[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.21, Mon Jun 2 11:46:47 2003 UTC revision 1.27.2.66, Wed Mar 3 20:57:36 2004 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 49  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,0,-124)
61    #define XVID_API                 XVID_MAKE_API(4, 0)
62    
 #define XVID_VERSION                            XVID_MAKE_VERSION(1,-127,0)  
63  #define XVID_UNSTABLE  #define XVID_UNSTABLE
64    
65  /* Bitstream Version  /* Bitstream Version
# Line 67  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 "0029"
77    
78    
79  /*****************************************************************************  /*****************************************************************************
# Line 90  Line 96 
96    
97  /* colorspace values */  /* colorspace values */
98    
99  #define XVID_CSP_USER           0       /* 4:2:0 planar */  #define XVID_CSP_PLANAR   (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */
100  #define XVID_CSP_I420           1       /* 4:2:0 packed(planar win32) */  #define XVID_CSP_USER     XVID_CSP_PLANAR
101  #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */  #define XVID_CSP_I420     (1<< 1) /* 4:2:0 planar */
102  #define XVID_CSP_YUY2           3       /* 4:2:2 packed */  #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 planar */
103  #define XVID_CSP_UYVY           4       /* 4:2:2 packed */  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */
104  #define XVID_CSP_YVYU           5       /* 4:2:2 packed */  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */
105  #define XVID_CSP_BGRA           6       /* 32-bit bgra packed */  #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */
106  #define XVID_CSP_ABGR           7       /* 32-bit abgr packed */  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
107  #define XVID_CSP_RGBA           8       /* 32-bit rgba packed */  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
108  #define XVID_CSP_BGR            9       /* 32-bit bgr packed */  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
109  #define XVID_CSP_RGB555     10  /* 16-bit rgb555 packed */  #define XVID_CSP_ARGB     (1<<15) /* 32-bit argb packed */
110  #define XVID_CSP_RGB565     11  /* 16-bit rgb565 packed */  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
111  #define XVID_CSP_SLICE          12      /* decoder only: 4:2:0 planar, per slice rendering */  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
112  #define XVID_CSP_INTERNAL       13      /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
113  #define XVID_CSP_NULL           14      /* decoder only: dont output anything */  #define XVID_CSP_SLICE    (1<<12) /* decoder only: 4:2:0 planar, per slice rendering */
114  #define XVID_CSP_VFLIP  0x80000000      /* vertical flip mask */  #define XVID_CSP_INTERNAL (1<<13) /* decoder only: 4:2:0 planar, returns ptrs to internal buffers */
115    #define XVID_CSP_NULL     (1<<14) /* decoder only: dont output anything */
116    #define XVID_CSP_VFLIP    (1<<31) /* vertical flip mask */
117    
118  /* xvid_image_t  /* xvid_image_t
119          for non-planar colorspaces use only plane[0] and stride[0]          for non-planar colorspaces use only plane[0] and stride[0]
# Line 132  Line 140 
140  #define XVID_PROFILE_AS_L4      0xf4  #define XVID_PROFILE_AS_L4      0xf4
141    
142  /* aspect ratios */  /* aspect ratios */
143  #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */  #define XVID_PAR_11_VGA    1 /* 1:1 vga (square), default if supplied PAR is not a valid value */
144  #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) */
145  #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) */
146  #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 153  Line 161 
161   * xvid_global()   * xvid_global()
162   ****************************************************************************/   ****************************************************************************/
163    
164  /* cpu_flags definitions */  /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
165    
166  #define XVID_CPU_FORCE      0x80000000  /* force passed cpu flags */  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
167  #define XVID_CPU_ASM        0x00000080  /* native assembly */  #define XVID_CPU_ASM      (1<< 7) /* native assembly */
168  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
169  #define XVID_CPU_MMX        0x00000001   /* mmx      : pentiumMMX,k6 */  #define XVID_CPU_MMX      (1<< 0) /*       mmx : pentiumMMX,k6 */
170  #define XVID_CPU_MMXEXT     0x00000002   /* mmx-ext  : pentium2, athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
171  #define XVID_CPU_SSE        0x00000004   /* sse      : pentium3, athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
172  #define XVID_CPU_SSE2       0x00000008   /* sse2     : pentium4, athlon64 */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
173  #define XVID_CPU_3DNOW      0x00000010   /* 3dnow    : k6-2 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
174  #define XVID_CPU_3DNOWEXT   0x00000020   /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
175  #define XVID_CPU_TSC        0x00000040   /* timestamp counter */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
176  /* ARCH_IS_PPC */  /* ARCH_IS_PPC */
177  #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */  #define XVID_CPU_ALTIVEC  (1<< 0) /* altivec */
178    
179    
180  #define XVID_DEBUG_ERROR       0x00000001  #define XVID_DEBUG_ERROR     (1<< 0)
181  #define XVID_DEBUG_STARTCODE   0x00000002  #define XVID_DEBUG_STARTCODE (1<< 1)
182  #define XVID_DEBUG_HEADER      0x00000004  #define XVID_DEBUG_HEADER    (1<< 2)
183  #define XVID_DEBUG_TIMECODE    0x00000008  #define XVID_DEBUG_TIMECODE  (1<< 3)
184  #define XVID_DEBUG_MB          0x00000010  #define XVID_DEBUG_MB        (1<< 4)
185  #define XVID_DEBUG_COEFF       0x00000020  #define XVID_DEBUG_COEFF     (1<< 5)
186  #define XVID_DEBUG_MV          0x00000040  #define XVID_DEBUG_MV        (1<< 6)
187  #define XVID_DEBUG_RC          0x00000080  #define XVID_DEBUG_RC        (1<< 7)
188  #define XVID_DEBUG_DEBUG       0x80000000  #define XVID_DEBUG_DEBUG     (1<<31)
189    
190  /* XVID_GBL_INIT param1 */  /* XVID_GBL_INIT param1 */
191  typedef struct {  typedef struct {
192          int version;          int version;
193          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 */
                                                                         XVID_CPU_FORCE|{cpu features} = force cpu features */  
194      int debug;              /* [in:opt] debug level */      int debug;              /* [in:opt] debug level */
195  } xvid_gbl_init_t;  } xvid_gbl_init_t;
196    
# Line 193  Line 200 
200          int version;          int version;
201          int actual_version;             /* [out]        returns the actual xvidcore version */          int actual_version;             /* [out]        returns the actual xvidcore version */
202          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 */
203          int cpu_flags;                  /* [out]        detected cpu features */          unsigned int cpu_flags;      /* [out] detected cpu features */
204          int num_threads;                /* [out]        detected number of cpus/threads */          int num_threads;                /* [out]        detected number of cpus/threads */
205  } xvid_gbl_info_t;  } xvid_gbl_info_t;
206    
# Line 212  Line 219 
219  #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) */
220  #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 */
221  #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */  #define XVID_GBL_CONVERT        2       /* colorspace conversion utility */
 #define XVID_GBL_TEST           3       /* testing.. */  
