[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.50, Wed Dec 10 01:01: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     *  Copyright(C) 2001-2003 Peter Ross <pross@xvid.org>
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  *  $Id$  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            $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  /* Error codes */          XVID_UNSTABLE is defined only during development.
49  #define XVID_ERR_FAIL           -1          */
 #define XVID_ERR_OK                     0  
 #define XVID_ERR_MEMORY         1  
 #define XVID_ERR_FORMAT         2  
   
   
 /* Colorspaces */  
 #define XVID_CSP_RGB24  0  
 #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  
 #define XVID_CSP_NULL   9999  
50    
51  #define XVID_CSP_VFLIP  0x80000000      // flip mask  #define XVID_MAKE_VERSION(a,b,c) ((((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff))
52    #define XVID_VERSION_MAJOR(a)    ((char)(((a)>>16) & 0xff))
53    #define XVID_VERSION_MINOR(a)    ((char)(((a)>> 8) & 0xff))
54    #define XVID_VERSION_PATCH(a)    ((char)(((a)>> 0) & 0xff))
55    
56    #define XVID_MAKE_API(a,b)       ((((a)&0xff)<<16) | (((b)&0xff)<<0))
57    #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)
58    #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)
59    
60    #define XVID_VERSION             XVID_MAKE_VERSION(1,0,-127)
61    #define XVID_API                 XVID_MAKE_API(4, 0)
62    
63    #define XVID_UNSTABLE
64    
65    /* Bitstream Version
66     * this will be writen into the bitstream to allow easy detection of xvid
67     * encoder bugs in the decoder, without this it might not possible to
68     * automatically distinquish between a file which has been encoded with an
69     * old & buggy XVID from a file which has been encoded with a bugfree version
70     * see the infamous interlacing bug ...
71     *
72     * this MUST be increased if an encoder bug is fixed, increasing it too often
73     * doesnt hurt but not increasing it could cause difficulty for decoders in the
74     * future
75     */
76    #define XVID_BS_VERSION "0023"
77    
78    
79  /*****************************************************************************  /*****************************************************************************
80     * error codes
81   ****************************************************************************/   ****************************************************************************/
82    
83  /* CPU flags for XVID_INIT_PARAM.cpu_flags */          /*      all functions return values <0 indicate error */
84    
85    #define XVID_ERR_FAIL           -1              /* general fault */
86    #define XVID_ERR_MEMORY         -2              /* memory allocation error */
87    #define XVID_ERR_FORMAT         -3              /* file format error */
88    #define XVID_ERR_VERSION        -4              /* structure version not supported */
89    #define XVID_ERR_END            -5              /* encoder only; end of stream reached */
90    
91    
 #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;  
92    
93  /*****************************************************************************  /*****************************************************************************
94   *  Initialization entry point   * xvid_image_t
95   ****************************************************************************/   ****************************************************************************/
96    
97          int xvid_init(void *handle,  /* colorspace values */
98                                    int opt,  
99                                    void *param1,  #define XVID_CSP_USER     (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */
100                                    void *param2);  #define XVID_CSP_I420     (1<< 1) /* 4:2:0 planar */
101    #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 planar */
102    #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */
103    #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */
104    #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */
105    #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
106    #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
107    #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
108    #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
109    #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
110    #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
111    #define XVID_CSP_SLICE    (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */
112    #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
113    #define XVID_CSP_NULL     (1<<14) /* decoder only: dont output anything */
114    #define XVID_CSP_VFLIP    (1<<31) /* vertical flip mask */
115    
116    /* xvid_image_t
117            for non-planar colorspaces use only plane[0] and stride[0]
118            four plane reserved for alpha*/
119    typedef struct {
120            int csp;                                /* [in] colorspace; or with XVID_CSP_VFLIP to perform vertical flip */
121            void * plane[4];                /* [in] image plane ptrs */
122            int stride[4];                  /* [in] image stride; "bytes per row"*/
123    } xvid_image_t;
124    
125    /* video-object-sequence profiles */
126    #define XVID_PROFILE_S_L0    0x08 /* simple */
127    #define XVID_PROFILE_S_L1    0x01
128    #define XVID_PROFILE_S_L2    0x02
129    #define XVID_PROFILE_S_L3    0x03
130    #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
131    #define XVID_PROFILE_ARTS_L2 0x92
132    #define XVID_PROFILE_ARTS_L3 0x93
133    #define XVID_PROFILE_ARTS_L4 0x94
134    #define XVID_PROFILE_AS_L0   0xf0 /* advanced simple */
135    #define XVID_PROFILE_AS_L1   0xf1
136    #define XVID_PROFILE_AS_L2   0xf2
137    #define XVID_PROFILE_AS_L3   0xf3
138    #define XVID_PROFILE_AS_L4   0xf4
139    
140    /* aspect ratios */
141    #define XVID_PAR_11_VGA    1 /* 1:1 vga (square), default if AR is not precised (ie: ==0) */
142    #define XVID_PAR_43_PAL    2 /* 4:3 pal (12:11 625-line) */
143    #define XVID_PAR_43_NTSC   3 /* 4:3 ntsc (10:11 525-line) */
144    #define XVID_PAR_169_PAL   4 /* 16:9 pal (16:11 625-line) */
145    #define XVID_PAR_169_NTSC  5 /* 16:9 ntsc (40:33 525-line) */
146    #define XVID_PAR_EXT      15 /* extended par; use par_width, par_height */
147    
148    /* frame type flags */
149    #define XVID_TYPE_VOL     -1 /* decoder only: vol was decoded */
150    #define XVID_TYPE_NOTHING  0 /* decoder only (encoder stats): nothing was decoded/encoded */
151    #define XVID_TYPE_AUTO     0 /* encoder: automatically determine coding type */
152    #define XVID_TYPE_IVOP     1 /* intra frame */
153    #define XVID_TYPE_PVOP     2 /* predicted frame */
154    #define XVID_TYPE_BVOP     3 /* bidirectionally encoded */
155    #define XVID_TYPE_SVOP     4 /* predicted+sprite frame */
156    
157    
158  /*****************************************************************************  /*****************************************************************************
159   * Decoder constants   * xvid_global()
160   ****************************************************************************/   ****************************************************************************/
161    
162  /* Flags for XVID_DEC_FRAME.general */  /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
163  #define XVID_QUICK_DECODE               0x00000010  
164    #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
165    #define XVID_CPU_ASM      (1<< 7) /* native assembly */
166    /* ARCH_IS_IA32 */
167    #define XVID_CPU_MMX      (1<< 0) /*       mmx : pentiumMMX,k6 */
168    #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
169    #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
170    #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
171    #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
172    #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
173    #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
174    /* ARCH_IS_PPC */
175    #define XVID_CPU_ALTIVEC  (1<< 0) /* altivec */
176    
177    
178    #define XVID_DEBUG_ERROR     (1<< 0)
179    #define XVID_DEBUG_STARTCODE (1<< 1)
180    #define XVID_DEBUG_HEADER    (1<< 2)
181    #define XVID_DEBUG_TIMECODE  (1<< 3)
182    #define XVID_DEBUG_MB        (1<< 4)
183    #define XVID_DEBUG_COEFF     (1<< 5)
184    #define XVID_DEBUG_MV        (1<< 6)
185    #define XVID_DEBUG_RC        (1<< 7)
186    #define XVID_DEBUG_DEBUG     (1<<31)
187    
188    /* XVID_GBL_INIT param1 */
189    typedef struct {
190            int version;
191            unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */
192            int debug;     /* [in:opt] debug level */
193    } xvid_gbl_init_t;
194    
195    
196    /* XVID_GBL_INFO param1 */
197    typedef struct {
198            int version;
199            int actual_version; /* [out] returns the actual xvidcore version */
200            const char * build; /* [out] if !null, points to description of this xvid core build */
201            unsigned int cpu_flags;      /* [out] detected cpu features */
202            int num_threads;    /* [out] detected number of cpus/threads */
203    } xvid_gbl_info_t;
204    
205    
206    /* XVID_GBL_CONVERT param1 */
207    typedef struct {
208            int version;
209            xvid_image_t input;  /* [in] input image & colorspace */
210            xvid_image_t output; /* [in] output image & colorspace */
211            int width;           /* [in] width */
212            int height;          /* [in] height */
213            int interlacing;     /* [in] interlacing */
214    } xvid_gbl_convert_t;
215    
216    
217    #define XVID_GBL_INIT    0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
218    #define XVID_GBL_INFO    1 /* return some info about xvidcore, and the host computer */
219    #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
220    
221    int xvid_global(void *handle, int opt, void *param1, void *param2);
222    
223    
224  /*****************************************************************************  /*****************************************************************************
225   * Decoder structures   * xvid_decore()
226   ****************************************************************************/   ****************************************************************************/
227    
228          typedef struct  #define XVID_DEC_CREATE  0 /* create decore instance; return 0 on success */
229          {  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
230                  int width;  #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */
231                  int height;  
232                  void *handle;  int xvid_decore(void *handle, int opt, void *param1, void *param2);
233          }  
234          XVID_DEC_PARAM;  /* XVID_DEC_CREATE param 1
235            image width & height may be specified here when the dimensions are
236            known in advance. */
237    typedef struct {
238            int version;
239            int width;     /* [in:opt] image width */
240            int height;    /* [in:opt] image width */
241            void * handle; /* [out]    decore context handle */
242    } xvid_dec_create_t;
243    
244    
245    /* XVID_DEC_DECODE param1 */
246    /* general flags */
247    #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
248    #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
249    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
250    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
251    
252    typedef struct {
253            int version;
254            int general;         /* [in:opt] general flags */
255            void *bitstream;     /* [in]     bitstream (read from)*/
256            int length;          /* [in]     bitstream length */
257            xvid_image_t output; /* [in]     output image (written to) */
258    } xvid_dec_frame_t;
259    
260    
261    /* XVID_DEC_DECODE param2 :: optional */
262          typedef struct          typedef struct
263          {          {
264                  int general;          int version;
265                  void *bitstream;  
266                  int length;          int type;                   /* [out] output data type */
267            union {
268                  void *image;                  struct { /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
269                  int stride;                          int general;        /* [out] flags */
270                  int colorspace;                          int time_base;      /* [out] time base */
271          }                          int time_increment; /* [out] time increment */
272          XVID_DEC_FRAME;  
273                            /* XXX: external deblocking stuff */
274                            int * qscale;       /* [out] pointer to quantizer table */
275                            int qscale_stride;  /* [out] quantizer scale stride */
276    
277                    } vop;
278                    struct {        /* XVID_TYPE_VOL */
279                            int general;        /* [out] flags */
280                            int width;          /* [out] width */
281                            int height;         /* [out] height */
282                            int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
283                            int par_width;      /* [out] aspect ratio width */
284                            int par_height;     /* [out] aspect ratio height */
285                    } vol;
286            } data;
287    } xvid_dec_stats_t;
288    
289    
290    
291          // This struct is used for per slice rendering  #define XVID_ZONE_QUANT  (1<<0)
292    #define XVID_ZONE_WEIGHT (1<<1)
293    
294          typedef struct          typedef struct
295          {          {
296                  void *y,*u,*v;          int frame;
297                  int stride_y, stride_u,stride_v;          int mode;
298          } XVID_DEC_PICTURE;          int increment;
299            int base;
300  #define XVID_DEC_DESTROY        2  } xvid_enc_zone_t;
301    
         int xvid_decore(void *handle,  
                                         int opt,  
                                         void *param1,  
                                         void *param2);  
302    
303    
304  /*****************************************************************************  /*****************************************************************************
305   * Encoder constants    xvid plugin system -- internals
306    
307      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
308      before encoding each frame xvidcore will call XVID_PLG_BEFORE
309      after encoding each frame xvidcore will call XVID_PLG_AFTER
310      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
311   ****************************************************************************/   ****************************************************************************/
312    
 /* Flags for XVID_ENC_PARAM.global */  
 #define XVID_GLOBAL_PACKED              0x00000001      /* packed bitstream */  
 #define XVID_GLOBAL_DX50BVOP    0x00000002      /* dx50 bvop compatibility */  
 #define XVID_GLOBAL_DEBUG               0x00000004      /* print debug info on each frame */  
   
 /* 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  
313    
314    #define XVID_PLG_CREATE  (1<<0)
315    #define XVID_PLG_DESTROY (1<<1)
316    #define XVID_PLG_INFO    (1<<2)
317    #define XVID_PLG_BEFORE  (1<<3)
318    #define XVID_PLG_FRAME   (1<<4)
319    #define XVID_PLG_AFTER   (1<<5)
320    
321    /* xvid_plg_info_t.flags */
322    #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
323    #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
324    #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
325    
 /*****************************************************************************  
  * Encoder structures  
  ****************************************************************************/  
326    
327          typedef struct          typedef struct
328          {          {
329                  int width, height;          int version;
330                  int fincr, fbase;               /* frame increment, fbase. each frame = "fincr/fbase" seconds */          int flags;   /* [in:opt] plugin flags */
331                  int rc_bitrate;                 /* the bitrate of the target encoded stream, in bits/second */  } xvid_plg_info_t;
                 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  
 #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;  
332    
         typedef struct  
         {  
                 int x;  
         }  
         VECTOR;  
333    
334          typedef struct          typedef struct
335          {          {
336                  int mode;                               /* macroblock mode */          int version;
337                  VECTOR mvs[4];  
338          }          int num_zones;           /* [out] */
339          MVBLOCKHINT;          xvid_enc_zone_t * zones; /* [out] */
340    
341            int width;               /* [out] */
342            int height;              /* [out] */
343            int mb_width;            /* [out] */
344            int mb_height;           /* [out] */
345            int fincr;               /* [out] */
346            int fbase;               /* [out] */
347    
348            void * param;            /* [out] */
349    } xvid_plg_create_t;
350    
351    
352          typedef struct          typedef struct
353          {          {
354                  int intra;                              /* frame intra choice */          int version;
355                  int fcode;                              /* frame fcode */  
356                  MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */          int num_frames; /* [out] total frame encoded */
357          }  } xvid_plg_destroy_t;
358          MVFRAMEHINT;  
359    
360          typedef struct          typedef struct
361          {          {
362                  int rawhints;                   /* if set, use MVFRAMEHINT, else use compressed buffer */          int version;
363    
364                  MVFRAMEHINT mvhint;          xvid_enc_zone_t * zone; /* [out] current zone */
365                  void *hintstream;               /* compressed hint buffer */  
366                  int hintlength;                 /* length of buffer (bytes) */          int width;              /* [out] */
367          }          int height;             /* [out] */
368          HINTINFO;          int mb_width;           /* [out] */
369            int mb_height;          /* [out] */
370            int fincr;              /* [out] */
371            int fbase;              /* [out] */
372    
373            int min_quant[3];       /* [out] */
374            int max_quant[3];       /* [out] */
375    
376            xvid_image_t reference; /* [out] -> [out] */
377            xvid_image_t current;   /* [out] -> [in,out] */
378            xvid_image_t original;  /* [out] after: points the original (uncompressed) copy of the current frame */
379            int frame_num;          /* [out] frame number */
380    
381            int type;               /* [in,out] */
382            int quant;              /* [in,out] */
383    
384            int * dquant;           /* [in,out]     pointer to diff quantizer table */
385            int dquant_stride;      /* [in,out]     diff quantizer stride */
386    
387            int vop_flags;          /* [in,out] */
388            int vol_flags;          /* [in,out] */
389            int motion_flags;       /* [in,out] */
390    
391            int length;             /* [out] after: length of encoded frame */
392            int kblks;              /* [out] number of blocks compressed as Intra */
393            int mblks;              /* [out] number of blocks compressed as Inter */
394            int ublks;              /* [out] number of blocks marked not_coded */
395            int sse_y;              /* [out] Y plane's sse */
396            int sse_u;              /* [out] U plane's sse */
397            int sse_v;              /* [out] V plane's sse */
398            int bquant_ratio;       /* [in] */
399            int bquant_offset;      /* [in] */
400    } xvid_plg_data_t;
401    
402    
403    /*****************************************************************************
404      xvid plugin system -- external
405    
406      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
407      indicates the plugin function pointer and plugin-specific data.
408      xvidcore handles the rest. example:
409    
410      xvid_enc_create_t create;
411      xvid_enc_plugin_t plugins[2];
412    
413      plugins[0].func = xvid_psnr_func;
414      plugins[0].param = NULL;
415      plugins[1].func = xvid_cbr_func;
416      plugins[1].param = &cbr_data;
417    
418      create.num_plugins = 2;
419      create.plugins = plugins;
420    
421     ****************************************************************************/
422    
423    typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
424    
425          typedef struct          typedef struct
426          {          {
427                  int general;                    /* [in] general options */          xvid_plugin_func * func;
428                  int motion;                             /* [in] ME options */          void * param;
429                  void *bitstream;                /* [in] bitstream ptr */  } xvid_enc_plugin_t;
                 int length;                             /* [out] bitstream length (bytes) */  
430    
                 void *image;                    /* [in] image ptr */  
                 int colorspace;                 /* [in] source colorspace */  
431    
432                  unsigned char *quant_intra_matrix;      // [in] custom intra qmatrix */  xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
433                  unsigned char *quant_inter_matrix;      // [in] custom inter qmatrix */  xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
434                  int quant;                              /* [in] frame quantizer (vbr) */  xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
                 int intra;                              /* [in] force intra frame (vbr only)  
                                                                  * [out] intra state  
                                                                  */  
                 HINTINFO hint;                  /* [in/out] mv hint information */  
435    
436  #ifdef BFRAMES  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
                 int bquant;                             /* [in] bframe quantizer */  
 #endif  
437    
438          }  xvid_plugin_func xvid_plugin_psnr;      /* write psnr values to stdout */
439          XVID_ENC_FRAME;  xvid_plugin_func xvid_plugin_dump;      /* dump before and after yuvpgms */
440    
441    
442    /* single pass rate control
443     * CBR and Constant quantizer modes */
444          typedef struct          typedef struct
445          {          {
446                  int quant;                              /* [out] frame quantizer */          int version;
                 int input_consumed;             /* [out] */  
                 int hlength;                    /* [out] header length (bytes) */  
                 int kblks, mblks, ublks;        /* [out] */  
447    
448          }          int bitrate;               /* [in] bits per second */
449          XVID_ENC_STATS;          int reaction_delay_factor; /* [in] */
450            int averaging_period;      /* [in] */
451            int buffer;                /* [in] */
452    } xvid_plugin_single_t;
453    
454    
455    typedef struct {
456            int version;
457    
458            char * filename;
459    } xvid_plugin_2pass1_t;
460    
461    
462    #define XVID_PAYBACK_BIAS 0 /* payback with bias */
463    #define XVID_PAYBACK_PROP 1 /* payback proportionally */
464    
465    typedef struct {
466            int version;
467    
468            int bitrate;                  /* [in] bits per second */
469            char * filename;              /* [in] first pass stats filename */
470    
471            int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
472            int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
473            int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
474            int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
475            int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
476            int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
477    
478            int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
479            int kfthreshold;              /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
480                                                                       *      is substracted from its bit allocation. The reduction is computed as multiples of
481                                                                       *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
482                                                                       *      0 for 1<distance<kfthreshold */
483    
484            int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
485    }xvid_plugin_2pass2_t;
486    
487    
488  /*****************************************************************************  /*****************************************************************************
489   * Encoder entry point   * xvid_encore()
490   ****************************************************************************/   ****************************************************************************/
491    
492  /* Encoder options */  /* Encoder options */
493  #define XVID_ENC_ENCODE         0  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
494  #define XVID_ENC_CREATE         1  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
495  #define XVID_ENC_DESTROY        2  #define XVID_ENC_ENCODE  2 /* encode a frame: returns number of ouput bytes
496                                * 0 means this frame should not be written (ie. encoder lag) */
497          int xvid_encore(void *handle,  
498                                          int opt,  int xvid_encore(void *handle, int opt, void *param1, void *param2);
499                                          void *param1,  
500                                          void *param2);  
501    
502    /* Global Flags */
503    #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
504    #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
505    #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
506    #if 0
507    #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
508    #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
509    #endif
510    
511    
512    /* XVID_ENC_ENCODE param1 */
513    /* vol-based flags */
514    #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
515    #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
516    #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
517    #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
518    #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
519    #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
520    
521    
522    
523    /* vop based flags */
524    #define XVID_VOP_DEBUG           (1<< 0)
525    #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */
526    #define XVID_VOP_INTER4V         (1<< 2)
527    #define XVID_VOP_TRELLISQUANT    (1<< 3) /* use trellis based R-D "optimal" quantization */
528    #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */
529    #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */
530    #define XVID_VOP_GREYSCALE       (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
531    #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */
532    #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */
533    /* only valid for vol_flags|=XVID_VOL_INTERLACING */
534    #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */
535    #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */
536    /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
537    #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */
538    
539    #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */
540    
541    
542    
543    /* Motion based flags */
544    #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
545    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
546    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
547    #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
548    #define XVID_ME_HALFPELREFINE16       (1<< 4)
549    #define XVID_ME_HALFPELREFINE8        (1<< 6)
550    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
551    #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
552    #define XVID_ME_GME_REFINE            (1<< 9)
553    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
554    #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
555    #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
556    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
557    
558    /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
559    #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
560    #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
561    #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
562    #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
563    #define XVID_ME_EXTSEARCH_RD          (1<<18) /* perform RD-based search using square pattern enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
564    #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
565    
566    #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
567    #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
568    #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
569    #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
570    
571    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
572    #define XVID_ME_FASTREFINE16              (1<<25) /* use low-complexity refinement functions */
573    
574    /* XVID_ENC_CREATE param1 */
575    typedef struct {
576            int version;
577    
578            int profile;                 /* [in] profile@level; refer to XVID_PROFILE_xxx */
579            int width;                   /* [in] frame dimensions; width, pixel units */
580            int height;                  /* [in] frame dimensions; height, pixel units */
581    
582            int num_zones;               /* [in:opt] number of bitrate zones */
583            xvid_enc_zone_t * zones;     /*          ^^ zone array */
584    
585            int num_plugins;             /* [in:opt] number of plugins */
586            xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
587    
588            int num_threads;             /* [in:opt] number of threads */
589            int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
590    
591            int global;                  /* [in:opt] global flags; controls encoding behavior */
592    
593            /* --- vol-based stuff; included here for convenience */
594            int fincr;                   /* [in:opt] framerate increment; set to zero for variable framerate */
595            int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
596        /* ---------------------------------------------- */
597    
598            /* --- vop-based; included here for convenience */
599            int max_key_interval;        /* [in:opt] the maximum interval between key frames */
600    
601            int frame_drop_ratio;        /* [in:opt] frame dropping: 0=drop none... 100=drop all */
602    
603            int bquant_ratio;            /* [in:opt] bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
604            int bquant_offset;           /* bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
605    
606            int min_quant[3];            /* [in:opt] */
607            int max_quant[3];            /* [in:opt] */
608            /* ---------------------------------------------- */
609    
610            void *handle;                /* [out] encoder instance handle */
611    }
612    xvid_enc_create_t;
613    
614    
615    #define XVID_KEYFRAME (1<<1)
616    
617    typedef struct {
618            int version;
619    
620            /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any changes here until the next VOL (keyframe). */
621            int vol_flags;                     /* [in] vol flags */
622            unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
623            unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
624    
625            int par;                           /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */
626            int par_width;                     /* [in:opt] aspect ratio width */
627            int par_height;                    /* [in:opt] aspect ratio height */
628            /* ---------------------------------------------- */
629    
630            int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
631            int vop_flags;                     /* [in] (general)vop-based flags */
632            int motion;                        /* [in] ME options */
633    
634            xvid_image_t input;                /* [in] input image (read from) */
635    
636            int type;                          /* [in:opt] coding type */
637            int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
638            int bframe_threshold;
639    
640            void *bitstream;                   /* [in:opt] bitstream ptr (written to)*/
641            int length;                        /* [in:opt] bitstream length (bytes) */
642    
643            int out_flags;                     /* [out] bitstream output flags */
644    } xvid_enc_frame_t;
645    
646    
647    /* XVID_ENC_ENCODE param2 (optional)
648            xvid_enc_stats_t describes individual frame details
649    
650            coding_type==XVID_TYPE_NOTHING if the stats are not given
651    */
652    typedef struct {
653            int version;
654    
655            /* encoding parameters */
656            int type;      /* [out] coding type */
657            int quant;     /* [out] frame quantizer */
658            int vol_flags; /* [out] vol flags (see above) */
659            int vop_flags; /* [out] vop flags (see above) */
660    
661            /* bitrate */
662            int length;    /* [out] frame length */
663    
664            int hlength;   /* [out] header length (bytes) */
665            int kblks;     /* [out] number of blocks compressed as Intra */
666            int mblks;     /* [out] number of blocks compressed as Inter */
667            int ublks;     /* [out] number of blocks marked as not_coded */
668    
669            int sse_y;     /* [out] Y plane's sse */
670            int sse_u;     /* [out] U plane's sse */
671            int sse_v;     /* [out] V plane's sse */
672    } xvid_enc_stats_t;
673    
674  #ifdef __cplusplus  #ifdef __cplusplus
675  }  }
676  #endif  #endif
677    
678    
679  #endif  #endif

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.27.2.50

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