[svn] / trunk / xvidcore / src / xvid.h Repository:
ViewVC logotype

Diff of /trunk/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1098, Mon Jul 28 12:39:32 2003 UTC revision 1512, Sun Jul 18 15:24:05 2004 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   *  This file is part of XviD, a free MPEG-4 video encoder/decoder   *  Copyright(C) 2001-2004 Peter Ross <pross@xvid.org>
7   *   *
8   *  This program is free software; you can redistribute it and/or modify   *  This program is free software; you can redistribute it and/or modify
9   *  it under the terms of the GNU General Public License as published by   *  it under the terms of the GNU General Public License as published by
# Line 19  Line 19 
19   *  along with this program; if not, write to the Free Software   *  along with this program; if not, write to the Free Software
20   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21   *   *
22   * $Id: xvid.h,v 1.32 2003-07-28 12:36:25 edgomez Exp $   * $Id: xvid.h,v 1.44 2004-07-18 15:24:05 edgomez Exp $
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 : 3.0 */  /* versioning
39  #define API_VERSION ((3 << 16) | (0))          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)    ((char)(((a)>>16) & 0xff))
53    #define XVID_VERSION_MINOR(a)    ((char)(((a)>> 8) & 0xff))
54    #define XVID_VERSION_PATCH(a)    ((char)(((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,1,-127)
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 49  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 "0015"  #define XVID_BS_VERSION 35
   
   
 /* Error codes */  
 #define XVID_ERR_FAIL    -1  
 #define XVID_ERR_OK       0  
 #define XVID_ERR_MEMORY   1  
 #define XVID_ERR_FORMAT   2  
   
   
 /* 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] */  
   
77    
78    /*****************************************************************************
79     * error codes
80     ****************************************************************************/
81    
82  #define XVID_CSP_NULL   9999          /*      all functions return values <0 indicate error */
83    
84  #define XVID_CSP_VFLIP  0x80000000 /* flip mask */  #define XVID_ERR_FAIL           -1              /* general fault */
85    #define XVID_ERR_MEMORY         -2              /* memory allocation error */
86    #define XVID_ERR_FORMAT         -3              /* file format error */
87    #define XVID_ERR_VERSION        -4              /* structure version not supported */
88    #define XVID_ERR_END            -5              /* encoder only; end of stream reached */
89    
90    
91    
92    /*****************************************************************************
93     * xvid_image_t
94     ****************************************************************************/
95    
96    /* colorspace values */
97    
98    #define XVID_CSP_PLANAR   (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */
99    #define XVID_CSP_USER     XVID_CSP_PLANAR
100    #define XVID_CSP_I420     (1<< 1) /* 4:2:0 planar */
101    #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 planar */
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_ARGB     (1<<15) /* 32-bit argb packed */
109    #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
110    #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
111    #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
112    #define XVID_CSP_SLICE    (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */
113    #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
114    #define XVID_CSP_NULL     (1<<14) /* decoder only: dont output anything */
115    #define XVID_CSP_VFLIP    (1<<31) /* vertical flip mask */
116    
117    /* xvid_image_t
118            for non-planar colorspaces use only plane[0] and stride[0]
119            four plane reserved for alpha*/
120    typedef struct {
121            int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
122            void * plane[4];                /* [in] image plane ptrs */
123            int stride[4];                  /* [in] image stride; "bytes per row"*/
124    } xvid_image_t;
125    
126    /* video-object-sequence profiles */
127    #define XVID_PROFILE_S_L0    0x08 /* simple */
128    #define XVID_PROFILE_S_L1    0x01
129    #define XVID_PROFILE_S_L2    0x02
130    #define XVID_PROFILE_S_L3    0x03
131    #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
132    #define XVID_PROFILE_ARTS_L2 0x92
133    #define XVID_PROFILE_ARTS_L3 0x93
134    #define XVID_PROFILE_ARTS_L4 0x94
135    #define XVID_PROFILE_AS_L0   0xf0 /* advanced simple */
136    #define XVID_PROFILE_AS_L1   0xf1
137    #define XVID_PROFILE_AS_L2   0xf2
138    #define XVID_PROFILE_AS_L3   0xf3
139    #define XVID_PROFILE_AS_L4   0xf4
140    
141    /* aspect ratios */
142    #define XVID_PAR_11_VGA    1 /* 1:1 vga (square), default if supplied PAR is not a valid value */
143    #define XVID_PAR_43_PAL    2 /* 4:3 pal (12:11 625-line) */
144    #define XVID_PAR_43_NTSC   3 /* 4:3 ntsc (10:11 525-line) */
145    #define XVID_PAR_169_PAL   4 /* 16:9 pal (16:11 625-line) */
146    #define XVID_PAR_169_NTSC  5 /* 16:9 ntsc (40:33 525-line) */
147    #define XVID_PAR_EXT      15 /* extended par; use par_width, par_height */
148    
149    /* frame type flags */
150    #define XVID_TYPE_VOL     -1 /* decoder only: vol was decoded */
151    #define XVID_TYPE_NOTHING  0 /* decoder only (encoder stats): nothing was decoded/encoded */
152    #define XVID_TYPE_AUTO     0 /* encoder: automatically determine coding type */
153    #define XVID_TYPE_IVOP     1 /* intra frame */
154    #define XVID_TYPE_PVOP     2 /* predicted frame */
155    #define XVID_TYPE_BVOP     3 /* bidirectionally encoded */
156    #define XVID_TYPE_SVOP     4 /* predicted+sprite frame */
157    
158    
159  /*****************************************************************************  /*****************************************************************************
160   *  Initialization constants   * xvid_global()
161   ****************************************************************************/   ****************************************************************************/
162    
163  /* CPU flags for XVID_INIT_PARAM.cpu_flags */  /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
 #define XVID_CPU_FORCE     0x80000000  /* force passed cpu flags */  
 #define XVID_CPU_CHKONLY   0x40000000  /* check cpu only; dont init globals */  
 #define XVID_CPU_ASM       0x00000080  /* native assembly */  
