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

   1 /*
   2  * Westwood Studios VQA Video Decoder
   3  * Copyright (C) 2003 the ffmpeg project
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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  * VQA Video Decoder
  25  * @author Mike Melanson (melanson@pcisys.net)
  26  * @see http://wiki.multimedia.cx/index.php?title=VQA
  27  *
  28  * The VQA video decoder outputs PAL8 or RGB555 colorspace data, depending
  29  * on the type of data in the file.
  30  *
  31  * This decoder needs the 42-byte VQHD header from the beginning
  32  * of the VQA file passed through the extradata field. The VQHD header
  33  * is laid out as:
  34  *
  35  *   bytes 0-3   chunk fourcc: 'VQHD'
  36  *   bytes 4-7   chunk size in big-endian format, should be 0x0000002A
  37  *   bytes 8-49  VQHD chunk data
  38  *
  39  * Bytes 8-49 are what this decoder expects to see.
  40  *
  41  * Briefly, VQA is a vector quantized animation format that operates in a
  42  * VGA palettized colorspace. It operates on pixel vectors (blocks)
  43  * of either 4x2 or 4x4 in size. Compressed VQA chunks can contain vector
  44  * codebooks, palette information, and code maps for rendering vectors onto
  45  * frames. Any of these components can also be compressed with a run-length
  46  * encoding (RLE) algorithm commonly referred to as "format80".
  47  *
  48  * VQA takes a novel approach to rate control. Each group of n frames
  49  * (usually, n = 8) relies on a different vector codebook. Rather than
  50  * transporting an entire codebook every 8th frame, the new codebook is
  51  * broken up into 8 pieces and sent along with the compressed video chunks
  52  * for each of the 8 frames preceding the 8 frames which require the
  53  * codebook. A full codebook is also sent on the very first frame of a
  54  * file. This is an interesting technique, although it makes random file
  55  * seeking difficult despite the fact that the frames are all intracoded.
  56  *
  57  * V1,2 VQA uses 12-bit codebook indexes. If the 12-bit indexes were
  58  * packed into bytes and then RLE compressed, bytewise, the results would
  59  * be poor. That is why the coding method divides each index into 2 parts,
  60  * the top 4 bits and the bottom 8 bits, then RL encodes the 4-bit pieces
  61  * together and the 8-bit pieces together. If most of the vectors are
  62  * clustered into one group of 256 vectors, most of the 4-bit index pieces
  63  * should be the same.
  64  */
  65
  66 #include <stdio.h>
  67 #include <stdlib.h>
  68 #include <string.h>
  69
  70 #include "libavutil/intreadwrite.h"
  71 #include "libavutil/imgutils.h"
  72 #include "avcodec.h"
  73 #include "bytestream.h"
  74
  75 #define PALETTE_COUNT 256
  76 #define VQA_HEADER_SIZE 0x2A
  77
  78 /* allocate the maximum vector space, regardless of the file version:
  79  * (0xFF00 codebook vectors + 0x100 solid pixel vectors) * (4x4 pixels/block) */
  80 #define MAX_CODEBOOK_VECTORS 0xFF00
  81 #define SOLID_PIXEL_VECTORS 0x100
  82 #define MAX_VECTORS (MAX_CODEBOOK_VECTORS + SOLID_PIXEL_VECTORS)
  83 #define MAX_CODEBOOK_SIZE (MAX_VECTORS * 4 * 4)
  84
  85 #define CBF0_TAG MKBETAG('C', 'B', 'F', '0')
  86 #define CBFZ_TAG MKBETAG('C', 'B', 'F', 'Z')
  87 #define CBP0_TAG MKBETAG('C', 'B', 'P', '0')
  88 #define CBPZ_TAG MKBETAG('C', 'B', 'P', 'Z')
  89 #define CPL0_TAG MKBETAG('C', 'P', 'L', '0')
  90 #define CPLZ_TAG MKBETAG('C', 'P', 'L', 'Z')
  91 #define VPTZ_TAG MKBETAG('V', 'P', 'T', 'Z')
  92
  93 typedef struct VqaContext {
  94
  95     AVCodecContext *avctx;
  96     AVFrame frame;
  97     GetByteContext gb;
  98
  99     uint32_t palette[PALETTE_COUNT];
 100
 101     int width;   /* width of a frame */
 102     int height;   /* height of a frame */
 103     int vector_width;  /* width of individual vector */
 104     int vector_height;  /* height of individual vector */
 105     int vqa_version;  /* this should be either 1, 2 or 3 */
 106
 107     unsigned char *codebook;         /* the current codebook */
 108     int codebook_size;
 109     unsigned char *next_codebook_buffer;  /* accumulator for next codebook */
 110     int next_codebook_buffer_index;
 111
 112     unsigned char *decode_buffer;
 113     int decode_buffer_size;
 114
 115     /* number of frames to go before replacing codebook */
 116     int partial_countdown;
 117     int partial_count;
 118
 119 } VqaContext;
 120
 121 static av_cold int vqa_decode_init(AVCodecContext *avctx)
 122 {
 123     VqaContext *s = avctx->priv_data;
 124     int i, j, codebook_index;
 125
 126     s->avctx = avctx;
 127     avctx->pix_fmt = AV_PIX_FMT_PAL8;
 128
 129     /* make sure the extradata made it */
 130     if (s->avctx->extradata_size != VQA_HEADER_SIZE) {
 131         av_log(s->avctx, AV_LOG_ERROR, "expected extradata size of %d\n", VQA_HEADER_SIZE);
 132         return AVERROR_INVALIDDATA;
 133     }
 134
 135     /* load up the VQA parameters from the header */
 136     s->vqa_version = s->avctx->extradata[0];
 137     if (s->vqa_version < 1 || s->vqa_version > 3) {
 138         av_log(s->avctx, AV_LOG_ERROR, "unsupported version %d\n", s->vqa_version);
 139         return AVERROR_PATCHWELCOME;
 140     }
 141     s->width = AV_RL16(&s->avctx->extradata[6]);
 142     s->height = AV_RL16(&s->avctx->extradata[8]);
 143     if(av_image_check_size(s->width, s->height, 0, avctx)){
 144         s->width= s->height= 0;
 145         return AVERROR_INVALIDDATA;
 146     }
 147     s->vector_width = s->avctx->extradata[10];
 148     s->vector_height = s->avctx->extradata[11];
 149     s->partial_count = s->partial_countdown = s->avctx->extradata[13];
 150
 151     /* the vector dimensions have to meet very stringent requirements */
 152     if ((s->vector_width != 4) ||
 153         ((s->vector_height != 2) && (s->vector_height != 4))) {
 154         /* return without further initialization */
 155         return AVERROR_INVALIDDATA;
 156     }
 157
 158     if (s->width % s->vector_width || s->height % s->vector_height) {
 159         av_log(avctx, AV_LOG_ERROR, "Image size not multiple of block size\n");
 160         return AVERROR_INVALIDDATA;
 161     }
 162
 163     /* allocate codebooks */
 164     s->codebook_size = MAX_CODEBOOK_SIZE;
 165     s->codebook = av_malloc(s->codebook_size);
 166     if (!s->codebook)
 167         goto fail;
 168     s->next_codebook_buffer = av_malloc(s->codebook_size);
 169     if (!s->next_codebook_buffer)
 170         goto fail;
 171
 172     /* allocate decode buffer */
 173     s->decode_buffer_size = (s->width / s->vector_width) *
 174         (s->height / s->vector_height) * 2;
 175     s->decode_buffer = av_malloc(s->decode_buffer_size);
 176     if (!s->decode_buffer)
 177         goto fail;
 178
 179     /* initialize the solid-color vectors */
 180     if (s->vector_height == 4) {
 181         codebook_index = 0xFF00 * 16;
 182         for (i = 0; i < 256; i++)
 183             for (j = 0; j < 16; j++)
 184                 s->codebook[codebook_index++] = i;
 185     } else {
 186         codebook_index = 0xF00 * 8;
 187         for (i = 0; i < 256; i++)
 188             for (j = 0; j < 8; j++)
 189                 s->codebook[codebook_index++] = i;
 190     }
 191     s->next_codebook_buffer_index = 0;
 192
 193     avcodec_get_frame_defaults(&s->frame);
 194     s->frame.data[0] = NULL;
 195
 196     return 0;
 197 fail:
 198     av_freep(&s->codebook);
 199     av_freep(&s->next_codebook_buffer);
 200     av_freep(&s->decode_buffer);
 201     return AVERROR(ENOMEM);
 202 }
 203
 204 #define CHECK_COUNT() \
 205     if (dest_index + count > dest_size) { \
 206         av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: next op would overflow dest_index\n"); \
 207         av_log(s->avctx, AV_LOG_ERROR, "current dest_index = %d, count = %d, dest_size = %d\n", \
 208             dest_index, count, dest_size); \
 209         return AVERROR_INVALIDDATA; \
 210     }
 211
 212 #define CHECK_COPY(idx) \
 213     if (idx < 0 || idx + count > dest_size) { \
 214         av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: next op would overflow dest_index\n"); \
 215         av_log(s->avctx, AV_LOG_ERROR, "current src_pos = %d, count = %d, dest_size = %d\n", \
 216             src_pos, count, dest_size); \
 217         return AVERROR_INVALIDDATA; \
 218     }
 219
 220
 221 static int decode_format80(VqaContext *s, int src_size,
 222     unsigned char *dest, int dest_size, int check_size) {
 223
 224     int dest_index = 0;
 225     int count, opcode, start;
 226     int src_pos;
 227     unsigned char color;
 228     int i;
 229
 230     start = bytestream2_tell(&s->gb);
 231     while (bytestream2_tell(&s->gb) - start < src_size) {
 232         opcode = bytestream2_get_byte(&s->gb);
 233         av_dlog(s->avctx, "opcode %02X: ", opcode);
 234
 235         /* 0x80 means that frame is finished */
 236         if (opcode == 0x80)
 237             return 0;
 238
 239         if (dest_index >= dest_size) {
 240             av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: dest_index (%d) exceeded dest_size (%d)\n",
 241                 dest_index, dest_size);
 242             return AVERROR_INVALIDDATA;
 243         }
 244
 245         if (opcode == 0xFF) {
 246
 247             count   = bytestream2_get_le16(&s->gb);
 248             src_pos = bytestream2_get_le16(&s->gb);
 249             av_dlog(s->avctx, "(1) copy %X bytes from absolute pos %X\n", count, src_pos);
 250             CHECK_COUNT();
 251             CHECK_COPY(src_pos);
 252             for (i = 0; i < count; i++)
 253                 dest[dest_index + i] = dest[src_pos + i];
 254             dest_index += count;
 255
 256         } else if (opcode == 0xFE) {
 257
 258             count = bytestream2_get_le16(&s->gb);
 259             color = bytestream2_get_byte(&s->gb);
 260             av_dlog(s->avctx, "(2) set %X bytes to %02X\n", count, color);
 261             CHECK_COUNT();
 262             memset(&dest[dest_index], color, count);
 263             dest_index += count;
 264
 265         } else if ((opcode & 0xC0) == 0xC0) {
 266
 267             count = (opcode & 0x3F) + 3;
 268             src_pos = bytestream2_get_le16(&s->gb);
 269             av_dlog(s->avctx, "(3) copy %X bytes from absolute pos %X\n", count, src_pos);
 270             CHECK_COUNT();
 271             CHECK_COPY(src_pos);
 272             for (i = 0; i < count; i++)
 273                 dest[dest_index + i] = dest[src_pos + i];
 274             dest_index += count;
 275
 276         } else if (opcode > 0x80) {
 277
 278             count = opcode & 0x3F;
 279             av_dlog(s->avctx, "(4) copy %X bytes from source to dest\n", count);
 280             CHECK_COUNT();
 281             bytestream2_get_buffer(&s->gb, &dest[dest_index], count);
 282             dest_index += count;
 283
 284         } else {
 285
 286             count = ((opcode & 0x70) >> 4) + 3;
 287             src_pos = bytestream2_get_byte(&s->gb) | ((opcode & 0x0F) << 8);
 288             av_dlog(s->avctx, "(5) copy %X bytes from relpos %X\n", count, src_pos);
 289             CHECK_COUNT();
 290             CHECK_COPY(dest_index - src_pos);
 291             for (i = 0; i < count; i++)
 292                 dest[dest_index + i] = dest[dest_index - src_pos + i];
 293             dest_index += count;
 294         }
 295     }
 296
 297     /* validate that the entire destination buffer was filled; this is
 298      * important for decoding frame maps since each vector needs to have a
 299      * codebook entry; it is not important for compressed codebooks because
 300      * not every entry needs to be filled */
 301     if (check_size)
 302         if (dest_index < dest_size)
 303             av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: decode finished with dest_index (%d) < dest_size (%d)\n",
 304                 dest_index, dest_size);
 305
 306     return 0; // let's display what we decoded anyway
 307 }
 308
 309 static int vqa_decode_chunk(VqaContext *s)
 310 {
 311     unsigned int chunk_type;
 312     unsigned int chunk_size;
 313     int byte_skip;
 314     unsigned int index = 0;
 315     int i;
 316     unsigned char r, g, b;
 317     int index_shift;
 318     int res;
 319
 320     int cbf0_chunk = -1;
 321     int cbfz_chunk = -1;
 322     int cbp0_chunk = -1;
 323     int cbpz_chunk = -1;
 324     int cpl0_chunk = -1;
 325     int cplz_chunk = -1;
 326     int vptz_chunk = -1;
 327
 328     int x, y;
 329     int lines = 0;
 330     int pixel_ptr;
 331     int vector_index = 0;
 332     int lobyte = 0;
 333     int hibyte = 0;
 334     int lobytes = 0;
 335     int hibytes = s->decode_buffer_size / 2;
 336
 337     /* first, traverse through the frame and find the subchunks */
 338     while (bytestream2_get_bytes_left(&s->gb) >= 8) {
 339
 340         chunk_type = bytestream2_get_be32u(&s->gb);
 341         index      = bytestream2_tell(&s->gb);
 342         chunk_size = bytestream2_get_be32u(&s->gb);
 343
 344         switch (chunk_type) {
 345
 346         case CBF0_TAG:
 347             cbf0_chunk = index;
 348             break;
 349
 350         case CBFZ_TAG:
 351             cbfz_chunk = index;
 352             break;
 353
 354         case CBP0_TAG:
 355             cbp0_chunk = index;
 356             break;
 357
 358         case CBPZ_TAG:
 359             cbpz_chunk = index;
 360             break;
 361
 362         case CPL0_TAG:
 363             cpl0_chunk = index;
 364             break;
 365
 366         case CPLZ_TAG:
 367             cplz_chunk = index;
 368             break;
 369
 370         case VPTZ_TAG:
 371             vptz_chunk = index;
 372             break;
 373
 374         default:
 375             av_log(s->avctx, AV_LOG_ERROR, "Found unknown chunk type: %c%c%c%c (%08X)\n",
 376             (chunk_type >> 24) & 0xFF,
 377             (chunk_type >> 16) & 0xFF,
 378             (chunk_type >>  8) & 0xFF,
 379             (chunk_type >>  0) & 0xFF,
 380             chunk_type);
 381             break;
 382         }
 383
 384         byte_skip = chunk_size & 0x01;
 385         bytestream2_skip(&s->gb, chunk_size + byte_skip);
 386     }
 387
 388     /* next, deal with the palette */
 389     if ((cpl0_chunk != -1) && (cplz_chunk != -1)) {
 390
 391         /* a chunk should not have both chunk types */
 392         av_log(s->avctx, AV_LOG_ERROR, "problem: found both CPL0 and CPLZ chunks\n");
 393         return AVERROR_INVALIDDATA;
 394     }
 395
 396     /* decompress the palette chunk */
 397     if (cplz_chunk != -1) {
 398
 399 /* yet to be handled */
 400
 401     }
 402
 403     /* convert the RGB palette into the machine's endian format */
 404     if (cpl0_chunk != -1) {
 405
 406         bytestream2_seek(&s->gb, cpl0_chunk, SEEK_SET);
 407         chunk_size = bytestream2_get_be32(&s->gb);
 408         /* sanity check the palette size */
 409         if (chunk_size / 3 > 256 || chunk_size > bytestream2_get_bytes_left(&s->gb)) {
 410             av_log(s->avctx, AV_LOG_ERROR, "problem: found a palette chunk with %d colors\n",
 411                 chunk_size / 3);
 412             return AVERROR_INVALIDDATA;
 413         }
 414         for (i = 0; i < chunk_size / 3; i++) {
 415             /* scale by 4 to transform 6-bit palette -> 8-bit */
 416             r = bytestream2_get_byteu(&s->gb) * 4;
 417             g = bytestream2_get_byteu(&s->gb) * 4;
 418             b = bytestream2_get_byteu(&s->gb) * 4;
 419             s->palette[i] = 0xFFU << 24 | r << 16 | g << 8 | b;
 420             s->palette[i] |= s->palette[i] >> 6 & 0x30303;
 421         }
 422     }
 423
 424     /* next, look for a full codebook */
 425     if ((cbf0_chunk != -1) && (cbfz_chunk != -1)) {
 426
 427         /* a chunk should not have both chunk types */
 428         av_log(s->avctx, AV_LOG_ERROR, "problem: found both CBF0 and CBFZ chunks\n");
 429         return AVERROR_INVALIDDATA;
 430     }
 431
 432     /* decompress the full codebook chunk */
 433     if (cbfz_chunk != -1) {
 434
 435         bytestream2_seek(&s->gb, cbfz_chunk, SEEK_SET);
 436         chunk_size = bytestream2_get_be32(&s->gb);
 437         if ((res = decode_format80(s, chunk_size, s->codebook,
 438                                    s->codebook_size, 0)) < 0)
 439             return res;
 440     }
 441
 442     /* copy a full codebook */
 443     if (cbf0_chunk != -1) {
 444
 445         bytestream2_seek(&s->gb, cbf0_chunk, SEEK_SET);
 446         chunk_size = bytestream2_get_be32(&s->gb);
 447         /* sanity check the full codebook size */
 448         if (chunk_size > MAX_CODEBOOK_SIZE) {
 449             av_log(s->avctx, AV_LOG_ERROR, "problem: CBF0 chunk too large (0x%X bytes)\n",
 450                 chunk_size);
 451             return AVERROR_INVALIDDATA;
 452         }
 453
 454         bytestream2_get_buffer(&s->gb, s->codebook, chunk_size);
 455     }
 456
 457     /* decode the frame */
 458     if (vptz_chunk == -1) {
 459
 460         /* something is wrong if there is no VPTZ chunk */
 461         av_log(s->avctx, AV_LOG_ERROR, "problem: no VPTZ chunk found\n");
 462         return AVERROR_INVALIDDATA;
 463     }
 464
 465     bytestream2_seek(&s->gb, vptz_chunk, SEEK_SET);
 466     chunk_size = bytestream2_get_be32(&s->gb);
 467     if ((res = decode_format80(s, chunk_size,
 468                                s->decode_buffer, s->decode_buffer_size, 1)) < 0)
 469         return res;
 470
 471     /* render the final PAL8 frame */
 472     if (s->vector_height == 4)
 473         index_shift = 4;
 474     else
 475         index_shift = 3;
 476     for (y = 0; y < s->height; y += s->vector_height) {
 477         for (x = 0; x < s->width; x += 4, lobytes++, hibytes++) {
 478             pixel_ptr = y * s->frame.linesize[0] + x;
 479
 480             /* get the vector index, the method for which varies according to
 481              * VQA file version */
 482             switch (s->vqa_version) {
 483
 484             case 1:
 485                 lobyte = s->decode_buffer[lobytes * 2];
 486                 hibyte = s->decode_buffer[(lobytes * 2) + 1];
 487                 vector_index = ((hibyte << 8) | lobyte) >> 3;
 488                 vector_index <<= index_shift;
 489                 lines = s->vector_height;
 490                 /* uniform color fill - a quick hack */
 491                 if (hibyte == 0xFF) {
 492                     while (lines--) {
 493                         s->frame.data[0][pixel_ptr + 0] = 255 - lobyte;
 494                         s->frame.data[0][pixel_ptr + 1] = 255 - lobyte;
 495                         s->frame.data[0][pixel_ptr + 2] = 255 - lobyte;
 496                         s->frame.data[0][pixel_ptr + 3] = 255 - lobyte;
 497                         pixel_ptr += s->frame.linesize[0];
 498                     }
 499                     lines=0;
 500                 }
 501                 break;
 502
 503             case 2:
 504                 lobyte = s->decode_buffer[lobytes];
 505                 hibyte = s->decode_buffer[hibytes];
 506                 vector_index = (hibyte << 8) | lobyte;
 507                 vector_index <<= index_shift;
 508                 lines = s->vector_height;
 509                 break;
 510
 511             case 3:
 512 /* not implemented yet */
 513                 lines = 0;
 514                 break;
 515             }
 516
 517             while (lines--) {
 518                 s->frame.data[0][pixel_ptr + 0] = s->codebook[vector_index++];
 519                 s->frame.data[0][pixel_ptr + 1] = s->codebook[vector_index++];
 520                 s->frame.data[0][pixel_ptr + 2] = s->codebook[vector_index++];
 521                 s->frame.data[0][pixel_ptr + 3] = s->codebook[vector_index++];
 522                 pixel_ptr += s->frame.linesize[0];
 523             }
 524         }
 525     }
 526
 527     /* handle partial codebook */
 528     if ((cbp0_chunk != -1) && (cbpz_chunk != -1)) {
 529         /* a chunk should not have both chunk types */
 530         av_log(s->avctx, AV_LOG_ERROR, "problem: found both CBP0 and CBPZ chunks\n");
 531         return AVERROR_INVALIDDATA;
 532     }
 533
 534     if (cbp0_chunk != -1) {
 535
 536         bytestream2_seek(&s->gb, cbp0_chunk, SEEK_SET);
 537         chunk_size = bytestream2_get_be32(&s->gb);
 538
 539         /* accumulate partial codebook */
 540         bytestream2_get_buffer(&s->gb, &s->next_codebook_buffer[s->next_codebook_buffer_index],
 541                                chunk_size);
 542         s->next_codebook_buffer_index += chunk_size;
 543
 544         s->partial_countdown--;
 545         if (s->partial_countdown <= 0) {
 546
 547             /* time to replace codebook */
 548             memcpy(s->codebook, s->next_codebook_buffer,
 549                 s->next_codebook_buffer_index);
 550
 551             /* reset accounting */
 552             s->next_codebook_buffer_index = 0;
 553             s->partial_countdown = s->partial_count;
 554         }
 555     }
 556
 557     if (cbpz_chunk != -1) {
 558
 559         bytestream2_seek(&s->gb, cbpz_chunk, SEEK_SET);
 560         chunk_size = bytestream2_get_be32(&s->gb);
 561
 562         /* accumulate partial codebook */
 563         bytestream2_get_buffer(&s->gb, &s->next_codebook_buffer[s->next_codebook_buffer_index],
 564                                chunk_size);
 565         s->next_codebook_buffer_index += chunk_size;
 566
 567         s->partial_countdown--;
 568         if (s->partial_countdown <= 0) {
 569             bytestream2_init(&s->gb, s->next_codebook_buffer, s->next_codebook_buffer_index);
 570             /* decompress codebook */
 571             if ((res = decode_format80(s, s->next_codebook_buffer_index,
 572                                        s->codebook, s->codebook_size, 0)) < 0)
 573                 return res;
 574
 575             /* reset accounting */
 576             s->next_codebook_buffer_index = 0;
 577             s->partial_countdown = s->partial_count;
 578         }
 579     }
 580
 581     return 0;
 582 }
 583
 584 static int vqa_decode_frame(AVCodecContext *avctx,
 585                             void *data, int *data_size,
 586                             AVPacket *avpkt)
 587 {
 588     VqaContext *s = avctx->priv_data;
 589     int res;
 590
 591     if (s->frame.data[0])
 592         avctx->release_buffer(avctx, &s->frame);
 593
 594     if ((res = avctx->get_buffer(avctx, &s->frame))) {
 595         av_log(s->avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 596         return res;
 597     }
 598
 599     bytestream2_init(&s->gb, avpkt->data, avpkt->size);
 600     if ((res = vqa_decode_chunk(s)) < 0)
 601         return res;
 602
 603     /* make the palette available on the way out */
 604     memcpy(s->frame.data[1], s->palette, PALETTE_COUNT * 4);
 605     s->frame.palette_has_changed = 1;
 606
 607     *data_size = sizeof(AVFrame);
 608     *(AVFrame*)data = s->frame;
 609
 610     /* report that the buffer was completely consumed */
 611     return avpkt->size;
 612 }
 613
 614 static av_cold int vqa_decode_end(AVCodecContext *avctx)
 615 {
 616     VqaContext *s = avctx->priv_data;
 617
 618     av_freep(&s->codebook);
 619     av_freep(&s->next_codebook_buffer);
 620     av_freep(&s->decode_buffer);
 621
 622     if (s->frame.data[0])
 623         avctx->release_buffer(avctx, &s->frame);
 624
 625     return 0;
 626 }
 627
 628 AVCodec ff_vqa_decoder = {
 629     .name           = "vqavideo",
 630     .type           = AVMEDIA_TYPE_VIDEO,
 631     .id             = AV_CODEC_ID_WS_VQA,
 632     .priv_data_size = sizeof(VqaContext),
 633     .init           = vqa_decode_init,
 634     .close          = vqa_decode_end,
 635     .decode         = vqa_decode_frame,
 636     .capabilities   = CODEC_CAP_DR1,
 637     .long_name      = NULL_IF_CONFIG_SMALL("Westwood Studios VQA (Vector Quantized Animation) video"),
 638 };