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"
29 #include "vorbiscomment.h"
31 #define MAX_PAGE_SIZE 65025
37 uint8_t segments_count;
38 uint8_t segments[255];
39 uint8_t data[MAX_PAGE_SIZE];
44 unsigned page_counter;
47 /** for theora granule */
52 unsigned page_count; ///< number of page buffered
53 OGGPage page; ///< current page
54 unsigned serial_num; ///< serial number
57 typedef struct OGGPageList {
59 struct OGGPageList *next;
63 OGGPageList *page_list;
66 static void ogg_update_checksum(AVFormatContext *s, ByteIOContext *pb, int64_t crc_offset)
68 int64_t pos = url_ftell(pb);
69 uint32_t checksum = get_checksum(pb);
70 url_fseek(pb, crc_offset, SEEK_SET);
71 put_be32(pb, checksum);
72 url_fseek(pb, pos, SEEK_SET);
75 static int ogg_write_page(AVFormatContext *s, OGGPage *page, int extra_flags)
77 OGGStreamContext *oggstream = s->streams[page->stream_index]->priv_data;
83 ret = url_open_dyn_buf(&pb);
86 init_checksum(pb, ff_crc04C11DB7_update, 0);
89 put_byte(pb, page->flags | extra_flags);
90 put_le64(pb, page->granule);
91 put_le32(pb, oggstream->serial_num);
92 put_le32(pb, oggstream->page_counter++);
93 crc_offset = url_ftell(pb);
94 put_le32(pb, 0); // crc
95 put_byte(pb, page->segments_count);
96 put_buffer(pb, page->segments, page->segments_count);
97 put_buffer(pb, page->data, page->size);
99 ogg_update_checksum(s, pb, crc_offset);
100 put_flush_packet(pb);
102 size = url_close_dyn_buf(pb, &buf);
106 put_buffer(s->pb, buf, size);
107 put_flush_packet(s->pb);
109 oggstream->page_count--;
113 static int64_t ogg_granule_to_timestamp(OGGStreamContext *oggstream, OGGPage *page)
115 if (oggstream->kfgshift)
116 return (page->granule>>oggstream->kfgshift) +
117 (page->granule & ((1<<oggstream->kfgshift)-1));
119 return page->granule;
122 static int ogg_compare_granule(AVFormatContext *s, OGGPage *next, OGGPage *page)
124 AVStream *st2 = s->streams[next->stream_index];
125 AVStream *st = s->streams[page->stream_index];
126 int64_t next_granule, cur_granule;
128 if (next->granule == -1 || page->granule == -1)
131 next_granule = av_rescale_q(ogg_granule_to_timestamp(st2->priv_data, next),
132 st2->time_base, AV_TIME_BASE_Q);
133 cur_granule = av_rescale_q(ogg_granule_to_timestamp(st->priv_data, page),
134 st ->time_base, AV_TIME_BASE_Q);
135 return next_granule > cur_granule;
138 static int ogg_reset_cur_page(OGGStreamContext *oggstream)
140 oggstream->page.granule = -1;
141 oggstream->page.flags = 0;
142 oggstream->page.segments_count = 0;
143 oggstream->page.size = 0;
147 static int ogg_buffer_page(AVFormatContext *s, OGGStreamContext *oggstream)
149 OGGContext *ogg = s->priv_data;
150 OGGPageList **p = &ogg->page_list;
151 OGGPageList *l = av_mallocz(sizeof(*l));
154 return AVERROR(ENOMEM);
155 l->page = oggstream->page;
157 oggstream->page_count++;
158 ogg_reset_cur_page(oggstream);
161 if (ogg_compare_granule(s, &(*p)->page, &l->page))
171 static int ogg_buffer_data(AVFormatContext *s, AVStream *st,
172 uint8_t *data, unsigned size, int64_t granule)
174 OGGStreamContext *oggstream = st->priv_data;
175 int total_segments = size / 255 + 1;
177 int i, segments, len;
179 for (i = 0; i < total_segments; ) {
180 OGGPage *page = &oggstream->page;
182 segments = FFMIN(total_segments - i, 255 - page->segments_count);
184 if (i && !page->segments_count)
185 page->flags |= 1; // continued packet
187 memset(page->segments+page->segments_count, 255, segments - 1);
188 page->segments_count += segments - 1;
190 len = FFMIN(size, segments*255);
191 page->segments[page->segments_count++] = len - (segments-1)*255;
192 memcpy(page->data+page->size, p, len);
198 if (i == total_segments)
199 page->granule = granule;
201 if (page->segments_count == 255) {
202 ogg_buffer_page(s, oggstream);
208 static uint8_t *ogg_write_vorbiscomment(int offset, int bitexact,
209 int *header_len, AVMetadata *m)
211 const char *vendor = bitexact ? "ffmpeg" : LIBAVFORMAT_IDENT;
216 size = offset + ff_vorbiscomment_length(m, vendor, &count);
217 p = av_mallocz(size);
223 ff_vorbiscomment_write(&p, m, vendor, count);
229 static int ogg_build_flac_headers(AVCodecContext *avctx,
230 OGGStreamContext *oggstream, int bitexact,
233 enum FLACExtradataFormat format;
237 if (!ff_flac_is_extradata_valid(avctx, &format, &streaminfo))
240 // first packet: STREAMINFO
241 oggstream->header_len[0] = 51;
242 oggstream->header[0] = av_mallocz(51); // per ogg flac specs
243 p = oggstream->header[0];
245 return AVERROR(ENOMEM);
246 bytestream_put_byte(&p, 0x7F);
247 bytestream_put_buffer(&p, "FLAC", 4);
248 bytestream_put_byte(&p, 1); // major version
249 bytestream_put_byte(&p, 0); // minor version
250 bytestream_put_be16(&p, 1); // headers packets without this one
251 bytestream_put_buffer(&p, "fLaC", 4);
252 bytestream_put_byte(&p, 0x00); // streaminfo
253 bytestream_put_be24(&p, 34);
254 bytestream_put_buffer(&p, streaminfo, FLAC_STREAMINFO_SIZE);
256 // second packet: VorbisComment
257 p = ogg_write_vorbiscomment(4, bitexact, &oggstream->header_len[1], m);
259 return AVERROR(ENOMEM);
260 oggstream->header[1] = p;
261 bytestream_put_byte(&p, 0x84); // last metadata block and vorbis comment
262 bytestream_put_be24(&p, oggstream->header_len[1] - 4);
267 #define SPEEX_HEADER_SIZE 80
269 static int ogg_build_speex_headers(AVCodecContext *avctx,
270 OGGStreamContext *oggstream, int bitexact,
275 if (avctx->extradata_size < SPEEX_HEADER_SIZE)
278 // first packet: Speex header
279 p = av_mallocz(SPEEX_HEADER_SIZE);
281 return AVERROR(ENOMEM);
282 oggstream->header[0] = p;
283 oggstream->header_len[0] = SPEEX_HEADER_SIZE;
284 bytestream_put_buffer(&p, avctx->extradata, SPEEX_HEADER_SIZE);
285 AV_WL32(&oggstream->header[0][68], 0); // set extra_headers to 0
287 // second packet: VorbisComment
288 p = ogg_write_vorbiscomment(0, bitexact, &oggstream->header_len[1], m);
290 return AVERROR(ENOMEM);
291 oggstream->header[1] = p;
296 static int ogg_write_header(AVFormatContext *s)
298 OGGStreamContext *oggstream;
301 for (i = 0; i < s->nb_streams; i++) {
302 AVStream *st = s->streams[i];
303 unsigned serial_num = i;
305 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO)
306 av_set_pts_info(st, 64, 1, st->codec->sample_rate);
307 else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
308 av_set_pts_info(st, 64, st->codec->time_base.num, st->codec->time_base.den);
309 if (st->codec->codec_id != CODEC_ID_VORBIS &&
310 st->codec->codec_id != CODEC_ID_THEORA &&
311 st->codec->codec_id != CODEC_ID_SPEEX &&
312 st->codec->codec_id != CODEC_ID_FLAC) {
313 av_log(s, AV_LOG_ERROR, "Unsupported codec id in stream %d\n", i);
317 if (!st->codec->extradata || !st->codec->extradata_size) {
318 av_log(s, AV_LOG_ERROR, "No extradata present\n");
321 oggstream = av_mallocz(sizeof(*oggstream));
322 oggstream->page.stream_index = i;
324 if (!(st->codec->flags & CODEC_FLAG_BITEXACT))
326 serial_num = av_get_random_seed();
327 for (j = 0; j < i; j++) {
328 OGGStreamContext *sc = s->streams[j]->priv_data;
329 if (serial_num == sc->serial_num)
333 oggstream->serial_num = serial_num;
335 st->priv_data = oggstream;
336 if (st->codec->codec_id == CODEC_ID_FLAC) {
337 int err = ogg_build_flac_headers(st->codec, oggstream,
338 st->codec->flags & CODEC_FLAG_BITEXACT,
341 av_log(s, AV_LOG_ERROR, "Error writing FLAC headers\n");
342 av_freep(&st->priv_data);
345 } else if (st->codec->codec_id == CODEC_ID_SPEEX) {
346 int err = ogg_build_speex_headers(st->codec, oggstream,
347 st->codec->flags & CODEC_FLAG_BITEXACT,
350 av_log(s, AV_LOG_ERROR, "Error writing Speex headers\n");
351 av_freep(&st->priv_data);
355 if (ff_split_xiph_headers(st->codec->extradata, st->codec->extradata_size,
356 st->codec->codec_id == CODEC_ID_VORBIS ? 30 : 42,
357 oggstream->header, oggstream->header_len) < 0) {
358 av_log(s, AV_LOG_ERROR, "Extradata corrupted\n");
359 av_freep(&st->priv_data);
362 if (st->codec->codec_id == CODEC_ID_THEORA) {
363 /** KFGSHIFT is the width of the less significant section of the granule position
364 The less significant section is the frame count since the last keyframe */
365 oggstream->kfgshift = ((oggstream->header[0][40]&3)<<3)|(oggstream->header[0][41]>>5);
366 oggstream->vrev = oggstream->header[0][9];
367 av_log(s, AV_LOG_DEBUG, "theora kfgshift %d, vrev %d\n",
368 oggstream->kfgshift, oggstream->vrev);
373 for (j = 0; j < s->nb_streams; j++) {
374 OGGStreamContext *oggstream = s->streams[j]->priv_data;
375 ogg_buffer_data(s, s->streams[j], oggstream->header[0],
376 oggstream->header_len[0], 0);
377 oggstream->page.flags |= 2; // bos
378 ogg_buffer_page(s, oggstream);
380 for (j = 0; j < s->nb_streams; j++) {
381 AVStream *st = s->streams[j];
382 OGGStreamContext *oggstream = st->priv_data;
383 for (i = 1; i < 3; i++) {
384 if (oggstream && oggstream->header_len[i])
385 ogg_buffer_data(s, st, oggstream->header[i],
386 oggstream->header_len[i], 0);
388 ogg_buffer_page(s, oggstream);
393 static void ogg_write_pages(AVFormatContext *s, int flush)
395 OGGContext *ogg = s->priv_data;
396 OGGPageList *next, *p;
401 for (p = ogg->page_list; p; ) {
402 OGGStreamContext *oggstream =
403 s->streams[p->page.stream_index]->priv_data;
404 if (oggstream->page_count < 2 && !flush)
406 ogg_write_page(s, &p->page,
407 flush && oggstream->page_count == 1 ? 4 : 0); // eos
415 static int ogg_write_packet(AVFormatContext *s, AVPacket *pkt)
417 AVStream *st = s->streams[pkt->stream_index];
418 OGGStreamContext *oggstream = st->priv_data;
422 if (st->codec->codec_id == CODEC_ID_THEORA) {
423 int64_t pts = oggstream->vrev < 1 ? pkt->pts : pkt->pts + pkt->duration;
425 if (pkt->flags & AV_PKT_FLAG_KEY)
426 oggstream->last_kf_pts = pts;
427 pframe_count = pts - oggstream->last_kf_pts;
428 // prevent frame count from overflow if key frame flag is not set
429 if (pframe_count >= (1<<oggstream->kfgshift)) {
430 oggstream->last_kf_pts += pframe_count;
433 granule = (oggstream->last_kf_pts<<oggstream->kfgshift) | pframe_count;
435 granule = pkt->pts + pkt->duration;
437 ret = ogg_buffer_data(s, st, pkt->data, pkt->size, granule);
441 ogg_write_pages(s, 0);
446 static int ogg_write_trailer(AVFormatContext *s)
450 /* flush current page */
451 for (i = 0; i < s->nb_streams; i++)
452 ogg_buffer_page(s, s->streams[i]->priv_data);
454 ogg_write_pages(s, 1);
456 for (i = 0; i < s->nb_streams; i++) {
457 AVStream *st = s->streams[i];
458 OGGStreamContext *oggstream = st->priv_data;
459 if (st->codec->codec_id == CODEC_ID_FLAC ||
460 st->codec->codec_id == CODEC_ID_SPEEX) {
461 av_free(oggstream->header[0]);
462 av_free(oggstream->header[1]);
464 av_freep(&st->priv_data);
469 AVOutputFormat ogg_muxer = {
471 NULL_IF_CONFIG_SMALL("Ogg"),
480 .metadata_conv = ff_vorbiscomment_metadata_conv,