vorbisfile.c 35.3 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
Ralph Giles's avatar
   
Ralph Giles committed
14
 last mod: $Id: vorbisfile.c,v 1.42 2001/03/20 07:39:07 giles Exp $
Monty's avatar
   
Monty committed
15
16
17

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

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

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

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

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

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

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

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

Monty's avatar
   
Monty committed
53
54
55
56
57
58
59
60
61
/*************************************************************************
 * 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 */

/* read a little more data from the file/pipe into the ogg_sync framer */
#define CHUNKSIZE 4096
static long _get_data(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
62
63
64
65
66
67
68
69
70
  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
71
72
73
74
}

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

/* 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
95
   return:   <0) did not find a page (OV_FALSE, OV_EOF, OV_EREAD)
Monty's avatar
   
Monty committed
96
97
98
99
100
101
102
              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
103
    if(boundary>0 && vf->offset>=boundary)return(OV_FALSE);
Monty's avatar
   
Monty committed
104
105
106
107
108
109
110
111
    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
112
113
114
115
116
117
	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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
      }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
134
/* returns offset or OV_EREAD, OV_FAULT */
Monty's avatar
   
Monty committed
135
136
137
138
139
140
141
142
143
144
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
145
146
      if(ret==OV_EREAD)return(OV_EREAD);
      if(ret<0){
Monty's avatar
   
Monty committed
147
148
149
150
151
152
153
154
155
156
	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
157
  if(ret<0)
Monty's avatar
   
Monty committed
158
    /* this shouldn't be possible */
Monty's avatar
   
Monty committed
159
160
    return(OV_EFAULT);

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

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

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

Monty's avatar
   
Monty committed
266
267
 bail_header:
  vorbis_info_clear(vi);
Monty's avatar
   
Monty committed
268
  vorbis_comment_clear(vc);
Monty's avatar
   
Monty committed
269
  ogg_stream_clear(&vf->os);
Monty's avatar
   
Monty committed
270
  return ret;
Monty's avatar
   
Monty committed
271
}
Monty's avatar
   
Monty committed
272

Monty's avatar
   
Monty committed
273
274
275
276
/* 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
277
278
279
280
281

/* 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
282
283
static void _prefetch_all_headers(OggVorbis_File *vf,vorbis_info *first_i,
				  vorbis_comment *first_c,
Monty's avatar
   
Monty committed
284
				  long dataoffset){
Monty's avatar
   
Monty committed
285
286
287
  ogg_page og;
  int i,ret;
  
Monty's avatar
   
Monty committed
288
289
290
291
292
  vf->vi=_ogg_calloc(vf->links,sizeof(vorbis_info));
  vf->vc=_ogg_calloc(vf->links,sizeof(vorbis_info));
  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
293
294
  
  for(i=0;i<vf->links;i++){
Monty's avatar
   
Monty committed
295
    if(first_i && first_c && i==0){
Monty's avatar
   
Monty committed
296
297
      /* we already grabbed the initial header earlier.  This just
         saves the waste of grabbing it again */
Monty's avatar
   
Monty committed
298
299
      memcpy(vf->vi+i,first_i,sizeof(vorbis_info));
      memcpy(vf->vc+i,first_c,sizeof(vorbis_comment));
Monty's avatar
   
Monty committed
300
      vf->dataoffsets[i]=dataoffset;
Monty's avatar
   
