vorbisfile.c 45.2 KB
Newer Older
Monty's avatar
 
Monty committed
1
2
3
4
/********************************************************************
 *                                                                  *
 * THIS FILE IS PART OF THE OggVorbis 'TREMOR' CODEC SOURCE CODE.   *
 *                                                                  *
Monty's avatar
   
Monty committed
5
6
7
8
 * 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
9
 * THE OggVorbis 'TREMOR' SOURCE CODE IS (C) COPYRIGHT 1994-2003    *
Monty's avatar
 
Monty committed
10
11
12
13
14
 * BY THE Xiph.Org FOUNDATION http://www.xiph.org/                  *
 *                                                                  *
 ********************************************************************

 function: stdio-based convenience library for opening/seeking/decoding
Monty's avatar
   
Monty committed
15
 last mod: $Id: vorbisfile.c,v 1.6 2003/03/30 23:40:56 xiphmont Exp $
Monty's avatar
 
Monty committed
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

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

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <string.h>
#include <math.h>

#include "ivorbiscodec.h"
#include "ivorbisfile.h"

#include "misc.h"

/* 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
   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. */

/* We can handle things a number of ways; we can determine the entire
   bitstream structure right off the bat, or find pieces on demand.
   This example determines and caches structure for the entire
   bitstream, but builds a virtual decoder on the fly when moving
   between links in the chain. */

/* 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
   picking some portion of the stream roughly in the desired area if
   we only want coarse navigation through the stream. */

/*************************************************************************
 * 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 */

Monty's avatar
   
Monty committed
59
60

/* read a little more data from the file/pipe into the ogg_sync framer */
Monty's avatar
 
Monty committed
61
62
63
static long _get_data(OggVorbis_File *vf){
  errno=0;
  if(vf->datasource){
64
    unsigned char *buffer=ogg_sync_bufferin(vf->oy,CHUNKSIZE);
Monty's avatar
 
Monty committed
65
    long bytes=(vf->callbacks.read_func)(buffer,1,CHUNKSIZE,vf->datasource);
Monty's avatar
   
Monty committed
66
    if(bytes>0)ogg_sync_wrote(vf->oy,bytes);
Monty's avatar
 
Monty committed
67
68
69
70
71
72
73
    if(bytes==0 && errno)return(-1);
    return(bytes);
  }else
    return(0);
}

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

/* 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

   return:   <0) did not find a page (OV_FALSE, OV_EOF, OV_EREAD)
Monty's avatar
   
Monty committed
96
97
98
              n) found a page at absolute offset n 

              produces a refcounted page */
Monty's avatar
 
Monty committed
99

Monty's avatar
   
