JackFFADODriver.cpp 35.4 KB
Newer Older
sletz's avatar
sletz committed
1
2
3
4
/*
Copyright (C) 2001 Paul Davis
Copyright (C) 2004 Grame
Copyright (C) 2007 Pieter Palmers
5
Copyright (C) 2009 Devin Anderson
sletz's avatar
sletz committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

This program 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 2 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#include <iostream>
#include <unistd.h>
#include <math.h>
#include <stdio.h>
#include <memory.h>
#include <unistd.h>
#include <stdlib.h>
#include <errno.h>
#include <stdarg.h>
#include <signal.h>
#include <sys/types.h>
#include <sys/time.h>
#include <regex.h>
#include <string.h>

#include "JackFFADODriver.h"
39
40
#include "JackFFADOMidiInput.h"
#include "JackFFADOMidiOutput.h"
sletz's avatar
sletz committed
41
42
43
44
#include "JackEngineControl.h"
#include "JackClientControl.h"
#include "JackPort.h"
#include "JackGraphManager.h"
45
#include "JackCompilerDeps.h"
sletz's avatar
sletz committed
46
47
48
49

namespace Jack
{

sletz's avatar
sletz committed
50
#define FIREWIRE_REQUIRED_FFADO_API_VERSION 8
sletz's avatar
sletz committed
51
52
53
54
55
56

#define jack_get_microseconds GetMicroSeconds

int
JackFFADODriver::ffado_driver_read (ffado_driver_t * driver, jack_nframes_t nframes)
{
57
    channel_t chn;
sletz's avatar
sletz committed
58
59
60
    jack_default_audio_sample_t* buf = NULL;

    printEnter();
sletz's avatar
sletz committed
61
62
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
        // if nothing connected, don't process
sletz's avatar
sletz committed
63
64
        if (fGraphManager->GetConnectionsNum(fCapturePortList[chn]) == 0) {
            buf = (jack_default_audio_sample_t*)driver->scratchbuffer;
sletz's avatar
sletz committed
65
66
67
68
69
70
            // we always have to specify a valid buffer
            ffado_streaming_set_capture_stream_buffer(driver->dev, chn, (char *)(buf));
            // notify the streaming system that it can (but doesn't have to) skip
            // this channel
            ffado_streaming_capture_stream_onoff(driver->dev, chn, 0);
        } else {
sletz's avatar
sletz committed
71
            if (driver->capture_channels[chn].stream_type == ffado_stream_type_audio) {
sletz's avatar
sletz committed
72
73
74
                buf = (jack_default_audio_sample_t*)fGraphManager->GetBuffer(fCapturePortList[chn],  nframes);

                /* if the returned buffer is invalid, use the dummy buffer */
sletz's avatar
sletz committed
75
76
                if (!buf) buf = (jack_default_audio_sample_t*)driver->scratchbuffer;

sletz's avatar
sletz committed
77
78
79
                ffado_streaming_set_capture_stream_buffer(driver->dev, chn, (char *)(buf));
                ffado_streaming_capture_stream_onoff(driver->dev, chn, 1);
            } else if (driver->capture_channels[chn].stream_type == ffado_stream_type_midi) {
sletz's avatar
sletz committed
80
81
                ffado_streaming_set_capture_stream_buffer(driver->dev, chn,
                        (char *)(driver->capture_channels[chn].midi_buffer));
sletz's avatar
sletz committed
82
83
84
85
86
87
                ffado_streaming_capture_stream_onoff(driver->dev, chn, 1);
            } else { // always have a valid buffer
                ffado_streaming_set_capture_stream_buffer(driver->dev, chn, (char *)(driver->scratchbuffer));
                // don't process what we don't use
                ffado_streaming_capture_stream_onoff(driver->dev, chn, 0);
            }
sletz's avatar
sletz committed
88
89
90
        }
    }

sletz's avatar
sletz committed
91
92
    /* now transfer the buffers */
    ffado_streaming_transfer_capture_buffers(driver->dev);
sletz's avatar
sletz committed
93

sletz's avatar
sletz committed
94
95
96
    /* process the midi data */
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
        if (driver->capture_channels[chn].stream_type == ffado_stream_type_midi) {
97
98
99
100
            JackFFADOMidiInput *midi_input = (JackFFADOMidiInput *) driver->capture_channels[chn].midi_input;
            JackMidiBuffer *buffer = (JackMidiBuffer *) fGraphManager->GetBuffer(fCapturePortList[chn], nframes);
            if (! buffer) {
                continue;
sletz's avatar
sletz committed
101
            }
102
103
104
            midi_input->SetInputBuffer(driver->capture_channels[chn].midi_buffer);
            midi_input->SetPortBuffer(buffer);
            midi_input->Process(nframes);
sletz's avatar
sletz committed
105
106
107
108
109
110
111
112
113
114
        }
    }

    printExit();
    return 0;
}

