2 * Argonaut Games ASF (de)muxer
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
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/avassert.h"
26 #include "libavutil/opt.h"
29 /* Maximum number of blocks to read at once. */
30 #define ASF_NB_BLOCKS 32
32 typedef struct ArgoASFDemuxContext {
33 ArgoASFFileHeader fhdr;
34 ArgoASFChunkHeader ckhdr;
36 } ArgoASFDemuxContext;
38 typedef struct ArgoASFMuxContext {
46 void ff_argo_asf_parse_file_header(ArgoASFFileHeader *hdr, const uint8_t *buf)
48 hdr->magic = AV_RL32(buf + 0);
49 hdr->version_major = AV_RL16(buf + 4);
50 hdr->version_minor = AV_RL16(buf + 6);
51 hdr->num_chunks = AV_RL32(buf + 8);
52 hdr->chunk_offset = AV_RL32(buf + 12);
53 for (int i = 0; i < FF_ARRAY_ELEMS(hdr->name); i++)
54 hdr->name[i] = AV_RL8(buf + 16 + i);
57 int ff_argo_asf_validate_file_header(AVFormatContext *s, const ArgoASFFileHeader *hdr)
59 if (hdr->magic != ASF_TAG || hdr->num_chunks == 0)
60 return AVERROR_INVALIDDATA;
62 if (hdr->chunk_offset < ASF_FILE_HEADER_SIZE)
63 return AVERROR_INVALIDDATA;
68 void ff_argo_asf_parse_chunk_header(ArgoASFChunkHeader *hdr, const uint8_t *buf)
70 hdr->num_blocks = AV_RL32(buf + 0);
71 hdr->num_samples = AV_RL32(buf + 4);
72 hdr->unk1 = AV_RL32(buf + 8);
73 hdr->sample_rate = AV_RL16(buf + 12);
74 hdr->unk2 = AV_RL16(buf + 14);
75 hdr->flags = AV_RL32(buf + 16);
78 int ff_argo_asf_fill_stream(AVFormatContext *s, AVStream *st, const ArgoASFFileHeader *fhdr,
79 const ArgoASFChunkHeader *ckhdr)
81 if (ckhdr->num_samples != ASF_SAMPLE_COUNT) {
82 av_log(s, AV_LOG_ERROR, "Invalid sample count. Got %u, expected %d\n",
83 ckhdr->num_samples, ASF_SAMPLE_COUNT);
84 return AVERROR_INVALIDDATA;
87 if ((ckhdr->flags & ASF_CF_ALWAYS1) != ASF_CF_ALWAYS1 || (ckhdr->flags & ASF_CF_ALWAYS0) != 0) {
88 avpriv_request_sample(s, "Nonstandard flags (0x%08X)", ckhdr->flags);
89 return AVERROR_PATCHWELCOME;
92 st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
93 st->codecpar->codec_id = AV_CODEC_ID_ADPCM_ARGO;
94 st->codecpar->format = AV_SAMPLE_FMT_S16P;
96 if (ckhdr->flags & ASF_CF_STEREO) {
97 st->codecpar->channel_layout = AV_CH_LAYOUT_STEREO;
98 st->codecpar->channels = 2;
100 st->codecpar->channel_layout = AV_CH_LAYOUT_MONO;
101 st->codecpar->channels = 1;
104 /* v1.1 files (FX Fighter) are all marked as 44100, but are actually 22050. */
105 if (fhdr->version_major == 1 && fhdr->version_minor == 1)
106 st->codecpar->sample_rate = 22050;
108 st->codecpar->sample_rate = ckhdr->sample_rate;
110 st->codecpar->bits_per_coded_sample = 4;
112 if (ckhdr->flags & ASF_CF_BITS_PER_SAMPLE)
113 st->codecpar->bits_per_raw_sample = 16;
115 st->codecpar->bits_per_raw_sample = 8;
117 if (st->codecpar->bits_per_raw_sample != 16) {
118 /* The header allows for these, but I've never seen any files with them. */
119 avpriv_request_sample(s, "Non 16-bit samples");
120 return AVERROR_PATCHWELCOME;
124 * (nchannel control bytes) + ((bytes_per_channel) * nchannel)
125 * For mono, this is 17. For stereo, this is 34.
127 st->codecpar->block_align = st->codecpar->channels +
128 (ckhdr->num_samples / 2) *
129 st->codecpar->channels;
131 st->codecpar->bit_rate = st->codecpar->channels *
132 st->codecpar->sample_rate *
133 st->codecpar->bits_per_coded_sample;
135 avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
138 if (fhdr->num_chunks == 1) {
139 st->duration = ckhdr->num_blocks * ckhdr->num_samples;
140 st->nb_frames = ckhdr->num_blocks;
146 #if CONFIG_ARGO_ASF_DEMUXER
149 * 1.1: https://samples.ffmpeg.org/game-formats/brender/part2.zip
151 * 1.2: Croc! Legend of the Gobbos
153 * The Emperor's New Groove
154 * Disney's Aladdin in Nasira's Revenge
156 static int argo_asf_is_known_version(const ArgoASFFileHeader *hdr)
158 return (hdr->version_major == 1 && hdr->version_minor == 1) ||
159 (hdr->version_major == 1 && hdr->version_minor == 2) ||
160 (hdr->version_major == 2 && hdr->version_minor == 1);
163 static int argo_asf_probe(const AVProbeData *p)
165 ArgoASFFileHeader hdr;
167 av_assert0(AVPROBE_PADDING_SIZE >= ASF_FILE_HEADER_SIZE);
169 ff_argo_asf_parse_file_header(&hdr, p->buf);
171 if (hdr.magic != ASF_TAG)
174 if (!argo_asf_is_known_version(&hdr))
175 return AVPROBE_SCORE_EXTENSION / 2;
177 return AVPROBE_SCORE_EXTENSION + 1;
180 static int argo_asf_read_header(AVFormatContext *s)
183 AVIOContext *pb = s->pb;
185 ArgoASFDemuxContext *asf = s->priv_data;
186 uint8_t buf[ASF_MIN_BUFFER_SIZE];
188 if (!(st = avformat_new_stream(s, NULL)))
189 return AVERROR(ENOMEM);
191 if ((ret = avio_read(pb, buf, ASF_FILE_HEADER_SIZE)) < 0)
193 else if (ret != ASF_FILE_HEADER_SIZE)
196 ff_argo_asf_parse_file_header(&asf->fhdr, buf);
198 if ((ret = ff_argo_asf_validate_file_header(s, &asf->fhdr)) < 0)
201 /* This should only be 1 in ASF files. >1 is fine if in BRP. */
202 if (asf->fhdr.num_chunks != 1)
203 return AVERROR_INVALIDDATA;
205 if ((ret = avio_skip(pb, asf->fhdr.chunk_offset - ASF_FILE_HEADER_SIZE)) < 0)
208 if ((ret = avio_read(pb, buf, ASF_CHUNK_HEADER_SIZE)) < 0)
210 else if (ret != ASF_CHUNK_HEADER_SIZE)
213 ff_argo_asf_parse_chunk_header(&asf->ckhdr, buf);
215 return ff_argo_asf_fill_stream(s, st, &asf->fhdr, &asf->ckhdr);
218 static int argo_asf_read_packet(AVFormatContext *s, AVPacket *pkt)
220 ArgoASFDemuxContext *asf = s->priv_data;
222 AVStream *st = s->streams[0];
223 AVIOContext *pb = s->pb;
226 if (asf->blocks_read >= asf->ckhdr.num_blocks)
229 ret = av_get_packet(pb, pkt, st->codecpar->block_align *
230 FFMIN(ASF_NB_BLOCKS, asf->ckhdr.num_blocks - asf->blocks_read));
234 /* Something real screwy is going on. */
235 if (ret % st->codecpar->block_align != 0)
236 return AVERROR_INVALIDDATA;
239 pkt->stream_index = st->index;
240 pkt->duration = asf->ckhdr.num_samples * (ret / st->codecpar->block_align);
241 pkt->pts = asf->blocks_read * asf->ckhdr.num_samples;
242 asf->blocks_read += (ret / st->codecpar->block_align);
244 pkt->flags &= ~AV_PKT_FLAG_CORRUPT;
248 static int argo_asf_seek(AVFormatContext *s, int stream_index,
249 int64_t pts, int flags)
251 ArgoASFDemuxContext *asf = s->priv_data;
252 AVStream *st = s->streams[stream_index];
254 uint32_t block = pts / asf->ckhdr.num_samples;
256 if (block >= asf->ckhdr.num_blocks)
259 offset = asf->fhdr.chunk_offset + ASF_CHUNK_HEADER_SIZE +
260 (block * st->codecpar->block_align);
262 if ((offset = avio_seek(s->pb, offset, SEEK_SET)) < 0)
265 asf->blocks_read = block;
270 * Not actually sure what ASF stands for.
271 * - Argonaut Sound File?
272 * - Audio Stream File?
274 AVInputFormat ff_argo_asf_demuxer = {
276 .long_name = NULL_IF_CONFIG_SMALL("Argonaut Games ASF"),
277 .priv_data_size = sizeof(ArgoASFDemuxContext),
278 .read_probe = argo_asf_probe,
279 .read_header = argo_asf_read_header,
280 .read_packet = argo_asf_read_packet,
281 .read_seek = argo_asf_seek,
285 #if CONFIG_ARGO_ASF_MUXER
286 static int argo_asf_write_init(AVFormatContext *s)
288 ArgoASFMuxContext *ctx = s->priv_data;
289 const AVCodecParameters *par;
291 if (s->nb_streams != 1) {
292 av_log(s, AV_LOG_ERROR, "ASF files have exactly one stream\n");
293 return AVERROR(EINVAL);
296 par = s->streams[0]->codecpar;
298 if (par->codec_id != AV_CODEC_ID_ADPCM_ARGO) {
299 av_log(s, AV_LOG_ERROR, "%s codec not supported\n",
300 avcodec_get_name(par->codec_id));
301 return AVERROR(EINVAL);
304 if (ctx->version_major == 1 && ctx->version_minor == 1 && par->sample_rate != 22050) {
305 av_log(s, AV_LOG_ERROR, "ASF v1.1 files only support a sample rate of 22050\n");
306 return AVERROR(EINVAL);
309 if (par->channels > 2) {
310 av_log(s, AV_LOG_ERROR, "ASF files only support up to 2 channels\n");
311 return AVERROR(EINVAL);
314 if (par->block_align != 17 * par->channels)
315 return AVERROR(EINVAL);
317 if (par->sample_rate > UINT16_MAX) {
318 av_log(s, AV_LOG_ERROR, "Sample rate too large\n");
319 return AVERROR(EINVAL);
322 if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL)) {
323 av_log(s, AV_LOG_ERROR, "Stream not seekable, unable to write output file\n");
324 return AVERROR(EINVAL);
330 static void argo_asf_write_file_header(const ArgoASFFileHeader *fhdr, AVIOContext *pb)
332 avio_wl32( pb, fhdr->magic);
333 avio_wl16( pb, fhdr->version_major);
334 avio_wl16( pb, fhdr->version_minor);
335 avio_wl32( pb, fhdr->num_chunks);
336 avio_wl32( pb, fhdr->chunk_offset);
337 avio_write(pb, fhdr->name, sizeof(fhdr->name));
340 static void argo_asf_write_chunk_header(const ArgoASFChunkHeader *ckhdr, AVIOContext *pb)
342 avio_wl32(pb, ckhdr->num_blocks);
343 avio_wl32(pb, ckhdr->num_samples);
344 avio_wl32(pb, ckhdr->unk1);
345 avio_wl16(pb, ckhdr->sample_rate);
346 avio_wl16(pb, ckhdr->unk2);
347 avio_wl32(pb, ckhdr->flags);
350 static int argo_asf_write_header(AVFormatContext *s)
352 const AVCodecParameters *par = s->streams[0]->codecpar;
353 ArgoASFMuxContext *ctx = s->priv_data;
354 ArgoASFChunkHeader chdr;
355 ArgoASFFileHeader fhdr = {
357 .version_major = (uint16_t)ctx->version_major,
358 .version_minor = (uint16_t)ctx->version_minor,
360 .chunk_offset = ASF_FILE_HEADER_SIZE
364 * If the user specified a name, use it as is. Otherwise take the
365 * basename and lop off the extension (if any).
368 strncpy(fhdr.name, ctx->name, sizeof(fhdr.name));
370 const char *start = av_basename(s->url);
371 const char *end = strrchr(start, '.');
379 memcpy(fhdr.name, start, FFMIN(len, sizeof(fhdr.name)));
383 chdr.num_samples = ASF_SAMPLE_COUNT;
386 if (ctx->version_major == 1 && ctx->version_minor == 1)
387 chdr.sample_rate = 44100;
389 chdr.sample_rate = par->sample_rate;
392 chdr.flags = ASF_CF_BITS_PER_SAMPLE | ASF_CF_ALWAYS1;
394 if (par->channels == 2)
395 chdr.flags |= ASF_CF_STEREO;
397 argo_asf_write_file_header(&fhdr, s->pb);
398 argo_asf_write_chunk_header(&chdr, s->pb);
402 static int argo_asf_write_packet(AVFormatContext *s, AVPacket *pkt)
404 ArgoASFMuxContext *ctx = s->priv_data;
405 AVCodecParameters *par = s->streams[0]->codecpar;
406 int nb_blocks = pkt->size / par->block_align;
408 if (pkt->size % par->block_align != 0)
409 return AVERROR_INVALIDDATA;
411 if (ctx->nb_blocks + nb_blocks > UINT32_MAX)
412 return AVERROR_INVALIDDATA;
414 avio_write(s->pb, pkt->data, pkt->size);
416 ctx->nb_blocks += nb_blocks;
420 static int argo_asf_write_trailer(AVFormatContext *s)
422 ArgoASFMuxContext *ctx = s->priv_data;
425 if ((ret = avio_seek(s->pb, ASF_FILE_HEADER_SIZE, SEEK_SET) < 0))
428 avio_wl32(s->pb, (uint32_t)ctx->nb_blocks);
432 static const AVOption argo_asf_options[] = {
434 .name = "version_major",
435 .help = "override file major version",
436 .offset = offsetof(ArgoASFMuxContext, version_major),
437 .type = AV_OPT_TYPE_INT,
438 .default_val = {.i64 = 2},
441 .flags = AV_OPT_FLAG_ENCODING_PARAM
444 .name = "version_minor",
445 .help = "override file minor version",
446 .offset = offsetof(ArgoASFMuxContext, version_minor),
447 .type = AV_OPT_TYPE_INT,
448 .default_val = {.i64 = 1},
451 .flags = AV_OPT_FLAG_ENCODING_PARAM
455 .help = "embedded file name (max 8 characters)",
456 .offset = offsetof(ArgoASFMuxContext, name),
457 .type = AV_OPT_TYPE_STRING,
458 .default_val = {.str = NULL},
459 .flags = AV_OPT_FLAG_ENCODING_PARAM
464 static const AVClass argo_asf_muxer_class = {
465 .class_name = "argo_asf_muxer",
466 .item_name = av_default_item_name,
467 .option = argo_asf_options,
468 .version = LIBAVUTIL_VERSION_INT
471 AVOutputFormat ff_argo_asf_muxer = {
473 .long_name = NULL_IF_CONFIG_SMALL("Argonaut Games ASF"),
475 * NB: Can't do this as it conflicts with the actual ASF format.
476 * .extensions = "asf",
478 .audio_codec = AV_CODEC_ID_ADPCM_ARGO,
479 .video_codec = AV_CODEC_ID_NONE,
480 .init = argo_asf_write_init,
481 .write_header = argo_asf_write_header,
482 .write_packet = argo_asf_write_packet,
483 .write_trailer = argo_asf_write_trailer,
484 .priv_class = &argo_asf_muxer_class,
485 .priv_data_size = sizeof(ArgoASFMuxContext)