[svn] / trunk / xvidcore / src / xvid.h Repository:
ViewVC logotype

Annotation of /trunk/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1066 - (view) (download)

1 : edgomez 199 /*****************************************************************************
2 : edgomez 868 *
3 :     * XVID MPEG-4 VIDEO CODEC
4 :     * - XviD Main header file -
5 :     *
6 :     * This file is part of XviD, a free MPEG-4 video encoder/decoder
7 :     *
8 :     * This program is free software; you can redistribute it and/or modify
9 :     * it under the terms of the GNU General Public License as published by
10 :     * the Free Software Foundation; either version 2 of the License, or
11 :     * (at your option) any later version.
12 :     *
13 :     * This program is distributed in the hope that it will be useful,
14 :     * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 :     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 :     * GNU General Public License for more details.
17 :     *
18 :     * You should have received a copy of the GNU General Public License
19 :     * along with this program; if not, write to the Free Software
20 :     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 :     *
22 : Isibaar 1066 * $Id: xvid.h,v 1.30 2003-06-11 14:10:59 Isibaar Exp $
23 : edgomez 868 *
24 :     ****************************************************************************/
25 : edgomez 199
26 :     #ifndef _XVID_H_
27 :     #define _XVID_H_
28 :    
29 :     #ifdef __cplusplus
30 : chl 352 extern "C" {
31 : edgomez 199 #endif
32 :    
33 :     /*****************************************************************************
34 : edgomez 851 * Global constants
35 : edgomez 199 ****************************************************************************/
36 :    
37 : edgomez 851 /* API Version : 2.1 */
38 :     #define API_VERSION ((2 << 16) | (1))
39 :     #define XVID_API_UNSTABLE
40 : edgomez 199
41 : edgomez 851 /* Bitstream Version
42 :     * this will be writen into the bitstream to allow easy detection of xvid
43 :     * encoder bugs in the decoder, without this it might not possible to
44 :     * automatically distinquish between a file which has been encoded with an
45 :     * old & buggy XVID from a file which has been encoded with a bugfree version
46 :     * see the infamous interlacing bug ...
47 :     *
48 :     * this MUST be increased if an encoder bug is fixed, increasing it too often
49 :     * doesnt hurt but not increasing it could cause difficulty for decoders in the
50 :     * future
51 : edgomez 608 */
52 : Isibaar 1066 #define XVID_BS_VERSION "0012"
53 : edgomez 199
54 :    
55 : edgomez 851 /* Error codes */
56 : edgomez 868 #define XVID_ERR_FAIL -1
57 :     #define XVID_ERR_OK 0
58 :     #define XVID_ERR_MEMORY 1
59 :     #define XVID_ERR_FORMAT 2
60 : edgomez 199
61 :    
62 : edgomez 851 /* Colorspaces */
63 : edgomez 868 #define XVID_CSP_RGB24 0 /* [b|g|r] */
64 :     #define XVID_CSP_YV12 1
65 :     #define XVID_CSP_YUY2 2
66 :     #define XVID_CSP_UYVY 3
67 :     #define XVID_CSP_I420 4
68 :     #define XVID_CSP_RGB555 10
69 :     #define XVID_CSP_RGB565 11
70 :     #define XVID_CSP_USER 12
71 :     #define XVID_CSP_EXTERN 1004 /* per slice rendering */
72 : edgomez 851 #define XVID_CSP_YVYU 1002
73 : edgomez 868 #define XVID_CSP_RGB32 1000 /* [b|g|r|a] */
74 :     #define XVID_CSP_ABGR 1006 /* [a|b|g|r] */
75 :     #define XVID_CSP_RGBA 1005 /* [r|g|b|a] */
76 : edgomez 199
77 :    
78 : edgomez 608
79 : edgomez 868 #define XVID_CSP_NULL 9999
80 : edgomez 608
81 : edgomez 868 #define XVID_CSP_VFLIP 0x80000000 /* flip mask */
82 : edgomez 608
83 :    
84 : edgomez 199 /*****************************************************************************
85 : edgomez 851 * Initialization constants
86 : edgomez 199 ****************************************************************************/
87 :    
88 : edgomez 851 /* CPU flags for XVID_INIT_PARAM.cpu_flags */
89 : edgomez 868 #define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */
90 :     #define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */
91 :     #define XVID_CPU_ASM 0x00000080 /* native assembly */
92 : edgomez 199
93 : edgomez 851 /* ARCH_IS_IA32 */
94 : edgomez 868 #define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */
95 :     #define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */
96 :     #define XVID_CPU_SSE 0x00000004 /* sse : pentium3, athlonXP */
97 :     #define XVID_CPU_SSE2 0x00000008 /* sse2 : pentium4, athlon64 */
98 :     #define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */
99 :     #define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */
100 :     #define XVID_CPU_TSC 0x00000040 /* timestamp counter */
101 :    
102 : edgomez 851 /* ARCH_IS_IA64 */
103 : edgomez 868 #define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */
104 :    
105 : edgomez 851 /* ARCH_IS_PPC */
106 : edgomez 868 #define XVID_CPU_ALTIVEC 0x00000001 /* altivec */
107 : edgomez 199
108 : Isibaar 209
109 : edgomez 851 typedef struct
110 :     {
111 :     int colorspace;
112 :     void * y;
113 :     void * u;
114 :     void * v;
115 :     int y_stride;
116 :     int uv_stride;
117 : edgomez 868 } XVID_IMAGE; /* from yv12 */
118 : edgomez 199
119 : edgomez 868 #define XVID_INIT_INIT 0
120 :     #define XVID_INIT_CONVERT 1
121 :     #define XVID_INIT_TEST 2
122 : edgomez 199
123 : Isibaar 209 /*****************************************************************************
124 : edgomez 199 * Initialization structures
125 : Isibaar 209 ****************************************************************************/
126 :    
127 :     typedef struct
128 : suxen_drol 234 {
129 : edgomez 851 int cpu_flags;
130 :     int api_version;
131 :     int core_build;
132 : edgomez 868 } XVID_INIT_PARAM;
133 : edgomez 199
134 : edgomez 851 typedef struct
135 :     {
136 :     XVID_IMAGE input;
137 :     XVID_IMAGE output;
138 :     int width;
139 :     int height;
140 :     int interlacing;
141 :     } XVID_INIT_CONVERTINFO;
142 :    
143 : edgomez 199 /*****************************************************************************
144 :     * Initialization entry point
145 :     ****************************************************************************/
146 :    
147 :     int xvid_init(void *handle,
148 : edgomez 851 int opt,
149 :     void *param1,
150 :     void *param2);
151 : edgomez 199
152 :    
153 :     /*****************************************************************************
154 : edgomez 851 * Decoder constants
155 : edgomez 199 ****************************************************************************/
156 :    
157 : edgomez 851 /* Flags for XVID_DEC_FRAME.general */
158 : edgomez 868 #define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. VFW) */
159 :     #define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */
160 :     #define XVID_DEC_DEBLOCKUV 0x00000008 /* chroma deblocking */
161 :     #define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream
162 :     instructs decoder to ignore any
163 :     previous reference frames */
164 :     #define XVID_QUICK_DECODE 0x00000010
165 : edgomez 199
166 :     /*****************************************************************************
167 :     * Decoder structures
168 :     ****************************************************************************/
169 :    
170 :     typedef struct
171 :     {
172 :     int width;
173 :     int height;
174 :     void *handle;
175 : edgomez 868 } XVID_DEC_PARAM;
176 : edgomez 199
177 :    
178 : edgomez 868 #define XVID_DEC_VOP 0
179 :     #define XVID_DEC_VOL 1
180 :     #define XVID_DEC_NOTHING 2 /* nothing was decoded */
181 : edgomez 851
182 : edgomez 199 typedef struct
183 :     {
184 : edgomez 868 int notify; /* [out] output 'mode' */
185 : edgomez 851 union
186 :     {
187 : edgomez 868 struct /* XVID_DEC_VOP */
188 : edgomez 851 {
189 : edgomez 868 int time_base; /* [out] time base */
190 :     int time_increment; /* [out] time increment */
191 : edgomez 851 } vop;
192 : edgomez 868 struct /* XVID_DEC_VOL */
193 : edgomez 851 {
194 : edgomez 868 int general; /* [out] flags: eg. frames are interlaced */
195 :     int width; /* [out] width */
196 :     int height; /* [out] height */
197 :     int aspect_ratio; /* [out] aspect ratio */
198 :     int par_width; /* [out] aspect ratio width */
199 :     int par_height; /* [out] aspect ratio height */
200 : edgomez 851 } vol;
201 :     } data;
202 :     } XVID_DEC_STATS;
203 :    
204 :    
205 :     typedef struct
206 :     {
207 : edgomez 199 int general;
208 :     void *bitstream;
209 :     int length;
210 :    
211 :     void *image;
212 :     int stride;
213 :     int colorspace;
214 : edgomez 868 } XVID_DEC_FRAME;
215 : edgomez 199
216 :    
217 : edgomez 868 /* This struct is used for per slice rendering */
218 : edgomez 199 typedef struct
219 :     {
220 :     void *y,*u,*v;
221 :     int stride_y, stride_u,stride_v;
222 :     } XVID_DEC_PICTURE;
223 :    
224 : albeu 315
225 :     /*****************************************************************************
226 :     * Decoder entry point
227 :     ****************************************************************************/
228 :    
229 : edgomez 851 /* decoder options */
230 : edgomez 868 #define XVID_DEC_DECODE 0
231 :     #define XVID_DEC_CREATE 1
232 :     #define XVID_DEC_DESTROY 2
233 : edgomez 199
234 : edgomez 851 int xvid_decore(void *handle,
235 :     int opt,
236 :     void *param1,
237 :     void *param2);
238 : edgomez 199
239 :    
240 : edgomez 851 /*****************************************************************************
241 :     * Encoder constants
242 :     ****************************************************************************/
243 : edgomez 199
244 : edgomez 851 /* Flags for XVID_ENC_PARAM.global */
245 : edgomez 868 #define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */
246 :     #define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */
247 :     #define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */
248 :     #define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */
249 : edgomez 199
250 : edgomez 868 #define XVID_GLOBAL_EXTRASTATS 0x00000200 /* generate extra statistics */
251 : edgomez 199
252 :    
253 : edgomez 851 /* Flags for XVID_ENC_FRAME.general */
254 : edgomez 868 #define XVID_VALID_FLAGS 0x80000000
255 : edgomez 199
256 : edgomez 868 #define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */
257 :     #define XVID_H263QUANT 0x00000010
258 :     #define XVID_MPEGQUANT 0x00000020
259 :     #define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */
260 :     #define XVID_QUARTERPEL 0x02000000
261 :     #define XVID_ADAPTIVEQUANT 0x00000080
262 :     #define XVID_LUMIMASKING 0x00000100
263 : edgomez 199
264 : edgomez 868 #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */
265 :     #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */
266 :     #define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */
267 : edgomez 199
268 : edgomez 868 #define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */
269 :     #define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */
270 : edgomez 199
271 : edgomez 868 #define XVID_INTER4V 0x00008000
272 : edgomez 199
273 : edgomez 868 #define XVID_ME_ZERO 0x00010000
274 :     #define XVID_ME_LOGARITHMIC 0x00020000
275 :     #define XVID_ME_FULLSEARCH 0x00040000
276 :     #define XVID_ME_PMVFAST 0x00080000
277 :     #define XVID_ME_EPZS 0x00100000
278 : edgomez 199
279 : edgomez 868 #define XVID_CHROMAOPT 0x00200000 /* enable chroma optimization pre-filter */
280 : edgomez 853
281 : edgomez 868 #define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for
282 :     color input material chroma is ignored) */
283 : edgomez 199
284 : edgomez 868 #define XVID_GMC 0x10000000
285 :     #define XVID_GMC_TRANSLATIONAL 0x20000000
286 : chl 352
287 : edgomez 868 #define XVID_REDUCED 0x04000000 /* reduced resolution vop */
288 :     #define XVID_HQACPRED 0x08000000 /* 20030209: high quality ac prediction */
289 : edgomez 199
290 : edgomez 868 #define XVID_EXTRASTATS 0x00000200 /* generate extra statistics */
291 : edgomez 199
292 : edgomez 868 #define XVID_MODEDECISION_BITS 0x00400000 /* enable DCT-ME and use it for mode decision */
293 : edgomez 199
294 : edgomez 608
295 : edgomez 851 /* Flags for XVID_ENC_FRAME.motion */
296 : edgomez 868 #define PMV_ADVANCEDDIAMOND16 0x00008000 /* use advdiamonds instead of diamonds as search pattern */
297 :     #define PMV_USESQUARES16 0x00800000 /* use squares instead of diamonds as search pattern */
298 : edgomez 851
299 : edgomez 868 #define PMV_HALFPELREFINE16 0x00020000
300 :     #define PMV_HALFPELREFINE8 0x02000000
301 : edgomez 851
302 : edgomez 868 #define PMV_QUARTERPELREFINE16 0x00040000
303 :     #define PMV_QUARTERPELREFINE8 0x04000000
304 : edgomez 851
305 : edgomez 868 #define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */
306 : edgomez 851
307 : edgomez 868 #define PMV_EXTSEARCH8 0x08000000 /* use diamond/square for extended 8x8 search */
308 :     #define PMV_ADVANCEDDIAMOND8 0x00004000 /* use advdiamond for PMV_EXTSEARCH8 */
309 :     #define PMV_USESQUARES8 0x80000000 /* use square for PMV_EXTSEARCH8 */
310 : edgomez 851
311 : edgomez 868 #define PMV_CHROMA16 0x00100000 /* also use chroma for P_VOP/S_VOP ME */
312 :     #define PMV_CHROMA8 0x10000000 /* also use chroma for B_VOP ME */
313 : edgomez 851
314 : edgomez 868 /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */
315 :     #define HALFPELREFINE16_BITS 0x00000100 /* perform DCT-based halfpel refinement */
316 :     #define HALFPELREFINE8_BITS 0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */
317 :     #define QUARTERPELREFINE16_BITS 0x00000400 /* perform DCT-based qpel refinement */
318 :     #define QUARTERPELREFINE8_BITS 0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */
319 : edgomez 851
320 : edgomez 868 #define EXTSEARCH_BITS 0x00001000 /* perform DCT-based search using square pattern
321 :     enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
322 :     #define CHECKPREDICTION_BITS 0x00002000 /* always check vector equal to prediction */
323 : edgomez 851
324 :    
325 :     /* note: old and deprecated - or never implemented */
326 :    
327 :     /* only for compatability with old encoders */
328 :    
329 : edgomez 868 #define PMV_EARLYSTOP16 0x00
330 :     #define PMV_EARLYSTOP8 0x00
331 :     #define PMV_QUICKSTOP16 0x00
332 :     #define PMV_QUICKSTOP8 0x00
333 : edgomez 851
334 : edgomez 868 #define PMV_HALFPELDIAMOND16 0x00
335 :     #define PMV_HALFPELDIAMOND8 0x00
336 : edgomez 851
337 : edgomez 868 #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */
338 :     #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */
339 :     #define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */
340 :     #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */
341 : edgomez 851
342 : edgomez 868 #define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_CHROMA[16/8] */
343 : edgomez 851
344 :    
345 : edgomez 199 /*****************************************************************************
346 :     * Encoder structures
347 :     ****************************************************************************/
348 :    
349 :     typedef struct
350 :     {
351 : edgomez 851 int width, height;
352 : edgomez 868 int fincr, fbase; /* [in] frame increment, fbase. each frame = "fincr/fbase" seconds */
353 :     int rc_bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */
354 :     int rc_reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */
355 :     int rc_averaging_period; /* [in] as above */
356 :     int rc_buffer; /* [in] as above */
357 :     int max_quantizer; /* [in] the upper limit of the quantizer */
358 :     int min_quantizer; /* [in] the lower limit of the quantizer */
359 :     int max_key_interval; /* [in] the maximum interval between key frames */
360 : edgomez 851 #ifdef _SMP
361 : edgomez 868 int num_threads; /* [in] number of threads */
362 : edgomez 851 #endif
363 : edgomez 868 int global; /* [in] global/debug options */
364 :     int max_bframes; /* [in] max sequential bframes (0=disable bframes) */
365 :     int bquant_ratio; /* [in] bframe quantizer multipier (percentage).
366 :     used only when bquant < 1
367 :     eg. 200 = x2 multiplier
368 :     quant = ((past_quant + future_quant) * bquant_ratio)/200
369 :     */
370 :     int bquant_offset; /* [in] bquant += bquant_offset */
371 :     int frame_drop_ratio; /* [in] frame dropping: 0=drop none... 100=drop all */
372 :     void *handle; /* [out] encoder instance handle */
373 :     } XVID_ENC_PARAM;
374 : edgomez 199
375 :     typedef struct
376 :     {
377 :     int x;
378 : suxen_drol 324 int y;
379 : edgomez 868 } VECTOR;
380 : edgomez 199
381 :     typedef struct
382 :     {
383 : edgomez 868 int mode; /* macroblock mode */
384 : edgomez 199 VECTOR mvs[4];
385 : edgomez 868 } MVBLOCKHINT;
386 : edgomez 199
387 :     typedef struct
388 :     {
389 : edgomez 868 int intra; /* frame intra choice */
390 :     int fcode; /* frame fcode */
391 :     MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */
392 :     } MVFRAMEHINT;
393 : edgomez 199
394 :     typedef struct
395 :     {
396 : edgomez 868 int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */
397 : edgomez 199
398 :     MVFRAMEHINT mvhint;
399 : edgomez 868 void *hintstream; /* compressed hint buffer */
400 :     int hintlength; /* length of buffer (bytes) */
401 :     } HINTINFO;
402 : edgomez 199
403 :     typedef struct
404 :     {
405 : edgomez 868 int general; /* [in] general options */
406 :     int motion; /* [in] ME options */
407 :     void *bitstream; /* [in] bitstream ptr */
408 :     int length; /* [out] bitstream length (bytes) */
409 : edgomez 199
410 : edgomez 868 void *image; /* [in] image ptr */
411 :     int stride; /* [in] horizontal stride in bytes */
412 :     int colorspace; /* [in] source colorspace */
413 : edgomez 851
414 : edgomez 868 unsigned char *quant_intra_matrix; /* [in] custom intra qmatrix */
415 :     unsigned char *quant_inter_matrix; /* [in] custom inter qmatrix */
416 :     int quant; /* [in] frame quantizer (vbr) */
417 :     int intra; /* [in] force intra frame (vbr only)
418 :     [out] frame type (ugly atm)
419 :     */
420 :     HINTINFO hint; /* [in/out] mv hint information */
421 : edgomez 851
422 : edgomez 868 int bquant; /* [in] bframe quantizer */
423 : syskin 903 int bframe_threshold; /* [in] sensitivity of B-frame decision */
424 : edgomez 851
425 : edgomez 868 } XVID_ENC_FRAME;
426 : edgomez 199
427 :    
428 :     typedef struct
429 :     {
430 : edgomez 868 int quant; /* [out] frame quantizer */
431 :     int hlength; /* [out] header length (bytes) */
432 :     int kblks; /* [out] number of intra blocks */
433 :     int mblks; /* [out] number of inter blocks */
434 :     int ublks; /* [out] number of "not coded" blocks */
435 :     long sse_y; /* [out] SSE of Y */
436 :     long sse_u; /* [out] SSE of Cb */
437 :     long sse_v; /* [out] SSE of Cr */
438 :     } XVID_ENC_STATS;
439 : edgomez 199
440 :    
441 :     /*****************************************************************************
442 :     * Encoder entry point
443 :     ****************************************************************************/
444 :    
445 : edgomez 851 /* Encoder options */
446 : edgomez 868 #define XVID_ENC_ENCODE 0
447 :     #define XVID_ENC_CREATE 1
448 :     #define XVID_ENC_DESTROY 2
449 : edgomez 199
450 :     int xvid_encore(void *handle,
451 :     int opt,
452 :     void *param1,
453 :     void *param2);
454 :    
455 :    
456 :     #ifdef __cplusplus
457 :     }
458 :     #endif
459 :    
460 :     #endif

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