164    
165    #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
166    #define XVID_CPU_ASM      (1<< 7) /* native assembly */
167  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
168  #define XVID_CPU_MMX      0x00000001   /* mmx      : pentiumMMX,k6 */  #define XVID_CPU_MMX      (1<< 0) /*       mmx : pentiumMMX,k6 */
169  #define XVID_CPU_MMXEXT   0x00000002   /* mmx-ext  : pentium2, athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
170  #define XVID_CPU_SSE      0x00000004   /* sse      : pentium3, athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
171  #define XVID_CPU_SSE2     0x00000008   /* sse2     : pentium4, athlon64 */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
172  #define XVID_CPU_3DNOW    0x00000010   /* 3dnow    : k6-2 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
173  #define XVID_CPU_3DNOWEXT 0x00000020   /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
174  #define XVID_CPU_TSC      0x00000040   /* timestamp counter */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
175    /* ARCH_IS_PPC */
176    #define XVID_CPU_ALTIVEC  (1<< 0) /* altivec */
177    
 /* ARCH_IS_IA64 */  
 #define XVID_CPU_IA64     XVID_CPU_ASM /* defined for backward compatibility */  
178    
179  /* ARCH_IS_PPC */  #define XVID_DEBUG_ERROR     (1<< 0)
180  #define XVID_CPU_ALTIVEC  0x00000001   /* altivec */  #define XVID_DEBUG_STARTCODE (1<< 1)
181    #define XVID_DEBUG_HEADER    (1<< 2)
182    #define XVID_DEBUG_TIMECODE  (1<< 3)
183    #define XVID_DEBUG_MB        (1<< 4)
184    #define XVID_DEBUG_COEFF     (1<< 5)
185    #define XVID_DEBUG_MV        (1<< 6)
186    #define XVID_DEBUG_RC        (1<< 7)
187    #define XVID_DEBUG_DEBUG     (1<<31)
188    
189    /* XVID_GBL_INIT param1 */
190    typedef struct {
191            int version;
192            unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */
193            int debug;     /* [in:opt] debug level */
194    } xvid_gbl_init_t;
195    
196    
197    /* XVID_GBL_INFO param1 */
198    typedef struct {
199            int version;
200            int actual_version; /* [out] returns the actual xvidcore version */
201            const char * build; /* [out] if !null, points to description of this xvid core build */
202            unsigned int cpu_flags;      /* [out] detected cpu features */
203            int num_threads;    /* [out] detected number of cpus/threads */
204    } xvid_gbl_info_t;
205    
206    
207    /* XVID_GBL_CONVERT param1 */
208    typedef struct {
209            int version;
210            xvid_image_t input;  /* [in] input image & colorspace */
211            xvid_image_t output; /* [in] output image & colorspace */
212            int width;           /* [in] width */
213            int height;          /* [in] height */
214            int interlacing;     /* [in] interlacing */
215    } xvid_gbl_convert_t;
216    
217    
218    #define XVID_GBL_INIT    0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
219    #define XVID_GBL_INFO    1 /* return some info about xvidcore, and the host computer */
220    #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
221    
222    extern int xvid_global(void *handle, int opt, void *param1, void *param2);
223    
224    
225    /*****************************************************************************
226     * xvid_decore()
227     ****************************************************************************/
228    
229    #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    #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */
232    
233    extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
234    
235    /* 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    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
251    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
252    #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
253    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
254    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
255    
256    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
257    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
258    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
259    
260    typedef struct {
261            int version;
262            int general;         /* [in:opt] general flags */
263            void *bitstream;     /* [in]     bitstream (read from)*/
264            int length;          /* [in]     bitstream length */
265            xvid_image_t output; /* [in]     output image (written to) */
266    /* ------- v1.1.x ------- */
267            int brightness;          /* [in]         brightness offset (0=none) */
268    } xvid_dec_frame_t;
269    
270    
271    /* XVID_DEC_DECODE param2 :: optional */
272    typedef struct
273    {
274            int version;
275    
276            int type;                   /* [out] output data type */
277            union {
278                    struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
279                            int general;        /* [out] flags */
280                            int time_base;      /* [out] time base */
281                            int time_increment; /* [out] time increment */
282    
283                            /* XXX: external deblocking stuff */
284                            int * qscale;       /* [out] pointer to quantizer table */
285                            int qscale_stride;  /* [out] quantizer scale stride */
286    
287          typedef struct                  } vop;
288          {                  struct {        /* XVID_TYPE_VOL */
289                  int colorspace;                          int general;        /* [out] flags */
290                  void * y;                          int width;          /* [out] width */
291                  void * u;                          int height;         /* [out] height */
292                  void * v;                          int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
293                  int y_stride;                          int par_width;      /* [out] aspect ratio width  [1..255] */
294                  int uv_stride;                          int par_height;     /* [out] aspect ratio height [1..255] */
295          } XVID_IMAGE;      /* from yv12 */                  } vol;
296            } data;
297  #define XVID_INIT_INIT    0  } xvid_dec_stats_t;
 #define XVID_INIT_CONVERT 1  
 #define XVID_INIT_TEST    2  
