e1a895408729da43fe304649d0ca6cb8ec960cdb
[ffmpeg.git] / 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
28 #define ENABLE_DEBUG 0
29
30 /* The earliest and latest file formats supported by this library */
31 #define APE_MIN_VERSION 3950
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 MAC_SUBFRAME_SIZE 4608
42
43 #define APE_EXTRADATA_SIZE 6
44
45 /* APE tags */
46 #define APE_TAG_VERSION               2000
47 #define APE_TAG_FOOTER_BYTES          32
48 #define APE_TAG_FLAG_CONTAINS_HEADER  (1 << 31)
49 #define APE_TAG_FLAG_IS_HEADER        (1 << 29)
50
51 typedef struct {
52     int64_t pos;
53     int nblocks;
54     int size;
55     int skip;
56     int64_t pts;
57 } APEFrame;
58
59 typedef struct {
60     /* Derived fields */
61     uint32_t junklength;
62     uint32_t firstframe;
63     uint32_t totalsamples;
64     int currentframe;
65     APEFrame *frames;
66
67     /* Info from Descriptor Block */
68     char magic[4];
69     int16_t fileversion;
70     int16_t padding1;
71     uint32_t descriptorlength;
72     uint32_t headerlength;
73     uint32_t seektablelength;
74     uint32_t wavheaderlength;
75     uint32_t audiodatalength;
76     uint32_t audiodatalength_high;
77     uint32_t wavtaillength;
78     uint8_t md5[16];
79
80     /* Info from Header Block */
81     uint16_t compressiontype;
82     uint16_t formatflags;
83     uint32_t blocksperframe;
84     uint32_t finalframeblocks;
85     uint32_t totalframes;
86     uint16_t bps;
87     uint16_t channels;
88     uint32_t samplerate;
89
90     /* Seektable */
91     uint32_t *seektable;
92 } APEContext;
93
94 static void ape_tag_read_field(AVFormatContext *s)
95 {
96     ByteIOContext *pb = s->pb;
97     uint8_t key[1024], value[1024];
98     uint32_t size;
99     int i, l;
100
101     size = get_le32(pb);  /* field size */
102     url_fskip(pb, 4);     /* skip field flags */
103
104     for (i=0; pb->buf_ptr[i]!='0' && pb->buf_ptr[i]>=0x20 && pb->buf_ptr[i]<=0x7E; i++);
105
106     l = FFMIN(i,    sizeof(key) -1);
107     get_buffer(pb, key,  l);
108     key[l]  = 0;
109     url_fskip(pb, 1 + i-l);
110     l = FFMIN(size, sizeof(value)-1);
111     get_buffer(pb, value, l);
112     value[l] = 0;
113     url_fskip(pb, size-l);
114     if (l < size)
115         av_log(s, AV_LOG_WARNING, "Too long '%s' tag was truncated.\n", key);
116     av_metadata_set(&s->metadata, key, value);
117 }
118
119 static void ape_parse_tag(AVFormatContext *s)
120 {
121     ByteIOContext *pb = s->pb;
122     int file_size = url_fsize(pb);
123     uint32_t val, fields, tag_bytes;
124     uint8_t buf[8];
125     int i;
126
127     if (file_size < APE_TAG_FOOTER_BYTES)
128         return;
129
130     url_fseek(pb, file_size - APE_TAG_FOOTER_BYTES, SEEK_SET);
131
132     get_buffer(pb, buf, 8);    /* APETAGEX */
133     if (strncmp(buf, "APETAGEX", 8)) {
134         return;
135     }
136
137     val = get_le32(pb);        /* APE tag version */
138     if (val > APE_TAG_VERSION) {
139         av_log(s, AV_LOG_ERROR, "Unsupported tag version. (>=%d)\n", APE_TAG_VERSION);
140         return;
141     }
142
143     tag_bytes = get_le32(pb);  /* tag size */
144     if (tag_bytes - APE_TAG_FOOTER_BYTES > (1024 * 1024 * 16)) {
145         av_log(s, AV_LOG_ERROR, "Tag size is way too big\n");
146         return;
147     }
148
149     fields = get_le32(pb);     /* number of fields */
150     if (fields > 65536) {
151         av_log(s, AV_LOG_ERROR, "Too many tag fields (%d)\n", fields);
152         return;
153     }
154
155     val = get_le32(pb);        /* flags */
156     if (val & APE_TAG_FLAG_IS_HEADER) {
157         av_log(s, AV_LOG_ERROR, "APE Tag is a header\n");
158         return;
159     }
160
161     url_fseek(pb, file_size - tag_bytes, SEEK_SET);
162
163     for (i=0; i<fields; i++)
164         ape_tag_read_field(s);
165
166 #if ENABLE_DEBUG
167     av_log(s, AV_LOG_DEBUG, "\nAPE Tags:\n\n");
168     av_log(s, AV_LOG_DEBUG, "title     = %s\n", s->title);
169     av_log(s, AV_LOG_DEBUG, "author    = %s\n", s->author);
170     av_log(s, AV_LOG_DEBUG, "copyright = %s\n", s->copyright);
171     av_log(s, AV_LOG_DEBUG, "comment   = %s\n", s->comment);
172     av_log(s, AV_LOG_DEBUG, "album     = %s\n", s->album);
173     av_log(s, AV_LOG_DEBUG, "year      = %d\n", s->year);
174     av_log(s, AV_LOG_DEBUG, "track     = %d\n", s->track);
175     av_log(s, AV_LOG_DEBUG, "genre     = %s\n", s->genre);
176 #endif
177 }
178
179 static int ape_probe(AVProbeData * p)
180 {
181     if (p->buf[0] == 'M' && p->buf[1] == 'A' && p->buf[2] == 'C' && p->buf[3] == ' ')
182         return AVPROBE_SCORE_MAX;
183
184     return 0;
185 }
186
187 static void ape_dumpinfo(AVFormatContext * s, APEContext * ape_ctx)
188 {
189 #if ENABLE_DEBUG
190     int i;
191
192     av_log(s, AV_LOG_DEBUG, "Descriptor Block:\n\n");
193     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]);
194     av_log(s, AV_LOG_DEBUG, "fileversion          = %d\n", ape_ctx->fileversion);
195     av_log(s, AV_LOG_DEBUG, "descriptorlength     = %d\n", ape_ctx->descriptorlength);
196     av_log(s, AV_LOG_DEBUG, "headerlength         = %d\n", ape_ctx->headerlength);
197     av_log(s, AV_LOG_DEBUG, "seektablelength      = %d\n", ape_ctx->seektablelength);
198     av_log(s, AV_LOG_DEBUG, "wavheaderlength      = %d\n", ape_ctx->wavheaderlength);
199     av_log(s, AV_LOG_DEBUG, "audiodatalength      = %d\n", ape_ctx->audiodatalength);
200     av_log(s, AV_LOG_DEBUG, "audiodatalength_high = %d\n", ape_ctx->audiodatalength_high);
201     av_log(s, AV_LOG_DEBUG, "wavtaillength        = %d\n", ape_ctx->wavtaillength);
202     av_log(s, AV_LOG_DEBUG, "md5                  = ");
203     for (i = 0; i < 16; i++)
204          av_log(s, AV_LOG_DEBUG, "%02x", ape_ctx->md5[i]);
205     av_log(s, AV_LOG_DEBUG, "\n");
206
207     av_log(s, AV_LOG_DEBUG, "\nHeader Block:\n\n");
208
209     av_log(s, AV_LOG_DEBUG, "compressiontype      = %d\n", ape_ctx->compressiontype);
210     av_log(s, AV_LOG_DEBUG, "formatflags          = %d\n", ape_ctx->formatflags);
211     av_log(s, AV_LOG_DEBUG, "blocksperframe       = %d\n", ape_ctx->blocksperframe);
212     av_log(s, AV_LOG_DEBUG, "finalframeblocks     = %d\n", ape_ctx->finalframeblocks);
213     av_log(s, AV_LOG_DEBUG, "totalframes          = %d\n", ape_ctx->totalframes);
214     av_log(s, AV_LOG_DEBUG, "bps                  = %d\n", ape_ctx->bps);
215     av_log(s, AV_LOG_DEBUG, "channels             = %d\n", ape_ctx->channels);
216     av_log(s, AV_LOG_DEBUG, "samplerate           = %d\n", ape_ctx->samplerate);
217
218     av_log(s, AV_LOG_DEBUG, "\nSeektable\n\n");
219     if ((ape_ctx->seektablelength / sizeof(uint32_t)) != ape_ctx->totalframes) {
220         av_log(s, AV_LOG_DEBUG, "No seektable\n");
221     } else {
222         for (i = 0; i < ape_ctx->seektablelength / sizeof(uint32_t); i++) {
223             if (i < ape_ctx->totalframes - 1) {
224                 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]);
225             } else {
226                 av_log(s, AV_LOG_DEBUG, "%8d   %d\n", i, ape_ctx->seektable[i]);
227             }
228         }
229     }
230
231     av_log(s, AV_LOG_DEBUG, "\nFrames\n\n");
232     for (i = 0; i < ape_ctx->totalframes; i++)
233         av_log(s, AV_LOG_DEBUG, "%8d   %8lld %8d (%d samples)\n", i, ape_ctx->frames[i].pos, ape_ctx->frames[i].size, ape_ctx->frames[i].nblocks);
234
235     av_log(s, AV_LOG_DEBUG, "\nCalculated information:\n\n");
236     av_log(s, AV_LOG_DEBUG, "junklength           = %d\n", ape_ctx->junklength);
237     av_log(s, AV_LOG_DEBUG, "firstframe           = %d\n", ape_ctx->firstframe);
238     av_log(s, AV_LOG_DEBUG, "totalsamples         = %d\n", ape_ctx->totalsamples);
239 #endif
240 }
241
242 static int ape_read_header(AVFormatContext * s, AVFormatParameters * ap)
243 {
244     ByteIOContext *pb = s->pb;
245     APEContext *ape = s->priv_data;
246     AVStream *st;
247     uint32_t tag;
248     int i;
249     int total_blocks;
250     int64_t pts;
251
252     /* TODO: Skip any leading junk such as id3v2 tags */
253     ape->junklength = 0;
254
255     tag = get_le32(pb);
256     if (tag != MKTAG('M', 'A', 'C', ' '))
257         return -1;
258
259     ape->fileversion = get_le16(pb);
260
261     if (ape->fileversion < APE_MIN_VERSION || ape->fileversion > APE_MAX_VERSION) {
262         av_log(s, AV_LOG_ERROR, "Unsupported file version - %d.%02d\n", ape->fileversion / 1000, (ape->fileversion % 1000) / 10);
263         return -1;
264     }
265
266     if (ape->fileversion >= 3980) {
267         ape->padding1             = get_le16(pb);
268         ape->descriptorlength     = get_le32(pb);
269         ape->headerlength         = get_le32(pb);
270         ape->seektablelength      = get_le32(pb);
271         ape->wavheaderlength      = get_le32(pb);
272         ape->audiodatalength      = get_le32(pb);
273         ape->audiodatalength_high = get_le32(pb);
274         ape->wavtaillength        = get_le32(pb);
275         get_buffer(pb, ape->md5, 16);
276
277         /* Skip any unknown bytes at the end of the descriptor.
278            This is for future compatibility */
279         if (ape->descriptorlength > 52)
280             url_fseek(pb, ape->descriptorlength - 52, SEEK_CUR);
281
282         /* Read header data */
283         ape->compressiontype      = get_le16(pb);
284         ape->formatflags          = get_le16(pb);
285         ape->blocksperframe       = get_le32(pb);
286         ape->finalframeblocks     = get_le32(pb);
287         ape->totalframes          = get_le32(pb);
288         ape->bps                  = get_le16(pb);
289         ape->channels             = get_le16(pb);
290         ape->samplerate           = get_le32(pb);
291     } else {
292         ape->descriptorlength = 0;
293         ape->headerlength = 32;
294
295         ape->compressiontype      = get_le16(pb);
296         ape->formatflags          = get_le16(pb);
297         ape->channels             = get_le16(pb);
298         ape->samplerate           = get_le32(pb);
299         ape->wavheaderlength      = get_le32(pb);
300         ape->wavtaillength        = get_le32(pb);
301         ape->totalframes          = get_le32(pb);
302         ape->finalframeblocks     = get_le32(pb);
303
304         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_PEAK_LEVEL) {
305             url_fseek(pb, 4, SEEK_CUR); /* Skip the peak level */
306             ape->headerlength += 4;
307         }
308
309         if (ape->formatflags & MAC_FORMAT_FLAG_HAS_SEEK_ELEMENTS) {
310             ape->seektablelength = get_le32(pb);
311             ape->headerlength += 4;
312             ape->seektablelength *= sizeof(int32_t);
313         } else
314             ape->seektablelength = ape->totalframes * sizeof(int32_t);
315
316         if (ape->formatflags & MAC_FORMAT_FLAG_8_BIT)
317             ape->bps = 8;
318         else if (ape->formatflags & MAC_FORMAT_FLAG_24_BIT)
319             ape->bps = 24;
320         else
321             ape->bps = 16;
322
323         if (ape->fileversion >= 3950)
324             ape->blocksperframe = 73728 * 4;
325         else if (ape->fileversion >= 3900 || (ape->fileversion >= 3800  && ape->compressiontype >= 4000))
326             ape->blocksperframe = 73728;
327         else
328             ape->blocksperframe = 9216;
329
330         /* Skip any stored wav header */
331         if (!(ape->formatflags & MAC_FORMAT_FLAG_CREATE_WAV_HEADER))
332             url_fskip(pb, ape->wavheaderlength);
333     }
334
335     if(ape->totalframes > UINT_MAX / sizeof(APEFrame)){
336         av_log(s, AV_LOG_ERROR, "Too many frames: %d\n", ape->totalframes);
337         return -1;
338     }
339     ape->frames       = av_malloc(ape->totalframes * sizeof(APEFrame));
340     if(!ape->frames)
341         return AVERROR_NOMEM;
342     ape->firstframe   = ape->junklength + ape->descriptorlength + ape->headerlength + ape->seektablelength + ape->wavheaderlength;
343     ape->currentframe = 0;
344
345
346     ape->totalsamples = ape->finalframeblocks;
347     if (ape->totalframes > 1)
348         ape->totalsamples += ape->blocksperframe * (ape->totalframes - 1);
349
350     if (ape->seektablelength > 0) {
351         ape->seektable = av_malloc(ape->seektablelength);
352         for (i = 0; i < ape->seektablelength / sizeof(uint32_t); i++)
353             ape->seektable[i] = get_le32(pb);
354     }
355
356     ape->frames[0].pos     = ape->firstframe;
357     ape->frames[0].nblocks = ape->blocksperframe;
358     ape->frames[0].skip    = 0;
359     for (i = 1; i < ape->totalframes; i++) {
360         ape->frames[i].pos      = ape->seektable[i]; //ape->frames[i-1].pos + ape->blocksperframe;
361         ape->frames[i].nblocks  = ape->blocksperframe;
362         ape->frames[i - 1].size = ape->frames[i].pos - ape->frames[i - 1].pos;
363         ape->frames[i].skip     = (ape->frames[i].pos - ape->frames[0].pos) & 3;
364     }
365     ape->frames[ape->totalframes - 1].size    = ape->finalframeblocks * 4;
366     ape->frames[ape->totalframes - 1].nblocks = ape->finalframeblocks;
367
368     for (i = 0; i < ape->totalframes; i++) {
369         if(ape->frames[i].skip){
370             ape->frames[i].pos  -= ape->frames[i].skip;
371             ape->frames[i].size += ape->frames[i].skip;
372         }
373         ape->frames[i].size = (ape->frames[i].size + 3) & ~3;
374     }
375
376
377     ape_dumpinfo(s, ape);
378
379     /* try to read APE tags */
380     if (!url_is_streamed(pb)) {
381         ape_parse_tag(s);
382         url_fseek(pb, 0, SEEK_SET);
383     }
384
385     av_log(s, AV_LOG_DEBUG, "Decoding file - v%d.%02d, compression level %d\n", ape->fileversion / 1000, (ape->fileversion % 1000) / 10, ape->compressiontype);
386
387     /* now we are ready: build format streams */
388     st = av_new_stream(s, 0);
389     if (!st)
390         return -1;
391
392     total_blocks = (ape->totalframes == 0) ? 0 : ((ape->totalframes - 1) * ape->blocksperframe) + ape->finalframeblocks;
393
394     st->codec->codec_type      = CODEC_TYPE_AUDIO;
395     st->codec->codec_id        = CODEC_ID_APE;
396     st->codec->codec_tag       = MKTAG('A', 'P', 'E', ' ');
397     st->codec->channels        = ape->channels;
398     st->codec->sample_rate     = ape->samplerate;
399     st->codec->bits_per_coded_sample = ape->bps;
400     st->codec->frame_size      = MAC_SUBFRAME_SIZE;
401
402     st->nb_frames = ape->totalframes;
403     s->start_time = 0;
404     s->duration   = (int64_t) total_blocks * AV_TIME_BASE / ape->samplerate;
405     av_set_pts_info(st, 64, MAC_SUBFRAME_SIZE, ape->samplerate);
406
407     st->codec->extradata = av_malloc(APE_EXTRADATA_SIZE);
408     st->codec->extradata_size = APE_EXTRADATA_SIZE;
409     AV_WL16(st->codec->extradata + 0, ape->fileversion);
410     AV_WL16(st->codec->extradata + 2, ape->compressiontype);
411     AV_WL16(st->codec->extradata + 4, ape->formatflags);
412
413     pts = 0;
414     for (i = 0; i < ape->totalframes; i++) {
415         ape->frames[i].pts = pts;
416         av_add_index_entry(st, ape->frames[i].pos, ape->frames[i].pts, 0, 0, AVINDEX_KEYFRAME);
417         pts += ape->blocksperframe / MAC_SUBFRAME_SIZE;
418     }
419
420     return 0;
421 }
422
423 static int ape_read_packet(AVFormatContext * s, AVPacket * pkt)
424 {
425     int ret;
426     int nblocks;
427     APEContext *ape = s->priv_data;
428     uint32_t extra_size = 8;
429
430     if (url_feof(s->pb))
431         return AVERROR_IO;
432     if (ape->currentframe > ape->totalframes)
433         return AVERROR_IO;
434
435     url_fseek (s->pb, ape->frames[ape->currentframe].pos, SEEK_SET);
436
437     /* Calculate how many blocks there are in this frame */
438     if (ape->currentframe == (ape->totalframes - 1))
439         nblocks = ape->finalframeblocks;
440     else
441         nblocks = ape->blocksperframe;
442
443     if (av_new_packet(pkt,  ape->frames[ape->currentframe].size + extra_size) < 0)
444         return AVERROR_NOMEM;
445
446     AV_WL32(pkt->data    , nblocks);
447     AV_WL32(pkt->data + 4, ape->frames[ape->currentframe].skip);
448     ret = get_buffer(s->pb, pkt->data + extra_size, ape->frames[ape->currentframe].size);
449
450     pkt->pts = ape->frames[ape->currentframe].pts;
451     pkt->stream_index = 0;
452
453     /* note: we need to modify the packet size here to handle the last
454        packet */
455     pkt->size = ret + extra_size;
456
457     ape->currentframe++;
458
459     return 0;
460 }
461
462 static int ape_read_close(AVFormatContext * s)
463 {
464     APEContext *ape = s->priv_data;
465
466     av_freep(&ape->frames);
467     av_freep(&ape->seektable);
468     return 0;
469 }
470
471 static int ape_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
472 {
473     AVStream *st = s->streams[stream_index];
474     APEContext *ape = s->priv_data;
475     int index = av_index_search_timestamp(st, timestamp, flags);
476
477     if (index < 0)
478         return -1;
479
480     ape->currentframe = index;
481     return 0;
482 }
483
484 AVInputFormat ape_demuxer = {
485     "ape",
486     NULL_IF_CONFIG_SMALL("Monkey's Audio"),
487     sizeof(APEContext),
488     ape_probe,
489     ape_read_header,
490     ape_read_packet,
491     ape_read_close,
492     ape_read_seek,
493     .extensions = "ape,apl,mac"
494 };