vorbisfile.c 64.7 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
    while(vf->offset<end){
157
      memset(og,0,sizeof(*og));
Monty's avatar
   
Monty committed
158
      ret=_get_next_page(vf,og,end-vf->offset);
Monty's avatar
   
Monty committed
159
160
      if(ret==OV_EREAD)return(OV_EREAD);
      if(ret<0){
Monty's avatar
   
Monty committed
161
162
163
164
165
166
167
	break;
      }else{
	offset=ret;
      }
    }
  }

168
169
  /* In a fully compliant, non-multiplexed stream, we'll still be
     holding the last page.  In multiplexed (or noncompliant streams),
170
     we will probably have to re-read the last page we saw */
171
172
173
  if(og->header_len==0){
    ret=_seek_helper(vf,offset);
    if(ret)return(ret);
174

175
176
177
178
179
    ret=_get_next_page(vf,og,CHUNKSIZE);
    if(ret<0)
      /* this shouldn't be possible */
      return(OV_EFAULT);
  }
Monty's avatar
   
Monty committed
180

Monty's avatar
   
Monty committed
181
182
183
  return(offset);
}

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
/* performs the same search as _get_prev_page, but prefers pages of
   the specified serial number. If a page of the specified serialno is
   spotted during the seek-back-and-read-forward, it will return the
   info of last page of the matching serial number instead of the very
   last page.  If no page of the specified serialno is seen, it will
   return the info of last page and alter *serialno.  */
static ogg_int64_t _get_prev_page_serial(OggVorbis_File *vf,int *serialno, ogg_int64_t *granpos){
  ogg_page og;
  ogg_int64_t begin=vf->offset;
  ogg_int64_t end=begin;
  ogg_int64_t ret;

  ogg_int64_t prefoffset=-1;
  ogg_int64_t offset=-1;
  ogg_int64_t ret_serialno;
  ogg_int64_t ret_gran;

  while(offset==-1){
    begin-=CHUNKSIZE;
    if(begin<0)
      begin=0;

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

    while(vf->offset<end){
      ret=_get_next_page(vf,&og,end-vf->offset);
      if(ret==OV_EREAD)return(OV_EREAD);
      if(ret<0){
	break;
      }else{
	ret_serialno=ogg_page_serialno(&og);
	ret_gran=ogg_page_granulepos(&og);
	offset=ret;

	if(ret_serialno == *serialno){
	  prefoffset=ret;
	  *granpos=ret_gran;
222
	}	
223
224
225
226
227
228
229
230
231
232
233
234
235
      }
    }
  }

  /* we're not interested in the page... just the serialno and granpos. */
  if(prefoffset>=0)return(prefoffset);

  *serialno = ret_serialno;
  *granpos = ret_gran;
  return(offset);

}

236
237
238
239
240
241
242
243
244
245
246
247
248
249
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 */
250
static int _lookup_serialno(long s, long *serialno_list, int n){
251
252
253
254
255
256
257
258
259
  if(serialno_list){
    while(n--){
      if(*serialno_list == s) return 1;
      serialno_list++;
    }
  }
  return 0;
}

260
261
262
static int _lookup_page_serialno(ogg_page *og, long *serialno_list, int n){
  long s = ogg_page_serialno(og);
  return _lookup_serialno(s,serialno_list,n);
Monty's avatar
   
Monty committed
263
}
Monty's avatar
   
Monty committed
264

Monty's avatar
   
Monty committed
265
266
/* uses the local ogg_stream storage in vf; this is important for
   non-streaming input sources */
Monty's avatar
   