int
JackFFADODriver::ffado_driver_write (ffado_driver_t * driver, jack_nframes_t nframes)
{
115
    channel_t chn;
sletz's avatar
sletz committed
116
    jack_default_audio_sample_t* buf;
sletz's avatar
sletz committed
117
118
119
120
    printEnter();

    driver->process_count++;

sletz's avatar
sletz committed
121
    for (chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
122
123
        if (fGraphManager->GetConnectionsNum(fPlaybackPortList[chn]) == 0) {
            buf = (jack_default_audio_sample_t*)driver->nullbuffer;
sletz's avatar
sletz committed
124
125
126
127
128
129
            // we always have to specify a valid buffer
            ffado_streaming_set_playback_stream_buffer(driver->dev, chn, (char *)(buf));
            // notify the streaming system that it can (but doesn't have to) skip
            // this channel
            ffado_streaming_playback_stream_onoff(driver->dev, chn, 0);
        } else {
sletz's avatar
sletz committed
130
            if (driver->playback_channels[chn].stream_type == ffado_stream_type_audio) {
sletz's avatar
sletz committed
131
132
                buf = (jack_default_audio_sample_t*)fGraphManager->GetBuffer(fPlaybackPortList[chn], nframes);
                /* use the silent buffer if there is no valid jack buffer */
sletz's avatar
sletz committed
133
                if (!buf) buf = (jack_default_audio_sample_t*)driver->nullbuffer;
sletz's avatar
sletz committed
134
                ffado_streaming_set_playback_stream_buffer(driver->dev, chn, (char *)(buf));
pieterpalmers's avatar
pieterpalmers committed
135
                ffado_streaming_playback_stream_onoff(driver->dev, chn, 1);
sletz's avatar
sletz committed
136
137
138
            } else if (driver->playback_channels[chn].stream_type == ffado_stream_type_midi) {
                uint32_t *midi_buffer = driver->playback_channels[chn].midi_buffer;
                memset(midi_buffer, 0, nframes * sizeof(uint32_t));
139
                buf = (jack_default_audio_sample_t *) fGraphManager->GetBuffer(fPlaybackPortList[chn], nframes);
sletz's avatar
sletz committed
140
141
                ffado_streaming_set_playback_stream_buffer(driver->dev, chn, (char *)(midi_buffer));
                /* if the returned buffer is invalid, continue */
sletz's avatar
sletz committed
142
                if (!buf) {
sletz's avatar
sletz committed
143
144
145
146
                    ffado_streaming_playback_stream_onoff(driver->dev, chn, 0);
                    continue;
                }
                ffado_streaming_playback_stream_onoff(driver->dev, chn, 1);
147
148
149
150
                JackFFADOMidiOutput *midi_output = (JackFFADOMidiOutput *) driver->playback_channels[chn].midi_output;
                midi_output->SetPortBuffer((JackMidiBuffer *) buf);
                midi_output->SetOutputBuffer(midi_buffer);
                midi_output->Process(nframes);
sletz's avatar
sletz committed
151

sletz's avatar
sletz committed
152
153
154
            } else { // always have a valid buffer
                ffado_streaming_set_playback_stream_buffer(driver->dev, chn, (char *)(driver->nullbuffer));
                ffado_streaming_playback_stream_onoff(driver->dev, chn, 0);
sletz's avatar
sletz committed
155
156
157
158
159
            }
        }
    }

    ffado_streaming_transfer_playback_buffers(driver->dev);
sletz's avatar
sletz committed
160

sletz's avatar
sletz committed
161
162
163
164
165
166
    printExit();
    return 0;
}

jack_nframes_t
JackFFADODriver::ffado_driver_wait (ffado_driver_t *driver, int extra_fd, int *status,
sletz's avatar
sletz committed
167
                                    float *delayed_usecs)
sletz's avatar
sletz committed
168
169
170
{
    jack_time_t wait_enter;
    jack_time_t wait_ret;
sletz's avatar
sletz committed
171
    ffado_wait_response response;
sletz's avatar
sletz committed
172
173
174
175
176
177

    printEnter();

    wait_enter = jack_get_microseconds ();
    if (wait_enter > driver->wait_next) {
        /*
pieterpalmers's avatar
pieterpalmers committed
178
179
180
181
                * This processing cycle was delayed past the
                * next due interrupt!  Do not account this as
                * a wakeup delay:
                */
sletz's avatar
sletz committed
182
183
184
185
186
187
188
        driver->wait_next = 0;
        driver->wait_late++;
    }
// *status = -2; interrupt
// *status = -3; timeout
// *status = -4; extra FD

sletz's avatar
sletz committed
189
    response = ffado_streaming_wait(driver->dev);
sletz's avatar
sletz committed
190
191
192
193
194
195
196
197

    wait_ret = jack_get_microseconds ();

    if (driver->wait_next && wait_ret > driver->wait_next) {
        *delayed_usecs = wait_ret - driver->wait_next;
    }
    driver->wait_last = wait_ret;
    driver->wait_next = wait_ret + driver->period_usecs;
pieterpalmers's avatar
pieterpalmers committed
198
//         driver->engine->transport_cycle_start (driver->engine, wait_ret);
sletz's avatar
sletz committed
199

sletz's avatar
sletz committed
200
201
202
203
    if(response == ffado_wait_ok) {
       // all good
       *status = 0;
    } else if (response == ffado_wait_xrun) {
sletz's avatar
sletz committed
204
        // xrun happened, but it's handled
sletz's avatar
sletz committed
205
        *status = 0;
sletz's avatar
sletz committed
206
207
208
209
        return 0;
    } else if (response == ffado_wait_error) {
        // an error happened (unhandled xrun)
        // this should be fatal
210
        jack_error("JackFFADODriver::ffado_driver_wait - unhandled xrun");
sletz's avatar
sletz committed
211
        *status = -1;
sletz's avatar
sletz committed
212
        return 0;
sletz's avatar
sletz committed
213
214
215
    } else if (response == ffado_wait_shutdown) {
        // ffado requested shutdown (e.g. device unplugged)
        // this should be fatal
216
217
        jack_error("JackFFADODriver::ffado_driver_wait - shutdown requested "
                   "(device unplugged?)");
sletz's avatar
sletz committed
218
219
220
221
222
        *status = -1;
        return 0;
    } else {
        // unknown response code. should be fatal
        // this should be fatal
223
224
        jack_error("JackFFADODriver::ffado_driver_wait - unexpected error "
                   "code '%d' returned from 'ffado_streaming_wait'", response);
sletz's avatar
sletz committed
225
226
        *status = -1;
        return 0;
sletz's avatar
sletz committed
227
228
    }

sletz's avatar
sletz committed
229
    fBeginDateUst = wait_ret;
sletz's avatar
sletz committed
230
231

    printExit();
sletz's avatar
sletz committed
232
    return driver->period_size;
sletz's avatar
sletz committed
233
234
235
236
237
238
239
240
241
}