222    
223  int xvid_global(void *handle, int opt, void *param1, void *param2);  extern int xvid_global(void *handle, int opt, void *param1, void *param2);
224    
225    
226  /*****************************************************************************  /*****************************************************************************
# Line 225  Line 231 
231  #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */  #define XVID_DEC_DESTROY        1       /* destroy decore instance: return 0 on success */
232  #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */  #define XVID_DEC_DECODE     2   /* decode a frame: returns number of bytes consumed >= 0 */
233    
234  int xvid_decore(void *handle, int opt, void *param1, void *param2);  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
235    
236  /* XVID_DEC_CREATE param 1  /* XVID_DEC_CREATE param 1
237          image width & height may be specified here when the dimensions are          image width & height may be specified here when the dimensions are
# Line 240  Line 246 
246    
247  /* XVID_DEC_DECODE param1 */  /* XVID_DEC_DECODE param1 */
248  /* general flags */  /* general flags */
249  #define XVID_LOWDELAY           0x00000001      /* lowdelay mode  */  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
250  #define XVID_DISCONTINUITY      0x00000002      /* indicates break in stream */  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
251    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
252    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
253    #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
254    
255  typedef struct {  typedef struct {
256          int version;          int version;
# Line 249  Line 258 
258          void *bitstream;                /* [in] bitstream (read from)*/          void *bitstream;                /* [in] bitstream (read from)*/
259          int length;                             /* [in] bitstream length */          int length;                             /* [in] bitstream length */
260          xvid_image_t output;    /* [in] output image (written to) */          xvid_image_t output;    /* [in] output image (written to) */
261  }  } xvid_dec_frame_t;
 xvid_dec_frame_t;  
