vorbisfile.c 44 KB
Newer Older
Monty's avatar
 
Monty committed
1 2
/********************************************************************
 *                                                                  *
Monty's avatar
 
Monty committed
3
 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
Monty's avatar
 
Monty committed
4 5 6
 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
Monty's avatar
 
Monty committed
7
 *                                                                  *
Monty's avatar
 
Monty committed
8
 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002             *
Monty's avatar
 
Monty committed
9
 * by the XIPHOPHORUS Company http://www.xiph.org/                  *
Monty's avatar
 
Monty committed
10
 *                                                                  *
Monty's avatar
 
Monty committed
11 12
 ********************************************************************

Monty's avatar
 
Monty committed
13
 function: stdio-based convenience library for opening/seeking/decoding
Monty's avatar
 
Monty committed
14
 last mod: $Id: vorbisfile.c,v 1.58 2002/03/04 01:02:04 xiphmont Exp $
Monty's avatar
 
Monty committed
15 16 17

 ********************************************************************/

Monty's avatar
 
Monty committed
18
#include <stdlib.h>
Monty's avatar
 
Monty committed
19
#include <stdio.h>
Monty's avatar
 
Monty committed
20
#include <errno.h>
Monty's avatar
 
Monty committed
21
#include <string.h>
Monty's avatar
 
Monty committed
22
#include <math.h>
23

Monty's avatar
 
Monty committed
24 25 26
#include "vorbis/codec.h"
#include "vorbis/vorbisfile.h"

Monty's avatar
 
Monty committed
27
#include "os.h"
Monty's avatar
 
Monty committed
28
#include "misc.h"
Monty's avatar
 
Monty committed
29 30 31 32 33 34 35

/* A 'chained bitstream' is a Vorbis bitstream that contains more than
   one logical bitstream arranged end to end (the only form of Ogg
   multiplexing allowed in a Vorbis bitstream; grouping [parallel
   multiplexing] is not allowed in Vorbis) */

/* A Vorbis file can be played beginning to end (streamed) without
Monty's avatar
 
Monty committed
36 37 38 39
   worrying ahead of time about chaining (see decoder_example.c).  If
   we have the whole file, however, and want random access
   (seeking/scrubbing) or desire to know the total length/time of a
   file, we need to account for the possibility of chaining. */
Monty's avatar
 
Monty committed
40 41

/* We can handle things a number of ways; we can determine the entire
Monty's avatar
 
Monty committed
42
   bitstream structure right off the bat, or find pieces on demand.
Monty's avatar
 
Monty committed
43
   This example determines and caches structure for the entire
Monty's avatar
 
Monty committed
44
   bitstream, but builds a virtual decoder on the fly when moving
Monty's avatar
 
Monty committed
45
   between links in the chain. */
Monty's avatar
 
Monty committed
46 47 48 49

/* There are also different ways to implement seeking.  Enough
   information exists in an Ogg bitstream to seek to
   sample-granularity positions in the output.  Or, one can seek by
Monty's avatar
 
Monty committed
50
   picking some portion of the stream roughly in the desired area if
Ralph Giles's avatar
Ralph Giles committed
51
   we only want coarse navigation through the stream. */
Monty's avatar
 
Monty committed
52

Monty's avatar
 
Monty committed
53 54 55 56 57 58
/*************************************************************************
 * Many, many internal helpers.  The intention is not to be confusing; 
 * rampant duplication and monolithic function implementation would be 
 * harder to understand anyway.  The high level functions are last.  Begin
 * grokking near the end of the file */

Ralph Giles's avatar
Ralph Giles committed
59 60
/* read a little more data from the file/pipe into the ogg_sync framer
*/
Monty's avatar
 
Monty committed
61 62
#define CHUNKSIZE 8500 /* a shade over 8k; anyone using pages well
                          over 8k gets what they deserve */
Monty's avatar
 
Monty committed
63
static long _get_data(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
64 65 66 67 68 69 70 71 72
  errno=0;
  if(vf->datasource){
    char *buffer=ogg_sync_buffer(&vf->oy,CHUNKSIZE);
    long bytes=(vf->callbacks.read_func)(buffer,1,CHUNKSIZE,vf->datasource);
    if(bytes>0)ogg_sync_wrote(&vf->oy,bytes);
    if(bytes==0 && errno)return(-1);
    return(bytes);
  }else
    return(0);
Monty's avatar
 
Monty committed
73 74 75 76
}

/* save a tiny smidge of verbosity to make the code more readable */
static void _seek_helper(OggVorbis_File *vf,long offset){
Monty's avatar
 
Monty committed
77 78 79 80 81 82 83 84
  if(vf->datasource){ 
    (vf->callbacks.seek_func)(vf->datasource, offset, SEEK_SET);
    vf->offset=offset;
    ogg_sync_reset(&vf->oy);
  }else{
    /* shouldn't happen unless someone writes a broken callback */
    return;
  }
Monty's avatar
 
Monty committed
85 86 87 88 89 90 91 92 93 94 95 96
}

/* The read/seek functions track absolute position within the stream */

/* from the head of the stream, get the next page.  boundary specifies
   if the function is allowed to fetch more data from the stream (and
   how much) or only use internally buffered data.

   boundary: -1) unbounded search
              0) read no additional data; use cached only
	      n) search for a new page beginning for n bytes

Monty's avatar
 
Monty committed
97
   return:   <0) did not find a page (OV_FALSE, OV_EOF, OV_EREAD)
Monty's avatar
 
Monty committed
98 99 100 101 102 103 104
              n) found a page at absolute offset n */

static long _get_next_page(OggVorbis_File *vf,ogg_page *og,int boundary){
  if(boundary>0)boundary+=vf->offset;
  while(1){
    long more;

Monty's avatar
 
Monty committed
105
    if(boundary>0 && vf->offset>=boundary)return(OV_FALSE);
Monty's avatar
 
Monty committed
106 107 108 109 110 111 112 113
    more=ogg_sync_pageseek(&vf->oy,og);
    
    if(more<0){
      /* skipped n bytes */
      vf->offset-=more;
    }else{
      if(more==0){
	/* send more paramedics */
Monty's avatar
 
Monty committed
114 115 116 117 118 119
	if(!boundary)return(OV_FALSE);
	{
	  long ret=_get_data(vf);
	  if(ret==0)return(OV_EOF);
	  if(ret<0)return(OV_EREAD);
	}
Monty's avatar
 
Monty committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
      }else{
	/* got a page.  Return the offset at the page beginning,
           advance the internal offset past the page end */
	long ret=vf->offset;
	vf->offset+=more;
	return(ret);
	
      }
    }
  }
}

