FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ivi_common.h
Go to the documentation of this file.
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_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 {
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
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  int scan_size; ///< size of the scantable
153 
154  IVIHuffTab blk_vlc; ///< vlc table for decoding block data
155 
156  int num_corr; ///< number of correction entries
157  uint8_t corr[61*2]; ///< rvmap correction pairs
158  int rvmap_sel; ///< rvmap table selector
159  RVMapDesc *rv_map; ///< ptr to the RLE table for this band
160  int num_tiles; ///< number of tiles in this band
161  IVITile *tiles; ///< array of tile descriptors
164  int is_2d_trans; ///< 1 indicates that the two-dimensional inverse transform is used
165  int transform_size; ///< block size of the transform
166  int32_t checksum; ///< for debug purposes
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 IVIPlaneDesc {
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 IVIPicConfig {
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;
196 } IVIPicConfig;
197 
198 typedef struct IVI45DecContext {
201  RVMapDesc rvmap_tabs[9]; ///< local corrected copy of the static rvmap tables
202 
203  uint32_t frame_num;
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
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
214  uint16_t checksum; ///< frame checksum
215 
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 
229  uint8_t in_q; ///< flag for explicitly stored quantiser delta
232 
233  uint16_t gop_hdr_size;
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);
249  int (*is_nonnull_frame)(struct IVI45DecContext *ctx);
250 
252  int buf_invalid[3];
254 
255 /** compare some properties of two pictures */
256 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
257 {
258  return str1->pic_width != str2->pic_width || str1->pic_height != str2->pic_height ||
259  str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
260  str1->tile_width != str2->tile_width || str1->tile_height != str2->tile_height ||
261  str1->luma_bands != str2->luma_bands || str1->chroma_bands != str2->chroma_bands;
262 }
263 
264 /** calculate number of tiles in a stride */
265 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
266 
267 /** calculate number of macroblocks in a tile */
268 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
269  ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
270 
271 /** convert unsigned values into signed ones (the sign is in the LSB) */
272 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
273 
274 /** scale motion vector */
275 static inline int ivi_scale_mv(int mv, int mv_scale)
276 {
277  return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
278 }
279 
280 /**
281  * Initialize static codes used for macroblock and block decoding.
282  */
283 void ff_ivi_init_static_vlc(void);
284 
285 /**
286  * Decode a huffman codebook descriptor from the bitstream
287  * and select specified huffman table.
288  *
289  * @param[in,out] gb the GetBit context
290  * @param[in] desc_coded flag signalling if table descriptor was coded
291  * @param[in] which_tab codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
292  * @param[out] huff_tab pointer to the descriptor of the selected table
293  * @param[in] avctx AVCodecContext pointer
294  * @return zero on success, negative value otherwise
295  */
296 int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
297  IVIHuffTab *huff_tab, AVCodecContext *avctx);
298 
299 /**
300  * Initialize planes (prepares descriptors, allocates buffers etc).
301  *
302  * @param[in,out] planes pointer to the array of the plane descriptors
303  * @param[in] cfg pointer to the ivi_pic_config structure describing picture layout
304  * @return result code: 0 - OK
305  */
307 
308 /**
309  * Initialize tile and macroblock descriptors.
310  *
311  * @param[in,out] planes pointer to the array of the plane descriptors
312  * @param[in] tile_width tile width
313  * @param[in] tile_height tile height
314  * @return result code: 0 - OK
315  */
316 int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
317 
318 int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
319  AVPacket *avpkt);
321 
322 #endif /* AVCODEC_IVI_COMMON_H */