libx265: Enable 12-bit encoding
[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     char *preset;
46     char *tune;
47     char *x265_opts;
48 } libx265Context;
49
50 static int is_keyframe(NalUnitType naltype)
51 {
52     switch (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:
59         return 1;
60     default:
61         return 0;
62     }
63 }
64
65 static av_cold int libx265_encode_close(AVCodecContext *avctx)
66 {
67     libx265Context *ctx = avctx->priv_data;
68
69     ctx->api->param_free(ctx->params);
70
71     if (ctx->encoder)
72         ctx->api->encoder_close(ctx->encoder);
73
74     return 0;
75 }
76
77 static av_cold int libx265_encode_init(AVCodecContext *avctx)
78 {
79     libx265Context *ctx = avctx->priv_data;
80
81     ctx->api = x265_api_get(av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth);
82     if (!ctx->api)
83         ctx->api = x265_api_get(0);
84
85     ctx->params = ctx->api->param_alloc();
86     if (!ctx->params) {
87         av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
88         return AVERROR(ENOMEM);
89     }
90
91     if (ctx->api->param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
92         int i;
93
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]);
98
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]);
103
104         av_log(avctx, AV_LOG_INFO, "\n");
105
106         return AVERROR(EINVAL);
107     }
108
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);
115
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)) {
122
123         ctx->params->vui.bEnableVideoSignalTypePresentFlag  = 1;
124         ctx->params->vui.bEnableColorDescriptionPresentFlag = 1;
125
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;
130     }
131
132     if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
133         char sar[12];
134         int sar_num, sar_den;
135
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;
143         }
144     }
145
146     switch (avctx->pix_fmt) {
147     case AV_PIX_FMT_YUV420P:
148     case AV_PIX_FMT_YUV420P10:
149     case AV_PIX_FMT_YUV420P12:
150         ctx->params->internalCsp = X265_CSP_I420;
151         break;
152     case AV_PIX_FMT_YUV422P:
153     case AV_PIX_FMT_YUV422P10:
154     case AV_PIX_FMT_YUV422P12:
155         ctx->params->internalCsp = X265_CSP_I422;
156         break;
157     case AV_PIX_FMT_YUV444P:
158     case AV_PIX_FMT_YUV444P10:
159     case AV_PIX_FMT_YUV444P12:
160         ctx->params->internalCsp = X265_CSP_I444;
161         break;
162     }
163
164     if (ctx->crf >= 0) {
165         char crf[6];
166
167         snprintf(crf, sizeof(crf), "%2.2f", ctx->crf);
168         if (ctx->api->param_parse(ctx->params, "crf", crf) == X265_PARAM_BAD_VALUE) {
169             av_log(avctx, AV_LOG_ERROR, "Invalid crf: %2.2f.\n", ctx->crf);
170             return AVERROR(EINVAL);
171         }
172     } else if (avctx->bit_rate > 0) {
173         ctx->params->rc.bitrate         = avctx->bit_rate / 1000;
174         ctx->params->rc.rateControlMode = X265_RC_ABR;
175     }
176
177     if (!(avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER))
178         ctx->params->bRepeatHeaders = 1;
179
180     if (ctx->x265_opts) {
181         AVDictionary *dict    = NULL;
182         AVDictionaryEntry *en = NULL;
183
184         if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
185             while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
186                 int parse_ret = ctx->api->param_parse(ctx->params, en->key, en->value);
187
188                 switch (parse_ret) {
189                 case X265_PARAM_BAD_NAME:
190                     av_log(avctx, AV_LOG_WARNING,
191                           "Unknown option: %s.\n", en->key);
192                     break;
193                 case X265_PARAM_BAD_VALUE:
194                     av_log(avctx, AV_LOG_WARNING,
195                           "Invalid value for %s: %s.\n", en->key, en->value);
196                     break;
197                 default:
198                     break;
199                 }
200             }
201             av_dict_free(&dict);
202         }
203     }
204
205     ctx->encoder = ctx->api->encoder_open(ctx->params);
206     if (!ctx->encoder) {
207         av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
208         libx265_encode_close(avctx);
209         return AVERROR_INVALIDDATA;
210     }
211
212     if (avctx->flags & AV_CODEC_FLAG_GLOBAL_HEADER) {
213         x265_nal *nal;
214         int nnal;
215
216         avctx->extradata_size = ctx->api->encoder_headers(ctx->encoder, &nal, &nnal);
217         if (avctx->extradata_size <= 0) {
218             av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
219             libx265_encode_close(avctx);
220             return AVERROR_INVALIDDATA;
221         }
222
223         avctx->extradata = av_malloc(avctx->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
224         if (!avctx->extradata) {
225             av_log(avctx, AV_LOG_ERROR,
226                    "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
227             libx265_encode_close(avctx);
228             return AVERROR(ENOMEM);
229         }
230
231         memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
232     }
233
234     return 0;
235 }
236
237 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
238                                 const AVFrame *pic, int *got_packet)
239 {
240     libx265Context *ctx = avctx->priv_data;
241     x265_picture x265pic;
242     x265_picture x265pic_out = { 0 };
243     x265_nal *nal;
244     uint8_t *dst;
245     int payload = 0;
246     int nnal;
247     int ret;
248     int i;
249
250     ctx->api->picture_init(ctx->params, &x265pic);
251
252     if (pic) {
253         for (i = 0; i < 3; i++) {
254            x265pic.planes[i] = pic->data[i];
255            x265pic.stride[i] = pic->linesize[i];
256         }
257
258         x265pic.pts      = pic->pts;
259         x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth;
260
261         x265pic.sliceType = pic->pict_type == AV_PICTURE_TYPE_I ? X265_TYPE_I :
262                             pic->pict_type == AV_PICTURE_TYPE_P ? X265_TYPE_P :
263                             pic->pict_type == AV_PICTURE_TYPE_B ? X265_TYPE_B :
264                             X265_TYPE_AUTO;
265     }
266
267     ret = ctx->api->encoder_encode(ctx->encoder, &nal, &nnal,
268                                    pic ? &x265pic : NULL, &x265pic_out);
269     if (ret < 0)
270         return AVERROR_EXTERNAL;
271
272     if (!nnal)
273         return 0;
274
275     for (i = 0; i < nnal; i++)
276         payload += nal[i].sizeBytes;
277
278     ret = ff_alloc_packet(pkt, payload);
279     if (ret < 0) {
280         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
281         return ret;
282     }
283     dst = pkt->data;
284
285     for (i = 0; i < nnal; i++) {
286         memcpy(dst, nal[i].payload, nal[i].sizeBytes);
287         dst += nal[i].sizeBytes;
288
289         if (is_keyframe(nal[i].type))
290             pkt->flags |= AV_PKT_FLAG_KEY;
291     }
292
293     pkt->pts = x265pic_out.pts;
294     pkt->dts = x265pic_out.dts;
295
296 #if FF_API_CODED_FRAME
297 FF_DISABLE_DEPRECATION_WARNINGS
298     switch (x265pic_out.sliceType) {
299     case X265_TYPE_IDR:
300     case X265_TYPE_I:
301         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
302         break;
303     case X265_TYPE_P:
304         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
305         break;
306     case X265_TYPE_B:
307         avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
308         break;
309     }
310 FF_ENABLE_DEPRECATION_WARNINGS
311 #endif
312
313     *got_packet = 1;
314     return 0;
315 }
316
317 static const enum AVPixelFormat x265_csp_eight[] = {
318     AV_PIX_FMT_YUV420P,
319     AV_PIX_FMT_YUV422P,
320     AV_PIX_FMT_YUV444P,
321     AV_PIX_FMT_NONE
322 };
323
324 static const enum AVPixelFormat x265_csp_ten[] = {
325     AV_PIX_FMT_YUV420P,
326     AV_PIX_FMT_YUV422P,
327     AV_PIX_FMT_YUV444P,
328     AV_PIX_FMT_YUV420P10,
329     AV_PIX_FMT_YUV422P10,
330     AV_PIX_FMT_YUV444P10,
331     AV_PIX_FMT_NONE
332 };
333
334 static const enum AVPixelFormat x265_csp_twelve[] = {
335     AV_PIX_FMT_YUV420P,
336     AV_PIX_FMT_YUV422P,
337     AV_PIX_FMT_YUV444P,
338     AV_PIX_FMT_YUV420P10,
339     AV_PIX_FMT_YUV422P10,
340     AV_PIX_FMT_YUV444P10,
341     AV_PIX_FMT_YUV420P12,
342     AV_PIX_FMT_YUV422P12,
343     AV_PIX_FMT_YUV444P12,
344     AV_PIX_FMT_NONE
345 };
346
347 static av_cold void libx265_encode_init_csp(AVCodec *codec)
348 {
349     if (x265_api_get(12))
350         codec->pix_fmts = x265_csp_twelve;
351     else if (x265_api_get(10))
352         codec->pix_fmts = x265_csp_ten;
353     else if (x265_api_get(8))
354         codec->pix_fmts = x265_csp_eight;
355 }
356
357 #define OFFSET(x) offsetof(libx265Context, x)
358 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
359 static const AVOption options[] = {
360     { "crf",         "set the x265 crf",                                                            OFFSET(crf),       AV_OPT_TYPE_FLOAT,  { .dbl = -1 }, -1, FLT_MAX, VE },
361     { "preset",      "set the x265 preset",                                                         OFFSET(preset),    AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
362     { "tune",        "set the x265 tune parameter",                                                 OFFSET(tune),      AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
363     { "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 },
364     { NULL }
365 };
366
367 static const AVClass class = {
368     .class_name = "libx265",
369     .item_name  = av_default_item_name,
370     .option     = options,
371     .version    = LIBAVUTIL_VERSION_INT,
372 };
373
374 static const AVCodecDefault x265_defaults[] = {
375     { "b", "0" },
376     { NULL },
377 };
378
379 AVCodec ff_libx265_encoder = {
380     .name             = "libx265",
381     .long_name        = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
382     .type             = AVMEDIA_TYPE_VIDEO,
383     .id               = AV_CODEC_ID_HEVC,
384     .init             = libx265_encode_init,
385     .init_static_data = libx265_encode_init_csp,
386     .encode2          = libx265_encode_frame,
387     .close            = libx265_encode_close,
388     .priv_data_size   = sizeof(libx265Context),
389     .priv_class       = &class,
390     .defaults         = x265_defaults,
391     .capabilities     = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_AUTO_THREADS,
392 };