mp3enc: support for id3v2.3 tags using a per-muxer AVOption
[ffmpeg.git] / libavformat / mp3enc.c
1 /*
2  * MP3 muxer
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 "avformat.h"
24 #include "id3v1.h"
25 #include "id3v2.h"
26 #include "libavutil/intreadwrite.h"
27 #include "libavutil/opt.h"
28
29 static int id3v1_set_string(AVFormatContext *s, const char *key,
30                             uint8_t *buf, int buf_size)
31 {
32     AVMetadataTag *tag;
33     if ((tag = av_metadata_get(s->metadata, key, NULL, 0)))
34         strncpy(buf, tag->value, buf_size);
35     return !!tag;
36 }
37
38 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
39 {
40     AVMetadataTag *tag;
41     int i, count = 0;
42
43     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
44     buf[0] = 'T';
45     buf[1] = 'A';
46     buf[2] = 'G';
47     count += id3v1_set_string(s, "TIT2",    buf +  3, 30);       //title
48     count += id3v1_set_string(s, "TPE1",    buf + 33, 30);       //author|artist
49     count += id3v1_set_string(s, "TALB",    buf + 63, 30);       //album
50     count += id3v1_set_string(s, "TDRL",    buf + 93,  4);       //date
51     count += id3v1_set_string(s, "comment", buf + 97, 30);
52     if ((tag = av_metadata_get(s->metadata, "TRCK", NULL, 0))) { //track
53         buf[125] = 0;
54         buf[126] = atoi(tag->value);
55         count++;
56     }
57     buf[127] = 0xFF; /* default to unknown genre */
58     if ((tag = av_metadata_get(s->metadata, "TCON", NULL, 0))) { //genre
59         for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
60             if (!strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
61                 buf[127] = i;
62                 count++;
63                 break;
64             }
65         }
66     }
67     return count;
68 }
69
70 /* simple formats */
71
72 static void id3v2_put_size(AVFormatContext *s, int size)
73 {
74     put_byte(s->pb, size >> 21 & 0x7f);
75     put_byte(s->pb, size >> 14 & 0x7f);
76     put_byte(s->pb, size >> 7  & 0x7f);
77     put_byte(s->pb, size       & 0x7f);
78 }
79
80 /**
81  * Write a text frame with one (normal frames) or two (TXXX frames) strings
82  * according to encoding (only UTF-8 or UTF-16+BOM supported).
83  * @return number of bytes written or a negative error code.
84  */
85 static int id3v2_put_ttag(AVFormatContext *s, const char *str1, const char *str2,
86                           uint32_t tag, enum ID3v2Encoding enc)
87 {
88     int len;
89     uint8_t *pb;
90     int (*put)(ByteIOContext*, const char*);
91     ByteIOContext *dyn_buf;
92     if (url_open_dyn_buf(&dyn_buf) < 0)
93         return AVERROR(ENOMEM);
94
95     put_byte(dyn_buf, enc);
96     if (enc == ID3v2_ENCODING_UTF16BOM) {
97         put_le16(dyn_buf, 0xFEFF);      /* BOM */
98         put = avio_put_str16le;
99     } else
100         put = avio_put_str;
101
102     put(dyn_buf, str1);
103     if (str2)
104         put(dyn_buf, str2);
105     len = url_close_dyn_buf(dyn_buf, &pb);
106
107     put_be32(s->pb, tag);
108     id3v2_put_size(s, len);
109     put_be16(s->pb, 0);
110     put_buffer(s->pb, pb, len);
111
112     av_freep(&pb);
113     return len + ID3v2_HEADER_SIZE;
114 }
115
116
117 static int mp3_write_packet(struct AVFormatContext *s, AVPacket *pkt)
118 {
119     put_buffer(s->pb, pkt->data, pkt->size);
120     put_flush_packet(s->pb);
121     return 0;
122 }
123
124 static int mp3_write_trailer(struct AVFormatContext *s)
125 {
126     uint8_t buf[ID3v1_TAG_SIZE];
127
128     /* write the id3v1 tag */
129     if (id3v1_create_tag(s, buf) > 0) {
130         put_buffer(s->pb, buf, ID3v1_TAG_SIZE);
131         put_flush_packet(s->pb);
132     }
133     return 0;
134 }
135
136 #if CONFIG_MP2_MUXER
137 AVOutputFormat mp2_muxer = {
138     "mp2",
139     NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
140     "audio/x-mpeg",
141     "mp2,m2a",
142     0,
143     CODEC_ID_MP2,
144     CODEC_ID_NONE,
145     NULL,
146     mp3_write_packet,
147     mp3_write_trailer,
148 };
149 #endif
150
151 #if CONFIG_MP3_MUXER
152 typedef struct MP3Context {
153     const AVClass *class;
154     int id3v2_version;
155 } MP3Context;
156
157 static const AVOption options[] = {
158     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
159       offsetof(MP3Context, id3v2_version), FF_OPT_TYPE_INT, 4, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
160     { NULL },
161 };
162
163 static const AVClass mp3_muxer_class = {
164     "MP3 muxer",
165     av_default_item_name,
166     options,
167     LIBAVUTIL_VERSION_INT,
168 };
169
170 static int id3v2_check_write_tag(AVFormatContext *s, AVMetadataTag *t, const char table[][4],
171                                  enum ID3v2Encoding enc)
172 {
173     uint32_t tag;
174     int i;
175
176     if (t->key[0] != 'T' || strlen(t->key) != 4)
177         return -1;
178     tag = AV_RB32(t->key);
179     for (i = 0; *table[i]; i++)
180         if (tag == AV_RB32(table[i]))
181             return id3v2_put_ttag(s, t->value, NULL, tag, enc);
182     return -1;
183 }
184
185 /**
186  * Write an ID3v2 header at beginning of stream
187  */
188
189 static int mp3_write_header(struct AVFormatContext *s)
190 {
191     MP3Context  *mp3 = s->priv_data;
192     AVMetadataTag *t = NULL;
193     int totlen = 0, enc = mp3->id3v2_version == 3 ? ID3v2_ENCODING_UTF16BOM :
194                                                     ID3v2_ENCODING_UTF8;
195     int64_t size_pos, cur_pos;
196
197     put_be32(s->pb, MKBETAG('I', 'D', '3', mp3->id3v2_version));
198     put_byte(s->pb, 0);
199     put_byte(s->pb, 0); /* flags */
200
201     /* reserve space for size */
202     size_pos = url_ftell(s->pb);
203     put_be32(s->pb, 0);
204
205     ff_metadata_conv(&s->metadata, ff_id3v2_34_metadata_conv, NULL);
206     if (mp3->id3v2_version == 4)
207         ff_metadata_conv(&s->metadata, ff_id3v2_4_metadata_conv, NULL);
208
209     while ((t = av_metadata_get(s->metadata, "", t, AV_METADATA_IGNORE_SUFFIX))) {
210         int ret;
211
212         if ((ret = id3v2_check_write_tag(s, t, ff_id3v2_tags, enc)) > 0) {
213             totlen += ret;
214             continue;
215         }
216         if ((ret = id3v2_check_write_tag(s, t, mp3->id3v2_version == 3 ?
217                                                ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
218             totlen += ret;
219             continue;
220         }
221
222         /* unknown tag, write as TXXX frame */
223         if ((ret = id3v2_put_ttag(s, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
224             return ret;
225         totlen += ret;
226     }
227
228     cur_pos = url_ftell(s->pb);
229     url_fseek(s->pb, size_pos, SEEK_SET);
230     id3v2_put_size(s, totlen);
231     url_fseek(s->pb, cur_pos, SEEK_SET);
232
233     return 0;
234 }
235
236 AVOutputFormat mp3_muxer = {
237     "mp3",
238     NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
239     "audio/x-mpeg",
240     "mp3",
241     sizeof(MP3Context),
242     CODEC_ID_MP3,
243     CODEC_ID_NONE,
244     mp3_write_header,
245     mp3_write_packet,
246     mp3_write_trailer,
247     AVFMT_NOTIMESTAMPS,
248     .priv_class = &mp3_muxer_class,
249 };
250 #endif