[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.19, Sat May 17 13:26:28 2003 UTC
# Line 26  Line 26 
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 52  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    
86  #define XVID_CSP_VFLIP  0x80000000 /* flip mask */  
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    /* video-object-sequence profiles */
120    #define XVID_PROFILE_S_L0       0x08    /* simple */
121    #define XVID_PROFILE_S_L1       0x01
122    #define XVID_PROFILE_S_L2       0x02
123    #define XVID_PROFILE_S_L3       0x03
124    #define XVID_PROFILE_ARTS_L1    0x91    /* advanced realtime simple */
125    #define XVID_PROFILE_ARTS_L2    0x92
126    #define XVID_PROFILE_ARTS_L3    0x93
127    #define XVID_PROFILE_ARTS_L4    0x94
128    #define XVID_PROFILE_AS_L0      0xf0    /* advanced simple */
129    #define XVID_PROFILE_AS_L1      0xf1
130    #define XVID_PROFILE_AS_L2      0xf2
131    #define XVID_PROFILE_AS_L3      0xf3
132    #define XVID_PROFILE_AS_L4      0xf4
133    
134    /* aspect ratios */
135    #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */
136    #define XVID_PAR_43_PAL     2   /* 4:3 pal (12:11 625-line) */
137    #define XVID_PAR_43_NTSC        3       /* 4:3 ntsc (10:11 525-line) */
138    #define XVID_PAR_169_PAL        4       /* 16:9 pal (16:11 625-line) */
139    #define XVID_PAR_169_NTSC       5       /* 16:9 ntsc (40:33 525-line) */
140    #define XVID_PAR_EXT            15      /* extended par; use par_width, par_height */
141    
142    /* frame type flags */
143    #define XVID_TYPE_VOL           -1              /* decoder only: vol was decoded */
144    #define XVID_TYPE_NOTHING       0               /* decoder only (encoder stats): nothing was decoded/encoded */
145    #define XVID_TYPE_AUTO          0               /* encoder: automatically determine coding type */
146    #define XVID_TYPE_IVOP          1               /* intra frame */
147    #define XVID_TYPE_PVOP          2               /* predicted frame */
148    #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */
149    #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */
150    
151    
152  /*****************************************************************************  /*****************************************************************************
153   *  Initialization constants   * xvid_global()
154   ****************************************************************************/   ****************************************************************************/
155    
156  /* CPU flags for XVID_INIT_PARAM.cpu_flags */  /* cpu_flags definitions */
157    
158  #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 */  
159  #define XVID_CPU_ASM       0x00000080  /* native assembly */  #define XVID_CPU_ASM       0x00000080  /* native assembly */
   
160  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
161  #define XVID_CPU_MMX      0x00000001   /* mmx      : pentiumMMX,k6 */  #define XVID_CPU_MMX      0x00000001   /* mmx      : pentiumMMX,k6 */
162  #define XVID_CPU_MMXEXT   0x00000002   /* mmx-ext  : pentium2, athlon */  #define XVID_CPU_MMXEXT   0x00000002   /* mmx-ext  : pentium2, athlon */
# Line 98  Line 165 
165  #define XVID_CPU_3DNOW    0x00000010   /* 3dnow    : k6-2 */  #define XVID_CPU_3DNOW    0x00000010   /* 3dnow    : k6-2 */
166  #define XVID_CPU_3DNOWEXT 0x00000020   /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT 0x00000020   /* 3dnow-ext: athlon */
167  #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 */  
   
168  /* ARCH_IS_PPC */  /* ARCH_IS_PPC */
169  #define XVID_CPU_ALTIVEC  0x00000001   /* altivec */  #define XVID_CPU_ALTIVEC  0x00000001   /* altivec */
170    
171    
172          typedef struct  #define XVID_DEBUG_ERROR       0x00000001
173          {  #define XVID_DEBUG_STARTCODE   0x00000002
174                  int colorspace;  #define XVID_DEBUG_HEADER      0x00000004
175                  void * y;  #define XVID_DEBUG_TIMECODE    0x00000008
176                  void * u;  #define XVID_DEBUG_MB          0x00000010
177                  void * v;  #define XVID_DEBUG_COEFF       0x00000020
178                  int y_stride;  #define XVID_DEBUG_MV          0x00000040
179                  int uv_stride;  #define XVID_DEBUG_RC          0x00000080
180          } XVID_IMAGE;      /* from yv12 */  #define XVID_DEBUG_DEBUG       0x80000000
181    
182  #define XVID_INIT_INIT    0  /* XVID_GBL_INIT param1 */
183  #define XVID_INIT_CONVERT 1  typedef struct {
184  #define XVID_INIT_TEST    2          int version;
185            int cpu_flags;                  /* [in:opt]     zero = autodetect cpu
186                                                                            XVID_CPU_FORCE|{cpu features} = force cpu features */
187        int debug;              /* [in:opt] debug level */
188    } xvid_gbl_init_t;
189    
190    
191    /* XVID_GBL_INFO param1 */
192    typedef struct {
193            int version;
194            int actual_version;             /* [out]        returns the actual xvidcore version */
195            const char * build;             /* [out]        if !null, points to description of this xvid core build */
196            int cpu_flags;                  /* [out]        detected cpu features */
197            int num_threads;                /* [out]        detected number of cpus/threads */
198    } xvid_gbl_info_t;
199    
200    
201    /* XVID_GBL_CONVERT param1 */
202    typedef struct {
203            int version;
204            xvid_image_t input;     /* [in] input image & colorspace */
205            xvid_image_t output;    /* [in] output image & colorspace */
206            int width;                              /* [in] width */
207            int height;                             /* [in] height */
208            int interlacing;                /* [in] interlacing */
209    } xvid_gbl_convert_t;
210    
211    
212    #define XVID_GBL_INIT           0       /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
213    #define XVID_GBL_INFO           1       /* return some info about xvidcore, and the host computer */
214    #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
215    #define XVID_GBL_TEST           3       /* testing.. */
216    
217    int xvid_global(void *handle, int opt, void *param1, void *param2);
218    
219    
220  /*****************************************************************************  /*****************************************************************************
221   *  Initialization structures   * xvid_decore()
222   ****************************************************************************/   ****************************************************************************/
223    
224    #define XVID_DEC_CREATE     0   /* create decore instance; return 0 on success */
225    #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */
226    #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */
227    
228    int xvid_decore(void *handle, int opt, void *param1, void *param2);
229    
230    /* XVID_DEC_CREATE param 1
231            image width & height may be specified here when the dimensions are
232            known in advance. */
233    typedef struct {
234            int version;
235            int width;                              /* [in:opt]     image width */
236            int height;                             /* [in:opt]     image width */
237            void * handle;                  /* [out]        decore context handle */
238    } xvid_dec_create_t;
239    
240    
241    /* XVID_DEC_DECODE param1 */
242    /* general flags */
243    #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */
244    #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */
245    
246    typedef struct {
247            int version;
248            int general;                    /* [in:opt] general flags */
249            void *bitstream;                /* [in] bitstream (read from)*/
250            int length;                             /* [in] bitstream length */
251            xvid_image_t output;    /* [in] output image (written to) */
252    }
253    xvid_dec_frame_t;
254    
255    
256    /* XVID_DEC_DECODE param2 :: optional */
257          typedef struct          typedef struct
258          {          {
259                  int cpu_flags;          int version;
260                  int api_version;          int type;                               /* [out]        output data type */
261                  int core_build;          union {
262          } XVID_INIT_PARAM;                  struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
263                            int general;            /* [out]        flags */
264                            int time_base;          /* [out]        time base */
265                            int time_increment;     /* [out]        time increment */
266    
267                            /* XXX: external deblocking stuff */
268                            int * qscale;   /* [out]        pointer to quantizer table */
269                            int qscale_stride;              /* [out]        quantizer scale stride */
270    
271                    } vop;
272                    struct {        /* XVID_TYPE_VOL */
273                            int general;            /* [out]        flags */
274                            int width;                      /* [out]        width */
275                            int height;                     /* [out]        height */
276                            int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */
277                            int par_width;          /* [out]        aspect ratio width */
278                            int par_height;         /* [out]        aspect ratio height */
279                    } vol;
280            } data;
281    } xvid_dec_stats_t;
282    
283    
284    
285    #define XVID_ZONE_QUANT     1
286    #define XVID_ZONE_WEIGHT    2
287          typedef struct          typedef struct
288          {          {
289                  XVID_IMAGE input;      int frame;
290                  XVID_IMAGE output;      int mode;
291                  int width;      int increment;
292                  int height;      int base;
293                  int interlacing;  } xvid_enc_zone_t;
         } XVID_INIT_CONVERTINFO;  
   
 /*****************************************************************************  
  *  Initialization entry point  
  ****************************************************************************/  
