---

xvid.h

/*****************************************************************************
 *
 *  XVID MPEG-4 VIDEO CODEC
 *  - XviD Main header file -
 *
 *  This file is part of XviD, a free MPEG-4 video encoder/decoder
 *
 *  XviD is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 *  Under section 8 of the GNU General Public License, the copyright
 *  holders of XVID explicitly forbid distribution in the following
 *  countries:
 *
 *    - Japan
 *    - United States of America
 *
 *  Linking XviD statically or dynamically with other modules is making a
 *  combined work based on XviD.  Thus, the terms and conditions of the
 *  GNU General Public License cover the whole combination.
 *
 *  As a special exception, the copyright holders of XviD give you
 *  permission to link XviD with independent modules that communicate with
 *  XviD solely through the VFW1.1 and DShow interfaces, regardless of the
 *  license terms of these independent modules, and to copy and distribute
 *  the resulting combined work under terms of your choice, provided that
 *  every copy of the combined work is accompanied by a complete copy of
 *  the source code of XviD (the version of XviD used to produce the
 *  combined work), being distributed under the terms of the GNU General
 *  Public License plus this exception.  An independent module is a module
 *  which is not derived from or based on XviD.
 *
 *  Note that people who make modified versions of XviD are not obligated
 *  to grant this special exception for their modified versions; it is
 *  their choice whether to do so.  The GNU General Public License gives
 *  permission to release a modified version without this exception; this
 *  exception also makes it possible to release a modified version which
 *  carries forward this exception.
 *
 * $Id: xvid.h,v 1.24 2002/11/26 23:44:10 edgomez Exp $
 *
 *****************************************************************************/

#ifndef _XVID_H_
#define _XVID_H_

