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, len = AV_BASE64_DECODE_SIZE(vl);
 157                 char *pict = av_malloc(len);
 158
 159                 if (!pict) {
 160                     av_log(as, AV_LOG_WARNING, "out-of-memory error. Skipping cover art block.\n");
 161                     av_freep(&tt);
 162                     av_freep(&ct);
 163                     continue;
 164                 }
 165                 ret = av_base64_decode(pict, ct, len);
 166                 av_freep(&tt);
 167                 av_freep(&ct);
 168                 if (ret > 0)
 169                     ret = ff_flac_parse_picture(as, pict, ret);
 170                 av_freep(&pict);
 171                 if (ret < 0) {
 172                     av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
 173                     continue;
 174                 }
 175             } else if (!ogm_chapter(as, tt, ct)) {
 176                 updates++;
 177                 if (av_dict_get(*m, tt, NULL, 0)) {
 178                     av_dict_set(m, tt, ";", AV_DICT_APPEND);
 179                 }
 180                 av_dict_set(m, tt, ct,
 181                             AV_DICT_DONT_STRDUP_KEY |
 182                             AV_DICT_APPEND);
 183                 av_freep(&ct);
 184             }
 185         }
 186     }
 187
 188     if (p != end)
 189         av_log(as, AV_LOG_INFO,
 190                "%"PTRDIFF_SPECIFIER" bytes of comment header remain\n", end - p);
 191     if (n > 0)
 192         av_log(as, AV_LOG_INFO,
 193                "truncated comment header, %i comments not found\n", n);
 194
 195     ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
 196
 197     return updates;
 198 }
 199
 200 /*
 201  * Parse the vorbis header
 202  *
 203  * Vorbis Identification header from Vorbis_I_spec.html#vorbis-spec-codec
 204  * [vorbis_version] = read 32 bits as unsigned integer | Not used
 205  * [audio_channels] = read 8 bit integer as unsigned | Used
 206  * [audio_sample_rate] = read 32 bits as unsigned integer | Used
 207  * [bitrate_maximum] = read 32 bits as signed integer | Not used yet
 208  * [bitrate_nominal] = read 32 bits as signed integer | Not used yet
 209  * [bitrate_minimum] = read 32 bits as signed integer | Used as bitrate
 210  * [blocksize_0] = read 4 bits as unsigned integer | Not Used
 211  * [blocksize_1] = read 4 bits as unsigned integer | Not Used
 212  * [framing_flag] = read one bit | Not Used
 213  */
 214
 215 struct oggvorbis_private {
 216     unsigned int len[3];
 217     unsigned char *packet[3];
 218     AVVorbisParseContext *vp;
 219     int64_t final_pts;
 220     int final_duration;
 221 };
 222
 223 static int fixup_vorbis_headers(AVFormatContext *as,
 224                                 struct oggvorbis_private *priv,
 225                                 uint8_t **buf)
 226 {
 227     int i, offset, len, err;
 228     int buf_len;
 229     unsigned char *ptr;
 230
 231     len = priv->len[0] + priv->len[1] + priv->len[2];
 232     buf_len = len + len / 255 + 64;
 233
 234     if (*buf)
 235         return AVERROR_INVALIDDATA;
 236
 237     ptr = *buf = av_realloc(NULL, buf_len);
 238     if (!ptr)
 239         return AVERROR(ENOMEM);
 240     memset(*buf, '\0', buf_len);
 241
 242     ptr[0]  = 2;
 243     offset  = 1;
 244     offset += av_xiphlacing(&ptr[offset], priv->len[0]);
 245     offset += av_xiphlacing(&ptr[offset], priv->len[1]);
 246     for (i = 0; i < 3; i++) {
 247         memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
 248         offset += priv->len[i];
 249         av_freep(&priv->packet[i]);
 250     }
 251     if ((err = av_reallocp(buf, offset + AV_INPUT_BUFFER_PADDING_SIZE)) < 0)
 252         return err;
 253     return offset;
 254 }
 255
 256 static void vorbis_cleanup(AVFormatContext *s, int idx)
 257 {
 258     struct ogg *ogg = s->priv_data;
 259     struct ogg_stream *os = ogg->streams + idx;
 260     struct oggvorbis_private *priv = os->private;
 261     int i;
 262     if (os->private) {
 263         av_vorbis_parse_free(&priv->vp);
 264         for (i = 0; i < 3; i++)
 265             av_freep(&priv->packet[i]);
 266     }
 267 }
 268
 269 static int vorbis_update_metadata(AVFormatContext *s, int idx)
 270 {
 271     struct ogg *ogg = s->priv_data;
 272     struct ogg_stream *os = ogg->streams + idx;
 273     AVStream *st = s->streams[idx];
 274     int ret;
 275
 276     if (os->psize <= 8)
 277         return 0;
 278
 279     /* New metadata packet; release old data. */
 280     av_dict_free(&st->metadata);
 281     ret = ff_vorbis_stream_comment(s, st, os->buf + os->pstart + 7,
 282                                    os->psize - 8);
 283     if (ret < 0)
 284         return ret;
 285
 286     /* Update the metadata if possible. */
 287     av_freep(&os->new_metadata);
 288     if (st->metadata) {
 289         os->new_metadata = av_packet_pack_dictionary(st->metadata, &os->new_metadata_size);
 290     /* Send an empty dictionary to indicate that metadata has been cleared. */
 291     } else {
 292         os->new_metadata = av_malloc(1);
 293         os->new_metadata_size = 0;
 294     }
 295
 296     return ret;
 297 }
 298
 299 static int vorbis_header(AVFormatContext *s, int idx)
 300 {
 301     struct ogg *ogg = s->priv_data;
 302     AVStream *st    = s->streams[idx];
 303     struct ogg_stream *os = ogg->streams + idx;
 304     struct oggvorbis_private *priv;
 305     int pkt_type = os->buf[os->pstart];
 306
 307     if (!os->private) {
 308         os->private = av_mallocz(sizeof(struct oggvorbis_private));
 309         if (!os->private)
 310             return AVERROR(ENOMEM);
 311     }
 312
 313     priv = os->private;
 314
 315     if (!(pkt_type & 1))
 316         return priv->vp ? 0 : AVERROR_INVALIDDATA;
 317
 318     if (os->psize < 1 || pkt_type > 5)
 319         return AVERROR_INVALIDDATA;
 320
 321     if (priv->packet[pkt_type >> 1])
 322         return AVERROR_INVALIDDATA;
 323     if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
 324         return priv->vp ? 0 : AVERROR_INVALIDDATA;
 325
 326     priv->len[pkt_type >> 1]    = os->psize;
 327     priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
 328     if (!priv->packet[pkt_type >> 1])
 329         return AVERROR(ENOMEM);
 330     memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
 331     if (os->buf[os->pstart] == 1) {
 332         const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
 333         unsigned blocksize, bs0, bs1;
 334         int srate;
 335         int channels;
 336
 337         if (os->psize != 30)
 338             return AVERROR_INVALIDDATA;
 339
 340         if (bytestream_get_le32(&p) != 0) /* vorbis_version */
 341             return AVERROR_INVALIDDATA;
 342
 343         channels = bytestream_get_byte(&p);
 344         if (st->codecpar->channels && channels != st->codecpar->channels) {
 345             av_log(s, AV_LOG_ERROR, "Channel change is not supported\n");
 346             return AVERROR_PATCHWELCOME;
 347         }
 348         st->codecpar->channels = channels;
 349         srate               = bytestream_get_le32(&p);
 350         p += 4; // skip maximum bitrate
 351         st->codecpar->bit_rate = bytestream_get_le32(&p); // nominal bitrate
 352         p += 4; // skip minimum bitrate
 353
 354         blocksize = bytestream_get_byte(&p);
 355         bs0       = blocksize & 15;
 356         bs1       = blocksize >> 4;
 357
 358         if (bs0 > bs1)
 359             return AVERROR_INVALIDDATA;
 360         if (bs0 < 6 || bs1 > 13)
 361             return AVERROR_INVALIDDATA;
 362
 363         if (bytestream_get_byte(&p) != 1) /* framing_flag */
 364             return AVERROR_INVALIDDATA;
 365
 366         st->codecpar->codec_type = AVMEDIA_TYPE_AUDIO;
 367         st->codecpar->codec_id   = AV_CODEC_ID_VORBIS;
 368
 369         if (srate > 0) {
 370             st->codecpar->sample_rate = srate;
 371             avpriv_set_pts_info(st, 64, 1, srate);
 372         }
 373     } else if (os->buf[os->pstart] == 3) {
 374         if (vorbis_update_metadata(s, idx) >= 0 && priv->len[1] > 10) {
 375             unsigned new_len;
 376
 377             int ret = ff_replaygain_export(st, st->metadata);
 378             if (ret < 0)
 379                 return ret;
 380
 381             // drop all metadata we parsed and which is not required by libvorbis
 382             new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
 383             if (new_len >= 16 && new_len < os->psize) {
 384                 AV_WL32(priv->packet[1] + new_len - 5, 0);
 385                 priv->packet[1][new_len - 1] = 1;
 386                 priv->len[1]                 = new_len;
 387             }
 388         }
 389     } else {
 390         int ret = fixup_vorbis_headers(s, priv, &st->codecpar->extradata);
 391         if (ret < 0) {
 392             st->codecpar->extradata_size = 0;
 393             return ret;
 394         }
 395         st->codecpar->extradata_size = ret;
 396
 397         priv->vp = av_vorbis_parse_init(st->codecpar->extradata, st->codecpar->extradata_size);
 398         if (!priv->vp) {
 399             av_freep(&st->codecpar->extradata);
 400             st->codecpar->extradata_size = 0;
 401             return AVERROR_UNKNOWN;
 402         }
 403     }
 404
 405     return 1;
 406 }
 407
 408 static int vorbis_packet(AVFormatContext *s, int idx)
 409 {
 410     struct ogg *ogg = s->priv_data;
 411     struct ogg_stream *os = ogg->streams + idx;
 412     struct oggvorbis_private *priv = os->private;
 413     int duration, flags = 0;
 414
 415     if (!priv->vp)
 416         return AVERROR_INVALIDDATA;
 417
 418     /* first packet handling
 419      * here we parse the duration of each packet in the first page and compare
 420      * the total duration to the page granule to find the encoder delay and
 421      * set the first timestamp */
 422     if ((!os->lastpts || os->lastpts == AV_NOPTS_VALUE) && !(os->flags & OGG_FLAG_EOS) && (int64_t)os->granule>=0) {
 423         int seg, d;
 424         uint8_t *last_pkt  = os->buf + os->pstart;
 425         uint8_t *next_pkt  = last_pkt;
 426
 427         av_vorbis_parse_reset(priv->vp);
 428         duration = 0;
 429         seg = os->segp;
 430         d = av_vorbis_parse_frame_flags(priv->vp, last_pkt, 1, &flags);
 431         if (d < 0) {
 432             os->pflags |= AV_PKT_FLAG_CORRUPT;
 433             return 0;
 434         } else if (flags & VORBIS_FLAG_COMMENT) {
 435             vorbis_update_metadata(s, idx);
 436             flags = 0;
 437         }
 438         duration += d;
 439         last_pkt = next_pkt =  next_pkt + os->psize;
 440         for (; seg < os->nsegs; seg++) {
 441             if (os->segments[seg] < 255) {
 442                 int d = av_vorbis_parse_frame_flags(priv->vp, last_pkt, 1, &flags);
 443                 if (d < 0) {
 444                     duration = os->granule;
 445                     break;
 446                 } else if (flags & VORBIS_FLAG_COMMENT) {
 447                     vorbis_update_metadata(s, idx);
 448                     flags = 0;
 449                 }
 450                 duration += d;
 451                 last_pkt  = next_pkt + os->segments[seg];
 452             }
 453             next_pkt += os->segments[seg];
 454         }
 455         os->lastpts                 =
 456         os->lastdts                 = os->granule - duration;
 457
 458         if (!os->granule && duration) //hack to deal with broken files (Ticket3710)
 459             os->lastpts = os->lastdts = AV_NOPTS_VALUE;
 460
 461         if (s->streams[idx]->start_time == AV_NOPTS_VALUE) {
 462             s->streams[idx]->start_time = FFMAX(os->lastpts, 0);
 463             if (s->streams[idx]->duration != AV_NOPTS_VALUE)
 464                 s->streams[idx]->duration -= s->streams[idx]->start_time;
 465         }
 466         priv->final_pts          = AV_NOPTS_VALUE;
 467         av_vorbis_parse_reset(priv->vp);
 468     }
 469
 470     /* parse packet duration */
 471     if (os->psize > 0) {
 472         duration = av_vorbis_parse_frame_flags(priv->vp, os->buf + os->pstart, 1, &flags);
 473         if (duration < 0) {
 474             os->pflags |= AV_PKT_FLAG_CORRUPT;
 475             return 0;
 476         } else if (flags & VORBIS_FLAG_COMMENT) {
 477             vorbis_update_metadata(s, idx);
 478             flags = 0;
 479         }
 480         os->pduration = duration;
 481     }
 482
 483     /* final packet handling
 484      * here we save the pts of the first packet in the final page, sum up all
 485      * packet durations in the final page except for the last one, and compare
 486      * to the page granule to find the duration of the final packet */
 487     if (os->flags & OGG_FLAG_EOS) {
 488         if (os->lastpts != AV_NOPTS_VALUE) {
 489             priv->final_pts      = os->lastpts;
 490             priv->final_duration = 0;
 491         }
 492         if (os->segp == os->nsegs)
 493             os->pduration = os->granule - priv->final_pts - priv->final_duration;
 494         priv->final_duration += os->pduration;
 495     }
 496
 497     return 0;
 498 }
 499
 500 const struct ogg_codec ff_vorbis_codec = {
 501     .magic     = "\001vorbis",
 502     .magicsize = 7,
 503     .header    = vorbis_header,
 504     .packet    = vorbis_packet,
 505     .cleanup   = vorbis_cleanup,
 506     .nb_header = 3,
 507 };