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