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

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

Parent Directory Parent Directory | Revision Log Revision Log

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