oggz_read.c 14.3 KB
Newer Older
andre's avatar
andre committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
/*
   Copyright (C) 2003 Commonwealth Scientific and Industrial Research
   Organisation (CSIRO) Australia

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   - Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

   - Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

   - Neither the name of CSIRO Australia nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/*
 * oggz_read.c
 *
 * Conrad Parker <conrad@annodex.net>
 */

#include "config.h"

#if OGGZ_CONFIG_READ

#include <assert.h>
#include <stdlib.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
48

49
#ifdef HAVE_UNISTD_H
andre's avatar
andre committed
50
#include <unistd.h>
51 52
#endif

andre's avatar
andre committed
53 54 55 56 57 58 59
#include <fcntl.h>
#include <errno.h>
#include <string.h>
#include <time.h>

#include <ogg/ogg.h>

60
#include "oggz_compat.h"
andre's avatar
andre committed
61 62
#include "oggz_private.h"

63 64
/* #define DEBUG */
/* #define DEBUG_VERBOSE */
andre's avatar
andre committed
65

66
#define CHUNKSIZE 65536
andre's avatar
andre committed
67

68
#define OGGZ_READ_EMPTY (-404)
69

andre's avatar
andre committed
70 71 72 73 74 75 76 77 78 79 80 81
OGGZ *
oggz_read_init (OGGZ * oggz)
{
  OggzReader * reader = &oggz->x.reader;

  ogg_sync_init (&reader->ogg_sync);
  ogg_stream_init (&reader->ogg_stream, (int)-1);
  reader->current_serialno = -1;

  reader->read_packet = NULL;
  reader->read_user_data = NULL;

conrad's avatar
conrad committed
82 83 84
  reader->read_page = NULL;
  reader->read_page_user_data = NULL;

andre's avatar
andre committed
85 86 87 88 89 90 91 92 93 94
  reader->current_unit = 0;

  return oggz;
}

OGGZ *
oggz_read_close (OGGZ * oggz)
{
  OggzReader * reader = &oggz->x.reader;

95
  ogg_stream_clear (&reader->ogg_stream);
andre's avatar
andre committed
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
  ogg_sync_clear (&reader->ogg_sync);

  return oggz;
}

int
oggz_set_read_callback (OGGZ * oggz, long serialno,
			OggzReadPacket read_packet, void * user_data)
{
  OggzReader * reader;
  oggz_stream_t * stream;

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

  reader =  &oggz->x.reader;

  if (oggz->flags & OGGZ_WRITE) {
    return OGGZ_ERR_INVALID;
  }

  if (serialno == -1) {
    reader->read_packet = read_packet;
    reader->read_user_data = user_data;
  } else {
    stream = oggz_get_stream (oggz, serialno);
conrad's avatar
conrad committed
121
#if 0
andre's avatar
andre committed
122
    if (stream == NULL) return OGGZ_ERR_BAD_SERIALNO;
conrad's avatar
conrad committed
123 124 125 126
#else
    if (stream == NULL)
      stream = oggz_add_stream (oggz, serialno);
#endif
andre's avatar
andre committed
127 128 129 130 131 132 133 134

    stream->read_packet = read_packet;
    stream->read_user_data = user_data;
  }

  return 0;
}

135
int
136 137
oggz_set_read_page (OGGZ * oggz, long serialno, OggzReadPage read_page,
		    void * user_data)
138 139
{
  OggzReader * reader;
140
  oggz_stream_t * stream;
141 142 143 144 145 146 147 148 149

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

  reader =  &oggz->x.reader;

  if (oggz->flags & OGGZ_WRITE) {
    return OGGZ_ERR_INVALID;
  }

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
  if (serialno == -1) {
    reader->read_page = read_page;
    reader->read_page_user_data = user_data;
  } else {
    stream = oggz_get_stream (oggz, serialno);
#if 0
    if (stream == NULL) return OGGZ_ERR_BAD_SERIALNO;
#else
    if (stream == NULL)
      stream = oggz_add_stream (oggz, serialno);
#endif

    stream->read_page = read_page;
    stream->read_page_user_data = user_data;
  }
165 166 167 168

  return 0;
}