int
JackFFADODriver::ffado_driver_start (ffado_driver_t *driver)
{
    int retval = 0;

    if ((retval = ffado_streaming_start(driver->dev))) {
        printError("Could not start streaming threads");
sletz's avatar
sletz committed
242

sletz's avatar
sletz committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
        return retval;
    }
    return 0;
}

int
JackFFADODriver::ffado_driver_stop (ffado_driver_t *driver)
{
    int retval = 0;

    if ((retval = ffado_streaming_stop(driver->dev))) {
        printError("Could not stop streaming threads");
        return retval;
    }

    return 0;
}

int
JackFFADODriver::ffado_driver_restart (ffado_driver_t *driver)
{
    if (Stop())
        return -1;
    return Start();
}

int
JackFFADODriver::SetBufferSize (jack_nframes_t nframes)
{
    printError("Buffer size change requested but not supported!!!");

    /*
sletz's avatar
sletz committed
275
    driver->period_size = nframes; 
sletz's avatar
sletz committed
276
    driver->period_usecs =
pieterpalmers's avatar
pieterpalmers committed
277
278
            (jack_time_t) floor ((((float) nframes) / driver->sample_rate)
                                 * 1000000.0f);
sletz's avatar
sletz committed
279
280
281
282
283
284
285
286
287
288
289
    */

    /* tell the engine to change its buffer size */
    //driver->engine->set_buffer_size (driver->engine, nframes);

    return -1; // unsupported
}

typedef void (*JackDriverFinishFunction) (jack_driver_t *);

ffado_driver_t *
290
JackFFADODriver::ffado_driver_new (const char *name,
sletz's avatar
sletz committed
291
                                   ffado_jack_settings_t *params)
sletz's avatar
sletz committed
292
293
294
295
296
{
    ffado_driver_t *driver;

    assert(params);

sletz's avatar
sletz committed
297
    if (ffado_get_api_version() != FIREWIRE_REQUIRED_FFADO_API_VERSION) {
sletz's avatar
sletz committed
298
299
300
301
302
303
304
305
306
307
308
        printError("Incompatible libffado version! (%s)", ffado_get_version());
        return NULL;
    }

    printMessage("Starting FFADO backend (%s)", ffado_get_version());

    driver = (ffado_driver_t*)calloc (1, sizeof (ffado_driver_t));

    /* Setup the jack interfaces */
    jack_driver_nt_init ((jack_driver_nt_t *) driver);

pieterpalmers's avatar
pieterpalmers committed
309
310
311
312
313
314
315
316
317
318
    /*        driver->nt_attach    = (JackDriverNTAttachFunction)   ffado_driver_attach;
            driver->nt_detach    = (JackDriverNTDetachFunction)   ffado_driver_detach;
            driver->nt_start     = (JackDriverNTStartFunction)    ffado_driver_start;
            driver->nt_stop      = (JackDriverNTStopFunction)     ffado_driver_stop;
            driver->nt_run_cycle = (JackDriverNTRunCycleFunction) ffado_driver_run_cycle;
            driver->null_cycle   = (JackDriverNullCycleFunction)  ffado_driver_null_cycle;
            driver->write        = (JackDriverReadFunction)       ffado_driver_write;
            driver->read         = (JackDriverReadFunction)       ffado_driver_read;
            driver->nt_bufsize   = (JackDriverNTBufSizeFunction)  ffado_driver_bufsize;
            */
sletz's avatar
sletz committed
319
320
321
322
323
324
325

    /* copy command line parameter contents to the driver structure */
    memcpy(&driver->settings, params, sizeof(ffado_jack_settings_t));

    /* prepare all parameters */
    driver->sample_rate = params->sample_rate;
    driver->period_size = params->period_size;
sletz's avatar
sletz committed
326
    fBeginDateUst = 0;
sletz's avatar
sletz committed
327
328
329
330

    driver->period_usecs =
        (jack_time_t) floor ((((float) driver->period_size) * 1000000.0f) / driver->sample_rate);

pieterpalmers's avatar
pieterpalmers committed
331
//         driver->client = client;
sletz's avatar
sletz committed
332
333
334
335
336
337
338
339
340
    driver->engine = NULL;

    memset(&driver->device_options, 0, sizeof(driver->device_options));
    driver->device_options.sample_rate = params->sample_rate;
    driver->device_options.period_size = params->period_size;
    driver->device_options.nb_buffers = params->buffer_size;
    driver->device_options.verbose = params->verbose_level;
    driver->capture_frame_latency = params->capture_frame_latency;
    driver->playback_frame_latency = params->playback_frame_latency;
sletz's avatar
sletz committed
341
    driver->device_options.snoop_mode = params->snoop_mode;
sletz's avatar
sletz committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355

    debugPrint(DEBUG_LEVEL_STARTUP, " Driver compiled on %s %s", __DATE__, __TIME__);
    debugPrint(DEBUG_LEVEL_STARTUP, " Created driver %s", name);
    debugPrint(DEBUG_LEVEL_STARTUP, "            period_size:   %d", driver->device_options.period_size);
    debugPrint(DEBUG_LEVEL_STARTUP, "            period_usecs:  %d", driver->period_usecs);
    debugPrint(DEBUG_LEVEL_STARTUP, "            sample rate:   %d", driver->device_options.sample_rate);
    debugPrint(DEBUG_LEVEL_STARTUP, "            verbose level: %d", driver->device_options.verbose);

    return (ffado_driver_t *) driver;
}

