vorbisfile.c 61.6 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
 *                                                                  *
8
 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007             *
9
 * by the Xiph.Org Foundation 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
Michael Smith's avatar
Michael Smith committed
14
 last mod: $Id$
Monty's avatar
 
Monty committed
15
16
17

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

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

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

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

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

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

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

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

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

Ralph Giles's avatar
Ralph Giles committed
59
60
/* read a little more data from the file/pipe into the ogg_sync framer
*/
61
62
#define CHUNKSIZE 65536

Monty's avatar
   
Monty committed
63
static long _get_data(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
64
  errno=0;
65
  if(!(vf->callbacks.read_func))return(-1);
Monty's avatar
   
Monty committed
66
67
68
69
70
71
72
73
  if(vf->datasource){
    char *buffer=ogg_sync_buffer(&vf->oy,CHUNKSIZE);
    long bytes=(vf->callbacks.read_func)(buffer,1,CHUNKSIZE,vf->datasource);
    if(bytes>0)ogg_sync_wrote(&vf->oy,bytes);
    if(bytes==0 && errno)return(-1);
    return(bytes);
  }else
    return(0);
Monty's avatar
   
Monty committed
74
75
76
}

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

/* 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
101
   return:   <0) did not find a page (OV_FALSE, OV_EOF, OV_EREAD)
Monty's avatar
   
Monty committed
102
103
              n) found a page at absolute offset n */

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

Monty's avatar
   
Monty committed
110
    if(boundary>0 && vf->offset>=boundary)return(OV_FALSE);
Monty's avatar
   
Monty committed
111
112
113
114
115
116
117
118
    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
119
120
121
122
123
124
	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
