JackNetTool.h 28.6 KB
Newer Older
1
/*
sletz's avatar
sletz committed
2
Copyright (C) 2008-2011 Romain Moret at Grame
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

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.

*/
sletz's avatar
sletz committed
19
20

#include "JackMidiPort.h"
21
#include "JackTools.h"
22
#include "JackPlatformPlug.h"
23
#include "types.h"
24
#include "transport.h"
sletz's avatar
sletz committed
25
#ifndef WIN32
26
#include <netinet/in.h>
sletz's avatar
sletz committed
27
#endif
sletz's avatar
sletz committed
28
29
#include <cmath>

moret's avatar
moret committed
30
31
using namespace std;

sletz's avatar
sletz committed
32
33
#ifndef htonll
#ifdef __BIG_ENDIAN__
34
35
#define htonll(x) (x)
#define ntohll(x) (x)
sletz's avatar
sletz committed
36
#else
37
38
#define htonll(x) ((((uint64_t)htonl(x)) << 32) + htonl(x >> 32))
#define ntohll(x) ((((uint64_t)ntohl(x)) << 32) + ntohl(x >> 32))
sletz's avatar
sletz committed
39
40
41
#endif
#endif

42
43
44
45
46
#define MASTER_PROTOCOL 3
#define SLAVE_PROTOCOL 3

#define OPTIMIZED_PROTOCOL

sletz's avatar
sletz committed
47
48
namespace Jack
{
49
50
    typedef struct _session_params session_params_t;
    typedef struct _packet_header packet_header_t;
51
    typedef struct _net_transport_data net_transport_data_t;
52
53
54
    typedef struct sockaddr socket_address_t;
    typedef struct in_addr address_t;
    typedef jack_default_audio_sample_t sample_t;
sletz's avatar
sletz committed
55

56
57
58
59
60
61
    enum JackNetEncoder {

        JackFloatEncoder = 0,
        JackIntEncoder = 1,
        JackCeltEncoder = 2,
    };
sletz's avatar
sletz committed
62
63
64

//session params ******************************************************************************

moret's avatar
moret committed
65
66
67
68
69
70
71
72
73
74
75
76
    /**
    \brief This structure containes master/slave connection parameters, it's used to setup the whole system

    We have :
        - some info like version, type and packet id
        - names
        - network parameters (hostnames and mtu)
        - nunber of audio and midi channels
        - sample rate and buffersize
        - number of audio frames in one network packet (depends on the channel number)
        - is the NetDriver in Sync or ASync mode ?
        - is the NetDriver linked with the master's transport
sletz's avatar
sletz committed
77

78
    Data encoding : headers (session_params and packet_header) are encoded using HTN kind of functions but float data
sletz's avatar
sletz committed
79
    are kept in LITTLE_ENDIAN format (to avoid 2 conversions in the more common LITTLE_ENDIAN <==> LITTLE_ENDIAN connection case).
moret's avatar
moret committed
80
    */
sletz's avatar
sletz committed
81

82
83
    struct _session_params
    {
moret's avatar
moret committed
84
85
86
87
88
89
90
91
92
        char fPacketType[7];                //packet type ('param')
        char fProtocolVersion;              //version
        uint32_t fPacketID;                 //indicates the packet type
        char fName[JACK_CLIENT_NAME_SIZE];  //slave's name
        char fMasterNetName[256];           //master hostname (network)
        char fSlaveNetName[256];            //slave hostname (network)
        uint32_t fMtu;                      //connection mtu
        uint32_t fID;                       //slave's ID
        uint32_t fTransportSync;            //is the transport synced ?
sletz's avatar
sletz committed
93
94
95
96
        int32_t fSendAudioChannels;         //number of master->slave channels
        int32_t fReturnAudioChannels;       //number of slave->master channels
        int32_t fSendMidiChannels;          //number of master->slave midi channels
        int32_t fReturnMidiChannels;        //number of slave->master midi channels
moret's avatar
moret committed
97
98
        uint32_t fSampleRate;               //session sample rate
        uint32_t fPeriodSize;               //period size
99
        uint32_t fSampleEncoder;            //samples encoder
sletz's avatar
sletz committed
100
        uint32_t fKBps;                     //KB per second for CELT encoder
moret's avatar
moret committed
101
        uint32_t fSlaveSyncMode;            //is the slave in sync mode ?
102
        char fNetworkMode;                  //fast, normal or slow mode
103
    };
sletz's avatar
sletz committed
104
105
106

//net status **********************************************************************************

moret's avatar
moret committed
107
108
109
    /**
    \Brief This enum groups network error by type
    */
110

111
112
113
114
115
116
117
118
119
120
    enum  _net_status
    {
        NET_SOCKET_ERROR = 0,
        NET_CONNECT_ERROR,
        NET_ERROR,
        NET_SEND_ERROR,
        NET_RECV_ERROR,
        NET_CONNECTED,
        NET_ROLLING
    };
sletz's avatar
sletz committed
121

122
    typedef enum _net_status net_status_t;
sletz's avatar
sletz committed
123
124
125

//sync packet type ****************************************************************************

moret's avatar
moret committed
126
127
128
    /**
    \Brief This enum indicates the type of a sync packet (used in the initialization phase)
    */
129

130
131
    enum _sync_packet_type
    {
132
133
134
135
136
137
        INVALID = 0,        //...
        SLAVE_AVAILABLE,    //a slave is available
        SLAVE_SETUP,        //slave configuration
        START_MASTER,       //slave is ready, start master
        START_SLAVE,        //master is ready, activate slave
        KILL_MASTER         //master must stop
138
    };
sletz's avatar
sletz committed
139

140
    typedef enum _sync_packet_type sync_packet_type_t;
sletz's avatar
sletz committed
141
142
143
144


//packet header *******************************************************************************

moret's avatar
moret committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
    /**
    \Brief This structure is a complete header

    A header indicates :
        - it is a header
        - the type of data the packet contains (sync, midi or audio)
        - the path of the packet (send -master->slave- or return -slave->master-)
        - the unique ID of the slave
        - the sample's bitdepth (unused for now)
        - the size of the midi data contains in the packet (indicates how much midi data will be sent)
        - the number of midi packet(s) : more than one is very unusual, it depends on the midi load
        - the ID of the current cycle (used to check missing packets)
        - the ID of the packet subcycle (for audio data)
        - a flag indicating this packet is the last of the cycle (for sync robustness, it's better to process this way)
        - a flag indicating if, in async mode, the previous graph was not finished or not
        - padding to fill 64 bytes

    */
163

164
165
    struct _packet_header
    {
sletz's avatar
sletz committed
166
        char fPacketType[7];        //packet type ('headr')
167
        char fDataType;             //a for audio, m for midi and s for sync
168
        char fDataStream;           //s for send, r for return
169
        uint32_t fID;               //unique ID of the slave
sletz's avatar
sletz committed
170
        uint32_t fNumPacket;        //number of data packets of the cycle
moret's avatar
moret committed
171
        uint32_t fPacketSize;       //packet size in bytes
172
        uint32_t fActivePorts;      //number of active ports
173
174
        uint32_t fCycle;            //process cycle counter
        uint32_t fSubCycle;         //midi/audio subcycle counter
moret's avatar
moret committed
175
        uint32_t fIsLastPckt;       //is it the last packet of a given cycle ('y' or 'n')
176
    };
sletz's avatar
sletz committed
177

178
179
180
181
182
183
184
185
//net timebase master

