[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 848 - (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 848 * $Id: xvid.h,v 1.17.2.30 2003-02-15 05:57:15 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 : chl 792 #define XVID_BS_VERSION "0009"
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 : suxen_drol 760 #define XVID_CPU_FORCE 0x80000000
100 :     #define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */
101 : edgomez 199
102 : suxen_drol 760 #define XVID_CPU_ASM 0x00000080 /* native assembly */
103 :     /* ARCH_X86 */
104 :     #define XVID_CPU_MMX 0x00000001 /* mmx: pentiumMMX,k6 */
105 :     #define XVID_CPU_MMXEXT 0x00000002 /* mmxx-ext: pentium2,athlon */
106 :     #define XVID_CPU_SSE 0x00000004 /* sse: pentium3,athlonXP */
107 :     #define XVID_CPU_SSE2 0x00000008 /* sse2: pentium4,athlon64 */
108 :     #define XVID_CPU_3DNOW 0x00000010 /* 3dnow: k6-2 */
109 :     #define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */
110 :     #define XVID_CPU_TSC 0x00000040 /* timestamp counter */
111 :     /* ARCH_IA64 */
112 :     #define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */
113 :     /* ARCH_PPC */
114 :     #define XVID_CPU_ALTIVEC 0x00000001 /* altivec */
115 : edgomez 199
116 : Isibaar 209
117 : suxen_drol 634 typedef struct
118 :     {
119 :     int colorspace;
120 :     void * y;
121 :     void * u;
122 :     void * v;
123 :     int y_stride;
124 :     int uv_stride;
125 :     } XVID_IMAGE; /* from yv12 */
126 : edgomez 199
127 : suxen_drol 634 #define XVID_INIT_INIT 0
128 :     #define XVID_INIT_CONVERT 1
129 : suxen_drol 752 #define XVID_INIT_TEST 2
130 : suxen_drol 634
131 : Isibaar 209 /*****************************************************************************
132 : edgomez 199 * Initialization structures
133 : Isibaar 209 ****************************************************************************/
134 :    
135 :     typedef struct
136 : suxen_drol 234 {
137 : edgomez 199 int cpu_flags;
138 :     int api_version;
139 :     int core_build;
140 :     }
141 :     XVID_INIT_PARAM;
142 :    
143 : suxen_drol 634 typedef struct
144 :     {
145 :     XVID_IMAGE input;
146 :     XVID_IMAGE output;
147 :     int width;
148 :     int height;
149 :     int interlacing;
150 :     } XVID_INIT_CONVERTINFO;
151 :    
152 : edgomez 199 /*****************************************************************************
153 :     * Initialization entry point
154 :     ****************************************************************************/
155 :    
156 :     int xvid_init(void *handle,
157 :     int opt,
158 :     void *param1,
159 :     void *param2);
160 :    
161 :    
162 :     /*****************************************************************************
163 :     * Decoder constants
164 :     ****************************************************************************/
165 :    
166 :     /* Flags for XVID_DEC_FRAME.general */
167 : suxen_drol 707 #define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. video-for-windows) */
168 : suxen_drol 715 #define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */
169 : suxen_drol 747 #define XVID_DEC_DEBLOCKUV 0x00000008 /* chroma deblocking */
170 : suxen_drol 725 #define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream; instructs
171 :     decoder to ignore any previous reference frames */
172 : edgomez 199 #define XVID_QUICK_DECODE 0x00000010
173 :    
174 :     /*****************************************************************************
175 :     * Decoder structures
176 :     ****************************************************************************/
177 :    
178 :     typedef struct
179 :     {
180 :     int width;
181 :     int height;
182 :     void *handle;
183 :     }
184 :     XVID_DEC_PARAM;
185 :    
186 :    
187 : suxen_drol 631 #define XVID_DEC_VOP 0
188 :     #define XVID_DEC_VOL 1
189 : suxen_drol 707 #define XVID_DEC_NOTHING 2 /* nothing was decoded */
190 : suxen_drol 631
191 : edgomez 199 typedef struct
192 :     {
193 : suxen_drol 631 int notify; /* [out] output 'mode' */
194 :     union
195 :     {
196 :     struct /* XVID_DEC_VOP */
197 :     {
198 :     int time_base; /* [out] time base */
199 :     int time_increment; /* [out] time increment */
200 :     } vop;
201 :     struct /* XVID_DEC_VOL */
202 :     {
203 :     int general; /* [out] flags: eg. frames are interlaced */
204 :     int width; /* [out] width */
205 :     int height; /* [out] height */
206 :     int aspect_ratio; /* [out] aspect ratio */
207 :     int par_width; /* [out] aspect ratio width */
208 :     int par_height; /* [out] aspect ratio height */
209 :     } vol;
210 :     } data;
211 :     } XVID_DEC_STATS;
212 :    
213 :    
214 :     typedef struct
215 :     {
216 : edgomez 199 int general;
217 :     void *bitstream;
218 :     int length;
219 :    
220 :     void *image;
221 :     int stride;
222 :     int colorspace;
223 :     }
224 :     XVID_DEC_FRAME;
225 :    
226 :    
227 :     // This struct is used for per slice rendering
228 :     typedef struct
229 :     {
230 :     void *y,*u,*v;
231 :     int stride_y, stride_u,stride_v;
232 :     } XVID_DEC_PICTURE;
233 :    
234 : albeu 315
235 :     /*****************************************************************************
236 :     * Decoder entry point
237 :     ****************************************************************************/
238 :    
239 :     /* decoder options */
240 :     #define XVID_DEC_DECODE 0
241 :     #define XVID_DEC_CREATE 1
242 : edgomez 199 #define XVID_DEC_DESTROY 2
243 :    
244 :     int xvid_decore(void *handle,
245 :     int opt,
246 :     void *param1,
247 :     void *param2);
248 :    
249 :    
250 :     /*****************************************************************************
251 :     * Encoder constants
252 :     ****************************************************************************/
253 :    
254 :     /* Flags for XVID_ENC_PARAM.global */
255 :     #define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */
256 :     #define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */
257 :     #define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */
258 : suxen_drol 701 #define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */
259 : edgomez 199
260 : chl 807 #define XVID_GLOBAL_EXTRASTATS 0x00000200 /* generate extra statistics */
261 :    
262 :    
263 : edgomez 199 /* Flags for XVID_ENC_FRAME.general */
264 :     #define XVID_VALID_FLAGS 0x80000000
265 :    
266 :     #define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */
267 : suxen_drol 234 #define XVID_H263QUANT 0x00000010
268 :     #define XVID_MPEGQUANT 0x00000020
269 :     #define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */
270 : Isibaar 579 #define XVID_QUARTERPEL 0x02000000
271 : suxen_drol 234 #define XVID_ADAPTIVEQUANT 0x00000080
272 :     #define XVID_LUMIMASKING 0x00000100
273 : edgomez 199
274 :     #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */
275 :     #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */
276 :     #define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */
277 :    
278 :     #define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */
279 :     #define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */
280 :    
281 :     #define XVID_INTER4V 0x00008000
282 :    
283 :     #define XVID_ME_ZERO 0x00010000
284 :     #define XVID_ME_LOGARITHMIC 0x00020000
285 :     #define XVID_ME_FULLSEARCH 0x00040000
286 :     #define XVID_ME_PMVFAST 0x00080000
287 :     #define XVID_ME_EPZS 0x00100000
288 :    
289 : suxen_drol 848 #define XVID_CHROMAOPT 0x00200000 /* enable chroma optimization pre-filter */
290 :    
291 : edgomez 199 #define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */
292 : syskin 834 /* color input material chroma is ignored) */
293 : edgomez 199
294 : chl 769 #define XVID_GMC 0x10000000
295 :     #define XVID_GMC_TRANSLATIONAL 0x20000000
296 : edgomez 199
297 : suxen_drol 701 #define XVID_REDUCED 0x04000000 /* reduced resolution vop */
298 : suxen_drol 821 #define XVID_HQACPRED 0x08000000 /* 20030209: high quality ac prediction */
299 : suxen_drol 701
300 : chl 807 #define XVID_EXTRASTATS 0x00000200 /* generate extra statistics */
301 :    
302 : syskin 835 #define XVID_MODEDECISION_BITS 0x00400000 /* enable DCT-ME and use it for mode decision */
303 : chl 807
304 : syskin 834
305 : edgomez 199 /* Flags for XVID_ENC_FRAME.motion */
306 : chl 352
307 : syskin 834 #define PMV_ADVANCEDDIAMOND16 0x00008000 /* use advdiamonds instead of diamonds as search pattern */
308 :     #define PMV_USESQUARES16 0x00800000 /* use squares instead of diamonds as search pattern */
309 :    
310 : chl 352 #define PMV_HALFPELREFINE16 0x00020000
311 : syskin 834 #define PMV_HALFPELREFINE8 0x02000000
312 :    
313 : Isibaar 579 #define PMV_QUARTERPELREFINE16 0x00040000
314 : syskin 834 #define PMV_QUARTERPELREFINE8 0x04000000
315 :    
316 : Isibaar 579 #define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */
317 : chl 769
318 : syskin 834 #define PMV_EXTSEARCH8 0x08000000 /* use diamond/square for extended 8x8 search */
319 :     #define PMV_ADVANCEDDIAMOND8 0x00004000 /* use advdiamond for PMV_EXTSEARCH8 */
320 :     #define PMV_USESQUARES8 0x80000000 /* use square for PMV_EXTSEARCH8 */
321 : edgomez 199
322 : syskin 834 #define PMV_CHROMA16 0x00100000 /* also use chroma for P_VOP/S_VOP ME */
323 :     #define PMV_CHROMA8 0x10000000 /* also use chroma for B_VOP ME */
324 : chl 769
325 : syskin 834 /* Motion search using DCT. use XVID_MODEDECISION_DCT to enable */
326 : syskin 835 #define HALFPELREFINE16_BITS 0x00000100 /* perform DCT-based halfpel refinement */
327 :     #define HALFPELREFINE8_BITS 0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */
328 :     #define QUARTERPELREFINE16_BITS 0x00000400 /* perform DCT-based qpel refinement */
329 :     #define QUARTERPELREFINE8_BITS 0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */
330 : edgomez 199
331 : syskin 835 #define EXTSEARCH_BITS 0x00001000 /* perform DCT-based search using square pattern */
332 : syskin 834 /* enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
333 : syskin 835 #define CHECKPREDICTION_BITS 0x00002000 /* always check vector equal to prediction */
334 : edgomez 199
335 : syskin 627
336 : syskin 834 /* note: old and deprecated - or never implemented */
337 :    
338 : chl 769 /* only for compatability with old encoders */
339 :    
340 :     #define PMV_EARLYSTOP16 0x00
341 :     #define PMV_EARLYSTOP8 0x00
342 :     #define PMV_QUICKSTOP16 0x00
343 :     #define PMV_QUICKSTOP8 0x00
344 :    
345 : syskin 834 #define PMV_HALFPELDIAMOND16 0x00
346 :     #define PMV_HALFPELDIAMOND8 0x00
347 : chl 769
348 : syskin 834 #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */
349 :     #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */
350 :     #define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */
351 :     #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */
352 : chl 769
353 : syskin 834 #define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_CHROMA[16/8] */
354 :    
355 :    
356 : edgomez 199 /*****************************************************************************
357 :     * Encoder structures
358 :     ****************************************************************************/
359 :    
360 :     typedef struct
361 :     {
362 :     int width, height;
363 :     int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */
364 :     int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */
365 :     int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */
366 :     int rc_averaging_period; /* as above */
367 :     int rc_buffer; /* as above */
368 :     int max_quantizer; /* the upper limit of the quantizer */
369 :     int min_quantizer; /* the lower limit of the quantizer */
370 :     int max_key_interval; /* the maximum interval between key frames */
371 :     #ifdef _SMP
372 :     int num_threads; /* number of threads */
373 :     #endif
374 :     int global; /* global/debug options */
375 :     int max_bframes; /* max sequential bframes (0=disable bframes) */
376 :     int bquant_ratio; /* bframe quantizer multipier (percentage).
377 :     * used only when bquant < 1
378 :     * eg. 200 = x2 multiplier
379 : suxen_drol 295 * quant = ((past_quant + future_quant) * bquant_ratio)/200
380 :     */
381 : suxen_drol 659 int bquant_offset; /* bquant += bquant_offset */
382 : suxen_drol 295 int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */
383 : suxen_drol 234 void *handle; /* [out] encoder instance handle */
384 : edgomez 199 }
385 :     XVID_ENC_PARAM;
386 :    
387 :     typedef struct
388 :     {
389 :     int x;
390 : suxen_drol 324 int y;
391 : edgomez 199 }
392 :     VECTOR;
393 :    
394 :     typedef struct
395 :     {
396 :     int mode; /* macroblock mode */
397 :     VECTOR mvs[4];
398 :     }
399 :     MVBLOCKHINT;
400 :    
401 :     typedef struct
402 :     {
403 :     int intra; /* frame intra choice */
404 :     int fcode; /* frame fcode */
405 :     MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */
406 :     }
407 :     MVFRAMEHINT;
408 :    
409 :     typedef struct
410 :     {
411 :     int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */
412 :    
413 :     MVFRAMEHINT mvhint;
414 :     void *hintstream; /* compressed hint buffer */
415 :     int hintlength; /* length of buffer (bytes) */
416 :     }
417 :     HINTINFO;
418 :    
419 :     typedef struct
420 :     {
421 :     int general; /* [in] general options */
422 :     int motion; /* [in] ME options */
423 :     void *bitstream; /* [in] bitstream ptr */
424 :     int length; /* [out] bitstream length (bytes) */
425 :    
426 :     void *image; /* [in] image ptr */
427 : suxen_drol 631 int stride;
428 : edgomez 199 int colorspace; /* [in] source colorspace */
429 :    
430 :     unsigned char *quant_intra_matrix; // [in] custom intra qmatrix */
431 :     unsigned char *quant_inter_matrix; // [in] custom inter qmatrix */
432 :     int quant; /* [in] frame quantizer (vbr) */
433 :     int intra; /* [in] force intra frame (vbr only)
434 :     * [out] intra state
435 :     */
436 :     HINTINFO hint; /* [in/out] mv hint information */
437 :    
438 :     int bquant; /* [in] bframe quantizer */
439 :    
440 :     }
441 :     XVID_ENC_FRAME;
442 :    
443 :    
444 :     typedef struct
445 :     {
446 :     int quant; /* [out] frame quantizer */
447 :     int hlength; /* [out] header length (bytes) */
448 :     int kblks, mblks, ublks; /* [out] */
449 : chl 807 long sse_y; /* [out] SSE of Y */
450 :     long sse_u; /* [out] SSE of Cb */
451 :     long sse_v; /* [out] SSE of Cr */
452 : edgomez 199 }
453 :     XVID_ENC_STATS;
454 :    
455 :    
456 :     /*****************************************************************************
457 :     * Encoder entry point
458 :     ****************************************************************************/
459 :    
460 :     /* Encoder options */
461 :     #define XVID_ENC_ENCODE 0
462 :     #define XVID_ENC_CREATE 1
463 :     #define XVID_ENC_DESTROY 2
464 :    
465 :     int xvid_encore(void *handle,
466 :     int opt,
467 :     void *param1,
468 :     void *param2);
469 :    
470 :    
471 :     #ifdef __cplusplus
472 :     }
473 :     #endif
474 :    
475 :     #endif

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