Monty committed
301
    }else{
Monty's avatar
   
Monty committed
302

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

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

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

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

Monty's avatar
   
Monty committed
338
339
static void _make_decode_ready(OggVorbis_File *vf){
  if(vf->decode_ready)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
346
  vorbis_block_init(&vf->vd,&vf->vb);
  vf->decode_ready=1;
Monty's avatar
   
Monty committed
347
  return;
Monty's avatar
   
Monty committed
348
349
}

Monty's avatar
   
Monty committed
350
static int _open_seekable(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
351
352
  vorbis_info initial_i;
  vorbis_comment initial_c;
Monty's avatar
   
Monty committed
353
354
  long serialno,end;
  int ret;
Monty's avatar
   
Monty committed
355
  long dataoffset;
Monty's avatar
   
Monty committed
356
357
358
  ogg_page og;
  
  /* is this even vorbis...? */
Monty's avatar
   
Monty committed
359
  ret=_fetch_headers(vf,&initial_i,&initial_c,&serialno,NULL);
Monty's avatar
   
Monty committed
360
  dataoffset=vf->offset;
Monty's avatar
   
Monty committed
361
  ogg_stream_clear(&vf->os);
Monty's avatar
   
Monty committed
362
  if(ret<0)return(ret);
Monty's avatar
   
Monty committed
363
364
365
  
  /* we can seek, so set out learning all about this file */
  vf->seekable=1;
Michael Smith's avatar
   
Michael Smith committed
366
367
  (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
  vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
Monty's avatar
   
Monty committed
368
369
370
371
  
  /* 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
372
373
374
375
  if(end<0){
    ogg_stream_clear(&vf->os);
    return(end);
  }
Monty's avatar
   
Monty committed
376

Monty's avatar
   
Monty committed
377
  /* more than one logical bitstream? */
Monty's avatar
   
Monty committed
378
  if(ogg_page_serialno(&og)!=serialno){
Monty's avatar
   
Monty committed
379

Monty's avatar
   
Monty committed
380
381
    /* Chained bitstream. Bisect-search each logical bitstream
       section.  Do so based on serial number only */
Monty's avatar
   
Monty committed
382
383
384
385
    if(_bisect_forward_serialno(vf,0,0,end+1,serialno,0)<0){
      ogg_stream_clear(&vf->os);
      return(OV_EREAD);
    }
Monty's avatar
   
Monty committed
386

Monty's avatar
   
Monty committed
387
388
389
  }else{

    /* Only one logical bitstream */
Monty's avatar
   
Monty committed
390
391
392
393
    if(_bisect_forward_serialno(vf,0,end,end+1,serialno,0)){
      ogg_stream_clear(&vf->os);
      return(OV_EREAD);
    }
Monty's avatar
   
Monty committed
394
395
396

  }

Monty's avatar
   
Monty committed
397
  _prefetch_all_headers(vf,&initial_i,&initial_c,dataoffset);
Monty's avatar
   
Monty committed
398
  return(ov_raw_seek(vf,0));
Monty's avatar
   
Monty committed
399
400
401
402

}

static int _open_nonseekable(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
403
  int ret;
Monty's avatar
   
Monty committed
404
405
  /* we cannot seek. Set up a 'single' (current) logical bitstream entry  */
  vf->links=1;
Monty's avatar
   
Monty committed
406
407
  vf->vi=_ogg_calloc(vf->links,sizeof(vorbis_info));
  vf->vc=_ogg_calloc(vf->links,sizeof(vorbis_info));
Monty's avatar
   
Monty committed
408
409

  /* Try to fetch the headers, maintaining all the storage */
Monty's avatar
   
Monty committed
410
411
  if((ret=_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,NULL))<0)
    return(ret);
Monty's avatar
   
Monty committed
412
413
  _make_decode_ready(vf);

Monty's avatar
   
Monty committed
414
415
  return 0;
}
Monty's avatar
   
Monty committed
416
417
418
419
420
421
422

/* 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);
  vf->decode_ready=0;
Monty's avatar
   
Monty committed
423

Monty's avatar
   
Monty committed
424
425
  vf->bittrack=0.f;
  vf->samptrack=0.f;
Monty's avatar
   
Monty committed
426
427
428
429
430
431
432
433
}

/* 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
434
435
   return: <0) error, OV_HOLE (lost packet) or OV_EOF
            0) need more data (only if readp==0)
Monty's avatar
   
Monty committed
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
	    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 */
    if(vf->decode_ready){
      ogg_packet op;
      int result=ogg_stream_packetout(&vf->os,&op);
Monty's avatar
   
Monty committed
451
      ogg_int64_t granulepos;
Monty's avatar
   
Monty committed
452
      
Monty's avatar
   
Monty committed
453
      if(result==-1)return(OV_HOLE); /* hole in the data. */
Monty's avatar
   
Monty committed
454
455
      if(result>0){
	/* got a packet.  process it */
Monty's avatar
   
Monty committed
456
	granulepos=op.granulepos;
Monty's avatar
   
Monty committed
457
458
459
460
461
462
463
	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
464
465
466
467
468
469
470
471

	  /* 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
472
	  
Monty's avatar
   
Monty committed
473
	  /* update the pcm offset. */
Monty's avatar
   
Monty committed
474
	  if(granulepos!=-1 && !op.e_o_s){
Monty's avatar
   
Monty committed
475
476
477
478
479
480
	    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
481
482
483
484
	       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
485
	       granulepos declares the last frame in the stream, and the
Monty's avatar
   
Monty committed
486
	       last packet of the last page may be a partial frame.
Monty's avatar
   
Monty committed
487
	       So, we need a previous granulepos from an in-sequence page
Monty's avatar
   
Monty committed
488
489
	       to have a reference point.  Thus the !op.e_o_s clause
	       above */
Monty's avatar
   
Monty committed
490
	    
Monty's avatar
   
Monty committed
491
	    samples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
   
Monty committed
492
	    
Monty's avatar
   
Monty committed
493
	    granulepos-=samples;
Monty's avatar
   
Monty committed
494
	    for(i=0;i<link;i++)
Monty's avatar
   
Monty committed
495
496
	      granulepos+=vf->pcmlengths[i];
	    vf->pcm_offset=granulepos;
Monty's avatar
   
Monty committed
497
498
	  }
	  return(1);
Monty's avatar
   
Monty committed
499
500
501
502
503
	}
      }
    }

    if(!readp)return(0);
