1 /********************************************************************
3 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
5 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2009 *
9 * by the Xiph.Org Foundation http://www.xiph.org/ *
11 ********************************************************************
13 function: stdio-based convenience library for opening/seeking/decoding
14 last mod: $Id: vorbisfile.c 16246 2009-07-10 03:19:29Z xiphmont $
16 ********************************************************************/
24 #include "vorbis/codec.h"
26 /* we don't need or want the static callback symbols here */
27 #define OV_EXCLUDE_STATIC_CALLBACKS
28 #include "vorbis/vorbisfile.h"
33 /* A 'chained bitstream' is a Vorbis bitstream that contains more than
34 one logical bitstream arranged end to end (the only form of Ogg
35 multiplexing allowed in a Vorbis bitstream; grouping [parallel
36 multiplexing] is not allowed in Vorbis) */
38 /* A Vorbis file can be played beginning to end (streamed) without
39 worrying ahead of time about chaining (see decoder_example.c). If
40 we have the whole file, however, and want random access
41 (seeking/scrubbing) or desire to know the total length/time of a
42 file, we need to account for the possibility of chaining. */
44 /* We can handle things a number of ways; we can determine the entire
45 bitstream structure right off the bat, or find pieces on demand.
46 This example determines and caches structure for the entire
47 bitstream, but builds a virtual decoder on the fly when moving
48 between links in the chain. */
50 /* There are also different ways to implement seeking. Enough
51 information exists in an Ogg bitstream to seek to
52 sample-granularity positions in the output. Or, one can seek by
53 picking some portion of the stream roughly in the desired area if
54 we only want coarse navigation through the stream. */
56 /*************************************************************************
57 * Many, many internal helpers. The intention is not to be confusing;
58 * rampant duplication and monolithic function implementation would be
59 * harder to understand anyway. The high level functions are last. Begin
60 * grokking near the end of the file */
62 /* read a little more data from the file/pipe into the ogg_sync framer
64 #define CHUNKSIZE 65536
66 static long _get_data(OggVorbis_File
*vf
){
68 if(!(vf
->callbacks
.read_func
))return(-1);
70 char *buffer
=ogg_sync_buffer(&vf
->oy
,CHUNKSIZE
);
71 long bytes
=(vf
->callbacks
.read_func
)(buffer
,1,CHUNKSIZE
,vf
->datasource
);
72 if(bytes
>0)ogg_sync_wrote(&vf
->oy
,bytes
);
73 if(bytes
==0 && errno
)return(-1);
79 /* save a tiny smidge of verbosity to make the code more readable */
80 static int _seek_helper(OggVorbis_File
*vf
,ogg_int64_t offset
){
82 if(!(vf
->callbacks
.seek_func
)||
83 (vf
->callbacks
.seek_func
)(vf
->datasource
, offset
, SEEK_SET
) == -1)
86 ogg_sync_reset(&vf
->oy
);
88 /* shouldn't happen unless someone writes a broken callback */
94 /* The read/seek functions track absolute position within the stream */
96 /* from the head of the stream, get the next page. boundary specifies
97 if the function is allowed to fetch more data from the stream (and
98 how much) or only use internally buffered data.
100 boundary: -1) unbounded search
101 0) read no additional data; use cached only
102 n) search for a new page beginning for n bytes
104 return: <0) did not find a page (OV_FALSE, OV_EOF, OV_EREAD)
105 n) found a page at absolute offset n */
107 static ogg_int64_t
_get_next_page(OggVorbis_File
*vf
,ogg_page
*og
,
108 ogg_int64_t boundary
){
109 if(boundary
>0)boundary
+=vf
->offset
;
113 if(boundary
>0 && vf
->offset
>=boundary
)return(OV_FALSE
);
114 more
=ogg_sync_pageseek(&vf
->oy
,og
);
117 /* skipped n bytes */
121 /* send more paramedics */
122 if(!boundary
)return(OV_FALSE
);
124 long ret
=_get_data(vf
);
125 if(ret
==0)return(OV_EOF
);
126 if(ret
<0)return(OV_EREAD
);
129 /* got a page. Return the offset at the page beginning,
130 advance the internal offset past the page end */
131 ogg_int64_t ret
=vf
->offset
;
140 /* find the latest page beginning before the current stream cursor
141 position. Much dirtier than the above as Ogg doesn't have any
142 backward search linkage. no 'readp' as it will certainly have to
144 /* returns offset or OV_EREAD, OV_FAULT */
145 static ogg_int64_t
_get_prev_page(OggVorbis_File
*vf
,ogg_page
*og
){
146 ogg_int64_t begin
=vf
->offset
;
147 ogg_int64_t end
=begin
;
149 ogg_int64_t offset
=-1;
156 ret
=_seek_helper(vf
,begin
);
159 while(vf
->offset
<end
){
160 memset(og
,0,sizeof(*og
));
161 ret
=_get_next_page(vf
,og
,end
-vf
->offset
);
162 if(ret
==OV_EREAD
)return(OV_EREAD
);
171 /* In a fully compliant, non-multiplexed stream, we'll still be
172 holding the last page. In multiplexed (or noncompliant streams),
173 we will probably have to re-read the last page we saw */
174 if(og
->header_len
==0){
175 ret
=_seek_helper(vf
,offset
);
178 ret
=_get_next_page(vf
,og
,CHUNKSIZE
);
180 /* this shouldn't be possible */
187 static void _add_serialno(ogg_page
*og
,long **serialno_list
, int *n
){
188 long s
= ogg_page_serialno(og
);
192 *serialno_list
= _ogg_realloc(*serialno_list
, sizeof(**serialno_list
)*(*n
));
194 *serialno_list
= _ogg_malloc(sizeof(**serialno_list
));
197 (*serialno_list
)[(*n
)-1] = s
;
200 /* returns nonzero if found */
201 static int _lookup_serialno(long s
, long *serialno_list
, int n
){
204 if(*serialno_list
== s
) return 1;
211 static int _lookup_page_serialno(ogg_page
*og
, long *serialno_list
, int n
){
212 long s
= ogg_page_serialno(og
);
213 return _lookup_serialno(s
,serialno_list
,n
);
216 /* performs the same search as _get_prev_page, but prefers pages of
217 the specified serial number. If a page of the specified serialno is
218 spotted during the seek-back-and-read-forward, it will return the
219 info of last page of the matching serial number instead of the very
220 last page. If no page of the specified serialno is seen, it will
221 return the info of last page and alter *serialno. */
222 static ogg_int64_t
_get_prev_page_serial(OggVorbis_File
*vf
,
223 long *serial_list
, int serial_n
,
224 int *serialno
, ogg_int64_t
*granpos
){
226 ogg_int64_t begin
=vf
->offset
;
227 ogg_int64_t end
=begin
;
230 ogg_int64_t prefoffset
=-1;
231 ogg_int64_t offset
=-1;
232 ogg_int64_t ret_serialno
=-1;
233 ogg_int64_t ret_gran
=-1;
240 ret
=_seek_helper(vf
,begin
);
243 while(vf
->offset
<end
){
244 ret
=_get_next_page(vf
,&og
,end
-vf
->offset
);
245 if(ret
==OV_EREAD
)return(OV_EREAD
);
249 ret_serialno
=ogg_page_serialno(&og
);
250 ret_gran
=ogg_page_granulepos(&og
);
253 if(ret_serialno
== *serialno
){
258 if(!_lookup_serialno(ret_serialno
,serial_list
,serial_n
)){
259 /* we fell off the end of the link, which means we seeked
260 back too far and shouldn't have been looking in that link
261 to begin with. If we found the preferred serial number,
262 forget that we saw it. */
269 /* we're not interested in the page... just the serialno and granpos. */
270 if(prefoffset
>=0)return(prefoffset
);
272 *serialno
= ret_serialno
;
278 /* uses the local ogg_stream storage in vf; this is important for
279 non-streaming input sources */
280 static int _fetch_headers(OggVorbis_File
*vf
,vorbis_info
*vi
,vorbis_comment
*vc
,
281 long **serialno_list
, int *serialno_n
,
289 ogg_int64_t llret
=_get_next_page(vf
,&og
,CHUNKSIZE
);
290 if(llret
==OV_EREAD
)return(OV_EREAD
);
291 if(llret
<0)return(OV_ENOTVORBIS
);
295 vorbis_info_init(vi
);
296 vorbis_comment_init(vc
);
297 vf
->ready_state
=OPENED
;
299 /* extract the serialnos of all BOS pages + the first set of vorbis
300 headers we see in the link */
302 while(ogg_page_bos(og_ptr
)){
304 if(_lookup_page_serialno(og_ptr
,*serialno_list
,*serialno_n
)){
305 /* a dupe serialnumber in an initial header packet set == invalid stream */
306 if(*serialno_list
)_ogg_free(*serialno_list
);
313 _add_serialno(og_ptr
,serialno_list
,serialno_n
);
316 if(vf
->ready_state
<STREAMSET
){
317 /* we don't have a vorbis stream in this link yet, so begin
318 prospective stream setup. We need a stream to get packets */
319 ogg_stream_reset_serialno(&vf
->os
,ogg_page_serialno(og_ptr
));
320 ogg_stream_pagein(&vf
->os
,og_ptr
);
322 if(ogg_stream_packetout(&vf
->os
,&op
) > 0 &&
323 vorbis_synthesis_idheader(&op
)){
324 /* vorbis header; continue setup */
325 vf
->ready_state
=STREAMSET
;
326 if((ret
=vorbis_synthesis_headerin(vi
,vc
,&op
))){
335 ogg_int64_t llret
=_get_next_page(vf
,og_ptr
,CHUNKSIZE
);
345 /* if this page also belongs to our vorbis stream, submit it and break */
346 if(vf
->ready_state
==STREAMSET
&&
347 vf
->os
.serialno
== ogg_page_serialno(og_ptr
)){
348 ogg_stream_pagein(&vf
->os
,og_ptr
);
354 if(vf
->ready_state
!=STREAMSET
){
362 while(i
<2){ /* get a page loop */
364 while(i
<2){ /* get a packet loop */
366 int result
=ogg_stream_packetout(&vf
->os
,&op
);
373 if((ret
=vorbis_synthesis_headerin(vi
,vc
,&op
)))
380 if(_get_next_page(vf
,og_ptr
,CHUNKSIZE
)<0){
385 /* if this page belongs to the correct stream, go parse it */
386 if(vf
->os
.serialno
== ogg_page_serialno(og_ptr
)){
387 ogg_stream_pagein(&vf
->os
,og_ptr
);
391 /* if we never see the final vorbis headers before the link
393 if(ogg_page_bos(og_ptr
)){
401 /* otherwise, keep looking */
409 vorbis_info_clear(vi
);
410 vorbis_comment_clear(vc
);
411 vf
->ready_state
=OPENED
;
416 /* Starting from current cursor position, get initial PCM offset of
417 next page. Consumes the page in the process without decoding
418 audio, however this is only called during stream parsing upon
420 static ogg_int64_t
_initial_pcmoffset(OggVorbis_File
*vf
, vorbis_info
*vi
){
422 ogg_int64_t accumulated
=0;
425 int serialno
= vf
->os
.serialno
;
429 if(_get_next_page(vf
,&og
,-1)<0)
430 break; /* should not be possible unless the file is truncated/mangled */
432 if(ogg_page_bos(&og
)) break;
433 if(ogg_page_serialno(&og
)!=serialno
) continue;
435 /* count blocksizes of all frames in the page */
436 ogg_stream_pagein(&vf
->os
,&og
);
437 while((result
=ogg_stream_packetout(&vf
->os
,&op
))){
438 if(result
>0){ /* ignore holes */
439 long thisblock
=vorbis_packet_blocksize(vi
,&op
);
441 accumulated
+=(lastblock
+thisblock
)>>2;
446 if(ogg_page_granulepos(&og
)!=-1){
447 /* pcm offset of last packet on the first audio page */
448 accumulated
= ogg_page_granulepos(&og
)-accumulated
;
453 /* less than zero? This is a stream with samples trimmed off
454 the beginning, a normal occurrence; set the offset to zero */
455 if(accumulated
<0)accumulated
=0;
460 /* finds each bitstream link one at a time using a bisection search
461 (has to begin by knowing the offset of the lb's initial page).
462 Recurses for each link so it can alloc the link storage after
463 finding them all, then unroll and fill the cache at the same time */
464 static int _bisect_forward_serialno(OggVorbis_File
*vf
,
466 ogg_int64_t searched
,
470 long *currentno_list
,
473 ogg_int64_t pcmoffset
;
474 ogg_int64_t dataoffset
=searched
;
475 ogg_int64_t endsearched
=end
;
476 ogg_int64_t next
=end
;
477 ogg_int64_t searchgran
=-1;
479 ogg_int64_t ret
,last
;
480 int serialno
= vf
->os
.serialno
;
483 we have the headers and serialnos for the link beginning at 'begin'
484 we have the offset and granpos of the last page in the file (potentially
485 not a page we care about)
488 /* Is the last page in our list of current serialnumbers? */
489 if(_lookup_serialno(endserial
,currentno_list
,currentnos
)){
491 /* last page is in the starting serialno list, so we've bisected
492 down to (or just started with) a single link. Now we need to
493 find the last vorbis page belonging to the first vorbis stream
496 while(endserial
!= serialno
){
497 endserial
= serialno
;
498 vf
->offset
=_get_prev_page_serial(vf
,currentno_list
,currentnos
,&endserial
,&endgran
);
502 if(vf
->offsets
)_ogg_free(vf
->offsets
);
503 if(vf
->serialnos
)_ogg_free(vf
->serialnos
);
504 if(vf
->dataoffsets
)_ogg_free(vf
->dataoffsets
);
506 vf
->offsets
=_ogg_malloc((vf
->links
+1)*sizeof(*vf
->offsets
));
507 vf
->vi
=_ogg_realloc(vf
->vi
,vf
->links
*sizeof(*vf
->vi
));
508 vf
->vc
=_ogg_realloc(vf
->vc
,vf
->links
*sizeof(*vf
->vc
));
509 vf
->serialnos
=_ogg_malloc(vf
->links
*sizeof(*vf
->serialnos
));
510 vf
->dataoffsets
=_ogg_malloc(vf
->links
*sizeof(*vf
->dataoffsets
));
511 vf
->pcmlengths
=_ogg_malloc(vf
->links
*2*sizeof(*vf
->pcmlengths
));
513 vf
->offsets
[m
+1]=end
;
514 vf
->offsets
[m
]=begin
;
515 vf
->pcmlengths
[m
*2+1]=endgran
;
519 long *next_serialno_list
=NULL
;
520 int next_serialnos
=0;
524 /* the below guards against garbage seperating the last and
525 first pages of two links. */
526 while(searched
<endsearched
){
529 if(endsearched
-searched
<CHUNKSIZE
){
532 bisect
=(searched
+endsearched
)/2;
535 ret
=_seek_helper(vf
,bisect
);
538 last
=_get_next_page(vf
,&og
,-1);
539 if(last
==OV_EREAD
)return(OV_EREAD
);
540 if(last
<0 || !_lookup_page_serialno(&og
,currentno_list
,currentnos
)){
542 if(last
>=0)next
=last
;
544 searched
=last
+og
.header_len
+og
.body_len
;
548 /* Bisection point found */
550 /* for the time being, fetch end PCM offset the simple way */
552 int testserial
= serialno
+1;
554 while(testserial
!= serialno
){
555 testserial
= serialno
;
556 vf
->offset
=_get_prev_page_serial(vf
,currentno_list
,currentnos
,&testserial
,&searchgran
);
560 if(vf
->offset
!=next
){
561 ret
=_seek_helper(vf
,next
);
565 ret
=_fetch_headers(vf
,&vi
,&vc
,&next_serialno_list
,&next_serialnos
,NULL
);
567 serialno
= vf
->os
.serialno
;
568 dataoffset
= vf
->offset
;
570 /* this will consume a page, however the next bistection always
571 starts with a raw seek */
572 pcmoffset
= _initial_pcmoffset(vf
,&vi
);
574 ret
=_bisect_forward_serialno(vf
,next
,vf
->offset
,end
,endgran
,endserial
,
575 next_serialno_list
,next_serialnos
,m
+1);
578 if(next_serialno_list
)_ogg_free(next_serialno_list
);
580 vf
->offsets
[m
+1]=next
;
581 vf
->serialnos
[m
+1]=serialno
;
582 vf
->dataoffsets
[m
+1]=dataoffset
;
587 vf
->pcmlengths
[m
*2+1]=searchgran
;
588 vf
->pcmlengths
[m
*2+2]=pcmoffset
;
589 vf
->pcmlengths
[m
*2+3]-=pcmoffset
;
595 static int _make_decode_ready(OggVorbis_File
*vf
){
596 if(vf
->ready_state
>STREAMSET
)return 0;
597 if(vf
->ready_state
<STREAMSET
)return OV_EFAULT
;
599 if(vorbis_synthesis_init(&vf
->vd
,vf
->vi
+vf
->current_link
))
602 if(vorbis_synthesis_init(&vf
->vd
,vf
->vi
))
605 vorbis_block_init(&vf
->vd
,&vf
->vb
);
606 vf
->ready_state
=INITSET
;
612 static int _open_seekable2(OggVorbis_File
*vf
){
613 ogg_int64_t dataoffset
=vf
->dataoffsets
[0],end
,endgran
=-1;
614 int endserial
=vf
->os
.serialno
;
615 int serialno
=vf
->os
.serialno
;
617 /* we're partially open and have a first link header state in
620 /* fetch initial PCM offset */
621 ogg_int64_t pcmoffset
= _initial_pcmoffset(vf
,vf
->vi
);
623 /* we can seek, so set out learning all about this file */
624 if(vf
->callbacks
.seek_func
&& vf
->callbacks
.tell_func
){
625 (vf
->callbacks
.seek_func
)(vf
->datasource
,0,SEEK_END
);
626 vf
->offset
=vf
->end
=(vf
->callbacks
.tell_func
)(vf
->datasource
);
628 vf
->offset
=vf
->end
=-1;
631 /* If seek_func is implemented, tell_func must also be implemented */
632 if(vf
->end
==-1) return(OV_EINVAL
);
634 /* Get the offset of the last page of the physical bitstream, or, if
635 we're lucky the last vorbis page of this link as most OggVorbis
636 files will contain a single logical bitstream */
637 end
=_get_prev_page_serial(vf
,vf
->serialnos
+2,vf
->serialnos
[1],&endserial
,&endgran
);
638 if(end
<0)return(end
);
640 /* now determine bitstream structure recursively */
641 if(_bisect_forward_serialno(vf
,0,dataoffset
,vf
->offset
,endgran
,endserial
,
642 vf
->serialnos
+2,vf
->serialnos
[1],0)<0)return(OV_EREAD
);
645 vf
->serialnos
[0]=serialno
;
646 vf
->dataoffsets
[0]=dataoffset
;
647 vf
->pcmlengths
[0]=pcmoffset
;
648 vf
->pcmlengths
[1]-=pcmoffset
;
650 return(ov_raw_seek(vf
,dataoffset
));
653 /* clear out the current logical bitstream decoder */
654 static void _decode_clear(OggVorbis_File
*vf
){
655 vorbis_dsp_clear(&vf
->vd
);
656 vorbis_block_clear(&vf
->vb
);
657 vf
->ready_state
=OPENED
;
660 /* fetch and process a packet. Handles the case where we're at a
661 bitstream boundary and dumps the decoding machine. If the decoding
662 machine is unloaded, it loads it. It also keeps pcm_offset up to
663 date (seek and read both use this. seek uses a special hack with
666 return: <0) error, OV_HOLE (lost packet) or OV_EOF
667 0) need more data (only if readp==0)
671 static int _fetch_and_process_packet(OggVorbis_File
*vf
,
677 /* handle one packet. Try to fetch it from current stream state */
678 /* extract packets from page */
681 if(vf
->ready_state
==STREAMSET
){
682 int ret
=_make_decode_ready(vf
);
686 /* process a packet if we can. */
688 if(vf
->ready_state
==INITSET
){
691 ogg_packet
*op_ptr
=(op_in
?op_in
:&op
);
692 int result
=ogg_stream_packetout(&vf
->os
,op_ptr
);
693 ogg_int64_t granulepos
;
696 if(result
==-1)return(OV_HOLE
); /* hole in the data. */
698 /* got a packet. process it */
699 granulepos
=op_ptr
->granulepos
;
700 if(!vorbis_synthesis(&vf
->vb
,op_ptr
)){ /* lazy check for lazy
702 header packets aren't
705 vorbis_synthesis will
708 /* suck in the synthesis data and track bitrate */
710 int oldsamples
=vorbis_synthesis_pcmout(&vf
->vd
,NULL
);
711 /* for proper use of libvorbis within libvorbisfile,
712 oldsamples will always be zero. */
713 if(oldsamples
)return(OV_EFAULT
);
715 vorbis_synthesis_blockin(&vf
->vd
,&vf
->vb
);
716 vf
->samptrack
+=vorbis_synthesis_pcmout(&vf
->vd
,NULL
)-oldsamples
;
717 vf
->bittrack
+=op_ptr
->bytes
*8;
720 /* update the pcm offset. */
721 if(granulepos
!=-1 && !op_ptr
->e_o_s
){
722 int link
=(vf
->seekable
?vf
->current_link
:0);
725 /* this packet has a pcm_offset on it (the last packet
726 completed on a page carries the offset) After processing
727 (above), we know the pcm position of the *last* sample
728 ready to be returned. Find the offset of the *first*
730 As an aside, this trick is inaccurate if we begin
731 reading anew right at the last page; the end-of-stream
732 granulepos declares the last frame in the stream, and the
733 last packet of the last page may be a partial frame.
734 So, we need a previous granulepos from an in-sequence page
735 to have a reference point. Thus the !op_ptr->e_o_s clause
738 if(vf
->seekable
&& link
>0)
739 granulepos
-=vf
->pcmlengths
[link
*2];
740 if(granulepos
<0)granulepos
=0; /* actually, this
741 shouldn't be possible
742 here unless the stream
745 samples
=vorbis_synthesis_pcmout(&vf
->vd
,NULL
);
749 granulepos
+=vf
->pcmlengths
[i
*2+1];
750 vf
->pcm_offset
=granulepos
;
760 if(vf
->ready_state
>=OPENED
){
764 /* the loop is not strictly necessary, but there's no sense in
765 doing the extra checks of the larger loop for the common
766 case in a multiplexed bistream where the page is simply
767 part of a different logical bitstream; keep reading until
768 we get one with the correct serialno */
771 if((ret
=_get_next_page(vf
,&og
,-1))<0){
772 return(OV_EOF
); /* eof. leave unitialized */
775 /* bitrate tracking; add the header's bytes here, the body bytes
776 are done by packet above */
777 vf
->bittrack
+=og
.header_len
*8;
779 if(vf
->ready_state
==INITSET
){
780 if(vf
->current_serialno
!=ogg_page_serialno(&og
)){
782 /* two possibilities:
783 1) our decoding just traversed a bitstream boundary
784 2) another stream is multiplexed into this logical section */
786 if(ogg_page_bos(&og
)){
794 vorbis_info_clear(vf
->vi
);
795 vorbis_comment_clear(vf
->vc
);
800 continue; /* possibility #2 */
808 /* Do we need to load a new machine before submitting the page? */
809 /* This is different in the seekable and non-seekable cases.
811 In the seekable case, we already have all the header
812 information loaded and cached; we just initialize the machine
813 with it and continue on our merry way.
815 In the non-seekable (streaming) case, we'll only be at a
816 boundary if we just left the previous logical bitstream and
817 we're now nominally at the header of the next bitstream
820 if(vf
->ready_state
!=INITSET
){
823 if(vf
->ready_state
<STREAMSET
){
825 long serialno
= ogg_page_serialno(&og
);
827 /* match the serialno to bitstream section. We use this rather than
828 offset positions to avoid problems near logical bitstream
831 for(link
=0;link
<vf
->links
;link
++)
832 if(vf
->serialnos
[link
]==serialno
)break;
834 if(link
==vf
->links
) continue; /* not the desired Vorbis
835 bitstream section; keep
838 vf
->current_serialno
=serialno
;
839 vf
->current_link
=link
;
841 ogg_stream_reset_serialno(&vf
->os
,vf
->current_serialno
);
842 vf
->ready_state
=STREAMSET
;
845 /* we're streaming */
846 /* fetch the three header packets, build the info struct */
848 int ret
=_fetch_headers(vf
,vf
->vi
,vf
->vc
,NULL
,NULL
,&og
);
850 vf
->current_serialno
=vf
->os
.serialno
;
857 /* the buffered page is the data we want, and we're ready for it;
858 add it to the stream state */
859 ogg_stream_pagein(&vf
->os
,&og
);
864 /* if, eg, 64 bit stdio is configured by default, this will build with
866 static int _fseek64_wrap(FILE *f
,ogg_int64_t off
,int whence
){
867 if(f
==NULL
)return(-1);
868 return fseek(f
,off
,whence
);
871 static int _ov_open1(void *f
,OggVorbis_File
*vf
,char *initial
,
872 long ibytes
, ov_callbacks callbacks
){
873 int offsettest
=((f
&& callbacks
.seek_func
)?callbacks
.seek_func(f
,0,SEEK_CUR
):-1);
874 long *serialno_list
=NULL
;
875 int serialno_list_size
=0;
878 memset(vf
,0,sizeof(*vf
));
880 vf
->callbacks
= callbacks
;
882 /* init the framing state */
883 ogg_sync_init(&vf
->oy
);
885 /* perhaps some data was previously read into a buffer for testing
886 against other stream types. Allow initialization from this
887 previously read data (especially as we may be reading from a
888 non-seekable stream) */
890 char *buffer
=ogg_sync_buffer(&vf
->oy
,ibytes
);
891 memcpy(buffer
,initial
,ibytes
);
892 ogg_sync_wrote(&vf
->oy
,ibytes
);
895 /* can we seek? Stevens suggests the seek test was portable */
896 if(offsettest
!=-1)vf
->seekable
=1;
898 /* No seeking yet; Set up a 'single' (current) logical bitstream
899 entry for partial open */
901 vf
->vi
=_ogg_calloc(vf
->links
,sizeof(*vf
->vi
));
902 vf
->vc
=_ogg_calloc(vf
->links
,sizeof(*vf
->vc
));
903 ogg_stream_init(&vf
->os
,-1); /* fill in the serialno later */
905 /* Fetch all BOS pages, store the vorbis header and all seen serial
906 numbers, load subsequent vorbis setup headers */
907 if((ret
=_fetch_headers(vf
,vf
->vi
,vf
->vc
,&serialno_list
,&serialno_list_size
,NULL
))<0){
911 /* serial number list for first link needs to be held somewhere
912 for second stage of seekable stream open; this saves having to
913 seek/reread first link's serialnumber data then. */
914 vf
->serialnos
=_ogg_calloc(serialno_list_size
+2,sizeof(*vf
->serialnos
));
915 vf
->serialnos
[0]=vf
->current_serialno
;
916 vf
->serialnos
[1]=serialno_list_size
;
917 memcpy(vf
->serialnos
+2,serialno_list
,serialno_list_size
*sizeof(*vf
->serialnos
));
919 vf
->offsets
=_ogg_calloc(1,sizeof(*vf
->offsets
));
920 vf
->dataoffsets
=_ogg_calloc(1,sizeof(*vf
->dataoffsets
));
922 vf
->dataoffsets
[0]=vf
->offset
;
923 vf
->current_serialno
=vf
->os
.serialno
;
925 vf
->ready_state
=PARTOPEN
;
927 if(serialno_list
)_ogg_free(serialno_list
);
931 static int _ov_open2(OggVorbis_File
*vf
){
932 if(vf
->ready_state
!= PARTOPEN
) return OV_EINVAL
;
933 vf
->ready_state
=OPENED
;
935 int ret
=_open_seekable2(vf
);
942 vf
->ready_state
=STREAMSET
;
948 /* clear out the OggVorbis_File struct */
949 int ov_clear(OggVorbis_File
*vf
){
951 vorbis_block_clear(&vf
->vb
);
952 vorbis_dsp_clear(&vf
->vd
);
953 ogg_stream_clear(&vf
->os
);
955 if(vf
->vi
&& vf
->links
){
957 for(i
=0;i
<vf
->links
;i
++){
958 vorbis_info_clear(vf
->vi
+i
);
959 vorbis_comment_clear(vf
->vc
+i
);
964 if(vf
->dataoffsets
)_ogg_free(vf
->dataoffsets
);
965 if(vf
->pcmlengths
)_ogg_free(vf
->pcmlengths
);
966 if(vf
->serialnos
)_ogg_free(vf
->serialnos
);
967 if(vf
->offsets
)_ogg_free(vf
->offsets
);
968 ogg_sync_clear(&vf
->oy
);
969 if(vf
->datasource
&& vf
->callbacks
.close_func
)
970 (vf
->callbacks
.close_func
)(vf
->datasource
);
971 memset(vf
,0,sizeof(*vf
));
979 /* inspects the OggVorbis file and finds/documents all the logical
980 bitstreams contained in it. Tries to be tolerant of logical
981 bitstream sections that are truncated/woogie.
987 int ov_open_callbacks(void *f
,OggVorbis_File
*vf
,char *initial
,long ibytes
,
988 ov_callbacks callbacks
){
989 int ret
=_ov_open1(f
,vf
,initial
,ibytes
,callbacks
);
991 return _ov_open2(vf
);
994 int ov_open(FILE *f
,OggVorbis_File
*vf
,char *initial
,long ibytes
){
995 ov_callbacks callbacks
= {
996 (size_t (*)(void *, size_t, size_t, void *)) fread
,
997 (int (*)(void *, ogg_int64_t
, int)) _fseek64_wrap
,
998 (int (*)(void *)) fclose
,
999 (long (*)(void *)) ftell
1002 return ov_open_callbacks((void *)f
, vf
, initial
, ibytes
, callbacks
);
1005 int ov_fopen(char *path
,OggVorbis_File
*vf
){
1007 FILE *f
= fopen(path
,"rb");
1010 ret
= ov_open(f
,vf
,NULL
,0);
1016 /* cheap hack for game usage where downsampling is desirable; there's
1017 no need for SRC as we can just do it cheaply in libvorbis. */
1019 int ov_halfrate(OggVorbis_File
*vf
,int flag
){
1021 if(vf
->vi
==NULL
)return OV_EINVAL
;
1022 if(!vf
->seekable
)return OV_EINVAL
;
1023 if(vf
->ready_state
>=STREAMSET
)
1024 _decode_clear(vf
); /* clear out stream state; later on libvorbis
1025 will be able to swap this on the fly, but
1026 for now dumping the decode machine is needed
1027 to reinit the MDCT lookups. 1.1 libvorbis
1028 is planned to be able to switch on the fly */
1030 for(i
=0;i
<vf
->links
;i
++){
1031 if(vorbis_synthesis_halfrate(vf
->vi
+i
,flag
)){
1039 int ov_halfrate_p(OggVorbis_File
*vf
){
1040 if(vf
->vi
==NULL
)return OV_EINVAL
;
1041 return vorbis_synthesis_halfrate_p(vf
->vi
);
1044 /* Only partially open the vorbis file; test for Vorbisness, and load
1045 the headers for the first chain. Do not seek (although test for
1046 seekability). Use ov_test_open to finish opening the file, else
1047 ov_clear to close/free it. Same return codes as open. */
1049 int ov_test_callbacks(void *f
,OggVorbis_File
*vf
,char *initial
,long ibytes
,
1050 ov_callbacks callbacks
)
1052 return _ov_open1(f
,vf
,initial
,ibytes
,callbacks
);
1055 int ov_test(FILE *f
,OggVorbis_File
*vf
,char *initial
,long ibytes
){
1056 ov_callbacks callbacks
= {
1057 (size_t (*)(void *, size_t, size_t, void *)) fread
,
1058 (int (*)(void *, ogg_int64_t
, int)) _fseek64_wrap
,
1059 (int (*)(void *)) fclose
,
1060 (long (*)(void *)) ftell
1063 return ov_test_callbacks((void *)f
, vf
, initial
, ibytes
, callbacks
);
1066 int ov_test_open(OggVorbis_File
*vf
){
1067 if(vf
->ready_state
!=PARTOPEN
)return(OV_EINVAL
);
1068 return _ov_open2(vf
);
1071 /* How many logical bitstreams in this physical bitstream? */
1072 long ov_streams(OggVorbis_File
*vf
){
1076 /* Is the FILE * associated with vf seekable? */
1077 long ov_seekable(OggVorbis_File
*vf
){
1078 return vf
->seekable
;
1081 /* returns the bitrate for a given logical bitstream or the entire
1082 physical bitstream. If the file is open for random access, it will
1083 find the *actual* average bitrate. If the file is streaming, it
1084 returns the nominal bitrate (if set) else the average of the
1085 upper/lower bounds (if set) else -1 (unset).
1087 If you want the actual bitrate field settings, get them from the
1088 vorbis_info structs */
1090 long ov_bitrate(OggVorbis_File
*vf
,int i
){
1091 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1092 if(i
>=vf
->links
)return(OV_EINVAL
);
1093 if(!vf
->seekable
&& i
!=0)return(ov_bitrate(vf
,0));
1098 for(i
=0;i
<vf
->links
;i
++)
1099 bits
+=(vf
->offsets
[i
+1]-vf
->dataoffsets
[i
])*8;
1100 /* This once read: return(rint(bits/ov_time_total(vf,-1)));
1101 * gcc 3.x on x86 miscompiled this at optimisation level 2 and above,
1102 * so this is slightly transformed to make it work.
1104 br
= bits
/ov_time_total(vf
,-1);
1108 /* return the actual bitrate */
1109 return(rint((vf
->offsets
[i
+1]-vf
->dataoffsets
[i
])*8/ov_time_total(vf
,i
)));
1111 /* return nominal if set */
1112 if(vf
->vi
[i
].bitrate_nominal
>0){
1113 return vf
->vi
[i
].bitrate_nominal
;
1115 if(vf
->vi
[i
].bitrate_upper
>0){
1116 if(vf
->vi
[i
].bitrate_lower
>0){
1117 return (vf
->vi
[i
].bitrate_upper
+vf
->vi
[i
].bitrate_lower
)/2;
1119 return vf
->vi
[i
].bitrate_upper
;
1128 /* returns the actual bitrate since last call. returns -1 if no
1129 additional data to offer since last call (or at beginning of stream),
1130 EINVAL if stream is only partially open
1132 long ov_bitrate_instant(OggVorbis_File
*vf
){
1133 int link
=(vf
->seekable
?vf
->current_link
:0);
1135 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1136 if(vf
->samptrack
==0)return(OV_FALSE
);
1137 ret
=vf
->bittrack
/vf
->samptrack
*vf
->vi
[link
].rate
+.5;
1144 long ov_serialnumber(OggVorbis_File
*vf
,int i
){
1145 if(i
>=vf
->links
)return(ov_serialnumber(vf
,vf
->links
-1));
1146 if(!vf
->seekable
&& i
>=0)return(ov_serialnumber(vf
,-1));
1148 return(vf
->current_serialno
);
1150 return(vf
->serialnos
[i
]);
1154 /* returns: total raw (compressed) length of content if i==-1
1155 raw (compressed) length of that logical bitstream for i==0 to n
1156 OV_EINVAL if the stream is not seekable (we can't know the length)
1157 or if stream is only partially open
1159 ogg_int64_t
ov_raw_total(OggVorbis_File
*vf
,int i
){
1160 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1161 if(!vf
->seekable
|| i
>=vf
->links
)return(OV_EINVAL
);
1165 for(i
=0;i
<vf
->links
;i
++)
1166 acc
+=ov_raw_total(vf
,i
);
1169 return(vf
->offsets
[i
+1]-vf
->offsets
[i
]);
1173 /* returns: total PCM length (samples) of content if i==-1 PCM length
1174 (samples) of that logical bitstream for i==0 to n
1175 OV_EINVAL if the stream is not seekable (we can't know the
1176 length) or only partially open
1178 ogg_int64_t
ov_pcm_total(OggVorbis_File
*vf
,int i
){
1179 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1180 if(!vf
->seekable
|| i
>=vf
->links
)return(OV_EINVAL
);
1184 for(i
=0;i
<vf
->links
;i
++)
1185 acc
+=ov_pcm_total(vf
,i
);
1188 return(vf
->pcmlengths
[i
*2+1]);
1192 /* returns: total seconds of content if i==-1
1193 seconds in that logical bitstream for i==0 to n
1194 OV_EINVAL if the stream is not seekable (we can't know the
1195 length) or only partially open
1197 double ov_time_total(OggVorbis_File
*vf
,int i
){
1198 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1199 if(!vf
->seekable
|| i
>=vf
->links
)return(OV_EINVAL
);
1203 for(i
=0;i
<vf
->links
;i
++)
1204 acc
+=ov_time_total(vf
,i
);
1207 return((double)(vf
->pcmlengths
[i
*2+1])/vf
->vi
[i
].rate
);
1211 /* seek to an offset relative to the *compressed* data. This also
1212 scans packets to update the PCM cursor. It will cross a logical
1213 bitstream boundary, but only if it can't get any packets out of the
1214 tail of the bitstream we seek to (so no surprises).
1216 returns zero on success, nonzero on failure */
1218 int ov_raw_seek(OggVorbis_File
*vf
,ogg_int64_t pos
){
1219 ogg_stream_state work_os
;
1222 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1224 return(OV_ENOSEEK
); /* don't dump machine if we can't seek */
1226 if(pos
<0 || pos
>vf
->end
)return(OV_EINVAL
);
1228 /* don't yet clear out decoding machine (if it's initialized), in
1229 the case we're in the same link. Restart the decode lapping, and
1230 let _fetch_and_process_packet deal with a potential bitstream
1233 ogg_stream_reset_serialno(&vf
->os
,
1234 vf
->current_serialno
); /* must set serialno */
1235 vorbis_synthesis_restart(&vf
->vd
);
1237 ret
=_seek_helper(vf
,pos
);
1238 if(ret
)goto seek_error
;
1240 /* we need to make sure the pcm_offset is set, but we don't want to
1241 advance the raw cursor past good packets just to get to the first
1242 with a granulepos. That's not equivalent behavior to beginning
1243 decoding as immediately after the seek position as possible.
1245 So, a hack. We use two stream states; a local scratch state and
1246 the shared vf->os stream state. We use the local state to
1247 scan, and the shared state as a buffer for later decode.
1249 Unfortuantely, on the last page we still advance to last packet
1250 because the granulepos on the last page is not necessarily on a
1251 packet boundary, and we need to make sure the granpos is
1263 ogg_int64_t pagepos
=-1;
1265 ogg_stream_init(&work_os
,vf
->current_serialno
); /* get the memory ready */
1266 ogg_stream_reset(&work_os
); /* eliminate the spurious OV_HOLE
1267 return from not necessarily
1268 starting from the beginning */
1271 if(vf
->ready_state
>=STREAMSET
){
1272 /* snarf/scan a packet if we can */
1273 int result
=ogg_stream_packetout(&work_os
,&op
);
1277 if(vf
->vi
[vf
->current_link
].codec_setup
){
1278 thisblock
=vorbis_packet_blocksize(vf
->vi
+vf
->current_link
,&op
);
1280 ogg_stream_packetout(&vf
->os
,NULL
);
1284 /* We can't get a guaranteed correct pcm position out of the
1285 last page in a stream because it might have a 'short'
1286 granpos, which can only be detected in the presence of a
1287 preceeding page. However, if the last page is also the first
1288 page, the granpos rules of a first page take precedence. Not
1289 only that, but for first==last, the EOS page must be treated
1290 as if its a normal first page for the stream to open/play. */
1291 if(lastflag
&& !firstflag
)
1292 ogg_stream_packetout(&vf
->os
,NULL
);
1294 if(lastblock
)accblock
+=(lastblock
+thisblock
)>>2;
1297 if(op
.granulepos
!=-1){
1298 int i
,link
=vf
->current_link
;
1299 ogg_int64_t granulepos
=op
.granulepos
-vf
->pcmlengths
[link
*2];
1300 if(granulepos
<0)granulepos
=0;
1303 granulepos
+=vf
->pcmlengths
[i
*2+1];
1304 vf
->pcm_offset
=granulepos
-accblock
;
1305 if(vf
->pcm_offset
<0)vf
->pcm_offset
=0;
1308 lastblock
=thisblock
;
1311 ogg_stream_packetout(&vf
->os
,NULL
);
1316 pagepos
=_get_next_page(vf
,&og
,-1);
1318 vf
->pcm_offset
=ov_pcm_total(vf
,-1);
1322 /* huh? Bogus stream with packets but no granulepos */
1327 /* has our decoding just traversed a bitstream boundary? */
1328 if(vf
->ready_state
>=STREAMSET
){
1329 if(vf
->current_serialno
!=ogg_page_serialno(&og
)){
1331 /* two possibilities:
1332 1) our decoding just traversed a bitstream boundary
1333 2) another stream is multiplexed into this logical section? */
1335 if(ogg_page_bos(&og
)){
1337 _decode_clear(vf
); /* clear out stream state */
1338 ogg_stream_clear(&work_os
);
1339 } /* else, do nothing; next loop will scoop another page */
1343 if(vf
->ready_state
<STREAMSET
){
1345 long serialno
= ogg_page_serialno(&og
);
1347 for(link
=0;link
<vf
->links
;link
++)
1348 if(vf
->serialnos
[link
]==serialno
)break;
1350 if(link
==vf
->links
) continue; /* not the desired Vorbis
1351 bitstream section; keep
1353 vf
->current_link
=link
;
1354 vf
->current_serialno
=serialno
;
1355 ogg_stream_reset_serialno(&vf
->os
,serialno
);
1356 ogg_stream_reset_serialno(&work_os
,serialno
);
1357 vf
->ready_state
=STREAMSET
;
1358 firstflag
=(pagepos
<=vf
->dataoffsets
[link
]);
1361 ogg_stream_pagein(&vf
->os
,&og
);
1362 ogg_stream_pagein(&work_os
,&og
);
1363 lastflag
=ogg_page_eos(&og
);
1368 ogg_stream_clear(&work_os
);
1374 /* dump the machine so we're in a known state */
1376 ogg_stream_clear(&work_os
);
1381 /* Page granularity seek (faster than sample granularity because we
1382 don't do the last bit of decode to find a specific sample).
1384 Seek to the last [granule marked] page preceeding the specified pos
1385 location, such that decoding past the returned point will quickly
1386 arrive at the requested position. */
1387 int ov_pcm_seek_page(OggVorbis_File
*vf
,ogg_int64_t pos
){
1389 ogg_int64_t result
=0;
1390 ogg_int64_t total
=ov_pcm_total(vf
,-1);
1392 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1393 if(!vf
->seekable
)return(OV_ENOSEEK
);
1395 if(pos
<0 || pos
>total
)return(OV_EINVAL
);
1397 /* which bitstream section does this pcm offset occur in? */
1398 for(link
=vf
->links
-1;link
>=0;link
--){
1399 total
-=vf
->pcmlengths
[link
*2+1];
1400 if(pos
>=total
)break;
1403 /* search within the logical bitstream for the page with the highest
1404 pcm_pos preceeding (or equal to) pos. There is a danger here;
1405 missing pages or incorrect frame number information in the
1406 bitstream could make our task impossible. Account for that (it
1407 would be an error condition) */
1409 /* new search algorithm by HB (Nicholas Vinen) */
1411 ogg_int64_t end
=vf
->offsets
[link
+1];
1412 ogg_int64_t begin
=vf
->offsets
[link
];
1413 ogg_int64_t begintime
= vf
->pcmlengths
[link
*2];
1414 ogg_int64_t endtime
= vf
->pcmlengths
[link
*2+1]+begintime
;
1415 ogg_int64_t target
=pos
-total
+begintime
;
1416 ogg_int64_t best
=begin
;
1422 if(end
-begin
<CHUNKSIZE
){
1425 /* take a (pretty decent) guess. */
1427 (ogg_int64_t
)((double)(target
-begintime
)*(end
-begin
)/(endtime
-begintime
))
1433 result
=_seek_helper(vf
,bisect
);
1434 if(result
) goto seek_error
;
1437 result
=_get_next_page(vf
,&og
,end
-vf
->offset
);
1438 if(result
==OV_EREAD
) goto seek_error
;
1441 end
=begin
; /* found it */
1443 if(bisect
==0) goto seek_error
;
1445 if(bisect
<=begin
)bisect
=begin
+1;
1446 result
=_seek_helper(vf
,bisect
);
1447 if(result
) goto seek_error
;
1450 ogg_int64_t granulepos
;
1452 if(ogg_page_serialno(&og
)!=vf
->serialnos
[link
])
1455 granulepos
=ogg_page_granulepos(&og
);
1456 if(granulepos
==-1)continue;
1458 if(granulepos
<target
){
1459 best
=result
; /* raw offset of packet with granulepos */
1460 begin
=vf
->offset
; /* raw offset of next page */
1461 begintime
=granulepos
;
1463 if(target
-begintime
>44100)break;
1464 bisect
=begin
; /* *not* begin + 1 */
1467 end
=begin
; /* found it */
1469 if(end
==vf
->offset
){ /* we're pretty close - we'd be stuck in */
1471 bisect
-=CHUNKSIZE
; /* an endless loop otherwise. */
1472 if(bisect
<=begin
)bisect
=begin
+1;
1473 result
=_seek_helper(vf
,bisect
);
1474 if(result
) goto seek_error
;
1486 /* found our page. seek to it, update pcm offset. Easier case than
1487 raw_seek, don't keep packets preceeding granulepos. */
1493 result
=_seek_helper(vf
,best
);
1495 if(result
) goto seek_error
;
1496 result
=_get_next_page(vf
,&og
,-1);
1497 if(result
<0) goto seek_error
;
1499 if(link
!=vf
->current_link
){
1500 /* Different link; dump entire decode machine */
1503 vf
->current_link
=link
;
1504 vf
->current_serialno
=vf
->serialnos
[link
];
1505 vf
->ready_state
=STREAMSET
;
1508 vorbis_synthesis_restart(&vf
->vd
);
1511 ogg_stream_reset_serialno(&vf
->os
,vf
->current_serialno
);
1512 ogg_stream_pagein(&vf
->os
,&og
);
1514 /* pull out all but last packet; the one with granulepos */
1516 result
=ogg_stream_packetpeek(&vf
->os
,&op
);
1518 /* !!! the packet finishing this page originated on a
1519 preceeding page. Keep fetching previous pages until we
1520 get one with a granulepos or without the 'continued' flag
1521 set. Then just use raw_seek for simplicity. */
1523 result
=_seek_helper(vf
,best
);
1524 if(result
<0) goto seek_error
;
1527 result
=_get_prev_page(vf
,&og
);
1528 if(result
<0) goto seek_error
;
1529 if(ogg_page_serialno(&og
)==vf
->current_serialno
&&
1530 (ogg_page_granulepos(&og
)>-1 ||
1531 !ogg_page_continued(&og
))){
1532 return ov_raw_seek(vf
,result
);
1538 result
= OV_EBADPACKET
;
1541 if(op
.granulepos
!=-1){
1542 vf
->pcm_offset
=op
.granulepos
-vf
->pcmlengths
[vf
->current_link
*2];
1543 if(vf
->pcm_offset
<0)vf
->pcm_offset
=0;
1544 vf
->pcm_offset
+=total
;
1547 result
=ogg_stream_packetout(&vf
->os
,NULL
);
1553 if(vf
->pcm_offset
>pos
|| pos
>ov_pcm_total(vf
,-1)){
1562 /* dump machine so we're in a known state */
1568 /* seek to a sample offset relative to the decompressed pcm stream
1569 returns zero on success, nonzero on failure */
1571 int ov_pcm_seek(OggVorbis_File
*vf
,ogg_int64_t pos
){
1572 int thisblock
,lastblock
=0;
1573 int ret
=ov_pcm_seek_page(vf
,pos
);
1574 if(ret
<0)return(ret
);
1575 if((ret
=_make_decode_ready(vf
)))return ret
;
1577 /* discard leading packets we don't need for the lapping of the
1578 position we want; don't decode them */
1584 int ret
=ogg_stream_packetpeek(&vf
->os
,&op
);
1586 thisblock
=vorbis_packet_blocksize(vf
->vi
+vf
->current_link
,&op
);
1588 ogg_stream_packetout(&vf
->os
,NULL
);
1589 continue; /* non audio packet */
1591 if(lastblock
)vf
->pcm_offset
+=(lastblock
+thisblock
)>>2;
1593 if(vf
->pcm_offset
+((thisblock
+
1594 vorbis_info_blocksize(vf
->vi
,1))>>2)>=pos
)break;
1596 /* remove the packet from packet queue and track its granulepos */
1597 ogg_stream_packetout(&vf
->os
,NULL
);
1598 vorbis_synthesis_trackonly(&vf
->vb
,&op
); /* set up a vb with
1601 vorbis_synthesis_blockin(&vf
->vd
,&vf
->vb
);
1603 /* end of logical stream case is hard, especially with exact
1604 length positioning. */
1606 if(op
.granulepos
>-1){
1608 /* always believe the stream markers */
1609 vf
->pcm_offset
=op
.granulepos
-vf
->pcmlengths
[vf
->current_link
*2];
1610 if(vf
->pcm_offset
<0)vf
->pcm_offset
=0;
1611 for(i
=0;i
<vf
->current_link
;i
++)
1612 vf
->pcm_offset
+=vf
->pcmlengths
[i
*2+1];
1615 lastblock
=thisblock
;
1618 if(ret
<0 && ret
!=OV_HOLE
)break;
1620 /* suck in a new page */
1621 if(_get_next_page(vf
,&og
,-1)<0)break;
1622 if(ogg_page_bos(&og
))_decode_clear(vf
);
1624 if(vf
->ready_state
<STREAMSET
){
1625 long serialno
=ogg_page_serialno(&og
);
1628 for(link
=0;link
<vf
->links
;link
++)
1629 if(vf
->serialnos
[link
]==serialno
)break;
1630 if(link
==vf
->links
) continue;
1631 vf
->current_link
=link
;
1633 vf
->ready_state
=STREAMSET
;
1634 vf
->current_serialno
=ogg_page_serialno(&og
);
1635 ogg_stream_reset_serialno(&vf
->os
,serialno
);
1636 ret
=_make_decode_ready(vf
);
1641 ogg_stream_pagein(&vf
->os
,&og
);
1647 /* discard samples until we reach the desired position. Crossing a
1648 logical bitstream boundary with abandon is OK. */
1649 while(vf
->pcm_offset
<pos
){
1650 ogg_int64_t target
=pos
-vf
->pcm_offset
;
1651 long samples
=vorbis_synthesis_pcmout(&vf
->vd
,NULL
);
1653 if(samples
>target
)samples
=target
;
1654 vorbis_synthesis_read(&vf
->vd
,samples
);
1655 vf
->pcm_offset
+=samples
;
1658 if(_fetch_and_process_packet(vf
,NULL
,1,1)<=0)
1659 vf
->pcm_offset
=ov_pcm_total(vf
,-1); /* eof */
1664 /* seek to a playback time relative to the decompressed pcm stream
1665 returns zero on success, nonzero on failure */
1666 int ov_time_seek(OggVorbis_File
*vf
,double seconds
){
1667 /* translate time to PCM position and call ov_pcm_seek */
1670 ogg_int64_t pcm_total
=0;
1671 double time_total
=0.;
1673 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1674 if(!vf
->seekable
)return(OV_ENOSEEK
);
1675 if(seconds
<0)return(OV_EINVAL
);
1677 /* which bitstream section does this time offset occur in? */
1678 for(link
=0;link
<vf
->links
;link
++){
1679 double addsec
= ov_time_total(vf
,link
);
1680 if(seconds
<time_total
+addsec
)break;
1682 pcm_total
+=vf
->pcmlengths
[link
*2+1];
1685 if(link
==vf
->links
)return(OV_EINVAL
);
1687 /* enough information to convert time offset to pcm offset */
1689 ogg_int64_t target
=pcm_total
+(seconds
-time_total
)*vf
->vi
[link
].rate
;
1690 return(ov_pcm_seek(vf
,target
));
1694 /* page-granularity version of ov_time_seek
1695 returns zero on success, nonzero on failure */
1696 int ov_time_seek_page(OggVorbis_File
*vf
,double seconds
){
1697 /* translate time to PCM position and call ov_pcm_seek */
1700 ogg_int64_t pcm_total
=0;
1701 double time_total
=0.;
1703 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1704 if(!vf
->seekable
)return(OV_ENOSEEK
);
1705 if(seconds
<0)return(OV_EINVAL
);
1707 /* which bitstream section does this time offset occur in? */
1708 for(link
=0;link
<vf
->links
;link
++){
1709 double addsec
= ov_time_total(vf
,link
);
1710 if(seconds
<time_total
+addsec
)break;
1712 pcm_total
+=vf
->pcmlengths
[link
*2+1];
1715 if(link
==vf
->links
)return(OV_EINVAL
);
1717 /* enough information to convert time offset to pcm offset */
1719 ogg_int64_t target
=pcm_total
+(seconds
-time_total
)*vf
->vi
[link
].rate
;
1720 return(ov_pcm_seek_page(vf
,target
));
1724 /* tell the current stream offset cursor. Note that seek followed by
1725 tell will likely not give the set offset due to caching */
1726 ogg_int64_t
ov_raw_tell(OggVorbis_File
*vf
){
1727 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1731 /* return PCM offset (sample) of next PCM sample to be read */
1732 ogg_int64_t
ov_pcm_tell(OggVorbis_File
*vf
){
1733 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1734 return(vf
->pcm_offset
);
1737 /* return time offset (seconds) of next PCM sample to be read */
1738 double ov_time_tell(OggVorbis_File
*vf
){
1740 ogg_int64_t pcm_total
=0;
1741 double time_total
=0.f
;
1743 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1745 pcm_total
=ov_pcm_total(vf
,-1);
1746 time_total
=ov_time_total(vf
,-1);
1748 /* which bitstream section does this time offset occur in? */
1749 for(link
=vf
->links
-1;link
>=0;link
--){
1750 pcm_total
-=vf
->pcmlengths
[link
*2+1];
1751 time_total
-=ov_time_total(vf
,link
);
1752 if(vf
->pcm_offset
>=pcm_total
)break;
1756 return((double)time_total
+(double)(vf
->pcm_offset
-pcm_total
)/vf
->vi
[link
].rate
);
1759 /* link: -1) return the vorbis_info struct for the bitstream section
1760 currently being decoded
1761 0-n) to request information for a specific bitstream section
1763 In the case of a non-seekable bitstream, any call returns the
1764 current bitstream. NULL in the case that the machine is not
1767 vorbis_info
*ov_info(OggVorbis_File
*vf
,int link
){
1770 if(vf
->ready_state
>=STREAMSET
)
1771 return vf
->vi
+vf
->current_link
;
1784 /* grr, strong typing, grr, no templates/inheritence, grr */
1785 vorbis_comment
*ov_comment(OggVorbis_File
*vf
,int link
){
1788 if(vf
->ready_state
>=STREAMSET
)
1789 return vf
->vc
+vf
->current_link
;
1802 static int host_is_big_endian() {
1803 ogg_int32_t pattern
= 0xfeedface; /* deadbeef */
1804 unsigned char *bytewise
= (unsigned char *)&pattern
;
1805 if (bytewise
[0] == 0xfe) return 1;
1809 /* up to this point, everything could more or less hide the multiple
1810 logical bitstream nature of chaining from the toplevel application
1811 if the toplevel application didn't particularly care. However, at
1812 the point that we actually read audio back, the multiple-section
1813 nature must surface: Multiple bitstream sections do not necessarily
1814 have to have the same number of channels or sampling rate.
1816 ov_read returns the sequential logical bitstream number currently
1817 being decoded along with the PCM data in order that the toplevel
1818 application can take action on channel/sample rate changes. This
1819 number will be incremented even for streamed (non-seekable) streams
1820 (for seekable streams, it represents the actual logical bitstream
1821 index within the physical bitstream. Note that the accessor
1822 functions above are aware of this dichotomy).
1824 ov_read_filter is exactly the same as ov_read except that it processes
1825 the decoded audio data through a filter before packing it into the
1826 requested format. This gives greater accuracy than applying a filter
1827 after the audio has been converted into integral PCM.
1829 input values: buffer) a buffer to hold packed PCM data for return
1830 length) the byte length requested to be placed into buffer
1831 bigendianp) should the data be packed LSB first (0) or
1833 word) word size for output. currently 1 (byte) or
1836 return values: <0) error/hole in data (OV_HOLE), partial open (OV_EINVAL)
1838 n) number of bytes of PCM actually returned. The
1839 below works on a packet-by-packet basis, so the
1840 return length is not related to the 'length' passed
1841 in, just guaranteed to fit.
1843 *section) set to the logical bitstream number */
1845 long ov_read_filter(OggVorbis_File
*vf
,char *buffer
,int length
,
1846 int bigendianp
,int word
,int sgned
,int *bitstream
,
1847 void (*filter
)(float **pcm
,long channels
,long samples
,void *filter_param
),void *filter_param
){
1849 int host_endian
= host_is_big_endian();
1854 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
1857 if(vf
->ready_state
==INITSET
){
1858 samples
=vorbis_synthesis_pcmout(&vf
->vd
,&pcm
);
1862 /* suck in another packet */
1864 int ret
=_fetch_and_process_packet(vf
,NULL
,1,1);
1875 /* yay! proceed to pack data into the byte buffer */
1877 long channels
=ov_info(vf
,-1)->channels
;
1878 long bytespersample
=word
* channels
;
1879 vorbis_fpu_control fpu
;
1880 if(samples
>length
/bytespersample
)samples
=length
/bytespersample
;
1887 filter(pcm
,channels
,samples
,filter_param
);
1889 /* a tight loop to pack each size */
1893 int off
=(sgned
?0:128);
1894 vorbis_fpu_setround(&fpu
);
1895 for(j
=0;j
<samples
;j
++)
1896 for(i
=0;i
<channels
;i
++){
1897 val
=vorbis_ftoi(pcm
[i
][j
]*128.f
);
1899 else if(val
<-128)val
=-128;
1902 vorbis_fpu_restore(fpu
);
1904 int off
=(sgned
?0:32768);
1906 if(host_endian
==bigendianp
){
1909 vorbis_fpu_setround(&fpu
);
1910 for(i
=0;i
<channels
;i
++) { /* It's faster in this order */
1912 short *dest
=((short *)buffer
)+i
;
1913 for(j
=0;j
<samples
;j
++) {
1914 val
=vorbis_ftoi(src
[j
]*32768.f
);
1915 if(val
>32767)val
=32767;
1916 else if(val
<-32768)val
=-32768;
1921 vorbis_fpu_restore(fpu
);
1925 vorbis_fpu_setround(&fpu
);
1926 for(i
=0;i
<channels
;i
++) {
1928 short *dest
=((short *)buffer
)+i
;
1929 for(j
=0;j
<samples
;j
++) {
1930 val
=vorbis_ftoi(src
[j
]*32768.f
);
1931 if(val
>32767)val
=32767;
1932 else if(val
<-32768)val
=-32768;
1937 vorbis_fpu_restore(fpu
);
1940 }else if(bigendianp
){
1942 vorbis_fpu_setround(&fpu
);
1943 for(j
=0;j
<samples
;j
++)
1944 for(i
=0;i
<channels
;i
++){
1945 val
=vorbis_ftoi(pcm
[i
][j
]*32768.f
);
1946 if(val
>32767)val
=32767;
1947 else if(val
<-32768)val
=-32768;
1950 *buffer
++=(val
&0xff);
1952 vorbis_fpu_restore(fpu
);
1956 vorbis_fpu_setround(&fpu
);
1957 for(j
=0;j
<samples
;j
++)
1958 for(i
=0;i
<channels
;i
++){
1959 val
=vorbis_ftoi(pcm
[i
][j
]*32768.f
);
1960 if(val
>32767)val
=32767;
1961 else if(val
<-32768)val
=-32768;
1963 *buffer
++=(val
&0xff);
1966 vorbis_fpu_restore(fpu
);
1972 vorbis_synthesis_read(&vf
->vd
,samples
);
1973 vf
->pcm_offset
+=samples
;
1974 if(bitstream
)*bitstream
=vf
->current_link
;
1975 return(samples
*bytespersample
);
1981 long ov_read(OggVorbis_File
*vf
,char *buffer
,int length
,
1982 int bigendianp
,int word
,int sgned
,int *bitstream
){
1983 return ov_read_filter(vf
, buffer
, length
, bigendianp
, word
, sgned
, bitstream
, NULL
, NULL
);
1986 /* input values: pcm_channels) a float vector per channel of output
1987 length) the sample length being read by the app
1989 return values: <0) error/hole in data (OV_HOLE), partial open (OV_EINVAL)
1991 n) number of samples of PCM actually returned. The
1992 below works on a packet-by-packet basis, so the
1993 return length is not related to the 'length' passed
1994 in, just guaranteed to fit.
1996 *section) set to the logical bitstream number */
2000 long ov_read_float(OggVorbis_File
*vf
,float ***pcm_channels
,int length
,
2003 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
2006 if(vf
->ready_state
==INITSET
){
2008 long samples
=vorbis_synthesis_pcmout(&vf
->vd
,&pcm
);
2010 if(pcm_channels
)*pcm_channels
=pcm
;
2011 if(samples
>length
)samples
=length
;
2012 vorbis_synthesis_read(&vf
->vd
,samples
);
2013 vf
->pcm_offset
+=samples
;
2014 if(bitstream
)*bitstream
=vf
->current_link
;
2020 /* suck in another packet */
2022 int ret
=_fetch_and_process_packet(vf
,NULL
,1,1);
2023 if(ret
==OV_EOF
)return(0);
2024 if(ret
<=0)return(ret
);
2030 extern float *vorbis_window(vorbis_dsp_state
*v
,int W
);
2032 static void _ov_splice(float **pcm
,float **lappcm
,
2035 float *w1
, float *w2
){
2046 for(j
=0;j
<ch1
&& j
<ch2
;j
++){
2053 d
[i
]=d
[i
]*wd
+ s
[i
]*ws
;
2056 /* window from zero */
2067 /* make sure vf is INITSET */
2068 static int _ov_initset(OggVorbis_File
*vf
){
2070 if(vf
->ready_state
==INITSET
)break;
2071 /* suck in another packet */
2073 int ret
=_fetch_and_process_packet(vf
,NULL
,1,0);
2074 if(ret
<0 && ret
!=OV_HOLE
)return(ret
);
2080 /* make sure vf is INITSET and that we have a primed buffer; if
2081 we're crosslapping at a stream section boundary, this also makes
2082 sure we're sanity checking against the right stream information */
2083 static int _ov_initprime(OggVorbis_File
*vf
){
2084 vorbis_dsp_state
*vd
=&vf
->vd
;
2086 if(vf
->ready_state
==INITSET
)
2087 if(vorbis_synthesis_pcmout(vd
,NULL
))break;
2089 /* suck in another packet */
2091 int ret
=_fetch_and_process_packet(vf
,NULL
,1,0);
2092 if(ret
<0 && ret
!=OV_HOLE
)return(ret
);
2098 /* grab enough data for lapping from vf; this may be in the form of
2099 unreturned, already-decoded pcm, remaining PCM we will need to
2100 decode, or synthetic postextrapolation from last packets. */
2101 static void _ov_getlap(OggVorbis_File
*vf
,vorbis_info
*vi
,vorbis_dsp_state
*vd
,
2102 float **lappcm
,int lapsize
){
2106 /* try first to decode the lapping data */
2107 while(lapcount
<lapsize
){
2108 int samples
=vorbis_synthesis_pcmout(vd
,&pcm
);
2110 if(samples
>lapsize
-lapcount
)samples
=lapsize
-lapcount
;
2111 for(i
=0;i
<vi
->channels
;i
++)
2112 memcpy(lappcm
[i
]+lapcount
,pcm
[i
],sizeof(**pcm
)*samples
);
2114 vorbis_synthesis_read(vd
,samples
);
2116 /* suck in another packet */
2117 int ret
=_fetch_and_process_packet(vf
,NULL
,1,0); /* do *not* span */
2118 if(ret
==OV_EOF
)break;
2121 if(lapcount
<lapsize
){
2122 /* failed to get lapping data from normal decode; pry it from the
2123 postextrapolation buffering, or the second half of the MDCT
2124 from the last packet */
2125 int samples
=vorbis_synthesis_lapout(&vf
->vd
,&pcm
);
2127 for(i
=0;i
<vi
->channels
;i
++)
2128 memset(lappcm
[i
]+lapcount
,0,sizeof(**pcm
)*lapsize
-lapcount
);
2131 if(samples
>lapsize
-lapcount
)samples
=lapsize
-lapcount
;
2132 for(i
=0;i
<vi
->channels
;i
++)
2133 memcpy(lappcm
[i
]+lapcount
,pcm
[i
],sizeof(**pcm
)*samples
);
2139 /* this sets up crosslapping of a sample by using trailing data from
2140 sample 1 and lapping it into the windowing buffer of sample 2 */
2141 int ov_crosslap(OggVorbis_File
*vf1
, OggVorbis_File
*vf2
){
2142 vorbis_info
*vi1
,*vi2
;
2146 int n1
,n2
,i
,ret
,hs1
,hs2
;
2148 if(vf1
==vf2
)return(0); /* degenerate case */
2149 if(vf1
->ready_state
<OPENED
)return(OV_EINVAL
);
2150 if(vf2
->ready_state
<OPENED
)return(OV_EINVAL
);
2152 /* the relevant overlap buffers must be pre-checked and pre-primed
2153 before looking at settings in the event that priming would cross
2154 a bitstream boundary. So, do it now */
2156 ret
=_ov_initset(vf1
);
2158 ret
=_ov_initprime(vf2
);
2161 vi1
=ov_info(vf1
,-1);
2162 vi2
=ov_info(vf2
,-1);
2163 hs1
=ov_halfrate_p(vf1
);
2164 hs2
=ov_halfrate_p(vf2
);
2166 lappcm
=alloca(sizeof(*lappcm
)*vi1
->channels
);
2167 n1
=vorbis_info_blocksize(vi1
,0)>>(1+hs1
);
2168 n2
=vorbis_info_blocksize(vi2
,0)>>(1+hs2
);
2169 w1
=vorbis_window(&vf1
->vd
,0);
2170 w2
=vorbis_window(&vf2
->vd
,0);
2172 for(i
=0;i
<vi1
->channels
;i
++)
2173 lappcm
[i
]=alloca(sizeof(**lappcm
)*n1
);
2175 _ov_getlap(vf1
,vi1
,&vf1
->vd
,lappcm
,n1
);
2177 /* have a lapping buffer from vf1; now to splice it into the lapping
2179 /* consolidate and expose the buffer. */
2180 vorbis_synthesis_lapout(&vf2
->vd
,&pcm
);
2183 _analysis_output_always("pcmL",0,pcm
[0],n1
*2,0,0,0);
2184 _analysis_output_always("pcmR",0,pcm
[1],n1
*2,0,0,0);
2188 _ov_splice(pcm
,lappcm
,n1
,n2
,vi1
->channels
,vi2
->channels
,w1
,w2
);
2194 static int _ov_64_seek_lap(OggVorbis_File
*vf
,ogg_int64_t pos
,
2195 int (*localseek
)(OggVorbis_File
*,ogg_int64_t
)){
2200 int n1
,n2
,ch1
,ch2
,hs
;
2203 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
2204 ret
=_ov_initset(vf
);
2207 hs
=ov_halfrate_p(vf
);
2210 n1
=vorbis_info_blocksize(vi
,0)>>(1+hs
);
2211 w1
=vorbis_window(&vf
->vd
,0); /* window arrays from libvorbis are
2212 persistent; even if the decode state
2213 from this link gets dumped, this
2214 window array continues to exist */
2216 lappcm
=alloca(sizeof(*lappcm
)*ch1
);
2218 lappcm
[i
]=alloca(sizeof(**lappcm
)*n1
);
2219 _ov_getlap(vf
,vi
,&vf
->vd
,lappcm
,n1
);
2221 /* have lapping data; seek and prime the buffer */
2222 ret
=localseek(vf
,pos
);
2224 ret
=_ov_initprime(vf
);
2227 /* Guard against cross-link changes; they're perfectly legal */
2230 n2
=vorbis_info_blocksize(vi
,0)>>(1+hs
);
2231 w2
=vorbis_window(&vf
->vd
,0);
2233 /* consolidate and expose the buffer. */
2234 vorbis_synthesis_lapout(&vf
->vd
,&pcm
);
2237 _ov_splice(pcm
,lappcm
,n1
,n2
,ch1
,ch2
,w1
,w2
);
2243 int ov_raw_seek_lap(OggVorbis_File
*vf
,ogg_int64_t pos
){
2244 return _ov_64_seek_lap(vf
,pos
,ov_raw_seek
);
2247 int ov_pcm_seek_lap(OggVorbis_File
*vf
,ogg_int64_t pos
){
2248 return _ov_64_seek_lap(vf
,pos
,ov_pcm_seek
);
2251 int ov_pcm_seek_page_lap(OggVorbis_File
*vf
,ogg_int64_t pos
){
2252 return _ov_64_seek_lap(vf
,pos
,ov_pcm_seek_page
);
2255 static int _ov_d_seek_lap(OggVorbis_File
*vf
,double pos
,
2256 int (*localseek
)(OggVorbis_File
*,double)){
2261 int n1
,n2
,ch1
,ch2
,hs
;
2264 if(vf
->ready_state
<OPENED
)return(OV_EINVAL
);
2265 ret
=_ov_initset(vf
);
2268 hs
=ov_halfrate_p(vf
);
2271 n1
=vorbis_info_blocksize(vi
,0)>>(1+hs
);
2272 w1
=vorbis_window(&vf
->vd
,0); /* window arrays from libvorbis are
2273 persistent; even if the decode state
2274 from this link gets dumped, this
2275 window array continues to exist */
2277 lappcm
=alloca(sizeof(*lappcm
)*ch1
);
2279 lappcm
[i
]=alloca(sizeof(**lappcm
)*n1
);
2280 _ov_getlap(vf
,vi
,&vf
->vd
,lappcm
,n1
);
2282 /* have lapping data; seek and prime the buffer */
2283 ret
=localseek(vf
,pos
);
2285 ret
=_ov_initprime(vf
);
2288 /* Guard against cross-link changes; they're perfectly legal */
2291 n2
=vorbis_info_blocksize(vi
,0)>>(1+hs
);
2292 w2
=vorbis_window(&vf
->vd
,0);
2294 /* consolidate and expose the buffer. */
2295 vorbis_synthesis_lapout(&vf
->vd
,&pcm
);
2298 _ov_splice(pcm
,lappcm
,n1
,n2
,ch1
,ch2
,w1
,w2
);
2304 int ov_time_seek_lap(OggVorbis_File
*vf
,double pos
){
2305 return _ov_d_seek_lap(vf
,pos
,ov_time_seek
);
2308 int ov_time_seek_page_lap(OggVorbis_File
*vf
,double pos
){
2309 return _ov_d_seek_lap(vf
,pos
,ov_time_seek_page
);