[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.26, Sat Feb 15 18:48:15 2003 UTC revision 1.27.2.32, Thu Aug 7 15:42:20 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>
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
10  *  the Free Software Foundation ; either version 2 of the License, or  *  the Free Software Foundation ; either version 2 of the License, or
# Line 17  Line 19 
19  *  along with this program ; if not, write to the Free Software  *  along with this program ; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21  *  *
 *****************************************************************************/  
 /*****************************************************************************  
 *  
 *  History  
 *  
 *  - 2002/06/13 Added legal header, ANSI C comment style (only for this header  
 *               as it can be included in a ANSI C project).  
 *  
 *               ToDo ? : when BFRAMES is defined, the API_VERSION should not  
 *                        be the same (3.0 ?)  
 *  
22  *  $Id$  *  $Id$
23  *  *
24  *****************************************************************************/   ****************************************************************************/
   
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
29    
30  #ifdef __cplusplus  #ifdef __cplusplus
31  extern "C" {  extern "C" {
32  #endif  #endif
33    
34  /*****************************************************************************  /*****************************************************************************
35   * Global constants   * versioning
36   ****************************************************************************/   ****************************************************************************/
37    
38  /* API Version : 2.1 */  /* versioning
39  #define API_VERSION ((2 << 16) | (1))          version takes the form "$major.$minor.$patch"
40  #define XVID_API_UNSTABLE          $patch is incremented when there is no api change
41            $minor is incremented when the api is changed, but remains backwards compatible
42            $major is incremented when the api is changed significantly
43    
44            when initialising an xvid structure, you must always zero it, and set the version field.
45                    memset(&struct,0,sizeof(struct));
46                    struct.version = XVID_VERSION;
47    
48            XVID_UNSTABLE is defined only during development.
49            */
50    
51    #define XVID_MAKE_VERSION(a,b,c) ((((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff))
52    #define XVID_VERSION_MAJOR(a)    (((a)>>16) & 0xff)
53    #define XVID_VERSION_MINOR(a)    (((a)>> 8) & 0xff)
54    #define XVID_VERSION_PATCH(a)    (((a)>> 0) & 0xff)
55    
56    #define XVID_MAKE_API(a,b)       ((((a)&0xff)<<16) | (((b)&0xff)<<0))
57    #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)
58    #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)
59    
60    #define XVID_VERSION             XVID_MAKE_VERSION(1,-127,0)
61    #define XVID_API                 XVID_MAKE_API(4, 0)
62    
63    #define XVID_UNSTABLE
64    
65  /* Bitstream Version  /* Bitstream Version
66   * 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 59  Line 73 
73   * doesnt hurt but not increasing it could cause difficulty for decoders in the   * doesnt hurt but not increasing it could cause difficulty for decoders in the
74   * future   * future
75   */   */
76  #define XVID_BS_VERSION "0009"  #define XVID_BS_VERSION "0017"
77    
78    
79    /*****************************************************************************
80     * error codes
81     ****************************************************************************/
82    
83  /* Error codes */          /*      all functions return values <0 indicate error */
 #define XVID_ERR_FAIL           -1  
 #define XVID_ERR_OK                     0  
 #define XVID_ERR_MEMORY         1  
 #define XVID_ERR_FORMAT         2  
84    
85    #define XVID_ERR_FAIL           -1              /* general fault */
86    #define XVID_ERR_MEMORY         -2              /* memory allocation error */
87    #define XVID_ERR_FORMAT         -3              /* file format error */
88    #define XVID_ERR_VERSION        -4              /* structure version not supported */
89    #define XVID_ERR_END            -5              /* encoder only; end of stream reached */
90    
 /* Colorspaces */  
 #define XVID_CSP_RGB24  0               /* [b|g|r] */  
 #define XVID_CSP_YV12   1  
 #define XVID_CSP_YUY2   2  
 #define XVID_CSP_UYVY   3  
 #define XVID_CSP_I420   4  
 #define XVID_CSP_RGB555 10  
 #define XVID_CSP_RGB565 11  
 #define XVID_CSP_USER   12  
 #define XVID_CSP_EXTERN      1004  // per slice rendering  
 #define XVID_CSP_YVYU   1002  
 #define XVID_CSP_RGB32  1000    /* [b|g|r|a] */  
 #define XVID_CSP_ABGR   1006    /* [a|b|g|r] */  
 #define XVID_CSP_RGBA   1005    /* [r|g|b|a] */  
91    
92    
93    /*****************************************************************************
94     * xvid_image_t
95     ****************************************************************************/
96    
97  #define XVID_CSP_NULL   9999  /* colorspace values */
98    
99  #define XVID_CSP_VFLIP  0x80000000      // flip mask  #define XVID_CSP_USER     (1<< 0) /* 4:2:0 planar */
100    #define XVID_CSP_I420     (1<< 1) /* 4:2:0 packed(planar win32) */
101    #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 packed(planar win32) */
102    #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */
103    #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */
104    #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */
105    #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
106    #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
107    #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
108    #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
109    #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
110    #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
111    #define XVID_CSP_SLICE    (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */
112    #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
113    #define XVID_CSP_NULL     (1<<14) /* decoder only: dont output anything */
114    #define XVID_CSP_VFLIP    (1<<31) /* vertical flip mask */
115    
116    /* xvid_image_t
117            for non-planar colorspaces use only plane[0] and stride[0]
118            four plane reserved for alpha*/
119    typedef struct {
120            int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
121            void * plane[4];                /* [in] image plane ptrs */
122            int stride[4];                  /* [in] image stride; "bytes per row"*/
123    } xvid_image_t;
124    
125    /* video-object-sequence profiles */
126    #define XVID_PROFILE_S_L0    0x08 /* simple */
127    #define XVID_PROFILE_S_L1    0x01
128    #define XVID_PROFILE_S_L2    0x02
129    #define XVID_PROFILE_S_L3    0x03
130    #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
131    #define XVID_PROFILE_ARTS_L2 0x92
132    #define XVID_PROFILE_ARTS_L3 0x93
133    #define XVID_PROFILE_ARTS_L4 0x94
134    #define XVID_PROFILE_AS_L0   0xf0 /* advanced simple */
135    #define XVID_PROFILE_AS_L1   0xf1
136    #define XVID_PROFILE_AS_L2   0xf2
137    #define XVID_PROFILE_AS_L3   0xf3
138    #define XVID_PROFILE_AS_L4   0xf4
139    
140    /* aspect ratios */
141    #define XVID_PAR_11_VGA    1 /* 1:1 vga (square) */
142    #define XVID_PAR_43_PAL    2 /* 4:3 pal (12:11 625-line) */
143    #define XVID_PAR_43_NTSC   3 /* 4:3 ntsc (10:11 525-line) */
144    #define XVID_PAR_169_PAL   4 /* 16:9 pal (16:11 625-line) */
145    #define XVID_PAR_169_NTSC  5 /* 16:9 ntsc (40:33 525-line) */
146    #define XVID_PAR_EXT      15 /* extended par; use par_width, par_height */
147    
148    /* frame type flags */
149    #define XVID_TYPE_VOL     -1 /* decoder only: vol was decoded */
150    #define XVID_TYPE_NOTHING  0 /* decoder only (encoder stats): nothing was decoded/encoded */
151    #define XVID_TYPE_AUTO     0 /* encoder: automatically determine coding type */
152    #define XVID_TYPE_IVOP     1 /* intra frame */
153    #define XVID_TYPE_PVOP     2 /* predicted frame */
154    #define XVID_TYPE_BVOP     3 /* bidirectionally encoded */
155    #define XVID_TYPE_SVOP     4 /* predicted+sprite frame */
156    
157    
158  /*****************************************************************************  /*****************************************************************************
159   *  Initialization constants   * xvid_global()
160   ****************************************************************************/   ****************************************************************************/
161    
162  /* CPU flags for XVID_INIT_PARAM.cpu_flags */  /* cpu_flags definitions */
 #define XVID_CPU_FORCE          0x80000000  
 #define XVID_CPU_CHKONLY        0x40000000              /* check cpu only; dont init globals */  
163    
164  #define XVID_CPU_ASM            0x00000080              /* native assembly */  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
165    #define XVID_CPU_ASM      (1<< 7) /* native assembly */
166  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
167  #define XVID_CPU_MMX            0x00000001              /* mmx: pentiumMMX,k6 */  #define XVID_CPU_MMX      (1<< 0) /*       mmx : pentiumMMX,k6 */
168  #define XVID_CPU_MMXEXT         0x00000002              /* mmxx-ext: pentium2,athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
169  #define XVID_CPU_SSE            0x00000004              /* sse: pentium3,athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
170  #define XVID_CPU_SSE2           0x00000008              /* sse2: pentium4,athlon64 */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
171  #define XVID_CPU_3DNOW          0x00000010              /* 3dnow: k6-2 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
172  #define XVID_CPU_3DNOWEXT       0x00000020              /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
173  #define XVID_CPU_TSC            0x00000040              /* timestamp counter */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
 /* ARCH_IS_IA64 */  
 #define XVID_CPU_IA64           XVID_CPU_ASM    /* defined for backward compatibility */  
174  /* ARCH_IS_PPC */  /* ARCH_IS_PPC */
175  #define XVID_CPU_ALTIVEC        0x00000001              /* altivec */  #define XVID_CPU_ALTIVEC  (1<< 0) /* altivec */
176    
177    
178          typedef struct  #define XVID_DEBUG_ERROR     (1<< 0)
179          {  #define XVID_DEBUG_STARTCODE (1<< 1)
180                  int colorspace;  #define XVID_DEBUG_HEADER    (1<< 2)
181                  void * y;  #define XVID_DEBUG_TIMECODE  (1<< 3)
182                  void * u;  #define XVID_DEBUG_MB        (1<< 4)
183                  void * v;  #define XVID_DEBUG_COEFF     (1<< 5)
184                  int y_stride;  #define XVID_DEBUG_MV        (1<< 6)
185                  int uv_stride;  #define XVID_DEBUG_RC        (1<< 7)
186          } XVID_IMAGE;           /* from yv12 */  #define XVID_DEBUG_DEBUG     (1<<31)
187    
188  #define XVID_INIT_INIT          0  /* XVID_GBL_INIT param1 */
189  #define XVID_INIT_CONVERT       1  typedef struct {
190  #define XVID_INIT_TEST          2          int version;
191            unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */
192            int debug;     /* [in:opt] debug level */
193    } xvid_gbl_init_t;
194    
195    
196    /* XVID_GBL_INFO param1 */
197    typedef struct {
198            int version;
199            int actual_version; /* [out] returns the actual xvidcore version */
200            const char * build; /* [out] if !null, points to description of this xvid core build */
201            unsigned int cpu_flags;      /* [out] detected cpu features */
202            int num_threads;    /* [out] detected number of cpus/threads */
203    } xvid_gbl_info_t;
204    
205    
206    /* XVID_GBL_CONVERT param1 */
207    typedef struct {
208            int version;
209            xvid_image_t input;  /* [in] input image & colorspace */
210            xvid_image_t output; /* [in] output image & colorspace */
211            int width;           /* [in] width */
212            int height;          /* [in] height */
213            int interlacing;     /* [in] interlacing */
214    } xvid_gbl_convert_t;
215    
216    
217    #define XVID_GBL_INIT    0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
218    #define XVID_GBL_INFO    1 /* return some info about xvidcore, and the host computer */
219    #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
220    #define XVID_GBL_TEST    3 /* testing.. */
221    
222    int xvid_global(void *handle, int opt, void *param1, void *param2);
223    
224    
225  /*****************************************************************************  /*****************************************************************************
226   *  Initialization structures   * xvid_decore()
227   ****************************************************************************/   ****************************************************************************/
228    
229          typedef struct  #define XVID_DEC_CREATE  0 /* create decore instance; return 0 on success */
230          {  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
231                  int cpu_flags;  #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */
232                  int api_version;  
233                  int core_build;  int xvid_decore(void *handle, int opt, void *param1, void *param2);
234          }  
235          XVID_INIT_PARAM;  /* XVID_DEC_CREATE param 1
236            image width & height may be specified here when the dimensions are
237            known in advance. */
238    typedef struct {
239            int version;
240            int width;     /* [in:opt] image width */
241            int height;    /* [in:opt] image width */
242            void * handle; /* [out]    decore context handle */
243    } xvid_dec_create_t;
244    
245    
246    /* XVID_DEC_DECODE param1 */
247    /* general flags */
248    #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
249    #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
250    
251    typedef struct {
252            int version;
253            int general;         /* [in:opt] general flags */
254            void *bitstream;     /* [in]     bitstream (read from)*/
255            int length;          /* [in]     bitstream length */
256            xvid_image_t output; /* [in]     output image (written to) */
257    } xvid_dec_frame_t;
258    
259    
260    /* XVID_DEC_DECODE param2 :: optional */
261    typedef struct
262    {
263            int version;
264    
265            int type;                   /* [out] output data type */
266            union {
267                    struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
268                            int general;        /* [out] flags */
269                            int time_base;      /* [out] time base */
270                            int time_increment; /* [out] time increment */
271    
272          typedef struct                          /* XXX: external deblocking stuff */
273          {                          int * qscale;       /* [out] pointer to quantizer table */
274                  XVID_IMAGE input;                          int qscale_stride;  /* [out] quantizer scale stride */
                 XVID_IMAGE output;  
                 int width;  
                 int height;  
                 int interlacing;  
         } XVID_INIT_CONVERTINFO;  
275    
276  /*****************************************************************************                  } vop;
277   *  Initialization entry point                  struct {        /* XVID_TYPE_VOL */
278   ****************************************************************************/                          int general;        /* [out] flags */
279                            int width;          /* [out] width */
280                            int height;         /* [out] height */
281                            int par;            /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */
282                            int par_width;      /* [out] aspect ratio width */
283                            int par_height;     /* [out] aspect ratio height */
284                    } vol;
285            } data;
286    } xvid_dec_stats_t;
287    
         int xvid_init(void *handle,  
                                   int opt,  
                                   void *param1,  
                                   void *param2);  
288    
289    
290  /*****************************************************************************  #define XVID_ZONE_QUANT  (1<<0)
291   * Decoder constants  #define XVID_ZONE_WEIGHT (1<<1)
292   ****************************************************************************/  
293    typedef struct
294    {
295            int frame;
296            int mode;
297            int increment;
298            int base;
299    } xvid_enc_zone_t;
300    
301    
 /* Flags for XVID_DEC_FRAME.general */  
 #define XVID_DEC_LOWDELAY               0x00000001      /* decode lowdelay mode (ie. video-for-windows) */  
 #define XVID_DEC_DEBLOCKY               0x00000002      /* luma deblocking */  
 #define XVID_DEC_DEBLOCKUV              0x00000008      /* chroma deblocking */  
 #define XVID_DEC_DISCONTINUITY  0x00000004      /* indicates break in stream; instructs  
                                                                                         decoder to ignore any previous reference frames */  
 #define XVID_QUICK_DECODE               0x00000010  
302    
303  /*****************************************************************************  /*****************************************************************************
304   * Decoder structures    xvid plugin system -- internals
305    
306      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
307      before encoding each frame xvidcore will call XVID_PLG_BEFORE
308      after encoding each frame xvidcore will call XVID_PLG_AFTER
309      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
310   ****************************************************************************/   ****************************************************************************/
311    
         typedef struct  
         {  
                 int width;  
                 int height;  
                 void *handle;  
         }  
         XVID_DEC_PARAM;  
312    
313    #define XVID_PLG_CREATE  (1<<0)
314    #define XVID_PLG_DESTROY (1<<1)
315    #define XVID_PLG_INFO    (1<<2)
316    #define XVID_PLG_BEFORE  (1<<3)
317    #define XVID_PLG_AFTER   (1<<4)
318    
319    /* xvid_plg_info_t.flags */
320    #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
321    #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
322    #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
323    
 #define XVID_DEC_VOP    0  
 #define XVID_DEC_VOL    1  
 #define XVID_DEC_NOTHING        2       /* nothing was decoded */  
324    
325          typedef struct          typedef struct
326          {          {
327                  int notify;                     /* [out]        output 'mode' */          int version;
328                  union          int flags;   /* [in:opt] plugin flags */
329                  {  } xvid_plg_info_t;
                         struct  /* XVID_DEC_VOP */  
                         {  
                                 int time_base;          /* [out]        time base */  
                                 int time_increment;     /* [out]        time increment */  
                         } vop;  
                         struct  /* XVID_DEC_VOL */  
                         {  
                                 int general;            /* [out]        flags: eg. frames are interlaced */  
                                 int width;                      /* [out]        width */  
                                 int height;                     /* [out]        height */  
                                 int aspect_ratio;       /* [out]        aspect ratio */  
                                 int par_width;          /* [out]        aspect ratio width */  
                                 int par_height;         /* [out]        aspect ratio height */  
                         } vol;  
                 } data;  
         } XVID_DEC_STATS;  
330    
331    
332          typedef struct          typedef struct
333          {          {
334                  int general;          int version;
335                  void *bitstream;  
336                  int length;          int num_zones;           /* [out] */
337            xvid_enc_zone_t * zones; /* [out] */
338                  void *image;  
339                  int stride;          int width;               /* [out] */
340                  int colorspace;          int height;              /* [out] */
341          }          int mb_width;            /* [out] */
342          XVID_DEC_FRAME;          int mb_height;           /* [out] */
343            int fincr;               /* [out] */
344            int fbase;               /* [out] */
345    
346            void * param;            /* [out] */
347    } xvid_plg_create_t;
348    
349    
         // This struct is used for per slice rendering  
350          typedef struct          typedef struct
351          {          {
352                  void *y,*u,*v;          int version;
                 int stride_y, stride_u,stride_v;  
         } XVID_DEC_PICTURE;  
353    
354            int num_frames; /* [out] total frame encoded */
355    } xvid_plg_destroy_t;
356    
 /*****************************************************************************  
  * Decoder entry point  
  ****************************************************************************/  
357    
358  /* decoder options */  typedef struct
359  #define XVID_DEC_DECODE         0  {
360  #define XVID_DEC_CREATE         1          int version;
 #define XVID_DEC_DESTROY        2  
   
         int xvid_decore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
361    
362            xvid_enc_zone_t * zone; /* [out] current zone */
363    
364  /*****************************************************************************          int width;              /* [out] */
365   * Encoder constants          int height;             /* [out] */
366   ****************************************************************************/          int mb_width;           /* [out] */
367            int mb_height;          /* [out] */
368            int fincr;              /* [out] */
369            int fbase;              /* [out] */
370    
371  /* Flags for XVID_ENC_PARAM.global */          int min_quant[3];       /* [out] */
372  #define XVID_GLOBAL_PACKED              0x00000001      /* packed bitstream */          int max_quant[3];       /* [out] */
 #define XVID_GLOBAL_DX50BVOP    0x00000002      /* dx50 bvop compatibility */  
 #define XVID_GLOBAL_DEBUG               0x00000004      /* print debug info on each frame */  
 #define XVID_GLOBAL_REDUCED             0x04000000      /* reduced resolution vop enable */  
373    
374  #define XVID_GLOBAL_EXTRASTATS  0x00000200      /* generate extra statistics */          xvid_image_t reference; /* [out] -> [out] */
375            xvid_image_t current;   /* [out] -> [in,out] */
376            xvid_image_t original;  /* [out] after: points the original (uncompressed) copy of the current frame */
377            int frame_num;          /* [out] frame number */
378    
379            int type;               /* [in,out] */
380            int quant;              /* [in,out] */
381    
382  /* Flags for XVID_ENC_FRAME.general */          int * dquant;           /* [in,out]     pointer to diff quantizer table */
383  #define XVID_VALID_FLAGS                0x80000000          int dquant_stride;      /* [in,out]     diff quantizer stride */
384    
385  #define XVID_CUSTOM_QMATRIX             0x00000004      /* use custom quant matrix */          int vop_flags;          /* [in,out] */
386  #define XVID_H263QUANT                  0x00000010          int vol_flags;          /* [in,out] */
387  #define XVID_MPEGQUANT                  0x00000020          int motion_flags;       /* [in,out] */
 #define XVID_HALFPEL                    0x00000040      /* use halfpel interpolation */  
 #define XVID_QUARTERPEL                 0x02000000  
 #define XVID_ADAPTIVEQUANT              0x00000080  
 #define XVID_LUMIMASKING                0x00000100  
388    
389  #define XVID_INTERLACING                0x00000400      /* enable interlaced encoding */          int length;             /* [out] after: length of encoded frame */
390  #define XVID_TOPFIELDFIRST              0x00000800      /* set top-field-first flag  */          int kblks;              /* [out] number of blocks compressed as Intra */
391  #define XVID_ALTERNATESCAN              0x00001000      /* set alternate vertical scan flag */          int mblks;              /* [out] number of blocks compressed as Inter */
392            int ublks;              /* [out] number of blocks marked not_coded */
393            int sse_y;              /* [out] Y plane's sse */
394            int sse_u;              /* [out] U plane's sse */
395            int sse_v;              /* [out] V plane's sse */
396    } xvid_plg_data_t;
397    
 #define XVID_HINTEDME_GET               0x00002000      /* receive mv hint data from core (1st pass) */  
 #define XVID_HINTEDME_SET               0x00004000      /* send mv hint data to core (2nd pass) */  
