liboggz: oggz_read.h Source File

liboggz 1.1.1

oggz_read.h
Go to the documentation of this file.
1 /*
2 Copyright (C) 2003 Commonwealth Scientific and Industrial Research
3 Organisation (CSIRO) Australia
4
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
7 are met:
8
9 - Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11
12 - Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in the
14 documentation and/or other materials provided with the distribution.
15
16 - Neither the name of CSIRO Australia nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
19
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
24 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef __OGGZ_READ_H__
34 #define __OGGZ_READ_H__
35
40 #include <oggz/oggz_packet.h>
41
81 typedef int (*OggzReadPacket) (OGGZ * oggz, oggz_packet * packet, long serialno,
82 void * user_data);
83
108 int oggz_set_read_callback (OGGZ * oggz, long serialno,
109 OggzReadPacket read_packet, void * user_data);
110
121 typedef int (*OggzReadPage) (OGGZ * oggz, const ogg_page * og,
122 long serialno, void * user_data);
123
146 int oggz_set_read_page (OGGZ * oggz, long serialno,
147 OggzReadPage read_page, void * user_data);
148
149
166 long oggz_read (OGGZ * oggz, long n);
167
183 long oggz_read_input (OGGZ * oggz, unsigned char * buf, long n);
184
198 int oggz_purge (OGGZ * oggz);
199
211 OggzStreamContent oggz_stream_get_content (OGGZ * oggz, long serialno);
212
222 const char * oggz_stream_get_content_type (OGGZ *oggz, long serialno);
223
236 int oggz_stream_get_numheaders (OGGZ * oggz, long serialno);
237
238 #endif /* __OGGZ_READ_H__ */
oggz_stream_get_numheaders
int oggz_stream_get_numheaders(OGGZ *oggz, long serialno)
Determine the number of headers of the oggz stream referred to by serialno.
oggz_packet.h
oggz_set_read_page
int oggz_set_read_page(OGGZ *oggz, long serialno, OggzReadPage read_page, void *user_data)
Set a callback for Oggz to call when a new Ogg page is found in the stream.
OGGZ
void OGGZ
An opaque handle to an Ogg file.
Definition: oggz.h:441
oggz_set_read_callback
int oggz_set_read_callback(OGGZ *oggz, long serialno, OggzReadPacket read_packet, void *user_data)
Set a callback for Oggz to call when a new Ogg packet is found in the stream.
oggz_stream_get_content_type
const char * oggz_stream_get_content_type(OGGZ *oggz, long serialno)
Return human-readable string representation of content type of oggz stream referred to by serialno.
oggz_packet
An ogg_packet and its position in the stream.
Definition: oggz_packet.h:84
OggzStreamContent
OggzStreamContent
Definition of stream content types.
Definition: oggz_constants.h:106
oggz_read
long oggz_read(OGGZ *oggz, long n)
Read n bytes into oggz, calling any read callbacks on the fly.
OggzReadPacket
int(* OggzReadPacket)(OGGZ *oggz, oggz_packet *packet, long serialno, void *user_data)
This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...
Definition: oggz_read.h:81
OggzReadPage
int(* OggzReadPage)(OGGZ *oggz, const ogg_page *og, long serialno, void *user_data)
This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...
Definition: oggz_read.h:121
oggz_stream_get_content
OggzStreamContent oggz_stream_get_content(OGGZ *oggz, long serialno)
Determine the content type of the oggz stream referred to by serialno.
oggz_read_input
long oggz_read_input(OGGZ *oggz, unsigned char *buf, long n)
Input data into oggz.
oggz_purge
int oggz_purge(OGGZ *oggz)
Erase any input buffered in Oggz.