[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 1031 - (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 1031 * $Id: xvid.h,v 1.27.2.19 2003-05-17 13:26:28 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 : suxen_drol 1014 /* video-object-sequence profiles */
120 :     #define XVID_PROFILE_S_L0 0x08 /* simple */
121 :     #define XVID_PROFILE_S_L1 0x01
122 :     #define XVID_PROFILE_S_L2 0x02
123 :     #define XVID_PROFILE_S_L3 0x03
124 :     #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
125 :     #define XVID_PROFILE_ARTS_L2 0x92
126 :     #define XVID_PROFILE_ARTS_L3 0x93
127 :     #define XVID_PROFILE_ARTS_L4 0x94
128 :     #define XVID_PROFILE_AS_L0 0xf0 /* advanced simple */
129 :     #define XVID_PROFILE_AS_L1 0xf1
130 :     #define XVID_PROFILE_AS_L2 0xf2
131 :     #define XVID_PROFILE_AS_L3 0xf3
132 :     #define XVID_PROFILE_AS_L4 0xf4
133 : suxen_drol 890
134 :     /* aspect ratios */
135 :     #define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */
136 :     #define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */
137 :     #define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */
138 :     #define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */
139 :     #define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */
140 :     #define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */
141 :    
142 :     /* frame type flags */
143 :     #define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */
144 :     #define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */
145 :     #define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */
146 :     #define XVID_TYPE_IVOP 1 /* intra frame */
147 :     #define XVID_TYPE_PVOP 2 /* predicted frame */
148 :     #define XVID_TYPE_BVOP 3 /* bidirectionally encoded */
149 :     #define XVID_TYPE_SVOP 4 /* predicted+sprite frame */
150 :    
151 : suxen_drol 1014
152 : edgomez 199 /*****************************************************************************
153 : suxen_drol 890 * xvid_global()
154 : edgomez 199 ****************************************************************************/
155 :    
156 : suxen_drol 890 /* cpu_flags definitions */
157 : edgomez 199
158 : suxen_drol 890 #define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */
159 :     #define XVID_CPU_ASM 0x00000080 /* native assembly */
160 : edgomez 851 /* ARCH_IS_IA32 */
161 : suxen_drol 890 #define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */
162 :     #define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */
163 :     #define XVID_CPU_SSE 0x00000004 /* sse : pentium3, athlonXP */
164 :     #define XVID_CPU_SSE2 0x00000008 /* sse2 : pentium4, athlon64 */
165 :     #define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */
166 :     #define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */
167 :     #define XVID_CPU_TSC 0x00000040 /* timestamp counter */
168 : edgomez 851 /* ARCH_IS_PPC */
169 : suxen_drol 890 #define XVID_CPU_ALTIVEC 0x00000001 /* altivec */
170 : edgomez 199
171 : Isibaar 209
172 : suxen_drol 1031 #define XVID_DEBUG_ERROR 0x00000001
173 :     #define XVID_DEBUG_STARTCODE 0x00000002
174 :     #define XVID_DEBUG_HEADER 0x00000004
175 :     #define XVID_DEBUG_TIMECODE 0x00000008
176 :     #define XVID_DEBUG_MB 0x00000010
177 :     #define XVID_DEBUG_COEFF 0x00000020
178 :     #define XVID_DEBUG_MV 0x00000040
179 :     #define XVID_DEBUG_RC 0x00000080
180 :     #define XVID_DEBUG_DEBUG 0x80000000
181 :    
182 : suxen_drol 890 /* XVID_GBL_INIT param1 */
183 :     typedef struct {
184 :     int version;
185 :     int cpu_flags; /* [in:opt] zero = autodetect cpu
186 :     XVID_CPU_FORCE|{cpu features} = force cpu features */
187 : suxen_drol 1031 int debug; /* [in:opt] debug level */
188 : suxen_drol 890 } xvid_gbl_init_t;
189 : edgomez 199
190 :    
191 : suxen_drol 890 /* XVID_GBL_INFO param1 */
192 :     typedef struct {
193 :     int version;
194 :     int actual_version; /* [out] returns the actual xvidcore version */
195 :     const char * build; /* [out] if !null, points to description of this xvid core build */
196 :     int cpu_flags; /* [out] detected cpu features */
197 :     int num_threads; /* [out] detected number of cpus/threads */
198 :     } xvid_gbl_info_t;
199 : Isibaar 209
200 : edgomez 199
201 : suxen_drol 890 /* XVID_GBL_CONVERT param1 */
202 :     typedef struct {
203 :     int version;
204 :     xvid_image_t input; /* [in] input image & colorspace */
205 :     xvid_image_t output; /* [in] output image & colorspace */
206 : suxen_drol 920 int width; /* [in] width */
207 :     int height; /* [in] height */
208 : suxen_drol 890 int interlacing; /* [in] interlacing */
209 :     } xvid_gbl_convert_t;
210 : edgomez 851
211 : edgomez 199
212 : suxen_drol 890 #define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
213 :     #define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */
214 :     #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
215 :     #define XVID_GBL_TEST 3 /* testing.. */
216 : edgomez 199
217 : suxen_drol 890 int xvid_global(void *handle, int opt, void *param1, void *param2);
218 : edgomez 199
219 :    
220 :     /*****************************************************************************
221 : suxen_drol 890 * xvid_decore()
222 : edgomez 199 ****************************************************************************/
223 :    
224 : suxen_drol 890 #define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */
225 :     #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
226 :     #define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */
227 : edgomez 199
228 : suxen_drol 890 int xvid_decore(void *handle, int opt, void *param1, void *param2);
229 : edgomez 199
230 : suxen_drol 890 /* XVID_DEC_CREATE param 1
231 :     image width & height may be specified here when the dimensions are
232 :     known in advance. */
233 :     typedef struct {
234 :     int version;
235 :     int width; /* [in:opt] image width */
236 :     int height; /* [in:opt] image width */
237 :     void * handle; /* [out] decore context handle */
238 :     } xvid_dec_create_t;
239 : edgomez 851
240 :    
241 : suxen_drol 890 /* XVID_DEC_DECODE param1 */
242 :     /* general flags */
243 :     #define XVID_LOWDELAY 0x00000001 /* lowdelay mode */
244 :     #define XVID_DISCONTINUITY 0x00000002 /* indicates break in stream */
245 : edgomez 851
246 : suxen_drol 890 typedef struct {
247 :     int version;
248 :     int general; /* [in:opt] general flags */
249 :     void *bitstream; /* [in] bitstream (read from)*/
250 :     int length; /* [in] bitstream length */
251 :     xvid_image_t output; /* [in] output image (written to) */
252 :     }
253 :     xvid_dec_frame_t;
254 : edgomez 199
255 :    
256 : suxen_drol 890 /* XVID_DEC_DECODE param2 :: optional */
257 :     typedef struct
258 :     {
259 :     int version;
260 :     int type; /* [out] output data type */
261 :     union {
262 :     struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
263 :     int general; /* [out] flags */
264 :     int time_base; /* [out] time base */
265 :     int time_increment; /* [out] time increment */
266 : edgomez 199
267 : suxen_drol 890 /* XXX: external deblocking stuff */
268 : suxen_drol 926 int * qscale; /* [out] pointer to quantizer table */
269 : suxen_drol 890 int qscale_stride; /* [out] quantizer scale stride */
270 : edgomez 199
271 : suxen_drol 890 } vop;
272 :     struct { /* XVID_TYPE_VOL */
273 :     int general; /* [out] flags */
274 :     int width; /* [out] width */
275 :     int height; /* [out] height */
276 :     int par; /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */
277 :     int par_width; /* [out] aspect ratio width */
278 :     int par_height; /* [out] aspect ratio height */
279 :     } vol;
280 :     } data;
281 :     } xvid_dec_stats_t;
282 : albeu 315
283 :    
284 : suxen_drol 1014
285 :     #define XVID_ZONE_QUANT 1
286 :     #define XVID_ZONE_WEIGHT 2
287 :     typedef struct
288 :     {
289 :     int frame;
290 :     int mode;
291 :     int increment;
292 :     int base;
293 :     } xvid_enc_zone_t;
294 :    
295 :    
296 :    
297 : suxen_drol 919 /*****************************************************************************
298 :     xvid plugin system -- internals
299 : edgomez 199
300 : suxen_drol 919 xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
301 :     before encoding each frame xvidcore will call XVID_PLG_BEFORE
302 :     after encoding each frame xvidcore will call XVID_PLG_AFTER
303 :     xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
304 :     ****************************************************************************/
305 :    
306 : suxen_drol 1014
307 : suxen_drol 919 #define XVID_PLG_CREATE 0
308 :     #define XVID_PLG_DESTROY 1
309 :     #define XVID_PLG_INFO 2
310 :     #define XVID_PLG_BEFORE 3
311 :     #define XVID_PLG_AFTER 4
312 :    
313 :     /* xvid_plg_info_t.flags */
314 : suxen_drol 920 #define XVID_REQORIGINAL 1 /* plugin requires a copy of the original (uncompressed) image */
315 : suxen_drol 922 #define XVID_REQPSNR 2 /* plugin requires psnr between the uncompressed and compressed image*/
316 : suxen_drol 926 #define XVID_REQDQUANTS 3 /* plugin requires access to the dquant table */
317 : suxen_drol 919
318 :    
319 :     typedef struct
320 :     {
321 :     int version;
322 : suxen_drol 1014 int flags; /* [in:opt] plugin flags */
323 : suxen_drol 919 } xvid_plg_info_t;
324 :    
325 :    
326 :     typedef struct
327 :     {
328 :     int version;
329 :    
330 : suxen_drol 1014 int num_zones; /* [out] */
331 :     xvid_enc_zone_t * zones; /* [out] */
332 : suxen_drol 919
333 : suxen_drol 1014 int width; /* [out] */
334 :     int height; /* [out] */
335 :     int mb_width; /* [out] */
336 :     int mb_height; /* [out] */
337 :     int fincr; /* [out] */
338 :     int fbase; /* [out] */
339 :    
340 :     void * param; /* [out] */
341 : suxen_drol 919 } xvid_plg_create_t;
342 :    
343 :    
344 :     typedef struct
345 :     {
346 :     int version;
347 :    
348 : suxen_drol 938 int num_frames; /* [out] totlal frame encoded */
349 :     } xvid_plg_destroy_t;
350 :    
351 :    
352 :     typedef struct
353 :     {
354 :     int version;
355 :    
356 : suxen_drol 1014 xvid_enc_zone_t * zone; /* [out] current zone */
357 :    
358 : suxen_drol 920 int width; /* [out] */
359 :     int height; /* [out] */
360 : suxen_drol 926 int mb_width; /* [out] */
361 :     int mb_height; /* [out] */
362 : suxen_drol 920 int fincr; /* [out] */
363 :     int fbase; /* [out] */
364 : suxen_drol 1014
365 :     int min_quant[3]; /* [out] */
366 :     int max_quant[3]; /* [out] */
367 : suxen_drol 920
368 :     xvid_image_t reference; /* [out] -> [out] */
369 :     xvid_image_t current; /* [out] -> [in,out] */
370 :     xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */
371 :     int frame_num; /* [out] frame number */
372 : suxen_drol 919
373 : suxen_drol 920 int type; /* [in,out] */
374 :     int quant; /* [in,out] */
375 :    
376 : suxen_drol 926 int * dquant; /* [in,out] pointer to diff quantizer table */
377 :     int dquant_stride; /* [in,out] diff quantizer stride */
378 : suxen_drol 919
379 :     int vop_flags; /* [in,out] */
380 :     int vol_flags; /* [in,out] */
381 :     int motion_flags; /* [in,out] */
382 :    
383 :     int length; /* [out] after: length of encoded frame */
384 :     int kblks, mblks, ublks; /* [out] after: */
385 : suxen_drol 922 int sse_y, sse_u, sse_v; /* [out] */
386 : suxen_drol 919 } xvid_plg_data_t;
387 :    
388 :    
389 : edgomez 851 /*****************************************************************************
390 : suxen_drol 919 xvid plugin system -- external
391 :    
392 :     the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
393 :     indicates the plugin function pointer and plugin-specific data.
394 :     xvidcore handles the rest. example:
395 :    
396 :     xvid_enc_create_t create;
397 :     xvid_enc_plugin_t plugins[2];
398 :    
399 :     plugins[0].func = xvid_psnr_func;
400 :     plugins[0].param = NULL;
401 :     plugins[1].func = xvid_cbr_func;
402 :     plugins[1].param = &cbr_data;
403 :    
404 :     create.num_plugins = 2;
405 :     create.plugins = plugins;
406 :    
407 :     ****************************************************************************/
408 :    
409 :     typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
410 :    
411 :     typedef struct
412 :     {
413 :     xvid_plugin_func * func;
414 :     void * param;
415 :     } xvid_enc_plugin_t;
416 :    
417 : suxen_drol 938
418 : suxen_drol 1014 xvid_plugin_func xvid_plugin_single; /* single-pass rate control */
419 :     xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */
420 :     xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */
421 : suxen_drol 938
422 :     xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */
423 :    
424 : suxen_drol 926 xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */
425 : suxen_drol 920 xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */
426 : suxen_drol 919
427 :    
428 : suxen_drol 938
429 : suxen_drol 1014 typedef struct /* single pass rate control */
430 : suxen_drol 938 {
431 :     int version;
432 : suxen_drol 977 int bitrate; /* bits per second */
433 : suxen_drol 938 int reaction_delay_factor;
434 :     int averaging_period;
435 :     int buffer;
436 : suxen_drol 1014 } xvid_plugin_single_t;
437 : suxen_drol 938
438 :    
439 :     typedef struct {
440 :     int version;
441 :     char * filename;
442 :     } xvid_plugin_2pass1_t;
443 :    
444 :    
445 : suxen_drol 942 #define XVID_CURVE_COSINE 0 /* low aggressiveness */
446 :     #define XVID_CURVE_LINEAR 1 /* medium aggressiveness */
447 :     #define XVID_CURVE_SINE 2 /* high aggressiveness */
448 : suxen_drol 938
449 : suxen_drol 942 #define XVID_PAYBACK_BIAS 0 /* payback with bias */
450 :     #define XVID_PAYBACK_PROP 1 /* payback proportionally */
451 : suxen_drol 938
452 : suxen_drol 942 typedef struct {
453 :     int version;
454 : suxen_drol 1014 int bitrate; /* bits per second */
455 : suxen_drol 977 char * filename;
456 : suxen_drol 1014
457 : suxen_drol 942 int keyframe_boost; /* keyframe boost percentage: [0..100...]; */
458 :     int payback_method;
459 :     int bitrate_payback_delay;
460 :     int curve_compression_high;
461 :     int curve_compression_low;
462 :     int max_overflow_improvement;
463 :     int max_overflow_degradation;
464 :    
465 :     int use_alt_curve;
466 :     int alt_curve_high_dist;
467 :     int alt_curve_low_dist;
468 :     int alt_curve_use_auto;
469 :     int alt_curve_auto_str;
470 :     int alt_curve_type; /* XVID_CURVE_ */
471 :     int alt_curve_min_rel_qual;
472 :     int alt_curve_use_auto_bonus_bias;
473 :     int alt_curve_bonus_bias;
474 :    
475 :     int kftreshold;
476 :     int kfreduction;
477 :     int min_key_interval;
478 :     }xvid_plugin_2pass2_t;
479 :    
480 :    
481 : suxen_drol 919 /*****************************************************************************
482 : suxen_drol 890 * xvid_encore()
483 : edgomez 851 ****************************************************************************/
484 : edgomez 199
485 : suxen_drol 890 /* Encoder options */
486 :     #define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */
487 :     #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
488 :     #define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes
489 :     0 means this frame should not be written (ie. encoder lag) */
490 : edgomez 199
491 : suxen_drol 890 int xvid_encore(void *handle, int opt, void *param1, void *param2);
492 : edgomez 199
493 :    
494 : suxen_drol 890 /* global flags */
495 :     typedef enum
496 :     {
497 : edgomez 949 XVID_GLOBAL_PACKED = 0x00000001, /* packed bitstream */
498 :     XVID_GLOBAL_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */
499 :     XVID_GLOBAL_EXTRASTATS_ENABLE = 0x00000004
500 :     /*define XVID_GLOBAL_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */
501 :     /*define XVID_GLOBAL_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
502 : suxen_drol 890 } xvid_global_t;
503 : edgomez 199
504 :    
505 : suxen_drol 890 /* XVID_ENC_ENCODE param1 */
506 :     /* vol-based flags */
507 :     typedef enum {
508 : edgomez 949 XVID_VOL_MPEGQUANT = 0x00000001,
509 :     XVID_VOL_EXTRASTATS = 0x00000002,
510 :     XVID_VOL_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */
511 :     XVID_VOL_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */
512 :     XVID_VOL_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */
513 :     XVID_VOL_INTERLACING = 0x00000400, /* enable interlaced encoding */
514 : suxen_drol 890 } xvid_vol_t;
515 : edgomez 199
516 :    
517 : suxen_drol 890 /* vop-based flags */
518 :     typedef enum {
519 : edgomez 949 XVID_VOP_DEBUG = 0x00000001,
520 : suxen_drol 920
521 : edgomez 949 XVID_VOP_HALFPEL = 0x00000004, /* use halfpel interpolation */
522 :     XVID_VOP_INTER4V = 0x00000008,
523 : suxen_drol 890
524 : chl 993 XVID_VOP_TRELLISQUANT = 0x00000010, /* use trellis based R-D "optimal" quantization */
525 :    
526 : edgomez 949 XVID_VOP_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */
527 :     XVID_VOP_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for
528 : suxen_drol 890 color input material chroma is ignored) */
529 : edgomez 949 XVID_VOP_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */
530 :     XVID_VOP_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */
531 : edgomez 199
532 : edgomez 949 /* only valid for vol_flags|=XVID_VOL_INTERLACING */
533 :     XVID_VOP_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */
534 :     XVID_VOP_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */
535 : edgomez 199
536 : edgomez 949 /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
537 :     XVID_VOP_REDUCED = 0x00001000, /* reduced resolution vop */
538 : suxen_drol 890 } xvid_vop_t;
539 : edgomez 853
540 : edgomez 199
541 : suxen_drol 890 typedef enum {
542 : edgomez 949 XVID_ME_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
543 :     XVID_ME_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */
544 : chl 352
545 : edgomez 949 XVID_ME_HALFPELREFINE16 = 0x00020000,
546 :     XVID_ME_HALFPELREFINE8 = 0x02000000,
547 : edgomez 199
548 : edgomez 949 XVID_ME_QUARTERPELREFINE16 = 0x00040000,
549 :     XVID_ME_QUARTERPELREFINE8 = 0x04000000,
550 : edgomez 199
551 : edgomez 949 XVID_ME_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */
552 : edgomez 199
553 : edgomez 949 XVID_ME_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */
554 :     XVID_ME_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */
555 :     XVID_ME_USESQUARES8 = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */
556 : edgomez 608
557 : edgomez 949 XVID_ME_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
558 :     XVID_ME_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */
559 : edgomez 851
560 : edgomez 949 /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
561 :     XVID_ME_HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */
562 :     XVID_ME_HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
563 :     XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
564 :     XVID_ME_QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
565 : edgomez 851
566 : edgomez 949 XVID_ME_EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern
567 :     enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
568 :     XVID_ME_CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */
569 : edgomez 851
570 : edgomez 949 XVID_ME_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */
571 :     XVID_ME_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */
572 :     XVID_ME_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */
573 :     XVID_ME_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */
574 : suxen_drol 890 } xvid_motion_t;
575 : edgomez 851
576 :    
577 : suxen_drol 890 /* XVID_ENC_CREATE param1 */
578 :     typedef struct {
579 :     int version;
580 : suxen_drol 1014
581 :     int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */
582 : suxen_drol 890 int width; /* [in] frame dimensions; width, pixel units */
583 :     int height; /* [in] frame dimensions; height, pixel units */
584 : edgomez 851
585 : suxen_drol 1014 int num_zones; /* [in:opt] number of bitrate zones */
586 :     xvid_enc_zone_t * zones; /* ^^ zone array */
587 :    
588 : suxen_drol 919 int num_plugins; /* [in:opt] number of plugins */
589 :     xvid_enc_plugin_t * plugins; /* ^^ plugin array */
590 :    
591 : suxen_drol 890 int num_threads; /* [in:opt] number of threads */
592 :     int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */
593 : edgomez 851
594 : suxen_drol 890 xvid_global_t global; /* [in:opt] global flags; controls encoding behavior */
595 : edgomez 851
596 : suxen_drol 890 /* --- vol-based stuff; included here for conveinience */
597 :     int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */
598 :     int fbase; /* [in] framerate base
599 :     frame_duration = fincr/fbase seconds*/
600 :     /* ^^^---------------------------------------------- */
601 : edgomez 851
602 :    
603 : suxen_drol 890 /* ---vop-based; included here for conveienience */
604 :     int max_key_interval; /* [in:opt] the maximum interval between key frames */
605 :     /*XXX: maybe call it gop_size? */
606 : edgomez 851
607 : suxen_drol 890 int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */
608 : edgomez 851
609 : suxen_drol 890 int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
610 :     int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
611 : edgomez 851
612 : suxen_drol 1014 int min_quant[3]; /* [in:opt] */
613 :     int max_quant[3]; /* [in:opt] */
614 :    
615 : suxen_drol 890 /* ^^^ -------------------------------------------------------------------------*/
616 : edgomez 851
617 : suxen_drol 890 void *handle; /* [out] encoder instance handle */
618 :     }
619 :     xvid_enc_create_t;
620 : edgomez 851
621 :    
622 : suxen_drol 890 #define XVID_KEYFRAME 0x00000001
623 : edgomez 199
624 : suxen_drol 890 typedef struct {
625 :     int version;
626 : edgomez 199
627 : suxen_drol 890 /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
628 :     changes here until the next VOL (keyframe). */
629 :     xvid_vol_t vol_flags; /* [in] vol flags */
630 :     unsigned char *
631 :     quant_intra_matrix; /* [in:opt] custom intra qmatrix */
632 :     unsigned char *
633 :     quant_inter_matrix; /* [in:opt] custom inter qmatrix */
634 : edgomez 199
635 : suxen_drol 890 int par; /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
636 :     int par_width; /* [in:opt] aspect ratio width */
637 :     int par_height; /* [in:opt] aspect ratio height */
638 :     /* ^^^----------------------------------------------------------------------------------*/
639 : edgomez 199
640 : suxen_drol 925 int fincr; /* framerate increment, for variable framerate only */
641 : suxen_drol 890 xvid_vop_t vop_flags; /* [in] (general)vop-based flags */
642 :     xvid_motion_t motion; /* [in] ME options */
643 : edgomez 851
644 : suxen_drol 890 xvid_image_t input; /* [in] input image (read from) */
645 :    
646 :     int type; /* [in:opt] coding type */
647 :     int quant; /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
648 : edgomez 953 int bframe_threshold;
649 : edgomez 851
650 : suxen_drol 890 void *bitstream; /* [in:opt] bitstream ptr (written to)*/
651 :     int length; /* [in:opt] bitstream length (bytes) */
652 : edgomez 851
653 : suxen_drol 890 int out_flags; /* [out] bitstream output flags */
654 :     }
655 :     xvid_enc_frame_t;
656 : edgomez 199
657 :    
658 : suxen_drol 890 /* XVID_ENC_ENCODE param2 (optional)
659 :     xvid_enc_stats_t describes individual frame details
660 :    
661 :     coding_type==XVID_TYPE_NOTHING if the stats are not given
662 :     */
663 :     typedef struct {
664 :     int version;
665 : edgomez 199
666 : suxen_drol 890 /* encoding parameters */
667 :     int type; /* [out] coding type */
668 :     int quant; /* [out] frame quantizer */
669 :     xvid_vol_t vol_flags; /* [out] vol flags (see above) */
670 :     int vop_flags; /* [out] vop flags (see above) */
671 :     /* bitrate */
672 :     int length; /* [out] frame length */
673 : edgomez 199
674 : suxen_drol 890 int hlength; /* [out] header length (bytes) */
675 :     int kblks, mblks, ublks; /* [out] */
676 : edgomez 199
677 : suxen_drol 890 int sse_y, sse_u, sse_v;
678 :     }
679 :     xvid_enc_stats_t;
680 : edgomez 199
681 :     #ifdef __cplusplus
682 :     }
683 :     #endif
684 :    
685 : suxen_drol 919
686 : edgomez 199 #endif

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