JackFFADODriver.cpp 35.9 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
6
Copyright (C) 2012 Jonathan Woithe, Adrian Knoth
sletz's avatar
sletz committed
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
39

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"
40
41
#include "JackFFADOMidiInputPort.h"
#include "JackFFADOMidiOutputPort.h"
sletz's avatar
sletz committed
42
43
44
45
#include "JackEngineControl.h"
#include "JackClientControl.h"
#include "JackPort.h"
#include "JackGraphManager.h"
46
#include "JackCompilerDeps.h"
47
#include "JackLockedEngine.h"
sletz's avatar
sletz committed
48
49
50
51

namespace Jack
{

52
53
// Basic functionality requires API version 8.  If version 9 or later
// is present the buffers can be resized at runtime.
sletz's avatar
sletz committed
54
#define FIREWIRE_REQUIRED_FFADO_API_VERSION 8
55
#define FIREWIRE_REQUIRED_FFADO_API_VERSION_FOR_SETBUFSIZE 9
sletz's avatar
sletz committed
56
57
58
59
60
61

#define jack_get_microseconds GetMicroSeconds

int
JackFFADODriver::ffado_driver_read (ffado_driver_t * driver, jack_nframes_t nframes)
{
62
    channel_t chn;
sletz's avatar
sletz committed
63
64
65
    jack_default_audio_sample_t* buf = NULL;

    printEnter();
sletz's avatar
sletz committed
66
67
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
        // if nothing connected, don't process
sletz's avatar
sletz committed
68
69
        if (fGraphManager->GetConnectionsNum(fCapturePortList[chn]) == 0) {
            buf = (jack_default_audio_sample_t*)driver->scratchbuffer;
sletz's avatar
sletz committed
70
71
72
73
74
75
            // 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
76
            if (driver->capture_channels[chn].stream_type == ffado_stream_type_audio) {
sletz's avatar
sletz committed
77
78
79
                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
80
81
                if (!buf) buf = (jack_default_audio_sample_t*)driver->scratchbuffer;

sletz's avatar
sletz committed
82
83
84
                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
85
86
                ffado_streaming_set_capture_stream_buffer(driver->dev, chn,
                        (char *)(driver->capture_channels[chn].midi_buffer));
sletz's avatar
sletz committed
87
88
89
90
91
92
                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
93
94
95
        }
    }

sletz's avatar
sletz committed
96
97
    /* now transfer the buffers */
    ffado_streaming_transfer_capture_buffers(driver->dev);
sletz's avatar
sletz committed
98

sletz's avatar
sletz committed
99
100
101
    /* process the midi data */
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
        if (driver->capture_channels[chn].stream_type == ffado_stream_type_midi) {
102
            JackFFADOMidiInputPort *midi_input = (JackFFADOMidiInputPort *) driver->capture_channels[chn].midi_input;
103
            JackMidiBuffer *buffer = (JackMidiBuffer *) fGraphManager->GetBuffer(fCapturePortList[chn], nframes);
104
            midi_input->Process(buffer, driver->capture_channels[chn].midi_buffer, 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
                ffado_streaming_set_playback_stream_buffer(driver->dev, chn, (char *)(midi_buffer));
141
142
143
                ffado_streaming_playback_stream_onoff(driver->dev, chn, buf ? 1 : 0);
                JackFFADOMidiOutputPort *midi_output = (JackFFADOMidiOutputPort *) driver->playback_channels[chn].midi_output;
                midi_output->Process((JackMidiBuffer *) buf, midi_buffer, nframes);
sletz's avatar
sletz committed
144

sletz's avatar
sletz committed
145
146
147
            } 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
148
149
150
151
152
153
154
155
156
157
            }
        }
    }
    ffado_streaming_transfer_playback_buffers(driver->dev);
    printExit();
    return 0;
}

jack_nframes_t
JackFFADODriver::ffado_driver_wait (ffado_driver_t *driver, int extra_fd, int *status,
sletz's avatar
sletz committed
158
                                    float *delayed_usecs)