/* find the latest page beginning before the current stream cursor
   position. Much dirtier than the above as Ogg doesn't have any
   backward search linkage.  no 'readp' as it will certainly have to
   read. */
Monty's avatar
 
Monty committed
136
/* returns offset or OV_EREAD, OV_FAULT */
Monty's avatar
 
Monty committed
137 138
static long _get_prev_page(OggVorbis_File *vf,ogg_page *og){
  long begin=vf->offset;
Monty's avatar
 
Monty committed
139
  long end=begin;
Monty's avatar
 
Monty committed
140 141 142 143 144
  long ret;
  int offset=-1;

  while(offset==-1){
    begin-=CHUNKSIZE;
145 146
    if(begin<0)
      begin=0;
Monty's avatar
 
Monty committed
147
    _seek_helper(vf,begin);
Monty's avatar
 
Monty committed
148 149
    while(vf->offset<end){
      ret=_get_next_page(vf,og,end-vf->offset);
Monty's avatar
 
Monty committed
150 151
      if(ret==OV_EREAD)return(OV_EREAD);
      if(ret<0){
Monty's avatar
 
Monty committed
152 153 154 155 156 157 158 159 160 161
	break;
      }else{
	offset=ret;
      }
    }
  }

  /* we have the offset.  Actually snork and hold the page now */
  _seek_helper(vf,offset);
  ret=_get_next_page(vf,og,CHUNKSIZE);
Monty's avatar
 
Monty committed
162
  if(ret<0)
Monty's avatar
 
Monty committed
163
    /* this shouldn't be possible */
Monty's avatar
 
Monty committed
164 165
    return(OV_EFAULT);

Monty's avatar
 
Monty committed
166 167 168 169 170 171 172
  return(offset);
}

/* finds each bitstream link one at a time using a bisection search
   (has to begin by knowing the offset of the lb's initial page).
   Recurses for each link so it can alloc the link storage after
   finding them all, then unroll and fill the cache at the same time */
Monty's avatar
 
Monty committed
173 174 175 176 177 178
static int _bisect_forward_serialno(OggVorbis_File *vf,
				    long begin,
				    long searched,
				    long end,
				    long currentno,
				    long m){
Monty's avatar
 
Monty committed
179 180 181
  long endsearched=end;
  long next=end;
  ogg_page og;
Monty's avatar
 
Monty committed
182
  long ret;
Monty's avatar
 
Monty committed
183
  
Monty's avatar
 
Monty committed
184 185 186 187 188 189 190 191 192 193 194 195 196
  /* the below guards against garbage seperating the last and
     first pages of two links. */
  while(searched<endsearched){
    long bisect;
    
    if(endsearched-searched<CHUNKSIZE){
      bisect=searched;
    }else{
      bisect=(searched+endsearched)/2;
    }
    
    _seek_helper(vf,bisect);
    ret=_get_next_page(vf,&og,-1);
Monty's avatar
 
Monty committed
197
    if(ret==OV_EREAD)return(OV_EREAD);
Monty's avatar
 
Monty committed
198 199 200 201 202 203 204
    if(ret<0 || ogg_page_serialno(&og)!=currentno){
      endsearched=bisect;
      if(ret>=0)next=ret;
    }else{
      searched=ret+og.header_len+og.body_len;
    }
  }
Monty's avatar
 
Monty committed
205 206 207

  _seek_helper(vf,next);
  ret=_get_next_page(vf,&og,-1);
Monty's avatar
 
Monty committed
208
  if(ret==OV_EREAD)return(OV_EREAD);
Monty's avatar
 
Monty committed
209
  
Monty's avatar
 
Monty committed
210
  if(searched>=end || ret<0){
Monty's avatar
 
Monty committed
211
    vf->links=m+1;
212
    vf->offsets=_ogg_malloc((m+2)*sizeof(*vf->offsets));
Monty's avatar
 
Monty committed
213 214
    vf->offsets[m+1]=searched;
  }else{
Monty's avatar
 
Monty committed
215 216 217
    ret=_bisect_forward_serialno(vf,next,vf->offset,
				 end,ogg_page_serialno(&og),m+1);
    if(ret==OV_EREAD)return(OV_EREAD);
Monty's avatar
 
Monty committed
218 219 220
  }
  
  vf->offsets[m]=begin;
Monty's avatar
 
Monty committed
221
  return(0);
Monty's avatar
 
Monty committed
222
}
Monty's avatar
 
Monty committed
223

Monty's avatar
 
Monty committed
224 225
/* uses the local ogg_stream storage in vf; this is important for
   non-streaming input sources */
Monty's avatar
 
