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 73
  39
  40 /* x264_t:
  41  *      opaque handler for encoder */
  42 typedef struct x264_t x264_t;
  43
  44 /****************************************************************************
  45  * Initialisation structure and function.
  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
  99 static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
 100 static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
 101 static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
 102 static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
 103 static const char * const x264_fullrange_names[] = { "off", "on", 0 };
 104 static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", 0 };
 105 static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316", 0 };
 106 static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", 0 };
 107
 108 /* Colorspace type
 109  * legacy only; nothing other than I420 is really supported. */
 110 #define X264_CSP_MASK           0x00ff  /* */
 111 #define X264_CSP_NONE           0x0000  /* Invalid mode     */
 112 #define X264_CSP_I420           0x0001  /* yuv 4:2:0 planar */
 113 #define X264_CSP_I422           0x0002  /* yuv 4:2:2 planar */
 114 #define X264_CSP_I444           0x0003  /* yuv 4:4:4 planar */
 115 #define X264_CSP_YV12           0x0004  /* yuv 4:2:0 planar */
 116 #define X264_CSP_YUYV           0x0005  /* yuv 4:2:2 packed */
 117 #define X264_CSP_RGB            0x0006  /* rgb 24bits       */
 118 #define X264_CSP_BGR            0x0007  /* bgr 24bits       */
 119 #define X264_CSP_BGRA           0x0008  /* bgr 32bits       */
 120 #define X264_CSP_MAX            0x0009  /* end of list */
 121 #define X264_CSP_VFLIP          0x1000  /* */
 122
 123 /* Slice type */
 124 #define X264_TYPE_AUTO          0x0000  /* Let x264 choose the right type */
 125 #define X264_TYPE_IDR           0x0001
 126 #define X264_TYPE_I             0x0002
 127 #define X264_TYPE_P             0x0003
 128 #define X264_TYPE_BREF          0x0004  /* Non-disposable B-frame */
 129 #define X264_TYPE_B             0x0005
 130 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
 131 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
 132
 133 /* Log level */
 134 #define X264_LOG_NONE          (-1)
 135 #define X264_LOG_ERROR          0
 136 #define X264_LOG_WARNING        1
 137 #define X264_LOG_INFO           2
 138 #define X264_LOG_DEBUG          3
 139
 140 /* Threading */
 141 #define X264_THREADS_AUTO 0 /* Automatically select optimal number of threads */
 142
 143 /* Zones: override ratecontrol or other options for specific sections of the video.
 144  * See x264_encoder_reconfig() for which options can be changed.
 145  * If zones overlap, whichever comes later in the list takes precedence. */
 146 typedef struct
 147 {
 148     int i_start, i_end; /* range of frame numbers */
 149     int b_force_qp; /* whether to use qp vs bitrate factor */
 150     int i_qp;
 151     float f_bitrate_factor;
 152     struct x264_param_t *param;
 153 } x264_zone_t;
 154
 155 typedef struct x264_param_t
 156 {
 157     /* CPU flags */
 158     unsigned int cpu;
 159     int         i_threads;       /* encode multiple frames in parallel */
 160     int         b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
 161
 162     /* Video Properties */
 163     int         i_width;
 164     int         i_height;
 165     int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
 166     int         i_level_idc;
 167     int         i_frame_total; /* number of frames to encode if known, else 0 */
 168
 169     struct
 170     {
 171         /* they will be reduced to be 0 < x <= 65535 and prime */
 172         int         i_sar_height;
 173         int         i_sar_width;
 174
 175         int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
 176
 177         /* see h264 annex E for the values of the following */
 178         int         i_vidformat;
 179         int         b_fullrange;
 180         int         i_colorprim;
 181         int         i_transfer;
 182         int         i_colmatrix;
 183         int         i_chroma_loc;    /* both top & bottom */
 184     } vui;
 185
 186     int         i_fps_num;
 187     int         i_fps_den;
 188
 189     /* Bitstream parameters */
 190     int         i_frame_reference;  /* Maximum number of reference frames */
 191     int         i_keyint_max;       /* Force an IDR keyframe at this interval */
 192     int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
 193     int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
 194     int         i_bframe;   /* how many b-frame between 2 references pictures */
 195     int         i_bframe_adaptive;
 196     int         i_bframe_bias;
 197     int         b_bframe_pyramid;   /* Keep some B-frames as references */
 198
 199     int         b_deblocking_filter;
 200     int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
 201     int         i_deblocking_filter_beta;       /* [-6, 6]  idem */
 202
 203     int         b_cabac;
 204     int         i_cabac_init_idc;
 205
 206     int         b_interlaced;
 207
 208     int         i_cqm_preset;
 209     char        *psz_cqm_file;      /* JM format */
 210     uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
 211     uint8_t     cqm_4ic[16];
 212     uint8_t     cqm_4py[16];
 213     uint8_t     cqm_4pc[16];
 214     uint8_t     cqm_8iy[64];
 215     uint8_t     cqm_8py[64];
 216
 217     /* Log */
 218     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
 219     void        *p_log_private;
 220     int         i_log_level;
 221     int         b_visualize;
 222     char        *psz_dump_yuv;  /* filename for reconstructed frames */
 223
 224     /* Encoder analyser parameters */
 225     struct
 226     {
 227         unsigned int intra;     /* intra partitions */
 228         unsigned int inter;     /* inter partitions */
 229
 230         int          b_transform_8x8;
 231         int          b_weighted_bipred; /* implicit weighting for B-frames */
 232         int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
 233         int          i_chroma_qp_offset;
 234
 235         int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
 236         int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
 237         int          i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
 238         int          i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
 239         int          i_subpel_refine; /* subpixel motion estimation quality */
 240         int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
 241         int          b_mixed_references; /* allow each mb partition in P-frames to have it's own reference number */
 242         int          i_trellis;  /* trellis RD quantization */
 243         int          b_fast_pskip; /* early SKIP detection on P-frames */
 244         int          b_dct_decimate; /* transform coefficient thresholding on P-frames */
 245         int          i_noise_reduction; /* adaptive pseudo-deadzone */
 246         float        f_psy_rd; /* Psy RD strength */
 247         float        f_psy_trellis; /* Psy trellis strength */
 248         int          b_psy; /* Toggle all psy optimizations */
 249
 250         /* the deadzone size that will be used in luma quantization */
 251         int          i_luma_deadzone[2]; /* {inter, intra} */
 252
 253         int          b_psnr;    /* compute and print PSNR stats */
 254         int          b_ssim;    /* compute and print SSIM stats */
 255     } analyse;
 256
 257     /* Rate control parameters */
 258     struct
 259     {
 260         int         i_rc_method;    /* X264_RC_* */
 261
 262         int         i_qp_constant;  /* 0-51 */
 263         int         i_qp_min;       /* min allowed QP value */
 264         int         i_qp_max;       /* max allowed QP value */
 265         int         i_qp_step;      /* max QP step between frames */
 266
 267         int         i_bitrate;
 268         float       f_rf_constant;  /* 1pass VBR, nominal QP */
 269         float       f_rate_tolerance;
 270         int         i_vbv_max_bitrate;
 271         int         i_vbv_buffer_size;
 272         float       f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
 273         float       f_ip_factor;
 274         float       f_pb_factor;
 275
 276         int         i_aq_mode;      /* psy adaptive QP. (X264_AQ_*) */
 277         float       f_aq_strength;
 278         int         b_mb_tree;      /* Macroblock-tree ratecontrol. */
 279         int         i_lookahead;
 280
 281         /* 2pass */
 282         int         b_stat_write;   /* Enable stat writing in psz_stat_out */
 283         char        *psz_stat_out;
 284         int         b_stat_read;    /* Read stat from psz_stat_in and use it */
 285         char        *psz_stat_in;
 286
 287         /* 2pass params (same as ffmpeg ones) */
 288         float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
 289         float       f_qblur;        /* temporally blur quants */
 290         float       f_complexity_blur; /* temporally blur complexity */
 291         x264_zone_t *zones;         /* ratecontrol overrides */
 292         int         i_zones;        /* number of zone_t's */
 293         char        *psz_zones;     /* alternate method of specifying zones */
 294     } rc;
 295
 296     /* Muxing parameters */
 297     int b_aud;                  /* generate access unit delimiters */
 298     int b_repeat_headers;       /* put SPS/PPS before each keyframe */
 299     int i_sps_id;               /* SPS and PPS id number */
 300
 301     /* Slicing parameters */
 302     int i_slice_max_size;    /* Max size per slice in bytes; includes estimated NAL overhead. */
 303     int i_slice_max_mbs;     /* Max number of MBs per slice; overrides i_slice_count. */
 304     int i_slice_count;       /* Number of slices per frame: forces rectangular slices. */
 305
 306     /* Optional callback for freeing this x264_param_t when it is done being used.
 307      * Only used when the x264_param_t sits in memory for an indefinite period of time,
 308      * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
 309      * Not used when x264_encoder_reconfig is called directly. */
 310     void (*param_free)( void* );
 311 } x264_param_t;
 312
 313 typedef struct {
 314     int level_idc;
 315     int mbps;        /* max macroblock processing rate (macroblocks/sec) */
 316     int frame_size;  /* max frame size (macroblocks) */
 317     int dpb;         /* max decoded picture buffer (bytes) */
 318     int bitrate;     /* max bitrate (kbit/sec) */
 319     int cpb;         /* max vbv buffer (kbit) */
 320     int mv_range;    /* max vertical mv component range (pixels) */
 321     int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
 322     int slice_rate;  /* ?? */
 323     int bipred8x8;   /* limit bipred to >=8x8 */
 324     int direct8x8;   /* limit b_direct to >=8x8 */
 325     int frame_only;  /* forbid interlacing */
 326 } x264_level_t;
 327
 328 /* all of the levels defined in the standard, terminated by .level_idc=0 */
 329 extern const x264_level_t x264_levels[];
 330
 331 /* x264_param_default:
 332  *      fill x264_param_t with default values and do CPU detection */
 333 void    x264_param_default( x264_param_t * );
 334
 335 /* x264_param_parse:
 336  *  set one parameter by name.
 337  *  returns 0 on success, or returns one of the following errors.
 338  *  note: BAD_VALUE occurs only if it can't even parse the value,
 339  *  numerical range is not checked until x264_encoder_open() or
 340  *  x264_encoder_reconfig().
 341  *  value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
 342 #define X264_PARAM_BAD_NAME  (-1)
 343 #define X264_PARAM_BAD_VALUE (-2)
 344 int x264_param_parse( x264_param_t *, const char *name, const char *value );
 345
 346 /****************************************************************************
 347  * Picture structures and functions.
 348  ****************************************************************************/
 349 typedef struct
 350 {
 351     int     i_csp;
 352
 353     int     i_plane;
 354     int     i_stride[4];
 355     uint8_t *plane[4];
 356 } x264_image_t;
 357
 358 typedef struct
 359 {
 360     /* In: force picture type (if not auto)
 361      *     If x264 encoding parameters are violated in the forcing of picture types,
 362      *     x264 will correct the input picture type and log a warning.
 363      *     The quality of frametype decisions may suffer if a great deal of fine-grained
 364      *     mixing of auto and forced frametypes is done.
 365      * Out: type of the picture encoded */
 366     int     i_type;
 367     /* In: force quantizer for > 0 */
 368     int     i_qpplus1;
 369     /* In: user pts, Out: pts of encoded picture (user)*/
 370     int64_t i_pts;
 371     /* In: custom encoding parameters to be set from this frame forwards
 372            (in coded order, not display order). If NULL, continue using
 373            parameters from the previous frame.  Some parameters, such as
 374            aspect ratio, can only be changed per-GOP due to the limitations
 375            of H.264 itself; in this case, the caller must force an IDR frame
 376            if it needs the changed parameter to apply immediately. */
 377     x264_param_t *param;
 378
 379     /* In: raw data */
 380     x264_image_t img;
 381 } x264_picture_t;
 382
 383 /* x264_picture_alloc:
 384  *  alloc data for a picture. You must call x264_picture_clean on it.
 385  *  returns 0 on success, or -1 on malloc failure. */
 386 int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
 387
 388 /* x264_picture_clean:
 389  *  free associated resource for a x264_picture_t allocated with
 390  *  x264_picture_alloc ONLY */
 391 void x264_picture_clean( x264_picture_t *pic );
 392
 393 /****************************************************************************
 394  * NAL structure and functions:
 395  ****************************************************************************/
 396 /* nal */
 397 enum nal_unit_type_e
 398 {
 399     NAL_UNKNOWN = 0,
 400     NAL_SLICE   = 1,
 401     NAL_SLICE_DPA   = 2,
 402     NAL_SLICE_DPB   = 3,
 403     NAL_SLICE_DPC   = 4,
 404     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
 405     NAL_SEI         = 6,    /* ref_idc == 0 */
 406     NAL_SPS         = 7,
 407     NAL_PPS         = 8,
 408     NAL_AUD         = 9,
 409     /* ref_idc == 0 for 6,9,10,11,12 */
 410 };
 411 enum nal_priority_e
 412 {
 413     NAL_PRIORITY_DISPOSABLE = 0,
 414     NAL_PRIORITY_LOW        = 1,
 415     NAL_PRIORITY_HIGH       = 2,
 416     NAL_PRIORITY_HIGHEST    = 3,
 417 };
 418
 419 typedef struct
 420 {
 421     int i_ref_idc;  /* nal_priority_e */
 422     int i_type;     /* nal_unit_type_e */
 423
 424     /* This data are raw payload */
 425     int     i_payload;
 426     uint8_t *p_payload;
 427 } x264_nal_t;
 428
 429 /* x264_nal_encode:
 430  *      encode a nal into a buffer, setting the size.
 431  *      if b_annexeb then a long synch work is added
 432  *      XXX: it currently doesn't check for overflow */
 433 int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
 434
 435 /****************************************************************************
 436  * Encoder functions:
 437  ****************************************************************************/
 438
 439 /* x264_encoder_open:
 440  *      create a new encoder handler, all parameters from x264_param_t are copied */
 441 x264_t *x264_encoder_open   ( x264_param_t * );
 442 /* x264_encoder_reconfig:
 443  *      analysis-related parameters from x264_param_t are copied.
 444  *      this takes effect immediately, on whichever frame is encoded next;
 445  *      due to delay, this may not be the next frame passed to encoder_encode.
 446  *      if the change should apply to some particular frame, use x264_picture_t->param instead. */
 447 int     x264_encoder_reconfig( x264_t *, x264_param_t * );
 448 /* x264_encoder_headers:
 449  *      return the SPS and PPS that will be used for the whole stream */
 450 int     x264_encoder_headers( x264_t *, x264_nal_t **, int * );
 451 /* x264_encoder_encode:
 452  *      encode one picture */
 453 int     x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
 454 /* x264_encoder_close:
 455  *      close an encoder handler */
 456 void    x264_encoder_close  ( x264_t * );
 457 /* x264_encoder_delayed_frames:
 458  *      return the number of currently delayed (buffered) frames
 459  *      this should be used at the end of the stream, to know when you have all the encoded frames. */
 460 int     x264_encoder_delayed_frames( x264_t * );
 461
 462 #endif