oggenc.c 16.2 KB
Newer Older
Baptiste Coudurier's avatar
Baptiste Coudurier committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Ogg muxer
 * Copyright (c) 2007 Baptiste Coudurier <baptiste dot coudurier at free dot fr>
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

22
#include "libavutil/crc.h"
23
#include "libavutil/random_seed.h"
24 25
#include "libavcodec/xiph.h"
#include "libavcodec/bytestream.h"
26
#include "libavcodec/flac.h"
Baptiste Coudurier's avatar
Baptiste Coudurier committed
27
#include "avformat.h"
28
#include "internal.h"
29
#include "vorbiscomment.h"
Baptiste Coudurier's avatar
Baptiste Coudurier committed
30

31 32 33 34 35 36 37 38 39 40 41 42
#define MAX_PAGE_SIZE 65025

typedef struct {
    int64_t granule;
    int stream_index;
    uint8_t flags;
    uint8_t segments_count;
    uint8_t segments[255];
    uint8_t data[MAX_PAGE_SIZE];
    uint16_t size;
} OGGPage;

Baptiste Coudurier's avatar
Baptiste Coudurier committed
43 44 45 46 47 48 49 50
typedef struct {
    unsigned page_counter;
    uint8_t *header[3];
    int header_len[3];
    /** for theora granule */
    int kfgshift;
    int64_t last_kf_pts;
    int vrev;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
51
    int eos;
52 53
    unsigned page_count; ///< number of page buffered
    OGGPage page; ///< current page
54
    unsigned serial_num; ///< serial number
55
    int64_t last_granule; ///< last packet granule
Baptiste Coudurier's avatar
Baptiste Coudurier committed
56 57
} OGGStreamContext;

58 59 60 61 62 63 64 65 66
typedef struct OGGPageList {
    OGGPage page;
    struct OGGPageList *next;
} OGGPageList;

typedef struct {
    OGGPageList *page_list;
} OGGContext;

67
static void ogg_update_checksum(AVFormatContext *s, ByteIOContext *pb, int64_t crc_offset)
Baptiste Coudurier's avatar
Baptiste Coudurier committed
68
{
69 70 71 72 73
    int64_t pos = url_ftell(pb);
    uint32_t checksum = get_checksum(pb);
    url_fseek(pb, crc_offset, SEEK_SET);
    put_be32(pb, checksum);
    url_fseek(pb, pos, SEEK_SET);
Baptiste Coudurier's avatar
Baptiste Coudurier committed
74 75
}

76
static int ogg_write_page(AVFormatContext *s, OGGPage *page, int extra_flags)
Baptiste Coudurier's avatar
Baptiste Coudurier committed
77
{
78
    OGGStreamContext *oggstream = s->streams[page->stream_index]->priv_data;
79
    ByteIOContext *pb;
80
    int64_t crc_offset;
81 82
    int ret, size;
    uint8_t *buf;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
83

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
    ret = url_open_dyn_buf(&pb);
    if (ret < 0)
        return ret;
    init_checksum(pb, ff_crc04C11DB7_update, 0);
    put_tag(pb, "OggS");
    put_byte(pb, 0);
    put_byte(pb, page->flags | extra_flags);
    put_le64(pb, page->granule);
    put_le32(pb, oggstream->serial_num);
    put_le32(pb, oggstream->page_counter++);
    crc_offset = url_ftell(pb);
    put_le32(pb, 0); // crc
    put_byte(pb, page->segments_count);
    put_buffer(pb, page->segments, page->segments_count);
    put_buffer(pb, page->data, page->size);

    ogg_update_checksum(s, pb, crc_offset);
    put_flush_packet(pb);

    size = url_close_dyn_buf(pb, &buf);
    if (size < 0)
        return size;

    put_buffer(s->pb, buf, size);
108
    put_flush_packet(s->pb);
109
    av_free(buf);
110
    oggstream->page_count--;
111
    return 0;
112 113
}

114
static int64_t ogg_granule_to_timestamp(OGGStreamContext *oggstream, int64_t granule)
115 116
{
    if (oggstream->kfgshift)
117 118
        return (granule>>oggstream->kfgshift) +
            (granule & ((1<<oggstream->kfgshift)-1));
119
    else
120
        return granule;
121 122 123 124 125 126 127 128 129 130 131
}

