x264.c 89 KB
Newer Older
1
/*****************************************************************************
2
 * x264: top-level x264cli functions
3
 *****************************************************************************
Henrik Gramner's avatar
Henrik Gramner committed
4
 * Copyright (C) 2003-2019 x264 project
5
 *
6 7
 * Authors: Loren Merritt <lorenm@u.washington.edu>
 *          Laurent Aimar <fenrir@via.ecp.fr>
8
 *          Steven Walters <kemuri9@gmail.com>
9
 *          Fiona Glaser <fiona@x264.com>
10
 *          Kieran Kunhya <kieran@kunhya.com>
Henrik Gramner's avatar
Henrik Gramner committed
11
 *          Henrik Gramner <henrik@gramner.com>
12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
25
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
26 27 28
 *
 * This program is also available under a commercial proprietary license.
 * For more information, contact us at licensing@x264.com.
29 30
 *****************************************************************************/

Henrik Gramner's avatar
Henrik Gramner committed
31 32 33 34 35 36 37 38 39
#ifdef _WIN32
/* The following two defines must be located before the inclusion of any system header files. */
#define WINVER       0x0500
#define _WIN32_WINNT 0x0500
#include <windows.h>
#include <io.h>       /* _setmode() */
#include <fcntl.h>    /* _O_BINARY */
#endif

40 41
#include <signal.h>
#include <getopt.h>
42 43 44
#include "x264cli.h"
#include "input/input.h"
#include "output/output.h"
45
#include "filters/filters.h"
46

47 48 49
#define QP_MAX_SPEC (51+6*2)
#define QP_MAX (QP_MAX_SPEC+18)

50
#define FAIL_IF_ERROR( cond, ... ) FAIL_IF_ERR( cond, "x264", __VA_ARGS__ )
Loren Merritt's avatar
Loren Merritt committed
51

52
#if HAVE_LAVF
53 54
#undef DECLARE_ALIGNED
#include <libavformat/avformat.h>
55 56 57 58
#include <libavutil/pixfmt.h>
#include <libavutil/pixdesc.h>
#endif

59
#if HAVE_SWSCALE
60
#undef DECLARE_ALIGNED
61 62 63 64 65 66 67
#include <libswscale/swscale.h>
#endif

#if HAVE_FFMS
#include <ffms.h>
#endif

Henrik Gramner's avatar
Henrik Gramner committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
#ifdef _WIN32
#define CONSOLE_TITLE_SIZE 200
static wchar_t org_console_title[CONSOLE_TITLE_SIZE] = L"";

void x264_cli_set_console_title( const char *title )
{
    wchar_t title_utf16[CONSOLE_TITLE_SIZE];
    if( utf8_to_utf16( title, title_utf16 ) )
        SetConsoleTitleW( title_utf16 );
}

static int utf16_to_ansi( const wchar_t *utf16, char *ansi, int size )
{
    int invalid;
    return WideCharToMultiByte( CP_ACP, WC_NO_BEST_FIT_CHARS, utf16, -1, ansi, size, NULL, &invalid ) && !invalid;
}

/* Some external libraries doesn't support Unicode in filenames,
 * as a workaround we can try to get an ANSI filename instead. */
int x264_ansi_filename( const char *filename, char *ansi_filename, int size, int create_file )
{
    wchar_t filename_utf16[MAX_PATH];
    if( utf8_to_utf16( filename, filename_utf16 ) )
    {
        if( create_file )
        {
            /* Create the file using the Unicode filename if it doesn't already exist. */
            FILE *fh = _wfopen( filename_utf16, L"ab" );
            if( fh )
                fclose( fh );
        }

        /* Check if the filename already is valid ANSI. */
        if( utf16_to_ansi( filename_utf16, ansi_filename, size ) )
            return 1;

        /* Check for a legacy 8.3 short filename. */
        int short_length = GetShortPathNameW( filename_utf16, filename_utf16, MAX_PATH );
        if( short_length > 0 && short_length < MAX_PATH )
            if( utf16_to_ansi( filename_utf16, ansi_filename, size ) )
                return 1;
    }
    return 0;
}

/* Retrieve command line arguments as UTF-8. */
static int get_argv_utf8( int *argc_ptr, char ***argv_ptr )
{
    int ret = 0;
    wchar_t **argv_utf16 = CommandLineToArgvW( GetCommandLineW(), argc_ptr );
    if( argv_utf16 )
    {
        int argc = *argc_ptr;
        int offset = (argc+1) * sizeof(char*);
        int size = offset;

        for( int i = 0; i < argc; i++ )
            size += WideCharToMultiByte( CP_UTF8, 0, argv_utf16[i], -1, NULL, 0, NULL, NULL );

        char **argv = *argv_ptr = malloc( size );
        if( argv )
        {
            for( int i = 0; i < argc; i++ )
            {
                argv[i] = (char*)argv + offset;
                offset += WideCharToMultiByte( CP_UTF8, 0, argv_utf16[i], -1, argv[i], size-offset, NULL, NULL );
            }
            argv[argc] = NULL;
            ret = 1;
        }
        LocalFree( argv_utf16 );
    }
    return ret;
}
#endif

144
/* Ctrl-C handler */
145
static volatile int b_ctrl_c = 0;
Anton Mitrofanov's avatar
Anton Mitrofanov committed
146
static void sigint_handler( int a )
147
{
Loren Merritt's avatar
Loren Merritt committed
148
    b_ctrl_c = 1;
149 150
}

Loren Merritt's avatar
Loren Merritt committed
151 152 153 154 155
typedef struct {
    int b_progress;
    int i_seek;
    hnd_t hin;
    hnd_t hout;
156
    FILE *qpfile;
Yusuke Nakamura's avatar
Yusuke Nakamura committed
157 158
    FILE *tcfile_out;
    double timebase_convert_multiplier;
159
    int i_pulldown;
Loren Merritt's avatar
Loren Merritt committed
160 161
} cli_opt_t;

162
/* file i/o operation structs */
Anton Mitrofanov's avatar
Anton Mitrofanov committed
163 164
cli_input_t cli_input;
static cli_output_t cli_output;
Loren Merritt's avatar
Loren Merritt committed
165

166 167 168
/* video filter operation struct */
static cli_vid_filter_t filter;

169 170 171 172 173 174 175 176
const char * const x264_avcintra_class_names[] = { "50", "100", "200", 0 };
const char * const x264_cqm_names[] = { "flat", "jvt", 0 };
const char * const x264_log_level_names[] = { "none", "error", "warning", "info", "debug", 0 };
const char * const x264_partition_names[] = { "p8x8", "p4x4", "b8x8", "i8x8", "i4x4", "none", "all", 0 };
const char * const x264_pulldown_names[] = { "none", "22", "32", "64", "double", "triple", "euro", 0 };
const char * const x264_range_names[] = { "auto", "tv", "pc", 0 };

const char * const x264_output_csp_names[] =
177
{
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I400
    "i400",
#endif
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I420
    "i420",
#endif
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I422
    "i422",
#endif
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I444
    "i444", "rgb",
#endif
    0
};

const char * const x264_valid_profile_names[] =
{
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT <= X264_CSP_I420
#if HAVE_BITDEPTH8
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I420
    "baseline", "main",
#endif
    "high",
#endif
#if HAVE_BITDEPTH10
   "high10",
#endif
#endif
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I422
   "high422",
#endif
   "high444", 0
};

const char * const x264_demuxer_names[] =
{
    "auto", "raw", "y4m",
Steven Walters's avatar
Steven Walters committed
215
#if HAVE_AVS
216 217
    "avs",
#endif
Steven Walters's avatar
Steven Walters committed
218
#if HAVE_LAVF
219 220
    "lavf",
#endif
Steven Walters's avatar
Steven Walters committed
221
#if HAVE_FFMS
222 223 224 225 226
    "ffms",
#endif
    0
};

227
const char * const x264_muxer_names[] =
228
{
229
    "auto", "raw", "mkv", "flv",
230
#if HAVE_GPAC || HAVE_LSMASH
231 232 233 234
    "mp4",
#endif
    0
};
235

236 237 238
static const char * const chroma_format_names[] =
{
    [0] = "all",
239
    [X264_CSP_I400] = "i400",
240 241 242 243
    [X264_CSP_I420] = "i420",
    [X264_CSP_I422] = "i422",
    [X264_CSP_I444] = "i444"
};
244

245 246
typedef struct
{
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
    int mod;
    uint8_t pattern[24];
    float fps_factor;
} cli_pulldown_t;

enum pulldown_type_e
{
    X264_PULLDOWN_22 = 1,
    X264_PULLDOWN_32,
    X264_PULLDOWN_64,
    X264_PULLDOWN_DOUBLE,
    X264_PULLDOWN_TRIPLE,
    X264_PULLDOWN_EURO
};

#define TB  PIC_STRUCT_TOP_BOTTOM
#define BT  PIC_STRUCT_BOTTOM_TOP
#define TBT PIC_STRUCT_TOP_BOTTOM_TOP
#define BTB PIC_STRUCT_BOTTOM_TOP_BOTTOM