125
126
127
      }else{
	/* got a page.  Return the offset at the page beginning,
           advance the internal offset past the page end */
Monty's avatar
   
Monty committed
128
	ogg_int64_t ret=vf->offset;
Monty's avatar
   
Monty committed
129
130
131
132
133
134
135
136
137
138
139
140
	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
141
/* returns offset or OV_EREAD, OV_FAULT */
Monty's avatar
   
Monty committed
142
143
144
145
146
static ogg_int64_t _get_prev_page(OggVorbis_File *vf,ogg_page *og){
  ogg_int64_t begin=vf->offset;
  ogg_int64_t end=begin;
  ogg_int64_t ret;
  ogg_int64_t offset=-1;
Monty's avatar
   
Monty committed
147
148
149

  while(offset==-1){
    begin-=CHUNKSIZE;
150
151
    if(begin<0)
      begin=0;
152
153
154
155

    ret=_seek_helper(vf,begin);
    if(ret)return(ret);

Monty's avatar
   
Monty committed
156
157
    while(vf->offset<end){
      ret=_get_next_page(vf,og,end-vf->offset);
Monty's avatar
   
Monty committed
158
159
      if(ret==OV_EREAD)return(OV_EREAD);
      if(ret<0){
Monty's avatar
   
Monty committed
160
161
162
163
164
165
166
167
	break;
      }else{
	offset=ret;
      }
    }
  }

  /* we have the offset.  Actually snork and hold the page now */
168
169
170
  ret=_seek_helper(vf,offset);
  if(ret)return(ret);

Monty's avatar
   
Monty committed
171
  ret=_get_next_page(vf,og,CHUNKSIZE);
Monty's avatar
   
Monty committed
172
  if(ret<0)
Monty's avatar
   
Monty committed
173
    /* this shouldn't be possible */
Monty's avatar
   
Monty committed
174
175
    return(OV_EFAULT);

Monty's avatar
   
Monty committed
176
177
178
  return(offset);
}

179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
static void _add_serialno(ogg_page *og,long **serialno_list, int *n){
  long s = ogg_page_serialno(og);
  (*n)++;

  if(serialno_list){
    *serialno_list = _ogg_realloc(*serialno_list, sizeof(*serialno_list)*(*n));
  }else{
    *serialno_list = _ogg_malloc(sizeof(**serialno_list));
  }
  
  (*serialno_list)[(*n)-1] = s;
}

/* returns nonzero if found */
static int _lookup_serialno(ogg_page *og, long *serialno_list, int n){
  long s = ogg_page_serialno(og);

  if(serialno_list){
    while(n--){
      if(*serialno_list == s) return 1;
      serialno_list++;
    }
  }
  return 0;
}

/* start parsing pages at current offset, remembering all serial
   numbers.  Stop logging at first non-bos page */
static int _get_serialnos(OggVorbis_File *vf, long **s, int *n){
  ogg_page og;

  *s=NULL;
  *n=0;

  while(1){
    ogg_int64_t llret=_get_next_page(vf,&og,CHUNKSIZE);
    if(llret==OV_EOF)return(0);
    if(llret<0)return(llret);
    if(!ogg_page_bos(&og)) return 0;

    /* look for duplicate serialnos; add this one if unique */
    if(_lookup_serialno(&og,*s,*n)){
      if(*s)_ogg_free(*s);
      *s=0;
      *n=0;
      return(OV_EBADHEADER);
    }

    _add_serialno(&og,s,n);
  }
}

Monty's avatar
   
Monty committed
231
232
233
234
/* 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
235
static int _bisect_forward_serialno(OggVorbis_File *vf,
Monty's avatar
   
Monty committed
236
237
238
				    ogg_int64_t begin,
				    ogg_int64_t searched,
				    ogg_int64_t end,
239
240
				    long *currentno_list,
				    int  currentnos,
Monty's avatar
   
Monty committed
241
				    long m){
Monty's avatar
   
Monty committed
242
243
  ogg_int64_t endsearched=end;
  ogg_int64_t next=end;
Monty's avatar
   
Monty committed
244
  ogg_page og;
Monty's avatar
   
Monty committed
245
  ogg_int64_t ret;
Monty's avatar
   
Monty committed
246
  
Monty's avatar
   
Monty committed
247
248
249
  /* the below guards against garbage seperating the last and
     first pages of two links. */
  while(searched<endsearched){
Monty's avatar
   
Monty committed
250
    ogg_int64_t bisect;
Monty's avatar
   
Monty committed
251
252
253
254
255
256
257
    
    if(endsearched-searched<CHUNKSIZE){
      bisect=searched;
    }else{
      bisect=(searched+endsearched)/2;
    }
    
258
259
260
    ret=_seek_helper(vf,bisect);
    if(ret)return(ret);

Monty's avatar
   
Monty committed
261
    ret=_get_next_page(vf,&og,-1);
Monty's avatar
   
Monty committed
262
    if(ret==OV_EREAD)return(OV_EREAD);
263
    if(ret<0 || !_lookup_serialno(&og,currentno_list,currentnos)){
Monty's avatar
   
Monty committed
264
265
266
267
268
269
      endsearched=bisect;
      if(ret>=0)next=ret;
    }else{
      searched=ret+og.header_len+og.body_len;
    }
  }
Monty's avatar
   
Monty committed
270

271
272
273
  {
    long *next_serialno_list=NULL;
    int next_serialnos=0;
274

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
    ret=_seek_helper(vf,next);
    if(ret)return(ret);
    ret=_get_serialnos(vf,&next_serialno_list,&next_serialnos);
    if(ret)return(ret);
    
    if(searched>=end || next_serialnos==0){
      vf->links=m+1;
      vf->offsets=_ogg_malloc((vf->links+1)*sizeof(*vf->offsets));
      vf->offsets[m+1]=searched;
    }else{
      ret=_bisect_forward_serialno(vf,next,vf->offset,
				   end,next_serialno_list,next_serialnos,m+1);
      if(ret)return(ret);
    }
    
    if(next_serialno_list)_ogg_free(next_serialno_list);
Monty's avatar
   
Monty committed
291
292
  }
  vf->offsets[m]=begin;
Monty's avatar
   
Monty committed
293
  return(0);
Monty's avatar
   
Monty committed
294
}
Monty's avatar
   
Monty committed
295

Monty's avatar
   
Monty committed
296
297
/* uses the local ogg_stream storage in vf; this is important for
   non-streaming input sources */
Monty's avatar
   
