/[svn]/linuxsampler/trunk/src/network/lscpserver.h
ViewVC logotype

Contents of /linuxsampler/trunk/src/network/lscpserver.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1695 - (show annotations) (download) (as text)
Sat Feb 16 01:09:33 2008 UTC (16 years, 2 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 21446 byte(s)
* added new LSCP event "DEVICE_MIDI" which can be used by frontends to
  react on MIDI data arriving on certain MIDI input devices (so far only
  Note-On and Note-Off events are sent via this LSCP event)
* bumped version to 0.5.1.4cvs

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 * Copyright (C) 2005 - 2008 Christian Schoenebeck *
7 * *
8 * This library is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This library is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this library; if not, write to the Free Software *
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21 * MA 02111-1307 USA *
22 ***************************************************************************/
23
24 #ifndef __LSCPSERVER_H_
25 #define __LSCPSERVER_H_
26
27 #if defined(WIN32)
28 #include <windows.h>
29 typedef int socklen_t;
30 #else
31 #include <unistd.h>
32 #include <sys/types.h>
33 #include <sys/socket.h>
34 #include <sys/select.h>
35 #include <sys/time.h>
36 #include <netinet/in.h>
37 #include <netinet/tcp.h>
38 #include <arpa/inet.h>
39 #include <netdb.h>
40 #endif
41
42 #include <list>
43
44 #include "lscp.h"
45 #include "lscpparser.h"
46 #include "lscp.h"
47 #include "lscpevent.h"
48 #include "../Sampler.h"
49 #include "../common/Thread.h"
50 #include "../common/Mutex.h"
51 #include "../common/Condition.h"
52 #include "../common/global_private.h"
53
54 #include "../drivers/midi/MidiInstrumentMapper.h"
55 #include "../drivers/midi/VirtualMidiDevice.h"
56
57 #if HAVE_SQLITE3
58 #include "../db/InstrumentsDb.h"
59 #endif
60
61 /// TCP Port on which the server should listen for connection requests.
62 #define LSCP_ADDR INADDR_ANY
63 #define LSCP_PORT 8888
64
65 /// try up to 3 minutes to bind server socket
66 #define LSCP_SERVER_BIND_TIMEOUT 180
67
68 using namespace LinuxSampler;
69
70 // External references to the main scanner and parser functions
71 extern int yyparse(void* YYPARSE_PARAM);
72 extern void restart(yyparse_param_t* pparam, int& yychar);
73
74 /**
75 * Network server for the LinuxSampler Control Protocol (LSCP).
76 */
77 class LSCPServer : public Thread {
78 public:
79 LSCPServer(Sampler* pSampler, long int addr, short int port);
80 virtual ~LSCPServer();
81 int WaitUntilInitialized(long TimeoutSeconds = 0L, long TimeoutNanoSeconds = 0L);
82
83 // Methods called by the parser
84 String DestroyAudioOutputDevice(uint DeviceIndex);
85 String DestroyMidiInputDevice(uint DeviceIndex);
86 String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
87 String SetEngineType(String EngineName, uint uiSamplerChannel);
88 String GetChannels();
89 String ListChannels();
90 String AddChannel();
91 String RemoveChannel(uint uiSamplerChannel);
92 String GetAvailableEngines();
93 String ListAvailableEngines();
94 String GetEngineInfo(String EngineName);
95 String GetChannelInfo(uint uiSamplerChannel);
96 String GetVoiceCount(uint uiSamplerChannel);
97 String GetStreamCount(uint uiSamplerChannel);
98 String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
99 String GetAvailableAudioOutputDrivers();
100 String ListAvailableAudioOutputDrivers();
101 String GetAvailableMidiInputDrivers();
102 String ListAvailableMidiInputDrivers();
103 String GetAudioOutputDriverInfo(String Driver);
104 String GetMidiInputDriverInfo(String Driver);
105 #ifdef __GNUC__
106 typedef std::map<String,String> StringMap; // nasty workaround for a GCC bug (see GCC bug #15980, #57)
107 String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
108 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
109 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
110 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
111 #else
112 String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
113 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
114 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
115 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
116 #endif // __GNUC__
117 String GetAudioOutputDeviceCount();
118 String GetMidiInputDeviceCount();
119 String GetAudioOutputDevices();
120 String GetMidiInputDevices();
121 String GetAudioOutputDeviceInfo(uint DeviceIndex);
122 String GetMidiInputDeviceInfo(uint DeviceIndex);
123 String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
124 String GetMidiInputPortParameterInfo(uint DeviceId, uint PortId, String ParameterName);
125 String GetAudioOutputChannelInfo(uint DeviceId, uint ChannelId);
126 String GetAudioOutputChannelParameterInfo(uint DeviceId, uint ChannelId, String ParameterName);
127 String SetAudioOutputChannelParameter(uint DeviceId, uint ChannelId, String ParamKey, String ParamVal);
128 String SetAudioOutputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
129 String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
130 String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
131 String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
132 String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
133 String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
134 String SetMIDIInputPort(uint MIDIPort, uint uiSamplerChannel);
135 String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);
136 String SetMIDIInputDevice(uint MIDIDeviceId, uint uiSamplerChannel);
137 String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
138 String SetMIDIInput(uint MIDIDeviceId, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
139 String SetVolume(double dVolume, uint uiSamplerChannel);
140 String SetChannelMute(bool bMute, uint uiSamplerChannel);
141 String SetChannelSolo(bool bSolo, uint uiSamplerChannel);
142 String AddOrReplaceMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg, String EngineType, String InstrumentFile, uint InstrumentIndex, float Volume, MidiInstrumentMapper::mode_t LoadMode, String Name, bool bModal);
143 String RemoveMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
144 String GetMidiInstrumentMappings(uint MidiMapID);
145 String GetAllMidiInstrumentMappings();
146 String GetMidiInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
147 String ListMidiInstrumentMappings(uint MidiMapID);
148 String ListAllMidiInstrumentMappings();
149 String ClearMidiInstrumentMappings(uint MidiMapID);
150 String ClearAllMidiInstrumentMappings();
151 String AddMidiInstrumentMap(String MapName = "");
152 String RemoveMidiInstrumentMap(uint MidiMapID);
153 String RemoveAllMidiInstrumentMaps();
154 String GetMidiInstrumentMaps();
155 String ListMidiInstrumentMaps();
156 String GetMidiInstrumentMap(uint MidiMapID);
157 String SetMidiInstrumentMapName(uint MidiMapID, String NewName);
158 String SetChannelMap(uint uiSamplerChannel, int MidiMapID);
159 String CreateFxSend(uint uiSamplerChannel, uint MidiCtrl, String Name = "");
160 String DestroyFxSend(uint uiSamplerChannel, uint FxSendID);
161 String GetFxSends(uint uiSamplerChannel);
162 String ListFxSends(uint uiSamplerChannel);
163 String GetFxSendInfo(uint uiSamplerChannel, uint FxSendID);
164 String SetFxSendName(uint uiSamplerChannel, uint FxSendID, String Name);
165 String SetFxSendAudioOutputChannel(uint uiSamplerChannel, uint FxSendID, uint FxSendChannel, uint DeviceChannel);
166 String SetFxSendMidiController(uint uiSamplerChannel, uint FxSendID, uint MidiController);
167 String SetFxSendLevel(uint uiSamplerChannel, uint FxSendID, double dLevel);
168 String AddDbInstrumentDirectory(String Dir);
169 String RemoveDbInstrumentDirectory(String Dir, bool Force = false);
170 String GetDbInstrumentDirectoryCount(String Dir, bool Recursive = false);
171 String GetDbInstrumentDirectories(String Dir, bool Recursive = false);
172 String GetDbInstrumentDirectoryInfo(String Dir);
173 String SetDbInstrumentDirectoryName(String Dir, String Name);
174 String MoveDbInstrumentDirectory(String Dir, String Dst);
175 String CopyDbInstrumentDirectory(String Dir, String Dst);
176 String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
177 String FindDbInstrumentDirectories(String Dir, std::map<String,String> Parameters, bool Recursive = true);
178 String AddDbInstruments(String DbDir, String FilePath, int Index = -1, bool bBackground = false);
179 String AddDbInstruments(String ScanMode, String DbDir, String FsDir, bool bBackground = false);
180 String RemoveDbInstrument(String Instr);
181 String GetDbInstrumentCount(String Dir, bool Recursive = false);
182 String GetDbInstruments(String Dir, bool Recursive = false);
183 String GetDbInstrumentInfo(String Instr);
184 String SetDbInstrumentName(String Instr, String Name);
185 String MoveDbInstrument(String Instr, String Dst);
186 String CopyDbInstrument(String Instr, String Dst);
187 String SetDbInstrumentDescription(String Instr, String Desc);
188 String FindDbInstruments(String Dir, std::map<String,String> Parameters, bool Recursive = true);
189 String FormatInstrumentsDb();
190 String EditSamplerChannelInstrument(uint uiSamplerChannel);
191 String GetDbInstrumentsJobInfo(int JobId);
192 String ResetChannel(uint uiSamplerChannel);
193 String ResetSampler();
194 String GetServerInfo();
195 String GetTotalStreamCount();
196 String GetTotalVoiceCount();
197 String GetTotalVoiceCountMax();
198 String GetGlobalVolume();
199 String SetGlobalVolume(double dVolume);
200 String GetFileInstruments(String Filename);
201 String ListFileInstruments(String Filename);
202 String GetFileInstrumentInfo(String Filename, uint InstrumentID);
203 String SubscribeNotification(LSCPEvent::event_t);
204 String UnsubscribeNotification(LSCPEvent::event_t);
205 String SetEcho(yyparse_param_t* pSession, double boolean_value);
206 void AnswerClient(String ReturnMessage);
207
208 static int currentSocket;
209 static std::map<int,String> bufferedCommands;
210
211 static void SendLSCPNotify( LSCPEvent Event );
212 static int EventSubscribers( std::list<LSCPEvent::event_t> events );
213 static void LockRTNotify();
214 static void UnlockRTNotify();
215 static String FilterEndlines(String s);
216
217 protected:
218 int hSocket;
219 sockaddr_in SocketAddress;
220 Sampler* pSampler;
221 Condition Initialized;
222
223 int Main(); ///< Implementation of virtual method from class Thread
224
225 private:
226
227 /**
228 * Find a created audio output device index.
229 */
230 int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
231
232 /**
233 * Find a created midi input device index.
234 */
235 int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
236
237 EngineChannel* GetEngineChannel(uint uiSamplerChannel);
238
239 /**
240 * Gets the specified effect send on the specified sampler channel.
241 */
242 FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);
243
244 bool HasSoloChannel();
245 void MuteNonSoloChannels();
246 void UnmuteChannels();
247
248 /**
249 * Throws an exception if the specified file is not found or
250 * if directory is specified.
251 */
252 static void VerifyFile(String Filename);
253
254 static std::map<int,String> bufferedNotifies;
255 static Mutex NotifyMutex;
256 static Mutex NotifyBufferMutex;
257 static bool GetLSCPCommand( std::vector<yyparse_param_t>::iterator iter );
258 static void CloseConnection( std::vector<yyparse_param_t>::iterator iter );
259 static std::vector<yyparse_param_t> Sessions;
260 static Mutex SubscriptionMutex;
261 static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
262 static fd_set fdSet;
263
264 //Protect main thread that generates real time notify messages
265 //like voice count, stream count and buffer fill
266 //from LSCP server removing engines and channels from underneath
267 static Mutex RTNotifyMutex;
268
269 class EventHandler : public ChannelCountListener, public AudioDeviceCountListener,
270 public MidiDeviceCountListener, public MidiInstrumentCountListener,
271 public MidiInstrumentInfoListener, public MidiInstrumentMapCountListener,
272 public MidiInstrumentMapInfoListener, public FxSendCountListener,
273 public VoiceCountListener, public StreamCountListener, public BufferFillListener,
274 public TotalStreamCountListener, public TotalVoiceCountListener,
275 public EngineChangeListener, public MidiPortCountListener {
276
277 public:
278 EventHandler(LSCPServer* pParent);
279
280 /**
281 * Invoked when the number of sampler channels has changed.
282 * @param NewCount The new number of sampler channels.
283 */
284 virtual void ChannelCountChanged(int NewCount);
285 virtual void ChannelAdded(SamplerChannel* pChannel);
286 virtual void ChannelToBeRemoved(SamplerChannel* pChannel);
287
288 /**
289 * Invoked when the number of audio output devices has changed.
290 * @param NewCount The new number of audio output devices.
291 */
292 virtual void AudioDeviceCountChanged(int NewCount);
293
294 /**
295 * Invoked when the number of MIDI input devices has changed.
296 * @param NewCount The new number of MIDI input devices.
297 */
298 virtual void MidiDeviceCountChanged(int NewCount);
299
300 /**
301 * Invoked right before the supplied MIDI input device is going
302 * to be destroyed.
303 * @param pDevice MidiInputDevice to be deleted
304 */
305 virtual void MidiDeviceToBeDestroyed(MidiInputDevice* pDevice);
306
307 /**
308 * Invoked to inform that a new MidiInputDevice has just been
309 * created.
310 * @param pDevice newly created MidiInputDevice
311 */
312 virtual void MidiDeviceCreated(MidiInputDevice* pDevice);
313
314 /**
315 * Invoked when the number of MIDI input ports has changed.
316 * @param NewCount The new number of MIDI input ports.
317 */
318 virtual void MidiPortCountChanged(int NewCount);
319
320 /**
321 * Invoked right before the supplied MIDI input port is going
322 * to be destroyed.
323 * @param pPort MidiInputPort to be deleted
324 */
325 virtual void MidiPortToBeRemoved(MidiInputPort* pPort);
326
327 /**
328 * Invoked to inform that a new MidiInputPort has just been
329 * added.
330 * @param pPort newly created MidiInputPort
331 */
332 virtual void MidiPortAdded(MidiInputPort* pPort);
333
334 /**
335 * Invoked when the number of MIDI instruments has changed.
336 * @param MapId The numerical ID of the MIDI instrument map.
337 * @param NewCount The new number of MIDI instruments.
338 */
339 virtual void MidiInstrumentCountChanged(int MapId, int NewCount);
340
341 /**
342 * Invoked when a MIDI instrument in a MIDI instrument map is changed.
343 * @param MapId The numerical ID of the MIDI instrument map.
344 * @param Bank The index of the MIDI bank, containing the instrument.
345 * @param Program The MIDI program number of the instrument.
346 */
347 virtual void MidiInstrumentInfoChanged(int MapId, int Bank, int Program);
348
349 /**
350 * Invoked when the number of MIDI instrument maps has changed.
351 * @param NewCount The new number of MIDI instruments.
352 */
353 virtual void MidiInstrumentMapCountChanged(int NewCount);
354
355 /**
356 * Invoked when the settings of a MIDI instrument map are changed.
357 * @param MapId The numerical ID of the MIDI instrument map.
358 */
359 virtual void MidiInstrumentMapInfoChanged(int MapId);
360
361 /**
362 * Invoked when the number of effect sends
363 * on the specified sampler channel has changed.
364 * @param ChannelId The numerical ID of the sampler channel.
365 * @param NewCount The new number of effect sends.
366 */
367 virtual void FxSendCountChanged(int ChannelId, int NewCount);
368
369 /**
370 * Invoked when the number of active voices
371 * on the specified sampler channel has changed.
372 * @param ChannelId The numerical ID of the sampler channel.
373 * @param NewCount The new number of active voices.
374 */
375 virtual void VoiceCountChanged(int ChannelId, int NewCount);
376
377 /**
378 * Invoked when the number of active disk streams
379 * on the specified sampler channel has changed.
380 * @param ChannelId The numerical ID of the sampler channel.
381 * @param NewCount The new number of active disk streams.
382 */
383 virtual void StreamCountChanged(int ChannelId, int NewCount);
384
385 /**
386 * Invoked when the fill state of the disk stream
387 * buffers on the specified sampler channel is changed.
388 * @param ChannelId The numerical ID of the sampler channel.
389 * @param FillData The buffer fill data for the specified sampler channel.
390 */
391 virtual void BufferFillChanged(int ChannelId, String FillData);
392
393 /**
394 * Invoked when the total number of active voices is changed.
395 * @param NewCount The new number of active voices.
396 */
397 virtual void TotalVoiceCountChanged(int NewCount);
398 virtual void TotalStreamCountChanged(int NewCount);
399
400 virtual void EngineToBeChanged(int ChannelId);
401 virtual void EngineChanged(int ChannelId);
402
403 virtual ~EventHandler();
404
405 struct midi_listener_entry {
406 SamplerChannel* pSamplerChannel;
407 EngineChannel* pEngineChannel;
408 VirtualMidiDevice* pMidiListener;
409 };
410
411 std::vector<midi_listener_entry> channelMidiListeners;
412
413 struct device_midi_listener_entry {
414 MidiInputPort* pPort;
415 VirtualMidiDevice* pMidiListener;
416 uint uiDeviceID;
417 };
418
419 std::vector<device_midi_listener_entry> deviceMidiListeners;
420
421 private:
422 LSCPServer* pParent;
423 } eventHandler;
424
425 #if HAVE_SQLITE3
426 class DbInstrumentsEventHandler : public InstrumentsDb::Listener {
427 public:
428 virtual void DirectoryCountChanged(String Dir);
429 virtual void DirectoryInfoChanged(String Dir);
430 virtual void DirectoryNameChanged(String Dir, String NewName);
431 virtual void InstrumentCountChanged(String Dir);
432 virtual void InstrumentInfoChanged(String Instr);
433 virtual void InstrumentNameChanged(String Instr, String NewName);
434 virtual void JobStatusChanged(int JobId);
435 } dbInstrumentsEventHandler;
436 #endif // HAVE_SQLITE3
437 };
438
439 #endif // __LSCPSERVER_H_

  ViewVC Help
Powered by ViewVC