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-2010 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.41 2004-06-11 08:44:30 suxen_drol Exp $ |
* $Id: xvid.h,v 1.74.2.1 2010-12-28 16:04:31 Isibaar Exp $ |
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,1,-127) |
#define XVID_VERSION XVID_MAKE_VERSION(1,3,0) |
61 |
#define XVID_API XVID_MAKE_API(4, 0) |
#define XVID_API XVID_MAKE_API(4, 3) |
|
|
|
|
#define XVID_UNSTABLE |
|
62 |
|
|
63 |
/* Bitstream Version |
/* Bitstream Version |
64 |
* 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 |
71 |
* 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 |
72 |
* future |
* future |
73 |
*/ |
*/ |
74 |
#define XVID_BS_VERSION 35 |
#define XVID_BS_VERSION 61 |
75 |
|
|
76 |
/***************************************************************************** |
/***************************************************************************** |
77 |
* error codes |
* error codes |
100 |
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
#define XVID_CSP_YUY2 (1<< 3) /* 4:2:2 packed */ |
101 |
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
#define XVID_CSP_UYVY (1<< 4) /* 4:2:2 packed */ |
102 |
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
#define XVID_CSP_YVYU (1<< 5) /* 4:2:2 packed */ |
103 |
|
#define XVID_CSP_RGB (1<<16) /* 24-bit rgb packed */ |
104 |
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
#define XVID_CSP_BGRA (1<< 6) /* 32-bit bgra packed */ |
105 |
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
#define XVID_CSP_ABGR (1<< 7) /* 32-bit abgr packed */ |
106 |
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
#define XVID_CSP_RGBA (1<< 8) /* 32-bit rgba packed */ |
127 |
#define XVID_PROFILE_S_L1 0x01 |
#define XVID_PROFILE_S_L1 0x01 |
128 |
#define XVID_PROFILE_S_L2 0x02 |
#define XVID_PROFILE_S_L2 0x02 |
129 |
#define XVID_PROFILE_S_L3 0x03 |
#define XVID_PROFILE_S_L3 0x03 |
130 |
|
#define XVID_PROFILE_S_L4a 0x04 |
131 |
|
#define XVID_PROFILE_S_L5 0x05 |
132 |
|
#define XVID_PROFILE_S_L6 0x06 |
133 |
#define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ |
#define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */ |
134 |
#define XVID_PROFILE_ARTS_L2 0x92 |
#define XVID_PROFILE_ARTS_L2 0x92 |
135 |
#define XVID_PROFILE_ARTS_L3 0x93 |
#define XVID_PROFILE_ARTS_L3 0x93 |
171 |
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
#define XVID_CPU_MMXEXT (1<< 1) /* mmx-ext : pentium2, athlon */ |
172 |
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
#define XVID_CPU_SSE (1<< 2) /* sse : pentium3, athlonXP */ |
173 |
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
#define XVID_CPU_SSE2 (1<< 3) /* sse2 : pentium4, athlon64 */ |
174 |
|
#define XVID_CPU_SSE3 (1<< 8) /* sse3 : pentium4, athlon64 */ |
175 |
|
#define XVID_CPU_SSE41 (1<< 9) /* sse41: penryn */ |
176 |
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
#define XVID_CPU_3DNOW (1<< 4) /* 3dnow : k6-2 */ |
177 |
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
#define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */ |
178 |
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
#define XVID_CPU_TSC (1<< 6) /* tsc : Pentium */ |
237 |
extern int xvid_decore(void *handle, int opt, void *param1, void *param2); |
extern int xvid_decore(void *handle, int opt, void *param1, void *param2); |
238 |
|
|
239 |
/* XVID_DEC_CREATE param 1 |
/* XVID_DEC_CREATE param 1 |
240 |
image width & height may be specified here when the dimensions are |
image width & height as well as FourCC code may be specified |
241 |
known in advance. */ |
here when known in advance (e.g. being read from container) */ |
242 |
typedef struct { |
typedef struct { |
243 |
int version; |
int version; |
244 |
int width; /* [in:opt] image width */ |
int width; /* [in:opt] image width */ |
245 |
int height; /* [in:opt] image width */ |
int height; /* [in:opt] image width */ |
246 |
void * handle; /* [out] decore context handle */ |
void * handle; /* [out] decore context handle */ |
247 |
|
/* ------- v1.3.x ------- */ |
248 |
|
int fourcc; /* [in:opt] fourcc of the input video */ |
249 |
|
int num_threads;/* [in:opt] number of threads to use in decoder */ |
250 |
} xvid_dec_create_t; |
} xvid_dec_create_t; |
251 |
|
|
252 |
|
|
270 |
void *bitstream; /* [in] bitstream (read from)*/ |
void *bitstream; /* [in] bitstream (read from)*/ |
271 |
int length; /* [in] bitstream length */ |
int length; /* [in] bitstream length */ |
272 |
xvid_image_t output; /* [in] output image (written to) */ |
xvid_image_t output; /* [in] output image (written to) */ |
273 |
/* ------- v1.1.0 ------- */ |
/* ------- v1.1.x ------- */ |
274 |
int brightness; /* [in] brightness offset (0=none) */ |
int brightness; /* [in] brightness offset (0=none) */ |
275 |
} xvid_dec_frame_t; |
} xvid_dec_frame_t; |
276 |
|
|
368 |
#define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
#define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */ |
369 |
#define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ |
#define XVID_REQPSNR (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/ |
370 |
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
#define XVID_REQDQUANTS (1<<2) /* plugin requires access to the dquant table */ |
371 |
|
#define XVID_REQLAMBDA (1<<3) /* plugin requires access to the lambda table */ |
372 |
|
|
373 |
typedef struct |
typedef struct |
374 |
{ |
{ |
433 |
int vol_flags; /* [in,out] */ |
int vol_flags; /* [in,out] */ |
434 |
int motion_flags; /* [in,out] */ |
int motion_flags; /* [in,out] */ |
435 |
|
|
436 |
|
/* Lambda table for HVSPlugins */ |
437 |
|
float * lambda; /* [in,out] six floats for each macroblock. read, multiply, write back */ |
438 |
|
|
439 |
/* Deprecated, use the stats field instead. |
/* Deprecated, use the stats field instead. |
440 |
* Will disapear before 1.0 */ |
* Will disapear before 1.0 */ |
441 |
int length; /* [out] after: length of encoded frame */ |
int length; /* [out] after: length of encoded frame */ |
491 |
extern xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
extern xvid_plugin_func xvid_plugin_psnr; /* write psnr values to stdout */ |
492 |
extern xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
extern xvid_plugin_func xvid_plugin_dump; /* dump before and after yuvpgms */ |
493 |
|
|
494 |
|
extern xvid_plugin_func xvid_plugin_ssim; /*write ssim values to stdout*/ |
495 |
|
extern xvid_plugin_func xvid_plugin_psnrhvsm; /*write psnrhvsm values to stdout*/ |
496 |
|
|
497 |
|
|
498 |
/* single pass rate control |
/* single pass rate control |
499 |
* CBR and Constant quantizer modes */ |
* CBR and Constant quantizer modes */ |
521 |
typedef struct { |
typedef struct { |
522 |
int version; |
int version; |
523 |
|
|
524 |
int bitrate; /* [in] bits per second */ |
int bitrate; /* [in] target bitrate (bits per second) */ |
525 |
char * filename; /* [in] first pass stats filename */ |
char * filename; /* [in] first pass stats filename */ |
526 |
|
|
527 |
int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
int keyframe_boost; /* [in] keyframe boost percentage: [0..100] */ |
539 |
|
|
540 |
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 */ |
541 |
|
|
542 |
/* ------- v1.1.0 ------- */ |
/* ------- v1.1.x ------- */ |
543 |
int vbv_size; |
int vbv_size; /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/ |
544 |
int vbv_initial; |
int vbv_initial; /* [in] initial buffer occupancy (bits) */ |
545 |
int vbv_maxrate; |
int vbv_maxrate; /* [in] max processing bitrate (bits per second) */ |
546 |
int vbv_peakrate; |
int vbv_peakrate; /* [in:opt] max average bitrate over 1 second (bits per second). |
547 |
|
* This is used for diagnostics only and won't affect the actual peak bitrate. |
548 |
|
* This is not a problem as long as vbv_peakrate > vbv_size + vbv_maxrate which |
549 |
|
* guarantees that vbv_peakrate won't be exceeded. */ |
550 |
}xvid_plugin_2pass2_t; |
}xvid_plugin_2pass2_t; |
551 |
|
|
552 |
|
|
553 |
|
typedef struct{ |
554 |
|
/*stat output*/ |
555 |
|
int b_printstat; |
556 |
|
char* stat_path; |
557 |
|
|
558 |
|
/*visualize*/ |
559 |
|
int b_visualize; |
560 |
|
|
561 |
|
/*accuracy 0 very accurate 4 very fast*/ |
562 |
|
int acc; |
563 |
|
|
564 |
|
int cpu_flags; /* XVID_CPU_XXX flags */ |
565 |
|
|
566 |
|
} xvid_plugin_ssim_t; |
567 |
|
|
568 |
|
typedef struct { |
569 |
|
int version; |
570 |
|
|
571 |
|
int method; /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */ |
572 |
|
} xvid_plugin_lumimasking_t; |
573 |
|
|
574 |
/***************************************************************************** |
/***************************************************************************** |
575 |
* ENCODER API |
* ENCODER API |
576 |
****************************************************************************/ |
****************************************************************************/ |
630 |
#define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ |
#define XVID_GLOBAL_VOL_AT_IVOP (1<<3) /* write vol at every ivop: WIN32/divx compatibility */ |
631 |
#define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ |
#define XVID_GLOBAL_FORCE_VOL (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */ |
632 |
#endif |
#endif |
633 |
|
#define XVID_GLOBAL_DIVX5_USERDATA (1<<5) /* write divx5 userdata string |
634 |
|
this is implied if XVID_GLOBAL_PACKED is set */ |
635 |
|
|
636 |
/*---------------------------------------------------------------------------- |
/*---------------------------------------------------------------------------- |
637 |
* "VOL" flags |
* "VOL" flags |
645 |
#define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ |
#define XVID_VOL_QUARTERPEL (1<<2) /* enable quarterpel: frames will encoded as quarterpel */ |
646 |
#define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ |
#define XVID_VOL_GMC (1<<3) /* enable GMC; frames will be checked for gmc suitability */ |
647 |
#define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
#define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */ |
648 |
|
/* NOTE: the reduced resolution feature is not supported anymore. This flag will have no effect! */ |
649 |
#define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ |
#define XVID_VOL_INTERLACING (1<<5) /* enable interlaced encoding */ |
650 |
|
|
651 |
|
|
667 |
#define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ |
#define XVID_VOP_HQACPRED (1<< 7) /* high quality ac prediction */ |
668 |
#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 */ |
669 |
#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 */ |
670 |
|
#define XVID_VOP_RD_BVOP (1<<13) /* enable rate-distortion mode decision in b-frames */ |
671 |
|
#define XVID_VOP_RD_PSNRHVSM (1<<14) /* use PSNR-HVS-M as metric for rate-distortion optimizations */ |
672 |
|
|
673 |
/* Only valid for vol_flags|=XVID_VOL_INTERLACING */ |
/* Only valid for vol_flags|=XVID_VOL_INTERLACING */ |
674 |
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
#define XVID_VOP_TOPFIELDFIRST (1<< 9) /* set top-field-first flag */ |
676 |
|
|
677 |
/* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
/* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */ |
678 |
#define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ |
#define XVID_VOP_REDUCED (1<<11) /* reduced resolution vop */ |
679 |
|
/* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */ |
680 |
|
|
681 |
/*---------------------------------------------------------------------------- |
/*---------------------------------------------------------------------------- |
682 |
* "Motion" flags |
* "Motion" flags |
746 |
int num_plugins; /* [in:opt] number of plugins */ |
int num_plugins; /* [in:opt] number of plugins */ |
747 |
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
xvid_enc_plugin_t * plugins; /* ^^ plugin array */ |
748 |
|
|
749 |
int num_threads; /* [in:opt] number of threads */ |
int num_threads; /* [in:opt] number of threads to use in encoder */ |
750 |
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
int max_bframes; /* [in:opt] max sequential bframes (0=disable bframes) */ |
751 |
|
|
752 |
int global; /* [in:opt] global flags; controls encoding behavior */ |
int global; /* [in:opt] global flags; controls encoding behavior */ |
769 |
/* ---------------------------------------------- */ |
/* ---------------------------------------------- */ |
770 |
|
|
771 |
void *handle; /* [out] encoder instance handle */ |
void *handle; /* [out] encoder instance handle */ |
772 |
|
|
773 |
|
/* ------- v1.3.x ------- */ |
774 |
|
int start_frame_num; /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */ |
775 |
|
int num_slices; /* [in:opt] number of slices to code for each frame */ |
776 |
} xvid_enc_create_t; |
} xvid_enc_create_t; |
777 |
|
|
778 |
|
|