JackNetTool.h 29.8 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

sletz's avatar
sletz committed
45
46
#define NET_PACKET_ERROR -2

47
48
#define OPTIMIZED_PROTOCOL

49
50
51
#define HEADER_SIZE (sizeof(packet_header_t))
#define PACKET_AVAILABLE_SIZE(params) ((params)->fMtu - sizeof(packet_header_t))

sletz's avatar
sletz committed
52
53
namespace Jack
{
54
55
    typedef struct _session_params session_params_t;
    typedef struct _packet_header packet_header_t;
56
    typedef struct _net_transport_data net_transport_data_t;
57
58
59
    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
60

61
62
63
64
65
66
    enum JackNetEncoder {

        JackFloatEncoder = 0,
        JackIntEncoder = 1,
        JackCeltEncoder = 2,
    };
sletz's avatar
sletz committed
67
68
69

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

moret's avatar
moret committed
70
71
72
73
74
75
76
77
78
79
80
81
    /**
    \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
82

83
    Data encoding : headers (session_params and packet_header) are encoded using HTN kind of functions but float data
sletz's avatar
sletz committed
84
    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
85
    */
sletz's avatar
sletz committed
86

87
88
    struct _session_params
    {
moret's avatar
moret committed
89
90
91
92
93
94
95
96
97
        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
98
99
100
101
        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
102
103
        uint32_t fSampleRate;               //session sample rate
        uint32_t fPeriodSize;               //period size
104
        uint32_t fSampleEncoder;            //samples encoder
sletz's avatar
sletz committed
105
        uint32_t fKBps;                     //KB per second for CELT encoder
moret's avatar
moret committed
106
        uint32_t fSlaveSyncMode;            //is the slave in sync mode ?
107
        uint32_t fNetworkLatency;           //network latency
108
    };
sletz's avatar
sletz committed
109
110
111

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

moret's avatar
moret committed
112
113
114
    /**
    \Brief This enum groups network error by type
    */
115

116
117
118
119
120
121
122
123
124
125
    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
126

127
    typedef enum _net_status net_status_t;
sletz's avatar
sletz committed
128
129
130

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

moret's avatar
moret committed
131
132
133
    /**
    \Brief This enum indicates the type of a sync packet (used in the initialization phase)
    */
134

135
136
    enum _sync_packet_type
    {
137
138
139
140
141
142
        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
143
    };
sletz's avatar
sletz committed
144

145
    typedef enum _sync_packet_type sync_packet_type_t;
sletz's avatar
sletz committed
146
147
148
149


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

moret's avatar
moret committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
    /**
    \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

    */
168

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

183
184
185
186
187
188
189
190
//net timebase master

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

    enum _net_timebase_master
    {
191
192
193
194
        NO_CHANGE = 0,
        RELEASE_TIMEBASEMASTER = 1,
        TIMEBASEMASTER = 2,
        CONDITIONAL_TIMEBASEMASTER = 3
195
196
197
198
199
    };

