FFmpeg
librav1e.c
Go to the documentation of this file.
1 /*
2  * librav1e encoder
3  *
4  * Copyright (c) 2019 Derek Buitenhuis
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #include <rav1e.h>
24 
25 #include "libavutil/buffer.h"
26 #include "libavutil/internal.h"
27 #include "libavutil/avassert.h"
28 #include "libavutil/base64.h"
29 #include "libavutil/common.h"
30 #include "libavutil/mathematics.h"
31 #include "libavutil/opt.h"
32 #include "libavutil/pixdesc.h"
33 #include "avcodec.h"
34 #include "codec_internal.h"
35 #include "encode.h"
36 #include "internal.h"
37 
38 typedef struct librav1eContext {
39  const AVClass *class;
40 
41  RaContext *ctx;
43  RaFrame *rframe;
44 
45  uint8_t *pass_data;
46  size_t pass_pos;
47  int pass_size;
48 
50  int quantizer;
51  int speed;
52  int tiles;
53  int tile_rows;
54  int tile_cols;
56 
57 typedef struct FrameData {
58  int64_t pts;
59  int64_t duration;
60 #if FF_API_REORDERED_OPAQUE
61  int64_t reordered_opaque;
62 #endif
63 
64  void *frame_opaque;
66 } FrameData;
67 
68 static inline RaPixelRange range_map(enum AVPixelFormat pix_fmt, enum AVColorRange range)
69 {
70  switch (pix_fmt) {
74  return RA_PIXEL_RANGE_FULL;
75  }
76 
77  switch (range) {
78  case AVCOL_RANGE_JPEG:
79  return RA_PIXEL_RANGE_FULL;
80  case AVCOL_RANGE_MPEG:
81  default:
82  return RA_PIXEL_RANGE_LIMITED;
83  }
84 }
85 
86 static inline RaChromaSampling pix_fmt_map(enum AVPixelFormat pix_fmt)
87 {
88  switch (pix_fmt) {
89  case AV_PIX_FMT_YUV420P:
93  return RA_CHROMA_SAMPLING_CS420;
94  case AV_PIX_FMT_YUV422P:
98  return RA_CHROMA_SAMPLING_CS422;
99  case AV_PIX_FMT_YUV444P:
100  case AV_PIX_FMT_YUVJ444P:
103  return RA_CHROMA_SAMPLING_CS444;
104  default:
105  av_assert0(0);
106  }
107 }
108 
109 static inline RaChromaSamplePosition chroma_loc_map(enum AVChromaLocation chroma_loc)
110 {
111  switch (chroma_loc) {
112  case AVCHROMA_LOC_LEFT:
113  return RA_CHROMA_SAMPLE_POSITION_VERTICAL;
115  return RA_CHROMA_SAMPLE_POSITION_COLOCATED;
116  default:
117  return RA_CHROMA_SAMPLE_POSITION_UNKNOWN;
118  }
119 }
120 
121 static int get_stats(AVCodecContext *avctx, int eos)
122 {
123  librav1eContext *ctx = avctx->priv_data;
124  RaData* buf = rav1e_twopass_out(ctx->ctx);
125  if (!buf)
126  return 0;
127 
128  if (!eos) {
129  uint8_t *tmp = av_fast_realloc(ctx->pass_data, &ctx->pass_size,
130  ctx->pass_pos + buf->len);
131  if (!tmp) {
132  rav1e_data_unref(buf);
133  return AVERROR(ENOMEM);
134  }
135 
136  ctx->pass_data = tmp;
137  memcpy(ctx->pass_data + ctx->pass_pos, buf->data, buf->len);
138  ctx->pass_pos += buf->len;
139  } else {
140  size_t b64_size = AV_BASE64_SIZE(ctx->pass_pos);
141 
142  memcpy(ctx->pass_data, buf->data, buf->len);
143 
144  avctx->stats_out = av_malloc(b64_size);
145  if (!avctx->stats_out) {
146  rav1e_data_unref(buf);
147  return AVERROR(ENOMEM);
148  }
149 
150  av_base64_encode(avctx->stats_out, b64_size, ctx->pass_data, ctx->pass_pos);
151 
152  av_freep(&ctx->pass_data);
153  }
154 
155  rav1e_data_unref(buf);
156 
157  return 0;
158 }
159 
160 static int set_stats(AVCodecContext *avctx)
161 {
162  librav1eContext *ctx = avctx->priv_data;
163  int ret = 1;
164 
165  while (ret > 0 && ctx->pass_size - ctx->pass_pos > 0) {
166  ret = rav1e_twopass_in(ctx->ctx, ctx->pass_data + ctx->pass_pos, ctx->pass_size);
167  if (ret < 0)
168  return AVERROR_EXTERNAL;
169  ctx->pass_pos += ret;
170  }
171 
172  return 0;
173 }
174 
176 {
177  librav1eContext *ctx = avctx->priv_data;
178 
179  if (ctx->ctx) {
180  rav1e_context_unref(ctx->ctx);
181  ctx->ctx = NULL;
182  }
183  if (ctx->rframe) {
184  rav1e_frame_unref(ctx->rframe);
185  ctx->rframe = NULL;
186  }
187 
188  av_frame_free(&ctx->frame);
189  av_freep(&ctx->pass_data);
190 
191  return 0;
192 }
193 
195 {
196  librav1eContext *ctx = avctx->priv_data;
198  RaConfig *cfg = NULL;
199  int rret;
200  int ret = 0;
201 
202  ctx->frame = av_frame_alloc();
203  if (!ctx->frame)
204  return AVERROR(ENOMEM);
205 
206  cfg = rav1e_config_default();
207  if (!cfg) {
208  av_log(avctx, AV_LOG_ERROR, "Could not allocate rav1e config.\n");
209  return AVERROR_EXTERNAL;
210  }
211 
212  /*
213  * Rav1e currently uses the time base given to it only for ratecontrol... where
214  * the inverse is taken and used as a framerate. So, do what we do in other wrappers
215  * and use the framerate if we can.
216  */
217  if (avctx->framerate.num > 0 && avctx->framerate.den > 0) {
218  rav1e_config_set_time_base(cfg, (RaRational) {
219  avctx->framerate.den, avctx->framerate.num
220  });
221  } else {
223  rav1e_config_set_time_base(cfg, (RaRational) {
224  avctx->time_base.num
225 #if FF_API_TICKS_PER_FRAME
226  * avctx->ticks_per_frame
227 #endif
228  , avctx->time_base.den
229  });
231  }
232 
233  if ((avctx->flags & AV_CODEC_FLAG_PASS1 || avctx->flags & AV_CODEC_FLAG_PASS2) && !avctx->bit_rate) {
234  av_log(avctx, AV_LOG_ERROR, "A bitrate must be set to use two pass mode.\n");
236  goto end;
237  }
238 
239  if (avctx->flags & AV_CODEC_FLAG_PASS2) {
240  if (!avctx->stats_in) {
241  av_log(avctx, AV_LOG_ERROR, "No stats file provided for second pass.\n");
242  ret = AVERROR(EINVAL);
243  goto end;
244  }
245 
246  ctx->pass_size = (strlen(avctx->stats_in) * 3) / 4;
247  ctx->pass_data = av_malloc(ctx->pass_size);
248  if (!ctx->pass_data) {
249  av_log(avctx, AV_LOG_ERROR, "Could not allocate stats buffer.\n");
250  ret = AVERROR(ENOMEM);
251  goto end;
252  }
253 
254  ctx->pass_size = av_base64_decode(ctx->pass_data, avctx->stats_in, ctx->pass_size);
255  if (ctx->pass_size < 0) {
256  av_log(avctx, AV_LOG_ERROR, "Invalid pass file.\n");
257  ret = AVERROR(EINVAL);
258  goto end;
259  }
260  }
261 
262  {
263  const AVDictionaryEntry *en = NULL;
264  while ((en = av_dict_iterate(ctx->rav1e_opts, en))) {
265  if (rav1e_config_parse(cfg, en->key, en->value) < 0)
266  av_log(avctx, AV_LOG_WARNING, "Invalid value for %s: %s.\n", en->key, en->value);
267  }
268  }
269 
270  rret = rav1e_config_parse_int(cfg, "width", avctx->width);
271  if (rret < 0) {
272  av_log(avctx, AV_LOG_ERROR, "Invalid width passed to rav1e.\n");
274  goto end;
275  }
276 
277  rret = rav1e_config_parse_int(cfg, "height", avctx->height);
278  if (rret < 0) {
279  av_log(avctx, AV_LOG_ERROR, "Invalid height passed to rav1e.\n");
281  goto end;
282  }
283 
284  if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0)
285  rav1e_config_set_sample_aspect_ratio(cfg, (RaRational) {
286  avctx->sample_aspect_ratio.num,
287  avctx->sample_aspect_ratio.den
288  });
289 
290  rret = rav1e_config_parse_int(cfg, "threads", avctx->thread_count);
291  if (rret < 0)
292  av_log(avctx, AV_LOG_WARNING, "Invalid number of threads, defaulting to auto.\n");
293 
294  if (ctx->speed >= 0) {
295  rret = rav1e_config_parse_int(cfg, "speed", ctx->speed);
296  if (rret < 0) {
297  av_log(avctx, AV_LOG_ERROR, "Could not set speed preset.\n");
299  goto end;
300  }
301  }
302 
303  /* rav1e handles precedence between 'tiles' and cols/rows for us. */
304  if (ctx->tiles > 0) {
305  rret = rav1e_config_parse_int(cfg, "tiles", ctx->tiles);
306  if (rret < 0) {
307  av_log(avctx, AV_LOG_ERROR, "Could not set number of tiles to encode with.\n");
309  goto end;
310  }
311  }
312  if (ctx->tile_rows > 0) {
313  rret = rav1e_config_parse_int(cfg, "tile_rows", ctx->tile_rows);
314  if (rret < 0) {
315  av_log(avctx, AV_LOG_ERROR, "Could not set number of tile rows to encode with.\n");
317  goto end;
318  }
319  }
320  if (ctx->tile_cols > 0) {
321  rret = rav1e_config_parse_int(cfg, "tile_cols", ctx->tile_cols);
322  if (rret < 0) {
323  av_log(avctx, AV_LOG_ERROR, "Could not set number of tile cols to encode with.\n");
325  goto end;
326  }
327  }
328 
329  if (avctx->gop_size > 0) {
330  rret = rav1e_config_parse_int(cfg, "key_frame_interval", avctx->gop_size);
331  if (rret < 0) {
332  av_log(avctx, AV_LOG_ERROR, "Could not set max keyint.\n");
334  goto end;
335  }
336  }
337 
338  if (avctx->keyint_min > 0) {
339  rret = rav1e_config_parse_int(cfg, "min_key_frame_interval", avctx->keyint_min);
340  if (rret < 0) {
341  av_log(avctx, AV_LOG_ERROR, "Could not set min keyint.\n");
343  goto end;
344  }
345  }
346 
347  if (avctx->bit_rate && ctx->quantizer < 0) {
348  int max_quantizer = avctx->qmax >= 0 ? avctx->qmax : 255;
349 
350  rret = rav1e_config_parse_int(cfg, "quantizer", max_quantizer);
351  if (rret < 0) {
352  av_log(avctx, AV_LOG_ERROR, "Could not set max quantizer.\n");
354  goto end;
355  }
356 
357  if (avctx->qmin >= 0) {
358  rret = rav1e_config_parse_int(cfg, "min_quantizer", avctx->qmin);
359  if (rret < 0) {
360  av_log(avctx, AV_LOG_ERROR, "Could not set min quantizer.\n");
362  goto end;
363  }
364  }
365 
366  rret = rav1e_config_parse_int(cfg, "bitrate", avctx->bit_rate);
367  if (rret < 0) {
368  av_log(avctx, AV_LOG_ERROR, "Could not set bitrate.\n");
370  goto end;
371  }
372  } else if (ctx->quantizer >= 0) {
373  if (avctx->bit_rate)
374  av_log(avctx, AV_LOG_WARNING, "Both bitrate and quantizer specified. Using quantizer mode.");
375 
376  rret = rav1e_config_parse_int(cfg, "quantizer", ctx->quantizer);
377  if (rret < 0) {
378  av_log(avctx, AV_LOG_ERROR, "Could not set quantizer.\n");
380  goto end;
381  }
382  }
383 
384  rret = rav1e_config_set_pixel_format(cfg, desc->comp[0].depth,
385  pix_fmt_map(avctx->pix_fmt),
387  range_map(avctx->pix_fmt, avctx->color_range));
388  if (rret < 0) {
389  av_log(avctx, AV_LOG_ERROR, "Failed to set pixel format properties.\n");
391  goto end;
392  }
393 
394  /* rav1e's colorspace enums match standard values. */
395  rret = rav1e_config_set_color_description(cfg, (RaMatrixCoefficients) avctx->colorspace,
396  (RaColorPrimaries) avctx->color_primaries,
397  (RaTransferCharacteristics) avctx->color_trc);
398  if (rret < 0) {
399  av_log(avctx, AV_LOG_WARNING, "Failed to set color properties.\n");
400  if (avctx->err_recognition & AV_EF_EXPLODE) {
402  goto end;
403  }
404  }
405 
406  ctx->ctx = rav1e_context_new(cfg);
407  if (!ctx->ctx) {
408  av_log(avctx, AV_LOG_ERROR, "Failed to create rav1e encode context.\n");
410  goto end;
411  }
412 
413  if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
414  RaData *seq_hdr = rav1e_container_sequence_header(ctx->ctx);
415 
416  if (seq_hdr)
417  avctx->extradata = av_mallocz(seq_hdr->len + AV_INPUT_BUFFER_PADDING_SIZE);
418  if (!seq_hdr || !avctx->extradata) {
419  rav1e_data_unref(seq_hdr);
420  av_log(avctx, AV_LOG_ERROR, "Failed to get extradata.\n");
421  ret = seq_hdr ? AVERROR(ENOMEM) : AVERROR_EXTERNAL;
422  goto end;
423  }
424 
425  memcpy(avctx->extradata, seq_hdr->data, seq_hdr->len);
426  avctx->extradata_size = seq_hdr->len;
427  rav1e_data_unref(seq_hdr);
428  }
429 
430  ret = 0;
431 
432 end:
433 
434  rav1e_config_unref(cfg);
435 
436  return ret;
437 }
438 
439 static void frame_data_free(void *data)
440 {
441  FrameData *fd = data;
442 
443  if (!fd)
444  return;
445 
447  av_free(data);
448 }
449 
451 {
452  librav1eContext *ctx = avctx->priv_data;
453  RaFrame *rframe = ctx->rframe;
454  RaPacket *rpkt = NULL;
455  FrameData *fd;
456  int ret;
457 
458  if (!rframe) {
459  AVFrame *frame = ctx->frame;
460 
461  ret = ff_encode_get_frame(avctx, frame);
462  if (ret < 0 && ret != AVERROR_EOF)
463  return ret;
464 
465  if (frame->buf[0]) {
467 
468  fd = av_mallocz(sizeof(*fd));
469  if (!fd) {
470  av_log(avctx, AV_LOG_ERROR, "Could not allocate PTS buffer.\n");
471  return AVERROR(ENOMEM);
472  }
473  fd->pts = frame->pts;
474  fd->duration = frame->duration;
475 #if FF_API_REORDERED_OPAQUE
477  fd->reordered_opaque = frame->reordered_opaque;
479 #endif
480 
481  if (avctx->flags & AV_CODEC_FLAG_COPY_OPAQUE) {
482  fd->frame_opaque = frame->opaque;
484  if (ret < 0) {
485  frame_data_free(fd);
487  return ret;
488  }
489  }
490 
491  rframe = rav1e_frame_new(ctx->ctx);
492  if (!rframe) {
493  av_log(avctx, AV_LOG_ERROR, "Could not allocate new rav1e frame.\n");
495  frame_data_free(fd);
496  return AVERROR(ENOMEM);
497  }
498 
499  for (int i = 0; i < desc->nb_components; i++) {
500  int shift = i ? desc->log2_chroma_h : 0;
501  int bytes = desc->comp[0].depth == 8 ? 1 : 2;
502  rav1e_frame_fill_plane(rframe, i, frame->data[i],
503  (frame->height >> shift) * frame->linesize[i],
504  frame->linesize[i], bytes);
505  }
507  rav1e_frame_set_opaque(rframe, fd, frame_data_free);
508  }
509  }
510 
511  ret = rav1e_send_frame(ctx->ctx, rframe);
512  if (rframe)
513  if (ret == RA_ENCODER_STATUS_ENOUGH_DATA) {
514  ctx->rframe = rframe; /* Queue is full. Store the RaFrame to retry next call */
515  } else {
516  rav1e_frame_unref(rframe); /* No need to unref if flushing. */
517  ctx->rframe = NULL;
518  }
519 
520  switch (ret) {
521  case RA_ENCODER_STATUS_SUCCESS:
522  case RA_ENCODER_STATUS_ENOUGH_DATA:
523  break;
524  case RA_ENCODER_STATUS_FAILURE:
525  av_log(avctx, AV_LOG_ERROR, "Could not send frame: %s\n", rav1e_status_to_str(ret));
526  return AVERROR_EXTERNAL;
527  default:
528  av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_send_frame: %s\n", ret, rav1e_status_to_str(ret));
529  return AVERROR_UNKNOWN;
530  }
531 
532 retry:
533 
534  if (avctx->flags & AV_CODEC_FLAG_PASS1) {
535  int sret = get_stats(avctx, 0);
536  if (sret < 0)
537  return sret;
538  } else if (avctx->flags & AV_CODEC_FLAG_PASS2) {
539  int sret = set_stats(avctx);
540  if (sret < 0)
541  return sret;
542  }
543 
544  ret = rav1e_receive_packet(ctx->ctx, &rpkt);
545  switch (ret) {
546  case RA_ENCODER_STATUS_SUCCESS:
547  break;
548  case RA_ENCODER_STATUS_LIMIT_REACHED:
549  if (avctx->flags & AV_CODEC_FLAG_PASS1) {
550  int sret = get_stats(avctx, 1);
551  if (sret < 0)
552  return sret;
553  }
554  return AVERROR_EOF;
555  case RA_ENCODER_STATUS_ENCODED:
556  goto retry;
557  case RA_ENCODER_STATUS_NEED_MORE_DATA:
558  if (avctx->internal->draining) {
559  av_log(avctx, AV_LOG_ERROR, "Unexpected error when receiving packet after EOF.\n");
560  return AVERROR_EXTERNAL;
561  }
562  return AVERROR(EAGAIN);
563  case RA_ENCODER_STATUS_FAILURE:
564  av_log(avctx, AV_LOG_ERROR, "Could not encode frame: %s\n", rav1e_status_to_str(ret));
565  return AVERROR_EXTERNAL;
566  default:
567  av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_receive_packet: %s\n", ret, rav1e_status_to_str(ret));
568  return AVERROR_UNKNOWN;
569  }
570 
571  ret = ff_get_encode_buffer(avctx, pkt, rpkt->len, 0);
572  if (ret < 0) {
573  av_log(avctx, AV_LOG_ERROR, "Could not allocate packet.\n");
574  rav1e_packet_unref(rpkt);
575  return ret;
576  }
577 
578  memcpy(pkt->data, rpkt->data, rpkt->len);
579 
580  if (rpkt->frame_type == RA_FRAME_TYPE_KEY)
582 
583  fd = rpkt->opaque;
584  pkt->pts = pkt->dts = fd->pts;
585  pkt->duration = fd->duration;
586 #if FF_API_REORDERED_OPAQUE
588  avctx->reordered_opaque = fd->reordered_opaque;
590 #endif
591 
592  if (avctx->flags & AV_CODEC_FLAG_COPY_OPAQUE) {
593  pkt->opaque = fd->frame_opaque;
595  fd->frame_opaque_ref = NULL;
596  }
597 
598  frame_data_free(fd);
599 
600  if (avctx->flags & AV_CODEC_FLAG_RECON_FRAME) {
601  AVCodecInternal *avci = avctx->internal;
602  AVFrame *frame = avci->recon_frame;
604 
606 
607  frame->format = avctx->pix_fmt;
608  frame->width = avctx->width;
609  frame->height = avctx->height;
610 
611  ret = ff_encode_alloc_frame(avctx, frame);
612  if (ret < 0) {
613  rav1e_packet_unref(rpkt);
614  return ret;
615  }
616 
617  for (int i = 0; i < desc->nb_components; i++) {
618  int shift = i ? desc->log2_chroma_h : 0;
619  rav1e_frame_extract_plane(rpkt->rec, i, frame->data[i],
620  (frame->height >> shift) * frame->linesize[i],
621  frame->linesize[i], desc->comp[i].step);
622  }
623  }
624 
625  rav1e_packet_unref(rpkt);
626 
627  return 0;
628 }
629 
630 #define OFFSET(x) offsetof(librav1eContext, x)
631 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
632 
633 static const AVOption options[] = {
634  { "qp", "use constant quantizer mode", OFFSET(quantizer), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 255, VE },
635  { "speed", "what speed preset to use", OFFSET(speed), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 10, VE },
636  { "tiles", "number of tiles encode with", OFFSET(tiles), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
637  { "tile-rows", "number of tiles rows to encode with", OFFSET(tile_rows), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
638  { "tile-columns", "number of tiles columns to encode with", OFFSET(tile_cols), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
639  { "rav1e-params", "set the rav1e configuration using a :-separated list of key=value parameters", OFFSET(rav1e_opts), AV_OPT_TYPE_DICT, { 0 }, 0, 0, VE },
640  { NULL }
641 };
642 
644  { "b", "0" },
645  { "g", "0" },
646  { "keyint_min", "0" },
647  { "qmax", "-1" },
648  { "qmin", "-1" },
649  { NULL }
650 };
651 
666 };
667 
668 static const AVClass class = {
669  .class_name = "librav1e",
670  .item_name = av_default_item_name,
671  .option = options,
673 };
674 
676  .p.name = "librav1e",
677  CODEC_LONG_NAME("librav1e AV1"),
678  .p.type = AVMEDIA_TYPE_VIDEO,
679  .p.id = AV_CODEC_ID_AV1,
680  .init = librav1e_encode_init,
682  .close = librav1e_encode_close,
683  .priv_data_size = sizeof(librav1eContext),
684  .p.priv_class = &class,
685  .defaults = librav1e_defaults,
686  .p.pix_fmts = librav1e_pix_fmts,
687  .p.capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_OTHER_THREADS |
690  .caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE |
692  .p.wrapper_name = "librav1e",
693 };
OFFSET
#define OFFSET(x)
Definition: librav1e.c:630
FF_ENABLE_DEPRECATION_WARNINGS
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:73
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
AV_EF_EXPLODE
#define AV_EF_EXPLODE
abort decoding on minor error detection
Definition: defs.h:51
FF_CODEC_CAP_INIT_CLEANUP
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: codec_internal.h:42
AVCodecContext::keyint_min
int keyint_min
minimum GOP size
Definition: avcodec.h:998
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
AVCodecContext::colorspace
enum AVColorSpace colorspace
YUV colorspace type.
Definition: avcodec.h:1033
FrameData
Definition: ffmpeg.h:616
AVFrame::duration
int64_t duration
Duration of the frame, in the same units as pts.
Definition: frame.h:807
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2968
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
AVCodecContext::err_recognition
int err_recognition
Error recognition; may misdetect some more or less valid parts as errors.
Definition: avcodec.h:1416
AV_CODEC_CAP_ENCODER_RECON_FRAME
#define AV_CODEC_CAP_ENCODER_RECON_FRAME
The encoder is able to output reconstructed frame data, i.e.
Definition: codec.h:174
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:100
AVFrame::opaque
void * opaque
Frame owner's private data.
Definition: frame.h:501
librav1eContext::rframe
RaFrame * rframe
Definition: librav1e.c:43
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:340
tmp
static uint8_t tmp[11]
Definition: aes_ctr.c:28
pixdesc.h
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:452
AVCodecContext::color_trc
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:1026
AVFrame::width
int width
Definition: frame.h:412
AVCOL_RANGE_JPEG
@ AVCOL_RANGE_JPEG
Full range content.
Definition: pixfmt.h:687
set_stats
static int set_stats(AVCodecContext *avctx)
Definition: librav1e.c:160
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:522
AVOption
AVOption.
Definition: opt.h:251
encode.h
librav1eContext::frame
AVFrame * frame
Definition: librav1e.c:42
data
const char data[16]
Definition: mxf.c:148
AV_PIX_FMT_YUV420P10
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:482
FF_CODEC_CAP_NOT_INIT_THREADSAFE
#define FF_CODEC_CAP_NOT_INIT_THREADSAFE
The codec is not known to be init-threadsafe (i.e.
Definition: codec_internal.h:34
FFCodec
Definition: codec_internal.h:127
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:540
mathematics.h
AVDictionary
Definition: dict.c:34
AVERROR_UNKNOWN
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:73
AVCodecContext::qmax
int qmax
maximum quantizer
Definition: avcodec.h:1259
AVFrame::buf
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
Definition: frame.h:590
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:577
ff_librav1e_encoder
const FFCodec ff_librav1e_encoder
Definition: librav1e.c:675
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:361
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:30
AV_CODEC_FLAG_GLOBAL_HEADER
#define AV_CODEC_FLAG_GLOBAL_HEADER
Place global headers in extradata instead of every keyframe.
Definition: avcodec.h:338
AVFrame::opaque_ref
AVBufferRef * opaque_ref
Frame owner's private data.
Definition: frame.h:768
AVCodecContext::framerate
AVRational framerate
Definition: avcodec.h:1807
librav1eContext::tiles
int tiles
Definition: librav1e.c:52
AV_CODEC_FLAG_COPY_OPAQUE
#define AV_CODEC_FLAG_COPY_OPAQUE
Definition: avcodec.h:299
FFCodecDefault
Definition: codec_internal.h:97
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:131
librav1eContext::ctx
RaContext * ctx
Definition: librav1e.c:41
AVPacket::opaque_ref
AVBufferRef * opaque_ref
AVBufferRef for free use by the API user.
Definition: packet.h:558
AVCodecContext::thread_count
int thread_count
thread count is used to decide how many independent tasks should be passed to execute()
Definition: avcodec.h:1536
AVCodecContext::flags
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:525
AVRational::num
int num
Numerator.
Definition: rational.h:59
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:88
AV_PIX_FMT_YUV444P10
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:485
tiles
int tiles
Definition: av1_levels.c:72
avassert.h
AVCodecContext::color_primaries
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition: avcodec.h:1019
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
AV_PIX_FMT_YUVJ422P
@ AV_PIX_FMT_YUVJ422P
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:86
AVCodecContext::extradata_size
int extradata_size
Definition: avcodec.h:547
AVFrame::reordered_opaque
attribute_deprecated int64_t reordered_opaque
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything).
Definition: frame.h:561
av_fast_realloc
void * av_fast_realloc(void *ptr, unsigned int *size, size_t min_size)
Reallocate the given buffer if it is not large enough, otherwise do nothing.
Definition: mem.c:495
librav1eContext
Definition: librav1e.c:38
AVCodecContext::stats_in
char * stats_in
pass2 encoding statistics input buffer Concatenated stuff from stats_out of pass1 should be placed he...
Definition: avcodec.h:1338
librav1e_encode_init
static av_cold int librav1e_encode_init(AVCodecContext *avctx)
Definition: librav1e.c:194
pix_fmt
static enum AVPixelFormat pix_fmt
Definition: demux_decode.c:41
librav1eContext::pass_pos
size_t pass_pos
Definition: librav1e.c:46
AVDictionaryEntry::key
char * key
Definition: dict.h:90
AV_CODEC_CAP_OTHER_THREADS
#define AV_CODEC_CAP_OTHER_THREADS
Codec supports multithreading through a method other than slice- or frame-level multithreading.
Definition: codec.h:124
librav1eContext::pass_size
int pass_size
Definition: librav1e.c:47
AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
#define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
This encoder can reorder user opaque values from input AVFrames and return them with corresponding ou...
Definition: codec.h:159
tile_rows
int tile_rows
Definition: h265_levels.c:217
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:40
tile_cols
int tile_cols
Definition: av1_levels.c:73
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:73
AVPacket::opaque
void * opaque
for some private data of the user
Definition: packet.h:547
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:272
AV_PIX_FMT_YUVJ444P
@ AV_PIX_FMT_YUVJ444P
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:87
frame
static AVFrame * frame
Definition: demux_decode.c:54
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
AVCodecContext::color_range
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: avcodec.h:1043
av_buffer_unref
void av_buffer_unref(AVBufferRef **buf)
Free a given reference and automatically free the buffer if there are no more references to it.
Definition: buffer.c:139
AV_CODEC_ID_AV1
@ AV_CODEC_ID_AV1
Definition: codec_id.h:283
AVCHROMA_LOC_LEFT
@ AVCHROMA_LOC_LEFT
MPEG-2/4 4:2:0, H.264 default for 4:2:0.
Definition: pixfmt.h:708
librav1eContext::rav1e_opts
AVDictionary * rav1e_opts
Definition: librav1e.c:49
AVCHROMA_LOC_TOPLEFT
@ AVCHROMA_LOC_TOPLEFT
ITU-R 601, SMPTE 274M 296M S314M(DV 4:1:1), mpeg2 4:2:2.
Definition: pixfmt.h:710
AVCodecContext::internal
struct AVCodecInternal * internal
Private context used for internal data.
Definition: avcodec.h:480
AV_PIX_FMT_YUVJ420P
@ AV_PIX_FMT_YUVJ420P
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:85
FF_CODEC_RECEIVE_PACKET_CB
#define FF_CODEC_RECEIVE_PACKET_CB(func)
Definition: codec_internal.h:321
AVCodecContext::bit_rate
int64_t bit_rate
the average bitrate
Definition: avcodec.h:495
AV_OPT_TYPE_DICT
@ AV_OPT_TYPE_DICT
Definition: opt.h:232
FrameData::duration
int64_t duration
Definition: librav1e.c:59
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
FrameData::frame_opaque
void * frame_opaque
Definition: librav1e.c:64
AV_PIX_FMT_YUV422P10
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:483
librav1eContext::tile_rows
int tile_rows
Definition: librav1e.c:53
av_base64_decode
int av_base64_decode(uint8_t *out, const char *in_str, int out_size)
Decode a base64-encoded string.
Definition: base64.c:81
base64.h
librav1e_receive_packet
static int librav1e_receive_packet(AVCodecContext *avctx, AVPacket *pkt)
Definition: librav1e.c:450
AVCodecContext::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avcodec.h:567
ff_encode_alloc_frame
int ff_encode_alloc_frame(AVCodecContext *avctx, AVFrame *frame)
Allocate buffers for a frame.
Definition: encode.c:808
AVCodecContext::stats_out
char * stats_out
pass1 encoding statistics output buffer
Definition: avcodec.h:1330
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVCodecContext::gop_size
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition: avcodec.h:647
codec_internal.h
shift
static int shift(int a, int b)
Definition: bonk.c:262
AV_PIX_FMT_YUV422P12
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:487
AV_PIX_FMT_YUV444P12
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:489
AVFrame::format
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:427
librav1eContext::pass_data
uint8_t * pass_data
Definition: librav1e.c:45
range
enum AVColorRange range
Definition: mediacodec_wrapper.c:2646
range_map
static RaPixelRange range_map(enum AVPixelFormat pix_fmt, enum AVColorRange range)
Definition: librav1e.c:68
buffer.h
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:521
AV_CODEC_FLAG_PASS2
#define AV_CODEC_FLAG_PASS2
Use internal 2pass ratecontrol in second pass mode.
Definition: avcodec.h:314
FrameData::pts
int64_t pts
Definition: ffmpeg.h:625
pix_fmt_map
static RaChromaSampling pix_fmt_map(enum AVPixelFormat pix_fmt)
Definition: librav1e.c:86
librav1eContext::tile_cols
int tile_cols
Definition: librav1e.c:54
AVERROR_EXTERNAL
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:59
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:528
AVCodecInternal
Definition: internal.h:49
FrameData::frame_opaque_ref
AVBufferRef * frame_opaque_ref
Definition: librav1e.c:65
AVChromaLocation
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:706
AV_BASE64_SIZE
#define AV_BASE64_SIZE(x)
Calculate the output size needed to base64-encode x bytes to a null-terminated string.
Definition: base64.h:66
AV_CODEC_FLAG_RECON_FRAME
#define AV_CODEC_FLAG_RECON_FRAME
Request the encoder to output reconstructed frames, i.e. frames that would be produced by decoding th...
Definition: avcodec.h:264
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:255
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:515
librav1eContext::speed
int speed
Definition: librav1e.c:51
AVCodecContext::extradata
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:546
internal.h
VE
#define VE
Definition: librav1e.c:631
common.h
av_frame_unref
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:622
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:254
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:194
av_buffer_replace
int av_buffer_replace(AVBufferRef **pdst, const AVBufferRef *src)
Ensure dst refers to the same data as src.
Definition: buffer.c:233
AVCodecContext::chroma_sample_location
enum AVChromaLocation chroma_sample_location
This defines the location of chroma samples.
Definition: avcodec.h:1050
AVCodecContext::height
int height
Definition: avcodec.h:625
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:662
AVCOL_RANGE_MPEG
@ AVCOL_RANGE_MPEG
Narrow or limited range content.
Definition: pixfmt.h:670
librav1eContext::quantizer
int quantizer
Definition: librav1e.c:50
avcodec.h
options
static const AVOption options[]
Definition: librav1e.c:633
ret
ret
Definition: filter_design.txt:187
AVClass::class_name
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:71
AVCodecInternal::recon_frame
AVFrame * recon_frame
When the AV_CODEC_FLAG_RECON_FRAME flag is used.
Definition: internal.h:105
AV_PIX_FMT_YUV420P12
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:486
AV_INPUT_BUFFER_PADDING_SIZE
#define AV_INPUT_BUFFER_PADDING_SIZE
Definition: defs.h:40
frame_data_free
static void frame_data_free(void *data)
Definition: librav1e.c:439
AVCodecContext
main external API structure.
Definition: avcodec.h:445
AVFrame::height
int height
Definition: frame.h:412
ff_get_encode_buffer
int ff_get_encode_buffer(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int flags)
Get a buffer for a packet.
Definition: encode.c:105
AVCodecContext::qmin
int qmin
minimum quantizer
Definition: avcodec.h:1252
AVRational::den
int den
Denominator.
Definition: rational.h:60
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:72
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
librav1e_defaults
static const FFCodecDefault librav1e_defaults[]
Definition: librav1e.c:643
AVCodecContext::ticks_per_frame
attribute_deprecated int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:583
av_base64_encode
char * av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size)
Encode data to base64 and null-terminate.
Definition: base64.c:145
AV_CODEC_CAP_DELAY
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: codec.h:76
chroma_loc_map
static RaChromaSamplePosition chroma_loc_map(enum AVChromaLocation chroma_loc)
Definition: librav1e.c:109
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:78
AVCodecInternal::draining
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:126
FF_DISABLE_DEPRECATION_WARNINGS
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:72
desc
const char * desc
Definition: libsvtav1.c:83
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_PIX_FMT_YUV422P
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:77
ff_encode_get_frame
int ff_encode_get_frame(AVCodecContext *avctx, AVFrame *frame)
Called by encoders to get the next frame for encoding.
Definition: encode.c:209
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
FF_CODEC_CAP_AUTO_THREADS
#define FF_CODEC_CAP_AUTO_THREADS
Codec handles avctx->thread_count == 0 (auto) internally.
Definition: codec_internal.h:73
librav1e_pix_fmts
enum AVPixelFormat librav1e_pix_fmts[]
Definition: librav1e.c:652
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
av_free
#define av_free(p)
Definition: tableprint_vlc.h:33
AVDictionaryEntry
Definition: dict.h:89
AVPacket
This structure stores compressed data.
Definition: packet.h:499
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:472
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:625
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:385
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AVDictionaryEntry::value
char * value
Definition: dict.h:91
AVColorRange
AVColorRange
Visual content value range.
Definition: pixfmt.h:652
AVCodecContext::sample_aspect_ratio
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel.
Definition: avcodec.h:826
av_dict_iterate
const AVDictionaryEntry * av_dict_iterate(const AVDictionary *m, const AVDictionaryEntry *prev)
Iterate over a dictionary.
Definition: dict.c:44
librav1e_encode_close
static av_cold int librav1e_encode_close(AVCodecContext *avctx)
Definition: librav1e.c:175
AV_CODEC_FLAG_PASS1
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:310
get_stats
static int get_stats(AVCodecContext *avctx, int eos)
Definition: librav1e.c:121