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

Diff of /xvidcore/src/xvid.h

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

revision 1.27.2.67, Sun May 9 14:00:35 2004 UTC revision 1.76, Tue Mar 8 19:16:26 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-2003 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
# Line 57  Line 57 
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,0,-124)  #define XVID_VERSION             XVID_MAKE_VERSION(1,4,-127)
61  #define XVID_API                 XVID_MAKE_API(4, 0)  #define XVID_API                 XVID_MAKE_API(4, 4)
62    
63  #define XVID_UNSTABLE  #define XVID_UNSTABLE
64    
# Line 73  Line 73 
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 "0030"  #define XVID_BS_VERSION 71
   
77    
78  /*****************************************************************************  /*****************************************************************************
79   * error codes   * error codes
# Line 103  Line 102 
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 */
# Line 129  Line 129 
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
# Line 170  Line 173 
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 */
# Line 234  Line 239 
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    
# Line 251  Line 259 
259  #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */  #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
260  #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */  #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
261  #define XVID_FILMEFFECT    (1<<4) /* adds film grain */  #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
262    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
263    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
264    
265    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
266    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
267    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
268    
269  typedef struct {  typedef struct {
270          int version;          int version;
# Line 258  Line 272 
272          void *bitstream;     /* [in]     bitstream (read from)*/          void *bitstream;     /* [in]     bitstream (read from)*/
273          int length;          /* [in]     bitstream length */          int length;          /* [in]     bitstream length */
274          xvid_image_t output; /* [in]     output image (written to) */          xvid_image_t output; /* [in]     output image (written to) */
275    /* ------- v1.1.x ------- */
276            int brightness;          /* [in]         brightness offset (0=none) */
277  } xvid_dec_frame_t;  } xvid_dec_frame_t;
278    
279    
# Line 354  Line 370 
370  #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 */
371  #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*/
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 */
374    
375  typedef struct  typedef struct
376  {  {
# Line 419  Line 435 
435          int vol_flags;          /* [in,out] */          int vol_flags;          /* [in,out] */
436          int motion_flags;       /* [in,out] */          int motion_flags;       /* [in,out] */
437    
438            /* Lambda table for HVSPlugins */
439            float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
440    
441  /* Deprecated, use the stats field instead.  /* Deprecated, use the stats field instead.
442   * Will disapear before 1.0 */   * Will disapear before 1.0 */
443          int length;             /* [out] after: length of encoded frame */          int length;             /* [out] after: length of encoded frame */
# Line 474  Line 493 
493  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
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*/
497    extern xvid_plugin_func xvid_plugin_psnrhvsm;   /*write psnrhvsm values to stdout*/
498    
499    
500  /* single pass rate control  /* single pass rate control
501   * CBR and Constant quantizer modes */   * CBR and Constant quantizer modes */
# Line 501  Line 523 
523  typedef struct {  typedef struct {
524          int version;          int version;
525    
526          int bitrate;                  /* [in] bits per second */          int bitrate;                  /* [in] target bitrate (bits per second) */
527          char * filename;              /* [in] first pass stats filename */          char * filename;              /* [in] first pass stats filename */
528    
529          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
# Line 519  Line 541 
541    
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  #ifdef VBV  /* ------- v1.1.x ------- */
545    int vbvsize;          int vbv_size;                 /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/
546    int vbvinitial;          int vbv_initial;              /* [in] initial buffer occupancy (bits) */
547    int vbv_maxrate;          int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
548    int vbv_peakrate;          int vbv_peakrate;             /* [in:opt] max average bitrate over 1 second (bits per second).
549  #endif                                                                     *          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    
555    typedef struct{
556            /*stat output*/
557            int b_printstat;
558            char* stat_path;
559    
560            /*visualize*/
561            int b_visualize;
562    
563            /*accuracy 0 very accurate 4 very fast*/
564            int acc;
565    
566        int cpu_flags; /* XVID_CPU_XXX flags */
567    
568    } 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   ****************************************************************************/   ****************************************************************************/
# Line 587  Line 632 
632  #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 */
633  #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 */
634  #endif  #endif
635    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
636                                                    this is implied if XVID_GLOBAL_PACKED is set */
637    
638  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
639   * "VOL" flags   * "VOL" flags
# Line 601  Line 647 
647  #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 */
648  #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 */
649  #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 */
650                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
651  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
652    
653    
# Line 622  Line 669 
669  #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */  #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */
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 */
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  */
# Line 629  Line 678 
678    
679  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
680  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */
681                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
682    
683  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
684   * "Motion" flags   * "Motion" flags
# Line 699  Line 748 
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 */
# Line 722  Line 771 
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    

Legend:
Removed from v.1.27.2.67  
changed lines
  Added in v.1.76

No admin address has been configured
ViewVC Help
Powered by ViewVC 1.0.4