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