libavformat/oggparsevorbis.c

   1 /*
   2  * Copyright (C) 2005  Michael Ahlberg, Måns Rullgård
   3  *
   4  * Permission is hereby granted, free of charge, to any person
   5  * obtaining a copy of this software and associated documentation
   6  * files (the "Software"), to deal in the Software without
   7  * restriction, including without limitation the rights to use, copy,
   8  * modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  *  The above copyright notice and this permission notice shall be
  13  *  included in all copies or substantial portions of the Software.
  14  *
  15  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  19  *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  20  *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  *  DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #include <stdlib.h>
  26
  27 #include "libavutil/avstring.h"
  28 #include "libavutil/base64.h"
  29 #include "libavutil/bswap.h"
  30 #include "libavutil/dict.h"
  31 #include "libavcodec/bytestream.h"
  32 #include "libavcodec/get_bits.h"
  33 #include "libavcodec/vorbis_parser.h"
  34 #include "avformat.h"
  35 #include "flac_picture.h"
  36 #include "internal.h"
  37 #include "oggdec.h"
  38 #include "vorbiscomment.h"
  39 #include "replaygain.h"
  40
  41 static int ogm_chapter(AVFormatContext *as, uint8_t *key, uint8_t *val)
  42 {
  43     int i, cnum, h, m, s, ms, keylen = strlen(key);
  44     AVChapter *chapter = NULL;
  45
  46     if (keylen < 9 || sscanf(key, "CHAPTER%03d", &cnum) != 1)
  47         return 0;
  48
  49     if (keylen <= 10) {
  50         if (sscanf(val, "%02d:%02d:%02d.%03d", &h, &m, &s, &ms) < 4)
  51             return 0;
  52
  53         avpriv_new_chapter(as, cnum, (AVRational) { 1, 1000 },
  54                            ms + 1000 * (s + 60 * (m + 60 * h)),
  55                            AV_NOPTS_VALUE, NULL);
  56         av_free(val);
  57     } else if (!strcmp(key + keylen - 4, "NAME")) {
  58         for (i = 0; i < as->nb_chapters; i++)
  59             if (as->chapters[i]->id == cnum) {
  60                 chapter = as->chapters[i];
  61                 break;
  62             }
  63         if (!chapter)
  64             return 0;
  65
  66         av_dict_set(&chapter->metadata, "title", val, AV_DICT_DONT_STRDUP_VAL);
  67     } else
  68         return 0;
  69
  70     av_free(key);
  71     return 1;
  72 }
  73
  74 int ff_vorbis_comment(AVFormatContext *as, AVDictionary **m,
  75                       const uint8_t *buf, int size,
  76                       int parse_picture)
  77 {
  78     const uint8_t *p   = buf;
  79     const uint8_t *end = buf + size;
  80     unsigned n, j;
  81     int s;
  82
  83     /* must have vendor_length and user_comment_list_length */
  84     if (size < 8)
  85         return AVERROR_INVALIDDATA;
  86
  87     s = bytestream_get_le32(&p);
  88
  89     if (end - p - 4 < s || s < 0)
  90         return AVERROR_INVALIDDATA;
  91
  92     p += s;
  93
  94     n = bytestream_get_le32(&p);
  95
  96     while (end - p >= 4 && n > 0) {
  97         const char *t, *v;
  98         int tl, vl;
  99
 100         s = bytestream_get_le32(&p);
 101
 102         if (end - p < s || s < 0)
 103             break;
 104
 105         t  = p;
 106         p += s;
 107         n--;
 108
 109         v = memchr(t, '=', s);
 110         if (!v)
 111             continue;
 112
 113         tl = v - t;
 114         vl = s - tl - 1;
 115         v++;
 116
 117         if (tl && vl) {
 118             char *tt, *ct;
 119
 120             tt = av_malloc(tl + 1);
 121             ct = av_malloc(vl + 1);
 122             if (!tt || !ct) {
 123                 av_freep(&tt);
 124                 av_freep(&ct);
 125                 return AVERROR(ENOMEM);
 126             }
 127
 128             for (j = 0; j < tl; j++)
 129                 tt[j] = av_toupper(t[j]);
 130             tt[tl] = 0;
 131
 132             memcpy(ct, v, vl);
 133             ct[vl] = 0;
 134
 135             /* The format in which the pictures are stored is the FLAC format.
 136              * Xiph says: "The binary FLAC picture structure is base64 encoded
 137              * and placed within a VorbisComment with the tag name
 138              * 'METADATA_BLOCK_PICTURE'. This is the preferred and
 139              * recommended way of embedding cover art within VorbisComments."
 140              */
 141             if (!strcmp(tt, "METADATA_BLOCK_PICTURE") && parse_picture) {
 142                 int ret;
 143                 char *pict = av_malloc(vl);
 144
 145                 if (!pict) {
 146                     av_freep(&tt);
 147                     av_freep(&ct);
 148                     return AVERROR(ENOMEM);
 149                 }
 150                 if ((ret = av_base64_decode(pict, ct, vl)) > 0)
 151                     ret = ff_flac_parse_picture(as, pict, ret);
 152                 av_freep(&tt);
 153                 av_freep(&ct);
 154                 av_freep(&pict);
 155                 if (ret < 0) {
 156                     av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
 157                     continue;
 158                 }
 159             } else if (!ogm_chapter(as, tt, ct))
 160                 av_dict_set(m, tt, ct,
 161                             AV_DICT_DONT_STRDUP_KEY |
 162                             AV_DICT_DONT_STRDUP_VAL);
 163         }
 164     }
 165
 166     if (p != end)
 167         av_log(as, AV_LOG_INFO,
 168                "%ti bytes of comment header remain\n", end - p);
 169     if (n > 0)
 170         av_log(as, AV_LOG_INFO,
 171                "truncated comment header, %i comments not found\n", n);
 172
 173     ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
 174
 175     return 0;
 176 }
 177
 178 /*
 179  * Parse the vorbis header
 180  *
 181  * Vorbis Identification header from Vorbis_I_spec.html#vorbis-spec-codec
 182  * [vorbis_version] = read 32 bits as unsigned integer | Not used
 183  * [audio_channels] = read 8 bit integer as unsigned | Used
 184  * [audio_sample_rate] = read 32 bits as unsigned integer | Used
 185  * [bitrate_maximum] = read 32 bits as signed integer | Not used yet
 186  * [bitrate_nominal] = read 32 bits as signed integer | Not used yet
 187  * [bitrate_minimum] = read 32 bits as signed integer | Used as bitrate
 188  * [blocksize_0] = read 4 bits as unsigned integer | Not Used
 189  * [blocksize_1] = read 4 bits as unsigned integer | Not Used
 190  * [framing_flag] = read one bit | Not Used
 191  */
 192
 193 struct oggvorbis_private {
 194     unsigned int len[3];
 195     unsigned char *packet[3];
 196     VorbisParseContext vp;
 197     int64_t final_pts;
 198     int final_duration;
 199 };
 200
 201 static int fixup_vorbis_headers(AVFormatContext *as,
 202                                 struct oggvorbis_private *priv,
 203                                 uint8_t **buf)
 204 {
 205     int i, offset, len, err;
 206     unsigned char *ptr;
 207
 208     len = priv->len[0] + priv->len[1] + priv->len[2];
 209     ptr = *buf = av_mallocz(len + len / 255 + 64);
 210     if (!ptr)
 211         return AVERROR(ENOMEM);
 212
 213     ptr[0]  = 2;
 214     offset  = 1;
 215     offset += av_xiphlacing(&ptr[offset], priv->len[0]);
 216     offset += av_xiphlacing(&ptr[offset], priv->len[1]);
 217     for (i = 0; i < 3; i++) {
 218         memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
 219         offset += priv->len[i];
 220         av_freep(&priv->packet[i]);
 221     }
 222     if ((err = av_reallocp(buf, offset + FF_INPUT_BUFFER_PADDING_SIZE)) < 0)
 223         return err;
 224     return offset;
 225 }
 226
 227 static void vorbis_cleanup(AVFormatContext *s, int idx)
 228 {
 229     struct ogg *ogg = s->priv_data;
 230     struct ogg_stream *os = ogg->streams + idx;
 231     struct oggvorbis_private *priv = os->private;
 232     int i;
 233     if (os->private)
 234         for (i = 0; i < 3; i++)
 235             av_freep(&priv->packet[i]);
 236 }
 237
 238 static int vorbis_header(AVFormatContext *s, int idx)
 239 {
 240     struct ogg *ogg = s->priv_data;
 241     AVStream *st    = s->streams[idx];
 242     struct ogg_stream *os = ogg->streams + idx;
 243     struct oggvorbis_private *priv;
 244     int pkt_type = os->buf[os->pstart];
 245
 246     if (!os->private) {
 247         os->private = av_mallocz(sizeof(struct oggvorbis_private));
 248         if (!os->private)
 249             return AVERROR(ENOMEM);
 250     }
 251
 252     if (!(pkt_type & 1))
 253         return 0;
 254
 255     if (os->psize < 1 || pkt_type > 5)
 256         return AVERROR_INVALIDDATA;
 257
 258     priv = os->private;
 259
 260     if (priv->packet[pkt_type >> 1])
 261         return AVERROR_INVALIDDATA;
 262     if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
 263         return AVERROR_INVALIDDATA;
 264
 265     priv->len[pkt_type >> 1]    = os->psize;
 266     priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
 267     if (!priv->packet[pkt_type >> 1])
 268         return AVERROR(ENOMEM);
 269     memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
 270     if (os->buf[os->pstart] == 1) {
 271         const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
 272         unsigned blocksize, bs0, bs1;
 273         int srate;
 274
 275         if (os->psize != 30)
 276             return AVERROR_INVALIDDATA;
 277
 278         if (bytestream_get_le32(&p) != 0) /* vorbis_version */
 279             return AVERROR_INVALIDDATA;
 280
 281         st->codec->channels = bytestream_get_byte(&p);
 282         srate               = bytestream_get_le32(&p);
 283         p += 4; // skip maximum bitrate
 284         st->codec->bit_rate = bytestream_get_le32(&p); // nominal bitrate
 285         p += 4; // skip minimum bitrate
 286
 287         blocksize = bytestream_get_byte(&p);
 288         bs0       = blocksize & 15;
 289         bs1       = blocksize >> 4;
 290
 291         if (bs0 > bs1)
 292             return AVERROR_INVALIDDATA;
 293         if (bs0 < 6 || bs1 > 13)
 294             return AVERROR_INVALIDDATA;
 295
 296         if (bytestream_get_byte(&p) != 1) /* framing_flag */
 297             return AVERROR_INVALIDDATA;
 298
 299         st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
 300         st->codec->codec_id   = AV_CODEC_ID_VORBIS;
 301
 302         if (srate > 0) {
 303             st->codec->sample_rate = srate;
 304             avpriv_set_pts_info(st, 64, 1, srate);
 305         }
 306     } else if (os->buf[os->pstart] == 3) {
 307         if (os->psize > 8 &&
 308             ff_vorbis_comment(s, &st->metadata, os->buf + os->pstart + 7,
 309                               os->psize - 8, 1) >= 0) {
 310             unsigned new_len;
 311
 312             int ret = ff_replaygain_export(st, st->metadata);
 313             if (ret < 0)
 314                 return ret;
 315
 316             // drop all metadata we parsed and which is not required by libvorbis
 317             new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
 318             if (new_len >= 16 && new_len < os->psize) {
 319                 AV_WL32(priv->packet[1] + new_len - 5, 0);
 320                 priv->packet[1][new_len - 1] = 1;
 321                 priv->len[1]                 = new_len;
 322             }
 323         }
 324     } else {
 325         int ret = fixup_vorbis_headers(s, priv, &st->codec->extradata);
 326         if (ret < 0) {
 327             st->codec->extradata_size = 0;
 328             return ret;
 329         }
 330         st->codec->extradata_size = ret;
 331         if ((ret = avpriv_vorbis_parse_extradata(st->codec, &priv->vp))) {
 332             av_freep(&st->codec->extradata);
 333             st->codec->extradata_size = 0;
 334             return ret;
 335         }
 336     }
 337
 338     return 1;
 339 }
 340
 341 static int vorbis_packet(AVFormatContext *s, int idx)
 342 {
 343     struct ogg *ogg = s->priv_data;
 344     struct ogg_stream *os = ogg->streams + idx;
 345     struct oggvorbis_private *priv = os->private;
 346     int duration;
 347
 348     /* first packet handling
 349      * here we parse the duration of each packet in the first page and compare
 350      * the total duration to the page granule to find the encoder delay and
 351      * set the first timestamp */
 352     if (!os->lastpts) {
 353         int seg;
 354         uint8_t *last_pkt  = os->buf + os->pstart;
 355         uint8_t *next_pkt  = last_pkt;
 356         int first_duration = 0;
 357
 358         avpriv_vorbis_parse_reset(&priv->vp);
 359         duration = 0;
 360         for (seg = 0; seg < os->nsegs; seg++) {
 361             if (os->segments[seg] < 255) {
 362                 int d = avpriv_vorbis_parse_frame(&priv->vp, last_pkt, 1);
 363                 if (d < 0) {
 364                     duration = os->granule;
 365                     break;
 366                 }
 367                 if (!duration)
 368                     first_duration = d;
 369                 duration += d;
 370                 last_pkt  = next_pkt + os->segments[seg];
 371             }
 372             next_pkt += os->segments[seg];
 373         }
 374         os->lastpts                 =
 375         os->lastdts                 = os->granule - duration;
 376         s->streams[idx]->start_time = os->lastpts + first_duration;
 377         if (s->streams[idx]->duration)
 378             s->streams[idx]->duration -= s->streams[idx]->start_time;
 379         s->streams[idx]->cur_dts = AV_NOPTS_VALUE;
 380         priv->final_pts          = AV_NOPTS_VALUE;
 381         avpriv_vorbis_parse_reset(&priv->vp);
 382     }
 383
 384     /* parse packet duration */
 385     if (os->psize > 0) {
 386         duration = avpriv_vorbis_parse_frame(&priv->vp, os->buf + os->pstart, 1);
 387         if (duration <= 0) {
 388             os->pflags |= AV_PKT_FLAG_CORRUPT;
 389             return 0;
 390         }
 391         os->pduration = duration;
 392     }
 393
 394     /* final packet handling
 395      * here we save the pts of the first packet in the final page, sum up all
 396      * packet durations in the final page except for the last one, and compare
 397      * to the page granule to find the duration of the final packet */
 398     if (os->flags & OGG_FLAG_EOS) {
 399         if (os->lastpts != AV_NOPTS_VALUE) {
 400             priv->final_pts      = os->lastpts;
 401             priv->final_duration = 0;
 402         }
 403         if (os->segp == os->nsegs)
 404             os->pduration = os->granule - priv->final_pts - priv->final_duration;
 405         priv->final_duration += os->pduration;
 406     }
 407
 408     return 0;
 409 }
 410
 411 const struct ogg_codec ff_vorbis_codec = {
 412     .magic     = "\001vorbis",
 413     .magicsize = 7,
 414     .header    = vorbis_header,
 415     .packet    = vorbis_packet,
 416     .cleanup   = vorbis_cleanup,
 417     .nb_header = 3,
 418 };