Parent Directory
| 
Revision Log
Revision 752 - (view) (download)
| 1 : | edgomez | 199 | /***************************************************************************** |
| 2 : | * | ||
| 3 : | * XVID MPEG-4 VIDEO CODEC | ||
| 4 : | * - XviD Main header file - | ||
| 5 : | * | ||
| 6 : | * This program is free software ; you can redistribute it and/or modify | ||
| 7 : | * it under the terms of the GNU General Public License as published by | ||
| 8 : | * the Free Software Foundation ; either version 2 of the License, or | ||
| 9 : | * (at your option) any later version. | ||
| 10 : | * | ||
| 11 : | * This program is distributed in the hope that it will be useful, | ||
| 12 : | * but WITHOUT ANY WARRANTY ; without even the implied warranty of | ||
| 13 : | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 14 : | * GNU General Public License for more details. | ||
| 15 : | * | ||
| 16 : | * You should have received a copy of the GNU General Public License | ||
| 17 : | * along with this program ; if not, write to the Free Software | ||
| 18 : | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | ||
| 19 : | * | ||
| 20 : | *****************************************************************************/ | ||
| 21 : | /***************************************************************************** | ||
| 22 : | * | ||
| 23 : | * History | ||
| 24 : | * | ||
| 25 : | * - 2002/06/13 Added legal header, ANSI C comment style (only for this header | ||
| 26 : | * as it can be included in a ANSI C project). | ||
| 27 : | * | ||
| 28 : | * ToDo ? : when BFRAMES is defined, the API_VERSION should not | ||
| 29 : | * be the same (3.0 ?) | ||
| 30 : | * | ||
| 31 : | suxen_drol | 752 | * $Id: xvid.h,v 1.17.2.18 2002-12-30 10:49:17 suxen_drol Exp $ |
| 32 : | edgomez | 199 | * |
| 33 : | *****************************************************************************/ | ||
| 34 : | |||
| 35 : | |||
| 36 : | #ifndef _XVID_H_ | ||
| 37 : | #define _XVID_H_ | ||
| 38 : | |||
| 39 : | #ifdef __cplusplus | ||
| 40 : | chl | 352 | extern "C" { |
| 41 : | edgomez | 199 | #endif |
| 42 : | |||
| 43 : | /***************************************************************************** | ||
| 44 : | * Global constants | ||
| 45 : | ****************************************************************************/ | ||
| 46 : | |||
| 47 : | /* API Version : 2.1 */ | ||
| 48 : | #define API_VERSION ((2 << 16) | (1)) | ||
| 49 : | suxen_drol | 725 | #define XVID_API_UNSTABLE |
| 50 : | edgomez | 199 | |
| 51 : | Isibaar | 602 | /* Bitstream Version |
| 52 : | * this will be writen into the bitstream to allow easy detection of xvid | ||
| 53 : | * encoder bugs in the decoder, without this it might not possible to | ||
| 54 : | * automatically distinquish between a file which has been encoded with an | ||
| 55 : | * old & buggy XVID from a file which has been encoded with a bugfree version | ||
| 56 : | * see the infamous interlacing bug ... | ||
| 57 : | * | ||
| 58 : | * this MUST be increased if an encoder bug is fixed, increasing it too often | ||
| 59 : | * doesnt hurt but not increasing it could cause difficulty for decoders in the | ||
| 60 : | * future | ||
| 61 : | */ | ||
| 62 : | Isibaar | 617 | #define XVID_BS_VERSION "0003" |
| 63 : | edgomez | 199 | |
| 64 : | Isibaar | 602 | |
| 65 : | edgomez | 199 | /* Error codes */ |
| 66 : | #define XVID_ERR_FAIL -1 | ||
| 67 : | #define XVID_ERR_OK 0 | ||
| 68 : | #define XVID_ERR_MEMORY 1 | ||
| 69 : | #define XVID_ERR_FORMAT 2 | ||
| 70 : | |||
| 71 : | |||
| 72 : | /* Colorspaces */ | ||
| 73 : | suxen_drol | 582 | #define XVID_CSP_RGB24 0 /* [b|g|r] */ |
| 74 : | edgomez | 199 | #define XVID_CSP_YV12 1 |
| 75 : | #define XVID_CSP_YUY2 2 | ||
| 76 : | #define XVID_CSP_UYVY 3 | ||
| 77 : | #define XVID_CSP_I420 4 | ||
| 78 : | #define XVID_CSP_RGB555 10 | ||
| 79 : | #define XVID_CSP_RGB565 11 | ||
| 80 : | #define XVID_CSP_USER 12 | ||
| 81 : | #define XVID_CSP_EXTERN 1004 // per slice rendering | ||
| 82 : | #define XVID_CSP_YVYU 1002 | ||
| 83 : | suxen_drol | 582 | #define XVID_CSP_RGB32 1000 /* [b|g|r|a] */ |
| 84 : | #define XVID_CSP_ABGR 1006 /* [a|b|g|r] */ | ||
| 85 : | #define XVID_CSP_RGBA 1005 /* [r|g|b|a] */ | ||
| 86 : | |||
| 87 : | |||
| 88 : | |||
| 89 : | edgomez | 199 | #define XVID_CSP_NULL 9999 |
| 90 : | |||
| 91 : | #define XVID_CSP_VFLIP 0x80000000 // flip mask | ||
| 92 : | |||
| 93 : | |||
| 94 : | /***************************************************************************** | ||
| 95 : | albeu | 315 | * Initialization constants |
| 96 : | edgomez | 199 | ****************************************************************************/ |
| 97 : | |||
| 98 : | /* CPU flags for XVID_INIT_PARAM.cpu_flags */ | ||
| 99 : | |||
| 100 : | #define XVID_CPU_MMX 0x00000001 | ||
| 101 : | #define XVID_CPU_MMXEXT 0x00000002 | ||
| 102 : | #define XVID_CPU_SSE 0x00000004 | ||
| 103 : | #define XVID_CPU_SSE2 0x00000008 | ||
| 104 : | #define XVID_CPU_3DNOW 0x00000010 | ||
| 105 : | #define XVID_CPU_3DNOWEXT 0x00000020 | ||
| 106 : | |||
| 107 : | #define XVID_CPU_TSC 0x00000040 | ||
| 108 : | Isibaar | 209 | |
| 109 : | edgomez | 199 | #define XVID_CPU_IA64 0x00000080 |
| 110 : | |||
| 111 : | #define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */ | ||
| 112 : | #define XVID_CPU_FORCE 0x80000000 | ||
| 113 : | |||
| 114 : | suxen_drol | 634 | typedef struct |
| 115 : | { | ||
| 116 : | int colorspace; | ||
| 117 : | void * y; | ||
| 118 : | void * u; | ||
| 119 : | void * v; | ||
| 120 : | int y_stride; | ||
| 121 : | int uv_stride; | ||
| 122 : | } XVID_IMAGE; /* from yv12 */ | ||
| 123 : | edgomez | 199 | |
| 124 : | suxen_drol | 634 | #define XVID_INIT_INIT 0 |
| 125 : | #define XVID_INIT_CONVERT 1 | ||
| 126 : | suxen_drol | 752 | #define XVID_INIT_TEST 2 |
| 127 : | suxen_drol | 634 | |
| 128 : | Isibaar | 209 | /***************************************************************************** |
| 129 : | edgomez | 199 | * Initialization structures |
| 130 : | Isibaar | 209 | ****************************************************************************/ |
| 131 : | |||
| 132 : | typedef struct | ||
| 133 : | suxen_drol | 234 | { |
| 134 : | edgomez | 199 | int cpu_flags; |
| 135 : | int api_version; | ||
| 136 : | int core_build; | ||
| 137 : | } | ||
| 138 : | XVID_INIT_PARAM; | ||
| 139 : | |||
| 140 : | suxen_drol | 634 | typedef struct |
| 141 : | { | ||
| 142 : | XVID_IMAGE input; | ||
| 143 : | XVID_IMAGE output; | ||
| 144 : | int width; | ||
| 145 : | int height; | ||
| 146 : | int interlacing; | ||
| 147 : | } XVID_INIT_CONVERTINFO; | ||
| 148 : | |||
| 149 : | edgomez | 199 | /***************************************************************************** |
| 150 : | * Initialization entry point | ||
| 151 : | ****************************************************************************/ | ||
| 152 : | |||
| 153 : | int xvid_init(void *handle, | ||
| 154 : | int opt, | ||
| 155 : | void *param1, | ||
| 156 : | void *param2); | ||
| 157 : | |||
| 158 : | |||
| 159 : | /***************************************************************************** | ||
| 160 : | * Decoder constants | ||
| 161 : | ****************************************************************************/ | ||
| 162 : | |||
| 163 : | /* Flags for XVID_DEC_FRAME.general */ | ||
| 164 : | suxen_drol | 707 | #define XVID_DEC_LOWDELAY 0x00000001 /* decode lowdelay mode (ie. video-for-windows) */ |
| 165 : | suxen_drol | 715 | #define XVID_DEC_DEBLOCKY 0x00000002 /* luma deblocking */ |
| 166 : | suxen_drol | 747 | #define XVID_DEC_DEBLOCKUV 0x00000008 /* chroma deblocking */ |
| 167 : | suxen_drol | 725 | #define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream; instructs |
| 168 : | decoder to ignore any previous reference frames */ | ||
| 169 : | edgomez | 199 | #define XVID_QUICK_DECODE 0x00000010 |
| 170 : | |||
| 171 : | /***************************************************************************** | ||
| 172 : | * Decoder structures | ||
| 173 : | ****************************************************************************/ | ||
| 174 : | |||
| 175 : | typedef struct | ||
| 176 : | { | ||
| 177 : | int width; | ||
| 178 : | int height; | ||
| 179 : | void *handle; | ||
| 180 : | } | ||
| 181 : | XVID_DEC_PARAM; | ||
| 182 : | |||
| 183 : | |||
| 184 : | suxen_drol | 631 | #define XVID_DEC_VOP 0 |
| 185 : | #define XVID_DEC_VOL 1 | ||
| 186 : | suxen_drol | 707 | #define XVID_DEC_NOTHING 2 /* nothing was decoded */ |
| 187 : | suxen_drol | 631 | |
| 188 : | edgomez | 199 | typedef struct |
| 189 : | { | ||
| 190 : | suxen_drol | 631 | int notify; /* [out] output 'mode' */ |
| 191 : | union | ||
| 192 : | { | ||
| 193 : | struct /* XVID_DEC_VOP */ | ||
| 194 : | { | ||
| 195 : | int time_base; /* [out] time base */ | ||
| 196 : | int time_increment; /* [out] time increment */ | ||
| 197 : | } vop; | ||
| 198 : | struct /* XVID_DEC_VOL */ | ||
| 199 : | { | ||
| 200 : | int general; /* [out] flags: eg. frames are interlaced */ | ||
| 201 : | int width; /* [out] width */ | ||
| 202 : | int height; /* [out] height */ | ||
| 203 : | int aspect_ratio; /* [out] aspect ratio */ | ||
| 204 : | int par_width; /* [out] aspect ratio width */ | ||
| 205 : | int par_height; /* [out] aspect ratio height */ | ||
| 206 : | } vol; | ||
| 207 : | } data; | ||
| 208 : | } XVID_DEC_STATS; | ||
| 209 : | |||
| 210 : | |||
| 211 : | typedef struct | ||
| 212 : | { | ||
| 213 : | edgomez | 199 | int general; |
| 214 : | void *bitstream; | ||
| 215 : | int length; | ||
| 216 : | |||
| 217 : | void *image; | ||
| 218 : | int stride; | ||
| 219 : | int colorspace; | ||
| 220 : | } | ||
| 221 : | XVID_DEC_FRAME; | ||
| 222 : | |||
| 223 : | |||
| 224 : | // This struct is used for per slice rendering | ||
| 225 : | typedef struct | ||
| 226 : | { | ||
| 227 : | void *y,*u,*v; | ||
| 228 : | int stride_y, stride_u,stride_v; | ||
| 229 : | } XVID_DEC_PICTURE; | ||
| 230 : | |||
| 231 : | albeu | 315 | |
| 232 : | /***************************************************************************** | ||
| 233 : | * Decoder entry point | ||
| 234 : | ****************************************************************************/ | ||
| 235 : | |||
| 236 : | /* decoder options */ | ||
| 237 : | #define XVID_DEC_DECODE 0 | ||
| 238 : | #define XVID_DEC_CREATE 1 | ||
| 239 : | edgomez | 199 | #define XVID_DEC_DESTROY 2 |
| 240 : | |||
| 241 : | int xvid_decore(void *handle, | ||
| 242 : | int opt, | ||
| 243 : | void *param1, | ||
| 244 : | void *param2); | ||
| 245 : | |||
| 246 : | |||
| 247 : | /***************************************************************************** | ||
| 248 : | * Encoder constants | ||
| 249 : | ****************************************************************************/ | ||
| 250 : | |||
| 251 : | /* Flags for XVID_ENC_PARAM.global */ | ||
| 252 : | #define XVID_GLOBAL_PACKED 0x00000001 /* packed bitstream */ | ||
| 253 : | #define XVID_GLOBAL_DX50BVOP 0x00000002 /* dx50 bvop compatibility */ | ||
| 254 : | #define XVID_GLOBAL_DEBUG 0x00000004 /* print debug info on each frame */ | ||
| 255 : | suxen_drol | 701 | #define XVID_GLOBAL_REDUCED 0x04000000 /* reduced resolution vop enable */ |
| 256 : | edgomez | 199 | |
| 257 : | /* Flags for XVID_ENC_FRAME.general */ | ||
| 258 : | #define XVID_VALID_FLAGS 0x80000000 | ||
| 259 : | |||
| 260 : | #define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */ | ||
| 261 : | suxen_drol | 234 | #define XVID_H263QUANT 0x00000010 |
| 262 : | #define XVID_MPEGQUANT 0x00000020 | ||
| 263 : | #define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */ | ||
| 264 : | Isibaar | 579 | #define XVID_QUARTERPEL 0x02000000 |
| 265 : | suxen_drol | 234 | #define XVID_ADAPTIVEQUANT 0x00000080 |
| 266 : | #define XVID_LUMIMASKING 0x00000100 | ||
| 267 : | edgomez | 199 | #define XVID_LATEINTRA 0x00000200 |
| 268 : | |||
| 269 : | #define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */ | ||
| 270 : | #define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */ | ||
| 271 : | #define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag */ | ||
| 272 : | |||
| 273 : | #define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st pass) */ | ||
| 274 : | #define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd pass) */ | ||
| 275 : | |||
| 276 : | #define XVID_INTER4V 0x00008000 | ||
| 277 : | |||
| 278 : | #define XVID_ME_ZERO 0x00010000 | ||
| 279 : | #define XVID_ME_LOGARITHMIC 0x00020000 | ||
| 280 : | #define XVID_ME_FULLSEARCH 0x00040000 | ||
| 281 : | #define XVID_ME_PMVFAST 0x00080000 | ||
| 282 : | #define XVID_ME_EPZS 0x00100000 | ||
| 283 : | |||
| 284 : | #define XVID_GREYSCALE 0x01000000 /* enable greyscale only mode (even for */ | ||
| 285 : | Isibaar | 579 | #define XVID_GRAYSCALE 0x01000000 /* color input material chroma is ignored) */ |
| 286 : | edgomez | 199 | |
| 287 : | syskin | 627 | #define XVID_GMC 0x20000000 |
| 288 : | #define XVID_ME_COLOUR 0x40000000 | ||
| 289 : | edgomez | 199 | |
| 290 : | suxen_drol | 701 | #define XVID_REDUCED 0x04000000 /* reduced resolution vop */ |
| 291 : | |||
| 292 : | edgomez | 199 | /* Flags for XVID_ENC_FRAME.motion */ |
| 293 : | #define PMV_ADVANCEDDIAMOND8 0x00004000 | ||
| 294 : | #define PMV_ADVANCEDDIAMOND16 0x00008000 | ||
| 295 : | chl | 352 | |
| 296 : | #define PMV_HALFPELDIAMOND16 0x00010000 | ||
| 297 : | #define PMV_HALFPELREFINE16 0x00020000 | ||
| 298 : | Isibaar | 579 | #define PMV_QUARTERPELREFINE16 0x00040000 |
| 299 : | #define PMV_EXTSEARCH16 0x00080000 /* extend PMV by more searches */ | ||
| 300 : | edgomez | 199 | #define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more refinement */ |
| 301 : | #define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented */ | ||
| 302 : | #define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented */ | ||
| 303 : | #define PMV_USESQUARES16 0x00800000 | ||
| 304 : | |||
| 305 : | #define PMV_HALFPELDIAMOND8 0x01000000 | ||
| 306 : | #define PMV_HALFPELREFINE8 0x02000000 | ||
| 307 : | Isibaar | 579 | #define PMV_QUARTERPELREFINE8 0x04000000 |
| 308 : | #define PMV_EXTSEARCH8 0x08000000 /* extend PMV by more searches */ | ||
| 309 : | edgomez | 199 | #define PMV_QUICKSTOP8 0x10000000 /* like early, but without any more refinement */ |
| 310 : | #define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented */ | ||
| 311 : | #define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented */ | ||
| 312 : | #define PMV_USESQUARES8 0x80000000 | ||
| 313 : | |||
| 314 : | |||
| 315 : | syskin | 627 | |
| 316 : | edgomez | 199 | /***************************************************************************** |
| 317 : | * Encoder structures | ||
| 318 : | ****************************************************************************/ | ||
| 319 : | |||
| 320 : | typedef struct | ||
| 321 : | { | ||
| 322 : | int width, height; | ||
| 323 : | int fincr, fbase; /* frame increment, fbase. each frame = "fincr/fbase" seconds */ | ||
| 324 : | int rc_bitrate; /* the bitrate of the target encoded stream, in bits/second */ | ||
| 325 : | int rc_reaction_delay_factor; /* how fast the rate control reacts - lower values are faster */ | ||
| 326 : | int rc_averaging_period; /* as above */ | ||
| 327 : | int rc_buffer; /* as above */ | ||
| 328 : | int max_quantizer; /* the upper limit of the quantizer */ | ||
| 329 : | int min_quantizer; /* the lower limit of the quantizer */ | ||
| 330 : | int max_key_interval; /* the maximum interval between key frames */ | ||
| 331 : | #ifdef _SMP | ||
| 332 : | int num_threads; /* number of threads */ | ||
| 333 : | #endif | ||
| 334 : | int global; /* global/debug options */ | ||
| 335 : | int max_bframes; /* max sequential bframes (0=disable bframes) */ | ||
| 336 : | int bquant_ratio; /* bframe quantizer multipier (percentage). | ||
| 337 : | * used only when bquant < 1 | ||
| 338 : | * eg. 200 = x2 multiplier | ||
| 339 : | suxen_drol | 295 | * quant = ((past_quant + future_quant) * bquant_ratio)/200 |
| 340 : | */ | ||
| 341 : | suxen_drol | 659 | int bquant_offset; /* bquant += bquant_offset */ |
| 342 : | suxen_drol | 295 | int frame_drop_ratio; /* frame dropping: 0=drop none... 100=drop all */ |
| 343 : | suxen_drol | 234 | void *handle; /* [out] encoder instance handle */ |
| 344 : | edgomez | 199 | } |
| 345 : | XVID_ENC_PARAM; | ||
| 346 : | |||
| 347 : | typedef struct | ||
| 348 : | { | ||
| 349 : | int x; | ||
| 350 : | suxen_drol | 324 | int y; |
| 351 : | edgomez | 199 | } |
| 352 : | VECTOR; | ||
| 353 : | |||
| 354 : | typedef struct | ||
| 355 : | { | ||
| 356 : | int mode; /* macroblock mode */ | ||
| 357 : | VECTOR mvs[4]; | ||
| 358 : | } | ||
| 359 : | MVBLOCKHINT; | ||
| 360 : | |||
| 361 : | typedef struct | ||
| 362 : | { | ||
| 363 : | int intra; /* frame intra choice */ | ||
| 364 : | int fcode; /* frame fcode */ | ||
| 365 : | MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */ | ||
| 366 : | } | ||
| 367 : | MVFRAMEHINT; | ||
| 368 : | |||
| 369 : | typedef struct | ||
| 370 : | { | ||
| 371 : | int rawhints; /* if set, use MVFRAMEHINT, else use compressed buffer */ | ||
| 372 : | |||
| 373 : | MVFRAMEHINT mvhint; | ||
| 374 : | void *hintstream; /* compressed hint buffer */ | ||
| 375 : | int hintlength; /* length of buffer (bytes) */ | ||
| 376 : | } | ||
| 377 : | HINTINFO; | ||
| 378 : | |||
| 379 : | typedef struct | ||
| 380 : | { | ||
| 381 : | int general; /* [in] general options */ | ||
| 382 : | int motion; /* [in] ME options */ | ||
| 383 : | void *bitstream; /* [in] bitstream ptr */ | ||
| 384 : | int length; /* [out] bitstream length (bytes) */ | ||
| 385 : | |||
| 386 : | void *image; /* [in] image ptr */ | ||
| 387 : | suxen_drol | 631 | int stride; |
| 388 : | edgomez | 199 | int colorspace; /* [in] source colorspace */ |
| 389 : | |||
| 390 : | unsigned char *quant_intra_matrix; // [in] custom intra qmatrix */ | ||
| 391 : | unsigned char *quant_inter_matrix; // [in] custom inter qmatrix */ | ||
| 392 : | int quant; /* [in] frame quantizer (vbr) */ | ||
| 393 : | int intra; /* [in] force intra frame (vbr only) | ||
| 394 : | * [out] intra state | ||
| 395 : | */ | ||
| 396 : | HINTINFO hint; /* [in/out] mv hint information */ | ||
| 397 : | |||
| 398 : | int bquant; /* [in] bframe quantizer */ | ||
| 399 : | |||
| 400 : | } | ||
| 401 : | XVID_ENC_FRAME; | ||
| 402 : | |||
| 403 : | |||
| 404 : | typedef struct | ||
| 405 : | { | ||
| 406 : | int quant; /* [out] frame quantizer */ | ||
| 407 : | int hlength; /* [out] header length (bytes) */ | ||
| 408 : | int kblks, mblks, ublks; /* [out] */ | ||
| 409 : | } | ||
| 410 : | XVID_ENC_STATS; | ||
| 411 : | |||
| 412 : | |||
| 413 : | /***************************************************************************** | ||
| 414 : | * Encoder entry point | ||
| 415 : | ****************************************************************************/ | ||
| 416 : | |||
| 417 : | /* Encoder options */ | ||
| 418 : | #define XVID_ENC_ENCODE 0 | ||
| 419 : | #define XVID_ENC_CREATE 1 | ||
| 420 : | #define XVID_ENC_DESTROY 2 | ||
| 421 : | |||
| 422 : | int xvid_encore(void *handle, | ||
| 423 : | int opt, | ||
| 424 : | void *param1, | ||
| 425 : | void *param2); | ||
| 426 : | |||
| 427 : | |||
| 428 : | #ifdef __cplusplus | ||
| 429 : | } | ||
| 430 : | #endif | ||
| 431 : | |||
| 432 : | #endif |
| No admin address has been configured | ViewVC Help |
| Powered by ViewVC 1.0.4 |