Monty committed
267
static int _fetch_headers(OggVorbis_File *vf,vorbis_info *vi,vorbis_comment *vc,
268
			  long **serialno_list, int *serialno_n,
269
                          ogg_page *og_ptr){
Monty's avatar
   
Monty committed
270
271
  ogg_page og;
  ogg_packet op;
Monty's avatar
   
Monty committed
272
  int i,ret;
273
274
  int allbos=0;

Monty's avatar
   
Monty committed
275
  if(!og_ptr){
Monty's avatar
   
Monty committed
276
277
    ogg_int64_t llret=_get_next_page(vf,&og,CHUNKSIZE);
    if(llret==OV_EREAD)return(OV_EREAD);
278
    if(llret<0)return(OV_ENOTVORBIS);
Monty's avatar
   
Monty committed
279
280
281
    og_ptr=&og;
  }

Monty's avatar
   
Monty committed
282
  vorbis_info_init(vi);
Monty's avatar
   
Monty committed
283
  vorbis_comment_init(vc);
284
  vf->ready_state=OPENED;
285

286
287
288
289
290
  /* extract the serialnos of all BOS pages + the first set of vorbis
     headers we see in the link */

  while(ogg_page_bos(og_ptr)){
    if(serialno_list){
291
      if(_lookup_page_serialno(og_ptr,*serialno_list,*serialno_n)){
292
293
294
295
296
297
298
299
300
        /* a dupe serialnumber in an initial header packet set == invalid stream */
        if(*serialno_list)_ogg_free(*serialno_list);
        *serialno_list=0;
        *serialno_n=0;
        ret=OV_EBADHEADER;
        goto bail_header;
      }
      
      _add_serialno(og_ptr,serialno_list,serialno_n);
301
302
    }

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
    if(vf->ready_state<STREAMSET){
      /* we don't have a vorbis stream in this link yet, so begin
         prospective stream setup. We need a stream to get packets */
      ogg_stream_reset_serialno(&vf->os,ogg_page_serialno(og_ptr));
      ogg_stream_pagein(&vf->os,og_ptr);

      if(ogg_stream_packetout(&vf->os,&op) > 0 &&
         vorbis_synthesis_idheader(&op)){
        /* vorbis header; continue setup */
        vf->ready_state=STREAMSET;
        if((ret=vorbis_synthesis_headerin(vi,vc,&op))){
          ret=OV_EBADHEADER;
          goto bail_header;
        }
      }
    }
319

320
321
322
323
324
325
326
327
328
329
330
    /* get next page */
    {
      ogg_int64_t llret=_get_next_page(vf,og_ptr,CHUNKSIZE);
      if(llret==OV_EREAD){
        ret=OV_EREAD;
        goto bail_header;
      }
      if(llret<0){
        ret=OV_ENOTVORBIS;
        goto bail_header;
      }
331

332
333
334
335
336
337
338
339
      /* if this page also belongs to our vorbis stream, submit it and break */
      if(vf->ready_state==STREAMSET && 
         vf->os.serialno == ogg_page_serialno(og_ptr)){
        ogg_stream_pagein(&vf->os,og_ptr);
        break;
      } 
    } 
  }
340

341
342
343
344
  if(vf->ready_state!=STREAMSET){
    ret = OV_ENOTVORBIS;
    goto bail_header;
  }
345

346
347
348
349
350
351
352
353
354
355
356
357
358
  while(1){
  
    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;
        }
359
	
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
        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
389
390
      }
    }
391
392
    
    return 0; 
Monty's avatar
   
Monty committed
393
  }
Monty's avatar
   
Monty committed
394

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

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

403
404
405
406
407
408
409
410
411
412
/* Starting from current cursor position, get initial PCM offset of
   next page.  Consumes the page in the process without decoding
   audio, however this is only called during stream parsing upon
   seekable open. */
static ogg_int64_t _initial_pcmoffset(OggVorbis_File *vf, vorbis_info *vi){
  ogg_page    og;
  ogg_int64_t accumulated=0;
  long        lastblock=-1;
  int         result;
  int         serialno = vf->os.serialno;
Monty's avatar
   
Monty committed
413

414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
  while(1){
    ogg_packet op;
    if(_get_next_page(vf,&og,-1)<0)
      break; /* should not be possible unless the file is truncated/mangled */
       
    if(ogg_page_bos(&og)) break;
    if(ogg_page_serialno(&og)!=serialno) continue;
	
    /* 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(vi,&op);
	if(lastblock!=-1)
	  accumulated+=(lastblock+thisblock)>>2;
	lastblock=thisblock;
      }
    }
432

433
434
435
436
437
438
    if(ogg_page_granulepos(&og)!=-1){
      /* pcm offset of last packet on the first audio page */
      accumulated= ogg_page_granulepos(&og)-accumulated;
      break;
    }
  }
