[svn] / trunk / xvidcore / src / xvid.h Repository:
ViewVC logotype

Diff of /trunk/xvidcore/src/xvid.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1894, Sun Oct 10 19:24:24 2010 UTC revision 2054, Fri Nov 4 15:24:39 2011 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-2010 Peter Ross <pross@xvid.org>   *  Copyright(C) 2001-2011 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 19  Line 19 
19   *  along with this program ; if not, write to the Free Software   *  along with this program ; if not, write to the Free Software
20   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21   *   *
22   * $Id: xvid.h,v 1.69 2010-10-10 19:19:55 Isibaar Exp $   * $Id$
23   *   *
24   ****************************************************************************/   ****************************************************************************/
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
28    
   
29  #ifdef __cplusplus  #ifdef __cplusplus
30  extern "C" {  extern "C" {
31  #endif  #endif
32    
33  /*****************************************************************************  /*****************************************************************************
34     * function export defines
35     ****************************************************************************/
36    
37    /* Attention! Work in progress. TODO: Review */
38    
39    #ifndef XVID_IMPEXP
40    #define XVID_IMPEXP             extern
41    #endif
42    
43    #ifndef XVID_CALL
44    #define XVID_CALL
45    #endif
46    
47    /*****************************************************************************
48   * versioning   * versioning
49   ****************************************************************************/   ****************************************************************************/
50    
# Line 57  Line 70 
70  #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)  #define XVID_API_MAJOR(a)        (((a)>>16) & 0xff)
71  #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)  #define XVID_API_MINOR(a)        (((a)>> 0) & 0xff)
72    
73  #define XVID_VERSION             XVID_MAKE_VERSION(1,3,-127)  #define XVID_VERSION             XVID_MAKE_VERSION(1,4,-127)
74  #define XVID_API                 XVID_MAKE_API(4, 3)  #define XVID_API                 XVID_MAKE_API(4, 4)
75    
76  #define XVID_UNSTABLE  #define XVID_UNSTABLE
77    
# Line 73  Line 86 
86   * 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
87   * future   * future
88   */   */
89  #define XVID_BS_VERSION 57  #define XVID_BS_VERSION 73
90    
91  /*****************************************************************************  /*****************************************************************************
92   * error codes   * error codes
# Line 225  Line 238 
238  #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 */
239  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */  #define XVID_GBL_CONVERT 2 /* colorspace conversion utility */
240    
241  extern int xvid_global(void *handle, int opt, void *param1, void *param2);  XVID_IMPEXP int XVID_CALL xvid_global(void *handle, int opt, void *param1, void *param2);
242    
243    
244  /*****************************************************************************  /*****************************************************************************
# Line 236  Line 249 
249  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */  #define XVID_DEC_DESTROY 1 /* destroy decore instance: return 0 on success */
250  #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 */
251    
252  extern int xvid_decore(void *handle, int opt, void *param1, void *param2);  XVID_IMPEXP int XVID_CALL xvid_decore(void *handle, int opt, void *param1, void *param2);
253    
254  /* XVID_DEC_CREATE param 1  /* XVID_DEC_CREATE param 1
255          image width & height as well as FourCC code may be specified          image width & height as well as FourCC code may be specified
# Line 246  Line 259 
259          int width;      /* [in:opt] image width */          int width;      /* [in:opt] image width */
260          int height;     /* [in:opt] image width */          int height;     /* [in:opt] image width */
261          void * handle;  /* [out]    decore context handle */          void * handle;  /* [out]    decore context handle */
262          int fourcc;     /* [in:opt] fourcc of the video */  /* ------- v1.3.x ------- */
263            int fourcc;     /* [in:opt] fourcc of the input video */
264            int num_threads;/* [in:opt] number of threads to use in decoder */
265  } xvid_dec_create_t;  } xvid_dec_create_t;
266    
267    
# Line 370  Line 385 
385  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */  #define XVID_REQDQUANTS  (1<<2) /* plugin requires access to the dquant table */
386  #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */  #define XVID_REQLAMBDA   (1<<3) /* plugin requires access to the lambda table */
387    
   
