indeo: clear allocated band buffers
[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 Libav.
7  *
8  * Libav 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  * Libav 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 Libav; 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_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
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  *  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 /**
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
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)
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         mb_size;
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
127 } IVITile;
128
129
130 /**
131  *  information for Indeo wavelet band
132  */
133 typedef struct {
134     int             plane;          ///< plane number this band belongs to
135     int             band_num;       ///< band number
136     int             width;
137     int             height;
138     const uint8_t   *data_ptr;      ///< ptr to the first byte of the band data
139     int             data_size;      ///< size of the band data
140     int16_t         *buf;           ///< pointer to the output buffer for this band
141     int16_t         *ref_buf;       ///< pointer to the reference frame buffer (for motion compensation)
142     int16_t         *bufs[3];       ///< array of pointers to the band buffers
143     int             pitch;          ///< pitch associated with the buffers above
144     int             is_empty;       ///< = 1 if this band doesn't contain any data
145     int             mb_size;        ///< macroblock size
146     int             blk_size;       ///< block size
147     int             is_halfpel;     ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
148     int             inherit_mv;     ///< tells if motion vector is inherited from reference macroblock
149     int             inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
150     int             qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
151     int             quant_mat;      ///< dequant matrix index
152     int             glob_quant;     ///< quant base for this band
153     const uint8_t   *scan;          ///< ptr to the scan pattern
154
155     IVIHuffTab      blk_vlc;        ///< vlc table for decoding block data
156
157     int             num_corr;       ///< number of correction entries
158     uint8_t         corr[61*2];     ///< rvmap correction pairs
159     int             rvmap_sel;      ///< rvmap table selector
160     RVMapDesc       *rv_map;        ///< ptr to the RLE table for this band
161     int             num_tiles;      ///< number of tiles in this band
162     IVITile         *tiles;         ///< array of tile descriptors
163     InvTransformPtr *inv_transform;
164     DCTransformPtr  *dc_transform;
165     int             is_2d_trans;    ///< 1 indicates that the two-dimensional inverse transform is used
166     int32_t         checksum;       ///< for debug purposes
167     int             checksum_present;
168     int             bufsize;        ///< band buffer size in bytes
169     const uint16_t  *intra_base;    ///< quantization matrix for intra blocks
170     const uint16_t  *inter_base;    ///< quantization matrix for inter blocks
171     const uint8_t   *intra_scale;   ///< quantization coefficient for intra blocks
172     const uint8_t   *inter_scale;   ///< quantization coefficient for inter blocks
173 } IVIBandDesc;
174
175
176 /**
177  *  color plane (luma or chroma) information
178  */
179 typedef struct {
180     uint16_t    width;
181     uint16_t    height;
182     uint8_t     num_bands;  ///< number of bands this plane subdivided into
183     IVIBandDesc *bands;     ///< array of band descriptors
184 } IVIPlaneDesc;
185
186
187 typedef struct {
188     uint16_t    pic_width;
189     uint16_t    pic_height;
190     uint16_t    chroma_width;
191     uint16_t    chroma_height;
192     uint16_t    tile_width;
193     uint16_t    tile_height;
194     uint8_t     luma_bands;
195     uint8_t     chroma_bands;
196 } IVIPicConfig;
197
198 typedef struct IVI45DecContext {
199     GetBitContext   gb;
200     AVFrame         frame;
201     RVMapDesc       rvmap_tabs[9];   ///< local corrected copy of the static rvmap tables
202
203     uint32_t        frame_num;
204     int             frame_type;
205     int             prev_frame_type; ///< frame type of the previous frame
206     uint32_t        data_size;       ///< size of the frame data in bytes from picture header
207     int             is_scalable;
208     int             transp_status;   ///< transparency mode status: 1 - enabled
209     const uint8_t   *frame_data;     ///< input frame data pointer
210     int             inter_scal;      ///< signals a sequence of scalable inter frames
211     uint32_t        frame_size;      ///< frame size in bytes
212     uint32_t        pic_hdr_size;    ///< picture header size in bytes
213     uint8_t         frame_flags;
214     uint16_t        checksum;        ///< frame checksum
215
216     IVIPicConfig    pic_conf;
217     IVIPlaneDesc    planes[3];       ///< color planes
218
219     int             buf_switch;      ///< used to switch between three buffers
220     int             dst_buf;         ///< buffer index for the currently decoded frame
221     int             ref_buf;         ///< inter frame reference buffer index
222     int             ref2_buf;        ///< temporal storage for switching buffers
223
224     IVIHuffTab      mb_vlc;          ///< current macroblock table descriptor
225     IVIHuffTab      blk_vlc;         ///< current block table descriptor
226
227     uint8_t         rvmap_sel;
228     uint8_t         in_imf;
229     uint8_t         in_q;            ///< flag for explicitly stored quantiser delta
230     uint8_t         pic_glob_quant;
231     uint8_t         unknown1;
232
233     uint16_t        gop_hdr_size;
234     uint8_t         gop_flags;
235     uint32_t        lock_word;
236
237 #if IVI4_STREAM_ANALYSER
238     uint8_t         has_b_frames;
239     uint8_t         has_transp;
240     uint8_t         uses_tiling;
241     uint8_t         uses_haar;
242     uint8_t         uses_fullpel;
243 #endif
244
245     int             (*decode_pic_hdr)  (struct IVI45DecContext *ctx, AVCodecContext *avctx);
246     int             (*decode_band_hdr) (struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx);
247     int             (*decode_mb_info)  (struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx);
248     void            (*switch_buffers)  (struct IVI45DecContext *ctx);
249     int             (*is_nonnull_frame)(struct IVI45DecContext *ctx);
250 } IVI45DecContext;
251
252 /** compare some properties of two pictures */
253 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
254 {
255     return str1->pic_width    != str2->pic_width    || str1->pic_height    != str2->pic_height    ||
256            str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
257            str1->tile_width   != str2->tile_width   || str1->tile_height   != str2->tile_height   ||
258            str1->luma_bands   != str2->luma_bands   || str1->chroma_bands  != str2->chroma_bands;
259 }
260
261 /** calculate number of tiles in a stride */
262 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
263
264 /** calculate number of macroblocks in a tile */
265 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
266     ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
267
268 /** convert unsigned values into signed ones (the sign is in the LSB) */
269 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
270
271 /** scale motion vector */
272 static inline int ivi_scale_mv(int mv, int mv_scale)
273 {
274     return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
275 }
276
277 /**
278  *  Generate a huffman codebook from the given descriptor
279  *  and convert it into the Libav VLC table.
280  *
281  *  @param[in]   cb    pointer to codebook descriptor
282  *  @param[out]  vlc   where to place the generated VLC table
283  *  @param[in]   flag  flag: 1 - for static or 0 for dynamic tables
284  *  @return     result code: 0 - OK, -1 = error (invalid codebook descriptor)
285  */
286 int  ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
287
288 /**
289  * Initialize static codes used for macroblock and block decoding.
290  */
291 void ff_ivi_init_static_vlc(void);
292
293 /**
294  *  Decode a huffman codebook descriptor from the bitstream
295  *  and select specified huffman table.
296  *
297  *  @param[in,out]  gb          the GetBit context
298  *  @param[in]      desc_coded  flag signalling if table descriptor was coded
299  *  @param[in]      which_tab   codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
300  *  @param[out]     huff_tab    pointer to the descriptor of the selected table
301  *  @param[in]      avctx       AVCodecContext pointer
302  *  @return             zero on success, negative value otherwise
303  */
304 int  ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
305                           IVIHuffTab *huff_tab, AVCodecContext *avctx);
306
307 /**
308  *  Compare two huffman codebook descriptors.
309  *
310  *  @param[in]  desc1  ptr to the 1st descriptor to compare
311  *  @param[in]  desc2  ptr to the 2nd descriptor to compare
312  *  @return         comparison result: 0 - equal, 1 - not equal
313  */
314 int  ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
315
316 /**
317  *  Copy huffman codebook descriptors.
318  *
319  *  @param[out]  dst  ptr to the destination descriptor
320  *  @param[in]   src  ptr to the source descriptor
321  */
322 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
323
324 /**
325  *  Initialize planes (prepares descriptors, allocates buffers etc).
326  *
327  *  @param[in,out]  planes  pointer to the array of the plane descriptors
328  *  @param[in]      cfg     pointer to the ivi_pic_config structure describing picture layout
329  *  @return             result code: 0 - OK
330  */
331 int  ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
332
333 /**
334  *  Free planes, bands and macroblocks buffers.
335  *
336  *  @param[in]  planes  pointer to the array of the plane descriptors
337  */
338 void ff_ivi_free_buffers(IVIPlaneDesc *planes);
339
340 /**
341  *  Initialize tile and macroblock descriptors.
342  *
343  *  @param[in,out]  planes       pointer to the array of the plane descriptors
344  *  @param[in]      tile_width   tile width
345  *  @param[in]      tile_height  tile height
346  *  @return             result code: 0 - OK
347  */
348 int  ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
349
350 /**
351  *  Decode size of the tile data.
352  *  The size is stored as a variable-length field having the following format:
353  *  if (tile_data_size < 255) than this field is only one byte long
354  *  if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
355  *  where X1-X3 is size of the tile data
356  *
357  *  @param[in,out]  gb  the GetBit context
358  *  @return     size of the tile data in bytes
359  */
360 int  ff_ivi_dec_tile_data_size(GetBitContext *gb);
361
362 /**
363  *  Decode block data:
364  *  extract huffman-coded transform coefficients from the bitstream,
365  *  dequantize them, apply inverse transform and motion compensation
366  *  in order to reconstruct the picture.
367  *
368  *  @param[in,out]  gb    the GetBit context
369  *  @param[in]      band  pointer to the band descriptor
370  *  @param[in]      tile  pointer to the tile descriptor
371  *  @return     result code: 0 - OK, -1 = error (corrupted blocks data)
372  */
373 int  ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
374
375 /**
376  *  Handle empty tiles by performing data copying and motion
377  *  compensation respectively.
378  *
379  *  @param[in]  avctx     ptr to the AVCodecContext
380  *  @param[in]  band      pointer to the band descriptor
381  *  @param[in]  tile      pointer to the tile descriptor
382  *  @param[in]  mv_scale  scaling factor for motion vectors
383  */
384 void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
385                                IVITile *tile, int32_t mv_scale);
386
387 /**
388  *  Convert and output the current plane.
389  *  This conversion is done by adding back the bias value of 128
390  *  (subtracted in the encoder) and clipping the result.
391  *
392  *  @param[in]   plane      pointer to the descriptor of the plane being processed
393  *  @param[out]  dst        pointer to the buffer receiving converted pixels
394  *  @param[in]   dst_pitch  pitch for moving to the next y line
395  */
396 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
397
398 /**
399  *  Calculate band checksum from band data.
400  */
401 uint16_t ivi_calc_band_checksum (IVIBandDesc *band);
402
403 /**
404  *  Verify that band data lies in range.
405  */
406 int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch);
407
408 int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
409                         AVPacket *avpkt);
410 av_cold int ff_ivi_decode_close(AVCodecContext *avctx);
411
412 #endif /* AVCODEC_IVI_COMMON_H */