[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.1, Sat Feb 22 08:49:44 2003 UTC revision 1.27.2.16, Sun Apr 27 14:21:35 2003 UTC
# Line 26  Line 26 
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
29    
30  #ifdef __cplusplus  #ifdef __cplusplus
31  extern "C" {  extern "C" {
32  #endif  #endif
# Line 238  Line 239 
239                          int time_increment;     /* [out]        time increment */                          int time_increment;     /* [out]        time increment */
240    
241                          /* XXX: external deblocking stuff */                          /* XXX: external deblocking stuff */
242                          unsigned char * qscale; /* [out]        pointer to quantizer table */                          int * qscale;   /* [out]        pointer to quantizer table */
243                          int qscale_stride;              /* [out]        quantizer scale stride */                          int qscale_stride;              /* [out]        quantizer scale stride */
244    
245                  } vop;                  } vop;
# Line 254  Line 255 
255  } xvid_dec_stats_t;  } xvid_dec_stats_t;
256    
257    
258    /*****************************************************************************
259      xvid plugin system -- internals
260    
261      xvidcore will call XVID_PLG_INFO and XVID_PLG_CREATE during XVID_ENC_CREATE
262      before encoding each frame xvidcore will call XVID_PLG_BEFORE
263      after encoding each frame xvidcore will call XVID_PLG_AFTER
264      xvidcore will call XVID_PLG_DESTROY during XVID_ENC_DESTROY
265     ****************************************************************************/
266    
267    #define XVID_PLG_CREATE     0
268    #define XVID_PLG_DESTROY    1
269    #define XVID_PLG_INFO       2
270    #define XVID_PLG_BEFORE     3
271    #define XVID_PLG_AFTER      4
272    
273    /* xvid_plg_info_t.flags */
274    #define XVID_REQORIGINAL    1  /* plugin requires a copy of the original (uncompressed) image */
275    #define XVID_REQPSNR        2  /* plugin requires psnr between the uncompressed and compressed image*/
276    #define XVID_REQDQUANTS      3  /* plugin requires access to the dquant table */
277    
278    
279    typedef struct
280    {
281        int version;
282        int flags;              /* plugin flags */
283    } xvid_plg_info_t;
284    
285    
286    typedef struct
287    {
288        int version;
289    
290        int width;
291        int height;
292        int mb_width;
293        int mb_height;
294            int fincr;
295        int fbase;
296    
297        void * param;
298    } xvid_plg_create_t;
299    
300    
301    typedef struct
302    {
303        int version;
304    
305        int num_frames;          /* [out] totlal frame encoded */
306    } xvid_plg_destroy_t;
307    
308    
309    typedef struct
310    {
311        int version;
312    
313        int width;              /* [out] */
314        int height;             /* [out] */
315        int mb_width;           /* [out] */
316        int mb_height;          /* [out] */
317            int fincr;              /* [out] */
318        int fbase;              /* [out] */
319    
320        xvid_image_t reference; /* [out] -> [out] */
321        xvid_image_t current;   /* [out] -> [in,out] */
322        xvid_image_t original;      /* [out] after: points the original (uncompressed) copy of the current frame */
323        int frame_num;          /* [out] frame number */
324    
325        int type;               /* [in,out] */
326        int quant;              /* [in,out] */
327    
328        int * dquant;               /* [in,out]     pointer to diff quantizer table */
329            int dquant_stride;              /* [in,out]     diff quantizer stride */
330    
331        int vop_flags;          /* [in,out] */
332        int vol_flags;          /* [in,out] */
333        int motion_flags;       /* [in,out] */
334    
335        int length;                 /* [out] after: length of encoded frame */
336        int kblks, mblks, ublks;    /* [out] after: */
337        int sse_y, sse_u, sse_v;    /* [out] */
338    } xvid_plg_data_t;
339    
340    
341    /*****************************************************************************
342      xvid plugin system -- external
343    
344      the application passes xvid an array of "xvid_plugin_t" at XVID_ENC_CREATE. the array
345      indicates the plugin function pointer and plugin-specific data.
346      xvidcore handles the rest. example:
347    
348      xvid_enc_create_t create;
349      xvid_enc_plugin_t plugins[2];
350    
351      plugins[0].func = xvid_psnr_func;
352      plugins[0].param = NULL;
353      plugins[1].func = xvid_cbr_func;
354      plugins[1].param = &cbr_data;
355    
356      create.num_plugins = 2;
357      create.plugins = plugins;
358    
359     ****************************************************************************/
360    
361    typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
362    
363    typedef struct
364    {
365        xvid_plugin_func * func;
366        void * param;
367    } xvid_enc_plugin_t;
368    
369    
370    
371    xvid_plugin_func xvid_plugin_fixed;   /* fixed quantizer control */
372    xvid_plugin_func xvid_plugin_cbr;   /* constant bitrate control */
373    xvid_plugin_func xvid_plugin_2pass1;   /* 2pass rate control: first pass */
374    xvid_plugin_func xvid_plugin_2pass2;   /* 2pass rate control: second pass */
375    
376    xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
377    
378    xvid_plugin_func xvid_plugin_psnr;  /* write psnr values to stdout */
379    xvid_plugin_func xvid_plugin_dump;  /* dump before and after yuvpgms */
380    
381    
382    typedef struct
383    {
384        int version;
385        int quant_increment;
386        int quant_base;
387    } xvid_plugin_fixed_t;
388    
389    
390    typedef struct
391    {
392        int version;
393        int bitrate;                                /* bits per second */
394        int max_quantizer;
395        int min_quantizer;
396        int reaction_delay_factor;
397        int averaging_period;
398        int buffer;
399    } xvid_plugin_cbr_t;
400    
401    
402    typedef struct {
403        int version;
404        char * filename;
405    } xvid_plugin_2pass1_t;
406    
407    
408    #define XVID_CURVE_COSINE   0   /* low aggressiveness */
409    #define XVID_CURVE_LINEAR   1   /* medium aggressiveness */
410    #define XVID_CURVE_SINE     2   /* high aggressiveness */
411    
412    #define XVID_PAYBACK_BIAS   0   /* payback with bias */
413    #define XVID_PAYBACK_PROP   1   /* payback proportionally */
414    
415    typedef struct {
416        int version;
417        char * filename;
418            int bitrate;                            /* bits per second */
419    
420        int keyframe_boost;             /* keyframe boost percentage: [0..100...]; */
421        int payback_method;
422        int bitrate_payback_delay;
423        int curve_compression_high;
424        int curve_compression_low;
425        int max_overflow_improvement;
426        int max_overflow_degradation;
427        int min_quant[3];
428        int max_quant[3];
429    
430        int use_alt_curve;
431            int alt_curve_high_dist;
432            int alt_curve_low_dist;
433        int alt_curve_use_auto;
434            int alt_curve_auto_str;
435            int alt_curve_type; /* XVID_CURVE_ */
436            int alt_curve_min_rel_qual;
437            int alt_curve_use_auto_bonus_bias;
438        int alt_curve_bonus_bias;
439    
440        int kftreshold;
441            int kfreduction;
442        int min_key_interval;
443    }xvid_plugin_2pass2_t;
444    
445    
446  /*****************************************************************************  /*****************************************************************************
447   * xvid_encore()   * xvid_encore()
# Line 271  Line 459 
459  /* global flags  */  /* global flags  */
460  typedef enum  typedef enum
461  {  {
462      XVID_PACKED                 = 0x00000001,   /* packed bitstream */      XVID_GLOBAL_PACKED                  = 0x00000001,   /* packed bitstream */
463      XVID_CLOSED_GOP             = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */      XVID_GLOBAL_CLOSED_GOP              = 0x00000002,   /* closed_gop:  was DX50BVOP dx50 bvop compatibility */
464      XVID_EXTRASTATS_ENABLE  = 0x00000004      XVID_GLOBAL_EXTRASTATS_ENABLE  = 0x00000004
465  /*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 */
466  /*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 */
467  } xvid_global_t;  } xvid_global_t;
468    
469    
470  /* XVID_ENC_ENCODE param1 */  /* XVID_ENC_ENCODE param1 */
471  /* vol-based flags */  /* vol-based flags */
472  typedef enum {  typedef enum {
473      XVID_MPEGQUANT          = 0x00000001,      XVID_VOL_MPEGQUANT          = 0x00000001,
474      XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */      XVID_VOL_EXTRASTATS         = 0x00000002,
475      XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */      XVID_VOL_QUARTERPEL         = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
476      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 */
477      XVID_INTERLACING        = 0x00000400, /* enable interlaced encoding */      XVID_VOL_REDUCED_ENABLE         = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
478        XVID_VOL_INTERLACING        = 0x00000400, /* enable interlaced encoding */
479  } xvid_vol_t;  } xvid_vol_t;
480    
481    
482  /* vop-based flags */  /* vop-based flags */
483  typedef enum {  typedef enum {
484      XVID_DEBUG              = 0x00000001,      XVID_VOP_DEBUG              = 0x00000001,
485      XVID_EXTRASTATS         = 0x00000002,  
486      XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */      XVID_VOP_HALFPEL            = 0x00000004, /* use halfpel interpolation */
487      XVID_INTER4V            = 0x00000008,      XVID_VOP_INTER4V            = 0x00000008,
     XVID_LUMIMASKING        = 0x00000010,  
488    
489      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */      XVID_VOP_TRELLISQUANT       = 0x00000010, /* use trellis based R-D "optimal" quantization */
490      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for  
491        XVID_VOP_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
492        XVID_VOP_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
493                                                color input material chroma is ignored) */                                                color input material chroma is ignored) */
494      XVID_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */      XVID_VOP_HQACPRED           = 0x00000080, /* 20030209: high quality ac prediction */
495      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 */
496      XVID_DYNAMIC_BFRAMES    = 0x00000200,      XVID_VOP_DYNAMIC_BFRAMES    = 0x00000200,
497    
498          /* only valid for vol_flags|=XVID_INTERLACING */          /* only valid for vol_flags|=XVID_VOL_INTERLACING */
499      XVID_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */      XVID_VOP_TOPFIELDFIRST      = 0x00000400, /* set top-field-first flag  */
500      XVID_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */      XVID_VOP_ALTERNATESCAN      = 0x00000800, /* set alternate vertical scan flag */
501    
502      /* only valid for vol_flags|=XVID_REDUCED_ENABLED */      /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
503      XVID_REDUCED            = 0x00001000, /* reduced resolution vop */      XVID_VOP_REDUCED            = 0x00001000, /* reduced resolution vop */
504  } xvid_vop_t;  } xvid_vop_t;
505    
506    
507  typedef enum {  typedef enum {
508      PMV_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */      XVID_ME_ADVANCEDDIAMOND16   = 0x00008000, /* use advdiamonds instead of diamonds as search pattern */
509      PMV_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */      XVID_ME_USESQUARES16        = 0x00800000, /* use squares instead of diamonds as search pattern */
510    
511      PMV_HALFPELREFINE16     = 0x00020000,      XVID_ME_HALFPELREFINE16     = 0x00020000,
512      PMV_HALFPELREFINE8      = 0x02000000,      XVID_ME_HALFPELREFINE8      = 0x02000000,
513    
514      PMV_QUARTERPELREFINE16  = 0x00040000,      XVID_ME_QUARTERPELREFINE16  = 0x00040000,
515      PMV_QUARTERPELREFINE8   = 0x04000000,      XVID_ME_QUARTERPELREFINE8   = 0x04000000,
516    
517      PMV_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */      XVID_ME_EXTSEARCH16         = 0x00080000, /* extend PMV by more searches */
518    
519      PMV_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */      XVID_ME_EXTSEARCH8          = 0x08000000, /* use diamond/square for extended 8x8 search */
520      PMV_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for PMV_EXTSEARCH8 */      XVID_ME_ADVANCEDDIAMOND8    = 0x00004000, /* use advdiamond for XVID_ME_EXTSEARCH8 */
521      PMV_USESQUARES8         = 0x80000000, /* use square for PMV_EXTSEARCH8 */      XVID_ME_USESQUARES8         = 0x80000000, /* use square for XVID_ME_EXTSEARCH8 */
522    
523      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 */
524      PMV_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */      XVID_ME_CHROMA8             = 0x10000000, /* also use chroma for B_VOP ME */
525    
526      /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */      /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */
527      HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */      XVID_ME_HALFPELREFINE16_BITS    = 0x00000100, /* perform DCT-based halfpel refinement */
528      HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */      XVID_ME_HALFPELREFINE8_BITS     = 0x00000200, /* perform DCT-based halfpel refinement for 8x8 mode */
529      QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */      XVID_ME_QUARTERPELREFINE16_BITS = 0x00000400, /* perform DCT-based qpel refinement */
530      QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */      XVID_ME_QUARTERPELREFINE8_BITS  = 0x00000800, /* perform DCT-based qpel refinement for 8x8 mode */
531    
532      EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern      XVID_ME_EXTSEARCH_BITS          = 0x00001000, /* perform DCT-based search using square pattern
533                                                    enable PMV_EXTSEARCH8 to do this in 8x8 search as well */                                                    enable XVID_ME_EXTSEARCH8 to do this in 8x8 search as well */
534      CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */      XVID_ME_CHECKPREDICTION_BITS    = 0x00002000, /* always check vector equal to prediction */
535    
536      PMV_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */      XVID_ME_UNRESTRICTED16      = 0x00200000, /* unrestricted ME, not implemented */
537      PMV_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */      XVID_ME_OVERLAPPING16       = 0x00400000, /* overlapping ME, not implemented */
538      PMV_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */      XVID_ME_UNRESTRICTED8       = 0x20000000, /* unrestricted ME, not implemented */
539      PMV_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */      XVID_ME_OVERLAPPING8        = 0x40000000 /* overlapping ME, not implemented */
540  } xvid_motion_t;  } xvid_motion_t;
541    
542    
# Line 356  Line 546 
546          int width;                              /* [in]         frame dimensions; width, pixel units */          int width;                              /* [in]         frame dimensions; width, pixel units */
547          int height;                             /* [in]         frame dimensions; height, pixel units */          int height;                             /* [in]         frame dimensions; height, pixel units */
548    
549        int num_plugins;        /* [in:opt] number of plugins */
550        xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
551    
552          int num_threads;                /* [in:opt]     number of threads */          int num_threads;                /* [in:opt]     number of threads */
553          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
554    
# Line 384  Line 577 
577  xvid_enc_create_t;  xvid_enc_create_t;
578    
579    
 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;  
   
   
   