sletz's avatar
sletz committed
159
160
161
{
    jack_time_t wait_enter;
    jack_time_t wait_ret;
sletz's avatar
sletz committed
162
    ffado_wait_response response;
sletz's avatar
sletz committed
163
164
165
166
167
168

    printEnter();

    wait_enter = jack_get_microseconds ();
    if (wait_enter > driver->wait_next) {
        /*
pieterpalmers's avatar
pieterpalmers committed
169
170
171
172
                * This processing cycle was delayed past the
                * next due interrupt!  Do not account this as
                * a wakeup delay:
                */
sletz's avatar
sletz committed
173
174
175
176
177
178
179
        driver->wait_next = 0;
        driver->wait_late++;
    }
// *status = -2; interrupt
// *status = -3; timeout
// *status = -4; extra FD

sletz's avatar
sletz committed
180
    response = ffado_streaming_wait(driver->dev);
sletz's avatar
sletz committed
181
182
183
184
185
186
187
188

    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
189
//         driver->engine->transport_cycle_start (driver->engine, wait_ret);
sletz's avatar
sletz committed
190

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

sletz's avatar
sletz committed
220
    fBeginDateUst = wait_ret;
sletz's avatar
sletz committed
221
222

    printExit();
sletz's avatar
sletz committed
223
    return driver->period_size;
sletz's avatar
sletz committed
224
225
226
227
228
229
230
231
232
}

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
233

sletz's avatar
sletz committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
        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();
}

260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
void
JackFFADODriver::UpdateLatencies(void)
{
    jack_latency_range_t range;
    ffado_driver_t* driver = (ffado_driver_t*)fDriver;

    for (int i = 0; i < fCaptureChannels; i++) {
        range.min = range.max = driver->period_size + driver->capture_frame_latency;
        fGraphManager->GetPort(fCapturePortList[i])->SetLatencyRange(JackCaptureLatency, &range);
    }

    for (int i = 0; i < fPlaybackChannels; i++) {
        // Add one buffer more latency if "async" mode is used...
        range.min = range.max = (driver->period_size *
			(driver->device_options.nb_buffers - 1)) +
                         ((fEngineControl->fSyncMode) ? 0 : fEngineControl->fBufferSize) + driver->playback_frame_latency;
        fGraphManager->GetPort(fPlaybackPortList[i])->SetLatencyRange(JackPlaybackLatency, &range);
        // Monitor port
        if (fWithMonitorPorts) {
            range.min = range.max =driver->period_size;
            fGraphManager->GetPort(fMonitorPortList[i])->SetLatencyRange(JackCaptureLatency, &range);
        }
    }
}

sletz's avatar
sletz committed
285
286
287
int
JackFFADODriver::SetBufferSize (jack_nframes_t nframes)
{
288
289
290
291
292
293
294
295
296
297
    ffado_driver_t* driver = (ffado_driver_t*)fDriver;
    signed int chn;

    // The speed of this function isn't critical; we can afford the
    // time to check the FFADO API version.
    if (ffado_get_api_version() < FIREWIRE_REQUIRED_FFADO_API_VERSION_FOR_SETBUFSIZE ||
		    ffado_streaming_set_period_size == NULL) {
	    printError("unsupported on current version of FFADO; please upgrade FFADO");
	    return -1;
    }
sletz's avatar
sletz committed
298

299
    driver->period_size = nframes;
sletz's avatar
sletz committed
300
    driver->period_usecs =
pieterpalmers's avatar
pieterpalmers committed
301
302
            (jack_time_t) floor ((((float) nframes) / driver->sample_rate)
                                 * 1000000.0f);
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342


    // Reallocate the null and scratch buffers.
    driver->nullbuffer = (ffado_sample_t*) calloc(driver->period_size, sizeof(ffado_sample_t));
    if(driver->nullbuffer == NULL) {
	    printError("could not allocate memory for null buffer");
	    return -1;
    }
    driver->scratchbuffer = (ffado_sample_t*) calloc(driver->period_size, sizeof(ffado_sample_t));
    if(driver->scratchbuffer == NULL) {
	    printError("could not allocate memory for scratch buffer");
	    return -1;
    }

    // MIDI buffers need reallocating
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
	    if(driver->capture_channels[chn].stream_type == ffado_stream_type_midi) {
		    // setup the midi buffer
		    if (driver->capture_channels[chn].midi_buffer != NULL)
			    free(driver->capture_channels[chn].midi_buffer);
		    driver->capture_channels[chn].midi_buffer = (ffado_sample_t*) calloc(driver->period_size, sizeof(uint32_t));
	    }
    }
    for (chn = 0; chn < driver->playback_nchannels; chn++) {
	    if(driver->playback_channels[chn].stream_type == ffado_stream_type_midi) {
		    if (driver->playback_channels[chn].midi_buffer != NULL)
			    free(driver->playback_channels[chn].midi_buffer);
		    driver->playback_channels[chn].midi_buffer = (ffado_sample_t*) calloc(driver->period_size, sizeof(uint32_t));
	    }
    }

    // Notify FFADO of the period size change
    if (ffado_streaming_set_period_size(driver->dev, nframes) != 0) {
	    printError("could not alter FFADO device period size");
	    return -1;
    }

    // This is needed to give the shadow variables a chance to
    // properly update to the changes.
    sleep(1);
