[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.26, Sat Jun 28 15:50:10 2003 UTC revision 1.31, Thu Jul 24 23:35:28 2003 UTC
# Line 3  Line 3 
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>   *  This file is part of XviD, a free MPEG-4 video encoder/decoder
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 26  Line 26 
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   * versioning   * Global constants
35   ****************************************************************************/   ****************************************************************************/
36    
37  /* versioning  /* API Version : 3.0 */
38          version takes the form "$major.$minor.$patch"  #define API_VERSION ((3 << 16) | (0))
39          $patch is incremented when there is no api change  #define XVID_API_UNSTABLE
         $minor is incremented when the api is changed, but remains backwards compatible  
         $major is incremented when the api is changed significantly  
   
         when initialising an xvid structure, you must always zero it, and set the version field.  
                 memset(&struct,0,sizeof(struct));  
                 struct.version = XVID_VERSION;  
   
         XVID_UNSTABLE is defined only during development.  
         */  
   
 #define XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )  
 #define XVID_MAJOR(a)                           ( ((a)>>16) & 0xff )  
 #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))  
 #define XVID_PATCH(c)                           ( (c) & 0xff )  
   
 #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)  
 #define XVID_UNSTABLE  
40    
41  /* Bitstream Version  /* Bitstream Version
42   * 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
# Line 67  Line 49 
49   * 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
50   * future   * future
51   */   */
52  #define XVID_BS_VERSION "0013"  #define XVID_BS_VERSION "0012"
53    
54    
55  /*****************************************************************************  /* Error codes */
56   * error codes  #define XVID_ERR_FAIL    -1
57   ****************************************************************************/  #define XVID_ERR_OK       0
58    #define XVID_ERR_MEMORY   1
59    #define XVID_ERR_FORMAT   2
60    
     /*  all functions return values <0 indicate error */  
61    
62  #define XVID_ERR_FAIL           -1              /* general fault */  /* Colorspaces */
63  #define XVID_ERR_MEMORY     -2          /* memory allocation error */  #define XVID_CSP_RGB24     0 /* [b|g|r] */
64  #define XVID_ERR_FORMAT     -3          /* file format error */  #define XVID_CSP_YV12      1
65  #define XVID_ERR_VERSION        -4              /* structure version not supported */  #define XVID_CSP_YUY2      2
66  #define XVID_ERR_END            -5              /* encoder only; end of stream reached */  #define XVID_CSP_UYVY      3
67    #define XVID_CSP_I420      4
68    #define XVID_CSP_RGB555   10
69    #define XVID_CSP_RGB565   11
70    #define XVID_CSP_USER     12
71    #define XVID_CSP_EXTERN 1004 /* per slice rendering */
72    #define XVID_CSP_YVYU   1002
73    #define XVID_CSP_RGB32  1000 /* [b|g|r|a] */
74    #define XVID_CSP_ABGR   1006 /* [a|b|g|r] */
75    #define XVID_CSP_RGBA   1005 /* [r|g|b|a] */
76    
77    
78    
79  /*****************************************************************************  #define XVID_CSP_NULL   9999
  * xvid_image_t  
  ****************************************************************************/  
   
 /* colorspace values */  
80    
81  #define XVID_CSP_USER           0       /* 4:2:0 planar */  #define XVID_CSP_VFLIP  0x80000000 /* flip mask */
 #define XVID_CSP_I420           1       /* 4:2:0 packed(planar win32) */  
 #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */  
 #define XVID_CSP_YUY2           3       /* 4:2:2 packed */  
 #define XVID_CSP_UYVY           4       /* 4:2:2 packed */  
 #define XVID_CSP_YVYU           5       /* 4:2:2 packed */  
 #define XVID_CSP_BGRA           6       /* 32-bit bgra packed */  
 #define XVID_CSP_ABGR           7       /* 32-bit abgr packed */  
 #define XVID_CSP_RGBA           8       /* 32-bit rgba packed */  
 #define XVID_CSP_BGR            9       /* 24-bit bgr packed */  
 #define XVID_CSP_RGB555     10  /* 16-bit rgb555 packed */  
 #define XVID_CSP_RGB565     11  /* 16-bit rgb565 packed */  
 #define XVID_CSP_SLICE          12      /* decoder only: 4:2:0 planar, per slice rendering */  
 #define XVID_CSP_INTERNAL       13      /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */  
 #define XVID_CSP_NULL           14      /* decoder only: dont output anything */  
 #define XVID_CSP_VFLIP  0x80000000      /* vertical flip mask */  
   
 /* xvid_image_t  
         for non-planar colorspaces use only plane[0] and stride[0]  
         four plane reserved for alpha*/  
 typedef struct {  
         int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */  
         void * plane[4];                /* [in] image plane ptrs */  
         int stride[4];                  /* [in] image stride; "bytes per row"*/  
 } xvid_image_t;  
   
 /* video-object-sequence profiles */  
 #define XVID_PROFILE_S_L0       0x08    /* simple */  
 #define XVID_PROFILE_S_L1       0x01  
 #define XVID_PROFILE_S_L2       0x02  
 #define XVID_PROFILE_S_L3       0x03  
 #define XVID_PROFILE_ARTS_L1    0x91    /* advanced realtime simple */  
 #define XVID_PROFILE_ARTS_L2    0x92  
 #define XVID_PROFILE_ARTS_L3    0x93  
 #define XVID_PROFILE_ARTS_L4    0x94  
 #define XVID_PROFILE_AS_L0      0xf0    /* advanced simple */  
 #define XVID_PROFILE_AS_L1      0xf1  
 #define XVID_PROFILE_AS_L2      0xf2  
 #define XVID_PROFILE_AS_L3      0xf3  
 #define XVID_PROFILE_AS_L4      0xf4  
   
 /* aspect ratios */  
 #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */  
 #define XVID_PAR_43_PAL     2   /* 4:3 pal (12:11 625-line) */  
 #define XVID_PAR_43_NTSC        3       /* 4:3 ntsc (10:11 525-line) */  
 #define XVID_PAR_169_PAL        4       /* 16:9 pal (16:11 625-line) */  
 #define XVID_PAR_169_NTSC       5       /* 16:9 ntsc (40:33 525-line) */  
 #define XVID_PAR_EXT            15      /* extended par; use par_width, par_height */  
   
 /* frame type flags */  
 #define XVID_TYPE_VOL           -1              /* decoder only: vol was decoded */  
 #define XVID_TYPE_NOTHING       0               /* decoder only (encoder stats): nothing was decoded/encoded */  
 #define XVID_TYPE_AUTO          0               /* encoder: automatically determine coding type */  
 #define XVID_TYPE_IVOP          1               /* intra frame */  
 #define XVID_TYPE_PVOP          2               /* predicted frame */  
 #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */  
 #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */  
82    
83    
84  /*****************************************************************************  /*****************************************************************************
85   * xvid_global()   *  Initialization constants
86   ****************************************************************************/   ****************************************************************************/
87    
88  /* cpu_flags definitions */  /* CPU flags for XVID_INIT_PARAM.cpu_flags */
   
89  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */
90    #define XVID_CPU_CHKONLY   0x40000000  /* check cpu only; dont init globals */
91  #define XVID_CPU_ASM        0x00000080  /* native assembly */  #define XVID_CPU_ASM        0x00000080  /* native assembly */
92    
93  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
94  #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */  #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */
95  #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */  #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */
# Line 165  Line 98 
98  #define XVID_CPU_3DNOW      0x00000010   /* 3dnow    : k6-2 */  #define XVID_CPU_3DNOW      0x00000010   /* 3dnow    : k6-2 */
99  #define XVID_CPU_3DNOWEXT   0x00000020   /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT   0x00000020   /* 3dnow-ext: athlon */
100  #define XVID_CPU_TSC        0x00000040   /* timestamp counter */  #define XVID_CPU_TSC        0x00000040   /* timestamp counter */
 /* ARCH_IS_PPC */  
 #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */  
101    
102    /* ARCH_IS_IA64 */
103    #define XVID_CPU_IA64     XVID_CPU_ASM /* defined for backward compatibility */
104    
105  #define XVID_DEBUG_ERROR       0x00000001  /* ARCH_IS_PPC */
106  #define XVID_DEBUG_STARTCODE   0x00000002  #define XVID_CPU_ALTIVEC  0x00000001   /* altivec */
 #define XVID_DEBUG_HEADER      0x00000004  
 #define XVID_DEBUG_TIMECODE    0x00000008  
 #define XVID_DEBUG_MB          0x00000010  
 #define XVID_DEBUG_COEFF       0x00000020  
 #define XVID_DEBUG_MV          0x00000040  
 #define XVID_DEBUG_RC          0x00000080  
 #define XVID_DEBUG_DEBUG       0x80000000  
   
 /* XVID_GBL_INIT param1 */  
 typedef struct {  
         int version;  
         int cpu_flags;                  /* [in:opt]     zero = autodetect cpu  
                                                                         XVID_CPU_FORCE|{cpu features} = force cpu features */  
     int debug;              /* [in:opt] debug level */  
 } xvid_gbl_init_t;  
   
   
 /* XVID_GBL_INFO param1 */  
 typedef struct {  
         int version;  
         int actual_version;             /* [out]        returns the actual xvidcore version */  
         const char * build;             /* [out]        if !null, points to description of this xvid core build */  
         int cpu_flags;                  /* [out]        detected cpu features */  
         int num_threads;                /* [out]        detected number of cpus/threads */  
 } xvid_gbl_info_t;  
   
   
 /* XVID_GBL_CONVERT param1 */  
 typedef struct {  
         int version;  
         xvid_image_t input;     /* [in] input image & colorspace */  
         xvid_image_t output;    /* [in] output image & colorspace */  
         int width;                              /* [in] width */  
         int height;                             /* [in] height */  
         int interlacing;                /* [in] interlacing */  
 } xvid_gbl_convert_t;  
   
   
 #define XVID_GBL_INIT           0       /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */  
 #define XVID_GBL_INFO           1       /* return some info about xvidcore, and the host computer */  
 #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */  
 #define XVID_GBL_TEST           3       /* testing.. */  
107    
 int xvid_global(void *handle, int opt, void *param1, void *param2);  
108    
109            typedef struct
110            {
111                    int colorspace;
112                    void * y;
113                    void * u;
114                    void * v;
115                    int y_stride;
116                    int uv_stride;
117            } XVID_IMAGE;      /* from yv12 */
118    
119    #define XVID_INIT_INIT    0
120    #define XVID_INIT_CONVERT 1
121    #define XVID_INIT_TEST    2
122    
123  /*****************************************************************************  /*****************************************************************************
124   * xvid_decore()   *  Initialization structures
125   ****************************************************************************/   ****************************************************************************/
126    
 #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */  
 #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */  
 #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */  
   
 int xvid_decore(void *handle, int opt, void *param1, void *param2);  
   
 /* XVID_DEC_CREATE param 1  
         image width & height may be specified here when the dimensions are  
         known in advance. */  
 typedef struct {  
         int version;  
         int width;                              /* [in:opt]     image width */  
         int height;                             /* [in:opt]     image width */  
         void * handle;                  /* [out]        decore context handle */  
 } xvid_dec_create_t;  
   
   
 /* XVID_DEC_DECODE param1 */  
 /* general flags */  
 #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */  
 #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */  
   
 typedef struct {  
         int version;  
         int general;                    /* [in:opt] general flags */  
         void *bitstream;                /* [in] bitstream (read from)*/  
         int length;                             /* [in] bitstream length */  
         xvid_image_t output;    /* [in] output image (written to) */  
 }  
 xvid_dec_frame_t;  
   
   
 /* XVID_DEC_DECODE param2 :: optional */  
127  typedef struct  typedef struct
128  {  {
129          int version;                  int cpu_flags;
130          int type;                               /* [out]        output data type */                  int api_version;
131          union {                  int core_build;
132                  struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */          } XVID_INIT_PARAM;
                         int general;            /* [out]        flags */  
                         int time_base;          /* [out]        time base */  
                         int time_increment;     /* [out]        time increment */  
   
                         /* XXX: external deblocking stuff */  
                         int * qscale;   /* [out]        pointer to quantizer table */  
                         int qscale_stride;              /* [out]        quantizer scale stride */  
   
                 } vop;  
                 struct {        /* XVID_TYPE_VOL */  
                         int general;            /* [out]        flags */  
                         int width;                      /* [out]        width */  
                         int height;                     /* [out]        height */  
                         int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */  
                         int par_width;          /* [out]        aspect ratio width */  
                         int par_height;         /* [out]        aspect ratio height */  
                 } vol;  
         } data;  
 } xvid_dec_stats_t;  
