vorbisfile.c 30.5 KB
Newer Older
Monty's avatar
 
Monty committed
1 2 3 4 5 6 7
/********************************************************************
 *                                                                  *
 * THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE.  *
 * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
 * THE GNU PUBLIC LICENSE 2, WHICH IS INCLUDED WITH THIS SOURCE.    *
 * PLEASE READ THESE TERMS DISTRIBUTING.                            *
 *                                                                  *
Monty's avatar
 
Monty committed
8 9
 * THE OggSQUISH 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
Michael Smith's avatar
 
Michael Smith committed
15
 last mod: $Id: vorbisfile.c,v 1.20 2000/04/21 09:35:03 msmith 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>
Monty's avatar
 
Monty committed
23 24 25
#include "vorbis/codec.h"
#include "vorbis/vorbisfile.h"

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

/* 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
35 36 37 38
   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
39 40

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

/* 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
49 50
   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
51

Monty's avatar
 
Monty committed
52 53 54 55 56 57 58 59 60
/*************************************************************************
 * 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
61 62
  char *buffer=ogg_sync_buffer(&vf->oy,CHUNKSIZE);
  long bytes=(vf->callbacks.read_func)(buffer,1,CHUNKSIZE,vf->datasource);
Monty's avatar
 
Monty committed
63 64 65 66 67 68
  ogg_sync_wrote(&vf->oy,bytes);
  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
69
  (vf->callbacks.seek_func)(vf->datasource, offset, SEEK_SET);
Monty's avatar
 
Monty committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
  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

   return:   -1) did not find a page 
              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;

    if(boundary>0 && vf->offset>=boundary)return(-1);
    more=ogg_sync_pageseek(&vf->oy,og);
    
    if(more<0){
      /* skipped n bytes */
      vf->offset-=more;
    }else{
      if(more==0){
	/* send more paramedics */
	if(!boundary)return(-1);
	if(_get_data(vf)<=0)return(-1);
      }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. */
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);
      if(ret==-1){
	break;
      }else{
	offset=ret;
      }
    }
  }

  /* we have the offset.  Actually snork and hold the page now */
  _seek_helper(vf,offset);
  ret=_get_next_page(vf,og,CHUNKSIZE);
  if(ret==-1){
    /* this shouldn't be possible */
    fprintf(stderr,"Missed page fencepost at end of logical bitstream. "
	    "Exiting.\n");
    exit(1);
  }
  return(offset);
}

/* finds each bitstream link one at a time using a bisection search
   (has to begin by knowing the offset of the lb's initial page).
   Recurses for each link so it can alloc the link storage after
   finding them all, then unroll and fill the cache at the same time */
