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 0x0009
  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_bframe;   /* how many b-frame between 2 references pictures */
 107
 108     int         b_deblocking_filter;
 109     int         i_deblocking_filter_alphac0;    /* [-6, 6] -6 light filter, 6 strong */
 110     int         i_deblocking_filter_beta;       /* [-6, 6]  idem */
 111
 112     int         b_cabac;
 113     int         i_cabac_init_idc;
 114
 115     int         i_qp_constant;  /* 1-51 */
 116     int         i_qp_min;       /* min allowed QP value */
 117     int         i_qp_max;       /* max allowed QP value */
 118     int         i_qp_step;      /* max QP step between frames */
 119
 120     int         b_cbr;          /* constant bitrate */
 121     int         i_bitrate;
 122     int         i_rc_buffer_size;
 123     int         i_rc_init_buffer;
 124     int         i_rc_sens;      /* rate control sensitivity */
 125     float       f_ip_factor;
 126     float       f_pb_factor;
 127
 128     /* Log */
 129     void        (*pf_log)( void *, int i_level, const char *psz, va_list );
 130     void        *p_log_private;
 131     int         i_log_level;
 132
 133     /* Encoder analyser parameters */
 134     struct
 135     {
 136         unsigned int intra;     /* intra flags */
 137         unsigned int inter;     /* inter flags */
 138
 139         int          b_psnr;    /* Do we compute PSNR stats (save a few % of cpu) */
 140     } analyse;
 141
 142 } x264_param_t;
 143
 144 /* x264_param_default:
 145  *      fill x264_param_t with default values and do CPU detection */
 146 void    x264_param_default( x264_param_t * );
 147
 148 /****************************************************************************
 149  * Picture structures and functions.
 150  ****************************************************************************/
 151 typedef struct
 152 {
 153     int     i_csp;
 154
 155     int     i_plane;
 156     int     i_stride[4];
 157     uint8_t *plane[4];
 158 } x264_image_t;
 159
 160 typedef struct
 161 {
 162     /* In: force picture type (if not auto) XXX: ignored for now
 163      * Out: type of the picture encoded */
 164     int     i_type;
 165     /* In: force quantizer for > 0 */
 166     int     i_qpplus1;
 167     /* In: user pts, Out: pts of encoded picture (user)*/
 168     int64_t i_pts;
 169
 170     /* In: raw data */
 171     x264_image_t img;
 172 } x264_picture_t;
 173
 174 /* x264_picture_alloc:
 175  *  alloc data for a picture. You must call x264_picture_clean on it. */
 176 void x264_picture_alloc( x264_picture_t *pic, int i_csp, int i_width, int i_height );
 177
 178 /* x264_picture_clean:
 179  *  free associated resource for a x264_picture_t allocated with
 180  *  x264_picture_alloc ONLY */
 181 void x264_picture_clean( x264_picture_t *pic );
 182
 183 /****************************************************************************
 184  * NAL structure and functions:
 185  ****************************************************************************/
 186 /* nal */
 187 enum nal_unit_type_e
 188 {
 189     NAL_UNKNOWN = 0,
 190     NAL_SLICE   = 1,
 191     NAL_SLICE_DPA   = 2,
 192     NAL_SLICE_DPB   = 3,
 193     NAL_SLICE_DPC   = 4,
 194     NAL_SLICE_IDR   = 5,    /* ref_idc != 0 */
 195     NAL_SEI         = 6,    /* ref_idc == 0 */
 196     NAL_SPS         = 7,
 197     NAL_PPS         = 8
 198     /* ref_idc == 0 for 6,9,10,11,12 */
 199 };
 200 enum nal_priority_e
 201 {
 202     NAL_PRIORITY_DISPOSABLE = 0,
 203     NAL_PRIORITY_LOW        = 1,
 204     NAL_PRIORITY_HIGH       = 2,
 205     NAL_PRIORITY_HIGHEST    = 3,
 206 };
 207
 208 typedef struct
 209 {
 210     int i_ref_idc;  /* nal_priority_e */
 211     int i_type;     /* nal_unit_type_e */
 212
 213     /* This data are raw payload */
 214     int     i_payload;
 215     uint8_t *p_payload;
 216 } x264_nal_t;
 217
 218 /* x264_nal_encode:
 219  *      encode a nal into a buffer, setting the size.
 220  *      if b_annexeb then a long synch work is added
 221  *      XXX: it currently doesn't check for overflow */
 222 int x264_nal_encode( void *, int *, int b_annexeb, x264_nal_t *nal );
 223
 224 /* x264_nal_decode:
 225  *      decode a buffer nal into a x264_nal_t */
 226 int x264_nal_decode( x264_nal_t *nal, void *, int );
 227
 228 /****************************************************************************
 229  * Encoder functions:
 230  ****************************************************************************/
 231
 232 /* x264_encoder_open:
 233  *      create a new encoder handler, all parameters from x264_param_t are copied */
 234 x264_t *x264_encoder_open   ( x264_param_t * );
 235 /* x264_encoder_headers:
 236  *      return the SPS and PPS that will be used for the whole stream */
 237 int     x264_encoder_headers( x264_t *, x264_nal_t **, int * );
 238 /* x264_encoder_encode:
 239  *      encode one picture */
 240 int     x264_encoder_encode ( x264_t *, x264_nal_t **, int *, x264_picture_t * );
 241 /* x264_encoder_close:
 242  *      close an encoder handler */
 243 void    x264_encoder_close  ( x264_t * );
 244
 245 /* XXX: decoder isn't working so no need to export it */
 246 #if 0
 247 /****************************************************************************
 248  * Decoder functions:
 249  ****************************************************************************
 250  * XXX: Not yet working so do not try ...
 251  ****************************************************************************/
 252 /* x264_decoder_open:
 253  */
 254 x264_t *x264_decoder_open   ( x264_param_t * );
 255 /* x264_decoder_decode:
 256  */
 257 int     x264_decoder_decode ( x264_t *, x264_picture_t **, x264_nal_t * );
 258 /* x264_decoder_close:
 259  */
 260 void    x264_decoder_close  ( x264_t * );
 261 #endif
 262
 263 /****************************************************************************
 264  * Private stuff for internal usage:
 265  ****************************************************************************/
 266 #ifdef __X264__
 267 #   ifdef _MSC_VER
 268 #       define inline __inline
 269 #       define DECLARE_ALIGNED( type, var, n ) __declspec(align(n)) type var
 270 #   else
 271 #       define DECLARE_ALIGNED( type, var, n ) type var __attribute__((aligned(n)))
 272 #   endif
 273 #endif
 274
 275 #endif