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