build: Group general components separate from de/encoders in arch Makefiles
[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     uint8_t      *header;
42     int           header_size;
43
44     char *preset;
45     char *tune;
46     char *x265_opts;
47 } libx265Context;
48
49 static int is_keyframe(NalUnitType naltype)
50 {
51     switch (naltype) {
52     case NAL_UNIT_CODED_SLICE_BLA_W_LP:
53     case NAL_UNIT_CODED_SLICE_BLA_W_RADL:
54     case NAL_UNIT_CODED_SLICE_BLA_N_LP:
55     case NAL_UNIT_CODED_SLICE_IDR_W_RADL:
56     case NAL_UNIT_CODED_SLICE_IDR_N_LP:
57     case NAL_UNIT_CODED_SLICE_CRA:
58         return 1;
59     default:
60         return 0;
61     }
62 }
63
64 static av_cold int libx265_encode_close(AVCodecContext *avctx)
65 {
66     libx265Context *ctx = avctx->priv_data;
67
68     av_frame_free(&avctx->coded_frame);
69     av_freep(&ctx->header);
70
71     x265_param_free(ctx->params);
72
73     if (ctx->encoder)
74         x265_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     x265_nal *nal;
83     uint8_t *buf;
84     int sar_num, sar_den;
85     int nnal;
86     int ret;
87     int i;
88
89     if (avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL &&
90         !av_pix_fmt_desc_get(avctx->pix_fmt)->log2_chroma_w &&
91         !av_pix_fmt_desc_get(avctx->pix_fmt)->log2_chroma_h) {
92         av_log(avctx, AV_LOG_ERROR,
93                "4:4:4 support is not fully defined for HEVC yet. "
94                "Set -strict experimental to encode anyway.\n");
95         return AVERROR(ENOSYS);
96     }
97
98     avctx->coded_frame = av_frame_alloc();
99     if (!avctx->coded_frame) {
100         av_log(avctx, AV_LOG_ERROR, "Could not allocate frame.\n");
101         return AVERROR(ENOMEM);
102     }
103
104     ctx->params = x265_param_alloc();
105     if (!ctx->params) {
106         av_log(avctx, AV_LOG_ERROR, "Could not allocate x265 param structure.\n");
107         return AVERROR(ENOMEM);
108     }
109
110     if (x265_param_default_preset(ctx->params, ctx->preset, ctx->tune) < 0) {
111         av_log(avctx, AV_LOG_ERROR, "Invalid preset or tune.\n");
112         return AVERROR(EINVAL);
113     }
114
115     ctx->params->frameNumThreads = avctx->thread_count;
116     ctx->params->fpsNum          = avctx->time_base.den;
117     ctx->params->fpsDenom        = avctx->time_base.num * avctx->ticks_per_frame;
118     ctx->params->sourceWidth     = avctx->width;
119     ctx->params->sourceHeight    = avctx->height;
120
121     av_reduce(&sar_num, &sar_den,
122               avctx->sample_aspect_ratio.num,
123               avctx->sample_aspect_ratio.den, 4096);
124     ctx->params->vui.bEnableVuiParametersPresentFlag = 1;
125     ctx->params->vui.bEnableAspectRatioIdc           = 1;
126     ctx->params->vui.aspectRatioIdc                  = 255;
127     ctx->params->vui.sarWidth                        = sar_num;
128     ctx->params->vui.sarHeight                       = sar_den;
129
130     if (x265_max_bit_depth == 8)
131         ctx->params->internalBitDepth = 8;
132     else if (x265_max_bit_depth == 12)
133         ctx->params->internalBitDepth = 10;
134
135     switch (avctx->pix_fmt) {
136     case AV_PIX_FMT_YUV420P:
137     case AV_PIX_FMT_YUV420P10:
138         ctx->params->internalCsp = X265_CSP_I420;
139         break;
140     case AV_PIX_FMT_YUV444P:
141     case AV_PIX_FMT_YUV444P10:
142         ctx->params->internalCsp = X265_CSP_I444;
143         break;
144     }
145
146     if (avctx->bit_rate > 0) {
147         ctx->params->rc.bitrate         = avctx->bit_rate / 1000;
148         ctx->params->rc.rateControlMode = X265_RC_ABR;
149     }
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     ret = x265_encoder_headers(ctx->encoder, &nal, &nnal);
184     if (ret < 0) {
185         av_log(avctx, AV_LOG_ERROR, "Cannot encode headers.\n");
186         libx265_encode_close(avctx);
187         return AVERROR_INVALIDDATA;
188     }
189
190     for (i = 0; i < nnal; i++)
191         ctx->header_size += nal[i].sizeBytes;
192
193     ctx->header = av_malloc(ctx->header_size);
194     if (!ctx->header) {
195         av_log(avctx, AV_LOG_ERROR,
196                "Cannot allocate HEVC header of size %d.\n", ctx->header_size);
197         libx265_encode_close(avctx);
198         return AVERROR(ENOMEM);
199     }
200
201     buf = ctx->header;
202     for (i = 0; i < nnal; i++) {
203         memcpy(buf, nal[i].payload, nal[i].sizeBytes);
204         buf += nal[i].sizeBytes;
205     }
206
207     return 0;
208 }
209
210 static int libx265_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
211                                 const AVFrame *pic, int *got_packet)
212 {
213     libx265Context *ctx = avctx->priv_data;
214     x265_picture x265pic;
215     x265_picture x265pic_out = { { 0 } };
216     x265_nal *nal;
217     uint8_t *dst;
218     int payload = 0;
219     int nnal;
220     int ret;
221     int i;
222
223     x265_picture_init(ctx->params, &x265pic);
224
225     if (pic) {
226         for (i = 0; i < 3; i++) {
227            x265pic.planes[i] = pic->data[i];
228            x265pic.stride[i] = pic->linesize[i];
229         }
230
231         x265pic.pts      = pic->pts;
232         x265pic.bitDepth = av_pix_fmt_desc_get(avctx->pix_fmt)->comp[0].depth_minus1 + 1;
233     }
234
235     ret = x265_encoder_encode(ctx->encoder, &nal, &nnal,
236                               pic ? &x265pic : NULL, &x265pic_out);
237     if (ret < 0)
238         return AVERROR_UNKNOWN;
239
240     if (!nnal)
241         return 0;
242
243     for (i = 0; i < nnal; i++)
244         payload += nal[i].sizeBytes;
245
246     payload += ctx->header_size;
247
248     ret = ff_alloc_packet(pkt, payload);
249     if (ret < 0) {
250         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
251         return ret;
252     }
253     dst = pkt->data;
254
255     if (ctx->header) {
256         memcpy(dst, ctx->header, ctx->header_size);
257         dst += ctx->header_size;
258
259         av_freep(&ctx->header);
260         ctx->header_size = 0;
261     }
262
263     for (i = 0; i < nnal; i++) {
264         memcpy(dst, nal[i].payload, nal[i].sizeBytes);
265         dst += nal[i].sizeBytes;
266
267         if (is_keyframe(nal[i].type))
268             pkt->flags |= AV_PKT_FLAG_KEY;
269     }
270
271     pkt->pts = x265pic_out.pts;
272     pkt->dts = x265pic_out.dts;
273
274     *got_packet = 1;
275     return 0;
276 }
277
278 static const enum AVPixelFormat x265_csp_eight[] = {
279     AV_PIX_FMT_YUV420P,
280     AV_PIX_FMT_YUV444P,
281     AV_PIX_FMT_NONE
282 };
283
284 static const enum AVPixelFormat x265_csp_twelve[] = {
285     AV_PIX_FMT_YUV420P,
286     AV_PIX_FMT_YUV444P,
287     AV_PIX_FMT_YUV420P10,
288     AV_PIX_FMT_YUV444P10,
289     AV_PIX_FMT_NONE
290 };
291
292 static av_cold void libx265_encode_init_csp(AVCodec *codec)
293 {
294     if (x265_max_bit_depth == 8)
295         codec->pix_fmts = x265_csp_eight;
296     else if (x265_max_bit_depth == 12)
297         codec->pix_fmts = x265_csp_twelve;
298 }
299
300 #define OFFSET(x) offsetof(libx265Context, x)
301 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
302 static const AVOption options[] = {
303     { "preset",      "set the x265 preset",                                                         OFFSET(preset),    AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
304     { "tune",        "set the x265 tune parameter",                                                 OFFSET(tune),      AV_OPT_TYPE_STRING, { 0 }, 0, 0, VE },
305     { "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 },
306     { NULL }
307 };
308
309 static const AVClass class = {
310     .class_name = "libx265",
311     .item_name  = av_default_item_name,
312     .option     = options,
313     .version    = LIBAVUTIL_VERSION_INT,
314 };
315
316 AVCodec ff_libx265_encoder = {
317     .name             = "libx265",
318     .long_name        = NULL_IF_CONFIG_SMALL("libx265 H.265 / HEVC"),
319     .type             = AVMEDIA_TYPE_VIDEO,
320     .id               = AV_CODEC_ID_HEVC,
321     .init             = libx265_encode_init,
322     .init_static_data = libx265_encode_init_csp,
323     .encode2          = libx265_encode_frame,
324     .close            = libx265_encode_close,
325     .priv_data_size   = sizeof(libx265Context),
326     .priv_class       = &class,
327     .capabilities     = CODEC_CAP_DELAY | CODEC_CAP_AUTO_THREADS,
328 };