libavformat/ape.c
bf4a1f17
 /*
  * Monkey's Audio APE demuxer
  * Copyright (c) 2007 Benjamin Zores <ben@geexbox.org>
  *  based upon libdemac from Dave Chapman.
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include <stdio.h>
 
6a5d31ac
 #include "libavutil/intreadwrite.h"
bf4a1f17
 #include "avformat.h"
c3f9ebf7
 #include "internal.h"
191e34cd
 #include "apetag.h"
bf4a1f17
 
 /* The earliest and latest file formats supported by this library */
613a37ec
 #define APE_MIN_VERSION 3800
bf4a1f17
 #define APE_MAX_VERSION 3990
 
 #define MAC_FORMAT_FLAG_8_BIT                 1 // is 8-bit [OBSOLETE]
 #define MAC_FORMAT_FLAG_CRC                   2 // uses the new CRC32 error detection [OBSOLETE]
 #define MAC_FORMAT_FLAG_HAS_PEAK_LEVEL        4 // uint32 nPeakLevel after the header [OBSOLETE]
 #define MAC_FORMAT_FLAG_24_BIT                8 // is 24-bit [OBSOLETE]
 #define MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS    16 // has the number of seek elements after the peak level
 #define MAC_FORMAT_FLAG_CREATE_WAV_HEADER    32 // create the wave header on decompression (not stored)
 
 #define APE_EXTRADATA_SIZE 6
 
daf8cf35
 typedef struct APEFrame {
bf4a1f17
     int64_t pos;
     int nblocks;
     int size;
     int skip;
     int64_t pts;
 } APEFrame;
 
daf8cf35
 typedef struct APEContext {
bf4a1f17
     /* Derived fields */
     uint32_t junklength;
     uint32_t firstframe;
     uint32_t totalsamples;
     int currentframe;
     APEFrame *frames;
 
     /* Info from Descriptor Block */
     int16_t fileversion;
     int16_t padding1;
     uint32_t descriptorlength;
     uint32_t headerlength;
     uint32_t seektablelength;
     uint32_t wavheaderlength;
     uint32_t audiodatalength;
     uint32_t audiodatalength_high;
     uint32_t wavtaillength;
     uint8_t md5[16];
 
     /* Info from Header Block */
     uint16_t compressiontype;
     uint16_t formatflags;
     uint32_t blocksperframe;
     uint32_t finalframeblocks;
     uint32_t totalframes;
     uint16_t bps;
     uint16_t channels;
     uint32_t samplerate;
 
     /* Seektable */
     uint32_t *seektable;
613a37ec
     uint8_t  *bittable;
bf4a1f17
 } APEContext;
 
 static int ape_probe(AVProbeData * p)
 {
b5708352
     int version = AV_RL16(p->buf+4);
     if (AV_RL32(p->buf) != MKTAG('M', 'A', 'C', ' '))
         return 0;
bf4a1f17
 
b5708352
     if (version < APE_MIN_VERSION || version > APE_MAX_VERSION)
         return AVPROBE_SCORE_MAX/4;
 
     return AVPROBE_SCORE_MAX;
bf4a1f17
 }
 
76b9092f
 static void ape_dumpinfo(AVFormatContext * s, APEContext * ape_ctx)
