[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 2177 - (view) (download)

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

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