1/********************************************************************
2 *                                                                  *
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.       *
7 *                                                                  *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2007             *
9 * by the Xiph.Org Foundation http://www.xiph.org/                  *
10 *                                                                  *
11 ********************************************************************
12
13 function: stdio-based convenience library for opening/seeking/decoding
14 last mod: $Id: vorbisfile.h 17021 2010-03-24 09:29:41Z xiphmont $
15
16 ********************************************************************/
17
18#ifndef _OV_FILE_H_
19#define _OV_FILE_H_
20
21#ifdef __cplusplus
22extern "C"
23{
24#endif /* __cplusplus */
25
26#include <stdio.h>
27#include "codec.h"
28
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 *
34 *
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
37 * unseekable
38 */
39typedef struct {
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);
44} ov_callbacks;
45
46#ifndef OV_EXCLUDE_STATIC_CALLBACKS
47
48/* a few sets of convenient callbacks, especially for use under
49 * Windows where ov_open_callbacks() should always be used instead of
50 * ov_open() to avoid problems with incompatible crt.o version linking
51 * issues. */
52
53static int _ov_header_fseek_wrap(FILE *f,ogg_int64_t off,int whence){
54  if(f==NULL)return(-1);
55
56#ifdef __MINGW32__
57  return fseeko64(f,off,whence);
58#elif defined (_WIN32)
59  return _fseeki64(f,off,whence);
60#else
61  return fseek(f,off,whence);
62#endif
63}
64
65/* These structs below (OV_CALLBACKS_DEFAULT etc) are defined here as
66 * static data. That means that every file which includes this header
67 * will get its own copy of these structs whether it uses them or
68 * not unless it #defines OV_EXCLUDE_STATIC_CALLBACKS.
69 * These static symbols are essential on platforms such as Windows on
70 * which several different versions of stdio support may be linked to
71 * by different DLLs, and we need to be certain we know which one
72 * we're using (the same one as the main application).
73 */
74
75static ov_callbacks OV_CALLBACKS_DEFAULT = {
76  (size_t (*)(void *, size_t, size_t, void *))  fread,
77  (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
78  (int (*)(void *))                             fclose,
79  (long (*)(void *))                            ftell
80};
81
82static ov_callbacks OV_CALLBACKS_NOCLOSE = {
83  (size_t (*)(void *, size_t, size_t, void *))  fread,
84  (int (*)(void *, ogg_int64_t, int))           _ov_header_fseek_wrap,
85  (int (*)(void *))                             NULL,
86  (long (*)(void *))                            ftell
87};
88
89static ov_callbacks OV_CALLBACKS_STREAMONLY = {
90  (size_t (*)(void *, size_t, size_t, void *))  fread,
91  (int (*)(void *, ogg_int64_t, int))           NULL,
92  (int (*)(void *))                             fclose,
93  (long (*)(void *))                            NULL
94};
95
96static ov_callbacks OV_CALLBACKS_STREAMONLY_NOCLOSE = {
97  (size_t (*)(void *, size_t, size_t, void *))  fread,
98  (int (*)(void *, ogg_int64_t, int))           NULL,
99  (int (*)(void *))                             NULL,
100  (long (*)(void *))                            NULL
101};
102
103#endif
104
105#define  NOTOPEN   0
106#define  PARTOPEN  1
107#define  OPENED    2
108#define  STREAMSET 3
109#define  INITSET   4
110
111typedef struct OggVorbis_File {
112  void            *datasource; /* Pointer to a FILE *, etc. */
113  int              seekable;
114  ogg_int64_t      offset;
115  ogg_int64_t      end;
116  ogg_sync_state   oy;
117
118  /* If the FILE handle isn't seekable (eg, a pipe), only the current
119     stream appears */
120  int              links;
121  ogg_int64_t     *offsets;
122  ogg_int64_t     *dataoffsets;
123  long            *serialnos;
124  ogg_int64_t     *pcmlengths; /* overloaded to maintain binary
125                                  compatibility; x2 size, stores both
126                                  beginning and end values */
127  vorbis_info     *vi;
128  vorbis_comment  *vc;
129
130  /* Decoding working state local storage */
131  ogg_int64_t      pcm_offset;
132  int              ready_state;
133  long             current_serialno;
134  int              current_link;
135
136  double           bittrack;
137  double           samptrack;
138
139  ogg_stream_state os; /* take physical pages, weld into a logical
140                          stream of packets */
141  vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
142  vorbis_block     vb; /* local working space for packet->PCM decode */
143
144  ov_callbacks callbacks;
145
146} OggVorbis_File;
147
148
149extern int ov_clear(OggVorbis_File *vf);
150extern int ov_fopen(char *path,OggVorbis_File *vf);
151extern int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
152extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
153                char *initial, long ibytes, ov_callbacks callbacks);
154
155extern int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
156extern int ov_test_callbacks(void *datasource, OggVorbis_File *vf,
157                char *initial, long ibytes, ov_callbacks callbacks);
158extern int ov_test_open(OggVorbis_File *vf);
159
160extern long ov_bitrate(OggVorbis_File *vf,int i);
161extern long ov_bitrate_instant(OggVorbis_File *vf);
162extern long ov_streams(OggVorbis_File *vf);
163extern long ov_seekable(OggVorbis_File *vf);
164extern long ov_serialnumber(OggVorbis_File *vf,int i);
165
166extern ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i);
167extern ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i);
168extern double ov_time_total(OggVorbis_File *vf,int i);
169
170extern int ov_raw_seek(OggVorbis_File *vf,ogg_int64_t pos);
171extern int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos);
172extern int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
173extern int ov_time_seek(OggVorbis_File *vf,double pos);
174extern int ov_time_seek_page(OggVorbis_File *vf,double pos);
175
176extern int ov_raw_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
177extern int ov_pcm_seek_lap(OggVorbis_File *vf,ogg_int64_t pos);
178extern int ov_pcm_seek_page_lap(OggVorbis_File *vf,ogg_int64_t pos);
179extern int ov_time_seek_lap(OggVorbis_File *vf,double pos);
180extern int ov_time_seek_page_lap(OggVorbis_File *vf,double pos);
181
182extern ogg_int64_t ov_raw_tell(OggVorbis_File *vf);
183extern ogg_int64_t ov_pcm_tell(OggVorbis_File *vf);
184extern double ov_time_tell(OggVorbis_File *vf);
185
186extern vorbis_info *ov_info(OggVorbis_File *vf,int link);
187extern vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
188
189extern long ov_read_float(OggVorbis_File *vf,float ***pcm_channels,int samples,
190                          int *bitstream);
191extern long ov_read_filter(OggVorbis_File *vf,char *buffer,int length,
192                          int bigendianp,int word,int sgned,int *bitstream,
193                          void (*filter)(float **pcm,long channels,long samples,void *filter_param),void *filter_param);
194extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
195                    int bigendianp,int word,int sgned,int *bitstream);
196extern int ov_crosslap(OggVorbis_File *vf1,OggVorbis_File *vf2);
197
198extern int ov_halfrate(OggVorbis_File *vf,int flag);
199extern int ov_halfrate_p(OggVorbis_File *vf);
200
201#ifdef __cplusplus
202}
203#endif /* __cplusplus */
204
205#endif
206
207