vorbisfile.c 43 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 9
 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001             *
 * 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
14
 last mod: $Id: vorbisfile.c,v 1.48 2001/06/02 11:38:14 msmith 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 "codec_internal.h"
Monty's avatar
 
Monty committed
29
#include "misc.h"
Monty's avatar
 
Monty committed
30 31 32 33 34 35 36

/* 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
37 38 39 40
   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
41 42

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

/* 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
51
   picking some portion of the stream roughly in the desired area if
Ralph Giles's avatar
Ralph Giles committed
52
   we only want coarse navigation through the stream. */
Monty's avatar
 
Monty committed
53

Monty's avatar
 
Monty committed
54 55 56 57 58 59
/*************************************************************************
 * 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
60 61
/* read a little more data from the file/pipe into the ogg_sync framer
*/
Monty's avatar
 
Monty committed
62 63
#define CHUNKSIZE 8500 /* a shade over 8k; anyone using pages well
                          over 8k gets what they deserve */
Monty's avatar
 
Monty committed
64
static long _get_data(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
65 66 67 68 69 70 71 72 73
  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
74 75 76 77
}

/* 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
78 79 80 81 82 83 84 85
  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
86 87 88 89 90 91 92 93 94 95 96 97
}

/* 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
98
   return:   <0) did not find a page (OV_FALSE, OV_EOF, OV_EREAD)
Monty's avatar
 
Monty committed
99 100 101 102 103 104 105
              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
106
    if(boundary>0 && vf->offset>=boundary)return(OV_FALSE);
Monty's avatar
 
Monty committed
107 108 109 110 111 112 113 114
    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
115 116 117 118 119 120
	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
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
      }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
137
/* returns offset or OV_EREAD, OV_FAULT */
Monty's avatar
 
