2 * Westwood Studios VQA Video Decoder
3 * Copyright (C) 2003 the ffmpeg project
5 * This file is part of FFmpeg.
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.
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.
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
25 * VQA Video Decoder by Mike Melanson (melanson@pcisys.net)
26 * For more information about the VQA format, visit:
27 * http://wiki.multimedia.cx/index.php?title=VQA
29 * The VQA video decoder outputs PAL8 or RGB555 colorspace data, depending
30 * on the type of data in the file.
32 * This decoder needs the 42-byte VQHD header from the beginning
33 * of the VQA file passed through the extradata field. The VQHD header
36 * bytes 0-3 chunk fourcc: 'VQHD'
37 * bytes 4-7 chunk size in big-endian format, should be 0x0000002A
38 * bytes 8-49 VQHD chunk data
40 * Bytes 8-49 are what this decoder expects to see.
42 * Briefly, VQA is a vector quantized animation format that operates in a
43 * VGA palettized colorspace. It operates on pixel vectors (blocks)
44 * of either 4x2 or 4x4 in size. Compressed VQA chunks can contain vector
45 * codebooks, palette information, and code maps for rendering vectors onto
46 * frames. Any of these components can also be compressed with a run-length
47 * encoding (RLE) algorithm commonly referred to as "format80".
49 * VQA takes a novel approach to rate control. Each group of n frames
50 * (usually, n = 8) relies on a different vector codebook. Rather than
51 * transporting an entire codebook every 8th frame, the new codebook is
52 * broken up into 8 pieces and sent along with the compressed video chunks
53 * for each of the 8 frames preceding the 8 frames which require the
54 * codebook. A full codebook is also sent on the very first frame of a
55 * file. This is an interesting technique, although it makes random file
56 * seeking difficult despite the fact that the frames are all intracoded.
58 * V1,2 VQA uses 12-bit codebook indices. If the 12-bit indices were
59 * packed into bytes and then RLE compressed, bytewise, the results would
60 * be poor. That is why the coding method divides each index into 2 parts,
61 * the top 4 bits and the bottom 8 bits, then RL encodes the 4-bit pieces
62 * together and the 8-bit pieces together. If most of the vectors are
63 * clustered into one group of 256 vectors, most of the 4-bit index pieces
76 #define PALETTE_COUNT 256
77 #define VQA_HEADER_SIZE 0x2A
78 #define CHUNK_PREAMBLE_SIZE 8
80 /* allocate the maximum vector space, regardless of the file version:
81 * (0xFF00 codebook vectors + 0x100 solid pixel vectors) * (4x4 pixels/block) */
82 #define MAX_CODEBOOK_VECTORS 0xFF00
83 #define SOLID_PIXEL_VECTORS 0x100
84 #define MAX_VECTORS (MAX_CODEBOOK_VECTORS + SOLID_PIXEL_VECTORS)
85 #define MAX_CODEBOOK_SIZE (MAX_VECTORS * 4 * 4)
87 #define CBF0_TAG MKBETAG('C', 'B', 'F', '0')
88 #define CBFZ_TAG MKBETAG('C', 'B', 'F', 'Z')
89 #define CBP0_TAG MKBETAG('C', 'B', 'P', '0')
90 #define CBPZ_TAG MKBETAG('C', 'B', 'P', 'Z')
91 #define CPL0_TAG MKBETAG('C', 'P', 'L', '0')
92 #define CPLZ_TAG MKBETAG('C', 'P', 'L', 'Z')
93 #define VPTZ_TAG MKBETAG('V', 'P', 'T', 'Z')
98 #define vqa_debug printf
100 static inline void vqa_debug(const char *format, ...) { }
103 typedef struct VqaContext {
105 AVCodecContext *avctx;
112 uint32_t palette[PALETTE_COUNT];
114 int width; /* width of a frame */
115 int height; /* height of a frame */
116 int vector_width; /* width of individual vector */
117 int vector_height; /* height of individual vector */
118 int vqa_version; /* this should be either 1, 2 or 3 */
120 unsigned char *codebook; /* the current codebook */
122 unsigned char *next_codebook_buffer; /* accumulator for next codebook */
123 int next_codebook_buffer_index;
125 unsigned char *decode_buffer;
126 int decode_buffer_size;
128 /* number of frames to go before replacing codebook */
129 int partial_countdown;
134 static int vqa_decode_init(AVCodecContext *avctx)
136 VqaContext *s = (VqaContext *)avctx->priv_data;
137 unsigned char *vqa_header;
138 int i, j, codebook_index;;
141 avctx->pix_fmt = PIX_FMT_PAL8;
142 dsputil_init(&s->dsp, avctx);
144 /* make sure the extradata made it */
145 if (s->avctx->extradata_size != VQA_HEADER_SIZE) {
146 av_log(s->avctx, AV_LOG_ERROR, " VQA video: expected extradata size of %d\n", VQA_HEADER_SIZE);
150 /* load up the VQA parameters from the header */
151 vqa_header = (unsigned char *)s->avctx->extradata;
152 s->vqa_version = vqa_header[0];
153 s->width = AV_RL16(&vqa_header[6]);
154 s->height = AV_RL16(&vqa_header[8]);
155 if(avcodec_check_dimensions(avctx, s->width, s->height)){
156 s->width= s->height= 0;
159 s->vector_width = vqa_header[10];
160 s->vector_height = vqa_header[11];
161 s->partial_count = s->partial_countdown = vqa_header[13];
163 /* the vector dimensions have to meet very stringent requirements */
164 if ((s->vector_width != 4) ||
165 ((s->vector_height != 2) && (s->vector_height != 4))) {
166 /* return without further initialization */
170 /* allocate codebooks */
171 s->codebook_size = MAX_CODEBOOK_SIZE;
172 s->codebook = av_malloc(s->codebook_size);
173 s->next_codebook_buffer = av_malloc(s->codebook_size);
175 /* initialize the solid-color vectors */
176 if (s->vector_height == 4) {
177 codebook_index = 0xFF00 * 16;
178 for (i = 0; i < 256; i++)
179 for (j = 0; j < 16; j++)
180 s->codebook[codebook_index++] = i;
182 codebook_index = 0xF00 * 8;
183 for (i = 0; i < 256; i++)
184 for (j = 0; j < 8; j++)
185 s->codebook[codebook_index++] = i;
187 s->next_codebook_buffer_index = 0;
189 /* allocate decode buffer */
190 s->decode_buffer_size = (s->width / s->vector_width) *
191 (s->height / s->vector_height) * 2;
192 s->decode_buffer = av_malloc(s->decode_buffer_size);
194 s->frame.data[0] = NULL;
199 #define CHECK_COUNT() \
200 if (dest_index + count > dest_size) { \
201 av_log(NULL, AV_LOG_ERROR, " VQA video: decode_format80 problem: next op would overflow dest_index\n"); \
202 av_log(NULL, AV_LOG_ERROR, " VQA video: current dest_index = %d, count = %d, dest_size = %d\n", \
203 dest_index, count, dest_size); \
207 static void decode_format80(unsigned char *src, int src_size,
208 unsigned char *dest, int dest_size, int check_size) {
217 while (src_index < src_size) {
219 vqa_debug(" opcode %02X: ", src[src_index]);
221 /* 0x80 means that frame is finished */
222 if (src[src_index] == 0x80)
225 if (dest_index >= dest_size) {
226 av_log(NULL, AV_LOG_ERROR, " VQA video: decode_format80 problem: dest_index (%d) exceeded dest_size (%d)\n",
227 dest_index, dest_size);
231 if (src[src_index] == 0xFF) {
234 count = AV_RL16(&src[src_index]);
236 src_pos = AV_RL16(&src[src_index]);
238 vqa_debug("(1) copy %X bytes from absolute pos %X\n", count, src_pos);
240 for (i = 0; i < count; i++)
241 dest[dest_index + i] = dest[src_pos + i];
244 } else if (src[src_index] == 0xFE) {
247 count = AV_RL16(&src[src_index]);
249 color = src[src_index++];
250 vqa_debug("(2) set %X bytes to %02X\n", count, color);
252 memset(&dest[dest_index], color, count);
255 } else if ((src[src_index] & 0xC0) == 0xC0) {
257 count = (src[src_index++] & 0x3F) + 3;
258 src_pos = AV_RL16(&src[src_index]);
260 vqa_debug("(3) copy %X bytes from absolute pos %X\n", count, src_pos);
262 for (i = 0; i < count; i++)
263 dest[dest_index + i] = dest[src_pos + i];
266 } else if (src[src_index] > 0x80) {
268 count = src[src_index++] & 0x3F;
269 vqa_debug("(4) copy %X bytes from source to dest\n", count);
271 memcpy(&dest[dest_index], &src[src_index], count);
277 count = ((src[src_index] & 0x70) >> 4) + 3;
278 src_pos = AV_RB16(&src[src_index]) & 0x0FFF;
280 vqa_debug("(5) copy %X bytes from relpos %X\n", count, src_pos);
282 for (i = 0; i < count; i++)
283 dest[dest_index + i] = dest[dest_index - src_pos + i];
288 /* validate that the entire destination buffer was filled; this is
289 * important for decoding frame maps since each vector needs to have a
290 * codebook entry; it is not important for compressed codebooks because
291 * not every entry needs to be filled */
293 if (dest_index < dest_size)
294 av_log(NULL, AV_LOG_ERROR, " VQA video: decode_format80 problem: decode finished with dest_index (%d) < dest_size (%d)\n",
295 dest_index, dest_size);
298 static void vqa_decode_chunk(VqaContext *s)
300 unsigned int chunk_type;
301 unsigned int chunk_size;
303 unsigned int index = 0;
305 unsigned char r, g, b;
319 int vector_index = 0;
323 int hibytes = s->decode_buffer_size / 2;
325 /* first, traverse through the frame and find the subchunks */
326 while (index < s->size) {
328 chunk_type = AV_RB32(&s->buf[index]);
329 chunk_size = AV_RB32(&s->buf[index + 4]);
331 switch (chunk_type) {
362 av_log(s->avctx, AV_LOG_ERROR, " VQA video: Found unknown chunk type: %c%c%c%c (%08X)\n",
363 (chunk_type >> 24) & 0xFF,
364 (chunk_type >> 16) & 0xFF,
365 (chunk_type >> 8) & 0xFF,
366 (chunk_type >> 0) & 0xFF,
371 byte_skip = chunk_size & 0x01;
372 index += (CHUNK_PREAMBLE_SIZE + chunk_size + byte_skip);
375 /* next, deal with the palette */
376 if ((cpl0_chunk != -1) && (cplz_chunk != -1)) {
378 /* a chunk should not have both chunk types */
379 av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found both CPL0 and CPLZ chunks\n");
383 /* decompress the palette chunk */
384 if (cplz_chunk != -1) {
386 /* yet to be handled */
390 /* convert the RGB palette into the machine's endian format */
391 if (cpl0_chunk != -1) {
393 chunk_size = AV_RB32(&s->buf[cpl0_chunk + 4]);
394 /* sanity check the palette size */
395 if (chunk_size / 3 > 256) {
396 av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found a palette chunk with %d colors\n",
400 cpl0_chunk += CHUNK_PREAMBLE_SIZE;
401 for (i = 0; i < chunk_size / 3; i++) {
402 /* scale by 4 to transform 6-bit palette -> 8-bit */
403 r = s->buf[cpl0_chunk++] * 4;
404 g = s->buf[cpl0_chunk++] * 4;
405 b = s->buf[cpl0_chunk++] * 4;
406 s->palette[i] = (r << 16) | (g << 8) | (b);
410 /* next, look for a full codebook */
411 if ((cbf0_chunk != -1) && (cbfz_chunk != -1)) {
413 /* a chunk should not have both chunk types */
414 av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found both CBF0 and CBFZ chunks\n");
418 /* decompress the full codebook chunk */
419 if (cbfz_chunk != -1) {
421 chunk_size = AV_RB32(&s->buf[cbfz_chunk + 4]);
422 cbfz_chunk += CHUNK_PREAMBLE_SIZE;
423 decode_format80(&s->buf[cbfz_chunk], chunk_size,
424 s->codebook, s->codebook_size, 0);
427 /* copy a full codebook */
428 if (cbf0_chunk != -1) {
430 chunk_size = AV_RB32(&s->buf[cbf0_chunk + 4]);
431 /* sanity check the full codebook size */
432 if (chunk_size > MAX_CODEBOOK_SIZE) {
433 av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: CBF0 chunk too large (0x%X bytes)\n",
437 cbf0_chunk += CHUNK_PREAMBLE_SIZE;
439 memcpy(s->codebook, &s->buf[cbf0_chunk], chunk_size);
442 /* decode the frame */
443 if (vptz_chunk == -1) {
445 /* something is wrong if there is no VPTZ chunk */
446 av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: no VPTZ chunk found\n");
450 chunk_size = AV_RB32(&s->buf[vptz_chunk + 4]);
451 vptz_chunk += CHUNK_PREAMBLE_SIZE;
452 decode_format80(&s->buf[vptz_chunk], chunk_size,
453 s->decode_buffer, s->decode_buffer_size, 1);
455 /* render the final PAL8 frame */
456 if (s->vector_height == 4)
460 for (y = 0; y < s->frame.linesize[0] * s->height;
461 y += s->frame.linesize[0] * s->vector_height) {
463 for (x = y; x < y + s->width; x += 4, lobytes++, hibytes++) {
466 /* get the vector index, the method for which varies according to
467 * VQA file version */
468 switch (s->vqa_version) {
471 /* still need sample media for this case (only one game, "Legend of
472 * Kyrandia III : Malcolm's Revenge", is known to use this version) */
473 lobyte = s->decode_buffer[lobytes * 2];
474 hibyte = s->decode_buffer[(lobytes * 2) + 1];
475 vector_index = ((hibyte << 8) | lobyte) >> 3;
476 vector_index <<= index_shift;
477 lines = s->vector_height;
478 /* uniform color fill - a quick hack */
479 if (hibyte == 0xFF) {
481 s->frame.data[0][pixel_ptr + 0] = 255 - lobyte;
482 s->frame.data[0][pixel_ptr + 1] = 255 - lobyte;
483 s->frame.data[0][pixel_ptr + 2] = 255 - lobyte;
484 s->frame.data[0][pixel_ptr + 3] = 255 - lobyte;
485 pixel_ptr += s->frame.linesize[0];
492 lobyte = s->decode_buffer[lobytes];
493 hibyte = s->decode_buffer[hibytes];
494 vector_index = (hibyte << 8) | lobyte;
495 vector_index <<= index_shift;
496 lines = s->vector_height;
500 /* not implemented yet */
506 s->frame.data[0][pixel_ptr + 0] = s->codebook[vector_index++];
507 s->frame.data[0][pixel_ptr + 1] = s->codebook[vector_index++];
508 s->frame.data[0][pixel_ptr + 2] = s->codebook[vector_index++];
509 s->frame.data[0][pixel_ptr + 3] = s->codebook[vector_index++];
510 pixel_ptr += s->frame.linesize[0];
515 /* handle partial codebook */
516 if ((cbp0_chunk != -1) && (cbpz_chunk != -1)) {
517 /* a chunk should not have both chunk types */
518 av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found both CBP0 and CBPZ chunks\n");
522 if (cbp0_chunk != -1) {
524 chunk_size = AV_RB32(&s->buf[cbp0_chunk + 4]);
525 cbp0_chunk += CHUNK_PREAMBLE_SIZE;
527 /* accumulate partial codebook */
528 memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
529 &s->buf[cbp0_chunk], chunk_size);
530 s->next_codebook_buffer_index += chunk_size;
532 s->partial_countdown--;
533 if (s->partial_countdown == 0) {
535 /* time to replace codebook */
536 memcpy(s->codebook, s->next_codebook_buffer,
537 s->next_codebook_buffer_index);
539 /* reset accounting */
540 s->next_codebook_buffer_index = 0;
541 s->partial_countdown = s->partial_count;
545 if (cbpz_chunk != -1) {
547 chunk_size = AV_RB32(&s->buf[cbpz_chunk + 4]);
548 cbpz_chunk += CHUNK_PREAMBLE_SIZE;
550 /* accumulate partial codebook */
551 memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
552 &s->buf[cbpz_chunk], chunk_size);
553 s->next_codebook_buffer_index += chunk_size;
555 s->partial_countdown--;
556 if (s->partial_countdown == 0) {
558 /* decompress codebook */
559 decode_format80(s->next_codebook_buffer,
560 s->next_codebook_buffer_index,
561 s->codebook, s->codebook_size, 0);
563 /* reset accounting */
564 s->next_codebook_buffer_index = 0;
565 s->partial_countdown = s->partial_count;
570 static int vqa_decode_frame(AVCodecContext *avctx,
571 void *data, int *data_size,
572 uint8_t *buf, int buf_size)
574 VqaContext *s = (VqaContext *)avctx->priv_data;
579 if (s->frame.data[0])
580 avctx->release_buffer(avctx, &s->frame);
582 if (avctx->get_buffer(avctx, &s->frame)) {
583 av_log(s->avctx, AV_LOG_ERROR, " VQA Video: get_buffer() failed\n");
589 /* make the palette available on the way out */
590 memcpy(s->frame.data[1], s->palette, PALETTE_COUNT * 4);
591 s->frame.palette_has_changed = 1;
593 *data_size = sizeof(AVFrame);
594 *(AVFrame*)data = s->frame;
596 /* report that the buffer was completely consumed */
600 static int vqa_decode_end(AVCodecContext *avctx)
602 VqaContext *s = (VqaContext *)avctx->priv_data;
604 av_free(s->codebook);
605 av_free(s->next_codebook_buffer);
606 av_free(s->decode_buffer);
608 if (s->frame.data[0])
609 avctx->release_buffer(avctx, &s->frame);
614 AVCodec vqa_decoder = {