andre's avatar
andre committed
169 170 171 172 173 174 175 176 177 178
/*
 * oggz_get_next_page_7 (oggz, og, do_read)
 *
 * MODIFIED COPY OF CODE FROM BELOW SEEKING STUFF
 *
 * retrieves the next page.
 * returns >= 0 if found; return value is offset of page start
 * returns -1 on error
 * returns -2 if EOF was encountered
 */
conrad's avatar
conrad committed
179
static oggz_off_t
andre's avatar
andre committed
180 181 182 183 184 185 186
oggz_get_next_page_7 (OGGZ * oggz, ogg_page * og)
{
  OggzReader * reader = &oggz->x.reader;
#if _UNMODIFIED
  char * buffer;
#endif
  long bytes = 0, more;
conrad's avatar
conrad committed
187
  oggz_off_t page_offset = 0, ret;
andre's avatar
andre committed
188 189 190 191 192 193 194 195 196
  int found = 0;

  do {
    more = ogg_sync_pageseek (&reader->ogg_sync, og);

    if (more == 0) {
      page_offset = 0;
#if _UMMODIFIED_
      buffer = ogg_sync_buffer (&reader->ogg_sync, CHUNKSIZE);
197
      if ((bytes = oggz_io_read (oggz, buffer, CHUNKSIZE)) == 0) {
198
#if 0
conrad's avatar
conrad committed
199 200 201 202
	if (ferror (oggz->file)) {
	  oggz_set_error (oggz, OGGZ_ERR_SYSTEM);
	  return -1;
	}
203
#endif
andre's avatar
andre committed
204 205 206 207 208 209 210 211 212 213 214
      }

      if (bytes == 0) {
	return -2;
      }

      ogg_sync_wrote(&reader->ogg_sync, bytes);
#else
      return -2;
#endif
    } else if (more < 0) {
215
#ifdef DEBUG_VERBOSE
andre's avatar
andre committed
216 217 218 219
      printf ("get_next_page: skipped %ld bytes\n", -more);
#endif
      page_offset -= more;
    } else {
220
#ifdef DEBUG_VERBOSE
andre's avatar
andre committed
221 222 223 224 225 226 227 228 229
      printf ("get_next_page: page has %ld bytes\n", more);
#endif
      found = 1;
    }

  } while (!found);

  /* Calculate the byte offset of the page which was found */
  if (bytes > 0) {
230
    oggz->offset = oggz_io_tell (oggz) - bytes + page_offset;
andre's avatar
andre committed
231 232 233 234 235 236 237 238 239 240
    ret = oggz->offset;
  } else {
    /* didn't need to do any reading -- accumulate the page_offset */
    ret = oggz->offset + page_offset;
    oggz->offset += page_offset + more;
  }

  return ret;
}