    /**
    \Brief This enum describes timebase master's type
    */

    enum _net_timebase_master
    {
186
187
188
189
        NO_CHANGE = 0,
        RELEASE_TIMEBASEMASTER = 1,
        TIMEBASEMASTER = 2,
        CONDITIONAL_TIMEBASEMASTER = 3
190
191
192
193
194
    };

    typedef enum _net_timebase_master net_timebase_master_t;


195
196
//transport data ******************************************************************************

moret's avatar
moret committed
197
    /**
198
    \Brief This structure contains transport data to be sent over the network
moret's avatar
moret committed
199
    */
200

moret's avatar
moret committed
201
202
    struct _net_transport_data
    {
203
204
        uint32_t fNewState;             //is it a state change
        uint32_t fTimebaseMaster;       //is there a new timebase master
moret's avatar
moret committed
205
        int32_t fState;                 //current cycle state
206
        jack_position_t fPosition;      //current cycle position
moret's avatar
moret committed
207
    };
sletz's avatar
sletz committed
208

sletz's avatar
sletz committed
209
 //midi data ***********************************************************************************
sletz's avatar
sletz committed
210

moret's avatar
moret committed
211
212
    /**
    \Brief Midi buffer and operations class
213

moret's avatar
moret committed
214
215
216
217
218
219
220
221
222
    This class is a toolset to manipulate Midi buffers.
    A JackMidiBuffer has a fixed size, which is the same than an audio buffer size.
    An intermediate fixed size buffer allows to uninterleave midi data (from jack ports).
    But for a big majority of the process cycles, this buffer is filled less than 1%,
    Sending over a network 99% of useless data seems completely unappropriate.
    The idea is to count effective midi data, and then send the smallest packet we can.
    To do it, we use an intermediate buffer.
    We have two methods to convert data from jack ports to intermediate buffer,
    And two others to convert this intermediate buffer to a network buffer (header + payload data)
223

moret's avatar
moret committed
224
    */
225

226
    class SERVER_EXPORT NetMidiBuffer
227
    {
228
        private:
sletz's avatar
sletz committed
229

230
231
232
233
234
235
            int fNPorts;
            size_t fMaxBufsize;
            int fMaxPcktSize;
            char* fBuffer;
            char* fNetBuffer;
            JackMidiBuffer** fPortBuffer;
sletz's avatar
sletz committed
236

sletz's avatar
sletz committed
237
            size_t fCycleSize;  // needed size in bytes ofr an entire cycle
238
239

        public:
sletz's avatar
sletz committed
240

sletz's avatar
sletz committed
241
            NetMidiBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
242
243
244
            ~NetMidiBuffer();

            void Reset();
sletz's avatar
sletz committed
245

sletz's avatar
sletz committed
246
247
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
248

sletz's avatar
sletz committed
249
            int GetNumPackets(int data_sizen, int max_size);
sletz's avatar
sletz committed
250

251
252
            //utility
            void DisplayEvents();
sletz's avatar
sletz committed
253

254
255
            //jack<->buffer
            int RenderFromJackPorts();
sletz's avatar
sletz committed
256
            void RenderToJackPorts();
sletz's avatar
sletz committed
257

258
            //network<->buffer
259
260
            int RenderFromNetwork(int sub_cycle, size_t copy_size);
            int RenderToNetwork(int sub_cycle, size_t total_size);
261

sletz's avatar
sletz committed
262
263
            void SetBuffer(int index, JackMidiBuffer* buffer);
            JackMidiBuffer* GetBuffer(int index);
264
    };
sletz's avatar
sletz committed
265
266
267

// audio data *********************************************************************************

sletz's avatar
sletz committed
268
    class SERVER_EXPORT NetAudioBuffer
269
    {
sletz's avatar
sletz committed
270

271
        public:
sletz's avatar
sletz committed
272

sletz's avatar
sletz committed
273
            NetAudioBuffer()
274
            {}
sletz's avatar
sletz committed
275
            virtual ~NetAudioBuffer()
276
            {}
sletz's avatar
sletz committed
277

sletz's avatar
sletz committed
278
279
            // needed syze in bytes ofr an entire cycle
            virtual size_t GetCycleSize() = 0;
sletz's avatar
sletz committed
280

sletz's avatar
sletz committed
281
282
            // cycle duration in sec
            virtual float GetCycleDuration() = 0;
sletz's avatar
sletz committed
283

sletz's avatar
sletz committed
284
            virtual int GetNumPackets() = 0;
sletz's avatar
sletz committed
285

286
            //jack<->buffer
sletz's avatar
sletz committed
287
288
            virtual void RenderFromJackPorts() = 0;
            virtual void RenderToJackPorts() = 0;
sletz's avatar
sletz committed
289

sletz's avatar
sletz committed
290
            //network<->buffer
291
            virtual int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num) = 0;
sletz's avatar
sletz committed
292
            virtual int RenderToNetwork(int sub_cycle, uint32_t& port_num) = 0;
293

sletz's avatar
sletz committed
294
295
            virtual void SetBuffer(int index, sample_t* buffer) = 0;
            virtual sample_t* GetBuffer(int index) = 0;
296
297
   };

