oggparsevorbis.c 15.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * 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.
 */
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 42 43 44 45
static int ogm_chapter(AVFormatContext *as, uint8_t *key, uint8_t *val)
{
    int i, cnum, h, m, s, ms, keylen = strlen(key);
    AVChapter *chapter = NULL;

46
    if (keylen < 9 || sscanf(key, "CHAPTER%03d", &cnum) != 1)
47 48
        return 0;

49
    if (keylen <= 10) {
50 51 52
        if (sscanf(val, "%02d:%02d:%02d.%03d", &h, &m, &s, &ms) < 4)
            return 0;

53 54 55
        avpriv_new_chapter(as, cnum, (AVRational) { 1, 1000 },
                           ms + 1000 * (s + 60 * (m + 60 * h)),
                           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 60 61 62 63 64 65
            if (as->chapters[i]->id == cnum) {
                chapter = as->chapters[i];
                break;
            }
        if (!chapter)
            return 0;

66
        av_dict_set(&chapter->metadata, "title", val, AV_DICT_DONT_STRDUP_VAL);
67 68 69 70 71 72 73
    } else
        return 0;

    av_free(key);
    return 1;
}

74 75 76 77 78 79 80 81 82 83 84 85
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;
}

86
int ff_vorbis_comment(AVFormatContext *as, AVDictionary **m,
87 88
                      const uint8_t *buf, int size,
                      int parse_picture)
89
{
90
    const uint8_t *p   = buf;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
91
    const uint8_t *end = buf + size;
92
    int updates        = 0;
93 94
    unsigned n, j;
    int s;
95

96 97
    /* must have vendor_length and user_comment_list_length */
    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 106

    p += s;

107
    n = bytestream_get_le32(&p);
108

109
    while (end - p >= 4 && n > 0) {
Baptiste Coudurier's avatar
Baptiste Coudurier committed
110
        const char *t, *v;
111 112
        int tl, vl;

113
        s = bytestream_get_le32(&p);
114

115
        if (end - p < s || s < 0)
116 117
            break;

118
        t  = p;
119 120 121
        p += s;
        n--;

Måns Rullgård's avatar
Måns Rullgård committed
122
        v = memchr(t, '=', s);
123 124 125 126 127 128 129
        if (!v)
            continue;

        tl = v - t;
        vl = s - tl - 1;
        v++;

Måns Rullgård's avatar
Måns Rullgård committed
130
        if (tl && vl) {
131 132 133 134 135 136 137
            char *tt, *ct;

            tt = av_malloc(tl + 1);
            ct = av_malloc(vl + 1);
            if (!tt || !ct) {
                av_freep(&tt);
                av_freep(&ct);
138
                return AVERROR(ENOMEM);
139
            }
140 141

            for (j = 0; j < tl; j++)
142
                tt[j] = av_toupper(t[j]);
143 144
            tt[tl] = 0;

Måns Rullgård's avatar
Måns Rullgård committed
145
            memcpy(ct, v, vl);
146 147
            ct[vl] = 0;

148 149 150 151 152 153
            /* 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."
             */
154
            if (!strcmp(tt, "METADATA_BLOCK_PICTURE") && parse_picture) {
155 156 157 158 159
                int ret;
                char *pict = av_malloc(vl);

                if (!pict) {
                    av_log(as, AV_LOG_WARNING, "out-of-memory error. Skipping cover art block.\n");
160
                    av_freep(&tt);
161
                    av_freep(&ct);
162 163 164 165
                    continue;
                }
                if ((ret = av_base64_decode(pict, ct, vl)) > 0)
                    ret = ff_flac_parse_picture(as, pict, ret);
166
                av_freep(&tt);
167
                av_freep(&ct);
168
                av_freep(&pict);
169 170 171 172
                if (ret < 0) {
                    av_log(as, AV_LOG_WARNING, "Failed to parse cover art block.\n");
                    continue;
                }
173
            } else if (!ogm_chapter(as, tt, ct)) {
174
                updates++;
175
                if (av_dict_get(*m, tt, NULL, 0)) {
176 177
                    av_dict_set(m, tt, ";", AV_DICT_APPEND);
                }
178
                av_dict_set(m, tt, ct,
179
                            AV_DICT_DONT_STRDUP_KEY |
180 181 182
                            AV_DICT_APPEND);
                av_freep(&ct);
            }
183 184 185
        }
    }

186
    if (p != end)
187
        av_log(as, AV_LOG_INFO,
188
               "%"PTRDIFF_SPECIFIER" bytes of comment header remain\n", end - p);
189
    if (n > 0)
Måns Rullgård's avatar
Måns Rullgård committed
190 191
        av_log(as, AV_LOG_INFO,
               "truncated comment header, %i comments not found\n", n);
192

193
    ff_metadata_conv(m, NULL, ff_vorbiscomment_metadata_conv);
194

195
    return updates;
196 197
}