Monty committed
226
static int _fetch_headers(OggVorbis_File *vf,vorbis_info *vi,vorbis_comment *vc,
Monty's avatar
 
Monty committed
227
			  long *serialno,ogg_page *og_ptr){
Monty's avatar
 
Monty committed
228 229
  ogg_page og;
  ogg_packet op;
Monty's avatar
 
Monty committed
230
  int i,ret=0;
Monty's avatar
 
Monty committed
231
  
Monty's avatar
 
Monty committed
232 233
  if(!og_ptr){
    ret=_get_next_page(vf,&og,CHUNKSIZE);
Monty's avatar
 
Monty committed
234 235
    if(ret==OV_EREAD)return(OV_EREAD);
    if(ret<0)return OV_ENOTVORBIS;
Monty's avatar
 
Monty committed
236 237 238 239 240
    og_ptr=&og;
  }

  if(serialno)*serialno=ogg_page_serialno(og_ptr);
  ogg_stream_init(&vf->os,ogg_page_serialno(og_ptr));
Monty's avatar
 
Monty committed
241
  vf->ready_state=STREAMSET;
Monty's avatar
 
Monty committed
242 243 244 245 246
  
  /* extract the initial header from the first page and verify that the
     Ogg bitstream is in fact Vorbis data */
  
  vorbis_info_init(vi);
Monty's avatar
 
Monty committed
247
  vorbis_comment_init(vc);
Monty's avatar
 
Monty committed
248 249 250
  
  i=0;
  while(i<3){
Monty's avatar
 
Monty committed
251
    ogg_stream_pagein(&vf->os,og_ptr);
Monty's avatar
 
Monty committed
252 253 254 255
    while(i<3){
      int result=ogg_stream_packetout(&vf->os,&op);
      if(result==0)break;
      if(result==-1){
Monty's avatar
 
Monty committed
256
	ret=OV_EBADHEADER;
Monty's avatar
 
Monty committed
257 258
	goto bail_header;
      }
Monty's avatar
 
Monty committed
259
      if((ret=vorbis_synthesis_headerin(vi,vc,&op))){
Monty's avatar
 
Monty committed
260 261 262 263 264
	goto bail_header;
      }
      i++;
    }
    if(i<3)
Monty's avatar
 
Monty committed
265
      if(_get_next_page(vf,og_ptr,CHUNKSIZE)<0){
Monty's avatar
 
Monty committed
266
	ret=OV_EBADHEADER;
Monty's avatar
 
Monty committed
267 268 269 270
	goto bail_header;
      }
  }
  return 0; 
Monty's avatar
 
Monty committed
271

Monty's avatar
 
Monty committed
272 273
 bail_header:
  vorbis_info_clear(vi);
Monty's avatar
 
Monty committed
274
  vorbis_comment_clear(vc);
Monty's avatar
 
Monty committed
275
  ogg_stream_clear(&vf->os);
Monty's avatar
 
Monty committed
276 277
  vf->ready_state=OPENED;

Monty's avatar
 
Monty committed
278
  return ret;
Monty's avatar
 
Monty committed
279
}
Monty's avatar
 
Monty committed
280

Monty's avatar
 
Monty committed
281 282 283 284
/* last step of the OggVorbis_File initialization; get all the
   vorbis_info structs and PCM positions.  Only called by the seekable
   initialization (local stream storage is hacked slightly; pay
   attention to how that's done) */
Monty's avatar
 
Monty committed
285 286 287 288 289

/* this is void and does not propogate errors up because we want to be
   able to open and use damaged bitstreams as well as we can.  Just
   watch out for missing information for links in the OggVorbis_File
   struct */
Monty's avatar
 
Monty committed
290
static void _prefetch_all_headers(OggVorbis_File *vf, long dataoffset){
Monty's avatar
 
Monty committed
291 292 293
  ogg_page og;
  int i,ret;
  
294 295 296 297 298
  vf->vi=_ogg_realloc(vf->vi,vf->links*sizeof(*vf->vi));
  vf->vc=_ogg_realloc(vf->vc,vf->links*sizeof(*vf->vc));
  vf->dataoffsets=_ogg_malloc(vf->links*sizeof(*vf->dataoffsets));
  vf->pcmlengths=_ogg_malloc(vf->links*sizeof(*vf->pcmlengths));
  vf->serialnos=_ogg_malloc(vf->links*sizeof(*vf->serialnos));
Monty's avatar
 
Monty committed
299 300
  
  for(i=0;i<vf->links;i++){
Monty's avatar
 
Monty committed
301 302
    if(i==0){
      /* we already grabbed the initial header earlier.  Just set the offset */
Monty's avatar
 
Monty committed
303
      vf->dataoffsets[i]=dataoffset;
Monty's avatar
 
Monty committed
304
    }else{
Monty's avatar
 
Monty committed
305

Monty's avatar
 
Monty committed
306
      /* seek to the location of the initial header */
Monty's avatar
 
Monty committed
307

Monty's avatar
 
Monty committed
308
      _seek_helper(vf,vf->offsets[i]);
Monty's avatar
 
Monty committed
309
      if(_fetch_headers(vf,vf->vi+i,vf->vc+i,NULL,NULL)<0){
Monty's avatar
 
Monty committed
310 311
    	vf->dataoffsets[i]=-1;
      }else{
Monty's avatar
 
Monty committed
312
	vf->dataoffsets[i]=vf->offset;
Monty's avatar
 
Monty committed
313 314
        ogg_stream_clear(&vf->os);
      }
Monty's avatar
 
Monty committed
315
    }
Monty's avatar
 
Monty committed
316

Monty's avatar
 
Monty committed
317 318 319 320 321
    /* get the serial number and PCM length of this link. To do this,
       get the last page of the stream */
    {
      long end=vf->offsets[i+1];
      _seek_helper(vf,end);
Monty's avatar
 
Monty committed
322

Monty's avatar
 
Monty committed
323 324
      while(1){
	ret=_get_prev_page(vf,&og);
Monty's avatar
 
Monty committed
325
	if(ret<0){
Monty's avatar
 
Monty committed
326
	  /* this should not be possible */
Monty's avatar
 
Monty committed
327
	  vorbis_info_clear(vf->vi+i);
Monty's avatar
 
Monty committed
328
	  vorbis_comment_clear(vf->vc+i);
Monty's avatar
 
Monty committed
329 330
	  break;
	}
Monty's avatar
 
Monty committed
331
	if(ogg_page_granulepos(&og)!=-1){
Monty's avatar
 
Monty committed
332
	  vf->serialnos[i]=ogg_page_serialno(&og);
Monty's avatar
 
Monty committed
333
	  vf->pcmlengths[i]=ogg_page_granulepos(&og);
Monty's avatar
 
Monty committed
334 335
	  break;
	}
Monty's avatar
 
Monty committed
336
	vf->offset=ret;
Monty's avatar
 
Monty committed
337 338 339
      }
    }
  }
Monty's avatar
 
Monty committed
340 341
}

Monty's avatar
 
Monty committed
342
static void _make_decode_ready(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
343
  if(vf->ready_state!=STREAMSET)return;
Monty's avatar
 
Monty committed
344 345 346 347 348
  if(vf->seekable){
    vorbis_synthesis_init(&vf->vd,vf->vi+vf->current_link);
  }else{
    vorbis_synthesis_init(&vf->vd,vf->vi);
  }    
Monty's avatar
 
Monty committed
349
  vorbis_block_init(&vf->vd,&vf->vb);
Monty's avatar
 
Monty committed
350
  vf->ready_state=INITSET;
Monty's avatar
 
Monty committed
351
  return;
Monty's avatar
 
Monty committed
352 353
}

