FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavcodec/pafvideo.c
Date: 2025-07-28 20:30:09
Exec Total Coverage
Lines: 191 223 85.7%
Functions: 8 8 100.0%
Branches: 92 126 73.0%
Line Branch Exec Source
1 /*
2 * Packed Animation File video decoder
3 * Copyright (c) 2012 Paul B Mahol
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 #include "libavutil/imgutils.h"
23 #include "libavutil/mem.h"
24
25 #include "avcodec.h"
26 #include "bytestream.h"
27 #include "copy_block.h"
28 #include "codec_internal.h"
29 #include "decode.h"
30
31
32 static const uint8_t block_sequences[16][8] = {
33 { 0, 0, 0, 0, 0, 0, 0, 0 },
34 { 2, 0, 0, 0, 0, 0, 0, 0 },
35 { 5, 7, 0, 0, 0, 0, 0, 0 },
36 { 5, 0, 0, 0, 0, 0, 0, 0 },
37 { 6, 0, 0, 0, 0, 0, 0, 0 },
38 { 5, 7, 5, 7, 0, 0, 0, 0 },
39 { 5, 7, 5, 0, 0, 0, 0, 0 },
40 { 5, 7, 6, 0, 0, 0, 0, 0 },
41 { 5, 5, 0, 0, 0, 0, 0, 0 },
42 { 3, 0, 0, 0, 0, 0, 0, 0 },
43 { 6, 6, 0, 0, 0, 0, 0, 0 },
44 { 2, 4, 0, 0, 0, 0, 0, 0 },
45 { 2, 4, 5, 7, 0, 0, 0, 0 },
46 { 2, 4, 5, 0, 0, 0, 0, 0 },
47 { 2, 4, 6, 0, 0, 0, 0, 0 },
48 { 2, 4, 5, 7, 5, 7, 0, 0 },
49 };
50
51 typedef struct PAFVideoDecContext {
52 AVFrame *pic;
53 GetByteContext gb;
54
55 int width;
56 int height;
57
58 int current_frame;
59 uint8_t *frame[4];
60 int dirty[4];
61 int frame_size;
62 int video_size;
63
64 uint8_t *opcodes;
65 } PAFVideoDecContext;
66
67 4 static av_cold int paf_video_close(AVCodecContext *avctx)
68 {
69 4 PAFVideoDecContext *c = avctx->priv_data;
70 int i;
71
72 4 av_frame_free(&c->pic);
73
74
2/2
✓ Branch 0 taken 16 times.
✓ Branch 1 taken 4 times.
 20 for (i = 0; i < 4; i++)
75 16 av_freep(&c->frame[i]);
76
77 4 return 0;
78 }
79
80 4 static av_cold int paf_video_init(AVCodecContext *avctx)
81 {
82 4 PAFVideoDecContext *c = avctx->priv_data;
83 int i;
84 int ret;
85
86 4 c->width = avctx->width;
87 4 c->height = avctx->height;
88
89
2/4
✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 4 times.
 4 if (avctx->height & 3 || avctx->width & 3) {
90 ✗ av_log(avctx, AV_LOG_ERROR,
91 "width %d and height %d must be multiplie of 4.\n",
92 avctx->width, avctx->height);
93 ✗ return AVERROR_INVALIDDATA;
94 }
95
96 4 avctx->pix_fmt = AV_PIX_FMT_PAL8;
97 4 ret = av_image_check_size2(avctx->width, FFALIGN(avctx->height, 256), avctx->max_pixels, avctx->pix_fmt, 0, avctx);
98
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (ret < 0)
99 ✗ return ret;
100
101 4 c->pic = av_frame_alloc();
102
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
 4 if (!c->pic)
103 ✗ return AVERROR(ENOMEM);
104
105 4 c->frame_size = avctx->width * FFALIGN(avctx->height, 256);
106 4 c->video_size = avctx->width * avctx->height;
107
2/2
✓ Branch 0 taken 16 times.
✓ Branch 1 taken 4 times.
 20 for (i = 0; i < 4; i++) {
108 16 c->frame[i] = av_mallocz(c->frame_size);
109
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 16 times.
 16 if (!c->frame[i])
110 ✗ return AVERROR(ENOMEM);
111 }
112
113 4 return 0;
114 }
115
116 612 static void read4x4block(PAFVideoDecContext *c, uint8_t *dst, int width)
117 {
118 int i;
119
120
2/2
✓ Branch 0 taken 2448 times.
✓ Branch 1 taken 612 times.
 3060 for (i = 0; i < 4; i++) {
121 2448 bytestream2_get_buffer(&c->gb, dst, 4);
122 2448 dst += width;
123 }
124 612 }
125
126 9005 static void copy_color_mask(uint8_t *dst, int width, uint8_t mask, uint8_t color)
127 {
128 int i;
129
130
2/2
✓ Branch 0 taken 36020 times.
✓ Branch 1 taken 9005 times.
 45025 for (i = 0; i < 4; i++) {
131
2/2
✓ Branch 0 taken 7465 times.
✓ Branch 1 taken 28555 times.
 36020 if (mask & (1 << 7 - i))
132 7465 dst[i] = color;
133
2/2
✓ Branch 0 taken 7596 times.
✓ Branch 1 taken 28424 times.
 36020 if (mask & (1 << 3 - i))
134 7596 dst[width + i] = color;
135 }
136 9005 }
137
138 10810 static void copy_src_mask(uint8_t *dst, int width, uint8_t mask, const uint8_t *src)
139 {
140 int i;
141
142
2/2
✓ Branch 0 taken 43240 times.
✓ Branch 1 taken 10810 times.
 54050 for (i = 0; i < 4; i++) {
143
2/2
✓ Branch 0 taken 14148 times.
✓ Branch 1 taken 29092 times.
 43240 if (mask & (1 << 7 - i))
144 14148 dst[i] = src[i];
145
2/2
✓ Branch 0 taken 14674 times.
✓ Branch 1 taken 28566 times.
 43240 if (mask & (1 << 3 - i))
146 14674 dst[width + i] = src[width + i];
147 }
148 10810 }
149
150 24878 static void set_src_position(PAFVideoDecContext *c,
151 const uint8_t **p,
152 const uint8_t **pend)
153 {
154 24878 int val = bytestream2_get_be16(&c->gb);
155 24878 int page = val >> 14;
156 24878 int x = (val & 0x7F);
157 24878 int y = ((val >> 7) & 0x7F);
158
159 24878 *p = c->frame[page] + x * 2 + y * 2 * c->width;
160 24878 *pend = c->frame[page] + c->frame_size;
161 24878 }
162
163 6 static int decode_0(PAFVideoDecContext *c, const uint8_t *pkt, uint8_t code)
164 {
165 uint32_t opcode_size, offset;
166 6 uint8_t *dst, *dend, mask = 0, color = 0;
167 const uint8_t *src, *send, *opcodes;
168 6 int i, j, op = 0;
169
170 6 i = bytestream2_get_byte(&c->gb);
171
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
 6 if (i) {
172
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
 6 if (code & 0x10) {
173 int align;
174
175 6 align = bytestream2_tell(&c->gb) & 3;
176
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
 6 if (align)
177 6 bytestream2_skip(&c->gb, 4 - align);
178 }
179 do {
180 int page, val, x, y;
181 6 val = bytestream2_get_be16(&c->gb);
182 6 page = val >> 14;
183 6 x = (val & 0x7F) * 2;
184 6 y = ((val >> 7) & 0x7F) * 2;
185 6 dst = c->frame[page] + x + y * c->width;
186 6 dend = c->frame[page] + c->frame_size;
187 6 offset = (x & 0x7F) * 2;
188 6 j = bytestream2_get_le16(&c->gb) + offset;
189
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6 times.
 6 if (bytestream2_get_bytes_left(&c->gb) < (j - offset) * 16)
190 ✗ return AVERROR_INVALIDDATA;
191 6 c->dirty[page] = 1;
192 do {
193 612 offset++;
194
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 612 times.
 612 if (dst + 3 * c->width + 4 > dend)
195 ✗ return AVERROR_INVALIDDATA;
196 612 read4x4block(c, dst, c->width);
197
2/2
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 605 times.
 612 if ((offset & 0x3F) == 0)
198 7 dst += c->width * 3;
199 612 dst += 4;
200
2/2
✓ Branch 0 taken 606 times.
✓ Branch 1 taken 6 times.
 612 } while (offset < j);
201
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6 times.
 6 } while (--i);
202 }
203
204 6 dst = c->frame[c->current_frame];
205 6 dend = c->frame[c->current_frame] + c->frame_size;
206 do {
207 18432 set_src_position(c, &src, &send);
208
1/2
✓ Branch 0 taken 18432 times.
✗ Branch 1 not taken.
 18432 if ((src + 3 * c->width + 4 > send) ||
209
2/4
✓ Branch 0 taken 18432 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 18432 times.
 36864 (dst + 3 * c->width + 4 > dend) ||
210 18432 bytestream2_get_bytes_left(&c->gb) < 4)
211 ✗ return AVERROR_INVALIDDATA;
212 18432 copy_block4(dst, src, c->width, c->width, 4);
213 18432 i++;
214
2/2
✓ Branch 0 taken 288 times.
✓ Branch 1 taken 18144 times.
 18432 if ((i & 0x3F) == 0)
215 288 dst += c->width * 3;
216 18432 dst += 4;
217
2/2
✓ Branch 0 taken 18426 times.
✓ Branch 1 taken 6 times.
 18432 } while (i < c->video_size / 16);
218
219 6 opcode_size = bytestream2_get_le16(&c->gb);
220 6 bytestream2_skip(&c->gb, 2);
221
222
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6 times.
 6 if (bytestream2_get_bytes_left(&c->gb) < opcode_size)
223 ✗ return AVERROR_INVALIDDATA;
224
225 6 opcodes = pkt + bytestream2_tell(&c->gb);
226 6 bytestream2_skipu(&c->gb, opcode_size);
227
228 6 dst = c->frame[c->current_frame];
229
230
2/2
✓ Branch 0 taken 288 times.
✓ Branch 1 taken 6 times.
 294 for (i = 0; i < c->height; i += 4, dst += c->width * 3)
231
2/2
✓ Branch 0 taken 18432 times.
✓ Branch 1 taken 288 times.
 18720 for (j = 0; j < c->width; j += 4, dst += 4) {
232 18432 int opcode, k = 0;
233
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 18432 times.
 18432 if (op > opcode_size)
234 ✗ return AVERROR_INVALIDDATA;
235
2/2
✓ Branch 0 taken 9216 times.
✓ Branch 1 taken 9216 times.
 18432 if (j & 4) {
236 9216 opcode = opcodes[op] & 15;
237 9216 op++;
238 } else {
239 9216 opcode = opcodes[op] >> 4;
240 }
241
242
2/2
✓ Branch 0 taken 19815 times.
✓ Branch 1 taken 18432 times.
 38247 while (block_sequences[opcode][k]) {
243 19815 offset = c->width * 2;
244 19815 code = block_sequences[opcode][k++];
245
246
6/7
✓ Branch 0 taken 4435 times.
✓ Branch 1 taken 1400 times.
✓ Branch 2 taken 3170 times.
✓ Branch 3 taken 5422 times.
✓ Branch 4 taken 1024 times.
✓ Branch 5 taken 4364 times.
✗ Branch 6 not taken.
 19815 switch (code) {
247 4435 case 2:
248 4435 offset = 0;
249 5835 case 3:
250 5835 color = bytestream2_get_byte(&c->gb);
251 9005 case 4:
252 9005 mask = bytestream2_get_byte(&c->gb);
253 9005 copy_color_mask(dst + offset, c->width, mask, color);
254 9005 break;
255 5422 case 5:
256 5422 offset = 0;
257 6446 case 6:
258 6446 set_src_position(c, &src, &send);
259 10810 case 7:
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 10810 times.
 10810 if (src + offset + c->width + 4 > send)
261 ✗ return AVERROR_INVALIDDATA;
262 10810 mask = bytestream2_get_byte(&c->gb);
263 10810 copy_src_mask(dst + offset, c->width, mask, src + offset);
264 10810 break;
265 }
266 }
267 }
268
269 6 return 0;
270 }
271
272 152 static int paf_video_decode(AVCodecContext *avctx, AVFrame *rframe,
273 int *got_frame, AVPacket *pkt)
274 {
275 152 PAFVideoDecContext *c = avctx->priv_data;
276 uint8_t code, *dst, *end;
277 int i, frame, ret;
278
279
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 152 times.
 152 if (pkt->size < 2)
280 ✗ return AVERROR_INVALIDDATA;
281
282 152 bytestream2_init(&c->gb, pkt->data, pkt->size);
283
284 152 code = bytestream2_get_byte(&c->gb);
285
2/4
✓ Branch 0 taken 152 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 152 times.
 152 if ((code & 0xF) > 4 || (code & 0xF) == 3) {
286 ✗ avpriv_request_sample(avctx, "unknown/invalid code");
287 ✗ return AVERROR_INVALIDDATA;
288 }
289
290
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 146 times.
 152 if ((code & 0xF) == 0 &&
291
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6 times.
 6 c->video_size / 32 - (int64_t)bytestream2_get_bytes_left(&c->gb) > c->video_size / 32 * (int64_t)avctx->discard_damaged_percentage / 100)
292 ✗ return AVERROR_INVALIDDATA;
293
294
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 152 times.
 152 if ((ret = ff_reget_buffer(avctx, c->pic, 0)) < 0)
295 ✗ return ret;
296
297
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 150 times.
 152 if (code & 0x20) { // frame is keyframe
298 2 memset(c->pic->data[1], 0, AVPALETTE_SIZE);
299 2 c->current_frame = 0;
300 2 c->pic->flags |= AV_FRAME_FLAG_KEY;
301 2 c->pic->pict_type = AV_PICTURE_TYPE_I;
302 } else {
303 150 c->pic->flags &= ~AV_FRAME_FLAG_KEY;
304 150 c->pic->pict_type = AV_PICTURE_TYPE_P;
305 }
306
307
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 150 times.
 152 if (code & 0x40) { // palette update
308 2 uint32_t *out = (uint32_t *)c->pic->data[1];
309 int index, count;
310
311 2 index = bytestream2_get_byte(&c->gb);
312 2 count = bytestream2_get_byte(&c->gb) + 1;
313
314
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 2 if (index + count > 256)
315 ✗ return AVERROR_INVALIDDATA;
316
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 2 times.
 2 if (bytestream2_get_bytes_left(&c->gb) < 3 * count)
317 ✗ return AVERROR_INVALIDDATA;
318
319 2 out += index;
320
2/2
✓ Branch 0 taken 512 times.
✓ Branch 1 taken 2 times.
 514 for (i = 0; i < count; i++) {
321 unsigned r, g, b;
322
323 512 r = bytestream2_get_byteu(&c->gb);
324 512 r = r << 2 | r >> 4;
325 512 g = bytestream2_get_byteu(&c->gb);
326 512 g = g << 2 | g >> 4;
327 512 b = bytestream2_get_byteu(&c->gb);
328 512 b = b << 2 | b >> 4;
329 512 *out++ = (0xFFU << 24) | (r << 16) | (g << 8) | b;
330 }
331 }
332
333 152 c->dirty[c->current_frame] = 1;
334
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 150 times.
 152 if (code & 0x20)
335
2/2
✓ Branch 0 taken 8 times.
✓ Branch 1 taken 2 times.
 10 for (i = 0; i < 4; i++) {
336
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 3 times.
 8 if (c->dirty[i])
337 5 memset(c->frame[i], 0, c->frame_size);
338 8 c->dirty[i] = 0;
339 }
340
341
3/5
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 28 times.
✓ Branch 3 taken 118 times.
✗ Branch 4 not taken.
 152 switch (code & 0x0F) {
342 6 case 0:
343 /* Block-based motion compensation using 4x4 blocks with either
344 * horizontal or vertical vectors; might incorporate VQ as well. */
345
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 6 times.
 6 if ((ret = decode_0(c, pkt->data, code)) < 0)
