JackFFADODriver.cpp 33.6 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 "JackFFADOMidiInputPort.h"
#include "JackFFADOMidiOutputPort.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"
46
#include "JackLockedEngine.h"
sletz's avatar
sletz committed
47
48
49
50

namespace Jack
{

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

#define jack_get_microseconds GetMicroSeconds

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

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

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

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

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

    printExit();
    return 0;
}

int
JackFFADODriver::ffado_driver_write (ffado_driver_t * driver, jack_nframes_t nframes)
{
111
    channel_t chn;
sletz's avatar
sletz committed
112
    jack_default_audio_sample_t* buf;
sletz's avatar
sletz committed
113
114
115
116
    printEnter();

    driver->process_count++;

sletz's avatar
sletz committed
117
    for (chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
118
119
        if (fGraphManager->GetConnectionsNum(fPlaybackPortList[chn]) == 0) {
            buf = (jack_default_audio_sample_t*)driver->nullbuffer;
sletz's avatar
sletz committed
120
121
122
123
124
125
            // 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
126
            if (driver->playback_channels[chn].stream_type == ffado_stream_type_audio) {
sletz's avatar
sletz committed
127
128
                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
129
                if (!buf) buf = (jack_default_audio_sample_t*)driver->nullbuffer;
sletz's avatar
sletz committed
130
                ffado_streaming_set_playback_stream_buffer(driver->dev, chn, (char *)(buf));
pieterpalmers's avatar
pieterpalmers committed
131
                ffado_streaming_playback_stream_onoff(driver->dev, chn, 1);
sletz's avatar
sletz committed
132
133
134
            } 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));
135
                buf = (jack_default_audio_sample_t *) fGraphManager->GetBuffer(fPlaybackPortList[chn], nframes);
sletz's avatar
sletz committed
136
                ffado_streaming_set_playback_stream_buffer(driver->dev, chn, (char *)(midi_buffer));
137
138
139
                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
140

sletz's avatar
sletz committed
141
142
143
            } 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
144
145
146
147
148
149
150
151
152
153
            }
        }
    }
    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
154
                                    float *delayed_usecs)
sletz's avatar
sletz committed
155
156
157
{
    jack_time_t wait_enter;
    jack_time_t wait_ret;
sletz's avatar
sletz committed
158
    ffado_wait_response response;
sletz's avatar
sletz committed
159
160
161
162
163
164

    printEnter();

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

sletz's avatar
sletz committed
176
    response = ffado_streaming_wait(driver->dev);
sletz's avatar
sletz committed
177
178
179
180
181
182
183
184

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

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

sletz's avatar
sletz committed
216
    fBeginDateUst = wait_ret;
sletz's avatar
sletz committed
217
218

    printExit();
sletz's avatar
sletz committed
219
    return driver->period_size;
sletz's avatar
sletz committed
220
221
222
223
224
225
226
227
228
}

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
229

