common/JackNetInterface.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 "JackNetInterface.h"
  21 #include "JackException.h"
  22 #include "JackPlatformPlug.h"
  23 #include <assert.h>
  24
  25 using namespace std;
  26
  27 /*
  28  TODO : since midi buffers now uses up to BUFFER_SIZE_MAX frames,
  29  probably also use BUFFER_SIZE_MAX in everything related to MIDI events
  30  handling (see MidiBufferInit in JackMidiPort.cpp)
  31 */
  32
  33 namespace Jack
  34 {
  35     // JackNetInterface*******************************************
  36
  37     JackNetInterface::JackNetInterface() : fSocket()
  38     {
  39         fMulticastIP = NULL;
  40         fTxBuffer = NULL;
  41         fRxBuffer = NULL;
  42         fNetAudioCaptureBuffer = NULL;
  43         fNetAudioPlaybackBuffer = NULL;
  44         fNetMidiCaptureBuffer = NULL;
  45         fNetMidiPlaybackBuffer = NULL;
  46     }
  47
  48     JackNetInterface::JackNetInterface ( const char* multicast_ip, int port ) : fSocket ( multicast_ip, port )
  49     {
  50         fMulticastIP = strdup ( multicast_ip );
  51         fTxBuffer = NULL;
  52         fRxBuffer = NULL;
  53         fNetAudioCaptureBuffer = NULL;
  54         fNetAudioPlaybackBuffer = NULL;
  55         fNetMidiCaptureBuffer = NULL;
  56         fNetMidiPlaybackBuffer = NULL;
  57     }
  58
  59     JackNetInterface::JackNetInterface ( session_params_t& params, JackNetSocket& socket, const char* multicast_ip ) : fSocket ( socket )
  60     {
  61         fParams = params;
  62         fMulticastIP = strdup ( multicast_ip );
  63         fTxBuffer = NULL;
  64         fRxBuffer = NULL;
  65         fNetAudioCaptureBuffer = NULL;
  66         fNetAudioPlaybackBuffer = NULL;
  67         fNetMidiCaptureBuffer = NULL;
  68         fNetMidiPlaybackBuffer = NULL;
  69     }
  70
  71     JackNetInterface::~JackNetInterface()
  72     {
  73         jack_log ( "JackNetInterface::~JackNetInterface" );
  74
  75         fSocket.Close();
  76         delete[] fTxBuffer;
  77         delete[] fRxBuffer;
  78         delete[] fMulticastIP;
  79         delete fNetAudioCaptureBuffer;
  80         delete fNetAudioPlaybackBuffer;
  81         delete fNetMidiCaptureBuffer;
  82         delete fNetMidiPlaybackBuffer;
  83     }
  84
  85     void JackNetInterface::SetFramesPerPacket()
  86     {
  87         jack_log ( "JackNetInterface::SetFramesPerPacket" );
  88
  89         if (fParams.fSendAudioChannels == 0 && fParams.fReturnAudioChannels == 0) {
  90             fParams.fFramesPerPacket = fParams.fPeriodSize;
  91         } else {
  92             jack_nframes_t period = ( int ) powf ( 2.f, ( int ) ( log (float ( fParams.fMtu - sizeof ( packet_header_t ) )
  93                                                / ( max ( fParams.fReturnAudioChannels, fParams.fSendAudioChannels ) * sizeof ( sample_t ) ) ) / log ( 2. ) ) );
  94             fParams.fFramesPerPacket = ( period > fParams.fPeriodSize ) ? fParams.fPeriodSize : period;
  95         }
  96     }
  97
  98     int JackNetInterface::SetNetBufferSize()
  99     {
 100         jack_log ( "JackNetInterface::SetNetBufferSize" );
 101
 102         float audio_size, midi_size;
 103         int bufsize;
 104         //audio
 105         audio_size = fParams.fMtu * ( fParams.fPeriodSize / fParams.fFramesPerPacket );
 106         //midi
 107         midi_size = fParams.fMtu * ( max ( fParams.fSendMidiChannels, fParams.fReturnMidiChannels ) *
 108                                      fParams.fPeriodSize * sizeof ( sample_t ) / ( fParams.fMtu - sizeof ( packet_header_t ) ) );
 109         //bufsize = sync + audio + midi
 110         bufsize = MAX_LATENCY * (fParams.fMtu + ( int ) audio_size + ( int ) midi_size);
 111
 112         //tx buffer
 113         if ( fSocket.SetOption ( SOL_SOCKET, SO_SNDBUF, &bufsize, sizeof ( bufsize ) ) == SOCKET_ERROR )
 114             return SOCKET_ERROR;
 115
 116         //rx buffer
 117         if ( fSocket.SetOption ( SOL_SOCKET, SO_RCVBUF, &bufsize, sizeof ( bufsize ) ) == SOCKET_ERROR )
 118             return SOCKET_ERROR;
 119
 120         return 0;
 121     }
 122
 123     int JackNetInterface::GetNMidiPckt()
 124     {
 125         //even if there is no midi data, jack need an empty buffer to know there is no event to read
 126         //99% of the cases : all data in one packet
 127         if ( fTxHeader.fMidiDataSize <= ( fParams.fMtu - sizeof ( packet_header_t ) ) )
 128             return 1;
 129         //else, get the number of needed packets (simply slice the biiig buffer)
 130         int npckt = fTxHeader.fMidiDataSize / ( fParams.fMtu - sizeof ( packet_header_t ) );
 131         if ( fTxHeader.fMidiDataSize % ( fParams.fMtu - sizeof ( packet_header_t ) ) )
 132             return ++npckt;
 133         return npckt;
 134     }
 135
 136     bool JackNetInterface::IsNextPacket()
 137     {
 138         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 139         //ignore first cycle
 140         if ( fRxHeader.fCycle <= 1 ) {
 141             return true;
 142         }
 143         //same PcktID (cycle), next SubPcktID (subcycle)
 144         if ( ( fRxHeader.fSubCycle < ( fNSubProcess - 1 ) ) && ( rx_head->fCycle == fRxHeader.fCycle ) && ( rx_head->fSubCycle == ( fRxHeader.fSubCycle + 1 ) ) ) {
 145              return true;
 146         }
 147         //next PcktID (cycle), SubPcktID reset to 0 (first subcyle)
 148         if ( ( rx_head->fCycle == ( fRxHeader.fCycle + 1 ) ) && ( fRxHeader.fSubCycle == ( fNSubProcess - 1 ) ) && ( rx_head->fSubCycle == 0 ) ) {
 149             return true;
 150         }
 151         //else, packet(s) missing, return false
 152         return false;
 153     }
 154
 155     void JackNetInterface::SetParams()
 156     {
 157         //number of audio subcycles (packets)
 158         fNSubProcess = fParams.fPeriodSize / fParams.fFramesPerPacket;
 159
 160         //payload size
 161         fPayloadSize = fParams.fMtu - sizeof ( packet_header_t );
 162
 163         //TX header init
 164         strcpy ( fTxHeader.fPacketType, "header" );
 165         fTxHeader.fID = fParams.fID;
 166         fTxHeader.fCycle = 0;
 167         fTxHeader.fSubCycle = 0;
 168         fTxHeader.fMidiDataSize = 0;
 169         fTxHeader.fBitdepth = fParams.fBitdepth;
 170         fTxHeader.fIsLastPckt = 0;
 171
 172         //RX header init
 173         strcpy ( fRxHeader.fPacketType, "header" );
 174         fRxHeader.fID = fParams.fID;
 175         fRxHeader.fCycle = 0;
 176         fRxHeader.fSubCycle = 0;
 177         fRxHeader.fMidiDataSize = 0;
 178         fRxHeader.fBitdepth = fParams.fBitdepth;
 179         fRxHeader.fIsLastPckt = 0;
 180
 181         //network buffers
 182         fTxBuffer = new char[fParams.fMtu];
 183         fRxBuffer = new char[fParams.fMtu];
 184         assert ( fTxBuffer );
 185         assert ( fRxBuffer );
 186
 187         //net audio/midi buffers'addresses
 188         fTxData = fTxBuffer + sizeof ( packet_header_t );
 189         fRxData = fRxBuffer + sizeof ( packet_header_t );
 190     }
 191
 192     // JackNetMasterInterface ************************************************************************************
 193
 194     bool JackNetMasterInterface::Init()
 195     {
 196         jack_log ( "JackNetMasterInterface::Init, ID %u.", fParams.fID );
 197
 198         session_params_t host_params;
 199         uint attempt = 0;
 200         int rx_bytes = 0;
 201
 202         //socket
 203         if ( fSocket.NewSocket() == SOCKET_ERROR )
 204         {
 205             jack_error ( "Can't create socket : %s", StrError ( NET_ERROR_CODE ) );
 206             return false;
 207         }
 208
 209         //timeout on receive (for init)
 210         if ( fSocket.SetTimeOut ( MASTER_INIT_TIMEOUT ) < 0 )
 211             jack_error ( "Can't set timeout : %s", StrError ( NET_ERROR_CODE ) );
 212
 213         //connect
 214         if ( fSocket.Connect() == SOCKET_ERROR )
 215         {
 216             jack_error ( "Can't connect : %s", StrError ( NET_ERROR_CODE ) );
 217             return false;
 218         }
 219
 220         //set the number of complete audio frames we can put in a packet
 221         SetFramesPerPacket();
 222
 223         //send 'SLAVE_SETUP' until 'START_MASTER' received
 224         jack_info ( "Sending parameters to %s ...", fParams.fSlaveNetName );
 225         do
 226         {
 227             session_params_t net_params;
 228             SetPacketType ( &fParams, SLAVE_SETUP );
 229             SessionParamsHToN(&fParams, &net_params);
 230
 231             if ( fSocket.Send ( &net_params, sizeof ( session_params_t ), 0 ) == SOCKET_ERROR )
 232                 jack_error ( "Error in send : ", StrError ( NET_ERROR_CODE ) );
 233
 234             memset(&net_params, 0, sizeof ( session_params_t ));
 235             if ( ( ( rx_bytes = fSocket.Recv ( &net_params, sizeof ( session_params_t ), 0 ) ) == SOCKET_ERROR ) && ( fSocket.GetError() != NET_NO_DATA ) )
 236             {
 237                 jack_error ( "Problem with network." );
 238                 return false;
 239             }
 240
 241             SessionParamsNToH(&net_params, &host_params);
 242         }
 243         while ( ( GetPacketType ( &host_params ) != START_MASTER ) && ( ++attempt < SLAVE_SETUP_RETRY ) );
 244         if ( attempt == SLAVE_SETUP_RETRY )
 245         {
 246             jack_error ( "Slave doesn't respond, exiting." );
 247             return false;
 248         }
 249
 250         //set the new timeout for the socket
 251         if ( SetRxTimeout() == SOCKET_ERROR )
 252         {
 253             jack_error ( "Can't set rx timeout : %s", StrError ( NET_ERROR_CODE ) );
 254             return false;
 255         }
 256
 257         //set the new rx buffer size
 258         if ( SetNetBufferSize() == SOCKET_ERROR )
 259         {
 260             jack_error ( "Can't set net buffer sizes : %s", StrError ( NET_ERROR_CODE ) );
 261             return false;
 262         }
 263
 264         return true;
 265     }
 266
 267     int JackNetMasterInterface::SetRxTimeout()
 268     {
 269         jack_log ( "JackNetMasterInterface::SetRxTimeout" );
 270
 271         float time = 0;
 272         //slow or normal mode, short timeout on recv (2 audio subcycles)
 273         if ( ( fParams.fNetworkMode == 's' ) || ( fParams.fNetworkMode == 'n' ) )
 274             time = 2000000.f * ( static_cast<float> ( fParams.fFramesPerPacket ) / static_cast<float> ( fParams.fSampleRate ) );
 275         //fast mode, wait for 75% of the entire cycle duration
 276         else if ( fParams.fNetworkMode == 'f' )
 277             time = 750000.f * ( static_cast<float> ( fParams.fPeriodSize ) / static_cast<float> ( fParams.fSampleRate ) );
 278         return fSocket.SetTimeOut ( static_cast<int> ( time ) );
 279     }
 280
 281     void JackNetMasterInterface::SetParams()
 282     {
 283         jack_log ( "JackNetMasterInterface::SetParams" );
 284
 285         JackNetInterface::SetParams();
 286
 287         fTxHeader.fDataStream = 's';
 288         fRxHeader.fDataStream = 'r';
 289
 290         //midi net buffers
 291         fNetMidiCaptureBuffer = new NetMidiBuffer ( &fParams, fParams.fSendMidiChannels, fTxData );
 292         fNetMidiPlaybackBuffer = new NetMidiBuffer ( &fParams, fParams.fReturnMidiChannels, fRxData );
 293         assert ( fNetMidiCaptureBuffer );
 294         assert ( fNetMidiPlaybackBuffer );
 295
 296         //audio net buffers
 297         fNetAudioCaptureBuffer = new NetAudioBuffer ( &fParams, fParams.fSendAudioChannels, fTxData );
 298         fNetAudioPlaybackBuffer = new NetAudioBuffer ( &fParams, fParams.fReturnAudioChannels, fRxData );
 299         assert ( fNetAudioCaptureBuffer );
 300         assert ( fNetAudioPlaybackBuffer );
 301
 302         //audio netbuffer length
 303         fAudioTxLen = sizeof ( packet_header_t ) + fNetAudioPlaybackBuffer->GetSize();
 304         fAudioRxLen = sizeof ( packet_header_t ) + fNetAudioCaptureBuffer->GetSize();
 305     }
 306
 307     void JackNetMasterInterface::Exit()
 308     {
 309         jack_log ( "JackNetMasterInterface::Exit, ID %u", fParams.fID );
 310
 311         //stop process
 312         fRunning = false;
 313
 314         //send a 'multicast euthanasia request' - new socket is required on macosx
 315         jack_info ( "Exiting '%s'", fParams.fName );
 316         SetPacketType ( &fParams, KILL_MASTER );
 317         JackNetSocket mcast_socket ( fMulticastIP, fSocket.GetPort() );
 318
 319         session_params_t net_params;
 320         SessionParamsHToN(&fParams, &net_params);
 321
 322         if ( mcast_socket.NewSocket() == SOCKET_ERROR )
 323             jack_error ( "Can't create socket : %s", StrError ( NET_ERROR_CODE ) );
 324         if ( mcast_socket.SendTo ( &net_params, sizeof ( session_params_t ), 0, fMulticastIP ) == SOCKET_ERROR )
 325             jack_error ( "Can't send suicide request : %s", StrError ( NET_ERROR_CODE ) );
 326
 327         mcast_socket.Close();
 328
 329         // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
 330         ThreadExit();
 331     }
 332
 333     int JackNetMasterInterface::Recv ( size_t size, int flags )
 334     {
 335         int rx_bytes;
 336         if ( ( ( rx_bytes = fSocket.Recv ( fRxBuffer, size, flags ) ) == SOCKET_ERROR ) && fRunning )
 337         {
 338             net_error_t error = fSocket.GetError();
 339             //no data isn't really a network error, so just return 0 avalaible read bytes
 340             if ( error == NET_NO_DATA )
 341                 return 0;
 342             else if ( error == NET_CONN_ERROR )
 343             {
 344                 //fatal connection issue, exit
 345                 jack_error ( "'%s' : %s, exiting.", fParams.fName, StrError ( NET_ERROR_CODE ) );
 346                 //ask to the manager to properly remove the master
 347                 Exit();
 348             }
 349             else
 350                 jack_error ( "Error in master receive : %s", StrError ( NET_ERROR_CODE ) );
 351         }
 352
 353         packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
 354         PacketHeaderNToH(header, header);
 355         return rx_bytes;
 356     }
 357
 358     int JackNetMasterInterface::Send ( size_t size, int flags )
 359     {
 360         int tx_bytes;
 361         packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
 362         PacketHeaderHToN(header, header);
 363
 364         if ( ( ( tx_bytes = fSocket.Send ( fTxBuffer, size, flags ) ) == SOCKET_ERROR ) && fRunning )
 365         {
 366             net_error_t error = fSocket.GetError();
 367             if ( error == NET_CONN_ERROR )
 368             {
 369                 //fatal connection issue, exit
 370                 jack_error ( "'%s' : %s, exiting.", fParams.fName, StrError ( NET_ERROR_CODE ) );
 371                 Exit();
 372             }
 373             else
 374                 jack_error ( "Error in master send : %s", StrError ( NET_ERROR_CODE ) );
 375         }
 376         return tx_bytes;
 377     }
 378
 379     bool JackNetMasterInterface::IsSynched()
 380     {
 381         if (fParams.fNetworkMode == 's') {
 382             return (fCycleOffset < 3);
 383         } else {
 384             return true;
 385         }
 386     }
 387
 388     int JackNetMasterInterface::SyncSend()
 389     {
 390         fTxHeader.fCycle++;
 391         fTxHeader.fSubCycle = 0;
 392         fTxHeader.fDataType = 's';
 393         fTxHeader.fIsLastPckt = ( !fParams.fSendMidiChannels && !fParams.fSendAudioChannels ) ?  1 : 0;
 394         fTxHeader.fPacketSize = fParams.fMtu;
 395         memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
 396         return Send ( fTxHeader.fPacketSize, 0 );
 397     }
 398
 399     int JackNetMasterInterface::DataSend()
 400     {
 401         uint subproc;
 402         //midi
 403         if ( fParams.fSendMidiChannels )
 404         {
 405             //set global header fields and get the number of midi packets
 406             fTxHeader.fDataType = 'm';
 407             fTxHeader.fMidiDataSize = fNetMidiCaptureBuffer->RenderFromJackPorts();
 408             fTxHeader.fNMidiPckt = GetNMidiPckt();
 409             for ( subproc = 0; subproc < fTxHeader.fNMidiPckt; subproc++ )
 410             {
 411                 fTxHeader.fSubCycle = subproc;
 412                 fTxHeader.fIsLastPckt = ( ( subproc == ( fTxHeader.fNMidiPckt - 1 ) ) && !fParams.fSendAudioChannels ) ? 1 : 0;
 413                 fTxHeader.fPacketSize = sizeof ( packet_header_t ) + fNetMidiCaptureBuffer->RenderToNetwork ( subproc, fTxHeader.fMidiDataSize );
 414                 memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
 415                 if ( Send ( fTxHeader.fPacketSize, 0 ) == SOCKET_ERROR )
 416                     return SOCKET_ERROR;
 417             }
 418         }
 419
 420         //audio
 421         if ( fParams.fSendAudioChannels )
 422         {
 423             fTxHeader.fDataType = 'a';
 424             for ( subproc = 0; subproc < fNSubProcess; subproc++ )
 425             {
 426                 fTxHeader.fSubCycle = subproc;
 427                 fTxHeader.fIsLastPckt = ( subproc == ( fNSubProcess - 1 ) ) ? 1 : 0;
 428                 fTxHeader.fPacketSize = fAudioTxLen;
 429                 memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
 430                 fNetAudioCaptureBuffer->RenderFromJackPorts ( subproc );
 431                 if ( Send ( fTxHeader.fPacketSize, 0 ) == SOCKET_ERROR )
 432                     return SOCKET_ERROR;
 433             }
 434         }
 435
 436         return 0;
 437     }
 438
 439     int JackNetMasterInterface::SyncRecv()
 440     {
 441         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 442         int rx_bytes = Recv ( fParams.fMtu, MSG_PEEK );
 443
 444         if ( ( rx_bytes == 0 ) || ( rx_bytes == SOCKET_ERROR ) )
 445             return rx_bytes;
 446
 447         fCycleOffset = fTxHeader.fCycle - rx_head->fCycle;
 448
 449         switch ( fParams.fNetworkMode )
 450         {
 451             case 's' :
 452                 //slow mode : allow to use full bandwidth and heavy process on the slave
 453                 //  - extra latency is set to two cycles, one cycle for send/receive operations + one cycle for heavy process on the slave
 454                 //  - if the network is two fast, just wait the next cycle, this mode allows a shorter cycle duration for the master
 455                 //  - this mode will skip the two first cycles, thus it lets time for data to be processed and queued on the socket rx buffer
 456                 //the slow mode is the safest mode because it wait twice the bandwidth relative time (send/return + process)
 457                 if (fCycleOffset < 2)
 458                      return 0;
 459                 else
 460                     rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 461
 462                 if (fCycleOffset > 2) {
 463                     jack_info("Warning : '%s' runs in slow network mode, but data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
 464                 }
 465                 break;
 466
 467             case 'n' :
 468                 //normal use of the network :
 469                 //  - extra latency is set to one cycle, what is the time needed to receive streams using full network bandwidth
 470                 //  - if the network is too fast, just wait the next cycle, the benefit here is the master's cycle is shorter
 471                 //  - indeed, data is supposed to be on the network rx buffer, so we don't have to wait for it
 472                 if (fCycleOffset < 1)
 473                     return 0;
 474                 else
 475                     rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 476
 477                 if (fCycleOffset != 1)
 478                     jack_info("'%s' can't run in normal network mode, data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
 479                 break;
 480
 481             case 'f' :
 482                 //fast mode suppose the network bandwith is larger than required for the transmission (only a few channels for example)
 483                 //    - packets can be quickly received, quickly is here relative to the cycle duration
 484                 //    - here, receive data, we can't keep it queued on the rx buffer,
 485                 //    - but if there is a cycle offset, tell the user, that means we're not in fast mode anymore, network is too slow
 486                 rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 487
 488                 if (fCycleOffset != 0)
 489                     jack_info("'%s' can't run in fast network mode, data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
 490                 break;
 491         }
 492
 493         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 494         return rx_bytes;
 495     }
 496
 497     int JackNetMasterInterface::DataRecv()
 498     {
 499         int rx_bytes = 0;
 500         uint jumpcnt = 0;
 501         uint recvd_midi_pckt = 0;
 502         uint recvd_audio_pckt = 0;
 503         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 504
 505         while ( !fRxHeader.fIsLastPckt )
 506         {
 507             //how much data is queued on the rx buffer ?
 508             rx_bytes = Recv ( fParams.fMtu, MSG_PEEK );
 509
 510             if ( rx_bytes == SOCKET_ERROR )
 511                 return rx_bytes;
 512             //if no data
 513             if ( ( rx_bytes == 0 ) && ( ++jumpcnt == fNSubProcess ) )
 514             {
 515                 jack_error ( "No data from %s...", fParams.fName );
 516                 jumpcnt = 0;
 517             }
 518             //else if data is valid,
 519             if ( rx_bytes && ( rx_head->fDataStream == 'r' ) && ( rx_head->fID == fParams.fID ) )
 520             {
 521                 //read data
 522                 switch ( rx_head->fDataType )
 523                 {
 524                     case 'm':   //midi
 525                         rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 526                         fRxHeader.fCycle = rx_head->fCycle;
 527                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 528                         fNetMidiPlaybackBuffer->RenderFromNetwork ( rx_head->fSubCycle, rx_bytes - sizeof ( packet_header_t ) );
 529                         if ( ++recvd_midi_pckt == rx_head->fNMidiPckt )
 530                             fNetMidiPlaybackBuffer->RenderToJackPorts();
 531                         jumpcnt = 0;
 532                         break;
 533
 534                     case 'a':   //audio
 535                         rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 536                         // SL: 25/01/09
 537                         // if ( !IsNextPacket() )
 538                         //    jack_error ( "Packet(s) missing from '%s'...", fParams.fName );
 539                         if (recvd_audio_pckt++ != rx_head->fSubCycle) {
 540                             jack_error("Packet(s) missing from '%s'...", fParams.fSlaveNetName);
 541                         }
 542                         fRxHeader.fCycle = rx_head->fCycle;
 543                         fRxHeader.fSubCycle = rx_head->fSubCycle;
 544                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 545                         fNetAudioPlaybackBuffer->RenderToJackPorts ( rx_head->fSubCycle );
 546                         jumpcnt = 0;
 547                         break;
 548
 549                     case 's':   //sync
 550                         /* SL: 25/01/09
 551                         if ( rx_head->fCycle == fTxHeader.fCycle )
 552                             return 0;
 553                         */
 554                         jack_info("NetMaster : overloaded, skipping receive from '%s'", fParams.fName);
 555                         return 0;
 556                 }
 557             }
 558         }
 559         return rx_bytes;
 560     }
 561
 562 // JackNetSlaveInterface ************************************************************************************************
 563
 564     uint JackNetSlaveInterface::fSlaveCounter = 0;
 565
 566     bool JackNetSlaveInterface::Init()
 567     {
 568         jack_log ( "JackNetSlaveInterface::Init()" );
 569
 570         //set the parameters to send
 571         strcpy ( fParams.fPacketType, "params" );
 572         fParams.fProtocolVersion = 'a';
 573         SetPacketType ( &fParams, SLAVE_AVAILABLE );
 574
 575         //init loop : get a master and start, do it until connection is ok
 576         net_status_t status;
 577         do
 578         {
 579             //first, get a master, do it until a valid connection is running
 580             do
 581             {
 582                 status = GetNetMaster();
 583                 if ( status == NET_SOCKET_ERROR )
 584                     return false;
 585             }
 586             while ( status != NET_CONNECTED );
 587
 588             //then tell the master we are ready
 589             jack_info ( "Initializing connection with %s...", fParams.fMasterNetName );
 590             status = SendStartToMaster();
 591             if ( status == NET_ERROR )
 592                 return false;
 593         }
 594         while ( status != NET_ROLLING );
 595
 596         return true;
 597     }
 598
 599     net_status_t JackNetSlaveInterface::GetNetMaster()
 600     {
 601         jack_log ( "JackNetSlaveInterface::GetNetMaster()" );
 602         //utility
 603         session_params_t host_params;
 604         int rx_bytes = 0;
 605
 606         //socket
 607         if ( fSocket.NewSocket() == SOCKET_ERROR )
 608         {
 609             jack_error ( "Fatal error : network unreachable - %s", StrError ( NET_ERROR_CODE ) );
 610             return NET_SOCKET_ERROR;
 611         }
 612
 613         //bind the socket
 614         if ( fSocket.Bind() == SOCKET_ERROR )
 615             jack_error ( "Can't bind the socket : %s", StrError ( NET_ERROR_CODE ) );
 616
 617         //timeout on receive
 618         if ( fSocket.SetTimeOut ( SLAVE_INIT_TIMEOUT ) == SOCKET_ERROR )
 619             jack_error ( "Can't set timeout : %s", StrError ( NET_ERROR_CODE ) );
 620
 621         //disable local loop
 622         if ( fSocket.SetLocalLoop() == SOCKET_ERROR )
 623             jack_error ( "Can't disable multicast loop : %s", StrError ( NET_ERROR_CODE ) );
 624
 625         //send 'AVAILABLE' until 'SLAVE_SETUP' received
 626         jack_info ( "Waiting for a master..." );
 627         do
 628         {
 629             //send 'available'
 630             session_params_t net_params;
 631             SessionParamsHToN(&fParams, &net_params);
 632             if ( fSocket.SendTo ( &net_params, sizeof ( session_params_t ), 0, fMulticastIP ) == SOCKET_ERROR )
 633                 jack_error ( "Error in data send : %s", StrError ( NET_ERROR_CODE ) );
 634
 635             //filter incoming packets : don't exit while no error is detected
 636             memset(&net_params, 0, sizeof ( session_params_t ));
 637             rx_bytes = fSocket.CatchHost ( &net_params, sizeof ( session_params_t ), 0 );
 638             SessionParamsNToH(&net_params, &host_params);
 639             if ( ( rx_bytes == SOCKET_ERROR ) && ( fSocket.GetError() != NET_NO_DATA ) )
 640             {
 641                 jack_error ( "Can't receive : %s", StrError ( NET_ERROR_CODE ) );
 642                 return NET_RECV_ERROR;
 643             }
 644         }
 645         while ( strcmp ( host_params.fPacketType, fParams.fPacketType )  && ( GetPacketType ( &host_params ) != SLAVE_SETUP ) );
 646
 647         //everything is OK, copy parameters
 648         fParams = host_params;
 649
 650         //set the new buffer sizes
 651         if ( SetNetBufferSize() == SOCKET_ERROR )
 652             jack_error ( "Can't set net buffer sizes : %s", StrError ( NET_ERROR_CODE ) );
 653
 654         //connect the socket
 655         if ( fSocket.Connect() == SOCKET_ERROR )
 656         {
 657             jack_error ( "Error in connect : %s", StrError ( NET_ERROR_CODE ) );
 658             return NET_CONNECT_ERROR;
 659         }
 660
 661         return NET_CONNECTED;
 662     }
 663
 664     net_status_t JackNetSlaveInterface::SendStartToMaster()
 665     {
 666         jack_log ( "JackNetSlaveInterface::SendStartToMaster" );
 667
 668         //tell the master to start
 669         session_params_t net_params;
 670         SetPacketType ( &fParams, START_MASTER );
 671         SessionParamsHToN(&fParams, &net_params);
 672         if ( fSocket.Send ( &net_params, sizeof ( session_params_t ), 0 ) == SOCKET_ERROR )
 673         {
 674             jack_error ( "Error in send : %s", StrError ( NET_ERROR_CODE ) );
 675             return ( fSocket.GetError() == NET_CONN_ERROR ) ? NET_ERROR : NET_SEND_ERROR;
 676         }
 677         return NET_ROLLING;
 678     }
 679
 680     void JackNetSlaveInterface::SetParams()
 681     {
 682         jack_log ( "JackNetSlaveInterface::SetParams" );
 683
 684         JackNetInterface::SetParams();
 685
 686         fTxHeader.fDataStream = 'r';
 687         fRxHeader.fDataStream = 's';
 688
 689         //midi net buffers
 690         fNetMidiCaptureBuffer = new NetMidiBuffer ( &fParams, fParams.fSendMidiChannels, fRxData );
 691         fNetMidiPlaybackBuffer = new NetMidiBuffer ( &fParams, fParams.fReturnMidiChannels, fTxData );
 692
 693         //audio net buffers
 694         fNetAudioCaptureBuffer = new NetAudioBuffer ( &fParams, fParams.fSendAudioChannels, fRxData );
 695         fNetAudioPlaybackBuffer = new NetAudioBuffer ( &fParams, fParams.fReturnAudioChannels, fTxData );
 696
 697         //audio netbuffer length
 698         fAudioTxLen = sizeof ( packet_header_t ) + fNetAudioPlaybackBuffer->GetSize();
 699         fAudioRxLen = sizeof ( packet_header_t ) + fNetAudioCaptureBuffer->GetSize();
 700     }
 701
 702     int JackNetSlaveInterface::Recv ( size_t size, int flags )
 703     {
 704         int rx_bytes = fSocket.Recv ( fRxBuffer, size, flags );
 705         //handle errors
 706         if ( rx_bytes == SOCKET_ERROR )
 707         {
 708             net_error_t error = fSocket.GetError();
 709             //no data isn't really an error in realtime processing, so just return 0
 710             if ( error == NET_NO_DATA )
 711                 jack_error ( "No data, is the master still running ?" );
 712             //if a network error occurs, this exception will restart the driver
 713             else if ( error == NET_CONN_ERROR )
 714             {
 715                 jack_error ( "Connection lost." );
 716                 throw JackNetException();
 717             }
 718             else
 719                 jack_error ( "Fatal error in slave receive : %s", StrError ( NET_ERROR_CODE ) );
 720         }
 721
 722         packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
 723         PacketHeaderNToH(header, header);
 724         return rx_bytes;
 725     }
 726
 727     int JackNetSlaveInterface::Send ( size_t size, int flags )
 728     {
 729         packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
 730         PacketHeaderHToN(header, header);
 731         int tx_bytes = fSocket.Send ( fTxBuffer, size, flags );
 732
 733         //handle errors
 734         if ( tx_bytes == SOCKET_ERROR )
 735         {
 736             net_error_t error = fSocket.GetError();
 737             //if a network error occurs, this exception will restart the driver
 738             if ( error == NET_CONN_ERROR )
 739             {
 740                 jack_error ( "Connection lost." );
 741                 throw JackNetException();
 742             }
 743             else
 744                 jack_error ( "Fatal error in slave send : %s", StrError ( NET_ERROR_CODE ) );
 745         }
 746         return tx_bytes;
 747     }
 748
 749     int JackNetSlaveInterface::SyncRecv()
 750     {
 751         int rx_bytes = 0;
 752         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 753         //receive sync (launch the cycle)
 754         do
 755         {
 756             rx_bytes = Recv ( fParams.fMtu, 0 );
 757             //connection issue, send will detect it, so don't skip the cycle (return 0)
 758             if ( rx_bytes == SOCKET_ERROR )
 759                 return rx_bytes;
 760         }
 761         while ( !rx_bytes && ( rx_head->fDataType != 's' ) );
 762         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 763         return rx_bytes;
 764     }
 765
 766     int JackNetSlaveInterface::DataRecv()
 767     {
 768         uint recvd_midi_pckt = 0;
 769         uint recvd_audio_pckt = 0;
 770         int rx_bytes = 0;
 771         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 772
 773         while ( !fRxHeader.fIsLastPckt )
 774         {
 775             rx_bytes = Recv ( fParams.fMtu, MSG_PEEK );
 776             //error here, problem with recv, just skip the cycle (return -1)
 777
 778             if ( rx_bytes == SOCKET_ERROR )
 779                 return rx_bytes;
 780             if ( rx_bytes && ( rx_head->fDataStream == 's' ) && ( rx_head->fID == fParams.fID ) )
 781             {
 782                 switch ( rx_head->fDataType )
 783                 {
 784                     case 'm':   //midi
 785                         rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 786                         fRxHeader.fCycle = rx_head->fCycle;
 787                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 788                         fNetMidiCaptureBuffer->RenderFromNetwork ( rx_head->fSubCycle, rx_bytes - sizeof ( packet_header_t ) );
 789                         if ( ++recvd_midi_pckt == rx_head->fNMidiPckt )
 790                             fNetMidiCaptureBuffer->RenderToJackPorts();
 791                         break;
 792
 793                     case 'a':   //audio
 794                         rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 795                         //SL: 25/01/09
 796                         // if ( !IsNextPacket() )
 797                         //    jack_error ( "Packet(s) missing..." );
 798                         if (recvd_audio_pckt++ != rx_head->fSubCycle) {
 799                             jack_error("Packet(s) missing from '%s'...", fParams.fMasterNetName);
 800                         }
 801                         fRxHeader.fCycle = rx_head->fCycle;
 802                         fRxHeader.fSubCycle = rx_head->fSubCycle;
 803                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 804                         fNetAudioCaptureBuffer->RenderToJackPorts ( rx_head->fSubCycle );
 805                         break;
 806
 807                     case 's':   //sync
 808                         jack_info ( "NetSlave : overloaded, skipping receive." );
 809                         return 0;
 810                 }
 811             }
 812         }
 813         fRxHeader.fCycle = rx_head->fCycle;
 814         return 0;
 815     }
 816
 817     int JackNetSlaveInterface::SyncSend()
 818     {
 819         //tx header
 820         if ( fParams.fSlaveSyncMode )
 821             fTxHeader.fCycle = fRxHeader.fCycle;
 822         else
 823             fTxHeader.fCycle++;
 824         fTxHeader.fSubCycle = 0;
 825         fTxHeader.fDataType = 's';
 826         fTxHeader.fIsLastPckt = ( !fParams.fReturnMidiChannels && !fParams.fReturnAudioChannels ) ?  1 : 0;
 827         fTxHeader.fPacketSize = fParams.fMtu;
 828         memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
 829         return Send ( fTxHeader.fPacketSize, 0 );
 830     }
 831
 832     int JackNetSlaveInterface::DataSend()
 833     {
 834         uint subproc;
 835
 836         //midi
 837         if ( fParams.fReturnMidiChannels )
 838         {
 839             fTxHeader.fDataType = 'm';
 840             fTxHeader.fMidiDataSize = fNetMidiPlaybackBuffer->RenderFromJackPorts();
 841             fTxHeader.fNMidiPckt = GetNMidiPckt();
 842             for ( subproc = 0; subproc < fTxHeader.fNMidiPckt; subproc++ )
 843             {
 844                 fTxHeader.fSubCycle = subproc;
 845                 fTxHeader.fIsLastPckt = ( ( subproc == ( fTxHeader.fNMidiPckt - 1 ) ) && !fParams.fReturnAudioChannels ) ? 1 : 0;
 846                 fTxHeader.fPacketSize = sizeof ( packet_header_t ) + fNetMidiPlaybackBuffer->RenderToNetwork ( subproc, fTxHeader.fMidiDataSize );
 847                 memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
 848                 if ( Send ( fTxHeader.fPacketSize, 0 ) == SOCKET_ERROR )
 849                     return SOCKET_ERROR;
 850             }
 851         }
 852
 853         //audio
 854         if ( fParams.fReturnAudioChannels )
 855         {
 856             fTxHeader.fDataType = 'a';
 857             for ( subproc = 0; subproc < fNSubProcess; subproc++ )
 858             {
 859                 fTxHeader.fSubCycle = subproc;
 860                 fTxHeader.fIsLastPckt = ( subproc == ( fNSubProcess - 1 ) ) ? 1 : 0;
 861                 fTxHeader.fPacketSize = fAudioTxLen;
 862                 memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
 863                 fNetAudioPlaybackBuffer->RenderFromJackPorts ( subproc );
 864                 if ( Send ( fTxHeader.fPacketSize, 0 ) == SOCKET_ERROR )
 865                     return SOCKET_ERROR;
 866             }
 867         }
 868         return 0;
 869     }
 870 }