1 |
/***************************************************************************** |
/***************************************************************************** |
2 |
* |
* |
3 |
* XVID MPEG-4 VIDEO CODEC |
* XVID MPEG-4 VIDEO CODEC |
4 |
* - XviD Main header file - |
* - Xvid Main header file - |
5 |
* |
* |
6 |
* Copyright(C) 2001-2004 Peter Ross <pross@xvid.org> |
* 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.58 2006-11-01 10:04:29 Isibaar Exp $ |
* $Id$ |
23 |
* |
* |
24 |
****************************************************************************/ |
****************************************************************************/ |
25 |
|
|
57 |
#define XVID_API_MAJOR(a) (((a)>>16) & 0xff) |
#define XVID_API_MAJOR(a) (((a)>>16) & 0xff) |
58 |
#define XVID_API_MINOR(a) (((a)>> 0) & 0xff) |
#define XVID_API_MINOR(a) (((a)>> 0) & 0xff) |
59 |
|
|
60 |
#define XVID_VERSION XVID_MAKE_VERSION(1,2,-127) |
#define XVID_VERSION XVID_MAKE_VERSION(1,4,-127) |
61 |
#define XVID_API XVID_MAKE_API(4, 1) |
#define XVID_API XVID_MAKE_API(4, 4) |
62 |
|
|
63 |
#define XVID_UNSTABLE |
#define XVID_UNSTABLE |
64 |
|
|
73 |
* 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 |
74 |
* future |
* future |
75 |
*/ |
*/ |
76 |
#define XVID_BS_VERSION 47 |
#define XVID_BS_VERSION 72 |
77 |
|
|
78 |
/***************************************************************************** |
/***************************************************************************** |
79 |
* error codes |
* error codes |
102 |
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
103 |
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
104 |
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
105 |
|
#define XVID_CSP_RGB (1<<16) /* 24-bit rgb packed */ |
106 |
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
107 |
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
108 |
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
129 |
#define XVID_PROFILE_S_L1 0x01 |
#define XVID_PROFILE_S_L1 0x01 |
130 |
#define XVID_PROFILE_S_L2 0x02 |
#define XVID_PROFILE_S_L2 0x02 |
131 |
#define XVID_PROFILE_S_L3 0x03 |
#define XVID_PROFILE_S_L3 0x03 |
132 |
|
#define XVID_PROFILE_S_L4a 0x04 |
133 |
|
#define XVID_PROFILE_S_L5 0x05 |
134 |
|
#define XVID_PROFILE_S_L6 0x06 |
135 |
#define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ |
#define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ |
136 |
#define XVID_PROFILE_ARTS_L2 0x92 |
#define XVID_PROFILE_ARTS_L2 0x92 |
137 |
#define XVID_PROFILE_ARTS_L3 0x93 |
#define XVID_PROFILE_ARTS_L3 0x93 |
173 |
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
174 |
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
175 |
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
176 |
|
#define XVID_CPU_SSE3 (1<< 8) /* sse3 : pentium4, athlon64 */ |
177 |
|
#define XVID_CPU_SSE41 (1<< 9) /* sse41: penryn */ |
178 |
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
179 |
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
180 |
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
239 |
extern int xvid_decore(void *handle, int opt, void *param1, void *param2); |
extern int xvid_decore(void *handle, int opt, void *param1, void *param2); |
240 |
|
|
241 |
/* XVID_DEC_CREATE param 1 |
/* XVID_DEC_CREATE param 1 |
242 |
image width & height may be specified here when the dimensions are |
image width & height as well as FourCC code may be specified |
243 |
known in advance. */ |
here when known in advance (e.g. being read from container) */ |
244 |
typedef struct { |
typedef struct { |
245 |
int version; |
int version; |
246 |
int width; /* [in:opt] image width */ |
int width; /* [in:opt] image width */ |
247 |
int height; /* [in:opt] image width */ |
int height; /* [in:opt] image width */ |
248 |
void * handle; /* [out] decore context handle */ |
void * handle; /* [out] decore context handle */ |
249 |
|
/* ------- v1.3.x ------- */ |
250 |
|
int fourcc; /* [in:opt] fourcc of the input video */ |
251 |
|
int num_threads;/* [in:opt] number of threads to use in decoder */ |
252 |
} xvid_dec_create_t; |
} xvid_dec_create_t; |
253 |
|
|
254 |
|
|
372 |
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
373 |
#define XVID_REQLAMBDA (1<<3) /* plugin requires access to the lambda table */ |
#define XVID_REQLAMBDA (1<<3) /* plugin requires access to the lambda table */ |
374 |
|
|
|
|
|
375 |
typedef struct |
typedef struct |
376 |
{ |
{ |
377 |
int version; |
int version; |
494 |
extern xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
extern xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
495 |
|
|
496 |
extern xvid_plugin_func xvid_plugin_ssim; /*write ssim values to stdout*/ |
extern xvid_plugin_func xvid_plugin_ssim; /*write ssim values to stdout*/ |
497 |
|
extern xvid_plugin_func xvid_plugin_psnrhvsm; /*write psnrhvsm values to stdout*/ |
498 |
|
|
499 |
|
|
500 |
/* single pass rate control |
/* single pass rate control |
542 |
int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */ |
543 |
|
|
544 |
/* ------- v1.1.x ------- */ |
/* ------- v1.1.x ------- */ |
545 |
int vbv_size; /* [in] buffer size (bits) */ |
int vbv_size; /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/ |
546 |
int vbv_initial; /* [in] initial buffer occupancy (bits) */ |
int vbv_initial; /* [in] initial buffer occupancy (bits) */ |
547 |
int vbv_maxrate; /* [in] max processing bitrate (bits per second) */ |
int vbv_maxrate; /* [in] max processing bitrate (bits per second) */ |
548 |
int vbv_peakrate; /* [in:opt] max average bitrate over 3 seconds (bits per second) */ |
int vbv_peakrate; /* [in:opt] max average bitrate over 1 second (bits per second). |
549 |
|
* This is used for diagnostics only and won't affect the actual peak bitrate. |
550 |
|
* This is not a problem as long as vbv_peakrate > vbv_size + vbv_maxrate which |
551 |
|
* guarantees that vbv_peakrate won't be exceeded. */ |
552 |
}xvid_plugin_2pass2_t; |
}xvid_plugin_2pass2_t; |
553 |
|
|
554 |
|
|
563 |
/*accuracy 0 very accurate 4 very fast*/ |
/*accuracy 0 very accurate 4 very fast*/ |
564 |
int acc; |
int acc; |
565 |
|
|
566 |
|
int cpu_flags; /* XVID_CPU_XXX flags */ |
567 |
|
|
568 |
} xvid_plugin_ssim_t; |
} xvid_plugin_ssim_t; |
569 |
|
|
570 |
|
typedef struct { |
571 |
|
int version; |
572 |
|
|
573 |
|
int method; /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */ |
574 |
|
} xvid_plugin_lumimasking_t; |
575 |
|
|
576 |
/***************************************************************************** |
/***************************************************************************** |
577 |
* ENCODER API |
* ENCODER API |
578 |
****************************************************************************/ |
****************************************************************************/ |
670 |
#define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ |
#define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */ |
671 |
#define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */ |
#define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */ |
672 |
#define XVID_VOP_RD_BVOP (1<<13) /* enable rate-distortion mode decision in b-frames */ |
#define XVID_VOP_RD_BVOP (1<<13) /* enable rate-distortion mode decision in b-frames */ |
673 |
|
#define XVID_VOP_RD_PSNRHVSM (1<<14) /* use PSNR-HVS-M as metric for rate-distortion optimizations */ |
674 |
|
|
675 |
/* Only valid for vol_flags|=XVID_VOL_INTERLACING */ |
/* Only valid for vol_flags|=XVID_VOL_INTERLACING */ |
676 |
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
748 |
int num_plugins; /* [in:opt] number of plugins */ |
int num_plugins; /* [in:opt] number of plugins */ |
749 |
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
750 |
|
|
751 |
int num_threads; /* [in:opt] number of threads */ |
int num_threads; /* [in:opt] number of threads to use in encoder */ |
752 |
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
753 |
|
|
754 |
int global; /* [in:opt] global flags; controls encoding behavior */ |
int global; /* [in:opt] global flags; controls encoding behavior */ |
771 |
/* ---------------------------------------------- */ |
/* ---------------------------------------------- */ |
772 |
|
|
773 |
void *handle; /* [out] encoder instance handle */ |
void *handle; /* [out] encoder instance handle */ |
774 |
|
|
775 |
|
/* ------- v1.3.x ------- */ |
776 |
|
int start_frame_num; /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */ |
777 |
|
int num_slices; /* [in:opt] number of slices to code for each frame */ |
778 |
} xvid_enc_create_t; |
} xvid_enc_create_t; |
779 |
|
|
780 |
|
|