Monty's avatar
   
Monty committed
504
    if(_get_next_page(vf,&og,-1)<0)return(OV_EOF); /* eof. leave unitialized */
Monty's avatar
   
Monty committed
505

Monty's avatar
   
Monty committed
506
507
508
509
    /* bitrate tracking; add the header's bytes here, the body bytes
       are done by packet above */
    vf->bittrack+=og.header_len*8;

Monty's avatar
   
Monty committed
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
    /* has our decoding just traversed a bitstream boundary? */
    if(vf->decode_ready){
      if(vf->current_serialno!=ogg_page_serialno(&og)){
	_decode_clear(vf);
      }
    }

    /* 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->decode_ready){
      int link;
      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
539
540
541
542
	if(link==vf->links)return(OV_EBADLINK); /* sign of a bogus
						   stream.  error out,
						   leave machine
						   uninitialized */
Monty's avatar
   
Monty committed
543
544
	
	vf->current_link=link;
Monty's avatar
   
Monty committed
545
	
Monty's avatar
   
Monty committed
546
	ogg_stream_init(&vf->os,vf->current_serialno);
Monty's avatar
   
Monty committed
547
	ogg_stream_reset(&vf->os); 
Monty's avatar
   
Monty committed
548
	
Monty's avatar
   
Monty committed
549
550
551
552
      }else{
	/* we're streaming */
	/* fetch the three header packets, build the info struct */
	
Monty's avatar
   
Monty committed
553
	_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,&og);
Monty's avatar
   
Monty committed
554
555
556
557
	vf->current_link++;
	link=0;
      }
      
Monty's avatar
   
Monty committed
558
      _make_decode_ready(vf);
Monty's avatar
   
Monty committed
559
560
561
562
563
    }
    ogg_stream_pagein(&vf->os,&og);
  }
}

Monty's avatar
   
Monty committed
564
565
566
567
568
569
570
571
572
573
574
575
/**********************************************************************
 * The helpers are over; it's all toplevel interface from here on out */
 
/* 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
576
      for(i=0;i<vf->links;i++){
Monty's avatar
   
Monty committed
577
	vorbis_info_clear(vf->vi+i);
Monty's avatar
   
Monty committed
578
579
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
   
Monty committed
580
581
      _ogg_free(vf->vi);
      _ogg_free(vf->vc);
Monty's avatar
   
Monty committed
582
    }
Monty's avatar
   
Monty committed
583
584
585
586
    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
587
    ogg_sync_clear(&vf->oy);
Michael Smith's avatar
   
Michael Smith committed
588
    if(vf->datasource)(vf->callbacks.close_func)(vf->datasource);
Monty's avatar
   
Monty committed
589
590
    memset(vf,0,sizeof(OggVorbis_File));
  }
Monty's avatar
   
Monty committed
591
#ifdef DEBUG_LEAKS
Monty's avatar
   
Monty committed
592
  _VDBG_dump();
Monty's avatar
   
Monty committed
593
#endif
Monty's avatar
   
Monty committed
594
  return(0);
Monty's avatar
   
Monty committed
595
}
Monty's avatar
   
Monty committed
596

Monty's avatar
   
Monty committed
597
static int _fseek64_wrap(FILE *f,ogg_int64_t off,int whence){
Monty's avatar
   
Monty committed
598
  if(f==NULL)return(-1);
Monty's avatar
   
Monty committed
599
600
601
  return fseek(f,(int)off,whence);
}

Monty's avatar
   
Monty committed
602
603
/* 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
604
605
606
607
608
609
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
   
Monty committed
610
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Michael Smith's avatar
   
Michael Smith committed
611
  ov_callbacks callbacks = {
Michael Smith's avatar
   
Michael Smith committed
612
    (size_t (*)(void *, size_t, size_t, void *))  fread,
Monty's avatar
   
Monty committed
613
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
Michael Smith's avatar
   
Michael Smith committed
614
615
616
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Michael Smith's avatar
   
Michael Smith committed
617
618
619
620
621
622
623
624

  return ov_open_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
  

int ov_open_callbacks(void *f,OggVorbis_File *vf,char *initial,long ibytes,
    ov_callbacks callbacks)
{
Monty's avatar
   
Monty committed
625
  long offset=(f?callbacks.seek_func(f,0,SEEK_CUR):-1);
Monty's avatar
   
Monty committed
626
627
628
  int ret;

  memset(vf,0,sizeof(OggVorbis_File));
Michael Smith's avatar
   
Michael Smith committed
629
630
  vf->datasource=f;
  vf->callbacks = callbacks;
Monty's avatar
   
Monty committed
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651

  /* 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){
    ret=_open_seekable(vf);
  }else{
    ret=_open_nonseekable(vf);
  }
  if(ret){
Michael Smith's avatar
   
Michael Smith committed
652
    vf->datasource=NULL;
Monty's avatar
   
Monty committed
653
654
655
656
657
    ov_clear(vf);
  }
  return(ret);
}

Monty's avatar
   
Monty committed
658
/* How many logical bitstreams in this physical bitstream? */
Monty's avatar
   