262    
263    
264  /* XVID_DEC_DECODE param2 :: optional */  /* XVID_DEC_DECODE param2 :: optional */
265  typedef struct  typedef struct
266  {  {
267          int version;          int version;
268    
269          int type;                               /* [out]        output data type */          int type;                               /* [out]        output data type */
270          union {          union {
271                  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 273  Line 282 
282                          int general;            /* [out]        flags */                          int general;            /* [out]        flags */
283                          int width;                      /* [out]        width */                          int width;                      /* [out]        width */
284                          int height;                     /* [out]        height */                          int height;                     /* [out]        height */
285                          int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */                          int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
286                          int par_width;          /* [out]        aspect ratio width */                          int par_width;      /* [out] aspect ratio width  [1..255] */
287                          int par_height;         /* [out]        aspect ratio height */                          int par_height;     /* [out] aspect ratio height [1..255] */
288                  } vol;                  } vol;
289          } data;          } data;
290  } xvid_dec_stats_t;  } xvid_dec_stats_t;
291    
292    #define XVID_ZONE_QUANT  (1<<0)
293    #define XVID_ZONE_WEIGHT (1<<1)
294    
   
 #define XVID_ZONE_QUANT     1  
 #define XVID_ZONE_WEIGHT    2  
295  typedef struct  typedef struct
296  {  {
297      int frame;      int frame;
# Line 293  Line 301 
301  } xvid_enc_zone_t;  } xvid_enc_zone_t;
302    
303    
304    /*----------------------------------------------------------------------------
305     * xvid_enc_stats_t structure
306     *
307     * Used in:
308     *  - xvid_plg_data_t structure
309     *  - optional parameter in xvid_encore() function
310     *
311     * .coding_type = XVID_TYPE_NOTHING if the stats are not given
312     *--------------------------------------------------------------------------*/
313    
314    typedef struct {
315            int version;
316    
317            /* encoding parameters */
318            int type;      /* [out] coding type */
319            int quant;     /* [out] frame quantizer */
320            int vol_flags; /* [out] vol flags (see above) */
321            int vop_flags; /* [out] vop flags (see above) */
322    
323            /* bitrate */
324            int length;    /* [out] frame length */
325    
326            int hlength;   /* [out] header length (bytes) */
327            int kblks;     /* [out] number of blocks compressed as Intra */
328            int mblks;     /* [out] number of blocks compressed as Inter */
329            int ublks;     /* [out] number of blocks marked as not_coded */
330    
331            int sse_y;     /* [out] Y plane's sse */
332            int sse_u;     /* [out] U plane's sse */
333            int sse_v;     /* [out] V plane's sse */
334    } xvid_enc_stats_t;
335    
336  /*****************************************************************************  /*****************************************************************************
337    xvid plugin system -- internals    xvid plugin system -- internals
# Line 304  Line 343 
343   ****************************************************************************/   ****************************************************************************/
344    
345    
346  #define XVID_PLG_CREATE     0  #define XVID_PLG_CREATE  (1<<0)
347  #define XVID_PLG_DESTROY    1  #define XVID_PLG_DESTROY (1<<1)
348  #define XVID_PLG_INFO       2  #define XVID_PLG_INFO    (1<<2)
349  #define XVID_PLG_BEFORE     3  #define XVID_PLG_BEFORE  (1<<3)
350  #define XVID_PLG_AFTER      4  #define XVID_PLG_FRAME   (1<<4)
351    #define XVID_PLG_AFTER   (1<<5)
352    
353  /* xvid_plg_info_t.flags */  /* xvid_plg_info_t.flags */
354  #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */  #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
355  #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/  #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
356  #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
357    
358    
359  typedef struct  typedef struct
# Line 345  Line 385 
385  {  {
386      int version;      int version;
387    
388      int num_frames;          /* [out] totlal frame encoded */          int num_frames; /* [out] total frame encoded */
389  } xvid_plg_destroy_t;  } xvid_plg_destroy_t;
390    
   
