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