Monty committed
659
660
long ov_streams(OggVorbis_File *vf){
  return vf->links;
Monty's avatar
   
Monty committed
661
662
}

Monty's avatar
   
Monty committed
663
/* Is the FILE * associated with vf seekable? */
Monty's avatar
   
Monty committed
664
665
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
Monty's avatar
   
Monty committed
666
667
}

Monty's avatar
   
Monty committed
668
669
670
671
672
673
674
675
676
677
/* 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
678
  if(i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
679
  if(!vf->seekable && i!=0)return(ov_bitrate(vf,0));
Monty's avatar
   
Monty committed
680
  if(i<0){
Monty's avatar
   
Monty committed
681
    ogg_int64_t bits=0;
Monty's avatar
   
Monty committed
682
683
    int i;
    for(i=0;i<vf->links;i++)
Monty's avatar
   
Monty committed
684
      bits+=(vf->offsets[i+1]-vf->dataoffsets[i])*8;
Monty's avatar
   
Monty committed
685
686
687
688
    return(rint(bits/ov_time_total(vf,-1)));
  }else{
    if(vf->seekable){
      /* return the actual bitrate */
Monty's avatar
   
Monty committed
689
      return(rint((vf->offsets[i+1]-vf->dataoffsets[i])*8/ov_time_total(vf,i)));
Monty's avatar
   
Monty committed
690
691
692
693
694
695
696
697
698
699
700
701
    }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
702
	return(OV_FALSE);
Monty's avatar
   
Monty committed
703
704
705
706
707
      }
    }
  }
}

Monty's avatar
   
Monty committed
708
709
710
711
712
/* returns the actual bitrate since last call.  returns -1 if no
   additional data to offer since last call (or at beginning of stream) */
long ov_bitrate_instant(OggVorbis_File *vf){
  int link=(vf->seekable?vf->current_link:0);
  long ret;
Monty's avatar
   
Monty committed
713
  if(vf->samptrack==0)return(OV_FALSE);
Monty's avatar
   
Monty committed
714
  ret=vf->bittrack/vf->samptrack*vf->vi[link].rate+.5;
Monty's avatar
   
Monty committed
715
716
  vf->bittrack=0.f;
  vf->samptrack=0.f;
Monty's avatar
   
Monty committed
717
718
719
  return(ret);
}

Monty's avatar
   