391  typedef struct  typedef struct
392  {  {
393      int version;      int version;
# Line 380  Line 419 
419      int vol_flags;          /* [in,out] */      int vol_flags;          /* [in,out] */
420      int motion_flags;       /* [in,out] */      int motion_flags;       /* [in,out] */
421    
422    /* Deprecated, use the stats field instead.
423     * Will disapear before 1.0 */
424      int length;                 /* [out] after: length of encoded frame */      int length;                 /* [out] after: length of encoded frame */
425      int kblks, mblks, ublks;    /* [out] after: */          int kblks;              /* [out] number of blocks compressed as Intra */
426      int sse_y, sse_u, sse_v;    /* [out] */          int mblks;              /* [out] number of blocks compressed as Inter */
427  } xvid_plg_data_t;          int ublks;              /* [out] number of blocks marked not_coded */
428            int sse_y;              /* [out] Y plane's sse */
429            int sse_u;              /* [out] U plane's sse */
430            int sse_v;              /* [out] V plane's sse */
431    /* End of duplicated data, kept only for binary compatibility */
432    
433            int bquant_ratio;       /* [in] */
434            int bquant_offset;      /* [in] */
435    
436            xvid_enc_stats_t stats; /* [out] frame statistics */
437    } xvid_plg_data_t;
438    
439  /*****************************************************************************  /*****************************************************************************
440    xvid plugin system -- external    xvid plugin system -- external
# Line 415  Line 465 
465  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
466    
467    
468  xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
469  xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */  extern xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
470  xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */  extern xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
471    
472  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
473    
474  xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
475  xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
476    
477    
478    /* single pass rate control
479  typedef struct          /* single pass rate control */   * CBR and Constant quantizer modes */
480    typedef struct
481  {  {
482      int version;      int version;
483      int bitrate;                                /* bits per second */  
484      int reaction_delay_factor;          int bitrate;               /* [in] bits per second */
485      int averaging_period;          int reaction_delay_factor; /* [in] */
486      int buffer;          int averaging_period;      /* [in] */
487            int buffer;                /* [in] */
488  } xvid_plugin_single_t;  } xvid_plugin_single_t;
489    
490    
491  typedef struct {  typedef struct {
492      int version;      int version;
493    
494      char * filename;      char * filename;
495  } xvid_plugin_2pass1_t;  } xvid_plugin_2pass1_t;
496    
# Line 447  Line 500 
500    
501  typedef struct {  typedef struct {
502      int version;      int version;
     int bitrate;                                /* bits per second */  
     char * filename;  
503    
504      int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */          int bitrate;                  /* [in] bits per second */
505      int payback_method;          char * filename;              /* [in] first pass stats filename */
     int bitrate_payback_delay;  
     int curve_compression_high;  
     int curve_compression_low;  
     int max_overflow_improvement;  
     int max_overflow_degradation;  
   
     int kftreshold;  
         int kfreduction;  
     int min_key_interval;  
506    
507          int container_frame_overhead;          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
508  }xvid_plugin_2pass2_t;          int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
509            int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
510            int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
511            int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
512            int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
513    
514            int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
515            int kfthreshold;              /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
516                                                                       *      is substracted from its bit allocation. The reduction is computed as multiples of
517                                                                       *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
518                                                                       *      0 for 1<distance<kfthreshold */
519    
520            int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
521    }xvid_plugin_2pass2_t;
522    
523  /*****************************************************************************  /*****************************************************************************
524   * xvid_encore()   *                             ENCODER API
525   ****************************************************************************/   ****************************************************************************/
526    
527  /* Encoder options */  /*----------------------------------------------------------------------------
528     * Encoder operations
529     *--------------------------------------------------------------------------*/
530    
531  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
532  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
533  #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
534                                                                          0 means this frame should not be written (ie. encoder lag) */                              * 0 means this frame should not be written (ie. encoder lag) */
535    
 int xvid_encore(void *handle, int opt, void *param1, void *param2);  
