git.sesse.net Git - ffmpeg/blob - 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
  32 #include "libavcodec/bytestream.h"
  33 #include "libavcodec/vorbis_parser.h"
  34
  35 #include "avformat.h"
  36 #include "flac_picture.h"
  37 #include "internal.h"
  38 #include "oggdec.h"
  39 #include "vorbiscomment.h"
  40 #include "replaygain.h"
  41
  42 static int ogm_chapter(AVFormatContext *as, uint8_t *key, uint8_t *val)
  43 {
  44     int i, cnum, h, m, s, ms, keylen = strlen(key);
  45     AVChapter *chapter = NULL;
  46
  47     if (keylen < 9 || sscanf(key, "CHAPTER%03d", &cnum) != 1)
  48         return 0;
  49
  50     if (keylen <= 10) {
  51         if (sscanf(val, "%02d:%02d:%02d.%03d", &h, &m, &s, &ms) < 4)
  52             return 0;
  53
  54         avpriv_new_chapter(as, cnum, (AVRational) { 1, 1000 },
  55                            ms + 1000 * (s + 60 * (m + 60 * h)),
  56                            AV_NOPTS_VALUE, NULL);
  57         av_free(val);
  58     } else if (!strcmp(key + keylen - 4, "NAME")) {
  59         for (i = 0; i < as->nb_chapters; i++)
  60             if (as->chapters[i]->id == cnum) {
  61                 chapter = as->chapters[i];
  62                 break;
  63             }
  64         if (!chapter)
  65             return 0;
  66
  67         av_dict_set(&chapter->metadata, "title", val, AV_DICT_DONT_STRDUP_VAL);
  68     } else
  69         return 0;
  70
  71     av_free(key);
  72     return 1;
  73 }
  74
  75 int ff_vorbis_stream_comment(AVFormatContext *as, AVStream *st,
  76                              const uint8_t *buf, int size)
  77 {
  78     int updates = ff_vorbis_comment(as, &st->metadata, buf, size, 1);
  79
  80     if (updates > 0) {
  81         st->event_flags |= AVSTREAM_EVENT_FLAG_METADATA_UPDATED;
  82     }
  83
  84     return updates;
  85 }
  86
  87 int ff_vorbis_comment(AVFormatContext *as, AVDictionary **m,
  88                       const uint8_t *buf, int size,
  89                       int parse_picture)
  90 {
  91     const uint8_t *p   = buf;
  92     const uint8_t *end = buf + size;
  93     int updates        = 0;
  94     unsigned n, j;
  95     int s;
  96
  97     /* must have vendor_length and user_comment_list_length */
  98     if (size < 8)
  99         return AVERROR_INVALIDDATA;
 100
 101     s = bytestream_get_le32(&p);
 102
 103     if (end - p - 4 < s || s < 0)
 104         return AVERROR_INVALIDDATA;
 105
 106     p += s;
 107
 108     n = bytestream_get_le32(&p);
 109
 110     while (end - p >= 4 && n > 0) {
 111         const char *t, *v;
 112         int tl, vl;
 113
 114         s = bytestream_get_le32(&p);
 115
 116         if (end - p < s || s < 0)
 117             break;
 118
 119         t  = p;
 120         p += s;
 121         n--;
 122
 123         v = memchr(t, '=', s);
 124         if (!v)
 125             continue;
 126
 127         tl = v - t;
 128         vl = s - tl - 1;
 129         v++;
 130
 131         if (tl && vl) {
 132             char *tt, *ct;
 133
 134             tt = av_malloc(tl + 1);
 135             ct = av_malloc(vl + 1);
 136             if (!tt || !ct) {
 137                 av_freep(&tt);
 138                 av_freep(&ct);
 139                 return AVERROR(ENOMEM);
 140             }
 141
 142             for (j = 0; j < tl; j++)
 143                 tt[j] = av_toupper(t[j]);
 144             tt[tl] = 0;
 145
 146             memcpy(ct, v, vl);
 147             ct[vl] = 0;
 148
 149             /* The format in which the pictures are stored is the FLAC format.
 150              * Xiph says: "The binary FLAC picture structure is base64 encoded
 151              * and placed within a VorbisComment with the tag name
 152              * 'METADATA_BLOCK_PICTURE'. This is the preferred and
 153              * recommended way of embedding cover art within VorbisComments."
 154              */
 155             if (!strcmp(tt, "METADATA_BLOCK_PICTURE") && parse_picture) {
 156                 int ret;
 157                 char *pict = av_malloc(vl);
 158
 159                 if (!pict) {
 160                     av_freep(&tt);
 161                     av_freep(&ct);
 162                     return AVERROR(ENOMEM);
 163                 }
 164                 if ((ret = av_base64_decode(pict, ct, vl)) > 0)
 165                     ret = ff_flac_parse_picture(as, pict, ret);
 166                 av_freep(&tt);
 167                 av_freep(&ct);
 168                 av_freep(&pict);
 169                 if (ret < 0) {
 170                     av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
 171                     continue;
 172                 }
 173             } else if (!ogm_chapter(as, tt, ct)) {
 174                 updates++;
 175                 av_dict_set(m, tt, ct,
 176                             AV_DICT_DONT_STRDUP_KEY |
 177                             AV_DICT_DONT_STRDUP_VAL);
 178             }
 179         }
 180     }
 181
 182     if (p != end)
 183         av_log(as, AV_LOG_INFO,
 184                "%ti bytes of comment header remain\n", end - p);
 185     if (n > 0)
 186         av_log(as, AV_LOG_INFO,
 187                "truncated comment header, %i comments not found\n", n);
 188
 189     ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
 190
 191     return updates;
 192 }
 193
 194 /*
 195  * Parse the vorbis header
 196  *
 197  * Vorbis Identification header from Vorbis_I_spec.html#vorbis-spec-codec
 198  * [vorbis_version] = read 32 bits as unsigned integer | Not used
 199  * [audio_channels] = read 8 bit integer as unsigned | Used
 200  * [audio_sample_rate] = read 32 bits as unsigned integer | Used
 201  * [bitrate_maximum] = read 32 bits as signed integer | Not used yet
 202  * [bitrate_nominal] = read 32 bits as signed integer | Not used yet
 203  * [bitrate_minimum] = read 32 bits as signed integer | Used as bitrate
 204  * [blocksize_0] = read 4 bits as unsigned integer | Not Used
 205  * [blocksize_1] = read 4 bits as unsigned integer | Not Used
 206  * [framing_flag] = read one bit | Not Used
 207  */
 208
 209 struct oggvorbis_private {
 210     unsigned int len[3];
 211     unsigned char *packet[3];
 212     AVVorbisParseContext *vp;
 213     int64_t final_pts;
 214     int final_duration;
 215 };
 216
 217 static int fixup_vorbis_headers(AVFormatContext *as,
 218                                 struct oggvorbis_private *priv,
 219                                 uint8_t **buf)
 220 {
 221     int i, offset, len, err;
 222     unsigned char *ptr;
 223
 224     len = priv->len[0] + priv->len[1] + priv->len[2];
 225     ptr = *buf = av_mallocz(len + len / 255 + 64);
 226     if (!ptr)
 227         return AVERROR(ENOMEM);
 228
 229     ptr[0]  = 2;
 230     offset  = 1;
 231     offset += av_xiphlacing(&ptr[offset], priv->len[0]);
 232     offset += av_xiphlacing(&ptr[offset], priv->len[1]);
 233     for (i = 0; i < 3; i++) {
 234         memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
 235         offset += priv->len[i];
 236         av_freep(&priv->packet[i]);
 237     }
 238     if ((err = av_reallocp(buf, offset + AV_INPUT_BUFFER_PADDING_SIZE)) < 0)
 239         return err;
 240     return offset;
 241 }
 242
 243 static void vorbis_cleanup(AVFormatContext *s, int idx)
 244 {
 245     struct ogg *ogg = s->priv_data;
 246     struct ogg_stream *os = ogg->streams + idx;
 247     struct oggvorbis_private *priv = os->private;
 248     int i;
 249     if (os->private) {
 250         av_vorbis_parse_free(&priv->vp);
 251         for (i = 0; i < 3; i++)
 252             av_freep(&priv->packet[i]);
 253     }
 254 }
 255
 256 static int vorbis_header(AVFormatContext *s, int idx)
 257 {
 258     struct ogg *ogg = s->priv_data;
 259     AVStream *st    = s->streams[idx];
 260     struct ogg_stream *os = ogg->streams + idx;
 261     struct oggvorbis_private *priv;
 262     int pkt_type = os->buf[os->pstart];
 263
 264     if (!os->private) {
 265         os->private = av_mallocz(sizeof(struct oggvorbis_private));
 266         if (!os->private)
 267             return AVERROR(ENOMEM);
 268     }
 269
 270     if (!(pkt_type & 1))
 271         return 0;
 272
 273     if (os->psize < 1 || pkt_type > 5)
 274         return AVERROR_INVALIDDATA;
 275
 276     priv = os->private;
 277
 278     if (priv->packet[pkt_type >> 1])
 279         return AVERROR_INVALIDDATA;
 280     if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
 281         return AVERROR_INVALIDDATA;
 282
 283     priv->len[pkt_type >> 1]    = os->psize;
 284     priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
 285     if (!priv->packet[pkt_type >> 1])
 286         return AVERROR(ENOMEM);
 287     memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
 288     if (os->buf[os->pstart] == 1) {
 289         const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
 290         unsigned blocksize, bs0, bs1;
 291         int srate;
 292
 293         if (os->psize != 30)
 294             return AVERROR_INVALIDDATA;
 295
 296         if (bytestream_get_le32(&p) != 0) /* vorbis_version */
 297             return AVERROR_INVALIDDATA;
 298
 299         st->codecpar->channels = bytestream_get_byte(&p);
 300         srate               = bytestream_get_le32(&p);
 301         p += 4; // skip maximum bitrate
 302         st->codecpar->bit_rate = bytestream_get_le32(&p); // nominal bitrate
 303         p += 4; // skip minimum bitrate
 304
 305         blocksize = bytestream_get_byte(&p);
 306         bs0       = blocksize & 15;
 307         bs1       = blocksize >> 4;
 308
 309         if (bs0 > bs1)
 310             return AVERROR_INVALIDDATA;
 311         if (bs0 < 6 || bs1 > 13)
 312             return AVERROR_INVALIDDATA;
 313
 314         if (bytestream_get_byte(&p) != 1) /* framing_flag */
 315             return AVERROR_INVALIDDATA;
 316
 317         st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
 318         st->codecpar->codec_id   = AV_CODEC_ID_VORBIS;
 319
 320         if (srate > 0) {
 321             st->codecpar->sample_rate = srate;
 322             avpriv_set_pts_info(st, 64, 1, srate);
 323         }
 324     } else if (os->buf[os->pstart] == 3) {
 325         if (os->psize > 8 &&
 326             ff_vorbis_stream_comment(s, st, os->buf + os->pstart + 7,
 327                                      os->psize - 8) >= 0) {
 328             unsigned new_len;
 329
 330             int ret = ff_replaygain_export(st, st->metadata);
 331             if (ret < 0)
 332                 return ret;
 333
 334             // drop all metadata we parsed and which is not required by libvorbis
 335             new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
 336             if (new_len >= 16 && new_len < os->psize) {
 337                 AV_WL32(priv->packet[1] + new_len - 5, 0);
 338                 priv->packet[1][new_len - 1] = 1;
 339                 priv->len[1]                 = new_len;
 340             }
 341         }
 342     } else {
 343         int ret = fixup_vorbis_headers(s, priv, &st->codecpar->extradata);
 344         if (ret < 0) {
 345             st->codecpar->extradata_size = 0;
 346             return ret;
 347         }
 348         st->codecpar->extradata_size = ret;
 349
 350         priv->vp = av_vorbis_parse_init(st->codecpar->extradata, st->codecpar->extradata_size);
 351         if (!priv->vp) {
 352             av_freep(&st->codecpar->extradata);
 353             st->codecpar->extradata_size = 0;
 354             return ret;
 355         }
 356     }
 357
 358     return 1;
 359 }
 360
 361 static int vorbis_packet(AVFormatContext *s, int idx)
 362 {
 363     struct ogg *ogg = s->priv_data;
 364     struct ogg_stream *os = ogg->streams + idx;
 365     struct oggvorbis_private *priv = os->private;
 366     int duration;
 367
 368     if (!priv->vp)
 369         return AVERROR_INVALIDDATA;
 370
 371     /* first packet handling
 372      * here we parse the duration of each packet in the first page and compare
 373      * the total duration to the page granule to find the encoder delay and
 374      * set the first timestamp */
 375     if (!os->lastpts) {
 376         int seg;
 377         uint8_t *last_pkt  = os->buf + os->pstart;
 378         uint8_t *next_pkt  = last_pkt;
 379         int first_duration = 0;
 380
 381         av_vorbis_parse_reset(priv->vp);
 382         duration = 0;
 383         for (seg = 0; seg < os->nsegs; seg++) {
 384             if (os->segments[seg] < 255) {
 385                 int d = av_vorbis_parse_frame(priv->vp, last_pkt, 1);
 386                 if (d < 0) {
 387                     duration = os->granule;
 388                     break;
 389                 }
 390                 if (!duration)
 391                     first_duration = d;
 392                 duration += d;
 393                 last_pkt  = next_pkt + os->segments[seg];
 394             }
 395             next_pkt += os->segments[seg];
 396         }
 397         os->lastpts                 =
 398         os->lastdts                 = os->granule - duration;
 399         s->streams[idx]->start_time = os->lastpts + first_duration;
 400         if (s->streams[idx]->duration)
 401             s->streams[idx]->duration -= s->streams[idx]->start_time;
 402         s->streams[idx]->cur_dts = AV_NOPTS_VALUE;
 403         priv->final_pts          = AV_NOPTS_VALUE;
 404         av_vorbis_parse_reset(priv->vp);
 405     }
 406
 407     /* parse packet duration */
 408     if (os->psize > 0) {
 409         duration = av_vorbis_parse_frame(priv->vp, os->buf + os->pstart, 1);
 410         if (duration <= 0) {
 411             os->pflags |= AV_PKT_FLAG_CORRUPT;
 412             return 0;
 413         }
 414         os->pduration = duration;
 415     }
 416
 417     /* final packet handling
 418      * here we save the pts of the first packet in the final page, sum up all
 419      * packet durations in the final page except for the last one, and compare
 420      * to the page granule to find the duration of the final packet */
 421     if (os->flags & OGG_FLAG_EOS) {
 422         if (os->lastpts != AV_NOPTS_VALUE) {
 423             priv->final_pts      = os->lastpts;
 424             priv->final_duration = 0;
 425         }
 426         if (os->segp == os->nsegs)
 427             os->pduration = os->granule - priv->final_pts - priv->final_duration;
 428         priv->final_duration += os->pduration;
 429     }
 430
 431     return 0;
 432 }
 433
 434 const struct ogg_codec ff_vorbis_codec = {
 435     .magic     = "\001vorbis",
 436     .magicsize = 7,
 437     .header    = vorbis_header,
 438     .packet    = vorbis_packet,
 439     .cleanup   = vorbis_cleanup,
 440     .nb_header = 3,
 441 };