vorbisfile.c 35.4 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
 * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
Monty's avatar
   
Monty committed
5
6
 * THE GNU LESSER/LIBRARY PUBLIC LICENSE, WHICH IS INCLUDED WITH    *
 * THIS SOURCE. 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-2000             *
 * by Monty <monty@xiph.org> and the XIPHOPHORUS Company            *
Monty's avatar
   
Monty committed
10
11
12
13
 * http://www.xiph.org/                                             *
 *                                                                  *
 ********************************************************************

Monty's avatar
   
Monty committed
14
 function: stdio-based convenience library for opening/seeking/decoding
Monty's avatar
   
Monty committed
15
 last mod: $Id: vorbisfile.c,v 1.32 2000/11/14 00:05:32 xiphmont Exp $
Monty's avatar
   
Monty committed
16
17
18

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

Monty's avatar
   
Monty committed
19
#include <stdlib.h>
Monty's avatar
   
Monty committed
20
#include <stdio.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){
Michael Smith's avatar
   
Michael Smith committed
62
63
  char *buffer=ogg_sync_buffer(&vf->oy,CHUNKSIZE);
  long bytes=(vf->callbacks.read_func)(buffer,1,CHUNKSIZE,vf->datasource);
Monty's avatar
   
Monty committed
64
  if(bytes>0)ogg_sync_wrote(&vf->oy,bytes);
Monty's avatar
   
Monty committed
65
66
67
68
69
  return(bytes);
}

/* save a tiny smidge of verbosity to make the code more readable */
static void _seek_helper(OggVorbis_File *vf,long offset){
Michael Smith's avatar
   
Michael Smith committed
70
  (vf->callbacks.seek_func)(vf->datasource, offset, SEEK_SET);
Monty's avatar
   
Monty committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
  vf->offset=offset;
  ogg_sync_reset(&vf->oy);
}

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

Monty's avatar
   
Monty committed
151
152
153
154
155
156
157
  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
158
159
160
161
162
163
static int _bisect_forward_serialno(OggVorbis_File *vf,
				    long begin,
				    long searched,
				    long end,
				    long currentno,
				    long m){
Monty's avatar
   
Monty committed
164
165
166
  long endsearched=end;
  long next=end;
  ogg_page og;
Monty's avatar
   
Monty committed
167
  long ret;
Monty's avatar
   
Monty committed
168
  
Monty's avatar
   
Monty committed
169
170
171
172
173
174
175
176
177
178
179
180
181
  /* 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
182
    if(ret==OV_EREAD)return(OV_EREAD);
Monty's avatar
   
Monty committed
183
184
185
186
187
188
189
    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
190
191
192

  _seek_helper(vf,next);
  ret=_get_next_page(vf,&og,-1);
Monty's avatar
   
Monty committed
193
  if(ret==OV_EREAD)return(OV_EREAD);
Monty's avatar
   
Monty committed
194
  
Monty's avatar
   
Monty committed
195
  if(searched>=end || ret<0){
Monty's avatar
   
Monty committed
196
    vf->links=m+1;
Monty's avatar
   
Monty committed
197
    vf->offsets=_ogg_malloc((m+2)*sizeof(ogg_int64_t));
Monty's avatar
   
Monty committed
198
199
    vf->offsets[m+1]=searched;
  }else{
Monty's avatar
   
Monty committed
200
201
202
    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
203
204
205
  }
  
  vf->offsets[m]=begin;
Monty's avatar
   
Monty committed
206
  return(0);
Monty's avatar
   
Monty committed
207
}
Monty's avatar
   
Monty committed
208

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

Monty's avatar
   
Monty committed
256
257
 bail_header:
  vorbis_info_clear(vi);
Monty's avatar
   
Monty committed
258
  vorbis_comment_clear(vc);
Monty's avatar
   
Monty committed
259
  ogg_stream_clear(&vf->os);
Monty's avatar
   
Monty committed
260
  return ret;
Monty's avatar
   
Monty committed
261
}
Monty's avatar
   
Monty committed
262

Monty's avatar
   
Monty committed
263
264
265
266
/* 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
267
268
269
270
271

/* 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
272
273
static void _prefetch_all_headers(OggVorbis_File *vf,vorbis_info *first_i,
				  vorbis_comment *first_c,
Monty's avatar
   
Monty committed
274
				  long dataoffset){
Monty's avatar
   
Monty committed
275
276
277
  ogg_page og;
  int i,ret;
  
Monty's avatar
   
Monty committed
278
279
280
281
282
  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
283
284
  
  for(i=0;i<vf->links;i++){
Monty's avatar
   
Monty committed
285
    if(first_i && first_c && i==0){
Monty's avatar
   
Monty committed
286
287
      /* we already grabbed the initial header earlier.  This just
         saves the waste of grabbing it again */
Monty's avatar
   
Monty committed
288
289
      memcpy(vf->vi+i,first_i,sizeof(vorbis_info));
      memcpy(vf->vc+i,first_c,sizeof(vorbis_comment));
Monty's avatar
   
Monty committed
290
      vf->dataoffsets[i]=dataoffset;
Monty's avatar
   
Monty committed
291
    }else{
Monty's avatar
   
Monty committed
292

Monty's avatar
   
Monty committed
293
      /* seek to the location of the initial header */
Monty's avatar
   
Monty committed
294

Monty's avatar
   
Monty committed
295
      _seek_helper(vf,vf->offsets[i]);
Monty's avatar
   
Monty committed
296
      if(_fetch_headers(vf,vf->vi+i,vf->vc+i,NULL,NULL)<0){
Monty's avatar
   
Monty committed
297
298
    	vf->dataoffsets[i]=-1;
      }else{
Monty's avatar
   
Monty committed
299
	vf->dataoffsets[i]=vf->offset;
Monty's avatar
   
Monty committed
300
301
        ogg_stream_clear(&vf->os);
      }
Monty's avatar
   
Monty committed
302
    }
