--- xvid.h 2003/03/25 10:57:02 1.27.2.11 +++ xvid.h 2003/06/09 13:51:26 1.27.2.22 @@ -3,23 +3,23 @@ * XVID MPEG-4 VIDEO CODEC * - XviD Main header file - * - * This file is part of XviD, a free MPEG-4 video encoder/decoder + * Copyright(C) 2001-2003 Peter Ross * - * This program is free software; you can redistribute it and/or modify + * This program is free software ; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * the Free Software Foundation ; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of + * but WITHOUT ANY WARRANTY ; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software + * along with this program ; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * - * $Id: xvid.h,v 1.27.2.11 2003/03/25 10:57:02 suxen_drol Exp $ + * $Id: xvid.h,v 1.27.2.22 2003/06/09 13:51:26 edgomez Exp $ * ****************************************************************************/ @@ -116,6 +116,20 @@ int stride[4]; /* [in] image stride; "bytes per row"*/ } xvid_image_t; +/* video-object-sequence profiles */ +#define XVID_PROFILE_S_L0 0x08 /* simple */ +#define XVID_PROFILE_S_L1 0x01 +#define XVID_PROFILE_S_L2 0x02 +#define XVID_PROFILE_S_L3 0x03 +#define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ +#define XVID_PROFILE_ARTS_L2 0x92 +#define XVID_PROFILE_ARTS_L3 0x93 +#define XVID_PROFILE_ARTS_L4 0x94 +#define XVID_PROFILE_AS_L0 0xf0 /* advanced simple */ +#define XVID_PROFILE_AS_L1 0xf1 +#define XVID_PROFILE_AS_L2 0xf2 +#define XVID_PROFILE_AS_L3 0xf3 +#define XVID_PROFILE_AS_L4 0xf4 /* aspect ratios */ #define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */ @@ -134,6 +148,7 @@ #define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ #define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ + /***************************************************************************** * xvid_global() ****************************************************************************/ @@ -154,11 +169,22 @@ #define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ +#define XVID_DEBUG_ERROR 0x00000001 +#define XVID_DEBUG_STARTCODE 0x00000002 +#define XVID_DEBUG_HEADER 0x00000004 +#define XVID_DEBUG_TIMECODE 0x00000008 +#define XVID_DEBUG_MB 0x00000010 +#define XVID_DEBUG_COEFF 0x00000020 +#define XVID_DEBUG_MV 0x00000040 +#define XVID_DEBUG_RC 0x00000080 +#define XVID_DEBUG_DEBUG 0x80000000 + /* XVID_GBL_INIT param1 */ typedef struct { int version; int cpu_flags; /* [in:opt] zero = autodetect cpu XVID_CPU_FORCE|{cpu features} = force cpu features */ + int debug; /* [in:opt] debug level */ } xvid_gbl_init_t; @@ -255,6 +281,19 @@ } xvid_dec_stats_t; + +#define XVID_ZONE_QUANT 1 +#define XVID_ZONE_WEIGHT 2 +typedef struct +{ + int frame; + int mode; + int increment; + int base; +} xvid_enc_zone_t; + + + /***************************************************************************** xvid plugin system -- internals @@ -264,6 +303,7 @@ xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY ****************************************************************************/ + #define XVID_PLG_CREATE 0 #define XVID_PLG_DESTROY 1 #define XVID_PLG_INFO 2 @@ -279,7 +319,7 @@ typedef struct { int version; - int flags; /* plugin flags */ + int flags; /* [in:opt] plugin flags */ } xvid_plg_info_t; @@ -287,14 +327,17 @@ { int version; - int width; - int height; - int mb_width; - int mb_height; - int fincr; - int fbase; + int num_zones; /* [out] */ + xvid_enc_zone_t * zones; /* [out] */ - void * param; + int width; /* [out] */ + int height; /* [out] */ + int mb_width; /* [out] */ + int mb_height; /* [out] */ + int fincr; /* [out] */ + int fbase; /* [out] */ + + void * param; /* [out] */ } xvid_plg_create_t; @@ -310,12 +353,17 @@ { int version; + xvid_enc_zone_t * zone; /* [out] current zone */ + int width; /* [out] */ int height; /* [out] */ int mb_width; /* [out] */ int mb_height; /* [out] */ int fincr; /* [out] */ int fbase; /* [out] */ + + int min_quant[3]; /* [out] */ + int max_quant[3]; /* [out] */ xvid_image_t reference; /* [out] -> [out] */ xvid_image_t current; /* [out] -> [in,out] */ @@ -367,11 +415,9 @@ } xvid_enc_plugin_t; - -xvid_plugin_func xvid_plugin_fixed; /* fixed quantizer control */ -xvid_plugin_func xvid_plugin_cbr; /* constant bitrate control */ -xvid_plugin_func xvid_plugin_2pass1; /* 2pass rate control: first pass */ -xvid_plugin_func xvid_plugin_2pass2; /* 2pass rate control: second pass */ +xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ +xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ +xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ @@ -379,24 +425,15 @@ xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ -typedef struct -{ - int version; - int quant_increment; - int quant_base; -} xvid_plugin_fixed_t; - -typedef struct +typedef struct /* single pass rate control */ { int version; - int bitrate; - int max_quantizer; - int min_quantizer; + int bitrate; /* bits per second */ int reaction_delay_factor; int averaging_period; int buffer; -} xvid_plugin_cbr_t; +} xvid_plugin_single_t; typedef struct { @@ -405,18 +442,14 @@ } xvid_plugin_2pass1_t; -#define XVID_CURVE_COSINE 0 /* low aggressiveness */ -#define XVID_CURVE_LINEAR 1 /* medium aggressiveness */ -#define XVID_CURVE_SINE 2 /* high aggressiveness */ - #define XVID_PAYBACK_BIAS 0 /* payback with bias */ #define XVID_PAYBACK_PROP 1 /* payback proportionally */ typedef struct { int version; - char * filename1; - char * filename2; - + int bitrate; /* bits per second */ + char * filename; + int keyframe_boost; /* keyframe boost percentage: [0..100...]; */ int payback_method; int bitrate_payback_delay; @@ -424,22 +457,12 @@ int curve_compression_low; int max_overflow_improvement; 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; int kftreshold; int kfreduction; int min_key_interval; + + int container_frame_overhead; }xvid_plugin_2pass2_t; @@ -459,91 +482,97 @@ /* global flags */ typedef enum { - XVID_PACKED = 0x00000001, /* packed bitstream */ - XVID_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */ - XVID_EXTRASTATS_ENABLE = 0x00000004 -/*define XVID_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */ -/*define XVID_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */ + XVID_GLOBAL_PACKED = 0x00000001, /* packed bitstream */ + XVID_GLOBAL_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */ + XVID_GLOBAL_EXTRASTATS_ENABLE = 0x00000004 +/*define XVID_GLOBAL_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */ +/*define XVID_GLOBAL_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */ } xvid_global_t; /* XVID_ENC_ENCODE param1 */ /* vol-based flags */ typedef enum { - XVID_MPEGQUANT = 0x00000001, - XVID_EXTRASTATS = 0x00000002, - XVID_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */ - XVID_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */ - XVID_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */ - XVID_INTERLACING = 0x00000400, /* enable interlaced encoding */ + XVID_VOL_MPEGQUANT = 0x00000001, + XVID_VOL_EXTRASTATS = 0x00000002, + XVID_VOL_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */ + XVID_VOL_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */ + XVID_VOL_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */ + XVID_VOL_INTERLACING = 0x00000400, /* enable interlaced encoding */ } xvid_vol_t; /* vop-based flags */ typedef enum { - XVID_DEBUG = 0x00000001, + XVID_VOP_DEBUG = 0x00000001, - XVID_HALFPEL = 0x00000004, /* use halfpel interpolation */ - XVID_INTER4V = 0x00000008, + XVID_VOP_HALFPEL = 0x00000004, /* use halfpel interpolation */ + XVID_VOP_INTER4V = 0x00000008, - XVID_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */ - XVID_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for + XVID_VOP_TRELLISQUANT = 0x00000010, /* use trellis based R-D "optimal" quantization */ + + XVID_VOP_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */ + XVID_VOP_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for color input material chroma is ignored) */ - XVID_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ - XVID_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ - XVID_DYNAMIC_BFRAMES = 0x00000200, - - /* only valid for vol_flags|=XVID_INTERLACING */ - XVID_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ - XVID_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */ + XVID_VOP_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ + XVID_VOP_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ + + /* only valid for vol_flags|=XVID_VOL_INTERLACING */ + XVID_VOP_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ + XVID_VOP_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */ - /* only valid for vol_flags|=XVID_REDUCED_ENABLED */ - XVID_REDUCED = 0x00001000, /* reduced resolution vop */ + /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ + XVID_VOP_REDUCED = 0x00001000, /* reduced resolution vop */ } xvid_vop_t; typedef enum { - PMV_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */ - PMV_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */ + XVID_ME_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */ + XVID_ME_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */ - PMV_HALFPELREFINE16 = 0x00020000, - PMV_HALFPELREFINE8 = 0x02000000, + XVID_ME_HALFPELREFINE16 = 0x00020000, + XVID_ME_HALFPELREFINE8 = 0x02000000, - PMV_QUARTERPELREFINE16 = 0x00040000, - PMV_QUARTERPELREFINE8 = 0x04000000, + XVID_ME_QUARTERPELREFINE16 = 0x00040000, + XVID_ME_QUARTERPELREFINE8 = 0x04000000, - PMV_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */ - - PMV_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */ - PMV_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */ - PMV_USESQUARES8 = 0x80000000, /* use square for PMV_EXTSEARCH8 */ - - PMV_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */ - PMV_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */ - - /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */ - HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */ - HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */ - QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */ - QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */ - - EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern - enable PMV_EXTSEARCH8 to do this in 8x8 search as well */ - CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */ - - PMV_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */ - PMV_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */ - PMV_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */ - PMV_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */ + XVID_ME_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */ + + XVID_ME_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */ + XVID_ME_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */ + XVID_ME_USESQUARES8 = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */ + + XVID_ME_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */ + XVID_ME_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */ + + /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */ + XVID_ME_HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */ + XVID_ME_HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */ + XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */ + XVID_ME_QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */ + + XVID_ME_EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern + enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */ + XVID_ME_CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */ + + XVID_ME_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */ + XVID_ME_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */ + XVID_ME_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */ + XVID_ME_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */ } xvid_motion_t; /* XVID_ENC_CREATE param1 */ typedef struct { int version; + + int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */ int width; /* [in] frame dimensions; width, pixel units */ int height; /* [in] frame dimensions; height, pixel units */ + int num_zones; /* [in:opt] number of bitrate zones */ + xvid_enc_zone_t * zones; /* ^^ zone array */ + int num_plugins; /* [in:opt] number of plugins */ xvid_enc_plugin_t * plugins; /* ^^ plugin array */ @@ -568,6 +597,9 @@ int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ + int min_quant[3]; /* [in:opt] */ + int max_quant[3]; /* [in:opt] */ + /* ^^^ -------------------------------------------------------------------------*/ void *handle; /* [out] encoder instance handle */ @@ -575,33 +607,6 @@ xvid_enc_create_t; -typedef struct { - int version; - int type; /* [in] rate control type: XVID_RC_xxx */ - - /* common stuff */ - int min_iquant; /* [in:opt] ivop quantizer upper/lower limit */ - int max_iquant; /* [in:opt] */ - int min_pquant; /* [in:opt] psvop quantizer upper/lower limit */ - int max_pquant; /* [in:opt] */ - int min_bquant; /* [in:opt] bvop quantizer upper/lower limit */ - int max_bquant; /* [in:opt] */ - - union { - struct { /* XVID_RC_FQUANT */ - float quant; /* [in] quantizer */ - } fquant; - struct { /* XVID_RC_CBR */ - int bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */ - int reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */ - int averaging_period; /* [in] */ - int buffer; /* [in] */ - } cbr; - } data; -} xvid_enc_rc_t; - - - #define XVID_KEYFRAME 0x00000001 typedef struct { @@ -628,6 +633,7 @@ int type; /* [in:opt] coding type */ int quant; /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */ + int bframe_threshold; void *bitstream; /* [in:opt] bitstream ptr (written to)*/ int length; /* [in:opt] bitstream length (bytes) */