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

Diff of /xvidcore/src/xvid.h

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

revision 1.17.2.30, Sat Feb 15 05:57:15 2003 UTC revision 1.76, Tue Mar 8 19:16:26 2011 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     *  Copyright(C) 2001-2010 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 17  Line 19 
19  *  along with this program ; if not, write to the Free Software  *  along with this program ; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21  *  *
 *****************************************************************************/  
 /*****************************************************************************  
 *  
 *  History  
 *  
 *  - 2002/06/13 Added legal header, ANSI C comment style (only for this header  
 *               as it can be included in a ANSI C project).  
 *  
 *               ToDo ? : when BFRAMES is defined, the API_VERSION should not  
 *                        be the same (3.0 ?)  
 *  
22  *  $Id$  *  $Id$
23  *  *
24  *****************************************************************************/   ****************************************************************************/
   
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
29    
30  #ifdef __cplusplus  #ifdef __cplusplus
31  extern "C" {  extern "C" {
32  #endif  #endif
33    
34  /*****************************************************************************  /*****************************************************************************
35   * Global constants   * versioning
36   ****************************************************************************/   ****************************************************************************/
37    
38  /* API Version : 2.1 */  /* versioning
39  #define API_VERSION ((2 << 16) | (1))          version takes the form "$major.$minor.$patch"
40  #define XVID_API_UNSTABLE          $patch is incremented when there is no api change
41            $minor is incremented when the api is changed, but remains backwards compatible
42            $major is incremented when the api is changed significantly
43    
44            when initialising an xvid structure, you must always zero it, and set the version field.
45                    memset(&struct,0,sizeof(struct));
46                    struct.version = XVID_VERSION;
47    
48            XVID_UNSTABLE is defined only during development.
49            */
50    
51    #define XVID_MAKE_VERSION(a,b,c) ((((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff))
52    #define XVID_VERSION_MAJOR(a)    ((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,4,-127)
61    #define XVID_API                 XVID_MAKE_API(4, 4)
62    
63    #define XVID_UNSTABLE
64    
65  /* Bitstream Version  /* Bitstream Version
66   * this will be writen into the bitstream to allow easy detection of xvid   * this will be writen into the bitstream to allow easy detection of xvid
# Line 59  Line 73 
73   * doesnt hurt but not increasing it could cause difficulty for decoders in the   * doesnt hurt but not increasing it could cause difficulty for decoders in the
74   * future   * future
75   */   */
76  #define XVID_BS_VERSION "0009"  #define XVID_BS_VERSION 71
77    
78    /*****************************************************************************
79     * error codes
80     ****************************************************************************/
81    
82  /* Error codes */          /*      all functions return values <0 indicate error */
 #define XVID_ERR_FAIL           -1  
 #define XVID_ERR_OK                     0  
 #define XVID_ERR_MEMORY         1  
 #define XVID_ERR_FORMAT         2  
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    
 /* 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] */  
90    
91    
92    /*****************************************************************************
93     * xvid_image_t
94     ****************************************************************************/
95    
96  #define XVID_CSP_NULL   9999  /* colorspace values */
97    
98  #define XVID_CSP_VFLIP  0x80000000      // flip mask  #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   *  Initialization constants   * xvid_global()
165   ****************************************************************************/   ****************************************************************************/
166    
167  /* 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  
 #define XVID_CPU_CHKONLY        0x40000000              /* check cpu only; dont init globals */  
   
 #define XVID_CPU_ASM            0x00000080              /* native assembly */  
 /* ARCH_X86 */  
 #define XVID_CPU_MMX            0x00000001              /* mmx: pentiumMMX,k6 */  
 #define XVID_CPU_MMXEXT         0x00000002              /* mmxx-ext: pentium2,athlon */  
 #define XVID_CPU_SSE            0x00000004              /* sse: pentium3,athlonXP */  
 #define XVID_CPU_SSE2           0x00000008              /* sse2: pentium4,athlon64 */  
 #define XVID_CPU_3DNOW          0x00000010              /* 3dnow: k6-2 */  
 #define XVID_CPU_3DNOWEXT       0x00000020              /* 3dnow-ext: athlon */  
 #define XVID_CPU_TSC            0x00000040              /* timestamp counter */  
 /* ARCH_IA64 */  
 #define XVID_CPU_IA64           XVID_CPU_ASM    /* defined for backward compatibility */  
 /* ARCH_PPC */  
 #define XVID_CPU_ALTIVEC        0x00000001              /* altivec */  
168    
169    #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
170    #define XVID_CPU_ASM      (1<< 7) /* native assembly */
171    /* ARCH_IS_IA32 */
172    #define XVID_CPU_MMX      (1<< 0) /*       mmx : pentiumMMX,k6 */
173    #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    
         typedef struct  
         {  
                 int colorspace;  
                 void * y;  
                 void * u;  
                 void * v;  
                 int y_stride;  
                 int uv_stride;  
         } XVID_IMAGE;           /* from yv12 */  
   
 #define XVID_INIT_INIT          0  
 #define XVID_INIT_CONVERT       1  
 #define XVID_INIT_TEST          2  
230    
231  /*****************************************************************************  /*****************************************************************************
232   *  Initialization structures   * xvid_decore()
233   ****************************************************************************/   ****************************************************************************/
234    
235          typedef struct  #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                  int cpu_flags;  #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */
238                  int api_version;  
239                  int core_build;  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
240          }  
241          XVID_INIT_PARAM;  /* 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    /* ------- v1.3.x ------- */
250            int fourcc;     /* [in:opt] fourcc of the input video */
251            int num_threads;/* [in:opt] number of threads to use in decoder */
252    } xvid_dec_create_t;
253    
254    
255    /* XVID_DEC_DECODE param1 */
256    /* general flags */
257    #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
258    #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
259    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
260    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
261    #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
262    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
263    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
264    
265    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
266    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
267    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
268    
269    typedef struct {
270            int version;
271            int general;         /* [in:opt] general flags */
272            void *bitstream;     /* [in]     bitstream (read from)*/
273            int length;          /* [in]     bitstream length */
274            xvid_image_t output; /* [in]     output image (written to) */
275    /* ------- v1.1.x ------- */
276            int brightness;          /* [in]         brightness offset (0=none) */
277    } xvid_dec_frame_t;
278    
279    
280    /* XVID_DEC_DECODE param2 :: optional */
281    typedef struct
282    {
283            int version;
284    
285            int type;                   /* [out] output data type */
286            union {
287                    struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
288                            int general;        /* [out] flags */
289                            int time_base;      /* [out] time base */
290                            int time_increment; /* [out] time increment */
291    
292                            /* XXX: external deblocking stuff */
293                            int * qscale;       /* [out] pointer to quantizer table */
294                            int qscale_stride;  /* [out] quantizer scale stride */
295    
296                    } vop;
297                    struct {        /* XVID_TYPE_VOL */
298                            int general;        /* [out] flags */
299                            int width;          /* [out] width */
300                            int height;         /* [out] height */
301                            int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
302                            int par_width;      /* [out] aspect ratio width  [1..255] */
303                            int par_height;     /* [out] aspect ratio height [1..255] */
304                    } vol;
305            } data;
306    } xvid_dec_stats_t;
307    
308    #define XVID_ZONE_QUANT  (1<<0)
309    #define XVID_ZONE_WEIGHT (1<<1)
310    
311          typedef struct          typedef struct
312          {          {
313                  XVID_IMAGE input;          int frame;
314                  XVID_IMAGE output;          int mode;
315                  int width;          int increment;
316                  int height;          int base;
317                  int interlacing;  } xvid_enc_zone_t;
         } XVID_INIT_CONVERTINFO;  
