[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.27.2.3, Mon Mar 10 00:43:31 2003 UTC
# Line 3  Line 3 
3   *  XVID MPEG-4 VIDEO CODEC   *  XVID MPEG-4 VIDEO CODEC
4   *  - XviD Main header file -   *  - XviD Main header file -
5   *   *
6   *  This program is an implementation of a part of one or more MPEG-4   *  This file is part of XviD, a free MPEG-4 video encoder/decoder
  *  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_
# Line 37  Line 30 
30  extern "C" {  extern "C" {
31  #endif  #endif
32    
   
 /**  
  * \defgroup global_grp   Global constants used in both encoder and decoder.  
  *  
  * This module describe all constants used in both the encoder and the decoder.  
  * @{  
  */  
   
33  /*****************************************************************************  /*****************************************************************************
34   *  API version number   * versioning
35   ****************************************************************************/   ****************************************************************************/
36    
37  /**  /* versioning
38   * \defgroup api_grp API version          version takes the form "$major.$minor.$patch"
39   * @{          $patch is incremented when there is no api change
40   */          $minor is incremented when the api is changed, but remains backwards compatible
41            $major is incremented when the api is changed significantly
 #define API_VERSION ((2 << 16) | (1))/**< This constant tells you what XviD's  
                                       *   version this header defines.  
                                       *  
  * You can use it to check if the host XviD library API is the same as the one  
  * you used to build you client program. If versions mismatch, then it is  
  * highly possible that your application will segfault because the host XviD  
  * library and your application use structure fields in different ways.  
  *  
  */  
   
 /** @} */  
42    
43            when initialising an xvid structure, you must always zero it, and set the version field.
44                    memset(&struct,0,sizeof(struct));
45                    struct.version = XVID_VERSION;
46    
47  /*****************************************************************************          XVID_UNSTABLE is defined only during development.
48   *  Error codes          */
  ****************************************************************************/  
49    
50    #define XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )
51    #define XVID_MAJOR(a)                           ( ((a)>>16) & 0xff )
52    #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))
53    #define XVID_PATCH(c)                           ( (c) & 0xff )
54    
55  /**  #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)
56   * \defgroup error_grp Error codes used by XviD API entry points.  #define XVID_UNSTABLE
  * @{  
  */  
57    
58  #define XVID_ERR_FAIL   -1 /**< Operation failed.  /* Bitstream Version
59     * this will be writen into the bitstream to allow easy detection of xvid
60     * encoder bugs in the decoder, without this it might not possible to
61     * automatically distinquish between a file which has been encoded with an
62     * old & buggy XVID from a file which has been encoded with a bugfree version
63     * see the infamous interlacing bug ...
64                              *                              *
65   * The requested XviD operation failed. If this error code is returned from :   * this MUST be increased if an encoder bug is fixed, increasing it too often
66   * <ul>   * doesnt hurt but not increasing it could cause difficulty for decoders in the
67   * <li>the xvid_init function : you must not try to use an XviD's instance from   * future
  *                              this point of the code. Clean all instances you  
  *                              already created and exit the program cleanly.  
  * <li>xvid_encore or xvid_decore : something was wrong and en/decoding  
  *                                  operation has not been completed  
  *                                 sucessfully. At your option, you can  
  *                                 stop the en/decoding process or just ignore  
  *                                 and go on.  
  * <li>xvid_stop : you can safely ignore it if you call this function at the  
  *                 end of your program.  
  * </ul>  
68   */   */
69    #define XVID_BS_VERSION "0009"
70    
 #define XVID_ERR_OK      0 /**< Operation succeed.  
                             *  
  * The requested XviD operation succeed, you can continue to use XviD's  
  * functions.  
  */  
71    
72  #define XVID_ERR_MEMORY  1 /**< Operation failed.  /*****************************************************************************
73                              *   * error codes
74   * No memory was available on the host system, this is probably time to kill   ****************************************************************************/
  * some unuseful programs (WinSpyWare, KDE, GNOME</trollinside>) in order to  
  * use XviD.  
  */  
75    
76  #define XVID_ERR_FORMAT  2 /**< Operation failed.      /*  all functions return values <0 indicate error */
77                              *  
78   * The format of the parameters, input stream were wrong.  #define XVID_ERR_FAIL           -1              /* general fault */
79   */  #define XVID_ERR_MEMORY     -2          /* memory allocation error */
80    #define XVID_ERR_FORMAT     -3          /* file format error */
81    #define XVID_ERR_VERSION        -4              /* structure version not supported */
82    #define XVID_ERR_END            -5              /* encoder only; end of stream reached */
83    
 /** @} */  
84    
85    
86  /*****************************************************************************  /*****************************************************************************
87   *  Color space constants   * xvid_image_t
88   ****************************************************************************/   ****************************************************************************/
89    
90    /* colorspace values */
91    
92  /**  #define XVID_CSP_USER           0       /* 4:2:0 planar */
93   * \defgroup csp_grp Colorspaces constants.  #define XVID_CSP_I420           1       /* 4:2:0 packed(planar win32) */
94   * @{  #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */
95   */  #define XVID_CSP_YUY2           3       /* 4:2:2 packed */
96    #define XVID_CSP_UYVY           4       /* 4:2:2 packed */
97    #define XVID_CSP_YVYU           5       /* 4:2:2 packed */
98    #define XVID_CSP_BGRA           6       /* 32-bit bgra packed */
99    #define XVID_CSP_ABGR           7       /* 32-bit abgr packed */
100    #define XVID_CSP_RGBA           8       /* 32-bit rgba packed */
101    #define XVID_CSP_BGR            9       /* 32-bit bgr packed */
102    #define XVID_CSP_RGB555     10  /* 16-bit rgb555 packed */
103    #define XVID_CSP_RGB565     11  /* 16-bit rgb565 packed */
104    #define XVID_CSP_SLICE          12      /* decoder only: 4:2:0 planar, per slice rendering */
105    #define XVID_CSP_INTERNAL       13      /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
106    #define XVID_CSP_NULL           14      /* decoder only: dont output anything */
107    #define XVID_CSP_VFLIP  0x80000000      /* vertical flip mask */
108    
109  #define XVID_CSP_RGB24  0  /**< Input/output frame uses the RGB24 colorspace format */  /* xvid_image_t
110  #define XVID_CSP_YV12   1  /**< Input/output frame uses the YV12 colorspace format */          for non-planar colorspaces use only plane[0] and stride[0]
111  #define XVID_CSP_YUY2   2  /**< Input/output frame uses the YUV2 colorspace format */          four plane reserved for alpha*/
112  #define XVID_CSP_UYVY   3  /**< Input/output frame uses the UYVY colorspace format */  typedef struct {
113  #define XVID_CSP_I420   4  /**< Input/output frame uses the I420 colorspace format */          int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
114  #define XVID_CSP_RGB555 10 /**< Input/output frame uses the RGB555 colorspace format */          void * plane[4];                /* [in] image plane ptrs */
115  #define XVID_CSP_RGB565 11 /**< Input/output frame uses the RGB565 colorspace format */          int stride[4];                  /* [in] image stride; "bytes per row"*/
116  #define XVID_CSP_USER   12 /**< Input/output frame uses the USER colorspace format  } xvid_image_t;
                             *  
                             * XviD will not perform any colorspace conversion. The  
                             * output will be the native MPEG4 YV12 colorspace. Up to  
                             * the client application to convert it to a usable format. */  
 #define XVID_CSP_EXTERN 1004 /**< Special colorspace used for slice rendering  
                               *  
                               * The application provides an external buffer to XviD.  
                               * This way, XviD works directly into the final rendering  
                               * buffer, no need to specify this is a speed boost feature.  
                               * This feature is only used by mplayer at the moment, refer  
                               * to mplayer code to see how it can be used. */  
 #define XVID_CSP_YVYU   1002 /**< Input/output frame uses the YVYU colorspace format */  
 #define XVID_CSP_RGB32  1000 /**< Input/output frame uses the RGB32 colorspace format */  
 #define XVID_CSP_NULL   9999 /**< Input/output frame uses the NULL colorspace format */  
117    
 #define XVID_CSP_VFLIP  0x80000000 /**< Flips input/output frames */  
118    
119  /** @} */  /* aspect ratios */
120    #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */
121  /** @} */  #define XVID_PAR_43_PAL     2   /* 4:3 pal (12:11 625-line) */
122    #define XVID_PAR_43_NTSC        3       /* 4:3 ntsc (10:11 525-line) */
123  /**  #define XVID_PAR_169_PAL        4       /* 16:9 pal (16:11 625-line) */
124   * \defgroup init_grp Initialization constants, structures and functions.  #define XVID_PAR_169_NTSC       5       /* 16:9 ntsc (40:33 525-line) */
125   *  #define XVID_PAR_EXT            15      /* extended par; use par_width, par_height */
  * This section describes all the constants, structures and functions used to  
  * initialize the XviD core library  
  *  
  * @{  
  */  
126    
127    /* frame type flags */
128    #define XVID_TYPE_VOL           -1              /* decoder only: vol was decoded */
129    #define XVID_TYPE_NOTHING       0               /* decoder only (encoder stats): nothing was decoded/encoded */
130    #define XVID_TYPE_AUTO          0               /* encoder: automatically determine coding type */
131    #define XVID_TYPE_IVOP          1               /* intra frame */
132    #define XVID_TYPE_PVOP          2               /* predicted frame */
133    #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */
134    #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */
135    
136  /*****************************************************************************  /*****************************************************************************
137   *  CPU flags   * xvid_global()
138   ****************************************************************************/   ****************************************************************************/
139    
140    /* cpu_flags definitions */
141    
142  /**  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */
143   * \defgroup cpu_grp Flags for XVID_INIT_PARAM.cpu_flags.  #define XVID_CPU_ASM        0x00000080  /* native assembly */
144   *  /* ARCH_IS_IA32 */
145   * This section describes all constants that show host cpu available features,  #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */
146   * and allow a client application to force usage of some cpu instructions sets.  #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */
147   * @{  #define XVID_CPU_SSE        0x00000004   /* sse      : pentium3, athlonXP */
148   */  #define XVID_CPU_SSE2       0x00000008   /* sse2     : pentium4, athlon64 */
149    #define XVID_CPU_3DNOW      0x00000010   /* 3dnow    : k6-2 */
150    #define XVID_CPU_3DNOWEXT   0x00000020   /* 3dnow-ext: athlon */
151    #define XVID_CPU_TSC        0x00000040   /* timestamp counter */
152    /* ARCH_IS_PPC */
153    #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */
154    
155    
156  /**  /* XVID_GBL_INIT param1 */
157   * \defgroup x86_grp x86 specific cpu flags  typedef struct {
158   * @{          int version;
159   */          int cpu_flags;                  /* [in:opt]     zero = autodetect cpu
160                                                                            XVID_CPU_FORCE|{cpu features} = force cpu features */
161    } xvid_gbl_init_t;
162    
 #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 (???) instruction set */  
 #define XVID_CPU_TSC      0x00000040 /**< has TimeStampCounter instruction */  
   
 /** @} */  
   
 /**  
  * \defgroup ia64_grp ia64 specific cpu flags.  
  * @{  
  */  
163    
164  #define XVID_CPU_IA64     0x00000080 /**< Forces ia64 optimized code usage  /* XVID_GBL_INFO param1 */
165                                        *  typedef struct {
166   * This flags allow client applications to force IA64 optimized functions.          int version;
167   * This feature is considered exeperimental and should be treated as is.          int actual_version;             /* [out]        returns the actual xvidcore version */
168   */          const char * build;             /* [out]        if !null, points to description of this xvid core build */
169            int cpu_flags;                  /* [out]        detected cpu features */
170            int num_threads;                /* [out]        detected number of cpus/threads */
171    } xvid_gbl_info_t;
172    
 /** @} */  
173    
174  /**  /* XVID_GBL_CONVERT param1 */
175   * \defgroup iniflags_grp Initialization commands.  typedef struct {
176   *          int version;
177   * @{          xvid_image_t input;     /* [in] input image & colorspace */
178   */          xvid_image_t output;    /* [in] output image & colorspace */
179            int width;                              /* [in] width */
180            int height;                             /* [in] height */
181            int interlacing;                /* [in] interlacing */
182    } xvid_gbl_convert_t;
183    
 #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.  
  */  
184    
185  #define XVID_CPU_FORCE    0x80000000 /**< Force input flags to be used  #define XVID_GBL_INIT           0       /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
186                                        *  #define XVID_GBL_INFO           1       /* return some info about xvidcore, and the host computer */
187   * When this flag is set, client application forces XviD to use other flags  #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
188   * set in cpu_flags. \b Use this at your own risk.  #define XVID_GBL_TEST           3       /* testing.. */
  */  
189    
190  /** @} */  int xvid_global(void *handle, int opt, void *param1, void *param2);
191    
 /** @} */  
192    
193  /*****************************************************************************  /*****************************************************************************
194   *  Initialization structures   * xvid_decore()
195   ****************************************************************************/   ****************************************************************************/
196    
197  /** Structure used in xvid_init function. */  #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */
198          typedef struct  #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */
199          {  #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */
                 int cpu_flags;   /**< [in/out]  
                                   *  
                                   * Filled with desired[in] or available[out]  
                                   * cpu instruction sets.  
                                   */  
                 int api_version; /**< [out]  
                                   *  
                                   * xvid_init will initialize this field with  
                                   * the API_VERSION used in this XviD core  
                                   * library  
                                   */  
                 int core_build;  /**< [out]  
                                   * \todo Still unused at the moment, what do we  
                                   * do with that ?  
                                   */  
         }  
         XVID_INIT_PARAM;  
200    
201  /*****************************************************************************  int xvid_decore(void *handle, int opt, void *param1, void *param2);
  *  Initialization entry point  
  ****************************************************************************/  
202    
203  /**  /* XVID_DEC_CREATE param 1
204   * \defgroup inientry_grp Initialization entry point.          image width & height may be specified here when the dimensions are
205   * @{          known in advance. */
206   */  typedef struct {
207            int version;
208            int width;                              /* [in:opt]     image width */
209            int height;                             /* [in:opt]     image width */
210            void * handle;                  /* [out]        decore context handle */
211    } xvid_dec_create_t;
212    
 /**  
  * \brief Initialization entry point.  
  *  
  * This is the XviD's initialization entry point, it is only used to initialize  
  * the XviD internal data (function pointers, vector length code tables,  
  * rgb2yuv lookup tables).  
  *  
  * \param handle Reserved for future use.  
  * \param opt Reserved for future use (set it to 0).  
  * \param param1 Used to pass an XVID_INIT_PARAM parameter.  
  * \param param2 Reserved for future use.  
  */  
         int xvid_init(void *handle,  
                       int opt,  
                       void *param1,  
                       void *param2);  
213    
214  /** @} */  /* XVID_DEC_DECODE param1 */
215    /* general flags */
216    #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */
217    #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */
218    
219  /** @} */  typedef struct {
220            int version;
221            int general;                    /* [in:opt] general flags */
222            void *bitstream;                /* [in] bitstream (read from)*/
223            int length;                             /* [in] bitstream length */
224            xvid_image_t output;    /* [in] output image (written to) */
225    }
226    xvid_dec_frame_t;
227    
 /*****************************************************************************  
  * Decoder constant  
  ****************************************************************************/  
228    
229  /**  /* XVID_DEC_DECODE param2 :: optional */
230   * \defgroup decoder_grp Decoder related functions and structures.  typedef struct
231   *  {
232   *  This part describes all the structures/functions from XviD's API needed for          int version;
233   *  decoding a MPEG4 compliant stream.          int type;                               /* [out]        output data type */
234   *  @{          union {
235   */                  struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
236                            int general;            /* [out]        flags */
237                            int time_base;          /* [out]        time base */
238                            int time_increment;     /* [out]        time increment */
239    
240  /**                          /* XXX: external deblocking stuff */
241   * \defgroup decframe_grp Flags for XVID_DEC_FRAME.general                          unsigned char * qscale; /* [out]        pointer to quantizer table */
242   *                          int qscale_stride;              /* [out]        quantizer scale stride */
  * Flags' description for the XVID_DEC_FRAME.general member.  
  *  
  * @{  
  */  
243    
244  /** Not used at the moment */                  } vop;
245  #define XVID_QUICK_DECODE               0x00000010                  struct {        /* XVID_TYPE_VOL */
246                            int general;            /* [out]        flags */
247                            int width;                      /* [out]        width */
248                            int height;                     /* [out]        height */
249                            int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */
250                            int par_width;          /* [out]        aspect ratio width */
251                            int par_height;         /* [out]        aspect ratio height */
252                    } vol;
253            } data;
254    } xvid_dec_stats_t;
255    
256    
 /**  
  * @}  
  */  
257    
258  /*****************************************************************************  /*****************************************************************************
259   * Decoder structures   * xvid_encore()
260   ****************************************************************************/   ****************************************************************************/
261    
262          typedef struct  /* Encoder options */
263          {  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
264                  int width;  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
265                  int height;  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
266                  void *handle;                                                                          0 means this frame should not be written (ie. encoder lag) */
         }  
         XVID_DEC_PARAM;  
267    
268    int xvid_encore(void *handle, int opt, void *param1, void *param2);
269    
270          typedef struct  
271    /* global flags  */
272    typedef enum
273          {          {
274                  int general;      XVID_PACKED                 = 0x00000001,   /* packed bitstream */
275                  void *bitstream;      XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
276                  int length;      XVID_EXTRASTATS_ENABLE  = 0x00000004
277    /*define XVID_VOL_AT_IVOP       0x00000008       write vol at every ivop: WIN32/divx compatibility */
278                  void *image;  /*define XVID_FORCE_VOL         0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
279                  int stride;  } xvid_global_t;
                 int colorspace;  
         }  
         XVID_DEC_FRAME;  
280    
281    
282          // This struct is used for per slice rendering  /* XVID_ENC_ENCODE param1 */
283          typedef struct  /* vol-based flags */
284          {  typedef enum {
285                  void *y,*u,*v;      XVID_MPEGQUANT          = 0x00000001,
286                  int stride_y, stride_u,stride_v;          XVID_H263QUANT          = 0x00000002,
287          } XVID_DEC_PICTURE;      XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
288        XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
289        XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
290        XVID_INTERLACING        = 0x00000400, /* enable interlaced encoding */
291    } xvid_vol_t;
292    
293    
294  /*****************************************************************************  /* vop-based flags */
295   * Decoder entry point  typedef enum {
296   ****************************************************************************/      XVID_DEBUG              = 0x00000001,
297        XVID_EXTRASTATS         = 0x00000002,
298        XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */
299        XVID_INTER4V            = 0x00000008,
300        XVID_LUMIMASKING        = 0x00000010,
301    
302  /**      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
303   * \defgroup  decops_grp Decoder operations      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
304   *                                                color input material chroma is ignored) */
305   * These are all the operations XviD's decoder can perform.      XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
306   *      XVID_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
307   * @{      XVID_DYNAMIC_BFRAMES    = 0x00000200,
  */  
308    
309  #define XVID_DEC_DECODE         0 /**< Decodes a frame          /* only valid for vol_flags|=XVID_INTERLACING */
310                                     *      XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
311   * This operation constant is used when client application wants to decode a      XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
  * frame. Client application must also fill XVID_DEC_FRAME appropriately.  
  */  
312    
313  #define XVID_DEC_CREATE         1 /**< Creates a decoder instance      /* only valid for vol_flags|=XVID_REDUCED_ENABLED */
314                                     *      XVID_REDUCED            = 0x00001000, /* reduced resolution vop */
315   * This operation constant is used by a client application in order to create  } xvid_vop_t;
  * a decoder instance. All instances are independant from each other, so  
  * client application can use safely various threads, each decoding a  
  * different MPEG4 bitstream.  
  */  
316    
 #define XVID_DEC_DESTROY        2 /**< Destroys a decoder instance  
                                    *  
  * This operation constant is used by the client application to destroy a  
  * previously created decoder instance.  
  */  
317    
318  /**  typedef enum {
319   * @}      PMV_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
320   */      PMV_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
321    
322  /**      PMV_HALFPELREFINE16     = 0x00020000,
323   * \defgroup  decentry_grp Decoder entry point      PMV_HALFPELREFINE8      = 0x02000000,
  *  
  * @{  
  */  
324    
325  /**      PMV_QUARTERPELREFINE16  = 0x00040000,
326   * \brief Decoder entry point.      PMV_QUARTERPELREFINE8   = 0x04000000,
  *  
  * 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  
  */  
327    
328          int xvid_decore(void *handle,      PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
                         int opt,  
                         void *param1,  
                         void *param2);  
329    
330  /** @} */      PMV_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
331        PMV_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */
332        PMV_USESQUARES8         = 0x80000000, /* use square for PMV_EXTSEARCH8 */
333    
334  /** @} */      PMV_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
335        PMV_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
336    
337  /**      /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */
338   * \defgroup encoder_grp Encoder related functions and structures.      HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
339   *      HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
340   * @{      QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
341   */      QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
342    
343  /*****************************************************************************      EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
344   * Encoder constants                                                    enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
345   ****************************************************************************/      CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
346    
347  /**      PMV_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
348   * \defgroup encgenflags_grp  Flags for XVID_ENC_FRAME.general      PMV_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
349   * @{      PMV_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
350   */      PMV_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
351    } xvid_motion_t;
352    
 #define XVID_VALID_FLAGS                0x80000000 /**< Reserved for future use */  
353    
354  #define XVID_CUSTOM_QMATRIX             0x00000004 /**< Use custom quantization matrices  /* XVID_ENC_CREATE param1 */
355                                                                                          *  typedef struct {
356   * This flag forces XviD to use custom matrices passed to encoder in          int version;
357   * XVID_ENC_FRAME structure (members quant_intra_matrix and quant_inter_matrix) */          int width;                              /* [in]         frame dimensions; width, pixel units */
358  #define XVID_H263QUANT                  0x00000010 /**< Use H263 quantization          int height;                             /* [in]         frame dimensions; height, pixel units */
                                                                                         *  
  * 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 */  
359    
360  /** @} */          int num_threads;                /* [in:opt]     number of threads */
361            int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
362    
363  /**          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */
  * \defgroup encmotionflags_grp  Flags for XVID_ENC_FRAME.motion  
  * @{  
  */  
364    
365  #define PMV_ADVANCEDDIAMOND8    0x00004000/**< Uses advanced diamonds for 8x8 blocks  /* --- vol-based stuff; included here for conveinience */
366                                                                                          *          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
367  * Same as its 16x16 companion option          int fbase;                              /* [in] framerate base
368  */                                                                                  frame_duration = fincr/fbase seconds*/
369  #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 */  
370    
 /** @} */  
371    
372  /*****************************************************************************  /* ---vop-based; included here for conveienience */
373   * Encoder structures          int max_key_interval;   /* [in:opt] the maximum interval between key frames */
374   ****************************************************************************/                                                                                  /*XXX: maybe call it gop_size? */
375    
376          /** Structure used for encoder instance creation */          int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
         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;  
377    
378          typedef struct          int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
379          {          int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
                 int x;  
                 int y;  
         }  
         VECTOR;  
380    
381          typedef struct  /* ^^^ -------------------------------------------------------------------------*/
         {  
                 int mode;                               /* macroblock mode */  
                 VECTOR mvs[4];  
         }  
         MVBLOCKHINT;  
382    
383          typedef struct          void *handle;                   /* [out] encoder instance handle */
         {  
                 int intra;                              /* frame intra choice */  
                 int fcode;                              /* frame fcode */  
                 MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */  
384          }          }
385          MVFRAMEHINT;  xvid_enc_create_t;
386    
         typedef struct  
         {  
                 int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */  
387    
388                  MVFRAMEHINT mvhint;  typedef struct {
389                  void *hintstream;               /* compressed hint buffer */          int version;
390                  int hintlength;                 /* length of buffer (bytes) */          int type;                               /* [in] rate control type: XVID_RC_xxx */
         }  
         HINTINFO;  
391    
392          /** Structure used to pass a frame to the encoder */          /* common stuff */
393          typedef struct          int min_iquant;         /* [in:opt] ivop quantizer upper/lower limit */
394          {          int max_iquant;         /* [in:opt] */
395                  int general;                       /**< [in]          int min_pquant;         /* [in:opt] psvop quantizer upper/lower limit */
396                                                                                          *          int max_pquant;         /* [in:opt]  */
397                                                                                          * Sets general options flag (See \ref encgenflags_grp) */          int min_bquant;         /* [in:opt] bvop quantizer upper/lower limit */
398                  int motion;                        /**< [in]          int max_bquant;         /* [in:opt] */
                                                                                         *  
                                                                                         * 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 */  
399    
400          }          union {
401          XVID_ENC_FRAME;                  struct {        /* XVID_RC_FQUANT */
402                            float quant;                            /* [in] quantizer */
403                    } fquant;
404                    struct {        /* XVID_RC_CBR */
405                            int bitrate;                            /* [in] the bitrate of the target encoded stream, in bits/second */
406                            int reaction_delay_factor;      /* [in] how fast the rate control reacts - lower values are faster */
407                            int averaging_period;           /* [in] */
408                            int buffer;                                     /* [in] */
409                    } cbr;
410            } data;
411    } xvid_enc_rc_t;
412    
413    
         /** Encoding statistics */  
         typedef struct  
         {  
                 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;  
414    
415    #define XVID_KEYFRAME   0x00000001
416    
417  /*****************************************************************************  typedef struct {
418   * Encoder entry point          int version;
  ****************************************************************************/  
419    
420  /**  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
421   * \defgroup  encops_grp Encoder operations                  changes here until the next VOL (keyframe). */
422   *          xvid_vol_t vol_flags;                   /* [in] vol flags */
423   * These are all the operations XviD's encoder can perform.          unsigned char *
424   *                  quant_intra_matrix;     /* [in:opt] custom intra qmatrix */
425   * @{          unsigned char *
426   */                  quant_inter_matrix;     /* [in:opt] custom inter qmatrix */
427    
428  #define XVID_ENC_ENCODE         0 /**< Encodes a frame          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
429                                     *          int par_width;                  /* [in:opt] aspect ratio width */
430   * This operation constant is used when client application wants to encode a          int par_height;                 /* [in:opt] aspect ratio height */
431   * frame. Client application must also fill XVID_ENC_FRAME appropriately.  /* ^^^----------------------------------------------------------------------------------*/
  */  
432    
433  #define XVID_ENC_CREATE         1 /**< Creates a decoder instance          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
434                                     *          xvid_motion_t motion;                           /* [in] ME options */
  * 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.  
  */  
435    
436  #define XVID_ENC_DESTROY        2 /**< Destroys a encoder instance          xvid_image_t input;     /* [in] input image (read from) */
                                    *  
  * This operation constant is used by the client application to destroy a  
  * previously created encoder instance.  
  */  
437    
438            int type;                               /* [in:opt] coding type */
439            int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
440            int bquant;                             /* [in:opt] bframe quantizer; if <=0, automatic*/
441    
442  /** @} */          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
443            int length;                             /* [in:opt] bitstream length (bytes) */
444    
445  /**          int out_flags;                          /* [out] bitstream output flags */
446   * \defgroup  encentry_grp Encoder entry point  }
447   *  xvid_enc_frame_t;
  * @{  
  */  
448    
449  /**  
450   * \brief Encoder entry point.  /* XVID_ENC_ENCODE param2 (optional)
451   *          xvid_enc_stats_t describes individual frame details
452   * This is the XviD's encoder entry point. The possible operations are  
453   * described in the \ref encops_grp section.          coding_type==XVID_TYPE_NOTHING if the stats are not given
  *  
  * \param handle Todo  
  * \param opt Todo  
  * \param param1 Todo  
  * \param param2 Todo  
454   */   */
455          int xvid_encore(void *handle,  typedef struct {
456                                          int opt,          int version;
457                                          void *param1,  
458                                          void *param2);          /* encoding parameters */
459            int type;                                       /* [out] coding type */
460            int quant;                                      /* [out] frame quantizer */
461            xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */
462            int vop_flags;                          /* [out] vop flags (see above) */
463            /* bitrate */
464            int length;                                     /* [out] frame length */
465    
466  /** @} */          int hlength;                            /* [out] header length (bytes) */
467            int kblks, mblks, ublks;        /* [out] */
468    
469  /** @} */      int sse_y, sse_u, sse_v;
470    }
471    xvid_enc_stats_t;
472    
473  #ifdef __cplusplus  #ifdef __cplusplus
474  }  }

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

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