static void _bisect_forward_serialno(OggVorbis_File *vf,
				     long begin,
				     long searched,
				     long end,
				     long currentno,
				     long m){
  long endsearched=end;
  long next=end;
  ogg_page og;
Monty's avatar
 
Monty committed
162
  long ret;
Monty's avatar
 
Monty committed
163
  
Monty's avatar
 
Monty committed
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
  /* 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);
    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
184 185 186 187 188

  _seek_helper(vf,next);
  ret=_get_next_page(vf,&og,-1);
  
  if(searched>=end || ret==-1){
Monty's avatar
 
Monty committed
189 190 191 192
    vf->links=m+1;
    vf->offsets=malloc((m+2)*sizeof(long));
    vf->offsets[m+1]=searched;
  }else{
Monty's avatar
 
Monty committed
193
    _bisect_forward_serialno(vf,next,vf->offset,
Monty's avatar
 
Monty committed
194 195 196 197 198
			     end,ogg_page_serialno(&og),m+1);
  }
  
  vf->offsets[m]=begin;
}
Monty's avatar
 
Monty committed
199

Monty's avatar
 
Monty committed
200 201
/* uses the local ogg_stream storage in vf; this is important for
   non-streaming input sources */
Monty's avatar
 
Monty committed
202 203
static int _fetch_headers(OggVorbis_File *vf,vorbis_info *vi,vorbis_comment *vc,
			  long *serialno){
Monty's avatar
 
Monty committed
204 205 206
  ogg_page og;
  ogg_packet op;
  int i,ret;
Monty's avatar
 
Monty committed
207

Monty's avatar
 
Monty committed
208 209 210 211 212 213 214 215 216 217 218 219 220
  ret=_get_next_page(vf,&og,CHUNKSIZE);
  if(ret==-1){
    fprintf(stderr,"Did not find initial header for bitstream.\n");
    return -1;
  }
  
  if(serialno)*serialno=ogg_page_serialno(&og);
  ogg_stream_init(&vf->os,ogg_page_serialno(&og));
  
  /* 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
221
  vorbis_comment_init(vc);
Monty's avatar
 
Monty committed
222 223 224 225 226 227 228 229
  
  i=0;
  while(i<3){
    ogg_stream_pagein(&vf->os,&og);
    while(i<3){
      int result=ogg_stream_packetout(&vf->os,&op);
      if(result==0)break;
      if(result==-1){
Monty's avatar
 
Monty committed
230
	fprintf(stderr,"Corrupt header in logical bitstream.\n");
Monty's avatar
 
Monty committed
231 232
	goto bail_header;
      }
Monty's avatar
 
Monty committed
233
      if(vorbis_synthesis_headerin(vi,vc,&op)){
Monty's avatar
 
Monty committed
234
	fprintf(stderr,"Illegal header in logical bitstream.\n");
Monty's avatar
 
Monty committed
235 236 237 238 239 240
	goto bail_header;
      }
      i++;
    }
    if(i<3)
      if(_get_next_page(vf,&og,1)<0){
Monty's avatar
 
Monty committed
241
	fprintf(stderr,"Missing header in logical bitstream.\n");
Monty's avatar
 
Monty committed
242 243 244 245
	goto bail_header;
      }
  }
  return 0; 
Monty's avatar
 
Monty committed
246

Monty's avatar
 
Monty committed
247 248
 bail_header:
  vorbis_info_clear(vi);
Monty's avatar
 
Monty committed
249
  vorbis_comment_clear(vc);
Monty's avatar
 
Monty committed
250 251 252
  ogg_stream_clear(&vf->os);
  return -1;
}
Monty's avatar
 
Monty committed
253

Monty's avatar
 
Monty committed
254 255 256 257
/* 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
258 259
static void _prefetch_all_headers(OggVorbis_File *vf,vorbis_info *first_i,
				  vorbis_comment *first_c,
Monty's avatar
 
Monty committed
260
				  long dataoffset){
Monty's avatar
 
Monty committed
261 262 263
  ogg_page og;
  int i,ret;
  
Monty's avatar
 
Monty committed
264
  vf->vi=calloc(vf->links,sizeof(vorbis_info));
Monty's avatar
 
Monty committed
265
  vf->vc=calloc(vf->links,sizeof(vorbis_info));
Monty's avatar
 
Monty committed
266
  vf->dataoffsets=malloc(vf->links*sizeof(long));
Monty's avatar
 
Monty committed
267
  vf->pcmlengths=malloc(vf->links*sizeof(int64_t));
Monty's avatar
 
Monty committed
268 269 270
  vf->serialnos=malloc(vf->links*sizeof(long));
  
  for(i=0;i<vf->links;i++){
Monty's avatar
 
Monty committed
271
    if(first_i && first_c && i==0){
Monty's avatar
 
Monty committed
272 273
      /* we already grabbed the initial header earlier.  This just
         saves the waste of grabbing it again */
Monty's avatar
 
Monty committed
274 275
      memcpy(vf->vi+i,first_i,sizeof(vorbis_info));
      memcpy(vf->vc+i,first_c,sizeof(vorbis_comment));
Monty's avatar
 
Monty committed
276
      vf->dataoffsets[i]=dataoffset;
Monty's avatar
 
Monty committed
277
    }else{
Monty's avatar
 
Monty committed
278

Monty's avatar
 
Monty committed
279
      /* seek to the location of the initial header */
Monty's avatar
 
Monty committed
280

Monty's avatar
 
Monty committed
281
      _seek_helper(vf,vf->offsets[i]);
Monty's avatar
 
Monty committed
282
      if(_fetch_headers(vf,vf->vi+i,vf->vc+i,NULL)==-1){
Monty's avatar
 
Monty committed
283
	fprintf(stderr,"Error opening logical bitstream #%d.\n\n",i+1);
Monty's avatar
 
Monty committed
284 285
    	vf->dataoffsets[i]=-1;
      }else{
Monty's avatar
 
Monty committed
286
	vf->dataoffsets[i]=vf->offset;
Monty's avatar
 
Monty committed
287 288
        ogg_stream_clear(&vf->os);
      }
Monty's avatar
 
Monty committed
289
    }
Monty's avatar
 
Monty committed
290

Monty's avatar
 
Monty committed
291 292 293 294 295
    /* 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
296

Monty's avatar
 
Monty committed
297 298 299 300 301 302 303
      while(1){
	ret=_get_prev_page(vf,&og);
	if(ret==-1){
	  /* this should not be possible */
	  fprintf(stderr,"Could not find last page of logical "
		  "bitstream #%d\n\n",i);
	  vorbis_info_clear(vf->vi+i);
Monty's avatar
 
Monty committed
304
	  vorbis_comment_clear(vf->vc+i);
Monty's avatar
 
Monty committed
305 306 307 308 309 310 311 312 313 314
	  break;
	}
	if(ogg_page_frameno(&og)!=-1){
	  vf->serialnos[i]=ogg_page_serialno(&og);
	  vf->pcmlengths[i]=ogg_page_frameno(&og);
	  break;
	}
      }
    }
  }
