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 #include <stdarg.h>
  28
  29 #define X264_BUILD 29
  30
  31 /* x264_t:
  32  *      opaque handler for decoder and encoder */
  33 typedef struct x264_t x264_t;
  34
  35 /****************************************************************************
  36  * Initialisation structure and function.
  37  ****************************************************************************/
  38 /* CPU flags
  39  */
  40 #define X264_CPU_MMX        0x000001    /* mmx */
  41 #define X264_CPU_MMXEXT     0x000002    /* mmx-ext*/
  42 #define X264_CPU_SSE        0x000004    /* sse */
  43 #define X264_CPU_SSE2       0x000008    /* sse 2 */
  44 #define X264_CPU_3DNOW      0x000010    /* 3dnow! */
  45 #define X264_CPU_3DNOWEXT   0x000020    /* 3dnow! ext */
  46 #define X264_CPU_ALTIVEC    0x000040    /* altivec */
  47
  48 /* Analyse flags
  49  */
  50 #define X264_ANALYSE_I4x4       0x0001  /* Analyse i4x4 */
  51 #define X264_ANALYSE_I8x8       0x0002  /* Analyse i8x8 (requires 8x8 transform) */
  52 #define X264_ANALYSE_PSUB16x16  0x0010  /* Analyse p16x8, p8x16 and p8x8 */
  53 #define X264_ANALYSE_PSUB8x8    0x0020  /* Analyse p8x4, p4x8, p4x4 */
  54 #define X264_ANALYSE_BSUB16x16  0x0100  /* Analyse b16x8, b8x16 and b8x8 */
  55 #define X264_DIRECT_PRED_NONE        0
  56 #define X264_DIRECT_PRED_SPATIAL     1
  57 #define X264_DIRECT_PRED_TEMPORAL    2
  58 #define X264_ME_DIA                  0
  59 #define X264_ME_HEX                  1
  60 #define X264_ME_UMH                  2
  61 #define X264_ME_ESA                  3
  62
  63 /* Colorspace type
  64  */
  65 #define X264_CSP_MASK           0x00ff  /* */
  66 #define X264_CSP_NONE           0x0000  /* Invalid mode     */
  67 #define X264_CSP_I420           0x0001  /* yuv 4:2:0 planar */
  68 #define X264_CSP_I422           0x0002  /* yuv 4:2:2 planar */
  69 #define X264_CSP_I444           0x0003  /* yuv 4:4:4 planar */
  70 #define X264_CSP_YV12           0x0004  /* yuv 4:2:0 planar */
  71 #define X264_CSP_YUYV           0x0005  /* yuv 4:2:2 packed */
  72 #define X264_CSP_RGB            0x0006  /* rgb 24bits       */
  73 #define X264_CSP_BGR            0x0007  /* bgr 24bits       */
  74 #define X264_CSP_BGRA           0x0008  /* bgr 32bits       */
  75 #define X264_CSP_VFLIP          0x1000  /* */
  76
  77 /* Slice type
  78  */
  79 #define X264_TYPE_AUTO          0x0000  /* Let x264 choose the right type */
  80 #define X264_TYPE_IDR           0x0001
  81 #define X264_TYPE_I             0x0002
  82 #define X264_TYPE_P             0x0003
  83 #define X264_TYPE_BREF          0x0004  /* Non-disposable B-frame */
  84 #define X264_TYPE_B             0x0005
  85 #define IS_X264_TYPE_I(x) ((x)==X264_TYPE_I || (x)==X264_TYPE_IDR)
  86 #define IS_X264_TYPE_B(x) ((x)==X264_TYPE_B || (x)==X264_TYPE_BREF)
  87
  88 /* Log level
  89  */
  90 #define X264_LOG_NONE          (-1)
  91 #define X264_LOG_ERROR          0
  92 #define X264_LOG_WARNING        1
  93 #define X264_LOG_INFO           2
  94 #define X264_LOG_DEBUG          3
  95
  96 typedef struct
  97 {
  98     int i_start, i_end;
  99     int b_force_qp;
 100     int i_qp;
 101     float f_bitrate_factor;
 102 } x264_zone_t;
 103
 104 typedef struct
 105 {
 106     /* CPU flags */
 107     unsigned int cpu;
 108     int         i_threads;  /* divide each frame into multiple slices, encode in parallel */
 109
 110     /* Video Properties */
 111     int         i_width;
 112     int         i_height;
 113     int         i_csp;  /* CSP of encoded bitstream, only i420 supported */
 114     int         i_level_idc;
 115
 116     struct
 117     {
 118         /* they will be reduced to be 0 < x <= 65535 and prime */
 119         int         i_sar_height;
 120         int         i_sar_width;
 121     } vui;
 122
 123     int         i_fps_num;
 124     int         i_fps_den;
 125
 126     /* Bitstream parameters */
 127     int         i_frame_reference;  /* Maximum number of reference frames */
 128     int         i_keyint_max;       /* Force an IDR keyframe at this interval */
 129     int         i_keyint_min;       /* Scenecuts closer together than this are coded as I, not IDR. */
 130     int         i_scenecut_threshold; /* how aggressively to insert extra I frames */
 131     int         i_bframe;   /* how many b-frame between 2 references pictures */
 132     int         b_bframe_adaptive;
 133     int         i_bframe_bias;
 134     int         b_bframe_pyramid;   /* Keep some B-frames as references */
 135
 136     int         b_deblocking_filter;
 137     int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
 138     int         i_deblocking_filter_beta;       /* [-6, 6]  idem */
 139
 140     int         b_cabac;
 141     int         i_cabac_init_idc;
 142
 143
 144     /* Log */
 145     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
 146     void        *p_log_private;
 147     int         i_log_level;
 148     int         b_visualize;
 149
 150     /* Encoder analyser parameters */
 151     struct
 152     {
 153         unsigned int intra;     /* intra partitions */
 154         unsigned int inter;     /* inter partitions */
 155
 156         int          b_transform_8x8;
 157
 158         int          i_direct_mv_pred; /* spatial vs temporal mv prediction */
 159         int          i_me_method; /* motion estimation algorithm to use (X264_ME_*) */
 160         int          i_me_range; /* integer pixel motion estimation search range (from predicted mv) */
 161         int          i_subpel_refine; /* subpixel motion estimation quality */
 162         int          b_chroma_me; /* chroma ME for subpel and mode decision in P-frames */
 163         int          i_mv_range; /* maximum length of a mv (in pixels) */
 164
 165         int          b_weighted_bipred; /* implicit weighting for B-frames */
 166
 167         int          i_chroma_qp_offset;
 168
 169         int          b_psnr;    /* Do we compute PSNR stats (save a few % of cpu) */
 170     } analyse;
 171
 172     /* Rate control parameters */
 173     struct
 174     {
 175         int         i_qp_constant;  /* 1-51 */
 176         int         i_qp_min;       /* min allowed QP value */
 177         int         i_qp_max;       /* max allowed QP value */
 178         int         i_qp_step;      /* max QP step between frames */
 179
 180         int         b_cbr;          /* use bitrate instead of CQP */
 181         int         i_bitrate;
 182         float       f_rate_tolerance;
 183         int         i_vbv_max_bitrate;
 184         int         i_vbv_buffer_size;
 185         float       f_vbv_buffer_init;
 186         float       f_ip_factor;
 187         float       f_pb_factor;
 188
 189         /* 2pass */
 190         int         b_stat_write;   /* Enable stat writing in psz_stat_out */
 191         char        *psz_stat_out;
 192         int         b_stat_read;    /* Read stat from psz_stat_in and use it */
 193         char        *psz_stat_in;
 194
 195         /* 2pass params (same as ffmpeg ones) */
 196         char        *psz_rc_eq;     /* 2 pass rate control equation */
 197         float       f_qcompress;    /* 0.0 => cbr, 1.0 => constant qp */
 198         float       f_qblur;        /* temporally blur quants */
 199         float       f_complexity_blur; /* temporally blur complexity */
 200         x264_zone_t *zones;         /* ratecontrol overrides */
 201         int         i_zones;        /* sumber of zone_t's */
 202         char        *psz_zones;     /* alternate method of specifying zones */
 203     } rc;
 204
 205     int b_aud;                  /* generate access unit delimiters */
 206 } x264_param_t;
 207
 208 /* x264_param_default:
 209  *      fill x264_param_t with default values and do CPU detection */
 210 void    x264_param_default( x264_param_t * );
 211
 212 /****************************************************************************
 213  * Picture structures and functions.
 214  ****************************************************************************/
 215 typedef struct
 216 {
 217     int     i_csp;
 218
 219     int     i_plane;
 220     int     i_stride[4];
 221     uint8_t *plane[4];
 222 } x264_image_t;
 223
 224 typedef struct
 225 {
 226     /* In: force picture type (if not auto) XXX: ignored for now
 227      * Out: type of the picture encoded */
 228     int     i_type;
 229     /* In: force quantizer for > 0 */
 230     int     i_qpplus1;
 231     /* In: user pts, Out: pts of encoded picture (user)*/
 232     int64_t i_pts;
 233
 234     /* In: raw data */
 235     x264_image_t img;
 236 } x264_picture_t;
 237
 238 /* x264_picture_alloc:
 239  *  alloc data for a picture. You must call x264_picture_clean on it. */
 240 void x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
 241
 242 /* x264_picture_clean:
 243  *  free associated resource for a x264_picture_t allocated with
 244  *  x264_picture_alloc ONLY */
 245 void x264_picture_clean( x264_picture_t *pic );
 246
 247 /****************************************************************************
 248  * NAL structure and functions:
 249  ****************************************************************************/
 250 /* nal */
 251 enum nal_unit_type_e
 252 {
 253     NAL_UNKNOWN = 0,
 254     NAL_SLICE   = 1,
 255     NAL_SLICE_DPA   = 2,
 256     NAL_SLICE_DPB   = 3,
 257     NAL_SLICE_DPC   = 4,
 258     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
 259     NAL_SEI         = 6,    /* ref_idc == 0 */
 260     NAL_SPS         = 7,
 261     NAL_PPS         = 8,
 262     NAL_AUD         = 9,
 263     /* ref_idc == 0 for 6,9,10,11,12 */
 264 };
 265 enum nal_priority_e
 266 {
 267     NAL_PRIORITY_DISPOSABLE = 0,
 268     NAL_PRIORITY_LOW        = 1,
 269     NAL_PRIORITY_HIGH       = 2,
 270     NAL_PRIORITY_HIGHEST    = 3,
 271 };
 272
 273 typedef struct
 274 {
 275     int i_ref_idc;  /* nal_priority_e */
 276     int i_type;     /* nal_unit_type_e */
 277
 278     /* This data are raw payload */
 279     int     i_payload;
 280     uint8_t *p_payload;
 281 } x264_nal_t;
 282
 283 /* x264_nal_encode:
 284  *      encode a nal into a buffer, setting the size.
 285  *      if b_annexeb then a long synch work is added
 286  *      XXX: it currently doesn't check for overflow */
 287 int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
 288
 289 /* x264_nal_decode:
 290  *      decode a buffer nal into a x264_nal_t */
 291 int x264_nal_decode( x264_nal_t *nal, void *, int );
 292
 293 /****************************************************************************
 294  * Encoder functions:
 295  ****************************************************************************/
 296
 297 /* x264_encoder_open:
 298  *      create a new encoder handler, all parameters from x264_param_t are copied */
 299 x264_t *x264_encoder_open   ( x264_param_t * );
 300 /* x264_encoder_reconfig:
 301  *      change encoder options while encoding,
 302  *      analysis-related parameters from x264_param_t are copied */
 303 int     x264_encoder_reconfig( x264_t *, x264_param_t * );
 304 /* x264_encoder_headers:
 305  *      return the SPS and PPS that will be used for the whole stream */
 306 int     x264_encoder_headers( x264_t *, x264_nal_t **, int * );
 307 /* x264_encoder_encode:
 308  *      encode one picture */
 309 int     x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t *, x264_picture_t * );
 310 /* x264_encoder_close:
 311  *      close an encoder handler */
 312 void    x264_encoder_close  ( x264_t * );
 313
 314 /* XXX: decoder isn't working so no need to export it */
 315 #if 0
 316 /****************************************************************************
 317  * Decoder functions:
 318  ****************************************************************************
 319  * XXX: Not yet working so do not try ...
 320  ****************************************************************************/
 321 /* x264_decoder_open:
 322  */
 323 x264_t *x264_decoder_open   ( x264_param_t * );
 324 /* x264_decoder_decode:
 325  */
 326 int     x264_decoder_decode ( x264_t *, x264_picture_t **, x264_nal_t * );
 327 /* x264_decoder_close:
 328  */
 329 void    x264_decoder_close  ( x264_t * );
 330 #endif
 331
 332 /****************************************************************************
 333  * Private stuff for internal usage:
 334  ****************************************************************************/
 335 #ifdef __X264__
 336 #   ifdef _MSC_VER
 337 #       define inline __inline
 338 #       define DECLARE_ALIGNED( type, var, n ) __declspec(align(n)) type var
 339 #   else
 340 #       define DECLARE_ALIGNED( type, var, n ) type var __attribute__((aligned(n)))
 341 #   endif
 342 #endif
 343
 344 #endif