ivi_common.h File Reference

This file contains structures and macros shared by both Indeo4 and Indeo5 decoders. More...

#include "avcodec.h"
#include "get_bits.h"
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  IVIHuffDesc
 huffman codebook descriptor More...
struct  IVIHuffTab
 macroblock/block huffman table descriptor More...
struct  RVMapDesc
 run-value (RLE) table descriptor More...
struct  IVIMbInfo
 information for Indeo macroblock (16x16, 8x8 or 4x4) More...
struct  IVITile
 information for Indeo tile More...
struct  IVIBandDesc
 information for Indeo wavelet band More...
struct  IVIPlaneDesc
 color plane (luma or chroma) information More...
struct  IVIPicConfig
struct  IVI45DecContext

Macros

#define IVI_VLC_BITS   13
 max number of bits of the ivi's huffman codes
#define IVI4_STREAM_ANALYSER   0
#define IVI5_IS_PROTECTED   0x20
#define IVI_NUM_TILES(stride, tile_size)   (((stride) + (tile_size) - 1) / (tile_size))
 calculate number of tiles in a stride
#define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size)   ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
 calculate number of macroblocks in a tile
#define IVI_TOSIGNED(val)   (-(((val) >> 1) ^ -((val) & 1)))
 convert unsigned values into signed ones (the sign is in the LSB)

Typedefs

typedef voidInvTransformPtr )(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags)
 Declare inverse transform function types.
typedef voidDCTransformPtr )(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size)
typedef struct IVI45DecContext IVI45DecContext

Enumerations

enum  { IVI_MB_HUFF = 0, IVI_BLK_HUFF = 1 }

Functions

static int ivi_pic_config_cmp (IVIPicConfig *str1, IVIPicConfig *str2)
 compare some properties of two pictures
static int ivi_scale_mv (int mv, int mv_scale)
 scale motion vector
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.
void ff_ivi_init_static_vlc (void)
 Initialize static codes used for macroblock and block decoding.
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.
int ff_ivi_huff_desc_cmp (const IVIHuffDesc *desc1, const IVIHuffDesc *desc2)
 Compare two huffman codebook descriptors.
void ff_ivi_huff_desc_copy (IVIHuffDesc *dst, const IVIHuffDesc *src)
 Copy huffman codebook descriptors.
int ff_ivi_init_planes (IVIPlaneDesc *planes, const IVIPicConfig *cfg)
 Initialize planes (prepares descriptors, allocates buffers etc).
void ff_ivi_free_buffers (IVIPlaneDesc *planes)
 Free planes, bands and macroblocks buffers.
int ff_ivi_init_tiles (IVIPlaneDesc *planes, int tile_width, int tile_height)
 Initialize tile and macroblock descriptors.
int ff_ivi_dec_tile_data_size (GetBitContext *gb)
 Decode size of the tile data.
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.
void ff_ivi_output_plane (IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch)
 Convert and output the current plane.
uint16_t ivi_calc_band_checksum (IVIBandDesc *band)
 Calculate band checksum from band data.
int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch)
 Verify that band data lies in range.
int ff_ivi_decode_frame (AVCodecContext *avctx, void *data, int *data_size, AVPacket *avpkt)
av_cold int ff_ivi_decode_close (AVCodecContext *avctx)
 Close Indeo5 decoder and clean up its context.

Variables

VLC ff_ivi_mb_vlc_tabs [8]
 static macroblock Huffman tables
VLC ff_ivi_blk_vlc_tabs [8]
 static block Huffman tables
const uint8_t ff_ivi_vertical_scan_8x8 [64]
 Common scan patterns (defined in ivi_common.c)
const uint8_t ff_ivi_horizontal_scan_8x8 [64]
const uint8_t ff_ivi_direct_scan_4x4 [16]
const RVMapDesc ff_ivi_rvmap_tabs [9]
 Run-value (RLE) tables.

Detailed Description

This file contains structures and macros shared by both Indeo4 and Indeo5 decoders.

Definition in file ivi_common.h.

Macro Definition Documentation

#define IVI4_STREAM_ANALYSER   0

