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