Monty's avatar
 
Monty committed
315 316
}

Monty's avatar
 
Monty committed
317 318 319 320 321 322 323 324
static int _make_decode_ready(OggVorbis_File *vf){
  if(vf->decode_ready)exit(1);
  vorbis_synthesis_init(&vf->vd,vf->vi);
  vorbis_block_init(&vf->vd,&vf->vb);
  vf->decode_ready=1;
  return(0);
}

Monty's avatar
 
Monty committed
325
static int _open_seekable(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
326 327
  vorbis_info initial_i;
  vorbis_comment initial_c;
Monty's avatar
 
Monty committed
328 329
  long serialno,end;
  int ret;
Monty's avatar
 
Monty committed
330
  long dataoffset;
Monty's avatar
 
Monty committed
331 332 333
  ogg_page og;
  
  /* is this even vorbis...? */
Monty's avatar
 
Monty committed
334
  ret=_fetch_headers(vf,&initial_i,&initial_c,&serialno);
Monty's avatar
 
Monty committed
335
  dataoffset=vf->offset;
Monty's avatar
 
Monty committed
336 337 338 339 340
  ogg_stream_clear(&vf->os);
  if(ret==-1)return(-1);
  
  /* we can seek, so set out learning all about this file */
  vf->seekable=1;
Michael Smith's avatar
 
Michael Smith committed
341 342
  (vf->callbacks.seek_func)(vf->datasource,0,SEEK_END);
  vf->offset=vf->end=(vf->callbacks.tell_func)(vf->datasource);
Monty's avatar
 
Monty committed
343 344 345 346
  
  /* 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
347

Monty's avatar
 
Monty committed
348 349
  /* moer than one logical bitstream? */
  if(ogg_page_serialno(&og)!=serialno){
Monty's avatar
 
Monty committed
350

Monty's avatar
 
Monty committed
351 352 353
    /* Chained bitstream. Bisect-search each logical bitstream
       section.  Do so based on serial number only */
    _bisect_forward_serialno(vf,0,0,end+1,serialno,0);
Monty's avatar
 
Monty committed
354

Monty's avatar
 
Monty committed
355 356 357 358 359 360 361
  }else{

    /* Only one logical bitstream */
    _bisect_forward_serialno(vf,0,end,end+1,serialno,0);

  }

Monty's avatar
 
Monty committed
362
  _prefetch_all_headers(vf,&initial_i,&initial_c,dataoffset);
Monty's avatar
 
Monty committed
363
  ov_raw_seek(vf,0);
Monty's avatar
 
Monty committed
364 365 366 367 368 369 370 371

  return(0);
}