298    
299  /*****************************************************************************  #define XVID_ZONE_QUANT  (1<<0)
300   *  Initialization structures  #define XVID_ZONE_WEIGHT (1<<1)
  ****************************************************************************/  
301    
302          typedef struct          typedef struct
303          {          {
304                  int cpu_flags;          int frame;
305                  int api_version;          int mode;
306                  int core_build;          int increment;
307          } XVID_INIT_PARAM;          int base;
308    } xvid_enc_zone_t;
309    
         typedef struct  
         {  
                 XVID_IMAGE input;  
                 XVID_IMAGE output;  
                 int width;  
                 int height;  
                 int interlacing;  
         } XVID_INIT_CONVERTINFO;  
310    
311  /*****************************************************************************  /*----------------------------------------------------------------------------
312   *  Initialization entry point   * xvid_enc_stats_t structure
313   ****************************************************************************/   *
314     * Used in:
315     *  - xvid_plg_data_t structure
316     *  - optional parameter in xvid_encore() function
317     *
318     * .coding_type = XVID_TYPE_NOTHING if the stats are not given
319     *--------------------------------------------------------------------------*/
320    
321          int xvid_init(void *handle,  typedef struct {
322                                    int opt,          int version;
                                   void *param1,  
                                   void *param2);  
323    
324            /* encoding parameters */
325            int type;      /* [out] coding type */
326            int quant;     /* [out] frame quantizer */
327            int vol_flags; /* [out] vol flags (see above) */
328            int vop_flags; /* [out] vop flags (see above) */
329    
330  /*****************************************************************************          /* bitrate */
331   * Decoder constants          int length;    /* [out] frame length */
  ****************************************************************************/  
332    
333  /* Flags for XVID_DEC_FRAME.general */          int hlength;   /* [out] header length (bytes) */
334  #define XVID_DEC_LOWDELAY      0x00000001 /* decode lowdelay mode (ie. VFW) */          int kblks;     /* [out] number of blocks compressed as Intra */
335  #define XVID_DEC_DEBLOCKY      0x00000002 /* luma deblocking */          int mblks;     /* [out] number of blocks compressed as Inter */
336  #define XVID_DEC_DEBLOCKUV     0x00000008 /* chroma deblocking */          int ublks;     /* [out] number of blocks marked as not_coded */
337  #define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream  
338                                               instructs decoder to ignore any          int sse_y;     /* [out] Y plane's sse */
339                                               previous reference frames */          int sse_u;     /* [out] U plane's sse */
340  #define XVID_QUICK_DECODE      0x00000010          int sse_v;     /* [out] V plane's sse */
341    } xvid_enc_stats_t;
342    
343  /*****************************************************************************  /*****************************************************************************
344   * Decoder structures    xvid plugin system -- internals
345    
346      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
347      before encoding each frame xvidcore will call XVID_PLG_BEFORE
348      after encoding each frame xvidcore will call XVID_PLG_AFTER
349      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
350   ****************************************************************************/   ****************************************************************************/
351    
         typedef struct  
         {  
                 int width;  
                 int height;  
                 void *handle;  
         } XVID_DEC_PARAM;  
