--- xvid.h 2002/06/20 14:05:57 1.12 +++ xvid.h 2003/01/25 22:44:50 1.17.2.26 @@ -28,7 +28,7 @@ * ToDo ? : when BFRAMES is defined, the API_VERSION should not * be the same (3.0 ?) * -* $Id: xvid.h,v 1.12 2002/06/20 14:05:57 suxen_drol Exp $ +* $Id: xvid.h,v 1.17.2.26 2003/01/25 22:44:50 chl Exp $ * *****************************************************************************/ @@ -37,7 +37,7 @@ #define _XVID_H_ #ifdef __cplusplus -* $Id: xvid.h,v 1.12 2002/06/20 14:05:57 suxen_drol Exp $ +extern "C" { #endif /***************************************************************************** @@ -46,6 +46,20 @@ /* API Version : 2.1 */ #define API_VERSION ((2 << 16) | (1)) +#define XVID_API_UNSTABLE + +/* Bitstream Version + * this will be writen into the bitstream to allow easy detection of xvid + * encoder bugs in the decoder, without this it might not possible to + * automatically distinquish between a file which has been encoded with an + * old & buggy XVID from a file which has been encoded with a bugfree version + * see the infamous interlacing bug ... + * + * this MUST be increased if an encoder bug is fixed, increasing it too often + * doesnt hurt but not increasing it could cause difficulty for decoders in the + * future + */ +#define XVID_BS_VERSION "0009" /* Error codes */ @@ -56,7 +70,7 @@ /* Colorspaces */ -#define XVID_CSP_RGB24 0 +#define XVID_CSP_RGB24 0 /* [b|g|r] */ #define XVID_CSP_YV12 1 #define XVID_CSP_YUY2 2 #define XVID_CSP_UYVY 3 @@ -66,43 +80,75 @@ #define XVID_CSP_USER 12 #define XVID_CSP_EXTERN 1004 // per slice rendering #define XVID_CSP_YVYU 1002 -#define XVID_CSP_RGB32 1000 +#define XVID_CSP_RGB32 1000 /* [b|g|r|a] */ +#define XVID_CSP_ABGR 1006 /* [a|b|g|r] */ +#define XVID_CSP_RGBA 1005 /* [r|g|b|a] */ + + + #define XVID_CSP_NULL 9999 #define XVID_CSP_VFLIP 0x80000000 // flip mask /***************************************************************************** + * Initialization constants ****************************************************************************/ /* CPU flags for XVID_INIT_PARAM.cpu_flags */ +#define XVID_CPU_FORCE 0x80000000 +#define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */ -#define XVID_CPU_MMX 0x00000001 -#define XVID_CPU_MMXEXT 0x00000002 -#define XVID_CPU_SSE 0x00000004 -#define XVID_CPU_SSE2 0x00000008 -#define XVID_CPU_3DNOW 0x00000010 -#define XVID_CPU_3DNOWEXT 0x00000020 - -#define XVID_CPU_TSC 0x00000040 - -#define XVID_CPU_IA64 0x00000080 +#define XVID_CPU_ASM 0x00000080 /* native assembly */ +/* ARCH_X86 */ +#define XVID_CPU_MMX 0x00000001 /* mmx: pentiumMMX,k6 */ +#define XVID_CPU_MMXEXT 0x00000002 /* mmxx-ext: pentium2,athlon */ +#define XVID_CPU_SSE 0x00000004 /* sse: pentium3,athlonXP */ +#define XVID_CPU_SSE2 0x00000008 /* sse2: pentium4,athlon64 */ +#define XVID_CPU_3DNOW 0x00000010 /* 3dnow: k6-2 */ +#define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ +#define XVID_CPU_TSC 0x00000040 /* timestamp counter */ +/* ARCH_IA64 */ +#define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */ +/* ARCH_PPC */ +#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ -#define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */ -#define XVID_CPU_FORCE 0x80000000 + typedef struct + { + int colorspace; + void * y; + void * u; + void * v; + int y_stride; + int uv_stride; + } XVID_IMAGE; /* from yv12 */ + +#define XVID_INIT_INIT 0 +#define XVID_INIT_CONVERT 1 +#define XVID_INIT_TEST 2 /***************************************************************************** * Initialization structures ****************************************************************************/ typedef struct + { int cpu_flags; int api_version; int core_build; } XVID_INIT_PARAM; + typedef struct + { + XVID_IMAGE input; + XVID_IMAGE output; + int width; + int height; + int interlacing; + } XVID_INIT_CONVERTINFO; + /***************************************************************************** * Initialization entry point ****************************************************************************/ @@ -118,6 +164,11 @@ ****************************************************************************/ /* Flags for XVID_DEC_FRAME.general */ +#define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. video-for-windows) */ +#define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */ +#define XVID_DEC_DEBLOCKUV 0x00000008 /* chroma deblocking */ +#define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream; instructs + decoder to ignore any previous reference frames */ #define XVID_QUICK_DECODE 0x00000010 /***************************************************************************** @@ -133,6 +184,33 @@ XVID_DEC_PARAM; +#define XVID_DEC_VOP 0 +#define XVID_DEC_VOL 1 +#define XVID_DEC_NOTHING 2 /* nothing was decoded */ + + typedef struct + { + int notify; /* [out] output 'mode' */ + union + { + struct /* XVID_DEC_VOP */ + { + int time_base; /* [out] time base */ + int time_increment; /* [out] time increment */ + } vop; + struct /* XVID_DEC_VOL */ + { + int general; /* [out] flags: eg. frames are interlaced */ + int width; /* [out] width */ + int height; /* [out] height */ + int aspect_ratio; /* [out] aspect ratio */ + int par_width; /* [out] aspect ratio width */ + int par_height; /* [out] aspect ratio height */ + } vol; + } data; + } XVID_DEC_STATS; + + typedef struct { int general; @@ -153,6 +231,14 @@ int stride_y, stride_u,stride_v; } XVID_DEC_PICTURE; + +/***************************************************************************** + * Decoder entry point + ****************************************************************************/ + +/* decoder options */ +#define XVID_DEC_DECODE 0 +#define XVID_DEC_CREATE 1 #define XVID_DEC_DESTROY 2 int xvid_decore(void *handle, @@ -169,12 +255,21 @@ #define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */ #define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */ #define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */ +#define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */ + +#define XVID_GLOBAL_EXTRASTATS 0x00000200 /* generate extra statistics */ + /* Flags for XVID_ENC_FRAME.general */ #define XVID_VALID_FLAGS 0x80000000 #define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */ -#define XVID_LATEINTRA 0x00000200 +#define XVID_H263QUANT 0x00000010 +#define XVID_MPEGQUANT 0x00000020 +#define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */ +#define XVID_QUARTERPEL 0x02000000 +#define XVID_ADAPTIVEQUANT 0x00000080 +#define XVID_LUMIMASKING 0x00000100 #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */ #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */ @@ -191,30 +286,54 @@ #define XVID_ME_PMVFAST 0x00080000 #define XVID_ME_EPZS 0x00100000 - #define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */ -#define XVID_GRAYSCALE 0x01000000 /* color input material chroma is ignored) */ +#define XVID_GRAYSCALE 0x01000000 /* color input material chroma is ignored) */ + +#define XVID_GMC 0x10000000 +#define XVID_GMC_TRANSLATIONAL 0x20000000 + +#define XVID_REDUCED 0x04000000 /* reduced resolution vop */ + +#define XVID_EXTRASTATS 0x00000200 /* generate extra statistics */ /* Flags for XVID_ENC_FRAME.motion */ #define PMV_ADVANCEDDIAMOND8 0x00004000 #define PMV_ADVANCEDDIAMOND16 0x00008000 -#define PMV_EARLYSTOP16 0x00080000 -#define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more refinement */ + +#define PMV_HALFPELDIAMOND16 0x00010000 +#define PMV_HALFPELREFINE16 0x00020000 +#define PMV_QUARTERPELREFINE16 0x00040000 +#define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */ + +#define PMV_CHROMA16 0x00100000 /* also use chroma for MB-ME */ #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ -#define PMV_USESQUARES16 0x00800000 +#define PMV_USESQUARES16 0x00800000 /* use squares instead of diamonds as search pattern */ #define PMV_HALFPELDIAMOND8 0x01000000 #define PMV_HALFPELREFINE8 0x02000000 -#define PMV_EXTSEARCH8 0x04000000 /* extend PMV by more searches */ -#define PMV_EARLYSTOP8 0x08000000 -#define PMV_QUICKSTOP8 0x10000000 /* like early, but without any more refinement */ +#define PMV_QUARTERPELREFINE8 0x04000000 +#define PMV_EXTSEARCH8 0x08000000 /* extend PMV by more searches */ + +#define PMV_CHROMA8 0x10000000 /* also use chroma for B-ME */ #define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */ #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */ #define PMV_USESQUARES8 0x80000000 +/* note: old and deprecated */ + +/* only for compatability with old encoders */ + +#define PMV_EARLYSTOP16 0x00 +#define PMV_EARLYSTOP8 0x00 +#define PMV_QUICKSTOP16 0x00 +#define PMV_QUICKSTOP8 0x00 + +#define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_COLOUR[16/8] */ + + /***************************************************************************** * Encoder structures ****************************************************************************/ @@ -233,20 +352,23 @@ #ifdef _SMP int num_threads; /* number of threads */ #endif -#ifdef BFRAMES int global; /* global/debug options */ int max_bframes; /* max sequential bframes (0=disable bframes) */ int bquant_ratio; /* bframe quantizer multipier (percentage). * used only when bquant < 1 * eg. 200 = x2 multiplier -#endif - int packed; /* enable packed mode */ + * quant = ((past_quant + future_quant) * bquant_ratio)/200 + */ + int bquant_offset; /* bquant += bquant_offset */ + int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */ + void *handle; /* [out] encoder instance handle */ } XVID_ENC_PARAM; typedef struct { int x; + int y; } VECTOR; @@ -283,6 +405,7 @@ int length; /* [out] bitstream length (bytes) */ void *image; /* [in] image ptr */ + int stride; int colorspace; /* [in] source colorspace */ unsigned char *quant_intra_matrix; // [in] custom intra qmatrix */ @@ -293,9 +416,7 @@ */ HINTINFO hint; /* [in/out] mv hint information */ -#ifdef BFRAMES int bquant; /* [in] bframe quantizer */ -#endif } XVID_ENC_FRAME; @@ -306,7 +427,9 @@ int quant; /* [out] frame quantizer */ int hlength; /* [out] header length (bytes) */ int kblks, mblks, ublks; /* [out] */ - + long sse_y; /* [out] SSE of Y */ + long sse_u; /* [out] SSE of Cb */ + long sse_v; /* [out] SSE of Cr */ } XVID_ENC_STATS;