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