git.sesse.net Git - ffmpeg/blob - libavformat/argo_asf.c

   1 /*
   2  * Argonaut Games ASF (de)muxer
   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/opt.h"
  27 #include "argo_asf.h"
  28
  29 /* Maximum number of blocks to read at once. */
  30 #define ASF_NB_BLOCKS 32
  31
  32 typedef struct ArgoASFDemuxContext {
  33     ArgoASFFileHeader   fhdr;
  34     ArgoASFChunkHeader  ckhdr;
  35     uint32_t            blocks_read;
  36 } ArgoASFDemuxContext;
  37
  38 typedef struct ArgoASFMuxContext {
  39     const AVClass *class;
  40     int            version_major;
  41     int            version_minor;
  42     const char    *name;
  43     int64_t        nb_blocks;
  44 } ArgoASFMuxContext;
  45
  46 void ff_argo_asf_parse_file_header(ArgoASFFileHeader *hdr, const uint8_t *buf)
  47 {
  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);
  55 }
  56
  57 int ff_argo_asf_validate_file_header(AVFormatContext *s, const ArgoASFFileHeader *hdr)
  58 {
  59     if (hdr->magic != ASF_TAG || hdr->num_chunks == 0)
  60         return AVERROR_INVALIDDATA;
  61
  62     if (hdr->num_chunks > 1) {
  63         avpriv_request_sample(s, ">1 chunk");
  64         return AVERROR_PATCHWELCOME;
  65     }
  66
  67     if (hdr->chunk_offset < ASF_FILE_HEADER_SIZE)
  68         return AVERROR_INVALIDDATA;
  69
  70     return 0;
  71 }
  72
  73 void ff_argo_asf_parse_chunk_header(ArgoASFChunkHeader *hdr, const uint8_t *buf)
  74 {
  75     hdr->num_blocks     = AV_RL32(buf + 0);
  76     hdr->num_samples    = AV_RL32(buf + 4);
  77     hdr->unk1           = AV_RL32(buf + 8);
  78     hdr->sample_rate    = AV_RL16(buf + 12);
  79     hdr->unk2           = AV_RL16(buf + 14);
  80     hdr->flags          = AV_RL32(buf + 16);
  81 }
  82
  83 int ff_argo_asf_fill_stream(AVStream *st, const ArgoASFFileHeader *fhdr,
  84                             const ArgoASFChunkHeader *ckhdr)
  85 {
  86     if (ckhdr->num_samples != ASF_SAMPLE_COUNT) {
  87         av_log(st, AV_LOG_ERROR, "Invalid sample count. Got %u, expected %d\n",
  88                ckhdr->num_samples, ASF_SAMPLE_COUNT);
  89         return AVERROR_INVALIDDATA;
  90     }
  91
  92     if ((ckhdr->flags & ASF_CF_ALWAYS1) != ASF_CF_ALWAYS1 || (ckhdr->flags & ASF_CF_ALWAYS0) != 0) {
  93         avpriv_request_sample(st, "Nonstandard flags (0x%08X)", ckhdr->flags);
  94         return AVERROR_PATCHWELCOME;
  95     }
  96
  97     st->codecpar->codec_type                = AVMEDIA_TYPE_AUDIO;
  98     st->codecpar->codec_id                  = AV_CODEC_ID_ADPCM_ARGO;
  99     st->codecpar->format                    = AV_SAMPLE_FMT_S16P;
 100
 101     if (ckhdr->flags & ASF_CF_STEREO) {
 102         st->codecpar->channel_layout        = AV_CH_LAYOUT_STEREO;
 103         st->codecpar->channels              = 2;
 104     } else {
 105         st->codecpar->channel_layout        = AV_CH_LAYOUT_MONO;
 106         st->codecpar->channels              = 1;
 107     }
 108
 109     /* v1.1 files (FX Fighter) are all marked as 44100, but are actually 22050. */
 110     if (fhdr->version_major == 1 && fhdr->version_minor == 1)
 111         st->codecpar->sample_rate           = 22050;
 112     else
 113         st->codecpar->sample_rate           = ckhdr->sample_rate;
 114
 115     st->codecpar->bits_per_coded_sample     = 4;
 116
 117     if (ckhdr->flags & ASF_CF_BITS_PER_SAMPLE)
 118         st->codecpar->bits_per_raw_sample   = 16;
 119     else
 120         st->codecpar->bits_per_raw_sample   = 8;
 121
 122     if (st->codecpar->bits_per_raw_sample != 16) {
 123         /* The header allows for these, but I've never seen any files with them. */
 124         avpriv_request_sample(st, "Non 16-bit samples");
 125         return AVERROR_PATCHWELCOME;
 126     }
 127
 128     /*
 129      * (nchannel control bytes) + ((bytes_per_channel) * nchannel)
 130      * For mono, this is 17. For stereo, this is 34.
 131      */
 132     st->codecpar->block_align           = st->codecpar->channels +
 133                                           (ckhdr->num_samples / 2) *
 134                                           st->codecpar->channels;
 135
 136     st->codecpar->bit_rate              = st->codecpar->channels *
 137                                           st->codecpar->sample_rate *
 138                                           st->codecpar->bits_per_coded_sample;
 139
 140     avpriv_set_pts_info(st, 64, 1, st->codecpar->sample_rate);
 141     st->start_time      = 0;
 142     st->duration        = ckhdr->num_blocks * ckhdr->num_samples;
 143     st->nb_frames       = ckhdr->num_blocks;
 144     return 0;
 145 }
 146
 147 #if CONFIG_ARGO_ASF_DEMUXER
 148 /*
 149  * Known versions:
 150  * 1.1: https://samples.ffmpeg.org/game-formats/brender/part2.zip
 151  *      FX Fighter
 152  * 1.2: Croc! Legend of the Gobbos
 153  * 2.1: Croc 2
 154  *      The Emperor's New Groove
 155  *      Disney's Aladdin in Nasira's Revenge
 156  */
 157 static int argo_asf_is_known_version(const ArgoASFFileHeader *hdr)
 158 {
 159     return (hdr->version_major == 1 && hdr->version_minor == 1) ||
 160            (hdr->version_major == 1 && hdr->version_minor == 2) ||
 161            (hdr->version_major == 2 && hdr->version_minor == 1);
 162 }
 163
 164 static int argo_asf_probe(const AVProbeData *p)
 165 {
 166     ArgoASFFileHeader hdr;
 167
 168     av_assert0(AVPROBE_PADDING_SIZE >= ASF_FILE_HEADER_SIZE);
 169
 170     ff_argo_asf_parse_file_header(&hdr, p->buf);
 171
 172     if (hdr.magic != ASF_TAG)
 173         return 0;
 174
 175     if (!argo_asf_is_known_version(&hdr))
 176         return AVPROBE_SCORE_EXTENSION / 2;
 177
 178     return AVPROBE_SCORE_EXTENSION + 1;
 179 }
 180
 181 static int argo_asf_read_header(AVFormatContext *s)
 182 {
 183     int64_t ret;
 184     AVIOContext *pb = s->pb;
 185     AVStream *st;
 186     ArgoASFDemuxContext *asf = s->priv_data;
 187     uint8_t buf[ASF_MIN_BUFFER_SIZE];
 188
 189     if (!(st = avformat_new_stream(s, NULL)))
 190         return AVERROR(ENOMEM);
 191
 192     if ((ret = avio_read(pb, buf, ASF_FILE_HEADER_SIZE)) < 0)
 193         return ret;
 194     else if (ret != ASF_FILE_HEADER_SIZE)
 195         return AVERROR(EIO);
 196
 197     ff_argo_asf_parse_file_header(&asf->fhdr, buf);
 198
 199     if ((ret = ff_argo_asf_validate_file_header(s, &asf->fhdr)) < 0)
 200         return ret;
 201
 202     if ((ret = avio_skip(pb, asf->fhdr.chunk_offset - ASF_FILE_HEADER_SIZE)) < 0)
 203         return ret;
 204
 205     if ((ret = avio_read(pb, buf, ASF_CHUNK_HEADER_SIZE)) < 0)
 206         return ret;
 207     else if (ret != ASF_CHUNK_HEADER_SIZE)
 208         return AVERROR(EIO);
 209
 210     ff_argo_asf_parse_chunk_header(&asf->ckhdr, buf);
 211
 212     return ff_argo_asf_fill_stream(st, &asf->fhdr, &asf->ckhdr);
 213 }
 214
 215 static int argo_asf_read_packet(AVFormatContext *s, AVPacket *pkt)
 216 {
 217     ArgoASFDemuxContext *asf = s->priv_data;
 218
 219     AVStream *st = s->streams[0];
 220     AVIOContext *pb = s->pb;
 221     int ret;
 222
 223     if (asf->blocks_read >= asf->ckhdr.num_blocks)
 224         return AVERROR_EOF;
 225
 226     ret = av_get_packet(pb, pkt, st->codecpar->block_align *
 227                         FFMIN(ASF_NB_BLOCKS, asf->ckhdr.num_blocks - asf->blocks_read));
 228     if (ret < 0)
 229         return ret;
 230
 231     /* Something real screwy is going on. */
 232     if (ret % st->codecpar->block_align != 0)
 233         return AVERROR_INVALIDDATA;
 234
 235
 236     pkt->stream_index   = st->index;
 237     pkt->duration       = asf->ckhdr.num_samples * (ret / st->codecpar->block_align);
 238     asf->blocks_read   += (ret / st->codecpar->block_align);
 239
 240     pkt->flags &= ~AV_PKT_FLAG_CORRUPT;
 241     return 0;
 242 }
 243
 244 /*
 245  * Not actually sure what ASF stands for.
 246  * - Argonaut Sound File?
 247  * - Audio Stream File?
 248  */
 249 AVInputFormat ff_argo_asf_demuxer = {
 250     .name           = "argo_asf",
 251     .long_name      = NULL_IF_CONFIG_SMALL("Argonaut Games ASF"),
 252     .priv_data_size = sizeof(ArgoASFDemuxContext),
 253     .read_probe     = argo_asf_probe,
 254     .read_header    = argo_asf_read_header,
 255     .read_packet    = argo_asf_read_packet
 256 };
 257 #endif
 258
 259 #if CONFIG_ARGO_ASF_MUXER
 260 static int argo_asf_write_init(AVFormatContext *s)
 261 {
 262     ArgoASFMuxContext *ctx = s->priv_data;
 263     const AVCodecParameters *par;
 264
 265     if (s->nb_streams != 1) {
 266         av_log(s, AV_LOG_ERROR, "ASF files have exactly one stream\n");
 267         return AVERROR(EINVAL);
 268     }
 269
 270     par = s->streams[0]->codecpar;
 271
 272     if (par->codec_id != AV_CODEC_ID_ADPCM_ARGO) {
 273         av_log(s, AV_LOG_ERROR, "%s codec not supported\n",
 274                avcodec_get_name(par->codec_id));
 275         return AVERROR(EINVAL);
 276     }
 277
 278     if (ctx->version_major == 1 && ctx->version_minor == 1 && par->sample_rate != 22050) {
 279         av_log(s, AV_LOG_ERROR, "ASF v1.1 files only support a sample rate of 22050\n");
 280         return AVERROR(EINVAL);
 281     }
 282
 283     if (par->channels > 2) {
 284         av_log(s, AV_LOG_ERROR, "ASF files only support up to 2 channels\n");
 285         return AVERROR(EINVAL);
 286     }
 287
 288     if (par->block_align != 17 * par->channels)
 289         return AVERROR(EINVAL);
 290
 291     if (par->sample_rate > UINT16_MAX) {
 292         av_log(s, AV_LOG_ERROR, "Sample rate too large\n");
 293         return AVERROR(EINVAL);
 294     }
 295
 296     if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL)) {
 297         av_log(s, AV_LOG_ERROR, "Stream not seekable, unable to write output file\n");
 298         return AVERROR(EINVAL);
 299     }
 300
 301     return 0;
 302 }
 303
 304 static void argo_asf_write_file_header(const ArgoASFFileHeader *fhdr, AVIOContext *pb)
 305 {
 306     avio_wl32( pb, fhdr->magic);
 307     avio_wl16( pb, fhdr->version_major);
 308     avio_wl16( pb, fhdr->version_minor);
 309     avio_wl32( pb, fhdr->num_chunks);
 310     avio_wl32( pb, fhdr->chunk_offset);
 311     avio_write(pb, fhdr->name, sizeof(fhdr->name));
 312 }
 313
 314 static void argo_asf_write_chunk_header(const ArgoASFChunkHeader *ckhdr, AVIOContext *pb)
 315 {
 316     avio_wl32(pb, ckhdr->num_blocks);
 317     avio_wl32(pb, ckhdr->num_samples);
 318     avio_wl32(pb, ckhdr->unk1);
 319     avio_wl16(pb, ckhdr->sample_rate);
 320     avio_wl16(pb, ckhdr->unk2);
 321     avio_wl32(pb, ckhdr->flags);
 322 }
 323
 324 static int argo_asf_write_header(AVFormatContext *s)
 325 {
 326     const AVCodecParameters  *par = s->streams[0]->codecpar;
 327     ArgoASFMuxContext        *ctx = s->priv_data;
 328     ArgoASFChunkHeader chdr;
 329     ArgoASFFileHeader  fhdr = {
 330         .magic         = ASF_TAG,
 331         .version_major = (uint16_t)ctx->version_major,
 332         .version_minor = (uint16_t)ctx->version_minor,
 333         .num_chunks    = 1,
 334         .chunk_offset  = ASF_FILE_HEADER_SIZE
 335     };
 336
 337     /*
 338      * If the user specified a name, use it as is. Otherwise take the
 339      * basename and lop off the extension (if any).
 340      */
 341     if (ctx->name) {
 342         strncpy(fhdr.name, ctx->name, sizeof(fhdr.name));
 343     } else {
 344         const char *start = av_basename(s->url);
 345         const char *end   = strrchr(start, '.');
 346         size_t      len;
 347
 348         if(end)
 349             len = end - start;
 350         else
 351             len = strlen(start);
 352
 353         memcpy(fhdr.name, start, FFMIN(len, sizeof(fhdr.name)));
 354     }
 355
 356     chdr.num_blocks    = 0;
 357     chdr.num_samples   = ASF_SAMPLE_COUNT;
 358     chdr.unk1          = 0;
 359
 360     if (ctx->version_major == 1 && ctx->version_minor == 1)
 361         chdr.sample_rate = 44100;
 362     else
 363         chdr.sample_rate = par->sample_rate;
 364
 365     chdr.unk2          = ~0;
 366     chdr.flags         = ASF_CF_BITS_PER_SAMPLE | ASF_CF_ALWAYS1;
 367
 368     if (par->channels == 2)
 369         chdr.flags |= ASF_CF_STEREO;
 370
 371     argo_asf_write_file_header(&fhdr, s->pb);
 372     argo_asf_write_chunk_header(&chdr, s->pb);
 373     return 0;
 374 }
 375
 376 static int argo_asf_write_packet(AVFormatContext *s, AVPacket *pkt)
 377 {
 378     ArgoASFMuxContext *ctx = s->priv_data;
 379     AVCodecParameters *par = s->streams[0]->codecpar;
 380     int nb_blocks = pkt->size / par->block_align;
 381
 382     if (pkt->size % par->block_align != 0)
 383         return AVERROR_INVALIDDATA;
 384
 385     if (ctx->nb_blocks + nb_blocks > UINT32_MAX)
 386         return AVERROR_INVALIDDATA;
 387
 388     avio_write(s->pb, pkt->data, pkt->size);
 389
 390     ctx->nb_blocks += nb_blocks;
 391     return 0;
 392 }
 393
 394 static int argo_asf_write_trailer(AVFormatContext *s)
 395 {
 396     ArgoASFMuxContext *ctx = s->priv_data;
 397     int64_t ret;
 398
 399     if ((ret = avio_seek(s->pb, ASF_FILE_HEADER_SIZE, SEEK_SET) < 0))
 400         return ret;
 401
 402     avio_wl32(s->pb, (uint32_t)ctx->nb_blocks);
 403     return 0;
 404 }
 405
 406 static const AVOption argo_asf_options[] = {
 407     {
 408         .name        = "version_major",
 409         .help        = "override file major version",
 410         .offset      = offsetof(ArgoASFMuxContext, version_major),
 411         .type        = AV_OPT_TYPE_INT,
 412         .default_val = {.i64 = 2},
 413         .min         = 0,
 414         .max         = UINT16_MAX,
 415         .flags       = AV_OPT_FLAG_ENCODING_PARAM
 416     },
 417     {
 418         .name        = "version_minor",
 419         .help        = "override file minor version",
 420         .offset      = offsetof(ArgoASFMuxContext, version_minor),
 421         .type        = AV_OPT_TYPE_INT,
 422         .default_val = {.i64 = 1},
 423         .min         = 0,
 424         .max         = UINT16_MAX,
 425         .flags       = AV_OPT_FLAG_ENCODING_PARAM
 426     },
 427     {
 428         .name        = "name",
 429         .help        = "embedded file name (max 8 characters)",
 430         .offset      = offsetof(ArgoASFMuxContext, name),
 431         .type        = AV_OPT_TYPE_STRING,
 432         .default_val = {.str = NULL},
 433         .flags       = AV_OPT_FLAG_ENCODING_PARAM
 434     },
 435     { NULL }
 436 };
 437
 438 static const AVClass argo_asf_muxer_class = {
 439     .class_name = "argo_asf_muxer",
 440     .item_name  = av_default_item_name,
 441     .option     = argo_asf_options,
 442     .version    = LIBAVUTIL_VERSION_INT
 443 };
 444
 445 AVOutputFormat ff_argo_asf_muxer = {
 446     .name           = "argo_asf",
 447     .long_name      = NULL_IF_CONFIG_SMALL("Argonaut Games ASF"),
 448     /*
 449      * NB: Can't do this as it conflicts with the actual ASF format.
 450      * .extensions  = "asf",
 451      */
 452     .audio_codec    = AV_CODEC_ID_ADPCM_ARGO,
 453     .video_codec    = AV_CODEC_ID_NONE,
 454     .init           = argo_asf_write_init,
 455     .write_header   = argo_asf_write_header,
 456     .write_packet   = argo_asf_write_packet,
 457     .write_trailer  = argo_asf_write_trailer,
 458     .priv_class     = &argo_asf_muxer_class,
 459     .priv_data_size = sizeof(ArgoASFMuxContext)
 460 };
 461 #endif