[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.20, Mon Oct 21 23:13:53 2002 UTC revision 1.27.2.16, Sun Apr 27 14:21:35 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   *  This file is part of XviD, a free MPEG-4 video encoder/decoder
  *  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    
   
 /**  
  * \defgroup global_grp   Global constants used in both encoder and decoder.  
  *  
  * This module describe all constants used in both the encoder and the decoder.  
  * @{  
  */  
   
34  /*****************************************************************************  /*****************************************************************************
35   *  API version number   * versioning
36   ****************************************************************************/   ****************************************************************************/
37    
38  /**  /* versioning
39   * \defgroup api_grp API version          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  #define API_VERSION ((2 << 16) | (1))/**< This constant tells you what XviD's  #define XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )
52                                        *   version this header defines.  #define XVID_MAJOR(a)                           ( ((a)>>16) & 0xff )
53                                        *  #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))
54   * You can use it to check if the host XviD library API is the same as the one  #define XVID_PATCH(c)                           ( (c) & 0xff )
55   * you used to build you client program. If versions mismatch, then it is  
56   * highly possible that your application will segfault because the host XviD  #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)
57   * library and your application use structure fields in different ways.  #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 "0009"
 /** @} */  
71    
72    
73  /*****************************************************************************  /*****************************************************************************
74   *  Error codes   * error codes
75   ****************************************************************************/   ****************************************************************************/
76    
77        /*  all functions return values <0 indicate error */
78    
79  /**  #define XVID_ERR_FAIL           -1              /* general fault */
80   * \defgroup error_grp Error codes used by XviD API entry points.  #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_ERR_FAIL   -1 /**< Operation failed.  
                             *  
  * The requested XviD operation failed. If this error code is returned from :  
  * <ul>  
  * <li>the xvid_init function : you must not try to use an XviD's instance from  
  *                              this point of the code. Clean all instances you  
  *                              already created and exit the program cleanly.  
  * <li>xvid_encore or xvid_decore : something was wrong and en/decoding  
  *                                  operation has not been completed  
  *                                 sucessfully. At your option, you can  
  *                                 stop the en/decoding process or just ignore  
  *                                 and go on.  
  * <li>xvid_stop : you can safely ignore it if you call this function at the  
  *                 end of your program.  
  * </ul>  
  */  
85    
 #define XVID_ERR_OK      0 /**< Operation succeed.  
                             *  
  * The requested XviD operation succeed, you can continue to use XviD's  
  * functions.  
  */  
86    
87  #define XVID_ERR_MEMORY  1 /**< Operation failed.  /*****************************************************************************
88                              *   * xvid_image_t
89   * No memory was available on the host system, this is probably time to kill   ****************************************************************************/
  * some unuseful programs (WinSpyWare, KDE, GNOME</trollinside>) in order to  
  * use XviD.  
  */  
90    
91  #define XVID_ERR_FORMAT  2 /**< Operation failed.  /* colorspace values */
92                              *  
93   * The format of the parameters, input stream were wrong.  #define XVID_CSP_USER           0       /* 4:2:0 planar */
94   */  #define XVID_CSP_I420           1       /* 4:2:0 packed(planar win32) */
95    #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */
96    #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   *  Color space constants   * xvid_global()
139   ****************************************************************************/   ****************************************************************************/
140    
141    /* cpu_flags definitions */
142    
143  /**  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */
144   * \defgroup csp_grp Colorspaces constants.  #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    
 #define XVID_CSP_RGB24  0  /**< Input/output frame uses the RGB24 colorspace format */  
 #define XVID_CSP_YV12   1  /**< Input/output frame uses the YV12 colorspace format */  
 #define XVID_CSP_YUY2   2  /**< Input/output frame uses the YUV2 colorspace format */  
 #define XVID_CSP_UYVY   3  /**< Input/output frame uses the UYVY colorspace format */  
 #define XVID_CSP_I420   4  /**< Input/output frame uses the I420 colorspace format */  
 #define XVID_CSP_RGB555 10 /**< Input/output frame uses the RGB555 colorspace format */  
 #define XVID_CSP_RGB565 11 /**< Input/output frame uses the RGB565 colorspace format */  
 #define XVID_CSP_USER   12 /**< Input/output frame uses the USER colorspace format  
                             *  
                             * XviD will not perform any colorspace conversion. The  
                             * output will be the native MPEG4 YV12 colorspace. Up to  
                             * the client application to convert it to a usable format. */  
 #define XVID_CSP_EXTERN 1004 /**< Special colorspace used for slice rendering  
                               *  
                               * The application provides an external buffer to XviD.  
                               * This way, XviD works directly into the final rendering  
                               * buffer, no need to specify this is a speed boost feature.  
                               * This feature is only used by mplayer at the moment, refer  
                               * to mplayer code to see how it can be used. */  
 #define XVID_CSP_YVYU   1002 /**< Input/output frame uses the YVYU colorspace format */  
 #define XVID_CSP_RGB32  1000 /**< Input/output frame uses the RGB32 colorspace format */  
 #define XVID_CSP_NULL   9999 /**< Input/output frame uses the NULL colorspace format */  
156    
157  #define XVID_CSP_VFLIP  0x80000000 /**< Flips input/output frames */  /* 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   * \defgroup init_grp Initialization constants, structures and functions.  /* XVID_GBL_CONVERT param1 */
176   *  typedef struct {
177   * This section describes all the constants, structures and functions used to          int version;
178   * initialize the XviD core library          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   *  CPU flags   * xvid_decore()
196   ****************************************************************************/   ****************************************************************************/
197    
198    #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */
199    #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);
  * \defgroup cpu_grp Flags for XVID_INIT_PARAM.cpu_flags.  
  *  
  * This section describes all constants that show host cpu available features,  
  * and allow a client application to force usage of some cpu instructions sets.  
  * @{  
  */  
   
203    
204  /**  /* XVID_DEC_CREATE param 1
205   * \defgroup x86_grp x86 specific cpu flags          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    
 #define XVID_CPU_MMX      0x00000001 /**< use/has MMX instruction set */  
 #define XVID_CPU_MMXEXT   0x00000002 /**< use/has MMX-ext (pentium3) instruction set */  
 #define XVID_CPU_SSE      0x00000004 /**< use/has SSE (pentium3) instruction set */  
 #define XVID_CPU_SSE2     0x00000008 /**< use/has SSE2 (pentium4) instruction set */  
 #define XVID_CPU_3DNOW    0x00000010 /**< use/has 3dNOW (k6-2) instruction set */  
 #define XVID_CPU_3DNOWEXT 0x00000020 /**< use/has 3dNOW-ext (???) instruction set */  
 #define XVID_CPU_TSC      0x00000040 /**< has TimeStampCounter instruction */  
   
 /** @} */  
   
 /**  
  * \defgroup ia64_grp ia64 specific cpu flags.  
  * @{  
  */  
214    
215  #define XVID_CPU_IA64     0x00000080 /**< Forces ia64 optimized code usage  /* XVID_DEC_DECODE param1 */
216                                        *  /* general flags */
217   * This flags allow client applications to force IA64 optimized functions.  #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */
218   * This feature is considered exeperimental and should be treated as is.  #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    
 /**  
  * \defgroup iniflags_grp Initialization commands.  
  *  
  * @{  
  */  
229    
230  #define XVID_CPU_CHKONLY  0x40000000 /**< Check cpu features  /* XVID_DEC_DECODE param2 :: optional */
231                                        *  typedef struct
232   * When this flag is set, the xvid_init function performs just a cpu feature  {
233   * checking and then fills the cpu field. This flag is usefull when client          int version;
234   * applications want to know what instruction sets the host cpu supports.          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  #define XVID_CPU_FORCE    0x80000000 /**< Force input flags to be used                          /* XXX: external deblocking stuff */
242                                        *                          int * qscale;   /* [out]        pointer to quantizer table */
243   * When this flag is set, client application forces XviD to use other flags                          int qscale_stride;              /* [out]        quantizer scale stride */
  * set in cpu_flags. \b Use this at your own risk.  
  */  
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   *  Initialization 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  /** Structure used in xvid_init function. */  #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    #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/
276    #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */
277    
278    
279          typedef struct          typedef struct
280          {          {
281                  int cpu_flags;   /**< [in/out]      int version;
282                                    *      int flags;              /* plugin flags */
283                                    * Filled with desired[in] or available[out]  } xvid_plg_info_t;
                                   * cpu instruction sets.  
                                   */  
                 int api_version; /**< [out]  
                                   *  
                                   * xvid_init will initialize this field with  
                                   * the API_VERSION used in this XviD core  
                                   * library  
                                   */  
                 int core_build;  /**< [out]  
                                   * \todo Still unused at the moment, what do we  
                                   * do with that ?  
                                   */  
         }  
         XVID_INIT_PARAM;  
284    
 /*****************************************************************************  
  *  Initialization entry point  
  ****************************************************************************/  
285    
286  /**  typedef struct
287   * \defgroup inientry_grp Initialization entry point.  {
288   * @{      int version;
  */  
289    
290  /**      int width;
291   * \brief Initialization entry point.      int height;
292   *      int mb_width;
293   * This is the XviD's initialization entry point, it is only used to initialize      int mb_height;
294   * the XviD internal data (function pointers, vector length code tables,          int fincr;
295   * rgb2yuv lookup tables).      int fbase;
  *  
  * \param handle Reserved for future use.  
  * \param opt Reserved for future use (set it to 0).  
  * \param param1 Used to pass an XVID_INIT_PARAM parameter.  
  * \param param2 Reserved for future use.  
  */  
         int xvid_init(void *handle,  
                       int opt,  
                       void *param1,  
                       void *param2);  
296    
297  /** @} */      void * param;
298    } xvid_plg_create_t;
299    
 /** @} */  
300    
301  /*****************************************************************************  typedef struct
302   * Decoder constant  {
303   ****************************************************************************/      int version;
304    
305  /**      int num_frames;          /* [out] totlal frame encoded */
306   * \defgroup decoder_grp Decoder related functions and structures.  } xvid_plg_destroy_t;
  *  
  *  This part describes all the structures/functions from XviD's API needed for  
  *  decoding a MPEG4 compliant stream.  
  *  @{  
  */  
307    
 /**  
  * \defgroup decframe_grp Flags for XVID_DEC_FRAME.general  
  *  
  * Flags' description for the XVID_DEC_FRAME.general member.  
  *  
  * @{  
  */  
308    
309  /** Not used at the moment */  typedef struct
310  #define XVID_QUICK_DECODE               0x00000010  {
311        int version;
312    
313        int width;              /* [out] */
314        int height;             /* [out] */
315        int mb_width;           /* [out] */
316        int mb_height;          /* [out] */
317            int fincr;              /* [out] */
318        int fbase;              /* [out] */
319    
320        xvid_image_t reference; /* [out] -> [out] */
321        xvid_image_t current;   /* [out] -> [in,out] */
322        xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
323        int frame_num;          /* [out] frame number */
324    
325        int type;               /* [in,out] */
326        int quant;              /* [in,out] */
327    
328        int * dquant;               /* [in,out]     pointer to diff quantizer table */
329            int dquant_stride;              /* [in,out]     diff quantizer stride */
330    
331        int vop_flags;          /* [in,out] */
332        int vol_flags;          /* [in,out] */
333        int motion_flags;       /* [in,out] */
334    
335        int length;                 /* [out] after: length of encoded frame */
336        int kblks, mblks, ublks;    /* [out] after: */
337        int sse_y, sse_u, sse_v;    /* [out] */
338    } xvid_plg_data_t;
339    
 /**  
  * @}  
  */  
340    
341  /*****************************************************************************  /*****************************************************************************
342   * Decoder structures    xvid plugin system -- external
343    
344      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
345      indicates the plugin function pointer and plugin-specific data.
346      xvidcore handles the rest. example:
347    
348      xvid_enc_create_t create;
349      xvid_enc_plugin_t plugins[2];
350    
351      plugins[0].func = xvid_psnr_func;
352      plugins[0].param = NULL;
353      plugins[1].func = xvid_cbr_func;
354      plugins[1].param = &cbr_data;
355    
356      create.num_plugins = 2;
357      create.plugins = plugins;
358    
359   ****************************************************************************/   ****************************************************************************/
360    
361    typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
362    
363          typedef struct          typedef struct
364          {          {
365                  int width;      xvid_plugin_func * func;
366                  int height;      void * param;
367                  void *handle;  } xvid_enc_plugin_t;
368          }  
369          XVID_DEC_PARAM;  
370    
371    xvid_plugin_func xvid_plugin_fixed;   /* fixed quantizer control */
372    xvid_plugin_func xvid_plugin_cbr;   /* constant bitrate control */
373    xvid_plugin_func xvid_plugin_2pass1;   /* 2pass rate control: first pass */
374    xvid_plugin_func xvid_plugin_2pass2;   /* 2pass rate control: second pass */
375    
376    xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
377    
378    xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */
379    xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
380    
381    
382          typedef struct          typedef struct
383          {          {
384                  int general;      int version;
385                  void *bitstream;      int quant_increment;
386                  int length;      int quant_base;
387    } xvid_plugin_fixed_t;
                 void *image;  
                 int stride;  
                 int colorspace;  
         }  
         XVID_DEC_FRAME;  
388    
389    
         // This struct is used for per slice rendering  
390          typedef struct          typedef struct
391          {          {
392                  void *y,*u,*v;      int version;
393                  int stride_y, stride_u,stride_v;      int bitrate;                                /* bits per second */
394          } XVID_DEC_PICTURE;      int max_quantizer;
395        int min_quantizer;
396        int reaction_delay_factor;
397        int averaging_period;
398        int buffer;
399    } xvid_plugin_cbr_t;
400    
401    
402    typedef struct {
403        int version;
404        char * filename;
405    } xvid_plugin_2pass1_t;
406    
407    
408    #define XVID_CURVE_COSINE   0   /* low aggressiveness */
409    #define XVID_CURVE_LINEAR   1   /* medium aggressiveness */
410    #define XVID_CURVE_SINE     2   /* high aggressiveness */
411    
412    #define XVID_PAYBACK_BIAS   0   /* payback with bias */
413    #define XVID_PAYBACK_PROP   1   /* payback proportionally */
414    
415    typedef struct {
416        int version;
417        char * filename;
418            int bitrate;                            /* bits per second */
419    
420        int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */
421        int payback_method;
422        int bitrate_payback_delay;
423        int curve_compression_high;
424        int curve_compression_low;
425        int max_overflow_improvement;
426        int max_overflow_degradation;
427        int min_quant[3];
428        int max_quant[3];
429    
430        int use_alt_curve;
431            int alt_curve_high_dist;
432            int alt_curve_low_dist;
433        int alt_curve_use_auto;
434            int alt_curve_auto_str;
435            int alt_curve_type; /* XVID_CURVE_ */
436            int alt_curve_min_rel_qual;
437            int alt_curve_use_auto_bonus_bias;
438        int alt_curve_bonus_bias;
439    
440        int kftreshold;
441            int kfreduction;
442        int min_key_interval;
443    }xvid_plugin_2pass2_t;
444    
445    
446  /*****************************************************************************  /*****************************************************************************
447   * Decoder entry point   * xvid_encore()
448   ****************************************************************************/   ****************************************************************************/
449    
450  /**  /* Encoder options */
451   * \defgroup  decops_grp Decoder operations  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
452   *  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
453   * These are all the operations XviD's decoder can perform.  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
454   *                                                                          0 means this frame should not be written (ie. encoder lag) */
  * @{  
  */  
455    
456  #define XVID_DEC_DECODE         0 /**< Decodes a frame  int xvid_encore(void *handle, int opt, void *param1, void *param2);
                                    *  
  * This operation constant is used when client application wants to decode a  
  * frame. Client application must also fill XVID_DEC_FRAME appropriately.  
  */  
457    
 #define XVID_DEC_CREATE         1 /**< Creates a decoder instance  
                                    *  
  * This operation constant is used by a client application in order to create  
  * a decoder instance. All instances are independant from each other, so  
  * client application can use safely various threads, each decoding a  
  * different MPEG4 bitstream.  
  */  
458    
459  #define XVID_DEC_DESTROY        2 /**< Destroys a decoder instance  /* global flags  */
460                                     *  typedef enum
461   * This operation constant is used by the client application to destroy a  {
462   * previously created decoder instance.      XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */
463   */      XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
464        XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004
465    /*define XVID_GLOBAL_VOL_AT_IVOP        0x00000008       write vol at every ivop: WIN32/divx compatibility */
466    /*define XVID_GLOBAL_FORCE_VOL          0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
467    } xvid_global_t;
468    
 /**  
  * @}  
  */  
469    
470  /**  /* XVID_ENC_ENCODE param1 */
471   * \defgroup  decentry_grp Decoder entry point  /* vol-based flags */
472   *  typedef enum {
473   * @{      XVID_VOL_MPEGQUANT          = 0x00000001,
474   */      XVID_VOL_EXTRASTATS         = 0x00000002,
475        XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
476        XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
477        XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
478        XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */
479    } xvid_vol_t;
480    
 /**  
  * \brief Decoder entry point.  
  *  
  * This is the XviD's decoder entry point. The possible operations are  
  * described in the \ref decops_grp section.  
  *  
  * \param handle Todo  
  * \param opt Todo  
  * \param param1 Todo  
  * \param param2 Todo  
  */  
481    
482          int xvid_decore(void *handle,  /* vop-based flags */
483                          int opt,  typedef enum {
484                          void *param1,      XVID_VOP_DEBUG              = 0x00000001,
                         void *param2);  
485    
486  /** @} */      XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */
487        XVID_VOP_INTER4V            = 0x00000008,
488    
489  /** @} */      XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */
490    
491  /**      XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
492   * \defgroup encoder_grp Encoder related functions and structures.      XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
493   *                                                color input material chroma is ignored) */
494   * @{      XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
495   */      XVID_VOP_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
496        XVID_VOP_DYNAMIC_BFRAMES    = 0x00000200,
497    
498  /*****************************************************************************          /* only valid for vol_flags|=XVID_VOL_INTERLACING */
499   * Encoder constants      XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
500   ****************************************************************************/      XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
501    
502  /**      /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
503   * \defgroup encgenflags_grp  Flags for XVID_ENC_FRAME.general      XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */
504   * @{  } xvid_vop_t;
  */  
505    
 #define XVID_VALID_FLAGS                0x80000000 /**< Reserved for future use */  
506    
507  #define XVID_CUSTOM_QMATRIX             0x00000004 /**< Use custom quantization matrices  typedef enum {
508                                                                                          *      XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
509   * This flag forces XviD to use custom matrices passed to encoder in      XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
  * XVID_ENC_FRAME structure (members quant_intra_matrix and quant_inter_matrix) */  
 #define XVID_H263QUANT                  0x00000010 /**< Use H263 quantization  
                                                                                         *  
  * This flag forces XviD to use H263  quantization type */  
 #define XVID_MPEGQUANT                  0x00000020 /**< Use MPEG4 quantization.  
                                                                                         *  
  * This flag forces XviD to use MPEG4 quantization type */  
 #define XVID_HALFPEL                    0x00000040 /**< Halfpel motion estimation  
                                                                                         *  
 * informs  xvid  to perform  a  half pixel  motion estimation. */  
 #define XVID_ADAPTIVEQUANT              0x00000080/**< Adaptive quantization  
                                                                                         *  
 * informs  xvid  to perform  an  adaptative quantization using a Luminance  
 * masking algorithm */  
 #define XVID_LUMIMASKING                0x00000100/**< Lumiomasking flag  
                                                                                         *  
 * \deprecated Please do not use this flag anymore */  
 #define XVID_LATEINTRA                  0x00000200/**< Unknown  
                                                                                         *  
 * ??? */  
 #define XVID_INTERLACING                0x00000400/**< MPEG4 interlacing mode.  
                                                                                         *  
 * Switches MPEG4 interlacing mode */  
 #define XVID_TOPFIELDFIRST              0x00000800/**<  
                                                                                         *  
 * */  
 #define XVID_ALTERNATESCAN              0x00001000/**<  
                                                                                         *  
 * */  
 #define XVID_HINTEDME_GET               0x00002000/**< Gets Motion vector data from ME system.  
                                                                                         *  
 * informs  xvid to  return  Motion Estimation vectors from the ME encoder  
 * algorithm. Used during a first pass. */  
 #define XVID_HINTEDME_SET               0x00004000/**< Gives Motion vectors hint to ME system.  
                                                                                         *  
 * informs xvid to  use the user  given motion estimation vectors as hints  
 * for the encoder ME algorithms. Used during a 2nd pass. */  
 #define XVID_INTER4V                    0x00008000/**< Inter4V mode.  
                                                                                         *  
 * forces XviD to search a vector for each 8x8 block within the 16x16  Macro  
 * Block. This mode should  be used only if the XVID_HALFPEL mode is  activated  
 * (this  could change  in the future). */  
 #define XVID_ME_ZERO                    0x00010000/**< Unused  
                                                                                         *  
 * Do not use this flag (reserved for future use) */  
 #define XVID_ME_LOGARITHMIC             0x00020000/**< Unused  
                                                                                         *  
 * Do not use this flag (reserved for future use) */  
 #define XVID_ME_FULLSEARCH              0x00040000/**< Unused  
                                                                                         *  
 * Do not use this flag (reserved for future use) */  
 #define XVID_ME_PMVFAST                 0x00080000/**< Use PMVfast ME algorithm.  
                                                                                         *  
 * Switches XviD ME algorithm to PMVfast */  
 #define XVID_ME_EPZS                    0x00100000/**< Use EPZS ME algorithm.  
                                                                                         *  
 * Switches XviD ME algorithm to EPZS */  
 #define XVID_GREYSCALE                  0x01000000/**< Discard chroma data.  
                                                                                         *  
 * This flags forces XviD to discard chroma data, this is not mpeg4 greyscale  
 * mode, it simply drops chroma MBs using cbp == 0 for these blocks */  
 #define XVID_GRAYSCALE                  XVID_GREYSCALE /**< XVID_GREYSCALE alia for US speakerss  
                                                                                         *  
 * Same as above */  
510    
511  /** @} */      XVID_ME_HALFPELREFINE16     = 0x00020000,
512        XVID_ME_HALFPELREFINE8      = 0x02000000,
513    
514  /**      XVID_ME_QUARTERPELREFINE16  = 0x00040000,
515   * \defgroup encmotionflags_grp  Flags for XVID_ENC_FRAME.motion      XVID_ME_QUARTERPELREFINE8   = 0x04000000,
  * @{  
  */  
516    
517  #define PMV_ADVANCEDDIAMOND8    0x00004000/**< Uses advanced diamonds for 8x8 blocks      XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
                                                                                         *  
 * Same as its 16x16 companion option  
 */  
 #define PMV_ADVANCEDDIAMOND16   0x00008000/**< Uses advanced diamonds for 16x16 blocks  
                                                                                         *  
 * */  
 #define PMV_HALFPELDIAMOND16    0x00010000/**< Turns on halfpel precision for 16x16 blocks  
                                                                                         *  
 * switches the search algorithm from 1 or 2 full pixels precision to 1 or 2 half pixel precision.  
 */  
 #define PMV_HALFPELREFINE16     0x00020000/**< Turns on halfpel refinement step  
                                                                                         *  
 * After normal  diamond  search, an  extra halfpel refinement step is  performed.  Should always be used if  
 * XVID_HALFPEL is  on, because it  gives a rather big  increase in quality.  
 */  
 #define PMV_EXTSEARCH16                 0x00040000/**< Extends search for 16x16 blocks  
                                                                                         *  
 * Normal PMVfast predicts one  start vector and  does diamond search around this position. EXTSEARCH means that 2  
 * more  start vectors  are used:  (0,0) and  median  predictor and diamond search  is done for  those, too.  Makes  
 * search slightly slower, but quality sometimes gets better.  
 */  
 #define PMV_EARLYSTOP16                 0x00080000/**< Dynamic ME thresholding  
                                                                                         *  
 * PMVfast and EPZS stop search  if current best is  below some dynamic  threshhold. No  diamond search  is done,  
 * only halfpel  refinement (if active).  Without EARLYSTOP diamond search is always done. That would be much slower,  
 * but not really lead to better quality.  
 */  
 #define PMV_QUICKSTOP16                 0x00100000/**< Dynamic ME thresholding  
                                                                                         *  
 * like  EARLYSTOP,   but  not   even  halfpel refinement is  done. Normally worse  quality, so it  defaults to  
 * off. Might be removed, too.  
 */  
 #define PMV_UNRESTRICTED16      0x00200000/**< Not implemented  
                                                                                         *  
 * "unrestricted  ME"   is  a   feature  of MPEG4. It's not  implemented, so this flag is  ignored (not even  
 * checked).  
 */  
 #define PMV_OVERLAPPING16       0x00400000/**< Not implemented  
                                                                                         *  
 * Same as above  
 */  
 #define PMV_USESQUARES16                0x00800000/**< Use square pattern  
                                                                                         *  
 * Replace  the  diamond search  with a  square search.  
 */  
 #define PMV_HALFPELDIAMOND8     0x01000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
 #define PMV_HALFPELREFINE8              0x02000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
 #define PMV_EXTSEARCH8                  0x04000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
 #define PMV_EARLYSTOP8                  0x08000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
 #define PMV_QUICKSTOP8                  0x10000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
 #define PMV_UNRESTRICTED8       0x20000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
 #define PMV_OVERLAPPING8                0x40000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
 #define PMV_USESQUARES8                 0x80000000/**< see 16x16 equivalent  
                                                                                         *  
 * Same as its 16x16 companion option */  
518    
519  /** @} */      XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
520        XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */
521        XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */
522    
523  /*****************************************************************************      XVID_ME_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
524   * Encoder structures      XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
  ****************************************************************************/  
525    
526          /** Structure used for encoder instance creation */      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
527          typedef struct      XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
528          {      XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
529                  int width;                    /**< [in]      XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
530                                                                             *      XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
                                                                            * Input frame width. */  
                 int height;                   /**< [in]  
                                                                            *  
                                                                            * Input frame height. */  
                 int fincr;                    /**< [in]  
                                                                            *  
                                                                            * Time increment (fps = increment/base). */  
                 int fbase;                    /**< [in]  
                                                                            *  
                                                                            * Time base (fps = increment/base). */  
                 int rc_bitrate;               /**< [in]  
                                                                            *  
                                                                            * Sets the target bitrate of the encoded stream, in bits/second. **/  
                 int rc_reaction_delay_factor; /**< [in]  
                                                                            *  
                                                                            * Tunes how fast the rate control reacts - lower values are faster. */  
                 int rc_averaging_period;      /**< [in]  
                                                                            *  
                                                                            * Tunes how fast the rate control reacts - lower values are faster. */  
                 int rc_buffer;                /**< [in]  
                                                                            *  
                                                                            * Tunes how fast the rate control reacts - lower values are faster. */  
                 int max_quantizer;            /**< [in]  
                                                                            *  
                                                                            * Sets the upper limit of the quantizer. */  
                 int min_quantizer;            /**< [in]  
                                                                            *  
                                                                            * Sets the lower limit of the quantizer. */  
                 int max_key_interval;         /**< [in]  
                                                                            *  
                                                                            * Sets the maximum interval between key frames. */  
                 void *handle;                 /**< [out]  
                                                                            *  
                                                                            * XviD core lib will set this with the creater encoder instance. */  
         }  
         XVID_ENC_PARAM;  
531    
532          typedef struct      XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
533          {                                                    enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
534                  int x;      XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
                 int y;  
         }  
         VECTOR;  
535    
536          typedef struct      XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
537          {      XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
538                  int mode;                               /* macroblock mode */      XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
539                  VECTOR mvs[4];      XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
540          }  } xvid_motion_t;
         MVBLOCKHINT;  
541    
         typedef struct  
         {  
                 int intra;                              /* frame intra choice */  
                 int fcode;                              /* frame fcode */  
                 MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */  
         }  
         MVFRAMEHINT;  
542    
543          typedef struct  /* XVID_ENC_CREATE param1 */
544          {  typedef struct {
545                  int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */          int version;
546            int width;                              /* [in]         frame dimensions; width, pixel units */
547            int height;                             /* [in]         frame dimensions; height, pixel units */
548    
549                  MVFRAMEHINT mvhint;      int num_plugins;        /* [in:opt] number of plugins */
550                  void *hintstream;               /* compressed hint buffer */      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
                 int hintlength;                 /* length of buffer (bytes) */  
         }  
         HINTINFO;  
551    
552          /** Structure used to pass a frame to the encoder */          int num_threads;                /* [in:opt]     number of threads */
553          typedef struct          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
         {  
                 int general;                       /**< [in]  
                                                                                         *  
                                                                                         * Sets general options flag (See \ref encgenflags_grp) */  
                 int motion;                        /**< [in]  
                                                                                         *  
                                                                                         * Sets Motion Estimation options */  
                 void *bitstream;                   /**< [out]  
                                                                                         *  
                                                                                         * Output MPEG4 bitstream buffer pointer */  
                 int length;                        /**< [out]  
                                                                                         *  
                                                                                         * Output MPEG4 bitstream length (bytes) */  
                 void *image;                       /**< [in]  
                                                                                         *  
                                                                                         * Input frame */  
                 int colorspace;                    /**< [in]  
                                                                                         *  
                                                                                         * input frame colorspace */  
                 unsigned char *quant_intra_matrix; /**< [in]  
                                                                                         *  
                                                                                         * Custom intra quantization matrix */  
                 unsigned char *quant_inter_matrix; /**< [in]  
                                                                                         *  
                                                                                         * Custom inter quantization matrix */  
                 int quant;                         /**< [in]  
                                                                                         *  
                                                                                         * Frame quantizer :  
                                                                                         * <ul>  
                                                                                         * <li> 0 (zero) : Then the  rate controler chooses the right quantizer  
                                                                                         *                 for you.  Tipically used in ABR encoding or first pass of a VBR  
                                                                                         *                 encoding session.  
                                                                                         * <li> !=  0  :  Then you  force  the  encoder  to use  this  specific  
                                                                                         *                  quantizer   value.     It   is   clamped    in   the   interval  
                                                                                         *                  [1..31]. Tipically used  during the 2nd pass of  a VBR encoding  
                                                                                         *                  session.  
                                                                                         * </ul> */  
                 int intra;                         /**< [in/out]  
                                                                                         *  
                                                                                         * <ul>  
                                                                                         * <li> [in] : tells XviD if the frame must be encoded as an intra frame  
                                                                                         *     <ul>  
                                                                                         *     <li> 1: forces the encoder  to create a keyframe. Mainly used during  
                                                                                         *              a VBR 2nd pass.  
                                                                                         *     <li> 0:  forces the  encoder not to  create a keyframe.  Minaly used  
                                                                                         *               during a VBR second pass  
                                                                                         *     <li> -1: let   the  encoder   decide  (based   on   contents  and  
                                                                                         *              max_key_interval). Mainly  used in ABR  mode and during  a 1st  
                                                                                         *              VBR pass.  
                                                                                         *     </ul>  
                                                                                         * <li> [out] : When first set to -1, the encoder returns the effective keyframe state  
                                                                                         *              of the frame.  
                                                                                         * </ul>  
                                             */  
                 HINTINFO hint;                     /**< [in/out]  
                                                                                         *  
                                                                                         * mv hint information */  
554    
555          }          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */
         XVID_ENC_FRAME;  
556    
557    /* --- vol-based stuff; included here for conveinience */
558            int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
559            int fbase;                              /* [in] framerate base
560                                                                                    frame_duration = fincr/fbase seconds*/
561    /* ^^^---------------------------------------------- */
562    
563          /** Encoding statistics */  
564          typedef struct  /* ---vop-based; included here for conveienience */
565          {          int max_key_interval;   /* [in:opt] the maximum interval between key frames */
566                  int quant;               /**< [out]                                                                                  /*XXX: maybe call it gop_size? */
567                                                                    *  
568                                                                    * Frame quantizer used during encoding */          int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
569                  int hlength;             /**< [out]  
570                                                                    *          int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
571                                                                    * Header bytes in the resulting MPEG4 stream */          int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
572                  int kblks;               /**< [out]  
573                                                                    *  /* ^^^ -------------------------------------------------------------------------*/
574                                                                    * Number of MacroBlocks coded as Intra blocks */  
575                  int mblks;               /**< [out]          void *handle;                   /* [out] encoder instance handle */
                                                                   *  
                                                                   * Number of MacroBlocks coded as Inter blocks */  
                 int ublks;               /**< [out]  
                                                                   *  
                                                                   * Number of MacroBlocks coded as skipped blocks */  
576          }          }
577          XVID_ENC_STATS;  xvid_enc_create_t;
578    
579    
580  /*****************************************************************************  #define XVID_KEYFRAME   0x00000001
  * Encoder entry point  
  ****************************************************************************/  
581    
582  /**  typedef struct {
583   * \defgroup  encops_grp Encoder operations          int version;
  *  
  * These are all the operations XviD's encoder can perform.  
  *  
  * @{  
  */  
584    
585  #define XVID_ENC_DECODE         0 /**< Encodes a frame  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
586                                     *                  changes here until the next VOL (keyframe). */
587   * This operation constant is used when client application wants to encode a          xvid_vol_t vol_flags;                   /* [in] vol flags */
588   * frame. Client application must also fill XVID_ENC_FRAME appropriately.          unsigned char *
589   */                  quant_intra_matrix;     /* [in:opt] custom intra qmatrix */
590            unsigned char *
591                    quant_inter_matrix;     /* [in:opt] custom inter qmatrix */
592    
593  #define XVID_ENC_CREATE         1 /**< Creates a decoder instance          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
594                                     *          int par_width;                  /* [in:opt] aspect ratio width */
595   * This operation constant is used by a client application in order to create          int par_height;                 /* [in:opt] aspect ratio height */
596   * an encoder instance. All instances are independant from each other, so  /* ^^^----------------------------------------------------------------------------------*/
  * client application can use safely various threads, each encoding a  
  * different set of frames.  
  */  
597    
598  #define XVID_ENC_DESTROY        2 /**< Destroys a encoder instance      int fincr;                          /* framerate increment, for variable framerate only */
599                                     *          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
600   * This operation constant is used by the client application to destroy a          xvid_motion_t motion;                           /* [in] ME options */
  * previously created encoder instance.  
  */  
601    
602            xvid_image_t input;     /* [in] input image (read from) */
603    
604  /** @} */          int type;                               /* [in:opt] coding type */
605            int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
606            int bframe_threshold;
607    
608  /**          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
609   * \defgroup  encentry_grp Encoder entry point          int length;                             /* [in:opt] bitstream length (bytes) */
  *  
  * @{  
  */  
610    
611  /**          int out_flags;                          /* [out] bitstream output flags */
612   * \brief Encoder entry point.  }
613   *  xvid_enc_frame_t;
614   * This is the XviD's encoder entry point. The possible operations are  
615   * described in the \ref encops_grp section.  
616   *  /* XVID_ENC_ENCODE param2 (optional)
617   * \param handle Todo          xvid_enc_stats_t describes individual frame details
618   * \param opt Todo  
619   * \param param1 Todo          coding_type==XVID_TYPE_NOTHING if the stats are not given
  * \param param2 Todo  
620   */   */
621          int xvid_encore(void *handle,  typedef struct {
622                                          int opt,          int version;
623                                          void *param1,  
624                                          void *param2);          /* encoding parameters */
625            int type;                                       /* [out] coding type */
626            int quant;                                      /* [out] frame quantizer */
627            xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */
628            int vop_flags;                          /* [out] vop flags (see above) */
629            /* bitrate */
630            int length;                                     /* [out] frame length */
631    
632  /** @} */          int hlength;                            /* [out] header length (bytes) */
633            int kblks, mblks, ublks;        /* [out] */
634    
635  /** @} */      int sse_y, sse_u, sse_v;
636    }
637    xvid_enc_stats_t;
638    
639  #ifdef __cplusplus  #ifdef __cplusplus
640  }  }
641  #endif  #endif
642    
643    
644  #endif  #endif

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.27.2.16

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