sletz's avatar
sletz committed
230
231
232
233
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
260
261
        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!!!");

    /*
262
    driver->period_size = nframes;
sletz's avatar
sletz committed
263
    driver->period_usecs =
pieterpalmers's avatar
pieterpalmers committed
264
265
            (jack_time_t) floor ((((float) nframes) / driver->sample_rate)
                                 * 1000000.0f);
sletz's avatar
sletz committed
266
267
268
269
270
271
272
273
274
275
276
    */

    /* 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 *
277
JackFFADODriver::ffado_driver_new (const char *name,
sletz's avatar
sletz committed
278
                                   ffado_jack_settings_t *params)
sletz's avatar
sletz committed
279
280
281
282
283
{
    ffado_driver_t *driver;

    assert(params);

sletz's avatar
sletz committed
284
    if (ffado_get_api_version() != FIREWIRE_REQUIRED_FFADO_API_VERSION) {
sletz's avatar
sletz committed
285
286
287
288
289
290
291
292
293
294
295
        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
296
297
298
299
300
301
302
303
304
305
    /*        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
306
307
308
309
310
311
312

    /* 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
313
    fBeginDateUst = 0;
sletz's avatar
sletz committed
314
315
316
317

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

pieterpalmers's avatar
pieterpalmers committed
318
//         driver->client = client;
sletz's avatar
sletz committed
319
320
321
322
323
324
325
326
327
    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
328
    driver->device_options.snoop_mode = params->snoop_mode;
sletz's avatar
sletz committed
329
330
331
332
333
334
335
336
337
338
339
340
341
342

    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
343
    free (driver);
sletz's avatar
sletz committed
344
345
346
347
348
}

int JackFFADODriver::Attach()
{
    JackPort* port;
Stephane Letz's avatar
Stephane Letz committed
349
    jack_port_id_t port_index;
sletz's avatar
sletz committed
350
351
    char buf[JACK_PORT_NAME_SIZE];
    char portname[JACK_PORT_NAME_SIZE];
352
    jack_latency_range_t range;
sletz's avatar
sletz committed
353
354
355

    ffado_driver_t* driver = (ffado_driver_t*)fDriver;

sletz's avatar
sletz committed
356
    jack_log("JackFFADODriver::Attach fBufferSize %ld fSampleRate %ld", fEngineControl->fBufferSize, fEngineControl->fSampleRate);
sletz's avatar
sletz committed
357
358
359

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

sletz's avatar
sletz committed
360
361
362
363
364
    /* 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
365
    if (driver->nullbuffer == NULL) {
sletz's avatar
sletz committed
366
367
368
369
370
        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
371

sletz's avatar
sletz committed
372
373
    /* 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
374
    if (driver->scratchbuffer == NULL) {
sletz's avatar
sletz committed
375
376
377
378
        printError("could not allocate memory for scratch buffer");
        return -1;
    }

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

382
    driver->device_options.packetizer_priority = fEngineControl->fServerPriority +
sletz's avatar
sletz committed
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
            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
403
404
    ffado_streaming_set_audio_datatype(driver->dev, ffado_audio_datatype_float);

sletz's avatar
sletz committed
405
406
407
408
    /* ports */

    // capture
    driver->capture_nchannels = ffado_streaming_get_nb_capture_streams(driver->dev);
sletz's avatar
sletz committed
409
410
    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
411
412
413
        printError("could not allocate memory for capture channel list");
        return -1;
    }
sletz's avatar
sletz committed
414

sletz's avatar
sletz committed
415
    fCaptureChannels = 0;
416
    for (channel_t chn = 0; chn < driver->capture_nchannels; chn++) {
sletz's avatar
sletz committed
417
        ffado_streaming_get_capture_stream_name(driver->dev, chn, portname, sizeof(portname) - 1);
sletz's avatar
sletz committed
418

sletz's avatar
sletz committed
419
420
        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) {
421
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_in", portname);
sletz's avatar
sletz committed
422
            printMessage ("Registering audio capture port %s", buf);
423
            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
424
                              JACK_DEFAULT_AUDIO_TYPE,
425
                              CaptureDriverFlags,
426
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
427
428
429
430
431
432
433
434
435
436
437
                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);
438
439
            range.min = range.max = driver->period_size + driver->capture_frame_latency;
            port->SetLatencyRange(JackCaptureLatency, &range);
440
441
442
            // 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
443
            fCapturePortList[chn] = port_index;
sletz's avatar
sletz committed
444
            jack_log("JackFFADODriver::Attach fCapturePortList[i] %ld ", port_index);
sletz's avatar
sletz committed
445
            fCaptureChannels++;
