3 * Copyright (c) 2007 Baptiste Coudurier <baptiste dot coudurier at free dot fr>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "libavutil/crc.h"
23 #include "libavutil/random_seed.h"
24 #include "libavcodec/xiph.h"
25 #include "libavcodec/bytestream.h"
26 #include "libavcodec/flac.h"
28 #include "avio_internal.h"
30 #include "vorbiscomment.h"
32 #define MAX_PAGE_SIZE 65025
38 uint8_t segments_count;
39 uint8_t segments[255];
40 uint8_t data[MAX_PAGE_SIZE];
45 unsigned page_counter;
48 /** for theora granule */
53 unsigned page_count; ///< number of page buffered
54 OGGPage page; ///< current page
55 unsigned serial_num; ///< serial number
56 int64_t last_granule; ///< last packet granule
59 typedef struct OGGPageList {
61 struct OGGPageList *next;
65 OGGPageList *page_list;
68 static void ogg_update_checksum(AVFormatContext *s, AVIOContext *pb, int64_t crc_offset)
70 int64_t pos = avio_tell(pb);
71 uint32_t checksum = ffio_get_checksum(pb);
72 avio_seek(pb, crc_offset, SEEK_SET);
73 avio_wb32(pb, checksum);
74 avio_seek(pb, pos, SEEK_SET);
77 static int ogg_write_page(AVFormatContext *s, OGGPage *page, int extra_flags)
79 OGGStreamContext *oggstream = s->streams[page->stream_index]->priv_data;
85 ret = avio_open_dyn_buf(&pb);
88 ffio_init_checksum(pb, ff_crc04C11DB7_update, 0);
89 ffio_wfourcc(pb, "OggS");
91 avio_w8(pb, page->flags | extra_flags);
92 avio_wl64(pb, page->granule);
93 avio_wl32(pb, oggstream->serial_num);
94 avio_wl32(pb, oggstream->page_counter++);
95 crc_offset = avio_tell(pb);
96 avio_wl32(pb, 0); // crc
97 avio_w8(pb, page->segments_count);
98 avio_write(pb, page->segments, page->segments_count);
99 avio_write(pb, page->data, page->size);
101 ogg_update_checksum(s, pb, crc_offset);
104 size = avio_close_dyn_buf(pb, &buf);
108 avio_write(s->pb, buf, size);
111 oggstream->page_count--;
115 static int64_t ogg_granule_to_timestamp(OGGStreamContext *oggstream, int64_t granule)
117 if (oggstream->kfgshift)
118 return (granule>>oggstream->kfgshift) +
119 (granule & ((1<<oggstream->kfgshift)-1));
124 static int ogg_compare_granule(AVFormatContext *s, OGGPage *next, OGGPage *page)
126 AVStream *st2 = s->streams[next->stream_index];
127 AVStream *st = s->streams[page->stream_index];
128 int64_t next_granule, cur_granule;
130 if (next->granule == -1 || page->granule == -1)
133 next_granule = av_rescale_q(ogg_granule_to_timestamp(st2->priv_data, next->granule),
134 st2->time_base, AV_TIME_BASE_Q);
135 cur_granule = av_rescale_q(ogg_granule_to_timestamp(st->priv_data, page->granule),
136 st ->time_base, AV_TIME_BASE_Q);
137 return next_granule > cur_granule;
140 static int ogg_reset_cur_page(OGGStreamContext *oggstream)
142 oggstream->page.granule = -1;
143 oggstream->page.flags = 0;
144 oggstream->page.segments_count = 0;
145 oggstream->page.size = 0;
149 static int ogg_buffer_page(AVFormatContext *s, OGGStreamContext *oggstream)
151 OGGContext *ogg = s->priv_data;
152 OGGPageList **p = &ogg->page_list;
153 OGGPageList *l = av_mallocz(sizeof(*l));
156 return AVERROR(ENOMEM);
157 l->page = oggstream->page;
159 oggstream->page_count++;
160 ogg_reset_cur_page(oggstream);
163 if (ogg_compare_granule(s, &(*p)->page, &l->page))
173 static int ogg_buffer_data(AVFormatContext *s, AVStream *st,
174 uint8_t *data, unsigned size, int64_t granule)
176 OGGStreamContext *oggstream = st->priv_data;
177 int total_segments = size / 255 + 1;
179 int i, segments, len, flush = 0;
181 // Handles VFR by flushing page because this frame needs to have a timestamp
182 if (st->codec->codec_id == CODEC_ID_THEORA &&
183 ogg_granule_to_timestamp(oggstream, granule) >
184 ogg_granule_to_timestamp(oggstream, oggstream->last_granule) + 1) {
185 if (oggstream->page.granule != -1)
186 ogg_buffer_page(s, oggstream);
190 for (i = 0; i < total_segments; ) {
191 OGGPage *page = &oggstream->page;
193 segments = FFMIN(total_segments - i, 255 - page->segments_count);
195 if (i && !page->segments_count)
196 page->flags |= 1; // continued packet
198 memset(page->segments+page->segments_count, 255, segments - 1);
199 page->segments_count += segments - 1;
201 len = FFMIN(size, segments*255);
202 page->segments[page->segments_count++] = len - (segments-1)*255;
203 memcpy(page->data+page->size, p, len);
209 if (i == total_segments)
210 page->granule = granule;
212 if (page->segments_count == 255) {
213 ogg_buffer_page(s, oggstream);
217 if (flush && oggstream->page.granule != -1)
218 ogg_buffer_page(s, oggstream);
223 static uint8_t *ogg_write_vorbiscomment(int offset, int bitexact,
224 int *header_len, AVMetadata **m, int framing_bit)
226 const char *vendor = bitexact ? "ffmpeg" : LIBAVFORMAT_IDENT;
231 ff_metadata_conv(m, ff_vorbiscomment_metadata_conv, NULL);
233 size = offset + ff_vorbiscomment_length(*m, vendor, &count) + framing_bit;
234 p = av_mallocz(size);
240 ff_vorbiscomment_write(&p, m, vendor, count);
242 bytestream_put_byte(&p, 1);
248 static int ogg_build_flac_headers(AVCodecContext *avctx,
249 OGGStreamContext *oggstream, int bitexact,
252 enum FLACExtradataFormat format;
256 if (!ff_flac_is_extradata_valid(avctx, &format, &streaminfo))
259 // first packet: STREAMINFO
260 oggstream->header_len[0] = 51;
261 oggstream->header[0] = av_mallocz(51); // per ogg flac specs
262 p = oggstream->header[0];
264 return AVERROR(ENOMEM);
265 bytestream_put_byte(&p, 0x7F);
266 bytestream_put_buffer(&p, "FLAC", 4);
267 bytestream_put_byte(&p, 1); // major version
268 bytestream_put_byte(&p, 0); // minor version
269 bytestream_put_be16(&p, 1); // headers packets without this one
270 bytestream_put_buffer(&p, "fLaC", 4);
271 bytestream_put_byte(&p, 0x00); // streaminfo
272 bytestream_put_be24(&p, 34);
273 bytestream_put_buffer(&p, streaminfo, FLAC_STREAMINFO_SIZE);
275 // second packet: VorbisComment
276 p = ogg_write_vorbiscomment(4, bitexact, &oggstream->header_len[1], m, 0);
278 return AVERROR(ENOMEM);
279 oggstream->header[1] = p;
280 bytestream_put_byte(&p, 0x84); // last metadata block and vorbis comment
281 bytestream_put_be24(&p, oggstream->header_len[1] - 4);
286 #define SPEEX_HEADER_SIZE 80
288 static int ogg_build_speex_headers(AVCodecContext *avctx,
289 OGGStreamContext *oggstream, int bitexact,
294 if (avctx->extradata_size < SPEEX_HEADER_SIZE)
297 // first packet: Speex header
298 p = av_mallocz(SPEEX_HEADER_SIZE);
300 return AVERROR(ENOMEM);
301 oggstream->header[0] = p;
302 oggstream->header_len[0] = SPEEX_HEADER_SIZE;
303 bytestream_put_buffer(&p, avctx->extradata, SPEEX_HEADER_SIZE);
304 AV_WL32(&oggstream->header[0][68], 0); // set extra_headers to 0
306 // second packet: VorbisComment
307 p = ogg_write_vorbiscomment(0, bitexact, &oggstream->header_len[1], m, 0);
309 return AVERROR(ENOMEM);
310 oggstream->header[1] = p;
315 static int ogg_write_header(AVFormatContext *s)
317 OGGStreamContext *oggstream;
320 for (i = 0; i < s->nb_streams; i++) {
321 AVStream *st = s->streams[i];
322 unsigned serial_num = i;
324 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO)
325 av_set_pts_info(st, 64, 1, st->codec->sample_rate);
326 else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
327 av_set_pts_info(st, 64, st->codec->time_base.num, st->codec->time_base.den);
328 if (st->codec->codec_id != CODEC_ID_VORBIS &&
329 st->codec->codec_id != CODEC_ID_THEORA &&
330 st->codec->codec_id != CODEC_ID_SPEEX &&
331 st->codec->codec_id != CODEC_ID_FLAC) {
332 av_log(s, AV_LOG_ERROR, "Unsupported codec id in stream %d\n", i);
336 if (!st->codec->extradata || !st->codec->extradata_size) {
337 av_log(s, AV_LOG_ERROR, "No extradata present\n");
340 oggstream = av_mallocz(sizeof(*oggstream));
341 oggstream->page.stream_index = i;
343 if (!(st->codec->flags & CODEC_FLAG_BITEXACT))
345 serial_num = av_get_random_seed();
346 for (j = 0; j < i; j++) {
347 OGGStreamContext *sc = s->streams[j]->priv_data;
348 if (serial_num == sc->serial_num)
352 oggstream->serial_num = serial_num;
354 st->priv_data = oggstream;
355 if (st->codec->codec_id == CODEC_ID_FLAC) {
356 int err = ogg_build_flac_headers(st->codec, oggstream,
357 st->codec->flags & CODEC_FLAG_BITEXACT,
360 av_log(s, AV_LOG_ERROR, "Error writing FLAC headers\n");
361 av_freep(&st->priv_data);
364 } else if (st->codec->codec_id == CODEC_ID_SPEEX) {
365 int err = ogg_build_speex_headers(st->codec, oggstream,
366 st->codec->flags & CODEC_FLAG_BITEXACT,
369 av_log(s, AV_LOG_ERROR, "Error writing Speex headers\n");
370 av_freep(&st->priv_data);
375 const char *cstr = st->codec->codec_id == CODEC_ID_VORBIS ? "vorbis" : "theora";
376 int header_type = st->codec->codec_id == CODEC_ID_VORBIS ? 3 : 0x81;
377 int framing_bit = st->codec->codec_id == CODEC_ID_VORBIS ? 1 : 0;
379 if (ff_split_xiph_headers(st->codec->extradata, st->codec->extradata_size,
380 st->codec->codec_id == CODEC_ID_VORBIS ? 30 : 42,
381 oggstream->header, oggstream->header_len) < 0) {
382 av_log(s, AV_LOG_ERROR, "Extradata corrupted\n");
383 av_freep(&st->priv_data);
387 p = ogg_write_vorbiscomment(7, st->codec->flags & CODEC_FLAG_BITEXACT,
388 &oggstream->header_len[1], &s->metadata,
391 return AVERROR(ENOMEM);
393 oggstream->header[1] = p;
394 bytestream_put_byte(&p, header_type);
395 bytestream_put_buffer(&p, cstr, 6);
397 if (st->codec->codec_id == CODEC_ID_THEORA) {
398 /** KFGSHIFT is the width of the less significant section of the granule position
399 The less significant section is the frame count since the last keyframe */
400 oggstream->kfgshift = ((oggstream->header[0][40]&3)<<3)|(oggstream->header[0][41]>>5);
401 oggstream->vrev = oggstream->header[0][9];
402 av_log(s, AV_LOG_DEBUG, "theora kfgshift %d, vrev %d\n",
403 oggstream->kfgshift, oggstream->vrev);
408 for (j = 0; j < s->nb_streams; j++) {
409 OGGStreamContext *oggstream = s->streams[j]->priv_data;
410 ogg_buffer_data(s, s->streams[j], oggstream->header[0],
411 oggstream->header_len[0], 0);
412 oggstream->page.flags |= 2; // bos
413 ogg_buffer_page(s, oggstream);
415 for (j = 0; j < s->nb_streams; j++) {
416 AVStream *st = s->streams[j];
417 OGGStreamContext *oggstream = st->priv_data;
418 for (i = 1; i < 3; i++) {
419 if (oggstream && oggstream->header_len[i])
420 ogg_buffer_data(s, st, oggstream->header[i],
421 oggstream->header_len[i], 0);
423 ogg_buffer_page(s, oggstream);
428 static void ogg_write_pages(AVFormatContext *s, int flush)
430 OGGContext *ogg = s->priv_data;
431 OGGPageList *next, *p;
436 for (p = ogg->page_list; p; ) {
437 OGGStreamContext *oggstream =
438 s->streams[p->page.stream_index]->priv_data;
439 if (oggstream->page_count < 2 && !flush)
441 ogg_write_page(s, &p->page,
442 flush && oggstream->page_count == 1 ? 4 : 0); // eos
450 static int ogg_write_packet(AVFormatContext *s, AVPacket *pkt)
452 AVStream *st = s->streams[pkt->stream_index];
453 OGGStreamContext *oggstream = st->priv_data;
457 if (st->codec->codec_id == CODEC_ID_THEORA) {
458 int64_t pts = oggstream->vrev < 1 ? pkt->pts : pkt->pts + pkt->duration;
460 if (pkt->flags & AV_PKT_FLAG_KEY)
461 oggstream->last_kf_pts = pts;
462 pframe_count = pts - oggstream->last_kf_pts;
463 // prevent frame count from overflow if key frame flag is not set
464 if (pframe_count >= (1<<oggstream->kfgshift)) {
465 oggstream->last_kf_pts += pframe_count;
468 granule = (oggstream->last_kf_pts<<oggstream->kfgshift) | pframe_count;
470 granule = pkt->pts + pkt->duration;
472 ret = ogg_buffer_data(s, st, pkt->data, pkt->size, granule);
476 ogg_write_pages(s, 0);
478 oggstream->last_granule = granule;
483 static int ogg_write_trailer(AVFormatContext *s)
487 /* flush current page */
488 for (i = 0; i < s->nb_streams; i++)
489 ogg_buffer_page(s, s->streams[i]->priv_data);
491 ogg_write_pages(s, 1);
493 for (i = 0; i < s->nb_streams; i++) {
494 AVStream *st = s->streams[i];
495 OGGStreamContext *oggstream = st->priv_data;
496 if (st->codec->codec_id == CODEC_ID_FLAC ||
497 st->codec->codec_id == CODEC_ID_SPEEX) {
498 av_free(oggstream->header[0]);
499 av_free(oggstream->header[1]);
501 av_freep(&st->priv_data);
506 AVOutputFormat ff_ogg_muxer = {
508 NULL_IF_CONFIG_SMALL("Ogg"),