2 * common functions for Indeo Video Interactive codecs (Indeo4 and Indeo5)
4 * Copyright (c) 2009 Maxim Poliakovski
6 * This file is part of FFmpeg.
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.
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.
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
24 * @file libavcodec/ivi_common.h
25 * This file contains structures and macros shared by both Indeo4 and
29 #ifndef AVCODEC_IVI_COMMON_H
30 #define AVCODEC_IVI_COMMON_H
38 #define IVI_VLC_BITS 13 ///< max number of bits of the ivi's huffman codes
41 * huffman codebook descriptor
49 * macroblock/block huffman table descriptor
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
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
62 IVI_MB_HUFF = 0, /// Huffman table is used for coding macroblocks
63 IVI_BLK_HUFF = 1 /// Huffman table is used for coding blocks
66 extern VLC ff_ivi_mb_vlc_tabs [8]; ///< static macroblock Huffman tables
67 extern VLC ff_ivi_blk_vlc_tabs[8]; ///< static block Huffman tables
71 * run-value (RLE) table descriptor
74 uint8_t eob_sym; ///< end of block symbol
75 uint8_t esc_sym; ///< escape symbol
80 extern const RVMapDesc ff_ivi_rvmap_tabs[9];
84 * information for Indeo macroblock (16x16, 8x8 or 4x4)
89 uint32_t buf_offs; ///< address in the output buffer for this mb
90 uint8_t type; ///< macroblock type: 0 - INTRA, 1 - INTER
91 uint8_t cbp; ///< coded block pattern
92 uint8_t q_delta; ///< quant delta
93 int8_t mv_x; ///< motion vector (x component)
94 int8_t mv_y; ///< motion vector (y component)
99 * information for Indeo tile
106 int is_empty; ///< = 1 if this tile doesn't contain any data
107 int data_size; ///< size of the data in bytes
108 int num_MBs; ///< number of macroblocks in this tile
109 IVIMbInfo *mbs; ///< array of macroblock descriptors
110 IVIMbInfo *ref_mbs; ///< ptr to the macroblock descriptors of the reference tile
115 * information for Indeo wavelet band
118 int plane; ///< plane number this band belongs to
119 int band_num; ///< band number
122 const uint8_t *data_ptr; ///< ptr to the first byte of the band data
123 int data_size; ///< size of the band data
124 int16_t *buf; ///< pointer to the output buffer for this band
125 int16_t *ref_buf; ///< pointer to the reference frame buffer (for motion compensation)
126 int16_t *bufs[3]; ///< array of pointers to the band buffers
127 int pitch; ///< pitch associated with the buffers above
128 int is_empty; ///< = 1 if this band doesn't contain any data
129 int mb_size; ///< macroblock size
130 int blk_size; ///< block size
131 int is_halfpel; ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
132 int inherit_mv; ///< tells if motion vector is inherited from reference macroblock
133 int inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
134 int qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
135 int quant_mat; ///< dequant matrix index
136 int glob_quant; ///< quant base for this band
137 const uint8_t *scan; ///< ptr to the scan pattern
139 IVIHuffTab blk_vlc; ///< vlc table for decoding block data
141 uint16_t *dequant_intra; ///< ptr to dequant tables for intra blocks
142 uint16_t *dequant_inter; ///< ptr dequant tables for inter blocks
143 int num_corr; ///< number of correction entries
144 uint8_t corr[61*2]; ///< rvmap correction pairs
145 int rvmap_sel; ///< rvmap table selector
146 RVMapDesc *rv_map; ///< ptr to the RLE table for this band
147 int num_tiles; ///< number of tiles in this band
148 IVITile *tiles; ///< array of tile descriptors
149 void (*inv_transform)(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags); ///< inverse transform function pointer
150 void (*dc_transform) (const int32_t *in, int16_t *out, uint32_t pitch, int blk_size); ///< dc transform function pointer, it may be NULL
151 int is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform is used
152 int32_t checksum; ///< for debug purposes
153 int checksum_present;
154 int bufsize; ///< band buffer size in bytes
155 const uint8_t *intra_base; ///< quantization matrix for intra blocks
156 const uint8_t *inter_base; ///< quantization matrix for inter blocks
157 const uint8_t *intra_scale; ///< quantization coefficient for intra blocks
158 const uint8_t *inter_scale; ///< quantization coefficient for inter blocks
163 * color plane (luma or chroma) information
168 uint8_t num_bands; ///< number of bands this plane subdivided into
169 IVIBandDesc *bands; ///< array of band descriptors
176 uint16_t chroma_width;
177 uint16_t chroma_height;
179 uint16_t tile_height;
181 uint8_t chroma_bands;
184 /** compares some properties of two pictures */
185 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
187 return (str1->pic_width != str2->pic_width || str1->pic_height != str2->pic_height ||
188 str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
189 str1->tile_width != str2->tile_width || str1->tile_height != str2->tile_height ||
190 str1->luma_bands != str2->luma_bands || str1->chroma_bands != str2->chroma_bands);
193 /** calculate number of tiles in a stride */
194 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
196 /** calculate number of macroblocks in a tile */
197 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
198 ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
200 /** convert unsigned values into signed ones (the sign is in the LSB) */
201 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
203 /** scales motion vector */
204 static inline int ivi_scale_mv(int mv, int mv_scale)
206 return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
210 * Generates a huffman codebook from the given descriptor
211 * and converts it into the FFmpeg VLC table.
213 * @param cb [in] pointer to codebook descriptor
214 * @param vlc [out] where to place the generated VLC table
215 * @param flag [in] flag: 1 - for static or 0 for dynamic tables
216 * @return result code: 0 - OK, -1 = error (invalid codebook descriptor)
218 int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
221 * Initializes static codes used for macroblock and block decoding.
223 void ff_ivi_init_static_vlc(void);
226 * Decodes a huffman codebook descriptor from the bitstream
227 * and selects specified huffman table.
229 * @param gb [in,out] the GetBit context
230 * @param desc_coded [in] flag signalling if table descriptor was coded
231 * @param which_tab [in] codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
232 * @param huff_tab [out] pointer to the descriptor of the selected table
233 * @param avctx [in] AVCodecContext pointer
234 * @return zero on success, negative value otherwise
236 int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
237 IVIHuffTab *huff_tab, AVCodecContext *avctx);
240 * Compares two huffman codebook descriptors.
242 * @param desc1 [in] ptr to the 1st descriptor to compare
243 * @param desc2 [in] ptr to the 2nd descriptor to compare
244 * @return comparison result: 0 - equal, 1 - not equal
246 int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
249 * Copies huffman codebook descriptors.
251 * @param dst [out] ptr to the destination descriptor
252 * @param src [in] ptr to the source descriptor
254 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
257 * Initializes planes (prepares descriptors, allocates buffers etc).
259 * @param planes [in,out] pointer to the array of the plane descriptors
260 * @param cfg [in] pointer to the ivi_pic_config structure describing picture layout
261 * @return result code: 0 - OK
263 int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
266 * Frees planes, bands and macroblocks buffers.
268 * @param planes [in] pointer to the array of the plane descriptors
270 void ff_ivi_free_buffers(IVIPlaneDesc *planes);
273 * Initializes tile and macroblock descriptors.
275 * @param planes [in,out] pointer to the array of the plane descriptors
276 * @param tile_width [in] tile width
277 * @param tile_height [in] tile height
278 * @return result code: 0 - OK
280 int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
283 * Decodes size of the tile data.
284 * The size is stored as a variable-length field having the following format:
285 * if (tile_data_size < 255) than this field is only one byte long
286 * if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
287 * where X1-X3 is size of the tile data
289 * @param gb [in,out] the GetBit context
290 * @return size of the tile data in bytes
292 int ff_ivi_dec_tile_data_size(GetBitContext *gb);
295 * Decodes block data:
296 * extracts huffman-coded transform coefficients from the bitstream,
297 * dequantizes them, applies inverse transform and motion compensation
298 * in order to reconstruct the picture.
300 * @param gb [in,out] the GetBit context
301 * @param band [in] pointer to the band descriptor
302 * @param tile [in] pointer to the tile descriptor
303 * @return result code: 0 - OK, -1 = error (corrupted blocks data)
305 int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
308 * Handles empty tiles by performing data copying and motion
309 * compensation respectively.
311 * @param avctx [in] ptr to the AVCodecContext
312 * @param band [in] pointer to the band descriptor
313 * @param tile [in] pointer to the tile descriptor
314 * @param mv_scale [in] scaling factor for motion vectors
316 void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
317 IVITile *tile, int32_t mv_scale);
320 * Converts and outputs the current plane.
321 * This conversion is done by adding back the bias value of 128
322 * (subtracted in the encoder) and clipping the result.
324 * @param plane [in] pointer to the descriptor of the plane being processed
325 * @param dst [out] pointer to the buffer receiving converted pixels
326 * @param dst_pitch [in] pitch for moving to the next y line
328 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
332 * Calculates band checksum from band data.
334 uint16_t ivi_calc_band_checksum (IVIBandDesc *band);
337 * Verifies that band data lies in range.
339 int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch);
342 #endif /* AVCODEC_IVI_COMMON_H */