vorbisfile.c 30.1 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
Monty's avatar
 
Monty committed
15
 last mod: $Id: vorbisfile.c,v 1.14 2000/01/28 09:05:18 xiphmont Exp $
Monty's avatar
 
Monty committed
16 17 18

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

Monty's avatar
 
Monty committed
19
#include <stdlib.h>
Monty's avatar
 
Monty committed
20
#include <stdio.h>
Monty's avatar
 
Monty committed
21
#include <math.h>
Monty's avatar
 
Monty committed
22 23 24
#include "vorbis/codec.h"
#include "vorbis/vorbisfile.h"

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

/* 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
33 34 35 36
   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
37 38

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

/* 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
47 48
   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
49

Monty's avatar
 
Monty committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 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
/*************************************************************************
 * 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){
  char *buffer=ogg_sync_buffer(&vf->oy,4096);
  long bytes=fread(buffer,1,4096,vf->f);
  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){
  fseek(vf->f,offset,SEEK_SET);
  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
160
  long ret;
Monty's avatar
 
Monty committed
161
  
Monty's avatar
 
Monty committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
  /* the below guards against garbage seperating the last and
     first pages of two links. */
  while(searched<endsearched){
    long bisect;
    
    if(endsearched-searched<CHUNKSIZE){
      bisect=searched;
    }else{
      bisect=(searched+endsearched)/2;
    }
    
    _seek_helper(vf,bisect);
    ret=_get_next_page(vf,&og,-1);
    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
182 183 184 185 186

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

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

Monty's avatar
 
Monty committed
206 207 208 209 210 211 212 213 214 215 216 217 218
  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
219
  vorbis_comment_init(vc);
Monty's avatar
 
Monty committed
220 221 222 223 224 225 226 227
  
  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
228
	fprintf(stderr,"Corrupt header in logical bitstream.\n");
Monty's avatar
 
Monty committed
229 230
	goto bail_header;
      }
Monty's avatar
 
Monty committed
231
      if(vorbis_synthesis_headerin(vi,vc,&op)){
Monty's avatar
 
Monty committed
232
	fprintf(stderr,"Illegal header in logical bitstream.\n");
Monty's avatar
 
Monty committed
233 234 235 236 237 238
	goto bail_header;
      }
      i++;
    }
    if(i<3)
      if(_get_next_page(vf,&og,1)<0){
Monty's avatar
 
Monty committed
239
	fprintf(stderr,"Missing header in logical bitstream.\n");
Monty's avatar
 
Monty committed
240 241 242
	goto bail_header;
      }
  }
Monty's avatar
 
Monty committed
243
  ogg_stream_clear(&vf->os);
Monty's avatar
 
Monty committed
244
  return 0; 
Monty's avatar
 
Monty committed
245

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

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

Monty's avatar
 
Monty committed
277
      /* seek to the location of the initial header */
Monty's avatar
 
Monty committed
278

Monty's avatar
 
Monty committed
279
      _seek_helper(vf,vf->offsets[i]);
Monty's avatar
 
Monty committed
280
      if(_fetch_headers(vf,vf->vi+i,vf->vc+i,NULL)==-1){
Monty's avatar
 
Monty committed
281 282 283 284 285 286 287
	fprintf(stderr,"Error opening logical bitstream #%d.\n\n",i+1);
    
	ogg_stream_clear(&vf->os); /* clear local storage.  This is not
				      done in _fetch_headers, as that may
				      be called in a non-seekable stream
				      (in which case, we need to preserve
				      the stream local storage) */
Monty's avatar
 
Monty committed
288 289 290
	vf->dataoffsets[i]=-1;
      }else
	vf->dataoffsets[i]=vf->offset;
Monty's avatar
 
Monty committed
291
    }
Monty's avatar
 
Monty committed
292

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

Monty's avatar
 
Monty committed
299 300 301 302 303 304 305
      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
306
	  vorbis_comment_clear(vf->vc+i);
Monty's avatar
 
Monty committed
307 308 309 310 311 312 313 314 315 316
	  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
317 318
}

Monty's avatar
 
