c2b3467bf44cfe40dbb48148dcd0fe32dc19acbf
[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/dict.h"
26 #include "libavutil/mathematics.h"
27 #include "avformat.h"
28 #include "internal.h"
29 #include "id3v2.h"
30 #include "id3v1.h"
31 #include "replaygain.h"
32
33 #include "libavcodec/mpegaudiodecheader.h"
34
35 #define XING_FLAG_FRAMES 0x01
36 #define XING_FLAG_SIZE   0x02
37 #define XING_FLAG_TOC    0x04
38
39 #define XING_TOC_COUNT 100
40
41 typedef struct {
42     AVClass *class;
43     int64_t filesize;
44     int64_t header_filesize;
45     int xing_toc;
46     int start_pad;
47     int end_pad;
48     int usetoc;
49     int is_cbr;
50 } MP3DecContext;
51
52 /* mp3 read */
53
54 static int mp3_read_probe(AVProbeData *p)
55 {
56     int max_frames, first_frames = 0;
57     int fsize, frames, sample_rate;
58     uint32_t header;
59     const uint8_t *buf, *buf0, *buf2, *end;
60     AVCodecContext avctx;
61
62     buf0 = p->buf;
63     end = p->buf + p->buf_size - sizeof(uint32_t);
64     while(buf0 < end && !*buf0)
65         buf0++;
66
67     max_frames = 0;
68     buf = buf0;
69
70     for(; buf < end; buf= buf2+1) {
71         buf2 = buf;
72         if(ff_mpa_check_header(AV_RB32(buf2)))
73             continue;
74
75         for(frames = 0; buf2 < end; frames++) {
76             header = AV_RB32(buf2);
77             fsize = avpriv_mpa_decode_header(&avctx, header, &sample_rate, &sample_rate, &sample_rate, &sample_rate);
78             if(fsize < 0)
79                 break;
80             buf2 += fsize;
81         }
82         max_frames = FFMAX(max_frames, frames);
83         if(buf == buf0)
84             first_frames= frames;
85     }
86     // keep this in sync with ac3 probe, both need to avoid
87     // issues with MPEG-files!
88     if   (first_frames>=4) return AVPROBE_SCORE_EXTENSION + 1;
89     else if(max_frames>200)return AVPROBE_SCORE_EXTENSION;
90     else if(max_frames>=4) return AVPROBE_SCORE_EXTENSION / 2;
91     else if(ff_id3v2_match(buf0, ID3v2_DEFAULT_MAGIC) && 2*ff_id3v2_tag_len(buf0) >= p->buf_size)
92                            return p->buf_size < PROBE_BUF_MAX ? AVPROBE_SCORE_EXTENSION / 4 : AVPROBE_SCORE_EXTENSION - 2;
93     else if(max_frames>=1) return 1;
94     else                   return 0;
95 //mpegps_mp3_unrecognized_format.mpg has max_frames=3
96 }
97
98 static void read_xing_toc(AVFormatContext *s, int64_t filesize, int64_t duration)
99 {
100     int i;
101     MP3DecContext *mp3 = s->priv_data;
102     int fill_index = mp3->usetoc && duration > 0;
103
104     if (!filesize &&
105         !(filesize = avio_size(s->pb))) {
106         av_log(s, AV_LOG_WARNING, "Cannot determine file size, skipping TOC table.\n");
107         fill_index = 0;
108     }
109
110     for (i = 0; i < XING_TOC_COUNT; i++) {
111         uint8_t b = avio_r8(s->pb);
112         if (fill_index)
113             av_add_index_entry(s->streams[0],
114                            av_rescale(b, filesize, 256),
115                            av_rescale(i, duration, XING_TOC_COUNT),
116                            0, 0, AVINDEX_KEYFRAME);
117     }
118     if (fill_index)
119         mp3->xing_toc = 1;
120 }
121
122 /**
123  * Try to find Xing/Info/VBRI tags and compute duration from info therein
124  */
125 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
126 {
127     MP3DecContext *mp3 = s->priv_data;
128     uint32_t v, spf;
129     unsigned frames = 0; /* Total number of frames in file */
130     unsigned size = 0; /* Total number of bytes in the stream */
131     static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
132     MPADecodeHeader c;
133     int vbrtag_size = 0;
134     int is_cbr;
135
136     v = avio_rb32(s->pb);
137     if(ff_mpa_check_header(v) < 0)
138       return -1;
139
140     if (avpriv_mpegaudio_decode_header(&c, v) == 0)
141         vbrtag_size = c.frame_size;
142     if(c.layer != 3)
143         return -1;
144
145     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
146
147     /* Check for Xing / Info tag */
148     avio_skip(s->pb, xing_offtbl[c.lsf == 1][c.nb_channels == 1]);
149     v = avio_rb32(s->pb);
150     is_cbr = v == MKBETAG('I', 'n', 'f', 'o');
151     if (v == MKBETAG('X', 'i', 'n', 'g') || is_cbr) {
152         v = avio_rb32(s->pb);
153         if(v & XING_FLAG_FRAMES)
154             frames = avio_rb32(s->pb);
155         if(v & XING_FLAG_SIZE)
156             size = avio_rb32(s->pb);
157         if (v & XING_FLAG_TOC)
158             read_xing_toc(s, size, av_rescale_q(frames, (AVRational){spf, c.sample_rate},
159                                     st->time_base));
160         if(v & 8)
161             avio_skip(s->pb, 4);
162
163         v = avio_rb32(s->pb);
164         if(v == MKBETAG('L', 'A', 'M', 'E') || v == MKBETAG('L', 'a', 'v', 'f')) {
165             avio_skip(s->pb, 21-4);
166             v= avio_rb24(s->pb);
167             mp3->start_pad = v>>12;
168             mp3->  end_pad = v&4095;
169             st->skip_samples = mp3->start_pad + 528 + 1;
170             if (!st->start_time)
171                 st->start_time = av_rescale_q(st->skip_samples,
172                                               (AVRational){1, c.sample_rate},
173                                               st->time_base);
174             av_log(s, AV_LOG_DEBUG, "pad %d %d\n", mp3->start_pad, mp3->  end_pad);
175         }
176     }
177
178     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
179     avio_seek(s->pb, base + 4 + 32, SEEK_SET);
180     v = avio_rb32(s->pb);
181     if(v == MKBETAG('V', 'B', 'R', 'I')) {
182         /* Check tag version */
183         if(avio_rb16(s->pb) == 1) {
184             /* skip delay and quality */
185             avio_skip(s->pb, 4);
186             size = avio_rb32(s->pb);
187             frames = avio_rb32(s->pb);
188         }
189     }
190
191     if(!frames && !size)
192         return -1;
193
194     /* Skip the vbr tag frame */
195     avio_seek(s->pb, base + vbrtag_size, SEEK_SET);
196
197     if(frames)
198         st->duration = av_rescale_q(frames, (AVRational){spf, c.sample_rate},
199                                     st->time_base);
200     if (size && frames && !is_cbr)
201         st->codec->bit_rate = av_rescale(size, 8 * c.sample_rate, frames * (int64_t)spf);
202
203     mp3->is_cbr          = is_cbr;
204     mp3->header_filesize = size;
205
206     return 0;
207 }
208
209 static int mp3_read_header(AVFormatContext *s)
210 {
211     MP3DecContext *mp3 = s->priv_data;
212     AVStream *st;
213     int64_t off;
214     int ret;
215
216     st = avformat_new_stream(s, NULL);
217     if (!st)
218         return AVERROR(ENOMEM);
219
220     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
221     st->codec->codec_id = AV_CODEC_ID_MP3;
222     st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
223     st->start_time = 0;
224
225     // lcm of all mp3 sample rates
226     avpriv_set_pts_info(st, 64, 1, 14112000);
227
228     s->pb->maxsize = -1;
229     off = avio_tell(s->pb);
230
231     if (!av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
232         ff_id3v1_read(s);
233
234     if(s->pb->seekable)
235         mp3->filesize = avio_size(s->pb);
236
237     if (mp3_parse_vbr_tags(s, st, off) < 0)
238         avio_seek(s->pb, off, SEEK_SET);
239
240     ret = ff_replaygain_export(st, s->metadata);
241     if (ret < 0)
242         return ret;
243
244     /* the parameters will be extracted from the compressed bitstream */
245     return 0;
246 }
247
248 #define MP3_PACKET_SIZE 1024
249
250 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
251 {
252     MP3DecContext *mp3 = s->priv_data;
253     int ret, size;
254     int64_t pos;
255
256     size= MP3_PACKET_SIZE;
257     pos = avio_tell(s->pb);
258     if(mp3->filesize > ID3v1_TAG_SIZE && pos < mp3->filesize)
259         size= FFMIN(size, mp3->filesize - pos);
260
261     ret= av_get_packet(s->pb, pkt, size);
262     if (ret <= 0) {
263         if(ret<0)
264             return ret;
265         return AVERROR_EOF;
266     }
267
268     pkt->flags &= ~AV_PKT_FLAG_CORRUPT;
269     pkt->stream_index = 0;
270
271     if (ret >= ID3v1_TAG_SIZE &&
272         memcmp(&pkt->data[ret - ID3v1_TAG_SIZE], "TAG", 3) == 0)
273         ret -= ID3v1_TAG_SIZE;
274
275     /* note: we need to modify the packet size here to handle the last
276        packet */
277     pkt->size = ret;
278     return ret;
279 }
280
281 static int check(AVFormatContext *s, int64_t pos)
282 {
283     int64_t ret = avio_seek(s->pb, pos, SEEK_SET);
284     unsigned header;
285     MPADecodeHeader sd;
286     if (ret < 0)
287         return ret;
288     header = avio_rb32(s->pb);
289     if (ff_mpa_check_header(header) < 0)
290         return -1;
291     if (avpriv_mpegaudio_decode_header(&sd, header) == 1)
292         return -1;
293     return sd.frame_size;
294 }
295
296 static int mp3_seek(AVFormatContext *s, int stream_index, int64_t timestamp,
297                     int flags)
298 {
299     MP3DecContext *mp3 = s->priv_data;
300     AVIndexEntry *ie, ie1;
301     AVStream *st = s->streams[0];
302     int64_t ret  = av_index_search_timestamp(st, timestamp, flags);
303     int i, j;
304     int dir = (flags&AVSEEK_FLAG_BACKWARD) ? -1 : 1;
305
306     if (mp3->is_cbr && st->duration > 0 && mp3->header_filesize > s->data_offset) {
307         int64_t filesize = avio_size(s->pb);
308         int64_t duration;
309         if (filesize <= s->data_offset)
310             filesize = mp3->header_filesize;
311         filesize -= s->data_offset;
312         duration = av_rescale(st->duration, filesize, mp3->header_filesize - s->data_offset);
313         ie = &ie1;
314         timestamp = av_clip64(timestamp, 0, duration);
315         ie->timestamp = timestamp;
316         ie->pos       = av_rescale(timestamp, filesize, duration) + s->data_offset;
317     } else if (mp3->xing_toc) {
318         if (ret < 0)
319             return ret;
320
321         ie = &st->index_entries[ret];
322     } else {
323         st->skip_samples = timestamp <= 0 ? mp3->start_pad + 528 + 1 : 0;
324
325         return -1;
326     }
327
328     if (dir < 0)
329         avio_seek(s->pb, FFMAX(ie->pos - 4096, 0), SEEK_SET);
330     ret = avio_seek(s->pb, ie->pos, SEEK_SET);
331     if (ret < 0)
332         return ret;
333
334 #define MIN_VALID 3
335     for(i=0; i<4096; i++) {
336         int64_t pos = ie->pos + i*dir;
337         for(j=0; j<MIN_VALID; j++) {
338             ret = check(s, pos);
339             if(ret < 0)
340                 break;
341             pos += ret;
342         }
343         if(j==MIN_VALID)
344             break;
345     }
346     if(j!=MIN_VALID)
347         i=0;
348
349     ret = avio_seek(s->pb, ie->pos + i*dir, SEEK_SET);
350     if (ret < 0)
351         return ret;
352     ff_update_cur_dts(s, st, ie->timestamp);
353     st->skip_samples = ie->timestamp <= 0 ? mp3->start_pad + 528 + 1 : 0;
354     return 0;
355 }
356
357 static const AVOption options[] = {
358     { "usetoc", "use table of contents", offsetof(MP3DecContext, usetoc), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 1, AV_OPT_FLAG_DECODING_PARAM},
359     { NULL },
360 };
361
362 static const AVClass demuxer_class = {
363     .class_name = "mp3",
364     .item_name  = av_default_item_name,
365     .option     = options,
366     .version    = LIBAVUTIL_VERSION_INT,
367     .category   = AV_CLASS_CATEGORY_DEMUXER,
368 };
369
370 AVInputFormat ff_mp3_demuxer = {
371     .name           = "mp3",
372     .long_name      = NULL_IF_CONFIG_SMALL("MP2/3 (MPEG audio layer 2/3)"),
373     .read_probe     = mp3_read_probe,
374     .read_header    = mp3_read_header,
375     .read_packet    = mp3_read_packet,
376     .read_seek      = mp3_seek,
377     .priv_data_size = sizeof(MP3DecContext),
378     .flags          = AVFMT_GENERIC_INDEX,
379     .extensions     = "mp2,mp3,m2a,mpa", /* XXX: use probe */
380     .priv_class     = &demuxer_class,
381 };