moret's avatar
moret committed
298
299
    /**
    \Brief Audio buffer and operations class
300

moret's avatar
moret committed
301
302
303
304
    This class is a toolset to manipulate audio buffers.
    The manipulation of audio buffers is similar to midi buffer, except those buffers have fixed size.
    The interleaving/uninterleaving operations are simplier here because audio buffers have fixed size,
    So there is no need of an intermediate buffer as in NetMidiBuffer.
305

moret's avatar
moret committed
306
    */
sletz's avatar
sletz committed
307

308
    struct JackPortList {
sletz's avatar
sletz committed
309

sletz's avatar
sletz committed
310
311
        // "[---Header---|--audio data--|--audio data--]..."

312
313
314
315
        jack_nframes_t fPeriodSize;
        jack_nframes_t fSubPeriodSize;
        size_t fSubPeriodBytesSize;
        sample_t** fPortBuffer;
316
        int fPacketSize;
317
        int fNPorts;
sletz's avatar
sletz committed
318
319
        size_t fCycleSize;      // needed size in bytes for an entire cycle
        float fCycleDuration;   // in sec
sletz's avatar
sletz committed
320

sletz's avatar
sletz committed
321
        int fLastSubCycle;
sletz's avatar
sletz committed
322

323
324
325
326
        JackPortList(session_params_t* params, uint32_t nports)
        {
            fNPorts = nports;
            fPeriodSize = params->fPeriodSize;
327
328
            fPacketSize = params->fMtu - sizeof(packet_header_t);

sletz's avatar
sletz committed
329
            if (params->fSendAudioChannels == 0 && params->fReturnAudioChannels == 0) {
sletz's avatar
sletz committed
330
331
                fSubPeriodSize = params->fPeriodSize;
            } else {
332
                jack_nframes_t period = (int) powf(2.f,(int)(log(float(fPacketSize)
sletz's avatar
sletz committed
333
                                                   / (max(params->fReturnAudioChannels, params->fSendAudioChannels) * sizeof(sample_t))) / log(2.)));
334
                fSubPeriodSize = (period > fPeriodSize) ? fPeriodSize : period;
sletz's avatar
sletz committed
335
            }
sletz's avatar
sletz committed
336

sletz's avatar
sletz committed
337
            fSubPeriodBytesSize = fSubPeriodSize * sizeof(sample_t);
sletz's avatar
sletz committed
338

339
            fPortBuffer = new sample_t* [fNPorts];
sletz's avatar
sletz committed
340
            for (int port_index = 0; port_index < fNPorts; port_index++)
341
                fPortBuffer[port_index] = NULL;
sletz's avatar
sletz committed
342

sletz's avatar
sletz committed
343
            fCycleDuration = float(fSubPeriodSize) / float(params->fSampleRate);
sletz's avatar
sletz committed
344
            fCycleSize = params->fMtu * (fPeriodSize / fSubPeriodSize);
sletz's avatar
sletz committed
345

sletz's avatar
sletz committed
346
347
            fLastSubCycle = -1;
        }
sletz's avatar
sletz committed
348

349
        virtual int GetNumPackets()
sletz's avatar
sletz committed
350
        {
351
352
            jack_info("GetNumPackets packet = %d  fPeriodSize = %d fSubPeriodSize = %d fSubPeriodBytesSize = %d",
                fPeriodSize / fSubPeriodSize, fPeriodSize, fSubPeriodSize, fSubPeriodBytesSize);
sletz's avatar
sletz committed
353
            return fPeriodSize / fSubPeriodSize;
354
        }
sletz's avatar
sletz committed
355

356
357
358
359
360
361
362
363
        JackPortList()
        {
            fNPorts = 0;
            fPeriodSize = 0;
            fSubPeriodSize = 0;
            fSubPeriodBytesSize = 0;
            fPortBuffer = 0;
        }
sletz's avatar
sletz committed
364

365
366
367
368
        ~JackPortList()
        {
            delete [] fPortBuffer;
        }
sletz's avatar
sletz committed
369

sletz's avatar
sletz committed
370
        void SetBuffer(int index, sample_t* buffer)
371
372
373
        {
            fPortBuffer[index] = buffer;
        }
sletz's avatar
sletz committed
374

sletz's avatar
sletz committed
375
        sample_t* GetBuffer(int index)
376
377
378
        {
            return fPortBuffer[index];
        }
sletz's avatar
sletz committed
379

380
381
        void Copy(sample_t** buffers)
        {
sletz's avatar
sletz committed
382
            for (int port_index = 0; port_index < fNPorts; port_index++)
383
384
                memcpy(buffers[port_index], fPortBuffer[port_index], fPeriodSize * sizeof(float));
        }
sletz's avatar
sletz committed
385

sletz's avatar
sletz committed
386
        // needed syze in bytes for an entire cycle
sletz's avatar
sletz committed
387
388
389
390
        size_t GetCycleSize()
        {
            return fCycleSize;
        }
sletz's avatar
sletz committed
391

sletz's avatar
sletz committed
392
393
394
395
396
        // cycle duration in sec
        float GetCycleDuration()
        {
            return fCycleDuration;
        }
sletz's avatar
sletz committed
397

398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
    #ifdef __BIG_ENDIAN__

        static inline float SwapFloat(float f)
        {
              union
              {
                float f;
                unsigned char b[4];
              } dat1, dat2;

              dat1.f = f;
              dat2.b[0] = dat1.b[3];
              dat2.b[1] = dat1.b[2];
              dat2.b[2] = dat1.b[1];
              dat2.b[3] = dat1.b[0];
              return dat2.f;
        }

sletz's avatar
sletz committed
416
417
        virtual void RenderFromJackPorts()
        {}
418

sletz's avatar
sletz committed
419
420
        virtual void RenderToJackPorts()
        {}
sletz's avatar
sletz committed
421

sletz's avatar
sletz committed
422
        //network<->buffer
423
        virtual int RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
sletz's avatar
sletz committed
424
        {
425
            for (int port_index = 0; port_index < fNPorts; port_index++) {
426
                float* src = (float*)(net_buffer + port_index * fSubPeriodBytesSize);
427
                float* dst = (float*)(fPortBuffer[port_index] + sub_cycle * fSubPeriodSize);
428
429
430
                for (unsigned int sample = 0; sample < fSubPeriodBytesSize / sizeof(float); sample++) {
                    dst[sample] = SwapFloat(src[sample]);
                }
sletz's avatar
sletz committed
431
            }
432
433
            if (sub_cycle != fLastSubCycle + 1) {
                jack_error("Packet(s) missing from... %d %d", fLastSubCycle, sub_cycle);
434
            }
435
            fLastSubCycle = sub_cycle;
sletz's avatar
sletz committed
436
437
            return copy_size;
        }
sletz's avatar
sletz committed
438

sletz's avatar
sletz committed
439
        virtual int RenderToNetwork(char* net_buffer, int sub_cycle, uint32_t& port_num)
sletz's avatar
sletz committed
440
        {
441
            for (int port_index = 0; port_index < fNPorts; port_index++) {
442
                float* src = (float*)(fPortBuffer[port_index] + sub_cycle * fSubPeriodSize);
sletz's avatar
sletz committed
443
444
445
446
447
                float* dst = (float*)(net_buffer + port_index * fSubPeriodBytesSize);
                for (unsigned int sample = 0; sample < fSubPeriodBytesSize / sizeof(float); sample++) {
                    dst[sample] = SwapFloat(src[sample]);
                }
            }
sletz's avatar
sletz committed
448

449
            port_num = fNPorts;
sletz's avatar
sletz committed
450
            return fNPorts * fSubPeriodBytesSize;
451
        }
sletz's avatar
sletz committed
452

453
454
    #else

sletz's avatar
sletz committed
455
456
        virtual void RenderFromJackPorts()
        {}
457

sletz's avatar
sletz committed
458
        virtual void RenderToJackPorts()
sletz's avatar
sletz committed
459
        {
sletz's avatar
sletz committed
460
            // reset for next cycle
sletz's avatar
sletz committed
461
462
            fLastSubCycle = -1;
        }
sletz's avatar
sletz committed
463

464
465
        //network<->buffer
        virtual int RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
466
        {
467
468
469
470
471
            for (int port_index = 0; port_index < fNPorts; port_index++) {
                memcpy(fPortBuffer[port_index] + sub_cycle * fSubPeriodSize, net_buffer + port_index * fSubPeriodBytesSize, fSubPeriodBytesSize);
            }
            if (sub_cycle != fLastSubCycle + 1) {
                jack_error("Packet(s) missing from... %d %d", fLastSubCycle, sub_cycle);
sletz's avatar
sletz committed
472
            }
473
            fLastSubCycle = sub_cycle;
sletz's avatar
sletz committed
474
475
            return copy_size;
        }
sletz's avatar
sletz committed
476

sletz's avatar
sletz committed
477
        virtual int RenderToNetwork(char* net_buffer, int sub_cycle, uint32_t& port_num)
sletz's avatar
sletz committed
478
        {
479
480
481
482
            for (int port_index = 0; port_index < fNPorts; port_index++) {
                memcpy(net_buffer + port_index * fSubPeriodBytesSize, fPortBuffer[port_index] + sub_cycle * fSubPeriodSize, fSubPeriodBytesSize);
            }
            port_num = fNPorts;
sletz's avatar
sletz committed
483
            return fNPorts * fSubPeriodBytesSize;
484
485
486
        }

    #endif
sletz's avatar
sletz committed
487

488
    };
