[libav.git] / libavcodec / ivi_common.h

/*
 * common functions for Indeo Video Interactive codecs (Indeo4 and Indeo5)
 *
 * Copyright (c) 2009 Maxim Poliakovski
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * @file
 * This file contains structures and macros shared by both Indeo4 and
 * Indeo5 decoders.
 */

#ifndef AVCODEC_IVI_COMMON_H
#define AVCODEC_IVI_COMMON_H

#include "avcodec.h"
#include "get_bits.h"
#include <stdint.h>

#define IVI_DEBUG 0

#define IVI_VLC_BITS 13 ///< max number of bits of the ivi's huffman codes

/**
 *  huffman codebook descriptor
 */
typedef struct {
    int32_t     num_rows;
    uint8_t     xbits[16];
} IVIHuffDesc;

/**
 *  macroblock/block huffman table descriptor
 */
typedef struct {
    int32_t     tab_sel;    /// index of one of the predefined tables
                            /// or "7" for custom one
    VLC         *tab;       /// pointer to the table associated with tab_sel

    //! the following are used only when tab_sel == 7
    IVIHuffDesc cust_desc;  /// custom Huffman codebook descriptor
    VLC         cust_tab;   /// vlc table for custom codebook
} IVIHuffTab;

enum {
    IVI_MB_HUFF   = 0,      /// Huffman table is used for coding macroblocks
    IVI_BLK_HUFF  = 1       /// Huffman table is used for coding blocks
};

extern VLC ff_ivi_mb_vlc_tabs [8]; ///< static macroblock Huffman tables
extern VLC ff_ivi_blk_vlc_tabs[8]; ///< static block Huffman tables


/**
 *  Common scan patterns (defined in ivi_common.c)
 */
extern const uint8_t ff_ivi_vertical_scan_8x8[64];
extern const uint8_t ff_ivi_horizontal_scan_8x8[64];
extern const uint8_t ff_ivi_direct_scan_4x4[16];


/**
 *  Declare inverse transform function types
 */
typedef void (InvTransformPtr)(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags);
typedef void (DCTransformPtr) (const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);


/**
 *  run-value (RLE) table descriptor
 */
typedef struct {
    uint8_t     eob_sym; ///< end of block symbol
    uint8_t     esc_sym; ///< escape symbol
    uint8_t     runtab[256];
    int8_t      valtab[256];
} RVMapDesc;

extern const RVMapDesc ff_ivi_rvmap_tabs[9];


/**
 *  information for Indeo macroblock (16x16, 8x8 or 4x4)
 */
typedef struct {
    int16_t     xpos;
    int16_t     ypos;
    uint32_t    buf_offs; ///< address in the output buffer for this mb
    uint8_t     type;     ///< macroblock type: 0 - INTRA, 1 - INTER
    uint8_t     cbp;      ///< coded block pattern
    int8_t      q_delta;  ///< quant delta
    int8_t      mv_x;     ///< motion vector (x component)
    int8_t      mv_y;     ///< motion vector (y component)
} IVIMbInfo;


/**
 *  information for Indeo tile
 */
typedef struct {
    int         xpos;
    int         ypos;
    int         width;
    int         height;
    int         is_empty;  ///< = 1 if this tile doesn't contain any data
    int         data_size; ///< size of the data in bytes
    int         num_MBs;   ///< number of macroblocks in this tile
    IVIMbInfo   *mbs;      ///< array of macroblock descriptors
    IVIMbInfo   *ref_mbs;  ///< ptr to the macroblock descriptors of the reference tile
} IVITile;


/**
 *  information for Indeo wavelet band
 */
