[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.44, Sat Nov 29 17:26:12 2003 UTC revision 1.56, Wed Oct 11 13:55:32 2006 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   *  Copyright(C) 2001-2003 Peter Ross <pross@xvid.org>   *  Copyright(C) 2001-2004 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 57  Line 57 
57  #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)  #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)
58  #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)  #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)
59    
60  #define XVID_VERSION             XVID_MAKE_VERSION(1,0,-127)  #define XVID_VERSION             XVID_MAKE_VERSION(1,2,-127)
61  #define XVID_API                 XVID_MAKE_API(4, 0)  #define XVID_API                 XVID_MAKE_API(4, 1)
62    
63  #define XVID_UNSTABLE  #define XVID_UNSTABLE
64    
# Line 73  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 "0021"  #define XVID_BS_VERSION 45
   
77    
78  /*****************************************************************************  /*****************************************************************************
79   * error codes   * error codes
# Line 96  Line 95 
95    
96  /* colorspace values */  /* colorspace values */
97    
98  #define XVID_CSP_USER     (1<< 0) /* 4:2:0 planar */  #define XVID_CSP_PLANAR   (1<< 0) /* 4:2:0 planar (==I420, except for pointers/strides) */
99  #define XVID_CSP_I420     (1<< 1) /* 4:2:0 packed(planar win32) */  #define XVID_CSP_USER     XVID_CSP_PLANAR
100  #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 packed(planar win32) */  #define XVID_CSP_I420     (1<< 1) /* 4:2:0 planar */
101    #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 planar */
102  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */
103  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */
104  #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */  #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */
105  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
106  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
107  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
108    #define XVID_CSP_ARGB     (1<<15) /* 32-bit argb packed */
109  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
110  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
111  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
# Line 138  Line 139 
139  #define XVID_PROFILE_AS_L4   0xf4  #define XVID_PROFILE_AS_L4   0xf4
140    
141  /* aspect ratios */  /* aspect ratios */
142  #define XVID_PAR_11_VGA    1 /* 1:1 vga (square), default if AR is not precised (ie: ==0) */  #define XVID_PAR_11_VGA    1 /* 1:1 vga (square), default if supplied PAR is not a valid value */
143  #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) */
144  #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) */
145  #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 218  Line 219 
219  #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 */
220  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
221    
222  int xvid_global(void *handle, int opt, void *param1, void *param2);  extern int xvid_global(void *handle, int opt, void *param1, void *param2);
223    
224    
225  /*****************************************************************************  /*****************************************************************************
# Line 229  Line 230 
230  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
231  #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */  #define XVID_DEC_DECODE  2 /* decode a frame: returns number of bytes consumed >= 0 */
232    
233  int xvid_decore(void *handle, int opt, void *param1, void *param2);  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
234    
235  /* XVID_DEC_CREATE param 1  /* XVID_DEC_CREATE param 1
236          image width & height may be specified here when the dimensions are          image width & height may be specified here when the dimensions are
# Line 246  Line 247 
247  /* general flags */  /* general flags */
248  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
249  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
250    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
251    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
252    #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
253    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
254    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
255    
256    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
257    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
258    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
259    
260  typedef struct {  typedef struct {
261          int version;          int version;
# Line 253  Line 263 
263          void *bitstream;     /* [in]     bitstream (read from)*/          void *bitstream;     /* [in]     bitstream (read from)*/
264          int length;          /* [in]     bitstream length */          int length;          /* [in]     bitstream length */
265          xvid_image_t output; /* [in]     output image (written to) */          xvid_image_t output; /* [in]     output image (written to) */
266    /* ------- v1.1.x ------- */
267            int brightness;          /* [in]         brightness offset (0=none) */
268  } xvid_dec_frame_t;  } xvid_dec_frame_t;
269    
270    
# Line 277  Line 289 
289                          int general;        /* [out] flags */                          int general;        /* [out] flags */
290                          int width;          /* [out] width */                          int width;          /* [out] width */
291                          int height;         /* [out] height */                          int height;         /* [out] height */
292                          int par;            /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */                          int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
293                          int par_width;      /* [out] aspect ratio width */                          int par_width;      /* [out] aspect ratio width  [1..255] */
294                          int par_height;     /* [out] aspect ratio height */                          int par_height;     /* [out] aspect ratio height [1..255] */
295                  } vol;                  } vol;
296          } data;          } data;
297  } xvid_dec_stats_t;  } xvid_dec_stats_t;
298    
   
   
299  #define XVID_ZONE_QUANT  (1<<0)  #define XVID_ZONE_QUANT  (1<<0)
300  #define XVID_ZONE_WEIGHT (1<<1)  #define XVID_ZONE_WEIGHT (1<<1)
301    
# Line 298  Line 308 
308  } xvid_enc_zone_t;  } xvid_enc_zone_t;
309    
310    
311    /*----------------------------------------------------------------------------
312     * xvid_enc_stats_t structure
313     *
314     * Used in:
315     *  - xvid_plg_data_t structure
316     *  - optional parameter in xvid_encore() function
317     *
318     * .coding_type = XVID_TYPE_NOTHING if the stats are not given
319     *--------------------------------------------------------------------------*/
320    
321    typedef struct {
322            int version;
323    
324            /* encoding parameters */
325            int type;      /* [out] coding type */
326            int quant;     /* [out] frame quantizer */
327            int vol_flags; /* [out] vol flags (see above) */
328            int vop_flags; /* [out] vop flags (see above) */
329    
330            /* bitrate */
331            int length;    /* [out] frame length */
332    
333            int hlength;   /* [out] header length (bytes) */
334            int kblks;     /* [out] number of blocks compressed as Intra */
335            int mblks;     /* [out] number of blocks compressed as Inter */
336            int ublks;     /* [out] number of blocks marked as not_coded */
337    
338            int sse_y;     /* [out] Y plane's sse */
339            int sse_u;     /* [out] U plane's sse */
340            int sse_v;     /* [out] V plane's sse */
341    } xvid_enc_stats_t;
342    
343  /*****************************************************************************  /*****************************************************************************
344    xvid plugin system -- internals    xvid plugin system -- internals
# Line 320  Line 361 
361  #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */  #define XVID_REQORIGINAL (1<<0) /* plugin requires a copy of the original (uncompressed) image */
362  #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/  #define XVID_REQPSNR     (1<<1) /* plugin requires psnr between the uncompressed and compressed image*/
363  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
364    #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */
365    
366    
367  typedef struct  typedef struct
# Line 354  Line 396 
396          int num_frames; /* [out] total frame encoded */          int num_frames; /* [out] total frame encoded */
397  } xvid_plg_destroy_t;  } xvid_plg_destroy_t;
398    
   
