[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 853, Sat Feb 15 18:48:15 2003 UTC revision 868, Tue Feb 18 00:23:27 2003 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     *  This file is part of XviD, a free MPEG-4 video encoder/decoder
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
10  *  the Free Software Foundation ; either version 2 of the License, or  *  the Free Software Foundation ; either version 2 of the License, or
# Line 17  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.27 2003-02-18 00:23:27 edgomez Exp $
 /*****************************************************************************  
 *  
 *  History  
 *  
 *  - 2002/06/13 Added legal header, ANSI C comment style (only for this header  
 *               as it can be included in a ANSI C project).  
 *  
 *               ToDo ? : when BFRAMES is defined, the API_VERSION should not  
 *                        be the same (3.0 ?)  
 *  
 *  $Id: xvid.h,v 1.26 2003-02-15 18:48:15 edgomez Exp $  
23  *  *
24  *****************************************************************************/   ****************************************************************************/
   
25    
26  #ifndef _XVID_H_  #ifndef _XVID_H_
27  #define _XVID_H_  #define _XVID_H_
# Line 78  Line 68 
68  #define XVID_CSP_RGB555 10  #define XVID_CSP_RGB555 10
69  #define XVID_CSP_RGB565 11  #define XVID_CSP_RGB565 11
70  #define XVID_CSP_USER   12  #define XVID_CSP_USER   12
71  #define XVID_CSP_EXTERN      1004  // per slice rendering  #define XVID_CSP_EXTERN 1004 /* per slice rendering */
72  #define XVID_CSP_YVYU   1002  #define XVID_CSP_YVYU   1002
73  #define XVID_CSP_RGB32  1000    /* [b|g|r|a] */  #define XVID_CSP_RGB32  1000    /* [b|g|r|a] */
74  #define XVID_CSP_ABGR   1006    /* [a|b|g|r] */  #define XVID_CSP_ABGR   1006    /* [a|b|g|r] */
# Line 88  Line 78 
78    
79  #define XVID_CSP_NULL   9999  #define XVID_CSP_NULL   9999
80    
81  #define XVID_CSP_VFLIP  0x80000000      // flip mask  #define XVID_CSP_VFLIP  0x80000000 /* flip mask */
82    
83    
84  /*****************************************************************************  /*****************************************************************************
# Line 96  Line 86 
86   ****************************************************************************/   ****************************************************************************/
87    
88  /* CPU flags for XVID_INIT_PARAM.cpu_flags */  /* CPU flags for XVID_INIT_PARAM.cpu_flags */
89  #define XVID_CPU_FORCE          0x80000000  #define XVID_CPU_FORCE     0x80000000  /* force passed cpu flags */
90  #define XVID_CPU_CHKONLY        0x40000000              /* check cpu only; dont init globals */  #define XVID_CPU_CHKONLY        0x40000000              /* check cpu only; dont init globals */
   
91  #define XVID_CPU_ASM            0x00000080              /* native assembly */  #define XVID_CPU_ASM            0x00000080              /* native assembly */
92    
93  /* ARCH_IS_IA32 */  /* ARCH_IS_IA32 */
94  #define XVID_CPU_MMX            0x00000001              /* mmx: pentiumMMX,k6 */  #define XVID_CPU_MMX            0x00000001              /* mmx: pentiumMMX,k6 */
95  #define XVID_CPU_MMXEXT         0x00000002              /* mmxx-ext: pentium2,athlon */  #define XVID_CPU_MMXEXT   0x00000002   /* mmx-ext  : pentium2, athlon */
96  #define XVID_CPU_SSE            0x00000004              /* sse: pentium3,athlonXP */  #define XVID_CPU_SSE            0x00000004              /* sse: pentium3,athlonXP */
97  #define XVID_CPU_SSE2           0x00000008              /* sse2: pentium4,athlon64 */  #define XVID_CPU_SSE2           0x00000008              /* sse2: pentium4,athlon64 */
98  #define XVID_CPU_3DNOW          0x00000010              /* 3dnow: k6-2 */  #define XVID_CPU_3DNOW          0x00000010              /* 3dnow: k6-2 */
99  #define XVID_CPU_3DNOWEXT       0x00000020              /* 3dnow-ext: athlon */  #define XVID_CPU_3DNOWEXT       0x00000020              /* 3dnow-ext: athlon */
100  #define XVID_CPU_TSC            0x00000040              /* timestamp counter */  #define XVID_CPU_TSC            0x00000040              /* timestamp counter */
101    
102  /* ARCH_IS_IA64 */  /* ARCH_IS_IA64 */
103  #define XVID_CPU_IA64           XVID_CPU_ASM    /* defined for backward compatibility */  #define XVID_CPU_IA64           XVID_CPU_ASM    /* defined for backward compatibility */
104    
105  /* ARCH_IS_PPC */  /* ARCH_IS_PPC */
106  #define XVID_CPU_ALTIVEC        0x00000001              /* altivec */  #define XVID_CPU_ALTIVEC        0x00000001              /* altivec */
107    
# Line 137  Line 129 
129                  int cpu_flags;                  int cpu_flags;
130                  int api_version;                  int api_version;
131                  int core_build;                  int core_build;
132          }          } XVID_INIT_PARAM;
         XVID_INIT_PARAM;  