void
JackFFADODriver::ffado_driver_delete (ffado_driver_t *driver)
{
sletz's avatar
sletz committed
356
    free (driver);
sletz's avatar
sletz committed
357
358
359
360
361
362
363
364
365
366
367
}

int JackFFADODriver::Attach()
{
    JackPort* port;
    int port_index;
    char buf[JACK_PORT_NAME_SIZE];
    char portname[JACK_PORT_NAME_SIZE];

    ffado_driver_t* driver = (ffado_driver_t*)fDriver;

sletz's avatar
sletz committed
368
    jack_log("JackFFADODriver::Attach fBufferSize %ld fSampleRate %ld", fEngineControl->fBufferSize, fEngineControl->fSampleRate);
sletz's avatar
sletz committed
369
370
371

    g_verbose = (fEngineControl->fVerbose ? 1 : 0);

sletz's avatar
sletz committed
372
373
374
375
376
    /* preallocate some buffers such that they don't have to be allocated
       in RT context (or from the stack)
     */
    /* the null buffer is a buffer that contains one period of silence */
    driver->nullbuffer = (ffado_sample_t *)calloc(driver->period_size, sizeof(ffado_sample_t));
sletz's avatar
sletz committed
377
    if (driver->nullbuffer == NULL) {
sletz's avatar
sletz committed
378
379
380
381
382
        printError("could not allocate memory for null buffer");
        return -1;
    }
    /* calloc should do this, but it can't hurt to be sure */
    memset(driver->nullbuffer, 0, driver->period_size*sizeof(ffado_sample_t));
sletz's avatar
sletz committed
383

sletz's avatar
sletz committed
384
385
    /* the scratch buffer is a buffer of one period that can be used as dummy memory */
    driver->scratchbuffer = (ffado_sample_t *)calloc(driver->period_size, sizeof(ffado_sample_t));
sletz's avatar
sletz committed
386
    if (driver->scratchbuffer == NULL) {
sletz's avatar
sletz committed
387
388
389
390
        printError("could not allocate memory for scratch buffer");
        return -1;
    }

sletz's avatar
sletz committed
391
392
393
    /* packetizer thread options */
    driver->device_options.realtime = (fEngineControl->fRealTime ? 1 : 0);

394
    driver->device_options.packetizer_priority = fEngineControl->fServerPriority +
sletz's avatar
sletz committed
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
            FFADO_RT_PRIORITY_PACKETIZER_RELATIVE;
    if (driver->device_options.packetizer_priority > 98) {
        driver->device_options.packetizer_priority = 98;
    }

    // initialize the thread
    driver->dev = ffado_streaming_init(driver->device_info, driver->device_options);

    if (!driver->dev) {
        printError("FFADO: Error creating virtual device");
        return -1;
    }

    if (driver->device_options.realtime) {
        printMessage("Streaming thread running with Realtime scheduling, priority %d",
                     driver->device_options.packetizer_priority);
    } else {
        printMessage("Streaming thread running without Realtime scheduling");
    }

sletz's avatar
sletz committed
415
416
    ffado_streaming_set_audio_datatype(driver->dev, ffado_audio_datatype_float);

sletz's avatar
sletz committed
417
418
419
420
    /* ports */

    // capture
    driver->capture_nchannels = ffado_streaming_get_nb_capture_streams(driver->dev);
sletz's avatar
sletz committed
421
422
    driver->capture_channels = (ffado_capture_channel_t *)calloc(driver->capture_nchannels, sizeof(ffado_capture_channel_t));
    if (driver->capture_channels == NULL) {
sletz's avatar
sletz committed
423
424
425
        printError("could not allocate memory for capture channel list");
        return -1;
    }
sletz's avatar
sletz committed
426

sletz's avatar
sletz committed
427
    fCaptureChannels = 0;
428
    for (channel_t chn = 0; chn < driver->capture_nchannels; chn++) {
sletz's avatar
sletz committed
429
        ffado_streaming_get_capture_stream_name(driver->dev, chn, portname, sizeof(portname) - 1);
sletz's avatar
sletz committed
430

sletz's avatar
sletz committed
431
432
        driver->capture_channels[chn].stream_type = ffado_streaming_get_capture_stream_type(driver->dev, chn);
        if (driver->capture_channels[chn].stream_type == ffado_stream_type_audio) {
433
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_in", portname);
sletz's avatar
sletz committed
434
            printMessage ("Registering audio capture port %s", buf);
435
            if ((port_index = fGraphManager->AllocatePort(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
436
                              JACK_DEFAULT_AUDIO_TYPE,
437
                              CaptureDriverFlags,
sletz's avatar
sletz committed
438
                              fEngineControl->fBufferSize)) == NO_PORT) {
sletz's avatar
sletz committed
439
440
441
442
443
444
445
446
447
448
449
450
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

            // setup port parameters
            if (ffado_streaming_set_capture_stream_buffer(driver->dev, chn, NULL)) {
                printError(" cannot configure initial port buffer for %s", buf);
            }
            ffado_streaming_capture_stream_onoff(driver->dev, chn, 0);

            port = fGraphManager->GetPort(port_index);
            port->SetLatency(driver->period_size + driver->capture_frame_latency);
451
452
453
            // capture port aliases (jackd1 style port names)
            snprintf(buf, sizeof(buf) - 1, "%s:capture_%i", fClientControl.fName, (int) chn + 1);
            port->SetAlias(buf);
sletz's avatar
sletz committed
454
            fCapturePortList[chn] = port_index;
sletz's avatar
sletz committed
455
            jack_log("JackFFADODriver::Attach fCapturePortList[i] %ld ", port_index);
sletz's avatar
sletz committed
456
457
            fCaptureChannels++;

sletz's avatar
sletz committed
458
        } else if (driver->capture_channels[chn].stream_type == ffado_stream_type_midi) {
459
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_in", portname);
sletz's avatar
sletz committed
460
            printMessage ("Registering midi capture port %s", buf);
461
            if ((port_index = fGraphManager->AllocatePort(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
462
                              JACK_DEFAULT_MIDI_TYPE,
463
                              CaptureDriverFlags,
sletz's avatar
sletz committed
464
                              fEngineControl->fBufferSize)) == NO_PORT) {
sletz's avatar
sletz committed
465
466
467
468
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

sletz's avatar
sletz committed
469
470
471
472
            // setup port parameters
            if (ffado_streaming_set_capture_stream_buffer(driver->dev, chn, NULL)) {
                printError(" cannot configure initial port buffer for %s", buf);
            }
sletz's avatar
sletz committed
473
            if (ffado_streaming_capture_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
474
475
                printError(" cannot enable port %s", buf);
            }
sletz's avatar
sletz committed
476

477
            driver->capture_channels[chn].midi_input = new JackFFADOMidiInput();
sletz's avatar
sletz committed
478
479
            // setup the midi buffer
            driver->capture_channels[chn].midi_buffer = (uint32_t *)calloc(driver->period_size, sizeof(uint32_t));
sletz's avatar
sletz committed
480
481
482

            port = fGraphManager->GetPort(port_index);
            port->SetLatency(driver->period_size + driver->capture_frame_latency);
sletz's avatar
sletz committed
483
            fCapturePortList[chn] = port_index;
sletz's avatar
sletz committed
484
            jack_log("JackFFADODriver::Attach fCapturePortList[i] %ld ", port_index);
sletz's avatar
sletz committed
485
486
487
            fCaptureChannels++;
        } else {
            printMessage ("Don't register capture port %s", portname);
sletz's avatar
sletz committed
488
489
490
491
492
        }
    }

    // playback
    driver->playback_nchannels = ffado_streaming_get_nb_playback_streams(driver->dev);
sletz's avatar
sletz committed
493
494
    driver->playback_channels = (ffado_playback_channel_t *)calloc(driver->playback_nchannels, sizeof(ffado_playback_channel_t));
    if (driver->playback_channels == NULL) {
sletz's avatar
sletz committed
495
496
497
        printError("could not allocate memory for playback channel list");
        return -1;
    }
sletz's avatar
sletz committed
498

sletz's avatar
sletz committed
499
    fPlaybackChannels = 0;
500
    for (channel_t chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
501
        ffado_streaming_get_playback_stream_name(driver->dev, chn, portname, sizeof(portname) - 1);
sletz's avatar
sletz committed
502

sletz's avatar
sletz committed
503
        driver->playback_channels[chn].stream_type = ffado_streaming_get_playback_stream_type(driver->dev, chn);
sletz's avatar
sletz committed
504

sletz's avatar
sletz committed
505
        if (driver->playback_channels[chn].stream_type == ffado_stream_type_audio) {
506
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_out", portname);
sletz's avatar
sletz committed
507
            printMessage ("Registering audio playback port %s", buf);
508
            if ((port_index = fGraphManager->AllocatePort(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
509
                              JACK_DEFAULT_AUDIO_TYPE,
510
                              PlaybackDriverFlags,
sletz's avatar
sletz committed
511
                              fEngineControl->fBufferSize)) == NO_PORT) {
sletz's avatar
sletz committed
512
513
514
515
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

sletz's avatar
sletz committed
516
517
518
519
            // setup port parameters
            if (ffado_streaming_set_playback_stream_buffer(driver->dev, chn, NULL)) {
                printError(" cannot configure initial port buffer for %s", buf);
            }
sletz's avatar
sletz committed
520
            if (ffado_streaming_playback_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
521
522
                printError(" cannot enable port %s", buf);
            }
sletz's avatar
sletz committed
523
524

            port = fGraphManager->GetPort(port_index);
525
526
            // Add one buffer more latency if "async" mode is used...
            port->SetLatency((driver->period_size * (driver->device_options.nb_buffers - 1)) + ((fEngineControl->fSyncMode) ? 0 : fEngineControl->fBufferSize) + driver->playback_frame_latency);
527
528
529
            // playback port aliases (jackd1 style port names)
            snprintf(buf, sizeof(buf) - 1, "%s:playback_%i", fClientControl.fName, (int) chn + 1);
            port->SetAlias(buf);
sletz's avatar
sletz committed
530
            fPlaybackPortList[chn] = port_index;
sletz's avatar
sletz committed
531
            jack_log("JackFFADODriver::Attach fPlaybackPortList[i] %ld ", port_index);
sletz's avatar
sletz committed
532
            fPlaybackChannels++;
sletz's avatar
sletz committed
533
        } else if (driver->playback_channels[chn].stream_type == ffado_stream_type_midi) {
534
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_out", portname);
sletz's avatar
sletz committed
535
            printMessage ("Registering midi playback port %s", buf);
536
            if ((port_index = fGraphManager->AllocatePort(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
537
                              JACK_DEFAULT_MIDI_TYPE,
538
                              PlaybackDriverFlags,
sletz's avatar
sletz committed
539
                              fEngineControl->fBufferSize)) == NO_PORT) {
sletz's avatar
sletz committed
540
541
542
543
544
545
546
547
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

            // setup port parameters
            if (ffado_streaming_set_playback_stream_buffer(driver->dev, chn, NULL)) {
                printError(" cannot configure initial port buffer for %s", buf);
            }
sletz's avatar
sletz committed
548
            if (ffado_streaming_playback_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
549
550
551
                printError(" cannot enable port %s", buf);
            }
            // setup the midi buffer
552
553
554
555
556
557
            
            // This constructor optionally accepts arguments for the
            // non-realtime buffer size and the realtime buffer size.  Ideally,
            // these would become command-line options for the FFADO driver.
            driver->playback_channels[chn].midi_output = new JackFFADOMidiOutput();

sletz's avatar
sletz committed
558
559
560
561
562
            driver->playback_channels[chn].midi_buffer = (uint32_t *)calloc(driver->period_size, sizeof(uint32_t));

            port = fGraphManager->GetPort(port_index);
            port->SetLatency((driver->period_size * (driver->device_options.nb_buffers - 1)) + driver->playback_frame_latency);
            fPlaybackPortList[chn] = port_index;
sletz's avatar
sletz committed
563
            jack_log("JackFFADODriver::Attach fPlaybackPortList[i] %ld ", port_index);
sletz's avatar
sletz committed
564
565
566
            fPlaybackChannels++;
        } else {
            printMessage ("Don't register playback port %s", portname);
sletz's avatar
sletz committed
567
568
569
        }
    }

sletz's avatar
sletz committed
570
571
    assert(fCaptureChannels < DRIVER_PORT_NUM);
    assert(fPlaybackChannels < DRIVER_PORT_NUM);
sletz's avatar
sletz committed
572

sletz's avatar
sletz committed
573
    if (ffado_streaming_prepare(driver->dev)) {
sletz's avatar
sletz committed
574
575
576
577
578
579
580
581
582
583
584
        printError("Could not prepare streaming device!");
        return -1;
    }

    // this makes no sense...
    assert(fCaptureChannels + fPlaybackChannels > 0);
    return 0;
}

int JackFFADODriver::Detach()
{
585
    channel_t chn;
sletz's avatar
sletz committed
586
    ffado_driver_t* driver = (ffado_driver_t*)fDriver;
sletz's avatar
sletz committed
587
    jack_log("JackFFADODriver::Detach");
sletz's avatar
sletz committed
588
589
590
591
592

    // finish the libfreebob streaming
    ffado_streaming_finish(driver->dev);
    driver->dev = NULL;

sletz's avatar
sletz committed
593
594
    // free all internal buffers
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
sletz's avatar
sletz committed
595
        if (driver->capture_channels[chn].midi_buffer)
sletz's avatar
sletz committed
596
            free(driver->capture_channels[chn].midi_buffer);
597
598
        if (driver->capture_channels[chn].midi_input)
            delete ((JackFFADOMidiInput *) (driver->capture_channels[chn].midi_input));
sletz's avatar
sletz committed
599
    }
sletz's avatar
sletz committed
600
    free(driver->capture_channels);
sletz's avatar
sletz committed
601

sletz's avatar
sletz committed
602
    for (chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
603
        if (driver->playback_channels[chn].midi_buffer)
sletz's avatar
sletz committed
604
            free(driver->playback_channels[chn].midi_buffer);
605
606
        if (driver->playback_channels[chn].midi_output)
            delete ((JackFFADOMidiOutput *) (driver->playback_channels[chn].midi_output));
sletz's avatar
sletz committed
607
608
609
610
611
    }
    free(driver->playback_channels);

    free(driver->nullbuffer);
    free(driver->scratchbuffer);
sletz's avatar
sletz committed
612

sletz's avatar
sletz committed
613
    return JackAudioDriver::Detach();  // Generic JackAudioDriver Detach
sletz's avatar
sletz committed
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
}

int JackFFADODriver::Open(ffado_jack_settings_t *params)
{
    // Generic JackAudioDriver Open
    if (JackAudioDriver::Open(
                params->period_size, params->sample_rate,
                params->playback_ports, params->playback_ports,
                0, 0, 0, "", "",
                params->capture_frame_latency, params->playback_frame_latency) != 0) {
        return -1;
    }

    fDriver = (jack_driver_t *)ffado_driver_new ("ffado_pcm", params);

    if (fDriver) {
        // FFADO driver may have changed the in/out values
sletz's avatar
sletz committed
631
632
        //fCaptureChannels = ((ffado_driver_t *)fDriver)->capture_nchannels_audio;
        //fPlaybackChannels = ((ffado_driver_t *)fDriver)->playback_nchannels_audio;
sletz's avatar
sletz committed
633
634
        return 0;
    } else {
635
        JackAudioDriver::Close();
sletz's avatar
sletz committed
636
637
638
639
640
641
642
643
644
645
646
647
648
        return -1;
    }
}

int JackFFADODriver::Close()
{
    JackAudioDriver::Close();
    ffado_driver_delete((ffado_driver_t*)fDriver);
    return 0;
}

int JackFFADODriver::Start()
{
649
    JackAudioDriver::Start();
sletz's avatar
sletz committed
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
    return ffado_driver_start((ffado_driver_t *)fDriver);
}

int JackFFADODriver::Stop()
{
    return ffado_driver_stop((ffado_driver_t *)fDriver);
}

int JackFFADODriver::Read()
{
    printEnter();

    /* Taken from ffado_driver_run_cycle */
    ffado_driver_t* driver = (ffado_driver_t*)fDriver;
    int wait_status = 0;
sletz's avatar
sletz committed
665
    fDelayedUsecs = 0.f;
sletz's avatar
sletz committed
666

sletz's avatar
sletz committed
667
    jack_nframes_t nframes = ffado_driver_wait(driver, -1, &wait_status,
sletz's avatar
sletz committed
668
                             &fDelayedUsecs);
sletz's avatar
sletz committed
669
670
671
672
673
674
675
676
677
678

    if ((wait_status < 0)) {
        printError( "wait status < 0! (= %d)", wait_status);
        return -1;
    }

    if (nframes == 0) {
        /* we detected an xrun and restarted: notify
         * clients about the delay. 
         */
sletz's avatar
sletz committed
679
        jack_log("FFADO XRun");
sletz's avatar
sletz committed
680
        NotifyXRun(fBeginDateUst, fDelayedUsecs);
sletz's avatar
sletz committed
681
682
683
684
        return -1;
    }

    if (nframes != fEngineControl->fBufferSize)
sletz's avatar
sletz committed
685
        jack_log("JackFFADODriver::Read nframes = %ld", nframes);
686
687
        
    // Has to be done before read
688
    JackDriver::CycleIncTime();
sletz's avatar
sletz committed
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745

    printExit();
    return ffado_driver_read((ffado_driver_t *)fDriver, fEngineControl->fBufferSize);
}

int JackFFADODriver::Write()
{
    printEnter();
    int res = ffado_driver_write((ffado_driver_t *)fDriver, fEngineControl->fBufferSize);
    printExit();
    return res;
}

void
JackFFADODriver::jack_driver_init (jack_driver_t *driver)
{
    memset (driver, 0, sizeof (*driver));

    driver->attach = 0;
    driver->detach = 0;
    driver->write = 0;
    driver->read = 0;
    driver->null_cycle = 0;
    driver->bufsize = 0;
    driver->start = 0;
    driver->stop = 0;
}

void
JackFFADODriver::jack_driver_nt_init (jack_driver_nt_t * driver)
{
    memset (driver, 0, sizeof (*driver));

    jack_driver_init ((jack_driver_t *) driver);

    driver->attach = 0;
    driver->detach = 0;
    driver->bufsize = 0;
    driver->stop = 0;
    driver->start = 0;

    driver->nt_bufsize = 0;
    driver->nt_start = 0;
    driver->nt_stop = 0;
    driver->nt_attach = 0;
    driver->nt_detach = 0;
    driver->nt_run_cycle = 0;
}

} // end of namespace


#ifdef __cplusplus
extern "C"
{
#endif

746
    SERVER_EXPORT const jack_driver_desc_t *
sletz's avatar
sletz committed
747
748
749
750
751
752
753
    driver_get_descriptor () {
        jack_driver_desc_t * desc;
        jack_driver_param_desc_t * params;
        unsigned int i;

        desc = (jack_driver_desc_t *)calloc (1, sizeof (jack_driver_desc_t));

754
755
756
        strcpy (desc->name, "firewire");                               // size MUST be less then JACK_DRIVER_NAME_MAX + 1
        strcpy(desc->desc, "Linux FFADO API based audio backend");     // size MUST be less then JACK_DRIVER_PARAM_DESC + 1
       
sletz's avatar
sletz committed
757
        desc->nparams = 13;
sletz's avatar
sletz committed
758
759
760
761
762

        params = (jack_driver_param_desc_t *)calloc (desc->nparams, sizeof (jack_driver_param_desc_t));
        desc->params = params;

        i = 0;
sletz's avatar
sletz committed
763
764
765
766
767
768
769
770
        strcpy (params[i].name, "device");
        params[i].character  = 'd';
        params[i].type       = JackDriverParamString;
        strcpy (params[i].value.str,  "hw:0");
        strcpy (params[i].short_desc, "The FireWire device to use.");
        strcpy (params[i].long_desc,  "The FireWire device to use. Please consult the FFADO documentation for more info.");

        i++;
sletz's avatar
sletz committed
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
        strcpy (params[i].name, "period");
        params[i].character  = 'p';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui   = 1024;
        strcpy (params[i].short_desc, "Frames per period");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "nperiods");
        params[i].character  = 'n';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui   = 3;
        strcpy (params[i].short_desc, "Number of periods of playback latency");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "rate");
        params[i].character  = 'r';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui   = 48000U;
        strcpy (params[i].short_desc, "Sample rate");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "capture");
        params[i].character  = 'C';
        params[i].type       = JackDriverParamBool;
        params[i].value.i    = 0;
        strcpy (params[i].short_desc, "Provide capture ports.");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "playback");
        params[i].character  = 'P';
        params[i].type       = JackDriverParamBool;
        params[i].value.i    = 0;
        strcpy (params[i].short_desc, "Provide playback ports.");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "duplex");
        params[i].character  = 'D';
        params[i].type       = JackDriverParamBool;
        params[i].value.i    = 1;
        strcpy (params[i].short_desc, "Provide both capture and playback ports.");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "input-latency");
        params[i].character  = 'I';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui    = 0;
        strcpy (params[i].short_desc, "Extra input latency (frames)");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "output-latency");
        params[i].character  = 'O';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui    = 0;
        strcpy (params[i].short_desc, "Extra output latency (frames)");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "inchannels");
        params[i].character  = 'i';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui    = 0;
        strcpy (params[i].short_desc, "Number of input channels to provide (note: currently ignored)");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "outchannels");
        params[i].character  = 'o';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui    = 0;
        strcpy (params[i].short_desc, "Number of output channels to provide (note: currently ignored)");
        strcpy (params[i].long_desc, params[i].short_desc);

        i++;
        strcpy (params[i].name, "verbose");
        params[i].character  = 'v';
        params[i].type       = JackDriverParamUInt;
        params[i].value.ui    = 3;
        strcpy (params[i].short_desc, "libffado verbose level");
        strcpy (params[i].long_desc, params[i].short_desc);