sletz's avatar
sletz committed
489

490
491
    struct JackOptimizedPortList : JackPortList {

sletz's avatar
sletz committed
492
493
        // "[---Header---|--active_port_num---audio data--|--active_port_num---audio data--]..."

494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
        JackOptimizedPortList(session_params_t* params, uint32_t nports)
            :JackPortList(params, nports)
        {}

        int GetNumPackets()
        {
            // Count active ports
            int active_ports = 0;
            for (int port_index = 0; port_index < fNPorts; port_index++) {
                if (fPortBuffer[port_index]) active_ports++;
            }

            if (active_ports == 0) {
                fSubPeriodSize = fPeriodSize;
            } else {
                jack_nframes_t period = (int) powf(2.f, (int)(log(float(fPacketSize) / (active_ports * sizeof(sample_t))) / log(2.)));
                fSubPeriodSize = (period > fPeriodSize) ? fPeriodSize : period;
            }

            fSubPeriodBytesSize = fSubPeriodSize * sizeof(sample_t) + sizeof(uint32_t); // The port number in coded on 4 bytes
            return fPeriodSize / fSubPeriodSize; // At least one packet...
        }

    #ifdef __BIG_ENDIAN__

        // TODO

    #else

        //network<->buffer
        virtual int RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
        {
            /// Setup rendering parameters
            int sub_period_size, sub_period_bytes_size;
            if (port_num == 0) {
                sub_period_size = fPeriodSize;
            } else {
                jack_nframes_t period = (int) powf(2.f, (int)(log(float(fPacketSize) / (port_num * sizeof(sample_t))) / log(2.)));
                sub_period_size = (period > fPeriodSize) ? fPeriodSize : period;
            }
            sub_period_bytes_size = sub_period_size * sizeof(sample_t) + sizeof(uint32_t); // The port number in coded on 4 bytes

            if (sub_cycle == 0) { // Cleanup all JACK ports
                for (int port_index = 0; port_index < fNPorts; port_index++) {
                    memset(fPortBuffer[port_index], 0, fPeriodSize * sizeof(sample_t));
                }
            }

            for (uint32_t port_index = 0; port_index < port_num; port_index++) {
sletz's avatar
sletz committed
543
                // Only copy to active ports : read the active port number then audio data
544
545
546
547
548
549
550
551
552
553
554
555
                int* active_port_address = (int*)(net_buffer + port_index * sub_period_bytes_size);
                int active_port = (int)(*active_port_address);
                memcpy(fPortBuffer[active_port] + sub_cycle * sub_period_size, (char*)(active_port_address + 1), sub_period_bytes_size - sizeof(int));
            }

            if (sub_cycle != fLastSubCycle + 1) {
                jack_error("Packet(s) missing from... %d %d", fLastSubCycle, sub_cycle);
            }
            fLastSubCycle = sub_cycle;
            return copy_size;
        }

sletz's avatar
sletz committed
556
        virtual int RenderToNetwork(char* net_buffer,int sub_cycle, uint32_t& port_num)
557
        {
sletz's avatar
sletz committed
558
            // Init active port count
559
560
561
            port_num = 0;

            for (int port_index = 0; port_index < fNPorts; port_index++) {
sletz's avatar
sletz committed
562
                // Only copy from active ports : write the active port number then audio data
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
                if (fPortBuffer[port_index]) {
                    int* active_port_address = (int*)(net_buffer + port_num * fSubPeriodBytesSize);
                    *active_port_address = port_index;
                    memcpy((char*)(active_port_address + 1), fPortBuffer[port_index] + sub_cycle * fSubPeriodSize, fSubPeriodBytesSize - sizeof(uint32_t));
                    port_num++;
                }
            }

            return port_num * fSubPeriodBytesSize;
        }

    #endif

    };