Definition at line 37 of file ivi_common.h.

#define IVI5_IS_PROTECTED   0x20

Definition at line 38 of file ivi_common.h.

Referenced by decode_gop_header(), and ff_ivi_decode_frame().

#define IVI_MBs_PER_TILE (   tile_width,
  tile_height,
  mb_size 
)    ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))

calculate number of macroblocks in a tile

Definition at line 269 of file ivi_common.h.

Referenced by decode_mb_info(), ivi_init_tiles(), and ivi_process_empty_tile().

#define IVI_NUM_TILES (   stride,
  tile_size 
)    (((stride) + (tile_size) - 1) / (tile_size))

calculate number of tiles in a stride

Definition at line 266 of file ivi_common.h.

Referenced by ff_ivi_init_tiles().

#define IVI_TOSIGNED (   val)    (-(((val) >> 1) ^ -((val) & 1)))

convert unsigned values into signed ones (the sign is in the LSB)

Definition at line 273 of file ivi_common.h.

Referenced by decode_mb_info(), and ivi_decode_coded_blocks().

#define IVI_VLC_BITS   13

max number of bits of the ivi's huffman codes

Definition at line 36 of file ivi_common.h.

Referenced by decode_mb_info(), ff_ivi_create_huff_from_desc(), and ivi_decode_coded_blocks().

Typedef Documentation

typedef void( DCTransformPtr)(const int32_t *in, int16_t *out, uint32_t pitch, int blk_size)

Definition at line 82 of file ivi_common.h.

typedef void( InvTransformPtr)(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags)

Declare inverse transform function types.

Definition at line 81 of file ivi_common.h.

Enumeration Type Documentation

anonymous enum
Enumerator:
IVI_MB_HUFF 
IVI_BLK_HUFF 

Huffman table is used for coding macroblocks.

Definition at line 61 of file ivi_common.h.

Function Documentation

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.

Parameters
[in]cbpointer to codebook descriptor
[out]vlcwhere to place the generated VLC table
[in]flagflag: 1 - for static or 0 for dynamic tables
Returns
result code: 0 - OK, -1 = error (invalid codebook descriptor)

Definition at line 83 of file ivi_common.c.

Referenced by ff_ivi_dec_huff_desc(), and ff_ivi_init_static_vlc().

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.

Parameters
[in,out]gbthe GetBit context
[in]desc_codedflag signalling if table descriptor was coded
[in]which_tabcodebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
[out]huff_tabpointer to the descriptor of the selected table
[in]avctxAVCodecContext pointer
Returns
zero on success, negative value otherwise

Definition at line 138 of file ivi_common.c.

Referenced by decode_band_hdr(), and decode_pic_hdr().

int ff_ivi_dec_tile_data_size ( GetBitContext gb)

Decode size of the tile data.

The size is stored as a variable-length field having the following format: if (tile_data_size < 255) than this field is only one byte long if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3 where X1-X3 is size of the tile data

Parameters
[in,out]gbthe GetBit context
Returns
size of the tile data in bytes

Definition at line 365 of file ivi_common.c.

Referenced by decode_band().

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.

Parameters
[in,out]gbthe GetBit context
[in]bandpointer to the band descriptor
[in]tilepointer to the tile descriptor
Returns
result code: 0 - OK, -1 = error (corrupted blocks data)

Definition at line 486 of file ivi_common.c.

Referenced by decode_band().

av_cold int ff_ivi_decode_close ( AVCodecContext avctx)

Close Indeo5 decoder and clean up its context.

Definition at line 970 of file ivi_common.c.

int ff_ivi_decode_frame ( AVCodecContext avctx,
void data,
int *  data_size,
AVPacket avpkt 
)

Definition at line 870 of file ivi_common.c.

void ff_ivi_free_buffers ( IVIPlaneDesc planes)

Free planes, bands and macroblocks buffers.

Parameters
[in]planespointer to the array of the plane descriptors

Definition at line 270 of file ivi_common.c.

Referenced by ff_ivi_decode_close(), and ff_ivi_init_planes().