Monty committed
720
721
/* Guess */
long ov_serialnumber(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
722
  if(i>=vf->links)return(ov_serialnumber(vf,vf->links-1));
Monty's avatar
   
Monty committed
723
724
725
726
727
728
729
730
  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
731
732
733
734
/* returns: total raw (compressed) length of content if i==-1
            raw (compressed) length of that logical bitstream for i==0 to n
	    -1 if the stream is not seekable (we can't know the length)
*/
Monty's avatar
   
Monty committed
735
ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
736
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
737
  if(i<0){
Monty's avatar
   
Monty committed
738
739
740
741
742
743
744
745
746
    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
747

Monty's avatar
   
Monty committed
748
749
750
751
/* returns: total PCM length (samples) of content if i==-1
            PCM length (samples) of that logical bitstream for i==0 to n
	    -1 if the stream is not seekable (we can't know the length)
*/
Monty's avatar
   
Monty committed
752
ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
753
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
754
  if(i<0){
Monty's avatar
   
Monty committed
755
    ogg_int64_t acc=0;
Monty's avatar
   
Monty committed
756
757
758
759
760
761
762
763
    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
764

Monty's avatar
   
Monty committed
765
766
767
768
/* returns: total seconds of content if i==-1
            seconds in that logical bitstream for i==0 to n
	    -1 if the stream is not seekable (we can't know the length)
*/
Monty's avatar
   
Monty committed
769
double ov_time_total(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
770
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
771
  if(i<0){
Monty's avatar
   
Monty committed
772
773
774
775
776
777
778
779
780
    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
781

Monty's avatar
   
Monty committed
782
783
784
785
/* seek to an offset relative to the *compressed* data. This also
   immediately sucks in and decodes pages 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
Monty's avatar
   
Monty committed
786
787
788
   surprises). 

   returns zero on success, nonzero on failure */
Monty's avatar
   
Monty committed
789
790

int ov_raw_seek(OggVorbis_File *vf,long pos){
Monty's avatar
   
Monty committed
791
792
793
  int flag=0;
  if(!vf->seekable)return(OV_ENOSEEK); /* don't dump machine if we can't seek */
  if(pos<0 || pos>vf->offsets[vf->links])return(OV_EINVAL);
Monty's avatar
   
Monty committed
794
795

  /* clear out decoding machine state */
Monty's avatar
   
Monty committed
796
  vf->pcm_offset=-1;
Monty's avatar
   
Monty committed
797
  _decode_clear(vf);
Monty's avatar
   
Monty committed
798
  
Monty's avatar
   
Monty committed
799
800
801
802
803
804
  /* seek */
  _seek_helper(vf,pos);

  /* we need to make sure the pcm_offset is set.  We use the
     _fetch_packet helper to process one packet with readp set, then
     call it until it returns '0' with readp not set (the last packet
Monty's avatar
   
Monty committed
805
     from a page has the 'granulepos' field set, and that's how the
Monty's avatar
   
Monty committed
806
807
     helper updates the offset */

Monty's avatar
   
Monty committed
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
  while(!flag){
    switch(_process_packet(vf,1)){
    case 0:case OV_EOF:
      /* oh, eof. There are no packets remaining.  Set the pcm offset to
	 the end of file */
      vf->pcm_offset=ov_pcm_total(vf,-1);
      return(0);
    case OV_HOLE:
      break;
    case OV_EBADLINK:
      goto seek_error;
    default:
      /* all OK */
      flag=1;
      break;
    }
Monty's avatar
   
Monty committed
824
  }
Monty's avatar
   
Monty committed
825
  
Monty's avatar
   
Monty committed
826
  while(1){
Monty's avatar
   
Monty committed
827
828
    /* don't have to check each time through for the updated granule;
       it's always the last complete packet on a page */
Monty's avatar
   
Monty committed
829
    switch(_process_packet(vf,0)){
Monty's avatar
   
Monty committed
830
831
832
    case 0:case OV_EOF:
      /* the offset is set unless it's a bogus bitstream with no
         offset information but that's not our fault.  We still run
Monty's avatar
   
Monty committed
833
834
         gracefully, we're just missing the offset */
      return(0);
Monty's avatar
   
Monty committed
835
    case OV_EBADLINK:
Monty's avatar
   
Monty committed
836
837
838
839
840
841
842
843
844
      goto seek_error;
    default:
      /* continue processing packets */
      break;
    }
  }
  
 seek_error:
  /* dump the machine so we're in a known state */
Monty's avatar
   
Monty committed
845
  vf->pcm_offset=-1;
Monty's avatar
   
Monty committed
846
  _decode_clear(vf);
Monty's avatar
   
Monty committed
847
  return OV_EBADLINK;
Monty's avatar
   
Monty committed
848
849
}

Monty's avatar
   
Monty committed
850
851
/* 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
852

Monty's avatar
   
Monty committed
853
854
855
856
   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
857
  int link=-1;
Monty's avatar
   
Monty committed
858
  long ret;
Monty's avatar
   
Monty committed
859
  ogg_int64_t total=ov_pcm_total(vf,-1);
Monty's avatar
   
Monty committed
860

Monty's avatar
   
Monty committed
861
862
  if(!vf->seekable)return(OV_ENOSEEK);
  if(pos<0 || pos>total)return(OV_EINVAL);
Monty's avatar
   
Monty committed
863
864
865
866
867
868
869

  /* 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
870
  /* search within the logical bitstream for the page with the highest
Monty's avatar
   
Monty committed
871
872
873
874
875
     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
876
    ogg_int64_t target=pos-total;
Monty's avatar
   
Monty committed
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
    long end=vf->offsets[link+1];
    long begin=vf->offsets[link];
    long best=begin;

    ogg_page og;
    while(begin<end){
      long bisect;
    
      if(end-begin<CHUNKSIZE){
	bisect=begin;
      }else{
	bisect=(end+begin)/2;
      }
    
      _seek_helper(vf,bisect);
Monty's avatar
   
Monty committed
892
      ret=_get_next_page(vf,&og,end-bisect);
Monty's avatar
   
Monty committed
893
894
      switch(ret){
      case OV_FALSE: case OV_EOF:
Monty's avatar
   
Monty committed
895
	end=bisect;
Monty's avatar
   
Monty committed
896
897
898
899
900
901
902
903
904
905
906
907
	break;
      case OV_EREAD:
	goto seek_error;
      default:
	{
	  ogg_int64_t granulepos=ogg_page_granulepos(&og);
	  if(granulepos<target){
	    best=ret;  /* raw offset of packet with granulepos */ 
	    begin=vf->offset; /* raw offset of next packet */
	  }else{
	    end=bisect;
	  }
Monty's avatar
   
Monty committed
908
909
910
	}
      }
    }
Monty's avatar
   
Monty committed
911

Monty's avatar
   
Monty committed
912
913
    /* found our page. seek to it (call raw_seek). */
    
Monty's avatar
   
Monty committed
914
    if((ret=ov_raw_seek(vf,best)))goto seek_error;
Monty's avatar
   
Monty committed
915
  }