346 ✗ return ret;
347 6 break;
348 ✗ case 1:
349 /* Uncompressed data. This mode specifies that (width * height) bytes
350 * should be copied directly from the encoded buffer into the output. */
351 ✗ dst = c->frame[c->current_frame];
352 // possibly chunk length data
353 ✗ bytestream2_skip(&c->gb, 2);
354 ✗ if (bytestream2_get_bytes_left(&c->gb) < c->video_size)
355 ✗ return AVERROR_INVALIDDATA;
356 ✗ bytestream2_get_bufferu(&c->gb, dst, c->video_size);
357 ✗ break;
358 28 case 2:
359 /* Copy reference frame: Consume the next byte in the stream as the
360 * reference frame (which should be 0, 1, 2, or 3, and should not be
361 * the same as the current frame number). */
362 28 frame = bytestream2_get_byte(&c->gb);
363
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 28 times.
 28 if (frame > 3)
364 ✗ return AVERROR_INVALIDDATA;
365
2/2
✓ Branch 0 taken 7 times.
✓ Branch 1 taken 21 times.
 28 if (frame != c->current_frame)
366 7 memcpy(c->frame[c->current_frame], c->frame[frame], c->frame_size);
367 28 break;
368 118 case 4:
369 /* Run length encoding.*/
370 118 dst = c->frame[c->current_frame];
371 118 end = dst + c->video_size;
372
373 118 bytestream2_skip(&c->gb, 2);
374
375
2/2
✓ Branch 0 taken 175223 times.
✓ Branch 1 taken 118 times.
 175341 while (dst < end) {
376 int8_t code;
377 int count;
378
379
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 175223 times.
 175223 if (bytestream2_get_bytes_left(&c->gb) < 2)
380 ✗ return AVERROR_INVALIDDATA;
381
382 175223 code = bytestream2_get_byteu(&c->gb);
383 175223 count = FFABS(code) + 1;
384
385
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 175223 times.
 175223 if (dst + count > end)
386 ✗ return AVERROR_INVALIDDATA;
387
2/2
✓ Branch 0 taken 116135 times.
✓ Branch 1 taken 59088 times.
 175223 if (code < 0)
388 116135 memset(dst, bytestream2_get_byteu(&c->gb), count);
389 else
390 59088 bytestream2_get_buffer(&c->gb, dst, count);
391 175223 dst += count;
392 }
393 118 break;
394 ✗ default:
395 ✗ av_assert0(0);
396 }
397
398 152 av_image_copy_plane(c->pic->data[0], c->pic->linesize[0],
399 152 c->frame[c->current_frame], c->width,
400 c->width, c->height);
401
402 152 c->current_frame = (c->current_frame + 1) & 3;
403
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 152 times.
 152 if ((ret = av_frame_ref(rframe, c->pic)) < 0)
404 ✗ return ret;
405
406 152 *got_frame = 1;
407
408 152 return pkt->size;
409 }
410
411 const FFCodec ff_paf_video_decoder = {
412 .p.name = "paf_video",
413 CODEC_LONG_NAME("Amazing Studio Packed Animation File Video"),
414 .p.type = AVMEDIA_TYPE_VIDEO,
415 .p.id = AV_CODEC_ID_PAF_VIDEO,
416 .priv_data_size = sizeof(PAFVideoDecContext),
417 .init = paf_video_init,
418 .close = paf_video_close,
419 FF_CODEC_DECODE_CB(paf_video_decode),
420 .p.capabilities = AV_CODEC_CAP_DR1,
421 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
422 };
423