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.
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[] = {
60 //FIXME We could avoid some structure duplication
61 static int ogg_save(AVFormatContext *s)
63 struct ogg *ogg = s->priv_data;
64 struct ogg_state *ost =
65 av_malloc(sizeof(*ost) + (ogg->nstreams - 1) * sizeof(*ogg->streams));
68 return AVERROR(ENOMEM);
69 ost->pos = avio_tell(s->pb);
70 ost->curidx = ogg->curidx;
71 ost->next = ogg->state;
72 ost->nstreams = ogg->nstreams;
73 memcpy(ost->streams, ogg->streams, ogg->nstreams * sizeof(*ogg->streams));
75 for (i = 0; i < ogg->nstreams; i++) {
76 struct ogg_stream *os = ogg->streams + i;
77 os->buf = av_mallocz(os->bufsize + AV_INPUT_BUFFER_PADDING_SIZE);
78 memcpy(os->buf, ost->streams[i].buf, os->bufpos);
86 static int ogg_restore(AVFormatContext *s, int discard)
88 struct ogg *ogg = s->priv_data;
89 AVIOContext *bc = s->pb;
90 struct ogg_state *ost = ogg->state;
96 ogg->state = ost->next;
100 for (i = 0; i < ogg->nstreams; i++)
101 av_free(ogg->streams[i].buf);
103 avio_seek(bc, ost->pos, SEEK_SET);
104 ogg->curidx = ost->curidx;
105 ogg->nstreams = ost->nstreams;
106 if ((err = av_reallocp_array(&ogg->streams, ogg->nstreams,
107 sizeof(*ogg->streams))) < 0) {
111 memcpy(ogg->streams, ost->streams,
112 ost->nstreams * sizeof(*ogg->streams));
120 static int ogg_reset(struct ogg *ogg)
124 for (i = 0; i < ogg->nstreams; i++) {
125 struct ogg_stream *os = ogg->streams + i;
130 os->lastpts = AV_NOPTS_VALUE;
131 os->lastdts = AV_NOPTS_VALUE;
144 static const struct ogg_codec *ogg_find_codec(uint8_t *buf, int size)
148 for (i = 0; ogg_codecs[i]; i++)
149 if (size >= ogg_codecs[i]->magicsize &&
150 !memcmp(buf, ogg_codecs[i]->magic, ogg_codecs[i]->magicsize))
151 return ogg_codecs[i];
156 static int ogg_new_stream(AVFormatContext *s, uint32_t serial, int new_avstream)
158 struct ogg *ogg = s->priv_data;
159 int idx = ogg->nstreams++;
161 struct ogg_stream *os;
163 os = av_realloc(ogg->streams, ogg->nstreams * sizeof(*ogg->streams));
166 return AVERROR(ENOMEM);
170 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 + AV_INPUT_BUFFER_PADDING_SIZE);
177 os->start_granule = OGG_NOGRANULE_VALUE;
180 st = avformat_new_stream(s, NULL);
182 return AVERROR(ENOMEM);
185 avpriv_set_pts_info(st, 64, 1, 1000000);
191 static int ogg_new_buf(struct ogg *ogg, int idx)
193 struct ogg_stream *os = ogg->streams + idx;
194 uint8_t *nb = av_malloc(os->bufsize + AV_INPUT_BUFFER_PADDING_SIZE);
195 int size = os->bufpos - os->pstart;
198 return AVERROR(ENOMEM);
201 memcpy(nb, os->buf + os->pstart, size);
212 static int ogg_read_page(AVFormatContext *s, int *str)
214 AVIOContext *bc = s->pb;
215 struct ogg *ogg = s->priv_data;
216 struct ogg_stream *os;
225 ret = avio_read(bc, sync, 4);
227 return ret < 0 ? ret : AVERROR_EOF;
232 if (sync[sp & 3] == 'O' &&
233 sync[(sp + 1) & 3] == 'g' &&
234 sync[(sp + 2) & 3] == 'g' && sync[(sp + 3) & 3] == 'S')
243 } while (i++ < MAX_PAGE_SIZE);
245 if (i >= MAX_PAGE_SIZE) {
246 av_log(s, AV_LOG_INFO, "cannot find sync word\n");
247 return AVERROR_INVALIDDATA;
250 if (avio_r8(bc) != 0) /* version */
251 return AVERROR_INVALIDDATA;
255 serial = avio_rl32(bc);
256 avio_skip(bc, 8); /* seq, crc */
259 idx = ogg_find_stream(ogg, serial);
264 for (n = 0; n < ogg->nstreams; n++) {
265 av_freep(&ogg->streams[n].buf);
267 ogg->state->streams[n].private != ogg->streams[n].private)
268 av_freep(&ogg->streams[n].private);
274 idx = ogg_new_stream(s, serial, 0);
276 idx = ogg_new_stream(s, serial, 1);
282 os = ogg->streams + idx;
283 os->page_pos = avio_tell(bc) - 27;
286 ret = ogg_new_buf(ogg, idx);
291 ret = avio_read(bc, os->segments, nsegs);
293 return ret < 0 ? ret : AVERROR_EOF;
299 for (i = 0; i < nsegs; i++)
300 size += os->segments[i];
302 if (flags & OGG_FLAG_CONT || os->incomplete) {
304 while (os->segp < os->nsegs) {
305 int seg = os->segments[os->segp++];
310 os->sync_pos = os->page_pos;
314 os->sync_pos = os->page_pos;
317 if (os->bufsize - os->bufpos < size) {
318 uint8_t *nb = av_malloc((os->bufsize *= 2) + AV_INPUT_BUFFER_PADDING_SIZE);
320 return AVERROR(ENOMEM);
321 memcpy(nb, os->buf, os->bufpos);
326 ret = avio_read(bc, os->buf + os->bufpos, size);
328 return ret < 0 ? ret : AVERROR_EOF;
334 memset(os->buf + os->bufpos, 0, AV_INPUT_BUFFER_PADDING_SIZE);
341 static int ogg_packet(AVFormatContext *s, int *str, int *dstart, int *dsize,
344 struct ogg *ogg = s->priv_data;
346 struct ogg_stream *os;
348 int segp = 0, psize = 0;
350 av_log(s, AV_LOG_TRACE, "ogg_packet: curidx=%i\n", ogg->curidx);
356 ret = ogg_read_page(s, &idx);
361 os = ogg->streams + idx;
363 av_log(s, AV_LOG_TRACE, "ogg_packet: idx=%d pstart=%d psize=%d segp=%d nsegs=%d\n",
364 idx, os->pstart, os->psize, os->segp, os->nsegs);
367 if (os->header < 0) {
368 os->codec = ogg_find_codec(os->buf, os->bufpos);
370 av_log(s, AV_LOG_WARNING, "Codec not found\n");
382 while (os->segp < os->nsegs) {
383 int ss = os->segments[os->segp++];
391 if (!complete && os->segp == os->nsegs) {
393 // Do not set incomplete for empty packets.
394 // Together with the code in ogg_read_page
395 // that discards all continuation of empty packets
396 // we would get an infinite loop.
397 os->incomplete = !!os->psize;
401 av_log(s, AV_LOG_TRACE, "ogg_packet: idx %i, frame size %i, start %i\n",
402 idx, os->psize, os->pstart);
404 if (os->granule == -1)
405 av_log(s, AV_LOG_WARNING,
406 "Page at %"PRId64" is missing granule\n",
413 os->header = os->codec->header(s, idx);
418 // We have reached the first non-header packet in this stream.
419 // Unfortunately more header packets may still follow for others,
420 // but if we continue with header parsing we may lose data packets.
423 // Update the header state for all streams and
424 // compute the data_offset.
425 if (!s->internal->data_offset)
426 s->internal->data_offset = os->sync_pos;
428 for (i = 0; i < ogg->nstreams; i++) {
429 struct ogg_stream *cur_os = ogg->streams + i;
431 // if we have a partial non-header packet, its start is
432 // obviously at or after the data start
433 if (cur_os->incomplete)
434 s->internal->data_offset = FFMIN(s->internal->data_offset, cur_os->sync_pos);
438 os->pstart += os->psize;
444 if (os->codec && os->codec->packet)
445 os->codec->packet(s, idx);
449 *dstart = os->pstart;
453 *fpos = os->sync_pos;
454 os->pstart += os->psize;
456 os->sync_pos = os->page_pos;
459 // determine whether there are more complete packets in this page
460 // if not, the page's granule will apply to this packet
462 for (i = os->segp; i < os->nsegs; i++)
463 if (os->segments[i] < 255) {
468 if (os->segp == os->nsegs)
474 static int ogg_get_headers(AVFormatContext *s)
476 struct ogg *ogg = s->priv_data;
480 ret = ogg_packet(s, NULL, NULL, NULL, NULL);
483 } while (!ogg->headers);
485 for (i = 0; i < ogg->nstreams; i++) {
486 struct ogg_stream *os = ogg->streams + i;
488 if (os->codec && os->codec->nb_header &&
489 os->nb_header < os->codec->nb_header) {
490 av_log(s, AV_LOG_ERROR,
491 "Headers mismatch for stream %d: "
492 "expected %d received %d.\n",
493 i, os->codec->nb_header, os->nb_header);
494 if (s->error_recognition & AV_EF_EXPLODE)
495 return AVERROR_INVALIDDATA;
497 if (os->start_granule != OGG_NOGRANULE_VALUE)
498 os->lastpts = s->streams[i]->start_time =
499 ogg_gptopts(s, i, os->start_granule, NULL);
501 av_log(s, AV_LOG_TRACE, "found headers\n");
506 static int ogg_get_length(AVFormatContext *s)
508 struct ogg *ogg = s->priv_data;
512 if (!s->pb->seekable)
516 if (s->duration != AV_NOPTS_VALUE)
519 size = avio_size(s->pb);
522 end = size > MAX_PAGE_SIZE ? size - MAX_PAGE_SIZE : 0;
527 avio_seek(s->pb, end, SEEK_SET);
529 while (!ogg_read_page(s, &i)) {
530 if (ogg->streams[i].granule != -1 && ogg->streams[i].granule != 0 &&
531 ogg->streams[i].codec) {
532 s->streams[i]->duration =
533 ogg_gptopts(s, i, ogg->streams[i].granule, NULL);
534 if (s->streams[i]->start_time != AV_NOPTS_VALUE)
535 s->streams[i]->duration -= s->streams[i]->start_time;
544 static int ogg_read_close(AVFormatContext *s)
546 struct ogg *ogg = s->priv_data;
549 for (i = 0; i < ogg->nstreams; i++) {
550 av_free(ogg->streams[i].buf);
551 if (ogg->streams[i].codec &&
552 ogg->streams[i].codec->cleanup) {
553 ogg->streams[i].codec->cleanup(s, i);
555 av_free(ogg->streams[i].private);
557 av_free(ogg->streams);
561 static int ogg_read_header(AVFormatContext *s)
563 struct ogg *ogg = s->priv_data;
566 //linear headers seek from start
567 ret = ogg_get_headers(s);
573 for (i = 0; i < ogg->nstreams; i++)
574 if (ogg->streams[i].header < 0)
575 ogg->streams[i].codec = NULL;
577 //linear granulepos seek from end
578 ret = ogg_get_length(s);
584 //fill the extradata in the per codec callbacks
588 static int64_t ogg_calc_pts(AVFormatContext *s, int idx, int64_t *dts)
590 struct ogg *ogg = s->priv_data;
591 struct ogg_stream *os = ogg->streams + idx;
592 int64_t pts = AV_NOPTS_VALUE;
595 *dts = AV_NOPTS_VALUE;
597 if (os->lastpts != AV_NOPTS_VALUE) {
599 os->lastpts = AV_NOPTS_VALUE;
601 if (os->lastdts != AV_NOPTS_VALUE) {
604 os->lastdts = AV_NOPTS_VALUE;
607 if (os->granule != -1LL) {
608 if (os->codec && os->codec->granule_is_start)
609 pts = ogg_gptopts(s, idx, os->granule, dts);
611 os->lastpts = ogg_gptopts(s, idx, os->granule, &os->lastdts);
618 static int ogg_read_packet(AVFormatContext *s, AVPacket *pkt)
621 struct ogg_stream *os;
624 int64_t fpos, pts, dts;
629 ret = ogg_packet(s, &idx, &pstart, &psize, &fpos);
632 } while (idx < 0 || !s->streams[idx]);
635 os = ogg->streams + idx;
637 // pflags might not be set until after this
638 pts = ogg_calc_pts(s, idx, &dts);
640 if (os->keyframe_seek && !(os->pflags & AV_PKT_FLAG_KEY))
642 os->keyframe_seek = 0;
645 ret = av_new_packet(pkt, psize);
648 pkt->stream_index = idx;
649 memcpy(pkt->data, os->buf + pstart, psize);
653 pkt->flags = os->pflags;
654 pkt->duration = os->pduration;
660 static int64_t ogg_read_timestamp(AVFormatContext *s, int stream_index,
661 int64_t *pos_arg, int64_t pos_limit)
663 struct ogg *ogg = s->priv_data;
664 AVIOContext *bc = s->pb;
665 int64_t pts = AV_NOPTS_VALUE;
667 avio_seek(bc, *pos_arg, SEEK_SET);
670 while (avio_tell(bc) < pos_limit &&
671 !ogg_packet(s, &i, NULL, NULL, pos_arg)) {
672 if (i == stream_index) {
673 struct ogg_stream *os = ogg->streams + stream_index;
674 pts = ogg_calc_pts(s, i, NULL);
675 if (os->keyframe_seek && !(os->pflags & AV_PKT_FLAG_KEY))
676 pts = AV_NOPTS_VALUE;
678 if (pts != AV_NOPTS_VALUE)
685 static int ogg_read_seek(AVFormatContext *s, int stream_index,
686 int64_t timestamp, int flags)
688 struct ogg *ogg = s->priv_data;
689 struct ogg_stream *os = ogg->streams + stream_index;
692 // Try seeking to a keyframe first. If this fails (very possible),
693 // av_seek_frame will fall back to ignoring keyframes
694 if (s->streams[stream_index]->codec->codec_type == AVMEDIA_TYPE_VIDEO
695 && !(flags & AVSEEK_FLAG_ANY))
696 os->keyframe_seek = 1;
698 ret = ff_seek_frame_binary(s, stream_index, timestamp, flags);
699 os = ogg->streams + stream_index;
701 os->keyframe_seek = 0;
705 static int ogg_probe(AVProbeData *p)
707 if (!memcmp("OggS", p->buf, 5) && p->buf[5] <= 0x7)
708 return AVPROBE_SCORE_MAX;
712 AVInputFormat ff_ogg_demuxer = {
714 .long_name = NULL_IF_CONFIG_SMALL("Ogg"),
715 .priv_data_size = sizeof(struct ogg),
716 .read_probe = ogg_probe,
717 .read_header = ogg_read_header,
718 .read_packet = ogg_read_packet,
719 .read_close = ogg_read_close,
720 .read_seek = ogg_read_seek,
721 .read_timestamp = ogg_read_timestamp,
723 .flags = AVFMT_GENERIC_INDEX | AVFMT_NOBINSEARCH,