| 1 |
/***************************************************************************** |
/***************************************************************************** |
| 2 |
* |
* |
| 3 |
* XVID MPEG-4 VIDEO CODEC |
* XVID MPEG-4 VIDEO CODEC |
| 4 |
* - XviD Main header file - |
* - Xvid Main header file - |
| 5 |
* |
* |
| 6 |
* This file is part of XviD, a free MPEG-4 video encoder/decoder |
* Copyright(C) 2001-2011 Peter Ross <pross@xvid.org> |
| 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 |
| 19 |
* along with this program; if not, write to the Free Software |
* along with this program; if not, write to the Free Software |
| 20 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 21 |
* |
* |
| 22 |
* $Id: xvid.h,v 1.29 2003-06-09 17:07:32 Isibaar Exp $ |
* $Id$ |
| 23 |
* |
* |
| 24 |
****************************************************************************/ |
****************************************************************************/ |
| 25 |
|
|
| 31 |
#endif |
#endif |
| 32 |
|
|
| 33 |
/***************************************************************************** |
/***************************************************************************** |
| 34 |
* Global constants |
* function export defines |
| 35 |
****************************************************************************/ |
****************************************************************************/ |
| 36 |
|
|
| 37 |
/* API Version : 2.1 */ |
/* Attention! Work in progress. TODO: Review */ |
| 38 |
#define API_VERSION ((2 << 16) | (1)) |
|
| 39 |
#define XVID_API_UNSTABLE |
#ifndef XVID_IMPEXP |
| 40 |
|
#define XVID_IMPEXP extern |
| 41 |
|
#endif |
| 42 |
|
|
| 43 |
|
#ifndef XVID_CALL |
| 44 |
|
#define XVID_CALL |
| 45 |
|
#endif |
| 46 |
|
|
| 47 |
|
/***************************************************************************** |
| 48 |
|
* versioning |
| 49 |
|
****************************************************************************/ |
| 50 |
|
|
| 51 |
|
/* versioning |
| 52 |
|
version takes the form "$major.$minor.$patch" |
| 53 |
|
$patch is incremented when there is no api change |
| 54 |
|
$minor is incremented when the api is changed, but remains backwards compatible |
| 55 |
|
$major is incremented when the api is changed significantly |
| 56 |
|
|
| 57 |
|
when initialising an xvid structure, you must always zero it, and set the version field. |
| 58 |
|
memset(&struct,0,sizeof(struct)); |
| 59 |
|
struct.version = XVID_VERSION; |
| 60 |
|
|
| 61 |
|
XVID_UNSTABLE is defined only during development. |
| 62 |
|
*/ |
| 63 |
|
|
| 64 |
|
#define XVID_MAKE_VERSION(a,b,c) ((((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff)) |
| 65 |
|
#define XVID_VERSION_MAJOR(a) ((char)(((a)>>16) & 0xff)) |
| 66 |
|
#define XVID_VERSION_MINOR(a) ((char)(((a)>> 8) & 0xff)) |
| 67 |
|
#define XVID_VERSION_PATCH(a) ((char)(((a)>> 0) & 0xff)) |
| 68 |
|
|
| 69 |
|
#define XVID_MAKE_API(a,b) ((((a)&0xff)<<16) | (((b)&0xff)<<0)) |
| 70 |
|
#define XVID_API_MAJOR(a) (((a)>>16) & 0xff) |
| 71 |
|
#define XVID_API_MINOR(a) (((a)>> 0) & 0xff) |
| 72 |
|
|
| 73 |
|
#define XVID_VERSION XVID_MAKE_VERSION(1,4,-127) |
| 74 |
|
#define XVID_API XVID_MAKE_API(4, 4) |
| 75 |
|
|
| 76 |
|
#define XVID_UNSTABLE |
| 77 |
|
|
| 78 |
/* Bitstream Version |
/* Bitstream Version |
| 79 |
* 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 |
| 86 |
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
* doesnt hurt but not increasing it could cause difficulty for decoders in the |
| 87 |
* future |
* future |
| 88 |
*/ |
*/ |
| 89 |
#define XVID_BS_VERSION "0010" |
#define XVID_BS_VERSION 73 |
| 90 |
|
|
| 91 |
|
/***************************************************************************** |
| 92 |
|
* error codes |
| 93 |
|
****************************************************************************/ |
| 94 |
|
|
| 95 |
|
/* all functions return values <0 indicate error */ |
| 96 |
|
|
| 97 |
/* Error codes */ |
#define XVID_ERR_FAIL -1 /* general fault */ |
| 98 |
#define XVID_ERR_FAIL -1 |
#define XVID_ERR_MEMORY -2 /* memory allocation error */ |
| 99 |
#define XVID_ERR_OK 0 |
#define XVID_ERR_FORMAT -3 /* file format error */ |
| 100 |
#define XVID_ERR_MEMORY 1 |
#define XVID_ERR_VERSION -4 /* structure version not supported */ |
| 101 |
#define XVID_ERR_FORMAT 2 |
#define XVID_ERR_END -5 /* encoder only; end of stream reached */ |
| 102 |
|
|
| 103 |
|
|
| 104 |
|
|
| 105 |
|
/***************************************************************************** |
| 106 |
|
* xvid_image_t |
| 107 |
|
****************************************************************************/ |
| 108 |
|
|
| 109 |
|
/* colorspace values */ |
| 110 |
|
|
| 111 |
|
#define XVID_CSP_PLANAR (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */ |
| 112 |
|
#define XVID_CSP_USER XVID_CSP_PLANAR |
| 113 |
|
#define XVID_CSP_I420 (1<< 1) /* 4:2:0 planar */ |
| 114 |
|
#define XVID_CSP_YV12 (1<< 2) /* 4:2:0 planar */ |
| 115 |
|
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
| 116 |
|
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
| 117 |
|
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
| 118 |
|
#define XVID_CSP_RGB (1<<16) /* 24-bit rgb packed */ |
| 119 |
|
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
| 120 |
|
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
| 121 |
|
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
| 122 |
|
#define XVID_CSP_ARGB (1<<15) /* 32-bit argb packed */ |
| 123 |
|
#define XVID_CSP_BGR (1<< 9) /* 24-bit bgr packed */ |
| 124 |
|
#define XVID_CSP_RGB555 (1<<10) /* 16-bit rgb555 packed */ |
| 125 |
|
#define XVID_CSP_RGB565 (1<<11) /* 16-bit rgb565 packed */ |
| 126 |
|
#define XVID_CSP_SLICE (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */ |
| 127 |
|
#define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */ |
| 128 |
|
#define XVID_CSP_NULL (1<<14) /* decoder only: dont output anything */ |
| 129 |
|
#define XVID_CSP_VFLIP (1<<31) /* vertical flip mask */ |
| 130 |
|
|
| 131 |
|
/* xvid_image_t |
| 132 |
|
for non-planar colorspaces use only plane[0] and stride[0] |
| 133 |
|
four plane reserved for alpha*/ |
| 134 |
|
typedef struct { |
| 135 |
|
int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */ |
| 136 |
|
void * plane[4]; /* [in] image plane ptrs */ |
| 137 |
|
int stride[4]; /* [in] image stride; "bytes per row"*/ |
| 138 |
|
} xvid_image_t; |
| 139 |
|
|
| 140 |
|
/* video-object-sequence profiles */ |
| 141 |
|
#define XVID_PROFILE_S_L0 0x08 /* simple */ |
| 142 |
|
#define XVID_PROFILE_S_L1 0x01 |
| 143 |
|
#define XVID_PROFILE_S_L2 0x02 |
| 144 |
|
#define XVID_PROFILE_S_L3 0x03 |
| 145 |
|
#define XVID_PROFILE_S_L4a 0x04 |
| 146 |
|
#define XVID_PROFILE_S_L5 0x05 |
| 147 |
|
#define XVID_PROFILE_S_L6 0x06 |
| 148 |
|
#define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ |
| 149 |
|
#define XVID_PROFILE_ARTS_L2 0x92 |
| 150 |
|
#define XVID_PROFILE_ARTS_L3 0x93 |
| 151 |
|
#define XVID_PROFILE_ARTS_L4 0x94 |
| 152 |
|
#define XVID_PROFILE_AS_L0 0xf0 /* advanced simple */ |
| 153 |
|
#define XVID_PROFILE_AS_L1 0xf1 |
| 154 |
|
#define XVID_PROFILE_AS_L2 0xf2 |
| 155 |
|
#define XVID_PROFILE_AS_L3 0xf3 |
| 156 |
|
#define XVID_PROFILE_AS_L4 0xf4 |
| 157 |
|
|
| 158 |
|
/* aspect ratios */ |
| 159 |
|
#define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if supplied PAR is not a valid value */ |
| 160 |
|
#define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ |
| 161 |
|
#define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ |
| 162 |
|
#define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ |
| 163 |
|
#define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */ |
| 164 |
|
#define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */ |
| 165 |
|
|
| 166 |
|
/* frame type flags */ |
| 167 |
|
#define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */ |
| 168 |
|
#define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */ |
| 169 |
|
#define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */ |
| 170 |
|
#define XVID_TYPE_IVOP 1 /* intra frame */ |
| 171 |
|
#define XVID_TYPE_PVOP 2 /* predicted frame */ |
| 172 |
|
#define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ |
| 173 |
|
#define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ |
| 174 |
|
|
| 175 |
|
|
| 176 |
/* Colorspaces */ |
/***************************************************************************** |
| 177 |
#define XVID_CSP_RGB24 0 /* [b|g|r] */ |
* xvid_global() |
| 178 |
#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] */ |
|
| 179 |
|
|
| 180 |
|
/* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */ |
| 181 |
|
|
| 182 |
|
#define XVID_CPU_FORCE (1<<31) /* force passed cpu flags */ |
| 183 |
|
#define XVID_CPU_ASM (1<< 7) /* native assembly */ |
| 184 |
|
/* ARCH_IS_IA32 */ |
| 185 |
|
#define XVID_CPU_MMX (1<< 0) /* mmx : pentiumMMX,k6 */ |
| 186 |
|
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
| 187 |
|
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
| 188 |
|
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
| 189 |
|
#define XVID_CPU_SSE3 (1<< 8) /* sse3 : pentium4, athlon64 */ |
| 190 |
|
#define XVID_CPU_SSE41 (1<< 9) /* sse41: penryn */ |
| 191 |
|
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
| 192 |
|
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
| 193 |
|
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
| 194 |
|
/* ARCH_IS_PPC */ |
| 195 |
|
#define XVID_CPU_ALTIVEC (1<< 0) /* altivec */ |
| 196 |
|
|
|
#define XVID_CSP_NULL 9999 |
|
| 197 |
|
|
| 198 |
#define XVID_CSP_VFLIP 0x80000000 /* flip mask */ |
#define XVID_DEBUG_ERROR (1<< 0) |
| 199 |
|
#define XVID_DEBUG_STARTCODE (1<< 1) |
| 200 |
|
#define XVID_DEBUG_HEADER (1<< 2) |
| 201 |
|
#define XVID_DEBUG_TIMECODE (1<< 3) |
| 202 |
|
#define XVID_DEBUG_MB (1<< 4) |
| 203 |
|
#define XVID_DEBUG_COEFF (1<< 5) |
| 204 |
|
#define XVID_DEBUG_MV (1<< 6) |
| 205 |
|
#define XVID_DEBUG_RC (1<< 7) |
| 206 |
|
#define XVID_DEBUG_DEBUG (1<<31) |
| 207 |
|
|
| 208 |
|
/* XVID_GBL_INIT param1 */ |
| 209 |
|
typedef struct { |
| 210 |
|
int version; |
| 211 |
|
unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */ |
| 212 |
|
int debug; /* [in:opt] debug level */ |
| 213 |
|
} xvid_gbl_init_t; |
| 214 |
|
|
| 215 |
|
|
| 216 |
|
/* XVID_GBL_INFO param1 */ |
| 217 |
|
typedef struct { |
| 218 |
|
int version; |
| 219 |
|
int actual_version; /* [out] returns the actual xvidcore version */ |
| 220 |
|
const char * build; /* [out] if !null, points to description of this xvid core build */ |
| 221 |
|
unsigned int cpu_flags; /* [out] detected cpu features */ |
| 222 |
|
int num_threads; /* [out] detected number of cpus/threads */ |
| 223 |
|
} xvid_gbl_info_t; |
| 224 |
|
|
| 225 |
|
|
| 226 |
|
/* XVID_GBL_CONVERT param1 */ |
| 227 |
|
typedef struct { |
| 228 |
|
int version; |
| 229 |
|
xvid_image_t input; /* [in] input image & colorspace */ |
| 230 |
|
xvid_image_t output; /* [in] output image & colorspace */ |
| 231 |
|
int width; /* [in] width */ |
| 232 |
|
int height; /* [in] height */ |
| 233 |
|
int interlacing; /* [in] interlacing */ |
| 234 |
|
} xvid_gbl_convert_t; |
| 235 |
|
|
| 236 |
|
|
| 237 |
|
#define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */ |
| 238 |
|
#define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ |
| 239 |
|
#define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ |
| 240 |
|
|
| 241 |
|
XVID_IMPEXP int XVID_CALL xvid_global(void *handle, int opt, void *param1, void *param2); |
| 242 |
|
|
| 243 |
|
|
| 244 |
|
/***************************************************************************** |
| 245 |
|
* xvid_decore() |
| 246 |
|
****************************************************************************/ |
| 247 |
|
|
| 248 |
|
#define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
| 249 |
|
#define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ |
| 250 |
|
#define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ |
| 251 |
|
|
| 252 |
|
XVID_IMPEXP int XVID_CALL xvid_decore(void *handle, int opt, void *param1, void *param2); |
| 253 |
|
|
| 254 |
|
/* XVID_DEC_CREATE param 1 |
| 255 |
|
image width & height as well as FourCC code may be specified |
| 256 |
|
here when known in advance (e.g. being read from container) */ |
| 257 |
|
typedef struct { |
| 258 |
|
int version; |
| 259 |
|
int width; /* [in:opt] image width */ |
| 260 |
|
int height; /* [in:opt] image width */ |
| 261 |
|
void * handle; /* [out] decore context handle */ |
| 262 |
|
/* ------- v1.3.x ------- */ |
| 263 |
|
int fourcc; /* [in:opt] fourcc of the input video */ |
| 264 |
|
int num_threads;/* [in:opt] number of threads to use in decoder */ |
| 265 |
|
} xvid_dec_create_t; |
| 266 |
|
|
| 267 |
|
|
| 268 |
|
/* XVID_DEC_DECODE param1 */ |
| 269 |
|
/* general flags */ |
| 270 |
|
#define XVID_LOWDELAY (1<<0) /* lowdelay mode */ |
| 271 |
|
#define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ |
| 272 |
|
#define XVID_DEBLOCKY (1<<2) /* perform luma deblocking */ |
| 273 |
|
#define XVID_DEBLOCKUV (1<<3) /* perform chroma deblocking */ |
| 274 |
|
#define XVID_FILMEFFECT (1<<4) /* adds film grain */ |
| 275 |
|
#define XVID_DERINGUV (1<<5) /* perform chroma deringing, requires deblocking to work */ |
| 276 |
|
#define XVID_DERINGY (1<<6) /* perform luma deringing, requires deblocking to work */ |
| 277 |
|
|
| 278 |
|
#define XVID_DEC_FAST (1<<29) /* disable postprocessing to decrease cpu usage *todo* */ |
| 279 |
|
#define XVID_DEC_DROP (1<<30) /* drop bframes to decrease cpu usage *todo* */ |
| 280 |
|
#define XVID_DEC_PREROLL (1<<31) /* decode as fast as you can, don't even show output *todo* */ |
| 281 |
|
|
| 282 |
|
typedef struct { |
| 283 |
|
int version; |
| 284 |
|
int general; /* [in:opt] general flags */ |
| 285 |
|
void *bitstream; /* [in] bitstream (read from)*/ |
| 286 |
|
int length; /* [in] bitstream length */ |
| 287 |
|
xvid_image_t output; /* [in] output image (written to) */ |
| 288 |
|
/* ------- v1.1.x ------- */ |
| 289 |
|
int brightness; /* [in] brightness offset (0=none) */ |
| 290 |
|
} xvid_dec_frame_t; |
| 291 |
|
|
| 292 |
|
|
| 293 |
|
/* XVID_DEC_DECODE param2 :: optional */ |
| 294 |
|
typedef struct |
| 295 |
|
{ |
| 296 |
|
int version; |
| 297 |
|
|
| 298 |
|
int type; /* [out] output data type */ |
| 299 |
|
union { |
| 300 |
|
struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ |
| 301 |
|
int general; /* [out] flags */ |
| 302 |
|
int time_base; /* [out] time base */ |
| 303 |
|
int time_increment; /* [out] time increment */ |
| 304 |
|
|
| 305 |
|
/* XXX: external deblocking stuff */ |
| 306 |
|
int * qscale; /* [out] pointer to quantizer table */ |
| 307 |
|
int qscale_stride; /* [out] quantizer scale stride */ |
| 308 |
|
|
| 309 |
|
} vop; |
| 310 |
|
struct { /* XVID_TYPE_VOL */ |
| 311 |
|
int general; /* [out] flags */ |
| 312 |
|
int width; /* [out] width */ |
| 313 |
|
int height; /* [out] height */ |
| 314 |
|
int par; /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
| 315 |
|
int par_width; /* [out] aspect ratio width [1..255] */ |
| 316 |
|
int par_height; /* [out] aspect ratio height [1..255] */ |
| 317 |
|
} vol; |
| 318 |
|
} data; |
| 319 |
|
} xvid_dec_stats_t; |
| 320 |
|
|
| 321 |
|
#define XVID_ZONE_QUANT (1<<0) |
| 322 |
|
#define XVID_ZONE_WEIGHT (1<<1) |
| 323 |
|
|
| 324 |
|
typedef struct |
| 325 |
|
{ |
| 326 |
|
int frame; |
| 327 |
|
int mode; |
| 328 |
|
int increment; |
| 329 |
|
int base; |
| 330 |
|
} xvid_enc_zone_t; |
| 331 |
|
|
| 332 |
|
|
| 333 |
|
/*---------------------------------------------------------------------------- |
| 334 |
|
* xvid_enc_stats_t structure |
| 335 |
|
* |
| 336 |
|
* Used in: |
| 337 |
|
* - xvid_plg_data_t structure |
| 338 |
|
* - optional parameter in xvid_encore() function |
| 339 |
|
* |
| 340 |
|
* .coding_type = XVID_TYPE_NOTHING if the stats are not given |
| 341 |
|
*--------------------------------------------------------------------------*/ |
| 342 |
|
|
| 343 |
|
typedef struct { |
| 344 |
|
int version; |
| 345 |
|
|
| 346 |
|
/* encoding parameters */ |
| 347 |
|
int type; /* [out] coding type */ |
| 348 |
|
int quant; /* [out] frame quantizer */ |
| 349 |
|
int vol_flags; /* [out] vol flags (see above) */ |
| 350 |
|
int vop_flags; /* [out] vop flags (see above) */ |
| 351 |
|
|
| 352 |
|
/* bitrate */ |
| 353 |
|
int length; /* [out] frame length */ |
| 354 |
|
|
| 355 |
|
int hlength; /* [out] header length (bytes) */ |
| 356 |
|
int kblks; /* [out] number of blocks compressed as Intra */ |
| 357 |
|
int mblks; /* [out] number of blocks compressed as Inter */ |
| 358 |
|
int ublks; /* [out] number of blocks marked as not_coded */ |
| 359 |
|
|
| 360 |
|
int sse_y; /* [out] Y plane's sse */ |
| 361 |
|
int sse_u; /* [out] U plane's sse */ |
| 362 |
|
int sse_v; /* [out] V plane's sse */ |
| 363 |
|
} xvid_enc_stats_t; |
| 364 |
|
|
| 365 |
/***************************************************************************** |
/***************************************************************************** |
| 366 |
* Initialization constants |
xvid plugin system -- internals |
| 367 |
|
|
| 368 |
|
xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE |
| 369 |
|
before encoding each frame xvidcore will call XVID_PLG_BEFORE |
| 370 |
|
after encoding each frame xvidcore will call XVID_PLG_AFTER |
| 371 |
|
xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY |
| 372 |
****************************************************************************/ |
****************************************************************************/ |
| 373 |
|
|
|
/* 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 */ |
|
| 374 |
|
|
| 375 |
/* ARCH_IS_IA32 */ |
#define XVID_PLG_CREATE (1<<0) |
| 376 |
#define XVID_CPU_MMX 0x00000001 /* mmx : pentiumMMX,k6 */ |
#define XVID_PLG_DESTROY (1<<1) |
| 377 |
#define XVID_CPU_MMXEXT 0x00000002 /* mmx-ext : pentium2, athlon */ |
#define XVID_PLG_INFO (1<<2) |
| 378 |
#define XVID_CPU_SSE 0x00000004 /* sse : pentium3, athlonXP */ |
#define XVID_PLG_BEFORE (1<<3) |
| 379 |
#define XVID_CPU_SSE2 0x00000008 /* sse2 : pentium4, athlon64 */ |
#define XVID_PLG_FRAME (1<<4) |
| 380 |
#define XVID_CPU_3DNOW 0x00000010 /* 3dnow : k6-2 */ |
#define XVID_PLG_AFTER (1<<5) |
|
#define XVID_CPU_3DNOWEXT 0x00000020 /* 3dnow-ext: athlon */ |
|
|
#define XVID_CPU_TSC 0x00000040 /* timestamp counter */ |
|
| 381 |
|
|
| 382 |
/* ARCH_IS_IA64 */ |
/* xvid_plg_info_t.flags */ |
| 383 |
#define XVID_CPU_IA64 XVID_CPU_ASM /* defined for backward compatibility */ |
#define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
| 384 |
|
#define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ |
| 385 |
|
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
| 386 |
|
#define XVID_REQLAMBDA (1<<3) /* plugin requires access to the lambda table */ |
| 387 |
|
|
| 388 |
/* ARCH_IS_PPC */ |
typedef struct |
| 389 |
#define XVID_CPU_ALTIVEC 0x00000001 /* altivec */ |
{ |
| 390 |
|
int version; |
| 391 |
|
int flags; /* [in:opt] plugin flags */ |
| 392 |
|
} xvid_plg_info_t; |
| 393 |
|
|
| 394 |
|
|
| 395 |
typedef struct |
typedef struct |
| 396 |
{ |
{ |
| 397 |
int colorspace; |
int version; |
| 398 |
void * y; |
|
| 399 |
void * u; |
int num_zones; /* [out] */ |
| 400 |
void * v; |
xvid_enc_zone_t * zones; /* [out] */ |
| 401 |
int y_stride; |
|
| 402 |
int uv_stride; |
int width; /* [out] */ |
| 403 |
} XVID_IMAGE; /* from yv12 */ |
int height; /* [out] */ |
| 404 |
|
int mb_width; /* [out] */ |
| 405 |
#define XVID_INIT_INIT 0 |
int mb_height; /* [out] */ |
| 406 |
#define XVID_INIT_CONVERT 1 |
int fincr; /* [out] */ |
| 407 |
#define XVID_INIT_TEST 2 |
int fbase; /* [out] */ |
| 408 |
|
|
| 409 |
|
void * param; /* [out] */ |
| 410 |
|
} xvid_plg_create_t; |
| 411 |
|
|
|
/***************************************************************************** |
|
|
* Initialization structures |
|
|
****************************************************************************/ |
|
| 412 |
|
|
| 413 |
typedef struct |
typedef struct |
| 414 |
{ |
{ |
| 415 |
int cpu_flags; |
int version; |
| 416 |
int api_version; |
|
| 417 |
int core_build; |
int num_frames; /* [out] total frame encoded */ |
| 418 |
} XVID_INIT_PARAM; |
} xvid_plg_destroy_t; |
| 419 |
|
|
| 420 |
typedef struct |
typedef struct |
| 421 |
{ |
{ |
| 422 |
XVID_IMAGE input; |
int version; |
|
XVID_IMAGE output; |
|
|
int width; |
|
|
int height; |
|
|
int interlacing; |
|
|
} XVID_INIT_CONVERTINFO; |
|
| 423 |
|
|
| 424 |
/***************************************************************************** |
xvid_enc_zone_t * zone; /* [out] current zone */ |
|
* Initialization entry point |
|
|
****************************************************************************/ |
|
| 425 |
|
|
| 426 |
int xvid_init(void *handle, |
int width; /* [out] */ |
| 427 |
int opt, |
int height; /* [out] */ |
| 428 |
void *param1, |
int mb_width; /* [out] */ |
| 429 |
void *param2); |
int mb_height; /* [out] */ |
| 430 |
|
int fincr; /* [out] */ |
| 431 |
|
int fbase; /* [out] */ |
| 432 |
|
|
| 433 |
|
int min_quant[3]; /* [out] */ |
| 434 |
|
int max_quant[3]; /* [out] */ |
| 435 |
|
|
| 436 |
/***************************************************************************** |
xvid_image_t reference; /* [out] -> [out] */ |
| 437 |
* Decoder constants |
xvid_image_t current; /* [out] -> [in,out] */ |
| 438 |
****************************************************************************/ |
xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ |
| 439 |
|
int frame_num; /* [out] frame number */ |
| 440 |
|
|
| 441 |
/* Flags for XVID_DEC_FRAME.general */ |
int type; /* [in,out] */ |
| 442 |
#define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. VFW) */ |
int quant; /* [in,out] */ |
| 443 |
#define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */ |
|
| 444 |
#define XVID_DEC_DEBLOCKUV 0x00000008 /* chroma deblocking */ |
int * dquant; /* [in,out] pointer to diff quantizer table */ |
| 445 |
#define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream |
int dquant_stride; /* [in,out] diff quantizer stride */ |
| 446 |
instructs decoder to ignore any |
|
| 447 |
previous reference frames */ |
int vop_flags; /* [in,out] */ |
| 448 |
#define XVID_QUICK_DECODE 0x00000010 |
int vol_flags; /* [in,out] */ |
| 449 |
|
int motion_flags; /* [in,out] */ |
| 450 |
|
|
| 451 |
|
/* Lambda table for HVSPlugins */ |
| 452 |
|
float * lambda; /* [in,out] six floats for each macroblock. read, multiply, write back */ |
| 453 |
|
|
| 454 |
|
/* Deprecated, use the stats field instead. |
| 455 |
|
* Will disapear before 1.0 */ |
| 456 |
|
int length; /* [out] after: length of encoded frame */ |
| 457 |
|
int kblks; /* [out] number of blocks compressed as Intra */ |
| 458 |
|
int mblks; /* [out] number of blocks compressed as Inter */ |
| 459 |
|
int ublks; /* [out] number of blocks marked not_coded */ |
| 460 |
|
int sse_y; /* [out] Y plane's sse */ |
| 461 |
|
int sse_u; /* [out] U plane's sse */ |
| 462 |
|
int sse_v; /* [out] V plane's sse */ |
| 463 |
|
/* End of duplicated data, kept only for binary compatibility */ |
| 464 |
|
|
| 465 |
|
int bquant_ratio; /* [in] */ |
| 466 |
|
int bquant_offset; /* [in] */ |
| 467 |
|
|
| 468 |
|
xvid_enc_stats_t stats; /* [out] frame statistics */ |
| 469 |
|
} xvid_plg_data_t; |
| 470 |
|
|
| 471 |
/***************************************************************************** |
/***************************************************************************** |
| 472 |
* Decoder structures |
xvid plugin system -- external |
|
****************************************************************************/ |
|
| 473 |
|
|
| 474 |
typedef struct |
the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array |
| 475 |
{ |
indicates the plugin function pointer and plugin-specific data. |
| 476 |
int width; |
xvidcore handles the rest. example: |
|
int height; |
|
|
void *handle; |
|
|
} XVID_DEC_PARAM; |
|
| 477 |
|
|
| 478 |
|
xvid_enc_create_t create; |
| 479 |
|
xvid_enc_plugin_t plugins[2]; |
| 480 |
|
|
| 481 |
#define XVID_DEC_VOP 0 |
plugins[0].func = xvid_psnr_func; |
| 482 |
#define XVID_DEC_VOL 1 |
plugins[0].param = NULL; |
| 483 |
#define XVID_DEC_NOTHING 2 /* nothing was decoded */ |
plugins[1].func = xvid_cbr_func; |
| 484 |
|
plugins[1].param = &cbr_data; |
| 485 |
|
|
| 486 |
typedef struct |
create.num_plugins = 2; |
| 487 |
{ |
create.plugins = plugins; |
|
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; |
|
| 488 |
|
|
| 489 |
|
****************************************************************************/ |
| 490 |
|
|
| 491 |
|
typedef int (XVID_CALL xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); |
| 492 |
|
|
| 493 |
typedef struct |
typedef struct |
| 494 |
{ |
{ |
| 495 |
int general; |
xvid_plugin_func * func; |
| 496 |
void *bitstream; |
void * param; |
| 497 |
int length; |
} xvid_enc_plugin_t; |
| 498 |
|
|
| 499 |
|
XVID_IMPEXP xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
| 500 |
|
XVID_IMPEXP xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ |
| 501 |
|
XVID_IMPEXP xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ |
| 502 |
|
|
| 503 |
|
XVID_IMPEXP xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
| 504 |
|
|
| 505 |
void *image; |
XVID_IMPEXP xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
| 506 |
int stride; |
XVID_IMPEXP xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
|
int colorspace; |
|
|
} XVID_DEC_FRAME; |
|
| 507 |
|
|
| 508 |
|
XVID_IMPEXP xvid_plugin_func xvid_plugin_ssim; /*write ssim values to stdout*/ |
| 509 |
|
XVID_IMPEXP xvid_plugin_func xvid_plugin_psnrhvsm; /*write psnrhvsm values to stdout*/ |
| 510 |
|
|
| 511 |
/* This struct is used for per slice rendering */ |
|
| 512 |
|
/* single pass rate control |
| 513 |
|
* CBR and Constant quantizer modes */ |
| 514 |
typedef struct |
typedef struct |
| 515 |
{ |
{ |
| 516 |
void *y,*u,*v; |
int version; |
|
int stride_y, stride_u,stride_v; |
|
|
} XVID_DEC_PICTURE; |
|
| 517 |
|
|
| 518 |
|
int bitrate; /* [in] bits per second */ |
| 519 |
|
int reaction_delay_factor; /* [in] */ |
| 520 |
|
int averaging_period; /* [in] */ |
| 521 |
|
int buffer; /* [in] */ |
| 522 |
|
} xvid_plugin_single_t; |
| 523 |
|
|
|
/***************************************************************************** |
|
|
* Decoder entry point |
|
|
****************************************************************************/ |
|
| 524 |
|
|
| 525 |
/* decoder options */ |
typedef struct { |
| 526 |
#define XVID_DEC_DECODE 0 |
int version; |
|
#define XVID_DEC_CREATE 1 |
|
|
#define XVID_DEC_DESTROY 2 |
|
|
|
|
|
int xvid_decore(void *handle, |
|
|
int opt, |
|
|
void *param1, |
|
|
void *param2); |
|
| 527 |
|
|
| 528 |
|
char * filename; |
| 529 |
|
} xvid_plugin_2pass1_t; |
| 530 |
|
|
|
/***************************************************************************** |
|
|
* Encoder constants |
|
|
****************************************************************************/ |
|
| 531 |
|
|
| 532 |
/* Flags for XVID_ENC_PARAM.global */ |
#define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
| 533 |
#define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */ |
#define XVID_PAYBACK_PROP 1 /* payback proportionally */ |
| 534 |
#define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */ |
|
| 535 |
#define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */ |
typedef struct { |
| 536 |
#define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */ |
int version; |
| 537 |
|
|
| 538 |
#define XVID_GLOBAL_EXTRASTATS 0x00000200 /* generate extra statistics */ |
int bitrate; /* [in] target bitrate (bits per second) */ |
| 539 |
|
char * filename; /* [in] first pass stats filename */ |
| 540 |
|
|
| 541 |
|
int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
| 542 |
|
int curve_compression_high; /* [in] percentage of compression performed on the high part of the curve (above average) */ |
| 543 |
|
int curve_compression_low; /* [in] percentage of compression performed on the low part of the curve (below average) */ |
| 544 |
|
int overflow_control_strength;/* [in] Payback delay expressed in number of frames */ |
| 545 |
|
int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */ |
| 546 |
|
int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */ |
| 547 |
|
|
| 548 |
/* Flags for XVID_ENC_FRAME.general */ |
int kfreduction; /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */ |
| 549 |
#define XVID_VALID_FLAGS 0x80000000 |
int kfthreshold; /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits |
| 550 |
|
* is substracted from its bit allocation. The reduction is computed as multiples of |
| 551 |
|
* kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold, |
| 552 |
|
* 0 for 1<distance<kfthreshold */ |
| 553 |
|
|
| 554 |
#define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */ |
int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
|
#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 |
|
| 555 |
|
|
| 556 |
#define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */ |
/* ------- v1.1.x ------- */ |
| 557 |
#define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */ |
int vbv_size; /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/ |
| 558 |
#define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */ |
int vbv_initial; /* [in] initial buffer occupancy (bits) */ |
| 559 |
|
int vbv_maxrate; /* [in] max processing bitrate (bits per second) */ |
| 560 |
|
int vbv_peakrate; /* [in:opt] max average bitrate over 1 second (bits per second). |
| 561 |
|
* This is used for diagnostics only and won't affect the actual peak bitrate. |
| 562 |
|
* This is not a problem as long as vbv_peakrate > vbv_size + vbv_maxrate which |
| 563 |
|
* guarantees that vbv_peakrate won't be exceeded. */ |
| 564 |
|
}xvid_plugin_2pass2_t; |
| 565 |
|
|
|
#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) */ |
|
| 566 |
|
|
| 567 |
#define XVID_INTER4V 0x00008000 |
typedef struct{ |
| 568 |
|
/*stat output*/ |
| 569 |
|
int b_printstat; |
| 570 |
|
char* stat_path; |
| 571 |
|
|
| 572 |
#define XVID_ME_ZERO 0x00010000 |
/*visualize*/ |
| 573 |
#define XVID_ME_LOGARITHMIC 0x00020000 |
int b_visualize; |
|
#define XVID_ME_FULLSEARCH 0x00040000 |
|
|
#define XVID_ME_PMVFAST 0x00080000 |
|
|
#define XVID_ME_EPZS 0x00100000 |
|
| 574 |
|
|
| 575 |
#define XVID_CHROMAOPT 0x00200000 /* enable chroma optimization pre-filter */ |
/*accuracy 0 very accurate 4 very fast*/ |
| 576 |
|
int acc; |
| 577 |
|
|
| 578 |
#define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for |
int cpu_flags; /* XVID_CPU_XXX flags */ |
|
color input material chroma is ignored) */ |
|
| 579 |
|
|
| 580 |
#define XVID_GMC 0x10000000 |
} xvid_plugin_ssim_t; |
|
#define XVID_GMC_TRANSLATIONAL 0x20000000 |
|
| 581 |
|
|
| 582 |
#define XVID_REDUCED 0x04000000 /* reduced resolution vop */ |
typedef struct { |
| 583 |
#define XVID_HQACPRED 0x08000000 /* 20030209: high quality ac prediction */ |
int version; |
| 584 |
|
|
| 585 |
#define XVID_EXTRASTATS 0x00000200 /* generate extra statistics */ |
int method; /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */ |
| 586 |
|
} xvid_plugin_lumimasking_t; |
| 587 |
|
|
| 588 |
|
/***************************************************************************** |
| 589 |
|
* ENCODER API |
| 590 |
|
****************************************************************************/ |
| 591 |
|
|
| 592 |
#define XVID_MODEDECISION_BITS 0x00400000 /* enable DCT-ME and use it for mode decision */ |
/*---------------------------------------------------------------------------- |
| 593 |
|
* Encoder operations |
| 594 |
|
*--------------------------------------------------------------------------*/ |
| 595 |
|
|
| 596 |
|
#define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
| 597 |
|
#define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ |
| 598 |
|
#define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes |
| 599 |
|
* 0 means this frame should not be written (ie. encoder lag) */ |
| 600 |
|
|
|
/* 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 */ |
|
| 601 |
|
|
| 602 |
#define PMV_HALFPELREFINE16 0x00020000 |
/*---------------------------------------------------------------------------- |
| 603 |
#define PMV_HALFPELREFINE8 0x02000000 |
* Encoder entry point |
| 604 |
|
*--------------------------------------------------------------------------*/ |
| 605 |
|
|
| 606 |
#define PMV_QUARTERPELREFINE16 0x00040000 |
XVID_IMPEXP int XVID_CALL xvid_encore(void *handle, int opt, void *param1, void *param2); |
|
#define PMV_QUARTERPELREFINE8 0x04000000 |
|
| 607 |
|
|
| 608 |
#define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */ |
/* Quick API reference |
| 609 |
|
* |
| 610 |
|
* XVID_ENC_CREATE operation |
| 611 |
|
* - handle: ignored |
| 612 |
|
* - opt: XVID_ENC_CREATE |
| 613 |
|
* - param1: address of a xvid_enc_create_t structure |
| 614 |
|
* - param2: ignored |
| 615 |
|
* |
| 616 |
|
* XVID_ENC_ENCODE operation |
| 617 |
|
* - handle: an instance returned by a CREATE op |
| 618 |
|
* - opt: XVID_ENC_ENCODE |
| 619 |
|
* - param1: address of a xvid_enc_frame_t structure |
| 620 |
|
* - param2: address of a xvid_enc_stats_t structure (optional) |
| 621 |
|
* its return value is asynchronous to what is written to the buffer |
| 622 |
|
* depending on the delay introduced by bvop use. It's display |
| 623 |
|
* ordered. |
| 624 |
|
* |
| 625 |
|
* XVID_ENC_DESTROY operation |
| 626 |
|
* - handle: an instance returned by a CREATE op |
| 627 |
|
* - opt: XVID_ENC_DESTROY |
| 628 |
|
* - param1: ignored |
| 629 |
|
* - param2: ignored |
| 630 |
|
*/ |
| 631 |
|
|
|
#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 */ |
|
| 632 |
|
|
| 633 |
#define PMV_CHROMA16 0x00100000 /* also use chroma for P_VOP/S_VOP ME */ |
/*---------------------------------------------------------------------------- |
| 634 |
#define PMV_CHROMA8 0x10000000 /* also use chroma for B_VOP ME */ |
* "Global" flags |
| 635 |
|
* |
| 636 |
|
* These flags are used for xvid_enc_create_t->global field during instance |
| 637 |
|
* creation (operation XVID_ENC_CREATE) |
| 638 |
|
*--------------------------------------------------------------------------*/ |
| 639 |
|
|
| 640 |
|
#define XVID_GLOBAL_PACKED (1<<0) /* packed bitstream */ |
| 641 |
|
#define XVID_GLOBAL_CLOSED_GOP (1<<1) /* closed_gop: was DX50BVOP dx50 bvop compatibility */ |
| 642 |
|
#define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2) |
| 643 |
|
#if 0 |
| 644 |
|
#define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ |
| 645 |
|
#define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ |
| 646 |
|
#endif |
| 647 |
|
#define XVID_GLOBAL_DIVX5_USERDATA (1<<5) /* write divx5 userdata string |
| 648 |
|
this is implied if XVID_GLOBAL_PACKED is set */ |
| 649 |
|
|
| 650 |
/* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */ |
/*---------------------------------------------------------------------------- |
| 651 |
#define HALFPELREFINE16_BITS 0x00000100 /* perform DCT-based halfpel refinement */ |
* "VOL" flags |
| 652 |
#define HALFPELREFINE8_BITS 0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */ |
* |
| 653 |
#define QUARTERPELREFINE16_BITS 0x00000400 /* perform DCT-based qpel refinement */ |
* These flags are used for xvid_enc_frame_t->vol_flags field during frame |
| 654 |
#define QUARTERPELREFINE8_BITS 0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */ |
* encoding (operation XVID_ENC_ENCODE) |
| 655 |
|
*--------------------------------------------------------------------------*/ |
| 656 |
|
|
| 657 |
|
#define XVID_VOL_MPEGQUANT (1<<0) /* enable MPEG type quantization */ |
| 658 |
|
#define XVID_VOL_EXTRASTATS (1<<1) /* enable plane sse stats */ |
| 659 |
|
#define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ |
| 660 |
|
#define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ |
| 661 |
|
#define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
| 662 |
|
/* NOTE: the reduced resolution feature is not supported anymore. This flag will have no effect! */ |
| 663 |
|
#define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ |
| 664 |
|
|
|
#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 */ |
|
| 665 |
|
|
| 666 |
|
/*---------------------------------------------------------------------------- |
| 667 |
|
* "VOP" flags |
| 668 |
|
* |
| 669 |
|
* These flags are used for xvid_enc_frame_t->vop_flags field during frame |
| 670 |
|
* encoding (operation XVID_ENC_ENCODE) |
| 671 |
|
*--------------------------------------------------------------------------*/ |
| 672 |
|
|
| 673 |
|
/* Always valid */ |
| 674 |
|
#define XVID_VOP_DEBUG (1<< 0) /* print debug messages in frames */ |
| 675 |
|
#define XVID_VOP_HALFPEL (1<< 1) /* use halfpel interpolation */ |
| 676 |
|
#define XVID_VOP_INTER4V (1<< 2) /* use 4 motion vectors per MB */ |
| 677 |
|
#define XVID_VOP_TRELLISQUANT (1<< 3) /* use trellis based R-D "optimal" quantization */ |
| 678 |
|
#define XVID_VOP_CHROMAOPT (1<< 4) /* enable chroma optimization pre-filter */ |
| 679 |
|
#define XVID_VOP_CARTOON (1<< 5) /* use 'cartoon mode' */ |
| 680 |
|
#define XVID_VOP_GREYSCALE (1<< 6) /* enable greyscale only mode (even for color input material chroma is ignored) */ |
| 681 |
|
#define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ |
| 682 |
|
#define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ |
| 683 |
|
#define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */ |
| 684 |
|
#define XVID_VOP_RD_BVOP (1<<13) /* enable rate-distortion mode decision in b-frames */ |
| 685 |
|
#define XVID_VOP_RD_PSNRHVSM (1<<14) /* use PSNR-HVS-M as metric for rate-distortion optimizations */ |
| 686 |
|
|
| 687 |
|
/* Only valid for vol_flags|=XVID_VOL_INTERLACING */ |
| 688 |
|
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
| 689 |
|
#define XVID_VOP_ALTERNATESCAN (1<<10) /* set alternate vertical scan flag */ |
| 690 |
|
|
| 691 |
|
/* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
| 692 |
|
#define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ |
| 693 |
|
/* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */ |
| 694 |
|
|
| 695 |
/* note: old and deprecated - or never implemented */ |
/*---------------------------------------------------------------------------- |
| 696 |
|
* "Motion" flags |
| 697 |
|
* |
| 698 |
|
* These flags are used for xvid_enc_frame_t->motion field during frame |
| 699 |
|
* encoding (operation XVID_ENC_ENCODE) |
| 700 |
|
*--------------------------------------------------------------------------*/ |
| 701 |
|
|
| 702 |
|
/* Motion Estimation Search Patterns */ |
| 703 |
|
#define XVID_ME_ADVANCEDDIAMOND16 (1<< 0) /* use advdiamonds instead of diamonds as search pattern */ |
| 704 |
|
#define XVID_ME_ADVANCEDDIAMOND8 (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */ |
| 705 |
|
#define XVID_ME_USESQUARES16 (1<< 2) /* use squares instead of diamonds as search pattern */ |
| 706 |
|
#define XVID_ME_USESQUARES8 (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */ |
| 707 |
|
|
| 708 |
|
/* SAD operator based flags */ |
| 709 |
|
#define XVID_ME_HALFPELREFINE16 (1<< 4) |
| 710 |
|
#define XVID_ME_HALFPELREFINE8 (1<< 6) |
| 711 |
|
#define XVID_ME_QUARTERPELREFINE16 (1<< 7) |
| 712 |
|
#define XVID_ME_QUARTERPELREFINE8 (1<< 8) |
| 713 |
|
#define XVID_ME_GME_REFINE (1<< 9) |
| 714 |
|
#define XVID_ME_EXTSEARCH16 (1<<10) /* extend PMV by more searches */ |
| 715 |
|
#define XVID_ME_EXTSEARCH8 (1<<11) /* use diamond/square for extended 8x8 search */ |
| 716 |
|
#define XVID_ME_CHROMA_PVOP (1<<12) /* also use chroma for P_VOP/S_VOP ME */ |
| 717 |
|
#define XVID_ME_CHROMA_BVOP (1<<13) /* also use chroma for B_VOP ME */ |
| 718 |
|
#define XVID_ME_FASTREFINE16 (1<<25) /* use low-complexity refinement functions */ |
| 719 |
|
#define XVID_ME_FASTREFINE8 (1<<29) /* low-complexity 8x8 sub-block refinement */ |
| 720 |
|
|
| 721 |
|
/* Rate Distortion based flags |
| 722 |
|
* Valid when XVID_VOP_MODEDECISION_RD is enabled */ |
| 723 |
|
#define XVID_ME_HALFPELREFINE16_RD (1<<14) /* perform RD-based halfpel refinement */ |
| 724 |
|
#define XVID_ME_HALFPELREFINE8_RD (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */ |
| 725 |
|
#define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */ |
| 726 |
|
#define XVID_ME_QUARTERPELREFINE8_RD (1<<17) /* perform RD-based qpel refinement for 8x8 mode */ |
| 727 |
|
#define XVID_ME_EXTSEARCH_RD (1<<18) /* perform RD-based search using square pattern enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */ |
| 728 |
|
#define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */ |
| 729 |
|
|
| 730 |
|
/* Other */ |
| 731 |
|
#define XVID_ME_DETECT_STATIC_MOTION (1<<24) /* speed-up ME by detecting stationary scenes */ |
| 732 |
|
#define XVID_ME_SKIP_DELTASEARCH (1<<26) /* speed-up by skipping b-frame delta search */ |
| 733 |
|
#define XVID_ME_FAST_MODEINTERPOLATE (1<<27) /* speed-up by partly skipping interpolate mode */ |
| 734 |
|
#define XVID_ME_BFRAME_EARLYSTOP (1<<28) /* speed-up by early exiting b-search */ |
| 735 |
|
|
| 736 |
|
/* Unused */ |
| 737 |
|
#define XVID_ME_UNRESTRICTED16 (1<<20) /* unrestricted ME, not implemented */ |
| 738 |
|
#define XVID_ME_OVERLAPPING16 (1<<21) /* overlapping ME, not implemented */ |
| 739 |
|
#define XVID_ME_UNRESTRICTED8 (1<<22) /* unrestricted ME, not implemented */ |
| 740 |
|
#define XVID_ME_OVERLAPPING8 (1<<23) /* overlapping ME, not implemented */ |
| 741 |
|
|
|
/* only for compatability with old encoders */ |
|
| 742 |
|
|
| 743 |
#define PMV_EARLYSTOP16 0x00 |
/*---------------------------------------------------------------------------- |
| 744 |
#define PMV_EARLYSTOP8 0x00 |
* xvid_enc_create_t structure definition |
| 745 |
#define PMV_QUICKSTOP16 0x00 |
* |
| 746 |
#define PMV_QUICKSTOP8 0x00 |
* This structure is passed as param1 during an instance creation (operation |
| 747 |
|
* XVID_ENC_CREATE) |
| 748 |
|
*--------------------------------------------------------------------------*/ |
| 749 |
|
|
| 750 |
#define PMV_HALFPELDIAMOND16 0x00 |
typedef struct { |
| 751 |
#define PMV_HALFPELDIAMOND8 0x00 |
int version; |
| 752 |
|
|
| 753 |
#define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ |
int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */ |
| 754 |
#define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ |
int width; /* [in] frame dimensions; width, pixel units */ |
| 755 |
#define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */ |
int height; /* [in] frame dimensions; height, pixel units */ |
|
#define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */ |
|
| 756 |
|
|
| 757 |
#define XVID_ME_COLOUR 0x00 /* this has been converted to PMV_CHROMA[16/8] */ |
int num_zones; /* [in:opt] number of bitrate zones */ |
| 758 |
|
xvid_enc_zone_t * zones; /* ^^ zone array */ |
| 759 |
|
|
| 760 |
|
int num_plugins; /* [in:opt] number of plugins */ |
| 761 |
|
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
| 762 |
|
|
| 763 |
/***************************************************************************** |
int num_threads; /* [in:opt] number of threads to use in encoder */ |
| 764 |
* Encoder structures |
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
|
****************************************************************************/ |
|
| 765 |
|
|
| 766 |
typedef struct |
int global; /* [in:opt] global flags; controls encoding behavior */ |
|
{ |
|
|
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; |
|
| 767 |
|
|
| 768 |
typedef struct |
/* --- vol-based stuff; included here for convenience */ |
| 769 |
{ |
int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ |
| 770 |
int x; |
int fbase; /* [in] framerate base frame_duration = fincr/fbase seconds*/ |
| 771 |
int y; |
/* ---------------------------------------------- */ |
|
} VECTOR; |
|
| 772 |
|
|
| 773 |
typedef struct |
/* --- vop-based; included here for convenience */ |
| 774 |
{ |
int max_key_interval; /* [in:opt] the maximum interval between key frames */ |
|
int mode; /* macroblock mode */ |
|
|
VECTOR mvs[4]; |
|
|
} MVBLOCKHINT; |
|
| 775 |
|
|
| 776 |
typedef struct |
int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
|
{ |
|
|
int intra; /* frame intra choice */ |
|
|
int fcode; /* frame fcode */ |
|
|
MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ |
|
|
} MVFRAMEHINT; |
|
| 777 |
|
|
| 778 |
typedef struct |
int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
| 779 |
{ |
int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ |
|
int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ |
|
| 780 |
|
|
| 781 |
MVFRAMEHINT mvhint; |
int min_quant[3]; /* [in:opt] */ |
| 782 |
void *hintstream; /* compressed hint buffer */ |
int max_quant[3]; /* [in:opt] */ |
| 783 |
int hintlength; /* length of buffer (bytes) */ |
/* ---------------------------------------------- */ |
|
} HINTINFO; |
|
| 784 |
|
|
| 785 |
typedef struct |
void *handle; /* [out] encoder instance handle */ |
|
{ |
|
|
int general; /* [in] general options */ |
|
|
int motion; /* [in] ME options */ |
|
|
void *bitstream; /* [in] bitstream ptr */ |
|
|
int length; /* [out] bitstream length (bytes) */ |
|
| 786 |
|
|
| 787 |
void *image; /* [in] image ptr */ |
/* ------- v1.3.x ------- */ |
| 788 |
int stride; /* [in] horizontal stride in bytes */ |
int start_frame_num; /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */ |
| 789 |
int colorspace; /* [in] source colorspace */ |
int num_slices; /* [in:opt] number of slices to code for each frame */ |
| 790 |
|
} xvid_enc_create_t; |
|
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 */ |
|
| 791 |
|
|
|
int bquant; /* [in] bframe quantizer */ |
|
|
int bframe_threshold; /* [in] sensitivity of B-frame decision */ |
|
| 792 |
|
|
| 793 |
} XVID_ENC_FRAME; |
/*---------------------------------------------------------------------------- |
| 794 |
|
* xvid_enc_frame_t structure definition |
| 795 |
|
* |
| 796 |
|
* This structure is passed as param1 during a frame encoding (operation |
| 797 |
|
* XVID_ENC_ENCODE) |
| 798 |
|
*--------------------------------------------------------------------------*/ |
| 799 |
|
|
| 800 |
|
/* out value for the frame structure->type field |
| 801 |
|
* unlike stats output in param2, this field is not asynchronous and tells |
| 802 |
|
* the client app, if the frame written into the stream buffer is an ivop |
| 803 |
|
* usually used for indexing purpose in the container */ |
| 804 |
|
#define XVID_KEYFRAME (1<<1) |
| 805 |
|
|
| 806 |
|
/* The structure */ |
| 807 |
|
typedef struct { |
| 808 |
|
int version; |
| 809 |
|
|
| 810 |
|
/* VOL related stuff |
| 811 |
|
* unless XVID_FORCEVOL is set, the encoder will not react to any changes |
| 812 |
|
* here until the next VOL (keyframe). */ |
| 813 |
|
|
| 814 |
|
int vol_flags; /* [in] vol flags */ |
| 815 |
|
unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */ |
| 816 |
|
unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */ |
| 817 |
|
|
| 818 |
|
int par; /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
| 819 |
|
int par_width; /* [in:opt] aspect ratio width */ |
| 820 |
|
int par_height; /* [in:opt] aspect ratio height */ |
| 821 |
|
|
| 822 |
|
/* Other fields that can change on a frame base */ |
| 823 |
|
|
| 824 |
typedef struct |
int fincr; /* [in:opt] framerate increment, for variable framerate only */ |
| 825 |
{ |
int vop_flags; /* [in] (general)vop-based flags */ |
| 826 |
int quant; /* [out] frame quantizer */ |
int motion; /* [in] ME options */ |
|
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; |
|
| 827 |
|
|
| 828 |
|
xvid_image_t input; /* [in] input image (read from) */ |
| 829 |
|
|
| 830 |
/***************************************************************************** |
int type; /* [in:opt] coding type */ |
| 831 |
* Encoder entry point |
int quant; /* [in] frame quantizer; if <=0, automatic (ratecontrol) */ |
| 832 |
****************************************************************************/ |
int bframe_threshold; |
| 833 |
|
|
| 834 |
/* Encoder options */ |
void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
| 835 |
#define XVID_ENC_ENCODE 0 |
int length; /* [in:opt] bitstream length (bytes) */ |
|
#define XVID_ENC_CREATE 1 |
|
|
#define XVID_ENC_DESTROY 2 |
|
|
|
|
|
int xvid_encore(void *handle, |
|
|
int opt, |
|
|
void *param1, |
|
|
void *param2); |
|
| 836 |
|
|
| 837 |
|
int out_flags; /* [out] bitstream output flags */ |
| 838 |
|
} xvid_enc_frame_t; |
| 839 |
|
|
| 840 |
#ifdef __cplusplus |
#ifdef __cplusplus |
| 841 |
} |
} |
Parent Directory
| 
Revision Log
| 
Patch