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