[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.25, Sat Feb 15 15:22:17 2003 UTC revision 1.27.2.9, Sun Mar 16 12:04:14 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    
30  #ifdef __cplusplus  #ifdef __cplusplus
31  extern "C" {  extern "C" {
32  #endif  #endif
33    
34  /*****************************************************************************  /*****************************************************************************
35   * Global constants   * versioning
36   ****************************************************************************/   ****************************************************************************/
37    
38  /* API Version : 2.1 */  /* versioning
39  #define API_VERSION ((2 << 16) | (1))          version takes the form "$major.$minor.$patch"
40  #define XVID_API_UNSTABLE          $patch is incremented when there is no api change
41            $minor is incremented when the api is changed, but remains backwards compatible
42            $major is incremented when the api is changed significantly
43    
44            when initialising an xvid structure, you must always zero it, and set the version field.
45                    memset(&struct,0,sizeof(struct));
46                    struct.version = XVID_VERSION;
47    
48            XVID_UNSTABLE is defined only during development.
49            */
50    
51    #define XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )
52    #define XVID_MAJOR(a)                           ( ((a)>>16) & 0xff )
53    #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))
54    #define XVID_PATCH(c)                           ( (c) & 0xff )
55    
56    #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)
57    #define XVID_UNSTABLE
58    
59  /* Bitstream Version  /* Bitstream Version
60   * this will be writen into the bitstream to allow easy detection of xvid   * this will be writen into the bitstream to allow easy detection of xvid
# Line 62  Line 70 
70  #define XVID_BS_VERSION "0009"  #define XVID_BS_VERSION "0009"
71    
72    
73  /* Error codes */  /*****************************************************************************
74  #define XVID_ERR_FAIL           -1   * error codes
75  #define XVID_ERR_OK                     0   ****************************************************************************/
 #define XVID_ERR_MEMORY         1  
 #define XVID_ERR_FORMAT         2  
   
   
 /* Colorspaces */  
 #define XVID_CSP_RGB24  0               /* [b|g|r] */  
 #define XVID_CSP_YV12   1  
 #define XVID_CSP_YUY2   2  
 #define XVID_CSP_UYVY   3  
 #define XVID_CSP_I420   4  
 #define XVID_CSP_RGB555 10  
 #define XVID_CSP_RGB565 11  
 #define XVID_CSP_USER   12  
 #define XVID_CSP_EXTERN      1004  // per slice rendering  
 #define XVID_CSP_YVYU   1002  
 #define XVID_CSP_RGB32  1000    /* [b|g|r|a] */  
 #define XVID_CSP_ABGR   1006    /* [a|b|g|r] */  
 #define XVID_CSP_RGBA   1005    /* [r|g|b|a] */  
76    
77        /*  all functions return values <0 indicate error */
78    
79    #define XVID_ERR_FAIL           -1              /* general fault */
80    #define XVID_ERR_MEMORY     -2          /* memory allocation error */
81    #define XVID_ERR_FORMAT     -3          /* file format error */
82    #define XVID_ERR_VERSION        -4              /* structure version not supported */
83    #define XVID_ERR_END            -5              /* encoder only; end of stream reached */
84    
 #define XVID_CSP_NULL   9999  
85    
 #define XVID_CSP_VFLIP  0x80000000      // flip mask  
86    
87    /*****************************************************************************
88     * xvid_image_t
89     ****************************************************************************/
90    
91    /* colorspace values */
92    
93    #define XVID_CSP_USER           0       /* 4:2:0 planar */
94    #define XVID_CSP_I420           1       /* 4:2:0 packed(planar win32) */
95    #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */
96    #define XVID_CSP_YUY2           3       /* 4:2:2 packed */
97    #define XVID_CSP_UYVY           4       /* 4:2:2 packed */
98    #define XVID_CSP_YVYU           5       /* 4:2:2 packed */
99    #define XVID_CSP_BGRA           6       /* 32-bit bgra packed */
100    #define XVID_CSP_ABGR           7       /* 32-bit abgr packed */
101    #define XVID_CSP_RGBA           8       /* 32-bit rgba packed */
102    #define XVID_CSP_BGR            9       /* 32-bit bgr packed */
103    #define XVID_CSP_RGB555     10  /* 16-bit rgb555 packed */
104    #define XVID_CSP_RGB565     11  /* 16-bit rgb565 packed */
105    #define XVID_CSP_SLICE          12      /* decoder only: 4:2:0 planar, per slice rendering */
106    #define XVID_CSP_INTERNAL       13      /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
107    #define XVID_CSP_NULL           14      /* decoder only: dont output anything */
108    #define XVID_CSP_VFLIP  0x80000000      /* vertical flip mask */
109    
110    /* xvid_image_t
111            for non-planar colorspaces use only plane[0] and stride[0]
112            four plane reserved for alpha*/
113    typedef struct {
114            int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
115            void * plane[4];                /* [in] image plane ptrs */
116            int stride[4];                  /* [in] image stride; "bytes per row"*/
117    } xvid_image_t;
118    
119    
120    /* aspect ratios */
121    #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */
122    #define XVID_PAR_43_PAL     2   /* 4:3 pal (12:11 625-line) */
123    #define XVID_PAR_43_NTSC        3       /* 4:3 ntsc (10:11 525-line) */
124    #define XVID_PAR_169_PAL        4       /* 16:9 pal (16:11 625-line) */
125    #define XVID_PAR_169_NTSC       5       /* 16:9 ntsc (40:33 525-line) */
126    #define XVID_PAR_EXT            15      /* extended par; use par_width, par_height */
127    
128    /* frame type flags */
129    #define XVID_TYPE_VOL           -1              /* decoder only: vol was decoded */
130    #define XVID_TYPE_NOTHING       0               /* decoder only (encoder stats): nothing was decoded/encoded */
131    #define XVID_TYPE_AUTO          0               /* encoder: automatically determine coding type */
132    #define XVID_TYPE_IVOP          1               /* intra frame */
133    #define XVID_TYPE_PVOP          2               /* predicted frame */
134    #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */
135    #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */
136    
137  /*****************************************************************************  /*****************************************************************************
138   *  Initialization constants   * xvid_global()
139   ****************************************************************************/   ****************************************************************************/
140    
141  /* CPU flags for XVID_INIT_PARAM.cpu_flags */  /* cpu_flags definitions */
 #define XVID_CPU_FORCE          0x80000000  
 #define XVID_CPU_CHKONLY        0x40000000              /* check cpu only; dont init globals */  
142    
143    #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */
144  #define XVID_CPU_ASM            0x00000080              /* native assembly */  #define XVID_CPU_ASM            0x00000080              /* native assembly */
145  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
146  #define XVID_CPU_MMX            0x00000001              /* mmx: pentiumMMX,k6 */  #define XVID_CPU_MMX            0x00000001              /* mmx: pentiumMMX,k6 */
147  #define XVID_CPU_MMXEXT         0x00000002              /* mmxx-ext: pentium2,athlon */  #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */
148  #define XVID_CPU_SSE            0x00000004              /* sse: pentium3,athlonXP */  #define XVID_CPU_SSE            0x00000004              /* sse: pentium3,athlonXP */
149  #define XVID_CPU_SSE2           0x00000008              /* sse2: pentium4,athlon64 */  #define XVID_CPU_SSE2           0x00000008              /* sse2: pentium4,athlon64 */
150  #define XVID_CPU_3DNOW          0x00000010              /* 3dnow: k6-2 */  #define XVID_CPU_3DNOW          0x00000010              /* 3dnow: k6-2 */
151  #define XVID_CPU_3DNOWEXT       0x00000020              /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT       0x00000020              /* 3dnow-ext: athlon */
152  #define XVID_CPU_TSC            0x00000040              /* timestamp counter */  #define XVID_CPU_TSC            0x00000040              /* timestamp counter */
 /* ARCH_IS_IA64 */  
 #define XVID_CPU_IA64           XVID_CPU_ASM    /* defined for backward compatibility */  
153  /* ARCH_IS_PPC */  /* ARCH_IS_PPC */
154  #define XVID_CPU_ALTIVEC        0x00000001              /* altivec */  #define XVID_CPU_ALTIVEC        0x00000001              /* altivec */
155    
156    
157          typedef struct  /* XVID_GBL_INIT param1 */
158          {  typedef struct {
159                  int colorspace;          int version;
160                  void * y;          int cpu_flags;                  /* [in:opt]     zero = autodetect cpu
161                  void * u;                                                                          XVID_CPU_FORCE|{cpu features} = force cpu features */
162                  void * v;  } xvid_gbl_init_t;
                 int y_stride;  
                 int uv_stride;  
         } XVID_IMAGE;           /* from yv12 */  
   
 #define XVID_INIT_INIT          0  
 #define XVID_INIT_CONVERT       1  
 #define XVID_INIT_TEST          2  
163    
 /*****************************************************************************  
  *  Initialization structures  
  ****************************************************************************/  
164    
165          typedef struct  /* XVID_GBL_INFO param1 */
166          {  typedef struct {
167                  int cpu_flags;          int version;
168                  int api_version;          int actual_version;             /* [out]        returns the actual xvidcore version */
169                  int core_build;          const char * build;             /* [out]        if !null, points to description of this xvid core build */
170          }          int cpu_flags;                  /* [out]        detected cpu features */
171          XVID_INIT_PARAM;          int num_threads;                /* [out]        detected number of cpus/threads */
172    } xvid_gbl_info_t;
173    
         typedef struct  
         {  
                 XVID_IMAGE input;  
                 XVID_IMAGE output;  
                 int width;  
                 int height;  
                 int interlacing;  
         } XVID_INIT_CONVERTINFO;  
174    
175  /*****************************************************************************  /* XVID_GBL_CONVERT param1 */
176   *  Initialization entry point  typedef struct {
177   ****************************************************************************/          int version;
178            xvid_image_t input;     /* [in] input image & colorspace */
179            xvid_image_t output;    /* [in] output image & colorspace */
180            int width;                              /* [in] width */
181            int height;                             /* [in] height */
182            int interlacing;                /* [in] interlacing */
183    } xvid_gbl_convert_t;
184    
         int xvid_init(void *handle,  
                                   int opt,  
                                   void *param1,  
                                   void *param2);  
185    
186    #define XVID_GBL_INIT           0       /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
187    #define XVID_GBL_INFO           1       /* return some info about xvidcore, and the host computer */
188    #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
189    #define XVID_GBL_TEST           3       /* testing.. */
190    
191  /*****************************************************************************  int xvid_global(void *handle, int opt, void *param1, void *param2);
  * Decoder constants  
  ****************************************************************************/  
192    
 /* Flags for XVID_DEC_FRAME.general */  
 #define XVID_DEC_LOWDELAY               0x00000001      /* decode lowdelay mode (ie. video-for-windows) */  
 #define XVID_DEC_DEBLOCKY               0x00000002      /* luma deblocking */  
 #define XVID_DEC_DEBLOCKUV              0x00000008      /* chroma deblocking */  
 #define XVID_DEC_DISCONTINUITY  0x00000004      /* indicates break in stream; instructs  
                                                                                         decoder to ignore any previous reference frames */  
 #define XVID_QUICK_DECODE               0x00000010  
193    
194  /*****************************************************************************  /*****************************************************************************
195   * Decoder structures   * xvid_decore()
196   ****************************************************************************/   ****************************************************************************/
197    
198          typedef struct  #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */
199          {  #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */
200                  int width;  #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */
201                  int height;  
202                  void *handle;  int xvid_decore(void *handle, int opt, void *param1, void *param2);
203          }  
204          XVID_DEC_PARAM;  /* XVID_DEC_CREATE param 1
205            image width & height may be specified here when the dimensions are
206            known in advance. */
207  #define XVID_DEC_VOP    0  typedef struct {
208  #define XVID_DEC_VOL    1          int version;
209  #define XVID_DEC_NOTHING        2       /* nothing was decoded */          int width;                              /* [in:opt]     image width */
210            int height;                             /* [in:opt]     image width */
211          typedef struct          void * handle;                  /* [out]        decore context handle */
212          {  } xvid_dec_create_t;
213                  int notify;                     /* [out]        output 'mode' */  
214                  union  
215                  {  /* XVID_DEC_DECODE param1 */
216                          struct  /* XVID_DEC_VOP */  /* general flags */
217                          {  #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */
218    #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */
219    
220    typedef struct {
221            int version;
222            int general;                    /* [in:opt] general flags */
223            void *bitstream;                /* [in] bitstream (read from)*/
224            int length;                             /* [in] bitstream length */
225            xvid_image_t output;    /* [in] output image (written to) */
226    }
227    xvid_dec_frame_t;
228    
229    
230    /* XVID_DEC_DECODE param2 :: optional */
231    typedef struct
232    {
233            int version;
234            int type;                               /* [out]        output data type */
235            union {
236                    struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
237                            int general;            /* [out]        flags */
238                                  int time_base;          /* [out]        time base */                                  int time_base;          /* [out]        time base */
239                                  int time_increment;     /* [out]        time increment */                                  int time_increment;     /* [out]        time increment */
240    
241                            /* XXX: external deblocking stuff */
242                            int * qscale;   /* [out]        pointer to quantizer table */
243                            int qscale_stride;              /* [out]        quantizer scale stride */
244    
245                          } vop;                          } vop;
246                          struct  /* XVID_DEC_VOL */                  struct {        /* XVID_TYPE_VOL */
247                          {                          int general;            /* [out]        flags */
                                 int general;            /* [out]        flags: eg. frames are interlaced */  
248                                  int width;                      /* [out]        width */                                  int width;                      /* [out]        width */
249                                  int height;                     /* [out]        height */                                  int height;                     /* [out]        height */
250                                  int aspect_ratio;       /* [out]        aspect ratio */                          int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */
251                                  int par_width;          /* [out]        aspect ratio width */                                  int par_width;          /* [out]        aspect ratio width */
252                                  int par_height;         /* [out]        aspect ratio height */                                  int par_height;         /* [out]        aspect ratio height */
253                          } vol;                          } vol;
254                  } data;                  } data;
255          } XVID_DEC_STATS;  } xvid_dec_stats_t;
256    
257    
258    /*****************************************************************************
259      xvid plugin system -- internals
260    
261      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
262      before encoding each frame xvidcore will call XVID_PLG_BEFORE
263      after encoding each frame xvidcore will call XVID_PLG_AFTER
264      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
265     ****************************************************************************/
266    
267    #define XVID_PLG_CREATE     0
268    #define XVID_PLG_DESTROY    1
269    #define XVID_PLG_INFO       2
270    #define XVID_PLG_BEFORE     3
271    #define XVID_PLG_AFTER      4
272    
273    /* xvid_plg_info_t.flags */
274    #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */
275    #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/
276    #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */
277    
278    
279          typedef struct          typedef struct
280          {          {
281                  int general;      int version;
282                  void *bitstream;      int flags;              /* plugin flags */
283                  int length;  } xvid_plg_info_t;
284    
285                  void *image;  
286                  int stride;  typedef struct
287                  int colorspace;  {
288          }      int version;
289          XVID_DEC_FRAME;  
290        int width;
291        int height;
292        int mb_width;
293        int mb_height;
294            int fincr;
295        int fbase;
296    
297        void * param;
298    } xvid_plg_create_t;
299    
300    
         // This struct is used for per slice rendering  
301          typedef struct          typedef struct
302          {          {
303                  void *y,*u,*v;      int version;
304                  int stride_y, stride_u,stride_v;  
305          } XVID_DEC_PICTURE;      int width;              /* [out] */
306        int height;             /* [out] */
307        int mb_width;           /* [out] */
308        int mb_height;          /* [out] */
309            int fincr;              /* [out] */
310        int fbase;              /* [out] */
311    
312        xvid_image_t reference; /* [out] -> [out] */
313        xvid_image_t current;   /* [out] -> [in,out] */
314        xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
315        int frame_num;          /* [out] frame number */
316    
317        int type;               /* [in,out] */
318        int quant;              /* [in,out] */
319    
320        int * dquant;               /* [in,out]     pointer to diff quantizer table */
321            int dquant_stride;              /* [in,out]     diff quantizer stride */
322    
323        int vop_flags;          /* [in,out] */
324        int vol_flags;          /* [in,out] */
325        int motion_flags;       /* [in,out] */
326    
327        int length;                 /* [out] after: length of encoded frame */
328        int kblks, mblks, ublks;    /* [out] after: */
329        int sse_y, sse_u, sse_v;    /* [out] */
330    } xvid_plg_data_t;
331    
332    
333  /*****************************************************************************  /*****************************************************************************
334   * Decoder entry point    xvid plugin system -- external
335    
336      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
337      indicates the plugin function pointer and plugin-specific data.
338      xvidcore handles the rest. example:
339    
340      xvid_enc_create_t create;
341      xvid_enc_plugin_t plugins[2];
342    
343      plugins[0].func = xvid_psnr_func;
344      plugins[0].param = NULL;
345      plugins[1].func = xvid_cbr_func;
346      plugins[1].param = &cbr_data;
347    
348      create.num_plugins = 2;
349      create.plugins = plugins;
350    
351   ****************************************************************************/   ****************************************************************************/
352    
353  /* decoder options */  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
354  #define XVID_DEC_DECODE         0  
355  #define XVID_DEC_CREATE         1  typedef struct
356  #define XVID_DEC_DESTROY        2  {
357        xvid_plugin_func * func;
358          int xvid_decore(void *handle,      void * param;
359                                          int opt,  } xvid_enc_plugin_t;
360                                          void *param1,  
361                                          void *param2);  xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */
362    xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
363    xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
364    
365    
366  /*****************************************************************************  /*****************************************************************************
367   * Encoder constants   * xvid_encore()
368   ****************************************************************************/   ****************************************************************************/
369    
370  /* Flags for XVID_ENC_PARAM.global */  /* Encoder options */
371  #define XVID_GLOBAL_PACKED              0x00000001      /* packed bitstream */  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
372  #define XVID_GLOBAL_DX50BVOP    0x00000002      /* dx50 bvop compatibility */  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
373  #define XVID_GLOBAL_DEBUG               0x00000004      /* print debug info on each frame */  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
374  #define XVID_GLOBAL_REDUCED             0x04000000      /* reduced resolution vop enable */                                                                          0 means this frame should not be written (ie. encoder lag) */
375    
376  #define XVID_GLOBAL_EXTRASTATS  0x00000200      /* generate extra statistics */  int xvid_encore(void *handle, int opt, void *param1, void *param2);
377    
378    
379  /* Flags for XVID_ENC_FRAME.general */  /* global flags  */
380  #define XVID_VALID_FLAGS                0x80000000  typedef enum
381    {
382        XVID_PACKED                 = 0x00000001,   /* packed bitstream */
383        XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
384        XVID_EXTRASTATS_ENABLE  = 0x00000004
385    /*define XVID_VOL_AT_IVOP       0x00000008       write vol at every ivop: WIN32/divx compatibility */
386    /*define XVID_FORCE_VOL         0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
387    } xvid_global_t;
388    
 #define XVID_CUSTOM_QMATRIX             0x00000004      /* use custom quant matrix */  
 #define XVID_H263QUANT                  0x00000010  
 #define XVID_MPEGQUANT                  0x00000020  
 #define XVID_HALFPEL                    0x00000040      /* use halfpel interpolation */  
 #define XVID_QUARTERPEL                 0x02000000  
 #define XVID_ADAPTIVEQUANT              0x00000080  
 #define XVID_LUMIMASKING                0x00000100  
389    
390  #define XVID_INTERLACING                0x00000400      /* enable interlaced encoding */  /* XVID_ENC_ENCODE param1 */
391  #define XVID_TOPFIELDFIRST              0x00000800      /* set top-field-first flag  */  /* vol-based flags */
392  #define XVID_ALTERNATESCAN              0x00001000      /* set alternate vertical scan flag */  typedef enum {
393        XVID_MPEGQUANT          = 0x00000001,
394        XVID_EXTRASTATS         = 0x00000002,
395        XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
396        XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
397        XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
398        XVID_INTERLACING        = 0x00000400, /* enable interlaced encoding */
399    } xvid_vol_t;
400    
 #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) */  