sletz's avatar
sletz committed
343
344

    /* tell the engine to change its buffer size */
345
    JackAudioDriver::SetBufferSize(nframes);  // Generic change, never fails
sletz's avatar
sletz committed
346

347
348
349
    UpdateLatencies();

    return 0;
sletz's avatar
sletz committed
350
351
352
353
354
}

typedef void (*JackDriverFinishFunction) (jack_driver_t *);

ffado_driver_t *
355
JackFFADODriver::ffado_driver_new (const char *name,
sletz's avatar
sletz committed
356
                                   ffado_jack_settings_t *params)
sletz's avatar
sletz committed
357
358
359
360
361
{
    ffado_driver_t *driver;

    assert(params);

362
    if (ffado_get_api_version() < FIREWIRE_REQUIRED_FFADO_API_VERSION) {
sletz's avatar
sletz committed
363
364
365
366
367
368
369
370
371
372
373
        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
374
375
376
377
378
379
380
381
382
383
    /*        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
384
385
386
387
388
389
390

    /* 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
391
    fBeginDateUst = 0;
sletz's avatar
sletz committed
392
393
394
395

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

pieterpalmers's avatar
pieterpalmers committed
396
//         driver->client = client;
sletz's avatar
sletz committed
397
398
399
400
401
402
403
404
405
    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
406
    driver->device_options.snoop_mode = params->snoop_mode;
sletz's avatar
sletz committed
407
408
409
410
411
412
413
414
415
416
417
418
419
420

    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
421
    free (driver);
sletz's avatar
sletz committed
422
423
424
425
426
}

int JackFFADODriver::Attach()
{
    JackPort* port;
Stephane Letz's avatar
Stephane Letz committed
427
    jack_port_id_t port_index;
sletz's avatar
sletz committed
428
429
    char buf[REAL_JACK_PORT_NAME_SIZE];
    char portname[REAL_JACK_PORT_NAME_SIZE];
sletz's avatar
sletz committed
430
431
432

    ffado_driver_t* driver = (ffado_driver_t*)fDriver;

sletz's avatar
sletz committed
433
    jack_log("JackFFADODriver::Attach fBufferSize %ld fSampleRate %ld", fEngineControl->fBufferSize, fEngineControl->fSampleRate);
sletz's avatar
sletz committed
434
435
436

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

sletz's avatar
sletz committed
437
438
439
440
441
    /* 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
442
    if (driver->nullbuffer == NULL) {
sletz's avatar
sletz committed
443
444
445
446
447
        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
448

sletz's avatar
sletz committed
449
450
    /* 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
451
    if (driver->scratchbuffer == NULL) {
sletz's avatar
sletz committed
452
453
454
455
        printError("could not allocate memory for scratch buffer");
        return -1;
    }

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

459
    driver->device_options.packetizer_priority = fEngineControl->fServerPriority +
sletz's avatar
sletz committed
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
            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
480
481
    ffado_streaming_set_audio_datatype(driver->dev, ffado_audio_datatype_float);

sletz's avatar
sletz committed
482
483
484
485
    /* ports */

    // capture
    driver->capture_nchannels = ffado_streaming_get_nb_capture_streams(driver->dev);
sletz's avatar
sletz committed
486
487
    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
488
489
490
        printError("could not allocate memory for capture channel list");
        return -1;
    }
sletz's avatar
sletz committed
491

sletz's avatar
sletz committed
492
    fCaptureChannels = 0;
493
    for (channel_t chn = 0; chn < driver->capture_nchannels; chn++) {
sletz's avatar
sletz committed
494
        ffado_streaming_get_capture_stream_name(driver->dev, chn, portname, sizeof(portname));
sletz's avatar
sletz committed
495

sletz's avatar
sletz committed
496
497
        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) {
sletz's avatar
sletz committed
498
            snprintf(buf, sizeof(buf), "firewire_pcm:%s_in", portname);
sletz's avatar
sletz committed
499
            printMessage ("Registering audio capture port %s", buf);
500
            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
501
                              JACK_DEFAULT_AUDIO_TYPE,
502
                              CaptureDriverFlags,
503
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
504
505
506
507
508
509
510
511
512
513
514
                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);
515
            // capture port aliases (jackd1 style port names)
sletz's avatar
sletz committed
516
            snprintf(buf, sizeof(buf), "%s:capture_%i", fClientControl.fName, (int) chn + 1);
517
            port->SetAlias(buf);
sletz's avatar
sletz committed
518
            fCapturePortList[chn] = port_index;
sletz's avatar
sletz committed
519
            jack_log("JackFFADODriver::Attach fCapturePortList[i] %ld ", port_index);
sletz's avatar
sletz committed
520
            fCaptureChannels++;
sletz's avatar
sletz committed
521
        } else if (driver->capture_channels[chn].stream_type == ffado_stream_type_midi) {
sletz's avatar
sletz committed
522
            snprintf(buf, sizeof(buf), "firewire_pcm:%s_in", portname);
sletz's avatar
sletz committed
523
            printMessage ("Registering midi capture port %s", buf);
524
            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
525
                              JACK_DEFAULT_MIDI_TYPE,
526
                              CaptureDriverFlags,
527
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
528
529
530
531
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

sletz's avatar
sletz committed
532
533
534
535
            // 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
536
            if (ffado_streaming_capture_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
537
538
                printError(" cannot enable port %s", buf);
            }
sletz's avatar
sletz committed
539

540
            driver->capture_channels[chn].midi_input = new JackFFADOMidiInputPort();
sletz's avatar
sletz committed
541
542
            // setup the midi buffer
            driver->capture_channels[chn].midi_buffer = (uint32_t *)calloc(driver->period_size, sizeof(uint32_t));
sletz's avatar
sletz committed
543

sletz's avatar
sletz committed
544
            fCapturePortList[chn] = port_index;
sletz's avatar
sletz committed
545
            jack_log("JackFFADODriver::Attach fCapturePortList[i] %ld ", port_index);
sletz's avatar
sletz committed
546
547
548
            fCaptureChannels++;
        } else {
            printMessage ("Don't register capture port %s", portname);
sletz's avatar
sletz committed
549
550
551
552
553
        }
    }

    // playback
    driver->playback_nchannels = ffado_streaming_get_nb_playback_streams(driver->dev);