Monty's avatar
   
Monty committed
303

Monty's avatar
   
Monty committed
304
305
306
307
308
    /* 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
309

Monty's avatar
   
Monty committed
310
311
      while(1){
	ret=_get_prev_page(vf,&og);
Monty's avatar
   
Monty committed
312
313
	if(ret<0){
	  /* this should not be possible, actually */
Monty's avatar
   
Monty committed
314
	  vorbis_info_clear(vf->vi+i);
Monty's avatar
   
Monty committed
315
	  vorbis_comment_clear(vf->vc+i);
Monty's avatar
   
Monty committed
316
317
	  break;
	}
Monty's avatar
   
Monty committed
318
	if(ogg_page_granulepos(&og)!=-1){
Monty's avatar
   
Monty committed
319
	  vf->serialnos[i]=ogg_page_serialno(&og);
Monty's avatar
   
Monty committed
320
	  vf->pcmlengths[i]=ogg_page_granulepos(&og);
Monty's avatar
   
Monty committed
321
322
323
324
325
	  break;
	}
      }
    }
  }
Monty's avatar
   
Monty committed
326
327
}

Monty's avatar
   
Monty committed
328
329
static void _make_decode_ready(OggVorbis_File *vf){
  if(vf->decode_ready)return;
Monty's avatar
   
Monty committed
330
331
332
333
334
  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
335
336
  vorbis_block_init(&vf->vd,&vf->vb);
  vf->decode_ready=1;
Monty's avatar
   
Monty committed
337
  return;
Monty's avatar
   
Monty committed
338
339
}

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

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

Monty's avatar
   
Monty committed
370
371
    /* Chained bitstream. Bisect-search each logical bitstream
       section.  Do so based on serial number only */
Monty's avatar
   
Monty committed
372
373
374
375
    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
376

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

    /* Only one logical bitstream */
Monty's avatar
   
Monty committed
380
381
382
383
    if(_bisect_forward_serialno(vf,0,end,end+1,serialno,0)){
      ogg_stream_clear(&vf->os);
      return(OV_EREAD);
    }
Monty's avatar
   
Monty committed
384
385
386

  }

Monty's avatar
   
Monty committed
387
  _prefetch_all_headers(vf,&initial_i,&initial_c,dataoffset);
Monty's avatar
   
Monty committed
388
  return(ov_raw_seek(vf,0));
Monty's avatar
   
Monty committed
389
390
391
392

}