388  typedef struct  typedef struct
389  {  {
390          int version;          int version;
# Line 474  Line 488 
488    
489   ****************************************************************************/   ****************************************************************************/
490    
491  typedef int (xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);  typedef int (XVID_CALL xvid_plugin_func)(void * handle, int opt, void * param1, void * param2);
492    
493  typedef struct  typedef struct
494  {  {
# Line 482  Line 496 
496          void * param;          void * param;
497  } xvid_enc_plugin_t;  } xvid_enc_plugin_t;
498    
499    XVID_IMPEXP xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */
500    XVID_IMPEXP xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */
501    XVID_IMPEXP xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */
502    
503  extern xvid_plugin_func xvid_plugin_single;   /* single-pass rate control */  XVID_IMPEXP xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */
 extern xvid_plugin_func xvid_plugin_2pass1;   /* two-pass rate control: first pass */  
 extern xvid_plugin_func xvid_plugin_2pass2;   /* two-pass rate control: second pass */  
   
 extern xvid_plugin_func xvid_plugin_lumimasking;  /* lumimasking */  
504    
505  extern xvid_plugin_func xvid_plugin_psnr;       /* write psnr values to stdout */  XVID_IMPEXP xvid_plugin_func xvid_plugin_psnr;      /* write psnr values to stdout */
506  extern xvid_plugin_func xvid_plugin_dump;       /* dump before and after yuvpgms */  XVID_IMPEXP xvid_plugin_func xvid_plugin_dump;      /* dump before and after yuvpgms */
507    
508  extern xvid_plugin_func xvid_plugin_ssim;           /*write ssim values to stdout*/  XVID_IMPEXP xvid_plugin_func xvid_plugin_ssim;      /*write ssim values to stdout*/
509  extern xvid_plugin_func xvid_plugin_psnrhvsm;   /*write psnrhvsm values to stdout*/  XVID_IMPEXP xvid_plugin_func xvid_plugin_psnrhvsm;  /*write psnrhvsm values to stdout*/
510    
511    
512  /* single pass rate control  /* single pass rate control
# Line 541  Line 554 
554          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 */
555    
556  /* ------- v1.1.x ------- */  /* ------- v1.1.x ------- */
557          int vbv_size;                 /* [in] buffer size (bits) */          int vbv_size;                 /* [in] buffer size (bits) If this is zero, VBV check is disabled.*/
558          int vbv_initial;              /* [in] initial buffer occupancy (bits) */          int vbv_initial;              /* [in] initial buffer occupancy (bits) */
559          int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */          int vbv_maxrate;              /* [in] max processing bitrate (bits per second) */
560          int vbv_peakrate;             /* [in:opt] max average bitrate over 3 seconds (bits per second) */          int vbv_peakrate;             /* [in:opt] max average bitrate over 1 second (bits per second).
561                                                                       *          This is used for diagnostics only and won't affect the actual peak bitrate.
562                                                                       *          This is not a problem as long as vbv_peakrate > vbv_size + vbv_maxrate which
563                                                                       *          guarantees that vbv_peakrate won't be exceeded. */
564  }xvid_plugin_2pass2_t;  }xvid_plugin_2pass2_t;
565    
566    
# Line 588  Line 603 
603   * Encoder entry point   * Encoder entry point
604   *--------------------------------------------------------------------------*/   *--------------------------------------------------------------------------*/
605    
606  extern int xvid_encore(void *handle, int opt, void *param1, void *param2);  XVID_IMPEXP int XVID_CALL xvid_encore(void *handle, int opt, void *param1, void *param2);
607    
608  /* Quick API reference  /* Quick API reference
609   *   *
# Line 667  Line 682 
682  #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 */
683  #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */  #define XVID_VOP_FAST_MODEDECISION_RD (1<<12) /* use simplified R-D mode decision */
684  #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */  #define XVID_VOP_RD_BVOP              (1<<13) /* enable rate-distortion mode decision in b-frames */
685    #define XVID_VOP_RD_PSNRHVSM          (1<<14) /* use PSNR-HVS-M as metric for rate-distortion optimizations */
686    
687  /* Only valid for vol_flags|=XVID_VOL_INTERLACING */  /* Only valid for vol_flags|=XVID_VOL_INTERLACING */
688  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */  #define XVID_VOP_TOPFIELDFIRST        (1<< 9) /* set top-field-first flag  */
# Line 744  Line 760 
760          int num_plugins;             /* [in:opt] number of plugins */          int num_plugins;             /* [in:opt] number of plugins */
761          xvid_enc_plugin_t * plugins; /*          ^^ plugin array */          xvid_enc_plugin_t * plugins; /*          ^^ plugin array */
762    
763          int num_threads;             /* [in:opt] number of threads */          int num_threads;             /* [in:opt] number of threads to use in encoder */
764          int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */          int max_bframes;             /* [in:opt] max sequential bframes (0=disable bframes) */
765    
766          int global;                  /* [in:opt] global flags; controls encoding behavior */          int global;                  /* [in:opt] global flags; controls encoding behavior */
# Line 770  Line 786 
786    
787          /* ------- v1.3.x ------- */          /* ------- v1.3.x ------- */
788          int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */          int start_frame_num;         /* [in:opt] frame number of start frame relative to zones definitions. allows to encode sub-sequences */
789            int num_slices;              /* [in:opt] number of slices to code for each frame */
790  } xvid_enc_create_t;  } xvid_enc_create_t;
791    
792    
Legend:
Removed from v.1894  
changed lines
  Added in v.2054
No admin address has been configured
 ViewVC Help
Powered by ViewVC 1.0.4