Monty committed
100
101
static ogg_int64_t _get_next_page(OggVorbis_File *vf,ogg_page *og,
				  ogg_int64_t boundary){
Monty's avatar
 
Monty committed
102
103
104
105
106
  if(boundary>0)boundary+=vf->offset;
  while(1){
    long more;

    if(boundary>0 && vf->offset>=boundary)return(OV_FALSE);
Monty's avatar
   
Monty committed
107
    more=ogg_sync_pageseek(vf->oy,og);
Monty's avatar
 
Monty committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
    
    if(more<0){
      /* skipped n bytes */
      vf->offset-=more;
    }else{
      if(more==0){
	/* send more paramedics */
	if(!boundary)return(OV_FALSE);
	{
	  long ret=_get_data(vf);
	  if(ret==0)return(OV_EOF);
	  if(ret<0)return(OV_EREAD);
	}
      }else{
	/* got a page.  Return the offset at the page beginning,
           advance the internal offset past the page end */
Monty's avatar
   
Monty committed
124
	ogg_int64_t ret=vf->offset;
Monty's avatar
 
Monty committed
125
126
127
128
129
130
131
132
133
134
135
136
	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
138
139
140
141
142
143
/* returns offset or OV_EREAD, OV_FAULT and produces a refcounted page */

static ogg_int64_t _get_prev_page(OggVorbis_File *vf,ogg_page *og){
  ogg_int64_t begin=vf->offset;
  ogg_int64_t end=begin;
  ogg_int64_t ret;
  ogg_int64_t offset=-1;
Monty's avatar
 
Monty committed
144
145
146
147
148
149

  while(offset==-1){
    begin-=CHUNKSIZE;
    if(begin<0)
      begin=0;
    _seek_helper(vf,begin);
Monty's avatar
   
Monty committed
150
151
    while(vf->offset<end){
      ret=_get_next_page(vf,og,end-vf->offset);
Monty's avatar
 
Monty committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
      if(ret==OV_EREAD)return(OV_EREAD);
      if(ret<0){
	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);
  if(ret<0)
    /* this shouldn't be possible */
    return(OV_EFAULT);

  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 */
static int _bisect_forward_serialno(OggVorbis_File *vf,
Monty's avatar
   
Monty committed
176
177
178
179
				    ogg_int64_t begin,
				    ogg_int64_t searched,
				    ogg_int64_t end,
				    ogg_uint32_t currentno,
Monty's avatar
 
Monty committed
180
				    long m){
Monty's avatar
   
Monty committed
181
182
183
184
  ogg_int64_t endsearched=end;
  ogg_int64_t next=end;
  ogg_page og={0,0,0,0};
  ogg_int64_t ret;
Monty's avatar
 
Monty committed
185
186
187
188
  
  /* the below guards against garbage seperating the last and
     first pages of two links. */
  while(searched<endsearched){
Monty's avatar
   
Monty committed
189
    ogg_int64_t bisect;
Monty's avatar
 
Monty committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
    
    if(endsearched-searched<CHUNKSIZE){
      bisect=searched;
    }else{
      bisect=(searched+endsearched)/2;
    }
    
    _seek_helper(vf,bisect);
    ret=_get_next_page(vf,&og,-1);
    if(ret==OV_EREAD)return(OV_EREAD);
    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
206
    ogg_page_release(&og);
Monty's avatar
 
Monty committed
207
208
209
210
211
212
213
  }

  _seek_helper(vf,next);
  ret=_get_next_page(vf,&og,-1);
  if(ret==OV_EREAD)return(OV_EREAD);
  
  if(searched>=end || ret<0){
Monty's avatar
   
Monty committed
214
    ogg_page_release(&og);
Monty's avatar
 
Monty committed
215
    vf->links=m+1;
Monty's avatar
   
Monty committed
216
217
    vf->offsets=_ogg_malloc((vf->links+1)*sizeof(*vf->offsets));
    vf->serialnos=_ogg_malloc(vf->links*sizeof(*vf->serialnos));
Monty's avatar
 
Monty committed
218
219
220
221
    vf->offsets[m+1]=searched;
  }else{
    ret=_bisect_forward_serialno(vf,next,vf->offset,
				 end,ogg_page_serialno(&og),m+1);
Monty's avatar
   
Monty committed
222
    ogg_page_release(&og);
Monty's avatar
 
Monty committed
223
224
225
226
    if(ret==OV_EREAD)return(OV_EREAD);
  }
  
  vf->offsets[m]=begin;
Monty's avatar
   
Monty committed
227
  vf->serialnos[m]=currentno;
Monty's avatar
 
Monty committed
228
229
230
231
232
  return(0);
}

/* uses the local ogg_stream storage in vf; this is important for
   non-streaming input sources */
Monty's avatar
   
Monty committed
233
234
235
236
237
238
239
240
241
242
/* consumes the page that's passed in (if any) */

static int _fetch_headers(OggVorbis_File *vf,
			  vorbis_info *vi,
			  vorbis_comment *vc,
			  ogg_uint32_t *serialno,
			  ogg_page *og_ptr){
  ogg_page og={0,0,0,0};
  ogg_packet op={0,0,0,0,0,0};
  int i,ret;
Monty's avatar
 
Monty committed
243
244
  
  if(!og_ptr){
Monty's avatar
   
Monty committed
245
246
247
    ogg_int64_t llret=_get_next_page(vf,&og,CHUNKSIZE);
    if(llret==OV_EREAD)return(OV_EREAD);
    if(llret<0)return OV_ENOTVORBIS;
Monty's avatar
 
Monty committed
248
249
250
    og_ptr=&og;
  }

Monty's avatar
   
Monty committed
251
252
  ogg_stream_reset_serialno(vf->os,ogg_page_serialno(og_ptr));
  if(serialno)*serialno=vf->os->serialno;
Monty's avatar
 
Monty committed
253
254
255
256
257
258
259
260
261
262
  vf->ready_state=STREAMSET;
  
  /* extract the initial header from the first page and verify that the
     Ogg bitstream is in fact Vorbis data */
  
  vorbis_info_init(vi);
  vorbis_comment_init(vc);
  
  i=0;
  while(i<3){
Monty's avatar
   
Monty committed
263
    ogg_stream_pagein(vf->os,og_ptr);
Monty's avatar
 
Monty committed
264
    while(i<3){
Monty's avatar
   
Monty committed
265
      int result=ogg_stream_packetout(vf->os,&op);
Monty's avatar
 
Monty committed
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
      if(result==0)break;
      if(result==-1){
	ret=OV_EBADHEADER;
	goto bail_header;
      }
      if((ret=vorbis_synthesis_headerin(vi,vc,&op))){
	goto bail_header;
      }
      i++;
    }
    if(i<3)
      if(_get_next_page(vf,og_ptr,CHUNKSIZE)<0){
	ret=OV_EBADHEADER;
	goto bail_header;
      }
  }
Monty's avatar
   
Monty committed
282
283
284

  ogg_packet_release(&op);
  ogg_page_release(&og);
Monty's avatar
 
Monty committed
285
286
287
  return 0; 

 bail_header:
Monty's avatar
   
Monty committed
288
289
  ogg_packet_release(&op);
  ogg_page_release(&og);
Monty's avatar
 
Monty committed
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
  vorbis_info_clear(vi);
  vorbis_comment_clear(vc);
  vf->ready_state=OPENED;

  return ret;
}

/* 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) */

/* 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
306
307
308
309
static void _prefetch_all_headers(OggVorbis_File *vf, ogg_int64_t dataoffset){
  ogg_page og={0,0,0,0};
  int i;
  ogg_int64_t ret;
Monty's avatar
 
Monty committed
310
  
Monty's avatar
   
Monty committed
311
312
313
314
  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*2*sizeof(*vf->pcmlengths));
Monty's avatar
 
Monty committed
315
316
317
318
319
  
  for(i=0;i<vf->links;i++){
    if(i==0){
      /* we already grabbed the initial header earlier.  Just set the offset */
      vf->dataoffsets[i]=dataoffset;
Monty's avatar
   
Monty committed
320
321
      _seek_helper(vf,dataoffset);

Monty's avatar
 
Monty committed
322
323
324
325
326
327
328
329
330
331
332
333
    }else{

      /* seek to the location of the initial header */

      _seek_helper(vf,vf->offsets[i]);
      if(_fetch_headers(vf,vf->vi+i,vf->vc+i,NULL,NULL)<0){
    	vf->dataoffsets[i]=-1;
      }else{
	vf->dataoffsets[i]=vf->offset;
      }
    }

Monty's avatar
   
Monty committed
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
    /* fetch beginning PCM offset */

    if(vf->dataoffsets[i]!=-1){
      ogg_int64_t accumulated=0,pos;
      long        lastblock=-1;
      int         result;

      ogg_stream_reset_serialno(vf->os,vf->serialnos[i]);

      while(1){
	ogg_packet op={0,0,0,0,0,0};

	ret=_get_next_page(vf,&og,-1);
	if(ret<0)
	  /* this should not be possible unless the file is
             truncated/mangled */
	  break;
       
	if(ogg_page_serialno(&og)!=vf->serialnos[i])
	  break;
	
	pos=ogg_page_granulepos(&og);

	/* count blocksizes of all frames in the page */
	ogg_stream_pagein(vf->os,&og);
	while((result=ogg_stream_packetout(vf->os,&op))){
	  if(result>0){ /* ignore holes */
	    long thisblock=vorbis_packet_blocksize(vf->vi+i,&op);
	    if(lastblock!=-1)
	      accumulated+=(lastblock+thisblock)>>2;
	    lastblock=thisblock;
	  }
	}
	ogg_packet_release(&op);

	if(pos!=-1){
	  /* pcm offset of last packet on the first audio page */
	  accumulated= pos-accumulated;
	  break;
	}
      }

      /* less than zero?  This is a stream with samples trimmed off
         the beginning, a normal occurrence; set the offset to zero */
      if(accumulated<0)accumulated=0;

      vf->pcmlengths[i*2]=accumulated;
    }

    /* get the PCM length of this link. To do this,
Monty's avatar
 
Monty committed
384
385
       get the last page of the stream */
    {
Monty's avatar
   
Monty committed
386
      ogg_int64_t end=vf->offsets[i+1];
Monty's avatar
 
Monty committed
387
388
389
390
391
392
393
394
395
396
397
      _seek_helper(vf,end);

      while(1){
	ret=_get_prev_page(vf,&og);
	if(ret<0){
	  /* this should not be possible */
	  vorbis_info_clear(vf->vi+i);
	  vorbis_comment_clear(vf->vc+i);
	  break;
	}
	if(ogg_page_granulepos(&og)!=-1){
Monty's avatar
   
Monty committed
398
	  vf->pcmlengths[i*2+1]=ogg_page_granulepos(&og)-vf->pcmlengths[i*2];
Monty's avatar
 
Monty committed
399
400
401
402
403
404
	  break;
	}
	vf->offset=ret;
      }
    }
  }
Monty's avatar
   
Monty committed
405
  ogg_page_release(&og);
Monty's avatar
 
Monty committed
406
407
408
409
410
411
412
413
414
415
416
}

static void _make_decode_ready(OggVorbis_File *vf){
  if(vf->ready_state!=STREAMSET)return;
  if(vf->seekable){
    vorbis_synthesis_init(&vf->vd,vf->vi+vf->current_link);
  }else{
    vorbis_synthesis_init(&vf->vd,vf->vi);
  }    
  vorbis_block_init(&vf->vd,&vf->vb);
  vf->ready_state=INITSET;
Monty's avatar
   
Monty committed
417
418
  vf->bittrack=0;
  vf->samptrack=0;
Monty's avatar
 
Monty committed
419
420
421
422
  return;
}

static int _open_seekable2(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
423
424
425
426
  ogg_uint32_t serialno=vf->current_serialno;
  ogg_uint32_t tempserialno;
  ogg_int64_t dataoffset=vf->offset, end;
  ogg_page og={0,0,0,0};
Monty's avatar
 
Monty committed
427
428
429
430
431
432
433
434
435
436

  /* we're partially open and have a first link header state in
     storage in vf */
  /* we can seek, so set out learning all about this file */
  (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
  vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
  
  /* 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
437
  if(end<0)return(end);
Monty's avatar
 
Monty committed
438
439

  /* more than one logical bitstream? */
Monty's avatar
   
Monty committed
440
441
442
443
  tempserialno=ogg_page_serialno(&og);
  ogg_page_release(&og);

  if(tempserialno!=serialno){
Monty's avatar
 
Monty committed
444
445
446

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

  }else{

    /* Only one logical bitstream */
Monty's avatar
   
Monty committed
452
    if(_bisect_forward_serialno(vf,0,end,end+1,serialno,0))return(OV_EREAD);
Monty's avatar
 
Monty committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478

  }

  /* the initial header memory is referenced by vf after; don't free it */
  _prefetch_all_headers(vf,dataoffset);
  return(ov_raw_seek(vf,0));
}

/* clear out the current logical bitstream decoder */ 
static void _decode_clear(OggVorbis_File *vf){
  vorbis_dsp_clear(&vf->vd);
  vorbis_block_clear(&vf->vb);
  vf->ready_state=OPENED;
}

/* 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). 

   return: <0) error, OV_HOLE (lost packet) or OV_EOF
            0) need more data (only if readp==0)
	    1) got a packet 
*/

Monty's avatar
   
Monty committed
479
480
481
482
483
484
static int _fetch_and_process_packet(OggVorbis_File *vf,
				     int readp,
				     int spanp){
  ogg_page og={0,0,0,0};
  ogg_packet op={0,0,0,0,0,0};
  int ret=0;
Monty's avatar
 
Monty committed
485
486
487
488
489
490
491
492
493

  /* 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 */
    if(vf->ready_state==INITSET){
      while(1) {
Monty's avatar
   
Monty committed
494
	int result=ogg_stream_packetout(vf->os,&op);
Monty's avatar
 
Monty committed
495
496
	ogg_int64_t granulepos;

Monty's avatar
   
Monty committed
497
498
499
500
	if(result<0){
	  ret=OV_HOLE; /* hole in the data. */
	  goto cleanup;
	}
Monty's avatar
 
Monty committed
501
502
503
	if(result>0){
	  /* got a packet.  process it */
	  granulepos=op.granulepos;
Monty's avatar
   
Monty committed
504
505
506
507
508
509
510
	  if(!vorbis_synthesis(&vf->vb,&op,1)){ /* 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
511
512
513
514

	    /* suck in the synthesis data and track bitrate */
	    {
	      int oldsamples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
   
Monty committed
515
516
517
518
519
520
521
	      /* for proper use of libvorbis within libvorbisfile,
                 oldsamples will always be zero. */
	      if(oldsamples){
		ret=OV_EFAULT;
		goto cleanup;
	      }

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
	      vorbis_synthesis_blockin(&vf->vd,&vf->vb);
	      vf->samptrack+=vorbis_synthesis_pcmout(&vf->vd,NULL)-oldsamples;
	      vf->bittrack+=op.bytes*8;
	    }
	  
	    /* update the pcm offset. */
	    if(granulepos!=-1 && !op.e_o_s){
	      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
	         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
	         to have a reference point.  Thus the !op.e_o_s clause
	         above */
Monty's avatar
   
Monty committed
544
545
546
547
548
549
550
551

	      if(vf->seekable && link>0)
		granulepos-=vf->pcmlengths[link*2];
	      if(granulepos<0)granulepos=0; /* actually, this
					       shouldn't be possible
					       here unless the stream
					       is very broken */

Monty's avatar
 
Monty committed
552
553
554
555
	      samples=vorbis_synthesis_pcmout(&vf->vd,NULL);
	    
	      granulepos-=samples;
	      for(i=0;i<link;i++)
Monty's avatar
   
Monty committed
556
	        granulepos+=vf->pcmlengths[i*2+1];
Monty's avatar
 
Monty committed
557
558
	      vf->pcm_offset=granulepos;
	    }
Monty's avatar
   
Monty committed
559
560
	    ret=1;
	    goto cleanup;
Monty's avatar
 
Monty committed
561
562
563
564
565
566
567
568
	  }
	}
	else 
	  break;
      }
    }

    if(vf->ready_state>=OPENED){
Monty's avatar
   
Monty committed
569
570
571
572
573
574
575
576
577
578
579
580
      int ret;
      if(!readp){
	ret=0;
	goto cleanup;
      }
      if((ret=_get_next_page(vf,&og,-1))<0){
	ret=OV_EOF; /* eof. leave unitialized */
	goto cleanup;
      }

	/* bitrate tracking; add the header's bytes here, the body bytes
	   are done by packet above */
Monty's avatar
 
Monty committed
581
582
583
584
585
      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)){
Monty's avatar
   
Monty committed
586
587
588
589
590
	  if(!spanp){
	    ret=OV_EOF;
	    goto cleanup;
	  }

Monty's avatar
 
Monty committed
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
	  _decode_clear(vf);
	  
	  if(!vf->seekable){
	    vorbis_info_clear(vf->vi);
	    vorbis_comment_clear(vf->vc);
	  }
	}
      }
    }

    /* 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
    */

    if(vf->ready_state!=INITSET){ 
      int link;

      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;
Monty's avatar
   
Monty committed
625
626
627
628
629
	  if(link==vf->links){
	    ret=OV_EBADLINK; /* sign of a bogus stream.  error out,
				leave machine uninitialized */
	    goto cleanup;
	  }
Monty's avatar
 
Monty committed
630
631
632
	  
	  vf->current_link=link;
	  
Monty's avatar
   
Monty committed
633
	  ogg_stream_reset_serialno(vf->os,vf->current_serialno);
Monty's avatar
 
Monty committed
634
635
636
637
638
639
640
	  vf->ready_state=STREAMSET;
	  
	}else{
	  /* we're streaming */
	  /* fetch the three header packets, build the info struct */
	  
	  int ret=_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,&og);
Monty's avatar
   
Monty committed
641
	  if(ret) goto cleanup;
Monty's avatar
 
Monty committed
642
643
644
645
646
647
648
	  vf->current_link++;
	  link=0;
	}
      }
      
      _make_decode_ready(vf);
    }