static int _open_nonseekable(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
393
  int ret;
Monty's avatar
   
Monty committed
394
395
  /* we cannot seek. Set up a 'single' (current) logical bitstream entry  */
  vf->links=1;
Monty's avatar
   
Monty committed
396
397
  vf->vi=_ogg_calloc(vf->links,sizeof(vorbis_info));
  vf->vc=_ogg_calloc(vf->links,sizeof(vorbis_info));
Monty's avatar
   
Monty committed
398
399

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

Monty's avatar
   
Monty committed
404
405
  return 0;
}
Monty's avatar
   
Monty committed
406
407
408
409
410
411
412

/* 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
413
414
415

  vf->bittrack=0.;
  vf->samptrack=0.;
Monty's avatar
   
Monty committed
416
417
418
419
420
421
422
423
}

/* 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
424
425
   return: <0) error, OV_HOLE (lost packet) or OV_EOF
            0) need more data (only if readp==0)
Monty's avatar
   
Monty committed
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
	    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
441
      ogg_int64_t granulepos;
Monty's avatar
   
Monty committed
442
      
Monty's avatar
   
Monty committed
443
      if(result==-1)return(OV_HOLE); /* hole in the data. */
Monty's avatar
   
Monty committed
444
445
      if(result>0){
	/* got a packet.  process it */
Monty's avatar
   
Monty committed
446
	granulepos=op.granulepos;
Monty's avatar
   
Monty committed
447
448
449
450
451
452
453
	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
454
455
456
457
458
459
460
461

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

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

Monty's avatar
   
Monty committed
496
497
498
499
    /* 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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
    /* 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
529
530
531
532
	if(link==vf->links)return(OV_EBADLINK); /* sign of a bogus
						   stream.  error out,
						   leave machine
						   uninitialized */
Monty's avatar
   
Monty committed
533
534
	
	vf->current_link=link;
Monty's avatar
   
Monty committed
535
	
Monty's avatar
   
Monty committed
536
	ogg_stream_init(&vf->os,vf->current_serialno);
Monty's avatar
   
Monty committed
537
	ogg_stream_reset(&vf->os); 
Monty's avatar
   
Monty committed
538
	
Monty's avatar
   
Monty committed
539
540
541
542
      }else{
	/* we're streaming */
	/* fetch the three header packets, build the info struct */
	
Monty's avatar
   
Monty committed
543
	_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,&og);
Monty's avatar
   
Monty committed
544
545
546
547
	vf->current_link++;
	link=0;
      }
      
Monty's avatar
   
Monty committed
548
      _make_decode_ready(vf);
Monty's avatar
   
Monty committed
549
550
551
552
553
    }
    ogg_stream_pagein(&vf->os,&og);
  }
}

Monty's avatar
   
Monty committed
554
555
556
557
558
559
560
561
562
563
564
565
/**********************************************************************
 * 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
566
      for(i=0;i<vf->links;i++){
Monty's avatar
   
Monty committed
567
	vorbis_info_clear(vf->vi+i);
Monty's avatar
   
Monty committed
568
569
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
   
Monty committed
570
571
      _ogg_free(vf->vi);
      _ogg_free(vf->vc);
Monty's avatar
   
Monty committed
572
    }
Monty's avatar
   
Monty committed
573
574
575
576
    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
577
    ogg_sync_clear(&vf->oy);
Michael Smith's avatar
   
Michael Smith committed
578
    if(vf->datasource)(vf->callbacks.close_func)(vf->datasource);
Monty's avatar
   
Monty committed
579
580
    memset(vf,0,sizeof(OggVorbis_File));
  }
Monty's avatar
   
Monty committed
581
#ifdef DEBUG_LEAKS
Monty's avatar
   
Monty committed
582
  _VDBG_dump();
Monty's avatar
   
Monty committed
583
#endif
Monty's avatar
   
Monty committed
584
  return(0);
Monty's avatar
   
Monty committed
585
}
Monty's avatar
   
Monty committed
586

Monty's avatar
   
Monty committed
587
static int _fseek64_wrap(FILE *f,ogg_int64_t off,int whence){
Monty's avatar
   
Monty committed
588
589
590
  return fseek(f,(int)off,whence);
}

Monty's avatar
   
Monty committed
591
592
/* 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
593
594
595
596
597
598
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
   
Monty committed
599
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Michael Smith's avatar
   
Michael Smith committed
600
  ov_callbacks callbacks = {
Michael Smith's avatar
   
Michael Smith committed
601
    (size_t (*)(void *, size_t, size_t, void *))  fread,
Monty's avatar
   
Monty committed
602
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
Michael Smith's avatar
   
Michael Smith committed
603
604
605
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Michael Smith's avatar
   
Michael Smith committed
606
607
608
609
610
611
612
613
614

  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)
{
  long offset=callbacks.seek_func(f,0,SEEK_CUR);
Monty's avatar
   
Monty committed
615
616
617
  int ret;

  memset(vf,0,sizeof(OggVorbis_File));
Michael Smith's avatar
   
Michael Smith committed
618
619
  vf->datasource=f;
  vf->callbacks = callbacks;
Monty's avatar
   
Monty committed
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640

  /* 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
641
    vf->datasource=NULL;
Monty's avatar
   
Monty committed
642
643
644
645
646
    ov_clear(vf);
  }
  return(ret);
}

Monty's avatar
   
Monty committed
647
/* How many logical bitstreams in this physical bitstream? */
Monty's avatar
   