sletz's avatar
sletz committed
446
        } else if (driver->capture_channels[chn].stream_type == ffado_stream_type_midi) {
447
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_in", portname);
sletz's avatar
sletz committed
448
            printMessage ("Registering midi capture port %s", buf);
449
            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
450
                              JACK_DEFAULT_MIDI_TYPE,
451
                              CaptureDriverFlags,
452
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
453
454
455
456
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

sletz's avatar
sletz committed
457
458
459
460
            // 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
461
            if (ffado_streaming_capture_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
462
463
                printError(" cannot enable port %s", buf);
            }
sletz's avatar
sletz committed
464

465
            driver->capture_channels[chn].midi_input = new JackFFADOMidiInputPort();
sletz's avatar
sletz committed
466
467
            // setup the midi buffer
            driver->capture_channels[chn].midi_buffer = (uint32_t *)calloc(driver->period_size, sizeof(uint32_t));
sletz's avatar
sletz committed
468
469

            port = fGraphManager->GetPort(port_index);
470
471
            range.min = range.max = driver->period_size + driver->capture_frame_latency;
            port->SetLatencyRange(JackCaptureLatency, &range);
sletz's avatar
sletz committed
472
            fCapturePortList[chn] = port_index;
sletz's avatar
sletz committed
473
            jack_log("JackFFADODriver::Attach fCapturePortList[i] %ld ", port_index);
sletz's avatar
sletz committed
474
475
476
            fCaptureChannels++;
        } else {
            printMessage ("Don't register capture port %s", portname);
sletz's avatar
sletz committed
477
478
479
480
481
        }
    }

    // playback
    driver->playback_nchannels = ffado_streaming_get_nb_playback_streams(driver->dev);
sletz's avatar
sletz committed
482
483
    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
484
485
486
        printError("could not allocate memory for playback channel list");
        return -1;
    }
sletz's avatar
sletz committed
487

sletz's avatar
sletz committed
488
    fPlaybackChannels = 0;
489
    for (channel_t chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
490
        ffado_streaming_get_playback_stream_name(driver->dev, chn, portname, sizeof(portname) - 1);
sletz's avatar
sletz committed
491

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

sletz's avatar
sletz committed
494
        if (driver->playback_channels[chn].stream_type == ffado_stream_type_audio) {
495
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_out", portname);
sletz's avatar
sletz committed
496
            printMessage ("Registering audio playback port %s", buf);
497
            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
498
                              JACK_DEFAULT_AUDIO_TYPE,
499
                              PlaybackDriverFlags,
500
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
501
502
503
504
                jack_error("driver: cannot register port for %s", buf);
                return -1;
            }

sletz's avatar
sletz committed
505
506
507
508
            // 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
509
            if (ffado_streaming_playback_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
510
511
                printError(" cannot enable port %s", buf);
            }
sletz's avatar
sletz committed
512
513

            port = fGraphManager->GetPort(port_index);
514
            // Add one buffer more latency if "async" mode is used...
Devin Anderson's avatar
Devin Anderson committed
515
            range.min = range.max = (driver->period_size * (driver->device_options.nb_buffers - 1)) + ((fEngineControl->fSyncMode) ? 0 : fEngineControl->fBufferSize) + driver->playback_frame_latency;
516
            port->SetLatencyRange(JackPlaybackLatency, &range);
517
518
519
            // 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
520
            fPlaybackPortList[chn] = port_index;
sletz's avatar
sletz committed
521
            jack_log("JackFFADODriver::Attach fPlaybackPortList[i] %ld ", port_index);
sletz's avatar
sletz committed
522
            fPlaybackChannels++;
sletz's avatar
sletz committed
523
        } else if (driver->playback_channels[chn].stream_type == ffado_stream_type_midi) {
524
            snprintf(buf, sizeof(buf) - 1, "firewire_pcm:%s_out", portname);
sletz's avatar
sletz committed
525
            printMessage ("Registering midi playback port %s", buf);
526
527

            if (fEngine->PortRegister(fClientControl.fRefNum, buf,
sletz's avatar
sletz committed
528
                              JACK_DEFAULT_MIDI_TYPE,
529
                              PlaybackDriverFlags,
530
                              fEngineControl->fBufferSize, &port_index) < 0) {
sletz's avatar
sletz committed
531
532
533
534
535
536
537
538
                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
539
            if (ffado_streaming_playback_stream_onoff(driver->dev, chn, 0)) {
sletz's avatar
sletz committed
540
541
542
                printError(" cannot enable port %s", buf);
            }
            // setup the midi buffer
543

544
545
546
            // 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.
547
            driver->playback_channels[chn].midi_output = new JackFFADOMidiOutputPort();
548

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

            port = fGraphManager->GetPort(port_index);
552
            range.min = range.max = (driver->period_size * (driver->device_options.nb_buffers - 1)) + ((fEngineControl->fSyncMode) ? 0 : fEngineControl->fBufferSize) + driver->playback_frame_latency;
553
            port->SetLatencyRange(JackPlaybackLatency, &range);
sletz's avatar
sletz committed
554
            fPlaybackPortList[chn] = port_index;
sletz's avatar
sletz committed
555
            jack_log("JackFFADODriver::Attach fPlaybackPortList[i] %ld ", port_index);
sletz's avatar
sletz committed
556
557
558
            fPlaybackChannels++;
        } else {
            printMessage ("Don't register playback port %s", portname);
sletz's avatar
sletz committed
559
560
561
        }
    }