Monty committed
298
static int _fetch_headers(OggVorbis_File *vf,vorbis_info *vi,vorbis_comment *vc,
Monty's avatar
   
Monty committed
299
			  long *serialno,ogg_page *og_ptr){
Monty's avatar
   
Monty committed
300
301
  ogg_page og;
  ogg_packet op;
Monty's avatar
   
Monty committed
302
  int i,ret;
303
304
  int allbos=0;

Monty's avatar
   
Monty committed
305
  if(!og_ptr){
Monty's avatar
   
Monty committed
306
307
    ogg_int64_t llret=_get_next_page(vf,&og,CHUNKSIZE);
    if(llret==OV_EREAD)return(OV_EREAD);
308
    if(llret<0)return(OV_ENOTVORBIS);
Monty's avatar
   
Monty committed
309
310
311
    og_ptr=&og;
  }

Monty's avatar
   
Monty committed
312
  vorbis_info_init(vi);
Monty's avatar
   
Monty committed
313
  vorbis_comment_init(vc);
314
315
316
317

  /* extract the first set of vorbis headers we see in the headerset */

  while(1){
Monty's avatar
   
Monty committed
318
  
319
320
321
322
323
324
325
326
327
    /* if we're past the ID headers, we won't be finding a Vorbis
       stream in this link */
    if(!ogg_page_bos(og_ptr)){
      ret = OV_ENOTVORBIS;
      goto bail_header;
    }

    /* prospective stream setup; we need a stream to get packets */
    ogg_stream_reset_serialno(&vf->os,ogg_page_serialno(og_ptr));
Monty's avatar
   
Monty committed
328
    ogg_stream_pagein(&vf->os,og_ptr);
329

330
331
    if(ogg_stream_packetout(&vf->os,&op) > 0 &&
       vorbis_synthesis_idheader(&op)){
332
333
334
335
336
337
338

      /* continue Vorbis header load; past this point, any error will
	 render this link useless (we won't continue looking for more
	 Vorbis streams */
      if(serialno)*serialno=vf->os.serialno;
      vf->ready_state=STREAMSET;
      if((ret=vorbis_synthesis_headerin(vi,vc,&op)))
Monty's avatar
   
Monty committed
339
	goto bail_header;
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382

      i=0;
      while(i<2){ /* get a page loop */
	
	while(i<2){ /* get a packet loop */

	  int result=ogg_stream_packetout(&vf->os,&op);
	  if(result==0)break;
	  if(result==-1){
	    ret=OV_EBADHEADER;
	    goto bail_header;
	  }
	
	  if((ret=vorbis_synthesis_headerin(vi,vc,&op)))
	    goto bail_header;

	  i++;
	}

	while(i<2){
	  if(_get_next_page(vf,og_ptr,CHUNKSIZE)<0){
	    ret=OV_EBADHEADER;
	    goto bail_header;
	  }

	  /* if this page belongs to the correct stream, go parse it */
	  if(vf->os.serialno == ogg_page_serialno(og_ptr)){
	    ogg_stream_pagein(&vf->os,og_ptr);
	    break;
	  }

	  /* if we never see the final vorbis headers before the link
	     ends, abort */
	  if(ogg_page_bos(og_ptr)){
	    if(allbos){
	      ret = OV_EBADHEADER;
	      goto bail_header;
	    }else
	      allbos=1;
	  }

	  /* otherwise, keep looking */
	}
Monty's avatar
   
Monty committed
383
      }
384
385

      return 0; 
Monty's avatar
   
Monty committed
386
    }
387
388
389
390
391
392
393

    /* this wasn't vorbis, get next page, try again */
    {
      ogg_int64_t llret=_get_next_page(vf,og_ptr,CHUNKSIZE);
      if(llret==OV_EREAD)return(OV_EREAD);
      if(llret<0)return(OV_ENOTVORBIS);
    } 
Monty's avatar
   
Monty committed
394
  }
Monty's avatar
   
Monty committed
395

Monty's avatar
   
Monty committed
396
397
 bail_header:
  vorbis_info_clear(vi);
Monty's avatar
   
Monty committed
398
  vorbis_comment_clear(vc);
Monty's avatar
   
Monty committed
399
400
  vf->ready_state=OPENED;

Monty's avatar
   
Monty committed
401
  return ret;
Monty's avatar
   
Monty committed
402
}
Monty's avatar
   
Monty committed
403

Monty's avatar
   
Monty committed
404
405
406
407
/* 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
408
409
410
411
412

/* 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
413
static void _prefetch_all_headers(OggVorbis_File *vf, ogg_int64_t dataoffset){
Monty's avatar
   
Monty committed
414
  ogg_page og;
Monty's avatar
   
Monty committed
415
416
  int i;
  ogg_int64_t ret;
417

418
419
  vf->vi=_ogg_realloc(vf->vi,vf->links*sizeof(*vf->vi));
  vf->vc=_ogg_realloc(vf->vc,vf->links*sizeof(*vf->vc));
420
  vf->serialnos=_ogg_malloc(vf->links*sizeof(*vf->serialnos));
421
  vf->dataoffsets=_ogg_malloc(vf->links*sizeof(*vf->dataoffsets));
Monty's avatar
   
Monty committed
422
  vf->pcmlengths=_ogg_malloc(vf->links*2*sizeof(*vf->pcmlengths));
Monty's avatar
   
Monty committed
423
424
  
  for(i=0;i<vf->links;i++){
Monty's avatar
   
Monty committed
425
426
    if(i==0){
      /* we already grabbed the initial header earlier.  Just set the offset */
