| 26 |
#ifndef _XVID_H_ |
#ifndef _XVID_H_ |
| 27 |
#define _XVID_H_ |
#define _XVID_H_ |
| 28 |
|
|
|
|
|
| 29 |
#ifdef __cplusplus |
#ifdef __cplusplus |
| 30 |
extern "C" { |
extern "C" { |
| 31 |
#endif |
#endif |
| 32 |
|
|
| 33 |
/***************************************************************************** |
/***************************************************************************** |
| 34 |
* versioning |
* Global constants |
| 35 |
****************************************************************************/ |
****************************************************************************/ |
| 36 |
|
|
| 37 |
/* versioning |
/* API Version : 2.1 */ |
| 38 |
version takes the form "$major.$minor.$patch" |
#define API_VERSION ((2 << 16) | (1)) |
| 39 |
$patch is incremented when there is no api change |
#define XVID_API_UNSTABLE |
|
$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_MAJOR(a) ( ((a)>>16) & 0xff ) |
|
|
#define XVID_MINOR(b) ((char)( ((b)>>8) & 0xff )) |
|
|
#define XVID_PATCH(c) ( (c) & 0xff ) |
|
|
|
|
|
#define XVID_VERSION XVID_MAKE_VERSION(1,-127,0) |
|
|
#define XVID_UNSTABLE |
|
| 40 |
|
|
| 41 |
/* Bitstream Version |
/* Bitstream Version |
| 42 |
* this will be writen into the bitstream to allow easy detection of xvid |
* this will be writen into the bitstream to allow easy detection of xvid |
| 52 |
#define XVID_BS_VERSION "0009" |
#define XVID_BS_VERSION "0009" |
| 53 |
|
|
| 54 |
|
|
| 55 |
/***************************************************************************** |
/* Error codes */ |
| 56 |
* error codes |
#define XVID_ERR_FAIL -1 |
| 57 |
****************************************************************************/ |
#define XVID_ERR_OK 0 |
| 58 |
|
#define XVID_ERR_MEMORY 1 |
| 59 |
|
#define XVID_ERR_FORMAT 2 |
| 60 |
|
|
| 61 |
|
|
| 62 |
|
/* Colorspaces */ |
| 63 |
|
#define XVID_CSP_RGB24 0 /* [b|g|r] */ |
| 64 |
|
#define XVID_CSP_YV12 1 |
| 65 |
|
#define XVID_CSP_YUY2 2 |
| 66 |
|
#define XVID_CSP_UYVY 3 |
| 67 |
|
#define XVID_CSP_I420 4 |
| 68 |
|
#define XVID_CSP_RGB555 10 |
| 69 |
|
#define XVID_CSP_RGB565 11 |
| 70 |
|
#define XVID_CSP_USER 12 |
| 71 |
|
#define XVID_CSP_EXTERN 1004 /* per slice rendering */ |
| 72 |
|
#define XVID_CSP_YVYU 1002 |
| 73 |
|
#define XVID_CSP_RGB32 1000 /* [b|g|r|a] */ |
| 74 |
|
#define XVID_CSP_ABGR 1006 /* [a|b|g|r] */ |
| 75 |
|
#define XVID_CSP_RGBA 1005 /* [r|g|b|a] */ |
| 76 |
|
|
|
/* all functions return values <0 indicate error */ |
|
| 77 |
|
|
|
#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 */ |
|
| 78 |
|
|
| 79 |
|
#define XVID_CSP_NULL 9999 |
| 80 |
|
|
| 81 |
|
#define XVID_CSP_VFLIP 0x80000000 /* flip mask */ |
| 82 |
|
|
|
/***************************************************************************** |
|
|
* xvid_image_t |
|
|
****************************************************************************/ |
|
|
|
|
|
/* colorspace values */ |
|
|
|
|
|
#define XVID_CSP_USER 0 /* 4:2:0 planar */ |
|
|
#define XVID_CSP_I420 1 /* 4:2:0 packed(planar win32) */ |
|
|
#define XVID_CSP_YV12 2 /* 4:2:0 packed(planar win32) */ |
|
|
#define XVID_CSP_YUY2 3 /* 4:2:2 packed */ |
|
|
#define XVID_CSP_UYVY 4 /* 4:2:2 packed */ |
|
|
#define XVID_CSP_YVYU 5 /* 4:2:2 packed */ |
|
|
#define XVID_CSP_BGRA 6 /* 32-bit bgra packed */ |
|
|
#define XVID_CSP_ABGR 7 /* 32-bit abgr packed */ |
|
|
#define XVID_CSP_RGBA 8 /* 32-bit rgba packed */ |
|
|
#define XVID_CSP_BGR 9 /* 32-bit bgr packed */ |
|
|
#define XVID_CSP_RGB555 10 /* 16-bit rgb555 packed */ |
|
|
#define XVID_CSP_RGB565 11 /* 16-bit rgb565 packed */ |
|
|
#define XVID_CSP_SLICE 12 /* decoder only: 4:2:0 planar, per slice rendering */ |
|
|
#define XVID_CSP_INTERNAL 13 /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */ |
|
|
#define XVID_CSP_NULL 14 /* decoder only: dont output anything */ |
|
|
#define XVID_CSP_VFLIP 0x80000000 /* 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; |
|
|
|
|
|
|
|
|
/* aspect ratios */ |
|
|
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square) */ |
|
|
#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 */ |
|
|
|
|
|
/* 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 */ |
|
| 83 |
|
|
| 84 |
/***************************************************************************** |
/***************************************************************************** |
| 85 |
* xvid_global() |
* Initialization constants |
| 86 |
****************************************************************************/ |
****************************************************************************/ |
| 87 |
|
|
| 88 |
/* cpu_flags definitions */ |
/* CPU flags for XVID_INIT_PARAM.cpu_flags */ |
|
|
|
| 89 |
#define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */ |
#define XVID_CPU_FORCE 0x80000000 /* force passed cpu flags */ |
| 90 |
|
#define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */ |
| 91 |
#define XVID_CPU_ASM 0x00000080 /* native assembly */ |
#define XVID_CPU_ASM 0x00000080 /* native assembly */ |
| 92 |
|
|
| 93 |
/* ARCH_IS_IA32 */ |
/* ARCH_IS_IA32 */ |
| 94 |
#define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */ |
#define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */ |
| 95 |
#define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */ |
#define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */ |
| 98 |
#define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */ |
#define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */ |
| 99 |
#define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ |
#define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ |
| 100 |
#define XVID_CPU_TSC 0x00000040 /* timestamp counter */ |
#define XVID_CPU_TSC 0x00000040 /* timestamp counter */ |
|
/* ARCH_IS_PPC */ |
|
|
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
|
| 101 |
|
|
| 102 |
|
/* ARCH_IS_IA64 */ |
| 103 |
|
#define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */ |
| 104 |
|
|
| 105 |
/* XVID_GBL_INIT param1 */ |
/* ARCH_IS_PPC */ |
| 106 |
typedef struct { |
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
|
int version; |
|
|
int cpu_flags; /* [in:opt] zero = autodetect cpu |
|
|
XVID_CPU_FORCE|{cpu features} = force cpu features */ |
|
|
} xvid_gbl_init_t; |
|
|
|
|
|
|
|
|
/* 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 */ |
|
|
int cpu_flags; /* [out] detected cpu features */ |
|
|
int num_threads; /* [out] detected number of cpus/threads */ |
|
|
} xvid_gbl_info_t; |
|
|
|
|
|
|
|
|
/* 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; |
|
|
|
|
|
|
|
|
#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 */ |
|
|
#define XVID_GBL_TEST 3 /* testing.. */ |
|
| 107 |
|
|
|
int xvid_global(void *handle, int opt, void *param1, void *param2); |
|
| 108 |
|
|
| 109 |
|
typedef struct |
| 110 |
|
{ |
| 111 |
|
int colorspace; |
| 112 |
|
void * y; |
| 113 |
|
void * u; |
| 114 |
|
void * v; |
| 115 |
|
int y_stride; |
| 116 |
|
int uv_stride; |
| 117 |
|
} XVID_IMAGE; /* from yv12 */ |
| 118 |
|
|
| 119 |
|
#define XVID_INIT_INIT 0 |
| 120 |
|
#define XVID_INIT_CONVERT 1 |
| 121 |
|
#define XVID_INIT_TEST 2 |
| 122 |
|
|
| 123 |
/***************************************************************************** |
/***************************************************************************** |
| 124 |
* xvid_decore() |
* Initialization structures |
| 125 |
****************************************************************************/ |
****************************************************************************/ |
| 126 |
|
|
| 127 |
#define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
typedef struct |
| 128 |
#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ |
{ |
| 129 |
#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ |
int cpu_flags; |
| 130 |
|
int api_version; |
| 131 |
int xvid_decore(void *handle, int opt, void *param1, void *param2); |
int core_build; |
| 132 |
|
} XVID_INIT_PARAM; |
|
/* 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; |
|
|
|
|
|
|
|
|
/* XVID_DEC_DECODE param1 */ |
|
|
/* general flags */ |
|
|
#define XVID_LOWDELAY 0x00000001 /* lowdelay mode */ |
|
|
#define XVID_DISCONTINUITY 0x00000002 /* indicates break in stream */ |
|
|
|
|
|
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; |
|
|
|
|
| 133 |
|
|
|
/* XVID_DEC_DECODE param2 :: optional */ |
|
| 134 |
typedef struct |
typedef struct |
| 135 |
{ |
{ |
| 136 |
int version; |
XVID_IMAGE input; |
| 137 |
int type; /* [out] output data type */ |
XVID_IMAGE output; |
| 138 |
union { |
int width; |
| 139 |
struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ |
int height; |
| 140 |
int general; /* [out] flags */ |
int interlacing; |
| 141 |
int time_base; /* [out] time base */ |
} XVID_INIT_CONVERTINFO; |
|
int time_increment; /* [out] time increment */ |
|
| 142 |
|
|
| 143 |
/* XXX: external deblocking stuff */ |
/***************************************************************************** |
| 144 |
unsigned char * qscale; /* [out] pointer to quantizer table */ |
* Initialization entry point |
| 145 |
int qscale_stride; /* [out] quantizer scale stride */ |
****************************************************************************/ |
| 146 |
|
|
| 147 |
} vop; |
int xvid_init(void *handle, |
| 148 |
struct { /* XVID_TYPE_VOL */ |
int opt, |
| 149 |
int general; /* [out] flags */ |
void *param1, |
| 150 |
int width; /* [out] width */ |
void *param2); |
|
int height; /* [out] height */ |
|
|
int par; /* [out] picture 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; |
|
| 151 |
|
|
| 152 |
|
|
| 153 |
/***************************************************************************** |
/***************************************************************************** |
| 154 |
xvid plugin system -- internals |
* Decoder constants |
|
|
|
|
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 |
|
| 155 |
****************************************************************************/ |
****************************************************************************/ |
| 156 |
|
|
| 157 |
#define XVID_PLG_CREATE 0 |
/* Flags for XVID_DEC_FRAME.general */ |
| 158 |
#define XVID_PLG_DESTROY 1 |
#define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. VFW) */ |
| 159 |
#define XVID_PLG_INFO 2 |
#define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */ |
| 160 |
#define XVID_PLG_BEFORE 3 |
#define XVID_DEC_DEBLOCKUV 0x00000008 /* chroma deblocking */ |
| 161 |
#define XVID_PLG_AFTER 4 |
#define XVID_DEC_DERING 0x00000012 /* deringing */ |
| 162 |
|
#define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream |
| 163 |
/* xvid_plg_info_t.flags */ |
instructs decoder to ignore any |
| 164 |
#define XVID_REQORIGINAL 1 /* plugin requires a copy of the original (uncompressed) image */ |
previous reference frames */ |
| 165 |
|
#define XVID_QUICK_DECODE 0x00000010 |
| 166 |
|
|
| 167 |
|
/***************************************************************************** |
| 168 |
|
* Decoder structures |
| 169 |
|
****************************************************************************/ |
| 170 |
|
|
| 171 |
typedef struct |
typedef struct |
| 172 |
{ |
{ |
| 173 |
int version; |
int width; |
| 174 |
int flags; /* plugin flags */ |
int height; |
| 175 |
} xvid_plg_info_t; |
void *handle; |
| 176 |
|
} XVID_DEC_PARAM; |
| 177 |
|
|
| 178 |
|
|
| 179 |
|
#define XVID_DEC_VOP 0 |
| 180 |
|
#define XVID_DEC_VOL 1 |
| 181 |
|
#define XVID_DEC_NOTHING 2 /* nothing was decoded */ |
| 182 |
|
|
| 183 |
typedef struct |
typedef struct |
| 184 |
{ |
{ |
| 185 |
int version; |
int notify; /* [out] output 'mode' */ |
| 186 |
|
union |
| 187 |
int width, height; |
{ |
| 188 |
int fincr, fbase; |
struct /* XVID_DEC_VOP */ |
| 189 |
|
{ |
| 190 |
void * param; |
int time_base; /* [out] time base */ |
| 191 |
} xvid_plg_create_t; |
int time_increment; /* [out] time increment */ |
| 192 |
|
} vop; |
| 193 |
|
struct /* XVID_DEC_VOL */ |
| 194 |
|
{ |
| 195 |
|
int general; /* [out] flags: eg. frames are interlaced */ |
| 196 |
|
int width; /* [out] width */ |
| 197 |
|
int height; /* [out] height */ |
| 198 |
|
int aspect_ratio; /* [out] aspect ratio */ |
| 199 |
|
int par_width; /* [out] aspect ratio width */ |
| 200 |
|
int par_height; /* [out] aspect ratio height */ |
| 201 |
|
} vol; |
| 202 |
|
} data; |
| 203 |
|
} XVID_DEC_STATS; |
| 204 |
|
|
| 205 |
|
|
| 206 |
typedef struct |
typedef struct |
| 207 |
{ |
{ |
| 208 |
int version; |
int general; |
| 209 |
|
void *bitstream; |
| 210 |
int width; /* [out] */ |
int length; |
|
int height; /* [out] */ |
|
|
int fincr; /* [out] */ |
|
|
int fbase; /* [out] */ |
|
|
|
|
|
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 */ |
|
|
|
|
|
int type; /* [in,out] */ |
|
|
int quant; /* [in,out] */ |
|
| 211 |
|
|
| 212 |
unsigned char * qscale; /* [in,out] pointer to quantizer table */ |
void *image; |
| 213 |
int qscale_stride; /* [in,out] quantizer scale stride */ |
int stride; |
| 214 |
|
int colorspace; |
| 215 |
|
} XVID_DEC_FRAME; |
| 216 |
|
|
|
int vop_flags; /* [in,out] */ |
|
|
int vol_flags; /* [in,out] */ |
|
|
int motion_flags; /* [in,out] */ |
|
| 217 |
|
|
| 218 |
int length; /* [out] after: length of encoded frame */ |
/* This struct is used for per slice rendering */ |
| 219 |
int kblks, mblks, ublks; /* [out] after: */ |
typedef struct |
| 220 |
} xvid_plg_data_t; |
{ |
| 221 |
|
void *y,*u,*v; |
| 222 |
|
int stride_y, stride_u,stride_v; |
| 223 |
|
} XVID_DEC_PICTURE; |
| 224 |
|
|
| 225 |
|
|
| 226 |
/***************************************************************************** |
/***************************************************************************** |
| 227 |
xvid plugin system -- external |
* Decoder entry point |
|
|
|
|
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; |
|
|
|
|
| 228 |
****************************************************************************/ |
****************************************************************************/ |
| 229 |
|
|
| 230 |
typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); |
/* decoder options */ |
| 231 |
|
#define XVID_DEC_DECODE 0 |
| 232 |
typedef struct |
#define XVID_DEC_CREATE 1 |
| 233 |
{ |
#define XVID_DEC_DESTROY 2 |
| 234 |
xvid_plugin_func * func; |
|
| 235 |
void * param; |
int xvid_decore(void *handle, |
| 236 |
} xvid_enc_plugin_t; |
int opt, |
| 237 |
|
void *param1, |
| 238 |
xvid_plugin_func xvid_plugin_psnr; /* stdout psnr calculator */ |
void *param2); |
|
xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
|
|
|
|
| 239 |
|
|
| 240 |
|
|
| 241 |
/***************************************************************************** |
/***************************************************************************** |
| 242 |
* xvid_encore() |
* Encoder constants |
| 243 |
****************************************************************************/ |
****************************************************************************/ |
| 244 |
|
|
| 245 |
/* Encoder options */ |
/* Flags for XVID_ENC_PARAM.global */ |
| 246 |
#define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
#define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */ |
| 247 |
#define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ |
#define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */ |
| 248 |
#define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes |
#define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */ |
| 249 |
0 means this frame should not be written (ie. encoder lag) */ |
#define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */ |
| 250 |
|
|
| 251 |
int xvid_encore(void *handle, int opt, void *param1, void *param2); |
#define XVID_GLOBAL_EXTRASTATS 0x00000200 /* generate extra statistics */ |
| 252 |
|
|
| 253 |
|
|
| 254 |
/* global flags */ |
/* Flags for XVID_ENC_FRAME.general */ |
| 255 |
typedef enum |
#define XVID_VALID_FLAGS 0x80000000 |
|
{ |
|
|
XVID_PACKED = 0x00000001, /* packed bitstream */ |
|
|
XVID_CLOSED_GOP = 0x00000002, /* closed_gop: was DX50BVOP dx50 bvop compatibility */ |
|
|
/*define XVID_VOL_AT_IVOP 0x00000008 write vol at every ivop: WIN32/divx compatibility */ |
|
|
/*define XVID_FORCE_VOL 0x00000008 XXX: when vol-based parameters are changed, insert an ivop NOT recommended */ |
|
|
} xvid_global_t; |
|
| 256 |
|
|
| 257 |
|
#define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */ |
| 258 |
|
#define XVID_CARTOON_MODE 0x00000008 /* use cartoon mode */ |
| 259 |
|
#define XVID_H263QUANT 0x00000010 |
| 260 |
|
#define XVID_MPEGQUANT 0x00000020 |
| 261 |
|
#define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */ |
| 262 |
|
#define XVID_QUARTERPEL 0x02000000 |
| 263 |
|
#define XVID_ADAPTIVEQUANT 0x00000080 |
| 264 |
|
#define XVID_LUMIMASKING 0x00000100 |
| 265 |
|
|
| 266 |
/* XVID_ENC_ENCODE param1 */ |
#define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */ |
| 267 |
/* vol-based flags */ |
#define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */ |
| 268 |
typedef enum { |
#define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */ |
|
XVID_MPEGQUANT = 0x00000001, |
|
|
XVID_QUARTERPEL = 0x00000004, /* enable quarterpel: frames will encoded as quarterpel */ |
|
|
XVID_GMC = 0x00000008, /* enable GMC; frames will be checked for gmc suitability */ |
|
|
XVID_REDUCED_ENABLE = 0x00000010, /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
|
|
XVID_INTERLACING = 0x00000400, /* enable interlaced encoding */ |
|
|
} xvid_vol_t; |
|
| 269 |
|
|
| 270 |
|
#define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */ |
| 271 |
|
#define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */ |
| 272 |
|
|
| 273 |
/* vop-based flags */ |
#define XVID_INTER4V 0x00008000 |
|
typedef enum { |
|
|
XVID_DEBUG = 0x00000001, |
|
| 274 |
|
|
| 275 |
XVID_HALFPEL = 0x00000004, /* use halfpel interpolation */ |
#define XVID_ME_ZERO 0x00010000 |
| 276 |
XVID_INTER4V = 0x00000008, |
#define XVID_ME_LOGARITHMIC 0x00020000 |
| 277 |
XVID_LUMIMASKING = 0x00000010, |
#define XVID_ME_FULLSEARCH 0x00040000 |
| 278 |
|
#define XVID_ME_PMVFAST 0x00080000 |
| 279 |
|
#define XVID_ME_EPZS 0x00100000 |
| 280 |
|
|
| 281 |
XVID_CHROMAOPT = 0x00000020, /* enable chroma optimization pre-filter */ |
#define XVID_CHROMAOPT 0x00200000 /* enable chroma optimization pre-filter */ |
|
XVID_GREYSCALE = 0x00000040, /* enable greyscale only mode (even for |
|
|
color input material chroma is ignored) */ |
|
|
XVID_HQACPRED = 0x00000080, /* 20030209: high quality ac prediction */ |
|
|
XVID_MODEDECISION_BITS = 0x00000100, /* enable DCT-ME and use it for mode decision */ |
|
|
XVID_DYNAMIC_BFRAMES = 0x00000200, |
|
| 282 |
|
|
| 283 |
/* only valid for vol_flags|=XVID_INTERLACING */ |
#define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for |
| 284 |
XVID_TOPFIELDFIRST = 0x00000400, /* set top-field-first flag */ |
color input material chroma is ignored) */ |
|
XVID_ALTERNATESCAN = 0x00000800, /* set alternate vertical scan flag */ |
|
| 285 |
|
|
| 286 |
/* only valid for vol_flags|=XVID_REDUCED_ENABLED */ |
#define XVID_GMC 0x10000000 |
| 287 |
XVID_REDUCED = 0x00001000, /* reduced resolution vop */ |
#define XVID_GMC_TRANSLATIONAL 0x20000000 |
|
} xvid_vop_t; |
|
| 288 |
|
|
| 289 |
|
#define XVID_REDUCED 0x04000000 /* reduced resolution vop */ |
| 290 |
|
#define XVID_HQACPRED 0x08000000 /* 20030209: high quality ac prediction */ |
| 291 |
|
|
| 292 |
typedef enum { |
#define XVID_EXTRASTATS 0x00000200 /* generate extra statistics */ |
|
PMV_ADVANCEDDIAMOND16 = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */ |
|
|
PMV_USESQUARES16 = 0x00800000, /* use squares instead of diamonds as search pattern */ |
|
| 293 |
|
|
| 294 |
PMV_HALFPELREFINE16 = 0x00020000, |
#define XVID_MODEDECISION_BITS 0x00400000 /* enable DCT-ME and use it for mode decision */ |
|
PMV_HALFPELREFINE8 = 0x02000000, |
|
| 295 |
|
|
|
PMV_QUARTERPELREFINE16 = 0x00040000, |
|
|
PMV_QUARTERPELREFINE8 = 0x04000000, |
|
| 296 |
|
|
| 297 |
PMV_EXTSEARCH16 = 0x00080000, /* extend PMV by more searches */ |
/* Flags for XVID_ENC_FRAME.motion */ |
| 298 |
|
#define PMV_ADVANCEDDIAMOND16 0x00008000 /* use advdiamonds instead of diamonds as search pattern */ |
| 299 |
|
#define PMV_USESQUARES16 0x00800000 /* use squares instead of diamonds as search pattern */ |
| 300 |
|
|
| 301 |
PMV_EXTSEARCH8 = 0x08000000, /* use diamond/square for extended 8x8 search */ |
#define PMV_HALFPELREFINE16 0x00020000 |
| 302 |
PMV_ADVANCEDDIAMOND8 = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */ |
#define PMV_HALFPELREFINE8 0x02000000 |
|
PMV_USESQUARES8 = 0x80000000, /* use square for PMV_EXTSEARCH8 */ |
|
| 303 |
|
|
| 304 |
PMV_CHROMA16 = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */ |
#define PMV_QUARTERPELREFINE16 0x00040000 |
| 305 |
PMV_CHROMA8 = 0x10000000, /* also use chroma for B_VOP ME */ |
#define PMV_QUARTERPELREFINE8 0x04000000 |
| 306 |
|
|
| 307 |
/* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */ |
#define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */ |
|
HALFPELREFINE16_BITS = 0x00000100, /* perform DCT-based halfpel refinement */ |
|
|
HALFPELREFINE8_BITS = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */ |
|
|
QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */ |
|
|
QUARTERPELREFINE8_BITS = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */ |
|
| 308 |
|
|
| 309 |
EXTSEARCH_BITS = 0x00001000, /* perform DCT-based search using square pattern |
#define PMV_EXTSEARCH8 0x08000000 /* use diamond/square for extended 8x8 search */ |
| 310 |
enable PMV_EXTSEARCH8 to do this in 8x8 search as well */ |
#define PMV_ADVANCEDDIAMOND8 0x00004000 /* use advdiamond for PMV_EXTSEARCH8 */ |
| 311 |
CHECKPREDICTION_BITS = 0x00002000, /* always check vector equal to prediction */ |
#define PMV_USESQUARES8 0x80000000 /* use square for PMV_EXTSEARCH8 */ |
| 312 |
|
|
| 313 |
PMV_UNRESTRICTED16 = 0x00200000, /* unrestricted ME, not implemented */ |
#define PMV_CHROMA16 0x00100000 /* also use chroma for P_VOP/S_VOP ME */ |
| 314 |
PMV_OVERLAPPING16 = 0x00400000, /* overlapping ME, not implemented */ |
#define PMV_CHROMA8 0x10000000 /* also use chroma for B_VOP ME */ |
|
PMV_UNRESTRICTED8 = 0x20000000, /* unrestricted ME, not implemented */ |
|
|
PMV_OVERLAPPING8 = 0x40000000 /* overlapping ME, not implemented */ |
|
|
} xvid_motion_t; |
|
| 315 |
|
|
| 316 |
|
/* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */ |
| 317 |
|
#define HALFPELREFINE16_BITS 0x00000100 /* perform DCT-based halfpel refinement */ |
| 318 |
|
#define HALFPELREFINE8_BITS 0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */ |
| 319 |
|
#define QUARTERPELREFINE16_BITS 0x00000400 /* perform DCT-based qpel refinement */ |
| 320 |
|
#define QUARTERPELREFINE8_BITS 0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */ |
| 321 |
|
|
| 322 |
/* XVID_ENC_CREATE param1 */ |
#define EXTSEARCH_BITS 0x00001000 /* perform DCT-based search using square pattern |
| 323 |
typedef struct { |
enable PMV_EXTSEARCH8 to do this in 8x8 search as well */ |
| 324 |
int version; |
#define CHECKPREDICTION_BITS 0x00002000 /* always check vector equal to prediction */ |
|
int width; /* [in] frame dimensions; width, pixel units */ |
|
|
int height; /* [in] frame dimensions; height, pixel units */ |
|
| 325 |
|
|
|
int num_plugins; /* [in:opt] number of plugins */ |
|
|
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
|
| 326 |
|
|
| 327 |
int num_threads; /* [in:opt] number of threads */ |
/* note: old and deprecated - or never implemented */ |
|
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
|
| 328 |
|
|
| 329 |
xvid_global_t global; /* [in:opt] global flags; controls encoding behavior */ |
/* only for compatability with old encoders */ |
| 330 |
|
|
| 331 |
/* --- vol-based stuff; included here for conveinience */ |
#define PMV_EARLYSTOP16 0x00 |
| 332 |
int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ |
#define PMV_EARLYSTOP8 0x00 |
| 333 |
int fbase; /* [in] framerate base |
#define PMV_QUICKSTOP16 0x00 |
| 334 |
frame_duration = fincr/fbase seconds*/ |
#define PMV_QUICKSTOP8 0x00 |
|
/* ^^^---------------------------------------------- */ |
|
| 335 |
|
|
| 336 |
|
#define PMV_HALFPELDIAMOND16 0x00 |
| 337 |
|
#define PMV_HALFPELDIAMOND8 0x00 |
| 338 |
|
|
| 339 |
/* ---vop-based; included here for conveienience */ |
#define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ |
| 340 |
int max_key_interval; /* [in:opt] the maximum interval between key frames */ |
#define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ |
| 341 |
/*XXX: maybe call it gop_size? */ |
#define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */ |
| 342 |
|
#define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */ |
| 343 |
|
|
| 344 |
int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
#define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_CHROMA[16/8] */ |
| 345 |
|
|
|
int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
|
|
int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ |
|
| 346 |
|
|
| 347 |
/* ^^^ -------------------------------------------------------------------------*/ |
/***************************************************************************** |
| 348 |
|
* Encoder structures |
| 349 |
|
****************************************************************************/ |
| 350 |
|
|
| 351 |
|
typedef struct |
| 352 |
|
{ |
| 353 |
|
int width, height; |
| 354 |
|
int fincr, fbase; /* [in] frame increment, fbase. each frame = "fincr/fbase" seconds */ |
| 355 |
|
int rc_bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */ |
| 356 |
|
int rc_reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */ |
| 357 |
|
int rc_averaging_period; /* [in] as above */ |
| 358 |
|
int rc_buffer; /* [in] as above */ |
| 359 |
|
int max_quantizer; /* [in] the upper limit of the quantizer */ |
| 360 |
|
int min_quantizer; /* [in] the lower limit of the quantizer */ |
| 361 |
|
int max_key_interval; /* [in] the maximum interval between key frames */ |
| 362 |
|
#ifdef _SMP |
| 363 |
|
int num_threads; /* [in] number of threads */ |
| 364 |
|
#endif |
| 365 |
|
int global; /* [in] global/debug options */ |
| 366 |
|
int max_bframes; /* [in] max sequential bframes (0=disable bframes) */ |
| 367 |
|
int bquant_ratio; /* [in] bframe quantizer multipier (percentage). |
| 368 |
|
used only when bquant < 1 |
| 369 |
|
eg. 200 = x2 multiplier |
| 370 |
|
quant = ((past_quant + future_quant) * bquant_ratio)/200 |
| 371 |
|
*/ |
| 372 |
|
int bquant_offset; /* [in] bquant += bquant_offset */ |
| 373 |
|
int frame_drop_ratio; /* [in] frame dropping: 0=drop none... 100=drop all */ |
| 374 |
void *handle; /* [out] encoder instance handle */ |
void *handle; /* [out] encoder instance handle */ |
| 375 |
} |
} XVID_ENC_PARAM; |
|
xvid_enc_create_t; |
|
|
|
|
|
|
|
|
typedef struct { |
|
|
int version; |
|
|
int type; /* [in] rate control type: XVID_RC_xxx */ |
|
|
|
|
|
/* common stuff */ |
|
|
int min_iquant; /* [in:opt] ivop quantizer upper/lower limit */ |
|
|
int max_iquant; /* [in:opt] */ |
|
|
int min_pquant; /* [in:opt] psvop quantizer upper/lower limit */ |
|
|
int max_pquant; /* [in:opt] */ |
|
|
int min_bquant; /* [in:opt] bvop quantizer upper/lower limit */ |
|
|
int max_bquant; /* [in:opt] */ |
|
|
|
|
|
union { |
|
|
struct { /* XVID_RC_FQUANT */ |
|
|
float quant; /* [in] quantizer */ |
|
|
} fquant; |
|
|
struct { /* XVID_RC_CBR */ |
|
|
int bitrate; /* [in] the bitrate of the target encoded stream, in bits/second */ |
|
|
int reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */ |
|
|
int averaging_period; /* [in] */ |
|
|
int buffer; /* [in] */ |
|
|
} cbr; |
|
|
} data; |
|
|
} xvid_enc_rc_t; |
|
|
|
|
|
|
|
|
|
|
|
#define XVID_KEYFRAME 0x00000001 |
|
| 376 |
|
|
| 377 |
typedef struct { |
typedef struct |
| 378 |
int version; |
{ |
| 379 |
|
int x; |
| 380 |
|
int y; |
| 381 |
|
} VECTOR; |
| 382 |
|
|
| 383 |
/* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any |
typedef struct |
| 384 |
changes here until the next VOL (keyframe). */ |
{ |
| 385 |
xvid_vol_t vol_flags; /* [in] vol flags */ |
int mode; /* macroblock mode */ |
| 386 |
unsigned char * |
VECTOR mvs[4]; |
| 387 |
quant_intra_matrix; /* [in:opt] custom intra qmatrix */ |
} MVBLOCKHINT; |
|
unsigned char * |
|
|
quant_inter_matrix; /* [in:opt] custom inter qmatrix */ |
|
| 388 |
|
|
| 389 |
int par; /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */ |
typedef struct |
| 390 |
int par_width; /* [in:opt] aspect ratio width */ |
{ |
| 391 |
int par_height; /* [in:opt] aspect ratio height */ |
int intra; /* frame intra choice */ |
| 392 |
/* ^^^----------------------------------------------------------------------------------*/ |
int fcode; /* frame fcode */ |
| 393 |
|
MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ |
| 394 |
|
} MVFRAMEHINT; |
| 395 |
|
|
| 396 |
xvid_vop_t vop_flags; /* [in] (general)vop-based flags */ |
typedef struct |
| 397 |
xvid_motion_t motion; /* [in] ME options */ |
{ |
| 398 |
|
int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ |
| 399 |
|
|
| 400 |
xvid_image_t input; /* [in] input image (read from) */ |
MVFRAMEHINT mvhint; |
| 401 |
|
void *hintstream; /* compressed hint buffer */ |
| 402 |
|
int hintlength; /* length of buffer (bytes) */ |
| 403 |
|
} HINTINFO; |
| 404 |
|
|
| 405 |
int type; /* [in:opt] coding type */ |
typedef struct |
| 406 |
int quant; /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */ |
{ |
| 407 |
int bquant; /* [in:opt] bframe quantizer; if <=0, automatic*/ |
int general; /* [in] general options */ |
| 408 |
|
int motion; /* [in] ME options */ |
| 409 |
|
void *bitstream; /* [in] bitstream ptr */ |
| 410 |
|
int length; /* [out] bitstream length (bytes) */ |
| 411 |
|
|
| 412 |
|
void *image; /* [in] image ptr */ |
| 413 |
|
int stride; /* [in] horizontal stride in bytes */ |
| 414 |
|
int colorspace; /* [in] source colorspace */ |
| 415 |
|
|
| 416 |
|
unsigned char *quant_intra_matrix; /* [in] custom intra qmatrix */ |
| 417 |
|
unsigned char *quant_inter_matrix; /* [in] custom inter qmatrix */ |
| 418 |
|
int quant; /* [in] frame quantizer (vbr) */ |
| 419 |
|
int intra; /* [in] force intra frame (vbr only) |
| 420 |
|
[out] frame type (ugly atm) |
| 421 |
|
*/ |
| 422 |
|
HINTINFO hint; /* [in/out] mv hint information */ |
| 423 |
|
|
| 424 |
void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
int bquant; /* [in] bframe quantizer */ |
| 425 |
int length; /* [in:opt] bitstream length (bytes) */ |
int bframe_threshold; /* [in] sensitivity of B-frame decision */ |
| 426 |
|
|
| 427 |
int out_flags; /* [out] bitstream output flags */ |
} XVID_ENC_FRAME; |
|
} |
|
|
xvid_enc_frame_t; |
|
| 428 |
|
|
| 429 |
|
|
| 430 |
/* XVID_ENC_ENCODE param2 (optional) |
typedef struct |
| 431 |
xvid_enc_stats_t describes individual frame details |
{ |
| 432 |
|
int quant; /* [out] frame quantizer */ |
| 433 |
|
int hlength; /* [out] header length (bytes) */ |
| 434 |
|
int kblks; /* [out] number of intra blocks */ |
| 435 |
|
int mblks; /* [out] number of inter blocks */ |
| 436 |
|
int ublks; /* [out] number of "not coded" blocks */ |
| 437 |
|
long sse_y; /* [out] SSE of Y */ |
| 438 |
|
long sse_u; /* [out] SSE of Cb */ |
| 439 |
|
long sse_v; /* [out] SSE of Cr */ |
| 440 |
|
int iblks; |
| 441 |
|
int qblks; |
| 442 |
|
} XVID_ENC_STATS; |
| 443 |
|
|
|
coding_type==XVID_TYPE_NOTHING if the stats are not given |
|
|
*/ |
|
|
typedef struct { |
|
|
int version; |
|
| 444 |
|
|
| 445 |
/* encoding parameters */ |
/***************************************************************************** |
| 446 |
int type; /* [out] coding type */ |
* Encoder entry point |
| 447 |
int quant; /* [out] frame quantizer */ |
****************************************************************************/ |
|
xvid_vol_t vol_flags; /* [out] vol flags (see above) */ |
|
|
int vop_flags; /* [out] vop flags (see above) */ |
|
|
/* bitrate */ |
|
|
int length; /* [out] frame length */ |
|
| 448 |
|
|
| 449 |
int hlength; /* [out] header length (bytes) */ |
/* Encoder options */ |
| 450 |
int kblks, mblks, ublks; /* [out] */ |
#define XVID_ENC_ENCODE 0 |
| 451 |
|
#define XVID_ENC_CREATE 1 |
| 452 |
|
#define XVID_ENC_DESTROY 2 |
| 453 |
|
|
| 454 |
|
int xvid_encore(void *handle, |
| 455 |
|
int opt, |
| 456 |
|
void *param1, |
| 457 |
|
void *param2); |
| 458 |
|
|
|
int sse_y, sse_u, sse_v; |
|
|
} |
|
|
xvid_enc_stats_t; |
|
| 459 |
|
|
| 460 |
#ifdef __cplusplus |
#ifdef __cplusplus |
| 461 |
} |
} |
| 462 |
#endif |
#endif |
| 463 |
|
|
|
|
|
| 464 |
#endif |
#endif |
Parent Directory
| 
Revision Log
| 
Patch