typedef struct {
    int             plane;          ///< plane number this band belongs to
    int             band_num;       ///< band number
    int             width;
    int             height;
    const uint8_t   *data_ptr;      ///< ptr to the first byte of the band data
    int             data_size;      ///< size of the band data
    int16_t         *buf;           ///< pointer to the output buffer for this band
    int16_t         *ref_buf;       ///< pointer to the reference frame buffer (for motion compensation)
    int16_t         *bufs[3];       ///< array of pointers to the band buffers
    int             pitch;          ///< pitch associated with the buffers above
    int             is_empty;       ///< = 1 if this band doesn't contain any data
    int             mb_size;        ///< macroblock size
    int             blk_size;       ///< block size
    int             is_halfpel;     ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
    int             inherit_mv;     ///< tells if motion vector is inherited from reference macroblock
    int             inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
    int             qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
    int             quant_mat;      ///< dequant matrix index
    int             glob_quant;     ///< quant base for this band
    const uint8_t   *scan;          ///< ptr to the scan pattern

    IVIHuffTab      blk_vlc;        ///< vlc table for decoding block data

    int             num_corr;       ///< number of correction entries
    uint8_t         corr[61*2];     ///< rvmap correction pairs
    int             rvmap_sel;      ///< rvmap table selector
    RVMapDesc       *rv_map;        ///< ptr to the RLE table for this band
    int             num_tiles;      ///< number of tiles in this band
    IVITile         *tiles;         ///< array of tile descriptors
    InvTransformPtr *inv_transform;
    DCTransformPtr  *dc_transform;
    int             is_2d_trans;    ///< 1 indicates that the two-dimensional inverse transform is used
    int32_t         checksum;       ///< for debug purposes
    int             checksum_present;
    int             bufsize;        ///< band buffer size in bytes
    const uint16_t  *intra_base;    ///< quantization matrix for intra blocks
    const uint16_t  *inter_base;    ///< quantization matrix for inter blocks
    const uint8_t   *intra_scale;   ///< quantization coefficient for intra blocks
    const uint8_t   *inter_scale;   ///< quantization coefficient for inter blocks
} IVIBandDesc;


/**
 *  color plane (luma or chroma) information
 */
typedef struct {
    uint16_t    width;
    uint16_t    height;
    uint8_t     num_bands;  ///< number of bands this plane subdivided into
    IVIBandDesc *bands;     ///< array of band descriptors
} IVIPlaneDesc;


typedef struct {
    uint16_t    pic_width;
    uint16_t    pic_height;
    uint16_t    chroma_width;
    uint16_t    chroma_height;
    uint16_t    tile_width;
    uint16_t    tile_height;
    uint8_t     luma_bands;
    uint8_t     chroma_bands;
} IVIPicConfig;

/** compares some properties of two pictures */
static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
{
    return (str1->pic_width    != str2->pic_width    || str1->pic_height    != str2->pic_height    ||
            str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
            str1->tile_width   != str2->tile_width   || str1->tile_height   != str2->tile_height   ||
            str1->luma_bands   != str2->luma_bands   || str1->chroma_bands  != str2->chroma_bands);
}

/** calculate number of tiles in a stride */
#define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))

/** calculate number of macroblocks in a tile */
#define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
    ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))

/** convert unsigned values into signed ones (the sign is in the LSB) */
#define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))

/** scales motion vector */
static inline int ivi_scale_mv(int mv, int mv_scale)
{
    return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
}

/**
 *  Generates a huffman codebook from the given descriptor
 *  and converts it into the FFmpeg VLC table.
 *
 *  @param cb   [in]  pointer to codebook descriptor
 *  @param vlc  [out] where to place the generated VLC table
 *  @param flag [in]  flag: 1 - for static or 0 for dynamic tables
 *  @return     result code: 0 - OK, -1 = error (invalid codebook descriptor)
 */
int  ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);

/**
 * Initializes static codes used for macroblock and block decoding.
 */
void ff_ivi_init_static_vlc(void);

/**
 *  Decodes a huffman codebook descriptor from the bitstream
 *  and selects specified huffman table.
 *
 *  @param gb           [in,out] the GetBit context
 *  @param desc_coded   [in] flag signalling if table descriptor was coded
 *  @param which_tab    [in] codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
 *  @param huff_tab     [out] pointer to the descriptor of the selected table
 *  @param avctx        [in] AVCodecContext pointer
 *  @return             zero on success, negative value otherwise
 */
int  ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
                          IVIHuffTab *huff_tab, AVCodecContext *avctx);

/**
 *  Compares two huffman codebook descriptors.
 *
 *  @param desc1    [in] ptr to the 1st descriptor to compare
 *  @param desc2    [in] ptr to the 2nd descriptor to compare
 *  @return         comparison result: 0 - equal, 1 - not equal
 */
int  ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);

/**
 *  Copies huffman codebook descriptors.
 *
 *  @param dst  [out] ptr to the destination descriptor
 *  @param src  [in]  ptr to the source descriptor
 */
void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);

