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