Move handling of ID3v2 to common utils.c code, reducing code duplication
[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 "libavutil/intreadwrite.h"
25 #include "avformat.h"
26 #include "id3v2.h"
27 #include "id3v1.h"
28
29 #if CONFIG_MP3_DEMUXER
30
31 #include "libavcodec/mpegaudio.h"
32 #include "libavcodec/mpegaudiodecheader.h"
33
34 /* mp3 read */
35
36 static int mp3_read_probe(AVProbeData *p)
37 {
38     int max_frames, first_frames = 0;
39     int fsize, frames, sample_rate;
40     uint32_t header;
41     uint8_t *buf, *buf0, *buf2, *end;
42     AVCodecContext avctx;
43
44     buf0 = p->buf;
45     end = p->buf + p->buf_size - sizeof(uint32_t);
46     while(buf0 < end && !*buf0)
47         buf0++;
48
49     max_frames = 0;
50     buf = buf0;
51
52     for(; buf < end; buf= buf2+1) {
53         buf2 = buf;
54
55         for(frames = 0; buf2 < end; frames++) {
56             header = AV_RB32(buf2);
57             fsize = ff_mpa_decode_header(&avctx, header, &sample_rate, &sample_rate, &sample_rate, &sample_rate);
58             if(fsize < 0)
59                 break;
60             buf2 += fsize;
61         }
62         max_frames = FFMAX(max_frames, frames);
63         if(buf == buf0)
64             first_frames= frames;
65     }
66     // keep this in sync with ac3 probe, both need to avoid
67     // issues with MPEG-files!
68     if   (first_frames>=4) return AVPROBE_SCORE_MAX/2+1;
69     else if(max_frames>500)return AVPROBE_SCORE_MAX/2;
70     else if(max_frames>=4) return AVPROBE_SCORE_MAX/4;
71     else if(buf0!=p->buf)  return AVPROBE_SCORE_MAX/4-1;
72     else if(max_frames>=1) return 1;
73     else                   return 0;
74 //mpegps_mp3_unrecognized_format.mpg has max_frames=3
75 }
76
77 /**
78  * Try to find Xing/Info/VBRI tags and compute duration from info therein
79  */
80 static int mp3_parse_vbr_tags(AVFormatContext *s, AVStream *st, int64_t base)
81 {
82     uint32_t v, spf;
83     unsigned frames = 0; /* Total number of frames in file */
84     unsigned size = 0; /* Total number of bytes in the stream */
85     const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
86     MPADecodeHeader c;
87     int vbrtag_size = 0;
88
89     v = get_be32(s->pb);
90     if(ff_mpa_check_header(v) < 0)
91       return -1;
92
93     if (ff_mpegaudio_decode_header(&c, v) == 0)
94         vbrtag_size = c.frame_size;
95     if(c.layer != 3)
96         return -1;
97
98     /* Check for Xing / Info tag */
99     url_fseek(s->pb, xing_offtbl[c.lsf == 1][c.nb_channels == 1], SEEK_CUR);
100     v = get_be32(s->pb);
101     if(v == MKBETAG('X', 'i', 'n', 'g') || v == MKBETAG('I', 'n', 'f', 'o')) {
102         v = get_be32(s->pb);
103         if(v & 0x1)
104             frames = get_be32(s->pb);
105         if(v & 0x2)
106             size = get_be32(s->pb);
107     }
108
109     /* Check for VBRI tag (always 32 bytes after end of mpegaudio header) */
110     url_fseek(s->pb, base + 4 + 32, SEEK_SET);
111     v = get_be32(s->pb);
112     if(v == MKBETAG('V', 'B', 'R', 'I')) {
113         /* Check tag version */
114         if(get_be16(s->pb) == 1) {
115             /* skip delay and quality */
116             url_fseek(s->pb, 4, SEEK_CUR);
117             frames = get_be32(s->pb);
118             size = get_be32(s->pb);
119         }
120     }
121
122     if(!frames && !size)
123         return -1;
124
125     /* Skip the vbr tag frame */
126     url_fseek(s->pb, base + vbrtag_size, SEEK_SET);
127
128     spf = c.lsf ? 576 : 1152; /* Samples per frame, layer 3 */
129     if(frames)
130         st->duration = av_rescale_q(frames, (AVRational){spf, c.sample_rate},
131                                     st->time_base);
132     if(size)
133         st->codec->bit_rate = av_rescale(size, 8 * c.sample_rate, frames * (int64_t)spf);
134
135     return 0;
136 }
137
138 static int mp3_read_header(AVFormatContext *s,
139                            AVFormatParameters *ap)
140 {
141     AVStream *st;
142     int64_t off;
143
144     st = av_new_stream(s, 0);
145     if (!st)
146         return AVERROR(ENOMEM);
147
148     st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
149     st->codec->codec_id = CODEC_ID_MP3;
150     st->need_parsing = AVSTREAM_PARSE_FULL;
151     st->start_time = 0;
152
153     // lcm of all mp3 sample rates
154     av_set_pts_info(st, 64, 1, 14112000);
155
156     off = url_ftell(s->pb);
157
158     if (!av_metadata_get(s->metadata, "", NULL, AV_METADATA_IGNORE_SUFFIX))
159         ff_id3v1_read(s);
160
161     if (mp3_parse_vbr_tags(s, st, off) < 0)
162         url_fseek(s->pb, off, SEEK_SET);
163
164     /* the parameters will be extracted from the compressed bitstream */
165     return 0;
166 }
167
168 #define MP3_PACKET_SIZE 1024
169
170 static int mp3_read_packet(AVFormatContext *s, AVPacket *pkt)
171 {
172     int ret, size;
173     //    AVStream *st = s->streams[0];
174
175     size= MP3_PACKET_SIZE;
176
177     ret= av_get_packet(s->pb, pkt, size);
178
179     pkt->stream_index = 0;
180     if (ret <= 0) {
181         return AVERROR(EIO);
182     }
183     /* note: we need to modify the packet size here to handle the last
184        packet */
185     pkt->size = ret;
186     return ret;
187 }
188
189 AVInputFormat mp3_demuxer = {
190     "mp3",
191     NULL_IF_CONFIG_SMALL("MPEG audio layer 2/3"),
192     0,
193     mp3_read_probe,
194     mp3_read_header,
195     mp3_read_packet,
196     .flags= AVFMT_GENERIC_INDEX,
197     .extensions = "mp2,mp3,m2a", /* XXX: use probe */
198     .metadata_conv = ff_id3v2_metadata_conv,
199 };
200 #endif
201
202 #if CONFIG_MP2_MUXER || CONFIG_MP3_MUXER
203 static int id3v1_set_string(AVFormatContext *s, const char *key,
204                             uint8_t *buf, int buf_size)
205 {
206     AVMetadataTag *tag;
207     if ((tag = av_metadata_get(s->metadata, key, NULL, 0)))
208         strncpy(buf, tag->value, buf_size);
209     return !!tag;
210 }
211
212 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
213 {
214     AVMetadataTag *tag;
215     int i, count = 0;
216
217     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
218     buf[0] = 'T';
219     buf[1] = 'A';
220     buf[2] = 'G';
221     count += id3v1_set_string(s, "TIT2",    buf +  3, 30);       //title
222     count += id3v1_set_string(s, "TPE1",    buf + 33, 30);       //author|artist
223     count += id3v1_set_string(s, "TALB",    buf + 63, 30);       //album
224     count += id3v1_set_string(s, "TDRL",    buf + 93,  4);       //date
225     count += id3v1_set_string(s, "comment", buf + 97, 30);
226     if ((tag = av_metadata_get(s->metadata, "TRCK", NULL, 0))) { //track
227         buf[125] = 0;
228         buf[126] = atoi(tag->value);
229         count++;
230     }
231     buf[127] = 0xFF; /* default to unknown genre */
232     if ((tag = av_metadata_get(s->metadata, "TCON", NULL, 0))) { //genre
233         for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
234             if (!strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
235                 buf[127] = i;
236                 count++;
237                 break;
238             }
239         }
240     }
241     return count;
242 }
243
244 /* simple formats */
245
246 static void id3v2_put_size(AVFormatContext *s, int size)
247 {
248     put_byte(s->pb, size >> 21 & 0x7f);
249     put_byte(s->pb, size >> 14 & 0x7f);
250     put_byte(s->pb, size >> 7  & 0x7f);
251     put_byte(s->pb, size       & 0x7f);
252 }
253
254 static void id3v2_put_ttag(AVFormatContext *s, const char *buf, int len,
255                            uint32_t tag)
256 {
257     put_be32(s->pb, tag);
258     id3v2_put_size(s, len + 1);
259     put_be16(s->pb, 0);
260     put_byte(s->pb, 3); /* UTF-8 */
261     put_buffer(s->pb, buf, len);
262 }
263
264
265 static int mp3_write_packet(struct AVFormatContext *s, AVPacket *pkt)
266 {
267     put_buffer(s->pb, pkt->data, pkt->size);
268     put_flush_packet(s->pb);
269     return 0;
270 }
271
272 static int mp3_write_trailer(struct AVFormatContext *s)
273 {
274     uint8_t buf[ID3v1_TAG_SIZE];
275
276     /* write the id3v1 tag */
277     if (id3v1_create_tag(s, buf) > 0) {
278         put_buffer(s->pb, buf, ID3v1_TAG_SIZE);
279         put_flush_packet(s->pb);
280     }
281     return 0;
282 }
283 #endif /* CONFIG_MP2_MUXER || CONFIG_MP3_MUXER */
284
285 #if CONFIG_MP2_MUXER
286 AVOutputFormat mp2_muxer = {
287     "mp2",
288     NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
289     "audio/x-mpeg",
290     "mp2,m2a",
291     0,
292     CODEC_ID_MP2,
293     CODEC_ID_NONE,
294     NULL,
295     mp3_write_packet,
296     mp3_write_trailer,
297     .metadata_conv = ff_id3v2_metadata_conv,
298 };
299 #endif
300
301 #if CONFIG_MP3_MUXER
302 /**
303  * Write an ID3v2.4 header at beginning of stream
304  */
305
306 static int mp3_write_header(struct AVFormatContext *s)
307 {
308     AVMetadataTag *t = NULL;
309     int totlen = 0;
310     int64_t size_pos, cur_pos;
311
312     put_be32(s->pb, MKBETAG('I', 'D', '3', 0x04)); /* ID3v2.4 */
313     put_byte(s->pb, 0);
314     put_byte(s->pb, 0); /* flags */
315
316     /* reserve space for size */
317     size_pos = url_ftell(s->pb);
318     put_be32(s->pb, 0);
319
320     while ((t = av_metadata_get(s->metadata, "", t, AV_METADATA_IGNORE_SUFFIX))) {
321         uint32_t tag = 0;
322
323         if (t->key[0] == 'T' && strlen(t->key) == 4) {
324             int i;
325             for (i = 0; *ff_id3v2_tags[i]; i++)
326                 if (AV_RB32(t->key) == AV_RB32(ff_id3v2_tags[i])) {
327                     int len = strlen(t->value);
328                     tag = AV_RB32(t->key);
329                     totlen += len + ID3v2_HEADER_SIZE + 2;
330                     id3v2_put_ttag(s, t->value, len + 1, tag);
331                     break;
332                 }
333         }
334
335         if (!tag) { /* unknown tag, write as TXXX frame */
336             int   len = strlen(t->key), len1 = strlen(t->value);
337             char *buf = av_malloc(len + len1 + 2);
338             if (!buf)
339                 return AVERROR(ENOMEM);
340             tag = MKBETAG('T', 'X', 'X', 'X');
341             strcpy(buf,           t->key);
342             strcpy(buf + len + 1, t->value);
343             id3v2_put_ttag(s, buf, len + len1 + 2, tag);
344             totlen += len + len1 + ID3v2_HEADER_SIZE + 3;
345             av_free(buf);
346         }
347     }
348
349     cur_pos = url_ftell(s->pb);
350     url_fseek(s->pb, size_pos, SEEK_SET);
351     id3v2_put_size(s, totlen);
352     url_fseek(s->pb, cur_pos, SEEK_SET);
353
354     return 0;
355 }
356
357 AVOutputFormat mp3_muxer = {
358     "mp3",
359     NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
360     "audio/x-mpeg",
361     "mp3",
362     0,
363     CODEC_ID_MP3,
364     CODEC_ID_NONE,
365     mp3_write_header,
366     mp3_write_packet,
367     mp3_write_trailer,
368     AVFMT_NOTIMESTAMPS,
369     .metadata_conv = ff_id3v2_metadata_conv,
370 };
371 #endif