static const cli_pulldown_t pulldown_values[] =
{
Kieran Kunhya's avatar
Kieran Kunhya committed
269
    [X264_PULLDOWN_22]     = {1,  {TB},                                   1.0},
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
    [X264_PULLDOWN_32]     = {4,  {TBT, BT, BTB, TB},                     1.25},
    [X264_PULLDOWN_64]     = {2,  {PIC_STRUCT_DOUBLE, PIC_STRUCT_TRIPLE}, 1.0},
    [X264_PULLDOWN_DOUBLE] = {1,  {PIC_STRUCT_DOUBLE},                    2.0},
    [X264_PULLDOWN_TRIPLE] = {1,  {PIC_STRUCT_TRIPLE},                    3.0},
    [X264_PULLDOWN_EURO]   = {24, {TBT, BT, BT, BT, BT, BT, BT, BT, BT, BT, BT, BT,
                                   BTB, TB, TB, TB, TB, TB, TB, TB, TB, TB, TB, TB}, 25.0/24.0}
};

#undef TB
#undef BT
#undef TBT
#undef BTB

// indexed by pic_struct enum
static const float pulldown_frame_duration[10] = { 0.0, 1, 0.5, 0.5, 1, 1, 1.5, 1.5, 2, 3 };

Anton Mitrofanov's avatar
Anton Mitrofanov committed
286 287 288
static void help( x264_param_t *defaults, int longhelp );
static int  parse( int argc, char **argv, x264_param_t *param, cli_opt_t *opt );
static int  encode( x264_param_t *param, cli_opt_t *opt );
289

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
/* logging and printing for within the cli system */
static int cli_log_level;
void x264_cli_log( const char *name, int i_level, const char *fmt, ... )
{
    if( i_level > cli_log_level )
        return;
    char *s_level;
    switch( i_level )
    {
        case X264_LOG_ERROR:
            s_level = "error";
            break;
        case X264_LOG_WARNING:
            s_level = "warning";
            break;
        case X264_LOG_INFO:
            s_level = "info";
            break;
        case X264_LOG_DEBUG:
            s_level = "debug";
            break;
        default:
            s_level = "unknown";
            break;
    }
    fprintf( stderr, "%s [%s]: ", name, s_level );
    va_list arg;
    va_start( arg, fmt );
Henrik Gramner's avatar
Henrik Gramner committed
318
    x264_vfprintf( stderr, fmt, arg );
319 320 321 322 323 324 325 326 327
    va_end( arg );
}

void x264_cli_printf( int i_level, const char *fmt, ... )
{
    if( i_level > cli_log_level )
        return;
    va_list arg;
    va_start( arg, fmt );
Henrik Gramner's avatar
Henrik Gramner committed
328
    x264_vfprintf( stderr, fmt, arg );
329 330 331
    va_end( arg );
}

332
static void print_version_info( void )
333 334 335 336 337
{
#ifdef X264_POINTVER
    printf( "x264 "X264_POINTVER"\n" );
#else
    printf( "x264 0.%d.X\n", X264_BUILD );
338 339 340 341 342 343 344 345 346
#endif
#if HAVE_SWSCALE
    printf( "(libswscale %d.%d.%d)\n", LIBSWSCALE_VERSION_MAJOR, LIBSWSCALE_VERSION_MINOR, LIBSWSCALE_VERSION_MICRO );
#endif
#if HAVE_LAVF
    printf( "(libavformat %d.%d.%d)\n", LIBAVFORMAT_VERSION_MAJOR, LIBAVFORMAT_VERSION_MINOR, LIBAVFORMAT_VERSION_MICRO );
#endif
#if HAVE_FFMS
    printf( "(ffmpegsource %d.%d.%d.%d)\n", FFMS_VERSION >> 24, (FFMS_VERSION & 0xff0000) >> 16, (FFMS_VERSION & 0xff00) >> 8, FFMS_VERSION & 0xff );
347 348
#endif
    printf( "built on " __DATE__ ", " );
Steven Walters's avatar
Steven Walters committed
349 350 351
#ifdef __INTEL_COMPILER
    printf( "intel: %.2f (%d)\n", __INTEL_COMPILER / 100.f, __INTEL_COMPILER_BUILD_DATE );
#elif defined(__GNUC__)
352
    printf( "gcc: " __VERSION__ "\n" );
353 354
#elif defined(_MSC_FULL_VER)
    printf( "msvc: %.2f (%u)\n", _MSC_VER / 100.f, _MSC_FULL_VER );
355
#else
Steven Walters's avatar
Steven Walters committed
356
    printf( "using an unknown compiler\n" );
357
#endif
358 359
    printf( "x264 configuration: --chroma-format=%s\n", chroma_format_names[X264_CHROMA_FORMAT] );
    printf( "libx264 configuration: --chroma-format=%s\n", chroma_format_names[x264_chroma_format] );
360 361 362 363 364 365
    printf( "x264 license: " );
#if HAVE_GPL
    printf( "GPL version 2 or later\n" );
#else
    printf( "Non-GPL commercial\n" );
#endif
366 367 368
#if HAVE_SWSCALE
    const char *license = swscale_license();
    printf( "libswscale%s%s license: %s\n", HAVE_LAVF ? "/libavformat" : "", HAVE_FFMS ? "/ffmpegsource" : "" , license );
369 370 371 372 373 374 375
    if( !strcmp( license, "nonfree and unredistributable" ) ||
       (!HAVE_GPL && (!strcmp( license, "GPL version 2 or later" )
                  ||  !strcmp( license, "GPL version 3 or later" ))))
        printf( "WARNING: This binary is unredistributable!\n" );
#endif
}

376
REALIGN_STACK int main( int argc, char **argv )
377
{
378 379 380
    if( argc == 4 && !strcmp( argv[1], "--autocomplete" ) )
        return x264_cli_autocomplete( argv[2], argv[3] );

381
    x264_param_t param;
382 383
    cli_opt_t opt = {0};
    int ret = 0;
384

385
    FAIL_IF_ERROR( x264_threading_init(), "unable to initialize threading\n" );
386

387
#ifdef _WIN32
388
    FAIL_IF_ERROR( !get_argv_utf8( &argc, &argv ), "unable to convert command line to UTF-8\n" );
389

Henrik Gramner's avatar
Henrik Gramner committed
390 391 392 393 394
    GetConsoleTitleW( org_console_title, CONSOLE_TITLE_SIZE );
    _setmode( _fileno( stdin ),  _O_BINARY );
    _setmode( _fileno( stdout ), _O_BINARY );
    _setmode( _fileno( stderr ), _O_BINARY );
#endif
395

396
    /* Parse command line */
Anton Mitrofanov's avatar
Anton Mitrofanov committed
397
    if( parse( argc, argv, &param, &opt ) < 0 )
398
        ret = -1;
399

Henrik Gramner's avatar
Henrik Gramner committed
400
#ifdef _WIN32
401
    /* Restore title; it can be changed by input modules */
Henrik Gramner's avatar
Henrik Gramner committed
402 403
    SetConsoleTitleW( org_console_title );
#endif
404

405
    /* Control-C handler */
Anton Mitrofanov's avatar
Anton Mitrofanov committed
406
    signal( SIGINT, sigint_handler );
407

408 409 410 411 412 413 414
    if( !ret )
        ret = encode( &param, &opt );

    /* clean up handles */
    if( filter.free )
        filter.free( opt.hin );
    else if( opt.hin )
Anton Mitrofanov's avatar
Anton Mitrofanov committed
415
        cli_input.close_file( opt.hin );
416
    if( opt.hout )
Anton Mitrofanov's avatar
Anton Mitrofanov committed
417
        cli_output.close_file( opt.hout, 0, 0 );
418 419 420 421
    if( opt.tcfile_out )
        fclose( opt.tcfile_out );
    if( opt.qpfile )
        fclose( opt.qpfile );
422

Henrik Gramner's avatar
Henrik Gramner committed
423 424 425 426
#ifdef _WIN32
    SetConsoleTitleW( org_console_title );
    free( argv );
#endif
427

428
    return ret;
429 430
}

431
static char const *strtable_lookup( const char * const table[], int idx )
432 433
{
    int i = 0; while( table[i] ) i++;
434
    return ( ( idx >= 0 && idx < i ) ? table[ idx ] : "???" );
435 436
}

437 438 439 440 441 442 443 444 445 446 447 448 449
static char *stringify_names( char *buf, const char * const names[] )
{
    int i = 0;
    char *p = buf;
    for( p[0] = 0; names[i]; i++ )
    {
        p += sprintf( p, "%s", names[i] );
        if( names[i+1] )
            p += sprintf( p, ", " );
    }
    return buf;
}

450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
#define INDENT "                                "
#define INDENT_LEN 32 // strlen( INDENT )
#define SEPARATOR ", "
#define SEPARATOR_LEN 2 // strlen( SEPARATOR )