sletz's avatar
sletz committed
554
555
    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
556
557
558
        printError("could not allocate memory for playback channel list");
        return -1;
    }
sletz's avatar
sletz committed
559

sletz's avatar
sletz committed
560
    fPlaybackChannels = 0;
561
    for (channel_t chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
562
        ffado_streaming_get_playback_stream_name(driver->dev, chn, portname, sizeof(portname));
sletz's avatar
sletz committed
563

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

sletz's avatar
sletz committed
566
        if (driver->playback_channels[chn].stream_type == ffado_stream_type_audio) {
sletz's avatar
sletz committed
567
            snprintf(buf, sizeof(buf), "firewire_pcm:%s_out", portname);
sletz's avatar
sletz committed
568
            printMessage ("Registering audio playback port %s", buf);
569
            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
570
                              JACK_DEFAULT_AUDIO_TYPE,
571
                              PlaybackDriverFlags,
572
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
573
574
575
576
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

sletz's avatar
sletz committed
577
578
579
580
            // 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
581
            if (ffado_streaming_playback_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
582
583
                printError(" cannot enable port %s", buf);
            }
sletz's avatar
sletz committed
584
585

            port = fGraphManager->GetPort(port_index);
586
            // Add one buffer more latency if "async" mode is used...
587
            // playback port aliases (jackd1 style port names)
sletz's avatar
sletz committed
588
            snprintf(buf, sizeof(buf), "%s:playback_%i", fClientControl.fName, (int) chn + 1);
589
            port->SetAlias(buf);
sletz's avatar
sletz committed
590
            fPlaybackPortList[chn] = port_index;
sletz's avatar
sletz committed
591
            jack_log("JackFFADODriver::Attach fPlaybackPortList[i] %ld ", port_index);
sletz's avatar
sletz committed
592
            fPlaybackChannels++;
sletz's avatar
sletz committed
593
        } else if (driver->playback_channels[chn].stream_type == ffado_stream_type_midi) {
sletz's avatar
sletz committed
594
            snprintf(buf, sizeof(buf), "firewire_pcm:%s_out", portname);
sletz's avatar
sletz committed
595
            printMessage ("Registering midi playback port %s", buf);
596
597

            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
598
                              JACK_DEFAULT_MIDI_TYPE,
599
                              PlaybackDriverFlags,
600
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
601
602
603
604
605
606
607
608
                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
609
            if (ffado_streaming_playback_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
610
611
612
                printError(" cannot enable port %s", buf);
            }
            // setup the midi buffer
613

614
615
616
            // 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.
617
            driver->playback_channels[chn].midi_output = new JackFFADOMidiOutputPort();
618

sletz's avatar
sletz committed
619
620
621
            driver->playback_channels[chn].midi_buffer = (uint32_t *)calloc(driver->period_size, sizeof(uint32_t));

            fPlaybackPortList[chn] = port_index;
sletz's avatar
sletz committed
622
            jack_log("JackFFADODriver::Attach fPlaybackPortList[i] %ld ", port_index);
sletz's avatar
sletz committed
623
624
625
            fPlaybackChannels++;
        } else {
            printMessage ("Don't register playback port %s", portname);
sletz's avatar
sletz committed
626
627
628
        }
    }