916
  
Monty's avatar
   
Monty committed
917
  /* verify result */
Monty's avatar
   
Monty committed
918
919
920
921
  if(vf->pcm_offset>=pos || pos>ov_pcm_total(vf,-1)){
    ret=OV_EFAULT;
    goto seek_error;
  }
Monty's avatar
   
Monty committed
922
  return(0);
Monty's avatar
   
Monty committed
923
  
Monty's avatar
   
Monty committed
924
925
926
927
 seek_error:
  /* dump machine so we're in a known state */
  vf->pcm_offset=-1;
  _decode_clear(vf);
Monty's avatar
   
Monty committed
928
  return ret;
Monty's avatar
   
Monty committed
929
930
931
932
933
934
}

/* 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
935
936
937
  int ret=ov_pcm_seek_page(vf,pos);
  if(ret<0)return(ret);
  
Monty's avatar
   
Monty committed
938
939
940
  /* 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
941
    float **pcm;
Monty's avatar
   
Monty committed
942
943
    long target=pos-vf->pcm_offset;
    long samples=vorbis_synthesis_pcmout(&vf->vd,&pcm);
Monty's avatar
   
Monty committed
944

Monty's avatar
   
Monty committed
945
946
947
948
949
950
951
952
953
    if(samples>target)samples=target;
    vorbis_synthesis_read(&vf->vd,samples);
    vf->pcm_offset+=samples;
    
    if(samples<target)
      if(_process_packet(vf,1)==0)
	vf->pcm_offset=ov_pcm_total(vf,-1); /* eof */
  }
  return 0;
Monty's avatar
   
Monty committed
954
955
956
957
958
959
960
961
962
963
964
}

/* 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,double seconds){
  /* translate time to PCM position and call ov_pcm_seek */

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

Monty's avatar
   
Monty committed
965
966
  if(!vf->seekable)return(OV_ENOSEEK);
  if(seconds<0 || seconds>time_total)return(OV_EINVAL);
Monty's avatar
   
Monty committed
967
  
Monty's avatar
   
Monty committed
968
969
970
971
972
973
974
975
976
977
978
979
  /* which bitstream section does this time offset occur in? */
  for(link=vf->links-1;link>=0;link--){
    pcm_total-=vf->pcmlengths[link];
    time_total-=ov_time_total(vf,link);
    if(seconds>=time_total)break;
  }

  /* enough information to convert time offset to pcm offset */
  {
    ogg_int64_t target=pcm_total+(seconds-time_total)*vf->vi[link].rate;
    return(ov_pcm_seek(vf,target));
  }
Monty's avatar
   
Monty committed
980
}
Monty's avatar
   
Monty committed
981

Monty's avatar
   
Monty committed
982
/* page-granularity version of ov_time_seek 
Monty's avatar
   
Monty committed
983
   returns zero on success, nonzero on failure */
Monty's avatar
   
