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;
83 ctx->api = x265_api_get(av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth);
85 ctx->api = x265_api_get(0);
87 ctx->params = ctx->api->param_alloc();
89 av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
90 return AVERROR(ENOMEM);
93 if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
96 av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", ctx->preset, ctx->tune);
97 av_log(avctx, AV_LOG_INFO, "Possible presets:");
98 for (i = 0; x265_preset_names[i]; i++)
99 av_log(avctx, AV_LOG_INFO, " %s", x265_preset_names[i]);
101 av_log(avctx, AV_LOG_INFO, "\n");
102 av_log(avctx, AV_LOG_INFO, "Possible tunes:");
103 for (i = 0; x265_tune_names[i]; i++)
104 av_log(avctx, AV_LOG_INFO, " %s", x265_tune_names[i]);
106 av_log(avctx, AV_LOG_INFO, "\n");
108 return AVERROR(EINVAL);
111 ctx->params->frameNumThreads = avctx->thread_count;
112 ctx->params->fpsNum = avctx->time_base.den;
113 ctx->params->fpsDenom = avctx->time_base.num * avctx->ticks_per_frame;
114 ctx->params->sourceWidth = avctx->width;
115 ctx->params->sourceHeight = avctx->height;
116 ctx->params->bEnablePsnr = !!(avctx->flags & AV_CODEC_FLAG_PSNR);
118 if ((avctx->color_primaries <= AVCOL_PRI_SMPTE432 &&
119 avctx->color_primaries != AVCOL_PRI_UNSPECIFIED) ||
120 (avctx->color_trc <= AVCOL_TRC_ARIB_STD_B67 &&
121 avctx->color_trc != AVCOL_TRC_UNSPECIFIED) ||
122 (avctx->colorspace <= AVCOL_SPC_ICTCP &&
123 avctx->colorspace != AVCOL_SPC_UNSPECIFIED)) {
125 ctx->params->vui.bEnableVideoSignalTypePresentFlag = 1;
126 ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
128 // x265 validates the parameters internally
129 ctx->params->vui.colorPrimaries = avctx->color_primaries;
130 ctx->params->vui.transferCharacteristics = avctx->color_trc;
131 ctx->params->vui.matrixCoeffs = avctx->colorspace;
134 if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
136 int sar_num, sar_den;
138 av_reduce(&sar_num, &sar_den,
139 avctx->sample_aspect_ratio.num,
140 avctx->sample_aspect_ratio.den, 65535);
141 snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
142 if (ctx->api->param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
143 av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
144 return AVERROR_INVALIDDATA;
148 switch (avctx->pix_fmt) {
149 case AV_PIX_FMT_YUV420P:
150 case AV_PIX_FMT_YUV420P10:
151 case AV_PIX_FMT_YUV420P12:
152 ctx->params->internalCsp = X265_CSP_I420;
154 case AV_PIX_FMT_YUV422P:
155 case AV_PIX_FMT_YUV422P10:
156 case AV_PIX_FMT_YUV422P12:
157 ctx->params->internalCsp = X265_CSP_I422;
159 case AV_PIX_FMT_GBRP:
160 case AV_PIX_FMT_GBRP10:
161 case AV_PIX_FMT_GBRP12:
162 ctx->params->vui.matrixCoeffs = AVCOL_SPC_RGB;
163 ctx->params->vui.bEnableVideoSignalTypePresentFlag = 1;
164 ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
165 case AV_PIX_FMT_YUV444P:
166 case AV_PIX_FMT_YUV444P10:
167 case AV_PIX_FMT_YUV444P12:
168 ctx->params->internalCsp = X265_CSP_I444;
170 case AV_PIX_FMT_GRAY8:
171 case AV_PIX_FMT_GRAY10:
172 case AV_PIX_FMT_GRAY12:
173 if (ctx->api->api_build_number < 85) {
174 av_log(avctx, AV_LOG_ERROR,
175 "libx265 version is %d, must be at least 85 for gray encoding.\n",
176 ctx->api->api_build_number);
177 return AVERROR_INVALIDDATA;
179 ctx->params->internalCsp = X265_CSP_I400;
186 snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
187 if (ctx->api->param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
188 av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
189 return AVERROR(EINVAL);
191 } else if (avctx->bit_rate > 0) {
192 ctx->params->rc.bitrate = avctx->bit_rate / 1000;
193 ctx->params->rc.rateControlMode = X265_RC_ABR;
196 if (!(avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER))
197 ctx->params->bRepeatHeaders = 1;
199 if (ctx->x265_opts) {
200 AVDictionary *dict = NULL;
201 AVDictionaryEntry *en = NULL;
203 if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
204 while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
205 int parse_ret = ctx->api->param_parse(ctx->params, en->key, en->value);
208 case X265_PARAM_BAD_NAME:
209 av_log(avctx, AV_LOG_WARNING,
210 "Unknown option: %s.\n", en->key);
212 case X265_PARAM_BAD_VALUE:
213 av_log(avctx, AV_LOG_WARNING,
214 "Invalid value for %s: %s.\n", en->key, en->value);
225 if (ctx->api->param_apply_profile(ctx->params, ctx->profile) < 0) {
227 av_log(avctx, AV_LOG_ERROR, "Invalid or incompatible profile set: %s.\n", ctx->profile);
228 av_log(avctx, AV_LOG_INFO, "Possible profiles:");
229 for (i = 0; x265_profile_names[i]; i++)
230 av_log(avctx, AV_LOG_INFO, " %s", x265_profile_names[i]);
231 av_log(avctx, AV_LOG_INFO, "\n");
232 return AVERROR(EINVAL);
236 ctx->encoder = ctx->api->encoder_open(ctx->params);
238 av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
239 libx265_encode_close(avctx);
240 return AVERROR_INVALIDDATA;
243 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
247 avctx->extradata_size = ctx->api->encoder_headers(ctx->encoder, &nal, &nnal);
248 if (avctx->extradata_size <= 0) {
249 av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
250 libx265_encode_close(avctx);
251 return AVERROR_INVALIDDATA;
254 avctx->extradata = av_malloc(avctx->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
255 if (!avctx->extradata) {
256 av_log(avctx, AV_LOG_ERROR,
257 "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
258 libx265_encode_close(avctx);
259 return AVERROR(ENOMEM);
262 memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
268 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
269 const AVFrame *pic, int *got_packet)
271 libx265Context *ctx = avctx->priv_data;
272 x265_picture x265pic;
273 x265_picture x265pic_out = { 0 };
281 ctx->api->picture_init(ctx->params, &x265pic);
284 for (i = 0; i < 3; i++) {
285 x265pic.planes[i] = pic->data[i];
286 x265pic.stride[i] = pic->linesize[i];
289 x265pic.pts = pic->pts;
290 x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth;
292 x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ?
293 (ctx->forced_idr ? X265_TYPE_IDR : X265_TYPE_I) :
294 pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
295 pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
299 ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
300 pic ? &x265pic : NULL, &x265pic_out);
302 return AVERROR_EXTERNAL;
307 for (i = 0; i < nnal; i++)
308 payload += nal[i].sizeBytes;
310 ret = ff_alloc_packet2(avctx, pkt, payload, payload);
312 av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
317 for (i = 0; i < nnal; i++) {
318 memcpy(dst, nal[i].payload, nal[i].sizeBytes);
319 dst += nal[i].sizeBytes;
321 if (is_keyframe(nal[i].type))
322 pkt->flags |= AV_PKT_FLAG_KEY;
325 pkt->pts = x265pic_out.pts;
326 pkt->dts = x265pic_out.dts;
328 #if FF_API_CODED_FRAME
329 FF_DISABLE_DEPRECATION_WARNINGS
330 switch (x265pic_out.sliceType) {
333 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
336 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
339 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
342 FF_ENABLE_DEPRECATION_WARNINGS
345 #if X265_BUILD >= 130
346 if (x265pic_out.sliceType == X265_TYPE_B)
348 if (x265pic_out.frameData.sliceType == 'b')
350 pkt->flags |= AV_PKT_FLAG_DISPOSABLE;
356 static const enum AVPixelFormat x265_csp_eight[] = {
365 static const enum AVPixelFormat x265_csp_ten[] = {
370 AV_PIX_FMT_YUV420P10,
371 AV_PIX_FMT_YUV422P10,
372 AV_PIX_FMT_YUV444P10,
379 static const enum AVPixelFormat x265_csp_twelve[] = {
384 AV_PIX_FMT_YUV420P10,
385 AV_PIX_FMT_YUV422P10,
386 AV_PIX_FMT_YUV444P10,
388 AV_PIX_FMT_YUV420P12,
389 AV_PIX_FMT_YUV422P12,
390 AV_PIX_FMT_YUV444P12,
398 static av_cold void libx265_encode_init_csp(AVCodec *codec)
400 if (x265_api_get(12))
401 codec->pix_fmts = x265_csp_twelve;
402 else if (x265_api_get(10))
403 codec->pix_fmts = x265_csp_ten;
404 else if (x265_api_get(8))
405 codec->pix_fmts = x265_csp_eight;
408 #define OFFSET(x) offsetof(libx265Context, x)
409 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
410 static const AVOption options[] = {
411 { "crf", "set the x265 crf", OFFSET(crf), AV_OPT_TYPE_FLOAT, { .dbl = -1 }, -1, FLT_MAX, VE },
412 { "forced-idr", "if forcing keyframes, force them as IDR frames", OFFSET(forced_idr),AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
413 { "preset", "set the x265 preset", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
414 { "tune", "set the x265 tune parameter", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
415 { "profile", "set the x265 profile", OFFSET(profile), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
416 { "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 },
420 static const AVClass class = {
421 .class_name = "libx265",
422 .item_name = av_default_item_name,
424 .version = LIBAVUTIL_VERSION_INT,
427 static const AVCodecDefault x265_defaults[] = {
432 AVCodec ff_libx265_encoder = {
434 .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
435 .type = AVMEDIA_TYPE_VIDEO,
436 .id = AV_CODEC_ID_HEVC,
437 .init = libx265_encode_init,
438 .init_static_data = libx265_encode_init_csp,
439 .encode2 = libx265_encode_frame,
440 .close = libx265_encode_close,
441 .priv_data_size = sizeof(libx265Context),
442 .priv_class = &class,
443 .defaults = x265_defaults,
444 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
445 .wrapper_name = "libx265",