294    
         int xvid_init(void *handle,  
                                   int opt,  
                                   void *param1,  
                                   void *param2);  
295    
296    
297  /*****************************************************************************  /*****************************************************************************
298   * Decoder constants    xvid plugin system -- internals
299    
300      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
301      before encoding each frame xvidcore will call XVID_PLG_BEFORE
302      after encoding each frame xvidcore will call XVID_PLG_AFTER
303      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
304   ****************************************************************************/   ****************************************************************************/
305    
 /* Flags for XVID_DEC_FRAME.general */  
 #define XVID_DEC_LOWDELAY      0x00000001 /* decode lowdelay mode (ie. VFW) */  
 #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  
306    
307  /*****************************************************************************  #define XVID_PLG_CREATE     0
308   * Decoder structures  #define XVID_PLG_DESTROY    1
309   ****************************************************************************/  #define XVID_PLG_INFO       2
310    #define XVID_PLG_BEFORE     3
311    #define XVID_PLG_AFTER      4
312    
313    /* xvid_plg_info_t.flags */
314    #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */
315    #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/
316    #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */
317    
318    
319          typedef struct          typedef struct
320          {          {
321                  int width;      int version;
322                  int height;      int flags;              /* [in:opt] plugin flags */
323                  void *handle;  } xvid_plg_info_t;
         } XVID_DEC_PARAM;  
   
