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 
00423 typedef void OGGZ;
00424 
00431 OGGZ * oggz_new (int flags);
00432 
00440 OGGZ * oggz_open (char * filename, int flags);
00441 
00449 OGGZ * oggz_open_stdio (FILE * file, int flags);
00450 
00459 int oggz_flush (OGGZ * oggz);
00460 
00468 int oggz_close (OGGZ * oggz);
00469 
00480 int oggz_get_bos (OGGZ * oggz, long serialno);
00481 
00492 int oggz_get_eos (OGGZ * oggz, long serialno);
00493 
00525 typedef int (*OggzReadPacket) (OGGZ * oggz, ogg_packet * op, long serialno,
00526                                void * user_data);
00527 
00551 int oggz_set_read_callback (OGGZ * oggz, long serialno,
00552                             OggzReadPacket read_packet, void * user_data);
00553 
00564 long oggz_read (OGGZ * oggz, long n);
00565 
00575 long oggz_read_input (OGGZ * oggz, unsigned char * buf, long n);
00576 
00663 typedef int (*OggzWriteHungry) (OGGZ * oggz, int empty, void * user_data);
00664 
00682 int oggz_write_set_hungry_callback (OGGZ * oggz,
00683                                     OggzWriteHungry hungry,
00684                                     int only_when_empty,
00685                                     void * user_data);
00723 int oggz_write_feed (OGGZ * oggz, ogg_packet * op, long serialno, int flush,
00724                      int * guard);
00725 
00740 long oggz_write_output (OGGZ * oggz, unsigned char * buf, long n);
00741 
00755 long oggz_write (OGGZ * oggz, long n);
00756 
00765 long oggz_write_get_next_page_size (OGGZ * oggz);
00766 
00906 int oggz_set_metric_linear (OGGZ * oggz, long serialno,
00907                             ogg_int64_t granule_rate_numerator,
00908                             ogg_int64_t granule_rate_denominator);
00909 
00927 typedef ogg_int64_t (*OggzMetric) (OGGZ * oggz, long serialno,
00928                                    ogg_int64_t granulepos, void * user_data);
00929 
00952 int oggz_set_metric (OGGZ * oggz, long serialno, OggzMetric metric,
00953                      void * user_data);
00954 
00962 ogg_int64_t oggz_tell_units (OGGZ * oggz);
00963 
00971 ogg_int64_t oggz_seek_units (OGGZ * oggz, ogg_int64_t units, int whence);
00972 
00973 #ifdef _UNIMPLEMENTED
00974 
01026 typedef int (*OggzOrder) (OGGZ * oggz, ogg_packet * op, void * target,
01027                          void * user_data);
01033 int oggz_set_order (OGGZ * oggz, long serialno, OggzOrder order,
01034                     void * user_data);
01035 
01036 long oggz_seek_byorder (OGGZ * oggz, void * target);
01037 
01038 #endif /* _UNIMPLEMENTED */
01039 
01050 int oggz_purge (OGGZ * oggz);
01051 
01065 int oggz_set_data_start (OGGZ * oggz, off_t offset);
01066 
01079 off_t oggz_tell (OGGZ * oggz);
01080 
01088 off_t oggz_seek (OGGZ * oggz, off_t offset, int whence);
01089 
01090 #ifdef _UNIMPLEMENTED
01091 long oggz_seek_packets (OGGZ * oggz, long serialno, long packets, int whence);
01092 #endif
01093 
01104 long oggz_serialno_new (OGGZ * oggz);
01105 
01106 #include <oggz/oggz_io.h>
01107 
01108 #endif /* __OGGZ_H__ */

Generated on Thu Apr 15 21:11:13 2004 for liboggz by doxygen 1.3.4