sletz's avatar
sletz committed
578
    class SERVER_EXPORT NetFloatAudioBuffer : public NetAudioBuffer
579
    {
580
        private:
sletz's avatar
sletz committed
581

582
583
584
        #ifdef OPTIMIZED_PROTOCOL
            JackOptimizedPortList fPortBuffer;
        #else
585
            JackPortList fPortBuffer;
586
        #endif
587
            char* fNetBuffer;
sletz's avatar
sletz committed
588

589
        public:
sletz's avatar
sletz committed
590

sletz's avatar
sletz committed
591
            NetFloatAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
sletz's avatar
sletz committed
592
            ~NetFloatAudioBuffer();
sletz's avatar
sletz committed
593

sletz's avatar
sletz committed
594
595
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
596

sletz's avatar
sletz committed
597
            // cycle duration in sec
sletz's avatar
sletz committed
598
599
600
601
            float GetCycleDuration()
            {
                return fPortBuffer.GetCycleDuration();
            }
sletz's avatar
sletz committed
602

sletz's avatar
sletz committed
603
604
605
606
            int GetNumPackets()
            {
                return fPortBuffer.GetNumPackets();
            }
sletz's avatar
sletz committed
607

608
            //jack<->buffer
sletz's avatar
sletz committed
609
610
            void RenderFromJackPorts();
            void RenderToJackPorts();
611

sletz's avatar
sletz committed
612
613
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
sletz's avatar
sletz committed
614

sletz's avatar
sletz committed
615
            //network<->buffer
616
            int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
sletz's avatar
sletz committed
617
            int RenderToNetwork(int sub_cycle, uint32_t&  port_num);
618
    };
