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/opt.h"
24 #include "libavutil/mathematics.h"
25 #include "libavutil/random_seed.h"
26 #include "libavcodec/xiph.h"
27 #include "libavcodec/bytestream.h"
28 #include "libavcodec/flac.h"
30 #include "avio_internal.h"
32 #include "vorbiscomment.h"
34 #define MAX_PAGE_SIZE 65025
40 uint8_t segments_count;
41 uint8_t segments[255];
42 uint8_t data[MAX_PAGE_SIZE];
47 unsigned page_counter;
50 /** for theora granule */
55 unsigned page_count; ///< number of page buffered
56 OGGPage page; ///< current page
57 unsigned serial_num; ///< serial number
58 int64_t last_granule; ///< last packet granule
61 typedef struct OGGPageList {
63 struct OGGPageList *next;
68 OGGPageList *page_list;
69 int pref_size; ///< preferred page size (0 => fill all segments)
73 static const AVOption options[] = {
74 { "oggpagesize", "Set preferred Ogg page size.",
75 offsetof(OGGContext, pref_size), AV_OPT_TYPE_INT, {.dbl = 0}, 0, MAX_PAGE_SIZE, AV_OPT_FLAG_ENCODING_PARAM},
79 static const AVClass ogg_muxer_class = {
83 LIBAVUTIL_VERSION_INT,
87 static void ogg_update_checksum(AVFormatContext *s, AVIOContext *pb, int64_t crc_offset)
89 int64_t pos = avio_tell(pb);
90 uint32_t checksum = ffio_get_checksum(pb);
91 avio_seek(pb, crc_offset, SEEK_SET);
92 avio_wb32(pb, checksum);
93 avio_seek(pb, pos, SEEK_SET);
96 static int ogg_write_page(AVFormatContext *s, OGGPage *page, int extra_flags)
98 OGGStreamContext *oggstream = s->streams[page->stream_index]->priv_data;
104 ret = avio_open_dyn_buf(&pb);
107 ffio_init_checksum(pb, ff_crc04C11DB7_update, 0);
108 ffio_wfourcc(pb, "OggS");
110 avio_w8(pb, page->flags | extra_flags);
111 avio_wl64(pb, page->granule);
112 avio_wl32(pb, oggstream->serial_num);
113 avio_wl32(pb, oggstream->page_counter++);
114 crc_offset = avio_tell(pb);
115 avio_wl32(pb, 0); // crc
116 avio_w8(pb, page->segments_count);
117 avio_write(pb, page->segments, page->segments_count);
118 avio_write(pb, page->data, page->size);
120 ogg_update_checksum(s, pb, crc_offset);
123 size = avio_close_dyn_buf(pb, &buf);
127 avio_write(s->pb, buf, size);
130 oggstream->page_count--;
134 static int ogg_key_granule(OGGStreamContext *oggstream, int64_t granule)
136 return oggstream->kfgshift && !(granule & ((1<<oggstream->kfgshift)-1));
139 static int64_t ogg_granule_to_timestamp(OGGStreamContext *oggstream, int64_t granule)
141 if (oggstream->kfgshift)
142 return (granule>>oggstream->kfgshift) +
143 (granule & ((1<<oggstream->kfgshift)-1));
148 static int ogg_compare_granule(AVFormatContext *s, OGGPage *next, OGGPage *page)
150 AVStream *st2 = s->streams[next->stream_index];
151 AVStream *st = s->streams[page->stream_index];
152 int64_t next_granule, cur_granule;
154 if (next->granule == -1 || page->granule == -1)
157 next_granule = av_rescale_q(ogg_granule_to_timestamp(st2->priv_data, next->granule),
158 st2->time_base, AV_TIME_BASE_Q);
159 cur_granule = av_rescale_q(ogg_granule_to_timestamp(st->priv_data, page->granule),
160 st ->time_base, AV_TIME_BASE_Q);
161 return next_granule > cur_granule;
164 static int ogg_reset_cur_page(OGGStreamContext *oggstream)
166 oggstream->page.granule = -1;
167 oggstream->page.flags = 0;
168 oggstream->page.segments_count = 0;
169 oggstream->page.size = 0;
173 static int ogg_buffer_page(AVFormatContext *s, OGGStreamContext *oggstream)
175 OGGContext *ogg = s->priv_data;
176 OGGPageList **p = &ogg->page_list;
177 OGGPageList *l = av_mallocz(sizeof(*l));
180 return AVERROR(ENOMEM);
181 l->page = oggstream->page;
183 oggstream->page_count++;
184 ogg_reset_cur_page(oggstream);
187 if (ogg_compare_granule(s, &(*p)->page, &l->page))
197 static int ogg_buffer_data(AVFormatContext *s, AVStream *st,
198 uint8_t *data, unsigned size, int64_t granule)
200 OGGStreamContext *oggstream = st->priv_data;
201 OGGContext *ogg = s->priv_data;
202 int total_segments = size / 255 + 1;
204 int i, segments, len, flush = 0;
206 // Handles VFR by flushing page because this frame needs to have a timestamp
207 // For theora, keyframes also need to have a timestamp to correctly mark
208 // them as such, otherwise seeking will not work correctly at the very
209 // least with old libogg versions.
210 // Do not try to flush empty packets though, that will create broken files.
211 if (st->codec->codec_id == CODEC_ID_THEORA &&
212 oggstream->page.size &&
213 (ogg_granule_to_timestamp(oggstream, granule) >
214 ogg_granule_to_timestamp(oggstream, oggstream->last_granule) + 1 ||
215 ogg_key_granule(oggstream, granule))) {
216 if (oggstream->page.granule != -1)
217 ogg_buffer_page(s, oggstream);
221 for (i = 0; i < total_segments; ) {
222 OGGPage *page = &oggstream->page;
224 segments = FFMIN(total_segments - i, 255 - page->segments_count);
226 if (i && !page->segments_count)
227 page->flags |= 1; // continued packet
229 memset(page->segments+page->segments_count, 255, segments - 1);
230 page->segments_count += segments - 1;
232 len = FFMIN(size, segments*255);
233 page->segments[page->segments_count++] = len - (segments-1)*255;
234 memcpy(page->data+page->size, p, len);
240 if (i == total_segments)
241 page->granule = granule;
243 if(page->segments_count == 255 ||
244 (ogg->pref_size > 0 && page->size >= ogg->pref_size)) {
245 ogg_buffer_page(s, oggstream);
249 if (flush && oggstream->page.granule != -1)
250 ogg_buffer_page(s, oggstream);
255 static uint8_t *ogg_write_vorbiscomment(int offset, int bitexact,
256 int *header_len, AVDictionary **m, int framing_bit)
258 const char *vendor = bitexact ? "ffmpeg" : LIBAVFORMAT_IDENT;
263 ff_metadata_conv(m, ff_vorbiscomment_metadata_conv, NULL);
265 size = offset + ff_vorbiscomment_length(*m, vendor, &count) + framing_bit;
266 p = av_mallocz(size);
272 ff_vorbiscomment_write(&p, m, vendor, count);
274 bytestream_put_byte(&p, 1);
280 static int ogg_build_flac_headers(AVCodecContext *avctx,
281 OGGStreamContext *oggstream, int bitexact,
284 enum FLACExtradataFormat format;
288 if (!avpriv_flac_is_extradata_valid(avctx, &format, &streaminfo))
291 // first packet: STREAMINFO
292 oggstream->header_len[0] = 51;
293 oggstream->header[0] = av_mallocz(51); // per ogg flac specs
294 p = oggstream->header[0];
296 return AVERROR(ENOMEM);
297 bytestream_put_byte(&p, 0x7F);
298 bytestream_put_buffer(&p, "FLAC", 4);
299 bytestream_put_byte(&p, 1); // major version
300 bytestream_put_byte(&p, 0); // minor version
301 bytestream_put_be16(&p, 1); // headers packets without this one
302 bytestream_put_buffer(&p, "fLaC", 4);
303 bytestream_put_byte(&p, 0x00); // streaminfo
304 bytestream_put_be24(&p, 34);
305 bytestream_put_buffer(&p, streaminfo, FLAC_STREAMINFO_SIZE);
307 // second packet: VorbisComment
308 p = ogg_write_vorbiscomment(4, bitexact, &oggstream->header_len[1], m, 0);
310 return AVERROR(ENOMEM);
311 oggstream->header[1] = p;
312 bytestream_put_byte(&p, 0x84); // last metadata block and vorbis comment
313 bytestream_put_be24(&p, oggstream->header_len[1] - 4);
318 #define SPEEX_HEADER_SIZE 80
320 static int ogg_build_speex_headers(AVCodecContext *avctx,
321 OGGStreamContext *oggstream, int bitexact,
326 if (avctx->extradata_size < SPEEX_HEADER_SIZE)
329 // first packet: Speex header
330 p = av_mallocz(SPEEX_HEADER_SIZE);
332 return AVERROR(ENOMEM);
333 oggstream->header[0] = p;
334 oggstream->header_len[0] = SPEEX_HEADER_SIZE;
335 bytestream_put_buffer(&p, avctx->extradata, SPEEX_HEADER_SIZE);
336 AV_WL32(&oggstream->header[0][68], 0); // set extra_headers to 0
338 // second packet: VorbisComment
339 p = ogg_write_vorbiscomment(0, bitexact, &oggstream->header_len[1], m, 0);
341 return AVERROR(ENOMEM);
342 oggstream->header[1] = p;
347 static int ogg_write_header(AVFormatContext *s)
349 OGGStreamContext *oggstream;
352 for (i = 0; i < s->nb_streams; i++) {
353 AVStream *st = s->streams[i];
354 unsigned serial_num = i;
356 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO)
357 avpriv_set_pts_info(st, 64, 1, st->codec->sample_rate);
358 else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
359 avpriv_set_pts_info(st, 64, st->codec->time_base.num, st->codec->time_base.den);
360 if (st->codec->codec_id != CODEC_ID_VORBIS &&
361 st->codec->codec_id != CODEC_ID_THEORA &&
362 st->codec->codec_id != CODEC_ID_SPEEX &&
363 st->codec->codec_id != CODEC_ID_FLAC) {
364 av_log(s, AV_LOG_ERROR, "Unsupported codec id in stream %d\n", i);
368 if (!st->codec->extradata || !st->codec->extradata_size) {
369 av_log(s, AV_LOG_ERROR, "No extradata present\n");
372 oggstream = av_mallocz(sizeof(*oggstream));
373 oggstream->page.stream_index = i;
375 if (!(st->codec->flags & CODEC_FLAG_BITEXACT))
377 serial_num = av_get_random_seed();
378 for (j = 0; j < i; j++) {
379 OGGStreamContext *sc = s->streams[j]->priv_data;
380 if (serial_num == sc->serial_num)
384 oggstream->serial_num = serial_num;
386 st->priv_data = oggstream;
387 if (st->codec->codec_id == CODEC_ID_FLAC) {
388 int err = ogg_build_flac_headers(st->codec, oggstream,
389 st->codec->flags & CODEC_FLAG_BITEXACT,
392 av_log(s, AV_LOG_ERROR, "Error writing FLAC headers\n");
393 av_freep(&st->priv_data);
396 } else if (st->codec->codec_id == CODEC_ID_SPEEX) {
397 int err = ogg_build_speex_headers(st->codec, oggstream,
398 st->codec->flags & CODEC_FLAG_BITEXACT,
401 av_log(s, AV_LOG_ERROR, "Error writing Speex headers\n");
402 av_freep(&st->priv_data);
407 const char *cstr = st->codec->codec_id == CODEC_ID_VORBIS ? "vorbis" : "theora";
408 int header_type = st->codec->codec_id == CODEC_ID_VORBIS ? 3 : 0x81;
409 int framing_bit = st->codec->codec_id == CODEC_ID_VORBIS ? 1 : 0;
411 if (avpriv_split_xiph_headers(st->codec->extradata, st->codec->extradata_size,
412 st->codec->codec_id == CODEC_ID_VORBIS ? 30 : 42,
413 oggstream->header, oggstream->header_len) < 0) {
414 av_log(s, AV_LOG_ERROR, "Extradata corrupted\n");
415 av_freep(&st->priv_data);
419 p = ogg_write_vorbiscomment(7, st->codec->flags & CODEC_FLAG_BITEXACT,
420 &oggstream->header_len[1], &s->metadata,
423 return AVERROR(ENOMEM);
425 oggstream->header[1] = p;
426 bytestream_put_byte(&p, header_type);
427 bytestream_put_buffer(&p, cstr, 6);
429 if (st->codec->codec_id == CODEC_ID_THEORA) {
430 /** KFGSHIFT is the width of the less significant section of the granule position
431 The less significant section is the frame count since the last keyframe */
432 oggstream->kfgshift = ((oggstream->header[0][40]&3)<<3)|(oggstream->header[0][41]>>5);
433 oggstream->vrev = oggstream->header[0][9];
434 av_log(s, AV_LOG_DEBUG, "theora kfgshift %d, vrev %d\n",
435 oggstream->kfgshift, oggstream->vrev);
440 for (j = 0; j < s->nb_streams; j++) {
441 OGGStreamContext *oggstream = s->streams[j]->priv_data;
442 ogg_buffer_data(s, s->streams[j], oggstream->header[0],
443 oggstream->header_len[0], 0);
444 oggstream->page.flags |= 2; // bos
445 ogg_buffer_page(s, oggstream);
447 for (j = 0; j < s->nb_streams; j++) {
448 AVStream *st = s->streams[j];
449 OGGStreamContext *oggstream = st->priv_data;
450 for (i = 1; i < 3; i++) {
451 if (oggstream && oggstream->header_len[i])
452 ogg_buffer_data(s, st, oggstream->header[i],
453 oggstream->header_len[i], 0);
455 ogg_buffer_page(s, oggstream);
460 static void ogg_write_pages(AVFormatContext *s, int flush)
462 OGGContext *ogg = s->priv_data;
463 OGGPageList *next, *p;
468 for (p = ogg->page_list; p; ) {
469 OGGStreamContext *oggstream =
470 s->streams[p->page.stream_index]->priv_data;
471 if (oggstream->page_count < 2 && !flush)
473 ogg_write_page(s, &p->page,
474 flush && oggstream->page_count == 1 ? 4 : 0); // eos
482 static int ogg_write_packet(AVFormatContext *s, AVPacket *pkt)
484 AVStream *st = s->streams[pkt->stream_index];
485 OGGStreamContext *oggstream = st->priv_data;
489 if (st->codec->codec_id == CODEC_ID_THEORA) {
490 int64_t pts = oggstream->vrev < 1 ? pkt->pts : pkt->pts + pkt->duration;
492 if (pkt->flags & AV_PKT_FLAG_KEY)
493 oggstream->last_kf_pts = pts;
494 pframe_count = pts - oggstream->last_kf_pts;
495 // prevent frame count from overflow if key frame flag is not set
496 if (pframe_count >= (1<<oggstream->kfgshift)) {
497 oggstream->last_kf_pts += pframe_count;
500 granule = (oggstream->last_kf_pts<<oggstream->kfgshift) | pframe_count;
502 granule = pkt->pts + pkt->duration;
504 ret = ogg_buffer_data(s, st, pkt->data, pkt->size, granule);
508 ogg_write_pages(s, 0);
510 oggstream->last_granule = granule;
515 static int ogg_write_trailer(AVFormatContext *s)
519 /* flush current page */
520 for (i = 0; i < s->nb_streams; i++)
521 ogg_buffer_page(s, s->streams[i]->priv_data);
523 ogg_write_pages(s, 1);
525 for (i = 0; i < s->nb_streams; i++) {
526 AVStream *st = s->streams[i];
527 OGGStreamContext *oggstream = st->priv_data;
528 if (st->codec->codec_id == CODEC_ID_FLAC ||
529 st->codec->codec_id == CODEC_ID_SPEEX) {
530 av_freep(&oggstream->header[0]);
531 av_freep(&oggstream->header[1]);
534 av_freep(&oggstream->header[1]);
535 av_freep(&st->priv_data);
540 AVOutputFormat ff_ogg_muxer = {
542 .long_name = NULL_IF_CONFIG_SMALL("Ogg"),
543 .mime_type = "application/ogg",
544 .extensions = "ogg,ogv,spx",
545 .priv_data_size = sizeof(OGGContext),
546 .audio_codec = CODEC_ID_FLAC,
547 .video_codec = CODEC_ID_THEORA,
548 .write_header = ogg_write_header,
549 .write_packet = ogg_write_packet,
550 .write_trailer = ogg_write_trailer,
551 .priv_class = &ogg_muxer_class,