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

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