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 #define PACKET_AVAILABLE_SIZE (fParams.fMtu - sizeof(packet_header_t))
  28 #define HEADER_SIZE (sizeof(packet_header_t))
  29
  30 /*
  31  TODO : since midi buffers now uses up to BUFFER_SIZE_MAX frames,
  32  probably also use BUFFER_SIZE_MAX in everything related to MIDI events
  33  handling (see MidiBufferInit in JackMidiPort.cpp)
  34 */
  35
  36 namespace Jack
  37 {
  38     // JackNetInterface*******************************************
  39
  40     JackNetInterface::JackNetInterface() : fSocket()
  41     {
  42         Initialize();
  43     }
  44
  45     JackNetInterface::JackNetInterface ( const char* multicast_ip, int port ) : fSocket ( multicast_ip, port )
  46     {
  47         strcpy(fMulticastIP, multicast_ip);
  48         Initialize();
  49     }
  50
  51     JackNetInterface::JackNetInterface ( session_params_t& params, JackNetSocket& socket, const char* multicast_ip ) : fSocket ( socket )
  52     {
  53         fParams = params;
  54         strcpy(fMulticastIP, multicast_ip);
  55         Initialize();
  56     }
  57
  58     void JackNetInterface::Initialize()
  59     {
  60         fTxBuffer = NULL;
  61         fRxBuffer = NULL;
  62         fNetAudioCaptureBuffer = NULL;
  63         fNetAudioPlaybackBuffer = NULL;
  64         fNetMidiCaptureBuffer = NULL;
  65         fNetMidiPlaybackBuffer = NULL;
  66         memset(&fSendTransportData, 0, sizeof(net_transport_data_t));
  67         memset(&fReturnTransportData, 0, sizeof(net_transport_data_t));
  68     }
  69
  70     void JackNetInterface::FreeNetworkBuffers()
  71     {
  72         delete fNetMidiCaptureBuffer;
  73         delete fNetMidiPlaybackBuffer;
  74         delete fNetAudioCaptureBuffer;
  75         delete fNetAudioPlaybackBuffer;
  76         fNetMidiCaptureBuffer = NULL;
  77         fNetMidiPlaybackBuffer = NULL;
  78         fNetAudioCaptureBuffer = NULL;
  79         fNetAudioPlaybackBuffer = NULL;
  80     }
  81
  82     JackNetInterface::~JackNetInterface()
  83     {
  84         jack_log ("JackNetInterface::~JackNetInterface");
  85
  86         fSocket.Close();
  87         delete[] fTxBuffer;
  88         delete[] fRxBuffer;
  89         delete fNetAudioCaptureBuffer;
  90         delete fNetAudioPlaybackBuffer;
  91         delete fNetMidiCaptureBuffer;
  92         delete fNetMidiPlaybackBuffer;
  93     }
  94
  95     int JackNetInterface::SetNetBufferSize()
  96     {
  97         //audio
  98         float audio_size = (fNetAudioCaptureBuffer)
  99                             ? fNetAudioCaptureBuffer->GetCycleSize()
 100                             : (fNetAudioPlaybackBuffer) ? fNetAudioPlaybackBuffer->GetCycleSize() : 0;
 101         jack_log("audio_size %f", audio_size);
 102
 103         //midi
 104         float midi_size = (fNetMidiCaptureBuffer)
 105                             ? fNetMidiCaptureBuffer->GetCycleSize()
 106                             : (fNetMidiPlaybackBuffer) ? fNetMidiPlaybackBuffer->GetCycleSize() : 0;
 107         jack_log("midi_size %f", midi_size);
 108
 109         //bufsize = sync + audio + midi
 110         int bufsize = MAX_LATENCY * (fParams.fMtu + (int)audio_size + (int) midi_size);
 111         jack_log("SetNetBufferSize bufsize = %d", bufsize);
 112
 113         //tx buffer
 114         if (fSocket.SetOption(SOL_SOCKET, SO_SNDBUF, &bufsize, sizeof(bufsize)) == SOCKET_ERROR)
 115             return SOCKET_ERROR;
 116
 117         //rx buffer
 118         if (fSocket.SetOption(SOL_SOCKET, SO_RCVBUF, &bufsize, sizeof(bufsize)) == SOCKET_ERROR)
 119             return SOCKET_ERROR;
 120
 121         return 0;
 122     }
 123
 124     bool JackNetInterface::SetParams()
 125     {
 126         //TX header init
 127         strcpy ( fTxHeader.fPacketType, "header" );
 128         fTxHeader.fID = fParams.fID;
 129         fTxHeader.fCycle = 0;
 130         fTxHeader.fSubCycle = 0;
 131         fTxHeader.fIsLastPckt = 0;
 132
 133         //RX header init
 134         strcpy ( fRxHeader.fPacketType, "header" );
 135         fRxHeader.fID = fParams.fID;
 136         fRxHeader.fCycle = 0;
 137         fRxHeader.fSubCycle = 0;
 138         fRxHeader.fIsLastPckt = 0;
 139
 140         //network buffers
 141         fTxBuffer = new char[fParams.fMtu];
 142         fRxBuffer = new char[fParams.fMtu];
 143         assert ( fTxBuffer );
 144         assert ( fRxBuffer );
 145
 146         //net audio/midi buffers'addresses
 147         fTxData = fTxBuffer + HEADER_SIZE;
 148         fRxData = fRxBuffer + HEADER_SIZE;
 149
 150         return true;
 151     }
 152
 153     // JackNetMasterInterface ************************************************************************************
 154
 155     bool JackNetMasterInterface::Init()
 156     {
 157         jack_log ( "JackNetMasterInterface::Init, ID %u.", fParams.fID );
 158
 159         session_params_t host_params;
 160         uint attempt = 0;
 161         int rx_bytes = 0;
 162
 163         //socket
 164         if ( fSocket.NewSocket() == SOCKET_ERROR ) {
 165             jack_error ( "Can't create socket : %s", StrError ( NET_ERROR_CODE ) );
 166             return false;
 167         }
 168
 169         //timeout on receive (for init)
 170         if ( fSocket.SetTimeOut ( MASTER_INIT_TIMEOUT ) < 0 )
 171             jack_error ( "Can't set timeout : %s", StrError ( NET_ERROR_CODE ) );
 172
 173         //connect
 174         if ( fSocket.Connect() == SOCKET_ERROR ) {
 175             jack_error ( "Can't connect : %s", StrError ( NET_ERROR_CODE ) );
 176             return false;
 177         }
 178
 179         //send 'SLAVE_SETUP' until 'START_MASTER' received
 180         jack_info ( "Sending parameters to %s...", fParams.fSlaveNetName );
 181         do
 182         {
 183             session_params_t net_params;
 184             memset(&net_params, 0, sizeof ( session_params_t ));
 185             SetPacketType ( &fParams, SLAVE_SETUP );
 186             SessionParamsHToN(&fParams, &net_params);
 187
 188             if ( fSocket.Send ( &net_params, sizeof ( session_params_t ), 0 ) == SOCKET_ERROR )
 189                 jack_error ( "Error in send : ", StrError ( NET_ERROR_CODE ) );
 190
 191             memset(&net_params, 0, sizeof (session_params_t));
 192             if (((rx_bytes = fSocket.Recv(&net_params, sizeof(session_params_t), 0)) == SOCKET_ERROR) && (fSocket.GetError() != NET_NO_DATA))
 193             {
 194                 jack_error ( "Problem with network." );
 195                 return false;
 196             }
 197
 198             SessionParamsNToH(&net_params, &host_params);
 199         }
 200         while ( ( GetPacketType ( &host_params ) != START_MASTER ) && ( ++attempt < SLAVE_SETUP_RETRY ) );
 201         if ( attempt == SLAVE_SETUP_RETRY ) {
 202             jack_error ( "Slave doesn't respond, exiting." );
 203             return false;
 204         }
 205
 206         return true;
 207     }
 208
 209     int JackNetMasterInterface::SetRxTimeout()
 210     {
 211         jack_log ( "JackNetMasterInterface::SetRxTimeout" );
 212
 213         float time = 0;
 214
 215         //slow or normal mode, short timeout on recv (2 audio subcycles)
 216         if ((fParams.fNetworkMode == 's') || (fParams.fNetworkMode == 'n')) {
 217             time = 2000000.f * ((fNetAudioCaptureBuffer)
 218                                 ? fNetAudioCaptureBuffer->GetCycleDuration()
 219                                 : (fNetAudioPlaybackBuffer) ? fNetAudioPlaybackBuffer->GetCycleDuration() : 0);
 220         }
 221         //fast mode, wait for 75% of the entire cycle duration
 222         else if (fParams.fNetworkMode == 'f') {
 223             time = 750000.f * (static_cast<float>(fParams.fPeriodSize) / static_cast<float>(fParams.fSampleRate));
 224         }
 225
 226         return fSocket.SetTimeOut (static_cast<int>(time));
 227     }
 228
 229     bool JackNetMasterInterface::SetParams()
 230     {
 231         jack_log("JackNetMasterInterface::SetParams");
 232
 233         JackNetInterface::SetParams();
 234
 235         fTxHeader.fDataStream = 's';
 236         fRxHeader.fDataStream = 'r';
 237
 238         //midi net buffers
 239         if (fParams.fSendMidiChannels)
 240             fNetMidiCaptureBuffer = new NetMidiBuffer(&fParams, fParams.fSendMidiChannels, fTxData);
 241
 242         if (fParams.fReturnMidiChannels)
 243             fNetMidiPlaybackBuffer = new NetMidiBuffer(&fParams, fParams.fReturnMidiChannels, fRxData);
 244
 245         try {
 246
 247             //audio net buffers
 248             if (fParams.fSendAudioChannels) {
 249
 250                 switch (fParams.fSampleEncoder) {
 251
 252                     case JackFloatEncoder:
 253                         fNetAudioCaptureBuffer = new NetFloatAudioBuffer(&fParams, fParams.fSendAudioChannels, fTxData);
 254                         break;
 255
 256                     case JackIntEncoder:
 257                         fNetAudioCaptureBuffer = new NetIntAudioBuffer(&fParams, fParams.fSendAudioChannels, fTxData);
 258                         break;
 259
 260                     case JackCeltEncoder:
 261                     #if HAVE_CELT
 262                         fNetAudioCaptureBuffer = new NetCeltAudioBuffer(&fParams, fParams.fSendAudioChannels, fTxData, fParams.fKBps);
 263                     #endif
 264                         break;
 265                 }
 266
 267                 assert(fNetAudioCaptureBuffer);
 268             }
 269
 270             if (fParams.fReturnAudioChannels) {
 271
 272                 switch (fParams.fSampleEncoder) {
 273
 274                     case JackFloatEncoder:
 275                         fNetAudioPlaybackBuffer = new NetFloatAudioBuffer(&fParams, fParams.fReturnAudioChannels, fRxData);
 276                         break;
 277
 278                     case JackIntEncoder:
 279                         fNetAudioPlaybackBuffer = new NetIntAudioBuffer(&fParams, fParams.fReturnAudioChannels, fRxData);
 280                         break;
 281
 282                     case JackCeltEncoder:
 283                     #if HAVE_CELT
 284                         fNetAudioPlaybackBuffer = new NetCeltAudioBuffer(&fParams, fParams.fReturnAudioChannels, fRxData, fParams.fKBps);
 285                     #endif
 286                         break;
 287                 }
 288
 289                 assert(fNetAudioPlaybackBuffer);
 290             }
 291
 292         } catch (exception&) {
 293             jack_error("NetAudioBuffer allocation error...");
 294             return false;
 295         }
 296
 297         //set the new timeout for the socket
 298         if (SetRxTimeout() == SOCKET_ERROR) {
 299             jack_error("Can't set rx timeout : %s", StrError(NET_ERROR_CODE));
 300             goto error;
 301         }
 302
 303         //set the new rx buffer size
 304         if (SetNetBufferSize() == SOCKET_ERROR) {
 305             jack_error("Can't set net buffer sizes : %s", StrError(NET_ERROR_CODE));
 306             goto error;
 307         }
 308
 309         return true;
 310
 311     error:
 312         FreeNetworkBuffers();
 313         return false;
 314     }
 315
 316     void JackNetMasterInterface::Exit()
 317     {
 318         jack_log ( "JackNetMasterInterface::Exit, ID %u", fParams.fID );
 319
 320         //stop process
 321         fRunning = false;
 322
 323         //send a 'multicast euthanasia request' - new socket is required on macosx
 324         jack_info ( "Exiting '%s'", fParams.fName );
 325         SetPacketType ( &fParams, KILL_MASTER );
 326         JackNetSocket mcast_socket ( fMulticastIP, fSocket.GetPort() );
 327
 328         session_params_t net_params;
 329         memset(&net_params, 0, sizeof ( session_params_t ));
 330         SessionParamsHToN(&fParams, &net_params);
 331
 332         if ( mcast_socket.NewSocket() == SOCKET_ERROR )
 333             jack_error ( "Can't create socket : %s", StrError ( NET_ERROR_CODE ) );
 334         if ( mcast_socket.SendTo ( &net_params, sizeof ( session_params_t ), 0, fMulticastIP ) == SOCKET_ERROR )
 335             jack_error ( "Can't send suicide request : %s", StrError ( NET_ERROR_CODE ) );
 336
 337         mcast_socket.Close();
 338     }
 339
 340     int JackNetMasterInterface::Recv(size_t size, int flags)
 341     {
 342         int rx_bytes;
 343
 344         if ((( rx_bytes = fSocket.Recv(fRxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
 345             net_error_t error = fSocket.GetError();
 346             //no data isn't really a network error, so just return 0 available read bytes
 347             if (error == NET_NO_DATA) {
 348                 return 0;
 349             } else if (error == NET_CONN_ERROR) {
 350                 //fatal connection issue, exit
 351                 jack_error ( "'%s' : %s, exiting.", fParams.fName, StrError(NET_ERROR_CODE));
 352                 //ask to the manager to properly remove the master
 353                 Exit();
 354
 355                 // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
 356                 ThreadExit();
 357             } else {
 358                 jack_error ( "Error in master receive : %s", StrError(NET_ERROR_CODE));
 359             }
 360         }
 361
 362         packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
 363         PacketHeaderNToH(header, header);
 364         return rx_bytes;
 365     }
 366
 367     int JackNetMasterInterface::Send(size_t size, int flags)
 368     {
 369         int tx_bytes;
 370         packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
 371         PacketHeaderHToN(header, header);
 372
 373         if (((tx_bytes = fSocket.Send(fTxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
 374             net_error_t error = fSocket.GetError();
 375             if (error == NET_CONN_ERROR) {
 376                 //fatal connection issue, exit
 377                 jack_error ("'%s' : %s, exiting.", fParams.fName, StrError (NET_ERROR_CODE));
 378                 Exit();
 379
 380                 // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
 381                 ThreadExit();
 382             } else {
 383                 jack_error("Error in master send : %s", StrError(NET_ERROR_CODE));
 384             }
 385         }
 386         return tx_bytes;
 387     }
 388
 389     bool JackNetMasterInterface::IsSynched()
 390     {
 391         if (fParams.fNetworkMode == 's') {
 392             return (fCycleOffset < (CYCLE_OFFSET_SLOW + 1));
 393         } else {
 394             return true;
 395         }
 396     }
 397
 398     int JackNetMasterInterface::SyncSend()
 399     {
 400         fTxHeader.fCycle++;
 401         fTxHeader.fSubCycle = 0;
 402         fTxHeader.fDataType = 's';
 403         fTxHeader.fIsLastPckt = (fParams.fSendMidiChannels == 0 && fParams.fSendAudioChannels == 0) ?  1 : 0;
 404         fTxHeader.fPacketSize = HEADER_SIZE;
 405
 406         memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
 407         return Send(fTxHeader.fPacketSize, 0);
 408     }
 409
 410     int JackNetMasterInterface::DataSend()
 411     {
 412         uint subproc;
 413         uint data_size;
 414
 415         //midi
 416         if (fParams.fSendMidiChannels > 0)
 417         {
 418             //set global header fields and get the number of midi packets
 419             fTxHeader.fDataType = 'm';
 420             data_size = fNetMidiCaptureBuffer->RenderFromJackPorts();
 421             fTxHeader.fNumPacket = fNetMidiCaptureBuffer->GetNumPackets();
 422
 423             for ( subproc = 0; subproc < fTxHeader.fNumPacket; subproc++ )
 424             {
 425                 fTxHeader.fSubCycle = subproc;
 426                 fTxHeader.fIsLastPckt = ((subproc == (fTxHeader.fNumPacket - 1)) && (fParams.fSendAudioChannels == 0)) ? 1 : 0;
 427                 fTxHeader.fPacketSize = HEADER_SIZE + fNetMidiCaptureBuffer->RenderToNetwork(subproc, data_size);
 428                 memcpy ( fTxBuffer, &fTxHeader, HEADER_SIZE);
 429                 if (Send (fTxHeader.fPacketSize, 0) == SOCKET_ERROR)
 430                     return SOCKET_ERROR;
 431             }
 432         }
 433
 434         //audio
 435         if (fParams.fSendAudioChannels > 0)
 436         {
 437             fTxHeader.fDataType = 'a';
 438             data_size = fNetAudioCaptureBuffer->RenderFromJackPorts();
 439             fTxHeader.fNumPacket = fNetAudioCaptureBuffer->GetNumPackets();
 440
 441             for (subproc = 0; subproc < fTxHeader.fNumPacket; subproc++)
 442             {
 443                 fTxHeader.fSubCycle = subproc;
 444                 fTxHeader.fIsLastPckt = (subproc == (fTxHeader.fNumPacket - 1)) ? 1 : 0;
 445                 fTxHeader.fPacketSize = HEADER_SIZE + fNetAudioCaptureBuffer->RenderToNetwork(subproc, data_size);
 446                 memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
 447                 if (Send(fTxHeader.fPacketSize, 0) == SOCKET_ERROR)
 448                     return SOCKET_ERROR;
 449             }
 450         }
 451
 452         return 0;
 453     }
 454
 455     int JackNetMasterInterface::SyncRecv()
 456     {
 457         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 458         int rx_bytes = Recv(HEADER_SIZE, MSG_PEEK);
 459
 460         if ( ( rx_bytes == 0 ) || ( rx_bytes == SOCKET_ERROR ) )
 461             return rx_bytes;
 462
 463         fCycleOffset = fTxHeader.fCycle - rx_head->fCycle;
 464
 465         switch ( fParams.fNetworkMode )
 466         {
 467             case 's' :
 468                 //slow mode : allow to use full bandwidth and heavy process on the slave
 469                 //  - extra latency is set to two cycles, one cycle for send/receive operations + one cycle for heavy process on the slave
 470                 //  - if the network is two fast, just wait the next cycle, this mode allows a shorter cycle duration for the master
 471                 //  - this mode will skip the two first cycles, thus it lets time for data to be processed and queued on the socket rx buffer
 472                 //the slow mode is the safest mode because it wait twice the bandwidth relative time (send/return + process)
 473
 474                 /*
 475                  if (fCycleOffset < CYCLE_OFFSET_SLOW) {
 476                  return 0;
 477                  } else {
 478                  rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 479                  }
 480                  */
 481
 482                 rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 483
 484                 if (fCycleOffset != fLastfCycleOffset)
 485                     jack_info("Warning : '%s' runs in slow network mode, but data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
 486                 fLastfCycleOffset = fCycleOffset;
 487                 break;
 488
 489             case 'n' :
 490                 //normal use of the network :
 491                 //  - extra latency is set to one cycle, what is the time needed to receive streams using full network bandwidth
 492                 //  - if the network is too fast, just wait the next cycle, the benefit here is the master's cycle is shorter
 493                 //  - indeed, data is supposed to be on the network rx buffer, so we don't have to wait for it
 494                 if (fCycleOffset < CYCLE_OFFSET_NORMAL) {
 495                     return 0;
 496                 } else {
 497                     rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 498                 }
 499
 500                 if (fCycleOffset > CYCLE_OFFSET_NORMAL)  {
 501                     jack_info("'%s' can't run in normal network mode, data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
 502                 }
 503                 break;
 504
 505             case 'f' :
 506                 //fast mode suppose the network bandwith is larger than required for the transmission (only a few channels for example)
 507                 //    - packets can be quickly received, quickly is here relative to the cycle duration
 508                 //    - here, receive data, we can't keep it queued on the rx buffer,
 509                 //    - but if there is a cycle offset, tell the user, that means we're not in fast mode anymore, network is too slow
 510                 rx_bytes = Recv ( rx_head->fPacketSize, 0 );
 511
 512                 if (fCycleOffset > CYCLE_OFFSET_FAST) {
 513                     jack_info("'%s' can't run in fast network mode, data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
 514                 }
 515                 break;
 516                 break;
 517         }
 518
 519         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 520         return rx_bytes;
 521     }
 522
 523     int JackNetMasterInterface::DataRecv()
 524     {
 525         int rx_bytes = 0;
 526         uint recvd_midi_pckt = 0;
 527         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 528
 529         while ( !fRxHeader.fIsLastPckt )
 530         {
 531             //how much data is queued on the rx buffer ?
 532             rx_bytes = Recv(HEADER_SIZE, MSG_PEEK);
 533
 534             //error here, problem with recv, just skip the cycle (return -1)
 535             if ( rx_bytes == SOCKET_ERROR )
 536                 return rx_bytes;
 537
 538             if ( rx_bytes && ( rx_head->fDataStream == 'r' ) && ( rx_head->fID == fParams.fID ) )
 539             {
 540                 //read data
 541                 switch ( rx_head->fDataType )
 542                 {
 543                     case 'm':   //midi
 544                         rx_bytes = Recv(rx_head->fPacketSize, 0);
 545                         fRxHeader.fCycle = rx_head->fCycle;
 546                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 547                         fNetMidiPlaybackBuffer->RenderFromNetwork(rx_head->fSubCycle, rx_bytes - HEADER_SIZE);
 548                         // Last midi packet is received, so finish rendering...
 549                         if (++recvd_midi_pckt == rx_head->fNumPacket)
 550                             fNetMidiPlaybackBuffer->RenderToJackPorts();
 551                         break;
 552
 553                     case 'a':   //audio
 554                         rx_bytes = Recv(rx_head->fPacketSize, 0);
 555                         fRxHeader.fCycle = rx_head->fCycle;
 556                         fRxHeader.fSubCycle = rx_head->fSubCycle;
 557                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 558                         fNetAudioPlaybackBuffer->RenderFromNetwork(rx_head->fCycle, rx_head->fSubCycle, rx_bytes - HEADER_SIZE);
 559                         // Last audio packet is received, so finish rendering...
 560                         if (fRxHeader.fIsLastPckt)
 561                             fNetAudioPlaybackBuffer->RenderToJackPorts();
 562                         break;
 563
 564                     case 's':   //sync
 565                         jack_info("NetMaster : overloaded, skipping receive from '%s'", fParams.fName);
 566                         // TODO : finish midi and audio rendering ?
 567                         fNetAudioPlaybackBuffer->RenderToJackPorts();
 568                         return 0;
 569                 }
 570             }
 571         }
 572
 573         return rx_bytes;
 574     }
 575
 576     void JackNetMasterInterface::EncodeSyncPacket()
 577     {
 578         //this method contains every step of sync packet informations coding
 579         //first of all, reset sync packet
 580         memset ( fTxData, 0, PACKET_AVAILABLE_SIZE );
 581
 582         //then, first step : transport
 583         if (fParams.fTransportSync) {
 584             EncodeTransportData();
 585             TransportDataHToN( &fSendTransportData,  &fSendTransportData);
 586             //copy to TxBuffer
 587             memcpy ( fTxData, &fSendTransportData, sizeof ( net_transport_data_t ) );
 588         }
 589         //then others (freewheel etc.)
 590         //...
 591     }
 592
 593     void JackNetMasterInterface::DecodeSyncPacket()
 594     {
 595         //this method contains every step of sync packet informations decoding process
 596         //first : transport
 597         if (fParams.fTransportSync) {
 598             //copy received transport data to transport data structure
 599             memcpy ( &fReturnTransportData, fRxData, sizeof ( net_transport_data_t ) );
 600             TransportDataNToH( &fReturnTransportData,  &fReturnTransportData);
 601             DecodeTransportData();
 602         }
 603         //then others
 604         //...
 605     }
 606
 607 // JackNetSlaveInterface ************************************************************************************************
 608
 609     uint JackNetSlaveInterface::fSlaveCounter = 0;
 610
 611     bool JackNetSlaveInterface::Init()
 612     {
 613         jack_log ( "JackNetSlaveInterface::Init()" );
 614
 615         //set the parameters to send
 616         strcpy ( fParams.fPacketType, "params" );
 617         fParams.fProtocolVersion = SLAVE_PROTOCOL;
 618         SetPacketType ( &fParams, SLAVE_AVAILABLE );
 619
 620         //init loop : get a master and start, do it until connection is ok
 621         net_status_t status;
 622         do
 623         {
 624             //first, get a master, do it until a valid connection is running
 625             do
 626             {
 627                 status = SendAvailableToMaster();
 628                 if ( status == NET_SOCKET_ERROR )
 629                     return false;
 630             }
 631             while ( status != NET_CONNECTED );
 632
 633             //then tell the master we are ready
 634             jack_info ( "Initializing connection with %s...", fParams.fMasterNetName );
 635             status = SendStartToMaster();
 636             if ( status == NET_ERROR )
 637                 return false;
 638         }
 639         while ( status != NET_ROLLING );
 640
 641         return true;
 642     }
 643
 644     // Separate the connection protocol into two separated step
 645     bool JackNetSlaveInterface::InitConnection(int time_out)
 646     {
 647         jack_log("JackNetSlaveInterface::InitConnection()");
 648         int try_count = (time_out > 0) ? ((1000000 * time_out) / SLAVE_INIT_TIMEOUT) : LONG_MAX;
 649
 650         //set the parameters to send
 651         strcpy (fParams.fPacketType, "params");
 652         fParams.fProtocolVersion = SLAVE_PROTOCOL;
 653         SetPacketType (&fParams, SLAVE_AVAILABLE);
 654
 655         net_status_t status;
 656         do
 657         {
 658             //get a master
 659             status = SendAvailableToMaster(try_count);
 660             if (status == NET_SOCKET_ERROR)
 661                 return false;
 662         }
 663         while (status != NET_CONNECTED && --try_count > 0);
 664
 665         return (try_count != 0);
 666     }
 667
 668     bool JackNetSlaveInterface::InitRendering()
 669     {
 670         jack_log("JackNetSlaveInterface::InitRendering()");
 671
 672         net_status_t status;
 673         do
 674         {
 675             //then tell the master we are ready
 676             jack_info("Initializing connection with %s...", fParams.fMasterNetName);
 677             status = SendStartToMaster();
 678             if (status == NET_ERROR)
 679                 return false;
 680         }
 681         while (status != NET_ROLLING);
 682
 683         return true;
 684     }
 685
 686     net_status_t JackNetSlaveInterface::SendAvailableToMaster(long try_count)
 687     {
 688         jack_log ( "JackNetSlaveInterface::SendAvailableToMaster()" );
 689         //utility
 690         session_params_t host_params;
 691         int rx_bytes = 0;
 692
 693         //socket
 694         if ( fSocket.NewSocket() == SOCKET_ERROR ) {
 695             jack_error ( "Fatal error : network unreachable - %s", StrError ( NET_ERROR_CODE ) );
 696             return NET_SOCKET_ERROR;
 697         }
 698
 699         //bind the socket
 700         if ( fSocket.Bind() == SOCKET_ERROR ) {
 701             jack_error ( "Can't bind the socket : %s", StrError ( NET_ERROR_CODE ) );
 702             return NET_SOCKET_ERROR;
 703         }
 704
 705         //timeout on receive
 706         if ( fSocket.SetTimeOut ( SLAVE_INIT_TIMEOUT ) == SOCKET_ERROR )
 707             jack_error ( "Can't set timeout : %s", StrError ( NET_ERROR_CODE ) );
 708
 709         //disable local loop
 710         if ( fSocket.SetLocalLoop() == SOCKET_ERROR )
 711             jack_error ( "Can't disable multicast loop : %s", StrError ( NET_ERROR_CODE ) );
 712
 713         //send 'AVAILABLE' until 'SLAVE_SETUP' received
 714         jack_info ( "Waiting for a master..." );
 715         do
 716         {
 717             //send 'available'
 718             session_params_t net_params;
 719             memset(&net_params, 0, sizeof ( session_params_t ));
 720             SessionParamsHToN(&fParams, &net_params);
 721             if ( fSocket.SendTo ( &net_params, sizeof ( session_params_t ), 0, fMulticastIP ) == SOCKET_ERROR )
 722                 jack_error ( "Error in data send : %s", StrError ( NET_ERROR_CODE ) );
 723
 724             //filter incoming packets : don't exit while no error is detected
 725             memset(&net_params, 0, sizeof ( session_params_t ));
 726             rx_bytes = fSocket.CatchHost ( &net_params, sizeof ( session_params_t ), 0 );
 727             SessionParamsNToH(&net_params, &host_params);
 728             if ( ( rx_bytes == SOCKET_ERROR ) && ( fSocket.GetError() != NET_NO_DATA ) )
 729             {
 730                 jack_error ( "Can't receive : %s", StrError ( NET_ERROR_CODE ) );
 731                 return NET_RECV_ERROR;
 732             }
 733         }
 734         while (strcmp(host_params.fPacketType, fParams.fPacketType)  && (GetPacketType(&host_params) != SLAVE_SETUP)  && (--try_count > 0));
 735
 736         // Time out failure..
 737         if (try_count == 0) {
 738             jack_error("Time out error in connect");
 739             return NET_CONNECT_ERROR;
 740         }
 741
 742         //everything is OK, copy parameters
 743         SessionParamsDisplay(&host_params);
 744         fParams = host_params;
 745
 746         //connect the socket
 747         if (fSocket.Connect() == SOCKET_ERROR) {
 748             jack_error("Error in connect : %s", StrError(NET_ERROR_CODE));
 749             return NET_CONNECT_ERROR;
 750         }
 751         return NET_CONNECTED;
 752     }
 753
 754     net_status_t JackNetSlaveInterface::SendStartToMaster()
 755     {
 756         jack_log("JackNetSlaveInterface::SendStartToMaster");
 757
 758         //tell the master to start
 759         session_params_t net_params;
 760         memset(&net_params, 0, sizeof ( session_params_t ));
 761         SetPacketType ( &fParams, START_MASTER );
 762         SessionParamsHToN(&fParams, &net_params);
 763         if (fSocket.Send(&net_params, sizeof(session_params_t), 0) == SOCKET_ERROR)
 764         {
 765             jack_error("Error in send : %s", StrError(NET_ERROR_CODE));
 766             return (fSocket.GetError() == NET_CONN_ERROR) ? NET_ERROR : NET_SEND_ERROR;
 767         }
 768         return NET_ROLLING;
 769     }
 770
 771     bool JackNetSlaveInterface::SetParams()
 772     {
 773         jack_log("JackNetSlaveInterface::SetParams");
 774
 775         JackNetInterface::SetParams();
 776
 777         fTxHeader.fDataStream = 'r';
 778         fRxHeader.fDataStream = 's';
 779
 780        //midi net buffers
 781         if (fParams.fSendMidiChannels)
 782             fNetMidiCaptureBuffer = new NetMidiBuffer(&fParams, fParams.fSendMidiChannels, fTxData);
 783
 784         if (fParams.fReturnMidiChannels)
 785             fNetMidiPlaybackBuffer = new NetMidiBuffer(&fParams, fParams.fReturnMidiChannels, fRxData);
 786
 787         try {
 788
 789             //audio net buffers
 790             if (fParams.fSendAudioChannels) {
 791
 792                 switch (fParams.fSampleEncoder) {
 793
 794                     case JackFloatEncoder:
 795                         fNetAudioCaptureBuffer = new NetFloatAudioBuffer(&fParams, fParams.fSendAudioChannels, fRxData);
 796                         break;
 797
 798                     case JackIntEncoder:
 799                         fNetAudioCaptureBuffer = new NetIntAudioBuffer(&fParams, fParams.fSendAudioChannels, fRxData);
 800                         break;
 801
 802                     case JackCeltEncoder:
 803                     #if HAVE_CELT
 804                         fNetAudioCaptureBuffer = new NetCeltAudioBuffer(&fParams, fParams.fSendAudioChannels, fRxData, fParams.fKBps);
 805                     #endif
 806                         break;
 807                 }
 808
 809                 assert(fNetAudioCaptureBuffer);
 810             }
 811
 812             if (fParams.fReturnAudioChannels) {
 813
 814                 switch (fParams.fSampleEncoder) {
 815
 816                     case JackFloatEncoder:
 817                         fNetAudioPlaybackBuffer = new NetFloatAudioBuffer(&fParams, fParams.fReturnAudioChannels, fTxData);
 818                         break;
 819
 820                     case JackIntEncoder:
 821                         fNetAudioPlaybackBuffer = new NetIntAudioBuffer(&fParams, fParams.fReturnAudioChannels, fTxData);
 822                         break;
 823
 824                     case JackCeltEncoder:
 825                     #if HAVE_CELT
 826                         fNetAudioPlaybackBuffer = new NetCeltAudioBuffer(&fParams, fParams.fReturnAudioChannels, fTxData, fParams.fKBps);
 827                     #endif
 828                         break;
 829                 }
 830
 831                 assert(fNetAudioPlaybackBuffer);
 832             }
 833
 834         } catch (exception&) {
 835             jack_error("NetAudioBuffer allocation error...");
 836             return false;
 837         }
 838
 839         //set the new buffer sizes
 840         if (SetNetBufferSize() == SOCKET_ERROR) {
 841             jack_error ( "Can't set net buffer sizes : %s", StrError ( NET_ERROR_CODE ) );
 842             goto error;
 843         }
 844
 845         return true;
 846
 847     error:
 848         FreeNetworkBuffers();
 849         return false;
 850     }
 851
 852     int JackNetSlaveInterface::Recv(size_t size, int flags)
 853     {
 854         int rx_bytes = fSocket.Recv(fRxBuffer, size, flags);
 855         //handle errors
 856         if ( rx_bytes == SOCKET_ERROR )
 857         {
 858             net_error_t error = fSocket.GetError();
 859             //no data isn't really an error in realtime processing, so just return 0
 860             if ( error == NET_NO_DATA ) {
 861                 jack_error ( "No data, is the master still running ?" );
 862             //if a network error occurs, this exception will restart the driver
 863             } else if ( error == NET_CONN_ERROR ) {
 864                 jack_error ( "Connection lost." );
 865                 throw JackNetException();
 866             } else {
 867                 jack_error ( "Fatal error in slave receive : %s", StrError ( NET_ERROR_CODE ) );
 868             }
 869         }
 870
 871         packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
 872         PacketHeaderNToH(header, header);
 873         return rx_bytes;
 874     }
 875
 876     int JackNetSlaveInterface::Send(size_t size, int flags)
 877     {
 878         packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
 879         PacketHeaderHToN(header, header);
 880         int tx_bytes = fSocket.Send ( fTxBuffer, size, flags );
 881
 882         //handle errors
 883         if ( tx_bytes == SOCKET_ERROR )
 884         {
 885             net_error_t error = fSocket.GetError();
 886             //if a network error occurs, this exception will restart the driver
 887             if ( error == NET_CONN_ERROR ) {
 888                 jack_error ( "Connection lost." );
 889                 throw JackNetException();
 890             } else {
 891                 jack_error ( "Fatal error in slave send : %s", StrError ( NET_ERROR_CODE ) );
 892             }
 893         }
 894         return tx_bytes;
 895     }
 896
 897     int JackNetSlaveInterface::SyncRecv()
 898     {
 899         int rx_bytes = 0;
 900         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 901
 902         //receive sync (launch the cycle)
 903         do
 904         {
 905             rx_bytes = Recv(HEADER_SIZE, 0);
 906             //connection issue, send will detect it, so don't skip the cycle (return 0)
 907             if ( rx_bytes == SOCKET_ERROR )
 908                 return rx_bytes;
 909         }
 910         while ((strcmp(rx_head->fPacketType, "header") != 0) && (rx_head->fDataType != 's'));
 911
 912         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 913         return rx_bytes;
 914     }
 915
 916     int JackNetSlaveInterface::DataRecv()
 917     {
 918         int rx_bytes = 0;
 919         uint recvd_midi_pckt = 0;
 920         packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
 921
 922         while ( !fRxHeader.fIsLastPckt )
 923         {
 924             //how much data is queued on the rx buffer ?
 925             rx_bytes = Recv(HEADER_SIZE, MSG_PEEK);
 926
 927             //error here, problem with recv, just skip the cycle (return -1)
 928             if ( rx_bytes == SOCKET_ERROR )
 929                 return rx_bytes;
 930
 931             if ( rx_bytes && ( rx_head->fDataStream == 's' ) && ( rx_head->fID == fParams.fID ) )
 932             {
 933                 switch ( rx_head->fDataType )
 934                 {
 935                     case 'm':   //midi
 936                         rx_bytes = Recv(rx_head->fPacketSize, 0);
 937                         fRxHeader.fCycle = rx_head->fCycle;
 938                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 939                         fNetMidiCaptureBuffer->RenderFromNetwork(rx_head->fSubCycle, rx_bytes - HEADER_SIZE);
 940                         // Last midi packet is received, so finish rendering...
 941                         if (++recvd_midi_pckt == rx_head->fNumPacket)
 942                             fNetMidiCaptureBuffer->RenderToJackPorts();
 943                         break;
 944
 945                     case 'a':   //audio
 946                         rx_bytes = Recv(rx_head->fPacketSize, 0);
 947                         fRxHeader.fCycle = rx_head->fCycle;
 948                         fRxHeader.fSubCycle = rx_head->fSubCycle;
 949                         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 950                         fNetAudioCaptureBuffer->RenderFromNetwork (rx_head->fCycle, rx_head->fSubCycle, rx_bytes - HEADER_SIZE);
 951                         // Last audio packet is received, so finish rendering...
 952                         if (fRxHeader.fIsLastPckt)
 953                             fNetAudioCaptureBuffer->RenderToJackPorts();
 954                         break;
 955
 956                     case 's':   //sync
 957                         jack_info ( "NetSlave : overloaded, skipping receive." );
 958                         // TODO : finish midi and audio rendering ?
 959                         fNetAudioCaptureBuffer->RenderToJackPorts();
 960                         return 0;
 961                 }
 962             }
 963         }
 964
 965         fRxHeader.fCycle = rx_head->fCycle;
 966         return 0;
 967     }
 968
 969     int JackNetSlaveInterface::SyncSend()
 970     {
 971         //tx header
 972         if ( fParams.fSlaveSyncMode ) {
 973             fTxHeader.fCycle = fRxHeader.fCycle;
 974         } else {
 975             fTxHeader.fCycle++;
 976         }
 977         fTxHeader.fSubCycle = 0;
 978         fTxHeader.fDataType = 's';
 979         fTxHeader.fIsLastPckt = (fParams.fReturnMidiChannels == 0 && fParams.fReturnAudioChannels == 0) ?  1 : 0;
 980         fTxHeader.fPacketSize = HEADER_SIZE;
 981
 982         memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
 983         return Send (fTxHeader.fPacketSize, 0);
 984     }
 985
 986     int JackNetSlaveInterface::DataSend()
 987     {
 988         uint subproc;
 989         uint data_size;
 990
 991         //midi
 992         if (fParams.fReturnMidiChannels > 0)
 993         {
 994             //set global header fields and get the number of midi packets
 995             fTxHeader.fDataType = 'm';
 996             data_size = fNetMidiPlaybackBuffer->RenderFromJackPorts();
 997             fTxHeader.fNumPacket = fNetMidiPlaybackBuffer->GetNumPackets();
 998             for ( subproc = 0; subproc < fTxHeader.fNumPacket; subproc++ )
 999             {
1000                 fTxHeader.fSubCycle = subproc;
1001                 fTxHeader.fIsLastPckt = ((subproc == (fTxHeader.fNumPacket - 1)) && !fParams.fReturnAudioChannels) ? 1 : 0;
1002                 fTxHeader.fPacketSize = HEADER_SIZE + fNetMidiPlaybackBuffer->RenderToNetwork(subproc, data_size);
1003                 memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
1004                 if (Send(fTxHeader.fPacketSize, 0) == SOCKET_ERROR)
1005                     return SOCKET_ERROR;
1006             }
1007         }
1008
1009         //audio
1010         if ( fParams.fReturnAudioChannels > 0)
1011         {
1012             fTxHeader.fDataType = 'a';
1013             data_size = fNetAudioPlaybackBuffer->RenderFromJackPorts();
1014             fTxHeader.fNumPacket = fNetAudioPlaybackBuffer->GetNumPackets();
1015             for ( subproc = 0; subproc < fTxHeader.fNumPacket; subproc++ )
1016             {
1017                 fTxHeader.fSubCycle = subproc;
1018                 fTxHeader.fIsLastPckt = (subproc == (fTxHeader.fNumPacket - 1)) ? 1 : 0;
1019                 fTxHeader.fPacketSize = HEADER_SIZE + fNetAudioPlaybackBuffer->RenderToNetwork(subproc, data_size);
1020                 memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
1021                 if (Send(fTxHeader.fPacketSize, 0) == SOCKET_ERROR)
1022                     return SOCKET_ERROR;
1023             }
1024         }
1025         return 0;
1026     }
1027
1028     //network sync------------------------------------------------------------------------
1029     void JackNetSlaveInterface::EncodeSyncPacket()
1030     {
1031         //this method contains every step of sync packet informations coding
1032         //first of all, reset sync packet
1033         memset ( fTxData, 0, PACKET_AVAILABLE_SIZE );
1034         //then first step : transport
1035         if (fParams.fTransportSync) {
1036             EncodeTransportData();
1037             TransportDataHToN( &fReturnTransportData,  &fReturnTransportData);
1038             //copy to TxBuffer
1039             memcpy ( fTxData, &fReturnTransportData, sizeof ( net_transport_data_t ) );
1040         }
1041         //then others
1042         //...
1043     }
1044
1045     void JackNetSlaveInterface::DecodeSyncPacket()
1046     {
1047         //this method contains every step of sync packet informations decoding process
1048         //first : transport
1049         if (fParams.fTransportSync) {
1050             //copy received transport data to transport data structure
1051             memcpy ( &fSendTransportData, fRxData, sizeof ( net_transport_data_t ) );
1052             TransportDataNToH( &fSendTransportData,  &fSendTransportData);
1053             DecodeTransportData();
1054         }
1055         //then others
1056         //...
1057     }
1058
1059 }