ff_end_tag: assert that the start is aligned.
[ffmpeg.git] / libavformat / mp3enc.c
index 1200d0f..cc9f0d0 100644 (file)
@@ -35,6 +35,7 @@
 #include "libavcodec/mpegaudiodecheader.h"
 #include "libavformat/avio_internal.h"
 #include "libavutil/dict.h"
+#include "libavutil/avassert.h"
 
 static int id3v1_set_string(AVFormatContext *s, const char *key,
                             uint8_t *buf, int buf_size)
@@ -78,112 +79,86 @@ static int id3v1_create_tag(AVFormatContext *s, uint8_t *buf)
     return count;
 }
 
-#define VBR_NUM_BAGS 400
-#define VBR_TOC_SIZE 100
+#define XING_NUM_BAGS 400
+#define XING_TOC_SIZE 100
+// maximum size of the xing frame: offset/Xing/flags/frames/size/TOC
+#define XING_MAX_SIZE (32 + 4 + 4 + 4 + 4 + XING_TOC_SIZE)
 
 typedef struct MP3Context {
     const AVClass *class;
+    ID3v2EncContext id3;
     int id3v2_version;
     int write_id3v1;
-    int64_t frames_offset;
+
+    /* xing header */
+    int64_t xing_offset;
     int32_t frames;
     int32_t size;
     uint32_t want;
     uint32_t seen;
     uint32_t pos;
-    uint64_t bag[VBR_NUM_BAGS];
-} MP3Context;
-
-static int mp2_write_trailer(struct AVFormatContext *s)
-{
-    uint8_t buf[ID3v1_TAG_SIZE];
-    MP3Context *mp3 = s->priv_data;
-
-    /* write the id3v1 tag */
-    if (mp3 && mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
-        avio_write(s->pb, buf, ID3v1_TAG_SIZE);
-    }
-
-    /* write number of frames */
-    if (mp3 && mp3->frames_offset) {
-        avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
-        avio_wb32(s->pb, s->streams[0]->nb_frames);
-        avio_seek(s->pb, 0, SEEK_END);
-    }
-
-    avio_flush(s->pb);
-
-    return 0;
-}
-
-#if CONFIG_MP2_MUXER
-AVOutputFormat ff_mp2_muxer = {
-    .name              = "mp2",
-    .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 2"),
-    .mime_type         = "audio/x-mpeg",
-    .extensions        = "mp2,m2a",
-    .audio_codec       = CODEC_ID_MP2,
-    .video_codec       = CODEC_ID_NONE,
-    .write_packet      = ff_raw_write_packet,
-    .write_trailer     = mp2_write_trailer,
-    .flags             = AVFMT_NOTIMESTAMPS,
-};
-#endif
-
-#if CONFIG_MP3_MUXER
+    uint64_t bag[XING_NUM_BAGS];
+    int initial_bitrate;
+    int has_variable_bitrate;
 
