git.sesse.net Git - ffmpeg/blob - libavcodec/indeo3.c

   1 /*
   2  * Indeo Video v3 compatible decoder
   3  * Copyright (c) 2009 - 2011 Maxim Poliakovski
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * Libav is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with Libav; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23  * @file
  24  * This is a decoder for Intel Indeo Video v3.
  25  * It is based on vector quantization, run-length coding and motion compensation.
  26  * Known container formats: .avi and .mov
  27  * Known FOURCCs: 'IV31', 'IV32'
  28  *
  29  * @see http://wiki.multimedia.cx/index.php?title=Indeo_3
  30  */
  31
  32 #include "libavutil/imgutils.h"
  33 #include "libavutil/intreadwrite.h"
  34 #include "avcodec.h"
  35 #include "dsputil.h"
  36 #include "bytestream.h"
  37 #include "get_bits.h"
  38
  39 #include "indeo3data.h"
  40
  41 /* RLE opcodes. */
  42 enum {
  43     RLE_ESC_F9    = 249, ///< same as RLE_ESC_FA + do the same with next block
  44     RLE_ESC_FA    = 250, ///< INTRA: skip block, INTER: copy data from reference
  45     RLE_ESC_FB    = 251, ///< apply null delta to N blocks / skip N blocks
  46     RLE_ESC_FC    = 252, ///< same as RLE_ESC_FD + do the same with next block
  47     RLE_ESC_FD    = 253, ///< apply null delta to all remaining lines of this block
  48     RLE_ESC_FE    = 254, ///< apply null delta to all lines up to the 3rd line
  49     RLE_ESC_FF    = 255  ///< apply null delta to all lines up to the 2nd line
  50 };
  51
  52
  53 /* Some constants for parsing frame bitstream flags. */
  54 #define BS_8BIT_PEL     (1 << 1) ///< 8bit pixel bitdepth indicator
  55 #define BS_KEYFRAME     (1 << 2) ///< intra frame indicator
  56 #define BS_MV_Y_HALF    (1 << 4) ///< vertical mv halfpel resolution indicator
  57 #define BS_MV_X_HALF    (1 << 5) ///< horizontal mv halfpel resolution indicator
  58 #define BS_NONREF       (1 << 8) ///< nonref (discardable) frame indicator
  59 #define BS_BUFFER        9       ///< indicates which of two frame buffers should be used
  60
  61
  62 typedef struct Plane {
  63     uint8_t         *buffers[2];
  64     uint8_t         *pixels[2]; ///< pointer to the actual pixel data of the buffers above
  65     uint32_t        width;
  66     uint32_t        height;
  67     uint32_t        pitch;
  68 } Plane;
  69
  70 #define CELL_STACK_MAX  20
  71
  72 typedef struct Cell {
  73     int16_t         xpos;       ///< cell coordinates in 4x4 blocks
  74     int16_t         ypos;
  75     int16_t         width;      ///< cell width  in 4x4 blocks
  76     int16_t         height;     ///< cell height in 4x4 blocks
  77     uint8_t         tree;       ///< tree id: 0- MC tree, 1 - VQ tree
  78     const int8_t    *mv_ptr;    ///< ptr to the motion vector if any
  79 } Cell;
  80
  81 typedef struct Indeo3DecodeContext {
  82     AVCodecContext *avctx;
  83     AVFrame         frame;
  84     DSPContext      dsp;
  85
  86     GetBitContext   gb;
  87     int             need_resync;
  88     int             skip_bits;
  89     const uint8_t   *next_cell_data;
  90     const uint8_t   *last_byte;
  91     const int8_t    *mc_vectors;
  92     unsigned        num_vectors;    ///< number of motion vectors in mc_vectors
  93
  94     int16_t         width, height;
  95     uint32_t        frame_num;      ///< current frame number (zero-based)
  96     uint32_t        data_size;      ///< size of the frame data in bytes
  97     uint16_t        frame_flags;    ///< frame properties
  98     uint8_t         cb_offset;      ///< needed for selecting VQ tables
  99     uint8_t         buf_sel;        ///< active frame buffer: 0 - primary, 1 -secondary
 100     const uint8_t   *y_data_ptr;
 101     const uint8_t   *v_data_ptr;
 102     const uint8_t   *u_data_ptr;
 103     int32_t         y_data_size;
 104     int32_t         v_data_size;
 105     int32_t         u_data_size;
 106     const uint8_t   *alt_quant;     ///< secondary VQ table set for the modes 1 and 4
 107     Plane           planes[3];
 108 } Indeo3DecodeContext;
 109
 110
 111 static uint8_t requant_tab[8][128];
 112
 113 /*
 114  *  Build the static requantization table.
 115  *  This table is used to remap pixel values according to a specific
 116  *  quant index and thus avoid overflows while adding deltas.
 117  */
 118 static av_cold void build_requant_tab(void)
 119 {
 120     static int8_t offsets[8] = { 1, 1, 2, -3, -3, 3, 4, 4 };
 121     static int8_t deltas [8] = { 0, 1, 0,  4,  4, 1, 0, 1 };
 122
 123     int i, j, step;
 124
 125     for (i = 0; i < 8; i++) {
 126         step = i + 2;
 127         for (j = 0; j < 128; j++)
 128                 requant_tab[i][j] = (j + offsets[i]) / step * step + deltas[i];
 129     }
 130
 131     /* some last elements calculated above will have values >= 128 */
 132     /* pixel values shall never exceed 127 so set them to non-overflowing values */
 133     /* according with the quantization step of the respective section */
 134     requant_tab[0][127] = 126;
 135     requant_tab[1][119] = 118;
 136     requant_tab[1][120] = 118;
 137     requant_tab[2][126] = 124;
 138     requant_tab[2][127] = 124;
 139     requant_tab[6][124] = 120;
 140     requant_tab[6][125] = 120;
 141     requant_tab[6][126] = 120;
 142     requant_tab[6][127] = 120;
 143
 144     /* Patch for compatibility with the Intel's binary decoders */
 145     requant_tab[1][7] = 10;
 146     requant_tab[4][8] = 10;
 147 }
 148
 149
 150 static av_cold int allocate_frame_buffers(Indeo3DecodeContext *ctx,
 151                                           AVCodecContext *avctx)
 152 {
 153     int p, luma_width, luma_height, chroma_width, chroma_height;
 154     int luma_pitch, chroma_pitch, luma_size, chroma_size;
 155
 156     luma_width  = ctx->width;
 157     luma_height = ctx->height;
 158
 159     if (luma_width  < 16 || luma_width  > 640 ||
 160         luma_height < 16 || luma_height > 480 ||
 161         luma_width  &  3 || luma_height &   3) {
 162         av_log(avctx, AV_LOG_ERROR, "Invalid picture dimensions: %d x %d!\n",
 163                luma_width, luma_height);
 164         return AVERROR_INVALIDDATA;
 165     }
 166
 167     chroma_width  = FFALIGN(luma_width  >> 2, 4);
 168     chroma_height = FFALIGN(luma_height >> 2, 4);
 169
 170     luma_pitch   = FFALIGN(luma_width,   16);
 171     chroma_pitch = FFALIGN(chroma_width, 16);
 172
 173     /* Calculate size of the luminance plane.  */
 174     /* Add one line more for INTRA prediction. */
 175     luma_size = luma_pitch * (luma_height + 1);
 176
 177     /* Calculate size of a chrominance planes. */
 178     /* Add one line more for INTRA prediction. */
 179     chroma_size = chroma_pitch * (chroma_height + 1);
 180
 181     /* allocate frame buffers */
 182     for (p = 0; p < 3; p++) {
 183         ctx->planes[p].pitch  = !p ? luma_pitch  : chroma_pitch;
 184         ctx->planes[p].width  = !p ? luma_width  : chroma_width;
 185         ctx->planes[p].height = !p ? luma_height : chroma_height;
 186
 187         ctx->planes[p].buffers[0] = av_malloc(!p ? luma_size : chroma_size);
 188         ctx->planes[p].buffers[1] = av_malloc(!p ? luma_size : chroma_size);
 189
 190         /* fill the INTRA prediction lines with the middle pixel value = 64 */
 191         memset(ctx->planes[p].buffers[0], 0x40, ctx->planes[p].pitch);
 192         memset(ctx->planes[p].buffers[1], 0x40, ctx->planes[p].pitch);
 193
 194         /* set buffer pointers = buf_ptr + pitch and thus skip the INTRA prediction line */
 195         ctx->planes[p].pixels[0] = ctx->planes[p].buffers[0] + ctx->planes[p].pitch;
 196         ctx->planes[p].pixels[1] = ctx->planes[p].buffers[1] + ctx->planes[p].pitch;
 197     }
 198
 199     return 0;
 200 }
 201
 202
 203 static av_cold void free_frame_buffers(Indeo3DecodeContext *ctx)
 204 {
 205     int p;
 206
 207     for (p = 0; p < 3; p++) {
 208         av_freep(&ctx->planes[p].buffers[0]);
 209         av_freep(&ctx->planes[p].buffers[1]);
 210     }
 211 }
 212
 213
 214 /**
 215  *  Copy pixels of the cell(x + mv_x, y + mv_y) from the previous frame into
 216  *  the cell(x, y) in the current frame.
 217  *
 218  *  @param ctx      pointer to the decoder context
 219  *  @param plane    pointer to the plane descriptor
 220  *  @param cell     pointer to the cell  descriptor
 221  */
 222 static void copy_cell(Indeo3DecodeContext *ctx, Plane *plane, Cell *cell)
 223 {
 224     int     h, w, mv_x, mv_y, offset, offset_dst;
 225     uint8_t *src, *dst;
 226
 227     /* setup output and reference pointers */
 228     offset_dst  = (cell->ypos << 2) * plane->pitch + (cell->xpos << 2);
 229     dst         = plane->pixels[ctx->buf_sel] + offset_dst;
 230     mv_y        = cell->mv_ptr[0];
 231     mv_x        = cell->mv_ptr[1];
 232     offset      = offset_dst + mv_y * plane->pitch + mv_x;
 233     src         = plane->pixels[ctx->buf_sel ^ 1] + offset;
 234
 235     h = cell->height << 2;
 236
 237     for (w = cell->width; w > 0;) {
 238         /* copy using 16xH blocks */
 239         if (!((cell->xpos << 2) & 15) && w >= 4) {
 240             for (; w >= 4; src += 16, dst += 16, w -= 4)
 241                 ctx->dsp.put_no_rnd_pixels_tab[0][0](dst, src, plane->pitch, h);
 242         }
 243
 244         /* copy using 8xH blocks */
 245         if (!((cell->xpos << 2) & 7) && w >= 2) {
 246             ctx->dsp.put_no_rnd_pixels_tab[1][0](dst, src, plane->pitch, h);
 247             w -= 2;
 248             src += 8;
 249             dst += 8;
 250         }
 251
 252         if (w >= 1) {
 253             copy_block4(dst, src, plane->pitch, plane->pitch, h);
 254             w--;
 255             src += 4;
 256             dst += 4;
 257         }
 258     }
 259 }
 260
 261
 262 /* Average 4/8 pixels at once without rounding using SWAR */
 263 #define AVG_32(dst, src, ref) \
 264     AV_WN32A(dst, ((AV_RN32A(src) + AV_RN32A(ref)) >> 1) & 0x7F7F7F7FUL)
 265
 266 #define AVG_64(dst, src, ref) \
 267     AV_WN64A(dst, ((AV_RN64A(src) + AV_RN64A(ref)) >> 1) & 0x7F7F7F7F7F7F7F7FULL)
 268
 269
 270 /*
 271  *  Replicate each even pixel as follows:
 272  *  ABCDEFGH -> AACCEEGG
 273  */
 274 static inline uint64_t replicate64(uint64_t a) {
 275 #if HAVE_BIGENDIAN
 276     a &= 0xFF00FF00FF00FF00ULL;
 277     a |= a >> 8;
 278 #else
 279     a &= 0x00FF00FF00FF00FFULL;
 280     a |= a << 8;
 281 #endif
 282     return a;
 283 }
 284
 285 static inline uint32_t replicate32(uint32_t a) {
 286 #if HAVE_BIGENDIAN
 287     a &= 0xFF00FF00UL;
 288     a |= a >> 8;
 289 #else
 290     a &= 0x00FF00FFUL;
 291     a |= a << 8;
 292 #endif
 293     return a;
 294 }
 295
 296
 297 /* Fill n lines with 64bit pixel value pix */
 298 static inline void fill_64(uint8_t *dst, const uint64_t pix, int32_t n,
 299                            int32_t row_offset)
 300 {
 301     for (; n > 0; dst += row_offset, n--)
 302         AV_WN64A(dst, pix);
 303 }
 304
 305
 306 /* Error codes for cell decoding. */
 307 enum {
 308     IV3_NOERR       = 0,
 309     IV3_BAD_RLE     = 1,
 310     IV3_BAD_DATA    = 2,
 311     IV3_BAD_COUNTER = 3,
 312     IV3_UNSUPPORTED = 4,
 313     IV3_OUT_OF_DATA = 5
 314 };
 315
 316
 317 #define BUFFER_PRECHECK \
 318 if (*data_ptr >= last_ptr) \
 319     return IV3_OUT_OF_DATA; \
 320
 321 #define RLE_BLOCK_COPY \
 322     if (cell->mv_ptr || !skip_flag) \
 323         copy_block4(dst, ref, row_offset, row_offset, 4 << v_zoom)
 324
 325 #define RLE_BLOCK_COPY_8 \
 326     pix64 = AV_RN64A(ref);\
 327     if (is_first_row) {/* special prediction case: top line of a cell */\
 328         pix64 = replicate64(pix64);\
 329         fill_64(dst + row_offset, pix64, 7, row_offset);\
 330         AVG_64(dst, ref, dst + row_offset);\
 331     } else \
 332         fill_64(dst, pix64, 8, row_offset)
 333
 334 #define RLE_LINES_COPY \
 335     copy_block4(dst, ref, row_offset, row_offset, num_lines << v_zoom)
 336
 337 #define RLE_LINES_COPY_M10 \
 338     pix64 = AV_RN64A(ref);\
 339     if (is_top_of_cell) {\
 340         pix64 = replicate64(pix64);\
 341         fill_64(dst + row_offset, pix64, (num_lines << 1) - 1, row_offset);\
 342         AVG_64(dst, ref, dst + row_offset);\
 343     } else \
 344         fill_64(dst, pix64, num_lines << 1, row_offset)
 345
 346 #define APPLY_DELTA_4 \
 347     AV_WN16A(dst + line_offset    , AV_RN16A(ref    ) + delta_tab->deltas[dyad1]);\
 348     AV_WN16A(dst + line_offset + 2, AV_RN16A(ref + 2) + delta_tab->deltas[dyad2]);\
 349     if (mode >= 3) {\
 350         if (is_top_of_cell && !cell->ypos) {\
 351             AV_COPY32(dst, dst + row_offset);\
 352         } else {\
 353             AVG_32(dst, ref, dst + row_offset);\
 354         }\
 355     }
 356
 357 #define APPLY_DELTA_8 \
 358     /* apply two 32-bit VQ deltas to next even line */\
 359     if (is_top_of_cell) { \
 360         AV_WN32A(dst + row_offset    , \
 361                  replicate32(AV_RN32A(ref    )) + delta_tab->deltas_m10[dyad1]);\
 362         AV_WN32A(dst + row_offset + 4, \
 363                  replicate32(AV_RN32A(ref + 4)) + delta_tab->deltas_m10[dyad2]);\
 364     } else { \
 365         AV_WN32A(dst + row_offset    , \
 366                  AV_RN32A(ref    ) + delta_tab->deltas_m10[dyad1]);\
 367         AV_WN32A(dst + row_offset + 4, \
 368                  AV_RN32A(ref + 4) + delta_tab->deltas_m10[dyad2]);\
 369     } \
 370     /* odd lines are not coded but rather interpolated/replicated */\
 371     /* first line of the cell on the top of image? - replicate */\
 372     /* otherwise - interpolate */\
 373     if (is_top_of_cell && !cell->ypos) {\
 374         AV_COPY64(dst, dst + row_offset);\
 375     } else \
 376         AVG_64(dst, ref, dst + row_offset);
 377
 378
 379 #define APPLY_DELTA_1011_INTER \
 380     if (mode == 10) { \
 381         AV_WN32A(dst                 , \
 382                  AV_RN32A(dst                 ) + delta_tab->deltas_m10[dyad1]);\
 383         AV_WN32A(dst + 4             , \
 384                  AV_RN32A(dst + 4             ) + delta_tab->deltas_m10[dyad2]);\
 385         AV_WN32A(dst + row_offset    , \
 386                  AV_RN32A(dst + row_offset    ) + delta_tab->deltas_m10[dyad1]);\
 387         AV_WN32A(dst + row_offset + 4, \
 388                  AV_RN32A(dst + row_offset + 4) + delta_tab->deltas_m10[dyad2]);\
 389     } else { \
 390         AV_WN16A(dst                 , \
 391                  AV_RN16A(dst                 ) + delta_tab->deltas[dyad1]);\
 392         AV_WN16A(dst + 2             , \
 393                  AV_RN16A(dst + 2             ) + delta_tab->deltas[dyad2]);\
 394         AV_WN16A(dst + row_offset    , \
 395                  AV_RN16A(dst + row_offset    ) + delta_tab->deltas[dyad1]);\
 396         AV_WN16A(dst + row_offset + 2, \
 397                  AV_RN16A(dst + row_offset + 2) + delta_tab->deltas[dyad2]);\
 398     }
 399
 400
 401 static int decode_cell_data(Cell *cell, uint8_t *block, uint8_t *ref_block,
 402                             int pitch, int h_zoom, int v_zoom, int mode,
 403                             const vqEntry *delta[2], int swap_quads[2],
 404                             const uint8_t **data_ptr, const uint8_t *last_ptr)
 405 {
 406     int           x, y, line, num_lines;
 407     int           rle_blocks = 0;
 408     uint8_t       code, *dst, *ref;
 409     const vqEntry *delta_tab;
 410     unsigned int  dyad1, dyad2;
 411     uint64_t      pix64;
 412     int           skip_flag = 0, is_top_of_cell, is_first_row = 1;
 413     int           row_offset, blk_row_offset, line_offset;
 414
 415     row_offset     =  pitch;
 416     blk_row_offset = (row_offset << (2 + v_zoom)) - (cell->width << 2);
 417     line_offset    = v_zoom ? row_offset : 0;
 418
 419     for (y = 0; y < cell->height; is_first_row = 0, y += 1 + v_zoom) {
 420         for (x = 0; x < cell->width; x += 1 + h_zoom) {
 421             ref = ref_block;
 422             dst = block;
 423
 424             if (rle_blocks > 0) {
 425                 if (mode <= 4) {
 426                     RLE_BLOCK_COPY;
 427                 } else if (mode == 10 && !cell->mv_ptr) {
 428                     RLE_BLOCK_COPY_8;
 429                 }
 430                 rle_blocks--;
 431             } else {
 432                 for (line = 0; line < 4;) {
 433                     num_lines = 1;
 434                     is_top_of_cell = is_first_row && !line;
 435
 436                     /* select primary VQ table for odd, secondary for even lines */
 437                     if (mode <= 4)
 438                         delta_tab = delta[line & 1];
 439                     else
 440                         delta_tab = delta[1];
 441                     BUFFER_PRECHECK;
 442                     code = bytestream_get_byte(data_ptr);
 443                     if (code < 248) {
 444                         if (code < delta_tab->num_dyads) {
 445                             BUFFER_PRECHECK;
 446                             dyad1 = bytestream_get_byte(data_ptr);
 447                             dyad2 = code;
 448                             if (dyad1 >= delta_tab->num_dyads || dyad1 >= 248)
 449                                 return IV3_BAD_DATA;
 450                         } else {
 451                             /* process QUADS */
 452                             code -= delta_tab->num_dyads;
 453                             dyad1 = code / delta_tab->quad_exp;
 454                             dyad2 = code % delta_tab->quad_exp;
 455                             if (swap_quads[line & 1])
 456                                 FFSWAP(unsigned int, dyad1, dyad2);
 457                         }
 458                         if (mode <= 4) {
 459                             APPLY_DELTA_4;
 460                         } else if (mode == 10 && !cell->mv_ptr) {
 461                             APPLY_DELTA_8;
 462                         } else {
 463                             APPLY_DELTA_1011_INTER;
 464                         }
 465                     } else {
 466                         /* process RLE codes */
 467                         switch (code) {
 468                         case RLE_ESC_FC:
 469                             skip_flag  = 0;
 470                             rle_blocks = 1;
 471                             code       = 253;
 472                             /* FALLTHROUGH */
 473                         case RLE_ESC_FF:
 474                         case RLE_ESC_FE:
 475                         case RLE_ESC_FD:
 476                             num_lines = 257 - code - line;
 477                             if (num_lines <= 0)
 478                                 return IV3_BAD_RLE;
 479                             if (mode <= 4) {
 480                                 RLE_LINES_COPY;
 481                             } else if (mode == 10 && !cell->mv_ptr) {
 482                                 RLE_LINES_COPY_M10;
 483                             }
 484                             break;
 485                         case RLE_ESC_FB:
 486                             BUFFER_PRECHECK;
 487                             code = bytestream_get_byte(data_ptr);
 488                             rle_blocks = (code & 0x1F) - 1; /* set block counter */
 489                             if (code >= 64 || rle_blocks < 0)
 490                                 return IV3_BAD_COUNTER;
 491                             skip_flag = code & 0x20;
 492                             num_lines = 4 - line; /* enforce next block processing */
 493                             if (mode >= 10 || (cell->mv_ptr || !skip_flag)) {
 494                                 if (mode <= 4) {
 495                                     RLE_LINES_COPY;
 496                                 } else if (mode == 10 && !cell->mv_ptr) {
 497                                     RLE_LINES_COPY_M10;
 498                                 }
 499                             }
 500                             break;
 501                         case RLE_ESC_F9:
 502                             skip_flag  = 1;
 503                             rle_blocks = 1;
 504                             /* FALLTHROUGH */
 505                         case RLE_ESC_FA:
 506                             if (line)
 507                                 return IV3_BAD_RLE;
 508                             num_lines = 4; /* enforce next block processing */
 509                             if (cell->mv_ptr) {
 510                                 if (mode <= 4) {
 511                                     RLE_LINES_COPY;
 512                                 } else if (mode == 10 && !cell->mv_ptr) {
 513                                     RLE_LINES_COPY_M10;
 514                                 }
 515                             }
 516                             break;
 517                         default:
 518                             return IV3_UNSUPPORTED;
 519                         }
 520                     }
 521
 522                     line += num_lines;
 523                     ref  += row_offset * (num_lines << v_zoom);
 524                     dst  += row_offset * (num_lines << v_zoom);
 525                 }
 526             }
 527
 528             /* move to next horizontal block */
 529             block     += 4 << h_zoom;
 530             ref_block += 4 << h_zoom;
 531         }
 532
 533         /* move to next line of blocks */
 534         ref_block += blk_row_offset;
 535         block     += blk_row_offset;
 536     }
 537     return IV3_NOERR;
 538 }
 539
 540
 541 /**
 542  *  Decode a vector-quantized cell.
 543  *  It consists of several routines, each of which handles one or more "modes"
 544  *  with which a cell can be encoded.
 545  *
 546  *  @param ctx      pointer to the decoder context
 547  *  @param avctx    ptr to the AVCodecContext
 548  *  @param plane    pointer to the plane descriptor
 549  *  @param cell     pointer to the cell  descriptor
 550  *  @param data_ptr pointer to the compressed data
 551  *  @param last_ptr pointer to the last byte to catch reads past end of buffer
 552  *  @return         number of consumed bytes or negative number in case of error
 553  */
 554 static int decode_cell(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
 555                        Plane *plane, Cell *cell, const uint8_t *data_ptr,
 556                        const uint8_t *last_ptr)
 557 {
 558     int           x, mv_x, mv_y, mode, vq_index, prim_indx, second_indx;
 559     int           zoom_fac;
 560     int           offset, error = 0, swap_quads[2];
 561     uint8_t       code, *block, *ref_block = 0;
 562     const vqEntry *delta[2];
 563     const uint8_t *data_start = data_ptr;
 564
 565     /* get coding mode and VQ table index from the VQ descriptor byte */
 566     code     = *data_ptr++;
 567     mode     = code >> 4;
 568     vq_index = code & 0xF;
 569
 570     /* setup output and reference pointers */
 571     offset = (cell->ypos << 2) * plane->pitch + (cell->xpos << 2);
 572     block  =  plane->pixels[ctx->buf_sel] + offset;
 573     if (!cell->mv_ptr) {
 574         /* use previous line as reference for INTRA cells */
 575         ref_block = block - plane->pitch;
 576     } else if (mode >= 10) {
 577         /* for mode 10 and 11 INTER first copy the predicted cell into the current one */
 578         /* so we don't need to do data copying for each RLE code later */
 579         copy_cell(ctx, plane, cell);
 580     } else {
 581         /* set the pointer to the reference pixels for modes 0-4 INTER */
 582         mv_y      = cell->mv_ptr[0];
 583         mv_x      = cell->mv_ptr[1];
 584         offset   += mv_y * plane->pitch + mv_x;
 585         ref_block = plane->pixels[ctx->buf_sel ^ 1] + offset;
 586     }
 587
 588     /* select VQ tables as follows: */
 589     /* modes 0 and 3 use only the primary table for all lines in a block */
 590     /* while modes 1 and 4 switch between primary and secondary tables on alternate lines */
 591     if (mode == 1 || mode == 4) {
 592         code        = ctx->alt_quant[vq_index];
 593         prim_indx   = (code >> 4)  + ctx->cb_offset;
 594         second_indx = (code & 0xF) + ctx->cb_offset;
 595     } else {
 596         vq_index += ctx->cb_offset;
 597         prim_indx = second_indx = vq_index;
 598     }
 599
 600     if (prim_indx >= 24 || second_indx >= 24) {
 601         av_log(avctx, AV_LOG_ERROR, "Invalid VQ table indexes! Primary: %d, secondary: %d!\n",
 602                prim_indx, second_indx);
 603         return AVERROR_INVALIDDATA;
 604     }
 605
 606     delta[0] = &vq_tab[second_indx];
 607     delta[1] = &vq_tab[prim_indx];
 608     swap_quads[0] = second_indx >= 16;
 609     swap_quads[1] = prim_indx   >= 16;
 610
 611     /* requantize the prediction if VQ index of this cell differs from VQ index */
 612     /* of the predicted cell in order to avoid overflows. */
 613     if (vq_index >= 8 && ref_block) {
 614         for (x = 0; x < cell->width << 2; x++)
 615             ref_block[x] = requant_tab[vq_index & 7][ref_block[x]];
 616     }
 617
 618     error = IV3_NOERR;
 619
 620     switch (mode) {
 621     case 0: /*------------------ MODES 0 & 1 (4x4 block processing) --------------------*/
 622     case 1:
 623     case 3: /*------------------ MODES 3 & 4 (4x8 block processing) --------------------*/
 624     case 4:
 625         if (mode >= 3 && cell->mv_ptr) {
 626             av_log(avctx, AV_LOG_ERROR, "Attempt to apply Mode 3/4 to an INTER cell!\n");
 627             return AVERROR_INVALIDDATA;
 628         }
 629
 630         zoom_fac = mode >= 3;
 631         error = decode_cell_data(cell, block, ref_block, plane->pitch, 0, zoom_fac,
 632                                  mode, delta, swap_quads, &data_ptr, last_ptr);
 633         break;
 634     case 10: /*-------------------- MODE 10 (8x8 block processing) ---------------------*/
 635     case 11: /*----------------- MODE 11 (4x8 INTER block processing) ------------------*/
 636         if (mode == 10 && !cell->mv_ptr) { /* MODE 10 INTRA processing */
 637             error = decode_cell_data(cell, block, ref_block, plane->pitch, 1, 1,
 638                                      mode, delta, swap_quads, &data_ptr, last_ptr);
 639         } else { /* mode 10 and 11 INTER processing */
 640             if (mode == 11 && !cell->mv_ptr) {
 641                av_log(avctx, AV_LOG_ERROR, "Attempt to use Mode 11 for an INTRA cell!\n");
 642                return AVERROR_INVALIDDATA;
 643             }
 644
 645             zoom_fac = mode == 10;
 646             error = decode_cell_data(cell, block, ref_block, plane->pitch,
 647                                      zoom_fac, 1, mode, delta, swap_quads,
 648                                      &data_ptr, last_ptr);
 649         }
 650         break;
 651     default:
 652         av_log(avctx, AV_LOG_ERROR, "Unsupported coding mode: %d\n", mode);
 653         return AVERROR_INVALIDDATA;
 654     }//switch mode
 655
 656     switch (error) {
 657     case IV3_BAD_RLE:
 658         av_log(avctx, AV_LOG_ERROR, "Mode %d: RLE code %X is not allowed at the current line\n",
 659                mode, data_ptr[-1]);
 660         return AVERROR_INVALIDDATA;
 661     case IV3_BAD_DATA:
 662         av_log(avctx, AV_LOG_ERROR, "Mode %d: invalid VQ data\n", mode);
 663         return AVERROR_INVALIDDATA;
 664     case IV3_BAD_COUNTER:
 665         av_log(avctx, AV_LOG_ERROR, "Mode %d: RLE-FB invalid counter: %d\n", mode, code);
 666         return AVERROR_INVALIDDATA;
 667     case IV3_UNSUPPORTED:
 668         av_log(avctx, AV_LOG_ERROR, "Mode %d: unsupported RLE code: %X\n", mode, data_ptr[-1]);
 669         return AVERROR_INVALIDDATA;
 670     case IV3_OUT_OF_DATA:
 671         av_log(avctx, AV_LOG_ERROR, "Mode %d: attempt to read past end of buffer\n", mode);
 672         return AVERROR_INVALIDDATA;
 673     }
 674
 675     return data_ptr - data_start; /* report number of bytes consumed from the input buffer */
 676 }
 677
 678
 679 /* Binary tree codes. */
 680 enum {
 681     H_SPLIT    = 0,
 682     V_SPLIT    = 1,
 683     INTRA_NULL = 2,
 684     INTER_DATA = 3
 685 };
 686
 687
 688 #define SPLIT_CELL(size, new_size) (new_size) = ((size) > 2) ? ((((size) + 2) >> 2) << 1) : 1
 689
 690 #define UPDATE_BITPOS(n) \
 691     ctx->skip_bits  += (n); \
 692     ctx->need_resync = 1
 693
 694 #define RESYNC_BITSTREAM \
 695     if (ctx->need_resync && !(get_bits_count(&ctx->gb) & 7)) { \
 696         skip_bits_long(&ctx->gb, ctx->skip_bits);              \
 697         ctx->skip_bits   = 0;                                  \
 698         ctx->need_resync = 0;                                  \
 699     }
 700
 701 #define CHECK_CELL \
 702     if (curr_cell.xpos + curr_cell.width > (plane->width >> 2) ||               \
 703         curr_cell.ypos + curr_cell.height > (plane->height >> 2)) {             \
 704         av_log(avctx, AV_LOG_ERROR, "Invalid cell: x=%d, y=%d, w=%d, h=%d\n",   \
 705                curr_cell.xpos, curr_cell.ypos, curr_cell.width, curr_cell.height); \
 706         return AVERROR_INVALIDDATA;                                                              \
 707     }
 708
 709
 710 static int parse_bintree(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
 711                          Plane *plane, int code, Cell *ref_cell,
 712                          const int depth, const int strip_width)
 713 {
 714     Cell    curr_cell;
 715     int     bytes_used;
 716
 717     if (depth <= 0) {
 718         av_log(avctx, AV_LOG_ERROR, "Stack overflow (corrupted binary tree)!\n");
 719         return AVERROR_INVALIDDATA; // unwind recursion
 720     }
 721
 722     curr_cell = *ref_cell; // clone parent cell
 723     if (code == H_SPLIT) {
 724         SPLIT_CELL(ref_cell->height, curr_cell.height);
 725         ref_cell->ypos   += curr_cell.height;
 726         ref_cell->height -= curr_cell.height;
 727         if (ref_cell->height <= 0 || curr_cell.height <= 0)
 728             return AVERROR_INVALIDDATA;
 729     } else if (code == V_SPLIT) {
 730         if (curr_cell.width > strip_width) {
 731             /* split strip */
 732             curr_cell.width = (curr_cell.width <= (strip_width << 1) ? 1 : 2) * strip_width;
 733         } else
 734             SPLIT_CELL(ref_cell->width, curr_cell.width);
 735         ref_cell->xpos  += curr_cell.width;
 736         ref_cell->width -= curr_cell.width;
 737         if (ref_cell->width <= 0 || curr_cell.width <= 0)
 738             return AVERROR_INVALIDDATA;
 739     }
 740
 741     while (1) { /* loop until return */
 742         RESYNC_BITSTREAM;
 743         switch (code = get_bits(&ctx->gb, 2)) {
 744         case H_SPLIT:
 745         case V_SPLIT:
 746             if (parse_bintree(ctx, avctx, plane, code, &curr_cell, depth - 1, strip_width))
 747                 return AVERROR_INVALIDDATA;
 748             break;
 749         case INTRA_NULL:
 750             if (!curr_cell.tree) { /* MC tree INTRA code */
 751                 curr_cell.mv_ptr = 0; /* mark the current strip as INTRA */
 752                 curr_cell.tree   = 1; /* enter the VQ tree */
 753             } else { /* VQ tree NULL code */
 754                 RESYNC_BITSTREAM;
 755                 code = get_bits(&ctx->gb, 2);
 756                 if (code >= 2) {
 757                     av_log(avctx, AV_LOG_ERROR, "Invalid VQ_NULL code: %d\n", code);
 758                     return AVERROR_INVALIDDATA;
 759                 }
 760                 if (code == 1)
 761                     av_log(avctx, AV_LOG_ERROR, "SkipCell procedure not implemented yet!\n");
 762
 763                 CHECK_CELL
 764                 if (!curr_cell.mv_ptr)
 765                     return AVERROR_INVALIDDATA;
 766                 copy_cell(ctx, plane, &curr_cell);
 767                 return 0;
 768             }
 769             break;
 770         case INTER_DATA:
 771             if (!curr_cell.tree) { /* MC tree INTER code */
 772                 unsigned mv_idx;
 773                 /* get motion vector index and setup the pointer to the mv set */
 774                 if (!ctx->need_resync)
 775                     ctx->next_cell_data = &ctx->gb.buffer[(get_bits_count(&ctx->gb) + 7) >> 3];
 776                 mv_idx = *(ctx->next_cell_data++);
 777                 if (mv_idx >= ctx->num_vectors) {
 778                     av_log(avctx, AV_LOG_ERROR, "motion vector index out of range\n");
 779                     return AVERROR_INVALIDDATA;
 780                 }
 781                 curr_cell.mv_ptr = &ctx->mc_vectors[mv_idx << 1];
 782                 curr_cell.tree   = 1; /* enter the VQ tree */
 783                 UPDATE_BITPOS(8);
 784             } else { /* VQ tree DATA code */
 785                 if (!ctx->need_resync)
 786                     ctx->next_cell_data = &ctx->gb.buffer[(get_bits_count(&ctx->gb) + 7) >> 3];
 787
 788                 CHECK_CELL
 789                 bytes_used = decode_cell(ctx, avctx, plane, &curr_cell,
 790                                          ctx->next_cell_data, ctx->last_byte);
 791                 if (bytes_used < 0)
 792                     return AVERROR_INVALIDDATA;
 793
 794                 UPDATE_BITPOS(bytes_used << 3);
 795                 ctx->next_cell_data += bytes_used;
 796                 return 0;
 797             }
 798             break;
 799         }
 800     }//while
 801
 802     return 0;
 803 }
 804
 805
 806 static int decode_plane(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
 807                         Plane *plane, const uint8_t *data, int32_t data_size,
 808                         int32_t strip_width)
 809 {
 810     Cell            curr_cell;
 811     unsigned        num_vectors;
 812
 813     /* each plane data starts with mc_vector_count field, */
 814     /* an optional array of motion vectors followed by the vq data */
 815     num_vectors = bytestream_get_le32(&data);
 816     if (num_vectors > 256) {
 817         av_log(ctx->avctx, AV_LOG_ERROR,
 818                "Read invalid number of motion vectors %d\n", num_vectors);
 819         return AVERROR_INVALIDDATA;
 820     }
 821     if (num_vectors * 2 >= data_size)
 822         return AVERROR_INVALIDDATA;
 823
 824     ctx->num_vectors = num_vectors;
 825     ctx->mc_vectors  = num_vectors ? data : 0;
 826
 827     /* init the bitreader */
 828     init_get_bits(&ctx->gb, &data[num_vectors * 2], (data_size - num_vectors * 2) << 3);
 829     ctx->skip_bits   = 0;
 830     ctx->need_resync = 0;
 831
 832     ctx->last_byte = data + data_size - 1;
 833
 834     /* initialize the 1st cell and set its dimensions to whole plane */
 835     curr_cell.xpos   = curr_cell.ypos = 0;
 836     curr_cell.width  = plane->width  >> 2;
 837     curr_cell.height = plane->height >> 2;
 838     curr_cell.tree   = 0; // we are in the MC tree now
 839     curr_cell.mv_ptr = 0; // no motion vector = INTRA cell
 840
 841     return parse_bintree(ctx, avctx, plane, INTRA_NULL, &curr_cell, CELL_STACK_MAX, strip_width);
 842 }
 843
 844
 845 #define OS_HDR_ID   MKBETAG('F', 'R', 'M', 'H')
 846
 847 static int decode_frame_headers(Indeo3DecodeContext *ctx, AVCodecContext *avctx,
 848                                 const uint8_t *buf, int buf_size)
 849 {
 850     const uint8_t   *buf_ptr = buf, *bs_hdr;
 851     uint32_t        frame_num, word2, check_sum, data_size;
 852     uint32_t        y_offset, u_offset, v_offset, starts[3], ends[3];
 853     uint16_t        height, width;
 854     int             i, j;
 855
 856     /* parse and check the OS header */
 857     frame_num = bytestream_get_le32(&buf_ptr);
 858     word2     = bytestream_get_le32(&buf_ptr);
 859     check_sum = bytestream_get_le32(&buf_ptr);
 860     data_size = bytestream_get_le32(&buf_ptr);
 861
 862     if ((frame_num ^ word2 ^ data_size ^ OS_HDR_ID) != check_sum) {
 863         av_log(avctx, AV_LOG_ERROR, "OS header checksum mismatch!\n");
 864         return AVERROR_INVALIDDATA;
 865     }
 866
 867     /* parse the bitstream header */
 868     bs_hdr = buf_ptr;
 869
 870     if (bytestream_get_le16(&buf_ptr) != 32) {
 871         av_log(avctx, AV_LOG_ERROR, "Unsupported codec version!\n");
 872         return AVERROR_INVALIDDATA;
 873     }
 874
 875     ctx->frame_num   =  frame_num;
 876     ctx->frame_flags =  bytestream_get_le16(&buf_ptr);
 877     ctx->data_size   = (bytestream_get_le32(&buf_ptr) + 7) >> 3;
 878     ctx->cb_offset   = *buf_ptr++;
 879
 880     if (ctx->data_size == 16)
 881         return 4;
 882     if (ctx->data_size > buf_size)
 883         ctx->data_size = buf_size;
 884
 885     buf_ptr += 3; // skip reserved byte and checksum
 886
 887     /* check frame dimensions */
 888     height = bytestream_get_le16(&buf_ptr);
 889     width  = bytestream_get_le16(&buf_ptr);
 890     if (av_image_check_size(width, height, 0, avctx))
 891         return AVERROR_INVALIDDATA;
 892
 893     if (width != ctx->width || height != ctx->height) {
 894         int res;
 895
 896         av_dlog(avctx, "Frame dimensions changed!\n");
 897
 898         ctx->width  = width;
 899         ctx->height = height;
 900
 901         free_frame_buffers(ctx);
 902         if ((res = allocate_frame_buffers(ctx, avctx)) < 0)
 903              return res;
 904         avcodec_set_dimensions(avctx, width, height);
 905     }
 906
 907     y_offset = bytestream_get_le32(&buf_ptr);
 908     v_offset = bytestream_get_le32(&buf_ptr);
 909     u_offset = bytestream_get_le32(&buf_ptr);
 910
 911     /* unfortunately there is no common order of planes in the buffer */
 912     /* so we use that sorting algo for determining planes data sizes  */
 913     starts[0] = y_offset;
 914     starts[1] = v_offset;
 915     starts[2] = u_offset;
 916
 917     for (j = 0; j < 3; j++) {
 918         ends[j] = ctx->data_size;
 919         for (i = 2; i >= 0; i--)
 920             if (starts[i] < ends[j] && starts[i] > starts[j])
 921                 ends[j] = starts[i];
 922     }
 923
 924     ctx->y_data_size = ends[0] - starts[0];
 925     ctx->v_data_size = ends[1] - starts[1];
 926     ctx->u_data_size = ends[2] - starts[2];
 927     if (FFMAX3(y_offset, v_offset, u_offset) >= ctx->data_size - 16 ||
 928         FFMIN3(ctx->y_data_size, ctx->v_data_size, ctx->u_data_size) <= 0) {
 929         av_log(avctx, AV_LOG_ERROR, "One of the y/u/v offsets is invalid\n");
 930         return AVERROR_INVALIDDATA;
 931     }
 932
 933     ctx->y_data_ptr = bs_hdr + y_offset;
 934     ctx->v_data_ptr = bs_hdr + v_offset;
 935     ctx->u_data_ptr = bs_hdr + u_offset;
 936     ctx->alt_quant  = buf_ptr + sizeof(uint32_t);
 937
 938     if (ctx->data_size == 16) {
 939         av_log(avctx, AV_LOG_DEBUG, "Sync frame encountered!\n");
 940         return 16;
 941     }
 942
 943     if (ctx->frame_flags & BS_8BIT_PEL) {
 944         av_log_ask_for_sample(avctx, "8-bit pixel format\n");
 945         return AVERROR_PATCHWELCOME;
 946     }
 947
 948     if (ctx->frame_flags & BS_MV_X_HALF || ctx->frame_flags & BS_MV_Y_HALF) {
 949         av_log_ask_for_sample(avctx, "halfpel motion vectors\n");
 950         return AVERROR_PATCHWELCOME;
 951     }
 952
 953     return 0;
 954 }
 955
 956
 957 /**
 958  *  Convert and output the current plane.
 959  *  All pixel values will be upsampled by shifting right by one bit.
 960  *
 961  *  @param[in]  plane        pointer to the descriptor of the plane being processed
 962  *  @param[in]  buf_sel      indicates which frame buffer the input data stored in
 963  *  @param[out] dst          pointer to the buffer receiving converted pixels
 964  *  @param[in]  dst_pitch    pitch for moving to the next y line
 965  */
 966 static void output_plane(const Plane *plane, int buf_sel, uint8_t *dst, int dst_pitch)
 967 {
 968     int             x,y;
 969     const uint8_t   *src  = plane->pixels[buf_sel];
 970     uint32_t        pitch = plane->pitch;
 971
 972     for (y = 0; y < plane->height; y++) {
 973         /* convert four pixels at once using SWAR */
 974         for (x = 0; x < plane->width >> 2; x++) {
 975             AV_WN32A(dst, (AV_RN32A(src) & 0x7F7F7F7F) << 1);
 976             src += 4;
 977             dst += 4;
 978         }
 979
 980         for (x <<= 2; x < plane->width; x++)
 981             *dst++ = *src++ << 1;
 982
 983         src += pitch     - plane->width;
 984         dst += dst_pitch - plane->width;
 985     }
 986 }
 987
 988
 989 static av_cold int decode_init(AVCodecContext *avctx)
 990 {
 991     Indeo3DecodeContext *ctx = avctx->priv_data;
 992
 993     ctx->avctx     = avctx;
 994     ctx->width     = avctx->width;
 995     ctx->height    = avctx->height;
 996     avctx->pix_fmt = PIX_FMT_YUV410P;
 997
 998     build_requant_tab();
 999
1000     ff_dsputil_init(&ctx->dsp, avctx);
1001
1002     allocate_frame_buffers(ctx, avctx);
1003
1004     return 0;
1005 }
1006
1007
1008 static int decode_frame(AVCodecContext *avctx, void *data, int *data_size,
1009                         AVPacket *avpkt)
1010 {
1011     Indeo3DecodeContext *ctx = avctx->priv_data;
1012     const uint8_t *buf = avpkt->data;
1013     int buf_size       = avpkt->size;
1014     int res;
1015
1016     res = decode_frame_headers(ctx, avctx, buf, buf_size);
1017     if (res < 0)
1018         return res;
1019
1020     /* skip sync(null) frames */
1021     if (res) {
1022         // we have processed 16 bytes but no data was decoded
1023         *data_size = 0;
1024         return buf_size;
1025     }
1026
1027     /* skip droppable INTER frames if requested */
1028     if (ctx->frame_flags & BS_NONREF &&
1029        (avctx->skip_frame >= AVDISCARD_NONREF))
1030         return 0;
1031
1032     /* skip INTER frames if requested */
1033     if (!(ctx->frame_flags & BS_KEYFRAME) && avctx->skip_frame >= AVDISCARD_NONKEY)
1034         return 0;
1035
1036     /* use BS_BUFFER flag for buffer switching */
1037     ctx->buf_sel = (ctx->frame_flags >> BS_BUFFER) & 1;
1038
1039     /* decode luma plane */
1040     if ((res = decode_plane(ctx, avctx, ctx->planes, ctx->y_data_ptr, ctx->y_data_size, 40)))
1041         return res;
1042
1043     /* decode chroma planes */
1044     if ((res = decode_plane(ctx, avctx, &ctx->planes[1], ctx->u_data_ptr, ctx->u_data_size, 10)))
1045         return res;
1046
1047     if ((res = decode_plane(ctx, avctx, &ctx->planes[2], ctx->v_data_ptr, ctx->v_data_size, 10)))
1048         return res;
1049
1050     if (ctx->frame.data[0])
1051         avctx->release_buffer(avctx, &ctx->frame);
1052
1053     ctx->frame.reference = 0;
1054     if ((res = avctx->get_buffer(avctx, &ctx->frame)) < 0) {
1055         av_log(ctx->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
1056         return res;
1057     }
1058
1059     output_plane(&ctx->planes[0], ctx->buf_sel, ctx->frame.data[0], ctx->frame.linesize[0]);
1060     output_plane(&ctx->planes[1], ctx->buf_sel, ctx->frame.data[1], ctx->frame.linesize[1]);
1061     output_plane(&ctx->planes[2], ctx->buf_sel, ctx->frame.data[2], ctx->frame.linesize[2]);
1062
1063     *data_size      = sizeof(AVFrame);
1064     *(AVFrame*)data = ctx->frame;
1065
1066     return buf_size;
1067 }
1068
1069
1070 static av_cold int decode_close(AVCodecContext *avctx)
1071 {
1072     Indeo3DecodeContext *ctx = avctx->priv_data;
1073
1074     free_frame_buffers(avctx->priv_data);
1075
1076     if (ctx->frame.data[0])
1077         avctx->release_buffer(avctx, &ctx->frame);
1078
1079     return 0;
1080 }
1081
1082 AVCodec ff_indeo3_decoder = {
1083     .name           = "indeo3",
1084     .type           = AVMEDIA_TYPE_VIDEO,
1085     .id             = CODEC_ID_INDEO3,
1086     .priv_data_size = sizeof(Indeo3DecodeContext),
1087     .init           = decode_init,
1088     .close          = decode_close,
1089     .decode         = decode_frame,
1090     .long_name      = NULL_IF_CONFIG_SMALL("Intel Indeo 3"),
1091 };