mp3enc: simplify mp3_write_xing()
[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 "avformat.h"
23 #include "avio_internal.h"
24 #include "id3v1.h"
25 #include "id3v2.h"
26 #include "rawenc.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
39 static int id3v1_set_string(AVFormatContext *s, const char *key,
40                             uint8_t *buf, int buf_size)
41 {
42     AVDictionaryEntry *tag;
43     if ((tag = av_dict_get(s->metadata, key, NULL, 0)))
44         av_strlcpy(buf, tag->value, buf_size);
45     return !!tag;
46 }
47
48 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
49 {
50     AVDictionaryEntry *tag;
51     int i, count = 0;
52
53     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
54     buf[0] = 'T';
55     buf[1] = 'A';
56     buf[2] = 'G';
57     /* we knowingly overspecify each tag length by one byte to compensate for the mandatory null byte added by av_strlcpy */
58     count += id3v1_set_string(s, "TIT2",    buf +  3, 30 + 1);       //title
59     count += id3v1_set_string(s, "TPE1",    buf + 33, 30 + 1);       //author|artist
60     count += id3v1_set_string(s, "TALB",    buf + 63, 30 + 1);       //album
61     count += id3v1_set_string(s, "TDRL",    buf + 93,  4 + 1);       //date
62     count += id3v1_set_string(s, "comment", buf + 97, 30 + 1);
63     if ((tag = av_dict_get(s->metadata, "TRCK", NULL, 0))) { //track
64         buf[125] = 0;
65         buf[126] = atoi(tag->value);
66         count++;
67     }
68     buf[127] = 0xFF; /* default to unknown genre */
69     if ((tag = av_dict_get(s->metadata, "TCON", NULL, 0))) { //genre
70         for(i = 0; i <= ID3v1_GENRE_MAX; i++) {
71             if (!av_strcasecmp(tag->value, ff_id3v1_genre_str[i])) {
72                 buf[127] = i;
73                 count++;
74                 break;
75             }
76         }
77     }
78     return count;
79 }
80
81 #define VBR_NUM_BAGS 400
82 #define VBR_TOC_SIZE 100
83
84 typedef struct MP3Context {
85     const AVClass *class;
86     int id3v2_version;
87     int write_id3v1;
88     int64_t frames_offset;
89     int32_t frames;
90     int32_t size;
91     uint32_t want;
92     uint32_t seen;
93     uint32_t pos;
94     uint64_t bag[VBR_NUM_BAGS];
95 } MP3Context;
96
97 static int mp2_write_trailer(struct AVFormatContext *s)
98 {
99     uint8_t buf[ID3v1_TAG_SIZE];
100     MP3Context *mp3 = s->priv_data;
101
102     /* write the id3v1 tag */
103     if (mp3 && mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
104         avio_write(s->pb, buf, ID3v1_TAG_SIZE);
105     }
106
107     /* write number of frames */
108     if (mp3 && mp3->frames_offset) {
109         avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
110         avio_wb32(s->pb, s->streams[0]->nb_frames);
111         avio_seek(s->pb, 0, SEEK_END);
112     }
113
114     avio_flush(s->pb);
115
116     return 0;
117 }
118
119 #if CONFIG_MP2_MUXER
120 AVOutputFormat ff_mp2_muxer = {
121     .name              = "mp2",
122     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
123     .mime_type         = "audio/x-mpeg",
124     .extensions        = "mp2,m2a",
125     .audio_codec       = CODEC_ID_MP2,
126     .video_codec       = CODEC_ID_NONE,
127     .write_packet      = ff_raw_write_packet,
128     .write_trailer     = mp2_write_trailer,
129     .flags             = AVFMT_NOTIMESTAMPS,
130 };
131 #endif
132
133 #if CONFIG_MP3_MUXER
134
135 static const AVOption options[] = {
136     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
137       offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
138     { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
139       offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
140     { NULL },
141 };
142
143 static const AVClass mp3_muxer_class = {
144     .class_name     = "MP3 muxer",
145     .item_name      = av_default_item_name,
146     .option         = options,
147     .version        = LIBAVUTIL_VERSION_INT,
148 };
149
150 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
151
152 /*
153  * Write an empty XING header and initialize respective data.
154  */
155 static int mp3_write_xing(AVFormatContext *s)
156 {
157     AVCodecContext   *codec = s->streams[0]->codec;
158     MP3Context       *mp3 = s->priv_data;
159     int              bitrate_idx = 3;
160     int64_t          xing_offset;
161     int32_t          mask, header;
162     MPADecodeHeader  c;
163     int              srate_idx, i, channels;
164     int              needed;
165
166     for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++)
167         if (avpriv_mpa_freq_tab[i] == codec->sample_rate) {
168             srate_idx = i;
169             break;
170         }
171     if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
172         av_log(s, AV_LOG_ERROR, "Unsupported sample rate.\n");
173         return -1;
174     }
175
176     switch (codec->channels) {
177     case 1:  channels = MPA_MONO;                                          break;
178     case 2:  channels = MPA_STEREO;                                        break;
179     default: av_log(s, AV_LOG_ERROR, "Unsupported number of channels.\n"); return -1;
180     }
181
182     /* dummy MPEG audio header */
183     header  =  0xff                                  << 24; // sync
184     header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
185     header |= (srate_idx << 2) <<  8;
186     header |= channels << 6;
187
188     for (;; bitrate_idx++) {
189         if (15 == bitrate_idx)
190             return -1;
191
192         avpriv_mpegaudio_decode_header(&c, header | (bitrate_idx << (4+8)));
193         xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
194         needed = 4              // header
195                + xing_offset
196                + 4              // xing tag
197                + 4              // frames/size/toc flags
198                + 4              // frames
199                + 4              // size
200                + VBR_TOC_SIZE;  // toc
201
202         if (needed <= c.frame_size)
203             break;
204     }
205
206     avio_wb32(s->pb, header);
207     ffio_fill(s->pb, 0, xing_offset);
208     avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
209     avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames/size/toc
210
211     mp3->frames_offset = avio_tell(s->pb);
212     mp3->size = c.frame_size;
213     mp3->want=1;
214     mp3->seen=0;
215     mp3->pos=0;
216
217     avio_wb32(s->pb, 0);  // frames
218     avio_wb32(s->pb, 0);  // size
219
220     // toc
221     for (i = 0; i < VBR_TOC_SIZE; ++i)
222         avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
223
224     ffio_fill(s->pb, 0, c.frame_size - needed);
225     avio_flush(s->pb);
226
227     return 0;
228 }
229
230 /*
231  * Add a frame to XING data.
232  * Following lame's "VbrTag.c".
233  */
234 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
235 {
236     MP3Context  *mp3 = s->priv_data;
237     int i;
238
239     ++mp3->frames;
240     mp3->size += pkt->size;
241
242     if (mp3->want == ++mp3->seen) {
243         mp3->bag[mp3->pos] = mp3->size;
244
245         if (VBR_NUM_BAGS == ++mp3->pos) {
246             /* shrink table to half size by throwing away each second bag. */
247             for (i = 1; i < VBR_NUM_BAGS; i += 2)
248                 mp3->bag[i >> 1] = mp3->bag[i];
249
250             /* double wanted amount per bag. */
251             mp3->want <<= 1;
252             /* adjust current position to half of table size. */
253             mp3->pos >>= 1;
254         }
255
256         mp3->seen = 0;
257     }
258 }
259
260 static void mp3_fix_xing(AVFormatContext *s)
261 {
262     MP3Context  *mp3 = s->priv_data;
263     int i;
264
265     avio_flush(s->pb);
266     avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
267     avio_wb32(s->pb, mp3->frames);
268     avio_wb32(s->pb, mp3->size);
269
270     avio_w8(s->pb, 0);  // first toc entry has to be zero.
271
272     for (i = 1; i < VBR_TOC_SIZE; ++i) {
273         int j = i * mp3->pos / VBR_TOC_SIZE;
274         int seek_point = 256LL * mp3->bag[j] / mp3->size;
275         avio_w8(s->pb, FFMIN(seek_point, 255));
276     }
277
278     avio_flush(s->pb);
279     avio_seek(s->pb, 0, SEEK_END);
280 }
281
282 /**
283  * Write an ID3v2 header at beginning of stream
284  */
285
286 static int mp3_write_header(struct AVFormatContext *s)
287 {
288     MP3Context  *mp3 = s->priv_data;
289     int ret;
290
291     ret = ff_id3v2_write(s, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
292     if (ret < 0)
293         return ret;
294
295     if (s->pb->seekable)
296         mp3_write_xing(s);
297
298     return 0;
299 }
300
301 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
302 {
303     if (! pkt || ! pkt->data || pkt->size < 4)
304         return ff_raw_write_packet(s, pkt);
305     else {
306         MP3Context  *mp3 = s->priv_data;
307 #ifdef FILTER_VBR_HEADERS
308         MPADecodeHeader c;
309         int base;
310
311         ff_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
312
313         /* filter out XING and INFO headers. */
314         base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
315
316         if (base + 4 <= pkt->size) {
317             uint32_t v = AV_RB32(pkt->data + base);
318
319             if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
320                 return 0;
321         }
322
323         /* filter out VBRI headers. */
324         base = 4 + 32;
325
326         if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
327             return 0;
328 #endif
329
330         if (mp3->frames_offset)
331             mp3_xing_add_frame(s, pkt);
332
333         return ff_raw_write_packet(s, pkt);
334     }
335 }
336
337 static int mp3_write_trailer(AVFormatContext *s)
338 {
339     MP3Context  *mp3 = s->priv_data;
340     int ret=mp2_write_trailer(s);
341
342     if (ret < 0)
343         return ret;
344
345     if (mp3->frames_offset)
346         mp3_fix_xing(s);
347
348     return 0;
349 }
350
351 AVOutputFormat ff_mp3_muxer = {
352     .name              = "mp3",
353     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
354     .mime_type         = "audio/x-mpeg",
355     .extensions        = "mp3",
356     .priv_data_size    = sizeof(MP3Context),
357     .audio_codec       = CODEC_ID_MP3,
358     .video_codec       = CODEC_ID_NONE,
359     .write_header      = mp3_write_header,
360     .write_packet      = mp3_write_packet,
361     .write_trailer     = mp3_write_trailer,
362     .flags             = AVFMT_NOTIMESTAMPS,
363     .priv_class = &mp3_muxer_class,
364 };
365 #endif