Monty committed
648
649
long ov_streams(OggVorbis_File *vf){
  return vf->links;
Monty's avatar
   
Monty committed
650
651
}

Monty's avatar
   
Monty committed
652
/* Is the FILE * associated with vf seekable? */
Monty's avatar
   
Monty committed
653
654
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
Monty's avatar
   
Monty committed
655
656
}

Monty's avatar
   
Monty committed
657
658
659
660
661
662
663
664
665
666
/* 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
667
  if(i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
668
  if(!vf->seekable && i!=0)return(ov_bitrate(vf,0));
Monty's avatar
   
Monty committed
669
  if(i<0){
Monty's avatar
   
Monty committed
670
    ogg_int64_t bits=0;
Monty's avatar
   
Monty committed
671
672
    int i;
    for(i=0;i<vf->links;i++)
Monty's avatar
   
Monty committed
673
      bits+=(vf->offsets[i+1]-vf->dataoffsets[i])*8;
Monty's avatar
   
Monty committed
674
675
676
677
    return(rint(bits/ov_time_total(vf,-1)));
  }else{
    if(vf->seekable){
      /* return the actual bitrate */
Monty's avatar
   
Monty committed
678
      return(rint((vf->offsets[i+1]-vf->dataoffsets[i])*8/ov_time_total(vf,i)));
Monty's avatar
   
Monty committed
679
680
681
682
683
684
685
686
687
688
689
690
    }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
691
	return(OV_FALSE);
Monty's avatar
   
Monty committed
692
693
694
695
696
      }
    }
  }
}

Monty's avatar
   
