4 * Copyright (c) 2013-2014 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
24 #define X265_API_IMPORTS 1
30 #include "libavutil/internal.h"
31 #include "libavutil/common.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixdesc.h"
37 typedef struct libx265Context {
40 x265_encoder *encoder;
52 static int is_keyframe(NalUnitType naltype)
55 case NAL_UNIT_CODED_SLICE_BLA_W_LP:
56 case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
57 case NAL_UNIT_CODED_SLICE_BLA_N_LP:
58 case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
59 case NAL_UNIT_CODED_SLICE_IDR_N_LP:
60 case NAL_UNIT_CODED_SLICE_CRA:
67 static av_cold int libx265_encode_close(AVCodecContext *avctx)
69 libx265Context *ctx = avctx->priv_data;
71 ctx->api->param_free(ctx->params);
74 ctx->api->encoder_close(ctx->encoder);
79 static av_cold int libx265_encode_init(AVCodecContext *avctx)
81 libx265Context *ctx = avctx->priv_data;
82 AVCPBProperties *cpb_props = NULL;
84 ctx->api = x265_api_get(av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth);
86 ctx->api = x265_api_get(0);
88 ctx->params = ctx->api->param_alloc();
90 av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
91 return AVERROR(ENOMEM);
94 if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
97 av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", ctx->preset, ctx->tune);
98 av_log(avctx, AV_LOG_INFO, "Possible presets:");
99 for (i = 0; x265_preset_names[i]; i++)
100 av_log(avctx, AV_LOG_INFO, " %s", x265_preset_names[i]);
102 av_log(avctx, AV_LOG_INFO, "\n");
103 av_log(avctx, AV_LOG_INFO, "Possible tunes:");
104 for (i = 0; x265_tune_names[i]; i++)
105 av_log(avctx, AV_LOG_INFO, " %s", x265_tune_names[i]);
107 av_log(avctx, AV_LOG_INFO, "\n");
109 return AVERROR(EINVAL);
112 ctx->params->frameNumThreads = avctx->thread_count;
113 if (avctx->framerate.num > 0 && avctx->framerate.den > 0) {
114 ctx->params->fpsNum = avctx->framerate.num;
115 ctx->params->fpsDenom = avctx->framerate.den;
117 ctx->params->fpsNum = avctx->time_base.den;
118 ctx->params->fpsDenom = avctx->time_base.num * avctx->ticks_per_frame;
120 ctx->params->sourceWidth = avctx->width;
121 ctx->params->sourceHeight = avctx->height;
122 ctx->params->bEnablePsnr = !!(avctx->flags & AV_CODEC_FLAG_PSNR);
123 ctx->params->bOpenGOP = !(avctx->flags & AV_CODEC_FLAG_CLOSED_GOP);
125 /* Tune the CTU size based on input resolution. */
126 if (ctx->params->sourceWidth < 64 || ctx->params->sourceHeight < 64)
127 ctx->params->maxCUSize = 32;
128 if (ctx->params->sourceWidth < 32 || ctx->params->sourceHeight < 32)
129 ctx->params->maxCUSize = 16;
130 if (ctx->params->sourceWidth < 16 || ctx->params->sourceHeight < 16) {
131 av_log(avctx, AV_LOG_ERROR, "Image size is too small (%dx%d).\n",
132 ctx->params->sourceWidth, ctx->params->sourceHeight);
133 return AVERROR(EINVAL);
137 ctx->params->vui.bEnableVideoSignalTypePresentFlag = 1;
139 ctx->params->vui.bEnableVideoFullRangeFlag = avctx->pix_fmt == AV_PIX_FMT_YUVJ420P ||
140 avctx->pix_fmt == AV_PIX_FMT_YUVJ422P ||
141 avctx->pix_fmt == AV_PIX_FMT_YUVJ444P ||
142 avctx->color_range == AVCOL_RANGE_JPEG;
144 if ((avctx->color_primaries <= AVCOL_PRI_SMPTE432 &&
145 avctx->color_primaries != AVCOL_PRI_UNSPECIFIED) ||
146 (avctx->color_trc <= AVCOL_TRC_ARIB_STD_B67 &&
147 avctx->color_trc != AVCOL_TRC_UNSPECIFIED) ||
148 (avctx->colorspace <= AVCOL_SPC_ICTCP &&
149 avctx->colorspace != AVCOL_SPC_UNSPECIFIED)) {
151 ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
153 // x265 validates the parameters internally
154 ctx->params->vui.colorPrimaries = avctx->color_primaries;
155 ctx->params->vui.transferCharacteristics = avctx->color_trc;
156 ctx->params->vui.matrixCoeffs = avctx->colorspace;
159 if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
161 int sar_num, sar_den;
163 av_reduce(&sar_num, &sar_den,
164 avctx->sample_aspect_ratio.num,
165 avctx->sample_aspect_ratio.den, 65535);
166 snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
167 if (ctx->api->param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
168 av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
169 return AVERROR_INVALIDDATA;
173 switch (avctx->pix_fmt) {
174 case AV_PIX_FMT_YUV420P:
175 case AV_PIX_FMT_YUV420P10:
176 case AV_PIX_FMT_YUV420P12:
177 ctx->params->internalCsp = X265_CSP_I420;
179 case AV_PIX_FMT_YUV422P:
180 case AV_PIX_FMT_YUV422P10:
181 case AV_PIX_FMT_YUV422P12:
182 ctx->params->internalCsp = X265_CSP_I422;
184 case AV_PIX_FMT_GBRP:
185 case AV_PIX_FMT_GBRP10:
186 case AV_PIX_FMT_GBRP12:
187 ctx->params->vui.matrixCoeffs = AVCOL_SPC_RGB;
188 ctx->params->vui.bEnableVideoSignalTypePresentFlag = 1;
189 ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
190 case AV_PIX_FMT_YUV444P:
191 case AV_PIX_FMT_YUV444P10:
192 case AV_PIX_FMT_YUV444P12:
193 ctx->params->internalCsp = X265_CSP_I444;
195 case AV_PIX_FMT_GRAY8:
196 case AV_PIX_FMT_GRAY10:
197 case AV_PIX_FMT_GRAY12:
198 if (ctx->api->api_build_number < 85) {
199 av_log(avctx, AV_LOG_ERROR,
200 "libx265 version is %d, must be at least 85 for gray encoding.\n",
201 ctx->api->api_build_number);
202 return AVERROR_INVALIDDATA;
204 ctx->params->internalCsp = X265_CSP_I400;
211 snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
212 if (ctx->api->param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
213 av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
214 return AVERROR(EINVAL);
216 } else if (avctx->bit_rate > 0) {
217 ctx->params->rc.bitrate = avctx->bit_rate / 1000;
218 ctx->params->rc.rateControlMode = X265_RC_ABR;
221 ctx->params->rc.vbvBufferSize = avctx->rc_buffer_size / 1000;
222 ctx->params->rc.vbvMaxBitrate = avctx->rc_max_rate / 1000;
224 cpb_props = ff_add_cpb_side_data(avctx);
226 return AVERROR(ENOMEM);
227 cpb_props->buffer_size = ctx->params->rc.vbvBufferSize * 1000;
228 cpb_props->max_bitrate = ctx->params->rc.vbvMaxBitrate * 1000;
229 cpb_props->avg_bitrate = ctx->params->rc.bitrate * 1000;
231 if (!(avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER))
232 ctx->params->bRepeatHeaders = 1;
234 if (ctx->x265_opts) {
235 AVDictionary *dict = NULL;
236 AVDictionaryEntry *en = NULL;
238 if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
239 while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
240 int parse_ret = ctx->api->param_parse(ctx->params, en->key, en->value);
243 case X265_PARAM_BAD_NAME:
244 av_log(avctx, AV_LOG_WARNING,
245 "Unknown option: %s.\n", en->key);
247 case X265_PARAM_BAD_VALUE:
248 av_log(avctx, AV_LOG_WARNING,
249 "Invalid value for %s: %s.\n", en->key, en->value);
259 if (ctx->params->rc.vbvBufferSize && avctx->rc_initial_buffer_occupancy > 1000 &&
260 ctx->params->rc.vbvBufferInit == 0.9) {
261 ctx->params->rc.vbvBufferInit = (float)avctx->rc_initial_buffer_occupancy / 1000;
265 if (ctx->api->param_apply_profile(ctx->params, ctx->profile) < 0) {
267 av_log(avctx, AV_LOG_ERROR, "Invalid or incompatible profile set: %s.\n", ctx->profile);
268 av_log(avctx, AV_LOG_INFO, "Possible profiles:");
269 for (i = 0; x265_profile_names[i]; i++)
270 av_log(avctx, AV_LOG_INFO, " %s", x265_profile_names[i]);
271 av_log(avctx, AV_LOG_INFO, "\n");
272 return AVERROR(EINVAL);
276 ctx->encoder = ctx->api->encoder_open(ctx->params);
278 av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
279 libx265_encode_close(avctx);
280 return AVERROR_INVALIDDATA;
283 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
287 avctx->extradata_size = ctx->api->encoder_headers(ctx->encoder, &nal, &nnal);
288 if (avctx->extradata_size <= 0) {
289 av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
290 libx265_encode_close(avctx);
291 return AVERROR_INVALIDDATA;
294 avctx->extradata = av_malloc(avctx->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
295 if (!avctx->extradata) {
296 av_log(avctx, AV_LOG_ERROR,
297 "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
298 libx265_encode_close(avctx);
299 return AVERROR(ENOMEM);
302 memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
308 static av_cold int libx265_encode_set_roi(libx265Context *ctx, const AVFrame *frame, x265_picture* pic)
310 AVFrameSideData *sd = av_frame_get_side_data(frame, AV_FRAME_DATA_REGIONS_OF_INTEREST);
312 if (ctx->params->rc.aqMode == X265_AQ_NONE) {
313 av_log(ctx, AV_LOG_WARNING, "Adaptive quantization must be enabled to use ROI encoding, skipping ROI.\n");
315 /* 8x8 block when qg-size is 8, 16*16 block otherwise. */
316 int mb_size = (ctx->params->rc.qgSize == 8) ? 8 : 16;
317 int mbx = (frame->width + mb_size - 1) / mb_size;
318 int mby = (frame->height + mb_size - 1) / mb_size;
320 AVRegionOfInterest *roi;
321 float *qoffsets; /* will be freed after encode is called. */
322 qoffsets = av_mallocz_array(mbx * mby, sizeof(*qoffsets));
324 return AVERROR(ENOMEM);
326 nb_rois = sd->size / sizeof(AVRegionOfInterest);
327 roi = (AVRegionOfInterest*)sd->data;
328 for (int count = 0; count < nb_rois; count++) {
329 int starty = FFMIN(mby, roi->top / mb_size);
330 int endy = FFMIN(mby, (roi->bottom + mb_size - 1)/ mb_size);
331 int startx = FFMIN(mbx, roi->left / mb_size);
332 int endx = FFMIN(mbx, (roi->right + mb_size - 1)/ mb_size);
335 if (roi->self_size == 0) {
337 av_log(ctx, AV_LOG_ERROR, "AVRegionOfInterest.self_size must be set to sizeof(AVRegionOfInterest).\n");
338 return AVERROR(EINVAL);
341 if (roi->qoffset.den == 0) {
343 av_log(ctx, AV_LOG_ERROR, "AVRegionOfInterest.qoffset.den must not be zero.\n");
344 return AVERROR(EINVAL);
346 qoffset = roi->qoffset.num * 1.0f / roi->qoffset.den;
347 qoffset = av_clipf(qoffset, -1.0f, 1.0f);
349 /* qp range of x265 is from 0 to 51, just choose 25 as the scale value,
350 * so the range of final qoffset is [-25.0, 25.0].
352 qoffset = qoffset * 25;
354 for (int y = starty; y < endy; y++)
355 for (int x = startx; x < endx; x++)
356 qoffsets[x + y*mbx] = qoffset;
358 roi = (AVRegionOfInterest*)((char*)roi + roi->self_size);
361 pic->quantOffsets = qoffsets;
367 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
368 const AVFrame *pic, int *got_packet)
370 libx265Context *ctx = avctx->priv_data;
371 x265_picture x265pic;
372 x265_picture x265pic_out = { 0 };
380 ctx->api->picture_init(ctx->params, &x265pic);
383 for (i = 0; i < 3; i++) {
384 x265pic.planes[i] = pic->data[i];
385 x265pic.stride[i] = pic->linesize[i];
388 x265pic.pts = pic->pts;
389 x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth;
391 x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ?
392 (ctx->forced_idr ? X265_TYPE_IDR : X265_TYPE_I) :
393 pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
394 pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
397 ret = libx265_encode_set_roi(ctx, pic, &x265pic);
402 ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
403 pic ? &x265pic : NULL, &x265pic_out);
405 av_freep(&x265pic.quantOffsets);
408 return AVERROR_EXTERNAL;
413 for (i = 0; i < nnal; i++)
414 payload += nal[i].sizeBytes;
416 ret = ff_alloc_packet2(avctx, pkt, payload, payload);
418 av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
423 for (i = 0; i < nnal; i++) {
424 memcpy(dst, nal[i].payload, nal[i].sizeBytes);
425 dst += nal[i].sizeBytes;
427 if (is_keyframe(nal[i].type))
428 pkt->flags |= AV_PKT_FLAG_KEY;
431 pkt->pts = x265pic_out.pts;
432 pkt->dts = x265pic_out.dts;
434 #if FF_API_CODED_FRAME
435 FF_DISABLE_DEPRECATION_WARNINGS
436 switch (x265pic_out.sliceType) {
439 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
442 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
445 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
448 FF_ENABLE_DEPRECATION_WARNINGS
451 #if X265_BUILD >= 130
452 if (x265pic_out.sliceType == X265_TYPE_B)
454 if (x265pic_out.frameData.sliceType == 'b')
456 pkt->flags |= AV_PKT_FLAG_DISPOSABLE;
462 static const enum AVPixelFormat x265_csp_eight[] = {
474 static const enum AVPixelFormat x265_csp_ten[] = {
482 AV_PIX_FMT_YUV420P10,
483 AV_PIX_FMT_YUV422P10,
484 AV_PIX_FMT_YUV444P10,
491 static const enum AVPixelFormat x265_csp_twelve[] = {
499 AV_PIX_FMT_YUV420P10,
500 AV_PIX_FMT_YUV422P10,
501 AV_PIX_FMT_YUV444P10,
503 AV_PIX_FMT_YUV420P12,
504 AV_PIX_FMT_YUV422P12,
505 AV_PIX_FMT_YUV444P12,
513 static av_cold void libx265_encode_init_csp(AVCodec *codec)
515 if (x265_api_get(12))
516 codec->pix_fmts = x265_csp_twelve;
517 else if (x265_api_get(10))
518 codec->pix_fmts = x265_csp_ten;
519 else if (x265_api_get(8))
520 codec->pix_fmts = x265_csp_eight;
523 #define OFFSET(x) offsetof(libx265Context, x)
524 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
525 static const AVOption options[] = {
526 { "crf", "set the x265 crf", OFFSET(crf), AV_OPT_TYPE_FLOAT, { .dbl = -1 }, -1, FLT_MAX, VE },
527 { "forced-idr", "if forcing keyframes, force them as IDR frames", OFFSET(forced_idr),AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
528 { "preset", "set the x265 preset", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
529 { "tune", "set the x265 tune parameter", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
530 { "profile", "set the x265 profile", OFFSET(profile), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
531 { "x265-params", "set the x265 configuration using a :-separated list of key=value parameters", OFFSET(x265_opts), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
535 static const AVClass class = {
536 .class_name = "libx265",
537 .item_name = av_default_item_name,
539 .version = LIBAVUTIL_VERSION_INT,
542 static const AVCodecDefault x265_defaults[] = {
547 AVCodec ff_libx265_encoder = {
549 .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
550 .type = AVMEDIA_TYPE_VIDEO,
551 .id = AV_CODEC_ID_HEVC,
552 .init = libx265_encode_init,
553 .init_static_data = libx265_encode_init_csp,
554 .encode2 = libx265_encode_frame,
555 .close = libx265_encode_close,
556 .priv_data_size = sizeof(libx265Context),
557 .priv_class = &class,
558 .defaults = x265_defaults,
559 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
560 .wrapper_name = "libx265",