324    
 #define XVID_DEC_VOP     0  
 #define XVID_DEC_VOL     1  
 #define XVID_DEC_NOTHING 2 /* nothing was decoded */  
325    
326          typedef struct          typedef struct
327          {          {
328                  int notify;                 /* [out] output 'mode' */      int version;
329                  union  
330                  {      int num_zones;          /* [out] */
331                          struct /* XVID_DEC_VOP */      xvid_enc_zone_t * zones;    /* [out] */
332                          {  
333                                  int time_base;      /* [out] time base */      int width;              /* [out] */
334                                  int time_increment; /* [out] time increment */      int height;             /* [out] */
335                          } vop;      int mb_width;           /* [out] */
336                          struct /* XVID_DEC_VOL */      int mb_height;          /* [out] */
337                          {          int fincr;              /* [out] */
338                                  int general;        /* [out] flags: eg. frames are interlaced */      int fbase;              /* [out] */
339                                  int width;          /* [out] width */  
340                                  int height;         /* [out] height */      void * param;           /* [out] */
341                                  int aspect_ratio;   /* [out] aspect ratio */  } xvid_plg_create_t;
                                 int par_width;      /* [out] aspect ratio width */  
                                 int par_height;     /* [out] aspect ratio height */  
                         } vol;  
                 } data;  
         } XVID_DEC_STATS;  
342    
343    
344          typedef struct          typedef struct
345          {          {
346                  int general;      int version;
                 void *bitstream;  
                 int length;  
347    
348                  void *image;      int num_frames;          /* [out] totlal frame encoded */
349                  int stride;  } xvid_plg_destroy_t;
                 int colorspace;  
         } XVID_DEC_FRAME;  
350    
351    
         /* This struct is used for per slice rendering */  
