[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.40, Tue Oct 7 13:02:35 2003 UTC revision 1.74.2.2, Mon Feb 14 17:21:00 2011 UTC
# Line 1  Line 1 
1  /*****************************************************************************  /*****************************************************************************
2   *   *
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-2010 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,0)
61  #define XVID_API                 XVID_MAKE_API(4, 0)  #define XVID_API                 XVID_MAKE_API(4, 3)
   
 #define XVID_UNSTABLE  
62    
63  /* Bitstream Version  /* Bitstream Version
64   * this will be writen into the bitstream to allow easy detection of xvid   * this will be writen into the bitstream to allow easy detection of xvid
# Line 73  Line 71 
71   * 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
72   * future   * future
73   */   */
74  #define XVID_BS_VERSION "0020"  #define XVID_BS_VERSION 62
   
75    
76  /*****************************************************************************  /*****************************************************************************
77   * error codes   * error codes
# Line 96  Line 93 
93    
94  /* colorspace values */  /* colorspace values */
95    
96  #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) */
97  #define XVID_CSP_I420     (1<< 1) /* 4:2:0 packed(planar win32) */  #define XVID_CSP_USER     XVID_CSP_PLANAR
98  #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 packed(planar win32) */  #define XVID_CSP_I420     (1<< 1) /* 4:2:0 planar */
99    #define XVID_CSP_YV12     (1<< 2) /* 4:2:0 planar */
100  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */  #define XVID_CSP_YUY2     (1<< 3) /* 4:2:2 packed */
101  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */  #define XVID_CSP_UYVY     (1<< 4) /* 4:2:2 packed */
102  #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */  #define XVID_CSP_YVYU     (1<< 5) /* 4:2:2 packed */
103    #define XVID_CSP_RGB      (1<<16) /* 24-bit rgb packed */
104  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */  #define XVID_CSP_BGRA     (1<< 6) /* 32-bit bgra packed */
105  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */  #define XVID_CSP_ABGR     (1<< 7) /* 32-bit abgr packed */
106  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */  #define XVID_CSP_RGBA     (1<< 8) /* 32-bit rgba packed */
107    #define XVID_CSP_ARGB     (1<<15) /* 32-bit argb packed */
108  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */  #define XVID_CSP_BGR      (1<< 9) /* 24-bit bgr packed */
109  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */  #define XVID_CSP_RGB555   (1<<10) /* 16-bit rgb555 packed */
110  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */  #define XVID_CSP_RGB565   (1<<11) /* 16-bit rgb565 packed */
# Line 127  Line 127 
127  #define XVID_PROFILE_S_L1    0x01  #define XVID_PROFILE_S_L1    0x01
128  #define XVID_PROFILE_S_L2    0x02  #define XVID_PROFILE_S_L2    0x02
129  #define XVID_PROFILE_S_L3    0x03  #define XVID_PROFILE_S_L3    0x03
130    #define XVID_PROFILE_S_L4a   0x04
131    #define XVID_PROFILE_S_L5    0x05
132    #define XVID_PROFILE_S_L6    0x06
133  #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */  #define XVID_PROFILE_ARTS_L1 0x91 /* advanced realtime simple */
134  #define XVID_PROFILE_ARTS_L2 0x92  #define XVID_PROFILE_ARTS_L2 0x92
135  #define XVID_PROFILE_ARTS_L3 0x93  #define XVID_PROFILE_ARTS_L3 0x93
# Line 138  Line 141 
141  #define XVID_PROFILE_AS_L4   0xf4  #define XVID_PROFILE_AS_L4   0xf4
142    
143  /* aspect ratios */  /* aspect ratios */
144  #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 */
145  #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) */
146  #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) */
147  #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 162 
162   * xvid_global()   * xvid_global()
163   ****************************************************************************/   ****************************************************************************/
164    
165  /* cpu_flags definitions */  /* cpu_flags definitions (make sure to sync this with cpuid.asm for ia32) */
166    
167  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */  #define XVID_CPU_FORCE    (1<<31) /* force passed cpu flags */
168  #define XVID_CPU_ASM      (1<< 7) /* native assembly */  #define XVID_CPU_ASM      (1<< 7) /* native assembly */
# Line 168  Line 171 
171  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */  #define XVID_CPU_MMXEXT   (1<< 1) /*   mmx-ext : pentium2, athlon */
172  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */  #define XVID_CPU_SSE      (1<< 2) /*       sse : pentium3, athlonXP */
173  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */  #define XVID_CPU_SSE2     (1<< 3) /*      sse2 : pentium4, athlon64 */
174    #define XVID_CPU_SSE3     (1<< 8) /*      sse3 : pentium4, athlon64 */
175    #define XVID_CPU_SSE41    (1<< 9) /*      sse41: penryn */
176  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */  #define XVID_CPU_3DNOW    (1<< 4) /*     3dnow : k6-2 */
177  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */  #define XVID_CPU_3DNOWEXT (1<< 5) /* 3dnow-ext : athlon */
178  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */  #define XVID_CPU_TSC      (1<< 6) /*       tsc : Pentium */
# Line 218  Line 223 
223  #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 */
224  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
225    
226  int xvid_global(void *handle, int opt, void *param1, void *param2);  extern int xvid_global(void *handle, int opt, void *param1, void *param2);
227    
228    
229  /*****************************************************************************  /*****************************************************************************
# Line 229  Line 234 
234  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
235  #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 */
236    
237  int xvid_decore(void *handle, int opt, void *param1, void *param2);  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);
238    
239  /* XVID_DEC_CREATE param 1  /* XVID_DEC_CREATE param 1
240          image width & height may be specified here when the dimensions are          image width & height as well as FourCC code may be specified
241          known in advance. */          here when known in advance (e.g. being read from container) */
242  typedef struct {  typedef struct {
243          int version;          int version;
244          int width;     /* [in:opt] image width */          int width;     /* [in:opt] image width */
245          int height;    /* [in:opt] image width */          int height;    /* [in:opt] image width */
246          void * handle; /* [out]    decore context handle */          void * handle; /* [out]    decore context handle */
247    /* ------- v1.3.x ------- */
248            int fourcc;     /* [in:opt] fourcc of the input video */
249            int num_threads;/* [in:opt] number of threads to use in decoder */
250  } xvid_dec_create_t;  } xvid_dec_create_t;
251    
252    
# Line 246  Line 254 
254  /* general flags */  /* general flags */
255  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */  #define XVID_LOWDELAY      (1<<0) /* lowdelay mode  */
256  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */  #define XVID_DISCONTINUITY (1<<1) /* indicates break in stream */
257    #define XVID_DEBLOCKY      (1<<2) /* perform luma deblocking */
258    #define XVID_DEBLOCKUV     (1<<3) /* perform chroma deblocking */
259    #define XVID_FILMEFFECT    (1<<4) /* adds film grain */
260    #define XVID_DERINGUV      (1<<5) /* perform chroma deringing, requires deblocking to work */
261    #define XVID_DERINGY       (1<<6) /* perform luma deringing, requires deblocking to work */
262    
263    #define XVID_DEC_FAST      (1<<29) /* disable postprocessing to decrease cpu usage *todo* */
264    #define XVID_DEC_DROP      (1<<30) /* drop bframes to decrease cpu usage *todo* */
265    #define XVID_DEC_PREROLL   (1<<31) /* decode as fast as you can, don't even show output *todo* */
266    
267  typedef struct {  typedef struct {
268          int version;          int version;
# Line 253  Line 270 
270          void *bitstream;     /* [in]     bitstream (read from)*/          void *bitstream;     /* [in]     bitstream (read from)*/
271          int length;          /* [in]     bitstream length */          int length;          /* [in]     bitstream length */
272          xvid_image_t output; /* [in]     output image (written to) */          xvid_image_t output; /* [in]     output image (written to) */
273    /* ------- v1.1.x ------- */
274            int brightness;          /* [in]         brightness offset (0=none) */
275  } xvid_dec_frame_t;  } xvid_dec_frame_t;
276    
277    
# Line 277  Line 296 
296                          int general;        /* [out] flags */                          int general;        /* [out] flags */
297                          int width;          /* [out] width */                          int width;          /* [out] width */
298                          int height;         /* [out] height */                          int height;         /* [out] height */
299                          int par;            /* [out] picture aspect ratio (refer to XVID_PAR_xxx above) */                          int par;            /* [out] pixel aspect ratio (refer to XVID_PAR_xxx above) */
300                          int par_width;      /* [out] aspect ratio width */                          int par_width;      /* [out] aspect ratio width  [1..255] */
301                          int par_height;     /* [out] aspect ratio height */                          int par_height;     /* [out] aspect ratio height [1..255] */
302                  } vol;                  } vol;
303          } data;          } data;
304  } xvid_dec_stats_t;  } xvid_dec_stats_t;
305    
   
   
306  #define XVID_ZONE_QUANT  (1<<0)  #define XVID_ZONE_QUANT  (1<<0)
307  #define XVID_ZONE_WEIGHT (1<<1)  #define XVID_ZONE_WEIGHT (1<<1)
308    
# Line 298  Line 315 
315  } xvid_enc_zone_t;  } xvid_enc_zone_t;
316    
317    
318    /*----------------------------------------------------------------------------
319     * xvid_enc_stats_t structure
320     *
321     * Used in:
322     *  - xvid_plg_data_t structure
323     *  - optional parameter in xvid_encore() function
324     *
325     * .coding_type = XVID_TYPE_NOTHING if the stats are not given
326     *--------------------------------------------------------------------------*/
327    
328    typedef struct {
329            int version;
330    
331            /* encoding parameters */
332            int type;      /* [out] coding type */
333            int quant;     /* [out] frame quantizer */
334            int vol_flags; /* [out] vol flags (see above) */
335            int vop_flags; /* [out] vop flags (see above) */
336    
337            /* bitrate */
338            int length;    /* [out] frame length */
339    
340            int hlength;   /* [out] header length (bytes) */
341            int kblks;     /* [out] number of blocks compressed as Intra */
342            int mblks;     /* [out] number of blocks compressed as Inter */
343            int ublks;     /* [out] number of blocks marked as not_coded */
344    
345            int sse_y;     /* [out] Y plane's sse */
346            int sse_u;     /* [out] U plane's sse */
347            int sse_v;     /* [out] V plane's sse */
348    } xvid_enc_stats_t;
349    
350  /*****************************************************************************  /*****************************************************************************
351    xvid plugin system -- internals    xvid plugin system -- internals
# Line 313  Line 361 
361  #define XVID_PLG_DESTROY (1<<1)  #define XVID_PLG_DESTROY (1<<1)
362  #define XVID_PLG_INFO    (1<<2)  #define XVID_PLG_INFO    (1<<2)
363  #define XVID_PLG_BEFORE  (1<<3)  #define XVID_PLG_BEFORE  (1<<3)
364  #define XVID_PLG_AFTER   (1<<4)  #define XVID_PLG_FRAME   (1<<4)
365    #define XVID_PLG_AFTER   (1<<5)
366    
367  /* xvid_plg_info_t.flags */  /* xvid_plg_info_t.flags */
368  #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 */
369  #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*/
370  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
371    #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */
372    
373  typedef struct  typedef struct
374  {  {
# Line 353  Line 402 
402          int num_frames; /* [out] total frame encoded */          int num_frames; /* [out] total frame encoded */
403  } xvid_plg_destroy_t;  } xvid_plg_destroy_t;
404    
   
