672d643cec1fbd3b2dff25c6a0368fb768920222
[ffmpeg.git] / libavformat / mp3dec.c
1 /*
2  * MP3 demuxer
3  * Copyright (c) 2003 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "libavutil/opt.h"
23 #include "libavutil/avstring.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/crc.h"
26 #include "libavutil/dict.h"
27 #include "libavutil/mathematics.h"
28 #include "avformat.h"
29 #include "internal.h"
30 #include "avio_internal.h"
31 #include "id3v2.h"
32 #include "id3v1.h"
33 #include "replaygain.h"
34
35 #include "libavcodec/avcodec.h"
36 #include "libavcodec/mpegaudiodecheader.h"
37
38 #define XING_FLAG_FRAMES 0x01
39 #define XING_FLAG_SIZE   0x02
40 #define XING_FLAG_TOC    0x04
41 #define XING_FLAC_QSCALE 0x08
42
43 #define XING_TOC_COUNT 100
44
45 #define SAME_HEADER_MASK \
46    (0xffe00000 | (3 << 17) | (3 << 10) | (3 << 19))
47
48 typedef struct {
49     AVClass *class;
50     int64_t filesize;
51     int xing_toc;
52     int start_pad;
53     int end_pad;
54     int usetoc;
55     unsigned frames; /* Total number of frames in file */
56     unsigned header_filesize;   /* Total number of bytes in the stream */
57     int is_cbr;
58 } MP3DecContext;
59
60 enum CheckRet {
61     CHECK_WRONG_HEADER = -1,
62     CHECK_SEEK_FAILED  = -2,
63 };
64
65 static int check(AVIOContext *pb, int64_t pos, uint32_t *header);
66
67 /* mp3 read */
68
69 static int mp3_read_probe(AVProbeData *p)
70 {
71     int max_frames, first_frames = 0;
72     int frames, ret;
73     uint32_t header;
74     const uint8_t *buf, *buf0, *buf2, *end;
75
76     buf0 = p->buf;
77     end = p->buf + p->buf_size - sizeof(uint32_t);
78     while(buf0 < end && !*buf0)
79         buf0++;
80
81     max_frames = 0;
82     buf = buf0;
83
84     for(; buf < end; buf= buf2+1) {
85         buf2 = buf;
86         for(frames = 0; buf2 < end; frames++) {
87             MPADecodeHeader h;
88
89             header = AV_RB32(buf2);
90             ret = avpriv_mpegaudio_decode_header(&h, header);
91             if (ret != 0)
92                 break;
93             buf2 += h.frame_size;
94         }
95         max_frames = FFMAX(max_frames, frames);
96         if(buf == buf0)
97             first_frames= frames;
98     }
99     // keep this in sync with ac3 probe, both need to avoid
100     // issues with MPEG-files!
101     if   (first_frames>=7) return AVPROBE_SCORE_EXTENSION + 1;
102     else if(max_frames>200)return AVPROBE_SCORE_EXTENSION;
103     else if(max_frames>=4 && max_frames >= p->buf_size/10000) return AVPROBE_SCORE_EXTENSION / 2;
104     else if(ff_id3v2_match(buf0, ID3v2_DEFAULT_MAGIC) && 2*ff_id3v2_tag_len(buf0) >= p->buf_size)
105                            return p->buf_size < PROBE_BUF_MAX ? AVPROBE_SCORE_EXTENSION / 4 : AVPROBE_SCORE_EXTENSION - 2;
106     else if(max_frames>=1 && max_frames >= p->buf_size/10000) return 1;
107     else                   return 0;
108 //mpegps_mp3_unrecognized_format.mpg has max_frames=3
109 }
110
111 static void read_xing_toc(AVFormatContext *s, int64_t filesize, int64_t duration)
112 {
113     int i;
114     MP3DecContext *mp3 = s->priv_data;
115     int fast_seek = s->flags & AVFMT_FLAG_FAST_SEEK;
116     int fill_index = (mp3->usetoc || fast_seek) && duration > 0;
117
118     if (!filesize &&
119         !(filesize = avio_size(s->pb))) {
120         av_log(s, AV_LOG_WARNING, "Cannot determine file size, skipping TOC table.\n");
121         fill_index = 0;
122     }
123
124     for (i = 0; i < XING_TOC_COUNT; i++) {
125         uint8_t b = avio_r8(s->pb);
126         if (fill_index)
127             av_add_index_entry(s->streams[0],
128                            av_rescale(b, filesize, 256),
129                            av_rescale(i, duration, XING_TOC_COUNT),
130                            0, 0, AVINDEX_KEYFRAME);
131     }
132     if (fill_index)
133         mp3->xing_toc = 1;
134 }
135
136 static void mp3_parse_info_tag(AVFormatContext *s, AVStream *st,
137                                MPADecodeHeader *c, uint32_t spf)
138 {
139 #define LAST_BITS(k, n) ((k) & ((1 << (n)) - 1))
140 #define MIDDLE_BITS(k, m, n) LAST_BITS((k) >> (m), ((n) - (m)))
141
142     uint16_t crc;
143     uint32_t v;
144
145     char version[10];
146
147     uint32_t peak   = 0;
148     int32_t  r_gain = INT32_MIN, a_gain = INT32_MIN;
149
150     MP3DecContext *mp3 = s->priv_data;
151     static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
152     uint64_t fsize = avio_size(s->pb);
153     fsize = fsize >= avio_tell(s->pb) ? fsize - avio_tell(s->pb) : 0;
154
155     /* Check for Xing / Info tag */
156     avio_skip(s->pb, xing_offtbl[c->lsf == 1][c->nb_channels == 1]);
157     v = avio_rb32(s->pb);
158     mp3->is_cbr = v == MKBETAG('I', 'n', 'f', 'o');
159     if (v != MKBETAG('X', 'i', 'n', 'g') && !mp3->is_cbr)
160         return;
161
162     v = avio_rb32(s->pb);
163     if (v & XING_FLAG_FRAMES)
164         mp3->frames = avio_rb32(s->pb);
165     if (v & XING_FLAG_SIZE)
166         mp3->header_filesize = avio_rb32(s->pb);
167     if (fsize && mp3->header_filesize) {
168         uint64_t min, delta;
169         min = FFMIN(fsize, mp3->header_filesize);
170         delta = FFMAX(fsize, mp3->header_filesize) - min;
171         if (fsize > mp3->header_filesize && delta > min >> 4) {
172             mp3->frames = 0;
173             av_log(s, AV_LOG_WARNING,
174                    "invalid concatenated file detected - using bitrate for duration\n");
175         } else if (delta > min >> 4) {
176             av_log(s, AV_LOG_WARNING,
177                    "filesize and duration do not match (growing file?)\n");
178         }
179     }
180     if (v & XING_FLAG_TOC)
181         read_xing_toc(s, mp3->header_filesize, av_rescale_q(mp3->frames,
182                                        (AVRational){spf, c->sample_rate},
183                                        st->time_base));
184     /* VBR quality */
185     if (v & XING_FLAC_QSCALE)
186         avio_rb32(s->pb);
187
188     /* Encoder short version string */
189     memset(version, 0, sizeof(version));
190     avio_read(s->pb, version, 9);
191
192     /* Info Tag revision + VBR method */
193     avio_r8(s->pb);
194
195     /* Lowpass filter value */
196     avio_r8(s->pb);
197
198     /* ReplayGain peak */
199     v    = avio_rb32(s->pb);
200     peak = av_rescale(v, 100000, 1 << 23);
201
202     /* Radio ReplayGain */
203     v = avio_rb16(s->pb);
204
205     if (MIDDLE_BITS(v, 13, 15) == 1) {
206         r_gain = MIDDLE_BITS(v, 0, 8) * 10000;
207
208         if (v & (1 << 9))
209             r_gain *= -1;
210     }
211
212     /* Audiophile ReplayGain */
213     v = avio_rb16(s->pb);
214
215     if (MIDDLE_BITS(v, 13, 15) == 2) {
216         a_gain = MIDDLE_BITS(v, 0, 8) * 10000;
217
218         if (v & (1 << 9))
219             a_gain *= -1;
220     }
221
222     /* Encoding flags + ATH Type */
223     avio_r8(s->pb);
224
225     /* if ABR {specified bitrate} else {minimal bitrate} */
226     avio_r8(s->pb);
227
228     /* Encoder delays */
229     v= avio_rb24(s->pb);
230     if(AV_RB32(version) == MKBETAG('L', 'A', 'M', 'E')
231         || AV_RB32(version) == MKBETAG('L', 'a', 'v', 'f')
232         || AV_RB32(version) == MKBETAG('L', 'a', 'v', 'c')
233     ) {
234
235         mp3->start_pad = v>>12;
236         mp3->  end_pad = v&4095;
237         st->start_skip_samples = mp3->start_pad + 528 + 1;
238         if (mp3->frames) {
239             st->first_discard_sample = -mp3->end_pad + 528 + 1 + mp3->frames * (int64_t)spf;
240             st->last_discard_sample = mp3->frames * (int64_t)spf;
241         }
242         if (!st->start_time)
243             st->start_time = av_rescale_q(st->start_skip_samples,
244                                             (AVRational){1, c->sample_rate},
245                                             st->time_base);
246         av_log(s, AV_LOG_DEBUG, "pad %d %d\n", mp3->start_pad, mp3->  end_pad);
247     }
248
249     /* Misc */
250     avio_r8(s->pb);
251
252     /* MP3 gain */
253     avio_r8(s->pb);
254
255     /* Preset and surround info */
256     avio_rb16(s->pb);
257
258     /* Music length */
259     avio_rb32(s->pb);
260
261     /* Music CRC */
262     avio_rb16(s->pb);
263
264     /* Info Tag CRC */
265     crc = ffio_get_checksum(s->pb);
266     v   = avio_rb16(s->pb);
267
268     if (v == crc) {
269         ff_replaygain_export_raw(st, r_gain, peak, a_gain, 0);
270         av_dict_set(&st->metadata, "encoder", version, 0);
271     }
272 }
273
274 static void mp3_parse_vbri_tag(AVFormatContext *s, AVStream *st, int64_t base)
275 {
276     uint32_t v;
277     MP3DecContext *mp3 = s->priv_data;
278
279     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
280     avio_seek(s->pb, base + 4 + 32, SEEK_SET);
281     v = avio_rb32(s->pb);
282     if (v == MKBETAG('V', 'B', 'R', 'I')) {
283         /* Check tag version */
284         if (avio_rb16(s->pb) == 1) {
285             /* skip delay and quality */
286             avio_skip(s->pb, 4);
287             mp3->header_filesize = avio_rb32(s->pb);
288             mp3->frames = avio_rb32(s->pb);
289         }
290     }
291 }
292
293 /**
294  * Try to find Xing/Info/VBRI tags and compute duration from info therein
295  */
296 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
297 {
298     uint32_t v, spf;
299     MPADecodeHeader c;
300     int vbrtag_size = 0;
301     MP3DecContext *mp3 = s->priv_data;
302     int ret;
303
304     ffio_init_checksum(s->pb, ff_crcA001_update, 0);
305
306     v = avio_rb32(s->pb);
307
308     ret = avpriv_mpegaudio_decode_header(&c, v);
309     if (ret < 0)
310         return ret;
311     else if (ret == 0)
312         vbrtag_size = c.frame_size;
313     if(c.layer != 3)
314         return -1;
315
316     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
317
318     mp3->frames = 0;
319     mp3->header_filesize   = 0;
320
321     mp3_parse_info_tag(s, st, &c, spf);
322     mp3_parse_vbri_tag(s, st, base);
323
324     if (!mp3->frames && !mp3->header_filesize)
325         return -1;
326
327     /* Skip the vbr tag frame */
328     avio_seek(s->pb, base + vbrtag_size, SEEK_SET);
329
330     if (mp3->frames)
331         st->duration = av_rescale_q(mp3->frames, (AVRational){spf, c.sample_rate},
332                                     st->time_base);
333     if (mp3->header_filesize && mp3->frames && !mp3->is_cbr)
334         st->codec->bit_rate = av_rescale(mp3->header_filesize, 8 * c.sample_rate, mp3->frames * (int64_t)spf);
335
336     return 0;
337 }
338
339 static int mp3_read_header(AVFormatContext *s)
340 {
341     MP3DecContext *mp3 = s->priv_data;
342     AVStream *st;
343     int64_t off;
344     int ret;
345     int i;
346
347     st = avformat_new_stream(s, NULL);
348     if (!st)
349         return AVERROR(ENOMEM);
350
351     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
352     st->codec->codec_id = AV_CODEC_ID_MP3;
353     st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
354     st->start_time = 0;
355
356     // lcm of all mp3 sample rates
357     avpriv_set_pts_info(st, 64, 1, 14112000);
358
359     s->pb->maxsize = -1;
360     off = avio_tell(s->pb);
361
362     if (!av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
363         ff_id3v1_read(s);
364
365     if(s->pb->seekable)
366         mp3->filesize = avio_size(s->pb);
367
368     if (mp3_parse_vbr_tags(s, st, off) < 0)
369         avio_seek(s->pb, off, SEEK_SET);
370
371     ret = ff_replaygain_export(st, s->metadata);
372     if (ret < 0)
373         return ret;
374
375     off = avio_tell(s->pb);
376     for (i = 0; i < 64 * 1024; i++) {
377         uint32_t header, header2;
378         int frame_size;
379         if (!(i&1023))
380             ffio_ensure_seekback(s->pb, i + 1024 + 4);
381         frame_size = check(s->pb, off + i, &header);
382         if (frame_size > 0) {
383             ret = avio_seek(s->pb, off, SEEK_SET);
384             if (ret < 0)
385                 return ret;
386             ffio_ensure_seekback(s->pb, i + 1024 + frame_size + 4);
387             ret = check(s->pb, off + i + frame_size, &header2);
388             if (ret >= 0 &&
389                 (header & SAME_HEADER_MASK) == (header2 & SAME_HEADER_MASK))
390             {
391                 av_log(s, i > 0 ? AV_LOG_INFO : AV_LOG_VERBOSE, "Skipping %d bytes of junk at %"PRId64".\n", i, off);
392                 ret = avio_seek(s->pb, off + i, SEEK_SET);
393                 if (ret < 0)
394                     return ret;
395                 break;
396             } else if (ret == CHECK_SEEK_FAILED) {
397                 av_log(s, AV_LOG_ERROR, "Invalid frame size (%d): Could not seek to %"PRId64".\n", frame_size, off + i + frame_size);
398                 return AVERROR(EINVAL);
399             }
400         } else if (frame_size == CHECK_SEEK_FAILED) {
401             av_log(s, AV_LOG_ERROR, "Failed to read frame size: Could not seek to %"PRId64".\n", (int64_t) (i + 1024 + frame_size + 4));
402             return AVERROR(EINVAL);
403         }
404         ret = avio_seek(s->pb, off, SEEK_SET);
405         if (ret < 0)
406             return ret;
407     }
408
409     // the seek index is relative to the end of the xing vbr headers
410     for (i = 0; i < st->nb_index_entries; i++)
411         st->index_entries[i].pos += avio_tell(s->pb);
412
413     /* the parameters will be extracted from the compressed bitstream */
414     return 0;
415 }
416
417 #define MP3_PACKET_SIZE 1024
418
419 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
420 {
421     MP3DecContext *mp3 = s->priv_data;
422     int ret, size;
423     int64_t pos;
424
425     size= MP3_PACKET_SIZE;
426     pos = avio_tell(s->pb);
427     if(mp3->filesize > ID3v1_TAG_SIZE && pos < mp3->filesize)
428         size= FFMIN(size, mp3->filesize - pos);
429
430     ret= av_get_packet(s->pb, pkt, size);
431     if (ret <= 0) {
432         if(ret<0)
433             return ret;
434         return AVERROR_EOF;
435     }
436
437     pkt->flags &= ~AV_PKT_FLAG_CORRUPT;
438     pkt->stream_index = 0;
439
440     return ret;
441 }
442
443 #define SEEK_WINDOW 4096
444
445 static int check(AVIOContext *pb, int64_t pos, uint32_t *ret_header)
446 {
447     int64_t ret = avio_seek(pb, pos, SEEK_SET);
448     uint8_t header_buf[4];
449     unsigned header;
450     MPADecodeHeader sd;
451     if (ret < 0)
452         return CHECK_SEEK_FAILED;
453
454     ret = avio_read(pb, &header_buf[0], 4);
455     if (ret < 0)
456         return CHECK_SEEK_FAILED;
457
458     header = AV_RB32(&header_buf[0]);
459     if (ff_mpa_check_header(header) < 0)
460         return CHECK_WRONG_HEADER;
461     if (avpriv_mpegaudio_decode_header(&sd, header) == 1)
462         return CHECK_WRONG_HEADER;
463
464     if (ret_header)
465         *ret_header = header;
466     return sd.frame_size;
467 }
468
469 static int64_t mp3_sync(AVFormatContext *s, int64_t target_pos, int flags)
470 {
471     int dir = (flags&AVSEEK_FLAG_BACKWARD) ? -1 : 1;
472     int64_t best_pos;
473     int best_score, i, j;
474     int64_t ret;
475
476     avio_seek(s->pb, FFMAX(target_pos - SEEK_WINDOW, 0), SEEK_SET);
477     ret = avio_seek(s->pb, target_pos, SEEK_SET);
478     if (ret < 0)
479         return ret;
480
481 #define MIN_VALID 3
482     best_pos = target_pos;
483     best_score = 999;
484     for(i=0; i<SEEK_WINDOW; i++) {
485         int64_t pos = target_pos + (dir > 0 ? i - SEEK_WINDOW/4 : -i);
486         int64_t candidate = -1;
487         int score = 999;
488
489         if (pos < 0)
490             continue;
491
492         for(j=0; j<MIN_VALID; j++) {
493             ret = check(s->pb, pos, NULL);
494             if(ret < 0) {
495                 if (ret == CHECK_WRONG_HEADER) {
496                     break;
497                 } else if (ret == CHECK_SEEK_FAILED) {
498                     av_log(s, AV_LOG_ERROR, "Could not seek to %"PRId64".\n", pos);
499                     return AVERROR(EINVAL);
500                 }
501             }
502             if ((target_pos - pos)*dir <= 0 && abs(MIN_VALID/2-j) < score) {
503                 candidate = pos;
504                 score = abs(MIN_VALID/2-j);
505             }
506             pos += ret;
507         }
508         if (best_score > score && j == MIN_VALID) {
509             best_pos = candidate;
510             best_score = score;
511             if(score == 0)
512                 break;
513         }
514     }
515
516     return avio_seek(s->pb, best_pos, SEEK_SET);
517 }
518
519 static int mp3_seek(AVFormatContext *s, int stream_index, int64_t timestamp,
520                     int flags)
521 {
522     MP3DecContext *mp3 = s->priv_data;
523     AVIndexEntry *ie, ie1;
524     AVStream *st = s->streams[0];
525     int64_t best_pos;
526     int fast_seek = s->flags & AVFMT_FLAG_FAST_SEEK;
527     int64_t filesize = mp3->header_filesize;
528
529     if (filesize <= 0) {
530         int64_t size = avio_size(s->pb);
531         if (size > 0 && size > s->internal->data_offset)
532             filesize = size - s->internal->data_offset;
533     }
534
535     if (mp3->xing_toc && (mp3->usetoc || (fast_seek && !mp3->is_cbr))) {
536         int64_t ret = av_index_search_timestamp(st, timestamp, flags);
537
538         // NOTE: The MP3 TOC is not a precise lookup table. Accuracy is worse
539         // for bigger files.
540         av_log(s, AV_LOG_WARNING, "Using MP3 TOC to seek; may be imprecise.\n");
541
542         if (ret < 0)
543             return ret;
544
545         ie = &st->index_entries[ret];
546     } else if (fast_seek && st->duration > 0 && filesize > 0) {
547         if (!mp3->is_cbr)
548             av_log(s, AV_LOG_WARNING, "Using scaling to seek VBR MP3; may be imprecise.\n");
549
550         ie = &ie1;
551         timestamp = av_clip64(timestamp, 0, st->duration);
552         ie->timestamp = timestamp;
553         ie->pos       = av_rescale(timestamp, filesize, st->duration) + s->internal->data_offset;
554     } else {
555         return -1; // generic index code
556     }
557
558     best_pos = mp3_sync(s, ie->pos, flags);
559     if (best_pos < 0)
560         return best_pos;
561
562     if (mp3->is_cbr && ie == &ie1 && mp3->frames) {
563         int frame_duration = av_rescale(st->duration, 1, mp3->frames);
564         ie1.timestamp = frame_duration * av_rescale(best_pos - s->internal->data_offset, mp3->frames, mp3->header_filesize);
565     }
566
567     ff_update_cur_dts(s, st, ie->timestamp);
568     return 0;
569 }
570
571 static const AVOption options[] = {
572     { "usetoc", "use table of contents", offsetof(MP3DecContext, usetoc), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, AV_OPT_FLAG_DECODING_PARAM},
573     { NULL },
574 };
575
576 static const AVClass demuxer_class = {
577     .class_name = "mp3",
578     .item_name  = av_default_item_name,
579     .option     = options,
580     .version    = LIBAVUTIL_VERSION_INT,
581     .category   = AV_CLASS_CATEGORY_DEMUXER,
582 };
583
584 AVInputFormat ff_mp3_demuxer = {
585     .name           = "mp3",
586     .long_name      = NULL_IF_CONFIG_SMALL("MP2/3 (MPEG audio layer 2/3)"),
587     .read_probe     = mp3_read_probe,
588     .read_header    = mp3_read_header,
589     .read_packet    = mp3_read_packet,
590     .read_seek      = mp3_seek,
591     .priv_data_size = sizeof(MP3DecContext),
592     .flags          = AVFMT_GENERIC_INDEX,
593     .extensions     = "mp2,mp3,m2a,mpa", /* XXX: use probe */
594     .priv_class     = &demuxer_class,
595 };