git.sesse.net Git - x264/blob - x264.h

   1 /*****************************************************************************
   2  * x264.h: h264 encoder library
   3  *****************************************************************************
   4  * Copyright (C) 2003-2008 x264 Project
   5  *
   6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   7  *          Loren Merritt <lorenm@u.washington.edu>
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 #ifndef X264_X264_H
  25 #define X264_X264_H
  26
  27 #if !defined(_STDINT_H) && !defined(_STDINT_H_) && \
  28     !defined(_INTTYPES_H) && !defined(_INTTYPES_H_)
  29 # ifdef _MSC_VER
  30 #  pragma message("You must include stdint.h or inttypes.h before x264.h")
  31 # else
  32 #  warning You must include stdint.h or inttypes.h before x264.h
  33 # endif
  34 #endif
  35
  36 #include <stdarg.h>
  37
  38 #define X264_BUILD 100
  39
  40 /* x264_t:
  41  *      opaque handler for encoder */
  42 typedef struct x264_t x264_t;
  43
  44 /****************************************************************************
  45  * Encoder parameters
  46  ****************************************************************************/
  47 /* CPU flags
  48  */
  49 #define X264_CPU_CACHELINE_32   0x000001  /* avoid memory loads that span the border between two cachelines */
  50 #define X264_CPU_CACHELINE_64   0x000002  /* 32/64 is the size of a cacheline in bytes */
  51 #define X264_CPU_ALTIVEC        0x000004
  52 #define X264_CPU_MMX            0x000008
  53 #define X264_CPU_MMXEXT         0x000010  /* MMX2 aka MMXEXT aka ISSE */
  54 #define X264_CPU_SSE            0x000020
  55 #define X264_CPU_SSE2           0x000040
  56 #define X264_CPU_SSE2_IS_SLOW   0x000080  /* avoid most SSE2 functions on Athlon64 */
  57 #define X264_CPU_SSE2_IS_FAST   0x000100  /* a few functions are only faster on Core2 and Phenom */
  58 #define X264_CPU_SSE3           0x000200
  59 #define X264_CPU_SSSE3          0x000400
  60 #define X264_CPU_SHUFFLE_IS_FAST 0x000800 /* Penryn, Nehalem, and Phenom have fast shuffle units */
  61 #define X264_CPU_STACK_MOD4     0x001000  /* if stack is only mod4 and not mod16 */
  62 #define X264_CPU_SSE4           0x002000  /* SSE4.1 */
  63 #define X264_CPU_SSE42          0x004000  /* SSE4.2 */
  64 #define X264_CPU_SSE_MISALIGN   0x008000  /* Phenom support for misaligned SSE instruction arguments */
  65 #define X264_CPU_LZCNT          0x010000  /* Phenom support for "leading zero count" instruction. */
  66 #define X264_CPU_ARMV6          0x020000
  67 #define X264_CPU_NEON           0x040000  /* ARM NEON */
  68 #define X264_CPU_FAST_NEON_MRC  0x080000  /* Transfer from NEON to ARM register is fast (Cortex-A9) */
  69 #define X264_CPU_SLOW_CTZ       0x100000  /* BSR/BSF x86 instructions are really slow on some CPUs */
  70 #define X264_CPU_SLOW_ATOM      0x200000  /* The Atom just sucks */
  71
  72 /* Analyse flags
  73  */
  74 #define X264_ANALYSE_I4x4       0x0001  /* Analyse i4x4 */
  75 #define X264_ANALYSE_I8x8       0x0002  /* Analyse i8x8 (requires 8x8 transform) */
  76 #define X264_ANALYSE_PSUB16x16  0x0010  /* Analyse p16x8, p8x16 and p8x8 */
  77 #define X264_ANALYSE_PSUB8x8    0x0020  /* Analyse p8x4, p4x8, p4x4 */
  78 #define X264_ANALYSE_BSUB16x16  0x0100  /* Analyse b16x8, b8x16 and b8x8 */
  79 #define X264_DIRECT_PRED_NONE        0
  80 #define X264_DIRECT_PRED_SPATIAL     1
  81 #define X264_DIRECT_PRED_TEMPORAL    2
  82 #define X264_DIRECT_PRED_AUTO        3
  83 #define X264_ME_DIA                  0
  84 #define X264_ME_HEX                  1
  85 #define X264_ME_UMH                  2
  86 #define X264_ME_ESA                  3
  87 #define X264_ME_TESA                 4
  88 #define X264_CQM_FLAT                0
  89 #define X264_CQM_JVT                 1
  90 #define X264_CQM_CUSTOM              2
  91 #define X264_RC_CQP                  0
  92 #define X264_RC_CRF                  1
  93 #define X264_RC_ABR                  2
  94 #define X264_AQ_NONE                 0
  95 #define X264_AQ_VARIANCE             1
  96 #define X264_AQ_AUTOVARIANCE         2
  97 #define X264_B_ADAPT_NONE            0
  98 #define X264_B_ADAPT_FAST            1
  99 #define X264_B_ADAPT_TRELLIS         2
 100 #define X264_WEIGHTP_NONE            0
 101 #define X264_WEIGHTP_BLIND           1
 102 #define X264_WEIGHTP_SMART           2
 103 #define X264_B_PYRAMID_NONE          0
 104 #define X264_B_PYRAMID_STRICT        1
 105 #define X264_B_PYRAMID_NORMAL        2
 106 #define X264_KEYINT_MIN_AUTO         0
 107 #define X264_OPEN_GOP_NONE           0
 108 #define X264_OPEN_GOP_DISPLAY_ORDER  1
 109 #define X264_OPEN_GOP_CODED_ORDER    2
 110
 111 static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
 112 static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
 113 static const char * const x264_b_pyramid_names[] = { "none", "strict", "normal", 0 };
 114 static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
 115 static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
 116 static const char * const x264_fullrange_names[] = { "off", "on", 0 };
 117 static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", 0 };
 118 static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316", 0 };
 119 static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", 0 };
 120 static const char * const x264_nal_hrd_names[] = { "none", "vbr", "cbr", 0 };
 121 static const char * const x264_open_gop_names[] = { "none", "display", "coded", 0 };
 122
 123 /* Colorspace type
 124  * legacy only; nothing other than I420 is really supported. */
 125 #define X264_CSP_MASK           0x00ff  /* */
 126 #define X264_CSP_NONE           0x0000  /* Invalid mode     */
 127 #define X264_CSP_I420           0x0001  /* yuv 4:2:0 planar */
 128 #define X264_CSP_I422           0x0002  /* yuv 4:2:2 planar */
 129 #define X264_CSP_I444           0x0003  /* yuv 4:4:4 planar */
 130 #define X264_CSP_YV12           0x0004  /* yuv 4:2:0 planar */
 131 #define X264_CSP_YUYV           0x0005  /* yuv 4:2:2 packed */
 132 #define X264_CSP_RGB            0x0006  /* rgb 24bits       */
 133 #define X264_CSP_BGR            0x0007  /* bgr 24bits       */
 134 #define X264_CSP_BGRA           0x0008  /* bgr 32bits       */
 135 #define X264_CSP_MAX            0x0009  /* end of list */
 136 #define X264_CSP_VFLIP          0x1000  /* */
 137
 138 /* Slice type */
 139 #define X264_TYPE_AUTO          0x0000  /* Let x264 choose the right type */
 140 #define X264_TYPE_IDR           0x0001
 141 #define X264_TYPE_I             0x0002
 142 #define X264_TYPE_P             0x0003
 143 #define X264_TYPE_BREF          0x0004  /* Non-disposable B-frame */
 144 #define X264_TYPE_B             0x0005
 145 #define X264_TYPE_KEYFRAME      0x0006  /* IDR or I depending on b_open_gop option */
 146 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
 147 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
 148
 149 /* Log level */
 150 #define X264_LOG_NONE          (-1)
 151 #define X264_LOG_ERROR          0
 152 #define X264_LOG_WARNING        1
 153 #define X264_LOG_INFO           2
 154 #define X264_LOG_DEBUG          3
 155
 156 /* Threading */
 157 #define X264_THREADS_AUTO 0 /* Automatically select optimal number of threads */
 158 #define X264_SYNC_LOOKAHEAD_AUTO (-1) /* Automatically select optimal lookahead thread buffer size */
 159
 160 /* HRD */
 161 #define X264_NAL_HRD_NONE            0
 162 #define X264_NAL_HRD_VBR             1
 163 #define X264_NAL_HRD_CBR             2
 164
 165 /* Zones: override ratecontrol or other options for specific sections of the video.
 166  * See x264_encoder_reconfig() for which options can be changed.
 167  * If zones overlap, whichever comes later in the list takes precedence. */
 168 typedef struct
 169 {
 170     int i_start, i_end; /* range of frame numbers */
 171     int b_force_qp; /* whether to use qp vs bitrate factor */
 172     int i_qp;
 173     float f_bitrate_factor;
 174     struct x264_param_t *param;
 175 } x264_zone_t;
 176
 177 typedef struct x264_param_t
 178 {
 179     /* CPU flags */
 180     unsigned int cpu;
 181     int         i_threads;       /* encode multiple frames in parallel */
 182     int         b_sliced_threads;  /* Whether to use slice-based threading. */
 183     int         b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
 184     int         i_sync_lookahead; /* threaded lookahead buffer */
 185
 186     /* Video Properties */
 187     int         i_width;
 188     int         i_height;
 189     int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
 190     int         i_level_idc;
 191     int         i_frame_total; /* number of frames to encode if known, else 0 */
 192
 193     /* NAL HRD
 194      * Uses Buffering and Picture Timing SEIs to signal HRD
 195      * The HRD in H.264 was not designed with VFR in mind.
 196      * It is therefore not recommendeded to use NAL HRD with VFR.
 197      * Furthermore, reconfiguring the VBV (via x264_encoder_reconfig)
 198      * will currently generate invalid HRD. */
 199     int         i_nal_hrd;
 200
 201     struct
 202     {
 203         /* they will be reduced to be 0 < x <= 65535 and prime */
 204         int         i_sar_height;
 205         int         i_sar_width;
 206
 207         int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
 208
 209         /* see h264 annex E for the values of the following */
 210         int         i_vidformat;
 211         int         b_fullrange;
 212         int         i_colorprim;
 213         int         i_transfer;
 214         int         i_colmatrix;
 215         int         i_chroma_loc;    /* both top & bottom */
 216     } vui;
 217
 218     /* Bitstream parameters */
 219     int         i_frame_reference;  /* Maximum number of reference frames */
 220     int         i_dpb_size;         /* Force a DPB size larger than that implied by B-frames and reference frames.
 221                                      * Useful in combination with interactive error resilience. */
 222     int         i_keyint_max;       /* Force an IDR keyframe at this interval */
 223     int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
 224     int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
 225     int         b_intra_refresh;    /* Whether or not to use periodic intra refresh instead of IDR frames. */
 226
 227     int         i_bframe;   /* how many b-frame between 2 references pictures */
 228     int         i_bframe_adaptive;
 229     int         i_bframe_bias;
 230     int         i_bframe_pyramid;   /* Keep some B-frames as references: 0=off, 1=strict hierarchical, 2=normal */
 231     int         i_open_gop;         /* Open gop: 1=display order, 2=coded order to determine gop size */
 232
 233     int         b_deblocking_filter;
 234     int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
 235     int         i_deblocking_filter_beta;       /* [-6, 6]  idem */
 236
 237     int         b_cabac;
 238     int         i_cabac_init_idc;
 239
 240     int         b_interlaced;
 241     int         b_constrained_intra;
 242
 243     int         i_cqm_preset;
 244     char        *psz_cqm_file;      /* JM format */
 245     uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
 246     uint8_t     cqm_4ic[16];
 247     uint8_t     cqm_4py[16];
 248     uint8_t     cqm_4pc[16];
 249     uint8_t     cqm_8iy[64];
 250     uint8_t     cqm_8py[64];
 251
 252     /* Log */
 253     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
 254     void        *p_log_private;
 255     int         i_log_level;
 256     int         b_visualize;
 257     char        *psz_dump_yuv;  /* filename for reconstructed frames */
 258
 259     /* Encoder analyser parameters */
 260     struct
 261     {
 262         unsigned int intra;     /* intra partitions */
 263         unsigned int inter;     /* inter partitions */
 264
 265         int          b_transform_8x8;
 266         int          i_weighted_pred; /* weighting for P-frames */
 267         int          b_weighted_bipred; /* implicit weighting for B-frames */
 268         int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
 269         int          i_chroma_qp_offset;
 270
 271         int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
 272         int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
 273         int          i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
 274         int          i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
 275         int          i_subpel_refine; /* subpixel motion estimation quality */
 276         int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
 277         int          b_mixed_references; /* allow each mb partition to have its own reference number */
 278         int          i_trellis;  /* trellis RD quantization */
 279         int          b_fast_pskip; /* early SKIP detection on P-frames */
 280         int          b_dct_decimate; /* transform coefficient thresholding on P-frames */
 281         int          i_noise_reduction; /* adaptive pseudo-deadzone */
 282         float        f_psy_rd; /* Psy RD strength */
 283         float        f_psy_trellis; /* Psy trellis strength */
 284         int          b_psy; /* Toggle all psy optimizations */
 285
 286         /* the deadzone size that will be used in luma quantization */
 287         int          i_luma_deadzone[2]; /* {inter, intra} */
 288
 289         int          b_psnr;    /* compute and print PSNR stats */
 290         int          b_ssim;    /* compute and print SSIM stats */
 291     } analyse;
 292
 293     /* Rate control parameters */
 294     struct
 295     {
 296         int         i_rc_method;    /* X264_RC_* */
 297
 298         int         i_qp_constant;  /* 0-51 */
 299         int         i_qp_min;       /* min allowed QP value */
 300         int         i_qp_max;       /* max allowed QP value */
 301         int         i_qp_step;      /* max QP step between frames */
 302
 303         int         i_bitrate;
 304         float       f_rf_constant;  /* 1pass VBR, nominal QP */
 305         float       f_rf_constant_max;  /* In CRF mode, maximum CRF as caused by VBV */
 306         float       f_rate_tolerance;
 307         int         i_vbv_max_bitrate;
 308         int         i_vbv_buffer_size;
 309         float       f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
 310         float       f_ip_factor;
 311         float       f_pb_factor;
 312
 313         int         i_aq_mode;      /* psy adaptive QP. (X264_AQ_*) */
 314         float       f_aq_strength;
 315         int         b_mb_tree;      /* Macroblock-tree ratecontrol. */
 316         int         i_lookahead;
 317
 318         /* 2pass */
 319         int         b_stat_write;   /* Enable stat writing in psz_stat_out */
 320         char        *psz_stat_out;
 321         int         b_stat_read;    /* Read stat from psz_stat_in and use it */
 322         char        *psz_stat_in;
 323
 324         /* 2pass params (same as ffmpeg ones) */
 325         float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
 326         float       f_qblur;        /* temporally blur quants */
 327         float       f_complexity_blur; /* temporally blur complexity */
 328         x264_zone_t *zones;         /* ratecontrol overrides */
 329         int         i_zones;        /* number of zone_t's */
 330         char        *psz_zones;     /* alternate method of specifying zones */
 331     } rc;
 332
 333     /* Muxing parameters */
 334     int b_aud;                  /* generate access unit delimiters */
 335     int b_repeat_headers;       /* put SPS/PPS before each keyframe */
 336     int b_annexb;               /* if set, place start codes (4 bytes) before NAL units,
 337                                  * otherwise place size (4 bytes) before NAL units. */
 338     int i_sps_id;               /* SPS and PPS id number */
 339     int b_vfr_input;            /* VFR input */
 340     uint32_t i_fps_num;
 341     uint32_t i_fps_den;
 342     uint32_t i_timebase_num;    /* Timebase numerator */
 343     uint32_t i_timebase_den;    /* Timebase denominator */
 344     int b_dts_compress;         /* DTS compression: this algorithm eliminates negative DTS
 345                                  * by compressing them to be less than the second PTS.
 346                                  * Warning: this will change the timebase! */
 347
 348     int b_tff;
 349
 350     /* Pulldown:
 351      * The correct pic_struct must be passed with each input frame.
 352      * The input timebase should be the timebase corresponding to the output framerate. This should be constant.
 353      * e.g. for 3:2 pulldown timebase should be 1001/30000
 354      * The PTS passed with each frame must be the PTS of the frame after pulldown is applied.
 355      * Frame doubling and tripling require b_vfr_input set to zero (see H.264 Table D-1)
 356      *
 357      * Pulldown changes are not clearly defined in H.264. Therefore, it is the calling app's responsibility to manage this.
 358      */
 359
 360     int b_pic_struct;
 361
 362     /* Fake Interlaced.
 363      *
 364      * Used only when b_interlaced=0. Setting this flag makes it possible to flag the stream as PAFF interlaced yet
 365      * encode all frames progessively. It is useful for encoding 25p and 30p Blu-Ray streams.
 366      */
 367
 368     int b_fake_interlaced;
 369
 370     /* Slicing parameters */
 371     int i_slice_max_size;    /* Max size per slice in bytes; includes estimated NAL overhead. */
 372     int i_slice_max_mbs;     /* Max number of MBs per slice; overrides i_slice_count. */
 373     int i_slice_count;       /* Number of slices per frame: forces rectangular slices. */
 374
 375     /* Optional callback for freeing this x264_param_t when it is done being used.
 376      * Only used when the x264_param_t sits in memory for an indefinite period of time,
 377      * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
 378      * Not used when x264_encoder_reconfig is called directly. */
 379     void (*param_free)( void* );
 380 } x264_param_t;
 381
 382 /****************************************************************************
 383  * H.264 level restriction information
 384  ****************************************************************************/
 385
 386 typedef struct {
 387     int level_idc;
 388     int mbps;        /* max macroblock processing rate (macroblocks/sec) */
 389     int frame_size;  /* max frame size (macroblocks) */
 390     int dpb;         /* max decoded picture buffer (bytes) */
 391     int bitrate;     /* max bitrate (kbit/sec) */
 392     int cpb;         /* max vbv buffer (kbit) */
 393     int mv_range;    /* max vertical mv component range (pixels) */
 394     int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
 395     int slice_rate;  /* ?? */
 396     int mincr;       /* min compression ratio */
 397     int bipred8x8;   /* limit bipred to >=8x8 */
 398     int direct8x8;   /* limit b_direct to >=8x8 */
 399     int frame_only;  /* forbid interlacing */
 400 } x264_level_t;
 401
 402 /* all of the levels defined in the standard, terminated by .level_idc=0 */
 403 extern const x264_level_t x264_levels[];
 404
 405 /****************************************************************************
 406  * Basic parameter handling functions
 407  ****************************************************************************/
 408
 409 /* x264_param_default:
 410  *      fill x264_param_t with default values and do CPU detection */
 411 void    x264_param_default( x264_param_t * );
 412
 413 /* x264_param_parse:
 414  *  set one parameter by name.
 415  *  returns 0 on success, or returns one of the following errors.
 416  *  note: BAD_VALUE occurs only if it can't even parse the value,
 417  *  numerical range is not checked until x264_encoder_open() or
 418  *  x264_encoder_reconfig().
 419  *  value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
 420 #define X264_PARAM_BAD_NAME  (-1)
 421 #define X264_PARAM_BAD_VALUE (-2)
 422 int x264_param_parse( x264_param_t *, const char *name, const char *value );
 423
 424 /****************************************************************************
 425  * Advanced parameter handling functions
 426  ****************************************************************************/
 427
 428 /* These functions expose the full power of x264's preset-tune-profile system for
 429  * easy adjustment of large numbers of internal parameters.
 430  *
 431  * In order to replicate x264CLI's option handling, these functions MUST be called
 432  * in the following order:
 433  * 1) x264_param_default_preset
 434  * 2) Custom user options (via param_parse or directly assigned variables)
 435  * 3) x264_param_apply_fastfirstpass
 436  * 4) x264_param_apply_profile
 437  *
 438  * Additionally, x264CLI does not apply step 3 if the preset chosen is "placebo"
 439  * or --slow-firstpass is set. */
 440
 441 /* x264_param_default_preset:
 442  *      The same as x264_param_default, but also use the passed preset and tune
 443  *      to modify the default settings.
 444  *      (either can be NULL, which implies no preset or no tune, respectively)
 445  *
 446  *      Currently available presets are, ordered from fastest to slowest: */
 447 static const char * const x264_preset_names[] = { "ultrafast", "superfast", "veryfast", "faster", "fast", "medium", "slow", "slower", "veryslow", "placebo", 0 };
 448
 449 /*      Warning: the speed of these presets scales dramatically.  Ultrafast is a full
 450  *      100 times faster than placebo!
 451  *
 452  *      Currently available tunings are: */
 453 static const char * const x264_tune_names[] = { "film", "animation", "grain", "stillimage", "psnr", "ssim", "fastdecode", "zerolatency", 0 };
 454
 455 /*      Multiple tunings can be used if separated by a delimiter in ",./-+",
 456  *      however multiple psy tunings cannot be used.
 457  *      film, animation, grain, stillimage, psnr, and ssim are psy tunings.
 458  *
 459  *      returns 0 on success, negative on failure (e.g. invalid preset/tune name). */
 460 int     x264_param_default_preset( x264_param_t *, const char *preset, const char *tune );
 461
 462 /* x264_param_apply_fastfirstpass:
 463  *      If first-pass mode is set (rc.b_stat_read == 0, rc.b_stat_write == 1),
 464  *      modify the encoder settings to disable options generally not useful on
 465  *      the first pass. */
 466 void    x264_param_apply_fastfirstpass( x264_param_t * );
 467
 468 /* x264_param_apply_profile:
 469  *      Applies the restrictions of the given profile.
 470  *      Currently available profiles are, from most to least restrictive: */
 471 static const char * const x264_profile_names[] = { "baseline", "main", "high", 0 };
 472
 473 /*      (can be NULL, in which case the function will do nothing)
 474  *
 475  *      Does NOT guarantee that the given profile will be used: if the restrictions
 476  *      of "High" are applied to settings that are already Baseline-compatible, the
 477  *      stream will remain baseline.  In short, it does not increase settings, only
 478  *      decrease them.
 479  *
 480  *      returns 0 on success, negative on failure (e.g. invalid profile name). */
 481 int     x264_param_apply_profile( x264_param_t *, const char *profile );
 482
 483 /****************************************************************************
 484  * Picture structures and functions
 485  ****************************************************************************/
 486
 487 enum pic_struct_e
 488 {
 489     PIC_STRUCT_AUTO              = 0, // automatically decide (default)
 490     PIC_STRUCT_PROGRESSIVE       = 1, // progressive frame
 491     // "TOP" and "BOTTOM" are not supported in x264 (PAFF only)
 492     PIC_STRUCT_TOP_BOTTOM        = 4, // top field followed by bottom
 493     PIC_STRUCT_BOTTOM_TOP        = 5, // bottom field followed by top
 494     PIC_STRUCT_TOP_BOTTOM_TOP    = 6, // top field, bottom field, top field repeated
 495     PIC_STRUCT_BOTTOM_TOP_BOTTOM = 7, // bottom field, top field, bottom field repeated
 496     PIC_STRUCT_DOUBLE            = 8, // double frame
 497     PIC_STRUCT_TRIPLE            = 9, // triple frame
 498 };
 499
 500 typedef struct
 501 {
 502     double cpb_initial_arrival_time;
 503     double cpb_final_arrival_time;
 504     double cpb_removal_time;
 505
 506     double dpb_output_time;
 507 } x264_hrd_t;
 508
 509 typedef struct
 510 {
 511     int     i_csp;       /* Colorspace */
 512     int     i_plane;     /* Number of image planes */
 513     int     i_stride[4]; /* Strides for each plane */
 514     uint8_t *plane[4];   /* Pointers to each plane */
 515 } x264_image_t;
 516
 517 typedef struct
 518 {
 519     /* In: an array of quantizer offsets to be applied to this image during encoding.
 520      *     These are added on top of the decisions made by x264.
 521      *     Offsets can be fractional; they are added before QPs are rounded to integer.
 522      *     Adaptive quantization must be enabled to use this feature.  Behavior if quant
 523      *     offsets differ between encoding passes is undefined.
 524      *
 525      *     Array contains one offset per macroblock, in raster scan order.  In interlaced
 526      *     mode, top-field MBs and bottom-field MBs are interleaved at the row level. */
 527     float *quant_offsets;
 528     /* In: optional callback to free quant_offsets when used.
 529      *     Useful if one wants to use a different quant_offset array for each frame. */
 530     void (*quant_offsets_free)( void* );
 531 } x264_image_properties_t;
 532
 533 typedef struct
 534 {
 535     /* In: force picture type (if not auto)
 536      *     If x264 encoding parameters are violated in the forcing of picture types,
 537      *     x264 will correct the input picture type and log a warning.
 538      *     The quality of frametype decisions may suffer if a great deal of fine-grained
 539      *     mixing of auto and forced frametypes is done.
 540      * Out: type of the picture encoded */
 541     int     i_type;
 542     /* In: force quantizer for > 0 */
 543     int     i_qpplus1;
 544     /* In: pic_struct, for pulldown/doubling/etc...used only if b_pic_timing_sei=1.
 545      *     use pic_struct_e for pic_struct inputs */
 546     int     i_pic_struct;
 547     /* Out: whether this frame is a keyframe.  Important when using modes that result in
 548      * SEI recovery points being used instead of IDR frames. */
 549     int     b_keyframe;
 550     /* In: user pts, Out: pts of encoded picture (user)*/
 551     int64_t i_pts;
 552     /* Out: frame dts. Since the pts of the first frame is always zero,
 553      *      initial frames may have a negative dts which must be dealt with by any muxer */
 554     int64_t i_dts;
 555     /* In: custom encoding parameters to be set from this frame forwards
 556            (in coded order, not display order). If NULL, continue using
 557            parameters from the previous frame.  Some parameters, such as
 558            aspect ratio, can only be changed per-GOP due to the limitations
 559            of H.264 itself; in this case, the caller must force an IDR frame
 560            if it needs the changed parameter to apply immediately. */
 561     x264_param_t *param;
 562     /* In: raw data */
 563     x264_image_t img;
 564     /* In: optional information to modify encoder decisions for this frame */
 565     x264_image_properties_t prop;
 566     /* Out: HRD timing information. Output only when i_nal_hrd is set. */
 567     x264_hrd_t hrd_timing;
 568     /* private user data. libx264 doesn't touch this,
 569        not even copy it from input to output frames. */
 570     void *opaque;
 571 } x264_picture_t;
 572
 573 /* x264_picture_init:
 574  *  initialize an x264_picture_t.  Needs to be done if the calling application
 575  *  allocates its own x264_picture_t as opposed to using x264_picture_alloc. */
 576 void x264_picture_init( x264_picture_t *pic );
 577
 578 /* x264_picture_alloc:
 579  *  alloc data for a picture. You must call x264_picture_clean on it.
 580  *  returns 0 on success, or -1 on malloc failure. */
 581 int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
 582
 583 /* x264_picture_clean:
 584  *  free associated resource for a x264_picture_t allocated with
 585  *  x264_picture_alloc ONLY */
 586 void x264_picture_clean( x264_picture_t *pic );
 587
 588 /****************************************************************************
 589  * NAL structure and functions
 590  ****************************************************************************/
 591
 592 enum nal_unit_type_e
 593 {
 594     NAL_UNKNOWN     = 0,
 595     NAL_SLICE       = 1,
 596     NAL_SLICE_DPA   = 2,
 597     NAL_SLICE_DPB   = 3,
 598     NAL_SLICE_DPC   = 4,
 599     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
 600     NAL_SEI         = 6,    /* ref_idc == 0 */
 601     NAL_SPS         = 7,
 602     NAL_PPS         = 8,
 603     NAL_AUD         = 9,
 604     NAL_FILLER      = 12,
 605     /* ref_idc == 0 for 6,9,10,11,12 */
 606 };
 607 enum nal_priority_e
 608 {
 609     NAL_PRIORITY_DISPOSABLE = 0,
 610     NAL_PRIORITY_LOW        = 1,
 611     NAL_PRIORITY_HIGH       = 2,
 612     NAL_PRIORITY_HIGHEST    = 3,
 613 };
 614
 615 /* The data within the payload is already NAL-encapsulated; the ref_idc and type
 616  * are merely in the struct for easy access by the calling application.
 617  * All data returned in an x264_nal_t, including the data in p_payload, is no longer
 618  * valid after the next call to x264_encoder_encode.  Thus it must be used or copied
 619  * before calling x264_encoder_encode or x264_encoder_headers again. */
 620 typedef struct
 621 {
 622     int i_ref_idc;  /* nal_priority_e */
 623     int i_type;     /* nal_unit_type_e */
 624
 625     /* Size of payload in bytes. */
 626     int     i_payload;
 627     /* If param->b_annexb is set, Annex-B bytestream with 4-byte startcode.
 628      * Otherwise, startcode is replaced with a 4-byte size.
 629      * This size is the size used in mp4/similar muxing; it is equal to i_payload-4 */
 630     uint8_t *p_payload;
 631 } x264_nal_t;
 632
 633 /****************************************************************************
 634  * Encoder functions
 635  ****************************************************************************/
 636
 637 /* Force a link error in the case of linking against an incompatible API version.
 638  * Glue #defines exist to force correct macro expansion; the final output of the macro
 639  * is x264_encoder_open_##X264_BUILD (for purposes of dlopen). */
 640 #define x264_encoder_glue1(x,y) x##y
 641 #define x264_encoder_glue2(x,y) x264_encoder_glue1(x,y)
 642 #define x264_encoder_open x264_encoder_glue2(x264_encoder_open_,X264_BUILD)
 643
 644 /* x264_encoder_open:
 645  *      create a new encoder handler, all parameters from x264_param_t are copied */
 646 x264_t *x264_encoder_open( x264_param_t * );
 647
 648 /* x264_encoder_reconfig:
 649  *      various parameters from x264_param_t are copied.
 650  *      this takes effect immediately, on whichever frame is encoded next;
 651  *      due to delay, this may not be the next frame passed to encoder_encode.
 652  *      if the change should apply to some particular frame, use x264_picture_t->param instead.
 653  *      returns 0 on success, negative on parameter validation error.
 654  *      not all parameters can be changed; see the actual function for a detailed breakdown. */
 655 int     x264_encoder_reconfig( x264_t *, x264_param_t * );
 656 /* x264_encoder_parameters:
 657  *      copies the current internal set of parameters to the pointer provided
 658  *      by the caller.  useful when the calling application needs to know
 659  *      how x264_encoder_open has changed the parameters, or the current state
 660  *      of the encoder after multiple x264_encoder_reconfig calls.
 661  *      note that the data accessible through pointers in the returned param struct
 662  *      (e.g. filenames) should not be modified by the calling application. */
 663 void    x264_encoder_parameters( x264_t *, x264_param_t * );
 664 /* x264_encoder_headers:
 665  *      return the SPS and PPS that will be used for the whole stream.
 666  *      *pi_nal is the number of NAL units outputted in pp_nal.
 667  *      returns negative on error.
 668  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 669 int     x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
 670 /* x264_encoder_encode:
 671  *      encode one picture.
 672  *      *pi_nal is the number of NAL units outputted in pp_nal.
 673  *      returns negative on error, zero if no NAL units returned.
 674  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 675 int     x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
 676 /* x264_encoder_close:
 677  *      close an encoder handler */
 678 void    x264_encoder_close  ( x264_t * );
 679 /* x264_encoder_delayed_frames:
 680  *      return the number of currently delayed (buffered) frames
 681  *      this should be used at the end of the stream, to know when you have all the encoded frames. */
 682 int     x264_encoder_delayed_frames( x264_t * );
 683 /* x264_encoder_intra_refresh:
 684  *      If an intra refresh is not in progress, begin one with the next P-frame.
 685  *      If an intra refresh is in progress, begin one as soon as the current one finishes.
 686  *      Requires that b_intra_refresh be set.
 687  *
 688  *      Useful for interactive streaming where the client can tell the server that packet loss has
 689  *      occurred.  In this case, keyint can be set to an extremely high value so that intra refreshes
 690  *      only occur when calling x264_encoder_intra_refresh.
 691  *
 692  *      In multi-pass encoding, if x264_encoder_intra_refresh is called differently in each pass,
 693  *      behavior is undefined.
 694  *
 695  *      Should not be called during an x264_encoder_encode. */
 696 void    x264_encoder_intra_refresh( x264_t * );
 697 /* x264_encoder_invalidate_reference:
 698  *      An interactive error resilience tool, designed for use in a low-latency one-encoder-few-clients
 699  *      system.  When the client has packet loss or otherwise incorrectly decodes a frame, the encoder
 700  *      can be told with this command to "forget" the frame and all frames that depend on it, referencing
 701  *      only frames that occurred before the loss.  This will force a keyframe if no frames are left to
 702  *      reference after the aforementioned "forgetting".
 703  *
 704  *      It is strongly recommended to use a large i_dpb_size in this case, which allows the encoder to
 705  *      keep around extra, older frames to fall back on in case more recent frames are all invalidated.
 706  *      Unlike increasing i_frame_reference, this does not increase the number of frames used for motion
 707  *      estimation and thus has no speed impact.  It is also recommended to set a very large keyframe
 708  *      interval, so that keyframes are not used except as necessary for error recovery.
 709  *
 710  *      x264_encoder_invalidate_reference is not currently compatible with the use of B-frames or intra
 711  *      refresh.
 712  *
 713  *      In multi-pass encoding, if x264_encoder_invalidate_reference is called differently in each pass,
 714  *      behavior is undefined.
 715  *
 716  *      Should not be called during an x264_encoder_encode.
 717  *
 718  *      Returns 0 on success, negative on failure. */
 719 int x264_encoder_invalidate_reference( x264_t *, int64_t pts );
 720
 721 #endif