Monty committed
138 139 140 141 142 143 144 145 146 147
static long _get_prev_page(OggVorbis_File *vf,ogg_page *og){
  long begin=vf->offset;
  long ret;
  int offset=-1;

  while(offset==-1){
    begin-=CHUNKSIZE;
    _seek_helper(vf,begin);
    while(vf->offset<begin+CHUNKSIZE){
      ret=_get_next_page(vf,og,begin+CHUNKSIZE-vf->offset);
Monty's avatar
 
Monty committed
148 149
      if(ret==OV_EREAD)return(OV_EREAD);
      if(ret<0){
Monty's avatar
 
Monty committed
150 151 152 153 154 155 156 157 158 159
	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
160
  if(ret<0)
Monty's avatar
 
Monty committed
161
    /* this shouldn't be possible */
Monty's avatar
 
Monty committed
162 163
    return(OV_EFAULT);

Monty's avatar
 
Monty committed
164 165 166 167 168 169 170
  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
171 172 173 174 175 176
static int _bisect_forward_serialno(OggVorbis_File *vf,
				    long begin,
				    long searched,
				    long end,
				    long currentno,
				    long m){
Monty's avatar
 
Monty committed
177 178 179
  long endsearched=end;
  long next=end;
  ogg_page og;
Monty's avatar
 
Monty committed
180
  long ret;
Monty's avatar
 
Monty committed
181
  
Monty's avatar
 
Monty committed
182 183 184 185 186 187 188 189 190 191 192 193 194
  /* 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
195
    if(ret==OV_EREAD)return(OV_EREAD);
Monty's avatar
 
Monty committed
196 197 198 199 200 201 202
    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
203 204 205

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

Monty's avatar
 
Monty committed
222 223
/* uses the local ogg_stream storage in vf; this is important for
   non-streaming input sources */
Monty's avatar
 
Monty committed
224
static int _fetch_headers(OggVorbis_File *vf,vorbis_info *vi,vorbis_comment *vc,
Monty's avatar
 
Monty committed
225
			  long *serialno,ogg_page *og_ptr){
Monty's avatar
 
Monty committed
226 227
  ogg_page og;
  ogg_packet op;
Monty's avatar
 
Monty committed
228
  int i,ret=0;
Monty's avatar
 
Monty committed
229
  
Monty's avatar
 
Monty committed
230 231
  if(!og_ptr){
    ret=_get_next_page(vf,&og,CHUNKSIZE);
Monty's avatar
 
Monty committed
232 233
    if(ret==OV_EREAD)return(OV_EREAD);
    if(ret<0)return OV_ENOTVORBIS;
Monty's avatar
 
Monty committed
234 235 236 237 238
    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
239
  vf->ready_state=STREAMSET;
Monty's avatar
 
Monty committed
240 241 242 243 244
  
  /* 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
245
  vorbis_comment_init(vc);
Monty's avatar
 
Monty committed
246 247 248
  
  i=0;
  while(i<3){
Monty's avatar
 
Monty committed
249
    ogg_stream_pagein(&vf->os,og_ptr);
Monty's avatar
 
Monty committed
250 251 252 253
    while(i<3){
      int result=ogg_stream_packetout(&vf->os,&op);
      if(result==0)break;
      if(result==-1){
Monty's avatar
 
Monty committed
254
	ret=OV_EBADHEADER;
Monty's avatar
 
Monty committed
255 256
	goto bail_header;
      }
Monty's avatar
 
Monty committed
257
      if((ret=vorbis_synthesis_headerin(vi,vc,&op))){
Monty's avatar
 
Monty committed
258 259 260 261 262
	goto bail_header;
      }
      i++;
    }
    if(i<3)
Monty's avatar
 
Monty committed
263
      if(_get_next_page(vf,og_ptr,1)<0){
Monty's avatar
 
Monty committed
264
	ret=OV_EBADHEADER;
Monty's avatar
 
Monty committed
265 266 267 268
	goto bail_header;
      }
  }
  return 0; 
Monty's avatar
 
Monty committed
269

Monty's avatar
 
Monty committed
270 271
 bail_header:
  vorbis_info_clear(vi);
Monty's avatar
 
Monty committed
272
  vorbis_comment_clear(vc);
Monty's avatar
 
Monty committed
273
  ogg_stream_clear(&vf->os);
Monty's avatar
 
Monty committed
274
  return ret;
Monty's avatar
 
Monty committed
275
}
Monty's avatar
 
Monty committed
276

Monty's avatar
 
Monty committed
277 278 279 280
/* 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
281 282 283 284 285

/* 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
286
static void _prefetch_all_headers(OggVorbis_File *vf, long dataoffset){
Monty's avatar
 
Monty committed
287 288 289
  ogg_page og;
  int i,ret;
  
Monty's avatar
 
Monty committed
290 291
  vf->vi=_ogg_realloc(vf->vi,vf->links*sizeof(vorbis_info));
  vf->vc=_ogg_realloc(vf->vc,vf->links*sizeof(vorbis_info));
Monty's avatar
 
Monty committed
292 293 294
  vf->dataoffsets=_ogg_malloc(vf->links*sizeof(ogg_int64_t));
  vf->pcmlengths=_ogg_malloc(vf->links*sizeof(ogg_int64_t));
  vf->serialnos=_ogg_malloc(vf->links*sizeof(long));
Monty's avatar
 
Monty committed
295 296
  
  for(i=0;i<vf->links;i++){
Monty's avatar
 
Monty committed
297 298
    if(i==0){
      /* we already grabbed the initial header earlier.  Just set the offset */
Monty's avatar
 
Monty committed
299
      vf->dataoffsets[i]=dataoffset;
Monty's avatar
 
Monty committed
300
    }else{
Monty's avatar
 
Monty committed
301

Monty's avatar
 
Monty committed
302
      /* seek to the location of the initial header */
Monty's avatar
 
Monty committed
303

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

Monty's avatar
 
Monty committed
313 314 315 316 317
    /* 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
318

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

Monty's avatar
 
Monty committed
338
static void _make_decode_ready(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
339
  if(vf->ready_state!=STREAMSET)return;
Monty's avatar
 
Monty committed
340 341 342 343 344
  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
345
  vorbis_block_init(&vf->vd,&vf->vb);
Monty's avatar
 
Monty committed
346
  vf->ready_state=INITSET;
Monty's avatar
 
Monty committed
347
  return;
Monty's avatar
 
Monty committed
348 349
}

Monty's avatar
 
Monty committed
350 351 352
static int _open_seekable2(OggVorbis_File *vf){
  long serialno=vf->current_serialno,end;
  long dataoffset=vf->offset;
Monty's avatar
 
Monty committed
353
  ogg_page og;
Monty's avatar
 
Monty committed
354 355 356

  /* we're partially open and have a first link header state in
     storage in vf */
Monty's avatar
 
Monty committed
357
  /* we can seek, so set out learning all about this file */
Michael Smith's avatar
 
Michael Smith committed
358 359
  (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
  vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
Monty's avatar
 
Monty committed
360 361 362 363
  
  /* 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
364
  if(end<0){
Monty's avatar
 
Monty committed
365
    ov_clear(vf);
Monty's avatar
 
Monty committed
366 367
    return(end);
  }
Monty's avatar
 
Monty committed
368

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

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

Monty's avatar
 
Monty committed
379 380 381
  }else{

    /* Only one logical bitstream */
Monty's avatar
 
Monty committed
382
    if(_bisect_forward_serialno(vf,0,end,end+1,serialno,0)){
Monty's avatar
 
Monty committed
383
      ov_clear(vf);
Monty's avatar
 
Monty committed
384 385
      return(OV_EREAD);
    }
Monty's avatar
 
Monty committed
386 387 388

  }

Monty's avatar
 
Monty committed
389 390
  /* the initial header memory is referenced by vf after; don't free it */
  _prefetch_all_headers(vf,dataoffset);
Monty's avatar
 
Monty committed
391
  return(ov_raw_seek(vf,0));
Monty's avatar
 
Monty committed
392
}
Monty's avatar
 
Monty committed
393 394 395 396 397 398

/* 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
399
  vf->ready_state=OPENED;
Monty's avatar
 
Monty committed
400

Monty's avatar
 
Monty committed
401 402
  vf->bittrack=0.f;
  vf->samptrack=0.f;
Monty's avatar
 
Monty committed
403 404 405 406 407 408 409 410
}

/* 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
411 412
   return: <0) error, OV_HOLE (lost packet) or OV_EOF
            0) need more data (only if readp==0)
Monty's avatar
 
Monty committed
413 414 415 416 417 418 419 420 421 422 423 424
	    1) got a packet 
*/

static int _process_packet(OggVorbis_File *vf,int readp){
  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
425
    if(vf->ready_state==INITSET){
Monty's avatar
 
Monty committed
426 427
      ogg_packet op;
      int result=ogg_stream_packetout(&vf->os,&op);
Monty's avatar
 
Monty committed
428
      ogg_int64_t granulepos;
Monty's avatar
 
Monty committed
429

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

	  /* suck in the synthesis data and track bitrate */
	  {
	    int oldsamples=vorbis_synthesis_pcmout(&vf->vd,NULL);
	    vorbis_synthesis_blockin(&vf->vd,&vf->vb);
	    vf->samptrack+=vorbis_synthesis_pcmout(&vf->vd,NULL)-oldsamples;
	    vf->bittrack+=op.bytes*8;
	  }
Monty's avatar
 
Monty committed
449
	  
Monty's avatar
 
Monty committed
450
	  /* update the pcm offset. */
Monty's avatar
 
Monty committed
451
	  if(granulepos!=-1 && !op.e_o_s){
Monty's avatar
 
Monty committed
452 453 454 455 456 457
	    int link=(vf->seekable?vf->current_link:0);
	    int i,samples;
	    
	    /* 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
Monty's avatar
 
Monty committed
458 459 460 461
	       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
Monty's avatar
 
Monty committed
462
	       granulepos declares the last frame in the stream, and the
Monty's avatar
 
Monty committed
463
	       last packet of the last page may be a partial frame.
Monty's avatar
 
Monty committed
464
	       So, we need a previous granulepos from an in-sequence page
Monty's avatar
 
Monty committed
465 466
	       to have a reference point.  Thus the !op.e_o_s clause
	       above */
Monty's avatar
 
Monty committed
467
	    
Monty's avatar
 
Monty committed
468
	    samples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
 
Monty committed
469
	    
Monty's avatar
 
Monty committed
470
	    granulepos-=samples;
Monty's avatar
 
Monty committed
471
	    for(i=0;i<link;i++)
Monty's avatar
 
Monty committed
472 473
	      granulepos+=vf->pcmlengths[i];
	    vf->pcm_offset=granulepos;
Monty's avatar
 
Monty committed
474 475
	  }
	  return(1);
Monty's avatar
 
Monty committed
476 477 478 479
	}
      }
    }

Monty's avatar
 
Monty committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
    if(vf->ready_state>=STREAMSET){
      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
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
      }
    }

    /* 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
514
    if(vf->ready_state!=INITSET){ 
Monty's avatar
 
Monty committed
515
      int link;
Monty's avatar
 
Monty committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

      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 */
	  
	  _fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,&og);
	  vf->current_link++;
	  link=0;
	}
Monty's avatar
 
Monty committed
545 546
      }
      
Monty's avatar
 
Monty committed
547
      _make_decode_ready(vf);
Monty's avatar
 
Monty committed
548 549 550 551 552
    }
    ogg_stream_pagein(&vf->os,&og);
  }
}

