2 * Ogg bitstream support
3 * Luca Barbato <lu_zero@gentoo.org>
4 * Based on tcvp implementation
8 Copyright (C) 2005 Michael Ahlberg, Måns Rullgård
10 Permission is hereby granted, free of charge, to any person
11 obtaining a copy of this software and associated documentation
12 files (the "Software"), to deal in the Software without
13 restriction, including without limitation the rights to use, copy,
14 modify, merge, publish, distribute, sublicense, and/or sell copies
15 of the Software, and to permit persons to whom the Software is
16 furnished to do so, subject to the following conditions:
18 The above copyright notice and this permission notice shall be
19 included in all copies or substantial portions of the Software.
21 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
25 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
26 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 DEALINGS IN THE SOFTWARE.
32 #include "libavutil/avassert.h"
33 #include "libavutil/intreadwrite.h"
37 #include "vorbiscomment.h"
39 #define MAX_PAGE_SIZE 65307
40 #define DECODER_BUFFER_SIZE MAX_PAGE_SIZE
42 static const struct ogg_codec * const ogg_codecs[] = {
62 static int64_t ogg_calc_pts(AVFormatContext *s, int idx, int64_t *dts);
63 static int ogg_new_stream(AVFormatContext *s, uint32_t serial);
64 static int ogg_restore(AVFormatContext *s);
66 static void free_stream(AVFormatContext *s, int i)
68 struct ogg *ogg = s->priv_data;
69 struct ogg_stream *stream = &ogg->streams[i];
71 av_freep(&stream->buf);
73 stream->codec->cleanup) {
74 stream->codec->cleanup(s, i);
77 av_freep(&stream->private);
78 av_freep(&stream->new_metadata);
81 //FIXME We could avoid some structure duplication
82 static int ogg_save(AVFormatContext *s)
84 struct ogg *ogg = s->priv_data;
85 struct ogg_state *ost =
86 av_malloc(sizeof(*ost) + (ogg->nstreams - 1) * sizeof(*ogg->streams));
91 return AVERROR(ENOMEM);
93 ost->pos = avio_tell(s->pb);
94 ost->curidx = ogg->curidx;
95 ost->next = ogg->state;
96 ost->nstreams = ogg->nstreams;
97 memcpy(ost->streams, ogg->streams, ogg->nstreams * sizeof(*ogg->streams));
99 for (i = 0; i < ogg->nstreams; i++) {
100 struct ogg_stream *os = ogg->streams + i;
101 os->buf = av_mallocz(os->bufsize + AV_INPUT_BUFFER_PADDING_SIZE);
103 memcpy(os->buf, ost->streams[i].buf, os->bufpos);
105 ret = AVERROR(ENOMEM);
106 os->new_metadata = NULL;
107 os->new_metadata_size = 0;
118 static int ogg_restore(AVFormatContext *s)
120 struct ogg *ogg = s->priv_data;
121 AVIOContext *bc = s->pb;
122 struct ogg_state *ost = ogg->state;
128 ogg->state = ost->next;
130 for (i = 0; i < ogg->nstreams; i++) {
131 struct ogg_stream *stream = &ogg->streams[i];
132 av_freep(&stream->buf);
133 av_freep(&stream->new_metadata);
135 if (i >= ost->nstreams || !ost->streams[i].private) {
140 avio_seek(bc, ost->pos, SEEK_SET);
142 ogg->curidx = ost->curidx;
143 ogg->nstreams = ost->nstreams;
144 if ((err = av_reallocp_array(&ogg->streams, ogg->nstreams,
145 sizeof(*ogg->streams))) < 0) {
149 memcpy(ogg->streams, ost->streams,
150 ost->nstreams * sizeof(*ogg->streams));
157 static int ogg_reset(AVFormatContext *s)
159 struct ogg *ogg = s->priv_data;
161 int64_t start_pos = avio_tell(s->pb);
163 for (i = 0; i < ogg->nstreams; i++) {
164 struct ogg_stream *os = ogg->streams + i;
169 os->lastpts = AV_NOPTS_VALUE;
170 os->lastdts = AV_NOPTS_VALUE;
177 if (start_pos <= s->internal->data_offset) {
180 os->end_trimming = 0;
181 av_freep(&os->new_metadata);
182 os->new_metadata_size = 0;
191 static const struct ogg_codec *ogg_find_codec(uint8_t *buf, int size)
195 for (i = 0; ogg_codecs[i]; i++)
196 if (size >= ogg_codecs[i]->magicsize &&
197 !memcmp(buf, ogg_codecs[i]->magic, ogg_codecs[i]->magicsize))
198 return ogg_codecs[i];
204 * Replace the current stream with a new one. This is a typical webradio
205 * situation where a new audio stream spawn (identified with a new serial) and
206 * must replace the previous one (track switch).
208 static int ogg_replace_stream(AVFormatContext *s, uint32_t serial, int nsegs)
210 struct ogg *ogg = s->priv_data;
211 struct ogg_stream *os;
212 const struct ogg_codec *codec;
215 if (s->pb->seekable & AVIO_SEEKABLE_NORMAL) {
217 int64_t pos = avio_tell(s->pb);
218 avio_skip(s->pb, nsegs);
219 if (avio_read(s->pb, magic, sizeof(magic)) != sizeof(magic))
220 return AVERROR_INVALIDDATA;
221 avio_seek(s->pb, pos, SEEK_SET);
222 codec = ogg_find_codec(magic, sizeof(magic));
224 av_log(s, AV_LOG_ERROR, "Cannot identify new stream\n");
225 return AVERROR_INVALIDDATA;
227 for (i = 0; i < ogg->nstreams; i++) {
228 if (ogg->streams[i].codec == codec)
231 if (i >= ogg->nstreams)
232 return ogg_new_stream(s, serial);
233 } else if (ogg->nstreams != 1) {
234 avpriv_report_missing_feature(s, "Changing stream parameters in multistream ogg");
235 return AVERROR_PATCHWELCOME;
238 os = &ogg->streams[i];
245 bufsize = os->bufsize;
248 if (!ogg->state || ogg->state->streams[i].private != os->private)
249 av_freep(&ogg->streams[i].private);
251 /* Set Ogg stream settings similar to what is done in ogg_new_stream(). We
252 * also re-use the ogg_stream allocated buffer */
253 memset(os, 0, sizeof(*os));
255 os->bufsize = bufsize;
264 static int ogg_new_stream(AVFormatContext *s, uint32_t serial)
266 struct ogg *ogg = s->priv_data;
267 int idx = ogg->nstreams;
269 struct ogg_stream *os;
273 av_log(s, AV_LOG_ERROR, "New streams are not supposed to be added "
274 "in between Ogg context save/restore operations.\n");
278 /* Allocate and init a new Ogg Stream */
279 if (av_size_mult(ogg->nstreams + 1, sizeof(*ogg->streams), &size) < 0 ||
280 !(os = av_realloc(ogg->streams, size)))
281 return AVERROR(ENOMEM);
283 os = ogg->streams + idx;
284 memset(os, 0, sizeof(*os));
286 os->bufsize = DECODER_BUFFER_SIZE;
287 os->buf = av_malloc(os->bufsize + AV_INPUT_BUFFER_PADDING_SIZE);
289 os->start_granule = OGG_NOGRANULE_VALUE;
291 return AVERROR(ENOMEM);
293 /* Create the associated AVStream */
294 st = avformat_new_stream(s, NULL);
297 return AVERROR(ENOMEM);
300 avpriv_set_pts_info(st, 64, 1, 1000000);
306 static int ogg_new_buf(struct ogg *ogg, int idx)
308 struct ogg_stream *os = ogg->streams + idx;
309 uint8_t *nb = av_malloc(os->bufsize + AV_INPUT_BUFFER_PADDING_SIZE);
310 int size = os->bufpos - os->pstart;
313 return AVERROR(ENOMEM);
316 memcpy(nb, os->buf + os->pstart, size);
327 static int data_packets_seen(const struct ogg *ogg)
331 for (i = 0; i < ogg->nstreams; i++)
332 if (ogg->streams[i].got_data)
337 static int ogg_read_page(AVFormatContext *s, int *sid)
339 AVIOContext *bc = s->pb;
340 struct ogg *ogg = s->priv_data;
341 struct ogg_stream *os;
350 ret = avio_read(bc, sync, 4);
352 return ret < 0 ? ret : AVERROR_EOF;
357 if (sync[sp & 3] == 'O' &&
358 sync[(sp + 1) & 3] == 'g' &&
359 sync[(sp + 2) & 3] == 'g' && sync[(sp + 3) & 3] == 'S')
362 if(!i && (bc->seekable & AVIO_SEEKABLE_NORMAL) && ogg->page_pos > 0) {
364 avio_seek(bc, ogg->page_pos+4, SEEK_SET);
374 } while (i++ < MAX_PAGE_SIZE);
376 if (i >= MAX_PAGE_SIZE) {
377 av_log(s, AV_LOG_INFO, "cannot find sync word\n");
378 return AVERROR_INVALIDDATA;
381 if (avio_r8(bc) != 0) { /* version */
382 av_log (s, AV_LOG_ERROR, "ogg page, unsupported version\n");
383 return AVERROR_INVALIDDATA;
388 serial = avio_rl32(bc);
389 avio_skip(bc, 8); /* seq, crc */
395 idx = ogg_find_stream(ogg, serial);
397 if (data_packets_seen(ogg))
398 idx = ogg_replace_stream(s, serial, nsegs);
400 idx = ogg_new_stream(s, serial);
403 av_log(s, AV_LOG_ERROR, "failed to create or replace stream\n");
408 os = ogg->streams + idx;
410 os->page_pos = avio_tell(bc) - 27;
413 ret = ogg_new_buf(ogg, idx);
418 ret = avio_read(bc, os->segments, nsegs);
420 return ret < 0 ? ret : AVERROR_EOF;
426 for (i = 0; i < nsegs; i++)
427 size += os->segments[i];
429 if (!(flags & OGG_FLAG_BOS))
432 if (flags & OGG_FLAG_CONT || os->incomplete) {
434 // If this is the very first segment we started
435 // playback in the middle of a continuation packet.
436 // Discard it since we missed the start of it.
437 while (os->segp < os->nsegs) {
438 int seg = os->segments[os->segp++];
443 os->sync_pos = os->page_pos;
447 os->sync_pos = os->page_pos;
450 if (os->bufsize - os->bufpos < size) {
451 uint8_t *nb = av_malloc((os->bufsize *= 2) + AV_INPUT_BUFFER_PADDING_SIZE);
453 return AVERROR(ENOMEM);
454 memcpy(nb, os->buf, os->bufpos);
459 ret = avio_read(bc, os->buf + os->bufpos, size);
461 return ret < 0 ? ret : AVERROR_EOF;
467 memset(os->buf + os->bufpos, 0, AV_INPUT_BUFFER_PADDING_SIZE);
475 * @brief find the next Ogg packet
476 * @param *sid is set to the stream for the packet or -1 if there is
477 * no matching stream, in that case assume all other return
478 * values to be uninitialized.
479 * @return negative value on error or EOF.
481 static int ogg_packet(AVFormatContext *s, int *sid, int *dstart, int *dsize,
484 struct ogg *ogg = s->priv_data;
486 struct ogg_stream *os;
488 int segp = 0, psize = 0;
490 av_log(s, AV_LOG_TRACE, "ogg_packet: curidx=%i\n", ogg->curidx);
498 ret = ogg_read_page(s, &idx);
503 os = ogg->streams + idx;
505 av_log(s, AV_LOG_TRACE, "ogg_packet: idx=%d pstart=%d psize=%d segp=%d nsegs=%d\n",
506 idx, os->pstart, os->psize, os->segp, os->nsegs);
509 if (os->header < 0) {
510 os->codec = ogg_find_codec(os->buf, os->bufpos);
512 av_log(s, AV_LOG_WARNING, "Codec not found\n");
524 while (os->segp < os->nsegs) {
525 int ss = os->segments[os->segp++];
533 if (!complete && os->segp == os->nsegs) {
535 // Do not set incomplete for empty packets.
536 // Together with the code in ogg_read_page
537 // that discards all continuation of empty packets
538 // we would get an infinite loop.
539 os->incomplete = !!os->psize;
544 if (os->granule == -1)
545 av_log(s, AV_LOG_WARNING,
546 "Page at %"PRId64" is missing granule\n",
553 if ((ret = os->codec->header(s, idx)) < 0) {
554 av_log(s, AV_LOG_ERROR, "Header processing failed: %s\n", av_err2str(ret));
562 // We have reached the first non-header packet in this stream.
563 // Unfortunately more header packets may still follow for others,
564 // but if we continue with header parsing we may lose data packets.
567 // Update the header state for all streams and
568 // compute the data_offset.
569 if (!s->internal->data_offset)
570 s->internal->data_offset = os->sync_pos;
572 for (i = 0; i < ogg->nstreams; i++) {
573 struct ogg_stream *cur_os = ogg->streams + i;
575 // if we have a partial non-header packet, its start is
576 // obviously at or after the data start
577 if (cur_os->incomplete)
578 s->internal->data_offset = FFMIN(s->internal->data_offset, cur_os->sync_pos);
582 os->pstart += os->psize;
588 if (os->codec && os->codec->packet) {
589 if ((ret = os->codec->packet(s, idx)) < 0) {
590 av_log(s, AV_LOG_ERROR, "Packet processing failed: %s\n", av_err2str(ret));
597 *dstart = os->pstart;
601 *fpos = os->sync_pos;
602 os->pstart += os->psize;
604 if(os->pstart == os->bufpos)
605 os->bufpos = os->pstart = 0;
606 os->sync_pos = os->page_pos;
609 // determine whether there are more complete packets in this page
610 // if not, the page's granule will apply to this packet
612 for (i = os->segp; i < os->nsegs; i++)
613 if (os->segments[i] < 255) {
618 if (os->segp == os->nsegs)
624 static int ogg_get_length(AVFormatContext *s)
626 struct ogg *ogg = s->priv_data;
631 if (!(s->pb->seekable & AVIO_SEEKABLE_NORMAL))
635 if (s->duration != AV_NOPTS_VALUE)
638 size = avio_size(s->pb);
641 end = size > MAX_PAGE_SIZE ? size - MAX_PAGE_SIZE : 0;
646 avio_seek(s->pb, end, SEEK_SET);
649 while (!ogg_read_page(s, &i)) {
650 if (ogg->streams[i].granule != -1 && ogg->streams[i].granule != 0 &&
651 ogg->streams[i].codec) {
652 s->streams[i]->duration =
653 ogg_gptopts(s, i, ogg->streams[i].granule, NULL);
654 if (s->streams[i]->start_time != AV_NOPTS_VALUE) {
655 s->streams[i]->duration -= s->streams[i]->start_time;
656 streams_left-= (ogg->streams[i].got_start==-1);
657 ogg->streams[i].got_start= 1;
658 } else if(!ogg->streams[i].got_start) {
659 ogg->streams[i].got_start= -1;
671 avio_seek (s->pb, s->internal->data_offset, SEEK_SET);
673 while (streams_left > 0 && !ogg_packet(s, &i, NULL, NULL, NULL)) {
676 pts = ogg_calc_pts(s, i, NULL);
677 if (s->streams[i]->duration == AV_NOPTS_VALUE)
679 if (pts != AV_NOPTS_VALUE && s->streams[i]->start_time == AV_NOPTS_VALUE && !ogg->streams[i].got_start) {
680 s->streams[i]->duration -= pts;
681 ogg->streams[i].got_start= 1;
683 }else if(s->streams[i]->start_time != AV_NOPTS_VALUE && !ogg->streams[i].got_start) {
684 ogg->streams[i].got_start= 1;
693 static int ogg_read_close(AVFormatContext *s)
695 struct ogg *ogg = s->priv_data;
698 for (i = 0; i < ogg->nstreams; i++) {
704 av_freep(&ogg->streams);
708 static int ogg_read_header(AVFormatContext *s)
710 struct ogg *ogg = s->priv_data;
715 //linear headers seek from start
717 ret = ogg_packet(s, NULL, NULL, NULL, NULL);
722 } while (!ogg->headers);
723 av_log(s, AV_LOG_TRACE, "found headers\n");
725 for (i = 0; i < ogg->nstreams; i++) {
726 struct ogg_stream *os = ogg->streams + i;
728 if (ogg->streams[i].header < 0) {
729 av_log(s, AV_LOG_ERROR, "Header parsing failed for stream %d\n", i);
730 ogg->streams[i].codec = NULL;
731 av_freep(&ogg->streams[i].private);
732 } else if (os->codec && os->nb_header < os->codec->nb_header) {
733 av_log(s, AV_LOG_WARNING,
734 "Headers mismatch for stream %d: "
735 "expected %d received %d.\n",
736 i, os->codec->nb_header, os->nb_header);
737 if (s->error_recognition & AV_EF_EXPLODE) {
739 return AVERROR_INVALIDDATA;
742 if (os->start_granule != OGG_NOGRANULE_VALUE)
743 os->lastpts = s->streams[i]->start_time =
744 ogg_gptopts(s, i, os->start_granule, NULL);
747 //linear granulepos seek from end
748 ret = ogg_get_length(s);
757 static int64_t ogg_calc_pts(AVFormatContext *s, int idx, int64_t *dts)
759 struct ogg *ogg = s->priv_data;
760 struct ogg_stream *os = ogg->streams + idx;
761 int64_t pts = AV_NOPTS_VALUE;
764 *dts = AV_NOPTS_VALUE;
766 if (os->lastpts != AV_NOPTS_VALUE) {
768 os->lastpts = AV_NOPTS_VALUE;
770 if (os->lastdts != AV_NOPTS_VALUE) {
773 os->lastdts = AV_NOPTS_VALUE;
776 if (os->granule != -1LL) {
777 if (os->codec && os->codec->granule_is_start)
778 pts = ogg_gptopts(s, idx, os->granule, dts);
780 os->lastpts = ogg_gptopts(s, idx, os->granule, &os->lastdts);
787 static void ogg_validate_keyframe(AVFormatContext *s, int idx, int pstart, int psize)
789 struct ogg *ogg = s->priv_data;
790 struct ogg_stream *os = ogg->streams + idx;
793 switch (s->streams[idx]->codecpar->codec_id) {
794 case AV_CODEC_ID_THEORA:
795 invalid = !!(os->pflags & AV_PKT_FLAG_KEY) != !(os->buf[pstart] & 0x40);
797 case AV_CODEC_ID_VP8:
798 invalid = !!(os->pflags & AV_PKT_FLAG_KEY) != !(os->buf[pstart] & 1);
801 os->pflags ^= AV_PKT_FLAG_KEY;
802 av_log(s, AV_LOG_WARNING, "Broken file, %skeyframe not correctly marked.\n",
803 (os->pflags & AV_PKT_FLAG_KEY) ? "" : "non-");
808 static int ogg_read_packet(AVFormatContext *s, AVPacket *pkt)
811 struct ogg_stream *os;
814 int64_t fpos, pts, dts;
816 if (s->io_repositioned) {
818 s->io_repositioned = 0;
824 ret = ogg_packet(s, &idx, &pstart, &psize, &fpos);
827 } while (idx < 0 || !s->streams[idx]);
830 os = ogg->streams + idx;
832 // pflags might not be set until after this
833 pts = ogg_calc_pts(s, idx, &dts);
834 ogg_validate_keyframe(s, idx, pstart, psize);
836 if (os->keyframe_seek && !(os->pflags & AV_PKT_FLAG_KEY))
838 os->keyframe_seek = 0;
841 ret = av_new_packet(pkt, psize);
844 pkt->stream_index = idx;
845 memcpy(pkt->data, os->buf + pstart, psize);
849 pkt->flags = os->pflags;
850 pkt->duration = os->pduration;
853 if (os->end_trimming) {
854 uint8_t *side_data = av_packet_new_side_data(pkt,
855 AV_PKT_DATA_SKIP_SAMPLES,
858 return AVERROR(ENOMEM);
859 AV_WL32(side_data + 4, os->end_trimming);
860 os->end_trimming = 0;
863 if (os->new_metadata) {
864 uint8_t *side_data = av_packet_new_side_data(pkt,
865 AV_PKT_DATA_METADATA_UPDATE,
866 os->new_metadata_size);
868 return AVERROR(ENOMEM);
870 memcpy(side_data, os->new_metadata, os->new_metadata_size);
871 av_freep(&os->new_metadata);
872 os->new_metadata_size = 0;
878 static int64_t ogg_read_timestamp(AVFormatContext *s, int stream_index,
879 int64_t *pos_arg, int64_t pos_limit)
881 struct ogg *ogg = s->priv_data;
882 AVIOContext *bc = s->pb;
883 int64_t pts = AV_NOPTS_VALUE;
887 avio_seek(bc, *pos_arg, SEEK_SET);
890 while ( avio_tell(bc) <= pos_limit
891 && !ogg_packet(s, &i, &pstart, &psize, pos_arg)) {
892 if (i == stream_index) {
893 struct ogg_stream *os = ogg->streams + stream_index;
894 // Do not trust the last timestamps of an ogm video
895 if ( (os->flags & OGG_FLAG_EOS)
896 && !(os->flags & OGG_FLAG_BOS)
897 && os->codec == &ff_ogm_video_codec)
899 pts = ogg_calc_pts(s, i, NULL);
900 ogg_validate_keyframe(s, i, pstart, psize);
901 if (os->pflags & AV_PKT_FLAG_KEY) {
903 } else if (os->keyframe_seek) {
904 // if we had a previous keyframe but no pts for it,
905 // return that keyframe with this pts value.
909 pts = AV_NOPTS_VALUE;
912 if (pts != AV_NOPTS_VALUE)
919 static int ogg_read_seek(AVFormatContext *s, int stream_index,
920 int64_t timestamp, int flags)
922 struct ogg *ogg = s->priv_data;
923 struct ogg_stream *os = ogg->streams + stream_index;
926 av_assert0(stream_index < ogg->nstreams);
927 // Ensure everything is reset even when seeking via
928 // the generated index.
931 // Try seeking to a keyframe first. If this fails (very possible),
932 // av_seek_frame will fall back to ignoring keyframes
933 if (s->streams[stream_index]->codecpar->codec_type == AVMEDIA_TYPE_VIDEO
934 && !(flags & AVSEEK_FLAG_ANY))
935 os->keyframe_seek = 1;
937 ret = ff_seek_frame_binary(s, stream_index, timestamp, flags);
939 os = ogg->streams + stream_index;
941 os->keyframe_seek = 0;
945 static int ogg_probe(const AVProbeData *p)
947 if (!memcmp("OggS", p->buf, 5) && p->buf[5] <= 0x7)
948 return AVPROBE_SCORE_MAX;
952 AVInputFormat ff_ogg_demuxer = {
954 .long_name = NULL_IF_CONFIG_SMALL("Ogg"),
955 .priv_data_size = sizeof(struct ogg),
956 .read_probe = ogg_probe,
957 .read_header = ogg_read_header,
958 .read_packet = ogg_read_packet,
959 .read_close = ogg_read_close,
960 .read_seek = ogg_read_seek,
961 .read_timestamp = ogg_read_timestamp,
963 .flags = AVFMT_GENERIC_INDEX | AVFMT_TS_DISCONT | AVFMT_NOBINSEARCH,