318    
 /*****************************************************************************  
  *  Initialization entry point  
  ****************************************************************************/  
319    
320          int xvid_init(void *handle,  /*----------------------------------------------------------------------------
321                                    int opt,   * xvid_enc_stats_t structure
322                                    void *param1,   *
323                                    void *param2);   * Used in:
324     *  - xvid_plg_data_t structure
325     *  - optional parameter in xvid_encore() function
326     *
327     * .coding_type = XVID_TYPE_NOTHING if the stats are not given
328     *--------------------------------------------------------------------------*/
329    
330    typedef struct {
331            int version;
332    
333  /*****************************************************************************          /* encoding parameters */
334   * Decoder constants          int type;      /* [out] coding type */
335   ****************************************************************************/          int quant;     /* [out] frame quantizer */
336            int vol_flags; /* [out] vol flags (see above) */
337            int vop_flags; /* [out] vop flags (see above) */
338    
339  /* Flags for XVID_DEC_FRAME.general */          /* bitrate */
340  #define XVID_DEC_LOWDELAY               0x00000001      /* decode lowdelay mode (ie. video-for-windows) */          int length;    /* [out] frame length */
 #define XVID_DEC_DEBLOCKY               0x00000002      /* luma deblocking */  
 #define XVID_DEC_DEBLOCKUV              0x00000008      /* chroma deblocking */  
 #define XVID_DEC_DISCONTINUITY  0x00000004      /* indicates break in stream; instructs  
                                                                                         decoder to ignore any previous reference frames */  
 #define XVID_QUICK_DECODE               0x00000010  
341    
342  /*****************************************************************************          int hlength;   /* [out] header length (bytes) */
343   * Decoder structures          int kblks;     /* [out] number of blocks compressed as Intra */
344            int mblks;     /* [out] number of blocks compressed as Inter */
345            int ublks;     /* [out] number of blocks marked as not_coded */
346    
347            int sse_y;     /* [out] Y plane's sse */
348            int sse_u;     /* [out] U plane's sse */
349            int sse_v;     /* [out] V plane's sse */
350    } xvid_enc_stats_t;
351    
352    /*****************************************************************************
353      xvid plugin system -- internals
354    
355      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
356      before encoding each frame xvidcore will call XVID_PLG_BEFORE
357      after encoding each frame xvidcore will call XVID_PLG_AFTER
358      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
359   ****************************************************************************/   ****************************************************************************/
360    
         typedef struct  
         {  
                 int width;  
                 int height;  
                 void *handle;  
         }  
         XVID_DEC_PARAM;  
361    
362    #define XVID_PLG_CREATE  (1<<0)
363    #define XVID_PLG_DESTROY (1<<1)
364    #define XVID_PLG_INFO    (1<<2)
365    #define XVID_PLG_BEFORE  (1<<3)
366    #define XVID_PLG_FRAME   (1<<4)
367    #define XVID_PLG_AFTER   (1<<5)
368    
369  #define XVID_DEC_VOP    0  /* xvid_plg_info_t.flags */
370  #define XVID_DEC_VOL    1  #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
371  #define XVID_DEC_NOTHING        2       /* nothing was decoded */  #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
372    #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
373    #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */
374    
375          typedef struct          typedef struct
376          {          {
377                  int notify;                     /* [out]        output 'mode' */          int version;
378                  union          int flags;   /* [in:opt] plugin flags */
379                  {  } xvid_plg_info_t;
380                          struct  /* XVID_DEC_VOP */  
381                          {  
382                                  int time_base;          /* [out]        time base */  typedef struct
                                 int time_increment;     /* [out]        time increment */  
                         } vop;  
                         struct  /* XVID_DEC_VOL */  
383                          {                          {
384                                  int general;            /* [out]        flags: eg. frames are interlaced */          int version;
385                                  int width;                      /* [out]        width */  
386                                  int height;                     /* [out]        height */          int num_zones;           /* [out] */
387                                  int aspect_ratio;       /* [out]        aspect ratio */          xvid_enc_zone_t * zones; /* [out] */
388                                  int par_width;          /* [out]        aspect ratio width */  
389                                  int par_height;         /* [out]        aspect ratio height */          int width;               /* [out] */
390                          } vol;          int height;              /* [out] */
391                  } data;          int mb_width;            /* [out] */
392          } XVID_DEC_STATS;          int mb_height;           /* [out] */
393            int fincr;               /* [out] */
394            int fbase;               /* [out] */
395    
396            void * param;            /* [out] */
397    } xvid_plg_create_t;
398    
399    
400          typedef struct          typedef struct
401          {          {
402                  int general;          int version;
                 void *bitstream;  
                 int length;  
   
                 void *image;  
                 int stride;  
                 int colorspace;  
         }  
         XVID_DEC_FRAME;  
403    
404            int num_frames; /* [out] total frame encoded */
405    } xvid_plg_destroy_t;
406    
         // This struct is used for per slice rendering  
407          typedef struct          typedef struct
408          {          {
409                  void *y,*u,*v;          int version;
                 int stride_y, stride_u,stride_v;  
         } XVID_DEC_PICTURE;  
410    
411            xvid_enc_zone_t * zone; /* [out] current zone */
412    
413  /*****************************************************************************          int width;              /* [out] */
414   * Decoder entry point          int height;             /* [out] */
415   ****************************************************************************/          int mb_width;           /* [out] */
416            int mb_height;          /* [out] */
417            int fincr;              /* [out] */
418            int fbase;              /* [out] */
419    
420            int min_quant[3];       /* [out] */
421            int max_quant[3];       /* [out] */
422    
423            xvid_image_t reference; /* [out] -> [out] */
424            xvid_image_t current;   /* [out] -> [in,out] */
425            xvid_image_t original;  /* [out] after: points the original (uncompressed) copy of the current frame */
426            int frame_num;          /* [out] frame number */
427    
428            int type;               /* [in,out] */
429            int quant;              /* [in,out] */
430    
431            int * dquant;           /* [in,out]     pointer to diff quantizer table */
432            int dquant_stride;      /* [in,out]     diff quantizer stride */
433    
434            int vop_flags;          /* [in,out] */
435            int vol_flags;          /* [in,out] */
436            int motion_flags;       /* [in,out] */
437    
438            /* Lambda table for HVSPlugins */
439            float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
440    
441  /* decoder options */  /* Deprecated, use the stats field instead.
442  #define XVID_DEC_DECODE         0   * Will disapear before 1.0 */
443  #define XVID_DEC_CREATE         1          int length;             /* [out] after: length of encoded frame */
444  #define XVID_DEC_DESTROY        2          int kblks;              /* [out] number of blocks compressed as Intra */
445            int mblks;              /* [out] number of blocks compressed as Inter */
446          int xvid_decore(void *handle,          int ublks;              /* [out] number of blocks marked not_coded */
447                                          int opt,          int sse_y;              /* [out] Y plane's sse */
448                                          void *param1,          int sse_u;              /* [out] U plane's sse */
449                                          void *param2);          int sse_v;              /* [out] V plane's sse */
450    /* End of duplicated data, kept only for binary compatibility */
451    
452            int bquant_ratio;       /* [in] */
453            int bquant_offset;      /* [in] */
454    
455            xvid_enc_stats_t stats; /* [out] frame statistics */
456    } xvid_plg_data_t;
457    
458  /*****************************************************************************  /*****************************************************************************
459   * Encoder constants    xvid plugin system -- external
  ****************************************************************************/  
460    
461  /* Flags for XVID_ENC_PARAM.global */    the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
462  #define XVID_GLOBAL_PACKED              0x00000001      /* packed bitstream */    indicates the plugin function pointer and plugin-specific data.
463  #define XVID_GLOBAL_DX50BVOP    0x00000002      /* dx50 bvop compatibility */    xvidcore handles the rest. example:
 #define XVID_GLOBAL_DEBUG               0x00000004      /* print debug info on each frame */  
 #define XVID_GLOBAL_REDUCED             0x04000000      /* reduced resolution vop enable */  
464    
465  #define XVID_GLOBAL_EXTRASTATS  0x00000200      /* generate extra statistics */    xvid_enc_create_t create;
466      xvid_enc_plugin_t plugins[2];
467    
468      plugins[0].func = xvid_psnr_func;
469      plugins[0].param = NULL;
470      plugins[1].func = xvid_cbr_func;
471      plugins[1].param = &cbr_data;
472    
473  /* Flags for XVID_ENC_FRAME.general */    create.num_plugins = 2;
474  #define XVID_VALID_FLAGS                0x80000000    create.plugins = plugins;
475    
476     ****************************************************************************/
477    
478  #define XVID_CUSTOM_QMATRIX             0x00000004      /* use custom quant matrix */  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
 #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  
479    
480  #define XVID_INTERLACING                0x00000400      /* enable interlaced encoding */  typedef struct
481  #define XVID_TOPFIELDFIRST              0x00000800      /* set top-field-first flag  */  {
482  #define XVID_ALTERNATESCAN              0x00001000      /* set alternate vertical scan flag */          xvid_plugin_func * func;
483            void * param;
484    } xvid_enc_plugin_t;
485    
 #define XVID_HINTEDME_GET               0x00002000      /* receive mv hint data from core (1st pass) */  
 #define XVID_HINTEDME_SET               0x00004000      /* send mv hint data to core (2nd pass) */  
