/[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 1535 - (show annotations) (download) (as text)
Mon Dec 3 13:59:03 2007 UTC (11 years, 8 months ago) by iliev
File MIME type: text/x-c++hdr
File size: 18862 byte(s)
* bugfix: The commands GET FILE INSTRUMENTS, LIST FILE INSTRUMENTS,
  GET FILE INSTRUMENT INFO now return an error on fail
* The field FORMAT_NAME returned by GET FILE INSTRUMENT INFO
  is now FORMAT_FAMILY

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 * Copyright (C) 2005 - 2007 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
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 using namespace LinuxSampler;
68
69 // External references to the main scanner and parser functions
70 extern int yyparse(void* YYPARSE_PARAM);
71 extern void restart(yyparse_param_t* pparam, int& yychar);
72
73 /**
74 * Network server for the LinuxSampler Control Protocol (LSCP).
75 */
76 class LSCPServer : public Thread {
77 public:
78 LSCPServer(Sampler* pSampler, long int addr, short int port);
79 virtual ~LSCPServer();
80 int WaitUntilInitialized(long TimeoutSeconds = 0L, long TimeoutNanoSeconds = 0L);
81
82 // Methods called by the parser
83 String DestroyAudioOutputDevice(uint DeviceIndex);
84 String DestroyMidiInputDevice(uint DeviceIndex);
85 String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
86 String SetEngineType(String EngineName, uint uiSamplerChannel);
87 String GetChannels();
88 String ListChannels();
89 String AddChannel();
90 String RemoveChannel(uint uiSamplerChannel);
91 String GetAvailableEngines();
92 String ListAvailableEngines();
93 String GetEngineInfo(String EngineName);
94 String GetChannelInfo(uint uiSamplerChannel);
95 String GetVoiceCount(uint uiSamplerChannel);
96 String GetStreamCount(uint uiSamplerChannel);
97 String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
98 String GetAvailableAudioOutputDrivers();
99 String ListAvailableAudioOutputDrivers();
100 String GetAvailableMidiInputDrivers();
101 String ListAvailableMidiInputDrivers();
102 String GetAudioOutputDriverInfo(String Driver);
103 String GetMidiInputDriverInfo(String Driver);
104 #ifdef __GNUC__
105 typedef std::map<String,String> StringMap; // nasty workaround for a GCC bug (see GCC bug #15980, #57)
106 String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
107 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
108 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
109 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
110 #else
111 String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
112 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
113 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
114 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
115 #endif // __GNUC__
116 String GetAudioOutputDeviceCount();
117 String GetMidiInputDeviceCount();
118 String GetAudioOutputDevices();
119 String GetMidiInputDevices();
120 String GetAudioOutputDeviceInfo(uint DeviceIndex);
121 String GetMidiInputDeviceInfo(uint DeviceIndex);
122 String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
123 String GetMidiInputPortParameterInfo(uint DeviceId, uint PortId, String ParameterName);
124 String GetAudioOutputChannelInfo(uint DeviceId, uint ChannelId);
125 String GetAudioOutputChannelParameterInfo(uint DeviceId, uint ChannelId, String ParameterName);
126 String SetAudioOutputChannelParameter(uint DeviceId, uint ChannelId, String ParamKey, String ParamVal);
127 String SetAudioOutputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
128 String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
129 String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
130 String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
131 String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
132 String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
133 String SetMIDIInputPort(uint MIDIPort, uint uiSamplerChannel);
134 String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);
135 String SetMIDIInputDevice(uint MIDIDeviceId, uint uiSamplerChannel);
136 String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
137 String SetMIDIInput(uint MIDIDeviceId, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
138 String SetVolume(double dVolume, uint uiSamplerChannel);
139 String SetChannelMute(bool bMute, uint uiSamplerChannel);
140 String SetChannelSolo(bool bSolo, uint uiSamplerChannel);
141 String AddOrReplaceMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg, String EngineType, String InstrumentFile, uint InstrumentIndex, float Volume, MidiInstrumentMapper::mode_t LoadMode, String Name, bool bModal);
142 String RemoveMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
143 String GetMidiInstrumentMappings(uint MidiMapID);
144 String GetAllMidiInstrumentMappings();
145 String GetMidiInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
146 String ListMidiInstrumentMappings(uint MidiMapID);
147 String ListAllMidiInstrumentMappings();
148 String ClearMidiInstrumentMappings(uint MidiMapID);
149 String ClearAllMidiInstrumentMappings();
150 String AddMidiInstrumentMap(String MapName = "");
151 String RemoveMidiInstrumentMap(uint MidiMapID);
152 String RemoveAllMidiInstrumentMaps();
153 String GetMidiInstrumentMaps();
154 String ListMidiInstrumentMaps();
155 String GetMidiInstrumentMap(uint MidiMapID);
156 String SetMidiInstrumentMapName(uint MidiMapID, String NewName);
157 String SetChannelMap(uint uiSamplerChannel, int MidiMapID);
158 String CreateFxSend(uint uiSamplerChannel, uint MidiCtrl, String Name = "");
159 String DestroyFxSend(uint uiSamplerChannel, uint FxSendID);
160 String GetFxSends(uint uiSamplerChannel);
161 String ListFxSends(uint uiSamplerChannel);
162 String GetFxSendInfo(uint uiSamplerChannel, uint FxSendID);
163 String SetFxSendName(uint uiSamplerChannel, uint FxSendID, String Name);
164 String SetFxSendAudioOutputChannel(uint uiSamplerChannel, uint FxSendID, uint FxSendChannel, uint DeviceChannel);
165 String SetFxSendMidiController(uint uiSamplerChannel, uint FxSendID, uint MidiController);
166 String SetFxSendLevel(uint uiSamplerChannel, uint FxSendID, double dLevel);
167 String AddDbInstrumentDirectory(String Dir);
168 String RemoveDbInstrumentDirectory(String Dir, bool Force = false);
169 String GetDbInstrumentDirectoryCount(String Dir, bool Recursive = false);
170 String GetDbInstrumentDirectories(String Dir, bool Recursive = false);
171 String GetDbInstrumentDirectoryInfo(String Dir);
172 String SetDbInstrumentDirectoryName(String Dir, String Name);
173 String MoveDbInstrumentDirectory(String Dir, String Dst);
174 String CopyDbInstrumentDirectory(String Dir, String Dst);
175 String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
176 String FindDbInstrumentDirectories(String Dir, std::map<String,String> Parameters, bool Recursive = true);
177 String AddDbInstruments(String DbDir, String FilePath, int Index = -1, bool bBackground = false);
178 String AddDbInstruments(String ScanMode, String DbDir, String FsDir, bool bBackground = false);
179 String RemoveDbInstrument(String Instr);
180 String GetDbInstrumentCount(String Dir, bool Recursive = false);
181 String GetDbInstruments(String Dir, bool Recursive = false);
182 String GetDbInstrumentInfo(String Instr);
183 String SetDbInstrumentName(String Instr, String Name);
184 String MoveDbInstrument(String Instr, String Dst);
185 String CopyDbInstrument(String Instr, String Dst);
186 String SetDbInstrumentDescription(String Instr, String Desc);
187 String FindDbInstruments(String Dir, std::map<String,String> Parameters, bool Recursive = true);
188 String FormatInstrumentsDb();
189 String EditSamplerChannelInstrument(uint uiSamplerChannel);
190 String GetDbInstrumentsJobInfo(int JobId);
191 String ResetChannel(uint uiSamplerChannel);
192 String ResetSampler();
193 String GetServerInfo();
194 String GetTotalVoiceCount();
195 String GetTotalVoiceCountMax();
196 String GetGlobalVolume();
197 String SetGlobalVolume(double dVolume);
198 String GetFileInstruments(String Filename);
199 String ListFileInstruments(String Filename);
200 String GetFileInstrumentInfo(String Filename, uint InstrumentID);
201 String SubscribeNotification(LSCPEvent::event_t);
202 String UnsubscribeNotification(LSCPEvent::event_t);
203 String SetEcho(yyparse_param_t* pSession, double boolean_value);
204 void AnswerClient(String ReturnMessage);
205
206 static int currentSocket;
207 static std::map<int,String> bufferedCommands;
208
209 static void SendLSCPNotify( LSCPEvent Event );
210 static int EventSubscribers( std::list<LSCPEvent::event_t> events );
211 static void LockRTNotify( void ) { RTNotifyMutex.Lock(); }
212 static void UnlockRTNotify( void ) { RTNotifyMutex.Unlock(); }
213 static String FilterEndlines(String s);
214
215 protected:
216 int hSocket;
217 sockaddr_in SocketAddress;
218 Sampler* pSampler;
219 Condition Initialized;
220
221 int Main(); ///< Implementation of virtual method from class Thread
222
223 private:
224
225 /**
226 * Find a created audio output device index.
227 */
228 int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
229
230 /**
231 * Find a created midi input device index.
232 */
233 int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
234
235 EngineChannel* GetEngineChannel(uint uiSamplerChannel);
236
237 /**
238 * Gets the specified effect send on the specified sampler channel.
239 */
240 FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);
241
242 bool HasSoloChannel();
243 void MuteNonSoloChannels();
244 void UnmuteChannels();
245
246 /**
247 * Throws an exception if the specified file is not found or
248 * if directory is specified.
249 */
250 static void VerifyFile(String Filename);
251
252 static std::map<int,String> bufferedNotifies;
253 static Mutex NotifyMutex;
254 static Mutex NotifyBufferMutex;
255 static bool GetLSCPCommand( std::vector<yyparse_param_t>::iterator iter );
256 static void CloseConnection( std::vector<yyparse_param_t>::iterator iter );
257 static std::vector<yyparse_param_t> Sessions;
258 static Mutex SubscriptionMutex;
259 static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
260 static fd_set fdSet;
261
262 //Protect main thread that generates real time notify messages
263 //like voice count, stream count and buffer fill
264 //from LSCP server removing engines and channels from underneath
265 static Mutex RTNotifyMutex;
266
267 class EventHandler : public ChannelCountListener, public AudioDeviceCountListener,
268 public MidiDeviceCountListener, public MidiInstrumentCountListener,
269 public MidiInstrumentInfoListener, public MidiInstrumentMapCountListener,
270 public MidiInstrumentMapInfoListener, public FxSendCountListener,
271 public VoiceCountListener, public StreamCountListener,
272 public BufferFillListener, public TotalVoiceCountListener {
273
274 public:
275 /**
276 * Invoked when the number of sampler channels has changed.
277 * @param NewCount The new number of sampler channels.
278 */
279 virtual void ChannelCountChanged(int NewCount);
280
281 /**
282 * Invoked when the number of audio output devices has changed.
283 * @param NewCount The new number of audio output devices.
284 */
285 virtual void AudioDeviceCountChanged(int NewCount);
286
287 /**
288 * Invoked when the number of MIDI input devices has changed.
289 * @param NewCount The new number of MIDI input devices.
290 */
291 virtual void MidiDeviceCountChanged(int NewCount);
292
293 /**
294 * Invoked when the number of MIDI instruments has changed.
295 * @param MapId The numerical ID of the MIDI instrument map.
296 * @param NewCount The new number of MIDI instruments.
297 */
298 virtual void MidiInstrumentCountChanged(int MapId, int NewCount);
299
300 /**
301 * Invoked when a MIDI instrument in a MIDI instrument map is changed.
302 * @param MapId The numerical ID of the MIDI instrument map.
303 * @param Bank The index of the MIDI bank, containing the instrument.
304 * @param Program The MIDI program number of the instrument.
305 */
306 virtual void MidiInstrumentInfoChanged(int MapId, int Bank, int Program);
307
308 /**
309 * Invoked when the number of MIDI instrument maps has changed.
310 * @param NewCount The new number of MIDI instruments.
311 */
312 virtual void MidiInstrumentMapCountChanged(int NewCount);
313
314 /**
315 * Invoked when the settings of a MIDI instrument map are changed.
316 * @param MapId The numerical ID of the MIDI instrument map.
317 */
318 virtual void MidiInstrumentMapInfoChanged(int MapId);
319
320 /**
321 * Invoked when the number of effect sends
322 * on the specified sampler channel has changed.
323 * @param ChannelId The numerical ID of the sampler channel.
324 * @param NewCount The new number of effect sends.
325 */
326 virtual void FxSendCountChanged(int ChannelId, int NewCount);
327
328 /**
329 * Invoked when the number of active voices
330 * on the specified sampler channel has changed.
331 * @param ChannelId The numerical ID of the sampler channel.
332 * @param NewCount The new number of active voices.
333 */
334 virtual void VoiceCountChanged(int ChannelId, int NewCount);
335
336 /**
337 * Invoked when the number of active disk streams
338 * on the specified sampler channel has changed.
339 * @param ChannelId The numerical ID of the sampler channel.
340 * @param NewCount The new number of active disk streams.
341 */
342 virtual void StreamCountChanged(int ChannelId, int NewCount);
343
344 /**
345 * Invoked when the fill state of the disk stream
346 * buffers on the specified sampler channel is changed.
347 * @param ChannelId The numerical ID of the sampler channel.
348 * @param FillData The buffer fill data for the specified sampler channel.
349 */
350 virtual void BufferFillChanged(int ChannelId, String FillData);
351
352 /**
353 * Invoked when the total number of active voices is changed.
354 * @param NewCount The new number of active voices.
355 */
356 virtual void TotalVoiceCountChanged(int NewCount);
357 } eventHandler;
358
359 #if HAVE_SQLITE3
360 class DbInstrumentsEventHandler : public InstrumentsDb::Listener {
361 public:
362 virtual void DirectoryCountChanged(String Dir);
363 virtual void DirectoryInfoChanged(String Dir);
364 virtual void DirectoryNameChanged(String Dir, String NewName);
365 virtual void InstrumentCountChanged(String Dir);
366 virtual void InstrumentInfoChanged(String Instr);
367 virtual void InstrumentNameChanged(String Instr, String NewName);
368 virtual void JobStatusChanged(int JobId);
369 } dbInstrumentsEventHandler;
370 #endif // HAVE_SQLITE3
371 };
372
373 #endif // __LSCPSERVER_H_

  ViewVC Help
Powered by ViewVC