3 |
* XVID MPEG-4 VIDEO CODEC |
* XVID MPEG-4 VIDEO CODEC |
4 |
* - XviD Main header file - |
* - XviD Main header file - |
5 |
* |
* |
6 |
|
* 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 |
10 |
* the Free Software Foundation ; either version 2 of the License, or |
* the Free Software Foundation ; either version 2 of the License, or |
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 |
* |
* |
|
*****************************************************************************/ |
|
|
/***************************************************************************** |
|
|
* |
|
|
* History |
|
|
* |
|
|
* - 2002/06/13 Added legal header, ANSI C comment style (only for this header |
|
|
* as it can be included in a ANSI C project). |
|
|
* |
|
|
* ToDo ? : when BFRAMES is defined, the API_VERSION should not |
|
|
* be the same (3.0 ?) |
|
|
* |
|
22 |
* $Id$ |
* $Id$ |
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 |
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,-127,0) |
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 "0009" |
#define XVID_BS_VERSION "0020" |
|
|
|
|
|
|
|
/* 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] */ |
|
|
|
|
|
|
|
|
|
|
|
#define XVID_CSP_NULL 9999 |
|
|
|
|
|
#define XVID_CSP_VFLIP 0x80000000 // flip mask |
|
77 |
|
|
78 |
|
|
79 |
/***************************************************************************** |
/***************************************************************************** |
80 |
* Initialization constants |
* error codes |
81 |
****************************************************************************/ |
****************************************************************************/ |
82 |
|
|
83 |
/* CPU flags for XVID_INIT_PARAM.cpu_flags */ |
/* all functions return values <0 indicate error */ |
84 |
#define XVID_CPU_FORCE 0x80000000 |
|
85 |
#define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */ |
#define XVID_ERR_FAIL -1 /* general fault */ |
86 |
|
#define XVID_ERR_MEMORY -2 /* memory allocation error */ |
87 |
#define XVID_CPU_ASM 0x00000080 /* native assembly */ |
#define XVID_ERR_FORMAT -3 /* file format error */ |
88 |
/* ARCH_X86 */ |
#define XVID_ERR_VERSION -4 /* structure version not supported */ |
89 |
#define XVID_CPU_MMX 0x00000001 /* mmx: pentiumMMX,k6 */ |
#define XVID_ERR_END -5 /* encoder only; end of stream reached */ |
|
#define XVID_CPU_MMXEXT 0x00000002 /* mmxx-ext: pentium2,athlon */ |
|
|
#define XVID_CPU_SSE 0x00000004 /* sse: pentium3,athlonXP */ |
|
|
#define XVID_CPU_SSE2 0x00000008 /* sse2: pentium4,athlon64 */ |
|
|
#define XVID_CPU_3DNOW 0x00000010 /* 3dnow: k6-2 */ |
|
|
#define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ |
|
|
#define XVID_CPU_TSC 0x00000040 /* timestamp counter */ |
|
|
/* ARCH_IA64 */ |
|
|
#define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */ |
|
|
/* ARCH_PPC */ |
|
|
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
|
90 |
|
|
91 |
|
|
|
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 |
|
92 |
|
|
93 |
/***************************************************************************** |
/***************************************************************************** |
94 |
* Initialization structures |
* xvid_image_t |
95 |
****************************************************************************/ |
****************************************************************************/ |
96 |
|
|
97 |
typedef struct |
/* colorspace values */ |
98 |
{ |
|
99 |
int cpu_flags; |
#define XVID_CSP_USER (1<< 0) /* 4:2:0 planar */ |
100 |
int api_version; |
#define XVID_CSP_I420 (1<< 1) /* 4:2:0 packed(planar win32) */ |
101 |
int core_build; |
#define XVID_CSP_YV12 (1<< 2) /* 4:2:0 packed(planar win32) */ |
102 |
} |
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
103 |
XVID_INIT_PARAM; |
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
104 |
|
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
105 |
|
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
106 |
|
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
107 |
|
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
108 |
|
#define XVID_CSP_BGR (1<< 9) /* 24-bit bgr packed */ |
109 |
|
#define XVID_CSP_RGB555 (1<<10) /* 16-bit rgb555 packed */ |
110 |
|
#define XVID_CSP_RGB565 (1<<11) /* 16-bit rgb565 packed */ |
111 |
|
#define XVID_CSP_SLICE (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */ |
112 |
|
#define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */ |
113 |
|
#define XVID_CSP_NULL (1<<14) /* decoder only: dont output anything */ |
114 |
|
#define XVID_CSP_VFLIP (1<<31) /* vertical flip mask */ |
115 |
|
|
116 |
|
/* xvid_image_t |
117 |
|
for non-planar colorspaces use only plane[0] and stride[0] |
118 |
|
four plane reserved for alpha*/ |
119 |
|
typedef struct { |
120 |
|
int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */ |
121 |
|
void * plane[4]; /* [in] image plane ptrs */ |
122 |
|
int stride[4]; /* [in] image stride; "bytes per row"*/ |
123 |
|
} xvid_image_t; |
124 |
|
|
125 |
|
/* video-object-sequence profiles */ |
126 |
|
#define XVID_PROFILE_S_L0 0x08 /* simple */ |
127 |
|
#define XVID_PROFILE_S_L1 0x01 |
128 |
|
#define XVID_PROFILE_S_L2 0x02 |
129 |
|
#define XVID_PROFILE_S_L3 0x03 |
130 |
|
#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 */ |
141 |
|
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if AR is not precised (ie: ==0) */ |
142 |
|
#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) */ |
144 |
|
#define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ |
145 |
|
#define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */ |
146 |
|
#define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */ |
147 |
|
|
148 |
|
/* frame type flags */ |
149 |
|
#define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */ |
150 |
|
#define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */ |
151 |
|
#define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */ |
152 |
|
#define XVID_TYPE_IVOP 1 /* intra frame */ |
153 |
|
#define XVID_TYPE_PVOP 2 /* predicted frame */ |
154 |
|
#define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ |
155 |
|
#define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ |
156 |
|
|
|
typedef struct |
|
|
{ |
|
|
XVID_IMAGE input; |
|
|
XVID_IMAGE output; |
|
|
int width; |
|
|
int height; |
|
|
int interlacing; |
|
|
} XVID_INIT_CONVERTINFO; |
|
157 |
|
|
158 |
/***************************************************************************** |
/***************************************************************************** |
159 |
* Initialization entry point |
* xvid_global() |
160 |
****************************************************************************/ |
****************************************************************************/ |
161 |
|
|
162 |
int xvid_init(void *handle, |
/* cpu_flags definitions */ |
|
int opt, |
|
|
void *param1, |
|
|
void *param2); |
|
163 |
|
|
164 |
|
#define XVID_CPU_FORCE (1<<31) /* force passed cpu flags */ |
165 |
|
#define XVID_CPU_ASM (1<< 7) /* native assembly */ |
166 |
|
/* ARCH_IS_IA32 */ |
167 |
|
#define XVID_CPU_MMX (1<< 0) /* mmx : pentiumMMX,k6 */ |
168 |
|
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
169 |
|
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
170 |
|
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
171 |
|
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
172 |
|
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
173 |
|
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
174 |
|
/* ARCH_IS_PPC */ |
175 |
|
#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 */ |
189 |
|
typedef struct { |
190 |
|
int version; |
191 |
|
unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */ |
192 |
|
int debug; /* [in:opt] debug level */ |
193 |
|
} xvid_gbl_init_t; |
194 |
|
|
195 |
|
|
196 |
|
/* XVID_GBL_INFO param1 */ |
197 |
|
typedef struct { |
198 |
|
int version; |
199 |
|
int actual_version; /* [out] returns the actual xvidcore version */ |
200 |
|
const char * build; /* [out] if !null, points to description of this xvid core build */ |
201 |
|
unsigned int cpu_flags; /* [out] detected cpu features */ |
202 |
|
int num_threads; /* [out] detected number of cpus/threads */ |
203 |
|
} xvid_gbl_info_t; |
204 |
|
|
205 |
|
|
206 |
|
/* XVID_GBL_CONVERT param1 */ |
207 |
|
typedef struct { |
208 |
|
int version; |
209 |
|
xvid_image_t input; /* [in] input image & colorspace */ |
210 |
|
xvid_image_t output; /* [in] output image & colorspace */ |
211 |
|
int width; /* [in] width */ |
212 |
|
int height; /* [in] height */ |
213 |
|
int interlacing; /* [in] interlacing */ |
214 |
|
} xvid_gbl_convert_t; |
215 |
|
|
216 |
|
|
217 |
|
#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 */ |
219 |
|
#define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ |
220 |
|
#define XVID_GBL_TEST 3 /* testing.. */ |
221 |
|
|
222 |
/***************************************************************************** |
int xvid_global(void *handle, int opt, void *param1, void *param2); |
|
* Decoder constants |
|
|
****************************************************************************/ |
|
223 |
|
|
|
/* Flags for XVID_DEC_FRAME.general */ |
|
|
#define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. video-for-windows) */ |
|
|
#define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */ |
|
|
#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 |
|
224 |
|
|
225 |
/***************************************************************************** |
/***************************************************************************** |
226 |
* Decoder structures |
* xvid_decore() |
227 |
****************************************************************************/ |
****************************************************************************/ |
228 |
|
|
229 |
typedef struct |
#define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
230 |
{ |
#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ |
231 |
int width; |
#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ |
232 |
int height; |
|
233 |
void *handle; |
int xvid_decore(void *handle, int opt, void *param1, void *param2); |
234 |
} |
|
235 |
XVID_DEC_PARAM; |
/* XVID_DEC_CREATE param 1 |
236 |
|
image width & height may be specified here when the dimensions are |
237 |
|
known in advance. */ |
238 |
#define XVID_DEC_VOP 0 |
typedef struct { |
239 |
#define XVID_DEC_VOL 1 |
int version; |
240 |
#define XVID_DEC_NOTHING 2 /* nothing was decoded */ |
int width; /* [in:opt] image width */ |
241 |
|
int height; /* [in:opt] image width */ |
242 |
typedef struct |
void * handle; /* [out] decore context handle */ |
243 |
{ |
} xvid_dec_create_t; |
244 |
int notify; /* [out] output 'mode' */ |
|
245 |
union |
|
246 |
{ |
/* XVID_DEC_DECODE param1 */ |
247 |
struct /* XVID_DEC_VOP */ |
/* general flags */ |
248 |
{ |
#define XVID_LOWDELAY (1<<0) /* lowdelay mode */ |
249 |
|
#define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ |
250 |
|
|
251 |
|
typedef struct { |
252 |
|
int version; |
253 |
|
int general; /* [in:opt] general flags */ |
254 |
|
void *bitstream; /* [in] bitstream (read from)*/ |
255 |
|
int length; /* [in] bitstream length */ |
256 |
|
xvid_image_t output; /* [in] output image (written to) */ |
257 |
|
} xvid_dec_frame_t; |
258 |
|
|
259 |
|
|
260 |
|
/* XVID_DEC_DECODE param2 :: optional */ |
261 |
|
typedef struct |
262 |
|
{ |
263 |
|
int version; |
264 |
|
|
265 |
|
int type; /* [out] output data type */ |
266 |
|
union { |
267 |
|
struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ |
268 |
|
int general; /* [out] flags */ |
269 |
int time_base; /* [out] time base */ |
int time_base; /* [out] time base */ |
270 |
int time_increment; /* [out] time increment */ |
int time_increment; /* [out] time increment */ |
271 |
|
|
272 |
|
/* XXX: external deblocking stuff */ |
273 |
|
int * qscale; /* [out] pointer to quantizer table */ |
274 |
|
int qscale_stride; /* [out] quantizer scale stride */ |
275 |
|
|
276 |
} vop; |
} vop; |
277 |
struct /* XVID_DEC_VOL */ |
struct { /* XVID_TYPE_VOL */ |
278 |
{ |
int general; /* [out] flags */ |
|
int general; /* [out] flags: eg. frames are interlaced */ |
|
279 |
int width; /* [out] width */ |
int width; /* [out] width */ |
280 |
int height; /* [out] height */ |
int height; /* [out] height */ |
281 |
int aspect_ratio; /* [out] aspect ratio */ |
int par; /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
282 |
int par_width; /* [out] aspect ratio width */ |
int par_width; /* [out] aspect ratio width */ |
283 |
int par_height; /* [out] aspect ratio height */ |
int par_height; /* [out] aspect ratio height */ |
284 |
} vol; |
} vol; |
285 |
} data; |
} data; |
286 |
} XVID_DEC_STATS; |
} xvid_dec_stats_t; |
287 |
|
|
288 |
|
|
|
typedef struct |
|
|
{ |
|
|
int general; |
|
|
void *bitstream; |
|
|
int length; |
|
|
|
|
|
void *image; |
|
|
int stride; |
|
|
int colorspace; |
|
|
} |
|
|
XVID_DEC_FRAME; |
|
289 |
|
|
290 |
|
#define XVID_ZONE_QUANT (1<<0) |
291 |
|
#define XVID_ZONE_WEIGHT (1<<1) |
292 |
|
|
|
// This struct is used for per slice rendering |
|
293 |
typedef struct |
typedef struct |
294 |
{ |
{ |
295 |
void *y,*u,*v; |
int frame; |
296 |
int stride_y, stride_u,stride_v; |
int mode; |
297 |
} XVID_DEC_PICTURE; |
int increment; |
298 |
|
int base; |
299 |
|
} xvid_enc_zone_t; |
|
/***************************************************************************** |
|
|
* Decoder entry point |
|
|
****************************************************************************/ |
|
300 |
|
|
|
/* decoder options */ |
|
|
#define XVID_DEC_DECODE 0 |
|
|
#define XVID_DEC_CREATE 1 |
|
|
#define XVID_DEC_DESTROY 2 |
|
|
|
|
|
int xvid_decore(void *handle, |
|
|
int opt, |
|
|
void *param1, |
|
|
void *param2); |
|
301 |
|
|
302 |
|
|
303 |
/***************************************************************************** |
/***************************************************************************** |
304 |
* Encoder constants |
xvid plugin system -- internals |
305 |
|
|
306 |
|
xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE |
307 |
|
before encoding each frame xvidcore will call XVID_PLG_BEFORE |
308 |
|
after encoding each frame xvidcore will call XVID_PLG_AFTER |
309 |
|
xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY |
310 |
****************************************************************************/ |
****************************************************************************/ |
311 |
|
|
|
/* 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 */ |
|
|
|
|
|
/* Flags for XVID_ENC_FRAME.general */ |
|
|
#define XVID_VALID_FLAGS 0x80000000 |
|
|
|
|
|
#define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */ |
|
|
#define XVID_H263QUANT 0x00000010 |
|
|
#define XVID_MPEGQUANT 0x00000020 |
|
|
#define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */ |
|
|
#define XVID_QUARTERPEL 0x02000000 |
|
|
#define XVID_ADAPTIVEQUANT 0x00000080 |
|
|
#define XVID_LUMIMASKING 0x00000100 |
|
|
#define XVID_LATEINTRA 0x00000200 |
|
|
|
|
|
#define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */ |
|
|
#define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */ |
|
|
#define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */ |
|
|
|
|
|
#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) */ |
|
|
|
|
|
#define XVID_INTER4V 0x00008000 |
|
|
|
|
|
#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 |
|
|
|
|
|
#define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */ |
|
|
#define XVID_GRAYSCALE 0x01000000 /* color input material chroma is ignored) */ |
|
|
|
|
|
#define XVID_GMC 0x10000000 |
|
|
#define XVID_GMC_TRANSLATIONAL 0x20000000 |
|
|
|
|
|
#define XVID_REDUCED 0x04000000 /* reduced resolution vop */ |
|
|
|
|
|
/* Flags for XVID_ENC_FRAME.motion */ |
|
|
#define PMV_ADVANCEDDIAMOND8 0x00004000 |
|
|
#define PMV_ADVANCEDDIAMOND16 0x00008000 |
|
|
|
|
|
#define PMV_HALFPELDIAMOND16 0x00010000 |
|
|
#define PMV_HALFPELREFINE16 0x00020000 |
|
|
#define PMV_QUARTERPELREFINE16 0x00040000 |
|
|
#define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */ |
|
|
|
|
|
#define PMV_CHROMA16 0x00100000 /* also use chroma for MB-ME */ |
|
|
#define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ |
|
|
#define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ |
|
|
#define PMV_USESQUARES16 0x00800000 /* use squares instead of diamonds as search pattern */ |
|
|
|
|
|
#define PMV_HALFPELDIAMOND8 0x01000000 |
|
|
#define PMV_HALFPELREFINE8 0x02000000 |
|
|
#define PMV_QUARTERPELREFINE8 0x04000000 |
|
|
#define PMV_EXTSEARCH8 0x08000000 /* extend PMV by more searches */ |
|
|
|
|
|
#define PMV_CHROMA8 0x10000000 /* also use chroma for B-ME */ |
|
|
#define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */ |
|
|
#define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */ |
|
|
#define PMV_USESQUARES8 0x80000000 |
|
|
|
|
|
|
|
|
/* note: old and deprecated */ |
|
|
|
|
|
/* only for compatability with old encoders */ |
|
|
|
|
|
#define PMV_EARLYSTOP16 0x00 |
|
|
#define PMV_EARLYSTOP8 0x00 |
|
|
#define PMV_QUICKSTOP16 0x00 |
|
|
#define PMV_QUICKSTOP8 0x00 |
|
312 |
|
|
313 |
#define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_COLOUR[16/8] */ |
#define XVID_PLG_CREATE (1<<0) |
314 |
|
#define XVID_PLG_DESTROY (1<<1) |
315 |
|
#define XVID_PLG_INFO (1<<2) |
316 |
|
#define XVID_PLG_BEFORE (1<<3) |
317 |
|
#define XVID_PLG_AFTER (1<<4) |
318 |
|
|
319 |
|
/* xvid_plg_info_t.flags */ |
320 |
|
#define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
321 |
|
#define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ |
322 |
|
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
323 |
|
|
|
/***************************************************************************** |
|
|
* Encoder structures |
|
|
****************************************************************************/ |
|
324 |
|
|
325 |
typedef struct |
typedef struct |
326 |
{ |
{ |
327 |
int width, height; |
int version; |
328 |
int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */ |
int flags; /* [in:opt] plugin flags */ |
329 |
int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */ |
} xvid_plg_info_t; |
|
int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */ |
|
|
int rc_averaging_period; /* as above */ |
|
|
int rc_buffer; /* as above */ |
|
|
int max_quantizer; /* the upper limit of the quantizer */ |
|
|
int min_quantizer; /* the lower limit of the quantizer */ |
|
|
int max_key_interval; /* the maximum interval between key frames */ |
|
|
#ifdef _SMP |
|
|
int num_threads; /* number of threads */ |
|
|
#endif |
|
|
int global; /* global/debug options */ |
|
|
int max_bframes; /* max sequential bframes (0=disable bframes) */ |
|
|
int bquant_ratio; /* bframe quantizer multipier (percentage). |
|
|
* used only when bquant < 1 |
|
|
* eg. 200 = x2 multiplier |
|
|
* quant = ((past_quant + future_quant) * bquant_ratio)/200 |
|
|
*/ |
|
|
int bquant_offset; /* bquant += bquant_offset */ |
|
|
int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */ |
|
|
void *handle; /* [out] encoder instance handle */ |
|
|
} |
|
|
XVID_ENC_PARAM; |
|
330 |
|
|
|
typedef struct |
|
|
{ |
|
|
int x; |
|
|
int y; |
|
|
} |
|
|
VECTOR; |
|
331 |
|
|
332 |
typedef struct |
typedef struct |
333 |
{ |
{ |
334 |
int mode; /* macroblock mode */ |
int version; |
335 |
VECTOR mvs[4]; |
|
336 |
} |
int num_zones; /* [out] */ |
337 |
MVBLOCKHINT; |
xvid_enc_zone_t * zones; /* [out] */ |
338 |
|
|
339 |
|
int width; /* [out] */ |
340 |
|
int height; /* [out] */ |
341 |
|
int mb_width; /* [out] */ |
342 |
|
int mb_height; /* [out] */ |
343 |
|
int fincr; /* [out] */ |
344 |
|
int fbase; /* [out] */ |
345 |
|
|
346 |
|
void * param; /* [out] */ |
347 |
|
} xvid_plg_create_t; |
348 |
|
|
349 |
|
|
350 |
typedef struct |
typedef struct |
351 |
{ |
{ |
352 |
int intra; /* frame intra choice */ |
int version; |
353 |
int fcode; /* frame fcode */ |
|
354 |
MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ |
int num_frames; /* [out] total frame encoded */ |
355 |
} |
} xvid_plg_destroy_t; |
356 |
MVFRAMEHINT; |
|
357 |
|
|
358 |
typedef struct |
typedef struct |
359 |
{ |
{ |
360 |
int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ |
int version; |
361 |
|
|
362 |
MVFRAMEHINT mvhint; |
xvid_enc_zone_t * zone; /* [out] current zone */ |
363 |
void *hintstream; /* compressed hint buffer */ |
|
364 |
int hintlength; /* length of buffer (bytes) */ |
int width; /* [out] */ |
365 |
} |
int height; /* [out] */ |
366 |
HINTINFO; |
int mb_width; /* [out] */ |
367 |
|
int mb_height; /* [out] */ |
368 |
|
int fincr; /* [out] */ |
369 |
|
int fbase; /* [out] */ |
370 |
|
|
371 |
|
int min_quant[3]; /* [out] */ |
372 |
|
int max_quant[3]; /* [out] */ |
373 |
|
|
374 |
|
xvid_image_t reference; /* [out] -> [out] */ |
375 |
|
xvid_image_t current; /* [out] -> [in,out] */ |
376 |
|
xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ |
377 |
|
int frame_num; /* [out] frame number */ |
378 |
|
|
379 |
|
int type; /* [in,out] */ |
380 |
|
int quant; /* [in,out] */ |
381 |
|
|
382 |
|
int * dquant; /* [in,out] pointer to diff quantizer table */ |
383 |
|
int dquant_stride; /* [in,out] diff quantizer stride */ |
384 |
|
|
385 |
|
int vop_flags; /* [in,out] */ |
386 |
|
int vol_flags; /* [in,out] */ |
387 |
|
int motion_flags; /* [in,out] */ |
388 |
|
|
389 |
|
int length; /* [out] after: length of encoded frame */ |
390 |
|
int kblks; /* [out] number of blocks compressed as Intra */ |
391 |
|
int mblks; /* [out] number of blocks compressed as Inter */ |
392 |
|
int ublks; /* [out] number of blocks marked not_coded */ |
393 |
|
int sse_y; /* [out] Y plane's sse */ |
394 |
|
int sse_u; /* [out] U plane's sse */ |
395 |
|
int sse_v; /* [out] V plane's sse */ |
396 |
|
} xvid_plg_data_t; |
397 |
|
|
398 |
|
|
399 |
|
/***************************************************************************** |
400 |
|
xvid plugin system -- external |
401 |
|
|
402 |
|
the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array |
403 |
|
indicates the plugin function pointer and plugin-specific data. |
404 |
|
xvidcore handles the rest. example: |
405 |
|
|
406 |
|
xvid_enc_create_t create; |
407 |
|
xvid_enc_plugin_t plugins[2]; |
408 |
|
|
409 |
|
plugins[0].func = xvid_psnr_func; |
410 |
|
plugins[0].param = NULL; |
411 |
|
plugins[1].func = xvid_cbr_func; |
412 |
|
plugins[1].param = &cbr_data; |
413 |
|
|
414 |
|
create.num_plugins = 2; |
415 |
|
create.plugins = plugins; |
416 |
|
|
417 |
|
****************************************************************************/ |
418 |
|
|
419 |
|
typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); |
420 |
|
|
421 |
typedef struct |
typedef struct |
422 |
{ |
{ |
423 |
int general; /* [in] general options */ |
xvid_plugin_func * func; |
424 |
int motion; /* [in] ME options */ |
void * param; |
425 |
void *bitstream; /* [in] bitstream ptr */ |
} xvid_enc_plugin_t; |
|
int length; /* [out] bitstream length (bytes) */ |
|
426 |
|
|
|
void *image; /* [in] image ptr */ |
|
|
int stride; |
|
|
int colorspace; /* [in] source colorspace */ |
|
|
|
|
|
unsigned char *quant_intra_matrix; // [in] custom intra qmatrix */ |
|
|
unsigned char *quant_inter_matrix; // [in] custom inter qmatrix */ |
|
|
int quant; /* [in] frame quantizer (vbr) */ |
|
|
int intra; /* [in] force intra frame (vbr only) |
|
|
* [out] intra state |
|
|
*/ |
|
|
HINTINFO hint; /* [in/out] mv hint information */ |
|
427 |
|
|
428 |
int bquant; /* [in] bframe quantizer */ |
xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
429 |
|
xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ |
430 |
|
xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ |
431 |
|
|
432 |
} |
xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
|
XVID_ENC_FRAME; |
|
433 |
|
|
434 |
|
xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
435 |
|
xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
436 |
|
|
437 |
|
|
438 |
|
/* single pass rate control |
439 |
|
* CBR and Constant quantizer modes */ |
440 |
typedef struct |
typedef struct |
441 |
{ |
{ |
442 |
int quant; /* [out] frame quantizer */ |
int version; |
443 |
int hlength; /* [out] header length (bytes) */ |
|
444 |
int kblks, mblks, ublks; /* [out] */ |
int bitrate; /* [in] bits per second */ |
445 |
} |
int reaction_delay_factor; /* [in] */ |
446 |
XVID_ENC_STATS; |
int averaging_period; /* [in] */ |
447 |
|
int buffer; /* [in] */ |
448 |
|
} xvid_plugin_single_t; |
449 |
|
|
450 |
|
|
451 |
|
typedef struct { |
452 |
|
int version; |
453 |
|
|
454 |
|
char * filename; |
455 |
|
} xvid_plugin_2pass1_t; |
456 |
|
|
457 |
|
|
458 |
|
#define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
459 |
|
#define XVID_PAYBACK_PROP 1 /* payback proportionally */ |
460 |
|
|
461 |
|
typedef struct { |
462 |
|
int version; |
463 |
|
|
464 |
|
int bitrate; /* [in] bits per second */ |
465 |
|
char * filename; /* [in] first pass stats filename */ |
466 |
|
|
467 |
|
int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
468 |
|
int payback_method; /* [in] Payback method: see XVID_PAYBACK flags */ |
469 |
|
int bitrate_payback_delay; /* [in] Payback delay expressed in number of frames */ |
470 |
|
int curve_compression_high; /* [in] percentage of compression performed on the high part of the curve (above average) */ |
471 |
|
int curve_compression_low; /* [in] percentage of compression performed on the low part of the curve (below average) */ |
472 |
|
int max_overflow_improvement; /* [in] */ |
473 |
|
int max_overflow_degradation; /* [in] */ |
474 |
|
|
475 |
|
int kftreshold; /* [in] */ |
476 |
|
int kfreduction; /* [in] */ |
477 |
|
int min_key_interval; /* [in] Minimum interval of frames between two IFrames */ |
478 |
|
|
479 |
|
int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
480 |
|
}xvid_plugin_2pass2_t; |
481 |
|
|
482 |
|
|
483 |
/***************************************************************************** |
/***************************************************************************** |
484 |
* Encoder entry point |
* xvid_encore() |
485 |
****************************************************************************/ |
****************************************************************************/ |
486 |
|
|
487 |
/* Encoder options */ |
/* Encoder options */ |
488 |
#define XVID_ENC_ENCODE 0 |
#define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
489 |
#define XVID_ENC_CREATE 1 |
#define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ |
490 |
#define XVID_ENC_DESTROY 2 |
#define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes |
491 |
|
* 0 means this frame should not be written (ie. encoder lag) */ |
492 |
int xvid_encore(void *handle, |
|
493 |
int opt, |
int xvid_encore(void *handle, int opt, void *param1, void *param2); |
494 |
void *param1, |
|
495 |
void *param2); |
|
496 |
|
|
497 |
|
/* Global Flags */ |
498 |
|
#define XVID_GLOBAL_PACKED (1<<0) /* packed bitstream */ |
499 |
|
#define XVID_GLOBAL_CLOSED_GOP (1<<1) /* closed_gop: was DX50BVOP dx50 bvop compatibility */ |
500 |
|
#define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2) |
501 |
|
#if 0 |
502 |
|
#define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ |
503 |
|
#define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ |
504 |
|
#endif |
505 |
|
|
506 |
|
|
507 |
|
/* XVID_ENC_ENCODE param1 */ |
508 |
|
/* vol-based flags */ |
509 |
|
#define XVID_VOL_MPEGQUANT (1<<0) /* enable MPEG type quantization */ |
510 |
|
#define XVID_VOL_EXTRASTATS (1<<1) /* enable plane sse stats */ |
511 |
|
#define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ |
512 |
|
#define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ |
513 |
|
#define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
514 |
|
#define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ |
515 |
|
|
516 |
|
|
517 |
|
|
518 |
|
/* vop based flags */ |
519 |
|
#define XVID_VOP_DEBUG (1<< 0) |
520 |
|
#define XVID_VOP_HALFPEL (1<< 1) /* use halfpel interpolation */ |
521 |
|
#define XVID_VOP_INTER4V (1<< 2) |
522 |
|
#define XVID_VOP_TRELLISQUANT (1<< 3) /* use trellis based R-D "optimal" quantization */ |
523 |
|
#define XVID_VOP_CHROMAOPT (1<< 4) /* enable chroma optimization pre-filter */ |
524 |
|
#define XVID_VOP_CARTOON (1<< 5) /* use 'cartoon mode' */ |
525 |
|
#define XVID_VOP_GREYSCALE (1<< 6) /* enable greyscale only mode (even for color input material chroma is ignored) */ |
526 |
|
#define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ |
527 |
|
#define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ |
528 |
|
/* only valid for vol_flags|=XVID_VOL_INTERLACING */ |
529 |
|
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
530 |
|
#define XVID_VOP_ALTERNATESCAN (1<<10) /* set alternate vertical scan flag */ |
531 |
|
/* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
532 |
|
#define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ |
533 |
|
|
534 |
|
#define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */ |
535 |
|
|
536 |
|
|
537 |
|
|
538 |
|
/* Motion based flags */ |
539 |
|
#define XVID_ME_ADVANCEDDIAMOND16 (1<< 0) /* use advdiamonds instead of diamonds as search pattern */ |
540 |
|
#define XVID_ME_ADVANCEDDIAMOND8 (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */ |
541 |
|
#define XVID_ME_USESQUARES16 (1<< 2) /* use squares instead of diamonds as search pattern */ |
542 |
|
#define XVID_ME_USESQUARES8 (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */ |
543 |
|
#define XVID_ME_HALFPELREFINE16 (1<< 4) |
544 |
|
#define XVID_ME_HALFPELREFINE8 (1<< 6) |
545 |
|
#define XVID_ME_QUARTERPELREFINE16 (1<< 7) |
546 |
|
#define XVID_ME_QUARTERPELREFINE8 (1<< 8) |
547 |
|
#define XVID_ME_GME_REFINE (1<< 9) |
548 |
|
#define XVID_ME_EXTSEARCH16 (1<<10) /* extend PMV by more searches */ |
549 |
|
#define XVID_ME_EXTSEARCH8 (1<<11) /* use diamond/square for extended 8x8 search */ |
550 |
|
#define XVID_ME_CHROMA_PVOP (1<<12) /* also use chroma for P_VOP/S_VOP ME */ |
551 |
|
#define XVID_ME_CHROMA_BVOP (1<<13) /* also use chroma for B_VOP ME */ |
552 |
|
|
553 |
|
/* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */ |
554 |
|
#define XVID_ME_HALFPELREFINE16_RD (1<<14) /* perform RD-based halfpel refinement */ |
555 |
|
#define XVID_ME_HALFPELREFINE8_RD (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */ |
556 |
|
#define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */ |
557 |
|
#define XVID_ME_QUARTERPELREFINE8_RD (1<<17) /* perform RD-based qpel refinement for 8x8 mode */ |
558 |
|
#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 */ |
559 |
|
#define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */ |
560 |
|
|
561 |
|
#define XVID_ME_UNRESTRICTED16 (1<<20) /* unrestricted ME, not implemented */ |
562 |
|
#define XVID_ME_OVERLAPPING16 (1<<21) /* overlapping ME, not implemented */ |
563 |
|
#define XVID_ME_UNRESTRICTED8 (1<<22) /* unrestricted ME, not implemented */ |
564 |
|
#define XVID_ME_OVERLAPPING8 (1<<23) /* overlapping ME, not implemented */ |
565 |
|
|
566 |
|
#define XVID_ME_DETECT_STATIC_MOTION (1<<24) /* speed-up ME by detecting stationary scenes */ |
567 |
|
#define XVID_ME_FASTREFINE16 (1<<25) /* use low-complexity refinement functions */ |
568 |
|
|
569 |
|
/* XVID_ENC_CREATE param1 */ |
570 |
|
typedef struct { |
571 |
|
int version; |
572 |
|
|
573 |
|
int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */ |
574 |
|
int width; /* [in] frame dimensions; width, pixel units */ |
575 |
|
int height; /* [in] frame dimensions; height, pixel units */ |
576 |
|
|
577 |
|
int num_zones; /* [in:opt] number of bitrate zones */ |
578 |
|
xvid_enc_zone_t * zones; /* ^^ zone array */ |
579 |
|
|
580 |
|
int num_plugins; /* [in:opt] number of plugins */ |
581 |
|
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
582 |
|
|
583 |
|
int num_threads; /* [in:opt] number of threads */ |
584 |
|
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
585 |
|
|
586 |
|
int global; /* [in:opt] global flags; controls encoding behavior */ |
587 |
|
|
588 |
|
/* --- vol-based stuff; included here for convenience */ |
589 |
|
int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ |
590 |
|
int fbase; /* [in] framerate base frame_duration = fincr/fbase seconds*/ |
591 |
|
/* ---------------------------------------------- */ |
592 |
|
|
593 |
|
/* --- vop-based; included here for convenience */ |
594 |
|
int max_key_interval; /* [in:opt] the maximum interval between key frames */ |
595 |
|
|
596 |
|
int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
597 |
|
|
598 |
|
int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
599 |
|
int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ |
600 |
|
|
601 |
|
int min_quant[3]; /* [in:opt] */ |
602 |
|
int max_quant[3]; /* [in:opt] */ |
603 |
|
/* ---------------------------------------------- */ |
604 |
|
|
605 |
|
void *handle; /* [out] encoder instance handle */ |
606 |
|
} |
607 |
|
xvid_enc_create_t; |
608 |
|
|
609 |
|
|
610 |
|
#define XVID_KEYFRAME (1<<1) |
611 |
|
|
612 |
|
typedef struct { |
613 |
|
int version; |
614 |
|
|
615 |
|
/* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any changes here until the next VOL (keyframe). */ |
616 |
|
int vol_flags; /* [in] vol flags */ |
617 |
|
unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */ |
618 |
|
unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */ |
619 |
|
|
620 |
|
int par; /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
621 |
|
int par_width; /* [in:opt] aspect ratio width */ |
622 |
|
int par_height; /* [in:opt] aspect ratio height */ |
623 |
|
/* ---------------------------------------------- */ |
624 |
|
|
625 |
|
int fincr; /* [in:opt] framerate increment, for variable framerate only */ |
626 |
|
int vop_flags; /* [in] (general)vop-based flags */ |
627 |
|
int motion; /* [in] ME options */ |
628 |
|
|
629 |
|
xvid_image_t input; /* [in] input image (read from) */ |
630 |
|
|
631 |
|
int type; /* [in:opt] coding type */ |
632 |
|
int quant; /* [in] frame quantizer; if <=0, automatic (ratecontrol) */ |
633 |
|
int bframe_threshold; |
634 |
|
|
635 |
|
void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
636 |
|
int length; /* [in:opt] bitstream length (bytes) */ |
637 |
|
|
638 |
|
int out_flags; /* [out] bitstream output flags */ |
639 |
|
} xvid_enc_frame_t; |
640 |
|
|
641 |
|
|
642 |
|
/* XVID_ENC_ENCODE param2 (optional) |
643 |
|
xvid_enc_stats_t describes individual frame details |
644 |
|
|
645 |
|
coding_type==XVID_TYPE_NOTHING if the stats are not given |
646 |
|
*/ |
647 |
|
typedef struct { |
648 |
|
int version; |
649 |
|
|
650 |
|
/* encoding parameters */ |
651 |
|
int type; /* [out] coding type */ |
652 |
|
int quant; /* [out] frame quantizer */ |
653 |
|
int vol_flags; /* [out] vol flags (see above) */ |
654 |
|
int vop_flags; /* [out] vop flags (see above) */ |
655 |
|
|
656 |
|
/* bitrate */ |
657 |
|
int length; /* [out] frame length */ |
658 |
|
|
659 |
|
int hlength; /* [out] header length (bytes) */ |
660 |
|
int kblks; /* [out] number of blocks compressed as Intra */ |
661 |
|
int mblks; /* [out] number of blocks compressed as Inter */ |
662 |
|
int ublks; /* [out] number of blocks marked as not_coded */ |
663 |
|
|
664 |
|
int sse_y; /* [out] Y plane's sse */ |
665 |
|
int sse_u; /* [out] U plane's sse */ |
666 |
|
int sse_v; /* [out] V plane's sse */ |
667 |
|
} xvid_enc_stats_t; |
668 |
|
|
669 |
#ifdef __cplusplus |
#ifdef __cplusplus |
670 |
} |
} |
671 |
#endif |
#endif |
672 |
|
|
673 |
|
|
674 |
#endif |
#endif |