]> git.sesse.net Git - ffmpeg/blobdiff - libavformat/oggparsevorbis.c
imgconvert: Drop outdated comment block
[ffmpeg] / libavformat / oggparsevorbis.c
index a1eb20dea21c40bc969617ceaaf414e1ae364e1b..519a0a7371e662569cc01d9abc9b541d49b5860d 100644 (file)
-/**
     Copyright (C) 2005  Michael Ahlberg, Måns Rullgård
-
     Permission is hereby granted, free of charge, to any person
     obtaining a copy of this software and associated documentation
     files (the "Software"), to deal in the Software without
     restriction, including without limitation the rights to use, copy,
     modify, merge, publish, distribute, sublicense, and/or sell copies
     of the Software, and to permit persons to whom the Software is
     furnished to do so, subject to the following conditions:
-
     The above copyright notice and this permission notice shall be
     included in all copies or substantial portions of the Software.
-
     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
     HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
     DEALINGS IN THE SOFTWARE.
-**/
+/*
* Copyright (C) 2005  Michael Ahlberg, Måns Rullgård
+ *
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
+ *
*  The above copyright notice and this permission notice shall be
*  included in all copies or substantial portions of the Software.
+ *
*  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
*  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
*  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
*  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
*  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
*  DEALINGS IN THE SOFTWARE.
+ */
 
 #include <stdlib.h>
+
 #include "libavutil/avstring.h"
+#include "libavutil/base64.h"
 #include "libavutil/bswap.h"
-#include "libavcodec/bitstream.h"
+#include "libavutil/dict.h"
 #include "libavcodec/bytestream.h"
+#include "libavcodec/get_bits.h"
+#include "libavcodec/vorbis_parser.h"
 #include "avformat.h"
+#include "flac_picture.h"
+#include "internal.h"
 #include "oggdec.h"
+#include "vorbiscomment.h"
+#include "replaygain.h"
 