352          typedef struct          typedef struct
353          {          {
354                  void *y,*u,*v;      int version;
355                  int stride_y, stride_u,stride_v;  
356          } XVID_DEC_PICTURE;      xvid_enc_zone_t * zone;    /* [out] current zone */
357    
358        int width;              /* [out] */
359        int height;             /* [out] */
360        int mb_width;           /* [out] */
361        int mb_height;          /* [out] */
362            int fincr;              /* [out] */
363        int fbase;              /* [out] */
364    
365        int min_quant[3];       /* [out] */
366        int max_quant[3];       /* [out] */
367    
368        xvid_image_t reference; /* [out] -> [out] */
369        xvid_image_t current;   /* [out] -> [in,out] */
370        xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
371        int frame_num;          /* [out] frame number */
372    
373        int type;               /* [in,out] */
374        int quant;              /* [in,out] */
375    
376        int * dquant;               /* [in,out]     pointer to diff quantizer table */
377            int dquant_stride;              /* [in,out]     diff quantizer stride */
378    
379        int vop_flags;          /* [in,out] */
380        int vol_flags;          /* [in,out] */
381        int motion_flags;       /* [in,out] */
382    
383        int length;                 /* [out] after: length of encoded frame */
384        int kblks, mblks, ublks;    /* [out] after: */
385        int sse_y, sse_u, sse_v;    /* [out] */
386    } xvid_plg_data_t;
387    
388    
389  /*****************************************************************************  /*****************************************************************************
390   * Decoder entry point    xvid plugin system -- external
391    
392      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
393      indicates the plugin function pointer and plugin-specific data.
394      xvidcore handles the rest. example:
395    
396      xvid_enc_create_t create;
397      xvid_enc_plugin_t plugins[2];
398    
399      plugins[0].func = xvid_psnr_func;
400      plugins[0].param = NULL;
401      plugins[1].func = xvid_cbr_func;
402      plugins[1].param = &cbr_data;
403    
404      create.num_plugins = 2;
405      create.plugins = plugins;
406    
407   ****************************************************************************/   ****************************************************************************/
408    
409  /* decoder options */  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
410  #define XVID_DEC_DECODE  0  
411  #define XVID_DEC_CREATE  1  typedef struct
412  #define XVID_DEC_DESTROY 2  {
413        xvid_plugin_func * func;
414          int xvid_decore(void *handle,      void * param;
415                                          int opt,  } xvid_enc_plugin_t;
416                                          void *param1,  
417                                          void *param2);  
418    xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
419    xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
420    xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
421    
422    xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
423    
424    xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */
425    xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
426    
427    
428    
429    typedef struct          /* single pass rate control */
430    {
431        int version;
432        int bitrate;                                /* bits per second */
433        int reaction_delay_factor;
434        int averaging_period;
435        int buffer;
436    } xvid_plugin_single_t;
437    
438    
439    typedef struct {
440        int version;
441        char * filename;
442    } xvid_plugin_2pass1_t;
443    
444    
445    #define XVID_CURVE_COSINE   0   /* low aggressiveness */
446    #define XVID_CURVE_LINEAR   1   /* medium aggressiveness */
447    #define XVID_CURVE_SINE     2   /* high aggressiveness */
448    
449    #define XVID_PAYBACK_BIAS   0   /* payback with bias */
450    #define XVID_PAYBACK_PROP   1   /* payback proportionally */
451    
452    typedef struct {
453        int version;
454        int bitrate;                                /* bits per second */
455        char * filename;
456    
457        int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */
458        int payback_method;
459        int bitrate_payback_delay;
460        int curve_compression_high;
461        int curve_compression_low;
462        int max_overflow_improvement;
463        int max_overflow_degradation;
464    
465        int use_alt_curve;
466            int alt_curve_high_dist;
467            int alt_curve_low_dist;
468        int alt_curve_use_auto;
469            int alt_curve_auto_str;
470            int alt_curve_type; /* XVID_CURVE_ */
471            int alt_curve_min_rel_qual;
472            int alt_curve_use_auto_bonus_bias;
473        int alt_curve_bonus_bias;
474    
475        int kftreshold;
476            int kfreduction;
477        int min_key_interval;
478    }xvid_plugin_2pass2_t;
479    
480    
481  /*****************************************************************************  /*****************************************************************************
482   * Encoder constants   * xvid_encore()
483   ****************************************************************************/   ****************************************************************************/
484    
485  /* Flags for XVID_ENC_PARAM.global */  /* Encoder options */
486  #define XVID_GLOBAL_PACKED      0x00000001 /* packed bitstream */  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
487  #define XVID_GLOBAL_DX50BVOP    0x00000002 /* dx50 bvop compatibility */  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
488  #define XVID_GLOBAL_DEBUG       0x00000004 /* print debug info on each frame */  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
489  #define XVID_GLOBAL_REDUCED     0x04000000 /* reduced resolution vop enable */                                                                          0 means this frame should not be written (ie. encoder lag) */
490    
491  #define XVID_GLOBAL_EXTRASTATS  0x00000200 /* generate extra statistics */  int xvid_encore(void *handle, int opt, void *param1, void *param2);
492    
493    
494  /* Flags for XVID_ENC_FRAME.general */  /* global flags  */
495  #define XVID_VALID_FLAGS        0x80000000  typedef enum
496    {
497        XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */
498        XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
499        XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004
500    /*define XVID_GLOBAL_VOL_AT_IVOP        0x00000008       write vol at every ivop: WIN32/divx compatibility */
501    /*define XVID_GLOBAL_FORCE_VOL          0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
502    } xvid_global_t;
503    
 #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  
504    
505  #define XVID_INTERLACING        0x00000400 /* enable interlaced encoding */  /* XVID_ENC_ENCODE param1 */
506  #define XVID_TOPFIELDFIRST      0x00000800 /* set top-field-first flag  */  /* vol-based flags */
507  #define XVID_ALTERNATESCAN      0x00001000 /* set alternate vertical scan flag */  typedef enum {
508        XVID_VOL_MPEGQUANT          = 0x00000001,
509        XVID_VOL_EXTRASTATS         = 0x00000002,
510        XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
511        XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
512        XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
513        XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */
514    } xvid_vol_t;
515    
 #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) */  
