[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.37, Sun Sep 28 13:43:47 2003 UTC revision 1.65, Wed May 27 15:52:05 2009 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,-127,0)  #define XVID_VERSION             XVID_MAKE_VERSION(1,3,-127)
61  #define XVID_API                 XVID_MAKE_API(4, 0)  #define XVID_API                 XVID_MAKE_API(4, 3)
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 "0019"  #define XVID_BS_VERSION 55
   
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_RGB      (1<<16) /* 24-bit rgb packed */
106  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
107  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
108  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
109    #define XVID_CSP_ARGB     (1<<15) /* 32-bit argb packed */
110  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
111  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
112  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
# Line 138  Line 140 
140  #define XVID_PROFILE_AS_L4   0xf4  #define XVID_PROFILE_AS_L4   0xf4
141    
142  /* aspect ratios */  /* aspect ratios */
143  #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 */
144  #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) */
145  #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) */
146  #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 159  Line 161 
161   * xvid_global()   * xvid_global()
162   ****************************************************************************/   ****************************************************************************/
163    
164  /* cpu_flags definitions */  /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
165    
166  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
167  #define XVID_CPU_ASM      (1<< 7) /* native assembly */  #define XVID_CPU_ASM      (1<< 7) /* native assembly */
# Line 168  Line 170 
170  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
171  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
172  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
173    #define XVID_CPU_SSE3     (1<< 8) /*      sse3 : pentium4, athlon64 */
174    #define XVID_CPU_SSE41    (1<< 9) /*      sse41: penryn */
175  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
176  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
177  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
# Line 217  Line 221 
221  #define XVID_GBL_INIT    0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */  #define XVID_GBL_INIT    0 /* initialize xvidcore; must be called before using xvid_decore, or xvid_encore) */
222  #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 */
223  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
 #define XVID_GBL_TEST    3 /* testing.. */  
224    
225  int xvid_global(void *handle, int opt, void *param1, void *param2);  extern int xvid_global(void *handle, int opt, void *param1, void *param2);
226    
227    
228  /*****************************************************************************  /*****************************************************************************
# Line 230  Line 233 
233  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
234  #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 */
235    
236  int xvid_decore(void *handle, int opt, void *param1, void *param2);  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
237    
238  /* XVID_DEC_CREATE param 1  /* XVID_DEC_CREATE param 1
239          image width & height may be specified here when the dimensions are          image width & height may be specified here when the dimensions are
# Line 247  Line 250 
250  /* general flags */  /* general flags */
251  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
252  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
253    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
254    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
255    #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
256    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
257    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
258    
259    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
260    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
261    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
262    
263  typedef struct {  typedef struct {
264          int version;          int version;
# Line 254  Line 266 
266          void *bitstream;     /* [in]     bitstream (read from)*/          void *bitstream;     /* [in]     bitstream (read from)*/
267          int length;          /* [in]     bitstream length */          int length;          /* [in]     bitstream length */
268          xvid_image_t output; /* [in]     output image (written to) */          xvid_image_t output; /* [in]     output image (written to) */
269    /* ------- v1.1.x ------- */
270            int brightness;          /* [in]         brightness offset (0=none) */
271  } xvid_dec_frame_t;  } xvid_dec_frame_t;
272    
273    
# Line 278  Line 292 
292                          int general;        /* [out] flags */                          int general;        /* [out] flags */
293                          int width;          /* [out] width */                          int width;          /* [out] width */
294                          int height;         /* [out] height */                          int height;         /* [out] height */
295                          int par;            /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */                          int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
296                          int par_width;      /* [out] aspect ratio width */                          int par_width;      /* [out] aspect ratio width  [1..255] */
297                          int par_height;     /* [out] aspect ratio height */                          int par_height;     /* [out] aspect ratio height [1..255] */
298                  } vol;                  } vol;
299          } data;          } data;
300  } xvid_dec_stats_t;  } xvid_dec_stats_t;
301    
   
   
302  #define XVID_ZONE_QUANT  (1<<0)  #define XVID_ZONE_QUANT  (1<<0)
303  #define XVID_ZONE_WEIGHT (1<<1)  #define XVID_ZONE_WEIGHT (1<<1)
304    
# Line 299  Line 311 
311  } xvid_enc_zone_t;  } xvid_enc_zone_t;
312    
313    
314    /*----------------------------------------------------------------------------
315     * xvid_enc_stats_t structure
316     *
317     * Used in:
318     *  - xvid_plg_data_t structure
319     *  - optional parameter in xvid_encore() function
320     *
321     * .coding_type = XVID_TYPE_NOTHING if the stats are not given
322     *--------------------------------------------------------------------------*/
323    
324    typedef struct {
325            int version;
326    
327            /* encoding parameters */
328            int type;      /* [out] coding type */
329            int quant;     /* [out] frame quantizer */
330            int vol_flags; /* [out] vol flags (see above) */
331            int vop_flags; /* [out] vop flags (see above) */
332    
333            /* bitrate */
334            int length;    /* [out] frame length */
335    
336            int hlength;   /* [out] header length (bytes) */
337            int kblks;     /* [out] number of blocks compressed as Intra */
338            int mblks;     /* [out] number of blocks compressed as Inter */
339            int ublks;     /* [out] number of blocks marked as not_coded */
340    
341            int sse_y;     /* [out] Y plane's sse */
342            int sse_u;     /* [out] U plane's sse */
343            int sse_v;     /* [out] V plane's sse */
344    } xvid_enc_stats_t;
345    
346  /*****************************************************************************  /*****************************************************************************
347    xvid plugin system -- internals    xvid plugin system -- internals
# Line 314  Line 357 
357  #define XVID_PLG_DESTROY (1<<1)  #define XVID_PLG_DESTROY (1<<1)
358  #define XVID_PLG_INFO    (1<<2)  #define XVID_PLG_INFO    (1<<2)
359  #define XVID_PLG_BEFORE  (1<<3)  #define XVID_PLG_BEFORE  (1<<3)
360  #define XVID_PLG_AFTER   (1<<4)  #define XVID_PLG_FRAME   (1<<4)
361    #define XVID_PLG_AFTER   (1<<5)
362    
363  /* xvid_plg_info_t.flags */  /* xvid_plg_info_t.flags */
364  #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 */
365  #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*/
366  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
367    #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */
368    
369    
370  typedef struct  typedef struct
# Line 354  Line 399 
399          int num_frames; /* [out] total frame encoded */          int num_frames; /* [out] total frame encoded */
400  } xvid_plg_destroy_t;  } xvid_plg_destroy_t;
401    
   