133    
   
   
 #define XVID_ZONE_QUANT     1  
 #define XVID_ZONE_WEIGHT    2  
134  typedef struct  typedef struct
135  {  {
136      int frame;                  XVID_IMAGE input;
137      int mode;                  XVID_IMAGE output;
138      int increment;                  int width;
139      int base;                  int height;
140  } xvid_enc_zone_t;                  int interlacing;
141            } XVID_INIT_CONVERTINFO;
   
142    
143  /*****************************************************************************  /*****************************************************************************
144    xvid plugin system -- internals   *  Initialization entry point
   
   xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE  
   before encoding each frame xvidcore will call XVID_PLG_BEFORE  
   after encoding each frame xvidcore will call XVID_PLG_AFTER  
   xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY  
145   ****************************************************************************/   ****************************************************************************/
146    
147            int xvid_init(void *handle,
148                                      int opt,
149                                      void *param1,
150                                      void *param2);
151    
 #define XVID_PLG_CREATE     0  
 #define XVID_PLG_DESTROY    1  
 #define XVID_PLG_INFO       2  
 #define XVID_PLG_BEFORE     3  
 #define XVID_PLG_AFTER      4  
152    
153  /* xvid_plg_info_t.flags */  /*****************************************************************************
154  #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */   * Decoder constants
155  #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/   ****************************************************************************/
 #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */  
