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;
50 static int is_keyframe(NalUnitType naltype)
53 case NAL_UNIT_CODED_SLICE_BLA_W_LP:
54 case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
55 case NAL_UNIT_CODED_SLICE_BLA_N_LP:
56 case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
57 case NAL_UNIT_CODED_SLICE_IDR_N_LP:
58 case NAL_UNIT_CODED_SLICE_CRA:
65 static av_cold int libx265_encode_close(AVCodecContext *avctx)
67 libx265Context *ctx = avctx->priv_data;
69 ctx->api->param_free(ctx->params);
72 ctx->api->encoder_close(ctx->encoder);
77 static av_cold int libx265_encode_init(AVCodecContext *avctx)
79 libx265Context *ctx = avctx->priv_data;
81 ctx->api = x265_api_get(av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth);
83 ctx->api = x265_api_get(0);
85 ctx->params = ctx->api->param_alloc();
87 av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
88 return AVERROR(ENOMEM);
91 if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
94 av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", ctx->preset, ctx->tune);
95 av_log(avctx, AV_LOG_INFO, "Possible presets:");
96 for (i = 0; x265_preset_names[i]; i++)
97 av_log(avctx, AV_LOG_INFO, " %s", x265_preset_names[i]);
99 av_log(avctx, AV_LOG_INFO, "\n");
100 av_log(avctx, AV_LOG_INFO, "Possible tunes:");
101 for (i = 0; x265_tune_names[i]; i++)
102 av_log(avctx, AV_LOG_INFO, " %s", x265_tune_names[i]);
104 av_log(avctx, AV_LOG_INFO, "\n");
106 return AVERROR(EINVAL);
109 ctx->params->frameNumThreads = avctx->thread_count;
110 ctx->params->fpsNum = avctx->time_base.den;
111 ctx->params->fpsDenom = avctx->time_base.num * avctx->ticks_per_frame;
112 ctx->params->sourceWidth = avctx->width;
113 ctx->params->sourceHeight = avctx->height;
114 ctx->params->bEnablePsnr = !!(avctx->flags & AV_CODEC_FLAG_PSNR);
116 if ((avctx->color_primaries <= AVCOL_PRI_BT2020 &&
117 avctx->color_primaries != AVCOL_PRI_UNSPECIFIED) ||
118 (avctx->color_trc <= AVCOL_TRC_BT2020_12 &&
119 avctx->color_trc != AVCOL_TRC_UNSPECIFIED) ||
120 (avctx->colorspace <= AVCOL_SPC_BT2020_CL &&
121 avctx->colorspace != AVCOL_SPC_UNSPECIFIED)) {
123 ctx->params->vui.bEnableVideoSignalTypePresentFlag = 1;
124 ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
126 // x265 validates the parameters internally
127 ctx->params->vui.colorPrimaries = avctx->color_primaries;
128 ctx->params->vui.transferCharacteristics = avctx->color_trc;
129 ctx->params->vui.matrixCoeffs = avctx->colorspace;
132 if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
134 int sar_num, sar_den;
136 av_reduce(&sar_num, &sar_den,
137 avctx->sample_aspect_ratio.num,
138 avctx->sample_aspect_ratio.den, 65535);
139 snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
140 if (ctx->api->param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
141 av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
142 return AVERROR_INVALIDDATA;
146 switch (avctx->pix_fmt) {
147 case AV_PIX_FMT_YUV420P:
148 case AV_PIX_FMT_YUV420P10:
149 ctx->params->internalCsp = X265_CSP_I420;
151 case AV_PIX_FMT_YUV422P:
152 case AV_PIX_FMT_YUV422P10:
153 ctx->params->internalCsp = X265_CSP_I422;
155 case AV_PIX_FMT_YUV444P:
156 case AV_PIX_FMT_YUV444P10:
157 ctx->params->internalCsp = X265_CSP_I444;
164 snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
165 if (ctx->api->param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
166 av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
167 return AVERROR(EINVAL);
169 } else if (avctx->bit_rate > 0) {
170 ctx->params->rc.bitrate = avctx->bit_rate / 1000;
171 ctx->params->rc.rateControlMode = X265_RC_ABR;
174 if (!(avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER))
175 ctx->params->bRepeatHeaders = 1;
177 if (ctx->x265_opts) {
178 AVDictionary *dict = NULL;
179 AVDictionaryEntry *en = NULL;
181 if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
182 while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
183 int parse_ret = ctx->api->param_parse(ctx->params, en->key, en->value);
186 case X265_PARAM_BAD_NAME:
187 av_log(avctx, AV_LOG_WARNING,
188 "Unknown option: %s.\n", en->key);
190 case X265_PARAM_BAD_VALUE:
191 av_log(avctx, AV_LOG_WARNING,
192 "Invalid value for %s: %s.\n", en->key, en->value);
202 ctx->encoder = ctx->api->encoder_open(ctx->params);
204 av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
205 libx265_encode_close(avctx);
206 return AVERROR_INVALIDDATA;
209 if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
213 avctx->extradata_size = ctx->api->encoder_headers(ctx->encoder, &nal, &nnal);
214 if (avctx->extradata_size <= 0) {
215 av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
216 libx265_encode_close(avctx);
217 return AVERROR_INVALIDDATA;
220 avctx->extradata = av_malloc(avctx->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
221 if (!avctx->extradata) {
222 av_log(avctx, AV_LOG_ERROR,
223 "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
224 libx265_encode_close(avctx);
225 return AVERROR(ENOMEM);
228 memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
234 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
235 const AVFrame *pic, int *got_packet)
237 libx265Context *ctx = avctx->priv_data;
238 x265_picture x265pic;
239 x265_picture x265pic_out = { 0 };
247 ctx->api->picture_init(ctx->params, &x265pic);
250 for (i = 0; i < 3; i++) {
251 x265pic.planes[i] = pic->data[i];
252 x265pic.stride[i] = pic->linesize[i];
255 x265pic.pts = pic->pts;
256 x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth;
258 x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ? X265_TYPE_I :
259 pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
260 pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
264 ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
265 pic ? &x265pic : NULL, &x265pic_out);
267 return AVERROR_EXTERNAL;
272 for (i = 0; i < nnal; i++)
273 payload += nal[i].sizeBytes;
275 ret = ff_alloc_packet(pkt, payload);
277 av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
282 for (i = 0; i < nnal; i++) {
283 memcpy(dst, nal[i].payload, nal[i].sizeBytes);
284 dst += nal[i].sizeBytes;
286 if (is_keyframe(nal[i].type))
287 pkt->flags |= AV_PKT_FLAG_KEY;
290 pkt->pts = x265pic_out.pts;
291 pkt->dts = x265pic_out.dts;
293 #if FF_API_CODED_FRAME
294 FF_DISABLE_DEPRECATION_WARNINGS
295 switch (x265pic_out.sliceType) {
298 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
301 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
304 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
307 FF_ENABLE_DEPRECATION_WARNINGS
314 static const enum AVPixelFormat x265_csp_eight[] = {
321 static const enum AVPixelFormat x265_csp_twelve[] = {
325 AV_PIX_FMT_YUV420P10,
326 AV_PIX_FMT_YUV422P10,
327 AV_PIX_FMT_YUV444P10,
331 static av_cold void libx265_encode_init_csp(AVCodec *codec)
333 if (x265_api_get(10))
334 codec->pix_fmts = x265_csp_twelve;
335 else if (x265_api_get(8))
336 codec->pix_fmts = x265_csp_eight;
339 #define OFFSET(x) offsetof(libx265Context, x)
340 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
341 static const AVOption options[] = {
342 { "crf", "set the x265 crf", OFFSET(crf), AV_OPT_TYPE_FLOAT, { .dbl = -1 }, -1, FLT_MAX, VE },
343 { "preset", "set the x265 preset", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
344 { "tune", "set the x265 tune parameter", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
345 { "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 },
349 static const AVClass class = {
350 .class_name = "libx265",
351 .item_name = av_default_item_name,
353 .version = LIBAVUTIL_VERSION_INT,
356 static const AVCodecDefault x265_defaults[] = {
361 AVCodec ff_libx265_encoder = {
363 .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
364 .type = AVMEDIA_TYPE_VIDEO,
365 .id = AV_CODEC_ID_HEVC,
366 .init = libx265_encode_init,
367 .init_static_data = libx265_encode_init_csp,
368 .encode2 = libx265_encode_frame,
369 .close = libx265_encode_close,
370 .priv_data_size = sizeof(libx265Context),
371 .priv_class = &class,
372 .defaults = x265_defaults,
373 .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,