Parent Directory | Revision Log
Revision 1155 - (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 | 1155 | * $Id: xvid.h,v 1.27.2.37 2003-09-28 13:43:47 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 : | XVID_UNSTABLE is defined only during development. | ||
49 : | */ | ||
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 : | #define XVID_VERSION XVID_MAKE_VERSION(1,-127,0) | ||
61 : | #define XVID_API XVID_MAKE_API(4, 0) | ||
62 : | |||
63 : | suxen_drol | 890 | #define XVID_UNSTABLE |
64 : | |||
65 : | edgomez | 851 | /* 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 : | * 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 : | syskin | 1150 | #define XVID_BS_VERSION "0019" |
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 : | edgomez | 1107 | #define XVID_CSP_USER (1<< 0) /* 4:2:0 planar */ |
100 : | #define XVID_CSP_I420 (1<< 1) /* 4:2:0 packed(planar win32) */ | ||
101 : | #define XVID_CSP_YV12 (1<< 2) /* 4:2:0 packed(planar win32) */ | ||
102 : | #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 | 1131 | #define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if AR is not precised (ie: ==0) */ |
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 : | suxen_drol | 890 | /* cpu_flags definitions */ |
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 : | #define XVID_GBL_TEST 3 /* testing.. */ | ||
221 : | edgomez | 199 | |
222 : | suxen_drol | 890 | int xvid_global(void *handle, int opt, void *param1, void *param2); |
223 : | edgomez | 199 | |
224 : | |||
225 : | /***************************************************************************** | ||
226 : | suxen_drol | 890 | * xvid_decore() |
227 : | edgomez | 199 | ****************************************************************************/ |
228 : | |||
229 : | edgomez | 1107 | #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 : | #define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ | ||
232 : | edgomez | 199 | |
233 : | suxen_drol | 890 | int xvid_decore(void *handle, int opt, void *param1, void *param2); |
234 : | edgomez | 199 | |
235 : | edgomez | 1107 | /* XVID_DEC_CREATE param 1 |
236 : | suxen_drol | 890 | image width & height may be specified here when the dimensions are |
237 : | known in advance. */ | ||
238 : | typedef struct { | ||
239 : | int version; | ||
240 : | edgomez | 1107 | int width; /* [in:opt] image width */ |
241 : | int height; /* [in:opt] image width */ | ||
242 : | void * handle; /* [out] decore context handle */ | ||
243 : | suxen_drol | 890 | } xvid_dec_create_t; |
244 : | edgomez | 851 | |
245 : | |||
246 : | suxen_drol | 890 | /* XVID_DEC_DECODE param1 */ |
247 : | /* general flags */ | ||
248 : | edgomez | 1107 | #define XVID_LOWDELAY (1<<0) /* lowdelay mode */ |
249 : | #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ | ||
250 : | edgomez | 851 | |
251 : | suxen_drol | 890 | typedef struct { |
252 : | int version; | ||
253 : | edgomez | 1107 | 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 : | edgomez | 199 | |
259 : | |||
260 : | suxen_drol | 890 | /* XVID_DEC_DECODE param2 :: optional */ |
261 : | typedef struct | ||
262 : | { | ||
263 : | int version; | ||
264 : | edgomez | 1107 | |
265 : | int type; /* [out] output data type */ | ||
266 : | suxen_drol | 890 | union { |
267 : | edgomez | 1107 | 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 */ | ||
270 : | int time_increment; /* [out] time increment */ | ||
271 : | edgomez | 199 | |
272 : | suxen_drol | 890 | /* XXX: external deblocking stuff */ |
273 : | edgomez | 1107 | int * qscale; /* [out] pointer to quantizer table */ |
274 : | int qscale_stride; /* [out] quantizer scale stride */ | ||
275 : | edgomez | 199 | |
276 : | suxen_drol | 890 | } vop; |
277 : | struct { /* XVID_TYPE_VOL */ | ||
278 : | edgomez | 1107 | int general; /* [out] flags */ |
279 : | int width; /* [out] width */ | ||
280 : | int height; /* [out] height */ | ||
281 : | int par; /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */ | ||
282 : | int par_width; /* [out] aspect ratio width */ | ||
283 : | int par_height; /* [out] aspect ratio height */ | ||
284 : | suxen_drol | 890 | } vol; |
285 : | } data; | ||
286 : | } xvid_dec_stats_t; | ||
287 : | albeu | 315 | |
288 : | |||
289 : | suxen_drol | 1014 | |
290 : | edgomez | 1107 | #define XVID_ZONE_QUANT (1<<0) |
291 : | #define XVID_ZONE_WEIGHT (1<<1) | ||
292 : | |||
293 : | suxen_drol | 1014 | typedef struct |
294 : | { | ||
295 : | edgomez | 1107 | int frame; |
296 : | int mode; | ||
297 : | int increment; | ||
298 : | int base; | ||
299 : | suxen_drol | 1014 | } xvid_enc_zone_t; |
300 : | |||
301 : | |||
302 : | |||
303 : | suxen_drol | 919 | /***************************************************************************** |
304 : | xvid plugin system -- internals | ||
305 : | edgomez | 199 | |
306 : | suxen_drol | 919 | 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 : | |||
312 : | suxen_drol | 1014 | |
313 : | edgomez | 1107 | #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 : | suxen_drol | 919 | |
319 : | /* xvid_plg_info_t.flags */ | ||
320 : | edgomez | 1107 | #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 : | suxen_drol | 919 | |
324 : | |||
325 : | typedef struct | ||
326 : | { | ||
327 : | edgomez | 1107 | int version; |
328 : | int flags; /* [in:opt] plugin flags */ | ||
329 : | suxen_drol | 919 | } xvid_plg_info_t; |
330 : | |||
331 : | |||
332 : | typedef struct | ||
333 : | { | ||
334 : | edgomez | 1107 | int version; |
335 : | suxen_drol | 919 | |
336 : | edgomez | 1107 | int num_zones; /* [out] */ |
337 : | xvid_enc_zone_t * zones; /* [out] */ | ||
338 : | suxen_drol | 919 | |
339 : | edgomez | 1107 | 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 : | suxen_drol | 1014 | |
346 : | edgomez | 1107 | void * param; /* [out] */ |
347 : | suxen_drol | 919 | } xvid_plg_create_t; |
348 : | |||
349 : | |||
350 : | typedef struct | ||
351 : | { | ||
352 : | edgomez | 1107 | int version; |
353 : | suxen_drol | 919 | |
354 : | edgomez | 1107 | int num_frames; /* [out] total frame encoded */ |
355 : | suxen_drol | 938 | } xvid_plg_destroy_t; |
356 : | |||
357 : | |||
358 : | typedef struct | ||
359 : | { | ||
360 : | edgomez | 1107 | int version; |
361 : | suxen_drol | 938 | |
362 : | edgomez | 1107 | xvid_enc_zone_t * zone; /* [out] current zone */ |
363 : | |||
364 : | int width; /* [out] */ | ||
365 : | int height; /* [out] */ | ||
366 : | int mb_width; /* [out] */ | ||
367 : | int mb_height; /* [out] */ | ||
368 : | suxen_drol | 920 | int fincr; /* [out] */ |
369 : | edgomez | 1107 | int fbase; /* [out] */ |
370 : | suxen_drol | 1014 | |
371 : | edgomez | 1107 | 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 : | suxen_drol | 919 | |
379 : | edgomez | 1107 | int type; /* [in,out] */ |
380 : | int quant; /* [in,out] */ | ||
381 : | suxen_drol | 920 | |
382 : | edgomez | 1107 | int * dquant; /* [in,out] pointer to diff quantizer table */ |
383 : | int dquant_stride; /* [in,out] diff quantizer stride */ | ||
384 : | suxen_drol | 919 | |
385 : | edgomez | 1107 | int vop_flags; /* [in,out] */ |
386 : | int vol_flags; /* [in,out] */ | ||
387 : | int motion_flags; /* [in,out] */ | ||
388 : | suxen_drol | 919 | |
389 : | edgomez | 1107 | 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 : | suxen_drol | 919 | } xvid_plg_data_t; |
397 : | |||
398 : | |||
399 : | edgomez | 851 | /***************************************************************************** |
400 : | suxen_drol | 919 | 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 | ||
422 : | { | ||
423 : | edgomez | 1107 | xvid_plugin_func * func; |
424 : | void * param; | ||
425 : | suxen_drol | 919 | } xvid_enc_plugin_t; |
426 : | |||
427 : | suxen_drol | 938 | |
428 : | suxen_drol | 1014 | 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 : | suxen_drol | 938 | |
432 : | xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ | ||
433 : | |||
434 : | edgomez | 1107 | xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
435 : | xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ | ||
436 : | suxen_drol | 919 | |
437 : | |||
438 : | edgomez | 1107 | /* single pass rate control |
439 : | * CBR and Constant quantizer modes */ | ||
440 : | typedef struct | ||
441 : | suxen_drol | 938 | { |
442 : | edgomez | 1107 | int version; |
443 : | |||
444 : | int bitrate; /* [in] bits per second */ | ||
445 : | int reaction_delay_factor; /* [in] */ | ||
446 : | int averaging_period; /* [in] */ | ||
447 : | int buffer; /* [in] */ | ||
448 : | suxen_drol | 1014 | } xvid_plugin_single_t; |
449 : | suxen_drol | 938 | |
450 : | |||
451 : | typedef struct { | ||
452 : | edgomez | 1107 | int version; |
453 : | |||
454 : | char * filename; | ||
455 : | suxen_drol | 938 | } xvid_plugin_2pass1_t; |
456 : | |||
457 : | |||
458 : | edgomez | 1107 | #define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
459 : | #define XVID_PAYBACK_PROP 1 /* payback proportionally */ | ||
460 : | suxen_drol | 938 | |
461 : | suxen_drol | 942 | typedef struct { |
462 : | edgomez | 1107 | int version; |
463 : | |||
464 : | int bitrate; /* [in] bits per second */ | ||
465 : | char * filename; /* [in] first pass stats filename */ | ||
466 : | suxen_drol | 1014 | |
467 : | edgomez | 1107 | 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 : | suxen_drol | 942 | |
475 : | edgomez | 1107 | int kftreshold; /* [in] */ |
476 : | int kfreduction; /* [in] */ | ||
477 : | int min_key_interval; /* [in] Minimum interval of frames between two IFrames */ | ||
478 : | edgomez | 1041 | |
479 : | edgomez | 1107 | int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
480 : | suxen_drol | 942 | }xvid_plugin_2pass2_t; |
481 : | |||
482 : | |||
483 : | suxen_drol | 919 | /***************************************************************************** |
484 : | suxen_drol | 890 | * xvid_encore() |
485 : | edgomez | 851 | ****************************************************************************/ |
486 : | edgomez | 199 | |
487 : | suxen_drol | 890 | /* Encoder options */ |
488 : | edgomez | 1107 | #define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
489 : | #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ | ||
490 : | #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 : | edgomez | 199 | |
493 : | suxen_drol | 890 | int xvid_encore(void *handle, int opt, void *param1, void *param2); |
494 : | edgomez | 199 | |
495 : | |||
496 : | |||
497 : | edgomez | 1107 | /* 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 : | edgomez | 199 | |
506 : | edgomez | 1107 | |
507 : | suxen_drol | 890 | /* XVID_ENC_ENCODE param1 */ |
508 : | /* vol-based flags */ | ||
509 : | edgomez | 1107 | #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 : | edgomez | 199 | |
516 : | |||
517 : | suxen_drol | 920 | |
518 : | edgomez | 1107 | /* 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 : | chl | 993 | |
534 : | Isibaar | 1138 | #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */ |
535 : | edgomez | 199 | |
536 : | |||
537 : | Isibaar | 1095 | |
538 : | edgomez | 1107 | /* 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 : | Isibaar | 1095 | |
553 : | edgomez | 1107 | /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */ |
554 : | syskin | 1150 | #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 : | edgomez | 1107 | #define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */ |
560 : | edgomez | 853 | |
561 : | edgomez | 1107 | #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 : | edgomez | 199 | |
566 : | Isibaar | 1136 | #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 : | chl | 352 | |
569 : | suxen_drol | 890 | /* XVID_ENC_CREATE param1 */ |
570 : | typedef struct { | ||
571 : | int version; | ||
572 : | suxen_drol | 1014 | |
573 : | edgomez | 1107 | 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 : | edgomez | 851 | |
577 : | edgomez | 1107 | int num_zones; /* [in:opt] number of bitrate zones */ |
578 : | xvid_enc_zone_t * zones; /* ^^ zone array */ | ||
579 : | suxen_drol | 1014 | |
580 : | edgomez | 1107 | int num_plugins; /* [in:opt] number of plugins */ |
581 : | xvid_enc_plugin_t * plugins; /* ^^ plugin array */ | ||
582 : | suxen_drol | 919 | |
583 : | edgomez | 1107 | int num_threads; /* [in:opt] number of threads */ |
584 : | int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ | ||
585 : | edgomez | 851 | |
586 : | edgomez | 1107 | int global; /* [in:opt] global flags; controls encoding behavior */ |
587 : | edgomez | 851 | |
588 : | edgomez | 1107 | /* --- 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 : | edgomez | 851 | |
593 : | edgomez | 1107 | /* --- vop-based; included here for convenience */ |
594 : | int max_key_interval; /* [in:opt] the maximum interval between key frames */ | ||
595 : | edgomez | 851 | |
596 : | edgomez | 1107 | int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
597 : | edgomez | 851 | |
598 : | edgomez | 1107 | 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 : | edgomez | 851 | |
601 : | edgomez | 1107 | int min_quant[3]; /* [in:opt] */ |
602 : | int max_quant[3]; /* [in:opt] */ | ||
603 : | /* ---------------------------------------------- */ | ||
604 : | edgomez | 851 | |
605 : | edgomez | 1107 | void *handle; /* [out] encoder instance handle */ |
606 : | suxen_drol | 890 | } |
607 : | xvid_enc_create_t; | ||
608 : | edgomez | 851 | |
609 : | |||
610 : | edgomez | 1107 | #define XVID_KEYFRAME (1<<1) |
611 : | edgomez | 199 | |
612 : | suxen_drol | 890 | typedef struct { |
613 : | int version; | ||
614 : | edgomez | 199 | |
615 : | edgomez | 1107 | /* --- 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 : | edgomez | 199 | |
620 : | edgomez | 1107 | 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 : | edgomez | 199 | |
625 : | edgomez | 1107 | 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 : | edgomez | 851 | |
629 : | edgomez | 1107 | xvid_image_t input; /* [in] input image (read from) */ |
630 : | suxen_drol | 890 | |
631 : | edgomez | 1107 | int type; /* [in:opt] coding type */ |
632 : | int quant; /* [in] frame quantizer; if <=0, automatic (ratecontrol) */ | ||
633 : | edgomez | 953 | int bframe_threshold; |
634 : | edgomez | 851 | |
635 : | edgomez | 1107 | void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
636 : | int length; /* [in:opt] bitstream length (bytes) */ | ||
637 : | edgomez | 851 | |
638 : | edgomez | 1107 | int out_flags; /* [out] bitstream output flags */ |
639 : | } xvid_enc_frame_t; | ||
640 : | edgomez | 199 | |
641 : | |||
642 : | suxen_drol | 890 | /* 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 : | edgomez | 199 | |
650 : | suxen_drol | 890 | /* encoding parameters */ |
651 : | edgomez | 1107 | 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 : | suxen_drol | 890 | /* bitrate */ |
657 : | edgomez | 1107 | int length; /* [out] frame length */ |
658 : | edgomez | 199 | |
659 : | edgomez | 1107 | 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 : | edgomez | 199 | |
664 : | edgomez | 1107 | 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 : | edgomez | 199 | |
669 : | #ifdef __cplusplus | ||
670 : | } | ||
671 : | #endif | ||
672 : | |||
673 : | suxen_drol | 919 | |
674 : | edgomez | 199 | #endif |
No admin address has been configured | ViewVC Help |
Powered by ViewVC 1.0.4 |