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

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.27.2.24

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