[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.2.4, Tue Mar 11 20:15:40 2003 UTC revision 1.27.2.42, Sun Nov 9 20:49:21 2003 UTC
# Line 3  Line 3 
3   *  XVID MPEG-4 VIDEO CODEC   *  XVID MPEG-4 VIDEO CODEC
4   *  - XviD Main header file -   *  - XviD Main header file -
5   *   *
6   *  This file is part of XviD, a free MPEG-4 video encoder/decoder   *  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
# 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
# Line 48  Line 49 
49          */          */
50    
51  #define XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )  #define XVID_MAKE_VERSION(a,b,c)        ( (((a)&0xff)<<16) | (((b)&0xff)<<8) | ((c)&0xff) )
52  #define XVID_MAJOR(a)                           ( ((a)>>16) & 0xff )  #define XVID_VERSION_MAJOR(a)    ((char)(((a)>>16) & 0xff))
53  #define XVID_MINOR(b)                           ((char)( ((b)>>8) & 0xff ))  #define XVID_VERSION_MINOR(a)    ((char)(((a)>> 8) & 0xff))
54  #define XVID_PATCH(c)                           ( (c) & 0xff )  #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,-127,0)  #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)
61    #define XVID_API                 XVID_MAKE_API(4, 0)
62    
63  #define XVID_UNSTABLE  #define XVID_UNSTABLE
64    
65  /* Bitstream Version  /* Bitstream Version
# Line 66  Line 73 
73   * doesnt hurt but not increasing it could cause difficulty for decoders in the   * doesnt hurt but not increasing it could cause difficulty for decoders in the
74   * future   * future
75   */   */
76  #define XVID_BS_VERSION "0009"  #define XVID_BS_VERSION "0020"
77    
78    
79  /*****************************************************************************  /*****************************************************************************
# Line 89  Line 96 
96    
97  /* colorspace values */  /* colorspace values */
98    
99  #define XVID_CSP_USER           0       /* 4:2:0 planar */  #define XVID_CSP_USER     (1<< 0) /* 4:2:0 planar */
100  #define XVID_CSP_I420           1       /* 4:2:0 packed(planar win32) */  #define XVID_CSP_I420     (1<< 1) /* 4:2:0 packed(planar win32) */
101  #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */  #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 packed(planar win32) */
102  #define XVID_CSP_YUY2           3       /* 4:2:2 packed */  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */
103  #define XVID_CSP_UYVY           4       /* 4:2:2 packed */  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */
104  #define XVID_CSP_YVYU           5       /* 4:2:2 packed */  #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */
105  #define XVID_CSP_BGRA           6       /* 32-bit bgra packed */  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
106  #define XVID_CSP_ABGR           7       /* 32-bit abgr packed */  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
107  #define XVID_CSP_RGBA           8       /* 32-bit rgba packed */  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
108  #define XVID_CSP_BGR            9       /* 32-bit bgr packed */  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
109  #define XVID_CSP_RGB555     10  /* 16-bit rgb555 packed */  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
110  #define XVID_CSP_RGB565     11  /* 16-bit rgb565 packed */  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
111  #define XVID_CSP_SLICE          12      /* decoder only: 4:2:0 planar, per slice rendering */  #define XVID_CSP_SLICE    (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */
112  #define XVID_CSP_INTERNAL       13      /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */  #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
113  #define XVID_CSP_NULL           14      /* decoder only: dont output anything */  #define XVID_CSP_NULL     (1<<14) /* decoder only: dont output anything */
114  #define XVID_CSP_VFLIP  0x80000000      /* vertical flip mask */  #define XVID_CSP_VFLIP    (1<<31) /* vertical flip mask */
115    
116  /* xvid_image_t  /* xvid_image_t
117          for non-planar colorspaces use only plane[0] and stride[0]          for non-planar colorspaces use only plane[0] and stride[0]
# Line 115  Line 122 
122          int stride[4];                  /* [in] image stride; "bytes per row"*/          int stride[4];                  /* [in] image stride; "bytes per row"*/
123  } xvid_image_t;  } 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 */  /* aspect ratios */
141  #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */  #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) */  #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) */  #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) */  #define XVID_PAR_169_PAL        4       /* 16:9 pal (16:11 625-line) */
# Line 133  Line 154 
154  #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */  #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */
155  #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */  #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */
156    
157    
158  /*****************************************************************************  /*****************************************************************************
159   * xvid_global()   * xvid_global()
160   ****************************************************************************/   ****************************************************************************/
161    
162  /* cpu_flags definitions */  /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
163    
164  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
165  #define XVID_CPU_ASM        0x00000080  /* native assembly */  #define XVID_CPU_ASM      (1<< 7) /* native assembly */
166  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
167  #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */  #define XVID_CPU_MMX      (1<< 0) /*       mmx : pentiumMMX,k6 */
168  #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
169  #define XVID_CPU_SSE        0x00000004   /* sse      : pentium3, athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
170  #define XVID_CPU_SSE2       0x00000008   /* sse2     : pentium4, athlon64 */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
171  #define XVID_CPU_3DNOW      0x00000010   /* 3dnow    : k6-2 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
172  #define XVID_CPU_3DNOWEXT   0x00000020   /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
173  #define XVID_CPU_TSC        0x00000040   /* timestamp counter */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
174  /* ARCH_IS_PPC */  /* ARCH_IS_PPC */
175  #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */  #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 */  /* XVID_GBL_INIT param1 */
189  typedef struct {  typedef struct {
190          int version;          int version;
191          int cpu_flags;                  /* [in:opt]     zero = autodetect cpu          unsigned int cpu_flags; /* [in:opt] zero = autodetect cpu; XVID_CPU_FORCE|{cpu features} = force cpu features */
192                                                                          XVID_CPU_FORCE|{cpu features} = force cpu features */          int debug;     /* [in:opt] debug level */
193  } xvid_gbl_init_t;  } xvid_gbl_init_t;
194    
195    
# Line 166  Line 198 
198          int version;          int version;
199          int actual_version;             /* [out]        returns the actual xvidcore version */          int actual_version;             /* [out]        returns the actual xvidcore version */
200          const char * build;             /* [out]        if !null, points to description of this xvid core build */          const char * build;             /* [out]        if !null, points to description of this xvid core build */
201          int cpu_flags;                  /* [out]        detected cpu features */          unsigned int cpu_flags;      /* [out] detected cpu features */
202          int num_threads;                /* [out]        detected number of cpus/threads */          int num_threads;                /* [out]        detected number of cpus/threads */
203  } xvid_gbl_info_t;  } xvid_gbl_info_t;
204    
# Line 185  Line 217 
217  #define XVID_GBL_INIT           0       /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */  #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 */  #define XVID_GBL_INFO           1       /* return some info about xvidcore, and the host computer */
219  #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */  #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
 #define XVID_GBL_TEST           3       /* testing.. */  
