JackNetTool.h 17.9 KB
Newer Older
1
/*
sletz's avatar
sletz committed
2
Copyright (C) 2008 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
34
35
36
37
38
39
40
41
#ifndef htonll
#ifdef __BIG_ENDIAN__
#define htonll(x)   (x)
#define ntohll(x)   (x)
#else
#define htonll(x)   ((((uint64_t)htonl(x)) << 32) + htonl(x >> 32))
#define ntohll(x)   ((((uint64_t)ntohl(x)) << 32) + ntohl(x >> 32))
#endif
#endif

sletz's avatar
sletz committed
42
43
namespace Jack
{
44
45
    typedef struct _session_params session_params_t;
    typedef struct _packet_header packet_header_t;
46
    typedef struct _net_transport_data net_transport_data_t;
47
48
49
    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
50
51
52

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

moret's avatar
moret committed
53
54
55
56
57
58
59
60
61
62
63
64
    /**
    \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
65

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

70
71
    #define MASTER_PROTOCOL 1
    #define SLAVE_PROTOCOL 1
72

73
74
    struct _session_params
    {
moret's avatar
moret committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
        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 ?
        uint32_t fSendAudioChannels;        //number of master->slave channels
        uint32_t fReturnAudioChannels;      //number of slave->master channels
        uint32_t fSendMidiChannels;         //number of master->slave midi channels
        uint32_t fReturnMidiChannels;       //number of slave->master midi channels
        uint32_t fSampleRate;               //session sample rate
        uint32_t fPeriodSize;               //period size
        uint32_t fFramesPerPacket;          //complete frames per packet
        uint32_t fBitdepth;                 //samples bitdepth (unused)
moret's avatar
moret committed
92
        uint32_t fSlaveSyncMode;            //is the slave in sync mode ?
93
        char fNetworkMode;                  //fast, normal or slow mode
94
    };
sletz's avatar
sletz committed
95
96
97

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

moret's avatar
moret committed
98
99
100
    /**
    \Brief This enum groups network error by type
    */
101

102
103
104
105
106
107
108
109
110
111
    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
112

113
    typedef enum _net_status net_status_t;
sletz's avatar
sletz committed
114
115
116

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

moret's avatar
moret committed
117
118
119
    /**
    \Brief This enum indicates the type of a sync packet (used in the initialization phase)
    */
120

121
122
    enum _sync_packet_type
    {
123
124
125
126
127
128
        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
129
    };
sletz's avatar
sletz committed
130

131
    typedef enum _sync_packet_type sync_packet_type_t;
sletz's avatar
sletz committed
132
133
134
135


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

moret's avatar
moret committed
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
    /**
    \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

    */
154

155
156
    struct _packet_header
    {
157
        char fPacketType[7];        //packet type ( 'headr' )
158
        char fDataType;             //a for audio, m for midi and s for sync
159
        char fDataStream;           //s for send, r for return
160
        uint32_t fID;               //unique ID of the slave
161
        uint32_t fBitdepth;         //bitdepth of the data samples
moret's avatar
moret committed
162
        uint32_t fMidiDataSize;     //size of midi data in bytes
163
        uint32_t fNMidiPckt;        //number of midi packets of the cycle
moret's avatar
moret committed
164
        uint32_t fPacketSize;       //packet size in bytes
165
166
        uint32_t fCycle;            //process cycle counter
        uint32_t fSubCycle;         //midi/audio subcycle counter
moret's avatar
moret committed
167
        uint32_t fIsLastPckt;       //is it the last packet of a given cycle ('y' or 'n')
168
        char fASyncWrongCycle;      //is the current async cycle wrong (slave's side; 'y' or 'n')
moret's avatar
moret committed
169
        char fFree[26];             //unused
170
    };
sletz's avatar
sletz committed
171

172
173
174
175
176
177
178
179
//net timebase master

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

    enum _net_timebase_master
    {
180
181
182
183
        NO_CHANGE = 0,
        RELEASE_TIMEBASEMASTER = 1,
        TIMEBASEMASTER = 2,
        CONDITIONAL_TIMEBASEMASTER = 3
184
185
186
187
188
    };

    typedef enum _net_timebase_master net_timebase_master_t;


189
190
//transport data ******************************************************************************

moret's avatar
moret committed
191
    /**
192
    \Brief This structure contains transport data to be sent over the network
moret's avatar
moret committed
193
    */
194

