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