156    
157    /* Flags for XVID_DEC_FRAME.general */
158    #define XVID_DEC_LOWDELAY      0x00000001 /* decode lowdelay mode (ie. VFW) */
159    #define XVID_DEC_DEBLOCKY      0x00000002 /* luma deblocking */
160    #define XVID_DEC_DEBLOCKUV     0x00000008 /* chroma deblocking */
161    #define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream
162                                                 instructs decoder to ignore any
163                                                 previous reference frames */
164    #define XVID_QUICK_DECODE      0x00000010
165    
166  typedef struct  /*****************************************************************************
167  {   * Decoder structures
168      int version;   ****************************************************************************/
     int flags;              /* [in:opt] plugin flags */  
 } xvid_plg_info_t;  
   
169    
170  typedef struct  typedef struct
171  {  {
172      int version;                  int width;
173                    int height;
174      int num_zones;          /* [out] */                  void *handle;
175      xvid_enc_zone_t * zones;    /* [out] */          } XVID_DEC_PARAM;
176    
     int width;              /* [out] */  
     int height;             /* [out] */  
     int mb_width;           /* [out] */  
     int mb_height;          /* [out] */  
         int fincr;              /* [out] */  
     int fbase;              /* [out] */  
   
     void * param;           /* [out] */  
 } xvid_plg_create_t;  