Monty's avatar
 
Monty committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
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;

  memset(vf,0,sizeof(OggVorbis_File));
  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;
  vf->vi=_ogg_calloc(vf->links,sizeof(vorbis_info));
  vf->vc=_ogg_calloc(vf->links,sizeof(vorbis_info));
  
  /* 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);
593
  }else if(vf->ready_state < PARTOPEN)
Monty's avatar
 
Monty committed
594 595 596 597 598
    vf->ready_state=PARTOPEN;
  return(ret);
}

static int _ov_open2(OggVorbis_File *vf){
599 600
  if(vf->ready_state < OPENED)
    vf->ready_state=OPENED;
Monty's avatar
 
Monty committed
601 602 603 604 605 606 607 608 609 610 611 612
  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
613 614 615 616 617 618 619 620 621
/* 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
622
      for(i=0;i<vf->links;i++){
Monty's avatar
 
Monty committed
623
	vorbis_info_clear(vf->vi+i);
Monty's avatar
 
Monty committed
624 625
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
 
Monty committed
626 627
      _ogg_free(vf->vi);
      _ogg_free(vf->vc);
Monty's avatar
 
Monty committed
628
    }
Monty's avatar
 
Monty committed
629 630 631 632
    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
633
    ogg_sync_clear(&vf->oy);
Michael Smith's avatar
 
Michael Smith committed
634
    if(vf->datasource)(vf->callbacks.close_func)(vf->datasource);
Monty's avatar
 
Monty committed
635 636
    memset(vf,0,sizeof(OggVorbis_File));
  }
Monty's avatar
 
Monty committed
637
#ifdef DEBUG_LEAKS
Monty's avatar
 
Monty committed
638
  _VDBG_dump();
Monty's avatar
 
Monty committed
639
#endif
Monty's avatar
 
Monty committed
640
  return(0);
Monty's avatar
 
Monty committed
641
}
Monty's avatar
 
Monty committed
642

Monty's avatar
 
Monty committed
643 644
/* 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
645 646 647 648 649 650
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
 
Monty committed
651 652 653 654 655 656 657
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
658
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Michael Smith's avatar
 
Michael Smith committed
659
  ov_callbacks callbacks = {
Michael Smith's avatar
 
Michael Smith committed
660
    (size_t (*)(void *, size_t, size_t, void *))  fread,
Monty's avatar
 
Monty committed
661
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
Michael Smith's avatar
 
Michael Smith committed
662 663 664
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Michael Smith's avatar
 
Michael Smith committed
665 666 667 668

  return ov_open_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
  
Monty's avatar
 
Monty committed
669 670 671 672
/* 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
673

Monty's avatar
 
Monty committed
674
int ov_test_callbacks(void *f,OggVorbis_File *vf,char *initial,long ibytes,
Michael Smith's avatar
 
Michael Smith committed
675 676
    ov_callbacks callbacks)
{
Monty's avatar
 
Monty committed
677 678
  return _ov_open1(f,vf,initial,ibytes,callbacks);
}
Monty's avatar
 
Monty committed
679

Monty's avatar
 
Monty committed
680 681 682 683 684 685 686
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
687

Monty's avatar
 
Monty committed
688 689 690 691 692 693
  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
694 695
}

Monty's avatar
 
Monty committed
696
/* How many logical bitstreams in this physical bitstream? */
Monty's avatar
 
