common/JackNetDriver.cpp

   1 /*
   2 Copyright (C) 2001 Paul Davis
   3 Copyright (C) 2008 Romain Moret at 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 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  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 #include "JackNetDriver.h"
  21 #include "JackEngineControl.h"
  22 #include "JackGraphManager.h"
  23 #include "JackWaitThreadedDriver.h"
  24
  25
  26 using namespace std;
  27
  28 namespace Jack
  29 {
  30     JackNetDriver::JackNetDriver ( const char* name, const char* alias, JackLockedEngine* engine, JackSynchro* table,
  31                                    const char* ip, int port, int mtu, int midi_input_ports, int midi_output_ports,
  32                                    char* net_name, uint transport_sync, char network_mode )
  33             : JackAudioDriver ( name, alias, engine, table ), JackNetSlaveInterface ( ip, port )
  34     {
  35         jack_log ( "JackNetDriver::JackNetDriver ip %s, port %d", ip, port );
  36
  37         // Use the hostname if no name parameter was given
  38         if ( strcmp ( net_name, "" ) == 0 )
  39             GetHostName ( net_name, JACK_CLIENT_NAME_SIZE );
  40
  41         fParams.fMtu = mtu;
  42         fParams.fSendMidiChannels = midi_input_ports;
  43         fParams.fReturnMidiChannels = midi_output_ports;
  44         strcpy ( fParams.fName, net_name );
  45         fSocket.GetName ( fParams.fSlaveNetName );
  46         fParams.fTransportSync = transport_sync;
  47         fParams.fNetworkMode = network_mode;
  48         fSendTransportData.fState = -1;
  49         fReturnTransportData.fState = -1;
  50         fLastTransportState = -1;
  51         fLastTimebaseMaster = -1;
  52         fMidiCapturePortList = NULL;
  53         fMidiPlaybackPortList = NULL;
  54 #ifdef JACK_MONITOR
  55         fNetTimeMon = NULL;
  56         fRcvSyncUst = 0;
  57 #endif
  58     }
  59
  60     JackNetDriver::~JackNetDriver()
  61     {
  62         delete[] fMidiCapturePortList;
  63         delete[] fMidiPlaybackPortList;
  64 #ifdef JACK_MONITOR
  65         delete fNetTimeMon;
  66 #endif
  67     }
  68
  69 //open, close, attach and detach------------------------------------------------------
  70     int JackNetDriver::Open ( jack_nframes_t buffer_size, jack_nframes_t samplerate, bool capturing, bool playing,
  71                               int inchannels, int outchannels, bool monitor,
  72                               const char* capture_driver_name, const char* playback_driver_name,
  73                               jack_nframes_t capture_latency, jack_nframes_t playback_latency )
  74     {
  75         if ( JackAudioDriver::Open ( buffer_size,
  76                                      samplerate,
  77                                      capturing,
  78                                      playing,
  79                                      inchannels,
  80                                      outchannels,
  81                                      monitor,
  82                                      capture_driver_name,
  83                                      playback_driver_name,
  84                                      capture_latency,
  85                                      playback_latency ) == 0 )
  86         {
  87             fEngineControl->fPeriod = 0;
  88             fEngineControl->fComputation = 500 * 1000;
  89             fEngineControl->fConstraint = 500 * 1000;
  90             return 0;
  91         }
  92         else
  93         {
  94             return -1;
  95         }
  96     }
  97
  98     int JackNetDriver::Close()
  99     {
 100 #ifdef JACK_MONITOR
 101         if ( fNetTimeMon )
 102             fNetTimeMon->Save();
 103 #endif
 104         FreeAll();
 105         return JackDriver::Close();
 106     }
 107
 108     // Attach and Detach are defined as empty methods: port allocation is done when driver actually start (that is in Init)
 109     int JackNetDriver::Attach()
 110     {
 111         return 0;
 112     }
 113
 114     int JackNetDriver::Detach()
 115     {
 116         return 0;
 117     }
 118
 119 //init and restart--------------------------------------------------------------------
 120     /*
 121         JackNetDriver is wrapped in a JackWaitThreadedDriver decorator that behaves
 122         as a "dummy driver, until Init method returns.
 123     */
 124
 125     bool JackNetDriver::Initialize()
 126     {
 127         jack_log("JackNetDriver::Initialize()");
 128
 129         //new loading, but existing socket, restart the driver
 130         if (fSocket.IsSocket()) {
 131             jack_info("Restarting driver...");
 132             FreeAll();
 133         }
 134
 135         //set the parameters to send
 136         fParams.fSendAudioChannels = fCaptureChannels;
 137         fParams.fReturnAudioChannels = fPlaybackChannels;
 138         fParams.fSlaveSyncMode = fEngineControl->fSyncMode;
 139
 140         //display some additional infos
 141         jack_info ( "NetDriver started in %s mode %s Master's transport sync.",
 142                     ( fParams.fSlaveSyncMode ) ? "sync" : "async", ( fParams.fTransportSync ) ? "with" : "without" );
 143
 144         //init network
 145         if ( !JackNetSlaveInterface::Init() )
 146             return false;
 147
 148         //set global parameters
 149         SetParams();
 150
 151         //allocate midi ports lists
 152         fMidiCapturePortList = new jack_port_id_t [fParams.fSendMidiChannels];
 153         fMidiPlaybackPortList = new jack_port_id_t [fParams.fReturnMidiChannels];
 154         assert ( fMidiCapturePortList );
 155         assert ( fMidiPlaybackPortList );
 156
 157         //register jack ports
 158         if ( AllocPorts() != 0 )
 159         {
 160             jack_error ( "Can't allocate ports." );
 161             return false;
 162         }
 163
 164         //init done, display parameters
 165         SessionParamsDisplay ( &fParams );
 166
 167         //monitor
 168 #ifdef JACK_MONITOR
 169         string plot_name;
 170         //NetTimeMon
 171         plot_name = string ( fParams.fName );
 172         plot_name += string ( "_slave" );
 173         plot_name += ( fEngineControl->fSyncMode ) ? string ( "_sync" ) : string ( "_async" );
 174         switch ( fParams.fNetworkMode )
 175         {
 176             case 's' :
 177                 plot_name += string ( "_slow" );
 178                 break;
 179
 180             case 'n' :
 181                 plot_name += string ( "_normal" );
 182                 break;
 183
 184             case 'f' :
 185                 plot_name += string ( "_fast" );
 186                 break;
 187         }
 188         fNetTimeMon = new JackGnuPlotMonitor<float> ( 128, 5, plot_name );
 189         string net_time_mon_fields[] =
 190         {
 191             string ( "sync decoded" ),
 192             string ( "end of read" ),
 193             string ( "start of write" ),
 194             string ( "sync send" ),
 195             string ( "end of write" )
 196         };
 197         string net_time_mon_options[] =
 198         {
 199             string ( "set xlabel \"audio cycles\"" ),
 200             string ( "set ylabel \"% of audio cycle\"" )
 201         };
 202         fNetTimeMon->SetPlotFile ( net_time_mon_options, 2, net_time_mon_fields, 5 );
 203 #endif
 204         //driver parametering
 205         JackAudioDriver::SetBufferSize ( fParams.fPeriodSize );
 206         JackAudioDriver::SetSampleRate ( fParams.fSampleRate );
 207
 208         JackDriver::NotifyBufferSize ( fParams.fPeriodSize );
 209         JackDriver::NotifySampleRate ( fParams.fSampleRate );
 210
 211         //transport engine parametering
 212         fEngineControl->fTransport.SetNetworkSync ( fParams.fTransportSync );
 213         return true;
 214     }
 215
 216     void JackNetDriver::FreeAll()
 217     {
 218         FreePorts();
 219
 220         delete[] fTxBuffer;
 221         delete[] fRxBuffer;
 222         delete fNetAudioCaptureBuffer;
 223         delete fNetAudioPlaybackBuffer;
 224         delete fNetMidiCaptureBuffer;
 225         delete fNetMidiPlaybackBuffer;
 226         delete[] fMidiCapturePortList;
 227         delete[] fMidiPlaybackPortList;
 228
 229         fTxBuffer = NULL;
 230         fRxBuffer = NULL;
 231         fNetAudioCaptureBuffer = NULL;
 232         fNetAudioPlaybackBuffer = NULL;
 233         fNetMidiCaptureBuffer = NULL;
 234         fNetMidiPlaybackBuffer = NULL;
 235         fMidiCapturePortList = NULL;
 236         fMidiPlaybackPortList = NULL;
 237
 238 #ifdef JACK_MONITOR
 239         delete fNetTimeMon;
 240         fNetTimeMon = NULL;
 241 #endif
 242     }
 243
 244 //jack ports and buffers--------------------------------------------------------------
 245     int JackNetDriver::AllocPorts()
 246     {
 247         jack_log ( "JackNetDriver::AllocPorts fBufferSize = %ld fSampleRate = %ld", fEngineControl->fBufferSize, fEngineControl->fSampleRate );
 248
 249         JackPort* port;
 250         jack_port_id_t port_id;
 251         char name[JACK_CLIENT_NAME_SIZE + JACK_PORT_NAME_SIZE];
 252         char alias[JACK_CLIENT_NAME_SIZE + JACK_PORT_NAME_SIZE];
 253         unsigned long port_flags;
 254         int audio_port_index;
 255         uint midi_port_index;
 256
 257         //audio
 258         port_flags = JackPortIsOutput | JackPortIsPhysical | JackPortIsTerminal;
 259         for ( audio_port_index = 0; audio_port_index < fCaptureChannels; audio_port_index++ )
 260         {
 261             snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:out%d", fAliasName, fCaptureDriverName, audio_port_index + 1 );
 262             snprintf ( name, sizeof ( name ) - 1, "%s:capture_%d", fClientControl.fName, audio_port_index + 1 );
 263             if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_AUDIO_TYPE,
 264                              static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
 265             {
 266                 jack_error ( "driver: cannot register port for %s", name );
 267                 return -1;
 268             }
 269             port = fGraphManager->GetPort ( port_id );
 270             port->SetAlias ( alias );
 271             //port latency
 272             port->SetLatency ( fEngineControl->fBufferSize );
 273             fCapturePortList[audio_port_index] = port_id;
 274             jack_log ( "JackNetDriver::AllocPorts() fCapturePortList[%d] audio_port_index = %ld fPortLatency = %ld", audio_port_index, port_id, port->GetLatency() );
 275         }
 276         port_flags = JackPortIsInput | JackPortIsPhysical | JackPortIsTerminal;
 277         for ( audio_port_index = 0; audio_port_index < fPlaybackChannels; audio_port_index++ )
 278         {
 279             snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:in%d", fAliasName, fPlaybackDriverName, audio_port_index + 1 );
 280             snprintf ( name, sizeof ( name ) - 1, "%s:playback_%d",fClientControl.fName, audio_port_index + 1 );
 281             if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_AUDIO_TYPE,
 282                              static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
 283             {
 284                 jack_error ( "driver: cannot register port for %s", name );
 285                 return -1;
 286             }
 287             port = fGraphManager->GetPort ( port_id );
 288             port->SetAlias ( alias );
 289             //port latency
 290             switch ( fParams.fNetworkMode )
 291             {
 292                 case 'f' :
 293                     port->SetLatency ( ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize );
 294                     break;
 295                 case 'n' :
 296                     port->SetLatency ( fEngineControl->fBufferSize + ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize );
 297                     break;
 298                 case 's' :
 299                     port->SetLatency ( 2 * fEngineControl->fBufferSize + ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize );
 300                     break;
 301             }
 302             fPlaybackPortList[audio_port_index] = port_id;
 303             jack_log ( "JackNetDriver::AllocPorts() fPlaybackPortList[%d] audio_port_index = %ld fPortLatency = %ld", audio_port_index, port_id, port->GetLatency() );
 304         }
 305         //midi
 306         port_flags = JackPortIsOutput | JackPortIsPhysical | JackPortIsTerminal;
 307         for ( midi_port_index = 0; midi_port_index < fParams.fSendMidiChannels; midi_port_index++ )
 308         {
 309             snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:out%d", fAliasName, fCaptureDriverName, midi_port_index + 1 );
 310             snprintf ( name, sizeof ( name ) - 1, "%s:midi_capture_%d", fClientControl.fName, midi_port_index + 1 );
 311             if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_MIDI_TYPE,
 312                              static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
 313             {
 314                 jack_error ( "driver: cannot register port for %s", name );
 315                 return -1;
 316             }
 317             port = fGraphManager->GetPort ( port_id );
 318             //port latency
 319             port->SetLatency ( fEngineControl->fBufferSize );
 320             fMidiCapturePortList[midi_port_index] = port_id;
 321             jack_log ( "JackNetDriver::AllocPorts() fMidiCapturePortList[%d] midi_port_index = %ld fPortLatency = %ld", midi_port_index, port_id, port->GetLatency() );
 322         }
 323
 324         port_flags = JackPortIsInput | JackPortIsPhysical | JackPortIsTerminal;
 325         for ( midi_port_index = 0; midi_port_index < fParams.fReturnMidiChannels; midi_port_index++ )
 326         {
 327             snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:in%d", fAliasName, fPlaybackDriverName, midi_port_index + 1 );
 328             snprintf ( name, sizeof ( name ) - 1, "%s:midi_playback_%d", fClientControl.fName, midi_port_index + 1 );
 329             if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_MIDI_TYPE,
 330                              static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
 331             {
 332                 jack_error ( "driver: cannot register port for %s", name );
 333                 return -1;
 334             }
 335             port = fGraphManager->GetPort ( port_id );
 336             //port latency
 337             switch ( fParams.fNetworkMode )
 338             {
 339                 case 'f' :
 340                     port->SetLatency ( ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize );
 341                     break;
 342                 case 'n' :
 343                     port->SetLatency ( fEngineControl->fBufferSize + ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize ) ;
 344                     break;
 345                 case 's' :
 346                     port->SetLatency ( 2 * fEngineControl->fBufferSize + ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize );
 347                     break;
 348             }
 349             fMidiPlaybackPortList[midi_port_index] = port_id;
 350             jack_log ( "JackNetDriver::AllocPorts() fMidiPlaybackPortList[%d] midi_port_index = %ld fPortLatency = %ld", midi_port_index, port_id, port->GetLatency() );
 351         }
 352
 353         return 0;
 354     }
 355
 356     int JackNetDriver::FreePorts()
 357     {
 358         jack_log ( "JackNetDriver::FreePorts" );
 359
 360         int audio_port_index;
 361         uint midi_port_index;
 362         for ( audio_port_index = 0; audio_port_index < fCaptureChannels; audio_port_index++ )
 363             if (fCapturePortList[audio_port_index] > 0)
 364                 fGraphManager->ReleasePort ( fClientControl.fRefNum, fCapturePortList[audio_port_index] );
 365         for ( audio_port_index = 0; audio_port_index < fPlaybackChannels; audio_port_index++ )
 366             if (fPlaybackPortList[audio_port_index] > 0)
 367                 fGraphManager->ReleasePort ( fClientControl.fRefNum, fPlaybackPortList[audio_port_index] );
 368         for ( midi_port_index = 0; midi_port_index < fParams.fSendMidiChannels; midi_port_index++ )
 369             if (fMidiCapturePortList[midi_port_index] > 0)
 370                 fGraphManager->ReleasePort ( fClientControl.fRefNum, fMidiCapturePortList[midi_port_index] );
 371         for ( midi_port_index = 0; midi_port_index < fParams.fReturnMidiChannels; midi_port_index++ )
 372             if (fMidiPlaybackPortList[midi_port_index] > 0)
 373                 fGraphManager->ReleasePort ( fClientControl.fRefNum, fMidiPlaybackPortList[midi_port_index] );
 374         return 0;
 375     }
 376
 377     JackMidiBuffer* JackNetDriver::GetMidiInputBuffer ( int port_index )
 378     {
 379         return static_cast<JackMidiBuffer*> ( fGraphManager->GetBuffer ( fMidiCapturePortList[port_index], fEngineControl->fBufferSize ) );
 380     }
 381
 382     JackMidiBuffer* JackNetDriver::GetMidiOutputBuffer ( int port_index )
 383     {
 384         return static_cast<JackMidiBuffer*> ( fGraphManager->GetBuffer ( fMidiPlaybackPortList[port_index], fEngineControl->fBufferSize ) );
 385     }
 386
 387 //transport---------------------------------------------------------------------------
 388     void JackNetDriver::DecodeTransportData()
 389     {
 390         //is there a new timebase master on the net master ?
 391         // - release timebase master only if it's a non-conditional request
 392         // - no change or no request : don't do anything
 393         // - conditional request : don't change anything too, the master will know if this slave is actually the timebase master
 394         int refnum;
 395         bool conditional;
 396         if ( fSendTransportData.fTimebaseMaster == TIMEBASEMASTER )
 397         {
 398             fEngineControl->fTransport.GetTimebaseMaster ( refnum, conditional );
 399             if ( refnum != -1 )
 400                 fEngineControl->fTransport.ResetTimebase ( refnum );
 401             jack_info ( "The NetMaster is now the new timebase master." );
 402         }
 403
 404         //is there a transport state change to handle ?
 405         if ( fSendTransportData.fNewState && ( fSendTransportData.fState != fEngineControl->fTransport.GetState() ) )
 406         {
 407
 408             switch ( fSendTransportData.fState )
 409             {
 410                 case JackTransportStopped :
 411                     fEngineControl->fTransport.SetCommand ( TransportCommandStop );
 412                     jack_info ( "Master stops transport." );
 413                     break;
 414
 415                 case JackTransportStarting :
 416                     fEngineControl->fTransport.RequestNewPos ( &fSendTransportData.fPosition );
 417                     fEngineControl->fTransport.SetCommand ( TransportCommandStart );
 418                     jack_info ( "Master starts transport frame = %d", fSendTransportData.fPosition.frame);
 419                     break;
 420
 421                 case JackTransportRolling :
 422                     //fEngineControl->fTransport.SetCommand ( TransportCommandStart );
 423                     fEngineControl->fTransport.SetState ( JackTransportRolling );
 424                     jack_info ( "Master is rolling." );
 425                     break;
 426             }
 427         }
 428     }
 429
 430     void JackNetDriver::EncodeTransportData()
 431     {
 432         /* Desactivated
 433         //is there a timebase master change ?
 434         int refnum;
 435         bool conditional;
 436         fEngineControl->fTransport.GetTimebaseMaster ( refnum, conditional );
 437         if ( refnum != fLastTimebaseMaster )
 438         {
 439             //timebase master has released its function
 440             if ( refnum == -1 )
 441             {
 442                 fReturnTransportData.fTimebaseMaster = RELEASE_TIMEBASEMASTER;
 443                 jack_info ( "Sending a timebase master release request." );
 444             }
 445             //there is a new timebase master
 446             else
 447             {
 448                 fReturnTransportData.fTimebaseMaster = ( conditional ) ? CONDITIONAL_TIMEBASEMASTER : TIMEBASEMASTER;
 449                 jack_info ( "Sending a %s timebase master request.", ( conditional ) ? "conditional" : "non-conditional" );
 450             }
 451             fLastTimebaseMaster = refnum;
 452         }
 453         else
 454             fReturnTransportData.fTimebaseMaster = NO_CHANGE;
 455         */
 456
 457         //update transport state and position
 458         fReturnTransportData.fState = fEngineControl->fTransport.Query ( &fReturnTransportData.fPosition );
 459
 460         //is it a new state (that the master need to know...) ?
 461         fReturnTransportData.fNewState = (( fReturnTransportData.fState == JackTransportNetStarting) &&
 462                                            ( fReturnTransportData.fState != fLastTransportState ) &&
 463                                            ( fReturnTransportData.fState != fSendTransportData.fState ) );
 464         if ( fReturnTransportData.fNewState )
 465             jack_info ( "Sending '%s'.", GetTransportState ( fReturnTransportData.fState ) );
 466         fLastTransportState = fReturnTransportData.fState;
 467     }
 468
 469 //driver processes--------------------------------------------------------------------
 470     int JackNetDriver::Read()
 471     {
 472         uint midi_port_index;
 473         uint audio_port_index;
 474
 475         //buffers
 476         for ( midi_port_index = 0; midi_port_index < fParams.fSendMidiChannels; midi_port_index++ )
 477             fNetMidiCaptureBuffer->SetBuffer ( midi_port_index, GetMidiInputBuffer ( midi_port_index ) );
 478         for ( audio_port_index = 0; audio_port_index < fParams.fSendAudioChannels; audio_port_index++ )
 479             fNetAudioCaptureBuffer->SetBuffer ( audio_port_index, GetInputBuffer ( audio_port_index ) );
 480
 481 #ifdef JACK_MONITOR
 482         fNetTimeMon->New();
 483 #endif
 484
 485         //receive sync (launch the cycle)
 486         if ( SyncRecv() == SOCKET_ERROR )
 487             return 0;
 488
 489 #ifdef JACK_MONITOR
 490         // For timing
 491         fRcvSyncUst = GetMicroSeconds();
 492 #endif
 493
 494         //decode sync
 495         //if there is an error, don't return -1, it will skip Write() and the network error probably won't be identified
 496         DecodeSyncPacket();
 497
 498 #ifdef JACK_MONITOR
 499         fNetTimeMon->Add ( ( ( float ) ( GetMicroSeconds() - fRcvSyncUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
 500 #endif
 501         //audio, midi or sync if driver is late
 502         if ( DataRecv() == SOCKET_ERROR )
 503             return SOCKET_ERROR;
 504
 505         //take the time at the beginning of the cycle
 506         JackDriver::CycleTakeBeginTime();
 507
 508 #ifdef JACK_MONITOR
 509         fNetTimeMon->Add ( ( ( float ) ( GetMicroSeconds() - fRcvSyncUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
 510 #endif
 511
 512         return 0;
 513     }
 514
 515     int JackNetDriver::Write()
 516     {
 517         uint midi_port_index;
 518         int audio_port_index;
 519
 520         //buffers
 521         for ( midi_port_index = 0; midi_port_index < fParams.fReturnMidiChannels; midi_port_index++ )
 522             fNetMidiPlaybackBuffer->SetBuffer ( midi_port_index, GetMidiOutputBuffer ( midi_port_index ) );
 523         for ( audio_port_index = 0; audio_port_index < fPlaybackChannels; audio_port_index++ )
 524             fNetAudioPlaybackBuffer->SetBuffer ( audio_port_index, GetOutputBuffer ( audio_port_index ) );
 525
 526 #ifdef JACK_MONITOR
 527         fNetTimeMon->Add ( ( ( float ) ( GetMicroSeconds() - fRcvSyncUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
 528 #endif
 529
 530         //sync
 531         EncodeSyncPacket();
 532
 533         //send sync
 534         if ( SyncSend() == SOCKET_ERROR )
 535             return SOCKET_ERROR;
 536
 537 #ifdef JACK_MONITOR
 538         fNetTimeMon->Add ( ( ( float ) ( GetMicroSeconds() - fRcvSyncUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
 539 #endif
 540
 541         //send data
 542         if ( DataSend() == SOCKET_ERROR )
 543             return SOCKET_ERROR;
 544
 545 #ifdef JACK_MONITOR
 546         fNetTimeMon->AddLast ( ( ( float ) ( GetMicroSeconds() - fRcvSyncUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
 547 #endif
 548
 549         return 0;
 550     }
 551
 552 //driver loader-----------------------------------------------------------------------
 553
 554 #ifdef __cplusplus
 555     extern "C"
 556     {
 557 #endif
 558         SERVER_EXPORT jack_driver_desc_t* driver_get_descriptor ()
 559         {
 560             jack_driver_desc_t* desc = ( jack_driver_desc_t* ) calloc ( 1, sizeof ( jack_driver_desc_t ) );
 561
 562             strcpy ( desc->name, "net" );                             // size MUST be less then JACK_DRIVER_NAME_MAX + 1
 563             strcpy ( desc->desc, "netjack slave backend component" ); // size MUST be less then JACK_DRIVER_PARAM_DESC + 1
 564
 565             desc->nparams = 10;
 566             desc->params = ( jack_driver_param_desc_t* ) calloc ( desc->nparams, sizeof ( jack_driver_param_desc_t ) );
 567
 568             int i = 0;
 569             strcpy ( desc->params[i].name, "multicast_ip" );
 570             desc->params[i].character = 'a';
 571             desc->params[i].type = JackDriverParamString;
 572             strcpy ( desc->params[i].value.str, DEFAULT_MULTICAST_IP );
 573             strcpy ( desc->params[i].short_desc, "Multicast Address" );
 574             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 575
 576             i++;
 577             strcpy ( desc->params[i].name, "udp_net_port" );
 578             desc->params[i].character = 'p';
 579             desc->params[i].type = JackDriverParamInt;
 580             desc->params[i].value.i = DEFAULT_PORT;
 581             strcpy ( desc->params[i].short_desc, "UDP port" );
 582             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 583
 584             i++;
 585             strcpy ( desc->params[i].name, "mtu" );
 586             desc->params[i].character = 'M';
 587             desc->params[i].type = JackDriverParamInt;
 588             desc->params[i].value.i = DEFAULT_MTU;
 589             strcpy ( desc->params[i].short_desc, "MTU to the master" );
 590             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 591
 592             i++;
 593             strcpy ( desc->params[i].name, "input_ports" );
 594             desc->params[i].character = 'C';
 595             desc->params[i].type = JackDriverParamInt;
 596             desc->params[i].value.i = 2;
 597             strcpy ( desc->params[i].short_desc, "Number of audio input ports" );
 598             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 599
 600             i++;
 601             strcpy ( desc->params[i].name, "output_ports" );
 602             desc->params[i].character = 'P';
 603             desc->params[i].type = JackDriverParamInt;
 604             desc->params[i].value.i = 2;
 605             strcpy ( desc->params[i].short_desc, "Number of audio output ports" );
 606             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 607
 608             i++;
 609             strcpy ( desc->params[i].name, "midi_in_ports" );
 610             desc->params[i].character = 'i';
 611             desc->params[i].type = JackDriverParamInt;
 612             desc->params[i].value.i = 0;
 613             strcpy ( desc->params[i].short_desc, "Number of midi input ports" );
 614             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 615
 616             i++;
 617             strcpy ( desc->params[i].name, "midi_out_ports" );
 618             desc->params[i].character = 'o';
 619             desc->params[i].type = JackDriverParamUInt;
 620             desc->params[i].value.i = 0;
 621             strcpy ( desc->params[i].short_desc, "Number of midi output ports" );
 622             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 623
 624             i++;
 625             strcpy ( desc->params[i].name, "client_name" );
 626             desc->params[i].character = 'n';
 627             desc->params[i].type = JackDriverParamString;
 628             strcpy ( desc->params[i].value.str, "'hostname'" );
 629             strcpy ( desc->params[i].short_desc, "Name of the jack client" );
 630             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 631
 632             i++;
 633             strcpy ( desc->params[i].name, "transport_sync" );
 634             desc->params[i].character  = 't';
 635             desc->params[i].type = JackDriverParamUInt;
 636             desc->params[i].value.ui = 1U;
 637             strcpy ( desc->params[i].short_desc, "Sync transport with master's" );
 638             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 639
 640             i++;
 641             strcpy ( desc->params[i].name, "mode" );
 642             desc->params[i].character  = 'm';
 643             desc->params[i].type = JackDriverParamString;
 644             strcpy ( desc->params[i].value.str, "slow" );
 645             strcpy ( desc->params[i].short_desc, "Slow, Normal or Fast mode." );
 646             strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
 647
 648             return desc;
 649         }
 650
 651         SERVER_EXPORT Jack::JackDriverClientInterface* driver_initialize ( Jack::JackLockedEngine* engine, Jack::JackSynchro* table, const JSList* params )
 652         {
 653             char multicast_ip[16];
 654             strcpy ( multicast_ip, DEFAULT_MULTICAST_IP );
 655             char net_name[JACK_CLIENT_NAME_SIZE + 1];
 656             int udp_port = DEFAULT_PORT;
 657             int mtu = DEFAULT_MTU;
 658             uint transport_sync = 1;
 659             jack_nframes_t period_size = 128;
 660             jack_nframes_t sample_rate = 48000;
 661             int audio_capture_ports = 2;
 662             int audio_playback_ports = 2;
 663             int midi_input_ports = 0;
 664             int midi_output_ports = 0;
 665             bool monitor = false;
 666             char network_mode = 's';
 667             const JSList* node;
 668             const jack_driver_param_t* param;
 669
 670             net_name[0] = 0;
 671
 672             for ( node = params; node; node = jack_slist_next ( node ) )
 673             {
 674                 param = ( const jack_driver_param_t* ) node->data;
 675                 switch ( param->character )
 676                 {
 677                     case 'a' :
 678                         strncpy ( multicast_ip, param->value.str, 15 );
 679                         break;
 680                     case 'p':
 681                         udp_port = param->value.ui;
 682                         break;
 683                     case 'M':
 684                         mtu = param->value.i;
 685                         break;
 686                     case 'C':
 687                         audio_capture_ports = param->value.i;
 688                         break;
 689                     case 'P':
 690                         audio_playback_ports = param->value.i;
 691                         break;
 692                     case 'i':
 693                         midi_input_ports = param->value.i;
 694                         break;
 695                     case 'o':
 696                         midi_output_ports = param->value.i;
 697                         break;
 698                     case 'n' :
 699                         strncpy ( net_name, param->value.str, JACK_CLIENT_NAME_SIZE );
 700                         break;
 701                     case 't' :
 702                         transport_sync = param->value.ui;
 703                         break;
 704                     case 'm' :
 705                         if ( strcmp ( param->value.str, "normal" ) == 0 )
 706                             network_mode = 'n';
 707                         else if ( strcmp ( param->value.str, "slow" ) == 0 )
 708                             network_mode = 's';
 709                         else if ( strcmp ( param->value.str, "fast" ) == 0 )
 710                             network_mode = 'f';
 711                         else
 712                             jack_error ( "Unknown network mode, using 'normal' mode." );
 713                         break;
 714                 }
 715             }
 716
 717             try
 718             {
 719
 720                 Jack::JackDriverClientInterface* driver =
 721                     new Jack::JackWaitThreadedDriver (
 722                     new Jack::JackNetDriver ( "system", "net_pcm", engine, table, multicast_ip, udp_port, mtu,
 723                                               midi_input_ports, midi_output_ports, net_name, transport_sync, network_mode ) );
 724                 if ( driver->Open ( period_size, sample_rate, 1, 1, audio_capture_ports, audio_playback_ports,
 725                                     monitor, "from_master_", "to_master_", 0, 0 ) == 0 )
 726                 {
 727                     return driver;
 728                 }
 729                 else
 730                 {
 731                     delete driver;
 732                     return NULL;
 733                 }
 734
 735             }
 736             catch ( ... )
 737             {
 738                 return NULL;
 739             }
 740         }
 741
 742 #ifdef __cplusplus
 743     }
 744 #endif
 745 }