198 199 200
/*
 * Parse the vorbis header
 *
201 202 203
 * 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
204
 * [audio_sample_rate] = read 32 bits as unsigned integer | Used
205 206 207 208 209 210
 * [bitrate_maximum] = read 32 bits as signed integer | Not used yet
 * [bitrate_nominal] = read 32 bits as signed integer | Not used yet
 * [bitrate_minimum] = read 32 bits as signed integer | Used as bitrate
 * [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
211
 */
212

213
struct oggvorbis_private {
214 215
    unsigned int len[3];
    unsigned char *packet[3];
216
    AVVorbisParseContext *vp;
217 218
    int64_t final_pts;
    int final_duration;
219
};
220

221 222 223
static int fixup_vorbis_headers(AVFormatContext *as,
                                struct oggvorbis_private *priv,
                                uint8_t **buf)
224
{
225
    int i, offset, len, err;
226
    int buf_len;
227 228 229
    unsigned char *ptr;

    len = priv->len[0] + priv->len[1] + priv->len[2];
230
    buf_len = len + len / 255 + 64;
231
    ptr = *buf = av_realloc(NULL, buf_len);
232 233
    if (!ptr)
        return AVERROR(ENOMEM);
234
    memset(*buf, '\0', buf_len);
235

236 237
    ptr[0]  = 2;
    offset  = 1;
238 239
    offset += av_xiphlacing(&ptr[offset], priv->len[0]);
    offset += av_xiphlacing(&ptr[offset], priv->len[1]);
Måns Rullgård's avatar
Måns Rullgård committed
240
    for (i = 0; i < 3; i++) {
241 242
        memcpy(&ptr[offset], priv->packet[i], priv->len[i]);
        offset += priv->len[i];
243
        av_freep(&priv->packet[i]);
244
    }
245
    if ((err = av_reallocp(buf, offset + AV_INPUT_BUFFER_PADDING_SIZE)) < 0)
246
        return err;
247 248 249
    return offset;
}

250
static void vorbis_cleanup(AVFormatContext *s, int idx)
251 252 253 254 255
{
    struct ogg *ogg = s->priv_data;
    struct ogg_stream *os = ogg->streams + idx;
    struct oggvorbis_private *priv = os->private;
    int i;
256 257
    if (os->private) {
        av_vorbis_parse_free(&priv->vp);
258 259
        for (i = 0; i < 3; i++)
            av_freep(&priv->packet[i]);
260
    }
261
}
262

263 264 265 266 267 268 269 270 271 272 273 274
static int vorbis_update_metadata(AVFormatContext *s, int idx)
{
    struct ogg *ogg = s->priv_data;
    struct ogg_stream *os = ogg->streams + idx;
    AVStream *st = s->streams[idx];
    int ret;

    if (os->psize <= 8)
        return 0;

    /* New metadata packet; release old data. */
    av_dict_free(&st->metadata);
275 276
    ret = ff_vorbis_stream_comment(s, st, os->buf + os->pstart + 7,
                                   os->psize - 8);
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
    if (ret < 0)
        return ret;

    /* Update the metadata if possible. */
    av_freep(&os->new_metadata);
    if (st->metadata) {
        os->new_metadata = av_packet_pack_dictionary(st->metadata, &os->new_metadata_size);
    /* Send an empty dictionary to indicate that metadata has been cleared. */
    } else {
        os->new_metadata = av_malloc(1);
        os->new_metadata_size = 0;
    }

    return ret;
}