-static const AVOption options[] = {
-    { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
-      offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.dbl = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
-    { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
-      offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
-    { NULL },
-};
+    /* index of the audio stream */
+    int audio_stream_idx;
+    /* number of attached pictures we still need to write */
+    int pics_to_write;
 
-static const AVClass mp3_muxer_class = {
-    .class_name     = "MP3 muxer",
-    .item_name      = av_default_item_name,
-    .option         = options,
-    .version        = LIBAVUTIL_VERSION_INT,
-};
+    /* audio packets are queued here until we get all the attached pictures */
+    AVPacketList *queue, *queue_end;
+} MP3Context;
 
-static const int64_t xing_offtbl[2][2] = {{32, 17}, {17,9}};
+static const uint8_t xing_offtbl[2][2] = {{32, 17}, {17, 9}};
 
 /*
  * Write an empty XING header and initialize respective data.
  */
 static int mp3_write_xing(AVFormatContext *s)
 {
-    AVCodecContext   *codec = s->streams[0]->codec;
     MP3Context       *mp3 = s->priv_data;
+    AVCodecContext *codec = s->streams[mp3->audio_stream_idx]->codec;
     int              bitrate_idx;
-    int              best_bitrate_idx;
+    int              best_bitrate_idx = -1;
     int              best_bitrate_error= INT_MAX;
-    int64_t          xing_offset;
-    int32_t          mask, header;
+    int              xing_offset;
+    int32_t          header, mask;
     MPADecodeHeader  c;
-    int              srate_idx, i, channels;
+    int              srate_idx, ver = 0, i, channels;
     int              needed;
+    const char      *vendor = (codec->flags & CODEC_FLAG_BITEXACT) ? "Lavf" : LIBAVFORMAT_IDENT;
 
-    for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++)
-        if (avpriv_mpa_freq_tab[i] == codec->sample_rate) {
-            srate_idx = i;
-            break;
-        }
+    if (!s->pb->seekable)
+        return 0;
+
+    for (i = 0; i < FF_ARRAY_ELEMS(avpriv_mpa_freq_tab); i++) {
+        const uint16_t base_freq = avpriv_mpa_freq_tab[i];
+
+        if      (codec->sample_rate == base_freq)     ver = 0x3; // MPEG 1
+        else if (codec->sample_rate == base_freq / 2) ver = 0x2; // MPEG 2
+        else if (codec->sample_rate == base_freq / 4) ver = 0x0; // MPEG 2.5
+        else continue;
+
+        srate_idx = i;
+        break;
+    }
     if (i == FF_ARRAY_ELEMS(avpriv_mpa_freq_tab)) {
-        av_log(s, AV_LOG_ERROR, "Unsupported sample rate.\n");
+        av_log(s, AV_LOG_WARNING, "Unsupported sample rate, not writing Xing header.\n");
         return -1;
     }
 
     switch (codec->channels) {
     case 1:  channels = MPA_MONO;                                          break;
     case 2:  channels = MPA_STEREO;                                        break;
-    default: av_log(s, AV_LOG_ERROR, "Unsupported number of channels.\n"); return -1;
+    default: av_log(s, AV_LOG_WARNING, "Unsupported number of channels, "
+                    "not writing Xing header.\n");
+             return -1;
     }
 
     /* dummy MPEG audio header */
-    header  =  0xff                                  << 24; // sync
-    header |= (0x7 << 5 | 0x3 << 3 | 0x1 << 1 | 0x1) << 16; // sync/mpeg-1/layer 3/no crc*/
+    header  =  0xffU                                 << 24; // sync
+    header |= (0x7 << 5 | ver << 3 | 0x1 << 1 | 0x1) << 16; // sync/audio-version/layer 3/no crc*/
     header |= (srate_idx << 2) <<  8;
     header |= channels << 6;
 
@@ -196,12 +171,14 @@ static int mp3_write_xing(AVFormatContext *s)
             best_bitrate_idx  = bitrate_idx;
         }
     }
+    av_assert0(best_bitrate_idx >= 0);
 
     for (bitrate_idx= best_bitrate_idx;; bitrate_idx++) {
         if (15 == bitrate_idx)
             return -1;
-
-        avpriv_mpegaudio_decode_header(&c, header | (bitrate_idx << (4+8)));
+        mask = bitrate_idx << (4+8);
+        header |= mask;
+        avpriv_mpegaudio_decode_header(&c, header);
         xing_offset=xing_offtbl[c.lsf == 1][c.nb_channels == 1];
         needed = 4              // header
                + xing_offset
@@ -209,18 +186,22 @@ static int mp3_write_xing(AVFormatContext *s)
                + 4              // frames/size/toc flags
                + 4              // frames
                + 4              // size
-               + VBR_TOC_SIZE;  // toc
+               + XING_TOC_SIZE   // toc
+               + 24
+               ;
 
         if (needed <= c.frame_size)
             break;
+        header &= ~mask;
     }
 
     avio_wb32(s->pb, header);
+
     ffio_fill(s->pb, 0, xing_offset);
-    avio_wb32(s->pb, MKBETAG('X', 'i', 'n', 'g'));
-    avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames/size/toc
+    mp3->xing_offset = avio_tell(s->pb);
+    ffio_wfourcc(s->pb, "Xing");
+    avio_wb32(s->pb, 0x01 | 0x02 | 0x04);  // frames / size / TOC
 
-    mp3->frames_offset = avio_tell(s->pb);
     mp3->size = c.frame_size;
     mp3->want=1;
     mp3->seen=0;
@@ -230,11 +211,16 @@ static int mp3_write_xing(AVFormatContext *s)
     avio_wb32(s->pb, 0);  // size
 
     // toc
-    for (i = 0; i < VBR_TOC_SIZE; ++i)
-        avio_w8(s->pb, (uint8_t)(255 * i / VBR_TOC_SIZE));
+    for (i = 0; i < XING_TOC_SIZE; ++i)
+        avio_w8(s->pb, (uint8_t)(255 * i / XING_TOC_SIZE));
+
+    for (i = 0; i < strlen(vendor); ++i)
+        avio_w8(s->pb, vendor[i]);
+    for (; i < 21; ++i)
+        avio_w8(s->pb, 0);
+    avio_wb24(s->pb, FFMAX(codec->delay - 528 - 1, 0)<<12);
 
     ffio_fill(s->pb, 0, c.frame_size - needed);