486    
487  #define XVID_INTER4V                    0x00008000  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
488    extern xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
489    extern xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
490    
491  #define XVID_ME_ZERO                    0x00010000  extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
 #define XVID_ME_LOGARITHMIC             0x00020000  
 #define XVID_ME_FULLSEARCH              0x00040000  
 #define XVID_ME_PMVFAST                 0x00080000  
 #define XVID_ME_EPZS                    0x00100000  
492    
493  #define XVID_CHROMAOPT                  0x00200000      /* enable chroma optimization pre-filter */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
494    extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
495    
496  #define XVID_GREYSCALE                  0x01000000      /* enable greyscale only mode (even for */  extern xvid_plugin_func xvid_plugin_ssim;           /*write ssim values to stdout*/
497                                                                                          /* color input material chroma is ignored) */  extern xvid_plugin_func xvid_plugin_psnrhvsm;   /*write psnrhvsm values to stdout*/
498    
 #define XVID_GMC                                0x10000000  
 #define XVID_GMC_TRANSLATIONAL  0x20000000  
499    
500  #define XVID_REDUCED                    0x04000000      /* reduced resolution vop */  /* single pass rate control
501  #define XVID_HQACPRED                   0x08000000      /* 20030209: high quality ac prediction */   * CBR and Constant quantizer modes */
502    typedef struct
503    {
504            int version;
505    
506  #define XVID_EXTRASTATS                 0x00000200  /* generate extra statistics */          int bitrate;               /* [in] bits per second */
507            int reaction_delay_factor; /* [in] */
508            int averaging_period;      /* [in] */
509            int buffer;                /* [in] */
510    } xvid_plugin_single_t;
511    
 #define XVID_MODEDECISION_BITS  0x00400000      /* enable DCT-ME and use it for mode decision */  
