oggz_read.c 13 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 63
#include "oggz_private.h"

/*#define DEBUG*/
conrad's avatar
conrad committed
64
/*#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 266 267 268
    /* process a packet if we can.  If the machine isn't loaded,
       neither is a page */
    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
      if (stream == NULL) {
	/* new stream ... check bos etc. */
	if ((stream = oggz_add_stream (oggz, serialno)) == NULL) {
	  /* error -- could not add stream */
	  return -7;
andre's avatar
andre committed
279
	}
280 281
      }
      os = &stream->ogg_stream;
282

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

285
      if(result == -1) {
286 287 288
#ifdef DEBUG
	printf ("oggz_read_sync: hole in the data\n");
#endif
289 290
	return -7;
      }
andre's avatar
andre committed
291

292 293 294
      if(result > 0){
	/* got a packet.  process it */
	granulepos = op->granulepos;
andre's avatar
andre committed
295

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
        /*
         * need to call oggz_auto to process Anx v2 streams which were headed
         * with AnxData packets.  This enables the AnxData-provided granulerate
         * to be overridden by the stream's rate if present
         */
	if 
        (
          (
            !stream->metric 
            || 
            (oggz_stream_get_content(oggz, serialno) == OGGZ_CONTENT_SKELETON)
          ) 
          && 
          (oggz->flags & OGGZ_AUTO)
        ) 
        {
	  oggz_auto_get_granulerate (oggz, op, serialno, NULL);
313
	}
conrad's avatar
conrad committed
314

315
	/* set unit on last packet of page */
316 317 318
	if ((oggz->metric || stream->metric) && granulepos != -1) {
	  reader->current_unit = oggz_get_unit (oggz, serialno, granulepos);
	}
319

320 321 322 323 324 325
	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);
326
	}
andre's avatar
andre committed
327
      }
328 329 330
      else
	break;
    }
andre's avatar
andre committed
331
    }
332

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

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

339 340 341 342
    serialno = ogg_page_serialno (&og);
    reader->current_serialno = serialno; /* XXX: maybe not necessary */

    stream = oggz_get_stream (oggz, serialno);
343

344 345 346 347 348
    if (stream == NULL) {
      /* new stream ... check bos etc. */
      if ((stream = oggz_add_stream (oggz, serialno)) == NULL) {
	/* error -- could not add stream */
	return -7;
andre's avatar
andre committed
349
      }
350 351 352 353 354 355 356 357 358 359

      /* 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);
360
    }
361
    
362
    os = &stream->ogg_stream;
andre's avatar
andre committed
363

364
    {
365 366 367
      ogg_int64_t granulepos;

      granulepos = ogg_page_granulepos (&og);
368

369 370 371 372
      if ((oggz->metric || stream->metric) && granulepos != -1) {
	reader->current_unit = oggz_get_unit (oggz, serialno, granulepos);
      } else if (granulepos == 0) {
	reader->current_unit = 0;
andre's avatar
andre committed
373
      }
374
    }
375

376 377 378 379 380 381
    if (stream->read_page) {
      cb_ret =
	stream->read_page (oggz, &og, serialno, stream->read_page_user_data);
    } else if (reader->read_page) {
      cb_ret = reader->read_page (oggz, &og, serialno,
				  reader->read_page_user_data);
382
    }
andre's avatar
andre committed
383 384

#if 0
385 386 387
    /* 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
388 389
#endif

390
    ogg_stream_pagein(os, &og);
andre's avatar
andre committed
391 392
  }

393
  return cb_ret;
andre's avatar
andre committed
394 395 396 397 398 399 400 401
}

long
oggz_read (OGGZ * oggz, long n)
{
  OggzReader * reader;
  char * buffer;
  long bytes, bytes_read = 1, remaining = n, nread = 0;
402
  int cb_ret = 0;
andre's avatar
andre committed
403 404 405 406 407 408 409

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

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

410 411
  if ((cb_ret = oggz->cb_next) != OGGZ_CONTINUE) {
    oggz->cb_next = 0;
412
    return oggz_map_return_value_to_error (cb_ret);
413 414
  }

andre's avatar
andre committed
415 416
  reader = &oggz->x.reader;

417
  cb_ret = oggz_read_sync (oggz);
andre's avatar
andre committed
418

419
#if 0
420
  if (cb_ret == OGGZ_READ_EMPTY) {
421 422
    /* If there's nothing to read yet, don't return 0 (eof) */
    if (reader->current_unit == 0) cb_ret = 0;
423 424 425 426 427 428 429
    else {
#if 0
      printf ("oggz_read: EMPTY, current_unit %ld != 0\n",
	      reader->current_unit);
      return 0;
#endif
    }
430
  }
