[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 747 - (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 : suxen_drol 747 * $Id: xvid.h,v 1.17.2.17 2002-12-29 06:48:25 suxen_drol 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 : suxen_drol 725 #define XVID_API_UNSTABLE
50 : edgomez 199
51 : Isibaar 602 /* Bitstream Version
52 :     * this will be writen into the bitstream to allow easy detection of xvid
53 :     * encoder bugs in the decoder, without this it might not possible to
54 :     * automatically distinquish between a file which has been encoded with an
55 :     * old & buggy XVID from a file which has been encoded with a bugfree version
56 :     * see the infamous interlacing bug ...
57 :     *
58 :     * this MUST be increased if an encoder bug is fixed, increasing it too often
59 :     * doesnt hurt but not increasing it could cause difficulty for decoders in the
60 :     * future
61 :     */
62 : Isibaar 617 #define XVID_BS_VERSION "0003"
63 : edgomez 199
64 : Isibaar 602
65 : edgomez 199 /* Error codes */
66 :     #define XVID_ERR_FAIL -1
67 :     #define XVID_ERR_OK 0
68 :     #define XVID_ERR_MEMORY 1
69 :     #define XVID_ERR_FORMAT 2
70 :    
71 :    
72 :     /* Colorspaces */
73 : suxen_drol 582 #define XVID_CSP_RGB24 0 /* [b|g|r] */
74 : edgomez 199 #define XVID_CSP_YV12 1
75 :     #define XVID_CSP_YUY2 2
76 :     #define XVID_CSP_UYVY 3
77 :     #define XVID_CSP_I420 4
78 :     #define XVID_CSP_RGB555 10
79 :     #define XVID_CSP_RGB565 11
80 :     #define XVID_CSP_USER 12
81 :     #define XVID_CSP_EXTERN 1004 // per slice rendering
82 :     #define XVID_CSP_YVYU 1002
83 : suxen_drol 582 #define XVID_CSP_RGB32 1000 /* [b|g|r|a] */
84 :     #define XVID_CSP_ABGR 1006 /* [a|b|g|r] */
85 :     #define XVID_CSP_RGBA 1005 /* [r|g|b|a] */
86 :    
87 :    
88 :    
89 : edgomez 199 #define XVID_CSP_NULL 9999
90 :    
91 :     #define XVID_CSP_VFLIP 0x80000000 // flip mask
92 :    
93 :    
94 :     /*****************************************************************************
95 : albeu 315 * Initialization constants
96 : edgomez 199 ****************************************************************************/
97 :    
98 :     /* CPU flags for XVID_INIT_PARAM.cpu_flags */
99 :    
100 :     #define XVID_CPU_MMX 0x00000001
101 :     #define XVID_CPU_MMXEXT 0x00000002
102 :     #define XVID_CPU_SSE 0x00000004
103 :     #define XVID_CPU_SSE2 0x00000008
104 :     #define XVID_CPU_3DNOW 0x00000010
105 :     #define XVID_CPU_3DNOWEXT 0x00000020
106 :    
107 :     #define XVID_CPU_TSC 0x00000040
108 : Isibaar 209
109 : edgomez 199 #define XVID_CPU_IA64 0x00000080
110 :    
111 :     #define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */
112 :     #define XVID_CPU_FORCE 0x80000000
113 :    
114 : suxen_drol 634 typedef struct
115 :     {
116 :     int colorspace;
117 :     void * y;
118 :     void * u;
119 :     void * v;
120 :     int y_stride;
121 :     int uv_stride;
122 :     } XVID_IMAGE; /* from yv12 */
123 : edgomez 199
124 : suxen_drol 634 #define XVID_INIT_INIT 0
125 :     #define XVID_INIT_CONVERT 1
126 :    
127 : Isibaar 209 /*****************************************************************************
128 : edgomez 199 * Initialization structures
129 : Isibaar 209 ****************************************************************************/
130 :    
131 :     typedef struct
132 : suxen_drol 234 {
133 : edgomez 199 int cpu_flags;
134 :     int api_version;
135 :     int core_build;
136 :     }
137 :     XVID_INIT_PARAM;
138 :    
139 : suxen_drol 634 typedef struct
140 :     {
141 :     XVID_IMAGE input;
142 :     XVID_IMAGE output;
143 :     int width;
144 :     int height;
145 :     int interlacing;
146 :     } XVID_INIT_CONVERTINFO;
147 :    
148 : edgomez 199 /*****************************************************************************
149 :     * Initialization entry point
150 :     ****************************************************************************/
151 :    
152 :     int xvid_init(void *handle,
153 :     int opt,
154 :     void *param1,
155 :     void *param2);
156 :    
157 :    
158 :     /*****************************************************************************
159 :     * Decoder constants
160 :     ****************************************************************************/
161 :    
162 :     /* Flags for XVID_DEC_FRAME.general */
163 : suxen_drol 707 #define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. video-for-windows) */
164 : suxen_drol 715 #define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */
165 : suxen_drol 747 #define XVID_DEC_DEBLOCKUV 0x00000008 /* chroma deblocking */
166 : suxen_drol 725 #define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream; instructs
167 :     decoder to ignore any previous reference frames */
168 : edgomez 199 #define XVID_QUICK_DECODE 0x00000010
169 :    
170 :     /*****************************************************************************
171 :     * Decoder structures
172 :     ****************************************************************************/
173 :    
174 :     typedef struct
175 :     {
176 :     int width;
177 :     int height;
178 :     void *handle;
179 :     }
180 :     XVID_DEC_PARAM;
181 :    
182 :    
183 : suxen_drol 631 #define XVID_DEC_VOP 0
184 :     #define XVID_DEC_VOL 1
185 : suxen_drol 707 #define XVID_DEC_NOTHING 2 /* nothing was decoded */
186 : suxen_drol 631
187 : edgomez 199 typedef struct
188 :     {
189 : suxen_drol 631 int notify; /* [out] output 'mode' */
190 :     union
191 :     {
192 :     struct /* XVID_DEC_VOP */
193 :     {
194 :     int time_base; /* [out] time base */
195 :     int time_increment; /* [out] time increment */
196 :     } vop;
197 :     struct /* XVID_DEC_VOL */
198 :     {
199 :     int general; /* [out] flags: eg. frames are interlaced */
200 :     int width; /* [out] width */
201 :     int height; /* [out] height */
202 :     int aspect_ratio; /* [out] aspect ratio */
203 :     int par_width; /* [out] aspect ratio width */
204 :     int par_height; /* [out] aspect ratio height */
205 :     } vol;
206 :     } data;
207 :     } XVID_DEC_STATS;
208 :    
209 :    
210 :     typedef struct
211 :     {
212 : edgomez 199 int general;
213 :     void *bitstream;
214 :     int length;
215 :    
216 :     void *image;
217 :     int stride;
218 :     int colorspace;
219 :     }
220 :     XVID_DEC_FRAME;
221 :    
222 :    
223 :     // This struct is used for per slice rendering
224 :     typedef struct
225 :     {
226 :     void *y,*u,*v;
227 :     int stride_y, stride_u,stride_v;
228 :     } XVID_DEC_PICTURE;
229 :    
230 : albeu 315
231 :     /*****************************************************************************
232 :     * Decoder entry point
233 :     ****************************************************************************/
234 :    
235 :     /* decoder options */
236 :     #define XVID_DEC_DECODE 0
237 :     #define XVID_DEC_CREATE 1
238 : edgomez 199 #define XVID_DEC_DESTROY 2
239 :    
240 :     int xvid_decore(void *handle,
241 :     int opt,
242 :     void *param1,
243 :     void *param2);
244 :    
245 :    
246 :     /*****************************************************************************
247 :     * Encoder constants
248 :     ****************************************************************************/
249 :    
250 :     /* Flags for XVID_ENC_PARAM.global */
251 :     #define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */
252 :     #define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */
253 :     #define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */
254 : suxen_drol 701 #define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */
255 : edgomez 199
256 :     /* Flags for XVID_ENC_FRAME.general */
257 :     #define XVID_VALID_FLAGS 0x80000000
258 :    
259 :     #define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */
260 : suxen_drol 234 #define XVID_H263QUANT 0x00000010
261 :     #define XVID_MPEGQUANT 0x00000020
262 :     #define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */
263 : Isibaar 579 #define XVID_QUARTERPEL 0x02000000
264 : suxen_drol 234 #define XVID_ADAPTIVEQUANT 0x00000080
265 :     #define XVID_LUMIMASKING 0x00000100
266 : edgomez 199 #define XVID_LATEINTRA 0x00000200
267 :    
268 :     #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */
269 :     #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */
270 :     #define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */
271 :    
272 :     #define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */
273 :     #define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */
274 :    
275 :     #define XVID_INTER4V 0x00008000
276 :    
277 :     #define XVID_ME_ZERO 0x00010000
278 :     #define XVID_ME_LOGARITHMIC 0x00020000
279 :     #define XVID_ME_FULLSEARCH 0x00040000
280 :     #define XVID_ME_PMVFAST 0x00080000
281 :     #define XVID_ME_EPZS 0x00100000
282 :    
283 :     #define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */
284 : Isibaar 579 #define XVID_GRAYSCALE 0x01000000 /* color input material chroma is ignored) */
285 : edgomez 199
286 : syskin 627 #define XVID_GMC 0x20000000
287 :     #define XVID_ME_COLOUR 0x40000000
288 : edgomez 199
289 : suxen_drol 701 #define XVID_REDUCED 0x04000000 /* reduced resolution vop */
290 :    
291 : edgomez 199 /* Flags for XVID_ENC_FRAME.motion */
292 :     #define PMV_ADVANCEDDIAMOND8 0x00004000
293 :     #define PMV_ADVANCEDDIAMOND16 0x00008000
294 : chl 352
295 :     #define PMV_HALFPELDIAMOND16 0x00010000
296 :     #define PMV_HALFPELREFINE16 0x00020000
297 : Isibaar 579 #define PMV_QUARTERPELREFINE16 0x00040000
298 :     #define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */
299 : edgomez 199 #define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more refinement */
300 :     #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */
301 :     #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */
302 :     #define PMV_USESQUARES16 0x00800000
303 :    
304 :     #define PMV_HALFPELDIAMOND8 0x01000000
305 :     #define PMV_HALFPELREFINE8 0x02000000
306 : Isibaar 579 #define PMV_QUARTERPELREFINE8 0x04000000
307 :     #define PMV_EXTSEARCH8 0x08000000 /* extend PMV by more searches */
308 : edgomez 199 #define PMV_QUICKSTOP8 0x10000000 /* like early, but without any more refinement */
309 :     #define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */
310 :     #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */
311 :     #define PMV_USESQUARES8 0x80000000
312 :    
313 :    
314 : syskin 627
315 : edgomez 199 /*****************************************************************************
316 :     * Encoder structures
317 :     ****************************************************************************/
318 :    
319 :     typedef struct
320 :     {
321 :     int width, height;
322 :     int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */
323 :     int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */
324 :     int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */
325 :     int rc_averaging_period; /* as above */
326 :     int rc_buffer; /* as above */
327 :     int max_quantizer; /* the upper limit of the quantizer */
328 :     int min_quantizer; /* the lower limit of the quantizer */
329 :     int max_key_interval; /* the maximum interval between key frames */
330 :     #ifdef _SMP
331 :     int num_threads; /* number of threads */
332 :     #endif
333 :     int global; /* global/debug options */
334 :     int max_bframes; /* max sequential bframes (0=disable bframes) */
335 :     int bquant_ratio; /* bframe quantizer multipier (percentage).
336 :     * used only when bquant < 1
337 :     * eg. 200 = x2 multiplier
338 : suxen_drol 295 * quant = ((past_quant + future_quant) * bquant_ratio)/200
339 :     */
340 : suxen_drol 659 int bquant_offset; /* bquant += bquant_offset */
341 : suxen_drol 295 int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */
342 : suxen_drol 234 void *handle; /* [out] encoder instance handle */
343 : edgomez 199 }
344 :     XVID_ENC_PARAM;
345 :    
346 :     typedef struct
347 :     {
348 :     int x;
349 : suxen_drol 324 int y;
350 : edgomez 199 }
351 :     VECTOR;
352 :    
353 :     typedef struct
354 :     {
355 :     int mode; /* macroblock mode */
356 :     VECTOR mvs[4];
357 :     }
358 :     MVBLOCKHINT;
359 :    
360 :     typedef struct
361 :     {
362 :     int intra; /* frame intra choice */
363 :     int fcode; /* frame fcode */
364 :     MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */
365 :     }
366 :     MVFRAMEHINT;
367 :    
368 :     typedef struct
369 :     {
370 :     int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */
371 :    
372 :     MVFRAMEHINT mvhint;
373 :     void *hintstream; /* compressed hint buffer */
374 :     int hintlength; /* length of buffer (bytes) */
375 :     }
376 :     HINTINFO;
377 :    
378 :     typedef struct
379 :     {
380 :     int general; /* [in] general options */
381 :     int motion; /* [in] ME options */
382 :     void *bitstream; /* [in] bitstream ptr */
383 :     int length; /* [out] bitstream length (bytes) */
384 :    
385 :     void *image; /* [in] image ptr */
386 : suxen_drol 631 int stride;
387 : edgomez 199 int colorspace; /* [in] source colorspace */
388 :    
389 :     unsigned char *quant_intra_matrix; // [in] custom intra qmatrix */
390 :     unsigned char *quant_inter_matrix; // [in] custom inter qmatrix */
391 :     int quant; /* [in] frame quantizer (vbr) */
392 :     int intra; /* [in] force intra frame (vbr only)
393 :     * [out] intra state
394 :     */
395 :     HINTINFO hint; /* [in/out] mv hint information */
396 :    
397 :     int bquant; /* [in] bframe quantizer */
398 :    
399 :     }
400 :     XVID_ENC_FRAME;
401 :    
402 :    
403 :     typedef struct
404 :     {
405 :     int quant; /* [out] frame quantizer */
406 :     int hlength; /* [out] header length (bytes) */
407 :     int kblks, mblks, ublks; /* [out] */
408 :     }
409 :     XVID_ENC_STATS;
410 :    
411 :    
412 :     /*****************************************************************************
413 :     * Encoder entry point
414 :     ****************************************************************************/
415 :    
416 :     /* Encoder options */
417 :     #define XVID_ENC_ENCODE 0
418 :     #define XVID_ENC_CREATE 1
419 :     #define XVID_ENC_DESTROY 2
420 :    
421 :     int xvid_encore(void *handle,
422 :     int opt,
423 :     void *param1,
424 :     void *param2);
425 :    
426 :    
427 :     #ifdef __cplusplus
428 :     }
429 :     #endif
430 :    
431 :     #endif

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