99095414a6af0966d79da60c37a7cb4e06e89a4f
[ffmpeg.git] / libavformat / mp3.c
1 /*
2  * MP3 muxer and 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 <strings.h>
23 #include "libavutil/avstring.h"
24 #include "libavcodec/mpegaudio.h"
25 #include "libavcodec/mpegaudiodecheader.h"
26 #include "avformat.h"
27 #include "id3v2.h"
28
29 #define ID3v1_TAG_SIZE 128
30
31 #define ID3v1_GENRE_MAX 125
32
33 static const char * const id3v1_genre_str[ID3v1_GENRE_MAX + 1] = {
34     [0] = "Blues",
35     [1] = "Classic Rock",
36     [2] = "Country",
37     [3] = "Dance",
38     [4] = "Disco",
39     [5] = "Funk",
40     [6] = "Grunge",
41     [7] = "Hip-Hop",
42     [8] = "Jazz",
43     [9] = "Metal",
44     [10] = "New Age",
45     [11] = "Oldies",
46     [12] = "Other",
47     [13] = "Pop",
48     [14] = "R&B",
49     [15] = "Rap",
50     [16] = "Reggae",
51     [17] = "Rock",
52     [18] = "Techno",
53     [19] = "Industrial",
54     [20] = "Alternative",
55     [21] = "Ska",
56     [22] = "Death Metal",
57     [23] = "Pranks",
58     [24] = "Soundtrack",
59     [25] = "Euro-Techno",
60     [26] = "Ambient",
61     [27] = "Trip-Hop",
62     [28] = "Vocal",
63     [29] = "Jazz+Funk",
64     [30] = "Fusion",
65     [31] = "Trance",
66     [32] = "Classical",
67     [33] = "Instrumental",
68     [34] = "Acid",
69     [35] = "House",
70     [36] = "Game",
71     [37] = "Sound Clip",
72     [38] = "Gospel",
73     [39] = "Noise",
74     [40] = "AlternRock",
75     [41] = "Bass",
76     [42] = "Soul",
77     [43] = "Punk",
78     [44] = "Space",
79     [45] = "Meditative",
80     [46] = "Instrumental Pop",
81     [47] = "Instrumental Rock",
82     [48] = "Ethnic",
83     [49] = "Gothic",
84     [50] = "Darkwave",
85     [51] = "Techno-Industrial",
86     [52] = "Electronic",
87     [53] = "Pop-Folk",
88     [54] = "Eurodance",
89     [55] = "Dream",
90     [56] = "Southern Rock",
91     [57] = "Comedy",
92     [58] = "Cult",
93     [59] = "Gangsta",
94     [60] = "Top 40",
95     [61] = "Christian Rap",
96     [62] = "Pop/Funk",
97     [63] = "Jungle",
98     [64] = "Native American",
99     [65] = "Cabaret",
100     [66] = "New Wave",
101     [67] = "Psychadelic",
102     [68] = "Rave",
103     [69] = "Showtunes",
104     [70] = "Trailer",
105     [71] = "Lo-Fi",
106     [72] = "Tribal",
107     [73] = "Acid Punk",
108     [74] = "Acid Jazz",
109     [75] = "Polka",
110     [76] = "Retro",
111     [77] = "Musical",
112     [78] = "Rock & Roll",
113     [79] = "Hard Rock",
114     [80] = "Folk",
115     [81] = "Folk-Rock",
116     [82] = "National Folk",
117     [83] = "Swing",
118     [84] = "Fast Fusion",
119     [85] = "Bebob",
120     [86] = "Latin",
121     [87] = "Revival",
122     [88] = "Celtic",
123     [89] = "Bluegrass",
124     [90] = "Avantgarde",
125     [91] = "Gothic Rock",
126     [92] = "Progressive Rock",
127     [93] = "Psychedelic Rock",
128     [94] = "Symphonic Rock",
129     [95] = "Slow Rock",
130     [96] = "Big Band",
131     [97] = "Chorus",
132     [98] = "Easy Listening",
133     [99] = "Acoustic",
134     [100] = "Humour",
135     [101] = "Speech",
136     [102] = "Chanson",
137     [103] = "Opera",
138     [104] = "Chamber Music",
139     [105] = "Sonata",
140     [106] = "Symphony",
141     [107] = "Booty Bass",
142     [108] = "Primus",
143     [109] = "Porn Groove",
144     [110] = "Satire",
145     [111] = "Slow Jam",
146     [112] = "Club",
147     [113] = "Tango",
148     [114] = "Samba",
149     [115] = "Folklore",
150     [116] = "Ballad",
151     [117] = "Power Ballad",
152     [118] = "Rhythmic Soul",
153     [119] = "Freestyle",
154     [120] = "Duet",
155     [121] = "Punk Rock",
156     [122] = "Drum Solo",
157     [123] = "A capella",
158     [124] = "Euro-House",
159     [125] = "Dance Hall",
160 };
161
162 static unsigned int id3v2_get_size(ByteIOContext *s, int len)
163 {
164     int v=0;
165     while(len--)
166         v= (v<<7) + (get_byte(s)&0x7F);
167     return v;
168 }
169
170 static void id3v2_read_ttag(AVFormatContext *s, int taglen, char *dst, int dstlen)
171 {
172     char *q;
173     int len;
174
175     if(dstlen > 0)
176         dst[0]= 0;
177     if(taglen < 1)
178         return;
179
180     taglen--; /* account for encoding type byte */
181     dstlen--; /* Leave space for zero terminator */
182
183     switch(get_byte(s->pb)) { /* encoding type */
184
185     case 0:  /* ISO-8859-1 (0 - 255 maps directly into unicode) */
186         q = dst;
187         while(taglen--) {
188             uint8_t tmp;
189             PUT_UTF8(get_byte(s->pb), tmp, if (q - dst < dstlen - 1) *q++ = tmp;)
190         }
191         *q = '\0';
192         break;
193
194     case 3:  /* UTF-8 */
195         len = FFMIN(taglen, dstlen-1);
196         get_buffer(s->pb, dst, len);
197         dst[len] = 0;
198         break;
199     }
200 }
201
202 /**
203  * ID3v2 parser
204  *
205  * Handles ID3v2.2, 2.3 and 2.4.
206  *
207  */
208
209 static void id3v2_parse(AVFormatContext *s, int len, uint8_t version, uint8_t flags)
210 {
211     int isv34, tlen;
212     uint32_t tag;
213     int64_t next;
214     char tmp[16];
215     int taghdrlen;
216     const char *reason;
217
218     switch(version) {
219     case 2:
220         if(flags & 0x40) {
221             reason = "compression";
222             goto error;
223         }
224         isv34 = 0;
225         taghdrlen = 6;
226         break;
227
228     case 3:
229     case 4:
230         isv34 = 1;
231         taghdrlen = 10;
232         break;
233
234     default:
235         reason = "version";
236         goto error;
237     }
238
239     if(flags & 0x80) {
240         reason = "unsynchronization";
241         goto error;
242     }
243
244     if(isv34 && flags & 0x40) /* Extended header present, just skip over it */
245         url_fskip(s->pb, id3v2_get_size(s->pb, 4));
246
247     while(len >= taghdrlen) {
248         if(isv34) {
249             tag  = get_be32(s->pb);
250             tlen = id3v2_get_size(s->pb, 4);
251             get_be16(s->pb); /* flags */
252         } else {
253             tag  = get_be24(s->pb);
254             tlen = id3v2_get_size(s->pb, 3);
255         }
256         len -= taghdrlen + tlen;
257
258         if(len < 0)
259             break;
260
261         next = url_ftell(s->pb) + tlen;
262
263         switch(tag) {
264         case MKBETAG('T', 'I', 'T', '2'):
265         case MKBETAG(0,   'T', 'T', '2'):
266             id3v2_read_ttag(s, tlen, s->title, sizeof(s->title));
267             break;
268         case MKBETAG('T', 'P', 'E', '1'):
269         case MKBETAG(0,   'T', 'P', '1'):
270             id3v2_read_ttag(s, tlen, s->author, sizeof(s->author));
271             break;
272         case MKBETAG('T', 'A', 'L', 'B'):
273         case MKBETAG(0,   'T', 'A', 'L'):
274             id3v2_read_ttag(s, tlen, s->album, sizeof(s->album));
275             break;
276         case MKBETAG('T', 'C', 'O', 'N'):
277         case MKBETAG(0,   'T', 'C', 'O'):
278             id3v2_read_ttag(s, tlen, s->genre, sizeof(s->genre));
279             break;
280         case MKBETAG('T', 'C', 'O', 'P'):
281         case MKBETAG(0,   'T', 'C', 'R'):
282             id3v2_read_ttag(s, tlen, s->copyright, sizeof(s->copyright));
283             break;
284         case MKBETAG('T', 'R', 'C', 'K'):
285         case MKBETAG(0,   'T', 'R', 'K'):
286             id3v2_read_ttag(s, tlen, tmp, sizeof(tmp));
287             s->track = atoi(tmp);
288             break;
289         case 0:
290             /* padding, skip to end */
291             url_fskip(s->pb, len);
292             len = 0;
293             continue;
294         }
295         /* Skip to end of tag */
296         url_fseek(s->pb, next, SEEK_SET);
297     }
298
299     if(version == 4 && flags & 0x10) /* Footer preset, always 10 bytes, skip over it */
300         url_fskip(s->pb, 10);
301     return;
302
303   error:
304     av_log(s, AV_LOG_INFO, "ID3v2.%d tag skipped, cannot handle %s\n", version, reason);
305     url_fskip(s->pb, len);
306 }
307
308 static void id3v1_get_string(char *str, int str_size,
309                              const uint8_t *buf, int buf_size)
310 {
311     int i, c;
312     char *q;
313
314     q = str;
315     for(i = 0; i < buf_size; i++) {
316         c = buf[i];
317         if (c == '\0')
318             break;
319         if ((q - str) >= str_size - 1)
320             break;
321         *q++ = c;
322     }
323     *q = '\0';
324 }
325
326 /* 'buf' must be ID3v1_TAG_SIZE byte long */
327 static int id3v1_parse_tag(AVFormatContext *s, const uint8_t *buf)
328 {
329     char str[5];
330     int genre;
331
332     if (!(buf[0] == 'T' &&
333           buf[1] == 'A' &&
334           buf[2] == 'G'))
335         return -1;
336     id3v1_get_string(s->title, sizeof(s->title), buf + 3, 30);
337     id3v1_get_string(s->author, sizeof(s->author), buf + 33, 30);
338     id3v1_get_string(s->album, sizeof(s->album), buf + 63, 30);
339     id3v1_get_string(str, sizeof(str), buf + 93, 4);
340     s->year = atoi(str);
341     id3v1_get_string(s->comment, sizeof(s->comment), buf + 97, 30);
342     if (buf[125] == 0 && buf[126] != 0)
343         s->track = buf[126];
344     genre = buf[127];
345     if (genre <= ID3v1_GENRE_MAX)
346         av_strlcpy(s->genre, id3v1_genre_str[genre], sizeof(s->genre));
347     return 0;
348 }
349
350 /* mp3 read */
351
352 static int mp3_read_probe(AVProbeData *p)
353 {
354     int max_frames, first_frames = 0;
355     int fsize, frames, sample_rate;
356     uint32_t header;
357     uint8_t *buf, *buf2, *end;
358     AVCodecContext avctx;
359
360     if(ff_id3v2_match(p->buf))
361         return AVPROBE_SCORE_MAX/2+1; // this must be less than mpeg-ps because some retards put id3v2 tags before mpeg-ps files
362
363     max_frames = 0;
364     buf = p->buf;
365     end = buf + p->buf_size - sizeof(uint32_t);
366
367     for(; buf < end; buf= buf2+1) {
368         buf2 = buf;
369
370         for(frames = 0; buf2 < end; frames++) {
371             header = AV_RB32(buf2);
372             fsize = ff_mpa_decode_header(&avctx, header, &sample_rate, &sample_rate, &sample_rate, &sample_rate);
373             if(fsize < 0)
374                 break;
375             buf2 += fsize;
376         }
377         max_frames = FFMAX(max_frames, frames);
378         if(buf == p->buf)
379             first_frames= frames;
380     }
381     if   (first_frames>=3) return AVPROBE_SCORE_MAX/2+1;
382     else if(max_frames>500)return AVPROBE_SCORE_MAX/2;
383     else if(max_frames>=3) return AVPROBE_SCORE_MAX/4;
384     else if(max_frames>=1) return 1;
385     else                   return 0;
386 }
387
388 /**
389  * Try to find Xing/Info/VBRI tags and compute duration from info therein
390  */
391 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
392 {
393     uint32_t v, spf;
394     int frames = -1; /* Total number of frames in file */
395     const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
396     MPADecodeContext c;
397     int vbrtag_size = 0;
398
399     v = get_be32(s->pb);
400     if(ff_mpa_check_header(v) < 0)
401       return -1;
402
403     if (ff_mpegaudio_decode_header(&c, v) == 0)
404         vbrtag_size = c.frame_size;
405     if(c.layer != 3)
406         return -1;
407
408     /* Check for Xing / Info tag */
409     url_fseek(s->pb, xing_offtbl[c.lsf == 1][c.nb_channels == 1], SEEK_CUR);
410     v = get_be32(s->pb);
411     if(v == MKBETAG('X', 'i', 'n', 'g') || v == MKBETAG('I', 'n', 'f', 'o')) {
412         v = get_be32(s->pb);
413         if(v & 0x1)
414             frames = get_be32(s->pb);
415     }
416
417     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
418     url_fseek(s->pb, base + 4 + 32, SEEK_SET);
419     v = get_be32(s->pb);
420     if(v == MKBETAG('V', 'B', 'R', 'I')) {
421         /* Check tag version */
422         if(get_be16(s->pb) == 1) {
423             /* skip delay, quality and total bytes */
424             url_fseek(s->pb, 8, SEEK_CUR);
425             frames = get_be32(s->pb);
426         }
427     }
428
429     if(frames < 0)
430         return -1;
431
432     /* Skip the vbr tag frame */
433     url_fseek(s->pb, base + vbrtag_size, SEEK_SET);
434
435     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
436     st->duration = av_rescale_q(frames, (AVRational){spf, c.sample_rate},
437                                 st->time_base);
438     return 0;
439 }
440
441 static int mp3_read_header(AVFormatContext *s,
442                            AVFormatParameters *ap)
443 {
444     AVStream *st;
445     uint8_t buf[ID3v1_TAG_SIZE];
446     int len, ret, filesize;
447     int64_t off;
448
449     st = av_new_stream(s, 0);
450     if (!st)
451         return AVERROR(ENOMEM);
452
453     st->codec->codec_type = CODEC_TYPE_AUDIO;
454     st->codec->codec_id = CODEC_ID_MP3;
455     st->need_parsing = AVSTREAM_PARSE_FULL;
456     st->start_time = 0;
457
458     /* try to get the TAG */
459     if (!url_is_streamed(s->pb)) {
460         /* XXX: change that */
461         filesize = url_fsize(s->pb);
462         if (filesize > 128) {
463             url_fseek(s->pb, filesize - 128, SEEK_SET);
464             ret = get_buffer(s->pb, buf, ID3v1_TAG_SIZE);
465             if (ret == ID3v1_TAG_SIZE) {
466                 id3v1_parse_tag(s, buf);
467             }
468             url_fseek(s->pb, 0, SEEK_SET);
469         }
470     }
471
472     /* if ID3v2 header found, skip it */
473     ret = get_buffer(s->pb, buf, ID3v2_HEADER_SIZE);
474     if (ret != ID3v2_HEADER_SIZE)
475         return -1;
476     if (ff_id3v2_match(buf)) {
477         /* parse ID3v2 header */
478         len = ((buf[6] & 0x7f) << 21) |
479             ((buf[7] & 0x7f) << 14) |
480             ((buf[8] & 0x7f) << 7) |
481             (buf[9] & 0x7f);
482         id3v2_parse(s, len, buf[3], buf[5]);
483     } else {
484         url_fseek(s->pb, 0, SEEK_SET);
485     }
486
487     off = url_ftell(s->pb);
488     if (mp3_parse_vbr_tags(s, st, off) < 0)
489         url_fseek(s->pb, off, SEEK_SET);
490
491     /* the parameters will be extracted from the compressed bitstream */
492     return 0;
493 }
494
495 #define MP3_PACKET_SIZE 1024
496
497 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
498 {
499     int ret, size;
500     //    AVStream *st = s->streams[0];
501
502     size= MP3_PACKET_SIZE;
503
504     ret= av_get_packet(s->pb, pkt, size);
505
506     pkt->stream_index = 0;
507     if (ret <= 0) {
508         return AVERROR(EIO);
509     }
510     /* note: we need to modify the packet size here to handle the last
511        packet */
512     pkt->size = ret;
513     return ret;
514 }
515
516 #if CONFIG_MP2_MUXER || CONFIG_MP3_MUXER
517 static void id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
518 {
519     int v, i;
520
521     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
522     buf[0] = 'T';
523     buf[1] = 'A';
524     buf[2] = 'G';
525     strncpy(buf + 3, s->title, 30);
526     strncpy(buf + 33, s->author, 30);
527     strncpy(buf + 63, s->album, 30);
528     v = s->year;
529     if (v > 0) {
530         for(i = 0;i < 4; i++) {
531             buf[96 - i] = '0' + (v % 10);
532             v = v / 10;
533         }
534     }
535     strncpy(buf + 97, s->comment, 30);
536     if (s->track != 0) {
537         buf[125] = 0;
538         buf[126] = s->track;
539     }
540     for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
541         if (!strcasecmp(s->genre, id3v1_genre_str[i])) {
542             buf[127] = i;
543             break;
544         }
545     }
546 }
547
548 /* simple formats */
549
550 static void id3v2_put_size(AVFormatContext *s, int size)
551 {
552     put_byte(s->pb, size >> 21 & 0x7f);
553     put_byte(s->pb, size >> 14 & 0x7f);
554     put_byte(s->pb, size >> 7  & 0x7f);
555     put_byte(s->pb, size       & 0x7f);
556 }
557
558 static void id3v2_put_ttag(AVFormatContext *s, const char *string, uint32_t tag)
559 {
560     int len = strlen(string);
561     put_be32(s->pb, tag);
562     id3v2_put_size(s, len + 1);
563     put_be16(s->pb, 0);
564     put_byte(s->pb, 3); /* UTF-8 */
565     put_buffer(s->pb, string, len);
566 }
567
568
569 /**
570  * Write an ID3v2.4 header at beginning of stream
571  */
572
573 static int mp3_write_header(struct AVFormatContext *s)
574 {
575     int totlen = 0;
576     char tracktxt[10];
577     char yeartxt[10];
578
579     if(s->track)
580         snprintf(tracktxt, sizeof(tracktxt), "%d", s->track);
581     if(s->year)
582         snprintf( yeartxt, sizeof(yeartxt) , "%d", s->year );
583
584     if(s->title[0])     totlen += 11 + strlen(s->title);
585     if(s->author[0])    totlen += 11 + strlen(s->author);
586     if(s->album[0])     totlen += 11 + strlen(s->album);
587     if(s->genre[0])     totlen += 11 + strlen(s->genre);
588     if(s->copyright[0]) totlen += 11 + strlen(s->copyright);
589     if(s->track)        totlen += 11 + strlen(tracktxt);
590     if(s->year)         totlen += 11 + strlen(yeartxt);
591     if(!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT))
592         totlen += strlen(LIBAVFORMAT_IDENT) + 11;
593
594     if(totlen == 0)
595         return 0;
596
597     put_be32(s->pb, MKBETAG('I', 'D', '3', 0x04)); /* ID3v2.4 */
598     put_byte(s->pb, 0);
599     put_byte(s->pb, 0); /* flags */
600
601     id3v2_put_size(s, totlen);
602
603     if(s->title[0])     id3v2_put_ttag(s, s->title,     MKBETAG('T', 'I', 'T', '2'));
604     if(s->author[0])    id3v2_put_ttag(s, s->author,    MKBETAG('T', 'P', 'E', '1'));
605     if(s->album[0])     id3v2_put_ttag(s, s->album,     MKBETAG('T', 'A', 'L', 'B'));
606     if(s->genre[0])     id3v2_put_ttag(s, s->genre,     MKBETAG('T', 'C', 'O', 'N'));
607     if(s->copyright[0]) id3v2_put_ttag(s, s->copyright, MKBETAG('T', 'C', 'O', 'P'));
608     if(s->track)        id3v2_put_ttag(s, tracktxt,     MKBETAG('T', 'R', 'C', 'K'));
609     if(s->year)         id3v2_put_ttag(s, yeartxt,      MKBETAG('T', 'Y', 'E', 'R'));
610     if(!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT))
611         id3v2_put_ttag(s, LIBAVFORMAT_IDENT,            MKBETAG('T', 'E', 'N', 'C'));
612     return 0;
613 }
614
615 static int mp3_write_packet(struct AVFormatContext *s, AVPacket *pkt)
616 {
617     put_buffer(s->pb, pkt->data, pkt->size);
618     put_flush_packet(s->pb);
619     return 0;
620 }
621
622 static int mp3_write_trailer(struct AVFormatContext *s)
623 {
624     uint8_t buf[ID3v1_TAG_SIZE];
625
626     /* write the id3v1 tag */
627     if (s->title[0] != '\0') {
628         id3v1_create_tag(s, buf);
629         put_buffer(s->pb, buf, ID3v1_TAG_SIZE);
630         put_flush_packet(s->pb);
631     }
632     return 0;
633 }
634 #endif /* CONFIG_MP2_MUXER || CONFIG_MP3_MUXER */
635
636 #if CONFIG_MP3_DEMUXER
637 AVInputFormat mp3_demuxer = {
638     "mp3",
639     NULL_IF_CONFIG_SMALL("MPEG audio"),
640     0,
641     mp3_read_probe,
642     mp3_read_header,
643     mp3_read_packet,
644     .flags= AVFMT_GENERIC_INDEX,
645     .extensions = "mp2,mp3,m2a", /* XXX: use probe */
646 };
647 #endif
648 #if CONFIG_MP2_MUXER
649 AVOutputFormat mp2_muxer = {
650     "mp2",
651     NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
652     "audio/x-mpeg",
653 #if CONFIG_LIBMP3LAME
654     "mp2,m2a",
655 #else
656     "mp2,mp3,m2a",
657 #endif
658     0,
659     CODEC_ID_MP2,
660     CODEC_ID_NONE,
661     NULL,
662     mp3_write_packet,
663     mp3_write_trailer,
664 };
665 #endif
666 #if CONFIG_MP3_MUXER
667 AVOutputFormat mp3_muxer = {
668     "mp3",
669     NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
670     "audio/x-mpeg",
671     "mp3",
672     0,
673     CODEC_ID_MP3,
674     CODEC_ID_NONE,
675     mp3_write_header,
676     mp3_write_packet,
677     mp3_write_trailer,
678 };
679 #endif