static void print_csp_name_internal( const char *name, size_t *line_len, int last )
{
    if( name )
    {
        size_t name_len = strlen( name );
        if( *line_len + name_len > (80 - SEPARATOR_LEN) )
        {
            printf( "\n" INDENT );
            *line_len = INDENT_LEN;
        }
        printf( "%s", name );
        *line_len += name_len;
        if( !last )
        {
            printf( SEPARATOR );
            *line_len += SEPARATOR_LEN;
        }
    }
}

475 476 477 478 479 480
static void print_csp_names( int longhelp )
{
    if( longhelp < 2 )
        return;
    printf( "                              - valid csps for `raw' demuxer:\n" );
    printf( INDENT );
481
    size_t line_len = INDENT_LEN;
482
    for( int i = X264_CSP_NONE+1; i < X264_CSP_CLI_MAX; i++ )
483
        print_csp_name_internal( x264_cli_csps[i].name, &line_len, i == X264_CSP_CLI_MAX-1 );
484 485 486 487
#if HAVE_LAVF
    printf( "\n" );
    printf( "                              - valid csps for `lavf' demuxer:\n" );
    printf( INDENT );
488
    line_len = INDENT_LEN;
489
    for( enum AVPixelFormat i = AV_PIX_FMT_NONE+1; i < AV_PIX_FMT_NB; i++ )
490
        print_csp_name_internal( av_get_pix_fmt_name( i ), &line_len, i == AV_PIX_FMT_NB-1 );
491 492 493 494
#endif
    printf( "\n" );
}