580  #define XVID_KEYFRAME   0x00000001  #define XVID_KEYFRAME   0x00000001
581    
582  typedef struct {  typedef struct {
# Line 429  Line 595 
595          int par_height;                 /* [in:opt] aspect ratio height */          int par_height;                 /* [in:opt] aspect ratio height */
596  /* ^^^----------------------------------------------------------------------------------*/  /* ^^^----------------------------------------------------------------------------------*/
597    
598        int fincr;                          /* framerate increment, for variable framerate only */
599          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
600          xvid_motion_t motion;                           /* [in] ME options */          xvid_motion_t motion;                           /* [in] ME options */
601    
# Line 436  Line 603 
603    
604          int type;                               /* [in:opt] coding type */          int type;                               /* [in:opt] coding type */
605          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
606          int bquant;                             /* [in:opt] bframe quantizer; if <=0, automatic*/          int bframe_threshold;
607    
608          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
609          int length;                             /* [in:opt] bitstream length (bytes) */          int length;                             /* [in:opt] bitstream length (bytes) */
# Line 449  Line 616 
616  /* XVID_ENC_ENCODE param2 (optional)  /* XVID_ENC_ENCODE param2 (optional)
617          xvid_enc_stats_t describes individual frame details          xvid_enc_stats_t describes individual frame details
618    
         when bframes>0, you must pass _two_ of these to xvid_encore()  
         ie. xstats[2]; xvid_encore(..., xstats)  
619          coding_type==XVID_TYPE_NOTHING if the stats are not given          coding_type==XVID_TYPE_NOTHING if the stats are not given
620  */  */
621  typedef struct {  typedef struct {
# Line 475  Line 640 
640  }  }
641  #endif  #endif
642    
643    
644  #endif  #endif

Legend:
Removed from v.1.27.2.1  
changed lines
  Added in v.1.27.2.16

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