sletz's avatar
sletz committed
562
563
    assert(fCaptureChannels < DRIVER_PORT_NUM);
    assert(fPlaybackChannels < DRIVER_PORT_NUM);
sletz's avatar
sletz committed
564

sletz's avatar
sletz committed
565
    if (ffado_streaming_prepare(driver->dev)) {
sletz's avatar
sletz committed
566
567
568
569
570
571
572
573
574
575
576
        printError("Could not prepare streaming device!");
        return -1;
    }

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

int JackFFADODriver::Detach()
{
577
    channel_t chn;
sletz's avatar
sletz committed
578
    ffado_driver_t* driver = (ffado_driver_t*)fDriver;
sletz's avatar
sletz committed
579
    jack_log("JackFFADODriver::Detach");
sletz's avatar
sletz committed
580
581
582
583
584

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

sletz's avatar
sletz committed
585
586
    // free all internal buffers
    for (chn = 0; chn < driver->capture_nchannels; chn++) {
sletz's avatar
sletz committed
587
        if (driver->capture_channels[chn].midi_buffer)
sletz's avatar
sletz committed
588
            free(driver->capture_channels[chn].midi_buffer);
589
        if (driver->capture_channels[chn].midi_input)
590
            delete ((JackFFADOMidiInputPort *) (driver->capture_channels[chn].midi_input));
sletz's avatar
sletz committed
591
    }
sletz's avatar
sletz committed
592
    free(driver->capture_channels);
sletz's avatar
sletz committed
593

sletz's avatar
sletz committed
594
    for (chn = 0; chn < driver->playback_nchannels; chn++) {
sletz's avatar
sletz committed
595
        if (driver->playback_channels[chn].midi_buffer)
sletz's avatar
sletz committed
596
            free(driver->playback_channels[chn].midi_buffer);
597
        if (driver->playback_channels[chn].midi_output)
598
            delete ((JackFFADOMidiOutputPort *) (driver->playback_channels[chn].midi_output));
sletz's avatar
sletz committed
599
600
601
602
603
    }
    free(driver->playback_channels);

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

sletz's avatar
sletz committed
605
    return JackAudioDriver::Detach();  // Generic JackAudioDriver Detach
sletz's avatar
sletz committed
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
}

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
623
624
        //fCaptureChannels = ((ffado_driver_t *)fDriver)->capture_nchannels_audio;
        //fPlaybackChannels = ((ffado_driver_t *)fDriver)->playback_nchannels_audio;
sletz's avatar
sletz committed
625
626
        return 0;
    } else {
627
        JackAudioDriver::Close();
sletz's avatar
sletz committed
628
629
630
631
632
633
        return -1;
    }
}

int JackFFADODriver::Close()
{
634
635
636
    // Generic audio driver close
    int res = JackAudioDriver::Close();

sletz's avatar
sletz committed
637
    ffado_driver_delete((ffado_driver_t*)fDriver);
638
    return res;
sletz's avatar
sletz committed
639
640
641
642
}

int JackFFADODriver::Start()
{
643
644
645
646
647
648
649
650
    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
651
652
653
654
}