516    
517  #define XVID_INTER4V            0x00008000  /* vop-based flags */
518    typedef enum {
519        XVID_VOP_DEBUG              = 0x00000001,
520    
521  #define XVID_ME_ZERO            0x00010000      XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */
522  #define XVID_ME_LOGARITHMIC     0x00020000      XVID_VOP_INTER4V            = 0x00000008,
 #define XVID_ME_FULLSEARCH      0x00040000  
 #define XVID_ME_PMVFAST         0x00080000  
 #define XVID_ME_EPZS            0x00100000  
523    
524  #define XVID_CHROMAOPT          0x00200000 /* enable chroma optimization pre-filter */      XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */
525    
526  #define XVID_GREYSCALE          0x01000000 /* enable greyscale only mode (even for      XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
527        XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
528                                                color input material chroma is ignored) */                                                color input material chroma is ignored) */
529        XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
530        XVID_VOP_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
531    
532  #define XVID_GMC                0x10000000          /* only valid for vol_flags|=XVID_VOL_INTERLACING */
533  #define XVID_GMC_TRANSLATIONAL  0x20000000      XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
534        XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
535    
536  #define XVID_REDUCED            0x04000000 /* reduced resolution vop */      /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
537  #define XVID_HQACPRED           0x08000000 /* 20030209: high quality ac prediction */      XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */
538    } xvid_vop_t;
539    
 #define XVID_EXTRASTATS         0x00000200 /* generate extra statistics */  
540    
541  #define XVID_MODEDECISION_BITS  0x00400000 /* enable DCT-ME and use it for mode decision */  typedef enum {
542        XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
543        XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
544    
545        XVID_ME_HALFPELREFINE16     = 0x00020000,
546        XVID_ME_HALFPELREFINE8      = 0x02000000,
547    
548  /* Flags for XVID_ENC_FRAME.motion */      XVID_ME_QUARTERPELREFINE16  = 0x00040000,
549  #define PMV_ADVANCEDDIAMOND16   0x00008000 /* use advdiamonds instead of diamonds as search pattern */      XVID_ME_QUARTERPELREFINE8   = 0x04000000,
 #define PMV_USESQUARES16        0x00800000 /* use squares instead of diamonds as search pattern */  