Monty committed
319
static int _open_seekable(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
320 321
  vorbis_info initial_i;
  vorbis_comment initial_c;
Monty's avatar
 
Monty committed
322 323
  long serialno,end;
  int ret;
Monty's avatar
 
Monty committed
324
  long dataoffset;
Monty's avatar
 
Monty committed
325 326 327
  ogg_page og;
  
  /* is this even vorbis...? */
Monty's avatar
 
Monty committed
328 329 330
  vorbis_info_init(&initial_i);
  vorbis_comment_init(&initial_c);
  ret=_fetch_headers(vf,&initial_i,&initial_c,&serialno);
Monty's avatar
 
Monty committed
331
  dataoffset=vf->offset;
Monty's avatar
 
Monty committed
332 333 334 335 336
  ogg_stream_clear(&vf->os);
  if(ret==-1)return(-1);
  
  /* we can seek, so set out learning all about this file */
  vf->seekable=1;
Monty's avatar
 
Monty committed
337
  fseek(vf->f,0,SEEK_END);
Monty's avatar
 
Monty committed
338 339 340 341 342
  vf->offset=vf->end=ftell(vf->f);
  
  /* 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
343

Monty's avatar
 
Monty committed
344 345
  /* moer than one logical bitstream? */
  if(ogg_page_serialno(&og)!=serialno){
Monty's avatar
 
Monty committed
346

Monty's avatar
 
Monty committed
347 348 349
    /* 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
350

Monty's avatar
 
Monty committed
351 352 353 354 355 356 357
  }else{

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

  }

Monty's avatar
 
Monty committed
358
  _prefetch_all_headers(vf,&initial_i,&initial_c,dataoffset);
Monty's avatar
 
Monty committed
359
  ov_raw_seek(vf,0);
Monty's avatar
 
Monty committed
360 361 362 363 364 365 366 367

  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
368 369

  /* Try to fetch the headers, maintaining all the storage */
Monty's avatar
 
Monty committed
370
  if(_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno)==-1)return(-1);
Monty's avatar
 
Monty committed
371
    
Monty's avatar
 
Monty committed
372 373
  return 0;
}
Monty's avatar
 
Monty committed
374 375 376 377 378 379 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

/* 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
407
      int64_t frameno;
Monty's avatar
 
Monty committed
408 409 410 411 412
      
      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
413 414 415 416 417 418 419 420
	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
421
	  
Monty's avatar
 
Monty committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
	  /* 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
441 442 443 444 445 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
	}
      }
    }

    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;
      }else{
	/* we're streaming */
	/* fetch the three header packets, build the info struct */
	
Monty's avatar
 
Monty committed
485
	_fetch_headers(vf,vf->vi,vf->vc,&vf->current_serialno);
Monty's avatar
 
Monty committed
486 487 488 489 490 491
	vf->current_link++;
	link=0;
      }
      
      /* reload */
      ogg_stream_init(&vf->os,vf->current_serialno);
Monty's avatar
 
Monty committed
492
      ogg_stream_reset(&vf->os,ogg_page_pageno(&og));
Monty's avatar
 
Monty committed
493 494 495 496 497 498 499 500
      vorbis_synthesis_init(&vf->vd,vf->vi+link);
      vorbis_block_init(&vf->vd,&vf->vb);
      vf->decode_ready=1;
    }
    ogg_stream_pagein(&vf->os,&og);
  }
}

Monty's avatar
 
Monty committed
501 502 503 504 505 506 507 508 509 510 511 512
/**********************************************************************
 * 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
513
      for(i=0;i<vf->links;i++){
Monty's avatar
 
Monty committed
514
	vorbis_info_clear(vf->vi+i);
Monty's avatar
 
Monty committed
515 516
	vorbis_comment_clear(vf->vc+i);
      }
Monty's avatar
 
Monty committed
517 518
      free(vf->vi);
    }
Monty's avatar
 
Monty committed
519
    if(vf->dataoffsets)free(vf->dataoffsets);
Monty's avatar
 
Monty committed
520 521 522 523 524 525 526 527
    if(vf->pcmlengths)free(vf->pcmlengths);
    if(vf->serialnos)free(vf->serialnos);
    if(vf->offsets)free(vf->offsets);
    ogg_sync_clear(&vf->oy);
    if(vf->f)fclose(vf->f);
    memset(vf,0,sizeof(OggVorbis_File));
  }
  return(0);
Monty's avatar
 
Monty committed
528
}
Monty's avatar
 
Monty committed
529

Monty's avatar
 
Monty committed
530 531
/* 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
532 533 534 535 536 537
   bitstream sections that are truncated/woogie. 

   return: -1) error
            0) OK
*/

Monty's avatar
 
