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