629
630
    UpdateLatencies();

sletz's avatar
sletz committed
631
632
    assert(fCaptureChannels < DRIVER_PORT_NUM);
    assert(fPlaybackChannels < DRIVER_PORT_NUM);
sletz's avatar
sletz committed
633

sletz's avatar
sletz committed
634
    if (ffado_streaming_prepare(driver->dev)) {
sletz's avatar
sletz committed
635
636
637
638
639
640
641
642
643
644
645
        printError("Could not prepare streaming device!");
        return -1;
    }

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

int JackFFADODriver::Detach()
{
646
    channel_t chn;
sletz's avatar
sletz committed
647
    ffado_driver_t* driver = (ffado_driver_t*)fDriver;
sletz's avatar
sletz committed
648
    jack_log("JackFFADODriver::Detach");
sletz's avatar
sletz committed
649
650
651
652
653

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

sletz's avatar
sletz committed
654
655
    // free all internal buffers
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
sletz's avatar
sletz committed
656
        if (driver->capture_channels[chn].midi_buffer)
sletz's avatar
sletz committed
657
            free(driver->capture_channels[chn].midi_buffer);
658
        if (driver->capture_channels[chn].midi_input)
659
            delete ((JackFFADOMidiInputPort *) (driver->capture_channels[chn].midi_input));
sletz's avatar
sletz committed
660
    }
sletz's avatar
sletz committed
661
    free(driver->capture_channels);
sletz's avatar
sletz committed
662

sletz's avatar
sletz committed
663
    for (chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
664
        if (driver->playback_channels[chn].midi_buffer)
sletz's avatar
sletz committed
665
            free(driver->playback_channels[chn].midi_buffer);
666
        if (driver->playback_channels[chn].midi_output)
667
            delete ((JackFFADOMidiOutputPort *) (driver->playback_channels[chn].midi_output));
sletz's avatar
sletz committed
668
669
670
671
672
    }
    free(driver->playback_channels);

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

