[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.13, Wed Mar 26 14:56:10 2003 UTC revision 1.27.2.49, Sat Dec 6 10:56:10 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 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,-127)
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 "0023"
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_USER     (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_I420     (1<< 1) /* 4:2:0 planar */
101  #define XVID_CSP_YV12           2       /* 4:2:0 packed(planar win32) */  #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 planar */
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 116  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 134  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 167  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 186  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 214  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 223  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 247  Line 277 
277                          int general;            /* [out]        flags */                          int general;            /* [out]        flags */
278                          int width;                      /* [out]        width */                          int width;                      /* [out]        width */
279                          int height;                     /* [out]        height */                          int height;                     /* [out]        height */
280                          int par;                        /* [out]        picture aspect ratio (refer to XVID_PAR_xxx above) */                          int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
281                          int par_width;          /* [out]        aspect ratio width */                          int par_width;          /* [out]        aspect ratio width */
282                          int par_height;         /* [out]        aspect ratio height */                          int par_height;         /* [out]        aspect ratio height */
283                  } vol;                  } vol;
# Line 255  Line 285 
285  } xvid_dec_stats_t;  } xvid_dec_stats_t;
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    xvid plugin system -- internals
304    
# Line 264  Line 308 
308    xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY    xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
309   ****************************************************************************/   ****************************************************************************/
310    
311  #define XVID_PLG_CREATE     0  
312  #define XVID_PLG_DESTROY    1  #define XVID_PLG_CREATE  (1<<0)
313  #define XVID_PLG_INFO       2  #define XVID_PLG_DESTROY (1<<1)
314  #define XVID_PLG_BEFORE     3  #define XVID_PLG_INFO    (1<<2)
315  #define XVID_PLG_AFTER      4  #define XVID_PLG_BEFORE  (1<<3)
316    #define XVID_PLG_FRAME   (1<<4)
317    #define XVID_PLG_AFTER   (1<<5)
318    
319  /* xvid_plg_info_t.flags */  /* xvid_plg_info_t.flags */
320  #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 */
321  #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*/
322  #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
323    
324    
325  typedef struct  typedef struct
326  {  {
327      int version;      int version;
328      int flags;              /* plugin flags */          int flags;   /* [in:opt] plugin flags */
329  } xvid_plg_info_t;  } xvid_plg_info_t;
330    
331    
# Line 287  Line 333 
333  {  {
334      int version;      int version;
335    
336      int width;          int num_zones;           /* [out] */
337      int height;          xvid_enc_zone_t * zones; /* [out] */
     int mb_width;  
     int mb_height;  
         int fincr;  
     int fbase;  
338    
339      void * param;          int width;               /* [out] */
340            int height;              /* [out] */
341            int mb_width;            /* [out] */
342            int mb_height;           /* [out] */
343            int fincr;               /* [out] */
344            int fbase;               /* [out] */
345    
346            void * param;            /* [out] */
347  } xvid_plg_create_t;  } xvid_plg_create_t;
348    
349    
# Line 302  Line 351 
351  {  {
352      int version;      int version;
353    
354      int num_frames;          /* [out] totlal frame encoded */          int num_frames; /* [out] total frame encoded */
355  } xvid_plg_destroy_t;  } xvid_plg_destroy_t;
356    
357    
# Line 310  Line 359 
359  {  {
360      int version;      int version;
361    
362            xvid_enc_zone_t * zone; /* [out] current zone */
363    
364      int width;              /* [out] */      int width;              /* [out] */
365      int height;             /* [out] */      int height;             /* [out] */
366      int mb_width;           /* [out] */      int mb_width;           /* [out] */
# Line 317  Line 368 
368          int fincr;              /* [out] */          int fincr;              /* [out] */
369      int fbase;              /* [out] */      int fbase;              /* [out] */
370    
371            int min_quant[3];       /* [out] */
372            int max_quant[3];       /* [out] */
373    
374      xvid_image_t reference; /* [out] -> [out] */      xvid_image_t reference; /* [out] -> [out] */
375      xvid_image_t current;   /* [out] -> [in,out] */      xvid_image_t current;   /* [out] -> [in,out] */
376      xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */      xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
# Line 333  Line 387 
387      int motion_flags;       /* [in,out] */      int motion_flags;       /* [in,out] */
388    
389      int length;                 /* [out] after: length of encoded frame */      int length;                 /* [out] after: length of encoded frame */
390      int kblks, mblks, ublks;    /* [out] after: */          int kblks;              /* [out] number of blocks compressed as Intra */
391      int sse_y, sse_u, sse_v;    /* [out] */          int mblks;              /* [out] number of blocks compressed as Inter */
392            int ublks;              /* [out] number of blocks marked not_coded */
393            int sse_y;              /* [out] Y plane's sse */
394            int sse_u;              /* [out] U plane's sse */
395            int sse_v;              /* [out] V plane's sse */
396            int bquant_ratio;       /* [in] */
397            int bquant_offset;      /* [in] */
398  } xvid_plg_data_t;  } xvid_plg_data_t;
399    
400    
# Line 367  Line 427 
427  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
428    
429    
430    xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
431  xvid_plugin_func xvid_plugin_fixed;   /* fixed quantizer control */  xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
432  xvid_plugin_func xvid_plugin_cbr;   /* constant bitrate control */  xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
 xvid_plugin_func xvid_plugin_2pass1;   /* 2pass rate control: first pass */  
 xvid_plugin_func xvid_plugin_2pass2;   /* 2pass rate control: second pass */  