439

440
441
442
  /* 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;
Monty's avatar
   
Monty committed
443
  
444
445
  return accumulated;
}
Monty's avatar
   
Monty committed
446

447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
/* finds each bitstream link one at a time using a bisection search
   (has to begin by knowing the offset of the lb's initial page).
   Recurses for each link so it can alloc the link storage after
   finding them all, then unroll and fill the cache at the same time */
static int _bisect_forward_serialno(OggVorbis_File *vf,
				    ogg_int64_t begin,
				    ogg_int64_t searched,
				    ogg_int64_t end,
				    ogg_int64_t endgran,
				    int endserial,
				    long *currentno_list,
				    int  currentnos,
				    long m){
  ogg_int64_t pcmoffset;
  ogg_int64_t dataoffset=searched;
  ogg_int64_t endsearched=end;
  ogg_int64_t next=end;
  ogg_int64_t searchgran=-1;
  ogg_page og;
  ogg_int64_t ret,last;
  int serialno = vf->os.serialno;

  /* invariants: 
     we have the headers and serialnos for the link beginning at 'begin'
     we have the offset and granpos of the last page in the file (potentially 
       not a page we care about)
  */

  /* Is the last page in our list of current serialnumbers? */
  if(_lookup_serialno(endserial,currentno_list,currentnos)){

    /* last page is in the starting serialno list, so we've bisected
       down to (or just started with) a single link.  Now we need to
       find the last vorbis page belonging to the first vorbis stream
       for this link. */
    
    while(endserial != serialno){
      endserial = serialno;
      vf->offset=_get_prev_page_serial(vf,&endserial,&endgran);
    }
Monty's avatar
   
Monty committed
487

488
489
490
491
    vf->links=m+1;
    if(vf->offsets)_ogg_free(vf->offsets);
    if(vf->serialnos)_ogg_free(vf->serialnos);
    if(vf->dataoffsets)_ogg_free(vf->dataoffsets);
Monty's avatar
   
Monty committed
492

493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
    vf->offsets=_ogg_malloc((vf->links+1)*sizeof(*vf->offsets));
    vf->vi=_ogg_realloc(vf->vi,vf->links*sizeof(*vf->vi));
    vf->vc=_ogg_realloc(vf->vc,vf->links*sizeof(*vf->vc));
    vf->serialnos=_ogg_malloc(vf->links*sizeof(*vf->serialnos));
    vf->dataoffsets=_ogg_malloc(vf->links*sizeof(*vf->dataoffsets));
    vf->pcmlengths=_ogg_malloc(vf->links*2*sizeof(*vf->pcmlengths));

    vf->offsets[m+1]=end;
    vf->offsets[m]=begin;
    vf->pcmlengths[m*2+1]=endgran; 

  }else{
    
    long *next_serialno_list=NULL;
    int next_serialnos=0;
    vorbis_info vi;
    vorbis_comment vc;

    /* the below guards against garbage seperating the last and
       first pages of two links. */
    while(searched<endsearched){
      ogg_int64_t bisect;
      
      if(endsearched-searched<CHUNKSIZE){
	bisect=searched;
Monty's avatar
   
Monty committed
518
      }else{
519
	bisect=(searched+endsearched)/2;
Monty's avatar
   
Monty committed
520
      }
521
522
523
      
      ret=_seek_helper(vf,bisect);
      if(ret)return(ret);
Monty's avatar
   
Monty committed
524

525
526
527
528
529
530
531
532
533
      last=_get_next_page(vf,&og,-1);
      if(last==OV_EREAD)return(OV_EREAD);
      if(last<0 || !_lookup_page_serialno(&og,currentno_list,currentnos)){
	endsearched=bisect;
	if(last>=0)next=last;
      }else{
	searched=last+og.header_len+og.body_len;
      }
    }
Monty's avatar
   
Monty committed
534

535
    /* Bisection point found */
Monty's avatar
   
Monty committed
536

537
538
539
540
541
542
543
544
545
    /* for the time being, fetch end PCM offset the simple way */
    {
      int testserial = serialno+1;
      vf->offset = next;
      while(testserial != serialno){
	testserial = serialno;
	vf->offset=_get_prev_page_serial(vf,&testserial,&searchgran);
      }
    }
Monty's avatar
   
Monty committed
546

547
548
549
550
    if(vf->offset!=next){
      ret=_seek_helper(vf,next);
      if(ret)return(ret);
    }
Monty's avatar
   
Monty committed
551

552
553
554
555
    ret=_fetch_headers(vf,&vi,&vc,&next_serialno_list,&next_serialnos,NULL);
    if(ret)return(ret);
    serialno = vf->os.serialno;
    dataoffset = vf->offset;
556

557
558
559
    /* this will consume a page, however the next bistection always
       starts with a raw seek */
    pcmoffset = _initial_pcmoffset(vf,&vi);
Monty's avatar
   
Monty committed
560

561
562
563
564
565
566
567
568
569
    ret=_bisect_forward_serialno(vf,next,vf->offset,end,endgran,endserial,
				 next_serialno_list,next_serialnos,m+1);
    if(ret)return(ret);
    
    if(next_serialno_list)_ogg_free(next_serialno_list);
    
    vf->offsets[m+1]=next;
    vf->serialnos[m+1]=serialno;
    vf->dataoffsets[m+1]=dataoffset;
Monty's avatar
   
Monty committed
570

571
572
    vf->vi[m+1]=vi;
    vf->vc[m+1]=vc;
Monty's avatar
   
Monty committed
573

574
575
576
    vf->pcmlengths[m*2+1]=searchgran;
    vf->pcmlengths[m*2+2]=pcmoffset;
    vf->pcmlengths[m*2+3]-=pcmoffset;
Monty's avatar
   
Monty committed
577

Monty's avatar
   
Monty committed
578
  }
579
  return(0);
Monty's avatar
   
Monty committed
580
581
}

