Jack2  1.9.8
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 };
44 
45 typedef struct {
46 
47  int audio_input; // from master or to slave (-1 for get master audio physical outputs)
48  int audio_output; // to master or from slave (-1 for get master audio physical inputs)
49  int midi_input; // from master or to slave (-1 for get master MIDI physical outputs)
50  int midi_output; // to master or from slave (-1 for get master MIDI physical inputs)
51  int mtu; // network Maximum Transmission Unit
52  int time_out; // in second, -1 means in infinite
53  int encoder; // encoder type (one of JackNetEncoder)
54  int kbps; // KB per second for CELT encoder
55  int latency; // network latency
56 
57 } jack_slave_t;
58 
59 typedef struct {
60 
61  int audio_input; // master audio physical outputs
62  int audio_output; // master audio physical inputs
63  int midi_input; // master MIDI physical outputs
64  int midi_output; // master MIDI physical inputs
65  jack_nframes_t buffer_size; // mater buffer size
66  jack_nframes_t sample_rate; // mater sample rate
67  char master_name[MASTER_NAME_SIZE]; // master machine name
68 
70 
75 typedef struct _jack_net_slave jack_net_slave_t;
76 
86 jack_net_slave_t* jack_net_slave_open(const char* ip, int port, const char* name, jack_slave_t* request, jack_master_t* result);
87 
94 int jack_net_slave_close(jack_net_slave_t* net);
95 
111 typedef int (* JackNetSlaveProcessCallback) (jack_nframes_t buffer_size,
112  int audio_input,
113  float** audio_input_buffer,
114  int midi_input,
115  void** midi_input_buffer,
116  int audio_output,
117  float** audio_output_buffer,
118  int midi_output,
119  void** midi_output_buffer,
120  void* data);
121 
130 int jack_set_net_slave_process_callback(jack_net_slave_t * net, JackNetSlaveProcessCallback net_callback, void *arg);
131 
138 int jack_net_slave_activate(jack_net_slave_t* net);
139 
146 int jack_net_slave_deactivate(jack_net_slave_t* net);
147 
155 typedef int (*JackNetSlaveBufferSizeCallback)(jack_nframes_t nframes, void *arg);
156 
164 typedef int (*JackNetSlaveSampleRateCallback)(jack_nframes_t nframes, void *arg);
165 
174 int jack_set_net_slave_buffer_size_callback(jack_net_slave_t *net, JackNetSlaveBufferSizeCallback bufsize_callback, void *arg);
175 
184 int jack_set_net_slave_sample_rate_callback(jack_net_slave_t *net, JackNetSlaveSampleRateCallback samplerate_callback, void *arg);
185 
190 typedef void (*JackNetSlaveShutdownCallback)(void* data);
191 
200 int jack_set_net_slave_shutdown_callback(jack_net_slave_t *net, JackNetSlaveShutdownCallback shutdown_callback, void *arg);
201 
205 typedef struct _jack_net_master jack_net_master_t;
206 
216 jack_net_master_t* jack_net_master_open(const char* ip, int port, const char* name, jack_master_t* request, jack_slave_t* result);
217 
224 int jack_net_master_close(jack_net_master_t* net);
225 
236 int jack_net_master_recv(jack_net_master_t* net, int audio_input, float** audio_input_buffer, int midi_input, void** midi_input_buffer);
237 
248 int jack_net_master_send(jack_net_master_t* net, int audio_output, float** audio_output_buffer, int midi_output, void** midi_output_buffer);
249 
250 // Experimental Adapter API
251 
255 typedef struct _jack_adapter jack_adapter_t;
256 
268 jack_adapter_t* jack_create_adapter(int input, int output,
269  jack_nframes_t host_buffer_size,
270  jack_nframes_t host_sample_rate,
271  jack_nframes_t adapted_buffer_size,
272  jack_nframes_t adapted_sample_rate);
273 
280 int jack_destroy_adapter(jack_adapter_t* adapter);
281 
288 void jack_flush_adapter(jack_adapter_t* adapter);
289 
299 int jack_adapter_push_and_pull(jack_adapter_t* adapter, float** input, float** output, unsigned int frames);
300 
310 int jack_adapter_pull_and_push(jack_adapter_t* adapter, float** input, float** output, unsigned int frames);
311 
312 #ifdef __cplusplus
313 }
314 #endif
315 
316 #endif /* __net_h__ */