[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.5, Thu Mar 13 11:07:20 2003 UTC revision 1.27.2.18, Thu May 15 13:00:37 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 239  Line 254 
254                          int time_increment;     /* [out]        time increment */                          int time_increment;     /* [out]        time increment */
255    
256                          /* XXX: external deblocking stuff */                          /* XXX: external deblocking stuff */
257                          unsigned char * qscale; /* [out]        pointer to quantizer table */                          int * qscale;   /* [out]        pointer to quantizer table */
258                          int qscale_stride;              /* [out]        quantizer scale stride */                          int qscale_stride;              /* [out]        quantizer scale stride */
259    
260                  } vop;                  } vop;
# Line 255  Line 270 
270  } xvid_dec_stats_t;  } xvid_dec_stats_t;
271    
272    
273    
274    #define XVID_ZONE_QUANT     1
275    #define XVID_ZONE_WEIGHT    2
276    typedef struct
277    {
278        int frame;
279        int mode;
280        int increment;
281        int base;
282    } xvid_enc_zone_t;
283    
284    
285    
286  /*****************************************************************************  /*****************************************************************************
287    xvid plugin system -- internals    xvid plugin system -- internals
288    
# Line 264  Line 292 
292    xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY    xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
293   ****************************************************************************/   ****************************************************************************/
294    
295    
296  #define XVID_PLG_CREATE     0  #define XVID_PLG_CREATE     0
297  #define XVID_PLG_DESTROY    1  #define XVID_PLG_DESTROY    1
298  #define XVID_PLG_INFO       2  #define XVID_PLG_INFO       2
# Line 271  Line 300 
300  #define XVID_PLG_AFTER      4  #define XVID_PLG_AFTER      4
301    
302  /* xvid_plg_info_t.flags */  /* xvid_plg_info_t.flags */
303  #define XVID_PLG_ORIGINAL   1  /* plugin requires a copy of the original (uncompressed) image */  #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */
304    #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/
305    #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */
306    
307    
308  typedef struct  typedef struct
309  {  {
310      int version;      int version;
311      int flags;              /* plugin flags */      int flags;              /* [in:opt] plugin flags */
312  } xvid_plg_info_t;  } xvid_plg_info_t;
313    
314    
# Line 285  Line 316 
316  {  {
317      int version;      int version;
318    
319      int width, height;      int num_zones;          /* [out] */
320          int fincr, fbase;      xvid_enc_zone_t * zones;    /* [out] */
321    
322      void * param;      int width;              /* [out] */
323        int height;             /* [out] */
324        int mb_width;           /* [out] */
325        int mb_height;          /* [out] */
326            int fincr;              /* [out] */
327        int fbase;              /* [out] */
328    
329        void * param;           /* [out] */
330  } xvid_plg_create_t;  } xvid_plg_create_t;
331    
332    
# Line 296  Line 334 
334  {  {
335      int version;      int version;
336    
337      xvid_image_t reference;      int num_frames;          /* [out] totlal frame encoded */
338      xvid_image_t current;  } xvid_plg_destroy_t;
339      xvid_image_t original;          /* after: points the original (uncompressed) copy of the current frame */  
340    
341    typedef struct
342    {
343        int version;
344    
345        xvid_enc_zone_t * zone;    /* [out] current zone */
346    
347        int width;              /* [out] */
348        int height;             /* [out] */
349        int mb_width;           /* [out] */
350        int mb_height;          /* [out] */
351            int fincr;              /* [out] */
352        int fbase;              /* [out] */
353    
354        int min_quant[3];       /* [out] */
355        int max_quant[3];       /* [out] */
356    
357        xvid_image_t reference; /* [out] -> [out] */
358        xvid_image_t current;   /* [out] -> [in,out] */
359        xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
360        int frame_num;          /* [out] frame number */
361    
362      int type;                   /* [in,out] */      int type;                   /* [in,out] */
363      int quant;                  /* [in,out] */      int quant;                  /* [in,out] */
364    
365      unsigned char * qscale;     /* [in,out]     pointer to quantizer table */      int * dquant;               /* [in,out]     pointer to diff quantizer table */
366          int qscale_stride;              /* [in,out]     quantizer scale stride */          int dquant_stride;              /* [in,out]     diff quantizer stride */
367    
368      int vop_flags;          /* [in,out] */      int vop_flags;          /* [in,out] */
369      int vol_flags;          /* [in,out] */      int vol_flags;          /* [in,out] */
# Line 312  Line 371 
371    
372      int length;                 /* [out] after: length of encoded frame */      int length;                 /* [out] after: length of encoded frame */
373      int kblks, mblks, ublks;    /* [out] after: */      int kblks, mblks, ublks;    /* [out] after: */
374        int sse_y, sse_u, sse_v;    /* [out] */
375  } xvid_plg_data_t;  } xvid_plg_data_t;
376    
377    
# Line 344  Line 404 
404  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
405    
406    
407    xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
408    xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
409    xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
410    
411    xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
412    
413    xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */
414    xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
415    
416    
417    
418    typedef struct          /* single pass rate control */
419    {
420        int version;
421        int bitrate;                                /* bits per second */
422        int reaction_delay_factor;
423        int averaging_period;
424        int buffer;
425    } xvid_plugin_single_t;
426    
427    
428    typedef struct {
429        int version;
430        char * filename;
431    } xvid_plugin_2pass1_t;
432    
433    
434    #define XVID_CURVE_COSINE   0   /* low aggressiveness */
435    #define XVID_CURVE_LINEAR   1   /* medium aggressiveness */
436    #define XVID_CURVE_SINE     2   /* high aggressiveness */
437    
438    #define XVID_PAYBACK_BIAS   0   /* payback with bias */
439    #define XVID_PAYBACK_PROP   1   /* payback proportionally */
440    
441    typedef struct {
442        int version;
443        int bitrate;                                /* bits per second */
444        char * filename;
445    
446        int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */
447        int payback_method;
448        int bitrate_payback_delay;
449        int curve_compression_high;
450        int curve_compression_low;
451        int max_overflow_improvement;
452        int max_overflow_degradation;
453    
454        int use_alt_curve;
455            int alt_curve_high_dist;
456            int alt_curve_low_dist;
457        int alt_curve_use_auto;
458            int alt_curve_auto_str;
459            int alt_curve_type; /* XVID_CURVE_ */
460            int alt_curve_min_rel_qual;
461            int alt_curve_use_auto_bonus_bias;
462        int alt_curve_bonus_bias;
463    
464        int kftreshold;
465            int kfreduction;
466        int min_key_interval;
467    }xvid_plugin_2pass2_t;
468    
469    
470  /*****************************************************************************  /*****************************************************************************
471   * xvid_encore()   * xvid_encore()
# Line 361  Line 483 
483  /* global flags  */  /* global flags  */
484  typedef enum  typedef enum
485  {  {
486      XVID_PACKED                 = 0x00000001,   /* packed bitstream */      XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */
487      XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */      XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
488      XVID_EXTRASTATS_ENABLE  = 0x00000004      XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004
489  /*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 */
490  /*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 */
491  } xvid_global_t;  } xvid_global_t;
492    
493    
494  /* XVID_ENC_ENCODE param1 */  /* XVID_ENC_ENCODE param1 */
495  /* vol-based flags */  /* vol-based flags */
496  typedef enum {  typedef enum {
497      XVID_MPEGQUANT          = 0x00000001,      XVID_VOL_MPEGQUANT          = 0x00000001,
498      XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */      XVID_VOL_EXTRASTATS         = 0x00000002,
499      XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */      XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
500      XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */      XVID_VOL_GMC                            = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
501      XVID_INTERLACING        = 0x00000400, /* enable interlaced encoding */      XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
502        XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */
503  } xvid_vol_t;  } xvid_vol_t;
504    
505    
506  /* vop-based flags */  /* vop-based flags */
507  typedef enum {  typedef enum {
508      XVID_DEBUG              = 0x00000001,      XVID_VOP_DEBUG              = 0x00000001,
     XVID_EXTRASTATS         = 0x00000002,  
     XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */  
     XVID_INTER4V            = 0x00000008,  
     XVID_LUMIMASKING        = 0x00000010,  
509    
510      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */      XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */
511      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for      XVID_VOP_INTER4V            = 0x00000008,
512    
513        XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */
514    
515        XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
516        XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
517                                                color input material chroma is ignored) */                                                color input material chroma is ignored) */
518      XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */      XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
519      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 */
520      XVID_DYNAMIC_BFRAMES    = 0x00000200,  
521            /* only valid for vol_flags|=XVID_VOL_INTERLACING */
522          /* only valid for vol_flags|=XVID_INTERLACING */      XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
523      XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */      XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
     XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */  
