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 77
  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 #define X264_SYNC_LOOKAHEAD_AUTO (-1) /* Automatically select optimal lookahead thread buffer size */
 143
 144 /* Zones: override ratecontrol or other options for specific sections of the video.
 145  * See x264_encoder_reconfig() for which options can be changed.
 146  * If zones overlap, whichever comes later in the list takes precedence. */
 147 typedef struct
 148 {
 149     int i_start, i_end; /* range of frame numbers */
 150     int b_force_qp; /* whether to use qp vs bitrate factor */
 151     int i_qp;
 152     float f_bitrate_factor;
 153     struct x264_param_t *param;
 154 } x264_zone_t;
 155
 156 typedef struct x264_param_t
 157 {
 158     /* CPU flags */
 159     unsigned int cpu;
 160     int         i_threads;       /* encode multiple frames in parallel */
 161     int         b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
 162     int         i_sync_lookahead; /* threaded lookahead buffer */
 163
 164     /* Video Properties */
 165     int         i_width;
 166     int         i_height;
 167     int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
 168     int         i_level_idc;
 169     int         i_frame_total; /* number of frames to encode if known, else 0 */
 170
 171     struct
 172     {
 173         /* they will be reduced to be 0 < x <= 65535 and prime */
 174         int         i_sar_height;
 175         int         i_sar_width;
 176
 177         int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
 178
 179         /* see h264 annex E for the values of the following */
 180         int         i_vidformat;
 181         int         b_fullrange;
 182         int         i_colorprim;
 183         int         i_transfer;
 184         int         i_colmatrix;
 185         int         i_chroma_loc;    /* both top & bottom */
 186     } vui;
 187
 188     int         i_fps_num;
 189     int         i_fps_den;
 190
 191     /* Bitstream parameters */
 192     int         i_frame_reference;  /* Maximum number of reference frames */
 193     int         i_keyint_max;       /* Force an IDR keyframe at this interval */
 194     int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
 195     int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
 196     int         i_bframe;   /* how many b-frame between 2 references pictures */
 197     int         i_bframe_adaptive;
 198     int         i_bframe_bias;
 199     int         b_bframe_pyramid;   /* Keep some B-frames as references */
 200
 201     int         b_deblocking_filter;
 202     int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
 203     int         i_deblocking_filter_beta;       /* [-6, 6]  idem */
 204
 205     int         b_cabac;
 206     int         i_cabac_init_idc;
 207
 208     int         b_interlaced;
 209     int         b_constrained_intra;
 210
 211     int         i_cqm_preset;
 212     char        *psz_cqm_file;      /* JM format */
 213     uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
 214     uint8_t     cqm_4ic[16];
 215     uint8_t     cqm_4py[16];
 216     uint8_t     cqm_4pc[16];
 217     uint8_t     cqm_8iy[64];
 218     uint8_t     cqm_8py[64];
 219
 220     /* Log */
 221     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
 222     void        *p_log_private;
 223     int         i_log_level;
 224     int         b_visualize;
 225     char        *psz_dump_yuv;  /* filename for reconstructed frames */
 226
 227     /* Encoder analyser parameters */
 228     struct
 229     {
 230         unsigned int intra;     /* intra partitions */
 231         unsigned int inter;     /* inter partitions */
 232
 233         int          b_transform_8x8;
 234         int          b_weighted_bipred; /* implicit weighting for B-frames */
 235         int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
 236         int          i_chroma_qp_offset;
 237
 238         int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
 239         int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
 240         int          i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
 241         int          i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
 242         int          i_subpel_refine; /* subpixel motion estimation quality */
 243         int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
 244         int          b_mixed_references; /* allow each mb partition in P-frames to have it's own reference number */
 245         int          i_trellis;  /* trellis RD quantization */
 246         int          b_fast_pskip; /* early SKIP detection on P-frames */
 247         int          b_dct_decimate; /* transform coefficient thresholding on P-frames */
 248         int          i_noise_reduction; /* adaptive pseudo-deadzone */
 249         float        f_psy_rd; /* Psy RD strength */
 250         float        f_psy_trellis; /* Psy trellis strength */
 251         int          b_psy; /* Toggle all psy optimizations */
 252
 253         /* the deadzone size that will be used in luma quantization */
 254         int          i_luma_deadzone[2]; /* {inter, intra} */
 255
 256         int          b_psnr;    /* compute and print PSNR stats */
 257         int          b_ssim;    /* compute and print SSIM stats */
 258     } analyse;
 259
 260     /* Rate control parameters */
 261     struct
 262     {
 263         int         i_rc_method;    /* X264_RC_* */
 264
 265         int         i_qp_constant;  /* 0-51 */
 266         int         i_qp_min;       /* min allowed QP value */
 267         int         i_qp_max;       /* max allowed QP value */
 268         int         i_qp_step;      /* max QP step between frames */
 269
 270         int         i_bitrate;
 271         float       f_rf_constant;  /* 1pass VBR, nominal QP */
 272         float       f_rate_tolerance;
 273         int         i_vbv_max_bitrate;
 274         int         i_vbv_buffer_size;
 275         float       f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
 276         float       f_ip_factor;
 277         float       f_pb_factor;
 278
 279         int         i_aq_mode;      /* psy adaptive QP. (X264_AQ_*) */
 280         float       f_aq_strength;
 281         int         b_mb_tree;      /* Macroblock-tree ratecontrol. */
 282         int         i_lookahead;
 283
 284         /* 2pass */
 285         int         b_stat_write;   /* Enable stat writing in psz_stat_out */
 286         char        *psz_stat_out;
 287         int         b_stat_read;    /* Read stat from psz_stat_in and use it */
 288         char        *psz_stat_in;
 289
 290         /* 2pass params (same as ffmpeg ones) */
 291         float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
 292         float       f_qblur;        /* temporally blur quants */
 293         float       f_complexity_blur; /* temporally blur complexity */
 294         x264_zone_t *zones;         /* ratecontrol overrides */
 295         int         i_zones;        /* number of zone_t's */
 296         char        *psz_zones;     /* alternate method of specifying zones */
 297     } rc;
 298
 299     /* Muxing parameters */
 300     int b_aud;                  /* generate access unit delimiters */
 301     int b_repeat_headers;       /* put SPS/PPS before each keyframe */
 302     int b_annexb;               /* if set, place start codes (4 bytes) before NAL units,
 303                                  * otherwise place size (4 bytes) before NAL units. */
 304     int i_sps_id;               /* SPS and PPS id number */
 305
 306     /* Slicing parameters */
 307     int i_slice_max_size;    /* Max size per slice in bytes; includes estimated NAL overhead. */
 308     int i_slice_max_mbs;     /* Max number of MBs per slice; overrides i_slice_count. */
 309     int i_slice_count;       /* Number of slices per frame: forces rectangular slices. */
 310
 311     /* Optional callback for freeing this x264_param_t when it is done being used.
 312      * Only used when the x264_param_t sits in memory for an indefinite period of time,
 313      * i.e. when an x264_param_t is passed to x264_t in an x264_picture_t or in zones.
 314      * Not used when x264_encoder_reconfig is called directly. */
 315     void (*param_free)( void* );
 316 } x264_param_t;
 317
 318 typedef struct {
 319     int level_idc;
 320     int mbps;        /* max macroblock processing rate (macroblocks/sec) */
 321     int frame_size;  /* max frame size (macroblocks) */
 322     int dpb;         /* max decoded picture buffer (bytes) */
 323     int bitrate;     /* max bitrate (kbit/sec) */
 324     int cpb;         /* max vbv buffer (kbit) */
 325     int mv_range;    /* max vertical mv component range (pixels) */
 326     int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
 327     int slice_rate;  /* ?? */
 328     int bipred8x8;   /* limit bipred to >=8x8 */
 329     int direct8x8;   /* limit b_direct to >=8x8 */
 330     int frame_only;  /* forbid interlacing */
 331 } x264_level_t;
 332
 333 /* all of the levels defined in the standard, terminated by .level_idc=0 */
 334 extern const x264_level_t x264_levels[];
 335
 336 /* x264_param_default:
 337  *      fill x264_param_t with default values and do CPU detection */
 338 void    x264_param_default( x264_param_t * );
 339
 340 /* x264_param_parse:
 341  *  set one parameter by name.
 342  *  returns 0 on success, or returns one of the following errors.
 343  *  note: BAD_VALUE occurs only if it can't even parse the value,
 344  *  numerical range is not checked until x264_encoder_open() or
 345  *  x264_encoder_reconfig().
 346  *  value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
 347 #define X264_PARAM_BAD_NAME  (-1)
 348 #define X264_PARAM_BAD_VALUE (-2)
 349 int x264_param_parse( x264_param_t *, const char *name, const char *value );
 350
 351 /****************************************************************************
 352  * Picture structures and functions.
 353  ****************************************************************************/
 354 typedef struct
 355 {
 356     int     i_csp;
 357
 358     int     i_plane;
 359     int     i_stride[4];
 360     uint8_t *plane[4];
 361 } x264_image_t;
 362
 363 typedef struct
 364 {
 365     /* In: force picture type (if not auto)
 366      *     If x264 encoding parameters are violated in the forcing of picture types,
 367      *     x264 will correct the input picture type and log a warning.
 368      *     The quality of frametype decisions may suffer if a great deal of fine-grained
 369      *     mixing of auto and forced frametypes is done.
 370      * Out: type of the picture encoded */
 371     int     i_type;
 372     /* In: force quantizer for > 0 */
 373     int     i_qpplus1;
 374     /* In: user pts, Out: pts of encoded picture (user)*/
 375     int64_t i_pts;
 376     /* In: custom encoding parameters to be set from this frame forwards
 377            (in coded order, not display order). If NULL, continue using
 378            parameters from the previous frame.  Some parameters, such as
 379            aspect ratio, can only be changed per-GOP due to the limitations
 380            of H.264 itself; in this case, the caller must force an IDR frame
 381            if it needs the changed parameter to apply immediately. */
 382     x264_param_t *param;
 383
 384     /* In: raw data */
 385     x264_image_t img;
 386 } x264_picture_t;
 387
 388 /* x264_picture_alloc:
 389  *  alloc data for a picture. You must call x264_picture_clean on it.
 390  *  returns 0 on success, or -1 on malloc failure. */
 391 int x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
 392
 393 /* x264_picture_clean:
 394  *  free associated resource for a x264_picture_t allocated with
 395  *  x264_picture_alloc ONLY */
 396 void x264_picture_clean( x264_picture_t *pic );
 397
 398 /****************************************************************************
 399  * NAL structure and functions:
 400  ****************************************************************************/
 401 /* nal */
 402 enum nal_unit_type_e
 403 {
 404     NAL_UNKNOWN = 0,
 405     NAL_SLICE   = 1,
 406     NAL_SLICE_DPA   = 2,
 407     NAL_SLICE_DPB   = 3,
 408     NAL_SLICE_DPC   = 4,
 409     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
 410     NAL_SEI         = 6,    /* ref_idc == 0 */
 411     NAL_SPS         = 7,
 412     NAL_PPS         = 8,
 413     NAL_AUD         = 9,
 414     /* ref_idc == 0 for 6,9,10,11,12 */
 415 };
 416 enum nal_priority_e
 417 {
 418     NAL_PRIORITY_DISPOSABLE = 0,
 419     NAL_PRIORITY_LOW        = 1,
 420     NAL_PRIORITY_HIGH       = 2,
 421     NAL_PRIORITY_HIGHEST    = 3,
 422 };
 423
 424 /* The data within the payload is already NAL-encapsulated; the ref_idc and type
 425  * are merely in the struct for easy access by the calling application.
 426  * All data returned in an x264_nal_t, including the data in p_payload, is no longer
 427  * valid after the next call to x264_encoder_encode.  Thus it must be used or copied
 428  * before calling x264_encoder_encode or x264_encoder_headers again. */
 429 typedef struct
 430 {
 431     int i_ref_idc;  /* nal_priority_e */
 432     int i_type;     /* nal_unit_type_e */
 433
 434     /* Size of payload in bytes. */
 435     int     i_payload;
 436     /* If param->b_annexb is set, Annex-B bytestream with 4-byte startcode.
 437      * Otherwise, startcode is replaced with a 4-byte size.
 438      * This size is the size used in mp4/similar muxing; it is equal to i_payload-4 */
 439     uint8_t *p_payload;
 440 } x264_nal_t;
 441
 442 /****************************************************************************
 443  * Encoder functions:
 444  ****************************************************************************/
 445
 446 /* Force a link error in the case of linking against an incompatible API version.
 447  * Glue #defines exist to force correct macro expansion; the final output of the macro
 448  * is x264_encoder_open_##X264_BUILD (for purposes of dlopen). */
 449 #define x264_encoder_glue1(x,y) x##y
 450 #define x264_encoder_glue2(x,y) x264_encoder_glue1(x,y)
 451 #define x264_encoder_open x264_encoder_glue2(x264_encoder_open_,X264_BUILD)
 452
 453 /* x264_encoder_open:
 454  *      create a new encoder handler, all parameters from x264_param_t are copied */
 455 x264_t *x264_encoder_open( x264_param_t * );
 456
 457 /* x264_encoder_reconfig:
 458  *      analysis-related parameters from x264_param_t are copied.
 459  *      this takes effect immediately, on whichever frame is encoded next;
 460  *      due to delay, this may not be the next frame passed to encoder_encode.
 461  *      if the change should apply to some particular frame, use x264_picture_t->param instead.
 462  *      returns 0 on success, negative on parameter validation error. */
 463 int     x264_encoder_reconfig( x264_t *, x264_param_t * );
 464 /* x264_encoder_headers:
 465  *      return the SPS and PPS that will be used for the whole stream.
 466  *      if i_nal > 0, returns the total size of all NAL payloads.
 467  *      returns negative on error.
 468  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 469 int     x264_encoder_headers( x264_t *, x264_nal_t **, int * );
 470 /* x264_encoder_encode:
 471  *      encode one picture.
 472  *      if i_nal > 0, returns the total size of all NAL payloads.
 473  *      returns negative on error, zero if no NAL units returned.
 474  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 475 int     x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
 476 /* x264_encoder_close:
 477  *      close an encoder handler */
 478 void    x264_encoder_close  ( x264_t * );
 479 /* x264_encoder_delayed_frames:
 480  *      return the number of currently delayed (buffered) frames
 481  *      this should be used at the end of the stream, to know when you have all the encoded frames. */
 482 int     x264_encoder_delayed_frames( x264_t * );
 483
 484 #endif