177    
178    #define XVID_DEC_VOP     0
179    #define XVID_DEC_VOL     1
180    #define XVID_DEC_NOTHING 2 /* nothing was decoded */
181    
182  typedef struct  typedef struct
183  {  {
184      int version;                  int notify;                 /* [out] output 'mode' */
185                    union
     int num_frames;          /* [out] totlal frame encoded */  
 } xvid_plg_destroy_t;  
   
   
 typedef struct  
186  {  {
187      int version;                          struct /* XVID_DEC_VOP */
188                            {
189      xvid_enc_zone_t * zone;    /* [out] current zone */                                  int time_base;      /* [out] time base */
190                                    int time_increment; /* [out] time increment */
191      int width;              /* [out] */                          } vop;
192      int height;             /* [out] */                          struct /* XVID_DEC_VOL */
193      int mb_width;           /* [out] */                          {
194      int mb_height;          /* [out] */                                  int general;        /* [out] flags: eg. frames are interlaced */
195          int fincr;              /* [out] */                                  int width;          /* [out] width */
196      int fbase;              /* [out] */                                  int height;         /* [out] height */
197                                    int aspect_ratio;   /* [out] aspect ratio */
198      int min_quant[3];       /* [out] */                                  int par_width;      /* [out] aspect ratio width */
199      int max_quant[3];       /* [out] */                                  int par_height;     /* [out] aspect ratio height */
200                            } vol;
201      xvid_image_t reference; /* [out] -> [out] */                  } data;
202      xvid_image_t current;   /* [out] -> [in,out] */          } XVID_DEC_STATS;
     xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */  
     int frame_num;          /* [out] frame number */  
   
     int type;               /* [in,out] */  
     int quant;              /* [in,out] */  
   
     int * dquant;               /* [in,out]     pointer to diff quantizer table */  
         int dquant_stride;              /* [in,out]     diff quantizer stride */  
   
     int vop_flags;          /* [in,out] */  
     int vol_flags;          /* [in,out] */  
     int motion_flags;       /* [in,out] */  
   
     int length;                 /* [out] after: length of encoded frame */  
     int kblks, mblks, ublks;    /* [out] after: */  
     int sse_y, sse_u, sse_v;    /* [out] */  
 } xvid_plg_data_t;  
   
   
 /*****************************************************************************  
   xvid plugin system -- external  
   
   the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array  
   indicates the plugin function pointer and plugin-specific data.  
   xvidcore handles the rest. example:  
   
   xvid_enc_create_t create;  
   xvid_enc_plugin_t plugins[2];  
   
   plugins[0].func = xvid_psnr_func;  
   plugins[0].param = NULL;  
   plugins[1].func = xvid_cbr_func;  
   plugins[1].param = &cbr_data;  
   
   create.num_plugins = 2;  
   create.plugins = plugins;  
   
  ****************************************************************************/  
