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