241
static int
andre's avatar
andre committed
242 243 244 245 246 247 248 249 250 251 252 253
oggz_read_sync (OGGZ * oggz)
{
  OggzReader * reader = &oggz->x.reader;

  oggz_stream_t * stream;
  ogg_stream_state * os;
  ogg_packet * op;
  long serialno;

  ogg_packet packet;
  ogg_page og;

254 255
  int cb_ret = 0;

andre's avatar
andre committed
256 257 258 259 260
  /*os = &reader->ogg_stream;*/
  op = &packet;

  /* handle one packet.  Try to fetch it from current stream state */
  /* extract packets from page */
261
  while(cb_ret == 0) {
andre's avatar
andre committed
262 263

    if (reader->current_serialno != -1) {
264 265
    /* process a packet if we can.  If the machine isn't loaded,
       neither is a page */
266 267 268
      while(cb_ret == 0) {
        ogg_int64_t granulepos;
        int result;
andre's avatar
andre committed
269

270
        serialno = reader->current_serialno;
andre's avatar
andre committed
271

272
        stream = oggz_get_stream (oggz, serialno);
273

274 275 276 277 278 279 280 281
        if (stream == NULL) {
        	/* new stream ... check bos etc. */
        	if ((stream = oggz_add_stream (oggz, serialno)) == NULL) {
      	    /* error -- could not add stream */
      	    return -7;
        	}
        }
        os = &stream->ogg_stream;
282

283
        result = ogg_stream_packetout(os, op);
andre's avatar
andre committed
284

285
        if(result == -1) {
286
#ifdef DEBUG
287
        	printf ("oggz_read_sync: hole in the data\n");
288
#endif
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
          result = ogg_stream_packetout(os, op);
          if (result == -1) {
#ifdef DEBUG
            /*
             * libogg flags "holes in the data" (which are really 
             * inconsistencies in the page sequence number) by returning
             * -1.  This occurs in some files and pretty much doesn't matter,
             *  so we silently swallow the notification and reget the packet.
             *  If the result is *still* -1 then something strange is happening.
             */
            printf ("shouldn't get here");
#endif
            return -7;
          }
        }
andre's avatar
andre committed
304

305 306 307 308 309
        if(result > 0){
          int content;
          
	        /* got a packet.  process it */
	        granulepos = op->granulepos;
andre's avatar
andre committed
310

311
          content = oggz_stream_get_content(oggz, serialno);
shans's avatar
 
shans committed
312
  
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
          /*
           * if we have no metrics for this stream yet, then generate them
           */      
        	if 
          (
            (!stream->metric || (content == OGGZ_CONTENT_SKELETON)) 
            && 
            (oggz->flags & OGGZ_AUTO)
          ) 
          {
        	  oggz_auto_get_granulerate (oggz, op, serialno, NULL);
        	}

          /* attempt to determine granulepos for this packet */
          if (oggz->flags & OGGZ_AUTO) {
            reader->current_granulepos = 
              oggz_auto_calculate_granulepos (content, granulepos, stream, op); 
          } else {
            reader->current_granulepos = granulepos;
          }
          stream->last_granulepos = reader->current_granulepos;
334
        
335 336 337 338 339 340 341
        	/* set unit on last packet of page */
        	if 
          (
            (oggz->metric || stream->metric) && reader->current_granulepos != -1
          ) 
          {
      	    reader->current_unit = oggz_get_unit (oggz, serialno, 
shans's avatar
 
shans committed
342
                                          reader->current_granulepos);
343 344 345 346 347 348 349 350 351 352 353 354
        	}

        	if (stream->read_packet) {
        	  cb_ret =
	            stream->read_packet (oggz, op, serialno, stream->read_user_data);
        	} else if (reader->read_packet) {
	          cb_ret =
      	      reader->read_packet (oggz, op, serialno, reader->read_user_data);
        	}
        }
        else
        	break;
andre's avatar
andre committed
355 356
      }
    }
357

358
    /* If we've got a stop already, don't read more data in */
359
    if (cb_ret == OGGZ_STOP_OK || cb_ret == OGGZ_STOP_ERR) return cb_ret;
andre's avatar
andre committed
360

361
    if(oggz_get_next_page_7 (oggz, &og) < 0)
362
      return OGGZ_READ_EMPTY; /* eof. leave uninitialized */
andre's avatar
andre committed
363

364 365 366 367
    serialno = ogg_page_serialno (&og);
    reader->current_serialno = serialno; /* XXX: maybe not necessary */

    stream = oggz_get_stream (oggz, serialno);
368

369 370 371
    if (stream == NULL) {
      /* new stream ... check bos etc. */
      if ((stream = oggz_add_stream (oggz, serialno)) == NULL) {
372 373
	      /* error -- could not add stream */
      	return -7;
andre's avatar
andre committed
374
      }
375 376 377 378 379 380 381 382 383 384

      /* identify stream type */
      oggz_auto_identify(oggz, &og, serialno);
    }
    else if (oggz_stream_get_content(oggz, serialno) == OGGZ_CONTENT_ANXDATA)
    {
      /*
       * re-identify ANXDATA streams as these are now content streams
       */
      oggz_auto_identify(oggz, &og, serialno);
385
    }
386
    
387
    os = &stream->ogg_stream;
andre's avatar
andre committed
388

389
    {
390 391 392
      ogg_int64_t granulepos;

      granulepos = ogg_page_granulepos (&og);
393
      stream->page_granulepos = granulepos;
394

395
      if ((oggz->metric || stream->metric) && granulepos != -1) {
396
       reader->current_unit = oggz_get_unit (oggz, serialno, granulepos);
397
      } else if (granulepos == 0) {
398
       reader->current_unit = 0;
andre's avatar
andre committed
399
      }
400
    }
401

402 403
    if (stream->read_page) {
      cb_ret =
404
	      stream->read_page (oggz, &og, serialno, stream->read_page_user_data);
405 406
    } else if (reader->read_page) {
      cb_ret = reader->read_page (oggz, &og, serialno,
407
		  		  reader->read_page_user_data);
408
    }
andre's avatar
andre committed
409 410

#if 0
411 412 413
    /* bitrate tracking; add the header's bytes here, the body bytes
       are done by packet above */
    vf->bittrack+=og.header_len*8;
andre's avatar
andre committed
414 415
#endif

416
    ogg_stream_pagein(os, &og);
andre's avatar
andre committed
417 418
  }

419
  return cb_ret;
andre's avatar
andre committed
420 421 422 423 424 425 426 427
}

