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