433    
434  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
435    
# Line 379  Line 437 
437  xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */  xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
438    
439    
440    /* single pass rate control
441     * CBR and Constant quantizer modes */
442  typedef struct  typedef struct
443  {  {
444      int version;      int version;
     int quant_increment;  
     int quant_base;  
 } xvid_plugin_fixed_t;  
445    
446            int bitrate;               /* [in] bits per second */
447  typedef struct          int reaction_delay_factor; /* [in] */
448  {          int averaging_period;      /* [in] */
449      int version;          int buffer;                /* [in] */
450      int bitrate;  } xvid_plugin_single_t;
     int max_quantizer;  
     int min_quantizer;  
     int reaction_delay_factor;  
     int averaging_period;  
     int buffer;  
 } xvid_plugin_cbr_t;  
451    
452    
453  typedef struct {  typedef struct {
454      int version;      int version;
455    
456      char * filename;      char * filename;
457  } xvid_plugin_2pass1_t;  } xvid_plugin_2pass1_t;
458    
459    
 #define XVID_CURVE_COSINE   0   /* low aggressiveness */  
 #define XVID_CURVE_LINEAR   1   /* medium aggressiveness */  
 #define XVID_CURVE_SINE     2   /* high aggressiveness */  
   
460  #define XVID_PAYBACK_BIAS   0   /* payback with bias */  #define XVID_PAYBACK_BIAS   0   /* payback with bias */
461  #define XVID_PAYBACK_PROP   1   /* payback proportionally */  #define XVID_PAYBACK_PROP   1   /* payback proportionally */
462    
463  typedef struct {  typedef struct {
464      int version;      int version;
     char * filename1;  
     char * filename2;  
465    
466      int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */          int bitrate;                  /* [in] bits per second */
467      int payback_method;          char * filename;              /* [in] first pass stats filename */
468      int bitrate_payback_delay;  
469      int curve_compression_high;          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
470      int curve_compression_low;          int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
471      int max_overflow_improvement;          int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
472      int max_overflow_degradation;          int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
473      int min_quant[3];          int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
474      int max_quant[3];          int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
475    
476      int use_alt_curve;          int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
477          int alt_curve_high_dist;          int kfthreshold;              /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
478          int alt_curve_low_dist;                                                                     *      is substracted from its bit allocation. The reduction is computed as multiples of
479      int alt_curve_use_auto;                                                                     *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
480          int alt_curve_auto_str;                                                                     *      0 for 1<distance<kfthreshold */
481          int alt_curve_type; /* XVID_CURVE_ */  
482          int alt_curve_min_rel_qual;          int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
         int alt_curve_use_auto_bonus_bias;  
     int alt_curve_bonus_bias;  
   
     int kftreshold;  
         int kfreduction;  
     int min_key_interval;  
483  }xvid_plugin_2pass2_t;  }xvid_plugin_2pass2_t;
484    
485    
# Line 451  Line 491 
491  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */  #define XVID_ENC_CREATE     0   /* create encoder instance; returns 0 on success */
492  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */  #define XVID_ENC_DESTROY        1       /* destroy encoder instance; returns 0 on success */
493  #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
494                                                                          0 means this frame should not be written (ie. encoder lag) */                              * 0 means this frame should not be written (ie. encoder lag) */
495    
496  int xvid_encore(void *handle, int opt, void *param1, void *param2);  int xvid_encore(void *handle, int opt, void *param1, void *param2);
497    
498    
499  /* global flags  */  
500  typedef enum  /* Global Flags */
501  {  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
502      XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */  #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
503      XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
504      XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004  #if 0
505  /*define XVID_GLOBAL_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 */
506  /*define XVID_GLOBAL_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 */
507  } xvid_global_t;  #endif
508    
509    
510  /* XVID_ENC_ENCODE param1 */  /* XVID_ENC_ENCODE param1 */
511  /* vol-based flags */  /* vol-based flags */
512  typedef enum {  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
513      XVID_VOL_MPEGQUANT          = 0x00000001,  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
514      XVID_VOL_EXTRASTATS         = 0x00000002,  #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
515      XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */  #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
516      XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */  #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
517      XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
     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_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 */  
     XVID_VOP_DYNAMIC_BFRAMES    = 0x00000200,  
   
         /* 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 */  
   
     /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  
     XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */  
 } xvid_vop_t;  