moret's avatar
moret committed
195
196
    struct _net_transport_data
    {
197
198
        uint32_t fNewState;             //is it a state change
        uint32_t fTimebaseMaster;       //is there a new timebase master
moret's avatar
moret committed
199
        int32_t fState;                 //current cycle state
200
        jack_position_t fPosition;      //current cycle position
moret's avatar
moret committed
201
    };
202

sletz's avatar
sletz committed
203
204
//midi data ***********************************************************************************

moret's avatar
moret committed
205
206
    /**
    \Brief Midi buffer and operations class
207

moret's avatar
moret committed
208
209
210
211
212
213
214
215
216
    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)
217

moret's avatar
moret committed
218
    */
219

220
    class SERVER_EXPORT NetMidiBuffer
221
    {
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
        private:
            int fNPorts;
            size_t fMaxBufsize;
            int fMaxPcktSize;
            char* fBuffer;
            char* fNetBuffer;
            JackMidiBuffer** fPortBuffer;

        public:
            NetMidiBuffer ( session_params_t* params, uint32_t nports, char* net_buffer );
            ~NetMidiBuffer();

            void Reset();
            size_t GetSize();
            //utility
            void DisplayEvents();
            //jack<->buffer
            int RenderFromJackPorts();
            int RenderToJackPorts();
            //network<->buffer
            int RenderFromNetwork ( int subcycle, size_t copy_size );
            int RenderToNetwork ( int subcycle, size_t total_size );

            void SetBuffer ( int index, JackMidiBuffer* buffer );
            JackMidiBuffer* GetBuffer ( int index );
247
    };
sletz's avatar
sletz committed
248
249
250

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

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
    class SERVER_EXPORT NetAudioBuffer 
    {
    
        public:
            NetAudioBuffer ()
            {}
            ~NetAudioBuffer()
            {}
            
            virtual size_t GetSize() = 0;
            //jack<->buffer
            virtual void RenderFromJackPorts (int subcycle ) = 0;
            virtual void RenderToJackPorts ( int cycle, int subcycle) = 0;
            virtual void FinishRenderToJackPorts (int cycle) = 0;

            virtual void SetBuffer ( int index, sample_t* buffer ) = 0;
            virtual sample_t* GetBuffer ( int index ) = 0;
   };

moret's avatar
moret committed
270
271
    /**
    \Brief Audio buffer and operations class
272

moret's avatar
moret committed
273
274
275
276
    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.
277

moret's avatar
moret committed
278
    */
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
    
    struct JackPortList {
    
        jack_nframes_t fPeriodSize;
        jack_nframes_t fSubPeriodSize;
        size_t fSubPeriodBytesSize;
        sample_t** fPortBuffer;
        int fNPorts;
        
        JackPortList(session_params_t* params, uint32_t nports)
        {
            fNPorts = nports;
            fPeriodSize = params->fPeriodSize;
            fSubPeriodSize = params->fFramesPerPacket;
            fSubPeriodBytesSize = fSubPeriodSize * sizeof ( sample_t );
            fPortBuffer = new sample_t* [fNPorts];
            for ( int port_index = 0; port_index < fNPorts; port_index++ )
                fPortBuffer[port_index] = NULL;
        }
        
        JackPortList()
        {
            fNPorts = 0;
            fPeriodSize = 0;
            fSubPeriodSize = 0;
            fSubPeriodBytesSize = 0;
            fPortBuffer = 0;
        }
     
        ~JackPortList()
        {
            delete [] fPortBuffer;
        }
        
        void SetBuffer( int index, sample_t* buffer )
        {
            fPortBuffer[index] = buffer;
        }
        
        sample_t* GetBuffer ( int index ) 
        {
            return fPortBuffer[index];
        }
        
        void Copy(sample_t** buffers)
        {
            for ( int port_index = 0; port_index < fNPorts; port_index++ )
                memcpy(buffers[port_index], fPortBuffer[port_index], fPeriodSize * sizeof(float));
        }
        
        size_t GetSize()
        {
             return fNPorts * fSubPeriodBytesSize;
        }
         
    #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;
        }

        void RenderFromJackPorts (char* net_buffer, int subcycle )
        {
            for ( int port_index = 0; port_index < fNPorts; port_index++ ) {
                float* src = (float*)(fPortBuffer[port_index] + subcycle * fSubPeriodSize);
                float* dst = (float*)(net_buffer + port_index * fSubPeriodBytesSize);
                for (unsigned int sample = 0; sample < fSubPeriodBytesSize / sizeof(float); sample++) {
                    dst[sample] = SwapFloat(src[sample]);
                }
            }
        }

        void RenderToJackPorts (char* net_buffer, int subcycle)
        {
            for ( int port_index = 0; port_index < fNPorts; port_index++ ) {
                float* src = (float*)(net_buffer + port_index * fSubPeriodBytesSize);
                float* dst = (float*)(fPortBuffer[port_index] + subcycle * fSubPeriodSize);
                for (unsigned int sample = 0; sample < fSubPeriodBytesSize / sizeof(float); sample++) {
                    dst[sample] = SwapFloat(src[sample]);
                }
            }    
        }
        
    #else

        void RenderFromJackPorts (char* net_buffer, int subcycle )
        {
            for ( int port_index = 0; port_index < fNPorts; port_index++ )
                memcpy ( net_buffer + port_index * fSubPeriodBytesSize, fPortBuffer[port_index] + subcycle * fSubPeriodSize, fSubPeriodBytesSize );
        }

        void RenderToJackPorts (char* net_buffer, int subcycle)
        {
            for ( int port_index = 0; port_index < fNPorts; port_index++ )
                memcpy ( fPortBuffer[port_index] + subcycle * fSubPeriodSize, net_buffer + port_index * fSubPeriodBytesSize, fSubPeriodBytesSize );
        }

    #endif
    
    };
    
    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;
            fSubPeriodSize = params->fFramesPerPacket;
            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];
        }
        
    };
