55b95dceba180b61707c1f8d02f27def6c262fec
[ffmpeg.git] / libavcodec / vqavideo.c
1 /*
2  * Westwood Studios VQA Video Decoder
3  * Copyright (C) 2003 the ffmpeg project
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  * 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
74 #define PALETTE_COUNT 256
75 #define VQA_HEADER_SIZE 0x2A
76 #define CHUNK_PREAMBLE_SIZE 8
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
98     const unsigned char *buf;
99     int size;
100
101     uint32_t palette[PALETTE_COUNT];
102
103     int width;   /* width of a frame */
104     int height;   /* height of a frame */
105     int vector_width;  /* width of individual vector */
106     int vector_height;  /* height of individual vector */
107     int vqa_version;  /* this should be either 1, 2 or 3 */
108
109     unsigned char *codebook;         /* the current codebook */
110     int codebook_size;
111     unsigned char *next_codebook_buffer;  /* accumulator for next codebook */
112     int next_codebook_buffer_index;
113
114     unsigned char *decode_buffer;
115     int decode_buffer_size;
116
117     /* number of frames to go before replacing codebook */
118     int partial_countdown;
119     int partial_count;
120
121 } VqaContext;
122
123 static av_cold int vqa_decode_init(AVCodecContext *avctx)
124 {
125     VqaContext *s = avctx->priv_data;
126     unsigned char *vqa_header;
127     int i, j, codebook_index;
128
129     s->avctx = avctx;
130     avctx->pix_fmt = PIX_FMT_PAL8;
131
132     /* make sure the extradata made it */
133     if (s->avctx->extradata_size != VQA_HEADER_SIZE) {
134         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: expected extradata size of %d\n", VQA_HEADER_SIZE);
135         return -1;
136     }
137
138     /* load up the VQA parameters from the header */
139     vqa_header = (unsigned char *)s->avctx->extradata;
140     s->vqa_version = vqa_header[0];
141     s->width = AV_RL16(&vqa_header[6]);
142     s->height = AV_RL16(&vqa_header[8]);
143     if(av_image_check_size(s->width, s->height, 0, avctx)){
144         s->width= s->height= 0;
145         return -1;
146     }
147     s->vector_width = vqa_header[10];
148     s->vector_height = vqa_header[11];
149     s->partial_count = s->partial_countdown = vqa_header[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 -1;
156     }
157
158     /* allocate codebooks */
159     s->codebook_size = MAX_CODEBOOK_SIZE;
160     s->codebook = av_malloc(s->codebook_size);
161     s->next_codebook_buffer = av_malloc(s->codebook_size);
162
163     /* initialize the solid-color vectors */
164     if (s->vector_height == 4) {
165         codebook_index = 0xFF00 * 16;
166         for (i = 0; i < 256; i++)
167             for (j = 0; j < 16; j++)
168                 s->codebook[codebook_index++] = i;
169     } else {
170         codebook_index = 0xF00 * 8;
171         for (i = 0; i < 256; i++)
172             for (j = 0; j < 8; j++)
173                 s->codebook[codebook_index++] = i;
174     }
175     s->next_codebook_buffer_index = 0;
176
177     /* allocate decode buffer */
178     s->decode_buffer_size = (s->width / s->vector_width) *
179         (s->height / s->vector_height) * 2;
180     s->decode_buffer = av_malloc(s->decode_buffer_size);
181
182     s->frame.data[0] = NULL;
183
184     return 0;
185 }
186
187 #define CHECK_COUNT() \
188     if (dest_index + count > dest_size) { \
189         av_log(NULL, AV_LOG_ERROR, "  VQA video: decode_format80 problem: next op would overflow dest_index\n"); \
190         av_log(NULL, AV_LOG_ERROR, "  VQA video: current dest_index = %d, count = %d, dest_size = %d\n", \
191             dest_index, count, dest_size); \
192         return; \
193     }
194
195 static void decode_format80(const unsigned char *src, int src_size,
196     unsigned char *dest, int dest_size, int check_size) {
197
198     int src_index = 0;
199     int dest_index = 0;
200     int count;
201     int src_pos;
202     unsigned char color;
203     int i;
204
205     while (src_index < src_size) {
206
207         av_dlog(NULL, "      opcode %02X: ", src[src_index]);
208
209         /* 0x80 means that frame is finished */
210         if (src[src_index] == 0x80)
211             return;
212
213         if (dest_index >= dest_size) {
214             av_log(NULL, AV_LOG_ERROR, "  VQA video: decode_format80 problem: dest_index (%d) exceeded dest_size (%d)\n",
215                 dest_index, dest_size);
216             return;
217         }
218
219         if (src[src_index] == 0xFF) {
220
221             src_index++;
222             count = AV_RL16(&src[src_index]);
223             src_index += 2;
224             src_pos = AV_RL16(&src[src_index]);
225             src_index += 2;
226             av_dlog(NULL, "(1) copy %X bytes from absolute pos %X\n", count, src_pos);
227             CHECK_COUNT();
228             for (i = 0; i < count; i++)
229                 dest[dest_index + i] = dest[src_pos + i];
230             dest_index += count;
231
232         } else if (src[src_index] == 0xFE) {
233
234             src_index++;
235             count = AV_RL16(&src[src_index]);
236             src_index += 2;
237             color = src[src_index++];
238             av_dlog(NULL, "(2) set %X bytes to %02X\n", count, color);
239             CHECK_COUNT();
240             memset(&dest[dest_index], color, count);
241             dest_index += count;
242
243         } else if ((src[src_index] & 0xC0) == 0xC0) {
244
245             count = (src[src_index++] & 0x3F) + 3;
246             src_pos = AV_RL16(&src[src_index]);
247             src_index += 2;
248             av_dlog(NULL, "(3) copy %X bytes from absolute pos %X\n", count, src_pos);
249             CHECK_COUNT();
250             for (i = 0; i < count; i++)
251                 dest[dest_index + i] = dest[src_pos + i];
252             dest_index += count;
253
254         } else if (src[src_index] > 0x80) {
255
256             count = src[src_index++] & 0x3F;
257             av_dlog(NULL, "(4) copy %X bytes from source to dest\n", count);
258             CHECK_COUNT();
259             memcpy(&dest[dest_index], &src[src_index], count);
260             src_index += count;
261             dest_index += count;
262
263         } else {
264
265             count = ((src[src_index] & 0x70) >> 4) + 3;
266             src_pos = AV_RB16(&src[src_index]) & 0x0FFF;
267             src_index += 2;
268             av_dlog(NULL, "(5) copy %X bytes from relpos %X\n", count, src_pos);
269             CHECK_COUNT();
270             for (i = 0; i < count; i++)
271                 dest[dest_index + i] = dest[dest_index - src_pos + i];
272             dest_index += count;
273         }
274     }
275
276     /* validate that the entire destination buffer was filled; this is
277      * important for decoding frame maps since each vector needs to have a
278      * codebook entry; it is not important for compressed codebooks because
279      * not every entry needs to be filled */
280     if (check_size)
281         if (dest_index < dest_size)
282             av_log(NULL, AV_LOG_ERROR, "  VQA video: decode_format80 problem: decode finished with dest_index (%d) < dest_size (%d)\n",
283                 dest_index, dest_size);
284 }
285
286 static void vqa_decode_chunk(VqaContext *s)
287 {
288     unsigned int chunk_type;
289     unsigned int chunk_size;
290     int byte_skip;
291     unsigned int index = 0;
292     int i;
293     unsigned char r, g, b;
294     int index_shift;
295
296     int cbf0_chunk = -1;
297     int cbfz_chunk = -1;
298     int cbp0_chunk = -1;
299     int cbpz_chunk = -1;
300     int cpl0_chunk = -1;
301     int cplz_chunk = -1;
302     int vptz_chunk = -1;
303
304     int x, y;
305     int lines = 0;
306     int pixel_ptr;
307     int vector_index = 0;
308     int lobyte = 0;
309     int hibyte = 0;
310     int lobytes = 0;
311     int hibytes = s->decode_buffer_size / 2;
312
313     /* first, traverse through the frame and find the subchunks */
314     while (index < s->size) {
315
316         chunk_type = AV_RB32(&s->buf[index]);
317         chunk_size = AV_RB32(&s->buf[index + 4]);
318
319         switch (chunk_type) {
320
321         case CBF0_TAG:
322             cbf0_chunk = index;
323             break;
324
325         case CBFZ_TAG:
326             cbfz_chunk = index;
327             break;
328
329         case CBP0_TAG:
330             cbp0_chunk = index;
331             break;
332
333         case CBPZ_TAG:
334             cbpz_chunk = index;
335             break;
336
337         case CPL0_TAG:
338             cpl0_chunk = index;
339             break;
340
341         case CPLZ_TAG:
342             cplz_chunk = index;
343             break;
344
345         case VPTZ_TAG:
346             vptz_chunk = index;
347             break;
348
349         default:
350             av_log(s->avctx, AV_LOG_ERROR, "  VQA video: Found unknown chunk type: %c%c%c%c (%08X)\n",
351             (chunk_type >> 24) & 0xFF,
352             (chunk_type >> 16) & 0xFF,
353             (chunk_type >>  8) & 0xFF,
354             (chunk_type >>  0) & 0xFF,
355             chunk_type);
356             break;
357         }
358
359         byte_skip = chunk_size & 0x01;
360         index += (CHUNK_PREAMBLE_SIZE + chunk_size + byte_skip);
361     }
362
363     /* next, deal with the palette */
364     if ((cpl0_chunk != -1) && (cplz_chunk != -1)) {
365
366         /* a chunk should not have both chunk types */
367         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found both CPL0 and CPLZ chunks\n");
368         return;
369     }
370
371     /* decompress the palette chunk */
372     if (cplz_chunk != -1) {
373
374 /* yet to be handled */
375
376     }
377
378     /* convert the RGB palette into the machine's endian format */
379     if (cpl0_chunk != -1) {
380
381         chunk_size = AV_RB32(&s->buf[cpl0_chunk + 4]);
382         /* sanity check the palette size */
383         if (chunk_size / 3 > 256) {
384             av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found a palette chunk with %d colors\n",
385                 chunk_size / 3);
386             return;
387         }
388         cpl0_chunk += CHUNK_PREAMBLE_SIZE;
389         for (i = 0; i < chunk_size / 3; i++) {
390             /* scale by 4 to transform 6-bit palette -> 8-bit */
391             r = s->buf[cpl0_chunk++] * 4;
392             g = s->buf[cpl0_chunk++] * 4;
393             b = s->buf[cpl0_chunk++] * 4;
394             s->palette[i] = (r << 16) | (g << 8) | (b);
395         }
396     }
397
398     /* next, look for a full codebook */
399     if ((cbf0_chunk != -1) && (cbfz_chunk != -1)) {
400
401         /* a chunk should not have both chunk types */
402         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found both CBF0 and CBFZ chunks\n");
403         return;
404     }
405
406     /* decompress the full codebook chunk */
407     if (cbfz_chunk != -1) {
408
409         chunk_size = AV_RB32(&s->buf[cbfz_chunk + 4]);
410         cbfz_chunk += CHUNK_PREAMBLE_SIZE;
411         decode_format80(&s->buf[cbfz_chunk], chunk_size,
412             s->codebook, s->codebook_size, 0);
413     }
414
415     /* copy a full codebook */
416     if (cbf0_chunk != -1) {
417
418         chunk_size = AV_RB32(&s->buf[cbf0_chunk + 4]);
419         /* sanity check the full codebook size */
420         if (chunk_size > MAX_CODEBOOK_SIZE) {
421             av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: CBF0 chunk too large (0x%X bytes)\n",
422                 chunk_size);
423             return;
424         }
425         cbf0_chunk += CHUNK_PREAMBLE_SIZE;
426
427         memcpy(s->codebook, &s->buf[cbf0_chunk], chunk_size);
428     }
429
430     /* decode the frame */
431     if (vptz_chunk == -1) {
432
433         /* something is wrong if there is no VPTZ chunk */
434         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: no VPTZ chunk found\n");
435         return;
436     }
437
438     chunk_size = AV_RB32(&s->buf[vptz_chunk + 4]);
439     vptz_chunk += CHUNK_PREAMBLE_SIZE;
440     decode_format80(&s->buf[vptz_chunk], chunk_size,
441         s->decode_buffer, s->decode_buffer_size, 1);
442
443     /* render the final PAL8 frame */
444     if (s->vector_height == 4)
445         index_shift = 4;
446     else
447         index_shift = 3;
448     for (y = 0; y < s->frame.linesize[0] * s->height;
449         y += s->frame.linesize[0] * s->vector_height) {
450
451         for (x = y; x < y + s->width; x += 4, lobytes++, hibytes++) {
452             pixel_ptr = x;
453
454             /* get the vector index, the method for which varies according to
455              * VQA file version */
456             switch (s->vqa_version) {
457
458             case 1:
459                 lobyte = s->decode_buffer[lobytes * 2];
460                 hibyte = s->decode_buffer[(lobytes * 2) + 1];
461                 vector_index = ((hibyte << 8) | lobyte) >> 3;
462                 vector_index <<= index_shift;
463                 lines = s->vector_height;
464                 /* uniform color fill - a quick hack */
465                 if (hibyte == 0xFF) {
466                     while (lines--) {
467                         s->frame.data[0][pixel_ptr + 0] = 255 - lobyte;
468                         s->frame.data[0][pixel_ptr + 1] = 255 - lobyte;
469                         s->frame.data[0][pixel_ptr + 2] = 255 - lobyte;
470                         s->frame.data[0][pixel_ptr + 3] = 255 - lobyte;
471                         pixel_ptr += s->frame.linesize[0];
472                     }
473                     lines=0;
474                 }
475                 break;
476
477             case 2:
478                 lobyte = s->decode_buffer[lobytes];
479                 hibyte = s->decode_buffer[hibytes];
480                 vector_index = (hibyte << 8) | lobyte;
481                 vector_index <<= index_shift;
482                 lines = s->vector_height;
483                 break;
484
485             case 3:
486 /* not implemented yet */
487                 lines = 0;
488                 break;
489             }
490
491             while (lines--) {
492                 s->frame.data[0][pixel_ptr + 0] = s->codebook[vector_index++];
493                 s->frame.data[0][pixel_ptr + 1] = s->codebook[vector_index++];
494                 s->frame.data[0][pixel_ptr + 2] = s->codebook[vector_index++];
495                 s->frame.data[0][pixel_ptr + 3] = s->codebook[vector_index++];
496                 pixel_ptr += s->frame.linesize[0];
497             }
498         }
499     }
500
501     /* handle partial codebook */
502     if ((cbp0_chunk != -1) && (cbpz_chunk != -1)) {
503         /* a chunk should not have both chunk types */
504         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found both CBP0 and CBPZ chunks\n");
505         return;
506     }
507
508     if (cbp0_chunk != -1) {
509
510         chunk_size = AV_RB32(&s->buf[cbp0_chunk + 4]);
511         cbp0_chunk += CHUNK_PREAMBLE_SIZE;
512
513         /* accumulate partial codebook */
514         memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
515             &s->buf[cbp0_chunk], chunk_size);
516         s->next_codebook_buffer_index += chunk_size;
517
518         s->partial_countdown--;
519         if (s->partial_countdown == 0) {
520
521             /* time to replace codebook */
522             memcpy(s->codebook, s->next_codebook_buffer,
523                 s->next_codebook_buffer_index);
524
525             /* reset accounting */
526             s->next_codebook_buffer_index = 0;
527             s->partial_countdown = s->partial_count;
528         }
529     }
530
531     if (cbpz_chunk != -1) {
532
533         chunk_size = AV_RB32(&s->buf[cbpz_chunk + 4]);
534         cbpz_chunk += CHUNK_PREAMBLE_SIZE;
535
536         /* accumulate partial codebook */
537         memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
538             &s->buf[cbpz_chunk], chunk_size);
539         s->next_codebook_buffer_index += chunk_size;
540
541         s->partial_countdown--;
542         if (s->partial_countdown == 0) {
543
544             /* decompress codebook */
545             decode_format80(s->next_codebook_buffer,
546                 s->next_codebook_buffer_index,
547                 s->codebook, s->codebook_size, 0);
548
549             /* reset accounting */
550             s->next_codebook_buffer_index = 0;
551             s->partial_countdown = s->partial_count;
552         }
553     }
554 }
555
556 static int vqa_decode_frame(AVCodecContext *avctx,
557                             void *data, int *data_size,
558                             AVPacket *avpkt)
559 {
560     const uint8_t *buf = avpkt->data;
561     int buf_size = avpkt->size;
562     VqaContext *s = avctx->priv_data;
563
564     s->buf = buf;
565     s->size = buf_size;
566
567     if (s->frame.data[0])
568         avctx->release_buffer(avctx, &s->frame);
569
570     if (avctx->get_buffer(avctx, &s->frame)) {
571         av_log(s->avctx, AV_LOG_ERROR, "  VQA Video: get_buffer() failed\n");
572         return -1;
573     }
574
575     vqa_decode_chunk(s);
576
577     /* make the palette available on the way out */
578     memcpy(s->frame.data[1], s->palette, PALETTE_COUNT * 4);
579     s->frame.palette_has_changed = 1;
580
581     *data_size = sizeof(AVFrame);
582     *(AVFrame*)data = s->frame;
583
584     /* report that the buffer was completely consumed */
585     return buf_size;
586 }
587
588 static av_cold int vqa_decode_end(AVCodecContext *avctx)
589 {
590     VqaContext *s = avctx->priv_data;
591
592     av_free(s->codebook);
593     av_free(s->next_codebook_buffer);
594     av_free(s->decode_buffer);
595
596     if (s->frame.data[0])
597         avctx->release_buffer(avctx, &s->frame);
598
599     return 0;
600 }
601
602 AVCodec ff_vqa_decoder = {
603     "vqavideo",
604     AVMEDIA_TYPE_VIDEO,
605     CODEC_ID_WS_VQA,
606     sizeof(VqaContext),
607     vqa_decode_init,
608     NULL,
609     vqa_decode_end,
610     vqa_decode_frame,
611     CODEC_CAP_DR1,
612     .long_name = NULL_IF_CONFIG_SMALL("Westwood Studios VQA (Vector Quantized Animation) video"),
613 };