220    
221  int xvid_global(void *handle, int opt, void *param1, void *param2);  int xvid_global(void *handle, int opt, void *param1, void *param2);
222    
# Line 213  Line 244 
244    
245  /* XVID_DEC_DECODE param1 */  /* XVID_DEC_DECODE param1 */
246  /* general flags */  /* general flags */
247  #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
248  #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
249    
250  typedef struct {  typedef struct {
251          int version;          int version;
# Line 222  Line 253 
253          void *bitstream;                /* [in] bitstream (read from)*/          void *bitstream;                /* [in] bitstream (read from)*/
254          int length;                             /* [in] bitstream length */          int length;                             /* [in] bitstream length */
255          xvid_image_t output;    /* [in] output image (written to) */          xvid_image_t output;    /* [in] output image (written to) */
256  }  } xvid_dec_frame_t;
 xvid_dec_frame_t;  
257    
258    
259  /* XVID_DEC_DECODE param2 :: optional */  /* XVID_DEC_DECODE param2 :: optional */
260  typedef struct  typedef struct
261  {  {
262          int version;          int version;
263    
264          int type;                               /* [out]        output data type */          int type;                               /* [out]        output data type */
265          union {          union {
266                  struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */                  struct {        /* type>0 {XVID_TYPE_IVOP,XVID_TYPE_PVOP,XVID_TYPE_BVOP,XVID_TYPE_SVOP} */
# Line 238  Line 269 
269                          int time_increment;     /* [out]        time increment */                          int time_increment;     /* [out]        time increment */
270    
271                          /* XXX: external deblocking stuff */                          /* XXX: external deblocking stuff */
272                          unsigned char * qscale; /* [out]        pointer to quantizer table */                          int * qscale;       /* [out] pointer to quantizer table */
273                          int qscale_stride;              /* [out]        quantizer scale stride */                          int qscale_stride;              /* [out]        quantizer scale stride */
274    
275                  } vop;                  } vop;
# Line 255  Line 286 
286    
287    
288    
289    #define XVID_ZONE_QUANT  (1<<0)
290    #define XVID_ZONE_WEIGHT (1<<1)
291    
292    typedef struct
293    {
294            int frame;
295            int mode;
296            int increment;
297            int base;
298    } xvid_enc_zone_t;
299    
300    
301    
302    /*****************************************************************************
303      xvid plugin system -- internals
304    
305      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
306      before encoding each frame xvidcore will call XVID_PLG_BEFORE
307      after encoding each frame xvidcore will call XVID_PLG_AFTER
308      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
309     ****************************************************************************/
310    
311    
312    #define XVID_PLG_CREATE  (1<<0)
313    #define XVID_PLG_DESTROY (1<<1)
314    #define XVID_PLG_INFO    (1<<2)
315    #define XVID_PLG_BEFORE  (1<<3)
316    #define XVID_PLG_AFTER   (1<<4)
317    
318    /* xvid_plg_info_t.flags */
319    #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
320    #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
321    #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
322    
323    
324    typedef struct
325    {
326            int version;
327            int flags;   /* [in:opt] plugin flags */
328    } xvid_plg_info_t;
329    
330    
331    typedef struct
332    {
333            int version;
334    
335            int num_zones;           /* [out] */
336            xvid_enc_zone_t * zones; /* [out] */
337    
338            int width;               /* [out] */
339            int height;              /* [out] */
340            int mb_width;            /* [out] */
341            int mb_height;           /* [out] */
342            int fincr;               /* [out] */
343            int fbase;               /* [out] */
344    
345            void * param;            /* [out] */
346    } xvid_plg_create_t;
347    
348    
349    typedef struct
350    {
351            int version;
352    
353            int num_frames; /* [out] total frame encoded */
354    } xvid_plg_destroy_t;
355    
356    
357    typedef struct
358    {
359            int version;
360    
361            xvid_enc_zone_t * zone; /* [out] current zone */
362    
363            int width;              /* [out] */
364            int height;             /* [out] */
365            int mb_width;           /* [out] */
366            int mb_height;          /* [out] */
367            int fincr;              /* [out] */
368            int fbase;              /* [out] */
369    
370            int min_quant[3];       /* [out] */
371            int max_quant[3];       /* [out] */
372    
373            xvid_image_t reference; /* [out] -> [out] */
374            xvid_image_t current;   /* [out] -> [in,out] */
375            xvid_image_t original;  /* [out] after: points the original (uncompressed) copy of the current frame */
376            int frame_num;          /* [out] frame number */
377    
378            int type;               /* [in,out] */
379            int quant;              /* [in,out] */
380    
381            int * dquant;           /* [in,out]     pointer to diff quantizer table */
382            int dquant_stride;      /* [in,out]     diff quantizer stride */
383    
384            int vop_flags;          /* [in,out] */
385            int vol_flags;          /* [in,out] */
386            int motion_flags;       /* [in,out] */
387    
388            int length;             /* [out] after: length of encoded frame */
389            int kblks;              /* [out] number of blocks compressed as Intra */
390            int mblks;              /* [out] number of blocks compressed as Inter */
391            int ublks;              /* [out] number of blocks marked not_coded */
392            int sse_y;              /* [out] Y plane's sse */
393            int sse_u;              /* [out] U plane's sse */
394            int sse_v;              /* [out] V plane's sse */
395            int bquant_ratio;       /* [in] */
396            int bquant_offset;      /* [in] */
397    } xvid_plg_data_t;
398    
399    
400    /*****************************************************************************
401      xvid plugin system -- external
402    
403      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
404      indicates the plugin function pointer and plugin-specific data.
405      xvidcore handles the rest. example:
406    
407      xvid_enc_create_t create;
408      xvid_enc_plugin_t plugins[2];
409    
410      plugins[0].func = xvid_psnr_func;
411      plugins[0].param = NULL;
412      plugins[1].func = xvid_cbr_func;
413      plugins[1].param = &cbr_data;
414    
415      create.num_plugins = 2;
416      create.plugins = plugins;
417    
418     ****************************************************************************/
419    
420    typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
421    
422    typedef struct
423    {
424            xvid_plugin_func * func;
425            void * param;
426    } xvid_enc_plugin_t;
427    
428    
429    xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
430    xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
431    xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
432    
433    xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
434    
435    xvid_plugin_func xvid_plugin_psnr;      /* write psnr values to stdout */
436    xvid_plugin_func xvid_plugin_dump;      /* dump before and after yuvpgms */
437    
438    
439    /* single pass rate control
440     * CBR and Constant quantizer modes */
441    typedef struct
442    {
443            int version;
444    
445            int bitrate;               /* [in] bits per second */
446            int reaction_delay_factor; /* [in] */
447            int averaging_period;      /* [in] */
448            int buffer;                /* [in] */
449    } xvid_plugin_single_t;
450    
451    
452    typedef struct {
453            int version;
454    
455            char * filename;
456    } xvid_plugin_2pass1_t;
457    
458    
459    #define XVID_PAYBACK_BIAS 0 /* payback with bias */
460    #define XVID_PAYBACK_PROP 1 /* payback proportionally */
461    
462    typedef struct {
463            int version;
464    
465            int bitrate;                  /* [in] bits per second */
466            char * filename;              /* [in] first pass stats filename */
467    
468            int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
469            int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
470            int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
471            int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
472            int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
473            int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
474    
475            int kfreduction;              /* [in] */
476            int min_key_interval;         /* [in] Minimum interval of frames between two IFrames */
477    
478            int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
479    }xvid_plugin_2pass2_t;
480    
481    
482  /*****************************************************************************  /*****************************************************************************
483   * xvid_encore()   * xvid_encore()
484   ****************************************************************************/   ****************************************************************************/
# Line 263  Line 487 
487  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
488  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
489  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes  #define XVID_ENC_ENCODE     2   /* encode a frame: returns number of ouput bytes
490                                                                          0 means this frame should not be written (ie. encoder lag) */                              * 0 means this frame should not be written (ie. encoder lag) */
491    
492  int xvid_encore(void *handle, int opt, void *param1, void *param2);  int xvid_encore(void *handle, int opt, void *param1, void *param2);
493    
494    
495  /* global flags  */  
496  typedef enum  /* Global Flags */
497  {  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
498      XVID_PACKED                 = 0x00000001,   /* packed bitstream */  #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
499      XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
500      XVID_EXTRASTATS_ENABLE  = 0x00000004  #if 0
501  /*define XVID_VOL_AT_IVOP       0x00000008       write vol at every ivop: WIN32/divx compatibility */  #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
502  /*define XVID_FORCE_VOL         0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */  #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
503  } xvid_global_t;  #endif
504    
505    
506  /* XVID_ENC_ENCODE param1 */  /* XVID_ENC_ENCODE param1 */
507  /* vol-based flags */  /* vol-based flags */
508  typedef enum {  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
509      XVID_MPEGQUANT          = 0x00000001,  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
510      XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */  #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
511      XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */  #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
512      XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */  #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
513      XVID_INTERLACING        = 0x00000400, /* enable interlaced encoding */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
514  } xvid_vol_t;  
515    
516    
517  /* vop-based flags */  /* vop based flags */
518  typedef enum {  #define XVID_VOP_DEBUG           (1<< 0)
519      XVID_DEBUG              = 0x00000001,  #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */
520      XVID_EXTRASTATS         = 0x00000002,  #define XVID_VOP_INTER4V         (1<< 2)
521      XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */  #define XVID_VOP_TRELLISQUANT    (1<< 3) /* use trellis based R-D "optimal" quantization */
522      XVID_INTER4V            = 0x00000008,  #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */
523      XVID_LUMIMASKING        = 0x00000010,  #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */
524    #define XVID_VOP_GREYSCALE       (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
525      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */  #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */
526      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for  #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */
527                                                color input material chroma is ignored) */  /* only valid for vol_flags|=XVID_VOL_INTERLACING */
528      XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */  #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */
529      XVID_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */  #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */
530      XVID_DYNAMIC_BFRAMES    = 0x00000200,  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
531    #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */
532          /* only valid for vol_flags|=XVID_INTERLACING */  
533      XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */  #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */
534      XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */  
535    
536      /* only valid for vol_flags|=XVID_REDUCED_ENABLED */  
537      XVID_REDUCED            = 0x00001000, /* reduced resolution vop */  /* Motion based flags */
538  } xvid_vop_t;  #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
539    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
540    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
541  typedef enum {  #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
542      PMV_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */  #define XVID_ME_HALFPELREFINE16       (1<< 4)
543      PMV_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */  #define XVID_ME_HALFPELREFINE8        (1<< 6)
544    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
545      PMV_HALFPELREFINE16     = 0x00020000,  #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
546      PMV_HALFPELREFINE8      = 0x02000000,  #define XVID_ME_GME_REFINE            (1<< 9)
547    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
548      PMV_QUARTERPELREFINE16  = 0x00040000,  #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
549      PMV_QUARTERPELREFINE8   = 0x04000000,  #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
550    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
551      PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */  
552    /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
553      PMV_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
554      PMV_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */  #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
555      PMV_USESQUARES8         = 0x80000000, /* use square for PMV_EXTSEARCH8 */  #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
556    #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
557      PMV_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */  #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 */
558      PMV_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */  #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
559    
560      /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
561      HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */  #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
562      HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
563      QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
     QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */  
   
     EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern  
                                                   enable PMV_EXTSEARCH8 to do this in 8x8 search as well */  
     CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */  
   
     PMV_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */  
     PMV_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */  
     PMV_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */  
     PMV_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */  
 } xvid_motion_t;  
564    
565    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
566    #define XVID_ME_FASTREFINE16              (1<<25) /* use low-complexity refinement functions */
567    
568  /* XVID_ENC_CREATE param1 */  /* XVID_ENC_CREATE param1 */
569  typedef struct {  typedef struct {
570          int version;          int version;
571    
572            int profile;                 /* [in] profile@level; refer to XVID_PROFILE_xxx */
573          int width;                              /* [in]         frame dimensions; width, pixel units */          int width;                              /* [in]         frame dimensions; width, pixel units */
574          int height;                             /* [in]         frame dimensions; height, pixel units */          int height;                             /* [in]         frame dimensions; height, pixel units */
575    
576            int num_zones;               /* [in:opt] number of bitrate zones */
577            xvid_enc_zone_t * zones;     /*          ^^ zone array */
578    
579            int num_plugins;             /* [in:opt] number of plugins */
580            xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
581    
582          int num_threads;                /* [in:opt]     number of threads */          int num_threads;                /* [in:opt]     number of threads */
583          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
584    
585          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */          int global;                  /* [in:opt] global flags; controls encoding behavior */
586    
587  /* --- vol-based stuff; included here for conveinience */          /* --- vol-based stuff; included here for convenience */
588          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
589          int fbase;                              /* [in] framerate base          int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
590                                                                                  frame_duration = fincr/fbase seconds*/      /* ---------------------------------------------- */
 /* ^^^---------------------------------------------- */  
   
591    
592  /* ---vop-based; included here for conveienience */          /* --- vop-based; included here for convenience */
593          int max_key_interval;   /* [in:opt] the maximum interval between key frames */          int max_key_interval;   /* [in:opt] the maximum interval between key frames */
                                                                                 /*XXX: maybe call it gop_size? */  
594    
595          int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */          int frame_drop_ratio;   /* [in:opt]     frame dropping: 0=drop none... 100=drop all */
596    
597          int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */          int bquant_ratio;               /* [in:opt]     bframe quantizer multipier/offeset; used to decide bframes quant when bquant==-1 */
598          int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */          int bquant_offset;              /*                      bquant = (avg(past_ref_quant,future_ref_quant)*bquant_ratio + bquant_offset) / 100 */
599    
600  /* ^^^ -------------------------------------------------------------------------*/          int min_quant[3];            /* [in:opt] */
601            int max_quant[3];            /* [in:opt] */
602            /* ---------------------------------------------- */
603    
604          void *handle;                   /* [out] encoder instance handle */          void *handle;                   /* [out] encoder instance handle */
605  }  }
606  xvid_enc_create_t;  xvid_enc_create_t;
607    
608    
609  typedef struct {  #define XVID_KEYFRAME (1<<1)
         int version;  
         int type;                               /* [in] rate control type: XVID_RC_xxx */  
   
         /* common stuff */  
         int min_iquant;         /* [in:opt] ivop quantizer upper/lower limit */  
         int max_iquant;         /* [in:opt] */  
         int min_pquant;         /* [in:opt] psvop quantizer upper/lower limit */  
         int max_pquant;         /* [in:opt]  */  
         int min_bquant;         /* [in:opt] bvop quantizer upper/lower limit */  
         int max_bquant;         /* [in:opt] */  
   
         union {  
                 struct {        /* XVID_RC_FQUANT */  
                         float quant;                            /* [in] quantizer */  
                 } fquant;  
                 struct {        /* XVID_RC_CBR */  
                         int bitrate;                            /* [in] the bitrate of the target encoded stream, in bits/second */  
                         int reaction_delay_factor;      /* [in] how fast the rate control reacts - lower values are faster */  
                         int averaging_period;           /* [in] */  
                         int buffer;                                     /* [in] */  
                 } cbr;  
         } data;  
 } xvid_enc_rc_t;  
   
   
   
 #define XVID_KEYFRAME   0x00000001  
610    
611  typedef struct {  typedef struct {
612          int version;          int version;
613    
614  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any          /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any changes here until the next VOL (keyframe). */
615                  changes here until the next VOL (keyframe). */          int vol_flags;                     /* [in] vol flags */
616          xvid_vol_t vol_flags;                   /* [in] vol flags */          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
617          unsigned char *          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
                 quant_intra_matrix;     /* [in:opt] custom intra qmatrix */  
         unsigned char *  
                 quant_inter_matrix;     /* [in:opt] custom inter qmatrix */  
618    
619          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */
620          int par_width;                  /* [in:opt] aspect ratio width */          int par_width;                  /* [in:opt] aspect ratio width */
621          int par_height;                 /* [in:opt] aspect ratio height */          int par_height;                 /* [in:opt] aspect ratio height */
622  /* ^^^----------------------------------------------------------------------------------*/          /* ---------------------------------------------- */
623    
624          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
625          xvid_motion_t motion;                           /* [in] ME options */          int vop_flags;                     /* [in] (general)vop-based flags */
626            int motion;                        /* [in] ME options */
627    
628          xvid_image_t input;     /* [in] input image (read from) */          xvid_image_t input;     /* [in] input image (read from) */
629    
630          int type;                               /* [in:opt] coding type */          int type;                               /* [in:opt] coding type */
631          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
632          int bquant;                             /* [in:opt] bframe quantizer; if <=0, automatic*/          int bframe_threshold;
633    
634          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
635          int length;                             /* [in:opt] bitstream length (bytes) */          int length;                             /* [in:opt] bitstream length (bytes) */
636    
637          int out_flags;                          /* [out] bitstream output flags */          int out_flags;                          /* [out] bitstream output flags */
638  }  } xvid_enc_frame_t;
 xvid_enc_frame_t;  
639    
640    
641  /* XVID_ENC_ENCODE param2 (optional)  /* XVID_ENC_ENCODE param2 (optional)
# Line 457  Line 649 
649          /* encoding parameters */          /* encoding parameters */
650          int type;                                       /* [out] coding type */          int type;                                       /* [out] coding type */
651          int quant;                                      /* [out] frame quantizer */          int quant;                                      /* [out] frame quantizer */
652          xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */          int vol_flags; /* [out] vol flags (see above) */
653          int vop_flags;                          /* [out] vop flags (see above) */          int vop_flags;                          /* [out] vop flags (see above) */
654    
655          /* bitrate */          /* bitrate */
656          int length;                                     /* [out] frame length */          int length;                                     /* [out] frame length */
657    
658          int hlength;                            /* [out] header length (bytes) */          int hlength;                            /* [out] header length (bytes) */
659          int kblks, mblks, ublks;        /* [out] */          int kblks;     /* [out] number of blocks compressed as Intra */
660            int mblks;     /* [out] number of blocks compressed as Inter */
661      int sse_y, sse_u, sse_v;          int ublks;     /* [out] number of blocks marked as not_coded */
662  }  
663  xvid_enc_stats_t;          int sse_y;     /* [out] Y plane's sse */
664            int sse_u;     /* [out] U plane's sse */
665            int sse_v;     /* [out] V plane's sse */
666    } xvid_enc_stats_t;
667    
668  #ifdef __cplusplus  #ifdef __cplusplus
669  }  }
670  #endif  #endif
671    
672    
673  #endif  #endif

Legend:
Removed from v.1.27.2.4  
changed lines
  Added in v.1.27.2.42

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