536    
537    /*----------------------------------------------------------------------------
538     * Encoder entry point
539     *--------------------------------------------------------------------------*/
540    
541  /* global flags  */  extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
 typedef enum  
 {  
     XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */  
     XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */  
     XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004  
 /*define XVID_GLOBAL_VOL_AT_IVOP        0x00000008       write vol at every ivop: WIN32/divx compatibility */  
 /*define XVID_GLOBAL_FORCE_VOL          0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */  
 } xvid_global_t;  
   
   
 /* XVID_ENC_ENCODE param1 */  
 /* vol-based flags */  
 typedef enum {  
     XVID_VOL_MPEGQUANT          = 0x00000001,  
     XVID_VOL_EXTRASTATS         = 0x00000002,  
     XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */  
     XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */  
     XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */  
     XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */  
 } xvid_vol_t;  
   
   
 /* vop-based flags */  
 typedef enum {  
     XVID_VOP_DEBUG              = 0x00000001,  
   
     XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */  
     XVID_VOP_INTER4V            = 0x00000008,  
   
     XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */  
   
     XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */  
     XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for  
                                               color input material chroma is ignored) */  
     XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */  
     XVID_VOP_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */  
   
         /* only valid for vol_flags|=XVID_VOL_INTERLACING */  
     XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */  
     XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */  