static int _open_nonseekable(OggVorbis_File *vf){
  /* we cannot seek. Set up a 'single' (current) logical bitstream entry  */
  vf->links=1;
  vf->vi=malloc(sizeof(vorbis_info));
Monty's avatar
 
Monty committed
372
  vf->vc=malloc(sizeof(vorbis_info));
Monty's avatar
 
Monty committed
373 374

  /* Try to fetch the headers, maintaining all the storage */
Monty's avatar
 
Monty committed
375
  if(_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno)==-1)return(-1);
Monty's avatar
 
Monty committed
376 377
  _make_decode_ready(vf);

Monty's avatar
 
Monty committed
378 379
  return 0;
}
Monty's avatar
 
Monty committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 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->pcm_offset=-1;
  vf->decode_ready=0;
}

/* fetch and process a packet.  Handles the case where we're at a
   bitstream boundary and dumps the decoding machine.  If the decoding
   machine is unloaded, it loads it.  It also keeps pcm_offset up to
   date (seek and read both use this.  seek uses a special hack with
   readp). 

   return: -1) hole in the data (lost packet) 
            0) need more date (only if readp==0)/eof
	    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
413
      int64_t frameno;
Monty's avatar
 
Monty committed
414 415 416 417 418
      
      if(result==-1)return(-1); /* hole in the data. alert the toplevel */
      if(result>0){
	/* got a packet.  process it */
	frameno=op.frameno;
Monty's avatar
 
Monty committed
419 420 421 422 423 424 425 426
	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 */
	  vorbis_synthesis_blockin(&vf->vd,&vf->vb);
Monty's avatar
 
Monty committed
427
	  
Monty's avatar
 
Monty committed
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
	  /* update the pcm offset. */
	  if(frameno!=-1){
	    int link=(vf->seekable?vf->current_link:0);
	    double **dummy;
	    int i,samples;
	    
	    /* this packet has a pcm_offset on it (the last packet
	       completed on a page carries the offset) After processing
	       (above), we know the pcm position of the *last* sample
	       ready to be returned. Find the offset of the *first* */
	    
	    samples=vorbis_synthesis_pcmout(&vf->vd,&dummy);
	    
	    frameno-=samples;
	    for(i=0;i<link;i++)
	      frameno+=vf->pcmlengths[i];
	    vf->pcm_offset=frameno;
	  }
	  return(1);
Monty's avatar
 
Monty committed
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
	}
      }
    }

    if(!readp)return(0);
    if(_get_next_page(vf,&og,-1)<0)return(0); /* eof. leave unitialized */

    /* 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;
	if(link==vf->links)return(-1); /* sign of a bogus stream.  error out,
					  leave machine uninitialized */
	
	vf->current_link=link;
Monty's avatar
 
Monty committed
487 488

	ogg_stream_init(&vf->os,vf->current_serialno);
Monty's avatar
 
Monty committed
489
	ogg_stream_reset(&vf->os); 
Monty's avatar
 
Monty committed
490

Monty's avatar
 
Monty committed
491 492 493 494
      }else{
	/* we're streaming */
	/* fetch the three header packets, build the info struct */
	
Monty's avatar
 
Monty committed
495
	_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno);
Monty's avatar
 
Monty committed
496 497 498 499
	vf->current_link++;
	link=0;
      }
      
Monty's avatar
 
Monty committed
500
      _make_decode_ready(vf);
Monty's avatar
 
Monty committed
501 502 503 504 505
    }
    ogg_stream_pagein(&vf->os,&og);
  }
}

Monty's avatar
 
