Jack2  1.9.9
net.h
1 /*
2  Copyright (C) 2009-2010 Grame
3 
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU Lesser General Public License as published by
6  the Free Software Foundation; either version 2.1 of the License, or
7  (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU Lesser General Public License for more details.
13 
14  You should have received a copy of the GNU Lesser General Public License
15  along with this program; if not, write to the Free Software
16  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 
18 */
19 
20 #ifndef __net_h__
21 #define __net_h__
22 
23 #ifdef __cplusplus
24 extern "C"
25 {
26 #endif
27 
28 #include <jack/systemdeps.h>
29 #include <jack/types.h>
30 
31 #define DEFAULT_MULTICAST_IP "225.3.19.154"
32 #define DEFAULT_PORT 19000
33 #define DEFAULT_MTU 1500
34 #define MASTER_NAME_SIZE 256
35 
36 #define SOCKET_ERROR -1
37 
38 enum JackNetEncoder {
39 
40  JackFloatEncoder = 0, // samples are transmitted as float
41  JackIntEncoder = 1, // samples are transmitted as 16 bits integer
42  JackCeltEncoder = 2, // samples are transmitted using CELT codec (http://www.celt-codec.org/)
43  JackOpusEncoder = 3, // samples are transmitted using OPUS codec (http://www.opus-codec.org/)
44 };
45 
46 typedef struct {
47 
48  int audio_input; // from master or to slave (-1 to take master audio physical inputs)
49  int audio_output; // to master or from slave (-1 to take master audio physical outputs)
50  int midi_input; // from master or to slave (-1 to take master MIDI physical inputs)
51  int midi_output; // to master or from slave (-1 to take master MIDI physical outputs)
52  int mtu; // network Maximum Transmission Unit
53  int time_out; // in second, -1 means in infinite
54  int encoder; // encoder type (one of JackNetEncoder)
55  int kbps; // KB per second for CELT encoder
56  int latency; // network latency
57 
58 } jack_slave_t;
59 
60 typedef struct {
61 
62  int audio_input; // master audio physical outputs (-1 to take slave wanted audio inputs)
63  int audio_output; // master audio physical inputs (-1 to take slave wanted audio outputs)
64  int midi_input; // master MIDI physical outputs (-1 to take slave wanted MIDI inputs)
65  int midi_output; // master MIDI physical inputs (-1 to take slave wanted MIDI outputs)
66  jack_nframes_t buffer_size; // mater buffer size
67  jack_nframes_t sample_rate; // mater sample rate
68  char master_name[MASTER_NAME_SIZE]; // master machine name
69 
71 
76 typedef struct _jack_net_slave jack_net_slave_t;
77 
87 jack_net_slave_t* jack_net_slave_open(const char* ip, int port, const char* name, jack_slave_t* request, jack_master_t* result);
88 
95 int jack_net_slave_close(jack_net_slave_t* net);
96 
112 typedef int (* JackNetSlaveProcessCallback) (jack_nframes_t buffer_size,
113  int audio_input,
114  float** audio_input_buffer,
115  int midi_input,
116  void** midi_input_buffer,
117  int audio_output,
118  float** audio_output_buffer,
119  int midi_output,
120  void** midi_output_buffer,
121  void* data);
122 
131 int jack_set_net_slave_process_callback(jack_net_slave_t * net, JackNetSlaveProcessCallback net_callback, void *arg);
132 
139 int jack_net_slave_activate(jack_net_slave_t* net);
140 
147 int jack_net_slave_deactivate(jack_net_slave_t* net);
148 
156 typedef int (*JackNetSlaveBufferSizeCallback)(jack_nframes_t nframes, void *arg);
157 
165 typedef int (*JackNetSlaveSampleRateCallback)(jack_nframes_t nframes, void *arg);
166 
175 int jack_set_net_slave_buffer_size_callback(jack_net_slave_t *net, JackNetSlaveBufferSizeCallback bufsize_callback, void *arg);
176 
185 int jack_set_net_slave_sample_rate_callback(jack_net_slave_t *net, JackNetSlaveSampleRateCallback samplerate_callback, void *arg);
186 
191 typedef void (*JackNetSlaveShutdownCallback)(void* data);
192 
201 int jack_set_net_slave_shutdown_callback(jack_net_slave_t *net, JackNetSlaveShutdownCallback shutdown_callback, void *arg);
202 
206 typedef struct _jack_net_master jack_net_master_t;
207 
217 jack_net_master_t* jack_net_master_open(const char* ip, int port, const char* name, jack_master_t* request, jack_slave_t* result);
218 
225 int jack_net_master_close(jack_net_master_t* net);
226 
237 int jack_net_master_recv(jack_net_master_t* net, int audio_input, float** audio_input_buffer, int midi_input, void** midi_input_buffer);
238 
249 int jack_net_master_send(jack_net_master_t* net, int audio_output, float** audio_output_buffer, int midi_output, void** midi_output_buffer);
250 
251 // Experimental Adapter API
252 
256 typedef struct _jack_adapter jack_adapter_t;
257 
269 jack_adapter_t* jack_create_adapter(int input, int output,
270  jack_nframes_t host_buffer_size,
271  jack_nframes_t host_sample_rate,
272  jack_nframes_t adapted_buffer_size,
273  jack_nframes_t adapted_sample_rate);
274 
281 int jack_destroy_adapter(jack_adapter_t* adapter);
282 
289 void jack_flush_adapter(jack_adapter_t* adapter);
290 
300 int jack_adapter_push_and_pull(jack_adapter_t* adapter, float** input, float** output, unsigned int frames);
301 
311 int jack_adapter_pull_and_push(jack_adapter_t* adapter, float** input, float** output, unsigned int frames);
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 
317 #endif /* __net_h__ */