1 /********************************************************************
3 * THIS FILE IS PART OF THE Ogg Vorbis SOFTWARE CODEC SOURCE CODE. *
4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS SOURCE IS GOVERNED BY *
5 * THE GNU PUBLIC LICENSE 2, WHICH IS INCLUDED WITH THIS SOURCE. *
6 * PLEASE READ THESE TERMS DISTRIBUTING. *
8 * THE OggSQUISH SOURCE CODE IS (C) COPYRIGHT 1994-2000 *
9 * by Monty <monty@xiph.org> and The XIPHOPHORUS Company *
10 * http://www.xiph.org/ *
12 ********************************************************************
14 function: stdio-based convenience library for opening/seeking/decoding
15 last mod: $Id: vorbisfile.h,v 1.6 2000/06/15 12:17:03 xiphmont Exp $
17 ********************************************************************/
25 #endif /* __cplusplus */
30 /* The function prototypes for the callbacks are basically the same as for
31 * the stdio functions fread, fseek, fclose, ftell.
32 * The one difference is that the FILE * arguments have been replaced with
33 * a void * - this is to be used as a pointer to whatever internal data these
34 * functions might need. In the stdio case, it's just a FILE * cast to a void *
36 * If you use other functions, check the docs for these functions and return
37 * the right values. For seek_func(), you *MUST* return -1 if the stream is
41 size_t (*read_func) (void *ptr, size_t size, size_t nmemb, void *datasource);
42 int (*seek_func) (void *datasource, int64_t offset, int whence);
43 int (*close_func) (void *datasource);
44 long (*tell_func) (void *datasource);
49 void *datasource; /* Pointer to a FILE *, etc. */
55 /* If the FILE handle isn't seekable (eg, a pipe), only the current
65 /* Decoding working state local storage */
68 long current_serialno;
74 ogg_stream_state os; /* take physical pages, weld into a logical
76 vorbis_dsp_state vd; /* central working state for the packet->PCM decoder */
77 vorbis_block vb; /* local working space for packet->PCM decode */
79 ov_callbacks callbacks;
83 extern int ov_clear(OggVorbis_File *vf);
84 extern int ov_open(FILE *f,OggVorbis_File *vf,char *initial,long ibytes);
85 extern int ov_open_callbacks(void *datasource, OggVorbis_File *vf,
86 char *initial, long ibytes, ov_callbacks callbacks);
88 extern long ov_bitrate(OggVorbis_File *vf,int i);
89 extern long ov_bitrate_instant(OggVorbis_File *vf);
90 extern long ov_streams(OggVorbis_File *vf);
91 extern long ov_seekable(OggVorbis_File *vf);
92 extern long ov_serialnumber(OggVorbis_File *vf,int i);
94 extern int64_t ov_raw_total(OggVorbis_File *vf,int i);
95 extern int64_t ov_pcm_total(OggVorbis_File *vf,int i);
96 extern double ov_time_total(OggVorbis_File *vf,int i);
98 extern int ov_raw_seek(OggVorbis_File *vf,long pos);
99 extern int ov_pcm_seek(OggVorbis_File *vf,int64_t pos);
100 extern int ov_time_seek(OggVorbis_File *vf,double pos);
102 extern int64_t ov_raw_tell(OggVorbis_File *vf);
103 extern int64_t ov_pcm_tell(OggVorbis_File *vf);
104 extern double ov_time_tell(OggVorbis_File *vf);
106 extern vorbis_info *ov_info(OggVorbis_File *vf,int link);
107 extern vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
109 extern long ov_read(OggVorbis_File *vf,char *buffer,int length,
110 int bigendianp,int word,int sgned,int *bitstream);
114 #endif /* __cplusplus */