402  typedef struct  typedef struct
403  {  {
404          int version;          int version;
# Line 386  Line 430 
430          int vol_flags;          /* [in,out] */          int vol_flags;          /* [in,out] */
431          int motion_flags;       /* [in,out] */          int motion_flags;       /* [in,out] */
432    
433            /* Lambda table for HVSPlugins */
434            float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
435    
436    /* Deprecated, use the stats field instead.
437     * Will disapear before 1.0 */
438          int length;             /* [out] after: length of encoded frame */          int length;             /* [out] after: length of encoded frame */
439          int kblks;              /* [out] number of blocks compressed as Intra */          int kblks;              /* [out] number of blocks compressed as Intra */
440          int mblks;              /* [out] number of blocks compressed as Inter */          int mblks;              /* [out] number of blocks compressed as Inter */
# Line 393  Line 442 
442          int sse_y;              /* [out] Y plane's sse */          int sse_y;              /* [out] Y plane's sse */
443          int sse_u;              /* [out] U plane's sse */          int sse_u;              /* [out] U plane's sse */
444          int sse_v;              /* [out] V plane's sse */          int sse_v;              /* [out] V plane's sse */
445  } xvid_plg_data_t;  /* End of duplicated data, kept only for binary compatibility */
446    
447            int bquant_ratio;       /* [in] */
448            int bquant_offset;      /* [in] */
449    
450            xvid_enc_stats_t stats; /* [out] frame statistics */
451    } xvid_plg_data_t;
452    
453  /*****************************************************************************  /*****************************************************************************
454    xvid plugin system -- external    xvid plugin system -- external
# Line 425  Line 479 
479  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
480    
481    
482  xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
483  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 */
484  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 */
485    
486    extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
487    
488  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
489    extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
490    
491  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 */  
492    
493    
494  /* single pass rate control  /* single pass rate control
# Line 461  Line 517 
517  typedef struct {  typedef struct {
518          int version;          int version;
519    
520          int bitrate;                  /* [in] bits per second */          int bitrate;                  /* [in] target bitrate (bits per second) */
521          char * filename;              /* [in] first pass stats filename */          char * filename;              /* [in] first pass stats filename */
522    
523          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */          int keyframe_boost;           /* [in] keyframe boost percentage: [0..100] */
         int payback_method;           /* [in] Payback method: see XVID_PAYBACK flags */  
         int bitrate_payback_delay;    /* [in] Payback delay expressed in number of frames */  
