FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ape.c
Go to the documentation of this file.
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 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 APE_EXTRADATA_SIZE 6
42 
43 typedef struct {
44  int64_t pos;
45  int nblocks;
46  int size;
47  int skip;
48  int64_t pts;
49 } APEFrame;
50 
51 typedef struct {
52  /* Derived fields */
53  uint32_t junklength;
54  uint32_t firstframe;
55  uint32_t totalsamples;
58 
59  /* Info from Descriptor Block */
60  char magic[4];
61  int16_t fileversion;
62  int16_t padding1;
63  uint32_t descriptorlength;
64  uint32_t headerlength;
65  uint32_t seektablelength;
66  uint32_t wavheaderlength;
67  uint32_t audiodatalength;
69  uint32_t wavtaillength;
70  uint8_t md5[16];
71 
72  /* Info from Header Block */
73  uint16_t compressiontype;
74  uint16_t formatflags;
75  uint32_t blocksperframe;
76  uint32_t finalframeblocks;
77  uint32_t totalframes;
78  uint16_t bps;
79  uint16_t channels;
80  uint32_t samplerate;
81 
82  /* Seektable */
83  uint32_t *seektable;
84 } APEContext;
85 
86 static int ape_probe(AVProbeData * p)
87 {
88  if (p->buf[0] == 'M' && p->buf[1] == 'A' && p->buf[2] == 'C' && p->buf[3] == ' ')
89  return AVPROBE_SCORE_MAX;
90 
91  return 0;
92 }
93 
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, "magic = \"%c%c%c%c\"\n", ape_ctx->magic[0], ape_ctx->magic[1], ape_ctx->magic[2], ape_ctx->magic[3]);
101  av_log(s, AV_LOG_DEBUG, "fileversion = %"PRId16"\n", ape_ctx->fileversion);
102  av_log(s, AV_LOG_DEBUG, "descriptorlength = %"PRIu32"\n", ape_ctx->descriptorlength);
103  av_log(s, AV_LOG_DEBUG, "headerlength = %"PRIu32"\n", ape_ctx->headerlength);
104  av_log(s, AV_LOG_DEBUG, "seektablelength = %"PRIu32"\n", ape_ctx->seektablelength);
105  av_log(s, AV_LOG_DEBUG, "wavheaderlength = %"PRIu32"\n", ape_ctx->wavheaderlength);
106  av_log(s, AV_LOG_DEBUG, "audiodatalength = %"PRIu32"\n", ape_ctx->audiodatalength);
107  av_log(s, AV_LOG_DEBUG, "audiodatalength_high = %"PRIu32"\n", ape_ctx->audiodatalength_high);
108  av_log(s, AV_LOG_DEBUG, "wavtaillength = %"PRIu32"\n", ape_ctx->wavtaillength);
109  av_log(s, AV_LOG_DEBUG, "md5 = ");
110  for (i = 0; i < 16; i++)
111  av_log(s, AV_LOG_DEBUG, "%02x", ape_ctx->md5[i]);
112  av_log(s, AV_LOG_DEBUG, "\n");
113 
114  av_log(s, AV_LOG_DEBUG, "\nHeader Block:\n\n");
115 
116  av_log(s, AV_LOG_DEBUG, "compressiontype = %"PRIu16"\n", ape_ctx->compressiontype);
117  av_log(s, AV_LOG_DEBUG, "formatflags = %"PRIu16"\n", ape_ctx->formatflags);
118  av_log(s, AV_LOG_DEBUG, "blocksperframe = %"PRIu32"\n", ape_ctx->blocksperframe);
119  av_log(s, AV_LOG_DEBUG, "finalframeblocks = %"PRIu32"\n", ape_ctx->finalframeblocks);
120  av_log(s, AV_LOG_DEBUG, "totalframes = %"PRIu32"\n", ape_ctx->totalframes);
121  av_log(s, AV_LOG_DEBUG, "bps = %"PRIu16"\n", ape_ctx->bps);
122  av_log(s, AV_LOG_DEBUG, "channels = %"PRIu16"\n", ape_ctx->channels);
123  av_log(s, AV_LOG_DEBUG, "samplerate = %"PRIu32"\n", ape_ctx->samplerate);
124 
125  av_log(s, AV_LOG_DEBUG, "\nSeektable\n\n");
126  if ((ape_ctx->seektablelength / sizeof(uint32_t)) != ape_ctx->totalframes) {
127  av_log(s, AV_LOG_DEBUG, "No seektable\n");
128  } else {
129  for (i = 0; i < ape_ctx->seektablelength / sizeof(uint32_t); i++) {
130  if (i < ape_ctx->totalframes - 1) {
131  av_log(s, AV_LOG_DEBUG, "%8d %"PRIu32" (%"PRIu32" bytes)\n",
132  i, ape_ctx->seektable[i],
133  ape_ctx->seektable[i + 1] - ape_ctx->seektable[i]);
134  } else {
135  av_log(s, AV_LOG_DEBUG, "%8d %"PRIu32"\n", i, ape_ctx->seektable[i]);
136  }
137  }
138  }
139 
140  av_log(s, AV_LOG_DEBUG, "\nFrames\n\n");
141  for (i = 0; i < ape_ctx->totalframes; i++)
142  av_log(s, AV_LOG_DEBUG, "%8d %8"PRId64" %8d (%d samples)\n", i,
143  ape_ctx->frames[i].pos, ape_ctx->frames[i].size,
144  ape_ctx->frames[i].nblocks);
145 
146  av_log(s, AV_LOG_DEBUG, "\nCalculated information:\n\n");
147  av_log(s, AV_LOG_DEBUG, "junklength = %"PRIu32"\n", ape_ctx->junklength);
148  av_log(s, AV_LOG_DEBUG, "firstframe = %"PRIu32"\n", ape_ctx->firstframe);
149  av_log(s, AV_LOG_DEBUG, "totalsamples = %"PRIu32"\n", ape_ctx->totalsamples);
150 #endif
151 }
152 
154 {
155  AVIOContext *pb = s->pb;
156  APEContext *ape = s->priv_data;
157  AVStream *st;
158  uint32_t tag;
159  int i;
160  int total_blocks, final_size = 0;
161  int64_t pts, file_size;
162 
163  /* Skip any leading junk such as id3v2 tags */
164  ape->junklength = avio_tell(pb);
165 
166  tag = avio_rl32(pb);
167  if (tag != MKTAG('M', 'A', 'C', ' '))
168  return AVERROR_INVALIDDATA;
169 
170  ape->fileversion = avio_rl16(pb);
171 
173  av_log(s, AV_LOG_ERROR, "Unsupported file version - %d.%02d\n",
174  ape->fileversion / 1000, (ape->fileversion % 1000) / 10);
175  return AVERROR_PATCHWELCOME;
176  }
177 
178  if (ape->fileversion >= 3980) {
179  ape->padding1 = avio_rl16(pb);
180  ape->descriptorlength = avio_rl32(pb);
181  ape->headerlength = avio_rl32(pb);
182  ape->seektablelength = avio_rl32(pb);
183  ape->wavheaderlength = avio_rl32(pb);
184  ape->audiodatalength = avio_rl32(pb);
185  ape->audiodatalength_high = avio_rl32(pb);
186  ape->wavtaillength = avio_rl32(pb);
187  avio_read(pb, ape->md5, 16);
188 
189  /* Skip any unknown bytes at the end of the descriptor.
190  This is for future compatibility */
191  if (ape->descriptorlength > 52)
192  avio_skip(pb, ape->descriptorlength - 52);
193 
194  /* Read header data */
195  ape->compressiontype = avio_rl16(pb);
196  ape->formatflags = avio_rl16(pb);
197  ape->blocksperframe = avio_rl32(pb);
198  ape->finalframeblocks = avio_rl32(pb);
199  ape->totalframes = avio_rl32(pb);
200  ape->bps = avio_rl16(pb);
201  ape->channels = avio_rl16(pb);
202  ape->samplerate = avio_rl32(pb);
203  } else {
204  ape->descriptorlength = 0;
205  ape->headerlength = 32;
206 
207  ape->compressiontype = avio_rl16(pb);
208  ape->formatflags = avio_rl16(pb);
209  ape->channels = avio_rl16(pb);
210  ape->samplerate = avio_rl32(pb);
211  ape->wavheaderlength = avio_rl32(pb);
212  ape->wavtaillength = avio_rl32(pb);
213  ape->totalframes = avio_rl32(pb);
214  ape->finalframeblocks = avio_rl32(pb);
215 
217  avio_skip(pb, 4); /* Skip the peak level */
218  ape->headerlength += 4;
219  }
220 
222  ape->seektablelength = avio_rl32(pb);
223  ape->headerlength += 4;
224  ape->seektablelength *= sizeof(int32_t);
225  } else
226  ape->seektablelength = ape->totalframes * sizeof(int32_t);
227 
229  ape->bps = 8;
230  else if (ape->formatflags & MAC_FORMAT_FLAG_24_BIT)
231  ape->bps = 24;
232  else
233  ape->bps = 16;
234 
235  if (ape->fileversion >= 3950)
236  ape->blocksperframe = 73728 * 4;
237  else if (ape->fileversion >= 3900 || (ape->fileversion >= 3800 && ape->compressiontype >= 4000))
238  ape->blocksperframe = 73728;
239  else
240  ape->blocksperframe = 9216;
241 
242  /* Skip any stored wav header */
244  avio_skip(pb, ape->wavheaderlength);
245  }
246 
247  if(!ape->totalframes){
248  av_log(s, AV_LOG_ERROR, "No frames in the file!\n");
249  return AVERROR(EINVAL);
250  }
251  if(ape->totalframes > UINT_MAX / sizeof(APEFrame)){
252  av_log(s, AV_LOG_ERROR, "Too many frames: %"PRIu32"\n",
253  ape->totalframes);
254  return AVERROR_INVALIDDATA;
255  }
256  if (ape->seektablelength && (ape->seektablelength / sizeof(*ape->seektable)) < ape->totalframes) {
257  av_log(s, AV_LOG_ERROR,
258  "Number of seek entries is less than number of frames: %zu vs. %"PRIu32"\n",
259  ape->seektablelength / sizeof(*ape->seektable), ape->totalframes);
260  return AVERROR_INVALIDDATA;
261  }
262  ape->frames = av_malloc(ape->totalframes * sizeof(APEFrame));
263  if(!ape->frames)
264  return AVERROR(ENOMEM);
265  ape->firstframe = ape->junklength + ape->descriptorlength + ape->headerlength + ape->seektablelength + ape->wavheaderlength;
266  ape->currentframe = 0;
267 
268 
269  ape->totalsamples = ape->finalframeblocks;
270  if (ape->totalframes > 1)
271  ape->totalsamples += ape->blocksperframe * (ape->totalframes - 1);
272 
273  if (ape->seektablelength > 0) {
274  ape->seektable = av_malloc(ape->seektablelength);
275  if (!ape->seektable)
276  return AVERROR(ENOMEM);
277  for (i = 0; i < ape->seektablelength / sizeof(uint32_t); i++)
278  ape->seektable[i] = avio_rl32(pb);
279  }else{
280  av_log(s, AV_LOG_ERROR, "Missing seektable\n");
281  return AVERROR_INVALIDDATA;
282  }
283 
284  ape->frames[0].pos = ape->firstframe;
285  ape->frames[0].nblocks = ape->blocksperframe;
286  ape->frames[0].skip = 0;
287  for (i = 1; i < ape->totalframes; i++) {
288  ape->frames[i].pos = ape->seektable[i] + ape->junklength;
289  ape->frames[i].nblocks = ape->blocksperframe;
290  ape->frames[i - 1].size = ape->frames[i].pos - ape->frames[i - 1].pos;
291  ape->frames[i].skip = (ape->frames[i].pos - ape->frames[0].pos) & 3;
292  }
293  ape->frames[ape->totalframes - 1].nblocks = ape->finalframeblocks;
294  /* calculate final packet size from total file size, if available */
295  file_size = avio_size(pb);
296  if (file_size > 0) {
297  final_size = file_size - ape->frames[ape->totalframes - 1].pos -
298  ape->wavtaillength;
299  final_size -= final_size & 3;
300  }
301  if (file_size <= 0 || final_size <= 0)
302  final_size = ape->finalframeblocks * 8;
303  ape->frames[ape->totalframes - 1].size = final_size;
304 
305  for (i = 0; i < ape->totalframes; i++) {
306  if(ape->frames[i].skip){
307  ape->frames[i].pos -= ape->frames[i].skip;
308  ape->frames[i].size += ape->frames[i].skip;
309  }
310  ape->frames[i].size = (ape->frames[i].size + 3) & ~3;
311  }
312 
313 
314  ape_dumpinfo(s, ape);
315 
316  av_log(s, AV_LOG_DEBUG, "Decoding file - v%d.%02d, compression level %"PRIu16"\n",
317  ape->fileversion / 1000, (ape->fileversion % 1000) / 10,
318  ape->compressiontype);
319 
320  /* now we are ready: build format streams */
321  st = avformat_new_stream(s, NULL);
322  if (!st)
323  return AVERROR(ENOMEM);
324 
325  total_blocks = (ape->totalframes == 0) ? 0 : ((ape->totalframes - 1) * ape->blocksperframe) + ape->finalframeblocks;
326 
329  st->codec->codec_tag = MKTAG('A', 'P', 'E', ' ');
330  st->codec->channels = ape->channels;
331  st->codec->sample_rate = ape->samplerate;
332  st->codec->bits_per_coded_sample = ape->bps;
333 
334  st->nb_frames = ape->totalframes;
335  st->start_time = 0;
336  st->duration = total_blocks;
337  avpriv_set_pts_info(st, 64, 1, ape->samplerate);
338 
341  AV_WL16(st->codec->extradata + 0, ape->fileversion);
342  AV_WL16(st->codec->extradata + 2, ape->compressiontype);
343  AV_WL16(st->codec->extradata + 4, ape->formatflags);
344 
345  pts = 0;
346  for (i = 0; i < ape->totalframes; i++) {
347  ape->frames[i].pts = pts;
348  av_add_index_entry(st, ape->frames[i].pos, ape->frames[i].pts, 0, 0, AVINDEX_KEYFRAME);
349  pts += ape->blocksperframe;
350  }
351 
352  /* try to read APE tags */
353  if (pb->seekable) {
354  ff_ape_parse_tag(s);
355  avio_seek(pb, 0, SEEK_SET);
356  }
357 
358  return 0;
359 }
360 
362 {
363  int ret;
364  int nblocks;
365  APEContext *ape = s->priv_data;
366  uint32_t extra_size = 8;
367 
368  if (url_feof(s->pb))
369  return AVERROR_EOF;
370  if (ape->currentframe >= ape->totalframes)
371  return AVERROR_EOF;
372 
373  if (avio_seek(s->pb, ape->frames[ape->currentframe].pos, SEEK_SET) < 0)
374  return AVERROR(EIO);
375 
376  /* Calculate how many blocks there are in this frame */
377  if (ape->currentframe == (ape->totalframes - 1))
378  nblocks = ape->finalframeblocks;
379  else
380  nblocks = ape->blocksperframe;
381 
382  if (ape->frames[ape->currentframe].size <= 0 ||
383  ape->frames[ape->currentframe].size > INT_MAX - extra_size) {
384  av_log(s, AV_LOG_ERROR, "invalid packet size: %d\n",
385  ape->frames[ape->currentframe].size);
386  ape->currentframe++;
387  return AVERROR(EIO);
388  }
389 
390  if (av_new_packet(pkt, ape->frames[ape->currentframe].size + extra_size) < 0)
391  return AVERROR(ENOMEM);
392 
393  AV_WL32(pkt->data , nblocks);
394  AV_WL32(pkt->data + 4, ape->frames[ape->currentframe].skip);
395  ret = avio_read(s->pb, pkt->data + extra_size, ape->frames[ape->currentframe].size);
396 
397  pkt->pts = ape->frames[ape->currentframe].pts;
398  pkt->stream_index = 0;
399 
400  /* note: we need to modify the packet size here to handle the last
401  packet */
402  pkt->size = ret + extra_size;
403 
404  ape->currentframe++;
405 
406  return 0;
407 }
408 
410 {
411  APEContext *ape = s->priv_data;
412 
413  av_freep(&ape->frames);
414  av_freep(&ape->seektable);
415  return 0;
416 }
417 
418 static int ape_read_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
419 {
420  AVStream *st = s->streams[stream_index];
421  APEContext *ape = s->priv_data;
422  int index = av_index_search_timestamp(st, timestamp, flags);
423 
424  if (index < 0)
425  return -1;
426 
427  if (avio_seek(s->pb, st->index_entries[index].pos, SEEK_SET) < 0)
428  return -1;
429  ape->currentframe = index;
430  return 0;
431 }
432 
434  .name = "ape",
435  .long_name = NULL_IF_CONFIG_SMALL("Monkey's Audio"),
436  .priv_data_size = sizeof(APEContext),
442  .extensions = "ape,apl,mac",
443 };