Monty committed
506 507 508 509 510 511 512 513 514 515 516 517
/**********************************************************************
 * 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
518
      for(i=0;i<vf->links;i++){
Monty's avatar
 
Monty committed
519
	vorbis_info_clear(vf->vi+i);
Monty's avatar
 
Monty committed
520 521
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
 
Monty committed
522
      free(vf->vi);
Monty's avatar
 
Monty committed
523
      free(vf->vc);
Monty's avatar
 
Monty committed
524
    }
Monty's avatar
 
Monty committed
525
    if(vf->dataoffsets)free(vf->dataoffsets);
Monty's avatar
 
Monty committed
526 527 528 529
    if(vf->pcmlengths)free(vf->pcmlengths);
    if(vf->serialnos)free(vf->serialnos);
    if(vf->offsets)free(vf->offsets);
    ogg_sync_clear(&vf->oy);
Michael Smith's avatar
 
Michael Smith committed
530
    if(vf->datasource)(vf->callbacks.close_func)(vf->datasource);
Monty's avatar
 
Monty committed
531 532
    memset(vf,0,sizeof(OggVorbis_File));
  }
Monty's avatar
 
Monty committed
533
#ifdef DEBUG_LEAKS
Monty's avatar
 
Monty committed
534
  _VDBG_dump();
Monty's avatar
 
Monty committed
535
#endif
Monty's avatar
 
Monty committed
536
  return(0);
Monty's avatar
 
Monty committed
537
}
Monty's avatar
 
Monty committed
538

Monty's avatar
 
Monty committed
539 540
/* 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
541 542 543 544 545 546
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
 
Monty committed
547
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Michael Smith's avatar
 
Michael Smith committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561
  ov_callbacks callbacks = {
    fread,
    fseek,
    fclose,
    ftell};

  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
562 563 564
  int ret;

  memset(vf,0,sizeof(OggVorbis_File));
Michael Smith's avatar
 
Michael Smith committed
565 566
  vf->datasource=f;
  vf->callbacks = callbacks;
Monty's avatar
 
Monty committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587

  /* 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
588
    vf->datasource=NULL;
Monty's avatar
 
Monty committed
589 590 591 592 593
    ov_clear(vf);
  }
  return(ret);
}

Monty's avatar
 
Monty committed
594
/* How many logical bitstreams in this physical bitstream? */
Monty's avatar
 
Monty committed
595 596
long ov_streams(OggVorbis_File *vf){
  return vf->links;
Monty's avatar
 
Monty committed
597 598
}

Monty's avatar
 
Monty committed
599
/* Is the FILE * associated with vf seekable? */
Monty's avatar
 
Monty committed
600 601
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
Monty's avatar
 
Monty committed
602 603
}

Monty's avatar
 
Monty committed
604 605 606 607 608 609 610 611 612 613 614
/* returns the bitrate for a given logical bitstream or the entire
   physical bitstream.  If the file is open for random access, it will
   find the *actual* average bitrate.  If the file is streaming, it
   returns the nominal bitrate (if set) else the average of the
   upper/lower bounds (if set) else -1 (unset).

   If you want the actual bitrate field settings, get them from the
   vorbis_info structs */

long ov_bitrate(OggVorbis_File *vf,int i){
  if(i>=vf->links)return(-1);
Monty's avatar
 
Monty committed
615
  if(!vf->seekable && i!=0)return(ov_bitrate(vf,0));
Monty's avatar
 
Monty committed
616
  if(i<0){
Monty's avatar
 
Monty committed
617
    int64_t bits=0;
Monty's avatar
 
Monty committed
618 619
    int i;
    for(i=0;i<vf->links;i++)
Monty's avatar
 
Monty committed
620
      bits+=(vf->offsets[i+1]-vf->dataoffsets[i])*8;
Monty's avatar
 
Monty committed
621 622 623 624
    return(rint(bits/ov_time_total(vf,-1)));
  }else{
    if(vf->seekable){
      /* return the actual bitrate */
Monty's avatar
 
Monty committed
625
      return(rint((vf->offsets[i+1]-vf->dataoffsets[i])*8/ov_time_total(vf,i)));
Monty's avatar
 
Monty committed
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
    }else{
      /* return nominal if set */
      if(vf->vi[i].bitrate_nominal>0){
	return vf->vi[i].bitrate_nominal;
      }else{
	if(vf->vi[i].bitrate_upper>0){
	  if(vf->vi[i].bitrate_lower>0){
	    return (vf->vi[i].bitrate_upper+vf->vi[i].bitrate_lower)/2;
	  }else{
	    return vf->vi[i].bitrate_upper;
	  }
	}
	return(-1);
      }
    }
  }
}

