source: src/synth/sampler.h @ 04c8346

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since 04c8346 was 04c8346, checked in by Paul Brossier <piem@piem.org>, 7 years ago

src/synth/sampler.h: add a simple sampler

  • Property mode set to 100644
File size: 3.5 KB
Line 
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_SYNTH_SAMPLER_H
22#define _AUBIO_SYNTH_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
38extern "C" {
39#endif
40
41/** sampler object */
42typedef 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
48  \return the newly created ::aubio_sampler_t
49
50*/
51aubio_sampler_t * new_aubio_sampler(uint_t samplerate, uint_t hop_size);
52
53/** load source in sampler
54
55  \param o sampler, created by ::new_aubio_sampler
56  \param uri the uri of the source to load
57
58  \return 0 if successful, non-zero otherwise
59
60*/
61uint_t aubio_sampler_load( aubio_sampler_t * o, char_t * uri );
62
63/** process sampler function
64
65  \param o sampler, created by ::new_aubio_sampler
66  \param input input of the sampler, to be added to the output
67  \param output output of the sampler
68
69This function adds the new samples from the playing sample to the output.
70
71If `input` is not NULL and different from `output`, then the samples from `input`
72are added to the output.
73
74*/
75void aubio_sampler_do ( aubio_sampler_t * o, fvec_t * input, fvec_t * output);
76
77/** process sampler function, multiple channels
78
79  \param o sampler, created by ::new_aubio_sampler
80  \param input input of the sampler, to be added to the output
81  \param output output of the sampler
82
83This function adds the new samples from the playing sample to the output.
84
85If `input` is not NULL and different from `output`, then the samples from `input`
86are added to the output.
87
88*/
89void aubio_sampler_do_multi ( aubio_sampler_t * o, fmat_t * input, fmat_t * output);
90
91/** get current playing state
92
93  \param o sampler, created by ::new_aubio_sampler
94
95  \return 0 if not playing, 1 if playing
96
97*/
98uint_t aubio_sampler_get_playing ( aubio_sampler_t * o );
99
100/** set current playing state
101
102  \param o sampler, created by ::new_aubio_sampler
103  \param playing 0 for not playing, 1 for playing
104
105  \return 0 if successful, 1 otherwise
106
107*/
108uint_t aubio_sampler_set_playing ( aubio_sampler_t * o, uint_t playing );
109
110/** play sample from start
111
112  \param o sampler, created by ::new_aubio_sampler
113  \param playing 0 for not playing, 1 for playing
114
115  \return 0 if successful, 1 otherwise
116
117*/
118uint_t aubio_sampler_play ( aubio_sampler_t * o );
119
120/** stop sample from start
121
122  \param o sampler, created by ::new_aubio_sampler
123  \param playing 0 for not playing, 1 for playing
124
125  \return 0 if successful, 1 otherwise
126
127*/
128uint_t aubio_sampler_stop ( aubio_sampler_t * o );
129
130/** destroy ::aubio_sampler_t object
131
132  \param o sampler, created by ::new_aubio_sampler
133
134*/
135void del_aubio_sampler( aubio_sampler_t * o );
136
137#ifdef __cplusplus
138}
139#endif
140
141#endif /* _AUBIO_SYNTH_SAMPLER_H */
Note: See TracBrowser for help on using the repository browser.