Monty committed
697 698
long ov_streams(OggVorbis_File *vf){
  return vf->links;
Monty's avatar
 
Monty committed
699 700
}

Monty's avatar
 
Monty committed
701
/* Is the FILE * associated with vf seekable? */
Monty's avatar
 
Monty committed
702 703
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
Monty's avatar
 
Monty committed
704 705
}

Monty's avatar
 
Monty committed
706 707 708 709 710 711 712 713 714 715
/* 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
716
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
717
  if(i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
718
  if(!vf->seekable && i!=0)return(ov_bitrate(vf,0));
Monty's avatar
 
Monty committed
719
  if(i<0){
Monty's avatar
 
Monty committed
720
    ogg_int64_t bits=0;
Monty's avatar
 
Monty committed
721 722
    int i;
    for(i=0;i<vf->links;i++)
Monty's avatar
 
Monty committed
723
      bits+=(vf->offsets[i+1]-vf->dataoffsets[i])*8;
Monty's avatar
 
Monty committed
724 725 726 727
    return(rint(bits/ov_time_total(vf,-1)));
  }else{
    if(vf->seekable){
      /* return the actual bitrate */
Monty's avatar
 
Monty committed
728
      return(rint((vf->offsets[i+1]-vf->dataoffsets[i])*8/ov_time_total(vf,i)));
