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 
00038 #include <ogg/ogg.h>
00039 #include <oggz/oggz_constants.h>
00040 #include <oggz/oggz_table.h>
00041 
00422 typedef void OGGZ;
00423 
00430 OGGZ * oggz_new (int flags);
00431 
00439 OGGZ * oggz_open (char * filename, int flags);
00440 
00448 OGGZ * oggz_open_stdio (FILE * file, int flags);
00449 
00458 int oggz_flush (OGGZ * oggz);
00459 
00467 int oggz_close (OGGZ * oggz);
00468 
00479 int oggz_get_bos (OGGZ * oggz, long serialno);
00480 
00491 int oggz_get_eos (OGGZ * oggz, long serialno);
00492 
00524 typedef int (*OggzReadPacket) (OGGZ * oggz, ogg_packet * op, long serialno,
00525                                void * user_data);
00526 
00550 int oggz_set_read_callback (OGGZ * oggz, long serialno,
00551                             OggzReadPacket read_packet, void * user_data);
00552 
00563 long oggz_read (OGGZ * oggz, long n);
00564 
00574 long oggz_read_input (OGGZ * oggz, unsigned char * buf, long n);
00575 
00662 typedef int (*OggzWriteHungry) (OGGZ * oggz, int empty, void * user_data);
00663 
00681 int oggz_write_set_hungry_callback (OGGZ * oggz,
00682                                     OggzWriteHungry hungry,
00683                                     int only_when_empty,
00684                                     void * user_data);
00722 int oggz_write_feed (OGGZ * oggz, ogg_packet * op, long serialno, int flush,
00723                      int * guard);
00724 
00739 long oggz_write_output (OGGZ * oggz, unsigned char * buf, long n);
00740 
00754 long oggz_write (OGGZ * oggz, long n);
00755 
00764 long oggz_write_get_next_page_size (OGGZ * oggz);
00765 
00905 int oggz_set_metric_linear (OGGZ * oggz, long serialno,
00906                             ogg_int64_t granule_rate_numerator,
00907                             ogg_int64_t granule_rate_denominator);
00908 
00926 typedef ogg_int64_t (*OggzMetric) (OGGZ * oggz, long serialno,
00927                                    ogg_int64_t granulepos, void * user_data);
00928 
00951 int oggz_set_metric (OGGZ * oggz, long serialno, OggzMetric metric,
00952                      void * user_data);
00953 
00961 ogg_int64_t oggz_seek_units (OGGZ * oggz, ogg_int64_t units, int whence);
00962 
00963 #ifdef _UNIMPLEMENTED
00964 
01016 typedef int (*OggzOrder) (OGGZ * oggz, ogg_packet * op, void * target,
01017                          void * user_data);
01023 int oggz_set_order (OGGZ * oggz, long serialno, OggzOrder order,
01024                     void * user_data);
01025 
01026 long oggz_seek_byorder (OGGZ * oggz, void * target);
01027 
01028 #endif /* _UNIMPLEMENTED */
01029 
01043 int oggz_set_data_start (OGGZ * oggz, off_t offset);
01044 
01057 off_t oggz_tell (OGGZ * oggz);
01058 
01066 off_t oggz_seek (OGGZ * oggz, off_t offset, int whence);
01067 
01068 #ifdef _UNIMPLEMENTED
01069 long oggz_seek_packets (OGGZ * oggz, long serialno, long packets, int whence);
01070 #endif
01071 
01082 long oggz_serialno_new (OGGZ * oggz);
01083 
01084 
01085 #endif /* __OGGZ_H__ */

Generated on Mon Feb 16 02:30:07 2004 for liboggz by doxygen 1.3.5