FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavcodec/fraps.c
Date: 2025-12-07 22:02:57
Exec Total Coverage
Lines: 122 151 80.8%
Functions: 5 5 100.0%
Branches: 72 98 73.5%
Line Branch Exec Source
1 /*
2 * Fraps FPS1 decoder
3 * Copyright (c) 2005 Roine Gustafsson
4 * Copyright (c) 2006 Konstantin Shishkov
5 *
6 * This file is part of FFmpeg.
7 *
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23 /**
24 * @file
25 * Lossless Fraps 'FPS1' decoder
26 * @author Roine Gustafsson (roine at users sf net)
27 * @author Konstantin Shishkov
28 *
29 * Codec algorithm for version 0 is taken from Transcode <www.transcoding.org>
30 *
31 * Version 2 files support by Konstantin Shishkov
32 */
33
34 #include "config.h"
35
36 #define CACHED_BITSTREAM_READER HAVE_FAST_64BIT
37 #define UNCHECKED_BITSTREAM_READER 1
38 #include "libavutil/mem.h"
39 #include "avcodec.h"
40 #include "get_bits.h"
41 #include "huffman.h"
42 #include "bytestream.h"
43 #include "bswapdsp.h"
44 #include "codec_internal.h"
45 #include "thread.h"
46
47 #define FPS_TAG MKTAG('F', 'P', 'S', 'x')
48 #define VLC_BITS 11
49
50 /**
51 * local variable storage
52 */
53 typedef struct FrapsContext {
54 AVCodecContext *avctx;
55 BswapDSPContext bdsp;
56 uint8_t *tmpbuf;
57 int tmpbuf_size;
58 } FrapsContext;
59
60 /**
61 * initializes decoder
62 * @param avctx codec context
63 * @return 0 on success or negative if fails
64 */
65 14 static av_cold int decode_init(AVCodecContext *avctx)
66 {
67 14 FrapsContext * const s = avctx->priv_data;
68
69 14 s->avctx = avctx;
70 14 s->tmpbuf = NULL;
71
72 14 ff_bswapdsp_init(&s->bdsp);
73
74 14 return 0;
75 }
76
77 /**
78 * Comparator - our nodes should ascend by count
79 * but with preserved symbol order
80 */
81 924225 static int huff_cmp(const void *va, const void *vb)
82 {
83 924225 const Node *a = va, *b = vb;
84 924225 return (a->count - b->count)*256 + a->sym - b->sym;
85 }
86
87 /**
88 * decode Fraps v2 packed plane
89 */
90 417 static int fraps2_decode_plane(FrapsContext *s, uint8_t *dst, int stride, int w,
91 int h, const uint8_t *src, int size, int Uoff,
92 const int step)
93 {
94 int i, j, ret;
95 GetBitContext gb;
96 VLC vlc;
97 Node nodes[512];
98
99
2/2
✓ Branch 0 taken 106752 times.
✓ Branch 1 taken 417 times.
 107169 for (i = 0; i < 256; i++)
100 106752 nodes[i].count = bytestream_get_le32(&src);
101 417 size -= 1024;
102
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 417 times.
 417 if ((ret = ff_huff_build_tree(s->avctx, &vlc, 256, VLC_BITS,
103 nodes, huff_cmp,
104 FF_HUFFMAN_FLAG_ZERO_COUNT)) < 0)
105 ✗ return ret;
106 /* we have built Huffman table and are ready to decode plane */
107
108 /* convert bits so they may be used by standard bitreader */
109 417 s->bdsp.bswap_buf((uint32_t *) s->tmpbuf,
110 (const uint32_t *) src, size >> 2);
111
112
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 417 times.
 417 if ((ret = init_get_bits8(&gb, s->tmpbuf, size)) < 0)
113 ✗ return ret;
114
115
2/2
✓ Branch 0 taken 82192 times.
✓ Branch 1 taken 415 times.
 82607 for (j = 0; j < h; j++) {
116
2/2
✓ Branch 0 taken 29519934 times.
✓ Branch 1 taken 82190 times.
 29602124 for (i = 0; i < w*step; i += step) {
117 29519934 dst[i] = get_vlc2(&gb, vlc.table, VLC_BITS, 3);
118 /* lines are stored as deltas between previous lines
119 * and we need to add 0x80 to the first lines of chroma planes
120 */
121
2/2
✓ Branch 0 taken 29387582 times.
✓ Branch 1 taken 132352 times.
 29519934 if (j)
122 29387582 dst[i] += dst[i - stride];
123
2/2
✓ Branch 0 taken 8192 times.
✓ Branch 1 taken 124160 times.
 132352 else if (Uoff)
124 8192 dst[i] += 0x80;
125
2/2
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 29519932 times.
 29519934 if (get_bits_left(&gb) < 0) {
126 2 ff_vlc_free(&vlc);
127 2 return AVERROR_INVALIDDATA;
128 }
129 }
130 82190 dst += stride;
131 }
132 415 ff_vlc_free(&vlc);
133 415 return 0;
134 }
135
136 176 static int decode_frame(AVCodecContext *avctx, AVFrame *f,
137 int *got_frame, AVPacket *avpkt)
138 {
139 176 FrapsContext * const s = avctx->priv_data;
140 176 const uint8_t *buf = avpkt->data;
141 176 int buf_size = avpkt->size;
142 uint32_t header;
143 unsigned int version,header_size;
144 const uint32_t *buf32;
145 uint32_t *luma1,*luma2,*cb,*cr;
146 uint32_t offs[4];
147 int i, j, ret, is_chroma;
148 176 const int planes = 3;
149 int is_pal;
150 uint8_t *out;
151
152
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 176 times.
 176 if (buf_size < 4) {
153 ✗ av_log(avctx, AV_LOG_ERROR, "Packet is too short\n");
154 ✗ return AVERROR_INVALIDDATA;
155 }
156
157 176 header = AV_RL32(buf);
158 176 version = header & 0xff;
159
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 176 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 176 is_pal = buf[1] == 2 && version == 1;
160
1/2
✓ Branch 0 taken 176 times.
✗ Branch 1 not taken.
 176 header_size = (header & (1<<30))? 8 : 4; /* bit 30 means pad to 8 bytes */
161
162
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 176 times.
 176 if (version > 5) {
163 ✗ avpriv_report_missing_feature(avctx, "Fraps version %u", version);
164 ✗ return AVERROR_PATCHWELCOME;
165 }
166
167 176 buf += header_size;
168
169
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 176 times.
 176 if (is_pal) {
170 ✗ unsigned needed_size = avctx->width * avctx->height + 1024;
171 ✗ needed_size += header_size;
172 ✗ if (buf_size != needed_size) {
173 ✗ av_log(avctx, AV_LOG_ERROR,
174 "Invalid frame length %d (should be %d)\n",
175 buf_size, needed_size);
176 ✗ return AVERROR_INVALIDDATA;
177 }
178
2/2
✓ Branch 0 taken 24 times.
✓ Branch 1 taken 152 times.
 176 } else if (version < 2) {
179 24 unsigned needed_size = avctx->width * avctx->height * 3;
180
2/2
✓ Branch 0 taken 22 times.
✓ Branch 1 taken 2 times.
 24 if (version == 0) needed_size /= 2;
181 24 needed_size += header_size;
182 /* bit 31 means same as previous pic */
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 24 times.
 24 if (header & (1U<<31)) {
184 ✗ *got_frame = 0;
185 ✗ return buf_size;
186 }
187
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 23 times.
 24 if (buf_size != needed_size) {
188 1 av_log(avctx, AV_LOG_ERROR,
189 "Invalid frame length %d (should be %d)\n",
190 buf_size, needed_size);
191 1 return AVERROR_INVALIDDATA;
192 }
193 } else {
194 /* skip frame */
195
2/2
✓ Branch 0 taken 10 times.
✓ Branch 1 taken 142 times.
 152 if (buf_size == 8) {
196 10 *got_frame = 0;
197 10 return buf_size;
198 }
199
2/4
✓ Branch 0 taken 142 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 142 times.
 142 if (AV_RL32(buf) != FPS_TAG || buf_size < planes*1024 + 24) {
200 ✗ av_log(avctx, AV_LOG_ERROR, "error in data stream\n");
201 ✗ return AVERROR_INVALIDDATA;
202 }
203
2/2
✓ Branch 0 taken 424 times.
✓ Branch 1 taken 139 times.
 563 for (i = 0; i < planes; i++) {
204 424 offs[i] = AV_RL32(buf + 4 + i * 4);
205
5/6
✓ Branch 0 taken 421 times.
✓ Branch 1 taken 3 times.
✓ Branch 2 taken 279 times.
✓ Branch 3 taken 142 times.
✗ Branch 4 not taken.
✓ Branch 5 taken 279 times.
 424 if (offs[i] >= buf_size - header_size || (i && offs[i] <= offs[i - 1] + 1024)) {
206 3 av_log(avctx, AV_LOG_ERROR, "plane %i offset is out of bounds\n", i);
207 3 return AVERROR_INVALIDDATA;
208 }
209 }
210 139 offs[planes] = buf_size - header_size;
211
2/2
✓ Branch 0 taken 417 times.
✓ Branch 1 taken 139 times.
 556 for (i = 0; i < planes; i++) {
212 417 av_fast_padded_malloc(&s->tmpbuf, &s->tmpbuf_size, offs[i + 1] - offs[i] - 1024);
213
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 417 times.
 417 if (!s->tmpbuf)
214 ✗ return AVERROR(ENOMEM);
215 }
216 }
217
218
3/4
✓ Branch 0 taken 130 times.
✓ Branch 1 taken 32 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 130 times.
 162 avctx->pix_fmt = version & 1 ? is_pal ? AV_PIX_FMT_PAL8 : AV_PIX_FMT_BGR24 : AV_PIX_FMT_YUVJ420P;
219 324 avctx->color_range = version & 1 ? AVCOL_RANGE_UNSPECIFIED
220
2/2
✓ Branch 0 taken 130 times.
✓ Branch 1 taken 32 times.
 162 : AVCOL_RANGE_JPEG;
221
2/2
✓ Branch 0 taken 130 times.
✓ Branch 1 taken 32 times.
 162 avctx->colorspace = version & 1 ? AVCOL_SPC_UNSPECIFIED : AVCOL_SPC_BT709;
222
223
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 162 times.
 162 if ((ret = ff_thread_get_buffer(avctx, f, 0)) < 0)
224 ✗ return ret;
225
226
4/4
✓ Branch 0 taken 21 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 11 times.
✓ Branch 3 taken 128 times.
 162 switch (version) {
227 21 case 0:
228 default:
229 /* Fraps v0 is a reordered YUV420 */
230
2/4
✓ Branch 0 taken 21 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 21 times.
 21 if (((avctx->width % 8) != 0) || ((avctx->height % 2) != 0)) {
231 ✗ av_log(avctx, AV_LOG_ERROR, "Invalid frame size %dx%d\n",
232 avctx->width, avctx->height);
233 ✗ return AVERROR_INVALIDDATA;
234 }
235
236 21 buf32 = (const uint32_t*)buf;
237
2/2
✓ Branch 0 taken 2268 times.
✓ Branch 1 taken 21 times.
 2289 for (ptrdiff_t y = 0; y < avctx->height / 2; y++) {
238 2268 luma1 = (uint32_t*)&f->data[0][ y * 2 * f->linesize[0] ];
239 2268 luma2 = (uint32_t*)&f->data[0][ (y * 2 + 1) * f->linesize[0] ];
240 2268 cr = (uint32_t*)&f->data[1][ y * f->linesize[1] ];
241 2268 cb = (uint32_t*)&f->data[2][ y * f->linesize[2] ];
242
2/2
✓ Branch 0 taken 88452 times.
✓ Branch 1 taken 2268 times.
 90720 for (ptrdiff_t x = 0; x < avctx->width; x += 8) {
243 88452 *luma1++ = *buf32++;
244 88452 *luma1++ = *buf32++;
245 88452 *luma2++ = *buf32++;
246 88452 *luma2++ = *buf32++;
247 88452 *cr++ = *buf32++;
248 88452 *cb++ = *buf32++;
249 }
250 }
251 21 break;
252
253 2 case 1:
254
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
 2 if (is_pal) {
255 ✗ uint32_t *pal = (uint32_t *)f->data[1];
256
257 ✗ for (unsigned y = 0; y < 256; y++) {
258 ✗ pal[y] = AV_RL32(buf) | 0xFF000000;
259 ✗ buf += 4;
260 }
261
262 ✗ for (ptrdiff_t y = 0; y < avctx->height; y++)
263 ✗ memcpy(&f->data[0][y * f->linesize[0]],
264 ✗ &buf[y * avctx->width],
265 ✗ avctx->width);
266 } else {
267 /* Fraps v1 is an upside-down BGR24 */
268
2/2
✓ Branch 0 taken 480 times.
✓ Branch 1 taken 2 times.
 482 for (ptrdiff_t y = 0; y < avctx->height; y++)
269 480 memcpy(&f->data[0][(avctx->height - y - 1) * f->linesize[0]],
270 480 &buf[y * avctx->width * 3],
271 480 3 * avctx->width);
272 }
273 2 break;
274
275 11 case 2:
276 case 4:
277 /**
278 * Fraps v2 is Huffman-coded YUV420 planes
279 * Fraps v4 is virtually the same
280 */
281
2/2
✓ Branch 0 taken 33 times.
✓ Branch 1 taken 11 times.
 44 for (i = 0; i < planes; i++) {
282 33 is_chroma = !!i;
283
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 33 times.
 33 if ((ret = fraps2_decode_plane(s, f->data[i], f->linesize[i],
284 33 avctx->width >> is_chroma,
285 33 avctx->height >> is_chroma,
286 33 buf + offs[i], offs[i + 1] - offs[i],
287 is_chroma, 1)) < 0) {
288 ✗ av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
289 ✗ return ret;
290 }
291 }
292 11 break;
293 128 case 3:
294 case 5:
295 /* Virtually the same as version 4, but is for RGB24 */
296
2/2
✓ Branch 0 taken 384 times.
✓ Branch 1 taken 126 times.
 510 for (i = 0; i < planes; i++) {
297
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 382 times.
 384 if ((ret = fraps2_decode_plane(s, f->data[0] + i + (f->linesize[0] * (avctx->height - 1)),
298 384 -f->linesize[0], avctx->width, avctx->height,
299 384 buf + offs[i], offs[i + 1] - offs[i], 0, 3)) < 0) {
300 2 av_log(avctx, AV_LOG_ERROR, "Error decoding plane %i\n", i);
301 2 return ret;
302 }
303 }
304 126 out = f->data[0];
305 // convert pseudo-YUV into real RGB
306
2/2
✓ Branch 0 taken 22896 times.
✓ Branch 1 taken 126 times.
 23022 for (j = 0; j < avctx->height; j++) {
307 22896 uint8_t *line_end = out + 3*avctx->width;
308
2/2
✓ Branch 0 taken 7282176 times.
✓ Branch 1 taken 22896 times.
 7305072 while (out < line_end) {
309 7282176 out[0] += out[1];
310 7282176 out[2] += out[1];
311 7282176 out += 3;
312 }
313 22896 out += f->linesize[0] - 3*avctx->width;
314 }
315 126 break;
316 }
317
318 160 *got_frame = 1;
319
320 160 return buf_size;
321 }
322
323 /**
324 * closes decoder
325 * @param avctx codec context
326 * @return 0 on success or negative if fails
327 */
328 14 static av_cold int decode_end(AVCodecContext *avctx)
329 {
330 14 FrapsContext *s = avctx->priv_data;
331
332 14 av_freep(&s->tmpbuf);
333 14 return 0;
334 }
335
336 const FFCodec ff_fraps_decoder = {
337 .p.name = "fraps",
338 CODEC_LONG_NAME("Fraps"),
339 .p.type = AVMEDIA_TYPE_VIDEO,
340 .p.id = AV_CODEC_ID_FRAPS,
341 .priv_data_size = sizeof(FrapsContext),
342 .init = decode_init,
343 .close = decode_end,
344 FF_CODEC_DECODE_CB(decode_frame),
345 .p.capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
346 };
347