/* Guess */
long ov_serialnumber(OggVorbis_File *vf,int i){
  if(i>=vf->links)return(-1);
  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
655 656 657 658
/* 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
659
long ov_raw_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
660 661
  if(!vf->seekable || i>=vf->links)return(-1);
  if(i<0){
Monty's avatar
 
Monty committed
662 663 664 665 666 667 668 669 670
    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
671

Monty's avatar
 
Monty committed
672 673 674 675
/* 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
676
int64_t ov_pcm_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
677 678
  if(!vf->seekable || i>=vf->links)return(-1);
  if(i<0){
Monty's avatar
 
Monty committed
679
    int64_t acc=0;
Monty's avatar
 
Monty committed
680 681 682 683 684 685 686 687
    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
688

Monty's avatar
 
Monty committed
689 690 691 692
/* 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
693
double ov_time_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
694 695
  if(!vf->seekable || i>=vf->links)return(-1);
  if(i<0){
Monty's avatar
 
Monty committed
696 697 698 699 700 701 702 703 704
    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
705

Monty's avatar
 
Monty committed
706 707 708 709
/* 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
710 711 712
   surprises). 

   returns zero on success, nonzero on failure */
Monty's avatar
 
Monty committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743

int ov_raw_seek(OggVorbis_File *vf,long pos){

  if(!vf->seekable)return(-1); /* don't dump machine if we can't seek */
  if(pos<0 || pos>vf->offsets[vf->links])goto seek_error;

  /* clear out decoding machine state */
  _decode_clear(vf);

  /* 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
     from a page has the 'frameno' field set, and that's how the
     helper updates the offset */

  switch(_process_packet(vf,1)){
  case 0:
    /* 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 -1:
    /* error! missing data or invalid bitstream structure */
    goto seek_error;
  default:
    /* all OK */
    break;
  }
Monty's avatar
 
Monty committed
744

Monty's avatar
 
Monty committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
  while(1){
    switch(_process_packet(vf,0)){
    case 0:
      /* the offset is set.  If it's a bogus bitstream with no offset
         information, it's not but that's not our fault.  We still run
         gracefully, we're just missing the offset */
      return(0);
    case -1:
      /* error! missing data or invalid bitstream structure */
      goto seek_error;
    default:
      /* continue processing packets */
      break;
    }
  }
  
 seek_error:
  /* dump the machine so we're in a known state */
  _decode_clear(vf);
  return -1;
Monty's avatar
 
Monty committed
765 766
}

Monty's avatar
 
Monty committed
767 768 769 770
/* seek to a sample offset relative to the decompressed pcm stream 

   returns zero on success, nonzero on failure */

Monty's avatar
 
Monty committed
771
int ov_pcm_seek(OggVorbis_File *vf,int64_t pos){
Monty's avatar
 
Monty committed
772
  int link=-1;
Monty's avatar
 
Monty committed
773
  int64_t total=ov_pcm_total(vf,-1);
Monty's avatar
 
Monty committed
774 775 776 777 778 779 780 781 782 783

  if(!vf->seekable)return(-1); /* don't dump machine if we can't seek */  
  if(pos<0 || pos>total)goto seek_error;

  /* 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
784
  /* search within the logical bitstream for the page with the highest
Monty's avatar
 
Monty committed
785 786 787 788 789
     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
790
    int64_t target=pos-total;
Monty's avatar
 
Monty committed
791 792 793 794 795 796 797
    long end=vf->offsets[link+1];
    long begin=vf->offsets[link];
    long best=begin;

    ogg_page og;
    while(begin<end){
      long bisect;
Monty's avatar
 
Monty committed
798
      long ret;
Monty's avatar
 
Monty committed
799 800 801 802 803 804 805 806
    
      if(end-begin<CHUNKSIZE){
	bisect=begin;
      }else{
	bisect=(end+begin)/2;
      }
    
      _seek_helper(vf,bisect);
Monty's avatar
 
Monty committed
807
      ret=_get_next_page(vf,&og,end-bisect);
Monty's avatar
 
Monty committed
808 809 810 811
      
      if(ret==-1){
	end=bisect;
      }else{
Monty's avatar
 
Monty committed
812
	int64_t frameno=ogg_page_frameno(&og);
Monty's avatar
 
Monty committed
813
	if(frameno<target){
Monty's avatar
 
Monty committed
814 815
	  best=ret;  /* raw offset of packet with frameno */ 
	  begin=vf->offset; /* raw offset of next packet */
Monty's avatar
 
Monty committed
816
	}else{
Monty's avatar
 
Monty committed
817
	  end=bisect;
Monty's avatar
 
Monty committed
818 819 820
	}
      }
    }
