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