[svn] / trunk / xvidcore / src / xvid.h Repository:
ViewVC logotype

Annotation of /trunk/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log


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

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