JackNetTool.h 30.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
#define MASTER_PROTOCOL 4
#define SLAVE_PROTOCOL 4
44
45
46

#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
            void RenderFromNetwork(int sub_cycle, size_t copy_size);
260
            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
292
293
            virtual void RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num) = 0;
            virtual void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num) {}

sletz's avatar
sletz committed
294
            virtual int RenderToNetwork(int sub_cycle, uint32_t& port_num) = 0;
295
            virtual void ActivePortsToNetwork(char* net_buffer, uint32_t& port_num) {}
296

sletz's avatar
sletz committed
297
298
            virtual void SetBuffer(int index, sample_t* buffer) = 0;
            virtual sample_t* GetBuffer(int index) = 0;
299
300
   };

moret's avatar
moret committed
301
302
    /**
    \Brief Audio buffer and operations class
303

moret's avatar
moret committed
304
305
306
307
    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.
308

moret's avatar
moret committed
309
    */
sletz's avatar
sletz committed
310

311
    struct JackPortList {
sletz's avatar
sletz committed
312

sletz's avatar
sletz committed
313
314
        // "[---Header---|--audio data--|--audio data--]..."

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

sletz's avatar
sletz committed
324
        int fLastSubCycle;
sletz's avatar
sletz committed
325

326
327
328
329
        JackPortList(session_params_t* params, uint32_t nports)
        {
            fNPorts = nports;
            fPeriodSize = params->fPeriodSize;
330
331
            fPacketSize = params->fMtu - sizeof(packet_header_t);

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

sletz's avatar
sletz committed
340
            fSubPeriodBytesSize = fSubPeriodSize * sizeof(sample_t);
sletz's avatar
sletz committed
341

342
            fPortBuffer = new sample_t* [fNPorts];
343
            for (int port_index = 0; port_index < fNPorts; port_index++) {
344
                fPortBuffer[port_index] = NULL;
345
            }
sletz's avatar
sletz committed
346

sletz's avatar
sletz committed
347
            fCycleDuration = float(fSubPeriodSize) / float(params->fSampleRate);
sletz's avatar
sletz committed
348
            fCycleSize = params->fMtu * (fPeriodSize / fSubPeriodSize);
sletz's avatar
sletz committed
349

sletz's avatar
sletz committed
350
351
            fLastSubCycle = -1;
        }
sletz's avatar
sletz committed
352

353
        virtual int GetNumPackets()
sletz's avatar
sletz committed
354
        {
355
356
            jack_info("GetNumPackets packet = %d  fPeriodSize = %d fSubPeriodSize = %d fSubPeriodBytesSize = %d",
                fPeriodSize / fSubPeriodSize, fPeriodSize, fSubPeriodSize, fSubPeriodBytesSize);
sletz's avatar
sletz committed
357
            return fPeriodSize / fSubPeriodSize;
358
        }
sletz's avatar
sletz committed
359

360
361
362
363
364
365
366
367
        JackPortList()
        {
            fNPorts = 0;
            fPeriodSize = 0;
            fSubPeriodSize = 0;
            fSubPeriodBytesSize = 0;
            fPortBuffer = 0;
        }
sletz's avatar
sletz committed
368

sletz's avatar
sletz committed
369
        virtual ~JackPortList()
370
371
372
        {
            delete [] fPortBuffer;
        }
sletz's avatar
sletz committed
373

sletz's avatar
sletz committed
374
        void SetBuffer(int index, sample_t* buffer)
375
376
377
        {
            fPortBuffer[index] = buffer;
        }
sletz's avatar
sletz committed
378

sletz's avatar
sletz committed
379
        sample_t* GetBuffer(int index)
380
381
382
        {
            return fPortBuffer[index];
        }
sletz's avatar
sletz committed
383

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

sletz's avatar
sletz committed
390
        // needed syze in bytes for an entire cycle
sletz's avatar
sletz committed
391
392
393
394
        size_t GetCycleSize()
        {
            return fCycleSize;
        }
sletz's avatar
sletz committed
395

sletz's avatar
sletz committed
396
397
398
399
400
        // cycle duration in sec
        float GetCycleDuration()
        {
            return fCycleDuration;
        }
sletz's avatar
sletz committed
401

402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
    #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
420
421
        virtual void RenderFromJackPorts()
        {}
422

sletz's avatar
sletz committed
423
424
        virtual void RenderToJackPorts()
        {}
sletz's avatar
sletz committed
425

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

sletz's avatar
sletz committed
442
        virtual int RenderToNetwork(char* net_buffer, int sub_cycle, uint32_t& port_num)
sletz's avatar
sletz committed
443
        {
444
            for (int port_index = 0; port_index < fNPorts; port_index++) {
445
                float* src = (float*)(fPortBuffer[port_index] + sub_cycle * fSubPeriodSize);
sletz's avatar
sletz committed
446
447
448
449
450
                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
451

452
            port_num = fNPorts;
sletz's avatar
sletz committed
453
            return fNPorts * fSubPeriodBytesSize;
454
        }
sletz's avatar
sletz committed
455

456
457
    #else

sletz's avatar
sletz committed
458
459
        virtual void RenderFromJackPorts()
        {}
460

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

467
        //network<->buffer
468
        virtual void RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
469
        {
470
471
472
473
474
            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
475
            }
476
            fLastSubCycle = sub_cycle;
sletz's avatar
sletz committed
477
        }
sletz's avatar
sletz committed
478

sletz's avatar
sletz committed
479
        virtual int RenderToNetwork(char* net_buffer, int sub_cycle, uint32_t& port_num)
sletz's avatar
sletz committed
480
        {
481
482
483
484
            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
485
            return fNPorts * fSubPeriodBytesSize;
486
487
488
        }

    #endif
sletz's avatar
sletz committed
489

490
491
492
493
494
495
496
497
        virtual void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num)
        {}

        virtual void ActivePortsToNetwork(char* net_buffer, uint32_t& port_num)
        {
            port_num = fNPorts;
        }