long
oggz_read (OGGZ * oggz, long n)
{
  OggzReader * reader;
  char * buffer;
  long bytes, bytes_read = 1, remaining = n, nread = 0;
428
  int cb_ret = 0;
andre's avatar
andre committed
429 430 431 432 433 434 435

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

  if (oggz->flags & OGGZ_WRITE) {
    return OGGZ_ERR_INVALID;
  }

436 437
  if ((cb_ret = oggz->cb_next) != OGGZ_CONTINUE) {
    oggz->cb_next = 0;
438
    return oggz_map_return_value_to_error (cb_ret);
439 440
  }

andre's avatar
andre committed
441 442
  reader = &oggz->x.reader;

443
  cb_ret = oggz_read_sync (oggz);
andre's avatar
andre committed
444

445
#if 0
446
  if (cb_ret == OGGZ_READ_EMPTY) {
447 448
    /* If there's nothing to read yet, don't return 0 (eof) */
    if (reader->current_unit == 0) cb_ret = 0;
449 450 451 452 453 454 455
    else {
#if 0
      printf ("oggz_read: EMPTY, current_unit %ld != 0\n",
	      reader->current_unit);
      return 0;
#endif
    }
456
  }
457
#endif
458

459 460
  while (cb_ret != OGGZ_STOP_ERR && cb_ret != OGGZ_STOP_OK &&
	 bytes_read > 0 && remaining > 0) {
461
    bytes = MIN (remaining, CHUNKSIZE);
andre's avatar
andre committed
462
    buffer = ogg_sync_buffer (&reader->ogg_sync, bytes);
463
    if ((bytes_read = (long) oggz_io_read (oggz, buffer, bytes)) == 0) {
464 465 466 467
      /* schyeah! */
    }
    if (bytes_read == OGGZ_ERR_SYSTEM) {
      return OGGZ_ERR_SYSTEM;
andre's avatar
andre committed
468 469
    }

conrad's avatar
 
conrad committed
470 471 472 473 474 475 476 477
    if (bytes_read > 0) {
      ogg_sync_wrote (&reader->ogg_sync, bytes_read);
      
      remaining -= bytes_read;
      nread += bytes_read;
      
      cb_ret = oggz_read_sync (oggz);
    }
andre's avatar
andre committed
478 479
  }

480
  if (cb_ret == OGGZ_STOP_ERR) oggz_purge (oggz);
481

482
  /* Don't return 0 unless it's actually an EOF condition */
483
  if (nread == 0) {
conrad's avatar
conrad committed
484 485 486 487 488 489 490
    switch (bytes_read) {
    case OGGZ_ERR_IO_AGAIN:
    case OGGZ_ERR_SYSTEM:
      return bytes_read; break;
    default: break;
    }

491 492 493 494 495
    if (cb_ret == OGGZ_READ_EMPTY) {
      return 0;
    } else {
      return oggz_map_return_value_to_error (cb_ret);
    }
496 497 498 499

  } else {
    if (cb_ret == OGGZ_READ_EMPTY) cb_ret = OGGZ_CONTINUE;
    oggz->cb_next = cb_ret;
500
  }
501

andre's avatar
andre committed
502 503 504 505 506 507 508 509 510 511
  return nread;
}