sletz's avatar
sletz committed
619

nedko's avatar
nedko committed
620
#if HAVE_CELT
sletz's avatar
sletz committed
621
622
623
624
625
626

#include <celt/celt.h>

    class SERVER_EXPORT NetCeltAudioBuffer : public NetAudioBuffer
    {
        private:
sletz's avatar
sletz committed
627

sletz's avatar
sletz committed
628
629
630
            CELTMode ** fCeltMode;
            CELTEncoder ** fCeltEncoder;
            CELTDecoder ** fCeltDecoder;
sletz's avatar
sletz committed
631

sletz's avatar
sletz committed
632
633
634
            int fCompressedSizeByte;
            jack_nframes_t fPeriodSize;
            int fNumPackets;
sletz's avatar
sletz committed
635
636
            float fCycleDuration;   // in sec
            size_t fCycleSize;      // needed size in bytes for an entire cycle
sletz's avatar
sletz committed
637

sletz's avatar
sletz committed
638
639
            size_t fSubPeriodBytesSize;
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
640

sletz's avatar
sletz committed
641
642
            sample_t** fPortBuffer;
            char* fNetBuffer;
643
            unsigned char** fCompressedBuffer;
sletz's avatar
sletz committed
644

sletz's avatar
sletz committed
645
646
            int fNPorts;
            int fLastSubCycle;
sletz's avatar
sletz committed
647

sletz's avatar
sletz committed
648
            void FreeCelt();
sletz's avatar
sletz committed
649

sletz's avatar
sletz committed
650
        public:
sletz's avatar
sletz committed
651

652
            NetCeltAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer, int kbps);