Monty's avatar
   
Monty committed
582
static int _make_decode_ready(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
583
584
  if(vf->ready_state>STREAMSET)return 0;
  if(vf->ready_state<STREAMSET)return OV_EFAULT;
Monty's avatar
   
Monty committed
585
  if(vf->seekable){
Monty's avatar
   
Monty committed
586
587
    if(vorbis_synthesis_init(&vf->vd,vf->vi+vf->current_link))
      return OV_EBADLINK;
Monty's avatar
   
Monty committed
588
  }else{
Monty's avatar
   
Monty committed
589
590
    if(vorbis_synthesis_init(&vf->vd,vf->vi))
      return OV_EBADLINK;
Monty's avatar
   
Monty committed
591
  }    
Monty's avatar
   
Monty committed
592
  vorbis_block_init(&vf->vd,&vf->vb);
Monty's avatar
   
Monty committed
593
  vf->ready_state=INITSET;
Monty's avatar
   
Monty committed
594
595
  vf->bittrack=0.f;
  vf->samptrack=0.f;
Monty's avatar
   
Monty committed
596
  return 0;
Monty's avatar
   
Monty committed
597
598
}

Monty's avatar
   
Monty committed
599
static int _open_seekable2(OggVorbis_File *vf){
600
601
602
  ogg_int64_t dataoffset=vf->dataoffsets[0],end,endgran=-1;
  int endserial=vf->os.serialno;
  int serialno=vf->os.serialno;
Monty's avatar
   
Monty committed
603
604
605

  /* we're partially open and have a first link header state in
     storage in vf */
606
607
608
609

  /* fetch initial PCM offset */
  ogg_int64_t pcmoffset = _initial_pcmoffset(vf,vf->vi);

Monty's avatar
   
Monty committed
610
  /* we can seek, so set out learning all about this file */
611
  if(vf->callbacks.seek_func && vf->callbacks.tell_func){
612
613
614
615
616
    (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;
  }
617
618
619
620

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

621
622
623
624
  /* Get the offset of the last page of the physical bitstream, or, if
     we're lucky the last vorbis page of this link as most OggVorbis
     files will contain a single logical bitstream */
  end=_get_prev_page_serial(vf,&endserial,&endgran);
625
626
  if(end<0)return(end);

627
  /* now determine bitstream structure recursively */
628
  if(_bisect_forward_serialno(vf,0,dataoffset,vf->offset,endgran,endserial,
629
630
631
632
633
634
635
			      vf->serialnos+2,vf->serialnos[1],0)<0)return(OV_EREAD);  

  vf->offsets[0]=0;
  vf->serialnos[0]=serialno;
  vf->dataoffsets[0]=dataoffset;
  vf->pcmlengths[0]=pcmoffset;
  vf->pcmlengths[1]-=pcmoffset;
Monty's avatar
   
Monty committed
636

637
  return(ov_raw_seek(vf,dataoffset));
Monty's avatar
   
Monty committed
638
}
Monty's avatar
   
Monty committed
639
640
641
642
643

/* 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
644
  vf->ready_state=OPENED;
Monty's avatar
   
Monty committed
645
646
647
648
649
650
651
652
}

/* 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
653
654
   return: <0) error, OV_HOLE (lost packet) or OV_EOF
            0) need more data (only if readp==0)
Monty's avatar
   
Monty committed
655
656
657
	    1) got a packet 
*/

Monty's avatar
   
Monty committed
658
659
static int _fetch_and_process_packet(OggVorbis_File *vf,
				     ogg_packet *op_in,
Monty's avatar
   
Monty committed
660
661
				     int readp,
				     int spanp){
Monty's avatar
   
Monty committed
662
663
664
665
666
667
668
669
  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
670
    if(vf->ready_state==INITSET){
671
672
      while(1) {
      	ogg_packet op;
Monty's avatar
   
Monty committed
673
674
      	ogg_packet *op_ptr=(op_in?op_in:&op);
	int result=ogg_stream_packetout(&vf->os,op_ptr);
675
676
	ogg_int64_t granulepos;

Monty's avatar
   
Monty committed
677
	op_in=NULL;
678
679
680
	if(result==-1)return(OV_HOLE); /* hole in the data. */
	if(result>0){
	  /* got a packet.  process it */
Monty's avatar
   
Monty committed
681
682
683
684
685
686
687
688
	  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 */
689
690
691
692

	    /* suck in the synthesis data and track bitrate */
	    {
	      int oldsamples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
   
Monty committed
693
694
695
696
	      /* for proper use of libvorbis within libvorbisfile,
                 oldsamples will always be zero. */
	      if(oldsamples)return(OV_EFAULT);
	      
697
698
	      vorbis_synthesis_blockin(&vf->vd,&vf->vb);
	      vf->samptrack+=vorbis_synthesis_pcmout(&vf->vd,NULL)-oldsamples;
Monty's avatar
   
Monty committed
699
	      vf->bittrack+=op_ptr->bytes*8;
700
	    }
Monty's avatar
   
Monty committed
701
	  
702
	    /* update the pcm offset. */
Monty's avatar
   
Monty committed
703
	    if(granulepos!=-1 && !op_ptr->e_o_s){
704
705
	      int link=(vf->seekable?vf->current_link:0);
	      int i,samples;
Monty's avatar
   
Monty committed
706
	    
707
708
709
710
711
712
713
714
715
716
	      /* 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
717
	         to have a reference point.  Thus the !op_ptr->e_o_s clause
718
	         above */
Monty's avatar
   
Monty committed
719
720
721

	      if(vf->seekable && link>0)
		granulepos-=vf->pcmlengths[link*2];
Monty's avatar
   
Monty committed
722
723
724
725
726
	      if(granulepos<0)granulepos=0; /* actually, this
					       shouldn't be possible
					       here unless the stream
					       is very broken */

727
	      samples=vorbis_synthesis_pcmout(&vf->vd,NULL);
Monty's avatar
   
Monty committed
728
	    
729
730
	      granulepos-=samples;
	      for(i=0;i<link;i++)
Monty's avatar
   
Monty committed
731
	        granulepos+=vf->pcmlengths[i*2+1];
732
733
734
	      vf->pcm_offset=granulepos;
	    }
	    return(1);
Monty's avatar
   
Monty committed
735
	  }
Monty's avatar
   
Monty committed
736
	}
737
738
	else 
	  break;
Monty's avatar
   
Monty committed
739
740
741
      }
    }

Monty's avatar
   
Monty committed
742
    if(vf->ready_state>=OPENED){
Michael Smith's avatar
Michael Smith committed
743
      ogg_int64_t ret;
744
745
746
747
748
749
750
751
752
753
754
755
      
      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
756
757
758

	/* bitrate tracking; add the header's bytes here, the body bytes
	   are done by packet above */
759
760
761
762
763
764
765
	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
766
	       2) another stream is multiplexed into this logical section */
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
	    
	    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
783
784
	  }
	}
