[svn] / branches / dev-api-4 / xvidcore / src / xvid.h Repository:
ViewVC logotype

Annotation of /branches/dev-api-4/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 925 - (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 : suxen_drol 925 * $Id: xvid.h,v 1.27.2.8 2003-03-15 17:03:17 suxen_drol Exp $
23 : edgomez 868 *
24 :     ****************************************************************************/
25 : edgomez 199
26 :     #ifndef _XVID_H_
27 :     #define _XVID_H_
28 :    
29 : suxen_drol 919
30 : edgomez 199 #ifdef __cplusplus
31 : chl 352 extern "C" {
32 : edgomez 199 #endif
33 :    
34 :     /*****************************************************************************
35 : suxen_drol 890 * versioning
36 : edgomez 199 ****************************************************************************/
37 :    
38 : suxen_drol 890 /* versioning
39 :     version takes the form "$major.$minor.$patch"
40 :     $patch is incremented when there is no api change
41 :     $minor is incremented when the api is changed, but remains backwards compatible
42 :     $major is incremented when the api is changed significantly
43 : edgomez 199
44 : suxen_drol 890 when initialising an xvid structure, you must always zero it, and set the version field.
45 :     memset(&struct,0,sizeof(struct));
46 :     struct.version = XVID_VERSION;
47 :    
48 :     XVID_UNSTABLE is defined only during development.
49 :     */
50 :    
51 :     #define XVID_MAKE_VERSION(a,b,c) ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )
52 :     #define XVID_MAJOR(a) ( ((a)>>16) & 0xff )
53 :     #define XVID_MINOR(b) ((char)( ((b)>>8) & 0xff ))
54 :     #define XVID_PATCH(c) ( (c) & 0xff )
55 :    
56 :     #define XVID_VERSION XVID_MAKE_VERSION(1,-127,0)
57 :     #define XVID_UNSTABLE
58 :    
59 : edgomez 851 /* Bitstream Version
60 :     * this will be writen into the bitstream to allow easy detection of xvid
61 :     * encoder bugs in the decoder, without this it might not possible to
62 :     * automatically distinquish between a file which has been encoded with an
63 :     * old & buggy XVID from a file which has been encoded with a bugfree version
64 :     * see the infamous interlacing bug ...
65 :     *
66 :     * this MUST be increased if an encoder bug is fixed, increasing it too often
67 :     * doesnt hurt but not increasing it could cause difficulty for decoders in the
68 :     * future
69 : edgomez 608 */
70 : edgomez 851 #define XVID_BS_VERSION "0009"
71 : edgomez 199
72 :    
73 : suxen_drol 890 /*****************************************************************************
74 :     * error codes
75 :     ****************************************************************************/
76 : edgomez 199
77 : suxen_drol 890 /* all functions return values <0 indicate error */
78 : edgomez 199
79 : suxen_drol 890 #define XVID_ERR_FAIL -1 /* general fault */
80 :     #define XVID_ERR_MEMORY -2 /* memory allocation error */
81 :     #define XVID_ERR_FORMAT -3 /* file format error */
82 :     #define XVID_ERR_VERSION -4 /* structure version not supported */
83 :     #define XVID_ERR_END -5 /* encoder only; end of stream reached */
84 : edgomez 199
85 :    
86 : edgomez 608
87 : suxen_drol 890 /*****************************************************************************
88 :     * xvid_image_t
89 :     ****************************************************************************/
90 : edgomez 608
91 : suxen_drol 890 /* colorspace values */
92 : edgomez 608
93 : suxen_drol 890 #define XVID_CSP_USER 0 /* 4:2:0 planar */
94 :     #define XVID_CSP_I420 1 /* 4:2:0 packed(planar win32) */
95 :     #define XVID_CSP_YV12 2 /* 4:2:0 packed(planar win32) */
96 :     #define XVID_CSP_YUY2 3 /* 4:2:2 packed */
97 :     #define XVID_CSP_UYVY 4 /* 4:2:2 packed */
98 :     #define XVID_CSP_YVYU 5 /* 4:2:2 packed */
99 :     #define XVID_CSP_BGRA 6 /* 32-bit bgra packed */
100 :     #define XVID_CSP_ABGR 7 /* 32-bit abgr packed */
101 :     #define XVID_CSP_RGBA 8 /* 32-bit rgba packed */
102 :     #define XVID_CSP_BGR 9 /* 32-bit bgr packed */
103 :     #define XVID_CSP_RGB555 10 /* 16-bit rgb555 packed */
104 :     #define XVID_CSP_RGB565 11 /* 16-bit rgb565 packed */
105 :     #define XVID_CSP_SLICE 12 /* decoder only: 4:2:0 planar, per slice rendering */
106 :     #define XVID_CSP_INTERNAL 13 /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
107 :     #define XVID_CSP_NULL 14 /* decoder only: dont output anything */
108 :     #define XVID_CSP_VFLIP 0x80000000 /* vertical flip mask */
109 : edgomez 608
110 : suxen_drol 890 /* xvid_image_t
111 :     for non-planar colorspaces use only plane[0] and stride[0]
112 :     four plane reserved for alpha*/
113 :     typedef struct {
114 :     int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
115 :     void * plane[4]; /* [in] image plane ptrs */
116 :     int stride[4]; /* [in] image stride; "bytes per row"*/
117 :     } xvid_image_t;
118 :    
119 :    
120 :     /* aspect ratios */
121 :     #define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */
122 :     #define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */
123 :     #define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */
124 :     #define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */
125 :     #define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */
126 :     #define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */
127 :    
128 :     /* frame type flags */
129 :     #define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */
130 :     #define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */
131 :     #define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */
132 :     #define XVID_TYPE_IVOP 1 /* intra frame */
133 :     #define XVID_TYPE_PVOP 2 /* predicted frame */
134 :     #define XVID_TYPE_BVOP 3 /* bidirectionally encoded */
135 :     #define XVID_TYPE_SVOP 4 /* predicted+sprite frame */
136 :    
137 : edgomez 199 /*****************************************************************************
138 : suxen_drol 890 * xvid_global()
139 : edgomez 199 ****************************************************************************/
140 :    
141 : suxen_drol 890 /* cpu_flags definitions */
142 : edgomez 199
143 : suxen_drol 890 #define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */
144 :     #define XVID_CPU_ASM 0x00000080 /* native assembly */
145 : edgomez 851 /* ARCH_IS_IA32 */
146 : suxen_drol 890 #define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */
147 :     #define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */
148 :     #define XVID_CPU_SSE 0x00000004 /* sse : pentium3, athlonXP */
149 :     #define XVID_CPU_SSE2 0x00000008 /* sse2 : pentium4, athlon64 */
150 :     #define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */
151 :     #define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */
152 :     #define XVID_CPU_TSC 0x00000040 /* timestamp counter */
153 : edgomez 851 /* ARCH_IS_PPC */
154 : suxen_drol 890 #define XVID_CPU_ALTIVEC 0x00000001 /* altivec */
155 : edgomez 199
156 : Isibaar 209
157 : suxen_drol 890 /* XVID_GBL_INIT param1 */
158 :     typedef struct {
159 :     int version;
160 :     int cpu_flags; /* [in:opt] zero = autodetect cpu
161 :     XVID_CPU_FORCE|{cpu features} = force cpu features */
162 :     } xvid_gbl_init_t;
163 : edgomez 199
164 :    
165 : suxen_drol 890 /* XVID_GBL_INFO param1 */
166 :     typedef struct {
167 :     int version;
168 :     int actual_version; /* [out] returns the actual xvidcore version */
169 :     const char * build; /* [out] if !null, points to description of this xvid core build */
170 :     int cpu_flags; /* [out] detected cpu features */
171 :     int num_threads; /* [out] detected number of cpus/threads */
172 :     } xvid_gbl_info_t;
173 : Isibaar 209
174 : edgomez 199
175 : suxen_drol 890 /* XVID_GBL_CONVERT param1 */
176 :     typedef struct {
177 :     int version;
178 :     xvid_image_t input; /* [in] input image & colorspace */
179 :     xvid_image_t output; /* [in] output image & colorspace */
180 : suxen_drol 920 int width; /* [in] width */
181 :     int height; /* [in] height */
182 : suxen_drol 890 int interlacing; /* [in] interlacing */
183 :     } xvid_gbl_convert_t;
184 : edgomez 851
185 : edgomez 199
186 : suxen_drol 890 #define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
187 :     #define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */
188 :     #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
189 :     #define XVID_GBL_TEST 3 /* testing.. */
190 : edgomez 199
191 : suxen_drol 890 int xvid_global(void *handle, int opt, void *param1, void *param2);
192 : edgomez 199
193 :    
194 :     /*****************************************************************************
195 : suxen_drol 890 * xvid_decore()
196 : edgomez 199 ****************************************************************************/
197 :    
198 : suxen_drol 890 #define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */
199 :     #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
200 :     #define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */
201 : edgomez 199
202 : suxen_drol 890 int xvid_decore(void *handle, int opt, void *param1, void *param2);
203 : edgomez 199
204 : suxen_drol 890 /* XVID_DEC_CREATE param 1
205 :     image width & height may be specified here when the dimensions are
206 :     known in advance. */
207 :     typedef struct {
208 :     int version;
209 :     int width; /* [in:opt] image width */
210 :     int height; /* [in:opt] image width */
211 :     void * handle; /* [out] decore context handle */
212 :     } xvid_dec_create_t;
213 : edgomez 851
214 :    
215 : suxen_drol 890 /* XVID_DEC_DECODE param1 */
216 :     /* general flags */
217 :     #define XVID_LOWDELAY 0x00000001 /* lowdelay mode */
218 :     #define XVID_DISCONTINUITY 0x00000002 /* indicates break in stream */
219 : edgomez 851
220 : suxen_drol 890 typedef struct {
221 :     int version;
222 :     int general; /* [in:opt] general flags */
223 :     void *bitstream; /* [in] bitstream (read from)*/
224 :     int length; /* [in] bitstream length */
225 :     xvid_image_t output; /* [in] output image (written to) */
226 :     }
227 :     xvid_dec_frame_t;
228 : edgomez 199
229 :    
230 : suxen_drol 890 /* XVID_DEC_DECODE param2 :: optional */
231 :     typedef struct
232 :     {
233 :     int version;
234 :     int type; /* [out] output data type */
235 :     union {
236 :     struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
237 :     int general; /* [out] flags */
238 :     int time_base; /* [out] time base */
239 :     int time_increment; /* [out] time increment */
240 : edgomez 199
241 : suxen_drol 890 /* XXX: external deblocking stuff */
242 :     unsigned char * qscale; /* [out] pointer to quantizer table */
243 :     int qscale_stride; /* [out] quantizer scale stride */
244 : edgomez 199
245 : suxen_drol 890 } vop;
246 :     struct { /* XVID_TYPE_VOL */
247 :     int general; /* [out] flags */
248 :     int width; /* [out] width */
249 :     int height; /* [out] height */
250 :     int par; /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */
251 :     int par_width; /* [out] aspect ratio width */
252 :     int par_height; /* [out] aspect ratio height */
253 :     } vol;
254 :     } data;
255 :     } xvid_dec_stats_t;
256 : albeu 315
257 :    
258 : suxen_drol 919 /*****************************************************************************
259 :     xvid plugin system -- internals
260 : edgomez 199
261 : suxen_drol 919 xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
262 :     before encoding each frame xvidcore will call XVID_PLG_BEFORE
263 :     after encoding each frame xvidcore will call XVID_PLG_AFTER
264 :     xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
265 :     ****************************************************************************/
266 :    
267 :     #define XVID_PLG_CREATE 0
268 :     #define XVID_PLG_DESTROY 1
269 :     #define XVID_PLG_INFO 2
270 :     #define XVID_PLG_BEFORE 3
271 :     #define XVID_PLG_AFTER 4
272 :    
273 :     /* xvid_plg_info_t.flags */
274 : suxen_drol 920 #define XVID_REQORIGINAL 1 /* plugin requires a copy of the original (uncompressed) image */
275 : suxen_drol 922 #define XVID_REQPSNR 2 /* plugin requires psnr between the uncompressed and compressed image*/
276 : suxen_drol 919
277 :    
278 :     typedef struct
279 :     {
280 :     int version;
281 :     int flags; /* plugin flags */
282 :     } xvid_plg_info_t;
283 :    
284 :    
285 :     typedef struct
286 :     {
287 :     int version;
288 :    
289 :     int width, height;
290 :     int fincr, fbase;
291 :    
292 :     void * param;
293 :     } xvid_plg_create_t;
294 :    
295 :    
296 :     typedef struct
297 :     {
298 :     int version;
299 :    
300 : suxen_drol 920 int width; /* [out] */
301 :     int height; /* [out] */
302 :     int fincr; /* [out] */
303 :     int fbase; /* [out] */
304 :    
305 :     xvid_image_t reference; /* [out] -> [out] */
306 :     xvid_image_t current; /* [out] -> [in,out] */
307 :     xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */
308 :     int frame_num; /* [out] frame number */
309 : suxen_drol 919
310 : suxen_drol 920 int type; /* [in,out] */
311 :     int quant; /* [in,out] */
312 :    
313 : suxen_drol 919 unsigned char * qscale; /* [in,out] pointer to quantizer table */
314 :     int qscale_stride; /* [in,out] quantizer scale stride */
315 :    
316 :     int vop_flags; /* [in,out] */
317 :     int vol_flags; /* [in,out] */
318 :     int motion_flags; /* [in,out] */
319 :    
320 :     int length; /* [out] after: length of encoded frame */
321 :     int kblks, mblks, ublks; /* [out] after: */
322 : suxen_drol 922 int sse_y, sse_u, sse_v; /* [out] */
323 : suxen_drol 919 } xvid_plg_data_t;
324 :    
325 :    
326 : edgomez 851 /*****************************************************************************
327 : suxen_drol 919 xvid plugin system -- external
328 :    
329 :     the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
330 :     indicates the plugin function pointer and plugin-specific data.
331 :     xvidcore handles the rest. example:
332 :    
333 :     xvid_enc_create_t create;
334 :     xvid_enc_plugin_t plugins[2];
335 :    
336 :     plugins[0].func = xvid_psnr_func;
337 :     plugins[0].param = NULL;
338 :     plugins[1].func = xvid_cbr_func;
339 :     plugins[1].param = &cbr_data;
340 :    
341 :     create.num_plugins = 2;
342 :     create.plugins = plugins;
343 :    
344 :     ****************************************************************************/
345 :    
346 :     typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
347 :    
348 :     typedef struct
349 :     {
350 :     xvid_plugin_func * func;
351 :     void * param;
352 :     } xvid_enc_plugin_t;
353 :    
354 : suxen_drol 920 xvid_plugin_func xvid_plugin_psnr; /* stdout psnr calculator */
355 :     xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */
356 : suxen_drol 919
357 :    
358 : suxen_drol 920
359 : suxen_drol 919 /*****************************************************************************
360 : suxen_drol 890 * xvid_encore()
361 : edgomez 851 ****************************************************************************/
362 : edgomez 199
363 : suxen_drol 890 /* Encoder options */
364 :     #define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */
365 :     #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
366 :     #define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes
367 :     0 means this frame should not be written (ie. encoder lag) */
368 : edgomez 199
369 : suxen_drol 890 int xvid_encore(void *handle, int opt, void *param1, void *param2);
370 : edgomez 199
371 :    
372 : suxen_drol 890 /* global flags */
373 :     typedef enum
374 :     {
375 :     XVID_PACKED = 0x00000001, /* packed bitstream */
376 :     XVID_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */
377 : suxen_drol 922 XVID_EXTRASTATS_ENABLE = 0x00000004
378 : suxen_drol 890 /*define XVID_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */
379 :     /*define XVID_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
380 :     } xvid_global_t;
381 : edgomez 199
382 :    
383 : suxen_drol 890 /* XVID_ENC_ENCODE param1 */
384 :     /* vol-based flags */
385 :     typedef enum {
386 :     XVID_MPEGQUANT = 0x00000001,
387 : suxen_drol 922 XVID_EXTRASTATS = 0x00000002,
388 : suxen_drol 890 XVID_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */
389 :     XVID_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */
390 :     XVID_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */
391 :     XVID_INTERLACING = 0x00000400, /* enable interlaced encoding */
392 :     } xvid_vol_t;
393 : edgomez 199
394 :    
395 : suxen_drol 890 /* vop-based flags */
396 :     typedef enum {
397 :     XVID_DEBUG = 0x00000001,
398 : suxen_drol 920
399 : suxen_drol 890 XVID_HALFPEL = 0x00000004, /* use halfpel interpolation */
400 :     XVID_INTER4V = 0x00000008,
401 :     XVID_LUMIMASKING = 0x00000010,
402 :    
403 :     XVID_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */
404 :     XVID_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for
405 :     color input material chroma is ignored) */
406 :     XVID_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */
407 :     XVID_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */
408 :     XVID_DYNAMIC_BFRAMES = 0x00000200,
409 : edgomez 199
410 : suxen_drol 890 /* only valid for vol_flags|=XVID_INTERLACING */
411 :     XVID_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */
412 :     XVID_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */
413 : edgomez 199
414 : suxen_drol 890 /* only valid for vol_flags|=XVID_REDUCED_ENABLED */
415 :     XVID_REDUCED = 0x00001000, /* reduced resolution vop */
416 :     } xvid_vop_t;
417 : edgomez 853
418 : edgomez 199
419 : suxen_drol 890 typedef enum {
420 :     PMV_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
421 :     PMV_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */
422 : chl 352
423 : suxen_drol 890 PMV_HALFPELREFINE16 = 0x00020000,
424 :     PMV_HALFPELREFINE8 = 0x02000000,
425 : edgomez 199
426 : suxen_drol 890 PMV_QUARTERPELREFINE16 = 0x00040000,
427 :     PMV_QUARTERPELREFINE8 = 0x04000000,
428 : edgomez 199
429 : suxen_drol 890 PMV_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */
430 : edgomez 199
431 : suxen_drol 890 PMV_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */
432 :     PMV_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */
433 :     PMV_USESQUARES8 = 0x80000000, /* use square for PMV_EXTSEARCH8 */
434 : edgomez 608
435 : suxen_drol 890 PMV_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
436 :     PMV_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */
437 : edgomez 851
438 : suxen_drol 890 /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */
439 :     HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */
440 :     HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
441 :     QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
442 :     QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
443 : edgomez 851
444 : suxen_drol 890 EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern
445 :     enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
446 :     CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */
447 : edgomez 851
448 : suxen_drol 890 PMV_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */
449 :     PMV_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */
450 :     PMV_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */
451 :     PMV_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */
452 :     } xvid_motion_t;
453 : edgomez 851
454 :    
455 : suxen_drol 890 /* XVID_ENC_CREATE param1 */
456 :     typedef struct {
457 :     int version;
458 :     int width; /* [in] frame dimensions; width, pixel units */
459 :     int height; /* [in] frame dimensions; height, pixel units */
460 : edgomez 851
461 : suxen_drol 919 int num_plugins; /* [in:opt] number of plugins */
462 :     xvid_enc_plugin_t * plugins; /* ^^ plugin array */
463 :    
464 : suxen_drol 890 int num_threads; /* [in:opt] number of threads */
465 :     int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */
466 : edgomez 851
467 : suxen_drol 890 xvid_global_t global; /* [in:opt] global flags; controls encoding behavior */
468 : edgomez 851
469 : suxen_drol 890 /* --- vol-based stuff; included here for conveinience */
470 :     int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */
471 :     int fbase; /* [in] framerate base
472 :     frame_duration = fincr/fbase seconds*/
473 :     /* ^^^---------------------------------------------- */
474 : edgomez 851
475 :    
476 : suxen_drol 890 /* ---vop-based; included here for conveienience */
477 :     int max_key_interval; /* [in:opt] the maximum interval between key frames */
478 :     /*XXX: maybe call it gop_size? */
479 : edgomez 851
480 : suxen_drol 890 int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */
481 : edgomez 851
482 : suxen_drol 890 int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
483 :     int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
484 : edgomez 851
485 : suxen_drol 890 /* ^^^ -------------------------------------------------------------------------*/
486 : edgomez 851
487 : suxen_drol 890 void *handle; /* [out] encoder instance handle */
488 :     }
489 :     xvid_enc_create_t;
490 : edgomez 851
491 :    
492 : suxen_drol 890 typedef struct {
493 :     int version;
494 :     int type; /* [in] rate control type: XVID_RC_xxx */
495 : edgomez 199
496 : suxen_drol 890 /* common stuff */
497 :     int min_iquant; /* [in:opt] ivop quantizer upper/lower limit */
498 :     int max_iquant; /* [in:opt] */
499 :     int min_pquant; /* [in:opt] psvop quantizer upper/lower limit */
500 :     int max_pquant; /* [in:opt] */
501 :     int min_bquant; /* [in:opt] bvop quantizer upper/lower limit */
502 :     int max_bquant; /* [in:opt] */
503 :    
504 :     union {
505 :     struct { /* XVID_RC_FQUANT */
506 :     float quant; /* [in] quantizer */
507 :     } fquant;
508 :     struct { /* XVID_RC_CBR */
509 :     int bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */
510 :     int reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */
511 :     int averaging_period; /* [in] */
512 :     int buffer; /* [in] */
513 :     } cbr;
514 :     } data;
515 :     } xvid_enc_rc_t;
516 : edgomez 199
517 :    
518 :    
519 : suxen_drol 890 #define XVID_KEYFRAME 0x00000001
520 : edgomez 199
521 : suxen_drol 890 typedef struct {
522 :     int version;
523 : edgomez 199
524 : suxen_drol 890 /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
525 :     changes here until the next VOL (keyframe). */
526 :     xvid_vol_t vol_flags; /* [in] vol flags */
527 :     unsigned char *
528 :     quant_intra_matrix; /* [in:opt] custom intra qmatrix */
529 :     unsigned char *
530 :     quant_inter_matrix; /* [in:opt] custom inter qmatrix */
531 : edgomez 199
532 : suxen_drol 890 int par; /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
533 :     int par_width; /* [in:opt] aspect ratio width */
534 :     int par_height; /* [in:opt] aspect ratio height */
535 :     /* ^^^----------------------------------------------------------------------------------*/
536 : edgomez 199
537 : suxen_drol 925 int fincr; /* framerate increment, for variable framerate only */
538 : suxen_drol 890 xvid_vop_t vop_flags; /* [in] (general)vop-based flags */
539 :     xvid_motion_t motion; /* [in] ME options */
540 : edgomez 851
541 : suxen_drol 890 xvid_image_t input; /* [in] input image (read from) */
542 :    
543 :     int type; /* [in:opt] coding type */
544 :     int quant; /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
545 :     int bquant; /* [in:opt] bframe quantizer; if <=0, automatic*/
546 : edgomez 851
547 : suxen_drol 890 void *bitstream; /* [in:opt] bitstream ptr (written to)*/
548 :     int length; /* [in:opt] bitstream length (bytes) */
549 : edgomez 851
550 : suxen_drol 890 int out_flags; /* [out] bitstream output flags */
551 :     }
552 :     xvid_enc_frame_t;
553 : edgomez 199
554 :    
555 : suxen_drol 890 /* XVID_ENC_ENCODE param2 (optional)
556 :     xvid_enc_stats_t describes individual frame details
557 :    
558 :     coding_type==XVID_TYPE_NOTHING if the stats are not given
559 :     */
560 :     typedef struct {
561 :     int version;
562 : edgomez 199
563 : suxen_drol 890 /* encoding parameters */
564 :     int type; /* [out] coding type */
565 :     int quant; /* [out] frame quantizer */
566 :     xvid_vol_t vol_flags; /* [out] vol flags (see above) */
567 :     int vop_flags; /* [out] vop flags (see above) */
568 :     /* bitrate */
569 :     int length; /* [out] frame length */
570 : edgomez 199
571 : suxen_drol 890 int hlength; /* [out] header length (bytes) */
572 :     int kblks, mblks, ublks; /* [out] */
573 : edgomez 199
574 : suxen_drol 890 int sse_y, sse_u, sse_v;
575 :     }
576 :     xvid_enc_stats_t;
577 : edgomez 199
578 :     #ifdef __cplusplus
579 :     }
580 :     #endif
581 :    
582 : suxen_drol 919
583 : edgomez 199 #endif

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