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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

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