405  typedef struct  typedef struct
406  {  {
407          int version;          int version;
# Line 385  Line 433 
433          int vol_flags;          /* [in,out] */          int vol_flags;          /* [in,out] */
434          int motion_flags;       /* [in,out] */          int motion_flags;       /* [in,out] */
435    
436            /* Lambda table for HVSPlugins */
437            float * lambda;         /* [in,out] six floats for each macroblock. read, multiply, write back */
438    
439    /* Deprecated, use the stats field instead.
440     * Will disapear before 1.0 */
441          int length;             /* [out] after: length of encoded frame */          int length;             /* [out] after: length of encoded frame */
442          int kblks;              /* [out] number of blocks compressed as Intra */          int kblks;              /* [out] number of blocks compressed as Intra */
443          int mblks;              /* [out] number of blocks compressed as Inter */          int mblks;              /* [out] number of blocks compressed as Inter */
# Line 392  Line 445 
445          int sse_y;              /* [out] Y plane's sse */          int sse_y;              /* [out] Y plane's sse */
446          int sse_u;              /* [out] U plane's sse */          int sse_u;              /* [out] U plane's sse */
447          int sse_v;              /* [out] V plane's sse */          int sse_v;              /* [out] V plane's sse */
448  } xvid_plg_data_t;  /* End of duplicated data, kept only for binary compatibility */
449    
450            int bquant_ratio;       /* [in] */
451            int bquant_offset;      /* [in] */
452    
453            xvid_enc_stats_t stats; /* [out] frame statistics */
454    } xvid_plg_data_t;
455    
456  /*****************************************************************************  /*****************************************************************************
457    xvid plugin system -- external    xvid plugin system -- external
# Line 424  Line 482 
482  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
483    
484    
485  xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
486  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 */
487  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 */
488    
489  xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
490    
491  xvid_plugin_func xvid_plugin_psnr;      /* write psnr values to stdout */  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */
492  xvid_plugin_func xvid_plugin_dump;      /* dump before and after yuvpgms */  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */
493    
494    extern xvid_plugin_func xvid_plugin_ssim;           /*write ssim values to stdout*/
495    extern xvid_plugin_func xvid_plugin_psnrhvsm;   /*write psnrhvsm values to stdout*/
496    
497    
498  /* single pass rate control  /* single pass rate control
# Line 460  Line 521 
521  typedef struct {  typedef struct {
522          int version;          int version;
523    
524          int bitrate;                  /* [in] bits per second */          int bitrate;                  /* [in] target bitrate (bits per second) */
525          char * filename;              /* [in] first pass stats filename */          char * filename;              /* [in] first pass stats filename */
526    
527          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 */  
528          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) */
529          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) */
530          int max_overflow_improvement; /* [in] */          int overflow_control_strength;/* [in] Payback delay expressed in number of frames */
531          int max_overflow_degradation; /* [in] */          int max_overflow_improvement; /* [in] percentage of allowed range for a frame that gets bigger because of overflow bonus */
532            int max_overflow_degradation; /* [in] percentage of allowed range for a frame that gets smaller because of overflow penalty */
533          int kftreshold;               /* [in] */  
534          int kfreduction;              /* [in] */          int kfreduction;              /* [in] maximum bitrate reduction applied to an iframe under the kfthreshold distance limit */
535          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
536                                                                       *      is substracted from its bit allocation. The reduction is computed as multiples of
537                                                                       *      kfreduction/kthreshold. It reaches kfreduction when the distance == kfthreshold,
538                                                                       *      0 for 1<distance<kfthreshold */
539    
540          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 */
541    
542    /* ------- v1.1.x ------- */
543            int vbv_size;                 /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/
544            int vbv_initial;              /* [in] initial buffer occupancy (bits) */
545            int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
546            int vbv_peakrate;             /* [in:opt] max average bitrate over 1 second (bits per second).
547                                                                       *          This is used for diagnostics only and won't affect the actual peak bitrate.
548                                                                       *          This is not a problem as long as vbv_peakrate > vbv_size + vbv_maxrate which
549                                                                       *          guarantees that vbv_peakrate won't be exceeded. */
550  }xvid_plugin_2pass2_t;  }xvid_plugin_2pass2_t;
551    
552    
553    typedef struct{
554            /*stat output*/
555            int b_printstat;
556            char* stat_path;
557    
558            /*visualize*/
559            int b_visualize;
560    
561            /*accuracy 0 very accurate 4 very fast*/
562            int acc;
563    
564        int cpu_flags; /* XVID_CPU_XXX flags */
565    
566    } xvid_plugin_ssim_t;
567    
568    typedef struct {
569            int version;
570    
571            int method;      /* [in] masking method to apply. 0 for luminance masking, 1 for variance masking */
572    } xvid_plugin_lumimasking_t;
573    
574  /*****************************************************************************  /*****************************************************************************
575   * xvid_encore()   *                             ENCODER API
576   ****************************************************************************/   ****************************************************************************/
577    
578  /* Encoder options */  /*----------------------------------------------------------------------------
579     * Encoder operations
580     *--------------------------------------------------------------------------*/
581    
582  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */  #define XVID_ENC_CREATE  0 /* create encoder instance; returns 0 on success */
583  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */  #define XVID_ENC_DESTROY 1 /* destroy encoder instance; returns 0 on success */
584  #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
585                              * 0 means this frame should not be written (ie. encoder lag) */                              * 0 means this frame should not be written (ie. encoder lag) */
586    
587  int xvid_encore(void *handle, int opt, void *param1, void *param2);  
588    /*----------------------------------------------------------------------------
589     * Encoder entry point
590     *--------------------------------------------------------------------------*/
591    
592    extern int xvid_encore(void *handle, int opt, void *param1, void *param2);
593    
594    /* Quick API reference
595     *
596     * XVID_ENC_CREATE operation
597     *  - handle: ignored
598     *  - opt: XVID_ENC_CREATE
599     *  - param1: address of a xvid_enc_create_t structure
600     *  - param2: ignored
601     *
602     * XVID_ENC_ENCODE operation
603     *  - handle: an instance returned by a CREATE op
604     *  - opt: XVID_ENC_ENCODE
605     *  - param1: address of a xvid_enc_frame_t structure
606     *  - param2: address of a xvid_enc_stats_t structure (optional)
607     *            its return value is asynchronous to what is written to the buffer
608     *            depending on the delay introduced by bvop use. It's display
609     *            ordered.
610     *
611     * XVID_ENC_DESTROY operation
612     *  - handle: an instance returned by a CREATE op
613     *  - opt: XVID_ENC_DESTROY
614     *  - param1: ignored
615     *  - param2: ignored
616     */
617    
618    
619    /*----------------------------------------------------------------------------
620     * "Global" flags
621     *
622     * These flags are used for xvid_enc_create_t->global field during instance
623     * creation (operation XVID_ENC_CREATE)
624     *--------------------------------------------------------------------------*/
625    
 /* Global Flags */  
