FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavformat/pp_bnk.c
Date: 2026-04-27 02:31:40
Exec Total Coverage
Lines: 109 138 79.0%
Functions: 6 7 85.7%
Branches: 65 94 69.1%
Line Branch Exec Source
1 /*
2 * Pro Pinball Series Soundbank (44c, 22c, 11c, 5c) demuxer.
3 *
4 * Copyright (C) 2020 Zane van Iperen (zane@zanevaniperen.com)
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 #include "avformat.h"
23 #include "avio_internal.h"
24 #include "demux.h"
25 #include "internal.h"
26 #include "libavutil/intreadwrite.h"
27 #include "libavutil/avassert.h"
28 #include "libavutil/channel_layout.h"
29 #include "libavutil/internal.h"
30 #include "libavutil/mem.h"
31
32 #define PP_BNK_MAX_READ_SIZE 4096
33 #define PP_BNK_FILE_HEADER_SIZE 20
34 #define PP_BNK_TRACK_SIZE 20
35
36 typedef struct PPBnkHeader {
37 uint32_t bank_id; /*< Bank ID, useless for our purposes. */
38 uint32_t sample_rate; /*< Sample rate of the contained tracks. */
39 uint32_t always1; /*< Unknown, always seems to be 1. */
40 uint32_t track_count; /*< Number of tracks in the file. */
41 uint32_t flags; /*< Flags. */
42 } PPBnkHeader;
43
44 typedef struct PPBnkTrack {
45 uint32_t id; /*< Track ID. Usually track[i].id == track[i-1].id + 1, but not always */
46 uint32_t size; /*< Size of the data in bytes. */
47 uint32_t sample_rate; /*< Sample rate. */
48 uint32_t always1_1; /*< Unknown, always seems to be 1. */
49 uint32_t always1_2; /*< Unknown, always seems to be 1. */
50 } PPBnkTrack;
51
52 typedef struct PPBnkCtxTrack {
53 int64_t data_offset;
54 uint32_t data_size;
55 uint32_t bytes_read;
56 } PPBnkCtxTrack;
57
58 typedef struct PPBnkCtx {
59 int track_count;
60 PPBnkCtxTrack *tracks;
61 uint32_t current_track;
62 int is_music;
63 } PPBnkCtx;
64
65 enum {
66 PP_BNK_FLAG_PERSIST = (1 << 0), /*< This is a large file, keep in memory. */
67 PP_BNK_FLAG_MUSIC = (1 << 1), /*< This is music. */
68 PP_BNK_FLAG_MASK = (PP_BNK_FLAG_PERSIST | PP_BNK_FLAG_MUSIC)
69 };
70
71 10 static void pp_bnk_parse_header(PPBnkHeader *hdr, const uint8_t *buf)
72 {
73 10 hdr->bank_id = AV_RL32(buf + 0);
74 10 hdr->sample_rate = AV_RL32(buf + 4);
75 10 hdr->always1 = AV_RL32(buf + 8);
76 10 hdr->track_count = AV_RL32(buf + 12);
77 10 hdr->flags = AV_RL32(buf + 16);
78 10 }
79
80 17 static void pp_bnk_parse_track(PPBnkTrack *trk, const uint8_t *buf)
81 {
82 17 trk->id = AV_RL32(buf + 0);
83 17 trk->size = AV_RL32(buf + 4);
84 17 trk->sample_rate = AV_RL32(buf + 8);
85 17 trk->always1_1 = AV_RL32(buf + 12);
86 17 trk->always1_2 = AV_RL32(buf + 16);
87 17 }
88
89 7480 static int pp_bnk_probe(const AVProbeData *p)
90 {
91 7480 uint32_t sample_rate = AV_RL32(p->buf + 4);
92 7480 uint32_t track_count = AV_RL32(p->buf + 12);
93 7480 uint32_t flags = AV_RL32(p->buf + 16);
94
95
4/4
✓ Branch 0 taken 7144 times.
✓ Branch 1 taken 336 times.
✓ Branch 2 taken 974 times.
✓ Branch 3 taken 6170 times.
 7480 if (track_count == 0 || track_count > INT_MAX)
96 1310 return 0;
97
98
6/6
✓ Branch 0 taken 6169 times.
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 6160 times.
✓ Branch 3 taken 9 times.
✓ Branch 4 taken 6159 times.
✓ Branch 5 taken 1 times.
 6170 if ((sample_rate != 5512) && (sample_rate != 11025) &&
99
2/2
✓ Branch 0 taken 6157 times.
✓ Branch 1 taken 2 times.
 6159 (sample_rate != 22050) && (sample_rate != 44100))
100 6157 return 0;
101
102 /* Check the first track header. */
103
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 10 times.
 13 if (AV_RL32(p->buf + 28) != sample_rate)
104 3 return 0;
105
106
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
 10 if ((flags & ~PP_BNK_FLAG_MASK) != 0)
107 ✗ return 0;
108
109 10 return AVPROBE_SCORE_MAX / 4 + 1;
110 }
111
112 10 static int pp_bnk_read_header(AVFormatContext *s)
113 {
114 int64_t ret;
115 AVStream *st;
116 AVCodecParameters *par;
117 10 PPBnkCtx *ctx = s->priv_data;
118 uint8_t buf[FFMAX(PP_BNK_FILE_HEADER_SIZE, PP_BNK_TRACK_SIZE)];
119 PPBnkHeader hdr;
120
121
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 10 times.
 10 if ((ret = ffio_read_size(s->pb, buf, PP_BNK_FILE_HEADER_SIZE)) < 0)
122 ✗ return ret;
123
124 10 pp_bnk_parse_header(&hdr, buf);
125
126
2/4
✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 10 times.
 10 if (hdr.track_count == 0 || hdr.track_count > INT_MAX)
127 ✗ return AVERROR_INVALIDDATA;
128
129
2/4
✓ Branch 0 taken 10 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 10 times.
 10 if (hdr.sample_rate == 0 || hdr.sample_rate > INT_MAX)
130 ✗ return AVERROR_INVALIDDATA;
131
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
 10 if (hdr.always1 != 1) {
133 ✗ avpriv_request_sample(s, "Non-one header value");
134 ✗ return AVERROR_PATCHWELCOME;
135 }
136
137 10 ctx->track_count = hdr.track_count;
138
139
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 10 times.
 10 if (!(ctx->tracks = av_malloc_array(hdr.track_count, sizeof(PPBnkCtxTrack))))
140 ✗ return AVERROR(ENOMEM);
141
142 /* Parse and validate each track. */
143
2/2
✓ Branch 0 taken 18 times.
✓ Branch 1 taken 4 times.
 22 for (int i = 0; i < hdr.track_count; i++) {
144 PPBnkTrack e;
145 18 PPBnkCtxTrack *trk = ctx->tracks + i;
146
147 18 ret = avio_read(s->pb, buf, PP_BNK_TRACK_SIZE);
148
3/4
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 17 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 1 times.
 18 if (ret < 0 && ret != AVERROR_EOF)
149 ✗ return ret;
150
151 /* Short byte-count or EOF, we have a truncated file. */
152
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 17 times.
 18 if (ret != PP_BNK_TRACK_SIZE) {
153 1 av_log(s, AV_LOG_WARNING, "File truncated at %d/%u track(s)\n",
154 i, hdr.track_count);
155 1 ctx->track_count = i;
156 6 break;
157 }
158
159 17 pp_bnk_parse_track(&e, buf);
160
161 /* The individual sample rates of all tracks must match that of the file header. */
162
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 17 times.
 17 if (e.sample_rate != hdr.sample_rate)
163 ✗ return AVERROR_INVALIDDATA;
164
165
2/4
✓ Branch 0 taken 17 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 17 times.
 17 if (e.always1_1 != 1 || e.always1_2 != 1) {
166 ✗ avpriv_request_sample(s, "Non-one track header values");
167 ✗ return AVERROR_PATCHWELCOME;
168 }
169
170 17 trk->data_offset = avio_tell(s->pb);
171 17 trk->data_size = e.size;
172 17 trk->bytes_read = 0;
173
174 /*
175 * Skip over the data to the next stream header.
176 * Sometimes avio_skip() doesn't detect EOF. If it doesn't, either:
177 * - the avio_read() above will, or
178 * - pp_bnk_read_packet() will read a truncated last track.
179 */
180
2/2
✓ Branch 1 taken 5 times.
✓ Branch 2 taken 12 times.
 17 if ((ret = avio_skip(s->pb, e.size)) == AVERROR_EOF) {
181 5 ctx->track_count = i + 1;
182 5 av_log(s, AV_LOG_WARNING,
183 "Track %d has truncated data, assuming track count == %d\n",
184 i, ctx->track_count);
185 5 break;
186
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 12 times.
 12 } else if (ret < 0) {
187 ✗ return ret;
188 }
189 }
190
191 /* File is only a header. */
192
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 10 times.
 10 if (ctx->track_count == 0)
193 ✗ return AVERROR_INVALIDDATA;
194
195 21 ctx->is_music = (hdr.flags & PP_BNK_FLAG_MUSIC) &&
196
3/4
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 9 times.
✓ Branch 2 taken 1 times.
✗ Branch 3 not taken.
 11 (ctx->track_count == 2) &&
197
1/2
✓ Branch 0 taken 1 times.
✗ Branch 1 not taken.
 1 (ctx->tracks[0].data_size == ctx->tracks[1].data_size);
198
199 /* Build the streams. */
200
4/4
✓ Branch 0 taken 24 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 16 times.
✓ Branch 3 taken 10 times.
 26 for (int i = 0; i < (ctx->is_music ? 1 : ctx->track_count); i++) {
201
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 16 times.
 16 if (!(st = avformat_new_stream(s, NULL)))
202 ✗ return AVERROR(ENOMEM);
203
204 16 par = st->codecpar;
205 16 par->codec_type = AVMEDIA_TYPE_AUDIO;
206 16 par->codec_id = AV_CODEC_ID_ADPCM_IMA_CUNNING;
207 16 par->format = AV_SAMPLE_FMT_S16P;
208
209 16 av_channel_layout_default(&par->ch_layout, ctx->is_music + 1);
210 16 par->sample_rate = hdr.sample_rate;
211 16 par->bits_per_coded_sample = 4;
212 16 par->block_align = 1;
213 16 par->bit_rate = par->sample_rate * (int64_t)par->bits_per_coded_sample *
214 16 par->ch_layout.nb_channels;
215
216 16 avpriv_set_pts_info(st, 64, 1, par->sample_rate);
217 16 st->start_time = 0;
218 16 st->duration = ctx->tracks[i].data_size * 2;
219 }
220
221 10 return 0;
222 }
223
224 76 static int pp_bnk_read_packet(AVFormatContext *s, AVPacket *pkt)
225 {
226 76 PPBnkCtx *ctx = s->priv_data;
227
228 /*
229 * Read a packet from each track, round-robin style.
230 * This method is nasty, but needed to avoid "Too many packets buffered" errors.
231 */
232
2/2
✓ Branch 0 taken 112 times.
✓ Branch 1 taken 20 times.
 132 for (int i = 0; i < ctx->track_count; i++, ctx->current_track++)
233 {
234 int64_t ret;
235 int size;
236 PPBnkCtxTrack *trk;
237
238 112 ctx->current_track %= ctx->track_count;
239
240 112 trk = ctx->tracks + ctx->current_track;
241
242
2/2
✓ Branch 0 taken 39 times.
✓ Branch 1 taken 73 times.
 112 if (trk->bytes_read == trk->data_size)
243 39 continue;
244
245
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 73 times.
 73 if ((ret = avio_seek(s->pb, trk->data_offset + trk->bytes_read, SEEK_SET)) < 0)
246 ✗ return ret;
247
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 73 times.
 73 else if (ret != trk->data_offset + trk->bytes_read)
248 ✗ return AVERROR_INVALIDDATA;
249
250 73 size = FFMIN(trk->data_size - trk->bytes_read, PP_BNK_MAX_READ_SIZE);
251
252
2/2
✓ Branch 0 taken 49 times.
✓ Branch 1 taken 24 times.
 73 if (!ctx->is_music) {
253 49 ret = av_get_packet(s->pb, pkt, size);
254
2/2
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 44 times.
 49 if (ret == AVERROR_EOF) {
255 /* If we've hit EOF, don't attempt this track again. */
256 5 trk->data_size = trk->bytes_read;
257 5 continue;
258 }
259 } else {
260
3/4
✓ Branch 0 taken 12 times.
✓ Branch 1 taken 12 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 12 times.
 24 if (!pkt->data && (ret = av_new_packet(pkt, size * 2)) < 0)
261 ✗ return ret;
262 24 ret = avio_read(s->pb, pkt->data + size * ctx->current_track, size);
263
2/4
✓ Branch 0 taken 24 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 24 times.
 24 if (ret >= 0 && ret != size) {
264 /* Only return stereo packets if both tracks could be read. */
265 ✗ ret = AVERROR_EOF;
266 }
267 }
268
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 68 times.
 68 if (ret < 0)
269 ✗ return ret;
270
271 68 trk->bytes_read += ret;
272 68 pkt->flags &= ~AV_PKT_FLAG_CORRUPT;
273 68 pkt->stream_index = ctx->current_track;
274 68 pkt->duration = ret * 2;
275
276
2/2
✓ Branch 0 taken 24 times.
✓ Branch 1 taken 44 times.
 68 if (ctx->is_music) {
277
2/2
✓ Branch 0 taken 12 times.
✓ Branch 1 taken 12 times.
 24 if (pkt->stream_index == 0)
278 12 continue;
279
280 12 pkt->stream_index = 0;
281 }
282
283 56 ctx->current_track++;
284 56 return 0;
285 }
286
287 /* If we reach here, we're done. */
288 20 return AVERROR_EOF;
289 }
290
291 10 static int pp_bnk_read_close(AVFormatContext *s)
292 {
293 10 PPBnkCtx *ctx = s->priv_data;
294
295 10 av_freep(&ctx->tracks);
296
297 10 return 0;
298 }
299
300 ✗ static int pp_bnk_seek(AVFormatContext *s, int stream_index,
301 int64_t pts, int flags)
302 {
303 ✗ PPBnkCtx *ctx = s->priv_data;
304
305 ✗ if (pts != 0)
306 ✗ return AVERROR(EINVAL);
307
308 ✗ if (ctx->is_music) {
309 ✗ av_assert0(stream_index == 0);
310 ✗ ctx->tracks[0].bytes_read = 0;
311 ✗ ctx->tracks[1].bytes_read = 0;
312 } else {
313 ✗ ctx->tracks[stream_index].bytes_read = 0;
314 }
315
316 ✗ return 0;
317 }
318
319 const FFInputFormat ff_pp_bnk_demuxer = {
320 .p.name = "pp_bnk",
321 .p.long_name = NULL_IF_CONFIG_SMALL("Pro Pinball Series Soundbank"),
322 .priv_data_size = sizeof(PPBnkCtx),
323 .flags_internal = FF_INFMT_FLAG_INIT_CLEANUP,
324 .read_probe = pp_bnk_probe,
325 .read_header = pp_bnk_read_header,
326 .read_packet = pp_bnk_read_packet,
327 .read_close = pp_bnk_read_close,
328 .read_seek = pp_bnk_seek,
329 };
330