427
      vf->serialnos[i]=vf->current_serialno;
Monty's avatar
   
Monty committed
428
      vf->dataoffsets[i]=dataoffset;
429
430
431
      ret=_seek_helper(vf,dataoffset);
      if(ret)
	vf->dataoffsets[i]=-1;
Monty's avatar
   
Monty committed
432

Monty's avatar
   
Monty committed
433
    }else{
Monty's avatar
   
Monty committed
434

Monty's avatar
   
Monty committed
435
      /* seek to the location of the initial header */
Monty's avatar
   
Monty committed
436

437
438
439
      ret=_seek_helper(vf,vf->offsets[i]);
      if(ret){
	vf->dataoffsets[i]=-1;
Monty's avatar
   
Monty committed
440
      }else{
441
	if(_fetch_headers(vf,vf->vi+i,vf->vc+i,vf->serialnos+i,NULL)<0){
442
443
444
445
	  vf->dataoffsets[i]=-1;
	}else{
	  vf->dataoffsets[i]=vf->offset;
	}
Monty's avatar
   
Monty committed
446
      }
Monty's avatar
   
Monty committed
447
    }
Monty's avatar
   
Monty committed
448

Monty's avatar
   
Monty committed
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
    /* fetch beginning PCM offset */

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

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

      while(1){
	ogg_packet op;

	ret=_get_next_page(vf,&og,-1);
	if(ret<0)
	  /* this should not be possible unless the file is
             truncated/mangled */
	  break;
       
467
468
	if(ogg_page_bos(&og)) break;

Monty's avatar
   
Monty committed
469
	if(ogg_page_serialno(&og)!=vf->serialnos[i])
470
	  continue;
Monty's avatar
   
Monty committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
	
	/* count blocksizes of all frames in the page */
	ogg_stream_pagein(&vf->os,&og);
	while((result=ogg_stream_packetout(&vf->os,&op))){
	  if(result>0){ /* ignore holes */
	    long thisblock=vorbis_packet_blocksize(vf->vi+i,&op);
	    if(lastblock!=-1)
	      accumulated+=(lastblock+thisblock)>>2;
	    lastblock=thisblock;
	  }
	}

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

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

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

    /* get the PCM length of this link. To do this,
Monty's avatar
   
Monty committed
498
499
       get the last page of the stream */
    {
Monty's avatar
   
Monty committed
500
      ogg_int64_t end=vf->offsets[i+1];
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
      ret=_seek_helper(vf,end);
      if(ret){
	/* this should not be possible */
	vorbis_info_clear(vf->vi+i);
	vorbis_comment_clear(vf->vc+i);
      }else{
	
	while(1){
	  ret=_get_prev_page(vf,&og);
	  if(ret<0){
	    /* this should not be possible */
	    vorbis_info_clear(vf->vi+i);
	    vorbis_comment_clear(vf->vc+i);
	    break;
	  }
516
517
518
519
520
	  if(ogg_page_serialno(&og)==vf->serialnos[i]){
	    if(ogg_page_granulepos(&og)!=-1){
	      vf->pcmlengths[i*2+1]=ogg_page_granulepos(&og)-vf->pcmlengths[i*2];
	      break;
	    }
521
522
	  }
	  vf->offset=ret;
Monty's avatar
   
Monty committed
523
524
525
526
	}
      }
    }
  }
Monty's avatar
   
Monty committed
527
528
}

Monty's avatar
   
Monty committed
529
static int _make_decode_ready(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
530
531
  if(vf->ready_state>STREAMSET)return 0;
  if(vf->ready_state<STREAMSET)return OV_EFAULT;
Monty's avatar
   
Monty committed
532
  if(vf->seekable){
Monty's avatar
   
Monty committed
533
534
    if(vorbis_synthesis_init(&vf->vd,vf->vi+vf->current_link))
      return OV_EBADLINK;
Monty's avatar
   
Monty committed
535
  }else{
Monty's avatar
   
Monty committed
536
537
    if(vorbis_synthesis_init(&vf->vd,vf->vi))
      return OV_EBADLINK;
Monty's avatar
   
Monty committed
538
  }    
Monty's avatar
   
Monty committed
539
  vorbis_block_init(&vf->vd,&vf->vb);
Monty's avatar
   
Monty committed
540
  vf->ready_state=INITSET;
Monty's avatar
   
Monty committed
541
542
  vf->bittrack=0.f;
  vf->samptrack=0.f;
Monty's avatar
   
Monty committed
543
  return 0;
Monty's avatar
   
Monty committed
544
545
}