/**
 *  Initializes planes (prepares descriptors, allocates buffers etc).
 *
 *  @param planes       [in,out] pointer to the array of the plane descriptors
 *  @param cfg          [in] pointer to the ivi_pic_config structure describing picture layout
 *  @return             result code: 0 - OK
 */
int  ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);

/**
 *  Frees planes, bands and macroblocks buffers.
 *
 *  @param planes       [in] pointer to the array of the plane descriptors
 */
void ff_ivi_free_buffers(IVIPlaneDesc *planes);

/**
 *  Initializes tile and macroblock descriptors.
 *
 *  @param planes       [in,out] pointer to the array of the plane descriptors
 *  @param tile_width   [in]     tile width
 *  @param tile_height  [in]     tile height
 *  @return             result code: 0 - OK
 */
int  ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);

/**
 *  Decodes size of the tile data.
 *  The size is stored as a variable-length field having the following format:
 *  if (tile_data_size < 255) than this field is only one byte long
 *  if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
 *  where X1-X3 is size of the tile data
 *
 *  @param gb   [in,out] the GetBit context
 *  @return     size of the tile data in bytes
 */
int  ff_ivi_dec_tile_data_size(GetBitContext *gb);

/**
 *  Decodes block data:
 *  extracts huffman-coded transform coefficients from the bitstream,
 *  dequantizes them, applies inverse transform and motion compensation
 *  in order to reconstruct the picture.
 *
 *  @param gb   [in,out] the GetBit context
 *  @param band [in]     pointer to the band descriptor
 *  @param tile [in]     pointer to the tile descriptor
 *  @return     result code: 0 - OK, -1 = error (corrupted blocks data)
 */
int  ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);

/**
 *  Handles empty tiles by performing data copying and motion
 *  compensation respectively.
 *
 *  @param avctx    [in] ptr to the AVCodecContext
 *  @param band     [in] pointer to the band descriptor
 *  @param tile     [in] pointer to the tile descriptor
 *  @param mv_scale [in] scaling factor for motion vectors
 */
void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
                               IVITile *tile, int32_t mv_scale);

/**
 *  Converts and outputs the current plane.
 *  This conversion is done by adding back the bias value of 128
 *  (subtracted in the encoder) and clipping the result.
 *
 *  @param plane        [in]  pointer to the descriptor of the plane being processed
 *  @param dst          [out] pointer to the buffer receiving converted pixels
 *  @param dst_pitch    [in]  pitch for moving to the next y line
 */
void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);

#if IVI_DEBUG
/**
 *  Calculates band checksum from band data.
 */
uint16_t ivi_calc_band_checksum (IVIBandDesc *band);

/**
 *  Verifies that band data lies in range.
 */
int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch);
#endif

#endif /* AVCODEC_IVI_COMMON_H */
Commit	Line	Data
1cf31685 KS	1	/*
	2	* common functions for Indeo Video Interactive codecs (Indeo4 and Indeo5)
	3	*
	4	* Copyright (c) 2009 Maxim Poliakovski
	5	*
	6	* This file is part of FFmpeg.
	7	*
	8	* FFmpeg is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU Lesser General Public
	10	* License as published by the Free Software Foundation; either
	11	* version 2.1 of the License, or (at your option) any later version.
	12	*
	13	* FFmpeg is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* Lesser General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU Lesser General Public
	19	* License along with FFmpeg; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	21	*/
	22
	23	/**
ba87f080	24	* @file
1cf31685 KS	25	* This file contains structures and macros shared by both Indeo4 and
	26	* Indeo5 decoders.
	27	*/
	28
	29	#ifndef AVCODEC_IVI_COMMON_H
	30	#define AVCODEC_IVI_COMMON_H
	31
	32	#include "avcodec.h"
	33	#include "get_bits.h"
	34	#include <stdint.h>
	35
	36	#define IVI_DEBUG 0
	37
	38	#define IVI_VLC_BITS 13 ///< max number of bits of the ivi's huffman codes
	39
	40	/**
	41	* huffman codebook descriptor
	42	*/
	43	typedef struct {
	44	int32_t num_rows;
	45	uint8_t xbits[16];
	46	} IVIHuffDesc;
	47
