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