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

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

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