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 60
  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_PHADD_IS_FAST  0x000800  /* pre-Penryn Core2 have a uselessly slow PHADD instruction */
  61 #define X264_CPU_SSE4           0x001000  /* SSE4.1 */
  62 #define X264_CPU_STACK_MOD4     0x002000  /* if stack is only mod4 and not mod16 */
  63
  64 /* Analyse flags
  65  */
  66 #define X264_ANALYSE_I4x4       0x0001  /* Analyse i4x4 */
  67 #define X264_ANALYSE_I8x8       0x0002  /* Analyse i8x8 (requires 8x8 transform) */
  68 #define X264_ANALYSE_PSUB16x16  0x0010  /* Analyse p16x8, p8x16 and p8x8 */
  69 #define X264_ANALYSE_PSUB8x8    0x0020  /* Analyse p8x4, p4x8, p4x4 */
  70 #define X264_ANALYSE_BSUB16x16  0x0100  /* Analyse b16x8, b8x16 and b8x8 */
  71 #define X264_DIRECT_PRED_NONE        0
  72 #define X264_DIRECT_PRED_SPATIAL     1
  73 #define X264_DIRECT_PRED_TEMPORAL    2
  74 #define X264_DIRECT_PRED_AUTO        3
  75 #define X264_ME_DIA                  0
  76 #define X264_ME_HEX                  1
  77 #define X264_ME_UMH                  2
  78 #define X264_ME_ESA                  3
  79 #define X264_ME_TESA                 4
  80 #define X264_CQM_FLAT                0
  81 #define X264_CQM_JVT                 1
  82 #define X264_CQM_CUSTOM              2
  83 #define X264_RC_NONE                 -1
  84 #define X264_RC_CQP                  0
  85 #define X264_RC_CRF                  1
  86 #define X264_RC_ABR                  2
  87 #define X264_AQ_NONE                 0
  88 #define X264_AQ_LOCAL                1
  89 #define X264_AQ_GLOBAL               2
  90
  91 static const char * const x264_direct_pred_names[] = { "none", "spatial", "temporal", "auto", 0 };
  92 static const char * const x264_motion_est_names[] = { "dia", "hex", "umh", "esa", "tesa", 0 };
  93 static const char * const x264_overscan_names[] = { "undef", "show", "crop", 0 };
  94 static const char * const x264_vidformat_names[] = { "component", "pal", "ntsc", "secam", "mac", "undef", 0 };
  95 static const char * const x264_fullrange_names[] = { "off", "on", 0 };
  96 static const char * const x264_colorprim_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "film", 0 };
  97 static const char * const x264_transfer_names[] = { "", "bt709", "undef", "", "bt470m", "bt470bg", "smpte170m", "smpte240m", "linear", "log100", "log316", 0 };
  98 static const char * const x264_colmatrix_names[] = { "GBR", "bt709", "undef", "", "fcc", "bt470bg", "smpte170m", "smpte240m", "YCgCo", 0 };
  99
 100 /* Colorspace type
 101  * legacy only; nothing other than I420 is really supported.
 102  */
 103 #define X264_CSP_MASK           0x00ff  /* */
 104 #define X264_CSP_NONE           0x0000  /* Invalid mode     */
 105 #define X264_CSP_I420           0x0001  /* yuv 4:2:0 planar */
 106 #define X264_CSP_I422           0x0002  /* yuv 4:2:2 planar */
 107 #define X264_CSP_I444           0x0003  /* yuv 4:4:4 planar */
 108 #define X264_CSP_YV12           0x0004  /* yuv 4:2:0 planar */
 109 #define X264_CSP_YUYV           0x0005  /* yuv 4:2:2 packed */
 110 #define X264_CSP_RGB            0x0006  /* rgb 24bits       */
 111 #define X264_CSP_BGR            0x0007  /* bgr 24bits       */
 112 #define X264_CSP_BGRA           0x0008  /* bgr 32bits       */
 113 #define X264_CSP_MAX            0x0009  /* end of list */
 114 #define X264_CSP_VFLIP          0x1000  /* */
 115
 116 /* Slice type
 117  */
 118 #define X264_TYPE_AUTO          0x0000  /* Let x264 choose the right type */
 119 #define X264_TYPE_IDR           0x0001
 120 #define X264_TYPE_I             0x0002
 121 #define X264_TYPE_P             0x0003
 122 #define X264_TYPE_BREF          0x0004  /* Non-disposable B-frame */
 123 #define X264_TYPE_B             0x0005
 124 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
 125 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
 126
 127 /* Log level
 128  */
 129 #define X264_LOG_NONE          (-1)
 130 #define X264_LOG_ERROR          0
 131 #define X264_LOG_WARNING        1
 132 #define X264_LOG_INFO           2
 133 #define X264_LOG_DEBUG          3
 134
 135 /* Zones: override ratecontrol or other options for specific sections of the video.
 136  * See x264_encoder_reconfig() for which options can be changed.
 137  * If zones overlap, whichever comes later in the list takes precedence. */
 138 typedef struct
 139 {
 140     int i_start, i_end; /* range of frame numbers */
 141     int b_force_qp; /* whether to use qp vs bitrate factor */
 142     int i_qp;
 143     float f_bitrate_factor;
 144     struct x264_param_t *param;
 145 } x264_zone_t;
 146
 147 typedef struct x264_param_t
 148 {
 149     /* CPU flags */
 150     unsigned int cpu;
 151     int         i_threads;       /* encode multiple frames in parallel */
 152     int         b_deterministic; /* whether to allow non-deterministic optimizations when threaded */
 153
 154     /* Video Properties */
 155     int         i_width;
 156     int         i_height;
 157     int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
 158     int         i_level_idc;
 159     int         i_frame_total; /* number of frames to encode if known, else 0 */
 160
 161     struct
 162     {
 163         /* they will be reduced to be 0 < x <= 65535 and prime */
 164         int         i_sar_height;
 165         int         i_sar_width;
 166
 167         int         i_overscan;    /* 0=undef, 1=no overscan, 2=overscan */
 168
 169         /* see h264 annex E for the values of the following */
 170         int         i_vidformat;
 171         int         b_fullrange;
 172         int         i_colorprim;
 173         int         i_transfer;
 174         int         i_colmatrix;
 175         int         i_chroma_loc;    /* both top & bottom */
 176     } vui;
 177
 178     int         i_fps_num;
 179     int         i_fps_den;
 180
 181     /* Bitstream parameters */
 182     int         i_frame_reference;  /* Maximum number of reference frames */
 183     int         i_keyint_max;       /* Force an IDR keyframe at this interval */
 184     int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
 185     int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
 186     int         b_pre_scenecut;     /* compute scenecut on lowres frames */
 187     int         i_bframe;   /* how many b-frame between 2 references pictures */
 188     int         b_bframe_adaptive;
 189     int         i_bframe_bias;
 190     int         b_bframe_pyramid;   /* Keep some B-frames as references */
 191
 192     int         b_deblocking_filter;
 193     int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
 194     int         i_deblocking_filter_beta;       /* [-6, 6]  idem */
 195
 196     int         b_cabac;
 197     int         i_cabac_init_idc;
 198
 199     int         b_interlaced;
 200
 201     int         i_cqm_preset;
 202     char        *psz_cqm_file;      /* JM format */
 203     uint8_t     cqm_4iy[16];        /* used only if i_cqm_preset == X264_CQM_CUSTOM */
 204     uint8_t     cqm_4ic[16];
 205     uint8_t     cqm_4py[16];
 206     uint8_t     cqm_4pc[16];
 207     uint8_t     cqm_8iy[64];
 208     uint8_t     cqm_8py[64];
 209
 210     /* Log */
 211     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
 212     void        *p_log_private;
 213     int         i_log_level;
 214     int         b_visualize;
 215     char        *psz_dump_yuv;  /* filename for reconstructed frames */
 216
 217     /* Encoder analyser parameters */
 218     struct
 219     {
 220         unsigned int intra;     /* intra partitions */
 221         unsigned int inter;     /* inter partitions */
 222
 223         int          b_transform_8x8;
 224         int          b_weighted_bipred; /* implicit weighting for B-frames */
 225         int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
 226         int          i_direct_8x8_inference; /* forbid 4x4 direct partitions. -1 = auto, based on level */
 227         int          i_chroma_qp_offset;
 228
 229         int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
 230         int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
 231         int          i_mv_range; /* maximum length of a mv (in pixels). -1 = auto, based on level */
 232         int          i_mv_range_thread; /* minimum space between threads. -1 = auto, based on number of threads. */
 233         int          i_subpel_refine; /* subpixel motion estimation quality */
 234         int          b_bidir_me; /* jointly optimize both MVs in B-frames */
 235         int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
 236         int          b_bframe_rdo; /* RD based mode decision for B-frames */
 237         int          b_mixed_references; /* allow each mb partition in P-frames to have it's own reference number */
 238         int          i_trellis;  /* trellis RD quantization */
 239         int          b_fast_pskip; /* early SKIP detection on P-frames */
 240         int          b_dct_decimate; /* transform coefficient thresholding on P-frames */
 241         int          i_noise_reduction; /* adaptive pseudo-deadzone */
 242
 243         /* the deadzone size that will be used in luma quantization */
 244         int          i_luma_deadzone[2]; /* {inter, intra} */
 245
 246         int          b_psnr;    /* compute and print PSNR stats */
 247         int          b_ssim;    /* compute and print SSIM stats */
 248     } analyse;
 249
 250     /* Rate control parameters */
 251     struct
 252     {
 253         int         i_rc_method;    /* X264_RC_* */
 254
 255         int         i_qp_constant;  /* 0-51 */
 256         int         i_qp_min;       /* min allowed QP value */
 257         int         i_qp_max;       /* max allowed QP value */
 258         int         i_qp_step;      /* max QP step between frames */
 259
 260         int         i_bitrate;
 261         float       f_rf_constant;  /* 1pass VBR, nominal QP */
 262         float       f_rate_tolerance;
 263         int         i_vbv_max_bitrate;
 264         int         i_vbv_buffer_size;
 265         float       f_vbv_buffer_init; /* <=1: fraction of buffer_size. >1: kbit */
 266         float       f_ip_factor;
 267         float       f_pb_factor;
 268
 269         int         i_aq_mode;      /* psy adaptive QP. (X264_AQ_*) */
 270         float       f_aq_strength;
 271
 272         /* 2pass */
 273         int         b_stat_write;   /* Enable stat writing in psz_stat_out */
 274         char        *psz_stat_out;
 275         int         b_stat_read;    /* Read stat from psz_stat_in and use it */
 276         char        *psz_stat_in;
 277
 278         /* 2pass params (same as ffmpeg ones) */
 279         char        *psz_rc_eq;     /* 2 pass rate control equation */
 280         float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
 281         float       f_qblur;        /* temporally blur quants */
 282         float       f_complexity_blur; /* temporally blur complexity */
 283         x264_zone_t *zones;         /* ratecontrol overrides */
 284         int         i_zones;        /* number of zone_t's */
 285         char        *psz_zones;     /* alternate method of specifying zones */
 286     } rc;
 287
 288     /* Muxing parameters */
 289     int b_aud;                  /* generate access unit delimiters */
 290     int b_repeat_headers;       /* put SPS/PPS before each keyframe */
 291     int i_sps_id;               /* SPS and PPS id number */
 292 } x264_param_t;
 293
 294 typedef struct {
 295     int level_idc;
 296     int mbps;        /* max macroblock processing rate (macroblocks/sec) */
 297     int frame_size;  /* max frame size (macroblocks) */
 298     int dpb;         /* max decoded picture buffer (bytes) */
 299     int bitrate;     /* max bitrate (kbit/sec) */
 300     int cpb;         /* max vbv buffer (kbit) */
 301     int mv_range;    /* max vertical mv component range (pixels) */
 302     int mvs_per_2mb; /* max mvs per 2 consecutive mbs. */
 303     int slice_rate;  /* ?? */
 304     int bipred8x8;   /* limit bipred to >=8x8 */
 305     int direct8x8;   /* limit b_direct to >=8x8 */
 306     int frame_only;  /* forbid interlacing */
 307 } x264_level_t;
 308
 309 /* all of the levels defined in the standard, terminated by .level_idc=0 */
 310 extern const x264_level_t x264_levels[];
 311
 312 /* x264_param_default:
 313  *      fill x264_param_t with default values and do CPU detection */
 314 void    x264_param_default( x264_param_t * );
 315
 316 /* x264_param_parse:
 317  *  set one parameter by name.
 318  *  returns 0 on success, or returns one of the following errors.
 319  *  note: BAD_VALUE occurs only if it can't even parse the value,
 320  *  numerical range is not checked until x264_encoder_open() or
 321  *  x264_encoder_reconfig().
 322  *  value=NULL means "true" for boolean options, but is a BAD_VALUE for non-booleans. */
 323 #define X264_PARAM_BAD_NAME  (-1)
 324 #define X264_PARAM_BAD_VALUE (-2)
 325 int x264_param_parse( x264_param_t *, const char *name, const char *value );
 326
 327 /****************************************************************************
 328  * Picture structures and functions.
 329  ****************************************************************************/
 330 typedef struct
 331 {
 332     int     i_csp;
 333
 334     int     i_plane;
 335     int     i_stride[4];
 336     uint8_t *plane[4];
 337 } x264_image_t;
 338
 339 typedef struct
 340 {
 341     /* In: force picture type (if not auto) XXX: ignored for now
 342      * Out: type of the picture encoded */
 343     int     i_type;
 344     /* In: force quantizer for > 0 */
 345     int     i_qpplus1;
 346     /* In: user pts, Out: pts of encoded picture (user)*/
 347     int64_t i_pts;
 348
 349     /* In: raw data */
 350     x264_image_t img;
 351 } x264_picture_t;
 352
 353 /* x264_picture_alloc:
 354  *  alloc data for a picture. You must call x264_picture_clean on it. */
 355 void x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
 356
 357 /* x264_picture_clean:
 358  *  free associated resource for a x264_picture_t allocated with
 359  *  x264_picture_alloc ONLY */
 360 void x264_picture_clean( x264_picture_t *pic );
 361
 362 /****************************************************************************
 363  * NAL structure and functions:
 364  ****************************************************************************/
 365 /* nal */
 366 enum nal_unit_type_e
 367 {
 368     NAL_UNKNOWN = 0,
 369     NAL_SLICE   = 1,
 370     NAL_SLICE_DPA   = 2,
 371     NAL_SLICE_DPB   = 3,
 372     NAL_SLICE_DPC   = 4,
 373     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
 374     NAL_SEI         = 6,    /* ref_idc == 0 */
 375     NAL_SPS         = 7,
 376     NAL_PPS         = 8,
 377     NAL_AUD         = 9,
 378     /* ref_idc == 0 for 6,9,10,11,12 */
 379 };
 380 enum nal_priority_e
 381 {
 382     NAL_PRIORITY_DISPOSABLE = 0,
 383     NAL_PRIORITY_LOW        = 1,
 384     NAL_PRIORITY_HIGH       = 2,
 385     NAL_PRIORITY_HIGHEST    = 3,
 386 };
 387
 388 typedef struct
 389 {
 390     int i_ref_idc;  /* nal_priority_e */
 391     int i_type;     /* nal_unit_type_e */
 392
 393     /* This data are raw payload */
 394     int     i_payload;
 395     uint8_t *p_payload;
 396 } x264_nal_t;
 397
 398 /* x264_nal_encode:
 399  *      encode a nal into a buffer, setting the size.
 400  *      if b_annexeb then a long synch work is added
 401  *      XXX: it currently doesn't check for overflow */
 402 int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
 403
 404 /* x264_nal_decode:
 405  *      decode a buffer nal into a x264_nal_t */
 406 int x264_nal_decode( x264_nal_t *nal, void *, int );
 407
 408 /****************************************************************************
 409  * Encoder functions:
 410  ****************************************************************************/
 411
 412 /* x264_encoder_open:
 413  *      create a new encoder handler, all parameters from x264_param_t are copied */
 414 x264_t *x264_encoder_open   ( x264_param_t * );
 415 /* x264_encoder_reconfig:
 416  *      change encoder options while encoding,
 417  *      analysis-related parameters from x264_param_t are copied */
 418 int     x264_encoder_reconfig( x264_t *, x264_param_t * );
 419 /* x264_encoder_headers:
 420  *      return the SPS and PPS that will be used for the whole stream */
 421 int     x264_encoder_headers( x264_t *, x264_nal_t **, int * );
 422 /* x264_encoder_encode:
 423  *      encode one picture */
 424 int     x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
 425 /* x264_encoder_close:
 426  *      close an encoder handler */
 427 void    x264_encoder_close  ( x264_t * );
 428
 429 #endif