3 * Copyright (c) 2003 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
27 #include "libavutil/avstring.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/opt.h"
30 #include "libavcodec/mpegaudiodata.h"
31 #include "libavcodec/mpegaudiodecheader.h"
32 #include "libavformat/avio_internal.h"
34 static int id3v1_set_string(AVFormatContext *s, const char *key,
35 uint8_t *buf, int buf_size)
38 if ((tag = av_metadata_get(s->metadata, key, NULL, 0)))
39 av_strlcpy(buf, tag->value, buf_size);
43 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
48 memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
52 count += id3v1_set_string(s, "TIT2", buf + 3, 30); //title
53 count += id3v1_set_string(s, "TPE1", buf + 33, 30); //author|artist
54 count += id3v1_set_string(s, "TALB", buf + 63, 30); //album
55 count += id3v1_set_string(s, "TDRL", buf + 93, 4); //date
56 count += id3v1_set_string(s, "comment", buf + 97, 30);
57 if ((tag = av_metadata_get(s->metadata, "TRCK", NULL, 0))) { //track
59 buf[126] = atoi(tag->value);
62 buf[127] = 0xFF; /* default to unknown genre */
63 if ((tag = av_metadata_get(s->metadata, "TCON", NULL, 0))) { //genre
64 for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
65 if (!strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
77 static void id3v2_put_size(AVFormatContext *s, int size)
79 avio_w8(s->pb, size >> 21 & 0x7f);
80 avio_w8(s->pb, size >> 14 & 0x7f);
81 avio_w8(s->pb, size >> 7 & 0x7f);
82 avio_w8(s->pb, size & 0x7f);
85 static int string_is_ascii(const uint8_t *str)
87 while (*str && *str < 128) str++;
92 * Write a text frame with one (normal frames) or two (TXXX frames) strings
93 * according to encoding (only UTF-8 or UTF-16+BOM supported).
94 * @return number of bytes written or a negative error code.
96 static int id3v2_put_ttag(AVFormatContext *s, const char *str1, const char *str2,
97 uint32_t tag, enum ID3v2Encoding enc)
101 int (*put)(AVIOContext*, const char*);
102 AVIOContext *dyn_buf;
103 if (avio_open_dyn_buf(&dyn_buf) < 0)
104 return AVERROR(ENOMEM);
106 /* check if the strings are ASCII-only and use UTF16 only if
108 if (enc == ID3v2_ENCODING_UTF16BOM && string_is_ascii(str1) &&
109 (!str2 || string_is_ascii(str2)))
110 enc = ID3v2_ENCODING_ISO8859;
112 avio_w8(dyn_buf, enc);
113 if (enc == ID3v2_ENCODING_UTF16BOM) {
114 avio_wl16(dyn_buf, 0xFEFF); /* BOM */
115 put = avio_put_str16le;
122 len = avio_close_dyn_buf(dyn_buf, &pb);
124 avio_wb32(s->pb, tag);
125 id3v2_put_size(s, len);
127 avio_write(s->pb, pb, len);
130 return len + ID3v2_HEADER_SIZE;
133 static int mp2_write_trailer(struct AVFormatContext *s)
135 uint8_t buf[ID3v1_TAG_SIZE];
137 /* write the id3v1 tag */
138 if (id3v1_create_tag(s, buf) > 0) {
139 avio_write(s->pb, buf, ID3v1_TAG_SIZE);
146 AVOutputFormat ff_mp2_muxer = {
148 NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
161 #define VBR_NUM_BAGS 400
162 #define VBR_TOC_SIZE 100
163 typedef struct MP3Context {
164 const AVClass *class;
166 int64_t frames_offset;
172 uint64_t bag[VBR_NUM_BAGS];
175 static const AVOption options[] = {
176 { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
177 offsetof(MP3Context, id3v2_version), FF_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
181 static const AVClass mp3_muxer_class = {
182 .class_name = "MP3 muxer",
183 .item_name = av_default_item_name,
185 .version = LIBAVUTIL_VERSION_INT,
188 static int id3v2_check_write_tag(AVFormatContext *s, AVMetadataTag *t, const char table[][4],
189 enum ID3v2Encoding enc)
194 if (t->key[0] != 'T' || strlen(t->key) != 4)
196 tag = AV_RB32(t->key);
197 for (i = 0; *table[i]; i++)
198 if (tag == AV_RB32(table[i]))
199 return id3v2_put_ttag(s, t->value, NULL, tag, enc);
203 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
206 * Write an empty XING header and initialize respective data.
208 static int mp3_write_xing(AVFormatContext *s)
210 AVCodecContext *codec = s->streams[0]->codec;
211 MP3Context *mp3 = s->priv_data;
214 int32_t mask, header;
216 int srate_idx, i, channels;
219 for (i = 0; i < FF_ARRAY_ELEMS(ff_mpa_freq_tab); i++)
220 if (ff_mpa_freq_tab[i] == codec->sample_rate) {
224 if (i == FF_ARRAY_ELEMS(ff_mpa_freq_tab)) {
225 av_log(s, AV_LOG_ERROR, "Unsupported sample rate.\n");
229 switch (codec->channels) {
230 case 1: channels = MPA_MONO; break;
231 case 2: channels = MPA_STEREO; break;
232 default: av_log(s, AV_LOG_ERROR, "Unsupported number of channels.\n"); return -1;
235 /* dummy MPEG audio header */
236 header = 0xff << 24; // sync
237 header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
238 header |= (srate_idx << 2) << 8;
239 header |= channels << 6;
242 if (15 == bitrate_idx)
245 mask = (bitrate_idx << 4) << 8;
247 ff_mpegaudio_decode_header(&c, header);
248 xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
252 + 4 // frames/size/toc flags
255 + VBR_TOC_SIZE; // toc
257 if (needed <= c.frame_size)
264 avio_wb32(s->pb, header);
265 ffio_fill(s->pb, 0, xing_offset);
266 avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
267 avio_wb32(s->pb, 0x01 | 0x02 | 0x04); // frames/size/toc
269 mp3->frames_offset = avio_tell(s->pb);
270 mp3->size = c.frame_size;
275 avio_wb32(s->pb, 0); // frames
276 avio_wb32(s->pb, 0); // size
279 for (i = 0; i < VBR_TOC_SIZE; ++i)
280 avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
282 ffio_fill(s->pb, 0, c.frame_size - needed);
289 * Add a frame to XING data.
290 * Following lame's "VbrTag.c".
292 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
294 MP3Context *mp3 = s->priv_data;
298 mp3->size += pkt->size;
300 if (mp3->want == ++mp3->seen) {
301 mp3->bag[mp3->pos] = mp3->size;
303 if (VBR_NUM_BAGS == ++mp3->pos) {
304 /* shrink table to half size by throwing away each second bag. */
305 for (i = 1; i < VBR_NUM_BAGS; i += 2)
306 mp3->bag[i >> 1] = mp3->bag[i];
308 /* double wanted amount per bag. */
310 /* adjust current position to half of table size. */
318 static void mp3_fix_xing(AVFormatContext *s)
320 MP3Context *mp3 = s->priv_data;
324 avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
325 avio_wb32(s->pb, mp3->frames);
326 avio_wb32(s->pb, mp3->size);
328 avio_w8(s->pb, 0); // first toc entry has to be zero.
330 for (i = 1; i < VBR_TOC_SIZE; ++i) {
331 int j = i * mp3->pos / VBR_TOC_SIZE;
332 int seek_point = 256LL * mp3->bag[j] / mp3->size;
333 avio_w8(s->pb, FFMIN(seek_point, 255));
337 avio_seek(s->pb, 0, SEEK_END);
341 * Write an ID3v2 header at beginning of stream
344 static int mp3_write_header(struct AVFormatContext *s)
346 MP3Context *mp3 = s->priv_data;
347 AVMetadataTag *t = NULL;
348 int totlen = 0, enc = mp3->id3v2_version == 3 ? ID3v2_ENCODING_UTF16BOM :
350 int64_t size_pos, cur_pos;
352 avio_wb32(s->pb, MKBETAG('I', 'D', '3', mp3->id3v2_version));
354 avio_w8(s->pb, 0); /* flags */
356 /* reserve space for size */
357 size_pos = avio_tell(s->pb);
360 ff_metadata_conv(&s->metadata, ff_id3v2_34_metadata_conv, NULL);
361 if (mp3->id3v2_version == 4)
362 ff_metadata_conv(&s->metadata, ff_id3v2_4_metadata_conv, NULL);
364 while ((t = av_metadata_get(s->metadata, "", t, AV_METADATA_IGNORE_SUFFIX))) {
367 if ((ret = id3v2_check_write_tag(s, t, ff_id3v2_tags, enc)) > 0) {
371 if ((ret = id3v2_check_write_tag(s, t, mp3->id3v2_version == 3 ?
372 ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
377 /* unknown tag, write as TXXX frame */
378 if ((ret = id3v2_put_ttag(s, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
383 cur_pos = avio_tell(s->pb);
384 avio_seek(s->pb, size_pos, SEEK_SET);
385 id3v2_put_size(s, totlen);
386 avio_seek(s->pb, cur_pos, SEEK_SET);
394 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
396 if (! pkt || ! pkt->data || pkt->size < 4)
397 return ff_raw_write_packet(s, pkt);
399 MP3Context *mp3 = s->priv_data;
403 #ifdef FILTER_VBR_HEADERS
404 ff_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
406 /* filter out XING and INFO headers. */
407 base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
409 if (base + 4 <= pkt->size) {
410 uint32_t v = AV_RB32(pkt->data + base);
412 if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
416 /* filter out VBRI headers. */
419 if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
423 if (0 < mp3->frames_offset)
424 mp3_xing_add_frame(s, pkt);
426 return ff_raw_write_packet(s, pkt);
430 static int mp3_write_trailer(AVFormatContext *s)
432 MP3Context *mp3 = s->priv_data;
433 int ret=mp2_write_trailer(s);
438 if (0 < mp3->frames_offset)
444 AVOutputFormat ff_mp3_muxer = {
446 NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
456 .priv_class = &mp3_muxer_class,