[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.22, Mon Nov 4 12:50:24 2002 UTC revision 1.27.2.23, Mon Jun 9 19:42:12 2003 UTC
# Line 3  Line 3 
3   *  XVID MPEG-4 VIDEO CODEC   *  XVID MPEG-4 VIDEO CODEC
4   *  - XviD Main header file -   *  - XviD Main header file -
5   *   *
6   *  This program is an implementation of a part of one or more MPEG-4   *  Copyright(C) 2001-2003 Peter Ross <pross@xvid.org>
  *  Video tools as specified in ISO/IEC 14496-2 standard.  Those intending  
  *  to use this software module in hardware or software products are  
  *  advised that its use may infringe existing patents or copyrights, and  
  *  any such use would be at such party's own risk.  The original  
  *  developer of this software module and his/her company, and subsequent  
  *  editors and their companies, will have no liability for use of this  
  *  software or modifications or derivatives thereof.  
7   *   *
8   *  This program is free software ; you can redistribute it and/or modify   *  This program is free software ; you can redistribute it and/or modify
9   *  it under the terms of the GNU General Public License as published by   *  it under the terms of the GNU General Public License as published by
# Line 28  Line 21 
21   *   *
22   * $Id$   * $Id$
23   *   *
24   *****************************************************************************/   ****************************************************************************/
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
29    
30  #ifdef __cplusplus  #ifdef __cplusplus
31  extern "C" {  extern "C" {
32  #endif  #endif
33    
34    /*****************************************************************************
35     * versioning
36     ****************************************************************************/
37    
38    /* versioning
39            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 XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )
52    #define XVID_MAJOR(a)                           ( ((a)>>16) & 0xff )
53    #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))
54    #define XVID_PATCH(c)                           ( (c) & 0xff )
55    
56  /**  #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)
57   * \defgroup global_grp   Global constants used in both encoder and decoder.  #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 module describe all constants used in both the encoder and the decoder.   * this MUST be increased if an encoder bug is fixed, increasing it too often
67   * @{   * doesnt hurt but not increasing it could cause difficulty for decoders in the
68     * future
69   */   */
70    #define XVID_BS_VERSION "0011"
71    
72    
73  /*****************************************************************************  /*****************************************************************************
74   *  API version number   * error codes
75   ****************************************************************************/   ****************************************************************************/
76    
77  /**      /*  all functions return values <0 indicate error */
  * \defgroup api_grp API version  
  * @{  
  */  
78    
79  #define API_VERSION ((2 << 16) | (1))/**< This constant tells you what XviD's  #define XVID_ERR_FAIL           -1              /* general fault */
80                                        *   version this header defines.  #define XVID_ERR_MEMORY     -2          /* memory allocation error */
81                                        *  #define XVID_ERR_FORMAT     -3          /* file format error */
82   * You can use it to check if the host XviD library API is the same as the one  #define XVID_ERR_VERSION        -4              /* structure version not supported */
83   * you used to build you client program. If versions mismatch, then it is  #define XVID_ERR_END            -5              /* encoder only; end of stream reached */
  * highly possible that your application will segfault because the host XviD  
  * library and your application use different structures.  
  *  
  */  
84    
 /** @} */  
85    
86    
87  /*****************************************************************************  /*****************************************************************************
88   *  Error codes   * xvid_image_t
89   ****************************************************************************/   ****************************************************************************/
90    
91    /* colorspace values */
92    
93  /**  #define XVID_CSP_USER           0       /* 4:2:0 planar */
94   * \defgroup error_grp Error codes returned by XviD API entry points.  #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_ERR_FAIL   -1 /**< Operation failed.  #define XVID_CSP_YVYU           5       /* 4:2:2 packed */
99                              *  #define XVID_CSP_BGRA           6       /* 32-bit bgra packed */
100   * The requested XviD operation failed. If this error code is returned from :  #define XVID_CSP_ABGR           7       /* 32-bit abgr packed */
101   * <ul>  #define XVID_CSP_RGBA           8       /* 32-bit rgba packed */
102   * <li>the xvid_init function : you must not try to use an XviD's instance from  #define XVID_CSP_BGR            9       /* 32-bit bgr packed */
103   *                              this point of the code. Clean all instances you  #define XVID_CSP_RGB555     10  /* 16-bit rgb555 packed */
104   *                              already created and exit the program cleanly.  #define XVID_CSP_RGB565     11  /* 16-bit rgb565 packed */
105   * <li>xvid_encore or xvid_decore : something was wrong and en/decoding  #define XVID_CSP_SLICE          12      /* decoder only: 4:2:0 planar, per slice rendering */
106   *                                  operation was not completed sucessfully.  #define XVID_CSP_INTERNAL       13      /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
107   *                                  you can stop the en/decoding process or just  #define XVID_CSP_NULL           14      /* decoder only: dont output anything */
108   *                                                                      ignore and go on.  #define XVID_CSP_VFLIP  0x80000000      /* vertical flip mask */
  * <li>xvid_stop : you can safely ignore it if you call this function at the  
  *                 end of your program.  
  * </ul>  
  */  
109    
110  #define XVID_ERR_OK      0 /**< Operation succeed.  /* xvid_image_t
111                              *          for non-planar colorspaces use only plane[0] and stride[0]
112   * The requested XviD operation succeed, you can continue to use XviD's          four plane reserved for alpha*/
113   * functions.  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  #define XVID_ERR_MEMORY  1 /**< Operation failed.  /* video-object-sequence profiles */
120                              *  #define XVID_PROFILE_S_L0       0x08    /* simple */
121   * Insufficent memory was available on the host system.  #define XVID_PROFILE_S_L1       0x01
122   */  #define XVID_PROFILE_S_L2       0x02
123    #define XVID_PROFILE_S_L3       0x03
124    #define XVID_PROFILE_ARTS_L1    0x91    /* advanced realtime simple */
125    #define XVID_PROFILE_ARTS_L2    0x92
126    #define XVID_PROFILE_ARTS_L3    0x93
127    #define XVID_PROFILE_ARTS_L4    0x94
128    #define XVID_PROFILE_AS_L0      0xf0    /* advanced simple */
129    #define XVID_PROFILE_AS_L1      0xf1
130    #define XVID_PROFILE_AS_L2      0xf2
131    #define XVID_PROFILE_AS_L3      0xf3
132    #define XVID_PROFILE_AS_L4      0xf4
133    
134  #define XVID_ERR_FORMAT  2 /**< Operation failed.  /* aspect ratios */
135                              *  #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */
136   * The format of the parameters or input stream were incorrect.  #define XVID_PAR_43_PAL     2   /* 4:3 pal (12:11 625-line) */
137   */  #define XVID_PAR_43_NTSC        3       /* 4:3 ntsc (10:11 525-line) */
138    #define XVID_PAR_169_PAL        4       /* 16:9 pal (16:11 625-line) */
139    #define XVID_PAR_169_NTSC       5       /* 16:9 ntsc (40:33 525-line) */
140    #define XVID_PAR_EXT            15      /* extended par; use par_width, par_height */
141    
142  /** @} */  /* frame type flags */
143    #define XVID_TYPE_VOL           -1              /* decoder only: vol was decoded */
144    #define XVID_TYPE_NOTHING       0               /* decoder only (encoder stats): nothing was decoded/encoded */
145    #define XVID_TYPE_AUTO          0               /* encoder: automatically determine coding type */
146    #define XVID_TYPE_IVOP          1               /* intra frame */
147    #define XVID_TYPE_PVOP          2               /* predicted frame */
148    #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */
149    #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */
150    
151    
152  /*****************************************************************************  /*****************************************************************************
153   *  Color space constants   * xvid_global()
154   ****************************************************************************/   ****************************************************************************/
155    
156    /* cpu_flags definitions */
157    
158  /**  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */
159   * \defgroup csp_grp Colorspaces constants.  #define XVID_CPU_ASM        0x00000080  /* native assembly */
160   * @{  /* ARCH_IS_IA32 */
161   */  #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */
162    #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */
163    #define XVID_CPU_SSE        0x00000004   /* sse      : pentium3, athlonXP */
164    #define XVID_CPU_SSE2       0x00000008   /* sse2     : pentium4, athlon64 */
165    #define XVID_CPU_3DNOW      0x00000010   /* 3dnow    : k6-2 */
166    #define XVID_CPU_3DNOWEXT   0x00000020   /* 3dnow-ext: athlon */
167    #define XVID_CPU_TSC        0x00000040   /* timestamp counter */
168    /* ARCH_IS_PPC */
169    #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */
170    
 #define XVID_CSP_RGB24  0  /**< 24-bit RGB colorspace (b,g,r packed) */  
 #define XVID_CSP_YV12   1  /**< YV12 colorspace (y,v,u planar) */  
 #define XVID_CSP_YUY2   2  /**< YUY2 colorspace (y,u,y,v packed) */  
 #define XVID_CSP_UYVY   3  /**< UYVY colorspace (u,y,v,y packed) */  
 #define XVID_CSP_I420   4  /**< I420 colorsapce (y,u,v planar) */  
 #define XVID_CSP_RGB555 10 /**< 16-bit RGB555 colorspace */  
 #define XVID_CSP_RGB565 11 /**< 16-bit RGB565 colorspace */  
 #define XVID_CSP_USER   12 /**< user colorspace format, where the image buffer points  
                             *   to a DEC_PICTURE (y,u,v planar) structure.  
                                                         *  
                                                         *   For encoding, image is read from the DEC_PICTURE  
                                                         *   parameter values. For decoding, the DEC_PICTURE  
                             *   parameters are set, pointing to the internal XviD  
                             *   image buffer. */  
 #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 /**< YVYU colorspace (y,v,y,u packed) */  
 #define XVID_CSP_RGB32  1000 /**< 32-bit RGB colorspace (b,g,r,a packed) */  
 #define XVID_CSP_NULL   9999 /**< NULL colorspace; no conversion is performed */  
171    
172  #define XVID_CSP_VFLIP  0x80000000 /**< (flag) Flip frame vertically during conversion */  #define XVID_DEBUG_ERROR       0x00000001
173    #define XVID_DEBUG_STARTCODE   0x00000002
174    #define XVID_DEBUG_HEADER      0x00000004
175    #define XVID_DEBUG_TIMECODE    0x00000008
176    #define XVID_DEBUG_MB          0x00000010
177    #define XVID_DEBUG_COEFF       0x00000020
178    #define XVID_DEBUG_MV          0x00000040
179    #define XVID_DEBUG_RC          0x00000080
180    #define XVID_DEBUG_DEBUG       0x80000000
181    
182  /** @} */  /* XVID_GBL_INIT param1 */
183    typedef struct {
184            int version;
185            int cpu_flags;                  /* [in:opt]     zero = autodetect cpu
186                                                                            XVID_CPU_FORCE|{cpu features} = force cpu features */
187        int debug;              /* [in:opt] debug level */
188    } xvid_gbl_init_t;
189    
 /** @} */  
190    
191  /**  /* XVID_GBL_INFO param1 */
192   * \defgroup init_grp Initialization constants, structures and functions.  typedef struct {
193   *          int version;
194   * This section describes all the constants, structures and functions used to          int actual_version;             /* [out]        returns the actual xvidcore version */
195   * initialize the XviD core library          const char * build;             /* [out]        if !null, points to description of this xvid core build */
196   *          int cpu_flags;                  /* [out]        detected cpu features */
197   * @{          int num_threads;                /* [out]        detected number of cpus/threads */
198   */  } xvid_gbl_info_t;
199    
200    
201  /*****************************************************************************  /* XVID_GBL_CONVERT param1 */
202   *  CPU flags  typedef struct {
203   ****************************************************************************/          int version;
204            xvid_image_t input;     /* [in] input image & colorspace */
205            xvid_image_t output;    /* [in] output image & colorspace */
206            int width;                              /* [in] width */
207            int height;                             /* [in] height */
208            int interlacing;                /* [in] interlacing */
209    } xvid_gbl_convert_t;
210    
211    
212  /**  #define XVID_GBL_INIT           0       /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
213   * \defgroup cpu_grp Flags for XVID_INIT_PARAM.cpu_flags.  #define XVID_GBL_INFO           1       /* return some info about xvidcore, and the host computer */
214   *  #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
215   * This section describes all constants that show host cpu available features,  #define XVID_GBL_TEST           3       /* testing.. */
  * and allow a client application to force usage of some cpu instructions sets.  
  * @{  
  */  
216    
217    int xvid_global(void *handle, int opt, void *param1, void *param2);
218    
 /**  
  * \defgroup x86_grp x86 specific cpu flags  
  * @{  
  */  
219    
220  #define XVID_CPU_MMX      0x00000001 /**< use/has MMX instruction set */  /*****************************************************************************
221  #define XVID_CPU_MMXEXT   0x00000002 /**< use/has MMX-ext (pentium3) instruction set */   * xvid_decore()
222  #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 (athlon) instruction set */  
 #define XVID_CPU_TSC      0x00000040 /**< has TimeStampCounter instruction */  
   
 /** @} */  
   
 /**  
  * \defgroup ia64_grp ia64 specific cpu flags.  
  * @{  
  */  
223    
224  #define XVID_CPU_IA64     0x00000080 /**< Forces ia64 optimized code usage  #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */
225   *  #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */
226   * This flags allow client applications to force IA64 optimized functions.  #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */
  * This feature is considered exeperimental and should be treated as is.  
  */  
227    
228  /** @} */  int xvid_decore(void *handle, int opt, void *param1, void *param2);
229    
230  /**  /* XVID_DEC_CREATE param 1
231   * \defgroup iniflags_grp Initialization commands.          image width & height may be specified here when the dimensions are
232   *          known in advance. */
233   * @{  typedef struct {
234   */          int version;
235            int width;                              /* [in:opt]     image width */
236            int height;                             /* [in:opt]     image width */
237            void * handle;                  /* [out]        decore context handle */
238    } xvid_dec_create_t;
239    
 #define XVID_CPU_CHKONLY  0x40000000 /**< Check cpu features  
                                       *  
  * When this flag is set, the xvid_init function performs just a cpu feature  
  * checking and then fills the cpu field. This flag is usefull when client  
  * applications want to know what instruction sets the host cpu supports.  
  */  
   
 #define XVID_CPU_FORCE    0x80000000 /**< Force input flags to be used  
                                       *  
  * When this flag is set, client application forces XviD to use other flags  
  * set in cpu_flags. \b Use this at your own risk.  
  */  
240    
241  /** @} */  /* XVID_DEC_DECODE param1 */
242    /* general flags */
243    #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */
244    #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */
245    
246  /** @} */  typedef struct {
247            int version;
248            int general;                    /* [in:opt] general flags */
249            void *bitstream;                /* [in] bitstream (read from)*/
250            int length;                             /* [in] bitstream length */
251            xvid_image_t output;    /* [in] output image (written to) */
252    }
253    xvid_dec_frame_t;
254    
 /*****************************************************************************  
  *  Initialization structures  
  ****************************************************************************/  
255    
256  /** Structure used in xvid_init function. */  /* XVID_DEC_DECODE param2 :: optional */
257          typedef struct          typedef struct
258          {          {
259                  int cpu_flags;   /**< [in/out]          int version;
260                                    *          int type;                               /* [out]        output data type */
261                                    * Filled with desired[in] or available[out]          union {
262                                    * cpu instruction sets.                  struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
263                                    */                          int general;            /* [out]        flags */
264                  int api_version; /**< [out]                          int time_base;          /* [out]        time base */
265                                    *                          int time_increment;     /* [out]        time increment */
                                   * xvid_init will initialize this field with  
                                   * the API_VERSION used in this XviD core  
                                   * library  
                                   */  
                 int core_build;  /**< [out]  
                                   * \todo Unused.  
                                   */  
         }  
         XVID_INIT_PARAM;  
266    
267  /*****************************************************************************                          /* XXX: external deblocking stuff */
268   *  Initialization entry point                          int * qscale;   /* [out]        pointer to quantizer table */
269   ****************************************************************************/                          int qscale_stride;              /* [out]        quantizer scale stride */
270    
271  /**                  } vop;
272   * \defgroup inientry_grp Initialization entry point.                  struct {        /* XVID_TYPE_VOL */
273   * @{                          int general;            /* [out]        flags */
274   */                          int width;                      /* [out]        width */
275                            int height;                     /* [out]        height */
276                            int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */
277                            int par_width;          /* [out]        aspect ratio width */
278                            int par_height;         /* [out]        aspect ratio height */
279                    } vol;
280            } data;
281    } xvid_dec_stats_t;
282    
 /**  
  * \brief Initialization entry point.  
  *  
  * This is the XviD's initialization entry point, it is only used to initialize  
  * the XviD internal data (function pointers, vector length code tables,  
  * rgb2yuv lookup tables).  
  *  
  * \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);  
283    
 /** @} */  
284    
285  /** @} */  #define XVID_ZONE_QUANT     1
286    #define XVID_ZONE_WEIGHT    2
287    typedef struct
288    {
289        int frame;
290        int mode;
291        int increment;
292        int base;
293    } xvid_enc_zone_t;
294    
295    
296    
297  /*****************************************************************************  /*****************************************************************************
298   * Decoder constant    xvid plugin system -- internals
299    
300      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
301      before encoding each frame xvidcore will call XVID_PLG_BEFORE
302      after encoding each frame xvidcore will call XVID_PLG_AFTER
303      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
304   ****************************************************************************/   ****************************************************************************/
305    
 /**  
  * \defgroup decoder_grp Decoder related functions and structures.  
  *  
  *  This part describes all the structures/functions from XviD's API needed for  
  *  decoding a MPEG4 compliant streams.  
  *  @{  
  */  
306    
307  /**  #define XVID_PLG_CREATE     0
308   * \defgroup decframe_grp Flags for XVID_DEC_FRAME.general  #define XVID_PLG_DESTROY    1
309   *  #define XVID_PLG_INFO       2
310   * Flags' description for the XVID_DEC_FRAME.general member.  #define XVID_PLG_BEFORE     3
311   *  #define XVID_PLG_AFTER      4
  * @{  
  */  
312    
313  /** Not used at the moment */  /* xvid_plg_info_t.flags */
314  #define XVID_QUICK_DECODE               0x00000010  #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */
315    #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/
316    #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */
317    
318    
319  /**  typedef struct
320   * @}  {
321   */      int version;
322        int flags;              /* [in:opt] plugin flags */
323    } xvid_plg_info_t;
324    
 /*****************************************************************************  
  * Decoder structures  
  ****************************************************************************/  
325    
326          typedef struct          typedef struct
327          {          {
328                  int width;      int version;
329                  int height;  
330                  void *handle;      int num_zones;          /* [out] */
331          }      xvid_enc_zone_t * zones;    /* [out] */
332          XVID_DEC_PARAM;  
333        int width;              /* [out] */
334        int height;             /* [out] */
335        int mb_width;           /* [out] */
336        int mb_height;          /* [out] */
337            int fincr;              /* [out] */
338        int fbase;              /* [out] */
339    
340        void * param;           /* [out] */
341    } xvid_plg_create_t;
342    
343    
344          typedef struct          typedef struct
345          {          {
346                  int general;      int version;
347                  void *bitstream;  
348                  int length;      int num_frames;          /* [out] totlal frame encoded */
349    } xvid_plg_destroy_t;
                 void *image;  
                 int stride;  
                 int colorspace;  
         }  
         XVID_DEC_FRAME;  
350    
351    
         // This struct is used for per slice rendering  
352          typedef struct          typedef struct
353          {          {
354                  void *y,*u,*v;      int version;
                 int stride_y, stride_u,stride_v;  
         } XVID_DEC_PICTURE;  
355    
356        xvid_enc_zone_t * zone;    /* [out] current zone */
357    
358  /*****************************************************************************      int width;              /* [out] */
359   * Decoder entry point      int height;             /* [out] */
360   ****************************************************************************/      int mb_width;           /* [out] */
361        int mb_height;          /* [out] */
362            int fincr;              /* [out] */
363        int fbase;              /* [out] */
364    
365  /**      int min_quant[3];       /* [out] */
366   * \defgroup  decops_grp Decoder operations      int max_quant[3];       /* [out] */
  *  
  * These are all the operations XviD's decoder can perform.  
  *  
  * @{  
  */  
367    
368  #define XVID_DEC_DECODE         0 /**< Decodes a frame      xvid_image_t reference; /* [out] -> [out] */
369                                     *      xvid_image_t current;   /* [out] -> [in,out] */
370   * This operation constant is used when client application wants to decode a      xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
371   * frame. Client application must also fill XVID_DEC_FRAME appropriately.      int frame_num;          /* [out] frame number */
  */  
372    
373  #define XVID_DEC_CREATE         1 /**< Creates a decoder instance      int type;               /* [in,out] */
374                                     *      int quant;              /* [in,out] */
  * This operation constant is used by a client application in order to create  
  * a decoder instance. Decoder instances are independant from each other, and  
  * can be safely threaded.  
  */  
375    
376  #define XVID_DEC_DESTROY        2 /**< Destroys a decoder instance      int * dquant;               /* [in,out]     pointer to diff quantizer table */
377                                     *          int dquant_stride;              /* [in,out]     diff quantizer stride */
  * This operation constant is used by the client application to destroy a  
  * previously created decoder instance.  
  */  
378    
379  /**      int vop_flags;          /* [in,out] */
380   * @}      int vol_flags;          /* [in,out] */
381   */      int motion_flags;       /* [in,out] */
382    
383  /**      int length;                 /* [out] after: length of encoded frame */
384   * \defgroup  decentry_grp Decoder entry point      int kblks, mblks, ublks;    /* [out] after: */
385   *      int sse_y, sse_u, sse_v;    /* [out] */
386   * @{  } xvid_plg_data_t;
  */  
387    
 /**  
  * \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 Decoder instance handle.  
  * \param opt Decoder option constant  
  * \param param1 Used to pass a XVID_DEC_PARAM or XVID_DEC_FRAME structure  
  * \param param2 Reserved for future use.  
  */  
388    
389          int xvid_decore(void *handle,  /*****************************************************************************
390                          int opt,    xvid plugin system -- external
                         void *param1,  
                         void *param2);  
391    
392  /** @} */    the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
393      indicates the plugin function pointer and plugin-specific data.
394      xvidcore handles the rest. example:
395    
396  /** @} */    xvid_enc_create_t create;
397      xvid_enc_plugin_t plugins[2];
398    
399  /**    plugins[0].func = xvid_psnr_func;
400   * \defgroup encoder_grp Encoder related functions and structures.    plugins[0].param = NULL;
401   *    plugins[1].func = xvid_cbr_func;
402   * @{    plugins[1].param = &cbr_data;
403   */  
404      create.num_plugins = 2;
405      create.plugins = plugins;
406    
 /*****************************************************************************  
  * Encoder constants  
407   ****************************************************************************/   ****************************************************************************/
408    
409  /**  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
  * \defgroup encgenflags_grp  Flags for XVID_ENC_FRAME.general  
  * @{  
  */  
410    
411  #define XVID_VALID_FLAGS                0x80000000 /**< Reserved for future use */  typedef struct
412    {
413        xvid_plugin_func * func;
414        void * param;
415    } xvid_enc_plugin_t;
416    
 #define XVID_CUSTOM_QMATRIX             0x00000004 /**< Use custom quantization matrices  
                                                                                         *  
  * This flag forces XviD to use custom matrices passed to encoder in  
  * 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/**< Lumimasking flag  
                                                                                         *  
                                                                                         * \deprecated This flag is no longer used. */  
 #define XVID_LATEINTRA                  0x00000200/**< Unknown  
                                                                                         *  
                                                                                         * \deprecated This flag is no longer used. */  
 #define XVID_INTERLACING                0x00000400/**< MPEG4 interlacing mode.  
                                                                                         *  
                                                                                         * Enables interlacing encoding mode */  
 #define XVID_TOPFIELDFIRST              0x00000800/**< Unknown  
                                             *  
                                                                                         * \deprecated This flag is no longer used. */  
 #define XVID_ALTERNATESCAN              0x00001000/**<  
                                                                                         *  
                                                                                         * \deprecated This flag is no longer used. */  
 #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 alias  
                                                                                         *  
 * United States locale support. */  
417    
418  /** @} */  xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
419    xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
420    xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
421    
422  /**  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
  * \defgroup encmotionflags_grp  Flags for XVID_ENC_FRAME.motion  
  * @{  
  */  
423    
424  #define PMV_ADVANCEDDIAMOND8    0x00004000/**< Uses advanced diamonds for 8x8 blocks  xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */
425                                                                                          *  xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
426  * Same as its 16x16 companion option  
427  */  
428  #define PMV_ADVANCEDDIAMOND16   0x00008000/**< Uses advanced diamonds for 16x16 blocks  
429                                                                                          *  typedef struct          /* single pass rate control */
430  * */  {
431  #define PMV_HALFPELDIAMOND16    0x00010000/**< Turns on halfpel precision for 16x16 blocks      int version;
432                                                                                          *      int bitrate;                                /* bits per second */
433  * switches the search algorithm from 1 or 2 full pixels precision to 1 or 2 half pixel precision.      int reaction_delay_factor;
434  */      int averaging_period;
435  #define PMV_HALFPELREFINE16     0x00020000/**< Turns on halfpel refinement step      int buffer;
436                                                                                          *  } xvid_plugin_single_t;
437  * After normal diamond search, an extra halfpel refinement step is  performed. Should always be used if  
438  * XVID_HALFPEL is on, because it gives a rather big increase in quality.  
439  */  typedef struct {
440  #define PMV_EXTSEARCH16                 0x00040000/**< Extends search for 16x16 blocks      int version;
441                                                                                          *      char * filename;
442  * Normal PMVfast predicts one  start vector and  does diamond search around this position. EXTSEARCH means that 2  } xvid_plugin_2pass1_t;
443  * more  start vectors  are used:  (0,0) and  median  predictor and diamond search  is done for  those, too.  Makes  
444  * search slightly slower, but quality sometimes gets better.  
445  */  #define XVID_PAYBACK_BIAS   0   /* payback with bias */
446  #define PMV_EARLYSTOP16                 0x00080000/**< Dynamic ME thresholding  #define XVID_PAYBACK_PROP   1   /* payback proportionally */
447                                                                                          *  
448  * PMVfast and EPZS stop search  if current best is  below some dynamic  threshhold. No  diamond search  is done,  typedef struct {
449  * only halfpel  refinement (if active).  Without EARLYSTOP diamond search is always done. That would be much slower,      int version;
450  * but not really lead to better quality.      int bitrate;                                /* bits per second */
451  */      char * filename;
452  #define PMV_QUICKSTOP16                 0x00100000/**< Dynamic ME thresholding  
453                                                                                          *      int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */
454  * like  EARLYSTOP, but not even halfpel refinement is  done. Normally worse quality, so it defaults to      int payback_method;
455  * off. Might be removed, too.      int bitrate_payback_delay;
456  */      int curve_compression_high;
457  #define PMV_UNRESTRICTED16      0x00200000/**< Not implemented      int curve_compression_low;
458                                                                                          *      int max_overflow_improvement;
459  * "unrestricted  ME"   is  a   feature  of MPEG4. It's not  implemented, so this flag is  ignored (not even      int max_overflow_degradation;
460  * checked).  
461  */      int kftreshold;
462  #define PMV_OVERLAPPING16       0x00400000/**< Not implemented          int kfreduction;
463                                                                                          *      int min_key_interval;
464  * Same as above  
465  */          int container_frame_overhead;
466  #define PMV_USESQUARES16                0x00800000/**< Use square pattern  }xvid_plugin_2pass2_t;
                                                                                         *  
 * 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 */  
467    
 /** @} */  
468    
469  /*****************************************************************************  /*****************************************************************************
470   * Encoder structures   * xvid_encore()
471   ****************************************************************************/   ****************************************************************************/
472    
473          /** Structure used for encoder instance creation */  /* Encoder options */
474          typedef struct  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
475          {  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
476                  int width;                    /**< [in]  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
477                                                                             *                                                                          0 means this frame should not be written (ie. encoder lag) */
                                                                            * 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;  
478    
479          typedef struct  int xvid_encore(void *handle, int opt, void *param1, void *param2);
         {  
                 int x;  
                 int y;  
         }  
         VECTOR;  
480    
         typedef struct  
         {  
                 int mode;                               /* macroblock mode */  
                 VECTOR mvs[4];  
         }  
         MVBLOCKHINT;  
481    
482          typedef struct  /* global flags  */
483    typedef enum
484          {          {
485                  int intra;                              /* frame intra choice */      XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */
486                  int fcode;                              /* frame fcode */      XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
487                  MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */      XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004
488          }  /*define XVID_GLOBAL_VOL_AT_IVOP        0x00000008       write vol at every ivop: WIN32/divx compatibility */
489          MVFRAMEHINT;  /*define XVID_GLOBAL_FORCE_VOL          0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
490    } xvid_global_t;
491    
         typedef struct  
         {  
                 int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */  
492    
493                  MVFRAMEHINT mvhint;  /* XVID_ENC_ENCODE param1 */
494                  void *hintstream;               /* compressed hint buffer */  /* vol-based flags */
495                  int hintlength;                 /* length of buffer (bytes) */  typedef enum {
496          }      XVID_VOL_MPEGQUANT          = 0x00000001,
497          HINTINFO;      XVID_VOL_EXTRASTATS         = 0x00000002,
498        XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
499        XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
500        XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
501        XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */
502    } xvid_vol_t;
503    
         /** Structure used to pass a frame to the encoder */  
         typedef struct  
         {  
                 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.  Typically 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 */  
504    
505          }  /* vop-based flags */
506          XVID_ENC_FRAME;  typedef enum {
507        XVID_VOP_DEBUG              = 0x00000001,
508    
509        XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */
510        XVID_VOP_INTER4V            = 0x00000008,
511    
512          /** Encoding statistics */      XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */
513          typedef struct  
514          {      XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
515                  int quant;               /**< [out]      XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
516                                                                    *                                                color input material chroma is ignored) */
517                                                                    * Frame quantizer used during encoding */      XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
518                  int hlength;             /**< [out]      XVID_VOP_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
519                                                                    *  
520                                                                    * Header bytes in the resulting MPEG4 stream */          /* only valid for vol_flags|=XVID_VOL_INTERLACING */
521                  int kblks;               /**< [out]      XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
522                                                                    *      XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
523                                                                    * Number of intra macro blocks  */  
524                  int mblks;               /**< [out]      /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
525                                                                    *      XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */
526                                                                    * Number of inter macro blocks */  } xvid_vop_t;
527                  int ublks;               /**< [out]  
528                                                                    *  
529                                                                    * Number of skipped macro blocks */  typedef enum {
530        XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
531        XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
532    
533        XVID_ME_HALFPELREFINE16     = 0x00020000,
534        XVID_ME_HALFPELREFINE8      = 0x02000000,
535    
536        XVID_ME_QUARTERPELREFINE16  = 0x00040000,
537        XVID_ME_QUARTERPELREFINE8   = 0x04000000,
538    
539        XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
540    
541        XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
542        XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */
543        XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */
544    
545        XVID_ME_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
546        XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
547    
548        /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
549        XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
550        XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
551        XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
552        XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
553    
554        XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
555                                                      enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
556        XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
557    
558        XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
559        XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
560        XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
561        XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
562    } xvid_motion_t;
563    
564    
565    /* XVID_ENC_CREATE param1 */
566    typedef struct {
567            int version;
568    
569        int profile;            /* [in]     profile@level; refer to XVID_PROFILE_xxx */
570            int width;                              /* [in]         frame dimensions; width, pixel units */
571            int height;                             /* [in]         frame dimensions; height, pixel units */
572    
573        int num_zones;          /* [in:opt] number of bitrate zones */
574        xvid_enc_zone_t * zones; /*             ^^ zone array */
575    
576        int num_plugins;        /* [in:opt] number of plugins */
577        xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
578    
579            int num_threads;                /* [in:opt]     number of threads */
580            int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
581    
582            xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */
583    
584    /* --- vol-based stuff; included here for conveinience */
585            int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
586            int fbase;                              /* [in] framerate base
587                                                                                    frame_duration = fincr/fbase seconds*/
588    /* ^^^---------------------------------------------- */
589    
590    
591    /* ---vop-based; included here for conveienience */
592            int max_key_interval;   /* [in:opt] the maximum interval between key frames */
593                                                                                    /*XXX: maybe call it gop_size? */
594    
595            int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
596    
597            int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
598            int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
599    
600        int min_quant[3];       /* [in:opt] */
601        int max_quant[3];       /* [in:opt] */
602    
603    /* ^^^ -------------------------------------------------------------------------*/
604    
605            void *handle;                   /* [out] encoder instance handle */
606          }          }
607          XVID_ENC_STATS;  xvid_enc_create_t;
608    
609    
610  /*****************************************************************************  #define XVID_KEYFRAME   0x00000001
  * Encoder entry point  
  ****************************************************************************/  
611    
612  /**  typedef struct {
613   * \defgroup  encops_grp Encoder operations          int version;
  *  
  * These are all the operations XviD's encoder can perform.  
  *  
  * @{  
  */  
614    
615  #define XVID_ENC_ENCODE         0 /**< Encodes a frame  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
616                                     *                  changes here until the next VOL (keyframe). */
617   * This operation constant is used when client application wants to encode a          xvid_vol_t vol_flags;                   /* [in] vol flags */
618   * frame. Client application must also fill XVID_ENC_FRAME appropriately.          unsigned char *
619   */                  quant_intra_matrix;     /* [in:opt] custom intra qmatrix */
620            unsigned char *
621                    quant_inter_matrix;     /* [in:opt] custom inter qmatrix */
622    
623  #define XVID_ENC_CREATE         1 /**< Creates a decoder instance          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
624                                     *          int par_width;                  /* [in:opt] aspect ratio width */
625   * This operation constant is used by a client application in order to create          int par_height;                 /* [in:opt] aspect ratio height */
626   * an encoder instance. Encoder instances are independant from each other.  /* ^^^----------------------------------------------------------------------------------*/
  */  
627    
628  #define XVID_ENC_DESTROY        2 /**< Destroys a encoder instance      int fincr;                          /* framerate increment, for variable framerate only */
629                                     *          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
630   * This operation constant is used by the client application to destroy a          xvid_motion_t motion;                           /* [in] ME options */
  * previously created encoder instance.  
  */  
631    
632            xvid_image_t input;     /* [in] input image (read from) */
633    
634  /** @} */          int type;                               /* [in:opt] coding type */
635            int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
636            int bframe_threshold;
637    
638  /**          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
639   * \defgroup  encentry_grp Encoder entry point          int length;                             /* [in:opt] bitstream length (bytes) */
  *  
  * @{  
  */  
640    
641  /**          int out_flags;                          /* [out] bitstream output flags */
642   * \brief Encoder entry point.  }
643   *  xvid_enc_frame_t;
644   * This is the XviD's encoder entry point. The possible operations are  
645   * described in the \ref encops_grp section.  
646   *  /* XVID_ENC_ENCODE param2 (optional)
647   * \param handle Encoder instance handle          xvid_enc_stats_t describes individual frame details
648   * \param opt Encoder option constant  
649   * \param param1 Used to pass XVID_ENC_PARAM or XVID_ENC_FRAME structures.          coding_type==XVID_TYPE_NOTHING if the stats are not given
  * \param param2 Optionally used to pass the XVID_ENC_STATS structure.  
650   */   */
651          int xvid_encore(void *handle,  typedef struct {
652                                          int opt,          int version;
653                                          void *param1,  
654                                          void *param2);          /* encoding parameters */
655            int type;                                       /* [out] coding type */
656            int quant;                                      /* [out] frame quantizer */
657            xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */
658            int vop_flags;                          /* [out] vop flags (see above) */
659            /* bitrate */
660            int length;                                     /* [out] frame length */
661    
662  /** @} */          int hlength;                            /* [out] header length (bytes) */
663            int kblks, mblks, ublks;        /* [out] */
664    
665  /** @} */      int sse_y, sse_u, sse_v;
666    }
667    xvid_enc_stats_t;
668    
669  #ifdef __cplusplus  #ifdef __cplusplus
670  }  }
671  #endif  #endif
672    
673    
674  #endif  #endif

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.27.2.23

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