sletz's avatar
sletz committed
858
859
860
861
862
863
864
865
        i++;
        strcpy (params[i].name, "snoop");
        params[i].character  = 'X';
        params[i].type       = JackDriverParamBool;
        params[i].value.i    = 0;
        strcpy (params[i].short_desc, "Snoop firewire traffic");
        strcpy (params[i].long_desc, params[i].short_desc);

sletz's avatar
sletz committed
866
867
868
        return desc;
    }

869
    SERVER_EXPORT Jack::JackDriverClientInterface* driver_initialize(Jack::JackLockedEngine* engine, Jack::JackSynchro* table, const JSList* params) {
sletz's avatar
sletz committed
870
871
872
873
874
        const JSList * node;
        const jack_driver_param_t * param;

        ffado_jack_settings_t cmlparams;

sletz's avatar
sletz committed
875
        char *device_name=(char*)"hw:0";
pieterpalmers's avatar
pieterpalmers committed
876

sletz's avatar
sletz committed
877
878
879
880
881
882
883
884
885
886
887
888
889
        cmlparams.period_size_set = 0;
        cmlparams.sample_rate_set = 0;
        cmlparams.buffer_size_set = 0;

        /* default values */
        cmlparams.period_size = 1024;
        cmlparams.sample_rate = 48000;
        cmlparams.buffer_size = 3;
        cmlparams.playback_ports = 0;
        cmlparams.capture_ports = 0;
        cmlparams.playback_frame_latency = 0;
        cmlparams.capture_frame_latency = 0;

sletz's avatar
sletz committed
890
891
892
893
894
895
        cmlparams.verbose_level = 0;

        cmlparams.slave_mode = 0;
        cmlparams.snoop_mode = 0;
        cmlparams.device_info = NULL;

sletz's avatar
sletz committed
896
897
898
899
        for (node = params; node; node = jack_slist_next (node)) {
            param = (jack_driver_param_t *) node->data;

            switch (param->character) {
pieterpalmers's avatar
pieterpalmers committed
900
                case 'd':
sletz's avatar
sletz committed
901
                    device_name = const_cast<char*>(param->value.str);
pieterpalmers's avatar
pieterpalmers committed
902
                    break;
sletz's avatar
sletz committed
903
904
905
906
907
908
909
910
911
912
913
914
                case 'p':
                    cmlparams.period_size = param->value.ui;
                    cmlparams.period_size_set = 1;
                    break;
                case 'n':
                    cmlparams.buffer_size = param->value.ui;
                    cmlparams.buffer_size_set = 1;
                    break;
                case 'r':
                    cmlparams.sample_rate = param->value.ui;
                    cmlparams.sample_rate_set = 1;
                    break;
pieterpalmers's avatar
pieterpalmers committed
915
916
                case 'i':
                    cmlparams.capture_ports = param->value.ui;
sletz's avatar
sletz committed
917
                    break;
pieterpalmers's avatar
pieterpalmers committed
918
919
                case 'o':
                    cmlparams.playback_ports = param->value.ui;
sletz's avatar
sletz committed
920
921
922
923
924
925
926
                    break;
                case 'I':
                    cmlparams.capture_frame_latency = param->value.ui;
                    break;
                case 'O':
                    cmlparams.playback_frame_latency = param->value.ui;
                    break;
pieterpalmers's avatar
pieterpalmers committed
927
928
                case 'x':
                    cmlparams.slave_mode = param->value.ui;
sletz's avatar
sletz committed
929
                    break;
pieterpalmers's avatar
pieterpalmers committed
930
                case 'X':
sletz's avatar
sletz committed
931
                    cmlparams.snoop_mode = param->value.i;
sletz's avatar
sletz committed
932
933
934
935
936
937
938
939
                    break;
                case 'v':
                    cmlparams.verbose_level = param->value.ui;
            }
        }

        /* duplex is the default */
        if (!cmlparams.playback_ports && !cmlparams.capture_ports) {
pieterpalmers's avatar
pieterpalmers committed
940
941
            cmlparams.playback_ports = 1;
            cmlparams.capture_ports = 1;
sletz's avatar
sletz committed
942
943
        }

pieterpalmers's avatar
pieterpalmers committed
944
945
946
        // temporary
        cmlparams.device_info = device_name;

947
        Jack::JackFFADODriver* ffado_driver = new Jack::JackFFADODriver("system", "firewire_pcm", engine, table);
sletz's avatar
sletz committed
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
        Jack::JackDriverClientInterface* threaded_driver = new Jack::JackThreadedDriver(ffado_driver);
        // Special open for FFADO driver...
        if (ffado_driver->Open(&cmlparams) == 0) {
            return threaded_driver;
        } else {
            delete threaded_driver; // Delete the decorated driver
            return NULL;
        }
    }

#ifdef __cplusplus
}
#endif