common/JackAudioDriver.cpp

   1 /*
   2 Copyright (C) 2001 Paul Davis
   3 Copyright (C) 2004-2008 Grame.
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 This program is distributed in the hope that it will be useful,
   9 but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 (at your option) any later version.
  12
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include "JackSystemDeps.h"
  22 #include "JackAudioDriver.h"
  23 #include "JackTime.h"
  24 #include "JackError.h"
  25 #include "JackEngineControl.h"
  26 #include "JackPort.h"
  27 #include "JackGraphManager.h"
  28 #include "JackLockedEngine.h"
  29 #include "JackException.h"
  30 #include <assert.h>
  31
  32 namespace Jack
  33 {
  34
  35 JackAudioDriver::JackAudioDriver(const char* name, const char* alias, JackLockedEngine* engine, JackSynchro* table)
  36         : JackDriver(name, alias, engine, table),
  37         fCaptureChannels(0),
  38         fPlaybackChannels(0),
  39         fWithMonitorPorts(false)
  40 {}
  41
  42 JackAudioDriver::~JackAudioDriver()
  43 {}
  44
  45 int JackAudioDriver::SetBufferSize(jack_nframes_t buffer_size)
  46 {
  47     fEngineControl->fBufferSize = buffer_size;
  48     fGraphManager->SetBufferSize(buffer_size);
  49     fEngineControl->fPeriodUsecs = jack_time_t(1000000.f / fEngineControl->fSampleRate * fEngineControl->fBufferSize);  // in microsec
  50     if (!fEngineControl->fTimeOut)
  51         fEngineControl->fTimeOutUsecs = jack_time_t(2.f * fEngineControl->fPeriodUsecs);
  52     return 0;
  53 }
  54
  55 int JackAudioDriver::SetSampleRate(jack_nframes_t sample_rate)
  56 {
  57     fEngineControl->fSampleRate = sample_rate;
  58     fEngineControl->fPeriodUsecs = jack_time_t(1000000.f / fEngineControl->fSampleRate * fEngineControl->fBufferSize);  // in microsec
  59     if (!fEngineControl->fTimeOut)
  60         fEngineControl->fTimeOutUsecs = jack_time_t(2.f * fEngineControl->fPeriodUsecs);
  61     return 0;
  62 }
  63
  64 int JackAudioDriver::Open(jack_nframes_t buffer_size,
  65                           jack_nframes_t samplerate,
  66                           bool capturing,
  67                           bool playing,
  68                           int inchannels,
  69                           int outchannels,
  70                           bool monitor,
  71                           const char* capture_driver_name,
  72                           const char* playback_driver_name,
  73                           jack_nframes_t capture_latency,
  74                           jack_nframes_t playback_latency)
  75 {
  76     fCaptureChannels = inchannels;
  77     fPlaybackChannels = outchannels;
  78     fWithMonitorPorts = monitor;
  79     return JackDriver::Open(buffer_size, samplerate, capturing, playing, inchannels, outchannels, monitor, capture_driver_name, playback_driver_name, capture_latency, playback_latency);
  80 }
  81
  82 int JackAudioDriver::Open(bool capturing,
  83                           bool playing,
  84                           int inchannels,
  85                           int outchannels,
  86                           bool monitor,
  87                           const char* capture_driver_name,
  88                           const char* playback_driver_name,
  89                           jack_nframes_t capture_latency,
  90                           jack_nframes_t playback_latency)
  91 {
  92     fCaptureChannels = inchannels;
  93     fPlaybackChannels = outchannels;
  94     fWithMonitorPorts = monitor;
  95     return JackDriver::Open(capturing, playing, inchannels, outchannels, monitor, capture_driver_name, playback_driver_name, capture_latency, playback_latency);
  96 }
  97
  98 int JackAudioDriver::Attach()
  99 {
 100     JackPort* port;
 101     jack_port_id_t port_index;
 102     char name[JACK_CLIENT_NAME_SIZE + JACK_PORT_NAME_SIZE];
 103     char alias[JACK_CLIENT_NAME_SIZE + JACK_PORT_NAME_SIZE];
 104     unsigned long port_flags = JackPortIsOutput | JackPortIsPhysical | JackPortIsTerminal;
 105     int i;
 106
 107     jack_log("JackAudioDriver::Attach fBufferSize = %ld fSampleRate = %ld", fEngineControl->fBufferSize, fEngineControl->fSampleRate);
 108
 109     for (i = 0; i < fCaptureChannels; i++) {
 110         snprintf(alias, sizeof(alias) - 1, "%s:%s:out%d", fAliasName, fCaptureDriverName, i + 1);
 111         snprintf(name, sizeof(name) - 1, "%s:capture_%d", fClientControl.fName, i + 1);
 112         if ((port_index = fGraphManager->AllocatePort(fClientControl.fRefNum, name, JACK_DEFAULT_AUDIO_TYPE, (JackPortFlags)port_flags, fEngineControl->fBufferSize)) == NO_PORT) {
 113             jack_error("driver: cannot register port for %s", name);
 114             return -1;
 115         }
 116         port = fGraphManager->GetPort(port_index);
 117         port->SetAlias(alias);
 118         port->SetLatency(fEngineControl->fBufferSize + fCaptureLatency);
 119         fCapturePortList[i] = port_index;
 120         jack_log("JackAudioDriver::Attach fCapturePortList[i] port_index = %ld", port_index);
 121     }
 122
 123     port_flags = JackPortIsInput | JackPortIsPhysical | JackPortIsTerminal;
 124
 125     for (i = 0; i < fPlaybackChannels; i++) {
 126         snprintf(alias, sizeof(alias) - 1, "%s:%s:in%d", fAliasName, fPlaybackDriverName, i + 1);
 127         snprintf(name, sizeof(name) - 1, "%s:playback_%d", fClientControl.fName, i + 1);
 128         if ((port_index = fGraphManager->AllocatePort(fClientControl.fRefNum, name, JACK_DEFAULT_AUDIO_TYPE, (JackPortFlags)port_flags, fEngineControl->fBufferSize)) == NO_PORT) {
 129             jack_error("driver: cannot register port for %s", name);
 130             return -1;
 131         }
 132         port = fGraphManager->GetPort(port_index);
 133         port->SetAlias(alias);
 134         // Add more latency if "async" mode is used...
 135         port->SetLatency(fEngineControl->fBufferSize + ((fEngineControl->fSyncMode) ? 0 : fEngineControl->fBufferSize) + fPlaybackLatency);
 136         fPlaybackPortList[i] = port_index;
 137         jack_log("JackAudioDriver::Attach fPlaybackPortList[i] port_index = %ld", port_index);
 138
 139         // Monitor ports
 140         if (fWithMonitorPorts) {
 141             jack_log("Create monitor port ");
 142             snprintf(name, sizeof(name) - 1, "%s:monitor_%u", fClientControl.fName, i + 1);
 143             if ((port_index = fGraphManager->AllocatePort(fClientControl.fRefNum, name, JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, fEngineControl->fBufferSize)) == NO_PORT) {
 144                 jack_error("Cannot register monitor port for %s", name);
 145                 return -1;
 146             } else {
 147                 port = fGraphManager->GetPort(port_index);
 148                 port->SetAlias(alias);
 149                 port->SetLatency(fEngineControl->fBufferSize);
 150                 fMonitorPortList[i] = port_index;
 151             }
 152         }
 153     }
 154
 155     return 0;
 156 }
 157
 158 int JackAudioDriver::Detach()
 159 {
 160     int i;
 161     jack_log("JackAudioDriver::Detach");
 162
 163     for (i = 0; i < fCaptureChannels; i++) {
 164         fGraphManager->ReleasePort(fClientControl.fRefNum, fCapturePortList[i]);
 165     }
 166
 167     for (i = 0; i < fPlaybackChannels; i++) {
 168         fGraphManager->ReleasePort(fClientControl.fRefNum, fPlaybackPortList[i]);
 169         if (fWithMonitorPorts)
 170             fGraphManager->ReleasePort(fClientControl.fRefNum, fMonitorPortList[i]);
 171     }
 172
 173     return 0;
 174 }
 175
 176 int JackAudioDriver::Write()
 177 {
 178     for (int i = 0; i < fPlaybackChannels; i++) {
 179         if (fGraphManager->GetConnectionsNum(fPlaybackPortList[i]) > 0) {
 180             float* buffer = GetOutputBuffer(i);
 181             int size = sizeof(float) * fEngineControl->fBufferSize;
 182             // Monitor ports
 183             if (fWithMonitorPorts && fGraphManager->GetConnectionsNum(fMonitorPortList[i]) > 0)
 184                 memcpy(GetMonitorBuffer(i), buffer, size);
 185         }
 186     }
 187     return 0;
 188 }
 189
 190 int JackAudioDriver::ProcessNull()
 191 {
 192     // Keep begin cycle time
 193     JackDriver::CycleTakeBeginTime();
 194
 195     if (fEngineControl->fSyncMode) {
 196         ProcessGraphSync();
 197     } else {
 198         ProcessGraphAsync();
 199     }
 200
 201      // Keep end cycle time
 202     JackDriver::CycleTakeEndTime();
 203     WaitUntilNextCycle();
 204     return 0;
 205 }
 206
 207 int JackAudioDriver::Process()
 208 {
 209     return (fEngineControl->fSyncMode) ? ProcessSync() : ProcessAsync();
 210 }
 211
 212 /*
 213 The driver ASYNC mode: output buffers computed at the *previous cycle* are used, the server does not
 214 synchronize to the end of client graph execution.
 215 */
 216
 217 int JackAudioDriver::ProcessAsync()
 218 {
 219     // Read input buffers for the current cycle
 220     if (Read() < 0) {
 221         jack_error("JackAudioDriver::ProcessAsync: read error, skip cycle");
 222         return 0;   // Skip cycle, but continue processing...
 223     }
 224
 225     // Write output buffers from the previous cycle
 226     if (Write() < 0) {
 227         jack_error("JackAudioDriver::ProcessAsync: write error, skip cycle");
 228         return 0;   // Skip cycle, but continue processing...
 229     }
 230
 231     if (fIsMaster) {
 232         ProcessGraphAsync();
 233     } else {
 234         fGraphManager->ResumeRefNum(&fClientControl, fSynchroTable);
 235     }
 236
 237     // Keep end cycle time
 238     JackDriver::CycleTakeEndTime();
 239     return 0;
 240 }
 241
 242 /*
 243 The driver SYNC mode: the server does synchronize to the end of client graph execution,
 244 output buffers computed at the *current cycle* are used.
 245 */
 246
 247 int JackAudioDriver::ProcessSync()
 248 {
 249     // Read input buffers for the current cycle
 250     if (Read() < 0) {
 251         jack_error("JackAudioDriver::ProcessSync: read error, skip cycle");
 252         return 0;   // Skip cycle, but continue processing...
 253     }
 254
 255     if (fIsMaster) {
 256         ProcessGraphSync();
 257     } else {
 258         fGraphManager->ResumeRefNum(&fClientControl, fSynchroTable);
 259     }
 260
 261     // Write output buffers for the current cycle
 262     if (Write() < 0) {
 263         jack_error("JackAudioDriver::ProcessSync: write error, skip cycle");
 264         return 0;   // Skip cycle, but continue processing...
 265     }
 266
 267     // Keep end cycle time
 268     JackDriver::CycleTakeEndTime();
 269     return 0;
 270 }
 271
 272 void JackAudioDriver::ProcessGraphAsync()
 273 {
 274     // fBeginDateUst is set in the "low level" layer, fEndDateUst is from previous cycle
 275     if (!fEngine->Process(fBeginDateUst, fEndDateUst))
 276         jack_error("JackAudioDriver::ProcessAsync Process error");
 277     fGraphManager->ResumeRefNum(&fClientControl, fSynchroTable);
 278     if (ProcessSlaves() < 0)
 279         jack_error("JackAudioDriver::ProcessAsync ProcessSlaves error");
 280 }
 281
 282 void JackAudioDriver::ProcessGraphSync()
 283 {
 284     // fBeginDateUst is set in the "low level" layer, fEndDateUst is from previous cycle
 285     if (fEngine->Process(fBeginDateUst, fEndDateUst)) {
 286         fGraphManager->ResumeRefNum(&fClientControl, fSynchroTable);
 287         if (ProcessSlaves() < 0)
 288             jack_error("JackAudioDriver::ProcessSync ProcessSlaves error, engine may now behave abnormally!!");
 289         if (fGraphManager->SuspendRefNum(&fClientControl, fSynchroTable, DRIVER_TIMEOUT_FACTOR * fEngineControl->fTimeOutUsecs) < 0)
 290             jack_error("JackAudioDriver::ProcessSync SuspendRefNum error, engine may now behave abnormally!!");
 291     } else { // Graph not finished: do not activate it
 292         jack_error("JackAudioDriver::ProcessSync: error");
 293     }
 294 }
 295
 296 void JackAudioDriver::WaitUntilNextCycle()
 297 {
 298     int wait_time_usec = (int((float(fEngineControl->fBufferSize) / (float(fEngineControl->fSampleRate))) * 1000000.0f));
 299     wait_time_usec = int(wait_time_usec - (GetMicroSeconds() - fBeginDateUst));
 300         if (wait_time_usec > 0)
 301                 JackSleep(wait_time_usec);
 302 }
 303
 304 jack_default_audio_sample_t* JackAudioDriver::GetInputBuffer(int port_index)
 305 {
 306     assert(fCapturePortList[port_index]);
 307     return (jack_default_audio_sample_t*)fGraphManager->GetBuffer(fCapturePortList[port_index], fEngineControl->fBufferSize);
 308 }
 309
 310 jack_default_audio_sample_t* JackAudioDriver::GetOutputBuffer(int port_index)
 311 {
 312     assert(fPlaybackPortList[port_index]);
 313     return (jack_default_audio_sample_t*)fGraphManager->GetBuffer(fPlaybackPortList[port_index], fEngineControl->fBufferSize);
 314 }
 315
 316 jack_default_audio_sample_t* JackAudioDriver::GetMonitorBuffer(int port_index)
 317 {
 318     assert(fPlaybackPortList[port_index]);
 319     return (jack_default_audio_sample_t*)fGraphManager->GetBuffer(fMonitorPortList[port_index], fEngineControl->fBufferSize);
 320 }
 321
 322 } // end of namespace