JackNetInterface.cpp 39 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*
Copyright (C) 2001 Paul Davis
Copyright (C) 2008 Romain Moret at Grame

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "JackNetInterface.h"
#include "JackException.h"
22
#include "JackPlatformPlug.h"
23
#include <assert.h>
24
25
26

using namespace std;

sletz's avatar
sletz committed
27
#define PACKET_AVAILABLE_SIZE (fParams.fMtu - sizeof(packet_header_t))
sletz's avatar
sletz committed
28
#define HEADER_SIZE (sizeof(packet_header_t))
sletz's avatar
sletz committed
29

30
31
32
/*
 TODO : since midi buffers now uses up to BUFFER_SIZE_MAX frames,
 probably also use BUFFER_SIZE_MAX in everything related to MIDI events
33
34
35
 handling (see MidiBufferInit in JackMidiPort.cpp)
*/

36
37
38
39
namespace Jack
{
    // JackNetInterface*******************************************

40
41
    JackNetInterface::JackNetInterface() : fSocket()
    {
sletz's avatar
sletz committed
42
        Initialize();
43
44
    }

moret's avatar
moret committed
45
    JackNetInterface::JackNetInterface ( const char* multicast_ip, int port ) : fSocket ( multicast_ip, port )
46
    {
47
        strcpy(fMulticastIP, multicast_ip);
sletz's avatar
sletz committed
48
        Initialize();
49
50
    }

moret's avatar
moret committed
51
    JackNetInterface::JackNetInterface ( session_params_t& params, JackNetSocket& socket, const char* multicast_ip ) : fSocket ( socket )
52
    {
moret's avatar
moret committed
53
        fParams = params;
54
        strcpy(fMulticastIP, multicast_ip);
sletz's avatar
sletz committed
55
56
        Initialize();
    }
sletz's avatar
sletz committed
57

sletz's avatar
sletz committed
58
59
    void JackNetInterface::Initialize()
    {
60
61
62
63
64
65
        fTxBuffer = NULL;
        fRxBuffer = NULL;
        fNetAudioCaptureBuffer = NULL;
        fNetAudioPlaybackBuffer = NULL;
        fNetMidiCaptureBuffer = NULL;
        fNetMidiPlaybackBuffer = NULL;
66
67
        memset(&fSendTransportData, 0, sizeof(net_transport_data_t));
        memset(&fReturnTransportData, 0, sizeof(net_transport_data_t));
68
69
    }

sletz's avatar
sletz committed
70
71
72
73
74
75
76
77
78
79
80
    void JackNetInterface::FreeNetworkBuffers()
    {
        delete fNetMidiCaptureBuffer;
        delete fNetMidiPlaybackBuffer;
        delete fNetAudioCaptureBuffer;
        delete fNetAudioPlaybackBuffer;
        fNetMidiCaptureBuffer = NULL;
        fNetMidiPlaybackBuffer = NULL;
        fNetAudioCaptureBuffer = NULL;
        fNetAudioPlaybackBuffer = NULL;
    }
sletz's avatar
sletz committed
81

82
83
    JackNetInterface::~JackNetInterface()
    {
sletz's avatar
sletz committed
84
        jack_log ("JackNetInterface::~JackNetInterface");
moret's avatar
moret committed
85

86
87
88
89
90
91
92
93
94
        fSocket.Close();
        delete[] fTxBuffer;
        delete[] fRxBuffer;
        delete fNetAudioCaptureBuffer;
        delete fNetAudioPlaybackBuffer;
        delete fNetMidiCaptureBuffer;
        delete fNetMidiPlaybackBuffer;
    }

moret's avatar
moret committed
95
96
97
    int JackNetInterface::SetNetBufferSize()
    {
        //audio
sletz's avatar
sletz committed
98
99
        float audio_size = (fNetAudioCaptureBuffer)
                            ? fNetAudioCaptureBuffer->GetCycleSize()
sletz's avatar
sletz committed
100
101
                            : (fNetAudioPlaybackBuffer) ? fNetAudioPlaybackBuffer->GetCycleSize() : 0;
        jack_log ("audio_size %f", audio_size);
sletz's avatar
sletz committed
102

moret's avatar
moret committed
103
        //midi
sletz's avatar
sletz committed
104
105
        float midi_size = (fNetMidiCaptureBuffer)
                            ? fNetMidiCaptureBuffer->GetCycleSize()
sletz's avatar
sletz committed
106
107
                            : (fNetMidiPlaybackBuffer) ? fNetMidiPlaybackBuffer->GetCycleSize() : 0;
        jack_log ("midi_size %f", midi_size);
sletz's avatar
sletz committed
108

moret's avatar
moret committed
109
        //bufsize = sync + audio + midi
sletz's avatar
sletz committed
110
        int bufsize = MAX_LATENCY * (fParams.fMtu + (int)audio_size + (int) midi_size);
sletz's avatar
sletz committed
111
        jack_log("SetNetBufferSize bufsize = %d", bufsize);
moret's avatar
moret committed
112
113

        //tx buffer
sletz's avatar
sletz committed
114
        if (fSocket.SetOption(SOL_SOCKET, SO_SNDBUF, &bufsize, sizeof(bufsize)) == SOCKET_ERROR)
115
            return SOCKET_ERROR;
moret's avatar
moret committed
116
117

        //rx buffer
sletz's avatar
sletz committed
118
        if (fSocket.SetOption(SOL_SOCKET, SO_RCVBUF, &bufsize, sizeof(bufsize)) == SOCKET_ERROR)
119
            return SOCKET_ERROR;
moret's avatar
moret committed
120

121
        return 0;
moret's avatar
moret committed
122
123
    }

sletz's avatar
sletz committed
124
    bool JackNetInterface::SetParams()
moret's avatar
moret committed
125
    {
126
127
128
129
130
        //TX header init
        strcpy ( fTxHeader.fPacketType, "header" );
        fTxHeader.fID = fParams.fID;
        fTxHeader.fCycle = 0;
        fTxHeader.fSubCycle = 0;
moret's avatar
moret committed
131
        fTxHeader.fIsLastPckt = 0;
132
133
134
135
136
137

        //RX header init
        strcpy ( fRxHeader.fPacketType, "header" );
        fRxHeader.fID = fParams.fID;
        fRxHeader.fCycle = 0;
        fRxHeader.fSubCycle = 0;
moret's avatar
moret committed
138
        fRxHeader.fIsLastPckt = 0;
139
140
141
142

        //network buffers
        fTxBuffer = new char[fParams.fMtu];
        fRxBuffer = new char[fParams.fMtu];
143
144
        assert ( fTxBuffer );
        assert ( fRxBuffer );
145

moret's avatar
moret committed
146
        //net audio/midi buffers'addresses
sletz's avatar
sletz committed
147
148
        fTxData = fTxBuffer + HEADER_SIZE;
        fRxData = fRxBuffer + HEADER_SIZE;
sletz's avatar
sletz committed
149

sletz's avatar
sletz committed
150
        return true;
151
152
    }

153
    // JackNetMasterInterface ************************************************************************************
154

155
    bool JackNetMasterInterface::Init()
156
    {
157
        jack_log ( "JackNetMasterInterface::Init, ID %u.", fParams.fID );
158

159
        session_params_t host_params;
160
        uint attempt = 0;
161
162
163
        int rx_bytes = 0;

        //socket
164
        if ( fSocket.NewSocket() == SOCKET_ERROR ) {
165
166
            jack_error ( "Can't create socket : %s", StrError ( NET_ERROR_CODE ) );
            return false;
167
168
        }

169
        //timeout on receive (for init)
170
        if ( fSocket.SetTimeOut ( MASTER_INIT_TIMEOUT ) < 0 )
171
            jack_error ( "Can't set timeout : %s", StrError ( NET_ERROR_CODE ) );
172

173
        //connect
174
        if ( fSocket.Connect() == SOCKET_ERROR ) {
175
176
177
            jack_error ( "Can't connect : %s", StrError ( NET_ERROR_CODE ) );
            return false;
        }
178

179
        //send 'SLAVE_SETUP' until 'START_MASTER' received
sletz's avatar
sletz committed
180
        jack_info ( "Sending parameters to %s...", fParams.fSlaveNetName );
181
182
        do
        {
183
            session_params_t net_params;
184
            memset(&net_params, 0, sizeof ( session_params_t ));
185
            SetPacketType ( &fParams, SLAVE_SETUP );
186
            SessionParamsHToN(&fParams, &net_params);
187

188
            if ( fSocket.Send ( &net_params, sizeof ( session_params_t ), 0 ) == SOCKET_ERROR )
189
                jack_error ( "Error in send : ", StrError ( NET_ERROR_CODE ) );
190

sletz's avatar
sletz committed
191
192
            memset(&net_params, 0, sizeof (session_params_t));
            if (((rx_bytes = fSocket.Recv(&net_params, sizeof(session_params_t), 0)) == SOCKET_ERROR) && (fSocket.GetError() != NET_NO_DATA))
193
            {
194
195
                jack_error ( "Problem with network." );
                return false;
196
            }
197

198
            SessionParamsNToH(&net_params, &host_params);
199
        }
200
        while ( ( GetPacketType ( &host_params ) != START_MASTER ) && ( ++attempt < SLAVE_SETUP_RETRY ) );
201
        if ( attempt == SLAVE_SETUP_RETRY ) {
202
203
            jack_error ( "Slave doesn't respond, exiting." );
            return false;
204
205
        }

206
        return true;
207
208
    }

moret's avatar
moret committed
209
210
    int JackNetMasterInterface::SetRxTimeout()
    {
moret's avatar
moret committed
211
212
        jack_log ( "JackNetMasterInterface::SetRxTimeout" );

moret's avatar
moret committed
213
        float time = 0;
sletz's avatar
sletz committed
214

moret's avatar
moret committed
215
        //slow or normal mode, short timeout on recv (2 audio subcycles)
sletz's avatar
sletz committed
216
        if ((fParams.fNetworkMode == 's') || (fParams.fNetworkMode == 'n')) {
sletz's avatar
sletz committed
217
218
            time = 2000000.f * ((fNetAudioCaptureBuffer)
                                ? fNetAudioCaptureBuffer->GetCycleDuration()
sletz's avatar
sletz committed
219
220
                                : (fNetAudioPlaybackBuffer) ? fNetAudioPlaybackBuffer->GetCycleDuration() : 0);
        }
moret's avatar
moret committed
221
        //fast mode, wait for 75% of the entire cycle duration
sletz's avatar
sletz committed
222
223
224
        else if (fParams.fNetworkMode == 'f') {
            time = 750000.f * (static_cast<float>(fParams.fPeriodSize) / static_cast<float>(fParams.fSampleRate));
        }
sletz's avatar
sletz committed
225

sletz's avatar
sletz committed
226
        return fSocket.SetTimeOut (static_cast<int>(time));
moret's avatar
moret committed
227
228
    }

sletz's avatar
sletz committed
229
    bool JackNetMasterInterface::SetParams()
moret's avatar
moret committed
230
    {
sletz's avatar
sletz committed
231
        jack_log("JackNetMasterInterface::SetParams");
moret's avatar
moret committed
232
233
234

        JackNetInterface::SetParams();

235
236
        fTxHeader.fDataStream = 's';
        fRxHeader.fDataStream = 'r';
moret's avatar
moret committed
237
238

        //midi net buffers
sletz's avatar
sletz committed
239
240
        if (fParams.fSendMidiChannels)
            fNetMidiCaptureBuffer = new NetMidiBuffer(&fParams, fParams.fSendMidiChannels, fTxData);
sletz's avatar
sletz committed
241

sletz's avatar
sletz committed
242
243
        if (fParams.fReturnMidiChannels)
            fNetMidiPlaybackBuffer = new NetMidiBuffer(&fParams, fParams.fReturnMidiChannels, fRxData);
sletz's avatar
sletz committed
244

sletz's avatar
sletz committed
245
        try {
sletz's avatar
sletz committed
246

247
248
            //audio net buffers
            if (fParams.fSendAudioChannels) {
sletz's avatar
sletz committed
249

250
                switch (fParams.fSampleEncoder) {
sletz's avatar
sletz committed
251

252
                    case JackFloatEncoder:
sletz's avatar
sletz committed
253
                        fNetAudioCaptureBuffer = new NetFloatAudioBuffer(&fParams, fParams.fSendAudioChannels, fTxData);
254
                        break;
sletz's avatar
sletz committed
255

256
                    case JackIntEncoder:
sletz's avatar
sletz committed
257
                        fNetAudioCaptureBuffer = new NetIntAudioBuffer(&fParams, fParams.fSendAudioChannels, fTxData);
258
                        break;
sletz's avatar
sletz committed
259

260
261
                    case JackCeltEncoder:
                    #ifdef CELT
sletz's avatar
sletz committed
262
                        fNetAudioCaptureBuffer = new NetCeltAudioBuffer(&fParams, fParams.fSendAudioChannels, fTxData, fParams.fKBps);
263
264
265
266
                    #endif
                        break;
                }
            }
sletz's avatar
sletz committed
267

sletz's avatar
sletz committed
268
269
            assert(fNetAudioCaptureBuffer);

270
            if (fParams.fReturnAudioChannels) {
sletz's avatar
sletz committed
271

272
                switch (fParams.fSampleEncoder) {
sletz's avatar
sletz committed
273

274
                    case JackFloatEncoder:
sletz's avatar
sletz committed
275
                        fNetAudioPlaybackBuffer = new NetFloatAudioBuffer(&fParams, fParams.fReturnAudioChannels, fRxData);
276
                        break;
sletz's avatar
sletz committed
277

278
                    case JackIntEncoder:
sletz's avatar
sletz committed
279
                        fNetAudioPlaybackBuffer = new NetIntAudioBuffer(&fParams, fParams.fReturnAudioChannels, fRxData);
280
                        break;
sletz's avatar
sletz committed
281

282
283
                    case JackCeltEncoder:
                    #ifdef CELT
sletz's avatar
sletz committed
284
                        fNetAudioPlaybackBuffer = new NetCeltAudioBuffer(&fParams, fParams.fReturnAudioChannels, fRxData, fParams.fKBps);
285
286
287
288
                    #endif
                        break;
                }
            }
sletz's avatar
sletz committed
289

sletz's avatar
sletz committed
290
291
             assert(fNetAudioPlaybackBuffer);

sletz's avatar
sletz committed
292
293
294
295
        } catch (exception&) {
            jack_error("NetAudioBuffer allocation error...");
            return false;
        }
moret's avatar
moret committed
296

sletz's avatar
sletz committed
297
        //set the new timeout for the socket
sletz's avatar
sletz committed
298
299
        if (SetRxTimeout() == SOCKET_ERROR) {
            jack_error("Can't set rx timeout : %s", StrError(NET_ERROR_CODE));
sletz's avatar
sletz committed
300
301
            goto error;
        }
moret's avatar
moret committed
302

sletz's avatar
sletz committed
303
        //set the new rx buffer size
sletz's avatar
sletz committed
304
305
        if (SetNetBufferSize() == SOCKET_ERROR) {
            jack_error("Can't set net buffer sizes : %s", StrError(NET_ERROR_CODE));
sletz's avatar
sletz committed
306
307
            goto error;
        }
sletz's avatar
sletz committed
308

sletz's avatar
sletz committed
309
        return true;
sletz's avatar
sletz committed
310

sletz's avatar
sletz committed
311
    error:
sletz's avatar
sletz committed
312
        FreeNetworkBuffers();
sletz's avatar
sletz committed
313
        return false;
moret's avatar
moret committed
314
315
    }

316
    void JackNetMasterInterface::Exit()
317
    {
318
319
320
321
        jack_log ( "JackNetMasterInterface::Exit, ID %u", fParams.fID );

        //stop process
        fRunning = false;
322

323
324
325
326
        //send a 'multicast euthanasia request' - new socket is required on macosx
        jack_info ( "Exiting '%s'", fParams.fName );
        SetPacketType ( &fParams, KILL_MASTER );
        JackNetSocket mcast_socket ( fMulticastIP, fSocket.GetPort() );
327

328
        session_params_t net_params;
329
        memset(&net_params, 0, sizeof ( session_params_t ));
330
331
        SessionParamsHToN(&fParams, &net_params);

332
333
        if ( mcast_socket.NewSocket() == SOCKET_ERROR )
            jack_error ( "Can't create socket : %s", StrError ( NET_ERROR_CODE ) );
334
        if ( mcast_socket.SendTo ( &net_params, sizeof ( session_params_t ), 0, fMulticastIP ) == SOCKET_ERROR )
335
            jack_error ( "Can't send suicide request : %s", StrError ( NET_ERROR_CODE ) );
336

337
338
339
        mcast_socket.Close();
    }

sletz's avatar
sletz committed
340
    int JackNetMasterInterface::Recv(size_t size, int flags)
341
    {
342
        int rx_bytes;
sletz's avatar
sletz committed
343

sletz's avatar
sletz committed
344
        if ((( rx_bytes = fSocket.Recv(fRxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
345
            net_error_t error = fSocket.GetError();
sletz's avatar
sletz committed
346
            //no data isn't really a network error, so just return 0 available read bytes
sletz's avatar
sletz committed
347
            if (error == NET_NO_DATA) {
348
                return 0;
sletz's avatar
sletz committed
349
            } else if (error == NET_CONN_ERROR) {
350
                //fatal connection issue, exit
sletz's avatar
sletz committed
351
                jack_error ( "'%s' : %s, exiting.", fParams.fName, StrError(NET_ERROR_CODE));
352
                //ask to the manager to properly remove the master
353
                Exit();
354

355
356
                // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
                ThreadExit();
sletz's avatar
sletz committed
357
358
            } else {
                jack_error ( "Error in master receive : %s", StrError(NET_ERROR_CODE));
359
360
            }
        }
361

362
363
364
        packet_header_t* header = reinterpret_cast<packet_header_t*>(fRxBuffer);
        PacketHeaderNToH(header, header);
        return rx_bytes;
365
    }
366

sletz's avatar
sletz committed
367
    int JackNetMasterInterface::Send(size_t size, int flags)
368
    {
369
370
371
        int tx_bytes;
        packet_header_t* header = reinterpret_cast<packet_header_t*>(fTxBuffer);
        PacketHeaderHToN(header, header);
372

sletz's avatar
sletz committed
373
        if (((tx_bytes = fSocket.Send(fTxBuffer, size, flags)) == SOCKET_ERROR) && fRunning) {
374
            net_error_t error = fSocket.GetError();
sletz's avatar
sletz committed
375
            if (error == NET_CONN_ERROR) {
376
                //fatal connection issue, exit
sletz's avatar
sletz committed
377
                jack_error ("'%s' : %s, exiting.", fParams.fName, StrError (NET_ERROR_CODE));
378
                Exit();
379

380
381
                // UGLY temporary way to be sure the thread does not call code possibly causing a deadlock in JackEngine.
                ThreadExit();
sletz's avatar
sletz committed
382
383
            } else {
                jack_error("Error in master send : %s", StrError(NET_ERROR_CODE));
384
385
            }
        }
386
        return tx_bytes;
387
    }
388

389
390
    bool JackNetMasterInterface::IsSynched()
    {
sletz's avatar
sletz committed
391
        if (fParams.fNetworkMode == 's') {
392
            return (fCycleOffset < (CYCLE_OFFSET_SLOW + 1));
sletz's avatar
sletz committed
393
        } else {
394
            return true;
sletz's avatar
sletz committed
395
        }
396
    }
397

398
    int JackNetMasterInterface::SyncSend()
399
    {
400
401
402
        fTxHeader.fCycle++;
        fTxHeader.fSubCycle = 0;
        fTxHeader.fDataType = 's';
sletz's avatar
sletz committed
403
        fTxHeader.fIsLastPckt = (fParams.fSendMidiChannels == 0 && fParams.fSendAudioChannels == 0) ?  1 : 0;
sletz's avatar
sletz committed
404
        fTxHeader.fPacketSize = HEADER_SIZE;
sletz's avatar
sletz committed
405

sletz's avatar
sletz committed
406
407
        memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
        return Send(fTxHeader.fPacketSize, 0);
408
409
410
411
412
    }

    int JackNetMasterInterface::DataSend()
    {
        uint subproc;
sletz's avatar
sletz committed
413
414
        uint data_size;

415
        //midi
sletz's avatar
sletz committed
416
        if (fParams.fSendMidiChannels > 0)
417
        {
418
419
            //set global header fields and get the number of midi packets
            fTxHeader.fDataType = 'm';
sletz's avatar
sletz committed
420
421
            data_size = fNetMidiCaptureBuffer->RenderFromJackPorts();
            fTxHeader.fNumPacket = fNetMidiCaptureBuffer->GetNumPackets();
sletz's avatar
sletz committed
422

sletz's avatar
sletz committed
423
            for ( subproc = 0; subproc < fTxHeader.fNumPacket; subproc++ )
424
            {
425
                fTxHeader.fSubCycle = subproc;
sletz's avatar
sletz committed
426
427
                fTxHeader.fIsLastPckt = ((subproc == (fTxHeader.fNumPacket - 1)) && (fParams.fSendAudioChannels == 0)) ? 1 : 0;
                fTxHeader.fPacketSize = HEADER_SIZE + fNetMidiCaptureBuffer->RenderToNetwork(subproc, data_size);
sletz's avatar
sletz committed
428
429
                memcpy ( fTxBuffer, &fTxHeader, HEADER_SIZE);
                if (Send (fTxHeader.fPacketSize, 0) == SOCKET_ERROR)
430
                    return SOCKET_ERROR;
431
432
            }
        }
433
434

        //audio
sletz's avatar
sletz committed
435
        if (fParams.fSendAudioChannels > 0)
436
437
        {
            fTxHeader.fDataType = 'a';
sletz's avatar
sletz committed
438
439
            data_size = fNetAudioCaptureBuffer->RenderFromJackPorts();
            fTxHeader.fNumPacket = fNetAudioCaptureBuffer->GetNumPackets();
sletz's avatar
sletz committed
440

sletz's avatar
sletz committed
441
            for (subproc = 0; subproc < fTxHeader.fNumPacket; subproc++)
442
443
            {
                fTxHeader.fSubCycle = subproc;
sletz's avatar
sletz committed
444
445
                fTxHeader.fIsLastPckt = (subproc == (fTxHeader.fNumPacket - 1)) ? 1 : 0;
                fTxHeader.fPacketSize = HEADER_SIZE + fNetAudioCaptureBuffer->RenderToNetwork(subproc, data_size);
sletz's avatar
sletz committed
446
447
                memcpy(fTxBuffer, &fTxHeader, HEADER_SIZE);
                if (Send(fTxHeader.fPacketSize, 0) == SOCKET_ERROR)
448
449
450
451
452
                    return SOCKET_ERROR;
            }
        }

        return 0;
453
454
    }

455
    int JackNetMasterInterface::SyncRecv()
456
457
    {
        packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
sletz's avatar
sletz committed
458
        int rx_bytes = Recv(HEADER_SIZE, MSG_PEEK);
459

460
461
462
        if ( ( rx_bytes == 0 ) || ( rx_bytes == SOCKET_ERROR ) )
            return rx_bytes;

463
        fCycleOffset = fTxHeader.fCycle - rx_head->fCycle;
464

465
        switch ( fParams.fNetworkMode )
466
        {
467
            case 's' :
moret's avatar
moret committed
468
469
470
471
472
                //slow mode : allow to use full bandwidth and heavy process on the slave
                //  - extra latency is set to two cycles, one cycle for send/receive operations + one cycle for heavy process on the slave
                //  - if the network is two fast, just wait the next cycle, this mode allows a shorter cycle duration for the master
                //  - this mode will skip the two first cycles, thus it lets time for data to be processed and queued on the socket rx buffer
                //the slow mode is the safest mode because it wait twice the bandwidth relative time (send/return + process)
473

sletz's avatar
sletz committed
474
                /*
sletz's avatar
sletz committed
475
476
477
478
479
480
                 if (fCycleOffset < CYCLE_OFFSET_SLOW) {
                 return 0;
                 } else {
                 rx_bytes = Recv ( rx_head->fPacketSize, 0 );
                 }
                 */
sletz's avatar
sletz committed
481

sletz's avatar
sletz committed
482
                rx_bytes = Recv ( rx_head->fPacketSize, 0 );
sletz's avatar
sletz committed
483

sletz's avatar
sletz committed
484
                if (fCycleOffset != fLastfCycleOffset)
485
                    jack_info("Warning : '%s' runs in slow network mode, but data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
sletz's avatar
sletz committed
486
                fLastfCycleOffset = fCycleOffset;
487
                break;
488

489
490
491
492
493
            case 'n' :
                //normal use of the network :
                //  - extra latency is set to one cycle, what is the time needed to receive streams using full network bandwidth
                //  - if the network is too fast, just wait the next cycle, the benefit here is the master's cycle is shorter
                //  - indeed, data is supposed to be on the network rx buffer, so we don't have to wait for it
sletz's avatar
sletz committed
494
                if (fCycleOffset < CYCLE_OFFSET_NORMAL) {
495
                    return 0;
sletz's avatar
sletz committed
496
                } else {
497
                    rx_bytes = Recv ( rx_head->fPacketSize, 0 );
sletz's avatar
sletz committed
498
                }
499

sletz's avatar
sletz committed
500
                if (fCycleOffset > CYCLE_OFFSET_NORMAL)  {
501
                    jack_info("'%s' can't run in normal network mode, data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
sletz's avatar
sletz committed
502
                }
503
                break;
504

505
506
507
508
509
510
            case 'f' :
                //fast mode suppose the network bandwith is larger than required for the transmission (only a few channels for example)
                //    - packets can be quickly received, quickly is here relative to the cycle duration
                //    - here, receive data, we can't keep it queued on the rx buffer,
                //    - but if there is a cycle offset, tell the user, that means we're not in fast mode anymore, network is too slow
                rx_bytes = Recv ( rx_head->fPacketSize, 0 );
511

sletz's avatar
sletz committed
512
                if (fCycleOffset > CYCLE_OFFSET_FAST) {
513
                    jack_info("'%s' can't run in fast network mode, data received too late (%d cycle(s) offset)", fParams.fName, fCycleOffset);
sletz's avatar
sletz committed
514
                }
515
516
                break;
                break;
517
        }
518

moret's avatar
moret committed
519
        fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
520
521
        return rx_bytes;
    }
522

523
    int JackNetMasterInterface::DataRecv()
524
525
    {
        int rx_bytes = 0;
526
        uint recvd_midi_pckt = 0;
527
        packet_header_t* rx_head = reinterpret_cast<packet_header_t*> ( fRxBuffer );
528

moret's avatar
moret committed
529
        while ( !fRxHeader.fIsLastPckt )
530
        {
moret's avatar
moret committed
531
            //how much data is queued on the rx buffer ?
sletz's avatar
sletz committed
532
            rx_bytes = Recv(HEADER_SIZE, MSG_PEEK);
533

sletz's avatar
sletz committed
534
            //error here, problem with recv, just skip the cycle (return -1)
moret's avatar
moret committed
535
536
            if ( rx_bytes == SOCKET_ERROR )
                return rx_bytes;
sletz's avatar
sletz committed
537

moret's avatar
moret committed
538
539
540
541
            if ( rx_bytes && ( rx_head->fDataStream == 'r' ) && ( rx_head->fID == fParams.fID ) )
            {
                //read data
                switch ( rx_head->fDataType )
542
                {
moret's avatar
moret committed
543
                    case 'm':   //midi
sletz's avatar
sletz committed
544
                        rx_bytes = Recv(rx_head->fPacketSize, 0);
moret's avatar
moret committed
545
                        fRxHeader.fCycle = rx_head->fCycle;
moret's avatar
moret committed
546
                        fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
sletz's avatar
sletz committed
547
                        fNetMidiPlaybackBuffer->RenderFromNetwork(rx_head->fSubCycle, rx_bytes - HEADER_SIZE);
sletz's avatar
sletz committed
548
549
                        // Last midi packet is received, so finish rendering...
                        if (++recvd_midi_pckt == rx_head->fNumPacket)
moret's avatar
moret committed
550
551
                            fNetMidiPlaybackBuffer->RenderToJackPorts();
                        break;
552

moret's avatar
moret committed
553
                    case 'a':   //audio
sletz's avatar
sletz committed
554
                        rx_bytes = Recv(rx_head->fPacketSize, 0);
moret's avatar
moret committed
555
556
                        fRxHeader.fCycle = rx_head->fCycle;
                        fRxHeader.fSubCycle = rx_head->fSubCycle;
moret's avatar
moret committed
557
                        fRxHeader.fIsLastPckt = rx_head->fIsLastPckt;
sletz's avatar
sletz committed
558
                        fNetAudioPlaybackBuffer->RenderFromNetwork(rx_head->fCycle, rx_head->fSubCycle, rx_bytes - HEADER_SIZE);
sletz's avatar
sletz committed
559
560
                        // Last audio packet is received, so finish rendering...
                        if (fRxHeader.fIsLastPckt)
sletz's avatar
sletz committed
561
                            fNetAudioPlaybackBuffer->RenderToJackPorts();
moret's avatar
moret committed
562
                        break;
563

moret's avatar
moret committed
564
                    case 's':   //sync
565
                        jack_info("NetMaster : overloaded, skipping receive from '%s'", fParams.fName);
sletz's avatar
sletz committed
566
                        // TODO : finish midi and audio rendering ?
sletz's avatar
sletz committed
567
                        fNetAudioPlaybackBuffer->RenderToJackPorts();
568
                        return 0;
569
570
571
                }
            }
        }
sletz's avatar
sletz committed
572

573
        return rx_bytes;
574
    }
575

576
    void JackNetMasterInterface::EncodeSyncPacket()
577
578
579
    {
        //this method contains every step of sync packet informations coding
        //first of all, reset sync packet
sletz's avatar
sletz committed
580
        memset ( fTxData, 0, PACKET_AVAILABLE_SIZE );
581
582

        //then, first step : transport
583
584
        if (fParams.fTransportSync) {
            EncodeTransportData();
585
            TransportDataHToN( &fSendTransportData,  &fSendTransportData);
586
587
588
589
590
591
592
            //copy to TxBuffer
            memcpy ( fTxData, &fSendTransportData, sizeof ( net_transport_data_t ) );
        }
        //then others (freewheel etc.)
        //...
    }

593
    void JackNetMasterInterface::DecodeSyncPacket()
594
595
596
    {
        //this method contains every step of sync packet informations decoding process
        //first : transport
597
        if (fParams.fTransportSync) {
598
599
            //copy received transport data to transport data structure
            memcpy ( &fReturnTransportData, fRxData, sizeof ( net_transport_data_t ) );
600
            TransportDataNToH( &fReturnTransportData,  &fReturnTransportData);
601
            DecodeTransportData();
602
603
604
605
        }
        //then others
        //...
    }
606

607
608
// JackNetSlaveInterface ************************************************************************************************

moret's avatar
moret committed
609
610
    uint JackNetSlaveInterface::fSlaveCounter = 0;

611
    bool JackNetSlaveInterface::Init()
612
    {
613
        jack_log ( "JackNetSlaveInterface::Init()" );
614

615
616
        //set the parameters to send
        strcpy ( fParams.fPacketType, "params" );
617
        fParams.fProtocolVersion = SLAVE_PROTOCOL;
618
        SetPacketType ( &fParams, SLAVE_AVAILABLE );
619

620
621
622
        //init loop : get a master and start, do it until connection is ok
        net_status_t status;
        do
623
        {
624
625
            //first, get a master, do it until a valid connection is running
            do
626
            {
627
                status = SendAvailableToMaster();
628
629
                if ( status == NET_SOCKET_ERROR )
                    return false;
630
            }
631
            while ( status != NET_CONNECTED );
632

633
634
            //then tell the master we are ready
            jack_info ( "Initializing connection with %s...", fParams.fMasterNetName );
moret's avatar
moret committed
635
            status = SendStartToMaster();
636
637
            if ( status == NET_ERROR )
                return false;
638
        }
639
        while ( status != NET_ROLLING );
640

641
642
        return true;
    }
643

644
    // Separate the connection protocol into two separated step
sletz's avatar
sletz committed
645
    bool JackNetSlaveInterface::InitConnection(int time_out)
646
    {
sletz's avatar
sletz committed
647
648
        jack_log("JackNetSlaveInterface::InitConnection()");
        int try_count = (time_out > 0) ? ((1000000 * time_out) / SLAVE_INIT_TIMEOUT) : LONG_MAX;
649
650
651
652
653
654
655
656
657
658

        //set the parameters to send
        strcpy (fParams.fPacketType, "params");
        fParams.fProtocolVersion = SLAVE_PROTOCOL;
        SetPacketType (&fParams, SLAVE_AVAILABLE);

        net_status_t status;
        do
        {
            //get a master
sletz's avatar
sletz committed
659
            status = SendAvailableToMaster(try_count);
660
661
662
            if (status == NET_SOCKET_ERROR)
                return false;
        }
sletz's avatar
sletz committed
663
        while (status != NET_CONNECTED && --try_count > 0);
664

sletz's avatar
sletz committed
665
        return (try_count != 0);
666
    }
667

668
669
670
671
672
673
674
675
676
677
678
679
680
    bool JackNetSlaveInterface::InitRendering()
    {
        jack_log("JackNetSlaveInterface::InitRendering()");

        net_status_t status;
        do
        {
            //then tell the master we are ready
            jack_info("Initializing connection with %s...", fParams.fMasterNetName);
            status = SendStartToMaster();
            if (status == NET_ERROR)
                return false;
        }
681
682
        while (status != NET_ROLLING);

683
684
        return true;
    }
685

sletz's avatar
sletz committed
686
    net_status_t JackNetSlaveInterface::SendAvailableToMaster(long try_count)
687
    {
688
        jack_log ( "JackNetSlaveInterface::SendAvailableToMaster()" );
689
        //utility
690
        session_params_t host_params;
691
692
693
        int rx_bytes = 0;

        //socket
694
        if ( fSocket.NewSocket() == SOCKET_ERROR ) {
695
696
            jack_error ( "Fatal error : network unreachable - %s", StrError ( NET_ERROR_CODE ) );
            return NET_SOCKET_ERROR;
697
698
        }

699
        //bind the socket
700
        if ( fSocket.Bind() == SOCKET_ERROR ) {
701
            jack_error ( "Can't bind the socket : %s", StrError ( NET_ERROR_CODE ) );
702
703
            return NET_SOCKET_ERROR;
        }
704
705

        //timeout on receive
706
        if ( fSocket.SetTimeOut ( SLAVE_INIT_TIMEOUT ) == SOCKET_ERROR )
707
708
            jack_error ( "Can't set timeout : %s", StrError ( NET_ERROR_CODE ) );

709
        //disable local loop
moret's avatar
moret committed
710
        if ( fSocket.SetLocalLoop() == SOCKET_ERROR )
711
            jack_error ( "Can't disable multicast loop : %s", StrError ( NET_ERROR_CODE ) );
712

713
714
        //send 'AVAILABLE' until 'SLAVE_SETUP' received
        jack_info ( "Waiting for a master..." );
715
716
        do
        {
717
            //send 'available'
718
            session_params_t net_params;
719
            memset(&net_params, 0, sizeof ( session_params_t ));
720
721
            SessionParamsHToN(&fParams, &net_params);
            if ( fSocket.SendTo ( &net_params, sizeof ( session_params_t ), 0, fMulticastIP ) == SOCKET_ERROR )
722
                jack_error ( "Error in data send : %s", StrError ( NET_ERROR_CODE ) );
723

724
            //filter incoming packets : don't exit while no error is detected
725
726
727
            memset(&net_params, 0, sizeof ( session_params_t ));
            rx_bytes = fSocket.CatchHost ( &net_params, sizeof ( session_params_t ), 0 );
            SessionParamsNToH(&net_params, &host_params);
728
            if ( ( rx_bytes == SOCKET_ERROR ) && ( fSocket.GetError() != NET_NO_DATA ) )
729
            {
730
731
                jack_error ( "Can't receive : %s", StrError ( NET_ERROR_CODE ) );
                return NET_RECV_ERROR;
732
733
            }
        }
sletz's avatar
sletz committed
734
        while (strcmp(host_params.fPacketType, fParams.fPacketType)  && (GetPacketType(&host_params) != SLAVE_SETUP)  && (--try_count > 0));
sletz's avatar
sletz committed
735

sletz's avatar
sletz committed
736
        // Time out failure..
sletz's avatar
sletz committed
737
738
        if (try_count == 0) {
            jack_error("Time out error in connect");
sletz's avatar
sletz committed
739
740
            return NET_CONNECT_ERROR;
        }
741

moret's avatar
moret committed
742
        //everything is OK, copy parameters
sletz's avatar
sletz committed
743
        SessionParamsDisplay(&host_params);
744
        fParams = host_params;
moret's avatar
moret committed
745

746
        //connect the socket
sletz's avatar
sletz committed
747
748
        if (fSocket.Connect() == SOCKET_ERROR) {
            jack_error("Error in connect : %s", StrError(NET_ERROR_CODE));
749
            return NET_CONNECT_ERROR;
750
        }
moret's avatar
moret committed
751
        return NET_CONNECTED;
752
753
    }

moret's avatar
moret committed
754
    net_status_t JackNetSlaveInterface::SendStartToMaster()
755
    {
sletz's avatar
sletz committed
756
        jack_log("JackNetSlaveInterface::SendStartToMaster");
moret's avatar
moret committed
757

758
        //tell the master to start
759
        session_params_t net_params;
760
        memset(&net_params, 0, sizeof ( session_params_t ));
761
        SetPacketType ( &fParams, START_MASTER );
762
        SessionParamsHToN(&fParams, &net_params);
sletz's avatar
sletz committed
763
        if (fSocket.Send(&net_params, sizeof(session_params_t), 0) == SOCKET_ERROR)
764
        {
sletz's avatar
sletz committed
765
766