Monty's avatar
   
Monty committed
649
    ogg_stream_pagein(vf->os,&og);
Monty's avatar
 
Monty committed
650
  }
Monty's avatar
   
Monty committed
651
652
653
654
 cleanup:
  ogg_packet_release(&op);
  ogg_page_release(&og);
  return ret;
Monty's avatar
 
Monty committed
655
656
}

Monty's avatar
   
Monty committed
657
658
/* if, eg, 64 bit stdio is configured by default, this will build with
   fseek64 */
Monty's avatar
 
Monty committed
659
660
static int _fseek64_wrap(FILE *f,ogg_int64_t off,int whence){
  if(f==NULL)return(-1);
Monty's avatar
   
Monty committed
661
  return fseek(f,off,whence);
Monty's avatar
 
Monty committed
662
663
664
665
}

static int _ov_open1(void *f,OggVorbis_File *vf,char *initial,
		     long ibytes, ov_callbacks callbacks){
Monty's avatar
   
Monty committed
666
  int offsettest=(f?callbacks.seek_func(f,0,SEEK_CUR):-1);
Monty's avatar
 
Monty committed
667
668
669
670
671
672
673
  int ret;

  memset(vf,0,sizeof(*vf));
  vf->datasource=f;
  vf->callbacks = callbacks;

  /* init the framing state */
Monty's avatar
   
Monty committed
674
  vf->oy=ogg_sync_create();
Monty's avatar
 
Monty committed
675
676
677
678
679
680

  /* 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){
681
    unsigned char *buffer=ogg_sync_bufferin(vf->oy,ibytes);
Monty's avatar
 
Monty committed
682
    memcpy(buffer,initial,ibytes);
Monty's avatar
   
Monty committed
683
    ogg_sync_wrote(vf->oy,ibytes);
Monty's avatar
 
Monty committed
684
685
686
  }

  /* can we seek? Stevens suggests the seek test was portable */
Monty's avatar
   
Monty committed
687
  if(offsettest!=-1)vf->seekable=1;
Monty's avatar
 
Monty committed
688
689
690
691

  /* No seeking yet; Set up a 'single' (current) logical bitstream
     entry for partial open */
  vf->links=1;
Monty's avatar
   
Monty committed
692
693
694
695
  vf->vi=_ogg_calloc(vf->links,sizeof(*vf->vi));
  vf->vc=_ogg_calloc(vf->links,sizeof(*vf->vc));
  vf->os=ogg_stream_create(-1); /* fill in the serialno later */

Monty's avatar
 
Monty committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
  /* 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);
  }else if(vf->ready_state < PARTOPEN)
    vf->ready_state=PARTOPEN;
  return(ret);
}

static int _ov_open2(OggVorbis_File *vf){
  if(vf->ready_state < OPENED)
    vf->ready_state=OPENED;
  if(vf->seekable){
    int ret=_open_seekable2(vf);
    if(ret){
      vf->datasource=NULL;
      ov_clear(vf);
    }
    return(ret);
  }
  return 0;
}


/* clear out the OggVorbis_File struct */
int ov_clear(OggVorbis_File *vf){
  if(vf){
    vorbis_block_clear(&vf->vb);
    vorbis_dsp_clear(&vf->vd);
Monty's avatar
   
Monty committed
725
    ogg_stream_destroy(vf->os);
Monty's avatar
 
Monty committed
726
727
728
729
730
731
732
733
734
735
736
737
738
739
    
    if(vf->vi && vf->links){
      int i;
      for(i=0;i<vf->links;i++){
	vorbis_info_clear(vf->vi+i);
	vorbis_comment_clear(vf->vc+i);
      }
      _ogg_free(vf->vi);
      _ogg_free(vf->vc);
    }
    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
740
741
    ogg_sync_destroy(vf->oy);

Monty's avatar
 
Monty committed
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
    if(vf->datasource)(vf->callbacks.close_func)(vf->datasource);
    memset(vf,0,sizeof(*vf));
  }
#ifdef DEBUG_LEAKS
  _VDBG_dump();
#endif
  return(0);
}

/* inspects the OggVorbis file and finds/documents all the logical
   bitstreams contained in it.  Tries to be tolerant of logical
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

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);
}

int ov_open(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
  };

  return ov_open_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
  
/* 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. */

int ov_test_callbacks(void *f,OggVorbis_File *vf,char *initial,long ibytes,
    ov_callbacks callbacks)
{
  return _ov_open1(f,vf,initial,ibytes,callbacks);
}

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
  };

  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);
}

