2 * Argonaut Games BRP Demuxer
4 * Copyright (C) 2020 Zane van Iperen (zane@zanevaniperen.com)
6 * This file is part of FFmpeg.
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.
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.
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
25 #include "libavutil/intreadwrite.h"
26 #include "libavutil/avassert.h"
27 #include "libavutil/internal.h"
30 #define BRP_TAG MKTAG('B', 'R', 'P', 'P')
31 #define BRP_FILE_HEADER_SIZE 12
32 #define BRP_BLOCK_HEADER_SIZE 12
33 #define BRP_STREAM_HEADER_SIZE 20
34 #define BRP_MAX_STREAMS 32 /* Soft cap, but even this is overkill. */
35 #define BVID_HEADER_SIZE 16
36 #define BRP_MIN_BUFFER_SIZE FFMAX(FFMAX3(BRP_FILE_HEADER_SIZE, \
37 BRP_BLOCK_HEADER_SIZE, \
38 BRP_STREAM_HEADER_SIZE), \
41 #define BRP_CODEC_ID_BVID MKTAG('B', 'V', 'I', 'D')
42 #define BRP_CODEC_ID_BASF MKTAG('B', 'A', 'S', 'F')
44 typedef struct ArgoBRPFileHeader {
50 typedef struct ArgoBRPBlockHeader {
56 typedef struct ArgoBVIDHeader {
63 typedef struct ArgoBRPStreamHeader {
68 uint32_t extradata_size;
71 /* If codec_id == BRP_CODEC_ID_BVID */
73 /* If codec_id == BRP_CODEC_ID_BASF */
74 ArgoASFFileHeader basf;
76 } ArgoBRPStreamHeader;
78 typedef struct ArgoBRPDemuxContext {
79 ArgoBRPFileHeader fhdr;
80 ArgoBRPStreamHeader streams[BRP_MAX_STREAMS];
81 /* To know how much of a BASF to give. */
85 /* BASF-specific fields. */
88 ArgoASFChunkHeader ckhdr;
91 /* ms, not samples. */
94 } ArgoBRPDemuxContext;
96 static int argo_brp_probe(const AVProbeData *p)
98 if (AV_RL32(p->buf) != BRP_TAG)
101 return AVPROBE_SCORE_EXTENSION + 1;
104 static int read_extradata(AVFormatContext *s, const ArgoBRPStreamHeader *hdr,
105 void *buf, size_t bufsz)
111 if (hdr->codec_id == BRP_CODEC_ID_BVID) {
113 size = BVID_HEADER_SIZE;
114 } else if (hdr->codec_id == BRP_CODEC_ID_BASF) {
116 size = ASF_FILE_HEADER_SIZE;
118 avpriv_request_sample(s, "BRP codec id 0x%x", hdr->codec_id);
120 if ((ret = avio_skip(s->pb, hdr->extradata_size)) < 0)
126 if (hdr->extradata_size != size) {
127 av_log(s, AV_LOG_ERROR, "Invalid %s extradata size %u, expected %u\n",
128 name, hdr->extradata_size, size);
129 return AVERROR_INVALIDDATA;
132 av_assert0(bufsz >= size);
134 if ((ret = avio_read(s->pb, buf, size)) < 0)
143 static int argo_brp_read_header(AVFormatContext *s)
146 AVIOContext *pb = s->pb;
147 ArgoBRPDemuxContext *brp = s->priv_data;
148 uint8_t buf[FFMAX(BRP_MIN_BUFFER_SIZE, ASF_MIN_BUFFER_SIZE)];
150 if ((ret = avio_read(pb, buf, BRP_FILE_HEADER_SIZE)) < 0)
152 else if (ret != BRP_FILE_HEADER_SIZE)
155 brp->fhdr.magic = AV_RL32(buf + 0);
156 brp->fhdr.num_streams = AV_RL32(buf + 4);
157 brp->fhdr.byte_rate = AV_RL32(buf + 8);
159 if (brp->fhdr.magic != BRP_TAG)
160 return AVERROR_INVALIDDATA;
162 if (brp->fhdr.num_streams > BRP_MAX_STREAMS) {
163 avpriv_request_sample(s, ">%d streams", BRP_MAX_STREAMS);
164 return AVERROR_PATCHWELCOME;
167 /* Build the stream info. */
168 brp->basf.index = -1;
169 for (uint32_t i = 0; i < brp->fhdr.num_streams; i++) {
170 ArgoBRPStreamHeader *hdr = brp->streams + i;
173 if (!(st = avformat_new_stream(s, NULL)))
174 return AVERROR(ENOMEM);
176 if ((ret = avio_read(pb, buf, BRP_STREAM_HEADER_SIZE)) < 0)
178 else if (ret != BRP_STREAM_HEADER_SIZE)
181 hdr->codec_id = AV_RL32(buf + 0);
182 hdr->id = AV_RL32(buf + 4);
183 hdr->duration_ms = AV_RL32(buf + 8);
184 hdr->byte_rate = AV_RL32(buf + 12);
185 hdr->extradata_size = AV_RL32(buf + 16);
187 /* This should always be the case. */
189 return AVERROR_INVALIDDATA;
191 /* Timestamps are in milliseconds. */
192 avpriv_set_pts_info(st, 64, 1, 1000);
193 st->duration = hdr->duration_ms;
194 st->codecpar->bit_rate = hdr->byte_rate * 8;
196 if ((ret = read_extradata(s, hdr, buf, sizeof(buf))) < 0) {
198 } else if (ret > 0) {
199 st->codecpar->codec_type = AVMEDIA_TYPE_UNKNOWN;
203 if (hdr->codec_id == BRP_CODEC_ID_BVID) {
204 ArgoBVIDHeader *bvid = &hdr->extradata.bvid;
206 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
208 /* No decoder for this yet. */
209 st->codecpar->codec_id = AV_CODEC_ID_NONE;
211 bvid->num_frames = AV_RL32(buf + 0);
212 bvid->width = AV_RL32(buf + 4);
213 bvid->height = AV_RL32(buf + 8);
214 bvid->depth = AV_RL32(buf + 12);
216 /* These are from 1990's games, sanity check this. */
217 if (bvid->width >= 65536 || bvid->height >= 65536 ||
218 bvid->depth > 24 || bvid->depth % 8 != 0) {
219 return AVERROR_INVALIDDATA;
222 st->codecpar->width = bvid->width;
223 st->codecpar->height = bvid->height;
225 if (bvid->depth == 8) {
226 st->codecpar->format = AV_PIX_FMT_PAL8;
227 } else if (bvid->depth == 24) {
228 st->codecpar->format = AV_PIX_FMT_RGB24;
230 avpriv_request_sample(s, "depth == %u", bvid->depth);
231 return AVERROR_PATCHWELCOME;
233 } else if (hdr->codec_id == BRP_CODEC_ID_BASF) {
235 * It would make the demuxer significantly more complicated
236 * to support multiple BASF streams. I've never seen a file
237 * with more than one.
239 if (brp->basf.index >= 0) {
240 avpriv_request_sample(s, "Multiple BASF streams");
241 return AVERROR_PATCHWELCOME;
244 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
245 st->codecpar->codec_id = AV_CODEC_ID_ADPCM_ARGO;
247 ff_argo_asf_parse_file_header(&hdr->extradata.basf, buf);
249 if ((ret = ff_argo_asf_validate_file_header(s, &hdr->extradata.basf)) < 0)
253 av_assert0(0); /* Caught above, should never happen. */
258 * This is nasty. BASF streams only have one (huge) block.
259 * It should be the first one. It contains the chunk header, so
260 * it needs to be read here.
262 if (brp->basf.index >= 0) {
263 AVStream *st = s->streams[brp->basf.index];
264 ArgoBRPStreamHeader *hdr = brp->streams + brp->basf.index;
265 ArgoBRPBlockHeader blk;
267 av_assert0(st->codecpar->codec_id == AV_CODEC_ID_ADPCM_ARGO);
268 av_assert0(brp->streams[brp->basf.index].extradata_size == ASF_FILE_HEADER_SIZE);
270 if ((ret = avio_read(pb, buf, BRP_BLOCK_HEADER_SIZE)) < 0)
272 else if (ret != BRP_BLOCK_HEADER_SIZE)
275 blk.stream_id = AV_RL32(buf + 0);
276 blk.start_ms = AV_RL32(buf + 4);
277 blk.size = AV_RL32(buf + 8);
279 if (blk.stream_id != brp->basf.index) {
280 avpriv_request_sample(st, "first block not BASF");
281 return AVERROR_PATCHWELCOME;
284 if (blk.size < ASF_CHUNK_HEADER_SIZE)
285 return AVERROR_INVALIDDATA;
287 if ((ret = avio_read(pb, buf, ASF_CHUNK_HEADER_SIZE)) < 0)
289 else if (ret != ASF_CHUNK_HEADER_SIZE)
292 ff_argo_asf_parse_chunk_header(&brp->basf.ckhdr, buf);
294 if ((ret = ff_argo_asf_fill_stream(st, &hdr->extradata.basf, &brp->basf.ckhdr)) < 0)
297 /* Convert ms to samples. */
298 st->start_time = (blk.start_ms * st->codecpar->sample_rate) / 1000;
300 if ((ret = avio_tell(s->pb)) < 0)
303 brp->basf.offset = ret;
305 if ((ret = avio_skip(s->pb, blk.size - ASF_CHUNK_HEADER_SIZE)) < 0)
311 static int argo_brp_read_basf(AVFormatContext *s, AVPacket *pkt,
312 ArgoBRPDemuxContext *brp, int ignorepts)
314 ArgoASFChunkHeader *ckhdr = &brp->basf.ckhdr;
315 AVCodecParameters *par;
318 if (brp->basf.index < 0)
321 par = s->streams[brp->basf.index]->codecpar;
323 if (brp->basf.blocks_read >= ckhdr->num_blocks)
326 if (!ignorepts && brp->lastpts < brp->basf.lastpts)
329 if ((ret = avio_tell(s->pb)) < 0)
334 if ((ret = avio_seek(s->pb, brp->basf.offset, SEEK_SET)) < 0)
336 else if (ret != brp->basf.offset)
339 if ((ret = av_get_packet(s->pb, pkt, par->block_align)) < 0)
342 if ((ret = avio_seek(s->pb, old, SEEK_SET)) < 0)
347 pkt->stream_index = brp->basf.index;
348 pkt->duration = ckhdr->num_samples;
350 brp->basf.offset += pkt->size;
351 brp->basf.blocks_read += 1;
352 /* Need the ceil() because ((32 * 1000) / 44100) < 1 */
353 brp->basf.lastpts += ceilf((ckhdr->num_samples * 1000.0f) / ckhdr->sample_rate);
357 static int argo_brp_read_packet(AVFormatContext *s, AVPacket *pkt)
359 ArgoBRPDemuxContext *brp = s->priv_data;
360 ArgoBRPBlockHeader blk;
361 AVIOContext *pb = s->pb;
362 uint8_t buf[BRP_BLOCK_HEADER_SIZE];
366 * Special-case: send some more BASF content if we're running behind.
367 * Grr, why couldn't they just interleave it.
369 if ((ret = argo_brp_read_basf(s, pkt, brp, brp->hit_eof)) < 0)
377 if ((ret = avio_read(pb, buf, BRP_BLOCK_HEADER_SIZE)) < 0)
379 else if (ret != BRP_BLOCK_HEADER_SIZE)
382 blk.stream_id = AV_RL32(buf + 0);
383 blk.start_ms = AV_RL32(buf + 4);
384 blk.size = AV_RL32(buf + 8);
386 /* This is meant to be EOF, but there might be more BASF packets. */
387 if (blk.stream_id == -1) {
389 /* This is nasty, but safe. */
390 return argo_brp_read_packet(s, pkt);
393 if (blk.stream_id < -1 || blk.stream_id >= s->nb_streams)
394 return AVERROR_INVALIDDATA;
396 /* Skip BASF blocks. */
397 if (blk.stream_id == brp->basf.index) {
398 if ((ret = avio_skip(s->pb, blk.size)) < 0)
401 if ((ret = av_get_packet(s->pb, pkt, blk.size)) < 0)
403 else if (ret != blk.size)
404 return AVERROR_INVALIDDATA;
407 pkt->stream_index = blk.stream_id;
408 pkt->pts = blk.start_ms;
409 brp->lastpts = FFMAX(brp->lastpts, blk.start_ms);
413 AVInputFormat ff_argo_brp_demuxer = {
415 .long_name = NULL_IF_CONFIG_SMALL("Argonaut Games BRP"),
416 .priv_data_size = sizeof(ArgoBRPDemuxContext),
417 .read_probe = argo_brp_probe,
418 .read_header = argo_brp_read_header,
419 .read_packet = argo_brp_read_packet,