1 /*****************************************************************************
2 * x264.c: h264 video encoder
3 *****************************************************************************
4 * Copyright (C) 2004 VideoLAN (Centrale Réseaux) and its contributors
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
30 #include <vlc/decoder.h>
34 #define SOUT_CFG_PREFIX "sout-x264-"
36 /*****************************************************************************
38 *****************************************************************************/
39 static int Open ( vlc_object_t * );
40 static void Close( vlc_object_t * );
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." )
47 #define QPMIN_TEXT N_("Minimum quantizer parameter")
48 #define QPMIN_LONGTEXT N_( "Minimum quantizer, 15/35 seems to be a useful " \
51 #define QPMAX_TEXT N_("Maximum quantizer parameter")
52 #define QPMAX_LONGTEXT N_( "Maximum quantizer parameter." )
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 " \
59 #define LOOPF_TEXT N_("Enable loop filter")
60 #define LOOPF_LONGTEXT N_( "Use deblocking loop filter (increases quality).")
62 #define ANALYSE_TEXT N_("Analyse mode")
63 #define ANALYSE_LONGTEXT N_( "This selects the analysing mode.")
65 #define TOLERANCE_TEXT N_("Bitrate tolerance")
66 #define TOLERANCE_LONGTEXT N_( "Sets the allowed variance in average " \
69 #define VBV_MAXRATE_TEXT N_("Maximum local bitrate")
70 #define VBV_MAXRATE_LONGTEXT N_( "Sets a maximum local bitrate in kbits/s.")
72 #define VBV_BUFSIZE_TEXT N_("Averaging period for the maximum local bitrate")
73 #define VBV_BUFSIZE_LONGTEXT N_( "Sets an averaging period for the maximum " \
74 "local bitrate, in kbits/s.")
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.")
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." )
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." )
94 #define BFRAMES_TEXT N_("B frames")
95 #define BFRAMES_LONGTEXT N_( "Number of consecutive B-Frames between I and " \
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." )
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." )
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." )
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)." )
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") };
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 );
133 add_integer( SOUT_CFG_PREFIX "qp", 0, NULL, QP_TEXT, QP_LONGTEXT,
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 );
143 add_bool( SOUT_CFG_PREFIX "cabac", 1, NULL, CABAC_TEXT, CABAC_LONGTEXT,
146 add_bool( SOUT_CFG_PREFIX "loopfilter", 1, NULL, LOOPF_TEXT,
147 LOOPF_LONGTEXT, VLC_FALSE );
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 );
153 add_float( SOUT_CFG_PREFIX "tolerance", 1.0, NULL, TOLERANCE_TEXT,
154 TOLERANCE_LONGTEXT, VLC_FALSE );
155 change_float_range( 0, 100 );
157 add_integer( SOUT_CFG_PREFIX "vbv-maxrate", 0, NULL, VBV_MAXRATE_TEXT,
158 VBV_MAXRATE_LONGTEXT, VLC_FALSE );
160 add_integer( SOUT_CFG_PREFIX "vbv-bufsize", 0, NULL, VBV_BUFSIZE_TEXT,
161 VBV_BUFSIZE_LONGTEXT, VLC_FALSE );
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 );
167 add_integer( SOUT_CFG_PREFIX "keyint", 250, NULL, KEYINT_TEXT,
168 KEYINT_LONGTEXT, VLC_FALSE );
170 add_integer( SOUT_CFG_PREFIX "keyint-min", 0, NULL, KEYINT_MIN_TEXT,
171 KEYINT_MIN_LONGTEXT, VLC_FALSE );
173 add_integer( SOUT_CFG_PREFIX "bframes", 0, NULL, BFRAMES_TEXT,
174 BFRAMES_LONGTEXT, VLC_FALSE );
175 change_integer_range( 0, 16 );
177 add_bool( SOUT_CFG_PREFIX "bpyramid", 0, NULL, BPYRAMID_TEXT,
178 BPYRAMID_LONGTEXT, VLC_FALSE );
180 add_integer( SOUT_CFG_PREFIX "frameref", 1, NULL, FRAMEREF_TEXT,
181 FRAMEREF_LONGTEXT, VLC_FALSE );
182 change_integer_range( 1, 15 );
184 add_integer( SOUT_CFG_PREFIX "scenecut", 40, NULL, SCENE_TEXT,
185 SCENE_LONGTEXT, VLC_FALSE );
186 change_integer_range( -1, 100 );
188 add_integer( SOUT_CFG_PREFIX "subpel", 5, NULL, SUBPEL_TEXT,
189 SUBPEL_LONGTEXT, VLC_FALSE );
190 change_integer_range( 1, 5 );
194 /*****************************************************************************
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
203 static block_t *Encode( encoder_t *, picture_t * );
213 mtime_t i_last_ref_pts;
216 /*****************************************************************************
217 * Open: probe the encoder
218 *****************************************************************************/
219 static int Open ( vlc_object_t *p_this )
221 encoder_t *p_enc = (encoder_t *)p_this;
222 encoder_sys_t *p_sys;
224 int i_qmin = 0, i_qmax = 0;
226 if( p_enc->fmt_out.i_codec != VLC_FOURCC( 'h', '2', '6', '4' ) &&
232 if( p_enc->fmt_in.video.i_width % 16 != 0 ||
233 p_enc->fmt_in.video.i_height % 16!= 0 )
235 msg_Warn( p_enc, "size is not a multiple of 16 (%ix%i)",
236 p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height );
238 if( p_enc->fmt_in.video.i_width < 16 ||
239 p_enc->fmt_in.video.i_height < 16 )
241 msg_Err( p_enc, "video is too small to be cropped" );
245 msg_Warn( p_enc, "cropping video to %ix%i",
246 p_enc->fmt_in.video.i_width >> 4 << 4,
247 p_enc->fmt_in.video.i_height >> 4 << 4 );
250 sout_CfgParse( p_enc, SOUT_CFG_PREFIX, ppsz_sout_options, p_enc->p_cfg );
252 p_enc->fmt_out.i_codec = VLC_FOURCC( 'h', '2', '6', '4' );
253 p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
255 p_enc->pf_encode_video = Encode;
256 p_enc->pf_encode_audio = NULL;
257 p_enc->p_sys = p_sys = malloc( sizeof( encoder_sys_t ) );
258 p_sys->i_last_ref_pts = 0;
260 x264_param_default( &p_sys->param );
261 p_sys->param.i_width = p_enc->fmt_in.video.i_width >> 4 << 4;
262 p_sys->param.i_height = p_enc->fmt_in.video.i_height >> 4 << 4;
264 var_Get( p_enc, SOUT_CFG_PREFIX "qp-min", &val );
265 if( val.i_int >= 1 && val.i_int <= 51 ) i_qmin = val.i_int;
266 var_Get( p_enc, SOUT_CFG_PREFIX "qp-max", &val );
267 if( val.i_int >= 1 && val.i_int <= 51 ) i_qmax = val.i_int;
269 var_Get( p_enc, SOUT_CFG_PREFIX "qp", &val );
270 if( val.i_int >= 1 && val.i_int <= 51 )
272 if( i_qmin > val.i_int ) i_qmin = val.i_int;
273 if( i_qmax < val.i_int ) i_qmax = val.i_int;
275 #if X264_BUILD >= 0x000a
276 p_sys->param.rc.i_qp_constant = val.i_int;
277 p_sys->param.rc.i_qp_min = i_qmin;
278 p_sys->param.rc.i_qp_max = i_qmax;
280 p_sys->param.i_qp_constant = val.i_int;
285 /* No QP -> constant bitrate */
286 #if X264_BUILD >= 0x000a
287 p_sys->param.rc.b_cbr = 1;
288 p_sys->param.rc.i_bitrate = p_enc->fmt_out.i_bitrate / 1000;
291 var_Get( p_enc, SOUT_CFG_PREFIX "tolerance", &val );
292 p_sys->param.rc.f_rate_tolerance = val.f_float;
294 var_Get( p_enc, SOUT_CFG_PREFIX "vbv-maxrate", &val );
295 p_sys->param.rc.i_vbv_max_bitrate = val.i_int;
297 var_Get( p_enc, SOUT_CFG_PREFIX "vbv-bufsize", &val );
298 p_sys->param.rc.i_vbv_buffer_size = val.i_int;
300 p_sys->param.rc.i_vbv_buffer_size = p_sys->param.rc.i_bitrate;
302 var_Get( p_enc, SOUT_CFG_PREFIX "vbv-init", &val );
303 p_sys->param.rc.f_vbv_buffer_init = val.f_float;
305 p_sys->param.rc.i_rc_buffer_size = p_sys->param.rc.i_bitrate;
306 p_sys->param.rc.i_rc_init_buffer = p_sys->param.rc.i_bitrate / 4;
311 var_Get( p_enc, SOUT_CFG_PREFIX "cabac", &val );
312 p_sys->param.b_cabac = val.b_bool;
314 var_Get( p_enc, SOUT_CFG_PREFIX "loopfilter", &val );
315 p_sys->param.b_deblocking_filter = val.b_bool;
317 var_Get( p_enc, SOUT_CFG_PREFIX "keyint", &val );
318 #if X264_BUILD >= 0x000e
319 if( val.i_int > 0 ) p_sys->param.i_keyint_max = val.i_int;
320 if( val.i_int > 0 ) p_sys->param.i_keyint_min = val.i_int * 0.4;
322 if( val.i_int > 0 ) p_sys->param.i_iframe = val.i_int;
325 var_Get( p_enc, SOUT_CFG_PREFIX "keyint-min", &val );
326 #if X264_BUILD >= 0x000e
327 if( val.i_int > 0 ) p_sys->param.i_keyint_min = val.i_int;
329 if( val.i_int > 0 ) p_sys->param.i_idrframe = val.i_int;
332 var_Get( p_enc, SOUT_CFG_PREFIX "bframes", &val );
333 if( val.i_int >= 0 && val.i_int <= 16 ) p_sys->param.i_bframe = val.i_int;
336 var_Get( p_enc, SOUT_CFG_PREFIX "bpyramid", &val );
337 p_sys->param.b_bframe_pyramid = val.b_bool;
340 var_Get( p_enc, SOUT_CFG_PREFIX "frameref", &val );
341 if( val.i_int > 0 && val.i_int <= 15 )
342 p_sys->param.i_frame_reference = val.i_int;
344 var_Get( p_enc, SOUT_CFG_PREFIX "scenecut", &val );
345 #if X264_BUILD >= 0x000b
346 if( val.i_int >= -1 && val.i_int <= 100 )
347 p_sys->param.i_scenecut_threshold = val.i_int;
351 var_Get( p_enc, SOUT_CFG_PREFIX "subpel", &val );
352 if( val.i_int >= 1 && val.i_int <= 5 )
353 p_sys->param.analyse.i_subpel_refine = val.i_int;
356 var_Get( p_enc, SOUT_CFG_PREFIX "analyse", &val );
357 if( !strcmp( val.psz_string, "none" ) )
359 p_sys->param.analyse.inter = 0;
361 else if( !strcmp( val.psz_string, "fast" ) )
363 p_sys->param.analyse.inter = X264_ANALYSE_I4x4;
365 else if( !strcmp( val.psz_string, "normal" ) )
367 p_sys->param.analyse.inter =
368 X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16;
370 else if( !strcmp( val.psz_string, "all" ) )
372 #ifndef X264_ANALYSE_BSUB16x16
373 # define X264_ANALYSE_BSUB16x16 0
375 p_sys->param.analyse.inter =
376 X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16 | X264_ANALYSE_PSUB8x8 |
377 X264_ANALYSE_BSUB16x16;
379 if( val.psz_string ) free( val.psz_string );
381 if( p_enc->fmt_in.video.i_aspect > 0 )
383 int64_t i_num, i_den;
384 int i_dst_num, i_dst_den;
386 i_num = p_enc->fmt_in.video.i_aspect *
387 (int64_t)p_enc->fmt_in.video.i_height;
388 i_den = VOUT_ASPECT_FACTOR * p_enc->fmt_in.video.i_width;
389 vlc_reduce( &i_dst_num, &i_dst_den, i_num, i_den, 0 );
391 p_sys->param.vui.i_sar_width = i_dst_num;
392 p_sys->param.vui.i_sar_height = i_dst_den;
394 if( p_enc->fmt_in.video.i_frame_rate_base > 0 )
396 p_sys->param.i_fps_num = p_enc->fmt_in.video.i_frame_rate;
397 p_sys->param.i_fps_den = p_enc->fmt_in.video.i_frame_rate_base;
399 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMX) )
401 p_sys->param.cpu &= ~X264_CPU_MMX;
403 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMXEXT) )
405 p_sys->param.cpu &= ~X264_CPU_MMXEXT;
407 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE) )
409 p_sys->param.cpu &= ~X264_CPU_SSE;
411 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE2) )
413 p_sys->param.cpu &= ~X264_CPU_SSE2;
417 if( p_enc->i_threads >= 1 )
418 p_sys->param.i_threads = p_enc->i_threads;
421 /* Open the encoder */
422 p_sys->h = x264_encoder_open( &p_sys->param );
425 p_sys->i_buffer = 4 * p_enc->fmt_in.video.i_width *
426 p_enc->fmt_in.video.i_height + 1000;
427 p_sys->p_buffer = malloc( p_sys->i_buffer );
429 /* get the globals headers */
430 p_enc->fmt_out.i_extra = 0;
431 p_enc->fmt_out.p_extra = NULL;
434 x264_encoder_headers( p_sys->h, &nal, &i_nal );
435 for( i = 0; i < i_nal; i++ )
437 int i_size = p_sys->i_buffer;
439 x264_nal_encode( p_sys->p_buffer, &i_size, 1, &nal[i] );
441 p_enc->fmt_out.p_extra = realloc( p_enc->fmt_out.p_extra, p_enc->fmt_out.i_extra + i_size );
443 memcpy( p_enc->fmt_out.p_extra + p_enc->fmt_out.i_extra,
444 p_sys->p_buffer, i_size );
446 p_enc->fmt_out.i_extra += i_size;
453 /****************************************************************************
455 ****************************************************************************/
456 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
458 encoder_sys_t *p_sys = p_enc->p_sys;
465 memset( &pic, 0, sizeof( x264_picture_t ) );
466 pic.i_pts = p_pict->date;
467 pic.img.i_csp = X264_CSP_I420;
468 pic.img.i_plane = p_pict->i_planes;
469 for( i = 0; i < p_pict->i_planes; i++ )
471 pic.img.plane[i] = p_pict->p[i].p_pixels;
472 pic.img.i_stride[i] = p_pict->p[i].i_pitch;
475 #if X264_BUILD >= 0x0013
476 x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic, &pic );
478 x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic );
481 if( !i_nal ) return NULL;
483 for( i = 0, i_out = 0; i < i_nal; i++ )
485 int i_size = p_sys->i_buffer - i_out;
486 x264_nal_encode( p_sys->p_buffer + i_out, &i_size, 1, &nal[i] );
491 p_block = block_New( p_enc, i_out );
492 memcpy( p_block->p_buffer, p_sys->p_buffer, i_out );
494 if( pic.i_type == X264_TYPE_IDR || pic.i_type == X264_TYPE_I )
495 p_block->i_flags |= BLOCK_FLAG_TYPE_I;
496 else if( pic.i_type == X264_TYPE_P )
497 p_block->i_flags |= BLOCK_FLAG_TYPE_P;
498 else if( pic.i_type == X264_TYPE_B )
499 p_block->i_flags |= BLOCK_FLAG_TYPE_B;
501 /* This isn't really valid for streams with B-frames */
502 p_block->i_length = I64C(1000000) *
503 p_enc->fmt_in.video.i_frame_rate_base /
504 p_enc->fmt_in.video.i_frame_rate;
506 p_block->i_dts = p_block->i_pts = pic.i_pts;
508 if( p_sys->param.i_bframe > 0 )
510 if( p_block->i_flags & BLOCK_FLAG_TYPE_B )
512 p_block->i_dts = p_block->i_pts;
516 if( p_sys->i_last_ref_pts )
518 p_block->i_dts = p_sys->i_last_ref_pts;
522 /* Let's put something sensible */
523 p_block->i_dts = p_block->i_pts;
526 p_sys->i_last_ref_pts = p_block->i_pts;
533 /*****************************************************************************
534 * CloseEncoder: ffmpeg encoder destruction
535 *****************************************************************************/
536 static void Close( vlc_object_t *p_this )
538 encoder_t *p_enc = (encoder_t *)p_this;
539 encoder_sys_t *p_sys = p_enc->p_sys;
541 x264_encoder_close( p_sys->h );
542 free( p_sys->p_buffer );