/*****************************************************************************
* Help:
*****************************************************************************/
static void Help( x264_param_t *defaults, int b_longhelp )
{
#define H0 printf
#define H1 if(b_longhelp) printf
H0( "x264 core:%d%s\n"
"Syntax: x264 [options] -o outfile infile [widthxheight]\n"
"\n"
"Infile can be raw YUV 4:2:0 (in which case resolution is required),\n"
" or YUV4MPEG 4:2:0 (*.y4m),\n"
" or AVI or Avisynth if compiled with AVIS support (%s).\n"
"Outfile type is selected by filename:\n"
" .264 -> Raw bytestream\n"
" .mkv -> Matroska\n"
" .mp4 -> MP4 if compiled with GPAC support (%s)\n"
"\n"
"Options:\n"
"\n"
" -h, --help List the more commonly used options\n"
" --longhelp List all options\n"
"\n",
X264_BUILD, X264_VERSION,
#ifdef AVIS_INPUT
"yes",
#else
"no",
#endif
#ifdef MP4_OUTPUT
"yes"
#else
"no"
#endif
);
H0( "Frame-type options:\n" );
H0( "\n" );
H0( " -I, --keyint <integer> Maximum GOP size [%d]\n", defaults->i_keyint_max );
H1( " -i, --min-keyint <integer> Minimum GOP size [%d]\n", defaults->i_keyint_min );
H1( " --scenecut <integer> How aggressively to insert extra I-frames [%d]\n", defaults->i_scenecut_threshold );
H1( " --pre-scenecut Faster, less precise scenecut detection.\n"
" Required and implied by multi-threading.\n" );
H0( " -b, --bframes <integer> Number of B-frames between I and P [%d]\n", defaults->i_bframe );
H1( " --b-adapt Adaptive B-frame decision method [%d]\n"
" Higher values may lower threading efficiency.\n"
" - 0: Disabled\n"
" - 1: Fast\n"
" - 2: Optimal (slow with high --bframes)\n", defaults->i_bframe_adaptive );
H1( " --b-bias <integer> Influences how often B-frames are used [%d]\n", defaults->i_bframe_bias );
H0( " --b-pyramid Keep some B-frames as references\n" );
H0( " --no-cabac Disable CABAC\n" );
H0( " -r, --ref <integer> Number of reference frames [%d]\n", defaults->i_frame_reference );
H1( " --no-deblock Disable loop filter\n" );
H0( " -f, --deblock <alpha:beta> Loop filter AlphaC0 and Beta parameters [%d:%d]\n",
defaults->i_deblocking_filter_alphac0, defaults->i_deblocking_filter_beta );
H0( " --interlaced Enable pure-interlaced mode\n" );
H0( "\n" );
H0( "Ratecontrol:\n" );
H0( "\n" );
H0( " -q, --qp <integer> Set QP (0=lossless) [%d]\n", defaults->rc.i_qp_constant );
H0( " -B, --bitrate <integer> Set bitrate (kbit/s)\n" );
H0( " --crf <float> Quality-based VBR (nominal QP)\n" );
H1( " --vbv-maxrate <integer> Max local bitrate (kbit/s) [%d]\n", defaults->rc.i_vbv_max_bitrate );
H0( " --vbv-bufsize <integer> Enable CBR and set size of the VBV buffer (kbit) [%d]\n", defaults->rc.i_vbv_buffer_size );
H1( " --vbv-init <float> Initial VBV buffer occupancy [%.1f]\n", defaults->rc.f_vbv_buffer_init );
H1( " --qpmin <integer> Set min QP [%d]\n", defaults->rc.i_qp_min );
H1( " --qpmax <integer> Set max QP [%d]\n", defaults->rc.i_qp_max );
H1( " --qpstep <integer> Set max QP step [%d]\n", defaults->rc.i_qp_step );
H0( " --ratetol <float> Allowed variance of average bitrate [%.1f]\n", defaults->rc.f_rate_tolerance );
H0( " --ipratio <float> QP factor between I and P [%.2f]\n", defaults->rc.f_ip_factor );
H0( " --pbratio <float> QP factor between P and B [%.2f]\n", defaults->rc.f_pb_factor );
H1( " --chroma-qp-offset <integer> QP difference between chroma and luma [%d]\n", defaults->analyse.i_chroma_qp_offset );
H1( " --aq-mode <integer> AQ method [%d]\n"
" - 0: Disabled\n"
" - 1: Variance AQ (complexity mask)\n", defaults->rc.i_aq_mode );
H0( " --aq-strength <float> Reduces blocking and blurring in flat and\n"
" textured areas. [%.1f]\n"
" - 0.5: weak AQ\n"
" - 1.5: strong AQ\n", defaults->rc.f_aq_strength );
H0( "\n" );
H0( " -p, --pass <1|2|3> Enable multipass ratecontrol\n"
" - 1: First pass, creates stats file\n"
" - 2: Last pass, does not overwrite stats file\n"
" - 3: Nth pass, overwrites stats file\n" );
H0( " --stats <string> Filename for 2 pass stats [\"%s\"]\n", defaults->rc.psz_stat_out );
H0( " --qcomp <float> QP curve compression: 0.0 => CBR, 1.0 => CQP [%.2f]\n", defaults->rc.f_qcompress );
H1( " --cplxblur <float> Reduce fluctuations in QP (before curve compression) [%.1f]\n", defaults->rc.f_complexity_blur );
H1( " --qblur <float> Reduce fluctuations in QP (after curve compression) [%.1f]\n", defaults->rc.f_qblur );
H0( " --zones <zone0>/<zone1>/... Tweak the bitrate of some regions of the video\n" );
H1( " Each zone is of the form\n"
" <start frame>,<end frame>,<option>\n"
" where <option> is either\n"
" q=<integer> (force QP)\n"
" or b=<float> (bitrate multiplier)\n" );
H1( " --qpfile <string> Force frametypes and QPs for some or all frames\n"
" Format of each line: framenumber frametype QP\n"
" QP of -1 lets x264 choose. Frametypes: I,i,P,B,b.\n" );
H0( "\n" );
H0( "Analysis:\n" );
H0( "\n" );
H0( " -A, --partitions <string> Partitions to consider [\"p8x8,b8x8,i8x8,i4x4\"]\n"
" - p8x8, p4x4, b8x8, i8x8, i4x4\n"
" - none, all\n"
" (p4x4 requires p8x8. i8x8 requires --8x8dct.)\n" );
H0( " --direct <string> Direct MV prediction mode [\"%s\"]\n"
" - none, spatial, temporal, auto\n",
strtable_lookup( x264_direct_pred_names, defaults->analyse.i_direct_mv_pred ) );
H0( " -w, --weightb Weighted prediction for B-frames\n" );
H0( " --me <string> Integer pixel motion estimation method [\"%s\"]\n",
strtable_lookup( x264_motion_est_names, defaults->analyse.i_me_method ) );
H1( " - dia: diamond search, radius 1 (fast)\n"
" - hex: hexagonal search, radius 2\n"
" - umh: uneven multi-hexagon search\n"
" - esa: exhaustive search\n"
" - tesa: hadamard exhaustive search (slow)\n" );
else H0( " - dia, hex, umh\n" );
/*****************************************************************************
* Help:
*****************************************************************************/
static void Help( x264_param_t *defaults )
{
fprintf( stderr,
"x264 core:%d%s\n"
"Syntax: x264 [options] -o outfile infile [widthxheight]\n"
"\n"
"Infile can be raw YUV 4:2:0 (in which case resolution is required),\n"
" or YUV4MPEG 4:2:0 (*.y4m),\n"
" or AVI or Avisynth if compiled with AVIS support (%s).\n"
"Outfile type is selected by filename:\n"
" .264 -> Raw bytestream\n"
" .mkv -> Matroska\n"
" .mp4 -> MP4 if compiled with GPAC support (%s)\n"
"\n"
"Options:\n"
"\n"
" -h, --help Print this help\n"
"\n"
"Frame-type options:\n"
"\n"
" -I, --keyint <integer> Maximum GOP size [%d]\n"
" -i, --min-keyint <integer> Minimum GOP size [%d]\n"
" --scenecut <integer> How aggressively to insert extra I-frames [%d]\n"
" -b, --bframes <integer> Number of B-frames between I and P [%d]\n"
" --no-b-adapt Disable adaptive B-frame decision\n"
" --b-bias <integer> Influences how often B-frames are used [%d]\n"
" --b-pyramid Keep some B-frames as references\n"
"\n"
" --no-cabac Disable CABAC\n"
" -r, --ref <integer> Number of reference frames [%d]\n"
" --nf Disable loop filter\n"
" -f, --filter <alpha:beta> Loop filter AlphaC0 and Beta parameters [%d:%d]\n"
"\n"
"Ratecontrol:\n"
"\n"
" -q, --qp <integer> Set QP (0=lossless) [%d]\n"
" -B, --bitrate <integer> Set bitrate\n"
" --crf <integer> Quality-based VBR (nominal QP)\n"
" --qpmin <integer> Set min QP [%d]\n"
" --qpmax <integer> Set max QP [%d]\n"
" --qpstep <integer> Set max QP step [%d]\n"
" --ratetol <float> Allowed variance of average bitrate [%.1f]\n"
" --vbv-maxrate <integer> Max local bitrate [%d]\n"
" --vbv-bufsize <integer> Size of VBV buffer [%d]\n"
" --vbv-init <float> Initial VBV buffer occupancy [%.1f]\n"
"\n"
" --ipratio <float> QP factor between I and P [%.2f]\n"
" --pbratio <float> QP factor between P and B [%.2f]\n"
" --chroma-qp-offset <integer> QP difference between chroma and luma [%d]\n"
"\n"
" -p, --pass <1|2|3> Enable multipass ratecontrol:\n"
" - 1: First pass, creates stats file\n"
" - 2: Last pass, does not overwrite stats file\n"
" - 3: Nth pass, overwrites stats file\n"
" --stats <string> Filename for 2 pass stats [\"%s\"]\n"
" --rceq <string> Ratecontrol equation [\"%s\"]\n"
" --qcomp <float> QP curve compression: 0.0 => CBR, 1.0 => CQP [%.2f]\n"
" --cplxblur <float> Reduce fluctuations in QP (before curve compression) [%.1f]\n"
" --qblur <float> Reduce fluctuations in QP (after curve compression) [%.1f]\n"
"\n"
" --zones <zone0>/<zone1>/...\n"
" Tweak the bitrate of some regions of the video\n"
" Each zone is of the form\n"
" <start frame>,<end frame>,<option>\n"
" where <option> is either\n"
" q=<integer> (force QP)\n"
" or b=<float> (bitrate multiplier)\n"
" --qpfile <string> Force frametypes and QPs\n"
"\n"
"Analysis:\n"
"\n"
" -A, --analyse <string> Partitions to consider [\"p8x8,b8x8,i8x8,i4x4\"]\n"
" - p8x8, p4x4, b8x8, i8x8, i4x4\n"
" - none, all\n"
" (p4x4 requires p8x8. i8x8 requires --8x8dct.)\n"
" --direct <string> Direct MV prediction mode [\"%s\"]\n"
" - none, spatial, temporal, auto\n"
" -w, --weightb Weighted prediction for B-frames\n"
" --me <string> Integer pixel motion estimation method [\"%s\"]\n"
" - dia: diamond search, radius 1 (fast)\n"
" - hex: hexagonal search, radius 2\n"
" - umh: uneven multi-hexagon search\n"
" - esa: exhaustive search (slow)\n"
" --merange <integer> Maximum motion vector search range [%d]\n"
" -m, --subme <integer> Subpixel motion estimation and partition\n"
" decision quality: 1=fast, 7=best. [%d]\n"
" --b-rdo RD based mode decision for B-frames. Requires subme 6.\n"
" --mixed-refs Decide references on a per partition basis\n"
" --no-chroma-me Ignore chroma in motion estimation\n"
" --bime Jointly optimize both MVs in B-frames\n"
" -8, --8x8dct Adaptive spatial transform size\n"
" -t, --trellis <integer> Trellis RD quantization. Requires CABAC. [%d]\n"
" - 0: disabled\n"
" - 1: enabled only on the final encode of a MB\n"
" - 2: enabled on all mode decisions\n"
" --no-fast-pskip Disables early SKIP detection on P-frames\n"
" --no-dct-decimate Disables coefficient thresholding on P-frames\n"
" --nr <integer> Noise reduction [%d]\n"
"\n"
" --cqm <string> Preset quant matrices [\"flat\"]\n"
" - jvt, flat\n"
" --cqmfile <string> Read quant matrices from a JM-compatible file\n"
" Overrides any other --cqm* options.\n"
" --cqm4 <list> Set all 4x4 quant matrices\n"
" Takes a comma-separated list of 16 integers.\n"
" --cqm8 <list> Set all 8x8 quant matrices\n"
" Takes a comma-separated list of 64 integers.\n"
" --cqm4i, --cqm4p, --cqm8i, --cqm8p\n"
" Set both luma and chroma quant matrices\n"
" --cqm4iy, --cqm4ic, --cqm4py, --cqm4pc\n"
" Set individual quant matrices\n"
"\n"
"Video Usability Info (Annex E):\n"
"The VUI settings are not used by the encoder but are merely suggestions to\n"
"the playback equipment. See doc/vui.txt for details. Use at your own risk.\n"
"\n"
" --sar width:height Specify Sample Aspect Ratio\n"
" --overscan <string> Specify crop overscan setting [\"%s\"]\n"
" - undef, show, crop\n"
" --videoformat <string> Specify video format [\"%s\"]\n"
" - component, pal, ntsc, secam, mac, undef\n"
" --fullrange <string> Specify full range samples setting [\"%s\"]\n"
" - off, on\n"
" --colorprim <string> Specify color primaries [\"%s\"]\n"
" - undef, bt709, bt470m, bt470bg\n"
" smpte170m, smpte240m, film\n"
" --transfer <string> Specify transfer characteristics [\"%s\"]\n"
" - undef, bt709, bt470m, bt470bg, linear,\n"
" log100, log316, smpte170m, smpte240m\n"
" --colormatrix <string> Specify color matrix setting [\"%s\"]\n"
" - undef, bt709, fcc, bt470bg\n"
" smpte170m, smpte240m, GBR, YCgCo\n"
" --chromaloc <integer> Specify chroma sample location (0 to 5) [%d]\n"
"\n"
"Input/Output:\n"
"\n"
" --level <string> Specify level (as defined by Annex A)\n"
" --fps <float|rational> Specify framerate\n"
" --seek <integer> First frame to encode\n"
" --frames <integer> Maximum number of frames to encode\n"
" -o, --output Specify output file\n"
"\n"
" --threads <integer> Parallel encoding (uses slices)\n"
" --thread-input Run Avisynth in its own thread\n"
" --no-asm Disable all CPU optimizations\n"
" --no-psnr Disable PSNR computation\n"
" --quiet Quiet Mode\n"
" -v, --verbose Print stats for each frame\n"
" --progress Show a progress indicator while encoding\n"
" --visualize Show MB types overlayed on the encoded video\n"
" --sps-id <integer> Set SPS and PPS id numbers [%d]\n"
" --aud Use access unit delimiters\n"
"\n",
X264_BUILD, X264_VERSION,
#ifdef AVIS_INPUT
"yes",
#else
"no",
#endif
#ifdef MP4_OUTPUT
"yes",
#else
"no",
#endif
defaults->i_keyint_max,
defaults->i_keyint_min,
defaults->i_scenecut_threshold,
defaults->i_bframe,
defaults->i_bframe_bias,
defaults->i_frame_reference,
defaults->i_deblocking_filter_alphac0,
defaults->i_deblocking_filter_beta,
defaults->rc.i_qp_constant,
defaults->rc.i_qp_min,
defaults->rc.i_qp_max,
defaults->rc.i_qp_step,
defaults->rc.f_rate_tolerance,
defaults->rc.i_vbv_max_bitrate,
defaults->rc.i_vbv_buffer_size,
defaults->rc.f_vbv_buffer_init,
defaults->rc.f_ip_factor,
defaults->rc.f_pb_factor,
defaults->analyse.i_chroma_qp_offset,
defaults->rc.psz_stat_out,
defaults->rc.psz_rc_eq,
defaults->rc.f_qcompress,
defaults->rc.f_complexity_blur,
defaults->rc.f_qblur,
strtable_lookup( x264_direct_pred_names, defaults->analyse.i_direct_mv_pred ),
strtable_lookup( x264_motion_est_names, defaults->analyse.i_me_method ),
defaults->analyse.i_me_range,
defaults->analyse.i_subpel_refine,
defaults->analyse.i_trellis,
defaults->analyse.i_noise_reduction,
strtable_lookup( overscan_str, defaults->vui.i_overscan ),
strtable_lookup( vidformat_str, defaults->vui.i_vidformat ),
strtable_lookup( fullrange_str, defaults->vui.b_fullrange ),
strtable_lookup( colorprim_str, defaults->vui.i_colorprim ),
strtable_lookup( transfer_str, defaults->vui.i_transfer ),
strtable_lookup( colmatrix_str, defaults->vui.i_colmatrix ),
defaults->vui.i_chroma_loc,
defaults->i_sps_id
);
}
H1( " --cqm4 <list> Set all 4x4 quant matrices\n"
" Takes a comma-separated list of 16 integers.\n" );
H1( " --cqm8 <list> Set all 8x8 quant matrices\n"
" Takes a comma-separated list of 64 integers.\n" );
H1( " --cqm4i, --cqm4p, --cqm8i, --cqm8p\n"
" Set both luma and chroma quant matrices\n" );
H1( " --cqm4iy, --cqm4ic, --cqm4py, --cqm4pc\n"
" Set individual quant matrices\n" );
H1( "\n" );
H1( "Video Usability Info (Annex E):\n" );
H1( "The VUI settings are not used by the encoder but are merely suggestions to\n" );
H1( "the playback equipment. See doc/vui.txt for details. Use at your own risk.\n" );
H1( "\n" );
H1( " --overscan <string> Specify crop overscan setting [\"%s\"]\n"
" - undef, show, crop\n",
strtable_lookup( x264_overscan_names, defaults->vui.i_overscan ) );
H1( " --videoformat <string> Specify video format [\"%s\"]\n"
" - component, pal, ntsc, secam, mac, undef\n",
strtable_lookup( x264_vidformat_names, defaults->vui.i_vidformat ) );
H1( " --fullrange <string> Specify full range samples setting [\"%s\"]\n"
" - off, on\n",
strtable_lookup( x264_fullrange_names, defaults->vui.b_fullrange ) );
H1( " --colorprim <string> Specify color primaries [\"%s\"]\n"
" - undef, bt709, bt470m, bt470bg\n"
" smpte170m, smpte240m, film\n",
strtable_lookup( x264_colorprim_names, defaults->vui.i_colorprim ) );
H1( " --transfer <string> Specify transfer characteristics [\"%s\"]\n"
" - undef, bt709, bt470m, bt470bg, linear,\n"
" log100, log316, smpte170m, smpte240m\n",
strtable_lookup( x264_transfer_names, defaults->vui.i_transfer ) );
H1( " --colormatrix <string> Specify color matrix setting [\"%s\"]\n"