785
786

	break;
Monty's avatar
   
Monty committed
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
      }
    }

    /* 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
802
    if(vf->ready_state!=INITSET){ 
Monty's avatar
   
Monty committed
803
      int link;
Monty's avatar
   
Monty committed
804
805
806

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

Monty's avatar
   
Monty committed
809
810
811
	  /* match the serialno to bitstream section.  We use this rather than
	     offset positions to avoid problems near logical bitstream
	     boundaries */
812

Monty's avatar
   
Monty committed
813
	  for(link=0;link<vf->links;link++)
814
815
816
817
818
819
820
	    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
821
822
	  vf->current_link=link;
	  
Monty's avatar
   
Monty committed
823
	  ogg_stream_reset_serialno(&vf->os,vf->current_serialno);
Monty's avatar
   
Monty committed
824
825
826
827
828
829
	  vf->ready_state=STREAMSET;
	  
	}else{
	  /* we're streaming */
	  /* fetch the three header packets, build the info struct */
	  
830
	  int ret=_fetch_headers(vf,vf->vi,vf->vc,NULL,NULL,&og);
Monty's avatar
   
Monty committed
831
	  if(ret)return(ret);
832
	  vf->current_serialno=vf->os.serialno;
Monty's avatar
   
Monty committed
833
834
835
	  vf->current_link++;
	  link=0;
	}
