[XviD-devel] API 3.0
peter ross
xvid-devel@xvid.org
Tue, 10 Sep 2002 22:38:46 +1000
This is a multi-part message in MIME format.
------=_NextPart_000_6a6b_70c3_2c1b
Content-Type: text/plain; format=flowed
>interesting. I believe that a lot can still be improved for CBR mode, but I
>don't plan to start working on ratecontrol before the "new" API 3.0 XVID is
>somehow "ready"...
iam working on it; see attachement.
feedback welcome; because nobody answered my original API v3.0 post.
more questions:
* should we call it XVID_VERSION or XVID_API_VERSION ??
* XVID_CPU_TSC can be removed; its not codec-performance related is it??
* XVID_CPU_IA64 can also be removed; when xvid is compiled with
ARCH_IA64, it assumed the cpu has IA64 support, right??
* ive moved time_increment/base to XVID_ENC_FRAME to support
variable frame rates.
* XVID_QUICK_DECODE? this in the old api, but never used in xvidcore.
we should have DEC_FRAME flags for things like:
* XVID_DEC_FAST /* skip bframes */
* XVID_DEC_CRAPIDCT /* or maybe selectable idct, urgh */
* raw hints worry me, as they add a lot of structs to the api.
does anyone use the raw(uncompressed) mv hints ??
-- pete
_________________________________________________________________
Join the world’s largest e-mail service with MSN Hotmail.
http://www.hotmail.com
------=_NextPart_000_6a6b_70c3_2c1b
Content-Type: text/plain; name="xvid3.h"; format=flowed
Content-Transfer-Encoding: 8bit
Content-Disposition: attachment; filename="xvid3.h"
/*****************************************************************************
*
* XVID MPEG-4 VIDEO CODEC
* - XviD Main header file -
*
* This program is an implementation of a part of one or more MPEG-4
* Video tools as specified in ISO/IEC 14496-2 standard. Those intending
* to use this software module in hardware or software products are
* advised that its use may infringe existing patents or copyrights, and
* any such use would be at such party's own risk. The original
* developer of this software module and his/her company, and subsequent
* editors and their companies, will have no liability for use of this
* software or modifications or derivatives thereof.
*
* This program 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
*
* $Id: xvid.h,v 1.17 2002/07/31 18:10:34 chl Exp $
*
*****************************************************************************/
#ifndef _XVID_H_
#define _XVID_H_
#ifdef __cplusplus
extern "C" {
#endif
/*****************************************************************************
* Global constants
****************************************************************************/
/* API Version : 3.0 */
#define XVID_MAKE_VERSION(A,B) (((A) << 16) | (B))
#define XVID_VERSION XVID_MAKE_VERSION(3,0)
/* Error codes */
#define XVID_ERR_OK 0
#define XVID_ERR_FAIL 1
#define XVID_ERR_MEMORY 2
#define XVID_ERR_FORMAT 3
#define XVID_ERR_VERSION 4
#define XVID_ERR_NOTIFY 5
/* Colorspaces */
#define XVID_CSP_NULL 0
#define XVID_CSP_USER 1
#define XVID_CSP_EXTERN 3 // per slice rendering
#define XVID_CSP_YV12 4
#define XVID_CSP_I420 5
#define XVID_CSP_YUY2 6
#define XVID_CSP_YVYU 7
#define XVID_CSP_UYVY 8
#define XVID_CSP_RGB32 9
#define XVID_CSP_RGB24 10
#define XVID_CSP_RGB555 11
#define XVID_CSP_RGB565 12
#define XVID_CSP_VFLIP 0x80000000 // flip mask
/*****************************************************************************
* Initialization constants
****************************************************************************/
/* CPU flags for XVID_INIT_PARAM.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_THREADS 0x00000040
/* XXX: #define XVID_CPU_TSC 0x00000040 */
/* XXX: #define XVID_CPU_IA64 0x00000080 */
// ---
#define XVID_CPU_CHKONLY 0x40000000 /* check cpu only; dont init globals */
#define XVID_CPU_FORCE 0x80000000 /* force
/*****************************************************************************
* Initialization structures
****************************************************************************/
typedef struct
{
int version; /* in | version */
int cpu_flags; /* in/out opt | cpu flags */
int max_version; /* out | max supported api version */
}
XVID_INIT_PARAM;
/*****************************************************************************
* Initialization entry point
****************************************************************************/
int xvid_init(void *handle,
int opt,
void *param1,
void *param2);
/*****************************************************************************
* Decoder constants
****************************************************************************/
/* Flags for XVID_DEC_FRAME.general */
/* XXX: #define XVID_QUICK_DECODE 0x00000001 */
/* Flags for XVID_DEC_STATS.flags */
#define XVID_DEC_STATS_IGNORE 0x00000001 /* dont display this frame */
/*****************************************************************************
* Decoder structures
****************************************************************************/
typedef struct
{
int version;
int width; /* [in:opt] frame width */
int height; /* [in:opt] frame height */
void *handle; /* [out codec handle */
struct {
/* extended fields */
} ext;
}
XVID_DEC_PARAM;
typedef struct
{
int version;
int general; /* [in] general flags */
void *bitstream; /* [in] input bitstream */
int length; /* [in] length of input bitstream */
void *image; /* [in] output image */
int stride; /* [in] output image stride */
int colorspace; /* [in] output colorspace */
struct {
/* extended fields */
} ext;
}
XVID_DEC_FRAME;
typedef struct
{
int version;
int flags; /* [out] flags */
int width; /* [out] width */
int height; /* [out] height */
int time_increment; /* [out] time_ncrement */
int time_base /* [out] time_base */
struct {
/* extended fields */
} ext;
} XVID_DEC_STATS;
// 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
****************************************************************************/
/* decoder options */
#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
****************************************************************************/
/* Flags for XVID_ENC_PARAM.global */
#define XVID_GLOBAL_BFRAMES 0x00000001 /* enable bframes */
#define XVID_GLOBAL_PACKED 0x00000002 /* packed bitstream */
#define XVID_GLOBAL_DX50BVOP 0x00000004 /* dx50 bvop compatibility */
#define XVID_GLOBAL_DEBUG 0x80000000 /* generic debug flag: print debug
info on each frame */
/* Flags for XVID_ENC_FRAME.general */
#define XVID_VALID_FLAGS 0x80000000
#define XVID_CUSTOM_QMATRIX 0x00000004 /* use custom quant matrix */
#define XVID_H263QUANT 0x00000010
#define XVID_MPEGQUANT 0x00000020
#define XVID_HALFPEL 0x00000040 /* use halfpel interpolation */
#define XVID_ADAPTIVEQUANT 0x00000080
#define XVID_LUMIMASKING 0x00000100
#define XVID_LATEINTRA 0x00000200
#define XVID_INTERLACING 0x00000400 /* enable interlaced encoding */
#define XVID_TOPFIELDFIRST 0x00000800 /* set top-field-first flag */
#define XVID_ALTERNATESCAN 0x00001000 /* set alternate vertical scan flag
*/
#define XVID_HINTEDME_GET 0x00002000 /* receive mv hint data from core (1st
pass) */
#define XVID_HINTEDME_SET 0x00004000 /* send mv hint data to core (2nd
pass) */
#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 /* enable greyscale only mode (even for
*/
#define XVID_GRAYSCALE 0x01000000 /* color input material chroma is
ignored) */
/* Flags for XVID_ENC_FRAME.motion */
#define PMV_ADVANCEDDIAMOND8 0x00004000
#define PMV_ADVANCEDDIAMOND16 0x00008000
#define PMV_HALFPELDIAMOND16 0x00010000
#define PMV_HALFPELREFINE16 0x00020000
#define PMV_EXTSEARCH16 0x00040000 /* extend PMV by more searches */
#define PMV_EARLYSTOP16 0x00080000
#define PMV_QUICKSTOP16 0x00100000 /* like early, but without any more
refinement */
#define PMV_UNRESTRICTED16 0x00200000 /* unrestricted ME, not implemented
*/
#define PMV_OVERLAPPING16 0x00400000 /* overlapping ME, not implemented
*/
#define PMV_USESQUARES16 0x00800000
#define PMV_HALFPELDIAMOND8 0x01000000
#define PMV_HALFPELREFINE8 0x02000000
#define PMV_EXTSEARCH8 0x04000000 /* extend PMV by more searches */
#define PMV_EARLYSTOP8 0x08000000
#define PMV_QUICKSTOP8 0x10000000 /* like early, but without any more
refinement */
#define PMV_UNRESTRICTED8 0x20000000 /* unrestricted ME, not implemented
*/
#define PMV_OVERLAPPING8 0x40000000 /* overlapping ME, not implemented
*/
#define PMV_USESQUARES8 0x80000000
/* XVID_ENC_STATS.flags */
#define XVID_ENC_STATS_IVOP 0
#define XVID_ENC_STATS_PVOP 1
#define XVID_ENC_STATS_BVOP 2
/*****************************************************************************
* Encoder structures
****************************************************************************/
typedef struct
{
int version;
int global; /* [in:opt] global options */
int width; /* [in] width */
int height; /* [in] height */
int max_quantizer; /* [in:opt] the upper limit of the quantizer */
int min_quantizer; /* [in:opt] the lower limit of the quantizer */
int max_key_interval; /* [in:opt] the maximum interval between key frames
*/
int frame_drop_ratio; /* [in:opt] frame dropping: 0=drop none...
100=drop all */
int num_threads; /* [in:opt] number of threads */
/* --- bframes stuff --- */
int max_bframes; /* max sequential bframes (0=disable bframes) */
int bquant_ratio_a; /* [in] bframes quantizer multiplier a */
int bquant_ratio_a; /* [in] bframes quantizer multiplier b */
/* used only when bquant < 1
* bquant = AVG(past_quant + future_quant) * bquant_ratio_a +
bquant_ratio_b */
/* --- rate control --- */
int rc_bitrate; /* the bitrate of the target encoded stream, in
bits/second */
int rc_reaction_delay_factor; /* how fast the rate control reacts - lower
values are faster */
int rc_averaging_period; /* as above */
int rc_buffer; /* as above */
void *handle; /* [out] encoder instance handle */
struct {
/* extended fields */
} ext;
}
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 version;
int general; /* [in:opt] general options */
int motion; /* [in:opt] ME options */
int time_increment; /* [in] frame increment */
int time_base; /* [in] frame base. each frame = "fincr/fbase" seconds
*/
void *image; /* [in] image ptr */
int stride /* [in] input image stride */
int colorspace; /* [in] source colorspace */
void *bitstream; /* [in] bitstream ptr */
int length; /* [out] bitstream length (bytes) */
int quant; /* [in] frame quantizer (vbr) */
int intra; /* [in] force intra frame (vbr only) */
int bquant; /* [in] bframe quantizer */
unsigned char *quant_intra_matrix; /* [in:opt] custom intra qmatrix */
unsigned char *quant_inter_matrix; /* [in:opt] custom inter qmatrix */
HINTINFO hint; /* [in/out] mv hint information */
struct {
/* extended fields */
} ext;
}
XVID_ENC_FRAME;
typedef struct
{
int version;
int type; /* [out] frame vop type */
int quant; /* [out] frame quantizer */
int length; /* [out] frame length (bytes) */
int hlength; /* [out] header length (bytes) ?? */
int kblks, mblks, ublks; /* [out] key,motion,uncoded macroblocks*/
struct {
/* extended fields */
} ext;
}
XVID_ENC_STATS;
/*****************************************************************************
* Encoder entry point
****************************************************************************/
/* Encoder options */
#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
------=_NextPart_000_6a6b_70c3_2c1b--