liboggplay  0.3.0
oggplay_reader.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 
41 #ifndef OGGPLAY_READER_HEADER
42 #define OGGPLAY_READER_HEADER
43 
44 #include <stdlib.h>
45 #include <oggz/oggz.h>
46 #include <ogg/ogg.h>
47 
48 typedef struct OggPlayReader_ OggPlayReader;
49 
51 typedef struct OggPlayReader_ {
52  OggPlayErrorCode (*initialise) (OggPlayReader *me, int block);
53  OggPlayErrorCode (*destroy) (OggPlayReader *me);
54  OggPlayErrorCode (*seek) (OggPlayReader *me, OGGZ *oggz,
55  ogg_int64_t milliseconds);
56  int (*available) (OggPlayReader *me,
57  ogg_int64_t current_bytes,
58  ogg_int64_t current_time);
59  ogg_int64_t (*duration) (OggPlayReader *me);
60  int (*finished_retrieving)(OggPlayReader *me);
61 
62  /* low-level io functions for oggz */
63  size_t (*io_read)(void *user_handle, void *buf, size_t n);
64  int (*io_seek)(void *user_handle, long offset, int whence);
65  long (*io_tell)(void *user_handle);
67 
76 oggplay_file_reader_new(const char *filename);
77 
88 oggplay_tcp_reader_new(const char *uri, const char *proxy, int proxy_port);
89 
90 #endif /* OGGPLAY_READER_HEADER */
OggPlayReader * oggplay_file_reader_new(const char *filename)
Create and initialise an OggPlayReader for a given Ogg file.
OggPlayReader * oggplay_tcp_reader_new(const char *uri, const char *proxy, int proxy_port)
Create and initialise an OggPlayReader for an Ogg content at a given URI.
Definition: oggplay_reader.h:51
OggPlayErrorCode
Definitions of error return values.
Definition: oggplay_enums.h:48