bf4a1f17
 {
f190f676
 #ifdef DEBUG
bf4a1f17
     int i;
 
76b9092f
     av_log(s, AV_LOG_DEBUG, "Descriptor Block:\n\n");
b0a4e5f9
     av_log(s, AV_LOG_DEBUG, "fileversion          = %"PRId16"\n", ape_ctx->fileversion);
     av_log(s, AV_LOG_DEBUG, "descriptorlength     = %"PRIu32"\n", ape_ctx->descriptorlength);
     av_log(s, AV_LOG_DEBUG, "headerlength         = %"PRIu32"\n", ape_ctx->headerlength);
     av_log(s, AV_LOG_DEBUG, "seektablelength      = %"PRIu32"\n", ape_ctx->seektablelength);
     av_log(s, AV_LOG_DEBUG, "wavheaderlength      = %"PRIu32"\n", ape_ctx->wavheaderlength);
     av_log(s, AV_LOG_DEBUG, "audiodatalength      = %"PRIu32"\n", ape_ctx->audiodatalength);
     av_log(s, AV_LOG_DEBUG, "audiodatalength_high = %"PRIu32"\n", ape_ctx->audiodatalength_high);
     av_log(s, AV_LOG_DEBUG, "wavtaillength        = %"PRIu32"\n", ape_ctx->wavtaillength);
76b9092f
     av_log(s, AV_LOG_DEBUG, "md5                  = ");
bf4a1f17
     for (i = 0; i < 16; i++)
76b9092f
          av_log(s, AV_LOG_DEBUG, "%02x", ape_ctx->md5[i]);
     av_log(s, AV_LOG_DEBUG, "\n");
bf4a1f17
 
76b9092f
     av_log(s, AV_LOG_DEBUG, "\nHeader Block:\n\n");
bf4a1f17
 
b0a4e5f9
     av_log(s, AV_LOG_DEBUG, "compressiontype      = %"PRIu16"\n", ape_ctx->compressiontype);
     av_log(s, AV_LOG_DEBUG, "formatflags          = %"PRIu16"\n", ape_ctx->formatflags);
     av_log(s, AV_LOG_DEBUG, "blocksperframe       = %"PRIu32"\n", ape_ctx->blocksperframe);
     av_log(s, AV_LOG_DEBUG, "finalframeblocks     = %"PRIu32"\n", ape_ctx->finalframeblocks);
     av_log(s, AV_LOG_DEBUG, "totalframes          = %"PRIu32"\n", ape_ctx->totalframes);
     av_log(s, AV_LOG_DEBUG, "bps                  = %"PRIu16"\n", ape_ctx->bps);
     av_log(s, AV_LOG_DEBUG, "channels             = %"PRIu16"\n", ape_ctx->channels);
     av_log(s, AV_LOG_DEBUG, "samplerate           = %"PRIu32"\n", ape_ctx->samplerate);
bf4a1f17
 
76b9092f
     av_log(s, AV_LOG_DEBUG, "\nSeektable\n\n");
bf4a1f17
     if ((ape_ctx->seektablelength / sizeof(uint32_t)) != ape_ctx->totalframes) {
76b9092f
         av_log(s, AV_LOG_DEBUG, "No seektable\n");
bf4a1f17
     } else {
         for (i = 0; i < ape_ctx->seektablelength / sizeof(uint32_t); i++) {
             if (i < ape_ctx->totalframes - 1) {
613a37ec
                 av_log(s, AV_LOG_DEBUG, "%8d   %"PRIu32" (%"PRIu32" bytes)",
ab3d241b
                        i, ape_ctx->seektable[i],
                        ape_ctx->seektable[i + 1] - ape_ctx->seektable[i]);
7857ddce
                 if (ape_ctx->bittable)
613a37ec
                     av_log(s, AV_LOG_DEBUG, " + %2d bits\n",
                            ape_ctx->bittable[i]);
                 av_log(s, AV_LOG_DEBUG, "\n");
bf4a1f17
             } else {
ab3d241b
                 av_log(s, AV_LOG_DEBUG, "%8d   %"PRIu32"\n", i, ape_ctx->seektable[i]);
bf4a1f17
             }
         }
     }
 
76b9092f
     av_log(s, AV_LOG_DEBUG, "\nFrames\n\n");
bf4a1f17
     for (i = 0; i < ape_ctx->totalframes; i++)
b0a4e5f9
         av_log(s, AV_LOG_DEBUG, "%8d   %8"PRId64" %8d (%d samples)\n", i,
                ape_ctx->frames[i].pos, ape_ctx->frames[i].size,
                ape_ctx->frames[i].nblocks);
bf4a1f17
 
76b9092f
     av_log(s, AV_LOG_DEBUG, "\nCalculated information:\n\n");
b0a4e5f9
     av_log(s, AV_LOG_DEBUG, "junklength           = %"PRIu32"\n", ape_ctx->junklength);
     av_log(s, AV_LOG_DEBUG, "firstframe           = %"PRIu32"\n", ape_ctx->firstframe);
     av_log(s, AV_LOG_DEBUG, "totalsamples         = %"PRIu32"\n", ape_ctx->totalsamples);
7f559eb1
 #endif
bf4a1f17
 }
 
