JackNetTool.h 15.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
            int fNPorts;
            size_t fMaxBufsize;
            int fMaxPcktSize;
sletz's avatar
sletz committed
238

239
240
241
            char* fBuffer;
            char* fNetBuffer;
            JackMidiBuffer** fPortBuffer;
sletz's avatar
sletz committed
242

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

        public:
sletz's avatar
sletz committed
246

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

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

sletz's avatar
sletz committed
252
253
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
254
            int GetNumPackets(int data_sizen, int max_size);
sletz's avatar
sletz committed
255

sletz's avatar
sletz committed
256
257
258
            void SetBuffer(int index, JackMidiBuffer* buffer);
            JackMidiBuffer* GetBuffer(int index);

259
260
            //utility
            void DisplayEvents();
sletz's avatar
sletz committed
261

262
263
            //jack<->buffer
            int RenderFromJackPorts();
sletz's avatar
sletz committed
264
            void RenderToJackPorts();
sletz's avatar
sletz committed
265

266
            //network<->buffer
267
            void RenderFromNetwork(int sub_cycle, size_t copy_size);
268
            int RenderToNetwork(int sub_cycle, size_t total_size);
269

270
    };
sletz's avatar
sletz committed
271
272
273

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

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

sletz's avatar
sletz committed
277
278
279
280
        protected:

            int fNPorts;
            int fLastSubCycle;
sletz's avatar
sletz committed
281

sletz's avatar
sletz committed
282
283
284
            char* fNetBuffer;
            sample_t** fPortBuffer;

sletz's avatar
sletz committed
285
286
287
288
289
290
291
292
293
294
295
            jack_nframes_t fPeriodSize;
            jack_nframes_t fSubPeriodSize;
            size_t fSubPeriodBytesSize;

            float fCycleDuration;       // in sec
            size_t fCycleBytesSize;     // needed size in bytes for an entire cycle

            int CheckPacket(int cycle, int sub_cycle);
            void NextCycle();
            void Cleanup();

296
        public:
sletz's avatar
sletz committed
297

sletz's avatar
sletz committed
298
299
            NetAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
            virtual ~NetAudioBuffer();
sletz's avatar
sletz committed
300

sletz's avatar
sletz committed
301
302
            // needed syze in bytes ofr an entire cycle
            virtual size_t GetCycleSize() = 0;
sletz's avatar
sletz committed
303

sletz's avatar
sletz committed
304
305
            // cycle duration in sec
            virtual float GetCycleDuration() = 0;
sletz's avatar
sletz committed
306

sletz's avatar
sletz committed
307
            virtual int GetNumPackets(int active_ports) = 0;
sletz's avatar
sletz committed
308

sletz's avatar
sletz committed
309
310
311
            virtual void SetBuffer(int index, sample_t* buffer);
            virtual sample_t* GetBuffer(int index);

312
            //jack<->buffer
sletz's avatar
sletz committed
313
314
            virtual int RenderFromJackPorts();
            virtual void RenderToJackPorts();
sletz's avatar
sletz committed
315

sletz's avatar
sletz committed
316
            //network<->buffer
sletz's avatar
sletz committed
317
318
            virtual int RenderFromNetwork(int cycle, int sub_cycle, uint32_t port_num) = 0;
            virtual int RenderToNetwork(int sub_cycle, uint32_t port_num) = 0;
319

sletz's avatar
sletz committed
320
321
            virtual void RenderFromNetwork(char* net_buffer, int active_port, int sub_cycle, size_t copy_size) {}
            virtual void RenderToNetwork(char* net_buffer, int active_port, int sub_cycle, size_t copy_size) {}
322

sletz's avatar
sletz committed
323
324
            virtual int ActivePortsToNetwork(char* net_buffer);
            virtual void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num);
325

326
327
    };

sletz's avatar
sletz committed
328
    class SERVER_EXPORT NetFloatAudioBuffer : public NetAudioBuffer
sletz's avatar
sletz committed
329
330
331
332
333
    {

        private:

            int fPacketSize;
sletz's avatar
sletz committed
334
335

            void UpdateParams(int active_ports);
sletz's avatar
sletz committed
336
337
338

        public:

sletz's avatar
sletz committed
339
340
            NetFloatAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
            virtual ~NetFloatAudioBuffer();
sletz's avatar
sletz committed
341
342
343
344
345
346

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

            // cycle duration in sec
            float GetCycleDuration();
sletz's avatar
sletz committed
347
            int GetNumPackets(int active_ports);
sletz's avatar
sletz committed
348
349

            //jack<->buffer
sletz's avatar
sletz committed
350
351
352
353
354
            int RenderFromNetwork(int cycle, int sub_cycle, uint32_t port_num);
            int RenderToNetwork(int sub_cycle, uint32_t port_num);

            void RenderFromNetwork(char* net_buffer, int active_port, int sub_cycle, size_t copy_size);
            void RenderToNetwork(char* net_buffer, int active_port, int sub_cycle, size_t copy_size);
sletz's avatar
sletz committed
355
356
357

    };