431
#endif
432

433 434
  while (cb_ret != OGGZ_STOP_ERR && cb_ret != OGGZ_STOP_OK &&
	 bytes_read > 0 && remaining > 0) {
435
    bytes = MIN (remaining, CHUNKSIZE);
andre's avatar
andre committed
436
    buffer = ogg_sync_buffer (&reader->ogg_sync, bytes);
437
    if ((bytes_read = (long) oggz_io_read (oggz, buffer, bytes)) == 0) {
438 439 440 441
      /* schyeah! */
    }
    if (bytes_read == OGGZ_ERR_SYSTEM) {
      return OGGZ_ERR_SYSTEM;
andre's avatar
andre committed
442 443
    }

conrad's avatar
 
conrad committed
444 445 446 447 448 449 450 451
    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
452 453
  }

454
  if (cb_ret == OGGZ_STOP_ERR) oggz_purge (oggz);
455

456
  /* Don't return 0 unless it's actually an EOF condition */
457
  if (nread == 0) {
conrad's avatar
conrad committed
458 459 460 461 462 463 464
    switch (bytes_read) {
    case OGGZ_ERR_IO_AGAIN:
    case OGGZ_ERR_SYSTEM:
      return bytes_read; break;
    default: break;
    }

465 466 467 468 469
    if (cb_ret == OGGZ_READ_EMPTY) {
      return 0;
    } else {
      return oggz_map_return_value_to_error (cb_ret);
    }
470 471 472 473

  } else {
    if (cb_ret == OGGZ_READ_EMPTY) cb_ret = OGGZ_CONTINUE;
    oggz->cb_next = cb_ret;
474
  }
475

andre's avatar
andre committed
476 477 478 479 480 481 482 483 484 485
  return nread;
}

/* generic */
long
oggz_read_input (OGGZ * oggz, unsigned char * buf, long n)
{
  OggzReader * reader;
  char * buffer;
  long bytes, remaining = n, nread = 0;
486
  int cb_ret = 0;
andre's avatar
andre committed
487 488 489 490 491 492 493

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

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

494 495
  if ((cb_ret = oggz->cb_next) != OGGZ_CONTINUE) {
    oggz->cb_next = 0;
496
    return oggz_map_return_value_to_error (cb_ret);
497 498
  }

andre's avatar
andre committed
499 500
  reader = &oggz->x.reader;

501 502
  cb_ret = oggz_read_sync (oggz);

503
#if 0
504
  if (cb_ret == OGGZ_READ_EMPTY) {
505 506 507 508
    /* If there's nothing to read yet, don't return 0 (eof) */
    if (reader->current_unit == 0) cb_ret = 0;
    else return 0;
  }
509
#endif
conrad's avatar
conrad committed
510

511 512
  while (cb_ret != OGGZ_STOP_ERR && cb_ret != OGGZ_STOP_OK  &&
	 /* !oggz->eos && */ remaining > 0) {
andre's avatar
andre committed
513 514 515 516 517 518 519 520 521
    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;

522
    cb_ret = oggz_read_sync (oggz);
andre's avatar
andre committed
523 524
  }

525
  if (cb_ret == OGGZ_STOP_ERR) oggz_purge (oggz);
526

527
  if (nread == 0) {
528 529
    /* Don't return 0 unless it's actually an EOF condition */
    if (cb_ret == OGGZ_READ_EMPTY) {
530
      return OGGZ_ERR_STOP_OK;
531
    } else {
532
      return oggz_map_return_value_to_error (cb_ret);
533
    }
534 535 536
  } else {
    if (cb_ret == OGGZ_READ_EMPTY) cb_ret = OGGZ_CONTINUE;
    oggz->cb_next = cb_ret;
537
  }
538

andre's avatar
andre committed
539 540 541 542 543 544 545 546 547
  return nread;
}


#else /* OGGZ_CONFIG_READ */

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

548 549 550 551 552 553 554 555 556 557 558 559
OGGZ *
oggz_read_init (OGGZ * oggz)
{
  return NULL;
}

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

andre's avatar
andre committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
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