src/synth/sampler.h: add a simple sampler
authorPaul Brossier <piem@piem.org>
Fri, 22 Mar 2013 16:46:38 +0000 (11:46 -0500)
committerPaul Brossier <piem@piem.org>
Fri, 22 Mar 2013 16:46:38 +0000 (11:46 -0500)
src/aubio.h
src/synth/sampler.h [new file with mode: 0644]

index 0e23419f320981150947ce608c0d2682a7d2a53f..7a275679126ccf02db1fca2dc74f40082a2e0d32 100644 (file)
@@ -184,6 +184,7 @@ extern "C"
 #include "tempo/tempo.h"
 #include "io/source.h"
 #include "io/sink.h"
+#include "synth/sampler.h"
 
 #if AUBIO_UNSTABLE
 #include "mathutils.h"
diff --git a/src/synth/sampler.h b/src/synth/sampler.h
new file mode 100644 (file)
index 0000000..b0e63b3
--- /dev/null
@@ -0,0 +1,141 @@
+/*
+  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_SYNTH_SAMPLER_H
+#define _AUBIO_SYNTH_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
+
+  \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, 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 sample 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, 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 sample 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, 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 ( 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
+  \param playing 0 for not playing, 1 for playing
+
+  \return 0 if successful, 1 otherwise
+
+*/
+uint_t aubio_sampler_play ( aubio_sampler_t * o );
+
+/** stop sample from start
+
+  \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_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_SYNTH_SAMPLER_H */