Monty committed
697
698
699
700
701
/* 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
702
  if(vf->samptrack==0)return(OV_FALSE);
Monty's avatar
   
Monty committed
703
704
705
706
707
708
  ret=vf->bittrack/vf->samptrack*vf->vi[link].rate+.5;
  vf->bittrack=0.;
  vf->samptrack=0.;
  return(ret);
}

Monty's avatar
   
Monty committed
709
710
/* Guess */
long ov_serialnumber(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
711
  if(i>=vf->links)return(ov_serialnumber(vf,vf->links-1));
Monty's avatar
   
Monty committed
712
713
714
715
716
717
718
719
  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
720
721
722
723
/* 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
724
ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
725
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
726
  if(i<0){
Monty's avatar
   
Monty committed
727
728
729
730
731
732
733
734
735
    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
736

Monty's avatar
   
Monty committed
737
738
739
740
/* 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
741
ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
742
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
743
  if(i<0){
Monty's avatar
   
Monty committed
744
    ogg_int64_t acc=0;
Monty's avatar
   
Monty committed
745
746
747
748
749
750
751
752
    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
753

Monty's avatar
   
Monty committed
754
755
756
757
/* 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
758
double ov_time_total(OggVorbis_File *vf,int i){
Monty's avatar
   
Monty committed
759
  if(!vf->seekable || i>=vf->links)return(OV_EINVAL);
Monty's avatar
   
Monty committed
760
  if(i<0){
Monty's avatar
   
Monty committed
761
762
763
764
765
766
767
768
769
    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
770

Monty's avatar
   
Monty committed
771
772
773
774
/* 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
775
776
777
   surprises). 

   returns zero on success, nonzero on failure */
Monty's avatar
   
Monty committed
778
779

int ov_raw_seek(OggVorbis_File *vf,long pos){
Monty's avatar
   
Monty committed
780
781
782
  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
783
784

  /* clear out decoding machine state */
Monty's avatar
   
Monty committed
785
  vf->pcm_offset=-1;
Monty's avatar
   
Monty committed
786
  _decode_clear(vf);
Monty's avatar
   
Monty committed
787
  
Monty's avatar
   
Monty committed
788
789
790
791
792
793
  /* 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
794
     from a page has the 'granulepos' field set, and that's how the
Monty's avatar
   
Monty committed
795
796
     helper updates the offset */

Monty's avatar
   
Monty committed
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
  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
813
  }
Monty's avatar
   
Monty committed
814
  
Monty's avatar
   
Monty committed
815
  while(1){
Monty's avatar
   
Monty committed
816
817
    /* 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
818
    switch(_process_packet(vf,0)){
Monty's avatar
   
Monty committed
819
820
821
    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
822
823
         gracefully, we're just missing the offset */
      return(0);
Monty's avatar
   
Monty committed
824
    case OV_EBADLINK:
Monty's avatar
   
Monty committed
825
826
827
828
829
830
831
832
833
      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
834
  vf->pcm_offset=-1;
Monty's avatar
   
Monty committed
835
  _decode_clear(vf);
Monty's avatar
   
Monty committed
836
  return OV_EBADLINK;
Monty's avatar
   
Monty committed
837
838
}

Monty's avatar
   
Monty committed
839
840
/* 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
841

Monty's avatar
   
Monty committed
842
843
844
845
   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
846
  int link=-1;
Monty's avatar
   
Monty committed
847
  long ret;
Monty's avatar
   
Monty committed
848
  ogg_int64_t total=ov_pcm_total(vf,-1);
Monty's avatar
   
Monty committed
849

Monty's avatar
   
Monty committed
850
851
  if(!vf->seekable)return(OV_ENOSEEK);
  if(pos<0 || pos>total)return(OV_EINVAL);
Monty's avatar
   
Monty committed
852
853
854
855
856
857
858

  /* 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
859
  /* search within the logical bitstream for the page with the highest
Monty's avatar
   
Monty committed
860
861
862
863
864
     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
865
    ogg_int64_t target=pos-total;
Monty's avatar
   
Monty committed
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
    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
881
      ret=_get_next_page(vf,&og,end-bisect);
Monty's avatar
   
Monty committed
882
883
      switch(ret){
      case OV_FALSE: case OV_EOF:
Monty's avatar
   
Monty committed
884
	end=bisect;
Monty's avatar
   
Monty committed
885
886
887
888
889
890
891
892
893
894
895
896
	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
897
898
899
	}
      }
    }
Monty's avatar
   
Monty committed
900

Monty's avatar
   
Monty committed
901
902
    /* found our page. seek to it (call raw_seek). */
    
Monty's avatar
   
Monty committed
903
    if((ret=ov_raw_seek(vf,best)))goto seek_error;
Monty's avatar
   
Monty committed
904
  }
Monty's avatar
   
Monty committed
905
  
Monty's avatar
   
Monty committed
906
  /* verify result */
Monty's avatar
   
Monty committed
907
908
909
910
  if(vf->pcm_offset>=pos || pos>ov_pcm_total(vf,-1)){
    ret=OV_EFAULT;
    goto seek_error;
  }
Monty's avatar
   
Monty committed
911
  return(0);
Monty's avatar
   
Monty committed
912
  
Monty's avatar
   
Monty committed
913
914
915
916
 seek_error:
  /* dump machine so we're in a known state */
  vf->pcm_offset=-1;
  _decode_clear(vf);
Monty's avatar
   
Monty committed
917
  return ret;
Monty's avatar
   
Monty committed
918
919
920
921
922
923
}

