aubio: synth/sampler.h Source File

aubio 0.4.9

sampler.h
Go to the documentation of this file.
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 sound files.
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 \example synth/test-sampler.c
34
35 */
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /** sampler object */
42 typedef struct _aubio_sampler_t aubio_sampler_t;
43
44 /** create new sampler object
45
46 \param samplerate the sampling rate of the new sampler
47 \param hop_size the block size of the new sampler
48
49 \return the newly created ::aubio_sampler_t
50
51 */
52 aubio_sampler_t * new_aubio_sampler(uint_t samplerate, uint_t hop_size);
53
54 /** load source in sampler
55
56 \param o sampler, created by new_aubio_sampler()
57 \param uri the uri of the source to load
58
59 \return 0 if successful, non-zero otherwise
60
61 */
62 uint_t aubio_sampler_load( aubio_sampler_t * o, const char_t * uri );
63
64 /** process sampler function
65
66 \param o sampler, created by new_aubio_sampler()
67 \param input input of the sampler, to be added to the output
68 \param output output of the sampler
69
70 This function adds the new samples from the playing source to the output.
71
72 If `input` is not NULL and different from `output`, then the samples from `input`
73 are added to the output.
74
75 */
76 void aubio_sampler_do ( aubio_sampler_t * o, const fvec_t * input, fvec_t * output);
77
78 /** process sampler function, multiple channels
79
80 \param o sampler, created by new_aubio_sampler()
81 \param input input of the sampler, to be added to the output
82 \param output output of the sampler
83
84 This function adds the new samples from the playing source to the output.
85
86 If `input` is not NULL and different from `output`, then the samples from `input`
87 are added to the output.
88
89 */
90 void aubio_sampler_do_multi ( aubio_sampler_t * o, const fmat_t * input, fmat_t * output);
91
92 /** get current playing state
93
94 \param o sampler, created by new_aubio_sampler()
95
96 \return 0 if not playing, 1 if playing
97
98 */
99 uint_t aubio_sampler_get_playing ( const aubio_sampler_t * o );
100
101 /** set current playing state
102
103 \param o sampler, created by new_aubio_sampler()
104 \param playing 0 for not playing, 1 for playing
105
106 \return 0 if successful, 1 otherwise
107
108 */
109 uint_t aubio_sampler_set_playing ( aubio_sampler_t * o, uint_t playing );
110
111 /** play sample from start
112
113 \param o sampler, created by new_aubio_sampler()
114
115 \return 0 if successful, 1 otherwise
116
117 */
118 uint_t aubio_sampler_play ( aubio_sampler_t * o );
119
120 /** stop sample
121
122 \param o sampler, created by new_aubio_sampler()
123
124 \return 0 if successful, 1 otherwise
125
126 */
127 uint_t aubio_sampler_stop ( aubio_sampler_t * o );
128
129 /** destroy ::aubio_sampler_t object
130
131 \param o sampler, created by new_aubio_sampler()
132
133 */
134 void del_aubio_sampler( aubio_sampler_t * o );
135
136 #ifdef __cplusplus
137 }
138 #endif
139
140 #endif /* AUBIO_SAMPLER_H */
fmat_t
Buffer for real data.
Definition: fmat.h:40
char_t
char char_t
character
Definition: types.h:64
aubio_sampler_load
uint_t aubio_sampler_load(aubio_sampler_t *o, const char_t *uri)
load source in sampler
new_aubio_sampler
aubio_sampler_t * new_aubio_sampler(uint_t samplerate, uint_t hop_size)
create new sampler object
aubio_sampler_do_multi
void aubio_sampler_do_multi(aubio_sampler_t *o, const fmat_t *input, fmat_t *output)
process sampler function, multiple channels
aubio_sampler_set_playing
uint_t aubio_sampler_set_playing(aubio_sampler_t *o, uint_t playing)
set current playing state
aubio_sampler_t
struct _aubio_sampler_t aubio_sampler_t
sampler object
Definition: sampler.h:42
aubio_sampler_stop
uint_t aubio_sampler_stop(aubio_sampler_t *o)
stop sample
aubio_sampler_do
void aubio_sampler_do(aubio_sampler_t *o, const fvec_t *input, fvec_t *output)
process sampler function
del_aubio_sampler
void del_aubio_sampler(aubio_sampler_t *o)
destroy aubio_sampler_t object
aubio_sampler_play
uint_t aubio_sampler_play(aubio_sampler_t *o)
play sample from start
fvec_t
Buffer for real data.
Definition: fvec.h:67
aubio_sampler_get_playing
uint_t aubio_sampler_get_playing(const aubio_sampler_t *o)
get current playing state
uint_t
unsigned int uint_t
unsigned integer
Definition: types.h:60