401    
402  #define XVID_INTER4V                    0x00008000  /* vop-based flags */
403    typedef enum {
404        XVID_DEBUG              = 0x00000001,
405    
406  #define XVID_ME_ZERO                    0x00010000      XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */
407  #define XVID_ME_LOGARITHMIC             0x00020000      XVID_INTER4V            = 0x00000008,
 #define XVID_ME_FULLSEARCH              0x00040000  
 #define XVID_ME_PMVFAST                 0x00080000  
 #define XVID_ME_EPZS                    0x00100000  
408    
409  #define XVID_GREYSCALE                  0x01000000      /* enable greyscale only mode (even for */      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
410                                                                                          /* color input material chroma is ignored) */      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
411                                                  color input material chroma is ignored) */
412        XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
413        XVID_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
414        XVID_DYNAMIC_BFRAMES    = 0x00000200,
415    
416  #define XVID_GMC                                0x10000000          /* only valid for vol_flags|=XVID_INTERLACING */
417  #define XVID_GMC_TRANSLATIONAL  0x20000000      XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
418        XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
419    
420  #define XVID_REDUCED                    0x04000000      /* reduced resolution vop */      /* only valid for vol_flags|=XVID_REDUCED_ENABLED */
421  #define XVID_HQACPRED                   0x08000000      /* 20030209: high quality ac prediction */      XVID_REDUCED            = 0x00001000, /* reduced resolution vop */
422    } xvid_vop_t;
423    
 #define XVID_EXTRASTATS                 0x00000200  /* generate extra statistics */  
