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