-int
-vorbis_comment(AVFormatContext * as, uint8_t *buf, int size)
+static int ogm_chapter(AVFormatContext *as, uint8_t *key, uint8_t *val)
 {
-    const uint8_t *p = buf;
+    int i, cnum, h, m, s, ms, keylen = strlen(key);
+    AVChapter *chapter = NULL;
+
+    if (keylen < 9 || sscanf(key, "CHAPTER%03d", &cnum) != 1)
+        return 0;
+
+    if (keylen <= 10) {
+        if (sscanf(val, "%02d:%02d:%02d.%03d", &h, &m, &s, &ms) < 4)
+            return 0;
+
+        avpriv_new_chapter(as, cnum, (AVRational) { 1, 1000 },
+                           ms + 1000 * (s + 60 * (m + 60 * h)),
+                           AV_NOPTS_VALUE, NULL);
+        av_free(val);
+    } else if (!strcmp(key + keylen - 4, "NAME")) {
+        for (i = 0; i < as->nb_chapters; i++)
+            if (as->chapters[i]->id == cnum) {
+                chapter = as->chapters[i];
+                break;
+            }
+        if (!chapter)
+            return 0;
+
+        av_dict_set(&chapter->metadata, "title", val, AV_DICT_DONT_STRDUP_VAL);
+    } else
+        return 0;
+
+    av_free(key);
+    return 1;
+}
+
+int ff_vorbis_stream_comment(AVFormatContext *as, AVStream *st,
+                             const uint8_t *buf, int size)
+{
+    int updates = ff_vorbis_comment(as, &st->metadata, buf, size, 1);
+
+    if (updates > 0) {
+        st->event_flags |= AVSTREAM_EVENT_FLAG_METADATA_UPDATED;
+    }
+
+    return updates;
+}
+
+int ff_vorbis_comment(AVFormatContext *as, AVDictionary **m,
+                      const uint8_t *buf, int size,
+                      int parse_picture)
+{
+    const uint8_t *p   = buf;
     const uint8_t *end = buf + size;
-    unsigned s, n, j;
+    int updates        = 0;
+    unsigned n, j;
+    int s;
 
-    if (size < 8) /* must have vendor_length and user_comment_list_length */
-        return -1;
+    /* must have vendor_length and user_comment_list_length */
+    if (size < 8)
+        return AVERROR_INVALIDDATA;
 
     s = bytestream_get_le32(&p);
 
-    if (end - p < s)
-        return -1;
+    if (end - p - 4 < s || s < 0)
+        return AVERROR_INVALIDDATA;
 
     p += s;
 
     n = bytestream_get_le32(&p);
 
-    while (p < end && n > 0) {
+    while (end - p >= 4 && n > 0) {
         const char *t, *v;
         int tl, vl;
 
         s = bytestream_get_le32(&p);
 
-        if (end - p < s)
+        if (end - p < s || s < 0)
             break;
 
-        t = p;
+        t  = p;
         p += s;
         n--;
 
@@ -71,45 +128,71 @@ vorbis_comment(AVFormatContext * as, uint8_t *buf, int size)
         v++;
 
         if (tl && vl) {
-            char tt[tl + 1];
-            char ct[vl + 1];
+            char *tt, *ct;
+
+            tt = av_malloc(tl + 1);
+            ct = av_malloc(vl + 1);
+            if (!tt || !ct) {
+                av_freep(&tt);
+                av_freep(&ct);
+                return AVERROR(ENOMEM);
+            }
 
             for (j = 0; j < tl; j++)
-                tt[j] = toupper(t[j]);
+                tt[j] = av_toupper(t[j]);
             tt[tl] = 0;
 
             memcpy(ct, v, vl);
             ct[vl] = 0;
 
-            // took from Vorbis_I_spec
-            if (!strcmp(tt, "AUTHOR") || !strcmp(tt, "ARTIST"))
-                av_strlcpy(as->author, ct, sizeof(as->author));
-            else if (!strcmp(tt, "TITLE"))
-                av_strlcpy(as->title, ct, sizeof(as->title));
-            else if (!strcmp(tt, "COPYRIGHT"))
-                av_strlcpy(as->copyright, ct, sizeof(as->copyright));
-            else if (!strcmp(tt, "DESCRIPTION"))
-                av_strlcpy(as->comment, ct, sizeof(as->comment));
-            else if (!strcmp(tt, "GENRE"))
-                av_strlcpy(as->genre, ct, sizeof(as->genre));
-            else if (!strcmp(tt, "TRACKNUMBER"))
-                as->track = atoi(ct);
-            else if (!strcmp(tt, "ALBUM"))
-                av_strlcpy(as->album, ct, sizeof(as->album));
+            /* The format in which the pictures are stored is the FLAC format.
+             * Xiph says: "The binary FLAC picture structure is base64 encoded
+             * and placed within a VorbisComment with the tag name
+             * 'METADATA_BLOCK_PICTURE'. This is the preferred and
+             * recommended way of embedding cover art within VorbisComments."
+             */
+            if (!strcmp(tt, "METADATA_BLOCK_PICTURE") && parse_picture) {
+                int ret;
+                char *pict = av_malloc(vl);
+
+                if (!pict) {
+                    av_freep(&tt);
+                    av_freep(&ct);
+                    return AVERROR(ENOMEM);
+                }
+                if ((ret = av_base64_decode(pict, ct, vl)) > 0)
+                    ret = ff_flac_parse_picture(as, pict, ret);
+                av_freep(&tt);
+                av_freep(&ct);
+                av_freep(&pict);
+                if (ret < 0) {
+                    av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
+                    continue;
+                }
+            } else if (!ogm_chapter(as, tt, ct)) {
+                updates++;
+                av_dict_set(m, tt, ct,
+                            AV_DICT_DONT_STRDUP_KEY |
+                            AV_DICT_DONT_STRDUP_VAL);
+            }
         }
     }
 
     if (p != end)
-        av_log(as, AV_LOG_INFO, "%ti bytes of comment header remain\n", p-end);
+        av_log(as, AV_LOG_INFO,
+               "%ti bytes of comment header remain\n", end - p);
     if (n > 0)
         av_log(as, AV_LOG_INFO,
                "truncated comment header, %i comments not found\n", n);
 
-    return 0;
-}
+    ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
 
+    return updates;
+}
 
-/** Parse the vorbis header
+/*
+ * Parse the vorbis header
+ *
  * Vorbis Identification header from Vorbis_I_spec.html#vorbis-spec-codec
  * [vorbis_version] = read 32 bits as unsigned integer | Not used
  * [audio_channels] = read 8 bit integer as unsigned | Used
@@ -120,107 +203,238 @@ vorbis_comment(AVFormatContext * as, uint8_t *buf, int size)
  * [blocksize_0] = read 4 bits as unsigned integer | Not Used
  * [blocksize_1] = read 4 bits as unsigned integer | Not Used
  * [framing_flag] = read one bit | Not Used
- *    */
+ */
 
 struct oggvorbis_private {
     unsigned int len[3];
     unsigned char *packet[3];
+    AVVorbisParseContext *vp;
+    int64_t final_pts;
+    int final_duration;
 };
 