/* How many logical bitstreams in this physical bitstream? */
long ov_streams(OggVorbis_File *vf){
  return vf->links;
}

/* Is the FILE * associated with vf seekable? */
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
}

/* 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){
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(i>=vf->links)return(OV_EINVAL);
  if(!vf->seekable && i!=0)return(ov_bitrate(vf,0));
  if(i<0){
    ogg_int64_t bits=0;
    int i;
    for(i=0;i<vf->links;i++)
      bits+=(vf->offsets[i+1]-vf->dataoffsets[i])*8;
Monty's avatar
   
Monty committed
832
833
834
835
    /* This once read: return(rint(bits/ov_time_total(vf,-1)));
     * gcc 3.x on x86 miscompiled this at optimisation level 2 and above,
     * so this is slightly transformed to make it work.
     */
Monty's avatar
 
Monty committed
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
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
    return(bits*1000/ov_time_total(vf,-1));
  }else{
    if(vf->seekable){
      /* return the actual bitrate */
      return((vf->offsets[i+1]-vf->dataoffsets[i])*8000/ov_time_total(vf,i));
    }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;
	  }
	}
	return(OV_FALSE);
      }
    }
  }
}

/* returns the actual bitrate since last call.  returns -1 if no
   additional data to offer since last call (or at beginning of stream),
   EINVAL if stream is only partially open 
*/
long ov_bitrate_instant(OggVorbis_File *vf){
  int link=(vf->seekable?vf->current_link:0);
  long ret;
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(vf->samptrack==0)return(OV_FALSE);
  ret=vf->bittrack/vf->samptrack*vf->vi[link].rate;
  vf->bittrack=0;
  vf->samptrack=0;
  return(ret);
}

/* Guess */
long ov_serialnumber(OggVorbis_File *vf,int i){
  if(i>=vf->links)return(ov_serialnumber(vf,vf->links-1));
  if(!vf->seekable && i>=0)return(ov_serialnumber(vf,-1));
  if(i<0){
    return(vf->current_serialno);
  }else{
    return(vf->serialnos[i]);
  }
}

/* returns: total raw (compressed) length of content if i==-1
            raw (compressed) length of that logical bitstream for i==0 to n
	    OV_EINVAL if the stream is not seekable (we can't know the length)
	    or if stream is only partially open
*/
ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i){
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
  if(i<0){
Monty's avatar
   
Monty committed
894
    ogg_int64_t acc=0;
Monty's avatar
 
Monty committed
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
    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]);
  }
}

