--- xvid.h 2003/02/12 12:03:30 1.17.2.28 +++ xvid.h 2002/09/04 22:26:04 1.19 @@ -1,37 +1,34 @@ /***************************************************************************** -* -* XVID MPEG-4 VIDEO CODEC -* - XviD Main header file - -* -* 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 -* (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 -* 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 -* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -* -*****************************************************************************/ -/***************************************************************************** -* -* History -* -* - 2002/06/13 Added legal header, ANSI C comment style (only for this header -* as it can be included in a ANSI C project). -* -* ToDo ? : when BFRAMES is defined, the API_VERSION should not -* be the same (3.0 ?) -* -* $Id: xvid.h,v 1.17.2.28 2003/02/12 12:03:30 syskin Exp $ -* -*****************************************************************************/ - + * + * XVID MPEG-4 VIDEO CODEC + * - XviD Main header file - + * + * This program is an implementation of a part of one or more MPEG-4 + * Video tools as specified in ISO/IEC 14496-2 standard. Those intending + * to use this software module in hardware or software products are + * advised that its use may infringe existing patents or copyrights, and + * any such use would be at such party's own risk. The original + * developer of this software module and his/her company, and subsequent + * editors and their companies, will have no liability for use of this + * software or modifications or derivatives thereof. + * + * 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 + * (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 + * 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 + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * $Id: xvid.h,v 1.19 2002/09/04 22:26:04 edgomez Exp $ + * + *****************************************************************************/ #ifndef _XVID_H_ #define _XVID_H_ @@ -46,49 +43,30 @@ /* 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 */ -#define XVID_ERR_FAIL -1 -#define XVID_ERR_OK 0 -#define XVID_ERR_MEMORY 1 -#define XVID_ERR_FORMAT 2 +#define XVID_ERR_FAIL -1 +#define XVID_ERR_OK 0 +#define XVID_ERR_MEMORY 1 +#define XVID_ERR_FORMAT 2 /* Colorspaces */ -#define XVID_CSP_RGB24 0 /* [b|g|r] */ -#define XVID_CSP_YV12 1 -#define XVID_CSP_YUY2 2 -#define XVID_CSP_UYVY 3 -#define XVID_CSP_I420 4 -#define XVID_CSP_RGB555 10 -#define XVID_CSP_RGB565 11 -#define XVID_CSP_USER 12 -#define XVID_CSP_EXTERN 1004 // per slice rendering -#define XVID_CSP_YVYU 1002 -#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_RGB24 0 +#define XVID_CSP_YV12 1 +#define XVID_CSP_YUY2 2 +#define XVID_CSP_UYVY 3 +#define XVID_CSP_I420 4 +#define XVID_CSP_RGB555 10 +#define XVID_CSP_RGB565 11 +#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_NULL 9999 - -#define XVID_CSP_NULL 9999 - -#define XVID_CSP_VFLIP 0x80000000 // flip mask +#define XVID_CSP_VFLIP 0x80000000 // flip mask /***************************************************************************** @@ -96,37 +74,22 @@ ****************************************************************************/ /* 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_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 */ + /* x86 cpu flags */ +#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 + /* ia64 cpu flags */ +#define XVID_CPU_IA64 0x00000080 + +#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 @@ -140,15 +103,6 @@ } XVID_INIT_PARAM; - typedef struct - { - XVID_IMAGE input; - XVID_IMAGE output; - int width; - int height; - int interlacing; - } XVID_INIT_CONVERTINFO; - /***************************************************************************** * Initialization entry point ****************************************************************************/ @@ -164,11 +118,6 @@ ****************************************************************************/ /* 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 /***************************************************************************** @@ -184,33 +133,6 @@ 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; @@ -251,14 +173,12 @@ * Encoder constants ****************************************************************************/ -/* Flags for XVID_ENC_PARAM.global */ -#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_PARAM.global + * ToDo : Remove this part when BFRAMES stuff will be out of XviD stable tree + */ +#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 */ /* Flags for XVID_ENC_FRAME.general */ #define XVID_VALID_FLAGS 0x80000000 @@ -267,9 +187,9 @@ #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_LATEINTRA 0x00000200 #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */ #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */ @@ -286,69 +206,32 @@ #define XVID_ME_PMVFAST 0x00080000 #define XVID_ME_EPZS 0x00100000 -#define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */ - /* color input material chroma is ignored) */ - -#define XVID_GMC 0x10000000 -#define XVID_GMC_TRANSLATIONAL 0x20000000 - -#define XVID_REDUCED 0x04000000 /* reduced resolution vop */ -#define XVID_HQACPRED 0x08000000 /* 20030209: high quality ac prediction */ -#define XVID_EXTRASTATS 0x00000200 /* generate extra statistics */ - -#define XVID_MODEDECISION_DCT 0x00400000 /* enable DCT-ME and use it for mode decision */ +#define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */ +#define XVID_GRAYSCALE XVID_GREYSCALE /* color input material chroma is ignored) */ /* Flags for XVID_ENC_FRAME.motion */ +#define PMV_ADVANCEDDIAMOND8 0x00004000 +#define PMV_ADVANCEDDIAMOND16 0x00008000 -#define PMV_ADVANCEDDIAMOND16 0x00008000 /* use advdiamonds instead of diamonds as search pattern */ -#define PMV_USESQUARES16 0x00800000 /* use squares instead of diamonds as search pattern */ - +#define PMV_HALFPELDIAMOND16 0x00010000 #define PMV_HALFPELREFINE16 0x00020000 -#define PMV_HALFPELREFINE8 0x02000000 - -#define PMV_QUARTERPELREFINE16 0x00040000 -#define PMV_QUARTERPELREFINE8 0x04000000 - -#define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */ - -#define PMV_EXTSEARCH8 0x08000000 /* use diamond/square for extended 8x8 search */ -#define PMV_ADVANCEDDIAMOND8 0x00004000 /* use advdiamond for PMV_EXTSEARCH8 */ -#define PMV_USESQUARES8 0x80000000 /* use square for PMV_EXTSEARCH8 */ - -#define PMV_CHROMA16 0x00100000 /* also use chroma for P_VOP/S_VOP ME */ -#define PMV_CHROMA8 0x10000000 /* also use chroma for B_VOP ME */ - -/* Motion search using DCT. use XVID_MODEDECISION_DCT to enable */ -#define HALFPELREFINE16_DCT 0x00000100 /* perform DCT-based halfpel refinement */ -#define HALFPELREFINE8_DCT 0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */ -#define QUARTERPELREFINE16_DCT 0x00000400 /* perform DCT-based qpel refinement */ -#define QUARTERPELREFINE8_DCT 0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */ - -#define EXTSEARCH_DCT 0x00001000 /* perform DCT-based search using square pattern */ - /* enable PMV_EXTSEARCH8 to do this in 8x8 search as well */ -#define CHECKPREDICTION_DCT 0x00002000 /* always check vector equal to prediction */ - - -/* note: old and deprecated - or never implemented */ - -/* only for compatability with old encoders */ - -#define PMV_EARLYSTOP16 0x00 -#define PMV_EARLYSTOP8 0x00 -#define PMV_QUICKSTOP16 0x00 -#define PMV_QUICKSTOP8 0x00 - -#define PMV_HALFPELDIAMOND16 0x00 -#define PMV_HALFPELDIAMOND8 0x00 - +#define PMV_EXTSEARCH16 0x00040000 /* extend PMV by more searches */ +#define PMV_EARLYSTOP16 0x00080000 +#define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more refinement */ #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ +#define PMV_USESQUARES16 0x00800000 + +#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_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */ #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */ - -#define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_CHROMA[16/8] */ +#define PMV_USESQUARES8 0x80000000 /***************************************************************************** @@ -357,28 +240,21 @@ typedef struct { - int width, height; - int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */ - int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */ - int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */ - int rc_averaging_period; /* as above */ - int rc_buffer; /* as above */ - int max_quantizer; /* the upper limit of the quantizer */ - int min_quantizer; /* the lower limit of the quantizer */ - int max_key_interval; /* the maximum interval between key frames */ + int width; + int height; + int fincr; + int fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */ + int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */ + int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */ + int rc_averaging_period; /* as above */ + int rc_buffer; /* as above */ + int max_quantizer; /* the upper limit of the quantizer */ + int min_quantizer; /* the lower limit of the quantizer */ + int max_key_interval; /* the maximum interval between key frames */ #ifdef _SMP - int num_threads; /* number of threads */ + int num_threads; /* number of threads */ #endif - 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 - * 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 */ + void *handle; /* [out] encoder instance handle */ } XVID_ENC_PARAM; @@ -422,7 +298,6 @@ 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 */ @@ -433,8 +308,6 @@ */ HINTINFO hint; /* [in/out] mv hint information */ - int bquant; /* [in] bframe quantizer */ - } XVID_ENC_FRAME; @@ -444,9 +317,7 @@ 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;