352    
353    #define XVID_PLG_CREATE  (1<<0)
354    #define XVID_PLG_DESTROY (1<<1)
355    #define XVID_PLG_INFO    (1<<2)
356    #define XVID_PLG_BEFORE  (1<<3)
357    #define XVID_PLG_FRAME   (1<<4)
358    #define XVID_PLG_AFTER   (1<<5)
359    
360    /* xvid_plg_info_t.flags */
361    #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
362    #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
363    #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
364    
 #define XVID_DEC_VOP     0  
 #define XVID_DEC_VOL     1  
 #define XVID_DEC_NOTHING 2 /* nothing was decoded */  
365    
366          typedef struct          typedef struct
367          {          {
368                  int notify;                 /* [out] output 'mode' */          int version;
369                  union          int flags;   /* [in:opt] plugin flags */
370                  {  } 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;  
371    
372    
373          typedef struct          typedef struct
374          {          {
375                  int general;          int version;
                 void *bitstream;  
                 int length;  
376    
377                  void *image;          int num_zones;           /* [out] */
378                  int stride;          xvid_enc_zone_t * zones; /* [out] */
379                  int colorspace;  
380          } XVID_DEC_FRAME;          int width;               /* [out] */
381            int height;              /* [out] */
382            int mb_width;            /* [out] */
383            int mb_height;           /* [out] */
384            int fincr;               /* [out] */
385            int fbase;               /* [out] */
386    
387            void * param;            /* [out] */
388    } xvid_plg_create_t;
389    
390    
         /* This struct is used for per slice rendering */  
391          typedef struct          typedef struct
392          {          {
393                  void *y,*u,*v;          int version;
                 int stride_y, stride_u,stride_v;  
         } XVID_DEC_PICTURE;  
394    
395            int num_frames; /* [out] total frame encoded */
396    } xvid_plg_destroy_t;
397    
398  /*****************************************************************************  typedef struct
399   * Decoder entry point  {
400   ****************************************************************************/          int version;
401    
402  /* decoder options */          xvid_enc_zone_t * zone; /* [out] current zone */
 #define XVID_DEC_DECODE  0  
 #define XVID_DEC_CREATE  1  
 #define XVID_DEC_DESTROY 2  
   
         int xvid_decore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
403    
404            int width;              /* [out] */
405            int height;             /* [out] */
406            int mb_width;           /* [out] */
407            int mb_height;          /* [out] */
408            int fincr;              /* [out] */
409            int fbase;              /* [out] */
410    
411  /*****************************************************************************          int min_quant[3];       /* [out] */
412   * Encoder constants          int max_quant[3];       /* [out] */
  ****************************************************************************/  
413    
414  /* Flags for XVID_ENC_PARAM.global */          xvid_image_t reference; /* [out] -> [out] */
415  #define XVID_GLOBAL_PACKED      0x00000001 /* packed bitstream */          xvid_image_t current;   /* [out] -> [in,out] */
416  #define XVID_GLOBAL_DX50BVOP    0x00000002 /* dx50 bvop compatibility */          xvid_image_t original;  /* [out] after: points the original (uncompressed) copy of the current frame */
417  #define XVID_GLOBAL_DEBUG       0x00000004 /* print debug info on each frame */          int frame_num;          /* [out] frame number */
 #define XVID_GLOBAL_REDUCED     0x04000000 /* reduced resolution vop enable */  
418    
419  #define XVID_GLOBAL_EXTRASTATS  0x00000200 /* generate extra statistics */          int type;               /* [in,out] */
420            int quant;              /* [in,out] */
421    
422            int * dquant;           /* [in,out]     pointer to diff quantizer table */
423            int dquant_stride;      /* [in,out]     diff quantizer stride */
424    
425  /* Flags for XVID_ENC_FRAME.general */          int vop_flags;          /* [in,out] */
426  #define XVID_VALID_FLAGS        0x80000000          int vol_flags;          /* [in,out] */
427            int motion_flags;       /* [in,out] */
428    
429  #define XVID_CUSTOM_QMATRIX     0x00000004 /* use custom quant matrix */  /* Deprecated, use the stats field instead.
430  #define XVID_H263QUANT          0x00000010   * Will disapear before 1.0 */
431  #define XVID_MPEGQUANT          0x00000020          int length;             /* [out] after: length of encoded frame */
432  #define XVID_HALFPEL            0x00000040 /* use halfpel interpolation */          int kblks;              /* [out] number of blocks compressed as Intra */
433  #define XVID_QUARTERPEL         0x02000000          int mblks;              /* [out] number of blocks compressed as Inter */
434  #define XVID_ADAPTIVEQUANT      0x00000080          int ublks;              /* [out] number of blocks marked not_coded */
435  #define XVID_LUMIMASKING        0x00000100          int sse_y;              /* [out] Y plane's sse */
436            int sse_u;              /* [out] U plane's sse */
437            int sse_v;              /* [out] V plane's sse */
438    /* End of duplicated data, kept only for binary compatibility */
439    
440  #define XVID_INTERLACING        0x00000400 /* enable interlaced encoding */          int bquant_ratio;       /* [in] */
441  #define XVID_TOPFIELDFIRST      0x00000800 /* set top-field-first flag  */          int bquant_offset;      /* [in] */
 #define XVID_ALTERNATESCAN      0x00001000 /* set alternate vertical scan flag */  
442    
443  #define XVID_HINTEDME_GET       0x00002000 /* receive mv hint data from core (1st pass) */          xvid_enc_stats_t stats; /* [out] frame statistics */
444  #define XVID_HINTEDME_SET       0x00004000 /* send mv hint data to core (2nd pass) */  } xvid_plg_data_t;
445    
446  #define XVID_INTER4V            0x00008000  /*****************************************************************************
447      xvid plugin system -- external
448    
449  #define XVID_ME_ZERO            0x00010000    the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
450  #define XVID_ME_LOGARITHMIC     0x00020000    indicates the plugin function pointer and plugin-specific data.
451  #define XVID_ME_FULLSEARCH      0x00040000    xvidcore handles the rest. example:
 #define XVID_ME_PMVFAST         0x00080000  
 #define XVID_ME_EPZS            0x00100000  
452    
453  #define XVID_CHROMAOPT          0x00200000 /* enable chroma optimization pre-filter */    xvid_enc_create_t create;
454      xvid_enc_plugin_t plugins[2];
455    
456  #define XVID_GREYSCALE          0x01000000 /* enable greyscale only mode (even for    plugins[0].func = xvid_psnr_func;
457                                                color input material chroma is ignored) */    plugins[0].param = NULL;
458      plugins[1].func = xvid_cbr_func;
459      plugins[1].param = &cbr_data;
460    
461  #define XVID_GMC                0x10000000    create.num_plugins = 2;
462  #define XVID_GMC_TRANSLATIONAL  0x20000000    create.plugins = plugins;
463    
464  #define XVID_REDUCED            0x04000000 /* reduced resolution vop */   ****************************************************************************/
 #define XVID_HQACPRED           0x08000000 /* 20030209: high quality ac prediction */  
465    
466  #define XVID_EXTRASTATS         0x00000200 /* generate extra statistics */  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
467    
468    typedef struct
469    {
470            xvid_plugin_func * func;
471            void * param;
472    } xvid_enc_plugin_t;
473    
 #define XVID_MODEDECISION_BITS  0x00400000 /* enable DCT-ME and use it for mode decision */  
474    
475    extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
476    extern xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
477    extern xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
478    
479  /* Flags for XVID_ENC_FRAME.motion */  extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
 #define PMV_ADVANCEDDIAMOND16   0x00008000 /* use advdiamonds instead of diamonds as search pattern */  
 #define PMV_USESQUARES16        0x00800000 /* use squares instead of diamonds as search pattern */  
480    
481  #define PMV_HALFPELREFINE16     0x00020000  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
482  #define PMV_HALFPELREFINE8      0x02000000  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
483    
 #define PMV_QUARTERPELREFINE16  0x00040000  
 #define PMV_QUARTERPELREFINE8   0x04000000  
484    
485  #define PMV_EXTSEARCH16         0x00080000 /* extend PMV by more searches */  /* single pass rate control
486     * CBR and Constant quantizer modes */
487    typedef struct
488    {
489            int version;
490    
491            int bitrate;               /* [in] bits per second */
492            int reaction_delay_factor; /* [in] */
493            int averaging_period;      /* [in] */
494            int buffer;                /* [in] */
495    } xvid_plugin_single_t;
496    
 #define PMV_EXTSEARCH8          0x08000000 /* use diamond/square for extended 8x8 search */  
 #define PMV_ADVANCEDDIAMOND8    0x00004000 /* use advdiamond for PMV_EXTSEARCH8 */  
 #define PMV_USESQUARES8         0x80000000 /* use square for PMV_EXTSEARCH8 */  
497    
498  #define PMV_CHROMA16            0x00100000 /* also use chroma for P_VOP/S_VOP ME */  typedef struct {
499  #define PMV_CHROMA8             0x10000000 /* also use chroma for B_VOP ME */          int version;
500    
501  /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */          char * filename;
502  #define HALFPELREFINE16_BITS    0x00000100 /* perform DCT-based halfpel refinement */  } xvid_plugin_2pass1_t;
 #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 */  
503    
 #define EXTSEARCH_BITS          0x00001000 /* perform DCT-based search using square pattern  
                                               enable PMV_EXTSEARCH8 to do this in 8x8 search as well */  
 #define CHECKPREDICTION_BITS    0x00002000 /* always check vector equal to prediction */  
504    
505    #define XVID_PAYBACK_BIAS 0 /* payback with bias */
506    #define XVID_PAYBACK_PROP 1 /* payback proportionally */
507    
508  /* note: old and deprecated - or never implemented */  typedef struct {
509            int version;
510    
511  /* only for compatability with old encoders */          int bitrate;                  /* [in] target bitrate (bits per second) */
512            char * filename;              /* [in] first pass stats filename */
513    
514  #define PMV_EARLYSTOP16         0x00          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
515  #define PMV_EARLYSTOP8          0x00          int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
516  #define PMV_QUICKSTOP16         0x00          int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
517  #define PMV_QUICKSTOP8          0x00          int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
518            int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
519            int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
520    
521  #define PMV_HALFPELDIAMOND16    0x00          int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
522  #define PMV_HALFPELDIAMOND8     0x00          int kfthreshold;              /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
523                                                                       *      is substracted from its bit allocation. The reduction is computed as multiples of
524                                                                       *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
525                                                                       *      0 for 1<distance<kfthreshold */
526    
527  #define PMV_UNRESTRICTED16      0x00200000 /* unrestricted ME, not implemented */          int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
 #define PMV_OVERLAPPING16       0x00400000 /* overlapping ME, not implemented */  
 #define PMV_UNRESTRICTED8       0x20000000 /* unrestricted ME, not implemented */  
 #define PMV_OVERLAPPING8        0x40000000 /* overlapping ME, not implemented */  
528    
529  #define XVID_ME_COLOUR          0x00       /* this has been converted to PMV_CHROMA[16/8] */  /* ------- v1.1.x ------- */
530            int vbv_size;                 /* [in] buffer size (bits) */
531            int vbv_initial;              /* [in] initial buffer occupancy (bits) */
532            int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
533            int vbv_peakrate;             /* [in:opt] max average bitrate over 3 seconds (bits per second) */
534    
535    }xvid_plugin_2pass2_t;
536    
537  /*****************************************************************************  /*****************************************************************************
538   * Encoder structures   *                             ENCODER API
539   ****************************************************************************/   ****************************************************************************/
540    
541          typedef struct  /*----------------------------------------------------------------------------
542          {   * Encoder operations
543                  int width, height;   *--------------------------------------------------------------------------*/
544                  int fincr, fbase;             /* [in] frame increment, fbase. each frame = "fincr/fbase" seconds */  
545                  int rc_bitrate;               /* [in] the bitrate of the target encoded stream, in bits/second */  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
546                  int rc_reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
547                  int rc_averaging_period;      /* [in] as above */  #define XVID_ENC_ENCODE  2 /* encode a frame: returns number of ouput bytes
548                  int rc_buffer;                /* [in] as above */                              * 0 means this frame should not be written (ie. encoder lag) */
549                  int max_quantizer;            /* [in] the upper limit of the quantizer */  
550                  int min_quantizer;            /* [in] the lower limit of the quantizer */  
551                  int max_key_interval;         /* [in] the maximum interval between key frames */  /*----------------------------------------------------------------------------
552  #ifdef _SMP   * Encoder entry point
553                  int num_threads;              /* [in] number of threads */   *--------------------------------------------------------------------------*/
554  #endif  
555                  int global;                   /* [in] global/debug options */  extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
556                  int max_bframes;              /* [in] max sequential bframes (0=disable bframes) */  
557                  int bquant_ratio;             /* [in] bframe quantizer multipier (percentage).  /* Quick API reference
558                                                used only when bquant < 1   *
559                                                eg. 200 = x2 multiplier   * XVID_ENC_CREATE operation
560                                                    quant = ((past_quant + future_quant) * bquant_ratio)/200   *  - handle: ignored
561     *  - opt: XVID_ENC_CREATE
562     *  - param1: address of a xvid_enc_create_t structure
563     *  - param2: ignored
564     *
565     * XVID_ENC_ENCODE operation
566     *  - handle: an instance returned by a CREATE op
567     *  - opt: XVID_ENC_ENCODE
568     *  - param1: address of a xvid_enc_frame_t structure
569     *  - param2: address of a xvid_enc_stats_t structure (optional)
570     *            its return value is asynchronous to what is written to the buffer
571     *            depending on the delay introduced by bvop use. It's display
572     *            ordered.
573     *
574     * XVID_ENC_DESTROY operation
575     *  - handle: an instance returned by a CREATE op
576     *  - opt: XVID_ENC_DESTROY
577     *  - param1: ignored
578     *  - param2: ignored
579                                         */                                         */
                 int bquant_offset;            /* [in] bquant += bquant_offset */  
                 int frame_drop_ratio;         /* [in] frame dropping: 0=drop none... 100=drop all */  
                 void *handle;                 /* [out] encoder instance handle */  
         } XVID_ENC_PARAM;  