626  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */  #define XVID_GLOBAL_PACKED            (1<<0) /* packed bitstream */
627  #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 */
628  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)  #define XVID_GLOBAL_EXTRASTATS_ENABLE (1<<2)
# Line 501  Line 630 
630  #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 */
631  #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 */
632  #endif  #endif
633    #define XVID_GLOBAL_DIVX5_USERDATA    (1<<5) /* write divx5 userdata string
634                                                    this is implied if XVID_GLOBAL_PACKED is set */
635    
636    /*----------------------------------------------------------------------------
637     * "VOL" flags
638     *
639     * These flags are used for xvid_enc_frame_t->vol_flags field during frame
640     * encoding (operation XVID_ENC_ENCODE)
641     *--------------------------------------------------------------------------*/
642    
 /* XVID_ENC_ENCODE param1 */  
 /* vol-based flags */  
643  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */  #define XVID_VOL_MPEGQUANT      (1<<0) /* enable MPEG type quantization */
644  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */  #define XVID_VOL_EXTRASTATS     (1<<1) /* enable plane sse stats */
645  #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 */
646  #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 */
647  #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 */
648                                                                               /* NOTE:  the reduced resolution feature is not supported anymore. This flag will have no effect! */
649  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */  #define XVID_VOL_INTERLACING    (1<<5) /* enable interlaced encoding */
650    
651    
652    /*----------------------------------------------------------------------------
653     * "VOP" flags
654     *
655     * These flags are used for xvid_enc_frame_t->vop_flags field during frame
656     * encoding (operation XVID_ENC_ENCODE)
657     *--------------------------------------------------------------------------*/
658    
659  /* vop based flags */  /* Always valid */
660  #define XVID_VOP_DEBUG           (1<< 0)  #define XVID_VOP_DEBUG                (1<< 0) /* print debug messages in frames */
661  #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */  #define XVID_VOP_HALFPEL         (1<< 1) /* use halfpel interpolation */
662  #define XVID_VOP_INTER4V         (1<< 2)  #define XVID_VOP_INTER4V              (1<< 2) /* use 4 motion vectors per MB */
663  #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 */
664  #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */  #define XVID_VOP_CHROMAOPT       (1<< 4) /* enable chroma optimization pre-filter */
665  #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */  #define XVID_VOP_CARTOON         (1<< 5) /* use 'cartoon mode' */
666  #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) */
667  #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */  #define XVID_VOP_HQACPRED        (1<< 7) /* high quality ac prediction */
668  #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 */
669  /* only valid for vol_flags|=XVID_VOL_INTERLACING */  #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
670    #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
671    #define XVID_VOP_RD_PSNRHVSM          (1<<14) /* use PSNR-HVS-M as metric for rate-distortion optimizations */
672    
673    /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
674  #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */  #define XVID_VOP_TOPFIELDFIRST   (1<< 9) /* set top-field-first flag  */
675  #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */  #define XVID_VOP_ALTERNATESCAN   (1<<10) /* set alternate vertical scan flag */
676    
677  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */  /* only valid for vol_flags|=XVID_VOL_REDUCED_ENABLED */
678  #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */  #define XVID_VOP_REDUCED         (1<<11) /* reduced resolution vop */
679                                                                                              /* NOTE: reduced resolution feature is not supported anymore. This flag will have no effect! */
680    
681  #define XVID_VOP_FAST_MODEDECISION_RD (1<< 12) /* use simplified R-D mode decision */  /*----------------------------------------------------------------------------
682     * "Motion" flags
683     *
684     * These flags are used for xvid_enc_frame_t->motion field during frame
685     * encoding (operation XVID_ENC_ENCODE)
686     *--------------------------------------------------------------------------*/
687    
688  /* Motion based flags */  /* Motion Estimation Search Patterns */
689  #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 */
690  #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */  #define XVID_ME_ADVANCEDDIAMOND8      (1<< 1) /* use advdiamond for XVID_ME_EXTSEARCH8 */
691  #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 */
692  #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */  #define XVID_ME_USESQUARES8           (1<< 3) /* use square for XVID_ME_EXTSEARCH8 */
693    
694    /* SAD operator based flags */
695  #define XVID_ME_HALFPELREFINE16       (1<< 4)  #define XVID_ME_HALFPELREFINE16       (1<< 4)
696  #define XVID_ME_HALFPELREFINE8        (1<< 6)  #define XVID_ME_HALFPELREFINE8        (1<< 6)
697  #define XVID_ME_QUARTERPELREFINE16    (1<< 7)  #define XVID_ME_QUARTERPELREFINE16    (1<< 7)
# Line 548  Line 701 
701  #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 */
702  #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 */
703  #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 */
704    #define XVID_ME_FASTREFINE16          (1<<25) /* use low-complexity refinement functions */
705    #define XVID_ME_FASTREFINE8           (1<<29) /* low-complexity 8x8 sub-block refinement */
706    
707  /* Motion search using DCT. use XVID_VOP_MODEDECISION_BITS to enable */  /* Rate Distortion based flags
708     * Valid when XVID_VOP_MODEDECISION_RD is enabled */
709  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */  #define XVID_ME_HALFPELREFINE16_RD    (1<<14) /* perform RD-based halfpel refinement */
710  #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 */
711  #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 557  Line 713 
713  #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 */
714  #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 */
715    
716    /* Other */
717    #define XVID_ME_DETECT_STATIC_MOTION  (1<<24) /* speed-up ME by detecting stationary scenes */
718    #define XVID_ME_SKIP_DELTASEARCH      (1<<26) /* speed-up by skipping b-frame delta search */
719    #define XVID_ME_FAST_MODEINTERPOLATE  (1<<27) /* speed-up by partly skipping interpolate mode */
720    #define XVID_ME_BFRAME_EARLYSTOP      (1<<28) /* speed-up by early exiting b-search */
721    
722    /* Unused */
723  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */  #define XVID_ME_UNRESTRICTED16        (1<<20) /* unrestricted ME, not implemented */
724  #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */  #define XVID_ME_OVERLAPPING16         (1<<21) /* overlapping ME, not implemented */
725  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */  #define XVID_ME_UNRESTRICTED8         (1<<22) /* unrestricted ME, not implemented */
726  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */  #define XVID_ME_OVERLAPPING8          (1<<23) /* overlapping ME, not implemented */
727    
 #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 */  