6e9651d1
 static int ape_read_header(AVFormatContext * s)
bf4a1f17
 {
471fe57e
     AVIOContext *pb = s->pb;
bf4a1f17
     APEContext *ape = s->priv_data;
     AVStream *st;
     uint32_t tag;
     int i;
ac3f8d31
     int total_blocks, final_size = 0;
     int64_t pts, file_size;
bf4a1f17
 
88f8805f
     /* Skip any leading junk such as id3v2 tags */
     ape->junklength = avio_tell(pb);
bf4a1f17
 
e63a3628
     tag = avio_rl32(pb);
bf4a1f17
     if (tag != MKTAG('M', 'A', 'C', ' '))
7510a9a4
         return AVERROR_INVALIDDATA;
bf4a1f17
 
e63a3628
     ape->fileversion = avio_rl16(pb);
bf4a1f17
 
     if (ape->fileversion < APE_MIN_VERSION || ape->fileversion > APE_MAX_VERSION) {
ab3d241b
         av_log(s, AV_LOG_ERROR, "Unsupported file version - %d.%02d\n",
b0a4e5f9
                ape->fileversion / 1000, (ape->fileversion % 1000) / 10);
7510a9a4
         return AVERROR_PATCHWELCOME;
bf4a1f17
     }
 
     if (ape->fileversion >= 3980) {
e63a3628
         ape->padding1             = avio_rl16(pb);
         ape->descriptorlength     = avio_rl32(pb);
         ape->headerlength         = avio_rl32(pb);
         ape->seektablelength      = avio_rl32(pb);
         ape->wavheaderlength      = avio_rl32(pb);
         ape->audiodatalength      = avio_rl32(pb);
         ape->audiodatalength_high = avio_rl32(pb);
         ape->wavtaillength        = avio_rl32(pb);
         avio_read(pb, ape->md5, 16);
bf4a1f17
 
         /* Skip any unknown bytes at the end of the descriptor.
            This is for future compatibility */
         if (ape->descriptorlength > 52)
45a8a02a
             avio_skip(pb, ape->descriptorlength - 52);
bf4a1f17
 
         /* Read header data */
e63a3628
         ape->compressiontype      = avio_rl16(pb);
         ape->formatflags          = avio_rl16(pb);
         ape->blocksperframe       = avio_rl32(pb);
         ape->finalframeblocks     = avio_rl32(pb);
         ape->totalframes          = avio_rl32(pb);
         ape->bps                  = avio_rl16(pb);
         ape->channels             = avio_rl16(pb);
         ape->samplerate           = avio_rl32(pb);
bf4a1f17
     } else {
         ape->descriptorlength = 0;
         ape->headerlength = 32;
 
e63a3628
         ape->compressiontype      = avio_rl16(pb);
         ape->formatflags          = avio_rl16(pb);
         ape->channels             = avio_rl16(pb);
         ape->samplerate           = avio_rl32(pb);
         ape->wavheaderlength      = avio_rl32(pb);
         ape->wavtaillength        = avio_rl32(pb);
         ape->totalframes          = avio_rl32(pb);
         ape->finalframeblocks     = avio_rl32(pb);
bf4a1f17
 
         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_PEAK_LEVEL) {
45a8a02a
             avio_skip(pb, 4); /* Skip the peak level */
bf4a1f17
             ape->headerlength += 4;
         }
 
         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS) {
e63a3628
             ape->seektablelength = avio_rl32(pb);
bf4a1f17
             ape->headerlength += 4;
             ape->seektablelength *= sizeof(int32_t);
         } else
             ape->seektablelength = ape->totalframes * sizeof(int32_t);
 
         if (ape->formatflags & MAC_FORMAT_FLAG_8_BIT)
             ape->bps = 8;
         else if (ape->formatflags & MAC_FORMAT_FLAG_24_BIT)
             ape->bps = 24;
         else
             ape->bps = 16;
 
         if (ape->fileversion >= 3950)
             ape->blocksperframe = 73728 * 4;
         else if (ape->fileversion >= 3900 || (ape->fileversion >= 3800  && ape->compressiontype >= 4000))
             ape->blocksperframe = 73728;
         else
             ape->blocksperframe = 9216;
 
         /* Skip any stored wav header */
         if (!(ape->formatflags & MAC_FORMAT_FLAG_CREATE_WAV_HEADER))
