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

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