JackNetTool.h 16.1 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 "types.h"
23
#include "transport.h"
sletz's avatar
sletz committed
24
#ifndef WIN32
25
#include <netinet/in.h>
sletz's avatar
sletz committed
26
#endif
sletz's avatar
sletz committed
27
28
#include <cmath>

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

sletz's avatar
sletz committed
31
32
#ifndef htonll
#ifdef __BIG_ENDIAN__
33
34
#define htonll(x) (x)
#define ntohll(x) (x)
sletz's avatar
sletz committed
35
#else
36
37
#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
38
39
40
#endif
#endif

41
42
#define MASTER_PROTOCOL 6
#define SLAVE_PROTOCOL 6
43

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

46
47
#define OPTIMIZED_PROTOCOL

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

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

60
61
62
63
64
65
    enum JackNetEncoder {

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

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

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

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

86
    PRE_PACKED_STRUCTURE
87
88
    struct _session_params
    {
89
90
91
        char fPacketType[8];                //packet type ('param')
        uint32_t fProtocolVersion;          //version
        int32_t fPacketID;                 //indicates the packet type
moret's avatar
moret committed
92
93
94
95
96
97
        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
    } POST_PACKED_STRUCTURE;
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
    PRE_PACKED_STRUCTURE
170
171
    struct _packet_header
    {
172
173
174
        char fPacketType[8];        //packet type ('headr')
        uint32_t fDataType;         //a for audio, m for midi and s for sync
        uint32_t fDataStream;       //s for send, r for return
175
        uint32_t fID;               //unique ID of the slave
sletz's avatar
sletz committed
176
        uint32_t fNumPacket;        //number of data packets of the cycle
moret's avatar
moret committed
177
        uint32_t fPacketSize;       //packet size in bytes
178
        uint32_t fActivePorts;      //number of active ports
179
180
        uint32_t fCycle;            //process cycle counter
        uint32_t fSubCycle;         //midi/audio subcycle counter
moret's avatar
moret committed
181
        uint32_t fIsLastPckt;       //is it the last packet of a given cycle ('y' or 'n')
182
    } POST_PACKED_STRUCTURE;
sletz's avatar
sletz committed
183

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

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

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

    typedef enum _net_timebase_master net_timebase_master_t;


201
202
//transport data ******************************************************************************

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

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

sletz's avatar
sletz committed
216
 //midi data ***********************************************************************************
sletz's avatar
sletz committed
217

moret's avatar
moret committed
218
219
    /**
    \Brief Midi buffer and operations class
220

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

moret's avatar
moret committed
231
    */
232

233
    class SERVER_EXPORT NetMidiBuffer
234
    {
235
        private:
sletz's avatar
sletz committed
236

237
238
239
            int fNPorts;
            size_t fMaxBufsize;
            int fMaxPcktSize;
sletz's avatar
sletz committed
240

241
242
243
            char* fBuffer;
            char* fNetBuffer;
            JackMidiBuffer** fPortBuffer;
sletz's avatar
sletz committed
244

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

        public:
sletz's avatar
sletz committed
248

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

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

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

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

261
262
            //utility
            void DisplayEvents();
sletz's avatar
sletz committed
263

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

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

272
    };
sletz's avatar
sletz committed
273
274
275

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

sletz's avatar
sletz committed
276
    class SERVER_EXPORT NetAudioBuffer
277
    {
sletz's avatar
sletz committed
278

sletz's avatar
sletz committed
279
280
281
282
        protected:

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

sletz's avatar
sletz committed
284
285
            char* fNetBuffer;
            sample_t** fPortBuffer;
286
            bool* fConnectedPorts;
sletz's avatar
sletz committed
287

sletz's avatar
sletz committed
288
289
290
291
292
293
294
295
296
297
298
            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();

299
        public:
sletz's avatar
sletz committed
300

sletz's avatar
sletz committed
301
302
            NetAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
            virtual ~NetAudioBuffer();
sletz's avatar
sletz committed
303

304
305
306
            bool GetConnected(int port_index) { return fConnectedPorts[port_index]; }
            void SetConnected(int port_index, bool state) { fConnectedPorts[port_index] = state; }

sletz's avatar
sletz committed
307
308
            // needed syze in bytes ofr an entire cycle
            virtual size_t GetCycleSize() = 0;
sletz's avatar
sletz committed
309

sletz's avatar
sletz committed
310
311
            // cycle duration in sec
            virtual float GetCycleDuration() = 0;
sletz's avatar
sletz committed
312

sletz's avatar
sletz committed
313
            virtual int GetNumPackets(int active_ports) = 0;
sletz's avatar
sletz committed
314

sletz's avatar
sletz committed
315
316
317
            virtual void SetBuffer(int index, sample_t* buffer);
            virtual sample_t* GetBuffer(int index);

318
            //jack<->buffer
sletz's avatar
sletz committed
319
320
            virtual int RenderFromJackPorts();
            virtual void RenderToJackPorts();
sletz's avatar
sletz committed
321

sletz's avatar
sletz committed
322
            //network<->buffer
sletz's avatar
sletz committed
323
324
            virtual int RenderFromNetwork(int cycle, int sub_cycle, uint32_t port_num) = 0;
            virtual int RenderToNetwork(int sub_cycle, uint32_t port_num) = 0;
325

sletz's avatar
sletz committed
326
327
            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) {}
328

sletz's avatar
sletz committed
329
330
            virtual int ActivePortsToNetwork(char* net_buffer);
            virtual void ActivePortsFromNetwork(char* net_buffer, uint32_t port_num);
331

332
333
    };

