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 "libavcodec/xiph.h"
24 #include "libavcodec/bytestream.h"
25 #include "libavcodec/flac.h"
28 #include "vorbiscomment.h"
32 unsigned page_counter;
35 /** for theora granule */
40 unsigned packet_count; ///< number of packet buffered
43 static void ogg_update_checksum(AVFormatContext *s, int64_t crc_offset)
45 int64_t pos = url_ftell(s->pb);
46 uint32_t checksum = get_checksum(s->pb);
47 url_fseek(s->pb, crc_offset, SEEK_SET);
48 put_be32(s->pb, checksum);
49 url_fseek(s->pb, pos, SEEK_SET);
52 static int ogg_write_page(AVFormatContext *s, const uint8_t *data, int size,
53 int64_t granule, int stream_index, int flags)
55 OGGStreamContext *oggstream = s->streams[stream_index]->priv_data;
59 if (size >= 255*255) {
62 } else if (oggstream->eos)
65 page_segments = FFMIN(size/255 + 1, 255);
67 init_checksum(s->pb, ff_crc04C11DB7_update, 0);
68 put_tag(s->pb, "OggS");
70 put_byte(s->pb, flags);
71 put_le64(s->pb, granule);
72 put_le32(s->pb, stream_index);
73 put_le32(s->pb, oggstream->page_counter++);
74 crc_offset = url_ftell(s->pb);
75 put_le32(s->pb, 0); // crc
76 put_byte(s->pb, page_segments);
77 for (i = 0; i < page_segments-1; i++)
79 put_byte(s->pb, size - (page_segments-1)*255);
80 put_buffer(s->pb, data, size);
82 ogg_update_checksum(s, crc_offset);
83 put_flush_packet(s->pb);
87 static uint8_t *ogg_write_vorbiscomment(int offset, int bitexact,
88 int *header_len, AVMetadata *m)
90 const char *vendor = bitexact ? "ffmpeg" : LIBAVFORMAT_IDENT;
95 size = offset + ff_vorbiscomment_length(m, vendor, &count);
102 ff_vorbiscomment_write(&p, m, vendor, count);
108 static int ogg_build_flac_headers(AVCodecContext *avctx,
109 OGGStreamContext *oggstream, int bitexact,
112 enum FLACExtradataFormat format;
116 if (!ff_flac_is_extradata_valid(avctx, &format, &streaminfo))
119 // first packet: STREAMINFO
120 oggstream->header_len[0] = 51;
121 oggstream->header[0] = av_mallocz(51); // per ogg flac specs
122 p = oggstream->header[0];
124 return AVERROR(ENOMEM);
125 bytestream_put_byte(&p, 0x7F);
126 bytestream_put_buffer(&p, "FLAC", 4);
127 bytestream_put_byte(&p, 1); // major version
128 bytestream_put_byte(&p, 0); // minor version
129 bytestream_put_be16(&p, 1); // headers packets without this one
130 bytestream_put_buffer(&p, "fLaC", 4);
131 bytestream_put_byte(&p, 0x00); // streaminfo
132 bytestream_put_be24(&p, 34);
133 bytestream_put_buffer(&p, streaminfo, FLAC_STREAMINFO_SIZE);
135 // second packet: VorbisComment
136 p = ogg_write_vorbiscomment(4, bitexact, &oggstream->header_len[1], m);
138 return AVERROR(ENOMEM);
139 oggstream->header[1] = p;
140 bytestream_put_byte(&p, 0x84); // last metadata block and vorbis comment
141 bytestream_put_be24(&p, oggstream->header_len[1] - 4);
146 #define SPEEX_HEADER_SIZE 80
148 static int ogg_build_speex_headers(AVCodecContext *avctx,
149 OGGStreamContext *oggstream, int bitexact,
154 if (avctx->extradata_size < SPEEX_HEADER_SIZE)
157 // first packet: Speex header
158 p = av_mallocz(SPEEX_HEADER_SIZE);
160 return AVERROR(ENOMEM);
161 oggstream->header[0] = p;
162 oggstream->header_len[0] = SPEEX_HEADER_SIZE;
163 bytestream_put_buffer(&p, avctx->extradata, SPEEX_HEADER_SIZE);
164 AV_WL32(&oggstream->header[0][68], 0); // set extra_headers to 0
166 // second packet: VorbisComment
167 p = ogg_write_vorbiscomment(0, bitexact, &oggstream->header_len[1], m);
169 return AVERROR(ENOMEM);
170 oggstream->header[1] = p;
175 static int ogg_write_header(AVFormatContext *s)
177 OGGStreamContext *oggstream;
179 for (i = 0; i < s->nb_streams; i++) {
180 AVStream *st = s->streams[i];
181 if (st->codec->codec_type == AVMEDIA_TYPE_AUDIO)
182 av_set_pts_info(st, 64, 1, st->codec->sample_rate);
183 else if (st->codec->codec_type == AVMEDIA_TYPE_VIDEO)
184 av_set_pts_info(st, 64, st->codec->time_base.num, st->codec->time_base.den);
185 if (st->codec->codec_id != CODEC_ID_VORBIS &&
186 st->codec->codec_id != CODEC_ID_THEORA &&
187 st->codec->codec_id != CODEC_ID_SPEEX &&
188 st->codec->codec_id != CODEC_ID_FLAC) {
189 av_log(s, AV_LOG_ERROR, "Unsupported codec id in stream %d\n", i);
193 if (!st->codec->extradata || !st->codec->extradata_size) {
194 av_log(s, AV_LOG_ERROR, "No extradata present\n");
197 oggstream = av_mallocz(sizeof(*oggstream));
198 st->priv_data = oggstream;
199 if (st->codec->codec_id == CODEC_ID_FLAC) {
200 int err = ogg_build_flac_headers(st->codec, oggstream,
201 st->codec->flags & CODEC_FLAG_BITEXACT,
204 av_log(s, AV_LOG_ERROR, "Error writing FLAC headers\n");
205 av_freep(&st->priv_data);
208 } else if (st->codec->codec_id == CODEC_ID_SPEEX) {
209 int err = ogg_build_speex_headers(st->codec, oggstream,
210 st->codec->flags & CODEC_FLAG_BITEXACT,
213 av_log(s, AV_LOG_ERROR, "Error writing Speex headers\n");
214 av_freep(&st->priv_data);
218 if (ff_split_xiph_headers(st->codec->extradata, st->codec->extradata_size,
219 st->codec->codec_id == CODEC_ID_VORBIS ? 30 : 42,
220 oggstream->header, oggstream->header_len) < 0) {
221 av_log(s, AV_LOG_ERROR, "Extradata corrupted\n");
222 av_freep(&st->priv_data);
225 if (st->codec->codec_id == CODEC_ID_THEORA) {
226 /** KFGSHIFT is the width of the less significant section of the granule position
227 The less significant section is the frame count since the last keyframe */
228 oggstream->kfgshift = ((oggstream->header[0][40]&3)<<3)|(oggstream->header[0][41]>>5);
229 oggstream->vrev = oggstream->header[0][9];
230 av_log(s, AV_LOG_DEBUG, "theora kfgshift %d, vrev %d\n",
231 oggstream->kfgshift, oggstream->vrev);
235 for (i = 0; i < 3; i++) {
236 for (j = 0; j < s->nb_streams; j++) {
237 AVStream *st = s->streams[j];
238 OGGStreamContext *oggstream = st->priv_data;
239 if (oggstream && oggstream->header_len[i]) {
240 ogg_write_page(s, oggstream->header[i], oggstream->header_len[i],
241 0, st->index, i ? 0 : 2); // bos
248 static int ogg_write_packet(AVFormatContext *s, AVPacket *pkt)
250 AVStream *st = s->streams[pkt->stream_index];
251 OGGStreamContext *oggstream = st->priv_data;
252 uint8_t *ptr = pkt->data;
253 int ret, size = pkt->size;
256 if (st->codec->codec_id == CODEC_ID_THEORA) {
257 int64_t pts = oggstream->vrev < 1 ? pkt->pts : pkt->pts + pkt->duration;
259 if (pkt->flags & AV_PKT_FLAG_KEY)
260 oggstream->last_kf_pts = pts;
261 pframe_count = pts - oggstream->last_kf_pts;
262 // prevent frame count from overflow if key frame flag is not set
263 if (pframe_count >= (1<<oggstream->kfgshift)) {
264 oggstream->last_kf_pts += pframe_count;
267 granule = (oggstream->last_kf_pts<<oggstream->kfgshift) | pframe_count;
269 granule = pkt->pts + pkt->duration;
270 oggstream->duration = granule;
272 ret = ogg_write_page(s, ptr, size, granule, pkt->stream_index, ptr != pkt->data);
273 ptr += ret; size -= ret;
274 } while (size > 0 || ret == 255*255); // need to output a last nil page
279 static int ogg_compare_granule(AVFormatContext *s, AVPacket *next, AVPacket *pkt)
281 AVStream *st2 = s->streams[next->stream_index];
282 AVStream *st = s->streams[pkt ->stream_index];
284 int64_t next_granule = av_rescale_q(next->pts + next->duration,
285 st2->time_base, AV_TIME_BASE_Q);
286 int64_t cur_granule = av_rescale_q(pkt ->pts + pkt ->duration,
287 st ->time_base, AV_TIME_BASE_Q);
288 return next_granule > cur_granule;
291 static int ogg_interleave_per_granule(AVFormatContext *s, AVPacket *out, AVPacket *pkt, int flush)
293 OGGStreamContext *ogg;
294 int i, stream_count = 0;
298 ff_interleave_add_packet(s, pkt, ogg_compare_granule);
299 ogg = s->streams[pkt->stream_index]->priv_data;
303 for (i = 0; i < s->nb_streams; i++) {
304 ogg = s->streams[i]->priv_data;
305 stream_count += !!ogg->packet_count;
306 interleaved += ogg->packet_count > 1;
309 if ((s->nb_streams == stream_count && interleaved == stream_count) ||
310 (flush && stream_count)) {
311 AVPacketList *pktl= s->packet_buffer;
313 s->packet_buffer = pktl->next;
315 ogg = s->streams[out->stream_index]->priv_data;
316 if (flush && ogg->packet_count == 1)
320 if(!s->packet_buffer)
321 s->packet_buffer_end= NULL;
323 if(s->streams[out->stream_index]->last_in_packet_buffer == pktl)
324 s->streams[out->stream_index]->last_in_packet_buffer= NULL;
334 static int ogg_write_trailer(AVFormatContext *s)
337 for (i = 0; i < s->nb_streams; i++) {
338 AVStream *st = s->streams[i];
339 OGGStreamContext *oggstream = st->priv_data;
340 if (st->codec->codec_id == CODEC_ID_FLAC ||
341 st->codec->codec_id == CODEC_ID_SPEEX) {
342 av_free(oggstream->header[0]);
343 av_free(oggstream->header[1]);
345 av_freep(&st->priv_data);
350 AVOutputFormat ogg_muxer = {
352 NULL_IF_CONFIG_SMALL("Ogg"),
361 .interleave_packet = ogg_interleave_per_granule,
362 .metadata_conv = ff_vorbiscomment_metadata_conv,