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