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 I frames")
66 #define KEYINT_LONGTEXT N_( "Larger values save bits, thus improve quality, " \
67 "at the cost of seeking precision." )
69 #define IDRINT_TEXT N_("IDR frames")
70 #define IDRINT_LONGTEXT N_("In H.264, I-Frames do not necessarily bound a " \
71 "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." )
77 #define BFRAMES_TEXT N_("B frames")
78 #define BFRAMES_LONGTEXT N_( "Number of consecutive B-Frames between I and " \
81 #define FRAMEREF_TEXT N_("Number of previous frames used as predictors.")
82 #define FRAMEREF_LONGTEXT N_( "This is effective in Anime, but seems to " \
83 "make little difference in live-action source material. Some decoders " \
84 "are unable to deal with large frameref values." )
86 #define SCENE_TEXT N_("Scene-cut detection.")
87 #define SCENE_LONGTEXT N_( "Controls how aggressively to insert extra " \
88 "I-frames. With small values of scenecut, the codec often has to force " \
89 "an I-frame when it would exceed keyint. " \
90 "Good values of scenecut may find a better location for the I-frame. " \
91 "Large values use more I-frames than necessary, thus wasting bits. " \
92 "-1 disables scene-cut detection, so I-frames are be inserted only every "\
93 "other keyint frames, which probably leads to ugly encoding artifacts." )
95 static char *enc_analyse_list[] =
96 { "", "all", "normal", "fast", "none" };
97 static char *enc_analyse_list_text[] =
98 { N_("default"), N_("all"), N_("normal"), N_("fast"), N_("none") };
101 set_description( _("h264 video encoder using x264 library"));
102 set_capability( "encoder", 200 );
103 set_callbacks( Open, Close );
105 add_integer( SOUT_CFG_PREFIX "qp", 0, NULL, QP_TEXT, QP_LONGTEXT,
107 change_integer_range( 0, 51 );
108 add_integer( SOUT_CFG_PREFIX "qp-min", 10, NULL, QPMIN_TEXT,
109 QPMIN_LONGTEXT, VLC_FALSE );
110 change_integer_range( 0, 51 );
111 add_integer( SOUT_CFG_PREFIX "qp-max", 51, NULL, QPMAX_TEXT,
112 QPMAX_LONGTEXT, VLC_FALSE );
113 change_integer_range( 0, 51 );
115 add_bool( SOUT_CFG_PREFIX "cabac", 1, NULL, CABAC_TEXT, CABAC_LONGTEXT,
118 add_bool( SOUT_CFG_PREFIX "loopfilter", 1, NULL, LOOPF_TEXT,
119 LOOPF_LONGTEXT, VLC_FALSE );
121 add_string( SOUT_CFG_PREFIX "analyse", "", NULL, ANALYSE_TEXT,
122 ANALYSE_LONGTEXT, VLC_FALSE );
123 change_string_list( enc_analyse_list, enc_analyse_list_text, 0 );
125 add_integer( SOUT_CFG_PREFIX "keyint", 250, NULL, KEYINT_TEXT,
126 KEYINT_LONGTEXT, VLC_FALSE );
128 add_integer( SOUT_CFG_PREFIX "idrint", 2, NULL, IDRINT_TEXT,
129 IDRINT_LONGTEXT, VLC_FALSE );
131 add_integer( SOUT_CFG_PREFIX "bframes", 0, NULL, BFRAMES_TEXT,
132 BFRAMES_LONGTEXT, VLC_FALSE );
133 change_integer_range( 0, 16 );
135 add_integer( SOUT_CFG_PREFIX "frameref", 1, NULL, FRAMEREF_TEXT,
136 FRAMEREF_LONGTEXT, VLC_FALSE );
137 change_integer_range( 1, 15 );
139 add_integer( SOUT_CFG_PREFIX "scenecut", 40, NULL, SCENE_TEXT,
140 SCENE_LONGTEXT, VLC_FALSE );
141 change_integer_range( -1, 100 );
145 /*****************************************************************************
147 *****************************************************************************/
148 static const char *ppsz_sout_options[] = {
149 "qp", "qp-min", "qp-max", "cabac", "loopfilter", "analyse",
150 "keyint", "idrint", "bframes", "frameref", "scenecut", NULL
153 static block_t *Encode( encoder_t *, picture_t * );
164 /*****************************************************************************
165 * Open: probe the encoder
166 *****************************************************************************/
167 static int Open ( vlc_object_t *p_this )
169 encoder_t *p_enc = (encoder_t *)p_this;
170 encoder_sys_t *p_sys;
172 int i_qmin = 0, i_qmax = 0;
174 if( p_enc->fmt_out.i_codec != VLC_FOURCC( 'h', '2', '6', '4' ) &&
180 if( p_enc->fmt_in.video.i_width % 16 != 0 ||
181 p_enc->fmt_in.video.i_height % 16!= 0 )
183 msg_Warn( p_enc, "invalid size %ix%i",
184 p_enc->fmt_in.video.i_width,
185 p_enc->fmt_in.video.i_height );
189 sout_CfgParse( p_enc, SOUT_CFG_PREFIX, ppsz_sout_options, p_enc->p_cfg );
191 p_enc->fmt_out.i_codec = VLC_FOURCC( 'h', '2', '6', '4' );
192 p_enc->fmt_in.i_codec = VLC_FOURCC('I','4','2','0');
194 p_enc->pf_encode_video = Encode;
195 p_enc->pf_encode_audio = NULL;
196 p_enc->p_sys = p_sys = malloc( sizeof( encoder_sys_t ) );
198 x264_param_default( &p_sys->param );
199 p_sys->param.i_width = p_enc->fmt_in.video.i_width;
200 p_sys->param.i_height = p_enc->fmt_in.video.i_height;
202 var_Get( p_enc, SOUT_CFG_PREFIX "qp-min", &val );
203 if( val.i_int >= 1 && val.i_int <= 51 ) i_qmin = val.i_int;
204 var_Get( p_enc, SOUT_CFG_PREFIX "qp-max", &val );
205 if( val.i_int >= 1 && val.i_int <= 51 ) i_qmax = val.i_int;
207 var_Get( p_enc, SOUT_CFG_PREFIX "qp", &val );
208 if( val.i_int >= 1 && val.i_int <= 51 )
210 if( i_qmin > val.i_int ) i_qmin = val.i_int;
211 if( i_qmax < val.i_int ) i_qmax = val.i_int;
213 #if X264_BUILD >= 0x000a
214 p_sys->param.rc.i_qp_constant = val.i_int;
215 p_sys->param.rc.i_qp_min = i_qmin;
216 p_sys->param.rc.i_qp_max = i_qmax;
218 p_sys->param.i_qp_constant = val.i_int;
223 /* No QP -> constant bitrate */
224 #if X264_BUILD >= 0x000a
225 p_sys->param.rc.b_cbr = 1;
226 p_sys->param.rc.i_bitrate = p_enc->fmt_out.i_bitrate / 1000;
227 p_sys->param.rc.i_rc_buffer_size = p_sys->param.rc.i_bitrate;
228 p_sys->param.rc.i_rc_init_buffer = p_sys->param.rc.i_bitrate / 4;
232 var_Get( p_enc, SOUT_CFG_PREFIX "cabac", &val );
233 p_sys->param.b_cabac = val.b_bool;
235 var_Get( p_enc, SOUT_CFG_PREFIX "loopfilter", &val );
236 p_sys->param.b_deblocking_filter = val.b_bool;
238 var_Get( p_enc, SOUT_CFG_PREFIX "keyint", &val );
239 if( val.i_int > 0 ) p_sys->param.i_iframe = val.i_int;
241 var_Get( p_enc, SOUT_CFG_PREFIX "idrint", &val );
242 if( val.i_int > 0 ) p_sys->param.i_idrframe = val.i_int;
244 var_Get( p_enc, SOUT_CFG_PREFIX "bframes", &val );
245 if( val.i_int >= 0 && val.i_int <= 16 ) p_sys->param.i_bframe = val.i_int;
247 var_Get( p_enc, SOUT_CFG_PREFIX "frameref", &val );
248 if( val.i_int > 0 && val.i_int <= 15 )
249 p_sys->param.i_frame_reference = val.i_int;
251 var_Get( p_enc, SOUT_CFG_PREFIX "scenecut", &val );
252 #if X264_BUILD >= 0x000b
253 if( val.i_int >= -1 && val.i_int <= 100 )
254 p_sys->param.i_scenecut_threshold = val.i_int;
257 var_Get( p_enc, SOUT_CFG_PREFIX "analyse", &val );
258 if( !strcmp( val.psz_string, "none" ) )
260 p_sys->param.analyse.inter = 0;
262 else if( !strcmp( val.psz_string, "fast" ) )
264 p_sys->param.analyse.inter = X264_ANALYSE_I4x4;
266 else if( !strcmp( val.psz_string, "normal" ) )
268 p_sys->param.analyse.inter =
269 X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16;
271 else if( !strcmp( val.psz_string, "all" ) )
273 p_sys->param.analyse.inter =
274 X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16 | X264_ANALYSE_PSUB8x8;
277 if( p_enc->fmt_in.video.i_aspect > 0 )
279 int64_t i_num, i_den;
280 int i_dst_num, i_dst_den;
282 i_num = p_enc->fmt_in.video.i_aspect *
283 (int64_t)p_enc->fmt_in.video.i_height;
284 i_den = VOUT_ASPECT_FACTOR * p_enc->fmt_in.video.i_width;
285 vlc_reduce( &i_dst_num, &i_dst_den, i_num, i_den, 0 );
287 p_sys->param.vui.i_sar_width = i_dst_num;
288 p_sys->param.vui.i_sar_height = i_dst_den;
290 if( p_enc->fmt_in.video.i_frame_rate_base > 0 )
292 p_sys->param.i_fps_num = p_enc->fmt_in.video.i_frame_rate;
293 p_sys->param.i_fps_den = p_enc->fmt_in.video.i_frame_rate_base;
295 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMX) )
297 p_sys->param.cpu &= ~X264_CPU_MMX;
299 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMXEXT) )
301 p_sys->param.cpu &= ~X264_CPU_MMXEXT;
303 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE) )
305 p_sys->param.cpu &= ~X264_CPU_SSE;
307 if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE2) )
309 p_sys->param.cpu &= ~X264_CPU_SSE2;
312 /* Open the encoder */
313 p_sys->h = x264_encoder_open( &p_sys->param );
316 p_sys->i_buffer = 4 * p_enc->fmt_in.video.i_width *
317 p_enc->fmt_in.video.i_height + 1000;
318 p_sys->p_buffer = malloc( p_sys->i_buffer );
320 /* get the globals headers */
321 p_enc->fmt_out.i_extra = 0;
322 p_enc->fmt_out.p_extra = NULL;
325 x264_encoder_headers( p_sys->h, &nal, &i_nal );
326 for( i = 0; i < i_nal; i++ )
328 int i_size = p_sys->i_buffer;
330 x264_nal_encode( p_sys->p_buffer, &i_size, 1, &nal[i] );
332 p_enc->fmt_out.p_extra = realloc( p_enc->fmt_out.p_extra, p_enc->fmt_out.i_extra + i_size );
334 memcpy( p_enc->fmt_out.p_extra + p_enc->fmt_out.i_extra,
335 p_sys->p_buffer, i_size );
337 p_enc->fmt_out.i_extra += i_size;
344 /****************************************************************************
346 ****************************************************************************/
347 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
349 encoder_sys_t *p_sys = p_enc->p_sys;
358 memset( &pic, 0, sizeof( x264_picture_t ) );
359 pic.img.i_csp = X264_CSP_I420;
360 pic.img.i_plane = p_pict->i_planes;
361 for( i = 0; i < p_pict->i_planes; i++ )
363 pic.img.plane[i] = p_pict->p[i].p_pixels;
364 pic.img.i_stride[i] = p_pict->p[i].i_pitch;
367 x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic );
368 for( i = 0, i_out = 0; i < i_nal; i++ )
370 int i_size = p_sys->i_buffer - i_out;
371 x264_nal_encode( p_sys->p_buffer + i_out, &i_size, 1, &nal[i] );
376 p_block = block_New( p_enc, i_out );
377 p_block->i_dts = p_pict->date;
378 p_block->i_pts = p_pict->date;
379 memcpy( p_block->p_buffer, p_sys->p_buffer, i_out );
381 if( pic.i_type == X264_TYPE_IDR || pic.i_type == X264_TYPE_I )
382 p_block->i_flags |= BLOCK_FLAG_TYPE_I;
383 else if( pic.i_type == X264_TYPE_P )
384 p_block->i_flags |= BLOCK_FLAG_TYPE_P;
385 else if( pic.i_type == X264_TYPE_B )
386 p_block->i_flags |= BLOCK_FLAG_TYPE_B;
391 /*****************************************************************************
392 * CloseEncoder: ffmpeg encoder destruction
393 *****************************************************************************/
394 static void Close( vlc_object_t *p_this )
396 encoder_t *p_enc = (encoder_t *)p_this;
397 encoder_sys_t *p_sys = p_enc->p_sys;
399 x264_encoder_close( p_sys->h );
400 free( p_sys->p_buffer );