--- xvid.h 2003/02/18 00:23:27 1.27 +++ xvid.h 2003/12/10 01:01:31 1.27.2.50 @@ -1,47 +1,71 @@ /***************************************************************************** * - * XVID MPEG-4 VIDEO CODEC - * - XviD Main header file - + * 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 2003/02/18 00:23:27 edgomez Exp $ + * $Id: xvid.h,v 1.27.2.50 2003/12/10 01:01:31 Isibaar Exp $ * ****************************************************************************/ #ifndef _XVID_H_ #define _XVID_H_ + #ifdef __cplusplus extern "C" { #endif /***************************************************************************** - * Global constants + * versioning ****************************************************************************/ -/* 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 +/* versioning + version takes the form "$major.$minor.$patch" + $patch is incremented when there is no api change + $minor is incremented when the api is changed, but remains backwards compatible + $major is incremented when the api is changed significantly + + when initialising an xvid structure, you must always zero it, and set the version field. + memset(&struct,0,sizeof(struct)); + struct.version = XVID_VERSION; + + XVID_UNSTABLE is defined only during development. + */ + +#define XVID_MAKE_VERSION(a,b,c) ((((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff)) +#define XVID_VERSION_MAJOR(a) ((char)(((a)>>16) & 0xff)) +#define XVID_VERSION_MINOR(a) ((char)(((a)>> 8) & 0xff)) +#define XVID_VERSION_PATCH(a) ((char)(((a)>> 0) & 0xff)) + +#define XVID_MAKE_API(a,b) ((((a)&0xff)<<16) | (((b)&0xff)<<0)) +#define XVID_API_MAJOR(a) (((a)>>16) & 0xff) +#define XVID_API_MINOR(a) (((a)>> 0) & 0xff) + +#define XVID_VERSION XVID_MAKE_VERSION(1,0,-127) +#define XVID_API XVID_MAKE_API(4, 0) + +#define XVID_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 ... * @@ -49,411 +73,607 @@ * doesnt hurt but not increasing it could cause difficulty for decoders in the * future */ -#define XVID_BS_VERSION "0009" +#define XVID_BS_VERSION "0023" + + +/***************************************************************************** + * error codes + ****************************************************************************/ + + /* all functions return values <0 indicate error */ + +#define XVID_ERR_FAIL -1 /* general fault */ +#define XVID_ERR_MEMORY -2 /* memory allocation error */ +#define XVID_ERR_FORMAT -3 /* file format error */ +#define XVID_ERR_VERSION -4 /* structure version not supported */ +#define XVID_ERR_END -5 /* encoder only; end of stream reached */ -/* Error codes */ -#define XVID_ERR_FAIL -1 -#define XVID_ERR_OK 0 -#define XVID_ERR_MEMORY 1 -#define XVID_ERR_FORMAT 2 +/***************************************************************************** + * xvid_image_t + ****************************************************************************/ + +/* colorspace values */ -/* 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_USER (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */ +#define XVID_CSP_I420 (1<< 1) /* 4:2:0 planar */ +#define XVID_CSP_YV12 (1<< 2) /* 4:2:0 planar */ +#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ +#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ +#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ +#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ +#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ +#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ +#define XVID_CSP_BGR (1<< 9) /* 24-bit bgr packed */ +#define XVID_CSP_RGB555 (1<<10) /* 16-bit rgb555 packed */ +#define XVID_CSP_RGB565 (1<<11) /* 16-bit rgb565 packed */ +#define XVID_CSP_SLICE (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */ +#define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */ +#define XVID_CSP_NULL (1<<14) /* decoder only: dont output anything */ +#define XVID_CSP_VFLIP (1<<31) /* vertical flip mask */ +/* xvid_image_t + for non-planar colorspaces use only plane[0] and stride[0] + four plane reserved for alpha*/ +typedef struct { + int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */ + void * plane[4]; /* [in] image plane ptrs */ + 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 -#define XVID_CSP_NULL 9999 +/* aspect ratios */ +#define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if AR is not precised (ie: ==0) */ +#define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ +#define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ +#define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ +#define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */ +#define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */ -#define XVID_CSP_VFLIP 0x80000000 /* flip mask */ +/* frame type flags */ +#define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */ +#define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */ +#define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */ +#define XVID_TYPE_IVOP 1 /* intra frame */ +#define XVID_TYPE_PVOP 2 /* predicted frame */ +#define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ +#define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ /***************************************************************************** - * Initialization constants + * xvid_global() ****************************************************************************/ -/* 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 */ +/* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */ +#define XVID_CPU_FORCE (1<<31) /* force passed cpu flags */ +#define XVID_CPU_ASM (1<< 7) /* native assembly */ /* 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_MMX (1<< 0) /* mmx : pentiumMMX,k6 */ +#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ +#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ +#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ +#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ +#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ +#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ +/* ARCH_IS_PPC */ +#define XVID_CPU_ALTIVEC (1<< 0) /* altivec */ -/* ARCH_IS_IA64 */ -#define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */ -/* ARCH_IS_PPC */ -#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ +#define XVID_DEBUG_ERROR (1<< 0) +#define XVID_DEBUG_STARTCODE (1<< 1) +#define XVID_DEBUG_HEADER (1<< 2) +#define XVID_DEBUG_TIMECODE (1<< 3) +#define XVID_DEBUG_MB (1<< 4) +#define XVID_DEBUG_COEFF (1<< 5) +#define XVID_DEBUG_MV (1<< 6) +#define XVID_DEBUG_RC (1<< 7) +#define XVID_DEBUG_DEBUG (1<<31) +/* XVID_GBL_INIT param1 */ +typedef struct { + int version; + unsigned 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; - 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 - ****************************************************************************/ +/* XVID_GBL_INFO param1 */ +typedef struct { + int version; + int actual_version; /* [out] returns the actual xvidcore version */ + const char * build; /* [out] if !null, points to description of this xvid core build */ + unsigned int cpu_flags; /* [out] detected cpu features */ + int num_threads; /* [out] detected number of cpus/threads */ +} xvid_gbl_info_t; - 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 - ****************************************************************************/ +/* XVID_GBL_CONVERT param1 */ +typedef struct { + int version; + xvid_image_t input; /* [in] input image & colorspace */ + xvid_image_t output; /* [in] output image & colorspace */ + int width; /* [in] width */ + int height; /* [in] height */ + int interlacing; /* [in] interlacing */ +} xvid_gbl_convert_t; - int xvid_init(void *handle, - int opt, - void *param1, - void *param2); +#define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */ +#define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ +#define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ -/***************************************************************************** - * Decoder constants - ****************************************************************************/ +int xvid_global(void *handle, int opt, void *param1, void *param2); -/* 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 + * xvid_decore() ****************************************************************************/ - typedef struct - { - int width; - int height; - void *handle; - } 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; - void *bitstream; - int length; - - void *image; - int stride; - int colorspace; - } XVID_DEC_FRAME; - - - /* This struct is used for per slice rendering */ - typedef struct - { - void *y,*u,*v; - int stride_y, stride_u,stride_v; - } XVID_DEC_PICTURE; +#define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ +#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ +#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ +int xvid_decore(void *handle, int opt, void *param1, void *param2); -/***************************************************************************** - * Decoder entry point - ****************************************************************************/ +/* XVID_DEC_CREATE param 1 + image width & height may be specified here when the dimensions are + known in advance. */ +typedef struct { + int version; + int width; /* [in:opt] image width */ + int height; /* [in:opt] image width */ + void * handle; /* [out] decore context handle */ +} xvid_dec_create_t; -/* decoder options */ -#define XVID_DEC_DECODE 0 -#define XVID_DEC_CREATE 1 -#define XVID_DEC_DESTROY 2 - - int xvid_decore(void *handle, - int opt, - void *param1, - void *param2); +/* XVID_DEC_DECODE param1 */ +/* general flags */ +#define XVID_LOWDELAY (1<<0) /* lowdelay mode */ +#define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ +#define XVID_DEBLOCKY (1<<2) /* perform luma deblocking */ +#define XVID_DEBLOCKUV (1<<3) /* perform chroma deblocking */ + +typedef struct { + int version; + int general; /* [in:opt] general flags */ + void *bitstream; /* [in] bitstream (read from)*/ + int length; /* [in] bitstream length */ + xvid_image_t output; /* [in] output image (written to) */ +} xvid_dec_frame_t; -/***************************************************************************** - * 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 */ +/* XVID_DEC_DECODE param2 :: optional */ +typedef struct +{ + int version; -#define XVID_GLOBAL_EXTRASTATS 0x00000200 /* generate extra statistics */ + int type; /* [out] output data type */ + union { + struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ + int general; /* [out] flags */ + int time_base; /* [out] time base */ + int time_increment; /* [out] time increment */ + /* XXX: external deblocking stuff */ + int * qscale; /* [out] pointer to quantizer table */ + int qscale_stride; /* [out] quantizer scale stride */ -/* Flags for XVID_ENC_FRAME.general */ -#define XVID_VALID_FLAGS 0x80000000 + } vop; + struct { /* XVID_TYPE_VOL */ + int general; /* [out] flags */ + int width; /* [out] width */ + int height; /* [out] height */ + int par; /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */ + int par_width; /* [out] aspect ratio width */ + int par_height; /* [out] aspect ratio height */ + } vol; + } data; +} xvid_dec_stats_t; -#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 */ -#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) */ +#define XVID_ZONE_QUANT (1<<0) +#define XVID_ZONE_WEIGHT (1<<1) -#define XVID_INTER4V 0x00008000 +typedef struct +{ + int frame; + int mode; + int increment; + int base; +} xvid_enc_zone_t; -#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_CHROMAOPT 0x00200000 /* enable chroma optimization pre-filter */ -#define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for - color input material chroma is ignored) */ +/***************************************************************************** + xvid plugin system -- internals + + xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE + before encoding each frame xvidcore will call XVID_PLG_BEFORE + after encoding each frame xvidcore will call XVID_PLG_AFTER + xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY + ****************************************************************************/ -#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_PLG_CREATE (1<<0) +#define XVID_PLG_DESTROY (1<<1) +#define XVID_PLG_INFO (1<<2) +#define XVID_PLG_BEFORE (1<<3) +#define XVID_PLG_FRAME (1<<4) +#define XVID_PLG_AFTER (1<<5) -#define XVID_EXTRASTATS 0x00000200 /* generate extra statistics */ +/* xvid_plg_info_t.flags */ +#define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ +#define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ +#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ -#define XVID_MODEDECISION_BITS 0x00400000 /* enable DCT-ME and use it for mode decision */ +typedef struct +{ + int version; + int flags; /* [in:opt] plugin flags */ +} xvid_plg_info_t; -/* 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 +typedef struct +{ + int version; -#define PMV_QUARTERPELREFINE16 0x00040000 -#define PMV_QUARTERPELREFINE8 0x04000000 + int num_zones; /* [out] */ + xvid_enc_zone_t * zones; /* [out] */ -#define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */ + int width; /* [out] */ + int height; /* [out] */ + int mb_width; /* [out] */ + int mb_height; /* [out] */ + int fincr; /* [out] */ + int fbase; /* [out] */ -#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 */ + void * param; /* [out] */ +} xvid_plg_create_t; -#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 */ +typedef struct +{ + int version; -#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 */ + int num_frames; /* [out] total frame encoded */ +} xvid_plg_destroy_t; -/* note: old and deprecated - or never implemented */ +typedef struct +{ + int version; -/* only for compatability with old encoders */ + xvid_enc_zone_t * zone; /* [out] current zone */ -#define PMV_EARLYSTOP16 0x00 -#define PMV_EARLYSTOP8 0x00 -#define PMV_QUICKSTOP16 0x00 -#define PMV_QUICKSTOP8 0x00 + int width; /* [out] */ + int height; /* [out] */ + int mb_width; /* [out] */ + int mb_height; /* [out] */ + int fincr; /* [out] */ + int fbase; /* [out] */ -#define PMV_HALFPELDIAMOND16 0x00 -#define PMV_HALFPELDIAMOND8 0x00 + int min_quant[3]; /* [out] */ + int max_quant[3]; /* [out] */ -#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 */ + xvid_image_t reference; /* [out] -> [out] */ + xvid_image_t current; /* [out] -> [in,out] */ + xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ + int frame_num; /* [out] frame number */ -#define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_CHROMA[16/8] */ + int type; /* [in,out] */ + int quant; /* [in,out] */ + + int * dquant; /* [in,out] pointer to diff quantizer table */ + int dquant_stride; /* [in,out] diff quantizer stride */ + + int vop_flags; /* [in,out] */ + int vol_flags; /* [in,out] */ + int motion_flags; /* [in,out] */ + + int length; /* [out] after: length of encoded frame */ + int kblks; /* [out] number of blocks compressed as Intra */ + int mblks; /* [out] number of blocks compressed as Inter */ + int ublks; /* [out] number of blocks marked not_coded */ + int sse_y; /* [out] Y plane's sse */ + int sse_u; /* [out] U plane's sse */ + int sse_v; /* [out] V plane's sse */ + int bquant_ratio; /* [in] */ + int bquant_offset; /* [in] */ +} xvid_plg_data_t; /***************************************************************************** - * Encoder structures + xvid plugin system -- external + + the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array + indicates the plugin function pointer and plugin-specific data. + xvidcore handles the rest. example: + + xvid_enc_create_t create; + xvid_enc_plugin_t plugins[2]; + + plugins[0].func = xvid_psnr_func; + plugins[0].param = NULL; + plugins[1].func = xvid_cbr_func; + plugins[1].param = &cbr_data; + + create.num_plugins = 2; + create.plugins = plugins; + ****************************************************************************/ - typedef struct - { - 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; - - typedef struct - { - int mode; /* macroblock mode */ - VECTOR mvs[4]; - } 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; - - typedef struct - { - int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ - - MVFRAMEHINT mvhint; - 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 */ - - int bquant; /* [in] bframe quantizer */ - - } XVID_ENC_FRAME; - - - 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; +typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); + +typedef struct +{ + xvid_plugin_func * func; + void * param; +} xvid_enc_plugin_t; + + +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 */ + +xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ +xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ + + +/* single pass rate control + * CBR and Constant quantizer modes */ +typedef struct +{ + int version; + + int bitrate; /* [in] bits per second */ + int reaction_delay_factor; /* [in] */ + int averaging_period; /* [in] */ + int buffer; /* [in] */ +} xvid_plugin_single_t; + + +typedef struct { + int version; + + char * filename; +} xvid_plugin_2pass1_t; + + +#define XVID_PAYBACK_BIAS 0 /* payback with bias */ +#define XVID_PAYBACK_PROP 1 /* payback proportionally */ + +typedef struct { + int version; + + int bitrate; /* [in] bits per second */ + char * filename; /* [in] first pass stats filename */ + + int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ + int curve_compression_high; /* [in] percentage of compression performed on the high part of the curve (above average) */ + int curve_compression_low; /* [in] percentage of compression performed on the low part of the curve (below average) */ + int overflow_control_strength;/* [in] Payback delay expressed in number of frames */ + int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */ + int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */ + + int kfreduction; /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */ + int kfthreshold; /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits + * is substracted from its bit allocation. The reduction is computed as multiples of + * kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold, + * 0 for 1