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