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