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 av_frame_free(&avctx->coded_frame);
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_minus1 + 1);
85 ctx->api = x265_api_get(0);
87 if (avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL &&
88 !av_pix_fmt_desc_get(avctx->pix_fmt)->log2_chroma_w) {
89 av_log(avctx, AV_LOG_ERROR,
90 "4:2:2 and 4:4:4 support is not fully defined for HEVC yet. "
91 "Set -strict experimental to encode anyway.\n");
92 return AVERROR(ENOSYS);
95 avctx->coded_frame = av_frame_alloc();
96 if (!avctx->coded_frame) {
97 av_log(avctx, AV_LOG_ERROR, "Could not allocate frame.\n");
98 return AVERROR(ENOMEM);
101 ctx->params = ctx->api->param_alloc();
103 av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
104 return AVERROR(ENOMEM);
107 if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
110 av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", ctx->preset, ctx->tune);
111 av_log(avctx, AV_LOG_INFO, "Possible presets:");
112 for (i = 0; x265_preset_names[i]; i++)
113 av_log(avctx, AV_LOG_INFO, " %s", x265_preset_names[i]);
115 av_log(avctx, AV_LOG_INFO, "\n");
116 av_log(avctx, AV_LOG_INFO, "Possible tunes:");
117 for (i = 0; x265_tune_names[i]; i++)
118 av_log(avctx, AV_LOG_INFO, " %s", x265_tune_names[i]);
120 av_log(avctx, AV_LOG_INFO, "\n");
122 return AVERROR(EINVAL);
125 ctx->params->frameNumThreads = avctx->thread_count;
126 ctx->params->fpsNum = avctx->time_base.den;
127 ctx->params->fpsDenom = avctx->time_base.num * avctx->ticks_per_frame;
128 ctx->params->sourceWidth = avctx->width;
129 ctx->params->sourceHeight = avctx->height;
130 ctx->params->bEnablePsnr = !!(avctx->flags & CODEC_FLAG_PSNR);
132 if ((avctx->color_primaries <= AVCOL_PRI_BT2020 &&
133 avctx->color_primaries != AVCOL_PRI_UNSPECIFIED) ||
134 (avctx->color_trc <= AVCOL_TRC_BT2020_12 &&
135 avctx->color_trc != AVCOL_TRC_UNSPECIFIED) ||
136 (avctx->colorspace <= AVCOL_SPC_BT2020_CL &&
137 avctx->colorspace != AVCOL_SPC_UNSPECIFIED)) {
139 ctx->params->vui.bEnableVideoSignalTypePresentFlag = 1;
140 ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
142 // x265 validates the parameters internally
143 ctx->params->vui.colorPrimaries = avctx->color_primaries;
144 ctx->params->vui.transferCharacteristics = avctx->color_trc;
145 ctx->params->vui.matrixCoeffs = avctx->colorspace;
148 if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
150 int sar_num, sar_den;
152 av_reduce(&sar_num, &sar_den,
153 avctx->sample_aspect_ratio.num,
154 avctx->sample_aspect_ratio.den, 65535);
155 snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
156 if (ctx->api->param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
157 av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
158 return AVERROR_INVALIDDATA;
162 switch (avctx->pix_fmt) {
163 case AV_PIX_FMT_YUV420P:
164 case AV_PIX_FMT_YUV420P10:
165 ctx->params->internalCsp = X265_CSP_I420;
167 case AV_PIX_FMT_YUV422P:
168 case AV_PIX_FMT_YUV422P10:
169 ctx->params->internalCsp = X265_CSP_I422;
171 case AV_PIX_FMT_YUV444P:
172 case AV_PIX_FMT_YUV444P10:
173 ctx->params->internalCsp = X265_CSP_I444;
180 snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
181 if (ctx->api->param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
182 av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
183 return AVERROR(EINVAL);
185 } else if (avctx->bit_rate > 0) {
186 ctx->params->rc.bitrate = avctx->bit_rate / 1000;
187 ctx->params->rc.rateControlMode = X265_RC_ABR;
190 if (!(avctx->flags & CODEC_FLAG_GLOBAL_HEADER))
191 ctx->params->bRepeatHeaders = 1;
193 if (ctx->x265_opts) {
194 AVDictionary *dict = NULL;
195 AVDictionaryEntry *en = NULL;
197 if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
198 while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
199 int parse_ret = ctx->api->param_parse(ctx->params, en->key, en->value);
202 case X265_PARAM_BAD_NAME:
203 av_log(avctx, AV_LOG_WARNING,
204 "Unknown option: %s.\n", en->key);
206 case X265_PARAM_BAD_VALUE:
207 av_log(avctx, AV_LOG_WARNING,
208 "Invalid value for %s: %s.\n", en->key, en->value);
218 ctx->encoder = ctx->api->encoder_open(ctx->params);
220 av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
221 libx265_encode_close(avctx);
222 return AVERROR_INVALIDDATA;
225 if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
229 avctx->extradata_size = ctx->api->encoder_headers(ctx->encoder, &nal, &nnal);
230 if (avctx->extradata_size <= 0) {
231 av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
232 libx265_encode_close(avctx);
233 return AVERROR_INVALIDDATA;
236 avctx->extradata = av_malloc(avctx->extradata_size + FF_INPUT_BUFFER_PADDING_SIZE);
237 if (!avctx->extradata) {
238 av_log(avctx, AV_LOG_ERROR,
239 "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
240 libx265_encode_close(avctx);
241 return AVERROR(ENOMEM);
244 memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
250 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
251 const AVFrame *pic, int *got_packet)
253 libx265Context *ctx = avctx->priv_data;
254 x265_picture x265pic;
255 x265_picture x265pic_out = { 0 };
263 ctx->api->picture_init(ctx->params, &x265pic);
266 for (i = 0; i < 3; i++) {
267 x265pic.planes[i] = pic->data[i];
268 x265pic.stride[i] = pic->linesize[i];
271 x265pic.pts = pic->pts;
272 x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth_minus1 + 1;
274 x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ? X265_TYPE_I :
275 pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
276 pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
280 ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
281 pic ? &x265pic : NULL, &x265pic_out);
283 return AVERROR_EXTERNAL;
288 for (i = 0; i < nnal; i++)
289 payload += nal[i].sizeBytes;
291 ret = ff_alloc_packet(pkt, payload);
293 av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
298 for (i = 0; i < nnal; i++) {
299 memcpy(dst, nal[i].payload, nal[i].sizeBytes);
300 dst += nal[i].sizeBytes;
302 if (is_keyframe(nal[i].type))
303 pkt->flags |= AV_PKT_FLAG_KEY;
306 pkt->pts = x265pic_out.pts;
307 pkt->dts = x265pic_out.dts;
309 switch (x265pic_out.sliceType) {
312 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
315 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
318 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
326 static const enum AVPixelFormat x265_csp_eight[] = {
333 static const enum AVPixelFormat x265_csp_twelve[] = {
337 AV_PIX_FMT_YUV420P10,
338 AV_PIX_FMT_YUV422P10,
339 AV_PIX_FMT_YUV444P10,
343 static av_cold void libx265_encode_init_csp(AVCodec *codec)
345 if (x265_api_get(10))
346 codec->pix_fmts = x265_csp_twelve;
347 else if (x265_api_get(8))
348 codec->pix_fmts = x265_csp_eight;
351 #define OFFSET(x) offsetof(libx265Context, x)
352 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
353 static const AVOption options[] = {
354 { "crf", "set the x265 crf", OFFSET(crf), AV_OPT_TYPE_FLOAT, { .dbl = -1 }, -1, FLT_MAX, VE },
355 { "preset", "set the x265 preset", OFFSET(preset), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
356 { "tune", "set the x265 tune parameter", OFFSET(tune), AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
357 { "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 },
361 static const AVClass class = {
362 .class_name = "libx265",
363 .item_name = av_default_item_name,
365 .version = LIBAVUTIL_VERSION_INT,
368 static const AVCodecDefault x265_defaults[] = {
373 AVCodec ff_libx265_encoder = {
375 .long_name = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
376 .type = AVMEDIA_TYPE_VIDEO,
377 .id = AV_CODEC_ID_HEVC,
378 .init = libx265_encode_init,
379 .init_static_data = libx265_encode_init_csp,
380 .encode2 = libx265_encode_frame,
381 .close = libx265_encode_close,
382 .priv_data_size = sizeof(libx265Context),
383 .priv_class = &class,
384 .defaults = x265_defaults,
385 .capabilities = CODEC_CAP_DELAY | CODEC_CAP_AUTO_THREADS,