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