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