Monty's avatar
   
Monty committed
836
837
      }
      
Monty's avatar
   
Monty committed
838
839
840
841
      {
	int ret=_make_decode_ready(vf);
	if(ret<0)return ret;
      }
Monty's avatar
   
Monty committed
842
    }
843
844
845

    /* 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
846
    ogg_stream_pagein(&vf->os,&og);
847

Monty's avatar
   
Monty committed
848
849
850
  }
}

Monty's avatar
   
Monty committed
851
852
/* if, eg, 64 bit stdio is configured by default, this will build with
   fseek64 */
Monty's avatar
   
Monty committed
853
854
static int _fseek64_wrap(FILE *f,ogg_int64_t off,int whence){
  if(f==NULL)return(-1);
Monty's avatar
   
Monty committed
855
  return fseek(f,off,whence);
Monty's avatar
   
Monty committed
856
857
858
859
}

static int _ov_open1(void *f,OggVorbis_File *vf,char *initial,
		     long ibytes, ov_callbacks callbacks){
860
  int offsettest=((f && callbacks.seek_func)?callbacks.seek_func(f,0,SEEK_CUR):-1);
861
862
  long *serialno_list=NULL;
  int serialno_list_size=0;
Monty's avatar
   
Monty committed
863
  int ret;
864
  
865
  memset(vf,0,sizeof(*vf));
Monty's avatar
   
Monty committed
866
867
868
869
870
871
872
873
  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
874
875
     previously read data (especially as we may be reading from a
     non-seekable stream) */
Monty's avatar
   
Monty committed
876
877
878
879
880
881
882
  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
883
  if(offsettest!=-1)vf->seekable=1;
Monty's avatar
   
Monty committed
884
885
886
887

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

892
893
  /* Fetch all BOS pages, store the vorbis header and all seen serial
     numbers, load subsequent vorbis setup headers */
894
  if((ret=_fetch_headers(vf,vf->vi,vf->vc,&serialno_list,&serialno_list_size,NULL))<0){
Monty's avatar
   
Monty committed
895
896
    vf->datasource=NULL;
    ov_clear(vf);
897
898
899
900
901
902
903
904
  }else{
    /* serial number list for first link needs to be held somewhere
       for second stage of seekable stream open; this saves having to
       seek/reread first link's serialnumber data then. */
    vf->serialnos=_ogg_calloc(serialno_list_size+2,sizeof(*vf->serialnos));
    vf->serialnos[0]=vf->current_serialno;
    vf->serialnos[1]=serialno_list_size;
    memcpy(vf->serialnos+2,serialno_list,serialno_list_size*sizeof(*vf->serialnos));
905
906
907
908
909
    
    vf->offsets=_ogg_calloc(1,sizeof(*vf->offsets));
    vf->dataoffsets=_ogg_calloc(1,sizeof(*vf->dataoffsets));
    vf->offsets[0]=0;
    vf->dataoffsets[0]=vf->offset;
910
    vf->current_serialno=vf->os.serialno;
911

Monty's avatar
   
Monty committed
912
    vf->ready_state=PARTOPEN;
913
914
  }
  if(serialno_list)_ogg_free(serialno_list);
Monty's avatar
   
Monty committed
915
916
917
918
  return(ret);
}