static int ogg_compare_granule(AVFormatContext *s, OGGPage *next, OGGPage *page)
{
    AVStream *st2 = s->streams[next->stream_index];
    AVStream *st  = s->streams[page->stream_index];
    int64_t next_granule, cur_granule;

    if (next->granule == -1 || page->granule == -1)
        return 0;

132
    next_granule = av_rescale_q(ogg_granule_to_timestamp(st2->priv_data, next->granule),
133
                                st2->time_base, AV_TIME_BASE_Q);
134
    cur_granule  = av_rescale_q(ogg_granule_to_timestamp(st->priv_data, page->granule),
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
                                st ->time_base, AV_TIME_BASE_Q);
    return next_granule > cur_granule;
}

static int ogg_reset_cur_page(OGGStreamContext *oggstream)
{
    oggstream->page.granule = -1;
    oggstream->page.flags = 0;
    oggstream->page.segments_count = 0;
    oggstream->page.size = 0;
    return 0;
}

static int ogg_buffer_page(AVFormatContext *s, OGGStreamContext *oggstream)
{
    OGGContext *ogg = s->priv_data;
    OGGPageList **p = &ogg->page_list;
    OGGPageList *l = av_mallocz(sizeof(*l));

    if (!l)
        return AVERROR(ENOMEM);
    l->page = oggstream->page;

    oggstream->page_count++;
    ogg_reset_cur_page(oggstream);

    while (*p) {
        if (ogg_compare_granule(s, &(*p)->page, &l->page))
            break;
        p = &(*p)->next;
    }
    l->next = *p;
    *p = l;

    return 0;
}

static int ogg_buffer_data(AVFormatContext *s, AVStream *st,
                           uint8_t *data, unsigned size, int64_t granule)
{
    OGGStreamContext *oggstream = st->priv_data;
    int total_segments = size / 255 + 1;
    uint8_t *p = data;
178 179 180 181 182 183 184 185 186 187
    int i, segments, len, flush = 0;

    // Handles VFR by flushing page because this frame needs to have a timestamp
    if (st->codec->codec_id == CODEC_ID_THEORA &&
        ogg_granule_to_timestamp(oggstream, granule) >
        ogg_granule_to_timestamp(oggstream, oggstream->last_granule) + 1) {
        if (oggstream->page.granule != -1)
            ogg_buffer_page(s, oggstream);
        flush = 1;
    }
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214

    for (i = 0; i < total_segments; ) {
        OGGPage *page = &oggstream->page;

        segments = FFMIN(total_segments - i, 255 - page->segments_count);

        if (i && !page->segments_count)
            page->flags |= 1; // continued packet

        memset(page->segments+page->segments_count, 255, segments - 1);
        page->segments_count += segments - 1;

        len = FFMIN(size, segments*255);
        page->segments[page->segments_count++] = len - (segments-1)*255;
        memcpy(page->data+page->size, p, len);
        p += len;
        size -= len;
        i += segments;
        page->size += len;

        if (i == total_segments)
            page->granule = granule;

        if (page->segments_count == 255) {
            ogg_buffer_page(s, oggstream);
        }
    }
215 216 217 218

    if (flush && oggstream->page.granule != -1)
        ogg_buffer_page(s, oggstream);

219
    return 0;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
220 221
}

222
static uint8_t *ogg_write_vorbiscomment(int offset, int bitexact,
223
                                        int *header_len, AVMetadata **m, int framing_bit)
224 225 226 227
{
    const char *vendor = bitexact ? "ffmpeg" : LIBAVFORMAT_IDENT;
    int size;
    uint8_t *p, *p0;
228
    unsigned int count;
229

230 231
    ff_metadata_conv(m, ff_vorbiscomment_metadata_conv, NULL);

232
    size = offset + ff_vorbiscomment_length(*m, vendor, &count) + framing_bit;
233 234 235 236 237 238
    p = av_mallocz(size);
    if (!p)
        return NULL;
    p0 = p;

    p += offset;
239
    ff_vorbiscomment_write(&p, m, vendor, count);
240 241
    if (framing_bit)
        bytestream_put_byte(&p, 1);
242 243 244 245 246

    *header_len = size;
    return p0;
}

247
static int ogg_build_flac_headers(AVCodecContext *avctx,
248
                                  OGGStreamContext *oggstream, int bitexact,
249
                                  AVMetadata **m)