512    
513    typedef struct {
514            int version;
515    
516  /* Flags for XVID_ENC_FRAME.motion */          char * filename;
517    } xvid_plugin_2pass1_t;
518    
 #define PMV_ADVANCEDDIAMOND16   0x00008000      /* use advdiamonds instead of diamonds as search pattern */  
 #define PMV_USESQUARES16                0x00800000      /* use squares instead of diamonds as search pattern */  
519    
520  #define PMV_HALFPELREFINE16     0x00020000  #define XVID_PAYBACK_BIAS 0 /* payback with bias */
521  #define PMV_HALFPELREFINE8              0x02000000  #define XVID_PAYBACK_PROP 1 /* payback proportionally */
522    
523  #define PMV_QUARTERPELREFINE16  0x00040000  typedef struct {
524  #define PMV_QUARTERPELREFINE8   0x04000000          int version;
525    
526  #define PMV_EXTSEARCH16                 0x00080000      /* extend PMV by more searches */          int bitrate;                  /* [in] target bitrate (bits per second) */
527            char * filename;              /* [in] first pass stats filename */
528    
529  #define PMV_EXTSEARCH8                  0x08000000      /* use diamond/square for extended 8x8 search */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
530  #define PMV_ADVANCEDDIAMOND8    0x00004000      /* use advdiamond for PMV_EXTSEARCH8 */          int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
531  #define PMV_USESQUARES8                 0x80000000      /* use square for PMV_EXTSEARCH8 */          int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
532            int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
533            int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
534            int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
535    
536  #define PMV_CHROMA16                    0x00100000      /* also use chroma for P_VOP/S_VOP ME */          int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
537  #define PMV_CHROMA8                             0x10000000      /* also use chroma for B_VOP ME */          int kfthreshold;              /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
538                                                                       *      is substracted from its bit allocation. The reduction is computed as multiples of
539                                                                       *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
540                                                                       *      0 for 1<distance<kfthreshold */
541    
542  /* Motion search using DCT. use XVID_MODEDECISION_DCT to enable */          int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
 #define HALFPELREFINE16_BITS    0x00000100      /* perform DCT-based halfpel refinement */  
 #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 */  