/* 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
924
925
926
  int ret=ov_pcm_seek_page(vf,pos);
  if(ret<0)return(ret);
  
Monty's avatar
   
Monty committed
927
928
929
  /* 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
930
    float **pcm;
Monty's avatar
   
Monty committed
931
932
    long target=pos-vf->pcm_offset;
    long samples=vorbis_synthesis_pcmout(&vf->vd,&pcm);
Monty's avatar
   
Monty committed
933

Monty's avatar
   
Monty committed
934
935
936
937
938
939
940
941
942
    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
943
944
945
946
947
948
949
950
951
952
953
}

/* 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
954
955
  if(!vf->seekable)return(OV_ENOSEEK);
  if(seconds<0 || seconds>time_total)return(OV_EINVAL);
Monty's avatar
   
Monty committed
956
  
Monty's avatar
   
Monty committed
957
958
959
960
961
962
963
964
965
966
967
968
  /* 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
969
}
Monty's avatar
   
Monty committed
970

Monty's avatar
   
Monty committed
971
/* page-granularity version of ov_time_seek 
Monty's avatar
   
Monty committed
972
   returns zero on success, nonzero on failure */
Monty's avatar
   
Monty committed
973
int ov_time_seek_page(OggVorbis_File *vf,double seconds){
Monty's avatar
   
Monty committed
974
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
   
Monty committed
975

Monty's avatar
   
Monty committed
976
  int link=-1;
Monty's avatar
   
Monty committed
977
  ogg_int64_t pcm_total=ov_pcm_total(vf,-1);
Monty's avatar
   
Monty committed
978
  double time_total=ov_time_total(vf,-1);
Monty's avatar
   
Monty committed
979

Monty's avatar
   
Monty committed
980
981
  if(!vf->seekable)return(OV_ENOSEEK);
  if(seconds<0 || seconds>time_total)return(OV_EINVAL);
Monty's avatar
   
Monty committed
982
983
984
985
986
987
988
989
990
991
  
  /* 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
992
    ogg_int64_t target=pcm_total+(seconds-time_total)*vf->vi[link].rate;
Monty's avatar
   
Monty committed
993
    return(ov_pcm_seek_page(vf,target));
Monty's avatar
   
Monty committed
994
995
996
997
998
  }
}

/* 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
999
ogg_int64_t ov_raw_tell(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
1000
  return(vf->offset);
Monty's avatar
   
Monty committed
1001
1002
}

Monty's avatar
   
Monty committed
1003
/* return PCM offset (sample) of next PCM sample to be read */
Monty's avatar
   
Monty committed
1004
ogg_int64_t ov_pcm_tell(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
1005
1006
  return(vf->pcm_offset);
}
Monty's avatar
   
Monty committed
1007

Monty's avatar
   
Monty committed
1008
/* return time offset (seconds) of next PCM sample to be read */
Monty's avatar
   
Monty committed
1009
1010
double ov_time_tell(OggVorbis_File *vf){
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
   
Monty committed
1011

Monty's avatar
   
Monty committed
1012
  int link=-1;
Monty's avatar
   
Monty committed
1013
  ogg_int64_t pcm_total=0;
Monty's avatar
   
Monty committed
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
  double time_total=0.;
  
  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
1024
      if(vf->pcm_offset>=pcm_total)break;
Monty's avatar
   
Monty committed
1025
1026
    }
  }
Monty's avatar
   
Monty committed
1027

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

Monty's avatar
   
Monty committed
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
/*  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
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
  }
}

/* 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
1077
1078
  }
}
Monty's avatar
   
Monty committed
1079

1080
int host_is_big_endian() {
Monty's avatar
   
Monty committed
1081
  ogg_int32_t pattern = 0xfeedface; /* deadbeef */
1082
  unsigned char *bytewise = (unsigned char *)&pattern;
Monty's avatar
   
Monty committed
1083
  if (bytewise[0] == 0xfe) return 1;
1084
1085
1086
  return 0;
}

Monty's avatar
   
