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;
190 * Rav1e currently uses the time base given to it only for ratecontrol... where
191 * the inverse is taken and used as a framerate. So, do what we do in other wrappers
192 * and use the framerate if we can.
194 if (avctx->framerate.num > 0 && avctx->framerate.den > 0) {
195 rav1e_config_set_time_base(cfg, (RaRational) {
196 avctx->framerate.den, avctx->framerate.num
199 rav1e_config_set_time_base(cfg, (RaRational) {
200 avctx->time_base.num * avctx->ticks_per_frame,
205 if ((avctx->flags & AV_CODEC_FLAG_PASS1 || avctx->flags & AV_CODEC_FLAG_PASS2) && !avctx->bit_rate) {
206 av_log(avctx, AV_LOG_ERROR, "A bitrate must be set to use two pass mode.\n");
207 ret = AVERROR_INVALIDDATA;
211 if (avctx->flags & AV_CODEC_FLAG_PASS2) {
212 if (!avctx->stats_in) {
213 av_log(avctx, AV_LOG_ERROR, "No stats file provided for second pass.\n");
214 ret = AVERROR(EINVAL);
218 ctx->pass_size = (strlen(avctx->stats_in) * 3) / 4;
219 ctx->pass_data = av_malloc(ctx->pass_size);
220 if (!ctx->pass_data) {
221 av_log(avctx, AV_LOG_ERROR, "Could not allocate stats buffer.\n");
222 ret = AVERROR(ENOMEM);
226 ctx->pass_size = av_base64_decode(ctx->pass_data, avctx->stats_in, ctx->pass_size);
227 if (ctx->pass_size < 0) {
228 av_log(avctx, AV_LOG_ERROR, "Invalid pass file.\n");
229 ret = AVERROR(EINVAL);
234 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
235 const AVBitStreamFilter *filter = av_bsf_get_by_name("extract_extradata");
239 av_log(avctx, AV_LOG_ERROR, "extract_extradata bitstream filter "
240 "not found. This is a bug, please report it.\n");
245 bret = av_bsf_alloc(filter, &ctx->bsf);
251 bret = avcodec_parameters_from_context(ctx->bsf->par_in, avctx);
257 bret = av_bsf_init(ctx->bsf);
265 AVDictionaryEntry *en = NULL;
266 while ((en = av_dict_get(ctx->rav1e_opts, "", en, AV_DICT_IGNORE_SUFFIX))) {
267 int parse_ret = rav1e_config_parse(cfg, en->key, en->value);
269 av_log(avctx, AV_LOG_WARNING, "Invalid value for %s: %s.\n", en->key, en->value);
273 rret = rav1e_config_parse_int(cfg, "width", avctx->width);
275 av_log(avctx, AV_LOG_ERROR, "Invalid width passed to rav1e.\n");
276 ret = AVERROR_INVALIDDATA;
280 rret = rav1e_config_parse_int(cfg, "height", avctx->height);
282 av_log(avctx, AV_LOG_ERROR, "Invalid height passed to rav1e.\n");
283 ret = AVERROR_INVALIDDATA;
287 rret = rav1e_config_parse_int(cfg, "threads", avctx->thread_count);
289 av_log(avctx, AV_LOG_WARNING, "Invalid number of threads, defaulting to auto.\n");
291 if (ctx->speed >= 0) {
292 rret = rav1e_config_parse_int(cfg, "speed", ctx->speed);
294 av_log(avctx, AV_LOG_ERROR, "Could not set speed preset.\n");
295 ret = AVERROR_EXTERNAL;
300 /* rav1e handles precedence between 'tiles' and cols/rows for us. */
301 if (ctx->tiles > 0) {
302 rret = rav1e_config_parse_int(cfg, "tiles", ctx->tiles);
304 av_log(avctx, AV_LOG_ERROR, "Could not set number of tiles to encode with.\n");
305 ret = AVERROR_EXTERNAL;
309 if (ctx->tile_rows > 0) {
310 rret = rav1e_config_parse_int(cfg, "tile_rows", ctx->tile_rows);
312 av_log(avctx, AV_LOG_ERROR, "Could not set number of tile rows to encode with.\n");
313 ret = AVERROR_EXTERNAL;
317 if (ctx->tile_cols > 0) {
318 rret = rav1e_config_parse_int(cfg, "tile_cols", ctx->tile_cols);
320 av_log(avctx, AV_LOG_ERROR, "Could not set number of tile cols to encode with.\n");
321 ret = AVERROR_EXTERNAL;
326 if (avctx->gop_size > 0) {
327 rret = rav1e_config_parse_int(cfg, "key_frame_interval", avctx->gop_size);
329 av_log(avctx, AV_LOG_ERROR, "Could not set max keyint.\n");
330 ret = AVERROR_EXTERNAL;
335 if (avctx->keyint_min > 0) {
336 rret = rav1e_config_parse_int(cfg, "min_key_frame_interval", avctx->keyint_min);
338 av_log(avctx, AV_LOG_ERROR, "Could not set min keyint.\n");
339 ret = AVERROR_EXTERNAL;
344 if (avctx->bit_rate && ctx->quantizer < 0) {
345 int max_quantizer = avctx->qmax >= 0 ? avctx->qmax : 255;
347 rret = rav1e_config_parse_int(cfg, "quantizer", max_quantizer);
349 av_log(avctx, AV_LOG_ERROR, "Could not set max quantizer.\n");
350 ret = AVERROR_EXTERNAL;
354 if (avctx->qmin >= 0) {
355 rret = rav1e_config_parse_int(cfg, "min_quantizer", avctx->qmin);
357 av_log(avctx, AV_LOG_ERROR, "Could not set min quantizer.\n");
358 ret = AVERROR_EXTERNAL;
363 rret = rav1e_config_parse_int(cfg, "bitrate", avctx->bit_rate);
365 av_log(avctx, AV_LOG_ERROR, "Could not set bitrate.\n");
366 ret = AVERROR_INVALIDDATA;
369 } else if (ctx->quantizer >= 0) {
371 av_log(avctx, AV_LOG_WARNING, "Both bitrate and quantizer specified. Using quantizer mode.");
373 rret = rav1e_config_parse_int(cfg, "quantizer", ctx->quantizer);
375 av_log(avctx, AV_LOG_ERROR, "Could not set quantizer.\n");
376 ret = AVERROR_EXTERNAL;
381 rret = rav1e_config_set_pixel_format(cfg, desc->comp[0].depth,
382 pix_fmt_map(avctx->pix_fmt),
383 chroma_loc_map(avctx->chroma_sample_location),
384 range_map(avctx->pix_fmt, avctx->color_range));
386 av_log(avctx, AV_LOG_ERROR, "Failed to set pixel format properties.\n");
387 ret = AVERROR_INVALIDDATA;
391 /* rav1e's colorspace enums match standard values. */
392 rret = rav1e_config_set_color_description(cfg, (RaMatrixCoefficients) avctx->colorspace,
393 (RaColorPrimaries) avctx->color_primaries,
394 (RaTransferCharacteristics) avctx->color_trc);
396 av_log(avctx, AV_LOG_WARNING, "Failed to set color properties.\n");
397 if (avctx->err_recognition & AV_EF_EXPLODE) {
398 ret = AVERROR_INVALIDDATA;
403 ctx->ctx = rav1e_context_new(cfg);
405 av_log(avctx, AV_LOG_ERROR, "Failed to create rav1e encode context.\n");
406 ret = AVERROR_EXTERNAL;
414 rav1e_config_unref(cfg);
419 static int librav1e_send_frame(AVCodecContext *avctx, const AVFrame *frame)
421 librav1eContext *ctx = avctx->priv_data;
422 RaFrame *rframe = NULL;
426 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
428 rframe = rav1e_frame_new(ctx->ctx);
430 av_log(avctx, AV_LOG_ERROR, "Could not allocate new rav1e frame.\n");
431 return AVERROR(ENOMEM);
434 for (int i = 0; i < desc->nb_components; i++) {
435 int shift = i ? desc->log2_chroma_h : 0;
436 int bytes = desc->comp[0].depth == 8 ? 1 : 2;
437 rav1e_frame_fill_plane(rframe, i, frame->data[i],
438 (frame->height >> shift) * frame->linesize[i],
439 frame->linesize[i], bytes);
443 ret = rav1e_send_frame(ctx->ctx, rframe);
445 rav1e_frame_unref(rframe); /* No need to unref if flushing. */
448 case RA_ENCODER_STATUS_SUCCESS:
450 case RA_ENCODER_STATUS_ENOUGH_DATA:
451 return AVERROR(EAGAIN);
452 case RA_ENCODER_STATUS_FAILURE:
453 av_log(avctx, AV_LOG_ERROR, "Could not send frame: %s\n", rav1e_status_to_str(ret));
454 return AVERROR_EXTERNAL;
456 av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_send_frame: %s\n", ret, rav1e_status_to_str(ret));
457 return AVERROR_UNKNOWN;
463 static int librav1e_receive_packet(AVCodecContext *avctx, AVPacket *pkt)
465 librav1eContext *ctx = avctx->priv_data;
466 RaPacket *rpkt = NULL;
471 if (avctx->flags & AV_CODEC_FLAG_PASS1) {
472 int sret = get_stats(avctx, 0);
475 } else if (avctx->flags & AV_CODEC_FLAG_PASS2) {
476 int sret = set_stats(avctx);
481 ret = rav1e_receive_packet(ctx->ctx, &rpkt);
483 case RA_ENCODER_STATUS_SUCCESS:
485 case RA_ENCODER_STATUS_LIMIT_REACHED:
486 if (avctx->flags & AV_CODEC_FLAG_PASS1) {
487 int sret = get_stats(avctx, 1);
492 case RA_ENCODER_STATUS_ENCODED:
493 if (avctx->internal->draining)
495 return AVERROR(EAGAIN);
496 case RA_ENCODER_STATUS_NEED_MORE_DATA:
497 if (avctx->internal->draining) {
498 av_log(avctx, AV_LOG_ERROR, "Unexpected error when receiving packet after EOF.\n");
499 return AVERROR_EXTERNAL;
501 return AVERROR(EAGAIN);
502 case RA_ENCODER_STATUS_FAILURE:
503 av_log(avctx, AV_LOG_ERROR, "Could not encode frame: %s\n", rav1e_status_to_str(ret));
504 return AVERROR_EXTERNAL;
506 av_log(avctx, AV_LOG_ERROR, "Unknown return code %d from rav1e_receive_packet: %s\n", ret, rav1e_status_to_str(ret));
507 return AVERROR_UNKNOWN;
510 ret = av_new_packet(pkt, rpkt->len);
512 av_log(avctx, AV_LOG_ERROR, "Could not allocate packet.\n");
513 rav1e_packet_unref(rpkt);
517 memcpy(pkt->data, rpkt->data, rpkt->len);
519 if (rpkt->frame_type == RA_FRAME_TYPE_KEY)
520 pkt->flags |= AV_PKT_FLAG_KEY;
522 pkt->pts = pkt->dts = rpkt->input_frameno * avctx->ticks_per_frame;
523 rav1e_packet_unref(rpkt);
525 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
526 int ret = av_bsf_send_packet(ctx->bsf, pkt);
528 av_log(avctx, AV_LOG_ERROR, "extradata extraction send failed.\n");
529 av_packet_unref(pkt);
533 ret = av_bsf_receive_packet(ctx->bsf, pkt);
535 av_log(avctx, AV_LOG_ERROR, "extradata extraction receive failed.\n");
536 av_packet_unref(pkt);
544 #define OFFSET(x) offsetof(librav1eContext, x)
545 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
547 static const AVOption options[] = {
548 { "qp", "use constant quantizer mode", OFFSET(quantizer), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 255, VE },
549 { "speed", "what speed preset to use", OFFSET(speed), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 10, VE },
550 { "tiles", "number of tiles encode with", OFFSET(tiles), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
551 { "tile-rows", "number of tiles rows to encode with", OFFSET(tile_rows), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
552 { "tile-columns", "number of tiles columns to encode with", OFFSET(tile_cols), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT64_MAX, VE },
553 { "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 },
557 static const AVCodecDefault librav1e_defaults[] = {
560 { "keyint_min", "0" },
566 const enum AVPixelFormat librav1e_pix_fmts[] = {
569 AV_PIX_FMT_YUV420P10,
570 AV_PIX_FMT_YUV420P12,
573 AV_PIX_FMT_YUV422P10,
574 AV_PIX_FMT_YUV422P12,
577 AV_PIX_FMT_YUV444P10,
578 AV_PIX_FMT_YUV444P12,
582 static const AVClass class = {
583 .class_name = "librav1e",
584 .item_name = av_default_item_name,
586 .version = LIBAVUTIL_VERSION_INT,
589 AVCodec ff_librav1e_encoder = {
591 .long_name = NULL_IF_CONFIG_SMALL("librav1e AV1"),
592 .type = AVMEDIA_TYPE_VIDEO,
593 .id = AV_CODEC_ID_AV1,
594 .init = librav1e_encode_init,
595 .send_frame = librav1e_send_frame,
596 .receive_packet = librav1e_receive_packet,
597 .close = librav1e_encode_close,
598 .priv_data_size = sizeof(librav1eContext),
599 .priv_class = &class,
600 .defaults = librav1e_defaults,
601 .pix_fmts = librav1e_pix_fmts,
602 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
603 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
604 .wrapper_name = "librav1e",