Monty's avatar
 
Monty committed
354 355 356
static int _open_seekable2(OggVorbis_File *vf){
  long serialno=vf->current_serialno,end;
  long dataoffset=vf->offset;
Monty's avatar
 
Monty committed
357
  ogg_page og;
Monty's avatar
 
Monty committed
358 359 360

  /* we're partially open and have a first link header state in
     storage in vf */
Monty's avatar
 
Monty committed
361
  /* we can seek, so set out learning all about this file */
Michael Smith's avatar
 
Michael Smith committed
362 363
  (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
  vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
Monty's avatar
 
Monty committed
364 365 366 367
  
  /* We get the offset for the last page of the physical bitstream.
     Most OggVorbis files will contain a single logical bitstream */
  end=_get_prev_page(vf,&og);
Monty's avatar
 
Monty committed
368
  if(end<0)return(end);
Monty's avatar
 
Monty committed
369

Monty's avatar
 
Monty committed
370
  /* more than one logical bitstream? */
Monty's avatar
 
Monty committed
371
  if(ogg_page_serialno(&og)!=serialno){
Monty's avatar
 
Monty committed
372

Monty's avatar
 
Monty committed
373 374
    /* Chained bitstream. Bisect-search each logical bitstream
       section.  Do so based on serial number only */
Monty's avatar
 
Monty committed
375
    if(_bisect_forward_serialno(vf,0,0,end+1,serialno,0)<0)return(OV_EREAD);
Monty's avatar
 
Monty committed
376

Monty's avatar
 
Monty committed
377 378 379
  }else{

    /* Only one logical bitstream */
Monty's avatar
 
Monty committed
380
    if(_bisect_forward_serialno(vf,0,end,end+1,serialno,0))return(OV_EREAD);
Monty's avatar
 
Monty committed
381 382 383

  }

Monty's avatar
 
Monty committed
384 385
  /* the initial header memory is referenced by vf after; don't free it */
  _prefetch_all_headers(vf,dataoffset);
Monty's avatar
 
Monty committed
386
  return(ov_raw_seek(vf,0));
Monty's avatar
 
Monty committed
387
}
Monty's avatar
 
Monty committed
388 389 390 391 392 393

/* clear out the current logical bitstream decoder */ 
static void _decode_clear(OggVorbis_File *vf){
  ogg_stream_clear(&vf->os);
  vorbis_dsp_clear(&vf->vd);
  vorbis_block_clear(&vf->vb);
Monty's avatar
 
Monty committed
394
  vf->ready_state=OPENED;
Monty's avatar
 
Monty committed
395

Monty's avatar
 
Monty committed
396 397
  vf->bittrack=0.f;
  vf->samptrack=0.f;
Monty's avatar
 
Monty committed
398 399 400 401 402 403 404 405
}

/* fetch and process a packet.  Handles the case where we're at a
   bitstream boundary and dumps the decoding machine.  If the decoding
   machine is unloaded, it loads it.  It also keeps pcm_offset up to
   date (seek and read both use this.  seek uses a special hack with
   readp). 

Monty's avatar
 
Monty committed
406 407
   return: <0) error, OV_HOLE (lost packet) or OV_EOF
            0) need more data (only if readp==0)
Monty's avatar
 
Monty committed
408 409 410
	    1) got a packet 
*/

Monty's avatar
 
Monty committed
411 412 413
static int _fetch_and_process_packet(OggVorbis_File *vf,
				     ogg_packet *op_in,
				     int readp){
Monty's avatar
 
Monty committed
414 415 416 417 418 419 420 421
  ogg_page og;

  /* handle one packet.  Try to fetch it from current stream state */
  /* extract packets from page */
  while(1){
    
    /* process a packet if we can.  If the machine isn't loaded,
       neither is a page */
Monty's avatar
 
Monty committed
422
    if(vf->ready_state==INITSET){
423 424
      while(1) {
      	ogg_packet op;
Monty's avatar
 
Monty committed
425 426
      	ogg_packet *op_ptr=(op_in?op_in:&op);
	int result=ogg_stream_packetout(&vf->os,op_ptr);
427 428
	ogg_int64_t granulepos;

Monty's avatar
 
Monty committed
429
	op_in=NULL;
430 431 432
	if(result==-1)return(OV_HOLE); /* hole in the data. */
	if(result>0){
	  /* got a packet.  process it */
Monty's avatar
 
Monty committed
433 434 435 436 437 438 439 440
	  granulepos=op_ptr->granulepos;
	  if(!vorbis_synthesis(&vf->vb,op_ptr)){ /* lazy check for lazy
						    header handling.  The
						    header packets aren't
						    audio, so if/when we
						    submit them,
						    vorbis_synthesis will
						    reject them */
441 442 443 444

	    /* suck in the synthesis data and track bitrate */
	    {
	      int oldsamples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
 
Monty committed
445 446 447 448
	      /* for proper use of libvorbis within libvorbisfile,
                 oldsamples will always be zero. */
	      if(oldsamples)return(OV_EFAULT);
	      
449 450
	      vorbis_synthesis_blockin(&vf->vd,&vf->vb);
	      vf->samptrack+=vorbis_synthesis_pcmout(&vf->vd,NULL)-oldsamples;
Monty's avatar
 
Monty committed
451
	      vf->bittrack+=op_ptr->bytes*8;
452
	    }
Monty's avatar
 
Monty committed
453
	  
454
	    /* update the pcm offset. */
Monty's avatar
 
Monty committed
455
	    if(granulepos!=-1 && !op_ptr->e_o_s){
456 457
	      int link=(vf->seekable?vf->current_link:0);
	      int i,samples;
Monty's avatar
 
Monty committed
458
	    
459 460 461 462 463 464 465 466 467 468
	      /* this packet has a pcm_offset on it (the last packet
	         completed on a page carries the offset) After processing
	         (above), we know the pcm position of the *last* sample
	         ready to be returned. Find the offset of the *first*

	         As an aside, this trick is inaccurate if we begin
	         reading anew right at the last page; the end-of-stream
	         granulepos declares the last frame in the stream, and the
	         last packet of the last page may be a partial frame.
	         So, we need a previous granulepos from an in-sequence page
Monty's avatar
 
Monty committed
469
	         to have a reference point.  Thus the !op_ptr->e_o_s clause
470
	         above */
Monty's avatar
 
Monty committed
471
	    
472
	      samples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
 
Monty committed
473
	    
474 475 476 477 478 479
	      granulepos-=samples;
	      for(i=0;i<link;i++)
	        granulepos+=vf->pcmlengths[i];
	      vf->pcm_offset=granulepos;
	    }
	    return(1);
Monty's avatar
 
Monty committed
480
	  }
Monty's avatar
 
Monty committed
481
	}
482 483
	else 
	  break;
Monty's avatar
 
Monty committed
484 485 486
      }
    }

Monty's avatar
 
Monty committed
487
    if(vf->ready_state>=OPENED){
Monty's avatar
 
Monty committed
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
      if(!readp)return(0);
      if(_get_next_page(vf,&og,-1)<0)return(OV_EOF); /* eof. 
							leave unitialized */
      /* bitrate tracking; add the header's bytes here, the body bytes
	 are done by packet above */
      vf->bittrack+=og.header_len*8;
      
      /* has our decoding just traversed a bitstream boundary? */
      if(vf->ready_state==INITSET){
	if(vf->current_serialno!=ogg_page_serialno(&og)){
	  _decode_clear(vf);
	  
	  if(!vf->seekable){
	    vorbis_info_clear(vf->vi);
	    vorbis_comment_clear(vf->vc);
	  }
	}
Monty's avatar
 
Monty committed
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
      }
    }

    /* Do we need to load a new machine before submitting the page? */
    /* This is different in the seekable and non-seekable cases.  

       In the seekable case, we already have all the header
       information loaded and cached; we just initialize the machine
       with it and continue on our merry way.

       In the non-seekable (streaming) case, we'll only be at a
       boundary if we just left the previous logical bitstream and
       we're now nominally at the header of the next bitstream
    */

Monty's avatar
 
Monty committed
520
    if(vf->ready_state!=INITSET){ 
Monty's avatar
 
Monty committed
521
      int link;
Monty's avatar
 
Monty committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546

      if(vf->ready_state<STREAMSET){
	if(vf->seekable){
	  vf->current_serialno=ogg_page_serialno(&og);
	  
	  /* match the serialno to bitstream section.  We use this rather than
	     offset positions to avoid problems near logical bitstream
	     boundaries */
	  for(link=0;link<vf->links;link++)
	    if(vf->serialnos[link]==vf->current_serialno)break;
	  if(link==vf->links)return(OV_EBADLINK); /* sign of a bogus
						     stream.  error out,
						     leave machine
						     uninitialized */
	  
	  vf->current_link=link;
	  
	  ogg_stream_init(&vf->os,vf->current_serialno);
	  ogg_stream_reset(&vf->os); 
	  vf->ready_state=STREAMSET;
	  
	}else{
	  /* we're streaming */
	  /* fetch the three header packets, build the info struct */
	  
Monty's avatar
 
Monty committed
547 548
	  int ret=_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,&og);
	  if(ret)return(ret);
Monty's avatar
 
Monty committed
549 550 551
	  vf->current_link++;
	  link=0;
	}
Monty's avatar
 
Monty committed
552 553
      }
      
Monty's avatar
 
Monty committed
554
      _make_decode_ready(vf);
Monty's avatar
 
Monty committed
555 556 557 558 559
    }
    ogg_stream_pagein(&vf->os,&og);
  }
}

