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 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 
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
37 #define IVI4_STREAM_ANALYSER 0
38 #define IVI5_IS_PROTECTED 0x20
39 
43 typedef struct {
44  int32_t num_rows;
45  uint8_t xbits[16];
46 } IVIHuffDesc;
47 
51 typedef struct {
52  int32_t tab_sel;
53  VLC *tab;
55 
59 } IVIHuffTab;
60 
61 enum {
64 };
65 
66 extern VLC ff_ivi_mb_vlc_tabs [8];
67 extern VLC ff_ivi_blk_vlc_tabs[8];
68 
69 
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 
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 
88 typedef struct {
89  uint8_t eob_sym;
90  uint8_t esc_sym;
91  uint8_t runtab[256];
92  int8_t valtab[256];
93 } RVMapDesc;
94 
95 extern const RVMapDesc ff_ivi_rvmap_tabs[9];
96 
97 
101 typedef struct {
102  int16_t xpos;
103  int16_t ypos;
104  uint32_t buf_offs;
105  uint8_t type;
106  uint8_t cbp;
107  int8_t q_delta;
108  int8_t mv_x;
109  int8_t mv_y;
110 } IVIMbInfo;
111 
112 
116 typedef struct {
117  int xpos;
118  int ypos;
119  int width;
120  int height;
121  int mb_size;
122  int is_empty;
123  int data_size;
124  int num_MBs;
127 } IVITile;
128 
129 
133 typedef struct {
134  int plane;
135  int band_num;
136  int width;
137  int height;
138  int aheight;
139  const uint8_t *data_ptr;
140  int data_size;
141  int16_t *buf;
142  int16_t *ref_buf;
143  int16_t *bufs[3];
144  int pitch;
145  int is_empty;
146  int mb_size;
147  int blk_size;
152  int quant_mat;
154  const uint8_t *scan;
155 
157 
158  int num_corr;
159  uint8_t corr[61*2];
160  int rvmap_sel;
162  int num_tiles;
168  int32_t checksum;
170  int bufsize;
171  const uint16_t *intra_base;
172  const uint16_t *inter_base;
173  const uint8_t *intra_scale;
174  const uint8_t *inter_scale;
175 } IVIBandDesc;
176 
177 
181 typedef struct {
182  uint16_t width;
183  uint16_t height;
184  uint8_t num_bands;
186 } IVIPlaneDesc;
187 
188 
189 typedef struct {
190  uint16_t pic_width;
191  uint16_t pic_height;
192  uint16_t chroma_width;
193  uint16_t chroma_height;
194  uint16_t tile_width;
195  uint16_t tile_height;
196  uint8_t luma_bands;
197  uint8_t chroma_bands;
198 } IVIPicConfig;
199 
200 typedef struct IVI45DecContext {
204 
205  uint32_t frame_num;
208  uint32_t data_size;
211  const uint8_t *frame_data;
213  uint32_t frame_size;
214  uint32_t pic_hdr_size;
215  uint8_t frame_flags;
216  uint16_t checksum;
217 
220 
222  int dst_buf;
223  int ref_buf;
224  int ref2_buf;
225 
228 
229  uint8_t rvmap_sel;
230  uint8_t in_imf;
231  uint8_t in_q;
232  uint8_t pic_glob_quant;
233  uint8_t unknown1;
234 
235  uint16_t gop_hdr_size;
236  uint8_t gop_flags;
237  uint32_t lock_word;
238 
239 #if IVI4_STREAM_ANALYSER
240  uint8_t has_b_frames;
241  uint8_t has_transp;
242  uint8_t uses_tiling;
243  uint8_t uses_haar;
244  uint8_t uses_fullpel;
245 #endif
246 
247  int (*decode_pic_hdr) (struct IVI45DecContext *ctx, AVCodecContext *avctx);
248  int (*decode_band_hdr) (struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx);
249  int (*decode_mb_info) (struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx);
251  int (*is_nonnull_frame)(struct IVI45DecContext *ctx);
252 
255 
257 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
258 {
259  return str1->pic_width != str2->pic_width || str1->pic_height != str2->pic_height ||
260  str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
261  str1->tile_width != str2->tile_width || str1->tile_height != str2->tile_height ||
262  str1->luma_bands != str2->luma_bands || str1->chroma_bands != str2->chroma_bands;
263 }
264 
266 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
267 
269 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
270  ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
271 
273 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
274 
276 static inline int ivi_scale_mv(int mv, int mv_scale)
277 {
278  return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
279 }
280 
290 int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
291 
295 void ff_ivi_init_static_vlc(void);
296 
308 int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
309  IVIHuffTab *huff_tab, AVCodecContext *avctx);
310 
318 int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
319 
326 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
327 
336 
343 
352 int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
353 
365 
378 
388 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
389 
393 uint16_t ivi_calc_band_checksum (IVIBandDesc *band);
394 
398 int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch);
399 
400 int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
401  AVPacket *avpkt);
403 
404 #endif /* AVCODEC_IVI_COMMON_H */
int is_empty
= 1 if this band doesn't contain any data
Definition: ivi_common.h:145
uint32_t data_size
size of the frame data in bytes from picture header
Definition: ivi_common.h:208
uint8_t type
macroblock type: 0 - INTRA, 1 - INTER
Definition: ivi_common.h:105
int num_MBs
number of macroblocks in this tile
Definition: ivi_common.h:124
Huffman table is used for coding macroblocks.
Definition: ivi_common.h:63
Audio Video Frame.
Definition: avcodec.h:985
macroblock/block huffman table descriptor
Definition: ivi_common.h:51
InvTransformPtr * inv_transform
Definition: ivi_common.h:164
int(* decode_pic_hdr)(struct IVI45DecContext *ctx, AVCodecContext *avctx)
Definition: ivi_common.h:247
int inter_scal
signals a sequence of scalable inter frames
Definition: ivi_common.h:212
int(* decode_mb_info)(struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx)
Definition: ivi_common.h:249
int num_tiles
number of tiles in this band
Definition: ivi_common.h:162
int dst_buf
buffer index for the currently decoded frame
Definition: ivi_common.h:222
int16_t * ref_buf
pointer to the reference frame buffer (for motion compensation)
Definition: ivi_common.h:142
uint8_t eob_sym
end of block symbol
Definition: ivi_common.h:89
int16_t * buf
pointer to the output buffer for this band
Definition: ivi_common.h:141
IVITile * tiles
array of tile descriptors
Definition: ivi_common.h:163
int is_halfpel
precision of the motion compensation: 0 - fullpel, 1 - halfpel
Definition: ivi_common.h:148
const RVMapDesc ff_ivi_rvmap_tabs[9]
Run-value (RLE) tables.
Definition: ivi_common.c:1065
uint8_t chroma_bands
Definition: ivi_common.h:197
const uint8_t ff_ivi_direct_scan_4x4[16]
Definition: ivi_common.c:1057
int plane
plane number this band belongs to
Definition: ivi_common.h:134
int mb_size
Definition: ivi_common.h:121
int bufsize
band buffer size in bytes
Definition: ivi_common.h:170
uint16_t ivi_calc_band_checksum(IVIBandDesc *band)
Calculate band checksum from band data.
IVIPicConfig pic_conf
Definition: ivi_common.h:218
void ff_ivi_init_static_vlc(void)
Initialize static codes used for macroblock and block decoding.
Definition: ivi_common.c:117
int quant_mat
dequant matrix index
Definition: ivi_common.h:152
uint16_t height
Definition: ivi_common.h:183
RVMapDesc * rv_map
ptr to the RLE table for this band
Definition: ivi_common.h:161
uint8_t luma_bands
Definition: ivi_common.h:196
#define av_cold
Definition: attributes.h:71
uint8_t pic_glob_quant
Definition: ivi_common.h:232
const uint8_t * frame_data
input frame data pointer
Definition: ivi_common.h:211
const uint16_t * inter_base
quantization matrix for inter blocks
Definition: ivi_common.h:172
const uint8_t * data_ptr
ptr to the first byte of the band data
Definition: ivi_common.h:139
uint16_t pic_height
Definition: ivi_common.h:191
const uint8_t ff_ivi_vertical_scan_8x8[64]
Common scan patterns (defined in ivi_common.c)
Definition: ivi_common.c:1035
int inherit_mv
tells if motion vector is inherited from reference macroblock
Definition: ivi_common.h:149
uint16_t tile_height
Definition: ivi_common.h:195
GetBitContext gb
Definition: ivi_common.h:201
const char data[16]
Definition: mxf.c:60
uint16_t chroma_width
Definition: ivi_common.h:192
int pitch
pitch associated with the buffers above
Definition: ivi_common.h:144
uint8_t cbp
coded block pattern
Definition: ivi_common.h:106
int qdelta_present
tells if Qdelta signal is present in the bitstream (Indeo5 only)
Definition: ivi_common.h:151
static int flags
Definition: log.c:34
uint16_t checksum
frame checksum
Definition: ivi_common.h:216
bitstream reader API header.
uint32_t pic_hdr_size
picture header size in bytes
Definition: ivi_common.h:214
uint16_t pic_width
Definition: ivi_common.h:190
IVIPlaneDesc planes[3]
color planes
Definition: ivi_common.h:219
int ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg)
Initialize planes (prepares descriptors, allocates buffers etc).
Definition: ivi_common.c:200
const uint16_t * intra_base
quantization matrix for intra blocks
Definition: ivi_common.h:171
int data_size
size of the band data
Definition: ivi_common.h:140
uint8_t unknown1
Definition: ivi_common.h:233
IVIHuffDesc cust_desc
pointer to the table associated with tab_sel
Definition: ivi_common.h:57
int blk_size
block size
Definition: ivi_common.h:147
int32_t tab_sel
Definition: ivi_common.h:52
static int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
compare some properties of two pictures
Definition: ivi_common.h:257
RVMapDesc rvmap_tabs[9]
local corrected copy of the static rvmap tables
Definition: ivi_common.h:203
VLC ff_ivi_blk_vlc_tabs[8]
static block Huffman tables
Definition: ivi_common.c:41
uint8_t in_q
flag for explicitly stored quantiser delta
Definition: ivi_common.h:231
int ref_buf
inter frame reference buffer index
Definition: ivi_common.h:223
DCTransformPtr * dc_transform
Definition: ivi_common.h:166
int ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height)
Initialize tile and macroblock descriptors.
Definition: ivi_common.c:328
int ivi_check_band(IVIBandDesc *band, const uint8_t *ref, int pitch)
Verify that band data lies in range.
int32_t num_rows
Definition: ivi_common.h:44
int ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2)
Compare two huffman codebook descriptors.
Definition: ivi_common.c:188
av_cold int ff_ivi_decode_close(AVCodecContext *avctx)
Close Indeo5 decoder and clean up its context.
Definition: ivi_common.c:970
struct IVI45DecContext IVI45DecContext
uint8_t esc_sym
escape symbol
Definition: ivi_common.h:90
uint16_t width
Definition: ivi_common.h:182
Definition: get_bits.h:63
run-value (RLE) table descriptor
Definition: ivi_common.h:88
int inherit_qdelta
tells if quantiser delta is inherited from reference macroblock
Definition: ivi_common.h:150
uint32_t frame_num
Definition: ivi_common.h:205
uint8_t num_bands
number of bands this plane subdivided into
Definition: ivi_common.h:184
int(* decode_band_hdr)(struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx)
Definition: ivi_common.h:248
IVIMbInfo * mbs
array of macroblock descriptors
Definition: ivi_common.h:125
const uint8_t * inter_scale
quantization coefficient for inter blocks
Definition: ivi_common.h:174
uint16_t chroma_height
Definition: ivi_common.h:193
uint32_t lock_word
Definition: ivi_common.h:237
int8_t q_delta
quant delta
Definition: ivi_common.h:107
VLC ff_ivi_mb_vlc_tabs[8]
static macroblock Huffman tables
Definition: ivi_common.c:40
uint32_t frame_size
frame size in bytes
Definition: ivi_common.h:213
static const int8_t mv[256][2]
Definition: 4xm.c:72
uint16_t tile_width
Definition: ivi_common.h:194
int ypos
Definition: ivi_common.h:118
IVIHuffTab mb_vlc
current macroblock table descriptor
Definition: ivi_common.h:226
int is_2d_trans
1 indicates that the two-dimensional inverse transform is used
Definition: ivi_common.h:167
external API header
int glob_quant
quant base for this band
Definition: ivi_common.h:153
int height
Definition: ivi_common.h:120
main external API structure.
Definition: avcodec.h:1329
static void(WINAPI *cond_broadcast)(pthread_cond_t *cond)
int aheight
aligned band height
Definition: ivi_common.h:138
int is_empty
= 1 if this tile doesn't contain any data
Definition: ivi_common.h:122
uint8_t frame_flags
Definition: ivi_common.h:215
int num_corr
number of correction entries
Definition: ivi_common.h:158
information for Indeo tile
Definition: ivi_common.h:116
int(* is_nonnull_frame)(struct IVI45DecContext *ctx)
Definition: ivi_common.h:251
int buf_switch
used to switch between three buffers
Definition: ivi_common.h:221
void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch)
Convert and output the current plane.
Definition: ivi_common.c:741
uint8_t in_imf
Definition: ivi_common.h:230
uint8_t gop_flags
Definition: ivi_common.h:236
void(* switch_buffers)(struct IVI45DecContext *ctx)
Definition: ivi_common.h:250
IVIBandDesc * bands
array of band descriptors
Definition: ivi_common.h:185
int32_t checksum
for debug purposes
Definition: ivi_common.h:168
int rvmap_sel
rvmap table selector
Definition: ivi_common.h:160
int8_t mv_x
motion vector (x component)
Definition: ivi_common.h:108
int8_t mv_y
motion vector (y component)
Definition: ivi_common.h:109
int mb_size
macroblock size
Definition: ivi_common.h:146
huffman codebook descriptor
Definition: ivi_common.h:43
int ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag)
Generate a huffman codebook from the given descriptor and convert it into the Libav VLC table...
Definition: ivi_common.c:83
IVIMbInfo * ref_mbs
ptr to the macroblock descriptors of the reference tile
Definition: ivi_common.h:126
int xpos
Definition: ivi_common.h:117
int ff_ivi_dec_tile_data_size(GetBitContext *gb)
Decode size of the tile data.
Definition: ivi_common.c:365
IVIHuffTab blk_vlc
current block table descriptor
Definition: ivi_common.h:227
uint16_t gop_hdr_size
Definition: ivi_common.h:235
int16_t xpos
Definition: ivi_common.h:102
void ff_ivi_free_buffers(IVIPlaneDesc *planes)
Free planes, bands and macroblocks buffers.
Definition: ivi_common.c:270
int band_num
band number
Definition: ivi_common.h:135
int transform_size
Definition: ivi_common.h:165
void( InvTransformPtr)(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags)
Declare inverse transform function types.
Definition: ivi_common.h:81
int ref2_buf
temporal storage for switching buffers
Definition: ivi_common.h:224
VLC cust_tab
custom Huffman codebook descriptor
Definition: ivi_common.h:58
const uint8_t * scan
ptr to the scan pattern
Definition: ivi_common.h:154
int ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile)
Decode block data: extract huffman-coded transform coefficients from the bitstream, dequantize them, apply inverse transform and motion compensation in order to reconstruct the picture.
Definition: ivi_common.c:486
int width
Definition: ivi_common.h:119
int checksum_present
Definition: ivi_common.h:169
static int ivi_scale_mv(int mv, int mv_scale)
scale motion vector
Definition: ivi_common.h:276
int transp_status
transparency mode status: 1 - enabled
Definition: ivi_common.h:210
static const struct @46 tab
TwinVQ codebooks.
int16_t ypos
Definition: ivi_common.h:103
int prev_frame_type
frame type of the previous frame
Definition: ivi_common.h:207
int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
Definition: ivi_common.c:870
information for Indeo macroblock (16x16, 8x8 or 4x4)
Definition: ivi_common.h:101
IVIHuffTab blk_vlc
vlc table for decoding block data
Definition: ivi_common.h:156
const uint8_t * intra_scale
quantization coefficient for intra blocks
Definition: ivi_common.h:173
color plane (luma or chroma) information
Definition: ivi_common.h:181
int ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab, IVIHuffTab *huff_tab, AVCodecContext *avctx)
Decode a huffman codebook descriptor from the bitstream and select specified huffman table...
Definition: ivi_common.c:138
uint32_t buf_offs
address in the output buffer for this mb
Definition: ivi_common.h:104
void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src)
Copy huffman codebook descriptors.
Definition: ivi_common.c:194
information for Indeo wavelet band
Definition: ivi_common.h:133
void( DCTransformPtr)(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size)
Definition: ivi_common.h:82
const uint8_t ff_ivi_horizontal_scan_8x8[64]
Definition: ivi_common.c:1046
uint8_t rvmap_sel
Definition: ivi_common.h:229
int data_size
size of the data in bytes
Definition: ivi_common.h:123