1 | /* |
---|
2 | Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org> |
---|
3 | |
---|
4 | This file is part of aubio. |
---|
5 | |
---|
6 | aubio is free software: you can redistribute it and/or modify |
---|
7 | it under the terms of the GNU General Public License as published by |
---|
8 | the Free Software Foundation, either version 3 of the License, or |
---|
9 | (at your option) any later version. |
---|
10 | |
---|
11 | aubio is distributed in the hope that it will be useful, |
---|
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
14 | GNU General Public License for more details. |
---|
15 | |
---|
16 | You should have received a copy of the GNU General Public License |
---|
17 | along with aubio. If not, see <http://www.gnu.org/licenses/>. |
---|
18 | |
---|
19 | */ |
---|
20 | |
---|
21 | #ifndef AUBIO_SAMPLER_H |
---|
22 | #define AUBIO_SAMPLER_H |
---|
23 | |
---|
24 | /** \file |
---|
25 | |
---|
26 | Load and play a sound file. |
---|
27 | |
---|
28 | This file loads a sample and gets ready to play it. |
---|
29 | |
---|
30 | The `_do` function adds the new samples to the input, and write the result as |
---|
31 | the output. |
---|
32 | |
---|
33 | TODO: |
---|
34 | - add _preset_threaded(level) |
---|
35 | - add _set_stretch |
---|
36 | - add _set_pitch |
---|
37 | |
---|
38 | \example synth/test-sampler.c |
---|
39 | |
---|
40 | */ |
---|
41 | |
---|
42 | #ifdef __cplusplus |
---|
43 | extern "C" { |
---|
44 | #endif |
---|
45 | |
---|
46 | /** sampler object */ |
---|
47 | typedef struct _aubio_sampler_t aubio_sampler_t; |
---|
48 | |
---|
49 | /** create new sampler object |
---|
50 | |
---|
51 | \param samplerate the sampling rate of the new sampler |
---|
52 | \param hop_size the block size of the new sampler |
---|
53 | |
---|
54 | \return the newly created ::aubio_sampler_t |
---|
55 | |
---|
56 | */ |
---|
57 | aubio_sampler_t * new_aubio_sampler(uint_t hop_size, uint_t samplerate); |
---|
58 | |
---|
59 | /** load source in sampler |
---|
60 | |
---|
61 | \param o sampler, created by new_aubio_sampler() |
---|
62 | \param uri the uri of the source to load |
---|
63 | |
---|
64 | \return 0 if successful, non-zero otherwise |
---|
65 | |
---|
66 | This function attempts to load a new source, swaps the current one with the |
---|
67 | newly loaded one (or NULL if loading failed), then delete the old one. |
---|
68 | |
---|
69 | */ |
---|
70 | uint_t aubio_sampler_load( aubio_sampler_t * o, const char_t * uri ); |
---|
71 | |
---|
72 | /** queue source in sampler |
---|
73 | |
---|
74 | \param o sampler, created by new_aubio_sampler() |
---|
75 | \param uri the uri of the source to load |
---|
76 | |
---|
77 | \return 0 if successfully queued, non-zero otherwise |
---|
78 | |
---|
79 | This function is identical to aubio_sampler_load(), except it will be called |
---|
80 | in its own thread to avoid blocking calls to aubio_sampler_do(). |
---|
81 | |
---|
82 | */ |
---|
83 | uint_t aubio_sampler_queue(aubio_sampler_t * o, const char_t * uri ); |
---|
84 | |
---|
85 | /** set array to read from |
---|
86 | |
---|
87 | \param o sampler, created by new_aubio_sampler() |
---|
88 | \param samples the vector to set the table to |
---|
89 | |
---|
90 | \return 0 if successfully set, non-zero otherwise |
---|
91 | |
---|
92 | */ |
---|
93 | uint_t aubio_sampler_set_table(aubio_sampler_t *o, fvec_t *samples); |
---|
94 | |
---|
95 | /** process sampler function |
---|
96 | |
---|
97 | \param o sampler, created by new_aubio_sampler() |
---|
98 | \param output output of the sampler |
---|
99 | \param read number of samples actually read |
---|
100 | |
---|
101 | This function get new samples from the sampler and store them into output. |
---|
102 | |
---|
103 | The output vector will be completed with 0 if too few samples are available. |
---|
104 | |
---|
105 | */ |
---|
106 | void aubio_sampler_do ( aubio_sampler_t * o, fvec_t * output, uint_t *read); |
---|
107 | |
---|
108 | /** process sampler function, multiple channels |
---|
109 | |
---|
110 | \param o sampler, created by new_aubio_sampler() |
---|
111 | \param output output of the sampler |
---|
112 | |
---|
113 | This function is identical to aubio_sampler_do(), but for a multi-channel source. |
---|
114 | |
---|
115 | */ |
---|
116 | void aubio_sampler_do_multi ( aubio_sampler_t * o, fmat_t * output, uint_t *read); |
---|
117 | |
---|
118 | /** get current playing state |
---|
119 | |
---|
120 | \param o sampler, created by new_aubio_sampler() |
---|
121 | |
---|
122 | \return 0 if not playing, 1 if playing |
---|
123 | |
---|
124 | */ |
---|
125 | uint_t aubio_sampler_get_playing ( const aubio_sampler_t * o ); |
---|
126 | |
---|
127 | /** set current playing state |
---|
128 | |
---|
129 | \param o sampler, created by new_aubio_sampler() |
---|
130 | \param playing 0 for not playing, 1 for playing |
---|
131 | |
---|
132 | \return 0 if successful, 1 otherwise |
---|
133 | |
---|
134 | */ |
---|
135 | uint_t aubio_sampler_set_playing ( aubio_sampler_t * o, uint_t playing ); |
---|
136 | |
---|
137 | uint_t aubio_sampler_get_loop(aubio_sampler_t * o); |
---|
138 | |
---|
139 | /** set current looping state |
---|
140 | |
---|
141 | \param o sampler, created by new_aubio_sampler() |
---|
142 | \param looping 0 for not looping, 1 for looping |
---|
143 | |
---|
144 | \return 0 if successful, 1 otherwise |
---|
145 | |
---|
146 | */ |
---|
147 | uint_t aubio_sampler_set_loop(aubio_sampler_t * o, uint_t loop); |
---|
148 | |
---|
149 | /** play sample from start |
---|
150 | |
---|
151 | \param o sampler, created by new_aubio_sampler() |
---|
152 | |
---|
153 | \return 0 if successful, 1 otherwise |
---|
154 | |
---|
155 | */ |
---|
156 | uint_t aubio_sampler_play ( aubio_sampler_t * o ); |
---|
157 | |
---|
158 | /** play sample from start, looping it |
---|
159 | |
---|
160 | \param o sampler, created by new_aubio_sampler() |
---|
161 | |
---|
162 | \return 0 if successful, 1 otherwise |
---|
163 | |
---|
164 | */ |
---|
165 | uint_t aubio_sampler_loop ( aubio_sampler_t * o ); |
---|
166 | |
---|
167 | /** play sample from start, once |
---|
168 | |
---|
169 | \param o sampler, created by new_aubio_sampler() |
---|
170 | |
---|
171 | \return 0 if successful, 1 otherwise |
---|
172 | |
---|
173 | */ |
---|
174 | uint_t aubio_sampler_trigger ( aubio_sampler_t * o ); |
---|
175 | |
---|
176 | /** stop sample |
---|
177 | |
---|
178 | \param o sampler, created by new_aubio_sampler() |
---|
179 | |
---|
180 | \return 0 if successful, 1 otherwise |
---|
181 | |
---|
182 | */ |
---|
183 | uint_t aubio_sampler_stop ( aubio_sampler_t * o ); |
---|
184 | |
---|
185 | /** get end-of-file status |
---|
186 | |
---|
187 | \param o sampler, created by new_aubio_sampler() |
---|
188 | |
---|
189 | \return 1 when the eof is being reached, 0 otherwise |
---|
190 | |
---|
191 | */ |
---|
192 | uint_t aubio_sampler_get_eof(aubio_sampler_t * o); |
---|
193 | |
---|
194 | /** get end-of-file status |
---|
195 | |
---|
196 | \param o sampler, created by new_aubio_sampler() |
---|
197 | |
---|
198 | \return 1 when the eof is being reached, 0 otherwise |
---|
199 | |
---|
200 | */ |
---|
201 | uint_t aubio_sampler_get_finished (aubio_sampler_t * o); |
---|
202 | |
---|
203 | /** get samplerate |
---|
204 | |
---|
205 | \param o sampler, created by new_aubio_sampler() |
---|
206 | |
---|
207 | \return samplerate of the sampler |
---|
208 | |
---|
209 | */ |
---|
210 | uint_t aubio_sampler_get_samplerate(aubio_sampler_t * o); |
---|
211 | |
---|
212 | /** get the number of samples that were set to zero while opening a file |
---|
213 | |
---|
214 | \param o sampler, created by new_aubio_sampler() |
---|
215 | \param waited the number of frames processed during this block |
---|
216 | |
---|
217 | \return the total delay in samples when the file was successfuly opened, 0 |
---|
218 | otherwise |
---|
219 | |
---|
220 | */ |
---|
221 | uint_t aubio_sampler_get_waited_opening(aubio_sampler_t * o, uint_t waited); |
---|
222 | |
---|
223 | /** get the current perfect loop mode |
---|
224 | |
---|
225 | \param o sampler, created by new_aubio_sampler() |
---|
226 | |
---|
227 | \return the total delay in samples when the file was successfuly opened, 0 |
---|
228 | otherwise |
---|
229 | |
---|
230 | */ |
---|
231 | uint_t aubio_sampler_get_perfectloop (aubio_sampler_t *o); |
---|
232 | |
---|
233 | /** set the perfect loop mode |
---|
234 | |
---|
235 | \param o sampler, created by new_aubio_sampler() |
---|
236 | \param perfectloop 1 to set perfect loop mode, 0 to turn it of |
---|
237 | |
---|
238 | \return AUBIO_OK on success, AUBIO_FAIL otherwise |
---|
239 | |
---|
240 | */ |
---|
241 | uint_t aubio_sampler_set_perfectloop (aubio_sampler_t *o, uint_t perfectloop); |
---|
242 | |
---|
243 | /** seek to position |
---|
244 | |
---|
245 | \param o sampler, created by new_aubio_sampler() |
---|
246 | \param pos position to seek to, in samples |
---|
247 | |
---|
248 | \return 0 if successful, 1 otherwise |
---|
249 | |
---|
250 | */ |
---|
251 | uint_t aubio_sampler_seek(aubio_sampler_t * o, uint_t pos); |
---|
252 | |
---|
253 | /** destroy ::aubio_sampler_t object |
---|
254 | |
---|
255 | \param o sampler, created by new_aubio_sampler() |
---|
256 | |
---|
257 | */ |
---|
258 | void del_aubio_sampler( aubio_sampler_t * o ); |
---|
259 | |
---|
260 | #ifdef __cplusplus |
---|
261 | } |
---|
262 | #endif |
---|
263 | |
---|
264 | #endif /* AUBIO_SAMPLER_H */ |
---|