518    
519    
 typedef enum {  
     XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */  
     XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */  
520    
521      XVID_ME_HALFPELREFINE16     = 0x00020000,  /* vop based flags */
522      XVID_ME_HALFPELREFINE8      = 0x02000000,  #define XVID_VOP_DEBUG           (1<< 0)
523    #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */
524    #define XVID_VOP_INTER4V         (1<< 2)
525    #define XVID_VOP_TRELLISQUANT    (1<< 3) /* use trellis based R-D "optimal" quantization */
526    #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */
527    #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */
528    #define XVID_VOP_GREYSCALE       (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
529    #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */
530    #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */
531    /* only valid for vol_flags|=XVID_VOL_INTERLACING */
532    #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */
533    #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */
534    /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
535    #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */
536    
537      XVID_ME_QUARTERPELREFINE16  = 0x00040000,  #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */
     XVID_ME_QUARTERPELREFINE8   = 0x04000000,  
538    
     XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */  
539    
     XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */  
     XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */  
     XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */  
540    
541      XVID_ME_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */  /* Motion based flags */
542      XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */  #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
543    #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
544    #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
545    #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
546    #define XVID_ME_HALFPELREFINE16       (1<< 4)
547    #define XVID_ME_HALFPELREFINE8        (1<< 6)
548    #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
549    #define XVID_ME_QUARTERPELREFINE8     (1<< 8)
550    #define XVID_ME_GME_REFINE            (1<< 9)
551    #define XVID_ME_EXTSEARCH16           (1<<10) /* extend PMV by more searches */
552    #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
553    #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
554    #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
555    
556      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
557      XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
558      XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */  #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
559      XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */  #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
560      XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */  #define XVID_ME_QUARTERPELREFINE8_RD  (1<<17) /* perform RD-based qpel refinement for 8x8 mode */
561    #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 */
562      XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern  #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
563                                                    enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */  
564      XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
565    #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
566      XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
567      XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
     XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */  
     XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */  
 } xvid_motion_t;  
