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
25 * This file contains structures and macros shared by both Indeo4 and
29 #ifndef AVCODEC_IVI_COMMON_H
30 #define AVCODEC_IVI_COMMON_H
36 #define IVI_VLC_BITS 13 ///< max number of bits of the ivi's huffman codes
37 #define IVI4_STREAM_ANALYSER 0
38 #define IVI5_IS_PROTECTED 0x20
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 * Common scan patterns (defined in ivi_common.c)
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];
79 * Declare inverse transform function types
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);
86 * run-value (RLE) table descriptor
89 uint8_t eob_sym; ///< end of block symbol
90 uint8_t esc_sym; ///< escape symbol
95 extern const RVMapDesc ff_ivi_rvmap_tabs[9];
99 * information for Indeo macroblock (16x16, 8x8 or 4x4)
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
107 int8_t q_delta; ///< quant delta
108 int8_t mv_x; ///< motion vector (x component)
109 int8_t mv_y; ///< motion vector (y component)
114 * information for Indeo tile
122 int is_empty; ///< = 1 if this tile doesn't contain any data
123 int data_size; ///< size of the data in bytes
124 int num_MBs; ///< number of macroblocks in this tile
125 IVIMbInfo *mbs; ///< array of macroblock descriptors
126 IVIMbInfo *ref_mbs; ///< ptr to the macroblock descriptors of the reference tile
131 * information for Indeo wavelet band
134 int plane; ///< plane number this band belongs to
135 int band_num; ///< band number
138 int aheight; ///< aligned band height
139 const uint8_t *data_ptr; ///< ptr to the first byte of the band data
140 int data_size; ///< size of the band data
141 int16_t *buf; ///< pointer to the output buffer for this band
142 int16_t *ref_buf; ///< pointer to the reference frame buffer (for motion compensation)
143 int16_t *bufs[3]; ///< array of pointers to the band buffers
144 int pitch; ///< pitch associated with the buffers above
145 int is_empty; ///< = 1 if this band doesn't contain any data
146 int mb_size; ///< macroblock size
147 int blk_size; ///< block size
148 int is_halfpel; ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
149 int inherit_mv; ///< tells if motion vector is inherited from reference macroblock
150 int inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
151 int qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
152 int quant_mat; ///< dequant matrix index
153 int glob_quant; ///< quant base for this band
154 const uint8_t *scan; ///< ptr to the scan pattern
156 IVIHuffTab blk_vlc; ///< vlc table for decoding block data
158 int num_corr; ///< number of correction entries
159 uint8_t corr[61*2]; ///< rvmap correction pairs
160 int rvmap_sel; ///< rvmap table selector
161 RVMapDesc *rv_map; ///< ptr to the RLE table for this band
162 int num_tiles; ///< number of tiles in this band
163 IVITile *tiles; ///< array of tile descriptors
164 InvTransformPtr *inv_transform;
165 DCTransformPtr *dc_transform;
166 int is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform is used
167 int transform_size; ///< block size of the transform
168 int32_t checksum; ///< for debug purposes
169 int checksum_present;
170 int bufsize; ///< band buffer size in bytes
171 const uint16_t *intra_base; ///< quantization matrix for intra blocks
172 const uint16_t *inter_base; ///< quantization matrix for inter blocks
173 const uint8_t *intra_scale; ///< quantization coefficient for intra blocks
174 const uint8_t *inter_scale; ///< quantization coefficient for inter blocks
179 * color plane (luma or chroma) information
184 uint8_t num_bands; ///< number of bands this plane subdivided into
185 IVIBandDesc *bands; ///< array of band descriptors
192 uint16_t chroma_width;
193 uint16_t chroma_height;
195 uint16_t tile_height;
197 uint8_t chroma_bands;
200 typedef struct IVI45DecContext {
203 RVMapDesc rvmap_tabs[9]; ///< local corrected copy of the static rvmap tables
207 int prev_frame_type; ///< frame type of the previous frame
208 uint32_t data_size; ///< size of the frame data in bytes from picture header
210 int transp_status; ///< transparency mode status: 1 - enabled
211 const uint8_t *frame_data; ///< input frame data pointer
212 int inter_scal; ///< signals a sequence of scalable inter frames
213 uint32_t frame_size; ///< frame size in bytes
214 uint32_t pic_hdr_size; ///< picture header size in bytes
216 uint16_t checksum; ///< frame checksum
218 IVIPicConfig pic_conf;
219 IVIPlaneDesc planes[3]; ///< color planes
221 int buf_switch; ///< used to switch between three buffers
222 int dst_buf; ///< buffer index for the currently decoded frame
223 int ref_buf; ///< inter frame reference buffer index
224 int ref2_buf; ///< temporal storage for switching buffers
226 IVIHuffTab mb_vlc; ///< current macroblock table descriptor
227 IVIHuffTab blk_vlc; ///< current block table descriptor
231 uint8_t in_q; ///< flag for explicitly stored quantiser delta
232 uint8_t pic_glob_quant;
235 uint16_t gop_hdr_size;
239 #if IVI4_STREAM_ANALYSER
240 uint8_t has_b_frames;
244 uint8_t uses_fullpel;
247 int (*decode_pic_hdr) (struct IVI45DecContext *ctx, AVCodecContext *avctx);
248 int (*decode_band_hdr) (struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx);
249 int (*decode_mb_info) (struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx);
250 void (*switch_buffers) (struct IVI45DecContext *ctx);
251 int (*is_nonnull_frame)(struct IVI45DecContext *ctx);
257 /** compare some properties of two pictures */
258 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
260 return str1->pic_width != str2->pic_width || str1->pic_height != str2->pic_height ||
261 str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
262 str1->tile_width != str2->tile_width || str1->tile_height != str2->tile_height ||
263 str1->luma_bands != str2->luma_bands || str1->chroma_bands != str2->chroma_bands;
266 /** calculate number of tiles in a stride */
267 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
269 /** calculate number of macroblocks in a tile */
270 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
271 ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
273 /** convert unsigned values into signed ones (the sign is in the LSB) */
274 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
276 /** scale motion vector */
277 static inline int ivi_scale_mv(int mv, int mv_scale)
279 return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
283 * Generate a huffman codebook from the given descriptor
284 * and convert it into the FFmpeg VLC table.
286 * @param[in] cb pointer to codebook descriptor
287 * @param[out] vlc where to place the generated VLC table
288 * @param[in] flag flag: 1 - for static or 0 for dynamic tables
289 * @return result code: 0 - OK, -1 = error (invalid codebook descriptor)
291 int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
294 * Initialize static codes used for macroblock and block decoding.
296 void ff_ivi_init_static_vlc(void);
299 * Decode a huffman codebook descriptor from the bitstream
300 * and select specified huffman table.
302 * @param[in,out] gb the GetBit context
303 * @param[in] desc_coded flag signalling if table descriptor was coded
304 * @param[in] which_tab codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
305 * @param[out] huff_tab pointer to the descriptor of the selected table
306 * @param[in] avctx AVCodecContext pointer
307 * @return zero on success, negative value otherwise
309 int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
310 IVIHuffTab *huff_tab, AVCodecContext *avctx);
313 * Compare two huffman codebook descriptors.
315 * @param[in] desc1 ptr to the 1st descriptor to compare
316 * @param[in] desc2 ptr to the 2nd descriptor to compare
317 * @return comparison result: 0 - equal, 1 - not equal
319 int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
322 * Copy huffman codebook descriptors.
324 * @param[out] dst ptr to the destination descriptor
325 * @param[in] src ptr to the source descriptor
327 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
330 * Initialize planes (prepares descriptors, allocates buffers etc).
332 * @param[in,out] planes pointer to the array of the plane descriptors
333 * @param[in] cfg pointer to the ivi_pic_config structure describing picture layout
334 * @return result code: 0 - OK
336 int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
339 * Free planes, bands and macroblocks buffers.
341 * @param[in] planes pointer to the array of the plane descriptors
343 void ff_ivi_free_buffers(IVIPlaneDesc *planes);
346 * Initialize tile and macroblock descriptors.
348 * @param[in,out] planes pointer to the array of the plane descriptors
349 * @param[in] tile_width tile width
350 * @param[in] tile_height tile height
351 * @return result code: 0 - OK
353 int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
356 * Decode size of the tile data.
357 * The size is stored as a variable-length field having the following format:
358 * if (tile_data_size < 255) than this field is only one byte long
359 * if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
360 * where X1-X3 is size of the tile data
362 * @param[in,out] gb the GetBit context
363 * @return size of the tile data in bytes
365 int ff_ivi_dec_tile_data_size(GetBitContext *gb);
369 * extract huffman-coded transform coefficients from the bitstream,
370 * dequantize them, apply inverse transform and motion compensation
371 * in order to reconstruct the picture.
373 * @param[in,out] gb the GetBit context
374 * @param[in] band pointer to the band descriptor
375 * @param[in] tile pointer to the tile descriptor
376 * @return result code: 0 - OK, -1 = error (corrupted blocks data)
378 int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
381 * Convert and output the current plane.
382 * This conversion is done by adding back the bias value of 128
383 * (subtracted in the encoder) and clipping the result.
385 * @param[in] plane pointer to the descriptor of the plane being processed
386 * @param[out] dst pointer to the buffer receiving converted pixels
387 * @param[in] dst_pitch pitch for moving to the next y line
389 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
391 int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
393 av_cold int ff_ivi_decode_close(AVCodecContext *avctx);
395 #endif /* AVCODEC_IVI_COMMON_H */