550    
551  #define PMV_HALFPELREFINE16     0x00020000      XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
 #define PMV_HALFPELREFINE8      0x02000000  
552    
553  #define PMV_QUARTERPELREFINE16  0x00040000      XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
554  #define PMV_QUARTERPELREFINE8   0x04000000      XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */
555        XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */
556    
557  #define PMV_EXTSEARCH16         0x00080000 /* extend PMV by more searches */      XVID_ME_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
558        XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
559    
560  #define PMV_EXTSEARCH8          0x08000000 /* use diamond/square for extended 8x8 search */      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
561  #define PMV_ADVANCEDDIAMOND8    0x00004000 /* use advdiamond for PMV_EXTSEARCH8 */      XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
562  #define PMV_USESQUARES8         0x80000000 /* use square for PMV_EXTSEARCH8 */      XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
563        XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
564        XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
565    
566  #define PMV_CHROMA16            0x00100000 /* also use chroma for P_VOP/S_VOP ME */      XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
567  #define PMV_CHROMA8             0x10000000 /* also use chroma for B_VOP ME */                                                    enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
568        XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
569    
570  /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */      XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
571  #define HALFPELREFINE16_BITS    0x00000100 /* perform DCT-based halfpel refinement */      XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
572  #define HALFPELREFINE8_BITS     0x00000200 /* perform DCT-based halfpel refinement for 8x8 mode */      XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
573  #define QUARTERPELREFINE16_BITS 0x00000400 /* perform DCT-based qpel refinement */      XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
574  #define QUARTERPELREFINE8_BITS  0x00000800 /* perform DCT-based qpel refinement for 8x8 mode */  } xvid_motion_t;
575    
 #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 */  
576    
577    /* XVID_ENC_CREATE param1 */
578    typedef struct {
579            int version;
580    
581  /* note: old and deprecated - or never implemented */      int profile;            /* [in]     profile@level; refer to XVID_PROFILE_xxx */
582            int width;                              /* [in]         frame dimensions; width, pixel units */
583            int height;                             /* [in]         frame dimensions; height, pixel units */
584    
585  /* only for compatability with old encoders */      int num_zones;          /* [in:opt] number of bitrate zones */
586        xvid_enc_zone_t * zones; /*             ^^ zone array */
587    
588  #define PMV_EARLYSTOP16         0x00      int num_plugins;        /* [in:opt] number of plugins */
589  #define PMV_EARLYSTOP8          0x00      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
 #define PMV_QUICKSTOP16         0x00  
 #define PMV_QUICKSTOP8          0x00  
590    
591  #define PMV_HALFPELDIAMOND16    0x00          int num_threads;                /* [in:opt]     number of threads */
592  #define PMV_HALFPELDIAMOND8     0x00          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
593    
594  #define PMV_UNRESTRICTED16      0x00200000 /* unrestricted ME, not implemented */          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */
 #define PMV_OVERLAPPING16       0x00400000 /* overlapping ME, not implemented */  
 #define PMV_UNRESTRICTED8       0x20000000 /* unrestricted ME, not implemented */  
 #define PMV_OVERLAPPING8        0x40000000 /* overlapping ME, not implemented */  
595    
596  #define XVID_ME_COLOUR          0x00       /* this has been converted to PMV_CHROMA[16/8] */  /* --- vol-based stuff; included here for conveinience */
597            int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
598            int fbase;                              /* [in] framerate base
599                                                                                    frame_duration = fincr/fbase seconds*/
600    /* ^^^---------------------------------------------- */
601    
602    
603  /*****************************************************************************  /* ---vop-based; included here for conveienience */
604   * Encoder structures          int max_key_interval;   /* [in:opt] the maximum interval between key frames */
605   ****************************************************************************/                                                                                  /*XXX: maybe call it gop_size? */
606    
607            int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
608    
609            int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
610            int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
611    
612        int min_quant[3];       /* [in:opt] */
613        int max_quant[3];       /* [in:opt] */
614    
615    /* ^^^ -------------------------------------------------------------------------*/
616    
         typedef struct  
         {  
                 int width, height;  
                 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 */  
617                  void *handle;                 /* [out] encoder instance handle */                  void *handle;                 /* [out] encoder instance handle */
618          } XVID_ENC_PARAM;  }
619    xvid_enc_create_t;
620    
         typedef struct  
         {  
                 int x;  
                 int y;  
         } VECTOR;  
