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 |
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 |
* |
* |
22 |
*****************************************************************************/ |
* $Id: xvid.h,v 1.27.2.5 2003-03-13 11:07:20 suxen_drol Exp $ |
|
/***************************************************************************** |
|
|
* |
|
|
* 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). |
|
23 |
* |
* |
24 |
* ToDo ? : when BFRAMES is defined, the API_VERSION should not |
****************************************************************************/ |
|
* be the same (3.0 ?) |
|
|
* |
|
|
* $Id: xvid.h,v 1.15 2002-07-19 11:15:21 albeu Exp $ |
|
|
* |
|
|
*****************************************************************************/ |
|
|
|
|
25 |
|
|
26 |
#ifndef _XVID_H_ |
#ifndef _XVID_H_ |
27 |
#define _XVID_H_ |
#define _XVID_H_ |
28 |
|
|
29 |
|
|
30 |
#ifdef __cplusplus |
#ifdef __cplusplus |
31 |
* $Id: xvid.h,v 1.15 2002-07-19 11:15:21 albeu Exp $ |
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 |
|
$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 |
/* Error codes */ |
XVID_UNSTABLE is defined only during development. |
49 |
#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 |
|
|
#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 |
|
|
#define XVID_CSP_NULL 9999 |
|
50 |
|
|
51 |
#define XVID_CSP_VFLIP 0x80000000 // flip mask |
#define XVID_MAKE_VERSION(a,b,c) ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) ) |
52 |
|
#define XVID_MAJOR(a) ( ((a)>>16) & 0xff ) |
53 |
|
#define XVID_MINOR(b) ((char)( ((b)>>8) & 0xff )) |
54 |
|
#define XVID_PATCH(c) ( (c) & 0xff ) |
55 |
|
|
56 |
|
#define XVID_VERSION XVID_MAKE_VERSION(1,-127,0) |
57 |
|
#define XVID_UNSTABLE |
58 |
|
|
59 |
|
/* Bitstream Version |
60 |
|
* this will be writen into the bitstream to allow easy detection of xvid |
61 |
|
* encoder bugs in the decoder, without this it might not possible to |
62 |
|
* automatically distinquish between a file which has been encoded with an |
63 |
|
* old & buggy XVID from a file which has been encoded with a bugfree version |
64 |
|
* see the infamous interlacing bug ... |
65 |
|
* |
66 |
|
* this MUST be increased if an encoder bug is fixed, increasing it too often |
67 |
|
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
68 |
|
* future |
69 |
|
*/ |
70 |
|
#define XVID_BS_VERSION "0009" |
71 |
|
|
72 |
|
|
73 |
/***************************************************************************** |
/***************************************************************************** |
74 |
* Initialization constants |
* error codes |
75 |
****************************************************************************/ |
****************************************************************************/ |
76 |
|
|
77 |
/* CPU flags for XVID_INIT_PARAM.cpu_flags */ |
/* all functions return values <0 indicate error */ |
|
|
|
|
#define XVID_CPU_MMX 0x00000001 |
|
|
#define XVID_CPU_MMXEXT 0x00000002 |
|
|
#define XVID_CPU_SSE 0x00000004 |
|
|
#define XVID_CPU_SSE2 0x00000008 |
|
|
#define XVID_CPU_3DNOW 0x00000010 |
|
|
#define XVID_CPU_3DNOWEXT 0x00000020 |
|
|
|
|
|
#define XVID_CPU_TSC 0x00000040 |
|
78 |
|
|
79 |
#define XVID_CPU_IA64 0x00000080 |
#define XVID_ERR_FAIL -1 /* general fault */ |
80 |
|
#define XVID_ERR_MEMORY -2 /* memory allocation error */ |
81 |
|
#define XVID_ERR_FORMAT -3 /* file format error */ |
82 |
|
#define XVID_ERR_VERSION -4 /* structure version not supported */ |
83 |
|
#define XVID_ERR_END -5 /* encoder only; end of stream reached */ |
84 |
|
|
|
#define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */ |
|
|
#define XVID_CPU_FORCE 0x80000000 |
|
85 |
|
|
86 |
|
|
87 |
/***************************************************************************** |
/***************************************************************************** |
88 |
* Initialization structures |
* xvid_image_t |
89 |
****************************************************************************/ |
****************************************************************************/ |
90 |
|
|
91 |
typedef struct |
/* colorspace values */ |
92 |
{ |
|
93 |
int cpu_flags; |
#define XVID_CSP_USER 0 /* 4:2:0 planar */ |
94 |
int api_version; |
#define XVID_CSP_I420 1 /* 4:2:0 packed(planar win32) */ |
95 |
int core_build; |
#define XVID_CSP_YV12 2 /* 4:2:0 packed(planar win32) */ |
96 |
} |
#define XVID_CSP_YUY2 3 /* 4:2:2 packed */ |
97 |
XVID_INIT_PARAM; |
#define XVID_CSP_UYVY 4 /* 4:2:2 packed */ |
98 |
|
#define XVID_CSP_YVYU 5 /* 4:2:2 packed */ |
99 |
|
#define XVID_CSP_BGRA 6 /* 32-bit bgra packed */ |
100 |
|
#define XVID_CSP_ABGR 7 /* 32-bit abgr packed */ |
101 |
|
#define XVID_CSP_RGBA 8 /* 32-bit rgba packed */ |
102 |
|
#define XVID_CSP_BGR 9 /* 32-bit bgr packed */ |
103 |
|
#define XVID_CSP_RGB555 10 /* 16-bit rgb555 packed */ |
104 |
|
#define XVID_CSP_RGB565 11 /* 16-bit rgb565 packed */ |
105 |
|
#define XVID_CSP_SLICE 12 /* decoder only: 4:2:0 planar, per slice rendering */ |
106 |
|
#define XVID_CSP_INTERNAL 13 /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */ |
107 |
|
#define XVID_CSP_NULL 14 /* decoder only: dont output anything */ |
108 |
|
#define XVID_CSP_VFLIP 0x80000000 /* vertical flip mask */ |
109 |
|
|
110 |
|
/* xvid_image_t |
111 |
|
for non-planar colorspaces use only plane[0] and stride[0] |
112 |
|
four plane reserved for alpha*/ |
113 |
|
typedef struct { |
114 |
|
int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */ |
115 |
|
void * plane[4]; /* [in] image plane ptrs */ |
116 |
|
int stride[4]; /* [in] image stride; "bytes per row"*/ |
117 |
|
} xvid_image_t; |
118 |
|
|
119 |
|
|
120 |
|
/* aspect ratios */ |
121 |
|
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */ |
122 |
|
#define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ |
123 |
|
#define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ |
124 |
|
#define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ |
125 |
|
#define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */ |
126 |
|
#define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */ |
127 |
|
|
128 |
|
/* frame type flags */ |
129 |
|
#define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */ |
130 |
|
#define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */ |
131 |
|
#define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */ |
132 |
|
#define XVID_TYPE_IVOP 1 /* intra frame */ |
133 |
|
#define XVID_TYPE_PVOP 2 /* predicted frame */ |
134 |
|
#define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ |
135 |
|
#define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ |
136 |
|
|
137 |
/***************************************************************************** |
/***************************************************************************** |
138 |
* Initialization entry point |
* xvid_global() |
139 |
****************************************************************************/ |
****************************************************************************/ |
140 |
|
|
141 |
int xvid_init(void *handle, |
/* cpu_flags definitions */ |
|
int opt, |
|
|
void *param1, |
|
|
void *param2); |
|
142 |
|
|
143 |
|
#define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */ |
144 |
|
#define XVID_CPU_ASM 0x00000080 /* native assembly */ |
145 |
|
/* ARCH_IS_IA32 */ |
146 |
|
#define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */ |
147 |
|
#define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */ |
148 |
|
#define XVID_CPU_SSE 0x00000004 /* sse : pentium3, athlonXP */ |
149 |
|
#define XVID_CPU_SSE2 0x00000008 /* sse2 : pentium4, athlon64 */ |
150 |
|
#define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */ |
151 |
|
#define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ |
152 |
|
#define XVID_CPU_TSC 0x00000040 /* timestamp counter */ |
153 |
|
/* ARCH_IS_PPC */ |
154 |
|
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
155 |
|
|
156 |
|
|
157 |
|
/* XVID_GBL_INIT param1 */ |
158 |
|
typedef struct { |
159 |
|
int version; |
160 |
|
int cpu_flags; /* [in:opt] zero = autodetect cpu |
161 |
|
XVID_CPU_FORCE|{cpu features} = force cpu features */ |
162 |
|
} xvid_gbl_init_t; |
163 |
|
|
164 |
|
|
165 |
|
/* XVID_GBL_INFO param1 */ |
166 |
|
typedef struct { |
167 |
|
int version; |
168 |
|
int actual_version; /* [out] returns the actual xvidcore version */ |
169 |
|
const char * build; /* [out] if !null, points to description of this xvid core build */ |
170 |
|
int cpu_flags; /* [out] detected cpu features */ |
171 |
|
int num_threads; /* [out] detected number of cpus/threads */ |
172 |
|
} xvid_gbl_info_t; |
173 |
|
|
174 |
|
|
175 |
|
/* XVID_GBL_CONVERT param1 */ |
176 |
|
typedef struct { |
177 |
|
int version; |
178 |
|
xvid_image_t input; /* [in] input image & colorspace */ |
179 |
|
xvid_image_t output; /* [in] output image & colorspace */ |
180 |
|
int width; /* [in] width */ |
181 |
|
int height; /* [in] height */ |
182 |
|
int interlacing; /* [in] interlacing */ |
183 |
|
} xvid_gbl_convert_t; |
184 |
|
|
185 |
|
|
186 |
|
#define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */ |
187 |
|
#define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ |
188 |
|
#define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ |
189 |
|
#define XVID_GBL_TEST 3 /* testing.. */ |
190 |
|
|
191 |
/***************************************************************************** |
int xvid_global(void *handle, int opt, void *param1, void *param2); |
|
* Decoder constants |
|
|
****************************************************************************/ |
|
192 |
|
|
|
/* Flags for XVID_DEC_FRAME.general */ |
|
|
#define XVID_QUICK_DECODE 0x00000010 |
|
193 |
|
|
194 |
/***************************************************************************** |
/***************************************************************************** |
195 |
* Decoder structures |
* xvid_decore() |
196 |
|
****************************************************************************/ |
197 |
|
|
198 |
|
#define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
199 |
|
#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ |
200 |
|
#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ |
201 |
|
|
202 |
|
int xvid_decore(void *handle, int opt, void *param1, void *param2); |
203 |
|
|
204 |
|
/* XVID_DEC_CREATE param 1 |
205 |
|
image width & height may be specified here when the dimensions are |
206 |
|
known in advance. */ |
207 |
|
typedef struct { |
208 |
|
int version; |
209 |
|
int width; /* [in:opt] image width */ |
210 |
|
int height; /* [in:opt] image width */ |
211 |
|
void * handle; /* [out] decore context handle */ |
212 |
|
} xvid_dec_create_t; |
213 |
|
|
214 |
|
|
215 |
|
/* XVID_DEC_DECODE param1 */ |
216 |
|
/* general flags */ |
217 |
|
#define XVID_LOWDELAY 0x00000001 /* lowdelay mode */ |
218 |
|
#define XVID_DISCONTINUITY 0x00000002 /* indicates break in stream */ |
219 |
|
|
220 |
|
typedef struct { |
221 |
|
int version; |
222 |
|
int general; /* [in:opt] general flags */ |
223 |
|
void *bitstream; /* [in] bitstream (read from)*/ |
224 |
|
int length; /* [in] bitstream length */ |
225 |
|
xvid_image_t output; /* [in] output image (written to) */ |
226 |
|
} |
227 |
|
xvid_dec_frame_t; |
228 |
|
|
229 |
|
|
230 |
|
/* XVID_DEC_DECODE param2 :: optional */ |
231 |
|
typedef struct |
232 |
|
{ |
233 |
|
int version; |
234 |
|
int type; /* [out] output data type */ |
235 |
|
union { |
236 |
|
struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ |
237 |
|
int general; /* [out] flags */ |
238 |
|
int time_base; /* [out] time base */ |
239 |
|
int time_increment; /* [out] time increment */ |
240 |
|
|
241 |
|
/* XXX: external deblocking stuff */ |
242 |
|
unsigned char * qscale; /* [out] pointer to quantizer table */ |
243 |
|
int qscale_stride; /* [out] quantizer scale stride */ |
244 |
|
|
245 |
|
} vop; |
246 |
|
struct { /* XVID_TYPE_VOL */ |
247 |
|
int general; /* [out] flags */ |
248 |
|
int width; /* [out] width */ |
249 |
|
int height; /* [out] height */ |
250 |
|
int par; /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
251 |
|
int par_width; /* [out] aspect ratio width */ |
252 |
|
int par_height; /* [out] aspect ratio height */ |
253 |
|
} vol; |
254 |
|
} data; |
255 |
|
} xvid_dec_stats_t; |
256 |
|
|
257 |
|
|
258 |
|
/***************************************************************************** |
259 |
|
xvid plugin system -- internals |
260 |
|
|
261 |
|
xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE |
262 |
|
before encoding each frame xvidcore will call XVID_PLG_BEFORE |
263 |
|
after encoding each frame xvidcore will call XVID_PLG_AFTER |
264 |
|
xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY |
265 |
****************************************************************************/ |
****************************************************************************/ |
266 |
|
|
267 |
|
#define XVID_PLG_CREATE 0 |
268 |
|
#define XVID_PLG_DESTROY 1 |
269 |
|
#define XVID_PLG_INFO 2 |
270 |
|
#define XVID_PLG_BEFORE 3 |
271 |
|
#define XVID_PLG_AFTER 4 |
272 |
|
|
273 |
|
/* xvid_plg_info_t.flags */ |
274 |
|
#define XVID_PLG_ORIGINAL 1 /* plugin requires a copy of the original (uncompressed) image */ |
275 |
|
|
276 |
|
|
277 |
typedef struct |
typedef struct |
278 |
{ |
{ |
279 |
int width; |
int version; |
280 |
int height; |
int flags; /* plugin flags */ |
281 |
void *handle; |
} xvid_plg_info_t; |
|
} |
|
|
XVID_DEC_PARAM; |
|
282 |
|
|
283 |
|
|
284 |
typedef struct |
typedef struct |
285 |
{ |
{ |
286 |
int general; |
int version; |
287 |
void *bitstream; |
|
288 |
int length; |
int width, height; |
289 |
|
int fincr, fbase; |
290 |
void *image; |
|
291 |
int stride; |
void * param; |
292 |
int colorspace; |
} xvid_plg_create_t; |
|
} |
|
|
XVID_DEC_FRAME; |
|
293 |
|
|
294 |
|
|
|
// This struct is used for per slice rendering |
|
295 |
typedef struct |
typedef struct |
296 |
{ |
{ |
297 |
void *y,*u,*v; |
int version; |
|
int stride_y, stride_u,stride_v; |
|
|
} XVID_DEC_PICTURE; |
|
298 |
|
|
299 |
|
xvid_image_t reference; |
300 |
|
xvid_image_t current; |
301 |
|
xvid_image_t original; /* after: points the original (uncompressed) copy of the current frame */ |
302 |
|
|
303 |
/***************************************************************************** |
int type; /* [in,out] */ |
304 |
* Decoder entry point |
int quant; /* [in,out] */ |
305 |
****************************************************************************/ |
|
306 |
|
unsigned char * qscale; /* [in,out] pointer to quantizer table */ |
307 |
|
int qscale_stride; /* [in,out] quantizer scale stride */ |
308 |
|
|
309 |
/* decoder options */ |
int vop_flags; /* [in,out] */ |
310 |
#define XVID_DEC_DECODE 0 |
int vol_flags; /* [in,out] */ |
311 |
#define XVID_DEC_CREATE 1 |
int motion_flags; /* [in,out] */ |
312 |
#define XVID_DEC_DESTROY 2 |
|
313 |
|
int length; /* [out] after: length of encoded frame */ |
314 |
int xvid_decore(void *handle, |
int kblks, mblks, ublks; /* [out] after: */ |
315 |
int opt, |
} xvid_plg_data_t; |
|
void *param1, |
|
|
void *param2); |
|
316 |
|
|
317 |
|
|
318 |
/***************************************************************************** |
/***************************************************************************** |
319 |
* Encoder constants |
xvid plugin system -- external |
320 |
|
|
321 |
|
the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array |
322 |
|
indicates the plugin function pointer and plugin-specific data. |
323 |
|
xvidcore handles the rest. example: |
324 |
|
|
325 |
|
xvid_enc_create_t create; |
326 |
|
xvid_enc_plugin_t plugins[2]; |
327 |
|
|
328 |
|
plugins[0].func = xvid_psnr_func; |
329 |
|
plugins[0].param = NULL; |
330 |
|
plugins[1].func = xvid_cbr_func; |
331 |
|
plugins[1].param = &cbr_data; |
332 |
|
|
333 |
|
create.num_plugins = 2; |
334 |
|
create.plugins = plugins; |
335 |
|
|
336 |
****************************************************************************/ |
****************************************************************************/ |
337 |
|
|
338 |
/* Flags for XVID_ENC_PARAM.global */ |
typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); |
339 |
#define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */ |
|
340 |
#define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */ |
typedef struct |
341 |
#define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */ |
{ |
342 |
|
xvid_plugin_func * func; |
343 |
/* Flags for XVID_ENC_FRAME.general */ |
void * param; |
344 |
#define XVID_VALID_FLAGS 0x80000000 |
} xvid_enc_plugin_t; |
345 |
|
|
|
#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_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) */ |
|
|
|
|
|
|
|
|
/* Flags for XVID_ENC_FRAME.motion */ |
|
|
#define PMV_ADVANCEDDIAMOND8 0x00004000 |
|
|
#define PMV_ADVANCEDDIAMOND16 0x00008000 |
|
|
#define PMV_EARLYSTOP16 0x00080000 |
|
|
#define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more refinement */ |
|
|
#define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ |
|
|
#define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ |
|
|
#define PMV_USESQUARES16 0x00800000 |
|
|
|
|
|
#define PMV_HALFPELDIAMOND8 0x01000000 |
|
|
#define PMV_HALFPELREFINE8 0x02000000 |
|
|
#define PMV_EXTSEARCH8 0x04000000 /* extend PMV by more searches */ |
|
|
#define PMV_EARLYSTOP8 0x08000000 |
|
|
#define PMV_QUICKSTOP8 0x10000000 /* like early, but without any more refinement */ |
|
|
#define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */ |
|
|
#define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */ |
|
|
#define PMV_USESQUARES8 0x80000000 |
|
346 |
|
|
347 |
|
|
348 |
/***************************************************************************** |
/***************************************************************************** |
349 |
* Encoder structures |
* xvid_encore() |
350 |
****************************************************************************/ |
****************************************************************************/ |
351 |
|
|
352 |
typedef struct |
/* Encoder options */ |
353 |
|
#define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
354 |
|
#define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ |
355 |
|
#define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes |
356 |
|
0 means this frame should not be written (ie. encoder lag) */ |
357 |
|
|
358 |
|
int xvid_encore(void *handle, int opt, void *param1, void *param2); |
359 |
|
|
360 |
|
|
361 |
|
/* global flags */ |
362 |
|
typedef enum |
363 |
{ |
{ |
364 |
int width, height; |
XVID_PACKED = 0x00000001, /* packed bitstream */ |
365 |
int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */ |
XVID_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */ |
366 |
int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */ |
XVID_EXTRASTATS_ENABLE = 0x00000004 |
367 |
int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */ |
/*define XVID_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */ |
368 |
int rc_averaging_period; /* as above */ |
/*define XVID_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */ |
369 |
int rc_buffer; /* as above */ |
} xvid_global_t; |
370 |
int max_quantizer; /* the upper limit of the quantizer */ |
|
371 |
int min_quantizer; /* the lower limit of the quantizer */ |
|
372 |
int max_key_interval; /* the maximum interval between key frames */ |
/* XVID_ENC_ENCODE param1 */ |
373 |
#ifdef _SMP |
/* vol-based flags */ |
374 |
int num_threads; /* number of threads */ |
typedef enum { |
375 |
#endif |
XVID_MPEGQUANT = 0x00000001, |
376 |
#ifdef BFRAMES |
XVID_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */ |
377 |
int global; /* global/debug options */ |
XVID_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */ |
378 |
int max_bframes; /* max sequential bframes (0=disable bframes) */ |
XVID_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
379 |
int bquant_ratio; /* bframe quantizer multipier (percentage). |
XVID_INTERLACING = 0x00000400, /* enable interlaced encoding */ |
380 |
* used only when bquant < 1 |
} xvid_vol_t; |
381 |
* eg. 200 = x2 multiplier |
|
382 |
* quant = ((past_quant + future_quant) * bquant_ratio)/200 |
|
383 |
*/ |
/* vop-based flags */ |
384 |
int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */ |
typedef enum { |
385 |
#endif |
XVID_DEBUG = 0x00000001, |
386 |
|
XVID_EXTRASTATS = 0x00000002, |
387 |
|
XVID_HALFPEL = 0x00000004, /* use halfpel interpolation */ |
388 |
|
XVID_INTER4V = 0x00000008, |
389 |
|
XVID_LUMIMASKING = 0x00000010, |
390 |
|
|
391 |
|
XVID_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */ |
392 |
|
XVID_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for |
393 |
|
color input material chroma is ignored) */ |
394 |
|
XVID_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ |
395 |
|
XVID_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ |
396 |
|
XVID_DYNAMIC_BFRAMES = 0x00000200, |
397 |
|
|
398 |
|
/* only valid for vol_flags|=XVID_INTERLACING */ |
399 |
|
XVID_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ |
400 |
|
XVID_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */ |
401 |
|
|
402 |
|
/* only valid for vol_flags|=XVID_REDUCED_ENABLED */ |
403 |
|
XVID_REDUCED = 0x00001000, /* reduced resolution vop */ |
404 |
|
} xvid_vop_t; |
405 |
|
|
406 |
|
|
407 |
|
typedef enum { |
408 |
|
PMV_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */ |
409 |
|
PMV_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */ |
410 |
|
|
411 |
|
PMV_HALFPELREFINE16 = 0x00020000, |
412 |
|
PMV_HALFPELREFINE8 = 0x02000000, |
413 |
|
|
414 |
|
PMV_QUARTERPELREFINE16 = 0x00040000, |
415 |
|
PMV_QUARTERPELREFINE8 = 0x04000000, |
416 |
|
|
417 |
|
PMV_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */ |
418 |
|
|
419 |
|
PMV_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */ |
420 |
|
PMV_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */ |
421 |
|
PMV_USESQUARES8 = 0x80000000, /* use square for PMV_EXTSEARCH8 */ |
422 |
|
|
423 |
|
PMV_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */ |
424 |
|
PMV_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */ |
425 |
|
|
426 |
|
/* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */ |
427 |
|
HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */ |
428 |
|
HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */ |
429 |
|
QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */ |
430 |
|
QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */ |
431 |
|
|
432 |
|
EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern |
433 |
|
enable PMV_EXTSEARCH8 to do this in 8x8 search as well */ |
434 |
|
CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */ |
435 |
|
|
436 |
|
PMV_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */ |
437 |
|
PMV_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */ |
438 |
|
PMV_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */ |
439 |
|
PMV_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */ |
440 |
|
} xvid_motion_t; |
441 |
|
|
442 |
|
|
443 |
|
/* XVID_ENC_CREATE param1 */ |
444 |
|
typedef struct { |
445 |
|
int version; |
446 |
|
int width; /* [in] frame dimensions; width, pixel units */ |
447 |
|
int height; /* [in] frame dimensions; height, pixel units */ |
448 |
|
|
449 |
|
int num_plugins; /* [in:opt] number of plugins */ |
450 |
|
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
451 |
|
|
452 |
|
int num_threads; /* [in:opt] number of threads */ |
453 |
|
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
454 |
|
|
455 |
|
xvid_global_t global; /* [in:opt] global flags; controls encoding behavior */ |
456 |
|
|
457 |
|
/* --- vol-based stuff; included here for conveinience */ |
458 |
|
int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ |
459 |
|
int fbase; /* [in] framerate base |
460 |
|
frame_duration = fincr/fbase seconds*/ |
461 |
|
/* ^^^---------------------------------------------- */ |
462 |
|
|
463 |
|
|
464 |
|
/* ---vop-based; included here for conveienience */ |
465 |
|
int max_key_interval; /* [in:opt] the maximum interval between key frames */ |
466 |
|
/*XXX: maybe call it gop_size? */ |
467 |
|
|
468 |
|
int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
469 |
|
|
470 |
|
int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
471 |
|
int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ |
472 |
|
|
473 |
|
/* ^^^ -------------------------------------------------------------------------*/ |
474 |
|
|
475 |
void *handle; /* [out] encoder instance handle */ |
void *handle; /* [out] encoder instance handle */ |
476 |
} |
} |
477 |
XVID_ENC_PARAM; |
xvid_enc_create_t; |
478 |
|
|
|
typedef struct |
|
|
{ |
|
|
int x; |
|
|
} |
|
|
VECTOR; |
|
479 |
|
|
480 |
typedef struct |
typedef struct { |
481 |
{ |
int version; |
482 |
int mode; /* macroblock mode */ |
int type; /* [in] rate control type: XVID_RC_xxx */ |
|
VECTOR mvs[4]; |
|
|
} |
|
|
MVBLOCKHINT; |
|
483 |
|
|
484 |
typedef struct |
/* common stuff */ |
485 |
{ |
int min_iquant; /* [in:opt] ivop quantizer upper/lower limit */ |
486 |
int intra; /* frame intra choice */ |
int max_iquant; /* [in:opt] */ |
487 |
int fcode; /* frame fcode */ |
int min_pquant; /* [in:opt] psvop quantizer upper/lower limit */ |
488 |
MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ |
int max_pquant; /* [in:opt] */ |
489 |
} |
int min_bquant; /* [in:opt] bvop quantizer upper/lower limit */ |
490 |
MVFRAMEHINT; |
int max_bquant; /* [in:opt] */ |
491 |
|
|
492 |
typedef struct |
union { |
493 |
{ |
struct { /* XVID_RC_FQUANT */ |
494 |
int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ |
float quant; /* [in] quantizer */ |
495 |
|
} fquant; |
496 |
|
struct { /* XVID_RC_CBR */ |
497 |
|
int bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */ |
498 |
|
int reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */ |
499 |
|
int averaging_period; /* [in] */ |
500 |
|
int buffer; /* [in] */ |
501 |
|
} cbr; |
502 |
|
} data; |
503 |
|
} xvid_enc_rc_t; |
504 |
|
|
|
MVFRAMEHINT mvhint; |
|
|
void *hintstream; /* compressed hint buffer */ |
|
|
int hintlength; /* length of buffer (bytes) */ |
|
|
} |
|
|
HINTINFO; |
|
505 |
|
|
|
typedef struct |
|
|
{ |
|
|
int general; /* [in] general options */ |
|
|
int motion; /* [in] ME options */ |
|
|
void *bitstream; /* [in] bitstream ptr */ |
|
|
int length; /* [out] bitstream length (bytes) */ |
|
|
|
|
|
void *image; /* [in] image ptr */ |
|
|
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 */ |
|
506 |
|
|
507 |
#ifdef BFRAMES |
#define XVID_KEYFRAME 0x00000001 |
|
int bquant; /* [in] bframe quantizer */ |
|
|
#endif |
|
508 |
|
|
509 |
} |
typedef struct { |
510 |
XVID_ENC_FRAME; |
int version; |
511 |
|
|
512 |
|
/* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any |
513 |
|
changes here until the next VOL (keyframe). */ |
514 |
|
xvid_vol_t vol_flags; /* [in] vol flags */ |
515 |
|
unsigned char * |
516 |
|
quant_intra_matrix; /* [in:opt] custom intra qmatrix */ |
517 |
|
unsigned char * |
518 |
|
quant_inter_matrix; /* [in:opt] custom inter qmatrix */ |
519 |
|
|
520 |
typedef struct |
int par; /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
521 |
{ |
int par_width; /* [in:opt] aspect ratio width */ |
522 |
int quant; /* [out] frame quantizer */ |
int par_height; /* [in:opt] aspect ratio height */ |
523 |
int hlength; /* [out] header length (bytes) */ |
/* ^^^----------------------------------------------------------------------------------*/ |
524 |
int kblks, mblks, ublks; /* [out] */ |
|
525 |
|
xvid_vop_t vop_flags; /* [in] (general)vop-based flags */ |
526 |
|
xvid_motion_t motion; /* [in] ME options */ |
527 |
|
|
528 |
|
xvid_image_t input; /* [in] input image (read from) */ |
529 |
|
|
530 |
|
int type; /* [in:opt] coding type */ |
531 |
|
int quant; /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */ |
532 |
|
int bquant; /* [in:opt] bframe quantizer; if <=0, automatic*/ |
533 |
|
|
534 |
|
void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
535 |
|
int length; /* [in:opt] bitstream length (bytes) */ |
536 |
|
|
537 |
|
int out_flags; /* [out] bitstream output flags */ |
538 |
} |
} |
539 |
XVID_ENC_STATS; |
xvid_enc_frame_t; |
540 |
|
|
541 |
|
|
542 |
/***************************************************************************** |
/* XVID_ENC_ENCODE param2 (optional) |
543 |
* Encoder entry point |
xvid_enc_stats_t describes individual frame details |
|
****************************************************************************/ |
|
544 |
|
|
545 |
/* Encoder options */ |
coding_type==XVID_TYPE_NOTHING if the stats are not given |
546 |
#define XVID_ENC_ENCODE 0 |
*/ |
547 |
#define XVID_ENC_CREATE 1 |
typedef struct { |
548 |
#define XVID_ENC_DESTROY 2 |
int version; |
|
|
|
|
int xvid_encore(void *handle, |
|
|
int opt, |
|
|
void *param1, |
|
|
void *param2); |
|
549 |
|
|
550 |
|
/* encoding parameters */ |
551 |
|
int type; /* [out] coding type */ |
552 |
|
int quant; /* [out] frame quantizer */ |
553 |
|
xvid_vol_t vol_flags; /* [out] vol flags (see above) */ |
554 |
|
int vop_flags; /* [out] vop flags (see above) */ |
555 |
|
/* bitrate */ |
556 |
|
int length; /* [out] frame length */ |
557 |
|
|
558 |
|
int hlength; /* [out] header length (bytes) */ |
559 |
|
int kblks, mblks, ublks; /* [out] */ |
560 |
|
|
561 |
|
int sse_y, sse_u, sse_v; |
562 |
|
} |
563 |
|
xvid_enc_stats_t; |
564 |
|
|
565 |
#ifdef __cplusplus |
#ifdef __cplusplus |
566 |
} |
} |
567 |
#endif |
#endif |
568 |
|
|
569 |
|
|
570 |
#endif |
#endif |