Monty's avatar
 
Monty committed
560 561 562 563 564 565 566 567 568 569
static int _fseek64_wrap(FILE *f,ogg_int64_t off,int whence){
  if(f==NULL)return(-1);
  return fseek(f,(int)off,whence);
}

static int _ov_open1(void *f,OggVorbis_File *vf,char *initial,
		     long ibytes, ov_callbacks callbacks){
  long offset=(f?callbacks.seek_func(f,0,SEEK_CUR):-1);
  int ret;

570
  memset(vf,0,sizeof(*vf));
Monty's avatar
 
Monty committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
  vf->datasource=f;
  vf->callbacks = callbacks;

  /* init the framing state */
  ogg_sync_init(&vf->oy);

  /* perhaps some data was previously read into a buffer for testing
     against other stream types.  Allow initialization from this
     previously read data (as we may be reading from a non-seekable
     stream) */
  if(initial){
    char *buffer=ogg_sync_buffer(&vf->oy,ibytes);
    memcpy(buffer,initial,ibytes);
    ogg_sync_wrote(&vf->oy,ibytes);
  }

  /* can we seek? Stevens suggests the seek test was portable */
  if(offset!=-1)vf->seekable=1;

  /* No seeking yet; Set up a 'single' (current) logical bitstream
     entry for partial open */
  vf->links=1;
593 594
  vf->vi=_ogg_calloc(vf->links,sizeof(*vf->vi));
  vf->vc=_ogg_calloc(vf->links,sizeof(*vf->vc));
Monty's avatar
 
Monty committed
595 596 597 598 599
  
  /* Try to fetch the headers, maintaining all the storage */
  if((ret=_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,NULL))<0){
    vf->datasource=NULL;
    ov_clear(vf);
600
  }else if(vf->ready_state < PARTOPEN)
Monty's avatar
 
Monty committed
601 602 603 604 605
    vf->ready_state=PARTOPEN;
  return(ret);
}

static int _ov_open2(OggVorbis_File *vf){
606 607
  if(vf->ready_state < OPENED)
    vf->ready_state=OPENED;
Monty's avatar
 
Monty committed
608 609 610 611 612 613 614 615 616 617 618 619
  if(vf->seekable){
    int ret=_open_seekable2(vf);
    if(ret){
      vf->datasource=NULL;
      ov_clear(vf);
    }
    return(ret);
  }
  return 0;
}


Monty's avatar
 