Baptiste Coudurier's avatar
Baptiste Coudurier committed
250
{
251 252
    enum FLACExtradataFormat format;
    uint8_t *streaminfo;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
253
    uint8_t *p;
254

255
    if (!ff_flac_is_extradata_valid(avctx, &format, &streaminfo))
Baptiste Coudurier's avatar
Baptiste Coudurier committed
256
        return -1;
257 258

    // first packet: STREAMINFO
259 260
    oggstream->header_len[0] = 51;
    oggstream->header[0] = av_mallocz(51); // per ogg flac specs
Baptiste Coudurier's avatar
Baptiste Coudurier committed
261
    p = oggstream->header[0];
262
    if (!p)
263
        return AVERROR(ENOMEM);
Baptiste Coudurier's avatar
Baptiste Coudurier committed
264 265 266 267 268 269 270 271
    bytestream_put_byte(&p, 0x7F);
    bytestream_put_buffer(&p, "FLAC", 4);
    bytestream_put_byte(&p, 1); // major version
    bytestream_put_byte(&p, 0); // minor version
    bytestream_put_be16(&p, 1); // headers packets without this one
    bytestream_put_buffer(&p, "fLaC", 4);
    bytestream_put_byte(&p, 0x00); // streaminfo
    bytestream_put_be24(&p, 34);
272
    bytestream_put_buffer(&p, streaminfo, FLAC_STREAMINFO_SIZE);
273 274

    // second packet: VorbisComment
275
    p = ogg_write_vorbiscomment(4, bitexact, &oggstream->header_len[1], m, 0);
276
    if (!p)
277
        return AVERROR(ENOMEM);
278
    oggstream->header[1] = p;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
279 280
    bytestream_put_byte(&p, 0x84); // last metadata block and vorbis comment
    bytestream_put_be24(&p, oggstream->header_len[1] - 4);
281 282 283 284 285 286 287

    return 0;
}

#define SPEEX_HEADER_SIZE 80

static int ogg_build_speex_headers(AVCodecContext *avctx,
288
                                   OGGStreamContext *oggstream, int bitexact,
289
                                   AVMetadata **m)
290 291 292 293 294 295 296 297 298
{
    uint8_t *p;

    if (avctx->extradata_size < SPEEX_HEADER_SIZE)
        return -1;

    // first packet: Speex header
    p = av_mallocz(SPEEX_HEADER_SIZE);
    if (!p)
299
        return AVERROR(ENOMEM);
300 301 302 303 304 305
    oggstream->header[0] = p;
    oggstream->header_len[0] = SPEEX_HEADER_SIZE;
    bytestream_put_buffer(&p, avctx->extradata, SPEEX_HEADER_SIZE);
    AV_WL32(&oggstream->header[0][68], 0);  // set extra_headers to 0

    // second packet: VorbisComment
306
    p = ogg_write_vorbiscomment(0, bitexact, &oggstream->header_len[1], m, 0);
307
    if (!p)
308
        return AVERROR(ENOMEM);
309
    oggstream->header[1] = p;
310

Baptiste Coudurier's avatar
Baptiste Coudurier committed
311 312 313 314 315 316 317
    return 0;
}

