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 "internal.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/avassert.h"
27 #include "libavutil/internal.h"
28 
29 #define PP_BNK_MAX_READ_SIZE 4096
30 #define PP_BNK_FILE_HEADER_SIZE 20
31 #define PP_BNK_TRACK_SIZE 20
32 
33 typedef struct PPBnkHeader {
34  uint32_t bank_id; /*< Bank ID, useless for our purposes. */
35  uint32_t sample_rate; /*< Sample rate of the contained tracks. */
36  uint32_t always1; /*< Unknown, always seems to be 1. */
37  uint32_t track_count; /*< Number of tracks in the file. */
38  uint32_t flags; /*< Flags. */
39 } PPBnkHeader;
40 
41 typedef struct PPBnkTrack {
42  uint32_t id; /*< Track ID. Usually track[i].id == track[i-1].id + 1, but not always */
43  uint32_t size; /*< Size of the data in bytes. */
44  uint32_t sample_rate; /*< Sample rate. */
45  uint32_t always1_1; /*< Unknown, always seems to be 1. */
46  uint32_t always1_2; /*< Unknown, always seems to be 1. */
47 } PPBnkTrack;
48 
49 typedef struct PPBnkCtxTrack {
50  int64_t data_offset;
51  uint32_t data_size;
52  uint32_t bytes_read;
54 
55 typedef struct PPBnkCtx {
58  uint32_t current_track;
59  int is_music;
60 } PPBnkCtx;
61 
62 enum {
63  PP_BNK_FLAG_PERSIST = (1 << 0), /*< This is a large file, keep in memory. */
64  PP_BNK_FLAG_MUSIC = (1 << 1), /*< This is music. */
66 };
67 
68 static void pp_bnk_parse_header(PPBnkHeader *hdr, const uint8_t *buf)
69 {
70  hdr->bank_id = AV_RL32(buf + 0);
71  hdr->sample_rate = AV_RL32(buf + 4);
72  hdr->always1 = AV_RL32(buf + 8);
73  hdr->track_count = AV_RL32(buf + 12);
74  hdr->flags = AV_RL32(buf + 16);
75 }
76 
77 static void pp_bnk_parse_track(PPBnkTrack *trk, const uint8_t *buf)
78 {
79  trk->id = AV_RL32(buf + 0);
80  trk->size = AV_RL32(buf + 4);
81  trk->sample_rate = AV_RL32(buf + 8);
82  trk->always1_1 = AV_RL32(buf + 12);
83  trk->always1_2 = AV_RL32(buf + 16);
84 }
85 
86 static int pp_bnk_probe(const AVProbeData *p)
87 {
88  uint32_t sample_rate = AV_RL32(p->buf + 4);
89  uint32_t track_count = AV_RL32(p->buf + 12);
90  uint32_t flags = AV_RL32(p->buf + 16);
91 
92  if (track_count == 0 || track_count > INT_MAX)
93  return 0;
94 
95  if ((sample_rate != 5512) && (sample_rate != 11025) &&
96  (sample_rate != 22050) && (sample_rate != 44100))
97  return 0;
98 
99  /* Check the first track header. */
100  if (AV_RL32(p->buf + 28) != sample_rate)
101  return 0;
102 
103  if ((flags & ~PP_BNK_FLAG_MASK) != 0)
104  return 0;
105 
106  return AVPROBE_SCORE_MAX / 4 + 1;
107 }
108 
110 {
111  int64_t ret;
112  AVStream *st;
113  AVCodecParameters *par;
114  PPBnkCtx *ctx = s->priv_data;
116  PPBnkHeader hdr;
117 
118  if ((ret = avio_read(s->pb, buf, PP_BNK_FILE_HEADER_SIZE)) < 0)
119  return ret;
120  else if (ret != PP_BNK_FILE_HEADER_SIZE)
121  return AVERROR(EIO);
122 
123  pp_bnk_parse_header(&hdr, buf);
124 
125  if (hdr.track_count == 0 || hdr.track_count > INT_MAX)
126  return AVERROR_INVALIDDATA;
127 
128  if (hdr.sample_rate == 0 || hdr.sample_rate > INT_MAX)
129  return AVERROR_INVALIDDATA;
130 
131  if (hdr.always1 != 1) {
132  avpriv_request_sample(s, "Non-one header value");
133  return AVERROR_PATCHWELCOME;
134  }
135 
136  ctx->track_count = hdr.track_count;
137 
138  if (!(ctx->tracks = av_malloc_array(hdr.track_count, sizeof(PPBnkCtxTrack))))
139  return AVERROR(ENOMEM);
140 
141  /* Parse and validate each track. */
142  for (int i = 0; i < hdr.track_count; i++) {
143  PPBnkTrack e;
144  PPBnkCtxTrack *trk = ctx->tracks + i;
145 
146  ret = avio_read(s->pb, buf, PP_BNK_TRACK_SIZE);
147  if (ret < 0 && ret != AVERROR_EOF)
148  return ret;
149 
150  /* Short byte-count or EOF, we have a truncated file. */
151  if (ret != PP_BNK_TRACK_SIZE) {
152  av_log(s, AV_LOG_WARNING, "File truncated at %d/%u track(s)\n",
153  i, hdr.track_count);
154  ctx->track_count = i;
155  break;
156  }
157 
158  pp_bnk_parse_track(&e, buf);
159 
160  /* The individual sample rates of all tracks must match that of the file header. */
161  if (e.sample_rate != hdr.sample_rate)
162  return AVERROR_INVALIDDATA;
163 
164  if (e.always1_1 != 1 || e.always1_2 != 1) {
165  avpriv_request_sample(s, "Non-one track header values");
166  return AVERROR_PATCHWELCOME;
167  }
168 
169  trk->data_offset = avio_tell(s->pb);
170  trk->data_size = e.size;
171  trk->bytes_read = 0;
172 
173  /*
174  * Skip over the data to the next stream header.
175  * Sometimes avio_skip() doesn't detect EOF. If it doesn't, either:
176  * - the avio_read() above will, or
177  * - pp_bnk_read_packet() will read a truncated last track.
178  */
179  if ((ret = avio_skip(s->pb, e.size)) == AVERROR_EOF) {
180  ctx->track_count = i + 1;
182  "Track %d has truncated data, assuming track count == %d\n",
183  i, ctx->track_count);
184  break;
185  } else if (ret < 0) {
186  return ret;
187  }
188  }
189 
190  /* File is only a header. */
191  if (ctx->track_count == 0)
192  return AVERROR_INVALIDDATA;
193 
194  ctx->is_music = (hdr.flags & PP_BNK_FLAG_MUSIC) &&
195  (ctx->track_count == 2) &&
196  (ctx->tracks[0].data_size == ctx->tracks[1].data_size);
197 
198  /* Build the streams. */
199  for (int i = 0; i < (ctx->is_music ? 1 : ctx->track_count); i++) {
200  if (!(st = avformat_new_stream(s, NULL)))
201  return AVERROR(ENOMEM);
202 
203  par = st->codecpar;
206  par->format = AV_SAMPLE_FMT_S16P;
207 
208  av_channel_layout_default(&par->ch_layout, ctx->is_music + 1);
209  par->sample_rate = hdr.sample_rate;
210  par->bits_per_coded_sample = 4;
211  par->block_align = 1;
212  par->bit_rate = par->sample_rate * (int64_t)par->bits_per_coded_sample *
213  par->ch_layout.nb_channels;
214 
215  avpriv_set_pts_info(st, 64, 1, par->sample_rate);
216  st->start_time = 0;
217  st->duration = ctx->tracks[i].data_size * 2;
218  }
219 
220  return 0;
221 }
222 
224 {
225  PPBnkCtx *ctx = s->priv_data;
226 
227  /*
228  * Read a packet from each track, round-robin style.
229  * This method is nasty, but needed to avoid "Too many packets buffered" errors.
230  */
231  for (int i = 0; i < ctx->track_count; i++, ctx->current_track++)
232  {
233  int64_t ret;
234  int size;
235  PPBnkCtxTrack *trk;
236 
237  ctx->current_track %= ctx->track_count;
238 
239  trk = ctx->tracks + ctx->current_track;
240 
241  if (trk->bytes_read == trk->data_size)
242  continue;
243 
244  if ((ret = avio_seek(s->pb, trk->data_offset + trk->bytes_read, SEEK_SET)) < 0)
245  return ret;
246  else if (ret != trk->data_offset + trk->bytes_read)
247  return AVERROR(EIO);
248 
250 
251  if (!ctx->is_music) {
252  ret = av_get_packet(s->pb, pkt, size);
253  if (ret == AVERROR_EOF) {
254  /* If we've hit EOF, don't attempt this track again. */
255  trk->data_size = trk->bytes_read;
256  continue;
257  }
258  } else {
259  if (!pkt->data && (ret = av_new_packet(pkt, size * 2)) < 0)
260  return ret;
261  ret = avio_read(s->pb, pkt->data + size * ctx->current_track, size);
262  if (ret >= 0 && ret != size) {
263  /* Only return stereo packets if both tracks could be read. */
264  ret = AVERROR_EOF;
265  }
266  }
267  if (ret < 0)
268  return ret;
269 
270  trk->bytes_read += ret;
272  pkt->stream_index = ctx->current_track;
273  pkt->duration = ret * 2;
274 
275  if (ctx->is_music) {
276  if (pkt->stream_index == 0)
277  continue;
278 
279  pkt->stream_index = 0;
280  }
281 
282  ctx->current_track++;
283  return 0;
284  }
285 
286  /* If we reach here, we're done. */
287  return AVERROR_EOF;
288 }
289 
291 {
292  PPBnkCtx *ctx = s->priv_data;
293 
294  av_freep(&ctx->tracks);
295 
296  return 0;
297 }
298 
299 static int pp_bnk_seek(AVFormatContext *s, int stream_index,
300  int64_t pts, int flags)
301 {
302  PPBnkCtx *ctx = s->priv_data;
303 
304  if (pts != 0)
305  return AVERROR(EINVAL);
306 
307  if (ctx->is_music) {
308  av_assert0(stream_index == 0);
309  ctx->tracks[0].bytes_read = 0;
310  ctx->tracks[1].bytes_read = 0;
311  } else {
312  ctx->tracks[stream_index].bytes_read = 0;
313  }
314 
315  return 0;
316 }
317 
319  .name = "pp_bnk",
320  .long_name = NULL_IF_CONFIG_SMALL("Pro Pinball Series Soundbank"),
321  .priv_data_size = sizeof(PPBnkCtx),
322  .flags_internal = FF_FMT_INIT_CLEANUP,
328 };
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
FF_FMT_INIT_CLEANUP
#define FF_FMT_INIT_CLEANUP
For an AVInputFormat with this flag set read_close() needs to be called by the caller upon read_heade...
Definition: internal.h:48
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
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: options.c:237
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:57
PPBnkCtx::is_music
int is_music
Definition: pp_bnk.c:59
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:53
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:68
PPBnkTrack::always1_2
uint32_t always1_2
Definition: pp_bnk.c:46
pp_bnk_seek
static int pp_bnk_seek(AVFormatContext *s, int stream_index, int64_t pts, int flags)
Definition: pp_bnk.c:299
AV_CODEC_ID_ADPCM_IMA_CUNNING
@ AV_CODEC_ID_ADPCM_IMA_CUNNING
Definition: codec_id.h:407
AVPacket::data
uint8_t * data
Definition: packet.h:374
PP_BNK_FLAG_PERSIST
@ PP_BNK_FLAG_PERSIST
Definition: pp_bnk.c:63
PPBnkCtx::track_count
int track_count
Definition: pp_bnk.c:56
AVPacket::duration
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: packet.h:392
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
PPBnkHeader::track_count
uint32_t track_count
Definition: pp_bnk.c:37
PPBnkTrack
Definition: pp_bnk.c:41
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:300
sample_rate
sample_rate
Definition: ffmpeg_filter.c:155
AVPROBE_SCORE_MAX
#define AVPROBE_SCORE_MAX
maximum score
Definition: avformat.h:465
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:763
PPBnkCtxTrack
Definition: pp_bnk.c:49
PPBnkCtxTrack::data_size
uint32_t data_size
Definition: pp_bnk.c:51
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:505
pts
static int64_t pts
Definition: transcode_aac.c:654
AVStream::duration
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:998
PPBnkTrack::always1_1
uint32_t always1_1
Definition: pp_bnk.c:45
avassert.h
pkt
AVPacket * pkt
Definition: movenc.c:59
AVInputFormat
Definition: avformat.h:656
AV_PKT_FLAG_CORRUPT
#define AV_PKT_FLAG_CORRUPT
The packet content is corrupted.
Definition: packet.h:430
pp_bnk_probe
static int pp_bnk_probe(const AVProbeData *p)
Definition: pp_bnk.c:86
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:256
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: avpacket.c:97
PPBnkTrack::id
uint32_t id
Definition: pp_bnk.c:42
AVInputFormat::name
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:661
AVProbeData::buf
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:455
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
PPBnkHeader::always1
uint32_t always1
Definition: pp_bnk.c:36
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
ctx
AVFormatContext * ctx
Definition: movenc.c:48
PPBnkCtx::current_track
uint32_t current_track
Definition: pp_bnk.c:58
pp_bnk_read_close
static int pp_bnk_read_close(AVFormatContext *s)
Definition: pp_bnk.c:290
PPBnkHeader::bank_id
uint32_t bank_id
Definition: pp_bnk.c:34
PPBnkCtx::tracks
PPBnkCtxTrack * tracks
Definition: pp_bnk.c:57
PP_BNK_MAX_READ_SIZE
#define PP_BNK_MAX_READ_SIZE
Definition: pp_bnk.c:29
PPBnkTrack::size
uint32_t size
Definition: pp_bnk.c:43
AVFormatContext
Format I/O context.
Definition: avformat.h:1213
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1108
read_header
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:532
NULL
#define NULL
Definition: coverity.c:32
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
read_probe
static int read_probe(const AVProbeData *pd)
Definition: jvdec.c:55
AVProbeData
This structure contains the data a format has to probe a file.
Definition: avformat.h:453
PPBnkTrack::sample_rate
uint32_t sample_rate
Definition: pp_bnk.c:44
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:960
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:212
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:177
pp_bnk_parse_track
static void pp_bnk_parse_track(PPBnkTrack *trk, const uint8_t *buf)
Definition: pp_bnk.c:77
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:117
size
int size
Definition: twinvq_data.h:10344
PP_BNK_TRACK_SIZE
#define PP_BNK_TRACK_SIZE
Definition: pp_bnk.c:31
AVPacket::flags
int flags
A combination of AV_PKT_FLAG values.
Definition: packet.h:380
AV_SAMPLE_FMT_S16P
@ AV_SAMPLE_FMT_S16P
signed 16 bits, planar
Definition: samplefmt.h:64
PPBnkHeader
Definition: pp_bnk.c:33
PPBnkCtx
Definition: pp_bnk.c:55
PPBnkCtxTrack::bytes_read
uint32_t bytes_read
Definition: pp_bnk.c:52
pp_bnk_read_header
static int pp_bnk_read_header(AVFormatContext *s)
Definition: pp_bnk.c:109
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
ff_pp_bnk_demuxer
const AVInputFormat ff_pp_bnk_demuxer
Definition: pp_bnk.c:318
internal.h
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:184
av_malloc_array
#define av_malloc_array(a, b)
Definition: tableprint_vlc.h:31
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
PPBnkHeader::sample_rate
uint32_t sample_rate
Definition: pp_bnk.c:35
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:102
ret
ret
Definition: filter_design.txt:187
read_packet
static int read_packet(void *opaque, uint8_t *buf, int buf_size)
Definition: avio_reading.c:42
AVStream
Stream structure.
Definition: avformat.h:948
PPBnkCtxTrack::data_offset
int64_t data_offset
Definition: pp_bnk.c:50
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:260
PP_BNK_FILE_HEADER_SIZE
#define PP_BNK_FILE_HEADER_SIZE
Definition: pp_bnk.c:30
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:38
PP_BNK_FLAG_MUSIC
@ PP_BNK_FLAG_MUSIC
Definition: pp_bnk.c:64
avio_read
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:641
pp_bnk_read_packet
static int pp_bnk_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: pp_bnk.c:223
AVPacket::stream_index
int stream_index
Definition: packet.h:376
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:347
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:103
avpriv_request_sample
#define avpriv_request_sample(...)
Definition: tableprint_vlc.h:36
AVCodecParameters::format
int format
Definition: codec_par.h:85
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:61
AVPacket
This structure stores compressed data.
Definition: packet.h:351
PP_BNK_FLAG_MASK
@ PP_BNK_FLAG_MASK
Definition: pp_bnk.c:65
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:90
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:988