sletz's avatar
sletz committed
674
    return JackAudioDriver::Detach();  // Generic JackAudioDriver Detach
sletz's avatar
sletz committed
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
}

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
692
693
        //fCaptureChannels = ((ffado_driver_t *)fDriver)->capture_nchannels_audio;
        //fPlaybackChannels = ((ffado_driver_t *)fDriver)->playback_nchannels_audio;
sletz's avatar
sletz committed
694
695
        return 0;
    } else {
696
        JackAudioDriver::Close();
sletz's avatar
sletz committed
697
698
699
700
701
702
        return -1;
    }
}

int JackFFADODriver::Close()
{
703
704
705
    // Generic audio driver close
    int res = JackAudioDriver::Close();

sletz's avatar
sletz committed
706
    ffado_driver_delete((ffado_driver_t*)fDriver);
707
    return res;
sletz's avatar
sletz committed
708
709
710
711
}

int JackFFADODriver::Start()
{
712
713
714
715
716
717
718
719
    int res = JackAudioDriver::Start();
    if (res >= 0) {
        res = ffado_driver_start((ffado_driver_t *)fDriver);
        if (res < 0) {
            JackAudioDriver::Stop();
        }
    }
    return res;
sletz's avatar
sletz committed
720
721
722
723
}

int JackFFADODriver::Stop()
{
724
725
726
727
728
    int res = ffado_driver_stop((ffado_driver_t *)fDriver);
    if (JackAudioDriver::Stop() < 0) {
        res = -1;
    }
    return res;
sletz's avatar
sletz committed
729
730
731
732
733
734
735
736
737
}

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
738
    fDelayedUsecs = 0.f;
sletz's avatar
sletz committed
739

740
741
retry:

sletz's avatar
sletz committed
742
    jack_nframes_t nframes = ffado_driver_wait(driver, -1, &wait_status,
sletz's avatar
sletz committed
743
                             &fDelayedUsecs);
sletz's avatar
sletz committed
744
745
746
747
748
749
750
751

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

    if (nframes == 0) {
        /* we detected an xrun and restarted: notify
752
         * clients about the delay.
sletz's avatar
sletz committed
753
         */
sletz's avatar
sletz committed
754
        jack_log("FFADO XRun");
sletz's avatar
sletz committed
755
        NotifyXRun(fBeginDateUst, fDelayedUsecs);
756
        goto retry; /* recoverable error*/
sletz's avatar
sletz committed
757
758
759
    }

    if (nframes != fEngineControl->fBufferSize)
760
        jack_log("JackFFADODriver::Read warning nframes = %ld", nframes);
761

762
    // Has to be done before read
763
    JackDriver::CycleIncTime();
sletz's avatar
sletz committed
764
765
766
767
768
769
770
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

    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

821
    SERVER_EXPORT const jack_driver_desc_t *