/* 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 
*/
ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i){
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
  if(i<0){
    ogg_int64_t acc=0;
    int i;
    for(i=0;i<vf->links;i++)
      acc+=ov_pcm_total(vf,i);
    return(acc);
  }else{
Monty's avatar
   
Monty committed
919
    return(vf->pcmlengths[i*2+1]);
Monty's avatar
 
Monty committed
920
921
922
923
  }
}

/* returns: total milliseconds of content if i==-1
Monty's avatar
   
Monty committed
924
            milliseconds in that logical bitstream for i==0 to n
Monty's avatar
 
Monty committed
925
926
927
928
929
930
931
932
933
934
935
936
937
	    OV_EINVAL if the stream is not seekable (we can't know the
	    length) or only partially open 
*/
ogg_int64_t ov_time_total(OggVorbis_File *vf,int i){
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
  if(i<0){
    ogg_int64_t acc=0;
    int i;
    for(i=0;i<vf->links;i++)
      acc+=ov_time_total(vf,i);
    return(acc);
  }else{
Monty's avatar
   
Monty committed
938
    return(((ogg_int64_t)vf->pcmlengths[i*2+1])*1000/vf->vi[i].rate);
Monty's avatar
 
Monty committed
939
940
941
942
943
944
945
946
947
948
  }
}

/* seek to an offset relative to the *compressed* data. This also
   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).

   returns zero on success, nonzero on failure */

Monty's avatar
   
Monty committed
949
950
951
952
953
int ov_raw_seek(OggVorbis_File *vf,ogg_int64_t pos){
  ogg_stream_state *work_os=NULL;
  ogg_page og={0,0,0,0};
  ogg_packet op={0,0,0,0,0,0};
  
Monty's avatar
 
Monty committed
954
955
956
957
  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
958
959
960
961
962
963
  if(pos<0 || pos>vf->end)return(OV_EINVAL);

  /* don't yet clear out decoding machine (if it's initialized), in
     the case we're in the same link.  Restart the decode lapping, and
     let _fetch_and_process_packet deal with a potential bitstream
     boundary */
Monty's avatar
 
Monty committed
964
  vf->pcm_offset=-1;
Monty's avatar
   
Monty committed
965
966
967
968
  ogg_stream_reset_serialno(vf->os,
			    vf->current_serialno); /* must set serialno */
  vorbis_synthesis_restart(&vf->vd);
    
Monty's avatar
 
Monty committed
969
970
971
972
973
974
975
976
  _seek_helper(vf,pos);

  /* 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
Monty's avatar
   
Monty committed
977
     the shared vf->os stream state.  We use the local state to
Monty's avatar
 
Monty committed
978
979
980
981
982
983
984
985
986
987
988
     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. 
  */

  {
    int lastblock=0;
    int accblock=0;
Monty's avatar
   
Monty committed
989
    int thisblock;
990
    int eosflag=0;
Monty's avatar
 
Monty committed
991

Monty's avatar
   
Monty committed
992
    work_os=ogg_stream_create(vf->current_serialno); /* get the memory ready */
Monty's avatar
 
Monty committed
993
    while(1){
Monty's avatar
   
Monty committed
994
      if(vf->ready_state>=STREAMSET){
Monty's avatar
 
Monty committed
995
	/* snarf/scan a packet if we can */
Monty's avatar
   
Monty committed
996
	int result=ogg_stream_packetout(work_os,&op);
Monty's avatar
 
Monty committed
997
998
999
      
	if(result>0){

Monty's avatar
   
Monty committed
1000
	  if(vf->vi[vf->current_link].codec_setup){
Monty's avatar
 
Monty committed
1001
	    thisblock=vorbis_packet_blocksize(vf->vi+vf->current_link,&op);
Monty's avatar
   
Monty committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
	    if(thisblock<0){
	      ogg_stream_packetout(vf->os,NULL);
	      thisblock=0;
	    }else{
	      
	      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-vf->pcmlengths[link*2];
	      if(granulepos<0)granulepos=0;
	      
	      for(i=0;i<link;i++)
		granulepos+=vf->pcmlengths[i*2+1];
	      vf->pcm_offset=granulepos-accblock;
	      break;
	    }
	    lastblock=thisblock;
	    continue;
	  }else
	    ogg_stream_packetout(vf->os,NULL);
Monty's avatar
 
Monty committed
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
	}
      }
      
      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? */
Monty's avatar
   
Monty committed
1042
      if(vf->ready_state>=STREAMSET)
Monty's avatar
 
Monty committed
1043
	if(vf->current_serialno!=ogg_page_serialno(&og)){
Monty's avatar
   
Monty committed
1044
1045
1046
	  _decode_clear(vf); /* clear out stream state */
	  ogg_stream_destroy(work_os);
	}
Monty's avatar
 
Monty committed
1047
1048
1049
1050
1051
1052
1053

      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;
Monty's avatar
   
Monty committed
1054
1055
1056
1057
	if(link==vf->links)
	  goto seek_error; /* sign of a bogus stream.  error out,
			      leave machine uninitialized */
 
Monty's avatar
 
Monty committed
1058
1059
	vf->current_link=link;
	
Monty's avatar
   
Monty committed
1060
1061
	ogg_stream_reset_serialno(vf->os,vf->current_serialno);
	ogg_stream_reset_serialno(work_os,vf->current_serialno); 
Monty's avatar
 
Monty committed
1062
1063
1064
1065
	vf->ready_state=STREAMSET;
	
      }
    
Monty's avatar
   
Monty committed
1066
1067
1068
1069
1070
1071
1072
      {
	ogg_page dup;
	ogg_page_dup(&dup,&og);
	eosflag=ogg_page_eos(&og);
	ogg_stream_pagein(vf->os,&og);
	ogg_stream_pagein(work_os,&dup);
      }
Monty's avatar
 
Monty committed
1073
1074
1075
    }
  }

Monty's avatar
   
Monty committed
1076
1077
1078
1079
1080
  ogg_packet_release(&op);
  ogg_page_release(&og);
  ogg_stream_destroy(work_os);
  vf->bittrack=0;
  vf->samptrack=0;
Monty's avatar
 
Monty committed
1081
1082
1083
  return(0);

 seek_error:
Monty's avatar
   
Monty committed
1084
1085
1086
  ogg_packet_release(&op);
  ogg_page_release(&og);

Monty's avatar
 
Monty committed
1087
1088
  /* dump the machine so we're in a known state */
  vf->pcm_offset=-1;
Monty's avatar
   
Monty committed
1089
  ogg_stream_destroy(work_os);
Monty's avatar
 
Monty committed
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
  _decode_clear(vf);
  return OV_EBADLINK;
}