203    
 typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);  
204    
205  typedef struct  typedef struct
206  {  {
207      xvid_plugin_func * func;                  int general;
208      void * param;                  void *bitstream;
209  } xvid_enc_plugin_t;                  int length;
   
   
 xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */  
 xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */  
 xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */  
   
 xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  
   
 xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */  
 xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */  
210    
211                    void *image;
212                    int stride;
213                    int colorspace;
214            } XVID_DEC_FRAME;
215    
216    
217  typedef struct          /* single pass rate control */          /* This struct is used for per slice rendering */
218            typedef struct
219  {  {
220      int version;                  void *y,*u,*v;
221      int bitrate;                                /* bits per second */                  int stride_y, stride_u,stride_v;
222      int reaction_delay_factor;          } XVID_DEC_PICTURE;
     int averaging_period;  
     int buffer;  
 } xvid_plugin_single_t;  
   
   
 typedef struct {  
     int version;  
     char * filename;  
 } xvid_plugin_2pass1_t;  
   
223    
 #define XVID_PAYBACK_BIAS   0   /* payback with bias */  
 #define XVID_PAYBACK_PROP   1   /* payback proportionally */  
224    
225  typedef struct {  /*****************************************************************************
226      int version;   * Decoder entry point
227      int bitrate;                                /* bits per second */   ****************************************************************************/
     char * filename;  
   
     int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */  
     int payback_method;  
     int bitrate_payback_delay;  
     int curve_compression_high;  
     int curve_compression_low;  
     int max_overflow_improvement;  
     int max_overflow_degradation;  
   
     int kftreshold;  
         int kfreduction;  
     int min_key_interval;  
228    
229          int container_frame_overhead;  /* decoder options */
230  }xvid_plugin_2pass2_t;  #define XVID_DEC_DECODE  0
231    #define XVID_DEC_CREATE  1
232    #define XVID_DEC_DESTROY 2
233    
234            int xvid_decore(void *handle,
235                                            int opt,
236                                            void *param1,
237                                            void *param2);
238    
239    
240  /*****************************************************************************  /*****************************************************************************
241   * xvid_encore()   * Encoder constants
242   ****************************************************************************/   ****************************************************************************/
243    
244  /* Encoder options */  /* Flags for XVID_ENC_PARAM.global */
245  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */  #define XVID_GLOBAL_PACKED      0x00000001 /* packed bitstream */
246  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */  #define XVID_GLOBAL_DX50BVOP    0x00000002 /* dx50 bvop compatibility */
247  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes  #define XVID_GLOBAL_DEBUG       0x00000004 /* print debug info on each frame */
248                                                                          0 means this frame should not be written (ie. encoder lag) */  #define XVID_GLOBAL_REDUCED     0x04000000 /* reduced resolution vop enable */
249    
250  int xvid_encore(void *handle, int opt, void *param1, void *param2);  #define XVID_GLOBAL_EXTRASTATS  0x00000200 /* generate extra statistics */
251    
252    
253  /* global flags  */  /* Flags for XVID_ENC_FRAME.general */
254  typedef enum  #define XVID_VALID_FLAGS        0x80000000
 {  
     XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */  
     XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */  
     XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004  
 /*define XVID_GLOBAL_VOL_AT_IVOP        0x00000008       write vol at every ivop: WIN32/divx compatibility */  
 /*define XVID_GLOBAL_FORCE_VOL          0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */  
 } xvid_global_t;  
255    
256    #define XVID_CUSTOM_QMATRIX     0x00000004 /* use custom quant matrix */
257    #define XVID_H263QUANT          0x00000010
258    #define XVID_MPEGQUANT          0x00000020
259    #define XVID_HALFPEL            0x00000040 /* use halfpel interpolation */
260    #define XVID_QUARTERPEL         0x02000000
261    #define XVID_ADAPTIVEQUANT      0x00000080
262    #define XVID_LUMIMASKING        0x00000100
263    
264  /* XVID_ENC_ENCODE param1 */  #define XVID_INTERLACING        0x00000400 /* enable interlaced encoding */
265  /* vol-based flags */  #define XVID_TOPFIELDFIRST      0x00000800 /* set top-field-first flag  */
266  typedef enum {  #define XVID_ALTERNATESCAN      0x00001000 /* set alternate vertical scan flag */
     XVID_VOL_MPEGQUANT          = 0x00000001,  
     XVID_VOL_EXTRASTATS         = 0x00000002,  
     XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */  
     XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */  
     XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */  
     XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */  
 } xvid_vol_t;  