e322aace KS	48	/**
	49	* macroblock/block huffman table descriptor
	50	*/
	51	typedef struct {
	52	int32_t tab_sel; /// index of one of the predefined tables
	53	/// or "7" for custom one
	54	VLC *tab; /// pointer to the table associated with tab_sel
	55
	56	//! the following are used only when tab_sel == 7
	57	IVIHuffDesc cust_desc; /// custom Huffman codebook descriptor
	58	VLC cust_tab; /// vlc table for custom codebook
	59	} IVIHuffTab;
	60
	61	enum {
	62	IVI_MB_HUFF = 0, /// Huffman table is used for coding macroblocks
	63	IVI_BLK_HUFF = 1 /// Huffman table is used for coding blocks
	64	};
	65
9068f36d KS	66	extern VLC ff_ivi_mb_vlc_tabs [8]; ///< static macroblock Huffman tables
9068f36d KS	67	extern VLC ff_ivi_blk_vlc_tabs[8]; ///< static block Huffman tables
1cf31685 KS	68
	69
	70	/**
220f2bd9 MP	71	* Common scan patterns (defined in ivi_common.c)
220f2bd9 MP	72	*/
9c6b3b97 MP	73	extern const uint8_t ff_ivi_vertical_scan_8x8[64];
	74	extern const uint8_t ff_ivi_horizontal_scan_8x8[64];
	75	extern const uint8_t ff_ivi_direct_scan_4x4[16];
