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