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

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