indeo: Convert to the new bitstream reader
[libav.git] / libavcodec / ivi.h
CommitLineData
1cf31685
KS
1/*
2 * common functions for Indeo Video Interactive codecs (Indeo4 and Indeo5)
3 *
4 * Copyright (c) 2009 Maxim Poliakovski
5 *
2912e87a 6 * This file is part of Libav.
1cf31685 7 *
2912e87a 8 * Libav is free software; you can redistribute it and/or
1cf31685
KS
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 *
2912e87a 13 * Libav is distributed in the hope that it will be useful,
1cf31685
KS
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
2912e87a 19 * License along with Libav; if not, write to the Free Software
1cf31685
KS
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23/**
ba87f080 24 * @file
1cf31685
KS
25 * This file contains structures and macros shared by both Indeo4 and
26 * Indeo5 decoders.
27 */
28
23944d29
DB
29#ifndef AVCODEC_IVI_H
30#define AVCODEC_IVI_H
1cf31685 31
1cf31685
KS
32#include <stdint.h>
33
c3defda0
AH
34#include "avcodec.h"
35#include "bitstream.h"
36
3df0d200
DA
37/**
38 * Indeo 4 frame types.
39 */
40enum {
41 IVI4_FRAMETYPE_INTRA = 0,
42 IVI4_FRAMETYPE_INTRA1 = 1, ///< intra frame with slightly different bitstream coding
43 IVI4_FRAMETYPE_INTER = 2, ///< non-droppable P-frame
44 IVI4_FRAMETYPE_BIDIR = 3, ///< bidirectional frame
45 IVI4_FRAMETYPE_INTER_NOREF = 4, ///< droppable P-frame
46 IVI4_FRAMETYPE_NULL_FIRST = 5, ///< empty frame with no data
47 IVI4_FRAMETYPE_NULL_LAST = 6 ///< empty frame with no data
48};
49
1cf31685 50#define IVI_VLC_BITS 13 ///< max number of bits of the ivi's huffman codes
aa372cf4 51#define IVI5_IS_PROTECTED 0x20
1cf31685
KS
52
53/**
54 * huffman codebook descriptor
55 */
e4cbf752 56typedef struct IVIHuffDesc {
1cf31685
KS
57 int32_t num_rows;
58 uint8_t xbits[16];
59} IVIHuffDesc;
60
e322aace
KS
61/**
62 * macroblock/block huffman table descriptor
63 */
e4cbf752 64typedef struct IVIHuffTab {
e322aace
KS
65 int32_t tab_sel; /// index of one of the predefined tables
66 /// or "7" for custom one
67 VLC *tab; /// pointer to the table associated with tab_sel
68
c68fafe0 69 /// the following are used only when tab_sel == 7
e322aace
KS
70 IVIHuffDesc cust_desc; /// custom Huffman codebook descriptor
71 VLC cust_tab; /// vlc table for custom codebook
72} IVIHuffTab;
73
74enum {
75 IVI_MB_HUFF = 0, /// Huffman table is used for coding macroblocks
76 IVI_BLK_HUFF = 1 /// Huffman table is used for coding blocks
77};
78
1cf31685
KS
79
80/**
220f2bd9
MP
81 * Common scan patterns (defined in ivi_common.c)
82 */
9c6b3b97
MP
83extern const uint8_t ff_ivi_vertical_scan_8x8[64];
84extern const uint8_t ff_ivi_horizontal_scan_8x8[64];
85extern const uint8_t ff_ivi_direct_scan_4x4[16];
220f2bd9
MP
86
87
88/**
c404e783
MP
89 * Declare inverse transform function types
90 */
746c56b7
DB
91typedef void (InvTransformPtr)(const int32_t *in, int16_t *out, ptrdiff_t pitch, const uint8_t *flags);
92typedef void (DCTransformPtr) (const int32_t *in, int16_t *out, ptrdiff_t pitch, int blk_size);
c404e783
MP
93
94
95/**
1cf31685
KS
96 * run-value (RLE) table descriptor
97 */
e4cbf752 98typedef struct RVMapDesc {
1cf31685
KS
99 uint8_t eob_sym; ///< end of block symbol
100 uint8_t esc_sym; ///< escape symbol
101 uint8_t runtab[256];
102 int8_t valtab[256];
103} RVMapDesc;
104
105extern const RVMapDesc ff_ivi_rvmap_tabs[9];
106
107
108/**
109 * information for Indeo macroblock (16x16, 8x8 or 4x4)
110 */
e4cbf752 111typedef struct IVIMbInfo {
1cf31685
KS
112 int16_t xpos;
113 int16_t ypos;
114 uint32_t buf_offs; ///< address in the output buffer for this mb
115 uint8_t type; ///< macroblock type: 0 - INTRA, 1 - INTER
116 uint8_t cbp; ///< coded block pattern
15f9fa3d 117 int8_t q_delta; ///< quant delta
1cf31685
KS
118 int8_t mv_x; ///< motion vector (x component)
119 int8_t mv_y; ///< motion vector (y component)
5ec6d152
DA
120 int8_t b_mv_x; ///< second motion vector (x component)
121 int8_t b_mv_y; ///< second motion vector (y component)
1cf31685
KS
122} IVIMbInfo;
123
124
125/**
126 * information for Indeo tile
127 */
e4cbf752 128typedef struct IVITile {
1cf31685
KS
129 int xpos;
130 int ypos;
131 int width;
132 int height;
a6e4ac40 133 int mb_size;
1cf31685
KS
134 int is_empty; ///< = 1 if this tile doesn't contain any data
135 int data_size; ///< size of the data in bytes
136 int num_MBs; ///< number of macroblocks in this tile
137 IVIMbInfo *mbs; ///< array of macroblock descriptors
138 IVIMbInfo *ref_mbs; ///< ptr to the macroblock descriptors of the reference tile
139} IVITile;
140
141
142/**
143 * information for Indeo wavelet band
144 */
e4cbf752 145typedef struct IVIBandDesc {
1cf31685
KS
146 int plane; ///< plane number this band belongs to
147 int band_num; ///< band number
148 int width;
149 int height;
cf61aaac 150 int aheight; ///< aligned band height
1cf31685
KS
151 const uint8_t *data_ptr; ///< ptr to the first byte of the band data
152 int data_size; ///< size of the band data
153 int16_t *buf; ///< pointer to the output buffer for this band
154 int16_t *ref_buf; ///< pointer to the reference frame buffer (for motion compensation)
5ec6d152
DA
155 int16_t *b_ref_buf; ///< pointer to the second reference frame buffer (for motion compensation)
156 int16_t *bufs[4]; ///< array of pointers to the band buffers
746c56b7 157 ptrdiff_t pitch; ///< pitch associated with the buffers above
1cf31685
KS
158 int is_empty; ///< = 1 if this band doesn't contain any data
159 int mb_size; ///< macroblock size
160 int blk_size; ///< block size
161 int is_halfpel; ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
162 int inherit_mv; ///< tells if motion vector is inherited from reference macroblock
163 int inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
164 int qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
165 int quant_mat; ///< dequant matrix index
166 int glob_quant; ///< quant base for this band
167 const uint8_t *scan; ///< ptr to the scan pattern
168
e322aace 169 IVIHuffTab blk_vlc; ///< vlc table for decoding block data
1cf31685 170
1cf31685
KS
171 int num_corr; ///< number of correction entries
172 uint8_t corr[61*2]; ///< rvmap correction pairs
173 int rvmap_sel; ///< rvmap table selector
174 RVMapDesc *rv_map; ///< ptr to the RLE table for this band
175 int num_tiles; ///< number of tiles in this band
176 IVITile *tiles; ///< array of tile descriptors
c404e783 177 InvTransformPtr *inv_transform;
dc796851 178 int transform_size;
c404e783 179 DCTransformPtr *dc_transform;
1cf31685
KS
180 int is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform is used
181 int32_t checksum; ///< for debug purposes
182 int checksum_present;
183 int bufsize; ///< band buffer size in bytes
0933f558
MP
184 const uint16_t *intra_base; ///< quantization matrix for intra blocks
185 const uint16_t *inter_base; ///< quantization matrix for inter blocks
1cf31685
KS
186 const uint8_t *intra_scale; ///< quantization coefficient for intra blocks
187 const uint8_t *inter_scale; ///< quantization coefficient for inter blocks
188} IVIBandDesc;
189
190
191/**
192 * color plane (luma or chroma) information
193 */
e4cbf752 194typedef struct IVIPlaneDesc {
1cf31685
KS
195 uint16_t width;
196 uint16_t height;
197 uint8_t num_bands; ///< number of bands this plane subdivided into
198 IVIBandDesc *bands; ///< array of band descriptors
199} IVIPlaneDesc;
200
201
e4cbf752 202typedef struct IVIPicConfig {
1cf31685
KS
203 uint16_t pic_width;
204 uint16_t pic_height;
205 uint16_t chroma_width;
206 uint16_t chroma_height;
207 uint16_t tile_width;
208 uint16_t tile_height;
209 uint8_t luma_bands;
210 uint8_t chroma_bands;
211} IVIPicConfig;
212
aa372cf4 213typedef struct IVI45DecContext {
c3defda0 214 BitstreamContext bc;
aa372cf4
KS
215 RVMapDesc rvmap_tabs[9]; ///< local corrected copy of the static rvmap tables
216
217 uint32_t frame_num;
218 int frame_type;
219 int prev_frame_type; ///< frame type of the previous frame
220 uint32_t data_size; ///< size of the frame data in bytes from picture header
221 int is_scalable;
aa372cf4
KS
222 const uint8_t *frame_data; ///< input frame data pointer
223 int inter_scal; ///< signals a sequence of scalable inter frames
224 uint32_t frame_size; ///< frame size in bytes
225 uint32_t pic_hdr_size; ///< picture header size in bytes
226 uint8_t frame_flags;
227 uint16_t checksum; ///< frame checksum
228
229 IVIPicConfig pic_conf;
230 IVIPlaneDesc planes[3]; ///< color planes
231
232 int buf_switch; ///< used to switch between three buffers
233 int dst_buf; ///< buffer index for the currently decoded frame
234 int ref_buf; ///< inter frame reference buffer index
235 int ref2_buf; ///< temporal storage for switching buffers
5ec6d152 236 int b_ref_buf; ///< second reference frame buffer index
aa372cf4
KS
237
238 IVIHuffTab mb_vlc; ///< current macroblock table descriptor
239 IVIHuffTab blk_vlc; ///< current block table descriptor
240
241 uint8_t rvmap_sel;
242 uint8_t in_imf;
243 uint8_t in_q; ///< flag for explicitly stored quantiser delta
244 uint8_t pic_glob_quant;
245 uint8_t unknown1;
246
247 uint16_t gop_hdr_size;
248 uint8_t gop_flags;
249 uint32_t lock_word;
250
6202e2fe 251 int show_indeo4_info;
aa372cf4 252 uint8_t has_b_frames;
64250d94 253 uint8_t has_transp; ///< transparency mode status: 1 - enabled
aa372cf4
KS
254 uint8_t uses_tiling;
255 uint8_t uses_haar;
256 uint8_t uses_fullpel;
aa372cf4
KS
257
258 int (*decode_pic_hdr) (struct IVI45DecContext *ctx, AVCodecContext *avctx);
259 int (*decode_band_hdr) (struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx);
260 int (*decode_mb_info) (struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx);
261 void (*switch_buffers) (struct IVI45DecContext *ctx);
262 int (*is_nonnull_frame)(struct IVI45DecContext *ctx);
89191843
MN
263
264 int gop_invalid;
f76e3669 265
e121ac63
DA
266 int is_indeo4;
267
f76e3669
DA
268 AVFrame *p_frame;
269 int got_p_frame;
aa372cf4
KS
270} IVI45DecContext;
271
49bd8e4b 272/** compare some properties of two pictures */
1cf31685
KS
273static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
274{
d4b63054
DB
275 return str1->pic_width != str2->pic_width || str1->pic_height != str2->pic_height ||
276 str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
277 str1->tile_width != str2->tile_width || str1->tile_height != str2->tile_height ||
278 str1->luma_bands != str2->luma_bands || str1->chroma_bands != str2->chroma_bands;
1cf31685
KS
279}
280
281/** calculate number of tiles in a stride */
282#define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
283
284/** calculate number of macroblocks in a tile */
285#define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
286 ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
287
288/** convert unsigned values into signed ones (the sign is in the LSB) */
1cf31685
KS
289#define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
290
49bd8e4b 291/** scale motion vector */
1cf31685
KS
292static inline int ivi_scale_mv(int mv, int mv_scale)
293{
294 return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
295}
296
297/**
49bd8e4b 298 * Initialize static codes used for macroblock and block decoding.
9068f36d 299 */
4982a77e 300void ff_ivi_init_static_vlc(void);
9068f36d
KS
301
302/**
49bd8e4b
MR
303 * Decode a huffman codebook descriptor from the bitstream
304 * and select specified huffman table.
1cf31685 305 *
c3defda0 306 * @param[in,out] bc the Bitstream context
0c733da8
DB
307 * @param[in] desc_coded flag signalling if table descriptor was coded
308 * @param[in] which_tab codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
309 * @param[out] huff_tab pointer to the descriptor of the selected table
310 * @param[in] avctx AVCodecContext pointer
e322aace 311 * @return zero on success, negative value otherwise
1cf31685 312 */
c3defda0 313int ff_ivi_dec_huff_desc(BitstreamContext *bc, int desc_coded, int which_tab,
e322aace 314 IVIHuffTab *huff_tab, AVCodecContext *avctx);
1cf31685
KS
315
316/**
49bd8e4b 317 * Initialize planes (prepares descriptors, allocates buffers etc).
1cf31685 318 *
5ec6d152
DA
319 * @param[in,out] planes pointer to the array of the plane descriptors
320 * @param[in] cfg pointer to the ivi_pic_config structure describing picture layout
321 * @param[in] is_indeo4 flag signalling if it is Indeo 4 or not
1cf31685
KS
322 * @return result code: 0 - OK
323 */
5ec6d152
DA
324int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg,
325 int is_indeo4);
1cf31685
KS
326
327/**
49bd8e4b 328 * Initialize tile and macroblock descriptors.
1cf31685 329 *
0c733da8
DB
330 * @param[in,out] planes pointer to the array of the plane descriptors
331 * @param[in] tile_width tile width
332 * @param[in] tile_height tile height
1cf31685
KS
333 * @return result code: 0 - OK
334 */
335int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
336
df9b9567 337int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
aa372cf4 338 AVPacket *avpkt);
94ee7da0 339int ff_ivi_decode_close(AVCodecContext *avctx);
aa372cf4 340
23944d29 341#endif /* AVCODEC_IVI_H */