[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.11, Fri Jun 14 13:27:47 2002 UTC revision 1.27.2.6, Sat Mar 15 14:32:56 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 file is part of XviD, a free MPEG-4 video encoder/decoder
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  *  *
 *****************************************************************************/  
 /*****************************************************************************  
 *  
 *  History  
 *  
 *  - 2002/06/13 Added legal header, ANSI C comment style (only for this header  
 *               as it can be included in a ANSI C project).  
 *  
 *               ToDo ? : when BFRAMES is defined, the API_VERSION should not  
 *                        be the same (3.0 ?)  
 *  
22  *  $Id$  *  $Id$
23  *  *
24  *****************************************************************************/   ****************************************************************************/
   
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
29    
30  #ifdef __cplusplus  #ifdef __cplusplus
31  *  $Id$  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_MAJOR(a)                           ( ((a)>>16) & 0xff )
53  #define XVID_ERR_OK                     0  #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))
54  #define XVID_ERR_MEMORY         1  #define XVID_PATCH(c)                           ( (c) & 0xff )
55  #define XVID_ERR_FORMAT         2  
56    #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)
57    #define XVID_UNSTABLE
58  /* Colorspaces */  
59  #define XVID_CSP_RGB24  0  /* Bitstream Version
60  #define XVID_CSP_YV12   1   * this will be writen into the bitstream to allow easy detection of xvid
61  #define XVID_CSP_YUY2   2   * encoder bugs in the decoder, without this it might not possible to
62  #define XVID_CSP_UYVY   3   * automatically distinquish between a file which has been encoded with an
63  #define XVID_CSP_I420   4   * old & buggy XVID from a file which has been encoded with a bugfree version
64  #define XVID_CSP_RGB555 10   * see the infamous interlacing bug ...
65  #define XVID_CSP_RGB565 11   *
66  #define XVID_CSP_USER   12   * this MUST be increased if an encoder bug is fixed, increasing it too often
67  #define XVID_CSP_EXTERN      1004  // per slice rendering   * doesnt hurt but not increasing it could cause difficulty for decoders in the
68  #define XVID_CSP_YVYU   1002   * future
69  #define XVID_CSP_RGB32  1000   */
70  #define XVID_CSP_NULL   9999  #define XVID_BS_VERSION "0009"
   
 #define XVID_CSP_VFLIP  0x80000000      // flip mask  
71    
72    
73  /*****************************************************************************  /*****************************************************************************
74     * error codes
75   ****************************************************************************/   ****************************************************************************/
76    
77  /* CPU flags for XVID_INIT_PARAM.cpu_flags */      /*  all functions return values <0 indicate error */
   
 #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  #define XVID_CPU_IA64           0x00000080  #define XVID_ERR_FAIL           -1              /* general fault */
80    #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                  int cpu_flags;  
93                  int api_version;  #define XVID_CSP_USER           0       /* 4:2:0 planar */
94                  int core_build;  #define XVID_CSP_I420           1       /* 4:2:0 packed(planar win32) */
95          }  #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */
96          XVID_INIT_PARAM;  #define XVID_CSP_YUY2           3       /* 4:2:2 packed */
97    #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       /* 32-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    
120    /* aspect ratios */
121    #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */
122    #define XVID_PAR_43_PAL     2   /* 4:3 pal (12:11 625-line) */
123    #define XVID_PAR_43_NTSC        3       /* 4:3 ntsc (10:11 525-line) */
124    #define XVID_PAR_169_PAL        4       /* 16:9 pal (16:11 625-line) */
125    #define XVID_PAR_169_NTSC       5       /* 16:9 ntsc (40:33 525-line) */
126    #define XVID_PAR_EXT            15      /* extended par; use par_width, par_height */
127    
128    /* frame type flags */
129    #define XVID_TYPE_VOL           -1              /* decoder only: vol was decoded */
130    #define XVID_TYPE_NOTHING       0               /* decoder only (encoder stats): nothing was decoded/encoded */
131    #define XVID_TYPE_AUTO          0               /* encoder: automatically determine coding type */
132    #define XVID_TYPE_IVOP          1               /* intra frame */
133    #define XVID_TYPE_PVOP          2               /* predicted frame */
134    #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */
135    #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */
136    
137  /*****************************************************************************  /*****************************************************************************
138   *  Initialization entry point   * xvid_global()
139   ****************************************************************************/   ****************************************************************************/
140    
141          int xvid_init(void *handle,  /* cpu_flags definitions */
142                                    int opt,  
143                                    void *param1,  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */
144                                    void *param2);  #define XVID_CPU_ASM        0x00000080  /* native assembly */
145    /* ARCH_IS_IA32 */
146    #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */
147    #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */
148    #define XVID_CPU_SSE        0x00000004   /* sse      : pentium3, athlonXP */
149    #define XVID_CPU_SSE2       0x00000008   /* sse2     : pentium4, athlon64 */
150    #define XVID_CPU_3DNOW      0x00000010   /* 3dnow    : k6-2 */
151    #define XVID_CPU_3DNOWEXT   0x00000020   /* 3dnow-ext: athlon */
152    #define XVID_CPU_TSC        0x00000040   /* timestamp counter */
153    /* ARCH_IS_PPC */
154    #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */
155    
156    
157    /* XVID_GBL_INIT param1 */
158    typedef struct {
159            int version;
160            int cpu_flags;                  /* [in:opt]     zero = autodetect cpu
161                                                                            XVID_CPU_FORCE|{cpu features} = force cpu features */
162    } xvid_gbl_init_t;
163    
164    
165    /* XVID_GBL_INFO param1 */
166    typedef struct {
167            int version;
168            int actual_version;             /* [out]        returns the actual xvidcore version */
169            const char * build;             /* [out]        if !null, points to description of this xvid core build */
170            int cpu_flags;                  /* [out]        detected cpu features */
171            int num_threads;                /* [out]        detected number of cpus/threads */
172    } xvid_gbl_info_t;
173    
174    
175    /* XVID_GBL_CONVERT param1 */
176    typedef struct {
177            int version;
178            xvid_image_t input;     /* [in] input image & colorspace */
179            xvid_image_t output;    /* [in] output image & colorspace */
180            int width;                              /* [in] width */
181            int height;                             /* [in] height */
182            int interlacing;                /* [in] interlacing */
183    } xvid_gbl_convert_t;
184    
185    
186    #define XVID_GBL_INIT           0       /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
187    #define XVID_GBL_INFO           1       /* return some info about xvidcore, and the host computer */
188    #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
189    #define XVID_GBL_TEST           3       /* testing.. */
190    
191    int xvid_global(void *handle, int opt, void *param1, void *param2);
192    
193    
194  /*****************************************************************************  /*****************************************************************************
195   * Decoder constants   * xvid_decore()
196   ****************************************************************************/   ****************************************************************************/
197    
198  /* Flags for XVID_DEC_FRAME.general */  #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */
199  #define XVID_QUICK_DECODE               0x00000010  #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */
200    #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */
201    
202    int xvid_decore(void *handle, int opt, void *param1, void *param2);
203    
204    /* XVID_DEC_CREATE param 1
205            image width & height may be specified here when the dimensions are
206            known in advance. */
207    typedef struct {
208            int version;
209            int width;                              /* [in:opt]     image width */
210            int height;                             /* [in:opt]     image width */
211            void * handle;                  /* [out]        decore context handle */
212    } xvid_dec_create_t;
213    
214    
215    /* XVID_DEC_DECODE param1 */
216    /* general flags */
217    #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */
218    #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */
219    
220    typedef struct {
221            int version;
222            int general;                    /* [in:opt] general flags */
223            void *bitstream;                /* [in] bitstream (read from)*/
224            int length;                             /* [in] bitstream length */
225            xvid_image_t output;    /* [in] output image (written to) */
226    }
227    xvid_dec_frame_t;
228    
229    
230    /* XVID_DEC_DECODE param2 :: optional */
231    typedef struct
232    {
233            int version;
234            int type;                               /* [out]        output data type */
235            union {
236                    struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
237                            int general;            /* [out]        flags */
238                            int time_base;          /* [out]        time base */
239                            int time_increment;     /* [out]        time increment */
240    
241                            /* XXX: external deblocking stuff */
242                            unsigned char * qscale; /* [out]        pointer to quantizer table */
243                            int qscale_stride;              /* [out]        quantizer scale stride */
244    
245                    } vop;
246                    struct {        /* XVID_TYPE_VOL */
247                            int general;            /* [out]        flags */
248                            int width;                      /* [out]        width */
249                            int height;                     /* [out]        height */
250                            int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */
251                            int par_width;          /* [out]        aspect ratio width */
252                            int par_height;         /* [out]        aspect ratio height */
253                    } vol;
254            } data;
255    } xvid_dec_stats_t;
256    
257    
258  /*****************************************************************************  /*****************************************************************************
259   * Decoder structures    xvid plugin system -- internals
260    
261      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
262      before encoding each frame xvidcore will call XVID_PLG_BEFORE
263      after encoding each frame xvidcore will call XVID_PLG_AFTER
264      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
265   ****************************************************************************/   ****************************************************************************/
266    
267    #define XVID_PLG_CREATE     0
268    #define XVID_PLG_DESTROY    1
269    #define XVID_PLG_INFO       2
270    #define XVID_PLG_BEFORE     3
271    #define XVID_PLG_AFTER      4
272    
273    /* xvid_plg_info_t.flags */
274    #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */
275    
276    
277          typedef struct          typedef struct
278          {          {
279                  int width;      int version;
280                  int height;      int flags;              /* plugin flags */
281                  void *handle;  } xvid_plg_info_t;
         }  
         XVID_DEC_PARAM;  
