FFmpeg
pp_bnk.c
Go to the documentation of this file.
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 "demux.h"
24 #include "internal.h"
25 #include "libavutil/intreadwrite.h"
26 #include "libavutil/avassert.h"
28 #include "libavutil/internal.h"
29 #include "libavutil/mem.h"
30 
31 #define PP_BNK_MAX_READ_SIZE 4096
32 #define PP_BNK_FILE_HEADER_SIZE 20
33 #define PP_BNK_TRACK_SIZE 20
34 
35 typedef struct PPBnkHeader {
36  uint32_t bank_id; /*< Bank ID, useless for our purposes. */
37  uint32_t sample_rate; /*< Sample rate of the contained tracks. */
38  uint32_t always1; /*< Unknown, always seems to be 1. */
39  uint32_t track_count; /*< Number of tracks in the file. */
40  uint32_t flags; /*< Flags. */
41 } PPBnkHeader;
42 
43 typedef struct PPBnkTrack {
44  uint32_t id; /*< Track ID. Usually track[i].id == track[i-1].id + 1, but not always */
45  uint32_t size; /*< Size of the data in bytes. */
46  uint32_t sample_rate; /*< Sample rate. */
47  uint32_t always1_1; /*< Unknown, always seems to be 1. */
48  uint32_t always1_2; /*< Unknown, always seems to be 1. */
49 } PPBnkTrack;
50 
51 typedef struct PPBnkCtxTrack {
52  int64_t data_offset;
53  uint32_t data_size;
54  uint32_t bytes_read;
56 
57 typedef struct PPBnkCtx {
60  uint32_t current_track;
61  int is_music;
62 } PPBnkCtx;
63 
64 enum {
65  PP_BNK_FLAG_PERSIST = (1 << 0), /*< This is a large file, keep in memory. */
66  PP_BNK_FLAG_MUSIC = (1 << 1), /*< This is music. */
68 };
69 
70 static void pp_bnk_parse_header(PPBnkHeader *hdr, const uint8_t *buf)
71 {
72  hdr->bank_id = AV_RL32(buf + 0);
73  hdr->sample_rate = AV_RL32(buf + 4);
74  hdr->always1 = AV_RL32(buf + 8);
75  hdr->track_count = AV_RL32(buf + 12);
76  hdr->flags = AV_RL32(buf + 16);
77 }
78 
79 static void pp_bnk_parse_track(PPBnkTrack *trk, const uint8_t *buf)
80 {
81  trk->id = AV_RL32(buf + 0);
82  trk->size = AV_RL32(buf + 4);
83  trk->sample_rate = AV_RL32(buf + 8);
84  trk->always1_1 = AV_RL32(buf + 12);
85  trk->always1_2 = AV_RL32(buf + 16);
86 }
87 
88 static int pp_bnk_probe(const AVProbeData *p)
89 {
90  uint32_t sample_rate = AV_RL32(p->buf + 4);
91  uint32_t track_count = AV_RL32(p->buf + 12);
92  uint32_t flags = AV_RL32(p->buf + 16);
93 
94  if (track_count == 0 || track_count > INT_MAX)
95  return 0;
96 
97  if ((sample_rate != 5512) && (sample_rate != 11025) &&
98  (sample_rate != 22050) && (sample_rate != 44100))
99  return 0;
100 
101  /* Check the first track header. */
102  if (AV_RL32(p->buf + 28) != sample_rate)
103  return 0;
104 
105  if ((flags & ~PP_BNK_FLAG_MASK) != 0)
106  return 0;
107 
108  return AVPROBE_SCORE_MAX / 4 + 1;
109 }
110 
112 {
113  int64_t ret;
114  AVStream *st;
115  AVCodecParameters *par;
116  PPBnkCtx *ctx = s->priv_data;
118  PPBnkHeader hdr;
119 
120  if ((ret = avio_read(s->pb, buf, PP_BNK_FILE_HEADER_SIZE)) < 0)
121  return ret;
122  else if (ret != PP_BNK_FILE_HEADER_SIZE)
123  return AVERROR(EIO);
124 
125  pp_bnk_parse_header(&hdr, buf);
126 
127  if (hdr.track_count == 0 || hdr.track_count > INT_MAX)
128  return AVERROR_INVALIDDATA;
129 
130  if (hdr.sample_rate == 0 || hdr.sample_rate > INT_MAX)
131  return AVERROR_INVALIDDATA;
132 
133  if (hdr.always1 != 1) {
134  avpriv_request_sample(s, "Non-one header value");
135  return AVERROR_PATCHWELCOME;
136  }
137 
138  ctx->track_count = hdr.track_count;
139 
140  if (!(ctx->tracks = av_malloc_array(hdr.track_count, sizeof(PPBnkCtxTrack))))
141  return AVERROR(ENOMEM);
142 
143  /* Parse and validate each track. */
144  for (int i = 0; i < hdr.track_count; i++) {
145  PPBnkTrack e;
146  PPBnkCtxTrack *trk = ctx->tracks + i;
147 
148  ret = avio_read(s->pb, buf, PP_BNK_TRACK_SIZE);
149  if (ret < 0 && ret != AVERROR_EOF)
150  return ret;
151 
152  /* Short byte-count or EOF, we have a truncated file. */
153  if (ret != PP_BNK_TRACK_SIZE) {
154  av_log(s, AV_LOG_WARNING, "File truncated at %d/%u track(s)\n",
155  i, hdr.track_count);
156  ctx->track_count = i;
157  break;
158  }
159 
160  pp_bnk_parse_track(&e, buf);
161 
162  /* The individual sample rates of all tracks must match that of the file header. */
163  if (e.sample_rate != hdr.sample_rate)
164  return AVERROR_INVALIDDATA;
165 
166  if (e.always1_1 != 1 || e.always1_2 != 1) {
167  avpriv_request_sample(s, "Non-one track header values");
168  return AVERROR_PATCHWELCOME;
169  }
170 
171  trk->data_offset = avio_tell(s->pb);
172  trk->data_size = e.size;
173  trk->bytes_read = 0;
174 
175  /*
176  * Skip over the data to the next stream header.
177  * Sometimes avio_skip() doesn't detect EOF. If it doesn't, either:
178  * - the avio_read() above will, or
179  * - pp_bnk_read_packet() will read a truncated last track.
180  */
181  if ((ret = avio_skip(s->pb, e.size)) == AVERROR_EOF) {
182  ctx->track_count = i + 1;
184  "Track %d has truncated data, assuming track count == %d\n",
185  i, ctx->track_count);
186  break;
187  } else if (ret < 0) {
188  return ret;
189  }
190  }
191 
192  /* File is only a header. */
193  if (ctx->track_count == 0)
194  return AVERROR_INVALIDDATA;
195 
196  ctx->is_music = (hdr.flags & PP_BNK_FLAG_MUSIC) &&
197  (ctx->track_count == 2) &&
198  (ctx->tracks[0].data_size == ctx->tracks[1].data_size);
199 
200  /* Build the streams. */
201  for (int i = 0; i < (ctx->is_music ? 1 : ctx->track_count); i++) {
202  if (!(st = avformat_new_stream(s, NULL)))
203  return AVERROR(ENOMEM);
204 
205  par = st->codecpar;
208  par->format = AV_SAMPLE_FMT_S16P;
209 
210  av_channel_layout_default(&par->ch_layout, ctx->is_music + 1);
211  par->sample_rate = hdr.sample_rate;
212  par->bits_per_coded_sample = 4;
213  par->block_align = 1;
214  par->bit_rate = par->sample_rate * (int64_t)par->bits_per_coded_sample *
215  par->ch_layout.nb_channels;
216 
217  avpriv_set_pts_info(st, 64, 1, par->sample_rate);
218  st->start_time = 0;
219  st->duration = ctx->tracks[i].data_size * 2;
220  }
221 
222  return 0;
223 }
224 
226 {
227  PPBnkCtx *ctx = s->priv_data;
228 
229  /*
230  * Read a packet from each track, round-robin style.
231  * This method is nasty, but needed to avoid "Too many packets buffered" errors.
232  */
233  for (int i = 0; i < ctx->track_count; i++, ctx->current_track++)
234  {
235  int64_t ret;
236  int size;
237  PPBnkCtxTrack *trk;
238 
239  ctx->current_track %= ctx->track_count;
240 
241  trk = ctx->tracks + ctx->current_track;
242 
243  if (trk->bytes_read == trk->data_size)
244  continue;
245 
246  if ((ret = avio_seek(s->pb, trk->data_offset + trk->bytes_read, SEEK_SET)) < 0)
247  return ret;
248  else if (ret != trk->data_offset + trk->bytes_read)
249  return AVERROR(EIO);
250 
252 
253  if (!ctx->is_music) {
254  ret = av_get_packet(s->pb, pkt, size);
255  if (ret == AVERROR_EOF) {
256  /* If we've hit EOF, don't attempt this track again. */
257  trk->data_size = trk->bytes_read;
258  continue;
259  }
260  } else {
261  if (!pkt->data && (ret = av_new_packet(pkt, size * 2)) < 0)
262  return ret;
263  ret = avio_read(s->pb, pkt->data + size * ctx->current_track, size);
264  if (ret >= 0 && ret != size) {
265  /* Only return stereo packets if both tracks could be read. */
266  ret = AVERROR_EOF;
267  }
268  }
269  if (ret < 0)
270  return ret;
271 
272  trk->bytes_read += ret;
274  pkt->stream_index = ctx->current_track;
275  pkt->duration = ret * 2;
276 
277  if (ctx->is_music) {
278  if (pkt->stream_index == 0)
279  continue;
280 
281  pkt->stream_index = 0;
282  }
283 
284  ctx->current_track++;
285  return 0;
286  }
287 
288  /* If we reach here, we're done. */
289  return AVERROR_EOF;
290 }
291 
293 {
294  PPBnkCtx *ctx = s->priv_data;
295 
296  av_freep(&ctx->tracks);
297 
298  return 0;
299 }
300 
301 static int pp_bnk_seek(AVFormatContext *s, int stream_index,
302  int64_t pts, int flags)
303 {
304  PPBnkCtx *ctx = s->priv_data;
305 
306  if (pts != 0)
307  return AVERROR(EINVAL);
308 
309  if (ctx->is_music) {
310  av_assert0(stream_index == 0);
311  ctx->tracks[0].bytes_read = 0;
312  ctx->tracks[1].bytes_read = 0;
313  } else {
314  ctx->tracks[stream_index].bytes_read = 0;
315  }
316 
317  return 0;
318 }
319 
321  .p.name = "pp_bnk",
322  .p.long_name = NULL_IF_CONFIG_SMALL("Pro Pinball Series Soundbank"),
323  .priv_data_size = sizeof(PPBnkCtx),
324  .flags_internal = FF_INFMT_FLAG_INIT_CLEANUP,
330 };
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:51
PPBnkCtx::is_music
int is_music
Definition: pp_bnk.c:61
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:47
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const struct AVCodec *c)
Add a new stream to a media file.
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
pp_bnk_parse_header
static void pp_bnk_parse_header(PPBnkHeader *hdr, const uint8_t *buf)
Definition: pp_bnk.c:70
PPBnkTrack::always1_2
uint32_t always1_2
Definition: pp_bnk.c:48
pp_bnk_seek
static int pp_bnk_seek(AVFormatContext *s, int stream_index, int64_t pts, int flags)
Definition: pp_bnk.c:301
AV_CODEC_ID_ADPCM_IMA_CUNNING
@ AV_CODEC_ID_ADPCM_IMA_CUNNING
Definition: codec_id.h:415
AVPacket::data
uint8_t * data
Definition: packet.h:520
PPBnkCtx::track_count
int track_count
Definition: pp_bnk.c:58
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:538
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
PPBnkHeader::track_count
uint32_t track_count
Definition: pp_bnk.c:39
PPBnkTrack
Definition: pp_bnk.c:43
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:321
sample_rate
sample_rate
Definition: ffmpeg_filter.c:424
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:463
avpriv_set_pts_info
void avpriv_set_pts_info(AVStream *st, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: avformat.c:853
PPBnkCtxTrack
Definition: pp_bnk.c:51
PPBnkCtxTrack::data_size
uint32_t data_size
Definition: pp_bnk.c:53
read_seek
static int read_seek(AVFormatContext *ctx, int stream_index, int64_t timestamp, int flags)
Definition: libcdio.c:151
read_close
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:143
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:494
pts
static int64_t pts
Definition: transcode_aac.c:644
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:802
PPBnkTrack::always1_1
uint32_t always1_1
Definition: pp_bnk.c:47
avassert.h
pkt
AVPacket * pkt
Definition: movenc.c:60
AV_PKT_FLAG_CORRUPT
#define AV_PKT_FLAG_CORRUPT
The packet content is corrupted.
Definition: packet.h:576
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_read_callback.c:42
pp_bnk_probe
static int pp_bnk_probe(const AVProbeData *p)
Definition: pp_bnk.c:88
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
av_new_packet
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: packet.c:98
PPBnkTrack::id
uint32_t id
Definition: pp_bnk.c:44
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:553
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:453
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
PPBnkHeader::always1
uint32_t always1
Definition: pp_bnk.c:38
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:40
ctx
AVFormatContext * ctx
Definition: movenc.c:49
PPBnkCtx::current_track
uint32_t current_track
Definition: pp_bnk.c:60
pp_bnk_read_close
static int pp_bnk_read_close(AVFormatContext *s)
Definition: pp_bnk.c:292
PPBnkHeader::bank_id
uint32_t bank_id
Definition: pp_bnk.c:36
PPBnkCtx::tracks
PPBnkCtxTrack * tracks
Definition: pp_bnk.c:59
PP_BNK_MAX_READ_SIZE
#define PP_BNK_MAX_READ_SIZE
Definition: pp_bnk.c:31
FF_INFMT_FLAG_INIT_CLEANUP
#define FF_INFMT_FLAG_INIT_CLEANUP
For an FFInputFormat with this flag set read_close() needs to be called by the caller upon read_heade...
Definition: demux.h:35
PPBnkTrack::size
uint32_t size
Definition: pp_bnk.c:45
AVFormatContext
Format I/O context.
Definition: avformat.h:1255
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:766
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:550
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:451
PPBnkTrack::sample_rate
uint32_t sample_rate
Definition: pp_bnk.c:46
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:180
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:184
pp_bnk_parse_track
static void pp_bnk_parse_track(PPBnkTrack *trk, const uint8_t *buf)
Definition: pp_bnk.c:79
PP_BNK_FLAG_PERSIST
@ PP_BNK_FLAG_PERSIST
Definition: pp_bnk.c:65
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:94
size
int size
Definition: twinvq_data.h:10344
PP_BNK_TRACK_SIZE
#define PP_BNK_TRACK_SIZE
Definition: pp_bnk.c:33
FFInputFormat::p
AVInputFormat p
The public AVInputFormat.
Definition: demux.h:41
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:526
AV_SAMPLE_FMT_S16P
@ AV_SAMPLE_FMT_S16P
signed 16 bits, planar
Definition: samplefmt.h:64
PPBnkHeader
Definition: pp_bnk.c:35
PPBnkCtx
Definition: pp_bnk.c:57
PPBnkCtxTrack::bytes_read
uint32_t bytes_read
Definition: pp_bnk.c:54
pp_bnk_read_header
static int pp_bnk_read_header(AVFormatContext *s)
Definition: pp_bnk.c:111
av_channel_layout_default
void av_channel_layout_default(AVChannelLayout *ch_layout, int nb_channels)
Get the default channel layout for a given number of channels.
Definition: channel_layout.c:834
PP_BNK_FLAG_MASK
@ PP_BNK_FLAG_MASK
Definition: pp_bnk.c:67
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
internal.h
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:191
av_malloc_array
#define av_malloc_array(a, b)
Definition: tableprint_vlc.h:31
ff_pp_bnk_demuxer
const FFInputFormat ff_pp_bnk_demuxer
Definition: pp_bnk.c:320
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
demux.h
PPBnkHeader::sample_rate
uint32_t sample_rate
Definition: pp_bnk.c:37
av_get_packet
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:91
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:743
PPBnkCtxTrack::data_offset
int64_t data_offset
Definition: pp_bnk.c:52
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:231
PP_BNK_FILE_HEADER_SIZE
#define PP_BNK_FILE_HEADER_SIZE
Definition: pp_bnk.c:32
avformat.h
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
channel_layout.h
PPBnkHeader::flags
uint32_t flags
Definition: pp_bnk.c:40
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:612
pp_bnk_read_packet
static int pp_bnk_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: pp_bnk.c:225
AVPacket::stream_index
int stream_index
Definition: packet.h:522
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:318
read_probe
static int read_probe(const AVProbeData *p)
Definition: cdg.c:30
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:110
mem.h
avpriv_request_sample
#define avpriv_request_sample(...)
Definition: tableprint_vlc.h:36
AVCodecParameters::format
int format
Definition: codec_par.h:92
PP_BNK_FLAG_MUSIC
@ PP_BNK_FLAG_MUSIC
Definition: pp_bnk.c:66
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:55
AVPacket
This structure stores compressed data.
Definition: packet.h:497
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
FFInputFormat
Definition: demux.h:37
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:474
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:97
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AVStream::start_time
int64_t start_time
Decoding: pts of the first frame of the stream in presentation order, in stream time base.
Definition: avformat.h:792