498
    };
sletz's avatar
sletz committed
499

500
501
    struct JackOptimizedPortList : JackPortList {

502
        // Consuming port list is transmitted in the Sync packed
sletz's avatar
sletz committed
503
504
        // "[---Header---|--active_port_num---audio data--|--active_port_num---audio data--]..."

505
506
507
508
        JackOptimizedPortList(session_params_t* params, uint32_t nports)
            :JackPortList(params, nports)
        {}

sletz's avatar
sletz committed
509
510
511
        virtual ~JackOptimizedPortList()
        {}

512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
        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
528
            return fPeriodSize / fSubPeriodSize; // At least one packet
529
530
531
532
533
534
535
536
537
        }

    #ifdef __BIG_ENDIAN__

        // TODO

    #else

        //network<->buffer
538
        virtual void RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
539
        {
sletz's avatar
sletz committed
540
541
542
543
544
545
546
547
            // Cleanup all JACK ports at the beginning of the cycle
            if (sub_cycle == 0) {
                for (int port_index = 0; port_index < fNPorts; port_index++) {
                    if (fPortBuffer[port_index])
                        memset(fPortBuffer[port_index], 0, fPeriodSize * sizeof(sample_t));
                }
            }

548
549
550
551
552
553
554
555
556
557
558
            if (port_num > 0)  {

                /// 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
559

560
561
562
563
564
565
566
                for (uint32_t port_index = 0; port_index < port_num; port_index++) {
                    // Only copy to active ports : read the active port number then audio data
                    int* active_port_address = (int*)(net_buffer + port_index * sub_period_bytes_size);
                    int active_port = (int)(*active_port_address);
                    if (fPortBuffer[port_index])
                        memcpy(fPortBuffer[active_port] + sub_cycle * sub_period_size, (char*)(active_port_address + 1), sub_period_bytes_size - sizeof(int));
                }
567

568
569
570
571
                if (sub_cycle != fLastSubCycle + 1) {
                    jack_error("Packet(s) missing from... %d %d", fLastSubCycle, sub_cycle);
                }
                fLastSubCycle = sub_cycle;
572
573
574
            }
        }

sletz's avatar
sletz committed
575
        virtual int RenderToNetwork(char* net_buffer,int sub_cycle, uint32_t& port_num)
576
        {
sletz's avatar
sletz committed
577
            // Init active port count
578
579
580
            port_num = 0;

            for (int port_index = 0; port_index < fNPorts; port_index++) {
sletz's avatar
sletz committed
581
                // Only copy from active ports : write the active port number then audio data
582
583
584
585
586
587
588
589
590
591
592
593
594
                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

595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
        virtual void ActivePortsToNetwork(char* net_buffer, uint32_t& port_num)
        {
            // Init active port count
            port_num = 0;
            short* active_port_address = (short*)net_buffer;

            for (int port_index = 0; port_index < fNPorts; port_index++) {
                // Write the active port number
                if (fPortBuffer[port_index]) {
                    *active_port_address = port_index;
                    active_port_address++;
                    port_num++;
                    assert(port_num < 512);
                }
            }
        }

        virtual void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num)
        {
            short* active_port_address = (short*)net_buffer;

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

            for (uint port_index = 0; port_index < port_num; port_index++) {
621
                // Use -1 when port is actually connected on other side
622
623
624
625
626
                fPortBuffer[*active_port_address] = (sample_t*)-1;
                active_port_address++;
            }
        }

627
628
    };

