[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.33.2.1, Sun Apr 4 15:11:42 2004 UTC revision 1.69, Sun Oct 10 19:19:55 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-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,-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 "0030"  #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 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            int fourcc;     /* [in:opt] fourcc of the video */
250  } xvid_dec_create_t;  } xvid_dec_create_t;
251    
252    
# Line 251  Line 257 
257  #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */  #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
258  #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */  #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
259  #define XVID_FILMEFFECT    (1<<4) /* adds film grain */  #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
260    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
261    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
262    
263    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
264    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
265    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
266    
267  typedef struct {  typedef struct {
268          int version;          int version;
# Line 258  Line 270 
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.x ------- */
274            int brightness;          /* [in]         brightness offset (0=none) */
275  } xvid_dec_frame_t;  } xvid_dec_frame_t;
276    
277    
# Line 354  Line 368 
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    
374  typedef struct  typedef struct
# Line 419  Line 434 
434          int vol_flags;          /* [in,out] */          int vol_flags;          /* [in,out] */
435          int motion_flags;       /* [in,out] */          int motion_flags;       /* [in,out] */
436    
437            /* Lambda table for HVSPlugins */
438            float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
439    
440  /* Deprecated, use the stats field instead.  /* Deprecated, use the stats field instead.
441   * Will disapear before 1.0 */   * Will disapear before 1.0 */
442          int length;             /* [out] after: length of encoded frame */          int length;             /* [out] after: length of encoded frame */
# Line 474  Line 492 
492  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
493  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
494    
495    extern xvid_plugin_func xvid_plugin_ssim;           /*write ssim values to stdout*/
496    extern xvid_plugin_func xvid_plugin_psnrhvsm;   /*write psnrhvsm values to stdout*/
497    
498    
499  /* single pass rate control  /* single pass rate control
500   * CBR and Constant quantizer modes */   * CBR and Constant quantizer modes */
# Line 501  Line 522 
522  typedef struct {  typedef struct {
523          int version;          int version;
524    
525          int bitrate;                  /* [in] bits per second */          int bitrate;                  /* [in] target bitrate (bits per second) */
526          char * filename;              /* [in] first pass stats filename */          char * filename;              /* [in] first pass stats filename */
527    
528          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
# Line 518  Line 539 
539                                                                     *      0 for 1<distance<kfthreshold */                                                                     *      0 for 1<distance<kfthreshold */
540    
541          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 */
542    
543    /* ------- v1.1.x ------- */
544            int vbv_size;                 /* [in] buffer size (bits) */
545            int vbv_initial;              /* [in] initial buffer occupancy (bits) */
546            int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
547            int vbv_peakrate;             /* [in:opt] max average bitrate over 3 seconds (bits per second) */
548    
549  }xvid_plugin_2pass2_t;  }xvid_plugin_2pass2_t;
550    
551    
552    typedef struct{
553            /*stat output*/
554            int b_printstat;
555            char* stat_path;
556    
557            /*visualize*/
558            int b_visualize;
559    
560            /*accuracy 0 very accurate 4 very fast*/
561            int acc;
562    
563        int cpu_flags; /* XVID_CPU_XXX flags */
564    
565    } xvid_plugin_ssim_t;
566    
567    typedef struct {
568            int version;
569    
570            int method;      /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */
571    } xvid_plugin_lumimasking_t;
572    
573  /*****************************************************************************  /*****************************************************************************
574   *                             ENCODER API   *                             ENCODER API
575   ****************************************************************************/   ****************************************************************************/
# Line 579  Line 629 
629  #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 */
630  #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 */
631  #endif  #endif
632    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
633                                                    this is implied if XVID_GLOBAL_PACKED is set */
634    
635  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
636   * "VOL" flags   * "VOL" flags
# Line 593  Line 644 
644  #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 */
645  #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 */
646  #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 */
647                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
648  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
649    
650    
# Line 614  Line 666 
666  #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */  #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */
667  #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 */
668  #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 */
669    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
670    
671  /* Only valid for vol_flags|=XVID_VOL_INTERLACING */  /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
672  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
# Line 621  Line 674 
674    
675  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
676  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */
677                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
678    
679  /*----------------------------------------------------------------------------  /*----------------------------------------------------------------------------
680   * "Motion" flags   * "Motion" flags
# Line 714  Line 767 
767          /* ---------------------------------------------- */          /* ---------------------------------------------- */
768    
769          void *handle;                /* [out] encoder instance handle */          void *handle;                /* [out] encoder instance handle */
770    
771            /* ------- v1.3.x ------- */
772            int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */
773  } xvid_enc_create_t;  } xvid_enc_create_t;
774    
775    
Legend:
Removed from v.1.33.2.1  
changed lines
  Added in v.1.69
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4