libavformat/mp3dec.c

   1 /*
   2  * MP3 demuxer
   3  * Copyright (c) 2003 Fabrice Bellard
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav 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  * Libav 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 Libav; 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/crc.h"
  25 #include "libavutil/dict.h"
  26 #include "libavutil/mathematics.h"
  27 #include "avformat.h"
  28 #include "internal.h"
  29 #include "avio_internal.h"
  30 #include "id3v2.h"
  31 #include "id3v1.h"
  32 #include "replaygain.h"
  33
  34 #include "libavcodec/mpegaudiodecheader.h"
  35
  36 #define XING_FLAG_FRAMES 0x01
  37 #define XING_FLAG_SIZE   0x02
  38 #define XING_FLAG_TOC    0x04
  39
  40 #define XING_TOC_COUNT 100
  41
  42 typedef struct MP3DecContext {
  43     int xing_toc;
  44     unsigned frames; /* Total number of frames in file */
  45     unsigned size;   /* Total number of bytes in the stream */
  46     int is_cbr;
  47 } MP3DecContext;
  48
  49 /* mp3 read */
  50
  51 static int mp3_read_probe(AVProbeData *p)
  52 {
  53     int max_frames, first_frames = 0;
  54     int fsize, frames, sample_rate;
  55     uint32_t header;
  56     uint8_t *buf, *buf0, *buf2, *end;
  57     AVCodecContext avctx;
  58
  59     buf0 = p->buf;
  60     end = p->buf + p->buf_size - sizeof(uint32_t);
  61     while(buf0 < end && !*buf0)
  62         buf0++;
  63
  64     max_frames = 0;
  65     buf = buf0;
  66
  67     for(; buf < end; buf= buf2+1) {
  68         buf2 = buf;
  69
  70         for(frames = 0; buf2 < end; frames++) {
  71             header = AV_RB32(buf2);
  72             fsize = avpriv_mpa_decode_header(&avctx, header, &sample_rate, &sample_rate, &sample_rate, &sample_rate);
  73             if(fsize < 0)
  74                 break;
  75             buf2 += fsize;
  76         }
  77         max_frames = FFMAX(max_frames, frames);
  78         if(buf == buf0)
  79             first_frames= frames;
  80     }
  81     // keep this in sync with ac3 probe, both need to avoid
  82     // issues with MPEG-files!
  83     if (first_frames >= 10)
  84         return AVPROBE_SCORE_EXTENSION + 5;
  85     if (first_frames >= 4)
  86         return AVPROBE_SCORE_EXTENSION + 1;
  87
  88     if (max_frames) {
  89         int pes = 0, i;
  90         unsigned int code = -1;
  91
  92 #define VIDEO_ID 0x000001e0
  93 #define AUDIO_ID 0x000001c0
  94         /* do a search for mpegps headers to be able to properly bias
  95          * towards mpegps if we detect this stream as both. */
  96         for (i = 0; i<p->buf_size; i++) {
  97             code = (code << 8) + p->buf[i];
  98             if ((code & 0xffffff00) == 0x100) {
  99                 if     ((code & 0x1f0) == VIDEO_ID) pes++;
 100                 else if((code & 0x1e0) == AUDIO_ID) pes++;
 101             }
 102         }
 103
 104         if (pes)
 105             max_frames = (max_frames + pes - 1) / pes;
 106     }
 107     if      (max_frames >  500) return AVPROBE_SCORE_EXTENSION;
 108     else if (max_frames >= 4)   return AVPROBE_SCORE_EXTENSION / 2;
 109     else if (max_frames >= 1)   return 1;
 110     else                        return 0;
 111 //mpegps_mp3_unrecognized_format.mpg has max_frames=3
 112 }
 113
 114 static void read_xing_toc(AVFormatContext *s, int64_t filesize, int64_t duration)
 115 {
 116     int i;
 117     MP3DecContext *mp3 = s->priv_data;
 118
 119     if (!filesize &&
 120         !(filesize = avio_size(s->pb))) {
 121         av_log(s, AV_LOG_WARNING, "Cannot determine file size, skipping TOC table.\n");
 122         return;
 123     }
 124
 125     for (i = 0; i < XING_TOC_COUNT; i++) {
 126         uint8_t b = avio_r8(s->pb);
 127
 128         av_add_index_entry(s->streams[0],
 129                            av_rescale(b, filesize, 256),
 130                            av_rescale(i, duration, XING_TOC_COUNT),
 131                            0, 0, AVINDEX_KEYFRAME);
 132     }
 133     mp3->xing_toc = 1;
 134 }
 135
 136 static void mp3_parse_info_tag(AVFormatContext *s, AVStream *st,
 137                                MPADecodeHeader *c, uint32_t spf)
 138 {
 139 #define LAST_BITS(k, n) ((k) & ((1 << (n)) - 1))
 140 #define MIDDLE_BITS(k, m, n) LAST_BITS((k) >> (m), ((n) - (m)))
 141
 142     uint16_t crc;
 143     uint32_t v;
 144
 145     char version[10];
 146
 147     uint32_t peak   = 0;
 148     int32_t  r_gain = INT32_MIN, a_gain = INT32_MIN;
 149
 150     MP3DecContext *mp3 = s->priv_data;
 151     const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
 152
 153     /* Check for Xing / Info tag */
 154     avio_skip(s->pb, xing_offtbl[c->lsf == 1][c->nb_channels == 1]);
 155     v = avio_rb32(s->pb);
 156     mp3->is_cbr = v == MKBETAG('I', 'n', 'f', 'o');
 157     if (v != MKBETAG('X', 'i', 'n', 'g') && !mp3->is_cbr)
 158         return;
 159
 160     v = avio_rb32(s->pb);
 161     if (v & XING_FLAG_FRAMES)
 162         mp3->frames = avio_rb32(s->pb);
 163     if (v & XING_FLAG_SIZE)
 164         mp3->size = avio_rb32(s->pb);
 165     if (v & XING_FLAG_TOC && mp3->frames)
 166         read_xing_toc(s, mp3->size, av_rescale_q(mp3->frames,
 167                                        (AVRational){spf, c->sample_rate},
 168                                        st->time_base));
 169
 170     /* VBR quality */
 171     avio_rb32(s->pb);
 172
 173     /* Encoder short version string */
 174     memset(version, 0, sizeof(version));
 175     avio_read(s->pb, version, 9);
 176
 177     /* Info Tag revision + VBR method */
 178     avio_r8(s->pb);
 179
 180     /* Lowpass filter value */
 181     avio_r8(s->pb);
 182
 183     /* ReplayGain peak */
 184     v    = avio_rb32(s->pb);
 185     peak = av_rescale(v, 100000, 1 << 23);
 186
 187     /* Radio ReplayGain */
 188     v = avio_rb16(s->pb);
 189
 190     if (MIDDLE_BITS(v, 13, 15) == 1) {
 191         r_gain = MIDDLE_BITS(v, 0, 8) * 10000;
 192
 193         if (v & (1 << 9))
 194             r_gain *= -1;
 195     }
 196
 197     /* Audiophile ReplayGain */
 198     v = avio_rb16(s->pb);
 199
 200     if (MIDDLE_BITS(v, 13, 15) == 2) {
 201         a_gain = MIDDLE_BITS(v, 0, 8) * 10000;
 202
 203         if (v & (1 << 9))
 204             a_gain *= -1;
 205     }
 206
 207     /* Encoding flags + ATH Type */
 208     avio_r8(s->pb);
 209
 210     /* if ABR {specified bitrate} else {minimal bitrate} */
 211     avio_r8(s->pb);
 212
 213     /* Encoder delays */
 214     avio_rb24(s->pb);
 215
 216     /* Misc */
 217     avio_r8(s->pb);
 218
 219     /* MP3 gain */
 220     avio_r8(s->pb);
 221
 222     /* Preset and surround info */
 223     avio_rb16(s->pb);
 224
 225     /* Music length */
 226     avio_rb32(s->pb);
 227
 228     /* Music CRC */
 229     avio_rb16(s->pb);
 230
 231     /* Info Tag CRC */
 232     crc = ffio_get_checksum(s->pb);
 233     v   = avio_rb16(s->pb);
 234
 235     if (v == crc) {
 236         ff_replaygain_export_raw(st, r_gain, peak, a_gain, 0);
 237         av_dict_set(&st->metadata, "encoder", version, 0);
 238     }
 239 }
 240
 241 static void mp3_parse_vbri_tag(AVFormatContext *s, AVStream *st, int64_t base)
 242 {
 243     uint32_t v;
 244     MP3DecContext *mp3 = s->priv_data;
 245
 246     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
 247     avio_seek(s->pb, base + 4 + 32, SEEK_SET);
 248     v = avio_rb32(s->pb);
 249     if (v == MKBETAG('V', 'B', 'R', 'I')) {
 250         /* Check tag version */
 251         if (avio_rb16(s->pb) == 1) {
 252             /* skip delay and quality */
 253             avio_skip(s->pb, 4);
 254             mp3->size = avio_rb32(s->pb);
 255             mp3->frames = avio_rb32(s->pb);
 256         }
 257     }
 258 }
 259
 260 /**
 261  * Try to find Xing/Info/VBRI tags and compute duration from info therein
 262  */
 263 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
 264 {
 265     uint32_t v, spf;
 266     MPADecodeHeader c;
 267     int vbrtag_size = 0;
 268     MP3DecContext *mp3 = s->priv_data;
 269
 270     ffio_init_checksum(s->pb, ff_crcA001_update, 0);
 271
 272     v = avio_rb32(s->pb);
 273     if(ff_mpa_check_header(v) < 0)
 274       return -1;
 275
 276     if (avpriv_mpegaudio_decode_header(&c, v) == 0)
 277         vbrtag_size = c.frame_size;
 278     if(c.layer != 3)
 279         return -1;
 280
 281     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
 282
 283     mp3->frames = 0;
 284     mp3->size   = 0;
 285
 286     mp3_parse_info_tag(s, st, &c, spf);
 287     mp3_parse_vbri_tag(s, st, base);
 288
 289     if (!mp3->frames && !mp3->size)
 290         return -1;
 291
 292     /* Skip the vbr tag frame */
 293     avio_seek(s->pb, base + vbrtag_size, SEEK_SET);
 294
 295     if (mp3->frames)
 296         st->duration = av_rescale_q(mp3->frames, (AVRational){spf, c.sample_rate},
 297                                     st->time_base);
 298     if (mp3->size && mp3->frames && !mp3->is_cbr)
 299         st->codec->bit_rate = av_rescale(mp3->size, 8 * c.sample_rate, mp3->frames * (int64_t)spf);
 300
 301     return 0;
 302 }
 303
 304 static int mp3_read_header(AVFormatContext *s)
 305 {
 306     AVStream *st;
 307     int64_t off;
 308     int ret;
 309
 310     st = avformat_new_stream(s, NULL);
 311     if (!st)
 312         return AVERROR(ENOMEM);
 313
 314     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 315     st->codec->codec_id = AV_CODEC_ID_MP3;
 316     st->need_parsing = AVSTREAM_PARSE_FULL;
 317     st->start_time = 0;
 318
 319     // lcm of all mp3 sample rates
 320     avpriv_set_pts_info(st, 64, 1, 14112000);
 321
 322     off = avio_tell(s->pb);
 323
 324     if (!av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
 325         ff_id3v1_read(s);
 326
 327     if (mp3_parse_vbr_tags(s, st, off) < 0)
 328         avio_seek(s->pb, off, SEEK_SET);
 329
 330     ret = ff_replaygain_export(st, s->metadata);
 331     if (ret < 0)
 332         return ret;
 333
 334     /* the parameters will be extracted from the compressed bitstream */
 335     return 0;
 336 }
 337
 338 #define MP3_PACKET_SIZE 1024
 339
 340 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
 341 {
 342     int ret;
 343
 344     ret = av_get_packet(s->pb, pkt, MP3_PACKET_SIZE);
 345     if (ret < 0)
 346         return ret;
 347
 348     pkt->stream_index = 0;
 349
 350     if (ret > ID3v1_TAG_SIZE &&
 351         memcmp(&pkt->data[ret - ID3v1_TAG_SIZE], "TAG", 3) == 0)
 352         ret -= ID3v1_TAG_SIZE;
 353
 354     /* note: we need to modify the packet size here to handle the last
 355        packet */
 356     pkt->size = ret;
 357     return ret;
 358 }
 359
 360 static int mp3_seek(AVFormatContext *s, int stream_index, int64_t timestamp,
 361                     int flags)
 362 {
 363     MP3DecContext *mp3 = s->priv_data;
 364     AVIndexEntry *ie;
 365     AVStream *st = s->streams[0];
 366     int64_t ret  = av_index_search_timestamp(st, timestamp, flags);
 367     uint32_t header = 0;
 368
 369     if (!mp3->xing_toc)
 370         return AVERROR(ENOSYS);
 371
 372     if (ret < 0)
 373         return ret;
 374
 375     ie = &st->index_entries[ret];
 376     ret = avio_seek(s->pb, ie->pos, SEEK_SET);
 377     if (ret < 0)
 378         return ret;
 379
 380     while (!s->pb->eof_reached) {
 381         header = (header << 8) + avio_r8(s->pb);
 382         if (ff_mpa_check_header(header) >= 0) {
 383             ff_update_cur_dts(s, st, ie->timestamp);
 384             ret = avio_seek(s->pb, -4, SEEK_CUR);
 385             return (ret >= 0) ? 0 : ret;
 386         }
 387     }
 388
 389     return AVERROR_EOF;
 390 }
 391
 392 AVInputFormat ff_mp3_demuxer = {
 393     .name           = "mp3",
 394     .long_name      = NULL_IF_CONFIG_SMALL("MP2/3 (MPEG audio layer 2/3)"),
 395     .read_probe     = mp3_read_probe,
 396     .read_header    = mp3_read_header,
 397     .read_packet    = mp3_read_packet,
 398     .read_seek      = mp3_seek,
 399     .priv_data_size = sizeof(MP3DecContext),
 400     .flags          = AVFMT_GENERIC_INDEX,
 401     .extensions     = "mp2,mp3,m2a,mpa", /* XXX: use probe */
 402 };