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