Monty committed
620 621 622 623 624 625 626 627 628
/* clear out the OggVorbis_File struct */
int ov_clear(OggVorbis_File *vf){
  if(vf){
    vorbis_block_clear(&vf->vb);
    vorbis_dsp_clear(&vf->vd);
    ogg_stream_clear(&vf->os);
    
    if(vf->vi && vf->links){
      int i;
Monty's avatar
 
Monty committed
629
      for(i=0;i<vf->links;i++){
Monty's avatar
 
Monty committed
630
	vorbis_info_clear(vf->vi+i);
Monty's avatar
 
Monty committed
631 632
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
 
Monty committed
633 634
      _ogg_free(vf->vi);
      _ogg_free(vf->vc);
Monty's avatar
 
Monty committed
635
    }
Monty's avatar
 
Monty committed
636 637 638 639
    if(vf->dataoffsets)_ogg_free(vf->dataoffsets);
    if(vf->pcmlengths)_ogg_free(vf->pcmlengths);
    if(vf->serialnos)_ogg_free(vf->serialnos);
    if(vf->offsets)_ogg_free(vf->offsets);
Monty's avatar
 
Monty committed
640
    ogg_sync_clear(&vf->oy);
Michael Smith's avatar
 
Michael Smith committed
641
    if(vf->datasource)(vf->callbacks.close_func)(vf->datasource);
642
    memset(vf,0,sizeof(*vf));
Monty's avatar
 
Monty committed
643
  }
Monty's avatar
 
Monty committed
644
#ifdef DEBUG_LEAKS
Monty's avatar
 
Monty committed
645
  _VDBG_dump();
Monty's avatar
 
Monty committed
646
#endif
Monty's avatar
 
Monty committed
647
  return(0);
Monty's avatar
 
Monty committed
648
}
Monty's avatar
 
Monty committed
649

Monty's avatar
 
Monty committed
650 651
/* inspects the OggVorbis file and finds/documents all the logical
   bitstreams contained in it.  Tries to be tolerant of logical
Monty's avatar
 
Monty committed
652 653 654 655 656 657
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
 
Monty committed
658 659 660 661 662 663 664
int ov_open_callbacks(void *f,OggVorbis_File *vf,char *initial,long ibytes,
    ov_callbacks callbacks){
  int ret=_ov_open1(f,vf,initial,ibytes,callbacks);
  if(ret)return ret;
  return _ov_open2(vf);
}

Monty's avatar
 
Monty committed
665
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Michael Smith's avatar
 
Michael Smith committed
666
  ov_callbacks callbacks = {
Michael Smith's avatar
 
Michael Smith committed
667
    (size_t (*)(void *, size_t, size_t, void *))  fread,
Monty's avatar
 
Monty committed
668
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
Michael Smith's avatar
 
Michael Smith committed
669 670 671
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Michael Smith's avatar
 
Michael Smith committed
672 673 674 675

  return ov_open_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
  
Monty's avatar
 
Monty committed
676 677 678 679
/* Only partially open the vorbis file; test for Vorbisness, and load
   the headers for the first chain.  Do not seek (although test for
   seekability).  Use ov_test_open to finish opening the file, else
   ov_clear to close/free it. Same return codes as open. */
Michael Smith's avatar
 
Michael Smith committed
680

Monty's avatar
 
Monty committed
681
int ov_test_callbacks(void *f,OggVorbis_File *vf,char *initial,long ibytes,
Michael Smith's avatar
 
Michael Smith committed
682 683
    ov_callbacks callbacks)
{
Monty's avatar
 
Monty committed
684 685
  return _ov_open1(f,vf,initial,ibytes,callbacks);
}
Monty's avatar
 
Monty committed
686

Monty's avatar
 
Monty committed
687 688 689 690 691 692 693
int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
  ov_callbacks callbacks = {
    (size_t (*)(void *, size_t, size_t, void *))  fread,
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Monty's avatar
 
Monty committed
694

Monty's avatar
 
Monty committed
695 696 697 698 699 700
  return ov_test_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
  
int ov_test_open(OggVorbis_File *vf){
  if(vf->ready_state!=PARTOPEN)return(OV_EINVAL);
  return _ov_open2(vf);
Monty's avatar
 
Monty committed
701 702
}

Monty's avatar
 
Monty committed
703
/* How many logical bitstreams in this physical bitstream? */
Monty's avatar
 
Monty committed
704 705
long ov_streams(OggVorbis_File *vf){
  return vf->links;
Monty's avatar
 
Monty committed
706 707
}

Monty's avatar
 
Monty committed
708
/* Is the FILE * associated with vf seekable? */
Monty's avatar
 
Monty committed
709 710
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
Monty's avatar
 
Monty committed
711 712
}

Monty's avatar
 
Monty committed
713 714 715 716 717 718 719 720 721 722
/* returns the bitrate for a given logical bitstream or the entire
   physical bitstream.  If the file is open for random access, it will
   find the *actual* average bitrate.  If the file is streaming, it
   returns the nominal bitrate (if set) else the average of the
   upper/lower bounds (if set) else -1 (unset).

   If you want the actual bitrate field settings, get them from the
   vorbis_info structs */

long ov_bitrate(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
723
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
724
  if(i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
725
  if(!vf->seekable && i!=0)return(ov_bitrate(vf,0));
Monty's avatar
 
Monty committed
726
  if(i<0){
Monty's avatar
 
Monty committed
727
    ogg_int64_t bits=0;
Monty's avatar
 
Monty committed
728 729
    int i;
    for(i=0;i<vf->links;i++)
Monty's avatar
 
Monty committed
730
      bits+=(vf->offsets[i+1]-vf->dataoffsets[i])*8;
Monty's avatar
 
Monty committed
731 732 733 734
    return(rint(bits/ov_time_total(vf,-1)));
  }else{
    if(vf->seekable){
      /* return the actual bitrate */
Monty's avatar
 
Monty committed
735
      return(rint((vf->offsets[i+1]-vf->dataoffsets[i])*8/ov_time_total(vf,i)));
Monty's avatar
 
Monty committed
736 737 738 739 740 741 742 743 744 745 746 747
    }else{
      /* return nominal if set */
      if(vf->vi[i].bitrate_nominal>0){
	return vf->vi[i].bitrate_nominal;
      }else{
	if(vf->vi[i].bitrate_upper>0){
	  if(vf->vi[i].bitrate_lower>0){
	    return (vf->vi[i].bitrate_upper+vf->vi[i].bitrate_lower)/2;
	  }else{
	    return vf->vi[i].bitrate_upper;
	  }
	}
Monty's avatar
 
Monty committed
748
	return(OV_FALSE);
Monty's avatar
 
Monty committed
749 750 751 752 753
      }
    }
  }
}

Monty's avatar
 
Monty committed
754
/* returns the actual bitrate since last call.  returns -1 if no
Monty's avatar
 
Monty committed
755 756 757
   additional data to offer since last call (or at beginning of stream),
   EINVAL if stream is only partially open 
*/
Monty's avatar
 
Monty committed
758 759 760
long ov_bitrate_instant(OggVorbis_File *vf){
  int link=(vf->seekable?vf->current_link:0);
  long ret;
Monty's avatar
 
Monty committed
761
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
762
  if(vf->samptrack==0)return(OV_FALSE);
Monty's avatar
 
Monty committed
763
  ret=vf->bittrack/vf->samptrack*vf->vi[link].rate+.5;
Monty's avatar
 
Monty committed
764 765
  vf->bittrack=0.f;
  vf->samptrack=0.f;
Monty's avatar
 
Monty committed
766 767 768
  return(ret);
}

Monty's avatar
 
Monty committed
769 770
/* Guess */
long ov_serialnumber(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
771
  if(i>=vf->links)return(ov_serialnumber(vf,vf->links-1));
Monty's avatar
 
Monty committed
772 773 774 775 776 777 778 779
  if(!vf->seekable && i>=0)return(ov_serialnumber(vf,-1));
  if(i<0){
    return(vf->current_serialno);
  }else{
    return(vf->serialnos[i]);
  }
}

Monty's avatar
 
Monty committed
780 781
/* returns: total raw (compressed) length of content if i==-1
            raw (compressed) length of that logical bitstream for i==0 to n
Monty's avatar
 
Monty committed
782 783
	    OV_EINVAL if the stream is not seekable (we can't know the length)
	    or if stream is only partially open
Monty's avatar
 
Monty committed
784
*/
Monty's avatar
 
Monty committed
785
ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
786
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
787
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
788
  if(i<0){
Monty's avatar
 
Monty committed
789 790 791 792 793 794 795 796 797
    long acc=0;
    int i;
    for(i=0;i<vf->links;i++)
      acc+=ov_raw_total(vf,i);
    return(acc);
  }else{
    return(vf->offsets[i+1]-vf->offsets[i]);
  }
}
Monty's avatar
 
Monty committed
798

Monty's avatar
 
Monty committed
799 800 801 802
/* returns: total PCM length (samples) of content if i==-1 PCM length
	    (samples) of that logical bitstream for i==0 to n
	    OV_EINVAL if the stream is not seekable (we can't know the
	    length) or only partially open 
Monty's avatar
 
Monty committed
803
*/
Monty's avatar
 
Monty committed
804
ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
805
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
806
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
807
  if(i<0){
Monty's avatar
 
Monty committed
808
    ogg_int64_t acc=0;
Monty's avatar
 
Monty committed
809 810 811 812 813 814 815 816
    int i;
    for(i=0;i<vf->links;i++)
      acc+=ov_pcm_total(vf,i);
    return(acc);
  }else{
    return(vf->pcmlengths[i]);
  }
}
Monty's avatar
 
