Remove pointless av_cold attributes in header files
[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 IVIHuffDesc {
44     int32_t     num_rows;
45     uint8_t     xbits[16];
46 } IVIHuffDesc;
47
48 /**
49  *  macroblock/block huffman table descriptor
50  */
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
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
67 /**
68  *  Common scan patterns (defined in ivi_common.c)
69  */
70 extern const uint8_t ff_ivi_vertical_scan_8x8[64];
71 extern const uint8_t ff_ivi_horizontal_scan_8x8[64];
72 extern const uint8_t ff_ivi_direct_scan_4x4[16];
73
74
75 /**
76  *  Declare inverse transform function types
77  */
78 typedef void (InvTransformPtr)(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags);
79 typedef void (DCTransformPtr) (const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
80
81
82 /**
83  *  run-value (RLE) table descriptor
84  */
85 typedef struct RVMapDesc {
86     uint8_t     eob_sym; ///< end of block symbol
87     uint8_t     esc_sym; ///< escape symbol
88     uint8_t     runtab[256];
89     int8_t      valtab[256];
90 } RVMapDesc;
91
92 extern const RVMapDesc ff_ivi_rvmap_tabs[9];
93
94
95 /**
96  *  information for Indeo macroblock (16x16, 8x8 or 4x4)
97  */
98 typedef struct IVIMbInfo {
99     int16_t     xpos;
100     int16_t     ypos;
101     uint32_t    buf_offs; ///< address in the output buffer for this mb
102     uint8_t     type;     ///< macroblock type: 0 - INTRA, 1 - INTER
103     uint8_t     cbp;      ///< coded block pattern
104     int8_t      q_delta;  ///< quant delta
105     int8_t      mv_x;     ///< motion vector (x component)
106     int8_t      mv_y;     ///< motion vector (y component)
107 } IVIMbInfo;
108
109
110 /**
111  *  information for Indeo tile
112  */
113 typedef struct IVITile {
114     int         xpos;
115     int         ypos;
116     int         width;
117     int         height;
118     int         mb_size;
119     int         is_empty;  ///< = 1 if this tile doesn't contain any data
120     int         data_size; ///< size of the data in bytes
121     int         num_MBs;   ///< number of macroblocks in this tile
122     IVIMbInfo   *mbs;      ///< array of macroblock descriptors
123     IVIMbInfo   *ref_mbs;  ///< ptr to the macroblock descriptors of the reference tile
124 } IVITile;
125
126
127 /**
128  *  information for Indeo wavelet band
129  */
130 typedef struct IVIBandDesc {
131     int             plane;          ///< plane number this band belongs to
132     int             band_num;       ///< band number
133     int             width;
134     int             height;
135     int             aheight;        ///< aligned band height
136     const uint8_t   *data_ptr;      ///< ptr to the first byte of the band data
137     int             data_size;      ///< size of the band data
138     int16_t         *buf;           ///< pointer to the output buffer for this band
139     int16_t         *ref_buf;       ///< pointer to the reference frame buffer (for motion compensation)
140     int16_t         *bufs[3];       ///< array of pointers to the band buffers
141     int             pitch;          ///< pitch associated with the buffers above
142     int             is_empty;       ///< = 1 if this band doesn't contain any data
143     int             mb_size;        ///< macroblock size
144     int             blk_size;       ///< block size
145     int             is_halfpel;     ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
146     int             inherit_mv;     ///< tells if motion vector is inherited from reference macroblock
147     int             inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
148     int             qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
149     int             quant_mat;      ///< dequant matrix index
150     int             glob_quant;     ///< quant base for this band
151     const uint8_t   *scan;          ///< ptr to the scan pattern
152
153     IVIHuffTab      blk_vlc;        ///< vlc table for decoding block data
154
155     int             num_corr;       ///< number of correction entries
156     uint8_t         corr[61*2];     ///< rvmap correction pairs
157     int             rvmap_sel;      ///< rvmap table selector
158     RVMapDesc       *rv_map;        ///< ptr to the RLE table for this band
159     int             num_tiles;      ///< number of tiles in this band
160     IVITile         *tiles;         ///< array of tile descriptors
161     InvTransformPtr *inv_transform;
162     DCTransformPtr  *dc_transform;
163     int             is_2d_trans;    ///< 1 indicates that the two-dimensional inverse transform is used
164     int32_t         checksum;       ///< for debug purposes
165     int             checksum_present;
166     int             bufsize;        ///< band buffer size in bytes
167     const uint16_t  *intra_base;    ///< quantization matrix for intra blocks
168     const uint16_t  *inter_base;    ///< quantization matrix for inter blocks
169     const uint8_t   *intra_scale;   ///< quantization coefficient for intra blocks
170     const uint8_t   *inter_scale;   ///< quantization coefficient for inter blocks
171 } IVIBandDesc;
172
173
174 /**
175  *  color plane (luma or chroma) information
176  */
177 typedef struct IVIPlaneDesc {
178     uint16_t    width;
179     uint16_t    height;
180     uint8_t     num_bands;  ///< number of bands this plane subdivided into
181     IVIBandDesc *bands;     ///< array of band descriptors
182 } IVIPlaneDesc;
183
184
185 typedef struct IVIPicConfig {
186     uint16_t    pic_width;
187     uint16_t    pic_height;
188     uint16_t    chroma_width;
189     uint16_t    chroma_height;
190     uint16_t    tile_width;
191     uint16_t    tile_height;
192     uint8_t     luma_bands;
193     uint8_t     chroma_bands;
194 } IVIPicConfig;
195
196 typedef struct IVI45DecContext {
197     GetBitContext   gb;
198     AVFrame         frame;
199     RVMapDesc       rvmap_tabs[9];   ///< local corrected copy of the static rvmap tables
200
201     uint32_t        frame_num;
202     int             frame_type;
203     int             prev_frame_type; ///< frame type of the previous frame
204     uint32_t        data_size;       ///< size of the frame data in bytes from picture header
205     int             is_scalable;
206     int             transp_status;   ///< transparency mode status: 1 - enabled
207     const uint8_t   *frame_data;     ///< input frame data pointer
208     int             inter_scal;      ///< signals a sequence of scalable inter frames
209     uint32_t        frame_size;      ///< frame size in bytes
210     uint32_t        pic_hdr_size;    ///< picture header size in bytes
211     uint8_t         frame_flags;
212     uint16_t        checksum;        ///< frame checksum
213
214     IVIPicConfig    pic_conf;
215     IVIPlaneDesc    planes[3];       ///< color planes
216
217     int             buf_switch;      ///< used to switch between three buffers
218     int             dst_buf;         ///< buffer index for the currently decoded frame
219     int             ref_buf;         ///< inter frame reference buffer index
220     int             ref2_buf;        ///< temporal storage for switching buffers
221
222     IVIHuffTab      mb_vlc;          ///< current macroblock table descriptor
223     IVIHuffTab      blk_vlc;         ///< current block table descriptor
224
225     uint8_t         rvmap_sel;
226     uint8_t         in_imf;
227     uint8_t         in_q;            ///< flag for explicitly stored quantiser delta
228     uint8_t         pic_glob_quant;
229     uint8_t         unknown1;
230
231     uint16_t        gop_hdr_size;
232     uint8_t         gop_flags;
233     uint32_t        lock_word;
234
235 #if IVI4_STREAM_ANALYSER
236     uint8_t         has_b_frames;
237     uint8_t         has_transp;
238     uint8_t         uses_tiling;
239     uint8_t         uses_haar;
240     uint8_t         uses_fullpel;
241 #endif
242
243     int             (*decode_pic_hdr)  (struct IVI45DecContext *ctx, AVCodecContext *avctx);
244     int             (*decode_band_hdr) (struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx);
245     int             (*decode_mb_info)  (struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx);
246     void            (*switch_buffers)  (struct IVI45DecContext *ctx);
247     int             (*is_nonnull_frame)(struct IVI45DecContext *ctx);
248
249     int gop_invalid;
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  * Initialize static codes used for macroblock and block decoding.
279  */
280 void ff_ivi_init_static_vlc(void);
281
282 /**
283  *  Decode a huffman codebook descriptor from the bitstream
284  *  and select specified huffman table.
285  *
286  *  @param[in,out]  gb          the GetBit context
287  *  @param[in]      desc_coded  flag signalling if table descriptor was coded
288  *  @param[in]      which_tab   codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
289  *  @param[out]     huff_tab    pointer to the descriptor of the selected table
290  *  @param[in]      avctx       AVCodecContext pointer
291  *  @return             zero on success, negative value otherwise
292  */
293 int  ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
294                           IVIHuffTab *huff_tab, AVCodecContext *avctx);
295
296 /**
297  *  Initialize planes (prepares descriptors, allocates buffers etc).
298  *
299  *  @param[in,out]  planes  pointer to the array of the plane descriptors
300  *  @param[in]      cfg     pointer to the ivi_pic_config structure describing picture layout
301  *  @return             result code: 0 - OK
302  */
303 int  ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
304
305 /**
306  *  Initialize tile and macroblock descriptors.
307  *
308  *  @param[in,out]  planes       pointer to the array of the plane descriptors
309  *  @param[in]      tile_width   tile width
310  *  @param[in]      tile_height  tile height
311  *  @return             result code: 0 - OK
312  */
313 int  ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
314
315 int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
316                         AVPacket *avpkt);
317 int ff_ivi_decode_close(AVCodecContext *avctx);
318
319 #endif /* AVCODEC_IVI_COMMON_H */