/* Page granularity seek (faster than sample granularity because we
   don't do the last bit of decode to find a specific sample).

   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){
  int link=-1;
Monty's avatar
   
Monty committed
1102
  ogg_int64_t result=0;
Monty's avatar
 
Monty committed
1103
  ogg_int64_t total=ov_pcm_total(vf,-1);
Monty's avatar
   
Monty committed
1104
1105
  ogg_page og={0,0,0,0};
  ogg_packet op={0,0,0,0,0,0};
Monty's avatar
 
Monty committed
1106
1107
1108
1109
1110
1111
1112

  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(!vf->seekable)return(OV_ENOSEEK);
  if(pos<0 || pos>total)return(OV_EINVAL);
 
  /* which bitstream section does this pcm offset occur in? */
  for(link=vf->links-1;link>=0;link--){
Monty's avatar
   
Monty committed
1113
    total-=vf->pcmlengths[link*2+1];
Monty's avatar
 
Monty committed
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
    if(pos>=total)break;
  }

  /* search within the logical bitstream for the page with the highest
     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) */

  /* new search algorithm by HB (Nicholas Vinen) */
  {
Monty's avatar
   
Monty committed
1125
1126
1127
1128
1129
1130
    ogg_int64_t end=vf->offsets[link+1];
    ogg_int64_t begin=vf->offsets[link];
    ogg_int64_t begintime = vf->pcmlengths[link*2];
    ogg_int64_t endtime = vf->pcmlengths[link*2+1]+begintime;
    ogg_int64_t target=pos-total+begintime;
    ogg_int64_t best=begin;
Monty's avatar
 
Monty committed
1131
1132
    
    while(begin<end){
Monty's avatar
   
Monty committed
1133
      ogg_int64_t bisect;
Monty's avatar
 
Monty committed
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
      
      if(end-begin<CHUNKSIZE){
	bisect=begin;
      }else{
	/* 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
1144
      
Monty's avatar
 
Monty committed
1145
1146
1147
      _seek_helper(vf,bisect);
    
      while(begin<end){
Monty's avatar
   
Monty committed
1148
1149
1150
	result=_get_next_page(vf,&og,end-vf->offset);
	if(result==OV_EREAD) goto seek_error;
	if(result<0){
Monty's avatar
 
Monty committed
1151
1152
1153
	  if(bisect<=begin+1)
	    end=begin; /* found it */
	  else{
Monty's avatar
   
Monty committed
1154
	    if(bisect==0) goto seek_error;
Monty's avatar
 
Monty committed
1155
1156
1157
1158
1159
1160
	    bisect-=CHUNKSIZE;
	    if(bisect<=begin)bisect=begin+1;
	    _seek_helper(vf,bisect);
	  }
	}else{
	  ogg_int64_t granulepos=ogg_page_granulepos(&og);
Monty's avatar
   
Monty committed
1161
	  if(granulepos==-1)continue;
Monty's avatar
 
Monty committed
1162
	  if(granulepos<target){
Monty's avatar
   
Monty committed
1163
	    best=result;  /* raw offset of packet with granulepos */ 
Monty's avatar
 
Monty committed
1164
1165
1166
	    begin=vf->offset; /* raw offset of next page */
	    begintime=granulepos;
	    
Monty's avatar
   
Monty committed
1167
	    if(target-begintime>44100)break;
Monty's avatar
 
Monty committed
1168
1169
1170
1171
1172
1173
	    bisect=begin; /* *not* begin + 1 */
	  }else{
	    if(bisect<=begin+1)
	      end=begin;  /* found it */
	    else{
	      if(end==vf->offset){ /* we're pretty close - we'd be stuck in */
Monty's avatar
   
Monty committed
1174
		end=result;
Monty's avatar
 
Monty committed
1175
1176
1177
1178
		bisect-=CHUNKSIZE; /* an endless loop otherwise. */
		if(bisect<=begin)bisect=begin+1;
		_seek_helper(vf,bisect);
	      }else{
Monty's avatar
   
Monty committed
1179
		end=result;
Monty's avatar
 
Monty committed
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
		endtime=granulepos;
		break;
	      }
	    }
	  }
	}
      }
    }

    /* found our page. seek to it, update pcm offset. Easier case than
       raw_seek, don't keep packets preceeding granulepos. */
    {
Monty's avatar
   
Monty committed
1192
      
Monty's avatar
 
Monty committed
1193
1194
      /* seek */
      _seek_helper(vf,best);
Monty's avatar
   
Monty committed
1195
      vf->pcm_offset=-1;
Monty's avatar
 
Monty committed
1196
      
Monty's avatar
   
Monty committed
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
      if(_get_next_page(vf,&og,-1)<0){
	ogg_page_release(&og);
	return(OV_EOF); /* shouldn't happen */
      }

      if(link!=vf->current_link){
	/* Different link; dump entire decode machine */
	_decode_clear(vf);  
	
	vf->current_link=link;
	vf->current_serialno=ogg_page_serialno(&og);
	vf->ready_state=STREAMSET;
	
      }else{
	vorbis_synthesis_restart(&vf->vd);
      }

      ogg_stream_reset_serialno(vf->os,vf->current_serialno);
      ogg_stream_pagein(vf->os,&og);
Monty's avatar
 
Monty committed
1216
1217
1218

      /* pull out all but last packet; the one with granulepos */
      while(1){
Monty's avatar
   
Monty committed
1219
1220
	result=ogg_stream_packetpeek(vf->os,&op);
	if(result==0){
Monty's avatar
 
Monty committed
1221
1222
1223
1224
	  /* !!! the packet finishing this page originated on a
             preceeding page. Keep fetching previous pages until we
             get one with a granulepos or without the 'continued' flag
             set.  Then just use raw_seek for simplicity. */
Monty's avatar
   
Monty committed
1225
1226
1227
	  
	  _seek_helper(vf,best);
	  
Monty's avatar
 
Monty committed
1228
	  while(1){
Monty's avatar
   
Monty committed
1229
1230
	    result=_get_prev_page(vf,&og);
	    if(result<0) goto seek_error;
Monty's avatar
 
Monty committed
1231
1232
	    if(ogg_page_granulepos(&og)>-1 ||
	       !ogg_page_continued(&og)){
Monty's avatar
   
Monty committed
1233
	      return ov_raw_seek(vf,result);
Monty's avatar
 
Monty committed
1234
	    }
Monty's avatar
   
Monty committed
1235
	    vf->offset=result;
Monty's avatar
 
Monty committed
1236
1237
	  }
	}
Monty's avatar
   
Monty committed
1238
1239
1240
1241
	if(result<0){
	  result = OV_EBADPACKET; 
	  goto seek_error;
	}
Monty's avatar
 
Monty committed
1242
	if(op.granulepos!=-1){
Monty's avatar
   
Monty committed
1243
1244
1245
	  vf->pcm_offset=op.granulepos-vf->pcmlengths[vf->current_link*2];
	  if(vf->pcm_offset<0)vf->pcm_offset=0;
	  vf->pcm_offset+=total;
Monty's avatar
 
Monty committed
1246
1247
	  break;
	}else
Monty's avatar
   
Monty committed
1248
	  result=ogg_stream_packetout(vf->os,NULL);
Monty's avatar
 
Monty committed
1249
1250
1251
1252
1253
1254
      }
    }
  }
  
  /* verify result */
  if(vf->pcm_offset>pos || pos>ov_pcm_total(vf,-1)){
Monty's avatar
   
Monty committed
1255
    result=OV_EFAULT;
Monty's avatar
 
Monty committed
1256
1257
    goto seek_error;
  }
