git.sesse.net Git - ffmpeg/blob - 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/mpegaudiodecheader.h"
  36
  37 #define XING_FLAG_FRAMES 0x01
  38 #define XING_FLAG_SIZE   0x02
  39 #define XING_FLAG_TOC    0x04
  40
  41 #define XING_TOC_COUNT 100
  42
  43 typedef struct {
  44     AVClass *class;
  45     int64_t filesize;
  46     int xing_toc;
  47     int start_pad;
  48     int end_pad;
  49     int usetoc;
  50     unsigned frames; /* Total number of frames in file */
  51     unsigned header_filesize;   /* Total number of bytes in the stream */
  52     int is_cbr;
  53 } MP3DecContext;
  54
  55 /* mp3 read */
  56
  57 static int mp3_read_probe(AVProbeData *p)
  58 {
  59     int max_frames, first_frames = 0;
  60     int fsize, frames, sample_rate;
  61     uint32_t header;
  62     const uint8_t *buf, *buf0, *buf2, *end;
  63     AVCodecContext avctx;
  64
  65     buf0 = p->buf;
  66     end = p->buf + p->buf_size - sizeof(uint32_t);
  67     while(buf0 < end && !*buf0)
  68         buf0++;
  69
  70     max_frames = 0;
  71     buf = buf0;
  72
  73     for(; buf < end; buf= buf2+1) {
  74         buf2 = buf;
  75         if(ff_mpa_check_header(AV_RB32(buf2)))
  76             continue;
  77
  78         for(frames = 0; buf2 < end; frames++) {
  79             header = AV_RB32(buf2);
  80             fsize = avpriv_mpa_decode_header(&avctx, header, &sample_rate, &sample_rate, &sample_rate, &sample_rate);
  81             if(fsize < 0)
  82                 break;
  83             buf2 += fsize;
  84         }
  85         max_frames = FFMAX(max_frames, frames);
  86         if(buf == buf0)
  87             first_frames= frames;
  88     }
  89     // keep this in sync with ac3 probe, both need to avoid
  90     // issues with MPEG-files!
  91     if   (first_frames>=4) return AVPROBE_SCORE_EXTENSION + 1;
  92     else if(max_frames>200)return AVPROBE_SCORE_EXTENSION;
  93     else if(max_frames>=4 && max_frames >= p->buf_size/10000) return AVPROBE_SCORE_EXTENSION / 2;
  94     else if(ff_id3v2_match(buf0, ID3v2_DEFAULT_MAGIC) && 2*ff_id3v2_tag_len(buf0) >= p->buf_size)
  95                            return p->buf_size < PROBE_BUF_MAX ? AVPROBE_SCORE_EXTENSION / 4 : AVPROBE_SCORE_EXTENSION - 2;
  96     else if(max_frames>=1 && max_frames >= p->buf_size/10000) return 1;
  97     else                   return 0;
  98 //mpegps_mp3_unrecognized_format.mpg has max_frames=3
  99 }
 100
 101 static void read_xing_toc(AVFormatContext *s, int64_t filesize, int64_t duration)
 102 {
 103     int i;
 104     MP3DecContext *mp3 = s->priv_data;
 105     int fill_index = mp3->usetoc && duration > 0;
 106
 107     if (!filesize &&
 108         !(filesize = avio_size(s->pb))) {
 109         av_log(s, AV_LOG_WARNING, "Cannot determine file size, skipping TOC table.\n");
 110         fill_index = 0;
 111     }
 112
 113     for (i = 0; i < XING_TOC_COUNT; i++) {
 114         uint8_t b = avio_r8(s->pb);
 115         if (fill_index)
 116             av_add_index_entry(s->streams[0],
 117                            av_rescale(b, filesize, 256),
 118                            av_rescale(i, duration, XING_TOC_COUNT),
 119                            0, 0, AVINDEX_KEYFRAME);
 120     }
 121     if (fill_index)
 122         mp3->xing_toc = 1;
 123 }
 124
 125 static void mp3_parse_info_tag(AVFormatContext *s, AVStream *st,
 126                                MPADecodeHeader *c, uint32_t spf)
 127 {
 128 #define LAST_BITS(k, n) ((k) & ((1 << (n)) - 1))
 129 #define MIDDLE_BITS(k, m, n) LAST_BITS((k) >> (m), ((n) - (m)))
 130
 131     uint16_t crc;
 132     uint32_t v;
 133
 134     char version[10];
 135
 136     uint32_t peak   = 0;
 137     int32_t  r_gain = INT32_MIN, a_gain = INT32_MIN;
 138
 139     MP3DecContext *mp3 = s->priv_data;
 140     static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
 141
 142     /* Check for Xing / Info tag */
 143     avio_skip(s->pb, xing_offtbl[c->lsf == 1][c->nb_channels == 1]);
 144     v = avio_rb32(s->pb);
 145     mp3->is_cbr = v == MKBETAG('I', 'n', 'f', 'o');
 146     if (v != MKBETAG('X', 'i', 'n', 'g') && !mp3->is_cbr)
 147         return;
 148
 149     v = avio_rb32(s->pb);
 150     if (v & XING_FLAG_FRAMES)
 151         mp3->frames = avio_rb32(s->pb);
 152     if (v & XING_FLAG_SIZE)
 153         mp3->header_filesize = avio_rb32(s->pb);
 154     if (v & XING_FLAG_TOC)
 155         read_xing_toc(s, mp3->header_filesize, av_rescale_q(mp3->frames,
 156                                        (AVRational){spf, c->sample_rate},
 157                                        st->time_base));
 158     /* VBR quality */
 159     if(v & 8)
 160         avio_skip(s->pb, 4);
 161
 162     /* Encoder short version string */
 163     memset(version, 0, sizeof(version));
 164     avio_read(s->pb, version, 9);
 165
 166     /* Info Tag revision + VBR method */
 167     avio_r8(s->pb);
 168
 169     /* Lowpass filter value */
 170     avio_r8(s->pb);
 171
 172     /* ReplayGain peak */
 173     v    = avio_rb32(s->pb);
 174     peak = av_rescale(v, 100000, 1 << 23);
 175
 176     /* Radio ReplayGain */
 177     v = avio_rb16(s->pb);
 178
 179     if (MIDDLE_BITS(v, 13, 15) == 1) {
 180         r_gain = MIDDLE_BITS(v, 0, 8) * 10000;
 181
 182         if (v & (1 << 9))
 183             r_gain *= -1;
 184     }
 185
 186     /* Audiophile ReplayGain */
 187     v = avio_rb16(s->pb);
 188
 189     if (MIDDLE_BITS(v, 13, 15) == 2) {
 190         a_gain = MIDDLE_BITS(v, 0, 8) * 10000;
 191
 192         if (v & (1 << 9))
 193             a_gain *= -1;
 194     }
 195
 196     /* Encoding flags + ATH Type */
 197     avio_r8(s->pb);
 198
 199     /* if ABR {specified bitrate} else {minimal bitrate} */
 200     avio_r8(s->pb);
 201
 202     /* Encoder delays */
 203     v= avio_rb24(s->pb);
 204     if(AV_RB32(version) == MKBETAG('L', 'A', 'M', 'E')
 205         || AV_RB32(version) == MKBETAG('L', 'a', 'v', 'f')) {
 206
 207         mp3->start_pad = v>>12;
 208         mp3->  end_pad = v&4095;
 209         st->skip_samples = mp3->start_pad + 528 + 1;
 210         if (!st->start_time)
 211             st->start_time = av_rescale_q(st->skip_samples,
 212                                             (AVRational){1, c->sample_rate},
 213                                             st->time_base);
 214         av_log(s, AV_LOG_DEBUG, "pad %d %d\n", mp3->start_pad, mp3->  end_pad);
 215     }
 216
 217     /* Misc */
 218     avio_r8(s->pb);
 219
 220     /* MP3 gain */
 221     avio_r8(s->pb);
 222
 223     /* Preset and surround info */
 224     avio_rb16(s->pb);
 225
 226     /* Music length */
 227     avio_rb32(s->pb);
 228
 229     /* Music CRC */
 230     avio_rb16(s->pb);
 231
 232     /* Info Tag CRC */
 233     crc = ffio_get_checksum(s->pb);
 234     v   = avio_rb16(s->pb);
 235
 236     if (v == crc) {
 237         ff_replaygain_export_raw(st, r_gain, peak, a_gain, 0);
 238         av_dict_set(&st->metadata, "encoder", version, 0);
 239     }
 240 }
 241
 242 static void mp3_parse_vbri_tag(AVFormatContext *s, AVStream *st, int64_t base)
 243 {
 244     uint32_t v;
 245     MP3DecContext *mp3 = s->priv_data;
 246
 247     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
 248     avio_seek(s->pb, base + 4 + 32, SEEK_SET);
 249     v = avio_rb32(s->pb);
 250     if (v == MKBETAG('V', 'B', 'R', 'I')) {
 251         /* Check tag version */
 252         if (avio_rb16(s->pb) == 1) {
 253             /* skip delay and quality */
 254             avio_skip(s->pb, 4);
 255             mp3->header_filesize = avio_rb32(s->pb);
 256             mp3->frames = avio_rb32(s->pb);
 257         }
 258     }
 259 }
 260
 261 /**
 262  * Try to find Xing/Info/VBRI tags and compute duration from info therein
 263  */
 264 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
 265 {
 266     uint32_t v, spf;
 267     MPADecodeHeader c;
 268     int vbrtag_size = 0;
 269     MP3DecContext *mp3 = s->priv_data;
 270
 271     ffio_init_checksum(s->pb, ff_crcA001_update, 0);
 272
 273     v = avio_rb32(s->pb);
 274     if(ff_mpa_check_header(v) < 0)
 275       return -1;
 276
 277     if (avpriv_mpegaudio_decode_header(&c, v) == 0)
 278         vbrtag_size = c.frame_size;
 279     if(c.layer != 3)
 280         return -1;
 281
 282     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
 283
 284     mp3->frames = 0;
 285     mp3->header_filesize   = 0;
 286
 287     mp3_parse_info_tag(s, st, &c, spf);
 288     mp3_parse_vbri_tag(s, st, base);
 289
 290     if (!mp3->frames && !mp3->header_filesize)
 291         return -1;
 292
 293     /* Skip the vbr tag frame */
 294     avio_seek(s->pb, base + vbrtag_size, SEEK_SET);
 295
 296     if (mp3->frames)
 297         st->duration = av_rescale_q(mp3->frames, (AVRational){spf, c.sample_rate},
 298                                     st->time_base);
 299     if (mp3->header_filesize && mp3->frames && !mp3->is_cbr)
 300         st->codec->bit_rate = av_rescale(mp3->header_filesize, 8 * c.sample_rate, mp3->frames * (int64_t)spf);
 301
 302     return 0;
 303 }
 304
 305 static int mp3_read_header(AVFormatContext *s)
 306 {
 307     MP3DecContext *mp3 = s->priv_data;
 308     AVStream *st;
 309     int64_t off;
 310     int ret;
 311
 312     st = avformat_new_stream(s, NULL);
 313     if (!st)
 314         return AVERROR(ENOMEM);
 315
 316     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 317     st->codec->codec_id = AV_CODEC_ID_MP3;
 318     st->need_parsing = AVSTREAM_PARSE_FULL_RAW;
 319     st->start_time = 0;
 320
 321     // lcm of all mp3 sample rates
 322     avpriv_set_pts_info(st, 64, 1, 14112000);
 323
 324     s->pb->maxsize = -1;
 325     off = avio_tell(s->pb);
 326
 327     if (!av_dict_get(s->metadata, "", NULL, AV_DICT_IGNORE_SUFFIX))
 328         ff_id3v1_read(s);
 329
 330     if(s->pb->seekable)
 331         mp3->filesize = avio_size(s->pb);
 332
 333     if (mp3_parse_vbr_tags(s, st, off) < 0)
 334         avio_seek(s->pb, off, SEEK_SET);
 335
 336     ret = ff_replaygain_export(st, s->metadata);
 337     if (ret < 0)
 338         return ret;
 339
 340     /* the parameters will be extracted from the compressed bitstream */
 341     return 0;
 342 }
 343
 344 #define MP3_PACKET_SIZE 1024
 345
 346 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
 347 {
 348     MP3DecContext *mp3 = s->priv_data;
 349     int ret, size;
 350     int64_t pos;
 351
 352     size= MP3_PACKET_SIZE;
 353     pos = avio_tell(s->pb);
 354     if(mp3->filesize > ID3v1_TAG_SIZE && pos < mp3->filesize)
 355         size= FFMIN(size, mp3->filesize - pos);
 356
 357     ret= av_get_packet(s->pb, pkt, size);
 358     if (ret <= 0) {
 359         if(ret<0)
 360             return ret;
 361         return AVERROR_EOF;
 362     }
 363
 364     pkt->flags &= ~AV_PKT_FLAG_CORRUPT;
 365     pkt->stream_index = 0;
 366
 367     if (ret >= ID3v1_TAG_SIZE &&
 368         memcmp(&pkt->data[ret - ID3v1_TAG_SIZE], "TAG", 3) == 0)
 369         ret -= ID3v1_TAG_SIZE;
 370
 371     /* note: we need to modify the packet size here to handle the last
 372        packet */
 373     pkt->size = ret;
 374     return ret;
 375 }
 376
 377 static int check(AVFormatContext *s, int64_t pos)
 378 {
 379     int64_t ret = avio_seek(s->pb, pos, SEEK_SET);
 380     unsigned header;
 381     MPADecodeHeader sd;
 382     if (ret < 0)
 383         return ret;
 384     header = avio_rb32(s->pb);
 385     if (ff_mpa_check_header(header) < 0)
 386         return -1;
 387     if (avpriv_mpegaudio_decode_header(&sd, header) == 1)
 388         return -1;
 389     return sd.frame_size;
 390 }
 391
 392 static int mp3_seek(AVFormatContext *s, int stream_index, int64_t timestamp,
 393                     int flags)
 394 {
 395     MP3DecContext *mp3 = s->priv_data;
 396     AVIndexEntry *ie, ie1;
 397     AVStream *st = s->streams[0];
 398     int64_t ret  = av_index_search_timestamp(st, timestamp, flags);
 399     int i, j;
 400     int dir = (flags&AVSEEK_FLAG_BACKWARD) ? -1 : 1;
 401
 402     if (mp3->is_cbr && st->duration > 0 && mp3->header_filesize > s->data_offset) {
 403         int64_t filesize = avio_size(s->pb);
 404         int64_t duration;
 405         if (filesize <= s->data_offset)
 406             filesize = mp3->header_filesize;
 407         filesize -= s->data_offset;
 408         duration = av_rescale(st->duration, filesize, mp3->header_filesize - s->data_offset);
 409         ie = &ie1;
 410         timestamp = av_clip64(timestamp, 0, duration);
 411         ie->timestamp = timestamp;
 412         ie->pos       = av_rescale(timestamp, filesize, duration) + s->data_offset;
 413     } else if (mp3->xing_toc) {
 414         if (ret < 0)
 415             return ret;
 416
 417         ie = &st->index_entries[ret];
 418     } else {
 419         st->skip_samples = timestamp <= 0 ? mp3->start_pad + 528 + 1 : 0;
 420
 421         return -1;
 422     }
 423
 424     if (dir < 0)
 425         avio_seek(s->pb, FFMAX(ie->pos - 4096, 0), SEEK_SET);
 426     ret = avio_seek(s->pb, ie->pos, SEEK_SET);
 427     if (ret < 0)
 428         return ret;
 429
 430 #define MIN_VALID 3
 431     for(i=0; i<4096; i++) {
 432         int64_t pos = ie->pos + i*dir;
 433         for(j=0; j<MIN_VALID; j++) {
 434             ret = check(s, pos);
 435             if(ret < 0)
 436                 break;
 437             pos += ret;
 438         }
 439         if(j==MIN_VALID)
 440             break;
 441     }
 442     if(j!=MIN_VALID)
 443         i=0;
 444
 445     ret = avio_seek(s->pb, ie->pos + i*dir, SEEK_SET);
 446     if (ret < 0)
 447         return ret;
 448     ff_update_cur_dts(s, st, ie->timestamp);
 449     st->skip_samples = ie->timestamp <= 0 ? mp3->start_pad + 528 + 1 : 0;
 450     return 0;
 451 }
 452
 453 static const AVOption options[] = {
 454     { "usetoc", "use table of contents", offsetof(MP3DecContext, usetoc), AV_OPT_TYPE_INT, {.i64 = -1}, -1, 1, AV_OPT_FLAG_DECODING_PARAM},
 455     { NULL },
 456 };
 457
 458 static const AVClass demuxer_class = {
 459     .class_name = "mp3",
 460     .item_name  = av_default_item_name,
 461     .option     = options,
 462     .version    = LIBAVUTIL_VERSION_INT,
 463     .category   = AV_CLASS_CATEGORY_DEMUXER,
 464 };
 465
 466 AVInputFormat ff_mp3_demuxer = {
 467     .name           = "mp3",
 468     .long_name      = NULL_IF_CONFIG_SMALL("MP2/3 (MPEG audio layer 2/3)"),
 469     .read_probe     = mp3_read_probe,
 470     .read_header    = mp3_read_header,
 471     .read_packet    = mp3_read_packet,
 472     .read_seek      = mp3_seek,
 473     .priv_data_size = sizeof(MP3DecContext),
 474     .flags          = AVFMT_GENERIC_INDEX,
 475     .extensions     = "mp2,mp3,m2a,mpa", /* XXX: use probe */
 476     .priv_class     = &demuxer_class,
 477 };