Parent Directory | Revision Log
Revision 1059 - (view) (download)
1 : | edgomez | 199 | /***************************************************************************** |
2 : | edgomez | 868 | * |
3 : | * XVID MPEG-4 VIDEO CODEC | ||
4 : | * - XviD Main header file - | ||
5 : | * | ||
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 | 1059 | * $Id: xvid.h,v 1.27.2.24 2003-06-10 09:02:55 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 : | #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 : | edgomez | 851 | /* 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 : | edgomez | 608 | */ |
70 : | edgomez | 1058 | #define XVID_BS_VERSION "0011" |
71 : | edgomez | 199 | |
72 : | |||
73 : | suxen_drol | 890 | /***************************************************************************** |
74 : | * error codes | ||
75 : | ****************************************************************************/ | ||
76 : | edgomez | 199 | |
77 : | suxen_drol | 890 | /* all functions return values <0 indicate error */ |
78 : | edgomez | 199 | |
79 : | suxen_drol | 890 | #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 : | edgomez | 199 | |
85 : | |||
86 : | edgomez | 608 | |
87 : | suxen_drol | 890 | /***************************************************************************** |
88 : | * xvid_image_t | ||
89 : | ****************************************************************************/ | ||
90 : | edgomez | 608 | |
91 : | suxen_drol | 890 | /* colorspace values */ |
92 : | edgomez | 608 | |
93 : | suxen_drol | 890 | #define XVID_CSP_USER 0 /* 4:2:0 planar */ |
94 : | #define XVID_CSP_I420 1 /* 4:2:0 packed(planar win32) */ | ||
95 : | #define XVID_CSP_YV12 2 /* 4:2:0 packed(planar win32) */ | ||
96 : | #define XVID_CSP_YUY2 3 /* 4:2:2 packed */ | ||
97 : | #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 : | edgomez | 1059 | #define XVID_CSP_BGR 9 /* 24-bit bgr packed */ |
103 : | suxen_drol | 890 | #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 : | edgomez | 608 | |
110 : | suxen_drol | 890 | /* 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 : | suxen_drol | 1014 | /* video-object-sequence profiles */ |
120 : | #define XVID_PROFILE_S_L0 0x08 /* simple */ | ||
121 : | #define XVID_PROFILE_S_L1 0x01 | ||
122 : | #define XVID_PROFILE_S_L2 0x02 | ||
123 : | #define XVID_PROFILE_S_L3 0x03 | ||
124 : | #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ | ||
125 : | #define XVID_PROFILE_ARTS_L2 0x92 | ||
126 : | #define XVID_PROFILE_ARTS_L3 0x93 | ||
127 : | #define XVID_PROFILE_ARTS_L4 0x94 | ||
128 : | #define XVID_PROFILE_AS_L0 0xf0 /* advanced simple */ | ||
129 : | #define XVID_PROFILE_AS_L1 0xf1 | ||
130 : | #define XVID_PROFILE_AS_L2 0xf2 | ||
131 : | #define XVID_PROFILE_AS_L3 0xf3 | ||
132 : | #define XVID_PROFILE_AS_L4 0xf4 | ||
133 : | suxen_drol | 890 | |
134 : | /* aspect ratios */ | ||
135 : | #define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */ | ||
136 : | #define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ | ||
137 : | #define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ | ||
138 : | #define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ | ||
139 : | #define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */ | ||
140 : | #define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */ | ||
141 : | |||
142 : | /* frame type flags */ | ||
143 : | #define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */ | ||
144 : | #define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */ | ||
145 : | #define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */ | ||
146 : | #define XVID_TYPE_IVOP 1 /* intra frame */ | ||
147 : | #define XVID_TYPE_PVOP 2 /* predicted frame */ | ||
148 : | #define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ | ||
149 : | #define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ | ||
150 : | |||
151 : | suxen_drol | 1014 | |
152 : | edgomez | 199 | /***************************************************************************** |
153 : | suxen_drol | 890 | * xvid_global() |
154 : | edgomez | 199 | ****************************************************************************/ |
155 : | |||
156 : | suxen_drol | 890 | /* cpu_flags definitions */ |
157 : | edgomez | 199 | |
158 : | suxen_drol | 890 | #define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */ |
159 : | #define XVID_CPU_ASM 0x00000080 /* native assembly */ | ||
160 : | edgomez | 851 | /* ARCH_IS_IA32 */ |
161 : | suxen_drol | 890 | #define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */ |
162 : | #define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */ | ||
163 : | #define XVID_CPU_SSE 0x00000004 /* sse : pentium3, athlonXP */ | ||
164 : | #define XVID_CPU_SSE2 0x00000008 /* sse2 : pentium4, athlon64 */ | ||
165 : | #define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */ | ||
166 : | #define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ | ||
167 : | #define XVID_CPU_TSC 0x00000040 /* timestamp counter */ | ||
168 : | edgomez | 851 | /* ARCH_IS_PPC */ |
169 : | suxen_drol | 890 | #define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
170 : | edgomez | 199 | |
171 : | Isibaar | 209 | |
172 : | suxen_drol | 1031 | #define XVID_DEBUG_ERROR 0x00000001 |
173 : | #define XVID_DEBUG_STARTCODE 0x00000002 | ||
174 : | #define XVID_DEBUG_HEADER 0x00000004 | ||
175 : | #define XVID_DEBUG_TIMECODE 0x00000008 | ||
176 : | #define XVID_DEBUG_MB 0x00000010 | ||
177 : | #define XVID_DEBUG_COEFF 0x00000020 | ||
178 : | #define XVID_DEBUG_MV 0x00000040 | ||
179 : | #define XVID_DEBUG_RC 0x00000080 | ||
180 : | #define XVID_DEBUG_DEBUG 0x80000000 | ||
181 : | |||
182 : | suxen_drol | 890 | /* XVID_GBL_INIT param1 */ |
183 : | typedef struct { | ||
184 : | int version; | ||
185 : | int cpu_flags; /* [in:opt] zero = autodetect cpu | ||
186 : | XVID_CPU_FORCE|{cpu features} = force cpu features */ | ||
187 : | suxen_drol | 1031 | int debug; /* [in:opt] debug level */ |
188 : | suxen_drol | 890 | } xvid_gbl_init_t; |
189 : | edgomez | 199 | |
190 : | |||
191 : | suxen_drol | 890 | /* XVID_GBL_INFO param1 */ |
192 : | typedef struct { | ||
193 : | int version; | ||
194 : | int actual_version; /* [out] returns the actual xvidcore version */ | ||
195 : | const char * build; /* [out] if !null, points to description of this xvid core build */ | ||
196 : | int cpu_flags; /* [out] detected cpu features */ | ||
197 : | int num_threads; /* [out] detected number of cpus/threads */ | ||
198 : | } xvid_gbl_info_t; | ||
199 : | Isibaar | 209 | |
200 : | edgomez | 199 | |
201 : | suxen_drol | 890 | /* XVID_GBL_CONVERT param1 */ |
202 : | typedef struct { | ||
203 : | int version; | ||
204 : | xvid_image_t input; /* [in] input image & colorspace */ | ||
205 : | xvid_image_t output; /* [in] output image & colorspace */ | ||
206 : | suxen_drol | 920 | int width; /* [in] width */ |
207 : | int height; /* [in] height */ | ||
208 : | suxen_drol | 890 | int interlacing; /* [in] interlacing */ |
209 : | } xvid_gbl_convert_t; | ||
210 : | edgomez | 851 | |
211 : | edgomez | 199 | |
212 : | suxen_drol | 890 | #define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */ |
213 : | #define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ | ||
214 : | #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ | ||
215 : | #define XVID_GBL_TEST 3 /* testing.. */ | ||
216 : | edgomez | 199 | |
217 : | suxen_drol | 890 | int xvid_global(void *handle, int opt, void *param1, void *param2); |
218 : | edgomez | 199 | |
219 : | |||
220 : | /***************************************************************************** | ||
221 : | suxen_drol | 890 | * xvid_decore() |
222 : | edgomez | 199 | ****************************************************************************/ |
223 : | |||
224 : | suxen_drol | 890 | #define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
225 : | #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ | ||
226 : | #define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ | ||
227 : | edgomez | 199 | |
228 : | suxen_drol | 890 | int xvid_decore(void *handle, int opt, void *param1, void *param2); |
229 : | edgomez | 199 | |
230 : | suxen_drol | 890 | /* XVID_DEC_CREATE param 1 |
231 : | image width & height may be specified here when the dimensions are | ||
232 : | known in advance. */ | ||
233 : | typedef struct { | ||
234 : | int version; | ||
235 : | int width; /* [in:opt] image width */ | ||
236 : | int height; /* [in:opt] image width */ | ||
237 : | void * handle; /* [out] decore context handle */ | ||
238 : | } xvid_dec_create_t; | ||
239 : | edgomez | 851 | |
240 : | |||
241 : | suxen_drol | 890 | /* XVID_DEC_DECODE param1 */ |
242 : | /* general flags */ | ||
243 : | #define XVID_LOWDELAY 0x00000001 /* lowdelay mode */ | ||
244 : | #define XVID_DISCONTINUITY 0x00000002 /* indicates break in stream */ | ||
245 : | edgomez | 851 | |
246 : | suxen_drol | 890 | typedef struct { |
247 : | int version; | ||
248 : | int general; /* [in:opt] general flags */ | ||
249 : | void *bitstream; /* [in] bitstream (read from)*/ | ||
250 : | int length; /* [in] bitstream length */ | ||
251 : | xvid_image_t output; /* [in] output image (written to) */ | ||
252 : | } | ||
253 : | xvid_dec_frame_t; | ||
254 : | edgomez | 199 | |
255 : | |||
256 : | suxen_drol | 890 | /* XVID_DEC_DECODE param2 :: optional */ |
257 : | typedef struct | ||
258 : | { | ||
259 : | int version; | ||
260 : | int type; /* [out] output data type */ | ||
261 : | union { | ||
262 : | struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ | ||
263 : | int general; /* [out] flags */ | ||
264 : | int time_base; /* [out] time base */ | ||
265 : | int time_increment; /* [out] time increment */ | ||
266 : | edgomez | 199 | |
267 : | suxen_drol | 890 | /* XXX: external deblocking stuff */ |
268 : | suxen_drol | 926 | int * qscale; /* [out] pointer to quantizer table */ |
269 : | suxen_drol | 890 | int qscale_stride; /* [out] quantizer scale stride */ |
270 : | edgomez | 199 | |
271 : | suxen_drol | 890 | } vop; |
272 : | struct { /* XVID_TYPE_VOL */ | ||
273 : | int general; /* [out] flags */ | ||
274 : | int width; /* [out] width */ | ||
275 : | int height; /* [out] height */ | ||
276 : | int par; /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */ | ||
277 : | int par_width; /* [out] aspect ratio width */ | ||
278 : | int par_height; /* [out] aspect ratio height */ | ||
279 : | } vol; | ||
280 : | } data; | ||
281 : | } xvid_dec_stats_t; | ||
282 : | albeu | 315 | |
283 : | |||
284 : | suxen_drol | 1014 | |
285 : | #define XVID_ZONE_QUANT 1 | ||
286 : | #define XVID_ZONE_WEIGHT 2 | ||
287 : | typedef struct | ||
288 : | { | ||
289 : | int frame; | ||
290 : | int mode; | ||
291 : | int increment; | ||
292 : | int base; | ||
293 : | } xvid_enc_zone_t; | ||
294 : | |||
295 : | |||
296 : | |||
297 : | suxen_drol | 919 | /***************************************************************************** |
298 : | xvid plugin system -- internals | ||
299 : | edgomez | 199 | |
300 : | suxen_drol | 919 | xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE |
301 : | before encoding each frame xvidcore will call XVID_PLG_BEFORE | ||
302 : | after encoding each frame xvidcore will call XVID_PLG_AFTER | ||
303 : | xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY | ||
304 : | ****************************************************************************/ | ||
305 : | |||
306 : | suxen_drol | 1014 | |
307 : | suxen_drol | 919 | #define XVID_PLG_CREATE 0 |
308 : | #define XVID_PLG_DESTROY 1 | ||
309 : | #define XVID_PLG_INFO 2 | ||
310 : | #define XVID_PLG_BEFORE 3 | ||
311 : | #define XVID_PLG_AFTER 4 | ||
312 : | |||
313 : | /* xvid_plg_info_t.flags */ | ||
314 : | suxen_drol | 920 | #define XVID_REQORIGINAL 1 /* plugin requires a copy of the original (uncompressed) image */ |
315 : | suxen_drol | 922 | #define XVID_REQPSNR 2 /* plugin requires psnr between the uncompressed and compressed image*/ |
316 : | suxen_drol | 926 | #define XVID_REQDQUANTS 3 /* plugin requires access to the dquant table */ |
317 : | suxen_drol | 919 | |
318 : | |||
319 : | typedef struct | ||
320 : | { | ||
321 : | int version; | ||
322 : | suxen_drol | 1014 | int flags; /* [in:opt] plugin flags */ |
323 : | suxen_drol | 919 | } xvid_plg_info_t; |
324 : | |||
325 : | |||
326 : | typedef struct | ||
327 : | { | ||
328 : | int version; | ||
329 : | |||
330 : | suxen_drol | 1014 | int num_zones; /* [out] */ |
331 : | xvid_enc_zone_t * zones; /* [out] */ | ||
332 : | suxen_drol | 919 | |
333 : | suxen_drol | 1014 | int width; /* [out] */ |
334 : | int height; /* [out] */ | ||
335 : | int mb_width; /* [out] */ | ||
336 : | int mb_height; /* [out] */ | ||
337 : | int fincr; /* [out] */ | ||
338 : | int fbase; /* [out] */ | ||
339 : | |||
340 : | void * param; /* [out] */ | ||
341 : | suxen_drol | 919 | } xvid_plg_create_t; |
342 : | |||
343 : | |||
344 : | typedef struct | ||
345 : | { | ||
346 : | int version; | ||
347 : | |||
348 : | suxen_drol | 938 | int num_frames; /* [out] totlal frame encoded */ |
349 : | } xvid_plg_destroy_t; | ||
350 : | |||
351 : | |||
352 : | typedef struct | ||
353 : | { | ||
354 : | int version; | ||
355 : | |||
356 : | suxen_drol | 1014 | xvid_enc_zone_t * zone; /* [out] current zone */ |
357 : | |||
358 : | suxen_drol | 920 | int width; /* [out] */ |
359 : | int height; /* [out] */ | ||
360 : | suxen_drol | 926 | int mb_width; /* [out] */ |
361 : | int mb_height; /* [out] */ | ||
362 : | suxen_drol | 920 | int fincr; /* [out] */ |
363 : | int fbase; /* [out] */ | ||
364 : | suxen_drol | 1014 | |
365 : | int min_quant[3]; /* [out] */ | ||
366 : | int max_quant[3]; /* [out] */ | ||
367 : | suxen_drol | 920 | |
368 : | xvid_image_t reference; /* [out] -> [out] */ | ||
369 : | xvid_image_t current; /* [out] -> [in,out] */ | ||
370 : | xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ | ||
371 : | int frame_num; /* [out] frame number */ | ||
372 : | suxen_drol | 919 | |
373 : | suxen_drol | 920 | int type; /* [in,out] */ |
374 : | int quant; /* [in,out] */ | ||
375 : | |||
376 : | suxen_drol | 926 | int * dquant; /* [in,out] pointer to diff quantizer table */ |
377 : | int dquant_stride; /* [in,out] diff quantizer stride */ | ||
378 : | suxen_drol | 919 | |
379 : | int vop_flags; /* [in,out] */ | ||
380 : | int vol_flags; /* [in,out] */ | ||
381 : | int motion_flags; /* [in,out] */ | ||
382 : | |||
383 : | int length; /* [out] after: length of encoded frame */ | ||
384 : | int kblks, mblks, ublks; /* [out] after: */ | ||
385 : | suxen_drol | 922 | int sse_y, sse_u, sse_v; /* [out] */ |
386 : | suxen_drol | 919 | } xvid_plg_data_t; |
387 : | |||
388 : | |||
389 : | edgomez | 851 | /***************************************************************************** |
390 : | suxen_drol | 919 | xvid plugin system -- external |
391 : | |||
392 : | the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array | ||
393 : | indicates the plugin function pointer and plugin-specific data. | ||
394 : | xvidcore handles the rest. example: | ||
395 : | |||
396 : | xvid_enc_create_t create; | ||
397 : | xvid_enc_plugin_t plugins[2]; | ||
398 : | |||
399 : | plugins[0].func = xvid_psnr_func; | ||
400 : | plugins[0].param = NULL; | ||
401 : | plugins[1].func = xvid_cbr_func; | ||
402 : | plugins[1].param = &cbr_data; | ||
403 : | |||
404 : | create.num_plugins = 2; | ||
405 : | create.plugins = plugins; | ||
406 : | |||
407 : | ****************************************************************************/ | ||
408 : | |||
409 : | typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); | ||
410 : | |||
411 : | typedef struct | ||
412 : | { | ||
413 : | xvid_plugin_func * func; | ||
414 : | void * param; | ||
415 : | } xvid_enc_plugin_t; | ||
416 : | |||
417 : | suxen_drol | 938 | |
418 : | suxen_drol | 1014 | xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
419 : | xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ | ||
420 : | xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ | ||
421 : | suxen_drol | 938 | |
422 : | xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ | ||
423 : | |||
424 : | suxen_drol | 926 | xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
425 : | suxen_drol | 920 | xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
426 : | suxen_drol | 919 | |
427 : | |||
428 : | suxen_drol | 938 | |
429 : | suxen_drol | 1014 | typedef struct /* single pass rate control */ |
430 : | suxen_drol | 938 | { |
431 : | int version; | ||
432 : | suxen_drol | 977 | int bitrate; /* bits per second */ |
433 : | suxen_drol | 938 | int reaction_delay_factor; |
434 : | int averaging_period; | ||
435 : | int buffer; | ||
436 : | suxen_drol | 1014 | } xvid_plugin_single_t; |
437 : | suxen_drol | 938 | |
438 : | |||
439 : | typedef struct { | ||
440 : | int version; | ||
441 : | char * filename; | ||
442 : | } xvid_plugin_2pass1_t; | ||
443 : | |||
444 : | |||
445 : | suxen_drol | 942 | #define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
446 : | #define XVID_PAYBACK_PROP 1 /* payback proportionally */ | ||
447 : | suxen_drol | 938 | |
448 : | suxen_drol | 942 | typedef struct { |
449 : | int version; | ||
450 : | suxen_drol | 1014 | int bitrate; /* bits per second */ |
451 : | suxen_drol | 977 | char * filename; |
452 : | suxen_drol | 1014 | |
453 : | suxen_drol | 942 | int keyframe_boost; /* keyframe boost percentage: [0..100...]; */ |
454 : | int payback_method; | ||
455 : | int bitrate_payback_delay; | ||
456 : | int curve_compression_high; | ||
457 : | int curve_compression_low; | ||
458 : | int max_overflow_improvement; | ||
459 : | int max_overflow_degradation; | ||
460 : | |||
461 : | int kftreshold; | ||
462 : | int kfreduction; | ||
463 : | int min_key_interval; | ||
464 : | edgomez | 1041 | |
465 : | int container_frame_overhead; | ||
466 : | suxen_drol | 942 | }xvid_plugin_2pass2_t; |
467 : | |||
468 : | |||
469 : | suxen_drol | 919 | /***************************************************************************** |
470 : | suxen_drol | 890 | * xvid_encore() |
471 : | edgomez | 851 | ****************************************************************************/ |
472 : | edgomez | 199 | |
473 : | suxen_drol | 890 | /* Encoder options */ |
474 : | #define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ | ||
475 : | #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ | ||
476 : | #define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes | ||
477 : | 0 means this frame should not be written (ie. encoder lag) */ | ||
478 : | edgomez | 199 | |
479 : | suxen_drol | 890 | int xvid_encore(void *handle, int opt, void *param1, void *param2); |
480 : | edgomez | 199 | |
481 : | |||
482 : | suxen_drol | 890 | /* global flags */ |
483 : | typedef enum | ||
484 : | { | ||
485 : | edgomez | 949 | XVID_GLOBAL_PACKED = 0x00000001, /* packed bitstream */ |
486 : | XVID_GLOBAL_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */ | ||
487 : | XVID_GLOBAL_EXTRASTATS_ENABLE = 0x00000004 | ||
488 : | /*define XVID_GLOBAL_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */ | ||
489 : | /*define XVID_GLOBAL_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */ | ||
490 : | suxen_drol | 890 | } xvid_global_t; |
491 : | edgomez | 199 | |
492 : | |||
493 : | suxen_drol | 890 | /* XVID_ENC_ENCODE param1 */ |
494 : | /* vol-based flags */ | ||
495 : | typedef enum { | ||
496 : | edgomez | 949 | XVID_VOL_MPEGQUANT = 0x00000001, |
497 : | XVID_VOL_EXTRASTATS = 0x00000002, | ||
498 : | XVID_VOL_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */ | ||
499 : | XVID_VOL_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */ | ||
500 : | XVID_VOL_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */ | ||
501 : | XVID_VOL_INTERLACING = 0x00000400, /* enable interlaced encoding */ | ||
502 : | suxen_drol | 890 | } xvid_vol_t; |
503 : | edgomez | 199 | |
504 : | |||
505 : | suxen_drol | 890 | /* vop-based flags */ |
506 : | typedef enum { | ||
507 : | edgomez | 949 | XVID_VOP_DEBUG = 0x00000001, |
508 : | suxen_drol | 920 | |
509 : | edgomez | 949 | XVID_VOP_HALFPEL = 0x00000004, /* use halfpel interpolation */ |
510 : | XVID_VOP_INTER4V = 0x00000008, | ||
511 : | suxen_drol | 890 | |
512 : | chl | 993 | XVID_VOP_TRELLISQUANT = 0x00000010, /* use trellis based R-D "optimal" quantization */ |
513 : | |||
514 : | edgomez | 949 | XVID_VOP_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */ |
515 : | XVID_VOP_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for | ||
516 : | suxen_drol | 890 | color input material chroma is ignored) */ |
517 : | edgomez | 949 | XVID_VOP_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ |
518 : | XVID_VOP_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ | ||
519 : | edgomez | 199 | |
520 : | edgomez | 949 | /* only valid for vol_flags|=XVID_VOL_INTERLACING */ |
521 : | XVID_VOP_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ | ||
522 : | XVID_VOP_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */ | ||
523 : | edgomez | 199 | |
524 : | edgomez | 949 | /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
525 : | XVID_VOP_REDUCED = 0x00001000, /* reduced resolution vop */ | ||
526 : | suxen_drol | 890 | } xvid_vop_t; |
527 : | edgomez | 853 | |
528 : | edgomez | 199 | |
529 : | suxen_drol | 890 | typedef enum { |
530 : | edgomez | 949 | XVID_ME_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */ |
531 : | XVID_ME_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */ | ||
532 : | chl | 352 | |
533 : | edgomez | 949 | XVID_ME_HALFPELREFINE16 = 0x00020000, |
534 : | XVID_ME_HALFPELREFINE8 = 0x02000000, | ||
535 : | edgomez | 199 | |
536 : | edgomez | 949 | XVID_ME_QUARTERPELREFINE16 = 0x00040000, |
537 : | XVID_ME_QUARTERPELREFINE8 = 0x04000000, | ||
538 : | edgomez | 199 | |
539 : | edgomez | 949 | XVID_ME_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */ |
540 : | edgomez | 199 | |
541 : | edgomez | 949 | XVID_ME_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */ |
542 : | XVID_ME_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */ | ||
543 : | XVID_ME_USESQUARES8 = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */ | ||
544 : | edgomez | 608 | |
545 : | edgomez | 949 | XVID_ME_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */ |
546 : | XVID_ME_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */ | ||
547 : | edgomez | 851 | |
548 : | edgomez | 949 | /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */ |
549 : | XVID_ME_HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */ | ||
550 : | XVID_ME_HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */ | ||
551 : | XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */ | ||
552 : | XVID_ME_QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */ | ||
553 : | edgomez | 851 | |
554 : | edgomez | 949 | XVID_ME_EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern |
555 : | enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */ | ||
556 : | XVID_ME_CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */ | ||
557 : | edgomez | 851 | |
558 : | edgomez | 949 | XVID_ME_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */ |
559 : | XVID_ME_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */ | ||
560 : | XVID_ME_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */ | ||
561 : | XVID_ME_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */ | ||
562 : | suxen_drol | 890 | } xvid_motion_t; |
563 : | edgomez | 851 | |
564 : | |||
565 : | suxen_drol | 890 | /* XVID_ENC_CREATE param1 */ |
566 : | typedef struct { | ||
567 : | int version; | ||
568 : | suxen_drol | 1014 | |
569 : | int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */ | ||
570 : | suxen_drol | 890 | int width; /* [in] frame dimensions; width, pixel units */ |
571 : | int height; /* [in] frame dimensions; height, pixel units */ | ||
572 : | edgomez | 851 | |
573 : | suxen_drol | 1014 | int num_zones; /* [in:opt] number of bitrate zones */ |
574 : | xvid_enc_zone_t * zones; /* ^^ zone array */ | ||
575 : | |||
576 : | suxen_drol | 919 | int num_plugins; /* [in:opt] number of plugins */ |
577 : | xvid_enc_plugin_t * plugins; /* ^^ plugin array */ | ||
578 : | |||
579 : | suxen_drol | 890 | int num_threads; /* [in:opt] number of threads */ |
580 : | int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ | ||
581 : | edgomez | 851 | |
582 : | suxen_drol | 890 | xvid_global_t global; /* [in:opt] global flags; controls encoding behavior */ |
583 : | edgomez | 851 | |
584 : | suxen_drol | 890 | /* --- vol-based stuff; included here for conveinience */ |
585 : | int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ | ||
586 : | int fbase; /* [in] framerate base | ||
587 : | frame_duration = fincr/fbase seconds*/ | ||
588 : | /* ^^^---------------------------------------------- */ | ||
589 : | edgomez | 851 | |
590 : | |||
591 : | suxen_drol | 890 | /* ---vop-based; included here for conveienience */ |
592 : | int max_key_interval; /* [in:opt] the maximum interval between key frames */ | ||
593 : | /*XXX: maybe call it gop_size? */ | ||
594 : | edgomez | 851 | |
595 : | suxen_drol | 890 | int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
596 : | edgomez | 851 | |
597 : | suxen_drol | 890 | int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
598 : | int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ | ||
599 : | edgomez | 851 | |
600 : | suxen_drol | 1014 | int min_quant[3]; /* [in:opt] */ |
601 : | int max_quant[3]; /* [in:opt] */ | ||
602 : | |||
603 : | suxen_drol | 890 | /* ^^^ -------------------------------------------------------------------------*/ |
604 : | edgomez | 851 | |
605 : | suxen_drol | 890 | void *handle; /* [out] encoder instance handle */ |
606 : | } | ||
607 : | xvid_enc_create_t; | ||
608 : | edgomez | 851 | |
609 : | |||
610 : | suxen_drol | 890 | #define XVID_KEYFRAME 0x00000001 |
611 : | edgomez | 199 | |
612 : | suxen_drol | 890 | typedef struct { |
613 : | int version; | ||
614 : | edgomez | 199 | |
615 : | suxen_drol | 890 | /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any |
616 : | changes here until the next VOL (keyframe). */ | ||
617 : | xvid_vol_t vol_flags; /* [in] vol flags */ | ||
618 : | unsigned char * | ||
619 : | quant_intra_matrix; /* [in:opt] custom intra qmatrix */ | ||
620 : | unsigned char * | ||
621 : | quant_inter_matrix; /* [in:opt] custom inter qmatrix */ | ||
622 : | edgomez | 199 | |
623 : | suxen_drol | 890 | int par; /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
624 : | int par_width; /* [in:opt] aspect ratio width */ | ||
625 : | int par_height; /* [in:opt] aspect ratio height */ | ||
626 : | /* ^^^----------------------------------------------------------------------------------*/ | ||
627 : | edgomez | 199 | |
628 : | suxen_drol | 925 | int fincr; /* framerate increment, for variable framerate only */ |
629 : | suxen_drol | 890 | xvid_vop_t vop_flags; /* [in] (general)vop-based flags */ |
630 : | xvid_motion_t motion; /* [in] ME options */ | ||
631 : | edgomez | 851 | |
632 : | suxen_drol | 890 | xvid_image_t input; /* [in] input image (read from) */ |
633 : | |||
634 : | int type; /* [in:opt] coding type */ | ||
635 : | int quant; /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */ | ||
636 : | edgomez | 953 | int bframe_threshold; |
637 : | edgomez | 851 | |
638 : | suxen_drol | 890 | void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
639 : | int length; /* [in:opt] bitstream length (bytes) */ | ||
640 : | edgomez | 851 | |
641 : | suxen_drol | 890 | int out_flags; /* [out] bitstream output flags */ |
642 : | } | ||
643 : | xvid_enc_frame_t; | ||
644 : | edgomez | 199 | |
645 : | |||
646 : | suxen_drol | 890 | /* XVID_ENC_ENCODE param2 (optional) |
647 : | xvid_enc_stats_t describes individual frame details | ||
648 : | |||
649 : | coding_type==XVID_TYPE_NOTHING if the stats are not given | ||
650 : | */ | ||
651 : | typedef struct { | ||
652 : | int version; | ||
653 : | edgomez | 199 | |
654 : | suxen_drol | 890 | /* encoding parameters */ |
655 : | int type; /* [out] coding type */ | ||
656 : | int quant; /* [out] frame quantizer */ | ||
657 : | xvid_vol_t vol_flags; /* [out] vol flags (see above) */ | ||
658 : | int vop_flags; /* [out] vop flags (see above) */ | ||
659 : | /* bitrate */ | ||
660 : | int length; /* [out] frame length */ | ||
661 : | edgomez | 199 | |
662 : | suxen_drol | 890 | int hlength; /* [out] header length (bytes) */ |
663 : | int kblks, mblks, ublks; /* [out] */ | ||
664 : | edgomez | 199 | |
665 : | suxen_drol | 890 | int sse_y, sse_u, sse_v; |
666 : | } | ||
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 |