-
-static unsigned int
-fixup_vorbis_headers(AVFormatContext * as, struct oggvorbis_private *priv,
-                     uint8_t **buf)
+static int fixup_vorbis_headers(AVFormatContext *as,
+                                struct oggvorbis_private *priv,
+                                uint8_t **buf)
 {
-    int i,offset, len;
+    int i, offset, len, err;
     unsigned char *ptr;
 
     len = priv->len[0] + priv->len[1] + priv->len[2];
-    ptr = *buf = av_mallocz(len + len/255 + 64);
+    ptr = *buf = av_mallocz(len + len / 255 + 64);
+    if (!ptr)
+        return AVERROR(ENOMEM);
 
-    ptr[0] = 2;
-    offset = 1;
+    ptr[0]  = 2;
+    offset  = 1;
     offset += av_xiphlacing(&ptr[offset], priv->len[0]);
     offset += av_xiphlacing(&ptr[offset], priv->len[1]);
     for (i = 0; i < 3; i++) {
         memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
         offset += priv->len[i];
+        av_freep(&priv->packet[i]);
     }
-    *buf = av_realloc(*buf, offset + FF_INPUT_BUFFER_PADDING_SIZE);
+    if ((err = av_reallocp(buf, offset + AV_INPUT_BUFFER_PADDING_SIZE)) < 0)
+        return err;
     return offset;
 }
 
+static void vorbis_cleanup(AVFormatContext *s, int idx)
+{
+    struct ogg *ogg = s->priv_data;
+    struct ogg_stream *os = ogg->streams + idx;
+    struct oggvorbis_private *priv = os->private;
+    int i;
+    if (os->private) {
+        av_vorbis_parse_free(&priv->vp);
+        for (i = 0; i < 3; i++)
+            av_freep(&priv->packet[i]);
+    }
+}
 
