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;
61 
62  void *frame_opaque;
64 } FrameData;
65 
66 static inline RaPixelRange range_map(enum AVPixelFormat pix_fmt, enum AVColorRange range)
67 {
68  switch (pix_fmt) {
72  return RA_PIXEL_RANGE_FULL;
73  }
74 
75  switch (range) {
76  case AVCOL_RANGE_JPEG:
77  return RA_PIXEL_RANGE_FULL;
78  case AVCOL_RANGE_MPEG:
79  default:
80  return RA_PIXEL_RANGE_LIMITED;
81  }
82 }
83 
84 static inline RaChromaSampling pix_fmt_map(enum AVPixelFormat pix_fmt)
85 {
86  switch (pix_fmt) {
87  case AV_PIX_FMT_YUV420P:
91  return RA_CHROMA_SAMPLING_CS420;
92  case AV_PIX_FMT_YUV422P:
96  return RA_CHROMA_SAMPLING_CS422;
97  case AV_PIX_FMT_YUV444P:
101  return RA_CHROMA_SAMPLING_CS444;
102  default:
103  av_assert0(0);
104  }
105 }
106 
107 static inline RaChromaSamplePosition chroma_loc_map(enum AVChromaLocation chroma_loc)
108 {
109  switch (chroma_loc) {
110  case AVCHROMA_LOC_LEFT:
111  return RA_CHROMA_SAMPLE_POSITION_VERTICAL;
113  return RA_CHROMA_SAMPLE_POSITION_COLOCATED;
114  default:
115  return RA_CHROMA_SAMPLE_POSITION_UNKNOWN;
116  }
117 }
118 
119 static int get_stats(AVCodecContext *avctx, int eos)
120 {
121  librav1eContext *ctx = avctx->priv_data;
122  RaData* buf = rav1e_twopass_out(ctx->ctx);
123  if (!buf)
124  return 0;
125 
126  if (!eos) {
127  uint8_t *tmp = av_fast_realloc(ctx->pass_data, &ctx->pass_size,
128  ctx->pass_pos + buf->len);
129  if (!tmp) {
130  rav1e_data_unref(buf);
131  return AVERROR(ENOMEM);
132  }
133 
134  ctx->pass_data = tmp;
135  memcpy(ctx->pass_data + ctx->pass_pos, buf->data, buf->len);
136  ctx->pass_pos += buf->len;
137  } else {
138  size_t b64_size = AV_BASE64_SIZE(ctx->pass_pos);
139 
140  memcpy(ctx->pass_data, buf->data, buf->len);
141 
142  avctx->stats_out = av_malloc(b64_size);
143  if (!avctx->stats_out) {
144  rav1e_data_unref(buf);
145  return AVERROR(ENOMEM);
146  }
147 
148  av_base64_encode(avctx->stats_out, b64_size, ctx->pass_data, ctx->pass_pos);
149 
150  av_freep(&ctx->pass_data);
151  }
152 
153  rav1e_data_unref(buf);
154 
155  return 0;
156 }
157 
158 static int set_stats(AVCodecContext *avctx)
159 {
160  librav1eContext *ctx = avctx->priv_data;
161  int ret = 1;
162 
163  while (ret > 0 && ctx->pass_size - ctx->pass_pos > 0) {
164  ret = rav1e_twopass_in(ctx->ctx, ctx->pass_data + ctx->pass_pos, ctx->pass_size);
165  if (ret < 0)
166  return AVERROR_EXTERNAL;
167  ctx->pass_pos += ret;
168  }
169 
170  return 0;
171 }
172 
174 {
175  librav1eContext *ctx = avctx->priv_data;
176 
177  if (ctx->ctx) {
178  rav1e_context_unref(ctx->ctx);
179  ctx->ctx = NULL;
180  }
181  if (ctx->rframe) {
182  rav1e_frame_unref(ctx->rframe);
183  ctx->rframe = NULL;
184  }
185 
186  av_frame_free(&ctx->frame);
187  av_freep(&ctx->pass_data);
188 
189  return 0;
190 }
191 
193 {
194  librav1eContext *ctx = avctx->priv_data;
196  RaConfig *cfg = NULL;
197  int rret;
198  int ret = 0;
199 
200  ctx->frame = av_frame_alloc();
201  if (!ctx->frame)
202  return AVERROR(ENOMEM);
203 
204  cfg = rav1e_config_default();
205  if (!cfg) {
206  av_log(avctx, AV_LOG_ERROR, "Could not allocate rav1e config.\n");
207  return AVERROR_EXTERNAL;
208  }
209 
210  /*
211  * Rav1e currently uses the time base given to it only for ratecontrol... where
212  * the inverse is taken and used as a framerate. So, do what we do in other wrappers
213  * and use the framerate if we can.
214  */
215  if (avctx->framerate.num > 0 && avctx->framerate.den > 0) {
216  rav1e_config_set_time_base(cfg, (RaRational) {
217  avctx->framerate.den, avctx->framerate.num
218  });
219  } else {
220  rav1e_config_set_time_base(cfg, (RaRational) {
221  avctx->time_base.num * avctx->ticks_per_frame,
222  avctx->time_base.den
223  });
224  }
225 
226  if ((avctx->flags & AV_CODEC_FLAG_PASS1 || avctx->flags & AV_CODEC_FLAG_PASS2) && !avctx->bit_rate) {
227  av_log(avctx, AV_LOG_ERROR, "A bitrate must be set to use two pass mode.\n");
229  goto end;
230  }
231 
232  if (avctx->flags & AV_CODEC_FLAG_PASS2) {
233  if (!avctx->stats_in) {
234  av_log(avctx, AV_LOG_ERROR, "No stats file provided for second pass.\n");
235  ret = AVERROR(EINVAL);
236  goto end;
237  }
238 
239  ctx->pass_size = (strlen(avctx->stats_in) * 3) / 4;
240  ctx->pass_data = av_malloc(ctx->pass_size);
241  if (!ctx->pass_data) {
242  av_log(avctx, AV_LOG_ERROR, "Could not allocate stats buffer.\n");
243  ret = AVERROR(ENOMEM);
244  goto end;
245  }
246 
247  ctx->pass_size = av_base64_decode(ctx->pass_data, avctx->stats_in, ctx->pass_size);
248  if (ctx->pass_size < 0) {
249  av_log(avctx, AV_LOG_ERROR, "Invalid pass file.\n");
250  ret = AVERROR(EINVAL);
251  goto end;
252  }
253  }
254 
255  {
256  const AVDictionaryEntry *en = NULL;
257  while ((en = av_dict_iterate(ctx->rav1e_opts, en))) {
258  if (rav1e_config_parse(cfg, en->key, en->value) < 0)
259  av_log(avctx, AV_LOG_WARNING, "Invalid value for %s: %s.\n", en->key, en->value);
260  }
261  }
262 
263  rret = rav1e_config_parse_int(cfg, "width", avctx->width);
264  if (rret < 0) {
265  av_log(avctx, AV_LOG_ERROR, "Invalid width passed to rav1e.\n");
267  goto end;
268  }
269 
270  rret = rav1e_config_parse_int(cfg, "height", avctx->height);
271  if (rret < 0) {
272  av_log(avctx, AV_LOG_ERROR, "Invalid height passed to rav1e.\n");
274  goto end;
275  }
276 
277  if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0)
278  rav1e_config_set_sample_aspect_ratio(cfg, (RaRational) {
279  avctx->sample_aspect_ratio.num,
280  avctx->sample_aspect_ratio.den
281  });
282 
283  rret = rav1e_config_parse_int(cfg, "threads", avctx->thread_count);
284  if (rret < 0)
285  av_log(avctx, AV_LOG_WARNING, "Invalid number of threads, defaulting to auto.\n");
286 
287  if (ctx->speed >= 0) {
288  rret = rav1e_config_parse_int(cfg, "speed", ctx->speed);
289  if (rret < 0) {
290  av_log(avctx, AV_LOG_ERROR, "Could not set speed preset.\n");
292  goto end;
293  }
294  }
295 
296  /* rav1e handles precedence between 'tiles' and cols/rows for us. */
297  if (ctx->tiles > 0) {
298  rret = rav1e_config_parse_int(cfg, "tiles", ctx->tiles);
299  if (rret < 0) {
300  av_log(avctx, AV_LOG_ERROR, "Could not set number of tiles to encode with.\n");
302  goto end;
303  }
304  }
305  if (ctx->tile_rows > 0) {
306  rret = rav1e_config_parse_int(cfg, "tile_rows", ctx->tile_rows);
307  if (rret < 0) {
308  av_log(avctx, AV_LOG_ERROR, "Could not set number of tile rows to encode with.\n");
310  goto end;
311  }
312  }
313  if (ctx->tile_cols > 0) {
314  rret = rav1e_config_parse_int(cfg, "tile_cols", ctx->tile_cols);
315  if (rret < 0) {
316  av_log(avctx, AV_LOG_ERROR, "Could not set number of tile cols to encode with.\n");
318  goto end;
319  }
320  }
321 
322  if (avctx->gop_size > 0) {
323  rret = rav1e_config_parse_int(cfg, "key_frame_interval", avctx->gop_size);
324  if (rret < 0) {
325  av_log(avctx, AV_LOG_ERROR, "Could not set max keyint.\n");
327  goto end;
328  }
329  }
330 
331  if (avctx->keyint_min > 0) {
332  rret = rav1e_config_parse_int(cfg, "min_key_frame_interval", avctx->keyint_min);
333  if (rret < 0) {
334  av_log(avctx, AV_LOG_ERROR, "Could not set min keyint.\n");
336  goto end;
337  }
338  }
339 
340  if (avctx->bit_rate && ctx->quantizer < 0) {
341  int max_quantizer = avctx->qmax >= 0 ? avctx->qmax : 255;
342 
343  rret = rav1e_config_parse_int(cfg, "quantizer", max_quantizer);
344  if (rret < 0) {
345  av_log(avctx, AV_LOG_ERROR, "Could not set max quantizer.\n");
347  goto end;
348  }
349 
350  if (avctx->qmin >= 0) {
351  rret = rav1e_config_parse_int(cfg, "min_quantizer", avctx->qmin);
352  if (rret < 0) {
353  av_log(avctx, AV_LOG_ERROR, "Could not set min quantizer.\n");
355  goto end;
356  }
357  }
358 
359  rret = rav1e_config_parse_int(cfg, "bitrate", avctx->bit_rate);
360  if (rret < 0) {
361  av_log(avctx, AV_LOG_ERROR, "Could not set bitrate.\n");
363  goto end;
364  }
365  } else if (ctx->quantizer >= 0) {
366  if (avctx->bit_rate)
367  av_log(avctx, AV_LOG_WARNING, "Both bitrate and quantizer specified. Using quantizer mode.");
368 
369  rret = rav1e_config_parse_int(cfg, "quantizer", ctx->quantizer);
370  if (rret < 0) {
371  av_log(avctx, AV_LOG_ERROR, "Could not set quantizer.\n");
373  goto end;
374  }
375  }
376 
377  rret = rav1e_config_set_pixel_format(cfg, desc->comp[0].depth,
378  pix_fmt_map(avctx->pix_fmt),
380  range_map(avctx->pix_fmt, avctx->color_range));
381  if (rret < 0) {
382  av_log(avctx, AV_LOG_ERROR, "Failed to set pixel format properties.\n");
384  goto end;
385  }
386 
387  /* rav1e's colorspace enums match standard values. */
388  rret = rav1e_config_set_color_description(cfg, (RaMatrixCoefficients) avctx->colorspace,
389  (RaColorPrimaries) avctx->color_primaries,
390  (RaTransferCharacteristics) avctx->color_trc);
391  if (rret < 0) {
392  av_log(avctx, AV_LOG_WARNING, "Failed to set color properties.\n");
393  if (avctx->err_recognition & AV_EF_EXPLODE) {
395  goto end;
396  }
397  }
398 
399  ctx->ctx = rav1e_context_new(cfg);
400  if (!ctx->ctx) {
401  av_log(avctx, AV_LOG_ERROR, "Failed to create rav1e encode context.\n");
403  goto end;
404  }
405 
406  if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
407  RaData *seq_hdr = rav1e_container_sequence_header(ctx->ctx);
408 
409  if (seq_hdr)
410  avctx->extradata = av_mallocz(seq_hdr->len + AV_INPUT_BUFFER_PADDING_SIZE);
411  if (!seq_hdr || !avctx->extradata) {
412  rav1e_data_unref(seq_hdr);
413  av_log(avctx, AV_LOG_ERROR, "Failed to get extradata.\n");
414  ret = seq_hdr ? AVERROR(ENOMEM) : AVERROR_EXTERNAL;
415  goto end;
416  }
417 
418  memcpy(avctx->extradata, seq_hdr->data, seq_hdr->len);
419  avctx->extradata_size = seq_hdr->len;
420  rav1e_data_unref(seq_hdr);
421  }
422 
423  ret = 0;
424 
425 end:
426 
427  rav1e_config_unref(cfg);
428 
429  return ret;
430 }
431 
432 static void frame_data_free(void *data)
433 {
434  FrameData *fd = data;
435 
436  if (!fd)
437  return;
438 
440  av_free(data);
441 }
442 
444 {
445  librav1eContext *ctx = avctx->priv_data;
446  RaFrame *rframe = ctx->rframe;
447  RaPacket *rpkt = NULL;
448  FrameData *fd;
449  int ret;
450 
451  if (!rframe) {
452  AVFrame *frame = ctx->frame;
453 
454  ret = ff_encode_get_frame(avctx, frame);
455  if (ret < 0 && ret != AVERROR_EOF)
456  return ret;
457 
458  if (frame->buf[0]) {
460 
461  fd = av_mallocz(sizeof(*fd));
462  if (!fd) {
463  av_log(avctx, AV_LOG_ERROR, "Could not allocate PTS buffer.\n");
464  return AVERROR(ENOMEM);
465  }
466  fd->pts = frame->pts;
467  fd->duration = frame->duration;
468  fd->reordered_opaque = frame->reordered_opaque;
469 
470  if (avctx->flags & AV_CODEC_FLAG_COPY_OPAQUE) {
471  fd->frame_opaque = frame->opaque;
472  ret = av_buffer_replace(&fd->frame_opaque_ref, frame->opaque_ref);
473  if (ret < 0) {
474  frame_data_free(fd);
476  return ret;
477  }
478  }
479 
480  rframe = rav1e_frame_new(ctx->ctx);
481  if (!rframe) {
482  av_log(avctx, AV_LOG_ERROR, "Could not allocate new rav1e frame.\n");
484  frame_data_free(fd);
485  return AVERROR(ENOMEM);
486  }
487 
488  for (int i = 0; i < desc->nb_components; i++) {
489  int shift = i ? desc->log2_chroma_h : 0;
490  int bytes = desc->comp[0].depth == 8 ? 1 : 2;
491  rav1e_frame_fill_plane(rframe, i, frame->data[i],
492  (frame->height >> shift) * frame->linesize[i],
493  frame->linesize[i], bytes);
494  }
496  rav1e_frame_set_opaque(rframe, fd, frame_data_free);
497  }
498  }
499 
500  ret = rav1e_send_frame(ctx->ctx, rframe);
501  if (rframe)
502  if (ret == RA_ENCODER_STATUS_ENOUGH_DATA) {
503  ctx->rframe = rframe; /* Queue is full. Store the RaFrame to retry next call */
504  } else {
505  rav1e_frame_unref(rframe); /* No need to unref if flushing. */
506  ctx->rframe = NULL;
507  }
508 
509  switch (ret) {
510  case RA_ENCODER_STATUS_SUCCESS:
511  case RA_ENCODER_STATUS_ENOUGH_DATA:
512  break;
513  case RA_ENCODER_STATUS_FAILURE:
514  av_log(avctx, AV_LOG_ERROR, "Could not send frame: %s\n", rav1e_status_to_str(ret));
515  return AVERROR_EXTERNAL;
516  default:
517  av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_send_frame: %s\n", ret, rav1e_status_to_str(ret));
518  return AVERROR_UNKNOWN;
519  }
520 
521 retry:
522 
523  if (avctx->flags & AV_CODEC_FLAG_PASS1) {
524  int sret = get_stats(avctx, 0);
525  if (sret < 0)
526  return sret;
527  } else if (avctx->flags & AV_CODEC_FLAG_PASS2) {
528  int sret = set_stats(avctx);
529  if (sret < 0)
530  return sret;
531  }
532 
533  ret = rav1e_receive_packet(ctx->ctx, &rpkt);
534  switch (ret) {
535  case RA_ENCODER_STATUS_SUCCESS:
536  break;
537  case RA_ENCODER_STATUS_LIMIT_REACHED:
538  if (avctx->flags & AV_CODEC_FLAG_PASS1) {
539  int sret = get_stats(avctx, 1);
540  if (sret < 0)
541  return sret;
542  }
543  return AVERROR_EOF;
544  case RA_ENCODER_STATUS_ENCODED:
545  goto retry;
546  case RA_ENCODER_STATUS_NEED_MORE_DATA:
547  if (avctx->internal->draining) {
548  av_log(avctx, AV_LOG_ERROR, "Unexpected error when receiving packet after EOF.\n");
549  return AVERROR_EXTERNAL;
550  }
551  return AVERROR(EAGAIN);
552  case RA_ENCODER_STATUS_FAILURE:
553  av_log(avctx, AV_LOG_ERROR, "Could not encode frame: %s\n", rav1e_status_to_str(ret));
554  return AVERROR_EXTERNAL;
555  default:
556  av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_receive_packet: %s\n", ret, rav1e_status_to_str(ret));
557  return AVERROR_UNKNOWN;
558  }
559 
560  ret = ff_get_encode_buffer(avctx, pkt, rpkt->len, 0);
561  if (ret < 0) {
562  av_log(avctx, AV_LOG_ERROR, "Could not allocate packet.\n");
563  rav1e_packet_unref(rpkt);
564  return ret;
565  }
566 
567  memcpy(pkt->data, rpkt->data, rpkt->len);
568 
569  if (rpkt->frame_type == RA_FRAME_TYPE_KEY)
571 
572  fd = rpkt->opaque;
573  pkt->pts = pkt->dts = fd->pts;
574  pkt->duration = fd->duration;
575  avctx->reordered_opaque = fd->reordered_opaque;
576 
577  if (avctx->flags & AV_CODEC_FLAG_COPY_OPAQUE) {
578  pkt->opaque = fd->frame_opaque;
580  fd->frame_opaque_ref = NULL;
581  }
582 
583  frame_data_free(fd);
584 
585  if (avctx->flags & AV_CODEC_FLAG_RECON_FRAME) {
586  AVCodecInternal *avci = avctx->internal;
587  AVFrame *frame = avci->recon_frame;
589 
591 
592  frame->format = avctx->pix_fmt;
593  frame->width = avctx->width;
594  frame->height = avctx->height;
595 
596  ret = ff_encode_alloc_frame(avctx, frame);
597  if (ret < 0) {
598  rav1e_packet_unref(rpkt);
599  return ret;
600  }
601 
602  for (int i = 0; i < desc->nb_components; i++) {
603  int shift = i ? desc->log2_chroma_h : 0;
604  rav1e_frame_extract_plane(rpkt->rec, i, frame->data[i],
605  (frame->height >> shift) * frame->linesize[i],
606  frame->linesize[i], desc->comp[i].step);
607  }
608  }
609 
610  rav1e_packet_unref(rpkt);
611 
612  return 0;
613 }
614 
615 #define OFFSET(x) offsetof(librav1eContext, x)
616 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
617 
618 static const AVOption options[] = {
619  { "qp", "use constant quantizer mode", OFFSET(quantizer), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 255, VE },
620  { "speed", "what speed preset to use", OFFSET(speed), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 10, VE },
621  { "tiles", "number of tiles encode with", OFFSET(tiles), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
622  { "tile-rows", "number of tiles rows to encode with", OFFSET(tile_rows), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
623  { "tile-columns", "number of tiles columns to encode with", OFFSET(tile_cols), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
624  { "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 },
625  { NULL }
626 };
627 
629  { "b", "0" },
630  { "g", "0" },
631  { "keyint_min", "0" },
632  { "qmax", "-1" },
633  { "qmin", "-1" },
634  { NULL }
635 };
636 
651 };
652 
653 static const AVClass class = {
654  .class_name = "librav1e",
655  .item_name = av_default_item_name,
656  .option = options,
658 };
659 
661  .p.name = "librav1e",
662  CODEC_LONG_NAME("librav1e AV1"),
663  .p.type = AVMEDIA_TYPE_VIDEO,
664  .p.id = AV_CODEC_ID_AV1,
665  .init = librav1e_encode_init,
667  .close = librav1e_encode_close,
668  .priv_data_size = sizeof(librav1eContext),
669  .p.priv_class = &class,
670  .defaults = librav1e_defaults,
671  .p.pix_fmts = librav1e_pix_fmts,
672  .p.capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_OTHER_THREADS |
675  .caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE |
677  .p.wrapper_name = "librav1e",
678 };
OFFSET
#define OFFSET(x)
Definition: librav1e.c:615
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
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:973
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:1008
FrameData
Definition: ffmpeg.c:117
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2888
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:1384
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:191
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:116
librav1eContext::rframe
RaFrame * rframe
Definition: librav1e.c:43
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:330
tmp
static uint8_t tmp[11]
Definition: aes_ctr.c:28
pixdesc.h
AVCodecContext::color_trc
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:1001
AVCOL_RANGE_JPEG
@ AVCOL_RANGE_JPEG
Full range content.
Definition: pixfmt.h:661
set_stats
static int set_stats(AVCodecContext *avctx)
Definition: librav1e.c:158
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:374
AVOption
AVOption.
Definition: opt.h:251
encode.h
librav1eContext::frame
AVFrame * frame
Definition: librav1e.c:42
data
const char data[16]
Definition: mxf.c:146
AV_PIX_FMT_YUV420P10
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:459
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:392
mathematics.h
AVDictionary
Definition: dict.c:32
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:1227
AV_PKT_FLAG_KEY
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: packet.h:429
ff_librav1e_encoder
const FFCodec ff_librav1e_encoder
Definition: librav1e.c:660
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:317
AVCodecContext::framerate
AVRational framerate
Definition: avcodec.h:1768
librav1eContext::tiles
int tiles
Definition: librav1e.c:52
AV_CODEC_FLAG_COPY_OPAQUE
#define AV_CODEC_FLAG_COPY_OPAQUE
Request the encoder to propagate each frame's AVFrame.opaque and AVFrame.opaque_ref values to its cor...
Definition: avcodec.h:269
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:410
AVCodecContext::thread_count
int thread_count
thread count is used to decide how many independent tasks should be passed to execute()
Definition: avcodec.h:1499
AVCodecContext::flags
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:511
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:104
AV_PIX_FMT_YUV444P10
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:462
avassert.h
AVCodecContext::color_primaries
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition: avcodec.h:994
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:79
AVCodecContext::extradata_size
int extradata_size
Definition: avcodec.h:533
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:505
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:1306
librav1e_encode_init
static av_cold int librav1e_encode_init(AVCodecContext *avctx)
Definition: librav1e.c:192
librav1eContext::pass_pos
size_t pass_pos
Definition: librav1e.c:46
AVDictionaryEntry::key
char * key
Definition: dict.h:90
AVCodecContext::ticks_per_frame
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:563
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:127
librav1eContext::pass_size
int pass_size
Definition: librav1e.c:47
AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
#define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
This codec takes the reordered_opaque field from input AVFrames and returns it in the corresponding f...
Definition: codec.h:176
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:37
ctx
AVFormatContext * ctx
Definition: movenc.c:48
pix_fmt
static enum AVPixelFormat pix_fmt
Definition: demuxing_decoding.c:41
tile_cols
int tile_cols
Definition: h265_levels.c:218
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:66
AVPacket::opaque
void * opaque
for some private data of the user
Definition: packet.h:399
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:80
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:1015
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:682
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:684
AVCodecContext::internal
struct AVCodecInternal * internal
Private context used for internal data.
Definition: avcodec.h:466
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:78
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:481
AV_OPT_TYPE_DICT
@ AV_OPT_TYPE_DICT
Definition: opt.h:232
FrameData::reordered_opaque
int64_t reordered_opaque
Definition: librav1e.c:60
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:62
AV_PIX_FMT_YUV422P10
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:460
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:443
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:554
ff_encode_alloc_frame
int ff_encode_alloc_frame(AVCodecContext *avctx, AVFrame *frame)
Allocate buffers for a frame.
Definition: encode.c:720
AVCodecContext::stats_out
char * stats_out
pass1 encoding statistics output buffer
Definition: avcodec.h:1298
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:626
codec_internal.h
shift
static int shift(int a, int b)
Definition: bonk.c:257
AV_PIX_FMT_YUV422P12
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:464
AV_PIX_FMT_YUV444P12
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:466
librav1eContext::pass_data
uint8_t * pass_data
Definition: librav1e.c:45
range_map
static RaPixelRange range_map(enum AVPixelFormat pix_fmt, enum AVColorRange range)
Definition: librav1e.c:66
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:373
AV_CODEC_FLAG_PASS2
#define AV_CODEC_FLAG_PASS2
Use internal 2pass ratecontrol in second pass mode.
Definition: avcodec.h:284
FrameData::pts
int64_t pts
Definition: ffmpeg.c:119
pix_fmt_map
static RaChromaSampling pix_fmt_map(enum AVPixelFormat pix_fmt)
Definition: librav1e.c:84
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:380
AVCodecInternal
Definition: internal.h:52
FrameData::frame_opaque_ref
AVBufferRef * frame_opaque_ref
Definition: librav1e.c:63
AVChromaLocation
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:680
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:243
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:367
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:532
internal.h
VE
#define VE
Definition: librav1e.c:616
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:487
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:264
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
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:1022
AVCodecContext::height
int height
Definition: avcodec.h:604
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:641
AVCOL_RANGE_MPEG
@ AVCOL_RANGE_MPEG
Narrow or limited range content.
Definition: pixfmt.h:644
librav1eContext::quantizer
int quantizer
Definition: librav1e.c:50
avcodec.h
options
static const AVOption options[]
Definition: librav1e.c:618
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
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AVCodecInternal::recon_frame
AVFrame * recon_frame
When the AV_CODEC_FLAG_RECON_FRAME flag is used.
Definition: internal.h:121
AV_PIX_FMT_YUV420P12
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:463
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:432
AVCodecContext
main external API structure.
Definition: avcodec.h:431
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:79
AVCodecContext::qmin
int qmin
minimum quantizer
Definition: avcodec.h:1220
AVRational::den
int den
Denominator.
Definition: rational.h:60
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
librav1e_defaults
static const FFCodecDefault librav1e_defaults[]
Definition: librav1e.c:628
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:82
chroma_loc_map
static RaChromaSamplePosition chroma_loc_map(enum AVChromaLocation chroma_loc)
Definition: librav1e.c:107
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:71
AVCodecInternal::draining
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:142
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:70
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:178
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:637
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:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:458
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
AVCodecContext::reordered_opaque
int64_t reordered_opaque
opaque 64-bit number (generally a PTS) that will be reordered and output in AVFrame....
Definition: avcodec.h:1395
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:604
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:626
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:801
av_dict_iterate
const AVDictionaryEntry * av_dict_iterate(const AVDictionary *m, const AVDictionaryEntry *prev)
Iterate over a dictionary.
Definition: dict.c:42
librav1e_encode_close
static av_cold int librav1e_encode_close(AVCodecContext *avctx)
Definition: librav1e.c:173
AV_CODEC_FLAG_PASS1
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:280
get_stats
static int get_stats(AVCodecContext *avctx, int eos)
Definition: librav1e.c:119