133    
134          typedef struct          typedef struct
135          {          {
# Line 164  Line 155 
155   ****************************************************************************/   ****************************************************************************/
156    
157  /* Flags for XVID_DEC_FRAME.general */  /* Flags for XVID_DEC_FRAME.general */
158  #define XVID_DEC_LOWDELAY               0x00000001      /* decode lowdelay mode (ie. video-for-windows) */  #define XVID_DEC_LOWDELAY      0x00000001 /* decode lowdelay mode (ie. VFW) */
159  #define XVID_DEC_DEBLOCKY               0x00000002      /* luma deblocking */  #define XVID_DEC_DEBLOCKY               0x00000002      /* luma deblocking */
160  #define XVID_DEC_DEBLOCKUV              0x00000008      /* chroma deblocking */  #define XVID_DEC_DEBLOCKUV              0x00000008      /* chroma deblocking */
161  #define XVID_DEC_DISCONTINUITY  0x00000004      /* indicates break in stream; instructs  #define XVID_DEC_DISCONTINUITY 0x00000004 /* indicates break in stream
162                                                                                          decoder to ignore any previous reference frames */                                               instructs decoder to ignore any
163                                                 previous reference frames */
164  #define XVID_QUICK_DECODE               0x00000010  #define XVID_QUICK_DECODE               0x00000010
165    
166  /*****************************************************************************  /*****************************************************************************
# Line 180  Line 172 
172                  int width;                  int width;
173                  int height;                  int height;
174                  void *handle;                  void *handle;
175          }          } XVID_DEC_PARAM;
         XVID_DEC_PARAM;  
176    
177    
178  #define XVID_DEC_VOP    0  #define XVID_DEC_VOP    0
# Line 220  Line 211 
211                  void *image;                  void *image;
212                  int stride;                  int stride;
213                  int colorspace;                  int colorspace;
214          }          } XVID_DEC_FRAME;
         XVID_DEC_FRAME;  
215    
216    
217          // This struct is used for per slice rendering          /* This struct is used for per slice rendering */
218          typedef struct          typedef struct
219          {          {
220                  void *y,*u,*v;                  void *y,*u,*v;
# Line 288  Line 278 
278    
279  #define XVID_CHROMAOPT                  0x00200000      /* enable chroma optimization pre-filter */  #define XVID_CHROMAOPT                  0x00200000      /* enable chroma optimization pre-filter */
280    
281  #define XVID_GREYSCALE                  0x01000000      /* enable greyscale only mode (even for */  #define XVID_GREYSCALE          0x01000000 /* enable greyscale only mode (even for
282                                                                                          /* color input material chroma is ignored) */                                                color input material chroma is ignored) */
283    
284  #define XVID_GMC                                0x10000000  #define XVID_GMC                                0x10000000
285  #define XVID_GMC_TRANSLATIONAL  0x20000000  #define XVID_GMC_TRANSLATIONAL  0x20000000
# Line 303  Line 293 
293    
294    
295  /* Flags for XVID_ENC_FRAME.motion */  /* Flags for XVID_ENC_FRAME.motion */
   
296  #define PMV_ADVANCEDDIAMOND16   0x00008000      /* use advdiamonds instead of diamonds as search pattern */  #define PMV_ADVANCEDDIAMOND16   0x00008000      /* use advdiamonds instead of diamonds as search pattern */
297  #define PMV_USESQUARES16                0x00800000      /* use squares instead of diamonds as search pattern */  #define PMV_USESQUARES16                0x00800000      /* use squares instead of diamonds as search pattern */
298    
# Line 322  Line 311 
311  #define PMV_CHROMA16                    0x00100000      /* also use chroma for P_VOP/S_VOP ME */  #define PMV_CHROMA16                    0x00100000      /* also use chroma for P_VOP/S_VOP ME */
312  #define PMV_CHROMA8                             0x10000000      /* also use chroma for B_VOP ME */  #define PMV_CHROMA8                             0x10000000      /* also use chroma for B_VOP ME */
313    
314  /* Motion search using DCT. use XVID_MODEDECISION_DCT to enable */  /* Motion search using DCT. use XVID_MODEDECISION_BITS to enable */
315  #define HALFPELREFINE16_BITS    0x00000100      /* perform DCT-based halfpel refinement */  #define HALFPELREFINE16_BITS    0x00000100      /* perform DCT-based halfpel refinement */
316  #define HALFPELREFINE8_BITS             0x00000200      /* perform DCT-based halfpel refinement for 8x8 mode */  #define HALFPELREFINE8_BITS             0x00000200      /* perform DCT-based halfpel refinement for 8x8 mode */
317  #define QUARTERPELREFINE16_BITS 0x00000400      /* perform DCT-based qpel refinement */  #define QUARTERPELREFINE16_BITS 0x00000400      /* perform DCT-based qpel refinement */
318  #define QUARTERPELREFINE8_BITS  0x00000800      /* perform DCT-based qpel refinement for 8x8 mode */  #define QUARTERPELREFINE8_BITS  0x00000800      /* perform DCT-based qpel refinement for 8x8 mode */
319    
320  #define EXTSEARCH_BITS                  0x00001000      /* perform DCT-based search using square pattern */  #define EXTSEARCH_BITS          0x00001000 /* perform DCT-based search using square pattern
321                                                                                          /* enable PMV_EXTSEARCH8 to do this in 8x8 search as well */                                                enable PMV_EXTSEARCH8 to do this in 8x8 search as well */
322  #define CHECKPREDICTION_BITS    0x00002000      /* always check vector equal to prediction */  #define CHECKPREDICTION_BITS    0x00002000      /* always check vector equal to prediction */
323    
324    
# Line 360  Line 349 
349          typedef struct          typedef struct
350          {          {
351                  int width, height;                  int width, height;
352                  int fincr, fbase;               /* frame increment, fbase. each frame = "fincr/fbase" seconds */                  int fincr, fbase;             /* [in] frame increment, fbase. each frame = "fincr/fbase" seconds */
353                  int rc_bitrate;                 /* the bitrate of the target encoded stream, in bits/second */                  int rc_bitrate;               /* [in] the bitrate of the target encoded stream, in bits/second */
354                  int rc_reaction_delay_factor;   /* how fast the rate control reacts - lower values are faster */                  int rc_reaction_delay_factor; /* [in] how fast the rate control reacts - lower values are faster */
355                  int rc_averaging_period;        /* as above */                  int rc_averaging_period;      /* [in] as above */
356                  int rc_buffer;                  /* as above */                  int rc_buffer;                /* [in] as above */
357                  int max_quantizer;              /* the upper limit of the quantizer */                  int max_quantizer;            /* [in] the upper limit of the quantizer */
358                  int min_quantizer;              /* the lower limit of the quantizer */                  int min_quantizer;            /* [in] the lower limit of the quantizer */
359                  int max_key_interval;   /* the maximum interval between key frames */                  int max_key_interval;         /* [in] the maximum interval between key frames */
360  #ifdef _SMP  #ifdef _SMP
361                  int num_threads;                /* number of threads */                  int num_threads;              /* [in] number of threads */
362  #endif  #endif
363                  int global;                             /* global/debug options */                  int global;                   /* [in] global/debug options */
364                  int max_bframes;                /* max sequential bframes (0=disable bframes) */                  int max_bframes;              /* [in] max sequential bframes (0=disable bframes) */
365                  int bquant_ratio;               /* bframe quantizer multipier (percentage).                  int bquant_ratio;             /* [in] bframe quantizer multipier (percentage).
366                                                                   * used only when bquant < 1                                                used only when bquant < 1
367                                                                   * eg. 200 = x2 multiplier                                                eg. 200 = x2 multiplier
368                                                                   * quant = ((past_quant + future_quant) * bquant_ratio)/200                                                    quant = ((past_quant + future_quant) * bquant_ratio)/200
369                                                                   */                                                                   */
370                  int bquant_offset;              /* bquant += bquant_offset */                  int bquant_offset;            /* [in] bquant += bquant_offset */
371                  int frame_drop_ratio;   /* frame dropping: 0=drop none... 100=drop all */                  int frame_drop_ratio;         /* [in] frame dropping: 0=drop none... 100=drop all */
372                  void *handle;                   /* [out] encoder instance handle */                  void *handle;                   /* [out] encoder instance handle */
373          }          } XVID_ENC_PARAM;
         XVID_ENC_PARAM;  
374    
375          typedef struct          typedef struct
376          {          {
377                  int x;                  int x;
378                  int y;                  int y;
379          }          } VECTOR;
         VECTOR;  
380    
381          typedef struct          typedef struct
382          {          {
383                  int mode;                               /* macroblock mode */                  int mode;                               /* macroblock mode */
384                  VECTOR mvs[4];                  VECTOR mvs[4];
385          }          } MVBLOCKHINT;
         MVBLOCKHINT;  
386    
387          typedef struct          typedef struct
388          {          {
389                  int intra;                              /* frame intra choice */                  int intra;                              /* frame intra choice */
390                  int fcode;                              /* frame fcode */                  int fcode;                              /* frame fcode */
391                  MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */                  MVBLOCKHINT *block;             /* caller-allocated array of block hints (mb_width * mb_height) */
392          }          } MVFRAMEHINT;
         MVFRAMEHINT;  
393    
394          typedef struct          typedef struct
395          {          {
# Line 413  Line 398 
398                  MVFRAMEHINT mvhint;                  MVFRAMEHINT mvhint;
399                  void *hintstream;               /* compressed hint buffer */                  void *hintstream;               /* compressed hint buffer */
400                  int hintlength;                 /* length of buffer (bytes) */                  int hintlength;                 /* length of buffer (bytes) */
401          }          } HINTINFO;
         HINTINFO;  
402    
403          typedef struct          typedef struct
404          {          {
# Line 424  Line 408 
408                  int length;                             /* [out] bitstream length (bytes) */                  int length;                             /* [out] bitstream length (bytes) */
409    
410                  void *image;                    /* [in] image ptr */                  void *image;                    /* [in] image ptr */
411                  int stride;                  int stride;                        /* [in] horizontal stride in bytes */
412                  int colorspace;                 /* [in] source colorspace */                  int colorspace;                 /* [in] source colorspace */
413    
414                  unsigned char *quant_intra_matrix;      // [in] custom intra qmatrix */                  unsigned char *quant_intra_matrix; /* [in] custom intra qmatrix */
415                  unsigned char *quant_inter_matrix;      // [in] custom inter qmatrix */                  unsigned char *quant_inter_matrix; /* [in] custom inter qmatrix */
416                  int quant;                              /* [in] frame quantizer (vbr) */                  int quant;                              /* [in] frame quantizer (vbr) */
417                  int intra;                              /* [in] force intra frame (vbr only)                  int intra;                              /* [in] force intra frame (vbr only)
418                                                                   * [out] intra state                                                [out] frame type (ugly atm)
419                                                                   */                                                                   */
420                  HINTINFO hint;                  /* [in/out] mv hint information */                  HINTINFO hint;                  /* [in/out] mv hint information */
421    
422                  int bquant;                             /* [in] bframe quantizer */                  int bquant;                             /* [in] bframe quantizer */
423    
424          }          } XVID_ENC_FRAME;
         XVID_ENC_FRAME;  
425    
426    
427          typedef struct          typedef struct
428          {          {
429                  int quant;                              /* [out] frame quantizer */                  int quant;                              /* [out] frame quantizer */
430                  int hlength;                    /* [out] header length (bytes) */                  int hlength;                    /* [out] header length (bytes) */
431                  int kblks, mblks, ublks;        /* [out] */                  int kblks;   /* [out] number of intra blocks */
432                    int mblks;   /* [out] number of inter blocks */
433                    int ublks;       /* [out] number of "not coded" blocks */
434                  long sse_y;                             /* [out] SSE of Y */                  long sse_y;                             /* [out] SSE of Y */
435                  long sse_u;                             /* [out] SSE of Cb */                  long sse_u;                             /* [out] SSE of Cb */
436                  long sse_v;                             /* [out] SSE of Cr */                  long sse_v;                             /* [out] SSE of Cr */
437          }          } XVID_ENC_STATS;
         XVID_ENC_STATS;  
438    
439    
440  /*****************************************************************************  /*****************************************************************************

Legend:
Removed from v.853  
changed lines
  Added in v.868

No admin address has been configured
ViewVC Help
Powered by ViewVC 1.0.4