621    
622          typedef struct  #define XVID_KEYFRAME   0x00000001
         {  
                 int mode;      /* macroblock mode */  
                 VECTOR mvs[4];  
         } MVBLOCKHINT;  
623    
624          typedef struct  typedef struct {
625          {          int version;
                 int intra;          /* frame intra choice */  
                 int fcode;          /* frame fcode */  
                 MVBLOCKHINT *block; /* caller-allocated array of block hints (mb_width * mb_height) */  
         } MVFRAMEHINT;  
626    
627          typedef struct  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any
628          {                  changes here until the next VOL (keyframe). */
629                  int rawhints;       /* if set, use MVFRAMEHINT, else use compressed buffer */          xvid_vol_t vol_flags;                   /* [in] vol flags */
630            unsigned char *
631                    quant_intra_matrix;     /* [in:opt] custom intra qmatrix */
632            unsigned char *
633                    quant_inter_matrix;     /* [in:opt] custom inter qmatrix */
634    
635                  MVFRAMEHINT mvhint;          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
636                  void *hintstream;   /* compressed hint buffer */          int par_width;                  /* [in:opt] aspect ratio width */
637                  int hintlength;     /* length of buffer (bytes) */          int par_height;                 /* [in:opt] aspect ratio height */
638          } HINTINFO;  /* ^^^----------------------------------------------------------------------------------*/
639    
640          typedef struct      int fincr;                          /* framerate increment, for variable framerate only */
641          {          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
642                  int general;                       /* [in] general options */          xvid_motion_t motion;                           /* [in] ME 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)  
                                             */  
                 HINTINFO hint;                     /* [in/out] mv hint information */  
643    
644                  int bquant;                        /* [in] bframe quantizer */          xvid_image_t input;     /* [in] input image (read from) */
645    
646          } XVID_ENC_FRAME;          int type;                               /* [in:opt] coding type */
647            int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
648            int bframe_threshold;
649    
650            void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
651            int length;                             /* [in:opt] bitstream length (bytes) */
652    
653          typedef struct          int out_flags;                          /* [out] bitstream output flags */
654          {  }
655                  int quant;   /* [out] frame quantizer */  xvid_enc_frame_t;
                 int hlength; /* [out] header length (bytes) */  
                 int kblks;   /* [out] number of intra blocks */  
                 int mblks;   /* [out] number of inter blocks */  
                 int ublks;       /* [out] number of "not coded" blocks */  
                 long sse_y;  /* [out] SSE of Y */  
                 long sse_u;  /* [out] SSE of Cb */  
                 long sse_v;  /* [out] SSE of Cr */  
         } XVID_ENC_STATS;  
656    
657    
658  /*****************************************************************************  /* XVID_ENC_ENCODE param2 (optional)
659   * Encoder entry point          xvid_enc_stats_t describes individual frame details
  ****************************************************************************/  
660    
661  /* Encoder options */          coding_type==XVID_TYPE_NOTHING if the stats are not given
662  #define XVID_ENC_ENCODE  0  */
663  #define XVID_ENC_CREATE  1  typedef struct {
664  #define XVID_ENC_DESTROY 2          int version;
665    
666          int xvid_encore(void *handle,          /* encoding parameters */
667                                          int opt,          int type;                                       /* [out] coding type */
668                                          void *param1,          int quant;                                      /* [out] frame quantizer */
669                                          void *param2);          xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */
670            int vop_flags;                          /* [out] vop flags (see above) */
671            /* bitrate */
672            int length;                                     /* [out] frame length */
673    
674            int hlength;                            /* [out] header length (bytes) */
675            int kblks, mblks, ublks;        /* [out] */
676    
677        int sse_y, sse_u, sse_v;
678    }
679    xvid_enc_stats_t;
680    
681  #ifdef __cplusplus  #ifdef __cplusplus
682  }  }
683  #endif  #endif
684    
685    
686  #endif  #endif

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

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