524          int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */          int curve_compression_high;   /* [in] percentage of compression performed on the high part of the curve (above average) */
525          int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */          int curve_compression_low;    /* [in] percentage of compression performed on the low  part of the curve (below average) */
526          int max_overflow_improvement; /* [in] */          int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
527          int max_overflow_degradation; /* [in] */          int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
528            int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
529          int kftreshold;               /* [in] */  
530          int kfreduction;              /* [in] */          int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
531          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
532                                                                       *      is substracted from its bit allocation. The reduction is computed as multiples of
533                                                                       *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
534                                                                       *      0 for 1<distance<kfthreshold */
535    
536          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 */
537    
538    /* ------- v1.1.x ------- */
539            int vbv_size;                 /* [in] buffer size (bits) */
540            int vbv_initial;              /* [in] initial buffer occupancy (bits) */
541            int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
542            int vbv_peakrate;             /* [in:opt] max average bitrate over 3 seconds (bits per second) */
543    
544  }xvid_plugin_2pass2_t;  }xvid_plugin_2pass2_t;
545    
546    
547    typedef struct{
548            /*stat output*/
549            int b_printstat;
550            char* stat_path;
551    
552            /*visualize*/
553            int b_visualize;
554    
555            /*accuracy 0 very accurate 4 very fast*/
556            int acc;
557    
558        int cpu_flags; /* XVID_CPU_XXX flags */
559    
560    } xvid_plugin_ssim_t;
561    
562    typedef struct {
563            int version;
564    
565            int method;      /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */
566    } xvid_plugin_lumimasking_t;
567    
568  /*****************************************************************************  /*****************************************************************************
569   * xvid_encore()   *                             ENCODER API
570   ****************************************************************************/   ****************************************************************************/
571    
572  /* Encoder options */  /*----------------------------------------------------------------------------
573     * Encoder operations
574     *--------------------------------------------------------------------------*/
575    
576  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
577  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
578  #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
579                              * 0 means this frame should not be written (ie. encoder lag) */                              * 0 means this frame should not be written (ie. encoder lag) */
580    
581  int xvid_encore(void *handle, int opt, void *param1, void *param2);  
582    /*----------------------------------------------------------------------------
583     * Encoder entry point
584     *--------------------------------------------------------------------------*/
585    
586    extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
587    
588    /* Quick API reference
589     *
590     * XVID_ENC_CREATE operation
591     *  - handle: ignored
592     *  - opt: XVID_ENC_CREATE
593     *  - param1: address of a xvid_enc_create_t structure
594     *  - param2: ignored
595     *
596     * XVID_ENC_ENCODE operation
597     *  - handle: an instance returned by a CREATE op
598     *  - opt: XVID_ENC_ENCODE
599     *  - param1: address of a xvid_enc_frame_t structure
600     *  - param2: address of a xvid_enc_stats_t structure (optional)
601     *            its return value is asynchronous to what is written to the buffer
602     *            depending on the delay introduced by bvop use. It's display
603     *            ordered.
604     *
605     * XVID_ENC_DESTROY operation
606     *  - handle: an instance returned by a CREATE op
607     *  - opt: XVID_ENC_DESTROY
608     *  - param1: ignored
609     *  - param2: ignored
610     */
611    
612    
613    /*----------------------------------------------------------------------------
614     * "Global" flags
615     *
616     * These flags are used for xvid_enc_create_t->global field during instance
617     * creation (operation XVID_ENC_CREATE)
618     *--------------------------------------------------------------------------*/
619    
 /* Global Flags */  
620  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
621  #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 */
622  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
# Line 502  Line 624 
624  #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 */
625  #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 */
626  #endif  #endif
627    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
628                                                    this is implied if XVID_GLOBAL_PACKED is set */
629    
630    /*----------------------------------------------------------------------------
631     * "VOL" flags
632     *
633     * These flags are used for xvid_enc_frame_t->vol_flags field during frame
634     * encoding (operation XVID_ENC_ENCODE)
635     *--------------------------------------------------------------------------*/
636    
 /* XVID_ENC_ENCODE param1 */  
 /* vol-based flags */  
