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

Legend:
Removed from v.903  
changed lines
  Added in v.1893

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