    typedef enum _net_timebase_master net_timebase_master_t;


200
201
//transport data ******************************************************************************

moret's avatar
moret committed
202
    /**
203
    \Brief This structure contains transport data to be sent over the network
moret's avatar
moret committed
204
    */
205

moret's avatar
moret committed
206
207
    struct _net_transport_data
    {
208
209
        uint32_t fNewState;             //is it a state change
        uint32_t fTimebaseMaster;       //is there a new timebase master
moret's avatar
moret committed
210
        int32_t fState;                 //current cycle state
211
        jack_position_t fPosition;      //current cycle position
moret's avatar
moret committed
212
    };
sletz's avatar
sletz committed
213

sletz's avatar
sletz committed
214
 //midi data ***********************************************************************************
sletz's avatar
sletz committed
215

moret's avatar
moret committed
216
217
    /**
    \Brief Midi buffer and operations class
218

moret's avatar
moret committed
219
220
221
222
223
224
225
226
227
    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)
228

moret's avatar
moret committed
229
    */
230

231
    class SERVER_EXPORT NetMidiBuffer
232
    {
233
        private:
sletz's avatar
sletz committed
234

235
236
237
238
239
240
            int fNPorts;
            size_t fMaxBufsize;
            int fMaxPcktSize;
            char* fBuffer;
            char* fNetBuffer;
            JackMidiBuffer** fPortBuffer;
sletz's avatar
sletz committed
241

sletz's avatar
sletz committed
242
            size_t fCycleSize;  // needed size in bytes ofr an entire cycle
243
244

        public:
sletz's avatar
sletz committed
245

sletz's avatar
sletz committed
246
            NetMidiBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
247
248
249
            ~NetMidiBuffer();

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

sletz's avatar
sletz committed
251
252
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
253

sletz's avatar
sletz committed
254
            int GetNumPackets(int data_sizen, int max_size);
sletz's avatar
sletz committed
255

256
257
            //utility
            void DisplayEvents();
sletz's avatar
sletz committed
258

259
260
            //jack<->buffer
            int RenderFromJackPorts();
sletz's avatar
sletz committed
261
            void RenderToJackPorts();
sletz's avatar
sletz committed
262

263
            //network<->buffer
264
            void RenderFromNetwork(int sub_cycle, size_t copy_size);
265
            int RenderToNetwork(int sub_cycle, size_t total_size);
266

sletz's avatar
sletz committed
267
268
            void SetBuffer(int index, JackMidiBuffer* buffer);
            JackMidiBuffer* GetBuffer(int index);
269
    };
sletz's avatar
sletz committed
270
271
272

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

sletz's avatar
sletz committed
273
    class SERVER_EXPORT NetAudioBuffer
274
    {
sletz's avatar
sletz committed
275

sletz's avatar
sletz committed
276
277
278
279
280
281
282
        protected:

            int fNPorts;
            int fLastSubCycle;
            char* fNetBuffer;
            sample_t** fPortBuffer;

283
        public:
sletz's avatar
sletz committed
284

sletz's avatar
sletz committed
285
286
            NetAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
            virtual ~NetAudioBuffer();
sletz's avatar
sletz committed
287

sletz's avatar
sletz committed
288
289
            // needed syze in bytes ofr an entire cycle
            virtual size_t GetCycleSize() = 0;
sletz's avatar
sletz committed
290

sletz's avatar
sletz committed
291
292
            // cycle duration in sec
            virtual float GetCycleDuration() = 0;
sletz's avatar
sletz committed
293

sletz's avatar
sletz committed
294
            virtual int GetNumPackets() = 0;
sletz's avatar
sletz committed
295

sletz's avatar
sletz committed
296
297
298
            virtual void SetBuffer(int index, sample_t* buffer);
            virtual sample_t* GetBuffer(int index);

299
            //jack<->buffer
sletz's avatar
sletz committed
300
301
            virtual void RenderFromJackPorts() = 0;
            virtual void RenderToJackPorts() = 0;
sletz's avatar
sletz committed
302

sletz's avatar
sletz committed
303
            //network<->buffer
sletz's avatar
sletz committed
304
            virtual int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num) = 0;
sletz's avatar
sletz committed
305
            virtual int RenderToNetwork(int sub_cycle, uint32_t& port_num) = 0;
306

sletz's avatar
sletz committed
307
308
            virtual void ActivePortsToNetwork(char* net_buffer, uint32_t& port_num);
            virtual void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num);
sletz's avatar
sletz committed
309

310
311
   };

moret's avatar
moret committed
312
313
    /**
    \Brief Audio buffer and operations class
314

moret's avatar
moret committed
315
316
317
318
    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.
319

moret's avatar
moret committed
320
    */
sletz's avatar
sletz committed
321