399  typedef struct  typedef struct
400  {  {
401          int version;          int version;
# Line 386  Line 427 
427          int vol_flags;          /* [in,out] */          int vol_flags;          /* [in,out] */
428          int motion_flags;       /* [in,out] */          int motion_flags;       /* [in,out] */
429    
430            /* Lambda table for HVSPlugins */
431            float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
432    
433    /* Deprecated, use the stats field instead.
434     * Will disapear before 1.0 */
435          int length;             /* [out] after: length of encoded frame */          int length;             /* [out] after: length of encoded frame */
436          int kblks;              /* [out] number of blocks compressed as Intra */          int kblks;              /* [out] number of blocks compressed as Intra */
437          int mblks;              /* [out] number of blocks compressed as Inter */          int mblks;              /* [out] number of blocks compressed as Inter */
# Line 393  Line 439 
439          int sse_y;              /* [out] Y plane's sse */          int sse_y;              /* [out] Y plane's sse */
440          int sse_u;              /* [out] U plane's sse */          int sse_u;              /* [out] U plane's sse */
441          int sse_v;              /* [out] V plane's sse */          int sse_v;              /* [out] V plane's sse */
442    /* End of duplicated data, kept only for binary compatibility */
443    
444          int bquant_ratio;       /* [in] */          int bquant_ratio;       /* [in] */
445          int bquant_offset;      /* [in] */          int bquant_offset;      /* [in] */
 } xvid_plg_data_t;  
446    
447            xvid_enc_stats_t stats; /* [out] frame statistics */
448    } xvid_plg_data_t;
449    
450  /*****************************************************************************  /*****************************************************************************
451    xvid plugin system -- external    xvid plugin system -- external
# Line 427  Line 476 
476  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
477    
478    
479  xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
480  xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */  extern xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
481  xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */  extern xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
482    
483    extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
484    
485  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
486    extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
487    
488  xvid_plugin_func xvid_plugin_psnr;      /* write psnr values to stdout */  extern xvid_plugin_func xvid_plugin_ssim;       /*write ssim values to stdout*/
 xvid_plugin_func xvid_plugin_dump;      /* dump before and after yuvpgms */  