398    
399  #define XVID_INTER4V                    0x00008000  /*****************************************************************************
400      xvid plugin system -- external
401    
402  #define XVID_ME_ZERO                    0x00010000    the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
403  #define XVID_ME_LOGARITHMIC             0x00020000    indicates the plugin function pointer and plugin-specific data.
404  #define XVID_ME_FULLSEARCH              0x00040000    xvidcore handles the rest. example:
 #define XVID_ME_PMVFAST                 0x00080000  
 #define XVID_ME_EPZS                    0x00100000  
405    
406  #define XVID_CHROMAOPT                  0x00200000      /* enable chroma optimization pre-filter */    xvid_enc_create_t create;
407      xvid_enc_plugin_t plugins[2];
408    
409  #define XVID_GREYSCALE                  0x01000000      /* enable greyscale only mode (even for */    plugins[0].func = xvid_psnr_func;
410                                                                                          /* color input material chroma is ignored) */    plugins[0].param = NULL;
411      plugins[1].func = xvid_cbr_func;
412      plugins[1].param = &cbr_data;
413    
414  #define XVID_GMC                                0x10000000    create.num_plugins = 2;
415  #define XVID_GMC_TRANSLATIONAL  0x20000000    create.plugins = plugins;
416    
417  #define XVID_REDUCED                    0x04000000      /* reduced resolution vop */   ****************************************************************************/
 #define XVID_HQACPRED                   0x08000000      /* 20030209: high quality ac prediction */  