sletz's avatar
sletz committed
822
823
    driver_get_descriptor () {
        jack_driver_desc_t * desc;
824
825
826
        jack_driver_desc_filler_t filler;
        jack_driver_param_value_t value;

827
        desc = jack_driver_descriptor_construct("firewire", JackDriverMaster, "Linux FFADO API based audio backend", &filler);
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
858
859
860
861
862
863
864
865
866
867
868
869

        strcpy(value.str, "hw:0");
        jack_driver_descriptor_add_parameter(
            desc,
            &filler,
            "device",
            'd',
            JackDriverParamString,
            &value,
            NULL,
            "The FireWire device to use.",
            "The FireWire device to use. Please consult the FFADO documentation for more info.");

        value.ui = 1024;
        jack_driver_descriptor_add_parameter(desc, &filler, "period", 'p', JackDriverParamUInt, &value, NULL, "Frames per period", NULL);

        value.ui = 3;
        jack_driver_descriptor_add_parameter(desc, &filler, "nperiods", 'n', JackDriverParamUInt, &value, NULL, "Number of periods of playback latency", NULL);

        value.ui = 48000U;
        jack_driver_descriptor_add_parameter(desc, &filler, "rate", 'r', JackDriverParamUInt, &value, NULL, "Sample rate", NULL);

        value.i = 0;
        jack_driver_descriptor_add_parameter(desc, &filler, "capture", 'C', JackDriverParamBool, &value, NULL, "Provide capture ports.", NULL);
        jack_driver_descriptor_add_parameter(desc, &filler, "playback", 'P', JackDriverParamBool, &value, NULL, "Provide playback ports.", NULL);

        value.i = 1;
        jack_driver_descriptor_add_parameter(desc, &filler, "duplex", 'D', JackDriverParamBool, &value, NULL, "Provide both capture and playback ports.", NULL);

        value.ui = 0;
        jack_driver_descriptor_add_parameter(desc, &filler, "input-latency", 'I', JackDriverParamUInt, &value, NULL, "Extra input latency (frames)", NULL);
        jack_driver_descriptor_add_parameter(desc, &filler, "output-latency", 'O', JackDriverParamUInt, &value, NULL, "Extra output latency (frames)", NULL);

        value.ui = 0;
        jack_driver_descriptor_add_parameter(desc, &filler, "inchannels", 'i', JackDriverParamUInt, &value, NULL, "Number of input channels to provide (note: currently ignored)", NULL);
        jack_driver_descriptor_add_parameter(desc, &filler, "outchannels", 'o', JackDriverParamUInt, &value, NULL, "Number of output channels to provide (note: currently ignored)", NULL);

        value.ui = 3;
        jack_driver_descriptor_add_parameter(desc, &filler, "verbose", 'v', JackDriverParamUInt, &value, NULL, "libffado verbose level", NULL);

        value.i = 0;
        jack_driver_descriptor_add_parameter(desc, &filler, "snoop", 'X', JackDriverParamBool, &value, NULL, "Snoop firewire traffic", NULL);
sletz's avatar
sletz committed
870

sletz's avatar
sletz committed
871
872
873
        return desc;
    }

874
    SERVER_EXPORT Jack::JackDriverClientInterface* driver_initialize(Jack::JackLockedEngine* engine, Jack::JackSynchro* table, const JSList* params) {
sletz's avatar
sletz committed
875
876
877
878
879
        const JSList * node;
        const jack_driver_param_t * param;

        ffado_jack_settings_t cmlparams;

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

sletz's avatar
sletz committed
882
883
884
885
886
887
888
889
890
891
892
893
894
        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
895
896
897
898
899
900
        cmlparams.verbose_level = 0;

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

sletz's avatar
sletz committed
901
902
903
904
        for (node = params; node; node = jack_slist_next (node)) {
            param = (jack_driver_param_t *) node->data;

            switch (param->character) {
pieterpalmers's avatar
pieterpalmers committed
905
                case 'd':
sletz's avatar
sletz committed
906
                    device_name = const_cast<char*>(param->value.str);
pieterpalmers's avatar
pieterpalmers committed
907
                    break;
sletz's avatar
sletz committed
908
909
910
911
912
913
914
915
916
917
918
919
                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
920
921
                case 'i':
                    cmlparams.capture_ports = param->value.ui;
sletz's avatar
sletz committed
922
                    break;
pieterpalmers's avatar
pieterpalmers committed
923
924
                case 'o':
                    cmlparams.playback_ports = param->value.ui;
sletz's avatar
sletz committed
925
926
927
928
929
930
931
                    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
932
933
                case 'x':
                    cmlparams.slave_mode = param->value.ui;
sletz's avatar
sletz committed
934
                    break;
pieterpalmers's avatar
pieterpalmers committed
935
                case 'X':
sletz's avatar
sletz committed
936
                    cmlparams.snoop_mode = param->value.i;
sletz's avatar
sletz committed
937
938
939
940
941
942
943
944
                    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
945
946
            cmlparams.playback_ports = 1;
            cmlparams.capture_ports = 1;
sletz's avatar
sletz committed
947
948
        }

pieterpalmers's avatar
pieterpalmers committed
949
950
951
        // temporary
        cmlparams.device_info = device_name;

952
        Jack::JackFFADODriver* ffado_driver = new Jack::JackFFADODriver("system", "firewire_pcm", engine, table);
sletz's avatar
sletz committed
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
        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