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
23 #include "avio_internal.h"
27 #include "libavutil/avstring.h"
28 #include "libavcodec/mpegaudio.h"
29 #include "libavcodec/mpegaudiodata.h"
30 #include "libavcodec/mpegaudiodecheader.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/opt.h"
33 #include "libavcodec/mpegaudio.h"
34 #include "libavcodec/mpegaudiodata.h"
35 #include "libavcodec/mpegaudiodecheader.h"
36 #include "libavformat/avio_internal.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/avassert.h"
40 static int id3v1_set_string(AVFormatContext *s, const char *key,
41 uint8_t *buf, int buf_size)
43 AVDictionaryEntry *tag;
44 if ((tag = av_dict_get(s->metadata, key, NULL, 0)))
45 av_strlcpy(buf, tag->value, buf_size);
49 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
51 AVDictionaryEntry *tag;
54 memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
58 /* we knowingly overspecify each tag length by one byte to compensate for the mandatory null byte added by av_strlcpy */
59 count += id3v1_set_string(s, "TIT2", buf + 3, 30 + 1); //title
60 count += id3v1_set_string(s, "TPE1", buf + 33, 30 + 1); //author|artist
61 count += id3v1_set_string(s, "TALB", buf + 63, 30 + 1); //album
62 count += id3v1_set_string(s, "TDRL", buf + 93, 4 + 1); //date
63 count += id3v1_set_string(s, "comment", buf + 97, 30 + 1);
64 if ((tag = av_dict_get(s->metadata, "TRCK", NULL, 0))) { //track
66 buf[126] = atoi(tag->value);
69 buf[127] = 0xFF; /* default to unknown genre */
70 if ((tag = av_dict_get(s->metadata, "TCON", NULL, 0))) { //genre
71 for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
72 if (!av_strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
82 #define VBR_NUM_BAGS 400
83 #define VBR_TOC_SIZE 100
85 typedef struct MP3Context {
90 int64_t frames_offset;
96 uint64_t bag[VBR_NUM_BAGS];
98 /* index of the audio stream */
100 /* number of attached pictures we still need to write */
103 /* audio packets are queued here until we get all the attached pictures */
104 AVPacketList *queue, *queue_end;
107 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
110 * Write an empty XING header and initialize respective data.
112 static int mp3_write_xing(AVFormatContext *s)
114 MP3Context *mp3 = s->priv_data;
115 AVCodecContext *codec = s->streams[mp3->audio_stream_idx]->codec;
117 int best_bitrate_idx = -1;
118 int best_bitrate_error= INT_MAX;
120 int32_t header, mask;
122 int srate_idx, i, channels;
125 if (!s->pb->seekable)
128 for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++)
129 if (avpriv_mpa_freq_tab[i] == codec->sample_rate) {
133 if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
134 av_log(s, AV_LOG_WARNING, "Unsupported sample rate, not writing Xing header.\n");
138 switch (codec->channels) {
139 case 1: channels = MPA_MONO; break;
140 case 2: channels = MPA_STEREO; break;
141 default: av_log(s, AV_LOG_WARNING, "Unsupported number of channels, not writing Xing header.\n"); return -1;
144 /* dummy MPEG audio header */
145 header = 0xff << 24; // sync
146 header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
147 header |= (srate_idx << 2) << 8;
148 header |= channels << 6;
150 for (bitrate_idx=1; bitrate_idx<15; bitrate_idx++) {
152 avpriv_mpegaudio_decode_header(&c, header | (bitrate_idx << (4+8)));
153 error= FFABS(c.bit_rate - codec->bit_rate);
154 if(error < best_bitrate_error){
155 best_bitrate_error= error;
156 best_bitrate_idx = bitrate_idx;
159 av_assert0(best_bitrate_idx >= 0);
161 for (bitrate_idx= best_bitrate_idx;; bitrate_idx++) {
162 if (15 == bitrate_idx)
164 mask = bitrate_idx << (4+8);
166 avpriv_mpegaudio_decode_header(&c, header);
167 xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
171 + 4 // frames/size/toc flags
174 + VBR_TOC_SIZE; // toc
176 if (needed <= c.frame_size)
181 avio_wb32(s->pb, header);
182 ffio_fill(s->pb, 0, xing_offset);
183 avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
184 avio_wb32(s->pb, 0x01 | 0x02 | 0x04); // frames/size/toc
186 mp3->frames_offset = avio_tell(s->pb);
187 mp3->size = c.frame_size;
192 avio_wb32(s->pb, 0); // frames
193 avio_wb32(s->pb, 0); // size
196 for (i = 0; i < VBR_TOC_SIZE; ++i)
197 avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
199 ffio_fill(s->pb, 0, c.frame_size - needed);
206 * Add a frame to XING data.
207 * Following lame's "VbrTag.c".
209 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
211 MP3Context *mp3 = s->priv_data;
215 mp3->size += pkt->size;
217 if (mp3->want == ++mp3->seen) {
218 mp3->bag[mp3->pos] = mp3->size;
220 if (VBR_NUM_BAGS == ++mp3->pos) {
221 /* shrink table to half size by throwing away each second bag. */
222 for (i = 1; i < VBR_NUM_BAGS; i += 2)
223 mp3->bag[i >> 1] = mp3->bag[i];
225 /* double wanted amount per bag. */
227 /* adjust current position to half of table size. */
235 static void mp3_fix_xing(AVFormatContext *s)
237 MP3Context *mp3 = s->priv_data;
241 avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
242 avio_wb32(s->pb, mp3->frames);
243 avio_wb32(s->pb, mp3->size);
245 avio_w8(s->pb, 0); // first toc entry has to be zero.
247 for (i = 1; i < VBR_TOC_SIZE; ++i) {
248 int j = i * mp3->pos / VBR_TOC_SIZE;
249 int seek_point = 256LL * mp3->bag[j] / mp3->size;
250 avio_w8(s->pb, FFMIN(seek_point, 255));
254 avio_seek(s->pb, 0, SEEK_END);
257 static int mp3_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
259 if (! pkt || ! pkt->data || pkt->size < 4)
260 return ff_raw_write_packet(s, pkt);
262 MP3Context *mp3 = s->priv_data;
263 #ifdef FILTER_VBR_HEADERS
267 ff_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
269 /* filter out XING and INFO headers. */
270 base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
272 if (base + 4 <= pkt->size) {
273 uint32_t v = AV_RB32(pkt->data + base);
275 if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
279 /* filter out VBRI headers. */
282 if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
286 if (mp3->frames_offset)
287 mp3_xing_add_frame(s, pkt);
289 return ff_raw_write_packet(s, pkt);
293 static int mp3_queue_flush(AVFormatContext *s)
295 MP3Context *mp3 = s->priv_data;
297 int ret = 0, write = 1;
299 ff_id3v2_finish(&mp3->id3, s->pb);
302 while ((pktl = mp3->queue)) {
303 if (write && (ret = mp3_write_packet_internal(s, &pktl->pkt)) < 0)
305 av_free_packet(&pktl->pkt);
306 mp3->queue = pktl->next;
309 mp3->queue_end = NULL;
313 static int mp2_write_trailer(struct AVFormatContext *s)
315 uint8_t buf[ID3v1_TAG_SIZE];
316 MP3Context *mp3 = s->priv_data;
318 if (mp3 && mp3->pics_to_write) {
319 av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
320 "attached pictures.\n");
324 /* write the id3v1 tag */
325 if (mp3 && mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
326 avio_write(s->pb, buf, ID3v1_TAG_SIZE);
329 /* write number of frames */
330 if (mp3 && mp3->frames_offset) {
331 avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
332 avio_wb32(s->pb, s->streams[mp3->audio_stream_idx]->nb_frames);
333 avio_seek(s->pb, 0, SEEK_END);
342 AVOutputFormat ff_mp2_muxer = {
344 .long_name = NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
345 .mime_type = "audio/x-mpeg",
346 .extensions = "mp2,m2a",
347 .audio_codec = CODEC_ID_MP2,
348 .video_codec = CODEC_ID_NONE,
349 .write_packet = ff_raw_write_packet,
350 .write_trailer = mp2_write_trailer,
351 .flags = AVFMT_NOTIMESTAMPS,
357 static const AVOption options[] = {
358 { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
359 offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
360 { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
361 offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
365 static const AVClass mp3_muxer_class = {
366 .class_name = "MP3 muxer",
367 .item_name = av_default_item_name,
369 .version = LIBAVUTIL_VERSION_INT,
372 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
374 MP3Context *mp3 = s->priv_data;
376 if (pkt->stream_index == mp3->audio_stream_idx) {
377 if (mp3->pics_to_write) {
378 /* buffer audio packets until we get all the pictures */
379 AVPacketList *pktl = av_mallocz(sizeof(*pktl));
381 return AVERROR(ENOMEM);
384 pkt->destruct = NULL;
387 mp3->queue_end->next = pktl;
390 mp3->queue_end = pktl;
392 return mp3_write_packet_internal(s, pkt);
396 /* warn only once for each stream */
397 if (s->streams[pkt->stream_index]->nb_frames == 1) {
398 av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
399 " ignoring.\n", pkt->stream_index);
401 if (!mp3->pics_to_write || s->streams[pkt->stream_index]->nb_frames >= 1)
404 if ((ret = ff_id3v2_write_apic(s, &mp3->id3, pkt)) < 0)
406 mp3->pics_to_write--;
408 /* flush the buffered audio packets */
409 if (!mp3->pics_to_write &&
410 (ret = mp3_queue_flush(s)) < 0)
418 * Write an ID3v2 header at beginning of stream
421 static int mp3_write_header(struct AVFormatContext *s)
423 MP3Context *mp3 = s->priv_data;
426 /* check the streams -- we want exactly one audio and arbitrary number of
427 * video (attached pictures) */
428 mp3->audio_stream_idx = -1;
429 for (i = 0; i < s->nb_streams; i++) {
430 AVStream *st = s->streams[i];
431 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
432 if (mp3->audio_stream_idx >= 0 || st->codec->codec_id != CODEC_ID_MP3) {
433 av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one MP3 "
434 "audio stream is required.\n");
435 return AVERROR(EINVAL);
437 mp3->audio_stream_idx = i;
438 } else if (st->codec->codec_type != AVMEDIA_TYPE_VIDEO) {
439 av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in MP3.\n");
440 return AVERROR(EINVAL);
443 if (mp3->audio_stream_idx < 0) {
444 av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
445 return AVERROR(EINVAL);
447 mp3->pics_to_write = s->nb_streams - 1;
449 ff_id3v2_start(&mp3->id3, s->pb, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
450 ret = ff_id3v2_write_metadata(s, &mp3->id3);
454 if (!mp3->pics_to_write) {
455 ff_id3v2_finish(&mp3->id3, s->pb);
462 static int mp3_write_trailer(AVFormatContext *s)
464 MP3Context *mp3 = s->priv_data;
465 int ret=mp2_write_trailer(s);
470 if (mp3->frames_offset)
476 AVOutputFormat ff_mp3_muxer = {
478 .long_name = NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
479 .mime_type = "audio/x-mpeg",
481 .priv_data_size = sizeof(MP3Context),
482 .audio_codec = CODEC_ID_MP3,
483 .video_codec = CODEC_ID_PNG,
484 .write_header = mp3_write_header,
485 .write_packet = mp3_write_packet,
486 .write_trailer = mp3_write_trailer,
487 .flags = AVFMT_NOTIMESTAMPS,
488 .priv_class = &mp3_muxer_class,