418    
419  #define XVID_EXTRASTATS                 0x00000200  /* generate extra statistics */  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
420    
421  #define XVID_MODEDECISION_BITS  0x00400000      /* enable DCT-ME and use it for mode decision */  typedef struct
422    {
423            xvid_plugin_func * func;
424            void * param;
425    } xvid_enc_plugin_t;
426    
427    
428  /* Flags for XVID_ENC_FRAME.motion */  xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
429    xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
430    xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
431    
432  #define PMV_ADVANCEDDIAMOND16   0x00008000      /* use advdiamonds instead of diamonds as search pattern */  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
 #define PMV_USESQUARES16                0x00800000      /* use squares instead of diamonds as search pattern */  
433    
434  #define PMV_HALFPELREFINE16     0x00020000  xvid_plugin_func xvid_plugin_psnr;      /* write psnr values to stdout */
435  #define PMV_HALFPELREFINE8              0x02000000  xvid_plugin_func xvid_plugin_dump;      /* dump before and after yuvpgms */
436    
 #define PMV_QUARTERPELREFINE16  0x00040000  
 #define PMV_QUARTERPELREFINE8   0x04000000  
437    
438  #define PMV_EXTSEARCH16                 0x00080000      /* extend PMV by more searches */  /* single pass rate control
439     * CBR and Constant quantizer modes */
440    typedef struct
441    {
442            int version;
443    
444  #define PMV_EXTSEARCH8                  0x08000000      /* use diamond/square for extended 8x8 search */          int bitrate;               /* [in] bits per second */
445  #define PMV_ADVANCEDDIAMOND8    0x00004000      /* use advdiamond for PMV_EXTSEARCH8 */          int reaction_delay_factor; /* [in] */
446  #define PMV_USESQUARES8                 0x80000000      /* use square for PMV_EXTSEARCH8 */          int averaging_period;      /* [in] */
447            int buffer;                /* [in] */
448    } xvid_plugin_single_t;
449    
 #define PMV_CHROMA16                    0x00100000      /* also use chroma for P_VOP/S_VOP ME */  
 #define PMV_CHROMA8                             0x10000000      /* also use chroma for B_VOP ME */  