Monty committed
984
int ov_time_seek_page(OggVorbis_File *vf,double seconds){
Monty's avatar
   
Monty committed
985
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
   
Monty committed
986

Monty's avatar
   
Monty committed
987
  int link=-1;
Monty's avatar
   
Monty committed
988
  ogg_int64_t pcm_total=ov_pcm_total(vf,-1);
Monty's avatar
   
Monty committed
989
  double time_total=ov_time_total(vf,-1);
Monty's avatar
   
Monty committed
990

Monty's avatar
   
Monty committed
991
992
  if(!vf->seekable)return(OV_ENOSEEK);
  if(seconds<0 || seconds>time_total)return(OV_EINVAL);
Monty's avatar
   
Monty committed
993
994
995
996
997
998
999
1000
1001
1002
  
  /* which bitstream section does this time offset occur in? */
  for(link=vf->links-1;link>=0;link--){
    pcm_total-=vf->pcmlengths[link];
    time_total-=ov_time_total(vf,link);
    if(seconds>=time_total)break;
  }

  /* enough information to convert time offset to pcm offset */
  {
Monty's avatar
   
Monty committed
1003
    ogg_int64_t target=pcm_total+(seconds-time_total)*vf->vi[link].rate;
Monty's avatar
   
Monty committed
1004
    return(ov_pcm_seek_page(vf,target));
Monty's avatar
   
Monty committed
1005
1006
1007
1008
1009
  }
}

/* tell the current stream offset cursor.  Note that seek followed by
   tell will likely not give the set offset due to caching */
Monty's avatar
   
Monty committed
1010
ogg_int64_t ov_raw_tell(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
1011
  return(vf->offset);
Monty's avatar
   
Monty committed
1012
1013
}

Monty's avatar
   
Monty committed
1014
/* return PCM offset (sample) of next PCM sample to be read */
Monty's avatar
   
Monty committed
1015
ogg_int64_t ov_pcm_tell(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
1016
1017
  return(vf->pcm_offset);
}
Monty's avatar
   
Monty committed
1018

Monty's avatar
   
Monty committed
1019
/* return time offset (seconds) of next PCM sample to be read */
Monty's avatar
   
Monty committed
1020
1021
double ov_time_tell(OggVorbis_File *vf){
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
   
Monty committed
1022

Monty's avatar
   
Monty committed
1023
  int link=-1;
Monty's avatar
   
Monty committed
1024
  ogg_int64_t pcm_total=0;
Monty's avatar
   
Monty committed
1025
  double time_total=0.f;
Monty's avatar
   
Monty committed
1026
1027
1028
1029
1030
1031
1032
1033
1034
  
  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--){
      pcm_total-=vf->pcmlengths[link];
      time_total-=ov_time_total(vf,link);
Monty's avatar
   
Monty committed
1035
      if(vf->pcm_offset>=pcm_total)break;
Monty's avatar
   
Monty committed
1036
1037
    }
  }
Monty's avatar
   
Monty committed
1038

Monty's avatar
   
Monty committed
1039
  return((double)time_total+(double)(vf->pcm_offset-pcm_total)/vf->vi[link].rate);
Monty's avatar
   
Monty committed
1040
1041
}

Monty's avatar
   
Monty committed
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
/*  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->decode_ready)
	return vf->vi+vf->current_link;
      else
	return NULL;
    else
      if(link>=vf->links)
	return NULL;
      else
	return vf->vi+link;
  }else{
    if(vf->decode_ready)
      return vf->vi;
    else
      return NULL;
Monty's avatar
   
Monty committed
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
  }
}

/* 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->decode_ready)
	return vf->vc+vf->current_link;
      else
	return NULL;
    else
      if(link>=vf->links)
	return NULL;
      else
	return vf->vc+link;
  }else{
    if(vf->decode_ready)
      return vf->vc;
    else
      return NULL;
Monty's avatar
   
Monty committed
1088
1089
  }
}
Monty's avatar
   
Monty committed
1090

1091
int host_is_big_endian() {
Monty's avatar
   
Monty committed
1092
  ogg_int32_t pattern = 0xfeedface; /* deadbeef */
1093
  unsigned char *bytewise = (unsigned char *)&pattern;
Monty's avatar
   
Monty committed
1094
  if (bytewise[0] == 0xfe) return 1;
1095
1096
1097
  return 0;
}

Monty's avatar
   