220f2bd9 MP	76
	77
	78	/**
c404e783 MP	79	* Declare inverse transform function types
	80	*/
	81	typedef void (InvTransformPtr)(const int32_t in, int16_t out, uint32_t pitch, const uint8_t *flags);
	82	typedef void (DCTransformPtr) (const int32_t in, int16_t out, uint32_t pitch, int blk_size);
	83
	84
	85	/**
1cf31685 KS	86	* run-value (RLE) table descriptor
	87	*/
	88	typedef struct {
	89	uint8_t eob_sym; ///< end of block symbol
	90	uint8_t esc_sym; ///< escape symbol
	91	uint8_t runtab[256];
	92	int8_t valtab[256];
	93	} RVMapDesc;
	94
	95	extern const RVMapDesc ff_ivi_rvmap_tabs[9];
	96
	97
	98	/**
	99	* information for Indeo macroblock (16x16, 8x8 or 4x4)
	100	*/
	101	typedef struct {
	102	int16_t xpos;
	103	int16_t ypos;
	104	uint32_t buf_offs; ///< address in the output buffer for this mb
	105	uint8_t type; ///< macroblock type: 0 - INTRA, 1 - INTER
	106	uint8_t cbp; ///< coded block pattern
15f9fa3d	107	int8_t q_delta; ///< quant delta
1cf31685 KS	108	int8_t mv_x; ///< motion vector (x component)
	109	int8_t mv_y; ///< motion vector (y component)
	110	} IVIMbInfo;
	111
	112
	113	/**
	114	* information for Indeo tile
	115	*/
	116	typedef struct {
	117	int xpos;
	118	int ypos;
	119	int width;
	120	int height;
	121	int is_empty; ///< = 1 if this tile doesn't contain any data
	122	int data_size; ///< size of the data in bytes
	123	int num_MBs; ///< number of macroblocks in this tile
	124	IVIMbInfo *mbs; ///< array of macroblock descriptors
	125	IVIMbInfo *ref_mbs; ///< ptr to the macroblock descriptors of the reference tile
	126	} IVITile;
	127
	128
	129	/**
	130	* information for Indeo wavelet band
	131	*/
	132	typedef struct {
	133	int plane; ///< plane number this band belongs to
	134	int band_num; ///< band number
	135	int width;
	136	int height;
	137	const uint8_t *data_ptr; ///< ptr to the first byte of the band data
	138	int data_size; ///< size of the band data
	139	int16_t *buf; ///< pointer to the output buffer for this band
	140	int16_t *ref_buf; ///< pointer to the reference frame buffer (for motion compensation)
	141	int16_t *bufs[3]; ///< array of pointers to the band buffers
	142	int pitch; ///< pitch associated with the buffers above
	143	int is_empty; ///< = 1 if this band doesn't contain any data
	144	int mb_size; ///< macroblock size
	145	int blk_size; ///< block size
	146	int is_halfpel; ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
	147	int inherit_mv; ///< tells if motion vector is inherited from reference macroblock
	148	int inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
	149	int qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
	150	int quant_mat; ///< dequant matrix index
	151	int glob_quant; ///< quant base for this band
	152	const uint8_t *scan; ///< ptr to the scan pattern
	153
e322aace	154	IVIHuffTab blk_vlc; ///< vlc table for decoding block data
1cf31685	155
1cf31685 KS	156	int num_corr; ///< number of correction entries
	157	uint8_t corr[61*2]; ///< rvmap correction pairs
	158	int rvmap_sel; ///< rvmap table selector
	159	RVMapDesc *rv_map; ///< ptr to the RLE table for this band
	160	int num_tiles; ///< number of tiles in this band
	161	IVITile *tiles; ///< array of tile descriptors
c404e783 MP	162	InvTransformPtr *inv_transform;
c404e783 MP	163	DCTransformPtr *dc_transform;
1cf31685 KS	164	int is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform is used
	165	int32_t checksum; ///< for debug purposes
	166	int checksum_present;
	167	int bufsize; ///< band buffer size in bytes
0933f558 MP	168	const uint16_t *intra_base; ///< quantization matrix for intra blocks
0933f558 MP	169	const uint16_t *inter_base; ///< quantization matrix for inter blocks
1cf31685 KS	170	const uint8_t *intra_scale; ///< quantization coefficient for intra blocks
	171	const uint8_t *inter_scale; ///< quantization coefficient for inter blocks
	172	} IVIBandDesc;
	173
	174
	175	/**
	176	* color plane (luma or chroma) information
	177	*/
	178	typedef struct {
	179	uint16_t width;
	180	uint16_t height;
	181	uint8_t num_bands; ///< number of bands this plane subdivided into
	182	IVIBandDesc *bands; ///< array of band descriptors
	183	} IVIPlaneDesc;
	184
	185
	186	typedef struct {
	187	uint16_t pic_width;
	188	uint16_t pic_height;
	189	uint16_t chroma_width;
	190	uint16_t chroma_height;
	191	uint16_t tile_width;
	192	uint16_t tile_height;
	193	uint8_t luma_bands;
	194	uint8_t chroma_bands;
	195	} IVIPicConfig;
	196
	197	/** compares some properties of two pictures */
	198	static inline int ivi_pic_config_cmp(IVIPicConfig str1, IVIPicConfig str2)
	199	{
	200	return (str1->pic_width != str2->pic_width \|\| str1->pic_height != str2->pic_height \|\|
	201	str1->chroma_width != str2->chroma_width \|\| str1->chroma_height != str2->chroma_height \|\|
	202	str1->tile_width != str2->tile_width \|\| str1->tile_height != str2->tile_height \|\|
	203	str1->luma_bands != str2->luma_bands \|\| str1->chroma_bands != str2->chroma_bands);
	204	}
	205
	206	/** calculate number of tiles in a stride */
	207	#define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
	208
	209	/** calculate number of macroblocks in a tile */
	210	#define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
	211	((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
	212
	213	/** convert unsigned values into signed ones (the sign is in the LSB) */
1cf31685 KS	214	#define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
	215
	216	/** scales motion vector */
	217	static inline int ivi_scale_mv(int mv, int mv_scale)
	218	{
	219	return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
	220	}
	221
	222	/**
	223	* Generates a huffman codebook from the given descriptor
	224	* and converts it into the FFmpeg VLC table.
	225	*
	226	* @param cb [in] pointer to codebook descriptor
	227	* @param vlc [out] where to place the generated VLC table
	228	* @param flag [in] flag: 1 - for static or 0 for dynamic tables
	229	* @return result code: 0 - OK, -1 = error (invalid codebook descriptor)
	230	*/
	231	int ff_ivi_create_huff_from_desc(const IVIHuffDesc cb, VLC vlc, int flag);
	232
	233	/**
9068f36d KS	234	* Initializes static codes used for macroblock and block decoding.
9068f36d KS	235	*/
4982a77e	236	void ff_ivi_init_static_vlc(void);
9068f36d KS	237
9068f36d KS	238	/**
e322aace KS	239	* Decodes a huffman codebook descriptor from the bitstream
e322aace KS	240	* and selects specified huffman table.
1cf31685	241	*
e322aace KS	242	* @param gb [in,out] the GetBit context
	243	* @param desc_coded [in] flag signalling if table descriptor was coded
	244	* @param which_tab [in] codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
	245	* @param huff_tab [out] pointer to the descriptor of the selected table
	246	* @param avctx [in] AVCodecContext pointer
	247	* @return zero on success, negative value otherwise
1cf31685	248	*/
e322aace KS	249	int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
e322aace KS	250	IVIHuffTab huff_tab, AVCodecContext avctx);
1cf31685 KS	251
	252	/**
	253	* Compares two huffman codebook descriptors.
	254	*
	255	* @param desc1 [in] ptr to the 1st descriptor to compare
	256	* @param desc2 [in] ptr to the 2nd descriptor to compare
	257	* @return comparison result: 0 - equal, 1 - not equal
	258	*/
	259	int ff_ivi_huff_desc_cmp(const IVIHuffDesc desc1, const IVIHuffDesc desc2);
	260
	261	/**
	262	* Copies huffman codebook descriptors.
	263	*
	264	* @param dst [out] ptr to the destination descriptor
	265	* @param src [in] ptr to the source descriptor
	266	*/
	267	void ff_ivi_huff_desc_copy(IVIHuffDesc dst, const IVIHuffDesc src);
	268
	269	/**
	270	* Initializes planes (prepares descriptors, allocates buffers etc).
	271	*
	272	* @param planes [in,out] pointer to the array of the plane descriptors
	273	* @param cfg [in] pointer to the ivi_pic_config structure describing picture layout
	274	* @return result code: 0 - OK
	275	*/
	276	int ff_ivi_init_planes(IVIPlaneDesc planes, const IVIPicConfig cfg);
	277
	278	/**
	279	* Frees planes, bands and macroblocks buffers.
	280	*
	281	* @param planes [in] pointer to the array of the plane descriptors
	282	*/
	283	void ff_ivi_free_buffers(IVIPlaneDesc *planes);
	284
	285	/**
	286	* Initializes tile and macroblock descriptors.
	287	*
	288	* @param planes [in,out] pointer to the array of the plane descriptors
	289	* @param tile_width [in] tile width
	290	* @param tile_height [in] tile height
	291	* @return result code: 0 - OK
	292	*/
	293	int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
	294
	295	/**
	296	* Decodes size of the tile data.
	297	* The size is stored as a variable-length field having the following format:
	298	* if (tile_data_size < 255) than this field is only one byte long
	299	* if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
	300	* where X1-X3 is size of the tile data
	301	*
	302	* @param gb [in,out] the GetBit context
	303	* @return size of the tile data in bytes
	304	*/
	305	int ff_ivi_dec_tile_data_size(GetBitContext *gb);
	306
	307	/**
	308	* Decodes block data:
	309	* extracts huffman-coded transform coefficients from the bitstream,
	310	* dequantizes them, applies inverse transform and motion compensation
	311	* in order to reconstruct the picture.
	312	*
	313	* @param gb [in,out] the GetBit context
	314	* @param band [in] pointer to the band descriptor
315	* @param tile [in] pointer to the tile descriptor
316	* @return result code: 0 - OK, -1 = error (corrupted blocks data)
317	*/
318	int ff_ivi_decode_blocks(GetBitContext gb, IVIBandDesc band, IVITile *tile);
319
320	/**
321	* Handles empty tiles by performing data copying and motion
322	* compensation respectively.
323	*
324	* @param avctx [in] ptr to the AVCodecContext
325	* @param band [in] pointer to the band descriptor
326	* @param tile [in] pointer to the tile descriptor
327	* @param mv_scale [in] scaling factor for motion vectors
328	*/
329	void ff_ivi_process_empty_tile(AVCodecContext avctx, IVIBandDesc band,
330	IVITile *tile, int32_t mv_scale);
331
332	/**
333	* Converts and outputs the current plane.
334	* This conversion is done by adding back the bias value of 128
335	* (subtracted in the encoder) and clipping the result.
336	*
337	* @param plane [in] pointer to the descriptor of the plane being processed
338	* @param dst [out] pointer to the buffer receiving converted pixels
339	* @param dst_pitch [in] pitch for moving to the next y line
340	*/
341	void ff_ivi_output_plane(IVIPlaneDesc plane, uint8_t dst, int dst_pitch);
342
343	#if IVI_DEBUG
344	/**
345	* Calculates band checksum from band data.
346	*/
347	uint16_t ivi_calc_band_checksum (IVIBandDesc *band);
348
349	/**
350	* Verifies that band data lies in range.
351	*/
352	int ivi_check_band (IVIBandDesc band, const uint8_t ref, int pitch);
353	#endif
354
355	#endif /* AVCODEC_IVI_COMMON_H */