-    avio_flush(s->pb);
 
     return 0;
 }
@@ -243,135 +229,290 @@ static int mp3_write_xing(AVFormatContext *s)
  * Add a frame to XING data.
  * Following lame's "VbrTag.c".
  */
-static void mp3_xing_add_frame(AVFormatContext *s, AVPacket *pkt)
+static void mp3_xing_add_frame(MP3Context *mp3, AVPacket *pkt)
 {
-    MP3Context  *mp3 = s->priv_data;
     int i;
 
-    ++mp3->frames;
+    mp3->frames++;
+    mp3->seen++;
     mp3->size += pkt->size;
 
-    if (mp3->want == ++mp3->seen) {
+    if (mp3->want == mp3->seen) {
         mp3->bag[mp3->pos] = mp3->size;
 
-        if (VBR_NUM_BAGS == ++mp3->pos) {
+        if (XING_NUM_BAGS == ++mp3->pos) {
             /* shrink table to half size by throwing away each second bag. */
-            for (i = 1; i < VBR_NUM_BAGS; i += 2)
+            for (i = 1; i < XING_NUM_BAGS; i += 2)
                 mp3->bag[i >> 1] = mp3->bag[i];
 
             /* double wanted amount per bag. */
-            mp3->want <<= 1;
+            mp3->want *= 2;
             /* adjust current position to half of table size. */
-            mp3->pos >>= 1;
+            mp3->pos = XING_NUM_BAGS / 2;
         }
 
         mp3->seen = 0;
     }
 }
 
-static void mp3_fix_xing(AVFormatContext *s)
+static int mp3_write_audio_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    MP3Context  *mp3 = s->priv_data;
+
+    if (pkt->data && pkt->size >= 4) {
+        MPADecodeHeader c;
+        int av_unused base;
+        uint32_t head = AV_RB32(pkt->data);
+
+        if (ff_mpa_check_header(head) < 0) {
+            av_log(s, AV_LOG_WARNING, "Audio packet of size %d (starting with %08X...) "
+                   "is invalid, writing it anyway.\n", pkt->size, head);
+            return ff_raw_write_packet(s, pkt);
+        }
+        avpriv_mpegaudio_decode_header(&c, head);
+
+        if (!mp3->initial_bitrate)
+            mp3->initial_bitrate = c.bit_rate;
+        if ((c.bit_rate == 0) || (mp3->initial_bitrate != c.bit_rate))
+            mp3->has_variable_bitrate = 1;
+
+#ifdef FILTER_VBR_HEADERS
+        /* filter out XING and INFO headers. */
+        base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
+
+        if (base + 4 <= pkt->size) {
+            uint32_t v = AV_RB32(pkt->data + base);
+
+            if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
+                return 0;
+        }
+
+        /* filter out VBRI headers. */
+        base = 4 + 32;
+
+        if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
+            return 0;
+#endif
+
+        if (mp3->xing_offset)
+            mp3_xing_add_frame(mp3, pkt);
+    }
+
+    return ff_raw_write_packet(s, pkt);
+}
+
+static int mp3_queue_flush(AVFormatContext *s)
+{
+    MP3Context *mp3 = s->priv_data;
+    AVPacketList *pktl;
+    int ret = 0, write = 1;
+
+    ff_id3v2_finish(&mp3->id3, s->pb);
+    mp3_write_xing(s);
+
+    while ((pktl = mp3->queue)) {
+        if (write && (ret = mp3_write_audio_packet(s, &pktl->pkt)) < 0)
+            write = 0;
+        av_free_packet(&pktl->pkt);
+        mp3->queue = pktl->next;
+        av_freep(&pktl);
+    }
+    mp3->queue_end = NULL;
+    return ret;
+}
+
+static void mp3_update_xing(AVFormatContext *s)
 {
     MP3Context  *mp3 = s->priv_data;
     int i;
 
-    avio_flush(s->pb);
-    avio_seek(s->pb, mp3->frames_offset, SEEK_SET);
+    /* replace "Xing" identification string with "Info" for CBR files. */
+    if (!mp3->has_variable_bitrate) {
+        avio_seek(s->pb, mp3->xing_offset, SEEK_SET);
+        ffio_wfourcc(s->pb, "Info");
+    }
+
+    avio_seek(s->pb, mp3->xing_offset + 8, SEEK_SET);
     avio_wb32(s->pb, mp3->frames);
     avio_wb32(s->pb, mp3->size);
 
     avio_w8(s->pb, 0);  // first toc entry has to be zero.
 
-    for (i = 1; i < VBR_TOC_SIZE; ++i) {
-        int j = i * mp3->pos / VBR_TOC_SIZE;
+    for (i = 1; i < XING_TOC_SIZE; ++i) {
+        int j = i * mp3->pos / XING_TOC_SIZE;
         int seek_point = 256LL * mp3->bag[j] / mp3->size;
         avio_w8(s->pb, FFMIN(seek_point, 255));
     }
 
-    avio_flush(s->pb);
     avio_seek(s->pb, 0, SEEK_END);
 }
 
-/**
- * Write an ID3v2 header at beginning of stream
- */
-
-static int mp3_write_header(struct AVFormatContext *s)
+static int mp3_write_trailer(struct AVFormatContext *s)
 {
-    MP3Context  *mp3 = s->priv_data;
-    int ret;
+    uint8_t buf[ID3v1_TAG_SIZE];
+    MP3Context *mp3 = s->priv_data;
 
-    ret = ff_id3v2_write(s, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
-    if (ret < 0)
-        return ret;
+    if (mp3->pics_to_write) {
+        av_log(s, AV_LOG_WARNING, "No packets were sent for some of the "
+               "attached pictures.\n");
+        mp3_queue_flush(s);
+    }
 
-    if (s->pb->seekable)
-        mp3_write_xing(s);
+    /* write the id3v1 tag */
+    if (mp3->write_id3v1 && id3v1_create_tag(s, buf) > 0) {
+        avio_write(s->pb, buf, ID3v1_TAG_SIZE);
+    }
+
+    if (mp3->xing_offset)
+        mp3_update_xing(s);
 
     return 0;
 }
 
-static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
+static int query_codec(enum AVCodecID id, int std_compliance)
 {
-    if (! pkt || ! pkt->data || pkt->size < 4)
-        return ff_raw_write_packet(s, pkt);
-    else {
-        MP3Context  *mp3 = s->priv_data;
-#ifdef FILTER_VBR_HEADERS
-        MPADecodeHeader c;
-        int base;
+    const CodecMime *cm= ff_id3v2_mime_tags;
+    while(cm->id != AV_CODEC_ID_NONE) {
+        if(id == cm->id)
+            return MKTAG('A', 'P', 'I', 'C');
+        cm++;
+    }
+    return -1;
+}
 
-        ff_mpegaudio_decode_header(&c, AV_RB32(pkt->data));
+#if CONFIG_MP2_MUXER
+AVOutputFormat ff_mp2_muxer = {
+    .name              = "mp2",
+    .long_name         = NULL_IF_CONFIG_SMALL("MP2 (MPEG audio layer 2)"),
+    .mime_type         = "audio/x-mpeg",
+    .extensions        = "mp2,m2a",
+    .audio_codec       = AV_CODEC_ID_MP2,
+    .video_codec       = AV_CODEC_ID_NONE,
+    .write_packet      = ff_raw_write_packet,
+    .flags             = AVFMT_NOTIMESTAMPS,
+};
+#endif
 
-        /* filter out XING and INFO headers. */
-        base = 4 + xing_offtbl[c.lsf == 1][c.nb_channels == 1];
+#if CONFIG_MP3_MUXER
 
-        if (base + 4 <= pkt->size) {
-            uint32_t v = AV_RB32(pkt->data + base);
+static const AVOption options[] = {
+    { "id3v2_version", "Select ID3v2 version to write. Currently 3 and 4 are supported.",
+      offsetof(MP3Context, id3v2_version), AV_OPT_TYPE_INT, {.i64 = 4}, 3, 4, AV_OPT_FLAG_ENCODING_PARAM},
+    { "write_id3v1", "Enable ID3v1 writing. ID3v1 tags are written in UTF-8 which may not be supported by most software.",
+      offsetof(MP3Context, write_id3v1), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, AV_OPT_FLAG_ENCODING_PARAM},
+    { NULL },
+};
 
-            if (MKBETAG('X','i','n','g') == v || MKBETAG('I','n','f','o') == v)
-                return 0;
-        }
+static const AVClass mp3_muxer_class = {
+    .class_name     = "MP3 muxer",
+    .item_name      = av_default_item_name,
+    .option         = options,
+    .version        = LIBAVUTIL_VERSION_INT,
+};
 
-        /* filter out VBRI headers. */
-        base = 4 + 32;
+static int mp3_write_packet(AVFormatContext *s, AVPacket *pkt)
+{
+    MP3Context *mp3 = s->priv_data;
 
-        if (base + 4 <= pkt->size && MKBETAG('V','B','R','I') == AV_RB32(pkt->data + base))
+    if (pkt->stream_index == mp3->audio_stream_idx) {
+        if (mp3->pics_to_write) {
+            /* buffer audio packets until we get all the pictures */
+            AVPacketList *pktl = av_mallocz(sizeof(*pktl));
+            if (!pktl)
+                return AVERROR(ENOMEM);
+
+            pktl->pkt     = *pkt;
+            pkt->destruct = NULL;
+
+            if (mp3->queue_end)
+                mp3->queue_end->next = pktl;
+            else
+                mp3->queue = pktl;
+            mp3->queue_end = pktl;
+        } else
+            return mp3_write_audio_packet(s, pkt);
+    } else {
+        int ret;
+
+        /* warn only once for each stream */
+        if (s->streams[pkt->stream_index]->nb_frames == 1) {
+            av_log(s, AV_LOG_WARNING, "Got more than one picture in stream %d,"
+                   " ignoring.\n", pkt->stream_index);
+        }
+        if (!mp3->pics_to_write || s->streams[pkt->stream_index]->nb_frames >= 1)
             return 0;
-#endif
 
-        if (mp3->frames_offset)
-            mp3_xing_add_frame(s, pkt);
+        if ((ret = ff_id3v2_write_apic(s, &mp3->id3, pkt)) < 0)
+            return ret;
+        mp3->pics_to_write--;
 
-        return ff_raw_write_packet(s, pkt);
+        /* flush the buffered audio packets */
+        if (!mp3->pics_to_write &&
+            (ret = mp3_queue_flush(s)) < 0)
+            return ret;
     }
+
+    return 0;
 }
 
-static int mp3_write_trailer(AVFormatContext *s)
+/**
+ * Write an ID3v2 header at beginning of stream
+ */
+
+static int mp3_write_header(struct AVFormatContext *s)
 {
     MP3Context  *mp3 = s->priv_data;
-    int ret=mp2_write_trailer(s);
+    int ret, i;
+
+    /* check the streams -- we want exactly one audio and arbitrary number of
+     * video (attached pictures) */
+    mp3->audio_stream_idx = -1;
+    for (i = 0; i < s->nb_streams; i++) {
+        AVStream *st = s->streams[i];
+        if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
+            if (mp3->audio_stream_idx >= 0 || st->codec->codec_id != AV_CODEC_ID_MP3) {
+                av_log(s, AV_LOG_ERROR, "Invalid audio stream. Exactly one MP3 "
+                       "audio stream is required.\n");
+                return AVERROR(EINVAL);
+            }
+            mp3->audio_stream_idx = i;
+        } else if (st->codec->codec_type != AVMEDIA_TYPE_VIDEO) {
+            av_log(s, AV_LOG_ERROR, "Only audio streams and pictures are allowed in MP3.\n");
+            return AVERROR(EINVAL);
+        }
+    }
+    if (mp3->audio_stream_idx < 0) {
+        av_log(s, AV_LOG_ERROR, "No audio stream present.\n");
+        return AVERROR(EINVAL);
+    }
+    mp3->pics_to_write = s->nb_streams - 1;
 
+    ff_id3v2_start(&mp3->id3, s->pb, mp3->id3v2_version, ID3v2_DEFAULT_MAGIC);
+    ret = ff_id3v2_write_metadata(s, &mp3->id3);
     if (ret < 0)
         return ret;
 
-    if (mp3->frames_offset)
-        mp3_fix_xing(s);
+    if (!mp3->pics_to_write) {
+        ff_id3v2_finish(&mp3->id3, s->pb);
+        mp3_write_xing(s);
+    }
 
     return 0;
 }
 
 AVOutputFormat ff_mp3_muxer = {
     .name              = "mp3",
-    .long_name         = NULL_IF_CONFIG_SMALL("MPEG audio layer 3"),
+    .long_name         = NULL_IF_CONFIG_SMALL("MP3 (MPEG audio layer 3)"),
     .mime_type         = "audio/x-mpeg",
     .extensions        = "mp3",
     .priv_data_size    = sizeof(MP3Context),
-    .audio_codec       = CODEC_ID_MP3,
-    .video_codec       = CODEC_ID_NONE,
+    .audio_codec       = AV_CODEC_ID_MP3,
+    .video_codec       = AV_CODEC_ID_PNG,
     .write_header      = mp3_write_header,
     .write_packet      = mp3_write_packet,
     .write_trailer     = mp3_write_trailer,
+    .query_codec       = query_codec,
     .flags             = AVFMT_NOTIMESTAMPS,
-    .priv_class = &mp3_muxer_class,
+    .priv_class        = &mp3_muxer_class,
 };
 #endif