489    
490    
491  /* single pass rate control  /* single pass rate control
# Line 463  Line 514 
514  typedef struct {  typedef struct {
515          int version;          int version;
516    
517          int bitrate;                  /* [in] bits per second */          int bitrate;                  /* [in] target bitrate (bits per second) */
518          char * filename;              /* [in] first pass stats filename */          char * filename;              /* [in] first pass stats filename */
519    
520          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
# Line 473  Line 524 
524          int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */          int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
525          int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */          int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
526    
527          int kfreduction;              /* [in] */          int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
528          int min_key_interval;         /* [in] Minimum interval of frames between two IFrames */          int kfthreshold;              /* [in] if an iframe is closer to the next iframe than this distance, a quantity of bits
529                                                                       *      is substracted from its bit allocation. The reduction is computed as multiples of
530                                                                       *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
531                                                                       *      0 for 1<distance<kfthreshold */
532    
533          int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */          int container_frame_overhead; /* [in] How many bytes the controller has to compensate per frame due to container format overhead */
534    
535    /* ------- v1.1.x ------- */
536            int vbv_size;                 /* [in] buffer size (bits) */
537            int vbv_initial;              /* [in] initial buffer occupancy (bits) */
538            int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
539            int vbv_peakrate;             /* [in:opt] max average bitrate over 3 seconds (bits per second) */
540    
541  }xvid_plugin_2pass2_t;  }xvid_plugin_2pass2_t;
542    
543    
544    typedef struct{
545            /*stat output*/
546            int b_printstat;
547            char* stat_path;
548    
549            /*visualize*/
550            int b_visualize;
551    
552    } xvid_plugin_ssim_t;
553    
554  /*****************************************************************************  /*****************************************************************************
555   * xvid_encore()   *                             ENCODER API
556   ****************************************************************************/   ****************************************************************************/
557    
558  /* Encoder options */  /*----------------------------------------------------------------------------
559     * Encoder operations
560     *--------------------------------------------------------------------------*/
561    
562  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
563  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
564  #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
565                              * 0 means this frame should not be written (ie. encoder lag) */                              * 0 means this frame should not be written (ie. encoder lag) */
566    
567  int xvid_encore(void *handle, int opt, void *param1, void *param2);  
568    /*----------------------------------------------------------------------------
569     * Encoder entry point
570     *--------------------------------------------------------------------------*/
571    
572    extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
573    
574    /* Quick API reference
575     *
576     * XVID_ENC_CREATE operation
577     *  - handle: ignored
578     *  - opt: XVID_ENC_CREATE
579     *  - param1: address of a xvid_enc_create_t structure
580     *  - param2: ignored
581     *
582     * XVID_ENC_ENCODE operation
583     *  - handle: an instance returned by a CREATE op
584     *  - opt: XVID_ENC_ENCODE
585     *  - param1: address of a xvid_enc_frame_t structure
586     *  - param2: address of a xvid_enc_stats_t structure (optional)
587     *            its return value is asynchronous to what is written to the buffer
588     *            depending on the delay introduced by bvop use. It's display
589     *            ordered.
590     *
591     * XVID_ENC_DESTROY operation
592     *  - handle: an instance returned by a CREATE op
593     *  - opt: XVID_ENC_DESTROY
594     *  - param1: ignored
595     *  - param2: ignored
596     */
597    
598    
599    /*----------------------------------------------------------------------------
600     * "Global" flags
601     *
602     * These flags are used for xvid_enc_create_t->global field during instance
603     * creation (operation XVID_ENC_CREATE)
604     *--------------------------------------------------------------------------*/
605    
 /* Global Flags */  
606  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
607  #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */  #define XVID_GLOBAL_CLOSED_GOP        (1<<1) /* closed_gop:     was DX50BVOP dx50 bvop compatibility */
608  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
# Line 502  Line 610 
610  #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */  #define XVID_GLOBAL_VOL_AT_IVOP       (1<<3) /* write vol at every ivop: WIN32/divx compatibility */
611  #define XVID_GLOBAL_FORCE_VOL         (1<<4) /* 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 */
612  #endif  #endif
613    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
614                                                    this is implied if XVID_GLOBAL_PACKED is set */
615    
616    /*----------------------------------------------------------------------------
617     * "VOL" flags
618     *
619     * These flags are used for xvid_enc_frame_t->vol_flags field during frame
620     * encoding (operation XVID_ENC_ENCODE)
621     *--------------------------------------------------------------------------*/
622    
 /* XVID_ENC_ENCODE param1 */  
 /* vol-based flags */  