sletz's avatar
sletz committed
653
            ~NetCeltAudioBuffer();
sletz's avatar
sletz committed
654

sletz's avatar
sletz committed
655
656
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
657

sletz's avatar
sletz committed
658
659
660
             // cycle duration in sec
            float GetCycleDuration();
            int GetNumPackets();
sletz's avatar
sletz committed
661

sletz's avatar
sletz committed
662
663
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
sletz's avatar
sletz committed
664

sletz's avatar
sletz committed
665
            //jack<->buffer
sletz's avatar
sletz committed
666
667
            void RenderFromJackPorts();
            void RenderToJackPorts();
sletz's avatar
sletz committed
668
669

            //network<->buffer
670
            int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
sletz's avatar
sletz committed
671
            int RenderToNetwork(int sub_cycle, uint32_t&  port_num);
sletz's avatar
sletz committed
672
673
674
    };

#endif
sletz's avatar
sletz committed
675
676
677
678

    class SERVER_EXPORT NetIntAudioBuffer : public NetAudioBuffer
    {
        private:
sletz's avatar
sletz committed
679

sletz's avatar
sletz committed
680
681
            int fCompressedSizeByte;
            jack_nframes_t fPeriodSize;
sletz's avatar
sletz committed
682

sletz's avatar
sletz committed
683
            int fNumPackets;
sletz's avatar
sletz committed
684
685
            float fCycleDuration;   // in sec
            size_t fCycleSize;      // needed size in bytes for an entire cycle
sletz's avatar
sletz committed
686

sletz's avatar
sletz committed
687
688
689
690
            size_t fSubPeriodSize;
            size_t fSubPeriodBytesSize;
            size_t fLastSubPeriodSize;;
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
691

sletz's avatar
sletz committed
692
693
694
            sample_t** fPortBuffer;
            char* fNetBuffer;
            short ** fIntBuffer;
sletz's avatar
sletz committed
695

sletz's avatar
sletz committed
696
697
            int fNPorts;
            int fLastSubCycle;
sletz's avatar
sletz committed
698

sletz's avatar
sletz committed
699
        public:
sletz's avatar
sletz committed
700

sletz's avatar
sletz committed
701
702
            NetIntAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
            ~NetIntAudioBuffer();
sletz's avatar
sletz committed
703

sletz's avatar
sletz committed
704
705
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
706

sletz's avatar
sletz committed
707
708
709
             // cycle duration in sec
            float GetCycleDuration();
            int GetNumPackets();
sletz's avatar
sletz committed
710

sletz's avatar
sletz committed
711
712
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
sletz's avatar
sletz committed
713

sletz's avatar
sletz committed
714
            //jack<->buffer
sletz's avatar
sletz committed
715
716
            void RenderFromJackPorts();
            void RenderToJackPorts();
sletz's avatar
sletz committed
717
718

            //network<->buffer
719
            int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
sletz's avatar
sletz committed
720
            int RenderToNetwork(int sub_cycle, uint32_t& port_num);
sletz's avatar
sletz committed
721
722
    };

