--- trunk/xvidcore/src/xvid.h 2002/10/24 10:56:07 610 +++ trunk/xvidcore/src/xvid.h 2003/03/04 10:55:21 903 @@ -3,32 +3,25 @@ * 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 file is part of XviD, a free MPEG-4 video encoder/decoder * - * 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.21 2002-10-24 10:56:07 suxen_drol Exp $ + * $Id: xvid.h,v 1.28 2003-03-04 10:55:21 syskin Exp $ * - *****************************************************************************/ + ****************************************************************************/ #ifndef _XVID_H_ #define _XVID_H_ @@ -37,280 +30,138 @@ extern "C" { #endif - -/** - * \defgroup global_grp Global constants used in both encoder and decoder. - * - * This module describe all constants used in both the encoder and the decoder. - * @{ - */ - /***************************************************************************** - * API version number + * Global constants ****************************************************************************/ -/** - * \defgroup api_grp API version - * @{ - */ - -#define API_VERSION ((2 << 16) | (1))/**< This constant tells you what XviD's - * version this header defines. - * - * You can use it to check if the host XviD library API is the same as the one - * you used to build you client program. If versions mismatch, then it is - * highly possible that your application will segfault because the host XviD - * library and your application use structure fields in different ways. - * - */ - -/** @} */ - +/* API Version : 2.1 */ +#define API_VERSION ((2 << 16) | (1)) +#define XVID_API_UNSTABLE -/***************************************************************************** - * Error codes - ****************************************************************************/ - - -/** - * \defgroup error_grp Error codes used by XviD API entry points. - * @{ - */ - -#define XVID_ERR_FAIL -1 /**< Operation failed. - * - * The requested XviD operation failed. If this error code is returned from : - * - */ - -#define XVID_ERR_OK 0 /**< Operation succeed. - * - * The requested XviD operation succeed, you can continue to use XviD's - * functions. - */ - -#define XVID_ERR_MEMORY 1 /**< Operation failed. - * - * No memory was available on the host system, this is probably time to kill - * some unuseful programs (WinSpyWare, KDE, GNOME) in order to - * use XviD. - */ - -#define XVID_ERR_FORMAT 2 /**< Operation failed. - * - * The format of the parameters, input stream were wrong. +/* 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 -/***************************************************************************** - * Color space constants - ****************************************************************************/ - - -/** - * \defgroup csp_grp Colorspaces constants. - * @{ - */ -#define XVID_CSP_RGB24 0 /**< Input/output frame uses the RGB24 colorspace format */ -#define XVID_CSP_YV12 1 /**< Input/output frame uses the YV12 colorspace format */ -#define XVID_CSP_YUY2 2 /**< Input/output frame uses the YUV2 colorspace format */ -#define XVID_CSP_UYVY 3 /**< Input/output frame uses the UYVY colorspace format */ -#define XVID_CSP_I420 4 /**< Input/output frame uses the I420 colorspace format */ -#define XVID_CSP_RGB555 10 /**< Input/output frame uses the RGB555 colorspace format */ -#define XVID_CSP_RGB565 11 /**< Input/output frame uses the RGB565 colorspace format */ -#define XVID_CSP_USER 12 /**< Input/output frame uses the USER colorspace format - * - * XviD will not perform any colorspace conversion. The - * output will be the native MPEG4 YV12 colorspace. Up to - * the client application to convert it to a usable format. */ -#define XVID_CSP_EXTERN 1004 /**< Special colorspace used for slice rendering - * - * The application provides an external buffer to XviD. - * This way, XviD works directly into the final rendering - * buffer, no need to specify this is a speed boost feature. - * This feature is only used by mplayer at the moment, refer - * to mplayer code to see how it can be used. */ -#define XVID_CSP_YVYU 1002 /**< Input/output frame uses the YVYU colorspace format */ -#define XVID_CSP_RGB32 1000 /**< Input/output frame uses the RGB32 colorspace format */ -#define XVID_CSP_NULL 9999 /**< Input/output frame uses the NULL colorspace format */ +/* 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_VFLIP 0x80000000 /**< Flips input/output frames */ -/** @} */ -/** @} */ +#define XVID_CSP_NULL 9999 -/** - * \defgroup init_grp Initialization constants, structures and functions. - * - * This section describes all the constants, structures and functions used to - * initialize the XviD core library - * - * @{ - */ +#define XVID_CSP_VFLIP 0x80000000 /* flip mask */ /***************************************************************************** - * CPU flags + * Initialization constants ****************************************************************************/ +/* CPU flags for XVID_INIT_PARAM.cpu_flags */ +#define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */ +#define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */ +#define XVID_CPU_ASM 0x00000080 /* native assembly */ -/** - * \defgroup cpu_grp Flags for XVID_INIT_PARAM.cpu_flags. - * - * This section describes all constants that show host cpu available features, - * and allow a client application to force usage of some cpu instructions sets. - * @{ - */ - - -/** - * \defgroup x86_grp x86 specific cpu flags - * @{ - */ - -#define XVID_CPU_MMX 0x00000001 /**< use/has MMX instruction set */ -#define XVID_CPU_MMXEXT 0x00000002 /**< use/has MMX-ext (pentium3) instruction set */ -#define XVID_CPU_SSE 0x00000004 /**< use/has SSE (pentium3) instruction set */ -#define XVID_CPU_SSE2 0x00000008 /**< use/has SSE2 (pentium4) instruction set */ -#define XVID_CPU_3DNOW 0x00000010 /**< use/has 3dNOW (k6-2) instruction set */ -#define XVID_CPU_3DNOWEXT 0x00000020 /**< use/has 3dNOW-ext (???) instruction set */ -#define XVID_CPU_TSC 0x00000040 /**< has TimeStampCounter instruction */ - -/** @} */ - -/** - * \defgroup ia64_grp ia64 specific cpu flags. - * @{ - */ - -#define XVID_CPU_IA64 0x00000080 /**< Forces ia64 optimized code usage - * - * This flags allow client applications to force IA64 optimized functions. - * This feature is considered exeperimental and should be treated as is. - */ - -/** @} */ - -/** - * \defgroup iniflags_grp Initialization commands. - * - * @{ - */ +/* ARCH_IS_IA32 */ +#define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */ +#define XVID_CPU_MMXEXT 0x00000002 /* mmx-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 */ -#define XVID_CPU_CHKONLY 0x40000000 /**< Check cpu features - * - * When this flag is set, the xvid_init function performs just a cpu feature - * checking and then fills the cpu field. This flag is usefull when client - * applications want to know what instruction sets the host cpu supports. - */ +/* ARCH_IS_IA64 */ +#define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */ -#define XVID_CPU_FORCE 0x80000000 /**< Force input flags to be used - * - * When this flag is set, client application forces XviD to use other flags - * set in cpu_flags. \b Use this at your own risk. - */ +/* ARCH_IS_PPC */ +#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ -/** @} */ -/** @} */ + 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 ****************************************************************************/ -/** Structure used in xvid_init function. */ typedef struct { - int cpu_flags; /**< [in/out] - * - * Filled with desired[in] or available[out] - * cpu instruction sets. - */ - int api_version; /**< [out] - * - * xvid_init will initialize this field with - * the API_VERSION used in this XviD core - * library - */ - int core_build; /**< [out] - * \todo Still unused at the moment, what do we - * do with that ? - */ - } - XVID_INIT_PARAM; + 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 ****************************************************************************/ -/** - * \defgroup inientry_grp Initialization entry point. - * @{ - */ - -/** - * \brief Initialization entry point. - * - * This is the XviD's initialization entry point, it is only used to initialize - * the XviD internal data (function pointers, vector length code tables, - * rgb2yuv lookup tables). - * - * \param handle Reserved for future use. - * \param opt Reserved for future use (set it to 0). - * \param param1 Used to pass an XVID_INIT_PARAM parameter. - * \param param2 Reserved for future use. - */ int xvid_init(void *handle, - int opt, - void *param1, - void *param2); + int opt, + void *param1, + void *param2); -/** @} */ - -/** @} */ /***************************************************************************** - * Decoder constant + * Decoder constants ****************************************************************************/ -/** - * \defgroup decoder_grp Decoder related functions and structures. - * - * This part describes all the structures/functions from XviD's API needed for - * decoding a MPEG4 compliant stream. - * @{ - */ - -/** - * \defgroup decframe_grp Flags for XVID_DEC_FRAME.general - * - * Flags' description for the XVID_DEC_FRAME.general member. - * - * @{ - */ - -/** Not used at the moment */ -#define XVID_QUICK_DECODE 0x00000010 - - -/** - * @} - */ +/* Flags for XVID_DEC_FRAME.general */ +#define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. VFW) */ +#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 /***************************************************************************** * Decoder structures @@ -321,8 +172,34 @@ int width; int height; void *handle; - } - XVID_DEC_PARAM; + } 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 @@ -334,11 +211,10 @@ void *image; int stride; int colorspace; - } - XVID_DEC_FRAME; + } XVID_DEC_FRAME; - // This struct is used for per slice rendering + /* This struct is used for per slice rendering */ typedef struct { void *y,*u,*v; @@ -350,454 +226,232 @@ * Decoder entry point ****************************************************************************/ -/** - * \defgroup decops_grp Decoder operations - * - * These are all the operations XviD's decoder can perform. - * - * @{ - */ +/* decoder options */ +#define XVID_DEC_DECODE 0 +#define XVID_DEC_CREATE 1 +#define XVID_DEC_DESTROY 2 -#define XVID_DEC_DECODE 0 /**< Decodes a frame - * - * This operation constant is used when client application wants to decode a - * frame. Client application must also fill XVID_DEC_FRAME appropriately. - */ + int xvid_decore(void *handle, + int opt, + void *param1, + void *param2); -#define XVID_DEC_CREATE 1 /**< Creates a decoder instance - * - * This operation constant is used by a client application in order to create - * a decoder instance. All instances are independant from each other, so - * client application can use safely various threads, each decoding a - * different MPEG4 bitstream. - */ -#define XVID_DEC_DESTROY 2 /**< Destroys a decoder instance - * - * This operation constant is used by the client application to destroy a - * previously created decoder instance. - */ +/***************************************************************************** + * 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 */ -/** - * \defgroup decentry_grp Decoder entry point - * - * @{ - */ +#define XVID_GLOBAL_EXTRASTATS 0x00000200 /* generate extra statistics */ -/** - * \brief Decoder entry point. - * - * This is the XviD's decoder entry point. The possible operations are - * described in the \ref decops_grp section. - * - * \param handle Todo - * \param opt Todo - * \param param1 Todo - * \param param2 Todo - */ - int xvid_decore(void *handle, - int opt, - void *param1, - void *param2); +/* Flags for XVID_ENC_FRAME.general */ +#define XVID_VALID_FLAGS 0x80000000 -/** @} */ +#define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */ +#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 */ +#define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */ -/** - * \defgroup encoder_grp Encoder related functions and structures. - * - * @{ - */ +#define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */ +#define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */ -/***************************************************************************** - * Encoder constants - ****************************************************************************/ +#define XVID_INTER4V 0x00008000 -/** - * \defgroup encgenflags_grp Flags for XVID_ENC_FRAME.general - * @{ - */ +#define XVID_ME_ZERO 0x00010000 +#define XVID_ME_LOGARITHMIC 0x00020000 +#define XVID_ME_FULLSEARCH 0x00040000 +#define XVID_ME_PMVFAST 0x00080000 +#define XVID_ME_EPZS 0x00100000 -#define XVID_VALID_FLAGS 0x80000000 /**< Reserved for future use */ +#define XVID_CHROMAOPT 0x00200000 /* enable chroma optimization pre-filter */ -#define XVID_CUSTOM_QMATRIX 0x00000004 /**< Use custom quantization matrices - * - * This flag forces XviD to use custom matrices passed to encoder in - * XVID_ENC_FRAME structure (members quant_intra_matrix and quant_inter_matrix) */ -#define XVID_H263QUANT 0x00000010 /**< Use H263 quantization - * - * This flag forces XviD to use H263 quantization type */ -#define XVID_MPEGQUANT 0x00000020 /**< Use MPEG4 quantization. - * - * This flag forces XviD to use MPEG4 quantization type */ -#define XVID_HALFPEL 0x00000040 /**< Halfpel motion estimation - * -* informs xvid to perform a half pixel motion estimation. */ -#define XVID_ADAPTIVEQUANT 0x00000080/**< Adaptive quantization - * -* informs xvid to perform an adaptative quantization using a Luminance -* masking algorithm */ -#define XVID_LUMIMASKING 0x00000100/**< Lumiomasking flag - * -* \deprecated Please do not use this flag anymore */ -#define XVID_LATEINTRA 0x00000200/**< Unknown - * -* ??? */ -#define XVID_INTERLACING 0x00000400/**< MPEG4 interlacing mode. - * -* Switches MPEG4 interlacing mode */ -#define XVID_TOPFIELDFIRST 0x00000800/**< - * -* */ -#define XVID_ALTERNATESCAN 0x00001000/**< - * -* */ -#define XVID_HINTEDME_GET 0x00002000/**< Gets Motion vector data from ME system. - * -* informs xvid to return Motion Estimation vectors from the ME encoder -* algorithm. Used during a first pass. */ -#define XVID_HINTEDME_SET 0x00004000/**< Gives Motion vectors hint to ME system. - * -* informs xvid to use the user given motion estimation vectors as hints -* for the encoder ME algorithms. Used during a 2nd pass. */ -#define XVID_INTER4V 0x00008000/**< Inter4V mode. - * -* forces XviD to search a vector for each 8x8 block within the 16x16 Macro -* Block. This mode should be used only if the XVID_HALFPEL mode is activated -* (this could change in the future). */ -#define XVID_ME_ZERO 0x00010000/**< Unused - * -* Do not use this flag (reserved for future use) */ -#define XVID_ME_LOGARITHMIC 0x00020000/**< Unused - * -* Do not use this flag (reserved for future use) */ -#define XVID_ME_FULLSEARCH 0x00040000/**< Unused - * -* Do not use this flag (reserved for future use) */ -#define XVID_ME_PMVFAST 0x00080000/**< Use PMVfast ME algorithm. - * -* Switches XviD ME algorithm to PMVfast */ -#define XVID_ME_EPZS 0x00100000/**< Use EPZS ME algorithm. - * -* Switches XviD ME algorithm to EPZS */ -#define XVID_GREYSCALE 0x01000000/**< Discard chroma data. - * -* This flags forces XviD to discard chroma data, this is not mpeg4 greyscale -* mode, it simply drops chroma MBs using cbp == 0 for these blocks */ -#define XVID_GRAYSCALE XVID_GREYSCALE /**< XVID_GREYSCALE alia for US speakerss - * -* Same as above */ - -/** @} */ - -/** - * \defgroup encmotionflags_grp Flags for XVID_ENC_FRAME.motion - * @{ - */ +#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_BITS 0x00400000 /* enable DCT-ME and use it for mode decision */ + + +/* Flags for XVID_ENC_FRAME.motion */ +#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_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_ADVANCEDDIAMOND8 0x00004000/**< Uses advanced diamonds for 8x8 blocks - * -* Same as its 16x16 companion option -*/ -#define PMV_ADVANCEDDIAMOND16 0x00008000/**< Uses advanced diamonds for 16x16 blocks - * -* */ -#define PMV_HALFPELDIAMOND16 0x00010000/**< Turns on halfpel precision for 16x16 blocks - * -* switches the search algorithm from 1 or 2 full pixels precision to 1 or 2 half pixel precision. -*/ -#define PMV_HALFPELREFINE16 0x00020000/**< Turns on halfpel refinement step - * -* After normal diamond search, an extra halfpel refinement step is performed. Should always be used if -* XVID_HALFPEL is on, because it gives a rather big increase in quality. -*/ -#define PMV_EXTSEARCH16 0x00040000/**< Extends search for 16x16 blocks - * -* Normal PMVfast predicts one start vector and does diamond search around this position. EXTSEARCH means that 2 -* more start vectors are used: (0,0) and median predictor and diamond search is done for those, too. Makes -* search slightly slower, but quality sometimes gets better. -*/ -#define PMV_EARLYSTOP16 0x00080000/**< Dynamic ME thresholding - * -* PMVfast and EPZS stop search if current best is below some dynamic threshhold. No diamond search is done, -* only halfpel refinement (if active). Without EARLYSTOP diamond search is always done. That would be much slower, -* but not really lead to better quality. -*/ -#define PMV_QUICKSTOP16 0x00100000/**< Dynamic ME thresholding - * -* like EARLYSTOP, but not even halfpel refinement is done. Normally worse quality, so it defaults to -* off. Might be removed, too. -*/ -#define PMV_UNRESTRICTED16 0x00200000/**< Not implemented - * -* "unrestricted ME" is a feature of MPEG4. It's not implemented, so this flag is ignored (not even -* checked). -*/ -#define PMV_OVERLAPPING16 0x00400000/**< Not implemented - * -* Same as above -*/ -#define PMV_USESQUARES16 0x00800000/**< Use square pattern - * -* Replace the diamond search with a square search. -*/ -#define PMV_HALFPELDIAMOND8 0x01000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ -#define PMV_HALFPELREFINE8 0x02000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ -#define PMV_EXTSEARCH8 0x04000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ -#define PMV_EARLYSTOP8 0x08000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ -#define PMV_QUICKSTOP8 0x10000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ -#define PMV_UNRESTRICTED8 0x20000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ -#define PMV_OVERLAPPING8 0x40000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ -#define PMV_USESQUARES8 0x80000000/**< see 16x16 equivalent - * -* Same as its 16x16 companion option */ +#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_BITS to enable */ +#define HALFPELREFINE16_BITS 0x00000100 /* perform DCT-based halfpel refinement */ +#define HALFPELREFINE8_BITS 0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */ +#define QUARTERPELREFINE16_BITS 0x00000400 /* perform DCT-based qpel refinement */ +#define QUARTERPELREFINE8_BITS 0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */ + +#define EXTSEARCH_BITS 0x00001000 /* perform DCT-based search using square pattern + enable PMV_EXTSEARCH8 to do this in 8x8 search as well */ +#define CHECKPREDICTION_BITS 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_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ +#define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ +#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] */ -/** @} */ /***************************************************************************** * Encoder structures ****************************************************************************/ - /** Structure used for encoder instance creation */ typedef struct { - int width; /**< [in] - * - * Input frame width. */ - int height; /**< [in] - * - * Input frame height. */ - int fincr; /**< [in] - * - * Time increment (fps = increment/base). */ - int fbase; /**< [in] - * - * Time base (fps = increment/base). */ - int rc_bitrate; /**< [in] - * - * Sets the target bitrate of the encoded stream, in bits/second. **/ - int rc_reaction_delay_factor; /**< [in] - * - * Tunes how fast the rate control reacts - lower values are faster. */ - int rc_averaging_period; /**< [in] - * - * Tunes how fast the rate control reacts - lower values are faster. */ - int rc_buffer; /**< [in] - * - * Tunes how fast the rate control reacts - lower values are faster. */ - int max_quantizer; /**< [in] - * - * Sets the upper limit of the quantizer. */ - int min_quantizer; /**< [in] - * - * Sets the lower limit of the quantizer. */ - int max_key_interval; /**< [in] - * - * Sets the maximum interval between key frames. */ - void *handle; /**< [out] - * - * XviD core lib will set this with the creater encoder instance. */ - } - XVID_ENC_PARAM; + int width, height; + int fincr, fbase; /* [in] frame increment, fbase. each frame = "fincr/fbase" seconds */ + int rc_bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */ + int rc_reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */ + int rc_averaging_period; /* [in] as above */ + int rc_buffer; /* [in] as above */ + int max_quantizer; /* [in] the upper limit of the quantizer */ + int min_quantizer; /* [in] the lower limit of the quantizer */ + int max_key_interval; /* [in] the maximum interval between key frames */ +#ifdef _SMP + int num_threads; /* [in] number of threads */ +#endif + int global; /* [in] global/debug options */ + int max_bframes; /* [in] max sequential bframes (0=disable bframes) */ + int bquant_ratio; /* [in] bframe quantizer multipier (percentage). + used only when bquant < 1 + eg. 200 = x2 multiplier + quant = ((past_quant + future_quant) * bquant_ratio)/200 + */ + int bquant_offset; /* [in] bquant += bquant_offset */ + int frame_drop_ratio; /* [in] frame dropping: 0=drop none... 100=drop all */ + void *handle; /* [out] encoder instance handle */ + } XVID_ENC_PARAM; typedef struct { int x; int y; - } - VECTOR; + } VECTOR; typedef struct { - int mode; /* macroblock mode */ + int mode; /* macroblock mode */ VECTOR mvs[4]; - } - MVBLOCKHINT; + } MVBLOCKHINT; typedef struct { - int intra; /* frame intra choice */ - int fcode; /* frame fcode */ - MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ - } - MVFRAMEHINT; + int intra; /* frame intra choice */ + int fcode; /* frame fcode */ + MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ + } MVFRAMEHINT; typedef struct { - int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ + int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ MVFRAMEHINT mvhint; - void *hintstream; /* compressed hint buffer */ - int hintlength; /* length of buffer (bytes) */ - } - HINTINFO; - - /** Structure used to pass a frame to the encoder */ - typedef struct - { - int general; /**< [in] - * - * Sets general options flag (See \ref encgenflags_grp) */ - int motion; /**< [in] - * - * Sets Motion Estimation options */ - void *bitstream; /**< [out] - * - * Output MPEG4 bitstream buffer pointer */ - int length; /**< [out] - * - * Output MPEG4 bitstream length (bytes) */ - void *image; /**< [in] - * - * Input frame */ - int colorspace; /**< [in] - * - * input frame colorspace */ - unsigned char *quant_intra_matrix; /**< [in] - * - * Custom intra quantization matrix */ - unsigned char *quant_inter_matrix; /**< [in] - * - * Custom inter quantization matrix */ - int quant; /**< [in] - * - * Frame quantizer : - * */ - int intra; /**< [in/out] - * - * - */ - HINTINFO hint; /**< [in/out] - * - * mv hint information */ - - } - XVID_ENC_FRAME; - - - /** Encoding statistics */ - typedef struct - { - int quant; /**< [out] - * - * Frame quantizer used during encoding */ - int hlength; /**< [out] - * - * Header bytes in the resulting MPEG4 stream */ - int kblks; /**< [out] - * - * Number of MacroBlocks coded as Intra blocks */ - int mblks; /**< [out] - * - * Number of MacroBlocks coded as Inter blocks */ - int ublks; /**< [out] - * - * Number of MacroBlocks coded as skipped blocks */ - } - XVID_ENC_STATS; + void *hintstream; /* compressed hint buffer */ + int hintlength; /* length of buffer (bytes) */ + } HINTINFO; + typedef struct + { + int general; /* [in] general options */ + int motion; /* [in] ME options */ + void *bitstream; /* [in] bitstream ptr */ + int length; /* [out] bitstream length (bytes) */ + + void *image; /* [in] image ptr */ + int stride; /* [in] horizontal stride in bytes */ + int colorspace; /* [in] source colorspace */ + + unsigned char *quant_intra_matrix; /* [in] custom intra qmatrix */ + unsigned char *quant_inter_matrix; /* [in] custom inter qmatrix */ + int quant; /* [in] frame quantizer (vbr) */ + int intra; /* [in] force intra frame (vbr only) + [out] frame type (ugly atm) + */ + HINTINFO hint; /* [in/out] mv hint information */ -/***************************************************************************** - * Encoder entry point - ****************************************************************************/ - -/** - * \defgroup encops_grp Encoder operations - * - * These are all the operations XviD's encoder can perform. - * - * @{ - */ + int bquant; /* [in] bframe quantizer */ + int bframe_threshold; /* [in] sensitivity of B-frame decision */ -#define XVID_ENC_ENCODE 0 /**< Encodes a frame - * - * This operation constant is used when client application wants to encode a - * frame. Client application must also fill XVID_ENC_FRAME appropriately. - */ + } XVID_ENC_FRAME; -#define XVID_ENC_CREATE 1 /**< Creates a decoder instance - * - * This operation constant is used by a client application in order to create - * an encoder instance. All instances are independant from each other, so - * client application can use safely various threads, each encoding a - * different set of frames. - */ -#define XVID_ENC_DESTROY 2 /**< Destroys a encoder instance - * - * This operation constant is used by the client application to destroy a - * previously created encoder instance. - */ + typedef struct + { + int quant; /* [out] frame quantizer */ + int hlength; /* [out] header length (bytes) */ + int kblks; /* [out] number of intra blocks */ + int mblks; /* [out] number of inter blocks */ + int ublks; /* [out] number of "not coded" blocks */ + long sse_y; /* [out] SSE of Y */ + long sse_u; /* [out] SSE of Cb */ + long sse_v; /* [out] SSE of Cr */ + } XVID_ENC_STATS; -/** @} */ +/***************************************************************************** + * Encoder entry point + ****************************************************************************/ -/** - * \defgroup encentry_grp Encoder entry point - * - * @{ - */ +/* Encoder options */ +#define XVID_ENC_ENCODE 0 +#define XVID_ENC_CREATE 1 +#define XVID_ENC_DESTROY 2 -/** - * \brief Encoder entry point. - * - * This is the XviD's encoder entry point. The possible operations are - * described in the \ref encops_grp section. - * - * \param handle Todo - * \param opt Todo - * \param param1 Todo - * \param param2 Todo - */ int xvid_encore(void *handle, int opt, void *param1, void *param2); -/** @} */ - -/** @} */ #ifdef __cplusplus }