322
    struct JackPortList {
sletz's avatar
sletz committed
323

sletz's avatar
sletz committed
324
325
        // "[---Header---|--audio data--|--audio data--]..."

326
327
328
329
        jack_nframes_t fPeriodSize;
        jack_nframes_t fSubPeriodSize;
        size_t fSubPeriodBytesSize;
        sample_t** fPortBuffer;
330
        int fPacketSize;
331
        int fNPorts;
sletz's avatar
sletz committed
332
333
        size_t fCycleSize;      // needed size in bytes for an entire cycle
        float fCycleDuration;   // in sec
sletz's avatar
sletz committed
334

sletz's avatar
sletz committed
335
        int fLastSubCycle;
sletz's avatar
sletz committed
336

337
338
339
340
        JackPortList(session_params_t* params, uint32_t nports)
        {
            fNPorts = nports;
            fPeriodSize = params->fPeriodSize;
341
342
            fPacketSize = params->fMtu - sizeof(packet_header_t);

sletz's avatar
sletz committed
343
            if (params->fSendAudioChannels == 0 && params->fReturnAudioChannels == 0) {
sletz's avatar
sletz committed
344
345
                fSubPeriodSize = params->fPeriodSize;
            } else {
346
                jack_nframes_t period = (int) powf(2.f,(int)(log(float(fPacketSize)
sletz's avatar
sletz committed
347
                                                   / (max(params->fReturnAudioChannels, params->fSendAudioChannels) * sizeof(sample_t))) / log(2.)));
348
                fSubPeriodSize = (period > fPeriodSize) ? fPeriodSize : period;
sletz's avatar
sletz committed
349
            }
sletz's avatar
sletz committed
350

sletz's avatar
sletz committed
351
            fSubPeriodBytesSize = fSubPeriodSize * sizeof(sample_t);
sletz's avatar
sletz committed
352

353
            fPortBuffer = new sample_t* [fNPorts];
354
            for (int port_index = 0; port_index < fNPorts; port_index++) {
355
                fPortBuffer[port_index] = NULL;
356
            }
sletz's avatar
sletz committed
357

sletz's avatar
sletz committed
358
            fCycleDuration = float(fSubPeriodSize) / float(params->fSampleRate);
sletz's avatar
sletz committed
359
            fCycleSize = params->fMtu * (fPeriodSize / fSubPeriodSize);
sletz's avatar
sletz committed
360

sletz's avatar
sletz committed
361
362
            fLastSubCycle = -1;
        }
sletz's avatar
sletz committed
363

364
        virtual int GetNumPackets()
sletz's avatar
sletz committed
365
        {
sletz's avatar
sletz committed
366
            /*
sletz's avatar
sletz committed
367
            jack_log("GetNumPackets packet = %d  fPeriodSize = %d fSubPeriodSize = %d fSubPeriodBytesSize = %d",
368
                fPeriodSize / fSubPeriodSize, fPeriodSize, fSubPeriodSize, fSubPeriodBytesSize);
sletz's avatar
sletz committed
369
            */
sletz's avatar
sletz committed
370
            return fPeriodSize / fSubPeriodSize;
371
        }
sletz's avatar
sletz committed
372

373
374
375
376
377
378
379
380
        JackPortList()
        {
            fNPorts = 0;
            fPeriodSize = 0;
            fSubPeriodSize = 0;
            fSubPeriodBytesSize = 0;
            fPortBuffer = 0;
        }
sletz's avatar
sletz committed
381

sletz's avatar
sletz committed
382
        virtual ~JackPortList()
383
384
385
        {
            delete [] fPortBuffer;
        }
sletz's avatar
sletz committed
386

sletz's avatar
sletz committed
387
        void SetBuffer(int index, sample_t* buffer)
388
389
390
        {
            fPortBuffer[index] = buffer;
        }
sletz's avatar
sletz committed
391

sletz's avatar
sletz committed
392
        sample_t* GetBuffer(int index)
393
394
395
        {
            return fPortBuffer[index];
        }
sletz's avatar
sletz committed
396

397
398
        void Copy(sample_t** buffers)
        {
sletz's avatar
sletz committed
399
            for (int port_index = 0; port_index < fNPorts; port_index++) {
400
                memcpy(buffers[port_index], fPortBuffer[port_index], fPeriodSize * sizeof(float));
sletz's avatar
sletz committed
401
            }
402
        }
sletz's avatar
sletz committed
403

sletz's avatar
sletz committed
404
        // needed syze in bytes for an entire cycle
sletz's avatar
sletz committed
405
406
407
408
        size_t GetCycleSize()
        {
            return fCycleSize;
        }
sletz's avatar
sletz committed
409

sletz's avatar
sletz committed
410
411
412
413
414
        // cycle duration in sec
        float GetCycleDuration()
        {
            return fCycleDuration;
        }
sletz's avatar
sletz committed
415

416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
    #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
434
435
        virtual void RenderFromJackPorts()
        {}
436

sletz's avatar
sletz committed
437
438
        virtual void RenderToJackPorts()
        {}
sletz's avatar
sletz committed
439

sletz's avatar
sletz committed
440
        //network<->buffer
sletz's avatar
sletz committed
441
        virtual int RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
sletz's avatar
sletz committed
442
        {
sletz's avatar
sletz committed
443
444
            int res = 0;

445
            for (int port_index = 0; port_index < fNPorts; port_index++) {
446
                float* src = (float*)(net_buffer + port_index * fSubPeriodBytesSize);
447
                float* dst = (float*)(fPortBuffer[port_index] + sub_cycle * fSubPeriodSize);
448
449
450
                for (unsigned int sample = 0; sample < fSubPeriodBytesSize / sizeof(float); sample++) {
                    dst[sample] = SwapFloat(src[sample]);
                }
sletz's avatar
sletz committed
451
            }
452
453
            if (sub_cycle != fLastSubCycle + 1) {
                jack_error("Packet(s) missing from... %d %d", fLastSubCycle, sub_cycle);
sletz's avatar
sletz committed
454
                res = NET_PACKET_ERROR;
455
            }
sletz's avatar
sletz committed
456

457
            fLastSubCycle = sub_cycle;
sletz's avatar
sletz committed
458
            return res;
sletz's avatar
sletz committed
459
        }
sletz's avatar
sletz committed
460

sletz's avatar
sletz committed
461
        virtual int RenderToNetwork(char* net_buffer, int sub_cycle, uint32_t& port_num)
sletz's avatar
sletz committed
462
        {
463
            for (int port_index = 0; port_index < fNPorts; port_index++) {
464
                float* src = (float*)(fPortBuffer[port_index] + sub_cycle * fSubPeriodSize);
sletz's avatar
sletz committed
465
466
467
468
469
                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
470

471
            port_num = fNPorts;
sletz's avatar
sletz committed
472
            return fNPorts * fSubPeriodBytesSize;
473
        }
sletz's avatar
sletz committed
474

475
476
    #else

sletz's avatar
sletz committed
477
478
        virtual void RenderFromJackPorts()
        {}
479

sletz's avatar
sletz committed
480
        virtual void RenderToJackPorts()
sletz's avatar
sletz committed
481
        {
sletz's avatar
sletz committed
482
            // reset for next cycle
sletz's avatar
sletz committed
483
484
            fLastSubCycle = -1;
        }
sletz's avatar
sletz committed
485

486
        //network<->buffer
sletz's avatar
sletz committed
487
        virtual int RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
488
        {
sletz's avatar
sletz committed
489
490
            int res = 0;

491
492
493
494
495
            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
496
                res = NET_PACKET_ERROR;
sletz's avatar
sletz committed
497
            }
sletz's avatar
sletz committed
498

499
            fLastSubCycle = sub_cycle;
sletz's avatar
sletz committed
500
            return res;
sletz's avatar
sletz committed
501
        }
sletz's avatar
sletz committed
502

sletz's avatar
sletz committed
503
        virtual int RenderToNetwork(char* net_buffer, int sub_cycle, uint32_t& port_num)
sletz's avatar
sletz committed
504
        {
505
506
507
508
            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
509
            return fNPorts * fSubPeriodBytesSize;
510
511
512
        }

    #endif
sletz's avatar
sletz committed
513

514
515
516
517
518
        virtual void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num)
        {}

        virtual void ActivePortsToNetwork(char* net_buffer, uint32_t& port_num)
        {
sletz's avatar
sletz committed
519
            // Default behaviour: all ports are active
520
521
522
            port_num = fNPorts;
        }

