[svn] / branches / dev-api-4 / xvidcore / src / xvid.h Repository:
ViewVC logotype

Annotation of /branches/dev-api-4/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1290 - (view) (download)

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

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