45a8a02a
             avio_skip(pb, ape->wavheaderlength);
bf4a1f17
     }
 
1c31b26b
     if(!ape->totalframes){
         av_log(s, AV_LOG_ERROR, "No frames in the file!\n");
         return AVERROR(EINVAL);
     }
bf4a1f17
     if(ape->totalframes > UINT_MAX / sizeof(APEFrame)){
b0a4e5f9
         av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n",
                ape->totalframes);
7510a9a4
         return AVERROR_INVALIDDATA;
bf4a1f17
     }
183b9d84
     if (ape->seektablelength / sizeof(*ape->seektable) < ape->totalframes) {
ab3d241b
         av_log(s, AV_LOG_ERROR,
ced0d6c1
                "Number of seek entries is less than number of frames: %"SIZE_SPECIFIER" vs. %"PRIu32"\n",
29a29043
                ape->seektablelength / sizeof(*ape->seektable), ape->totalframes);
         return AVERROR_INVALIDDATA;
     }
f289422a
     ape->frames       = av_malloc_array(ape->totalframes, sizeof(APEFrame));
bf4a1f17
     if(!ape->frames)
2874c81c
         return AVERROR(ENOMEM);
bf4a1f17
     ape->firstframe   = ape->junklength + ape->descriptorlength + ape->headerlength + ape->seektablelength + ape->wavheaderlength;
613a37ec
     if (ape->fileversion < 3810)
         ape->firstframe += ape->totalframes;
bf4a1f17
     ape->currentframe = 0;
 
 
     ape->totalsamples = ape->finalframeblocks;
     if (ape->totalframes > 1)
         ape->totalsamples += ape->blocksperframe * (ape->totalframes - 1);
 
     if (ape->seektablelength > 0) {
3cfa310c
         ape->seektable = av_mallocz(ape->seektablelength);
1632a576
         if (!ape->seektable)
             return AVERROR(ENOMEM);
488b2984
         for (i = 0; i < ape->seektablelength / sizeof(uint32_t) && !pb->eof_reached; i++)
e63a3628
             ape->seektable[i] = avio_rl32(pb);
613a37ec
         if (ape->fileversion < 3810) {
3cfa310c
             ape->bittable = av_mallocz(ape->totalframes);
613a37ec
             if (!ape->bittable)
                 return AVERROR(ENOMEM);
488b2984
             for (i = 0; i < ape->totalframes && !pb->eof_reached; i++)
613a37ec
                 ape->bittable[i] = avio_r8(pb);
         }
3cfa310c
         if (pb->eof_reached)
             av_log(s, AV_LOG_WARNING, "File truncated\n");
bf4a1f17
     }
 
     ape->frames[0].pos     = ape->firstframe;
     ape->frames[0].nblocks = ape->blocksperframe;
     ape->frames[0].skip    = 0;
     for (i = 1; i < ape->totalframes; i++) {
ab088f7d
         ape->frames[i].pos      = ape->seektable[i] + ape->junklength;
bf4a1f17
         ape->frames[i].nblocks  = ape->blocksperframe;
         ape->frames[i - 1].size = ape->frames[i].pos - ape->frames[i - 1].pos;
         ape->frames[i].skip     = (ape->frames[i].pos - ape->frames[0].pos) & 3;
     }
     ape->frames[ape->totalframes - 1].nblocks = ape->finalframeblocks;
