libavformat/ape.c

   1 /*
   2  * Monkey's Audio APE demuxer
   3  * Copyright (c) 2007 Benjamin Zores <ben@geexbox.org>
   4  *  based upon libdemac from Dave Chapman.
   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
  23 #include <stdio.h>
  24
  25 #include "libavutil/intreadwrite.h"
  26 #include "libavutil/mem.h"
  27 #include "avformat.h"
  28 #include "demux.h"
  29 #include "internal.h"
  30 #include "apetag.h"
  31
  32 /* The earliest and latest file formats supported by this library */
  33 #define APE_MIN_VERSION 3800
  34 #define APE_MAX_VERSION 3990
  35
  36 #define MAC_FORMAT_FLAG_8_BIT                 1 // is 8-bit [OBSOLETE]
  37 #define MAC_FORMAT_FLAG_CRC                   2 // uses the new CRC32 error detection [OBSOLETE]
  38 #define MAC_FORMAT_FLAG_HAS_PEAK_LEVEL        4 // uint32 nPeakLevel after the header [OBSOLETE]
  39 #define MAC_FORMAT_FLAG_24_BIT                8 // is 24-bit [OBSOLETE]
  40 #define MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS    16 // has the number of seek elements after the peak level
  41 #define MAC_FORMAT_FLAG_CREATE_WAV_HEADER    32 // create the wave header on decompression (not stored)
  42
  43 #define APE_EXTRADATA_SIZE 6
  44
  45 typedef struct APEFrame {
  46     int64_t pos;
  47     int64_t size;
  48     int nblocks;
  49     int skip;
  50     int64_t pts;
  51 } APEFrame;
  52
  53 typedef struct APEContext {
  54     /* Derived fields */
  55     uint32_t junklength;
  56     uint32_t firstframe;
  57     uint32_t totalsamples;
  58     int currentframe;
  59     APEFrame *frames;
  60
  61     /* Info from Descriptor Block */
  62     int16_t fileversion;
  63     int16_t padding1;
  64     uint32_t descriptorlength;
  65     uint32_t headerlength;
  66     uint32_t seektablelength;
  67     uint32_t wavheaderlength;
  68     uint32_t audiodatalength;
  69     uint32_t audiodatalength_high;
  70     uint32_t wavtaillength;
  71     uint8_t md5[16];
  72
  73     /* Info from Header Block */
  74     uint16_t compressiontype;
  75     uint16_t formatflags;
  76     uint32_t blocksperframe;
  77     uint32_t finalframeblocks;
  78     uint32_t totalframes;
  79     uint16_t bps;
  80     uint16_t channels;
  81     uint32_t samplerate;
  82 } APEContext;
  83
  84 static int ape_probe(const AVProbeData * p)
  85 {
  86     int version = AV_RL16(p->buf+4);
  87     if (AV_RL32(p->buf) != MKTAG('M', 'A', 'C', ' '))
  88         return 0;
  89
  90     if (version < APE_MIN_VERSION || version > APE_MAX_VERSION)
  91         return AVPROBE_SCORE_MAX/4;
  92
  93     return AVPROBE_SCORE_MAX;
  94 }
  95
  96 static void ape_dumpinfo(AVFormatContext * s, APEContext * ape_ctx)
  97 {
  98 #ifdef DEBUG
  99     int i;
 100
 101     av_log(s, AV_LOG_DEBUG, "Descriptor Block:\n\n");
 102     av_log(s, AV_LOG_DEBUG, "fileversion          = %"PRId16"\n", ape_ctx->fileversion);
 103     av_log(s, AV_LOG_DEBUG, "descriptorlength     = %"PRIu32"\n", ape_ctx->descriptorlength);
 104     av_log(s, AV_LOG_DEBUG, "headerlength         = %"PRIu32"\n", ape_ctx->headerlength);
 105     av_log(s, AV_LOG_DEBUG, "seektablelength      = %"PRIu32"\n", ape_ctx->seektablelength);
 106     av_log(s, AV_LOG_DEBUG, "wavheaderlength      = %"PRIu32"\n", ape_ctx->wavheaderlength);
 107     av_log(s, AV_LOG_DEBUG, "audiodatalength      = %"PRIu32"\n", ape_ctx->audiodatalength);
 108     av_log(s, AV_LOG_DEBUG, "audiodatalength_high = %"PRIu32"\n", ape_ctx->audiodatalength_high);
 109     av_log(s, AV_LOG_DEBUG, "wavtaillength        = %"PRIu32"\n", ape_ctx->wavtaillength);
 110     av_log(s, AV_LOG_DEBUG, "md5                  = ");
 111     for (i = 0; i < 16; i++)
 112          av_log(s, AV_LOG_DEBUG, "%02x", ape_ctx->md5[i]);
 113     av_log(s, AV_LOG_DEBUG, "\n");
 114
 115     av_log(s, AV_LOG_DEBUG, "\nHeader Block:\n\n");
 116
 117     av_log(s, AV_LOG_DEBUG, "compressiontype      = %"PRIu16"\n", ape_ctx->compressiontype);
 118     av_log(s, AV_LOG_DEBUG, "formatflags          = %"PRIu16"\n", ape_ctx->formatflags);
 119     av_log(s, AV_LOG_DEBUG, "blocksperframe       = %"PRIu32"\n", ape_ctx->blocksperframe);
 120     av_log(s, AV_LOG_DEBUG, "finalframeblocks     = %"PRIu32"\n", ape_ctx->finalframeblocks);
 121     av_log(s, AV_LOG_DEBUG, "totalframes          = %"PRIu32"\n", ape_ctx->totalframes);
 122     av_log(s, AV_LOG_DEBUG, "bps                  = %"PRIu16"\n", ape_ctx->bps);
 123     av_log(s, AV_LOG_DEBUG, "channels             = %"PRIu16"\n", ape_ctx->channels);
 124     av_log(s, AV_LOG_DEBUG, "samplerate           = %"PRIu32"\n", ape_ctx->samplerate);
 125
 126     av_log(s, AV_LOG_DEBUG, "\nSeektable\n\n");
 127     if ((ape_ctx->seektablelength / sizeof(uint32_t)) != ape_ctx->totalframes) {
 128         av_log(s, AV_LOG_DEBUG, "No seektable\n");
 129     }
 130
 131     av_log(s, AV_LOG_DEBUG, "\nFrames\n\n");
 132     for (i = 0; i < ape_ctx->totalframes; i++)
 133         av_log(s, AV_LOG_DEBUG, "%8d   %8"PRId64" %8"PRId64" (%d samples)\n", i,
 134                ape_ctx->frames[i].pos, ape_ctx->frames[i].size,
 135                ape_ctx->frames[i].nblocks);
 136
 137     av_log(s, AV_LOG_DEBUG, "\nCalculated information:\n\n");
 138     av_log(s, AV_LOG_DEBUG, "junklength           = %"PRIu32"\n", ape_ctx->junklength);
 139     av_log(s, AV_LOG_DEBUG, "firstframe           = %"PRIu32"\n", ape_ctx->firstframe);
 140     av_log(s, AV_LOG_DEBUG, "totalsamples         = %"PRIu32"\n", ape_ctx->totalsamples);
 141 #endif
 142 }
 143
 144 static int ape_read_header(AVFormatContext * s)
 145 {
 146     AVIOContext *pb = s->pb;
 147     APEContext *ape = s->priv_data;
 148     AVStream *st;
 149     uint32_t tag;
 150     int i, ret;
 151     int64_t total_blocks;
 152     int64_t final_size = 0;
 153     int64_t pts, file_size;
 154
 155     /* Skip any leading junk such as id3v2 tags */
 156     ape->junklength = avio_tell(pb);
 157
 158     tag = avio_rl32(pb);
 159     if (tag != MKTAG('M', 'A', 'C', ' '))
 160         return AVERROR_INVALIDDATA;
 161
 162     ape->fileversion = avio_rl16(pb);
 163
 164     if (ape->fileversion < APE_MIN_VERSION || ape->fileversion > APE_MAX_VERSION) {
 165         av_log(s, AV_LOG_ERROR, "Unsupported file version - %d.%02d\n",
 166                ape->fileversion / 1000, (ape->fileversion % 1000) / 10);
 167         return AVERROR_PATCHWELCOME;
 168     }
 169
 170     if (ape->fileversion >= 3980) {
 171         ape->padding1             = avio_rl16(pb);
 172         ape->descriptorlength     = avio_rl32(pb);
 173         ape->headerlength         = avio_rl32(pb);
 174         ape->seektablelength      = avio_rl32(pb);
 175         ape->wavheaderlength      = avio_rl32(pb);
 176         ape->audiodatalength      = avio_rl32(pb);
 177         ape->audiodatalength_high = avio_rl32(pb);
 178         ape->wavtaillength        = avio_rl32(pb);
 179         avio_read(pb, ape->md5, 16);
 180
 181         /* Skip any unknown bytes at the end of the descriptor.
 182            This is for future compatibility */
 183         if (ape->descriptorlength > 52)
 184             avio_skip(pb, ape->descriptorlength - 52);
 185
 186         /* Read header data */
 187         ape->compressiontype      = avio_rl16(pb);
 188         ape->formatflags          = avio_rl16(pb);
 189         ape->blocksperframe       = avio_rl32(pb);
 190         ape->finalframeblocks     = avio_rl32(pb);
 191         ape->totalframes          = avio_rl32(pb);
 192         ape->bps                  = avio_rl16(pb);
 193         ape->channels             = avio_rl16(pb);
 194         ape->samplerate           = avio_rl32(pb);
 195     } else {
 196         ape->descriptorlength = 0;
 197         ape->headerlength = 32;
 198
 199         ape->compressiontype      = avio_rl16(pb);
 200         ape->formatflags          = avio_rl16(pb);
 201         ape->channels             = avio_rl16(pb);
 202         ape->samplerate           = avio_rl32(pb);
 203         ape->wavheaderlength      = avio_rl32(pb);
 204         ape->wavtaillength        = avio_rl32(pb);
 205         ape->totalframes          = avio_rl32(pb);
 206         ape->finalframeblocks     = avio_rl32(pb);
 207
 208         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_PEAK_LEVEL) {
 209             avio_skip(pb, 4); /* Skip the peak level */
 210             ape->headerlength += 4;
 211         }
 212
 213         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS) {
 214             ape->seektablelength = avio_rl32(pb);
 215             ape->headerlength += 4;
 216             ape->seektablelength *= sizeof(int32_t);
 217         } else
 218             ape->seektablelength = ape->totalframes * sizeof(int32_t);
 219
 220         if (ape->formatflags & MAC_FORMAT_FLAG_8_BIT)
 221             ape->bps = 8;
 222         else if (ape->formatflags & MAC_FORMAT_FLAG_24_BIT)
 223             ape->bps = 24;
 224         else
 225             ape->bps = 16;
 226
 227         if (ape->fileversion >= 3950)
 228             ape->blocksperframe = 73728 * 4;
 229         else if (ape->fileversion >= 3900 || (ape->fileversion >= 3800  && ape->compressiontype >= 4000))
 230             ape->blocksperframe = 73728;
 231         else
 232             ape->blocksperframe = 9216;
 233
 234         /* Skip any stored wav header */
 235         if (!(ape->formatflags & MAC_FORMAT_FLAG_CREATE_WAV_HEADER))
 236             avio_skip(pb, ape->wavheaderlength);
 237     }
 238
 239     if(!ape->totalframes || pb->eof_reached){
 240         av_log(s, AV_LOG_ERROR, "No frames in the file!\n");
 241         return AVERROR(EINVAL);
 242     }
 243     if(ape->totalframes > UINT_MAX / sizeof(APEFrame)){
 244         av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n",
 245                ape->totalframes);
 246         return AVERROR_INVALIDDATA;
 247     }
 248     if (ape->seektablelength / sizeof(uint32_t) < ape->totalframes) {
 249         av_log(s, AV_LOG_ERROR,
 250                "Number of seek entries is less than number of frames: %"SIZE_SPECIFIER" vs. %"PRIu32"\n",
 251                ape->seektablelength / sizeof(uint32_t), ape->totalframes);
 252         return AVERROR_INVALIDDATA;
 253     }
 254     ape->frames       = av_malloc_array(ape->totalframes, sizeof(APEFrame));
 255     if(!ape->frames)
 256         return AVERROR(ENOMEM);
 257     ape->firstframe   = ape->junklength + ape->descriptorlength + ape->headerlength + ape->seektablelength + ape->wavheaderlength;
 258     if (ape->fileversion < 3810)
 259         ape->firstframe += ape->totalframes;
 260     ape->currentframe = 0;
 261
 262
 263     ape->totalsamples = ape->finalframeblocks;
 264     if (ape->totalframes > 1)
 265         ape->totalsamples += ape->blocksperframe * (ape->totalframes - 1);
 266
 267     ape->frames[0].pos     = ape->firstframe;
 268     ape->frames[0].nblocks = ape->blocksperframe;
 269     ape->frames[0].skip    = 0;
 270     avio_rl32(pb); // seektable[0]
 271     for (i = 1; i < ape->totalframes; i++) {
 272         uint32_t seektable_entry = avio_rl32(pb);
 273         ape->frames[i].pos      = seektable_entry + ape->junklength;
 274         ape->frames[i].nblocks  = ape->blocksperframe;
 275         ape->frames[i - 1].size = ape->frames[i].pos - ape->frames[i - 1].pos;
 276         ape->frames[i].skip     = (ape->frames[i].pos - ape->frames[0].pos) & 3;
 277
 278         if (pb->eof_reached) {
 279             av_log(s, AV_LOG_ERROR, "seektable truncated\n");
 280             return AVERROR_INVALIDDATA;
 281         }
 282         ff_dlog(s, "seektable: %8d   %"PRIu32"\n", i, seektable_entry);
 283     }
 284     avio_skip(pb, ape->seektablelength / sizeof(uint32_t) - ape->totalframes);
 285
 286     ape->frames[ape->totalframes - 1].nblocks = ape->finalframeblocks;
 287     /* calculate final packet size from total file size, if available */
 288     file_size = avio_size(pb);
 289     if (file_size > 0) {
 290         final_size = file_size - ape->frames[ape->totalframes - 1].pos -
 291                      ape->wavtaillength;
 292         final_size -= final_size & 3;
 293     }
 294     if (file_size <= 0 || final_size <= 0)
 295         final_size = ape->finalframeblocks * 8LL;
 296     ape->frames[ape->totalframes - 1].size = final_size;
 297
 298     for (i = 0; i < ape->totalframes; i++) {
 299         if(ape->frames[i].skip){
 300             ape->frames[i].pos  -= ape->frames[i].skip;
 301             ape->frames[i].size += ape->frames[i].skip;
 302         }
 303         if (ape->frames[i].size > INT_MAX - 3)
 304             return AVERROR_INVALIDDATA;
 305         ape->frames[i].size = (ape->frames[i].size + 3) & ~3;
 306     }
 307     if (ape->fileversion < 3810) {
 308         for (i = 0; i < ape->totalframes; i++) {
 309             int bits = avio_r8(pb);
 310             if (i && bits)
 311                 ape->frames[i - 1].size += 4;
 312
 313             ape->frames[i].skip <<= 3;
 314             ape->frames[i].skip  += bits;
 315             ff_dlog(s, "bittable: %2d\n", bits);
 316             if (pb->eof_reached) {
 317                 av_log(s, AV_LOG_ERROR, "bittable truncated\n");
 318                 return AVERROR_INVALIDDATA;
 319             }
 320         }
 321     }
 322
 323     ape_dumpinfo(s, ape);
 324
 325     av_log(s, AV_LOG_VERBOSE, "Decoding file - v%d.%02d, compression level %"PRIu16"\n",
 326            ape->fileversion / 1000, (ape->fileversion % 1000) / 10,
 327            ape->compressiontype);
 328
 329     /* now we are ready: build format streams */
 330     st = avformat_new_stream(s, NULL);
 331     if (!st)
 332         return AVERROR(ENOMEM);
 333
 334     total_blocks = (ape->totalframes == 0) ? 0 : ((int64_t)(ape->totalframes - 1) * ape->blocksperframe) + ape->finalframeblocks;
 335
 336     st->codecpar->codec_type      = AVMEDIA_TYPE_AUDIO;
 337     st->codecpar->codec_id        = AV_CODEC_ID_APE;
 338     st->codecpar->codec_tag       = MKTAG('A', 'P', 'E', ' ');
 339     st->codecpar->ch_layout.nb_channels = ape->channels;
 340     st->codecpar->sample_rate     = ape->samplerate;
 341     st->codecpar->bits_per_coded_sample = ape->bps;
 342
 343     st->nb_frames = ape->totalframes;
 344     st->start_time = 0;
 345     st->duration  = total_blocks;
 346     avpriv_set_pts_info(st, 64, 1, ape->samplerate);
 347
 348     if ((ret = ff_alloc_extradata(st->codecpar, APE_EXTRADATA_SIZE)) < 0)
 349         return ret;
 350     AV_WL16(st->codecpar->extradata + 0, ape->fileversion);
 351     AV_WL16(st->codecpar->extradata + 2, ape->compressiontype);
 352     AV_WL16(st->codecpar->extradata + 4, ape->formatflags);
 353
 354     pts = 0;
 355     for (i = 0; i < ape->totalframes; i++) {
 356         ape->frames[i].pts = pts;
 357         av_add_index_entry(st, ape->frames[i].pos, ape->frames[i].pts, 0, 0, AVINDEX_KEYFRAME);
 358         pts += ape->blocksperframe;
 359     }
 360
 361     /* try to read APE tags */
 362     if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
 363         ff_ape_parse_tag(s);
 364         avio_seek(pb, 0, SEEK_SET);
 365     }
 366
 367     return 0;
 368 }
 369
 370 static int ape_read_packet(AVFormatContext * s, AVPacket * pkt)
 371 {
 372     int ret;
 373     int nblocks;
 374     APEContext *ape = s->priv_data;
 375     uint32_t extra_size = 8;
 376     int64_t ret64;
 377
 378     if (avio_feof(s->pb))
 379         return AVERROR_EOF;
 380     if (ape->currentframe >= ape->totalframes)
 381         return AVERROR_EOF;
 382
 383     ret64 = avio_seek(s->pb, ape->frames[ape->currentframe].pos, SEEK_SET);
 384     if (ret64 < 0)
 385         return ret64;
 386
 387     /* Calculate how many blocks there are in this frame */
 388     if (ape->currentframe == (ape->totalframes - 1))
 389         nblocks = ape->finalframeblocks;
 390     else
 391         nblocks = ape->blocksperframe;
 392
 393     if (ape->frames[ape->currentframe].size <= 0 ||
 394         ape->frames[ape->currentframe].size > INT_MAX - extra_size) {
 395         av_log(s, AV_LOG_ERROR, "invalid packet size: %8"PRId64"\n",
 396                ape->frames[ape->currentframe].size);
 397         ape->currentframe++;
 398         return AVERROR_INVALIDDATA;
 399     }
 400
 401     ret = av_new_packet(pkt, ape->frames[ape->currentframe].size + extra_size);
 402     if (ret < 0)
 403         return ret;
 404
 405     AV_WL32(pkt->data    , nblocks);
 406     AV_WL32(pkt->data + 4, ape->frames[ape->currentframe].skip);
 407     ret = avio_read(s->pb, pkt->data + extra_size, ape->frames[ape->currentframe].size);
 408     if (ret < 0) {
 409         return ret;
 410     }
 411
 412     pkt->pts = ape->frames[ape->currentframe].pts;
 413     pkt->stream_index = 0;
 414
 415     /* note: we need to modify the packet size here to handle the last
 416        packet */
 417     pkt->size = ret + extra_size;
 418     pkt->duration = nblocks;
 419
 420     ape->currentframe++;
 421
 422     return 0;
 423 }
 424
 425 static int ape_read_close(AVFormatContext * s)
 426 {
 427     APEContext *ape = s->priv_data;
 428
 429     av_freep(&ape->frames);
 430     return 0;
 431 }
 432
 433 static int ape_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
 434 {
 435     AVStream *st = s->streams[stream_index];
 436     APEContext *ape = s->priv_data;
 437     int index = av_index_search_timestamp(st, timestamp, flags);
 438     int64_t ret;
 439
 440     if (index < 0)
 441         return -1;
 442
 443     if ((ret = avio_seek(s->pb, ffstream(st)->index_entries[index].pos, SEEK_SET)) < 0)
 444         return ret;
 445     ape->currentframe = index;
 446     return 0;
 447 }
 448
 449 const FFInputFormat ff_ape_demuxer = {
 450     .p.name         = "ape",
 451     .p.long_name    = NULL_IF_CONFIG_SMALL("Monkey's Audio"),
 452     .p.extensions   = "ape,apl,mac",
 453     .priv_data_size = sizeof(APEContext),
 454     .flags_internal = FF_INFMT_FLAG_INIT_CLEANUP,
 455     .read_probe     = ape_probe,
 456     .read_header    = ape_read_header,
 457     .read_packet    = ape_read_packet,
 458     .read_close     = ape_read_close,
 459     .read_seek      = ape_read_seek,
 460 };