4 * Copyright (c) 2019 Derek Buitenhuis
6 * This file is part of FFmpeg.
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.
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.
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
25 #include "libavutil/internal.h"
26 #include "libavutil/avassert.h"
27 #include "libavutil/base64.h"
28 #include "libavutil/common.h"
29 #include "libavutil/mathematics.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixdesc.h"
35 typedef struct librav1eContext {
45 AVDictionary *rav1e_opts;
53 static inline RaPixelRange range_map(enum AVPixelFormat pix_fmt, enum AVColorRange range)
56 case AV_PIX_FMT_YUVJ420P:
57 case AV_PIX_FMT_YUVJ422P:
58 case AV_PIX_FMT_YUVJ444P:
59 return RA_PIXEL_RANGE_FULL;
63 case AVCOL_RANGE_JPEG:
64 return RA_PIXEL_RANGE_FULL;
65 case AVCOL_RANGE_MPEG:
67 return RA_PIXEL_RANGE_LIMITED;
71 static inline RaChromaSampling pix_fmt_map(enum AVPixelFormat pix_fmt)
74 case AV_PIX_FMT_YUV420P:
75 case AV_PIX_FMT_YUVJ420P:
76 case AV_PIX_FMT_YUV420P10:
77 case AV_PIX_FMT_YUV420P12:
78 return RA_CHROMA_SAMPLING_CS420;
79 case AV_PIX_FMT_YUV422P:
80 case AV_PIX_FMT_YUVJ422P:
81 case AV_PIX_FMT_YUV422P10:
82 case AV_PIX_FMT_YUV422P12:
83 return RA_CHROMA_SAMPLING_CS422;
84 case AV_PIX_FMT_YUV444P:
85 case AV_PIX_FMT_YUVJ444P:
86 case AV_PIX_FMT_YUV444P10:
87 case AV_PIX_FMT_YUV444P12:
88 return RA_CHROMA_SAMPLING_CS444;
94 static inline RaChromaSamplePosition chroma_loc_map(enum AVChromaLocation chroma_loc)
97 case AVCHROMA_LOC_LEFT:
98 return RA_CHROMA_SAMPLE_POSITION_VERTICAL;
99 case AVCHROMA_LOC_TOPLEFT:
100 return RA_CHROMA_SAMPLE_POSITION_COLOCATED;
102 return RA_CHROMA_SAMPLE_POSITION_UNKNOWN;
106 static int get_stats(AVCodecContext *avctx, int eos)
108 librav1eContext *ctx = avctx->priv_data;
109 RaData* buf = rav1e_twopass_out(ctx->ctx);
114 uint8_t *tmp = av_fast_realloc(ctx->pass_data, &ctx->pass_size,
115 ctx->pass_pos + buf->len);
117 rav1e_data_unref(buf);
118 return AVERROR(ENOMEM);
121 ctx->pass_data = tmp;
122 memcpy(ctx->pass_data + ctx->pass_pos, buf->data, buf->len);
123 ctx->pass_pos += buf->len;
125 size_t b64_size = AV_BASE64_SIZE(ctx->pass_pos);
127 memcpy(ctx->pass_data, buf->data, buf->len);
129 avctx->stats_out = av_malloc(b64_size);
130 if (!avctx->stats_out) {
131 rav1e_data_unref(buf);
132 return AVERROR(ENOMEM);
135 av_base64_encode(avctx->stats_out, b64_size, ctx->pass_data, ctx->pass_pos);
137 av_freep(&ctx->pass_data);
140 rav1e_data_unref(buf);
145 static int set_stats(AVCodecContext *avctx)
147 librav1eContext *ctx = avctx->priv_data;
150 while (ret > 0 && ctx->pass_size - ctx->pass_pos > 0) {
151 ret = rav1e_twopass_in(ctx->ctx, ctx->pass_data + ctx->pass_pos, ctx->pass_size);
153 return AVERROR_EXTERNAL;
154 ctx->pass_pos += ret;
160 static av_cold int librav1e_encode_close(AVCodecContext *avctx)
162 librav1eContext *ctx = avctx->priv_data;
165 rav1e_context_unref(ctx->ctx);
169 av_bsf_free(&ctx->bsf);
170 av_freep(&ctx->pass_data);
175 static av_cold int librav1e_encode_init(AVCodecContext *avctx)
177 librav1eContext *ctx = avctx->priv_data;
178 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(avctx->pix_fmt);
179 RaConfig *cfg = NULL;
183 cfg = rav1e_config_default();
185 av_log(avctx, AV_LOG_ERROR, "Could not allocate rav1e config.\n");
186 return AVERROR_EXTERNAL;
189 rav1e_config_set_time_base(cfg, (RaRational) {
190 avctx->time_base.num * avctx->ticks_per_frame,
194 if (avctx->flags & AV_CODEC_FLAG_PASS2) {
195 if (!avctx->stats_in) {
196 av_log(avctx, AV_LOG_ERROR, "No stats file provided for second pass.\n");
197 ret = AVERROR(EINVAL);
201 ctx->pass_size = (strlen(avctx->stats_in) * 3) / 4;
202 ctx->pass_data = av_malloc(ctx->pass_size);
203 if (!ctx->pass_data) {
204 av_log(avctx, AV_LOG_ERROR, "Could not allocate stats buffer.\n");
205 ret = AVERROR(ENOMEM);
209 ctx->pass_size = av_base64_decode(ctx->pass_data, avctx->stats_in, ctx->pass_size);
210 if (ctx->pass_size < 0) {
211 av_log(avctx, AV_LOG_ERROR, "Invalid pass file.\n");
212 ret = AVERROR(EINVAL);
217 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
218 const AVBitStreamFilter *filter = av_bsf_get_by_name("extract_extradata");
222 av_log(avctx, AV_LOG_ERROR, "extract_extradata bitstream filter "
223 "not found. This is a bug, please report it.\n");
228 bret = av_bsf_alloc(filter, &ctx->bsf);
234 bret = avcodec_parameters_from_context(ctx->bsf->par_in, avctx);
240 bret = av_bsf_init(ctx->bsf);
248 AVDictionaryEntry *en = NULL;
249 while ((en = av_dict_get(ctx->rav1e_opts, "", en, AV_DICT_IGNORE_SUFFIX))) {
250 int parse_ret = rav1e_config_parse(cfg, en->key, en->value);
252 av_log(avctx, AV_LOG_WARNING, "Invalid value for %s: %s.\n", en->key, en->value);
256 rret = rav1e_config_parse_int(cfg, "width", avctx->width);
258 av_log(avctx, AV_LOG_ERROR, "Invalid width passed to rav1e.\n");
259 ret = AVERROR_INVALIDDATA;
263 rret = rav1e_config_parse_int(cfg, "height", avctx->height);
265 av_log(avctx, AV_LOG_ERROR, "Invalid height passed to rav1e.\n");
266 ret = AVERROR_INVALIDDATA;
270 rret = rav1e_config_parse_int(cfg, "threads", avctx->thread_count);
272 av_log(avctx, AV_LOG_WARNING, "Invalid number of threads, defaulting to auto.\n");
274 if (ctx->speed >= 0) {
275 rret = rav1e_config_parse_int(cfg, "speed", ctx->speed);
277 av_log(avctx, AV_LOG_ERROR, "Could not set speed preset.\n");
278 ret = AVERROR_EXTERNAL;
283 /* rav1e handles precedence between 'tiles' and cols/rows for us. */
284 if (ctx->tiles > 0) {
285 rret = rav1e_config_parse_int(cfg, "tiles", ctx->tiles);
287 av_log(avctx, AV_LOG_ERROR, "Could not set number of tiles to encode with.\n");
288 ret = AVERROR_EXTERNAL;
292 if (ctx->tile_rows > 0) {
293 rret = rav1e_config_parse_int(cfg, "tile_rows", ctx->tile_rows);
295 av_log(avctx, AV_LOG_ERROR, "Could not set number of tile rows to encode with.\n");
296 ret = AVERROR_EXTERNAL;
300 if (ctx->tile_cols > 0) {
301 rret = rav1e_config_parse_int(cfg, "tile_cols", ctx->tile_cols);
303 av_log(avctx, AV_LOG_ERROR, "Could not set number of tile cols to encode with.\n");
304 ret = AVERROR_EXTERNAL;
309 if (avctx->gop_size > 0) {
310 rret = rav1e_config_parse_int(cfg, "key_frame_interval", avctx->gop_size);
312 av_log(avctx, AV_LOG_ERROR, "Could not set max keyint.\n");
313 ret = AVERROR_EXTERNAL;
318 if (avctx->keyint_min > 0) {
319 rret = rav1e_config_parse_int(cfg, "min_key_frame_interval", avctx->keyint_min);
321 av_log(avctx, AV_LOG_ERROR, "Could not set min keyint.\n");
322 ret = AVERROR_EXTERNAL;
327 if (avctx->bit_rate && ctx->quantizer < 0) {
328 int max_quantizer = avctx->qmax >= 0 ? avctx->qmax : 255;
330 rret = rav1e_config_parse_int(cfg, "quantizer", max_quantizer);
332 av_log(avctx, AV_LOG_ERROR, "Could not set max quantizer.\n");
333 ret = AVERROR_EXTERNAL;
337 if (avctx->qmin >= 0) {
338 rret = rav1e_config_parse_int(cfg, "min_quantizer", avctx->qmin);
340 av_log(avctx, AV_LOG_ERROR, "Could not set min quantizer.\n");
341 ret = AVERROR_EXTERNAL;
346 rret = rav1e_config_parse_int(cfg, "bitrate", avctx->bit_rate);
348 av_log(avctx, AV_LOG_ERROR, "Could not set bitrate.\n");
349 ret = AVERROR_INVALIDDATA;
352 } else if (ctx->quantizer >= 0) {
354 av_log(avctx, AV_LOG_WARNING, "Both bitrate and quantizer specified. Using quantizer mode.");
356 rret = rav1e_config_parse_int(cfg, "quantizer", ctx->quantizer);
358 av_log(avctx, AV_LOG_ERROR, "Could not set quantizer.\n");
359 ret = AVERROR_EXTERNAL;
364 rret = rav1e_config_set_pixel_format(cfg, desc->comp[0].depth,
365 pix_fmt_map(avctx->pix_fmt),
366 chroma_loc_map(avctx->chroma_sample_location),
367 range_map(avctx->pix_fmt, avctx->color_range));
369 av_log(avctx, AV_LOG_ERROR, "Failed to set pixel format properties.\n");
370 ret = AVERROR_INVALIDDATA;
374 /* rav1e's colorspace enums match standard values. */
375 rret = rav1e_config_set_color_description(cfg, (RaMatrixCoefficients) avctx->colorspace,
376 (RaColorPrimaries) avctx->color_primaries,
377 (RaTransferCharacteristics) avctx->color_trc);
379 av_log(avctx, AV_LOG_WARNING, "Failed to set color properties.\n");
380 if (avctx->err_recognition & AV_EF_EXPLODE) {
381 ret = AVERROR_INVALIDDATA;
386 ctx->ctx = rav1e_context_new(cfg);
388 av_log(avctx, AV_LOG_ERROR, "Failed to create rav1e encode context.\n");
389 ret = AVERROR_EXTERNAL;
397 rav1e_config_unref(cfg);
402 static int librav1e_send_frame(AVCodecContext *avctx, const AVFrame *frame)
404 librav1eContext *ctx = avctx->priv_data;
405 RaFrame *rframe = NULL;
409 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
411 rframe = rav1e_frame_new(ctx->ctx);
413 av_log(avctx, AV_LOG_ERROR, "Could not allocate new rav1e frame.\n");
414 return AVERROR(ENOMEM);
417 for (int i = 0; i < desc->nb_components; i++) {
418 int shift = i ? desc->log2_chroma_h : 0;
419 int bytes = desc->comp[0].depth == 8 ? 1 : 2;
420 rav1e_frame_fill_plane(rframe, i, frame->data[i],
421 (frame->height >> shift) * frame->linesize[i],
422 frame->linesize[i], bytes);
426 ret = rav1e_send_frame(ctx->ctx, rframe);
428 rav1e_frame_unref(rframe); /* No need to unref if flushing. */
431 case RA_ENCODER_STATUS_SUCCESS:
433 case RA_ENCODER_STATUS_ENOUGH_DATA:
434 return AVERROR(EAGAIN);
435 case RA_ENCODER_STATUS_FAILURE:
436 av_log(avctx, AV_LOG_ERROR, "Could not send frame: %s\n", rav1e_status_to_str(ret));
437 return AVERROR_EXTERNAL;
439 av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_send_frame: %s\n", ret, rav1e_status_to_str(ret));
440 return AVERROR_UNKNOWN;
446 static int librav1e_receive_packet(AVCodecContext *avctx, AVPacket *pkt)
448 librav1eContext *ctx = avctx->priv_data;
449 RaPacket *rpkt = NULL;
454 if (avctx->flags & AV_CODEC_FLAG_PASS1) {
455 int sret = get_stats(avctx, 0);
458 } else if (avctx->flags & AV_CODEC_FLAG_PASS2) {
459 int sret = set_stats(avctx);
464 ret = rav1e_receive_packet(ctx->ctx, &rpkt);
466 case RA_ENCODER_STATUS_SUCCESS:
468 case RA_ENCODER_STATUS_LIMIT_REACHED:
469 if (avctx->flags & AV_CODEC_FLAG_PASS1) {
470 int sret = get_stats(avctx, 1);
475 case RA_ENCODER_STATUS_ENCODED:
476 if (avctx->internal->draining)
478 return AVERROR(EAGAIN);
479 case RA_ENCODER_STATUS_NEED_MORE_DATA:
480 if (avctx->internal->draining) {
481 av_log(avctx, AV_LOG_ERROR, "Unexpected error when receiving packet after EOF.\n");
482 return AVERROR_EXTERNAL;
484 return AVERROR(EAGAIN);
485 case RA_ENCODER_STATUS_FAILURE:
486 av_log(avctx, AV_LOG_ERROR, "Could not encode frame: %s\n", rav1e_status_to_str(ret));
487 return AVERROR_EXTERNAL;
489 av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_receive_packet: %s\n", ret, rav1e_status_to_str(ret));
490 return AVERROR_UNKNOWN;
493 ret = av_new_packet(pkt, rpkt->len);
495 av_log(avctx, AV_LOG_ERROR, "Could not allocate packet.\n");
496 rav1e_packet_unref(rpkt);
500 memcpy(pkt->data, rpkt->data, rpkt->len);
502 if (rpkt->frame_type == RA_FRAME_TYPE_KEY)
503 pkt->flags |= AV_PKT_FLAG_KEY;
505 pkt->pts = pkt->dts = rpkt->input_frameno * avctx->ticks_per_frame;
506 rav1e_packet_unref(rpkt);
508 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
509 int ret = av_bsf_send_packet(ctx->bsf, pkt);
511 av_log(avctx, AV_LOG_ERROR, "extradata extraction send failed.\n");
512 av_packet_unref(pkt);
516 ret = av_bsf_receive_packet(ctx->bsf, pkt);
518 av_log(avctx, AV_LOG_ERROR, "extradata extraction receive failed.\n");
519 av_packet_unref(pkt);
527 #define OFFSET(x) offsetof(librav1eContext, x)
528 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
530 static const AVOption options[] = {
531 { "qp", "use constant quantizer mode", OFFSET(quantizer), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 255, VE },
532 { "speed", "what speed preset to use", OFFSET(speed), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 10, VE },
533 { "tiles", "number of tiles encode with", OFFSET(tiles), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
534 { "tile-rows", "number of tiles rows to encode with", OFFSET(tile_rows), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
535 { "tile-columns", "number of tiles columns to encode with", OFFSET(tile_cols), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
536 { "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 },
540 static const AVCodecDefault librav1e_defaults[] = {
543 { "keyint_min", "0" },
549 const enum AVPixelFormat librav1e_pix_fmts[] = {
552 AV_PIX_FMT_YUV420P10,
553 AV_PIX_FMT_YUV420P12,
556 AV_PIX_FMT_YUV422P10,
557 AV_PIX_FMT_YUV422P12,
560 AV_PIX_FMT_YUV444P10,
561 AV_PIX_FMT_YUV444P12,
565 static const AVClass class = {
566 .class_name = "librav1e",
567 .item_name = av_default_item_name,
569 .version = LIBAVUTIL_VERSION_INT,
572 AVCodec ff_librav1e_encoder = {
574 .long_name = NULL_IF_CONFIG_SMALL("librav1e AV1"),
575 .type = AVMEDIA_TYPE_VIDEO,
576 .id = AV_CODEC_ID_AV1,
577 .init = librav1e_encode_init,
578 .send_frame = librav1e_send_frame,
579 .receive_packet = librav1e_receive_packet,
580 .close = librav1e_encode_close,
581 .priv_data_size = sizeof(librav1eContext),
582 .priv_class = &class,
583 .defaults = librav1e_defaults,
584 .pix_fmts = librav1e_pix_fmts,
585 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
586 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
587 .wrapper_name = "librav1e",