static int _ov_open2(OggVorbis_File *vf){
Monty's avatar
   
Monty committed
919
920
  if(vf->ready_state != PARTOPEN) return OV_EINVAL;
  vf->ready_state=OPENED;
Monty's avatar
   
Monty committed
921
922
923
924
925
926
927
  if(vf->seekable){
    int ret=_open_seekable2(vf);
    if(ret){
      vf->datasource=NULL;
      ov_clear(vf);
    }
    return(ret);
Monty's avatar
   
Monty committed
928
929
930
  }else
    vf->ready_state=STREAMSET;

Monty's avatar
   
Monty committed
931
932
933
934
  return 0;
}


Monty's avatar
   
Monty committed
935
936
937
938
939
940
941
942
943
/* 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
944
      for(i=0;i<vf->links;i++){
Monty's avatar
   
Monty committed
945
	vorbis_info_clear(vf->vi+i);
Monty's avatar
   
Monty committed
946
947
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
   
Monty committed
948
949
      _ogg_free(vf->vi);
      _ogg_free(vf->vc);
Monty's avatar
   
Monty committed
950
    }
Monty's avatar
   
Monty committed
951
952
953
954
    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
955
    ogg_sync_clear(&vf->oy);
956
957
    if(vf->datasource && vf->callbacks.close_func)
      (vf->callbacks.close_func)(vf->datasource);
958
    memset(vf,0,sizeof(*vf));
Monty's avatar
   
Monty committed
959
  }
Monty's avatar
   
Monty committed
960
#ifdef DEBUG_LEAKS
Monty's avatar
   
Monty committed
961
  _VDBG_dump();
Monty's avatar
   
Monty committed
962
#endif
Monty's avatar
   
Monty committed
963
  return(0);
Monty's avatar
   
Monty committed
964
}
Monty's avatar
 
Monty committed
965

Monty's avatar
   
Monty committed
966
967
/* 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
968
969
970
971
972
973
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
   
Monty committed
974
975
976
977
978
979
980
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
981
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Michael Smith's avatar
   
Michael Smith committed
982
  ov_callbacks callbacks = {
Michael Smith's avatar
   
Michael Smith committed
983
    (size_t (*)(void *, size_t, size_t, void *))  fread,
Monty's avatar
   
Monty committed
984
    (int (*)(void *, ogg_int64_t, int))              _fseek64_wrap,
Michael Smith's avatar
   
Michael Smith committed
985
986
987
    (int (*)(void *))                             fclose,
    (long (*)(void *))                            ftell
  };
Michael Smith's avatar
   
Michael Smith committed
988
989
990

  return ov_open_callbacks((void *)f, vf, initial, ibytes, callbacks);
}
991
992
993
994
995
996
997
998
999
1000

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;
}
For faster browsing, not all history is shown. View entire blame