Monty committed
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
/* 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
		 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
1109
   return values: -1) error/hole in data (OV_HOLE)
Monty's avatar
   
Monty committed
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
                   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;
1121
  int host_endian = host_is_big_endian();
Monty's avatar
   
Monty committed
1122
1123
1124

  while(1){
    if(vf->decode_ready){
Monty's avatar
   
Monty committed
1125
      float **pcm;
Monty's avatar
   
Monty committed
1126
1127
1128
1129
1130
1131
      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
1132
	vorbis_fpu_control fpu;
Monty's avatar
   
Monty committed
1133
1134
1135
1136
	if(samples>length/bytespersample)samples=length/bytespersample;
	
	/* a tight loop to pack each size */
	{
Michael Smith's avatar
   
Michael Smith committed
1137
	  int val;
Monty's avatar
   
Monty committed
1138
1139
	  if(word==1){
	    int off=(sgned?0:128);
Monty's avatar
   
Monty committed
1140
	    vorbis_fpu_setround(&fpu);
Monty's avatar
   
Monty committed
1141
1142
	    for(j=0;j<samples;j++)
	      for(i=0;i<channels;i++){
Monty's avatar
   
Monty committed
1143
		val=vorbis_ftoi(pcm[i][j]*128.);
Monty's avatar
   
Monty committed
1144
		if(val>127)val=127;
Michael Smith's avatar
   
Michael Smith committed
1145
		else if(val<-128)val=-128;
Monty's avatar
   
Monty committed
1146
1147
		*buffer++=val+off;
	      }
Monty's avatar
   
Monty committed
1148
	    vorbis_fpu_restore(fpu);
Monty's avatar
   
Monty committed
1149
1150
1151
	  }else{
	    int off=(sgned?0:32768);

1152
1153
	    if(host_endian==bigendianp){
	      if(sgned){
Monty's avatar
   
Monty committed
1154
1155

		vorbis_fpu_setround(&fpu);
1156
		for(i=0;i<channels;i++) { /* It's faster in this order */
Monty's avatar
   
Monty committed
1157
		  float *src=pcm[i];
1158
1159
		  short *dest=((short *)buffer)+i;
		  for(j=0;j<samples;j++) {
Monty's avatar
   
Monty committed
1160
		    val=vorbis_ftoi(src[j]*32768.);
1161
1162
1163
1164
1165
1166
		    if(val>32767)val=32767;
		    else if(val<-32768)val=-32768;
		    *dest=val;
		    dest+=channels;
		  }
		}
Monty's avatar
   
Monty committed
1167
1168
		vorbis_fpu_restore(fpu);

1169
	      }else{
Monty's avatar
   
Monty committed
1170
1171

		vorbis_fpu_setround(&fpu);
1172
		for(i=0;i<channels;i++) {
Monty's avatar
   
Monty committed
1173
		  float *src=pcm[i];
1174
1175
		  short *dest=((short *)buffer)+i;
		  for(j=0;j<samples;j++) {
Monty's avatar
   
Monty committed
1176
		    val=vorbis_ftoi(src[j]*32768.);
1177
1178
1179
1180
1181
1182
		    if(val>32767)val=32767;
		    else if(val<-32768)val=-32768;
		    *dest=val+off;
		    dest+=channels;
		  }
		}
Monty's avatar
   
Monty committed
1183
1184
		vorbis_fpu_restore(fpu);

1185
1186
	      }
	    }else if(bigendianp){
Monty's avatar
   
Monty committed
1187
1188

	      vorbis_fpu_setround(&fpu);
Monty's avatar
   
Monty committed
1189
1190
	      for(j=0;j<samples;j++)
		for(i=0;i<channels;i++){
Monty's avatar
   
Monty committed
1191
		  val=vorbis_ftoi(pcm[i][j]*32768.);
Monty's avatar
   
Monty committed
1192
		  if(val>32767)val=32767;
Michael Smith's avatar
   
Michael Smith committed
1193
		  else if(val<-32768)val=-32768;
Monty's avatar
   
Monty committed
1194
1195
1196
1197
		  val+=off;
		  *buffer++=(val>>8);
		  *buffer++=(val&0xff);
		}
Monty's avatar
   
Monty committed
1198
1199
	      vorbis_fpu_restore(fpu);

Monty's avatar
   
Monty committed
1200
	    }else{
Michael Smith's avatar
   
Michael Smith committed
1201
	      int val;
Monty's avatar
   
Monty committed
1202
	      vorbis_fpu_setround(&fpu);
Monty's avatar
   
Monty committed
1203
	      for(j=0;j<samples;j++)
Michael Smith's avatar
   
Michael Smith committed