Monty committed
1098
1099
1100
1101
1102
1103
1104
1105
1106
/* 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
Ralph Giles's avatar
   
Ralph Giles committed
1107
   application can take action on channel/sample rate changes.
Monty's avatar
   
Monty committed
1108
1109
1110
1111
1112
1113
1114
1115

   input values: buffer) a buffer to hold packed PCM data for return
		 length) the byte length requested to be placed into buffer
		 bigendianp) should the data be packed LSB first (0) or
		             MSB first (1)
		 word) word size for output.  currently 1 (byte) or 
		       2 (16 bit short)

Monty's avatar
   
Monty committed
1116
   return values: <0) error/hole in data (OV_HOLE)
Monty's avatar
   
Monty committed
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
                   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 length,
		    int bigendianp,int word,int sgned,int *bitstream){
  int i,j;
1128
  int host_endian = host_is_big_endian();
Monty's avatar
   
Monty committed
1129
1130
1131

  while(1){
    if(vf->decode_ready){
Monty's avatar
   
Monty committed
1132
      float **pcm;
Monty's avatar
   
Monty committed
1133
1134
1135
1136
1137
1138
      long samples=vorbis_synthesis_pcmout(&vf->vd,&pcm);
      if(samples){
	/* yay! proceed to pack data into the byte buffer */

	long channels=ov_info(vf,-1)->channels;
	long bytespersample=word * channels;
Monty's avatar
   
Monty committed
1139
	vorbis_fpu_control fpu;
Monty's avatar
   
Monty committed
1140
1141
1142
1143
	if(samples>length/bytespersample)samples=length/bytespersample;
	
	/* a tight loop to pack each size */
	{
Michael Smith's avatar
   
Michael Smith committed
1144
	  int val;
Monty's avatar
   
Monty committed
1145
1146
	  if(word==1){
	    int off=(sgned?0:128);
Monty's avatar
   
Monty committed
1147
	    vorbis_fpu_setround(&fpu);
Monty's avatar
   
Monty committed
1148
1149
	    for(j=0;j<samples;j++)
	      for(i=0;i<channels;i++){
Monty's avatar
   
Monty committed
1150
		val=vorbis_ftoi(pcm[i][j]*128.f);
Monty's avatar
   
Monty committed
1151
		if(val>127)val=127;
Michael Smith's avatar
   
Michael Smith committed
1152
		else if(val<-128)val=-128;
Monty's avatar
   
Monty committed
1153
1154
		*buffer++=val+off;
	      }
Monty's avatar
   
Monty committed
1155
	    vorbis_fpu_restore(fpu);
Monty's avatar
   
Monty committed
1156
1157
1158
	  }else{
	    int off=(sgned?0:32768);

1159
1160
	    if(host_endian==bigendianp){
	      if(sgned){
Monty's avatar
   
Monty committed
1161
1162

		vorbis_fpu_setround(&fpu);
1163
		for(i=0;i<channels;i++) { /* It's faster in this order */
Monty's avatar
   
Monty committed
1164
		  float *src=pcm[i];
1165
1166
		  short *dest=((short *)buffer)+i;
		  for(j=0;j<samples;j++) {
Monty's avatar
   
Monty committed
1167
		    val=vorbis_ftoi(src[j]*32768.f);
1168
1169
1170
1171
1172
1173
		    if(val>32767)val=32767;
		    else if(val<-32768)val=-32768;
		    *dest=val;
		    dest+=channels;
		  }
		}
Monty's avatar
   
Monty committed
1174
1175
		vorbis_fpu_restore(fpu);

1176
	      }else{
Monty's avatar
   
Monty committed
1177
1178

		vorbis_fpu_setround(&fpu);
1179
		for(i=0;i<channels;i++) {
Monty's avatar
   
Monty committed
1180
		  float *src=pcm[i];
1181
1182
		  short *dest=((short *)buffer)+i;
		  for(j=0;j<samples;j++) {
Monty's avatar
   
Monty committed
1183
		    val=vorbis_ftoi(src[j]*32768.f);
1184
1185
1186
1187
1188
1189
		    if(val>32767)val=32767;
		    else if(val<-32768)val=-32768;
		    *dest=val+off;
		    dest+=channels;
		  }
		}
Monty's avatar
   
Monty committed
1190
1191
		vorbis_fpu_restore(fpu);

1192
1193
	      }
	    }else if(bigendianp){
Monty's avatar
   
Monty committed
1194
1195

	      vorbis_fpu_setround(&fpu);
Monty's avatar
   
Monty committed
1196
1197
	      for(j=0;j<samples;j++)
		for(i=0;i<channels;i++){
Monty's avatar
   
Monty committed
1198
		  val=vorbis_ftoi(pcm[i][j]*32768.f);
Monty's avatar
   
Monty committed
1199
		  if(val>32767)val=32767;
Michael Smith's avatar