Monty committed
538
int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes){
Monty's avatar
 
Monty committed
539
  long offset=fseek(f,0,SEEK_CUR);
Monty's avatar
 
Monty committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
  int ret;

  memset(vf,0,sizeof(OggVorbis_File));
  vf->f=f;

  /* 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){
    vf->f=NULL;
    ov_clear(vf);
Monty's avatar
 
Monty committed
567 568 569 570 571
  }else{
    ogg_stream_init(&vf->os,vf->current_serialno);
    vorbis_synthesis_init(&vf->vd,vf->vi);
    vorbis_block_init(&vf->vd,&vf->vb);
    vf->decode_ready=1;
Monty's avatar
 
Monty committed
572 573 574 575
  }
  return(ret);
}

Monty's avatar
 
Monty committed
576
/* How many logical bitstreams in this physical bitstream? */
Monty's avatar
 
Monty committed
577 578
long ov_streams(OggVorbis_File *vf){
  return vf->links;
Monty's avatar
 
Monty committed
579 580
}

Monty's avatar
 
Monty committed
581
/* Is the FILE * associated with vf seekable? */
Monty's avatar
 
Monty committed
582 583
long ov_seekable(OggVorbis_File *vf){
  return vf->seekable;
Monty's avatar
 
Monty committed
584 585
}

Monty's avatar
 
Monty committed
586 587 588 589 590 591 592 593 594 595 596
/* 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
597
  if(!vf->seekable && i!=0)return(ov_bitrate(vf,0));
Monty's avatar
 
Monty committed
598
  if(i<0){
Monty's avatar
 
Monty committed
599
    int64_t bits=0;
Monty's avatar
 
Monty committed
600 601
    int i;
    for(i=0;i<vf->links;i++)
Monty's avatar
 
Monty committed
602
      bits+=(vf->offsets[i+1]-vf->dataoffsets[i])*8;
Monty's avatar
 
Monty committed
603 604 605 606
    return(rint(bits/ov_time_total(vf,-1)));
  }else{
    if(vf->seekable){
      /* return the actual bitrate */
Monty's avatar
 
Monty committed
607
      return(rint((vf->offsets[i+1]-vf->dataoffsets[i])*8/ov_time_total(vf,i)));
Monty's avatar
 
Monty committed
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
    }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
637 638 639 640
/* 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
641
long ov_raw_total(OggVorbis_File *vf,int i){
Monty's avatar
 
Monty committed
642 643
  if(!vf->seekable || i>=vf->links)return(-1);
  if(i<0){
Monty's avatar
 
Monty committed
644 645 646 647 648 649 650 651 652
    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
653

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

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

Monty's avatar
 
Monty committed
688 689 690 691
/* 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
692 693 694
   surprises). 

   returns zero on success, nonzero on failure */
Monty's avatar
 
Monty committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725

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
726

Monty's avatar
 
Monty committed
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
  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
747 748
}

Monty's avatar
 
Monty committed
749 750 751 752
/* seek to a sample offset relative to the decompressed pcm stream 

   returns zero on success, nonzero on failure */

Monty's avatar
 
Monty committed
753
int ov_pcm_seek(OggVorbis_File *vf,int64_t pos){
Monty's avatar
 
Monty committed
754
  int link=-1;
Monty's avatar
 
Monty committed
755
  int64_t total=ov_pcm_total(vf,-1);
Monty's avatar
 
Monty committed
756 757 758 759 760 761 762 763 764 765

  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
766
  /* search within the logical bitstream for the page with the highest
Monty's avatar
 
Monty committed
767 768 769 770 771
     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
772
    int64_t target=pos-total;
Monty's avatar
 
Monty committed
773 774 775 776 777 778 779
    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
780
      long ret;
Monty's avatar
 
Monty committed
781 782 783 784 785 786 787 788
    
      if(end-begin<CHUNKSIZE){
	bisect=begin;
      }else{
	bisect=(end+begin)/2;
      }
    
      _seek_helper(vf,bisect);
Monty's avatar
 
Monty committed
789
      ret=_get_next_page(vf,&og,end-bisect);
Monty's avatar
 
Monty committed
790 791 792 793
      
      if(ret==-1){
	end=bisect;
      }else{
Monty's avatar
 
Monty committed
794
	int64_t frameno=ogg_page_frameno(&og);
Monty's avatar
 
Monty committed
795
	if(frameno<target){
Monty's avatar
 
Monty committed
796 797
	  best=ret;  /* raw offset of packet with frameno */ 
	  begin=vf->offset; /* raw offset of next packet */
Monty's avatar
 
Monty committed
798
	}else{
Monty's avatar
 
Monty committed
799
	  end=bisect;
Monty's avatar
 
Monty committed
800 801 802
	}
      }
    }
