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

Legend:
Removed from v.199  
changed lines
  Added in v.1743

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