1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*
Copyright (C) 2012-2013 Paul Brossier <piem@aubio.org>
This file is part of aubio.
aubio is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
aubio is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with aubio. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef AUBIO_SOURCE_H
#define AUBIO_SOURCE_H
/** \file
Media source to read blocks of consecutive audio samples from file.
To write to file, use ::aubio_sink_t.
Depending on how aubio was compiled, the following sources will be available.
When creating a new source using ::new_aubio_source, the new function of each
of the compiled-in sources will be used, in the following order, until one of
them gets successfully created. If all sources returned NULL,
::new_aubio_source will return NULL.
\b \p source_avcodec : libav
aubio can be optionally compiled with [libav](http://libav.org), which can
read from a very large number of audio and video formats, including over
different network protocols such as HTTP.
\b \p source_apple_audio : ExtAudioFileRef
On Mac and iOS platforms, aubio should be compiled with CoreAudio [Extended
Audio File Services]
(https://developer.apple.com/library/mac/documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html).
This provides access to most common audio file formats, including compressed
ones.
\b \p source_sndfile : libsndfile
Also optional, aubio can be built against
[libsndfile](http://www.mega-nerd.com/libsndfile/), which can read [most
uncompressed formats](http://www.mega-nerd.com/libsndfile/#Features).
\b \p source_wavread : native WAV reader
A simple source to read from 16-bits PCM RIFF encoded WAV files.
\example io/test-source.c
\example io/test-source_multi.c
*/
#ifdef __cplusplus
extern "C" {
#endif
/** media source object */
typedef struct _aubio_source_t aubio_source_t;
/**
create new ::aubio_source_t
\param uri the file path or uri to read from
\param samplerate sampling rate to view the fie at
\param hop_size the size of the blocks to read from
Creates a new source object. If `0` is passed as `samplerate`, the sample
rate of the original file is used.
The samplerate of newly created source can be obtained using
::aubio_source_get_samplerate.
*/
aubio_source_t * new_aubio_source(const char_t * uri, uint_t samplerate, uint_t hop_size);
/**
read monophonic vector of length hop_size from source object
\param s source object, created with ::new_aubio_source
\param read_to ::fvec_t of data to read to
\param read upon returns, equals to number of frames actually read
Upon returns, `read` contains the number of frames actually read from the
source. `hop_size` if enough frames could be read, less otherwise.
*/
void aubio_source_do(aubio_source_t * s, fvec_t * read_to, uint_t * read);
/**
read polyphonic vector of length hop_size from source object
\param s source object, created with ::new_aubio_source
\param read_to ::fmat_t of data to read to
\param[out] read upon returns, equals to number of frames actually read
Upon returns, `read` contains the number of frames actually read from the
source. `hop_size` if enough frames could be read, less otherwise.
*/
void aubio_source_do_multi(aubio_source_t * s, fmat_t * read_to, uint_t * read);
/**
get samplerate of source object
\param s source object, created with ::new_aubio_source
\return samplerate, in Hz
*/
uint_t aubio_source_get_samplerate(aubio_source_t * s);
/**
get channels of source object
\param s source object, created with ::new_aubio_source
\return channels
*/
uint_t aubio_source_get_channels (aubio_source_t * s);
/**
seek source object
\param s source object, created with ::new_aubio_source
\param pos position to seek to, in frames
\return 0 if sucessful, non-zero on failure
*/
uint_t aubio_source_seek (aubio_source_t * s, uint_t pos);
/**
get the duration of source object, in frames
\param s source object, created with ::new_aubio_source
\return number of frames in file
*/
uint_t aubio_source_get_duration (aubio_source_t * s);
/**
close source object
\param s source object, created with ::new_aubio_source
\return 0 if sucessful, non-zero on failure
*/
uint_t aubio_source_close (aubio_source_t *s);
/**
close source and cleanup memory
\param s source object, created with ::new_aubio_source
*/
void del_aubio_source(aubio_source_t * s);
#ifdef __cplusplus
}
#endif
#endif /* AUBIO_SOURCE_H */
|
