• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Argonaut Games ASF 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 
27 #define ASF_TAG                 MKTAG('A', 'S', 'F', '\0')
28 #define ASF_FILE_HEADER_SIZE    24
29 #define ASF_CHUNK_HEADER_SIZE   20
30 
31 typedef struct ArgoASFFileHeader {
32     uint32_t    magic;          /*< Magic Number, {'A', 'S', 'F', '\0'} */
33     uint16_t    version_major;  /*< File Major Version. */
34     uint16_t    version_minor;  /*< File Minor Version. */
35     uint32_t    num_chunks;     /*< No. chunks in the file. */
36     uint32_t    chunk_offset;   /*< Offset to the first chunk from the start of the file. */
37     int8_t      name[8];        /*< Name. */
38 } ArgoASFFileHeader;
39 
40 typedef struct ArgoASFChunkHeader {
41     uint32_t    num_blocks;     /*< No. blocks in the chunk. */
42     uint32_t    num_samples;    /*< No. samples per channel in a block. */
43     uint32_t    unk1;           /*< Unknown */
44     uint16_t    sample_rate;    /*< Sample rate. */
45     uint16_t    unk2;           /*< Unknown. */
46     uint32_t    flags;          /*< Stream flags. */
47 } ArgoASFChunkHeader;
48 
49 enum {
50     ASF_CF_BITS_PER_SAMPLE  = (1 << 0), /*< 16-bit if set, 8 otherwise.      */
51     ASF_CF_STEREO           = (1 << 1), /*< Stereo if set, mono otherwise.   */
52     ASF_CF_ALWAYS1_1        = (1 << 2), /*< Unknown, always seems to be set. */
53     ASF_CF_ALWAYS1_2        = (1 << 3), /*< Unknown, always seems to be set. */
54 
55     ASF_CF_ALWAYS1          = ASF_CF_ALWAYS1_1 | ASF_CF_ALWAYS1_2,
56     ASF_CF_ALWAYS0          = ~(ASF_CF_BITS_PER_SAMPLE | ASF_CF_STEREO | ASF_CF_ALWAYS1)
57 };
58 
59 typedef struct ArgoASFDemuxContext {
60     ArgoASFFileHeader   fhdr;
61     ArgoASFChunkHeader  ckhdr;
62     uint32_t            blocks_read;
63 } ArgoASFDemuxContext;
64 
argo_asf_parse_file_header(ArgoASFFileHeader * hdr,const uint8_t * buf)65 static void argo_asf_parse_file_header(ArgoASFFileHeader *hdr, const uint8_t *buf)
66 {
67     hdr->magic          = AV_RL32(buf + 0);
68     hdr->version_major  = AV_RL16(buf + 4);
69     hdr->version_minor  = AV_RL16(buf + 6);
70     hdr->num_chunks     = AV_RL32(buf + 8);
71     hdr->chunk_offset   = AV_RL32(buf + 12);
72     for (int i = 0; i < FF_ARRAY_ELEMS(hdr->name); i++)
73         hdr->name[i]    = AV_RL8(buf + 16 + i);
74 }
75 
argo_asf_parse_chunk_header(ArgoASFChunkHeader * hdr,const uint8_t * buf)76 static void argo_asf_parse_chunk_header(ArgoASFChunkHeader *hdr, const uint8_t *buf)
77 {
78     hdr->num_blocks     = AV_RL32(buf + 0);
79     hdr->num_samples    = AV_RL32(buf + 4);
80     hdr->unk1           = AV_RL32(buf + 8);
81     hdr->sample_rate    = AV_RL16(buf + 12);
82     hdr->unk2           = AV_RL16(buf + 14);
83     hdr->flags          = AV_RL32(buf + 16);
84 }
85 
86 /*
87  * Known versions:
88  * 1.1: The sample files in /game-formats/brender/part2.zip
89  * 1.2: Croc! Legend of the Gobbos
90  * 2.1: Croc 2
91  */
argo_asf_is_known_version(const ArgoASFFileHeader * hdr)92 static int argo_asf_is_known_version(const ArgoASFFileHeader *hdr)
93 {
94     return (hdr->version_major == 1 && hdr->version_minor == 1) ||
95            (hdr->version_major == 1 && hdr->version_minor == 2) ||
96            (hdr->version_major == 2 && hdr->version_minor == 1);
97 }
98 
argo_asf_probe(const AVProbeData * p)99 static int argo_asf_probe(const AVProbeData *p)
100 {
101     ArgoASFFileHeader hdr;
102 
103     av_assert0(AVPROBE_PADDING_SIZE >= ASF_FILE_HEADER_SIZE);
104 
105     argo_asf_parse_file_header(&hdr, p->buf);
106 
107     if (hdr.magic != ASF_TAG)
108         return 0;
109 
110     if (!argo_asf_is_known_version(&hdr))
111         return AVPROBE_SCORE_EXTENSION / 2;
112 
113     return AVPROBE_SCORE_EXTENSION + 1;
114 }
115 
argo_asf_read_header(AVFormatContext * s)116 static int argo_asf_read_header(AVFormatContext *s)
117 {
118     int64_t ret;
119     AVIOContext *pb = s->pb;
120     AVStream *st;
121     ArgoASFDemuxContext *asf = s->priv_data;
122     uint8_t buf[FFMAX(ASF_FILE_HEADER_SIZE, ASF_CHUNK_HEADER_SIZE)];
123 
124     if (!(st = avformat_new_stream(s, NULL)))
125         return AVERROR(ENOMEM);
126 
127     if ((ret = avio_read(pb, buf, ASF_FILE_HEADER_SIZE)) < 0)
128         return ret;
129     else if (ret != ASF_FILE_HEADER_SIZE)
130         return AVERROR(EIO);
131 
132     argo_asf_parse_file_header(&asf->fhdr, buf);
133 
134     if (!argo_asf_is_known_version(&asf->fhdr)) {
135         avpriv_request_sample(s, "Version %hu.%hu",
136             asf->fhdr.version_major, asf->fhdr.version_minor
137         );
138         return AVERROR_PATCHWELCOME;
139     }
140 
141     if (asf->fhdr.num_chunks == 0) {
142         return AVERROR_INVALIDDATA;
143     } else if (asf->fhdr.num_chunks > 1) {
144         avpriv_request_sample(s, ">1 chunk");
145         return AVERROR_PATCHWELCOME;
146     }
147 
148     if (asf->fhdr.chunk_offset < ASF_FILE_HEADER_SIZE)
149         return AVERROR_INVALIDDATA;
150 
151     if ((ret = avio_skip(pb, asf->fhdr.chunk_offset - ASF_FILE_HEADER_SIZE)) < 0)
152         return ret;
153 
154     if ((ret = avio_read(pb, buf, ASF_CHUNK_HEADER_SIZE)) < 0)
155         return ret;
156     else if (ret != ASF_CHUNK_HEADER_SIZE)
157         return AVERROR(EIO);
158 
159     argo_asf_parse_chunk_header(&asf->ckhdr, buf);
160 
161     if ((asf->ckhdr.flags & ASF_CF_ALWAYS1) != ASF_CF_ALWAYS1 || (asf->ckhdr.flags & ASF_CF_ALWAYS0) != 0) {
162         avpriv_request_sample(s, "Nonstandard flags (0x%08X)", asf->ckhdr.flags);
163         return AVERROR_PATCHWELCOME;
164     }
165 
166     st->codecpar->codec_type                = AVMEDIA_TYPE_AUDIO;
167     st->codecpar->codec_id                  = AV_CODEC_ID_ADPCM_ARGO;
168     st->codecpar->format                    = AV_SAMPLE_FMT_S16P;
169 
170     if (asf->ckhdr.flags & ASF_CF_STEREO) {
171         st->codecpar->channel_layout        = AV_CH_LAYOUT_STEREO;
172         st->codecpar->channels              = 2;
173     } else {
174         st->codecpar->channel_layout        = AV_CH_LAYOUT_MONO;
175         st->codecpar->channels              = 1;
176     }
177 
178     /* v1.1 files (FX Fighter) are all marked as 44100, but are actually 22050. */
179     if (asf->fhdr.version_major == 1 && asf->fhdr.version_minor == 1)
180         st->codecpar->sample_rate           = 22050;
181     else
182         st->codecpar->sample_rate           = asf->ckhdr.sample_rate;
183 
184     st->codecpar->bits_per_coded_sample     = 4;
185 
186     if (asf->ckhdr.flags & ASF_CF_BITS_PER_SAMPLE)
187         st->codecpar->bits_per_raw_sample   = 16;
188     else
189         st->codecpar->bits_per_raw_sample   = 8;
190 
191     if (st->codecpar->bits_per_raw_sample != 16) {
192         /* The header allows for these, but I've never seen any files with them. */
193         avpriv_request_sample(s, "Non 16-bit samples");
194         return AVERROR_PATCHWELCOME;
195     }
196 
197     /*
198      * (nchannel control bytes) + ((bytes_per_channel) * nchannel)
199      * For mono, this is 17. For stereo, this is 34.
200      */
201     st->codecpar->frame_size            = st->codecpar->channels +
202                                           (asf->ckhdr.num_samples / 2) *
203                                           st->codecpar->channels;
204 
205     st->codecpar->block_align           = st->codecpar->frame_size;
206 
207     st->codecpar->bit_rate              = st->codecpar->channels *
208                                           st->codecpar->sample_rate *
209                                           st->codecpar->bits_per_coded_sample;
210 
211     avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
212     st->start_time      = 0;
213     st->duration        = asf->ckhdr.num_blocks * asf->ckhdr.num_samples;
214     st->nb_frames       = asf->ckhdr.num_blocks;
215     return 0;
216 }
217 
argo_asf_read_packet(AVFormatContext * s,AVPacket * pkt)218 static int argo_asf_read_packet(AVFormatContext *s, AVPacket *pkt)
219 {
220     ArgoASFDemuxContext *asf = s->priv_data;
221 
222     AVStream *st = s->streams[0];
223     AVIOContext *pb = s->pb;
224     int ret;
225 
226     if (asf->blocks_read >= asf->ckhdr.num_blocks)
227         return AVERROR_EOF;
228 
229     if ((ret = av_get_packet(pb, pkt, st->codecpar->frame_size)) < 0)
230         return ret;
231     else if (ret != st->codecpar->frame_size)
232         return AVERROR_INVALIDDATA;
233 
234     pkt->stream_index   = st->index;
235     pkt->duration       = asf->ckhdr.num_samples;
236 
237     ++asf->blocks_read;
238     return 0;
239 }
240 
241 /*
242  * Not actually sure what ASF stands for.
243  * - Argonaut Sound File?
244  * - Audio Stream File?
245  */
246 AVInputFormat ff_argo_asf_demuxer = {
247     .name           = "argo_asf",
248     .long_name      = NULL_IF_CONFIG_SMALL("Argonaut Games ASF"),
249     .priv_data_size = sizeof(ArgoASFDemuxContext),
250     .read_probe     = argo_asf_probe,
251     .read_header    = argo_asf_read_header,
252     .read_packet    = argo_asf_read_packet
253 };
254