ac3f8d31
     /* calculate final packet size from total file size, if available */
     file_size = avio_size(pb);
     if (file_size > 0) {
         final_size = file_size - ape->frames[ape->totalframes - 1].pos -
                      ape->wavtaillength;
         final_size -= final_size & 3;
     }
     if (file_size <= 0 || final_size <= 0)
         final_size = ape->finalframeblocks * 8;
     ape->frames[ape->totalframes - 1].size = final_size;
bf4a1f17
 
     for (i = 0; i < ape->totalframes; i++) {
         if(ape->frames[i].skip){
             ape->frames[i].pos  -= ape->frames[i].skip;
             ape->frames[i].size += ape->frames[i].skip;
         }
         ape->frames[i].size = (ape->frames[i].size + 3) & ~3;
     }
613a37ec
     if (ape->fileversion < 3810) {
         for (i = 0; i < ape->totalframes; i++) {
             if (i < ape->totalframes - 1 && ape->bittable[i + 1])
                 ape->frames[i].size += 4;
             ape->frames[i].skip <<= 3;
             ape->frames[i].skip  += ape->bittable[i];
         }
     }
bf4a1f17
 
76b9092f
     ape_dumpinfo(s, ape);
bf4a1f17
 
9cf8c3e6
     av_log(s, AV_LOG_VERBOSE, "Decoding file - v%d.%02d, compression level %"PRIu16"\n",
b0a4e5f9
            ape->fileversion / 1000, (ape->fileversion % 1000) / 10,
            ape->compressiontype);
bf4a1f17
 
     /* now we are ready: build format streams */
3b3bbdd3
     st = avformat_new_stream(s, NULL);
bf4a1f17
     if (!st)
7510a9a4
         return AVERROR(ENOMEM);
bf4a1f17
 
     total_blocks = (ape->totalframes == 0) ? 0 : ((ape->totalframes - 1) * ape->blocksperframe) + ape->finalframeblocks;
 
9200514a
     st->codecpar->codec_type      = AVMEDIA_TYPE_AUDIO;
     st->codecpar->codec_id        = AV_CODEC_ID_APE;
     st->codecpar->codec_tag       = MKTAG('A', 'P', 'E', ' ');
     st->codecpar->channels        = ape->channels;
     st->codecpar->sample_rate     = ape->samplerate;
     st->codecpar->bits_per_coded_sample = ape->bps;
bf4a1f17
 
     st->nb_frames = ape->totalframes;
0fc07ad9
     st->start_time = 0;
732dfc76
     st->duration  = total_blocks;
     avpriv_set_pts_info(st, 64, 1, ape->samplerate);
bf4a1f17
 
6f69f7a8
     if (ff_alloc_extradata(st->codecpar, APE_EXTRADATA_SIZE))
a807c682
         return AVERROR(ENOMEM);
9200514a
     AV_WL16(st->codecpar->extradata + 0, ape->fileversion);
     AV_WL16(st->codecpar->extradata + 2, ape->compressiontype);
     AV_WL16(st->codecpar->extradata + 4, ape->formatflags);
bf4a1f17
 
     pts = 0;
     for (i = 0; i < ape->totalframes; i++) {
         ape->frames[i].pts = pts;
         av_add_index_entry(st, ape->frames[i].pos, ape->frames[i].pts, 0, 0, AVINDEX_KEYFRAME);
732dfc76
         pts += ape->blocksperframe;
bf4a1f17
     }
 