-static int
-vorbis_header (AVFormatContext * s, int idx)
+static int vorbis_header(AVFormatContext *s, int idx)
 {
     struct ogg *ogg = s->priv_data;
+    AVStream *st    = s->streams[idx];
     struct ogg_stream *os = ogg->streams + idx;
-    AVStream *st = s->streams[idx];
     struct oggvorbis_private *priv;
+    int pkt_type = os->buf[os->pstart];
 
-    if (os->seq > 2)
-        return 0;
-
-    if (os->seq == 0) {
+    if (!os->private) {
         os->private = av_mallocz(sizeof(struct oggvorbis_private));
         if (!os->private)
-            return 0;
+            return AVERROR(ENOMEM);
     }
 
-    if (os->psize < 1)
-        return -1;
+    if (!(pkt_type & 1))
+        return 0;
+
+    if (os->psize < 1 || pkt_type > 5)
+        return AVERROR_INVALIDDATA;
 
     priv = os->private;
-    priv->len[os->seq] = os->psize;
-    priv->packet[os->seq] = av_mallocz(os->psize);
-    memcpy(priv->packet[os->seq], os->buf + os->pstart, os->psize);
+
+    if (priv->packet[pkt_type >> 1])
+        return AVERROR_INVALIDDATA;
+    if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
+        return AVERROR_INVALIDDATA;
+
+    priv->len[pkt_type >> 1]    = os->psize;
+    priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
+    if (!priv->packet[pkt_type >> 1])
+        return AVERROR(ENOMEM);
+    memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
     if (os->buf[os->pstart] == 1) {
         const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
         unsigned blocksize, bs0, bs1;
+        int srate;
 
         if (os->psize != 30)
-            return -1;
+            return AVERROR_INVALIDDATA;
 
         if (bytestream_get_le32(&p) != 0) /* vorbis_version */
-            return -1;
+            return AVERROR_INVALIDDATA;
 
         st->codec->channels = bytestream_get_byte(&p);
-        st->codec->sample_rate = bytestream_get_le32(&p);
+        srate               = bytestream_get_le32(&p);
         p += 4; // skip maximum bitrate
         st->codec->bit_rate = bytestream_get_le32(&p); // nominal bitrate
         p += 4; // skip minimum bitrate
 
         blocksize = bytestream_get_byte(&p);
-        bs0 = blocksize & 15;
-        bs1 = blocksize >> 4;
+        bs0       = blocksize & 15;
+        bs1       = blocksize >> 4;
 
         if (bs0 > bs1)
-            return -1;
+            return AVERROR_INVALIDDATA;
         if (bs0 < 6 || bs1 > 13)
-            return -1;
+            return AVERROR_INVALIDDATA;
 
         if (bytestream_get_byte(&p) != 1) /* framing_flag */
-            return -1;
+            return AVERROR_INVALIDDATA;
 
-        st->codec->codec_type = CODEC_TYPE_AUDIO;
-        st->codec->codec_id CODEC_ID_VORBIS;
+        st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
+        st->codec->codec_id   = AV_CODEC_ID_VORBIS;
 
-        st->time_base.num = 1;
-        st->time_base.den = st->codec->sample_rate;
+        if (srate > 0) {
+            st->codec->sample_rate = srate;
+            avpriv_set_pts_info(st, 64, 1, srate);
+        }
     } else if (os->buf[os->pstart] == 3) {
-        if (os->psize > 8)
-            vorbis_comment (s, os->buf + os->pstart + 7, os->psize - 8);
+        if (os->psize > 8 &&
+            ff_vorbis_stream_comment(s, st, os->buf + os->pstart + 7,
+                                     os->psize - 8) >= 0) {
+            unsigned new_len;
+
+            int ret = ff_replaygain_export(st, st->metadata);
+            if (ret < 0)
+                return ret;
+
+            // drop all metadata we parsed and which is not required by libvorbis
+            new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
+            if (new_len >= 16 && new_len < os->psize) {
+                AV_WL32(priv->packet[1] + new_len - 5, 0);
+                priv->packet[1][new_len - 1] = 1;
+                priv->len[1]                 = new_len;
+            }
+        }
     } else {
-        st->codec->extradata_size =
-            fixup_vorbis_headers(s, priv, &st->codec->extradata);
+        int ret = fixup_vorbis_headers(s, priv, &st->codec->extradata);
+        if (ret < 0) {
+            st->codec->extradata_size = 0;
+            return ret;
+        }
+        st->codec->extradata_size = ret;
+
+        priv->vp = av_vorbis_parse_init(st->codec->extradata, st->codec->extradata_size);
+        if (!priv->vp) {
+            av_freep(&st->codec->extradata);
+            st->codec->extradata_size = 0;
+            return ret;
+        }
     }
 
-    return os->seq < 3;
+    return 1;
+}
+
+static int vorbis_packet(AVFormatContext *s, int idx)
+{
+    struct ogg *ogg = s->priv_data;
+    struct ogg_stream *os = ogg->streams + idx;
+    struct oggvorbis_private *priv = os->private;
+    int duration;
+
+    if (!priv->vp)
+        return AVERROR_INVALIDDATA;
+
+    /* first packet handling
+     * here we parse the duration of each packet in the first page and compare
+     * the total duration to the page granule to find the encoder delay and
+     * set the first timestamp */
+    if (!os->lastpts) {
+        int seg;
+        uint8_t *last_pkt  = os->buf + os->pstart;
+        uint8_t *next_pkt  = last_pkt;
+        int first_duration = 0;
+
+        av_vorbis_parse_reset(priv->vp);
+        duration = 0;
+        for (seg = 0; seg < os->nsegs; seg++) {
+            if (os->segments[seg] < 255) {
+                int d = av_vorbis_parse_frame(priv->vp, last_pkt, 1);
+                if (d < 0) {
+                    duration = os->granule;
+                    break;
+                }
+                if (!duration)
+                    first_duration = d;
+                duration += d;
+                last_pkt  = next_pkt + os->segments[seg];
+            }
+            next_pkt += os->segments[seg];
+        }
+        os->lastpts                 =
+        os->lastdts                 = os->granule - duration;
+        s->streams[idx]->start_time = os->lastpts + first_duration;
+        if (s->streams[idx]->duration)
+            s->streams[idx]->duration -= s->streams[idx]->start_time;
+        s->streams[idx]->cur_dts = AV_NOPTS_VALUE;
+        priv->final_pts          = AV_NOPTS_VALUE;
+        av_vorbis_parse_reset(priv->vp);
+    }
+
+    /* parse packet duration */
+    if (os->psize > 0) {
+        duration = av_vorbis_parse_frame(priv->vp, os->buf + os->pstart, 1);
+        if (duration <= 0) {
+            os->pflags |= AV_PKT_FLAG_CORRUPT;
+            return 0;
+        }
+        os->pduration = duration;
+    }
+
+    /* final packet handling
+     * here we save the pts of the first packet in the final page, sum up all
+     * packet durations in the final page except for the last one, and compare
+     * to the page granule to find the duration of the final packet */
+    if (os->flags & OGG_FLAG_EOS) {
+        if (os->lastpts != AV_NOPTS_VALUE) {
+            priv->final_pts      = os->lastpts;
+            priv->final_duration = 0;
+        }
+        if (os->segp == os->nsegs)
+            os->pduration = os->granule - priv->final_pts - priv->final_duration;
+        priv->final_duration += os->pduration;
+    }
+
+    return 0;
 }
 
 const struct ogg_codec ff_vorbis_codec = {
-    .magic = "\001vorbis",
+    .magic     = "\001vorbis",
     .magicsize = 7,
-    .header = vorbis_header
+    .header    = vorbis_header,
+    .packet    = vorbis_packet,
+    .cleanup   = vorbis_cleanup,
+    .nb_header = 3,
 };