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