]> git.sesse.net Git - vlc/blob - modules/codec/x264.c
* modules/codec/x264.c: updated with latest changes in libx264.
[vlc] / modules / codec / x264.c
1 /*****************************************************************************
2  * x264.c: h264 video encoder
3  *****************************************************************************
4  * Copyright (C) 2004 VideoLAN
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <vlc/vlc.h>
28 #include <vlc/vout.h>
29 #include <vlc/sout.h>
30 #include <vlc/decoder.h>
31
32 #include <x264.h>
33
34 #define SOUT_CFG_PREFIX "sout-x264-"
35
36 /*****************************************************************************
37  * Module descriptor
38  *****************************************************************************/
39 static int  Open ( vlc_object_t * );
40 static void Close( vlc_object_t * );
41
42 #define QP_TEXT N_("Quantizer parameter")
43 #define QP_LONGTEXT N_( \
44     "This selects the quantizer to use (1 to 51). Lower values result in " \
45     "better fidelity, but higher bitrates. 26 is a good default value." )
46
47 #define QPMIN_TEXT N_("Minimum quantizer parameter")
48 #define QPMIN_LONGTEXT N_( "Minimum quantizer, 15/35 seems to be a useful " \
49     "range." )
50
51 #define QPMAX_TEXT N_("Maximum quantizer parameter")
52 #define QPMAX_LONGTEXT N_( "Maximum quantizer parameter." )
53
54 #define CABAC_TEXT N_("Enable CABAC")
55 #define CABAC_LONGTEXT N_( "Enable CABAC (Context-Adaptive Binary Arithmetic "\
56     "Coding). Slightly slows down encoding and decoding, but should save " \
57     "10-15% bitrate." )
58
59 #define LOOPF_TEXT N_("Enable loop filter")
60 #define LOOPF_LONGTEXT N_( "Use deblocking loop filter (increases quality).")
61
62 #define ANALYSE_TEXT N_("Analyse mode")
63 #define ANALYSE_LONGTEXT N_( "This selects the analysing mode.")
64
65 #define TOLERANCE_TEXT N_("Bitrate tolerance")
66 #define TOLERANCE_LONGTEXT N_( "Sets the allowed variance in average " \
67     "bitrate.")
68
69 #define VBV_MAXRATE_TEXT N_("Maximum local bitrate")
70 #define VBV_MAXRATE_LONGTEXT N_( "Sets a maximum local bitrate in kbits/s.")
71
72 #define VBV_BUFSIZE_TEXT N_("Averaging period for the maximum local bitrate")
73 #define VBV_BUFSIZE_LONGTEXT N_( "Sets an averaging preiod for the maximum " \
74     "local bitrate, in kbits/s.")
75
76 #define VBV_INIT_TEXT N_("Initial buffer occupancy")
77 #define VBV_INIT_LONGTEXT N_( "Sets the initial buffer occupancy as a " \
78     "fraction of the buffer size.")
79
80 #define KEYINT_TEXT N_("Sets maximum interval between IDR-frames")
81 #define KEYINT_LONGTEXT N_( "Larger values save bits, thus improve quality "\
82     "for a given bitrate, at the cost of seeking precision." )
83
84 #define KEYINT_MIN_TEXT N_("Sets minimum interval between IDR-frames")
85 #define KEYINT_MIN_LONGTEXT N_("In H.264, I-Frames do not necessarily bound " \
86     "a closed GOP because it is allowable for a P-frame to be predicted from "\
87     "more frames than just the one frame before it (also see frameref). " \
88     "Therefore, I-frames are not necessarily seekable. " \
89     "IDR-Frames restrict subsequent P-frames from referring to any frame " \
90     "prior to the IDR-Frame. \n" \
91     "If scenecuts appear within this interval, they are still encoded as " \
92     "I-frames, but do not start a new GOP. Default value is keyint * 0.4." )
93
94 #define BFRAMES_TEXT N_("B frames")
95 #define BFRAMES_LONGTEXT N_( "Number of consecutive B-Frames between I and " \
96     "P-frames." )
97
98 #define BPYRAMID_TEXT N_("B pyramid")
99 #define BPYRAMID_LONGTEXT N_( "Allows B-frames to be used as references for " \
100     "predicting other frames." )
101
102 #define FRAMEREF_TEXT N_("Number of previous frames used as predictors.")
103 #define FRAMEREF_LONGTEXT N_( "This is effective in Anime, but seems to " \
104     "make little difference in live-action source material. Some decoders " \
105     "are unable to deal with large frameref values." )
106
107 #define SCENE_TEXT N_("Scene-cut detection.")
108 #define SCENE_LONGTEXT N_( "Controls how aggressively to insert extra " \
109     "I-frames. With small values of scenecut, the codec often has to force " \
110     "an I-frame when it would exceed keyint. " \
111     "Good values of scenecut may find a better location for the I-frame. " \
112     "Large values use more I-frames than necessary, thus wasting bits. " \
113     "-1 disables scene-cut detection, so I-frames are be inserted only every "\
114     "other keyint frames, which probably leads to ugly encoding artifacts." )
115
116 #define SUBPEL_TEXT N_("Sub-pixel refinement quality.")
117 #define SUBPEL_LONGTEXT N_( "This parameter controls quality versus speed " \
118     "tradeoffs involved in the motion estimation decision process " \
119     "(lower = quicker and higher = better quality)." )
120
121 static char *enc_analyse_list[] =
122   { "", "all", "normal", "fast", "none" };
123 static char *enc_analyse_list_text[] =
124   { N_("default"), N_("all"), N_("normal"), N_("fast"), N_("none") };
125
126 vlc_module_begin();
127     set_description( _("h264 video encoder using x264 library"));
128     set_capability( "encoder", 200 );
129     set_callbacks( Open, Close );
130     set_category( CAT_INPUT );
131     set_subcategory( SUBCAT_INPUT_VCODEC );
132
133     add_integer( SOUT_CFG_PREFIX "qp", 0, NULL, QP_TEXT, QP_LONGTEXT,
134                  VLC_FALSE );
135         change_integer_range( 0, 51 );
136     add_integer( SOUT_CFG_PREFIX "qp-min", 10, NULL, QPMIN_TEXT,
137                  QPMIN_LONGTEXT, VLC_FALSE );
138         change_integer_range( 0, 51 );
139     add_integer( SOUT_CFG_PREFIX "qp-max", 51, NULL, QPMAX_TEXT,
140                  QPMAX_LONGTEXT, VLC_FALSE );
141         change_integer_range( 0, 51 );
142
143     add_bool( SOUT_CFG_PREFIX "cabac", 1, NULL, CABAC_TEXT, CABAC_LONGTEXT,
144               VLC_FALSE );
145
146     add_bool( SOUT_CFG_PREFIX "loopfilter", 1, NULL, LOOPF_TEXT,
147               LOOPF_LONGTEXT, VLC_FALSE );
148
149     add_string( SOUT_CFG_PREFIX "analyse", "", NULL, ANALYSE_TEXT,
150                 ANALYSE_LONGTEXT, VLC_FALSE );
151         change_string_list( enc_analyse_list, enc_analyse_list_text, 0 );
152
153     add_float( SOUT_CFG_PREFIX "tolerance", 1.0, NULL, TOLERANCE_TEXT,
154                TOLERANCE_LONGTEXT, VLC_FALSE );
155         change_float_range( 0, 100 );
156
157     add_integer( SOUT_CFG_PREFIX "vbv-maxrate", 0, NULL, VBV_MAXRATE_TEXT,
158                  VBV_MAXRATE_LONGTEXT, VLC_FALSE );
159
160     add_integer( SOUT_CFG_PREFIX "vbv-bufsize", 0, NULL, VBV_BUFSIZE_TEXT,
161                  VBV_BUFSIZE_LONGTEXT, VLC_FALSE );
162
163     add_float( SOUT_CFG_PREFIX "vbv-init", 0.9, NULL, VBV_INIT_TEXT,
164                VBV_INIT_LONGTEXT, VLC_FALSE );
165         change_float_range( 0, 1 );
166
167     add_integer( SOUT_CFG_PREFIX "keyint", 250, NULL, KEYINT_TEXT,
168                  KEYINT_LONGTEXT, VLC_FALSE );
169
170     add_integer( SOUT_CFG_PREFIX "keyint-min", 0, NULL, KEYINT_MIN_TEXT,
171                  KEYINT_MIN_LONGTEXT, VLC_FALSE );
172
173     add_integer( SOUT_CFG_PREFIX "bframes", 0, NULL, BFRAMES_TEXT,
174                  BFRAMES_LONGTEXT, VLC_FALSE );
175         change_integer_range( 0, 16 );
176
177     add_bool( SOUT_CFG_PREFIX "bpyramid", 0, NULL, BPYRAMID_TEXT,
178               BPYRAMID_LONGTEXT, VLC_FALSE );
179
180     add_integer( SOUT_CFG_PREFIX "frameref", 1, NULL, FRAMEREF_TEXT,
181                  FRAMEREF_LONGTEXT, VLC_FALSE );
182         change_integer_range( 1, 15 );
183
184     add_integer( SOUT_CFG_PREFIX "scenecut", 40, NULL, SCENE_TEXT,
185                  SCENE_LONGTEXT, VLC_FALSE );
186         change_integer_range( -1, 100 );
187
188     add_integer( SOUT_CFG_PREFIX "subpel", 5, NULL, SUBPEL_TEXT,
189                  SUBPEL_LONGTEXT, VLC_FALSE );
190         change_integer_range( 1, 5 );
191
192 vlc_module_end();
193
194 /*****************************************************************************
195  * Local prototypes
196  *****************************************************************************/
197 static const char *ppsz_sout_options[] = {
198     "qp", "qp-min", "qp-max", "cabac", "loopfilter", "analyse",
199     "keyint", "keyint-min", "bframes", "bpyramid", "frameref", "scenecut",
200     "subpel", "tolerance", "vbv-maxrate", "vbv-bufsize", "vbv-init", NULL
201 };
202
203 static block_t *Encode( encoder_t *, picture_t * );
204
205 struct encoder_sys_t
206 {
207     x264_t          *h;
208     x264_param_t    param;
209
210     int             i_buffer;
211     uint8_t         *p_buffer;
212 };
213
214 /*****************************************************************************
215  * Open: probe the encoder
216  *****************************************************************************/
217 static int  Open ( vlc_object_t *p_this )
218 {
219     encoder_t     *p_enc = (encoder_t *)p_this;
220     encoder_sys_t *p_sys;
221     vlc_value_t    val;
222     int i_qmin = 0, i_qmax = 0;
223
224     if( p_enc->fmt_out.i_codec != VLC_FOURCC( 'h', '2', '6', '4' ) &&
225         !p_enc->b_force )
226     {
227         return VLC_EGENERIC;
228     }
229
230     if( p_enc->fmt_in.video.i_width % 16 != 0 ||
231         p_enc->fmt_in.video.i_height % 16!= 0 )
232     {
233         msg_Warn( p_enc, "size is not a multiple of 16 (%ix%i)",
234                   p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height );
235
236         if( p_enc->fmt_in.video.i_width < 16 ||
237             p_enc->fmt_in.video.i_height < 16 )
238         {
239             msg_Err( p_enc, "video is too small to be cropped" );
240             return VLC_EGENERIC;
241         }
242
243         msg_Warn( p_enc, "cropping video to %ix%i",
244                   p_enc->fmt_in.video.i_width >> 4 << 4,
245                   p_enc->fmt_in.video.i_height >> 4 << 4 );
246     }
247
248     sout_CfgParse( p_enc, SOUT_CFG_PREFIX, ppsz_sout_options, p_enc->p_cfg );
249
250     p_enc->fmt_out.i_codec = VLC_FOURCC( 'h', '2', '6', '4' );
251     p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
252
253     p_enc->pf_encode_video = Encode;
254     p_enc->pf_encode_audio = NULL;
255     p_enc->p_sys = p_sys = malloc( sizeof( encoder_sys_t ) );
256
257     x264_param_default( &p_sys->param );
258     p_sys->param.i_width  = p_enc->fmt_in.video.i_width >> 4 << 4;
259     p_sys->param.i_height = p_enc->fmt_in.video.i_height >> 4 << 4;
260
261     var_Get( p_enc, SOUT_CFG_PREFIX "qp-min", &val );
262     if( val.i_int >= 1 && val.i_int <= 51 ) i_qmin = val.i_int;
263     var_Get( p_enc, SOUT_CFG_PREFIX "qp-max", &val );
264     if( val.i_int >= 1 && val.i_int <= 51 ) i_qmax = val.i_int;
265
266     var_Get( p_enc, SOUT_CFG_PREFIX "qp", &val );
267     if( val.i_int >= 1 && val.i_int <= 51 )
268     {
269         if( i_qmin > val.i_int ) i_qmin = val.i_int;
270         if( i_qmax < val.i_int ) i_qmax = val.i_int;
271
272 #if X264_BUILD >= 0x000a
273         p_sys->param.rc.i_qp_constant = val.i_int;
274         p_sys->param.rc.i_qp_min = i_qmin;
275         p_sys->param.rc.i_qp_max = i_qmax;
276 #else
277         p_sys->param.i_qp_constant = val.i_int;
278 #endif
279     }
280     else
281     {
282         /* No QP -> constant bitrate */
283 #if X264_BUILD >= 0x000a
284         p_sys->param.rc.b_cbr = 1;
285         p_sys->param.rc.i_bitrate = p_enc->fmt_out.i_bitrate / 1000;
286
287 #if X264_BUILD >= 24
288         var_Get( p_enc, SOUT_CFG_PREFIX "tolerance", &val );
289         p_sys->param.rc.f_rate_tolerance = val.f_float;
290
291         var_Get( p_enc, SOUT_CFG_PREFIX "vbv-maxrate", &val );
292         p_sys->param.rc.i_vbv_max_bitrate = val.i_int;
293
294         var_Get( p_enc, SOUT_CFG_PREFIX "vbv-bufsize", &val );
295         p_sys->param.rc.i_vbv_buffer_size = val.i_int;
296         if( !val.i_int )
297             p_sys->param.rc.i_vbv_buffer_size = p_sys->param.rc.i_bitrate;
298
299         var_Get( p_enc, SOUT_CFG_PREFIX "vbv-init", &val );
300         p_sys->param.rc.f_vbv_buffer_init = val.f_float;
301 #else
302         p_sys->param.rc.i_rc_buffer_size = p_sys->param.rc.i_bitrate;
303         p_sys->param.rc.i_rc_init_buffer = p_sys->param.rc.i_bitrate / 4;
304 #endif
305 #endif
306     }
307
308     var_Get( p_enc, SOUT_CFG_PREFIX "cabac", &val );
309     p_sys->param.b_cabac = val.b_bool;
310
311     var_Get( p_enc, SOUT_CFG_PREFIX "loopfilter", &val );
312     p_sys->param.b_deblocking_filter = val.b_bool;
313
314     var_Get( p_enc, SOUT_CFG_PREFIX "keyint", &val );
315 #if X264_BUILD >= 0x000e
316     if( val.i_int > 0 ) p_sys->param.i_keyint_max = val.i_int;
317     if( val.i_int > 0 ) p_sys->param.i_keyint_min = val.i_int * 0.4;
318 #else
319     if( val.i_int > 0 ) p_sys->param.i_iframe = val.i_int;
320 #endif
321
322     var_Get( p_enc, SOUT_CFG_PREFIX "keyint-min", &val );
323 #if X264_BUILD >= 0x000e
324     if( val.i_int > 0 ) p_sys->param.i_keyint_min = val.i_int;
325 #else
326     if( val.i_int > 0 ) p_sys->param.i_idrframe = val.i_int;
327 #endif
328
329     var_Get( p_enc, SOUT_CFG_PREFIX "bframes", &val );
330     if( val.i_int >= 0 && val.i_int <= 16 ) p_sys->param.i_bframe = val.i_int;
331
332 #if X264_BUILD >= 22
333     var_Get( p_enc, SOUT_CFG_PREFIX "bpyramid", &val );
334     p_sys->param.b_bframe_pyramid = val.b_bool;
335 #endif
336
337     var_Get( p_enc, SOUT_CFG_PREFIX "frameref", &val );
338     if( val.i_int > 0 && val.i_int <= 15 )
339         p_sys->param.i_frame_reference = val.i_int;
340
341     var_Get( p_enc, SOUT_CFG_PREFIX "scenecut", &val );
342 #if X264_BUILD >= 0x000b
343     if( val.i_int >= -1 && val.i_int <= 100 )
344         p_sys->param.i_scenecut_threshold = val.i_int;
345 #endif
346
347 #if X264_BUILD >= 22
348     var_Get( p_enc, SOUT_CFG_PREFIX "subpel", &val );
349     if( val.i_int >= 1 && val.i_int <= 5 )
350         p_sys->param.analyse.i_subpel_refine = val.i_int;
351 #endif
352
353     var_Get( p_enc, SOUT_CFG_PREFIX "analyse", &val );
354     if( !strcmp( val.psz_string, "none" ) )
355     {
356         p_sys->param.analyse.inter = 0;
357     }
358     else if( !strcmp( val.psz_string, "fast" ) )
359     {
360         p_sys->param.analyse.inter = X264_ANALYSE_I4x4;
361     }
362     else if( !strcmp( val.psz_string, "normal" ) )
363     {
364         p_sys->param.analyse.inter =
365             X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16;
366     }
367     else if( !strcmp( val.psz_string, "all" ) )
368     {
369 #ifndef X264_ANALYSE_BSUB16x16
370 #   define X264_ANALYSE_BSUB16x16 0
371 #endif
372         p_sys->param.analyse.inter =
373             X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16 | X264_ANALYSE_PSUB8x8 |
374             X264_ANALYSE_BSUB16x16;
375     }
376     if( val.psz_string ) free( val.psz_string );
377
378     if( p_enc->fmt_in.video.i_aspect > 0 )
379     {
380         int64_t i_num, i_den;
381         int i_dst_num, i_dst_den;
382
383         i_num = p_enc->fmt_in.video.i_aspect *
384             (int64_t)p_enc->fmt_in.video.i_height;
385         i_den = VOUT_ASPECT_FACTOR * p_enc->fmt_in.video.i_width;
386         vlc_reduce( &i_dst_num, &i_dst_den, i_num, i_den, 0 );
387
388         p_sys->param.vui.i_sar_width = i_dst_num;
389         p_sys->param.vui.i_sar_height = i_dst_den;
390     }
391     if( p_enc->fmt_in.video.i_frame_rate_base > 0 )
392     {
393         p_sys->param.i_fps_num = p_enc->fmt_in.video.i_frame_rate;
394         p_sys->param.i_fps_den = p_enc->fmt_in.video.i_frame_rate_base;
395     }
396     if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMX) )
397     {
398         p_sys->param.cpu &= ~X264_CPU_MMX;
399     }
400     if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMXEXT) )
401     {
402         p_sys->param.cpu &= ~X264_CPU_MMXEXT;
403     }
404     if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE) )
405     {
406         p_sys->param.cpu &= ~X264_CPU_SSE;
407     }
408     if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE2) )
409     {
410         p_sys->param.cpu &= ~X264_CPU_SSE2;
411     }
412
413     /* Open the encoder */
414     p_sys->h = x264_encoder_open( &p_sys->param );
415
416     /* alloc mem */
417     p_sys->i_buffer = 4 * p_enc->fmt_in.video.i_width *
418         p_enc->fmt_in.video.i_height + 1000;
419     p_sys->p_buffer = malloc( p_sys->i_buffer );
420
421     /* get the globals headers */
422     p_enc->fmt_out.i_extra = 0;
423     p_enc->fmt_out.p_extra = NULL;
424
425 #if 0
426     x264_encoder_headers( p_sys->h, &nal, &i_nal );
427     for( i = 0; i < i_nal; i++ )
428     {
429         int i_size = p_sys->i_buffer;
430
431         x264_nal_encode( p_sys->p_buffer, &i_size, 1, &nal[i] );
432
433         p_enc->fmt_out.p_extra = realloc( p_enc->fmt_out.p_extra, p_enc->fmt_out.i_extra + i_size );
434
435         memcpy( p_enc->fmt_out.p_extra + p_enc->fmt_out.i_extra,
436                 p_sys->p_buffer, i_size );
437
438         p_enc->fmt_out.i_extra += i_size;
439     }
440 #endif
441
442     return VLC_SUCCESS;
443 }
444
445 /****************************************************************************
446  * Encode:
447  ****************************************************************************/
448 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
449 {
450     encoder_sys_t *p_sys = p_enc->p_sys;
451     x264_picture_t pic;
452     x264_nal_t *nal;
453     block_t *p_block;
454     int i_nal, i_out, i;
455
456     /* init pic */
457     memset( &pic, 0, sizeof( x264_picture_t ) );
458     pic.img.i_csp = X264_CSP_I420;
459     pic.img.i_plane = p_pict->i_planes;
460     for( i = 0; i < p_pict->i_planes; i++ )
461     {
462         pic.img.plane[i] = p_pict->p[i].p_pixels;
463         pic.img.i_stride[i] = p_pict->p[i].i_pitch;
464     }
465
466 #if X264_BUILD >= 0x0013
467     x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic, &pic );
468 #else
469     x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic );
470 #endif
471     for( i = 0, i_out = 0; i < i_nal; i++ )
472     {
473         int i_size = p_sys->i_buffer - i_out;
474         x264_nal_encode( p_sys->p_buffer + i_out, &i_size, 1, &nal[i] );
475
476         i_out += i_size;
477     }
478
479     p_block = block_New( p_enc, i_out );
480     p_block->i_dts = p_pict->date;
481     p_block->i_pts = p_pict->date;
482     memcpy( p_block->p_buffer, p_sys->p_buffer, i_out );
483
484     if( pic.i_type == X264_TYPE_IDR || pic.i_type == X264_TYPE_I )
485         p_block->i_flags |= BLOCK_FLAG_TYPE_I;
486     else if( pic.i_type == X264_TYPE_P )
487         p_block->i_flags |= BLOCK_FLAG_TYPE_P;
488     else if( pic.i_type == X264_TYPE_B )
489         p_block->i_flags |= BLOCK_FLAG_TYPE_B;
490
491     return p_block;
492 }
493
494 /*****************************************************************************
495  * CloseEncoder: ffmpeg encoder destruction
496  *****************************************************************************/
497 static void Close( vlc_object_t *p_this )
498 {
499     encoder_t     *p_enc = (encoder_t *)p_this;
500     encoder_sys_t *p_sys = p_enc->p_sys;
501
502     x264_encoder_close( p_sys->h );
503     free( p_sys->p_buffer );
504     free( p_sys );
505 }