523
    };
sletz's avatar
sletz committed
524

525
526
    struct JackOptimizedPortList : JackPortList {

527
        // Consuming port list is transmitted in the Sync packed
sletz's avatar
sletz committed
528
        // "[---Header---|--active_port_num (uint32_t) ---audio data--|--active_port_num (uint32_t) ---audio data--]..."
sletz's avatar
sletz committed
529

530
531
532
533
        JackOptimizedPortList(session_params_t* params, uint32_t nports)
            :JackPortList(params, nports)
        {}

sletz's avatar
sletz committed
534
535
536
        virtual ~JackOptimizedPortList()
        {}

537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
        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
sletz's avatar
sletz committed
553

sletz's avatar
sletz committed
554
            /*
sletz's avatar
sletz committed
555
556
            jack_log("GetNumPackets packet = %d  fPeriodSize = %d fSubPeriodSize = %d fSubPeriodBytesSize = %d",
                fPeriodSize / fSubPeriodSize, fPeriodSize, fSubPeriodSize, fSubPeriodBytesSize);
sletz's avatar
sletz committed
557
            */
558
            return fPeriodSize / fSubPeriodSize; // At least one packet
559
560
561
562
563
564
565
566
567
        }

    #ifdef __BIG_ENDIAN__

        // TODO

    #else

        //network<->buffer
