/[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 1835 - (show annotations) (download) (as text)
Mon Feb 16 17:56:50 2009 UTC (15 years, 1 month ago) by iliev
File MIME type: text/x-c++hdr
File size: 21866 byte(s)
* Adapted drivers/Plugin class to be used as a base class for the
  AudioUnit plugin and fixed orphaned pointers when deleting PluginGlobal
* Fixed possible iterator invalidations when resetting the sampler
* Fixed memory leaks when issuing the following LSCP commands:
  GET AUDIO_OUTPUT_DRIVER INFO
  GET AUDIO_OUTPUT_DRIVER_PARAMETER INFO
  GET MIDI_INPUT_DRIVER INFO
  GET MIDI_INPUT_DRIVER_PARAMETER INFO
* Fixed possible compilation error when sqlite is not present

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 "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 AddDbInstrumentDirectory(String Dir);
170 String RemoveDbInstrumentDirectory(String Dir, bool Force = false);
171 String GetDbInstrumentDirectoryCount(String Dir, bool Recursive = false);
172 String GetDbInstrumentDirectories(String Dir, bool Recursive = false);
173 String GetDbInstrumentDirectoryInfo(String Dir);
174 String SetDbInstrumentDirectoryName(String Dir, String Name);
175 String MoveDbInstrumentDirectory(String Dir, String Dst);
176 String CopyDbInstrumentDirectory(String Dir, String Dst);
177 String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
178 String FindDbInstrumentDirectories(String Dir, std::map<String,String> Parameters, bool Recursive = true);
179 String AddDbInstruments(String DbDir, String FilePath, int Index = -1, bool bBackground = false);
180 String AddDbInstruments(String ScanMode, String DbDir, String FsDir, bool bBackground = false, bool insDir = false);
181 String RemoveDbInstrument(String Instr);
182 String GetDbInstrumentCount(String Dir, bool Recursive = false);
183 String GetDbInstruments(String Dir, bool Recursive = false);
184 String GetDbInstrumentInfo(String Instr);
185 String SetDbInstrumentName(String Instr, String Name);
186 String MoveDbInstrument(String Instr, String Dst);
187 String CopyDbInstrument(String Instr, String Dst);
188 String SetDbInstrumentDescription(String Instr, String Desc);
189 String SetDbInstrumentFilePath(String OldPath, String NewPath);
190 String FindLostDbInstrumentFiles();
191 String FindDbInstruments(String Dir, std::map<String,String> Parameters, bool Recursive = true);
192 String FormatInstrumentsDb();
193 String EditSamplerChannelInstrument(uint uiSamplerChannel);
194 String GetDbInstrumentsJobInfo(int JobId);
195 String ResetChannel(uint uiSamplerChannel);
196 String ResetSampler();
197 String GetServerInfo();
198 String GetTotalStreamCount();
199 String GetTotalVoiceCount();
200 String GetTotalVoiceCountMax();
201 String GetGlobalMaxVoices();
202 String SetGlobalMaxVoices(int iVoices);
203 String GetGlobalMaxStreams();
204 String SetGlobalMaxStreams(int iStreams);
205 String GetGlobalVolume();
206 String SetGlobalVolume(double dVolume);
207 String GetFileInstruments(String Filename);
208 String ListFileInstruments(String Filename);
209 String GetFileInstrumentInfo(String Filename, uint InstrumentID);
210 String SendChannelMidiData(String MidiMsg, uint uiSamplerChannel, uint Arg1, uint Arg2);
211 String SubscribeNotification(LSCPEvent::event_t);
212 String UnsubscribeNotification(LSCPEvent::event_t);
213 String SetEcho(yyparse_param_t* pSession, double boolean_value);
214 void AnswerClient(String ReturnMessage);
215
216 static int currentSocket;
217 static std::map<int,String> bufferedCommands;
218
219 static void SendLSCPNotify( LSCPEvent Event );
220 static int EventSubscribers( std::list<LSCPEvent::event_t> events );
221 static void LockRTNotify();
222 static void UnlockRTNotify();
223 static String FilterEndlines(String s);
224
225 protected:
226 int hSocket;
227 sockaddr_in SocketAddress;
228 Sampler* pSampler;
229 Condition Initialized;
230
231 int Main(); ///< Implementation of virtual method from class Thread
232
233 private:
234
235 /**
236 * Find a created audio output device index.
237 */
238 int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
239
240 /**
241 * Find a created midi input device index.
242 */
243 int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
244
245 EngineChannel* GetEngineChannel(uint uiSamplerChannel);
246
247 /**
248 * Gets the specified effect send on the specified sampler channel.
249 */
250 FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);
251
252 bool HasSoloChannel();
253 void MuteNonSoloChannels();
254 void UnmuteChannels();
255
256 /**
257 * Throws an exception if the specified file is not found or
258 * if directory is specified.
259 */
260 static void VerifyFile(String Filename);
261
262 static std::map<int,String> bufferedNotifies;
263 static Mutex NotifyMutex;
264 static Mutex NotifyBufferMutex;
265 static bool GetLSCPCommand( std::vector<yyparse_param_t>::iterator iter );
266 static void CloseConnection( std::vector<yyparse_param_t>::iterator iter );
267 static std::vector<yyparse_param_t> Sessions;
268 static Mutex SubscriptionMutex;
269 static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
270 static fd_set fdSet;
271
272 //Protect main thread that generates real time notify messages
273 //like voice count, stream count and buffer fill
274 //from LSCP server removing engines and channels from underneath
275 static Mutex RTNotifyMutex;
276
277 class EventHandler : public ChannelCountListener, public AudioDeviceCountListener,
278 public MidiDeviceCountListener, public MidiInstrumentCountListener,
279 public MidiInstrumentInfoListener, public MidiInstrumentMapCountListener,
280 public MidiInstrumentMapInfoListener, public FxSendCountListener,
281 public VoiceCountListener, public StreamCountListener, public BufferFillListener,
282 public TotalStreamCountListener, public TotalVoiceCountListener,
283 public EngineChangeListener, public MidiPortCountListener {
284
285 public:
286 EventHandler(LSCPServer* pParent);
287
288 /**
289 * Invoked when the number of sampler channels has changed.
290 * @param NewCount The new number of sampler channels.
291 */
292 virtual void ChannelCountChanged(int NewCount);
293 virtual void ChannelAdded(SamplerChannel* pChannel);
294 virtual void ChannelToBeRemoved(SamplerChannel* pChannel);
295
296 /**
297 * Invoked when the number of audio output devices has changed.
298 * @param NewCount The new number of audio output devices.
299 */
300 virtual void AudioDeviceCountChanged(int NewCount);
301
302 /**
303 * Invoked when the number of MIDI input devices has changed.
304 * @param NewCount The new number of MIDI input devices.
305 */
306 virtual void MidiDeviceCountChanged(int NewCount);
307
308 /**
309 * Invoked right before the supplied MIDI input device is going
310 * to be destroyed.
311 * @param pDevice MidiInputDevice to be deleted
312 */
313 virtual void MidiDeviceToBeDestroyed(MidiInputDevice* pDevice);
314
315 /**
316 * Invoked to inform that a new MidiInputDevice has just been
317 * created.
318 * @param pDevice newly created MidiInputDevice
319 */
320 virtual void MidiDeviceCreated(MidiInputDevice* pDevice);
321
322 /**
323 * Invoked when the number of MIDI input ports has changed.
324 * @param NewCount The new number of MIDI input ports.
325 */
326 virtual void MidiPortCountChanged(int NewCount);
327
328 /**
329 * Invoked right before the supplied MIDI input port is going
330 * to be destroyed.
331 * @param pPort MidiInputPort to be deleted
332 */
333 virtual void MidiPortToBeRemoved(MidiInputPort* pPort);
334
335 /**
336 * Invoked to inform that a new MidiInputPort has just been
337 * added.
338 * @param pPort newly created MidiInputPort
339 */
340 virtual void MidiPortAdded(MidiInputPort* pPort);
341
342 /**
343 * Invoked when the number of MIDI instruments has changed.
344 * @param MapId The numerical ID of the MIDI instrument map.
345 * @param NewCount The new number of MIDI instruments.
346 */
347 virtual void MidiInstrumentCountChanged(int MapId, int NewCount);
348
349 /**
350 * Invoked when a MIDI instrument in a MIDI instrument map is changed.
351 * @param MapId The numerical ID of the MIDI instrument map.
352 * @param Bank The index of the MIDI bank, containing the instrument.
353 * @param Program The MIDI program number of the instrument.
354 */
355 virtual void MidiInstrumentInfoChanged(int MapId, int Bank, int Program);
356
357 /**
358 * Invoked when the number of MIDI instrument maps has changed.
359 * @param NewCount The new number of MIDI instruments.
360 */
361 virtual void MidiInstrumentMapCountChanged(int NewCount);
362
363 /**
364 * Invoked when the settings of a MIDI instrument map are changed.
365 * @param MapId The numerical ID of the MIDI instrument map.
366 */
367 virtual void MidiInstrumentMapInfoChanged(int MapId);
368
369 /**
370 * Invoked when the number of effect sends
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 effect sends.
374 */
375 virtual void FxSendCountChanged(int ChannelId, int NewCount);
376
377 /**
378 * Invoked when the number of active voices
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 voices.
382 */
383 virtual void VoiceCountChanged(int ChannelId, int NewCount);
384
385 /**
386 * Invoked when the number of active disk streams
387 * on the specified sampler channel has changed.
388 * @param ChannelId The numerical ID of the sampler channel.
389 * @param NewCount The new number of active disk streams.
390 */
391 virtual void StreamCountChanged(int ChannelId, int NewCount);
392
393 /**
394 * Invoked when the fill state of the disk stream
395 * buffers on the specified sampler channel is changed.
396 * @param ChannelId The numerical ID of the sampler channel.
397 * @param FillData The buffer fill data for the specified sampler channel.
398 */
399 virtual void BufferFillChanged(int ChannelId, String FillData);
400
401 /**
402 * Invoked when the total number of active voices is changed.
403 * @param NewCount The new number of active voices.
404 */
405 virtual void TotalVoiceCountChanged(int NewCount);
406 virtual void TotalStreamCountChanged(int NewCount);
407
408 virtual void EngineToBeChanged(int ChannelId);
409 virtual void EngineChanged(int ChannelId);
410
411 virtual ~EventHandler();
412
413 struct midi_listener_entry {
414 SamplerChannel* pSamplerChannel;
415 EngineChannel* pEngineChannel;
416 VirtualMidiDevice* pMidiListener;
417 };
418
419 std::vector<midi_listener_entry> channelMidiListeners;
420
421 struct device_midi_listener_entry {
422 MidiInputPort* pPort;
423 VirtualMidiDevice* pMidiListener;
424 uint uiDeviceID;
425 };
426
427 std::vector<device_midi_listener_entry> deviceMidiListeners;
428
429 private:
430 LSCPServer* pParent;
431 } eventHandler;
432
433 #if HAVE_SQLITE3
434 class DbInstrumentsEventHandler : public InstrumentsDb::Listener {
435 public:
436 virtual void DirectoryCountChanged(String Dir);
437 virtual void DirectoryInfoChanged(String Dir);
438 virtual void DirectoryNameChanged(String Dir, String NewName);
439 virtual void InstrumentCountChanged(String Dir);
440 virtual void InstrumentInfoChanged(String Instr);
441 virtual void InstrumentNameChanged(String Instr, String NewName);
442 virtual void JobStatusChanged(int JobId);
443 } dbInstrumentsEventHandler;
444 #endif // HAVE_SQLITE3
445 };
446
447 }
448
449 #endif // __LSCPSERVER_H_

  ViewVC Help
Powered by ViewVC