Remove unused variables.
[ffmpeg.git] / libavcodec / ivi_common.h
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 /**
24  * @file
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
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
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
68
69
70 /**
71  *  Common scan patterns (defined in ivi_common.c)
72  */
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];
76
77
78 /**
79  *  run-value (RLE) table descriptor
80  */
81 typedef struct {
82     uint8_t     eob_sym; ///< end of block symbol
83     uint8_t     esc_sym; ///< escape symbol
84     uint8_t     runtab[256];
85     int8_t      valtab[256];
86 } RVMapDesc;
87
88 extern const RVMapDesc ff_ivi_rvmap_tabs[9];
89
90
91 /**
92  *  information for Indeo macroblock (16x16, 8x8 or 4x4)
93  */
94 typedef struct {
95     int16_t     xpos;
96     int16_t     ypos;
97     uint32_t    buf_offs; ///< address in the output buffer for this mb
98     uint8_t     type;     ///< macroblock type: 0 - INTRA, 1 - INTER
99     uint8_t     cbp;      ///< coded block pattern
100     int8_t      q_delta;  ///< quant delta
101     int8_t      mv_x;     ///< motion vector (x component)
102     int8_t      mv_y;     ///< motion vector (y component)
103 } IVIMbInfo;
104
105
106 /**
107  *  information for Indeo tile
108  */
109 typedef struct {
110     int         xpos;
111     int         ypos;
112     int         width;
113     int         height;
114     int         is_empty;  ///< = 1 if this tile doesn't contain any data
115     int         data_size; ///< size of the data in bytes
116     int         num_MBs;   ///< number of macroblocks in this tile
117     IVIMbInfo   *mbs;      ///< array of macroblock descriptors
118     IVIMbInfo   *ref_mbs;  ///< ptr to the macroblock descriptors of the reference tile
119 } IVITile;
120
121
122 /**
123  *  information for Indeo wavelet band
124  */
125 typedef struct {
126     int             plane;          ///< plane number this band belongs to
127     int             band_num;       ///< band number
128     int             width;
129     int             height;
130     const uint8_t   *data_ptr;      ///< ptr to the first byte of the band data
131     int             data_size;      ///< size of the band data
132     int16_t         *buf;           ///< pointer to the output buffer for this band
133     int16_t         *ref_buf;       ///< pointer to the reference frame buffer (for motion compensation)
134     int16_t         *bufs[3];       ///< array of pointers to the band buffers
135     int             pitch;          ///< pitch associated with the buffers above
136     int             is_empty;       ///< = 1 if this band doesn't contain any data
137     int             mb_size;        ///< macroblock size
138     int             blk_size;       ///< block size
139     int             is_halfpel;     ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
140     int             inherit_mv;     ///< tells if motion vector is inherited from reference macroblock
141     int             inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
142     int             qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
143     int             quant_mat;      ///< dequant matrix index
144     int             glob_quant;     ///< quant base for this band
145     const uint8_t   *scan;          ///< ptr to the scan pattern
146
147     IVIHuffTab      blk_vlc;        ///< vlc table for decoding block data
148
149     int             num_corr;       ///< number of correction entries
150     uint8_t         corr[61*2];     ///< rvmap correction pairs
151     int             rvmap_sel;      ///< rvmap table selector
152     RVMapDesc       *rv_map;        ///< ptr to the RLE table for this band
153     int             num_tiles;      ///< number of tiles in this band
154     IVITile         *tiles;         ///< array of tile descriptors
155     void (*inv_transform)(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags); ///< inverse transform function pointer
156     void (*dc_transform) (const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);   ///< dc transform function pointer, it may be NULL
157     int             is_2d_trans;    ///< 1 indicates that the two-dimensional inverse transform is used
158     int32_t         checksum;       ///< for debug purposes
159     int             checksum_present;
160     int             bufsize;        ///< band buffer size in bytes
161     const uint8_t   *intra_base;    ///< quantization matrix for intra blocks
162     const uint8_t   *inter_base;    ///< quantization matrix for inter blocks
163     const uint8_t   *intra_scale;   ///< quantization coefficient for intra blocks
164     const uint8_t   *inter_scale;   ///< quantization coefficient for inter blocks
165 } IVIBandDesc;
166
167
168 /**
169  *  color plane (luma or chroma) information
170  */
171 typedef struct {
172     uint16_t    width;
173     uint16_t    height;
174     uint8_t     num_bands;  ///< number of bands this plane subdivided into
175     IVIBandDesc *bands;     ///< array of band descriptors
176 } IVIPlaneDesc;
177
178
179 typedef struct {
180     uint16_t    pic_width;
181     uint16_t    pic_height;
182     uint16_t    chroma_width;
183     uint16_t    chroma_height;
184     uint16_t    tile_width;
185     uint16_t    tile_height;
186     uint8_t     luma_bands;
187     uint8_t     chroma_bands;
188 } IVIPicConfig;
189
190 /** compares some properties of two pictures */
191 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
192 {
193     return (str1->pic_width    != str2->pic_width    || str1->pic_height    != str2->pic_height    ||
194             str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
195             str1->tile_width   != str2->tile_width   || str1->tile_height   != str2->tile_height   ||
196             str1->luma_bands   != str2->luma_bands   || str1->chroma_bands  != str2->chroma_bands);
197 }
198
199 /** calculate number of tiles in a stride */
200 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
201
202 /** calculate number of macroblocks in a tile */
203 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
204     ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
205
206 /** convert unsigned values into signed ones (the sign is in the LSB) */
207 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
208
209 /** scales motion vector */
210 static inline int ivi_scale_mv(int mv, int mv_scale)
211 {
212     return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
213 }
214
215 /**
216  *  Generates a huffman codebook from the given descriptor
217  *  and converts it into the FFmpeg VLC table.
218  *
219  *  @param cb   [in]  pointer to codebook descriptor
220  *  @param vlc  [out] where to place the generated VLC table
221  *  @param flag [in]  flag: 1 - for static or 0 for dynamic tables
222  *  @return     result code: 0 - OK, -1 = error (invalid codebook descriptor)
223  */
224 int  ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
225
226 /**
227  * Initializes static codes used for macroblock and block decoding.
228  */
229 void ff_ivi_init_static_vlc(void);
230
231 /**
232  *  Decodes a huffman codebook descriptor from the bitstream
233  *  and selects specified huffman table.
234  *
235  *  @param gb           [in,out] the GetBit context
236  *  @param desc_coded   [in] flag signalling if table descriptor was coded
237  *  @param which_tab    [in] codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
238  *  @param huff_tab     [out] pointer to the descriptor of the selected table
239  *  @param avctx        [in] AVCodecContext pointer
240  *  @return             zero on success, negative value otherwise
241  */
242 int  ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
243                           IVIHuffTab *huff_tab, AVCodecContext *avctx);
244
245 /**
246  *  Compares two huffman codebook descriptors.
247  *
248  *  @param desc1    [in] ptr to the 1st descriptor to compare
249  *  @param desc2    [in] ptr to the 2nd descriptor to compare
250  *  @return         comparison result: 0 - equal, 1 - not equal
251  */
252 int  ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
253
254 /**
255  *  Copies huffman codebook descriptors.
256  *
257  *  @param dst  [out] ptr to the destination descriptor
258  *  @param src  [in]  ptr to the source descriptor
259  */
260 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
261
262 /**
263  *  Initializes planes (prepares descriptors, allocates buffers etc).
264  *
265  *  @param planes       [in,out] pointer to the array of the plane descriptors
266  *  @param cfg          [in] pointer to the ivi_pic_config structure describing picture layout
267  *  @return             result code: 0 - OK
268  */
269 int  ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
270
271 /**
272  *  Frees planes, bands and macroblocks buffers.
273  *
274  *  @param planes       [in] pointer to the array of the plane descriptors
275  */
276 void ff_ivi_free_buffers(IVIPlaneDesc *planes);
277
278 /**
279  *  Initializes tile and macroblock descriptors.
280  *
281  *  @param planes       [in,out] pointer to the array of the plane descriptors
282  *  @param tile_width   [in]     tile width
283  *  @param tile_height  [in]     tile height
284  *  @return             result code: 0 - OK
285  */
286 int  ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
287
288 /**
289  *  Decodes size of the tile data.
290  *  The size is stored as a variable-length field having the following format:
291  *  if (tile_data_size < 255) than this field is only one byte long
292  *  if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
293  *  where X1-X3 is size of the tile data
294  *
295  *  @param gb   [in,out] the GetBit context
296  *  @return     size of the tile data in bytes
297  */
298 int  ff_ivi_dec_tile_data_size(GetBitContext *gb);
299
300 /**
301  *  Decodes block data:
302  *  extracts huffman-coded transform coefficients from the bitstream,
303  *  dequantizes them, applies inverse transform and motion compensation
304  *  in order to reconstruct the picture.
305  *
306  *  @param gb   [in,out] the GetBit context
307  *  @param band [in]     pointer to the band descriptor
308  *  @param tile [in]     pointer to the tile descriptor
309  *  @return     result code: 0 - OK, -1 = error (corrupted blocks data)
310  */
311 int  ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
312
313 /**
314  *  Handles empty tiles by performing data copying and motion
315  *  compensation respectively.
316  *
317  *  @param avctx    [in] ptr to the AVCodecContext
318  *  @param band     [in] pointer to the band descriptor
319  *  @param tile     [in] pointer to the tile descriptor
320  *  @param mv_scale [in] scaling factor for motion vectors
321  */
322 void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
323                                IVITile *tile, int32_t mv_scale);
324
325 /**
326  *  Converts and outputs the current plane.
327  *  This conversion is done by adding back the bias value of 128
328  *  (subtracted in the encoder) and clipping the result.
329  *
330  *  @param plane        [in]  pointer to the descriptor of the plane being processed
331  *  @param dst          [out] pointer to the buffer receiving converted pixels
332  *  @param dst_pitch    [in]  pitch for moving to the next y line
333  */
334 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
335
336 #if IVI_DEBUG
337 /**
338  *  Calculates band checksum from band data.
339  */
340 uint16_t ivi_calc_band_checksum (IVIBandDesc *band);
341
342 /**
343  *  Verifies that band data lies in range.
344  */
345 int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch);
346 #endif
347
348 #endif /* AVCODEC_IVI_COMMON_H */