[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 1397, Thu Apr 1 11:11:28 2004 UTC revision 1890, Tue Aug 10 14:17:40 2010 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-2004 Peter Ross <pross@xvid.org>
7   *   *
# 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.34 2004-04-01 11:11:28 suxen_drol Exp $   * $Id: xvid.h,v 1.67 2010-08-10 14:17:23 Isibaar Exp $
23   *   *
24   ****************************************************************************/   ****************************************************************************/
25    
# 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,-123)  #define XVID_VERSION             XVID_MAKE_VERSION(1,3,-127)
61  #define XVID_API                 XVID_MAKE_API(4, 0)  #define XVID_API                 XVID_MAKE_API(4, 3)
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 "0029"  #define XVID_BS_VERSION 57
   
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 170  Line 170 
170  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
171  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
172  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
173    #define XVID_CPU_SSE3     (1<< 8) /*      sse3 : pentium4, athlon64 */
174    #define XVID_CPU_SSE41    (1<< 9) /*      sse41: penryn */
175  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
176  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
177  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
# Line 234  Line 236 
236  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
237    
238  /* XVID_DEC_CREATE param 1  /* XVID_DEC_CREATE param 1
239          image width & height may be specified here when the dimensions are          image width & height as well as FourCC code may be specified
240          known in advance. */          here when known in advance (e.g. being read from container) */
241  typedef struct {  typedef struct {
242          int version;          int version;
243          int width;     /* [in:opt] image width */          int width;     /* [in:opt] image width */
244          int height;    /* [in:opt] image width */          int height;    /* [in:opt] image width */
245          void * handle; /* [out]    decore context handle */          void * handle; /* [out]    decore context handle */
246            int fourcc;     /* [in:opt] fourcc of the video */
247  } xvid_dec_create_t;  } xvid_dec_create_t;
248    
249    
# Line 251  Line 254 
254  #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */  #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
255  #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */  #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
256  #define XVID_FILMEFFECT    (1<<4) /* adds film grain */  #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
257    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
258    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
259    
260    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
261    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
262    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
263    
264  typedef struct {  typedef struct {
265          int version;          int version;
# Line 258  Line 267 
267          void *bitstream;     /* [in]     bitstream (read from)*/          void *bitstream;     /* [in]     bitstream (read from)*/
268          int length;          /* [in]     bitstream length */          int length;          /* [in]     bitstream length */
269          xvid_image_t output; /* [in]     output image (written to) */          xvid_image_t output; /* [in]     output image (written to) */
270    /* ------- v1.1.x ------- */
271          int brightness;          /* [in]         brightness offset (0=none) */          int brightness;          /* [in]         brightness offset (0=none) */
272  } xvid_dec_frame_t;  } xvid_dec_frame_t;
273    
# Line 355  Line 365 
365  #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 */
366  #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*/
367  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
368    #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */
369    
370    
371  typedef struct  typedef struct
# Line 420  Line 431 
431          int vol_flags;          /* [in,out] */          int vol_flags;          /* [in,out] */
432          int motion_flags;       /* [in,out] */          int motion_flags;       /* [in,out] */
433    
434            /* Lambda table for HVSPlugins */
435            float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
436    
437  /* Deprecated, use the stats field instead.  /* Deprecated, use the stats field instead.
438   * Will disapear before 1.0 */   * Will disapear before 1.0 */
439          int length;             /* [out] after: length of encoded frame */          int length;             /* [out] after: length of encoded frame */
# Line 475  Line 489 
489  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
490  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
491    
492    extern xvid_plugin_func xvid_plugin_ssim;       /*write ssim values to stdout*/
493    
494    
495  /* single pass rate control  /* single pass rate control
496   * CBR and Constant quantizer modes */   * CBR and Constant quantizer modes */
# Line 502  Line 518 
518  typedef struct {  typedef struct {
519          int version;          int version;
520    
521          int bitrate;                  /* [in] bits per second */          int bitrate;                  /* [in] target bitrate (bits per second) */
522          char * filename;              /* [in] first pass stats filename */          char * filename;              /* [in] first pass stats filename */
523    
524          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
# Line 519  Line 535 
535                                                                     *      0 for 1<distance<kfthreshold */                                                                     *      0 for 1<distance<kfthreshold */
536    
537          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 */
538    
539    /* ------- v1.1.x ------- */
540            int vbv_size;                 /* [in] buffer size (bits) */
541            int vbv_initial;              /* [in] initial buffer occupancy (bits) */
542            int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
543            int vbv_peakrate;             /* [in:opt] max average bitrate over 3 seconds (bits per second) */
544    
545  }xvid_plugin_2pass2_t;  }xvid_plugin_2pass2_t;
546    
547    
548    typedef struct{
549            /*stat output*/
550            int b_printstat;
551            char* stat_path;
552    
553            /*visualize*/
554            int b_visualize;
555    
556            /*accuracy 0 very accurate 4 very fast*/
557            int acc;
558    
559        int cpu_flags; /* XVID_CPU_XXX flags */
560    
561    } xvid_plugin_ssim_t;
562    
563    typedef struct {
564            int version;
565    
566            int method;      /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */
567    } xvid_plugin_lumimasking_t;
568    
569  /*****************************************************************************  /*****************************************************************************
570   *                             ENCODER API   *                             ENCODER API
571   ****************************************************************************/   ****************************************************************************/
# Line 580  Line 625 
625  #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 */
626  #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 */
627  #endif  #endif
628    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
629                                                    this is implied if XVID_GLOBAL_PACKED is set */
630    
631  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
632   * "VOL" flags   * "VOL" flags
# Line 594  Line 640 
640  #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 */
641  #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 */
642  #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 */
643                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
644  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
645    
646    
# Line 615  Line 662 
662  #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */  #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */
663  #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 */
664  #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 */
665    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
666    
667  /* Only valid for vol_flags|=XVID_VOL_INTERLACING */  /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
668  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
# Line 622  Line 670 
670    
671  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
672  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */
673                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
674    
675  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
676   * "Motion" flags   * "Motion" flags
# Line 715  Line 763 
763          /* ---------------------------------------------- */          /* ---------------------------------------------- */
764    
765          void *handle;                /* [out] encoder instance handle */          void *handle;                /* [out] encoder instance handle */
766    
767            /* ------- v1.3.x ------- */
768            int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */
769  } xvid_enc_create_t;  } xvid_enc_create_t;
770    
771    
Legend:
Removed from v.1397  
changed lines
  Added in v.1890
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4