a9134f180ff98a9e758567ae0ce988631ca9847a
[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, const char *key)
171 {
172     char *q, dst[512];
173     int len, dstlen = sizeof(dst);
174     unsigned genre;
175
176     if(dstlen > 0)
177         dst[0]= 0;
178     if(taglen < 1)
179         return;
180
181     taglen--; /* account for encoding type byte */
182     dstlen--; /* Leave space for zero terminator */
183
184     switch(get_byte(s->pb)) { /* encoding type */
185
186     case 0:  /* ISO-8859-1 (0 - 255 maps directly into unicode) */
187         q = dst;
188         while(taglen--) {
189             uint8_t tmp;
190             PUT_UTF8(get_byte(s->pb), tmp, if (q - dst < dstlen - 1) *q++ = tmp;)
191         }
192         *q = '\0';
193         break;
194
195     case 3:  /* UTF-8 */
196         len = FFMIN(taglen, dstlen-1);
197         get_buffer(s->pb, dst, len);
198         dst[len] = 0;
199         break;
200     }
201
202     if (!strcmp(key, "genre")
203         && sscanf(dst, "(%d)", &genre) == 1 && genre <= ID3v1_GENRE_MAX)
204         av_strlcpy(dst, id3v1_genre_str[genre], sizeof(dst));
205
206     if (*dst)
207         av_metadata_set(&s->metadata, key, dst);
208 }
209
210 /**
211  * ID3v2 parser
212  *
213  * Handles ID3v2.2, 2.3 and 2.4.
214  *
215  */
216
217 static void id3v2_parse(AVFormatContext *s, int len, uint8_t version, uint8_t flags)
218 {
219     int isv34, tlen;
220     uint32_t tag;
221     int64_t next;
222     int taghdrlen;
223     const char *reason;
224
225     switch(version) {
226     case 2:
227         if(flags & 0x40) {
228             reason = "compression";
229             goto error;
230         }
231         isv34 = 0;
232         taghdrlen = 6;
233         break;
234
235     case 3:
236     case 4:
237         isv34 = 1;
238         taghdrlen = 10;
239         break;
240
241     default:
242         reason = "version";
243         goto error;
244     }
245
246     if(flags & 0x80) {
247         reason = "unsynchronization";
248         goto error;
249     }
250
251     if(isv34 && flags & 0x40) /* Extended header present, just skip over it */
252         url_fskip(s->pb, id3v2_get_size(s->pb, 4));
253
254     while(len >= taghdrlen) {
255         if(isv34) {
256             tag  = get_be32(s->pb);
257             tlen = id3v2_get_size(s->pb, 4);
258             get_be16(s->pb); /* flags */
259         } else {
260             tag  = get_be24(s->pb);
261             tlen = id3v2_get_size(s->pb, 3);
262         }
263         len -= taghdrlen + tlen;
264
265         if(len < 0)
266             break;
267
268         next = url_ftell(s->pb) + tlen;
269
270         switch(tag) {
271         case MKBETAG('T', 'I', 'T', '2'):
272         case MKBETAG(0,   'T', 'T', '2'):
273             id3v2_read_ttag(s, tlen, "title");
274             break;
275         case MKBETAG('T', 'P', 'E', '1'):
276         case MKBETAG(0,   'T', 'P', '1'):
277             id3v2_read_ttag(s, tlen, "author");
278             break;
279         case MKBETAG('T', 'A', 'L', 'B'):
280         case MKBETAG(0,   'T', 'A', 'L'):
281             id3v2_read_ttag(s, tlen, "album");
282             break;
283         case MKBETAG('T', 'C', 'O', 'N'):
284         case MKBETAG(0,   'T', 'C', 'O'):
285             id3v2_read_ttag(s, tlen, "genre");
286             break;
287         case MKBETAG('T', 'C', 'O', 'P'):
288         case MKBETAG(0,   'T', 'C', 'R'):
289             id3v2_read_ttag(s, tlen, "copyright");
290             break;
291         case MKBETAG('T', 'R', 'C', 'K'):
292         case MKBETAG(0,   'T', 'R', 'K'):
293             id3v2_read_ttag(s, tlen, "track");
294             break;
295         case 0:
296             /* padding, skip to end */
297             url_fskip(s->pb, len);
298             len = 0;
299             continue;
300         }
301         /* Skip to end of tag */
302         url_fseek(s->pb, next, SEEK_SET);
303     }
304
305     if(version == 4 && flags & 0x10) /* Footer preset, always 10 bytes, skip over it */
306         url_fskip(s->pb, 10);
307     return;
308
309   error:
310     av_log(s, AV_LOG_INFO, "ID3v2.%d tag skipped, cannot handle %s\n", version, reason);
311     url_fskip(s->pb, len);
312 }
313
314 static void id3v1_get_string(AVFormatContext *s, const char *key,
315                              const uint8_t *buf, int buf_size)
316 {
317     int i, c;
318     char *q, str[512];
319
320     q = str;
321     for(i = 0; i < buf_size; i++) {
322         c = buf[i];
323         if (c == '\0')
324             break;
325         if ((q - str) >= sizeof(str) - 1)
326             break;
327         *q++ = c;
328     }
329     *q = '\0';
330
331     if (*str)
332         av_metadata_set(&s->metadata, key, str);
333 }
334
335 /* 'buf' must be ID3v1_TAG_SIZE byte long */
336 static int id3v1_parse_tag(AVFormatContext *s, const uint8_t *buf)
337 {
338     char str[5];
339     int genre;
340
341     if (!(buf[0] == 'T' &&
342           buf[1] == 'A' &&
343           buf[2] == 'G'))
344         return -1;
345     id3v1_get_string(s, "title",   buf +  3, 30);
346     id3v1_get_string(s, "author",  buf + 33, 30);
347     id3v1_get_string(s, "album",   buf + 63, 30);
348     id3v1_get_string(s, "year",    buf + 93,  4);
349     id3v1_get_string(s, "comment", buf + 97, 30);
350     if (buf[125] == 0 && buf[126] != 0) {
351         snprintf(str, sizeof(str), "%d", buf[126]);
352         av_metadata_set(&s->metadata, "track", str);
353     }
354     genre = buf[127];
355     if (genre <= ID3v1_GENRE_MAX)
356         av_metadata_set(&s->metadata, "genre", id3v1_genre_str[genre]);
357     return 0;
358 }
359
360 /* mp3 read */
361
362 static int mp3_read_probe(AVProbeData *p)
363 {
364     int max_frames, first_frames = 0;
365     int fsize, frames, sample_rate;
366     uint32_t header;
367     uint8_t *buf, *buf0, *buf2, *end;
368     AVCodecContext avctx;
369
370     buf0 = p->buf;
371     if(ff_id3v2_match(buf0)) {
372         buf0 += ff_id3v2_tag_len(buf0);
373     }
374
375     max_frames = 0;
376     buf = buf0;
377     end = p->buf + p->buf_size - sizeof(uint32_t);
378
379     for(; buf < end; buf= buf2+1) {
380         buf2 = buf;
381
382         for(frames = 0; buf2 < end; frames++) {
383             header = AV_RB32(buf2);
384             fsize = ff_mpa_decode_header(&avctx, header, &sample_rate, &sample_rate, &sample_rate, &sample_rate);
385             if(fsize < 0)
386                 break;
387             buf2 += fsize;
388         }
389         max_frames = FFMAX(max_frames, frames);
390         if(buf == buf0)
391             first_frames= frames;
392     }
393     if   (first_frames>=3) return AVPROBE_SCORE_MAX/2+1;
394     else if(max_frames>500)return AVPROBE_SCORE_MAX/2;
395     else if(max_frames>=3) return AVPROBE_SCORE_MAX/4;
396     else if(max_frames>=1) return 1;
397     else                   return 0;
398 }
399
400 /**
401  * Try to find Xing/Info/VBRI tags and compute duration from info therein
402  */
403 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
404 {
405     uint32_t v, spf;
406     int frames = -1; /* Total number of frames in file */
407     const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
408     MPADecodeHeader c;
409     int vbrtag_size = 0;
410
411     v = get_be32(s->pb);
412     if(ff_mpa_check_header(v) < 0)
413       return -1;
414
415     if (ff_mpegaudio_decode_header(&c, v) == 0)
416         vbrtag_size = c.frame_size;
417     if(c.layer != 3)
418         return -1;
419
420     /* Check for Xing / Info tag */
421     url_fseek(s->pb, xing_offtbl[c.lsf == 1][c.nb_channels == 1], SEEK_CUR);
422     v = get_be32(s->pb);
423     if(v == MKBETAG('X', 'i', 'n', 'g') || v == MKBETAG('I', 'n', 'f', 'o')) {
424         v = get_be32(s->pb);
425         if(v & 0x1)
426             frames = get_be32(s->pb);
427     }
428
429     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
430     url_fseek(s->pb, base + 4 + 32, SEEK_SET);
431     v = get_be32(s->pb);
432     if(v == MKBETAG('V', 'B', 'R', 'I')) {
433         /* Check tag version */
434         if(get_be16(s->pb) == 1) {
435             /* skip delay, quality and total bytes */
436             url_fseek(s->pb, 8, SEEK_CUR);
437             frames = get_be32(s->pb);
438         }
439     }
440
441     if(frames < 0)
442         return -1;
443
444     /* Skip the vbr tag frame */
445     url_fseek(s->pb, base + vbrtag_size, SEEK_SET);
446
447     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
448     st->duration = av_rescale_q(frames, (AVRational){spf, c.sample_rate},
449                                 st->time_base);
450     return 0;
451 }
452
453 static int mp3_read_header(AVFormatContext *s,
454                            AVFormatParameters *ap)
455 {
456     AVStream *st;
457     uint8_t buf[ID3v1_TAG_SIZE];
458     int len, ret, filesize;
459     int64_t off;
460
461     st = av_new_stream(s, 0);
462     if (!st)
463         return AVERROR(ENOMEM);
464
465     st->codec->codec_type = CODEC_TYPE_AUDIO;
466     st->codec->codec_id = CODEC_ID_MP3;
467     st->need_parsing = AVSTREAM_PARSE_FULL;
468     st->start_time = 0;
469
470     /* try to get the TAG */
471     if (!url_is_streamed(s->pb)) {
472         /* XXX: change that */
473         filesize = url_fsize(s->pb);
474         if (filesize > 128) {
475             url_fseek(s->pb, filesize - 128, SEEK_SET);
476             ret = get_buffer(s->pb, buf, ID3v1_TAG_SIZE);
477             if (ret == ID3v1_TAG_SIZE) {
478                 id3v1_parse_tag(s, buf);
479             }
480             url_fseek(s->pb, 0, SEEK_SET);
481         }
482     }
483
484     /* if ID3v2 header found, skip it */
485     ret = get_buffer(s->pb, buf, ID3v2_HEADER_SIZE);
486     if (ret != ID3v2_HEADER_SIZE)
487         return -1;
488     if (ff_id3v2_match(buf)) {
489         /* parse ID3v2 header */
490         len = ((buf[6] & 0x7f) << 21) |
491             ((buf[7] & 0x7f) << 14) |
492             ((buf[8] & 0x7f) << 7) |
493             (buf[9] & 0x7f);
494         id3v2_parse(s, len, buf[3], buf[5]);
495     } else {
496         url_fseek(s->pb, 0, SEEK_SET);
497     }
498
499     off = url_ftell(s->pb);
500     if (mp3_parse_vbr_tags(s, st, off) < 0)
501         url_fseek(s->pb, off, SEEK_SET);
502
503     /* the parameters will be extracted from the compressed bitstream */
504     return 0;
505 }
506
507 #define MP3_PACKET_SIZE 1024
508
509 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
510 {
511     int ret, size;
512     //    AVStream *st = s->streams[0];
513
514     size= MP3_PACKET_SIZE;
515
516     ret= av_get_packet(s->pb, pkt, size);
517
518     pkt->stream_index = 0;
519     if (ret <= 0) {
520         return AVERROR(EIO);
521     }
522     /* note: we need to modify the packet size here to handle the last
523        packet */
524     pkt->size = ret;
525     return ret;
526 }
527
528 #if CONFIG_MP2_MUXER || CONFIG_MP3_MUXER
529 static void id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
530 {
531     int v, i;
532
533     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
534     buf[0] = 'T';
535     buf[1] = 'A';
536     buf[2] = 'G';
537     strncpy(buf + 3, s->title, 30);
538     strncpy(buf + 33, s->author, 30);
539     strncpy(buf + 63, s->album, 30);
540     v = s->year;
541     if (v > 0) {
542         for(i = 0;i < 4; i++) {
543             buf[96 - i] = '0' + (v % 10);
544             v = v / 10;
545         }
546     }
547     strncpy(buf + 97, s->comment, 30);
548     if (s->track != 0) {
549         buf[125] = 0;
550         buf[126] = s->track;
551     }
552     for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
553         if (!strcasecmp(s->genre, id3v1_genre_str[i])) {
554             buf[127] = i;
555             break;
556         }
557     }
558 }
559
560 /* simple formats */
561
562 static void id3v2_put_size(AVFormatContext *s, int size)
563 {
564     put_byte(s->pb, size >> 21 & 0x7f);
565     put_byte(s->pb, size >> 14 & 0x7f);
566     put_byte(s->pb, size >> 7  & 0x7f);
567     put_byte(s->pb, size       & 0x7f);
568 }
569
570 static void id3v2_put_ttag(AVFormatContext *s, const char *string, uint32_t tag)
571 {
572     int len = strlen(string);
573     put_be32(s->pb, tag);
574     id3v2_put_size(s, len + 1);
575     put_be16(s->pb, 0);
576     put_byte(s->pb, 3); /* UTF-8 */
577     put_buffer(s->pb, string, len);
578 }
579
580
581 /**
582  * Write an ID3v2.4 header at beginning of stream
583  */
584
585 static int mp3_write_header(struct AVFormatContext *s)
586 {
587     int totlen = 0;
588     char tracktxt[10];
589     char yeartxt[10];
590
591     if(s->track)
592         snprintf(tracktxt, sizeof(tracktxt), "%d", s->track);
593     if(s->year)
594         snprintf( yeartxt, sizeof(yeartxt) , "%d", s->year );
595
596     if(s->title[0])     totlen += 11 + strlen(s->title);
597     if(s->author[0])    totlen += 11 + strlen(s->author);
598     if(s->album[0])     totlen += 11 + strlen(s->album);
599     if(s->genre[0])     totlen += 11 + strlen(s->genre);
600     if(s->copyright[0]) totlen += 11 + strlen(s->copyright);
601     if(s->track)        totlen += 11 + strlen(tracktxt);
602     if(s->year)         totlen += 11 + strlen(yeartxt);
603     if(!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT))
604         totlen += strlen(LIBAVFORMAT_IDENT) + 11;
605
606     if(totlen == 0)
607         return 0;
608
609     put_be32(s->pb, MKBETAG('I', 'D', '3', 0x04)); /* ID3v2.4 */
610     put_byte(s->pb, 0);
611     put_byte(s->pb, 0); /* flags */
612
613     id3v2_put_size(s, totlen);
614
615     if(s->title[0])     id3v2_put_ttag(s, s->title,     MKBETAG('T', 'I', 'T', '2'));
616     if(s->author[0])    id3v2_put_ttag(s, s->author,    MKBETAG('T', 'P', 'E', '1'));
617     if(s->album[0])     id3v2_put_ttag(s, s->album,     MKBETAG('T', 'A', 'L', 'B'));
618     if(s->genre[0])     id3v2_put_ttag(s, s->genre,     MKBETAG('T', 'C', 'O', 'N'));
619     if(s->copyright[0]) id3v2_put_ttag(s, s->copyright, MKBETAG('T', 'C', 'O', 'P'));
620     if(s->track)        id3v2_put_ttag(s, tracktxt,     MKBETAG('T', 'R', 'C', 'K'));
621     if(s->year)         id3v2_put_ttag(s, yeartxt,      MKBETAG('T', 'Y', 'E', 'R'));
622     if(!(s->streams[0]->codec->flags & CODEC_FLAG_BITEXACT))
623         id3v2_put_ttag(s, LIBAVFORMAT_IDENT,            MKBETAG('T', 'E', 'N', 'C'));
624     return 0;
625 }
626
627 static int mp3_write_packet(struct AVFormatContext *s, AVPacket *pkt)
628 {
629     put_buffer(s->pb, pkt->data, pkt->size);
630     put_flush_packet(s->pb);
631     return 0;
632 }
633
634 static int mp3_write_trailer(struct AVFormatContext *s)
635 {
636     uint8_t buf[ID3v1_TAG_SIZE];
637
638     /* write the id3v1 tag */
639     if (s->title[0] != '\0') {
640         id3v1_create_tag(s, buf);
641         put_buffer(s->pb, buf, ID3v1_TAG_SIZE);
642         put_flush_packet(s->pb);
643     }
644     return 0;
645 }
646 #endif /* CONFIG_MP2_MUXER || CONFIG_MP3_MUXER */
647
648 #if CONFIG_MP3_DEMUXER
649 AVInputFormat mp3_demuxer = {
650     "mp3",
651     NULL_IF_CONFIG_SMALL("MPEG audio"),
652     0,
653     mp3_read_probe,
654     mp3_read_header,
655     mp3_read_packet,
656     .flags= AVFMT_GENERIC_INDEX,
657     .extensions = "mp2,mp3,m2a", /* XXX: use probe */
658 };
659 #endif
660 #if CONFIG_MP2_MUXER
661 AVOutputFormat mp2_muxer = {
662     "mp2",
663     NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
664     "audio/x-mpeg",
665     "mp2,m2a",
666     0,
667     CODEC_ID_MP2,
668     CODEC_ID_NONE,
669     NULL,
670     mp3_write_packet,
671     mp3_write_trailer,
672 };
673 #endif
674 #if CONFIG_MP3_MUXER
675 AVOutputFormat mp3_muxer = {
676     "mp3",
677     NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
678     "audio/x-mpeg",
679     "mp3",
680     0,
681     CODEC_ID_MP3,
682     CODEC_ID_NONE,
683     mp3_write_header,
684     mp3_write_packet,
685     mp3_write_trailer,
686 };
687 #endif