sletz's avatar
sletz committed
568
        virtual int RenderFromNetwork(char* net_buffer, int cycle, int sub_cycle, size_t copy_size, uint32_t port_num)
569
        {
sletz's avatar
sletz committed
570
571
            int res = 0;

sletz's avatar
sletz committed
572
573
574
            // Cleanup all JACK ports at the beginning of the cycle
            if (sub_cycle == 0) {
                for (int port_index = 0; port_index < fNPorts; port_index++) {
575
                    if (fPortBuffer[port_index]) {
sletz's avatar
sletz committed
576
                        memset(fPortBuffer[port_index], 0, fPeriodSize * sizeof(sample_t));
577
                    }
sletz's avatar
sletz committed
578
579
580
                }
            }

581
582
583
584
585
586
587
588
589
590
591
            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
592

593
594
                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
sletz's avatar
sletz committed
595
596
                    uint32_t* active_port_address = (uint32_t*)(net_buffer + port_index * sub_period_bytes_size);
                    uint32_t active_port = (uint32_t)(*active_port_address);
597
                    if (fPortBuffer[port_index]) {
sletz's avatar
sletz committed
598
                        memcpy(fPortBuffer[active_port] + sub_cycle * sub_period_size, (char*)(active_port_address + 1), sub_period_bytes_size - sizeof(uint32_t));
599
                    }
600
                }
601

602
603
                if (sub_cycle != fLastSubCycle + 1) {
                    jack_error("Packet(s) missing from... %d %d", fLastSubCycle, sub_cycle);
sletz's avatar
sletz committed
604
                    res = NET_PACKET_ERROR;
605
                }
sletz's avatar
sletz committed
606

607
                fLastSubCycle = sub_cycle;
608
            }
sletz's avatar
sletz committed
609
610

            return res;
611
612
        }

sletz's avatar
sletz committed
613
        virtual int RenderToNetwork(char* net_buffer,int sub_cycle, uint32_t& port_num)
614
        {
sletz's avatar
sletz committed
615
            // Init active port count
616
617
618
            port_num = 0;

            for (int port_index = 0; port_index < fNPorts; port_index++) {
sletz's avatar
sletz committed
619
                // Only copy from active ports : write the active port number then audio data
620
                if (fPortBuffer[port_index]) {
sletz's avatar
sletz committed
621
                    uint32_t* active_port_address = (uint32_t*)(net_buffer + port_num * fSubPeriodBytesSize);
622
623
624
625
626
627
628
629
630
631
632
                    *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

633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
        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++) {
659
                // Use -1 when port is actually connected on other side
sletz's avatar
sletz committed
660
661
662
663
664
                if (*active_port_address >= 0 && *active_port_address < fNPorts) {
                    fPortBuffer[*active_port_address] = (sample_t*)-1;
                } else {
                    jack_error("ActivePortsFromNetwork: incorrect port = %d", *active_port_address);
                }
665
666
667
668
                active_port_address++;
            }
        }

669
670
    };

sletz's avatar
sletz committed
671
    class SERVER_EXPORT NetFloatAudioBuffer : public NetAudioBuffer
