[svn] / branches / dev-api-3 / xvidcore / src / xvid.h Repository:
ViewVC logotype

Annotation of /branches/dev-api-3/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 617 - (view) (download)

1 : edgomez 199 /*****************************************************************************
2 :     *
3 :     * XVID MPEG-4 VIDEO CODEC
4 :     * - XviD Main header file -
5 :     *
6 :     * This program is free software ; you can redistribute it and/or modify
7 :     * it under the terms of the GNU General Public License as published by
8 :     * the Free Software Foundation ; either version 2 of the License, or
9 :     * (at your option) any later version.
10 :     *
11 :     * This program is distributed in the hope that it will be useful,
12 :     * but WITHOUT ANY WARRANTY ; without even the implied warranty of
13 :     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 :     * GNU General Public License for more details.
15 :     *
16 :     * You should have received a copy of the GNU General Public License
17 :     * along with this program ; if not, write to the Free Software
18 :     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 :     *
20 :     *****************************************************************************/
21 :     /*****************************************************************************
22 :     *
23 :     * History
24 :     *
25 :     * - 2002/06/13 Added legal header, ANSI C comment style (only for this header
26 :     * as it can be included in a ANSI C project).
27 :     *
28 :     * ToDo ? : when BFRAMES is defined, the API_VERSION should not
29 :     * be the same (3.0 ?)
30 :     *
31 : Isibaar 617 * $Id: xvid.h,v 1.17.2.5 2002-10-30 23:11:35 Isibaar Exp $
32 : edgomez 199 *
33 :     *****************************************************************************/
34 :    
35 :    
36 :     #ifndef _XVID_H_
37 :     #define _XVID_H_
38 :    
39 :     #ifdef __cplusplus
40 : chl 352 extern "C" {
41 : edgomez 199 #endif
42 :    
43 :     /*****************************************************************************
44 :     * Global constants
45 :     ****************************************************************************/
46 :    
47 :     /* API Version : 2.1 */
48 :     #define API_VERSION ((2 << 16) | (1))
49 :    
50 : Isibaar 602 /* Bitstream Version
51 :     * this will be writen into the bitstream to allow easy detection of xvid
52 :     * encoder bugs in the decoder, without this it might not possible to
53 :     * automatically distinquish between a file which has been encoded with an
54 :     * old & buggy XVID from a file which has been encoded with a bugfree version
55 :     * see the infamous interlacing bug ...
56 :     *
57 :     * this MUST be increased if an encoder bug is fixed, increasing it too often
58 :     * doesnt hurt but not increasing it could cause difficulty for decoders in the
59 :     * future
60 :     */
61 : Isibaar 617 #define XVID_BS_VERSION "0003"
62 : edgomez 199
63 : Isibaar 602
64 : edgomez 199 /* Error codes */
65 :     #define XVID_ERR_FAIL -1
66 :     #define XVID_ERR_OK 0
67 :     #define XVID_ERR_MEMORY 1
68 :     #define XVID_ERR_FORMAT 2
69 :    
70 :    
71 :     /* Colorspaces */
72 : suxen_drol 582 #define XVID_CSP_RGB24 0 /* [b|g|r] */
73 : edgomez 199 #define XVID_CSP_YV12 1
74 :     #define XVID_CSP_YUY2 2
75 :     #define XVID_CSP_UYVY 3
76 :     #define XVID_CSP_I420 4
77 :     #define XVID_CSP_RGB555 10
78 :     #define XVID_CSP_RGB565 11
79 :     #define XVID_CSP_USER 12
80 :     #define XVID_CSP_EXTERN 1004 // per slice rendering
81 :     #define XVID_CSP_YVYU 1002
82 : suxen_drol 582 #define XVID_CSP_RGB32 1000 /* [b|g|r|a] */
83 :     #define XVID_CSP_ABGR 1006 /* [a|b|g|r] */
84 :     #define XVID_CSP_RGBA 1005 /* [r|g|b|a] */
85 :    
86 :    
87 :    
88 : edgomez 199 #define XVID_CSP_NULL 9999
89 :    
90 :     #define XVID_CSP_VFLIP 0x80000000 // flip mask
91 :    
92 :    
93 :     /*****************************************************************************
94 : albeu 315 * Initialization constants
95 : edgomez 199 ****************************************************************************/
96 :    
97 :     /* CPU flags for XVID_INIT_PARAM.cpu_flags */
98 :    
99 :     #define XVID_CPU_MMX 0x00000001
100 :     #define XVID_CPU_MMXEXT 0x00000002
101 :     #define XVID_CPU_SSE 0x00000004
102 :     #define XVID_CPU_SSE2 0x00000008
103 :     #define XVID_CPU_3DNOW 0x00000010
104 :     #define XVID_CPU_3DNOWEXT 0x00000020
105 :    
106 :     #define XVID_CPU_TSC 0x00000040
107 : Isibaar 209
108 : edgomez 199 #define XVID_CPU_IA64 0x00000080
109 :    
110 :     #define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */
111 :     #define XVID_CPU_FORCE 0x80000000
112 :    
113 :    
114 : Isibaar 209 /*****************************************************************************
115 : edgomez 199 * Initialization structures
116 : Isibaar 209 ****************************************************************************/
117 :    
118 :     typedef struct
119 : suxen_drol 234 {
120 : edgomez 199 int cpu_flags;
121 :     int api_version;
122 :     int core_build;
123 :     }
124 :     XVID_INIT_PARAM;
125 :    
126 :     /*****************************************************************************
127 :     * Initialization entry point
128 :     ****************************************************************************/
129 :    
130 :     int xvid_init(void *handle,
131 :     int opt,
132 :     void *param1,
133 :     void *param2);
134 :    
135 :    
136 :     /*****************************************************************************
137 :     * Decoder constants
138 :     ****************************************************************************/
139 :    
140 :     /* Flags for XVID_DEC_FRAME.general */
141 :     #define XVID_QUICK_DECODE 0x00000010
142 :    
143 :     /*****************************************************************************
144 :     * Decoder structures
145 :     ****************************************************************************/
146 :    
147 :     typedef struct
148 :     {
149 :     int width;
150 :     int height;
151 :     void *handle;
152 :     }
153 :     XVID_DEC_PARAM;
154 :    
155 :    
156 :     typedef struct
157 :     {
158 :     int general;
159 :     void *bitstream;
160 :     int length;
161 :    
162 :     void *image;
163 :     int stride;
164 :     int colorspace;
165 :     }
166 :     XVID_DEC_FRAME;
167 :    
168 :    
169 :     // This struct is used for per slice rendering
170 :     typedef struct
171 :     {
172 :     void *y,*u,*v;
173 :     int stride_y, stride_u,stride_v;
174 :     } XVID_DEC_PICTURE;
175 :    
176 : albeu 315
177 :     /*****************************************************************************
178 :     * Decoder entry point
179 :     ****************************************************************************/
180 :    
181 :     /* decoder options */
182 :     #define XVID_DEC_DECODE 0
183 :     #define XVID_DEC_CREATE 1
184 : edgomez 199 #define XVID_DEC_DESTROY 2
185 :    
186 :     int xvid_decore(void *handle,
187 :     int opt,
188 :     void *param1,
189 :     void *param2);
190 :    
191 :    
192 :     /*****************************************************************************
193 :     * Encoder constants
194 :     ****************************************************************************/
195 :    
196 :     /* Flags for XVID_ENC_PARAM.global */
197 :     #define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */
198 :     #define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */
199 :     #define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */
200 :    
201 :     /* Flags for XVID_ENC_FRAME.general */
202 :     #define XVID_VALID_FLAGS 0x80000000
203 :    
204 :     #define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */
205 : suxen_drol 234 #define XVID_H263QUANT 0x00000010
206 :     #define XVID_MPEGQUANT 0x00000020
207 :     #define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */
208 : Isibaar 579 #define XVID_QUARTERPEL 0x02000000
209 : suxen_drol 234 #define XVID_ADAPTIVEQUANT 0x00000080
210 :     #define XVID_LUMIMASKING 0x00000100
211 : edgomez 199 #define XVID_LATEINTRA 0x00000200
212 :    
213 :     #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */
214 :     #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */
215 :     #define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */
216 :    
217 :     #define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */
218 :     #define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */
219 :    
220 :     #define XVID_INTER4V 0x00008000
221 :    
222 :     #define XVID_ME_ZERO 0x00010000
223 :     #define XVID_ME_LOGARITHMIC 0x00020000
224 :     #define XVID_ME_FULLSEARCH 0x00040000
225 :     #define XVID_ME_PMVFAST 0x00080000
226 :     #define XVID_ME_EPZS 0x00100000
227 :    
228 :    
229 :     #define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */
230 : Isibaar 579 #define XVID_GRAYSCALE 0x01000000 /* color input material chroma is ignored) */
231 : edgomez 199
232 :    
233 :     /* Flags for XVID_ENC_FRAME.motion */
234 :     #define PMV_ADVANCEDDIAMOND8 0x00004000
235 :     #define PMV_ADVANCEDDIAMOND16 0x00008000
236 : chl 352
237 :     #define PMV_HALFPELDIAMOND16 0x00010000
238 :     #define PMV_HALFPELREFINE16 0x00020000
239 : Isibaar 579 #define PMV_QUARTERPELREFINE16 0x00040000
240 :     #define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */
241 : edgomez 199 #define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more refinement */
242 :     #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */
243 :     #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */
244 :     #define PMV_USESQUARES16 0x00800000
245 :    
246 :     #define PMV_HALFPELDIAMOND8 0x01000000
247 :     #define PMV_HALFPELREFINE8 0x02000000
248 : Isibaar 579 #define PMV_QUARTERPELREFINE8 0x04000000
249 :     #define PMV_EXTSEARCH8 0x08000000 /* extend PMV by more searches */
250 : edgomez 199 #define PMV_QUICKSTOP8 0x10000000 /* like early, but without any more refinement */
251 :     #define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */
252 :     #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */
253 :     #define PMV_USESQUARES8 0x80000000
254 :    
255 :    
256 :     /*****************************************************************************
257 :     * Encoder structures
258 :     ****************************************************************************/
259 :    
260 :     typedef struct
261 :     {
262 :     int width, height;
263 :     int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */
264 :     int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */
265 :     int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */
266 :     int rc_averaging_period; /* as above */
267 :     int rc_buffer; /* as above */
268 :     int max_quantizer; /* the upper limit of the quantizer */
269 :     int min_quantizer; /* the lower limit of the quantizer */
270 :     int max_key_interval; /* the maximum interval between key frames */
271 :     #ifdef _SMP
272 :     int num_threads; /* number of threads */
273 :     #endif
274 :     #ifdef BFRAMES
275 :     int global; /* global/debug options */
276 :     int max_bframes; /* max sequential bframes (0=disable bframes) */
277 :     int bquant_ratio; /* bframe quantizer multipier (percentage).
278 :     * used only when bquant < 1
279 :     * eg. 200 = x2 multiplier
280 : suxen_drol 295 * quant = ((past_quant + future_quant) * bquant_ratio)/200
281 :     */
282 :     int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */
283 : edgomez 199 #endif
284 : suxen_drol 234 void *handle; /* [out] encoder instance handle */
285 : edgomez 199 }
286 :     XVID_ENC_PARAM;
287 :    
288 :     typedef struct
289 :     {
290 :     int x;
291 : suxen_drol 324 int y;
292 : edgomez 199 }
293 :     VECTOR;
294 :    
295 :     typedef struct
296 :     {
297 :     int mode; /* macroblock mode */
298 :     VECTOR mvs[4];
299 :     }
300 :     MVBLOCKHINT;
301 :    
302 :     typedef struct
303 :     {
304 :     int intra; /* frame intra choice */
305 :     int fcode; /* frame fcode */
306 :     MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */
307 :     }
308 :     MVFRAMEHINT;
309 :    
310 :     typedef struct
311 :     {
312 :     int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */
313 :    
314 :     MVFRAMEHINT mvhint;
315 :     void *hintstream; /* compressed hint buffer */
316 :     int hintlength; /* length of buffer (bytes) */
317 :     }
318 :     HINTINFO;
319 :    
320 :     typedef struct
321 :     {
322 :     int general; /* [in] general options */
323 :     int motion; /* [in] ME options */
324 :     void *bitstream; /* [in] bitstream ptr */
325 :     int length; /* [out] bitstream length (bytes) */
326 :    
327 :     void *image; /* [in] image ptr */
328 :     int colorspace; /* [in] source colorspace */
329 :    
330 :     unsigned char *quant_intra_matrix; // [in] custom intra qmatrix */
331 :     unsigned char *quant_inter_matrix; // [in] custom inter qmatrix */
332 :     int quant; /* [in] frame quantizer (vbr) */
333 :     int intra; /* [in] force intra frame (vbr only)
334 :     * [out] intra state
335 :     */
336 :     HINTINFO hint; /* [in/out] mv hint information */
337 :    
338 :     #ifdef BFRAMES
339 :     int bquant; /* [in] bframe quantizer */
340 :     #endif
341 :    
342 :     }
343 :     XVID_ENC_FRAME;
344 :    
345 :    
346 :     typedef struct
347 :     {
348 :     int quant; /* [out] frame quantizer */
349 :     int hlength; /* [out] header length (bytes) */
350 :     int kblks, mblks, ublks; /* [out] */
351 :    
352 :     }
353 :     XVID_ENC_STATS;
354 :    
355 :    
356 :     /*****************************************************************************
357 :     * Encoder entry point
358 :     ****************************************************************************/
359 :    
360 :     /* Encoder options */
361 :     #define XVID_ENC_ENCODE 0
362 :     #define XVID_ENC_CREATE 1
363 :     #define XVID_ENC_DESTROY 2
364 :    
365 :     int xvid_encore(void *handle,
366 :     int opt,
367 :     void *param1,
368 :     void *param2);
369 :    
370 :    
371 :     #ifdef __cplusplus
372 :     }
373 :     #endif
374 :    
375 :     #endif

No admin address has been configured
ViewVC Help
Powered by ViewVC 1.0.4