[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.23, Sat Nov 16 23:38:16 2002 UTC revision 1.71, Sun Nov 28 15:18:21 2010 UTC
# Line 1  Line 1 
1  /*****************************************************************************  /*****************************************************************************
2   *   *
3   *  XVID MPEG-4 VIDEO CODEC   *  XVID MPEG-4 VIDEO CODEC
4   *  - XviD Main header file -   * - Xvid Main header file -
5   *   *
6   *  This file is part of XviD, a free MPEG-4 video encoder/decoder   *  Copyright(C) 2001-2010 Peter Ross <pross@xvid.org>
7   *   *
8   *  XviD is free software; you can redistribute it and/or modify it   *  This program is free software ; you can redistribute it and/or modify
9   *  under the terms of the GNU General Public License as published by   *  it under the terms of the GNU General Public License as published by
10   *  the Free Software Foundation; either version 2 of the License, or   *  the Free Software Foundation; either version 2 of the License, or
11   *  (at your option) any later version.   *  (at your option) any later version.
12   *   *
# Line 19  Line 19 
19   *  along with this program; if not, write to the Free Software   *  along with this program; if not, write to the Free Software
20   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21   *   *
  *  Under section 8 of the GNU General Public License, the copyright  
  *  holders of XVID explicitly forbid distribution in the following  
  *  countries:  
  *  
  *    - Japan  
  *    - United States of America  
  *  
  *  Linking XviD statically or dynamically with other modules is making a  
  *  combined work based on XviD.  Thus, the terms and conditions of the  
  *  GNU General Public License cover the whole combination.  
  *  
  *  As a special exception, the copyright holders of XviD give you  
  *  permission to link XviD with independent modules that communicate with  
  *  XviD solely through the VFW1.1 and DShow interfaces, regardless of the  
  *  license terms of these independent modules, and to copy and distribute  
  *  the resulting combined work under terms of your choice, provided that  
  *  every copy of the combined work is accompanied by a complete copy of  
  *  the source code of XviD (the version of XviD used to produce the  
  *  combined work), being distributed under the terms of the GNU General  
  *  Public License plus this exception.  An independent module is a module  
  *  which is not derived from or based on XviD.  
  *  
  *  Note that people who make modified versions of XviD are not obligated  
  *  to grant this special exception for their modified versions; it is  
  *  their choice whether to do so.  The GNU General Public License gives  
  *  permission to release a modified version without this exception; this  
  *  exception also makes it possible to release a modified version which  
  *  carries forward this exception.  
  *  
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 different structures.  
  *  
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,3,-127)
61   *  Error codes  #define XVID_API                 XVID_MAKE_API(4, 3)
  ****************************************************************************/  
   
62    
63  /**  #define XVID_UNSTABLE
  * \defgroup error_grp Error codes returned 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 was not completed sucessfully.  
  *                                  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 58
77    
78  #define XVID_ERR_OK      0 /**< Operation succeed.  /*****************************************************************************
79                              *   * error codes
80   * The requested XviD operation succeed, you can continue to use XviD's   ****************************************************************************/
  * functions.  
  */  
81    
82  #define XVID_ERR_MEMORY  1 /**< Operation failed.          /*      all functions return values <0 indicate error */
                             *  
  * Insufficent memory was available on the host system.  
  */  
83    
84  #define XVID_ERR_FORMAT  2 /**< Operation failed.  #define XVID_ERR_FAIL           -1              /* general fault */
85                              *  #define XVID_ERR_MEMORY         -2              /* memory allocation error */
86   * The format of the parameters or input stream were incorrect.  #define XVID_ERR_FORMAT         -3              /* file format error */
87   */  #define XVID_ERR_VERSION        -4              /* structure version not supported */
88    #define XVID_ERR_END            -5              /* encoder only; end of stream reached */
89    
 /** @} */  
90    
91    
92  /*****************************************************************************  /*****************************************************************************
93   *  Color space constants   * xvid_image_t
94   ****************************************************************************/   ****************************************************************************/
95    
96    /* colorspace values */
97    
98  /**  #define XVID_CSP_PLANAR   (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */
99   * \defgroup csp_grp Colorspaces constants.  #define XVID_CSP_USER     XVID_CSP_PLANAR
100   * @{  #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_RGB      (1<<16) /* 24-bit rgb packed */
106    #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
107    #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
108    #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
109    #define XVID_CSP_ARGB     (1<<15) /* 32-bit argb packed */
110    #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
111    #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
112    #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
113    #define XVID_CSP_SLICE    (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */
114    #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
115    #define XVID_CSP_NULL     (1<<14) /* decoder only: dont output anything */
116    #define XVID_CSP_VFLIP    (1<<31) /* vertical flip mask */
117    
118  #define XVID_CSP_RGB24  0  /**< 24-bit RGB colorspace (b,g,r packed) */  /* xvid_image_t
119  #define XVID_CSP_YV12   1  /**< YV12 colorspace (y,v,u planar) */          for non-planar colorspaces use only plane[0] and stride[0]
120  #define XVID_CSP_YUY2   2  /**< YUY2 colorspace (y,u,y,v packed) */          four plane reserved for alpha*/
121  #define XVID_CSP_UYVY   3  /**< UYVY colorspace (u,y,v,y packed) */  typedef struct {
122  #define XVID_CSP_I420   4  /**< I420 colorsapce (y,u,v planar) */          int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
123  #define XVID_CSP_RGB555 10 /**< 16-bit RGB555 colorspace */          void * plane[4];                /* [in] image plane ptrs */
124  #define XVID_CSP_RGB565 11 /**< 16-bit RGB565 colorspace */          int stride[4];                  /* [in] image stride; "bytes per row"*/
125  #define XVID_CSP_USER   12 /**< user colorspace format, where the image buffer points  } xvid_image_t;
                             *   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 */  
   
 #define XVID_CSP_VFLIP  0x80000000 /**< (flag) Flip frame vertically during conversion */  
   
 /** @} */  
   
 /** @} */  
126    
127  /**  /* video-object-sequence profiles */
128   * \defgroup init_grp Initialization constants, structures and functions.  #define XVID_PROFILE_S_L0    0x08 /* simple */
129   *  #define XVID_PROFILE_S_L1    0x01
130   * This section describes all the constants, structures and functions used to  #define XVID_PROFILE_S_L2    0x02
131   * initialize the XviD core library  #define XVID_PROFILE_S_L3    0x03
132   *  #define XVID_PROFILE_S_L4a   0x04
133   * @{  #define XVID_PROFILE_S_L5    0x05
134   */  #define XVID_PROFILE_S_L6    0x06
135    #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
136    #define XVID_PROFILE_ARTS_L2 0x92
137    #define XVID_PROFILE_ARTS_L3 0x93
138    #define XVID_PROFILE_ARTS_L4 0x94
139    #define XVID_PROFILE_AS_L0   0xf0 /* advanced simple */
140    #define XVID_PROFILE_AS_L1   0xf1
141    #define XVID_PROFILE_AS_L2   0xf2
142    #define XVID_PROFILE_AS_L3   0xf3
143    #define XVID_PROFILE_AS_L4   0xf4
144    
145    /* aspect ratios */
146    #define XVID_PAR_11_VGA    1 /* 1:1 vga (square), default if supplied PAR is not a valid value */
147    #define XVID_PAR_43_PAL    2 /* 4:3 pal (12:11 625-line) */
148    #define XVID_PAR_43_NTSC   3 /* 4:3 ntsc (10:11 525-line) */
149    #define XVID_PAR_169_PAL   4 /* 16:9 pal (16:11 625-line) */
150    #define XVID_PAR_169_NTSC  5 /* 16:9 ntsc (40:33 525-line) */
151    #define XVID_PAR_EXT      15 /* extended par; use par_width, par_height */
152    
153    /* frame type flags */
154    #define XVID_TYPE_VOL     -1 /* decoder only: vol was decoded */
155    #define XVID_TYPE_NOTHING  0 /* decoder only (encoder stats): nothing was decoded/encoded */
156    #define XVID_TYPE_AUTO     0 /* encoder: automatically determine coding type */
157    #define XVID_TYPE_IVOP     1 /* intra frame */
158    #define XVID_TYPE_PVOP     2 /* predicted frame */
159    #define XVID_TYPE_BVOP     3 /* bidirectionally encoded */
160    #define XVID_TYPE_SVOP     4 /* predicted+sprite frame */
161    
162    
163  /*****************************************************************************  /*****************************************************************************
164   *  CPU flags   * xvid_global()
165   ****************************************************************************/   ****************************************************************************/
166    
167    /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
168    
169  /**  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
170   * \defgroup cpu_grp Flags for XVID_INIT_PARAM.cpu_flags.  #define XVID_CPU_ASM      (1<< 7) /* native assembly */
171   *  /* ARCH_IS_IA32 */
172   * This section describes all constants that show host cpu available features,  #define XVID_CPU_MMX      (1<< 0) /*       mmx : pentiumMMX,k6 */
173   * and allow a client application to force usage of some cpu instructions sets.  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
174   * @{  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
175   */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
176    #define XVID_CPU_SSE3     (1<< 8) /*      sse3 : pentium4, athlon64 */
177    #define XVID_CPU_SSE41    (1<< 9) /*      sse41: penryn */
178    #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
179    #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
180    #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
181    /* ARCH_IS_PPC */
182    #define XVID_CPU_ALTIVEC  (1<< 0) /* altivec */
183    
184    
185  /**  #define XVID_DEBUG_ERROR     (1<< 0)
186   * \defgroup x86_grp x86 specific cpu flags  #define XVID_DEBUG_STARTCODE (1<< 1)
187   * @{  #define XVID_DEBUG_HEADER    (1<< 2)
188   */  #define XVID_DEBUG_TIMECODE  (1<< 3)
189    #define XVID_DEBUG_MB        (1<< 4)
190    #define XVID_DEBUG_COEFF     (1<< 5)
191    #define XVID_DEBUG_MV        (1<< 6)
192    #define XVID_DEBUG_RC        (1<< 7)
193    #define XVID_DEBUG_DEBUG     (1<<31)
194    
195  #define XVID_CPU_MMX      0x00000001 /**< use/has MMX instruction set */  /* XVID_GBL_INIT param1 */
196  #define XVID_CPU_MMXEXT   0x00000002 /**< use/has MMX-ext (pentium3) instruction set */  typedef struct {
197  #define XVID_CPU_SSE      0x00000004 /**< use/has SSE (pentium3) instruction set */          int version;
198  #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 */
199  #define XVID_CPU_3DNOW    0x00000010 /**< use/has 3dNOW (k6-2) instruction set */          int debug;     /* [in:opt] debug level */
200  #define XVID_CPU_3DNOWEXT 0x00000020 /**< use/has 3dNOW-ext (athlon) instruction set */  } xvid_gbl_init_t;
 #define XVID_CPU_TSC      0x00000040 /**< has TimeStampCounter instruction */  
   
 /** @} */  
   
 /**  
  * \defgroup ia64_grp ia64 specific cpu flags.  
  * @{  
  */  
201    
 #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.  
  */  
202    
203  /** @} */  /* XVID_GBL_INFO param1 */
204    typedef struct {
205            int version;
206            int actual_version; /* [out] returns the actual xvidcore version */
207            const char * build; /* [out] if !null, points to description of this xvid core build */
208            unsigned int cpu_flags;      /* [out] detected cpu features */
209            int num_threads;    /* [out] detected number of cpus/threads */
210    } xvid_gbl_info_t;
211    
 /**  
  * \defgroup iniflags_grp Initialization commands.  
  *  
  * @{  
  */  
212    
213  #define XVID_CPU_CHKONLY  0x40000000 /**< Check cpu features  /* XVID_GBL_CONVERT param1 */
214                                        *  typedef struct {
215   * When this flag is set, the xvid_init function performs just a cpu feature          int version;
216   * checking and then fills the cpu field. This flag is usefull when client          xvid_image_t input;  /* [in] input image & colorspace */
217   * applications want to know what instruction sets the host cpu supports.          xvid_image_t output; /* [in] output image & colorspace */
218   */          int width;           /* [in] width */
219            int height;          /* [in] height */
220            int interlacing;     /* [in] interlacing */
221    } xvid_gbl_convert_t;
222    
 #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.  
  */  
223    
224  /** @} */  #define XVID_GBL_INIT    0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
225    #define XVID_GBL_INFO    1 /* return some info about xvidcore, and the host computer */
226    #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
227    
228    extern int xvid_global(void *handle, int opt, void *param1, void *param2);
229    
 /** @} */  
230    
231  /*****************************************************************************  /*****************************************************************************
232   *  Initialization structures   * xvid_decore()
233   ****************************************************************************/   ****************************************************************************/
234    
235  /** Structure used in xvid_init function. */  #define XVID_DEC_CREATE  0 /* create decore instance; return 0 on success */
236    #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
237    #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */
238    
239    extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
240    
241    /* XVID_DEC_CREATE param 1
242            image width & height as well as FourCC code may be specified
243            here when known in advance (e.g. being read from container) */
244    typedef struct {
245            int version;
246            int width;      /* [in:opt] image width */
247            int height;     /* [in:opt] image width */
248            void * handle;  /* [out]    decore context handle */
249            int fourcc;     /* [in:opt] fourcc of the video */
250    } xvid_dec_create_t;
251    
252    
253    /* XVID_DEC_DECODE param1 */
254    /* general flags */
255    #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
256    #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
257    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
258    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
259    #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
260    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
261    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
262    
263    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
264    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
265    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
266    
267    typedef struct {
268            int version;
269            int general;         /* [in:opt] general flags */
270            void *bitstream;     /* [in]     bitstream (read from)*/
271            int length;          /* [in]     bitstream length */
272            xvid_image_t output; /* [in]     output image (written to) */
273    /* ------- v1.1.x ------- */
274            int brightness;          /* [in]         brightness offset (0=none) */
275    } xvid_dec_frame_t;
276    
277    
278    /* XVID_DEC_DECODE param2 :: optional */
279          typedef struct          typedef struct
280          {          {
281                  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 Unused.  
                                   */  
         }  
         XVID_INIT_PARAM;  
   
 /*****************************************************************************  
  *  Initialization entry point  
  ****************************************************************************/  
282    
283  /**          int type;                   /* [out] output data type */
284   * \defgroup inientry_grp Initialization entry point.          union {
285   * @{                  struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
286   */                          int general;        /* [out] flags */
287                            int time_base;      /* [out] time base */
288                            int time_increment; /* [out] time increment */
289    
290  /**                          /* XXX: external deblocking stuff */
291   * \brief Initialization entry point.                          int * qscale;       /* [out] pointer to quantizer table */
292   *                          int qscale_stride;  /* [out] quantizer scale stride */
  * 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);  
293    
294  /** @} */                  } vop;
295                    struct {        /* XVID_TYPE_VOL */
296                            int general;        /* [out] flags */
297                            int width;          /* [out] width */
298                            int height;         /* [out] height */
299                            int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
300                            int par_width;      /* [out] aspect ratio width  [1..255] */
301                            int par_height;     /* [out] aspect ratio height [1..255] */
302                    } vol;
303            } data;
304    } xvid_dec_stats_t;
305    
306  /** @} */  #define XVID_ZONE_QUANT  (1<<0)
307    #define XVID_ZONE_WEIGHT (1<<1)
308    
309  /*****************************************************************************  typedef struct
310   * Decoder constant  {
311   ****************************************************************************/          int frame;
312            int mode;
313            int increment;
314            int base;
315    } xvid_enc_zone_t;
316    
 /**  
  * \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.  
  *  @{  
  */  
317    
318  /**  /*----------------------------------------------------------------------------
319   * \defgroup decframe_grp Flags for XVID_DEC_FRAME.general   * xvid_enc_stats_t structure
320   *   *
321   * Flags' description for the XVID_DEC_FRAME.general member.   * Used in:
322     *  - xvid_plg_data_t structure
323     *  - optional parameter in xvid_encore() function
324   *   *
325   * @{   * .coding_type = XVID_TYPE_NOTHING if the stats are not given
326   */   *--------------------------------------------------------------------------*/
327    
328  /** Not used at the moment */  typedef struct {
329  #define XVID_QUICK_DECODE               0x00000010          int version;
330    
331            /* encoding parameters */
332            int type;      /* [out] coding type */
333            int quant;     /* [out] frame quantizer */
334            int vol_flags; /* [out] vol flags (see above) */
335            int vop_flags; /* [out] vop flags (see above) */
336    
337  /**          /* bitrate */
338   * @}          int length;    /* [out] frame length */
339   */  
340            int hlength;   /* [out] header length (bytes) */
341            int kblks;     /* [out] number of blocks compressed as Intra */
342            int mblks;     /* [out] number of blocks compressed as Inter */
343            int ublks;     /* [out] number of blocks marked as not_coded */
344    
345            int sse_y;     /* [out] Y plane's sse */
346            int sse_u;     /* [out] U plane's sse */
347            int sse_v;     /* [out] V plane's sse */
348    } xvid_enc_stats_t;
349    
350  /*****************************************************************************  /*****************************************************************************
351   * Decoder structures    xvid plugin system -- internals
352    
353      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
354      before encoding each frame xvidcore will call XVID_PLG_BEFORE
355      after encoding each frame xvidcore will call XVID_PLG_AFTER
356      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
357   ****************************************************************************/   ****************************************************************************/
358    
359    
360    #define XVID_PLG_CREATE  (1<<0)
361    #define XVID_PLG_DESTROY (1<<1)
362    #define XVID_PLG_INFO    (1<<2)
363    #define XVID_PLG_BEFORE  (1<<3)
364    #define XVID_PLG_FRAME   (1<<4)
365    #define XVID_PLG_AFTER   (1<<5)
366    
367    /* xvid_plg_info_t.flags */
368    #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
369    #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
370    #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
371    #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */
372    
373          typedef struct          typedef struct
374          {          {
375                  int width;          int version;
376                  int height;          int flags;   /* [in:opt] plugin flags */
377                  void *handle;  } xvid_plg_info_t;
         }  
         XVID_DEC_PARAM;  
378    
379    
380          typedef struct          typedef struct
381          {          {
382                  int general;          int version;
383                  void *bitstream;  
384                  int length;          int num_zones;           /* [out] */
385            xvid_enc_zone_t * zones; /* [out] */
386                  void *image;  
387                  int stride;          int width;               /* [out] */
388                  int colorspace;          int height;              /* [out] */
389          }          int mb_width;            /* [out] */
390          XVID_DEC_FRAME;          int mb_height;           /* [out] */
391            int fincr;               /* [out] */
392            int fbase;               /* [out] */
393    
394            void * param;            /* [out] */
395    } xvid_plg_create_t;
396    
397    
         // This struct is used for per slice rendering  
398          typedef struct          typedef struct
399          {          {
400                  void *y,*u,*v;          int version;
                 int stride_y, stride_u,stride_v;  
         } XVID_DEC_PICTURE;  
401    
402            int num_frames; /* [out] total frame encoded */
403    } xvid_plg_destroy_t;
404    
405  /*****************************************************************************  typedef struct
406   * Decoder entry point  {
407   ****************************************************************************/          int version;
408    
409  /**          xvid_enc_zone_t * zone; /* [out] current zone */
  * \defgroup  decops_grp Decoder operations  
  *  
  * These are all the operations XviD's decoder can perform.  
  *  
  * @{  
  */  
410    
411  #define XVID_DEC_DECODE         0 /**< Decodes a frame          int width;              /* [out] */
412                                     *          int height;             /* [out] */
413   * This operation constant is used when client application wants to decode a          int mb_width;           /* [out] */
414   * frame. Client application must also fill XVID_DEC_FRAME appropriately.          int mb_height;          /* [out] */
415   */          int fincr;              /* [out] */
416            int fbase;              /* [out] */
417    
418  #define XVID_DEC_CREATE         1 /**< Creates a decoder instance          int min_quant[3];       /* [out] */
419                                     *          int max_quant[3];       /* [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.  
  */  
420    
421  #define XVID_DEC_DESTROY        2 /**< Destroys a decoder instance          xvid_image_t reference; /* [out] -> [out] */
422                                     *          xvid_image_t current;   /* [out] -> [in,out] */
423   * This operation constant is used by the client application to destroy a          xvid_image_t original;  /* [out] after: points the original (uncompressed) copy of the current frame */
424   * previously created decoder instance.          int frame_num;          /* [out] frame number */
  */  
425    
426  /**          int type;               /* [in,out] */
427   * @}          int quant;              /* [in,out] */
  */  
428    
429  /**          int * dquant;           /* [in,out]     pointer to diff quantizer table */
430   * \defgroup  decentry_grp Decoder entry point          int dquant_stride;      /* [in,out]     diff quantizer stride */
  *  
  * @{  
  */  
431    
432  /**          int vop_flags;          /* [in,out] */
433   * \brief Decoder entry point.          int vol_flags;          /* [in,out] */
434   *          int motion_flags;       /* [in,out] */
  * 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.  
  */  
435    
436          int xvid_decore(void *handle,          /* Lambda table for HVSPlugins */
437                          int opt,          float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
                         void *param1,  
                         void *param2);  
438    
439  /** @} */  /* Deprecated, use the stats field instead.
440     * Will disapear before 1.0 */
441            int length;             /* [out] after: length of encoded frame */
442            int kblks;              /* [out] number of blocks compressed as Intra */
443            int mblks;              /* [out] number of blocks compressed as Inter */
444            int ublks;              /* [out] number of blocks marked not_coded */
445            int sse_y;              /* [out] Y plane's sse */
446            int sse_u;              /* [out] U plane's sse */
447            int sse_v;              /* [out] V plane's sse */
448    /* End of duplicated data, kept only for binary compatibility */
449    
450  /** @} */          int bquant_ratio;       /* [in] */
451            int bquant_offset;      /* [in] */
452    
453  /**          xvid_enc_stats_t stats; /* [out] frame statistics */
454   * \defgroup encoder_grp Encoder related functions and structures.  } xvid_plg_data_t;
  *  
  * @{  
  */  
455    
456  /*****************************************************************************  /*****************************************************************************
457   * Encoder constants    xvid plugin system -- external
458    
459      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
460      indicates the plugin function pointer and plugin-specific data.
461      xvidcore handles the rest. example:
462    
463      xvid_enc_create_t create;
464      xvid_enc_plugin_t plugins[2];
465    
466      plugins[0].func = xvid_psnr_func;
467      plugins[0].param = NULL;
468      plugins[1].func = xvid_cbr_func;
469      plugins[1].param = &cbr_data;
470    
471      create.num_plugins = 2;
472      create.plugins = plugins;
473    
474   ****************************************************************************/   ****************************************************************************/
475    
476  /**  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
  * \defgroup encgenflags_grp  Flags for XVID_ENC_FRAME.general  
  * @{  
  */  
477    
478  #define XVID_VALID_FLAGS                0x80000000 /**< Reserved for future use */  typedef struct
479    {
480            xvid_plugin_func * func;
481            void * param;
482    } xvid_enc_plugin_t;
483    
 #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. */  
484    
485  /** @} */  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
486    extern xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
487    extern xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
488    
489  /**  extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
  * \defgroup encmotionflags_grp  Flags for XVID_ENC_FRAME.motion  
  * @{  
  */  
490    
491  #define PMV_ADVANCEDDIAMOND8    0x00004000/**< Uses advanced diamonds for 8x8 blocks  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
492                                                                                          *  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
 * 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 */  
493    
494  /** @} */  extern xvid_plugin_func xvid_plugin_ssim;           /*write ssim values to stdout*/
495    extern xvid_plugin_func xvid_plugin_psnrhvsm;   /*write psnrhvsm values to stdout*/
496    
 /*****************************************************************************  
  * Encoder structures  
  ****************************************************************************/  
497    
498          /** Structure used for encoder instance creation */  /* single pass rate control
499     * CBR and Constant quantizer modes */
500          typedef struct          typedef struct
501          {          {
502                  int width;                    /**< [in]          int version;
                                                                            *  
                                                                            * 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;  
503    
504          typedef struct          int bitrate;               /* [in] bits per second */
505          {          int reaction_delay_factor; /* [in] */
506                  int x;          int averaging_period;      /* [in] */
507                  int y;          int buffer;                /* [in] */
508          }  } xvid_plugin_single_t;
         VECTOR;  
509    
         typedef struct  
         {  
                 int mode;                               /* macroblock mode */  
                 VECTOR mvs[4];  
         }  
         MVBLOCKHINT;  
510    
511          typedef struct  typedef struct {
512          {          int version;
                 int intra;                              /* frame intra choice */  
                 int fcode;                              /* frame fcode */  
                 MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */  
         }  
         MVFRAMEHINT;  
513    
514          typedef struct          char * filename;
515          {  } xvid_plugin_2pass1_t;
                 int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */  
516    
                 MVFRAMEHINT mvhint;  
                 void *hintstream;               /* compressed hint buffer */  
                 int hintlength;                 /* length of buffer (bytes) */  
         }  
         HINTINFO;  
517    
518          /** Structure used to pass a frame to the encoder */  #define XVID_PAYBACK_BIAS 0 /* payback with bias */
519          typedef struct  #define XVID_PAYBACK_PROP 1 /* payback proportionally */
         {  
                 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 */  
520    
521          }  typedef struct {
522          XVID_ENC_FRAME;          int version;
523    
524            int bitrate;                  /* [in] target bitrate (bits per second) */
525            char * filename;              /* [in] first pass stats filename */
526    
527          /** Encoding statistics */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
528          typedef struct          int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
529          {          int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
530                  int quant;               /**< [out]          int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
531                                                                    *          int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
532                                                                    * Frame quantizer used during encoding */          int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
533                  int hlength;             /**< [out]  
534                                                                    *          int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
535                                                                    * Header bytes in the resulting MPEG4 stream */          int kfthreshold;              /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
536                  int kblks;               /**< [out]                                                                     *      is substracted from its bit allocation. The reduction is computed as multiples of
537                                                                    *                                                                     *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
538                                                                    * Number of intra macro blocks  */                                                                     *      0 for 1<distance<kfthreshold */
539                  int mblks;               /**< [out]  
540                                                                    *          int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
541                                                                    * Number of inter macro blocks */  
542                  int ublks;               /**< [out]  /* ------- v1.1.x ------- */
543                                                                    *          int vbv_size;                 /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/
544                                                                    * Number of skipped macro blocks */          int vbv_initial;              /* [in] initial buffer occupancy (bits) */
545          }          int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
546          XVID_ENC_STATS;          int vbv_peakrate;             /* [in:opt] max average bitrate over 1 second (bits per second).
547                                                                       *          This is used for diagnostics only and won't affect the actual peak bitrate.
548                                                                       *          This is not a problem as long as vbv_peakrate > vbv_size + vbv_maxrate which
549                                                                       *          guarantees that vbv_peakrate won't be exceeded. */
550    }xvid_plugin_2pass2_t;
551    
552    
553    typedef struct{
554            /*stat output*/
555            int b_printstat;
556            char* stat_path;
557    
558            /*visualize*/
559            int b_visualize;
560    
561            /*accuracy 0 very accurate 4 very fast*/
562            int acc;
563    
564        int cpu_flags; /* XVID_CPU_XXX flags */
565    
566    } xvid_plugin_ssim_t;
567    
568    typedef struct {
569            int version;
570    
571            int method;      /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */
572    } xvid_plugin_lumimasking_t;
573    
574  /*****************************************************************************  /*****************************************************************************
575   * Encoder entry point   *                             ENCODER API
576   ****************************************************************************/   ****************************************************************************/
577    
578  /**  /*----------------------------------------------------------------------------
579   * \defgroup  encops_grp Encoder operations   * Encoder operations
580   *   *--------------------------------------------------------------------------*/
  * These are all the operations XviD's encoder can perform.  
  *  
  * @{  
  */  
   
 #define XVID_ENC_ENCODE         0 /**< Encodes a frame  
                                    *  
  * This operation constant is used when client application wants to encode a  
  * frame. Client application must also fill XVID_ENC_FRAME appropriately.  
  */  
581    
582  #define XVID_ENC_CREATE         1 /**< Creates a decoder instance  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
583                                     *  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
584   * This operation constant is used by a client application in order to create  #define XVID_ENC_ENCODE  2 /* encode a frame: returns number of ouput bytes
585   * an encoder instance. Encoder instances are independant from each other.                              * 0 means this frame should not be written (ie. encoder lag) */
  */  
586    
 #define XVID_ENC_DESTROY        2 /**< Destroys a encoder instance  
                                    *  
  * This operation constant is used by the client application to destroy a  
  * previously created encoder instance.  
  */  
587    
588    /*----------------------------------------------------------------------------
589     * Encoder entry point
590     *--------------------------------------------------------------------------*/
591    
592  /** @} */  extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
593    
594  /**  /* Quick API reference
  * \defgroup  encentry_grp Encoder entry point  
595   *   *
596   * @{   * XVID_ENC_CREATE operation
597     *  - handle: ignored
598     *  - opt: XVID_ENC_CREATE
599     *  - param1: address of a xvid_enc_create_t structure
600     *  - param2: ignored
601     *
602     * XVID_ENC_ENCODE operation
603     *  - handle: an instance returned by a CREATE op
604     *  - opt: XVID_ENC_ENCODE
605     *  - param1: address of a xvid_enc_frame_t structure
606     *  - param2: address of a xvid_enc_stats_t structure (optional)
607     *            its return value is asynchronous to what is written to the buffer
608     *            depending on the delay introduced by bvop use. It's display
609     *            ordered.
610     *
611     * XVID_ENC_DESTROY operation
612     *  - handle: an instance returned by a CREATE op
613     *  - opt: XVID_ENC_DESTROY
614     *  - param1: ignored
615     *  - param2: ignored
616   */   */
617    
618  /**  
619   * \brief Encoder entry point.  /*----------------------------------------------------------------------------
620   *   * "Global" flags
621   * This is the XviD's encoder entry point. The possible operations are   *
622   * described in the \ref encops_grp section.   * These flags are used for xvid_enc_create_t->global field during instance
623     * creation (operation XVID_ENC_CREATE)
624     *--------------------------------------------------------------------------*/
625    
626    #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
627    #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
628    #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
629    #if 0
630    #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
631    #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
632    #endif
633    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
634                                                    this is implied if XVID_GLOBAL_PACKED is set */
635    
636    /*----------------------------------------------------------------------------
637     * "VOL" flags
638   *   *
639   * \param handle Encoder instance handle   * These flags are used for xvid_enc_frame_t->vol_flags field during frame
640   * \param opt Encoder option constant   * encoding (operation XVID_ENC_ENCODE)
641   * \param param1 Used to pass XVID_ENC_PARAM or XVID_ENC_FRAME structures.   *--------------------------------------------------------------------------*/
642   * \param param2 Optionally used to pass the XVID_ENC_STATS structure.  
643   */  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
644          int xvid_encore(void *handle,  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
645                                          int opt,  #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
646                                          void *param1,  #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
647                                          void *param2);  #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
648                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
649    #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
650    
651    
652    /*----------------------------------------------------------------------------
653     * "VOP" flags
654     *
655     * These flags are used for xvid_enc_frame_t->vop_flags field during frame
656     * encoding (operation XVID_ENC_ENCODE)
657     *--------------------------------------------------------------------------*/
658    
659    /* Always valid */
660    #define XVID_VOP_DEBUG                (1<< 0) /* print debug messages in frames */
661    #define XVID_VOP_HALFPEL              (1<< 1) /* use halfpel interpolation */
662    #define XVID_VOP_INTER4V              (1<< 2) /* use 4 motion vectors per MB */
663    #define XVID_VOP_TRELLISQUANT         (1<< 3) /* use trellis based R-D "optimal" quantization */
664    #define XVID_VOP_CHROMAOPT            (1<< 4) /* enable chroma optimization pre-filter */
665    #define XVID_VOP_CARTOON              (1<< 5) /* use 'cartoon mode' */
666    #define XVID_VOP_GREYSCALE            (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
667    #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */
668    #define XVID_VOP_MODEDECISION_RD      (1<< 8) /* enable DCT-ME and use it for mode decision */
669    #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
670    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
671    #define XVID_VOP_RD_PSNRHVSM          (1<<14) /* use PSNR-HVS-M as metric for rate-distortion optimizations */
672    
673    /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
674    #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
675    #define XVID_VOP_ALTERNATESCAN        (1<<10) /* set alternate vertical scan flag */
676    
677    /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
678    #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */
679                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
680    
681    /*----------------------------------------------------------------------------
682     * "Motion" flags
683     *
684     * These flags are used for xvid_enc_frame_t->motion field during frame
685     * encoding (operation XVID_ENC_ENCODE)
686     *--------------------------------------------------------------------------*/
687    
688    /* Motion Estimation Search Patterns */
689    #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
690    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
691    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
692    #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
693    
694    /* SAD operator based flags */
695    #define XVID_ME_HALFPELREFINE16       (1<< 4)
696    #define XVID_ME_HALFPELREFINE8        (1<< 6)
697    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
698    #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
699    #define XVID_ME_GME_REFINE            (1<< 9)
700    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
701    #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
702    #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
703    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
704    #define XVID_ME_FASTREFINE16          (1<<25) /* use low-complexity refinement functions */
705    #define XVID_ME_FASTREFINE8           (1<<29) /* low-complexity 8x8 sub-block refinement */
706    
707    /* Rate Distortion based flags
708     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
709    #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
710    #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
711    #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
712    #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
713    #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 */
714    #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
715    
716    /* Other */
717    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
718    #define XVID_ME_SKIP_DELTASEARCH      (1<<26) /* speed-up by skipping b-frame delta search */
719    #define XVID_ME_FAST_MODEINTERPOLATE  (1<<27) /* speed-up by partly skipping interpolate mode */
720    #define XVID_ME_BFRAME_EARLYSTOP      (1<<28) /* speed-up by early exiting b-search */
721    
722    /* Unused */
723    #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
724    #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
725    #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
726    #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
727    
728    
729    /*----------------------------------------------------------------------------
730     * xvid_enc_create_t structure definition
731     *
732     * This structure is passed as param1 during an instance creation (operation
733     * XVID_ENC_CREATE)
734     *--------------------------------------------------------------------------*/
735    
736    typedef struct {
737            int version;
738    
739            int profile;                 /* [in] profile@level; refer to XVID_PROFILE_xxx */
740            int width;                   /* [in] frame dimensions; width, pixel units */
741            int height;                  /* [in] frame dimensions; height, pixel units */
742    
743            int num_zones;               /* [in:opt] number of bitrate zones */
744            xvid_enc_zone_t * zones;     /*          ^^ zone array */
745    
746            int num_plugins;             /* [in:opt] number of plugins */
747            xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
748    
749            int num_threads;             /* [in:opt] number of threads */
750            int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
751    
752            int global;                  /* [in:opt] global flags; controls encoding behavior */
753    
754            /* --- vol-based stuff; included here for convenience */
755            int fincr;                   /* [in:opt] framerate increment; set to zero for variable framerate */
756            int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
757        /* ---------------------------------------------- */
758    
759            /* --- vop-based; included here for convenience */
760            int max_key_interval;        /* [in:opt] the maximum interval between key frames */
761    
762            int frame_drop_ratio;        /* [in:opt] frame dropping: 0=drop none... 100=drop all */
763    
764            int bquant_ratio;            /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
765            int bquant_offset;           /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
766    
767            int min_quant[3];            /* [in:opt] */
768            int max_quant[3];            /* [in:opt] */
769            /* ---------------------------------------------- */
770    
771            void *handle;                /* [out] encoder instance handle */
772    
773            /* ------- v1.3.x ------- */
774            int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */
775    } xvid_enc_create_t;
776    
777    
778    /*----------------------------------------------------------------------------
779     * xvid_enc_frame_t structure definition
780     *
781     * This structure is passed as param1 during a frame encoding (operation
782     * XVID_ENC_ENCODE)
783     *--------------------------------------------------------------------------*/
784    
785    /* out value for the frame structure->type field
786     * unlike stats output in param2, this field is not asynchronous and tells
787     * the client app, if the frame written into the stream buffer is an ivop
788     * usually used for indexing purpose in the container */
789    #define XVID_KEYFRAME (1<<1)
790    
791    /* The structure */
792    typedef struct {
793            int version;
794    
795            /* VOL related stuff
796             * unless XVID_FORCEVOL is set, the encoder will not react to any changes
797             * here until the next VOL (keyframe). */
798    
799            int vol_flags;                     /* [in] vol flags */
800            unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
801            unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
802    
803            int par;                           /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */
804            int par_width;                     /* [in:opt] aspect ratio width */
805            int par_height;                    /* [in:opt] aspect ratio height */
806    
807            /* Other fields that can change on a frame base */
808    
809            int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
810            int vop_flags;                     /* [in] (general)vop-based flags */
811            int motion;                        /* [in] ME options */
812    
813            xvid_image_t input;                /* [in] input image (read from) */
814    
815            int type;                          /* [in:opt] coding type */
816            int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
817            int bframe_threshold;
818    
819  /** @} */          void *bitstream;                   /* [in:opt] bitstream ptr (written to)*/
820            int length;                        /* [in:opt] bitstream length (bytes) */
821    
822  /** @} */          int out_flags;                     /* [out] bitstream output flags */
823    } xvid_enc_frame_t;
824    
825  #ifdef __cplusplus  #ifdef __cplusplus
826  }  }
Legend:
Removed from v.1.23  
changed lines
  Added in v.1.71
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4