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

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

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