543    
544  #define EXTSEARCH_BITS                  0x00001000      /* perform DCT-based search using square pattern */  /* ------- v1.1.x ------- */
545                                                                                          /* enable PMV_EXTSEARCH8 to do this in 8x8 search as well */          int vbv_size;                 /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/
546  #define CHECKPREDICTION_BITS    0x00002000      /* always check vector equal to prediction */          int vbv_initial;              /* [in] initial buffer occupancy (bits) */
547            int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
548            int vbv_peakrate;             /* [in:opt] max average bitrate over 1 second (bits per second).
549                                                                       *          This is used for diagnostics only and won't affect the actual peak bitrate.
550                                                                       *          This is not a problem as long as vbv_peakrate > vbv_size + vbv_maxrate which
551                                                                       *          guarantees that vbv_peakrate won't be exceeded. */
552    }xvid_plugin_2pass2_t;
553    
554    
555  /* note: old and deprecated - or never implemented */  typedef struct{
556            /*stat output*/
557            int b_printstat;
558            char* stat_path;
559    
560  /* only for compatability with old encoders */          /*visualize*/
561            int b_visualize;
562    
563  #define PMV_EARLYSTOP16                 0x00          /*accuracy 0 very accurate 4 very fast*/
564  #define PMV_EARLYSTOP8                  0x00          int acc;
 #define PMV_QUICKSTOP16                 0x00  
 #define PMV_QUICKSTOP8                  0x00  
565    
566  #define PMV_HALFPELDIAMOND16    0x00      int cpu_flags; /* XVID_CPU_XXX flags */
 #define PMV_HALFPELDIAMOND8     0x00  
567    
568  #define PMV_UNRESTRICTED16      0x00200000      /* unrestricted ME, not implemented */  } xvid_plugin_ssim_t;
 #define PMV_OVERLAPPING16       0x00400000      /* overlapping ME, not implemented */  
 #define PMV_UNRESTRICTED8       0x20000000      /* unrestricted ME, not implemented */  
 #define PMV_OVERLAPPING8                0x40000000      /* overlapping ME, not implemented */  
569    
570  #define XVID_ME_COLOUR                  0x00    /* this has been converted to PMV_CHROMA[16/8] */  typedef struct {
571            int version;
572    
573            int method;      /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */
574    } xvid_plugin_lumimasking_t;
575    
576  /*****************************************************************************  /*****************************************************************************
577   * Encoder structures   *                             ENCODER API
578   ****************************************************************************/   ****************************************************************************/
579    
580          typedef struct  /*----------------------------------------------------------------------------
581          {   * Encoder operations
582                  int width, height;   *--------------------------------------------------------------------------*/
583                  int fincr, fbase;               /* frame increment, fbase. each frame = "fincr/fbase" seconds */  
584                  int rc_bitrate;                 /* the bitrate of the target encoded stream, in bits/second */  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
585                  int rc_reaction_delay_factor;   /* how fast the rate control reacts - lower values are faster */  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
586                  int rc_averaging_period;        /* as above */  #define XVID_ENC_ENCODE  2 /* encode a frame: returns number of ouput bytes
587                  int rc_buffer;                  /* as above */                              * 0 means this frame should not be written (ie. encoder lag) */
588                  int max_quantizer;              /* the upper limit of the quantizer */  
589                  int min_quantizer;              /* the lower limit of the quantizer */  
590                  int max_key_interval;   /* the maximum interval between key frames */  /*----------------------------------------------------------------------------
591  #ifdef _SMP   * Encoder entry point
592                  int num_threads;                /* number of threads */   *--------------------------------------------------------------------------*/
593  #endif  
594                  int global;                             /* global/debug options */  extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
595                  int max_bframes;                /* max sequential bframes (0=disable bframes) */  
596                  int bquant_ratio;               /* bframe quantizer multipier (percentage).  /* Quick API reference
597                                                                   * used only when bquant < 1   *
598                                                                   * eg. 200 = x2 multiplier   * XVID_ENC_CREATE operation
599                                                                   * quant = ((past_quant + future_quant) * bquant_ratio)/200   *  - handle: ignored
600     *  - opt: XVID_ENC_CREATE
601     *  - param1: address of a xvid_enc_create_t structure
602     *  - param2: ignored
603     *
604     * XVID_ENC_ENCODE operation
605     *  - handle: an instance returned by a CREATE op
606     *  - opt: XVID_ENC_ENCODE
607     *  - param1: address of a xvid_enc_frame_t structure
608     *  - param2: address of a xvid_enc_stats_t structure (optional)
609     *            its return value is asynchronous to what is written to the buffer
610     *            depending on the delay introduced by bvop use. It's display
611     *            ordered.
612     *
613     * XVID_ENC_DESTROY operation
614     *  - handle: an instance returned by a CREATE op
615     *  - opt: XVID_ENC_DESTROY
616     *  - param1: ignored
617     *  - param2: ignored
618                                                                   */                                                                   */
                 int bquant_offset;              /* bquant += bquant_offset */  
                 int frame_drop_ratio;   /* frame dropping: 0=drop none... 100=drop all */  
                 void *handle;                   /* [out] encoder instance handle */  
         }  
         XVID_ENC_PARAM;  