Anton Mitrofanov's avatar
Anton Mitrofanov committed
495
static void help( x264_param_t *defaults, int longhelp )
496
{
497
    char buf[50];
498
#define H0 printf
Anton Mitrofanov's avatar
Anton Mitrofanov committed
499 500
#define H1 if( longhelp >= 1 ) printf
#define H2 if( longhelp == 2 ) printf
501
    H0( "x264 core:%d%s\n"
502
        "Syntax: x264 [options] -o outfile infile\n"
503
        "\n"
504 505
        "Infile can be raw (in which case resolution is required),\n"
        "  or YUV4MPEG (*.y4m),\n"
506
        "  or Avisynth if compiled with support (%s).\n"
507
        "  or libav* formats if compiled with lavf support (%s) or ffms support (%s).\n"
508 509 510
        "Outfile type is selected by filename:\n"
        " .264 -> Raw bytestream\n"
        " .mkv -> Matroska\n"
Kieran Kunhya's avatar
Kieran Kunhya committed
511
        " .flv -> Flash Video\n"
512
        " .mp4 -> MP4 if compiled with GPAC or L-SMASH support (%s)\n"
513
        "Output bit depth: %s\n."
514 515 516
        "\n"
        "Options:\n"
        "\n"
Fiona Glaser's avatar
Fiona Glaser committed
517 518 519
        "  -h, --help                  List basic options\n"
        "      --longhelp              List more options\n"
        "      --fullhelp              List all options\n"
520 521
        "\n",
        X264_BUILD, X264_VERSION,
Steven Walters's avatar
Steven Walters committed
522
#if HAVE_AVS
523 524 525 526
        "yes",
#else
        "no",
#endif
Steven Walters's avatar
Steven Walters committed
527
#if HAVE_LAVF
528 529 530 531
        "yes",
#else
        "no",
#endif
Steven Walters's avatar
Steven Walters committed
532
#if HAVE_FFMS
533
        "yes",
Loren Merritt's avatar
Loren Merritt committed
534
#else
535
        "no",
Loren Merritt's avatar
Loren Merritt committed
536
#endif
Steven Walters's avatar
Steven Walters committed
537
#if HAVE_GPAC
538 539 540
        "gpac",
#elif HAVE_LSMASH
        "lsmash",
Loren Merritt's avatar
Loren Merritt committed
541
#else
542
        "no",
Loren Merritt's avatar
Loren Merritt committed
543
#endif
544 545 546 547 548 549 550 551 552
#if HAVE_BITDEPTH8 && HAVE_BITDEPTH10
        "8/10"
#elif HAVE_BITDEPTH8
        "8"
#elif HAVE_BITDEPTH10
        "10"
#else
        "none"
#endif
553
      );
Fiona Glaser's avatar
Fiona Glaser committed
554 555 556
    H0( "Example usage:\n" );
    H0( "\n" );
    H0( "      Constant quality mode:\n" );
557
    H0( "            x264 --crf 24 -o <output> <input>\n" );
Fiona Glaser's avatar
Fiona Glaser committed
558 559
    H0( "\n" );
    H0( "      Two-pass with a bitrate of 1000kbps:\n" );
560 561
    H0( "            x264 --pass 1 --bitrate 1000 -o <output> <input>\n" );
    H0( "            x264 --pass 2 --bitrate 1000 -o <output> <input>\n" );
Fiona Glaser's avatar
Fiona Glaser committed
562 563
    H0( "\n" );
    H0( "      Lossless:\n" );
564
    H0( "            x264 --qp 0 -o <output> <input>\n" );
Fiona Glaser's avatar
Fiona Glaser committed
565 566
    H0( "\n" );
    H0( "      Maximum PSNR at the cost of speed and visual quality:\n" );
567
    H0( "            x264 --preset placebo --tune psnr -o <output> <input>\n" );
Fiona Glaser's avatar
Fiona Glaser committed
568 569
    H0( "\n" );
    H0( "      Constant bitrate at 1000kbps with a 2 second-buffer:\n");
570
    H0( "            x264 --vbv-bufsize 2000 --bitrate 1000 -o <output> <input>\n" );
Fiona Glaser's avatar
Fiona Glaser committed
571
    H0( "\n" );
572 573
    H0( "Presets:\n" );
    H0( "\n" );
574
    H0( "      --profile <string>      Force the limits of an H.264 profile\n"
575
        "                                  Overrides all settings.\n" );
Harfe Leier's avatar
Harfe Leier committed
576
    H2(
577
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT <= X264_CSP_I420
578
#if HAVE_BITDEPTH8
579
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I420
Harfe Leier's avatar
Harfe Leier committed
580
        "                                  - baseline:\n"
581
        "                                    --no-8x8dct --bframes 0 --no-cabac\n"
582 583 584
        "                                    --cqm flat --weightp 0\n"
        "                                    No interlaced.\n"
        "                                    No lossless.\n"
585
        "                                  - main:\n"
586 587
        "                                    --no-8x8dct --cqm flat\n"
        "                                    No lossless.\n"
588
#endif
589
        "                                  - high:\n"
590
        "                                    No lossless.\n"
591 592
#endif
#if HAVE_BITDEPTH10
593 594
        "                                  - high10:\n"
        "                                    No lossless.\n"
Harfe Leier's avatar
Harfe Leier committed
595
        "                                    Support for bit depth 8-10.\n"
596
#endif
597 598
#endif
#if !X264_CHROMA_FORMAT || X264_CHROMA_FORMAT == X264_CSP_I422
Harfe Leier's avatar
Harfe Leier committed
599 600 601 602
        "                                  - high422:\n"
        "                                    No lossless.\n"
        "                                    Support for bit depth 8-10.\n"
        "                                    Support for 4:2:0/4:2:2 chroma subsampling.\n"
603
#endif
Harfe Leier's avatar
Harfe Leier committed
604 605 606
        "                                  - high444:\n"
        "                                    Support for bit depth 8-10.\n"
        "                                    Support for 4:2:0/4:2:2/4:4:4 chroma subsampling.\n" );
607
    else H0( "                                  - %s\n", stringify_names( buf, x264_valid_profile_names ) );
608
    H0( "      --preset <string>       Use a preset to select encoding settings [medium]\n"
609
        "                                  Overridden by user settings.\n" );
610
    H2( "                                  - ultrafast:\n"
611
        "                                    --no-8x8dct --aq-mode 0 --b-adapt 0\n"
612 613
        "                                    --bframes 0 --no-cabac --no-deblock\n"
        "                                    --no-mbtree --me dia --no-mixed-refs\n"
614 615 616
        "                                    --partitions none --rc-lookahead 0 --ref 1\n"
        "                                    --scenecut 0 --subme 0 --trellis 0\n"
        "                                    --no-weightb --weightp 0\n"
617
        "                                  - superfast:\n"
618
        "                                    --no-mbtree --me dia --no-mixed-refs\n"
619
        "                                    --partitions i8x8,i4x4 --rc-lookahead 0\n"
620
        "                                    --ref 1 --subme 1 --trellis 0 --weightp 1\n"
621
        "                                  - veryfast:\n"
622
        "                                    --no-mixed-refs --rc-lookahead 10\n"
623
        "                                    --ref 1 --subme 2 --trellis 0 --weightp 1\n"
624
        "                                  - faster:\n"
625 626
        "                                    --no-mixed-refs --rc-lookahead 20\n"
        "                                    --ref 2 --subme 4 --weightp 1\n"
627
        "                                  - fast:\n"
628
        "                                    --rc-lookahead 30 --ref 2 --subme 6\n"
629
        "                                    --weightp 1\n"
630
        "                                  - medium:\n"
631
        "                                    Default settings apply.\n"
632
        "                                  - slow:\n"
633 634
        "                                    --direct auto --rc-lookahead 50 --ref 5\n"
        "                                    --subme 8 --trellis 2\n"
635
        "                                  - slower:\n"
636 637 638
        "                                    --b-adapt 2 --direct auto --me umh\n"
        "                                    --partitions all --rc-lookahead 60\n"
        "                                    --ref 8 --subme 9 --trellis 2\n"
639
        "                                  - veryslow:\n"
640
        "                                    --b-adapt 2 --bframes 8 --direct auto\n"
Fiona Glaser's avatar
Fiona Glaser committed
641
        "                                    --me umh --merange 24 --partitions all\n"
642 643
        "                                    --ref 16 --subme 10 --trellis 2\n"
        "                                    --rc-lookahead 60\n"
644
        "                                  - placebo:\n"
645 646
        "                                    --bframes 16 --b-adapt 2 --direct auto\n"
        "                                    --slow-firstpass --no-fast-pskip\n"
Fiona Glaser's avatar
Fiona Glaser committed
647
        "                                    --me tesa --merange 24 --partitions all\n"
648
        "                                    --rc-lookahead 60 --ref 16 --subme 11\n"
649
        "                                    --trellis 2\n" );
650 651
    else H0( "                                  - ultrafast,superfast,veryfast,faster,fast\n"
             "                                  - medium,slow,slower,veryslow,placebo\n" );
652
    H0( "      --tune <string>         Tune the settings for a particular type of source\n"
653 654 655 656 657
        "                              or situation\n"
        "                                  Overridden by user settings.\n"
        "                                  Multiple tunings are separated by commas.\n"
        "                                  Only one psy tuning can be used at a time.\n" );
    H2( "                                  - film (psy tuning):\n"
658
        "                                    --deblock -1:-1 --psy-rd <unset>:0.15\n"
659
        "                                  - animation (psy tuning):\n"
660
        "                                    --bframes {+2} --deblock 1:1\n"
661
        "                                    --psy-rd 0.4:<unset> --aq-strength 0.6\n"
662
        "                                    --ref {Double if >1 else 1}\n"
663
        "                                  - grain (psy tuning):\n"
664
        "                                    --aq-strength 0.5 --no-dct-decimate\n"
665
        "                                    --deadzone-inter 6 --deadzone-intra 6\n"
666
        "                                    --deblock -2:-2 --ipratio 1.1\n"
667 668
        "                                    --pbratio 1.1 --psy-rd <unset>:0.25\n"
        "                                    --qcomp 0.8\n"
669 670 671
        "                                  - stillimage (psy tuning):\n"
        "                                    --aq-strength 1.2 --deblock -3:-3\n"
        "                                    --psy-rd 2.0:0.7\n"
672
        "                                  - psnr (psy tuning):\n"
673
        "                                    --aq-mode 0 --no-psy\n"
674
        "                                  - ssim (psy tuning):\n"
675 676 677 678
        "                                    --aq-mode 2 --no-psy\n"
        "                                  - fastdecode:\n"
        "                                    --no-cabac --no-deblock --no-weightb\n"
        "                                    --weightp 0\n"
679
        "                                  - zerolatency:\n"
680 681 682
        "                                    --bframes 0 --force-cfr --no-mbtree\n"
        "                                    --sync-lookahead 0 --sliced-threads\n"
        "                                    --rc-lookahead 0\n" );
683 684
    else H0( "                                  - psy tunings: film,animation,grain,\n"
             "                                                 stillimage,psnr,ssim\n"
685
             "                                  - other tunings: fastdecode,zerolatency\n" );
686
    H2( "      --slow-firstpass        Don't force these faster settings with --pass 1:\n"
687 688 689
        "                                  --no-8x8dct --me dia --partitions none\n"
        "                                  --ref 1 --subme {2 if >2 else unchanged}\n"
        "                                  --trellis 0 --fast-pskip\n" );
690
    else H1( "      --slow-firstpass        Don't force faster settings with --pass 1\n" );
691
    H0( "\n" );
692 693
    H0( "Frame-type options:\n" );
    H0( "\n" );
694
    H0( "  -I, --keyint <integer or \"infinite\"> Maximum GOP size [%d]\n", defaults->i_keyint_max );
695
    H2( "  -i, --min-keyint <integer>  Minimum GOP size [auto]\n" );
Fiona Glaser's avatar
Fiona Glaser committed
696 697
    H2( "      --no-scenecut           Disable adaptive I-frame decision\n" );
    H2( "      --scenecut <integer>    How aggressively to insert extra I-frames [%d]\n", defaults->i_scenecut_threshold );
Fiona Glaser's avatar
Fiona Glaser committed
698
    H2( "      --intra-refresh         Use Periodic Intra Refresh instead of IDR frames\n" );
Fiona Glaser's avatar
Fiona Glaser committed
699
    H1( "  -b, --bframes <integer>     Number of B-frames between I and P [%d]\n", defaults->i_bframe );
Fiona Glaser's avatar
Fiona Glaser committed
700
    H1( "      --b-adapt <integer>     Adaptive B-frame decision method [%d]\n"
701 702 703 704
        "                                  Higher values may lower threading efficiency.\n"
        "                                  - 0: Disabled\n"
        "                                  - 1: Fast\n"
        "                                  - 2: Optimal (slow with high --bframes)\n", defaults->i_bframe_adaptive );
Fiona Glaser's avatar
Fiona Glaser committed
705
    H2( "      --b-bias <integer>      Influences how often B-frames are used [%d]\n", defaults->i_bframe_bias );
706 707
    H1( "      --b-pyramid <string>    Keep some B-frames as references [%s]\n"
        "                                  - none: Disabled\n"
708
        "                                  - strict: Strictly hierarchical pyramid\n"
709 710
        "                                  - normal: Non-strict (not Blu-ray compatible)\n",
        strtable_lookup( x264_b_pyramid_names, defaults->i_bframe_pyramid ) );
711
    H1( "      --open-gop              Use recovery points to close GOPs\n"
Lamont Alston's avatar
Lamont Alston committed
712
        "                              Only available with b-frames\n" );
Fiona Glaser's avatar
Fiona Glaser committed
713 714
    H1( "      --no-cabac              Disable CABAC\n" );
    H1( "  -r, --ref <integer>         Number of reference frames [%d]\n", defaults->i_frame_reference );
715
    H1( "      --no-deblock            Disable loop filter\n" );
Fiona Glaser's avatar
Fiona Glaser committed
716
    H1( "  -f, --deblock <alpha:beta>  Loop filter parameters [%d:%d]\n",
717
                                       defaults->i_deblocking_filter_alphac0, defaults->i_deblocking_filter_beta );
Fiona Glaser's avatar
Fiona Glaser committed
718
    H2( "      --slices <integer>      Number of slices per frame; forces rectangular\n"
719
        "                              slices and is overridden by other slicing options\n" );
Fiona Glaser's avatar
Fiona Glaser committed
720
    else H1( "      --slices <integer>      Number of slices per frame\n" );
Fiona Glaser's avatar
Fiona Glaser committed
721 722
    H2( "      --slices-max <integer>  Absolute maximum slices per frame; overrides\n"
        "                              slice-max-size/slice-max-mbs when necessary\n" );
Fiona Glaser's avatar
Fiona Glaser committed
723
    H2( "      --slice-max-size <integer> Limit the size of each slice in bytes\n");
Fiona Glaser's avatar
Fiona Glaser committed
724 725
    H2( "      --slice-max-mbs <integer> Limit the size of each slice in macroblocks (max)\n");
    H2( "      --slice-min-mbs <integer> Limit the size of each slice in macroblocks (min)\n");
726 727
    H0( "      --tff                   Enable interlaced mode (top field first)\n" );
    H0( "      --bff                   Enable interlaced mode (bottom field first)\n" );
728
    H2( "      --constrained-intra     Enable constrained intra prediction.\n" );
729 730 731 732 733
    H0( "      --pulldown <string>     Use soft pulldown to change frame rate\n"
        "                                  - none, 22, 32, 64, double, triple, euro (requires cfr input)\n" );
    H2( "      --fake-interlaced       Flag stream as interlaced but encode progressive.\n"
        "                              Makes it possible to encode 25p and 30p Blu-Ray\n"
        "                              streams. Ignored in interlaced mode.\n" );
734 735 736 737 738 739
    H2( "      --frame-packing <integer> For stereoscopic videos define frame arrangement\n"
        "                                  - 0: checkerboard - pixels are alternatively from L and R\n"
        "                                  - 1: column alternation - L and R are interlaced by column\n"
        "                                  - 2: row alternation - L and R are interlaced by row\n"
        "                                  - 3: side by side - L is on the left, R on the right\n"
        "                                  - 4: top bottom - L is on top, R on bottom\n"
740
        "                                  - 5: frame alternation - one view per frame\n"
741 742
        "                                  - 6: mono - 2D frame without any frame packing\n"
        "                                  - 7: tile format - L is on top-left, R split across\n" );
743 744 745
    H0( "\n" );
    H0( "Ratecontrol:\n" );
    H0( "\n" );
746
    H1( "  -q, --qp <integer>          Force constant QP (0-%d, 0=lossless)\n", QP_MAX );
747
    H0( "  -B, --bitrate <integer>     Set bitrate (kbit/s)\n" );
748
    H0( "      --crf <float>           Quality-based VBR (%d-51) [%.1f]\n", 51 - QP_MAX_SPEC, defaults->rc.f_rf_constant );
Fiona Glaser's avatar
Fiona Glaser committed
749
    H1( "      --rc-lookahead <integer> Number of frames for frametype lookahead [%d]\n", defaults->rc.i_lookahead );
750 751
    H0( "      --vbv-maxrate <integer> Max local bitrate (kbit/s) [%d]\n", defaults->rc.i_vbv_max_bitrate );
    H0( "      --vbv-bufsize <integer> Set size of the VBV buffer (kbit) [%d]\n", defaults->rc.i_vbv_buffer_size );
Fiona Glaser's avatar
Fiona Glaser committed
752
    H2( "      --vbv-init <float>      Initial VBV buffer occupancy [%.1f]\n", defaults->rc.f_vbv_buffer_init );
753 754
    H2( "      --crf-max <float>       With CRF+VBV, limit RF to this value\n"
        "                                  May cause VBV underflows!\n" );
Fiona Glaser's avatar
Fiona Glaser committed
755
    H2( "      --qpmin <integer>       Set min QP [%d]\n", defaults->rc.i_qp_min );
756
    H2( "      --qpmax <integer>       Set max QP [%d]\n", X264_MIN( defaults->rc.i_qp_max, QP_MAX ) );
Fiona Glaser's avatar
Fiona Glaser committed
757
    H2( "      --qpstep <integer>      Set max QP step [%d]\n", defaults->rc.i_qp_step );
758
    H2( "      --ratetol <float>       Tolerance of ABR ratecontrol and VBV [%.1f]\n", defaults->rc.f_rate_tolerance );
Fiona Glaser's avatar
Fiona Glaser committed
759 760 761 762
    H2( "      --ipratio <float>       QP factor between I and P [%.2f]\n", defaults->rc.f_ip_factor );
    H2( "      --pbratio <float>       QP factor between P and B [%.2f]\n", defaults->rc.f_pb_factor );
    H2( "      --chroma-qp-offset <integer>  QP difference between chroma and luma [%d]\n", defaults->analyse.i_chroma_qp_offset );
    H2( "      --aq-mode <integer>     AQ method [%d]\n"
763
        "                                  - 0: Disabled\n"
764
        "                                  - 1: Variance AQ (complexity mask)\n"
765 766
        "                                  - 2: Auto-variance AQ\n"
        "                                  - 3: Auto-variance AQ with bias to dark scenes\n", defaults->rc.i_aq_mode );
Fiona Glaser's avatar
Fiona Glaser committed
767 768 769
    H1( "      --aq-strength <float>   Reduces blocking and blurring in flat and\n"
        "                              textured areas. [%.1f]\n", defaults->rc.f_aq_strength );
    H1( "\n" );
Fiona Glaser's avatar
Fiona Glaser committed
770 771
    H0( "  -p, --pass <integer>        Enable multipass ratecontrol\n"
        "                                  - 1: First pass, creates stats file\n"
Fiona Glaser's avatar
Fiona Glaser committed
772 773 774 775 776 777 778 779 780
        "                                  - 2: Last pass, does not overwrite stats file\n" );
    H2( "                                  - 3: Nth pass, overwrites stats file\n" );
    H1( "      --stats <string>        Filename for 2 pass stats [\"%s\"]\n", defaults->rc.psz_stat_out );
    H2( "      --no-mbtree             Disable mb-tree ratecontrol.\n");
    H2( "      --qcomp <float>         QP curve compression [%.2f]\n", defaults->rc.f_qcompress );
    H2( "      --cplxblur <float>      Reduce fluctuations in QP (before curve compression) [%.1f]\n", defaults->rc.f_complexity_blur );
    H2( "      --qblur <float>         Reduce fluctuations in QP (after curve compression) [%.1f]\n", defaults->rc.f_qblur );
    H2( "      --zones <zone0>/<zone1>/...  Tweak the bitrate of regions of the video\n" );
    H2( "                              Each zone is of the form\n"
781 782 783 784
        "                                  <start frame>,<end frame>,<option>\n"
        "                                  where <option> is either\n"
        "                                      q=<integer> (force QP)\n"
        "                                  or  b=<float> (bitrate multiplier)\n" );
785
    H2( "      --qpfile <string>       Force frametypes and QPs for some or all frames\n"
786
        "                              Format of each line: framenumber frametype QP\n"
787
        "                              QP is optional (none lets x264 choose). Frametypes: I,i,K,P,B,b.\n"
Lamont Alston's avatar
Lamont Alston committed
788
        "                                  K=<I or i> depending on open-gop setting\n"
789
        "                              QPs are restricted by qpmin/qpmax.\n" );
Fiona Glaser's avatar
Fiona Glaser committed
790 791 792 793
    H1( "\n" );
    H1( "Analysis:\n" );
    H1( "\n" );
    H1( "  -A, --partitions <string>   Partitions to consider [\"p8x8,b8x8,i8x8,i4x4\"]\n"
794 795
        "                                  - %s\n"
        "                                  (p4x4 requires p8x8. i8x8 requires --8x8dct.)\n", stringify_names( buf, x264_partition_names ) );
Fiona Glaser's avatar
Fiona Glaser committed
796
    H1( "      --direct <string>       Direct MV prediction mode [\"%s\"]\n"
797 798
        "                                  - none, spatial, temporal, auto\n",
                                       strtable_lookup( x264_direct_pred_names, defaults->analyse.i_direct_mv_pred ) );
Fiona Glaser's avatar
Fiona Glaser committed
799
    H2( "      --no-weightb            Disable weighted prediction for B-frames\n" );
Fiona Glaser's avatar
Fiona Glaser committed
800
    H1( "      --weightp <integer>     Weighted prediction for P-frames [%d]\n"
Fiona Glaser's avatar
Fiona Glaser committed
801
        "                                  - 0: Disabled\n"
802 803
        "                                  - 1: Weighted refs\n"
        "                                  - 2: Weighted refs + Duplicates\n", defaults->analyse.i_weighted_pred );
Fiona Glaser's avatar
Fiona Glaser committed
804
    H1( "      --me <string>           Integer pixel motion estimation method [\"%s\"]\n",
805
                                       strtable_lookup( x264_motion_est_names, defaults->analyse.i_me_method ) );
Fiona Glaser's avatar
Fiona Glaser committed
806
    H2( "                                  - dia: diamond search, radius 1 (fast)\n"
807 808
        "                                  - hex: hexagonal search, radius 2\n"
        "                                  - umh: uneven multi-hexagon search\n"
809 810
        "                                  - esa: exhaustive search\n"
        "                                  - tesa: hadamard exhaustive search (slow)\n" );
Fiona Glaser's avatar
Fiona Glaser committed
811 812 813 814 815 816
    else H1( "                                  - dia, hex, umh\n" );
    H2( "      --merange <integer>     Maximum motion vector search range [%d]\n", defaults->analyse.i_me_range );
    H2( "      --mvrange <integer>     Maximum motion vector length [-1 (auto)]\n" );
    H2( "      --mvrange-thread <int>  Minimum buffer between threads [-1 (auto)]\n" );
    H1( "  -m, --subme <integer>       Subpixel motion estimation and mode decision [%d]\n", defaults->analyse.i_subpel_refine );
    H2( "                                  - 0: fullpel only (not recommended)\n"
817
        "                                  - 1: SAD mode decision, one qpel iteration\n"
818 819 820 821 822
        "                                  - 2: SATD mode decision\n"
        "                                  - 3-5: Progressively more qpel\n"
        "                                  - 6: RD mode decision for I/P-frames\n"
        "                                  - 7: RD mode decision for all frames\n"
        "                                  - 8: RD refinement for I/P-frames\n"
823
        "                                  - 9: RD refinement for all frames\n"
824 825 826
        "                                  - 10: QP-RD - requires trellis=2, aq-mode>0\n"
        "                                  - 11: Full RD: disable all early terminations\n" );
    else H1( "                                  decision quality: 1=fast, 11=best\n" );
827
    H1( "      --psy-rd <float:float>  Strength of psychovisual optimization [\"%.1f:%.1f\"]\n"
828
        "                                  #1: RD (requires subme>=6)\n"
829
        "                                  #2: Trellis (requires trellis, experimental)\n",
Loren Merritt's avatar
Loren Merritt committed
830
                                       defaults->analyse.f_psy_rd, defaults->analyse.f_psy_trellis );
Fiona Glaser's avatar
Fiona Glaser committed
831
    H2( "      --no-psy                Disable all visual optimizations that worsen\n"
832
        "                              both PSNR and SSIM.\n" );
Fiona Glaser's avatar
Fiona Glaser committed
833 834 835
    H2( "      --no-mixed-refs         Don't decide references on a per partition basis\n" );
    H2( "      --no-chroma-me          Ignore chroma in motion estimation\n" );
    H1( "      --no-8x8dct             Disable adaptive spatial transform size\n" );
Fiona Glaser's avatar
Fiona Glaser committed
836
    H1( "  -t, --trellis <integer>     Trellis RD quantization. [%d]\n"
837 838 839
        "                                  - 0: disabled\n"
        "                                  - 1: enabled only on the final encode of a MB\n"
        "                                  - 2: enabled on all mode decisions\n", defaults->analyse.i_trellis );
Fiona Glaser's avatar
Fiona Glaser committed
840 841 842 843 844 845 846
    H2( "      --no-fast-pskip         Disables early SKIP detection on P-frames\n" );
    H2( "      --no-dct-decimate       Disables coefficient thresholding on P-frames\n" );
    H1( "      --nr <integer>          Noise reduction [%d]\n", defaults->analyse.i_noise_reduction );
    H2( "\n" );
    H2( "      --deadzone-inter <int>  Set the size of the inter luma quantization deadzone [%d]\n", defaults->analyse.i_luma_deadzone[0] );
    H2( "      --deadzone-intra <int>  Set the size of the intra luma quantization deadzone [%d]\n", defaults->analyse.i_luma_deadzone[1] );
    H2( "                                  Deadzones should be in the range 0 - 32.\n" );
847 848
    H2( "      --cqm <string>          Preset quant matrices [\"%s\"]\n"
        "                                  - %s\n", x264_cqm_names[0], stringify_names( buf, x264_cqm_names ) );
Fiona Glaser's avatar
Fiona Glaser committed
849 850 851
    H1( "      --cqmfile <string>      Read custom quant matrices from a JM-compatible file\n" );
    H2( "                                  Overrides any other --cqm* options.\n" );
    H2( "      --cqm4 <list>           Set all 4x4 quant matrices\n"
852
        "                                  Takes a comma-separated list of 16 integers.\n" );
Fiona Glaser's avatar
Fiona Glaser committed
853
    H2( "      --cqm8 <list>           Set all 8x8 quant matrices\n"
854
        "                                  Takes a comma-separated list of 64 integers.\n" );
855
    H2( "      --cqm4i, --cqm4p, --cqm8i, --cqm8p <list>\n"
856
        "                              Set both luma and chroma quant matrices\n" );
857
    H2( "      --cqm4iy, --cqm4ic, --cqm4py, --cqm4pc <list>\n"
858
        "                              Set individual quant matrices\n" );
Fiona Glaser's avatar
Fiona Glaser committed
859 860 861 862 863 864
    H2( "\n" );
    H2( "Video Usability Info (Annex E):\n" );
    H2( "The VUI settings are not used by the encoder but are merely suggestions to\n" );
    H2( "the playback equipment. See doc/vui.txt for details. Use at your own risk.\n" );
    H2( "\n" );
    H2( "      --overscan <string>     Specify crop overscan setting [\"%s\"]\n"
865 866
        "                                  - undef, show, crop\n",
                                       strtable_lookup( x264_overscan_names, defaults->vui.i_overscan ) );
Fiona Glaser's avatar
Fiona Glaser committed
867
    H2( "      --videoformat <string>  Specify video format [\"%s\"]\n"
868 869
        "                                  - component, pal, ntsc, secam, mac, undef\n",
                                       strtable_lookup( x264_vidformat_names, defaults->vui.i_vidformat ) );
870
    H2( "      --range <string>        Specify color range [\"%s\"]\n"
871
        "                                  - %s\n", x264_range_names[0], stringify_names( buf, x264_range_names ) );
Fiona Glaser's avatar
Fiona Glaser committed
872
    H2( "      --colorprim <string>    Specify color primaries [\"%s\"]\n"
873
        "                                  - undef, bt709, bt470m, bt470bg, smpte170m,\n"
874 875
        "                                    smpte240m, film, bt2020, smpte428,\n"
        "                                    smpte431, smpte432\n",
876
                                       strtable_lookup( x264_colorprim_names, defaults->vui.i_colorprim ) );
Fiona Glaser's avatar
Fiona Glaser committed
877
    H2( "      --transfer <string>     Specify transfer characteristics [\"%s\"]\n"
878 879 880
        "                                  - undef, bt709, bt470m, bt470bg, smpte170m,\n"
        "                                    smpte240m, linear, log100, log316,\n"
        "                                    iec61966-2-4, bt1361e, iec61966-2-1,\n"
881 882
        "                                    bt2020-10, bt2020-12, smpte2084, smpte428,\n"
        "                                    arib-std-b67\n",
883
                                       strtable_lookup( x264_transfer_names, defaults->vui.i_transfer ) );
Fiona Glaser's avatar
Fiona Glaser committed
884
    H2( "      --colormatrix <string>  Specify color matrix setting [\"%s\"]\n"
885
        "                                  - undef, bt709, fcc, bt470bg, smpte170m,\n"
886
        "                                    smpte240m, GBR, YCgCo, bt2020nc, bt2020c,\n"
887 888
        "                                    smpte2085, chroma-derived-nc,\n"
        "                                    chroma-derived-c, ICtCp\n",
889
                                       strtable_lookup( x264_colmatrix_names, defaults->vui.i_colmatrix ) );
Fiona Glaser's avatar
Fiona Glaser committed
890
    H2( "      --chromaloc <integer>   Specify chroma sample location (0 to 5) [%d]\n",
891
                                       defaults->vui.i_chroma_loc );
892 893 894 895
    H2( "      --alternative-transfer <string> Specify an alternative transfer\n"
        "                              characteristics [\"%s\"]\n"
        "                                  - same values as --transfer\n",
                                       strtable_lookup( x264_transfer_names, defaults->i_alternative_transfer ) );
896 897
    H2( "      --nal-hrd <string>      Signal HRD information (requires vbv-bufsize)\n"
        "                                  - none, vbr, cbr (cbr not allowed in .mp4)\n" );
Fiona Glaser's avatar
Fiona Glaser committed
898 899
    H2( "      --filler                Force hard-CBR and generate filler (implied by\n"
        "                              --nal-hrd cbr)\n" );
900
    H2( "      --pic-struct            Force pic_struct in Picture Timing SEI\n" );
901 902
    H2( "      --crop-rect <string>    Add 'left,top,right,bottom' to the bitstream-level\n"
        "                              cropping rectangle\n" );
903

904 905 906
    H0( "\n" );
    H0( "Input/Output:\n" );
    H0( "\n" );
907
    H0( "  -o, --output <string>       Specify output file\n" );
908
    H1( "      --muxer <string>        Specify output container format [\"%s\"]\n"
909
        "                                  - %s\n", x264_muxer_names[0], stringify_names( buf, x264_muxer_names ) );
910
    H1( "      --demuxer <string>      Specify input container format [\"%s\"]\n"
911
        "                                  - %s\n", x264_demuxer_names[0], stringify_names( buf, x264_demuxer_names ) );
912
    H1( "      --input-fmt <string>    Specify input file format (requires lavf support)\n" );
913 914
    H1( "      --input-csp <string>    Specify input colorspace format for raw input\n" );
    print_csp_names( longhelp );
Fiona Glaser's avatar
Fiona Glaser committed
915
    H1( "      --output-csp <string>   Specify output colorspace [\"%s\"]\n"
916 917
        "                                  - %s\n",
#if X264_CHROMA_FORMAT
918
        x264_output_csp_names[0],
919 920 921
#else
        "i420",
#endif
922
        stringify_names( buf, x264_output_csp_names ) );
923
    H1( "      --input-depth <integer> Specify input bit depth for raw input\n" );
924
    H1( "      --output-depth <integer> Specify output bit depth\n" );
925
    H1( "      --input-range <string>  Specify input color range [\"%s\"]\n"
926
        "                                  - %s\n", x264_range_names[0], stringify_names( buf, x264_range_names ) );
927
    H1( "      --input-res <intxint>   Specify input resolution (width x height)\n" );
928
    H1( "      --index <string>        Filename for input index file\n" );
929 930 931 932 933
    H0( "      --sar width:height      Specify Sample Aspect Ratio\n" );
    H0( "      --fps <float|rational>  Specify framerate\n" );
    H0( "      --seek <integer>        First frame to encode\n" );
    H0( "      --frames <integer>      Maximum number of frames to encode\n" );
    H0( "      --level <string>        Specify level (as defined by Annex A)\n" );
934
    H1( "      --bluray-compat         Enable compatibility hacks for Blu-ray support\n" );
935
    H1( "      --avcintra-class <integer> Use compatibility hacks for AVC-Intra class\n"
936
        "                                  - %s\n", stringify_names( buf, x264_avcintra_class_names ) );
937 938
    H1( "      --avcintra-flavor <string> AVC-Intra flavor [\"%s\"]\n"
        "                                  - %s\n", x264_avcintra_flavor_names[0], stringify_names( buf, x264_avcintra_flavor_names ) );
939 940
    H1( "      --stitchable            Don't optimize headers based on video content\n"
        "                              Ensures ability to recombine a segmented encode\n" );
Fiona Glaser's avatar
Fiona Glaser committed
941 942 943
    H1( "\n" );
    H1( "  -v, --verbose               Print stats for each frame\n" );
    H1( "      --no-progress           Don't show the progress indicator while encoding\n" );
944
    H0( "      --quiet                 Quiet Mode\n" );
945
    H1( "      --log-level <string>    Specify the maximum level of logging [\"%s\"]\n"
946 947
        "                                  - %s\n", strtable_lookup( x264_log_level_names, cli_log_level - X264_LOG_NONE ),
                                       stringify_names( buf, x264_log_level_names ) );
Fiona Glaser's avatar
Fiona Glaser committed
948 949 950
    H1( "      --psnr                  Enable PSNR computation\n" );
    H1( "      --ssim                  Enable SSIM computation\n" );
    H1( "      --threads <integer>     Force a specific number of threads\n" );
Fiona Glaser's avatar
Fiona Glaser committed
951
    H2( "      --lookahead-threads <integer> Force a specific number of lookahead threads\n" );
952
    H2( "      --sliced-threads        Low-latency but lower-efficiency threading\n" );
Fiona Glaser's avatar
Fiona Glaser committed
953 954 955
    H2( "      --thread-input          Run Avisynth in its own thread\n" );
    H2( "      --sync-lookahead <integer> Number of buffer frames for threaded lookahead\n" );
    H2( "      --non-deterministic     Slightly improve quality of SMP, at the cost of repeatability\n" );
956 957
    H2( "      --cpu-independent       Ensure exact reproducibility across different cpus,\n"
        "                                  as opposed to letting them select different algorithms\n" );
Fiona Glaser's avatar
Fiona Glaser committed
958 959
    H2( "      --asm <integer>         Override CPU detection\n" );
    H2( "      --no-asm                Disable all CPU optimizations\n" );
Steve Borho's avatar
Steve Borho committed
960 961
    H2( "      --opencl                Enable use of OpenCL\n" );
    H2( "      --opencl-clbin <string> Specify path of compiled OpenCL kernel cache\n" );
Kieran Kunhya's avatar
Kieran Kunhya committed
962
    H2( "      --opencl-device <integer> Specify OpenCL device ordinal\n" );
Fiona Glaser's avatar
Fiona Glaser committed
963 964 965
    H2( "      --dump-yuv <string>     Save reconstructed frames\n" );
    H2( "      --sps-id <integer>      Set SPS and PPS id numbers [%d]\n", defaults->i_sps_id );
    H2( "      --aud                   Use access unit delimiters\n" );
966
    H2( "      --force-cfr             Force constant framerate timestamp generation\n" );
Yusuke Nakamura's avatar
Yusuke Nakamura committed
967 968 969 970 971
    H2( "      --tcfile-in <string>    Force timestamp generation with timecode file\n" );
    H2( "      --tcfile-out <string>   Output timecode v2 file from input timestamps\n" );
    H2( "      --timebase <int/int>    Specify timebase numerator and denominator\n"
        "                 <integer>    Specify timebase numerator for input timecode file\n"
        "                              or specify timebase denominator for other input\n" );
972
    H2( "      --dts-compress          Eliminate initial delay with container DTS hack\n" );
973
    H0( "\n" );
974 975
    H0( "Filtering:\n" );
    H0( "\n" );
976 977 978 979
    H0( "      --vf, --video-filter <filter0>/<filter1>/... Apply video filtering to the input file\n" );
    H0( "\n" );
    H0( "      Filter options may be specified in <filter>:<option>=<value> format.\n" );
    H0( "\n" );
980 981 982 983
    H0( "      Available filters:\n" );
    x264_register_vid_filters();
    x264_vid_filter_help( longhelp );
    H0( "\n" );
984 985
}