623  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
624  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
625  #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */  #define XVID_VOL_QUARTERPEL     (1<<2) /* enable quarterpel: frames will encoded as quarterpel */
626  #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */  #define XVID_VOL_GMC            (1<<3) /* enable GMC; frames will be checked for gmc suitability */
627  #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */  #define XVID_VOL_REDUCED_ENABLE (1<<4) /* enable reduced resolution vops: frames will be checked for rrv suitability */
628                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
629  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
630    
631    
632    /*----------------------------------------------------------------------------
633     * "VOP" flags
634     *
635     * These flags are used for xvid_enc_frame_t->vop_flags field during frame
636     * encoding (operation XVID_ENC_ENCODE)
637     *--------------------------------------------------------------------------*/
638    
639  /* vop based flags */  /* Always valid */
640  #define XVID_VOP_DEBUG           (1<< 0)  #define XVID_VOP_DEBUG                (1<< 0) /* print debug messages in frames */
641  #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */  #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */
642  #define XVID_VOP_INTER4V         (1<< 2)  #define XVID_VOP_INTER4V              (1<< 2) /* use 4 motion vectors per MB */
643  #define XVID_VOP_TRELLISQUANT    (1<< 3) /* use trellis based R-D "optimal" quantization */  #define XVID_VOP_TRELLISQUANT    (1<< 3) /* use trellis based R-D "optimal" quantization */
644  #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */  #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */
645  #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */  #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */
646  #define XVID_VOP_GREYSCALE       (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */  #define XVID_VOP_GREYSCALE       (1<< 6) /* enable greyscale only mode (even for  color input material chroma is ignored) */
647  #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */  #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */
648  #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */  #define XVID_VOP_MODEDECISION_RD (1<< 8) /* enable DCT-ME and use it for mode decision */
649  /* only valid for vol_flags|=XVID_VOL_INTERLACING */  #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
650    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
651    
652    /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
653  #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */  #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */
654  #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */  #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */
655    
656  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
657  #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */  #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */
658                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
659    
660  #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */  /*----------------------------------------------------------------------------
661     * "Motion" flags
662     *
663     * These flags are used for xvid_enc_frame_t->motion field during frame
664     * encoding (operation XVID_ENC_ENCODE)
665     *--------------------------------------------------------------------------*/
666    
667  /* Motion based flags */  /* Motion Estimation Search Patterns */
668  #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */  #define XVID_ME_ADVANCEDDIAMOND16     (1<< 0) /* use advdiamonds instead of diamonds as search pattern */
669  #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */  #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
670  #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */  #define XVID_ME_USESQUARES16          (1<< 2) /* use squares instead of diamonds as search pattern */
671  #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */  #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
672    
673    /* SAD operator based flags */
674  #define XVID_ME_HALFPELREFINE16       (1<< 4)  #define XVID_ME_HALFPELREFINE16       (1<< 4)
675  #define XVID_ME_HALFPELREFINE8        (1<< 6)  #define XVID_ME_HALFPELREFINE8        (1<< 6)
676  #define XVID_ME_QUARTERPELREFINE16    (1<< 7)  #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
# Line 549  Line 680 
680  #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */  #define XVID_ME_EXTSEARCH8            (1<<11) /* use diamond/square for extended 8x8 search */
681  #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */  #define XVID_ME_CHROMA_PVOP           (1<<12) /* also use chroma for P_VOP/S_VOP ME */
682  #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */  #define XVID_ME_CHROMA_BVOP           (1<<13) /* also use chroma for B_VOP ME */
683    #define XVID_ME_FASTREFINE16          (1<<25) /* use low-complexity refinement functions */
684    #define XVID_ME_FASTREFINE8           (1<<29) /* low-complexity 8x8 sub-block refinement */
685    
686  /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */  /* Rate Distortion based flags
687     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
688  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
689  #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */  #define XVID_ME_HALFPELREFINE8_RD     (1<<15) /* perform RD-based halfpel refinement for 8x8 mode */
690  #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */  #define XVID_ME_QUARTERPELREFINE16_RD (1<<16) /* perform RD-based qpel refinement */
# Line 558  Line 692 
692  #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 */  #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 */
693  #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */  #define XVID_ME_CHECKPREDICTION_RD    (1<<19) /* always check vector equal to prediction */
694    
695    /* Other */
696    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
697    #define XVID_ME_SKIP_DELTASEARCH      (1<<26) /* speed-up by skipping b-frame delta search */
698    #define XVID_ME_FAST_MODEINTERPOLATE  (1<<27) /* speed-up by partly skipping interpolate mode */
699    #define XVID_ME_BFRAME_EARLYSTOP      (1<<28) /* speed-up by early exiting b-search */
700    
701    /* Unused */
702  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
703  #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */  #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
704  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
705  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
706    
 #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */  
 #define XVID_ME_FASTREFINE16              (1<<25) /* use low-complexity refinement functions */  