267    
268    #define XVID_HINTEDME_GET       0x00002000 /* receive mv hint data from core (1st pass) */
269    #define XVID_HINTEDME_SET       0x00004000 /* send mv hint data to core (2nd pass) */
270    
271  /* vop-based flags */  #define XVID_INTER4V            0x00008000
 typedef enum {  
     XVID_VOP_DEBUG              = 0x00000001,  
272    
273      XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */  #define XVID_ME_ZERO            0x00010000
274      XVID_VOP_INTER4V            = 0x00000008,  #define XVID_ME_LOGARITHMIC     0x00020000
275    #define XVID_ME_FULLSEARCH      0x00040000
276    #define XVID_ME_PMVFAST         0x00080000
277    #define XVID_ME_EPZS            0x00100000
278    
279      XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */  #define XVID_CHROMAOPT          0x00200000 /* enable chroma optimization pre-filter */
280    
281      XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */  #define XVID_GREYSCALE          0x01000000 /* enable greyscale only mode (even for
     XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for  
282                                                color input material chroma is ignored) */                                                color input material chroma is ignored) */
     XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */  
     XVID_VOP_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */  
   
         /* only valid for vol_flags|=XVID_VOL_INTERLACING */  
     XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */  
     XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */  
   
     /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  
     XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */  
 } xvid_vop_t;  
   
   
 typedef enum {  
     XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */  
     XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */  
   
     XVID_ME_HALFPELREFINE16     = 0x00020000,  
     XVID_ME_HALFPELREFINE8      = 0x02000000,  
   
     XVID_ME_QUARTERPELREFINE16  = 0x00040000,  
     XVID_ME_QUARTERPELREFINE8   = 0x04000000,  
283    
284      XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */  #define XVID_GMC                0x10000000
285    #define XVID_GMC_TRANSLATIONAL  0x20000000
286    
287      XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */  #define XVID_REDUCED            0x04000000 /* reduced resolution vop */
288      XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */  #define XVID_HQACPRED           0x08000000 /* 20030209: high quality ac prediction */
     XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */  
289    
290      XVID_ME_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */  #define XVID_EXTRASTATS         0x00000200 /* generate extra statistics */
     XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */  
291    
292      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */  #define XVID_MODEDECISION_BITS  0x00400000 /* enable DCT-ME and use it for mode decision */
     XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */  
     XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */  
     XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */  
     XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */  
293    
     XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern  
                                                   enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */  
     XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */  
294    
295      XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */  /* Flags for XVID_ENC_FRAME.motion */
296      XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */  #define PMV_ADVANCEDDIAMOND16   0x00008000 /* use advdiamonds instead of diamonds as search pattern */
297      XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */  #define PMV_USESQUARES16        0x00800000 /* use squares instead of diamonds as search pattern */
     XVID_ME_OVERLAPPING8        = 0x40000000, /* overlapping ME, not implemented */  
298    
299      XVID_GME_REFINE  = 0x00010000  #define PMV_HALFPELREFINE16     0x00020000
300    #define PMV_HALFPELREFINE8      0x02000000
301    
302  } xvid_motion_t;  #define PMV_QUARTERPELREFINE16  0x00040000
303    #define PMV_QUARTERPELREFINE8   0x04000000
304    
305    #define PMV_EXTSEARCH16         0x00080000 /* extend PMV by more searches */
306    
307  /* XVID_ENC_CREATE param1 */  #define PMV_EXTSEARCH8          0x08000000 /* use diamond/square for extended 8x8 search */
308  typedef struct {  #define PMV_ADVANCEDDIAMOND8    0x00004000 /* use advdiamond for PMV_EXTSEARCH8 */
309          int version;  #define PMV_USESQUARES8         0x80000000 /* use square for PMV_EXTSEARCH8 */
310    
311      int profile;            /* [in]     profile@level; refer to XVID_PROFILE_xxx */  #define PMV_CHROMA16            0x00100000 /* also use chroma for P_VOP/S_VOP ME */
312          int width;                              /* [in]         frame dimensions; width, pixel units */  #define PMV_CHROMA8             0x10000000 /* also use chroma for B_VOP ME */
         int height;                             /* [in]         frame dimensions; height, pixel units */  
313    
314      int num_zones;          /* [in:opt] number of bitrate zones */  /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */
315      xvid_enc_zone_t * zones; /*             ^^ zone array */  #define HALFPELREFINE16_BITS    0x00000100 /* perform DCT-based halfpel refinement */
316    #define HALFPELREFINE8_BITS     0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */
317    #define QUARTERPELREFINE16_BITS 0x00000400 /* perform DCT-based qpel refinement */
318    #define QUARTERPELREFINE8_BITS  0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */
319    
320      int num_plugins;        /* [in:opt] number of plugins */  #define EXTSEARCH_BITS          0x00001000 /* perform DCT-based search using square pattern
321      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */                                                enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
322    #define CHECKPREDICTION_BITS    0x00002000 /* always check vector equal to prediction */
323    
         int num_threads;                /* [in:opt]     number of threads */  
         int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */  
324    
325          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */  /* note: old and deprecated - or never implemented */
326    
327  /* --- vol-based stuff; included here for conveinience */  /* only for compatability with old encoders */
         int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */  
         int fbase;                              /* [in] framerate base  
                                                                                 frame_duration = fincr/fbase seconds*/  
 /* ^^^---------------------------------------------- */  
328    
329    #define PMV_EARLYSTOP16         0x00
330    #define PMV_EARLYSTOP8          0x00
331    #define PMV_QUICKSTOP16         0x00
332    #define PMV_QUICKSTOP8          0x00
333    
334  /* ---vop-based; included here for conveienience */  #define PMV_HALFPELDIAMOND16    0x00
335          int max_key_interval;   /* [in:opt] the maximum interval between key frames */  #define PMV_HALFPELDIAMOND8     0x00
                                                                                 /*XXX: maybe call it gop_size? */  
336    
337          int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */  #define PMV_UNRESTRICTED16      0x00200000 /* unrestricted ME, not implemented */
338    #define PMV_OVERLAPPING16       0x00400000 /* overlapping ME, not implemented */
339    #define PMV_UNRESTRICTED8       0x20000000 /* unrestricted ME, not implemented */
340    #define PMV_OVERLAPPING8        0x40000000 /* overlapping ME, not implemented */
341    
342          int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */  #define XVID_ME_COLOUR          0x00       /* this has been converted to PMV_CHROMA[16/8] */
         int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */  
343    
     int min_quant[3];       /* [in:opt] */  
     int max_quant[3];       /* [in:opt] */  
344    
345  /* ^^^ -------------------------------------------------------------------------*/  /*****************************************************************************
346     * Encoder structures
347     ****************************************************************************/
348    
349            typedef struct
350            {
351                    int width, height;
352                    int fincr, fbase;             /* [in] frame increment, fbase. each frame = "fincr/fbase" seconds */
353                    int rc_bitrate;               /* [in] the bitrate of the target encoded stream, in bits/second */
354                    int rc_reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */
355                    int rc_averaging_period;      /* [in] as above */
356                    int rc_buffer;                /* [in] as above */
357                    int max_quantizer;            /* [in] the upper limit of the quantizer */
358                    int min_quantizer;            /* [in] the lower limit of the quantizer */
359                    int max_key_interval;         /* [in] the maximum interval between key frames */
360    #ifdef _SMP
361                    int num_threads;              /* [in] number of threads */
362    #endif
363                    int global;                   /* [in] global/debug options */
364                    int max_bframes;              /* [in] max sequential bframes (0=disable bframes) */
365                    int bquant_ratio;             /* [in] bframe quantizer multipier (percentage).
366                                                  used only when bquant < 1
367                                                  eg. 200 = x2 multiplier
368                                                      quant = ((past_quant + future_quant) * bquant_ratio)/200
369                                           */
370                    int bquant_offset;            /* [in] bquant += bquant_offset */
371                    int frame_drop_ratio;         /* [in] frame dropping: 0=drop none... 100=drop all */
372          void *handle;                   /* [out] encoder instance handle */          void *handle;                   /* [out] encoder instance handle */
373  }          } XVID_ENC_PARAM;
 xvid_enc_create_t;  
   
   
 #define XVID_KEYFRAME   0x00000001  