619    
         typedef struct  
         {  
                 int x;  
                 int y;  
         }  
         VECTOR;  
620    
621          typedef struct  /*----------------------------------------------------------------------------
622          {   * "Global" flags
623                  int mode;                               /* macroblock mode */   *
624                  VECTOR mvs[4];   * These flags are used for xvid_enc_create_t->global field during instance
625          }   * creation (operation XVID_ENC_CREATE)
626          MVBLOCKHINT;   *--------------------------------------------------------------------------*/
627    
628    #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
629    #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
630    #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
631    #if 0
632    #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
633    #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
634    #endif
635    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
636                                                    this is implied if XVID_GLOBAL_PACKED is set */
637    
638          typedef struct  /*----------------------------------------------------------------------------
639          {   * "VOL" flags
640                  int intra;                              /* frame intra choice */   *
641                  int fcode;                              /* frame fcode */   * These flags are used for xvid_enc_frame_t->vol_flags field during frame
642                  MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */   * encoding (operation XVID_ENC_ENCODE)
643          }   *--------------------------------------------------------------------------*/
644          MVFRAMEHINT;  
645    #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
646    #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
647    #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
648    #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
649    #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
650                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
651    #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
652    
653    
654    /*----------------------------------------------------------------------------
655     * "VOP" flags
656     *
657     * These flags are used for xvid_enc_frame_t->vop_flags field during frame
658     * encoding (operation XVID_ENC_ENCODE)
659     *--------------------------------------------------------------------------*/
660    
661    /* Always valid */
662    #define XVID_VOP_DEBUG                (1<< 0) /* print debug messages in frames */
663    #define XVID_VOP_HALFPEL              (1<< 1) /* use halfpel interpolation */
664    #define XVID_VOP_INTER4V              (1<< 2) /* use 4 motion vectors per MB */
665    #define XVID_VOP_TRELLISQUANT         (1<< 3) /* use trellis based R-D "optimal" quantization */
666    #define XVID_VOP_CHROMAOPT            (1<< 4) /* enable chroma optimization pre-filter */
667    #define XVID_VOP_CARTOON              (1<< 5) /* use 'cartoon mode' */
668    #define XVID_VOP_GREYSCALE            (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
669    #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */
670    #define XVID_VOP_MODEDECISION_RD      (1<< 8) /* enable DCT-ME and use it for mode decision */
671    #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
672    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
673    #define XVID_VOP_RD_PSNRHVSM          (1<<14) /* use PSNR-HVS-M as metric for rate-distortion optimizations */
674    
675    /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
676    #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
677    #define XVID_VOP_ALTERNATESCAN        (1<<10) /* set alternate vertical scan flag */
678    
679    /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
680    #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */
681                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
682    
683    /*----------------------------------------------------------------------------
684     * "Motion" flags
685     *
686     * These flags are used for xvid_enc_frame_t->motion field during frame
687     * encoding (operation XVID_ENC_ENCODE)
688     *--------------------------------------------------------------------------*/
689    
690    /* Motion Estimation Search Patterns */
691    #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
692    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
693    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
694    #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
695    
696    /* SAD operator based flags */
697    #define XVID_ME_HALFPELREFINE16       (1<< 4)
698    #define XVID_ME_HALFPELREFINE8        (1<< 6)
699    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
700    #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
701    #define XVID_ME_GME_REFINE            (1<< 9)
702    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
703    #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
704    #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
705    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
706    #define XVID_ME_FASTREFINE16          (1<<25) /* use low-complexity refinement functions */
707    #define XVID_ME_FASTREFINE8           (1<<29) /* low-complexity 8x8 sub-block refinement */
708    
709    /* Rate Distortion based flags
710     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
711    #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
712    #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
713    #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
714    #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
715    #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 */
716    #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
717    
718    /* Other */
719    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
720    #define XVID_ME_SKIP_DELTASEARCH      (1<<26) /* speed-up by skipping b-frame delta search */
721    #define XVID_ME_FAST_MODEINTERPOLATE  (1<<27) /* speed-up by partly skipping interpolate mode */
722    #define XVID_ME_BFRAME_EARLYSTOP      (1<<28) /* speed-up by early exiting b-search */
723    
724    /* Unused */
725    #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
726    #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
727    #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
728    #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
729    
730    
731    /*----------------------------------------------------------------------------
732     * xvid_enc_create_t structure definition
733     *
734     * This structure is passed as param1 during an instance creation (operation
735     * XVID_ENC_CREATE)
736     *--------------------------------------------------------------------------*/
737    
738    typedef struct {
739            int version;
740    
741            int profile;                 /* [in] profile@level; refer to XVID_PROFILE_xxx */
742            int width;                   /* [in] frame dimensions; width, pixel units */
743            int height;                  /* [in] frame dimensions; height, pixel units */
744    
745            int num_zones;               /* [in:opt] number of bitrate zones */
746            xvid_enc_zone_t * zones;     /*          ^^ zone array */
747    
748            int num_plugins;             /* [in:opt] number of plugins */
749            xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
750    
751            int num_threads;             /* [in:opt] number of threads to use in encoder */
752            int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
753    
754            int global;                  /* [in:opt] global flags; controls encoding behavior */
755    
756            /* --- vol-based stuff; included here for convenience */
757            int fincr;                   /* [in:opt] framerate increment; set to zero for variable framerate */
758            int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
759        /* ---------------------------------------------- */
760    
761            /* --- vop-based; included here for convenience */
762            int max_key_interval;        /* [in:opt] the maximum interval between key frames */
763    
764            int frame_drop_ratio;        /* [in:opt] frame dropping: 0=drop none... 100=drop all */
765    
766            int bquant_ratio;            /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
767            int bquant_offset;           /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
768    
769            int min_quant[3];            /* [in:opt] */
770            int max_quant[3];            /* [in:opt] */
771            /* ---------------------------------------------- */
772    
773          typedef struct          void *handle;                /* [out] encoder instance handle */
         {  
                 int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */  
774    
775                  MVFRAMEHINT mvhint;          /* ------- v1.3.x ------- */
776                  void *hintstream;               /* compressed hint buffer */          int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */
777                  int hintlength;                 /* length of buffer (bytes) */          int num_slices;              /* [in:opt] number of slices to code for each frame */
778          }  } xvid_enc_create_t;
         HINTINFO;  
