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/mpegaudio.h"
31 #include "libavcodec/mpegaudiodata.h"
32 #include "libavcodec/mpegaudiodecheader.h"
33 #include "libavformat/avio_internal.h"
34 #include "libavutil/dict.h"
36 static int id3v1_set_string(AVFormatContext *s, const char *key,
37 uint8_t *buf, int buf_size)
39 AVDictionaryEntry *tag;
40 if ((tag = av_dict_get(s->metadata, key, NULL, 0)))
41 av_strlcpy(buf, tag->value, buf_size);
45 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
47 AVDictionaryEntry *tag;
50 memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
54 count += id3v1_set_string(s, "TIT2", buf + 3, 30); //title
55 count += id3v1_set_string(s, "TPE1", buf + 33, 30); //author|artist
56 count += id3v1_set_string(s, "TALB", buf + 63, 30); //album
57 count += id3v1_set_string(s, "TDRL", buf + 93, 4); //date
58 count += id3v1_set_string(s, "comment", buf + 97, 30);
59 if ((tag = av_dict_get(s->metadata, "TRCK", NULL, 0))) { //track
61 buf[126] = atoi(tag->value);
64 buf[127] = 0xFF; /* default to unknown genre */
65 if ((tag = av_dict_get(s->metadata, "TCON", NULL, 0))) { //genre
66 for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
67 if (!strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
79 static void id3v2_put_size(AVFormatContext *s, int size)
81 avio_w8(s->pb, size >> 21 & 0x7f);
82 avio_w8(s->pb, size >> 14 & 0x7f);
83 avio_w8(s->pb, size >> 7 & 0x7f);
84 avio_w8(s->pb, size & 0x7f);
87 static int string_is_ascii(const uint8_t *str)
89 while (*str && *str < 128) str++;
94 * Write a text frame with one (normal frames) or two (TXXX frames) strings
95 * according to encoding (only UTF-8 or UTF-16+BOM supported).
96 * @return number of bytes written or a negative error code.
98 static int id3v2_put_ttag(AVFormatContext *s, const char *str1, const char *str2,
99 uint32_t tag, enum ID3v2Encoding enc)
103 int (*put)(AVIOContext*, const char*);
104 AVIOContext *dyn_buf;
105 if (avio_open_dyn_buf(&dyn_buf) < 0)
106 return AVERROR(ENOMEM);
108 /* check if the strings are ASCII-only and use UTF16 only if
110 if (enc == ID3v2_ENCODING_UTF16BOM && string_is_ascii(str1) &&
111 (!str2 || string_is_ascii(str2)))
112 enc = ID3v2_ENCODING_ISO8859;
114 avio_w8(dyn_buf, enc);
115 if (enc == ID3v2_ENCODING_UTF16BOM) {
116 avio_wl16(dyn_buf, 0xFEFF); /* BOM */
117 put = avio_put_str16le;
124 len = avio_close_dyn_buf(dyn_buf, &pb);
126 avio_wb32(s->pb, tag);
127 id3v2_put_size(s, len);
129 avio_write(s->pb, pb, len);
132 return len + ID3v2_HEADER_SIZE;
135 static int mp2_write_trailer(struct AVFormatContext *s)
137 uint8_t buf[ID3v1_TAG_SIZE];
139 /* write the id3v1 tag */
140 if (id3v1_create_tag(s, buf) > 0) {
141 avio_write(s->pb, buf, ID3v1_TAG_SIZE);
148 AVOutputFormat ff_mp2_muxer = {
150 NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
163 #define VBR_NUM_BAGS 400
164 #define VBR_TOC_SIZE 100
165 typedef struct MP3Context {
166 const AVClass *class;
168 int64_t frames_offset;
174 uint64_t bag[VBR_NUM_BAGS];
177 static const AVOption options[] = {
178 { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
179 offsetof(MP3Context, id3v2_version), FF_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
183 static const AVClass mp3_muxer_class = {
184 .class_name = "MP3 muxer",
185 .item_name = av_default_item_name,
187 .version = LIBAVUTIL_VERSION_INT,
190 static int id3v2_check_write_tag(AVFormatContext *s, AVDictionaryEntry *t, const char table[][4],
191 enum ID3v2Encoding enc)
196 if (t->key[0] != 'T' || strlen(t->key) != 4)
198 tag = AV_RB32(t->key);
199 for (i = 0; *table[i]; i++)
200 if (tag == AV_RB32(table[i]))
201 return id3v2_put_ttag(s, t->value, NULL, tag, enc);
205 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
208 * Write an empty XING header and initialize respective data.
210 static int mp3_write_xing(AVFormatContext *s)
212 AVCodecContext *codec = s->streams[0]->codec;
213 MP3Context *mp3 = s->priv_data;
216 int32_t mask, header;
218 int srate_idx, i, channels;
221 for (i = 0; i < FF_ARRAY_ELEMS(ff_mpa_freq_tab); i++)
222 if (ff_mpa_freq_tab[i] == codec->sample_rate) {
226 if (i == FF_ARRAY_ELEMS(ff_mpa_freq_tab)) {
227 av_log(s, AV_LOG_ERROR, "Unsupported sample rate.\n");
231 switch (codec->channels) {
232 case 1: channels = MPA_MONO; break;
233 case 2: channels = MPA_STEREO; break;
234 default: av_log(s, AV_LOG_ERROR, "Unsupported number of channels.\n"); return -1;
237 /* dummy MPEG audio header */
238 header = 0xff << 24; // sync
239 header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
240 header |= (srate_idx << 2) << 8;
241 header |= channels << 6;
244 if (15 == bitrate_idx)
247 mask = (bitrate_idx << 4) << 8;
249 ff_mpegaudio_decode_header(&c, header);
250 xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
254 + 4 // frames/size/toc flags
257 + VBR_TOC_SIZE; // toc
259 if (needed <= c.frame_size)
266 avio_wb32(s->pb, header);
267 ffio_fill(s->pb, 0, xing_offset);
268 avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
269 avio_wb32(s->pb, 0x01 | 0x02 | 0x04); // frames/size/toc
271 mp3->frames_offset = avio_tell(s->pb);
272 mp3->size = c.frame_size;
277 avio_wb32(s->pb, 0); // frames
278 avio_wb32(s->pb, 0); // size
281 for (i = 0; i < VBR_TOC_SIZE; ++i)
282 avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
284 ffio_fill(s->pb, 0, c.frame_size - needed);
291 * Add a frame to XING data.
292 * Following lame's "VbrTag.c".
294 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
296 MP3Context *mp3 = s->priv_data;
300 mp3->size += pkt->size;
302 if (mp3->want == ++mp3->seen) {
303 mp3->bag[mp3->pos] = mp3->size;
305 if (VBR_NUM_BAGS == ++mp3->pos) {
306 /* shrink table to half size by throwing away each second bag. */
307 for (i = 1; i < VBR_NUM_BAGS; i += 2)
308 mp3->bag[i >> 1] = mp3->bag[i];
310 /* double wanted amount per bag. */
312 /* adjust current position to half of table size. */
320 static void mp3_fix_xing(AVFormatContext *s)
322 MP3Context *mp3 = s->priv_data;
326 avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
327 avio_wb32(s->pb, mp3->frames);
328 avio_wb32(s->pb, mp3->size);
330 avio_w8(s->pb, 0); // first toc entry has to be zero.
332 for (i = 1; i < VBR_TOC_SIZE; ++i) {
333 int j = i * mp3->pos / VBR_TOC_SIZE;
334 int seek_point = 256LL * mp3->bag[j] / mp3->size;
335 avio_w8(s->pb, FFMIN(seek_point, 255));
339 avio_seek(s->pb, 0, SEEK_END);
343 * Write an ID3v2 header at beginning of stream
346 static int mp3_write_header(struct AVFormatContext *s)
348 MP3Context *mp3 = s->priv_data;
349 AVDictionaryEntry *t = NULL;
350 int totlen = 0, enc = mp3->id3v2_version == 3 ? ID3v2_ENCODING_UTF16BOM :
352 int64_t size_pos, cur_pos;
354 avio_wb32(s->pb, MKBETAG('I', 'D', '3', mp3->id3v2_version));
356 avio_w8(s->pb, 0); /* flags */
358 /* reserve space for size */
359 size_pos = avio_tell(s->pb);
362 ff_metadata_conv(&s->metadata, ff_id3v2_34_metadata_conv, NULL);
363 if (mp3->id3v2_version == 4)
364 ff_metadata_conv(&s->metadata, ff_id3v2_4_metadata_conv, NULL);
366 while ((t = av_dict_get(s->metadata, "", t, AV_DICT_IGNORE_SUFFIX))) {
369 if ((ret = id3v2_check_write_tag(s, t, ff_id3v2_tags, enc)) > 0) {
373 if ((ret = id3v2_check_write_tag(s, t, mp3->id3v2_version == 3 ?
374 ff_id3v2_3_tags : ff_id3v2_4_tags, enc)) > 0) {
379 /* unknown tag, write as TXXX frame */
380 if ((ret = id3v2_put_ttag(s, t->key, t->value, MKBETAG('T', 'X', 'X', 'X'), enc)) < 0)
385 cur_pos = avio_tell(s->pb);
386 avio_seek(s->pb, size_pos, SEEK_SET);
387 id3v2_put_size(s, totlen);
388 avio_seek(s->pb, cur_pos, SEEK_SET);
396 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
398 if (! pkt || ! pkt->data || pkt->size < 4)
399 return ff_raw_write_packet(s, pkt);
401 MP3Context *mp3 = s->priv_data;
402 #ifdef FILTER_VBR_HEADERS
406 ff_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
408 /* filter out XING and INFO headers. */
409 base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
411 if (base + 4 <= pkt->size) {
412 uint32_t v = AV_RB32(pkt->data + base);
414 if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
418 /* filter out VBRI headers. */
421 if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
425 if (mp3->frames_offset)
426 mp3_xing_add_frame(s, pkt);
428 return ff_raw_write_packet(s, pkt);
432 static int mp3_write_trailer(AVFormatContext *s)
434 MP3Context *mp3 = s->priv_data;
435 int ret=mp2_write_trailer(s);
440 if (mp3->frames_offset)
446 AVOutputFormat ff_mp3_muxer = {
448 NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
458 .priv_class = &mp3_muxer_class,