374    
375  typedef struct {          typedef struct
376          int version;          {
377                    int x;
378                    int y;
379            } VECTOR;
380    
381  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any          typedef struct
382                  changes here until the next VOL (keyframe). */          {
383          xvid_vol_t vol_flags;                   /* [in] vol flags */                  int mode;      /* macroblock mode */
384          unsigned char *                  VECTOR mvs[4];
385                  quant_intra_matrix;     /* [in:opt] custom intra qmatrix */          } MVBLOCKHINT;
         unsigned char *  
                 quant_inter_matrix;     /* [in:opt] custom inter qmatrix */  
386    
387          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */          typedef struct
388          int par_width;                  /* [in:opt] aspect ratio width */          {
389          int par_height;                 /* [in:opt] aspect ratio height */                  int intra;          /* frame intra choice */
390  /* ^^^----------------------------------------------------------------------------------*/                  int fcode;          /* frame fcode */
391                    MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */
392            } MVFRAMEHINT;
393    
394      int fincr;                          /* framerate increment, for variable framerate only */          typedef struct
395          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */          {
396          xvid_motion_t motion;                           /* [in] ME options */                  int rawhints;       /* if set, use MVFRAMEHINT, else use compressed buffer */
397    
398          xvid_image_t input;     /* [in] input image (read from) */                  MVFRAMEHINT mvhint;
399                    void *hintstream;   /* compressed hint buffer */
400                    int hintlength;     /* length of buffer (bytes) */
401            } HINTINFO;
402    
403          int type;                               /* [in:opt] coding type */          typedef struct
404          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          {
405          int bframe_threshold;                  int general;                       /* [in] general options */
406                    int motion;                        /* [in] ME options */
407                    void *bitstream;                   /* [in] bitstream ptr */
408                    int length;                        /* [out] bitstream length (bytes) */
409    
410                    void *image;                       /* [in] image ptr */
411                    int stride;                        /* [in] horizontal stride in bytes */
412                    int colorspace;                    /* [in] source colorspace */
413    
414                    unsigned char *quant_intra_matrix; /* [in] custom intra qmatrix */
415                    unsigned char *quant_inter_matrix; /* [in] custom inter qmatrix */
416                    int quant;                         /* [in] frame quantizer (vbr) */
417                    int intra;                         /* [in] force intra frame (vbr only)
418                                                  [out] frame type (ugly atm)
419                                                */
420                    HINTINFO hint;                     /* [in/out] mv hint information */
421    
422          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/                  int bquant;                        /* [in] bframe quantizer */
423          int length;                             /* [in:opt] bitstream length (bytes) */                  int bframe_threshold;                      /* [in] sensitivity of B-frame decision */
424    
425          int out_flags;                          /* [out] bitstream output flags */          } XVID_ENC_FRAME;
 }  
 xvid_enc_frame_t;  