sletz's avatar
sletz committed
629
    class SERVER_EXPORT NetFloatAudioBuffer : public NetAudioBuffer
630
    {
631
        private:
sletz's avatar
sletz committed
632

633
634
635
        #ifdef OPTIMIZED_PROTOCOL
            JackOptimizedPortList fPortBuffer;
        #else
636
            JackPortList fPortBuffer;
637
        #endif
638
            char* fNetBuffer;
sletz's avatar
sletz committed
639

640
        public:
sletz's avatar
sletz committed
641

sletz's avatar
sletz committed
642
            NetFloatAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
sletz's avatar
sletz committed
643
            ~NetFloatAudioBuffer();
sletz's avatar
sletz committed
644

sletz's avatar
sletz committed
645
646
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
647

sletz's avatar
sletz committed
648
            // cycle duration in sec
sletz's avatar
sletz committed
649
650
651
652
            float GetCycleDuration()
            {
                return fPortBuffer.GetCycleDuration();
            }
sletz's avatar
sletz committed
653

sletz's avatar
sletz committed
654
655
656
657
            int GetNumPackets()
            {
                return fPortBuffer.GetNumPackets();
            }
sletz's avatar
sletz committed
658

659
            //jack<->buffer
sletz's avatar
sletz committed
660
661
            void RenderFromJackPorts();
            void RenderToJackPorts();
662

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

sletz's avatar
sletz committed
666
            //network<->buffer
667
668
669
670
671
            void RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
            void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num);

            int RenderToNetwork(int sub_cycle, uint32_t&  ort_num);
            void ActivePortsToNetwork(char* net_buffer, uint32_t& port_num);
672
    };
sletz's avatar
sletz committed
673

nedko's avatar
nedko committed
674
#if HAVE_CELT
sletz's avatar
sletz committed
675
676
677
678
679
680

#include <celt/celt.h>

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

682
683
684
            CELTMode** fCeltMode;
            CELTEncoder** fCeltEncoder;
            CELTDecoder** fCeltDecoder;
sletz's avatar
sletz committed
685

sletz's avatar
sletz committed
686
687
688
            int fCompressedSizeByte;
            jack_nframes_t fPeriodSize;
            int fNumPackets;
sletz's avatar
sletz committed
689
690
            float fCycleDuration;   // in sec
            size_t fCycleSize;      // needed size in bytes for an entire cycle
sletz's avatar
sletz committed
691

sletz's avatar
sletz committed
692
693
            size_t fSubPeriodBytesSize;
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
694

sletz's avatar
sletz committed
695
696
            sample_t** fPortBuffer;
            char* fNetBuffer;
697
            unsigned char** fCompressedBuffer;
sletz's avatar
sletz committed
698

sletz's avatar
sletz committed
699
700
            int fNPorts;
            int fLastSubCycle;
sletz's avatar
sletz committed
701

sletz's avatar
sletz committed
702
            void FreeCelt();
sletz's avatar
sletz committed
703

sletz's avatar
sletz committed
704
        public:
sletz's avatar
sletz committed
705

706
            NetCeltAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer, int kbps);
sletz's avatar
sletz committed
707
            ~NetCeltAudioBuffer();
sletz's avatar
sletz committed
708

sletz's avatar
sletz committed
709
710
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
711

sletz's avatar
sletz committed
712
713
714
             // cycle duration in sec
            float GetCycleDuration();
            int GetNumPackets();
sletz's avatar
sletz committed
715

sletz's avatar
sletz committed
716
717
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
sletz's avatar
sletz committed
718

sletz's avatar
sletz committed
719
            //jack<->buffer
sletz's avatar
sletz committed
720
721
            void RenderFromJackPorts();
            void RenderToJackPorts();
sletz's avatar
sletz committed
722
723

            //network<->buffer
724
            void RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
sletz's avatar
sletz committed
725
            int RenderToNetwork(int sub_cycle, uint32_t&  port_num);
sletz's avatar
sletz committed
726
727
728
    };

#endif
sletz's avatar
sletz committed
729
730
731
732

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

sletz's avatar
sletz committed
734
735
            int fCompressedSizeByte;
            jack_nframes_t fPeriodSize;
sletz's avatar
sletz committed
736

sletz's avatar
sletz committed
737
            int fNumPackets;
sletz's avatar
sletz committed
738
739
            float fCycleDuration;   // in sec
            size_t fCycleSize;      // needed size in bytes for an entire cycle
sletz's avatar
sletz committed
740

sletz's avatar
sletz committed
741
742
743
744
            size_t fSubPeriodSize;
            size_t fSubPeriodBytesSize;
            size_t fLastSubPeriodSize;;
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
745