424    
425  #define XVID_MODEDECISION_BITS  0x00400000      /* enable DCT-ME and use it for mode decision */  typedef enum {
426        PMV_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
427        PMV_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
428    
429        PMV_HALFPELREFINE16     = 0x00020000,
430        PMV_HALFPELREFINE8      = 0x02000000,
431    
432  /* Flags for XVID_ENC_FRAME.motion */      PMV_QUARTERPELREFINE16  = 0x00040000,
433        PMV_QUARTERPELREFINE8   = 0x04000000,
434    
435  #define PMV_ADVANCEDDIAMOND16   0x00008000      /* use advdiamonds instead of diamonds as search pattern */      PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
 #define PMV_USESQUARES16                0x00800000      /* use squares instead of diamonds as search pattern */  
436    
437  #define PMV_HALFPELREFINE16     0x00020000      PMV_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
438  #define PMV_HALFPELREFINE8              0x02000000      PMV_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */
439        PMV_USESQUARES8         = 0x80000000, /* use square for PMV_EXTSEARCH8 */
440    
441  #define PMV_QUARTERPELREFINE16  0x00040000      PMV_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
442  #define PMV_QUARTERPELREFINE8   0x04000000      PMV_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
443    
444  #define PMV_EXTSEARCH16                 0x00080000      /* extend PMV by more searches */      /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */
445        HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
446        HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
447        QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
448        QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
449    
450  #define PMV_EXTSEARCH8                  0x08000000      /* use diamond/square for extended 8x8 search */      EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
451  #define PMV_ADVANCEDDIAMOND8    0x00004000      /* use advdiamond for PMV_EXTSEARCH8 */                                                    enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
452  #define PMV_USESQUARES8                 0x80000000      /* use square for PMV_EXTSEARCH8 */      CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
453    
454  #define PMV_CHROMA16                    0x00100000      /* also use chroma for P_VOP/S_VOP ME */      PMV_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
455  #define PMV_CHROMA8                             0x10000000      /* also use chroma for B_VOP ME */      PMV_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
456        PMV_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
457        PMV_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
458    } xvid_motion_t;
459    
 /* Motion search using DCT. use XVID_MODEDECISION_DCT to enable */  
 #define HALFPELREFINE16_BITS    0x00000100      /* perform DCT-based halfpel refinement */  
 #define HALFPELREFINE8_BITS             0x00000200      /* perform DCT-based halfpel refinement for 8x8 mode */  
 #define QUARTERPELREFINE16_BITS 0x00000400      /* perform DCT-based qpel refinement */  
 #define QUARTERPELREFINE8_BITS  0x00000800      /* perform DCT-based qpel refinement for 8x8 mode */  
