[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.9, Sun Mar 16 12:04:14 2003 UTC revision 1.27.2.20, Thu May 22 22:56:17 2003 UTC
# Line 116  Line 116 
116          int stride[4];                  /* [in] image stride; "bytes per row"*/          int stride[4];                  /* [in] image stride; "bytes per row"*/
117  } xvid_image_t;  } xvid_image_t;
118    
119    /* video-object-sequence profiles */
120    #define XVID_PROFILE_S_L0       0x08    /* simple */
121    #define XVID_PROFILE_S_L1       0x01
122    #define XVID_PROFILE_S_L2       0x02
123    #define XVID_PROFILE_S_L3       0x03
124    #define XVID_PROFILE_ARTS_L1    0x91    /* advanced realtime simple */
125    #define XVID_PROFILE_ARTS_L2    0x92
126    #define XVID_PROFILE_ARTS_L3    0x93
127    #define XVID_PROFILE_ARTS_L4    0x94
128    #define XVID_PROFILE_AS_L0      0xf0    /* advanced simple */
129    #define XVID_PROFILE_AS_L1      0xf1
130    #define XVID_PROFILE_AS_L2      0xf2
131    #define XVID_PROFILE_AS_L3      0xf3
132    #define XVID_PROFILE_AS_L4      0xf4
133    
134  /* aspect ratios */  /* aspect ratios */
135  #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */  #define XVID_PAR_11_VGA     1   /* 1:1 vga (square) */
# Line 134  Line 148 
148  #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */  #define XVID_TYPE_BVOP          3               /* bidirectionally encoded */
149  #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */  #define XVID_TYPE_SVOP          4               /* predicted+sprite frame */
150    
151    
152  /*****************************************************************************  /*****************************************************************************
153   * xvid_global()   * xvid_global()
154   ****************************************************************************/   ****************************************************************************/
# Line 154  Line 169 
169  #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */  #define XVID_CPU_ALTIVEC    0x00000001   /* altivec */
170    
171    
172    #define XVID_DEBUG_ERROR       0x00000001
173    #define XVID_DEBUG_STARTCODE   0x00000002
174    #define XVID_DEBUG_HEADER      0x00000004
175    #define XVID_DEBUG_TIMECODE    0x00000008
176    #define XVID_DEBUG_MB          0x00000010
177    #define XVID_DEBUG_COEFF       0x00000020
178    #define XVID_DEBUG_MV          0x00000040
179    #define XVID_DEBUG_RC          0x00000080
180    #define XVID_DEBUG_DEBUG       0x80000000
181    
182  /* XVID_GBL_INIT param1 */  /* XVID_GBL_INIT param1 */
183  typedef struct {  typedef struct {
184          int version;          int version;
185          int cpu_flags;                  /* [in:opt]     zero = autodetect cpu          int cpu_flags;                  /* [in:opt]     zero = autodetect cpu
186                                                                          XVID_CPU_FORCE|{cpu features} = force cpu features */                                                                          XVID_CPU_FORCE|{cpu features} = force cpu features */
187        int debug;              /* [in:opt] debug level */
188  } xvid_gbl_init_t;  } xvid_gbl_init_t;
189    
190    
# Line 255  Line 281 
281  } xvid_dec_stats_t;  } xvid_dec_stats_t;
282    
283    
284    
285    #define XVID_ZONE_QUANT     1
286    #define XVID_ZONE_WEIGHT    2
287    typedef struct
288    {
289        int frame;
290        int mode;
291        int increment;
292        int base;
293    } xvid_enc_zone_t;
294    
295    
296    
297  /*****************************************************************************  /*****************************************************************************
298    xvid plugin system -- internals    xvid plugin system -- internals
299    
# Line 264  Line 303 
303    xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY    xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
304   ****************************************************************************/   ****************************************************************************/
305    
306    
307  #define XVID_PLG_CREATE     0  #define XVID_PLG_CREATE     0
308  #define XVID_PLG_DESTROY    1  #define XVID_PLG_DESTROY    1
309  #define XVID_PLG_INFO       2  #define XVID_PLG_INFO       2
# Line 279  Line 319 
319  typedef struct  typedef struct
320  {  {
321      int version;      int version;
322      int flags;              /* plugin flags */      int flags;              /* [in:opt] plugin flags */
323  } xvid_plg_info_t;  } xvid_plg_info_t;
324    
325    
# Line 287  Line 327 
327  {  {
328      int version;      int version;
329    
330      int width;      int num_zones;          /* [out] */
331      int height;      xvid_enc_zone_t * zones;    /* [out] */
     int mb_width;  
     int mb_height;  
         int fincr;  
     int fbase;  
332    
333      void * param;      int width;              /* [out] */
334        int height;             /* [out] */
335        int mb_width;           /* [out] */
336        int mb_height;          /* [out] */
337            int fincr;              /* [out] */
338        int fbase;              /* [out] */
339    
340        void * param;           /* [out] */
341  } xvid_plg_create_t;  } xvid_plg_create_t;
342    
343    
# Line 302  Line 345 
345  {  {
346      int version;      int version;
347    
348        int num_frames;          /* [out] totlal frame encoded */
349    } xvid_plg_destroy_t;
350    
351    
352    typedef struct
353    {
354        int version;
355    
356        xvid_enc_zone_t * zone;    /* [out] current zone */
357    
358      int width;              /* [out] */      int width;              /* [out] */
359      int height;             /* [out] */      int height;             /* [out] */
360      int mb_width;           /* [out] */      int mb_width;           /* [out] */
# Line 309  Line 362 
362          int fincr;              /* [out] */          int fincr;              /* [out] */
363      int fbase;              /* [out] */      int fbase;              /* [out] */
364    
365        int min_quant[3];       /* [out] */
366        int max_quant[3];       /* [out] */
367    
368      xvid_image_t reference; /* [out] -> [out] */      xvid_image_t reference; /* [out] -> [out] */
369      xvid_image_t current;   /* [out] -> [in,out] */      xvid_image_t current;   /* [out] -> [in,out] */
370      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 358  Line 414 
414      void * param;      void * param;
415  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
416    
417    
418    xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
419    xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
420    xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
421    
422    xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
423    
424  xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */  xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */
425  xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */  xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
426  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  
427    
428    
429    typedef struct          /* single pass rate control */
430    {
431        int version;
432        int bitrate;                                /* bits per second */
433        int reaction_delay_factor;
434        int averaging_period;
435        int buffer;
436    } xvid_plugin_single_t;
437    
438    
439    typedef struct {
440        int version;
441        char * filename;
442    } xvid_plugin_2pass1_t;
443    
444    
445    #define XVID_CURVE_COSINE   0   /* low aggressiveness */
446    #define XVID_CURVE_LINEAR   1   /* medium aggressiveness */
447    #define XVID_CURVE_SINE     2   /* high aggressiveness */
448    
449    #define XVID_PAYBACK_BIAS   0   /* payback with bias */
450    #define XVID_PAYBACK_PROP   1   /* payback proportionally */
451    
452    typedef struct {
453        int version;
454        int bitrate;                                /* bits per second */
455        char * filename;
456    
457        int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */
458        int payback_method;
459        int bitrate_payback_delay;
460        int curve_compression_high;
461        int curve_compression_low;
462        int max_overflow_improvement;
463        int max_overflow_degradation;
464    
465        int use_alt_curve;
466            int alt_curve_high_dist;
467            int alt_curve_low_dist;
468        int alt_curve_use_auto;
469            int alt_curve_auto_str;
470            int alt_curve_type; /* XVID_CURVE_ */
471            int alt_curve_min_rel_qual;
472            int alt_curve_use_auto_bonus_bias;
473        int alt_curve_bonus_bias;
474    
475        int kftreshold;
476            int kfreduction;
477        int min_key_interval;
478    
479            int container_frame_overhead;
480    }xvid_plugin_2pass2_t;
481    
482    
483  /*****************************************************************************  /*****************************************************************************
# Line 379  Line 496 
496  /* global flags  */  /* global flags  */
497  typedef enum  typedef enum
498  {  {
499      XVID_PACKED                 = 0x00000001,   /* packed bitstream */      XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */
500      XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */      XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
501      XVID_EXTRASTATS_ENABLE  = 0x00000004      XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004
502  /*define XVID_VOL_AT_IVOP       0x00000008       write vol at every ivop: WIN32/divx compatibility */  /*define XVID_GLOBAL_VOL_AT_IVOP        0x00000008       write vol at every ivop: WIN32/divx compatibility */
503  /*define XVID_FORCE_VOL         0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */  /*define XVID_GLOBAL_FORCE_VOL          0x00000008       XXX: when vol-based parameters are changed, insert an ivop NOT recommended */
504  } xvid_global_t;  } xvid_global_t;
505    
506    
507  /* XVID_ENC_ENCODE param1 */  /* XVID_ENC_ENCODE param1 */
508  /* vol-based flags */  /* vol-based flags */
509  typedef enum {  typedef enum {
510      XVID_MPEGQUANT          = 0x00000001,      XVID_VOL_MPEGQUANT          = 0x00000001,
511      XVID_EXTRASTATS         = 0x00000002,      XVID_VOL_EXTRASTATS         = 0x00000002,
512      XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */      XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
513      XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */      XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
514      XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */      XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
515      XVID_INTERLACING        = 0x00000400, /* enable interlaced encoding */      XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */
516  } xvid_vol_t;  } xvid_vol_t;
517    
518    
519  /* vop-based flags */  /* vop-based flags */
520  typedef enum {  typedef enum {
521      XVID_DEBUG              = 0x00000001,      XVID_VOP_DEBUG              = 0x00000001,
522    
523        XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */
524        XVID_VOP_INTER4V            = 0x00000008,
525    
526      XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */      XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */
     XVID_INTER4V            = 0x00000008,  
527    
528      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */      XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
529      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for      XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
530                                                color input material chroma is ignored) */                                                color input material chroma is ignored) */
531      XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */      XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
532      XVID_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */      XVID_VOP_MODEDECISION_BITS  = 0x00000100, /* enable DCT-ME and use it for mode decision */
     XVID_DYNAMIC_BFRAMES    = 0x00000200,  
   
         /* only valid for vol_flags|=XVID_INTERLACING */  
     XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */  
     XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */  
533    
534      /* only valid for vol_flags|=XVID_REDUCED_ENABLED */          /* only valid for vol_flags|=XVID_VOL_INTERLACING */
535      XVID_REDUCED            = 0x00001000, /* reduced resolution vop */      XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
536        XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
537    
538        /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
539        XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */
540  } xvid_vop_t;  } xvid_vop_t;
541    
542    
543  typedef enum {  typedef enum {
544      PMV_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */      XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
545      PMV_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */      XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
546    
547      PMV_HALFPELREFINE16     = 0x00020000,      XVID_ME_HALFPELREFINE16     = 0x00020000,
548      PMV_HALFPELREFINE8      = 0x02000000,      XVID_ME_HALFPELREFINE8      = 0x02000000,
549    
550      PMV_QUARTERPELREFINE16  = 0x00040000,      XVID_ME_QUARTERPELREFINE16  = 0x00040000,
551      PMV_QUARTERPELREFINE8   = 0x04000000,      XVID_ME_QUARTERPELREFINE8   = 0x04000000,
552    
553      PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */      XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
554    
555      PMV_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */      XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
556      PMV_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */      XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */
557      PMV_USESQUARES8         = 0x80000000, /* use square for PMV_EXTSEARCH8 */      XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */
558    
559      PMV_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */      XVID_ME_CHROMA16            = 0x00100000, /* also use chroma for P_VOP/S_VOP ME */
560      PMV_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */      XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
561    
562      /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
563      HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */      XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
564      HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */      XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
565      QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */      XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
566      QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */      XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
567    
568      EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern      XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
569                                                    enable PMV_EXTSEARCH8 to do this in 8x8 search as well */                                                    enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
570      CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */      XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
571    
572      PMV_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */      XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
573      PMV_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */      XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
574      PMV_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */      XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
575      PMV_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */      XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
576  } xvid_motion_t;  } xvid_motion_t;
577    
578    
579  /* XVID_ENC_CREATE param1 */  /* XVID_ENC_CREATE param1 */
580  typedef struct {  typedef struct {
581          int version;          int version;
582    
583        int profile;            /* [in]     profile@level; refer to XVID_PROFILE_xxx */
584          int width;                              /* [in]         frame dimensions; width, pixel units */          int width;                              /* [in]         frame dimensions; width, pixel units */
585          int height;                             /* [in]         frame dimensions; height, pixel units */          int height;                             /* [in]         frame dimensions; height, pixel units */
586    
587        int num_zones;          /* [in:opt] number of bitrate zones */
588        xvid_enc_zone_t * zones; /*             ^^ zone array */
589    
590      int num_plugins;        /* [in:opt] number of plugins */      int num_plugins;        /* [in:opt] number of plugins */
591      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
592    
# Line 488  Line 611 
611          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 */
612          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 */
613    
614        int min_quant[3];       /* [in:opt] */
615        int max_quant[3];       /* [in:opt] */
616    
617  /* ^^^ -------------------------------------------------------------------------*/  /* ^^^ -------------------------------------------------------------------------*/
618    
619          void *handle;                   /* [out] encoder instance handle */          void *handle;                   /* [out] encoder instance handle */
# Line 495  Line 621 
621  xvid_enc_create_t;  xvid_enc_create_t;
622    
623    
 typedef struct {  
         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;  
   
   
   
624  #define XVID_KEYFRAME   0x00000001  #define XVID_KEYFRAME   0x00000001
625    
626  typedef struct {  typedef struct {
# Line 548  Line 647 
647    
648          int type;                               /* [in:opt] coding type */          int type;                               /* [in:opt] coding type */
649          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
650            int bframe_threshold;
651    
652          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
653          int length;                             /* [in:opt] bitstream length (bytes) */          int length;                             /* [in:opt] bitstream length (bytes) */

Legend:
Removed from v.1.27.2.9  
changed lines
  Added in v.1.27.2.20

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