Monty's avatar
   
Monty committed
546
static int _open_seekable2(OggVorbis_File *vf){
547
548
549
550
  ogg_int64_t dataoffset=vf->offset,end;
  long *serialno_list=NULL;
  int serialnos=0;
  int ret;
551
  ogg_page og;
Monty's avatar
   
Monty committed
552
553
554

  /* we're partially open and have a first link header state in
     storage in vf */
Monty's avatar
   
Monty committed
555
  /* we can seek, so set out learning all about this file */
556
  if(vf->callbacks.seek_func && vf->callbacks.tell_func){
557
558
559
560
561
    (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
    vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
  }else{
    vf->offset=vf->end=-1;
  }
562
563
564
565

  /* If seek_func is implemented, tell_func must also be implemented */
  if(vf->end==-1) return(OV_EINVAL);

566
567
568
569
570
  /* 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);
  if(end<0)return(end);

571
  /* back to beginning, learn all serialnos of first link */
572
  ret=_seek_helper(vf,0);
573
574
575
  if(ret)return(ret);
  ret=_get_serialnos(vf,&serialno_list,&serialnos);
  if(ret)return(ret);
Monty's avatar
   
Monty committed
576

577
578
579
  /* now determine bitstream structure recursively */
  if(_bisect_forward_serialno(vf,0,0,end+1,serialno_list,serialnos,0)<0)return(OV_EREAD);  
  if(serialno_list)_ogg_free(serialno_list);
Monty's avatar
   
Monty committed
580

Monty's avatar
   
Monty committed
581
582
  /* the initial header memory is referenced by vf after; don't free it */
  _prefetch_all_headers(vf,dataoffset);
Monty's avatar
   
Monty committed
583
  return(ov_raw_seek(vf,0));
Monty's avatar
   
Monty committed
584
}
Monty's avatar
   
Monty committed
585
586
587
588
589

/* clear out the current logical bitstream decoder */ 
static void _decode_clear(OggVorbis_File *vf){
  vorbis_dsp_clear(&vf->vd);
  vorbis_block_clear(&vf->vb);
Monty's avatar
   
Monty committed
590
  vf->ready_state=OPENED;
Monty's avatar
   
Monty committed
591
592
593
594
595
596
597
598
}

/* 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
599
600
   return: <0) error, OV_HOLE (lost packet) or OV_EOF
            0) need more data (only if readp==0)
Monty's avatar
   
Monty committed
601
602
603
	    1) got a packet 
*/

Monty's avatar
   
Monty committed
604
605
static int _fetch_and_process_packet(OggVorbis_File *vf,
				     ogg_packet *op_in,
Monty's avatar
   
Monty committed
606
607
				     int readp,
				     int spanp){
Monty's avatar
   
Monty committed
608
609
610
611
612
613
614
615
  ogg_page og;

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

Monty's avatar
   
Monty committed
623
	op_in=NULL;
624
625
626
	if(result==-1)return(OV_HOLE); /* hole in the data. */
	if(result>0){
	  /* got a packet.  process it */
Monty's avatar
   
Monty committed
627
628
629
630
631
632
633
634
	  granulepos=op_ptr->granulepos;
	  if(!vorbis_synthesis(&vf->vb,op_ptr)){ /* lazy check for lazy
						    header handling.  The
						    header packets aren't
						    audio, so if/when we
						    submit them,
						    vorbis_synthesis will
						    reject them */
635
636
637
638

	    /* suck in the synthesis data and track bitrate */
	    {
	      int oldsamples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
   
Monty committed
639
640
641
642
	      /* for proper use of libvorbis within libvorbisfile,
                 oldsamples will always be zero. */
	      if(oldsamples)return(OV_EFAULT);
	      
643
644
	      vorbis_synthesis_blockin(&vf->vd,&vf->vb);
	      vf->samptrack+=vorbis_synthesis_pcmout(&vf->vd,NULL)-oldsamples;
Monty's avatar
   
Monty committed
645
	      vf->bittrack+=op_ptr->bytes*8;
646
	    }
Monty's avatar
   
Monty committed
647
	  
648
	    /* update the pcm offset. */
Monty's avatar
   
Monty committed
649
	    if(granulepos!=-1 && !op_ptr->e_o_s){
650
651
	      int link=(vf->seekable?vf->current_link:0);
	      int i,samples;
Monty's avatar
   
Monty committed
652
	    
653
654
655
656
657
658
659
660
661
662
	      /* this packet has a pcm_offset on it (the last packet
	         completed on a page carries the offset) After processing
	         (above), we know the pcm position of the *last* sample
	         ready to be returned. Find the offset of the *first*

	         As an aside, this trick is inaccurate if we begin
	         reading anew right at the last page; the end-of-stream
	         granulepos declares the last frame in the stream, and the
	         last packet of the last page may be a partial frame.
	         So, we need a previous granulepos from an in-sequence page
Monty's avatar
   
Monty committed
663
	         to have a reference point.  Thus the !op_ptr->e_o_s clause
664
	         above */
Monty's avatar
   
Monty committed
665
666
667

	      if(vf->seekable && link>0)
		granulepos-=vf->pcmlengths[link*2];
Monty's avatar
   
Monty committed
668
669
670
671
672
	      if(granulepos<0)granulepos=0; /* actually, this
					       shouldn't be possible
					       here unless the stream
					       is very broken */

673
	      samples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
   
Monty committed
674
	    
675
676
	      granulepos-=samples;
	      for(i=0;i<link;i++)
Monty's avatar
   
Monty committed
677
	        granulepos+=vf->pcmlengths[i*2+1];
678
679
680
	      vf->pcm_offset=granulepos;
	    }
	    return(1);
Monty's avatar
   
Monty committed
681
	  }
Monty's avatar
   
Monty committed
682
	}
683
684
	else 
	  break;
Monty's avatar
   
Monty committed
685
686
687
      }
    }