static int ogg_write_header(AVFormatContext *s)
{
    OGGStreamContext *oggstream;
    int i, j;
318

Baptiste Coudurier's avatar
Baptiste Coudurier committed
319 320
    for (i = 0; i < s->nb_streams; i++) {
        AVStream *st = s->streams[i];
321 322
        unsigned serial_num = i;

323
        if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO)
Baptiste Coudurier's avatar
Baptiste Coudurier committed
324
            av_set_pts_info(st, 64, 1, st->codec->sample_rate);
325
        else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
Baptiste Coudurier's avatar
Baptiste Coudurier committed
326 327 328
            av_set_pts_info(st, 64, st->codec->time_base.num, st->codec->time_base.den);
        if (st->codec->codec_id != CODEC_ID_VORBIS &&
            st->codec->codec_id != CODEC_ID_THEORA &&
329
            st->codec->codec_id != CODEC_ID_SPEEX  &&
Baptiste Coudurier's avatar
Baptiste Coudurier committed
330 331 332 333 334 335 336 337 338 339
            st->codec->codec_id != CODEC_ID_FLAC) {
            av_log(s, AV_LOG_ERROR, "Unsupported codec id in stream %d\n", i);
            return -1;
        }

        if (!st->codec->extradata || !st->codec->extradata_size) {
            av_log(s, AV_LOG_ERROR, "No extradata present\n");
            return -1;
        }
        oggstream = av_mallocz(sizeof(*oggstream));
340
        oggstream->page.stream_index = i;
341 342 343 344 345 346 347 348 349 350 351 352

        if (!(st->codec->flags & CODEC_FLAG_BITEXACT))
            do {
                serial_num = av_get_random_seed();
                for (j = 0; j < i; j++) {
                    OGGStreamContext *sc = s->streams[j]->priv_data;
                    if (serial_num == sc->serial_num)
                        break;
                }
            } while (j < i);
        oggstream->serial_num = serial_num;

Baptiste Coudurier's avatar
Baptiste Coudurier committed
353 354
        st->priv_data = oggstream;
        if (st->codec->codec_id == CODEC_ID_FLAC) {
355
            int err = ogg_build_flac_headers(st->codec, oggstream,
356
                                             st->codec->flags & CODEC_FLAG_BITEXACT,
357
                                             &s->metadata);
358
            if (err) {
359
                av_log(s, AV_LOG_ERROR, "Error writing FLAC headers\n");
Baptiste Coudurier's avatar
Baptiste Coudurier committed
360
                av_freep(&st->priv_data);
361
                return err;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
362
            }
363 364
        } else if (st->codec->codec_id == CODEC_ID_SPEEX) {
            int err = ogg_build_speex_headers(st->codec, oggstream,
365
                                              st->codec->flags & CODEC_FLAG_BITEXACT,
366
                                              &s->metadata);
367 368 369 370 371
            if (err) {
                av_log(s, AV_LOG_ERROR, "Error writing Speex headers\n");
                av_freep(&st->priv_data);
                return err;
            }
Baptiste Coudurier's avatar
Baptiste Coudurier committed
372
        } else {
373
            uint8_t *p;
374
            const char *cstr = st->codec->codec_id == CODEC_ID_VORBIS ? "vorbis" : "theora";
375 376 377
            int header_type = st->codec->codec_id == CODEC_ID_VORBIS ? 3 : 0x81;
            int framing_bit = st->codec->codec_id == CODEC_ID_VORBIS ? 1 : 0;

Baptiste Coudurier's avatar
Baptiste Coudurier committed
378 379 380 381 382 383 384
            if (ff_split_xiph_headers(st->codec->extradata, st->codec->extradata_size,
                                      st->codec->codec_id == CODEC_ID_VORBIS ? 30 : 42,
                                      oggstream->header, oggstream->header_len) < 0) {
                av_log(s, AV_LOG_ERROR, "Extradata corrupted\n");
                av_freep(&st->priv_data);
                return -1;
            }
385 386

            p = ogg_write_vorbiscomment(7, st->codec->flags & CODEC_FLAG_BITEXACT,
387
                                        &oggstream->header_len[1], &s->metadata,
388 389 390 391 392 393 394 395
                                        framing_bit);
            if (!p)
                return AVERROR(ENOMEM);

            oggstream->header[1] = p;
            bytestream_put_byte(&p, header_type);
            bytestream_put_buffer(&p, cstr, 6);

Baptiste Coudurier's avatar
Baptiste Coudurier committed
396 397 398 399 400 401 402 403 404 405
            if (st->codec->codec_id == CODEC_ID_THEORA) {
                /** KFGSHIFT is the width of the less significant section of the granule position
                    The less significant section is the frame count since the last keyframe */
                oggstream->kfgshift = ((oggstream->header[0][40]&3)<<3)|(oggstream->header[0][41]>>5);
                oggstream->vrev = oggstream->header[0][9];
                av_log(s, AV_LOG_DEBUG, "theora kfgshift %d, vrev %d\n",
                       oggstream->kfgshift, oggstream->vrev);
            }
        }
    }
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

    for (j = 0; j < s->nb_streams; j++) {
        OGGStreamContext *oggstream = s->streams[j]->priv_data;
        ogg_buffer_data(s, s->streams[j], oggstream->header[0],
                        oggstream->header_len[0], 0);
        oggstream->page.flags |= 2; // bos
        ogg_buffer_page(s, oggstream);
    }
    for (j = 0; j < s->nb_streams; j++) {
        AVStream *st = s->streams[j];
        OGGStreamContext *oggstream = st->priv_data;
        for (i = 1; i < 3; i++) {
            if (oggstream && oggstream->header_len[i])
                ogg_buffer_data(s, st, oggstream->header[i],
                                oggstream->header_len[i], 0);
Baptiste Coudurier's avatar
Baptiste Coudurier committed
421
        }
422
        ogg_buffer_page(s, oggstream);
Baptiste Coudurier's avatar
Baptiste Coudurier committed
423 424 425 426
    }
    return 0;
}

