common/JackNetInterface.cpp

   1 /*
   2 Copyright (C) 2008-2011 Romain Moret at Grame
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation; either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include "JackNetInterface.h"
  20 #include "JackException.h"
  21 #include "JackError.h"
  22
  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         Initialize();
  40     }
  41
  42     JackNetInterface::JackNetInterface(const char* multicast_ip, int port) : fSocket(multicast_ip, port)
  43     {
  44         strcpy(fMulticastIP, multicast_ip);
  45         Initialize();
  46     }
  47
  48     JackNetInterface::JackNetInterface(session_params_t& params, JackNetSocket& socket, const char* multicast_ip) : fSocket(socket)
  49     {
  50         fParams = params;
  51         strcpy(fMulticastIP, multicast_ip);
  52         Initialize();
  53     }
  54
  55     void JackNetInterface::Initialize()
  56     {
  57         fSetTimeOut = false;
  58         fTxBuffer = NULL;
  59         fRxBuffer = NULL;
  60         fNetAudioCaptureBuffer = NULL;
  61         fNetAudioPlaybackBuffer = NULL;
  62         fNetMidiCaptureBuffer = NULL;
  63         fNetMidiPlaybackBuffer = NULL;
  64         memset(&fSendTransportData, 0, sizeof(net_transport_data_t));
  65         memset(&fReturnTransportData, 0, sizeof(net_transport_data_t));
  66     }
  67
  68     void JackNetInterface::FreeNetworkBuffers()
  69     {
  70         delete fNetMidiCaptureBuffer;
  71         delete fNetMidiPlaybackBuffer;
  72         delete fNetAudioCaptureBuffer;
  73         delete fNetAudioPlaybackBuffer;
  74         fNetMidiCaptureBuffer = NULL;
  75         fNetMidiPlaybackBuffer = NULL;
  76         fNetAudioCaptureBuffer = NULL;
  77         fNetAudioPlaybackBuffer = NULL;
  78     }
  79
  80     JackNetInterface::~JackNetInterface()
  81     {
  82         jack_log("JackNetInterface::~JackNetInterface");
  83
  84         fSocket.Close();
  85         delete[] fTxBuffer;
  86         delete[] fRxBuffer;
  87         delete fNetAudioCaptureBuffer;
  88         delete fNetAudioPlaybackBuffer;
  89         delete fNetMidiCaptureBuffer;
  90         delete fNetMidiPlaybackBuffer;
  91     }
  92
  93     int JackNetInterface::SetNetBufferSize()
  94     {
  95         // audio
  96         float audio_size = (fNetAudioCaptureBuffer)
  97                         ? fNetAudioCaptureBuffer->GetCycleSize()
  98                         : (fNetAudioPlaybackBuffer) ? fNetAudioPlaybackBuffer->GetCycleSize() : 0;
  99         jack_log("audio_size %f", audio_size);
 100
 101         // midi
 102         float midi_size = (fNetMidiCaptureBuffer)
 103                         ? fNetMidiCaptureBuffer->GetCycleSize()
 104                         : (fNetMidiPlaybackBuffer) ? fNetMidiPlaybackBuffer->GetCycleSize() : 0;
 105         jack_log("midi_size %f", midi_size);
 106
 107         // bufsize = sync + audio + midi
 108         int bufsize = NETWORK_MAX_LATENCY * (fParams.fMtu + (int)audio_size + (int)midi_size);
 109         jack_log("SetNetBufferSize bufsize = %d", bufsize);
 110
 111         // tx buffer
 112         if (fSocket.SetOption(SOL_SOCKET, SO_SNDBUF, &bufsize, sizeof(bufsize)) == SOCKET_ERROR) {
 113             return SOCKET_ERROR;
 114         }
 115
 116         // rx buffer
 117         if (fSocket.SetOption(SOL_SOCKET, SO_RCVBUF, &bufsize, sizeof(bufsize)) == SOCKET_ERROR) {
 118             return SOCKET_ERROR;
 119         }
 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     int JackNetInterface::MidiSend(NetMidiBuffer* buffer, int midi_channnels, int audio_channels)
 154     {
 155         if (midi_channnels > 0) {
 156             // set global header fields and get the number of midi packets
 157             fTxHeader.fDataType = 'm';
 158             uint data_size = buffer->RenderFromJackPorts();
 159             fTxHeader.fNumPacket = buffer->GetNumPackets(data_size, PACKET_AVAILABLE_SIZE(&fParams));
 160
 161             for (uint subproc = 0; subproc < fTxHeader.fNumPacket; subproc++) {
 162                 fTxHeader.fSubCycle = subproc;
 163                 fTxHeader.fIsLastPckt = ((subproc == (fTxHeader.fNumPacket - 1)) && audio_channels == 0) ? 1 : 0;
 164                 fTxHeader.fPacketSize = HEADER_SIZE + buffer->RenderToNetwork(subproc, data_size);
 165                 memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
 166                 if (Send(fTxHeader.fPacketSize, 0) == SOCKET_ERROR) {
 167                     return SOCKET_ERROR;
 168                 }
 169             }
 170         }
 171         return 0;
 172     }
 173
 174     int JackNetInterface::AudioSend(NetAudioBuffer* buffer, int audio_channels)
 175     {
 176         // audio
 177         if (audio_channels > 0) {
 178             fTxHeader.fDataType = 'a';
 179             fTxHeader.fActivePorts = buffer->RenderFromJackPorts();
 180             fTxHeader.fNumPacket = buffer->GetNumPackets(fTxHeader.fActivePorts);
 181
 182             for (uint subproc = 0; subproc < fTxHeader.fNumPacket; subproc++) {
 183                 fTxHeader.fSubCycle = subproc;
 184                 fTxHeader.fIsLastPckt = (subproc == (fTxHeader.fNumPacket - 1)) ? 1 : 0;
 185                 fTxHeader.fPacketSize = HEADER_SIZE + buffer->RenderToNetwork(subproc, fTxHeader.fActivePorts);
 186                 memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
 187                 // PacketHeaderDisplay(&fTxHeader);
 188                 if (Send(fTxHeader.fPacketSize, 0) == SOCKET_ERROR) {
 189                     return SOCKET_ERROR;
 190                 }
 191             }
 192         }
 193         return 0;
 194     }
 195
 196     int JackNetInterface::MidiRecv(packet_header_t* rx_head, NetMidiBuffer* buffer, uint& recvd_midi_pckt)
 197     {
 198         int rx_bytes = Recv(rx_head->fPacketSize, 0);
 199         fRxHeader.fCycle = rx_head->fCycle;
 200         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 201         buffer->RenderFromNetwork(rx_head->fSubCycle, rx_bytes - HEADER_SIZE);
 202
 203         // Last midi packet is received, so finish rendering...
 204         if (++recvd_midi_pckt == rx_head->fNumPacket) {
 205             buffer->RenderToJackPorts();
 206         }
 207         return rx_bytes;
 208     }
 209
 210     int JackNetInterface::AudioRecv(packet_header_t* rx_head, NetAudioBuffer* buffer)
 211     {
 212         int rx_bytes = Recv(rx_head->fPacketSize, 0);
 213         fRxHeader.fCycle = rx_head->fCycle;
 214         fRxHeader.fSubCycle = rx_head->fSubCycle;
 215         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 216         fRxHeader.fActivePorts = rx_head->fActivePorts;
 217         rx_bytes = buffer->RenderFromNetwork(rx_head->fCycle, rx_head->fSubCycle, fRxHeader.fActivePorts);
 218
 219         // Last audio packet is received, so finish rendering...
 220         if (fRxHeader.fIsLastPckt) {
 221             buffer->RenderToJackPorts();
 222         }
 223         return rx_bytes;
 224     }
 225
 226     int JackNetInterface::FinishRecv(NetAudioBuffer* buffer)
 227     {
 228         buffer->RenderToJackPorts();
 229         return NET_PACKET_ERROR;
 230     }
 231
 232     NetAudioBuffer* JackNetInterface::AudioBufferFactory(int nports, char* buffer)
 233     {
 234          switch (fParams.fSampleEncoder) {
 235
 236             case JackFloatEncoder:
 237                 return new NetFloatAudioBuffer(&fParams, nports, buffer);
 238
 239             case JackIntEncoder:
 240                 return new NetIntAudioBuffer(&fParams, nports, buffer);
 241
 242             #if HAVE_CELT
 243             case JackCeltEncoder:
 244                 return new NetCeltAudioBuffer(&fParams, nports, buffer, fParams.fKBps);
 245             #endif
 246         }
 247         return NULL;
 248     }
 249
 250     void JackNetInterface::SetRcvTimeOut()
 251     {
 252         if (!fSetTimeOut) {
 253             if (fSocket.SetTimeOut(PACKET_TIMEOUT) == SOCKET_ERROR) {
 254                 jack_error("Can't set rx timeout : %s", StrError(NET_ERROR_CODE));
 255                 return;
 256             }
 257             fSetTimeOut = true;
 258         }
 259     }
 260
 261     // JackNetMasterInterface ************************************************************************************
 262
 263     bool JackNetMasterInterface::Init()
 264     {
 265         jack_log("JackNetMasterInterface::Init : ID %u", fParams.fID);
 266
 267         session_params_t host_params;
 268         uint attempt = 0;
 269         int rx_bytes = 0;
 270
 271         // socket
 272         if (fSocket.NewSocket() == SOCKET_ERROR) {
 273             jack_error("Can't create socket : %s", StrError(NET_ERROR_CODE));
 274             return false;
 275         }
 276
 277         // timeout on receive (for init)
 278         if (fSocket.SetTimeOut(MASTER_INIT_TIMEOUT) < 0) {
 279             jack_error("Can't set init timeout : %s", StrError(NET_ERROR_CODE));
 280         }
 281
 282         // connect
 283         if (fSocket.Connect() == SOCKET_ERROR) {
 284             jack_error("Can't connect : %s", StrError(NET_ERROR_CODE));
 285             return false;
 286         }
 287
 288         // send 'SLAVE_SETUP' until 'START_MASTER' received
 289         jack_info("Sending parameters to %s...", fParams.fSlaveNetName);
 290         do
 291         {
 292             session_params_t net_params;
 293             memset(&net_params, 0, sizeof(session_params_t));
 294             SetPacketType(&fParams, SLAVE_SETUP);
 295             SessionParamsHToN(&fParams, &net_params);
 296
 297             if (fSocket.Send(&net_params, sizeof(session_params_t), 0) == SOCKET_ERROR) {
 298                 jack_error("Error in send : %s", StrError(NET_ERROR_CODE));
 299             }
 300
 301             memset(&net_params, 0, sizeof(session_params_t));
 302             if (((rx_bytes = fSocket.Recv(&net_params, sizeof(session_params_t), 0)) == SOCKET_ERROR) && (fSocket.GetError() != NET_NO_DATA)) {
 303                 jack_error("Problem with network");
 304                 return false;
 305             }
 306
 307             SessionParamsNToH(&net_params, &host_params);
 308         }
 309         while ((GetPacketType(&host_params) != START_MASTER) && (++attempt < SLAVE_SETUP_RETRY));
 310
 311         if (attempt == SLAVE_SETUP_RETRY) {
 312             jack_error("Slave doesn't respond, exiting");
 313             return false;
 314         }
 315
 316         return true;
 317     }
 318
 319     bool JackNetMasterInterface::SetParams()
 320     {
 321         jack_log("JackNetMasterInterface::SetParams audio in = %d audio out = %d MIDI in = %d MIDI out = %d",
 322             fParams.fSendAudioChannels, fParams.fReturnAudioChannels,
 323             fParams.fSendMidiChannels, fParams.fReturnMidiChannels);
 324
 325         JackNetInterface::SetParams();
 326
 327         fTxHeader.fDataStream = 's';
 328         fRxHeader.fDataStream = 'r';
 329
 330         fMaxCycleOffset = fParams.fNetworkLatency;
 331
 332         // midi net buffers
 333         if (fParams.fSendMidiChannels > 0) {
 334             fNetMidiCaptureBuffer = new NetMidiBuffer(&fParams, fParams.fSendMidiChannels, fTxData);
 335         }
 336
 337         if (fParams.fReturnMidiChannels > 0) {
 338             fNetMidiPlaybackBuffer = new NetMidiBuffer(&fParams, fParams.fReturnMidiChannels, fRxData);
 339         }
 340
 341         try {
 342
 343             // audio net buffers
 344             if (fParams.fSendAudioChannels > 0) {
 345                 fNetAudioCaptureBuffer = AudioBufferFactory(fParams.fSendAudioChannels, fTxData);
 346                 assert(fNetAudioCaptureBuffer);
 347             }
 348
 349             if (fParams.fReturnAudioChannels > 0) {
 350                 fNetAudioPlaybackBuffer = AudioBufferFactory(fParams.fReturnAudioChannels, fRxData);
 351                 assert(fNetAudioPlaybackBuffer);
 352             }
 353
 354         } catch (exception&) {
 355             jack_error("NetAudioBuffer allocation error...");
 356             return false;
 357         }
 358
 359         // set the new rx buffer size
 360         if (SetNetBufferSize() == SOCKET_ERROR) {
 361             jack_error("Can't set net buffer sizes : %s", StrError(NET_ERROR_CODE));
 362             goto error;
 363         }
 364
 365         return true;
 366
 367     error:
 368         FreeNetworkBuffers();
 369         return false;
 370     }
 371
 372     void JackNetMasterInterface::Exit()
 373     {
 374         jack_log("JackNetMasterInterface::Exit, ID %u", fParams.fID);
 375
 376         // stop process
 377         fRunning = false;
 378
 379         // send a 'multicast euthanasia request' - new socket is required on macosx
 380         jack_info("Exiting '%s'", fParams.fName);
 381         SetPacketType(&fParams, KILL_MASTER);
 382         JackNetSocket mcast_socket(fMulticastIP, fSocket.GetPort());
 383
 384         session_params_t net_params;
 385         memset(&net_params, 0, sizeof(session_params_t));
 386         SessionParamsHToN(&fParams, &net_params);
 387
 388         if (mcast_socket.NewSocket() == SOCKET_ERROR) {
 389             jack_error("Can't create socket : %s", StrError(NET_ERROR_CODE));
 390         }
 391         if (mcast_socket.SendTo(&net_params, sizeof(session_params_t), 0, fMulticastIP) == SOCKET_ERROR) {
 392             jack_error("Can't send suicide request : %s", StrError(NET_ERROR_CODE));
 393         }
 394
 395         mcast_socket.Close();
 396     }
 397
 398     void JackNetMasterInterface::FatalRecvError()
 399     {
 400         // fatal connection issue, exit
 401         jack_error("Recv connection lost error = %s, '%s' exiting", StrError(NET_ERROR_CODE), fParams.fName);
 402         // ask to the manager to properly remove the master
 403         Exit();
 404         // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
 405         ThreadExit();
 406     }
 407
 408      void JackNetMasterInterface::FatalSendError()
 409     {
 410         // fatal connection issue, exit
 411         jack_error("Send connection lost error = %s, '%s' exiting", StrError(NET_ERROR_CODE), fParams.fName);
 412         // ask to the manager to properly remove the master
 413         Exit();
 414         // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
 415         ThreadExit();
 416     }
 417
 418     int JackNetMasterInterface::Recv(size_t size, int flags)
 419     {
 420         int rx_bytes;
 421
 422         if (((rx_bytes = fSocket.Recv(fRxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
 423             FatalRecvError();
 424         }
 425
 426         packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
 427         PacketHeaderNToH(header, header);
 428         return rx_bytes;
 429     }
 430
 431     int JackNetMasterInterface::Send(size_t size, int flags)
 432     {
 433         int tx_bytes;
 434         packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
 435         PacketHeaderHToN(header, header);
 436
 437         if (((tx_bytes = fSocket.Send(fTxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
 438             FatalSendError();
 439         }
 440         return tx_bytes;
 441     }
 442
 443     bool JackNetMasterInterface::IsSynched()
 444     {
 445         return (fCurrentCycleOffset <= fMaxCycleOffset);
 446     }
 447
 448     int JackNetMasterInterface::SyncSend()
 449     {
 450         SetRcvTimeOut();
 451
 452         fTxHeader.fCycle++;
 453         fTxHeader.fSubCycle = 0;
 454         fTxHeader.fDataType = 's';
 455         fTxHeader.fIsLastPckt = (fParams.fSendMidiChannels == 0 && fParams.fSendAudioChannels == 0) ? 1 : 0;
 456         fTxHeader.fPacketSize = fParams.fMtu;
 457
 458         memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
 459         // PacketHeaderDisplay(&fTxHeader);
 460         return Send(fTxHeader.fPacketSize, 0);
 461     }
 462
 463     int JackNetMasterInterface::DataSend()
 464     {
 465         if (MidiSend(fNetMidiCaptureBuffer, fParams.fSendMidiChannels, fParams.fSendAudioChannels) == SOCKET_ERROR) {
 466             return SOCKET_ERROR;
 467         }
 468         return AudioSend(fNetAudioCaptureBuffer, fParams.fSendAudioChannels);
 469     }
 470
 471     int JackNetMasterInterface::SyncRecv()
 472     {
 473         int rx_bytes = 0;
 474         packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
 475
 476         // receive sync (launch the cycle)
 477         do {
 478             rx_bytes = Recv(fParams.fMtu, MSG_PEEK);
 479             // connection issue, send will detect it, so don't skip the cycle (return 0)
 480             if (rx_bytes == SOCKET_ERROR) {
 481                 return SOCKET_ERROR;
 482             }
 483         }
 484         while ((strcmp(rx_head->fPacketType, "header") != 0) && (rx_head->fDataType != 's'));
 485
 486         fCurrentCycleOffset = fTxHeader.fCycle - rx_head->fCycle;
 487
 488         if (fCurrentCycleOffset < fMaxCycleOffset) {
 489             jack_info("Synching with latency = %d", fCurrentCycleOffset);
 490             return 0;
 491         } else {
 492             rx_bytes = Recv(rx_head->fPacketSize, 0);
 493             fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 494             return rx_bytes;
 495         }
 496     }
 497
 498     int JackNetMasterInterface::DataRecv()
 499     {
 500         int rx_bytes = 0;
 501         uint recvd_midi_pckt = 0;
 502         packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
 503
 504         while (!fRxHeader.fIsLastPckt) {
 505             // how much data is queued on the rx buffer ?
 506             rx_bytes = Recv(fParams.fMtu, MSG_PEEK);
 507
 508             // error here, problem with recv, just skip the cycle (return -1)
 509             if (rx_bytes == SOCKET_ERROR) {
 510                 return rx_bytes;
 511             }
 512
 513             if (rx_bytes && (rx_head->fDataStream == 'r') && (rx_head->fID == fParams.fID)) {
 514                 // read data
 515                 switch (rx_head->fDataType) {
 516
 517                     case 'm':   // midi
 518                         rx_bytes = MidiRecv(rx_head, fNetMidiPlaybackBuffer, recvd_midi_pckt);
 519                         break;
 520
 521                     case 'a':   // audio
 522                         rx_bytes = AudioRecv(rx_head, fNetAudioPlaybackBuffer);
 523                         break;
 524
 525                     case 's':   // sync
 526                         jack_info("NetMaster : overloaded, skipping receive from '%s'", fParams.fName);
 527                         return FinishRecv(fNetAudioPlaybackBuffer);
 528                 }
 529             }
 530         }
 531
 532         return rx_bytes;
 533     }
 534
 535     void JackNetMasterInterface::EncodeSyncPacket()
 536     {
 537         // This method contains every step of sync packet informations coding
 538         // first of all, clear sync packet
 539         memset(fTxData, 0, PACKET_AVAILABLE_SIZE(&fParams));
 540
 541         // then, first step : transport
 542         if (fParams.fTransportSync) {
 543             EncodeTransportData();
 544             TransportDataHToN(&fSendTransportData, &fSendTransportData);
 545             // copy to TxBuffer
 546             memcpy(fTxData, &fSendTransportData, sizeof(net_transport_data_t));
 547         }
 548         // then others (freewheel etc.)
 549         // ...
 550
 551         // Transport not used for now...
 552
 553         // Write active ports list
 554         fTxHeader.fActivePorts = (fNetAudioPlaybackBuffer) ? fNetAudioPlaybackBuffer->ActivePortsToNetwork(fTxData) : 0;
 555     }
 556
 557     void JackNetMasterInterface::DecodeSyncPacket()
 558     {
 559         // This method contains every step of sync packet informations decoding process
 560         // first : transport
 561         if (fParams.fTransportSync) {
 562             // copy received transport data to transport data structure
 563             memcpy(&fReturnTransportData, fRxData, sizeof(net_transport_data_t));
 564             TransportDataNToH(&fReturnTransportData,  &fReturnTransportData);
 565             DecodeTransportData();
 566         }
 567         // then others
 568         // ...
 569
 570         // Transport not used for now...
 571         packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
 572
 573         // Read active ports list
 574         if (fNetAudioCaptureBuffer) {
 575             fNetAudioCaptureBuffer->ActivePortsFromNetwork(fRxData, rx_head->fActivePorts);
 576         }
 577     }
 578
 579 // JackNetSlaveInterface ************************************************************************************************
 580
 581     uint JackNetSlaveInterface::fSlaveCounter = 0;
 582
 583     void JackNetSlaveInterface::InitAPI()
 584     {
 585         // open Socket API with the first slave
 586         if (fSlaveCounter++ == 0) {
 587             if (SocketAPIInit() < 0) {
 588                 jack_error("Can't init Socket API, exiting...");
 589                 throw std::bad_alloc();
 590             }
 591         }
 592     }
 593
 594     bool JackNetSlaveInterface::Init()
 595     {
 596         jack_log("JackNetSlaveInterface::Init()");
 597
 598         // set the parameters to send
 599         strcpy(fParams.fPacketType, "params");
 600         fParams.fProtocolVersion = SLAVE_PROTOCOL;
 601         SetPacketType(&fParams, SLAVE_AVAILABLE);
 602
 603         // init loop : get a master and start, do it until connection is ok
 604         net_status_t status;
 605         do {
 606             // first, get a master, do it until a valid connection is running
 607             do {
 608                 status = SendAvailableToMaster();
 609                 if (status == NET_SOCKET_ERROR) {
 610                     return false;
 611                 }
 612             }
 613             while (status != NET_CONNECTED);
 614
 615             // then tell the master we are ready
 616             jack_info("Initializing connection with %s...", fParams.fMasterNetName);
 617             status = SendStartToMaster();
 618             if (status == NET_ERROR) {
 619                 return false;
 620             }
 621         }
 622         while (status != NET_ROLLING);
 623
 624         return true;
 625     }
 626
 627     // Separate the connection protocol into two separated step
 628     bool JackNetSlaveInterface::InitConnection(int time_out_sec)
 629     {
 630         jack_log("JackNetSlaveInterface::InitConnection()");
 631         uint try_count = (time_out_sec > 0) ? ((1000000 * time_out_sec) / SLAVE_INIT_TIMEOUT) : LONG_MAX;
 632
 633         // set the parameters to send
 634         strcpy(fParams.fPacketType, "params");
 635         fParams.fProtocolVersion = SLAVE_PROTOCOL;
 636         SetPacketType(&fParams, SLAVE_AVAILABLE);
 637
 638         net_status_t status;
 639         do {
 640             // get a master
 641             status = SendAvailableToMaster(try_count);
 642             if (status == NET_SOCKET_ERROR) {
 643                 return false;
 644             }
 645         }
 646         while (status != NET_CONNECTED && --try_count > 0);
 647
 648         return (try_count != 0);
 649     }
 650
 651     bool JackNetSlaveInterface::InitRendering()
 652     {
 653         jack_log("JackNetSlaveInterface::InitRendering()");
 654
 655         net_status_t status;
 656         do {
 657             // then tell the master we are ready
 658             jack_info("Initializing connection with %s...", fParams.fMasterNetName);
 659             status = SendStartToMaster();
 660             if (status == NET_ERROR) {
 661                 return false;
 662             }
 663         }
 664         while (status != NET_ROLLING);
 665
 666         return true;
 667     }
 668
 669     net_status_t JackNetSlaveInterface::SendAvailableToMaster(long try_count)
 670     {
 671         jack_log("JackNetSlaveInterface::SendAvailableToMaster()");
 672         // utility
 673         session_params_t host_params;
 674         int rx_bytes = 0;
 675
 676         // socket
 677         if (fSocket.NewSocket() == SOCKET_ERROR) {
 678             jack_error("Fatal error : network unreachable - %s", StrError(NET_ERROR_CODE));
 679             return NET_SOCKET_ERROR;
 680         }
 681
 682         if (fSocket.IsLocal(fMulticastIP)) {
 683             jack_info("Local IP is used...");
 684         } else {
 685             // bind the socket
 686             if (fSocket.Bind() == SOCKET_ERROR) {
 687                 jack_error("Can't bind the socket : %s", StrError(NET_ERROR_CODE));
 688                 return NET_SOCKET_ERROR;
 689             }
 690         }
 691
 692         // timeout on receive (for init)
 693         if (fSocket.SetTimeOut(SLAVE_INIT_TIMEOUT) == SOCKET_ERROR) {
 694             jack_error("Can't set init timeout : %s", StrError(NET_ERROR_CODE));
 695         }
 696
 697         // disable local loop
 698         if (fSocket.SetLocalLoop() == SOCKET_ERROR) {
 699             jack_error("Can't disable multicast loop : %s", StrError(NET_ERROR_CODE));
 700         }
 701
 702         // send 'AVAILABLE' until 'SLAVE_SETUP' received
 703         jack_info("Waiting for a master...");
 704         do {
 705             // send 'available'
 706             session_params_t net_params;
 707             memset(&net_params, 0, sizeof(session_params_t));
 708             SessionParamsHToN(&fParams, &net_params);
 709             if (fSocket.SendTo(&net_params, sizeof(session_params_t), 0, fMulticastIP) == SOCKET_ERROR) {
 710                 jack_error("Error in data send : %s", StrError(NET_ERROR_CODE));
 711             }
 712
 713             // filter incoming packets : don't exit while no error is detected
 714             memset(&net_params, 0, sizeof(session_params_t));
 715             rx_bytes = fSocket.CatchHost(&net_params, sizeof(session_params_t), 0);
 716             SessionParamsNToH(&net_params, &host_params);
 717             if ((rx_bytes == SOCKET_ERROR) && (fSocket.GetError() != NET_NO_DATA)) {
 718                 jack_error("Can't receive : %s", StrError(NET_ERROR_CODE));
 719                 return NET_RECV_ERROR;
 720             }
 721         }
 722         while (strcmp(host_params.fPacketType, fParams.fPacketType)  && (GetPacketType(&host_params) != SLAVE_SETUP)  && (--try_count > 0));
 723
 724         // Time out failure..
 725         if (try_count == 0) {
 726             jack_error("Time out error in connect");
 727             return NET_CONNECT_ERROR;
 728         }
 729
 730         // everything is OK, copy parameters
 731         fParams = host_params;
 732
 733         // connect the socket
 734         if (fSocket.Connect() == SOCKET_ERROR) {
 735             jack_error("Error in connect : %s", StrError(NET_ERROR_CODE));
 736             return NET_CONNECT_ERROR;
 737         }
 738         return NET_CONNECTED;
 739     }
 740
 741     net_status_t JackNetSlaveInterface::SendStartToMaster()
 742     {
 743         jack_log("JackNetSlaveInterface::SendStartToMaster");
 744
 745         // tell the master to start
 746         session_params_t net_params;
 747         memset(&net_params, 0, sizeof(session_params_t));
 748         SetPacketType(&fParams, START_MASTER);
 749         SessionParamsHToN(&fParams, &net_params);
 750         if (fSocket.Send(&net_params, sizeof(session_params_t), 0) == SOCKET_ERROR) {
 751             jack_error("Error in send : %s", StrError(NET_ERROR_CODE));
 752             return (fSocket.GetError() == NET_CONN_ERROR) ? NET_ERROR : NET_SEND_ERROR;
 753         }
 754         return NET_ROLLING;
 755     }
 756
 757     bool JackNetSlaveInterface::SetParams()
 758     {
 759         jack_log("JackNetSlaveInterface::SetParams audio in = %d audio out = %d MIDI in = %d MIDI out = %d",
 760                 fParams.fSendAudioChannels, fParams.fReturnAudioChannels,
 761                 fParams.fSendMidiChannels, fParams.fReturnMidiChannels);
 762
 763         JackNetInterface::SetParams();
 764
 765         fTxHeader.fDataStream = 'r';
 766         fRxHeader.fDataStream = 's';
 767
 768         // midi net buffers
 769         if (fParams.fSendMidiChannels > 0) {
 770             fNetMidiCaptureBuffer = new NetMidiBuffer(&fParams, fParams.fSendMidiChannels, fRxData);
 771         }
 772
 773         if (fParams.fReturnMidiChannels > 0) {
 774             fNetMidiPlaybackBuffer = new NetMidiBuffer(&fParams, fParams.fReturnMidiChannels, fTxData);
 775         }
 776
 777         try {
 778
 779             // audio net buffers
 780             if (fParams.fSendAudioChannels > 0) {
 781                 fNetAudioCaptureBuffer = AudioBufferFactory(fParams.fSendAudioChannels, fRxData);
 782                 assert(fNetAudioCaptureBuffer);
 783             }
 784
 785             if (fParams.fReturnAudioChannels > 0) {
 786                 fNetAudioPlaybackBuffer = AudioBufferFactory(fParams.fReturnAudioChannels, fTxData);
 787                 assert(fNetAudioPlaybackBuffer);
 788             }
 789
 790         } catch (exception&) {
 791             jack_error("NetAudioBuffer allocation error...");
 792             return false;
 793         }
 794
 795         // set the new buffer sizes
 796         if (SetNetBufferSize() == SOCKET_ERROR) {
 797             jack_error("Can't set net buffer sizes : %s", StrError(NET_ERROR_CODE));
 798             goto error;
 799         }
 800
 801         return true;
 802
 803     error:
 804         FreeNetworkBuffers();
 805         return false;
 806     }
 807
 808     void JackNetSlaveInterface::FatalRecvError()
 809     {
 810         jack_error("Recv connection lost error = %s", StrError(NET_ERROR_CODE));
 811         throw JackNetException();
 812     }
 813
 814     void JackNetSlaveInterface::FatalSendError()
 815     {
 816         jack_error("Send connection lost error = %s", StrError(NET_ERROR_CODE));
 817         throw JackNetException();
 818     }
 819
 820     int JackNetSlaveInterface::Recv(size_t size, int flags)
 821     {
 822         int rx_bytes = fSocket.Recv(fRxBuffer, size, flags);
 823
 824         // handle errors
 825         if (rx_bytes == SOCKET_ERROR) {
 826             FatalRecvError();
 827         }
 828
 829         packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
 830         PacketHeaderNToH(header, header);
 831         return rx_bytes;
 832     }
 833
 834     int JackNetSlaveInterface::Send(size_t size, int flags)
 835     {
 836         packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
 837         PacketHeaderHToN(header, header);
 838         int tx_bytes = fSocket.Send(fTxBuffer, size, flags);
 839
 840         // handle errors
 841         if (tx_bytes == SOCKET_ERROR) {
 842             FatalSendError();
 843         }
 844
 845         return tx_bytes;
 846     }
 847
 848     int JackNetSlaveInterface::SyncRecv()
 849     {
 850         int rx_bytes = 0;
 851         packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
 852
 853         // receive sync (launch the cycle)
 854         do {
 855             rx_bytes = Recv(fParams.fMtu, 0);
 856             // connection issue, send will detect it, so don't skip the cycle (return 0)
 857             if (rx_bytes == SOCKET_ERROR) {
 858                 return rx_bytes;
 859             }
 860         }
 861         while ((strcmp(rx_head->fPacketType, "header") != 0) && (rx_head->fDataType != 's'));
 862
 863         fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
 864
 865         SetRcvTimeOut();
 866         return rx_bytes;
 867     }
 868
 869     int JackNetSlaveInterface::DataRecv()
 870     {
 871         int rx_bytes = 0;
 872         uint recvd_midi_pckt = 0;
 873         packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
 874
 875         while (!fRxHeader.fIsLastPckt) {
 876             // how much data is queued on the rx buffer ?
 877             rx_bytes = Recv(fParams.fMtu, MSG_PEEK);
 878
 879             // error here, problem with recv, just skip the cycle (return -1)
 880             if (rx_bytes == SOCKET_ERROR) {
 881                 return rx_bytes;
 882             }
 883
 884             if (rx_bytes && (rx_head->fDataStream == 's') && (rx_head->fID == fParams.fID)) {
 885                 // read data
 886                 switch (rx_head->fDataType) {
 887
 888                     case 'm':   // midi
 889                         rx_bytes = MidiRecv(rx_head, fNetMidiCaptureBuffer, recvd_midi_pckt);
 890                         break;
 891
 892                     case 'a':   // audio
 893                         rx_bytes = AudioRecv(rx_head, fNetAudioCaptureBuffer);
 894                         break;
 895
 896                     case 's':   // sync
 897                         jack_info("NetSlave : overloaded, skipping receive");
 898                         return FinishRecv(fNetAudioCaptureBuffer);
 899                 }
 900             }
 901         }
 902
 903         fRxHeader.fCycle = rx_head->fCycle;
 904         return rx_bytes;
 905     }
 906
 907     int JackNetSlaveInterface::SyncSend()
 908     {
 909         // tx header
 910         if (fParams.fSlaveSyncMode) {
 911             fTxHeader.fCycle = fRxHeader.fCycle;
 912         } else {
 913             fTxHeader.fCycle++;
 914         }
 915         fTxHeader.fSubCycle = 0;
 916         fTxHeader.fDataType = 's';
 917         fTxHeader.fIsLastPckt = (fParams.fReturnMidiChannels == 0 && fParams.fReturnAudioChannels == 0) ? 1 : 0;
 918         fTxHeader.fPacketSize = fParams.fMtu;
 919
 920         memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
 921         // PacketHeaderDisplay(&fTxHeader);
 922         return Send(fTxHeader.fPacketSize, 0);
 923     }
 924
 925     int JackNetSlaveInterface::DataSend()
 926     {
 927         if (MidiSend(fNetMidiPlaybackBuffer, fParams.fReturnMidiChannels, fParams.fReturnAudioChannels) == SOCKET_ERROR) {
 928             return SOCKET_ERROR;
 929         }
 930         return AudioSend(fNetAudioPlaybackBuffer, fParams.fReturnAudioChannels);
 931     }
 932
 933     // network sync------------------------------------------------------------------------
 934     void JackNetSlaveInterface::EncodeSyncPacket()
 935     {
 936         // This method contains every step of sync packet informations coding
 937         // first of all, clear sync packet
 938         memset(fTxData, 0, PACKET_AVAILABLE_SIZE(&fParams));
 939
 940         // then first step : transport
 941         if (fParams.fTransportSync) {
 942             EncodeTransportData();
 943             TransportDataHToN(&fReturnTransportData, &fReturnTransportData);
 944             // copy to TxBuffer
 945             memcpy(fTxData, &fReturnTransportData, sizeof(net_transport_data_t));
 946         }
 947         // then others
 948         // ...
 949
 950         // Transport is not used for now...
 951
 952         // Write active ports list
 953         fTxHeader.fActivePorts = (fNetAudioCaptureBuffer) ? fNetAudioCaptureBuffer->ActivePortsToNetwork(fTxData) : 0;
 954     }
 955
 956     void JackNetSlaveInterface::DecodeSyncPacket()
 957     {
 958         // This method contains every step of sync packet informations decoding process
 959         // first : transport
 960         if (fParams.fTransportSync) {
 961             // copy received transport data to transport data structure
 962             memcpy(&fSendTransportData, fRxData, sizeof(net_transport_data_t));
 963             TransportDataNToH(&fSendTransportData, &fSendTransportData);
 964             DecodeTransportData();
 965         }
 966         // then others
 967         // ...
 968
 969         // Transport not used for now...
 970         packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
 971
 972         // Read active ports list
 973         if (fNetAudioPlaybackBuffer) {
 974             fNetAudioPlaybackBuffer->ActivePortsFromNetwork(fRxData, rx_head->fActivePorts);
 975         }
 976     }
 977
 978 }