[svn] / branches / release-1_0-branch / xvidcore / src / xvid.h Repository:
ViewVC logotype

Annotation of /branches/release-1_0-branch/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1580 - (view) (download)

1 : edgomez 199 /*****************************************************************************
2 : edgomez 868 *
3 : edgomez 1382 * XVID MPEG-4 VIDEO CODEC
4 :     * - XviD Main header file -
5 : edgomez 868 *
6 : edgomez 1382 * Copyright(C) 2001-2003 Peter Ross <pross@xvid.org>
7 : edgomez 868 *
8 : edgomez 1382 * This program is free software ; you can redistribute it and/or modify
9 : edgomez 868 * it under the terms of the GNU General Public License as published by
10 : edgomez 1382 * the Free Software Foundation ; either version 2 of the License, or
11 : edgomez 868 * (at your option) any later version.
12 :     *
13 :     * This program is distributed in the hope that it will be useful,
14 : edgomez 1382 * but WITHOUT ANY WARRANTY ; without even the implied warranty of
15 : edgomez 868 * 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 : edgomez 1382 * along with this program ; if not, write to the Free Software
20 : edgomez 868 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 :     *
22 : edgomez 1580 * $Id: xvid.h,v 1.33.2.9 2004-12-19 12:04:27 edgomez Exp $
23 : edgomez 868 *
24 :     ****************************************************************************/
25 : edgomez 199
26 :     #ifndef _XVID_H_
27 :     #define _XVID_H_
28 :    
29 : edgomez 1382
30 : edgomez 199 #ifdef __cplusplus
31 : chl 352 extern "C" {
32 : edgomez 199 #endif
33 :    
34 :     /*****************************************************************************
35 : edgomez 1382 * versioning
36 : edgomez 199 ****************************************************************************/
37 :    
38 : edgomez 1382 /* 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 : edgomez 1382 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_VERSION_MAJOR(a) ((char)(((a)>>16) & 0xff))
53 :     #define XVID_VERSION_MINOR(a) ((char)(((a)>> 8) & 0xff))
54 :     #define XVID_VERSION_PATCH(a) ((char)(((a)>> 0) & 0xff))
55 :    
56 :     #define XVID_MAKE_API(a,b) ((((a)&0xff)<<16) | (((b)&0xff)<<0))
57 :     #define XVID_API_MAJOR(a) (((a)>>16) & 0xff)
58 :     #define XVID_API_MINOR(a) (((a)>> 0) & 0xff)
59 :    
60 : edgomez 1580 #define XVID_VERSION XVID_MAKE_VERSION(1,0,3)
61 : edgomez 1382 #define XVID_API XVID_MAKE_API(4, 0)
62 :    
63 :     /* Bitstream Version
64 :     * this will be writen into the bitstream to allow easy detection of xvid
65 :     * encoder bugs in the decoder, without this it might not possible to
66 :     * automatically distinquish between a file which has been encoded with an
67 : edgomez 851 * old & buggy XVID from a file which has been encoded with a bugfree version
68 :     * see the infamous interlacing bug ...
69 :     *
70 :     * this MUST be increased if an encoder bug is fixed, increasing it too often
71 :     * doesnt hurt but not increasing it could cause difficulty for decoders in the
72 :     * future
73 : edgomez 608 */
74 : edgomez 1580 #define XVID_BS_VERSION 37
75 : edgomez 199
76 : edgomez 1382 /*****************************************************************************
77 :     * error codes
78 :     ****************************************************************************/
79 : edgomez 199
80 : edgomez 1382 /* all functions return values <0 indicate error */
81 : edgomez 199
82 : edgomez 1382 #define XVID_ERR_FAIL -1 /* general fault */
83 :     #define XVID_ERR_MEMORY -2 /* memory allocation error */
84 :     #define XVID_ERR_FORMAT -3 /* file format error */
85 :     #define XVID_ERR_VERSION -4 /* structure version not supported */
86 :     #define XVID_ERR_END -5 /* encoder only; end of stream reached */
87 : edgomez 199
88 :    
89 : edgomez 608
90 : edgomez 1382 /*****************************************************************************
91 :     * xvid_image_t
92 :     ****************************************************************************/
93 : edgomez 608
94 : edgomez 1382 /* colorspace values */
95 : edgomez 608
96 : edgomez 1382 #define XVID_CSP_PLANAR (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */
97 :     #define XVID_CSP_USER XVID_CSP_PLANAR
98 :     #define XVID_CSP_I420 (1<< 1) /* 4:2:0 planar */
99 :     #define XVID_CSP_YV12 (1<< 2) /* 4:2:0 planar */
100 :     #define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */
101 :     #define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */
102 :     #define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */
103 :     #define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */
104 :     #define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */
105 :     #define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */
106 :     #define XVID_CSP_ARGB (1<<15) /* 32-bit argb packed */
107 :     #define XVID_CSP_BGR (1<< 9) /* 24-bit bgr packed */
108 :     #define XVID_CSP_RGB555 (1<<10) /* 16-bit rgb555 packed */
109 :     #define XVID_CSP_RGB565 (1<<11) /* 16-bit rgb565 packed */
110 :     #define XVID_CSP_SLICE (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */
111 :     #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
112 :     #define XVID_CSP_NULL (1<<14) /* decoder only: dont output anything */
113 :     #define XVID_CSP_VFLIP (1<<31) /* vertical flip mask */
114 : edgomez 608
115 : edgomez 1382 /* xvid_image_t
116 :     for non-planar colorspaces use only plane[0] and stride[0]
117 :     four plane reserved for alpha*/
118 :     typedef struct {
119 :     int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
120 :     void * plane[4]; /* [in] image plane ptrs */
121 :     int stride[4]; /* [in] image stride; "bytes per row"*/
122 :     } xvid_image_t;
123 :    
124 :     /* video-object-sequence profiles */
125 :     #define XVID_PROFILE_S_L0 0x08 /* simple */
126 :     #define XVID_PROFILE_S_L1 0x01
127 :     #define XVID_PROFILE_S_L2 0x02
128 :     #define XVID_PROFILE_S_L3 0x03
129 :     #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
130 :     #define XVID_PROFILE_ARTS_L2 0x92
131 :     #define XVID_PROFILE_ARTS_L3 0x93
132 :     #define XVID_PROFILE_ARTS_L4 0x94
133 :     #define XVID_PROFILE_AS_L0 0xf0 /* advanced simple */
134 :     #define XVID_PROFILE_AS_L1 0xf1
135 :     #define XVID_PROFILE_AS_L2 0xf2
136 :     #define XVID_PROFILE_AS_L3 0xf3
137 :     #define XVID_PROFILE_AS_L4 0xf4
138 :    
139 :     /* aspect ratios */
140 :     #define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if supplied PAR is not a valid value */
141 :     #define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */
142 :     #define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */
143 :     #define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */
144 :     #define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */
145 :     #define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */
146 :    
147 :     /* frame type flags */
148 :     #define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */
149 :     #define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */
150 :     #define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */
151 :     #define XVID_TYPE_IVOP 1 /* intra frame */
152 :     #define XVID_TYPE_PVOP 2 /* predicted frame */
153 :     #define XVID_TYPE_BVOP 3 /* bidirectionally encoded */
154 :     #define XVID_TYPE_SVOP 4 /* predicted+sprite frame */
155 :    
156 :    
157 : edgomez 199 /*****************************************************************************
158 : edgomez 1382 * xvid_global()
159 : edgomez 199 ****************************************************************************/
160 :    
161 : edgomez 1382 /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
162 : edgomez 199
163 : edgomez 1382 #define XVID_CPU_FORCE (1<<31) /* force passed cpu flags */
164 :     #define XVID_CPU_ASM (1<< 7) /* native assembly */
165 : edgomez 851 /* ARCH_IS_IA32 */
166 : edgomez 1382 #define XVID_CPU_MMX (1<< 0) /* mmx : pentiumMMX,k6 */
167 :     #define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */
168 :     #define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */
169 :     #define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */
170 :     #define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */
171 :     #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
172 :     #define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */
173 :     /* ARCH_IS_PPC */
174 :     #define XVID_CPU_ALTIVEC (1<< 0) /* altivec */
175 : edgomez 868
176 :    
177 : edgomez 1382 #define XVID_DEBUG_ERROR (1<< 0)
178 :     #define XVID_DEBUG_STARTCODE (1<< 1)
179 :     #define XVID_DEBUG_HEADER (1<< 2)
180 :     #define XVID_DEBUG_TIMECODE (1<< 3)
181 :     #define XVID_DEBUG_MB (1<< 4)
182 :     #define XVID_DEBUG_COEFF (1<< 5)
183 :     #define XVID_DEBUG_MV (1<< 6)
184 :     #define XVID_DEBUG_RC (1<< 7)
185 :     #define XVID_DEBUG_DEBUG (1<<31)
186 : edgomez 199
187 : edgomez 1382 /* XVID_GBL_INIT param1 */
188 :     typedef struct {
189 :     int version;
190 :     unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */
191 :     int debug; /* [in:opt] debug level */
192 :     } xvid_gbl_init_t;
193 : Isibaar 209
194 : edgomez 199
195 : edgomez 1382 /* XVID_GBL_INFO param1 */
196 :     typedef struct {
197 :     int version;
198 :     int actual_version; /* [out] returns the actual xvidcore version */
199 :     const char * build; /* [out] if !null, points to description of this xvid core build */
200 :     unsigned int cpu_flags; /* [out] detected cpu features */
201 :     int num_threads; /* [out] detected number of cpus/threads */
202 :     } xvid_gbl_info_t;
203 : edgomez 199
204 : Isibaar 209
205 : edgomez 1382 /* XVID_GBL_CONVERT param1 */
206 :     typedef struct {
207 :     int version;
208 :     xvid_image_t input; /* [in] input image & colorspace */
209 :     xvid_image_t output; /* [in] output image & colorspace */
210 :     int width; /* [in] width */
211 :     int height; /* [in] height */
212 :     int interlacing; /* [in] interlacing */
213 :     } xvid_gbl_convert_t;
214 : edgomez 199
215 : edgomez 851
216 : edgomez 1382 #define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
217 :     #define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */
218 :     #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
219 : edgomez 199
220 : edgomez 1382 extern int xvid_global(void *handle, int opt, void *param1, void *param2);
221 : edgomez 199
222 :    
223 :     /*****************************************************************************
224 : edgomez 1382 * xvid_decore()
225 : edgomez 199 ****************************************************************************/
226 :    
227 : edgomez 1382 #define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */
228 :     #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
229 :     #define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */
230 : edgomez 199
231 : edgomez 1382 extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
232 :    
233 :     /* XVID_DEC_CREATE param 1
234 :     image width & height may be specified here when the dimensions are
235 :     known in advance. */
236 :     typedef struct {
237 :     int version;
238 :     int width; /* [in:opt] image width */
239 :     int height; /* [in:opt] image width */
240 :     void * handle; /* [out] decore context handle */
241 :     } xvid_dec_create_t;
242 :    
243 :    
244 :     /* XVID_DEC_DECODE param1 */
245 :     /* general flags */
246 :     #define XVID_LOWDELAY (1<<0) /* lowdelay mode */
247 :     #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
248 :     #define XVID_DEBLOCKY (1<<2) /* perform luma deblocking */
249 :     #define XVID_DEBLOCKUV (1<<3) /* perform chroma deblocking */
250 :     #define XVID_FILMEFFECT (1<<4) /* adds film grain */
251 :    
252 :     typedef struct {
253 :     int version;
254 :     int general; /* [in:opt] general flags */
255 :     void *bitstream; /* [in] bitstream (read from)*/
256 :     int length; /* [in] bitstream length */
257 :     xvid_image_t output; /* [in] output image (written to) */
258 :     } xvid_dec_frame_t;
259 :    
260 :    
261 :     /* XVID_DEC_DECODE param2 :: optional */
262 :     typedef struct
263 :     {
264 :     int version;
265 :    
266 :     int type; /* [out] output data type */
267 :     union {
268 :     struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
269 :     int general; /* [out] flags */
270 :     int time_base; /* [out] time base */
271 :     int time_increment; /* [out] time increment */
272 :    
273 :     /* XXX: external deblocking stuff */
274 :     int * qscale; /* [out] pointer to quantizer table */
275 :     int qscale_stride; /* [out] quantizer scale stride */
276 :    
277 :     } vop;
278 :     struct { /* XVID_TYPE_VOL */
279 :     int general; /* [out] flags */
280 :     int width; /* [out] width */
281 :     int height; /* [out] height */
282 :     int par; /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
283 :     int par_width; /* [out] aspect ratio width [1..255] */
284 :     int par_height; /* [out] aspect ratio height [1..255] */
285 :     } vol;
286 :     } data;
287 :     } xvid_dec_stats_t;
288 :    
289 :     #define XVID_ZONE_QUANT (1<<0)
290 :     #define XVID_ZONE_WEIGHT (1<<1)
291 :    
292 :     typedef struct
293 :     {
294 :     int frame;
295 :     int mode;
296 :     int increment;
297 :     int base;
298 :     } xvid_enc_zone_t;
299 :    
300 :    
301 :     /*----------------------------------------------------------------------------
302 :     * xvid_enc_stats_t structure
303 :     *
304 :     * Used in:
305 :     * - xvid_plg_data_t structure
306 :     * - optional parameter in xvid_encore() function
307 :     *
308 :     * .coding_type = XVID_TYPE_NOTHING if the stats are not given
309 :     *--------------------------------------------------------------------------*/
310 :    
311 :     typedef struct {
312 :     int version;
313 :    
314 :     /* encoding parameters */
315 :     int type; /* [out] coding type */
316 :     int quant; /* [out] frame quantizer */
317 :     int vol_flags; /* [out] vol flags (see above) */
318 :     int vop_flags; /* [out] vop flags (see above) */
319 :    
320 :     /* bitrate */
321 :     int length; /* [out] frame length */
322 :    
323 :     int hlength; /* [out] header length (bytes) */
324 :     int kblks; /* [out] number of blocks compressed as Intra */
325 :     int mblks; /* [out] number of blocks compressed as Inter */
326 :     int ublks; /* [out] number of blocks marked as not_coded */
327 :    
328 :     int sse_y; /* [out] Y plane's sse */
329 :     int sse_u; /* [out] U plane's sse */
330 :     int sse_v; /* [out] V plane's sse */
331 :     } xvid_enc_stats_t;
332 :    
333 : edgomez 199 /*****************************************************************************
334 : edgomez 1382 xvid plugin system -- internals
335 :    
336 :     xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
337 :     before encoding each frame xvidcore will call XVID_PLG_BEFORE
338 :     after encoding each frame xvidcore will call XVID_PLG_AFTER
339 :     xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
340 : edgomez 199 ****************************************************************************/
341 :    
342 :    
343 : edgomez 1382 #define XVID_PLG_CREATE (1<<0)
344 :     #define XVID_PLG_DESTROY (1<<1)
345 :     #define XVID_PLG_INFO (1<<2)
346 :     #define XVID_PLG_BEFORE (1<<3)
347 :     #define XVID_PLG_FRAME (1<<4)
348 :     #define XVID_PLG_AFTER (1<<5)
349 : edgomez 199
350 : edgomez 1382 /* xvid_plg_info_t.flags */
351 :     #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
352 :     #define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
353 :     #define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */
354 : edgomez 851
355 :    
356 : edgomez 1382 typedef struct
357 :     {
358 :     int version;
359 :     int flags; /* [in:opt] plugin flags */
360 :     } xvid_plg_info_t;
361 : edgomez 851
362 : edgomez 199
363 : edgomez 1382 typedef struct
364 :     {
365 :     int version;
366 : edgomez 199
367 : edgomez 1382 int num_zones; /* [out] */
368 :     xvid_enc_zone_t * zones; /* [out] */
369 : edgomez 199
370 : edgomez 1382 int width; /* [out] */
371 :     int height; /* [out] */
372 :     int mb_width; /* [out] */
373 :     int mb_height; /* [out] */
374 :     int fincr; /* [out] */
375 :     int fbase; /* [out] */
376 : edgomez 199
377 : edgomez 1382 void * param; /* [out] */
378 :     } xvid_plg_create_t;
379 : albeu 315
380 : edgomez 1382
381 :     typedef struct
382 :     {
383 :     int version;
384 :    
385 :     int num_frames; /* [out] total frame encoded */
386 :     } xvid_plg_destroy_t;
387 :    
388 :     typedef struct
389 :     {
390 :     int version;
391 :    
392 :     xvid_enc_zone_t * zone; /* [out] current zone */
393 :    
394 :     int width; /* [out] */
395 :     int height; /* [out] */
396 :     int mb_width; /* [out] */
397 :     int mb_height; /* [out] */
398 :     int fincr; /* [out] */
399 :     int fbase; /* [out] */
400 :    
401 :     int min_quant[3]; /* [out] */
402 :     int max_quant[3]; /* [out] */
403 :    
404 :     xvid_image_t reference; /* [out] -> [out] */
405 :     xvid_image_t current; /* [out] -> [in,out] */
406 :     xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */
407 :     int frame_num; /* [out] frame number */
408 :    
409 :     int type; /* [in,out] */
410 :     int quant; /* [in,out] */
411 :    
412 :     int * dquant; /* [in,out] pointer to diff quantizer table */
413 :     int dquant_stride; /* [in,out] diff quantizer stride */
414 :    
415 :     int vop_flags; /* [in,out] */
416 :     int vol_flags; /* [in,out] */
417 :     int motion_flags; /* [in,out] */
418 :    
419 :     /* Deprecated, use the stats field instead.
420 :     * Will disapear before 1.0 */
421 :     int length; /* [out] after: length of encoded frame */
422 :     int kblks; /* [out] number of blocks compressed as Intra */
423 :     int mblks; /* [out] number of blocks compressed as Inter */
424 :     int ublks; /* [out] number of blocks marked not_coded */
425 :     int sse_y; /* [out] Y plane's sse */
426 :     int sse_u; /* [out] U plane's sse */
427 :     int sse_v; /* [out] V plane's sse */
428 :     /* End of duplicated data, kept only for binary compatibility */
429 :    
430 :     int bquant_ratio; /* [in] */
431 :     int bquant_offset; /* [in] */
432 :    
433 :     xvid_enc_stats_t stats; /* [out] frame statistics */
434 :     } xvid_plg_data_t;
435 :    
436 : albeu 315 /*****************************************************************************
437 : edgomez 1382 xvid plugin system -- external
438 :    
439 :     the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
440 :     indicates the plugin function pointer and plugin-specific data.
441 :     xvidcore handles the rest. example:
442 :    
443 :     xvid_enc_create_t create;
444 :     xvid_enc_plugin_t plugins[2];
445 :    
446 :     plugins[0].func = xvid_psnr_func;
447 :     plugins[0].param = NULL;
448 :     plugins[1].func = xvid_cbr_func;
449 :     plugins[1].param = &cbr_data;
450 :    
451 :     create.num_plugins = 2;
452 :     create.plugins = plugins;
453 :    
454 : albeu 315 ****************************************************************************/
455 :    
456 : edgomez 1382 typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
457 : edgomez 199
458 : edgomez 1382 typedef struct
459 :     {
460 :     xvid_plugin_func * func;
461 :     void * param;
462 :     } xvid_enc_plugin_t;
463 : edgomez 199
464 :    
465 : edgomez 1382 extern xvid_plugin_func xvid_plugin_single; /* single-pass rate control */
466 :     extern xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */
467 :     extern xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */
468 :    
469 :     extern xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */
470 :    
471 :     extern xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */
472 :     extern xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */
473 :    
474 :    
475 :     /* single pass rate control
476 :     * CBR and Constant quantizer modes */
477 :     typedef struct
478 :     {
479 :     int version;
480 :    
481 :     int bitrate; /* [in] bits per second */
482 :     int reaction_delay_factor; /* [in] */
483 :     int averaging_period; /* [in] */
484 :     int buffer; /* [in] */
485 :     } xvid_plugin_single_t;
486 :    
487 :    
488 :     typedef struct {
489 :     int version;
490 :    
491 :     char * filename;
492 :     } xvid_plugin_2pass1_t;
493 :    
494 :    
495 :     #define XVID_PAYBACK_BIAS 0 /* payback with bias */
496 :     #define XVID_PAYBACK_PROP 1 /* payback proportionally */
497 :    
498 :     typedef struct {
499 :     int version;
500 :    
501 :     int bitrate; /* [in] bits per second */
502 :     char * filename; /* [in] first pass stats filename */
503 :    
504 :     int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */
505 :     int curve_compression_high; /* [in] percentage of compression performed on the high part of the curve (above average) */
506 :     int curve_compression_low; /* [in] percentage of compression performed on the low part of the curve (below average) */
507 :     int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
508 :     int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
509 :     int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
510 :    
511 :     int kfreduction; /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
512 :     int kfthreshold; /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
513 :     * is substracted from its bit allocation. The reduction is computed as multiples of
514 :     * kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
515 :     * 0 for 1<distance<kfthreshold */
516 :    
517 :     int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
518 :     }xvid_plugin_2pass2_t;
519 :    
520 : edgomez 851 /*****************************************************************************
521 : edgomez 1382 * ENCODER API
522 : edgomez 851 ****************************************************************************/
523 : edgomez 199
524 : edgomez 1382 /*----------------------------------------------------------------------------
525 :     * Encoder operations
526 :     *--------------------------------------------------------------------------*/
527 : edgomez 199
528 : edgomez 1382 #define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */
529 :     #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
530 :     #define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes
531 :     * 0 means this frame should not be written (ie. encoder lag) */
532 : edgomez 199
533 :    
534 : edgomez 1382 /*----------------------------------------------------------------------------
535 :     * Encoder entry point
536 :     *--------------------------------------------------------------------------*/
537 : edgomez 199
538 : edgomez 1382 extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
539 : edgomez 199
540 : edgomez 1382 /* Quick API reference
541 :     *
542 :     * XVID_ENC_CREATE operation
543 :     * - handle: ignored
544 :     * - opt: XVID_ENC_CREATE
545 :     * - param1: address of a xvid_enc_create_t structure
546 :     * - param2: ignored
547 :     *
548 :     * XVID_ENC_ENCODE operation
549 :     * - handle: an instance returned by a CREATE op
550 :     * - opt: XVID_ENC_ENCODE
551 :     * - param1: address of a xvid_enc_frame_t structure
552 :     * - param2: address of a xvid_enc_stats_t structure (optional)
553 :     * its return value is asynchronous to what is written to the buffer
554 :     * depending on the delay introduced by bvop use. It's display
555 :     * ordered.
556 :     *
557 :     * XVID_ENC_DESTROY operation
558 :     * - handle: an instance returned by a CREATE op
559 :     * - opt: XVID_ENC_DESTROY
560 :     * - param1: ignored
561 :     * - param2: ignored
562 :     */
563 : edgomez 199
564 :    
565 : edgomez 1382 /*----------------------------------------------------------------------------
566 :     * "Global" flags
567 :     *
568 :     * These flags are used for xvid_enc_create_t->global field during instance
569 :     * creation (operation XVID_ENC_CREATE)
570 :     *--------------------------------------------------------------------------*/
571 : edgomez 199
572 : edgomez 1382 #define XVID_GLOBAL_PACKED (1<<0) /* packed bitstream */
573 :     #define XVID_GLOBAL_CLOSED_GOP (1<<1) /* closed_gop: was DX50BVOP dx50 bvop compatibility */
574 :     #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
575 :     #if 0
576 :     #define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
577 :     #define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
578 :     #endif
579 : edgomez 199
580 : edgomez 853
581 : edgomez 1382 /*----------------------------------------------------------------------------
582 :     * "VOL" flags
583 :     *
584 :     * These flags are used for xvid_enc_frame_t->vol_flags field during frame
585 :     * encoding (operation XVID_ENC_ENCODE)
586 :     *--------------------------------------------------------------------------*/
587 : edgomez 199
588 : edgomez 1382 #define XVID_VOL_MPEGQUANT (1<<0) /* enable MPEG type quantization */
589 :     #define XVID_VOL_EXTRASTATS (1<<1) /* enable plane sse stats */
590 :     #define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
591 :     #define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */
592 :     #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
593 :     #define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */
594 : chl 352
595 : edgomez 199
596 : edgomez 1382 /*----------------------------------------------------------------------------
597 :     * "VOP" flags
598 :     *
599 :     * These flags are used for xvid_enc_frame_t->vop_flags field during frame
600 :     * encoding (operation XVID_ENC_ENCODE)
601 :     *--------------------------------------------------------------------------*/
602 : edgomez 199
603 : edgomez 1382 /* Always valid */
604 :     #define XVID_VOP_DEBUG (1<< 0) /* print debug messages in frames */
605 :     #define XVID_VOP_HALFPEL (1<< 1) /* use halfpel interpolation */
606 :     #define XVID_VOP_INTER4V (1<< 2) /* use 4 motion vectors per MB */
607 :     #define XVID_VOP_TRELLISQUANT (1<< 3) /* use trellis based R-D "optimal" quantization */
608 :     #define XVID_VOP_CHROMAOPT (1<< 4) /* enable chroma optimization pre-filter */
609 :     #define XVID_VOP_CARTOON (1<< 5) /* use 'cartoon mode' */
610 :     #define XVID_VOP_GREYSCALE (1<< 6) /* enable greyscale only mode (even for color input material chroma is ignored) */
611 :     #define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */
612 :     #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */
613 :     #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
614 : edgomez 199
615 : edgomez 1382 /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
616 :     #define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */
617 :     #define XVID_VOP_ALTERNATESCAN (1<<10) /* set alternate vertical scan flag */
618 : edgomez 608
619 : edgomez 1382 /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
620 :     #define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */
621 : edgomez 851
622 :    
623 : edgomez 1382 /*----------------------------------------------------------------------------
624 :     * "Motion" flags
625 :     *
626 :     * These flags are used for xvid_enc_frame_t->motion field during frame
627 :     * encoding (operation XVID_ENC_ENCODE)
628 :     *--------------------------------------------------------------------------*/
629 : edgomez 851
630 : edgomez 1382 /* Motion Estimation Search Patterns */
631 :     #define XVID_ME_ADVANCEDDIAMOND16 (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
632 :     #define XVID_ME_ADVANCEDDIAMOND8 (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
633 :     #define XVID_ME_USESQUARES16 (1<< 2) /* use squares instead of diamonds as search pattern */
634 :     #define XVID_ME_USESQUARES8 (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
635 : edgomez 851
636 : edgomez 1382 /* SAD operator based flags */
637 :     #define XVID_ME_HALFPELREFINE16 (1<< 4)
638 :     #define XVID_ME_HALFPELREFINE8 (1<< 6)
639 :     #define XVID_ME_QUARTERPELREFINE16 (1<< 7)
640 :     #define XVID_ME_QUARTERPELREFINE8 (1<< 8)
641 :     #define XVID_ME_GME_REFINE (1<< 9)
642 :     #define XVID_ME_EXTSEARCH16 (1<<10) /* extend PMV by more searches */
643 :     #define XVID_ME_EXTSEARCH8 (1<<11) /* use diamond/square for extended 8x8 search */
644 :     #define XVID_ME_CHROMA_PVOP (1<<12) /* also use chroma for P_VOP/S_VOP ME */
645 :     #define XVID_ME_CHROMA_BVOP (1<<13) /* also use chroma for B_VOP ME */
646 :     #define XVID_ME_FASTREFINE16 (1<<25) /* use low-complexity refinement functions */
647 :     #define XVID_ME_FASTREFINE8 (1<<29) /* low-complexity 8x8 sub-block refinement */
648 : edgomez 851
649 : edgomez 1382 /* Rate Distortion based flags
650 :     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
651 :     #define XVID_ME_HALFPELREFINE16_RD (1<<14) /* perform RD-based halfpel refinement */
652 :     #define XVID_ME_HALFPELREFINE8_RD (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
653 :     #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
654 :     #define XVID_ME_QUARTERPELREFINE8_RD (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
655 :     #define XVID_ME_EXTSEARCH_RD (1<<18) /* perform RD-based search using square pattern enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
656 :     #define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */
657 : edgomez 851
658 : edgomez 1382 /* Other */
659 :     #define XVID_ME_DETECT_STATIC_MOTION (1<<24) /* speed-up ME by detecting stationary scenes */
660 :     #define XVID_ME_SKIP_DELTASEARCH (1<<26) /* speed-up by skipping b-frame delta search */
661 :     #define XVID_ME_FAST_MODEINTERPOLATE (1<<27) /* speed-up by partly skipping interpolate mode */
662 :     #define XVID_ME_BFRAME_EARLYSTOP (1<<28) /* speed-up by early exiting b-search */
663 : edgomez 851
664 : edgomez 1382 /* Unused */
665 :     #define XVID_ME_UNRESTRICTED16 (1<<20) /* unrestricted ME, not implemented */
666 :     #define XVID_ME_OVERLAPPING16 (1<<21) /* overlapping ME, not implemented */
667 :     #define XVID_ME_UNRESTRICTED8 (1<<22) /* unrestricted ME, not implemented */
668 :     #define XVID_ME_OVERLAPPING8 (1<<23) /* overlapping ME, not implemented */
669 : edgomez 851
670 :    
671 : edgomez 1382 /*----------------------------------------------------------------------------
672 :     * xvid_enc_create_t structure definition
673 :     *
674 :     * This structure is passed as param1 during an instance creation (operation
675 :     * XVID_ENC_CREATE)
676 :     *--------------------------------------------------------------------------*/
677 : edgomez 851
678 : edgomez 1382 typedef struct {
679 :     int version;
680 : edgomez 851
681 : edgomez 1382 int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */
682 :     int width; /* [in] frame dimensions; width, pixel units */
683 :     int height; /* [in] frame dimensions; height, pixel units */
684 : edgomez 851
685 : edgomez 1382 int num_zones; /* [in:opt] number of bitrate zones */
686 :     xvid_enc_zone_t * zones; /* ^^ zone array */
687 : edgomez 851
688 : edgomez 1382 int num_plugins; /* [in:opt] number of plugins */
689 :     xvid_enc_plugin_t * plugins; /* ^^ plugin array */
690 : edgomez 851
691 : edgomez 1382 int num_threads; /* [in:opt] number of threads */
692 :     int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */
693 : edgomez 851
694 : edgomez 1382 int global; /* [in:opt] global flags; controls encoding behavior */
695 : edgomez 851
696 : edgomez 1382 /* --- vol-based stuff; included here for convenience */
697 :     int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */
698 :     int fbase; /* [in] framerate base frame_duration = fincr/fbase seconds*/
699 :     /* ---------------------------------------------- */
700 : edgomez 199
701 : edgomez 1382 /* --- vop-based; included here for convenience */
702 :     int max_key_interval; /* [in:opt] the maximum interval between key frames */
703 : edgomez 199
704 : edgomez 1382 int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */
705 : edgomez 199
706 : edgomez 1382 int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
707 :     int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
708 : edgomez 199
709 : edgomez 1382 int min_quant[3]; /* [in:opt] */
710 :     int max_quant[3]; /* [in:opt] */
711 :     /* ---------------------------------------------- */
712 : edgomez 199
713 : edgomez 1382 void *handle; /* [out] encoder instance handle */
714 :     } xvid_enc_create_t;
715 : edgomez 199
716 :    
717 : edgomez 1382 /*----------------------------------------------------------------------------
718 :     * xvid_enc_frame_t structure definition
719 :     *
720 :     * This structure is passed as param1 during a frame encoding (operation
721 :     * XVID_ENC_ENCODE)
722 :     *--------------------------------------------------------------------------*/
723 : edgomez 199
724 : edgomez 1382 /* out value for the frame structure->type field
725 :     * unlike stats output in param2, this field is not asynchronous and tells
726 :     * the client app, if the frame written into the stream buffer is an ivop
727 :     * usually used for indexing purpose in the container */
728 :     #define XVID_KEYFRAME (1<<1)
729 : edgomez 851
730 : edgomez 1382 /* The structure */
731 :     typedef struct {
732 :     int version;
733 : edgomez 851
734 : edgomez 1382 /* VOL related stuff
735 :     * unless XVID_FORCEVOL is set, the encoder will not react to any changes
736 :     * here until the next VOL (keyframe). */
737 : edgomez 851
738 : edgomez 1382 int vol_flags; /* [in] vol flags */
739 :     unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
740 :     unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
741 : edgomez 199
742 : edgomez 1382 int par; /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */
743 :     int par_width; /* [in:opt] aspect ratio width */
744 :     int par_height; /* [in:opt] aspect ratio height */
745 : edgomez 199
746 : edgomez 1382 /* Other fields that can change on a frame base */
747 : edgomez 199
748 : edgomez 1382 int fincr; /* [in:opt] framerate increment, for variable framerate only */
749 :     int vop_flags; /* [in] (general)vop-based flags */
750 :     int motion; /* [in] ME options */
751 : edgomez 199
752 : edgomez 1382 xvid_image_t input; /* [in] input image (read from) */
753 : edgomez 199
754 : edgomez 1382 int type; /* [in:opt] coding type */
755 :     int quant; /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
756 :     int bframe_threshold;
757 : edgomez 199
758 : edgomez 1382 void *bitstream; /* [in:opt] bitstream ptr (written to)*/
759 :     int length; /* [in:opt] bitstream length (bytes) */
760 : edgomez 199
761 : edgomez 1382 int out_flags; /* [out] bitstream output flags */
762 :     } xvid_enc_frame_t;
763 : edgomez 199
764 :     #ifdef __cplusplus
765 :     }
766 :     #endif
767 :    
768 :     #endif

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