Main Page | Modules | File List | Globals

oggz.h

Go to the documentation of this file.
00001 /* 00002 Copyright (C) 2003 Commonwealth Scientific and Industrial Research 00003 Organisation (CSIRO) Australia 00004 00005 Redistribution and use in source and binary forms, with or without 00006 modification, are permitted provided that the following conditions 00007 are met: 00008 00009 - Redistributions of source code must retain the above copyright 00010 notice, this list of conditions and the following disclaimer. 00011 00012 - Redistributions in binary form must reproduce the above copyright 00013 notice, this list of conditions and the following disclaimer in the 00014 documentation and/or other materials provided with the distribution. 00015 00016 - Neither the name of CSIRO Australia nor the names of its 00017 contributors may be used to endorse or promote products derived from 00018 this software without specific prior written permission. 00019 00020 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 00021 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 00022 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 00023 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR 00024 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00025 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00026 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00027 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00028 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00029 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00030 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00031 */ 00032 00033 #ifndef __OGGZ_H__ 00034 #define __OGGZ_H__ 00035 00036 #include <stdio.h> 00037 #include <sys/types.h> 00038 00039 #include <ogg/ogg.h> 00040 #include <oggz/oggz_constants.h> 00041 #include <oggz/oggz_table.h> 00042 00043 #ifdef __cplusplus 00044 extern "C" { 00045 #endif 00046 00441 typedef void OGGZ; 00442 00449 OGGZ * oggz_new (int flags); 00450 00458 OGGZ * oggz_open (const char * filename, int flags); 00459 00467 OGGZ * oggz_open_stdio (FILE * file, int flags); 00468 00477 int oggz_flush (OGGZ * oggz); 00478 00486 int oggz_close (OGGZ * oggz); 00487 00498 int oggz_get_bos (OGGZ * oggz, long serialno); 00499 00510 int oggz_get_eos (OGGZ * oggz, long serialno); 00511 00543 typedef int (*OggzReadPacket) (OGGZ * oggz, ogg_packet * op, long serialno, 00544 void * user_data); 00545 00569 int oggz_set_read_callback (OGGZ * oggz, long serialno, 00570 OggzReadPacket read_packet, void * user_data); 00571 00586 long oggz_read (OGGZ * oggz, long n); 00587 00601 long oggz_read_input (OGGZ * oggz, unsigned char * buf, long n); 00602 00689 typedef int (*OggzWriteHungry) (OGGZ * oggz, int empty, void * user_data); 00690 00708 int oggz_write_set_hungry_callback (OGGZ * oggz, 00709 OggzWriteHungry hungry, 00710 int only_when_empty, 00711 void * user_data); 00749 int oggz_write_feed (OGGZ * oggz, ogg_packet * op, long serialno, int flush, 00750 int * guard); 00751 00766 long oggz_write_output (OGGZ * oggz, unsigned char * buf, long n); 00767 00781 long oggz_write (OGGZ * oggz, long n); 00782 00791 long oggz_write_get_next_page_size (OGGZ * oggz); 00792 00963 int oggz_set_metric_linear (OGGZ * oggz, long serialno, 00964 ogg_int64_t granule_rate_numerator, 00965 ogg_int64_t granule_rate_denominator); 00966 00984 typedef ogg_int64_t (*OggzMetric) (OGGZ * oggz, long serialno, 00985 ogg_int64_t granulepos, void * user_data); 00986 01009 int oggz_set_metric (OGGZ * oggz, long serialno, OggzMetric metric, 01010 void * user_data); 01011 01019 ogg_int64_t oggz_tell_units (OGGZ * oggz); 01020 01028 ogg_int64_t oggz_seek_units (OGGZ * oggz, ogg_int64_t units, int whence); 01029 01030 #ifdef _UNIMPLEMENTED 01031 01083 typedef int (*OggzOrder) (OGGZ * oggz, ogg_packet * op, void * target, 01084 void * user_data); 01090 int oggz_set_order (OGGZ * oggz, long serialno, OggzOrder order, 01091 void * user_data); 01092 01093 long oggz_seek_byorder (OGGZ * oggz, void * target); 01094 01095 #endif /* _UNIMPLEMENTED */ 01096 01107 int oggz_purge (OGGZ * oggz); 01108 01122 int oggz_set_data_start (OGGZ * oggz, off_t offset); 01123 01136 off_t oggz_tell (OGGZ * oggz); 01137 01145 off_t oggz_seek (OGGZ * oggz, off_t offset, int whence); 01146 01147 #ifdef _UNIMPLEMENTED 01148 long oggz_seek_packets (OGGZ * oggz, long serialno, long packets, int whence); 01149 #endif 01150 01161 long oggz_serialno_new (OGGZ * oggz); 01162 01163 #include <oggz/oggz_io.h> 01164 #include <oggz/oggz_deprecated.h> 01165 01166 #ifdef __cplusplus 01167 } 01168 #endif 01169 01170 #endif /* __OGGZ_H__ */

Generated on Wed Sep 8 15:08:05 2004 for liboggz by doxygen 1.3.8