oggz_read.c 12.6 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

conrad's avatar
conrad committed
70 71
#define oggz_off_t long

andre's avatar
andre committed
72 73 74 75 76 77 78 79 80 81 82 83
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
84 85 86
  reader->read_page = NULL;
  reader->read_page_user_data = NULL;

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

  return oggz;
}

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

97
  ogg_stream_clear (&reader->ogg_stream);
andre's avatar
andre committed
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
  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
123
#if 0
andre's avatar
andre committed
124
    if (stream == NULL) return OGGZ_ERR_BAD_SERIALNO;
conrad's avatar
conrad committed
125 126 127 128
#else
    if (stream == NULL)
      stream = oggz_add_stream (oggz, serialno);
#endif
andre's avatar
andre committed
129 130 131 132 133 134 135 136

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

  return 0;
}

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

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

  reader =  &oggz->x.reader;

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

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
  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;
  }
167 168 169 170

  return 0;
}

andre's avatar
andre committed
171 172 173 174 175 176 177 178 179 180
/*
 * 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
181
static oggz_off_t
andre's avatar
andre committed
182 183 184 185 186 187 188
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
189
  oggz_off_t page_offset = 0, ret;
andre's avatar
andre committed
190 191 192 193 194 195 196 197 198
  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);
199
      if ((bytes = oggz_io_read (oggz, buffer, CHUNKSIZE)) == 0) {
200
#if 0
conrad's avatar
conrad committed
201 202 203 204
	if (ferror (oggz->file)) {
	  oggz_set_error (oggz, OGGZ_ERR_SYSTEM);
	  return -1;
	}
205
#endif
andre's avatar
andre committed
206 207 208 209 210 211 212 213 214 215 216
      }

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

      ogg_sync_wrote(&reader->ogg_sync, bytes);
#else
      return -2;
#endif
    } else if (more < 0) {
217
#ifdef DEBUG_VERBOSE
andre's avatar
andre committed
218 219 220 221
      printf ("get_next_page: skipped %ld bytes\n", -more);
#endif
      page_offset -= more;
    } else {
222
#ifdef DEBUG_VERBOSE
andre's avatar
andre committed
223 224 225 226 227 228 229 230 231
      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) {
232
    oggz->offset = oggz_io_tell (oggz) - bytes + page_offset;
andre's avatar
andre committed
233 234 235 236 237 238 239 240 241 242
    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;
}

243
static int
andre's avatar
andre committed
244 245 246 247 248 249 250 251 252 253 254 255
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;

256 257
  int cb_ret = 0;

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

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

    if (reader->current_serialno != -1) {
266 267 268 269 270
    /* 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
271

272
      serialno = reader->current_serialno;
andre's avatar
andre committed
273

274
      stream = oggz_get_stream (oggz, serialno);
275

276 277 278 279 280
      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
281
	}
282 283
      }
      os = &stream->ogg_stream;
284

285
      result = ogg_stream_packetout(os, op);
andre's avatar
andre committed
286

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

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

298 299 300
	if (!stream->metric && (oggz->flags & OGGZ_AUTO)) {
	  oggz_auto (oggz, op, serialno, NULL);
	}
conrad's avatar
conrad committed
301

302
	/* set unit on last packet of page */
303 304 305
	if ((oggz->metric || stream->metric) && granulepos != -1) {
	  reader->current_unit = oggz_get_unit (oggz, serialno, granulepos);
	}
306

307 308 309 310 311 312
	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);
313
	}
andre's avatar
andre committed
314
      }
315 316 317
      else
	break;
    }
andre's avatar
andre committed
318
    }
319

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

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

326 327 328 329
    serialno = ogg_page_serialno (&og);
    reader->current_serialno = serialno; /* XXX: maybe not necessary */

    stream = oggz_get_stream (oggz, serialno);
330

331 332 333 334 335
    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
336
      }
337 338
    }
    os = &stream->ogg_stream;
andre's avatar
andre committed
339

340
    {
341 342 343
      ogg_int64_t granulepos;

      granulepos = ogg_page_granulepos (&og);
344

345 346 347 348
      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
349
      }
350
    }
351

352 353 354 355 356 357
    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);
358
    }
andre's avatar
andre committed
359 360

#if 0
361 362 363
    /* 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
364 365
#endif

366
    ogg_stream_pagein(os, &og);
andre's avatar
andre committed
367 368
  }

369
  return cb_ret;
andre's avatar
andre committed
370 371
}

372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
/* Map callback return values to error return values for oggz_read_*() */
static int
map_return_value_to_error (int cb_ret)
{
  switch (cb_ret) {
  case OGGZ_CONTINUE:
  case OGGZ_READ_EMPTY:
    return OGGZ_CONTINUE;
  case OGGZ_STOP_OK:
    return OGGZ_ERR_READ_STOP_OK;
  case OGGZ_STOP_ERR:
    return OGGZ_ERR_READ_STOP_ERR;
  default:
    return OGGZ_ERR_READ_STOP_ERR;
  }
}

