/[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 1212 - (show annotations) (download) (as text)
Tue May 29 23:59:36 2007 UTC (16 years, 10 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 20113 byte(s)
* added highly experimental support for on-the-fly instrument editing
  within the sampler's process (by using instrument editor plugins),
  you'll notice the new "Registered instrument editors:" message on
  startup, the plugin path can be overridden at compile time with
  ./configure --enable-plugin-dir=/some/dir
* added a new LSCP command "EDIT INSTRUMENT <sampler-channel>" to spawn
  a matching instrument editor for the instrument on the given sampler
  channel (LSCP command syntax might be subject to change soon)
* config.h is not going to be installed along with liblinuxsampler's
  API header files anymore (not necessary anymore)
* take care of $(DESTDIR) when creating the instruments DB on 'make
  install' rule (needed for packaging and cross compilation)
* bumped version to 0.4.0.5cvs

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

  ViewVC Help
Powered by ViewVC