2 Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
4 This file is part of aubio.
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.
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.
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/>.
24 #include "aubio_priv.h"
27 typedef jack_default_audio_sample_t jack_sample_t;
29 #if !AUBIO_SINGLE_PRECISION
30 #define AUBIO_JACK_MAX_FRAMES 4096
31 #define AUBIO_JACK_NEEDS_CONVERSION
34 #define RINGBUFFER_SIZE 1024*sizeof(jack_midi_event_t)
37 * jack device structure
42 jack_client_t *client;
43 /** jack output ports */
45 /** jack input ports */
47 /** jack input buffer */
48 jack_sample_t **ibufs;
49 /** jack output buffer */
50 jack_sample_t **obufs;
51 #ifdef AUBIO_JACK_NEEDS_CONVERSION
52 /** converted jack input buffer */
54 /** converted jack output buffer */
57 /** jack input audio channels */
59 /** jack output audio channels */
61 /** jack input midi channels */
63 /** jack output midi channels */
65 /** midi output ringbuffer */
66 jack_ringbuffer_t *midi_out_ring;
67 /** jack samplerate (Hz) */
69 /** jack processing function */
70 aubio_process_func_t callback;
73 /* static memory management */
74 static aubio_jack_t *aubio_jack_alloc (uint_t ichan, uint_t ochan,
75 uint_t imidichan, uint_t omidichan);
76 static uint_t aubio_jack_free (aubio_jack_t * jack_setup);
77 /* jack callback functions */
78 static int aubio_jack_process (jack_nframes_t nframes, void *arg);
79 static void aubio_jack_shutdown (void *arg);
82 new_aubio_jack (uint_t ichan, uint_t ochan,
83 uint_t imidichan, uint_t omidichan, aubio_process_func_t callback)
85 aubio_jack_t *jack_setup = aubio_jack_alloc (ichan, ochan,
86 imidichan, omidichan);
88 char *client_name = "aubio";
91 /* initial jack client setup */
92 if ((jack_setup->client = jack_client_new (client_name)) == 0) {
93 AUBIO_ERR ("jack server not running?\n");
94 AUBIO_QUIT (AUBIO_FAIL);
97 if (jack_setup->omidichan) {
98 jack_setup->midi_out_ring = jack_ringbuffer_create (RINGBUFFER_SIZE);
100 if (jack_setup->midi_out_ring == NULL) {
101 AUBIO_ERR ("Failed creating jack midi output ringbuffer.");
102 AUBIO_QUIT (AUBIO_FAIL);
105 jack_ringbuffer_mlock (jack_setup->midi_out_ring);
109 jack_set_process_callback (jack_setup->client, aubio_jack_process,
110 (void *) jack_setup);
111 jack_on_shutdown (jack_setup->client, aubio_jack_shutdown,
112 (void *) jack_setup);
114 /* register jack output audio and midi ports */
115 for (i = 0; i < ochan + omidichan; i++) {
117 jack_port_type = JACK_DEFAULT_AUDIO_TYPE;
118 AUBIO_SPRINTF (name, "out_%d", i + 1);
120 jack_port_type = JACK_DEFAULT_MIDI_TYPE;
121 AUBIO_SPRINTF (name, "midi_out_%d", i - ochan + 1);
123 if ((jack_setup->oports[i] =
124 jack_port_register (jack_setup->client, name,
125 jack_port_type, JackPortIsOutput, 0)) == 0) {
128 AUBIO_DBG ("%s:%s\n", client_name, name);
131 /* register jack input audio ports */
132 for (i = 0; i < ichan + imidichan; i++) {
134 jack_port_type = JACK_DEFAULT_AUDIO_TYPE;
135 AUBIO_SPRINTF (name, "in_%d", i + 1);
137 jack_port_type = JACK_DEFAULT_MIDI_TYPE;
138 AUBIO_SPRINTF (name, "midi_in_%d", i - ichan + 1);
140 if ((jack_setup->iports[i] =
141 jack_port_register (jack_setup->client, name,
142 jack_port_type, JackPortIsInput, 0)) == 0) {
145 AUBIO_DBG ("%s:%s\n", client_name, name);
148 /* set processing callback */
149 jack_setup->callback = callback;
153 AUBIO_ERR ("failed registering port \"%s:%s\"!\n", client_name, name);
154 jack_client_close (jack_setup->client);
155 AUBIO_QUIT (AUBIO_FAIL);
159 aubio_jack_activate (aubio_jack_t * jack_setup)
161 /* get sample rate */
162 jack_setup->samplerate = jack_get_sample_rate (jack_setup->client);
163 /* actual jack process activation */
164 if (jack_activate (jack_setup->client)) {
165 AUBIO_ERR ("jack client activation failed");
172 aubio_jack_close (aubio_jack_t * jack_setup)
174 /* bug : should disconnect all ports first */
175 jack_client_close (jack_setup->client);
176 aubio_jack_free (jack_setup);
179 /* memory management */
180 static aubio_jack_t *
181 aubio_jack_alloc (uint_t ichan, uint_t ochan,
182 uint_t imidichan, uint_t omidichan)
184 aubio_jack_t *jack_setup = AUBIO_NEW (aubio_jack_t);
185 jack_setup->ichan = ichan;
186 jack_setup->ochan = ochan;
187 jack_setup->imidichan = imidichan;
188 jack_setup->omidichan = omidichan;
189 jack_setup->oports = AUBIO_ARRAY (jack_port_t *, ichan + imidichan);
190 jack_setup->iports = AUBIO_ARRAY (jack_port_t *, ochan + omidichan);
191 jack_setup->ibufs = AUBIO_ARRAY (jack_sample_t *, ichan);
192 jack_setup->obufs = AUBIO_ARRAY (jack_sample_t *, ochan);
193 #ifdef AUBIO_JACK_NEEDS_CONVERSION
194 /* allocate arrays for data conversion */
195 jack_setup->sibufs = AUBIO_ARRAY (smpl_t *, ichan);
197 for (i = 0; i < ichan; i++) {
198 jack_setup->sibufs[i] = AUBIO_ARRAY (smpl_t, AUBIO_JACK_MAX_FRAMES);
200 jack_setup->sobufs = AUBIO_ARRAY (smpl_t *, ochan);
201 for (i = 0; i < ochan; i++) {
202 jack_setup->sobufs[i] = AUBIO_ARRAY (smpl_t, AUBIO_JACK_MAX_FRAMES);
209 aubio_jack_free (aubio_jack_t * jack_setup)
211 if (jack_setup->omidichan && jack_setup->midi_out_ring) {
212 jack_ringbuffer_free (jack_setup->midi_out_ring);
214 AUBIO_FREE (jack_setup->oports);
215 AUBIO_FREE (jack_setup->iports);
216 AUBIO_FREE (jack_setup->ibufs);
217 AUBIO_FREE (jack_setup->obufs);
218 AUBIO_FREE (jack_setup);
222 /* jack callback functions */
224 aubio_jack_shutdown (void *arg UNUSED)
226 AUBIO_ERR ("jack shutdown\n");
227 AUBIO_QUIT (AUBIO_OK);
230 static void process_midi_output (aubio_jack_t * dev, jack_nframes_t nframes);
233 aubio_jack_process (jack_nframes_t nframes, void *arg)
235 aubio_jack_t *dev = (aubio_jack_t *) arg;
237 for (i = 0; i < dev->ichan; i++) {
238 /* get readable input */
240 (jack_sample_t *) jack_port_get_buffer (dev->iports[i], nframes);
242 for (i = 0; i < dev->ochan; i++) {
243 /* get writable output */
245 (jack_sample_t *) jack_port_get_buffer (dev->oports[i], nframes);
247 #ifndef AUBIO_JACK_NEEDS_CONVERSION
248 dev->callback (dev->ibufs, dev->obufs, nframes);
251 for (j = 0; j < MIN (nframes, AUBIO_JACK_MAX_FRAMES); j++) {
252 for (i = 0; i < dev->ichan; i++) {
253 dev->sibufs[i][j] = (smpl_t) dev->ibufs[i][j];
256 dev->callback (dev->sibufs, dev->sobufs, nframes);
257 for (j = 0; j < MIN (nframes, AUBIO_JACK_MAX_FRAMES); j++) {
258 for (i = 0; i < dev->ochan; i++) {
259 dev->obufs[i][j] = (jack_sample_t) dev->sobufs[i][j];
264 /* now process midi stuff */
265 if (dev->omidichan) {
266 process_midi_output (dev, nframes);
273 aubio_jack_midi_event_write (aubio_jack_t * dev, jack_midi_event_t * event)
277 if (jack_ringbuffer_write_space (dev->midi_out_ring) < sizeof (*event)) {
278 AUBIO_ERR ("Not enough space to write midi output, midi event lost!\n");
282 written = jack_ringbuffer_write (dev->midi_out_ring,
283 (char *) event, sizeof (*event));
285 if (written != sizeof (*event)) {
286 AUBIO_WRN ("Call to jack_ringbuffer_write failed, midi event lost! \n");
291 process_midi_output (aubio_jack_t * dev, jack_nframes_t nframes)
294 jack_midi_event_t ev;
295 unsigned char *buffer;
296 jack_nframes_t last_frame_time = jack_last_frame_time (dev->client);
297 // TODO for each omidichan
298 void *port_buffer = jack_port_get_buffer (dev->oports[dev->ochan], nframes);
300 if (port_buffer == NULL) {
301 AUBIO_WRN ("Failed to get jack midi output port, will not send anything\n");
305 jack_midi_clear_buffer (port_buffer);
307 // TODO add rate_limit
309 while (jack_ringbuffer_read_space (dev->midi_out_ring)) {
310 read = jack_ringbuffer_peek (dev->midi_out_ring, (char *) &ev, sizeof (ev));
312 if (read != sizeof (ev)) {
313 AUBIO_WRN ("Short read from the ringbuffer, possible note loss.\n");
314 jack_ringbuffer_read_advance (dev->midi_out_ring, read);
318 sendtime = ev.time + nframes - last_frame_time;
320 /* send time is after current period, will do this one later */
321 if (sendtime >= (int) nframes) {
329 jack_ringbuffer_read_advance (dev->midi_out_ring, sizeof (ev));
331 buffer = jack_midi_event_reserve (port_buffer, sendtime, ev.size);
333 if (buffer == NULL) {
334 AUBIO_WRN ("Call to jack_midi_event_reserve failed, note lost.\n");
338 AUBIO_MEMCPY (buffer, ev.buffer, ev.size);
342 #endif /* HAVE_JACK */