Parent Directory
| 
Revision Log
Revision 1448 - (view) (download)
| 1 : | edgomez | 199 | /***************************************************************************** |
| 2 : | edgomez | 868 | * |
| 3 : | edgomez | 1107 | * XVID MPEG-4 VIDEO CODEC |
| 4 : | * - XviD Main header file - | ||
| 5 : | edgomez | 868 | * |
| 6 : | edgomez | 1054 | * Copyright(C) 2001-2003 Peter Ross <pross@xvid.org> |
| 7 : | edgomez | 868 | * |
| 8 : | edgomez | 1054 | * This program is free software ; you can redistribute it and/or modify |
| 9 : | edgomez | 868 | * it under the terms of the GNU General Public License as published by |
| 10 : | edgomez | 1054 | * the Free Software Foundation ; either version 2 of the License, or |
| 11 : | edgomez | 868 | * (at your option) any later version. |
| 12 : | * | ||
| 13 : | * This program is distributed in the hope that it will be useful, | ||
| 14 : | edgomez | 1054 | * but WITHOUT ANY WARRANTY ; without even the implied warranty of |
| 15 : | edgomez | 868 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 : | * GNU General Public License for more details. | ||
| 17 : | * | ||
| 18 : | * You should have received a copy of the GNU General Public License | ||
| 19 : | edgomez | 1054 | * along with this program ; if not, write to the Free Software |
| 20 : | edgomez | 868 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 21 : | * | ||
| 22 : | chl | 1448 | * $Id: xvid.h,v 1.27.2.67 2004-05-09 14:00:35 chl Exp $ |
| 23 : | edgomez | 868 | * |
| 24 : | ****************************************************************************/ | ||
| 25 : | edgomez | 199 | |
| 26 : | #ifndef _XVID_H_ | ||
| 27 : | #define _XVID_H_ | ||
| 28 : | |||
| 29 : | suxen_drol | 919 | |
| 30 : | edgomez | 199 | #ifdef __cplusplus |
| 31 : | chl | 352 | extern "C" { |
| 32 : | edgomez | 199 | #endif |
| 33 : | |||
| 34 : | /***************************************************************************** | ||
| 35 : | suxen_drol | 890 | * versioning |
| 36 : | edgomez | 199 | ****************************************************************************/ |
| 37 : | |||
| 38 : | suxen_drol | 890 | /* versioning |
| 39 : | version takes the form "$major.$minor.$patch" | ||
| 40 : | $patch is incremented when there is no api change | ||
| 41 : | $minor is incremented when the api is changed, but remains backwards compatible | ||
| 42 : | $major is incremented when the api is changed significantly | ||
| 43 : | edgomez | 199 | |
| 44 : | suxen_drol | 890 | when initialising an xvid structure, you must always zero it, and set the version field. |
| 45 : | memset(&struct,0,sizeof(struct)); | ||
| 46 : | struct.version = XVID_VERSION; | ||
| 47 : | |||
| 48 : | edgomez | 1161 | XVID_UNSTABLE is defined only during development. |
| 49 : | suxen_drol | 890 | */ |
| 50 : | |||
| 51 : | edgomez | 1107 | #define XVID_MAKE_VERSION(a,b,c) ((((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff)) |
| 52 : | edgomez | 1155 | #define XVID_VERSION_MAJOR(a) ((char)(((a)>>16) & 0xff)) |
| 53 : | #define XVID_VERSION_MINOR(a) ((char)(((a)>> 8) & 0xff)) | ||
| 54 : | #define XVID_VERSION_PATCH(a) ((char)(((a)>> 0) & 0xff)) | ||
| 55 : | suxen_drol | 890 | |
| 56 : | edgomez | 1107 | #define XVID_MAKE_API(a,b) ((((a)&0xff)<<16) | (((b)&0xff)<<0)) |
| 57 : | #define XVID_API_MAJOR(a) (((a)>>16) & 0xff) | ||
| 58 : | #define XVID_API_MINOR(a) (((a)>> 0) & 0xff) | ||
| 59 : | |||
| 60 : | edgomez | 1373 | #define XVID_VERSION XVID_MAKE_VERSION(1,0,-124) |
| 61 : | edgomez | 1107 | #define XVID_API XVID_MAKE_API(4, 0) |
| 62 : | |||
| 63 : | suxen_drol | 890 | #define XVID_UNSTABLE |
| 64 : | |||
| 65 : | edgomez | 1161 | /* Bitstream Version |
| 66 : | * this will be writen into the bitstream to allow easy detection of xvid | ||
| 67 : | * encoder bugs in the decoder, without this it might not possible to | ||
| 68 : | * automatically distinquish between a file which has been encoded with an | ||
| 69 : | edgomez | 851 | * old & buggy XVID from a file which has been encoded with a bugfree version |
| 70 : | * see the infamous interlacing bug ... | ||
| 71 : | * | ||
| 72 : | * this MUST be increased if an encoder bug is fixed, increasing it too often | ||
| 73 : | * doesnt hurt but not increasing it could cause difficulty for decoders in the | ||
| 74 : | * future | ||
| 75 : | edgomez | 608 | */ |
| 76 : | chl | 1448 | #define XVID_BS_VERSION "0030" |
| 77 : | edgomez | 199 | |
| 78 : | |||
| 79 : | suxen_drol | 890 | /***************************************************************************** |
| 80 : | * error codes | ||
| 81 : | ****************************************************************************/ | ||
| 82 : | edgomez | 199 | |
| 83 : | edgomez | 1107 | /* all functions return values <0 indicate error */ |
| 84 : | edgomez | 199 | |
| 85 : | suxen_drol | 890 | #define XVID_ERR_FAIL -1 /* general fault */ |
| 86 : | edgomez | 1107 | #define XVID_ERR_MEMORY -2 /* memory allocation error */ |
| 87 : | #define XVID_ERR_FORMAT -3 /* file format error */ | ||
| 88 : | suxen_drol | 890 | #define XVID_ERR_VERSION -4 /* structure version not supported */ |
| 89 : | #define XVID_ERR_END -5 /* encoder only; end of stream reached */ | ||
| 90 : | edgomez | 199 | |
| 91 : | |||
| 92 : | edgomez | 608 | |
| 93 : | suxen_drol | 890 | /***************************************************************************** |
| 94 : | * xvid_image_t | ||
| 95 : | ****************************************************************************/ | ||
| 96 : | edgomez | 608 | |
| 97 : | suxen_drol | 890 | /* colorspace values */ |
| 98 : | edgomez | 608 | |
| 99 : | chl | 1344 | #define XVID_CSP_PLANAR (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */ |
| 100 : | #define XVID_CSP_USER XVID_CSP_PLANAR | ||
| 101 : | chl | 1244 | #define XVID_CSP_I420 (1<< 1) /* 4:2:0 planar */ |
| 102 : | #define XVID_CSP_YV12 (1<< 2) /* 4:2:0 planar */ | ||
| 103 : | edgomez | 1107 | #define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
| 104 : | #define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ | ||
| 105 : | #define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ | ||
| 106 : | #define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ | ||
| 107 : | #define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ | ||
| 108 : | #define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ | ||
| 109 : | edgomez | 1290 | #define XVID_CSP_ARGB (1<<15) /* 32-bit argb packed */ |
| 110 : | edgomez | 1107 | #define XVID_CSP_BGR (1<< 9) /* 24-bit bgr packed */ |
| 111 : | #define XVID_CSP_RGB555 (1<<10) /* 16-bit rgb555 packed */ | ||
| 112 : | #define XVID_CSP_RGB565 (1<<11) /* 16-bit rgb565 packed */ | ||
| 113 : | #define XVID_CSP_SLICE (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */ | ||
| 114 : | #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */ | ||
| 115 : | #define XVID_CSP_NULL (1<<14) /* decoder only: dont output anything */ | ||
| 116 : | #define XVID_CSP_VFLIP (1<<31) /* vertical flip mask */ | ||
| 117 : | edgomez | 608 | |
| 118 : | suxen_drol | 890 | /* xvid_image_t |
| 119 : | for non-planar colorspaces use only plane[0] and stride[0] | ||
| 120 : | four plane reserved for alpha*/ | ||
| 121 : | typedef struct { | ||
| 122 : | int csp; /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */ | ||
| 123 : | void * plane[4]; /* [in] image plane ptrs */ | ||
| 124 : | int stride[4]; /* [in] image stride; "bytes per row"*/ | ||
| 125 : | } xvid_image_t; | ||
| 126 : | |||
| 127 : | suxen_drol | 1014 | /* video-object-sequence profiles */ |
| 128 : | edgomez | 1107 | #define XVID_PROFILE_S_L0 0x08 /* simple */ |
| 129 : | #define XVID_PROFILE_S_L1 0x01 | ||
| 130 : | #define XVID_PROFILE_S_L2 0x02 | ||
| 131 : | #define XVID_PROFILE_S_L3 0x03 | ||
| 132 : | #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ | ||
| 133 : | #define XVID_PROFILE_ARTS_L2 0x92 | ||
| 134 : | #define XVID_PROFILE_ARTS_L3 0x93 | ||
| 135 : | #define XVID_PROFILE_ARTS_L4 0x94 | ||
| 136 : | #define XVID_PROFILE_AS_L0 0xf0 /* advanced simple */ | ||
| 137 : | #define XVID_PROFILE_AS_L1 0xf1 | ||
| 138 : | #define XVID_PROFILE_AS_L2 0xf2 | ||
| 139 : | #define XVID_PROFILE_AS_L3 0xf3 | ||
| 140 : | #define XVID_PROFILE_AS_L4 0xf4 | ||
| 141 : | suxen_drol | 890 | |
| 142 : | /* aspect ratios */ | ||
| 143 : | edgomez | 1259 | #define XVID_PAR_11_VGA 1 /* 1:1 vga (square), default if supplied PAR is not a valid value */ |
| 144 : | edgomez | 1107 | #define XVID_PAR_43_PAL 2 /* 4:3 pal (12:11 625-line) */ |
| 145 : | #define XVID_PAR_43_NTSC 3 /* 4:3 ntsc (10:11 525-line) */ | ||
| 146 : | #define XVID_PAR_169_PAL 4 /* 16:9 pal (16:11 625-line) */ | ||
| 147 : | #define XVID_PAR_169_NTSC 5 /* 16:9 ntsc (40:33 525-line) */ | ||
| 148 : | #define XVID_PAR_EXT 15 /* extended par; use par_width, par_height */ | ||
| 149 : | suxen_drol | 890 | |
| 150 : | /* frame type flags */ | ||
| 151 : | edgomez | 1107 | #define XVID_TYPE_VOL -1 /* decoder only: vol was decoded */ |
| 152 : | #define XVID_TYPE_NOTHING 0 /* decoder only (encoder stats): nothing was decoded/encoded */ | ||
| 153 : | #define XVID_TYPE_AUTO 0 /* encoder: automatically determine coding type */ | ||
| 154 : | #define XVID_TYPE_IVOP 1 /* intra frame */ | ||
| 155 : | #define XVID_TYPE_PVOP 2 /* predicted frame */ | ||
| 156 : | #define XVID_TYPE_BVOP 3 /* bidirectionally encoded */ | ||
| 157 : | #define XVID_TYPE_SVOP 4 /* predicted+sprite frame */ | ||
| 158 : | suxen_drol | 890 | |
| 159 : | suxen_drol | 1014 | |
| 160 : | edgomez | 199 | /***************************************************************************** |
| 161 : | suxen_drol | 890 | * xvid_global() |
| 162 : | edgomez | 199 | ****************************************************************************/ |
| 163 : | |||
| 164 : | edgomez | 1176 | /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */ |
| 165 : | edgomez | 199 | |
| 166 : | edgomez | 1107 | #define XVID_CPU_FORCE (1<<31) /* force passed cpu flags */ |
| 167 : | #define XVID_CPU_ASM (1<< 7) /* native assembly */ | ||
| 168 : | edgomez | 851 | /* ARCH_IS_IA32 */ |
| 169 : | edgomez | 1107 | #define XVID_CPU_MMX (1<< 0) /* mmx : pentiumMMX,k6 */ |
| 170 : | #define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ | ||
| 171 : | #define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ | ||
| 172 : | #define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ | ||
| 173 : | #define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ | ||
| 174 : | #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ | ||
| 175 : | #define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ | ||
| 176 : | edgomez | 851 | /* ARCH_IS_PPC */ |
| 177 : | edgomez | 1107 | #define XVID_CPU_ALTIVEC (1<< 0) /* altivec */ |
| 178 : | edgomez | 199 | |
| 179 : | Isibaar | 209 | |
| 180 : | edgomez | 1107 | #define XVID_DEBUG_ERROR (1<< 0) |
| 181 : | #define XVID_DEBUG_STARTCODE (1<< 1) | ||
| 182 : | #define XVID_DEBUG_HEADER (1<< 2) | ||
| 183 : | #define XVID_DEBUG_TIMECODE (1<< 3) | ||
| 184 : | #define XVID_DEBUG_MB (1<< 4) | ||
| 185 : | #define XVID_DEBUG_COEFF (1<< 5) | ||
| 186 : | #define XVID_DEBUG_MV (1<< 6) | ||
| 187 : | #define XVID_DEBUG_RC (1<< 7) | ||
| 188 : | #define XVID_DEBUG_DEBUG (1<<31) | ||
| 189 : | suxen_drol | 1031 | |
| 190 : | suxen_drol | 890 | /* XVID_GBL_INIT param1 */ |
| 191 : | typedef struct { | ||
| 192 : | int version; | ||
| 193 : | chl | 1115 | unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */ |
| 194 : | edgomez | 1107 | int debug; /* [in:opt] debug level */ |
| 195 : | suxen_drol | 890 | } xvid_gbl_init_t; |
| 196 : | edgomez | 199 | |
| 197 : | |||
| 198 : | suxen_drol | 890 | /* XVID_GBL_INFO param1 */ |
| 199 : | typedef struct { | ||
| 200 : | int version; | ||
| 201 : | edgomez | 1107 | int actual_version; /* [out] returns the actual xvidcore version */ |
| 202 : | const char * build; /* [out] if !null, points to description of this xvid core build */ | ||
| 203 : | chl | 1115 | unsigned int cpu_flags; /* [out] detected cpu features */ |
| 204 : | edgomez | 1107 | int num_threads; /* [out] detected number of cpus/threads */ |
| 205 : | suxen_drol | 890 | } xvid_gbl_info_t; |
| 206 : | Isibaar | 209 | |
| 207 : | edgomez | 199 | |
| 208 : | suxen_drol | 890 | /* XVID_GBL_CONVERT param1 */ |
| 209 : | typedef struct { | ||
| 210 : | int version; | ||
| 211 : | edgomez | 1107 | xvid_image_t input; /* [in] input image & colorspace */ |
| 212 : | xvid_image_t output; /* [in] output image & colorspace */ | ||
| 213 : | int width; /* [in] width */ | ||
| 214 : | int height; /* [in] height */ | ||
| 215 : | int interlacing; /* [in] interlacing */ | ||
| 216 : | suxen_drol | 890 | } xvid_gbl_convert_t; |
| 217 : | edgomez | 851 | |
| 218 : | edgomez | 199 | |
| 219 : | edgomez | 1107 | #define XVID_GBL_INIT 0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */ |
| 220 : | #define XVID_GBL_INFO 1 /* return some info about xvidcore, and the host computer */ | ||
| 221 : | #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */ | ||
| 222 : | edgomez | 199 | |
| 223 : | edgomez | 1267 | extern int xvid_global(void *handle, int opt, void *param1, void *param2); |
| 224 : | edgomez | 199 | |
| 225 : | |||
| 226 : | /***************************************************************************** | ||
| 227 : | suxen_drol | 890 | * xvid_decore() |
| 228 : | edgomez | 199 | ****************************************************************************/ |
| 229 : | |||
| 230 : | edgomez | 1107 | #define XVID_DEC_CREATE 0 /* create decore instance; return 0 on success */ |
| 231 : | #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */ | ||
| 232 : | #define XVID_DEC_DECODE 2 /* decode a frame: returns number of bytes consumed >= 0 */ | ||
| 233 : | edgomez | 199 | |
| 234 : | edgomez | 1267 | extern int xvid_decore(void *handle, int opt, void *param1, void *param2); |
| 235 : | edgomez | 199 | |
| 236 : | edgomez | 1161 | /* XVID_DEC_CREATE param 1 |
| 237 : | suxen_drol | 890 | image width & height may be specified here when the dimensions are |
| 238 : | known in advance. */ | ||
| 239 : | typedef struct { | ||
| 240 : | int version; | ||
| 241 : | edgomez | 1107 | int width; /* [in:opt] image width */ |
| 242 : | int height; /* [in:opt] image width */ | ||
| 243 : | void * handle; /* [out] decore context handle */ | ||
| 244 : | suxen_drol | 890 | } xvid_dec_create_t; |
| 245 : | edgomez | 851 | |
| 246 : | |||
| 247 : | suxen_drol | 890 | /* XVID_DEC_DECODE param1 */ |
| 248 : | /* general flags */ | ||
| 249 : | edgomez | 1107 | #define XVID_LOWDELAY (1<<0) /* lowdelay mode */ |
| 250 : | #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */ | ||
| 251 : | edgomez | 1253 | #define XVID_DEBLOCKY (1<<2) /* perform luma deblocking */ |
| 252 : | Isibaar | 1251 | #define XVID_DEBLOCKUV (1<<3) /* perform chroma deblocking */ |
| 253 : | edgomez | 1276 | #define XVID_FILMEFFECT (1<<4) /* adds film grain */ |
| 254 : | edgomez | 851 | |
| 255 : | suxen_drol | 890 | typedef struct { |
| 256 : | int version; | ||
| 257 : | edgomez | 1107 | int general; /* [in:opt] general flags */ |
| 258 : | void *bitstream; /* [in] bitstream (read from)*/ | ||
| 259 : | int length; /* [in] bitstream length */ | ||
| 260 : | xvid_image_t output; /* [in] output image (written to) */ | ||
| 261 : | } xvid_dec_frame_t; | ||
| 262 : | edgomez | 199 | |
| 263 : | |||
| 264 : | suxen_drol | 890 | /* XVID_DEC_DECODE param2 :: optional */ |
| 265 : | typedef struct | ||
| 266 : | { | ||
| 267 : | int version; | ||
| 268 : | edgomez | 1107 | |
| 269 : | int type; /* [out] output data type */ | ||
| 270 : | suxen_drol | 890 | union { |
| 271 : | edgomez | 1107 | struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */ |
| 272 : | int general; /* [out] flags */ | ||
| 273 : | int time_base; /* [out] time base */ | ||
| 274 : | int time_increment; /* [out] time increment */ | ||
| 275 : | edgomez | 199 | |
| 276 : | suxen_drol | 890 | /* XXX: external deblocking stuff */ |
| 277 : | edgomez | 1107 | int * qscale; /* [out] pointer to quantizer table */ |
| 278 : | int qscale_stride; /* [out] quantizer scale stride */ | ||
| 279 : | edgomez | 199 | |
| 280 : | suxen_drol | 890 | } vop; |
| 281 : | struct { /* XVID_TYPE_VOL */ | ||
| 282 : | edgomez | 1107 | int general; /* [out] flags */ |
| 283 : | int width; /* [out] width */ | ||
| 284 : | int height; /* [out] height */ | ||
| 285 : | chl | 1243 | int par; /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
| 286 : | edgomez | 1259 | int par_width; /* [out] aspect ratio width [1..255] */ |
| 287 : | int par_height; /* [out] aspect ratio height [1..255] */ | ||
| 288 : | suxen_drol | 890 | } vol; |
| 289 : | } data; | ||
| 290 : | } xvid_dec_stats_t; | ||
| 291 : | albeu | 315 | |
| 292 : | edgomez | 1107 | #define XVID_ZONE_QUANT (1<<0) |
| 293 : | #define XVID_ZONE_WEIGHT (1<<1) | ||
| 294 : | |||
| 295 : | suxen_drol | 1014 | typedef struct |
| 296 : | { | ||
| 297 : | edgomez | 1107 | int frame; |
| 298 : | int mode; | ||
| 299 : | int increment; | ||
| 300 : | int base; | ||
| 301 : | suxen_drol | 1014 | } xvid_enc_zone_t; |
| 302 : | |||
| 303 : | |||
| 304 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 305 : | * xvid_enc_stats_t structure | ||
| 306 : | * | ||
| 307 : | * Used in: | ||
| 308 : | * - xvid_plg_data_t structure | ||
| 309 : | * - optional parameter in xvid_encore() function | ||
| 310 : | * | ||
| 311 : | * .coding_type = XVID_TYPE_NOTHING if the stats are not given | ||
| 312 : | *--------------------------------------------------------------------------*/ | ||
| 313 : | suxen_drol | 1014 | |
| 314 : | edgomez | 1267 | typedef struct { |
| 315 : | int version; | ||
| 316 : | |||
| 317 : | /* encoding parameters */ | ||
| 318 : | int type; /* [out] coding type */ | ||
| 319 : | int quant; /* [out] frame quantizer */ | ||
| 320 : | int vol_flags; /* [out] vol flags (see above) */ | ||
| 321 : | int vop_flags; /* [out] vop flags (see above) */ | ||
| 322 : | |||
| 323 : | /* bitrate */ | ||
| 324 : | int length; /* [out] frame length */ | ||
| 325 : | |||
| 326 : | int hlength; /* [out] header length (bytes) */ | ||
| 327 : | int kblks; /* [out] number of blocks compressed as Intra */ | ||
| 328 : | int mblks; /* [out] number of blocks compressed as Inter */ | ||
| 329 : | int ublks; /* [out] number of blocks marked as not_coded */ | ||
| 330 : | |||
| 331 : | int sse_y; /* [out] Y plane's sse */ | ||
| 332 : | int sse_u; /* [out] U plane's sse */ | ||
| 333 : | int sse_v; /* [out] V plane's sse */ | ||
| 334 : | } xvid_enc_stats_t; | ||
| 335 : | |||
| 336 : | suxen_drol | 919 | /***************************************************************************** |
| 337 : | xvid plugin system -- internals | ||
| 338 : | edgomez | 199 | |
| 339 : | suxen_drol | 919 | xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE |
| 340 : | before encoding each frame xvidcore will call XVID_PLG_BEFORE | ||
| 341 : | after encoding each frame xvidcore will call XVID_PLG_AFTER | ||
| 342 : | xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY | ||
| 343 : | ****************************************************************************/ | ||
| 344 : | |||
| 345 : | suxen_drol | 1014 | |
| 346 : | edgomez | 1107 | #define XVID_PLG_CREATE (1<<0) |
| 347 : | #define XVID_PLG_DESTROY (1<<1) | ||
| 348 : | #define XVID_PLG_INFO (1<<2) | ||
| 349 : | #define XVID_PLG_BEFORE (1<<3) | ||
| 350 : | syskin | 1216 | #define XVID_PLG_FRAME (1<<4) |
| 351 : | #define XVID_PLG_AFTER (1<<5) | ||
| 352 : | suxen_drol | 919 | |
| 353 : | /* xvid_plg_info_t.flags */ | ||
| 354 : | edgomez | 1107 | #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
| 355 : | #define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ | ||
| 356 : | #define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ | ||
| 357 : | suxen_drol | 919 | |
| 358 : | |||
| 359 : | typedef struct | ||
| 360 : | { | ||
| 361 : | edgomez | 1107 | int version; |
| 362 : | int flags; /* [in:opt] plugin flags */ | ||
| 363 : | suxen_drol | 919 | } xvid_plg_info_t; |
| 364 : | |||
| 365 : | |||
| 366 : | typedef struct | ||
| 367 : | { | ||
| 368 : | edgomez | 1107 | int version; |
| 369 : | suxen_drol | 919 | |
| 370 : | edgomez | 1107 | int num_zones; /* [out] */ |
| 371 : | xvid_enc_zone_t * zones; /* [out] */ | ||
| 372 : | suxen_drol | 919 | |
| 373 : | edgomez | 1107 | int width; /* [out] */ |
| 374 : | int height; /* [out] */ | ||
| 375 : | int mb_width; /* [out] */ | ||
| 376 : | int mb_height; /* [out] */ | ||
| 377 : | int fincr; /* [out] */ | ||
| 378 : | int fbase; /* [out] */ | ||
| 379 : | suxen_drol | 1014 | |
| 380 : | edgomez | 1107 | void * param; /* [out] */ |
| 381 : | suxen_drol | 919 | } xvid_plg_create_t; |
| 382 : | |||
| 383 : | |||
| 384 : | typedef struct | ||
| 385 : | { | ||
| 386 : | edgomez | 1107 | int version; |
| 387 : | suxen_drol | 919 | |
| 388 : | edgomez | 1107 | int num_frames; /* [out] total frame encoded */ |
| 389 : | suxen_drol | 938 | } xvid_plg_destroy_t; |
| 390 : | |||
| 391 : | typedef struct | ||
| 392 : | { | ||
| 393 : | edgomez | 1107 | int version; |
| 394 : | suxen_drol | 938 | |
| 395 : | edgomez | 1107 | xvid_enc_zone_t * zone; /* [out] current zone */ |
| 396 : | edgomez | 1161 | |
| 397 : | edgomez | 1107 | int width; /* [out] */ |
| 398 : | int height; /* [out] */ | ||
| 399 : | int mb_width; /* [out] */ | ||
| 400 : | int mb_height; /* [out] */ | ||
| 401 : | suxen_drol | 920 | int fincr; /* [out] */ |
| 402 : | edgomez | 1107 | int fbase; /* [out] */ |
| 403 : | suxen_drol | 1014 | |
| 404 : | edgomez | 1107 | int min_quant[3]; /* [out] */ |
| 405 : | int max_quant[3]; /* [out] */ | ||
| 406 : | edgomez | 1161 | |
| 407 : | edgomez | 1107 | xvid_image_t reference; /* [out] -> [out] */ |
| 408 : | xvid_image_t current; /* [out] -> [in,out] */ | ||
| 409 : | xvid_image_t original; /* [out] after: points the original (uncompressed) copy of the current frame */ | ||
| 410 : | int frame_num; /* [out] frame number */ | ||
| 411 : | suxen_drol | 919 | |
| 412 : | edgomez | 1107 | int type; /* [in,out] */ |
| 413 : | int quant; /* [in,out] */ | ||
| 414 : | suxen_drol | 920 | |
| 415 : | edgomez | 1107 | int * dquant; /* [in,out] pointer to diff quantizer table */ |
| 416 : | int dquant_stride; /* [in,out] diff quantizer stride */ | ||
| 417 : | suxen_drol | 919 | |
| 418 : | edgomez | 1107 | int vop_flags; /* [in,out] */ |
| 419 : | int vol_flags; /* [in,out] */ | ||
| 420 : | int motion_flags; /* [in,out] */ | ||
| 421 : | suxen_drol | 919 | |
| 422 : | edgomez | 1267 | /* Deprecated, use the stats field instead. |
| 423 : | * Will disapear before 1.0 */ | ||
| 424 : | edgomez | 1107 | int length; /* [out] after: length of encoded frame */ |
| 425 : | int kblks; /* [out] number of blocks compressed as Intra */ | ||
| 426 : | int mblks; /* [out] number of blocks compressed as Inter */ | ||
| 427 : | int ublks; /* [out] number of blocks marked not_coded */ | ||
| 428 : | int sse_y; /* [out] Y plane's sse */ | ||
| 429 : | int sse_u; /* [out] U plane's sse */ | ||
| 430 : | int sse_v; /* [out] V plane's sse */ | ||
| 431 : | edgomez | 1267 | /* End of duplicated data, kept only for binary compatibility */ |
| 432 : | |||
| 433 : | edgomez | 1202 | int bquant_ratio; /* [in] */ |
| 434 : | int bquant_offset; /* [in] */ | ||
| 435 : | edgomez | 1267 | |
| 436 : | xvid_enc_stats_t stats; /* [out] frame statistics */ | ||
| 437 : | suxen_drol | 919 | } xvid_plg_data_t; |
| 438 : | |||
| 439 : | edgomez | 851 | /***************************************************************************** |
| 440 : | suxen_drol | 919 | xvid plugin system -- external |
| 441 : | |||
| 442 : | the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array | ||
| 443 : | indicates the plugin function pointer and plugin-specific data. | ||
| 444 : | xvidcore handles the rest. example: | ||
| 445 : | |||
| 446 : | xvid_enc_create_t create; | ||
| 447 : | xvid_enc_plugin_t plugins[2]; | ||
| 448 : | |||
| 449 : | plugins[0].func = xvid_psnr_func; | ||
| 450 : | plugins[0].param = NULL; | ||
| 451 : | plugins[1].func = xvid_cbr_func; | ||
| 452 : | plugins[1].param = &cbr_data; | ||
| 453 : | edgomez | 1161 | |
| 454 : | suxen_drol | 919 | create.num_plugins = 2; |
| 455 : | create.plugins = plugins; | ||
| 456 : | |||
| 457 : | ****************************************************************************/ | ||
| 458 : | |||
| 459 : | typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2); | ||
| 460 : | |||
| 461 : | typedef struct | ||
| 462 : | { | ||
| 463 : | edgomez | 1107 | xvid_plugin_func * func; |
| 464 : | void * param; | ||
| 465 : | suxen_drol | 919 | } xvid_enc_plugin_t; |
| 466 : | |||
| 467 : | suxen_drol | 938 | |
| 468 : | edgomez | 1267 | extern xvid_plugin_func xvid_plugin_single; /* single-pass rate control */ |
| 469 : | extern xvid_plugin_func xvid_plugin_2pass1; /* two-pass rate control: first pass */ | ||
| 470 : | extern xvid_plugin_func xvid_plugin_2pass2; /* two-pass rate control: second pass */ | ||
| 471 : | suxen_drol | 938 | |
| 472 : | edgomez | 1267 | extern xvid_plugin_func xvid_plugin_lumimasking; /* lumimasking */ |
| 473 : | suxen_drol | 938 | |
| 474 : | edgomez | 1267 | extern xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
| 475 : | extern xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ | ||
| 476 : | suxen_drol | 919 | |
| 477 : | |||
| 478 : | edgomez | 1107 | /* single pass rate control |
| 479 : | * CBR and Constant quantizer modes */ | ||
| 480 : | typedef struct | ||
| 481 : | suxen_drol | 938 | { |
| 482 : | edgomez | 1107 | int version; |
| 483 : | |||
| 484 : | int bitrate; /* [in] bits per second */ | ||
| 485 : | int reaction_delay_factor; /* [in] */ | ||
| 486 : | int averaging_period; /* [in] */ | ||
| 487 : | int buffer; /* [in] */ | ||
| 488 : | suxen_drol | 1014 | } xvid_plugin_single_t; |
| 489 : | suxen_drol | 938 | |
| 490 : | |||
| 491 : | typedef struct { | ||
| 492 : | edgomez | 1107 | int version; |
| 493 : | |||
| 494 : | char * filename; | ||
| 495 : | suxen_drol | 938 | } xvid_plugin_2pass1_t; |
| 496 : | |||
| 497 : | |||
| 498 : | edgomez | 1107 | #define XVID_PAYBACK_BIAS 0 /* payback with bias */ |
| 499 : | #define XVID_PAYBACK_PROP 1 /* payback proportionally */ | ||
| 500 : | suxen_drol | 938 | |
| 501 : | suxen_drol | 942 | typedef struct { |
| 502 : | edgomez | 1107 | int version; |
| 503 : | |||
| 504 : | int bitrate; /* [in] bits per second */ | ||
| 505 : | char * filename; /* [in] first pass stats filename */ | ||
| 506 : | edgomez | 1161 | |
| 507 : | edgomez | 1107 | int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
| 508 : | int curve_compression_high; /* [in] percentage of compression performed on the high part of the curve (above average) */ | ||
| 509 : | int curve_compression_low; /* [in] percentage of compression performed on the low part of the curve (below average) */ | ||
| 510 : | edgomez | 1202 | int overflow_control_strength;/* [in] Payback delay expressed in number of frames */ |
| 511 : | int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */ | ||
| 512 : | int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */ | ||
| 513 : | suxen_drol | 942 | |
| 514 : | edgomez | 1242 | int kfreduction; /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */ |
| 515 : | int kfthreshold; /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits | ||
| 516 : | * is substracted from its bit allocation. The reduction is computed as multiples of | ||
| 517 : | * kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold, | ||
| 518 : | * 0 for 1<distance<kfthreshold */ | ||
| 519 : | edgomez | 1041 | |
| 520 : | edgomez | 1107 | int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
| 521 : | chl | 1448 | |
| 522 : | #ifdef VBV | ||
| 523 : | int vbvsize; | ||
| 524 : | int vbvinitial; | ||
| 525 : | int vbv_maxrate; | ||
| 526 : | int vbv_peakrate; | ||
| 527 : | #endif | ||
| 528 : | |||
| 529 : | suxen_drol | 942 | }xvid_plugin_2pass2_t; |
| 530 : | |||
| 531 : | suxen_drol | 919 | /***************************************************************************** |
| 532 : | edgomez | 1267 | * ENCODER API |
| 533 : | edgomez | 851 | ****************************************************************************/ |
| 534 : | edgomez | 199 | |
| 535 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 536 : | * Encoder operations | ||
| 537 : | *--------------------------------------------------------------------------*/ | ||
| 538 : | |||
| 539 : | edgomez | 1107 | #define XVID_ENC_CREATE 0 /* create encoder instance; returns 0 on success */ |
| 540 : | #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */ | ||
| 541 : | #define XVID_ENC_ENCODE 2 /* encode a frame: returns number of ouput bytes | ||
| 542 : | * 0 means this frame should not be written (ie. encoder lag) */ | ||
| 543 : | edgomez | 199 | |
| 544 : | |||
| 545 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 546 : | * Encoder entry point | ||
| 547 : | *--------------------------------------------------------------------------*/ | ||
| 548 : | edgomez | 199 | |
| 549 : | edgomez | 1267 | extern int xvid_encore(void *handle, int opt, void *param1, void *param2); |
| 550 : | edgomez | 199 | |
| 551 : | edgomez | 1267 | /* Quick API reference |
| 552 : | * | ||
| 553 : | * XVID_ENC_CREATE operation | ||
| 554 : | * - handle: ignored | ||
| 555 : | * - opt: XVID_ENC_CREATE | ||
| 556 : | * - param1: address of a xvid_enc_create_t structure | ||
| 557 : | * - param2: ignored | ||
| 558 : | * | ||
| 559 : | * XVID_ENC_ENCODE operation | ||
| 560 : | * - handle: an instance returned by a CREATE op | ||
| 561 : | * - opt: XVID_ENC_ENCODE | ||
| 562 : | * - param1: address of a xvid_enc_frame_t structure | ||
| 563 : | * - param2: address of a xvid_enc_stats_t structure (optional) | ||
| 564 : | * its return value is asynchronous to what is written to the buffer | ||
| 565 : | * depending on the delay introduced by bvop use. It's display | ||
| 566 : | * ordered. | ||
| 567 : | * | ||
| 568 : | * XVID_ENC_DESTROY operation | ||
| 569 : | * - handle: an instance returned by a CREATE op | ||
| 570 : | * - opt: XVID_ENC_DESTROY | ||
| 571 : | * - param1: ignored | ||
| 572 : | * - param2: ignored | ||
| 573 : | */ | ||
| 574 : | |||
| 575 : | |||
| 576 : | /*---------------------------------------------------------------------------- | ||
| 577 : | * "Global" flags | ||
| 578 : | * | ||
| 579 : | * These flags are used for xvid_enc_create_t->global field during instance | ||
| 580 : | * creation (operation XVID_ENC_CREATE) | ||
| 581 : | *--------------------------------------------------------------------------*/ | ||
| 582 : | |||
| 583 : | edgomez | 1107 | #define XVID_GLOBAL_PACKED (1<<0) /* packed bitstream */ |
| 584 : | #define XVID_GLOBAL_CLOSED_GOP (1<<1) /* closed_gop: was DX50BVOP dx50 bvop compatibility */ | ||
| 585 : | #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2) | ||
| 586 : | #if 0 | ||
| 587 : | #define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ | ||
| 588 : | #define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ | ||
| 589 : | #endif | ||
| 590 : | edgomez | 199 | |
| 591 : | edgomez | 1107 | |
| 592 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 593 : | * "VOL" flags | ||
| 594 : | * | ||
| 595 : | * These flags are used for xvid_enc_frame_t->vol_flags field during frame | ||
| 596 : | * encoding (operation XVID_ENC_ENCODE) | ||
| 597 : | *--------------------------------------------------------------------------*/ | ||
| 598 : | |||
| 599 : | edgomez | 1107 | #define XVID_VOL_MPEGQUANT (1<<0) /* enable MPEG type quantization */ |
| 600 : | #define XVID_VOL_EXTRASTATS (1<<1) /* enable plane sse stats */ | ||
| 601 : | #define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ | ||
| 602 : | #define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ | ||
| 603 : | #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ | ||
| 604 : | #define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ | ||
| 605 : | edgomez | 199 | |
| 606 : | |||
| 607 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 608 : | * "VOP" flags | ||
| 609 : | * | ||
| 610 : | * These flags are used for xvid_enc_frame_t->vop_flags field during frame | ||
| 611 : | * encoding (operation XVID_ENC_ENCODE) | ||
| 612 : | *--------------------------------------------------------------------------*/ | ||
| 613 : | suxen_drol | 920 | |
| 614 : | edgomez | 1267 | /* Always valid */ |
| 615 : | #define XVID_VOP_DEBUG (1<< 0) /* print debug messages in frames */ | ||
| 616 : | #define XVID_VOP_HALFPEL (1<< 1) /* use halfpel interpolation */ | ||
| 617 : | #define XVID_VOP_INTER4V (1<< 2) /* use 4 motion vectors per MB */ | ||
| 618 : | #define XVID_VOP_TRELLISQUANT (1<< 3) /* use trellis based R-D "optimal" quantization */ | ||
| 619 : | #define XVID_VOP_CHROMAOPT (1<< 4) /* enable chroma optimization pre-filter */ | ||
| 620 : | #define XVID_VOP_CARTOON (1<< 5) /* use 'cartoon mode' */ | ||
| 621 : | #define XVID_VOP_GREYSCALE (1<< 6) /* enable greyscale only mode (even for color input material chroma is ignored) */ | ||
| 622 : | #define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ | ||
| 623 : | #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ | ||
| 624 : | #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */ | ||
| 625 : | |||
| 626 : | /* Only valid for vol_flags|=XVID_VOL_INTERLACING */ | ||
| 627 : | #define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ | ||
| 628 : | #define XVID_VOP_ALTERNATESCAN (1<<10) /* set alternate vertical scan flag */ | ||
| 629 : | |||
| 630 : | edgomez | 1107 | /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
| 631 : | edgomez | 1267 | #define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ |
| 632 : | chl | 993 | |
| 633 : | edgomez | 199 | |
| 634 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 635 : | * "Motion" flags | ||
| 636 : | * | ||
| 637 : | * These flags are used for xvid_enc_frame_t->motion field during frame | ||
| 638 : | * encoding (operation XVID_ENC_ENCODE) | ||
| 639 : | *--------------------------------------------------------------------------*/ | ||
| 640 : | edgomez | 199 | |
| 641 : | edgomez | 1267 | /* Motion Estimation Search Patterns */ |
| 642 : | edgomez | 1107 | #define XVID_ME_ADVANCEDDIAMOND16 (1<< 0) /* use advdiamonds instead of diamonds as search pattern */ |
| 643 : | #define XVID_ME_ADVANCEDDIAMOND8 (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */ | ||
| 644 : | #define XVID_ME_USESQUARES16 (1<< 2) /* use squares instead of diamonds as search pattern */ | ||
| 645 : | #define XVID_ME_USESQUARES8 (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */ | ||
| 646 : | edgomez | 1267 | |
| 647 : | /* SAD operator based flags */ | ||
| 648 : | edgomez | 1161 | #define XVID_ME_HALFPELREFINE16 (1<< 4) |
| 649 : | #define XVID_ME_HALFPELREFINE8 (1<< 6) | ||
| 650 : | #define XVID_ME_QUARTERPELREFINE16 (1<< 7) | ||
| 651 : | #define XVID_ME_QUARTERPELREFINE8 (1<< 8) | ||
| 652 : | #define XVID_ME_GME_REFINE (1<< 9) | ||
| 653 : | edgomez | 1107 | #define XVID_ME_EXTSEARCH16 (1<<10) /* extend PMV by more searches */ |
| 654 : | #define XVID_ME_EXTSEARCH8 (1<<11) /* use diamond/square for extended 8x8 search */ | ||
| 655 : | #define XVID_ME_CHROMA_PVOP (1<<12) /* also use chroma for P_VOP/S_VOP ME */ | ||
| 656 : | #define XVID_ME_CHROMA_BVOP (1<<13) /* also use chroma for B_VOP ME */ | ||
| 657 : | edgomez | 1308 | #define XVID_ME_FASTREFINE16 (1<<25) /* use low-complexity refinement functions */ |
| 658 : | Isibaar | 1281 | #define XVID_ME_FASTREFINE8 (1<<29) /* low-complexity 8x8 sub-block refinement */ |
| 659 : | Isibaar | 1095 | |
| 660 : | edgomez | 1267 | /* Rate Distortion based flags |
| 661 : | edgomez | 1308 | * Valid when XVID_VOP_MODEDECISION_RD is enabled */ |
| 662 : | syskin | 1150 | #define XVID_ME_HALFPELREFINE16_RD (1<<14) /* perform RD-based halfpel refinement */ |
| 663 : | #define XVID_ME_HALFPELREFINE8_RD (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */ | ||
| 664 : | #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */ | ||
| 665 : | #define XVID_ME_QUARTERPELREFINE8_RD (1<<17) /* perform RD-based qpel refinement for 8x8 mode */ | ||
| 666 : | #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 */ | ||
| 667 : | edgomez | 1107 | #define XVID_ME_CHECKPREDICTION_RD (1<<19) /* always check vector equal to prediction */ |
| 668 : | edgomez | 853 | |
| 669 : | edgomez | 1267 | /* Other */ |
| 670 : | #define XVID_ME_DETECT_STATIC_MOTION (1<<24) /* speed-up ME by detecting stationary scenes */ | ||
| 671 : | edgomez | 1276 | #define XVID_ME_SKIP_DELTASEARCH (1<<26) /* speed-up by skipping b-frame delta search */ |
| 672 : | Isibaar | 1274 | #define XVID_ME_FAST_MODEINTERPOLATE (1<<27) /* speed-up by partly skipping interpolate mode */ |
| 673 : | edgomez | 1276 | #define XVID_ME_BFRAME_EARLYSTOP (1<<28) /* speed-up by early exiting b-search */ |
| 674 : | Isibaar | 1275 | |
| 675 : | edgomez | 1267 | /* Unused */ |
| 676 : | edgomez | 1107 | #define XVID_ME_UNRESTRICTED16 (1<<20) /* unrestricted ME, not implemented */ |
| 677 : | #define XVID_ME_OVERLAPPING16 (1<<21) /* overlapping ME, not implemented */ | ||
| 678 : | #define XVID_ME_UNRESTRICTED8 (1<<22) /* unrestricted ME, not implemented */ | ||
| 679 : | #define XVID_ME_OVERLAPPING8 (1<<23) /* overlapping ME, not implemented */ | ||
| 680 : | edgomez | 199 | |
| 681 : | chl | 352 | |
| 682 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 683 : | * xvid_enc_create_t structure definition | ||
| 684 : | * | ||
| 685 : | * This structure is passed as param1 during an instance creation (operation | ||
| 686 : | * XVID_ENC_CREATE) | ||
| 687 : | *--------------------------------------------------------------------------*/ | ||
| 688 : | |||
| 689 : | suxen_drol | 890 | typedef struct { |
| 690 : | int version; | ||
| 691 : | suxen_drol | 1014 | |
| 692 : | edgomez | 1107 | int profile; /* [in] profile@level; refer to XVID_PROFILE_xxx */ |
| 693 : | int width; /* [in] frame dimensions; width, pixel units */ | ||
| 694 : | int height; /* [in] frame dimensions; height, pixel units */ | ||
| 695 : | edgomez | 851 | |
| 696 : | edgomez | 1107 | int num_zones; /* [in:opt] number of bitrate zones */ |
| 697 : | xvid_enc_zone_t * zones; /* ^^ zone array */ | ||
| 698 : | suxen_drol | 1014 | |
| 699 : | edgomez | 1107 | int num_plugins; /* [in:opt] number of plugins */ |
| 700 : | xvid_enc_plugin_t * plugins; /* ^^ plugin array */ | ||
| 701 : | suxen_drol | 919 | |
| 702 : | edgomez | 1107 | int num_threads; /* [in:opt] number of threads */ |
| 703 : | int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ | ||
| 704 : | edgomez | 851 | |
| 705 : | edgomez | 1107 | int global; /* [in:opt] global flags; controls encoding behavior */ |
| 706 : | edgomez | 851 | |
| 707 : | edgomez | 1107 | /* --- vol-based stuff; included here for convenience */ |
| 708 : | int fincr; /* [in:opt] framerate increment; set to zero for variable framerate */ | ||
| 709 : | int fbase; /* [in] framerate base frame_duration = fincr/fbase seconds*/ | ||
| 710 : | /* ---------------------------------------------- */ | ||
| 711 : | edgomez | 851 | |
| 712 : | edgomez | 1107 | /* --- vop-based; included here for convenience */ |
| 713 : | int max_key_interval; /* [in:opt] the maximum interval between key frames */ | ||
| 714 : | edgomez | 851 | |
| 715 : | edgomez | 1107 | int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none... 100=drop all */ |
| 716 : | edgomez | 851 | |
| 717 : | edgomez | 1107 | int bquant_ratio; /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */ |
| 718 : | int bquant_offset; /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */ | ||
| 719 : | edgomez | 851 | |
| 720 : | edgomez | 1107 | int min_quant[3]; /* [in:opt] */ |
| 721 : | int max_quant[3]; /* [in:opt] */ | ||
| 722 : | /* ---------------------------------------------- */ | ||
| 723 : | edgomez | 851 | |
| 724 : | edgomez | 1107 | void *handle; /* [out] encoder instance handle */ |
| 725 : | edgomez | 1267 | } xvid_enc_create_t; |
| 726 : | edgomez | 851 | |
| 727 : | |||
| 728 : | edgomez | 1267 | /*---------------------------------------------------------------------------- |
| 729 : | * xvid_enc_frame_t structure definition | ||
| 730 : | * | ||
| 731 : | * This structure is passed as param1 during a frame encoding (operation | ||
| 732 : | * XVID_ENC_ENCODE) | ||
| 733 : | *--------------------------------------------------------------------------*/ | ||
| 734 : | |||
| 735 : | /* out value for the frame structure->type field | ||
| 736 : | * unlike stats output in param2, this field is not asynchronous and tells | ||
| 737 : | * the client app, if the frame written into the stream buffer is an ivop | ||
| 738 : | * usually used for indexing purpose in the container */ | ||
| 739 : | edgomez | 1107 | #define XVID_KEYFRAME (1<<1) |
| 740 : | edgomez | 199 | |
| 741 : | edgomez | 1267 | /* The structure */ |
| 742 : | suxen_drol | 890 | typedef struct { |
| 743 : | int version; | ||
| 744 : | edgomez | 199 | |
| 745 : | edgomez | 1267 | /* VOL related stuff |
| 746 : | * unless XVID_FORCEVOL is set, the encoder will not react to any changes | ||
| 747 : | * here until the next VOL (keyframe). */ | ||
| 748 : | |||
| 749 : | edgomez | 1107 | int vol_flags; /* [in] vol flags */ |
| 750 : | unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */ | ||
| 751 : | unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */ | ||
| 752 : | edgomez | 199 | |
| 753 : | chl | 1243 | int par; /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */ |
| 754 : | edgomez | 1107 | int par_width; /* [in:opt] aspect ratio width */ |
| 755 : | int par_height; /* [in:opt] aspect ratio height */ | ||
| 756 : | edgomez | 199 | |
| 757 : | edgomez | 1267 | /* Other fields that can change on a frame base */ |
| 758 : | |||
| 759 : | edgomez | 1107 | int fincr; /* [in:opt] framerate increment, for variable framerate only */ |
| 760 : | int vop_flags; /* [in] (general)vop-based flags */ | ||
| 761 : | int motion; /* [in] ME options */ | ||
| 762 : | edgomez | 851 | |
| 763 : | edgomez | 1107 | xvid_image_t input; /* [in] input image (read from) */ |
| 764 : | edgomez | 1161 | |
| 765 : | edgomez | 1107 | int type; /* [in:opt] coding type */ |
| 766 : | int quant; /* [in] frame quantizer; if <=0, automatic (ratecontrol) */ | ||
| 767 : | edgomez | 953 | int bframe_threshold; |
| 768 : | edgomez | 851 | |
| 769 : | edgomez | 1107 | void *bitstream; /* [in:opt] bitstream ptr (written to)*/ |
| 770 : | int length; /* [in:opt] bitstream length (bytes) */ | ||
| 771 : | edgomez | 851 | |
| 772 : | edgomez | 1107 | int out_flags; /* [out] bitstream output flags */ |
| 773 : | } xvid_enc_frame_t; | ||
| 774 : | edgomez | 199 | |
| 775 : | #ifdef __cplusplus | ||
| 776 : | } | ||
| 777 : | #endif | ||
| 778 : | |||
| 779 : | #endif |
| No admin address has been configured | ViewVC Help |
| Powered by ViewVC 1.0.4 |