580    
         typedef struct  
         {  
                 int x;  
                 int y;  
         } VECTOR;  
581    
582          typedef struct  /*----------------------------------------------------------------------------
583          {   * "Global" flags
584                  int mode;      /* macroblock mode */   *
585                  VECTOR mvs[4];   * These flags are used for xvid_enc_create_t->global field during instance
586          } MVBLOCKHINT;   * creation (operation XVID_ENC_CREATE)
587     *--------------------------------------------------------------------------*/
588    
589    #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
590    #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
591    #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
592    #if 0
593    #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
594    #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
595    #endif
596    
         typedef struct  
         {  
                 int intra;          /* frame intra choice */  
                 int fcode;          /* frame fcode */  
                 MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */  
         } MVFRAMEHINT;  
597    
598          typedef struct  /*----------------------------------------------------------------------------
599          {   * "VOL" flags
600                  int rawhints;       /* if set, use MVFRAMEHINT, else use compressed buffer */   *
601     * These flags are used for xvid_enc_frame_t->vol_flags field during frame
602     * encoding (operation XVID_ENC_ENCODE)
603     *--------------------------------------------------------------------------*/
604    
605    #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
606    #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
607    #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
608    #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
609    #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
610    #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
611    
                 MVFRAMEHINT mvhint;  
                 void *hintstream;   /* compressed hint buffer */  
                 int hintlength;     /* length of buffer (bytes) */  
         } HINTINFO;  