980e65f1
     /* try to read APE tags */
83548fe8
     if (pb->seekable & AVIO_SEEKABLE_NORMAL) {
980e65f1
         ff_ape_parse_tag(s);
         avio_seek(pb, 0, SEEK_SET);
     }
 
bf4a1f17
     return 0;
 }
 
 static int ape_read_packet(AVFormatContext * s, AVPacket * pkt)
 {
     int ret;
     int nblocks;
     APEContext *ape = s->priv_data;
     uint32_t extra_size = 8;
 
d34ec64a
     if (avio_feof(s->pb))
66f7be36
         return AVERROR_EOF;
c2c31615
     if (ape->currentframe >= ape->totalframes)
66f7be36
         return AVERROR_EOF;
bf4a1f17
 
1bc035bc
     if (avio_seek(s->pb, ape->frames[ape->currentframe].pos, SEEK_SET) < 0)
         return AVERROR(EIO);
bf4a1f17
 
     /* Calculate how many blocks there are in this frame */
     if (ape->currentframe == (ape->totalframes - 1))
         nblocks = ape->finalframeblocks;
     else
         nblocks = ape->blocksperframe;
 
f1c3d4a6
     if (ape->frames[ape->currentframe].size <= 0 ||
         ape->frames[ape->currentframe].size > INT_MAX - extra_size) {
         av_log(s, AV_LOG_ERROR, "invalid packet size: %d\n",
                ape->frames[ape->currentframe].size);
         ape->currentframe++;
         return AVERROR(EIO);
     }
 
bf4a1f17
     if (av_new_packet(pkt,  ape->frames[ape->currentframe].size + extra_size) < 0)
2874c81c
         return AVERROR(ENOMEM);
bf4a1f17
 
     AV_WL32(pkt->data    , nblocks);
     AV_WL32(pkt->data + 4, ape->frames[ape->currentframe].skip);
e63a3628
     ret = avio_read(s->pb, pkt->data + extra_size, ape->frames[ape->currentframe].size);
459db512
     if (ret < 0) {
c2f861ca
         av_packet_unref(pkt);
a5ef7960
         return ret;
459db512
     }
bf4a1f17
 
     pkt->pts = ape->frames[ape->currentframe].pts;
     pkt->stream_index = 0;
 
     /* note: we need to modify the packet size here to handle the last
        packet */
     pkt->size = ret + extra_size;
 
     ape->currentframe++;
 
     return 0;
 }
 
 static int ape_read_close(AVFormatContext * s)
 {
     APEContext *ape = s->priv_data;
 
     av_freep(&ape->frames);
     av_freep(&ape->seektable);
613a37ec
     av_freep(&ape->bittable);
bf4a1f17
     return 0;
 }
 
 static int ape_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
 {
     AVStream *st = s->streams[stream_index];
     APEContext *ape = s->priv_data;
     int index = av_index_search_timestamp(st, timestamp, flags);
 
     if (index < 0)
         return -1;
 
86b57e4e
     if (avio_seek(s->pb, st->index_entries[index].pos, SEEK_SET) < 0)
         return -1;
bf4a1f17
     ape->currentframe = index;
     return 0;
 }
 
66355be3
 AVInputFormat ff_ape_demuxer = {
dfc2c4d9
     .name           = "ape",
     .long_name      = NULL_IF_CONFIG_SMALL("Monkey's Audio"),
     .priv_data_size = sizeof(APEContext),
     .read_probe     = ape_probe,
     .read_header    = ape_read_header,
     .read_packet    = ape_read_packet,
     .read_close     = ape_read_close,
     .read_seek      = ape_read_seek,
20234a4b
     .extensions     = "ape,apl,mac",
bf4a1f17
 };