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