| 3 |
* XVID MPEG-4 VIDEO CODEC |
* XVID MPEG-4 VIDEO CODEC |
| 4 |
* - XviD Main header file - |
* - XviD Main header file - |
| 5 |
* |
* |
| 6 |
* This program is an implementation of a part of one or more MPEG-4 |
* This file is part of XviD, a free MPEG-4 video encoder/decoder |
|
* 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. |
|
| 7 |
* |
* |
| 8 |
* This program is free software ; you can redistribute it and/or modify |
* This program is free software ; you can redistribute it and/or modify |
| 9 |
* it under the terms of the GNU General Public License as published by |
* it under the terms of the GNU General Public License as published by |
| 21 |
* |
* |
| 22 |
* $Id$ |
* $Id$ |
| 23 |
* |
* |
| 24 |
*****************************************************************************/ |
****************************************************************************/ |
| 25 |
|
|
| 26 |
#ifndef _XVID_H_ |
#ifndef _XVID_H_ |
| 27 |
#define _XVID_H_ |
#define _XVID_H_ |
| 28 |
|
|
| 29 |
|
|
| 30 |
#ifdef __cplusplus |
#ifdef __cplusplus |
| 31 |
extern "C" { |
extern "C" { |
| 32 |
#endif |
#endif |
| 33 |
|
|
|
|
|
|
/** |
|
|
* \defgroup global_grp Global constants used in both encoder and decoder. |
|
|
* |
|
|
* This module describe all constants used in both the encoder and the decoder. |
|
|
* @{ |
|
|
*/ |
|
|
|
|
| 34 |
/***************************************************************************** |
/***************************************************************************** |
| 35 |
* API version number |
* versioning |
| 36 |
****************************************************************************/ |
****************************************************************************/ |
| 37 |
|
|
| 38 |
/** |
/* versioning |
| 39 |
* \defgroup api_grp API version |
version takes the form "$major.$minor.$patch" |
| 40 |
* @{ |
$patch is incremented when there is no api change |
| 41 |
*/ |
$minor is incremented when the api is changed, but remains backwards compatible |
| 42 |
|
$major is incremented when the api is changed significantly |
|
#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 different structures. |
|
|
* |
|
|
*/ |
|
|
|
|
|
/** @} */ |
|
| 43 |
|
|
| 44 |
|
when initialising an xvid structure, you must always zero it, and set the version field. |
| 45 |
|
memset(&struct,0,sizeof(struct)); |
| 46 |
|
struct.version = XVID_VERSION; |
| 47 |
|
|
| 48 |
/***************************************************************************** |
XVID_UNSTABLE is defined only during development. |
| 49 |
* Error codes |
*/ |
|
****************************************************************************/ |
|
| 50 |
|
|
| 51 |
|
#define XVID_MAKE_VERSION(a,b,c) ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) ) |
| 52 |
|
#define XVID_MAJOR(a) ( ((a)>>16) & 0xff ) |
| 53 |
|
#define XVID_MINOR(b) ((char)( ((b)>>8) & 0xff )) |
| 54 |
|
#define XVID_PATCH(c) ( (c) & 0xff ) |
| 55 |
|
|
| 56 |
/** |
#define XVID_VERSION XVID_MAKE_VERSION(1,-127,0) |
| 57 |
* \defgroup error_grp Error codes returned by XviD API entry points. |
#define XVID_UNSTABLE |
|
* @{ |
|
|
*/ |
|
| 58 |
|
|
| 59 |
#define XVID_ERR_FAIL -1 /**< Operation failed. |
/* Bitstream Version |
| 60 |
|
* this will be writen into the bitstream to allow easy detection of xvid |
| 61 |
|
* encoder bugs in the decoder, without this it might not possible to |
| 62 |
|
* automatically distinquish between a file which has been encoded with an |
| 63 |
|
* old & buggy XVID from a file which has been encoded with a bugfree version |
| 64 |
|
* see the infamous interlacing bug ... |
| 65 |
* |
* |
| 66 |
* The requested XviD operation failed. If this error code is returned from : |
* this MUST be increased if an encoder bug is fixed, increasing it too often |
| 67 |
* <ul> |
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
| 68 |
* <li>the xvid_init function : you must not try to use an XviD's instance from |
* future |
|
* this point of the code. Clean all instances you |
|
|
* already created and exit the program cleanly. |
|
|
* <li>xvid_encore or xvid_decore : something was wrong and en/decoding |
|
|
* operation was not completed sucessfully. |
|
|
* you can stop the en/decoding process or just |
|
|
* ignore and go on. |
|
|
* <li>xvid_stop : you can safely ignore it if you call this function at the |
|
|
* end of your program. |
|
|
* </ul> |
|
| 69 |
*/ |
*/ |
| 70 |
|
#define XVID_BS_VERSION "0009" |
| 71 |
|
|
|
#define XVID_ERR_OK 0 /**< Operation succeed. |
|
|
* |
|
|
* The requested XviD operation succeed, you can continue to use XviD's |
|
|
* functions. |
|
|
*/ |
|
| 72 |
|
|
| 73 |
#define XVID_ERR_MEMORY 1 /**< Operation failed. |
/***************************************************************************** |
| 74 |
* |
* error codes |
| 75 |
* Insufficent memory was available on the host system. |
****************************************************************************/ |
|
*/ |
|
| 76 |
|
|
| 77 |
#define XVID_ERR_FORMAT 2 /**< Operation failed. |
/* all functions return values <0 indicate error */ |
| 78 |
* |
|
| 79 |
* The format of the parameters or input stream were incorrect. |
#define XVID_ERR_FAIL -1 /* general fault */ |
| 80 |
*/ |
#define XVID_ERR_MEMORY -2 /* memory allocation error */ |
| 81 |
|
#define XVID_ERR_FORMAT -3 /* file format error */ |
| 82 |
|
#define XVID_ERR_VERSION -4 /* structure version not supported */ |
| 83 |
|
#define XVID_ERR_END -5 /* encoder only; end of stream reached */ |
| 84 |
|
|
|
/** @} */ |
|
| 85 |
|
|
| 86 |
|
|
| 87 |
/***************************************************************************** |
/***************************************************************************** |
| 88 |
* Color space constants |
* xvid_image_t |
| 89 |
****************************************************************************/ |
****************************************************************************/ |
| 90 |
|
|
| 91 |
|
/* colorspace values */ |
| 92 |
|
|
| 93 |
/** |
#define XVID_CSP_USER 0 /* 4:2:0 planar */ |
| 94 |
* \defgroup csp_grp Colorspaces constants. |
#define XVID_CSP_I420 1 /* 4:2:0 packed(planar win32) */ |
| 95 |
* @{ |
#define XVID_CSP_YV12 2 /* 4:2:0 packed(planar win32) */ |
| 96 |
*/ |
#define XVID_CSP_YUY2 3 /* 4:2:2 packed */ |
| 97 |
|
#define XVID_CSP_UYVY 4 /* 4:2:2 packed */ |
| 98 |
|
#define XVID_CSP_YVYU 5 /* 4:2:2 packed */ |
| 99 |
|
#define XVID_CSP_BGRA 6 /* 32-bit bgra packed */ |
| 100 |
|
#define XVID_CSP_ABGR 7 /* 32-bit abgr packed */ |
| 101 |
|
#define XVID_CSP_RGBA 8 /* 32-bit rgba packed */ |
| 102 |
|
#define XVID_CSP_BGR 9 /* 32-bit bgr packed */ |
| 103 |
|
#define XVID_CSP_RGB555 10 /* 16-bit rgb555 packed */ |
| 104 |
|
#define XVID_CSP_RGB565 11 /* 16-bit rgb565 packed */ |
| 105 |
|
#define XVID_CSP_SLICE 12 /* decoder only: 4:2:0 planar, per slice rendering */ |
| 106 |
|
#define XVID_CSP_INTERNAL 13 /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */ |
| 107 |
|
#define XVID_CSP_NULL 14 /* decoder only: dont output anything */ |
| 108 |
|
#define XVID_CSP_VFLIP 0x80000000 /* vertical flip mask */ |
| 109 |
|
|
| 110 |
#define XVID_CSP_RGB24 0 /**< 24-bit RGB colorspace (b,g,r packed) */ |
/* xvid_image_t |
| 111 |
#define XVID_CSP_YV12 1 /**< YV12 colorspace (y,v,u planar) */ |
for non-planar colorspaces use only plane[0] and stride[0] |
| 112 |
#define XVID_CSP_YUY2 2 /**< YUY2 colorspace (y,u,y,v packed) */ |
four plane reserved for alpha*/ |
| 113 |
#define XVID_CSP_UYVY 3 /**< UYVY colorspace (u,y,v,y packed) */ |
typedef struct { |
| 114 |
#define XVID_CSP_I420 4 /**< I420 colorsapce (y,u,v planar) */ |
int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */ |
| 115 |
#define XVID_CSP_RGB555 10 /**< 16-bit RGB555 colorspace */ |
void * plane[4]; /* [in] image plane ptrs */ |
| 116 |
#define XVID_CSP_RGB565 11 /**< 16-bit RGB565 colorspace */ |
int stride[4]; /* [in] image stride; "bytes per row"*/ |
| 117 |
#define XVID_CSP_USER 12 /**< user colorspace format, where the image buffer points |
} xvid_image_t; |
|
* to a DEC_PICTURE (y,u,v planar) structure. |
|
|
* |
|
|
* For encoding, image is read from the DEC_PICTURE |
|
|
* parameter values. For decoding, the DEC_PICTURE |
|
|
* parameters are set, pointing to the internal XviD |
|
|
* image buffer. */ |
|
|
#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 /**< YVYU colorspace (y,v,y,u packed) */ |
|
|
#define XVID_CSP_RGB32 1000 /**< 32-bit RGB colorspace (b,g,r,a packed) */ |
|
|
#define XVID_CSP_NULL 9999 /**< NULL colorspace; no conversion is performed */ |
|
| 118 |
|
|
|
#define XVID_CSP_VFLIP 0x80000000 /**< (flag) Flip frame vertically during conversion */ |
|
| 119 |
|
|
| 120 |
/** @} */ |
/* aspect ratios */ |
| 121 |
|
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */ |
| 122 |
/** @} */ |
#define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ |
| 123 |
|
#define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ |
| 124 |
/** |
#define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ |
| 125 |
* \defgroup init_grp Initialization constants, structures and functions. |
#define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */ |
| 126 |
* |
#define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */ |
|
* This section describes all the constants, structures and functions used to |
|
|
* initialize the XviD core library |
|
|
* |
|
|
* @{ |
|
|
*/ |
|
| 127 |
|
|
| 128 |
|
/* frame type flags */ |
| 129 |
|
#define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */ |
| 130 |
|
#define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */ |
| 131 |
|
#define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */ |
| 132 |
|
#define XVID_TYPE_IVOP 1 /* intra frame */ |
| 133 |
|
#define XVID_TYPE_PVOP 2 /* predicted frame */ |
| 134 |
|
#define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ |
| 135 |
|
#define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ |
| 136 |
|
|
| 137 |
/***************************************************************************** |
/***************************************************************************** |
| 138 |
* CPU flags |
* xvid_global() |
| 139 |
****************************************************************************/ |
****************************************************************************/ |
| 140 |
|
|
| 141 |
|
/* cpu_flags definitions */ |
| 142 |
|
|
| 143 |
/** |
#define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */ |
| 144 |
* \defgroup cpu_grp Flags for XVID_INIT_PARAM.cpu_flags. |
#define XVID_CPU_ASM 0x00000080 /* native assembly */ |
| 145 |
* |
/* ARCH_IS_IA32 */ |
| 146 |
* This section describes all constants that show host cpu available features, |
#define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */ |
| 147 |
* and allow a client application to force usage of some cpu instructions sets. |
#define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */ |
| 148 |
* @{ |
#define XVID_CPU_SSE 0x00000004 /* sse : pentium3, athlonXP */ |
| 149 |
*/ |
#define XVID_CPU_SSE2 0x00000008 /* sse2 : pentium4, athlon64 */ |
| 150 |
|
#define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */ |
| 151 |
|
#define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ |
| 152 |
|
#define XVID_CPU_TSC 0x00000040 /* timestamp counter */ |
| 153 |
|
/* ARCH_IS_PPC */ |
| 154 |
|
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
| 155 |
|
|
| 156 |
|
|
| 157 |
/** |
/* XVID_GBL_INIT param1 */ |
| 158 |
* \defgroup x86_grp x86 specific cpu flags |
typedef struct { |
| 159 |
* @{ |
int version; |
| 160 |
*/ |
int cpu_flags; /* [in:opt] zero = autodetect cpu |
| 161 |
|
XVID_CPU_FORCE|{cpu features} = force cpu features */ |
| 162 |
|
} xvid_gbl_init_t; |
| 163 |
|
|
|
#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 (athlon) instruction set */ |
|
|
#define XVID_CPU_TSC 0x00000040 /**< has TimeStampCounter instruction */ |
|
|
|
|
|
/** @} */ |
|
|
|
|
|
/** |
|
|
* \defgroup ia64_grp ia64 specific cpu flags. |
|
|
* @{ |
|
|
*/ |
|
| 164 |
|
|
| 165 |
#define XVID_CPU_IA64 0x00000080 /**< Forces ia64 optimized code usage |
/* XVID_GBL_INFO param1 */ |
| 166 |
* |
typedef struct { |
| 167 |
* This flags allow client applications to force IA64 optimized functions. |
int version; |
| 168 |
* This feature is considered exeperimental and should be treated as is. |
int actual_version; /* [out] returns the actual xvidcore version */ |
| 169 |
*/ |
const char * build; /* [out] if !null, points to description of this xvid core build */ |
| 170 |
|
int cpu_flags; /* [out] detected cpu features */ |
| 171 |
|
int num_threads; /* [out] detected number of cpus/threads */ |
| 172 |
|
} xvid_gbl_info_t; |
| 173 |
|
|
|
/** @} */ |
|
| 174 |
|
|
| 175 |
/** |
/* XVID_GBL_CONVERT param1 */ |
| 176 |
* \defgroup iniflags_grp Initialization commands. |
typedef struct { |
| 177 |
* |
int version; |
| 178 |
* @{ |
xvid_image_t input; /* [in] input image & colorspace */ |
| 179 |
*/ |
xvid_image_t output; /* [in] output image & colorspace */ |
| 180 |
|
int width; /* [in] width */ |
| 181 |
|
int height; /* [in] height */ |
| 182 |
|
int interlacing; /* [in] interlacing */ |
| 183 |
|
} xvid_gbl_convert_t; |
| 184 |
|
|
|
#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. |
|
|
*/ |
|
| 185 |
|
|
| 186 |
#define XVID_CPU_FORCE 0x80000000 /**< Force input flags to be used |
#define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */ |
| 187 |
* |
#define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ |
| 188 |
* When this flag is set, client application forces XviD to use other flags |
#define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ |
| 189 |
* set in cpu_flags. \b Use this at your own risk. |
#define XVID_GBL_TEST 3 /* testing.. */ |
|
*/ |
|
| 190 |
|
|
| 191 |
/** @} */ |
int xvid_global(void *handle, int opt, void *param1, void *param2); |
| 192 |
|
|
|
/** @} */ |
|
| 193 |
|
|
| 194 |
/***************************************************************************** |
/***************************************************************************** |
| 195 |
* Initialization structures |
* xvid_decore() |
| 196 |
****************************************************************************/ |
****************************************************************************/ |
| 197 |
|
|
| 198 |
/** Structure used in xvid_init function. */ |
#define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
| 199 |
typedef struct |
#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ |
| 200 |
{ |
#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ |
| 201 |
int cpu_flags; /**< [in/out] |
|
| 202 |
* |
int xvid_decore(void *handle, int opt, void *param1, void *param2); |
| 203 |
* Filled with desired[in] or available[out] |
|
| 204 |
* cpu instruction sets. |
/* XVID_DEC_CREATE param 1 |
| 205 |
*/ |
image width & height may be specified here when the dimensions are |
| 206 |
int api_version; /**< [out] |
known in advance. */ |
| 207 |
* |
typedef struct { |
| 208 |
* xvid_init will initialize this field with |
int version; |
| 209 |
* the API_VERSION used in this XviD core |
int width; /* [in:opt] image width */ |
| 210 |
* library |
int height; /* [in:opt] image width */ |
| 211 |
*/ |
void * handle; /* [out] decore context handle */ |
| 212 |
int core_build; /**< [out] |
} xvid_dec_create_t; |
| 213 |
* \todo Unused. |
|
| 214 |
*/ |
|
| 215 |
|
/* XVID_DEC_DECODE param1 */ |
| 216 |
|
/* general flags */ |
| 217 |
|
#define XVID_LOWDELAY 0x00000001 /* lowdelay mode */ |
| 218 |
|
#define XVID_DISCONTINUITY 0x00000002 /* indicates break in stream */ |
| 219 |
|
|
| 220 |
|
typedef struct { |
| 221 |
|
int version; |
| 222 |
|
int general; /* [in:opt] general flags */ |
| 223 |
|
void *bitstream; /* [in] bitstream (read from)*/ |
| 224 |
|
int length; /* [in] bitstream length */ |
| 225 |
|
xvid_image_t output; /* [in] output image (written to) */ |
| 226 |
} |
} |
| 227 |
XVID_INIT_PARAM; |
xvid_dec_frame_t; |
| 228 |
|
|
|
/***************************************************************************** |
|
|
* Initialization entry point |
|
|
****************************************************************************/ |
|
| 229 |
|
|
| 230 |
/** |
/* XVID_DEC_DECODE param2 :: optional */ |
| 231 |
* \defgroup inientry_grp Initialization entry point. |
typedef struct |
| 232 |
* @{ |
{ |
| 233 |
*/ |
int version; |
| 234 |
|
int type; /* [out] output data type */ |
| 235 |
|
union { |
| 236 |
|
struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ |
| 237 |
|
int general; /* [out] flags */ |
| 238 |
|
int time_base; /* [out] time base */ |
| 239 |
|
int time_increment; /* [out] time increment */ |
| 240 |
|
|
| 241 |
/** |
/* XXX: external deblocking stuff */ |
| 242 |
* \brief Initialization entry point. |
int * qscale; /* [out] pointer to quantizer table */ |
| 243 |
* |
int qscale_stride; /* [out] quantizer scale stride */ |
|
* 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); |
|
| 244 |
|
|
| 245 |
/** @} */ |
} vop; |
| 246 |
|
struct { /* XVID_TYPE_VOL */ |
| 247 |
|
int general; /* [out] flags */ |
| 248 |
|
int width; /* [out] width */ |
| 249 |
|
int height; /* [out] height */ |
| 250 |
|
int par; /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
| 251 |
|
int par_width; /* [out] aspect ratio width */ |
| 252 |
|
int par_height; /* [out] aspect ratio height */ |
| 253 |
|
} vol; |
| 254 |
|
} data; |
| 255 |
|
} xvid_dec_stats_t; |
| 256 |
|
|
|
/** @} */ |
|
| 257 |
|
|
| 258 |
/***************************************************************************** |
/***************************************************************************** |
| 259 |
* Decoder constant |
xvid plugin system -- internals |
|
****************************************************************************/ |
|
| 260 |
|
|
| 261 |
/** |
xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE |
| 262 |
* \defgroup decoder_grp Decoder related functions and structures. |
before encoding each frame xvidcore will call XVID_PLG_BEFORE |
| 263 |
* |
after encoding each frame xvidcore will call XVID_PLG_AFTER |
| 264 |
* This part describes all the structures/functions from XviD's API needed for |
xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY |
| 265 |
* decoding a MPEG4 compliant streams. |
****************************************************************************/ |
|
* @{ |
|
|
*/ |
|
| 266 |
|
|
| 267 |
/** |
#define XVID_PLG_CREATE 0 |
| 268 |
* \defgroup decframe_grp Flags for XVID_DEC_FRAME.general |
#define XVID_PLG_DESTROY 1 |
| 269 |
* |
#define XVID_PLG_INFO 2 |
| 270 |
* Flags' description for the XVID_DEC_FRAME.general member. |
#define XVID_PLG_BEFORE 3 |
| 271 |
* |
#define XVID_PLG_AFTER 4 |
|
* @{ |
|
|
*/ |
|
| 272 |
|
|
| 273 |
/** Not used at the moment */ |
/* xvid_plg_info_t.flags */ |
| 274 |
#define XVID_QUICK_DECODE 0x00000010 |
#define XVID_REQORIGINAL 1 /* plugin requires a copy of the original (uncompressed) image */ |
| 275 |
|
#define XVID_REQPSNR 2 /* plugin requires psnr between the uncompressed and compressed image*/ |
| 276 |
|
#define XVID_REQDQUANTS 3 /* plugin requires access to the dquant table */ |
| 277 |
|
|
| 278 |
|
|
| 279 |
/** |
typedef struct |
| 280 |
* @} |
{ |
| 281 |
*/ |
int version; |
| 282 |
|
int flags; /* plugin flags */ |
| 283 |
|
} xvid_plg_info_t; |
| 284 |
|
|
|
/***************************************************************************** |
|
|
* Decoder structures |
|
|
****************************************************************************/ |
|
| 285 |
|
|
| 286 |
typedef struct |
typedef struct |
| 287 |
{ |
{ |
| 288 |
|
int version; |
| 289 |
|
|
| 290 |
int width; |
int width; |
| 291 |
int height; |
int height; |
| 292 |
void *handle; |
int mb_width; |
| 293 |
} |
int mb_height; |
| 294 |
XVID_DEC_PARAM; |
int fincr; |
| 295 |
|
int fbase; |
| 296 |
|
|
| 297 |
|
void * param; |
| 298 |
|
} xvid_plg_create_t; |
| 299 |
|
|
| 300 |
|
|
| 301 |
typedef struct |
typedef struct |
| 302 |
{ |
{ |
| 303 |
int general; |
int version; |
| 304 |
void *bitstream; |
|
| 305 |
int length; |
int width; /* [out] */ |
| 306 |
|
int height; /* [out] */ |
| 307 |
void *image; |
int mb_width; /* [out] */ |
| 308 |
int stride; |
int mb_height; /* [out] */ |
| 309 |
int colorspace; |
int fincr; /* [out] */ |
| 310 |
} |
int fbase; /* [out] */ |
| 311 |
XVID_DEC_FRAME; |
|
| 312 |
|
xvid_image_t reference; /* [out] -> [out] */ |
| 313 |
|
xvid_image_t current; /* [out] -> [in,out] */ |
| 314 |
|
xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ |
| 315 |
|
int frame_num; /* [out] frame number */ |
| 316 |
|
|
| 317 |
|
int type; /* [in,out] */ |
| 318 |
|
int quant; /* [in,out] */ |
| 319 |
|
|
| 320 |
|
int * dquant; /* [in,out] pointer to diff quantizer table */ |
| 321 |
|
int dquant_stride; /* [in,out] diff quantizer stride */ |
| 322 |
|
|
| 323 |
|
int vop_flags; /* [in,out] */ |
| 324 |
|
int vol_flags; /* [in,out] */ |
| 325 |
|
int motion_flags; /* [in,out] */ |
| 326 |
|
|
| 327 |
|
int length; /* [out] after: length of encoded frame */ |
| 328 |
|
int kblks, mblks, ublks; /* [out] after: */ |
| 329 |
|
int sse_y, sse_u, sse_v; /* [out] */ |
| 330 |
|
} xvid_plg_data_t; |
| 331 |
|
|
| 332 |
|
|
| 333 |
|
/***************************************************************************** |
| 334 |
|
xvid plugin system -- external |
| 335 |
|
|
| 336 |
|
the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array |
| 337 |
|
indicates the plugin function pointer and plugin-specific data. |
| 338 |
|
xvidcore handles the rest. example: |
| 339 |
|
|
| 340 |
|
xvid_enc_create_t create; |
| 341 |
|
xvid_enc_plugin_t plugins[2]; |
| 342 |
|
|
| 343 |
|
plugins[0].func = xvid_psnr_func; |
| 344 |
|
plugins[0].param = NULL; |
| 345 |
|
plugins[1].func = xvid_cbr_func; |
| 346 |
|
plugins[1].param = &cbr_data; |
| 347 |
|
|
| 348 |
|
create.num_plugins = 2; |
| 349 |
|
create.plugins = plugins; |
| 350 |
|
|
| 351 |
|
****************************************************************************/ |
| 352 |
|
|
| 353 |
|
typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); |
| 354 |
|
|
|
// This struct is used for per slice rendering |
|
| 355 |
typedef struct |
typedef struct |
| 356 |
{ |
{ |
| 357 |
void *y,*u,*v; |
xvid_plugin_func * func; |
| 358 |
int stride_y, stride_u,stride_v; |
void * param; |
| 359 |
} XVID_DEC_PICTURE; |
} xvid_enc_plugin_t; |
| 360 |
|
|
| 361 |
|
xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
| 362 |
|
xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
| 363 |
|
xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
| 364 |
|
|
| 365 |
|
|
| 366 |
/***************************************************************************** |
/***************************************************************************** |
| 367 |
* Decoder entry point |
* xvid_encore() |
| 368 |
****************************************************************************/ |
****************************************************************************/ |
| 369 |
|
|
| 370 |
/** |
/* Encoder options */ |
| 371 |
* \defgroup decops_grp Decoder operations |
#define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
| 372 |
* |
#define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ |
| 373 |
* These are all the operations XviD's decoder can perform. |
#define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes |
| 374 |
* |
0 means this frame should not be written (ie. encoder lag) */ |
|
* @{ |
|
|
*/ |
|
| 375 |
|
|
| 376 |
#define XVID_DEC_DECODE 0 /**< Decodes a frame |
int xvid_encore(void *handle, int opt, void *param1, void *param2); |
|
* |
|
|
* This operation constant is used when client application wants to decode a |
|
|
* frame. Client application must also fill XVID_DEC_FRAME appropriately. |
|
|
*/ |
|
| 377 |
|
|
|
#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. Decoder instances are independant from each other, and |
|
|
* can be safely threaded. |
|
|
*/ |
|
| 378 |
|
|
| 379 |
#define XVID_DEC_DESTROY 2 /**< Destroys a decoder instance |
/* global flags */ |
| 380 |
* |
typedef enum |
| 381 |
* This operation constant is used by the client application to destroy a |
{ |
| 382 |
* previously created decoder instance. |
XVID_PACKED = 0x00000001, /* packed bitstream */ |
| 383 |
*/ |
XVID_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */ |
| 384 |
|
XVID_EXTRASTATS_ENABLE = 0x00000004 |
| 385 |
|
/*define XVID_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */ |
| 386 |
|
/*define XVID_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */ |
| 387 |
|
} xvid_global_t; |
| 388 |
|
|
|
/** |
|
|
* @} |
|
|
*/ |
|
| 389 |
|
|
| 390 |
/** |
/* XVID_ENC_ENCODE param1 */ |
| 391 |
* \defgroup decentry_grp Decoder entry point |
/* vol-based flags */ |
| 392 |
* |
typedef enum { |
| 393 |
* @{ |
XVID_MPEGQUANT = 0x00000001, |
| 394 |
*/ |
XVID_EXTRASTATS = 0x00000002, |
| 395 |
|
XVID_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */ |
| 396 |
|
XVID_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */ |
| 397 |
|
XVID_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
| 398 |
|
XVID_INTERLACING = 0x00000400, /* enable interlaced encoding */ |
| 399 |
|
} xvid_vol_t; |
| 400 |
|
|
|
/** |
|
|
* \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 Decoder instance handle. |
|
|
* \param opt Decoder option constant |
|
|
* \param param1 Used to pass a XVID_DEC_PARAM or XVID_DEC_FRAME structure |
|
|
* \param param2 Reserved for future use. |
|
|
*/ |
|
| 401 |
|
|
| 402 |
int xvid_decore(void *handle, |
/* vop-based flags */ |
| 403 |
int opt, |
typedef enum { |
| 404 |
void *param1, |
XVID_DEBUG = 0x00000001, |
|
void *param2); |
|
| 405 |
|
|
| 406 |
/** @} */ |
XVID_HALFPEL = 0x00000004, /* use halfpel interpolation */ |
| 407 |
|
XVID_INTER4V = 0x00000008, |
| 408 |
|
|
| 409 |
/** @} */ |
XVID_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */ |
| 410 |
|
XVID_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for |
| 411 |
|
color input material chroma is ignored) */ |
| 412 |
|
XVID_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ |
| 413 |
|
XVID_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ |
| 414 |
|
XVID_DYNAMIC_BFRAMES = 0x00000200, |
| 415 |
|
|
| 416 |
/** |
/* only valid for vol_flags|=XVID_INTERLACING */ |
| 417 |
* \defgroup encoder_grp Encoder related functions and structures. |
XVID_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ |
| 418 |
* |
XVID_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */ |
|
* @{ |
|
|
*/ |
|
| 419 |
|
|
| 420 |
/***************************************************************************** |
/* only valid for vol_flags|=XVID_REDUCED_ENABLED */ |
| 421 |
* Encoder constants |
XVID_REDUCED = 0x00001000, /* reduced resolution vop */ |
| 422 |
****************************************************************************/ |
} xvid_vop_t; |
| 423 |
|
|
|
/** |
|
|
* \defgroup encgenflags_grp Flags for XVID_ENC_FRAME.general |
|
|
* @{ |
|
|
*/ |
|
| 424 |
|
|
| 425 |
#define XVID_VALID_FLAGS 0x80000000 /**< Reserved for future use */ |
typedef enum { |
| 426 |
|
PMV_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */ |
| 427 |
|
PMV_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */ |
| 428 |
|
|
| 429 |
#define XVID_CUSTOM_QMATRIX 0x00000004 /**< Use custom quantization matrices |
PMV_HALFPELREFINE16 = 0x00020000, |
| 430 |
* |
PMV_HALFPELREFINE8 = 0x02000000, |
|
* 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/**< Lumimasking flag |
|
|
* |
|
|
* \deprecated This flag is no longer used. */ |
|
|
#define XVID_LATEINTRA 0x00000200/**< Unknown |
|
|
* |
|
|
* \deprecated This flag is no longer used. */ |
|
|
#define XVID_INTERLACING 0x00000400/**< MPEG4 interlacing mode. |
|
|
* |
|
|
* Enables interlacing encoding mode */ |
|
|
#define XVID_TOPFIELDFIRST 0x00000800/**< Unknown |
|
|
* |
|
|
* \deprecated This flag is no longer used. */ |
|
|
#define XVID_ALTERNATESCAN 0x00001000/**< |
|
|
* |
|
|
* \deprecated This flag is no longer used. */ |
|
|
#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 alias |
|
|
* |
|
|
* United States locale support. */ |
|
| 431 |
|
|
| 432 |
/** @} */ |
PMV_QUARTERPELREFINE16 = 0x00040000, |
| 433 |
|
PMV_QUARTERPELREFINE8 = 0x04000000, |
| 434 |
|
|
| 435 |
/** |
PMV_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */ |
|
* \defgroup encmotionflags_grp Flags for XVID_ENC_FRAME.motion |
|
|
* @{ |
|
|
*/ |
|
| 436 |
|
|
| 437 |
#define PMV_ADVANCEDDIAMOND8 0x00004000/**< Uses advanced diamonds for 8x8 blocks |
PMV_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */ |
| 438 |
* |
PMV_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */ |
| 439 |
* Same as its 16x16 companion option |
PMV_USESQUARES8 = 0x80000000, /* use square for PMV_EXTSEARCH8 */ |
|
*/ |
|
|
#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 */ |
|
| 440 |
|
|
| 441 |
/** @} */ |
PMV_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */ |
| 442 |
|
PMV_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */ |
| 443 |
|
|
| 444 |
/***************************************************************************** |
/* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */ |
| 445 |
* Encoder structures |
HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */ |
| 446 |
****************************************************************************/ |
HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */ |
| 447 |
|
QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */ |
| 448 |
|
QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */ |
| 449 |
|
|
| 450 |
/** Structure used for encoder instance creation */ |
EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern |
| 451 |
typedef struct |
enable PMV_EXTSEARCH8 to do this in 8x8 search as well */ |
| 452 |
{ |
CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */ |
|
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; |
|
| 453 |
|
|
| 454 |
typedef struct |
PMV_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */ |
| 455 |
{ |
PMV_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */ |
| 456 |
int x; |
PMV_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */ |
| 457 |
int y; |
PMV_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */ |
| 458 |
} |
} xvid_motion_t; |
|
VECTOR; |
|
| 459 |
|
|
|
typedef struct |
|
|
{ |
|
|
int mode; /* macroblock mode */ |
|
|
VECTOR mvs[4]; |
|
|
} |
|
|
MVBLOCKHINT; |
|
| 460 |
|
|
| 461 |
typedef struct |
/* XVID_ENC_CREATE param1 */ |
| 462 |
{ |
typedef struct { |
| 463 |
int intra; /* frame intra choice */ |
int version; |
| 464 |
int fcode; /* frame fcode */ |
int width; /* [in] frame dimensions; width, pixel units */ |
| 465 |
MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ |
int height; /* [in] frame dimensions; height, pixel units */ |
|
} |
|
|
MVFRAMEHINT; |
|
| 466 |
|
|
| 467 |
typedef struct |
int num_plugins; /* [in:opt] number of plugins */ |
| 468 |
{ |
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
|
int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ |
|
| 469 |
|
|
| 470 |
MVFRAMEHINT mvhint; |
int num_threads; /* [in:opt] number of threads */ |
| 471 |
void *hintstream; /* compressed hint buffer */ |
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
|
int hintlength; /* length of buffer (bytes) */ |
|
|
} |
|
|
HINTINFO; |
|
| 472 |
|
|
| 473 |
/** Structure used to pass a frame to the encoder */ |
xvid_global_t global; /* [in:opt] global flags; controls encoding behavior */ |
|
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 : |
|
|
* <ul> |
|
|
* <li> 0 (zero) : Then the rate controler chooses the right quantizer |
|
|
* for you. Typically used in ABR encoding, or first pass of a VBR |
|
|
* encoding session. |
|
|
* <li> != 0 : Then you force the encoder to use this specific |
|
|
* quantizer value. It is clamped in the interval |
|
|
* [1..31]. Tipically used during the 2nd pass of a VBR encoding |
|
|
* session. |
|
|
* </ul> */ |
|
|
int intra; /**< [in/out] |
|
|
* |
|
|
* <ul> |
|
|
* <li> [in] : tells XviD if the frame must be encoded as an intra frame |
|
|
* <ul> |
|
|
* <li> 1: forces the encoder to create a keyframe. Mainly used during |
|
|
* a VBR 2nd pass. |
|
|
* <li> 0: forces the encoder not to create a keyframe. Minaly used |
|
|
* during a VBR second pass |
|
|
* <li> -1: let the encoder decide (based on contents and |
|
|
* max_key_interval). Mainly used in ABR mode and during a 1st |
|
|
* VBR pass. |
|
|
* </ul> |
|
|
* <li> [out] : When first set to -1, the encoder returns the effective keyframe state |
|
|
* of the frame. |
|
|
* </ul> |
|
|
*/ |
|
|
HINTINFO hint; /**< [in/out] |
|
|
* |
|
|
* mv hint information */ |
|
| 474 |
|
|
| 475 |
} |
/* --- vol-based stuff; included here for conveinience */ |
| 476 |
XVID_ENC_FRAME; |
int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ |
| 477 |
|
int fbase; /* [in] framerate base |
| 478 |
|
frame_duration = fincr/fbase seconds*/ |
| 479 |
|
/* ^^^---------------------------------------------- */ |
| 480 |
|
|
| 481 |
|
|
| 482 |
/** Encoding statistics */ |
/* ---vop-based; included here for conveienience */ |
| 483 |
typedef struct |
int max_key_interval; /* [in:opt] the maximum interval between key frames */ |
| 484 |
{ |
/*XXX: maybe call it gop_size? */ |
| 485 |
int quant; /**< [out] |
|
| 486 |
* |
int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
| 487 |
* Frame quantizer used during encoding */ |
|
| 488 |
int hlength; /**< [out] |
int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
| 489 |
* |
int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ |
| 490 |
* Header bytes in the resulting MPEG4 stream */ |
|
| 491 |
int kblks; /**< [out] |
/* ^^^ -------------------------------------------------------------------------*/ |
| 492 |
* |
|
| 493 |
* Number of intra macro blocks */ |
void *handle; /* [out] encoder instance handle */ |
|
int mblks; /**< [out] |
|
|
* |
|
|
* Number of inter macro blocks */ |
|
|
int ublks; /**< [out] |
|
|
* |
|
|
* Number of skipped macro blocks */ |
|
| 494 |
} |
} |
| 495 |
XVID_ENC_STATS; |
xvid_enc_create_t; |
| 496 |
|
|
| 497 |
|
|
| 498 |
/***************************************************************************** |
typedef struct { |
| 499 |
* Encoder entry point |
int version; |
| 500 |
****************************************************************************/ |
int type; /* [in] rate control type: XVID_RC_xxx */ |
| 501 |
|
|
| 502 |
/** |
/* common stuff */ |
| 503 |
* \defgroup encops_grp Encoder operations |
int min_iquant; /* [in:opt] ivop quantizer upper/lower limit */ |
| 504 |
* |
int max_iquant; /* [in:opt] */ |
| 505 |
* These are all the operations XviD's encoder can perform. |
int min_pquant; /* [in:opt] psvop quantizer upper/lower limit */ |
| 506 |
* |
int max_pquant; /* [in:opt] */ |
| 507 |
* @{ |
int min_bquant; /* [in:opt] bvop quantizer upper/lower limit */ |
| 508 |
*/ |
int max_bquant; /* [in:opt] */ |
| 509 |
|
|
| 510 |
#define XVID_ENC_ENCODE 0 /**< Encodes a frame |
union { |
| 511 |
* |
struct { /* XVID_RC_FQUANT */ |
| 512 |
* This operation constant is used when client application wants to encode a |
float quant; /* [in] quantizer */ |
| 513 |
* frame. Client application must also fill XVID_ENC_FRAME appropriately. |
} fquant; |
| 514 |
*/ |
struct { /* XVID_RC_CBR */ |
| 515 |
|
int bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */ |
| 516 |
|
int reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */ |
| 517 |
|
int averaging_period; /* [in] */ |
| 518 |
|
int buffer; /* [in] */ |
| 519 |
|
} cbr; |
| 520 |
|
} data; |
| 521 |
|
} xvid_enc_rc_t; |
| 522 |
|
|
|
#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. Encoder instances are independant from each other. |
|
|
*/ |
|
| 523 |
|
|
|
#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. |
|
|
*/ |
|
| 524 |
|
|
| 525 |
|
#define XVID_KEYFRAME 0x00000001 |
| 526 |
|
|
| 527 |
/** @} */ |
typedef struct { |
| 528 |
|
int version; |
| 529 |
|
|
| 530 |
/** |
/* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any |
| 531 |
* \defgroup encentry_grp Encoder entry point |
changes here until the next VOL (keyframe). */ |
| 532 |
* |
xvid_vol_t vol_flags; /* [in] vol flags */ |
| 533 |
* @{ |
unsigned char * |
| 534 |
*/ |
quant_intra_matrix; /* [in:opt] custom intra qmatrix */ |
| 535 |
|
unsigned char * |
| 536 |
|
quant_inter_matrix; /* [in:opt] custom inter qmatrix */ |
| 537 |
|
|
| 538 |
/** |
int par; /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
| 539 |
* \brief Encoder entry point. |
int par_width; /* [in:opt] aspect ratio width */ |
| 540 |
* |
int par_height; /* [in:opt] aspect ratio height */ |
| 541 |
* This is the XviD's encoder entry point. The possible operations are |
/* ^^^----------------------------------------------------------------------------------*/ |
| 542 |
* described in the \ref encops_grp section. |
|
| 543 |
* |
int fincr; /* framerate increment, for variable framerate only */ |
| 544 |
* \param handle Encoder instance handle |
xvid_vop_t vop_flags; /* [in] (general)vop-based flags */ |
| 545 |
* \param opt Encoder option constant |
xvid_motion_t motion; /* [in] ME options */ |
| 546 |
* \param param1 Used to pass XVID_ENC_PARAM or XVID_ENC_FRAME structures. |
|
| 547 |
* \param param2 Optionally used to pass the XVID_ENC_STATS structure. |
xvid_image_t input; /* [in] input image (read from) */ |
| 548 |
|
|
| 549 |
|
int type; /* [in:opt] coding type */ |
| 550 |
|
int quant; /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */ |
| 551 |
|
|
| 552 |
|
void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
| 553 |
|
int length; /* [in:opt] bitstream length (bytes) */ |
| 554 |
|
|
| 555 |
|
int out_flags; /* [out] bitstream output flags */ |
| 556 |
|
} |
| 557 |
|
xvid_enc_frame_t; |
| 558 |
|
|
| 559 |
|
|
| 560 |
|
/* XVID_ENC_ENCODE param2 (optional) |
| 561 |
|
xvid_enc_stats_t describes individual frame details |
| 562 |
|
|
| 563 |
|
coding_type==XVID_TYPE_NOTHING if the stats are not given |
| 564 |
*/ |
*/ |
| 565 |
int xvid_encore(void *handle, |
typedef struct { |
| 566 |
int opt, |
int version; |
|
void *param1, |
|
|
void *param2); |
|
| 567 |
|
|
| 568 |
/** @} */ |
/* encoding parameters */ |
| 569 |
|
int type; /* [out] coding type */ |
| 570 |
|
int quant; /* [out] frame quantizer */ |
| 571 |
|
xvid_vol_t vol_flags; /* [out] vol flags (see above) */ |
| 572 |
|
int vop_flags; /* [out] vop flags (see above) */ |
| 573 |
|
/* bitrate */ |
| 574 |
|
int length; /* [out] frame length */ |
| 575 |
|
|
| 576 |
/** @} */ |
int hlength; /* [out] header length (bytes) */ |
| 577 |
|
int kblks, mblks, ublks; /* [out] */ |
| 578 |
|
|
| 579 |
|
int sse_y, sse_u, sse_v; |
| 580 |
|
} |
| 581 |
|
xvid_enc_stats_t; |
| 582 |
|
|
| 583 |
#ifdef __cplusplus |
#ifdef __cplusplus |
| 584 |
} |
} |
| 585 |
#endif |
#endif |
| 586 |
|
|
| 587 |
|
|
| 588 |
#endif |
#endif |
Parent Directory
| 
Revision Log
| 
Patch