2 * Monkey's Audio APE demuxer
3 * Copyright (c) 2007 Benjamin Zores <ben@geexbox.org>
4 * based upon libdemac from Dave Chapman.
6 * This file is part of FFmpeg.
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.
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.
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
25 #include "libavutil/intreadwrite.h"
29 /* The earliest and latest file formats supported by this library */
30 #define APE_MIN_VERSION 3950
31 #define APE_MAX_VERSION 3990
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)
40 #define MAC_SUBFRAME_SIZE 4608
42 #define APE_EXTRADATA_SIZE 6
56 uint32_t totalsamples;
60 /* Info from Descriptor Block */
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;
73 /* Info from Header Block */
74 uint16_t compressiontype;
76 uint32_t blocksperframe;
77 uint32_t finalframeblocks;
87 static int ape_probe(AVProbeData * p)
89 if (p->buf[0] == 'M' && p->buf[1] == 'A' && p->buf[2] == 'C' && p->buf[3] == ' ')
90 return AVPROBE_SCORE_MAX;
95 static void ape_dumpinfo(AVFormatContext * s, APEContext * ape_ctx)
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");
115 av_log(s, AV_LOG_DEBUG, "\nHeader Block:\n\n");
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);
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");
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]);
134 av_log(s, AV_LOG_DEBUG, "%8d %d\n", i, ape_ctx->seektable[i]);
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);
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);
152 static int ape_read_header(AVFormatContext * s, AVFormatParameters * ap)
154 AVIOContext *pb = s->pb;
155 APEContext *ape = s->priv_data;
162 /* Skip any leading junk such as id3v2 tags */
163 ape->junklength = avio_tell(pb);
166 if (tag != MKTAG('M', 'A', 'C', ' '))
169 ape->fileversion = avio_rl16(pb);
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);
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);
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);
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);
203 ape->descriptorlength = 0;
204 ape->headerlength = 32;
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);
215 if (ape->formatflags & MAC_FORMAT_FLAG_HAS_PEAK_LEVEL) {
216 avio_skip(pb, 4); /* Skip the peak level */
217 ape->headerlength += 4;
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);
225 ape->seektablelength = ape->totalframes * sizeof(int32_t);
227 if (ape->formatflags & MAC_FORMAT_FLAG_8_BIT)
229 else if (ape->formatflags & MAC_FORMAT_FLAG_24_BIT)
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;
239 ape->blocksperframe = 9216;
241 /* Skip any stored wav header */
242 if (!(ape->formatflags & MAC_FORMAT_FLAG_CREATE_WAV_HEADER))
243 avio_skip(pb, ape->wavheaderlength);
246 if(!ape->totalframes){
247 av_log(s, AV_LOG_ERROR, "No frames in the file!\n");
248 return AVERROR(EINVAL);
250 if(ape->totalframes > UINT_MAX / sizeof(APEFrame)){
251 av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n",
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;
260 ape->frames = av_malloc(ape->totalframes * sizeof(APEFrame));
262 return AVERROR(ENOMEM);
263 ape->firstframe = ape->junklength + ape->descriptorlength + ape->headerlength + ape->seektablelength + ape->wavheaderlength;
264 ape->currentframe = 0;
267 ape->totalsamples = ape->finalframeblocks;
268 if (ape->totalframes > 1)
269 ape->totalsamples += ape->blocksperframe * (ape->totalframes - 1);
271 if (ape->seektablelength > 0) {
272 ape->seektable = av_malloc(ape->seektablelength);
273 for (i = 0; i < ape->seektablelength / sizeof(uint32_t); i++)
274 ape->seektable[i] = avio_rl32(pb);
277 ape->frames[0].pos = ape->firstframe;
278 ape->frames[0].nblocks = ape->blocksperframe;
279 ape->frames[0].skip = 0;
280 for (i = 1; i < ape->totalframes; i++) {
281 ape->frames[i].pos = ape->seektable[i] + ape->junklength;
282 ape->frames[i].nblocks = ape->blocksperframe;
283 ape->frames[i - 1].size = ape->frames[i].pos - ape->frames[i - 1].pos;
284 ape->frames[i].skip = (ape->frames[i].pos - ape->frames[0].pos) & 3;
286 ape->frames[ape->totalframes - 1].size = ape->finalframeblocks * 4;
287 ape->frames[ape->totalframes - 1].nblocks = ape->finalframeblocks;
289 for (i = 0; i < ape->totalframes; i++) {
290 if(ape->frames[i].skip){
291 ape->frames[i].pos -= ape->frames[i].skip;
292 ape->frames[i].size += ape->frames[i].skip;
294 ape->frames[i].size = (ape->frames[i].size + 3) & ~3;
298 ape_dumpinfo(s, ape);
300 /* try to read APE tags */
303 avio_seek(pb, 0, SEEK_SET);
306 av_log(s, AV_LOG_DEBUG, "Decoding file - v%d.%02d, compression level %"PRIu16"\n",
307 ape->fileversion / 1000, (ape->fileversion % 1000) / 10,
308 ape->compressiontype);
310 /* now we are ready: build format streams */
311 st = av_new_stream(s, 0);
315 total_blocks = (ape->totalframes == 0) ? 0 : ((ape->totalframes - 1) * ape->blocksperframe) + ape->finalframeblocks;
317 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
318 st->codec->codec_id = CODEC_ID_APE;
319 st->codec->codec_tag = MKTAG('A', 'P', 'E', ' ');
320 st->codec->channels = ape->channels;
321 st->codec->sample_rate = ape->samplerate;
322 st->codec->bits_per_coded_sample = ape->bps;
323 st->codec->frame_size = MAC_SUBFRAME_SIZE;
325 st->nb_frames = ape->totalframes;
327 st->duration = total_blocks / MAC_SUBFRAME_SIZE;
328 av_set_pts_info(st, 64, MAC_SUBFRAME_SIZE, ape->samplerate);
330 st->codec->extradata = av_malloc(APE_EXTRADATA_SIZE);
331 st->codec->extradata_size = APE_EXTRADATA_SIZE;
332 AV_WL16(st->codec->extradata + 0, ape->fileversion);
333 AV_WL16(st->codec->extradata + 2, ape->compressiontype);
334 AV_WL16(st->codec->extradata + 4, ape->formatflags);
337 for (i = 0; i < ape->totalframes; i++) {
338 ape->frames[i].pts = pts;
339 av_add_index_entry(st, ape->frames[i].pos, ape->frames[i].pts, 0, 0, AVINDEX_KEYFRAME);
340 pts += ape->blocksperframe / MAC_SUBFRAME_SIZE;
346 static int ape_read_packet(AVFormatContext * s, AVPacket * pkt)
350 APEContext *ape = s->priv_data;
351 uint32_t extra_size = 8;
355 if (ape->currentframe > ape->totalframes)
358 avio_seek (s->pb, ape->frames[ape->currentframe].pos, SEEK_SET);
360 /* Calculate how many blocks there are in this frame */
361 if (ape->currentframe == (ape->totalframes - 1))
362 nblocks = ape->finalframeblocks;
364 nblocks = ape->blocksperframe;
366 if (av_new_packet(pkt, ape->frames[ape->currentframe].size + extra_size) < 0)
367 return AVERROR(ENOMEM);
369 AV_WL32(pkt->data , nblocks);
370 AV_WL32(pkt->data + 4, ape->frames[ape->currentframe].skip);
371 ret = avio_read(s->pb, pkt->data + extra_size, ape->frames[ape->currentframe].size);
373 pkt->pts = ape->frames[ape->currentframe].pts;
374 pkt->stream_index = 0;
376 /* note: we need to modify the packet size here to handle the last
378 pkt->size = ret + extra_size;
385 static int ape_read_close(AVFormatContext * s)
387 APEContext *ape = s->priv_data;
389 av_freep(&ape->frames);
390 av_freep(&ape->seektable);
394 static int ape_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
396 AVStream *st = s->streams[stream_index];
397 APEContext *ape = s->priv_data;
398 int index = av_index_search_timestamp(st, timestamp, flags);
403 ape->currentframe = index;
407 AVInputFormat ff_ape_demuxer = {
409 NULL_IF_CONFIG_SMALL("Monkey's Audio"),
416 .extensions = "ape,apl,mac"