568    
569    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
570    #define XVID_ME_FASTREFINE16              (1<<25) /* use low-complexity refinement functions */
571    
572  /* XVID_ENC_CREATE param1 */  /* XVID_ENC_CREATE param1 */
573  typedef struct {  typedef struct {
574          int version;          int version;
575    
576            int profile;                 /* [in] profile@level; refer to XVID_PROFILE_xxx */
577          int width;                              /* [in]         frame dimensions; width, pixel units */          int width;                              /* [in]         frame dimensions; width, pixel units */
578          int height;                             /* [in]         frame dimensions; height, pixel units */          int height;                             /* [in]         frame dimensions; height, pixel units */
579    
580            int num_zones;               /* [in:opt] number of bitrate zones */
581            xvid_enc_zone_t * zones;     /*          ^^ zone array */
582    
583      int num_plugins;        /* [in:opt] number of plugins */      int num_plugins;        /* [in:opt] number of plugins */
584      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
585    
586          int num_threads;                /* [in:opt]     number of threads */          int num_threads;                /* [in:opt]     number of threads */
587          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
588    
589          xvid_global_t global;   /* [in:opt] global flags; controls encoding behavior */          int global;                  /* [in:opt] global flags; controls encoding behavior */
590    
591  /* --- vol-based stuff; included here for conveinience */          /* --- vol-based stuff; included here for convenience */
592          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */          int fincr;                              /* [in:opt] framerate increment; set to zero for variable framerate */
593          int fbase;                              /* [in] framerate base          int fbase;                   /* [in] framerate base frame_duration = fincr/fbase seconds*/
594                                                                                  frame_duration = fincr/fbase seconds*/      /* ---------------------------------------------- */
 /* ^^^---------------------------------------------- */  
   
595    
596  /* ---vop-based; included here for conveienience */          /* --- vop-based; included here for convenience */
597          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? */  
598    
599          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 */
600    
601          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 */
602          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 */
603    
604  /* ^^^ -------------------------------------------------------------------------*/          int min_quant[3];            /* [in:opt] */
605            int max_quant[3];            /* [in:opt] */
606            /* ---------------------------------------------- */
607    
608          void *handle;                   /* [out] encoder instance handle */          void *handle;                   /* [out] encoder instance handle */
609  }  }
610  xvid_enc_create_t;  xvid_enc_create_t;
611    
612    
613  #define XVID_KEYFRAME   0x00000001  #define XVID_KEYFRAME (1<<1)
614    
615  typedef struct {  typedef struct {
616          int version;          int version;
617    
618  /* --- 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). */
619                  changes here until the next VOL (keyframe). */          int vol_flags;                     /* [in] vol flags */
620          xvid_vol_t vol_flags;                   /* [in] vol flags */          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
621          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 */  
622    
623          int par;                                /* [in:opt] picture aspect ratio (refer to XVID_PAR_xxx above) */          int par;                           /* [in:opt] pixel aspect ratio (refer to XVID_PAR_xxx above) */
624          int par_width;                  /* [in:opt] aspect ratio width */          int par_width;                  /* [in:opt] aspect ratio width */
625          int par_height;                 /* [in:opt] aspect ratio height */          int par_height;                 /* [in:opt] aspect ratio height */
626  /* ^^^----------------------------------------------------------------------------------*/          /* ---------------------------------------------- */
627    
628      int fincr;                          /* framerate increment, for variable framerate only */          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
629          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */          int vop_flags;                     /* [in] (general)vop-based flags */
630          xvid_motion_t motion;                           /* [in] ME options */          int motion;                        /* [in] ME options */
631    
632          xvid_image_t input;     /* [in] input image (read from) */          xvid_image_t input;     /* [in] input image (read from) */
633    
634          int type;                               /* [in:opt] coding type */          int type;                               /* [in:opt] coding type */
635          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          int quant;                         /* [in] frame quantizer; if <=0, automatic (ratecontrol) */
636            int bframe_threshold;
637    
638          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
639          int length;                             /* [in:opt] bitstream length (bytes) */          int length;                             /* [in:opt] bitstream length (bytes) */
640    
641          int out_flags;                          /* [out] bitstream output flags */          int out_flags;                          /* [out] bitstream output flags */
642  }  } xvid_enc_frame_t;
 xvid_enc_frame_t;  
643    
644    
645  /* XVID_ENC_ENCODE param2 (optional)  /* XVID_ENC_ENCODE param2 (optional)
# Line 621  Line 653 
653          /* encoding parameters */          /* encoding parameters */
654          int type;                                       /* [out] coding type */          int type;                                       /* [out] coding type */
655          int quant;                                      /* [out] frame quantizer */          int quant;                                      /* [out] frame quantizer */
656          xvid_vol_t vol_flags;                           /* [out] vol flags (see above) */          int vol_flags; /* [out] vol flags (see above) */
657          int vop_flags;                          /* [out] vop flags (see above) */          int vop_flags;                          /* [out] vop flags (see above) */
658    
659          /* bitrate */          /* bitrate */
660          int length;                                     /* [out] frame length */          int length;                                     /* [out] frame length */
661    
662          int hlength;                            /* [out] header length (bytes) */          int hlength;                            /* [out] header length (bytes) */
663          int kblks, mblks, ublks;        /* [out] */          int kblks;     /* [out] number of blocks compressed as Intra */
664            int mblks;     /* [out] number of blocks compressed as Inter */
665      int sse_y, sse_u, sse_v;          int ublks;     /* [out] number of blocks marked as not_coded */
666  }  
667  xvid_enc_stats_t;          int sse_y;     /* [out] Y plane's sse */
668            int sse_u;     /* [out] U plane's sse */
669            int sse_v;     /* [out] V plane's sse */
670    } xvid_enc_stats_t;
671    
672  #ifdef __cplusplus  #ifdef __cplusplus
673  }  }

Legend:
Removed from v.1.27.2.13  
changed lines
  Added in v.1.27.2.49

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