88256ef47588b8ce64251f0b7851344c35ea1e88
[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/mpegaudiodecheader.h"
36
37 #define XING_FLAG_FRAMES 0x01
38 #define XING_FLAG_SIZE   0x02
39 #define XING_FLAG_TOC    0x04
40 #define XING_FLAC_QSCALE 0x08
41
42 #define XING_TOC_COUNT 100
43
44 typedef struct {
45     AVClass *class;
46     int64_t filesize;
47     int xing_toc;
48     int start_pad;
49     int end_pad;
50     int usetoc;
51     unsigned frames; /* Total number of frames in file */
52     unsigned header_filesize;   /* Total number of bytes in the stream */
53     int is_cbr;
54 } MP3DecContext;
55
56 /* mp3 read */
57
58 static int mp3_read_probe(AVProbeData *p)
59 {
60     int max_frames, first_frames = 0;
61     int fsize, frames, sample_rate;
62     uint32_t header;
63     const uint8_t *buf, *buf0, *buf2, *end;
64     AVCodecContext avctx;
65
66     buf0 = p->buf;
67     end = p->buf + p->buf_size - sizeof(uint32_t);
68     while(buf0 < end && !*buf0)
69         buf0++;
70
71     max_frames = 0;
72     buf = buf0;
73
74     for(; buf < end; buf= buf2+1) {
75         buf2 = buf;
76         if(ff_mpa_check_header(AV_RB32(buf2)))
77             continue;
78
79         for(frames = 0; buf2 < end; frames++) {
80             header = AV_RB32(buf2);
81             fsize = avpriv_mpa_decode_header(&avctx, header, &sample_rate, &sample_rate, &sample_rate, &sample_rate);
82             if(fsize < 0)
83                 break;
84             buf2 += fsize;
85         }
86         max_frames = FFMAX(max_frames, frames);
87         if(buf == buf0)
88             first_frames= frames;
89     }
90     // keep this in sync with ac3 probe, both need to avoid
91     // issues with MPEG-files!
92     if   (first_frames>=4) return AVPROBE_SCORE_EXTENSION + 1;
93     else if(max_frames>200)return AVPROBE_SCORE_EXTENSION;
94     else if(max_frames>=4 && max_frames >= p->buf_size/10000) return AVPROBE_SCORE_EXTENSION / 2;
95     else if(ff_id3v2_match(buf0, ID3v2_DEFAULT_MAGIC) && 2*ff_id3v2_tag_len(buf0) >= p->buf_size)
96                            return p->buf_size < PROBE_BUF_MAX ? AVPROBE_SCORE_EXTENSION / 4 : AVPROBE_SCORE_EXTENSION - 2;
97     else if(max_frames>=1 && max_frames >= p->buf_size/10000) return 1;
98     else                   return 0;
99 //mpegps_mp3_unrecognized_format.mpg has max_frames=3
100 }
101
102 static void read_xing_toc(AVFormatContext *s, int64_t filesize, int64_t duration)
103 {
104     int i;
105     MP3DecContext *mp3 = s->priv_data;
106     int fill_index = mp3->usetoc && duration > 0;
107
108     if (!filesize &&
109         !(filesize = avio_size(s->pb))) {
110         av_log(s, AV_LOG_WARNING, "Cannot determine file size, skipping TOC table.\n");
111         fill_index = 0;
112     }
113
114     for (i = 0; i < XING_TOC_COUNT; i++) {
115         uint8_t b = avio_r8(s->pb);
116         if (fill_index)
117             av_add_index_entry(s->streams[0],
118                            av_rescale(b, filesize, 256),
119                            av_rescale(i, duration, XING_TOC_COUNT),
120                            0, 0, AVINDEX_KEYFRAME);
121     }
122     if (fill_index)
123         mp3->xing_toc = 1;
124 }
125
126 static void mp3_parse_info_tag(AVFormatContext *s, AVStream *st,
127                                MPADecodeHeader *c, uint32_t spf)
128 {
129 #define LAST_BITS(k, n) ((k) & ((1 << (n)) - 1))
130 #define MIDDLE_BITS(k, m, n) LAST_BITS((k) >> (m), ((n) - (m)))
131
132     uint16_t crc;
133     uint32_t v;
134
135     char version[10];
136
137     uint32_t peak   = 0;
138     int32_t  r_gain = INT32_MIN, a_gain = INT32_MIN;
139
140     MP3DecContext *mp3 = s->priv_data;
141     static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
142     uint64_t fsize = avio_size(s->pb);
143
144     /* Check for Xing / Info tag */
145     avio_skip(s->pb, xing_offtbl[c->lsf == 1][c->nb_channels == 1]);
146     v = avio_rb32(s->pb);
147     mp3->is_cbr = v == MKBETAG('I', 'n', 'f', 'o');
148     if (v != MKBETAG('X', 'i', 'n', 'g') && !mp3->is_cbr)
149         return;
150
151     v = avio_rb32(s->pb);
152     if (v & XING_FLAG_FRAMES)
153         mp3->frames = avio_rb32(s->pb);
154     if (v & XING_FLAG_SIZE)
155         mp3->header_filesize = avio_rb32(s->pb);
156     if (fsize && mp3->header_filesize) {
157         uint64_t min, delta;
158         min = FFMIN(fsize, mp3->header_filesize);
159         delta = FFMAX(fsize, mp3->header_filesize) - min;
160         if (fsize > mp3->header_filesize && delta > min >> 4) {
161             mp3->frames = 0;
162         } else if (delta > min >> 4) {
163             av_log(s, AV_LOG_WARNING,
164                    "filesize and duration do not match (growing file?)\n");
165         }
166     }
167     if (v & XING_FLAG_TOC)
168         read_xing_toc(s, mp3->header_filesize, av_rescale_q(mp3->frames,
169                                        (AVRational){spf, c->sample_rate},
170                                        st->time_base));
171     /* VBR quality */
172     if (v & XING_FLAC_QSCALE)
173         avio_rb32(s->pb);
174
175     /* Encoder short version string */
176     memset(version, 0, sizeof(version));
177     avio_read(s->pb, version, 9);
178
179     /* Info Tag revision + VBR method */
180     avio_r8(s->pb);
181
182     /* Lowpass filter value */
183     avio_r8(s->pb);
184
185     /* ReplayGain peak */
186     v    = avio_rb32(s->pb);
187     peak = av_rescale(v, 100000, 1 << 23);
188
189     /* Radio ReplayGain */
190     v = avio_rb16(s->pb);
191
192     if (MIDDLE_BITS(v, 13, 15) == 1) {
193         r_gain = MIDDLE_BITS(v, 0, 8) * 10000;
194
195         if (v & (1 << 9))
196             r_gain *= -1;
197     }
198
199     /* Audiophile ReplayGain */
200     v = avio_rb16(s->pb);
201
202     if (MIDDLE_BITS(v, 13, 15) == 2) {
203         a_gain = MIDDLE_BITS(v, 0, 8) * 10000;
204
205         if (v & (1 << 9))
206             a_gain *= -1;
207     }
208
209     /* Encoding flags + ATH Type */
210     avio_r8(s->pb);
211
212     /* if ABR {specified bitrate} else {minimal bitrate} */
213     avio_r8(s->pb);
214
215     /* Encoder delays */
216     v= avio_rb24(s->pb);
217     if(AV_RB32(version) == MKBETAG('L', 'A', 'M', 'E')
218         || AV_RB32(version) == MKBETAG('L', 'a', 'v', 'f')) {
219
220         mp3->start_pad = v>>12;
221         mp3->  end_pad = v&4095;
222         st->skip_samples = mp3->start_pad + 528 + 1;
223         if (mp3->frames) {
224             st->first_discard_sample = -mp3->end_pad + 528 + 1 + mp3->frames * (int64_t)spf;
225             st->last_discard_sample = mp3->frames * (int64_t)spf;
226         }
227         if (!st->start_time)
228             st->start_time = av_rescale_q(st->skip_samples,
229                                             (AVRational){1, c->sample_rate},
230                                             st->time_base);
231         av_log(s, AV_LOG_DEBUG, "pad %d %d\n", mp3->start_pad, mp3->  end_pad);
232     }
233
234     /* Misc */
235     avio_r8(s->pb);
236
237     /* MP3 gain */
238     avio_r8(s->pb);
239
240     /* Preset and surround info */
241     avio_rb16(s->pb);
242
243     /* Music length */
244     avio_rb32(s->pb);
245
246     /* Music CRC */
247     avio_rb16(s->pb);
248
249     /* Info Tag CRC */
250     crc = ffio_get_checksum(s->pb);
251     v   = avio_rb16(s->pb);
252
253     if (v == crc) {
254         ff_replaygain_export_raw(st, r_gain, peak, a_gain, 0);
255         av_dict_set(&st->metadata, "encoder", version, 0);
256     }
257 }
258
259 static void mp3_parse_vbri_tag(AVFormatContext *s, AVStream *st, int64_t base)
260 {
261     uint32_t v;
262     MP3DecContext *mp3 = s->priv_data;
263
264     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
265     avio_seek(s->pb, base + 4 + 32, SEEK_SET);
266     v = avio_rb32(s->pb);
267     if (v == MKBETAG('V', 'B', 'R', 'I')) {
268         /* Check tag version */
269         if (avio_rb16(s->pb) == 1) {
270             /* skip delay and quality */
271             avio_skip(s->pb, 4);
272             mp3->header_filesize = avio_rb32(s->pb);
273             mp3->frames = avio_rb32(s->pb);
274         }
275     }
276 }
277
278 /**
279  * Try to find Xing/Info/VBRI tags and compute duration from info therein
280  */
281 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
282 {
283     uint32_t v, spf;
284     MPADecodeHeader c;
285     int vbrtag_size = 0;
286     MP3DecContext *mp3 = s->priv_data;
287
288     ffio_init_checksum(s->pb, ff_crcA001_update, 0);
289
290     v = avio_rb32(s->pb);
291     if(ff_mpa_check_header(v) < 0)
292       return -1;
293
294     if (avpriv_mpegaudio_decode_header(&c, v) == 0)
295         vbrtag_size = c.frame_size;
296     if(c.layer != 3)
297         return -1;
298
299     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
300
301     mp3->frames = 0;
302     mp3->header_filesize   = 0;
303
304     mp3_parse_info_tag(s, st, &c, spf);
305     mp3_parse_vbri_tag(s, st, base);
306
307     if (!mp3->frames && !mp3->header_filesize)
308         return -1;
309
310     /* Skip the vbr tag frame */
311     avio_seek(s->pb, base + vbrtag_size, SEEK_SET);
312
313     if (mp3->frames)
314         st->duration = av_rescale_q(mp3->frames, (AVRational){spf, c.sample_rate},
315                                     st->time_base);
316     if (mp3->header_filesize && mp3->frames && !mp3->is_cbr)
317         st->codec->bit_rate = av_rescale(mp3->header_filesize, 8 * c.sample_rate, mp3->frames * (int64_t)spf);
318
319     return 0;
320 }
321
322 static int mp3_read_header(AVFormatContext *s)
323 {
324     MP3DecContext *mp3 = s->priv_data;
325     AVStream *st;
326     int64_t off;
327     int ret;
328
329     st = avformat_new_stream(s, NULL);
330     if (!st)
331         return AVERROR(ENOMEM);
332
333     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
334     st->codec->codec_id = AV_CODEC_ID_MP3;
335     st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
336     st->start_time = 0;
337
338     // lcm of all mp3 sample rates
339     avpriv_set_pts_info(st, 64, 1, 14112000);
340
341     s->pb->maxsize = -1;
342     off = avio_tell(s->pb);
343
344     if (!av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
345         ff_id3v1_read(s);
346
347     if(s->pb->seekable)
348         mp3->filesize = avio_size(s->pb);
349
350     if (mp3_parse_vbr_tags(s, st, off) < 0)
351         avio_seek(s->pb, off, SEEK_SET);
352
353     ret = ff_replaygain_export(st, s->metadata);
354     if (ret < 0)
355         return ret;
356
357     /* the parameters will be extracted from the compressed bitstream */
358     return 0;
359 }
360
361 #define MP3_PACKET_SIZE 1024
362
363 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
364 {
365     MP3DecContext *mp3 = s->priv_data;
366     int ret, size;
367     int64_t pos;
368
369     size= MP3_PACKET_SIZE;
370     pos = avio_tell(s->pb);
371     if(mp3->filesize > ID3v1_TAG_SIZE && pos < mp3->filesize)
372         size= FFMIN(size, mp3->filesize - pos);
373
374     ret= av_get_packet(s->pb, pkt, size);
375     if (ret <= 0) {
376         if(ret<0)
377             return ret;
378         return AVERROR_EOF;
379     }
380
381     pkt->flags &= ~AV_PKT_FLAG_CORRUPT;
382     pkt->stream_index = 0;
383
384     if (ret >= ID3v1_TAG_SIZE &&
385         memcmp(&pkt->data[ret - ID3v1_TAG_SIZE], "TAG", 3) == 0)
386         ret -= ID3v1_TAG_SIZE;
387
388     /* note: we need to modify the packet size here to handle the last
389        packet */
390     pkt->size = ret;
391     return ret;
392 }
393
394 static int check(AVFormatContext *s, int64_t pos)
395 {
396     int64_t ret = avio_seek(s->pb, pos, SEEK_SET);
397     unsigned header;
398     MPADecodeHeader sd;
399     if (ret < 0)
400         return ret;
401     header = avio_rb32(s->pb);
402     if (ff_mpa_check_header(header) < 0)
403         return -1;
404     if (avpriv_mpegaudio_decode_header(&sd, header) == 1)
405         return -1;
406     return sd.frame_size;
407 }
408
409 static int mp3_seek(AVFormatContext *s, int stream_index, int64_t timestamp,
410                     int flags)
411 {
412     MP3DecContext *mp3 = s->priv_data;
413     AVIndexEntry *ie, ie1;
414     AVStream *st = s->streams[0];
415     int64_t ret  = av_index_search_timestamp(st, timestamp, flags);
416     int i, j;
417     int dir = (flags&AVSEEK_FLAG_BACKWARD) ? -1 : 1;
418     int64_t best_pos;
419     int best_score;
420
421     if (   mp3->is_cbr
422         && st->duration > 0
423         && mp3->header_filesize > s->data_offset
424         && mp3->frames) {
425         int64_t filesize = avio_size(s->pb);
426         int64_t duration;
427         if (filesize <= s->data_offset)
428             filesize = mp3->header_filesize;
429         filesize -= s->data_offset;
430         duration = av_rescale(st->duration, filesize, mp3->header_filesize - s->data_offset);
431         ie = &ie1;
432         timestamp = av_clip64(timestamp, 0, duration);
433         ie->timestamp = timestamp;
434         ie->pos       = av_rescale(timestamp, filesize, duration) + s->data_offset;
435     } else if (mp3->xing_toc) {
436         if (ret < 0)
437             return ret;
438
439         ie = &st->index_entries[ret];
440     } else {
441         st->skip_samples = timestamp <= 0 ? mp3->start_pad + 528 + 1 : 0;
442
443         return -1;
444     }
445
446     avio_seek(s->pb, FFMAX(ie->pos - 4096, 0), SEEK_SET);
447     ret = avio_seek(s->pb, ie->pos, SEEK_SET);
448     if (ret < 0)
449         return ret;
450
451 #define MIN_VALID 3
452     best_pos = ie->pos;
453     best_score = 999;
454     for(i=0; i<4096; i++) {
455         int64_t pos = ie->pos + (dir > 0 ? i - 1024 : -i);
456         int64_t candidate = -1;
457         int score = 999;
458         for(j=0; j<MIN_VALID; j++) {
459             ret = check(s, pos);
460             if(ret < 0)
461                 break;
462             if ((ie->pos - pos)*dir <= 0 && abs(MIN_VALID/2-j) < score) {
463                 candidate = pos;
464                 score = abs(MIN_VALID/2-j);
465             }
466             pos += ret;
467         }
468         if (best_score > score && j == MIN_VALID) {
469             best_pos = candidate;
470             best_score = score;
471             if(score == 0)
472                 break;
473         }
474     }
475
476     ret = avio_seek(s->pb, best_pos, SEEK_SET);
477     if (ret < 0)
478         return ret;
479     ff_update_cur_dts(s, st, ie->timestamp);
480     st->skip_samples = ie->timestamp <= 0 ? mp3->start_pad + 528 + 1 : 0;
481     return 0;
482 }
483
484 static const AVOption options[] = {
485     { "usetoc", "use table of contents", offsetof(MP3DecContext, usetoc), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 1, AV_OPT_FLAG_DECODING_PARAM},
486     { NULL },
487 };
488
489 static const AVClass demuxer_class = {
490     .class_name = "mp3",
491     .item_name  = av_default_item_name,
492     .option     = options,
493     .version    = LIBAVUTIL_VERSION_INT,
494     .category   = AV_CLASS_CATEGORY_DEMUXER,
495 };
496
497 AVInputFormat ff_mp3_demuxer = {
498     .name           = "mp3",
499     .long_name      = NULL_IF_CONFIG_SMALL("MP2/3 (MPEG audio layer 2/3)"),
500     .read_probe     = mp3_read_probe,
501     .read_header    = mp3_read_header,
502     .read_packet    = mp3_read_packet,
503     .read_seek      = mp3_seek,
504     .priv_data_size = sizeof(MP3DecContext),
505     .flags          = AVFMT_GENERIC_INDEX,
506     .extensions     = "mp2,mp3,m2a,mpa", /* XXX: use probe */
507     .priv_class     = &demuxer_class,
508 };