Monty's avatar
   
Monty committed
1258
1259
1260
1261
1262
  vf->bittrack=0;
  vf->samptrack=0;

  ogg_page_release(&og);
  ogg_packet_release(&op);
Monty's avatar
 
Monty committed
1263
1264
1265
  return(0);
  
 seek_error:
Monty's avatar
   
Monty committed
1266
1267
1268
1269

  ogg_page_release(&og);
  ogg_packet_release(&op);

Monty's avatar
 
Monty committed
1270
1271
1272
  /* dump machine so we're in a known state */
  vf->pcm_offset=-1;
  _decode_clear(vf);
Monty's avatar
   
Monty committed
1273
  return (int)result;
Monty's avatar
 
Monty committed
1274
1275
1276
1277
1278
1279
}

/* seek to a sample offset relative to the decompressed pcm stream 
   returns zero on success, nonzero on failure */

int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos){
Monty's avatar
   
Monty committed
1280
1281
  ogg_packet op={0,0,0,0,0,0};
  ogg_page og={0,0,0,0};
Monty's avatar
 
Monty committed
1282
1283
1284
  int thisblock,lastblock=0;
  int ret=ov_pcm_seek_page(vf,pos);
  if(ret<0)return(ret);
Monty's avatar
   
Monty committed
1285
  _make_decode_ready(vf);
Monty's avatar
 
Monty committed
1286
1287
1288
1289
1290
1291

  /* discard leading packets we don't need for the lapping of the
     position we want; don't decode them */

  while(1){

Monty's avatar
   
Monty committed
1292
    int ret=ogg_stream_packetpeek(vf->os,&op);
Monty's avatar
 
Monty committed
1293
1294
    if(ret>0){
      thisblock=vorbis_packet_blocksize(vf->vi+vf->current_link,&op);
Monty's avatar
   
Monty committed
1295
1296
1297
1298
      if(thisblock<0){
	ogg_stream_packetout(vf->os,NULL);
	continue; /* non audio packet */
      }
Monty's avatar
 
Monty committed
1299
      if(lastblock)vf->pcm_offset+=(lastblock+thisblock)>>2;
Monty's avatar
   
Monty committed
1300
      
Monty's avatar
 
Monty committed
1301
1302
1303
      if(vf->pcm_offset+((thisblock+
			  vorbis_info_blocksize(vf->vi,1))>>2)>=pos)break;
      
Monty's avatar
   
Monty committed
1304
1305
1306
1307
1308
1309
1310
      /* remove the packet from packet queue and track its granulepos */
      ogg_stream_packetout(vf->os,NULL);
      vorbis_synthesis(&vf->vb,&op,0);  /* set up a vb with
					   only tracking, no
					   pcm_decode */
      vorbis_synthesis_blockin(&vf->vd,&vf->vb); 
      
Monty's avatar
 
Monty committed
1311
      /* end of logical stream case is hard, especially with exact
Monty's avatar
   
Monty committed
1312
1313
	 length positioning. */
      
Monty's avatar
 
Monty committed
1314
1315
1316
      if(op.granulepos>-1){
	int i;
	/* always believe the stream markers */
Monty's avatar
   
Monty committed
1317
1318
	vf->pcm_offset=op.granulepos-vf->pcmlengths[vf->current_link*2];
	if(vf->pcm_offset<0)vf->pcm_offset=0;
Monty's avatar
 
Monty committed
1319
	for(i=0;i<vf->current_link;i++)
Monty's avatar
   
Monty committed
1320
	  vf->pcm_offset+=vf->pcmlengths[i*2+1];
Monty's avatar
 
Monty committed
1321
      }
Monty's avatar
   
Monty committed
1322
	
Monty's avatar
 
Monty committed
1323
      lastblock=thisblock;
Monty's avatar
   
Monty committed
1324
      
Monty's avatar
 
Monty committed
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
    }else{
      if(ret<0 && ret!=OV_HOLE)break;
      
      /* suck in a new page */
      if(_get_next_page(vf,&og,-1)<0)break;
      if(vf->current_serialno!=ogg_page_serialno(&og))_decode_clear(vf);
      
      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;
Monty's avatar
   
Monty committed
1338
1339
1340
1341
1342
	if(link==vf->links){
	  ogg_page_release(&og);
	  ogg_packet_release(&op);
	  return(OV_EBADLINK);
	}
Monty's avatar
 
Monty committed
1343
1344
	vf->current_link=link;
	
Monty's avatar
   
Monty committed
1345
	ogg_stream_reset_serialno(vf->os,vf->current_serialno); 
Monty's avatar
 
Monty committed
1346
	vf->ready_state=STREAMSET;      
Monty's avatar
   
Monty committed
1347
	_make_decode_ready(vf);
Monty's avatar
 
Monty committed
1348
1349
	lastblock=0;
      }
Monty's avatar
   
Monty committed
1350
1351

      ogg_stream_pagein(vf->os,&og);
Monty's avatar
 
Monty committed
1352
1353
1354
    }
  }

Monty's avatar
   
Monty committed
1355
1356
  vf->bittrack=0;
  vf->samptrack=0;
Monty's avatar
 
Monty committed
1357
1358
1359
  /* discard samples until we reach the desired position. Crossing a
     logical bitstream boundary with abandon is OK. */
  while(vf->pcm_offset<pos){
Monty's avatar
   
Monty committed
1360
1361
    ogg_int64_t target=pos-vf->pcm_offset;
    long samples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
 
Monty committed
1362
1363
1364
1365
1366
1367

    if(samples>target)samples=target;
    vorbis_synthesis_read(&vf->vd,samples);
    vf->pcm_offset+=samples;
    
    if(samples<target)
Monty's avatar
   
Monty committed
1368
      if(_fetch_and_process_packet(vf,1,1)<=0)
Monty's avatar
 
Monty committed
1369
1370
	vf->pcm_offset=ov_pcm_total(vf,-1); /* eof */
  }
Monty's avatar
   
Monty committed
1371
1372
1373

  ogg_page_release(&og);
  ogg_packet_release(&op);
Monty's avatar
 
Monty committed
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
  return 0;
}

/* seek to a playback time relative to the decompressed pcm stream 
   returns zero on success, nonzero on failure */
int ov_time_seek(OggVorbis_File *vf,ogg_int64_t milliseconds){
  /* translate time to PCM position and call ov_pcm_seek */

  int link=-1;
  ogg_int64_t pcm_total=ov_pcm_total(vf,-1);
  ogg_int64_t time_total=ov_time_total(vf,-1);

  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(!vf->seekable)return(OV_ENOSEEK);
  if(milliseconds<0 || milliseconds>time_total)return(OV_EINVAL);
  
  /* which bitstream section does this time offset occur in? */
  for(link=vf->links-1;link>=0;link--){
Monty's avatar
   
Monty committed
1392
    pcm_total-=vf->pcmlengths[link*2+1];
Monty's avatar
 
Monty committed
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
    time_total-=ov_time_total(vf,link);
    if(milliseconds>=time_total)break;
  }

  /* enough information to convert time offset to pcm offset */
  {
    ogg_int64_t target=pcm_total+(milliseconds-time_total)*vf->vi[link].rate/1000;
    return(ov_pcm_seek(vf,target));
  }
}

