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-2001 *
9 * by the XIPHOPHORUS Company http://www.xiph.org/ *
11 ********************************************************************
13 function: stdio-based convenience library for opening/seeking/decoding
14 last mod: $Id: vorbisfile.h,v 1.14 2001/05/27 06:43:59 xiphmont 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);
52 typedef struct OggVorbis_File {
53 void *datasource; /* Pointer to a FILE *, etc. */
59 /* If the FILE handle isn't seekable (eg, a pipe), only the current
63 ogg_int64_t *dataoffsets;
65 ogg_int64_t *pcmlengths;
69 /* Decoding working state local storage */
70 ogg_int64_t pcm_offset;
72 long current_serialno;
78 ogg_stream_state os; /* take physical pages, weld into a logical
80 vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
81 vorbis_block vb; /* local working space for packet->PCM decode */
83 ov_callbacks callbacks;
87 extern int ov_clear(OggVorbis_File *vf);
88 extern int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
89 extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
90 char *initial, long ibytes, ov_callbacks callbacks);
92 extern int ov_test(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
93 extern int ov_test_callbacks(void *datasource, OggVorbis_File *vf,
94 char *initial, long ibytes, ov_callbacks callbacks);
95 extern int ov_test_open(OggVorbis_File *vf);
97 extern long ov_bitrate(OggVorbis_File *vf,int i);
98 extern long ov_bitrate_instant(OggVorbis_File *vf);
99 extern long ov_streams(OggVorbis_File *vf);
100 extern long ov_seekable(OggVorbis_File *vf);
101 extern long ov_serialnumber(OggVorbis_File *vf,int i);
103 extern ogg_int64_t ov_raw_total(OggVorbis_File *vf,int i);
104 extern ogg_int64_t ov_pcm_total(OggVorbis_File *vf,int i);
105 extern double ov_time_total(OggVorbis_File *vf,int i);
107 extern int ov_raw_seek(OggVorbis_File *vf,long pos);
108 extern int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos);
109 extern int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
110 extern int ov_time_seek(OggVorbis_File *vf,double pos);
111 extern int ov_time_seek_page(OggVorbis_File *vf,double pos);
113 extern ogg_int64_t ov_raw_tell(OggVorbis_File *vf);
114 extern ogg_int64_t ov_pcm_tell(OggVorbis_File *vf);
115 extern double ov_time_tell(OggVorbis_File *vf);
117 extern vorbis_info *ov_info(OggVorbis_File *vf,int link);
118 extern vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
120 extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
121 int bigendianp,int word,int sgned,int *bitstream);
125 #endif /* __cplusplus */