b46e10a73d1e17fe300e423336896e1c025ea0d4
[ffmpeg.git] / libavcodec / libx264.c
1 /*
2  * H.264 encoding using the x264 library
3  * Copyright (C) 2005  Mans Rullgard <mans@mansr.com>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "libavutil/opt.h"
23 #include "avcodec.h"
24 #include "internal.h"
25 #include <x264.h>
26 #include <float.h>
27 #include <math.h>
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31
32 typedef struct X264Context {
33     AVClass        *class;
34     x264_param_t    params;
35     x264_t         *enc;
36     x264_picture_t  pic;
37     uint8_t        *sei;
38     int             sei_size;
39     AVFrame         out_pic;
40     char *preset;
41     char *tune;
42     char *profile;
43     int fastfirstpass;
44     float crf;
45     int cqp;
46     int aq_mode;
47     float aq_strength;
48 } X264Context;
49
50 static void X264_log(void *p, int level, const char *fmt, va_list args)
51 {
52     static const int level_map[] = {
53         [X264_LOG_ERROR]   = AV_LOG_ERROR,
54         [X264_LOG_WARNING] = AV_LOG_WARNING,
55         [X264_LOG_INFO]    = AV_LOG_INFO,
56         [X264_LOG_DEBUG]   = AV_LOG_DEBUG
57     };
58
59     if (level < 0 || level > X264_LOG_DEBUG)
60         return;
61
62     av_vlog(p, level_map[level], fmt, args);
63 }
64
65
66 static int encode_nals(AVCodecContext *ctx, uint8_t *buf, int size,
67                        x264_nal_t *nals, int nnal, int skip_sei)
68 {
69     X264Context *x4 = ctx->priv_data;
70     uint8_t *p = buf;
71     int i;
72
73     /* Write the SEI as part of the first frame. */
74     if (x4->sei_size > 0 && nnal > 0) {
75         memcpy(p, x4->sei, x4->sei_size);
76         p += x4->sei_size;
77         x4->sei_size = 0;
78     }
79
80     for (i = 0; i < nnal; i++){
81         /* Don't put the SEI in extradata. */
82         if (skip_sei && nals[i].i_type == NAL_SEI) {
83             x4->sei_size = nals[i].i_payload;
84             x4->sei      = av_malloc(x4->sei_size);
85             memcpy(x4->sei, nals[i].p_payload, nals[i].i_payload);
86             continue;
87         }
88         memcpy(p, nals[i].p_payload, nals[i].i_payload);
89         p += nals[i].i_payload;
90     }
91
92     return p - buf;
93 }
94
95 static int X264_frame(AVCodecContext *ctx, uint8_t *buf,
96                       int bufsize, void *data)
97 {
98     X264Context *x4 = ctx->priv_data;
99     AVFrame *frame = data;
100     x264_nal_t *nal;
101     int nnal, i;
102     x264_picture_t pic_out;
103
104     x264_picture_init( &x4->pic );
105     x4->pic.img.i_csp   = X264_CSP_I420;
106     x4->pic.img.i_plane = 3;
107
108     if (frame) {
109         for (i = 0; i < 3; i++) {
110             x4->pic.img.plane[i]    = frame->data[i];
111             x4->pic.img.i_stride[i] = frame->linesize[i];
112         }
113
114         x4->pic.i_pts  = frame->pts;
115         x4->pic.i_type =
116             frame->pict_type == AV_PICTURE_TYPE_I ? X264_TYPE_KEYFRAME :
117             frame->pict_type == AV_PICTURE_TYPE_P ? X264_TYPE_P :
118             frame->pict_type == AV_PICTURE_TYPE_B ? X264_TYPE_B :
119                                             X264_TYPE_AUTO;
120         if (x4->params.b_tff != frame->top_field_first) {
121             x4->params.b_tff = frame->top_field_first;
122             x264_encoder_reconfig(x4->enc, &x4->params);
123         }
124     }
125
126     do {
127     if (x264_encoder_encode(x4->enc, &nal, &nnal, frame? &x4->pic: NULL, &pic_out) < 0)
128         return -1;
129
130     bufsize = encode_nals(ctx, buf, bufsize, nal, nnal, 0);
131     if (bufsize < 0)
132         return -1;
133     } while (!bufsize && !frame && x264_encoder_delayed_frames(x4->enc));
134
135     /* FIXME: libx264 now provides DTS, but AVFrame doesn't have a field for it. */
136     x4->out_pic.pts = pic_out.i_pts;
137
138     switch (pic_out.i_type) {
139     case X264_TYPE_IDR:
140     case X264_TYPE_I:
141         x4->out_pic.pict_type = AV_PICTURE_TYPE_I;
142         break;
143     case X264_TYPE_P:
144         x4->out_pic.pict_type = AV_PICTURE_TYPE_P;
145         break;
146     case X264_TYPE_B:
147     case X264_TYPE_BREF:
148         x4->out_pic.pict_type = AV_PICTURE_TYPE_B;
149         break;
150     }
151
152     x4->out_pic.key_frame = pic_out.b_keyframe;
153     if (bufsize)
154         x4->out_pic.quality = (pic_out.i_qpplus1 - 1) * FF_QP2LAMBDA;
155
156     return bufsize;
157 }
158
159 static av_cold int X264_close(AVCodecContext *avctx)
160 {
161     X264Context *x4 = avctx->priv_data;
162
163     av_freep(&avctx->extradata);
164     av_free(x4->sei);
165
166     if (x4->enc)
167         x264_encoder_close(x4->enc);
168
169     return 0;
170 }
171
172 static av_cold int X264_init(AVCodecContext *avctx)
173 {
174     X264Context *x4 = avctx->priv_data;
175
176     x4->sei_size = 0;
177     x264_param_default(&x4->params);
178
179     x4->params.i_keyint_max         = avctx->gop_size;
180
181     x4->params.i_bframe          = avctx->max_b_frames;
182     x4->params.b_cabac           = avctx->coder_type == FF_CODER_TYPE_AC;
183     x4->params.i_bframe_adaptive = avctx->b_frame_strategy;
184     x4->params.i_bframe_bias     = avctx->bframebias;
185     x4->params.i_bframe_pyramid  = avctx->flags2 & CODEC_FLAG2_BPYRAMID ? X264_B_PYRAMID_NORMAL : X264_B_PYRAMID_NONE;
186     avctx->has_b_frames          = avctx->flags2 & CODEC_FLAG2_BPYRAMID ? 2 : !!avctx->max_b_frames;
187
188     x4->params.i_keyint_min = avctx->keyint_min;
189     if (x4->params.i_keyint_min > x4->params.i_keyint_max)
190         x4->params.i_keyint_min = x4->params.i_keyint_max;
191
192     x4->params.i_scenecut_threshold        = avctx->scenechange_threshold;
193
194     x4->params.b_deblocking_filter         = avctx->flags & CODEC_FLAG_LOOP_FILTER;
195     x4->params.i_deblocking_filter_alphac0 = avctx->deblockalpha;
196     x4->params.i_deblocking_filter_beta    = avctx->deblockbeta;
197
198     x4->params.rc.i_qp_min                 = avctx->qmin;
199     x4->params.rc.i_qp_max                 = avctx->qmax;
200     x4->params.rc.i_qp_step                = avctx->max_qdiff;
201
202     x4->params.rc.f_qcompress       = avctx->qcompress; /* 0.0 => cbr, 1.0 => constant qp */
203     x4->params.rc.f_qblur           = avctx->qblur;     /* temporally blur quants */
204     x4->params.rc.f_complexity_blur = avctx->complexityblur;
205
206     x4->params.i_frame_reference    = avctx->refs;
207
208     x4->params.analyse.inter    = 0;
209     if (avctx->partitions) {
210         if (avctx->partitions & X264_PART_I4X4)
211             x4->params.analyse.inter |= X264_ANALYSE_I4x4;
212         if (avctx->partitions & X264_PART_I8X8)
213             x4->params.analyse.inter |= X264_ANALYSE_I8x8;
214         if (avctx->partitions & X264_PART_P8X8)
215             x4->params.analyse.inter |= X264_ANALYSE_PSUB16x16;
216         if (avctx->partitions & X264_PART_P4X4)
217             x4->params.analyse.inter |= X264_ANALYSE_PSUB8x8;
218         if (avctx->partitions & X264_PART_B8X8)
219             x4->params.analyse.inter |= X264_ANALYSE_BSUB16x16;
220     }
221
222     x4->params.analyse.i_direct_mv_pred  = avctx->directpred;
223
224     x4->params.analyse.b_weighted_bipred = avctx->flags2 & CODEC_FLAG2_WPRED;
225     x4->params.analyse.i_weighted_pred = avctx->weighted_p_pred;
226
227     if (avctx->me_method == ME_EPZS)
228         x4->params.analyse.i_me_method = X264_ME_DIA;
229     else if (avctx->me_method == ME_HEX)
230         x4->params.analyse.i_me_method = X264_ME_HEX;
231     else if (avctx->me_method == ME_UMH)
232         x4->params.analyse.i_me_method = X264_ME_UMH;
233     else if (avctx->me_method == ME_FULL)
234         x4->params.analyse.i_me_method = X264_ME_ESA;
235     else if (avctx->me_method == ME_TESA)
236         x4->params.analyse.i_me_method = X264_ME_TESA;
237     else x4->params.analyse.i_me_method = X264_ME_HEX;
238
239     x4->params.rc.i_lookahead             = avctx->rc_lookahead;
240
241     x4->params.analyse.b_psy              = avctx->flags2 & CODEC_FLAG2_PSY;
242     x4->params.analyse.f_psy_rd           = avctx->psy_rd;
243     x4->params.analyse.f_psy_trellis      = avctx->psy_trellis;
244
245     x4->params.analyse.i_me_range         = avctx->me_range;
246     x4->params.analyse.i_subpel_refine    = avctx->me_subpel_quality;
247
248     x4->params.analyse.b_mixed_references = avctx->flags2 & CODEC_FLAG2_MIXED_REFS;
249     x4->params.analyse.b_chroma_me        = avctx->me_cmp & FF_CMP_CHROMA;
250     x4->params.analyse.b_transform_8x8    = avctx->flags2 & CODEC_FLAG2_8X8DCT;
251     x4->params.analyse.b_fast_pskip       = avctx->flags2 & CODEC_FLAG2_FASTPSKIP;
252
253     x4->params.analyse.i_trellis          = avctx->trellis;
254     x4->params.analyse.i_noise_reduction  = avctx->noise_reduction;
255
256     if (avctx->level > 0)
257         x4->params.i_level_idc = avctx->level;
258
259     if (x4->preset || x4->tune)
260         if (x264_param_default_preset(&x4->params, x4->preset, x4->tune) < 0) {
261             av_log(avctx, AV_LOG_ERROR, "Error setting preset/tune %s/%s.\n", x4->preset, x4->tune);
262             return AVERROR(EINVAL);
263         }
264
265     x4->params.pf_log               = X264_log;
266     x4->params.p_log_private        = avctx;
267     x4->params.i_log_level          = X264_LOG_DEBUG;
268
269     x4->params.b_intra_refresh      = avctx->flags2 & CODEC_FLAG2_INTRA_REFRESH;
270     if (avctx->bit_rate) {
271         x4->params.rc.i_bitrate   = avctx->bit_rate / 1000;
272         x4->params.rc.i_rc_method = X264_RC_ABR;
273     }
274     x4->params.rc.i_vbv_buffer_size = avctx->rc_buffer_size / 1000;
275     x4->params.rc.i_vbv_max_bitrate = avctx->rc_max_rate    / 1000;
276     x4->params.rc.b_stat_write      = avctx->flags & CODEC_FLAG_PASS1;
277     if (avctx->flags & CODEC_FLAG_PASS2) {
278         x4->params.rc.b_stat_read = 1;
279     } else {
280 #if FF_API_X264_GLOBAL_OPTS
281         if (avctx->crf) {
282             x4->params.rc.i_rc_method   = X264_RC_CRF;
283             x4->params.rc.f_rf_constant = avctx->crf;
284             x4->params.rc.f_rf_constant_max = avctx->crf_max;
285         } else if (avctx->cqp > -1) {
286             x4->params.rc.i_rc_method   = X264_RC_CQP;
287             x4->params.rc.i_qp_constant = avctx->cqp;
288         }
289 #endif
290
291         if (x4->crf >= 0) {
292             x4->params.rc.i_rc_method   = X264_RC_CRF;
293             x4->params.rc.f_rf_constant = x4->crf;
294         } else if (x4->cqp >= 0) {
295             x4->params.rc.i_rc_method   = X264_RC_CQP;
296             x4->params.rc.i_qp_constant = x4->cqp;
297         }
298     }
299
300     if (avctx->rc_buffer_size && avctx->rc_initial_buffer_occupancy &&
301         (avctx->rc_initial_buffer_occupancy <= avctx->rc_buffer_size)) {
302         x4->params.rc.f_vbv_buffer_init =
303             (float)avctx->rc_initial_buffer_occupancy / avctx->rc_buffer_size;
304     }
305
306     x4->params.rc.b_mb_tree               = !!(avctx->flags2 & CODEC_FLAG2_MBTREE);
307     x4->params.rc.f_ip_factor             = 1 / fabs(avctx->i_quant_factor);
308     x4->params.rc.f_pb_factor             = avctx->b_quant_factor;
309     x4->params.analyse.i_chroma_qp_offset = avctx->chromaoffset;
310
311 #if FF_API_X264_GLOBAL_OPTS
312     if (avctx->aq_mode >= 0)
313         x4->params.rc.i_aq_mode = avctx->aq_mode;
314     if (avctx->aq_strength >= 0)
315         x4->params.rc.f_aq_strength = avctx->aq_strength;
316 #endif
317
318     if (x4->aq_mode >= 0)
319         x4->params.rc.i_aq_mode = x4->aq_mode;
320     if (x4->aq_strength >= 0)
321         x4->params.rc.f_aq_strength = x4->aq_strength;
322
323     if (x4->fastfirstpass)
324         x264_param_apply_fastfirstpass(&x4->params);
325
326     if (x4->profile)
327         if (x264_param_apply_profile(&x4->params, x4->profile) < 0) {
328             av_log(avctx, AV_LOG_ERROR, "Error setting profile %s.\n", x4->profile);
329             return AVERROR(EINVAL);
330         }
331
332     x4->params.i_width          = avctx->width;
333     x4->params.i_height         = avctx->height;
334     x4->params.vui.i_sar_width  = avctx->sample_aspect_ratio.num;
335     x4->params.vui.i_sar_height = avctx->sample_aspect_ratio.den;
336     x4->params.i_fps_num = x4->params.i_timebase_den = avctx->time_base.den;
337     x4->params.i_fps_den = x4->params.i_timebase_num = avctx->time_base.num;
338
339     x4->params.analyse.b_psnr = avctx->flags & CODEC_FLAG_PSNR;
340     x4->params.analyse.b_ssim = avctx->flags2 & CODEC_FLAG2_SSIM;
341
342     x4->params.b_aud          = avctx->flags2 & CODEC_FLAG2_AUD;
343
344     x4->params.i_threads      = avctx->thread_count;
345
346     x4->params.b_interlaced   = avctx->flags & CODEC_FLAG_INTERLACED_DCT;
347
348     x4->params.b_open_gop     = !(avctx->flags & CODEC_FLAG_CLOSED_GOP);
349
350     x4->params.i_slice_count  = avctx->slices;
351
352     x4->params.vui.b_fullrange = avctx->pix_fmt == PIX_FMT_YUVJ420P;
353
354     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER)
355         x4->params.b_repeat_headers = 0;
356
357     // update AVCodecContext with x264 parameters
358     avctx->has_b_frames = x4->params.i_bframe ?
359         x4->params.i_bframe_pyramid ? 2 : 1 : 0;
360     avctx->bit_rate = x4->params.rc.i_bitrate*1000;
361 #if FF_API_X264_GLOBAL_OPTS
362     avctx->crf = x4->params.rc.f_rf_constant;
363 #endif
364
365     x4->enc = x264_encoder_open(&x4->params);
366     if (!x4->enc)
367         return -1;
368
369     avctx->coded_frame = &x4->out_pic;
370
371     if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
372         x264_nal_t *nal;
373         int nnal, s, i;
374
375         s = x264_encoder_headers(x4->enc, &nal, &nnal);
376
377         for (i = 0; i < nnal; i++)
378             if (nal[i].i_type == NAL_SEI)
379                 av_log(avctx, AV_LOG_INFO, "%s\n", nal[i].p_payload+25);
380
381         avctx->extradata      = av_malloc(s);
382         avctx->extradata_size = encode_nals(avctx, avctx->extradata, s, nal, nnal, 1);
383     }
384
385     return 0;
386 }
387
388 #define OFFSET(x) offsetof(X264Context, x)
389 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
390 static const AVOption options[] = {
391     { "preset",        "Set the encoding preset (cf. x264 --fullhelp)",   OFFSET(preset),        FF_OPT_TYPE_STRING, { .str = "medium" }, 0, 0, VE},
392     { "tune",          "Tune the encoding params (cf. x264 --fullhelp)",  OFFSET(tune),          FF_OPT_TYPE_STRING, { 0 }, 0, 0, VE},
393     { "profile",       "Set profile restrictions (cf. x264 --fullhelp) ", OFFSET(profile),       FF_OPT_TYPE_STRING, { 0 }, 0, 0, VE},
394     { "fastfirstpass", "Use fast settings when encoding first pass",      OFFSET(fastfirstpass), FF_OPT_TYPE_INT,    { 1 }, 0, 1, VE},
395     { "crf",           "Select the quality for constant quality mode",    OFFSET(crf),           FF_OPT_TYPE_FLOAT,  {-1 }, -1, FLT_MAX, VE },
396     { "cqp",           "Constant quantization parameter rate control method",OFFSET(cqp),        FF_OPT_TYPE_INT,    {-1 }, -1, INT_MAX, VE },
397     { "aq_mode",       "AQ method",                                       OFFSET(aq_mode),       FF_OPT_TYPE_INT,    {-1 }, -1, INT_MAX, VE, "aq_mode"},
398     { "none",          NULL,                              0, FF_OPT_TYPE_CONST, {X264_AQ_NONE},         INT_MIN, INT_MAX, VE, "aq_mode" },
399     { "variance",      "Variance AQ (complexity mask)",   0, FF_OPT_TYPE_CONST, {X264_AQ_VARIANCE},     INT_MIN, INT_MAX, VE, "aq_mode" },
400     { "autovariance",  "Auto-variance AQ (experimental)", 0, FF_OPT_TYPE_CONST, {X264_AQ_AUTOVARIANCE}, INT_MIN, INT_MAX, VE, "aq_mode" },
401     { "aq_strength",   "AQ strength. Reduces blocking and blurring in flat and textured areas.", OFFSET(aq_strength), FF_OPT_TYPE_FLOAT, {-1}, -1, FLT_MAX, VE},
402     { NULL },
403 };
404
405 static const AVClass class = {
406     .class_name = "libx264",
407     .item_name  = av_default_item_name,
408     .option     = options,
409     .version    = LIBAVUTIL_VERSION_INT,
410 };
411
412 static const AVCodecDefault x264_defaults[] = {
413     { "b",                "0" },
414     { NULL },
415 };
416
417 AVCodec ff_libx264_encoder = {
418     .name           = "libx264",
419     .type           = AVMEDIA_TYPE_VIDEO,
420     .id             = CODEC_ID_H264,
421     .priv_data_size = sizeof(X264Context),
422     .init           = X264_init,
423     .encode         = X264_frame,
424     .close          = X264_close,
425     .capabilities   = CODEC_CAP_DELAY,
426     .pix_fmts       = (const enum PixelFormat[]) { PIX_FMT_YUV420P, PIX_FMT_YUVJ420P, PIX_FMT_NONE },
427     .long_name      = NULL_IF_CONFIG_SMALL("libx264 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10"),
428     .priv_class     = &class,
429     .defaults       = x264_defaults,
430 };