Jack2  1.9.9
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  #if HAVE_OPUS
247  case JackOpusEncoder:
248  return new NetOpusAudioBuffer(&fParams, nports, buffer, fParams.fKBps);
249  #endif
250  }
251  return NULL;
252  }
253 
254  void JackNetInterface::SetRcvTimeOut()
255  {
256  if (!fSetTimeOut) {
257  if (fSocket.SetTimeOut(PACKET_TIMEOUT) == SOCKET_ERROR) {
258  jack_error("Can't set rx timeout : %s", StrError(NET_ERROR_CODE));
259  return;
260  }
261  fSetTimeOut = true;
262  }
263  }
264 
265  // JackNetMasterInterface ************************************************************************************
266 
267  bool JackNetMasterInterface::Init()
268  {
269  jack_log("JackNetMasterInterface::Init : ID %u", fParams.fID);
270 
271  session_params_t host_params;
272  uint attempt = 0;
273  int rx_bytes = 0;
274 
275  // socket
276  if (fSocket.NewSocket() == SOCKET_ERROR) {
277  jack_error("Can't create socket : %s", StrError(NET_ERROR_CODE));
278  return false;
279  }
280 
281  // timeout on receive (for init)
282  if (fSocket.SetTimeOut(MASTER_INIT_TIMEOUT) < 0) {
283  jack_error("Can't set init timeout : %s", StrError(NET_ERROR_CODE));
284  }
285 
286  // connect
287  if (fSocket.Connect() == SOCKET_ERROR) {
288  jack_error("Can't connect : %s", StrError(NET_ERROR_CODE));
289  return false;
290  }
291 
292  // send 'SLAVE_SETUP' until 'START_MASTER' received
293  jack_info("Sending parameters to %s...", fParams.fSlaveNetName);
294  do
295  {
296  session_params_t net_params;
297  memset(&net_params, 0, sizeof(session_params_t));
298  SetPacketType(&fParams, SLAVE_SETUP);
299  SessionParamsHToN(&fParams, &net_params);
300 
301  if (fSocket.Send(&net_params, sizeof(session_params_t), 0) == SOCKET_ERROR) {
302  jack_error("Error in send : %s", StrError(NET_ERROR_CODE));
303  }
304 
305  memset(&net_params, 0, sizeof(session_params_t));
306  if (((rx_bytes = fSocket.Recv(&net_params, sizeof(session_params_t), 0)) == SOCKET_ERROR) && (fSocket.GetError() != NET_NO_DATA)) {
307  jack_error("Problem with network");
308  return false;
309  }
310 
311  SessionParamsNToH(&net_params, &host_params);
312  }
313  while ((GetPacketType(&host_params) != START_MASTER) && (++attempt < SLAVE_SETUP_RETRY));
314 
315  if (attempt == SLAVE_SETUP_RETRY) {
316  jack_error("Slave doesn't respond, exiting");
317  return false;
318  }
319 
320  return true;
321  }
322 
323  bool JackNetMasterInterface::SetParams()
324  {
325  jack_log("JackNetMasterInterface::SetParams audio in = %d audio out = %d MIDI in = %d MIDI out = %d",
326  fParams.fSendAudioChannels, fParams.fReturnAudioChannels,
327  fParams.fSendMidiChannels, fParams.fReturnMidiChannels);
328 
329  JackNetInterface::SetParams();
330 
331  fTxHeader.fDataStream = 's';
332  fRxHeader.fDataStream = 'r';
333 
334  fMaxCycleOffset = fParams.fNetworkLatency;
335 
336  // midi net buffers
337  if (fParams.fSendMidiChannels > 0) {
338  fNetMidiCaptureBuffer = new NetMidiBuffer(&fParams, fParams.fSendMidiChannels, fTxData);
339  }
340 
341  if (fParams.fReturnMidiChannels > 0) {
342  fNetMidiPlaybackBuffer = new NetMidiBuffer(&fParams, fParams.fReturnMidiChannels, fRxData);
343  }
344 
345  try {
346 
347  // audio net buffers
348  if (fParams.fSendAudioChannels > 0) {
349  fNetAudioCaptureBuffer = AudioBufferFactory(fParams.fSendAudioChannels, fTxData);
350  assert(fNetAudioCaptureBuffer);
351  }
352 
353  if (fParams.fReturnAudioChannels > 0) {
354  fNetAudioPlaybackBuffer = AudioBufferFactory(fParams.fReturnAudioChannels, fRxData);
355  assert(fNetAudioPlaybackBuffer);
356  }
357 
358  } catch (exception&) {
359  jack_error("NetAudioBuffer allocation error...");
360  return false;
361  }
362 
363  // set the new rx buffer size
364  if (SetNetBufferSize() == SOCKET_ERROR) {
365  jack_error("Can't set net buffer sizes : %s", StrError(NET_ERROR_CODE));
366  goto error;
367  }
368 
369  return true;
370 
371  error:
372  FreeNetworkBuffers();
373  return false;
374  }
375 
376  void JackNetMasterInterface::Exit()
377  {
378  jack_log("JackNetMasterInterface::Exit, ID %u", fParams.fID);
379 
380  // stop process
381  fRunning = false;
382 
383  // send a 'multicast euthanasia request' - new socket is required on macosx
384  jack_info("Exiting '%s'", fParams.fName);
385  SetPacketType(&fParams, KILL_MASTER);
386  JackNetSocket mcast_socket(fMulticastIP, fSocket.GetPort());
387 
388  session_params_t net_params;
389  memset(&net_params, 0, sizeof(session_params_t));
390  SessionParamsHToN(&fParams, &net_params);
391 
392  if (mcast_socket.NewSocket() == SOCKET_ERROR) {
393  jack_error("Can't create socket : %s", StrError(NET_ERROR_CODE));
394  }
395  if (mcast_socket.SendTo(&net_params, sizeof(session_params_t), 0, fMulticastIP) == SOCKET_ERROR) {
396  jack_error("Can't send suicide request : %s", StrError(NET_ERROR_CODE));
397  }
398 
399  mcast_socket.Close();
400  }
401 
402  void JackNetMasterInterface::FatalRecvError()
403  {
404  // fatal connection issue, exit
405  jack_error("Recv connection lost error = %s, '%s' exiting", StrError(NET_ERROR_CODE), fParams.fName);
406  // ask to the manager to properly remove the master
407  Exit();
408  // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
409  ThreadExit();
410  }
411 
412  void JackNetMasterInterface::FatalSendError()
413  {
414  // fatal connection issue, exit
415  jack_error("Send connection lost error = %s, '%s' exiting", StrError(NET_ERROR_CODE), fParams.fName);
416  // ask to the manager to properly remove the master
417  Exit();
418  // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
419  ThreadExit();
420  }
421 
422  int JackNetMasterInterface::Recv(size_t size, int flags)
423  {
424  int rx_bytes;
425 
426  if (((rx_bytes = fSocket.Recv(fRxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
427  FatalRecvError();
428  }
429 
430  packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
431  PacketHeaderNToH(header, header);
432  return rx_bytes;
433  }
434 
435  int JackNetMasterInterface::Send(size_t size, int flags)
436  {
437  int tx_bytes;
438  packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
439  PacketHeaderHToN(header, header);
440 
441  if (((tx_bytes = fSocket.Send(fTxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
442  FatalSendError();
443  }
444  return tx_bytes;
445  }
446 
447  bool JackNetMasterInterface::IsSynched()
448  {
449  return (fCurrentCycleOffset <= fMaxCycleOffset);
450  }
451 
452  int JackNetMasterInterface::SyncSend()
453  {
454  SetRcvTimeOut();
455 
456  fTxHeader.fCycle++;
457  fTxHeader.fSubCycle = 0;
458  fTxHeader.fDataType = 's';
459  fTxHeader.fIsLastPckt = (fParams.fSendMidiChannels == 0 && fParams.fSendAudioChannels == 0) ? 1 : 0;
460  fTxHeader.fPacketSize = fParams.fMtu;
461 
462  memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
463  // PacketHeaderDisplay(&fTxHeader);
464  return Send(fTxHeader.fPacketSize, 0);
465  }
466 
467  int JackNetMasterInterface::DataSend()
468  {
469  if (MidiSend(fNetMidiCaptureBuffer, fParams.fSendMidiChannels, fParams.fSendAudioChannels) == SOCKET_ERROR) {
470  return SOCKET_ERROR;
471  }
472  return AudioSend(fNetAudioCaptureBuffer, fParams.fSendAudioChannels);
473  }
474 
475  int JackNetMasterInterface::SyncRecv()
476  {
477  int rx_bytes = 0;
478  packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
479 
480  // receive sync (launch the cycle)
481  do {
482  rx_bytes = Recv(fParams.fMtu, MSG_PEEK);
483  // connection issue, send will detect it, so don't skip the cycle (return 0)
484  if (rx_bytes == SOCKET_ERROR) {
485  return SOCKET_ERROR;
486  }
487  }
488  while ((strcmp(rx_head->fPacketType, "header") != 0) && (rx_head->fDataType != 's'));
489 
490  fCurrentCycleOffset = fTxHeader.fCycle - rx_head->fCycle;
491 
492  if (fCurrentCycleOffset < fMaxCycleOffset) {
493  jack_info("Synching with latency = %d", fCurrentCycleOffset);
494  return 0;
495  } else {
496  rx_bytes = Recv(rx_head->fPacketSize, 0);
497  fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
498  return rx_bytes;
499  }
500  }
501 
502  int JackNetMasterInterface::DataRecv()
503  {
504  int rx_bytes = 0;
505  uint recvd_midi_pckt = 0;
506  packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
507 
508  while (!fRxHeader.fIsLastPckt) {
509  // how much data is queued on the rx buffer ?
510  rx_bytes = Recv(fParams.fMtu, MSG_PEEK);
511 
512  // error here, problem with recv, just skip the cycle (return -1)
513  if (rx_bytes == SOCKET_ERROR) {
514  return rx_bytes;
515  }
516 
517  if (rx_bytes && (rx_head->fDataStream == 'r') && (rx_head->fID == fParams.fID)) {
518  // read data
519  switch (rx_head->fDataType) {
520 
521  case 'm': // midi
522  rx_bytes = MidiRecv(rx_head, fNetMidiPlaybackBuffer, recvd_midi_pckt);
523  break;
524 
525  case 'a': // audio
526  rx_bytes = AudioRecv(rx_head, fNetAudioPlaybackBuffer);
527  break;
528 
529  case 's': // sync
530  jack_info("NetMaster : overloaded, skipping receive from '%s'", fParams.fName);
531  return FinishRecv(fNetAudioPlaybackBuffer);
532  }
533  }
534  }
535 
536  return rx_bytes;
537  }
538 
539  void JackNetMasterInterface::EncodeSyncPacket()
540  {
541  // This method contains every step of sync packet informations coding
542  // first of all, clear sync packet
543  memset(fTxData, 0, PACKET_AVAILABLE_SIZE(&fParams));
544 
545  // then, first step : transport
546  if (fParams.fTransportSync) {
547  EncodeTransportData();
548  TransportDataHToN(&fSendTransportData, &fSendTransportData);
549  // copy to TxBuffer
550  memcpy(fTxData, &fSendTransportData, sizeof(net_transport_data_t));
551  }
552  // then others (freewheel etc.)
553  // ...
554 
555  // Transport not used for now...
556 
557  // Write active ports list
558  fTxHeader.fActivePorts = (fNetAudioPlaybackBuffer) ? fNetAudioPlaybackBuffer->ActivePortsToNetwork(fTxData) : 0;
559  }
560 
561  void JackNetMasterInterface::DecodeSyncPacket()
562  {
563  // This method contains every step of sync packet informations decoding process
564  // first : transport
565  if (fParams.fTransportSync) {
566  // copy received transport data to transport data structure
567  memcpy(&fReturnTransportData, fRxData, sizeof(net_transport_data_t));
568  TransportDataNToH(&fReturnTransportData, &fReturnTransportData);
569  DecodeTransportData();
570  }
571  // then others
572  // ...
573 
574  // Transport not used for now...
575  packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
576 
577  // Read active ports list
578  if (fNetAudioCaptureBuffer) {
579  fNetAudioCaptureBuffer->ActivePortsFromNetwork(fRxData, rx_head->fActivePorts);
580  }
581  }
582 
583 // JackNetSlaveInterface ************************************************************************************************
584 
585  uint JackNetSlaveInterface::fSlaveCounter = 0;
586 
587  void JackNetSlaveInterface::InitAPI()
588  {
589  // open Socket API with the first slave
590  if (fSlaveCounter++ == 0) {
591  if (SocketAPIInit() < 0) {
592  jack_error("Can't init Socket API, exiting...");
593  throw std::bad_alloc();
594  }
595  }
596  }
597 
598  bool JackNetSlaveInterface::Init()
599  {
600  jack_log("JackNetSlaveInterface::Init()");
601 
602  // set the parameters to send
603  strcpy(fParams.fPacketType, "params");
604  fParams.fProtocolVersion = SLAVE_PROTOCOL;
605  SetPacketType(&fParams, SLAVE_AVAILABLE);
606 
607  // init loop : get a master and start, do it until connection is ok
608  net_status_t status;
609  do {
610  // first, get a master, do it until a valid connection is running
611  do {
612  status = SendAvailableToMaster();
613  if (status == NET_SOCKET_ERROR) {
614  return false;
615  }
616  }
617  while (status != NET_CONNECTED);
618 
619  // then tell the master we are ready
620  jack_info("Initializing connection with %s...", fParams.fMasterNetName);
621  status = SendStartToMaster();
622  if (status == NET_ERROR) {
623  return false;
624  }
625  }
626  while (status != NET_ROLLING);
627 
628  return true;
629  }
630 
631  // Separate the connection protocol into two separated step
632  bool JackNetSlaveInterface::InitConnection(int time_out_sec)
633  {
634  jack_log("JackNetSlaveInterface::InitConnection()");
635  uint try_count = (time_out_sec > 0) ? ((1000000 * time_out_sec) / SLAVE_INIT_TIMEOUT) : LONG_MAX;
636 
637  // set the parameters to send
638  strcpy(fParams.fPacketType, "params");
639  fParams.fProtocolVersion = SLAVE_PROTOCOL;
640  SetPacketType(&fParams, SLAVE_AVAILABLE);
641 
642  net_status_t status;
643  do {
644  // get a master
645  status = SendAvailableToMaster(try_count);
646  if (status == NET_SOCKET_ERROR) {
647  return false;
648  }
649  }
650  while (status != NET_CONNECTED && --try_count > 0);
651 
652  return (try_count != 0);
653  }
654 
655  bool JackNetSlaveInterface::InitRendering()
656  {
657  jack_log("JackNetSlaveInterface::InitRendering()");
658 
659  net_status_t status;
660  do {
661  // then tell the master we are ready
662  jack_info("Initializing connection with %s...", fParams.fMasterNetName);
663  status = SendStartToMaster();
664  if (status == NET_ERROR) {
665  return false;
666  }
667  }
668  while (status != NET_ROLLING);
669 
670  return true;
671  }
672 
673  net_status_t JackNetSlaveInterface::SendAvailableToMaster(long try_count)
674  {
675  jack_log("JackNetSlaveInterface::SendAvailableToMaster()");
676  // utility
677  session_params_t host_params;
678  int rx_bytes = 0;
679 
680  // socket
681  if (fSocket.NewSocket() == SOCKET_ERROR) {
682  jack_error("Fatal error : network unreachable - %s", StrError(NET_ERROR_CODE));
683  return NET_SOCKET_ERROR;
684  }
685 
686  if (fSocket.IsLocal(fMulticastIP)) {
687  jack_info("Local IP is used...");
688  } else {
689  // bind the socket
690  if (fSocket.Bind() == SOCKET_ERROR) {
691  jack_error("Can't bind the socket : %s", StrError(NET_ERROR_CODE));
692  return NET_SOCKET_ERROR;
693  }
694  }
695 
696  // timeout on receive (for init)
697  if (fSocket.SetTimeOut(SLAVE_INIT_TIMEOUT) == SOCKET_ERROR) {
698  jack_error("Can't set init timeout : %s", StrError(NET_ERROR_CODE));
699  }
700 
701  // disable local loop
702  if (fSocket.SetLocalLoop() == SOCKET_ERROR) {
703  jack_error("Can't disable multicast loop : %s", StrError(NET_ERROR_CODE));
704  }
705 
706  // send 'AVAILABLE' until 'SLAVE_SETUP' received
707  jack_info("Waiting for a master...");
708  do {
709  // send 'available'
710  session_params_t net_params;
711  memset(&net_params, 0, sizeof(session_params_t));
712  SessionParamsHToN(&fParams, &net_params);
713  if (fSocket.SendTo(&net_params, sizeof(session_params_t), 0, fMulticastIP) == SOCKET_ERROR) {
714  jack_error("Error in data send : %s", StrError(NET_ERROR_CODE));
715  }
716 
717  // filter incoming packets : don't exit while no error is detected
718  memset(&net_params, 0, sizeof(session_params_t));
719  rx_bytes = fSocket.CatchHost(&net_params, sizeof(session_params_t), 0);
720  SessionParamsNToH(&net_params, &host_params);
721  if ((rx_bytes == SOCKET_ERROR) && (fSocket.GetError() != NET_NO_DATA)) {
722  jack_error("Can't receive : %s", StrError(NET_ERROR_CODE));
723  return NET_RECV_ERROR;
724  }
725  }
726  while (strcmp(host_params.fPacketType, fParams.fPacketType) && (GetPacketType(&host_params) != SLAVE_SETUP) && (--try_count > 0));
727 
728  // Time out failure..
729  if (try_count == 0) {
730  jack_error("Time out error in connect");
731  return NET_CONNECT_ERROR;
732  }
733 
734  // everything is OK, copy parameters
735  fParams = host_params;
736 
737  // connect the socket
738  if (fSocket.Connect() == SOCKET_ERROR) {
739  jack_error("Error in connect : %s", StrError(NET_ERROR_CODE));
740  return NET_CONNECT_ERROR;
741  }
742  return NET_CONNECTED;
743  }
744 
745  net_status_t JackNetSlaveInterface::SendStartToMaster()
746  {
747  jack_log("JackNetSlaveInterface::SendStartToMaster");
748 
749  // tell the master to start
750  session_params_t net_params;
751  memset(&net_params, 0, sizeof(session_params_t));
752  SetPacketType(&fParams, START_MASTER);
753  SessionParamsHToN(&fParams, &net_params);
754  if (fSocket.Send(&net_params, sizeof(session_params_t), 0) == SOCKET_ERROR) {
755  jack_error("Error in send : %s", StrError(NET_ERROR_CODE));
756  return (fSocket.GetError() == NET_CONN_ERROR) ? NET_ERROR : NET_SEND_ERROR;
757  }
758  return NET_ROLLING;
759  }
760 
761  bool JackNetSlaveInterface::SetParams()
762  {
763  jack_log("JackNetSlaveInterface::SetParams audio in = %d audio out = %d MIDI in = %d MIDI out = %d",
764  fParams.fSendAudioChannels, fParams.fReturnAudioChannels,
765  fParams.fSendMidiChannels, fParams.fReturnMidiChannels);
766 
767  JackNetInterface::SetParams();
768 
769  fTxHeader.fDataStream = 'r';
770  fRxHeader.fDataStream = 's';
771 
772  // midi net buffers
773  if (fParams.fSendMidiChannels > 0) {
774  fNetMidiCaptureBuffer = new NetMidiBuffer(&fParams, fParams.fSendMidiChannels, fRxData);
775  }
776 
777  if (fParams.fReturnMidiChannels > 0) {
778  fNetMidiPlaybackBuffer = new NetMidiBuffer(&fParams, fParams.fReturnMidiChannels, fTxData);
779  }
780 
781  try {
782 
783  // audio net buffers
784  if (fParams.fSendAudioChannels > 0) {
785  fNetAudioCaptureBuffer = AudioBufferFactory(fParams.fSendAudioChannels, fRxData);
786  assert(fNetAudioCaptureBuffer);
787  }
788 
789  if (fParams.fReturnAudioChannels > 0) {
790  fNetAudioPlaybackBuffer = AudioBufferFactory(fParams.fReturnAudioChannels, fTxData);
791  assert(fNetAudioPlaybackBuffer);
792  }
793 
794  } catch (exception&) {
795  jack_error("NetAudioBuffer allocation error...");
796  return false;
797  }
798 
799  // set the new buffer sizes
800  if (SetNetBufferSize() == SOCKET_ERROR) {
801  jack_error("Can't set net buffer sizes : %s", StrError(NET_ERROR_CODE));
802  goto error;
803  }
804 
805  return true;
806 
807  error:
808  FreeNetworkBuffers();
809  return false;
810  }
811 
812  void JackNetSlaveInterface::FatalRecvError()
813  {
814  jack_error("Recv connection lost error = %s", StrError(NET_ERROR_CODE));
815  throw JackNetException();
816  }
817 
818  void JackNetSlaveInterface::FatalSendError()
819  {
820  jack_error("Send connection lost error = %s", StrError(NET_ERROR_CODE));
821  throw JackNetException();
822  }
823 
824  int JackNetSlaveInterface::Recv(size_t size, int flags)
825  {
826  int rx_bytes = fSocket.Recv(fRxBuffer, size, flags);
827 
828  // handle errors
829  if (rx_bytes == SOCKET_ERROR) {
830  FatalRecvError();
831  }
832 
833  packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
834  PacketHeaderNToH(header, header);
835  return rx_bytes;
836  }
837 
838  int JackNetSlaveInterface::Send(size_t size, int flags)
839  {
840  packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
841  PacketHeaderHToN(header, header);
842  int tx_bytes = fSocket.Send(fTxBuffer, size, flags);
843 
844  // handle errors
845  if (tx_bytes == SOCKET_ERROR) {
846  FatalSendError();
847  }
848 
849  return tx_bytes;
850  }
851 
852  int JackNetSlaveInterface::SyncRecv()
853  {
854  int rx_bytes = 0;
855  packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
856 
857  // receive sync (launch the cycle)
858  do {
859  rx_bytes = Recv(fParams.fMtu, 0);
860  // connection issue, send will detect it, so don't skip the cycle (return 0)
861  if (rx_bytes == SOCKET_ERROR) {
862  return rx_bytes;
863  }
864  }
865  while ((strcmp(rx_head->fPacketType, "header") != 0) && (rx_head->fDataType != 's'));
866 
867  fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
868 
869  SetRcvTimeOut();
870  return rx_bytes;
871  }
872 
873  int JackNetSlaveInterface::DataRecv()
874  {
875  int rx_bytes = 0;
876  uint recvd_midi_pckt = 0;
877  packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
878 
879  while (!fRxHeader.fIsLastPckt) {
880  // how much data is queued on the rx buffer ?
881  rx_bytes = Recv(fParams.fMtu, MSG_PEEK);
882 
883  // error here, problem with recv, just skip the cycle (return -1)
884  if (rx_bytes == SOCKET_ERROR) {
885  return rx_bytes;
886  }
887 
888  if (rx_bytes && (rx_head->fDataStream == 's') && (rx_head->fID == fParams.fID)) {
889  // read data
890  switch (rx_head->fDataType) {
891 
892  case 'm': // midi
893  rx_bytes = MidiRecv(rx_head, fNetMidiCaptureBuffer, recvd_midi_pckt);
894  break;
895 
896  case 'a': // audio
897  rx_bytes = AudioRecv(rx_head, fNetAudioCaptureBuffer);
898  break;
899 
900  case 's': // sync
901  jack_info("NetSlave : overloaded, skipping receive");
902  return FinishRecv(fNetAudioCaptureBuffer);
903  }
904  }
905  }
906 
907  fRxHeader.fCycle = rx_head->fCycle;
908  return rx_bytes;
909  }
910 
911  int JackNetSlaveInterface::SyncSend()
912  {
913  // tx header
914  if (fParams.fSlaveSyncMode) {
915  fTxHeader.fCycle = fRxHeader.fCycle;
916  } else {
917  fTxHeader.fCycle++;
918  }
919  fTxHeader.fSubCycle = 0;
920  fTxHeader.fDataType = 's';
921  fTxHeader.fIsLastPckt = (fParams.fReturnMidiChannels == 0 && fParams.fReturnAudioChannels == 0) ? 1 : 0;
922  fTxHeader.fPacketSize = fParams.fMtu;
923 
924  memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
925  // PacketHeaderDisplay(&fTxHeader);
926  return Send(fTxHeader.fPacketSize, 0);
927  }
928 
929  int JackNetSlaveInterface::DataSend()
930  {
931  if (MidiSend(fNetMidiPlaybackBuffer, fParams.fReturnMidiChannels, fParams.fReturnAudioChannels) == SOCKET_ERROR) {
932  return SOCKET_ERROR;
933  }
934  return AudioSend(fNetAudioPlaybackBuffer, fParams.fReturnAudioChannels);
935  }
936 
937  // network sync------------------------------------------------------------------------
938  void JackNetSlaveInterface::EncodeSyncPacket()
939  {
940  // This method contains every step of sync packet informations coding
941  // first of all, clear sync packet
942  memset(fTxData, 0, PACKET_AVAILABLE_SIZE(&fParams));
943 
944  // then first step : transport
945  if (fParams.fTransportSync) {
946  EncodeTransportData();
947  TransportDataHToN(&fReturnTransportData, &fReturnTransportData);
948  // copy to TxBuffer
949  memcpy(fTxData, &fReturnTransportData, sizeof(net_transport_data_t));
950  }
951  // then others
952  // ...
953 
954  // Transport is not used for now...
955 
956  // Write active ports list
957  fTxHeader.fActivePorts = (fNetAudioCaptureBuffer) ? fNetAudioCaptureBuffer->ActivePortsToNetwork(fTxData) : 0;
958  }
959 
960  void JackNetSlaveInterface::DecodeSyncPacket()
961  {
962  // This method contains every step of sync packet informations decoding process
963  // first : transport
964  if (fParams.fTransportSync) {
965  // copy received transport data to transport data structure
966  memcpy(&fSendTransportData, fRxData, sizeof(net_transport_data_t));
967  TransportDataNToH(&fSendTransportData, &fSendTransportData);
968  DecodeTransportData();
969  }
970  // then others
971  // ...
972 
973  // Transport not used for now...
974  packet_header_t* rx_head = reinterpret_cast<packet_header_t*>(fRxBuffer);
975 
976  // Read active ports list
977  if (fNetAudioPlaybackBuffer) {
978  fNetAudioPlaybackBuffer->ActivePortsFromNetwork(fRxData, rx_head->fActivePorts);
979  }
980  }
981 
982 }
SERVER_EXPORT void jack_error(const char *fmt,...)
Definition: JackError.cpp:91
SERVER_EXPORT void jack_info(const char *fmt,...)
Definition: JackError.cpp:99
SERVER_EXPORT void jack_log(const char *fmt,...)
Definition: JackError.cpp:107