3 |
* XVID MPEG-4 VIDEO CODEC |
* XVID MPEG-4 VIDEO CODEC |
4 |
* - XviD Main header file - |
* - XviD Main header file - |
5 |
* |
* |
6 |
* This file is part of XviD, a free MPEG-4 video encoder/decoder |
* Copyright(C) 2001-2003 Peter Ross <pross@xvid.org> |
7 |
* |
* |
8 |
* This program is free software; you can redistribute it and/or modify |
* This program is free software; you can redistribute it and/or modify |
9 |
* it under the terms of the GNU General Public License as published by |
* it under the terms of the GNU General Public License as published by |
19 |
* along with this program; if not, write to the Free Software |
* along with this program; if not, write to the Free Software |
20 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
21 |
* |
* |
22 |
* $Id: xvid.h,v 1.27.2.16 2003-04-27 14:21:35 chl Exp $ |
* $Id: xvid.h,v 1.27.2.23 2003-06-09 19:42:12 edgomez Exp $ |
23 |
* |
* |
24 |
****************************************************************************/ |
****************************************************************************/ |
25 |
|
|
67 |
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
68 |
* future |
* future |
69 |
*/ |
*/ |
70 |
#define XVID_BS_VERSION "0009" |
#define XVID_BS_VERSION "0011" |
71 |
|
|
72 |
|
|
73 |
/***************************************************************************** |
/***************************************************************************** |
116 |
int stride[4]; /* [in] image stride; "bytes per row"*/ |
int stride[4]; /* [in] image stride; "bytes per row"*/ |
117 |
} xvid_image_t; |
} xvid_image_t; |
118 |
|
|
119 |
|
/* 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 |
|
|
134 |
/* aspect ratios */ |
/* aspect ratios */ |
135 |
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */ |
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */ |
148 |
#define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ |
#define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ |
149 |
#define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ |
#define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ |
150 |
|
|
151 |
|
|
152 |
/***************************************************************************** |
/***************************************************************************** |
153 |
* xvid_global() |
* xvid_global() |
154 |
****************************************************************************/ |
****************************************************************************/ |
169 |
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
170 |
|
|
171 |
|
|
172 |
|
#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 |
/* XVID_GBL_INIT param1 */ |
/* XVID_GBL_INIT param1 */ |
183 |
typedef struct { |
typedef struct { |
184 |
int version; |
int version; |
185 |
int cpu_flags; /* [in:opt] zero = autodetect cpu |
int cpu_flags; /* [in:opt] zero = autodetect cpu |
186 |
XVID_CPU_FORCE|{cpu features} = force cpu features */ |
XVID_CPU_FORCE|{cpu features} = force cpu features */ |
187 |
|
int debug; /* [in:opt] debug level */ |
188 |
} xvid_gbl_init_t; |
} xvid_gbl_init_t; |
189 |
|
|
190 |
|
|
281 |
} xvid_dec_stats_t; |
} xvid_dec_stats_t; |
282 |
|
|
283 |
|
|
284 |
|
|
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 |
/***************************************************************************** |
/***************************************************************************** |
298 |
xvid plugin system -- internals |
xvid plugin system -- internals |
299 |
|
|
303 |
xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY |
xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY |
304 |
****************************************************************************/ |
****************************************************************************/ |
305 |
|
|
306 |
|
|
307 |
#define XVID_PLG_CREATE 0 |
#define XVID_PLG_CREATE 0 |
308 |
#define XVID_PLG_DESTROY 1 |
#define XVID_PLG_DESTROY 1 |
309 |
#define XVID_PLG_INFO 2 |
#define XVID_PLG_INFO 2 |
319 |
typedef struct |
typedef struct |
320 |
{ |
{ |
321 |
int version; |
int version; |
322 |
int flags; /* plugin flags */ |
int flags; /* [in:opt] plugin flags */ |
323 |
} xvid_plg_info_t; |
} xvid_plg_info_t; |
324 |
|
|
325 |
|
|
327 |
{ |
{ |
328 |
int version; |
int version; |
329 |
|
|
330 |
int width; |
int num_zones; /* [out] */ |
331 |
int height; |
xvid_enc_zone_t * zones; /* [out] */ |
|
int mb_width; |
|
|
int mb_height; |
|
|
int fincr; |
|
|
int fbase; |
|
332 |
|
|
333 |
void * param; |
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 |
} xvid_plg_create_t; |
} xvid_plg_create_t; |
342 |
|
|
343 |
|
|
353 |
{ |
{ |
354 |
int version; |
int version; |
355 |
|
|
356 |
|
xvid_enc_zone_t * zone; /* [out] current zone */ |
357 |
|
|
358 |
int width; /* [out] */ |
int width; /* [out] */ |
359 |
int height; /* [out] */ |
int height; /* [out] */ |
360 |
int mb_width; /* [out] */ |
int mb_width; /* [out] */ |
362 |
int fincr; /* [out] */ |
int fincr; /* [out] */ |
363 |
int fbase; /* [out] */ |
int fbase; /* [out] */ |
364 |
|
|
365 |
|
int min_quant[3]; /* [out] */ |
366 |
|
int max_quant[3]; /* [out] */ |
367 |
|
|
368 |
xvid_image_t reference; /* [out] -> [out] */ |
xvid_image_t reference; /* [out] -> [out] */ |
369 |
xvid_image_t current; /* [out] -> [in,out] */ |
xvid_image_t current; /* [out] -> [in,out] */ |
370 |
xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ |
xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ |
415 |
} xvid_enc_plugin_t; |
} xvid_enc_plugin_t; |
416 |
|
|
417 |
|
|
418 |
|
xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
419 |
xvid_plugin_func xvid_plugin_fixed; /* fixed quantizer control */ |
xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ |
420 |
xvid_plugin_func xvid_plugin_cbr; /* constant bitrate control */ |
xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ |
|
xvid_plugin_func xvid_plugin_2pass1; /* 2pass rate control: first pass */ |
|
|
xvid_plugin_func xvid_plugin_2pass2; /* 2pass rate control: second pass */ |
|
421 |
|
|
422 |
xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
423 |
|
|
425 |
xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
426 |
|
|
427 |
|
|
|
typedef struct |
|
|
{ |
|
|
int version; |
|
|
int quant_increment; |
|
|
int quant_base; |
|
|
} xvid_plugin_fixed_t; |
|
|
|
|
428 |
|
|
429 |
typedef struct |
typedef struct /* single pass rate control */ |
430 |
{ |
{ |
431 |
int version; |
int version; |
432 |
int bitrate; /* bits per second */ |
int bitrate; /* bits per second */ |
|
int max_quantizer; |
|
|
int min_quantizer; |
|
433 |
int reaction_delay_factor; |
int reaction_delay_factor; |
434 |
int averaging_period; |
int averaging_period; |
435 |
int buffer; |
int buffer; |
436 |
} xvid_plugin_cbr_t; |
} xvid_plugin_single_t; |
437 |
|
|
438 |
|
|
439 |
typedef struct { |
typedef struct { |
442 |
} xvid_plugin_2pass1_t; |
} xvid_plugin_2pass1_t; |
443 |
|
|
444 |
|
|
|
#define XVID_CURVE_COSINE 0 /* low aggressiveness */ |
|
|
#define XVID_CURVE_LINEAR 1 /* medium aggressiveness */ |
|
|
#define XVID_CURVE_SINE 2 /* high aggressiveness */ |
|
|
|
|
445 |
#define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
#define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
446 |
#define XVID_PAYBACK_PROP 1 /* payback proportionally */ |
#define XVID_PAYBACK_PROP 1 /* payback proportionally */ |
447 |
|
|
448 |
typedef struct { |
typedef struct { |
449 |
int version; |
int version; |
|
char * filename; |
|
450 |
int bitrate; /* bits per second */ |
int bitrate; /* bits per second */ |
451 |
|
char * filename; |
452 |
|
|
453 |
int keyframe_boost; /* keyframe boost percentage: [0..100...]; */ |
int keyframe_boost; /* keyframe boost percentage: [0..100...]; */ |
454 |
int payback_method; |
int payback_method; |
457 |
int curve_compression_low; |
int curve_compression_low; |
458 |
int max_overflow_improvement; |
int max_overflow_improvement; |
459 |
int max_overflow_degradation; |
int max_overflow_degradation; |
|
int min_quant[3]; |
|
|
int max_quant[3]; |
|
|
|
|
|
int use_alt_curve; |
|
|
int alt_curve_high_dist; |
|
|
int alt_curve_low_dist; |
|
|
int alt_curve_use_auto; |
|
|
int alt_curve_auto_str; |
|
|
int alt_curve_type; /* XVID_CURVE_ */ |
|
|
int alt_curve_min_rel_qual; |
|
|
int alt_curve_use_auto_bonus_bias; |
|
|
int alt_curve_bonus_bias; |
|
460 |
|
|
461 |
int kftreshold; |
int kftreshold; |
462 |
int kfreduction; |
int kfreduction; |
463 |
int min_key_interval; |
int min_key_interval; |
464 |
|
|
465 |
|
int container_frame_overhead; |
466 |
}xvid_plugin_2pass2_t; |
}xvid_plugin_2pass2_t; |
467 |
|
|
468 |
|
|
516 |
color input material chroma is ignored) */ |
color input material chroma is ignored) */ |
517 |
XVID_VOP_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ |
XVID_VOP_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ |
518 |
XVID_VOP_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ |
XVID_VOP_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ |
|
XVID_VOP_DYNAMIC_BFRAMES = 0x00000200, |
|
519 |
|
|
520 |
/* only valid for vol_flags|=XVID_VOL_INTERLACING */ |
/* only valid for vol_flags|=XVID_VOL_INTERLACING */ |
521 |
XVID_VOP_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ |
XVID_VOP_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ |
565 |
/* XVID_ENC_CREATE param1 */ |
/* XVID_ENC_CREATE param1 */ |
566 |
typedef struct { |
typedef struct { |
567 |
int version; |
int version; |
568 |
|
|
569 |
|
int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */ |
570 |
int width; /* [in] frame dimensions; width, pixel units */ |
int width; /* [in] frame dimensions; width, pixel units */ |
571 |
int height; /* [in] frame dimensions; height, pixel units */ |
int height; /* [in] frame dimensions; height, pixel units */ |
572 |
|
|
573 |
|
int num_zones; /* [in:opt] number of bitrate zones */ |
574 |
|
xvid_enc_zone_t * zones; /* ^^ zone array */ |
575 |
|
|
576 |
int num_plugins; /* [in:opt] number of plugins */ |
int num_plugins; /* [in:opt] number of plugins */ |
577 |
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
578 |
|
|
597 |
int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
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 */ |
int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ |
599 |
|
|
600 |
|
int min_quant[3]; /* [in:opt] */ |
601 |
|
int max_quant[3]; /* [in:opt] */ |
602 |
|
|
603 |
/* ^^^ -------------------------------------------------------------------------*/ |
/* ^^^ -------------------------------------------------------------------------*/ |
604 |
|
|
605 |
void *handle; /* [out] encoder instance handle */ |
void *handle; /* [out] encoder instance handle */ |