672
    {
673
        private:
sletz's avatar
sletz committed
674

675
        #ifdef OPTIMIZED_PROTOCOL
sletz's avatar
sletz committed
676
            JackOptimizedPortList fPortBuffer1;
677
        #else
sletz's avatar
sletz committed
678
            JackPortList fPortBuffer1;
679
        #endif
sletz's avatar
sletz committed
680

681
        public:
sletz's avatar
sletz committed
682

sletz's avatar
sletz committed
683
            NetFloatAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
sletz's avatar
sletz committed
684
            virtual ~NetFloatAudioBuffer();
sletz's avatar
sletz committed
685

sletz's avatar
sletz committed
686
687
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
688

sletz's avatar
sletz committed
689
            // cycle duration in sec
sletz's avatar
sletz committed
690
691
            float GetCycleDuration()
            {
sletz's avatar
sletz committed
692
                return fPortBuffer1.GetCycleDuration();
sletz's avatar
sletz committed
693
            }
sletz's avatar
sletz committed
694

sletz's avatar
sletz committed
695
696
            int GetNumPackets()
            {
sletz's avatar
sletz committed
697
                return fPortBuffer1.GetNumPackets();
sletz's avatar
sletz committed
698
            }
sletz's avatar
sletz committed
699

700
            //jack<->buffer
sletz's avatar
sletz committed
701
702
            void RenderFromJackPorts();
            void RenderToJackPorts();
703

sletz's avatar
sletz committed
704

sletz's avatar
sletz committed
705
706
            void SetBuffer(int index, sample_t* buffer);
            sample_t* GetBuffer(int index);
sletz's avatar
sletz committed
707

sletz's avatar
sletz committed
708

sletz's avatar
sletz committed
709
            //network<->buffer
sletz's avatar
sletz committed
710
            int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
711
            int RenderToNetwork(int sub_cycle, uint32_t&  ort_num);
sletz's avatar
sletz committed
712
713

            void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num);
714
            void ActivePortsToNetwork(char* net_buffer, uint32_t& port_num);
715
    };
sletz's avatar
sletz committed
716

sletz's avatar
sletz committed
717
718
719
720
721
722
723
724
725
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
    class SERVER_EXPORT NetFloatAudioBuffer1 : public NetAudioBuffer
    {

        private:

            jack_nframes_t fPeriodSize;
            jack_nframes_t fSubPeriodSize;
            size_t fSubPeriodBytesSize;
            int fPacketSize;
            size_t fCycleSize;      // needed size in bytes for an entire cycle
            float fCycleDuration;   // in sec

        public:

            NetFloatAudioBuffer1(session_params_t* params, uint32_t nports, char* net_buffer);
            virtual ~NetFloatAudioBuffer1();

            // needed size in bytes for an entire cycle
            size_t GetCycleSize();

            // cycle duration in sec
            float GetCycleDuration();

            int GetNumPackets();

            virtual void RenderFromJackPorts()
            {}

            virtual void RenderToJackPorts()
            {
                // reset for next cycle
                fLastSubCycle = -1;
            }

            //jack<->buffer
            int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
            int RenderToNetwork(int sub_cycle, uint32_t& port_num);

    };

nedko's avatar
nedko committed
757
#if HAVE_CELT
sletz's avatar
sletz committed
758
759
760
761
762
763

#include <celt/celt.h>

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

765
766
767
            CELTMode** fCeltMode;
            CELTEncoder** fCeltEncoder;
            CELTDecoder** fCeltDecoder;
sletz's avatar
sletz committed
768

sletz's avatar
sletz committed
769
770
            int fCompressedSizeByte;
            jack_nframes_t fPeriodSize;
771

sletz's avatar
sletz committed
772
            int fNumPackets;
sletz's avatar
sletz committed
773
774
            float fCycleDuration;   // in sec
            size_t fCycleSize;      // needed size in bytes for an entire cycle
sletz's avatar
sletz committed
775

sletz's avatar
sletz committed
776
777
            size_t fSubPeriodBytesSize;
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
778

779
            unsigned char** fCompressedBuffer;
sletz's avatar
sletz committed
780

sletz's avatar
sletz committed
781
            void FreeCelt();