637  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
638  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
639  #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 */
640  #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 */
641  #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 */
642                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
643  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
644    
645    
646    /*----------------------------------------------------------------------------
647     * "VOP" flags
648     *
649     * These flags are used for xvid_enc_frame_t->vop_flags field during frame
650     * encoding (operation XVID_ENC_ENCODE)
651     *--------------------------------------------------------------------------*/
652    
653  /* vop based flags */  /* Always valid */
654  #define XVID_VOP_DEBUG           (1<< 0)  #define XVID_VOP_DEBUG                (1<< 0) /* print debug messages in frames */
655  #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */  #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */
656  #define XVID_VOP_INTER4V         (1<< 2)  #define XVID_VOP_INTER4V              (1<< 2) /* use 4 motion vectors per MB */
657  #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 */
658  #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */  #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */
659  #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */  #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */
660  #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) */
661  #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */  #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */
662  #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 */
663  /* only valid for vol_flags|=XVID_VOL_INTERLACING */  #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
664    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
665    
666    /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
667  #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */  #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */
668  #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */  #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */
669    
670  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
671  #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */  #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */
672                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
673    
674  #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */  /*----------------------------------------------------------------------------
675     * "Motion" flags
676     *
677     * These flags are used for xvid_enc_frame_t->motion field during frame
678     * encoding (operation XVID_ENC_ENCODE)
679     *--------------------------------------------------------------------------*/
680    
681  /* Motion based flags */  /* Motion Estimation Search Patterns */
682  #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 */
683  #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */  #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
684  #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 */
685  #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */  #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
686    
687    /* SAD operator based flags */
688  #define XVID_ME_HALFPELREFINE16       (1<< 4)  #define XVID_ME_HALFPELREFINE16       (1<< 4)
689  #define XVID_ME_HALFPELREFINE8        (1<< 6)  #define XVID_ME_HALFPELREFINE8        (1<< 6)
690  #define XVID_ME_QUARTERPELREFINE16    (1<< 7)  #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
# Line 549  Line 694 
694  #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 */
695  #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 */
696  #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 */
697    #define XVID_ME_FASTREFINE16          (1<<25) /* use low-complexity refinement functions */
698    #define XVID_ME_FASTREFINE8           (1<<29) /* low-complexity 8x8 sub-block refinement */
699    
700  /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */  /* Rate Distortion based flags
701     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
702  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
703  #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 */
704  #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 706 
706  #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 */
707  #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 */
708    
709    /* Other */
710    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
711    #define XVID_ME_SKIP_DELTASEARCH      (1<<26) /* speed-up by skipping b-frame delta search */
712    #define XVID_ME_FAST_MODEINTERPOLATE  (1<<27) /* speed-up by partly skipping interpolate mode */
713    #define XVID_ME_BFRAME_EARLYSTOP      (1<<28) /* speed-up by early exiting b-search */
714    
715    /* Unused */
716  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
717  #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */  #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
718  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
719  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
720    
 #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 */  
721    
722  /* XVID_ENC_CREATE param1 */  /*----------------------------------------------------------------------------
723     * xvid_enc_create_t structure definition
724     *
725     * This structure is passed as param1 during an instance creation (operation
726     * XVID_ENC_CREATE)
727     *--------------------------------------------------------------------------*/
728    
729  typedef struct {  typedef struct {
730          int version;          int version;
731    
# Line 603  Line 762 
762          /* ---------------------------------------------- */          /* ---------------------------------------------- */
763    
764          void *handle;                /* [out] encoder instance handle */          void *handle;                /* [out] encoder instance handle */
765  }  } xvid_enc_create_t;
 xvid_enc_create_t;  
766    
767    
768    /*----------------------------------------------------------------------------
769     * xvid_enc_frame_t structure definition
770     *
771     * This structure is passed as param1 during a frame encoding (operation
772     * XVID_ENC_ENCODE)
773     *--------------------------------------------------------------------------*/
774    
775    /* out value for the frame structure->type field
776     * unlike stats output in param2, this field is not asynchronous and tells
777     * the client app, if the frame written into the stream buffer is an ivop
778     * usually used for indexing purpose in the container */
779  #define XVID_KEYFRAME (1<<1)  #define XVID_KEYFRAME (1<<1)
780    
781    /* The structure */
782  typedef struct {  typedef struct {
783          int version;          int version;
784    
785          /* --- 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
786             * unless XVID_FORCEVOL is set, the encoder will not react to any changes
787             * here until the next VOL (keyframe). */
788    
789          int vol_flags;                     /* [in] vol flags */          int vol_flags;                     /* [in] vol flags */
790          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
791          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
792    
793          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) */
794          int par_width;                     /* [in:opt] aspect ratio width */          int par_width;                     /* [in:opt] aspect ratio width */
795          int par_height;                    /* [in:opt] aspect ratio height */          int par_height;                    /* [in:opt] aspect ratio height */
796          /* ---------------------------------------------- */  
797            /* Other fields that can change on a frame base */
798    
799          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
800          int vop_flags;                     /* [in] (general)vop-based flags */          int vop_flags;                     /* [in] (general)vop-based flags */
# Line 638  Line 812 
812          int out_flags;                     /* [out] bitstream output flags */          int out_flags;                     /* [out] bitstream output flags */
813  } xvid_enc_frame_t;  } xvid_enc_frame_t;
814    
   
 /* 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;  
   
815  #ifdef __cplusplus  #ifdef __cplusplus
816  }  }
817  #endif  #endif
818    
   
819  #endif  #endif
Legend:
Removed from v.1.27.2.37  
changed lines
  Added in v.1.65
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4