int JackFFADODriver::Stop()
{
655
656
657
658
659
    int res = ffado_driver_stop((ffado_driver_t *)fDriver);
    if (JackAudioDriver::Stop() < 0) {
        res = -1;
    }
    return res;
sletz's avatar
sletz committed
660
661
662
663
664
665
666
667
668
}

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

671
672
retry:

sletz's avatar
sletz committed
673
    jack_nframes_t nframes = ffado_driver_wait(driver, -1, &wait_status,
sletz's avatar
sletz committed
674
                             &fDelayedUsecs);
sletz's avatar
sletz committed
675
676
677
678
679
680
681
682

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

    if (nframes == 0) {
        /* we detected an xrun and restarted: notify
683
         * clients about the delay.
sletz's avatar
sletz committed
684
         */
sletz's avatar
sletz committed
685
        jack_log("FFADO XRun");
sletz's avatar
sletz committed
686
        NotifyXRun(fBeginDateUst, fDelayedUsecs);
687
        goto retry; /* recoverable error*/
sletz's avatar
sletz committed
688
689
690
    }

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

693
    // Has to be done before read
694
    JackDriver::CycleIncTime();
sletz's avatar
sletz committed
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
746
747
748
749
750
751

    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

752
    SERVER_EXPORT const jack_driver_desc_t *
sletz's avatar
sletz committed
753
754
    driver_get_descriptor () {
        jack_driver_desc_t * desc;
755
756
757
        jack_driver_desc_filler_t filler;
        jack_driver_param_value_t value;

758
        desc = jack_driver_descriptor_construct("firewire", JackDriverMaster, "Linux FFADO API based audio backend", &filler);
759
760
761
762
763
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

        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
801

sletz's avatar
sletz committed
802
803
804
        return desc;
    }

805
    SERVER_EXPORT Jack::JackDriverClientInterface* driver_initialize(Jack::JackLockedEngine* engine, Jack::JackSynchro* table, const JSList* params) {
sletz's avatar
sletz committed
806
807
808
809
810
        const JSList * node;
        const jack_driver_param_t * param;

        ffado_jack_settings_t cmlparams;

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

sletz's avatar
sletz committed
813
814
815
816
817
818
819
820
821
822
823
824
825
        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
826
827
828
829
830
831
        cmlparams.verbose_level = 0;

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

sletz's avatar
sletz committed
832
833
834
835
        for (node = params; node; node = jack_slist_next (node)) {
            param = (jack_driver_param_t *) node->data;

            switch (param->character) {
pieterpalmers's avatar
pieterpalmers committed
836
                case 'd':
sletz's avatar
sletz committed
837
                    device_name = const_cast<char*>(param->value.str);
pieterpalmers's avatar
pieterpalmers committed
838
                    break;
sletz's avatar
sletz committed
839
840
841
842
843
844
845
846
847
848
849
850
                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
851
852
                case 'i':
                    cmlparams.capture_ports = param->value.ui;
sletz's avatar
sletz committed
853
                    break;
pieterpalmers's avatar
pieterpalmers committed
854
855
                case 'o':
                    cmlparams.playback_ports = param->value.ui;
sletz's avatar
sletz committed
856
857
858
859
860
861
862
                    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
863
864
                case 'x':
                    cmlparams.slave_mode = param->value.ui;
sletz's avatar
sletz committed
865
                    break;
pieterpalmers's avatar
pieterpalmers committed
866
                case 'X':
sletz's avatar
sletz committed
867
                    cmlparams.snoop_mode = param->value.i;
sletz's avatar
sletz committed
868
869
870
871
872
873
874
875
                    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
876
877
            cmlparams.playback_ports = 1;
            cmlparams.capture_ports = 1;
sletz's avatar
sletz committed
878
879
        }

pieterpalmers's avatar
pieterpalmers committed
880
881
882
        // temporary
        cmlparams.device_info = device_name;

883
        Jack::JackFFADODriver* ffado_driver = new Jack::JackFFADODriver("system", "firewire_pcm", engine, table);
sletz's avatar
sletz committed
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
        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