282    
283    
284          typedef struct          typedef struct
285          {          {
286                  int general;      int version;
287                  void *bitstream;  
288                  int length;      int width, height;
289            int fincr, fbase;
290                  void *image;  
291                  int stride;      void * param;
292                  int colorspace;  } xvid_plg_create_t;
         }  
         XVID_DEC_FRAME;  
293    
294    
         // This struct is used for per slice rendering  
295          typedef struct          typedef struct
296          {          {
297                  void *y,*u,*v;      int version;
                 int stride_y, stride_u,stride_v;  
         } XVID_DEC_PICTURE;  
   
 #define XVID_DEC_DESTROY        2  
   
         int xvid_decore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
298    
299        int width;              /* [out] */
300        int height;             /* [out] */
301            int fincr;              /* [out] */
302        int fbase;              /* [out] */
303    
304  /*****************************************************************************      xvid_image_t reference; /* [out] -> [out] */
305   * Encoder constants      xvid_image_t current;   /* [out] -> [in,out] */
306   ****************************************************************************/      xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
307        int frame_num;          /* [out] frame number */
308    
309        int type;               /* [in,out] */
310        int quant;              /* [in,out] */
311    
312        unsigned char * qscale;     /* [in,out]     pointer to quantizer table */
313            int qscale_stride;              /* [in,out]     quantizer scale stride */
314    
315        int vop_flags;          /* [in,out] */
316        int vol_flags;          /* [in,out] */
317        int motion_flags;       /* [in,out] */
318    
319  /* Flags for XVID_ENC_PARAM.global */      int length;                 /* [out] after: length of encoded frame */
320  #define XVID_GLOBAL_PACKED              0x00000001      /* packed bitstream */      int kblks, mblks, ublks;    /* [out] after: */
321  #define XVID_GLOBAL_DX50BVOP    0x00000002      /* dx50 bvop compatibility */  } xvid_plg_data_t;
 #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  
322    
323    
324  /*****************************************************************************  /*****************************************************************************
325   * Encoder structures    xvid plugin system -- external
326    
327      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
328      indicates the plugin function pointer and plugin-specific data.
329      xvidcore handles the rest. example:
330    
331      xvid_enc_create_t create;
332      xvid_enc_plugin_t plugins[2];
333    
334      plugins[0].func = xvid_psnr_func;
335      plugins[0].param = NULL;
336      plugins[1].func = xvid_cbr_func;
337      plugins[1].param = &cbr_data;
338    
339      create.num_plugins = 2;
340      create.plugins = plugins;
341    
342   ****************************************************************************/   ****************************************************************************/
343    
344          typedef struct  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
         {  
                 int width, height;  
                 int fincr, 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  
 #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;  
345    
346          typedef struct          typedef struct
347          {          {
348                  int x;      xvid_plugin_func * func;
349          }      void * param;
350          VECTOR;  } xvid_enc_plugin_t;
351    
352          typedef struct  xvid_plugin_func xvid_plugin_psnr;  /* stdout psnr calculator */
353          {  xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
                 int mode;                               /* macroblock mode */  
                 VECTOR mvs[4];  
         }  
         MVBLOCKHINT;  
354    
         typedef struct  
         {  
                 int intra;                              /* frame intra choice */  
                 int fcode;                              /* frame fcode */  
                 MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */  
         }  
         MVFRAMEHINT;  
355    
         typedef struct  
         {  
                 int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */  
356    
357                  MVFRAMEHINT mvhint;  /*****************************************************************************
358                  void *hintstream;               /* compressed hint buffer */   * xvid_encore()
359                  int hintlength;                 /* length of buffer (bytes) */   ****************************************************************************/
         }  
         HINTINFO;  
360    
361          typedef struct  /* Encoder options */
362    #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
363    #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
364    #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
365                                                                            0 means this frame should not be written (ie. encoder lag) */
366    
367    int xvid_encore(void *handle, int opt, void *param1, void *param2);
368    
369    
370    /* global flags  */
371    typedef enum
372          {          {
373                  int general;                    /* [in] general options */      XVID_PACKED                 = 0x00000001,   /* packed bitstream */
374                  int motion;                             /* [in] ME options */      XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
375                  void *bitstream;                /* [in] bitstream ptr */  /*define XVID_VOL_AT_IVOP       0x00000008       write vol at every ivop: WIN32/divx compatibility */
376                  int length;                             /* [out] bitstream length (bytes) */  /*define XVID_FORCE_VOL         0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
377    } xvid_global_t;
                 void *image;                    /* [in] image ptr */  
                 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 */  
378    
 #ifdef BFRAMES  
                 int bquant;                             /* [in] bframe quantizer */  
 #endif  
379    
380    /* XVID_ENC_ENCODE param1 */
381    /* vol-based flags */
382    typedef enum {
383        XVID_MPEGQUANT          = 0x00000001,
384        XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
385        XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
386        XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
387        XVID_INTERLACING        = 0x00000400, /* enable interlaced encoding */
388    } xvid_vol_t;
389    
390    
391    /* vop-based flags */
392    typedef enum {
393        XVID_DEBUG              = 0x00000001,
394    
395        XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */
396        XVID_INTER4V            = 0x00000008,
397        XVID_LUMIMASKING        = 0x00000010,
398    
399        XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
400        XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
401                                                  color input material chroma is ignored) */
402        XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
403        XVID_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
404        XVID_DYNAMIC_BFRAMES    = 0x00000200,
405    
406            /* only valid for vol_flags|=XVID_INTERLACING */
407        XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
408        XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
409    
410        /* only valid for vol_flags|=XVID_REDUCED_ENABLED */
411        XVID_REDUCED            = 0x00001000, /* reduced resolution vop */
412    } xvid_vop_t;
413    
414    
415    typedef enum {
416        PMV_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
417        PMV_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
418    
419        PMV_HALFPELREFINE16     = 0x00020000,
420        PMV_HALFPELREFINE8      = 0x02000000,
421    
422        PMV_QUARTERPELREFINE16  = 0x00040000,
423        PMV_QUARTERPELREFINE8   = 0x04000000,
424    
425        PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
426    
427        PMV_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
428        PMV_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */
429        PMV_USESQUARES8         = 0x80000000, /* use square for PMV_EXTSEARCH8 */
430    
431        PMV_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
432        PMV_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
433    
434        /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */
435        HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
436        HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
437        QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
438        QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
439    
440        EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
441                                                      enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
442        CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
443    
444        PMV_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
445        PMV_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
446        PMV_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
447        PMV_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
448    } xvid_motion_t;
449    
450    
451    /* XVID_ENC_CREATE param1 */
452    typedef struct {
453            int version;
454            int width;                              /* [in]         frame dimensions; width, pixel units */
455            int height;                             /* [in]         frame dimensions; height, pixel units */
456    
457        int num_plugins;        /* [in:opt] number of plugins */
458        xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
459    
460            int num_threads;                /* [in:opt]     number of threads */
461            int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
462    
463            xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */
464    
465    /* --- vol-based stuff; included here for conveinience */
466            int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
467            int fbase;                              /* [in] framerate base
468                                                                                    frame_duration = fincr/fbase seconds*/
469    /* ^^^---------------------------------------------- */
470    
471    
472    /* ---vop-based; included here for conveienience */
473            int max_key_interval;   /* [in:opt] the maximum interval between key frames */
474                                                                                    /*XXX: maybe call it gop_size? */
475    
476            int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
477    
478            int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
479            int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
480    
481    /* ^^^ -------------------------------------------------------------------------*/
482    
483            void *handle;                   /* [out] encoder instance handle */
484          }          }
485          XVID_ENC_FRAME;  xvid_enc_create_t;
486    
487    
488          typedef struct  typedef struct {
489          {          int version;
490                  int quant;                              /* [out] frame quantizer */          int type;                               /* [in] rate control type: XVID_RC_xxx */
491                  int input_consumed;             /* [out] */  
492                  int hlength;                    /* [out] header length (bytes) */          /* common stuff */
493                  int kblks, mblks, ublks;        /* [out] */          int min_iquant;         /* [in:opt] ivop quantizer upper/lower limit */
494            int max_iquant;         /* [in:opt] */
495            int min_pquant;         /* [in:opt] psvop quantizer upper/lower limit */
496            int max_pquant;         /* [in:opt]  */
497            int min_bquant;         /* [in:opt] bvop quantizer upper/lower limit */
498            int max_bquant;         /* [in:opt] */
499    
500            union {
501                    struct {        /* XVID_RC_FQUANT */
502                            float quant;                            /* [in] quantizer */
503                    } fquant;
504                    struct {        /* XVID_RC_CBR */
505                            int bitrate;                            /* [in] the bitrate of the target encoded stream, in bits/second */
506                            int reaction_delay_factor;      /* [in] how fast the rate control reacts - lower values are faster */
507                            int averaging_period;           /* [in] */
508                            int buffer;                                     /* [in] */
509                    } cbr;
510            } data;
511    } xvid_enc_rc_t;
512    
513    
514    
515    #define XVID_KEYFRAME   0x00000001
516    
517    typedef struct {
518            int version;
519    
520    /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
521                    changes here until the next VOL (keyframe). */
522            xvid_vol_t vol_flags;                   /* [in] vol flags */
523            unsigned char *
524                    quant_intra_matrix;     /* [in:opt] custom intra qmatrix */
525            unsigned char *
526                    quant_inter_matrix;     /* [in:opt] custom inter qmatrix */
527    
528            int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
529            int par_width;                  /* [in:opt] aspect ratio width */
530            int par_height;                 /* [in:opt] aspect ratio height */
531    /* ^^^----------------------------------------------------------------------------------*/
532    
533            xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
534            xvid_motion_t motion;                           /* [in] ME options */
535    
536            xvid_image_t input;     /* [in] input image (read from) */
537    
538            int type;                               /* [in:opt] coding type */
539            int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
540            int bquant;                             /* [in:opt] bframe quantizer; if <=0, automatic*/
541    
542            void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
543            int length;                             /* [in:opt] bitstream length (bytes) */
544    
545            int out_flags;                          /* [out] bitstream output flags */
546          }          }
547          XVID_ENC_STATS;  xvid_enc_frame_t;
548    
549    
550  /*****************************************************************************  /* XVID_ENC_ENCODE param2 (optional)
551   * Encoder entry point          xvid_enc_stats_t describes individual frame details
  ****************************************************************************/  
552    
553  /* Encoder options */          coding_type==XVID_TYPE_NOTHING if the stats are not given
554  #define XVID_ENC_ENCODE         0  */
555  #define XVID_ENC_CREATE         1  typedef struct {
556  #define XVID_ENC_DESTROY        2          int version;
   
         int xvid_encore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
557    
558            /* encoding parameters */
559            int type;                                       /* [out] coding type */
560            int quant;                                      /* [out] frame quantizer */
561            xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */
562            int vop_flags;                          /* [out] vop flags (see above) */
563            /* bitrate */
564            int length;                                     /* [out] frame length */
565    
566            int hlength;                            /* [out] header length (bytes) */
567            int kblks, mblks, ublks;        /* [out] */
568    
569        int sse_y, sse_u, sse_v;
570    }
571    xvid_enc_stats_t;
572    
573  #ifdef __cplusplus  #ifdef __cplusplus
574  }  }
575  #endif  #endif
576    
577    
578  #endif  #endif

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.27.2.6

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