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