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 %"PRIu32" (%"PRIu32" bytes)\n",
133 i, ape_ctx->seektable[i],
134 ape_ctx->seektable[i + 1] - ape_ctx->seektable[i]);
136 av_log(s, AV_LOG_DEBUG, "%8d %"PRIu32"\n", i, ape_ctx->seektable[i]);
141 av_log(s, AV_LOG_DEBUG, "\nFrames\n\n");
142 for (i = 0; i < ape_ctx->totalframes; i++)
143 av_log(s, AV_LOG_DEBUG, "%8d %8"PRId64" %8d (%d samples)\n", i,
144 ape_ctx->frames[i].pos, ape_ctx->frames[i].size,
145 ape_ctx->frames[i].nblocks);
147 av_log(s, AV_LOG_DEBUG, "\nCalculated information:\n\n");
148 av_log(s, AV_LOG_DEBUG, "junklength = %"PRIu32"\n", ape_ctx->junklength);
149 av_log(s, AV_LOG_DEBUG, "firstframe = %"PRIu32"\n", ape_ctx->firstframe);
150 av_log(s, AV_LOG_DEBUG, "totalsamples = %"PRIu32"\n", ape_ctx->totalsamples);
154 static int ape_read_header(AVFormatContext * s, AVFormatParameters * ap)
156 AVIOContext *pb = s->pb;
157 APEContext *ape = s->priv_data;
164 /* Skip any leading junk such as id3v2 tags */
165 ape->junklength = avio_tell(pb);
168 if (tag != MKTAG('M', 'A', 'C', ' '))
171 ape->fileversion = avio_rl16(pb);
173 if (ape->fileversion < APE_MIN_VERSION || ape->fileversion > APE_MAX_VERSION) {
174 av_log(s, AV_LOG_ERROR, "Unsupported file version - %d.%02d\n",
175 ape->fileversion / 1000, (ape->fileversion % 1000) / 10);
179 if (ape->fileversion >= 3980) {
180 ape->padding1 = avio_rl16(pb);
181 ape->descriptorlength = avio_rl32(pb);
182 ape->headerlength = avio_rl32(pb);
183 ape->seektablelength = avio_rl32(pb);
184 ape->wavheaderlength = avio_rl32(pb);
185 ape->audiodatalength = avio_rl32(pb);
186 ape->audiodatalength_high = avio_rl32(pb);
187 ape->wavtaillength = avio_rl32(pb);
188 avio_read(pb, ape->md5, 16);
190 /* Skip any unknown bytes at the end of the descriptor.
191 This is for future compatibility */
192 if (ape->descriptorlength > 52)
193 avio_skip(pb, ape->descriptorlength - 52);
195 /* Read header data */
196 ape->compressiontype = avio_rl16(pb);
197 ape->formatflags = avio_rl16(pb);
198 ape->blocksperframe = avio_rl32(pb);
199 ape->finalframeblocks = avio_rl32(pb);
200 ape->totalframes = avio_rl32(pb);
201 ape->bps = avio_rl16(pb);
202 ape->channels = avio_rl16(pb);
203 ape->samplerate = avio_rl32(pb);
205 ape->descriptorlength = 0;
206 ape->headerlength = 32;
208 ape->compressiontype = avio_rl16(pb);
209 ape->formatflags = avio_rl16(pb);
210 ape->channels = avio_rl16(pb);
211 ape->samplerate = avio_rl32(pb);
212 ape->wavheaderlength = avio_rl32(pb);
213 ape->wavtaillength = avio_rl32(pb);
214 ape->totalframes = avio_rl32(pb);
215 ape->finalframeblocks = avio_rl32(pb);
217 if (ape->formatflags & MAC_FORMAT_FLAG_HAS_PEAK_LEVEL) {
218 avio_skip(pb, 4); /* Skip the peak level */
219 ape->headerlength += 4;
222 if (ape->formatflags & MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS) {
223 ape->seektablelength = avio_rl32(pb);
224 ape->headerlength += 4;
225 ape->seektablelength *= sizeof(int32_t);
227 ape->seektablelength = ape->totalframes * sizeof(int32_t);
229 if (ape->formatflags & MAC_FORMAT_FLAG_8_BIT)
231 else if (ape->formatflags & MAC_FORMAT_FLAG_24_BIT)
236 if (ape->fileversion >= 3950)
237 ape->blocksperframe = 73728 * 4;
238 else if (ape->fileversion >= 3900 || (ape->fileversion >= 3800 && ape->compressiontype >= 4000))
239 ape->blocksperframe = 73728;
241 ape->blocksperframe = 9216;
243 /* Skip any stored wav header */
244 if (!(ape->formatflags & MAC_FORMAT_FLAG_CREATE_WAV_HEADER))
245 avio_skip(pb, ape->wavheaderlength);
248 if(!ape->totalframes){
249 av_log(s, AV_LOG_ERROR, "No frames in the file!\n");
250 return AVERROR(EINVAL);
252 if(ape->totalframes > UINT_MAX / sizeof(APEFrame)){
253 av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n",
257 if (ape->seektablelength && (ape->seektablelength / sizeof(*ape->seektable)) < ape->totalframes) {
258 av_log(s, AV_LOG_ERROR,
259 "Number of seek entries is less than number of frames: %zu vs. %"PRIu32"\n",
260 ape->seektablelength / sizeof(*ape->seektable), ape->totalframes);
261 return AVERROR_INVALIDDATA;
263 ape->frames = av_malloc(ape->totalframes * sizeof(APEFrame));
265 return AVERROR(ENOMEM);
266 ape->firstframe = ape->junklength + ape->descriptorlength + ape->headerlength + ape->seektablelength + ape->wavheaderlength;
267 ape->currentframe = 0;
270 ape->totalsamples = ape->finalframeblocks;
271 if (ape->totalframes > 1)
272 ape->totalsamples += ape->blocksperframe * (ape->totalframes - 1);
274 if (ape->seektablelength > 0) {
275 ape->seektable = av_malloc(ape->seektablelength);
276 for (i = 0; i < ape->seektablelength / sizeof(uint32_t); i++)
277 ape->seektable[i] = avio_rl32(pb);
280 ape->frames[0].pos = ape->firstframe;
281 ape->frames[0].nblocks = ape->blocksperframe;
282 ape->frames[0].skip = 0;
283 for (i = 1; i < ape->totalframes; i++) {
284 ape->frames[i].pos = ape->seektable[i] + ape->junklength;
285 ape->frames[i].nblocks = ape->blocksperframe;
286 ape->frames[i - 1].size = ape->frames[i].pos - ape->frames[i - 1].pos;
287 ape->frames[i].skip = (ape->frames[i].pos - ape->frames[0].pos) & 3;
289 ape->frames[ape->totalframes - 1].size = ape->finalframeblocks * 4;
290 ape->frames[ape->totalframes - 1].nblocks = ape->finalframeblocks;
292 for (i = 0; i < ape->totalframes; i++) {
293 if(ape->frames[i].skip){
294 ape->frames[i].pos -= ape->frames[i].skip;
295 ape->frames[i].size += ape->frames[i].skip;
297 ape->frames[i].size = (ape->frames[i].size + 3) & ~3;
301 ape_dumpinfo(s, ape);
303 /* try to read APE tags */
306 avio_seek(pb, 0, SEEK_SET);
309 av_log(s, AV_LOG_DEBUG, "Decoding file - v%d.%02d, compression level %"PRIu16"\n",
310 ape->fileversion / 1000, (ape->fileversion % 1000) / 10,
311 ape->compressiontype);
313 /* now we are ready: build format streams */
314 st = av_new_stream(s, 0);
318 total_blocks = (ape->totalframes == 0) ? 0 : ((ape->totalframes - 1) * ape->blocksperframe) + ape->finalframeblocks;
320 st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
321 st->codec->codec_id = CODEC_ID_APE;
322 st->codec->codec_tag = MKTAG('A', 'P', 'E', ' ');
323 st->codec->channels = ape->channels;
324 st->codec->sample_rate = ape->samplerate;
325 st->codec->bits_per_coded_sample = ape->bps;
326 st->codec->frame_size = MAC_SUBFRAME_SIZE;
328 st->nb_frames = ape->totalframes;
330 st->duration = total_blocks / MAC_SUBFRAME_SIZE;
331 av_set_pts_info(st, 64, MAC_SUBFRAME_SIZE, ape->samplerate);
333 st->codec->extradata = av_malloc(APE_EXTRADATA_SIZE);
334 st->codec->extradata_size = APE_EXTRADATA_SIZE;
335 AV_WL16(st->codec->extradata + 0, ape->fileversion);
336 AV_WL16(st->codec->extradata + 2, ape->compressiontype);
337 AV_WL16(st->codec->extradata + 4, ape->formatflags);
340 for (i = 0; i < ape->totalframes; i++) {
341 ape->frames[i].pts = pts;
342 av_add_index_entry(st, ape->frames[i].pos, ape->frames[i].pts, 0, 0, AVINDEX_KEYFRAME);
343 pts += ape->blocksperframe / MAC_SUBFRAME_SIZE;
349 static int ape_read_packet(AVFormatContext * s, AVPacket * pkt)
353 APEContext *ape = s->priv_data;
354 uint32_t extra_size = 8;
358 if (ape->currentframe > ape->totalframes)
361 avio_seek (s->pb, ape->frames[ape->currentframe].pos, SEEK_SET);
363 /* Calculate how many blocks there are in this frame */
364 if (ape->currentframe == (ape->totalframes - 1))
365 nblocks = ape->finalframeblocks;
367 nblocks = ape->blocksperframe;
369 if (av_new_packet(pkt, ape->frames[ape->currentframe].size + extra_size) < 0)
370 return AVERROR(ENOMEM);
372 AV_WL32(pkt->data , nblocks);
373 AV_WL32(pkt->data + 4, ape->frames[ape->currentframe].skip);
374 ret = avio_read(s->pb, pkt->data + extra_size, ape->frames[ape->currentframe].size);
376 pkt->pts = ape->frames[ape->currentframe].pts;
377 pkt->stream_index = 0;
379 /* note: we need to modify the packet size here to handle the last
381 pkt->size = ret + extra_size;
388 static int ape_read_close(AVFormatContext * s)
390 APEContext *ape = s->priv_data;
392 av_freep(&ape->frames);
393 av_freep(&ape->seektable);
397 static int ape_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
399 AVStream *st = s->streams[stream_index];
400 APEContext *ape = s->priv_data;
401 int index = av_index_search_timestamp(st, timestamp, flags);
406 ape->currentframe = index;
410 AVInputFormat ff_ape_demuxer = {
412 .long_name = NULL_IF_CONFIG_SMALL("Monkey's Audio"),
413 .priv_data_size = sizeof(APEContext),
414 .read_probe = ape_probe,
415 .read_header = ape_read_header,
416 .read_packet = ape_read_packet,
417 .read_close = ape_read_close,
418 .read_seek = ape_read_seek,
419 .extensions = "ape,apl,mac"