Monty's avatar
   
Monty committed
688
    if(vf->ready_state>=OPENED){
Michael Smith's avatar
Michael Smith committed
689
      ogg_int64_t ret;
690
691
692
693
694
695
696
697
698
699
700
701
      
      while(1){ 
	/* the loop is not strictly necessary, but there's no sense in
	   doing the extra checks of the larger loop for the common
	   case in a multiplexed bistream where the page is simply
	   part of a different logical bitstream; keep reading until
	   we get one with the correct serialno */
	
	if(!readp)return(0);
	if((ret=_get_next_page(vf,&og,-1))<0){
	  return(OV_EOF); /* eof. leave unitialized */
	}
Monty's avatar
   
Monty committed
702
703
704

	/* bitrate tracking; add the header's bytes here, the body bytes
	   are done by packet above */
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
	vf->bittrack+=og.header_len*8;
	
	if(vf->ready_state==INITSET){
	  if(vf->current_serialno!=ogg_page_serialno(&og)){
	    
	    /* two possibilities: 
	       1) our decoding just traversed a bitstream boundary
	       2) another stream is multiplexed into this logical section? */
	    
	    if(ogg_page_bos(&og)){
	      /* boundary case */
	      if(!spanp)
		return(OV_EOF);
	      
	      _decode_clear(vf);
	      
	      if(!vf->seekable){
		vorbis_info_clear(vf->vi);
		vorbis_comment_clear(vf->vc);
	      }
	      break;

	    }else
	      continue; /* possibility #2 */
Monty's avatar
   
Monty committed
729
730
	  }
	}
731
732

	break;
Monty's avatar
   
Monty committed
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
      }
    }

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

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

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

Monty's avatar
   
Monty committed
748
    if(vf->ready_state!=INITSET){ 
Monty's avatar
   
Monty committed
749
      int link;
Monty's avatar
   
Monty committed
750
751
752

      if(vf->ready_state<STREAMSET){
	if(vf->seekable){
753
754
	  long serialno = ogg_page_serialno(&og);

Monty's avatar
   
Monty committed
755
756
757
	  /* match the serialno to bitstream section.  We use this rather than
	     offset positions to avoid problems near logical bitstream
	     boundaries */
758

Monty's avatar
   
Monty committed
759
	  for(link=0;link<vf->links;link++)
760
761
762
763
764
765
766
	    if(vf->serialnos[link]==serialno)break;

	  if(link==vf->links) continue; /* not the desired Vorbis
					   bitstream section; keep
					   trying */

	  vf->current_serialno=serialno;
Monty's avatar
   
Monty committed
767
768
	  vf->current_link=link;
	  
Monty's avatar
   
Monty committed
769
	  ogg_stream_reset_serialno(&vf->os,vf->current_serialno);
Monty's avatar
   
Monty committed
770
771
772
773
774
775
	  vf->ready_state=STREAMSET;
	  
	}else{
	  /* we're streaming */
	  /* fetch the three header packets, build the info struct */
	  
Monty's avatar
   
Monty committed
776
777
	  int ret=_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,&og);
	  if(ret)return(ret);
Monty's avatar
   
Monty committed
778
779
780
	  vf->current_link++;
	  link=0;
	}
Monty's avatar
   
Monty committed
781
782
      }
      
