FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavcodec/vqavideo.c
Date: 2021-09-23 20:34:37
Exec Total Coverage
Lines: 192 279 68.8%
Branches: 92 159 57.9%
Line Branch Exec Source
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 #include "bytestream.h"
74 #include "internal.h"
75
76 #define PALETTE_COUNT 256
77 #define VQA_HEADER_SIZE 0x2A
78
79 /* allocate the maximum vector space, regardless of the file version:
80 * (0xFF00 codebook vectors + 0x100 solid pixel vectors) * (4x4 pixels/block) */
81 #define MAX_CODEBOOK_VECTORS 0xFF00
82 #define SOLID_PIXEL_VECTORS 0x100
83 #define MAX_VECTORS (MAX_CODEBOOK_VECTORS + SOLID_PIXEL_VECTORS)
84 #define MAX_CODEBOOK_SIZE (MAX_VECTORS * 4 * 4)
85
86 #define CBF0_TAG MKBETAG('C', 'B', 'F', '0')
87 #define CBFZ_TAG MKBETAG('C', 'B', 'F', 'Z')
88 #define CBP0_TAG MKBETAG('C', 'B', 'P', '0')
89 #define CBPZ_TAG MKBETAG('C', 'B', 'P', 'Z')
90 #define CPL0_TAG MKBETAG('C', 'P', 'L', '0')
91 #define CPLZ_TAG MKBETAG('C', 'P', 'L', 'Z')
92 #define VPTZ_TAG MKBETAG('V', 'P', 'T', 'Z')
93
94 typedef struct VqaContext {
95
96 AVCodecContext *avctx;
97 GetByteContext gb;
98
99 uint32_t palette[PALETTE_COUNT];
100
101 int width; /* width of a frame */
102 int height; /* height of a frame */
103 int vector_width; /* width of individual vector */
104 int vector_height; /* height of individual vector */
105 int vqa_version; /* this should be either 1, 2 or 3 */
106
107 unsigned char *codebook; /* the current codebook */
108 int codebook_size;
109 unsigned char *next_codebook_buffer; /* accumulator for next codebook */
110 int next_codebook_buffer_index;
111
112 unsigned char *decode_buffer;
113 int decode_buffer_size;
114
115 /* number of frames to go before replacing codebook */
116 int partial_countdown;
117 int partial_count;
118
119 } VqaContext;
120
121 6 static av_cold int vqa_decode_init(AVCodecContext *avctx)
122 {
123 6 VqaContext *s = avctx->priv_data;
124 int i, j, codebook_index, ret;
125
126 6 s->avctx = avctx;
127 6 avctx->pix_fmt = AV_PIX_FMT_PAL8;
128
129 /* make sure the extradata made it */
130
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
 6 if (s->avctx->extradata_size != VQA_HEADER_SIZE) {
131 ✗ av_log(s->avctx, AV_LOG_ERROR, "expected extradata size of %d\n", VQA_HEADER_SIZE);
132 ✗ return AVERROR(EINVAL);
133 }
134
135 /* load up the VQA parameters from the header */
136 6 s->vqa_version = s->avctx->extradata[0];
137
2/3
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
 6 switch (s->vqa_version) {
138 4 case 1:
139 case 2:
140 4 break;
141 2 case 3:
142 2 avpriv_report_missing_feature(avctx, "VQA Version %d", s->vqa_version);
143 2 return AVERROR_PATCHWELCOME;
144 ✗ default:
145 ✗ avpriv_request_sample(avctx, "VQA Version %i", s->vqa_version);
146 ✗ return AVERROR_PATCHWELCOME;
147 }
148 4 s->width = AV_RL16(&s->avctx->extradata[6]);
149 4 s->height = AV_RL16(&s->avctx->extradata[8]);
150
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
 4 if ((ret = ff_set_dimensions(avctx, s->width, s->height)) < 0) {
151 ✗ s->width= s->height= 0;
152 ✗ return ret;
153 }
154 4 s->vector_width = s->avctx->extradata[10];
155 4 s->vector_height = s->avctx->extradata[11];
156 4 s->partial_count = s->partial_countdown = s->avctx->extradata[13];
157
158 /* the vector dimensions have to meet very stringent requirements */
159
1/2
✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
 4 if ((s->vector_width != 4) ||
160
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 4 ((s->vector_height != 2) && (s->vector_height != 4))) {
161 /* return without further initialization */
162 ✗ return AVERROR_INVALIDDATA;
163 }
164
165
2/4
✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 4 times.
 4 if (s->width % s->vector_width || s->height % s->vector_height) {
166 ✗ av_log(avctx, AV_LOG_ERROR, "Image size not multiple of block size\n");
167 ✗ return AVERROR_INVALIDDATA;
168 }
169
170 /* allocate codebooks */
171 4 s->codebook_size = MAX_CODEBOOK_SIZE;
172 4 s->codebook = av_malloc(s->codebook_size);
173
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (!s->codebook)
174 ✗ return AVERROR(ENOMEM);
175 4 s->next_codebook_buffer = av_malloc(s->codebook_size);
176
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (!s->next_codebook_buffer)
177 ✗ return AVERROR(ENOMEM);
178
179 /* allocate decode buffer */
180 4 s->decode_buffer_size = (s->width / s->vector_width) *
181 4 (s->height / s->vector_height) * 2;
182 4 s->decode_buffer = av_mallocz(s->decode_buffer_size);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (!s->decode_buffer)
184 ✗ return AVERROR(ENOMEM);
185
186 /* initialize the solid-color vectors */
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (s->vector_height == 4) {
188 ✗ codebook_index = 0xFF00 * 16;
189 ✗ for (i = 0; i < 256; i++)
190 ✗ for (j = 0; j < 16; j++)
191 ✗ s->codebook[codebook_index++] = i;
192 } else {
193 4 codebook_index = 0xF00 * 8;
194
2/2
✓ Branch 0 taken 1024 times.
✓ Branch 1 taken 4 times.
 1028 for (i = 0; i < 256; i++)
195
2/2
✓ Branch 0 taken 8192 times.
✓ Branch 1 taken 1024 times.
 9216 for (j = 0; j < 8; j++)
196 8192 s->codebook[codebook_index++] = i;
197 }
198 4 s->next_codebook_buffer_index = 0;
199
200 4 return 0;
201 }
202
203 #define CHECK_COUNT() \
204 if (dest_index + count > dest_size) { \
205 av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: next op would overflow dest_index\n"); \
206 av_log(s->avctx, AV_LOG_ERROR, "current dest_index = %d, count = %d, dest_size = %d\n", \
207 dest_index, count, dest_size); \
208 return AVERROR_INVALIDDATA; \
209 }
210
211 #define CHECK_COPY(idx) \
212 if (idx < 0 || idx + count > dest_size) { \
213 av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: next op would overflow dest_index\n"); \
214 av_log(s->avctx, AV_LOG_ERROR, "current src_pos = %d, count = %d, dest_size = %d\n", \
215 src_pos, count, dest_size); \
216 return AVERROR_INVALIDDATA; \
217 }
218
219
220 38 static int decode_format80(VqaContext *s, int src_size,
221 unsigned char *dest, int dest_size, int check_size) {
222
223 38 int dest_index = 0;
224 int count, opcode, start;
225 int src_pos;
226 unsigned char color;
227 int i;
228
229
2/4
✓ Branch 0 taken 38 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 38 times.
 38 if (src_size < 0 || src_size > bytestream2_get_bytes_left(&s->gb)) {
230 ✗ av_log(s->avctx, AV_LOG_ERROR, "Chunk size %d is out of range\n",
231 src_size);
232 ✗ return AVERROR_INVALIDDATA;
233 }
234
235 38 start = bytestream2_tell(&s->gb);
236
1/2
✓ Branch 1 taken 44627 times.
✗ Branch 2 not taken.
 44627 while (bytestream2_tell(&s->gb) - start < src_size) {
237 44627 opcode = bytestream2_get_byte(&s->gb);
238 ff_tlog(s->avctx, "opcode %02X: ", opcode);
239
240 /* 0x80 means that frame is finished */
241
2/2
✓ Branch 0 taken 38 times.
✓ Branch 1 taken 44589 times.
 44627 if (opcode == 0x80)
242 38 break;
243
244
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 44589 times.
 44589 if (dest_index >= dest_size) {
245 ✗ av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: dest_index (%d) exceeded dest_size (%d)\n",
246 dest_index, dest_size);
247 ✗ return AVERROR_INVALIDDATA;
248 }
249
250
2/2
✓ Branch 0 taken 265 times.
✓ Branch 1 taken 44324 times.
 44589 if (opcode == 0xFF) {
251
252 265 count = bytestream2_get_le16(&s->gb);
253 265 src_pos = bytestream2_get_le16(&s->gb);
254 ff_tlog(s->avctx, "(1) copy %X bytes from absolute pos %X\n", count, src_pos);
255
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 265 times.
 265 CHECK_COUNT();
256
2/4
✓ Branch 0 taken 265 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 265 times.
 265 CHECK_COPY(src_pos);
257
2/2
✓ Branch 0 taken 24165 times.
✓ Branch 1 taken 265 times.
 24430 for (i = 0; i < count; i++)
258 24165 dest[dest_index + i] = dest[src_pos + i];
259 265 dest_index += count;
260
261
2/2
✓ Branch 0 taken 440 times.
✓ Branch 1 taken 43884 times.
 44324 } else if (opcode == 0xFE) {
262
263 440 count = bytestream2_get_le16(&s->gb);
264 440 color = bytestream2_get_byte(&s->gb);
265 ff_tlog(s->avctx, "(2) set %X bytes to %02X\n", count, color);
266
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 440 times.
 440 CHECK_COUNT();
267 440 memset(&dest[dest_index], color, count);
268 440 dest_index += count;
269
270
2/2
✓ Branch 0 taken 8741 times.
✓ Branch 1 taken 35143 times.
 43884 } else if ((opcode & 0xC0) == 0xC0) {
271
272 8741 count = (opcode & 0x3F) + 3;
273 8741 src_pos = bytestream2_get_le16(&s->gb);
274 ff_tlog(s->avctx, "(3) copy %X bytes from absolute pos %X\n", count, src_pos);
275
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8741 times.
 8741 CHECK_COUNT();
276
2/4
✓ Branch 0 taken 8741 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 8741 times.
 8741 CHECK_COPY(src_pos);
277
2/2
✓ Branch 0 taken 181662 times.
✓ Branch 1 taken 8741 times.
 190403 for (i = 0; i < count; i++)
278 181662 dest[dest_index + i] = dest[src_pos + i];
279 8741 dest_index += count;
280
281
2/2
✓ Branch 0 taken 12393 times.
✓ Branch 1 taken 22750 times.
 35143 } else if (opcode > 0x80) {
282
283 12393 count = opcode & 0x3F;
284 ff_tlog(s->avctx, "(4) copy %X bytes from source to dest\n", count);
285
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 12393 times.
 12393 CHECK_COUNT();
286 12393 bytestream2_get_buffer(&s->gb, &dest[dest_index], count);
287 12393 dest_index += count;
288
289 } else {
290
291 22750 count = ((opcode & 0x70) >> 4) + 3;
292 22750 src_pos = bytestream2_get_byte(&s->gb) | ((opcode & 0x0F) << 8);
293 ff_tlog(s->avctx, "(5) copy %X bytes from relpos %X\n", count, src_pos);
294
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 22750 times.
 22750 CHECK_COUNT();
295
2/4
✓ Branch 0 taken 22750 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 22750 times.
 22750 CHECK_COPY(dest_index - src_pos);
296
2/2
✓ Branch 0 taken 113822 times.
✓ Branch 1 taken 22750 times.
 136572 for (i = 0; i < count; i++)
297 113822 dest[dest_index + i] = dest[dest_index - src_pos + i];
298 22750 dest_index += count;
299 }
300 }
301
302 /* validate that the entire destination buffer was filled; this is
303 * important for decoding frame maps since each vector needs to have a
304 * codebook entry; it is not important for compressed codebooks because
305 * not every entry needs to be filled */
306
1/2
✓ Branch 0 taken 38 times.
✗ Branch 1 not taken.
 38 if (check_size)
307
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 38 times.
 38 if (dest_index < dest_size) {
308 ✗ av_log(s->avctx, AV_LOG_ERROR, "decode_format80 problem: decode finished with dest_index (%d) < dest_size (%d)\n",
309 dest_index, dest_size);
310 ✗ memset(dest + dest_index, 0, dest_size - dest_index);
311 }
312
313 38 return 0; // let's display what we decoded anyway
314 }
315
316 39 static int vqa_decode_chunk(VqaContext *s, AVFrame *frame)
317 {
318 unsigned int chunk_type;
319 unsigned int chunk_size;
320 int byte_skip;
321 39 unsigned int index = 0;
322 int i;
323 unsigned char r, g, b;
324 int index_shift;
325 int res;
326
327 39 int cbf0_chunk = -1;
328 39 int cbfz_chunk = -1;
329 39 int cbp0_chunk = -1;
330 39 int cbpz_chunk = -1;
331 39 int cpl0_chunk = -1;
332 39 int cplz_chunk = -1;
333 39 int vptz_chunk = -1;
334
335 int x, y;
336 39 int lines = 0;
337 int pixel_ptr;
338 39 int vector_index = 0;
339 39 int lobyte = 0;
340 39 int hibyte = 0;
341 39 int lobytes = 0;
342 39 int hibytes = s->decode_buffer_size / 2;
343
344 /* first, traverse through the frame and find the subchunks */
345
2/2
✓ Branch 1 taken 79 times.
✓ Branch 2 taken 39 times.
 118 while (bytestream2_get_bytes_left(&s->gb) >= 8) {
346
347 79 chunk_type = bytestream2_get_be32u(&s->gb);
348 79 index = bytestream2_tell(&s->gb);
349 79 chunk_size = bytestream2_get_be32u(&s->gb);
350
351
4/8
✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 39 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 38 times.
✗ Branch 7 not taken.
 79 switch (chunk_type) {
352
353 1 case CBF0_TAG:
354 1 cbf0_chunk = index;
355 1 break;
356
357 ✗ case CBFZ_TAG:
358 ✗ cbfz_chunk = index;
359 ✗ break;
360
361 39 case CBP0_TAG:
362 39 cbp0_chunk = index;
363 39 break;
364
365 ✗ case CBPZ_TAG:
366 ✗ cbpz_chunk = index;
367 ✗ break;
368
369 1 case CPL0_TAG:
370 1 cpl0_chunk = index;
371 1 break;
372
373 ✗ case CPLZ_TAG:
374 ✗ cplz_chunk = index;
375 ✗ break;
376
377 38 case VPTZ_TAG:
378 38 vptz_chunk = index;
379 38 break;
380
381 ✗ default:
382 ✗ av_log(s->avctx, AV_LOG_ERROR, "Found unknown chunk type: %s (%08X)\n",
383 ✗ av_fourcc2str(av_bswap32(chunk_type)), chunk_type);
384 ✗ break;
385 }
386
387 79 byte_skip = chunk_size & 0x01;
388 79 bytestream2_skip(&s->gb, chunk_size + byte_skip);
389 }
390
391 /* next, deal with the palette */
392
3/4
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 38 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 1 times.
 39 if ((cpl0_chunk != -1) && (cplz_chunk != -1)) {
393
394 /* a chunk should not have both chunk types */
395 ✗ av_log(s->avctx, AV_LOG_ERROR, "problem: found both CPL0 and CPLZ chunks\n");
396 ✗ return AVERROR_INVALIDDATA;
397 }
398
399 /* decompress the palette chunk */
400 if (cplz_chunk != -1) {
401
402 /* yet to be handled */
403
404 }
405
406 /* convert the RGB palette into the machine's endian format */
407
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 38 times.
 39 if (cpl0_chunk != -1) {
408
409 1 bytestream2_seek(&s->gb, cpl0_chunk, SEEK_SET);
410 1 chunk_size = bytestream2_get_be32(&s->gb);
411 /* sanity check the palette size */
412
2/4
✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 1 times.
 1 if (chunk_size / 3 > 256 || chunk_size > bytestream2_get_bytes_left(&s->gb)) {
413 ✗ av_log(s->avctx, AV_LOG_ERROR, "problem: found a palette chunk with %d colors\n",
414 chunk_size / 3);
415 ✗ return AVERROR_INVALIDDATA;
416 }
417
2/2
✓ Branch 0 taken 251 times.
✓ Branch 1 taken 1 times.
 252 for (i = 0; i < chunk_size / 3; i++) {
418 /* scale by 4 to transform 6-bit palette -> 8-bit */
419 251 r = bytestream2_get_byteu(&s->gb) * 4;
420 251 g = bytestream2_get_byteu(&s->gb) * 4;
421 251 b = bytestream2_get_byteu(&s->gb) * 4;
422 251 s->palette[i] = 0xFFU << 24 | r << 16 | g << 8 | b;
423 251 s->palette[i] |= s->palette[i] >> 6 & 0x30303;
424 }
425 }
426
427 /* next, look for a full codebook */
428
3/4
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 38 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 1 times.
 39 if ((cbf0_chunk != -1) && (cbfz_chunk != -1)) {
429
430 /* a chunk should not have both chunk types */
431 ✗ av_log(s->avctx, AV_LOG_ERROR, "problem: found both CBF0 and CBFZ chunks\n");
432 ✗ return AVERROR_INVALIDDATA;
433 }
434
435 /* decompress the full codebook chunk */
436
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 39 times.
 39 if (cbfz_chunk != -1) {
437
438 ✗ bytestream2_seek(&s->gb, cbfz_chunk, SEEK_SET);
439 ✗ chunk_size = bytestream2_get_be32(&s->gb);
440 ✗ if ((res = decode_format80(s, chunk_size, s->codebook,
441 s->codebook_size, 0)) < 0)
442 ✗ return res;
443 }
444
445 /* copy a full codebook */
446
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 38 times.
 39 if (cbf0_chunk != -1) {
447
448 1 bytestream2_seek(&s->gb, cbf0_chunk, SEEK_SET);
449 1 chunk_size = bytestream2_get_be32(&s->gb);
450 /* sanity check the full codebook size */
451
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1 times.
 1 if (chunk_size > MAX_CODEBOOK_SIZE) {
452 ✗ av_log(s->avctx, AV_LOG_ERROR, "problem: CBF0 chunk too large (0x%X bytes)\n",
453 chunk_size);
454 ✗ return AVERROR_INVALIDDATA;
455 }
456
457 1 bytestream2_get_buffer(&s->gb, s->codebook, chunk_size);
458 }
459
460 /* decode the frame */
461
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 38 times.
 39 if (vptz_chunk == -1) {
462
463 /* something is wrong if there is no VPTZ chunk */
464 1 av_log(s->avctx, AV_LOG_ERROR, "problem: no VPTZ chunk found\n");
465 1 return AVERROR_INVALIDDATA;
466 }
467
468 38 bytestream2_seek(&s->gb, vptz_chunk, SEEK_SET);
469 38 chunk_size = bytestream2_get_be32(&s->gb);
470
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 38 times.
 38 if ((res = decode_format80(s, chunk_size,
471 s->decode_buffer, s->decode_buffer_size, 1)) < 0)
472 ✗ return res;
473
474 /* render the final PAL8 frame */
475
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 38 times.
 38 if (s->vector_height == 4)
476 ✗ index_shift = 4;
477 else
478 38 index_shift = 3;
479
2/2
✓ Branch 0 taken 3800 times.
✓ Branch 1 taken 38 times.
 3838 for (y = 0; y < s->height; y += s->vector_height) {
480
2/2
✓ Branch 0 taken 304000 times.
✓ Branch 1 taken 3800 times.
 307800 for (x = 0; x < s->width; x += 4, lobytes++, hibytes++) {
481 304000 pixel_ptr = y * frame->linesize[0] + x;
482
483 /* get the vector index, the method for which varies according to
484 * VQA file version */
485
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 304000 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 304000 switch (s->vqa_version) {
486
487 ✗ case 1:
488 ✗ lobyte = s->decode_buffer[lobytes * 2];
489 ✗ hibyte = s->decode_buffer[(lobytes * 2) + 1];
490 ✗ vector_index = ((hibyte << 8) | lobyte) >> 3;
491 ✗ vector_index <<= index_shift;
492 ✗ lines = s->vector_height;
493 /* uniform color fill - a quick hack */
494 ✗ if (hibyte == 0xFF) {
495 ✗ while (lines--) {
496 ✗ frame->data[0][pixel_ptr + 0] = 255 - lobyte;
497 ✗ frame->data[0][pixel_ptr + 1] = 255 - lobyte;
498 ✗ frame->data[0][pixel_ptr + 2] = 255 - lobyte;
499 ✗ frame->data[0][pixel_ptr + 3] = 255 - lobyte;
500 ✗ pixel_ptr += frame->linesize[0];
501 }
502 ✗ lines=0;
503 }
504 ✗ break;
505
506 304000 case 2:
507 304000 lobyte = s->decode_buffer[lobytes];
508 304000 hibyte = s->decode_buffer[hibytes];
509 304000 vector_index = (hibyte << 8) | lobyte;
510 304000 vector_index <<= index_shift;
511 304000 lines = s->vector_height;
512 304000 break;
513
514 ✗ case 3:
515 /* not implemented yet */
516 ✗ lines = 0;
517 ✗ break;
518 }
519
520
2/2
✓ Branch 0 taken 608000 times.
✓ Branch 1 taken 304000 times.
 912000 while (lines--) {
521 608000 frame->data[0][pixel_ptr + 0] = s->codebook[vector_index++];
522 608000 frame->data[0][pixel_ptr + 1] = s->codebook[vector_index++];
523 608000 frame->data[0][pixel_ptr + 2] = s->codebook[vector_index++];
524 608000 frame->data[0][pixel_ptr + 3] = s->codebook[vector_index++];
525 608000 pixel_ptr += frame->linesize[0];
526 }
527 }
528 }
529
530 /* handle partial codebook */
531
2/4
✓ Branch 0 taken 38 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 38 times.
 38 if ((cbp0_chunk != -1) && (cbpz_chunk != -1)) {
532 /* a chunk should not have both chunk types */
533 ✗ av_log(s->avctx, AV_LOG_ERROR, "problem: found both CBP0 and CBPZ chunks\n");
534 ✗ return AVERROR_INVALIDDATA;
535 }
536
537
1/2
✓ Branch 0 taken 38 times.
✗ Branch 1 not taken.
 38 if (cbp0_chunk != -1) {
538
539 38 bytestream2_seek(&s->gb, cbp0_chunk, SEEK_SET);
540 38 chunk_size = bytestream2_get_be32(&s->gb);
541
542
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 38 times.
 38 if (chunk_size > MAX_CODEBOOK_SIZE - s->next_codebook_buffer_index) {
543 ✗ av_log(s->avctx, AV_LOG_ERROR, "cbp0 chunk too large (%u bytes)\n",
544 chunk_size);
545 ✗ return AVERROR_INVALIDDATA;
546 }
547
548 /* accumulate partial codebook */
549 38 bytestream2_get_buffer(&s->gb, &s->next_codebook_buffer[s->next_codebook_buffer_index],
550 chunk_size);
551 38 s->next_codebook_buffer_index += chunk_size;
552
553 38 s->partial_countdown--;
554
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 34 times.
 38 if (s->partial_countdown <= 0) {
555
556 /* time to replace codebook */
557 4 memcpy(s->codebook, s->next_codebook_buffer,
558 4 s->next_codebook_buffer_index);
559
560 /* reset accounting */
561 4 s->next_codebook_buffer_index = 0;
562 4 s->partial_countdown = s->partial_count;
563 }
564 }
565
566
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 38 times.
 38 if (cbpz_chunk != -1) {
567
568 ✗ bytestream2_seek(&s->gb, cbpz_chunk, SEEK_SET);
569 ✗ chunk_size = bytestream2_get_be32(&s->gb);
570
571 ✗ if (chunk_size > MAX_CODEBOOK_SIZE - s->next_codebook_buffer_index) {
572 ✗ av_log(s->avctx, AV_LOG_ERROR, "cbpz chunk too large (%u bytes)\n",
573 chunk_size);
574 ✗ return AVERROR_INVALIDDATA;
575 }
576
577 /* accumulate partial codebook */
578 ✗ bytestream2_get_buffer(&s->gb, &s->next_codebook_buffer[s->next_codebook_buffer_index],
579 chunk_size);
580 ✗ s->next_codebook_buffer_index += chunk_size;
581
582 ✗ s->partial_countdown--;
583 ✗ if (s->partial_countdown <= 0) {
584 ✗ bytestream2_init(&s->gb, s->next_codebook_buffer, s->next_codebook_buffer_index);
585 /* decompress codebook */
586 ✗ if ((res = decode_format80(s, s->next_codebook_buffer_index,
587 s->codebook, s->codebook_size, 0)) < 0)
588 ✗ return res;
589
590 /* reset accounting */
591 ✗ s->next_codebook_buffer_index = 0;
592 ✗ s->partial_countdown = s->partial_count;
593 }
594 }
595
596 38 return 0;
597 }
598
599 39 static int vqa_decode_frame(AVCodecContext *avctx,
600 void *data, int *got_frame,
601 AVPacket *avpkt)
602 {
603 39 VqaContext *s = avctx->priv_data;
604 39 AVFrame *frame = data;
605 int res;
606
607
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 39 times.
 39 if ((res = ff_get_buffer(avctx, frame, 0)) < 0)
608 ✗ return res;
609
610 39 bytestream2_init(&s->gb, avpkt->data, avpkt->size);
611
2/2
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 38 times.
 39 if ((res = vqa_decode_chunk(s, frame)) < 0)
612 1 return res;
613
614 /* make the palette available on the way out */
615 38 memcpy(frame->data[1], s->palette, PALETTE_COUNT * 4);
616 38 frame->palette_has_changed = 1;
617
618 38 *got_frame = 1;
619
620 /* report that the buffer was completely consumed */
621 38 return avpkt->size;
622 }
623
624 6 static av_cold int vqa_decode_end(AVCodecContext *avctx)
625 {
626 6 VqaContext *s = avctx->priv_data;
627
628 6 av_freep(&s->codebook);
629 6 av_freep(&s->next_codebook_buffer);
630 6 av_freep(&s->decode_buffer);
631
632 6 return 0;
633 }
634
635 static const AVCodecDefault vqa_defaults[] = {
636 { "max_pixels", "320*240" },
637 { NULL },
638 };
639
640 const AVCodec ff_vqa_decoder = {
641 .name = "vqavideo",
642 .long_name = NULL_IF_CONFIG_SMALL("Westwood Studios VQA (Vector Quantized Animation) video"),
643 .type = AVMEDIA_TYPE_VIDEO,
644 .id = AV_CODEC_ID_WS_VQA,
645 .priv_data_size = sizeof(VqaContext),
646 .init = vqa_decode_init,
647 .close = vqa_decode_end,
648 .decode = vqa_decode_frame,
649 .capabilities = AV_CODEC_CAP_DR1,
650 .defaults = vqa_defaults,
651 .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE | FF_CODEC_CAP_INIT_CLEANUP,
652 };
653