Parent Directory | Revision Log
Revision 1259 - (view) (download)
1 : | edgomez | 199 | /***************************************************************************** |
2 : | edgomez | 868 | * |
3 : | edgomez | 1107 | * XVID MPEG-4 VIDEO CODEC |
4 : | * - XviD Main header file - | ||
5 : | edgomez | 868 | * |
6 : | edgomez | 1054 | * Copyright(C) 2001-2003 Peter Ross <pross@xvid.org> |
7 : | edgomez | 868 | * |
8 : | edgomez | 1054 | * This program is free software ; you can redistribute it and/or modify |
9 : | edgomez | 868 | * it under the terms of the GNU General Public License as published by |
10 : | edgomez | 1054 | * the Free Software Foundation ; either version 2 of the License, or |
11 : | edgomez | 868 | * (at your option) any later version. |
12 : | * | ||
13 : | * This program is distributed in the hope that it will be useful, | ||
14 : | edgomez | 1054 | * but WITHOUT ANY WARRANTY ; without even the implied warranty of |
15 : | edgomez | 868 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 : | * GNU General Public License for more details. | ||
17 : | * | ||
18 : | * You should have received a copy of the GNU General Public License | ||
19 : | edgomez | 1054 | * along with this program ; if not, write to the Free Software |
20 : | edgomez | 868 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
21 : | * | ||
22 : | edgomez | 1259 | * $Id: xvid.h,v 1.27.2.52 2003-12-12 14:16:40 edgomez Exp $ |
23 : | edgomez | 868 | * |
24 : | ****************************************************************************/ | ||
25 : | edgomez | 199 | |
26 : | #ifndef _XVID_H_ | ||
27 : | #define _XVID_H_ | ||
28 : | |||
29 : | suxen_drol | 919 | |
30 : | edgomez | 199 | #ifdef __cplusplus |
31 : | chl | 352 | extern "C" { |
32 : | edgomez | 199 | #endif |
33 : | |||
34 : | /***************************************************************************** | ||
35 : | suxen_drol | 890 | * versioning |
36 : | edgomez | 199 | ****************************************************************************/ |
37 : | |||
38 : | suxen_drol | 890 | /* versioning |
39 : | version takes the form "$major.$minor.$patch" | ||
40 : | $patch is incremented when there is no api change | ||
41 : | $minor is incremented when the api is changed, but remains backwards compatible | ||
42 : | $major is incremented when the api is changed significantly | ||
43 : | edgomez | 199 | |
44 : | suxen_drol | 890 | when initialising an xvid structure, you must always zero it, and set the version field. |
45 : | memset(&struct,0,sizeof(struct)); | ||
46 : | struct.version = XVID_VERSION; | ||
47 : | |||
48 : | edgomez | 1161 | XVID_UNSTABLE is defined only during development. |
49 : | suxen_drol | 890 | */ |
50 : | |||
51 : | edgomez | 1107 | #define XVID_MAKE_VERSION(a,b,c) ((((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff)) |
52 : | edgomez | 1155 | #define XVID_VERSION_MAJOR(a) ((char)(((a)>>16) & 0xff)) |
53 : | #define XVID_VERSION_MINOR(a) ((char)(((a)>> 8) & 0xff)) | ||
54 : | #define XVID_VERSION_PATCH(a) ((char)(((a)>> 0) & 0xff)) | ||
55 : | suxen_drol | 890 | |
56 : | edgomez | 1107 | #define XVID_MAKE_API(a,b) ((((a)&0xff)<<16) | (((b)&0xff)<<0)) |
57 : | #define XVID_API_MAJOR(a) (((a)>>16) & 0xff) | ||
58 : | #define XVID_API_MINOR(a) (((a)>> 0) & 0xff) | ||
59 : | |||
60 : | edgomez | 1226 | #define XVID_VERSION XVID_MAKE_VERSION(1,0,-127) |
61 : | edgomez | 1107 | #define XVID_API XVID_MAKE_API(4, 0) |
62 : | |||
63 : | suxen_drol | 890 | #define XVID_UNSTABLE |
64 : | |||
65 : | edgomez | 1161 | /* Bitstream Version |
66 : | * this will be writen into the bitstream to allow easy detection of xvid | ||
67 : | * encoder bugs in the decoder, without this it might not possible to | ||
68 : | * automatically distinquish between a file which has been encoded with an | ||
69 : | edgomez | 851 | * old & buggy XVID from a file which has been encoded with a bugfree version |
70 : | * see the infamous interlacing bug ... | ||
71 : | * | ||
72 : | * this MUST be increased if an encoder bug is fixed, increasing it too often | ||
73 : | * doesnt hurt but not increasing it could cause difficulty for decoders in the | ||
74 : | * future | ||
75 : | edgomez | 608 | */ |
76 : | edgomez | 1259 | #define XVID_BS_VERSION "0024" |
77 : | edgomez | 199 | |
78 : | |||
79 : | suxen_drol | 890 | /***************************************************************************** |
80 : | * error codes | ||
81 : | ****************************************************************************/ | ||
82 : | edgomez | 199 | |
83 : | edgomez | 1107 | /* all functions return values <0 indicate error */ |
84 : | edgomez | 199 | |
85 : | suxen_drol | 890 | #define XVID_ERR_FAIL -1 /* general fault */ |
86 : | edgomez | 1107 | #define XVID_ERR_MEMORY -2 /* memory allocation error */ |
87 : | #define XVID_ERR_FORMAT -3 /* file format error */ | ||
88 : | suxen_drol | 890 | #define XVID_ERR_VERSION -4 /* structure version not supported */ |
89 : | #define XVID_ERR_END -5 /* encoder only; end of stream reached */ | ||
90 : | edgomez | 199 | |
91 : | |||
92 : | edgomez | 608 | |
93 : | suxen_drol | 890 | /***************************************************************************** |
94 : | * xvid_image_t | ||
95 : | ****************************************************************************/ | ||
96 : | edgomez | 608 | |
97 : | suxen_drol | 890 | /* colorspace values */ |
98 : | edgomez | 608 | |
99 : | chl | 1244 | #define XVID_CSP_USER (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */ |
100 : | #define XVID_CSP_I420 (1<< 1) /* 4:2:0 planar */ | ||
101 : | #define XVID_CSP_YV12 (1<< 2) /* 4:2:0 planar */ | ||
102 : | edgomez | 1107 | #define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
103 : | #define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ | ||
104 : | #define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ | ||
105 : | #define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ | ||
106 : | #define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ | ||
107 : | #define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ | ||
108 : | #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 : | edgomez | 608 | |
116 : | suxen_drol | 890 | /* 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 : | suxen_drol | 1014 | /* video-object-sequence profiles */ |
126 : | edgomez | 1107 | #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 : | suxen_drol | 890 | |
140 : | /* aspect ratios */ | ||
141 : | edgomez | 1259 | #define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if supplied PAR is not a valid value */ |
142 : | edgomez | 1107 | #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 : | suxen_drol | 890 | |
148 : | /* frame type flags */ | ||
149 : | edgomez | 1107 | #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 : | suxen_drol | 890 | |
157 : | suxen_drol | 1014 | |
158 : | edgomez | 199 | /***************************************************************************** |
159 : | suxen_drol | 890 | * xvid_global() |
160 : | edgomez | 199 | ****************************************************************************/ |
161 : | |||
162 : | edgomez | 1176 | /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */ |
163 : | edgomez | 199 | |
164 : | edgomez | 1107 | #define XVID_CPU_FORCE (1<<31) /* force passed cpu flags */ |
165 : | #define XVID_CPU_ASM (1<< 7) /* native assembly */ | ||
166 : | edgomez | 851 | /* ARCH_IS_IA32 */ |
167 : | edgomez | 1107 | #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 : | edgomez | 851 | /* ARCH_IS_PPC */ |
175 : | edgomez | 1107 | #define XVID_CPU_ALTIVEC (1<< 0) /* altivec */ |
176 : | edgomez | 199 | |
177 : | Isibaar | 209 | |
178 : | edgomez | 1107 | #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 : | suxen_drol | 1031 | |
188 : | suxen_drol | 890 | /* XVID_GBL_INIT param1 */ |
189 : | typedef struct { | ||
190 : | int version; | ||
191 : | chl | 1115 | unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */ |
192 : | edgomez | 1107 | int debug; /* [in:opt] debug level */ |
193 : | suxen_drol | 890 | } xvid_gbl_init_t; |
194 : | edgomez | 199 | |
195 : | |||
196 : | suxen_drol | 890 | /* XVID_GBL_INFO param1 */ |
197 : | typedef struct { | ||
198 : | int version; | ||
199 : | edgomez | 1107 | 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 : | chl | 1115 | unsigned int cpu_flags; /* [out] detected cpu features */ |
202 : | edgomez | 1107 | int num_threads; /* [out] detected number of cpus/threads */ |
203 : | suxen_drol | 890 | } xvid_gbl_info_t; |
204 : | Isibaar | 209 | |
205 : | edgomez | 199 | |
206 : | suxen_drol | 890 | /* XVID_GBL_CONVERT param1 */ |
207 : | typedef struct { | ||
208 : | int version; | ||
209 : | edgomez | 1107 | 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 : | suxen_drol | 890 | } xvid_gbl_convert_t; |
215 : | edgomez | 851 | |
216 : | edgomez | 199 | |
217 : | edgomez | 1107 | #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 : | edgomez | 199 | |
221 : | suxen_drol | 890 | int xvid_global(void *handle, int opt, void *param1, void *param2); |
222 : | edgomez | 199 | |
223 : | |||
224 : | /***************************************************************************** | ||
225 : | suxen_drol | 890 | * xvid_decore() |
226 : | edgomez | 199 | ****************************************************************************/ |
227 : | |||
228 : | edgomez | 1107 | #define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
229 : | #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ | ||
230 : | #define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ | ||
231 : | edgomez | 199 | |
232 : | suxen_drol | 890 | int xvid_decore(void *handle, int opt, void *param1, void *param2); |
233 : | edgomez | 199 | |
234 : | edgomez | 1161 | /* XVID_DEC_CREATE param 1 |
235 : | suxen_drol | 890 | image width & height may be specified here when the dimensions are |
236 : | known in advance. */ | ||
237 : | typedef struct { | ||
238 : | int version; | ||
239 : | edgomez | 1107 | int width; /* [in:opt] image width */ |
240 : | int height; /* [in:opt] image width */ | ||
241 : | void * handle; /* [out] decore context handle */ | ||
242 : | suxen_drol | 890 | } xvid_dec_create_t; |
243 : | edgomez | 851 | |
244 : | |||
245 : | suxen_drol | 890 | /* XVID_DEC_DECODE param1 */ |
246 : | /* general flags */ | ||
247 : | edgomez | 1107 | #define XVID_LOWDELAY (1<<0) /* lowdelay mode */ |
248 : | #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ | ||
249 : | edgomez | 1253 | #define XVID_DEBLOCKY (1<<2) /* perform luma deblocking */ |
250 : | Isibaar | 1251 | #define XVID_DEBLOCKUV (1<<3) /* perform chroma deblocking */ |
251 : | edgomez | 851 | |
252 : | suxen_drol | 890 | typedef struct { |
253 : | int version; | ||
254 : | edgomez | 1107 | int general; /* [in:opt] general flags */ |
255 : | void *bitstream; /* [in] bitstream (read from)*/ | ||
256 : | int length; /* [in] bitstream length */ | ||
257 : | xvid_image_t output; /* [in] output image (written to) */ | ||
258 : | } xvid_dec_frame_t; | ||
259 : | edgomez | 199 | |
260 : | |||
261 : | suxen_drol | 890 | /* XVID_DEC_DECODE param2 :: optional */ |
262 : | typedef struct | ||
263 : | { | ||
264 : | int version; | ||
265 : | edgomez | 1107 | |
266 : | int type; /* [out] output data type */ | ||
267 : | suxen_drol | 890 | union { |
268 : | edgomez | 1107 | struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ |
269 : | int general; /* [out] flags */ | ||
270 : | int time_base; /* [out] time base */ | ||
271 : | int time_increment; /* [out] time increment */ | ||
272 : | edgomez | 199 | |
273 : | suxen_drol | 890 | /* XXX: external deblocking stuff */ |
274 : | edgomez | 1107 | int * qscale; /* [out] pointer to quantizer table */ |
275 : | int qscale_stride; /* [out] quantizer scale stride */ | ||
276 : | edgomez | 199 | |
277 : | suxen_drol | 890 | } vop; |
278 : | struct { /* XVID_TYPE_VOL */ | ||
279 : | edgomez | 1107 | int general; /* [out] flags */ |
280 : | int width; /* [out] width */ | ||
281 : | int height; /* [out] height */ | ||
282 : | chl | 1243 | int par; /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
283 : | edgomez | 1259 | int par_width; /* [out] aspect ratio width [1..255] */ |
284 : | int par_height; /* [out] aspect ratio height [1..255] */ | ||
285 : | suxen_drol | 890 | } vol; |
286 : | } data; | ||
287 : | } xvid_dec_stats_t; | ||
288 : | albeu | 315 | |
289 : | |||
290 : | suxen_drol | 1014 | |
291 : | edgomez | 1107 | #define XVID_ZONE_QUANT (1<<0) |
292 : | #define XVID_ZONE_WEIGHT (1<<1) | ||
293 : | |||
294 : | suxen_drol | 1014 | typedef struct |
295 : | { | ||
296 : | edgomez | 1107 | int frame; |
297 : | int mode; | ||
298 : | int increment; | ||
299 : | int base; | ||
300 : | suxen_drol | 1014 | } xvid_enc_zone_t; |
301 : | |||
302 : | |||
303 : | |||
304 : | suxen_drol | 919 | /***************************************************************************** |
305 : | xvid plugin system -- internals | ||
306 : | edgomez | 199 | |
307 : | suxen_drol | 919 | xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE |
308 : | before encoding each frame xvidcore will call XVID_PLG_BEFORE | ||
309 : | after encoding each frame xvidcore will call XVID_PLG_AFTER | ||
310 : | xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY | ||
311 : | ****************************************************************************/ | ||
312 : | |||
313 : | suxen_drol | 1014 | |
314 : | edgomez | 1107 | #define XVID_PLG_CREATE (1<<0) |
315 : | #define XVID_PLG_DESTROY (1<<1) | ||
316 : | #define XVID_PLG_INFO (1<<2) | ||
317 : | #define XVID_PLG_BEFORE (1<<3) | ||
318 : | syskin | 1216 | #define XVID_PLG_FRAME (1<<4) |
319 : | #define XVID_PLG_AFTER (1<<5) | ||
320 : | suxen_drol | 919 | |
321 : | /* xvid_plg_info_t.flags */ | ||
322 : | edgomez | 1107 | #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
323 : | #define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ | ||
324 : | #define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ | ||
325 : | suxen_drol | 919 | |
326 : | |||
327 : | typedef struct | ||
328 : | { | ||
329 : | edgomez | 1107 | int version; |
330 : | int flags; /* [in:opt] plugin flags */ | ||
331 : | suxen_drol | 919 | } xvid_plg_info_t; |
332 : | |||
333 : | |||
334 : | typedef struct | ||
335 : | { | ||
336 : | edgomez | 1107 | int version; |
337 : | suxen_drol | 919 | |
338 : | edgomez | 1107 | int num_zones; /* [out] */ |
339 : | xvid_enc_zone_t * zones; /* [out] */ | ||
340 : | suxen_drol | 919 | |
341 : | edgomez | 1107 | int width; /* [out] */ |
342 : | int height; /* [out] */ | ||
343 : | int mb_width; /* [out] */ | ||
344 : | int mb_height; /* [out] */ | ||
345 : | int fincr; /* [out] */ | ||
346 : | int fbase; /* [out] */ | ||
347 : | suxen_drol | 1014 | |
348 : | edgomez | 1107 | void * param; /* [out] */ |
349 : | suxen_drol | 919 | } xvid_plg_create_t; |
350 : | |||
351 : | |||
352 : | typedef struct | ||
353 : | { | ||
354 : | edgomez | 1107 | int version; |
355 : | suxen_drol | 919 | |
356 : | edgomez | 1107 | int num_frames; /* [out] total frame encoded */ |
357 : | suxen_drol | 938 | } xvid_plg_destroy_t; |
358 : | |||
359 : | |||
360 : | typedef struct | ||
361 : | { | ||
362 : | edgomez | 1107 | int version; |
363 : | suxen_drol | 938 | |
364 : | edgomez | 1107 | xvid_enc_zone_t * zone; /* [out] current zone */ |
365 : | edgomez | 1161 | |
366 : | edgomez | 1107 | int width; /* [out] */ |
367 : | int height; /* [out] */ | ||
368 : | int mb_width; /* [out] */ | ||
369 : | int mb_height; /* [out] */ | ||
370 : | suxen_drol | 920 | int fincr; /* [out] */ |
371 : | edgomez | 1107 | int fbase; /* [out] */ |
372 : | suxen_drol | 1014 | |
373 : | edgomez | 1107 | int min_quant[3]; /* [out] */ |
374 : | int max_quant[3]; /* [out] */ | ||
375 : | edgomez | 1161 | |
376 : | edgomez | 1107 | xvid_image_t reference; /* [out] -> [out] */ |
377 : | xvid_image_t current; /* [out] -> [in,out] */ | ||
378 : | xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ | ||
379 : | int frame_num; /* [out] frame number */ | ||
380 : | suxen_drol | 919 | |
381 : | edgomez | 1107 | int type; /* [in,out] */ |
382 : | int quant; /* [in,out] */ | ||
383 : | suxen_drol | 920 | |
384 : | edgomez | 1107 | int * dquant; /* [in,out] pointer to diff quantizer table */ |
385 : | int dquant_stride; /* [in,out] diff quantizer stride */ | ||
386 : | suxen_drol | 919 | |
387 : | edgomez | 1107 | int vop_flags; /* [in,out] */ |
388 : | int vol_flags; /* [in,out] */ | ||
389 : | int motion_flags; /* [in,out] */ | ||
390 : | suxen_drol | 919 | |
391 : | edgomez | 1107 | int length; /* [out] after: length of encoded frame */ |
392 : | int kblks; /* [out] number of blocks compressed as Intra */ | ||
393 : | int mblks; /* [out] number of blocks compressed as Inter */ | ||
394 : | int ublks; /* [out] number of blocks marked not_coded */ | ||
395 : | int sse_y; /* [out] Y plane's sse */ | ||
396 : | int sse_u; /* [out] U plane's sse */ | ||
397 : | int sse_v; /* [out] V plane's sse */ | ||
398 : | edgomez | 1202 | int bquant_ratio; /* [in] */ |
399 : | int bquant_offset; /* [in] */ | ||
400 : | suxen_drol | 919 | } xvid_plg_data_t; |
401 : | |||
402 : | |||
403 : | edgomez | 851 | /***************************************************************************** |
404 : | suxen_drol | 919 | xvid plugin system -- external |
405 : | |||
406 : | the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array | ||
407 : | indicates the plugin function pointer and plugin-specific data. | ||
408 : | xvidcore handles the rest. example: | ||
409 : | |||
410 : | xvid_enc_create_t create; | ||
411 : | xvid_enc_plugin_t plugins[2]; | ||
412 : | |||
413 : | plugins[0].func = xvid_psnr_func; | ||
414 : | plugins[0].param = NULL; | ||
415 : | plugins[1].func = xvid_cbr_func; | ||
416 : | plugins[1].param = &cbr_data; | ||
417 : | edgomez | 1161 | |
418 : | suxen_drol | 919 | create.num_plugins = 2; |
419 : | create.plugins = plugins; | ||
420 : | |||
421 : | ****************************************************************************/ | ||
422 : | |||
423 : | typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); | ||
424 : | |||
425 : | typedef struct | ||
426 : | { | ||
427 : | edgomez | 1107 | xvid_plugin_func * func; |
428 : | void * param; | ||
429 : | suxen_drol | 919 | } xvid_enc_plugin_t; |
430 : | |||
431 : | suxen_drol | 938 | |
432 : | suxen_drol | 1014 | xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
433 : | xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ | ||
434 : | xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ | ||
435 : | suxen_drol | 938 | |
436 : | xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ | ||
437 : | |||
438 : | edgomez | 1107 | xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
439 : | xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ | ||
440 : | suxen_drol | 919 | |
441 : | |||
442 : | edgomez | 1107 | /* single pass rate control |
443 : | * CBR and Constant quantizer modes */ | ||
444 : | typedef struct | ||
445 : | suxen_drol | 938 | { |
446 : | edgomez | 1107 | int version; |
447 : | |||
448 : | int bitrate; /* [in] bits per second */ | ||
449 : | int reaction_delay_factor; /* [in] */ | ||
450 : | int averaging_period; /* [in] */ | ||
451 : | int buffer; /* [in] */ | ||
452 : | suxen_drol | 1014 | } xvid_plugin_single_t; |
453 : | suxen_drol | 938 | |
454 : | |||
455 : | typedef struct { | ||
456 : | edgomez | 1107 | int version; |
457 : | |||
458 : | char * filename; | ||
459 : | suxen_drol | 938 | } xvid_plugin_2pass1_t; |
460 : | |||
461 : | |||
462 : | edgomez | 1107 | #define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
463 : | #define XVID_PAYBACK_PROP 1 /* payback proportionally */ | ||
464 : | suxen_drol | 938 | |
465 : | suxen_drol | 942 | typedef struct { |
466 : | edgomez | 1107 | int version; |
467 : | |||
468 : | int bitrate; /* [in] bits per second */ | ||
469 : | char * filename; /* [in] first pass stats filename */ | ||
470 : | edgomez | 1161 | |
471 : | edgomez | 1107 | int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
472 : | int curve_compression_high; /* [in] percentage of compression performed on the high part of the curve (above average) */ | ||
473 : | int curve_compression_low; /* [in] percentage of compression performed on the low part of the curve (below average) */ | ||
474 : | edgomez | 1202 | int overflow_control_strength;/* [in] Payback delay expressed in number of frames */ |
475 : | int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */ | ||
476 : | int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */ | ||
477 : | suxen_drol | 942 | |
478 : | edgomez | 1242 | int kfreduction; /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */ |
479 : | int kfthreshold; /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits | ||
480 : | * is substracted from its bit allocation. The reduction is computed as multiples of | ||
481 : | * kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold, | ||
482 : | * 0 for 1<distance<kfthreshold */ | ||
483 : | edgomez | 1041 | |
484 : | edgomez | 1107 | int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
485 : | suxen_drol | 942 | }xvid_plugin_2pass2_t; |
486 : | |||
487 : | |||
488 : | suxen_drol | 919 | /***************************************************************************** |
489 : | suxen_drol | 890 | * xvid_encore() |
490 : | edgomez | 851 | ****************************************************************************/ |
491 : | edgomez | 199 | |
492 : | suxen_drol | 890 | /* Encoder options */ |
493 : | edgomez | 1107 | #define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
494 : | #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ | ||
495 : | #define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes | ||
496 : | * 0 means this frame should not be written (ie. encoder lag) */ | ||
497 : | edgomez | 199 | |
498 : | suxen_drol | 890 | int xvid_encore(void *handle, int opt, void *param1, void *param2); |
499 : | edgomez | 199 | |
500 : | |||
501 : | |||
502 : | edgomez | 1107 | /* Global Flags */ |
503 : | #define XVID_GLOBAL_PACKED (1<<0) /* packed bitstream */ | ||
504 : | #define XVID_GLOBAL_CLOSED_GOP (1<<1) /* closed_gop: was DX50BVOP dx50 bvop compatibility */ | ||
505 : | #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2) | ||
506 : | #if 0 | ||
507 : | #define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ | ||
508 : | #define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ | ||
509 : | #endif | ||
510 : | edgomez | 199 | |
511 : | edgomez | 1107 | |
512 : | suxen_drol | 890 | /* XVID_ENC_ENCODE param1 */ |
513 : | /* vol-based flags */ | ||
514 : | edgomez | 1107 | #define XVID_VOL_MPEGQUANT (1<<0) /* enable MPEG type quantization */ |
515 : | #define XVID_VOL_EXTRASTATS (1<<1) /* enable plane sse stats */ | ||
516 : | #define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ | ||
517 : | #define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ | ||
518 : | #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ | ||
519 : | #define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ | ||
520 : | edgomez | 199 | |
521 : | |||
522 : | suxen_drol | 920 | |
523 : | edgomez | 1107 | /* vop based flags */ |
524 : | #define XVID_VOP_DEBUG (1<< 0) | ||
525 : | #define XVID_VOP_HALFPEL (1<< 1) /* use halfpel interpolation */ | ||
526 : | #define XVID_VOP_INTER4V (1<< 2) | ||
527 : | #define XVID_VOP_TRELLISQUANT (1<< 3) /* use trellis based R-D "optimal" quantization */ | ||
528 : | #define XVID_VOP_CHROMAOPT (1<< 4) /* enable chroma optimization pre-filter */ | ||
529 : | #define XVID_VOP_CARTOON (1<< 5) /* use 'cartoon mode' */ | ||
530 : | #define XVID_VOP_GREYSCALE (1<< 6) /* enable greyscale only mode (even for color input material chroma is ignored) */ | ||
531 : | #define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ | ||
532 : | #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ | ||
533 : | /* only valid for vol_flags|=XVID_VOL_INTERLACING */ | ||
534 : | #define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ | ||
535 : | #define XVID_VOP_ALTERNATESCAN (1<<10) /* set alternate vertical scan flag */ | ||
536 : | /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ | ||
537 : | #define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ | ||
538 : | chl | 993 | |
539 : | Isibaar | 1138 | #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */ |
540 : | edgomez | 199 | |
541 : | |||
542 : | Isibaar | 1095 | |
543 : | edgomez | 1107 | /* Motion based flags */ |
544 : | #define XVID_ME_ADVANCEDDIAMOND16 (1<< 0) /* use advdiamonds instead of diamonds as search pattern */ | ||
545 : | #define XVID_ME_ADVANCEDDIAMOND8 (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */ | ||
546 : | #define XVID_ME_USESQUARES16 (1<< 2) /* use squares instead of diamonds as search pattern */ | ||
547 : | #define XVID_ME_USESQUARES8 (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */ | ||
548 : | edgomez | 1161 | #define XVID_ME_HALFPELREFINE16 (1<< 4) |
549 : | #define XVID_ME_HALFPELREFINE8 (1<< 6) | ||
550 : | #define XVID_ME_QUARTERPELREFINE16 (1<< 7) | ||
551 : | #define XVID_ME_QUARTERPELREFINE8 (1<< 8) | ||
552 : | #define XVID_ME_GME_REFINE (1<< 9) | ||
553 : | edgomez | 1107 | #define XVID_ME_EXTSEARCH16 (1<<10) /* extend PMV by more searches */ |
554 : | #define XVID_ME_EXTSEARCH8 (1<<11) /* use diamond/square for extended 8x8 search */ | ||
555 : | #define XVID_ME_CHROMA_PVOP (1<<12) /* also use chroma for P_VOP/S_VOP ME */ | ||
556 : | #define XVID_ME_CHROMA_BVOP (1<<13) /* also use chroma for B_VOP ME */ | ||
557 : | Isibaar | 1095 | |
558 : | edgomez | 1107 | /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */ |
559 : | syskin | 1150 | #define XVID_ME_HALFPELREFINE16_RD (1<<14) /* perform RD-based halfpel refinement */ |
560 : | #define XVID_ME_HALFPELREFINE8_RD (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */ | ||
561 : | #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */ | ||
562 : | #define XVID_ME_QUARTERPELREFINE8_RD (1<<17) /* perform RD-based qpel refinement for 8x8 mode */ | ||
563 : | #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 */ | ||
564 : | edgomez | 1107 | #define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */ |
565 : | edgomez | 853 | |
566 : | edgomez | 1107 | #define XVID_ME_UNRESTRICTED16 (1<<20) /* unrestricted ME, not implemented */ |
567 : | #define XVID_ME_OVERLAPPING16 (1<<21) /* overlapping ME, not implemented */ | ||
568 : | #define XVID_ME_UNRESTRICTED8 (1<<22) /* unrestricted ME, not implemented */ | ||
569 : | #define XVID_ME_OVERLAPPING8 (1<<23) /* overlapping ME, not implemented */ | ||
570 : | edgomez | 199 | |
571 : | Isibaar | 1136 | #define XVID_ME_DETECT_STATIC_MOTION (1<<24) /* speed-up ME by detecting stationary scenes */ |
572 : | #define XVID_ME_FASTREFINE16 (1<<25) /* use low-complexity refinement functions */ | ||
573 : | chl | 352 | |
574 : | suxen_drol | 890 | /* XVID_ENC_CREATE param1 */ |
575 : | typedef struct { | ||
576 : | int version; | ||
577 : | suxen_drol | 1014 | |
578 : | edgomez | 1107 | int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */ |
579 : | int width; /* [in] frame dimensions; width, pixel units */ | ||
580 : | int height; /* [in] frame dimensions; height, pixel units */ | ||
581 : | edgomez | 851 | |
582 : | edgomez | 1107 | int num_zones; /* [in:opt] number of bitrate zones */ |
583 : | xvid_enc_zone_t * zones; /* ^^ zone array */ | ||
584 : | suxen_drol | 1014 | |
585 : | edgomez | 1107 | int num_plugins; /* [in:opt] number of plugins */ |
586 : | xvid_enc_plugin_t * plugins; /* ^^ plugin array */ | ||
587 : | suxen_drol | 919 | |
588 : | edgomez | 1107 | int num_threads; /* [in:opt] number of threads */ |
589 : | int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ | ||
590 : | edgomez | 851 | |
591 : | edgomez | 1107 | int global; /* [in:opt] global flags; controls encoding behavior */ |
592 : | edgomez | 851 | |
593 : | edgomez | 1107 | /* --- vol-based stuff; included here for convenience */ |
594 : | int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ | ||
595 : | int fbase; /* [in] framerate base frame_duration = fincr/fbase seconds*/ | ||
596 : | /* ---------------------------------------------- */ | ||
597 : | edgomez | 851 | |
598 : | edgomez | 1107 | /* --- vop-based; included here for convenience */ |
599 : | int max_key_interval; /* [in:opt] the maximum interval between key frames */ | ||
600 : | edgomez | 851 | |
601 : | edgomez | 1107 | int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
602 : | edgomez | 851 | |
603 : | edgomez | 1107 | int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
604 : | int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ | ||
605 : | edgomez | 851 | |
606 : | edgomez | 1107 | int min_quant[3]; /* [in:opt] */ |
607 : | int max_quant[3]; /* [in:opt] */ | ||
608 : | /* ---------------------------------------------- */ | ||
609 : | edgomez | 851 | |
610 : | edgomez | 1107 | void *handle; /* [out] encoder instance handle */ |
611 : | suxen_drol | 890 | } |
612 : | xvid_enc_create_t; | ||
613 : | edgomez | 851 | |
614 : | |||
615 : | edgomez | 1107 | #define XVID_KEYFRAME (1<<1) |
616 : | edgomez | 199 | |
617 : | suxen_drol | 890 | typedef struct { |
618 : | int version; | ||
619 : | edgomez | 199 | |
620 : | edgomez | 1107 | /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any changes here until the next VOL (keyframe). */ |
621 : | int vol_flags; /* [in] vol flags */ | ||
622 : | unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */ | ||
623 : | unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */ | ||
624 : | edgomez | 199 | |
625 : | chl | 1243 | int par; /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
626 : | edgomez | 1107 | int par_width; /* [in:opt] aspect ratio width */ |
627 : | int par_height; /* [in:opt] aspect ratio height */ | ||
628 : | /* ---------------------------------------------- */ | ||
629 : | edgomez | 199 | |
630 : | edgomez | 1107 | int fincr; /* [in:opt] framerate increment, for variable framerate only */ |
631 : | int vop_flags; /* [in] (general)vop-based flags */ | ||
632 : | int motion; /* [in] ME options */ | ||
633 : | edgomez | 851 | |
634 : | edgomez | 1107 | xvid_image_t input; /* [in] input image (read from) */ |
635 : | edgomez | 1161 | |
636 : | edgomez | 1107 | int type; /* [in:opt] coding type */ |
637 : | int quant; /* [in] frame quantizer; if <=0, automatic (ratecontrol) */ | ||
638 : | edgomez | 953 | int bframe_threshold; |
639 : | edgomez | 851 | |
640 : | edgomez | 1107 | void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
641 : | int length; /* [in:opt] bitstream length (bytes) */ | ||
642 : | edgomez | 851 | |
643 : | edgomez | 1107 | int out_flags; /* [out] bitstream output flags */ |
644 : | } xvid_enc_frame_t; | ||
645 : | edgomez | 199 | |
646 : | |||
647 : | suxen_drol | 890 | /* XVID_ENC_ENCODE param2 (optional) |
648 : | edgomez | 1161 | xvid_enc_stats_t describes individual frame details |
649 : | |||
650 : | coding_type==XVID_TYPE_NOTHING if the stats are not given | ||
651 : | suxen_drol | 890 | */ |
652 : | typedef struct { | ||
653 : | int version; | ||
654 : | edgomez | 199 | |
655 : | suxen_drol | 890 | /* encoding parameters */ |
656 : | edgomez | 1107 | int type; /* [out] coding type */ |
657 : | int quant; /* [out] frame quantizer */ | ||
658 : | int vol_flags; /* [out] vol flags (see above) */ | ||
659 : | int vop_flags; /* [out] vop flags (see above) */ | ||
660 : | |||
661 : | suxen_drol | 890 | /* bitrate */ |
662 : | edgomez | 1107 | int length; /* [out] frame length */ |
663 : | edgomez | 199 | |
664 : | edgomez | 1107 | int hlength; /* [out] header length (bytes) */ |
665 : | int kblks; /* [out] number of blocks compressed as Intra */ | ||
666 : | int mblks; /* [out] number of blocks compressed as Inter */ | ||
667 : | int ublks; /* [out] number of blocks marked as not_coded */ | ||
668 : | edgomez | 199 | |
669 : | edgomez | 1107 | int sse_y; /* [out] Y plane's sse */ |
670 : | int sse_u; /* [out] U plane's sse */ | ||
671 : | int sse_v; /* [out] V plane's sse */ | ||
672 : | } xvid_enc_stats_t; | ||
673 : | edgomez | 199 | |
674 : | #ifdef __cplusplus | ||
675 : | } | ||
676 : | #endif | ||
677 : | |||
678 : | suxen_drol | 919 | |
679 : | edgomez | 199 | #endif |
No admin address has been configured | ViewVC Help |
Powered by ViewVC 1.0.4 |