Libav
mp3dec.c
Go to the documentation of this file.
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/avcodec.h"
36 
37 #define XING_FLAG_FRAMES 0x01
38 #define XING_FLAG_SIZE 0x02
39 #define XING_FLAG_TOC 0x04
40 #define XING_FLAC_QSCALE 0x08
41 
42 #define XING_TOC_COUNT 100
43 
44 typedef struct MP3DecContext {
45  int xing_toc;
46  unsigned frames; /* Total number of frames in file */
47  unsigned size; /* Total number of bytes in the stream */
48  int is_cbr;
50 
51 /* mp3 read */
52 
54 {
55  int max_frames, first_frames = 0;
56  int fsize, frames, sample_rate;
57  uint32_t header;
58  uint8_t *buf, *buf0, *buf2, *end;
60 
61  if (!avctx)
62  return AVERROR(ENOMEM);
63 
64  buf0 = p->buf;
65  end = p->buf + p->buf_size - sizeof(uint32_t);
66  while(buf0 < end && !*buf0)
67  buf0++;
68 
69  max_frames = 0;
70  buf = buf0;
71 
72  for(; buf < end; buf= buf2+1) {
73  buf2 = buf;
74 
75  for(frames = 0; buf2 < end; frames++) {
76  header = AV_RB32(buf2);
77  fsize = avpriv_mpa_decode_header(avctx, header, &sample_rate,
78  &sample_rate, &sample_rate,
79  &sample_rate);
80  if(fsize < 0)
81  break;
82  buf2 += fsize;
83  }
84  max_frames = FFMAX(max_frames, frames);
85  if(buf == buf0)
86  first_frames= frames;
87  }
88  avcodec_free_context(&avctx);
89  // keep this in sync with ac3 probe, both need to avoid
90  // issues with MPEG-files!
91  if (first_frames >= 10)
92  return AVPROBE_SCORE_EXTENSION + 5;
93  if (first_frames >= 4)
94  return AVPROBE_SCORE_EXTENSION + 1;
95 
96  if (max_frames) {
97  int pes = 0, i;
98  unsigned int code = -1;
99 
100 #define VIDEO_ID 0x000001e0
101 #define AUDIO_ID 0x000001c0
102  /* do a search for mpegps headers to be able to properly bias
103  * towards mpegps if we detect this stream as both. */
104  for (i = 0; i<p->buf_size; i++) {
105  code = (code << 8) + p->buf[i];
106  if ((code & 0xffffff00) == 0x100) {
107  if ((code & 0x1f0) == VIDEO_ID) pes++;
108  else if((code & 0x1e0) == AUDIO_ID) pes++;
109  }
110  }
111 
112  if (pes)
113  max_frames = (max_frames + pes - 1) / pes;
114  }
115  if (max_frames > 500) return AVPROBE_SCORE_EXTENSION;
116  else if (max_frames >= 4) return AVPROBE_SCORE_EXTENSION / 2;
117  else if (max_frames >= 1) return 1;
118  else return 0;
119 //mpegps_mp3_unrecognized_format.mpg has max_frames=3
120 }
121 
122 static void read_xing_toc(AVFormatContext *s, int64_t filesize, int64_t duration)
123 {
124  int i;
125  MP3DecContext *mp3 = s->priv_data;
126 
127  if (!filesize &&
128  !(filesize = avio_size(s->pb))) {
129  av_log(s, AV_LOG_WARNING, "Cannot determine file size, skipping TOC table.\n");
130  return;
131  }
132 
133  for (i = 0; i < XING_TOC_COUNT; i++) {
134  uint8_t b = avio_r8(s->pb);
135 
137  av_rescale(b, filesize, 256),
138  av_rescale(i, duration, XING_TOC_COUNT),
139  0, 0, AVINDEX_KEYFRAME);
140  }
141  mp3->xing_toc = 1;
142 }
143 
145  MPADecodeHeader *c, uint32_t spf)
146 {
147 #define LAST_BITS(k, n) ((k) & ((1 << (n)) - 1))
148 #define MIDDLE_BITS(k, m, n) LAST_BITS((k) >> (m), ((n) - (m)))
149 
150  uint16_t crc;
151  uint32_t v;
152 
153  char version[10];
154 
155  uint32_t peak = 0;
156  int32_t r_gain = INT32_MIN, a_gain = INT32_MIN;
157 
158  MP3DecContext *mp3 = s->priv_data;
159  const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
160 
161  /* Check for Xing / Info tag */
162  avio_skip(s->pb, xing_offtbl[c->lsf == 1][c->nb_channels == 1]);
163  v = avio_rb32(s->pb);
164  mp3->is_cbr = v == MKBETAG('I', 'n', 'f', 'o');
165  if (v != MKBETAG('X', 'i', 'n', 'g') && !mp3->is_cbr)
166  return;
167 
168  v = avio_rb32(s->pb);
169  if (v & XING_FLAG_FRAMES)
170  mp3->frames = avio_rb32(s->pb);
171  if (v & XING_FLAG_SIZE)
172  mp3->size = avio_rb32(s->pb);
173  if (v & XING_FLAG_TOC && mp3->frames)
174  read_xing_toc(s, mp3->size, av_rescale_q(mp3->frames,
175  (AVRational){spf, c->sample_rate},
176  st->time_base));
177 
178  /* VBR quality */
179  if (v & XING_FLAC_QSCALE)
180  avio_rb32(s->pb);
181 
182  /* Encoder short version string */
183  memset(version, 0, sizeof(version));
184  avio_read(s->pb, version, 9);
185 
186  /* Info Tag revision + VBR method */
187  avio_r8(s->pb);
188 
189  /* Lowpass filter value */
190  avio_r8(s->pb);
191 
192  /* ReplayGain peak */
193  v = avio_rb32(s->pb);
194  peak = av_rescale(v, 100000, 1 << 23);
195 
196  /* Radio ReplayGain */
197  v = avio_rb16(s->pb);
198 
199  if (MIDDLE_BITS(v, 13, 15) == 1) {
200  r_gain = MIDDLE_BITS(v, 0, 8) * 10000;
201 
202  if (v & (1 << 9))
203  r_gain *= -1;
204  }
205 
206  /* Audiophile ReplayGain */
207  v = avio_rb16(s->pb);
208 
209  if (MIDDLE_BITS(v, 13, 15) == 2) {
210  a_gain = MIDDLE_BITS(v, 0, 8) * 10000;
211 
212  if (v & (1 << 9))
213  a_gain *= -1;
214  }
215 
216  /* Encoding flags + ATH Type */
217  avio_r8(s->pb);
218 
219  /* if ABR {specified bitrate} else {minimal bitrate} */
220  avio_r8(s->pb);
221 
222  /* Encoder delays */
223  avio_rb24(s->pb);
224 
225  /* Misc */
226  avio_r8(s->pb);
227 
228  /* MP3 gain */
229  avio_r8(s->pb);
230 
231  /* Preset and surround info */
232  avio_rb16(s->pb);
233 
234  /* Music length */
235  avio_rb32(s->pb);
236 
237  /* Music CRC */
238  avio_rb16(s->pb);
239 
240  /* Info Tag CRC */
241  crc = ffio_get_checksum(s->pb);
242  v = avio_rb16(s->pb);
243 
244  if (v == crc) {
245  ff_replaygain_export_raw(st, r_gain, peak, a_gain, 0);
246  av_dict_set(&st->metadata, "encoder", version, 0);
247  }
248 }
249 
250 static void mp3_parse_vbri_tag(AVFormatContext *s, AVStream *st, int64_t base)
251 {
252  uint32_t v;
253  MP3DecContext *mp3 = s->priv_data;
254 
255  /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
256  avio_seek(s->pb, base + 4 + 32, SEEK_SET);
257  v = avio_rb32(s->pb);
258  if (v == MKBETAG('V', 'B', 'R', 'I')) {
259  /* Check tag version */
260  if (avio_rb16(s->pb) == 1) {
261  /* skip delay and quality */
262  avio_skip(s->pb, 4);
263  mp3->size = avio_rb32(s->pb);
264  mp3->frames = avio_rb32(s->pb);
265  }
266  }
267 }
268 
272 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
273 {
274  uint32_t v, spf;
275  MPADecodeHeader c;
276  int vbrtag_size = 0;
277  MP3DecContext *mp3 = s->priv_data;
278 
280 
281  v = avio_rb32(s->pb);
282  if(ff_mpa_check_header(v) < 0)
283  return -1;
284 
285  if (avpriv_mpegaudio_decode_header(&c, v) == 0)
286  vbrtag_size = c.frame_size;
287  if(c.layer != 3)
288  return -1;
289 
290  spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
291 
292  mp3->frames = 0;
293  mp3->size = 0;
294 
295  mp3_parse_info_tag(s, st, &c, spf);
296  mp3_parse_vbri_tag(s, st, base);
297 
298  if (!mp3->frames && !mp3->size)
299  return -1;
300 
301  /* Skip the vbr tag frame */
302  avio_seek(s->pb, base + vbrtag_size, SEEK_SET);
303 
304  if (mp3->frames)
305  st->duration = av_rescale_q(mp3->frames, (AVRational){spf, c.sample_rate},
306  st->time_base);
307  if (mp3->size && mp3->frames && !mp3->is_cbr)
308  st->codec->bit_rate = av_rescale(mp3->size, 8 * c.sample_rate, mp3->frames * (int64_t)spf);
309 
310  return 0;
311 }
312 
314 {
315  AVStream *st;
316  int64_t off;
317  int ret;
318 
319  st = avformat_new_stream(s, NULL);
320  if (!st)
321  return AVERROR(ENOMEM);
322 
326  st->start_time = 0;
327 
328  // lcm of all mp3 sample rates
329  avpriv_set_pts_info(st, 64, 1, 14112000);
330 
331  off = avio_tell(s->pb);
332 
334  ff_id3v1_read(s);
335 
336  if (mp3_parse_vbr_tags(s, st, off) < 0)
337  avio_seek(s->pb, off, SEEK_SET);
338 
339  ret = ff_replaygain_export(st, s->metadata);
340  if (ret < 0)
341  return ret;
342 
343  /* the parameters will be extracted from the compressed bitstream */
344  return 0;
345 }
346 
347 #define MP3_PACKET_SIZE 1024
348 
350 {
351  int ret;
352 
353  ret = av_get_packet(s->pb, pkt, MP3_PACKET_SIZE);
354  if (ret < 0)
355  return ret;
356 
357  pkt->stream_index = 0;
358 
359  if (ret > ID3v1_TAG_SIZE &&
360  memcmp(&pkt->data[ret - ID3v1_TAG_SIZE], "TAG", 3) == 0)
361  ret -= ID3v1_TAG_SIZE;
362 
363  /* note: we need to modify the packet size here to handle the last
364  packet */
365  pkt->size = ret;
366  return ret;
367 }
368 
369 static int mp3_seek(AVFormatContext *s, int stream_index, int64_t timestamp,
370  int flags)
371 {
372  MP3DecContext *mp3 = s->priv_data;
373  AVIndexEntry *ie;
374  AVStream *st = s->streams[0];
375  int64_t ret = av_index_search_timestamp(st, timestamp, flags);
376  uint32_t header = 0;
377 
378  if (!mp3->xing_toc)
379  return AVERROR(ENOSYS);
380 
381  if (ret < 0)
382  return ret;
383 
384  ie = &st->index_entries[ret];
385  ret = avio_seek(s->pb, ie->pos, SEEK_SET);
386  if (ret < 0)
387  return ret;
388 
389  while (!s->pb->eof_reached) {
390  header = (header << 8) + avio_r8(s->pb);
391  if (ff_mpa_check_header(header) >= 0) {
392  ff_update_cur_dts(s, st, ie->timestamp);
393  ret = avio_seek(s->pb, -4, SEEK_CUR);
394  return (ret >= 0) ? 0 : ret;
395  }
396  }
397 
398  return AVERROR_EOF;
399 }
400 
402  .name = "mp3",
403  .long_name = NULL_IF_CONFIG_SMALL("MP2/3 (MPEG audio layer 2/3)"),
404  .read_probe = mp3_read_probe,
405  .read_header = mp3_read_header,
406  .read_packet = mp3_read_packet,
407  .read_seek = mp3_seek,
408  .priv_data_size = sizeof(MP3DecContext),
410  .extensions = "mp2,mp3,m2a,mpa", /* XXX: use probe */
411 };
int64_t avio_size(AVIOContext *s)
Get the filesize.
Definition: aviobuf.c:241
int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, int size, int distance, int flags)
Add an index entry into a sorted list.
Definition: utils.c:1181
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:129
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:2829
int64_t pos
Definition: avformat.h:660
void ff_id3v1_read(AVFormatContext *s)
Read an ID3v1 tag.
Definition: id3v1.c:227
int size
Definition: avcodec.h:974
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:186
AVIndexEntry * index_entries
Only used if the format does not support seeking natively.
Definition: avformat.h:878
static void read_xing_toc(AVFormatContext *s, int64_t filesize, int64_t duration)
Definition: mp3dec.c:122
unsigned int avio_rb16(AVIOContext *s)
Definition: aviobuf.c:580
unsigned frames
Definition: mp3dec.c:46
static int64_t duration
Definition: avplay.c:246
Format I/O context.
Definition: avformat.h:922
void ff_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp)
Update cur_dts of all streams based on the given timestamp and AVStream.
Definition: utils.c:1104
Public dictionary API.
static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
Definition: mp3dec.c:349
uint8_t
#define XING_FLAG_SIZE
Definition: mp3dec.c:38
unsigned int avio_rb32(AVIOContext *s)
Definition: aviobuf.c:595
static int mp3_seek(AVFormatContext *s, int stream_index, int64_t timestamp, int flags)
Definition: mp3dec.c:369
#define AV_RB32
Definition: intreadwrite.h:130
enum AVStreamParseType need_parsing
Definition: avformat.h:867
#define b
Definition: input.c:52
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:2521
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:990
AVDictionaryEntry * av_dict_get(const AVDictionary *m, const char *key, const AVDictionaryEntry *prev, int flags)
Get a dictionary entry with matching key.
Definition: dict.c:38
uint8_t * data
Definition: avcodec.h:973
int avpriv_mpegaudio_decode_header(MPADecodeHeader *s, uint32_t header)
static int flags
Definition: log.c:44
static const uint8_t xing_offtbl[2][2]
Definition: mp3enc.c:109
#define AVERROR_EOF
End of file.
Definition: error.h:51
int av_get_packet(AVIOContext *s, AVPacket *pkt, int size)
Allocate and read the payload of a packet and initialize its fields with default values.
Definition: utils.c:117
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:219
int ff_replaygain_export(AVStream *st, AVDictionary *metadata)
Parse replaygain tags and export them as per-stream side data.
Definition: replaygain.c:110
int avio_read(AVIOContext *s, unsigned char *buf, int size)
Read size bytes from AVIOContext into buf.
Definition: aviobuf.c:452
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:129
#define VIDEO_ID
#define AVINDEX_KEYFRAME
Definition: avformat.h:662
AVDictionary * metadata
Metadata that applies to the whole file.
Definition: avformat.h:1130
int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags)
Get the index for a specific timestamp.
Definition: utils.c:1222
#define AVERROR(e)
Definition: error.h:43
int64_t timestamp
Definition: avformat.h:661
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:150
static int mp3_read_header(AVFormatContext *s)
Definition: mp3dec.c:313
preferred ID for decoding MPEG audio layer 1, 2 or 3
Definition: avcodec.h:379
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:169
static int ff_mpa_check_header(uint32_t header)
#define FFMAX(a, b)
Definition: common.h:55
int avio_r8(AVIOContext *s)
Definition: aviobuf.c:443
int avpriv_mpa_decode_header(AVCodecContext *avctx, uint32_t head, int *sample_rate, int *channels, int *frame_size, int *bit_rate)
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:718
int buf_size
Size of buf except extra allocated bytes.
Definition: avformat.h:398
unsigned char * buf
Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero.
Definition: avformat.h:397
void ffio_init_checksum(AVIOContext *s, unsigned long(*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum)
Definition: aviobuf.c:431
int bit_rate
the average bitrate
Definition: avcodec.h:1114
unsigned int avio_rb24(AVIOContext *s)
Definition: aviobuf.c:588
int64_t av_rescale(int64_t a, int64_t b, int64_t c)
Rescale a 64-bit integer with rounding to nearest.
Definition: mathematics.c:116
#define MP3_PACKET_SIZE
Definition: mp3dec.c:347
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:124
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: avio.h:210
static void mp3_parse_info_tag(AVFormatContext *s, AVStream *st, MPADecodeHeader *c, uint32_t spf)
Definition: mp3dec.c:144
int32_t
int xing_toc
Definition: mp3dec.c:45
AVDictionary * metadata
Definition: avformat.h:771
unsigned long ff_crcA001_update(unsigned long checksum, const uint8_t *buf, unsigned int len)
Definition: aviobuf.c:417
static void mp3_parse_vbri_tag(AVFormatContext *s, AVStream *st, int64_t base)
Definition: mp3dec.c:250
if(ac->has_optimized_func)
Stream structure.
Definition: avformat.h:699
static int mp3_read_probe(AVProbeData *p)
Definition: mp3dec.c:53
NULL
Definition: eval.c:55
Libavcodec external API header.
enum AVMediaType codec_type
Definition: avcodec.h:1058
version
Definition: ffv1enc.c:1080
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer...
Definition: options.c:139
enum AVCodecID codec_id
Definition: avcodec.h:1067
AVIOContext * pb
I/O context.
Definition: avformat.h:964
main external API structure.
Definition: avcodec.h:1050
#define XING_FLAG_FRAMES
Definition: mp3dec.c:37
int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags)
Set the given entry in *pm, overwriting an existing entry.
Definition: dict.c:68
#define AVFMT_GENERIC_INDEX
Use generic index building code.
Definition: avformat.h:417
rational number numerator/denominator
Definition: rational.h:43
#define XING_FLAC_QSCALE
Definition: mp3dec.c:40
unsigned long ffio_get_checksum(AVIOContext *s)
Definition: aviobuf.c:423
#define AVPROBE_SCORE_EXTENSION
score for file extension
Definition: avformat.h:402
This structure contains the data a format has to probe a file.
Definition: avformat.h:395
#define AUDIO_ID
int64_t duration
Decoding: duration of the stream, in stream time base.
Definition: avformat.h:756
MPEG Audio header decoder.
int is_cbr
Definition: mp3dec.c:48
full parsing and repack
Definition: avformat.h:653
Main libavformat public API header.
int ff_replaygain_export_raw(AVStream *st, int32_t tg, uint32_t tp, int32_t ag, uint32_t ap)
Export already decoded replaygain values as per-stream side data.
Definition: replaygain.c:69
int64_t start_time
Decoding: pts of the first frame of the stream, in stream time base.
Definition: avformat.h:749
AVInputFormat ff_mp3_demuxer
Definition: mp3dec.c:401
#define MKBETAG(a, b, c, d)
Definition: common.h:239
#define XING_FLAG_TOC
Definition: mp3dec.c:39
#define MIDDLE_BITS(k, m, n)
unsigned size
Definition: mp3dec.c:47
int eof_reached
true if eof reached
Definition: avio.h:96
void * priv_data
Format private data.
Definition: avformat.h:950
#define XING_TOC_COUNT
Definition: mp3dec.c:42
static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
Try to find Xing/Info/VBRI tags and compute duration from info therein.
Definition: mp3dec.c:272
#define ID3v1_TAG_SIZE
Definition: id3v1.h:27
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:525
#define AV_DICT_IGNORE_SUFFIX
Definition: dict.h:62
int stream_index
Definition: avcodec.h:975
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:741
This structure stores compressed data.
Definition: avcodec.h:950