[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 707 - (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 707 * $Id: xvid.h,v 1.17.2.14 2002-12-12 10:37:44 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 :    
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 : suxen_drol 634 typedef struct
114 :     {
115 :     int colorspace;
116 :     void * y;
117 :     void * u;
118 :     void * v;
119 :     int y_stride;
120 :     int uv_stride;
121 :     } XVID_IMAGE; /* from yv12 */
122 : edgomez 199
123 : suxen_drol 634 #define XVID_INIT_INIT 0
124 :     #define XVID_INIT_CONVERT 1
125 :    
126 : Isibaar 209 /*****************************************************************************
127 : edgomez 199 * Initialization structures
128 : Isibaar 209 ****************************************************************************/
129 :    
130 :     typedef struct
131 : suxen_drol 234 {
132 : edgomez 199 int cpu_flags;
133 :     int api_version;
134 :     int core_build;
135 :     }
136 :     XVID_INIT_PARAM;
137 :    
138 : suxen_drol 634 typedef struct
139 :     {
140 :     XVID_IMAGE input;
141 :     XVID_IMAGE output;
142 :     int width;
143 :     int height;
144 :     int interlacing;
145 :     } XVID_INIT_CONVERTINFO;
146 :    
147 : edgomez 199 /*****************************************************************************
148 :     * Initialization entry point
149 :     ****************************************************************************/
150 :    
151 :     int xvid_init(void *handle,
152 :     int opt,
153 :     void *param1,
154 :     void *param2);
155 :    
156 :    
157 :     /*****************************************************************************
158 :     * Decoder constants
159 :     ****************************************************************************/
160 :    
161 :     /* Flags for XVID_DEC_FRAME.general */
162 : suxen_drol 707 #define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. video-for-windows) */
163 : edgomez 199 #define XVID_QUICK_DECODE 0x00000010
164 :    
165 :     /*****************************************************************************
166 :     * Decoder structures
167 :     ****************************************************************************/
168 :    
169 :     typedef struct
170 :     {
171 :     int width;
172 :     int height;
173 :     void *handle;
174 :     }
175 :     XVID_DEC_PARAM;
176 :    
177 :    
178 : suxen_drol 631 #define XVID_DEC_VOP 0
179 :     #define XVID_DEC_VOL 1
180 : suxen_drol 707 #define XVID_DEC_NOTHING 2 /* nothing was decoded */
181 : suxen_drol 631
182 : edgomez 199 typedef struct
183 :     {
184 : suxen_drol 631 int notify; /* [out] output 'mode' */
185 :     union
186 :     {
187 :     struct /* XVID_DEC_VOP */
188 :     {
189 :     int time_base; /* [out] time base */
190 :     int time_increment; /* [out] time increment */
191 :     } vop;
192 :     struct /* XVID_DEC_VOL */
193 :     {
194 :     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 :     } 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 :     }
215 :     XVID_DEC_FRAME;
216 :    
217 :    
218 :     // This struct is used for per slice rendering
219 :     typedef struct
220 :     {
221 :     void *y,*u,*v;
222 :     int stride_y, stride_u,stride_v;
223 :     } XVID_DEC_PICTURE;
224 :    
225 : albeu 315
226 :     /*****************************************************************************
227 :     * Decoder entry point
228 :     ****************************************************************************/
229 :    
230 :     /* decoder options */
231 :     #define XVID_DEC_DECODE 0
232 :     #define XVID_DEC_CREATE 1
233 : edgomez 199 #define XVID_DEC_DESTROY 2
234 :    
235 :     int xvid_decore(void *handle,
236 :     int opt,
237 :     void *param1,
238 :     void *param2);
239 :    
240 :    
241 :     /*****************************************************************************
242 :     * Encoder constants
243 :     ****************************************************************************/
244 :    
245 :     /* Flags for XVID_ENC_PARAM.global */
246 :     #define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */
247 :     #define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */
248 :     #define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */
249 : suxen_drol 701 #define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */
250 : edgomez 199
251 :     /* Flags for XVID_ENC_FRAME.general */
252 :     #define XVID_VALID_FLAGS 0x80000000
253 :    
254 :     #define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */
255 : suxen_drol 234 #define XVID_H263QUANT 0x00000010
256 :     #define XVID_MPEGQUANT 0x00000020
257 :     #define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */
258 : Isibaar 579 #define XVID_QUARTERPEL 0x02000000
259 : suxen_drol 234 #define XVID_ADAPTIVEQUANT 0x00000080
260 :     #define XVID_LUMIMASKING 0x00000100
261 : edgomez 199 #define XVID_LATEINTRA 0x00000200
262 :    
263 :     #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */
264 :     #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */
265 :     #define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */
266 :    
267 :     #define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */
268 :     #define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */
269 :    
270 :     #define XVID_INTER4V 0x00008000
271 :    
272 :     #define XVID_ME_ZERO 0x00010000
273 :     #define XVID_ME_LOGARITHMIC 0x00020000
274 :     #define XVID_ME_FULLSEARCH 0x00040000
275 :     #define XVID_ME_PMVFAST 0x00080000
276 :     #define XVID_ME_EPZS 0x00100000
277 :    
278 :     #define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */
279 : Isibaar 579 #define XVID_GRAYSCALE 0x01000000 /* color input material chroma is ignored) */
280 : edgomez 199
281 : syskin 627 #define XVID_GMC 0x20000000
282 :     #define XVID_ME_COLOUR 0x40000000
283 : edgomez 199
284 : suxen_drol 701 #define XVID_REDUCED 0x04000000 /* reduced resolution vop */
285 :    
286 : edgomez 199 /* Flags for XVID_ENC_FRAME.motion */
287 :     #define PMV_ADVANCEDDIAMOND8 0x00004000
288 :     #define PMV_ADVANCEDDIAMOND16 0x00008000
289 : chl 352
290 :     #define PMV_HALFPELDIAMOND16 0x00010000
291 :     #define PMV_HALFPELREFINE16 0x00020000
292 : Isibaar 579 #define PMV_QUARTERPELREFINE16 0x00040000
293 :     #define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */
294 : edgomez 199 #define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more refinement */
295 :     #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */
296 :     #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */
297 :     #define PMV_USESQUARES16 0x00800000
298 :    
299 :     #define PMV_HALFPELDIAMOND8 0x01000000
300 :     #define PMV_HALFPELREFINE8 0x02000000
301 : Isibaar 579 #define PMV_QUARTERPELREFINE8 0x04000000
302 :     #define PMV_EXTSEARCH8 0x08000000 /* extend PMV by more searches */
303 : edgomez 199 #define PMV_QUICKSTOP8 0x10000000 /* like early, but without any more refinement */
304 :     #define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */
305 :     #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */
306 :     #define PMV_USESQUARES8 0x80000000
307 :    
308 :    
309 : syskin 627
310 : edgomez 199 /*****************************************************************************
311 :     * Encoder structures
312 :     ****************************************************************************/
313 :    
314 :     typedef struct
315 :     {
316 :     int width, height;
317 :     int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */
318 :     int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */
319 :     int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */
320 :     int rc_averaging_period; /* as above */
321 :     int rc_buffer; /* as above */
322 :     int max_quantizer; /* the upper limit of the quantizer */
323 :     int min_quantizer; /* the lower limit of the quantizer */
324 :     int max_key_interval; /* the maximum interval between key frames */
325 :     #ifdef _SMP
326 :     int num_threads; /* number of threads */
327 :     #endif
328 :     int global; /* global/debug options */
329 :     int max_bframes; /* max sequential bframes (0=disable bframes) */
330 :     int bquant_ratio; /* bframe quantizer multipier (percentage).
331 :     * used only when bquant < 1
332 :     * eg. 200 = x2 multiplier
333 : suxen_drol 295 * quant = ((past_quant + future_quant) * bquant_ratio)/200
334 :     */
335 : suxen_drol 659 int bquant_offset; /* bquant += bquant_offset */
336 : suxen_drol 295 int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */
337 : suxen_drol 234 void *handle; /* [out] encoder instance handle */
338 : edgomez 199 }
339 :     XVID_ENC_PARAM;
340 :    
341 :     typedef struct
342 :     {
343 :     int x;
344 : suxen_drol 324 int y;
345 : edgomez 199 }
346 :     VECTOR;
347 :    
348 :     typedef struct
349 :     {
350 :     int mode; /* macroblock mode */
351 :     VECTOR mvs[4];
352 :     }
353 :     MVBLOCKHINT;
354 :    
355 :     typedef struct
356 :     {
357 :     int intra; /* frame intra choice */
358 :     int fcode; /* frame fcode */
359 :     MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */
360 :     }
361 :     MVFRAMEHINT;
362 :    
363 :     typedef struct
364 :     {
365 :     int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */
366 :    
367 :     MVFRAMEHINT mvhint;
368 :     void *hintstream; /* compressed hint buffer */
369 :     int hintlength; /* length of buffer (bytes) */
370 :     }
371 :     HINTINFO;
372 :    
373 :     typedef struct
374 :     {
375 :     int general; /* [in] general options */
376 :     int motion; /* [in] ME options */
377 :     void *bitstream; /* [in] bitstream ptr */
378 :     int length; /* [out] bitstream length (bytes) */
379 :    
380 :     void *image; /* [in] image ptr */
381 : suxen_drol 631 int stride;
382 : edgomez 199 int colorspace; /* [in] source colorspace */
383 :    
384 :     unsigned char *quant_intra_matrix; // [in] custom intra qmatrix */
385 :     unsigned char *quant_inter_matrix; // [in] custom inter qmatrix */
386 :     int quant; /* [in] frame quantizer (vbr) */
387 :     int intra; /* [in] force intra frame (vbr only)
388 :     * [out] intra state
389 :     */
390 :     HINTINFO hint; /* [in/out] mv hint information */
391 :    
392 :     int bquant; /* [in] bframe quantizer */
393 :    
394 :     }
395 :     XVID_ENC_FRAME;
396 :    
397 :    
398 :     typedef struct
399 :     {
400 :     int quant; /* [out] frame quantizer */
401 :     int hlength; /* [out] header length (bytes) */
402 :     int kblks, mblks, ublks; /* [out] */
403 :     }
404 :     XVID_ENC_STATS;
405 :    
406 :    
407 :     /*****************************************************************************
408 :     * Encoder entry point
409 :     ****************************************************************************/
410 :    
411 :     /* Encoder options */
412 :     #define XVID_ENC_ENCODE 0
413 :     #define XVID_ENC_CREATE 1
414 :     #define XVID_ENC_DESTROY 2
415 :    
416 :     int xvid_encore(void *handle,
417 :     int opt,
418 :     void *param1,
419 :     void *param2);
420 :    
421 :    
422 :     #ifdef __cplusplus
423 :     }
424 :     #endif
425 :    
426 :     #endif

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