sletz's avatar
sletz committed
746
747
748
            sample_t** fPortBuffer;
            char* fNetBuffer;
            short ** fIntBuffer;
sletz's avatar
sletz committed
749

sletz's avatar
sletz committed
750
751
            int fNPorts;
            int fLastSubCycle;
sletz's avatar
sletz committed
752

sletz's avatar
sletz committed
753
        public:
sletz's avatar
sletz committed
754

sletz's avatar
sletz committed
755
756
            NetIntAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
            ~NetIntAudioBuffer();
sletz's avatar
sletz committed
757

sletz's avatar
sletz committed
758
759
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
760

sletz's avatar
sletz committed
761
762
763
             // cycle duration in sec
            float GetCycleDuration();
            int GetNumPackets();
sletz's avatar
sletz committed
764

sletz's avatar
sletz committed
765
766
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
sletz's avatar
sletz committed
767

sletz's avatar
sletz committed
768
            //jack<->buffer
sletz's avatar
sletz committed
769
770
            void RenderFromJackPorts();
            void RenderToJackPorts();
sletz's avatar
sletz committed
771
772

            //network<->buffer
773
            void RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
sletz's avatar
sletz committed
774
            int RenderToNetwork(int sub_cycle, uint32_t& port_num);
sletz's avatar
sletz committed
775
776
    };

sletz's avatar
sletz committed
777
    /*
778
    #define AUDIO_BUFFER_SIZE 8
sletz's avatar
sletz committed
779

sletz's avatar
sletz committed
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
    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];
        }

    };

819
820
    class SERVER_EXPORT NetBufferedAudioBuffer : public NetAudioBuffer
    {
sletz's avatar
sletz committed
821

822
        private:
823
            char* fNetBuffer;
824
825
826
            JackPortListAllocate fPortBuffer[AUDIO_BUFFER_SIZE];
            sample_t** fJackPortBuffer;
            int fMaxCycle;
sletz's avatar
sletz committed
827

828
        public:
sletz's avatar
sletz committed
829
            NetBufferedAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
830
            ~NetBufferedAudioBuffer();
831

sletz's avatar
sletz committed
832
833
            // needed syze in bytes ofr an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
834

sletz's avatar
sletz committed
835
836
837
838
839
             // cycle duration in sec
            float GetCycleDuration()
            {
                return fPortBuffer[0].GetCycleDuration();
            }
sletz's avatar
sletz committed
840

841
            //jack<->buffer
sletz's avatar
sletz committed
842
843
            void RenderFromJackPorts(int sub_cycle);
            void RenderToJackPorts(int cycle, int sub_cycle);
sletz's avatar
sletz committed
844
            //void FinishRenderToJackPorts(int cycle);
sletz's avatar
sletz committed
845

sletz's avatar
sletz committed
846
            //network<->buffer
847
            void RenderFromNetwork(int sub_cycle, size_t copy_size)
sletz's avatar
sletz committed
848
            {
sletz's avatar
sletz committed
849
850
                // TODO
            }
851
            int RenderToNetwork(int sub_cycle, size_t total_size)
sletz's avatar
sletz committed
852
            {
sletz's avatar
sletz committed
853
854
855
                // TODO
                return 0;
            }
856

sletz's avatar
sletz committed
857
858
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
859
    };
sletz's avatar
sletz committed
860
    */
sletz's avatar
sletz committed
861

sletz's avatar
sletz committed
862
    //utility *************************************************************************************
863
864

    //socket API management
865
866
    SERVER_EXPORT int SocketAPIInit();
    SERVER_EXPORT int SocketAPIEnd();
867
    //n<-->h functions
sletz's avatar
sletz committed
868
869
870
871
872
873
874
875
    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);
876
    //display session parameters
sletz's avatar
sletz committed
877
    SERVER_EXPORT void SessionParamsDisplay(session_params_t* params);
878
    //display packet header
sletz's avatar
sletz committed
879
    SERVER_EXPORT void PacketHeaderDisplay(packet_header_t* header);
880
    //get the packet type from a sesion parameters
sletz's avatar
sletz committed
881
    SERVER_EXPORT sync_packet_type_t GetPacketType(session_params_t* params);
882
    //set the packet type in a session parameters
sletz's avatar
sletz committed
883
    SERVER_EXPORT int SetPacketType(session_params_t* params, sync_packet_type_t packet_type);
884
    //transport utility
sletz's avatar
sletz committed
885
886
    SERVER_EXPORT const char* GetTransportState(int transport_state);
    SERVER_EXPORT void NetTransportDataDisplay(net_transport_data_t* data);
sletz's avatar
sletz committed
887
}