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