git.sesse.net Git - vlc/blob - 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 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." )
  68
  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." )
  76
  77 #define BFRAMES_TEXT N_("B frames")
  78 #define BFRAMES_LONGTEXT N_( "Number of consecutive B-Frames between I and " \
  79     "P-frames." )
  80
  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." )
  85
  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." )
  94
  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") };
  99
 100 vlc_module_begin();
 101     set_description( _("h264 video encoder using x264 library"));
 102     set_capability( "encoder", 200 );
 103     set_callbacks( Open, Close );
 104
 105     add_integer( SOUT_CFG_PREFIX "qp", 0, NULL, QP_TEXT, QP_LONGTEXT,
 106                  VLC_FALSE );
 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 );
 114
 115     add_bool( SOUT_CFG_PREFIX "cabac", 1, NULL, CABAC_TEXT, CABAC_LONGTEXT,
 116               VLC_FALSE );
 117
 118     add_bool( SOUT_CFG_PREFIX "loopfilter", 1, NULL, LOOPF_TEXT,
 119               LOOPF_LONGTEXT, VLC_FALSE );
 120
 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 );
 124
 125     add_integer( SOUT_CFG_PREFIX "keyint", 250, NULL, KEYINT_TEXT,
 126                  KEYINT_LONGTEXT, VLC_FALSE );
 127
 128     add_integer( SOUT_CFG_PREFIX "idrint", 2, NULL, IDRINT_TEXT,
 129                  IDRINT_LONGTEXT, VLC_FALSE );
 130
 131     add_integer( SOUT_CFG_PREFIX "bframes", 0, NULL, BFRAMES_TEXT,
 132                  BFRAMES_LONGTEXT, VLC_FALSE );
 133         change_integer_range( 0, 16 );
 134
 135     add_integer( SOUT_CFG_PREFIX "frameref", 1, NULL, FRAMEREF_TEXT,
 136                  FRAMEREF_LONGTEXT, VLC_FALSE );
 137         change_integer_range( 1, 15 );
 138
 139     add_integer( SOUT_CFG_PREFIX "scenecut", 40, NULL, SCENE_TEXT,
 140                  SCENE_LONGTEXT, VLC_FALSE );
 141         change_integer_range( -1, 100 );
 142
 143 vlc_module_end();
 144
 145 /*****************************************************************************
 146  * Local prototypes
 147  *****************************************************************************/
 148 static const char *ppsz_sout_options[] = {
 149     "qp", "qp-max", "qp-max", "cabac", "loopfilter", "analyse",
 150     "keyint", "idrint", "bframes", "frameref", NULL
 151 };
 152
 153 static block_t *Encode( encoder_t *, picture_t * );
 154
 155 struct encoder_sys_t
 156 {
 157     x264_t          *h;
 158     x264_param_t    param;
 159
 160     int             i_buffer;
 161     uint8_t         *p_buffer;
 162 };
 163
 164 /*****************************************************************************
 165  * Open: probe the encoder
 166  *****************************************************************************/
 167 static int  Open ( vlc_object_t *p_this )
 168 {
 169     encoder_t     *p_enc = (encoder_t *)p_this;
 170     encoder_sys_t *p_sys;
 171     vlc_value_t    val;
 172     int i_qmin = 0, i_qmax = 0;
 173
 174     if( p_enc->fmt_out.i_codec != VLC_FOURCC( 'h', '2', '6', '4' ) &&
 175         !p_enc->b_force )
 176     {
 177         return VLC_EGENERIC;
 178     }
 179
 180     if( p_enc->fmt_in.video.i_width % 16 != 0 ||
 181         p_enc->fmt_in.video.i_height % 16!= 0 )
 182     {
 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 );
 186         return VLC_EGENERIC;
 187     }
 188
 189     sout_CfgParse( p_enc, SOUT_CFG_PREFIX, ppsz_sout_options, p_enc->p_cfg );
 190
 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');
 193
 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 ) );
 197
 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;
 201
 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;
 206
 207     var_Get( p_enc, SOUT_CFG_PREFIX "qp", &val );
 208     if( val.i_int >= 1 && val.i_int <= 51 )
 209     {
 210         if( i_qmin > val.i_int ) i_qmin = val.i_int;
 211         if( i_qmax < val.i_int ) i_qmax = val.i_int;
 212
 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;
 217 #else
 218         p_sys->param.i_qp_constant = val.i_int;
 219 #endif
 220     }
 221     else
 222     {
 223         /* No QP -> constant bitrate */
 224 #if X264_BUILD >= 0x000a
 225         p_sys->param.rc.i_bitrate = p_enc->fmt_out.i_bitrate / 1000;
 226         p_sys->param.rc.i_rc_buffer_size = p_sys->param.rc.i_bitrate;
 227         p_sys->param.rc.i_rc_init_buffer = p_sys->param.rc.i_bitrate / 4;
 228 #endif
 229     }
 230
 231     var_Get( p_enc, SOUT_CFG_PREFIX "cabac", &val );
 232     p_sys->param.b_cabac = val.b_bool;
 233
 234     var_Get( p_enc, SOUT_CFG_PREFIX "loopfilter", &val );
 235     p_sys->param.b_deblocking_filter = val.b_bool;
 236
 237     var_Get( p_enc, SOUT_CFG_PREFIX "keyint", &val );
 238     if( val.i_int > 0 ) p_sys->param.i_iframe = val.i_int;
 239
 240     var_Get( p_enc, SOUT_CFG_PREFIX "idrint", &val );
 241     if( val.i_int > 0 ) p_sys->param.i_idrframe = val.i_int;
 242
 243     var_Get( p_enc, SOUT_CFG_PREFIX "bframes", &val );
 244     if( val.i_int >= 0 && val.i_int <= 16 ) p_sys->param.i_bframe = val.i_int;
 245
 246     var_Get( p_enc, SOUT_CFG_PREFIX "frameref", &val );
 247     if( val.i_int > 0 && val.i_int <= 15 )
 248         p_sys->param.i_frame_reference = val.i_int;
 249
 250     var_Get( p_enc, SOUT_CFG_PREFIX "scenecut", &val );
 251     if( val.i_int >= -1 && val.i_int <= 100 )
 252         p_sys->param.i_scenecut_threshold = val.i_int;
 253
 254     var_Get( p_enc, SOUT_CFG_PREFIX "analyse", &val );
 255     if( !strcmp( val.psz_string, "none" ) )
 256     {
 257         p_sys->param.analyse.inter = 0;
 258     }
 259     else if( !strcmp( val.psz_string, "fast" ) )
 260     {
 261         p_sys->param.analyse.inter = X264_ANALYSE_I4x4;
 262     }
 263     else if( !strcmp( val.psz_string, "normal" ) )
 264     {
 265         p_sys->param.analyse.inter =
 266             X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16;
 267     }
 268     else if( !strcmp( val.psz_string, "all" ) )
 269     {
 270         p_sys->param.analyse.inter =
 271             X264_ANALYSE_I4x4 | X264_ANALYSE_PSUB16x16 | X264_ANALYSE_PSUB8x8;
 272     }
 273
 274     if( p_enc->fmt_in.video.i_aspect > 0 )
 275     {
 276         int64_t i_num, i_den;
 277         int i_dst_num, i_dst_den;
 278
 279         i_num = p_enc->fmt_in.video.i_aspect *
 280             (int64_t)p_enc->fmt_in.video.i_height;
 281         i_den = VOUT_ASPECT_FACTOR * p_enc->fmt_in.video.i_width;
 282         vlc_reduce( &i_dst_num, &i_dst_den, i_num, i_den, 0 );
 283
 284         p_sys->param.vui.i_sar_width = i_dst_num;
 285         p_sys->param.vui.i_sar_height = i_dst_den;
 286     }
 287     if( p_enc->fmt_in.video.i_frame_rate_base > 0 )
 288     {
 289         p_sys->param.i_fps_num = p_enc->fmt_in.video.i_frame_rate;
 290         p_sys->param.i_fps_den = p_enc->fmt_in.video.i_frame_rate_base;
 291     }
 292     if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMX) )
 293     {
 294         p_sys->param.cpu &= ~X264_CPU_MMX;
 295     }
 296     if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_MMXEXT) )
 297     {
 298         p_sys->param.cpu &= ~X264_CPU_MMXEXT;
 299     }
 300     if( !(p_enc->p_libvlc->i_cpu & CPU_CAPABILITY_SSE) )
 301     {
 302         p_sys->param.cpu &= ~(X264_CPU_SSE|X264_CPU_SSE2);
 303     }
 304
 305     /* Open the encoder */
 306     p_sys->h = x264_encoder_open( &p_sys->param );
 307
 308     /* alloc mem */
 309     p_sys->i_buffer = 4 * p_enc->fmt_in.video.i_width *
 310         p_enc->fmt_in.video.i_height + 1000;
 311     p_sys->p_buffer = malloc( p_sys->i_buffer );
 312
 313     /* get the globals headers */
 314     p_enc->fmt_out.i_extra = 0;
 315     p_enc->fmt_out.p_extra = NULL;
 316
 317 #if 0
 318     x264_encoder_headers( p_sys->h, &nal, &i_nal );
 319     for( i = 0; i < i_nal; i++ )
 320     {
 321         int i_size = p_sys->i_buffer;
 322
 323         x264_nal_encode( p_sys->p_buffer, &i_size, 1, &nal[i] );
 324
 325         p_enc->fmt_out.p_extra = realloc( p_enc->fmt_out.p_extra, p_enc->fmt_out.i_extra + i_size );
 326
 327         memcpy( p_enc->fmt_out.p_extra + p_enc->fmt_out.i_extra,
 328                 p_sys->p_buffer, i_size );
 329
 330         p_enc->fmt_out.i_extra += i_size;
 331     }
 332 #endif
 333
 334     return VLC_SUCCESS;
 335 }
 336
 337 /****************************************************************************
 338  * Encode:
 339  ****************************************************************************/
 340 static block_t *Encode( encoder_t *p_enc, picture_t *p_pict )
 341 {
 342     encoder_sys_t *p_sys = p_enc->p_sys;
 343     x264_picture_t  pic;
 344     int        i_nal;
 345     x264_nal_t *nal;
 346     block_t *p_block;
 347     int i_out;
 348     int i;
 349
 350     /* init pic */
 351     memset( &pic, 0, sizeof( x264_picture_t ) );
 352     pic.img.i_csp = X264_CSP_I420;
 353     pic.img.i_plane = p_pict->i_planes;
 354     for( i = 0; i < p_pict->i_planes; i++ )
 355     {
 356         pic.img.plane[i] = p_pict->p[i].p_pixels;
 357         pic.img.i_stride[i] = p_pict->p[i].i_pitch;
 358     }
 359
 360     x264_encoder_encode( p_sys->h, &nal, &i_nal, &pic );
 361     for( i = 0, i_out = 0; i < i_nal; i++ )
 362     {
 363         int i_size = p_sys->i_buffer - i_out;
 364         x264_nal_encode( p_sys->p_buffer + i_out, &i_size, 1, &nal[i] );
 365
 366         i_out += i_size;
 367     }
 368
 369     p_block = block_New( p_enc, i_out );
 370     p_block->i_dts = p_pict->date;
 371     p_block->i_pts = p_pict->date;
 372     memcpy( p_block->p_buffer, p_sys->p_buffer, i_out );
 373
 374     if( pic.i_type == X264_TYPE_IDR || pic.i_type == X264_TYPE_I )
 375         p_block->i_flags |= BLOCK_FLAG_TYPE_I;
 376     else if( pic.i_type == X264_TYPE_P )
 377         p_block->i_flags |= BLOCK_FLAG_TYPE_P;
 378     else if( pic.i_type == X264_TYPE_B )
 379         p_block->i_flags |= BLOCK_FLAG_TYPE_B;
 380
 381     return p_block;
 382 }
 383
 384 /*****************************************************************************
 385  * CloseEncoder: ffmpeg encoder destruction
 386  *****************************************************************************/
 387 static void Close( vlc_object_t *p_this )
 388 {
 389     encoder_t     *p_enc = (encoder_t *)p_this;
 390     encoder_sys_t *p_sys = p_enc->p_sys;
 391
 392     x264_encoder_close( p_sys->h );
 393     free( p_sys->p_buffer );
 394     free( p_sys );
 395 }