450    
451  /* Motion search using DCT. use XVID_MODEDECISION_DCT to enable */  typedef struct {
452  #define HALFPELREFINE16_BITS    0x00000100      /* perform DCT-based halfpel refinement */          int version;
 #define HALFPELREFINE8_BITS             0x00000200      /* perform DCT-based halfpel refinement for 8x8 mode */  
 #define QUARTERPELREFINE16_BITS 0x00000400      /* perform DCT-based qpel refinement */  
 #define QUARTERPELREFINE8_BITS  0x00000800      /* perform DCT-based qpel refinement for 8x8 mode */  
453    
454  #define EXTSEARCH_BITS                  0x00001000      /* perform DCT-based search using square pattern */          char * filename;
455                                                                                          /* enable PMV_EXTSEARCH8 to do this in 8x8 search as well */  } xvid_plugin_2pass1_t;
 #define CHECKPREDICTION_BITS    0x00002000      /* always check vector equal to prediction */  
456    
457    
458  /* note: old and deprecated - or never implemented */  #define XVID_PAYBACK_BIAS 0 /* payback with bias */
459    #define XVID_PAYBACK_PROP 1 /* payback proportionally */
460    
461  /* only for compatability with old encoders */  typedef struct {
462            int version;
463    
464  #define PMV_EARLYSTOP16                 0x00          int bitrate;                  /* [in] bits per second */
465  #define PMV_EARLYSTOP8                  0x00          char * filename;              /* [in] first pass stats filename */
 #define PMV_QUICKSTOP16                 0x00  
 #define PMV_QUICKSTOP8                  0x00  
466    
467  #define PMV_HALFPELDIAMOND16    0x00          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
468  #define PMV_HALFPELDIAMOND8     0x00          int payback_method;           /* [in] Payback method: see XVID_PAYBACK flags */
469            int bitrate_payback_delay;    /* [in] Payback delay expressed in number of frames */
470            int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
471            int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
472            int max_overflow_improvement; /* [in] */
473            int max_overflow_degradation; /* [in] */
474    
475  #define PMV_UNRESTRICTED16      0x00200000      /* unrestricted ME, not implemented */          int kftreshold;               /* [in] */
476  #define PMV_OVERLAPPING16       0x00400000      /* overlapping ME, not implemented */          int kfreduction;              /* [in] */
477  #define PMV_UNRESTRICTED8       0x20000000      /* unrestricted ME, not implemented */          int min_key_interval;         /* [in] Minimum interval of frames between two IFrames */
 #define PMV_OVERLAPPING8                0x40000000      /* overlapping ME, not implemented */  
478    
479  #define XVID_ME_COLOUR                  0x00    /* this has been converted to PMV_CHROMA[16/8] */          int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
480    }xvid_plugin_2pass2_t;
481    
482    
483  /*****************************************************************************  /*****************************************************************************
484   * Encoder structures   * xvid_encore()
485   ****************************************************************************/   ****************************************************************************/
486    
487          typedef struct  /* Encoder options */
488          {  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
489                  int width, height;  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
490                  int fincr, fbase;               /* frame increment, fbase. each frame = "fincr/fbase" seconds */  #define XVID_ENC_ENCODE  2 /* encode a frame: returns number of ouput bytes
491                  int rc_bitrate;                 /* the bitrate of the target encoded stream, in bits/second */                              * 0 means this frame should not be written (ie. encoder lag) */
492                  int rc_reaction_delay_factor;   /* how fast the rate control reacts - lower values are faster */  
493                  int rc_averaging_period;        /* as above */  int xvid_encore(void *handle, int opt, void *param1, void *param2);
494                  int rc_buffer;                  /* as above */  
495                  int max_quantizer;              /* the upper limit of the quantizer */  
496                  int min_quantizer;              /* the lower limit of the quantizer */  
497                  int max_key_interval;   /* the maximum interval between key frames */  /* Global Flags */
498  #ifdef _SMP  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
499                  int num_threads;                /* number of threads */  #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
500    #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
501    #if 0
502    #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
503    #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
504  #endif  #endif
505                  int global;                             /* global/debug options */  
506                  int max_bframes;                /* max sequential bframes (0=disable bframes) */  
507                  int bquant_ratio;               /* bframe quantizer multipier (percentage).  /* XVID_ENC_ENCODE param1 */
508                                                                   * used only when bquant < 1  /* vol-based flags */
509                                                                   * eg. 200 = x2 multiplier  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
510                                                                   * quant = ((past_quant + future_quant) * bquant_ratio)/200  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
511                                                                   */  #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
512                  int bquant_offset;              /* bquant += bquant_offset */  #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
513                  int frame_drop_ratio;   /* frame dropping: 0=drop none... 100=drop all */  #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
514    #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
515    
516    
517    
518    /* vop based flags */
519    #define XVID_VOP_DEBUG           (1<< 0)
520    #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */
521    #define XVID_VOP_INTER4V         (1<< 2)
522    #define XVID_VOP_TRELLISQUANT    (1<< 3) /* use trellis based R-D "optimal" quantization */
523    #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */
524    #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */
525    #define XVID_VOP_GREYSCALE       (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
526    #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */
527    #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */
528    /* only valid for vol_flags|=XVID_VOL_INTERLACING */
529    #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */
530    #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */
531    /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
532    #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */
533    
534    
535    
536    
537    /* Motion based flags */
538    #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
539    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
540    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
541    #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
542    #define XVID_ME_HALFPELREFINE16       (1<< 4)
543    #define XVID_ME_HALFPELREFINE8        (1<< 6)
544    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
545    #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
546    #define XVID_ME_GME_REFINE            (1<< 9)
547    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
548    #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
549    #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
550    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
551    
552    /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
553    #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform DCT-based halfpel refinement */
554    #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform DCT-based halfpel refinement for 8x8 mode */
555    #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform DCT-based qpel refinement */
556    #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform DCT-based qpel refinement for 8x8 mode */
557    #define XVID_ME_EXTSEARCH_RD          (1<<18) /* perform DCT-based search using square pattern enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
558    #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
559    
560    #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
561    #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
562    #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
563    #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
564    
565    
566    
567    /* XVID_ENC_CREATE param1 */
568    typedef struct {
569            int version;
570    
571            int profile;                 /* [in] profile@level; refer to XVID_PROFILE_xxx */
572            int width;                   /* [in] frame dimensions; width, pixel units */
573            int height;                  /* [in] frame dimensions; height, pixel units */
574    
575            int num_zones;               /* [in:opt] number of bitrate zones */
576            xvid_enc_zone_t * zones;     /*          ^^ zone array */
577    
578            int num_plugins;             /* [in:opt] number of plugins */
579            xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
580    
581            int num_threads;             /* [in:opt] number of threads */
582            int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
583    
584            int global;                  /* [in:opt] global flags; controls encoding behavior */
585    
586            /* --- vol-based stuff; included here for convenience */
587            int fincr;                   /* [in:opt] framerate increment; set to zero for variable framerate */
588            int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
589        /* ---------------------------------------------- */
590    
591            /* --- vop-based; included here for convenience */
592            int max_key_interval;        /* [in:opt] the maximum interval between key frames */
593    
594            int frame_drop_ratio;        /* [in:opt] frame dropping: 0=drop none... 100=drop all */
595    
596            int bquant_ratio;            /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
597            int bquant_offset;           /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
598    
599            int min_quant[3];            /* [in:opt] */
600            int max_quant[3];            /* [in:opt] */
601            /* ---------------------------------------------- */
602    
603                  void *handle;                   /* [out] encoder instance handle */                  void *handle;                   /* [out] encoder instance handle */
604          }          }
605          XVID_ENC_PARAM;  xvid_enc_create_t;
606    
         typedef struct  
         {  
                 int x;  
                 int y;  
         }  
         VECTOR;  
