libx265: Only set the SAR if it is valid
[ffmpeg.git] / libavcodec / libx265.c
1 /*
2  * libx265 encoder
3  *
4  * Copyright (c) 2013-2014 Derek Buitenhuis
5  *
6  * This file is part of Libav.
7  *
8  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #include <x265.h>
24
25 #include "libavutil/internal.h"
26 #include "libavutil/common.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/pixdesc.h"
29 #include "avcodec.h"
30 #include "internal.h"
31
32 #if defined(_MSC_VER)
33 #define X265_API_IMPORTS 1
34 #endif
35
36 typedef struct libx265Context {
37     const AVClass *class;
38
39     x265_encoder *encoder;
40     x265_param   *params;
41
42     char *preset;
43     char *tune;
44     char *x265_opts;
45 } libx265Context;
46
47 static int is_keyframe(NalUnitType naltype)
48 {
49     switch (naltype) {
50     case NAL_UNIT_CODED_SLICE_BLA_W_LP:
51     case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
52     case NAL_UNIT_CODED_SLICE_BLA_N_LP:
53     case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
54     case NAL_UNIT_CODED_SLICE_IDR_N_LP:
55     case NAL_UNIT_CODED_SLICE_CRA:
56         return 1;
57     default:
58         return 0;
59     }
60 }
61
62 static av_cold int libx265_encode_close(AVCodecContext *avctx)
63 {
64     libx265Context *ctx = avctx->priv_data;
65
66     av_frame_free(&avctx->coded_frame);
67
68     x265_param_free(ctx->params);
69
70     if (ctx->encoder)
71         x265_encoder_close(ctx->encoder);
72
73     return 0;
74 }
75
76 static av_cold int libx265_encode_init(AVCodecContext *avctx)
77 {
78     libx265Context *ctx = avctx->priv_data;
79     x265_nal *nal;
80     char sar[12];
81     int sar_num, sar_den;
82     int nnal;
83
84     if (avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL &&
85         !av_pix_fmt_desc_get(avctx->pix_fmt)->log2_chroma_w &&
86         !av_pix_fmt_desc_get(avctx->pix_fmt)->log2_chroma_h) {
87         av_log(avctx, AV_LOG_ERROR,
88                "4:4:4 support is not fully defined for HEVC yet. "
89                "Set -strict experimental to encode anyway.\n");
90         return AVERROR(ENOSYS);
91     }
92
93     avctx->coded_frame = av_frame_alloc();
94     if (!avctx->coded_frame) {
95         av_log(avctx, AV_LOG_ERROR, "Could not allocate frame.\n");
96         return AVERROR(ENOMEM);
97     }
98
99     ctx->params = x265_param_alloc();
100     if (!ctx->params) {
101         av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
102         return AVERROR(ENOMEM);
103     }
104
105     if (x265_param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
106         av_log(avctx, AV_LOG_ERROR, "Invalid preset or tune.\n");
107         return AVERROR(EINVAL);
108     }
109
110     ctx->params->frameNumThreads = avctx->thread_count;
111     ctx->params->fpsNum          = avctx->time_base.den;
112     ctx->params->fpsDenom        = avctx->time_base.num * avctx->ticks_per_frame;
113     ctx->params->sourceWidth     = avctx->width;
114     ctx->params->sourceHeight    = avctx->height;
115
116     if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0) {
117         av_reduce(&sar_num, &sar_den,
118                   avctx->sample_aspect_ratio.num,
119                   avctx->sample_aspect_ratio.den, 65535);
120         snprintf(sar, sizeof(sar), "%d:%d", sar_num, sar_den);
121         if (x265_param_parse(ctx->params, "sar", sar) == X265_PARAM_BAD_VALUE) {
122             av_log(avctx, AV_LOG_ERROR, "Invalid SAR: %d:%d.\n", sar_num, sar_den);
123             return AVERROR_INVALIDDATA;
124         }
125     }
126
127     if (x265_max_bit_depth == 8)
128         ctx->params->internalBitDepth = 8;
129     else if (x265_max_bit_depth == 12)
130         ctx->params->internalBitDepth = 10;
131
132     switch (avctx->pix_fmt) {
133     case AV_PIX_FMT_YUV420P:
134     case AV_PIX_FMT_YUV420P10:
135         ctx->params->internalCsp = X265_CSP_I420;
136         break;
137     case AV_PIX_FMT_YUV444P:
138     case AV_PIX_FMT_YUV444P10:
139         ctx->params->internalCsp = X265_CSP_I444;
140         break;
141     }
142
143     if (avctx->bit_rate > 0) {
144         ctx->params->rc.bitrate         = avctx->bit_rate / 1000;
145         ctx->params->rc.rateControlMode = X265_RC_ABR;
146     }
147
148     if (!(avctx->flags & CODEC_FLAG_GLOBAL_HEADER))
149         ctx->params->bRepeatHeaders = 1;
150
151     if (ctx->x265_opts) {
152         AVDictionary *dict    = NULL;
153         AVDictionaryEntry *en = NULL;
154
155         if (!av_dict_parse_string(&dict, ctx->x265_opts, "=", ":", 0)) {
156             while ((en = av_dict_get(dict, "", en, AV_DICT_IGNORE_SUFFIX))) {
157                 int parse_ret = x265_param_parse(ctx->params, en->key, en->value);
158
159                 switch (parse_ret) {
160                 case X265_PARAM_BAD_NAME:
161                     av_log(avctx, AV_LOG_WARNING,
162                           "Unknown option: %s.\n", en->key);
163                     break;
164                 case X265_PARAM_BAD_VALUE:
165                     av_log(avctx, AV_LOG_WARNING,
166                           "Invalid value for %s: %s.\n", en->key, en->value);
167                     break;
168                 default:
169                     break;
170                 }
171             }
172             av_dict_free(&dict);
173         }
174     }
175
176     ctx->encoder = x265_encoder_open(ctx->params);
177     if (!ctx->encoder) {
178         av_log(avctx, AV_LOG_ERROR, "Cannot open libx265 encoder.\n");
179         libx265_encode_close(avctx);
180         return AVERROR_INVALIDDATA;
181     }
182
183     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
184         avctx->extradata_size = x265_encoder_headers(ctx->encoder, &nal, &nnal);
185         if (avctx->extradata_size <= 0) {
186             av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
187             libx265_encode_close(avctx);
188             return AVERROR_INVALIDDATA;
189         }
190
191         avctx->extradata = av_malloc(avctx->extradata_size + FF_INPUT_BUFFER_PADDING_SIZE);
192         if (!avctx->extradata) {
193             av_log(avctx, AV_LOG_ERROR,
194                    "Cannot allocate HEVC header of size %d.\n", avctx->extradata_size);
195             libx265_encode_close(avctx);
196             return AVERROR(ENOMEM);
197         }
198
199         memcpy(avctx->extradata, nal[0].payload, avctx->extradata_size);
200     }
201
202     return 0;
203 }
204
205 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
206                                 const AVFrame *pic, int *got_packet)
207 {
208     libx265Context *ctx = avctx->priv_data;
209     x265_picture x265pic;
210     x265_picture x265pic_out = { { 0 } };
211     x265_nal *nal;
212     uint8_t *dst;
213     int payload = 0;
214     int nnal;
215     int ret;
216     int i;
217
218     x265_picture_init(ctx->params, &x265pic);
219
220     if (pic) {
221         for (i = 0; i < 3; i++) {
222            x265pic.planes[i] = pic->data[i];
223            x265pic.stride[i] = pic->linesize[i];
224         }
225
226         x265pic.pts      = pic->pts;
227         x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth_minus1 + 1;
228     }
229
230     ret = x265_encoder_encode(ctx->encoder, &nal, &nnal,
231                               pic ? &x265pic : NULL, &x265pic_out);
232     if (ret < 0)
233         return AVERROR_UNKNOWN;
234
235     if (!nnal)
236         return 0;
237
238     for (i = 0; i < nnal; i++)
239         payload += nal[i].sizeBytes;
240
241     ret = ff_alloc_packet(pkt, payload);
242     if (ret < 0) {
243         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
244         return ret;
245     }
246     dst = pkt->data;
247
248     for (i = 0; i < nnal; i++) {
249         memcpy(dst, nal[i].payload, nal[i].sizeBytes);
250         dst += nal[i].sizeBytes;
251
252         if (is_keyframe(nal[i].type))
253             pkt->flags |= AV_PKT_FLAG_KEY;
254     }
255
256     pkt->pts = x265pic_out.pts;
257     pkt->dts = x265pic_out.dts;
258
259     *got_packet = 1;
260     return 0;
261 }
262
263 static const enum AVPixelFormat x265_csp_eight[] = {
264     AV_PIX_FMT_YUV420P,
265     AV_PIX_FMT_YUV444P,
266     AV_PIX_FMT_NONE
267 };
268
269 static const enum AVPixelFormat x265_csp_twelve[] = {
270     AV_PIX_FMT_YUV420P,
271     AV_PIX_FMT_YUV444P,
272     AV_PIX_FMT_YUV420P10,
273     AV_PIX_FMT_YUV444P10,
274     AV_PIX_FMT_NONE
275 };
276
277 static av_cold void libx265_encode_init_csp(AVCodec *codec)
278 {
279     if (x265_max_bit_depth == 8)
280         codec->pix_fmts = x265_csp_eight;
281     else if (x265_max_bit_depth == 12)
282         codec->pix_fmts = x265_csp_twelve;
283 }
284
285 #define OFFSET(x) offsetof(libx265Context, x)
286 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
287 static const AVOption options[] = {
288     { "preset",      "set the x265 preset",                                                         OFFSET(preset),    AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
289     { "tune",        "set the x265 tune parameter",                                                 OFFSET(tune),      AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
290     { "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 },
291     { NULL }
292 };
293
294 static const AVClass class = {
295     .class_name = "libx265",
296     .item_name  = av_default_item_name,
297     .option     = options,
298     .version    = LIBAVUTIL_VERSION_INT,
299 };
300
301 AVCodec ff_libx265_encoder = {
302     .name             = "libx265",
303     .long_name        = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
304     .type             = AVMEDIA_TYPE_VIDEO,
305     .id               = AV_CODEC_ID_HEVC,
306     .init             = libx265_encode_init,
307     .init_static_data = libx265_encode_init_csp,
308     .encode2          = libx265_encode_frame,
309     .close            = libx265_encode_close,
310     .priv_data_size   = sizeof(libx265Context),
311     .priv_class       = &class,
312     .capabilities     = CODEC_CAP_DELAY | CODEC_CAP_AUTO_THREADS,
313 };