Monty's avatar
 
Monty committed
729 730 731 732 733 734 735 736 737 738 739 740
    }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
741
	return(OV_FALSE);
Monty's avatar
 
Monty committed
742 743 744 745 746
      }
    }
  }
}

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

Monty's avatar
 
Monty committed
762 763
/* Guess */
long ov_serialnumber(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
764
  if(i>=vf->links)return(ov_serialnumber(vf,vf->links-1));
Monty's avatar
 
Monty committed
765 766 767 768 769 770 771 772
  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
773 774
/* 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
775 776
	    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
777
*/
Monty's avatar
 
Monty committed
778
ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
779
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
780
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
781
  if(i<0){
Monty's avatar
 
Monty committed
782 783 784 785 786 787 788 789 790
    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
791

Monty's avatar
 
Monty committed
792 793 794 795
/* 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
796
*/
Monty's avatar
 
Monty committed
797
ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
798
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
799
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
800
  if(i<0){
Monty's avatar
 
Monty committed
801
    ogg_int64_t acc=0;
Monty's avatar
 
Monty committed
802 803 804 805 806 807 808 809
    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
810

Monty's avatar
 
Monty committed
811 812
/* returns: total seconds of content if i==-1
            seconds in that logical bitstream for i==0 to n
Monty's avatar
 
Monty committed
813 814
	    OV_EINVAL if the stream is not seekable (we can't know the
	    length) or only partially open 
Monty's avatar
 
Monty committed
815
*/
Monty's avatar
 
Monty committed
816
double ov_time_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
817
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
818
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
 
Monty committed
819
  if(i<0){
Monty's avatar
 
Monty committed
820 821 822 823 824 825 826 827 828
    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
829

Monty's avatar
 
Monty committed
830
/* seek to an offset relative to the *compressed* data. This also
Monty's avatar
 
Monty committed
831 832 833
   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
834 835

   returns zero on success, nonzero on failure */
Monty's avatar
 
Monty committed
836 837

int ov_raw_seek(OggVorbis_File *vf,long pos){
Monty's avatar
 
Monty committed
838 839 840 841 842 843
  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
844
  if(pos<0 || pos>vf->offsets[vf->links])return(OV_EINVAL);
Monty's avatar
 
Monty committed
845 846

  /* clear out decoding machine state */
Monty's avatar
 
Monty committed
847
  vf->pcm_offset=-1;
Monty's avatar
 
Monty committed
848
  _decode_clear(vf);
Monty's avatar
 
Monty committed
849
  
Monty's avatar
 
Monty committed
850 851
  _seek_helper(vf,pos);

Monty's avatar
 
Monty committed
852 853 854 855 856 857 858 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
  /* 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
947 948
    }
  }
Monty's avatar
 
Monty committed
949 950 951 952

  ogg_stream_clear(&work_os);
  return(0);

Monty's avatar
 
Monty committed
953 954
 seek_error:
  /* dump the machine so we're in a known state */
Monty's avatar
 
Monty committed
955
  vf->pcm_offset=-1;
Monty's avatar
 
Monty committed
956
  ogg_stream_clear(&work_os);
Monty's avatar
 
Monty committed
957
  _decode_clear(vf);
Monty's avatar
 
Monty committed
958
  return OV_EBADLINK;
Monty's avatar
 
Monty committed
959 960
}

Monty's avatar
 
Monty committed
961 962
/* 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
963

Monty's avatar
 
Monty committed
964 965 966 967
   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
968
  int link=-1;
Monty's avatar
 
Monty committed
969
  long ret;
Monty's avatar
 
Monty committed
970
  ogg_int64_t total=ov_pcm_total(vf,-1);
Monty's avatar
 
Monty committed
971

Monty's avatar
 
Monty committed
972
  if(vf->ready_state<OPENED)return(OV_EINVAL);
Monty's avatar
 
Monty committed
973 974
  if(!vf->seekable)return(OV_ENOSEEK);
  if(pos<0 || pos>total)return(OV_EINVAL);
Monty's avatar
 
Monty committed
975
 
Monty's avatar
 
Monty committed
976 977 978 979 980 981
  /* 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
982
  /* search within the logical bitstream for the page with the highest
Monty's avatar
 
Monty committed
983 984 985 986
     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
987 988

  /* new search algorithm by HB (Nicholas Vinen) */
Monty's avatar
 
Monty committed
989
  {
Monty's avatar
 
Monty committed
990
    ogg_int64_t target=pos-total;
Monty's avatar
 
Monty committed
991 992
    long end=vf->offsets[link+1];
    long begin=vf->offsets[link];
Monty's avatar
 
Monty committed
993 994
    ogg_int64_t endtime = vf->pcmlengths[link];
    ogg_int64_t begintime = 0;
Monty's avatar
 
Monty committed
995
    long best=begin;
Monty's avatar
 
Monty committed
996
    
Monty's avatar
 
Monty committed
997 998 999
    ogg_page og;
    while(begin<end){
      long bisect;
Monty's avatar
 
Monty committed
1000
      
Monty's avatar
 
Monty committed
1001 1002 1003
      if(end-begin<CHUNKSIZE){
	bisect=begin;
      }else{
Monty's avatar
 
Monty committed
1004 1005 1006 1007 1008
	/* 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
1009 1010
      }
      _seek_helper(vf,bisect);
Monty's avatar
 
Monty committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
    
      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
 
Monty committed
1025 1026 1027
	  ogg_int64_t granulepos=ogg_page_granulepos(&og);
	  if(granulepos<target){
	    best=ret;  /* raw offset of packet with granulepos */ 
Monty's avatar
 
Monty committed
1028 1029 1030 1031 1032
	    begin=vf->offset; /* raw offset of next page */
	    begintime=granulepos;
	    
	    if(target-begin>44100)break;
	    bisect=begin; /* *not* begin + 1 */
Monty's avatar
 
Monty committed
1033
	  }else{
Monty's avatar
 
Monty committed
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
	    if(bisect<=begin+1)
	      end=begin;  /* found it */
	    else{
	      if(end==vf->offset){ /* we're pretty close - we'd be stuck in */
		end=ret;
		bisect-=CHUNKSIZE; /* an endless loop otherwise. */
		if(bisect<=begin)bisect=begin+1;
		_seek_helper(vf,bisect);
	      }else{
		end=ret;
		endtime=granulepos;
		break;
	      }
	    }
Monty's avatar
 
Monty committed
1048
	  }
Monty's avatar
 
Monty committed
1049 1050 1051
	}
      }
    }
Monty's avatar
 
Monty committed
1052