607    
608          typedef struct  #define XVID_KEYFRAME (1<<1)
         {  
                 int mode;                               /* macroblock mode */  
                 VECTOR mvs[4];  
         }  
         MVBLOCKHINT;  
609    
610          typedef struct  typedef struct {
611          {          int version;
                 int intra;                              /* frame intra choice */  
                 int fcode;                              /* frame fcode */  
                 MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */  
         }  
         MVFRAMEHINT;  
612    
613          typedef struct          /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any changes here until the next VOL (keyframe). */
614          {          int vol_flags;                     /* [in] vol flags */
615                  int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
616            unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
617    
618                  MVFRAMEHINT mvhint;          int par;                           /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
619                  void *hintstream;               /* compressed hint buffer */          int par_width;                     /* [in:opt] aspect ratio width */
620                  int hintlength;                 /* length of buffer (bytes) */          int par_height;                    /* [in:opt] aspect ratio height */
621          }          /* ---------------------------------------------- */
         HINTINFO;  
622    
623          typedef struct          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
624          {          int vop_flags;                     /* [in] (general)vop-based flags */
                 int general;                    /* [in] general options */  
625                  int motion;                             /* [in] ME options */                  int motion;                             /* [in] ME options */
                 void *bitstream;                /* [in] bitstream ptr */  
                 int length;                             /* [out] bitstream length (bytes) */  
626    
627                  void *image;                    /* [in] image ptr */          xvid_image_t input;                /* [in] input image (read from) */
                 int stride;  
                 int colorspace;                 /* [in] source colorspace */  
   
                 unsigned char *quant_intra_matrix;      // [in] custom intra qmatrix */  
                 unsigned char *quant_inter_matrix;      // [in] custom inter qmatrix */  
                 int quant;                              /* [in] frame quantizer (vbr) */  
                 int intra;                              /* [in] force intra frame (vbr only)  
                                                                  * [out] intra state  
                                                                  */  
                 HINTINFO hint;                  /* [in/out] mv hint information */  
628    
629                  int bquant;                             /* [in] bframe quantizer */          int type;                          /* [in:opt] coding type */
630            int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
631            int bframe_threshold;
632    
633          }          void *bitstream;                   /* [in:opt] bitstream ptr (written to)*/
634          XVID_ENC_FRAME;          int length;                        /* [in:opt] bitstream length (bytes) */
635    
636            int out_flags;                     /* [out] bitstream output flags */
637    } xvid_enc_frame_t;
638    
         typedef struct  
         {  
                 int quant;                              /* [out] frame quantizer */  
                 int hlength;                    /* [out] header length (bytes) */  
                 int kblks, mblks, ublks;        /* [out] */  
                 long sse_y;                             /* [out] SSE of Y */  
                 long sse_u;                             /* [out] SSE of Cb */  
                 long sse_v;                             /* [out] SSE of Cr */  
         }  
         XVID_ENC_STATS;  
