git.sesse.net Git - ffmpeg/blob - 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 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
  38 /**
  39  *  huffman codebook descriptor
  40  */
  41 typedef struct {
  42     int32_t     num_rows;
  43     uint8_t     xbits[16];
  44 } IVIHuffDesc;
  45
  46 /**
  47  *  macroblock/block huffman table descriptor
  48  */
  49 typedef struct {
  50     int32_t     tab_sel;    /// index of one of the predefined tables
  51                             /// or "7" for custom one
  52     VLC         *tab;       /// pointer to the table associated with tab_sel
  53
  54     /// the following are used only when tab_sel == 7
  55     IVIHuffDesc cust_desc;  /// custom Huffman codebook descriptor
  56     VLC         cust_tab;   /// vlc table for custom codebook
  57 } IVIHuffTab;
  58
  59 enum {
  60     IVI_MB_HUFF   = 0,      /// Huffman table is used for coding macroblocks
  61     IVI_BLK_HUFF  = 1       /// Huffman table is used for coding blocks
  62 };
  63
  64 extern VLC ff_ivi_mb_vlc_tabs [8]; ///< static macroblock Huffman tables
  65 extern VLC ff_ivi_blk_vlc_tabs[8]; ///< static block Huffman tables
  66
  67
  68 /**
  69  *  Common scan patterns (defined in ivi_common.c)
  70  */
  71 extern const uint8_t ff_ivi_vertical_scan_8x8[64];
  72 extern const uint8_t ff_ivi_horizontal_scan_8x8[64];
  73 extern const uint8_t ff_ivi_direct_scan_4x4[16];
  74
  75
  76 /**
  77  *  Declare inverse transform function types
  78  */
  79 typedef void (InvTransformPtr)(const int32_t *in, int16_t *out, uint32_t pitch, const uint8_t *flags);
  80 typedef void (DCTransformPtr) (const int32_t *in, int16_t *out, uint32_t pitch, int blk_size);
  81
  82
  83 /**
  84  *  run-value (RLE) table descriptor
  85  */
  86 typedef struct {
  87     uint8_t     eob_sym; ///< end of block symbol
  88     uint8_t     esc_sym; ///< escape symbol
  89     uint8_t     runtab[256];
  90     int8_t      valtab[256];
  91 } RVMapDesc;
  92
  93 extern const RVMapDesc ff_ivi_rvmap_tabs[9];
  94
  95
  96 /**
  97  *  information for Indeo macroblock (16x16, 8x8 or 4x4)
  98  */
  99 typedef struct {
 100     int16_t     xpos;
 101     int16_t     ypos;
 102     uint32_t    buf_offs; ///< address in the output buffer for this mb
 103     uint8_t     type;     ///< macroblock type: 0 - INTRA, 1 - INTER
 104     uint8_t     cbp;      ///< coded block pattern
 105     int8_t      q_delta;  ///< quant delta
 106     int8_t      mv_x;     ///< motion vector (x component)
 107     int8_t      mv_y;     ///< motion vector (y component)
 108 } IVIMbInfo;
 109
 110
 111 /**
 112  *  information for Indeo tile
 113  */
 114 typedef struct {
 115     int         xpos;
 116     int         ypos;
 117     int         width;
 118     int         height;
 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 {
 131     int             plane;          ///< plane number this band belongs to
 132     int             band_num;       ///< band number
 133     int             width;
 134     int             height;
 135     const uint8_t   *data_ptr;      ///< ptr to the first byte of the band data
 136     int             data_size;      ///< size of the band data
 137     int16_t         *buf;           ///< pointer to the output buffer for this band
 138     int16_t         *ref_buf;       ///< pointer to the reference frame buffer (for motion compensation)
 139     int16_t         *bufs[3];       ///< array of pointers to the band buffers
 140     int             pitch;          ///< pitch associated with the buffers above
 141     int             is_empty;       ///< = 1 if this band doesn't contain any data
 142     int             mb_size;        ///< macroblock size
 143     int             blk_size;       ///< block size
 144     int             is_halfpel;     ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
 145     int             inherit_mv;     ///< tells if motion vector is inherited from reference macroblock
 146     int             inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
 147     int             qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
 148     int             quant_mat;      ///< dequant matrix index
 149     int             glob_quant;     ///< quant base for this band
 150     const uint8_t   *scan;          ///< ptr to the scan pattern
 151
 152     IVIHuffTab      blk_vlc;        ///< vlc table for decoding block data
 153
 154     int             num_corr;       ///< number of correction entries
 155     uint8_t         corr[61*2];     ///< rvmap correction pairs
 156     int             rvmap_sel;      ///< rvmap table selector
 157     RVMapDesc       *rv_map;        ///< ptr to the RLE table for this band
 158     int             num_tiles;      ///< number of tiles in this band
 159     IVITile         *tiles;         ///< array of tile descriptors
 160     InvTransformPtr *inv_transform;
 161     DCTransformPtr  *dc_transform;
 162     int             is_2d_trans;    ///< 1 indicates that the two-dimensional inverse transform is used
 163     int             transform_size; ///< block size of the transform
 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 {
 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 {
 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 /** compare some properties of two pictures */
 197 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
 198 {
 199     return str1->pic_width    != str2->pic_width    || str1->pic_height    != str2->pic_height    ||
 200            str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
 201            str1->tile_width   != str2->tile_width   || str1->tile_height   != str2->tile_height   ||
 202            str1->luma_bands   != str2->luma_bands   || str1->chroma_bands  != str2->chroma_bands;
 203 }
 204
 205 /** calculate number of tiles in a stride */
 206 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
 207
 208 /** calculate number of macroblocks in a tile */
 209 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
 210     ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
 211
 212 /** convert unsigned values into signed ones (the sign is in the LSB) */
 213 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
 214
 215 /** scale motion vector */
 216 static inline int ivi_scale_mv(int mv, int mv_scale)
 217 {
 218     return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
 219 }
 220
 221 /**
 222  *  Generate a huffman codebook from the given descriptor
 223  *  and convert it into the FFmpeg VLC table.
 224  *
 225  *  @param[in]   cb    pointer to codebook descriptor
 226  *  @param[out]  vlc   where to place the generated VLC table
 227  *  @param[in]   flag  flag: 1 - for static or 0 for dynamic tables
 228  *  @return     result code: 0 - OK, -1 = error (invalid codebook descriptor)
 229  */
 230 int  ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
 231
 232 /**
 233  * Initialize static codes used for macroblock and block decoding.
 234  */
 235 void ff_ivi_init_static_vlc(void);
 236
 237 /**
 238  *  Decode a huffman codebook descriptor from the bitstream
 239  *  and select specified huffman table.
 240  *
 241  *  @param[in,out]  gb          the GetBit context
 242  *  @param[in]      desc_coded  flag signalling if table descriptor was coded
 243  *  @param[in]      which_tab   codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
 244  *  @param[out]     huff_tab    pointer to the descriptor of the selected table
 245  *  @param[in]      avctx       AVCodecContext pointer
 246  *  @return             zero on success, negative value otherwise
 247  */
 248 int  ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
 249                           IVIHuffTab *huff_tab, AVCodecContext *avctx);
 250
 251 /**
 252  *  Compare two huffman codebook descriptors.
 253  *
 254  *  @param[in]  desc1  ptr to the 1st descriptor to compare
 255  *  @param[in]  desc2  ptr to the 2nd descriptor to compare
 256  *  @return         comparison result: 0 - equal, 1 - not equal
 257  */
 258 int  ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
 259
 260 /**
 261  *  Copy huffman codebook descriptors.
 262  *
 263  *  @param[out]  dst  ptr to the destination descriptor
 264  *  @param[in]   src  ptr to the source descriptor
 265  */
 266 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
 267
 268 /**
 269  *  Initialize planes (prepares descriptors, allocates buffers etc).
 270  *
 271  *  @param[in,out]  planes  pointer to the array of the plane descriptors
 272  *  @param[in]      cfg     pointer to the ivi_pic_config structure describing picture layout
 273  *  @return             result code: 0 - OK
 274  */
 275 int  ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
 276
 277 /**
 278  *  Free planes, bands and macroblocks buffers.
 279  *
 280  *  @param[in]  planes  pointer to the array of the plane descriptors
 281  */
 282 void ff_ivi_free_buffers(IVIPlaneDesc *planes);
 283
 284 /**
 285  *  Initialize tile and macroblock descriptors.
 286  *
 287  *  @param[in,out]  planes       pointer to the array of the plane descriptors
 288  *  @param[in]      tile_width   tile width
 289  *  @param[in]      tile_height  tile height
 290  *  @return             result code: 0 - OK
 291  */
 292 int  ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
 293
 294 /**
 295  *  Decode size of the tile data.
 296  *  The size is stored as a variable-length field having the following format:
 297  *  if (tile_data_size < 255) than this field is only one byte long
 298  *  if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
 299  *  where X1-X3 is size of the tile data
 300  *
 301  *  @param[in,out]  gb  the GetBit context
 302  *  @return     size of the tile data in bytes
 303  */
 304 int  ff_ivi_dec_tile_data_size(GetBitContext *gb);
 305
 306 /**
 307  *  Decode block data:
 308  *  extract huffman-coded transform coefficients from the bitstream,
 309  *  dequantize them, apply inverse transform and motion compensation
 310  *  in order to reconstruct the picture.
 311  *
 312  *  @param[in,out]  gb    the GetBit context
 313  *  @param[in]      band  pointer to the band descriptor
 314  *  @param[in]      tile  pointer to the tile descriptor
 315  *  @return     result code: 0 - OK, -1 = error (corrupted blocks data)
 316  */
 317 int  ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
 318
 319 /**
 320  *  Handle empty tiles by performing data copying and motion
 321  *  compensation respectively.
 322  *
 323  *  @param[in]  avctx     ptr to the AVCodecContext
 324  *  @param[in]  band      pointer to the band descriptor
 325  *  @param[in]  tile      pointer to the tile descriptor
 326  *  @param[in]  mv_scale  scaling factor for motion vectors
 327  */
 328 void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
 329                                IVITile *tile, int32_t mv_scale);
 330
 331 /**
 332  *  Convert and output the current plane.
 333  *  This conversion is done by adding back the bias value of 128
 334  *  (subtracted in the encoder) and clipping the result.
 335  *
 336  *  @param[in]   plane      pointer to the descriptor of the plane being processed
 337  *  @param[out]  dst        pointer to the buffer receiving converted pixels
 338  *  @param[in]   dst_pitch  pitch for moving to the next y line
 339  */
 340 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
 341
 342 /**
 343  *  Calculate band checksum from band data.
 344  */
 345 uint16_t ivi_calc_band_checksum (IVIBandDesc *band);
 346
 347 /**
 348  *  Verify that band data lies in range.
 349  */
 350 int ivi_check_band (IVIBandDesc *band, const uint8_t *ref, int pitch);
 351
 352 #endif /* AVCODEC_IVI_COMMON_H */