542    
543      /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* Quick API reference
544      XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */   *
545  } xvid_vop_t;   * XVID_ENC_CREATE operation
546     *  - handle: ignored
547     *  - opt: XVID_ENC_CREATE
548     *  - param1: address of a xvid_enc_create_t structure
549     *  - param2: ignored
550     *
551     * XVID_ENC_ENCODE operation
552     *  - handle: an instance returned by a CREATE op
553     *  - opt: XVID_ENC_ENCODE
554     *  - param1: address of a xvid_enc_frame_t structure
555     *  - param2: address of a xvid_enc_stats_t structure (optional)
556     *            its return value is asynchronous to what is written to the buffer
557     *            depending on the delay introduced by bvop use. It's display
558     *            ordered.
559     *
560     * XVID_ENC_DESTROY operation
561     *  - handle: an instance returned by a CREATE op
562     *  - opt: XVID_ENC_DESTROY
563     *  - param1: ignored
564     *  - param2: ignored
565     */
566    
567    
568  typedef enum {  /*----------------------------------------------------------------------------
569      XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */   * "Global" flags
570      XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */   *
571     * These flags are used for xvid_enc_create_t->global field during instance
572     * creation (operation XVID_ENC_CREATE)
573     *--------------------------------------------------------------------------*/
574    
575    #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
576    #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
577    #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
578    #if 0
579    #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
580    #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* when vol-based parameters are changed, insert an ivop NOT recommended */
581    #endif
582    
     XVID_ME_HALFPELREFINE16     = 0x00020000,  
     XVID_ME_HALFPELREFINE8      = 0x02000000,  
583    
584      XVID_ME_QUARTERPELREFINE16  = 0x00040000,  /*----------------------------------------------------------------------------
585      XVID_ME_QUARTERPELREFINE8   = 0x04000000,   * "VOL" flags
586     *
587     * These flags are used for xvid_enc_frame_t->vol_flags field during frame
588     * encoding (operation XVID_ENC_ENCODE)
589     *--------------------------------------------------------------------------*/
590    
591    #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
592    #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
593    #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
594    #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
595    #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
596    #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
597    
     XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */  
598    
599      XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */  /*----------------------------------------------------------------------------
600      XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */   * "VOP" flags
601      XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */   *
602     * These flags are used for xvid_enc_frame_t->vop_flags field during frame
603     * encoding (operation XVID_ENC_ENCODE)
604     *--------------------------------------------------------------------------*/
605    
606    /* Always valid */
607    #define XVID_VOP_DEBUG                (1<< 0) /* print debug messages in frames */
608    #define XVID_VOP_HALFPEL              (1<< 1) /* use halfpel interpolation */
609    #define XVID_VOP_INTER4V              (1<< 2) /* use 4 motion vectors per MB */
610    #define XVID_VOP_TRELLISQUANT         (1<< 3) /* use trellis based R-D "optimal" quantization */
611    #define XVID_VOP_CHROMAOPT            (1<< 4) /* enable chroma optimization pre-filter */
612    #define XVID_VOP_CARTOON              (1<< 5) /* use 'cartoon mode' */
613    #define XVID_VOP_GREYSCALE            (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
614    #define XVID_VOP_HQACPRED             (1<< 7) /* high quality ac prediction */
615    #define XVID_VOP_MODEDECISION_RD      (1<< 8) /* enable DCT-ME and use it for mode decision */
616    #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
617    
618    /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
619    #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
620    #define XVID_VOP_ALTERNATESCAN        (1<<10) /* set alternate vertical scan flag */
621    
622      XVID_ME_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
623      XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */  #define XVID_VOP_REDUCED              (1<<11) /* reduced resolution vop */
624    
     /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */  
     XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */  
     XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */  
     XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */  
     XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */  
625    
626      XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern  /*----------------------------------------------------------------------------
627                                                    enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */   * "Motion" flags
628      XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */   *
629     * These flags are used for xvid_enc_frame_t->motion field during frame
630     * encoding (operation XVID_ENC_ENCODE)
631     *--------------------------------------------------------------------------*/
632    
633    /* Motion Estimation Search Patterns */
634    #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
635    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
636    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
637    #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
638    
639    /* SAD operator based flags */
640    #define XVID_ME_HALFPELREFINE16       (1<< 4)
641    #define XVID_ME_HALFPELREFINE8        (1<< 6)
642    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
643    #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
644    #define XVID_ME_GME_REFINE            (1<< 9)
645    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
646    #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
647    #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
648    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
649    #define XVID_ME_FASTREFINE16          (1<<25) /* use low-complexity refinement functions */
650    #define XVID_ME_FASTREFINE8           (1<<29) /* low-complexity 8x8 sub-block refinement */
651    
652    /* Rate Distortion based flags
653     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
654    #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
655    #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
656    #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
657    #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
658    #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 */
659    #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
660    
661    /* Other */
662    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
663    #define XVID_ME_SKIP_DELTASEARCH      (1<<26) /* speed-up by skipping b-frame delta search */
664    #define XVID_ME_FAST_MODEINTERPOLATE  (1<<27) /* speed-up by partly skipping interpolate mode */
665    #define XVID_ME_BFRAME_EARLYSTOP      (1<<28) /* speed-up by early exiting b-search */
666    
667    /* Unused */
668    #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
669    #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
670    #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
671    #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
672    
     XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */  
     XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */  
     XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */  
     XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */  
 } xvid_motion_t;  
673    
674    /*----------------------------------------------------------------------------
675     * xvid_enc_create_t structure definition
676     *
677     * This structure is passed as param1 during an instance creation (operation
678     * XVID_ENC_CREATE)
679     *--------------------------------------------------------------------------*/
680    
 /* XVID_ENC_CREATE param1 */  
681  typedef struct {  typedef struct {
682          int version;          int version;
683    
# Line 579  Line 694 
694          int num_threads;                /* [in:opt]     number of threads */          int num_threads;                /* [in:opt]     number of threads */
695          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
696    
697          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */          int global;                  /* [in:opt] global flags; controls encoding behavior */
698    
699  /* --- vol-based stuff; included here for conveinience */          /* --- vol-based stuff; included here for convenience */
700          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
701          int fbase;                              /* [in] framerate base          int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
702                                                                                  frame_duration = fincr/fbase seconds*/      /* ---------------------------------------------- */
 /* ^^^---------------------------------------------- */  
703    
704            /* --- vop-based; included here for convenience */
 /* ---vop-based; included here for conveienience */  
705          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? */  
706    
707          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 */
708    
# Line 599  Line 711 
711    
712      int min_quant[3];       /* [in:opt] */      int min_quant[3];       /* [in:opt] */
713      int max_quant[3];       /* [in:opt] */      int max_quant[3];       /* [in:opt] */
714            /* ---------------------------------------------- */
 /* ^^^ -------------------------------------------------------------------------*/  
715    
716          void *handle;                   /* [out] encoder instance handle */          void *handle;                   /* [out] encoder instance handle */
717  }  } xvid_enc_create_t;
 xvid_enc_create_t;  
