Merge commit '36ef5369ee9b336febc2c270f8718cec4476cb85'
[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, ver = 0, i, channels;
125     int              needed;
126     const char      *vendor = (codec->flags & CODEC_FLAG_BITEXACT) ? "Lavf" : LIBAVFORMAT_IDENT;
127
128     if (!s->pb->seekable)
129         return 0;
130
131     for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++) {
132         const uint16_t base_freq = avpriv_mpa_freq_tab[i];
133         if      (codec->sample_rate == base_freq)     ver = 0x3; // MPEG 1
134         else if (codec->sample_rate == base_freq / 2) ver = 0x2; // MPEG 2
135         else if (codec->sample_rate == base_freq / 4) ver = 0x0; // MPEG 2.5
136         else continue;
137         srate_idx = i;
138         break;
139     }
140     if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
141         av_log(s, AV_LOG_WARNING, "Unsupported sample rate, not writing Xing header.\n");
142         return -1;
143     }
144
145     switch (codec->channels) {
146     case 1:  channels = MPA_MONO;                                          break;
147     case 2:  channels = MPA_STEREO;                                        break;
148     default: av_log(s, AV_LOG_WARNING, "Unsupported number of channels, not writing Xing header.\n"); return -1;
149     }
150
151     /* dummy MPEG audio header */
152     header  =  0xff                                  << 24; // sync
153     header |= (0x7 << 5 | ver << 3 | 0x1 << 1 | 0x1) << 16; // sync/audio-version/layer 3/no crc*/
154     header |= (srate_idx << 2) <<  8;
155     header |= channels << 6;
156
157     for (bitrate_idx=1; bitrate_idx<15; bitrate_idx++) {
158         int error;
159         avpriv_mpegaudio_decode_header(&c, header | (bitrate_idx << (4+8)));
160         error= FFABS(c.bit_rate - codec->bit_rate);
161         if(error < best_bitrate_error){
162             best_bitrate_error= error;
163             best_bitrate_idx  = bitrate_idx;
164         }
165     }
166     av_assert0(best_bitrate_idx >= 0);
167
168     for (bitrate_idx= best_bitrate_idx;; bitrate_idx++) {
169         if (15 == bitrate_idx)
170             return -1;
171         mask = bitrate_idx << (4+8);
172         header |= mask;
173         avpriv_mpegaudio_decode_header(&c, header);
174         xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
175         needed = 4              // header
176                + xing_offset
177                + 4              // xing tag
178                + 4              // frames/size/toc flags
179                + 4              // frames
180                + 4              // size
181                + VBR_TOC_SIZE   // toc
182                + 24
183                ;
184
185         if (needed <= c.frame_size)
186             break;
187         header &= ~mask;
188     }
189
190     avio_wb32(s->pb, header);
191     ffio_fill(s->pb, 0, xing_offset);
192     avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
193     avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames/size/toc
194
195     mp3->frames_offset = avio_tell(s->pb);
196     mp3->size = c.frame_size;
197     mp3->want=1;
198     mp3->seen=0;
199     mp3->pos=0;
200
201     avio_wb32(s->pb, 0);  // frames
202     avio_wb32(s->pb, 0);  // size
203
204     // toc
205     for (i = 0; i < VBR_TOC_SIZE; ++i)
206         avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
207
208     for (i = 0; i < strlen(vendor); ++i)
209         avio_w8(s->pb, vendor[i]);
210     for (; i < 21; ++i)
211         avio_w8(s->pb, 0);
212     avio_wb24(s->pb, FFMAX(codec->delay - 528 - 1, 0)<<12);
213
214     ffio_fill(s->pb, 0, c.frame_size - needed);
215     avio_flush(s->pb);
216
217     return 0;
218 }
219
220 /*
221  * Add a frame to XING data.
222  * Following lame's "VbrTag.c".
223  */
224 static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
225 {
226     MP3Context  *mp3 = s->priv_data;
227     int i;
228
229     ++mp3->frames;
230     mp3->size += pkt->size;
231
232     if (mp3->want == ++mp3->seen) {
233         mp3->bag[mp3->pos] = mp3->size;
234
235         if (VBR_NUM_BAGS == ++mp3->pos) {
236             /* shrink table to half size by throwing away each second bag. */
237             for (i = 1; i < VBR_NUM_BAGS; i += 2)
238                 mp3->bag[i >> 1] = mp3->bag[i];
239
240             /* double wanted amount per bag. */
241             mp3->want <<= 1;
242             /* adjust current position to half of table size. */
243             mp3->pos >>= 1;
244         }
245
246         mp3->seen = 0;
247     }
248 }
249
250 static void mp3_fix_xing(AVFormatContext *s)
251 {
252     MP3Context  *mp3 = s->priv_data;
253     int i;
254
255     avio_flush(s->pb);
256
257     /* replace "Xing" identification string with "Info" for CBR files. */
258     if (!mp3->has_variable_bitrate) {
259         int64_t tag_offset = mp3->frames_offset
260             - 4   // frames/size/toc flags
261             - 4;  // xing tag
262         avio_seek(s->pb, tag_offset, SEEK_SET);
263         avio_wb32(s->pb, MKBETAG('I', 'n', 'f', 'o'));
264     }
265
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 static int mp3_write_packet_internal(AVFormatContext *s, AVPacket *pkt)
283 {
284     if (! pkt || ! pkt->data || pkt->size < 4)
285         return ff_raw_write_packet(s, pkt);
286     else {
287         MP3Context  *mp3 = s->priv_data;
288         MPADecodeHeader c;
289         int av_unused base;
290
291         avpriv_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
292
293         if (!mp3->initial_bitrate)
294             mp3->initial_bitrate = c.bit_rate;
295         if (!mp3->has_variable_bitrate) {
296             if ((c.bit_rate == 0) || (mp3->initial_bitrate != c.bit_rate))
297                 mp3->has_variable_bitrate = 1;
298         }
299
300 #ifdef FILTER_VBR_HEADERS
301         /* filter out XING and INFO headers. */
302         base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
303
304         if (base + 4 <= pkt->size) {
305             uint32_t v = AV_RB32(pkt->data + base);
306
307             if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
308                 return 0;
309         }
310
311         /* filter out VBRI headers. */
312         base = 4 + 32;
313
314         if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
315             return 0;
316 #endif
317
318         if (mp3->frames_offset)
319             mp3_xing_add_frame(s, pkt);
320
321         return ff_raw_write_packet(s, pkt);
322     }
323 }
324
325 static int mp3_queue_flush(AVFormatContext *s)
326 {
327     MP3Context *mp3 = s->priv_data;
328     AVPacketList *pktl;
329     int ret = 0, write = 1;
330
331     ff_id3v2_finish(&mp3->id3, s->pb);
332     mp3_write_xing(s);
333
334     while ((pktl = mp3->queue)) {
335         if (write && (ret = mp3_write_packet_internal(s, &pktl->pkt)) < 0)
336             write = 0;
337         av_free_packet(&pktl->pkt);
338         mp3->queue = pktl->next;
339         av_freep(&pktl);
340     }
341     mp3->queue_end = NULL;
342     return ret;
343 }
344
345 static int mp2_write_trailer(struct AVFormatContext *s)
346 {
347     uint8_t buf[ID3v1_TAG_SIZE];
348     MP3Context *mp3 = s->priv_data;
349
350     if (mp3 && mp3->pics_to_write) {
351         av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
352                "attached pictures.\n");
353         mp3_queue_flush(s);
354     }
355
356     /* write the id3v1 tag */
357     if (mp3 && mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
358         avio_write(s->pb, buf, ID3v1_TAG_SIZE);
359     }
360
361     /* write number of frames */
362     if (mp3 && mp3->frames_offset) {
363         avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
364         avio_wb32(s->pb, s->streams[mp3->audio_stream_idx]->nb_frames);
365         avio_seek(s->pb, 0, SEEK_END);
366     }
367
368     avio_flush(s->pb);
369
370     return 0;
371 }
372
373 #if CONFIG_MP2_MUXER
374 AVOutputFormat ff_mp2_muxer = {
375     .name              = "mp2",
376     .long_name         = NULL_IF_CONFIG_SMALL("MP2 (MPEG audio layer 2)"),
377     .mime_type         = "audio/x-mpeg",
378     .extensions        = "mp2,m2a",
379     .audio_codec       = AV_CODEC_ID_MP2,
380     .video_codec       = AV_CODEC_ID_NONE,
381     .write_packet      = ff_raw_write_packet,
382     .write_trailer     = mp2_write_trailer,
383     .flags             = AVFMT_NOTIMESTAMPS,
384 };
385 #endif
386
387 #if CONFIG_MP3_MUXER
388
389 static const AVOption options[] = {
390     { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
391       offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
392     { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
393       offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
394     { NULL },
395 };
396
397 static const AVClass mp3_muxer_class = {
398     .class_name     = "MP3 muxer",
399     .item_name      = av_default_item_name,
400     .option         = options,
401     .version        = LIBAVUTIL_VERSION_INT,
402 };
403
404 static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
405 {
406     MP3Context *mp3 = s->priv_data;
407
408     if (pkt->stream_index == mp3->audio_stream_idx) {
409         if (mp3->pics_to_write) {
410             /* buffer audio packets until we get all the pictures */
411             AVPacketList *pktl = av_mallocz(sizeof(*pktl));
412             if (!pktl)
413                 return AVERROR(ENOMEM);
414
415             pktl->pkt     = *pkt;
416             pkt->destruct = NULL;
417
418             if (mp3->queue_end)
419                 mp3->queue_end->next = pktl;
420             else
421                 mp3->queue = pktl;
422             mp3->queue_end = pktl;
423         } else
424             return mp3_write_packet_internal(s, pkt);
425     } else {
426         int ret;
427
428         /* warn only once for each stream */
429         if (s->streams[pkt->stream_index]->nb_frames == 1) {
430             av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
431                    " ignoring.\n", pkt->stream_index);
432         }
433         if (!mp3->pics_to_write || s->streams[pkt->stream_index]->nb_frames >= 1)
434             return 0;
435
436         if ((ret = ff_id3v2_write_apic(s, &mp3->id3, pkt)) < 0)
437             return ret;
438         mp3->pics_to_write--;
439
440         /* flush the buffered audio packets */
441         if (!mp3->pics_to_write &&
442             (ret = mp3_queue_flush(s)) < 0)
443             return ret;
444     }
445
446     return 0;
447 }
448
449 /**
450  * Write an ID3v2 header at beginning of stream
451  */
452
453 static int mp3_write_header(struct AVFormatContext *s)
454 {
455     MP3Context  *mp3 = s->priv_data;
456     int ret, i;
457
458     /* check the streams -- we want exactly one audio and arbitrary number of
459      * video (attached pictures) */
460     mp3->audio_stream_idx = -1;
461     for (i = 0; i < s->nb_streams; i++) {
462         AVStream *st = s->streams[i];
463         if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
464             if (mp3->audio_stream_idx >= 0 || st->codec->codec_id != AV_CODEC_ID_MP3) {
465                 av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one MP3 "
466                        "audio stream is required.\n");
467                 return AVERROR(EINVAL);
468             }
469             mp3->audio_stream_idx = i;
470         } else if (st->codec->codec_type != AVMEDIA_TYPE_VIDEO) {
471             av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in MP3.\n");
472             return AVERROR(EINVAL);
473         }
474     }
475     if (mp3->audio_stream_idx < 0) {
476         av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
477         return AVERROR(EINVAL);
478     }
479     mp3->pics_to_write = s->nb_streams - 1;
480
481     ff_id3v2_start(&mp3->id3, s->pb, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
482     ret = ff_id3v2_write_metadata(s, &mp3->id3);
483     if (ret < 0)
484         return ret;
485
486     if (!mp3->pics_to_write) {
487         ff_id3v2_finish(&mp3->id3, s->pb);
488         mp3_write_xing(s);
489     }
490
491     return 0;
492 }
493
494 static int mp3_write_trailer(AVFormatContext *s)
495 {
496     MP3Context  *mp3 = s->priv_data;
497     int ret=mp2_write_trailer(s);
498
499     if (ret < 0)
500         return ret;
501
502     if (mp3->frames_offset)
503         mp3_fix_xing(s);
504
505     return 0;
506 }
507
508 AVOutputFormat ff_mp3_muxer = {
509     .name              = "mp3",
510     .long_name         = NULL_IF_CONFIG_SMALL("MP3 (MPEG audio layer 3)"),
511     .mime_type         = "audio/x-mpeg",
512     .extensions        = "mp3",
513     .priv_data_size    = sizeof(MP3Context),
514     .audio_codec       = AV_CODEC_ID_MP3,
515     .video_codec       = AV_CODEC_ID_PNG,
516     .write_header      = mp3_write_header,
517     .write_packet      = mp3_write_packet,
518     .write_trailer     = mp3_write_trailer,
519     .flags             = AVFMT_NOTIMESTAMPS,
520     .priv_class        = &mp3_muxer_class,
521 };
522 #endif