728    
729  /* XVID_ENC_CREATE param1 */  /*----------------------------------------------------------------------------
730     * xvid_enc_create_t structure definition
731     *
732     * This structure is passed as param1 during an instance creation (operation
733     * XVID_ENC_CREATE)
734     *--------------------------------------------------------------------------*/
735    
736  typedef struct {  typedef struct {
737          int version;          int version;
738    
# Line 579  Line 746 
746          int num_plugins;             /* [in:opt] number of plugins */          int num_plugins;             /* [in:opt] number of plugins */
747          xvid_enc_plugin_t * plugins; /*          ^^ plugin array */          xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
748    
749          int num_threads;             /* [in:opt] number of threads */          int num_threads;             /* [in:opt] number of threads to use in encoder */
750          int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
751    
752          int global;                  /* [in:opt] global flags; controls encoding behavior */          int global;                  /* [in:opt] global flags; controls encoding behavior */
# Line 602  Line 769 
769          /* ---------------------------------------------- */          /* ---------------------------------------------- */
770    
771          void *handle;                /* [out] encoder instance handle */          void *handle;                /* [out] encoder instance handle */
772  }  
773  xvid_enc_create_t;          /* ------- v1.3.x ------- */
774            int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */
775            int num_slices;              /* [in:opt] number of slices to code for each frame */
776    } xvid_enc_create_t;
777    
778    
779    /*----------------------------------------------------------------------------
780     * xvid_enc_frame_t structure definition
781     *
782     * This structure is passed as param1 during a frame encoding (operation
783     * XVID_ENC_ENCODE)
784     *--------------------------------------------------------------------------*/
785    
786    /* out value for the frame structure->type field
787     * unlike stats output in param2, this field is not asynchronous and tells
788     * the client app, if the frame written into the stream buffer is an ivop
789     * usually used for indexing purpose in the container */
790  #define XVID_KEYFRAME (1<<1)  #define XVID_KEYFRAME (1<<1)
791    
792    /* The structure */
793  typedef struct {  typedef struct {
794          int version;          int version;
795    
796          /* --- 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
797             * unless XVID_FORCEVOL is set, the encoder will not react to any changes
798             * here until the next VOL (keyframe). */
799    
800          int vol_flags;                     /* [in] vol flags */          int vol_flags;                     /* [in] vol flags */
801          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */          unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
802          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */          unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
803    
804          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) */
805          int par_width;                     /* [in:opt] aspect ratio width */          int par_width;                     /* [in:opt] aspect ratio width */
806          int par_height;                    /* [in:opt] aspect ratio height */          int par_height;                    /* [in:opt] aspect ratio height */
807          /* ---------------------------------------------- */  
808            /* Other fields that can change on a frame base */
809    
810          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */          int fincr;                         /* [in:opt] framerate increment, for variable framerate only */
811          int vop_flags;                     /* [in] (general)vop-based flags */          int vop_flags;                     /* [in] (general)vop-based flags */
# Line 637  Line 823 
823          int out_flags;                     /* [out] bitstream output flags */          int out_flags;                     /* [out] bitstream output flags */
824  } xvid_enc_frame_t;  } xvid_enc_frame_t;
825    
   
 /* 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;  
   
826  #ifdef __cplusplus  #ifdef __cplusplus
827  }  }
828  #endif  #endif
829    
   
830  #endif  #endif
Legend:
Removed from v.1.27.2.40  
changed lines
  Added in v.1.74.2.2
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4