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"
36 #include "vorbiscomment.h"
38 #define MAX_PAGE_SIZE 65307
39 #define DECODER_BUFFER_SIZE MAX_PAGE_SIZE
41 static const struct ogg_codec * const ogg_codecs[] = {
58 //FIXME We could avoid some structure duplication
59 static int ogg_save(AVFormatContext *s)
61 struct ogg *ogg = s->priv_data;
62 struct ogg_state *ost =
63 av_malloc(sizeof (*ost) + (ogg->nstreams-1) * sizeof (*ogg->streams));
65 ost->pos = avio_tell (s->pb);
66 ost->curidx = ogg->curidx;
67 ost->next = ogg->state;
68 ost->nstreams = ogg->nstreams;
69 memcpy(ost->streams, ogg->streams, ogg->nstreams * sizeof(*ogg->streams));
71 for (i = 0; i < ogg->nstreams; i++){
72 struct ogg_stream *os = ogg->streams + i;
73 os->buf = av_mallocz (os->bufsize + FF_INPUT_BUFFER_PADDING_SIZE);
74 memcpy (os->buf, ost->streams[i].buf, os->bufpos);
82 static int ogg_restore(AVFormatContext *s, int discard)
84 struct ogg *ogg = s->priv_data;
85 AVIOContext *bc = s->pb;
86 struct ogg_state *ost = ogg->state;
92 ogg->state = ost->next;
95 struct ogg_stream *old_streams = ogg->streams;
97 for (i = 0; i < ogg->nstreams; i++)
98 av_free (ogg->streams[i].buf);
100 avio_seek (bc, ost->pos, SEEK_SET);
101 ogg->curidx = ost->curidx;
102 ogg->nstreams = ost->nstreams;
103 ogg->streams = av_realloc (ogg->streams,
104 ogg->nstreams * sizeof (*ogg->streams));
107 memcpy(ogg->streams, ost->streams,
108 ost->nstreams * sizeof(*ogg->streams));
110 av_free(old_streams);
120 static int ogg_reset(AVFormatContext *s)
122 struct ogg *ogg = s->priv_data;
124 int64_t start_pos = avio_tell(s->pb);
126 for (i = 0; i < ogg->nstreams; i++){
127 struct ogg_stream *os = ogg->streams + i;
132 os->lastpts = AV_NOPTS_VALUE;
133 os->lastdts = AV_NOPTS_VALUE;
139 if (start_pos <= s->data_offset) {
149 static const struct ogg_codec *ogg_find_codec(uint8_t *buf, int size)
153 for (i = 0; ogg_codecs[i]; i++)
154 if (size >= ogg_codecs[i]->magicsize &&
155 !memcmp (buf, ogg_codecs[i]->magic, ogg_codecs[i]->magicsize))
156 return ogg_codecs[i];
161 static int ogg_new_stream(AVFormatContext *s, uint32_t serial, int new_avstream)
164 struct ogg *ogg = s->priv_data;
165 int idx = ogg->nstreams++;
167 struct ogg_stream *os;
169 ogg->streams = av_realloc (ogg->streams,
170 ogg->nstreams * sizeof (*ogg->streams));
171 memset (ogg->streams + idx, 0, sizeof (*ogg->streams));
172 os = ogg->streams + idx;
174 os->bufsize = DECODER_BUFFER_SIZE;
175 os->buf = av_malloc(os->bufsize + FF_INPUT_BUFFER_PADDING_SIZE);
179 st = avformat_new_stream(s, NULL);
181 return AVERROR(ENOMEM);
184 avpriv_set_pts_info(st, 64, 1, 1000000);
190 static int ogg_new_buf(struct ogg *ogg, int idx)
192 struct ogg_stream *os = ogg->streams + idx;
193 uint8_t *nb = av_malloc(os->bufsize + FF_INPUT_BUFFER_PADDING_SIZE);
194 int size = os->bufpos - os->pstart;
196 memcpy(nb, os->buf + os->pstart, size);
206 static int ogg_read_page(AVFormatContext *s, int *str)
208 AVIOContext *bc = s->pb;
209 struct ogg *ogg = s->priv_data;
210 struct ogg_stream *os;
219 ret = avio_read(bc, sync, 4);
221 return ret < 0 ? ret : AVERROR_EOF;
226 if (sync[sp & 3] == 'O' &&
227 sync[(sp + 1) & 3] == 'g' &&
228 sync[(sp + 2) & 3] == 'g' && sync[(sp + 3) & 3] == 'S')
235 }while (i++ < MAX_PAGE_SIZE);
237 if (i >= MAX_PAGE_SIZE){
238 av_log (s, AV_LOG_INFO, "ogg, can't find sync word\n");
239 return AVERROR_INVALIDDATA;
242 if (avio_r8(bc) != 0) /* version */
243 return AVERROR_INVALIDDATA;
247 serial = avio_rl32 (bc);
248 avio_skip(bc, 8); /* seq, crc */
251 idx = ogg_find_stream (ogg, serial);
256 if (ogg->nstreams != 1)
259 for (n = 0; n < ogg->nstreams; n++) {
260 av_freep(&ogg->streams[n].buf);
261 if (!ogg->state || ogg->state->streams[n].private != ogg->streams[n].private)
262 av_freep(&ogg->streams[n].private);
266 idx = ogg_new_stream(s, serial, 0);
268 idx = ogg_new_stream(s, serial, 1);
274 os = ogg->streams + idx;
275 os->page_pos = avio_tell(bc) - 27;
278 ogg_new_buf(ogg, idx);
280 ret = avio_read(bc, os->segments, nsegs);
282 return ret < 0 ? ret : AVERROR_EOF;
288 for (i = 0; i < nsegs; i++)
289 size += os->segments[i];
291 if (flags & OGG_FLAG_CONT || os->incomplete){
293 // If this is the very first segment we started
294 // playback in the middle of a continuation packet.
295 // Discard it since we missed the start of it.
296 while (os->segp < os->nsegs){
297 int seg = os->segments[os->segp++];
302 os->sync_pos = os->page_pos;
306 os->sync_pos = os->page_pos;
309 if (os->bufsize - os->bufpos < size){
310 uint8_t *nb = av_malloc ((os->bufsize *= 2) + FF_INPUT_BUFFER_PADDING_SIZE);
311 memcpy (nb, os->buf, os->bufpos);
316 ret = avio_read(bc, os->buf + os->bufpos, size);
318 return ret < 0 ? ret : AVERROR_EOF;
324 memset(os->buf + os->bufpos, 0, FF_INPUT_BUFFER_PADDING_SIZE);
331 static int ogg_packet(AVFormatContext *s, int *str, int *dstart, int *dsize,
334 struct ogg *ogg = s->priv_data;
336 struct ogg_stream *os;
338 int segp = 0, psize = 0;
340 av_dlog(s, "ogg_packet: curidx=%i\n", ogg->curidx);
346 ret = ogg_read_page(s, &idx);
351 os = ogg->streams + idx;
353 av_dlog(s, "ogg_packet: idx=%d pstart=%d psize=%d segp=%d nsegs=%d\n",
354 idx, os->pstart, os->psize, os->segp, os->nsegs);
358 os->codec = ogg_find_codec (os->buf, os->bufpos);
360 av_log(s, AV_LOG_WARNING, "Codec not found\n");
372 while (os->segp < os->nsegs){
373 int ss = os->segments[os->segp++];
381 if (!complete && os->segp == os->nsegs){
383 // Do not set incomplete for empty packets.
384 // Together with the code in ogg_read_page
385 // that discards all continuation of empty packets
386 // we would get an infinite loop.
387 os->incomplete = !!os->psize;
392 if (os->granule == -1)
393 av_log(s, AV_LOG_WARNING, "Page at %"PRId64" is missing granule\n", os->page_pos);
399 os->header = os->codec->header (s, idx);
404 // We have reached the first non-header packet in this stream.
405 // Unfortunately more header packets may still follow for others,
406 // but if we continue with header parsing we may lose data packets.
409 // Update the header state for all streams and
410 // compute the data_offset.
412 s->data_offset = os->sync_pos;
413 for (i = 0; i < ogg->nstreams; i++) {
414 struct ogg_stream *cur_os = ogg->streams + i;
416 // if we have a partial non-header packet, its start is
417 // obviously at or after the data start
418 if (cur_os->incomplete)
419 s->data_offset = FFMIN(s->data_offset, cur_os->sync_pos);
422 os->pstart += os->psize;
428 if (os->codec && os->codec->packet)
429 os->codec->packet (s, idx);
433 *dstart = os->pstart;
437 *fpos = os->sync_pos;
438 os->pstart += os->psize;
440 if(os->pstart == os->bufpos)
441 os->bufpos = os->pstart = 0;
442 os->sync_pos = os->page_pos;
445 // determine whether there are more complete packets in this page
446 // if not, the page's granule will apply to this packet
448 for (i = os->segp; i < os->nsegs; i++)
449 if (os->segments[i] < 255) {
454 if (os->segp == os->nsegs)
460 static int ogg_get_headers(AVFormatContext *s)
462 struct ogg *ogg = s->priv_data;
466 ret = ogg_packet(s, NULL, NULL, NULL, NULL);
469 }while (!ogg->headers);
471 av_dlog(s, "found headers\n");
476 static int ogg_get_length(AVFormatContext *s)
478 struct ogg *ogg = s->priv_data;
487 if (s->duration != AV_NOPTS_VALUE)
490 size = avio_size(s->pb);
493 end = size > MAX_PAGE_SIZE? size - MAX_PAGE_SIZE: 0;
496 avio_seek (s->pb, end, SEEK_SET);
498 while (!ogg_read_page (s, &i)){
499 if (ogg->streams[i].granule != -1 && ogg->streams[i].granule != 0 &&
500 ogg->streams[i].codec) {
501 s->streams[i]->duration =
502 ogg_gptopts (s, i, ogg->streams[i].granule, NULL);
503 if (s->streams[i]->start_time != AV_NOPTS_VALUE){
504 s->streams[i]->duration -= s->streams[i]->start_time;
505 streams_left-= (ogg->streams[i].got_start==-1);
506 ogg->streams[i].got_start= 1;
507 }else if(!ogg->streams[i].got_start){
508 ogg->streams[i].got_start= -1;
517 avio_seek (s->pb, 0, SEEK_SET);
518 while (!ogg_read_page (s, &i)){
519 if (ogg->streams[i].granule != -1 && ogg->streams[i].granule != 0 &&
520 ogg->streams[i].codec) {
521 if(s->streams[i]->duration && s->streams[i]->start_time == AV_NOPTS_VALUE && !ogg->streams[i].got_start){
522 int64_t start= ogg_gptopts (s, i, ogg->streams[i].granule, NULL);
523 if(av_rescale_q(start, s->streams[i]->time_base, AV_TIME_BASE_Q) > AV_TIME_BASE)
524 s->streams[i]->duration -= start;
525 ogg->streams[i].got_start= 1;
537 static int ogg_read_header(AVFormatContext *s)
539 struct ogg *ogg = s->priv_data;
542 //linear headers seek from start
543 ret = ogg_get_headers(s);
547 for (i = 0; i < ogg->nstreams; i++)
548 if (ogg->streams[i].header < 0)
549 ogg->streams[i].codec = NULL;
551 //linear granulepos seek from end
554 //fill the extradata in the per codec callbacks
558 static int64_t ogg_calc_pts(AVFormatContext *s, int idx, int64_t *dts)
560 struct ogg *ogg = s->priv_data;
561 struct ogg_stream *os = ogg->streams + idx;
562 int64_t pts = AV_NOPTS_VALUE;
565 *dts = AV_NOPTS_VALUE;
567 if (os->lastpts != AV_NOPTS_VALUE) {
569 os->lastpts = AV_NOPTS_VALUE;
571 if (os->lastdts != AV_NOPTS_VALUE) {
574 os->lastdts = AV_NOPTS_VALUE;
577 if (os->granule != -1LL) {
578 if (os->codec && os->codec->granule_is_start)
579 pts = ogg_gptopts(s, idx, os->granule, dts);
581 os->lastpts = ogg_gptopts(s, idx, os->granule, &os->lastdts);
588 static void ogg_validate_keyframe(AVFormatContext *s, int idx, int pstart, int psize)
590 struct ogg *ogg = s->priv_data;
591 struct ogg_stream *os = ogg->streams + idx;
592 if (psize && s->streams[idx]->codec->codec_id == CODEC_ID_THEORA) {
593 if (!!(os->pflags & AV_PKT_FLAG_KEY) != !(os->buf[pstart] & 0x40)) {
594 os->pflags ^= AV_PKT_FLAG_KEY;
595 av_log(s, AV_LOG_WARNING, "Broken file, %skeyframe not correctly marked.\n",
596 (os->pflags & AV_PKT_FLAG_KEY) ? "" : "non-");
601 static int ogg_read_packet(AVFormatContext *s, AVPacket *pkt)
604 struct ogg_stream *os;
607 int64_t fpos, pts, dts;
612 ret = ogg_packet(s, &idx, &pstart, &psize, &fpos);
615 }while (idx < 0 || !s->streams[idx]);
618 os = ogg->streams + idx;
620 // pflags might not be set until after this
621 pts = ogg_calc_pts(s, idx, &dts);
622 ogg_validate_keyframe(s, idx, pstart, psize);
624 if (os->keyframe_seek && !(os->pflags & AV_PKT_FLAG_KEY))
626 os->keyframe_seek = 0;
629 ret = av_new_packet(pkt, psize);
632 pkt->stream_index = idx;
633 memcpy (pkt->data, os->buf + pstart, psize);
637 pkt->flags = os->pflags;
638 pkt->duration = os->pduration;
644 static int ogg_read_close(AVFormatContext *s)
646 struct ogg *ogg = s->priv_data;
649 for (i = 0; i < ogg->nstreams; i++){
650 av_free (ogg->streams[i].buf);
651 av_free (ogg->streams[i].private);
653 av_free (ogg->streams);
657 static int64_t ogg_read_timestamp(AVFormatContext *s, int stream_index,
658 int64_t *pos_arg, int64_t pos_limit)
660 struct ogg *ogg = s->priv_data;
661 AVIOContext *bc = s->pb;
662 int64_t pts = AV_NOPTS_VALUE;
666 avio_seek(bc, *pos_arg, SEEK_SET);
669 while (avio_tell(bc) < pos_limit && !ogg_packet(s, &i, &pstart, &psize, pos_arg)) {
670 if (i == stream_index) {
671 struct ogg_stream *os = ogg->streams + stream_index;
672 pts = ogg_calc_pts(s, i, NULL);
673 ogg_validate_keyframe(s, i, pstart, psize);
674 if (os->pflags & AV_PKT_FLAG_KEY) {
676 } else if (os->keyframe_seek) {
677 // if we had a previous keyframe but no pts for it,
678 // return that keyframe with this pts value.
682 pts = AV_NOPTS_VALUE;
685 if (pts != AV_NOPTS_VALUE)
692 static int ogg_read_seek(AVFormatContext *s, int stream_index,
693 int64_t timestamp, int flags)
695 struct ogg *ogg = s->priv_data;
696 struct ogg_stream *os = ogg->streams + stream_index;
699 av_assert0(stream_index < ogg->nstreams);
700 // Ensure everything is reset even when seeking via
701 // the generated index.
704 // Try seeking to a keyframe first. If this fails (very possible),
705 // av_seek_frame will fall back to ignoring keyframes
706 if (s->streams[stream_index]->codec->codec_type == AVMEDIA_TYPE_VIDEO
707 && !(flags & AVSEEK_FLAG_ANY))
708 os->keyframe_seek = 1;
710 ret = ff_seek_frame_binary(s, stream_index, timestamp, flags);
711 os = ogg->streams + stream_index;
713 os->keyframe_seek = 0;
717 static int ogg_probe(AVProbeData *p)
719 if (!memcmp("OggS", p->buf, 5) && p->buf[5] <= 0x7)
720 return AVPROBE_SCORE_MAX;
724 AVInputFormat ff_ogg_demuxer = {
726 .long_name = NULL_IF_CONFIG_SMALL("Ogg"),
727 .priv_data_size = sizeof(struct ogg),
728 .read_probe = ogg_probe,
729 .read_header = ogg_read_header,
730 .read_packet = ogg_read_packet,
731 .read_close = ogg_read_close,
732 .read_seek = ogg_read_seek,
733 .read_timestamp = ogg_read_timestamp,
735 .flags = AVFMT_GENERIC_INDEX,