[svn] / trunk / xvidcore / src / xvid.h Repository:
ViewVC logotype

Diff of /trunk/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 677, Tue Nov 26 23:44:11 2002 UTC revision 851, Sat Feb 15 15:22:19 2003 UTC
# Line 3  Line 3 
3   *  XVID MPEG-4 VIDEO CODEC   *  XVID MPEG-4 VIDEO CODEC
4   *  - XviD Main header file -   *  - XviD Main header file -
5   *   *
6   *  This file is part of XviD, a free MPEG-4 video encoder/decoder  *  This program is free software ; you can redistribute it and/or modify
7   *  *  it under the terms of the GNU General Public License as published by
  *  XviD is free software; you can redistribute it and/or modify it  
  *  under the terms of the GNU General Public License as published by  
8   *  the Free Software Foundation; either version 2 of the License, or   *  the Free Software Foundation; either version 2 of the License, or
9   *  (at your option) any later version.   *  (at your option) any later version.
10   *   *
# Line 19  Line 17 
17   *  along with this program; if not, write to the Free Software   *  along with this program; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19   *   *
20   *  Under section 8 of the GNU General Public License, the copyright  *****************************************************************************/
21   *  holders of XVID explicitly forbid distribution in the following  /*****************************************************************************
22   *  countries:  *
23   *  *  History
  *    - 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.  
24   *   *
25   * $Id: xvid.h,v 1.24 2002-11-26 23:44:10 edgomez Exp $  *  - 2002/06/13 Added legal header, ANSI C comment style (only for this header
26    *               as it can be included in a ANSI C project).
27    *
28    *               ToDo ? : when BFRAMES is defined, the API_VERSION should not
29    *                        be the same (3.0 ?)
30    *
31    *  $Id: xvid.h,v 1.25 2003-02-15 15:22:17 edgomez Exp $
32   *   *
33   *****************************************************************************/   *****************************************************************************/
34    
35    
36  #ifndef _XVID_H_  #ifndef _XVID_H_
37  #define _XVID_H_  #define _XVID_H_
38    
# Line 59  Line 40 
40  extern "C" {  extern "C" {
41  #endif  #endif
42    
   
 /**  
  * \defgroup global_grp   Global constants used in both encoder and decoder.  
  *  
  * This module describe all constants used in both the encoder and the decoder.  
  * @{  
  */  
   
43  /*****************************************************************************  /*****************************************************************************
44   *  API version number   * Global constants
45   ****************************************************************************/   ****************************************************************************/
46    
47  /**  /* API Version : 2.1 */
48   * \defgroup api_grp API version  #define API_VERSION ((2 << 16) | (1))
49   * @{  #define XVID_API_UNSTABLE
  */  
50    
51  #define API_VERSION ((2 << 16) | (1))/**< This constant tells you what XviD's  /* Bitstream Version
52                                        *   version this header defines.   * this will be writen into the bitstream to allow easy detection of xvid
53                                        *   * encoder bugs in the decoder, without this it might not possible to
54   * You can use it to check if the host XviD library API is the same as the one   * automatically distinquish between a file which has been encoded with an
55   * you used to build you client program. If versions mismatch, then it is   * old & buggy XVID from a file which has been encoded with a bugfree version
56   * highly possible that your application will segfault because the host XviD   * see the infamous interlacing bug ...
  * library and your application use different structures.  
57   *   *
58     * this MUST be increased if an encoder bug is fixed, increasing it too often
59     * doesnt hurt but not increasing it could cause difficulty for decoders in the
60     * future
61   */   */
62    #define XVID_BS_VERSION "0009"
63    
 /** @} */  
   
   
 /*****************************************************************************  
  *  Error codes  
  ****************************************************************************/  
64    
65    /* Error codes */
66    #define XVID_ERR_FAIL           -1
67    #define XVID_ERR_OK                     0
68    #define XVID_ERR_MEMORY         1
69    #define XVID_ERR_FORMAT         2
70    
 /**  
  * \defgroup error_grp Error codes returned by XviD API entry points.  
  * @{  
  */  
71    
72  #define XVID_ERR_FAIL   -1 /**< Operation failed.  /* Colorspaces */
73                              *  #define XVID_CSP_RGB24  0               /* [b|g|r] */
74   * The requested XviD operation failed. If this error code is returned from :  #define XVID_CSP_YV12   1
75   * <ul>  #define XVID_CSP_YUY2   2
76   * <li>the xvid_init function : you must not try to use an XviD's instance from  #define XVID_CSP_UYVY   3
77   *                              this point of the code. Clean all instances you  #define XVID_CSP_I420   4
78   *                              already created and exit the program cleanly.  #define XVID_CSP_RGB555 10
79   * <li>xvid_encore or xvid_decore : something was wrong and en/decoding  #define XVID_CSP_RGB565 11
80   *                                  operation was not completed sucessfully.  #define XVID_CSP_USER   12
81   *                                  you can stop the en/decoding process or just  #define XVID_CSP_EXTERN      1004  // per slice rendering
82   *                                                                      ignore and go on.  #define XVID_CSP_YVYU   1002
83   * <li>xvid_stop : you can safely ignore it if you call this function at the  #define XVID_CSP_RGB32  1000    /* [b|g|r|a] */
84   *                 end of your program.  #define XVID_CSP_ABGR   1006    /* [a|b|g|r] */
85   * </ul>  #define XVID_CSP_RGBA   1005    /* [r|g|b|a] */
  */  
86    
 #define XVID_ERR_OK      0 /**< Operation succeed.  
                             *  
  * The requested XviD operation succeed, you can continue to use XviD's  
  * functions.  
  */  
87    
 #define XVID_ERR_MEMORY  1 /**< Operation failed.  
                             *  
  * Insufficent memory was available on the host system.  
  */  
88    
89  #define XVID_ERR_FORMAT  2 /**< Operation failed.  #define XVID_CSP_NULL   9999
                             *  
  * The format of the parameters or input stream were incorrect.  
  */  
90    
91  /** @} */  #define XVID_CSP_VFLIP  0x80000000      // flip mask
92    
93    
94  /*****************************************************************************  /*****************************************************************************
95   *  Color space constants   *  Initialization constants
96   ****************************************************************************/   ****************************************************************************/
97    
98    /* CPU flags for XVID_INIT_PARAM.cpu_flags */
99    #define XVID_CPU_FORCE          0x80000000
100    #define XVID_CPU_CHKONLY        0x40000000              /* check cpu only; dont init globals */
101    
102  /**  #define XVID_CPU_ASM            0x00000080              /* native assembly */
103   * \defgroup csp_grp Colorspaces constants.  /* ARCH_IS_IA32 */
104   * @{  #define XVID_CPU_MMX            0x00000001              /* mmx: pentiumMMX,k6 */
105   */  #define XVID_CPU_MMXEXT         0x00000002              /* mmxx-ext: pentium2,athlon */
106    #define XVID_CPU_SSE            0x00000004              /* sse: pentium3,athlonXP */
107    #define XVID_CPU_SSE2           0x00000008              /* sse2: pentium4,athlon64 */
108    #define XVID_CPU_3DNOW          0x00000010              /* 3dnow: k6-2 */
109    #define XVID_CPU_3DNOWEXT       0x00000020              /* 3dnow-ext: athlon */
110    #define XVID_CPU_TSC            0x00000040              /* timestamp counter */
111    /* ARCH_IS_IA64 */
112    #define XVID_CPU_IA64           XVID_CPU_ASM    /* defined for backward compatibility */
113    /* ARCH_IS_PPC */
114    #define XVID_CPU_ALTIVEC        0x00000001              /* altivec */
115    
 #define XVID_CSP_RGB24  0  /**< 24-bit RGB colorspace (b,g,r packed) */  
 #define XVID_CSP_YV12   1  /**< YV12 colorspace (y,v,u planar) */  
 #define XVID_CSP_YUY2   2  /**< YUY2 colorspace (y,u,y,v packed) */  
 #define XVID_CSP_UYVY   3  /**< UYVY colorspace (u,y,v,y packed) */  
 #define XVID_CSP_I420   4  /**< I420 colorsapce (y,u,v planar) */  
 #define XVID_CSP_RGB555 10 /**< 16-bit RGB555 colorspace */  
 #define XVID_CSP_RGB565 11 /**< 16-bit RGB565 colorspace */  
 #define XVID_CSP_USER   12 /**< user colorspace format, where the image buffer points  
                             *   to a DEC_PICTURE (y,u,v planar) structure.  
                                                         *  
                                                         *   For encoding, image is read from the DEC_PICTURE  
                                                         *   parameter values. For decoding, the DEC_PICTURE  
                             *   parameters are set, pointing to the internal XviD  
                             *   image buffer. */  
 #define XVID_CSP_EXTERN 1004 /**< Special colorspace used for slice rendering  
                               *  
                               * The application provides an external buffer to XviD.  
                               * This way, XviD works directly into the final rendering  
                               * buffer, no need to specify this is a speed boost feature.  
                               * This feature is only used by mplayer at the moment, refer  
                               * to mplayer code to see how it can be used. */  
 #define XVID_CSP_YVYU   1002 /**< YVYU colorspace (y,v,y,u packed) */  
 #define XVID_CSP_RGB32  1000 /**< 32-bit RGB colorspace (b,g,r,a packed) */  
 #define XVID_CSP_NULL   9999 /**< NULL colorspace; no conversion is performed */  
   
 #define XVID_CSP_VFLIP  0x80000000 /**< (flag) Flip frame vertically during conversion */  
   
 /** @} */  
   
 /** @} */  
116    
117  /**          typedef struct
118   * \defgroup init_grp Initialization constants, structures and functions.          {
119   *                  int colorspace;
120   * This section describes all the constants, structures and functions used to                  void * y;
121   * initialize the XviD core library                  void * u;
122   *                  void * v;
123   * @{                  int y_stride;
124   */                  int uv_stride;
125            } XVID_IMAGE;           /* from yv12 */
126    
127  /*****************************************************************************  #define XVID_INIT_INIT          0
128   *  CPU flags  #define XVID_INIT_CONVERT       1
129   ****************************************************************************/  #define XVID_INIT_TEST          2
   
   
 /**  
  * \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.  
  * @{  
  */  
   
   
 /**  
  * \defgroup x86_grp x86 specific cpu flags  
  * @{  
  */  
   
 #define XVID_CPU_MMX      0x00000001 /**< use/has MMX instruction set */  
 #define XVID_CPU_MMXEXT   0x00000002 /**< use/has MMX-ext (pentium3) instruction set */  
 #define XVID_CPU_SSE      0x00000004 /**< use/has SSE (pentium3) instruction set */  
 #define XVID_CPU_SSE2     0x00000008 /**< use/has SSE2 (pentium4) instruction set */  
 #define XVID_CPU_3DNOW    0x00000010 /**< use/has 3dNOW (k6-2) instruction set */  
 #define XVID_CPU_3DNOWEXT 0x00000020 /**< use/has 3dNOW-ext (athlon) instruction set */  
 #define XVID_CPU_TSC      0x00000040 /**< has TimeStampCounter instruction */  
   
 /** @} */  
   
 /**  
  * \defgroup ia64_grp ia64 specific cpu flags.  
  * @{  
  */  
   
 #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.  
  */  
   
 /** @} */  
   
 /**  
  * \defgroup iniflags_grp Initialization commands.  
  *  
  * @{  
  */  
   
 #define XVID_CPU_CHKONLY  0x40000000 /**< Check cpu features  
                                       *  
  * When this flag is set, the xvid_init function performs just a cpu feature  
  * checking and then fills the cpu field. This flag is usefull when client  
  * applications want to know what instruction sets the host cpu supports.  
  */  
   
 #define XVID_CPU_FORCE    0x80000000 /**< Force input flags to be used  
                                       *  
  * When this flag is set, client application forces XviD to use other flags  
  * set in cpu_flags. \b Use this at your own risk.  
  */  
   
 /** @} */  
   
 /** @} */  
130    
131  /*****************************************************************************  /*****************************************************************************
132   *  Initialization structures   *  Initialization structures
133   ****************************************************************************/   ****************************************************************************/
134    
 /** Structure used in xvid_init function. */  
135          typedef struct          typedef struct
136          {          {
137                  int cpu_flags;   /**< [in/out]                  int cpu_flags;
138                                    *                  int api_version;
139                                    * Filled with desired[in] or available[out]                  int core_build;
                                   * 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.  
                                   */  
140          }          }
141          XVID_INIT_PARAM;          XVID_INIT_PARAM;
142    
143            typedef struct
144            {
145                    XVID_IMAGE input;
146                    XVID_IMAGE output;
147                    int width;
148                    int height;
149                    int interlacing;
150            } XVID_INIT_CONVERTINFO;
151    
152  /*****************************************************************************  /*****************************************************************************
153   *  Initialization entry point   *  Initialization entry point
154   ****************************************************************************/   ****************************************************************************/
155    
 /**  
  * \defgroup inientry_grp Initialization entry point.  
  * @{  
  */  
   
 /**  
  * \brief Initialization entry point.  
  *  
  * This is the XviD's initialization entry point, it is only used to initialize  
  * the XviD internal data (function pointers, vector length code tables,  
  * rgb2yuv lookup tables).  
  *  
  * \param handle Reserved for future use.  
  * \param opt Reserved for future use (set it to 0).  
  * \param param1 Used to pass an XVID_INIT_PARAM parameter.  
  * \param param2 Reserved for future use.  
  */  
156          int xvid_init(void *handle,          int xvid_init(void *handle,
157                        int opt,                        int opt,
158                        void *param1,                        void *param1,
159                        void *param2);                        void *param2);
160    
 /** @} */  
   
 /** @} */  
161    
162  /*****************************************************************************  /*****************************************************************************
163   * Decoder constant   * Decoder constants
164   ****************************************************************************/   ****************************************************************************/
165    
166  /**  /* Flags for XVID_DEC_FRAME.general */
167   * \defgroup decoder_grp Decoder related functions and structures.  #define XVID_DEC_LOWDELAY               0x00000001      /* decode lowdelay mode (ie. video-for-windows) */
168   *  #define XVID_DEC_DEBLOCKY               0x00000002      /* luma deblocking */
169   *  This part describes all the structures/functions from XviD's API needed for  #define XVID_DEC_DEBLOCKUV              0x00000008      /* chroma deblocking */
170   *  decoding a MPEG4 compliant streams.  #define XVID_DEC_DISCONTINUITY  0x00000004      /* indicates break in stream; instructs
171   *  @{                                                                                          decoder to ignore any previous reference frames */
  */  
   
 /**  
  * \defgroup decframe_grp Flags for XVID_DEC_FRAME.general  
  *  
  * Flags' description for the XVID_DEC_FRAME.general member.  
  *  
  * @{  
  */  
   
 /** Not used at the moment */  
172  #define XVID_QUICK_DECODE               0x00000010  #define XVID_QUICK_DECODE               0x00000010
173    
   
 /**  
  * @}  
  */  
   
174  /*****************************************************************************  /*****************************************************************************
175   * Decoder structures   * Decoder structures
176   ****************************************************************************/   ****************************************************************************/
# Line 345  Line 184 
184          XVID_DEC_PARAM;          XVID_DEC_PARAM;
185    
186    
187    #define XVID_DEC_VOP    0
188    #define XVID_DEC_VOL    1
189    #define XVID_DEC_NOTHING        2       /* nothing was decoded */
190    
191            typedef struct
192            {
193                    int notify;                     /* [out]        output 'mode' */
194                    union
195                    {
196                            struct  /* XVID_DEC_VOP */
197                            {
198                                    int time_base;          /* [out]        time base */
199                                    int time_increment;     /* [out]        time increment */
200                            } vop;
201                            struct  /* XVID_DEC_VOL */
202                            {
203                                    int general;            /* [out]        flags: eg. frames are interlaced */
204                                    int width;                      /* [out]        width */
205                                    int height;                     /* [out]        height */
206                                    int aspect_ratio;       /* [out]        aspect ratio */
207                                    int par_width;          /* [out]        aspect ratio width */
208                                    int par_height;         /* [out]        aspect ratio height */
209                            } vol;
210                    } data;
211            } XVID_DEC_STATS;
212    
213    
214          typedef struct          typedef struct
215          {          {
216                  int general;                  int general;
# Line 358  Line 224 
224          XVID_DEC_FRAME;          XVID_DEC_FRAME;
225    
226    
227          /* This struct is used for per slice rendering */          // This struct is used for per slice rendering
228          typedef struct          typedef struct
229          {          {
230                  void *y,*u,*v;                  void *y,*u,*v;
# Line 370  Line 236 
236   * Decoder entry point   * Decoder entry point
237   ****************************************************************************/   ****************************************************************************/
238    
239  /**  /* decoder options */
240   * \defgroup  decops_grp Decoder operations  #define XVID_DEC_DECODE         0
241   *  #define XVID_DEC_CREATE         1
242   * These are all the operations XviD's decoder can perform.  #define XVID_DEC_DESTROY        2
  *  
  * @{  
  */  
243    
244  #define XVID_DEC_DECODE         0 /**< Decodes a frame          int xvid_decore(void *handle,
245                                     *                                          int opt,
246   * This operation constant is used when client application wants to decode a                                          void *param1,
247   * frame. Client application must also fill XVID_DEC_FRAME appropriately.                                          void *param2);
  */  
248    
 #define XVID_DEC_CREATE         1 /**< Creates a decoder instance  
                                    *  
  * This operation constant is used by a client application in order to create  
  * a decoder instance. Decoder instances are independant from each other, and  
  * can be safely threaded.  
  */  
249    
250  #define XVID_DEC_DESTROY        2 /**< Destroys a decoder instance  /*****************************************************************************
251                                     *   * Encoder constants
252   * This operation constant is used by the client application to destroy a   ****************************************************************************/
  * previously created decoder instance.  
  */  
253    
254  /**  /* Flags for XVID_ENC_PARAM.global */
255   * @}  #define XVID_GLOBAL_PACKED              0x00000001      /* packed bitstream */
256   */  #define XVID_GLOBAL_DX50BVOP    0x00000002      /* dx50 bvop compatibility */
257    #define XVID_GLOBAL_DEBUG               0x00000004      /* print debug info on each frame */
258    #define XVID_GLOBAL_REDUCED             0x04000000      /* reduced resolution vop enable */
259    
260  /**  #define XVID_GLOBAL_EXTRASTATS  0x00000200      /* generate extra statistics */
  * \defgroup  decentry_grp Decoder entry point  
  *  
  * @{  
  */  
261    
 /**  
  * \brief Decoder entry point.  
  *  
  * This is the XviD's decoder entry point. The possible operations are  
  * described in the \ref decops_grp section.  
  *  
  * \param handle Decoder instance handle.  
  * \param opt Decoder option constant  
  * \param param1 Used to pass a XVID_DEC_PARAM or XVID_DEC_FRAME structure  
  * \param param2 Reserved for future use.  
  */  
262    
263          int xvid_decore(void *handle,  /* Flags for XVID_ENC_FRAME.general */
264                          int opt,  #define XVID_VALID_FLAGS                0x80000000
                         void *param1,  
                         void *param2);  
265    
266  /** @} */  #define XVID_CUSTOM_QMATRIX             0x00000004      /* use custom quant matrix */
267    #define XVID_H263QUANT                  0x00000010
268    #define XVID_MPEGQUANT                  0x00000020
269    #define XVID_HALFPEL                    0x00000040      /* use halfpel interpolation */
270    #define XVID_QUARTERPEL                 0x02000000
271    #define XVID_ADAPTIVEQUANT              0x00000080
272    #define XVID_LUMIMASKING                0x00000100
273    
274  /** @} */  #define XVID_INTERLACING                0x00000400      /* enable interlaced encoding */
275    #define XVID_TOPFIELDFIRST              0x00000800      /* set top-field-first flag  */
276    #define XVID_ALTERNATESCAN              0x00001000      /* set alternate vertical scan flag */
277    
278  /**  #define XVID_HINTEDME_GET               0x00002000      /* receive mv hint data from core (1st pass) */
279   * \defgroup encoder_grp Encoder related functions and structures.  #define XVID_HINTEDME_SET               0x00004000      /* send mv hint data to core (2nd pass) */
  *  
  * @{  
  */  
280    
281  /*****************************************************************************  #define XVID_INTER4V                    0x00008000
  * Encoder constants  
  ****************************************************************************/  
282    
283  /**  #define XVID_ME_ZERO                    0x00010000
284   * \defgroup encgenflags_grp  Flags for XVID_ENC_FRAME.general  #define XVID_ME_LOGARITHMIC             0x00020000
285   * @{  #define XVID_ME_FULLSEARCH              0x00040000
286   */  #define XVID_ME_PMVFAST                 0x00080000
287    #define XVID_ME_EPZS                    0x00100000
288    
289  #define XVID_VALID_FLAGS                0x80000000 /**< Reserved for future use */  #define XVID_GREYSCALE                  0x01000000      /* enable greyscale only mode (even for */
290                                                                                            /* color input material chroma is ignored) */
291    
292  #define XVID_CUSTOM_QMATRIX             0x00000004 /**< Use custom quantization matrices  #define XVID_GMC                                0x10000000
293                                                                                          *  #define XVID_GMC_TRANSLATIONAL  0x20000000
  * 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. */  
294    
295  /** @} */  #define XVID_REDUCED                    0x04000000      /* reduced resolution vop */
296    #define XVID_HQACPRED                   0x08000000      /* 20030209: high quality ac prediction */
297    
298  /**  #define XVID_EXTRASTATS                 0x00000200  /* generate extra statistics */
  * \defgroup encmotionflags_grp  Flags for XVID_ENC_FRAME.motion  
  * @{  
  */  
299    
300  #define PMV_ADVANCEDDIAMOND8    0x00004000/**< Uses advanced diamonds for 8x8 blocks  #define XVID_MODEDECISION_BITS  0x00400000      /* enable DCT-ME and use it for mode decision */
301                                                                                          *  
302  * Same as its 16x16 companion option  
303  */  /* Flags for XVID_ENC_FRAME.motion */
304  #define PMV_ADVANCEDDIAMOND16   0x00008000/**< Uses advanced diamonds for 16x16 blocks  
305                                                                                          *  #define PMV_ADVANCEDDIAMOND16   0x00008000      /* use advdiamonds instead of diamonds as search pattern */
306  * */  #define PMV_USESQUARES16                0x00800000      /* use squares instead of diamonds as search pattern */
307  #define PMV_HALFPELDIAMOND16    0x00010000/**< Turns on halfpel precision for 16x16 blocks  
308                                                                                          *  #define PMV_HALFPELREFINE16     0x00020000
309  * switches the search algorithm from 1 or 2 full pixels precision to 1 or 2 half pixel precision.  #define PMV_HALFPELREFINE8              0x02000000
310  */  
311  #define PMV_HALFPELREFINE16     0x00020000/**< Turns on halfpel refinement step  #define PMV_QUARTERPELREFINE16  0x00040000
312                                                                                          *  #define PMV_QUARTERPELREFINE8   0x04000000
313  * After normal diamond search, an extra halfpel refinement step is  performed. Should always be used if  
314  * XVID_HALFPEL is on, because it gives a rather big increase in quality.  #define PMV_EXTSEARCH16                 0x00080000      /* extend PMV by more searches */
315  */  
316  #define PMV_EXTSEARCH16                 0x00040000/**< Extends search for 16x16 blocks  #define PMV_EXTSEARCH8                  0x08000000      /* use diamond/square for extended 8x8 search */
317                                                                                          *  #define PMV_ADVANCEDDIAMOND8    0x00004000      /* use advdiamond for PMV_EXTSEARCH8 */
318  * Normal PMVfast predicts one  start vector and  does diamond search around this position. EXTSEARCH means that 2  #define PMV_USESQUARES8                 0x80000000      /* use square for PMV_EXTSEARCH8 */
319  * more  start vectors  are used:  (0,0) and  median  predictor and diamond search  is done for  those, too.  Makes  
320  * search slightly slower, but quality sometimes gets better.  #define PMV_CHROMA16                    0x00100000      /* also use chroma for P_VOP/S_VOP ME */
321  */  #define PMV_CHROMA8                             0x10000000      /* also use chroma for B_VOP ME */
322  #define PMV_EARLYSTOP16                 0x00080000/**< Dynamic ME thresholding  
323                                                                                          *  /* Motion search using DCT. use XVID_MODEDECISION_DCT to enable */
324  * PMVfast and EPZS stop search  if current best is  below some dynamic  threshhold. No  diamond search  is done,  #define HALFPELREFINE16_BITS    0x00000100      /* perform DCT-based halfpel refinement */
325  * only halfpel  refinement (if active).  Without EARLYSTOP diamond search is always done. That would be much slower,  #define HALFPELREFINE8_BITS             0x00000200      /* perform DCT-based halfpel refinement for 8x8 mode */
326  * but not really lead to better quality.  #define QUARTERPELREFINE16_BITS 0x00000400      /* perform DCT-based qpel refinement */
327  */  #define QUARTERPELREFINE8_BITS  0x00000800      /* perform DCT-based qpel refinement for 8x8 mode */
328  #define PMV_QUICKSTOP16                 0x00100000/**< Dynamic ME thresholding  
329                                                                                          *  #define EXTSEARCH_BITS                  0x00001000      /* perform DCT-based search using square pattern */
330  * like  EARLYSTOP, but not even halfpel refinement is  done. Normally worse quality, so it defaults to                                                                                          /* enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
331  * off. Might be removed, too.  #define CHECKPREDICTION_BITS    0x00002000      /* always check vector equal to prediction */
332  */  
333  #define PMV_UNRESTRICTED16      0x00200000/**< Not implemented  
334                                                                                          *  /* note: old and deprecated - or never implemented */
335  * "unrestricted  ME"   is  a   feature  of MPEG4. It's not  implemented, so this flag is  ignored (not even  
336  * checked).  /* only for compatability with old encoders */
337  */  
338  #define PMV_OVERLAPPING16       0x00400000/**< Not implemented  #define PMV_EARLYSTOP16                 0x00
339                                                                                          *  #define PMV_EARLYSTOP8                  0x00
340  * Same as above  #define PMV_QUICKSTOP16                 0x00
341  */  #define PMV_QUICKSTOP8                  0x00
342  #define PMV_USESQUARES16                0x00800000/**< Use square pattern  
343                                                                                          *  #define PMV_HALFPELDIAMOND16    0x00
344  * Replace  the  diamond search  with a  square search.  #define PMV_HALFPELDIAMOND8     0x00
345  */  
346  #define PMV_HALFPELDIAMOND8     0x01000000/**< see 16x16 equivalent  #define PMV_UNRESTRICTED16      0x00200000      /* unrestricted ME, not implemented */
347                                                                                          *  #define PMV_OVERLAPPING16       0x00400000      /* overlapping ME, not implemented */
348  * Same as its 16x16 companion option */  #define PMV_UNRESTRICTED8       0x20000000      /* unrestricted ME, not implemented */
349  #define PMV_HALFPELREFINE8              0x02000000/**< see 16x16 equivalent  #define PMV_OVERLAPPING8                0x40000000      /* overlapping ME, not implemented */
350                                                                                          *  
351  * Same as its 16x16 companion option */  #define XVID_ME_COLOUR                  0x00    /* this has been converted to PMV_CHROMA[16/8] */
 #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 */  
352    
 /** @} */  
353    
354  /*****************************************************************************  /*****************************************************************************
355   * Encoder structures   * Encoder structures
356   ****************************************************************************/   ****************************************************************************/
357    
         /** Structure used for encoder instance creation */  
358          typedef struct          typedef struct
359          {          {
360                  int width;                    /**< [in]                  int width, height;
361                                                                             *                  int fincr, fbase;               /* frame increment, fbase. each frame = "fincr/fbase" seconds */
362                                                                             * Input frame width. */                  int rc_bitrate;                 /* the bitrate of the target encoded stream, in bits/second */
363                  int height;                   /**< [in]                  int rc_reaction_delay_factor;   /* how fast the rate control reacts - lower values are faster */
364                                                                             *                  int rc_averaging_period;        /* as above */
365                                                                             * Input frame height. */                  int rc_buffer;                  /* as above */
366                  int fincr;                    /**< [in]                  int max_quantizer;              /* the upper limit of the quantizer */
367                                                                             *                  int min_quantizer;              /* the lower limit of the quantizer */
368                                                                             * Time increment (fps = increment/base). */                  int max_key_interval;   /* the maximum interval between key frames */
369                  int fbase;                    /**< [in]  #ifdef _SMP
370                                                                             *                  int num_threads;                /* number of threads */
371                                                                             * Time base (fps = increment/base). */  #endif
372                  int rc_bitrate;               /**< [in]                  int global;                             /* global/debug options */
373                                                                             *                  int max_bframes;                /* max sequential bframes (0=disable bframes) */
374                                                                             * Sets the target bitrate of the encoded stream, in bits/second. **/                  int bquant_ratio;               /* bframe quantizer multipier (percentage).
375                  int rc_reaction_delay_factor; /**< [in]                                                                   * used only when bquant < 1
376                                                                             *                                                                   * eg. 200 = x2 multiplier
377                                                                             * Tunes how fast the rate control reacts - lower values are faster. */                                                                   * quant = ((past_quant + future_quant) * bquant_ratio)/200
378                  int rc_averaging_period;      /**< [in]                                                                   */
379                                                                             *                  int bquant_offset;              /* bquant += bquant_offset */
380                                                                             * Tunes how fast the rate control reacts - lower values are faster. */                  int frame_drop_ratio;   /* frame dropping: 0=drop none... 100=drop all */
381                  int rc_buffer;                /**< [in]                  void *handle;                   /* [out] encoder instance handle */
                                                                            *  
                                                                            * 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. */  
382          }          }
383          XVID_ENC_PARAM;          XVID_ENC_PARAM;
384    
# Line 671  Line 414 
414          }          }
415          HINTINFO;          HINTINFO;
416    
         /** Structure used to pass a frame to the encoder */  
417          typedef struct          typedef struct
418          {          {
419                  int general;                       /**< [in]                  int general;                    /* [in] general options */
420                                                                                          *                  int motion;                             /* [in] ME options */
421                                                                                          * Sets general options flag (See \ref encgenflags_grp) */                  void *bitstream;                /* [in] bitstream ptr */
422                  int motion;                        /**< [in]                  int length;                             /* [out] bitstream length (bytes) */
423                                                                                          *  
424                                                                                          * Sets Motion Estimation options */                  void *image;                    /* [in] image ptr */
425                  void *bitstream;                   /**< [out]                  int stride;
426                                                                                          *                  int colorspace;                 /* [in] source colorspace */
427                                                                                          * Output MPEG4 bitstream buffer pointer */  
428                  int length;                        /**< [out]                  unsigned char *quant_intra_matrix;      // [in] custom intra qmatrix */
429                                                                                          *                  unsigned char *quant_inter_matrix;      // [in] custom inter qmatrix */
430                                                                                          * Output MPEG4 bitstream length (bytes) */                  int quant;                              /* [in] frame quantizer (vbr) */
431                  void *image;                       /**< [in]                  int intra;                              /* [in] force intra frame (vbr only)
432                                                                                          *                                                                   * [out] intra state
                                                                                         * 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>  
433                                              */                                              */
434                  HINTINFO hint;                     /**< [in/out]                  HINTINFO hint;                  /* [in/out] mv hint information */
435                                                                                          *  
436                                                                                          * mv hint information */                  int bquant;                             /* [in] bframe quantizer */
437    
438          }          }
439          XVID_ENC_FRAME;          XVID_ENC_FRAME;
440    
441    
         /** Encoding statistics */  
442          typedef struct          typedef struct
443          {          {
444                  int quant;               /**< [out]                  int quant;                              /* [out] frame quantizer */
445                                                                    *                  int hlength;                    /* [out] header length (bytes) */
446                                                                    * Frame quantizer used during encoding */                  int kblks, mblks, ublks;        /* [out] */
447                  int hlength;             /**< [out]                  long sse_y;                             /* [out] SSE of Y */
448                                                                    *                  long sse_u;                             /* [out] SSE of Cb */
449                                                                    * Header bytes in the resulting MPEG4 stream */                  long sse_v;                             /* [out] SSE of Cr */
                 int kblks;               /**< [out]  
                                                                   *  
                                                                   * Number of intra macro blocks  */  
                 int mblks;               /**< [out]  
                                                                   *  
                                                                   * Number of inter macro blocks */  
                 int ublks;               /**< [out]  
                                                                   *  
                                                                   * Number of skipped macro blocks */  
450          }          }
451          XVID_ENC_STATS;          XVID_ENC_STATS;
452    
# Line 761  Line 455 
455   * Encoder entry point   * Encoder entry point
456   ****************************************************************************/   ****************************************************************************/
457    
458  /**  /* Encoder options */
459   * \defgroup  encops_grp Encoder operations  #define XVID_ENC_ENCODE         0
460   *  #define XVID_ENC_CREATE         1
461   * These are all the operations XviD's encoder can perform.  #define XVID_ENC_DESTROY        2
  *  
  * @{  
  */  
462    
 #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.  
  */  
   
 #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. Encoder instances are independant from each other.  
  */  
   
 #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.  
  */  
   
   
 /** @} */  
   
 /**  
  * \defgroup  encentry_grp Encoder entry point  
  *  
  * @{  
  */  
   
 /**  
  * \brief Encoder entry point.  
  *  
  * This is the XviD's encoder entry point. The possible operations are  
  * described in the \ref encops_grp section.  
  *  
  * \param handle Encoder instance handle  
  * \param opt Encoder option constant  
  * \param param1 Used to pass XVID_ENC_PARAM or XVID_ENC_FRAME structures.  
  * \param param2 Optionally used to pass the XVID_ENC_STATS structure.  
  */  
463          int xvid_encore(void *handle,          int xvid_encore(void *handle,
464                                          int opt,                                          int opt,
465                                          void *param1,                                          void *param1,
466                                          void *param2);                                          void *param2);
467    
 /** @} */  
   
 /** @} */  
468    
469  #ifdef __cplusplus  #ifdef __cplusplus
470  }  }

Legend:
Removed from v.677  
changed lines
  Added in v.851

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