Monty's avatar
 
Monty committed
821

Monty's avatar
 
Monty committed
822 823 824 825
    /* found our page. seek to it (call raw_seek). */
    
    if(ov_raw_seek(vf,best))goto seek_error;
  }
Monty's avatar
 
Monty committed
826

Monty's avatar
 
Monty committed
827 828 829
  /* verify result */
  if(vf->pcm_offset>=pos)goto seek_error;
  if(pos>ov_pcm_total(vf,-1))goto seek_error;
Monty's avatar
 
Monty committed
830

Monty's avatar
 
Monty committed
831 832 833 834 835 836
  /* discard samples until we reach the desired position. Crossing a
     logical bitstream boundary with abandon is OK. */
  while(vf->pcm_offset<pos){
    double **pcm;
    long target=pos-vf->pcm_offset;
    long samples=vorbis_synthesis_pcmout(&vf->vd,&pcm);
Monty's avatar
 
Monty committed
837

Monty's avatar
 
Monty committed
838 839 840 841 842 843 844 845 846 847 848 849 850 851
    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;
  
 seek_error:
  /* dump machine so we're in a known state */
  _decode_clear(vf);
  return -1;
Monty's avatar
 
Monty committed
852
}
Monty's avatar
 
Monty committed
853

Monty's avatar
 
Monty committed
854 855
/* seek to a playback time relative to the decompressed pcm stream 
   returns zero on success, nonzero on failure */
Monty's avatar
 
Monty committed
856 857
int ov_time_seek(OggVorbis_File *vf,double seconds){
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
 
Monty committed
858

Monty's avatar
 
Monty committed
859
  int link=-1;
Monty's avatar
 
Monty committed
860
  int64_t pcm_total=ov_pcm_total(vf,-1);
Monty's avatar
 
Monty committed
861
  double time_total=ov_time_total(vf,-1);
Monty's avatar
 
Monty committed
862

Monty's avatar
 
Monty committed
863 864 865 866 867 868 869 870 871 872 873 874
  if(!vf->seekable)return(-1); /* don't dump machine if we can't seek */  
  if(seconds<0 || seconds>time_total)goto seek_error;
  
  /* 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
875
    int64_t target=pcm_total+(seconds-time_total)*vf->vi[link].rate;
Monty's avatar
 
Monty committed
876 877 878 879 880 881 882 883 884 885 886 887 888
    return(ov_pcm_seek(vf,target));
  }

 seek_error:
  /* dump machine so we're in a known state */
  _decode_clear(vf);
  return -1;
}

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

Monty's avatar
 
Monty committed
891
/* return PCM offset (sample) of next PCM sample to be read */
Monty's avatar
 
Monty committed
892
int64_t ov_pcm_tell(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
893 894
  return(vf->pcm_offset);
}
Monty's avatar
 