Monty committed
817

Monty's avatar
 
Monty committed
818 819
/* returns: total seconds of content if i==-1
            seconds in that logical bitstream for i==0 to n
Monty's avatar
 
Monty committed
820 821
	    OV_EINVAL if the stream is not seekable (we can't know the
	    length) or only partially open 
Monty's avatar
 
Monty committed
822
*/
Monty's avatar
 
Monty committed
823
double ov_time_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
824
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
825
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
826
  if(i<0){
Monty's avatar
 
Monty committed
827 828 829 830 831 832 833 834 835
    double acc=0;
    int i;
    for(i=0;i<vf->links;i++)
      acc+=ov_time_total(vf,i);
    return(acc);
  }else{
    return((float)(vf->pcmlengths[i])/vf->vi[i].rate);
  }
}
Monty's avatar
 
Monty committed
836

Monty's avatar
 
Monty committed
837
/* seek to an offset relative to the *compressed* data. This also
Monty's avatar
 
Monty committed
838 839 840
   scans packets to update the PCM cursor. It will cross a logical
   bitstream boundary, but only if it can't get any packets out of the
   tail of the bitstream we seek to (so no surprises).
Monty's avatar
 
Monty committed
841 842

   returns zero on success, nonzero on failure */
Monty's avatar
 
Monty committed
843 844