779    
         typedef struct  
         {  
                 int general;                    /* [in] general options */  
                 int motion;                             /* [in] ME options */  
                 void *bitstream;                /* [in] bitstream ptr */  
                 int length;                             /* [out] bitstream length (bytes) */  
780    
781                  void *image;                    /* [in] image ptr */  /*----------------------------------------------------------------------------
782                  int stride;   * xvid_enc_frame_t structure definition
783                  int colorspace;                 /* [in] source colorspace */   *
784     * This structure is passed as param1 during a frame encoding (operation
785                  unsigned char *quant_intra_matrix;      // [in] custom intra qmatrix */   * XVID_ENC_ENCODE)
786                  unsigned char *quant_inter_matrix;      // [in] custom inter qmatrix */   *--------------------------------------------------------------------------*/
                 int quant;                              /* [in] frame quantizer (vbr) */  
                 int intra;                              /* [in] force intra frame (vbr only)  
                                                                  * [out] intra state  
                                                                  */  
                 HINTINFO hint;                  /* [in/out] mv hint information */  
787    
788                  int bquant;                             /* [in] bframe quantizer */  /* out value for the frame structure->type field
789     * unlike stats output in param2, this field is not asynchronous and tells
790     * the client app, if the frame written into the stream buffer is an ivop
791     * usually used for indexing purpose in the container */
792    #define XVID_KEYFRAME (1<<1)
793    
794          }  /* The structure */
795          XVID_ENC_FRAME;  typedef struct {
796            int version;
797    
798            /* VOL related stuff
799             * unless XVID_FORCEVOL is set, the encoder will not react to any changes
800             * here until the next VOL (keyframe). */
801    
802          typedef struct          int vol_flags;                     /* [in] vol flags */
803          {          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
804                  int quant;                              /* [out] frame quantizer */          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
                 int hlength;                    /* [out] header length (bytes) */  
                 int kblks, mblks, ublks;        /* [out] */  
                 long sse_y;                             /* [out] SSE of Y */  
                 long sse_u;                             /* [out] SSE of Cb */  
                 long sse_v;                             /* [out] SSE of Cr */  
         }  
         XVID_ENC_STATS;  
805    
806            int par;                           /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */
807            int par_width;                     /* [in:opt] aspect ratio width */
808            int par_height;                    /* [in:opt] aspect ratio height */
809    
810  /*****************************************************************************          /* Other fields that can change on a frame base */
811   * Encoder entry point  
812   ****************************************************************************/          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
813            int vop_flags;                     /* [in] (general)vop-based flags */
814            int motion;                        /* [in] ME options */
815    
816            xvid_image_t input;                /* [in] input image (read from) */
817    
818            int type;                          /* [in:opt] coding type */
819            int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
820            int bframe_threshold;
821    
822  /* Encoder options */          void *bitstream;                   /* [in:opt] bitstream ptr (written to)*/
823  #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);  
824    
825            int out_flags;                     /* [out] bitstream output flags */
826    } xvid_enc_frame_t;
827    
828  #ifdef __cplusplus  #ifdef __cplusplus
829  }  }

Legend:
Removed from v.1.17.2.30  
changed lines
  Added in v.1.76

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