/[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 2427 - (show annotations) (download) (as text)
Sat Mar 2 07:03:04 2013 UTC (11 years, 1 month ago) by persson
File MIME type: text/x-c++hdr
File size: 23366 byte(s)
* code refactoring: added a lock guard class for exception safe mutex
  handling and used it everywhere appropriate

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 * Copyright (C) 2005 - 2013 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 "lscpevent.h"
47 #include "../Sampler.h"
48 #include "../common/Thread.h"
49 #include "../common/Mutex.h"
50 #include "../common/Condition.h"
51 #include "../common/global_private.h"
52
53 #include "../drivers/midi/MidiInstrumentMapper.h"
54 #include "../drivers/midi/VirtualMidiDevice.h"
55
56 #if HAVE_SQLITE3
57 #include "../db/InstrumentsDb.h"
58 #endif
59
60 /// TCP Port on which the server should listen for connection requests.
61 #define LSCP_ADDR INADDR_ANY
62 #define LSCP_PORT 8888
63
64 /// try up to 3 minutes to bind server socket
65 #define LSCP_SERVER_BIND_TIMEOUT 180
66
67 // External references to the main scanner and parser functions
68 extern int yyparse(void* YYPARSE_PARAM);
69
70 namespace LinuxSampler {
71
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 void RemoveListeners();
83
84 // Methods called by the parser
85 String DestroyAudioOutputDevice(uint DeviceIndex);
86 String DestroyMidiInputDevice(uint DeviceIndex);
87 String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
88 String SetEngineType(String EngineName, uint uiSamplerChannel);
89 String GetChannels();
90 String ListChannels();
91 String AddChannel();
92 String RemoveChannel(uint uiSamplerChannel);
93 String GetAvailableEngines();
94 String ListAvailableEngines();
95 String GetEngineInfo(String EngineName);
96 String GetChannelInfo(uint uiSamplerChannel);
97 String GetVoiceCount(uint uiSamplerChannel);
98 String GetStreamCount(uint uiSamplerChannel);
99 String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
100 String GetAvailableAudioOutputDrivers();
101 String ListAvailableAudioOutputDrivers();
102 String GetAvailableMidiInputDrivers();
103 String ListAvailableMidiInputDrivers();
104 String GetAudioOutputDriverInfo(String Driver);
105 String GetMidiInputDriverInfo(String Driver);
106 #ifdef __GNUC__
107 typedef std::map<String,String> StringMap; // nasty workaround for a GCC bug (see GCC bug #15980, #57)
108 String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
109 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
110 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
111 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
112 #else
113 String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
114 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
115 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
116 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
117 #endif // __GNUC__
118 String GetAudioOutputDeviceCount();
119 String GetMidiInputDeviceCount();
120 String GetAudioOutputDevices();
121 String GetMidiInputDevices();
122 String GetAudioOutputDeviceInfo(uint DeviceIndex);
123 String GetMidiInputDeviceInfo(uint DeviceIndex);
124 String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
125 String GetMidiInputPortParameterInfo(uint DeviceId, uint PortId, String ParameterName);
126 String GetAudioOutputChannelInfo(uint DeviceId, uint ChannelId);
127 String GetAudioOutputChannelParameterInfo(uint DeviceId, uint ChannelId, String ParameterName);
128 String SetAudioOutputChannelParameter(uint DeviceId, uint ChannelId, String ParamKey, String ParamVal);
129 String SetAudioOutputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
130 String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
131 String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
132 String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
133 String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
134 String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
135 String SetMIDIInputPort(uint MIDIPort, uint uiSamplerChannel);
136 String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);
137 String SetMIDIInputDevice(uint MIDIDeviceId, uint uiSamplerChannel);
138 String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
139 String SetMIDIInput(uint MIDIDeviceId, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
140 String SetVolume(double dVolume, uint uiSamplerChannel);
141 String SetChannelMute(bool bMute, uint uiSamplerChannel);
142 String SetChannelSolo(bool bSolo, uint uiSamplerChannel);
143 String AddOrReplaceMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg, String EngineType, String InstrumentFile, uint InstrumentIndex, float Volume, MidiInstrumentMapper::mode_t LoadMode, String Name, bool bModal);
144 String RemoveMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
145 String GetMidiInstrumentMappings(uint MidiMapID);
146 String GetAllMidiInstrumentMappings();
147 String GetMidiInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
148 String ListMidiInstrumentMappings(uint MidiMapID);
149 String ListAllMidiInstrumentMappings();
150 String ClearMidiInstrumentMappings(uint MidiMapID);
151 String ClearAllMidiInstrumentMappings();
152 String AddMidiInstrumentMap(String MapName = "");
153 String RemoveMidiInstrumentMap(uint MidiMapID);
154 String RemoveAllMidiInstrumentMaps();
155 String GetMidiInstrumentMaps();
156 String ListMidiInstrumentMaps();
157 String GetMidiInstrumentMap(uint MidiMapID);
158 String SetMidiInstrumentMapName(uint MidiMapID, String NewName);
159 String SetChannelMap(uint uiSamplerChannel, int MidiMapID);
160 String CreateFxSend(uint uiSamplerChannel, uint MidiCtrl, String Name = "");
161 String DestroyFxSend(uint uiSamplerChannel, uint FxSendID);
162 String GetFxSends(uint uiSamplerChannel);
163 String ListFxSends(uint uiSamplerChannel);
164 String GetFxSendInfo(uint uiSamplerChannel, uint FxSendID);
165 String SetFxSendName(uint uiSamplerChannel, uint FxSendID, String Name);
166 String SetFxSendAudioOutputChannel(uint uiSamplerChannel, uint FxSendID, uint FxSendChannel, uint DeviceChannel);
167 String SetFxSendMidiController(uint uiSamplerChannel, uint FxSendID, uint MidiController);
168 String SetFxSendLevel(uint uiSamplerChannel, uint FxSendID, double dLevel);
169 String SetFxSendEffect(uint uiSamplerChannel, uint FxSendID, int iSendEffectChain, int iEffectChainPosition);
170
171 // effect commands
172 String GetAvailableEffects();
173 String ListAvailableEffects();
174 String GetEffectInfo(int iEffectIndex);
175 String CreateEffectInstance(int iEffectIndex);
176 String CreateEffectInstance(String effectSystem, String module, String effectName);
177 String DestroyEffectInstance(int iEffectInstance);
178 String GetEffectInstances();
179 String ListEffectInstances();
180 String GetEffectInstanceInfo(int iEffectInstance);
181 String GetEffectInstanceInputControlInfo(int iEffectInstance, int iInputControlIndex);
182 String SetEffectInstanceInputControlValue(int iEffectInstance, int iInputControlIndex, double dValue);
183 String GetSendEffectChains(int iAudioOutputDevice);
184 String ListSendEffectChains(int iAudioOutputDevice);
185 String AddSendEffectChain(int iAudioOutputDevice);
186 String RemoveSendEffectChain(int iAudioOutputDevice, int iSendEffectChain);
187 String GetSendEffectChainInfo(int iAudioOutputDevice, int iSendEffectChain);
188 String AppendSendEffectChainEffect(int iAudioOutputDevice, int iSendEffectChain, int iEffectInstance);
189 String InsertSendEffectChainEffect(int iAudioOutputDevice, int iSendEffectChain, int iEffectChainPosition, int iEffectInstance);
190 String RemoveSendEffectChainEffect(int iAudioOutputDevice, int iSendEffectChain, int iEffectChainPosition);
191
192 String AddDbInstrumentDirectory(String Dir);
193 String RemoveDbInstrumentDirectory(String Dir, bool Force = false);
194 String GetDbInstrumentDirectoryCount(String Dir, bool Recursive = false);
195 String GetDbInstrumentDirectories(String Dir, bool Recursive = false);
196 String GetDbInstrumentDirectoryInfo(String Dir);
197 String SetDbInstrumentDirectoryName(String Dir, String Name);
198 String MoveDbInstrumentDirectory(String Dir, String Dst);
199 String CopyDbInstrumentDirectory(String Dir, String Dst);
200 String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
201 String FindDbInstrumentDirectories(String Dir, std::map<String,String> Parameters, bool Recursive = true);
202 String AddDbInstruments(String DbDir, String FilePath, int Index = -1, bool bBackground = false);
203 String AddDbInstruments(String ScanMode, String DbDir, String FsDir, bool bBackground = false, bool insDir = false);
204 String RemoveDbInstrument(String Instr);
205 String GetDbInstrumentCount(String Dir, bool Recursive = false);
206 String GetDbInstruments(String Dir, bool Recursive = false);
207 String GetDbInstrumentInfo(String Instr);
208 String SetDbInstrumentName(String Instr, String Name);
209 String MoveDbInstrument(String Instr, String Dst);
210 String CopyDbInstrument(String Instr, String Dst);
211 String SetDbInstrumentDescription(String Instr, String Desc);
212 String SetDbInstrumentFilePath(String OldPath, String NewPath);
213 String FindLostDbInstrumentFiles();
214 String FindDbInstruments(String Dir, std::map<String,String> Parameters, bool Recursive = true);
215 String FormatInstrumentsDb();
216 String EditSamplerChannelInstrument(uint uiSamplerChannel);
217 String GetDbInstrumentsJobInfo(int JobId);
218 String ResetChannel(uint uiSamplerChannel);
219 String ResetSampler();
220 String GetServerInfo();
221 String GetTotalStreamCount();
222 String GetTotalVoiceCount();
223 String GetTotalVoiceCountMax();
224 String GetGlobalMaxVoices();
225 String SetGlobalMaxVoices(int iVoices);
226 String GetGlobalMaxStreams();
227 String SetGlobalMaxStreams(int iStreams);
228 String GetGlobalVolume();
229 String SetGlobalVolume(double dVolume);
230 String GetFileInstruments(String Filename);
231 String ListFileInstruments(String Filename);
232 String GetFileInstrumentInfo(String Filename, uint InstrumentID);
233 String SendChannelMidiData(String MidiMsg, uint uiSamplerChannel, uint Arg1, uint Arg2);
234 String SubscribeNotification(LSCPEvent::event_t);
235 String UnsubscribeNotification(LSCPEvent::event_t);
236 String SetEcho(yyparse_param_t* pSession, double boolean_value);
237 void AnswerClient(String ReturnMessage);
238 void CloseAllConnections();
239
240 static int currentSocket;
241 static std::map<int,String> bufferedCommands;
242
243 static void SendLSCPNotify( LSCPEvent Event );
244 static int EventSubscribers( std::list<LSCPEvent::event_t> events );
245 static String FilterEndlines(String s);
246
247 //Protect main thread that generates real time notify messages
248 //like voice count, stream count and buffer fill
249 //from LSCP server removing engines and channels from underneath
250 static Mutex RTNotifyMutex;
251
252 protected:
253 int hSocket;
254 sockaddr_in SocketAddress;
255 Sampler* pSampler;
256 Condition Initialized;
257
258 int Main(); ///< Implementation of virtual method from class Thread
259
260 private:
261
262 /**
263 * Find a created audio output device index.
264 */
265 int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
266
267 /**
268 * Find a created midi input device index.
269 */
270 int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
271
272 EngineChannel* GetEngineChannel(uint uiSamplerChannel);
273
274 /**
275 * Gets the specified effect send on the specified sampler channel.
276 */
277 FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);
278
279 bool HasSoloChannel();
280 void MuteNonSoloChannels();
281 void UnmuteChannels();
282
283 /**
284 * Throws an exception if the specified file is not found or
285 * if directory is specified.
286 */
287 static void VerifyFile(String Filename);
288
289 static std::map<int,String> bufferedNotifies;
290 static Mutex NotifyMutex;
291 static Mutex NotifyBufferMutex;
292 static bool GetLSCPCommand( std::vector<yyparse_param_t>::iterator iter );
293 static void CloseConnection( std::vector<yyparse_param_t>::iterator iter );
294 static std::vector<yyparse_param_t> Sessions;
295 static Mutex SubscriptionMutex;
296 static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
297 static fd_set fdSet;
298
299 class EventHandler : public ChannelCountListener, public AudioDeviceCountListener,
300 public MidiDeviceCountListener, public MidiInstrumentCountListener,
301 public MidiInstrumentInfoListener, public MidiInstrumentMapCountListener,
302 public MidiInstrumentMapInfoListener, public FxSendCountListener,
303 public VoiceCountListener, public StreamCountListener, public BufferFillListener,
304 public TotalStreamCountListener, public TotalVoiceCountListener,
305 public EngineChangeListener, public MidiPortCountListener {
306
307 public:
308 EventHandler(LSCPServer* pParent);
309
310 /**
311 * Invoked when the number of sampler channels has changed.
312 * @param NewCount The new number of sampler channels.
313 */
314 virtual void ChannelCountChanged(int NewCount);
315 virtual void ChannelAdded(SamplerChannel* pChannel);
316 virtual void ChannelToBeRemoved(SamplerChannel* pChannel);
317
318 /**
319 * Invoked when the number of audio output devices has changed.
320 * @param NewCount The new number of audio output devices.
321 */
322 virtual void AudioDeviceCountChanged(int NewCount);
323
324 /**
325 * Invoked when the number of MIDI input devices has changed.
326 * @param NewCount The new number of MIDI input devices.
327 */
328 virtual void MidiDeviceCountChanged(int NewCount);
329
330 /**
331 * Invoked right before the supplied MIDI input device is going
332 * to be destroyed.
333 * @param pDevice MidiInputDevice to be deleted
334 */
335 virtual void MidiDeviceToBeDestroyed(MidiInputDevice* pDevice);
336
337 /**
338 * Invoked to inform that a new MidiInputDevice has just been
339 * created.
340 * @param pDevice newly created MidiInputDevice
341 */
342 virtual void MidiDeviceCreated(MidiInputDevice* pDevice);
343
344 /**
345 * Invoked when the number of MIDI input ports has changed.
346 * @param NewCount The new number of MIDI input ports.
347 */
348 virtual void MidiPortCountChanged(int NewCount);
349
350 /**
351 * Invoked right before the supplied MIDI input port is going
352 * to be destroyed.
353 * @param pPort MidiInputPort to be deleted
354 */
355 virtual void MidiPortToBeRemoved(MidiInputPort* pPort);
356
357 /**
358 * Invoked to inform that a new MidiInputPort has just been
359 * added.
360 * @param pPort newly created MidiInputPort
361 */
362 virtual void MidiPortAdded(MidiInputPort* pPort);
363
364 /**
365 * Invoked when the number of MIDI instruments has changed.
366 * @param MapId The numerical ID of the MIDI instrument map.
367 * @param NewCount The new number of MIDI instruments.
368 */
369 virtual void MidiInstrumentCountChanged(int MapId, int NewCount);
370
371 /**
372 * Invoked when a MIDI instrument in a MIDI instrument map is changed.
373 * @param MapId The numerical ID of the MIDI instrument map.
374 * @param Bank The index of the MIDI bank, containing the instrument.
375 * @param Program The MIDI program number of the instrument.
376 */
377 virtual void MidiInstrumentInfoChanged(int MapId, int Bank, int Program);
378
379 /**
380 * Invoked when the number of MIDI instrument maps has changed.
381 * @param NewCount The new number of MIDI instruments.
382 */
383 virtual void MidiInstrumentMapCountChanged(int NewCount);
384
385 /**
386 * Invoked when the settings of a MIDI instrument map are changed.
387 * @param MapId The numerical ID of the MIDI instrument map.
388 */
389 virtual void MidiInstrumentMapInfoChanged(int MapId);
390
391 /**
392 * Invoked when the number of effect sends
393 * on the specified sampler channel has changed.
394 * @param ChannelId The numerical ID of the sampler channel.
395 * @param NewCount The new number of effect sends.
396 */
397 virtual void FxSendCountChanged(int ChannelId, int NewCount);
398
399 /**
400 * Invoked when the number of active voices
401 * on the specified sampler channel has changed.
402 * @param ChannelId The numerical ID of the sampler channel.
403 * @param NewCount The new number of active voices.
404 */
405 virtual void VoiceCountChanged(int ChannelId, int NewCount);
406
407 /**
408 * Invoked when the number of active disk streams
409 * on the specified sampler channel has changed.
410 * @param ChannelId The numerical ID of the sampler channel.
411 * @param NewCount The new number of active disk streams.
412 */
413 virtual void StreamCountChanged(int ChannelId, int NewCount);
414
415 /**
416 * Invoked when the fill state of the disk stream
417 * buffers on the specified sampler channel is changed.
418 * @param ChannelId The numerical ID of the sampler channel.
419 * @param FillData The buffer fill data for the specified sampler channel.
420 */
421 virtual void BufferFillChanged(int ChannelId, String FillData);
422
423 /**
424 * Invoked when the total number of active voices is changed.
425 * @param NewCount The new number of active voices.
426 */
427 virtual void TotalVoiceCountChanged(int NewCount);
428 virtual void TotalStreamCountChanged(int NewCount);
429
430 virtual void EngineToBeChanged(int ChannelId);
431 virtual void EngineChanged(int ChannelId);
432
433 virtual ~EventHandler();
434
435 struct midi_listener_entry {
436 SamplerChannel* pSamplerChannel;
437 EngineChannel* pEngineChannel;
438 VirtualMidiDevice* pMidiListener;
439 };
440
441 std::vector<midi_listener_entry> channelMidiListeners;
442
443 struct device_midi_listener_entry {
444 MidiInputPort* pPort;
445 VirtualMidiDevice* pMidiListener;
446 uint uiDeviceID;
447 };
448
449 std::vector<device_midi_listener_entry> deviceMidiListeners;
450
451 private:
452 LSCPServer* pParent;
453 } eventHandler;
454
455 #if HAVE_SQLITE3
456 class DbInstrumentsEventHandler : public InstrumentsDb::Listener {
457 public:
458 virtual void DirectoryCountChanged(String Dir);
459 virtual void DirectoryInfoChanged(String Dir);
460 virtual void DirectoryNameChanged(String Dir, String NewName);
461 virtual void InstrumentCountChanged(String Dir);
462 virtual void InstrumentInfoChanged(String Instr);
463 virtual void InstrumentNameChanged(String Instr, String NewName);
464 virtual void JobStatusChanged(int JobId);
465 } dbInstrumentsEventHandler;
466 #endif // HAVE_SQLITE3
467 };
468
469 }
470
471 #endif // __LSCPSERVER_H_

  ViewVC Help
Powered by ViewVC