427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
static void ogg_write_pages(AVFormatContext *s, int flush)
{
    OGGContext *ogg = s->priv_data;
    OGGPageList *next, *p;

    if (!ogg->page_list)
        return;

    for (p = ogg->page_list; p; ) {
        OGGStreamContext *oggstream =
            s->streams[p->page.stream_index]->priv_data;
        if (oggstream->page_count < 2 && !flush)
            break;
        ogg_write_page(s, &p->page,
                       flush && oggstream->page_count == 1 ? 4 : 0); // eos
        next = p->next;
        av_freep(&p);
        p = next;
    }
    ogg->page_list = p;
}

Baptiste Coudurier's avatar
Baptiste Coudurier committed
449 450 451 452
static int ogg_write_packet(AVFormatContext *s, AVPacket *pkt)
{
    AVStream *st = s->streams[pkt->stream_index];
    OGGStreamContext *oggstream = st->priv_data;
453
    int ret;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
454 455 456 457 458
    int64_t granule;

    if (st->codec->codec_id == CODEC_ID_THEORA) {
        int64_t pts = oggstream->vrev < 1 ? pkt->pts : pkt->pts + pkt->duration;
        int pframe_count;
459
        if (pkt->flags & AV_PKT_FLAG_KEY)
Baptiste Coudurier's avatar
Baptiste Coudurier committed
460 461 462 463 464 465 466 467 468 469 470
            oggstream->last_kf_pts = pts;
        pframe_count = pts - oggstream->last_kf_pts;
        // prevent frame count from overflow if key frame flag is not set
        if (pframe_count >= (1<<oggstream->kfgshift)) {
            oggstream->last_kf_pts += pframe_count;
            pframe_count = 0;
        }
        granule = (oggstream->last_kf_pts<<oggstream->kfgshift) | pframe_count;
    } else
        granule = pkt->pts + pkt->duration;

471 472 473
    ret = ogg_buffer_data(s, st, pkt->data, pkt->size, granule);
    if (ret < 0)
        return ret;
Baptiste Coudurier's avatar
Baptiste Coudurier committed
474

475
    ogg_write_pages(s, 0);
476

477 478
    oggstream->last_granule = granule;

479
    return 0;
480 481
}

482
static int ogg_write_trailer(AVFormatContext *s)
Baptiste Coudurier's avatar
Baptiste Coudurier committed
483
{
484
    int i;
485

486 487 488
    /* flush current page */
    for (i = 0; i < s->nb_streams; i++)
        ogg_buffer_page(s, s->streams[i]->priv_data);
489

490
    ogg_write_pages(s, 1);
491

Baptiste Coudurier's avatar
Baptiste Coudurier committed
492 493 494
    for (i = 0; i < s->nb_streams; i++) {
        AVStream *st = s->streams[i];
        OGGStreamContext *oggstream = st->priv_data;
495 496
        if (st->codec->codec_id == CODEC_ID_FLAC ||
            st->codec->codec_id == CODEC_ID_SPEEX) {
Baptiste Coudurier's avatar
Baptiste Coudurier committed
497 498 499 500 501 502 503 504 505 506
            av_free(oggstream->header[0]);
            av_free(oggstream->header[1]);
        }
        av_freep(&st->priv_data);
    }
    return 0;
}

AVOutputFormat ogg_muxer = {
    "ogg",
507
    NULL_IF_CONFIG_SMALL("Ogg"),
Baptiste Coudurier's avatar
Baptiste Coudurier committed
508
    "application/ogg",
509
    "ogg,ogv,spx",
510
    sizeof(OGGContext),
Baptiste Coudurier's avatar
Baptiste Coudurier committed
511 512 513 514 515 516
    CODEC_ID_FLAC,
    CODEC_ID_THEORA,
    ogg_write_header,
    ogg_write_packet,
    ogg_write_trailer,
};