293
static int vorbis_header(AVFormatContext *s, int idx)
294
{
295
    struct ogg *ogg = s->priv_data;
296
    AVStream *st    = s->streams[idx];
297 298
    struct ogg_stream *os = ogg->streams + idx;
    struct oggvorbis_private *priv;
299
    int pkt_type = os->buf[os->pstart];
300

301
    if (!os->private) {
302
        os->private = av_mallocz(sizeof(struct oggvorbis_private));
Måns Rullgård's avatar
Måns Rullgård committed
303
        if (!os->private)
304
            return AVERROR(ENOMEM);
305
    }
306

307 308
    priv = os->private;

309
    if (!(pkt_type & 1))
310
        return priv->vp ? 0 : AVERROR_INVALIDDATA;
311

312
    if (os->psize < 1 || pkt_type > 5)
313
        return AVERROR_INVALIDDATA;
314

315
    if (priv->packet[pkt_type >> 1])
316
        return AVERROR_INVALIDDATA;
317
    if (pkt_type > 1 && !priv->packet[0] || pkt_type > 3 && !priv->packet[1])
318
        return AVERROR_INVALIDDATA;
319

320
    priv->len[pkt_type >> 1]    = os->psize;
321
    priv->packet[pkt_type >> 1] = av_mallocz(os->psize);
322 323
    if (!priv->packet[pkt_type >> 1])
        return AVERROR(ENOMEM);
324
    memcpy(priv->packet[pkt_type >> 1], os->buf + os->pstart, os->psize);
325
    if (os->buf[os->pstart] == 1) {
Baptiste Coudurier's avatar
Baptiste Coudurier committed
326
        const uint8_t *p = os->buf + os->pstart + 7; /* skip "\001vorbis" tag */
327
        unsigned blocksize, bs0, bs1;
328
        int srate;
329
        int channels;
330 331

        if (os->psize != 30)
332
            return AVERROR_INVALIDDATA;
333

334
        if (bytestream_get_le32(&p) != 0) /* vorbis_version */
335
            return AVERROR_INVALIDDATA;
336

337
        channels = bytestream_get_byte(&p);
338 339 340 341 342
        if (st->codec->channels && channels != st->codec->channels) {
            av_log(s, AV_LOG_ERROR, "Channel change is not supported\n");
            return AVERROR_PATCHWELCOME;
        }
        st->codec->channels = channels;
343
        srate               = bytestream_get_le32(&p);
344 345
        p += 4; // skip maximum bitrate
        st->codec->bit_rate = bytestream_get_le32(&p); // nominal bitrate
346 347 348
        p += 4; // skip minimum bitrate

        blocksize = bytestream_get_byte(&p);
349 350
        bs0       = blocksize & 15;
        bs1       = blocksize >> 4;
351 352

        if (bs0 > bs1)
353
            return AVERROR_INVALIDDATA;
354
        if (bs0 < 6 || bs1 > 13)
355
            return AVERROR_INVALIDDATA;
356 357

        if (bytestream_get_byte(&p) != 1) /* framing_flag */
358
            return AVERROR_INVALIDDATA;
359

360
        st->codec->codec_type = AVMEDIA_TYPE_AUDIO;
361
        st->codec->codec_id   = AV_CODEC_ID_VORBIS;
362

363 364
        if (srate > 0) {
            st->codec->sample_rate = srate;
365
            avpriv_set_pts_info(st, 64, 1, srate);
366
        }
367
    } else if (os->buf[os->pstart] == 3) {
368
        if (vorbis_update_metadata(s, idx) >= 0 && priv->len[1] > 10) {
369 370 371 372 373 374
            unsigned new_len;

            int ret = ff_replaygain_export(st, st->metadata);
            if (ret < 0)
                return ret;

375
            // drop all metadata we parsed and which is not required by libvorbis
376
            new_len = 7 + 4 + AV_RL32(priv->packet[1] + 7) + 4 + 1;
377 378 379
            if (new_len >= 16 && new_len < os->psize) {
                AV_WL32(priv->packet[1] + new_len - 5, 0);
                priv->packet[1][new_len - 1] = 1;
380
                priv->len[1]                 = new_len;
381 382
            }
        }
383
    } else {
384 385 386 387 388 389
        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;
390 391 392

        priv->vp = av_vorbis_parse_init(st->codec->extradata, st->codec->extradata_size);
        if (!priv->vp) {
393 394
            av_freep(&st->codec->extradata);
            st->codec->extradata_size = 0;
395
            return AVERROR_UNKNOWN;
396
        }
397 398
    }

399
    return 1;
400 401
}