andre's avatar
andre committed
389 390 391 392 393 394
long
oggz_read (OGGZ * oggz, long n)
{
  OggzReader * reader;
  char * buffer;
  long bytes, bytes_read = 1, remaining = n, nread = 0;
395
  int cb_ret = 0;
andre's avatar
andre committed
396 397 398 399 400 401 402

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

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

403 404 405 406 407
  if ((cb_ret = oggz->cb_next) != OGGZ_CONTINUE) {
    oggz->cb_next = 0;
    return map_return_value_to_error (cb_ret);
  }

andre's avatar
andre committed
408 409
  reader = &oggz->x.reader;

410
  cb_ret = oggz_read_sync (oggz);
andre's avatar
andre committed
411

412
#if 0
413
  if (cb_ret == OGGZ_READ_EMPTY) {
414 415
    /* If there's nothing to read yet, don't return 0 (eof) */
    if (reader->current_unit == 0) cb_ret = 0;
416 417 418 419 420 421 422
    else {
#if 0
      printf ("oggz_read: EMPTY, current_unit %ld != 0\n",
	      reader->current_unit);
      return 0;
#endif
    }
423
  }
424
#endif
425

426 427
  while (cb_ret != OGGZ_STOP_ERR && cb_ret != OGGZ_STOP_OK &&
	 bytes_read > 0 && remaining > 0) {
428
    bytes = MIN (remaining, CHUNKSIZE);
andre's avatar
andre committed
429
    buffer = ogg_sync_buffer (&reader->ogg_sync, bytes);
430
    if ((bytes_read = (long) oggz_io_read (oggz, buffer, bytes)) == 0) {
431 432 433 434
      /* schyeah! */
    }
    if (bytes_read == OGGZ_ERR_SYSTEM) {
      return OGGZ_ERR_SYSTEM;
andre's avatar
andre committed
435 436
    }

conrad's avatar
 
conrad committed
437 438 439 440 441 442 443 444
    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
445 446
  }

447
  if (cb_ret == OGGZ_STOP_ERR) oggz_purge (oggz);
448

449
  /* Don't return 0 unless it's actually an EOF condition */
450
  if (nread == 0) {
conrad's avatar
conrad committed
451 452 453 454 455 456 457
    switch (bytes_read) {
    case OGGZ_ERR_IO_AGAIN:
    case OGGZ_ERR_SYSTEM:
      return bytes_read; break;
    default: break;
    }

458 459 460 461 462
    return map_return_value_to_error (cb_ret);

  } else {
    if (cb_ret == OGGZ_READ_EMPTY) cb_ret = OGGZ_CONTINUE;
    oggz->cb_next = cb_ret;
463
  }
464

andre's avatar
andre committed
465 466 467 468 469 470 471 472 473 474
  return nread;
}

/* generic */
long
oggz_read_input (OGGZ * oggz, unsigned char * buf, long n)
{
  OggzReader * reader;
  char * buffer;
  long bytes, remaining = n, nread = 0;
475
  int cb_ret = 0;
andre's avatar
andre committed
476 477 478 479 480 481 482

  if (oggz == NULL) return OGGZ_ERR_BAD_OGGZ;

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

483 484 485 486 487
  if ((cb_ret = oggz->cb_next) != OGGZ_CONTINUE) {
    oggz->cb_next = 0;
    return map_return_value_to_error (cb_ret);
  }

andre's avatar
andre committed
488 489
  reader = &oggz->x.reader;

490 491
  cb_ret = oggz_read_sync (oggz);

492
#if 0
493
  if (cb_ret == OGGZ_READ_EMPTY) {
494 495 496 497
    /* If there's nothing to read yet, don't return 0 (eof) */
    if (reader->current_unit == 0) cb_ret = 0;
    else return 0;
  }
498
#endif
conrad's avatar
conrad committed
499

500 501
  while (cb_ret != OGGZ_STOP_ERR && cb_ret != OGGZ_STOP_OK  &&
	 /* !oggz->eos && */ remaining > 0) {
andre's avatar
andre committed
502 503 504 505 506 507 508 509 510
    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;

511
    cb_ret = oggz_read_sync (oggz);
andre's avatar
andre committed
512 513
  }

514
  if (cb_ret == OGGZ_STOP_ERR) oggz_purge (oggz);
515

516
  if (nread == 0) {
517 518
    /* Don't return 0 unless it's actually an EOF condition */
    if (cb_ret == OGGZ_READ_EMPTY) {
519
      return OGGZ_ERR_READ_STOP_OK;
520 521
    } else {
      return map_return_value_to_error (cb_ret);
522
    }
523 524 525
  } else {
    if (cb_ret == OGGZ_READ_EMPTY) cb_ret = OGGZ_CONTINUE;
    oggz->cb_next = cb_ret;
526
  }
527

andre's avatar
andre committed
528 529 530 531 532 533 534 535 536
  return nread;
}


#else /* OGGZ_CONFIG_READ */

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

537 538 539 540 541 542 543 544 545 546 547 548
OGGZ *
oggz_read_init (OGGZ * oggz)
{
  return NULL;
}

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

andre's avatar
andre committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
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