sletz's avatar
sletz committed
334
    class SERVER_EXPORT NetFloatAudioBuffer : public NetAudioBuffer
sletz's avatar
sletz committed
335
336
337
338
339
    {

        private:

            int fPacketSize;
sletz's avatar
sletz committed
340
341

            void UpdateParams(int active_ports);
sletz's avatar
sletz committed
342
343
344

        public:

sletz's avatar
sletz committed
345
346
            NetFloatAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
            virtual ~NetFloatAudioBuffer();
sletz's avatar
sletz committed
347
348
349
350
351
352

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

            // cycle duration in sec
            float GetCycleDuration();
sletz's avatar
sletz committed
353
            int GetNumPackets(int active_ports);
sletz's avatar
sletz committed
354
355

            //jack<->buffer
sletz's avatar
sletz committed
356
357
358
            int RenderFromNetwork(int cycle, int sub_cycle, uint32_t port_num);
            int RenderToNetwork(int sub_cycle, uint32_t port_num);

359
360
            void RenderFromNetwork(char* net_buffer, int active_port, int sub_cycle);
            void RenderToNetwork(char* net_buffer, int active_port, int sub_cycle);
sletz's avatar
sletz committed
361
362
363

    };

nedko's avatar
nedko committed
364
#if HAVE_CELT
sletz's avatar
sletz committed
365
366
367
368
369
370

#include <celt/celt.h>

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

372
373
374
            CELTMode** fCeltMode;
            CELTEncoder** fCeltEncoder;
            CELTDecoder** fCeltDecoder;
sletz's avatar
sletz committed
375

sletz's avatar
sletz committed
376
377
            int fCompressedSizeByte;
            int fNumPackets;
sletz's avatar
sletz committed
378

sletz's avatar
sletz committed
379
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
380

381
            unsigned char** fCompressedBuffer;
sletz's avatar
sletz committed
382

sletz's avatar
sletz committed
383
            void FreeCelt();
sletz's avatar
sletz committed
384

sletz's avatar
sletz committed
385
        public:
sletz's avatar
sletz committed
386

387
            NetCeltAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer, int kbps);
388
            virtual ~NetCeltAudioBuffer();
sletz's avatar
sletz committed
389

sletz's avatar
sletz committed
390
391
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
392

sletz's avatar
sletz committed
393
394
             // cycle duration in sec
            float GetCycleDuration();
sletz's avatar
sletz committed
395
            int GetNumPackets(int active_ports);
sletz's avatar
sletz committed
396

sletz's avatar
sletz committed
397
            //jack<->buffer
sletz's avatar
sletz committed
398
            int RenderFromJackPorts();
sletz's avatar
sletz committed
399
            void RenderToJackPorts();
sletz's avatar
sletz committed
400
401

            //network<->buffer
sletz's avatar
sletz committed
402
403
            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
404
405
406
    };

#endif
sletz's avatar
sletz committed
407
408
409
410

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

sletz's avatar
sletz committed
412
413
            int fCompressedSizeByte;
            int fNumPackets;
sletz's avatar
sletz committed
414

sletz's avatar
sletz committed
415
            size_t fLastSubPeriodBytesSize;
sletz's avatar
sletz committed
416

417
            short** fIntBuffer;
sletz's avatar
sletz committed
418

sletz's avatar
sletz committed
419
        public:
sletz's avatar
sletz committed
420

sletz's avatar
sletz committed
421
            NetIntAudioBuffer(session_params_t* params, uint32_t nports, char* net_buffer);
422
            virtual ~NetIntAudioBuffer();
sletz's avatar
sletz committed
423

sletz's avatar
sletz committed
424
425
            // needed size in bytes for an entire cycle
            size_t GetCycleSize();
sletz's avatar
sletz committed
426

sletz's avatar
sletz committed
427
428
             // cycle duration in sec
            float GetCycleDuration();
sletz's avatar
sletz committed
429
            int GetNumPackets(int active_ports);
sletz's avatar
sletz committed
430

sletz's avatar
sletz committed
431
            //jack<->buffer
sletz's avatar
sletz committed
432
            int RenderFromJackPorts();
sletz's avatar
sletz committed
433
            void RenderToJackPorts();
sletz's avatar
sletz committed
434
435

            //network<->buffer
sletz's avatar
sletz committed
436
437
            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
438
439
    };

sletz's avatar
sletz committed
440
    //utility *************************************************************************************
441
442

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