460    
461  #define EXTSEARCH_BITS                  0x00001000      /* perform DCT-based search using square pattern */  /* XVID_ENC_CREATE param1 */
462                                                                                          /* enable PMV_EXTSEARCH8 to do this in 8x8 search as well */  typedef struct {
463  #define CHECKPREDICTION_BITS    0x00002000      /* always check vector equal to prediction */          int version;
464            int width;                              /* [in]         frame dimensions; width, pixel units */
465            int height;                             /* [in]         frame dimensions; height, pixel units */
466    
467        int num_plugins;        /* [in:opt] number of plugins */
468        xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
469    
470  /* note: old and deprecated - or never implemented */          int num_threads;                /* [in:opt]     number of threads */
471            int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
472    
473  /* only for compatability with old encoders */          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */
474    
475  #define PMV_EARLYSTOP16                 0x00  /* --- vol-based stuff; included here for conveinience */
476  #define PMV_EARLYSTOP8                  0x00          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
477  #define PMV_QUICKSTOP16                 0x00          int fbase;                              /* [in] framerate base
478  #define PMV_QUICKSTOP8                  0x00                                                                                  frame_duration = fincr/fbase seconds*/
479    /* ^^^---------------------------------------------- */
480    
 #define PMV_HALFPELDIAMOND16    0x00  
 #define PMV_HALFPELDIAMOND8     0x00  
481    
482  #define PMV_UNRESTRICTED16      0x00200000      /* unrestricted ME, not implemented */  /* ---vop-based; included here for conveienience */
483  #define PMV_OVERLAPPING16       0x00400000      /* overlapping ME, not implemented */          int max_key_interval;   /* [in:opt] the maximum interval between key frames */
484  #define PMV_UNRESTRICTED8       0x20000000      /* unrestricted ME, not implemented */                                                                                  /*XXX: maybe call it gop_size? */
 #define PMV_OVERLAPPING8                0x40000000      /* overlapping ME, not implemented */  
485    
486  #define XVID_ME_COLOUR                  0x00    /* this has been converted to PMV_CHROMA[16/8] */          int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
487    
488            int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
489            int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
490    
491  /*****************************************************************************  /* ^^^ -------------------------------------------------------------------------*/
  * Encoder structures  
  ****************************************************************************/  
492    
         typedef struct  
         {  
                 int width, height;  
                 int fincr, fbase;               /* frame increment, fbase. each frame = "fincr/fbase" seconds */  
                 int rc_bitrate;                 /* the bitrate of the target encoded stream, in bits/second */  
                 int rc_reaction_delay_factor;   /* how fast the rate control reacts - lower values are faster */  
                 int rc_averaging_period;        /* as above */  
                 int rc_buffer;                  /* as above */  
                 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  
                 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  
                                                                  * quant = ((past_quant + future_quant) * bquant_ratio)/200  
                                                                  */  
                 int bquant_offset;              /* bquant += bquant_offset */  
                 int frame_drop_ratio;   /* frame dropping: 0=drop none... 100=drop all */  
493                  void *handle;                   /* [out] encoder instance handle */                  void *handle;                   /* [out] encoder instance handle */
494          }          }
495          XVID_ENC_PARAM;  xvid_enc_create_t;
496    
         typedef struct  
         {  
                 int x;  
                 int y;  
         }  
         VECTOR;  
