summaryrefslogtreecommitdiff
path: root/src/synth/sampler.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/synth/sampler.h')
-rw-r--r--src/synth/sampler.h140
1 files changed, 140 insertions, 0 deletions
diff --git a/src/synth/sampler.h b/src/synth/sampler.h
new file mode 100644
index 0000000..fb1304f
--- /dev/null
+++ b/src/synth/sampler.h
@@ -0,0 +1,140 @@
+/*
+ Copyright (C) 2003-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_SAMPLER_H
+#define AUBIO_SAMPLER_H
+
+/** \file
+
+ Load and play sound files.
+
+ This file loads a sample and gets ready to play it.
+
+ The `_do` function adds the new samples to the input, and write the result as
+ the output.
+
+ \example synth/test-sampler.c
+
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** sampler object */
+typedef struct _aubio_sampler_t aubio_sampler_t;
+
+/** create new sampler object
+
+ \param samplerate the sampling rate of the new sampler
+ \param hop_size the block size of the new sampler
+
+ \return the newly created ::aubio_sampler_t
+
+*/
+aubio_sampler_t * new_aubio_sampler(uint_t samplerate, uint_t hop_size);
+
+/** load source in sampler
+
+ \param o sampler, created by new_aubio_sampler()
+ \param uri the uri of the source to load
+
+ \return 0 if successful, non-zero otherwise
+
+*/
+uint_t aubio_sampler_load( aubio_sampler_t * o, const char_t * uri );
+
+/** process sampler function
+
+ \param o sampler, created by new_aubio_sampler()
+ \param input input of the sampler, to be added to the output
+ \param output output of the sampler
+
+This function adds the new samples from the playing source to the output.
+
+If `input` is not NULL and different from `output`, then the samples from `input`
+are added to the output.
+
+*/
+void aubio_sampler_do ( aubio_sampler_t * o, const fvec_t * input, fvec_t * output);
+
+/** process sampler function, multiple channels
+
+ \param o sampler, created by new_aubio_sampler()
+ \param input input of the sampler, to be added to the output
+ \param output output of the sampler
+
+This function adds the new samples from the playing source to the output.
+
+If `input` is not NULL and different from `output`, then the samples from `input`
+are added to the output.
+
+*/
+void aubio_sampler_do_multi ( aubio_sampler_t * o, const fmat_t * input, fmat_t * output);
+
+/** get current playing state
+
+ \param o sampler, created by new_aubio_sampler()
+
+ \return 0 if not playing, 1 if playing
+
+*/
+uint_t aubio_sampler_get_playing ( const aubio_sampler_t * o );
+
+/** set current playing state
+
+ \param o sampler, created by new_aubio_sampler()
+ \param playing 0 for not playing, 1 for playing
+
+ \return 0 if successful, 1 otherwise
+
+*/
+uint_t aubio_sampler_set_playing ( aubio_sampler_t * o, uint_t playing );
+
+/** play sample from start
+
+ \param o sampler, created by new_aubio_sampler()
+
+ \return 0 if successful, 1 otherwise
+
+*/
+uint_t aubio_sampler_play ( aubio_sampler_t * o );
+
+/** stop sample
+
+ \param o sampler, created by new_aubio_sampler()
+
+ \return 0 if successful, 1 otherwise
+
+*/
+uint_t aubio_sampler_stop ( aubio_sampler_t * o );
+
+/** destroy ::aubio_sampler_t object
+
+ \param o sampler, created by new_aubio_sampler()
+
+*/
+void del_aubio_sampler( aubio_sampler_t * o );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* AUBIO_SAMPLER_H */