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