]> git.sesse.net Git - ffmpeg/blob - libavformat/pp_bnk.c
doc/examples/transcode_aac: use av_packet_alloc() to allocate packets
[ffmpeg] / libavformat / pp_bnk.c
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"
26 #include "libavutil/internal.h"
27
28 #define PP_BNK_MAX_READ_SIZE    4096
29 #define PP_BNK_FILE_HEADER_SIZE 20
30 #define PP_BNK_TRACK_SIZE       20
31
32 typedef struct PPBnkHeader {
33     uint32_t        bank_id;        /*< Bank ID, useless for our purposes. */
34     uint32_t        sample_rate;    /*< Sample rate of the contained tracks. */
35     uint32_t        always1;        /*< Unknown, always seems to be 1. */
36     uint32_t        track_count;    /*< Number of tracks in the file. */
37     uint32_t        flags;          /*< Flags. */
38 } PPBnkHeader;
39
40 typedef struct PPBnkTrack {
41     uint32_t        id;             /*< Track ID. Usually track[i].id == track[i-1].id + 1, but not always */
42     uint32_t        size;           /*< Size of the data in bytes. */
43     uint32_t        sample_rate;    /*< Sample rate. */
44     uint32_t        always1_1;      /*< Unknown, always seems to be 1. */
45     uint32_t        always1_2;      /*< Unknown, always seems to be 1. */
46 } PPBnkTrack;
47
48 typedef struct PPBnkCtxTrack {
49     int64_t         data_offset;
50     uint32_t        data_size;
51     uint32_t        bytes_read;
52 } PPBnkCtxTrack;
53
54 typedef struct PPBnkCtx {
55     int             track_count;
56     PPBnkCtxTrack   *tracks;
57     uint32_t        current_track;
58 } PPBnkCtx;
59
60 enum {
61     PP_BNK_FLAG_PERSIST = (1 << 0), /*< This is a large file, keep in memory. */
62     PP_BNK_FLAG_MUSIC   = (1 << 1), /*< This is music. */
63     PP_BNK_FLAG_MASK    = (PP_BNK_FLAG_PERSIST | PP_BNK_FLAG_MUSIC)
64 };
65
66 static void pp_bnk_parse_header(PPBnkHeader *hdr, const uint8_t *buf)
67 {
68     hdr->bank_id        = AV_RL32(buf +  0);
69     hdr->sample_rate    = AV_RL32(buf +  4);
70     hdr->always1        = AV_RL32(buf +  8);
71     hdr->track_count    = AV_RL32(buf + 12);
72     hdr->flags          = AV_RL32(buf + 16);
73 }
74
75 static void pp_bnk_parse_track(PPBnkTrack *trk, const uint8_t *buf)
76 {
77     trk->id             = AV_RL32(buf +  0);
78     trk->size           = AV_RL32(buf +  4);
79     trk->sample_rate    = AV_RL32(buf +  8);
80     trk->always1_1      = AV_RL32(buf + 12);
81     trk->always1_2      = AV_RL32(buf + 16);
82 }
83
84 static int pp_bnk_probe(const AVProbeData *p)
85 {
86     uint32_t sample_rate = AV_RL32(p->buf +  4);
87     uint32_t track_count = AV_RL32(p->buf + 12);
88     uint32_t flags       = AV_RL32(p->buf + 16);
89
90     if (track_count == 0 || track_count > INT_MAX)
91         return 0;
92
93     if ((sample_rate !=  5512) && (sample_rate != 11025) &&
94         (sample_rate != 22050) && (sample_rate != 44100))
95         return 0;
96
97     /* Check the first track header. */
98     if (AV_RL32(p->buf + 28) != sample_rate)
99         return 0;
100
101     if ((flags & ~PP_BNK_FLAG_MASK) != 0)
102         return 0;
103
104     return AVPROBE_SCORE_MAX / 4 + 1;
105 }
106
107 static int pp_bnk_read_header(AVFormatContext *s)
108 {
109     int64_t ret;
110     AVStream *st;
111     AVCodecParameters *par;
112     PPBnkCtx *ctx = s->priv_data;
113     uint8_t buf[FFMAX(PP_BNK_FILE_HEADER_SIZE, PP_BNK_TRACK_SIZE)];
114     PPBnkHeader hdr;
115
116     if ((ret = avio_read(s->pb, buf, PP_BNK_FILE_HEADER_SIZE)) < 0)
117         return ret;
118     else if (ret != PP_BNK_FILE_HEADER_SIZE)
119         return AVERROR(EIO);
120
121     pp_bnk_parse_header(&hdr, buf);
122
123     if (hdr.track_count == 0 || hdr.track_count > INT_MAX)
124         return AVERROR_INVALIDDATA;
125
126     if (hdr.sample_rate == 0 || hdr.sample_rate > INT_MAX)
127         return AVERROR_INVALIDDATA;
128
129     if (hdr.always1 != 1) {
130         avpriv_request_sample(s, "Non-one header value");
131         return AVERROR_PATCHWELCOME;
132     }
133
134     ctx->track_count = hdr.track_count;
135
136     if (!(ctx->tracks = av_malloc_array(hdr.track_count, sizeof(PPBnkCtxTrack))))
137         return AVERROR(ENOMEM);
138
139     /* Parse and validate each track. */
140     for (int i = 0; i < hdr.track_count; i++) {
141         PPBnkTrack e;
142         PPBnkCtxTrack *trk = ctx->tracks + i;
143
144         ret = avio_read(s->pb, buf, PP_BNK_TRACK_SIZE);
145         if (ret < 0 && ret != AVERROR_EOF)
146             goto fail;
147
148         /* Short byte-count or EOF, we have a truncated file. */
149         if (ret != PP_BNK_TRACK_SIZE) {
150             av_log(s, AV_LOG_WARNING, "File truncated at %d/%u track(s)\n",
151                    i, hdr.track_count);
152             ctx->track_count = i;
153             break;
154         }
155
156         pp_bnk_parse_track(&e, buf);
157
158         /* The individual sample rates of all tracks must match that of the file header. */
159         if (e.sample_rate != hdr.sample_rate) {
160             ret = AVERROR_INVALIDDATA;
161             goto fail;
162         }
163
164         if (e.always1_1 != 1 || e.always1_2 != 1) {
165             avpriv_request_sample(s, "Non-one track header values");
166             ret = AVERROR_PATCHWELCOME;
167             goto fail;
168         }
169
170         trk->data_offset = avio_tell(s->pb);
171         trk->data_size   = e.size;
172         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         if ((ret = avio_skip(s->pb, e.size)) == AVERROR_EOF) {
181             ctx->track_count = i + 1;
182             av_log(s, AV_LOG_WARNING,
183                    "Track %d has truncated data, assuming track count == %d\n",
184                    i, ctx->track_count);
185             break;
186         } else if (ret < 0) {
187             goto fail;
188         }
189     }
190
191     /* File is only a header. */
192     if (ctx->track_count == 0) {
193         ret = AVERROR_INVALIDDATA;
194         goto fail;
195     }
196
197     /* Build the streams. */
198     for (int i = 0; i < ctx->track_count; i++) {
199         if (!(st = avformat_new_stream(s, NULL))) {
200             ret = AVERROR(ENOMEM);
201             goto fail;
202         }
203
204         par                         = st->codecpar;
205         par->codec_type             = AVMEDIA_TYPE_AUDIO;
206         par->codec_id               = AV_CODEC_ID_ADPCM_IMA_CUNNING;
207         par->format                 = AV_SAMPLE_FMT_S16;
208         par->channel_layout         = AV_CH_LAYOUT_MONO;
209         par->channels               = 1;
210         par->sample_rate            = hdr.sample_rate;
211         par->bits_per_coded_sample  = 4;
212         par->bits_per_raw_sample    = 16;
213         par->block_align            = 1;
214         par->bit_rate               = par->sample_rate * par->bits_per_coded_sample;
215
216         avpriv_set_pts_info(st, 64, 1, par->sample_rate);
217         st->start_time              = 0;
218         st->duration                = ctx->tracks[i].data_size * 2;
219     }
220
221     return 0;
222
223 fail:
224     av_freep(&ctx->tracks);
225     return ret;
226 }
227
228 static int pp_bnk_read_packet(AVFormatContext *s, AVPacket *pkt)
229 {
230     PPBnkCtx *ctx = s->priv_data;
231
232     /*
233      * Read a packet from each track, round-robin style.
234      * This method is nasty, but needed to avoid "Too many packets buffered" errors.
235      */
236     for (int i = 0; i < ctx->track_count; i++, ctx->current_track++)
237     {
238         int64_t ret;
239         int size;
240         PPBnkCtxTrack *trk;
241
242         ctx->current_track %= ctx->track_count;
243
244         trk = ctx->tracks + ctx->current_track;
245
246         if (trk->bytes_read == trk->data_size)
247             continue;
248
249         if ((ret = avio_seek(s->pb, trk->data_offset + trk->bytes_read, SEEK_SET)) < 0)
250             return ret;
251         else if (ret != trk->data_offset + trk->bytes_read)
252             return AVERROR(EIO);
253
254         size = FFMIN(trk->data_size - trk->bytes_read, PP_BNK_MAX_READ_SIZE);
255
256         if ((ret = av_get_packet(s->pb, pkt, size)) == AVERROR_EOF) {
257             /* If we've hit EOF, don't attempt this track again. */
258             trk->data_size = trk->bytes_read;
259             continue;
260         } else if (ret < 0) {
261             return ret;
262         }
263
264         trk->bytes_read    += ret;
265         pkt->flags         &= ~AV_PKT_FLAG_CORRUPT;
266         pkt->stream_index   = ctx->current_track++;
267         pkt->duration       = ret * 2;
268         return 0;
269     }
270
271     /* If we reach here, we're done. */
272     return AVERROR_EOF;
273 }
274
275 static int pp_bnk_read_close(AVFormatContext *s)
276 {
277     PPBnkCtx *ctx = s->priv_data;
278
279     av_freep(&ctx->tracks);
280
281     return 0;
282 }
283
284 AVInputFormat ff_pp_bnk_demuxer = {
285     .name           = "pp_bnk",
286     .long_name      = NULL_IF_CONFIG_SMALL("Pro Pinball Series Soundbank"),
287     .priv_data_size = sizeof(PPBnkCtx),
288     .read_probe     = pp_bnk_probe,
289     .read_header    = pp_bnk_read_header,
290     .read_packet    = pp_bnk_read_packet,
291     .read_close     = pp_bnk_read_close
292 };