int ff_ivi_huff_desc_cmp ( const IVIHuffDesc desc1,
const IVIHuffDesc desc2 
)

Compare two huffman codebook descriptors.

Parameters
[in]desc1ptr to the 1st descriptor to compare
[in]desc2ptr to the 2nd descriptor to compare
Returns
comparison result: 0 - equal, 1 - not equal

Definition at line 188 of file ivi_common.c.

Referenced by ff_ivi_dec_huff_desc().

void ff_ivi_huff_desc_copy ( IVIHuffDesc dst,
const IVIHuffDesc src 
)

Copy huffman codebook descriptors.

Parameters
[out]dstptr to the destination descriptor
[in]srcptr to the source descriptor

Definition at line 194 of file ivi_common.c.

Referenced by ff_ivi_dec_huff_desc().

int ff_ivi_init_planes ( IVIPlaneDesc planes,
const IVIPicConfig cfg 
)

Initialize planes (prepares descriptors, allocates buffers etc).

Parameters
[in,out]planespointer to the array of the plane descriptors
[in]cfgpointer to the ivi_pic_config structure describing picture layout
Returns
result code: 0 - OK

Definition at line 200 of file ivi_common.c.

Referenced by decode_gop_header(), decode_init(), and decode_pic_hdr().

void ff_ivi_init_static_vlc ( void  )

Initialize static codes used for macroblock and block decoding.

Definition at line 117 of file ivi_common.c.

Referenced by decode_init().

int ff_ivi_init_tiles ( IVIPlaneDesc planes,
int  tile_width,
int  tile_height 
)

Initialize tile and macroblock descriptors.

Parameters
[in,out]planespointer to the array of the plane descriptors
[in]tile_widthtile width
[in]tile_heighttile height
Returns
result code: 0 - OK

Definition at line 328 of file ivi_common.c.

Referenced by decode_gop_header(), and decode_pic_hdr().

void ff_ivi_output_plane ( IVIPlaneDesc plane,
uint8_t *  dst,
int  dst_pitch 
)

Convert and output the current plane.

This conversion is done by adding back the bias value of 128 (subtracted in the encoder) and clipping the result.

Parameters
[in]planepointer to the descriptor of the plane being processed
[out]dstpointer to the buffer receiving converted pixels
[in]dst_pitchpitch for moving to the next y line

Definition at line 741 of file ivi_common.c.

Referenced by ff_ivi_decode_frame().

uint16_t ivi_calc_band_checksum ( IVIBandDesc band)

Calculate band checksum from band data.

Referenced by decode_band().

int ivi_check_band ( IVIBandDesc band,
const uint8_t *  ref,
int  pitch 
)

Verify that band data lies in range.

static int ivi_pic_config_cmp ( IVIPicConfig str1,
IVIPicConfig str2 
)
inlinestatic

compare some properties of two pictures

Definition at line 257 of file ivi_common.h.

Referenced by decode_gop_header(), and decode_pic_hdr().

static int ivi_scale_mv ( int  mv,
int  mv_scale 
)
inlinestatic

scale motion vector

Definition at line 276 of file ivi_common.h.

Referenced by decode_mb_info(), and ivi_process_empty_tile().

Variable Documentation

VLC ff_ivi_blk_vlc_tabs[8]

static block Huffman tables

Definition at line 41 of file ivi_common.c.

const uint8_t ff_ivi_direct_scan_4x4[16]

Definition at line 1057 of file ivi_common.c.

Referenced by decode_gop_header().

const uint8_t ff_ivi_horizontal_scan_8x8[64]

Definition at line 1046 of file ivi_common.c.

Referenced by decode_gop_header().

VLC ff_ivi_mb_vlc_tabs[8]

static macroblock Huffman tables

Definition at line 40 of file ivi_common.c.

const RVMapDesc ff_ivi_rvmap_tabs[9]

Run-value (RLE) tables.

Definition at line 1065 of file ivi_common.c.

Referenced by decode_init().

const uint8_t ff_ivi_vertical_scan_8x8[64]

Common scan patterns (defined in ivi_common.c)

Definition at line 1035 of file ivi_common.c.

Referenced by decode_gop_header().