718    
719    
720  #define XVID_KEYFRAME   0x00000001  /*----------------------------------------------------------------------------
721     * xvid_enc_frame_t structure definition
722     *
723     * This structure is passed as param1 during a frame encoding (operation
724     * XVID_ENC_ENCODE)
725     *--------------------------------------------------------------------------*/
726    
727    /* out value for the frame structure->type field
728     * unlike stats output in param2, this field is not asynchronous and tells
729     * the client app, if the frame written into the stream buffer is an ivop
730     * usually used for indexing purpose in the container */
731    #define XVID_KEYFRAME (1<<1)
732    
733    /* The structure */
734  typedef struct {  typedef struct {
735          int version;          int version;
736    
737  /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any          /* VOL related stuff
738                  changes here until the next VOL (keyframe). */           * unless XVID_FORCEVOL is set, the encoder will not react to any changes
739          xvid_vol_t vol_flags;                   /* [in] vol flags */           * here until the next VOL (keyframe). */
         unsigned char *  
                 quant_intra_matrix;     /* [in:opt] custom intra qmatrix */  
         unsigned char *  
                 quant_inter_matrix;     /* [in:opt] custom inter qmatrix */  
740    
741          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */          int vol_flags;                     /* [in] vol flags */
742            unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
743            unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
744    
745            int par;                           /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */
746          int par_width;                  /* [in:opt] aspect ratio width */          int par_width;                  /* [in:opt] aspect ratio width */
747          int par_height;                 /* [in:opt] aspect ratio height */          int par_height;                 /* [in:opt] aspect ratio height */
 /* ^^^----------------------------------------------------------------------------------*/  
748    
749      int fincr;                          /* framerate increment, for variable framerate only */          /* Other fields that can change on a frame base */
750          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */  
751          xvid_motion_t motion;                           /* [in] ME options */          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
752            int vop_flags;                     /* [in] (general)vop-based flags */
753            int motion;                        /* [in] ME options */
754    
755          xvid_image_t input;     /* [in] input image (read from) */          xvid_image_t input;     /* [in] input image (read from) */
756    
757          int type;                               /* [in:opt] coding type */          int type;                               /* [in:opt] coding type */
758          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
759          int bframe_threshold;          int bframe_threshold;
760    
761          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
762          int length;                             /* [in:opt] bitstream length (bytes) */          int length;                             /* [in:opt] bitstream length (bytes) */
763    
764          int out_flags;                          /* [out] bitstream output flags */          int out_flags;                          /* [out] bitstream output flags */
765  }  } xvid_enc_frame_t;
 xvid_enc_frame_t;  
   
   
 /* XVID_ENC_ENCODE param2 (optional)  
         xvid_enc_stats_t describes individual frame details  
   
         coding_type==XVID_TYPE_NOTHING if the stats are not given  
 */  
 typedef struct {  
         int version;  
   
         /* encoding parameters */  
         int type;                                       /* [out] coding type */  
         int quant;                                      /* [out] frame quantizer */  
         xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */  
         int vop_flags;                          /* [out] vop flags (see above) */  
         /* bitrate */  
         int length;                                     /* [out] frame length */  
   
         int hlength;                            /* [out] header length (bytes) */  
         int kblks, mblks, ublks;        /* [out] */  
   
     int sse_y, sse_u, sse_v;  
 }  
 xvid_enc_stats_t;  
766    
767  #ifdef __cplusplus  #ifdef __cplusplus
768  }  }
769  #endif  #endif
770    
   
771  #endif  #endif

Legend:
Removed from v.1.27.2.21  
changed lines
  Added in v.1.27.2.66

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