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
43 typedef struct IVIHuffDesc {
49 * macroblock/block huffman table descriptor
51 typedef struct IVIHuffTab {
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
88 typedef struct RVMapDesc {
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)
101 typedef struct IVIMbInfo {
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
116 typedef struct IVITile {
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
133 typedef struct IVIBandDesc {
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
155 int scan_size; ///< size of the scantable
157 IVIHuffTab blk_vlc; ///< vlc table for decoding block data
159 int num_corr; ///< number of correction entries
160 uint8_t corr[61*2]; ///< rvmap correction pairs
161 int rvmap_sel; ///< rvmap table selector
162 RVMapDesc *rv_map; ///< ptr to the RLE table for this band
163 int num_tiles; ///< number of tiles in this band
164 IVITile *tiles; ///< array of tile descriptors
165 InvTransformPtr *inv_transform;
166 DCTransformPtr *dc_transform;
167 int is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform is used
168 int transform_size; ///< block size of the transform
169 int32_t checksum; ///< for debug purposes
170 int checksum_present;
171 int bufsize; ///< band buffer size in bytes
172 const uint16_t *intra_base; ///< quantization matrix for intra blocks
173 const uint16_t *inter_base; ///< quantization matrix for inter blocks
174 const uint8_t *intra_scale; ///< quantization coefficient for intra blocks
175 const uint8_t *inter_scale; ///< quantization coefficient for inter blocks
180 * color plane (luma or chroma) information
182 typedef struct IVIPlaneDesc {
185 uint8_t num_bands; ///< number of bands this plane subdivided into
186 IVIBandDesc *bands; ///< array of band descriptors
190 typedef struct IVIPicConfig {
193 uint16_t chroma_width;
194 uint16_t chroma_height;
196 uint16_t tile_height;
198 uint8_t chroma_bands;
201 typedef struct IVI45DecContext {
204 RVMapDesc rvmap_tabs[9]; ///< local corrected copy of the static rvmap tables
208 int prev_frame_type; ///< frame type of the previous frame
209 uint32_t data_size; ///< size of the frame data in bytes from picture header
211 int transp_status; ///< transparency mode status: 1 - enabled
212 const uint8_t *frame_data; ///< input frame data pointer
213 int inter_scal; ///< signals a sequence of scalable inter frames
214 uint32_t frame_size; ///< frame size in bytes
215 uint32_t pic_hdr_size; ///< picture header size in bytes
217 uint16_t checksum; ///< frame checksum
219 IVIPicConfig pic_conf;
220 IVIPlaneDesc planes[3]; ///< color planes
222 int buf_switch; ///< used to switch between three buffers
223 int dst_buf; ///< buffer index for the currently decoded frame
224 int ref_buf; ///< inter frame reference buffer index
225 int ref2_buf; ///< temporal storage for switching buffers
227 IVIHuffTab mb_vlc; ///< current macroblock table descriptor
228 IVIHuffTab blk_vlc; ///< current block table descriptor
232 uint8_t in_q; ///< flag for explicitly stored quantiser delta
233 uint8_t pic_glob_quant;
236 uint16_t gop_hdr_size;
240 #if IVI4_STREAM_ANALYSER
241 uint8_t has_b_frames;
245 uint8_t uses_fullpel;
248 int (*decode_pic_hdr) (struct IVI45DecContext *ctx, AVCodecContext *avctx);
249 int (*decode_band_hdr) (struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx);
250 int (*decode_mb_info) (struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx);
251 void (*switch_buffers) (struct IVI45DecContext *ctx);
252 int (*is_nonnull_frame)(struct IVI45DecContext *ctx);
258 /** compare some properties of two pictures */
259 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
261 return str1->pic_width != str2->pic_width || str1->pic_height != str2->pic_height ||
262 str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
263 str1->tile_width != str2->tile_width || str1->tile_height != str2->tile_height ||
264 str1->luma_bands != str2->luma_bands || str1->chroma_bands != str2->chroma_bands;
267 /** calculate number of tiles in a stride */
268 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
270 /** calculate number of macroblocks in a tile */
271 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
272 ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
274 /** convert unsigned values into signed ones (the sign is in the LSB) */
275 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
277 /** scale motion vector */
278 static inline int ivi_scale_mv(int mv, int mv_scale)
280 return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
284 * Generate a huffman codebook from the given descriptor
285 * and convert it into the FFmpeg VLC table.
287 * @param[in] cb pointer to codebook descriptor
288 * @param[out] vlc where to place the generated VLC table
289 * @param[in] flag flag: 1 - for static or 0 for dynamic tables
290 * @return result code: 0 - OK, -1 = error (invalid codebook descriptor)
292 int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
295 * Initialize static codes used for macroblock and block decoding.
297 void ff_ivi_init_static_vlc(void);
300 * Decode a huffman codebook descriptor from the bitstream
301 * and select specified huffman table.
303 * @param[in,out] gb the GetBit context
304 * @param[in] desc_coded flag signalling if table descriptor was coded
305 * @param[in] which_tab codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
306 * @param[out] huff_tab pointer to the descriptor of the selected table
307 * @param[in] avctx AVCodecContext pointer
308 * @return zero on success, negative value otherwise
310 int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
311 IVIHuffTab *huff_tab, AVCodecContext *avctx);
314 * Compare two huffman codebook descriptors.
316 * @param[in] desc1 ptr to the 1st descriptor to compare
317 * @param[in] desc2 ptr to the 2nd descriptor to compare
318 * @return comparison result: 0 - equal, 1 - not equal
320 int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
323 * Copy huffman codebook descriptors.
325 * @param[out] dst ptr to the destination descriptor
326 * @param[in] src ptr to the source descriptor
328 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
331 * Initialize planes (prepares descriptors, allocates buffers etc).
333 * @param[in,out] planes pointer to the array of the plane descriptors
334 * @param[in] cfg pointer to the ivi_pic_config structure describing picture layout
335 * @return result code: 0 - OK
337 int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
340 * Free planes, bands and macroblocks buffers.
342 * @param[in] planes pointer to the array of the plane descriptors
344 void ff_ivi_free_buffers(IVIPlaneDesc *planes);
347 * Initialize tile and macroblock descriptors.
349 * @param[in,out] planes pointer to the array of the plane descriptors
350 * @param[in] tile_width tile width
351 * @param[in] tile_height tile height
352 * @return result code: 0 - OK
354 int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
357 * Decode size of the tile data.
358 * The size is stored as a variable-length field having the following format:
359 * if (tile_data_size < 255) than this field is only one byte long
360 * if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
361 * where X1-X3 is size of the tile data
363 * @param[in,out] gb the GetBit context
364 * @return size of the tile data in bytes
366 int ff_ivi_dec_tile_data_size(GetBitContext *gb);
370 * extract huffman-coded transform coefficients from the bitstream,
371 * dequantize them, apply inverse transform and motion compensation
372 * in order to reconstruct the picture.
374 * @param[in,out] gb the GetBit context
375 * @param[in] band pointer to the band descriptor
376 * @param[in] tile pointer to the tile descriptor
377 * @return result code: 0 - OK, -1 = error (corrupted blocks data)
379 int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
382 * Convert and output the current plane.
383 * This conversion is done by adding back the bias value of 128
384 * (subtracted in the encoder) and clipping the result.
386 * @param[in] plane pointer to the descriptor of the plane being processed
387 * @param[out] dst pointer to the buffer receiving converted pixels
388 * @param[in] dst_pitch pitch for moving to the next y line
390 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
392 int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
394 av_cold int ff_ivi_decode_close(AVCodecContext *avctx);
396 #endif /* AVCODEC_IVI_COMMON_H */