Monty's avatar
   
Monty committed
783
784
785
786
      {
	int ret=_make_decode_ready(vf);
	if(ret<0)return ret;
      }
Monty's avatar
   
Monty committed
787
    }
788
789
790

    /* the buffered page is the data we want, and we're ready for it;
       add it to the stream state */
Monty's avatar
   
Monty committed
791
    ogg_stream_pagein(&vf->os,&og);
792

Monty's avatar
   
Monty committed
793
794
795
  }
}

Monty's avatar
   
Monty committed
796
797
/* if, eg, 64 bit stdio is configured by default, this will build with
   fseek64 */
Monty's avatar
   
Monty committed
798
799
static int _fseek64_wrap(FILE *f,ogg_int64_t off,int whence){
  if(f==NULL)return(-1);
Monty's avatar
   
Monty committed
800
  return fseek(f,off,whence);
Monty's avatar
   
Monty committed
801
802
803
804
}

static int _ov_open1(void *f,OggVorbis_File *vf,char *initial,
		     long ibytes, ov_callbacks callbacks){
805
  int offsettest=((f && callbacks.seek_func)?callbacks.seek_func(f,0,SEEK_CUR):-1);
Monty's avatar
   
Monty committed
806
  int ret;
807
  
808
  memset(vf,0,sizeof(*vf));
Monty's avatar
   
Monty committed
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
  vf->datasource=f;
  vf->callbacks = callbacks;

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

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

  /* can we seek? Stevens suggests the seek test was portable */
Monty's avatar
   
Monty committed
826
  if(offsettest!=-1)vf->seekable=1;
Monty's avatar
   
Monty committed
827
828
829
830

  /* No seeking yet; Set up a 'single' (current) logical bitstream
     entry for partial open */
  vf->links=1;
831
832
  vf->vi=_ogg_calloc(vf->links,sizeof(*vf->vi));
  vf->vc=_ogg_calloc(vf->links,sizeof(*vf->vc));
Monty's avatar
   
Monty committed
833
834
  ogg_stream_init(&vf->os,-1); /* fill in the serialno later */

Monty's avatar
   
Monty committed
835
836
837
838
  /* Try to fetch the headers, maintaining all the storage */
  if((ret=_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno,NULL))<0){
    vf->datasource=NULL;
    ov_clear(vf);
Monty's avatar
   
Monty committed
839
  }else 
Monty's avatar
   
Monty committed
840
841
842
843
844
    vf->ready_state=PARTOPEN;
  return(ret);
}

static int _ov_open2(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
845
846
  if(vf->ready_state != PARTOPEN) return OV_EINVAL;
  vf->ready_state=OPENED;
Monty's avatar
   
Monty committed
847
848
849
850
851
852
853
  if(vf->seekable){
    int ret=_open_seekable2(vf);
    if(ret){
      vf->datasource=NULL;
      ov_clear(vf);
    }
    return(ret);
Monty's avatar
   
Monty committed
854
855
856
  }else
    vf->ready_state=STREAMSET;

Monty's avatar
   
Monty committed
857
858
859
860
  return 0;
}


Monty's avatar
   