sletz's avatar
sletz committed
782

sletz's avatar
sletz committed
783
        public:
sletz's avatar
sletz committed
784

785
            NetCeltAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer, int kbps);
786
            virtual ~NetCeltAudioBuffer();
sletz's avatar
sletz committed
787

sletz's avatar
sletz committed
788
789
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
790

sletz's avatar
sletz committed
791
792
793
             // cycle duration in sec
            float GetCycleDuration();
            int GetNumPackets();
sletz's avatar
sletz committed
794

sletz's avatar
sletz committed
795
            //jack<->buffer
sletz's avatar
sletz committed
796
797
            void RenderFromJackPorts();
            void RenderToJackPorts();
sletz's avatar
sletz committed
798
799

            //network<->buffer
sletz's avatar
sletz committed
800
            int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
sletz's avatar
sletz committed
801
            int RenderToNetwork(int sub_cycle, uint32_t&  port_num);
sletz's avatar
sletz committed
802
803
804
    };

#endif
sletz's avatar
sletz committed
805
806
807
808

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

sletz's avatar
sletz committed
810
811
            int fCompressedSizeByte;
            jack_nframes_t fPeriodSize;
sletz's avatar
sletz committed
812

sletz's avatar
sletz committed
813
            int fNumPackets;
sletz's avatar
sletz committed
814

sletz's avatar
sletz committed
815
816
            float fCycleDuration;   // in sec
            size_t fCycleSize;      // needed size in bytes for an entire cycle
sletz's avatar
sletz committed
817

sletz's avatar
sletz committed
818
819
            size_t fSubPeriodSize;
            size_t fSubPeriodBytesSize;
sletz's avatar
sletz committed
820

821
            size_t fLastSubPeriodSize;
sletz's avatar
sletz committed
822
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
823

824
            short** fIntBuffer;
sletz's avatar
sletz committed
825

sletz's avatar
sletz committed
826
        public:
sletz's avatar
sletz committed
827

sletz's avatar
sletz committed
828
            NetIntAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
829
            virtual ~NetIntAudioBuffer();
sletz's avatar
sletz committed
830

sletz's avatar
sletz committed
831
832
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
833

sletz's avatar
sletz committed
834
835
836
             // cycle duration in sec
            float GetCycleDuration();
            int GetNumPackets();
sletz's avatar
sletz committed
837

sletz's avatar
sletz committed
838
            //jack<->buffer
sletz's avatar
sletz committed
839
840
            void RenderFromJackPorts();
            void RenderToJackPorts();
sletz's avatar
sletz committed
841
842

            //network<->buffer
sletz's avatar
sletz committed
843
            int RenderFromNetwork(int cycle, int sub_cycle, size_t copy_size, uint32_t port_num);
sletz's avatar
sletz committed
844
            int RenderToNetwork(int sub_cycle, uint32_t& port_num);
sletz's avatar
sletz committed
845
846
    };

sletz's avatar
sletz committed
847
    //utility *************************************************************************************
848
849

    //socket API management
850
851
    SERVER_EXPORT int SocketAPIInit();
    SERVER_EXPORT int SocketAPIEnd();
852
    //n<-->h functions
sletz's avatar
sletz committed
853
854
855
856
857
858
859
860
    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);
861
    //display session parameters
sletz's avatar
sletz committed
862
    SERVER_EXPORT void SessionParamsDisplay(session_params_t* params);
863
    //display packet header
sletz's avatar
sletz committed
864
    SERVER_EXPORT void PacketHeaderDisplay(packet_header_t* header);
865
    //get the packet type from a sesion parameters
sletz's avatar
sletz committed
866
    SERVER_EXPORT sync_packet_type_t GetPacketType(session_params_t* params);
867
    //set the packet type in a session parameters
sletz's avatar
sletz committed
868
    SERVER_EXPORT int SetPacketType(session_params_t* params, sync_packet_type_t packet_type);
869
    //transport utility
sletz's avatar
sletz committed
870
871
    SERVER_EXPORT const char* GetTransportState(int transport_state);
    SERVER_EXPORT void NetTransportDataDisplay(net_transport_data_t* data);
sletz's avatar
sletz committed
872
}