1 /*****************************************************************************
2 * x264.c: h264 video encoder
3 *****************************************************************************
4 * Copyright (C) 2004 VideoLAN
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 KEYINT_TEXT N_("Sets maximum interval between IDR-frames")
66 #define KEYINT_LONGTEXT N_( "Larger values save bits, thus improve quality "\
67 "for a given bitrate, at the cost of seeking precision." )
69 #define KEYINT_MIN_TEXT N_("Sets minimum interval between IDR-frames")
70 #define KEYINT_MIN_LONGTEXT N_("In H.264, I-Frames do not necessarily bound " \
71 "a closed GOP because it is allowable for a P-frame to be predicted from "\
72 "more frames than just the one frame before it (also see frameref). " \
73 "Therefore, I-frames are not necessarily seekable. " \
74 "IDR-Frames restrict subsequent P-frames from referring to any frame " \
75 "prior to the IDR-Frame. \n" \
76 "If scenecuts appear within this interval, they are still encoded as " \
77 "I-frames, but do not start a new GOP. Default value is keyint * 0.4." )
79 #define BFRAMES_TEXT N_("B frames")
80 #define BFRAMES_LONGTEXT N_( "Number of consecutive B-Frames between I and " \
83 #define BPYRAMID_TEXT N_("B pyramid")
84 #define BPYRAMID_LONGTEXT N_( "Allows B-frames to be used as references for " \
85 "predicting other frames." )
87 #define FRAMEREF_TEXT N_("Number of previous frames used as predictors.")
88 #define FRAMEREF_LONGTEXT N_( "This is effective in Anime, but seems to " \
89 "make little difference in live-action source material. Some decoders " \
90 "are unable to deal with large frameref values." )
92 #define SCENE_TEXT N_("Scene-cut detection.")
93 #define SCENE_LONGTEXT N_( "Controls how aggressively to insert extra " \
94 "I-frames. With small values of scenecut, the codec often has to force " \
95 "an I-frame when it would exceed keyint. " \
96 "Good values of scenecut may find a better location for the I-frame. " \
97 "Large values use more I-frames than necessary, thus wasting bits. " \
98 "-1 disables scene-cut detection, so I-frames are be inserted only every "\
99 "other keyint frames, which probably leads to ugly encoding artifacts." )
101 #define SUBPEL_TEXT N_("Sub-pixel refinement quality.")
102 #define SUBPEL_LONGTEXT N_( "This parameter controls quality versus speed " \
103 "tradeoffs involved in the motion estimation decision process " \
104 "(lower = quicker and higher = better quality)." )
106 static char *enc_analyse_list[] =
107 { "", "all", "normal", "fast", "none" };
108 static char *enc_analyse_list_text[] =
109 { N_("default"), N_("all"), N_("normal"), N_("fast"), N_("none") };
112 set_description( _("h264 video encoder using x264 library"));
113 set_capability( "encoder", 200 );
114 set_callbacks( Open, Close );
115 set_category( CAT_INPUT );
116 set_subcategory( SUBCAT_INPUT_VCODEC );
118 add_integer( SOUT_CFG_PREFIX "qp", 0, NULL, QP_TEXT, QP_LONGTEXT,
120 change_integer_range( 0, 51 );
121 add_integer( SOUT_CFG_PREFIX "qp-min", 10, NULL, QPMIN_TEXT,
122 QPMIN_LONGTEXT, VLC_FALSE );
123 change_integer_range( 0, 51 );
124 add_integer( SOUT_CFG_PREFIX "qp-max", 51, NULL, QPMAX_TEXT,
125 QPMAX_LONGTEXT, VLC_FALSE );
126 change_integer_range( 0, 51 );
128 add_bool( SOUT_CFG_PREFIX "cabac", 1, NULL, CABAC_TEXT, CABAC_LONGTEXT,
131 add_bool( SOUT_CFG_PREFIX "loopfilter", 1, NULL, LOOPF_TEXT,
132 LOOPF_LONGTEXT, VLC_FALSE );
134 add_string( SOUT_CFG_PREFIX "analyse", "", NULL, ANALYSE_TEXT,
135 ANALYSE_LONGTEXT, VLC_FALSE );
136 change_string_list( enc_analyse_list, enc_analyse_list_text, 0 );
138 add_integer( SOUT_CFG_PREFIX "keyint", 250, NULL, KEYINT_TEXT,
139 KEYINT_LONGTEXT, VLC_FALSE );
141 add_integer( SOUT_CFG_PREFIX "keyint-min", 0, NULL, KEYINT_MIN_TEXT,
142 KEYINT_MIN_LONGTEXT, VLC_FALSE );
144 add_integer( SOUT_CFG_PREFIX "bframes", 0, NULL, BFRAMES_TEXT,
145 BFRAMES_LONGTEXT, VLC_FALSE );
146 change_integer_range( 0, 16 );
148 add_bool( SOUT_CFG_PREFIX "bpyramid", 0, NULL, BPYRAMID_TEXT,
149 BPYRAMID_LONGTEXT, VLC_FALSE );
151 add_integer( SOUT_CFG_PREFIX "frameref", 1, NULL, FRAMEREF_TEXT,
152 FRAMEREF_LONGTEXT, VLC_FALSE );
153 change_integer_range( 1, 15 );
155 add_integer( SOUT_CFG_PREFIX "scenecut", 40, NULL, SCENE_TEXT,
156 SCENE_LONGTEXT, VLC_FALSE );
157 change_integer_range( -1, 100 );
159 add_integer( SOUT_CFG_PREFIX "subpel", 5, NULL, SUBPEL_TEXT,
160 SUBPEL_LONGTEXT, VLC_FALSE );
161 change_integer_range( 1, 5 );
165 /*****************************************************************************
167 *****************************************************************************/
168 static const char *ppsz_sout_options[] = {
169 "qp", "qp-min", "qp-max", "cabac", "loopfilter", "analyse",
170 "keyint", "keyint-min", "bframes", "bpyramid", "frameref", "scenecut",
174 static block_t *Encode( encoder_t *, picture_t * );
185 /*****************************************************************************
186 * Open: probe the encoder
187 *****************************************************************************/
188 static int Open ( vlc_object_t *p_this )
190 encoder_t *p_enc = (encoder_t *)p_this;
191 encoder_sys_t *p_sys;
193 int i_qmin = 0, i_qmax = 0;
195 if( p_enc->fmt_out.i_codec != VLC_FOURCC( 'h', '2', '6', '4' ) &&
201 if( p_enc->fmt_in.video.i_width % 16 != 0 ||
202 p_enc->fmt_in.video.i_height % 16!= 0 )
204 msg_Warn( p_enc, "size is not a multiple of 16 (%ix%i)",
205 p_enc->fmt_in.video.i_width, p_enc->fmt_in.video.i_height );
207 if( p_enc->fmt_in.video.i_width < 16 ||
208 p_enc->fmt_in.video.i_height < 16 )
210 msg_Err( p_enc, "video is too small to be cropped" );
214 msg_Warn( p_enc, "cropping video to %ix%i",
215 p_enc->fmt_in.video.i_width >> 4 << 4,
216 p_enc->fmt_in.video.i_height >> 4 << 4 );
219 sout_CfgParse( p_enc, SOUT_CFG_PREFIX, ppsz_sout_options, p_enc->p_cfg );
221 p_enc->fmt_out.i_codec = VLC_FOURCC( 'h', '2', '6', '4' );
222 p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
224 p_enc->pf_encode_video = Encode;
225 p_enc->pf_encode_audio = NULL;
226 p_enc->p_sys = p_sys = malloc( sizeof( encoder_sys_t ) );
228 x264_param_default( &p_sys->param );
229 p_sys->param.i_width = p_enc->fmt_in.video.i_width >> 4 << 4;
230 p_sys->param.i_height = p_enc->fmt_in.video.i_height >> 4 << 4;
232 var_Get( p_enc, SOUT_CFG_PREFIX "qp-min", &val );
233 if( val.i_int >= 1 && val.i_int <= 51 ) i_qmin = val.i_int;
234 var_Get( p_enc, SOUT_CFG_PREFIX "qp-max", &val );
235 if( val.i_int >= 1 && val.i_int <= 51 ) i_qmax = val.i_int;
237 var_Get( p_enc, SOUT_CFG_PREFIX "qp", &val );
238 if( val.i_int >= 1 && val.i_int <= 51 )
240 if( i_qmin > val.i_int ) i_qmin = val.i_int;
241 if( i_qmax < val.i_int ) i_qmax = val.i_int;
243 #if X264_BUILD >= 0x000a
244 p_sys->param.rc.i_qp_constant = val.i_int;
245 p_sys->param.rc.i_qp_min = i_qmin;
246 p_sys->param.rc.i_qp_max = i_qmax;
248 p_sys->param.i_qp_constant = val.i_int;
253 /* No QP -> constant bitrate */
254 #if X264_BUILD >= 0x000a
255 p_sys->param.rc.b_cbr = 1;
256 p_sys->param.rc.i_bitrate = p_enc->fmt_out.i_bitrate / 1000;
257 p_sys->param.rc.i_rc_buffer_size = p_sys->param.rc.i_bitrate;
258 p_sys->param.rc.i_rc_init_buffer = p_sys->param.rc.i_bitrate / 4;
262 var_Get( p_enc, SOUT_CFG_PREFIX "cabac", &val );
263 p_sys->param.b_cabac = val.b_bool;
265 var_Get( p_enc, SOUT_CFG_PREFIX "loopfilter", &val );
266 p_sys->param.b_deblocking_filter = val.b_bool;
268 var_Get( p_enc, SOUT_CFG_PREFIX "keyint", &val );
269 #if X264_BUILD >= 0x000e
270 if( val.i_int > 0 ) p_sys->param.i_keyint_max = val.i_int;
271 if( val.i_int > 0 ) p_sys->param.i_keyint_min = val.i_int * 0.4;
273 if( val.i_int > 0 ) p_sys->param.i_iframe = val.i_int;
276 var_Get( p_enc, SOUT_CFG_PREFIX "keyint-min", &val );
277 #if X264_BUILD >= 0x000e
278 if( val.i_int > 0 ) p_sys->param.i_keyint_min = val.i_int;
280 if( val.i_int > 0 ) p_sys->param.i_idrframe = val.i_int;
283 var_Get( p_enc, SOUT_CFG_PREFIX "bframes", &val );
284 if( val.i_int >= 0 && val.i_int <= 16 ) p_sys->param.i_bframe = val.i_int;
287 var_Get( p_enc, SOUT_CFG_PREFIX "bpyramid", &val );
288 p_sys->param.b_bframe_pyramid = val.b_bool;
291 var_Get( p_enc, SOUT_CFG_PREFIX "frameref", &val );
292 if( val.i_int > 0 && val.i_int <= 15 )
293 p_sys->param.i_frame_reference = val.i_int;
295 var_Get( p_enc, SOUT_CFG_PREFIX "scenecut", &val );
296 #if X264_BUILD >= 0x000b
297 if( val.i_int >= -1 && val.i_int <= 100 )
298 p_sys->param.i_scenecut_threshold = val.i_int;
302 var_Get( p_enc, SOUT_CFG_PREFIX "subpel", &val );
303 if( val.i_int >= 1 && val.i_int <= 5 )
304 p_sys->param.analyse.i_subpel_refine = val.i_int;
307 var_Get( p_enc, SOUT_CFG_PREFIX "analyse", &val );
308 if( !strcmp( val.psz_string, "none" ) )
310 p_sys->param.analyse.inter = 0;
312 else if( !strcmp( val.psz_string, "fast" ) )
314 p_sys->param.analyse.inter = X264_ANALYSE_I4x4;
316 else if( !strcmp( val.psz_string, "normal" ) )
318 p_sys->param.analyse.inter =
319 X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16;
321 else if( !strcmp( val.psz_string, "all" ) )
323 #ifndef X264_ANALYSE_BSUB16x16
324 # define X264_ANALYSE_BSUB16x16 0
326 p_sys->param.analyse.inter =
327 X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16 | X264_ANALYSE_PSUB8x8 |
328 X264_ANALYSE_BSUB16x16;
330 if( val.psz_string ) free( val.psz_string );
332 if( p_enc->fmt_in.video.i_aspect > 0 )
334 int64_t i_num, i_den;
335 int i_dst_num, i_dst_den;
337 i_num = p_enc->fmt_in.video.i_aspect *
338 (int64_t)p_enc->fmt_in.video.i_height;
339 i_den = VOUT_ASPECT_FACTOR * p_enc->fmt_in.video.i_width;
340 vlc_reduce( &i_dst_num, &i_dst_den, i_num, i_den, 0 );
342 p_sys->param.vui.i_sar_width = i_dst_num;
343 p_sys->param.vui.i_sar_height = i_dst_den;
345 if( p_enc->fmt_in.video.i_frame_rate_base > 0 )
347 p_sys->param.i_fps_num = p_enc->fmt_in.video.i_frame_rate;
348 p_sys->param.i_fps_den = p_enc->fmt_in.video.i_frame_rate_base;
350 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMX) )
352 p_sys->param.cpu &= ~X264_CPU_MMX;
354 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMXEXT) )
356 p_sys->param.cpu &= ~X264_CPU_MMXEXT;
358 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE) )
360 p_sys->param.cpu &= ~X264_CPU_SSE;
362 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE2) )
364 p_sys->param.cpu &= ~X264_CPU_SSE2;
367 /* Open the encoder */
368 p_sys->h = x264_encoder_open( &p_sys->param );
371 p_sys->i_buffer = 4 * p_enc->fmt_in.video.i_width *
372 p_enc->fmt_in.video.i_height + 1000;
373 p_sys->p_buffer = malloc( p_sys->i_buffer );
375 /* get the globals headers */
376 p_enc->fmt_out.i_extra = 0;
377 p_enc->fmt_out.p_extra = NULL;
380 x264_encoder_headers( p_sys->h, &nal, &i_nal );
381 for( i = 0; i < i_nal; i++ )
383 int i_size = p_sys->i_buffer;
385 x264_nal_encode( p_sys->p_buffer, &i_size, 1, &nal[i] );
387 p_enc->fmt_out.p_extra = realloc( p_enc->fmt_out.p_extra, p_enc->fmt_out.i_extra + i_size );
389 memcpy( p_enc->fmt_out.p_extra + p_enc->fmt_out.i_extra,
390 p_sys->p_buffer, i_size );
392 p_enc->fmt_out.i_extra += i_size;
399 /****************************************************************************
401 ****************************************************************************/
402 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
404 encoder_sys_t *p_sys = p_enc->p_sys;
411 memset( &pic, 0, sizeof( x264_picture_t ) );
412 pic.img.i_csp = X264_CSP_I420;
413 pic.img.i_plane = p_pict->i_planes;
414 for( i = 0; i < p_pict->i_planes; i++ )
416 pic.img.plane[i] = p_pict->p[i].p_pixels;
417 pic.img.i_stride[i] = p_pict->p[i].i_pitch;
420 #if X264_BUILD >= 0x0013
421 x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic, &pic );
423 x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic );
425 for( i = 0, i_out = 0; i < i_nal; i++ )
427 int i_size = p_sys->i_buffer - i_out;
428 x264_nal_encode( p_sys->p_buffer + i_out, &i_size, 1, &nal[i] );
433 p_block = block_New( p_enc, i_out );
434 p_block->i_dts = p_pict->date;
435 p_block->i_pts = p_pict->date;
436 memcpy( p_block->p_buffer, p_sys->p_buffer, i_out );
438 if( pic.i_type == X264_TYPE_IDR || pic.i_type == X264_TYPE_I )
439 p_block->i_flags |= BLOCK_FLAG_TYPE_I;
440 else if( pic.i_type == X264_TYPE_P )
441 p_block->i_flags |= BLOCK_FLAG_TYPE_P;
442 else if( pic.i_type == X264_TYPE_B )
443 p_block->i_flags |= BLOCK_FLAG_TYPE_B;
448 /*****************************************************************************
449 * CloseEncoder: ffmpeg encoder destruction
450 *****************************************************************************/
451 static void Close( vlc_object_t *p_this )
453 encoder_t *p_enc = (encoder_t *)p_this;
454 encoder_sys_t *p_sys = p_enc->p_sys;
456 x264_encoder_close( p_sys->h );
457 free( p_sys->p_buffer );