[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.10, Thu Jun 13 12:42:18 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 file is part of XviD, a free MPEG-4 video encoder/decoder
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
10  *  the Free Software Foundation ; either version 2 of the License, or  *  the Free Software Foundation ; either version 2 of the License, or
# Line 17  Line 19 
19  *  along with this program ; if not, write to the Free Software  *  along with this program ; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21  *  *
 *****************************************************************************/  
 /*****************************************************************************  
 *  
 *  History  
 *  
 *  - 2002/06/13 Added legal header, ANSI C comment style (only for this header  
 *               as it can be included in a ANSI C project).  
 *  
 *               ToDo ? : when BFRAMES is defined, the API_VERSION should not  
 *                        be the same (3.0 ?)  
 *  
22  *  $Id$  *  $Id$
23  *  *
24  *****************************************************************************/   ****************************************************************************/
   
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
29  #ifdef __cplusplus  #ifdef __cplusplus
30  *  $Id$  extern "C" {
31  #endif  #endif
32    
33  /*****************************************************************************  /*****************************************************************************
34   * Global constants   * versioning
35   ****************************************************************************/   ****************************************************************************/
36    
37  /* API Version : 2.1 */  /* versioning
38  #define API_VERSION ((2 << 16) | (1))          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
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            */
49    
50  /* Error codes */  #define XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )
51  #define XVID_ERR_FAIL           -1  #define XVID_MAJOR(a)                           ( ((a)>>16) & 0xff )
52  #define XVID_ERR_OK                     0  #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))
53  #define XVID_ERR_MEMORY         1  #define XVID_PATCH(c)                           ( (c) & 0xff )
54  #define XVID_ERR_FORMAT         2  
55    #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)
56    #define XVID_UNSTABLE
57  /* Colorspaces */  
58  #define XVID_CSP_RGB24  0  /* Bitstream Version
59  #define XVID_CSP_YV12   1   * this will be writen into the bitstream to allow easy detection of xvid
60  #define XVID_CSP_YUY2   2   * encoder bugs in the decoder, without this it might not possible to
61  #define XVID_CSP_UYVY   3   * automatically distinquish between a file which has been encoded with an
62  #define XVID_CSP_I420   4   * old & buggy XVID from a file which has been encoded with a bugfree version
63  #define XVID_CSP_RGB555 10   * see the infamous interlacing bug ...
64  #define XVID_CSP_RGB565 11   *
65  #define XVID_CSP_USER   12   * this MUST be increased if an encoder bug is fixed, increasing it too often
66  #define XVID_CSP_EXTERN      1004  // per slice rendering   * doesnt hurt but not increasing it could cause difficulty for decoders in the
67  #define XVID_CSP_YVYU   1002   * future
68  #define XVID_CSP_RGB32  1000   */
69  #define XVID_CSP_NULL   9999  #define XVID_BS_VERSION "0009"
   
 #define XVID_CSP_VFLIP  0x80000000      // flip mask  
70    
71    
72  /*****************************************************************************  /*****************************************************************************
73     * error codes
74   ****************************************************************************/   ****************************************************************************/
75    
76  /* CPU flags for XVID_INIT_PARAM.cpu_flags */      /*  all functions return values <0 indicate error */
77    
78    #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    
 #define XVID_CPU_MMX            0x00000001  
 #define XVID_CPU_MMXEXT         0x00000002  
 #define XVID_CPU_SSE            0x00000004  
 #define XVID_CPU_SSE2           0x00000008  
 #define XVID_CPU_3DNOW          0x00000010  
 #define XVID_CPU_3DNOWEXT       0x00000020  
   
 #define XVID_CPU_TSC            0x00000040  
 #define XVID_CPU_IA64           0x00000080  
   
 #define XVID_CPU_CHKONLY        0x40000000              /* check cpu only; dont init globals */  
 #define XVID_CPU_FORCE          0x80000000  
   
   
  *  Initialization structures  
                 int cpu_flags;  
                 int api_version;  
                 int core_build;  
         }  
         XVID_INIT_PARAM;  
85    
86  /*****************************************************************************  /*****************************************************************************
87   *  Initialization entry point   * xvid_image_t
88   ****************************************************************************/   ****************************************************************************/
89    
90          int xvid_init(void *handle,  /* colorspace values */
                                   int opt,  
                                   void *param1,  
                                   void *param2);  
91    
92    #define XVID_CSP_USER           0       /* 4:2:0 planar */
93    #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    /* xvid_image_t
110            for non-planar colorspaces use only plane[0] and stride[0]
111            four plane reserved for alpha*/
112    typedef struct {
113            int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
114            void * plane[4];                /* [in] image plane ptrs */
115            int stride[4];                  /* [in] image stride; "bytes per row"*/
116    } xvid_image_t;
117    
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    #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 */
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   * Decoder constants   * xvid_global()
138   ****************************************************************************/   ****************************************************************************/
139    
140  /* Flags for XVID_DEC_FRAME.general */  /* cpu_flags definitions */
141  #define XVID_QUICK_DECODE               0x00000010  
142    #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */
143    #define XVID_CPU_ASM        0x00000080  /* native assembly */
144    /* ARCH_IS_IA32 */
145    #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */
146    #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    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    
163    
164    /* XVID_GBL_INFO param1 */
165    typedef struct {
166            int version;
167            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    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    
184    
185    #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    #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
188    #define XVID_GBL_TEST           3       /* testing.. */
189    
190    int xvid_global(void *handle, int opt, void *param1, void *param2);
191    
192    
193  /*****************************************************************************  /*****************************************************************************
194   * Decoder structures   * xvid_decore()
195   ****************************************************************************/   ****************************************************************************/
196    
197          typedef struct  #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */
198          {  #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */
199                  int width;  #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */
200                  int height;  
201                  void *handle;  int xvid_decore(void *handle, int opt, void *param1, void *param2);
202    
203    /* XVID_DEC_CREATE param 1
204            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    
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_PARAM;  xvid_dec_frame_t;
227    
228    
229    /* XVID_DEC_DECODE param2 :: optional */
230          typedef struct          typedef struct
231          {          {
232                  int general;          int version;
233                  void *bitstream;          int type;                               /* [out]        output data type */
234                  int length;          union {
235                    struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
236                  void *image;                          int general;            /* [out]        flags */
237                  int stride;                          int time_base;          /* [out]        time base */
238                  int colorspace;                          int time_increment;     /* [out]        time increment */
239          }  
240          XVID_DEC_FRAME;                          /* XXX: external deblocking stuff */
241                            unsigned char * qscale; /* [out]        pointer to quantizer table */
242                            int qscale_stride;              /* [out]        quantizer scale stride */
243    
244                    } vop;
245                    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    
         // This struct is used for per slice rendering  
         typedef struct  
         {  
                 void *y,*u,*v;  
                 int stride_y, stride_u,stride_v;  
         } XVID_DEC_PICTURE;  
   
 #define XVID_DEC_DESTROY        2  
   
         int xvid_decore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
256    
257    
258  /*****************************************************************************  /*****************************************************************************
259   * Encoder constants   * xvid_encore()
260   ****************************************************************************/   ****************************************************************************/
261    
262  /* Flags for XVID_ENC_PARAM.global */  /* Encoder options */
263  #define XVID_GLOBAL_PACKED              0x00000001      /* packed bitstream */  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
264  #define XVID_GLOBAL_DX50BVOP    0x00000002      /* dx50 bvop compatibility */  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
265  #define XVID_GLOBAL_DEBUG               0x00000004      /* print debug info on each frame */  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
266                                                                            0 means this frame should not be written (ie. encoder lag) */
 /* Flags for XVID_ENC_FRAME.general */  
 #define XVID_VALID_FLAGS                0x80000000  
   
 #define XVID_CUSTOM_QMATRIX             0x00000004      /* use custom quant matrix */  
 #define XVID_LATEINTRA                  0x00000200  
   
 #define XVID_INTERLACING                0x00000400      /* enable interlaced encoding */  
 #define XVID_TOPFIELDFIRST              0x00000800      /* set top-field-first flag  */  
 #define XVID_ALTERNATESCAN              0x00001000      /* set alternate vertical scan flag */  
   
 #define XVID_HINTEDME_GET               0x00002000      /* receive mv hint data from core (1st pass) */  
 #define XVID_HINTEDME_SET               0x00004000      /* send mv hint data to core (2nd pass) */  
   
 #define XVID_INTER4V                    0x00008000  
   
 #define XVID_ME_ZERO                    0x00010000  
 #define XVID_ME_LOGARITHMIC             0x00020000  
 #define XVID_ME_FULLSEARCH              0x00040000  
 #define XVID_ME_PMVFAST                 0x00080000  
 #define XVID_ME_EPZS                    0x00100000  
   
   
 #define XVID_GREYSCALE                  0x01000000      /* enable greyscale only mode (even for */  
 #define XVID_GRAYSCALE                  0x01000000      /* color input material chroma is ignored) */  
   
   
 /* Flags for XVID_ENC_FRAME.motion */  
 #define PMV_ADVANCEDDIAMOND8    0x00004000  
 #define PMV_ADVANCEDDIAMOND16   0x00008000  
 #define PMV_EARLYSTOP16                 0x00080000  
 #define PMV_QUICKSTOP16                 0x00100000      /* like early, but without any more refinement */  
 #define PMV_UNRESTRICTED16      0x00200000      /* unrestricted ME, not implemented */  
 #define PMV_OVERLAPPING16       0x00400000      /* overlapping ME, not implemented */  
 #define PMV_USESQUARES16                0x00800000  
   
 #define PMV_HALFPELDIAMOND8     0x01000000  
 #define PMV_HALFPELREFINE8              0x02000000  
 #define PMV_EXTSEARCH8                  0x04000000      /* extend PMV by more searches */  
 #define PMV_EARLYSTOP8                  0x08000000  
 #define PMV_QUICKSTOP8                  0x10000000      /* like early, but without any more refinement */  
 #define PMV_UNRESTRICTED8       0x20000000      /* unrestricted ME, not implemented */  
 #define PMV_OVERLAPPING8                0x40000000      /* overlapping ME, not implemented */  
 #define PMV_USESQUARES8                 0x80000000  
267    
268    int xvid_encore(void *handle, int opt, void *param1, void *param2);
269    
 /*****************************************************************************  
  * Encoder structures  
  ****************************************************************************/  
270    
271          typedef struct  /* global flags  */
272    typedef enum
273          {          {
274                  int width, height;      XVID_PACKED                 = 0x00000001,   /* packed bitstream */
275                  int fincr, fbase;               /* frame increment, fbase. each frame = "fincr/fbase" seconds */      XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
276                  int rc_bitrate;                 /* the bitrate of the target encoded stream, in bits/second */      XVID_EXTRASTATS_ENABLE  = 0x00000004
277                  int rc_reaction_delay_factor;   /* how fast the rate control reacts - lower values are faster */  /*define XVID_VOL_AT_IVOP       0x00000008       write vol at every ivop: WIN32/divx compatibility */
278                  int rc_averaging_period;        /* as above */  /*define XVID_FORCE_VOL         0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
279                  int rc_buffer;                  /* as above */  } xvid_global_t;
                 int max_quantizer;              /* the upper limit of the quantizer */  
                 int min_quantizer;              /* the lower limit of the quantizer */  
                 int max_key_interval;   /* the maximum interval between key frames */  
 #ifdef _SMP  
                 int num_threads;                /* number of threads */  
 #endif  
 #ifdef BFRAMES  
                 int global;                             /* global/debug options */  
                 int max_bframes;                /* max sequential bframes (0=disable bframes) */  
                 int bquant_ratio;               /* bframe quantizer multipier (percentage).  
                                                                  * used only when bquant < 1  
                                                                  * eg. 200 = x2 multiplier  
 #endif  
         }  
         XVID_ENC_PARAM;  
280    
         typedef struct  
         {  
                 int x;  
         }  
         VECTOR;  
281    
282          typedef struct  /* XVID_ENC_ENCODE param1 */
283          {  /* vol-based flags */
284                  int mode;                               /* macroblock mode */  typedef enum {
285                  VECTOR mvs[4];      XVID_MPEGQUANT          = 0x00000001,
286          }          XVID_H263QUANT          = 0x00000002,
287          MVBLOCKHINT;      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    
         typedef struct  
         {  
                 int intra;                              /* frame intra choice */  
                 int fcode;                              /* frame fcode */  
                 MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */  
         }  
         MVFRAMEHINT;  
293    
294          typedef struct  /* vop-based flags */
295          {  typedef enum {
296                  int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */      XVID_DEBUG              = 0x00000001,
297        XVID_EXTRASTATS         = 0x00000002,
298        XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */
299        XVID_INTER4V            = 0x00000008,
300        XVID_LUMIMASKING        = 0x00000010,
301    
302                  MVFRAMEHINT mvhint;      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
303                  void *hintstream;               /* compressed hint buffer */      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
304                  int hintlength;                 /* length of buffer (bytes) */                                                color input material chroma is ignored) */
305          }      XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
306          HINTINFO;      XVID_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
307        XVID_DYNAMIC_BFRAMES    = 0x00000200,
308    
309          typedef struct          /* only valid for vol_flags|=XVID_INTERLACING */
310          {      XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
311                  int general;                    /* [in] general options */      XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
                 int motion;                             /* [in] ME options */  
                 void *bitstream;                /* [in] bitstream ptr */  
                 int length;                             /* [out] bitstream length (bytes) */  
   
                 void *image;                    /* [in] image ptr */  
                 int colorspace;                 /* [in] source colorspace */  
   
                 unsigned char *quant_intra_matrix;      // [in] custom intra qmatrix */  
                 unsigned char *quant_inter_matrix;      // [in] custom inter qmatrix */  
                 int quant;                              /* [in] frame quantizer (vbr) */  
                 int intra;                              /* [in] force intra frame (vbr only)  
                                                                  * [out] intra state  
                                                                  */  
                 HINTINFO hint;                  /* [in/out] mv hint information */  
312    
313  #ifdef BFRAMES      /* only valid for vol_flags|=XVID_REDUCED_ENABLED */
314                  int bquant;                             /* [in] bframe quantizer */      XVID_REDUCED            = 0x00001000, /* reduced resolution vop */
315  #endif  } xvid_vop_t;
316    
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        PMV_HALFPELREFINE8      = 0x02000000,
324    
325        PMV_QUARTERPELREFINE16  = 0x00040000,
326        PMV_QUARTERPELREFINE8   = 0x04000000,
327    
328        PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
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        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                                                      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        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    
353    
354    /* XVID_ENC_CREATE param1 */
355    typedef struct {
356            int version;
357            int width;                              /* [in]         frame dimensions; width, pixel units */
358            int height;                             /* [in]         frame dimensions; height, pixel units */
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 */
364    
365    /* --- vol-based stuff; included here for conveinience */
366            int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
367            int fbase;                              /* [in] framerate base
368                                                                                    frame_duration = fincr/fbase seconds*/
369    /* ^^^---------------------------------------------- */
370    
371    
372    /* ---vop-based; included here for conveienience */
373            int max_key_interval;   /* [in:opt] the maximum interval between key frames */
374                                                                                    /*XXX: maybe call it gop_size? */
375    
376            int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
377    
378            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 */
380    
381    /* ^^^ -------------------------------------------------------------------------*/
382    
383            void *handle;                   /* [out] encoder instance handle */
384          }          }
385          XVID_ENC_FRAME;  xvid_enc_create_t;
386    
387    
388          typedef struct  typedef struct {
389          {          int version;
390                  int quant;                              /* [out] frame quantizer */          int type;                               /* [in] rate control type: XVID_RC_xxx */
391                  int input_consumed;             /* [out] */  
392                  int hlength;                    /* [out] header length (bytes) */          /* common stuff */
393                  int kblks, mblks, ublks;        /* [out] */          int min_iquant;         /* [in:opt] ivop quantizer upper/lower limit */
394            int max_iquant;         /* [in:opt] */
395            int min_pquant;         /* [in:opt] psvop quantizer upper/lower limit */
396            int max_pquant;         /* [in:opt]  */
397            int min_bquant;         /* [in:opt] bvop quantizer upper/lower limit */
398            int max_bquant;         /* [in:opt] */
399    
400            union {
401                    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    
414    
415    #define XVID_KEYFRAME   0x00000001
416    
417    typedef struct {
418            int version;
419    
420    /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
421                    changes here until the next VOL (keyframe). */
422            xvid_vol_t vol_flags;                   /* [in] vol flags */
423            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            int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
429            int par_width;                  /* [in:opt] aspect ratio width */
430            int par_height;                 /* [in:opt] aspect ratio height */
431    /* ^^^----------------------------------------------------------------------------------*/
432    
433            xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
434            xvid_motion_t motion;                           /* [in] ME options */
435    
436            xvid_image_t input;     /* [in] input image (read from) */
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          }          }
447          XVID_ENC_STATS;  xvid_enc_frame_t;
448    
449    
450  /*****************************************************************************  /* XVID_ENC_ENCODE param2 (optional)
451   * Encoder entry point          xvid_enc_stats_t describes individual frame details
  ****************************************************************************/  
452    
453  /* Encoder options */          coding_type==XVID_TYPE_NOTHING if the stats are not given
454  #define XVID_ENC_ENCODE         0  */
455  #define XVID_ENC_CREATE         1  typedef struct {
456  #define XVID_ENC_DESTROY        2          int version;
   
         int xvid_encore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
457    
458            /* 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.10  
changed lines
  Added in v.1.27.2.3

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