[svn] / trunk / xvidcore / src / xvid.h Repository:
ViewVC logotype

Diff of /trunk/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1471, Fri Jun 11 08:44:30 2004 UTC revision 2054, Fri Nov 4 15:24:39 2011 UTC
# Line 1  Line 1 
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
# Line 19  Line 19 
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$
23   *   *
24   ****************************************************************************/   ****************************************************************************/
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
   
29  #ifdef __cplusplus  #ifdef __cplusplus
30  extern "C" {  extern "C" {
31  #endif  #endif
32    
33  /*****************************************************************************  /*****************************************************************************
34     * function export defines
35     ****************************************************************************/
36    
37    /* Attention! Work in progress. TODO: Review */
38    
39    #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   * versioning
49   ****************************************************************************/   ****************************************************************************/
50    
# Line 57  Line 70 
70  #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)  #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)
71  #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)  #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)
72    
73  #define XVID_VERSION             XVID_MAKE_VERSION(1,1,-127)  #define XVID_VERSION             XVID_MAKE_VERSION(1,4,-127)
74  #define XVID_API                 XVID_MAKE_API(4, 0)  #define XVID_API                 XVID_MAKE_API(4, 4)
75    
76  #define XVID_UNSTABLE  #define XVID_UNSTABLE
77    
# Line 73  Line 86 
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 35  #define XVID_BS_VERSION 73
90    
91  /*****************************************************************************  /*****************************************************************************
92   * error codes   * error codes
# Line 102  Line 115 
115  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */
116  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */
117  #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */  #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 */  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
120  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
121  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
# Line 128  Line 142 
142  #define XVID_PROFILE_S_L1    0x01  #define XVID_PROFILE_S_L1    0x01
143  #define XVID_PROFILE_S_L2    0x02  #define XVID_PROFILE_S_L2    0x02
144  #define XVID_PROFILE_S_L3    0x03  #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 */  #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
149  #define XVID_PROFILE_ARTS_L2 0x92  #define XVID_PROFILE_ARTS_L2 0x92
150  #define XVID_PROFILE_ARTS_L3 0x93  #define XVID_PROFILE_ARTS_L3 0x93
# Line 169  Line 186 
186  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
187  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
188  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */  #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 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
192  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
193  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
# Line 219  Line 238 
238  #define XVID_GBL_INFO    1 /* return some info about xvidcore, and the host computer */  #define XVID_GBL_INFO    1 /* return some info about xvidcore, and the host computer */
239  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
240    
241  extern int xvid_global(void *handle, int opt, void *param1, void *param2);  XVID_IMPEXP int XVID_CALL xvid_global(void *handle, int opt, void *param1, void *param2);
242    
243    
244  /*****************************************************************************  /*****************************************************************************
# Line 230  Line 249 
249  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */  #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 */  #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */
251    
252  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);  XVID_IMPEXP int XVID_CALL xvid_decore(void *handle, int opt, void *param1, void *param2);
253    
254  /* XVID_DEC_CREATE param 1  /* XVID_DEC_CREATE param 1
255          image width & height may be specified here when the dimensions are          image width & height as well as FourCC code may be specified
256          known in advance. */          here when known in advance (e.g. being read from container) */
257  typedef struct {  typedef struct {
258          int version;          int version;
259          int width;     /* [in:opt] image width */          int width;     /* [in:opt] image width */
260          int height;    /* [in:opt] image width */          int height;    /* [in:opt] image width */
261          void * handle; /* [out]    decore context handle */          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;  } xvid_dec_create_t;
266    
267    
# Line 263  Line 285 
285          void *bitstream;     /* [in]     bitstream (read from)*/          void *bitstream;     /* [in]     bitstream (read from)*/
286          int length;          /* [in]     bitstream length */          int length;          /* [in]     bitstream length */
287          xvid_image_t output; /* [in]     output image (written to) */          xvid_image_t output; /* [in]     output image (written to) */
288  /* ------- v1.1.0 ------- */  /* ------- v1.1.x ------- */
289          int brightness;          /* [in]         brightness offset (0=none) */          int brightness;          /* [in]         brightness offset (0=none) */
290  } xvid_dec_frame_t;  } xvid_dec_frame_t;
291    
# Line 361  Line 383 
383  #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 */
384  #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*/
385  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */  #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  typedef struct  typedef struct
389  {  {
# Line 426  Line 448 
448          int vol_flags;          /* [in,out] */          int vol_flags;          /* [in,out] */
449          int motion_flags;       /* [in,out] */          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.  /* Deprecated, use the stats field instead.
455   * Will disapear before 1.0 */   * Will disapear before 1.0 */
456          int length;             /* [out] after: length of encoded frame */          int length;             /* [out] after: length of encoded frame */
# Line 463  Line 488 
488    
489   ****************************************************************************/   ****************************************************************************/
490    
491  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);  typedef int (XVID_CALL xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
492    
493  typedef struct  typedef struct
494  {  {
# Line 471  Line 496 
496          void * param;          void * param;
497  } xvid_enc_plugin_t;  } 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  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */  XVID_IMPEXP xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
 extern xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */  
 extern xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */  
504    
505  extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  XVID_IMPEXP xvid_plugin_func xvid_plugin_psnr;      /* write psnr values to stdout */
506    XVID_IMPEXP xvid_plugin_func xvid_plugin_dump;      /* dump before and after yuvpgms */
507    
508  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */  XVID_IMPEXP xvid_plugin_func xvid_plugin_ssim;      /*write ssim values to stdout*/
509  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */  XVID_IMPEXP xvid_plugin_func xvid_plugin_psnrhvsm;  /*write psnrhvsm values to stdout*/
510    
511    
512  /* single pass rate control  /* single pass rate control
# Line 508  Line 535 
535  typedef struct {  typedef struct {
536          int version;          int version;
537    
538          int bitrate;                  /* [in] bits per second */          int bitrate;                  /* [in] target bitrate (bits per second) */
539          char * filename;              /* [in] first pass stats filename */          char * filename;              /* [in] first pass stats filename */
540    
541          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
# Line 526  Line 553 
553    
554          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 */
555    
556  /* ------- v1.1.0 ------- */  /* ------- v1.1.x ------- */
557          int vbv_size;          int vbv_size;                 /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/
558          int vbv_initial;          int vbv_initial;              /* [in] initial buffer occupancy (bits) */
559          int vbv_maxrate;          int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
560          int vbv_peakrate;          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;  }xvid_plugin_2pass2_t;
565    
566    
567    typedef struct{
568            /*stat output*/
569            int b_printstat;
570            char* stat_path;
571    
572            /*visualize*/
573            int b_visualize;
574    
575            /*accuracy 0 very accurate 4 very fast*/
576            int acc;
577    
578        int cpu_flags; /* XVID_CPU_XXX flags */
579    
580    } xvid_plugin_ssim_t;
581    
582    typedef struct {
583            int version;
584    
585            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   *                             ENCODER API
590   ****************************************************************************/   ****************************************************************************/
# Line 552  Line 603 
603   * Encoder entry point   * Encoder entry point
604   *--------------------------------------------------------------------------*/   *--------------------------------------------------------------------------*/
605    
606  extern int xvid_encore(void *handle, int opt, void *param1, void *param2);  XVID_IMPEXP int XVID_CALL xvid_encore(void *handle, int opt, void *param1, void *param2);
607    
608  /* Quick API reference  /* Quick API reference
609   *   *
# Line 593  Line 644 
644  #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 */
645  #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 */
646  #endif  #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  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
651   * "VOL" flags   * "VOL" flags
# Line 607  Line 659 
659  #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 */
660  #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 */
661  #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 */
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 */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
664    
665    
# Line 628  Line 681 
681  #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */  #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 */  #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 */  #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 */  /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
688  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
# Line 635  Line 690 
690    
691  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
692  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */  #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  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
696   * "Motion" flags   * "Motion" flags
# Line 705  Line 760 
760          int num_plugins;             /* [in:opt] number of plugins */          int num_plugins;             /* [in:opt] number of plugins */
761          xvid_enc_plugin_t * plugins; /*          ^^ plugin array */          xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
762    
763          int num_threads;             /* [in:opt] number of threads */          int num_threads;             /* [in:opt] number of threads to use in encoder */
764          int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
765    
766          int global;                  /* [in:opt] global flags; controls encoding behavior */          int global;                  /* [in:opt] global flags; controls encoding behavior */
# Line 728  Line 783 
783          /* ---------------------------------------------- */          /* ---------------------------------------------- */
784    
785          void *handle;                /* [out] encoder instance handle */          void *handle;                /* [out] encoder instance handle */
786    
787            /* ------- v1.3.x ------- */
788            int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */
789            int num_slices;              /* [in:opt] number of slices to code for each frame */
790  } xvid_enc_create_t;  } xvid_enc_create_t;
791    
792    
Legend:
Removed from v.1471  
changed lines
  Added in v.2054
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4