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
24
* VQA Video Decoder by Mike Melanson (melanson@pcisys.net)
25
* For more information about the VQA format, visit:
26
* http://wiki.multimedia.cx/index.php?title=VQA
28
* The VQA video decoder outputs PAL8 or RGB555 colorspace data, depending
29
* on the type of data in the file.
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
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
39
* Bytes 8-49 are what this decoder expects to see.
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".
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.
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
70
#include "libavutil/intreadwrite.h"
71
#include "libavcore/imgutils.h"
74
#define PALETTE_COUNT 256
75
#define VQA_HEADER_SIZE 0x2A
76
#define CHUNK_PREAMBLE_SIZE 8
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)
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')
96
#define vqa_debug printf
98
static inline void vqa_debug(const char *format, ...) { }
101
typedef struct VqaContext {
103
AVCodecContext *avctx;
106
const unsigned char *buf;
109
uint32_t palette[PALETTE_COUNT];
111
int width; /* width of a frame */
112
int height; /* height of a frame */
113
int vector_width; /* width of individual vector */
114
int vector_height; /* height of individual vector */
115
int vqa_version; /* this should be either 1, 2 or 3 */
117
unsigned char *codebook; /* the current codebook */
119
unsigned char *next_codebook_buffer; /* accumulator for next codebook */
120
int next_codebook_buffer_index;
122
unsigned char *decode_buffer;
123
int decode_buffer_size;
125
/* number of frames to go before replacing codebook */
126
int partial_countdown;
131
static av_cold int vqa_decode_init(AVCodecContext *avctx)
133
VqaContext *s = avctx->priv_data;
134
unsigned char *vqa_header;
135
int i, j, codebook_index;
138
avctx->pix_fmt = PIX_FMT_PAL8;
140
/* make sure the extradata made it */
141
if (s->avctx->extradata_size != VQA_HEADER_SIZE) {
142
av_log(s->avctx, AV_LOG_ERROR, " VQA video: expected extradata size of %d\n", VQA_HEADER_SIZE);
146
/* load up the VQA parameters from the header */
147
vqa_header = (unsigned char *)s->avctx->extradata;
148
s->vqa_version = vqa_header[0];
149
s->width = AV_RL16(&vqa_header[6]);
150
s->height = AV_RL16(&vqa_header[8]);
151
if(av_image_check_size(s->width, s->height, 0, avctx)){
152
s->width= s->height= 0;
155
s->vector_width = vqa_header[10];
156
s->vector_height = vqa_header[11];
157
s->partial_count = s->partial_countdown = vqa_header[13];
159
/* the vector dimensions have to meet very stringent requirements */
160
if ((s->vector_width != 4) ||
161
((s->vector_height != 2) && (s->vector_height != 4))) {
162
/* return without further initialization */
166
/* allocate codebooks */
167
s->codebook_size = MAX_CODEBOOK_SIZE;
168
s->codebook = av_malloc(s->codebook_size);
169
s->next_codebook_buffer = av_malloc(s->codebook_size);
171
/* initialize the solid-color vectors */
172
if (s->vector_height == 4) {
173
codebook_index = 0xFF00 * 16;
174
for (i = 0; i < 256; i++)
175
for (j = 0; j < 16; j++)
176
s->codebook[codebook_index++] = i;
178
codebook_index = 0xF00 * 8;
179
for (i = 0; i < 256; i++)
180
for (j = 0; j < 8; j++)
181
s->codebook[codebook_index++] = i;
183
s->next_codebook_buffer_index = 0;
185
/* allocate decode buffer */
186
s->decode_buffer_size = (s->width / s->vector_width) *
187
(s->height / s->vector_height) * 2;
188
s->decode_buffer = av_malloc(s->decode_buffer_size);
190
s->frame.data[0] = NULL;
195
#define CHECK_COUNT() \
196
if (dest_index + count > dest_size) { \
197
av_log(NULL, AV_LOG_ERROR, " VQA video: decode_format80 problem: next op would overflow dest_index\n"); \
198
av_log(NULL, AV_LOG_ERROR, " VQA video: current dest_index = %d, count = %d, dest_size = %d\n", \
199
dest_index, count, dest_size); \
203
static void decode_format80(const unsigned char *src, int src_size,
204
unsigned char *dest, int dest_size, int check_size) {
213
while (src_index < src_size) {
215
vqa_debug(" opcode %02X: ", src[src_index]);
217
/* 0x80 means that frame is finished */
218
if (src[src_index] == 0x80)
221
if (dest_index >= dest_size) {
222
av_log(NULL, AV_LOG_ERROR, " VQA video: decode_format80 problem: dest_index (%d) exceeded dest_size (%d)\n",
223
dest_index, dest_size);
227
if (src[src_index] == 0xFF) {
230
count = AV_RL16(&src[src_index]);
232
src_pos = AV_RL16(&src[src_index]);
234
vqa_debug("(1) copy %X bytes from absolute pos %X\n", count, src_pos);
236
for (i = 0; i < count; i++)
237
dest[dest_index + i] = dest[src_pos + i];
240
} else if (src[src_index] == 0xFE) {
243
count = AV_RL16(&src[src_index]);
245
color = src[src_index++];
246
vqa_debug("(2) set %X bytes to %02X\n", count, color);
248
memset(&dest[dest_index], color, count);
251
} else if ((src[src_index] & 0xC0) == 0xC0) {
253
count = (src[src_index++] & 0x3F) + 3;
254
src_pos = AV_RL16(&src[src_index]);
256
vqa_debug("(3) copy %X bytes from absolute pos %X\n", count, src_pos);
258
for (i = 0; i < count; i++)
259
dest[dest_index + i] = dest[src_pos + i];
262
} else if (src[src_index] > 0x80) {
264
count = src[src_index++] & 0x3F;
265
vqa_debug("(4) copy %X bytes from source to dest\n", count);
267
memcpy(&dest[dest_index], &src[src_index], count);
273
count = ((src[src_index] & 0x70) >> 4) + 3;
274
src_pos = AV_RB16(&src[src_index]) & 0x0FFF;
276
vqa_debug("(5) copy %X bytes from relpos %X\n", count, src_pos);
278
for (i = 0; i < count; i++)
279
dest[dest_index + i] = dest[dest_index - src_pos + i];
284
/* validate that the entire destination buffer was filled; this is
285
* important for decoding frame maps since each vector needs to have a
286
* codebook entry; it is not important for compressed codebooks because
287
* not every entry needs to be filled */
289
if (dest_index < dest_size)
290
av_log(NULL, AV_LOG_ERROR, " VQA video: decode_format80 problem: decode finished with dest_index (%d) < dest_size (%d)\n",
291
dest_index, dest_size);
294
static void vqa_decode_chunk(VqaContext *s)
296
unsigned int chunk_type;
297
unsigned int chunk_size;
299
unsigned int index = 0;
301
unsigned char r, g, b;
315
int vector_index = 0;
319
int hibytes = s->decode_buffer_size / 2;
321
/* first, traverse through the frame and find the subchunks */
322
while (index < s->size) {
324
chunk_type = AV_RB32(&s->buf[index]);
325
chunk_size = AV_RB32(&s->buf[index + 4]);
327
switch (chunk_type) {
358
av_log(s->avctx, AV_LOG_ERROR, " VQA video: Found unknown chunk type: %c%c%c%c (%08X)\n",
359
(chunk_type >> 24) & 0xFF,
360
(chunk_type >> 16) & 0xFF,
361
(chunk_type >> 8) & 0xFF,
362
(chunk_type >> 0) & 0xFF,
367
byte_skip = chunk_size & 0x01;
368
index += (CHUNK_PREAMBLE_SIZE + chunk_size + byte_skip);
371
/* next, deal with the palette */
372
if ((cpl0_chunk != -1) && (cplz_chunk != -1)) {
374
/* a chunk should not have both chunk types */
375
av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found both CPL0 and CPLZ chunks\n");
379
/* decompress the palette chunk */
380
if (cplz_chunk != -1) {
382
/* yet to be handled */
386
/* convert the RGB palette into the machine's endian format */
387
if (cpl0_chunk != -1) {
389
chunk_size = AV_RB32(&s->buf[cpl0_chunk + 4]);
390
/* sanity check the palette size */
391
if (chunk_size / 3 > 256) {
392
av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found a palette chunk with %d colors\n",
396
cpl0_chunk += CHUNK_PREAMBLE_SIZE;
397
for (i = 0; i < chunk_size / 3; i++) {
398
/* scale by 4 to transform 6-bit palette -> 8-bit */
399
r = s->buf[cpl0_chunk++] * 4;
400
g = s->buf[cpl0_chunk++] * 4;
401
b = s->buf[cpl0_chunk++] * 4;
402
s->palette[i] = (r << 16) | (g << 8) | (b);
406
/* next, look for a full codebook */
407
if ((cbf0_chunk != -1) && (cbfz_chunk != -1)) {
409
/* a chunk should not have both chunk types */
410
av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found both CBF0 and CBFZ chunks\n");
414
/* decompress the full codebook chunk */
415
if (cbfz_chunk != -1) {
417
chunk_size = AV_RB32(&s->buf[cbfz_chunk + 4]);
418
cbfz_chunk += CHUNK_PREAMBLE_SIZE;
419
decode_format80(&s->buf[cbfz_chunk], chunk_size,
420
s->codebook, s->codebook_size, 0);
423
/* copy a full codebook */
424
if (cbf0_chunk != -1) {
426
chunk_size = AV_RB32(&s->buf[cbf0_chunk + 4]);
427
/* sanity check the full codebook size */
428
if (chunk_size > MAX_CODEBOOK_SIZE) {
429
av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: CBF0 chunk too large (0x%X bytes)\n",
433
cbf0_chunk += CHUNK_PREAMBLE_SIZE;
435
memcpy(s->codebook, &s->buf[cbf0_chunk], chunk_size);
438
/* decode the frame */
439
if (vptz_chunk == -1) {
441
/* something is wrong if there is no VPTZ chunk */
442
av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: no VPTZ chunk found\n");
446
chunk_size = AV_RB32(&s->buf[vptz_chunk + 4]);
447
vptz_chunk += CHUNK_PREAMBLE_SIZE;
448
decode_format80(&s->buf[vptz_chunk], chunk_size,
449
s->decode_buffer, s->decode_buffer_size, 1);
451
/* render the final PAL8 frame */
452
if (s->vector_height == 4)
456
for (y = 0; y < s->frame.linesize[0] * s->height;
457
y += s->frame.linesize[0] * s->vector_height) {
459
for (x = y; x < y + s->width; x += 4, lobytes++, hibytes++) {
462
/* get the vector index, the method for which varies according to
463
* VQA file version */
464
switch (s->vqa_version) {
467
/* still need sample media for this case (only one game, "Legend of
468
* Kyrandia III : Malcolm's Revenge", is known to use this version) */
469
lobyte = s->decode_buffer[lobytes * 2];
470
hibyte = s->decode_buffer[(lobytes * 2) + 1];
471
vector_index = ((hibyte << 8) | lobyte) >> 3;
472
vector_index <<= index_shift;
473
lines = s->vector_height;
474
/* uniform color fill - a quick hack */
475
if (hibyte == 0xFF) {
477
s->frame.data[0][pixel_ptr + 0] = 255 - lobyte;
478
s->frame.data[0][pixel_ptr + 1] = 255 - lobyte;
479
s->frame.data[0][pixel_ptr + 2] = 255 - lobyte;
480
s->frame.data[0][pixel_ptr + 3] = 255 - lobyte;
481
pixel_ptr += s->frame.linesize[0];
488
lobyte = s->decode_buffer[lobytes];
489
hibyte = s->decode_buffer[hibytes];
490
vector_index = (hibyte << 8) | lobyte;
491
vector_index <<= index_shift;
492
lines = s->vector_height;
496
/* not implemented yet */
502
s->frame.data[0][pixel_ptr + 0] = s->codebook[vector_index++];
503
s->frame.data[0][pixel_ptr + 1] = s->codebook[vector_index++];
504
s->frame.data[0][pixel_ptr + 2] = s->codebook[vector_index++];
505
s->frame.data[0][pixel_ptr + 3] = s->codebook[vector_index++];
506
pixel_ptr += s->frame.linesize[0];
511
/* handle partial codebook */
512
if ((cbp0_chunk != -1) && (cbpz_chunk != -1)) {
513
/* a chunk should not have both chunk types */
514
av_log(s->avctx, AV_LOG_ERROR, " VQA video: problem: found both CBP0 and CBPZ chunks\n");
518
if (cbp0_chunk != -1) {
520
chunk_size = AV_RB32(&s->buf[cbp0_chunk + 4]);
521
cbp0_chunk += CHUNK_PREAMBLE_SIZE;
523
/* accumulate partial codebook */
524
memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
525
&s->buf[cbp0_chunk], chunk_size);
526
s->next_codebook_buffer_index += chunk_size;
528
s->partial_countdown--;
529
if (s->partial_countdown == 0) {
531
/* time to replace codebook */
532
memcpy(s->codebook, s->next_codebook_buffer,
533
s->next_codebook_buffer_index);
535
/* reset accounting */
536
s->next_codebook_buffer_index = 0;
537
s->partial_countdown = s->partial_count;
541
if (cbpz_chunk != -1) {
543
chunk_size = AV_RB32(&s->buf[cbpz_chunk + 4]);
544
cbpz_chunk += CHUNK_PREAMBLE_SIZE;
546
/* accumulate partial codebook */
547
memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
548
&s->buf[cbpz_chunk], chunk_size);
549
s->next_codebook_buffer_index += chunk_size;
551
s->partial_countdown--;
552
if (s->partial_countdown == 0) {
554
/* decompress codebook */
555
decode_format80(s->next_codebook_buffer,
556
s->next_codebook_buffer_index,
557
s->codebook, s->codebook_size, 0);
559
/* reset accounting */
560
s->next_codebook_buffer_index = 0;
561
s->partial_countdown = s->partial_count;
566
static int vqa_decode_frame(AVCodecContext *avctx,
567
void *data, int *data_size,
570
const uint8_t *buf = avpkt->data;
571
int buf_size = avpkt->size;
572
VqaContext *s = avctx->priv_data;
577
if (s->frame.data[0])
578
avctx->release_buffer(avctx, &s->frame);
580
if (avctx->get_buffer(avctx, &s->frame)) {
581
av_log(s->avctx, AV_LOG_ERROR, " VQA Video: get_buffer() failed\n");
587
/* make the palette available on the way out */
588
memcpy(s->frame.data[1], s->palette, PALETTE_COUNT * 4);
589
s->frame.palette_has_changed = 1;
591
*data_size = sizeof(AVFrame);
592
*(AVFrame*)data = s->frame;
594
/* report that the buffer was completely consumed */
598
static av_cold int vqa_decode_end(AVCodecContext *avctx)
600
VqaContext *s = avctx->priv_data;
602
av_free(s->codebook);
603
av_free(s->next_codebook_buffer);
604
av_free(s->decode_buffer);
606
if (s->frame.data[0])
607
avctx->release_buffer(avctx, &s->frame);
612
AVCodec vqa_decoder = {
622
.long_name = NULL_IF_CONFIG_SMALL("Westwood Studios VQA (Vector Quantized Animation) video"),
added
removed
ffmpeg-mt/libavcodec/vqavideo.c