707    
708  /* XVID_ENC_CREATE param1 */  /*----------------------------------------------------------------------------
709     * xvid_enc_create_t structure definition
710     *
711     * This structure is passed as param1 during an instance creation (operation
712     * XVID_ENC_CREATE)
713     *--------------------------------------------------------------------------*/
714    
715  typedef struct {  typedef struct {
716          int version;          int version;
717    
# Line 603  Line 748 
748          /* ---------------------------------------------- */          /* ---------------------------------------------- */
749    
750          void *handle;                /* [out] encoder instance handle */          void *handle;                /* [out] encoder instance handle */
751  }  } xvid_enc_create_t;
 xvid_enc_create_t;  
752    
753    
754    /*----------------------------------------------------------------------------
755     * xvid_enc_frame_t structure definition
756     *
757     * This structure is passed as param1 during a frame encoding (operation
758     * XVID_ENC_ENCODE)
759     *--------------------------------------------------------------------------*/
760    
761    /* out value for the frame structure->type field
762     * unlike stats output in param2, this field is not asynchronous and tells
763     * the client app, if the frame written into the stream buffer is an ivop
764     * usually used for indexing purpose in the container */
765  #define XVID_KEYFRAME (1<<1)  #define XVID_KEYFRAME (1<<1)
766    
767    /* The structure */
768  typedef struct {  typedef struct {
769          int version;          int version;
770    
771          /* --- VOL related stuff; unless XVID_FORCEVOL is set, the encoder will not react to any changes here until the next VOL (keyframe). */          /* VOL related stuff
772             * unless XVID_FORCEVOL is set, the encoder will not react to any changes
773             * here until the next VOL (keyframe). */
774    
775          int vol_flags;                     /* [in] vol flags */          int vol_flags;                     /* [in] vol flags */
776          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
777          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
778    
779          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) */
780          int par_width;                     /* [in:opt] aspect ratio width */          int par_width;                     /* [in:opt] aspect ratio width */
781          int par_height;                    /* [in:opt] aspect ratio height */          int par_height;                    /* [in:opt] aspect ratio height */
782          /* ---------------------------------------------- */  
783            /* Other fields that can change on a frame base */
784    
785          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
786          int vop_flags;                     /* [in] (general)vop-based flags */          int vop_flags;                     /* [in] (general)vop-based flags */
# Line 638  Line 798 
798          int out_flags;                     /* [out] bitstream output flags */          int out_flags;                     /* [out] bitstream output flags */
799  } xvid_enc_frame_t;  } xvid_enc_frame_t;
800    
   
 /* XVID_ENC_ENCODE param2 (optional)  
         xvid_enc_stats_t describes individual frame details  
   
         coding_type==XVID_TYPE_NOTHING if the stats are not given  
 */  
 typedef struct {  
         int version;  
   
         /* encoding parameters */  
         int type;      /* [out] coding type */  
         int quant;     /* [out] frame quantizer */  
         int vol_flags; /* [out] vol flags (see above) */  
         int vop_flags; /* [out] vop flags (see above) */  
   
         /* bitrate */  
         int length;    /* [out] frame length */  
   
         int hlength;   /* [out] header length (bytes) */  
         int kblks;     /* [out] number of blocks compressed as Intra */  
         int mblks;     /* [out] number of blocks compressed as Inter */  
         int ublks;     /* [out] number of blocks marked as not_coded */  
   
         int sse_y;     /* [out] Y plane's sse */  
         int sse_u;     /* [out] U plane's sse */  
         int sse_v;     /* [out] V plane's sse */  
 } xvid_enc_stats_t;  
   
801  #ifdef __cplusplus  #ifdef __cplusplus
802  }  }
803  #endif  #endif
804    
   
805  #endif  #endif
Legend:
Removed from v.1.27.2.44  
changed lines
  Added in v.1.56
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4