Monty committed
895

Monty's avatar
 
Monty committed
896
/* return time offset (seconds) of next PCM sample to be read */
Monty's avatar
 
Monty committed
897 898
double ov_time_tell(OggVorbis_File *vf){
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
 
Monty committed
899

Monty's avatar
 
Monty committed
900
  int link=-1;
Monty's avatar
 
Monty committed
901
  int64_t pcm_total=0;
Monty's avatar
 
Monty committed
902 903 904 905 906 907 908 909 910 911 912 913 914
  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);
      if(vf->pcm_offset>pcm_total)break;
    }
  }
Monty's avatar
 
Monty committed
915

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

Monty's avatar
 
Monty committed
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
/*  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
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
  }
}

/* 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
965 966
  }
}
Monty's avatar
 
Monty committed
967

Monty's avatar
 
Monty committed
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
/* 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)

   return values: -1) error/hole in data
                   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;

  while(1){
    if(vf->decode_ready){
      double **pcm;
      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;
	if(samples>length/bytespersample)samples=length/bytespersample;
	
	/* a tight loop to pack each size */
	{
Michael Smith's avatar
 
Michael Smith committed
1016
	  int val;
Monty's avatar
 
Monty committed
1017 1018 1019 1020
	  if(word==1){
	    int off=(sgned?0:128);
	    for(j=0;j<samples;j++)
	      for(i=0;i<channels;i++){
Michael Smith's avatar
 
Michael Smith committed
1021
		val=(int)(pcm[i][j]*128. + 0.5);
Monty's avatar
 
Monty committed
1022
		if(val>127)val=127;
Michael Smith's avatar
 
Michael Smith committed
1023
		else if(val<-128)val=-128;
Monty's avatar
 
Monty committed
1024 1025 1026 1027 1028 1029 1030 1031
		*buffer++=val+off;
	      }
	  }else{
	    int off=(sgned?0:32768);

	    if(bigendianp){
	      for(j=0;j<samples;j++)
		for(i=0;i<channels;i++){
Michael Smith's avatar
 
Michael Smith committed
1032
		  val=(int)(pcm[i][j]*32768. + 0.5);
Monty's avatar
 
Monty committed
1033
		  if(val>32767)val=32767;
Michael Smith's avatar
 
Michael Smith committed
1034
		  else if(val<-32768)val=-32768;
Monty's avatar
 
Monty committed
1035 1036 1037 1038 1039
		  val+=off;
		  *buffer++=(val>>8);
		  *buffer++=(val&0xff);
		}
	    }else{
Michael Smith's avatar
 
Michael Smith committed
1040
	      int val;
Monty's avatar
 
Monty committed
1041
	      for(j=0;j<samples;j++)
Michael Smith's avatar
 
Michael Smith committed
1042 1043
	 	for(i=0;i<channels;i++){
		  val=(int)(pcm[i][j]*32768. + 0.5);
Monty's avatar
 
Monty committed
1044
		  if(val>32767)val=32767;
Michael Smith's avatar
 
Michael Smith committed
1045
		  else if(val<-32768)val=-32768;
Monty's avatar
 
Monty committed
1046 1047 1048
		  val+=off;
		  *buffer++=(val&0xff);
		  *buffer++=(val>>8);
Michael Smith's avatar
 
Michael Smith committed
1049
	  	}
Monty's avatar
 
Monty committed
1050 1051 1052 1053 1054 1055 1056

	    }
	  }
	}
	
	vorbis_synthesis_read(&vf->vd,samples);
	vf->pcm_offset+=samples;
Monty's avatar
 
Monty committed
1057
	if(bitstream)*bitstream=vf->current_link;
Monty's avatar
 
Monty committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
	return(samples*bytespersample);
      }
    }

    /* suck in another packet */
    switch(_process_packet(vf,1)){
    case 0:
      return(0);
    case -1:
      return -1;
    default:
      break;
    }
  }
}
Monty's avatar
 
Monty committed
1073 1074 1075



Monty's avatar
 
Monty committed
1076