639    
640    /* XVID_ENC_ENCODE param2 (optional)
641            xvid_enc_stats_t describes individual frame details
642    
643  /*****************************************************************************          coding_type==XVID_TYPE_NOTHING if the stats are not given
644   * Encoder entry point  */
645   ****************************************************************************/  typedef struct {
646            int version;
647    
648  /* Encoder options */          /* encoding parameters */
649  #define XVID_ENC_ENCODE         0          int type;      /* [out] coding type */
650  #define XVID_ENC_CREATE         1          int quant;     /* [out] frame quantizer */
651  #define XVID_ENC_DESTROY        2          int vol_flags; /* [out] vol flags (see above) */
652            int vop_flags; /* [out] vop flags (see above) */
         int xvid_encore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
653    
654            /* bitrate */
655            int length;    /* [out] frame length */
656    
657            int hlength;   /* [out] header length (bytes) */
658            int kblks;     /* [out] number of blocks compressed as Intra */
659            int mblks;     /* [out] number of blocks compressed as Inter */
660            int ublks;     /* [out] number of blocks marked as not_coded */
661    
662            int sse_y;     /* [out] Y plane's sse */
663            int sse_u;     /* [out] U plane's sse */
664            int sse_v;     /* [out] V plane's sse */
665    } xvid_enc_stats_t;
666    
667  #ifdef __cplusplus  #ifdef __cplusplus
668  }  }
669  #endif  #endif
670    
671    
672  #endif  #endif

Legend:
Removed from v.1.26  
changed lines
  Added in v.1.27.2.32

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