612    
613          typedef struct  /*----------------------------------------------------------------------------
614          {   * "VOP" flags
615                  int general;                       /* [in] general options */   *
616                  int motion;                        /* [in] ME options */   * These flags are used for xvid_enc_frame_t->vop_flags field during frame
617                  void *bitstream;                   /* [in] bitstream ptr */   * encoding (operation XVID_ENC_ENCODE)
618                  int length;                        /* [out] bitstream length (bytes) */   *--------------------------------------------------------------------------*/
619    
620    /* Always valid */
621    #define XVID_VOP_DEBUG                (1<< 0) /* print debug messages in frames */
622    #define XVID_VOP_HALFPEL              (1<< 1) /* use halfpel interpolation */
623    #define XVID_VOP_INTER4V              (1<< 2) /* use 4 motion vectors per MB */
624    #define XVID_VOP_TRELLISQUANT         (1<< 3) /* use trellis based R-D "optimal" quantization */
625    #define XVID_VOP_CHROMAOPT            (1<< 4) /* enable chroma optimization pre-filter */
626    #define XVID_VOP_CARTOON              (1<< 5) /* use 'cartoon mode' */
627    #define XVID_VOP_GREYSCALE            (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
628    #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */
629    #define XVID_VOP_MODEDECISION_RD      (1<< 8) /* enable DCT-ME and use it for mode decision */
630    #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
631    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
632    
633    /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
634    #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
635    #define XVID_VOP_ALTERNATESCAN        (1<<10) /* set alternate vertical scan flag */
636    
637                  void *image;                       /* [in] image ptr */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
638                  int stride;                        /* [in] horizontal stride in bytes */  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */
                 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] frame type (ugly atm)  
                                             */  
                 HINTINFO hint;                     /* [in/out] mv hint information */  