497    
498          typedef struct  typedef struct {
499          {          int version;
500                  int mode;                               /* macroblock mode */          int type;                               /* [in] rate control type: XVID_RC_xxx */
501                  VECTOR mvs[4];  
502          }          /* common stuff */
503          MVBLOCKHINT;          int min_iquant;         /* [in:opt] ivop quantizer upper/lower limit */
504            int max_iquant;         /* [in:opt] */
505            int min_pquant;         /* [in:opt] psvop quantizer upper/lower limit */
506            int max_pquant;         /* [in:opt]  */
507            int min_bquant;         /* [in:opt] bvop quantizer upper/lower limit */
508            int max_bquant;         /* [in:opt] */
509    
510            union {
511                    struct {        /* XVID_RC_FQUANT */
512                            float quant;                            /* [in] quantizer */
513                    } fquant;
514                    struct {        /* XVID_RC_CBR */
515                            int bitrate;                            /* [in] the bitrate of the target encoded stream, in bits/second */
516                            int reaction_delay_factor;      /* [in] how fast the rate control reacts - lower values are faster */
517                            int averaging_period;           /* [in] */
518                            int buffer;                                     /* [in] */
519                    } cbr;
520            } data;
521    } xvid_enc_rc_t;
522    
         typedef struct  
         {  
                 int intra;                              /* frame intra choice */  
                 int fcode;                              /* frame fcode */  
                 MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */  
         }  
         MVFRAMEHINT;  