Monty's avatar
 
Monty committed
803

Monty's avatar
 
Monty committed
804 805 806 807
    /* found our page. seek to it (call raw_seek). */
    
    if(ov_raw_seek(vf,best))goto seek_error;
  }
Monty's avatar
 
Monty committed
808

Monty's avatar
 
Monty committed
809 810 811
  /* 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
812

Monty's avatar
 
Monty committed
813 814 815 816 817 818
  /* 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
819

Monty's avatar
 
Monty committed
820 821 822 823 824 825 826 827 828 829 830 831 832 833
    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
834
}
Monty's avatar
 
Monty committed
835

Monty's avatar
 
Monty committed
836 837
/* seek to a playback time relative to the decompressed pcm stream 
   returns zero on success, nonzero on failure */
Monty's avatar
 
Monty committed
838 839
int ov_time_seek(OggVorbis_File *vf,double seconds){
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
 
Monty committed
840

Monty's avatar
 
Monty committed
841
  int link=-1;
Monty's avatar
 
Monty committed
842
  int64_t pcm_total=ov_pcm_total(vf,-1);
Monty's avatar
 
Monty committed
843
  double time_total=ov_time_total(vf,-1);
Monty's avatar
 
Monty committed
844

Monty's avatar
 
Monty committed
845 846 847 848 849 850 851 852 853 854 855 856
  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
857
    int64_t target=pcm_total+(seconds-time_total)*vf->vi[link].rate;
Monty's avatar
 
Monty committed
858 859 860 861 862 863 864 865 866 867 868 869 870
    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
871 872
}

Monty's avatar
 
Monty committed
873
/* return PCM offset (sample) of next PCM sample to be read */
Monty's avatar
 
Monty committed
874
int64_t ov_pcm_tell(OggVorbis_File *vf){
Monty's avatar
 
Monty committed
875 876
  return(vf->pcm_offset);
}
Monty's avatar
 
Monty committed
877

Monty's avatar
 
Monty committed
878
/* return time offset (seconds) of next PCM sample to be read */
Monty's avatar
 
Monty committed
879 880
double ov_time_tell(OggVorbis_File *vf){
  /* translate time to PCM position and call ov_pcm_seek */
Monty's avatar
 
Monty committed
881

Monty's avatar
 
Monty committed
882
  int link=-1;
Monty's avatar
 
Monty committed
883
  int64_t pcm_total=0;
Monty's avatar
 
Monty committed
884 885 886 887 888 889 890 891 892 893 894 895 896
  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
897

Monty's avatar
 
Monty committed
898
  return(time_total+(vf->pcm_offset-pcm_total)/vf->vi[link].rate);
Monty's avatar
 
Monty committed
899 900
}

Monty's avatar
 
Monty committed
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
/*  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
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
  }
}

/* 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
947 948
  }
}
Monty's avatar
 
Monty committed
949

Monty's avatar
 
Monty committed
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 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 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
/* 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 */
	{
	  if(word==1){
	    int off=(sgned?0:128);
	    for(j=0;j<samples;j++)
	      for(i=0;i<channels;i++){
		int val=rint(pcm[i][j]*128.);
		if(val>127)val=127;
		if(val<-128)val=-128;
		*buffer++=val+off;
	      }
	  }else{
	    int off=(sgned?0:32768);

	    if(bigendianp){
	      for(j=0;j<samples;j++)
		for(i=0;i<channels;i++){
		  int val=rint(pcm[i][j]*32768.);
		  if(val>32767)val=32767;
		  if(val<-32768)val=-32768;
		  val+=off;
		  *buffer++=(val>>8);
		  *buffer++=(val&0xff);
		}
	    }else{
	      for(j=0;j<samples;j++)
		for(i=0;i<channels;i++){
		  int val=rint(pcm[i][j]*32768.);
		  if(val>32767)val=32767;
		  if(val<-32768)val=-32768;
		  val+=off;
		  *buffer++=(val&0xff);
		  *buffer++=(val>>8);
		}

	    }
	  }
	}
	
	vorbis_synthesis_read(&vf->vd,samples);
	vf->pcm_offset+=samples;
Monty's avatar
 
Monty committed
1037
	if(bitstream)*bitstream=vf->current_link;
Monty's avatar
 
Monty committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
	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
1053 1054 1055



Monty's avatar
 
Monty committed
1056