639    
                 int bquant;                        /* [in] bframe quantizer */  
                 int bframe_threshold;                      /* [in] sensitivity of B-frame decision */  
640    
641          } XVID_ENC_FRAME;  /*----------------------------------------------------------------------------
642     * "Motion" flags
643     *
644     * These flags are used for xvid_enc_frame_t->motion field during frame
645     * encoding (operation XVID_ENC_ENCODE)
646     *--------------------------------------------------------------------------*/
647    
648    /* Motion Estimation Search Patterns */
649    #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
650    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
651    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
652    #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
653    
654    /* SAD operator based flags */
655    #define XVID_ME_HALFPELREFINE16       (1<< 4)
656    #define XVID_ME_HALFPELREFINE8        (1<< 6)
657    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
658    #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
659    #define XVID_ME_GME_REFINE            (1<< 9)
660    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
661    #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
662    #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
663    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
664    #define XVID_ME_FASTREFINE16          (1<<25) /* use low-complexity refinement functions */
665    #define XVID_ME_FASTREFINE8           (1<<29) /* low-complexity 8x8 sub-block refinement */
666    
667    /* Rate Distortion based flags
668     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
669    #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
670    #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
671    #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
672    #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
673    #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 */
674    #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
675    
676    /* Other */
677    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
678    #define XVID_ME_SKIP_DELTASEARCH      (1<<26) /* speed-up by skipping b-frame delta search */
679    #define XVID_ME_FAST_MODEINTERPOLATE  (1<<27) /* speed-up by partly skipping interpolate mode */
680    #define XVID_ME_BFRAME_EARLYSTOP      (1<<28) /* speed-up by early exiting b-search */
681    
682    /* Unused */
683    #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
684    #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
685    #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
686    #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
687    
688    
689          typedef struct  /*----------------------------------------------------------------------------
690          {   * xvid_enc_create_t structure definition
691                  int quant;   /* [out] frame quantizer */   *
692                  int hlength; /* [out] header length (bytes) */   * This structure is passed as param1 during an instance creation (operation
693                  int kblks;   /* [out] number of intra blocks */   * XVID_ENC_CREATE)
694                  int mblks;   /* [out] number of inter blocks */   *--------------------------------------------------------------------------*/
                 int ublks;       /* [out] number of "not coded" blocks */  
                 long sse_y;  /* [out] SSE of Y */  
                 long sse_u;  /* [out] SSE of Cb */  
                 long sse_v;  /* [out] SSE of Cr */  
         } XVID_ENC_STATS;  
