1
/********************************************************************
3
* THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
4
* USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
5
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
8
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007 *
9
* by the Xiph.Org Foundation http://www.xiph.org/ *
11
********************************************************************
13
function: stdio-based convenience library for opening/seeking/decoding
14
last mod: $Id: vorbisfile.h,v 1.2 2008-04-10 22:54:16 adrian_henke Exp $
16
********************************************************************/
24
#endif /* __cplusplus */
29
/* The function prototypes for the callbacks are basically the same as for
30
* the stdio functions fread, fseek, fclose, ftell.
31
* The one difference is that the FILE * arguments have been replaced with
32
* a void * - this is to be used as a pointer to whatever internal data these
33
* functions might need. In the stdio case, it's just a FILE * cast to a void *
35
* If you use other functions, check the docs for these functions and return
36
* the right values. For seek_func(), you *MUST* return -1 if the stream is
40
size_t (*read_func) (void *ptr, size_t size, size_t nmemb, void *datasource);
41
int (*seek_func) (void *datasource, ogg_int64_t offset, int whence);
42
int (*close_func) (void *datasource);
43
long (*tell_func) (void *datasource);
46
/* a few sets of convenient callbacks, especially for use under
47
* Windows where ov_open_callbacks() should always be used instead of
48
* ov_open() to avoid problems with incompatable crt.o version linking
51
static int _ov_header_fseek_wrap(FILE *f,ogg_int64_t off,int whence){
52
if(f==NULL)return(-1);
53
return fseek(f,off,whence);
56
static ov_callbacks OV_CALLBACKS_DEFAULT = {
57
(size_t (*)(void *, size_t, size_t, void *)) fread,
58
(int (*)(void *, ogg_int64_t, int)) _ov_header_fseek_wrap,
59
(int (*)(void *)) fclose,
60
(long (*)(void *)) ftell
63
static ov_callbacks OV_CALLBACKS_NOCLOSE = {
64
(size_t (*)(void *, size_t, size_t, void *)) fread,
65
(int (*)(void *, ogg_int64_t, int)) _ov_header_fseek_wrap,
66
(int (*)(void *)) NULL,
67
(long (*)(void *)) ftell
70
static ov_callbacks OV_CALLBACKS_STREAMONLY = {
71
(size_t (*)(void *, size_t, size_t, void *)) fread,
72
(int (*)(void *, ogg_int64_t, int)) NULL,
73
(int (*)(void *)) fclose,
74
(long (*)(void *)) NULL
77
static ov_callbacks OV_CALLBACKS_STREAMONLY_NOCLOSE = {
78
(size_t (*)(void *, size_t, size_t, void *)) fread,
79
(int (*)(void *, ogg_int64_t, int)) NULL,
80
(int (*)(void *)) NULL,
81
(long (*)(void *)) NULL
90
typedef struct OggVorbis_File {
91
void *datasource; /* Pointer to a FILE *, etc. */
97
/* If the FILE handle isn't seekable (eg, a pipe), only the current
100
ogg_int64_t *offsets;
101
ogg_int64_t *dataoffsets;
103
ogg_int64_t *pcmlengths; /* overloaded to maintain binary
104
compatability; x2 size, stores both
105
beginning and end values */
109
/* Decoding working state local storage */
110
ogg_int64_t pcm_offset;
112
long current_serialno;
118
ogg_stream_state os; /* take physical pages, weld into a logical
120
vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
121
vorbis_block vb; /* local working space for packet->PCM decode */
123
ov_callbacks callbacks;
128
extern int ov_clear(OggVorbis_File *vf);
129
extern int ov_fopen(char *path,OggVorbis_File *vf);
130
extern int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
131
extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
132
char *initial, long ibytes, ov_callbacks callbacks);
134
extern int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
135
extern int ov_test_callbacks(void *datasource, OggVorbis_File *vf,
136
char *initial, long ibytes, ov_callbacks callbacks);
137
extern int ov_test_open(OggVorbis_File *vf);
139
extern long ov_bitrate(OggVorbis_File *vf,int i);
140
extern long ov_bitrate_instant(OggVorbis_File *vf);
141
extern long ov_streams(OggVorbis_File *vf);
142
extern long ov_seekable(OggVorbis_File *vf);
143
extern long ov_serialnumber(OggVorbis_File *vf,int i);
145
extern ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i);
146
extern ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i);
147
extern double ov_time_total(OggVorbis_File *vf,int i);
149
extern int ov_raw_seek(OggVorbis_File *vf,ogg_int64_t pos);
150
extern int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos);
151
extern int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
152
extern int ov_time_seek(OggVorbis_File *vf,double pos);
153
extern int ov_time_seek_page(OggVorbis_File *vf,double pos);
155
extern int ov_raw_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
156
extern int ov_pcm_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
157
extern int ov_pcm_seek_page_lap(OggVorbis_File *vf,ogg_int64_t pos);
158
extern int ov_time_seek_lap(OggVorbis_File *vf,double pos);
159
extern int ov_time_seek_page_lap(OggVorbis_File *vf,double pos);
161
extern ogg_int64_t ov_raw_tell(OggVorbis_File *vf);
162
extern ogg_int64_t ov_pcm_tell(OggVorbis_File *vf);
163
extern double ov_time_tell(OggVorbis_File *vf);
165
extern vorbis_info *ov_info(OggVorbis_File *vf,int link);
166
extern vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
168
extern long ov_read_float(OggVorbis_File *vf,float ***pcm_channels,int samples,
170
extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
171
int bigendianp,int word,int sgned,int *bitstream);
172
extern int ov_crosslap(OggVorbis_File *vf1,OggVorbis_File *vf2);
174
extern int ov_halfrate(OggVorbis_File *vf,int flag);
175
extern int ov_halfrate_p(OggVorbis_File *vf);
179
#endif /* __cplusplus */