422

423
    class SERVER_EXPORT NetSingleAudioBuffer : public NetAudioBuffer
424
    {
425
        private:
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
            JackPortList fPortBuffer;
            char* fNetBuffer;
            
        public:
            NetSingleAudioBuffer ( session_params_t* params, uint32_t nports, char* net_buffer );
            ~NetSingleAudioBuffer();

            size_t GetSize();
            //jack<->buffer
            void RenderFromJackPorts (int subcycle );
            void RenderToJackPorts (int cycle, int subcycle);

            void SetBuffer ( int index, sample_t* buffer );
            sample_t* GetBuffer ( int index );
            
            void FinishRenderToJackPorts (int cycle) {}
    };
    
    #define AUDIO_BUFFER_SIZE 8
    
    class SERVER_EXPORT NetBufferedAudioBuffer : public NetAudioBuffer
    {
    
        private:
450
            char* fNetBuffer;
451
452
453
454
            JackPortListAllocate fPortBuffer[AUDIO_BUFFER_SIZE];
            sample_t** fJackPortBuffer;
            int fMaxCycle;
            
455
        public:
456
457
            NetBufferedAudioBuffer ( session_params_t* params, uint32_t nports, char* net_buffer );
            ~NetBufferedAudioBuffer();
458
459
460

            size_t GetSize();
            //jack<->buffer
461
462
463
            void RenderFromJackPorts (int subcycle );
            void RenderToJackPorts ( int cycle, int subcycle);
            void FinishRenderToJackPorts (int cycle);
464
465
466

            void SetBuffer ( int index, sample_t* buffer );
            sample_t* GetBuffer ( int index );
467
    };
sletz's avatar
sletz committed
468
469

//utility *************************************************************************************
470
471

    //socket API management
472
473
    SERVER_EXPORT int SocketAPIInit();
    SERVER_EXPORT int SocketAPIEnd();
474
    //n<-->h functions
475
476
477
478
    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 );
479
480
    SERVER_EXPORT void MidiBufferHToN ( JackMidiBuffer* src_buffer, JackMidiBuffer* dst_buffer );
    SERVER_EXPORT void MidiBufferNToH ( JackMidiBuffer* src_buffer, JackMidiBuffer* dst_buffer );
sletz's avatar
sletz committed
481
482
    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 );
483
    //display session parameters
484
    SERVER_EXPORT void SessionParamsDisplay ( session_params_t* params );
485
    //display packet header
486
    SERVER_EXPORT void PacketHeaderDisplay ( packet_header_t* header );
487
    //get the packet type from a sesion parameters
488
    SERVER_EXPORT sync_packet_type_t GetPacketType ( session_params_t* params );
489
    //set the packet type in a session parameters
490
    SERVER_EXPORT int SetPacketType ( session_params_t* params, sync_packet_type_t packet_type );
491
    //transport utility
492
    SERVER_EXPORT const char* GetTransportState ( int transport_state );
sletz's avatar
sletz committed
493
    SERVER_EXPORT void NetTransportDataDisplay ( net_transport_data_t* data );
sletz's avatar
sletz committed
494
}