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

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.47

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