int ov_raw_seek(OggVorbis_File *vf,long pos){
Monty's avatar
 
Monty committed
845 846 847 848 849 850
  ogg_stream_state work_os;

  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(!vf->seekable)
    return(OV_ENOSEEK); /* don't dump machine if we can't seek */

Monty's avatar
 
Monty committed
851
  if(pos<0 || pos>vf->offsets[vf->links])return(OV_EINVAL);
Monty's avatar
 
Monty committed
852 853

  /* clear out decoding machine state */
Monty's avatar
 
Monty committed
854
  vf->pcm_offset=-1;
Monty's avatar
 
Monty committed
855
  _decode_clear(vf);
Monty's avatar
 
Monty committed
856
  
Monty's avatar
 
Monty committed
857 858
  _seek_helper(vf,pos);

Monty's avatar
 
Monty committed
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
  /* we need to make sure the pcm_offset is set, but we don't want to
     advance the raw cursor past good packets just to get to the first
     with a granulepos.  That's not equivalent behavior to beginning
     decoding as immediately after the seek position as possible.

     So, a hack.  We use two stream states; a local scratch state and
     a the shared vf->os stream state.  We use the local state to
     scan, and the shared state as a buffer for later decode. 

     Unfortuantely, on the last page we still advance to last packet
     because the granulepos on the last page is not necessarily on a
     packet boundary, and we need to make sure the granpos is
     correct. 
  */

  {
    ogg_page og;
    ogg_packet op;
    int lastblock=0;
    int accblock=0;
    int thisblock;
    int eosflag;

    memset(&work_os,0,sizeof(work_os));/* so that it's safe to clear
					  it later even if we don't
					  init it */

    while(1){
      if(vf->ready_state==STREAMSET){
	/* snarf/scan a packet if we can */
	int result=ogg_stream_packetout(&work_os,&op);
      
	if(result>0){

	  if(vf->vi[vf->current_link].codec_setup)
	    thisblock=vorbis_packet_blocksize(vf->vi+vf->current_link,&op);
	  if(eosflag)
	    ogg_stream_packetout(&vf->os,NULL);
	  else
	    if(lastblock)accblock+=(lastblock+thisblock)>>2;

	  if(op.granulepos!=-1){
	    int i,link=vf->current_link;
	    ogg_int64_t granulepos=op.granulepos;
	    
	    for(i=0;i<link;i++)
	      granulepos+=vf->pcmlengths[i];
	    vf->pcm_offset=granulepos-accblock;
	    break;
	  }
	  lastblock=thisblock;
	  continue;
	}
      }
      
      if(!lastblock){
	if(_get_next_page(vf,&og,-1)<0){
	  vf->pcm_offset=ov_pcm_total(vf,-1);
	  break;
	}
      }else{
	/* huh?  Bogus stream with packets but no granulepos */
	vf->pcm_offset=-1;
	break;
      }
      
      /* has our decoding just traversed a bitstream boundary? */
      if(vf->ready_state==STREAMSET)
	if(vf->current_serialno!=ogg_page_serialno(&og)){
	_decode_clear(vf); /* clear out stream state */
	ogg_stream_clear(&work_os);
      }

      if(vf->ready_state<STREAMSET){
	int link;
	
	vf->current_serialno=ogg_page_serialno(&og);
	for(link=0;link<vf->links;link++)
	  if(vf->serialnos[link]==vf->current_serialno)break;
	if(link==vf->links)goto seek_error; /* sign of a bogus stream.
					       error out, leave
					       machine uninitialized */
	vf->current_link=link;
	
	ogg_stream_init(&vf->os,vf->current_serialno);
	ogg_stream_reset(&vf->os); 
	ogg_stream_init(&work_os,vf->current_serialno);
	ogg_stream_reset(&work_os); 
	vf->ready_state=STREAMSET;
	
      }
    
      ogg_stream_pagein(&vf->os,&og);
      ogg_stream_pagein(&work_os,&og);
      eosflag=ogg_page_eos(&og);
Monty's avatar
 
Monty committed
954 955
    }
  }
Monty's avatar
 
Monty committed
956 957 958 959

  ogg_stream_clear(&work_os);
  return(0);

Monty's avatar
 
Monty committed
960 961
 seek_error:
  /* dump the machine so we're in a known state */
Monty's avatar
 
Monty committed
962
  vf->pcm_offset=-1;
Monty's avatar
 
Monty committed
963
  ogg_stream_clear(&work_os);
Monty's avatar
 
Monty committed
964
  _decode_clear(vf);
Monty's avatar
 
Monty committed
965
  return OV_EBADLINK;
Monty's avatar
 
Monty committed
966 967
}

Monty's avatar
 
Monty committed
968 969
/* Page granularity seek (faster than sample granularity because we
   don't do the last bit of decode to find a specific sample).
Monty's avatar
 
Monty committed
970

Monty's avatar
 
Monty committed
971 972 973 974
   Seek to the last [granule marked] page preceeding the specified pos
   location, such that decoding past the returned point will quickly
   arrive at the requested position. */
int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos){
Monty's avatar
 
Monty committed
975
  int link=-1;
Monty's avatar
 
Monty committed
976
  long ret;
Monty's avatar
 
Monty committed
977
  ogg_int64_t total=ov_pcm_total(vf,-1);
Monty's avatar
 
Monty committed
978

Monty's avatar
 
Monty committed
979
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
980 981
  if(!vf->seekable)return(OV_ENOSEEK);
  if(pos<0 || pos>total)return(OV_EINVAL);
Monty's avatar
 
Monty committed
982
 
Monty's avatar
 
Monty committed
983 984 985 986 987 988
  /* which bitstream section does this pcm offset occur in? */
  for(link=vf->links-1;link>=0;link--){
    total-=vf->pcmlengths[link];
    if(pos>=total)break;
  }

Monty's avatar
 
Monty committed
989
  /* search within the logical bitstream for the page with the highest
Monty's avatar
 
Monty committed
990 991 992 993
     pcm_pos preceeding (or equal to) pos.  There is a danger here;
     missing pages or incorrect frame number information in the
     bitstream could make our task impossible.  Account for that (it
     would be an error condition) */
Monty's avatar
 
Monty committed
994 995

  /* new search algorithm by HB (Nicholas Vinen) */
Monty's avatar
 
Monty committed
996
  {
Monty's avatar
 
Monty committed
997
    ogg_int64_t target=pos-total;
Monty's avatar
 
Monty committed
998 999
    long end=vf->offsets[link+1];
    long begin=vf->offsets[link];
Monty's avatar
 
Monty committed
1000 1001
    ogg_int64_t endtime = vf->pcmlengths[link];
    ogg_int64_t begintime = 0;
Monty's avatar
 
Monty committed
1002
    long best=begin;
Monty's avatar
 
Monty committed
1003
    
Monty's avatar
 
Monty committed
1004 1005 1006
    ogg_page og;
    while(begin<end){
      long bisect;
Monty's avatar
 
Monty committed
1007
      
Monty's avatar
 
Monty committed
1008 1009 1010
      if(end-begin<CHUNKSIZE){
	bisect=begin;
      }else{
Monty's avatar
 
Monty committed
1011 1012 1013 1014 1015
	/* take a (pretty decent) guess. */
	bisect=begin + 
	  (target-begintime)*(end-begin)/(endtime-begintime) - CHUNKSIZE;
	if(bisect<=begin)
	  bisect=begin+1;
Monty's avatar
 
Monty committed
1016 1017
      }
      _seek_helper(vf,bisect);
Monty's avatar
 
Monty committed
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
    
      while(begin<end){
	ret=_get_next_page(vf,&og,end-bisect);
	if(ret==OV_EREAD) goto seek_error;
	if(ret<0){
	  if(bisect<=begin+1)
	    end=begin; /* found it */
	  else{
	    if(bisect==0)goto seek_error;
	    bisect-=CHUNKSIZE;
	    if(bisect<=begin)bisect=begin+1;
	    _seek_helper(vf,bisect);
	  }
	}else{
Monty's avatar