avcodec/libx265 - Add named option to set profile
[ffmpeg.git] / libavcodec / libx265.c
1 /*
2  * libx265 encoder
3  *
4  * Copyright (c) 2013-2014 Derek Buitenhuis
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 #if defined(_MSC_VER)
24 #define X265_API_IMPORTS 1
25 #endif
26
27 #include <x265.h>
28 #include <float.h>
29
30 #include "libavutil/internal.h"
31 #include "libavutil/common.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixdesc.h"
34 #include "avcodec.h"
35 #include "internal.h"
36
37 typedef struct libx265Context {
38     const AVClass *class;
39
40     x265_encoder *encoder;
41     x265_param   *params;
42     const x265_api *api;
43
44     float crf;
45     int   forced_idr;
46     char *preset;
47     char *tune;
48     char *profile;
49     char *x265_opts;
50 } libx265Context;
51
52 static int is_keyframe(NalUnitType naltype)
53 {
54     switch (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:
61         return 1;
62     default:
63         return 0;
64     }
65 }
66
67 static av_cold int libx265_encode_close(AVCodecContext *avctx)
68 {
69     libx265Context *ctx = avctx->priv_data;
70
71     ctx->api->param_free(ctx->params);
72
73     if (ctx->encoder)
74         ctx->api->encoder_close(ctx->encoder);
75
76     return 0;
77 }
78
79 static av_cold int libx265_encode_init(AVCodecContext *avctx)
80 {
81     libx265Context *ctx = avctx->priv_data;
82
83     ctx->api = x265_api_get(av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth);
84     if (!ctx->api)
85         ctx->api = x265_api_get(0);
86
87     ctx->params = ctx->api->param_alloc();
88     if (!ctx->params) {
89         av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
90         return AVERROR(ENOMEM);
91     }
92
93     if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
94         int i;
95
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]);
100
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]);
105
106         av_log(avctx, AV_LOG_INFO, "\n");
107
108         return AVERROR(EINVAL);
109     }
110
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);
117
118     if ((avctx->color_primaries <= AVCOL_PRI_BT2020 &&
119          avctx->color_primaries != AVCOL_PRI_UNSPECIFIED) ||
120         (avctx->color_trc <= AVCOL_TRC_BT2020_12 &&
121          avctx->color_trc != AVCOL_TRC_UNSPECIFIED) ||
122         (avctx->colorspace <= AVCOL_SPC_BT2020_CL &&
123          avctx->colorspace != AVCOL_SPC_UNSPECIFIED)) {
124
125         ctx->params->vui.bEnableVideoSignalTypePresentFlag  = 1;
126         ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
127
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;
132     }
133
134     if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
135         char sar[12];
136         int sar_num, sar_den;
137
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;
145         }
146     }
147
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;
153         break;
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;
158         break;
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;
169         break;
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;
178         }
179         ctx->params->internalCsp = X265_CSP_I400;
180         break;
181     }
182
183     if (ctx->crf >= 0) {
184         char crf[6];
185
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);
190         }
191     } else if (avctx->bit_rate > 0) {
192         ctx->params->rc.bitrate         = avctx->bit_rate / 1000;
193         ctx->params->rc.rateControlMode = X265_RC_ABR;
194     }
195
196     if (!(avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER))
197         ctx->params->bRepeatHeaders = 1;
198
199     if (ctx->x265_opts) {
200         AVDictionary *dict    = NULL;
201         AVDictionaryEntry *en = NULL;
202
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);
206
207                 switch (parse_ret) {
208                 case X265_PARAM_BAD_NAME:
209                     av_log(avctx, AV_LOG_WARNING,
210                           "Unknown option: %s.\n", en->key);
211                     break;
212                 case X265_PARAM_BAD_VALUE:
213                     av_log(avctx, AV_LOG_WARNING,
214                           "Invalid value for %s: %s.\n", en->key, en->value);
215                     break;
216                 default:
217                     break;
218                 }
219             }
220             av_dict_free(&dict);
221         }
222     }
223
224     if (ctx->profile) {
225         if (ctx->api->param_apply_profile(ctx->params, ctx->profile) < 0) {
226             int i;
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);
233         }
234     }
235
236     ctx->encoder = ctx->api->encoder_open(ctx->params);
237     if (!ctx->encoder) {
238         av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
239         libx265_encode_close(avctx);
240         return AVERROR_INVALIDDATA;
241     }
242
243     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
244         x265_nal *nal;
245         int nnal;
246
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;
252         }
253
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);
260         }
261
262         memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
263     }
264
265     return 0;
266 }
267
268 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
269                                 const AVFrame *pic, int *got_packet)
270 {
271     libx265Context *ctx = avctx->priv_data;
272     x265_picture x265pic;
273     x265_picture x265pic_out = { 0 };
274     x265_nal *nal;
275     uint8_t *dst;
276     int payload = 0;
277     int nnal;
278     int ret;
279     int i;
280
281     ctx->api->picture_init(ctx->params, &x265pic);
282
283     if (pic) {
284         for (i = 0; i < 3; i++) {
285            x265pic.planes[i] = pic->data[i];
286            x265pic.stride[i] = pic->linesize[i];
287         }
288
289         x265pic.pts      = pic->pts;
290         x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth;
291
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 :
296                             X265_TYPE_AUTO;
297     }
298
299     ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
300                                    pic ? &x265pic : NULL, &x265pic_out);
301     if (ret < 0)
302         return AVERROR_EXTERNAL;
303
304     if (!nnal)
305         return 0;
306
307     for (i = 0; i < nnal; i++)
308         payload += nal[i].sizeBytes;
309
310     ret = ff_alloc_packet2(avctx, pkt, payload, payload);
311     if (ret < 0) {
312         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
313         return ret;
314     }
315     dst = pkt->data;
316
317     for (i = 0; i < nnal; i++) {
318         memcpy(dst, nal[i].payload, nal[i].sizeBytes);
319         dst += nal[i].sizeBytes;
320
321         if (is_keyframe(nal[i].type))
322             pkt->flags |= AV_PKT_FLAG_KEY;
323     }
324
325     pkt->pts = x265pic_out.pts;
326     pkt->dts = x265pic_out.dts;
327
328 #if FF_API_CODED_FRAME
329 FF_DISABLE_DEPRECATION_WARNINGS
330     switch (x265pic_out.sliceType) {
331     case X265_TYPE_IDR:
332     case X265_TYPE_I:
333         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
334         break;
335     case X265_TYPE_P:
336         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
337         break;
338     case X265_TYPE_B:
339         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
340         break;
341     }
342 FF_ENABLE_DEPRECATION_WARNINGS
343 #endif
344
345     *got_packet = 1;
346     return 0;
347 }
348
349 static const enum AVPixelFormat x265_csp_eight[] = {
350     AV_PIX_FMT_YUV420P,
351     AV_PIX_FMT_YUV422P,
352     AV_PIX_FMT_YUV444P,
353     AV_PIX_FMT_GBRP,
354     AV_PIX_FMT_GRAY8,
355     AV_PIX_FMT_NONE
356 };
357
358 static const enum AVPixelFormat x265_csp_ten[] = {
359     AV_PIX_FMT_YUV420P,
360     AV_PIX_FMT_YUV422P,
361     AV_PIX_FMT_YUV444P,
362     AV_PIX_FMT_GBRP,
363     AV_PIX_FMT_YUV420P10,
364     AV_PIX_FMT_YUV422P10,
365     AV_PIX_FMT_YUV444P10,
366     AV_PIX_FMT_GBRP10,
367     AV_PIX_FMT_GRAY8,
368     AV_PIX_FMT_GRAY10,
369     AV_PIX_FMT_NONE
370 };
371
372 static const enum AVPixelFormat x265_csp_twelve[] = {
373     AV_PIX_FMT_YUV420P,
374     AV_PIX_FMT_YUV422P,
375     AV_PIX_FMT_YUV444P,
376     AV_PIX_FMT_GBRP,
377     AV_PIX_FMT_YUV420P10,
378     AV_PIX_FMT_YUV422P10,
379     AV_PIX_FMT_YUV444P10,
380     AV_PIX_FMT_GBRP10,
381     AV_PIX_FMT_YUV420P12,
382     AV_PIX_FMT_YUV422P12,
383     AV_PIX_FMT_YUV444P12,
384     AV_PIX_FMT_GBRP12,
385     AV_PIX_FMT_GRAY8,
386     AV_PIX_FMT_GRAY10,
387     AV_PIX_FMT_GRAY12,
388     AV_PIX_FMT_NONE
389 };
390
391 static av_cold void libx265_encode_init_csp(AVCodec *codec)
392 {
393     if (x265_api_get(12))
394         codec->pix_fmts = x265_csp_twelve;
395     else if (x265_api_get(10))
396         codec->pix_fmts = x265_csp_ten;
397     else if (x265_api_get(8))
398         codec->pix_fmts = x265_csp_eight;
399 }
400
401 #define OFFSET(x) offsetof(libx265Context, x)
402 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
403 static const AVOption options[] = {
404     { "crf",         "set the x265 crf",                                                            OFFSET(crf),       AV_OPT_TYPE_FLOAT,  { .dbl = -1 }, -1, FLT_MAX, VE },
405     { "forced-idr",  "if forcing keyframes, force them as IDR frames",                              OFFSET(forced_idr),AV_OPT_TYPE_BOOL,   { .i64 =  0 },  0,       1, VE },
406     { "preset",      "set the x265 preset",                                                         OFFSET(preset),    AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
407     { "tune",        "set the x265 tune parameter",                                                 OFFSET(tune),      AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
408     { "profile",     "set the x265 profile",                                                        OFFSET(profile),   AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
409     { "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 },
410     { NULL }
411 };
412
413 static const AVClass class = {
414     .class_name = "libx265",
415     .item_name  = av_default_item_name,
416     .option     = options,
417     .version    = LIBAVUTIL_VERSION_INT,
418 };
419
420 static const AVCodecDefault x265_defaults[] = {
421     { "b", "0" },
422     { NULL },
423 };
424
425 AVCodec ff_libx265_encoder = {
426     .name             = "libx265",
427     .long_name        = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
428     .type             = AVMEDIA_TYPE_VIDEO,
429     .id               = AV_CODEC_ID_HEVC,
430     .init             = libx265_encode_init,
431     .init_static_data = libx265_encode_init_csp,
432     .encode2          = libx265_encode_frame,
433     .close            = libx265_encode_close,
434     .priv_data_size   = sizeof(libx265Context),
435     .priv_class       = &class,
436     .defaults         = x265_defaults,
437     .capabilities     = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
438 };