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