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

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