FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavcodec/vmdvideo.c
Date: 2024-04-12 08:31:17
Exec Total Coverage
Lines: 147 242 60.7%
Functions: 5 6 83.3%
Branches: 87 172 50.6%

Line Branch Exec Source
1 /*
2 * Sierra VMD video decoder
3 * Copyright (c) 2004 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 * Sierra VMD video decoder
25 * by Vladimir "VAG" Gneushev (vagsoft at mail.ru)
26 * for more information on the Sierra VMD format, visit:
27 * http://www.pcisys.net/~melanson/codecs/
28 *
29 * The video decoder outputs PAL8 colorspace data. The decoder expects
30 * a 0x330-byte VMD file header to be transmitted via extradata during
31 * codec initialization. Each encoded frame that is sent to this decoder
32 * is expected to be prepended with the appropriate 16-byte frame
33 * information record from the VMD file.
34 */
35
36 #include <string.h>
37
38 #include "libavutil/common.h"
39 #include "libavutil/intreadwrite.h"
40 #include "libavutil/mem.h"
41
42 #include "avcodec.h"
43 #include "codec_internal.h"
44 #include "decode.h"
45 #include "bytestream.h"
46
47 #define VMD_HEADER_SIZE 0x330
48 #define PALETTE_COUNT 256
49
50 typedef struct VmdVideoContext {
51
52 AVCodecContext *avctx;
53 AVFrame *prev_frame;
54
55 const unsigned char *buf;
56 int size;
57
58 unsigned char palette[PALETTE_COUNT * 4];
59 unsigned char *unpack_buffer;
60 int unpack_buffer_size;
61
62 int x_off, y_off;
63 } VmdVideoContext;
64
65 #define QUEUE_SIZE 0x1000
66 #define QUEUE_MASK 0x0FFF
67
68 137 static int lz_unpack(const unsigned char *src, int src_len,
69 unsigned char *dest, int dest_len)
70 {
71 unsigned char *d;
72 unsigned char *d_end;
73 unsigned char queue[QUEUE_SIZE];
74 unsigned int qpos;
75 unsigned int dataleft;
76 unsigned int chainofs;
77 unsigned int chainlen;
78 unsigned int speclen;
79 unsigned char tag;
80 unsigned int i, j;
81 GetByteContext gb;
82
83 137 bytestream2_init(&gb, src, src_len);
84 137 d = dest;
85 137 d_end = d + dest_len;
86 137 dataleft = bytestream2_get_le32(&gb);
87 137 memset(queue, 0x20, QUEUE_SIZE);
88
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 137 times.
137 if (bytestream2_get_bytes_left(&gb) < 4)
89 return AVERROR_INVALIDDATA;
90
2/2
✓ Branch 1 taken 93 times.
✓ Branch 2 taken 44 times.
137 if (bytestream2_peek_le32(&gb) == 0x56781234) {
91 93 bytestream2_skipu(&gb, 4);
92 93 qpos = 0x111;
93 93 speclen = 0xF + 3;
94 } else {
95 44 qpos = 0xFEE;
96 44 speclen = 100; /* no speclen */
97 }
98
99
3/4
✓ Branch 0 taken 20943 times.
✓ Branch 1 taken 137 times.
✓ Branch 3 taken 20943 times.
✗ Branch 4 not taken.
21080 while (dataleft > 0 && bytestream2_get_bytes_left(&gb) > 0) {
100 20943 tag = bytestream2_get_byteu(&gb);
101
4/4
✓ Branch 0 taken 1951 times.
✓ Branch 1 taken 18992 times.
✓ Branch 2 taken 1947 times.
✓ Branch 3 taken 4 times.
20943 if ((tag == 0xFF) && (dataleft > 8)) {
102
2/4
✓ Branch 0 taken 1947 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 1947 times.
1947 if (d_end - d < 8 || bytestream2_get_bytes_left(&gb) < 8)
103 return AVERROR_INVALIDDATA;
104
2/2
✓ Branch 0 taken 15576 times.
✓ Branch 1 taken 1947 times.
17523 for (i = 0; i < 8; i++) {
105 15576 queue[qpos++] = *d++ = bytestream2_get_byteu(&gb);
106 15576 qpos &= QUEUE_MASK;
107 }
108 1947 dataleft -= 8;
109 } else {
110
2/2
✓ Branch 0 taken 151568 times.
✓ Branch 1 taken 18878 times.
170446 for (i = 0; i < 8; i++) {
111
2/2
✓ Branch 0 taken 118 times.
✓ Branch 1 taken 151450 times.
151568 if (dataleft == 0)
112 118 break;
113
2/2
✓ Branch 0 taken 89509 times.
✓ Branch 1 taken 61941 times.
151450 if (tag & 0x01) {
114
2/4
✓ Branch 0 taken 89509 times.
✗ Branch 1 not taken.
✗ Branch 3 not taken.
✓ Branch 4 taken 89509 times.
89509 if (d_end - d < 1 || bytestream2_get_bytes_left(&gb) < 1)
115 return AVERROR_INVALIDDATA;
116 89509 queue[qpos++] = *d++ = bytestream2_get_byteu(&gb);
117 89509 qpos &= QUEUE_MASK;
118 89509 dataleft--;
119 } else {
120 61941 chainofs = bytestream2_get_byte(&gb);
121 61941 chainofs |= ((bytestream2_peek_byte(&gb) & 0xF0) << 4);
122 61941 chainlen = (bytestream2_get_byte(&gb) & 0x0F) + 3;
123
2/2
✓ Branch 0 taken 7740 times.
✓ Branch 1 taken 54201 times.
61941 if (chainlen == speclen) {
124 7740 chainlen = bytestream2_get_byte(&gb) + 0xF + 3;
125 }
126
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 61941 times.
61941 if (d_end - d < chainlen)
127 return AVERROR_INVALIDDATA;
128
2/2
✓ Branch 0 taken 693697 times.
✓ Branch 1 taken 61941 times.
755638 for (j = 0; j < chainlen; j++) {
129 693697 *d = queue[chainofs++ & QUEUE_MASK];
130 693697 queue[qpos++] = *d++;
131 693697 qpos &= QUEUE_MASK;
132 }
133 61941 dataleft -= chainlen;
134 }
135 151450 tag >>= 1;
136 }
137 }
138 }
139 137 return d - dest;
140 }
141 static int rle_unpack(const unsigned char *src, unsigned char *dest,
142 int src_count, int src_size, int dest_len)
143 {
144 unsigned char *pd;
145 int i, l, used = 0;
146 unsigned char *dest_end = dest + dest_len;
147 GetByteContext gb;
148 uint16_t run_val;
149
150 bytestream2_init(&gb, src, src_size);
151 pd = dest;
152 if (src_count & 1) {
153 if (bytestream2_get_bytes_left(&gb) < 1)
154 return 0;
155 *pd++ = bytestream2_get_byteu(&gb);
156 used++;
157 }
158
159 do {
160 if (bytestream2_get_bytes_left(&gb) < 1)
161 break;
162 l = bytestream2_get_byteu(&gb);
163 if (l & 0x80) {
164 l = (l & 0x7F) * 2;
165 if (dest_end - pd < l || bytestream2_get_bytes_left(&gb) < l)
166 return bytestream2_tell(&gb);
167 bytestream2_get_bufferu(&gb, pd, l);
168 pd += l;
169 } else {
170 if (dest_end - pd < 2*l || bytestream2_get_bytes_left(&gb) < 2)
171 return bytestream2_tell(&gb);
172 run_val = bytestream2_get_ne16(&gb);
173 for (i = 0; i < l; i++) {
174 AV_WN16(pd, run_val);
175 pd += 2;
176 }
177 l *= 2;
178 }
179 used += l;
180 } while (used < src_count);
181
182 return bytestream2_tell(&gb);
183 }
184
185 146 static int vmd_decode(VmdVideoContext *s, AVFrame *frame)
186 {
187 int i;
188 unsigned int *palette32;
189 unsigned char r, g, b;
190
191 GetByteContext gb;
192
193 unsigned char meth;
194 unsigned char *dp; /* pointer to current frame */
195 unsigned char *pp; /* pointer to previous frame */
196 unsigned char len;
197 int ofs;
198
199 int frame_x, frame_y, prev_linesize;
200 int frame_width, frame_height;
201
202 146 frame_x = AV_RL16(&s->buf[6]);
203 146 frame_y = AV_RL16(&s->buf[8]);
204 146 frame_width = AV_RL16(&s->buf[10]) - frame_x + 1;
205 146 frame_height = AV_RL16(&s->buf[12]) - frame_y + 1;
206
207
5/6
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 139 times.
✓ Branch 2 taken 6 times.
✓ Branch 3 taken 1 times.
✓ Branch 4 taken 6 times.
✗ Branch 5 not taken.
146 if ((frame_width == s->avctx->width && frame_height == s->avctx->height) &&
208
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
6 (frame_x || frame_y)) {
209
210 s->x_off = frame_x;
211 s->y_off = frame_y;
212 }
213 146 frame_x -= s->x_off;
214 146 frame_y -= s->y_off;
215
216
2/4
✓ Branch 0 taken 146 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 146 times.
✗ Branch 3 not taken.
146 if (frame_x < 0 || frame_width < 0 ||
217
1/2
✓ Branch 0 taken 146 times.
✗ Branch 1 not taken.
146 frame_x >= s->avctx->width ||
218
1/2
✓ Branch 0 taken 146 times.
✗ Branch 1 not taken.
146 frame_width > s->avctx->width ||
219
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 146 times.
146 frame_x + frame_width > s->avctx->width) {
220 av_log(s->avctx, AV_LOG_ERROR,
221 "Invalid horizontal range %d-%d\n",
222 frame_x, frame_width);
223 return AVERROR_INVALIDDATA;
224 }
225
2/4
✓ Branch 0 taken 146 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 146 times.
✗ Branch 3 not taken.
146 if (frame_y < 0 || frame_height < 0 ||
226
1/2
✓ Branch 0 taken 146 times.
✗ Branch 1 not taken.
146 frame_y >= s->avctx->height ||
227
1/2
✓ Branch 0 taken 146 times.
✗ Branch 1 not taken.
146 frame_height > s->avctx->height ||
228
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 146 times.
146 frame_y + frame_height > s->avctx->height) {
229 av_log(s->avctx, AV_LOG_ERROR,
230 "Invalid vertical range %d-%d\n",
231 frame_y, frame_height);
232 return AVERROR_INVALIDDATA;
233 }
234
235 /* if only a certain region will be updated, copy the entire previous
236 * frame before the decode */
237
4/4
✓ Branch 0 taken 144 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 8 times.
✓ Branch 3 taken 136 times.
146 if (s->prev_frame->data[0] &&
238
3/4
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 3 times.
✓ Branch 2 taken 5 times.
✗ Branch 3 not taken.
8 (frame_x || frame_y || (frame_width != s->avctx->width) ||
239
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 4 times.
5 (frame_height != s->avctx->height))) {
240
241 140 memcpy(frame->data[0], s->prev_frame->data[0],
242 140 s->avctx->height * frame->linesize[0]);
243 }
244
245 /* check if there is a new palette */
246 146 bytestream2_init(&gb, s->buf + 16, s->size - 16);
247
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 146 times.
146 if (s->buf[15] & 0x02) {
248 bytestream2_skip(&gb, 2);
249 palette32 = (unsigned int *)s->palette;
250 if (bytestream2_get_bytes_left(&gb) >= PALETTE_COUNT * 3) {
251 for (i = 0; i < PALETTE_COUNT; i++) {
252 r = bytestream2_get_byteu(&gb) * 4;
253 g = bytestream2_get_byteu(&gb) * 4;
254 b = bytestream2_get_byteu(&gb) * 4;
255 palette32[i] = 0xFFU << 24 | (r << 16) | (g << 8) | (b);
256 palette32[i] |= palette32[i] >> 6 & 0x30303;
257 }
258 } else {
259 av_log(s->avctx, AV_LOG_ERROR, "Incomplete palette\n");
260 return AVERROR_INVALIDDATA;
261 }
262 }
263
264
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 146 times.
146 if (!s->size)
265 return 0;
266
267 /* originally UnpackFrame in VAG's code */
268
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 146 times.
146 if (bytestream2_get_bytes_left(&gb) < 1)
269 return AVERROR_INVALIDDATA;
270 146 meth = bytestream2_get_byteu(&gb);
271
2/2
✓ Branch 0 taken 137 times.
✓ Branch 1 taken 9 times.
146 if (meth & 0x80) {
272 int size;
273
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 137 times.
137 if (!s->unpack_buffer_size) {
274 av_log(s->avctx, AV_LOG_ERROR,
275 "Trying to unpack LZ-compressed frame with no LZ buffer\n");
276 return AVERROR_INVALIDDATA;
277 }
278 137 size = lz_unpack(gb.buffer, bytestream2_get_bytes_left(&gb),
279 s->unpack_buffer, s->unpack_buffer_size);
280
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 137 times.
137 if (size < 0)
281 return size;
282 137 meth &= 0x7F;
283 137 bytestream2_init(&gb, s->unpack_buffer, size);
284 }
285
286 146 dp = &frame->data[0][frame_y * frame->linesize[0] + frame_x];
287
2/2
✓ Branch 0 taken 144 times.
✓ Branch 1 taken 2 times.
146 if (s->prev_frame->data[0]) {
288 144 prev_linesize = s->prev_frame->linesize[0];
289 144 pp = s->prev_frame->data[0] + frame_y * prev_linesize + frame_x;
290 } else {
291 2 pp = NULL;
292 2 prev_linesize = 0;
293 }
294
2/4
✓ Branch 0 taken 140 times.
✓ Branch 1 taken 6 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
146 switch (meth) {
295 140 case 1:
296
2/2
✓ Branch 0 taken 13948 times.
✓ Branch 1 taken 140 times.
14088 for (i = 0; i < frame_height; i++) {
297 13948 ofs = 0;
298 do {
299 61634 len = bytestream2_get_byte(&gb);
300
2/2
✓ Branch 0 taken 22343 times.
✓ Branch 1 taken 39291 times.
61634 if (len & 0x80) {
301 22343 len = (len & 0x7F) + 1;
302
1/2
✓ Branch 0 taken 22343 times.
✗ Branch 1 not taken.
22343 if (ofs + len > frame_width ||
303
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 22343 times.
22343 bytestream2_get_bytes_left(&gb) < len)
304 return AVERROR_INVALIDDATA;
305 22343 bytestream2_get_bufferu(&gb, &dp[ofs], len);
306 22343 ofs += len;
307 } else {
308 /* interframe pixel copy */
309
2/4
✓ Branch 0 taken 39291 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 39291 times.
39291 if (ofs + len + 1 > frame_width || !pp)
310 return AVERROR_INVALIDDATA;
311 39291 memcpy(&dp[ofs], &pp[ofs], len + 1);
312 39291 ofs += len + 1;
313 }
314
2/2
✓ Branch 0 taken 47686 times.
✓ Branch 1 taken 13948 times.
61634 } while (ofs < frame_width);
315
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 13948 times.
13948 if (ofs > frame_width) {
316 av_log(s->avctx, AV_LOG_ERROR,
317 "offset > width (%d > %d)\n",
318 ofs, frame_width);
319 return AVERROR_INVALIDDATA;
320 }
321 13948 dp += frame->linesize[0];
322
1/2
✓ Branch 0 taken 13948 times.
✗ Branch 1 not taken.
13948 pp = FF_PTR_ADD(pp, prev_linesize);
323 }
324 140 break;
325
326 6 case 2:
327
2/2
✓ Branch 0 taken 765 times.
✓ Branch 1 taken 6 times.
771 for (i = 0; i < frame_height; i++) {
328 765 bytestream2_get_buffer(&gb, dp, frame_width);
329 765 dp += frame->linesize[0];
330 }
331 6 break;
332
333 case 3:
334 for (i = 0; i < frame_height; i++) {
335 ofs = 0;
336 do {
337 len = bytestream2_get_byte(&gb);
338 if (len & 0x80) {
339 len = (len & 0x7F) + 1;
340 if (bytestream2_peek_byte(&gb) == 0xFF) {
341 int slen = len;
342 bytestream2_get_byte(&gb);
343 len = rle_unpack(gb.buffer, &dp[ofs],
344 len, bytestream2_get_bytes_left(&gb),
345 frame_width - ofs);
346 ofs += slen;
347 bytestream2_skip(&gb, len);
348 } else {
349 if (ofs + len > frame_width ||
350 bytestream2_get_bytes_left(&gb) < len)
351 return AVERROR_INVALIDDATA;
352 bytestream2_get_buffer(&gb, &dp[ofs], len);
353 ofs += len;
354 }
355 } else {
356 /* interframe pixel copy */
357 if (ofs + len + 1 > frame_width || !pp)
358 return AVERROR_INVALIDDATA;
359 memcpy(&dp[ofs], &pp[ofs], len + 1);
360 ofs += len + 1;
361 }
362 } while (ofs < frame_width);
363 if (ofs > frame_width) {
364 av_log(s->avctx, AV_LOG_ERROR,
365 "offset > width (%d > %d)\n",
366 ofs, frame_width);
367 return AVERROR_INVALIDDATA;
368 }
369 dp += frame->linesize[0];
370 pp = FF_PTR_ADD(pp, prev_linesize);
371 }
372 break;
373 }
374 146 return 0;
375 }
376
377 5 static av_cold int vmdvideo_decode_end(AVCodecContext *avctx)
378 {
379 5 VmdVideoContext *s = avctx->priv_data;
380
381 5 av_frame_free(&s->prev_frame);
382 5 av_freep(&s->unpack_buffer);
383 5 s->unpack_buffer_size = 0;
384
385 5 return 0;
386 }
387
388 5 static av_cold int vmdvideo_decode_init(AVCodecContext *avctx)
389 {
390 5 VmdVideoContext *s = avctx->priv_data;
391 int i;
392 unsigned int *palette32;
393 5 int palette_index = 0;
394 unsigned char r, g, b;
395 unsigned char *vmd_header;
396 unsigned char *raw_palette;
397
398 5 s->avctx = avctx;
399 5 avctx->pix_fmt = AV_PIX_FMT_PAL8;
400
401 /* make sure the VMD header made it */
402
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5 times.
5 if (s->avctx->extradata_size != VMD_HEADER_SIZE) {
403 av_log(s->avctx, AV_LOG_ERROR, "expected extradata size of %d\n",
404 VMD_HEADER_SIZE);
405 return AVERROR_INVALIDDATA;
406 }
407 5 vmd_header = (unsigned char *)avctx->extradata;
408
409 5 s->unpack_buffer_size = AV_RL32(&vmd_header[800]);
410
1/2
✓ Branch 0 taken 5 times.
✗ Branch 1 not taken.
5 if (s->unpack_buffer_size) {
411 5 s->unpack_buffer = av_malloc(s->unpack_buffer_size);
412
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5 times.
5 if (!s->unpack_buffer)
413 return AVERROR(ENOMEM);
414 }
415
416 /* load up the initial palette */
417 5 raw_palette = &vmd_header[28];
418 5 palette32 = (unsigned int *)s->palette;
419
2/2
✓ Branch 0 taken 1280 times.
✓ Branch 1 taken 5 times.
1285 for (i = 0; i < PALETTE_COUNT; i++) {
420 1280 r = raw_palette[palette_index++] * 4;
421 1280 g = raw_palette[palette_index++] * 4;
422 1280 b = raw_palette[palette_index++] * 4;
423 1280 palette32[i] = 0xFFU << 24 | (r << 16) | (g << 8) | (b);
424 1280 palette32[i] |= palette32[i] >> 6 & 0x30303;
425 }
426
427 5 s->prev_frame = av_frame_alloc();
428
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 5 times.
5 if (!s->prev_frame)
429 return AVERROR(ENOMEM);
430
431 5 return 0;
432 }
433
434 146 static int vmdvideo_decode_frame(AVCodecContext *avctx, AVFrame *frame,
435 int *got_frame, AVPacket *avpkt)
436 {
437 146 const uint8_t *buf = avpkt->data;
438 146 int buf_size = avpkt->size;
439 146 VmdVideoContext *s = avctx->priv_data;
440 int ret;
441
442 146 s->buf = buf;
443 146 s->size = buf_size;
444
445
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 146 times.
146 if (buf_size < 16)
446 return AVERROR_INVALIDDATA;
447
448
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 146 times.
146 if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
449 return ret;
450
451
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 146 times.
146 if ((ret = vmd_decode(s, frame)) < 0)
452 return ret;
453
454 /* make the palette available on the way out */
455 146 memcpy(frame->data[1], s->palette, PALETTE_COUNT * 4);
456
457 /* shuffle frames */
458
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 146 times.
146 if ((ret = av_frame_replace(s->prev_frame, frame)) < 0)
459 return ret;
460
461 146 *got_frame = 1;
462
463 /* report that the buffer was completely consumed */
464 146 return buf_size;
465 }
466
467 const FFCodec ff_vmdvideo_decoder = {
468 .p.name = "vmdvideo",
469 CODEC_LONG_NAME("Sierra VMD video"),
470 .p.type = AVMEDIA_TYPE_VIDEO,
471 .p.id = AV_CODEC_ID_VMDVIDEO,
472 .priv_data_size = sizeof(VmdVideoContext),
473 .init = vmdvideo_decode_init,
474 .close = vmdvideo_decode_end,
475 FF_CODEC_DECODE_CB(vmdvideo_decode_frame),
476 .p.capabilities = AV_CODEC_CAP_DR1,
477 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
478 };
479