Anton Mitrofanov's avatar
Anton Mitrofanov committed
986
typedef enum
Anton Mitrofanov's avatar
Anton Mitrofanov committed
987
{
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
    OPT_FRAMES = 256,
    OPT_SEEK,
    OPT_QPFILE,
    OPT_THREAD_INPUT,
    OPT_QUIET,
    OPT_NOPROGRESS,
    OPT_LONGHELP,
    OPT_PROFILE,
    OPT_PRESET,
    OPT_TUNE,
    OPT_SLOWFIRSTPASS,
    OPT_FULLHELP,
    OPT_FPS,
    OPT_MUXER,
    OPT_DEMUXER,
    OPT_INDEX,
    OPT_INTERLACED,
    OPT_TCFILE_IN,
    OPT_TCFILE_OUT,
    OPT_TIMEBASE,
    OPT_PULLDOWN,
1009 1010
    OPT_LOG_LEVEL,
    OPT_VIDEO_FILTER,
1011
    OPT_INPUT_FMT,
1012
    OPT_INPUT_RES,
1013
    OPT_INPUT_CSP,
1014
    OPT_INPUT_DEPTH,
1015
    OPT_OUTPUT_DEPTH,
Fiona Glaser's avatar
Fiona Glaser committed
1016
    OPT_DTS_COMPRESSION,
1017 1018 1019
    OPT_OUTPUT_CSP,
    OPT_INPUT_RANGE,
    OPT_RANGE
1020
} OptionsOPT;
1021 1022 1023 1024 1025 1026