402 403 404 405 406
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;
407
    int duration, flags = 0;
408

409 410 411
    if (!priv->vp)
        return AVERROR_INVALIDDATA;

412
    /* first packet handling
413 414 415
     * 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 */
416
    if ((!os->lastpts || os->lastpts == AV_NOPTS_VALUE) && !(os->flags & OGG_FLAG_EOS) && (int64_t)os->granule>=0) {
417
        int seg, d;
418 419
        uint8_t *last_pkt  = os->buf + os->pstart;
        uint8_t *next_pkt  = last_pkt;
420

421
        av_vorbis_parse_reset(priv->vp);
422
        duration = 0;
423
        seg = os->segp;
424
        d = av_vorbis_parse_frame_flags(priv->vp, last_pkt, 1, &flags);
425 426 427
        if (d < 0) {
            os->pflags |= AV_PKT_FLAG_CORRUPT;
            return 0;
428 429 430
        } else if (flags & VORBIS_FLAG_COMMENT) {
            vorbis_update_metadata(s, idx);
            flags = 0;
431 432 433 434
        }
        duration += d;
        last_pkt = next_pkt =  next_pkt + os->psize;
        for (; seg < os->nsegs; seg++) {
435
            if (os->segments[seg] < 255) {
436
                int d = av_vorbis_parse_frame_flags(priv->vp, last_pkt, 1, &flags);
437 438 439
                if (d < 0) {
                    duration = os->granule;
                    break;
440 441 442
                } else if (flags & VORBIS_FLAG_COMMENT) {
                    vorbis_update_metadata(s, idx);
                    flags = 0;
443 444
                }
                duration += d;
445
                last_pkt  = next_pkt + os->segments[seg];
446 447 448
            }
            next_pkt += os->segments[seg];
        }
449 450
        os->lastpts                 =
        os->lastdts                 = os->granule - duration;
451 452 453 454

        if (!os->granule && duration) //hack to deal with broken files (Ticket3710)
            os->lastpts = os->lastdts = AV_NOPTS_VALUE;

455
        if (s->streams[idx]->start_time == AV_NOPTS_VALUE) {
456
            s->streams[idx]->start_time = FFMAX(os->lastpts, 0);
457
            if (s->streams[idx]->duration != AV_NOPTS_VALUE)
458 459
                s->streams[idx]->duration -= s->streams[idx]->start_time;
        }
460
        priv->final_pts          = AV_NOPTS_VALUE;
461
        av_vorbis_parse_reset(priv->vp);
462 463 464 465
    }

    /* parse packet duration */
    if (os->psize > 0) {
466
        duration = av_vorbis_parse_frame_flags(priv->vp, os->buf + os->pstart, 1, &flags);
467
        if (duration < 0) {
468 469
            os->pflags |= AV_PKT_FLAG_CORRUPT;
            return 0;
470 471 472
        } else if (flags & VORBIS_FLAG_COMMENT) {
            vorbis_update_metadata(s, idx);
            flags = 0;
473 474 475 476 477
        }
        os->pduration = duration;
    }

    /* final packet handling
478 479 480
     * 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 */
481 482
    if (os->flags & OGG_FLAG_EOS) {
        if (os->lastpts != AV_NOPTS_VALUE) {
483
            priv->final_pts      = os->lastpts;
484 485 486 487 488 489 490 491 492 493
            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;
}

494
const struct ogg_codec ff_vorbis_codec = {
495
    .magic     = "\001vorbis",
496
    .magicsize = 7,
497 498 499
    .header    = vorbis_header,
    .packet    = vorbis_packet,
    .cleanup   = vorbis_cleanup,
500
    .nb_header = 3,
501
};