jack2 codebase
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

882 lines
36KB

  1. /*
  2. Copyright (C) 2001 Paul Davis
  3. Copyright (C) 2008 Romain Moret at Grame
  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. This program is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. GNU General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with this program; if not, write to the Free Software
  14. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  15. */
  16. #include "JackNetDriver.h"
  17. #include "JackEngineControl.h"
  18. #include "JackClientControl.h"
  19. #include "JackGraphManager.h"
  20. #include "JackDriverLoader.h"
  21. #include "JackThreadedDriver.h"
  22. #include "JackWaitThreadedDriver.h"
  23. #include "JackException.h"
  24. #define DEFAULT_MULTICAST_IP "225.3.19.154"
  25. #define DEFAULT_PORT 19000
  26. using namespace std;
  27. namespace Jack
  28. {
  29. JackNetDriver::JackNetDriver ( const char* name, const char* alias, JackLockedEngine* engine, JackSynchro* table,
  30. const char* ip, int port, int mtu, int midi_input_ports, int midi_output_ports,
  31. const char* net_name, uint transport_sync, char network_mode )
  32. : JackAudioDriver ( name, alias, engine, table ), fSocket ( ip, port )
  33. {
  34. jack_log ( "JackNetDriver::JackNetDriver ip %s, port %d", ip, port );
  35. fMulticastIP = new char[strlen ( ip ) + 1];
  36. strcpy ( fMulticastIP, ip );
  37. fParams.fMtu = mtu;
  38. fParams.fSendMidiChannels = midi_input_ports;
  39. fParams.fReturnMidiChannels = midi_output_ports;
  40. strcpy ( fParams.fName, net_name );
  41. fSocket.GetName ( fParams.fSlaveNetName );
  42. fParams.fTransportSync = transport_sync;
  43. fParams.fNetworkMode = network_mode;
  44. #ifdef JACK_MONITOR
  45. fNetTimeMon = NULL;
  46. fCycleTimeMon = NULL;
  47. #endif
  48. }
  49. JackNetDriver::~JackNetDriver()
  50. {
  51. fSocket.Close();
  52. SocketAPIEnd();
  53. delete fNetAudioCaptureBuffer;
  54. delete fNetAudioPlaybackBuffer;
  55. delete fNetMidiCaptureBuffer;
  56. delete fNetMidiPlaybackBuffer;
  57. delete[] fTxBuffer;
  58. delete[] fRxBuffer;
  59. delete[] fMulticastIP;
  60. delete[] fMidiCapturePortList;
  61. delete[] fMidiPlaybackPortList;
  62. #ifdef JACK_MONITOR
  63. delete fNetTimeMon;
  64. delete fCycleTimeMon;
  65. #endif
  66. }
  67. //*************************************initialization***********************************************************************
  68. int JackNetDriver::Open ( jack_nframes_t buffer_size, jack_nframes_t samplerate, bool capturing, bool playing,
  69. int inchannels, int outchannels, bool monitor,
  70. const char* capture_driver_name, const char* playback_driver_name,
  71. jack_nframes_t capture_latency, jack_nframes_t playback_latency )
  72. {
  73. int res = JackAudioDriver::Open ( buffer_size, samplerate, capturing, playing, inchannels, outchannels, monitor,
  74. capture_driver_name, playback_driver_name, capture_latency, playback_latency );
  75. fEngineControl->fPeriod = 0;
  76. fEngineControl->fComputation = 500 * 1000;
  77. fEngineControl->fConstraint = 500 * 1000;
  78. return res;
  79. }
  80. #ifdef JACK_MONITOR
  81. int JackNetDriver::Close()
  82. {
  83. if ( fNetTimeMon )
  84. fNetTimeMon->Save();
  85. if ( fCycleTimeMon )
  86. fCycleTimeMon->Save();
  87. return JackDriver::Close();
  88. }
  89. #endif
  90. int JackNetDriver::Attach()
  91. {
  92. return 0;
  93. }
  94. int JackNetDriver::Detach()
  95. {
  96. return 0;
  97. }
  98. bool JackNetDriver::Init()
  99. {
  100. jack_log ( "JackNetDriver::Init()" );
  101. //new loading, but existing socket, restart the driver
  102. if ( fSocket.IsSocket() )
  103. Restart();
  104. //set the parameters to send
  105. strcpy ( fParams.fPacketType, "params" );
  106. fParams.fProtocolVersion = 'a';
  107. SetPacketType ( &fParams, SLAVE_AVAILABLE );
  108. fParams.fSendAudioChannels = fCaptureChannels;
  109. fParams.fReturnAudioChannels = fPlaybackChannels;
  110. fParams.fSlaveSyncMode = fEngineControl->fSyncMode;
  111. //is transport sync ?
  112. if ( fParams.fTransportSync )
  113. jack_info ( "NetDriver started with Master's Transport Sync." );
  114. //init loop : get a master and start, do it until connection is ok
  115. net_status_t status;
  116. do
  117. {
  118. //first, get a master, do it until a valid connection is running
  119. jack_info ( "Initializing Net Driver..." );
  120. do
  121. {
  122. status = GetNetMaster();
  123. if ( status == NET_SOCKET_ERROR )
  124. return false;
  125. }
  126. while ( status != NET_CONNECTED );
  127. //then tell the master we are ready
  128. jack_info ( "Initializing connection with %s...", fParams.fMasterNetName );
  129. status = SendMasterStartSync();
  130. if ( status == NET_ERROR )
  131. return false;
  132. }
  133. while ( status != NET_ROLLING );
  134. //driver parametering
  135. if ( SetParams() )
  136. {
  137. jack_error ( "Fatal error : can't alloc net driver ports." );
  138. return false;
  139. }
  140. //init done, display parameters
  141. SessionParamsDisplay ( &fParams );
  142. return true;
  143. }
  144. net_status_t JackNetDriver::GetNetMaster()
  145. {
  146. jack_log ( "JackNetDriver::GetNetMaster()" );
  147. //utility
  148. session_params_t params;
  149. int us_timeout = 2000000;
  150. int rx_bytes = 0;
  151. unsigned char loop = 0;
  152. //socket
  153. if ( fSocket.NewSocket() == SOCKET_ERROR )
  154. {
  155. jack_error ( "Fatal error : network unreachable - %s", StrError ( NET_ERROR_CODE ) );
  156. return NET_SOCKET_ERROR;
  157. }
  158. //bind the socket
  159. if ( fSocket.Bind() == SOCKET_ERROR )
  160. jack_error ( "Can't bind the socket : %s", StrError ( NET_ERROR_CODE ) );
  161. //timeout on receive
  162. if ( fSocket.SetTimeOut ( us_timeout ) == SOCKET_ERROR )
  163. jack_error ( "Can't set timeout : %s", StrError ( NET_ERROR_CODE ) );
  164. //disable local loop
  165. if ( fSocket.SetOption ( IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof ( loop ) ) == SOCKET_ERROR )
  166. jack_error ( "Can't disable multicast loop : %s", StrError ( NET_ERROR_CODE ) );
  167. //send 'AVAILABLE' until 'SLAVE_SETUP' received
  168. jack_info ( "Waiting for a master..." );
  169. do
  170. {
  171. //send 'available'
  172. if ( fSocket.SendTo ( &fParams, sizeof ( session_params_t ), 0, fMulticastIP ) == SOCKET_ERROR )
  173. jack_error ( "Error in data send : %s", StrError ( NET_ERROR_CODE ) );
  174. //filter incoming packets : don't exit while no error is detected
  175. rx_bytes = fSocket.CatchHost ( &params, sizeof ( session_params_t ), 0 );
  176. if ( ( rx_bytes == SOCKET_ERROR ) && ( fSocket.GetError() != NET_NO_DATA ) )
  177. {
  178. jack_error ( "Can't receive : %s", StrError ( NET_ERROR_CODE ) );
  179. return NET_RECV_ERROR;
  180. }
  181. }
  182. while ( strcmp ( params.fPacketType, fParams.fPacketType ) && ( GetPacketType ( &params ) != SLAVE_SETUP ) );
  183. //connect the socket
  184. if ( fSocket.Connect() == SOCKET_ERROR )
  185. {
  186. jack_error ( "Error in connect : %s", StrError ( NET_ERROR_CODE ) );
  187. return NET_CONNECT_ERROR;
  188. }
  189. //everything is OK, copy parameters and return
  190. fParams = params;
  191. return NET_CONNECTED;
  192. }
  193. net_status_t JackNetDriver::SendMasterStartSync()
  194. {
  195. jack_log ( "JackNetDriver::GetNetMasterStartSync()" );
  196. //tell the master to start
  197. SetPacketType ( &fParams, START_MASTER );
  198. if ( fSocket.Send ( &fParams, sizeof ( session_params_t ), 0 ) == SOCKET_ERROR )
  199. {
  200. jack_error ( "Error in send : %s", StrError ( NET_ERROR_CODE ) );
  201. return ( fSocket.GetError() == NET_CONN_ERROR ) ? NET_ERROR : NET_SEND_ERROR;
  202. }
  203. return NET_ROLLING;
  204. }
  205. void JackNetDriver::Restart()
  206. {
  207. jack_log ( "JackNetDriver::Restart" );
  208. jack_info ( "Restarting driver..." );
  209. delete[] fTxBuffer;
  210. fTxBuffer = NULL;
  211. delete[] fRxBuffer;
  212. fRxBuffer = NULL;
  213. delete fNetAudioCaptureBuffer;
  214. fNetAudioCaptureBuffer = NULL;
  215. delete fNetAudioPlaybackBuffer;
  216. fNetAudioPlaybackBuffer = NULL;
  217. delete fNetMidiCaptureBuffer;
  218. fNetMidiCaptureBuffer = NULL;
  219. delete fNetMidiPlaybackBuffer;
  220. fNetMidiPlaybackBuffer = NULL;
  221. FreePorts();
  222. delete[] fMidiCapturePortList;
  223. fMidiCapturePortList = NULL;
  224. delete[] fMidiPlaybackPortList;
  225. fMidiPlaybackPortList = NULL;
  226. #ifdef JACK_MONITOR
  227. delete fNetTimeMon;
  228. fNetTimeMon = NULL;
  229. delete fCycleTimeMon;
  230. fCycleTimeMon = NULL;
  231. #endif
  232. }
  233. int JackNetDriver::SetParams()
  234. {
  235. fNSubProcess = fParams.fPeriodSize / fParams.fFramesPerPacket;
  236. JackAudioDriver::SetBufferSize ( fParams.fPeriodSize );
  237. JackAudioDriver::SetSampleRate ( fParams.fSampleRate );
  238. JackDriver::NotifyBufferSize ( fParams.fPeriodSize );
  239. JackDriver::NotifySampleRate ( fParams.fSampleRate );
  240. //allocate midi ports lists
  241. fMidiCapturePortList = new jack_port_id_t [fParams.fSendMidiChannels];
  242. fMidiPlaybackPortList = new jack_port_id_t [fParams.fReturnMidiChannels];
  243. //register jack ports
  244. if ( AllocPorts() != 0 )
  245. {
  246. jack_error ( "Can't allocate ports." );
  247. return -1;
  248. }
  249. //TX header init
  250. strcpy ( fTxHeader.fPacketType, "header" );
  251. fTxHeader.fDataStream = 'r';
  252. fTxHeader.fID = fParams.fID;
  253. fTxHeader.fCycle = 0;
  254. fTxHeader.fSubCycle = 0;
  255. fTxHeader.fMidiDataSize = 0;
  256. fTxHeader.fBitdepth = fParams.fBitdepth;
  257. //RX header init
  258. strcpy ( fRxHeader.fPacketType, "header" );
  259. fRxHeader.fDataStream = 's';
  260. fRxHeader.fID = fParams.fID;
  261. fRxHeader.fCycle = 0;
  262. fRxHeader.fSubCycle = 0;
  263. fRxHeader.fMidiDataSize = 0;
  264. fRxHeader.fBitdepth = fParams.fBitdepth;
  265. //network buffers
  266. fTxBuffer = new char[fParams.fMtu];
  267. fRxBuffer = new char[fParams.fMtu];
  268. //net audio/midi buffers
  269. fTxData = fTxBuffer + sizeof ( packet_header_t );
  270. fRxData = fRxBuffer + sizeof ( packet_header_t );
  271. //midi net buffers
  272. fNetMidiCaptureBuffer = new NetMidiBuffer ( &fParams, fParams.fSendMidiChannels, fRxData );
  273. fNetMidiPlaybackBuffer = new NetMidiBuffer ( &fParams, fParams.fReturnMidiChannels, fTxData );
  274. //audio net buffers
  275. fNetAudioCaptureBuffer = new NetAudioBuffer ( &fParams, fParams.fSendAudioChannels, fRxData );
  276. fNetAudioPlaybackBuffer = new NetAudioBuffer ( &fParams, fParams.fReturnAudioChannels, fTxData );
  277. //audio netbuffer length
  278. fAudioTxLen = sizeof ( packet_header_t ) + fNetAudioPlaybackBuffer->GetSize();
  279. fAudioRxLen = sizeof ( packet_header_t ) + fNetAudioCaptureBuffer->GetSize();
  280. //payload size
  281. fPayloadSize = fParams.fMtu - sizeof ( packet_header_t );
  282. //monitor
  283. #ifdef JACK_MONITOR
  284. string plot_name;
  285. //NetTimeMon
  286. plot_name = string ( fParams.fName );
  287. plot_name += string ( "_slave" );
  288. plot_name += ( fEngineControl->fSyncMode ) ? string ( "_sync" ) : string ( "_async" );
  289. plot_name += ( fParams.fNetworkMode == 'f' ) ? string ( "_fast" ) : string ( "_normal" );
  290. fNetTimeMon = new JackGnuPlotMonitor<float> ( 128, 4, plot_name );
  291. string net_time_mon_fields[] =
  292. {
  293. string ( "end of read" ),
  294. string ( "start of write" ),
  295. string ( "sync send" ),
  296. string ( "end of write" )
  297. };
  298. string net_time_mon_options[] =
  299. {
  300. string ( "set xlabel \"audio cycles\"" ),
  301. string ( "set ylabel \"% of audio cycle\"" )
  302. };
  303. fNetTimeMon->SetPlotFile ( net_time_mon_options, 2, net_time_mon_fields, 4 );
  304. //CycleTimeMon
  305. plot_name.clear();
  306. plot_name = string ( fParams.fName );
  307. plot_name += string ( "_slave_cycle_duration" );
  308. plot_name += ( fEngineControl->fSyncMode ) ? string ( "_sync" ) : string ( "_async" );
  309. plot_name += ( fParams.fNetworkMode == 'f' ) ? string ( "_fast" ) : string ( "_normal" );
  310. fCycleTimeMon = new JackGnuPlotMonitor<jack_time_t> ( 2048, 1, plot_name );
  311. string cycle_time_mon_field = string ( "cycle duration" );
  312. string cycle_time_mon_options[] =
  313. {
  314. string ( "set xlabel \"audio cycles\"" ),
  315. string ( "set ylabel \"usecs\"" )
  316. };
  317. fCycleTimeMon->SetPlotFile ( cycle_time_mon_options, 2, &cycle_time_mon_field, 1 );
  318. fLastCycleBeginDate = GetMicroSeconds();
  319. #endif
  320. return 0;
  321. }
  322. int JackNetDriver::AllocPorts()
  323. {
  324. jack_log ( "JackNetDriver::AllocPorts fBufferSize = %ld fSampleRate = %ld", fEngineControl->fBufferSize, fEngineControl->fSampleRate );
  325. JackPort* port;
  326. jack_port_id_t port_id;
  327. char name[JACK_CLIENT_NAME_SIZE + JACK_PORT_NAME_SIZE];
  328. char alias[JACK_CLIENT_NAME_SIZE + JACK_PORT_NAME_SIZE];
  329. unsigned long port_flags;
  330. int audio_port_index;
  331. uint midi_port_index;
  332. //audio
  333. port_flags = JackPortIsOutput | JackPortIsPhysical | JackPortIsTerminal;
  334. for ( audio_port_index = 0; audio_port_index < fCaptureChannels; audio_port_index++ )
  335. {
  336. snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:out%d", fAliasName, fCaptureDriverName, audio_port_index + 1 );
  337. snprintf ( name, sizeof ( name ) - 1, "%s:capture_%d", fClientControl.fName, audio_port_index + 1 );
  338. if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_AUDIO_TYPE,
  339. static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
  340. {
  341. jack_error ( "driver: cannot register port for %s", name );
  342. return -1;
  343. }
  344. port = fGraphManager->GetPort ( port_id );
  345. port->SetAlias ( alias );
  346. port->SetLatency ( fEngineControl->fBufferSize );
  347. fCapturePortList[audio_port_index] = port_id;
  348. jack_log ( "JackNetDriver::AllocPorts() fCapturePortList[%d] audio_port_index = %ld fPortLatency = %ld", audio_port_index, port_id, port->GetLatency() );
  349. }
  350. port_flags = JackPortIsInput | JackPortIsPhysical | JackPortIsTerminal;
  351. for ( audio_port_index = 0; audio_port_index < fPlaybackChannels; audio_port_index++ )
  352. {
  353. snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:in%d", fAliasName, fPlaybackDriverName, audio_port_index + 1 );
  354. snprintf ( name, sizeof ( name ) - 1, "%s:playback_%d",fClientControl.fName, audio_port_index + 1 );
  355. if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_AUDIO_TYPE,
  356. static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
  357. {
  358. jack_error ( "driver: cannot register port for %s", name );
  359. return -1;
  360. }
  361. port = fGraphManager->GetPort ( port_id );
  362. port->SetAlias ( alias );
  363. port->SetLatency ( ( fParams.fNetworkMode == 'f' ) ? 0 : fEngineControl->fBufferSize + ( ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize ) );
  364. fPlaybackPortList[audio_port_index] = port_id;
  365. jack_log ( "JackNetDriver::AllocPorts() fPlaybackPortList[%d] audio_port_index = %ld fPortLatency = %ld", audio_port_index, port_id, port->GetLatency() );
  366. }
  367. //midi
  368. port_flags = JackPortIsOutput | JackPortIsPhysical | JackPortIsTerminal;
  369. for ( midi_port_index = 0; midi_port_index < fParams.fSendMidiChannels; midi_port_index++ )
  370. {
  371. snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:out%d", fAliasName, fCaptureDriverName, midi_port_index + 1 );
  372. snprintf ( name, sizeof ( name ) - 1, "%s:midi_capture_%d", fClientControl.fName, midi_port_index + 1 );
  373. if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_MIDI_TYPE,
  374. static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
  375. {
  376. jack_error ( "driver: cannot register port for %s", name );
  377. return -1;
  378. }
  379. port = fGraphManager->GetPort ( port_id );
  380. port->SetLatency ( fEngineControl->fBufferSize );
  381. fMidiCapturePortList[midi_port_index] = port_id;
  382. jack_log ( "JackNetDriver::AllocPorts() fMidiCapturePortList[%d] midi_port_index = %ld fPortLatency = %ld", midi_port_index, port_id, port->GetLatency() );
  383. }
  384. port_flags = JackPortIsInput | JackPortIsPhysical | JackPortIsTerminal;
  385. for ( midi_port_index = 0; midi_port_index < fParams.fReturnMidiChannels; midi_port_index++ )
  386. {
  387. snprintf ( alias, sizeof ( alias ) - 1, "%s:%s:in%d", fAliasName, fPlaybackDriverName, midi_port_index + 1 );
  388. snprintf ( name, sizeof ( name ) - 1, "%s:midi_playback_%d", fClientControl.fName, midi_port_index + 1 );
  389. if ( ( port_id = fGraphManager->AllocatePort ( fClientControl.fRefNum, name, JACK_DEFAULT_MIDI_TYPE,
  390. static_cast<JackPortFlags> ( port_flags ), fEngineControl->fBufferSize ) ) == NO_PORT )
  391. {
  392. jack_error ( "driver: cannot register port for %s", name );
  393. return -1;
  394. }
  395. port = fGraphManager->GetPort ( port_id );
  396. port->SetLatency ( ( fParams.fNetworkMode == 'f' ) ? 0 : fEngineControl->fBufferSize + ( ( fEngineControl->fSyncMode ) ? 0 : fEngineControl->fBufferSize ) );
  397. fMidiPlaybackPortList[midi_port_index] = port_id;
  398. jack_log ( "JackNetDriver::AllocPorts() fMidiPlaybackPortList[%d] midi_port_index = %ld fPortLatency = %ld", midi_port_index, port_id, port->GetLatency() );
  399. }
  400. return 0;
  401. }
  402. int JackNetDriver::FreePorts()
  403. {
  404. jack_log ( "JackNetDriver::FreePorts" );
  405. int audio_port_index;
  406. uint midi_port_index;
  407. for ( audio_port_index = 0; audio_port_index < fCaptureChannels; audio_port_index++ )
  408. fGraphManager->ReleasePort ( fClientControl.fRefNum, fCapturePortList[audio_port_index] );
  409. for ( audio_port_index = 0; audio_port_index < fPlaybackChannels; audio_port_index++ )
  410. fGraphManager->ReleasePort ( fClientControl.fRefNum, fPlaybackPortList[audio_port_index] );
  411. for ( midi_port_index = 0; midi_port_index < fParams.fSendMidiChannels; midi_port_index++ )
  412. fGraphManager->ReleasePort ( fClientControl.fRefNum, fMidiCapturePortList[midi_port_index] );
  413. for ( midi_port_index = 0; midi_port_index < fParams.fReturnMidiChannels; midi_port_index++ )
  414. fGraphManager->ReleasePort ( fClientControl.fRefNum, fMidiPlaybackPortList[midi_port_index] );
  415. return 0;
  416. }
  417. JackMidiBuffer* JackNetDriver::GetMidiInputBuffer ( int port_index )
  418. {
  419. return static_cast<JackMidiBuffer*> ( fGraphManager->GetBuffer ( fMidiCapturePortList[port_index], fEngineControl->fBufferSize ) );
  420. }
  421. JackMidiBuffer* JackNetDriver::GetMidiOutputBuffer ( int port_index )
  422. {
  423. return static_cast<JackMidiBuffer*> ( fGraphManager->GetBuffer ( fMidiPlaybackPortList[port_index], fEngineControl->fBufferSize ) );
  424. }
  425. int JackNetDriver::SetSyncPacket()
  426. {
  427. if ( fParams.fTransportSync )
  428. {
  429. //set the TransportData
  430. //copy to TxBuffer
  431. memcpy ( fTxData, &fTransportData, sizeof ( net_transport_data_t ) );
  432. }
  433. return 0;
  434. }
  435. //***********************************network operations*************************************************************
  436. int JackNetDriver::Recv ( size_t size, int flags )
  437. {
  438. int rx_bytes = fSocket.Recv ( fRxBuffer, size, flags );
  439. //handle errors
  440. if ( rx_bytes == SOCKET_ERROR )
  441. {
  442. net_error_t error = fSocket.GetError();
  443. //no data isn't really an error in realtime processing, so just return 0
  444. if ( error == NET_NO_DATA )
  445. jack_error ( "No data, is the master still running ?" );
  446. //if a network error occurs, this exception will restart the driver
  447. else if ( error == NET_CONN_ERROR )
  448. {
  449. jack_error ( "Connection lost." );
  450. throw JackDriverException();
  451. }
  452. else
  453. jack_error ( "Fatal error in receive : %s", StrError ( NET_ERROR_CODE ) );
  454. }
  455. return rx_bytes;
  456. }
  457. int JackNetDriver::Send ( size_t size, int flags )
  458. {
  459. int tx_bytes = fSocket.Send ( fTxBuffer, size, flags );
  460. //handle errors
  461. if ( tx_bytes == SOCKET_ERROR )
  462. {
  463. net_error_t error = fSocket.GetError();
  464. //if a network error occurs, this exception will restart the driver
  465. if ( error == NET_CONN_ERROR )
  466. {
  467. jack_error ( "Connection lost." );
  468. throw JackDriverException();
  469. }
  470. else
  471. jack_error ( "Fatal error in send : %s", StrError ( NET_ERROR_CODE ) );
  472. }
  473. return tx_bytes;
  474. }
  475. //*************************************process************************************************************************
  476. int JackNetDriver::Read()
  477. {
  478. int rx_bytes;
  479. uint recvd_midi_pckt = 0;
  480. packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
  481. fRxHeader.fIsLastPckt = 'n';
  482. uint midi_port_index;
  483. int audio_port_index;
  484. //buffers
  485. for ( midi_port_index = 0; midi_port_index < fParams.fSendMidiChannels; midi_port_index++ )
  486. fNetMidiCaptureBuffer->SetBuffer ( midi_port_index, GetMidiInputBuffer ( midi_port_index ) );
  487. for ( audio_port_index = 0; audio_port_index < fCaptureChannels; audio_port_index++ )
  488. fNetAudioCaptureBuffer->SetBuffer ( audio_port_index, GetInputBuffer ( audio_port_index ) );
  489. #ifdef JACK_MONITOR
  490. fNetTimeMon->New();
  491. #endif
  492. //receive sync (launch the cycle)
  493. do
  494. {
  495. rx_bytes = Recv ( fParams.fMtu, 0 );
  496. //connection issue, send will detect it, so don't skip the cycle (return 0)
  497. if ( rx_bytes == SOCKET_ERROR )
  498. return 0;
  499. }
  500. while ( !rx_bytes && ( rx_head->fDataType != 's' ) );
  501. //take the time at the beginning of the cycle
  502. JackDriver::CycleTakeBeginTime();
  503. #ifdef JACK_MONITOR
  504. fCycleTimeMon->AddNew ( JackDriver::fBeginDateUst - fLastCycleBeginDate );
  505. fCycleTimeMon->Write();
  506. fLastCycleBeginDate = JackDriver::fBeginDateUst;
  507. #endif
  508. //audio, midi or sync if driver is late
  509. if ( fParams.fSendMidiChannels || fParams.fSendAudioChannels )
  510. {
  511. do
  512. {
  513. rx_bytes = Recv ( fParams.fMtu, MSG_PEEK );
  514. //error here, problem with recv, just skip the cycle (return -1)
  515. if ( rx_bytes == SOCKET_ERROR )
  516. return rx_bytes;
  517. if ( rx_bytes && ( rx_head->fDataStream == 's' ) && ( rx_head->fID == fParams.fID ) )
  518. {
  519. switch ( rx_head->fDataType )
  520. {
  521. case 'm': //midi
  522. rx_bytes = Recv ( rx_head->fPacketSize, 0 );
  523. fRxHeader.fCycle = rx_head->fCycle;
  524. fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
  525. fNetMidiCaptureBuffer->RenderFromNetwork ( rx_head->fSubCycle, rx_bytes - sizeof ( packet_header_t ) );
  526. if ( ++recvd_midi_pckt == rx_head->fNMidiPckt )
  527. fNetMidiCaptureBuffer->RenderToJackPorts();
  528. break;
  529. case 'a': //audio
  530. rx_bytes = Recv ( rx_head->fPacketSize, 0 );
  531. if ( !IsNextPacket ( &fRxHeader, rx_head, fNSubProcess ) )
  532. jack_error ( "Packet(s) missing..." );
  533. fRxHeader.fCycle = rx_head->fCycle;
  534. fRxHeader.fSubCycle = rx_head->fSubCycle;
  535. fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
  536. fNetAudioCaptureBuffer->RenderToJackPorts ( rx_head->fSubCycle );
  537. break;
  538. case 's': //sync
  539. jack_info ( "NetDriver : driver overloaded, skipping receive." );
  540. fRxHeader.fCycle = rx_head->fCycle;
  541. return 0;
  542. }
  543. }
  544. }
  545. while ( fRxHeader.fIsLastPckt != 'y' );
  546. }
  547. fRxHeader.fCycle = rx_head->fCycle;
  548. #ifdef JACK_MONITOR
  549. fNetTimeMon->Add ( ( ( float ) ( GetMicroSeconds() - JackDriver::fBeginDateUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
  550. #endif
  551. return 0;
  552. }
  553. int JackNetDriver::Write()
  554. {
  555. uint midi_port_index;
  556. int tx_bytes, audio_port_index;
  557. //tx header
  558. if ( fEngineControl->fSyncMode )
  559. fTxHeader.fCycle = fRxHeader.fCycle;
  560. else
  561. fTxHeader.fCycle++;
  562. fTxHeader.fSubCycle = 0;
  563. fTxHeader.fIsLastPckt = 'n';
  564. //buffers
  565. for ( midi_port_index = 0; midi_port_index < fParams.fReturnMidiChannels; midi_port_index++ )
  566. fNetMidiPlaybackBuffer->SetBuffer ( midi_port_index, GetMidiOutputBuffer ( midi_port_index ) );
  567. for ( audio_port_index = 0; audio_port_index < fPlaybackChannels; audio_port_index++ )
  568. fNetAudioPlaybackBuffer->SetBuffer ( audio_port_index, GetOutputBuffer ( audio_port_index ) );
  569. #ifdef JACK_MONITOR
  570. fNetTimeMon->Add ( ( ( float ) ( GetMicroSeconds() - JackDriver::fBeginDateUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
  571. #endif
  572. //sync
  573. fTxHeader.fDataType = 's';
  574. if ( !fParams.fSendMidiChannels && !fParams.fSendAudioChannels )
  575. fTxHeader.fIsLastPckt = 'y';
  576. fTxHeader.fPacketSize = fParams.fMtu;
  577. memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
  578. memset ( fTxData, 0, fPayloadSize );
  579. SetSyncPacket();
  580. tx_bytes = Send ( fTxHeader.fPacketSize, 0 );
  581. if ( tx_bytes == SOCKET_ERROR )
  582. return tx_bytes;
  583. #ifdef JACK_MONITOR
  584. fNetTimeMon->Add ( ( ( float ) ( GetMicroSeconds() - JackDriver::fBeginDateUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
  585. #endif
  586. //midi
  587. if ( fParams.fReturnMidiChannels )
  588. {
  589. fTxHeader.fDataType = 'm';
  590. fTxHeader.fMidiDataSize = fNetMidiPlaybackBuffer->RenderFromJackPorts();
  591. fTxHeader.fNMidiPckt = GetNMidiPckt ( &fParams, fTxHeader.fMidiDataSize );
  592. for ( uint subproc = 0; subproc < fTxHeader.fNMidiPckt; subproc++ )
  593. {
  594. fTxHeader.fSubCycle = subproc;
  595. if ( ( subproc == ( fTxHeader.fNMidiPckt - 1 ) ) && !fParams.fReturnAudioChannels )
  596. fTxHeader.fIsLastPckt = 'y';
  597. fTxHeader.fPacketSize = fNetMidiPlaybackBuffer->RenderToNetwork ( subproc, fTxHeader.fMidiDataSize );
  598. fTxHeader.fPacketSize += sizeof ( packet_header_t );
  599. memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
  600. tx_bytes = Send ( fTxHeader.fPacketSize, 0 );
  601. if ( tx_bytes == SOCKET_ERROR )
  602. return tx_bytes;
  603. }
  604. }
  605. //audio
  606. if ( fParams.fReturnAudioChannels )
  607. {
  608. fTxHeader.fDataType = 'a';
  609. for ( uint subproc = 0; subproc < fNSubProcess; subproc++ )
  610. {
  611. fTxHeader.fSubCycle = subproc;
  612. if ( subproc == ( fNSubProcess - 1 ) )
  613. fTxHeader.fIsLastPckt = 'y';
  614. fTxHeader.fPacketSize = fAudioTxLen;
  615. memcpy ( fTxBuffer, &fTxHeader, sizeof ( packet_header_t ) );
  616. fNetAudioPlaybackBuffer->RenderFromJackPorts ( subproc );
  617. tx_bytes = Send ( fTxHeader.fPacketSize, 0 );
  618. if ( tx_bytes == SOCKET_ERROR )
  619. return tx_bytes;
  620. }
  621. }
  622. #ifdef JACK_MONITOR
  623. fNetTimeMon->AddLast ( ( ( float ) ( GetMicroSeconds() - JackDriver::fBeginDateUst ) / ( float ) fEngineControl->fPeriodUsecs ) * 100.f );
  624. #endif
  625. return 0;
  626. }
  627. //*************************************loader*******************************************************
  628. #ifdef __cplusplus
  629. extern "C"
  630. {
  631. #endif
  632. EXPORT jack_driver_desc_t* driver_get_descriptor ()
  633. {
  634. jack_driver_desc_t* desc = ( jack_driver_desc_t* ) calloc ( 1, sizeof ( jack_driver_desc_t ) );
  635. strcpy ( desc->name, "net" );
  636. desc->nparams = 10;
  637. desc->params = ( jack_driver_param_desc_t* ) calloc ( desc->nparams, sizeof ( jack_driver_param_desc_t ) );
  638. int i = 0;
  639. strcpy ( desc->params[i].name, "multicast_ip" );
  640. desc->params[i].character = 'a';
  641. desc->params[i].type = JackDriverParamString;
  642. strcpy ( desc->params[i].value.str, DEFAULT_MULTICAST_IP );
  643. strcpy ( desc->params[i].short_desc, "Multicast Address" );
  644. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  645. i++;
  646. strcpy ( desc->params[i].name, "udp_net_port" );
  647. desc->params[i].character = 'p';
  648. desc->params[i].type = JackDriverParamInt;
  649. desc->params[i].value.i = 19000;
  650. strcpy ( desc->params[i].short_desc, "UDP port" );
  651. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  652. i++;
  653. strcpy ( desc->params[i].name, "mtu" );
  654. desc->params[i].character = 'M';
  655. desc->params[i].type = JackDriverParamInt;
  656. desc->params[i].value.i = 1500;
  657. strcpy ( desc->params[i].short_desc, "MTU to the master" );
  658. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  659. i++;
  660. strcpy ( desc->params[i].name, "input_ports" );
  661. desc->params[i].character = 'C';
  662. desc->params[i].type = JackDriverParamInt;
  663. desc->params[i].value.i = 2;
  664. strcpy ( desc->params[i].short_desc, "Number of audio input ports" );
  665. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  666. i++;
  667. strcpy ( desc->params[i].name, "output_ports" );
  668. desc->params[i].character = 'P';
  669. desc->params[i].type = JackDriverParamInt;
  670. desc->params[i].value.i = 2;
  671. strcpy ( desc->params[i].short_desc, "Number of audio output ports" );
  672. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  673. i++;
  674. strcpy ( desc->params[i].name, "midi_in_ports" );
  675. desc->params[i].character = 'i';
  676. desc->params[i].type = JackDriverParamInt;
  677. desc->params[i].value.i = 0;
  678. strcpy ( desc->params[i].short_desc, "Number of midi input ports" );
  679. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  680. i++;
  681. strcpy ( desc->params[i].name, "midi_out_ports" );
  682. desc->params[i].character = 'o';
  683. desc->params[i].type = JackDriverParamUInt;
  684. desc->params[i].value.i = 0;
  685. strcpy ( desc->params[i].short_desc, "Number of midi output ports" );
  686. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  687. i++;
  688. strcpy ( desc->params[i].name, "client_name" );
  689. desc->params[i].character = 'n';
  690. desc->params[i].type = JackDriverParamString;
  691. strcpy ( desc->params[i].value.str, "'hostname'" );
  692. strcpy ( desc->params[i].short_desc, "Name of the jack client" );
  693. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  694. i++;
  695. strcpy ( desc->params[i].name, "transport_sync" );
  696. desc->params[i].character = 't';
  697. desc->params[i].type = JackDriverParamUInt;
  698. desc->params[i].value.ui = 1U;
  699. strcpy ( desc->params[i].short_desc, "Sync transport with master's" );
  700. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  701. i++;
  702. strcpy ( desc->params[i].name, "network_mode" );
  703. desc->params[i].character = 'f';
  704. desc->params[i].type = JackDriverParamString;
  705. strcpy ( desc->params[i].value.str, "" );
  706. strcpy ( desc->params[i].short_desc, "Fast mode allows a zero latency transmission." );
  707. strcpy ( desc->params[i].long_desc, desc->params[i].short_desc );
  708. return desc;
  709. }
  710. EXPORT Jack::JackDriverClientInterface* driver_initialize ( Jack::JackLockedEngine* engine, Jack::JackSynchro* table, const JSList* params )
  711. {
  712. if ( SocketAPIInit() < 0 )
  713. {
  714. jack_error ( "Can't init Socket API, exiting..." );
  715. return NULL;
  716. }
  717. const char* multicast_ip = DEFAULT_MULTICAST_IP;
  718. char name[JACK_CLIENT_NAME_SIZE];
  719. GetHostName ( name, JACK_CLIENT_NAME_SIZE );
  720. int udp_port = DEFAULT_PORT;
  721. int mtu = 1500;
  722. uint transport_sync = 1;
  723. jack_nframes_t period_size = 128;
  724. jack_nframes_t sample_rate = 48000;
  725. int audio_capture_ports = 2;
  726. int audio_playback_ports = 2;
  727. int midi_input_ports = 0;
  728. int midi_output_ports = 0;
  729. bool monitor = false;
  730. char network_mode = 'n';
  731. const JSList* node;
  732. const jack_driver_param_t* param;
  733. for ( node = params; node; node = jack_slist_next ( node ) )
  734. {
  735. param = ( const jack_driver_param_t* ) node->data;
  736. switch ( param->character )
  737. {
  738. case 'a' :
  739. multicast_ip = strdup ( param->value.str );
  740. break;
  741. case 'p':
  742. udp_port = param->value.ui;
  743. break;
  744. case 'M':
  745. mtu = param->value.i;
  746. break;
  747. case 'C':
  748. audio_capture_ports = param->value.i;
  749. break;
  750. case 'P':
  751. audio_playback_ports = param->value.i;
  752. break;
  753. case 'i':
  754. midi_input_ports = param->value.i;
  755. break;
  756. case 'o':
  757. midi_output_ports = param->value.i;
  758. break;
  759. case 'n' :
  760. strncpy ( name, param->value.str, JACK_CLIENT_NAME_SIZE );
  761. break;
  762. case 't' :
  763. transport_sync = param->value.ui;
  764. break;
  765. case 'f' :
  766. network_mode = 'f';
  767. break;
  768. }
  769. }
  770. Jack::JackDriverClientInterface* driver = new Jack::JackWaitThreadedDriver (
  771. new Jack::JackNetDriver ( "system", "net_pcm", engine, table, multicast_ip, udp_port, mtu,
  772. midi_input_ports, midi_output_ports, name, transport_sync, network_mode ) );
  773. if ( driver->Open ( period_size, sample_rate, 1, 1, audio_capture_ports, audio_playback_ports,
  774. monitor, "from_master_", "to_master_", 0, 0 ) == 0 )
  775. return driver;
  776. delete driver;
  777. return NULL;
  778. }
  779. #ifdef __cplusplus
  780. }
  781. #endif
  782. }