[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.12, Wed Mar 26 11:01:03 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;
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 * filename1;
418        char * filename2;
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 283  Line 471 
471  /* vol-based flags */  /* vol-based flags */
472  typedef enum {  typedef enum {
473      XVID_MPEGQUANT          = 0x00000001,      XVID_MPEGQUANT          = 0x00000001,
474        XVID_EXTRASTATS         = 0x00000002,
475      XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */      XVID_QUARTERPEL             = 0x00000004,   /* enable quarterpel: frames will encoded as quarterpel */
476      XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */      XVID_GMC                        = 0x00000008,       /* enable GMC; frames will be checked for gmc suitability */
477      XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */      XVID_REDUCED_ENABLE     = 0x00000010,       /* enable reduced resolution vops: frames will be checked for rrv suitability */
# Line 293  Line 482 
482  /* vop-based flags */  /* vop-based flags */
483  typedef enum {  typedef enum {
484      XVID_DEBUG              = 0x00000001,      XVID_DEBUG              = 0x00000001,
485      XVID_EXTRASTATS         = 0x00000002,  
486      XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */      XVID_HALFPEL            = 0x00000004, /* use halfpel interpolation */
487      XVID_INTER4V            = 0x00000008,      XVID_INTER4V            = 0x00000008,
     XVID_LUMIMASKING        = 0x00000010,  
488    
489      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */      XVID_CHROMAOPT          = 0x00000020, /* enable chroma optimization pre-filter */
490      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for      XVID_GREYSCALE          = 0x00000040, /* enable greyscale only mode (even for
# Line 356  Line 544 
544          int width;                              /* [in]         frame dimensions; width, pixel units */          int width;                              /* [in]         frame dimensions; width, pixel units */
545          int height;                             /* [in]         frame dimensions; height, pixel units */          int height;                             /* [in]         frame dimensions; height, pixel units */
546    
547        int num_plugins;        /* [in:opt] number of plugins */
548        xvid_enc_plugin_t * plugins; /*        ^^ plugin array */
549    
550          int num_threads;                /* [in:opt]     number of threads */          int num_threads;                /* [in:opt]     number of threads */
551          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;                /* [in:opt] max sequential bframes (0=disable bframes) */
552    
# Line 384  Line 575 
575  xvid_enc_create_t;  xvid_enc_create_t;
576    
577    
 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;  
   
   
   
578  #define XVID_KEYFRAME   0x00000001  #define XVID_KEYFRAME   0x00000001
579    
580  typedef struct {  typedef struct {
# Line 429  Line 593 
593          int par_height;                 /* [in:opt] aspect ratio height */          int par_height;                 /* [in:opt] aspect ratio height */
594  /* ^^^----------------------------------------------------------------------------------*/  /* ^^^----------------------------------------------------------------------------------*/
595    
596        int fincr;                          /* framerate increment, for variable framerate only */
597          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */          xvid_vop_t vop_flags;                   /* [in] (general)vop-based flags */
598          xvid_motion_t motion;                           /* [in] ME options */          xvid_motion_t motion;                           /* [in] ME options */
599    
# Line 436  Line 601 
601    
602          int type;                               /* [in:opt] coding type */          int type;                               /* [in:opt] coding type */
603          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */          int quant;                              /* [in] frame quantizer; if <=0, automatatic (ratecontrol) */
         int bquant;                             /* [in:opt] bframe quantizer; if <=0, automatic*/  
604    
605          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/          void *bitstream;                /* [in:opt] bitstream ptr (written to)*/
606          int length;                             /* [in:opt] bitstream length (bytes) */          int length;                             /* [in:opt] bitstream length (bytes) */
# Line 449  Line 613 
613  /* XVID_ENC_ENCODE param2 (optional)  /* XVID_ENC_ENCODE param2 (optional)
614          xvid_enc_stats_t describes individual frame details          xvid_enc_stats_t describes individual frame details
615    
         when bframes>0, you must pass _two_ of these to xvid_encore()  
         ie. xstats[2]; xvid_encore(..., xstats)  
616          coding_type==XVID_TYPE_NOTHING if the stats are not given          coding_type==XVID_TYPE_NOTHING if the stats are not given
617  */  */
618  typedef struct {  typedef struct {
# Line 475  Line 637 
637  }  }
638  #endif  #endif
639    
640    
641  #endif  #endif

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

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