/* page-granularity version of ov_time_seek 
   returns zero on success, nonzero on failure */
int ov_time_seek_page(OggVorbis_File *vf,ogg_int64_t milliseconds){
  /* translate time to PCM position and call ov_pcm_seek */

  int link=-1;
  ogg_int64_t pcm_total=ov_pcm_total(vf,-1);
  ogg_int64_t time_total=ov_time_total(vf,-1);

  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(!vf->seekable)return(OV_ENOSEEK);
  if(milliseconds<0 || milliseconds>time_total)return(OV_EINVAL);
  
  /* which bitstream section does this time offset occur in? */
  for(link=vf->links-1;link>=0;link--){
Monty's avatar
   
Monty committed
1419
    pcm_total-=vf->pcmlengths[link*2+1];
Monty's avatar
 
Monty committed
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
    time_total-=ov_time_total(vf,link);
    if(milliseconds>=time_total)break;
  }

  /* enough information to convert time offset to pcm offset */
  {
    ogg_int64_t target=pcm_total+(milliseconds-time_total)*vf->vi[link].rate/1000;
    return(ov_pcm_seek_page(vf,target));
  }
}

/* tell the current stream offset cursor.  Note that seek followed by
   tell will likely not give the set offset due to caching */
ogg_int64_t ov_raw_tell(OggVorbis_File *vf){
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  return(vf->offset);
}

/* return PCM offset (sample) of next PCM sample to be read */
ogg_int64_t ov_pcm_tell(OggVorbis_File *vf){
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  return(vf->pcm_offset);
}

/* return time offset (milliseconds) of next PCM sample to be read */
ogg_int64_t ov_time_tell(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
1446
  int link=0;
Monty's avatar
 
Monty committed
1447
  ogg_int64_t pcm_total=0;
Monty's avatar
   
Monty committed
1448
  ogg_int64_t time_total=0;
Monty's avatar
 
Monty committed
1449
1450
1451
1452
1453
1454
1455
1456
  
  if(vf->ready_state<OPENED)return(OV_EINVAL);
  if(vf->seekable){
    pcm_total=ov_pcm_total(vf,-1);
    time_total=ov_time_total(vf,-1);
  
    /* which bitstream section does this time offset occur in? */
    for(link=vf->links-1;link>=0;link--){
Monty's avatar
   
Monty committed
1457
      pcm_total-=vf->pcmlengths[link*2+1];
Monty's avatar
 
Monty committed
1458
1459
1460
1461
1462
      time_total-=ov_time_total(vf,link);
      if(vf->pcm_offset>=pcm_total)break;
    }
  }

Monty's avatar
   
Monty committed
1463
  return(time_total+(1000*vf->pcm_offset-pcm_total)/vf->vi[link].rate);
Monty's avatar
 
Monty committed
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
}

/*  link:   -1) return the vorbis_info struct for the bitstream section
                currently being decoded
           0-n) to request information for a specific bitstream section
    
    In the case of a non-seekable bitstream, any call returns the
    current bitstream.  NULL in the case that the machine is not
    initialized */

vorbis_info *ov_info(OggVorbis_File *vf,int link){
  if(vf->seekable){
    if(link<0)
      if(vf->ready_state>=STREAMSET)
	return vf->vi+vf->current_link;
      else
      return vf->vi;
    else
      if(link>=vf->links)
	return NULL;
      else
	return vf->vi+link;
  }else{
    return vf->vi;
  }
}

/* grr, strong typing, grr, no templates/inheritence, grr */
vorbis_comment *ov_comment(OggVorbis_File *vf,int link){
  if(vf->seekable){
    if(link<0)
      if(vf->ready_state>=STREAMSET)
	return vf->vc+vf->current_link;
      else
	return vf->vc;
    else
      if(link>=vf->links)
	return NULL;
      else
	return vf->vc+link;
  }else{
    return vf->vc;
  }
}

/* up to this point, everything could more or less hide the multiple
   logical bitstream nature of chaining from the toplevel application
   if the toplevel application didn't particularly care.  However, at
   the point that we actually read audio back, the multiple-section
   nature must surface: Multiple bitstream sections do not necessarily
   have to have the same number of channels or sampling rate.

   ov_read returns the sequential logical bitstream number currently
   being decoded along with the PCM data in order that the toplevel
   application can take action on channel/sample rate changes.  This
   number will be incremented even for streamed (non-seekable) streams
   (for seekable streams, it represents the actual logical bitstream
   index within the physical bitstream.  Note that the accessor
   functions above are aware of this dichotomy).

   input values: buffer) a buffer to hold packed PCM data for return
		 length) the byte length requested to be placed into buffer

   return values: <0) error/hole in data (OV_HOLE), partial open (OV_EINVAL)
                   0) EOF
		   n) number of bytes of PCM actually returned.  The
		   below works on a packet-by-packet basis, so the
		   return length is not related to the 'length' passed
		   in, just guaranteed to fit.

	    *section) set to the logical bitstream number */

long ov_read(OggVorbis_File *vf,char *buffer,int bytes_req,int *bitstream){
  int i,j;

  ogg_int32_t **pcm;
  long samples;

  if(vf->ready_state<OPENED)return(OV_EINVAL);

  while(1){
Monty's avatar
   
Monty committed
1545
    if(vf->ready_state==INITSET){
Monty's avatar
 
Monty committed
1546
1547
1548
1549
1550
1551
      samples=vorbis_synthesis_pcmout(&vf->vd,&pcm);
      if(samples)break;
    }

    /* suck in another packet */
    {
Monty's avatar
   
Monty committed
1552
1553
1554
1555
1556
      int ret=_fetch_and_process_packet(vf,1,1);
      if(ret==OV_EOF)
	return(0);
      if(ret<=0)
	return(ret);
Monty's avatar
 
Monty committed
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
    }

  }

  if(samples>0){
  
    /* yay! proceed to pack data into the byte buffer */
    
    long channels=ov_info(vf,-1)->channels;

1567
1568
    if(samples>(bytes_req/(2*channels)))
      samples=bytes_req/(2*channels);      
Monty's avatar
 
Monty committed
1569
1570
1571
1572
1573
    
    for(i=0;i<channels;i++) { /* It's faster in this order */
      ogg_int32_t *src=pcm[i];
      short *dest=((short *)buffer)+i;
      for(j=0;j<samples;j++) {
Monty's avatar
   
Monty committed
1574
1575
        *dest=CLIP_TO_15(src[j]>>9);
        dest+=channels;
Monty's avatar
 
Monty committed
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
      }
    }
    
    vorbis_synthesis_read(&vf->vd,samples);
    vf->pcm_offset+=samples;
    if(bitstream)*bitstream=vf->current_link;
    return(samples*2*channels);
  }else{
    return(samples);
  }
}