Monty committed
861
862
863
864
865
866
867
868
869
/* 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
870
      for(i=0;i<vf->links;i++){
Monty's avatar
   
Monty committed
871
	vorbis_info_clear(vf->vi+i);
Monty's avatar
   
Monty committed
872
873
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
   
Monty committed
874
875
      _ogg_free(vf->vi);
      _ogg_free(vf->vc);
Monty's avatar
   
Monty committed
876
    }
Monty's avatar
   
Monty committed
877
878
879
880
    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
881
    ogg_sync_clear(&vf->oy);
882
883
    if(vf->datasource && vf->callbacks.close_func)
      (vf->callbacks.close_func)(vf->datasource);
884
    memset(vf,0,sizeof(*vf));
Monty's avatar
   
Monty committed
885
  }
Monty's avatar
   
Monty committed
886
#ifdef DEBUG_LEAKS
Monty's avatar
   
Monty committed
887
  _VDBG_dump();
Monty's avatar
   
Monty committed
888
#endif
Monty's avatar
   
Monty committed
889
  return(0);
Monty's avatar
   
Monty committed
890
}
Monty's avatar
 
Monty committed
891

Monty's avatar
   
Monty committed
892
893
/* 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
894
895
896
897
898
899
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
   
Monty committed
900
901
902
903
904
905
906
int ov_open_callbacks(void *f,OggVorbis_File *vf,char *initial,long ibytes,
    ov_callbacks callbacks){
  int ret=_ov_open1(f,vf,initial,ibytes,callbacks);
  if(ret)return ret;
  return _ov_open2(vf);
}

Monty's avatar
   
Monty committed
907
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Michael Smith's avatar
   
Michael Smith committed
908
  ov_callbacks callbacks = {
Michael Smith's avatar
   
Michael Smith committed
909
    (size_t (*)(void *, size_t, size_t, void *))  fread,
Monty's avatar
   
Monty committed
910
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
Michael Smith's avatar
   
Michael Smith committed
911
912
913
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Michael Smith's avatar
   
Michael Smith committed
914
915
916

  return ov_open_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
917
918
919
920
921
922
923
924
925
926
927

int ov_fopen(char *path,OggVorbis_File *vf){
  int ret;
  FILE *f = fopen(path,"rb");
  if(!f) return -1;

  ret = ov_open(f,vf,NULL,0);
  if(ret) fclose(f);
  return ret;
}

Monty's avatar
   
Monty committed
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
/* cheap hack for game usage where downsampling is desirable; there's
   no need for SRC as we can just do it cheaply in libvorbis. */
 
int ov_halfrate(OggVorbis_File *vf,int flag){
  int i;
  if(vf->vi==NULL)return OV_EINVAL;
  if(!vf->seekable)return OV_EINVAL;
  if(vf->ready_state>=STREAMSET)
    _decode_clear(vf); /* clear out stream state; later on libvorbis
                          will be able to swap this on the fly, but
                          for now dumping the decode machine is needed
                          to reinit the MDCT lookups.  1.1 libvorbis
                          is planned to be able to switch on the fly */
Michael Smith's avatar
   
Michael Smith committed
942
  
Monty's avatar
   
Monty committed
943
944
945
946
947
948
949
950
951
952
953
954
955
956
  for(i=0;i<vf->links;i++){
    if(vorbis_synthesis_halfrate(vf->vi+i,flag)){
      ov_halfrate(vf,0);
      return OV_EINVAL;
    }
  }
  return 0;
}

int ov_halfrate_p(OggVorbis_File *vf){
  if(vf->vi==NULL)return OV_EINVAL;
  return vorbis_synthesis_halfrate_p(vf->vi);
}

Monty's avatar
   
Monty committed
957
958
959
960
/* Only partially open the vorbis file; test for Vorbisness, and load
   the headers for the first chain.  Do not seek (although test for
   seekability).  Use ov_test_open to finish opening the file, else
   ov_clear to close/free it. Same return codes as open. */
Michael Smith's avatar
   
Michael Smith committed
961

Monty's avatar
   
Monty committed
962
int ov_test_callbacks(void *f,OggVorbis_File *vf,char *initial,long ibytes,
Michael Smith's avatar
   
Michael Smith committed
963
964
    ov_callbacks callbacks)
{
Monty's avatar
   
Monty committed
965
966
  return _ov_open1(f,vf,initial,ibytes,callbacks);
}
Monty's avatar
   
Monty committed
967

Monty's avatar
   
Monty committed
968
969
970
971
972
973
974
int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
  ov_callbacks callbacks = {
    (size_t (*)(void *, size_t, size_t, void *))  fread,
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Monty's avatar
   
Monty committed
975

Monty's avatar
   
Monty committed
976
977
978
979
980
981
  return ov_test_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
  
int ov_test_open(OggVorbis_File *vf){
  if(vf->ready_state!=PARTOPEN)return(OV_EINVAL);
  return _ov_open2(vf);
Monty's avatar
   
Monty committed
982
983
}

Monty's avatar
   
Monty committed
984
/* How many logical bitstreams in this physical bitstream? */
Monty's avatar
   
Monty committed
985
986
long ov_streams(OggVorbis_File *vf){
  return vf->links;
Monty's avatar
   
Monty committed
987
988
}

Monty's avatar
   
Monty committed
989
/* Is the FILE * associated with vf seekable? */
Monty's avatar
   
Monty committed
990
991
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
Monty's avatar
   
Monty committed
992
993
}

Monty's avatar
   
Monty committed
994
995
996
997
998
999
1000
/* 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
For faster browsing, not all history is shown. View entire blame