524    
525      /* only valid for vol_flags|=XVID_REDUCED_ENABLED */      /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
526      XVID_REDUCED            = 0x00001000, /* reduced resolution vop */      XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */
527  } xvid_vop_t;  } xvid_vop_t;
528    
529    
530  typedef enum {  typedef enum {
531      PMV_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */      XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
532      PMV_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */      XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
533    
534      PMV_HALFPELREFINE16     = 0x00020000,      XVID_ME_HALFPELREFINE16     = 0x00020000,
535      PMV_HALFPELREFINE8      = 0x02000000,      XVID_ME_HALFPELREFINE8      = 0x02000000,
536    
537      PMV_QUARTERPELREFINE16  = 0x00040000,      XVID_ME_QUARTERPELREFINE16  = 0x00040000,
538      PMV_QUARTERPELREFINE8   = 0x04000000,      XVID_ME_QUARTERPELREFINE8   = 0x04000000,
539    
540      PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */      XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
541    
542      PMV_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */      XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
543      PMV_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */      XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */
544      PMV_USESQUARES8         = 0x80000000, /* use square for PMV_EXTSEARCH8 */      XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */
545    
546      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 */
547      PMV_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */      XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
548    
549      /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
550      HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */      XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
551      HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */      XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
552      QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */      XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
553      QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */      XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
554    
555      EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern      XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
556                                                    enable PMV_EXTSEARCH8 to do this in 8x8 search as well */                                                    enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
557      CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */      XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
558    
559      PMV_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */      XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
560      PMV_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */      XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
561      PMV_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */      XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
562      PMV_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */      XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
563  } xvid_motion_t;  } xvid_motion_t;
564    
565    
566  /* XVID_ENC_CREATE param1 */  /* XVID_ENC_CREATE param1 */
567  typedef struct {  typedef struct {
568          int version;          int version;
569    
570        int profile;            /* [in]     profile@level; refer to XVID_PROFILE_xxx */
571          int width;                              /* [in]         frame dimensions; width, pixel units */          int width;                              /* [in]         frame dimensions; width, pixel units */
572          int height;                             /* [in]         frame dimensions; height, pixel units */          int height;                             /* [in]         frame dimensions; height, pixel units */
573    
574        int num_zones;          /* [in:opt] number of bitrate zones */
575        xvid_enc_zone_t * zones; /*             ^^ zone array */
576    
577      int num_plugins;        /* [in:opt] number of plugins */      int num_plugins;        /* [in:opt] number of plugins */
578      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */      xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
579    
# Line 470  Line 598 
598          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 */
599          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 */
600    
601        int min_quant[3];       /* [in:opt] */
602        int max_quant[3];       /* [in:opt] */
603    
604  /* ^^^ -------------------------------------------------------------------------*/  /* ^^^ -------------------------------------------------------------------------*/
605    
606          void *handle;                   /* [out] encoder instance handle */          void *handle;                   /* [out] encoder instance handle */
# Line 477  Line 608 
608  xvid_enc_create_t;  xvid_enc_create_t;
609    
610    
 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;  
   
   
   
611  #define XVID_KEYFRAME   0x00000001  #define XVID_KEYFRAME   0x00000001
612    
613  typedef struct {  typedef struct {
# Line 522  Line 626 
626          int par_height;                 /* [in:opt] aspect ratio height */          int par_height;                 /* [in:opt] aspect ratio height */
627  /* ^^^----------------------------------------------------------------------------------*/  /* ^^^----------------------------------------------------------------------------------*/
628    
629        int fincr;                          /* framerate increment, for variable framerate only */
630          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
631          xvid_motion_t motion;                           /* [in] ME options */          xvid_motion_t motion;                           /* [in] ME options */
632    
# Line 529  Line 634 
634    
635          int type;                               /* [in:opt] coding type */          int type;                               /* [in:opt] coding type */
636          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
637          int bquant;                             /* [in:opt] bframe quantizer; if <=0, automatic*/          int bframe_threshold;
638    
639          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
640          int length;                             /* [in:opt] bitstream length (bytes) */          int length;                             /* [in:opt] bitstream length (bytes) */

Legend:
Removed from v.1.27.2.5  
changed lines
  Added in v.1.27.2.18

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