#ifdef __cplusplus
extern "C" {
#endif


/*****************************************************************************
 *  API version number
 ****************************************************************************/

#define API_VERSION ((2 << 16) | (1))
/*****************************************************************************
 *  Error codes
 ****************************************************************************/


#define XVID_ERR_FAIL   -1 
#define XVID_ERR_OK      0 
#define XVID_ERR_MEMORY  1 
#define XVID_ERR_FORMAT  2 
/*****************************************************************************
 *  Color space constants
 ****************************************************************************/


#define XVID_CSP_RGB24  0  
#define XVID_CSP_YV12   1  
#define XVID_CSP_YUY2   2  
#define XVID_CSP_UYVY   3  
#define XVID_CSP_I420   4  
#define XVID_CSP_RGB555 10 
#define XVID_CSP_RGB565 11 
#define XVID_CSP_USER   12 
#define XVID_CSP_EXTERN 1004 
#define XVID_CSP_YVYU   1002 
#define XVID_CSP_RGB32  1000 
#define XVID_CSP_NULL   9999 
#define XVID_CSP_VFLIP  0x80000000 
/*****************************************************************************
 *  CPU flags
 ****************************************************************************/


#define XVID_CPU_MMX      0x00000001 
#define XVID_CPU_MMXEXT   0x00000002 
#define XVID_CPU_SSE      0x00000004 
#define XVID_CPU_SSE2     0x00000008 
#define XVID_CPU_3DNOW    0x00000010 
#define XVID_CPU_3DNOWEXT 0x00000020 
#define XVID_CPU_TSC      0x00000040 
#define XVID_CPU_IA64     0x00000080 
#define XVID_CPU_CHKONLY  0x40000000 
#define XVID_CPU_FORCE    0x80000000 
/*****************************************************************************
 *  Initialization structures
 ****************************************************************************/

    typedef struct
    {
        int cpu_flags;   
        int api_version; 
        int core_build;  
    }
    XVID_INIT_PARAM;

/*****************************************************************************
 *  Initialization entry point
 ****************************************************************************/

    int xvid_init(void *handle,
              int opt,
              void *param1,
              void *param2);

/*****************************************************************************
 * Decoder constant
 ****************************************************************************/

#define XVID_QUICK_DECODE       0x00000010


/*****************************************************************************
 * Decoder structures
 ****************************************************************************/

    typedef struct
    {
        int width;
        int height;
        void *handle;
    }
    XVID_DEC_PARAM;


    typedef struct
    {
        int general;
        void *bitstream;
        int length;

        void *image;
        int stride;
        int colorspace;
    }
    XVID_DEC_FRAME;


    /* This struct is used for per slice rendering */
    typedef struct 
    {
        void *y,*u,*v;
        int stride_y, stride_u,stride_v;
    } XVID_DEC_PICTURE;


/*****************************************************************************
 * Decoder entry point
 ****************************************************************************/

#define XVID_DEC_DECODE     0 
#define XVID_DEC_CREATE     1 
#define XVID_DEC_DESTROY    2 
    int xvid_decore(void *handle,
            int opt,
            void *param1,
            void *param2);

/*****************************************************************************
 * Encoder constants
 ****************************************************************************/

#define XVID_VALID_FLAGS        0x80000000 
#define XVID_CUSTOM_QMATRIX     0x00000004 
#define XVID_H263QUANT          0x00000010 
#define XVID_MPEGQUANT          0x00000020 
#define XVID_HALFPEL            0x00000040 
#define XVID_ADAPTIVEQUANT      0x00000080
#define XVID_LUMIMASKING        0x00000100
#define XVID_LATEINTRA          0x00000200
#define XVID_INTERLACING        0x00000400
#define XVID_TOPFIELDFIRST      0x00000800
#define XVID_ALTERNATESCAN      0x00001000
#define XVID_HINTEDME_GET       0x00002000
#define XVID_HINTEDME_SET       0x00004000
#define XVID_INTER4V            0x00008000
#define XVID_ME_ZERO            0x00010000
#define XVID_ME_LOGARITHMIC     0x00020000
#define XVID_ME_FULLSEARCH      0x00040000
#define XVID_ME_PMVFAST         0x00080000
#define XVID_ME_EPZS            0x00100000
#define XVID_GREYSCALE          0x01000000
#define XVID_GRAYSCALE          XVID_GREYSCALE 
#define PMV_ADVANCEDDIAMOND8    0x00004000
#define PMV_ADVANCEDDIAMOND16   0x00008000
#define PMV_HALFPELDIAMOND16    0x00010000
#define PMV_HALFPELREFINE16     0x00020000
#define PMV_EXTSEARCH16         0x00040000
#define PMV_EARLYSTOP16         0x00080000
#define PMV_QUICKSTOP16         0x00100000
#define PMV_UNRESTRICTED16      0x00200000
#define PMV_OVERLAPPING16       0x00400000
#define PMV_USESQUARES16        0x00800000
#define PMV_HALFPELDIAMOND8     0x01000000
#define PMV_HALFPELREFINE8      0x02000000
#define PMV_EXTSEARCH8          0x04000000
#define PMV_EARLYSTOP8          0x08000000
#define PMV_QUICKSTOP8          0x10000000
#define PMV_UNRESTRICTED8       0x20000000
#define PMV_OVERLAPPING8        0x40000000
#define PMV_USESQUARES8         0x80000000
/*****************************************************************************
 * Encoder structures
 ****************************************************************************/

    typedef struct
    {
        int width;                    
        int height;                   
        int fincr;                    
        int fbase;                    
        int rc_bitrate;               
        int rc_reaction_delay_factor; 
        int rc_averaging_period;      
        int rc_buffer;                
        int max_quantizer;            
        int min_quantizer;            
        int max_key_interval;         
        void *handle;                 
    }
    XVID_ENC_PARAM;

    typedef struct
    {
        int x;
        int y;
    }
    VECTOR;

    typedef struct
    {
        int mode;               /* macroblock mode */
        VECTOR mvs[4];
    }
    MVBLOCKHINT;

    typedef struct
    {
        int intra;              /* frame intra choice */
        int fcode;              /* frame fcode */
        MVBLOCKHINT *block;     /* caller-allocated array of block hints (mb_width * mb_height) */
    }
    MVFRAMEHINT;

    typedef struct
    {
        int rawhints;           /* if set, use MVFRAMEHINT, else use compressed buffer */

        MVFRAMEHINT mvhint;
        void *hintstream;       /* compressed hint buffer */
        int hintlength;         /* length of buffer (bytes) */
    }
    HINTINFO;

    typedef struct
    {
        int general;                       
        int motion;                        
        void *bitstream;                   
        int length;                        
        void *image;                       
        int colorspace;                    
        unsigned char *quant_intra_matrix; 
        unsigned char *quant_inter_matrix; 
        int quant;                         
        int intra;                         
        HINTINFO hint;                     
    }
    XVID_ENC_FRAME;


    typedef struct
    {
        int quant;               
        int hlength;             
        int kblks;               
        int mblks;               
        int ublks;               
    }
    XVID_ENC_STATS;


/*****************************************************************************
 * Encoder entry point
 ****************************************************************************/

#define XVID_ENC_ENCODE     0 
#define XVID_ENC_CREATE     1 
#define XVID_ENC_DESTROY    2 
    int xvid_encore(void *handle,
                    int opt,
                    void *param1,
                    void *param2);

#ifdef __cplusplus
}
#endif

#endif

Author : XviD team <xvid-devel@xvid.org>	Date : 2003-02-13