[ci] add pip install to readthedocs.yaml
[aubio.git] / examples / jackio.h
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 JACKIO_H
22 #define JACKIO_H
23
24 /**
25  * @file
26  *
27  * Jack driver for aubio
28  *
29  */
30
31 #ifdef __cplusplus
32 extern "C"
33 {
34 #endif
35
36 #include <jack/jack.h>
37 #include <jack/midiport.h>
38 #include <jack/ringbuffer.h>
39
40 /** jack object */
41 typedef struct _aubio_jack_t aubio_jack_t;
42
43 /** jack device creation function */
44 aubio_jack_t *new_aubio_jack (uint_t hop_size,
45     uint_t inchannels, uint_t outchannels,
46     uint_t imidichan, uint_t omidichan);
47 /** activate jack client (run jackprocess function) */
48 uint_t aubio_jack_activate (aubio_jack_t * jack_setup,
49     aubio_process_func_t callback);
50 /** close and delete jack client */
51 void aubio_jack_close (aubio_jack_t * jack_setup);
52 void del_aubio_jack (aubio_jack_t * jack_setup);
53 /** get samplerate */
54 uint_t aubio_jack_get_samplerate (aubio_jack_t * jack_setup);
55
56 /** write a jack_midi_event_t to the midi output ringbuffer */
57 void aubio_jack_midi_event_write (aubio_jack_t * jack_setup,
58     jack_midi_event_t * event);
59
60 #ifdef __cplusplus
61 }
62 #endif
63
64 #endif                          /* JACKIO_H */