426    
427    
428  /* XVID_ENC_ENCODE param2 (optional)          typedef struct
429          xvid_enc_stats_t describes individual frame details          {
430                    int quant;   /* [out] frame quantizer */
431                    int hlength; /* [out] header length (bytes) */
432                    int kblks;   /* [out] number of intra blocks */
433                    int mblks;   /* [out] number of inter blocks */
434                    int ublks;       /* [out] number of "not coded" blocks */
435                    long sse_y;  /* [out] SSE of Y */
436                    long sse_u;  /* [out] SSE of Cb */
437                    long sse_v;  /* [out] SSE of Cr */
438            } XVID_ENC_STATS;
439    
         coding_type==XVID_TYPE_NOTHING if the stats are not given  
 */  
 typedef struct {  
         int version;  
440    
441          /* encoding parameters */  /*****************************************************************************
442          int type;                                       /* [out] coding type */   * Encoder entry point
443          int quant;                                      /* [out] frame quantizer */   ****************************************************************************/
         xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */  
         int vop_flags;                          /* [out] vop flags (see above) */  
         /* bitrate */  
         int length;                                     /* [out] frame length */  
444    
445          int hlength;                            /* [out] header length (bytes) */  /* Encoder options */
446          int kblks, mblks, ublks;        /* [out] */  #define XVID_ENC_ENCODE  0
447    #define XVID_ENC_CREATE  1
448    #define XVID_ENC_DESTROY 2
449    
450            int xvid_encore(void *handle,
451                                            int opt,
452                                            void *param1,
453                                            void *param2);
454    
     int sse_y, sse_u, sse_v;  
 }  
 xvid_enc_stats_t;  
455    
456  #ifdef __cplusplus  #ifdef __cplusplus
457  }  }
458  #endif  #endif
459    
   
460  #endif  #endif
Legend:
Removed from v.1.27.2.26  
changed lines
  Added in v.1.31
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4