/* generic */
long
oggz_read_input (OGGZ * oggz, unsigned char * buf, long n)
{
  OggzReader * reader;
  char * buffer;
  long bytes, remaining = n, nread = 0;
512
  int cb_ret = 0;
andre's avatar
andre committed
513 514 515 516 517 518 519

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

  if (oggz->flags & OGGZ_WRITE) {
    return OGGZ_ERR_INVALID;
  }

520 521
  if ((cb_ret = oggz->cb_next) != OGGZ_CONTINUE) {
    oggz->cb_next = 0;
522
    return oggz_map_return_value_to_error (cb_ret);
523 524
  }

andre's avatar
andre committed
525 526
  reader = &oggz->x.reader;

527 528
  cb_ret = oggz_read_sync (oggz);

529
#if 0
530
  if (cb_ret == OGGZ_READ_EMPTY) {
531 532 533 534
    /* If there's nothing to read yet, don't return 0 (eof) */
    if (reader->current_unit == 0) cb_ret = 0;
    else return 0;
  }
535
#endif
conrad's avatar
conrad committed
536

537 538
  while (cb_ret != OGGZ_STOP_ERR && cb_ret != OGGZ_STOP_OK  &&
	 /* !oggz->eos && */ remaining > 0) {
andre's avatar
andre committed
539 540 541 542 543 544 545 546 547
    bytes = MIN (remaining, 4096);
    buffer = ogg_sync_buffer (&reader->ogg_sync, bytes);
    memcpy (buffer, buf, bytes);
    ogg_sync_wrote (&reader->ogg_sync, bytes);

    buf += bytes;
    remaining -= bytes;
    nread += bytes;

548
    cb_ret = oggz_read_sync (oggz);
andre's avatar
andre committed
549 550
  }

551
  if (cb_ret == OGGZ_STOP_ERR) oggz_purge (oggz);
552

553
  if (nread == 0) {
554 555
    /* Don't return 0 unless it's actually an EOF condition */
    if (cb_ret == OGGZ_READ_EMPTY) {
556
      return OGGZ_ERR_STOP_OK;
557
    } else {
558
      return oggz_map_return_value_to_error (cb_ret);
559
    }
560 561 562
  } else {
    if (cb_ret == OGGZ_READ_EMPTY) cb_ret = OGGZ_CONTINUE;
    oggz->cb_next = cb_ret;
563
  }
564

andre's avatar
andre committed
565 566 567 568 569 570 571 572 573
  return nread;
}


#else /* OGGZ_CONFIG_READ */

#include <ogg/ogg.h>
#include "oggz_private.h"

574 575 576 577 578 579 580 581 582 583 584 585
OGGZ *
oggz_read_init (OGGZ * oggz)
{
  return NULL;
}

OGGZ *
oggz_read_close (OGGZ * oggz)
{
  return NULL;
}

andre's avatar
andre committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
int
oggz_set_read_callback (OGGZ * oggz, long serialno,
			OggzReadPacket read_packet, void * user_data)
{
  return OGGZ_ERR_DISABLED;
}

long
oggz_read (OGGZ * oggz, long n)
{
  return OGGZ_ERR_DISABLED;
}

long
oggz_read_input (OGGZ * oggz, unsigned char * buf, long n)
{
  return OGGZ_ERR_DISABLED;
}

#endif