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 "avformat.h"
  27 #include "apetag.h"
  28
  29 /* The earliest and latest file formats supported by this library */
  30 #define APE_MIN_VERSION 3950
  31 #define APE_MAX_VERSION 3990
  32
  33 #define MAC_FORMAT_FLAG_8_BIT                 1 // is 8-bit [OBSOLETE]
  34 #define MAC_FORMAT_FLAG_CRC                   2 // uses the new CRC32 error detection [OBSOLETE]
  35 #define MAC_FORMAT_FLAG_HAS_PEAK_LEVEL        4 // uint32 nPeakLevel after the header [OBSOLETE]
  36 #define MAC_FORMAT_FLAG_24_BIT                8 // is 24-bit [OBSOLETE]
  37 #define MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS    16 // has the number of seek elements after the peak level
  38 #define MAC_FORMAT_FLAG_CREATE_WAV_HEADER    32 // create the wave header on decompression (not stored)
  39
  40 #define MAC_SUBFRAME_SIZE 4608
  41
  42 #define APE_EXTRADATA_SIZE 6
  43
  44 typedef struct {
  45     int64_t pos;
  46     int nblocks;
  47     int size;
  48     int skip;
  49     int64_t pts;
  50 } APEFrame;
  51
  52 typedef struct {
  53     /* Derived fields */
  54     uint32_t junklength;
  55     uint32_t firstframe;
  56     uint32_t totalsamples;
  57     int currentframe;
  58     APEFrame *frames;
  59
  60     /* Info from Descriptor Block */
  61     char magic[4];
  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
  83     /* Seektable */
  84     uint32_t *seektable;
  85 } APEContext;
  86
  87 static int ape_probe(AVProbeData * p)
  88 {
  89     if (p->buf[0] == 'M' && p->buf[1] == 'A' && p->buf[2] == 'C' && p->buf[3] == ' ')
  90         return AVPROBE_SCORE_MAX;
  91
  92     return 0;
  93 }
  94
  95 static void ape_dumpinfo(AVFormatContext * s, APEContext * ape_ctx)
  96 {
  97 #ifdef DEBUG
  98     int i;
  99
 100     av_log(s, AV_LOG_DEBUG, "Descriptor Block:\n\n");
 101     av_log(s, AV_LOG_DEBUG, "magic                = \"%c%c%c%c\"\n", ape_ctx->magic[0], ape_ctx->magic[1], ape_ctx->magic[2], ape_ctx->magic[3]);
 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     } else {
 130         for (i = 0; i < ape_ctx->seektablelength / sizeof(uint32_t); i++) {
 131             if (i < ape_ctx->totalframes - 1) {
 132                 av_log(s, AV_LOG_DEBUG, "%8d   %d (%d bytes)\n", i, ape_ctx->seektable[i], ape_ctx->seektable[i + 1] - ape_ctx->seektable[i]);
 133             } else {
 134                 av_log(s, AV_LOG_DEBUG, "%8d   %d\n", i, ape_ctx->seektable[i]);
 135             }
 136         }
 137     }
 138
 139     av_log(s, AV_LOG_DEBUG, "\nFrames\n\n");
 140     for (i = 0; i < ape_ctx->totalframes; i++)
 141         av_log(s, AV_LOG_DEBUG, "%8d   %8"PRId64" %8d (%d samples)\n", i,
 142                ape_ctx->frames[i].pos, ape_ctx->frames[i].size,
 143                ape_ctx->frames[i].nblocks);
 144
 145     av_log(s, AV_LOG_DEBUG, "\nCalculated information:\n\n");
 146     av_log(s, AV_LOG_DEBUG, "junklength           = %"PRIu32"\n", ape_ctx->junklength);
 147     av_log(s, AV_LOG_DEBUG, "firstframe           = %"PRIu32"\n", ape_ctx->firstframe);
 148     av_log(s, AV_LOG_DEBUG, "totalsamples         = %"PRIu32"\n", ape_ctx->totalsamples);
 149 #endif
 150 }
 151
 152 static int ape_read_header(AVFormatContext * s, AVFormatParameters * ap)
 153 {
 154     AVIOContext *pb = s->pb;
 155     APEContext *ape = s->priv_data;
 156     AVStream *st;
 157     uint32_t tag;
 158     int i;
 159     int total_blocks;
 160     int64_t pts;
 161
 162     /* Skip any leading junk such as id3v2 tags */
 163     ape->junklength = avio_tell(pb);
 164
 165     tag = avio_rl32(pb);
 166     if (tag != MKTAG('M', 'A', 'C', ' '))
 167         return -1;
 168
 169     ape->fileversion = avio_rl16(pb);
 170
 171     if (ape->fileversion < APE_MIN_VERSION || ape->fileversion > APE_MAX_VERSION) {
 172         av_log(s, AV_LOG_ERROR, "Unsupported file version - %"PRId16".%02"PRId16"\n",
 173                ape->fileversion / 1000, (ape->fileversion % 1000) / 10);
 174         return -1;
 175     }
 176
 177     if (ape->fileversion >= 3980) {
 178         ape->padding1             = avio_rl16(pb);
 179         ape->descriptorlength     = avio_rl32(pb);
 180         ape->headerlength         = avio_rl32(pb);
 181         ape->seektablelength      = avio_rl32(pb);
 182         ape->wavheaderlength      = avio_rl32(pb);
 183         ape->audiodatalength      = avio_rl32(pb);
 184         ape->audiodatalength_high = avio_rl32(pb);
 185         ape->wavtaillength        = avio_rl32(pb);
 186         avio_read(pb, ape->md5, 16);
 187
 188         /* Skip any unknown bytes at the end of the descriptor.
 189            This is for future compatibility */
 190         if (ape->descriptorlength > 52)
 191             avio_skip(pb, ape->descriptorlength - 52);
 192
 193         /* Read header data */
 194         ape->compressiontype      = avio_rl16(pb);
 195         ape->formatflags          = avio_rl16(pb);
 196         ape->blocksperframe       = avio_rl32(pb);
 197         ape->finalframeblocks     = avio_rl32(pb);
 198         ape->totalframes          = avio_rl32(pb);
 199         ape->bps                  = avio_rl16(pb);
 200         ape->channels             = avio_rl16(pb);
 201         ape->samplerate           = avio_rl32(pb);
 202     } else {
 203         ape->descriptorlength = 0;
 204         ape->headerlength = 32;
 205
 206         ape->compressiontype      = avio_rl16(pb);
 207         ape->formatflags          = avio_rl16(pb);
 208         ape->channels             = avio_rl16(pb);
 209         ape->samplerate           = avio_rl32(pb);
 210         ape->wavheaderlength      = avio_rl32(pb);
 211         ape->wavtaillength        = avio_rl32(pb);
 212         ape->totalframes          = avio_rl32(pb);
 213         ape->finalframeblocks     = avio_rl32(pb);
 214
 215         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_PEAK_LEVEL) {
 216             avio_skip(pb, 4); /* Skip the peak level */
 217             ape->headerlength += 4;
 218         }
 219
 220         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS) {
 221             ape->seektablelength = avio_rl32(pb);
 222             ape->headerlength += 4;
 223             ape->seektablelength *= sizeof(int32_t);
 224         } else
 225             ape->seektablelength = ape->totalframes * sizeof(int32_t);
 226
 227         if (ape->formatflags & MAC_FORMAT_FLAG_8_BIT)
 228             ape->bps = 8;
 229         else if (ape->formatflags & MAC_FORMAT_FLAG_24_BIT)
 230             ape->bps = 24;
 231         else
 232             ape->bps = 16;
 233
 234         if (ape->fileversion >= 3950)
 235             ape->blocksperframe = 73728 * 4;
 236         else if (ape->fileversion >= 3900 || (ape->fileversion >= 3800  && ape->compressiontype >= 4000))
 237             ape->blocksperframe = 73728;
 238         else
 239             ape->blocksperframe = 9216;
 240
 241         /* Skip any stored wav header */
 242         if (!(ape->formatflags & MAC_FORMAT_FLAG_CREATE_WAV_HEADER))
 243             avio_skip(pb, ape->wavheaderlength);
 244     }
 245
 246     if(!ape->totalframes){
 247         av_log(s, AV_LOG_ERROR, "No frames in the file!\n");
 248         return AVERROR(EINVAL);
 249     }
 250     if(ape->totalframes > UINT_MAX / sizeof(APEFrame)){
 251         av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n",
 252                ape->totalframes);
 253         return -1;
 254     }
 255     if (ape->seektablelength && (ape->seektablelength / sizeof(*ape->seektable)) < ape->totalframes) {
 256         av_log(s, AV_LOG_ERROR, "Number of seek entries is less than number of frames: %ld vs. %"PRIu32"\n",
 257                ape->seektablelength / sizeof(*ape->seektable), ape->totalframes);
 258         return AVERROR_INVALIDDATA;
 259     }
 260     ape->frames       = av_malloc(ape->totalframes * sizeof(APEFrame));
 261     if(!ape->frames)
 262         return AVERROR(ENOMEM);
 263     ape->firstframe   = ape->junklength + ape->descriptorlength + ape->headerlength + ape->seektablelength + ape->wavheaderlength;
 264     ape->currentframe = 0;
 265
 266
 267     ape->totalsamples = ape->finalframeblocks;
 268     if (ape->totalframes > 1)
 269         ape->totalsamples += ape->blocksperframe * (ape->totalframes - 1);
 270
 271     if (ape->seektablelength > 0) {
 272         ape->seektable = av_malloc(ape->seektablelength);
 273         if (!ape->seektable)
 274             return AVERROR(ENOMEM);
 275         for (i = 0; i < ape->seektablelength / sizeof(uint32_t); i++)
 276             ape->seektable[i] = avio_rl32(pb);
 277     }
 278
 279     ape->frames[0].pos     = ape->firstframe;
 280     ape->frames[0].nblocks = ape->blocksperframe;
 281     ape->frames[0].skip    = 0;
 282     for (i = 1; i < ape->totalframes; i++) {
 283         ape->frames[i].pos      = ape->seektable[i] + ape->junklength;
 284         ape->frames[i].nblocks  = ape->blocksperframe;
 285         ape->frames[i - 1].size = ape->frames[i].pos - ape->frames[i - 1].pos;
 286         ape->frames[i].skip     = (ape->frames[i].pos - ape->frames[0].pos) & 3;
 287     }
 288     ape->frames[ape->totalframes - 1].size    = ape->finalframeblocks * 4;
 289     ape->frames[ape->totalframes - 1].nblocks = ape->finalframeblocks;
 290
 291     for (i = 0; i < ape->totalframes; i++) {
 292         if(ape->frames[i].skip){
 293             ape->frames[i].pos  -= ape->frames[i].skip;
 294             ape->frames[i].size += ape->frames[i].skip;
 295         }
 296         ape->frames[i].size = (ape->frames[i].size + 3) & ~3;
 297     }
 298
 299
 300     ape_dumpinfo(s, ape);
 301
 302     /* try to read APE tags */
 303     if (pb->seekable) {
 304         ff_ape_parse_tag(s);
 305         avio_seek(pb, 0, SEEK_SET);
 306     }
 307
 308     av_log(s, AV_LOG_DEBUG, "Decoding file - v%d.%02d, compression level %"PRIu16"\n",
 309            ape->fileversion / 1000, (ape->fileversion % 1000) / 10,
 310            ape->compressiontype);
 311
 312     /* now we are ready: build format streams */
 313     st = av_new_stream(s, 0);
 314     if (!st)
 315         return -1;
 316
 317     total_blocks = (ape->totalframes == 0) ? 0 : ((ape->totalframes - 1) * ape->blocksperframe) + ape->finalframeblocks;
 318
 319     st->codec->codec_type      = AVMEDIA_TYPE_AUDIO;
 320     st->codec->codec_id        = CODEC_ID_APE;
 321     st->codec->codec_tag       = MKTAG('A', 'P', 'E', ' ');
 322     st->codec->channels        = ape->channels;
 323     st->codec->sample_rate     = ape->samplerate;
 324     st->codec->bits_per_coded_sample = ape->bps;
 325     st->codec->frame_size      = MAC_SUBFRAME_SIZE;
 326
 327     st->nb_frames = ape->totalframes;
 328     st->start_time = 0;
 329     st->duration  = total_blocks / MAC_SUBFRAME_SIZE;
 330     av_set_pts_info(st, 64, MAC_SUBFRAME_SIZE, ape->samplerate);
 331
 332     st->codec->extradata = av_malloc(APE_EXTRADATA_SIZE);
 333     st->codec->extradata_size = APE_EXTRADATA_SIZE;
 334     AV_WL16(st->codec->extradata + 0, ape->fileversion);
 335     AV_WL16(st->codec->extradata + 2, ape->compressiontype);
 336     AV_WL16(st->codec->extradata + 4, ape->formatflags);
 337
 338     pts = 0;
 339     for (i = 0; i < ape->totalframes; i++) {
 340         ape->frames[i].pts = pts;
 341         av_add_index_entry(st, ape->frames[i].pos, ape->frames[i].pts, 0, 0, AVINDEX_KEYFRAME);
 342         pts += ape->blocksperframe / MAC_SUBFRAME_SIZE;
 343     }
 344
 345     return 0;
 346 }
 347
 348 static int ape_read_packet(AVFormatContext * s, AVPacket * pkt)
 349 {
 350     int ret;
 351     int nblocks;
 352     APEContext *ape = s->priv_data;
 353     uint32_t extra_size = 8;
 354
 355     if (url_feof(s->pb))
 356         return AVERROR(EIO);
 357     if (ape->currentframe > ape->totalframes)
 358         return AVERROR(EIO);
 359
 360     avio_seek (s->pb, ape->frames[ape->currentframe].pos, SEEK_SET);
 361
 362     /* Calculate how many blocks there are in this frame */
 363     if (ape->currentframe == (ape->totalframes - 1))
 364         nblocks = ape->finalframeblocks;
 365     else
 366         nblocks = ape->blocksperframe;
 367
 368     if (av_new_packet(pkt,  ape->frames[ape->currentframe].size + extra_size) < 0)
 369         return AVERROR(ENOMEM);
 370
 371     AV_WL32(pkt->data    , nblocks);
 372     AV_WL32(pkt->data + 4, ape->frames[ape->currentframe].skip);
 373     ret = avio_read(s->pb, pkt->data + extra_size, ape->frames[ape->currentframe].size);
 374
 375     pkt->pts = ape->frames[ape->currentframe].pts;
 376     pkt->stream_index = 0;
 377
 378     /* note: we need to modify the packet size here to handle the last
 379        packet */
 380     pkt->size = ret + extra_size;
 381
 382     ape->currentframe++;
 383
 384     return 0;
 385 }
 386
 387 static int ape_read_close(AVFormatContext * s)
 388 {
 389     APEContext *ape = s->priv_data;
 390
 391     av_freep(&ape->frames);
 392     av_freep(&ape->seektable);
 393     return 0;
 394 }
 395
 396 static int ape_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
 397 {
 398     AVStream *st = s->streams[stream_index];
 399     APEContext *ape = s->priv_data;
 400     int index = av_index_search_timestamp(st, timestamp, flags);
 401
 402     if (index < 0)
 403         return -1;
 404
 405     ape->currentframe = index;
 406     return 0;
 407 }
 408
 409 AVInputFormat ff_ape_demuxer = {
 410     "ape",
 411     NULL_IF_CONFIG_SMALL("Monkey's Audio"),
 412     sizeof(APEContext),
 413     ape_probe,
 414     ape_read_header,
 415     ape_read_packet,
 416     ape_read_close,
 417     ape_read_seek,
 418     .extensions = "ape,apl,mac"
 419 };