mp3enc: Fix Xing tag identification string for CBR files
[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 #include "libavutil/avassert.h"
39
40 static int id3v1_set_string(AVFormatContext *s, const char *key,
41                             uint8_t *buf, int buf_size)
42 {
43     AVDictionaryEntry *tag;
44     if ((tag = av_dict_get(s->metadata, key, NULL, 0)))
45         av_strlcpy(buf, tag->value, buf_size);
46     return !!tag;
47 }
48
49 static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
50 {
51     AVDictionaryEntry *tag;
52     int i, count = 0;
53
54     memset(buf, 0, ID3v1_TAG_SIZE); /* fail safe */
55     buf[0] = 'T';
56     buf[1] = 'A';
57     buf[2] = 'G';
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
65         buf[125] = 0;
66         buf[126] = atoi(tag->value);
67         count++;
68     }
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])) {
73                 buf[127] = i;
74                 count++;
75                 break;
76             }
77         }
78     }
79     return count;
80 }
81
82 #define VBR_NUM_BAGS 400
83 #define VBR_TOC_SIZE 100
84
85 typedef struct MP3Context {
86     const AVClass *class;
87     ID3v2EncContext id3;
88     int id3v2_version;
89     int write_id3v1;
90     int64_t frames_offset;
91     int32_t frames;
92     int32_t size;
93     uint32_t want;
94     uint32_t seen;
95     uint32_t pos;
96     uint64_t bag[VBR_NUM_BAGS];
97     int initial_bitrate;
98     int has_variable_bitrate;
99
100     /* index of the audio stream */
101     int audio_stream_idx;
102     /* number of attached pictures we still need to write */
103     int pics_to_write;
104
105     /* audio packets are queued here until we get all the attached pictures */
106     AVPacketList *queue, *queue_end;
107 } MP3Context;
108
109 static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
110
111 /*
112  * Write an empty XING header and initialize respective data.
113  */
114 static int mp3_write_xing(AVFormatContext *s)
115 {
116     MP3Context       *mp3 = s->priv_data;
117     AVCodecContext *codec = s->streams[mp3->audio_stream_idx]->codec;
118     int              bitrate_idx;
119     int              best_bitrate_idx = -1;
120     int              best_bitrate_error= INT_MAX;
121     int64_t          xing_offset;
122     int32_t          header, mask;
123     MPADecodeHeader  c;
124     int              srate_idx, i, channels;
125     int              needed;
126
127     if (!s->pb->seekable)
128         return 0;
129
130     for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++)
131         if (avpriv_mpa_freq_tab[i] == codec->sample_rate) {
132             srate_idx = i;
133             break;
134         }
135     if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
136         av_log(s, AV_LOG_WARNING, "Unsupported sample rate, not writing Xing header.\n");
137         return -1;
138     }
139
140     switch (codec->channels) {
141     case 1:  channels = MPA_MONO;                                          break;
142     case 2:  channels = MPA_STEREO;                                        break;
143     default: av_log(s, AV_LOG_WARNING, "Unsupported number of channels, not writing Xing header.\n"); return -1;
144     }
145
146     /* dummy MPEG audio header */
147     header  =  0xff                                  << 24; // sync
148     header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
149     header |= (srate_idx << 2) <<  8;
150     header |= channels << 6;
151
152     for (bitrate_idx=1; bitrate_idx<15; bitrate_idx++) {
153         int error;
154         avpriv_mpegaudio_decode_header(&c, header | (bitrate_idx << (4+8)));
155         error= FFABS(c.bit_rate - codec->bit_rate);
156         if(error < best_bitrate_error){
157             best_bitrate_error= error;
158             best_bitrate_idx  = bitrate_idx;
159         }
160     }
161     av_assert0(best_bitrate_idx >= 0);
162
163     for (bitrate_idx= best_bitrate_idx;; bitrate_idx++) {
164         if (15 == bitrate_idx)
165             return -1;
166         mask = bitrate_idx << (4+8);
167         header |= mask;
168         avpriv_mpegaudio_decode_header(&c, header);
169         xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
170         needed = 4              // header
171                + xing_offset
172                + 4              // xing tag
173                + 4              // frames/size/toc flags
174                + 4              // frames
175                + 4              // size
176                + VBR_TOC_SIZE;  // toc
177
178         if (needed <= c.frame_size)
179             break;
180         header &= ~mask;
181     }
182
183     avio_wb32(s->pb, header);
184     ffio_fill(s->pb, 0, xing_offset);
185     avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
186     avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames/size/toc
187
188     mp3->frames_offset = avio_tell(s->pb);
189     mp3->size = c.frame_size;
190     mp3->want=1;
191     mp3->seen=0;
192     mp3->pos=0;
193
194     avio_wb32(s->pb, 0);  // frames
195     avio_wb32(s->pb, 0);  // size
196
197     // toc
198     for (i = 0; i < VBR_TOC_SIZE; ++i)
199         avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
200
201     ffio_fill(s->pb, 0, c.frame_size - needed);
202     avio_flush(s->pb);
203
204     return 0;
205 }
206
207 /*
208  * Add a frame to XING data.
209  * Following lame's "VbrTag.c".
210  */
211 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
212 {
213     MP3Context  *mp3 = s->priv_data;
214     int i;
215
216     ++mp3->frames;
217     mp3->size += pkt->size;
218
219     if (mp3->want == ++mp3->seen) {
220         mp3->bag[mp3->pos] = mp3->size;
221
222         if (VBR_NUM_BAGS == ++mp3->pos) {
223             /* shrink table to half size by throwing away each second bag. */
224             for (i = 1; i < VBR_NUM_BAGS; i += 2)
225                 mp3->bag[i >> 1] = mp3->bag[i];
226
227             /* double wanted amount per bag. */
228             mp3->want <<= 1;
229             /* adjust current position to half of table size. */
230             mp3->pos >>= 1;
231         }
232
233         mp3->seen = 0;
234     }
235 }
236
237 static void mp3_fix_xing(AVFormatContext *s)
238 {
239     MP3Context  *mp3 = s->priv_data;
240     int i;
241
242     avio_flush(s->pb);
243
244     /* replace "Xing" identification string with "Info" for CBR files. */
245     if (!mp3->has_variable_bitrate) {
246         int64_t tag_offset = mp3->frames_offset
247             - 4   // frames/size/toc flags
248             - 4;  // xing tag
249         avio_seek(s->pb, tag_offset, SEEK_SET);
250         avio_wb32(s->pb, MKBETAG('I', 'n', 'f', 'o'));
251     }
252
253     avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
254     avio_wb32(s->pb, mp3->frames);
255     avio_wb32(s->pb, mp3->size);
256
257     avio_w8(s->pb, 0);  // first toc entry has to be zero.
258
259     for (i = 1; i < VBR_TOC_SIZE; ++i) {
260         int j = i * mp3->pos / VBR_TOC_SIZE;
261         int seek_point = 256LL * mp3->bag[j] / mp3->size;
262         avio_w8(s->pb, FFMIN(seek_point, 255));
263     }
264
265     avio_flush(s->pb);
266     avio_seek(s->pb, 0, SEEK_END);
267 }
268
269 static int mp3_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
270 {
271     if (! pkt || ! pkt->data || pkt->size < 4)
272         return ff_raw_write_packet(s, pkt);
273     else {
274         MP3Context  *mp3 = s->priv_data;
275         MPADecodeHeader c;
276 #ifdef FILTER_VBR_HEADERS
277         int base;
278 #endif
279
280         avpriv_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
281
282         if (!mp3->initial_bitrate)
283             mp3->initial_bitrate = c.bit_rate;
284         if (!mp3->has_variable_bitrate) {
285             if ((c.bit_rate == 0) || (mp3->initial_bitrate != c.bit_rate))
286                 mp3->has_variable_bitrate = 1;
287         }
288
289 #ifdef FILTER_VBR_HEADERS
290         /* filter out XING and INFO headers. */
291         base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
292
293         if (base + 4 <= pkt->size) {
294             uint32_t v = AV_RB32(pkt->data + base);
295
296             if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
297                 return 0;
298         }
299
300         /* filter out VBRI headers. */
301         base = 4 + 32;
302
303         if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
304             return 0;
305 #endif
306
307         if (mp3->frames_offset)
308             mp3_xing_add_frame(s, pkt);
309
310         return ff_raw_write_packet(s, pkt);
311     }
312 }
313
314 static int mp3_queue_flush(AVFormatContext *s)
315 {
316     MP3Context *mp3 = s->priv_data;
317     AVPacketList *pktl;
318     int ret = 0, write = 1;
319
320     ff_id3v2_finish(&mp3->id3, s->pb);
321     mp3_write_xing(s);
322
323     while ((pktl = mp3->queue)) {
324         if (write && (ret = mp3_write_packet_internal(s, &pktl->pkt)) < 0)
325             write = 0;
326         av_free_packet(&pktl->pkt);
327         mp3->queue = pktl->next;
328         av_freep(&pktl);
329     }
330     mp3->queue_end = NULL;
331     return ret;
332 }
333
334 static int mp2_write_trailer(struct AVFormatContext *s)
335 {
336     uint8_t buf[ID3v1_TAG_SIZE];
337     MP3Context *mp3 = s->priv_data;
338
339     if (mp3 && mp3->pics_to_write) {
340         av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
341                "attached pictures.\n");
342         mp3_queue_flush(s);
343     }
344
345     /* write the id3v1 tag */
346     if (mp3 && mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
347         avio_write(s->pb, buf, ID3v1_TAG_SIZE);
348     }
349
350     /* write number of frames */
351     if (mp3 && mp3->frames_offset) {
352         avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
353         avio_wb32(s->pb, s->streams[mp3->audio_stream_idx]->nb_frames);
354         avio_seek(s->pb, 0, SEEK_END);
355     }
356
357     avio_flush(s->pb);
358
359     return 0;
360 }
361
362 #if CONFIG_MP2_MUXER
363 AVOutputFormat ff_mp2_muxer = {
364     .name              = "mp2",
365     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
366     .mime_type         = "audio/x-mpeg",
367     .extensions        = "mp2,m2a",
368     .audio_codec       = CODEC_ID_MP2,
369     .video_codec       = CODEC_ID_NONE,
370     .write_packet      = ff_raw_write_packet,
371     .write_trailer     = mp2_write_trailer,
372     .flags             = AVFMT_NOTIMESTAMPS,
373 };
374 #endif
375
376 #if CONFIG_MP3_MUXER
377
378 static const AVOption options[] = {
379     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
380       offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
381     { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
382       offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
383     { NULL },
384 };
385
386 static const AVClass mp3_muxer_class = {
387     .class_name     = "MP3 muxer",
388     .item_name      = av_default_item_name,
389     .option         = options,
390     .version        = LIBAVUTIL_VERSION_INT,
391 };
392
393 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
394 {
395     MP3Context *mp3 = s->priv_data;
396
397     if (pkt->stream_index == mp3->audio_stream_idx) {
398         if (mp3->pics_to_write) {
399             /* buffer audio packets until we get all the pictures */
400             AVPacketList *pktl = av_mallocz(sizeof(*pktl));
401             if (!pktl)
402                 return AVERROR(ENOMEM);
403
404             pktl->pkt     = *pkt;
405             pkt->destruct = NULL;
406
407             if (mp3->queue_end)
408                 mp3->queue_end->next = pktl;
409             else
410                 mp3->queue = pktl;
411             mp3->queue_end = pktl;
412         } else
413             return mp3_write_packet_internal(s, pkt);
414     } else {
415         int ret;
416
417         /* warn only once for each stream */
418         if (s->streams[pkt->stream_index]->nb_frames == 1) {
419             av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
420                    " ignoring.\n", pkt->stream_index);
421         }
422         if (!mp3->pics_to_write || s->streams[pkt->stream_index]->nb_frames >= 1)
423             return 0;
424
425         if ((ret = ff_id3v2_write_apic(s, &mp3->id3, pkt)) < 0)
426             return ret;
427         mp3->pics_to_write--;
428
429         /* flush the buffered audio packets */
430         if (!mp3->pics_to_write &&
431             (ret = mp3_queue_flush(s)) < 0)
432             return ret;
433     }
434
435     return 0;
436 }
437
438 /**
439  * Write an ID3v2 header at beginning of stream
440  */
441
442 static int mp3_write_header(struct AVFormatContext *s)
443 {
444     MP3Context  *mp3 = s->priv_data;
445     int ret, i;
446
447     /* check the streams -- we want exactly one audio and arbitrary number of
448      * video (attached pictures) */
449     mp3->audio_stream_idx = -1;
450     for (i = 0; i < s->nb_streams; i++) {
451         AVStream *st = s->streams[i];
452         if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
453             if (mp3->audio_stream_idx >= 0 || st->codec->codec_id != CODEC_ID_MP3) {
454                 av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one MP3 "
455                        "audio stream is required.\n");
456                 return AVERROR(EINVAL);
457             }
458             mp3->audio_stream_idx = i;
459         } else if (st->codec->codec_type != AVMEDIA_TYPE_VIDEO) {
460             av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in MP3.\n");
461             return AVERROR(EINVAL);
462         }
463     }
464     if (mp3->audio_stream_idx < 0) {
465         av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
466         return AVERROR(EINVAL);
467     }
468     mp3->pics_to_write = s->nb_streams - 1;
469
470     ff_id3v2_start(&mp3->id3, s->pb, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
471     ret = ff_id3v2_write_metadata(s, &mp3->id3);
472     if (ret < 0)
473         return ret;
474
475     if (!mp3->pics_to_write) {
476         ff_id3v2_finish(&mp3->id3, s->pb);
477         mp3_write_xing(s);
478     }
479
480     return 0;
481 }
482
483 static int mp3_write_trailer(AVFormatContext *s)
484 {
485     MP3Context  *mp3 = s->priv_data;
486     int ret=mp2_write_trailer(s);
487
488     if (ret < 0)
489         return ret;
490
491     if (mp3->frames_offset)
492         mp3_fix_xing(s);
493
494     return 0;
495 }
496
497 AVOutputFormat ff_mp3_muxer = {
498     .name              = "mp3",
499     .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
500     .mime_type         = "audio/x-mpeg",
501     .extensions        = "mp3",
502     .priv_data_size    = sizeof(MP3Context),
503     .audio_codec       = CODEC_ID_MP3,
504     .video_codec       = CODEC_ID_PNG,
505     .write_header      = mp3_write_header,
506     .write_packet      = mp3_write_packet,
507     .write_trailer     = mp3_write_trailer,
508     .flags             = AVFMT_NOTIMESTAMPS,
509     .priv_class        = &mp3_muxer_class,
510 };
511 #endif