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 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
  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 {
  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 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
  78 /**
  79  *  Declare inverse transform function types
  80  */
  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
  85 /**
  86  *  run-value (RLE) table descriptor
  87  */
  88 typedef struct {
  89     uint8_t     eob_sym; ///< end of block symbol
  90     uint8_t     esc_sym; ///< escape symbol
  91     uint8_t     runtab[256];
  92     int8_t      valtab[256];
  93 } RVMapDesc;
  94
  95 extern const RVMapDesc ff_ivi_rvmap_tabs[9];
  96
  97
  98 /**
  99  *  information for Indeo macroblock (16x16, 8x8 or 4x4)
 100  */
 101 typedef struct {
 102     int16_t     xpos;
 103     int16_t     ypos;
 104     uint32_t    buf_offs; ///< address in the output buffer for this mb
 105     uint8_t     type;     ///< macroblock type: 0 - INTRA, 1 - INTER
 106     uint8_t     cbp;      ///< coded block pattern
 107     int8_t      q_delta;  ///< quant delta
 108     int8_t      mv_x;     ///< motion vector (x component)
 109     int8_t      mv_y;     ///< motion vector (y component)
 110 } IVIMbInfo;
 111
 112
 113 /**
 114  *  information for Indeo tile
 115  */
 116 typedef struct {
 117     int         xpos;
 118     int         ypos;
 119     int         width;
 120     int         height;
 121     int         mb_size;
 122     int         is_empty;  ///< = 1 if this tile doesn't contain any data
 123     int         data_size; ///< size of the data in bytes
 124     int         num_MBs;   ///< number of macroblocks in this tile
 125     IVIMbInfo   *mbs;      ///< array of macroblock descriptors
 126     IVIMbInfo   *ref_mbs;  ///< ptr to the macroblock descriptors of the reference tile
 127 } IVITile;
 128
 129
 130 /**
 131  *  information for Indeo wavelet band
 132  */
 133 typedef struct {
 134     int             plane;          ///< plane number this band belongs to
 135     int             band_num;       ///< band number
 136     int             width;
 137     int             height;
 138     int             aheight;        ///< aligned band height
 139     const uint8_t   *data_ptr;      ///< ptr to the first byte of the band data
 140     int             data_size;      ///< size of the band data
 141     int16_t         *buf;           ///< pointer to the output buffer for this band
 142     int16_t         *ref_buf;       ///< pointer to the reference frame buffer (for motion compensation)
 143     int16_t         *bufs[3];       ///< array of pointers to the band buffers
 144     int             pitch;          ///< pitch associated with the buffers above
 145     int             is_empty;       ///< = 1 if this band doesn't contain any data
 146     int             mb_size;        ///< macroblock size
 147     int             blk_size;       ///< block size
 148     int             is_halfpel;     ///< precision of the motion compensation: 0 - fullpel, 1 - halfpel
 149     int             inherit_mv;     ///< tells if motion vector is inherited from reference macroblock
 150     int             inherit_qdelta; ///< tells if quantiser delta is inherited from reference macroblock
 151     int             qdelta_present; ///< tells if Qdelta signal is present in the bitstream (Indeo5 only)
 152     int             quant_mat;      ///< dequant matrix index
 153     int             glob_quant;     ///< quant base for this band
 154     const uint8_t   *scan;          ///< ptr to the scan pattern
 155
 156     IVIHuffTab      blk_vlc;        ///< vlc table for decoding block data
 157
 158     int             num_corr;       ///< number of correction entries
 159     uint8_t         corr[61*2];     ///< rvmap correction pairs
 160     int             rvmap_sel;      ///< rvmap table selector
 161     RVMapDesc       *rv_map;        ///< ptr to the RLE table for this band
 162     int             num_tiles;      ///< number of tiles in this band
 163     IVITile         *tiles;         ///< array of tile descriptors
 164     InvTransformPtr *inv_transform;
 165     DCTransformPtr  *dc_transform;
 166     int             is_2d_trans;    ///< 1 indicates that the two-dimensional inverse transform is used
 167     int32_t         checksum;       ///< for debug purposes
 168     int             checksum_present;
 169     int             bufsize;        ///< band buffer size in bytes
 170     const uint16_t  *intra_base;    ///< quantization matrix for intra blocks
 171     const uint16_t  *inter_base;    ///< quantization matrix for inter blocks
 172     const uint8_t   *intra_scale;   ///< quantization coefficient for intra blocks
 173     const uint8_t   *inter_scale;   ///< quantization coefficient for inter blocks
 174 } IVIBandDesc;
 175
 176
 177 /**
 178  *  color plane (luma or chroma) information
 179  */
 180 typedef struct {
 181     uint16_t    width;
 182     uint16_t    height;
 183     uint8_t     num_bands;  ///< number of bands this plane subdivided into
 184     IVIBandDesc *bands;     ///< array of band descriptors
 185 } IVIPlaneDesc;
 186
 187
 188 typedef struct {
 189     uint16_t    pic_width;
 190     uint16_t    pic_height;
 191     uint16_t    chroma_width;
 192     uint16_t    chroma_height;
 193     uint16_t    tile_width;
 194     uint16_t    tile_height;
 195     uint8_t     luma_bands;
 196     uint8_t     chroma_bands;
 197 } IVIPicConfig;
 198
 199 typedef struct IVI45DecContext {
 200     GetBitContext   gb;
 201     AVFrame         frame;
 202     RVMapDesc       rvmap_tabs[9];   ///< local corrected copy of the static rvmap tables
 203
 204     uint32_t        frame_num;
 205     int             frame_type;
 206     int             prev_frame_type; ///< frame type of the previous frame
 207     uint32_t        data_size;       ///< size of the frame data in bytes from picture header
 208     int             is_scalable;
 209     int             transp_status;   ///< transparency mode status: 1 - enabled
 210     const uint8_t   *frame_data;     ///< input frame data pointer
 211     int             inter_scal;      ///< signals a sequence of scalable inter frames
 212     uint32_t        frame_size;      ///< frame size in bytes
 213     uint32_t        pic_hdr_size;    ///< picture header size in bytes
 214     uint8_t         frame_flags;
 215     uint16_t        checksum;        ///< frame checksum
 216
 217     IVIPicConfig    pic_conf;
 218     IVIPlaneDesc    planes[3];       ///< color planes
 219
 220     int             buf_switch;      ///< used to switch between three buffers
 221     int             dst_buf;         ///< buffer index for the currently decoded frame
 222     int             ref_buf;         ///< inter frame reference buffer index
 223     int             ref2_buf;        ///< temporal storage for switching buffers
 224
 225     IVIHuffTab      mb_vlc;          ///< current macroblock table descriptor
 226     IVIHuffTab      blk_vlc;         ///< current block table descriptor
 227
 228     uint8_t         rvmap_sel;
 229     uint8_t         in_imf;
 230     uint8_t         in_q;            ///< flag for explicitly stored quantiser delta
 231     uint8_t         pic_glob_quant;
 232     uint8_t         unknown1;
 233
 234     uint16_t        gop_hdr_size;
 235     uint8_t         gop_flags;
 236     uint32_t        lock_word;
 237
 238 #if IVI4_STREAM_ANALYSER
 239     uint8_t         has_b_frames;
 240     uint8_t         has_transp;
 241     uint8_t         uses_tiling;
 242     uint8_t         uses_haar;
 243     uint8_t         uses_fullpel;
 244 #endif
 245
 246     int             (*decode_pic_hdr)  (struct IVI45DecContext *ctx, AVCodecContext *avctx);
 247     int             (*decode_band_hdr) (struct IVI45DecContext *ctx, IVIBandDesc *band, AVCodecContext *avctx);
 248     int             (*decode_mb_info)  (struct IVI45DecContext *ctx, IVIBandDesc *band, IVITile *tile, AVCodecContext *avctx);
 249     void            (*switch_buffers)  (struct IVI45DecContext *ctx);
 250     int             (*is_nonnull_frame)(struct IVI45DecContext *ctx);
 251 } IVI45DecContext;
 252
 253 /** compare some properties of two pictures */
 254 static inline int ivi_pic_config_cmp(IVIPicConfig *str1, IVIPicConfig *str2)
 255 {
 256     return str1->pic_width    != str2->pic_width    || str1->pic_height    != str2->pic_height    ||
 257            str1->chroma_width != str2->chroma_width || str1->chroma_height != str2->chroma_height ||
 258            str1->tile_width   != str2->tile_width   || str1->tile_height   != str2->tile_height   ||
 259            str1->luma_bands   != str2->luma_bands   || str1->chroma_bands  != str2->chroma_bands;
 260 }
 261
 262 /** calculate number of tiles in a stride */
 263 #define IVI_NUM_TILES(stride, tile_size) (((stride) + (tile_size) - 1) / (tile_size))
 264
 265 /** calculate number of macroblocks in a tile */
 266 #define IVI_MBs_PER_TILE(tile_width, tile_height, mb_size) \
 267     ((((tile_width) + (mb_size) - 1) / (mb_size)) * (((tile_height) + (mb_size) - 1) / (mb_size)))
 268
 269 /** convert unsigned values into signed ones (the sign is in the LSB) */
 270 #define IVI_TOSIGNED(val) (-(((val) >> 1) ^ -((val) & 1)))
 271
 272 /** scale motion vector */
 273 static inline int ivi_scale_mv(int mv, int mv_scale)
 274 {
 275     return (mv + (mv > 0) + (mv_scale - 1)) >> mv_scale;
 276 }
 277
 278 /**
 279  *  Generate a huffman codebook from the given descriptor
 280  *  and convert it into the Libav VLC table.
 281  *
 282  *  @param[in]   cb    pointer to codebook descriptor
 283  *  @param[out]  vlc   where to place the generated VLC table
 284  *  @param[in]   flag  flag: 1 - for static or 0 for dynamic tables
 285  *  @return     result code: 0 - OK, -1 = error (invalid codebook descriptor)
 286  */
 287 int  ff_ivi_create_huff_from_desc(const IVIHuffDesc *cb, VLC *vlc, int flag);
 288
 289 /**
 290  * Initialize static codes used for macroblock and block decoding.
 291  */
 292 void ff_ivi_init_static_vlc(void);
 293
 294 /**
 295  *  Decode a huffman codebook descriptor from the bitstream
 296  *  and select specified huffman table.
 297  *
 298  *  @param[in,out]  gb          the GetBit context
 299  *  @param[in]      desc_coded  flag signalling if table descriptor was coded
 300  *  @param[in]      which_tab   codebook purpose (IVI_MB_HUFF or IVI_BLK_HUFF)
 301  *  @param[out]     huff_tab    pointer to the descriptor of the selected table
 302  *  @param[in]      avctx       AVCodecContext pointer
 303  *  @return             zero on success, negative value otherwise
 304  */
 305 int  ff_ivi_dec_huff_desc(GetBitContext *gb, int desc_coded, int which_tab,
 306                           IVIHuffTab *huff_tab, AVCodecContext *avctx);
 307
 308 /**
 309  *  Compare two huffman codebook descriptors.
 310  *
 311  *  @param[in]  desc1  ptr to the 1st descriptor to compare
 312  *  @param[in]  desc2  ptr to the 2nd descriptor to compare
 313  *  @return         comparison result: 0 - equal, 1 - not equal
 314  */
 315 int  ff_ivi_huff_desc_cmp(const IVIHuffDesc *desc1, const IVIHuffDesc *desc2);
 316
 317 /**
 318  *  Copy huffman codebook descriptors.
 319  *
 320  *  @param[out]  dst  ptr to the destination descriptor
 321  *  @param[in]   src  ptr to the source descriptor
 322  */
 323 void ff_ivi_huff_desc_copy(IVIHuffDesc *dst, const IVIHuffDesc *src);
 324
 325 /**
 326  *  Initialize planes (prepares descriptors, allocates buffers etc).
 327  *
 328  *  @param[in,out]  planes  pointer to the array of the plane descriptors
 329  *  @param[in]      cfg     pointer to the ivi_pic_config structure describing picture layout
 330  *  @return             result code: 0 - OK
 331  */
 332 int  ff_ivi_init_planes(IVIPlaneDesc *planes, const IVIPicConfig *cfg);
 333
 334 /**
 335  *  Free planes, bands and macroblocks buffers.
 336  *
 337  *  @param[in]  planes  pointer to the array of the plane descriptors
 338  */
 339 void ff_ivi_free_buffers(IVIPlaneDesc *planes);
 340
 341 /**
 342  *  Initialize tile and macroblock descriptors.
 343  *
 344  *  @param[in,out]  planes       pointer to the array of the plane descriptors
 345  *  @param[in]      tile_width   tile width
 346  *  @param[in]      tile_height  tile height
 347  *  @return             result code: 0 - OK
 348  */
 349 int  ff_ivi_init_tiles(IVIPlaneDesc *planes, int tile_width, int tile_height);
 350
 351 /**
 352  *  Decode size of the tile data.
 353  *  The size is stored as a variable-length field having the following format:
 354  *  if (tile_data_size < 255) than this field is only one byte long
 355  *  if (tile_data_size >= 255) than this field four is byte long: 0xFF X1 X2 X3
 356  *  where X1-X3 is size of the tile data
 357  *
 358  *  @param[in,out]  gb  the GetBit context
 359  *  @return     size of the tile data in bytes
 360  */
 361 int  ff_ivi_dec_tile_data_size(GetBitContext *gb);
 362
 363 /**
 364  *  Decode block data:
 365  *  extract huffman-coded transform coefficients from the bitstream,
 366  *  dequantize them, apply inverse transform and motion compensation
 367  *  in order to reconstruct the picture.
 368  *
 369  *  @param[in,out]  gb    the GetBit context
 370  *  @param[in]      band  pointer to the band descriptor
 371  *  @param[in]      tile  pointer to the tile descriptor
 372  *  @return     result code: 0 - OK, -1 = error (corrupted blocks data)
 373  */
 374 int  ff_ivi_decode_blocks(GetBitContext *gb, IVIBandDesc *band, IVITile *tile);
 375
 376 /**
 377  *  Handle empty tiles by performing data copying and motion
 378  *  compensation respectively.
 379  *
 380  *  @param[in]  avctx     ptr to the AVCodecContext
 381  *  @param[in]  band      pointer to the band descriptor
 382  *  @param[in]  tile      pointer to the tile descriptor
 383  *  @param[in]  mv_scale  scaling factor for motion vectors
 384  */
 385 void ff_ivi_process_empty_tile(AVCodecContext *avctx, IVIBandDesc *band,
 386                                IVITile *tile, int32_t mv_scale);
 387
 388 /**
 389  *  Convert and output the current plane.
 390  *  This conversion is done by adding back the bias value of 128
 391  *  (subtracted in the encoder) and clipping the result.
 392  *
 393  *  @param[in]   plane      pointer to the descriptor of the plane being processed
 394  *  @param[out]  dst        pointer to the buffer receiving converted pixels
 395  *  @param[in]   dst_pitch  pitch for moving to the next y line
 396  */
 397 void ff_ivi_output_plane(IVIPlaneDesc *plane, uint8_t *dst, int dst_pitch);
 398
 399 int ff_ivi_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
 400                         AVPacket *avpkt);
 401 av_cold int ff_ivi_decode_close(AVCodecContext *avctx);
 402
 403 #endif /* AVCODEC_IVI_COMMON_H */