695    
696    typedef struct {
697            int version;
698    
699  /*****************************************************************************          int profile;                 /* [in] profile@level; refer to XVID_PROFILE_xxx */
700   * Encoder entry point          int width;                   /* [in] frame dimensions; width, pixel units */
701   ****************************************************************************/          int height;                  /* [in] frame dimensions; height, pixel units */
702    
703            int num_zones;               /* [in:opt] number of bitrate zones */
704            xvid_enc_zone_t * zones;     /*          ^^ zone array */
705    
706            int num_plugins;             /* [in:opt] number of plugins */
707            xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
708    
709            int num_threads;             /* [in:opt] number of threads */
710            int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
711    
712            int global;                  /* [in:opt] global flags; controls encoding behavior */
713    
714            /* --- vol-based stuff; included here for convenience */
715            int fincr;                   /* [in:opt] framerate increment; set to zero for variable framerate */
716            int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
717        /* ---------------------------------------------- */
718    
719            /* --- vop-based; included here for convenience */
720            int max_key_interval;        /* [in:opt] the maximum interval between key frames */
721    
722            int frame_drop_ratio;        /* [in:opt] frame dropping: 0=drop none... 100=drop all */
723    
724            int bquant_ratio;            /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
725            int bquant_offset;           /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
726    
727            int min_quant[3];            /* [in:opt] */
728            int max_quant[3];            /* [in:opt] */
729            /* ---------------------------------------------- */
730    
731            void *handle;                /* [out] encoder instance handle */
732    } xvid_enc_create_t;
733    
734    
735    /*----------------------------------------------------------------------------
736     * xvid_enc_frame_t structure definition
737     *
738     * This structure is passed as param1 during a frame encoding (operation
739     * XVID_ENC_ENCODE)
740     *--------------------------------------------------------------------------*/
741    
742    /* out value for the frame structure->type field
743     * unlike stats output in param2, this field is not asynchronous and tells
744     * the client app, if the frame written into the stream buffer is an ivop
745     * usually used for indexing purpose in the container */
746    #define XVID_KEYFRAME (1<<1)
747    
748    /* The structure */
749    typedef struct {
750            int version;
751    
752            /* VOL related stuff
753             * unless XVID_FORCEVOL is set, the encoder will not react to any changes
754             * here until the next VOL (keyframe). */
755    
756            int vol_flags;                     /* [in] vol flags */
757            unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
758            unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
759    
760            int par;                           /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */
761            int par_width;                     /* [in:opt] aspect ratio width */
762            int par_height;                    /* [in:opt] aspect ratio height */
763    
764            /* Other fields that can change on a frame base */
765    
766            int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
767            int vop_flags;                     /* [in] (general)vop-based flags */
768            int motion;                        /* [in] ME options */
769    
770            xvid_image_t input;                /* [in] input image (read from) */
771    
772            int type;                          /* [in:opt] coding type */
773            int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
774            int bframe_threshold;
775    
776  /* Encoder options */          void *bitstream;                   /* [in:opt] bitstream ptr (written to)*/
777  #define XVID_ENC_ENCODE  0          int length;                        /* [in:opt] bitstream length (bytes) */
 #define XVID_ENC_CREATE  1  
 #define XVID_ENC_DESTROY 2  
   
         int xvid_encore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
778    
779            int out_flags;                     /* [out] bitstream output flags */
780    } xvid_enc_frame_t;
781    
782  #ifdef __cplusplus  #ifdef __cplusplus
783  }  }

Legend:
Removed from v.1098  
changed lines
  Added in v.1512

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