523    
         typedef struct  
         {  
                 int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */  
524    
525                  MVFRAMEHINT mvhint;  #define XVID_KEYFRAME   0x00000001
                 void *hintstream;               /* compressed hint buffer */  
                 int hintlength;                 /* length of buffer (bytes) */  
         }  
         HINTINFO;  
526    
527          typedef struct  typedef struct {
528          {          int version;
                 int general;                    /* [in] general options */  
                 int motion;                             /* [in] ME options */  
                 void *bitstream;                /* [in] bitstream ptr */  
                 int length;                             /* [out] bitstream length (bytes) */  
   
                 void *image;                    /* [in] image ptr */  
                 int stride;  
                 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 */  
529    
530                  int bquant;                             /* [in] bframe quantizer */  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
531                    changes here until the next VOL (keyframe). */
532            xvid_vol_t vol_flags;                   /* [in] vol flags */
533            unsigned char *
534                    quant_intra_matrix;     /* [in:opt] custom intra qmatrix */
535            unsigned char *
536                    quant_inter_matrix;     /* [in:opt] custom inter qmatrix */
537    
538          }          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
539          XVID_ENC_FRAME;          int par_width;                  /* [in:opt] aspect ratio width */
540            int par_height;                 /* [in:opt] aspect ratio height */
541    /* ^^^----------------------------------------------------------------------------------*/
542    
543        int fincr;                          /* framerate increment, for variable framerate only */
544            xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
545            xvid_motion_t motion;                           /* [in] ME options */
546    
547          typedef struct          xvid_image_t input;     /* [in] input image (read from) */
548          {  
549                  int quant;                              /* [out] frame quantizer */          int type;                               /* [in:opt] coding type */
550                  int hlength;                    /* [out] header length (bytes) */          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
551                  int kblks, mblks, ublks;        /* [out] */  
552                  long sse_y;                             /* [out] SSE of Y */          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
553                  long sse_u;                             /* [out] SSE of Cb */          int length;                             /* [in:opt] bitstream length (bytes) */
554                  long sse_v;                             /* [out] SSE of Cr */  
555            int out_flags;                          /* [out] bitstream output flags */
556          }          }
557          XVID_ENC_STATS;  xvid_enc_frame_t;
558    
559    
560  /*****************************************************************************  /* XVID_ENC_ENCODE param2 (optional)
561   * Encoder entry point          xvid_enc_stats_t describes individual frame details
  ****************************************************************************/  
562    
563  /* Encoder options */          coding_type==XVID_TYPE_NOTHING if the stats are not given
564  #define XVID_ENC_ENCODE         0  */
565  #define XVID_ENC_CREATE         1  typedef struct {
566  #define XVID_ENC_DESTROY        2          int version;
   
         int xvid_encore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
567    
568            /* encoding parameters */
569            int type;                                       /* [out] coding type */
570            int quant;                                      /* [out] frame quantizer */
571            xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */
572            int vop_flags;                          /* [out] vop flags (see above) */
573            /* bitrate */
574            int length;                                     /* [out] frame length */
575    
576            int hlength;                            /* [out] header length (bytes) */
577            int kblks, mblks, ublks;        /* [out] */
578    
579        int sse_y, sse_u, sse_v;
580    }
581    xvid_enc_stats_t;
582    
583  #ifdef __cplusplus  #ifdef __cplusplus
584  }  }
585  #endif  #endif
586    
587    
588  #endif  #endif

Legend:
Removed from v.1.25  
changed lines
  Added in v.1.27.2.9

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