sletz's avatar
sletz committed
723
    /*
724
    #define AUDIO_BUFFER_SIZE 8
sletz's avatar
sletz committed
725

sletz's avatar
sletz committed
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
    struct JackPortListAllocate : public JackPortList {

        JackPortListAllocate()
        {
            fNPorts = 0;
            fPeriodSize = 0;
            fSubPeriodSize = 0;
            fSubPeriodBytesSize = 0;
            fPortBuffer = 0;
        }

        ~JackPortListAllocate()
        {
            for (int port_index = 0; port_index < fNPorts; port_index++)
                delete [] fPortBuffer[port_index];
            delete [] fPortBuffer;
        }

        void Init(session_params_t* params, uint32_t nports)
        {
            fNPorts = nports;
            fPeriodSize = params->fPeriodSize;

            if (params->fSendAudioChannels == 0 && params->fReturnAudioChannels == 0) {
                fSubPeriodSize = params->fPeriodSize;
            } else {
                jack_nframes_t period = (int) powf(2.f, (int)(log(float((params->fMtu - sizeof(packet_header_t)))
                                                   / (max(params->fReturnAudioChannels, params->fSendAudioChannels) * sizeof(sample_t))) / log(2.)));
                fSubPeriodSize = (period > params->fPeriodSize) ? params->fPeriodSize : period;
            }

            fSubPeriodBytesSize = fSubPeriodSize * sizeof(sample_t);
            fPortBuffer = new sample_t* [fNPorts];
            for (int port_index = 0; port_index < fNPorts; port_index++)
                fPortBuffer[port_index] = new sample_t[fPeriodSize];
        }

    };

765
766
    class SERVER_EXPORT NetBufferedAudioBuffer : public NetAudioBuffer
    {
sletz's avatar
sletz committed
767

768
        private:
769
            char* fNetBuffer;
770
771
772
            JackPortListAllocate fPortBuffer[AUDIO_BUFFER_SIZE];
            sample_t** fJackPortBuffer;
            int fMaxCycle;
sletz's avatar
sletz committed
773

774
        public:
sletz's avatar
sletz committed
775
            NetBufferedAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
776
            ~NetBufferedAudioBuffer();
777

sletz's avatar
sletz committed
778
779
            // needed syze in bytes ofr an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
780

sletz's avatar
sletz committed
781
782
783
784
785
             // cycle duration in sec
            float GetCycleDuration()
            {
                return fPortBuffer[0].GetCycleDuration();
            }
sletz's avatar
sletz committed
786

787
            //jack<->buffer
sletz's avatar
sletz committed
788
789
            void RenderFromJackPorts(int sub_cycle);
            void RenderToJackPorts(int cycle, int sub_cycle);
sletz's avatar
sletz committed
790
            //void FinishRenderToJackPorts(int cycle);
sletz's avatar
sletz committed
791

sletz's avatar
sletz committed
792
            //network<->buffer
793
            int RenderFromNetwork(int sub_cycle, size_t copy_size)
sletz's avatar
sletz committed
794
            {
sletz's avatar
sletz committed
795
796
797
                // TODO
                return 0;
            }
798
            int RenderToNetwork(int sub_cycle, size_t total_size)
sletz's avatar
sletz committed
799
            {
sletz's avatar
sletz committed
800
801
802
                // TODO
                return 0;
            }
803

sletz's avatar
sletz committed
804
805
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
806
    };
sletz's avatar
sletz committed
807
    */
sletz's avatar
sletz committed
808

sletz's avatar
sletz committed
809
    //utility *************************************************************************************
810
811

    //socket API management
812
813
    SERVER_EXPORT int SocketAPIInit();
    SERVER_EXPORT int SocketAPIEnd();
814
    //n<-->h functions
sletz's avatar
sletz committed
815
816
817
818
819
820
821
822
    SERVER_EXPORT void SessionParamsHToN(session_params_t* src_params, session_params_t* dst_params);
    SERVER_EXPORT void SessionParamsNToH(session_params_t* src_params, session_params_t* dst_params);
    SERVER_EXPORT void PacketHeaderHToN(packet_header_t* src_header, packet_header_t* dst_header);
    SERVER_EXPORT void PacketHeaderNToH(packet_header_t* src_header, packet_header_t* dst_header);
    SERVER_EXPORT void MidiBufferHToN(JackMidiBuffer* src_buffer, JackMidiBuffer* dst_buffer);
    SERVER_EXPORT void MidiBufferNToH(JackMidiBuffer* src_buffer, JackMidiBuffer* dst_buffer);
    SERVER_EXPORT void TransportDataHToN(net_transport_data_t* src_params, net_transport_data_t* dst_params);
    SERVER_EXPORT void TransportDataNToH(net_transport_data_t* src_params, net_transport_data_t* dst_params);
823
    //display session parameters
sletz's avatar
sletz committed
824
    SERVER_EXPORT void SessionParamsDisplay(session_params_t* params);
825
    //display packet header
sletz's avatar
sletz committed
826
    SERVER_EXPORT void PacketHeaderDisplay(packet_header_t* header);
827
    //get the packet type from a sesion parameters
sletz's avatar
sletz committed
828
    SERVER_EXPORT sync_packet_type_t GetPacketType(session_params_t* params);
829
    //set the packet type in a session parameters
sletz's avatar
sletz committed
830
    SERVER_EXPORT int SetPacketType(session_params_t* params, sync_packet_type_t packet_type);
831
    //transport utility
sletz's avatar
sletz committed
832
833
    SERVER_EXPORT const char* GetTransportState(int transport_state);
    SERVER_EXPORT void NetTransportDataDisplay(net_transport_data_t* data);
sletz's avatar
sletz committed
834
}