static char short_options[] = "8A:B:b:f:hI:i:m:o:p:q:r:t:Vvw";
static struct option long_options[] =
{
    { "help",              no_argument, NULL, 'h' },
    { "longhelp",          no_argument, NULL, OPT_LONGHELP },
Fiona Glaser's avatar
Fiona Glaser committed
1027
    { "fullhelp",          no_argument, NULL, OPT_FULLHELP },
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
    { "version",           no_argument, NULL, 'V' },
    { "profile",     required_argument, NULL, OPT_PROFILE },
    { "preset",      required_argument, NULL, OPT_PRESET },
    { "tune",        required_argument, NULL, OPT_TUNE },
    { "slow-firstpass",    no_argument, NULL, OPT_SLOWFIRSTPASS },
    { "bitrate",     required_argument, NULL, 'B' },
    { "bframes",     required_argument, NULL, 'b' },
    { "b-adapt",     required_argument, NULL, 0 },
    { "no-b-adapt",        no_argument, NULL, 0 },
    { "b-bias",      required_argument, NULL, 0 },
1038
    { "b-pyramid",   required_argument, NULL, 0 },
1039 1040
    { "open-gop",          no_argument, NULL, 0 },
    { "bluray-compat",     no_argument, NULL, 0 },
1041
    { "avcintra-class", required_argument, NULL, 0 },
1042
    { "avcintra-flavor", required_argument, NULL, 0 },
1043 1044
    { "min-keyint",  required_argument, NULL, 'i' },
    { "keyint",      required_argument, NULL, 'I' },
Fiona Glaser's avatar
Fiona Glaser committed
1045
    { "intra-refresh",     no_argument, NULL, 0 },
1046 1047 1048 1049 1050 1051
    { "scenecut",    required_argument, NULL, 0 },
    { "no-scenecut",       no_argument, NULL, 0 },
    { "nf",                no_argument, NULL, 0 },
    { "no-deblock",        no_argument, NULL, 0 },
    { "filter",      required_argument, NULL, 0 },
    { "deblock",     required_argument, NULL, 'f' },
1052
    { "interlaced",        no_argument, NULL, OPT_INTERLACED },
1053 1054
    { "tff",               no_argument, NULL, OPT_INTERLACED },
    { "bff",               no_argument, NULL, OPT_INTERLACED },
1055
    { "no-interlaced",     no_argument, NULL, OPT_INTERLACED },
1056
    { "constrained-intra", no_argument, NULL, 0 },
1057 1058 1059 1060 1061 1062 1063
    { "cabac",             no_argument, NULL, 0 },
    { "no-cabac",          no_argument, NULL, 0 },
    { "qp",          required_argument, NULL, 'q' },
    { "qpmin",       required_argument, NULL, 0 },
    { "qpmax",       required_argument, NULL, 0 },
    { "qpstep",      required_argument, NULL, 0 },
    { "crf",         required_argument, NULL, 0 },
1064
    { "rc-lookahead",required_argument, NULL, 0 },
1065 1066 1067
    { "ref",         required_argument, NULL, 'r' },
    { "asm",         required_argument, NULL, 0 },
    { "no-asm",            no_argument, NULL, 0 },
Steve Borho's avatar
Steve Borho committed
1068 1069 1070
    { "opencl",            no_argument, NULL, 1 },
    { "opencl-clbin",required_argument, NULL, 0 },
    { "opencl-device",required_argument, NULL, 0 },
1071
    { "sar",         required_argument, NULL, 0 },
1072
    { "fps",         required_argument, NULL, OPT_FPS },
1073 1074 1075
    { "frames",      required_argument, NULL, OPT_FRAMES },
    { "seek",        required_argument, NULL, OPT_SEEK },
    { "output",      required_argument, NULL, 'o' },
1076 1077 1078 1079 1080
    { "muxer",       required_argument, NULL, OPT_MUXER },
    { "demuxer",     required_argument, NULL, OPT_DEMUXER },
    { "stdout",      required_argument, NULL, OPT_MUXER },
    { "stdin",       required_argument, NULL, OPT_DEMUXER },
    { "index",       required_argument, NULL, OPT_INDEX },
1081 1082 1083 1084 1085
    { "analyse",     required_argument, NULL, 0 },
    { "partitions",  required_argument, NULL, 'A' },
    { "direct",      required_argument, NULL, 0 },
    { "weightb",           no_argument, NULL, 'w' },
    { "no-weightb",        no_argument, NULL, 0 },
1086
    { "weightp",     required_argument, NULL, 0 },
1087 1088 1089 1090 1091 1092
    { "me",          required_argument, NULL, 0 },
    { "merange",     required_argument, NULL, 0 },
    { "mvrange",     required_argument, NULL, 0 },
    { "mvrange-thread", required_argument, NULL, 0 },
    { "subme",       required_argument, NULL, 'm' },
    { "psy-rd",      required_argument, NULL, 0 },
1093 1094
    { "no-psy",            no_argument, NULL, 0 },
    { "psy",               no_argument, NULL, 0 },
1095 1096 1097
    { "mixed-refs",        no_argument, NULL, 0 },
    { "no-mixed-refs",     no_argument, NULL, 0 },
    { "no-chroma-me",      no_argument, NULL, 0 },
1098
    { "8x8dct",            no_argument, NULL, '8' },
1099 1100 1101 1102 1103 1104 1105
    { "no-8x8dct",         no_argument, NULL, 0 },
    { "trellis",     required_argument, NULL, 't' },
    { "fast-pskip",        no_argument, NULL, 0 },
    { "no-fast-pskip",     no_argument, NULL, 0 },
    { "no-dct-decimate",   no_argument, NULL, 0 },
    { "aq-strength", required_argument, NULL, 0 },
    { "aq-mode",     required_argument, NULL, 0 },
1106 1107
    { "deadzone-inter", required_argument, NULL, 0 },
    { "deadzone-intra", required_argument, NULL, 0 },
1108 1109 1110 1111
    { "level",       required_argument, NULL, 0 },
    { "ratetol",     required_argument, NULL, 0 },
    { "vbv-maxrate", required_argument, NULL, 0 },
    { "vbv-bufsize", required_argument, NULL, 0 },
1112 1113
    { "vbv-init",    required_argument, NULL, 0 },
    { "crf-max",     required_argument, NULL, 0 },
1114 1115 1116 1117 1118 1119
    { "ipratio",     required_argument, NULL, 0 },
    { "pbratio",     required_argument, NULL, 0 },
    { "chroma-qp-offset", required_argument, NULL, 0 },
    { "pass",        required_argument, NULL, 'p' },
    { "stats",       required_argument, NULL, 0 },
    { "qcomp",       required_argument, NULL, 0 },
1120 1121
    { "mbtree",            no_argument, NULL, 0 },
    { "no-mbtree",         no_argument, NULL, 0 },
1122 1123 1124 1125 1126
    { "qblur",       required_argument, NULL, 0 },
    { "cplxblur",    required_argument, NULL, 0 },
    { "zones",       required_argument, NULL, 0 },
    { "qpfile",      required_argument, NULL, OPT_QPFILE },
    { "threads",     required_argument, NULL, 0 },
Fiona Glaser's avatar
Fiona Glaser committed
1127
    { "lookahead-threads", required_argument, NULL, 0 },
1128 1129
    { "sliced-threads",    no_argument, NULL, 0 },
    { "no-sliced-threads", no_argument, NULL, 0 },
1130 1131
    { "slice-max-size",    required_argument, NULL, 0 },
    { "slice-max-mbs",     required_argument, NULL, 0 },
Fiona Glaser's avatar
Fiona Glaser committed
1132
    { "slice-min-mbs",     required_argument, NULL, 0 },
1133
    { "slices",            required_argument, NULL, 0 },
Fiona Glaser's avatar
Fiona Glaser committed
1134
    { "slices-max",        required_argument, NULL, 0 },
1135
    { "thread-input",      no_argument, NULL, OPT_THREAD_INPUT },
Steven Walters's avatar
Steven Walters committed
1136
    { "sync-lookahead",    required_argument, NULL, 0 },
1137
    { "non-deterministic", no_argument, NULL, 0 },
1138
    { "cpu-independent",   no_argument, NULL, 0 },
1139 1140 1141 1142
    { "psnr",              no_argument, NULL, 0 },
    { "ssim",              no_argument, NULL, 0 },
    { "quiet",             no_argument, NULL, OPT_QUIET },
    { "verbose",           no_argument, NULL, 'v' },
1143
    { "log-level",   required_argument, NULL, OPT_LOG_LEVEL },
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
    { "no-progress",       no_argument, NULL, OPT_NOPROGRESS },
    { "dump-yuv",    required_argument, NULL, 0 },
    { "sps-id",      required_argument, NULL, 0 },
    { "aud",               no_argument, NULL, 0 },
    { "nr",          required_argument, NULL, 0 },
    { "cqm",         required_argument, NULL, 0 },
    { "cqmfile",     required_argument, NULL, 0 },
    { "cqm4",        required_argument, NULL, 0 },
    { "cqm4i",       required_argument, NULL, 0 },
    { "cqm4iy",      required_argument, NULL, 0 },
    { "cqm4ic",      required_argument, NULL, 0 },
    { "cqm4p",       required_argument, NULL, 0 },
    { "cqm4py",      required_argument, NULL, 0 },
    { "cqm4pc",      required_argument, NULL, 0 },
    { "cqm8",        required_argument, NULL, 0 },
    { "cqm8i",       required_argument, NULL, 0 },
    { "cqm8p",       required_argument, NULL, 0 },
    { "overscan",    required_argument, NULL, 0 },
    { "videoformat", required_argument, NULL, 0 },
1163
    { "range",       required_argument, NULL, OPT_RANGE },
1164 1165 1166 1167
    { "colorprim",   required_argument, NULL, 0 },
    { "transfer",    required_argument, NULL, 0 },
    { "colormatrix", required_argument, NULL, 0 },
    { "chromaloc",   required_argument, NULL, 0 },
1168
    { "force-cfr",         no_argument, NULL, 0 },
Yusuke Nakamura's avatar
Yusuke Nakamura committed
1169 1170 1171
    { "tcfile-in",   required_argument, NULL, OPT_TCFILE_IN },
    { "tcfile-out",  required_argument, NULL, OPT_TCFILE_OUT },
    { "timebase",    required_argument, NULL, OPT_TIMEBASE },
1172
    { "pic-struct",        no_argument, NULL, 0 },
1173
    { "crop-rect",   required_argument, NULL, 0 },
1174 1175
    { "nal-hrd",     required_argument, NULL, 0 },
    { "pulldown",    required_argument, NULL, OPT_PULLDOWN },
1176
    { "fake-interlaced",   no_argument, NULL, 0 },
1177
    { "frame-packing",     required_argument, NULL, 0 },
1178
    { "alternative-transfer", required_argument, NULL, 0 },
1179 1180
    { "vf",          required_argument, NULL, OPT_VIDEO_FILTER },
    { "video-filter", required_argument, NULL, OPT_VIDEO_FILTER },
1181
    { "input-fmt",   required_argument, NULL, OPT_INPUT_FMT },
1182 1183
    { "input-res",   required_argument, NULL, OPT_INPUT_RES },
    { "input-csp",   required_argument, NULL, OPT_INPUT_CSP },
1184
    { "input-depth", required_argument, NULL, OPT_INPUT_DEPTH },
1185
    { "output-depth", required_argument, NULL, OPT_OUTPUT_DEPTH },
1186
    { "dts-compress",      no_argument, NULL, OPT_DTS_COMPRESSION },
Fiona Glaser's avatar
Fiona Glaser committed
1187
    { "output-csp",  required_argument, NULL, OPT_OUTPUT_CSP },
1188
    { "input-range", required_argument, NULL, OPT_INPUT_RANGE },
1189
    { "stitchable",        no_argument, NULL, 0 },
Fiona Glaser's avatar
Fiona Glaser committed
1190
    { "filler",            no_argument, NULL, 0 },
1191 1192 1193
    {0, 0, 0, 0}
};

1194
static int select_output( const char *muxer, char *filename, x264_param_t *param )
1195
{
1196
    const char *ext = get_filename_extension( filename );
1197 1198
    if( !strcmp( filename, "-" ) || strcasecmp( muxer, "auto" ) )
        ext = muxer;
1199

Fiona Glaser's avatar
Fiona Glaser committed
1200
    if( !strcasecmp( ext, "mp4" ) )
1201
    {
1202
#if HAVE_GPAC || HAVE_LSMASH
Anton Mitrofanov's avatar
Anton Mitrofanov committed
1203
        cli_output = mp4_output;