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