nedko's avatar
nedko committed
358
#if HAVE_CELT
sletz's avatar
sletz committed
359
360
361
362
363
364

#include <celt/celt.h>

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

366
367
368
            CELTMode** fCeltMode;
            CELTEncoder** fCeltEncoder;
            CELTDecoder** fCeltDecoder;
sletz's avatar
sletz committed
369

sletz's avatar
sletz committed
370
371
            int fCompressedSizeByte;
            int fNumPackets;
sletz's avatar
sletz committed
372

sletz's avatar
sletz committed
373
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
374

375
            unsigned char** fCompressedBuffer;
sletz's avatar
sletz committed
376

sletz's avatar
sletz committed
377
            void FreeCelt();
sletz's avatar
sletz committed
378

sletz's avatar
sletz committed
379
        public:
sletz's avatar
sletz committed
380

381
            NetCeltAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer, int kbps);
382
            virtual ~NetCeltAudioBuffer();
sletz's avatar
sletz committed
383

sletz's avatar
sletz committed
384
385
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
386

sletz's avatar
sletz committed
387
388
             // cycle duration in sec
            float GetCycleDuration();
sletz's avatar
sletz committed
389
            int GetNumPackets(int active_ports);
sletz's avatar
sletz committed
390

sletz's avatar
sletz committed
391
            //jack<->buffer
sletz's avatar
sletz committed
392
            int RenderFromJackPorts();
sletz's avatar
sletz committed
393
            void RenderToJackPorts();
sletz's avatar
sletz committed
394
395

            //network<->buffer
sletz's avatar
sletz committed
396
397
            int RenderFromNetwork(int cycle, int sub_cycle, uint32_t port_num);
            int RenderToNetwork(int sub_cycle, uint32_t  port_num);
sletz's avatar
sletz committed
398
399
400
    };

#endif
sletz's avatar
sletz committed
401
402
403
404

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

sletz's avatar
sletz committed
406
407
            int fCompressedSizeByte;
            int fNumPackets;
sletz's avatar
sletz committed
408

sletz's avatar
sletz committed
409
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
410

411
            short** fIntBuffer;
sletz's avatar
sletz committed
412

sletz's avatar
sletz committed
413
        public:
sletz's avatar
sletz committed
414

sletz's avatar
sletz committed
415
            NetIntAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
416
            virtual ~NetIntAudioBuffer();
sletz's avatar
sletz committed
417

sletz's avatar
sletz committed
418
419
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
420

sletz's avatar
sletz committed
421
422
             // cycle duration in sec
            float GetCycleDuration();
sletz's avatar
sletz committed
423
            int GetNumPackets(int active_ports);
sletz's avatar
sletz committed
424

sletz's avatar
sletz committed
425
            //jack<->buffer
sletz's avatar
sletz committed
426
            int RenderFromJackPorts();
sletz's avatar
sletz committed
427
            void RenderToJackPorts();
sletz's avatar
sletz committed
428
429

            //network<->buffer
sletz's avatar
sletz committed
430
431
            int RenderFromNetwork(int cycle, int sub_cycle, uint32_t port_num);
            int RenderToNetwork(int sub_cycle, uint32_t port_num);
sletz's avatar
sletz committed
432
433
    };

sletz's avatar
sletz committed
434
    //utility *************************************************************************************
435
436

    //socket API management
437
438
    SERVER_EXPORT int SocketAPIInit();
    SERVER_EXPORT int SocketAPIEnd();
439
    //n<-->h functions
sletz's avatar
sletz committed
440
441
442
443
444
445
446
447
    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);
448
    //display session parameters
sletz's avatar
sletz committed
449
    SERVER_EXPORT void SessionParamsDisplay(session_params_t* params);
450
    //display packet header
sletz's avatar
sletz committed
451
    SERVER_EXPORT void PacketHeaderDisplay(packet_header_t* header);
452
    //get the packet type from a sesion parameters
sletz's avatar
sletz committed
453
    SERVER_EXPORT sync_packet_type_t GetPacketType(session_params_t* params);
454
    //set the packet type in a session parameters
sletz's avatar
sletz committed
455
    SERVER_EXPORT int SetPacketType(session_params_t* params, sync_packet_type_t packet_type);
456
    //transport utility
sletz's avatar
sletz committed
457
458
    SERVER_EXPORT const char* GetTransportState(int transport_state);
    SERVER_EXPORT void NetTransportDataDisplay(net_transport_data_t* data);
sletz's avatar
sletz committed
459
}