/[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 1535 - (hide annotations) (download) (as text)
Mon Dec 3 13:59:03 2007 UTC (16 years, 4 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 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 1026 * Copyright (C) 2005 - 2007 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    
56 iliev 1161 #if HAVE_SQLITE3
57     #include "../db/InstrumentsDb.h"
58     #endif
59    
60 schoenebeck 35 /// TCP Port on which the server should listen for connection requests.
61 senkov 667 #define LSCP_ADDR INADDR_ANY
62 schoenebeck 35 #define LSCP_PORT 8888
63    
64 schoenebeck 227 /// try up to 3 minutes to bind server socket
65     #define LSCP_SERVER_BIND_TIMEOUT 180
66    
67 schoenebeck 53 using namespace LinuxSampler;
68    
69 schoenebeck 35 // External references to the main scanner and parser functions
70     extern int yyparse(void* YYPARSE_PARAM);
71 schoenebeck 219 extern void restart(yyparse_param_t* pparam, int& yychar);
72 schoenebeck 35
73     /**
74     * Network server for the LinuxSampler Control Protocol (LSCP).
75     */
76     class LSCPServer : public Thread {
77     public:
78 senkov 667 LSCPServer(Sampler* pSampler, long int addr, short int port);
79 schoenebeck 475 virtual ~LSCPServer();
80 schoenebeck 211 int WaitUntilInitialized(long TimeoutSeconds = 0L, long TimeoutNanoSeconds = 0L);
81 schoenebeck 35
82     // Methods called by the parser
83 schoenebeck 123 String DestroyAudioOutputDevice(uint DeviceIndex);
84 senkov 155 String DestroyMidiInputDevice(uint DeviceIndex);
85 capela 137 String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
86 schoenebeck 411 String SetEngineType(String EngineName, uint uiSamplerChannel);
87 schoenebeck 35 String GetChannels();
88 schoenebeck 209 String ListChannels();
89 schoenebeck 35 String AddChannel();
90 schoenebeck 53 String RemoveChannel(uint uiSamplerChannel);
91 schoenebeck 35 String GetAvailableEngines();
92 capela 527 String ListAvailableEngines();
93 schoenebeck 35 String GetEngineInfo(String EngineName);
94 schoenebeck 53 String GetChannelInfo(uint uiSamplerChannel);
95     String GetVoiceCount(uint uiSamplerChannel);
96     String GetStreamCount(uint uiSamplerChannel);
97     String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
98 schoenebeck 123 String GetAvailableAudioOutputDrivers();
99 capela 527 String ListAvailableAudioOutputDrivers();
100 senkov 155 String GetAvailableMidiInputDrivers();
101 capela 527 String ListAvailableMidiInputDrivers();
102 schoenebeck 123 String GetAudioOutputDriverInfo(String Driver);
103 senkov 155 String GetMidiInputDriverInfo(String Driver);
104 schoenebeck 123 #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 senkov 155 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
108 senkov 140 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
109 senkov 155 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
110 schoenebeck 123 #else
111     String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
112 senkov 155 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
113 senkov 140 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
114 senkov 155 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
115 schoenebeck 123 #endif // __GNUC__
116     String GetAudioOutputDeviceCount();
117 senkov 155 String GetMidiInputDeviceCount();
118 schoenebeck 123 String GetAudioOutputDevices();
119 senkov 155 String GetMidiInputDevices();
120 schoenebeck 123 String GetAudioOutputDeviceInfo(uint DeviceIndex);
121 senkov 155 String GetMidiInputDeviceInfo(uint DeviceIndex);
122     String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
123 senkov 185 String GetMidiInputPortParameterInfo(uint DeviceId, uint PortId, String ParameterName);
124 schoenebeck 123 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 senkov 155 String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
129 capela 159 String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
130 schoenebeck 123 String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
131 capela 159 String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
132 capela 143 String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
133 capela 159 String SetMIDIInputPort(uint MIDIPort, uint uiSamplerChannel);
134     String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);
135     String SetMIDIInputDevice(uint MIDIDeviceId, uint uiSamplerChannel);
136 schoenebeck 123 String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
137 capela 159 String SetMIDIInput(uint MIDIDeviceId, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
138 schoenebeck 225 String SetVolume(double dVolume, uint uiSamplerChannel);
139 schoenebeck 705 String SetChannelMute(bool bMute, uint uiSamplerChannel);
140     String SetChannelSolo(bool bSolo, uint uiSamplerChannel);
141 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);
142 schoenebeck 973 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 schoenebeck 1001 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 iliev 1135 String SetFxSendName(uint uiSamplerChannel, uint FxSendID, String Name);
164 schoenebeck 1001 String SetFxSendAudioOutputChannel(uint uiSamplerChannel, uint FxSendID, uint FxSendChannel, uint DeviceChannel);
165 schoenebeck 1026 String SetFxSendMidiController(uint uiSamplerChannel, uint FxSendID, uint MidiController);
166     String SetFxSendLevel(uint uiSamplerChannel, uint FxSendID, double dLevel);
167 iliev 1161 String AddDbInstrumentDirectory(String Dir);
168     String RemoveDbInstrumentDirectory(String Dir, bool Force = false);
169 iliev 1187 String GetDbInstrumentDirectoryCount(String Dir, bool Recursive = false);
170     String GetDbInstrumentDirectories(String Dir, bool Recursive = false);
171 iliev 1161 String GetDbInstrumentDirectoryInfo(String Dir);
172     String SetDbInstrumentDirectoryName(String Dir, String Name);
173     String MoveDbInstrumentDirectory(String Dir, String Dst);
174 iliev 1187 String CopyDbInstrumentDirectory(String Dir, String Dst);
175 iliev 1161 String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
176 iliev 1187 String FindDbInstrumentDirectories(String Dir, std::map<String,String> Parameters, bool Recursive = true);
177 iliev 1200 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 iliev 1161 String RemoveDbInstrument(String Instr);
180 iliev 1187 String GetDbInstrumentCount(String Dir, bool Recursive = false);
181     String GetDbInstruments(String Dir, bool Recursive = false);
182 iliev 1161 String GetDbInstrumentInfo(String Instr);
183     String SetDbInstrumentName(String Instr, String Name);
184     String MoveDbInstrument(String Instr, String Dst);
185 iliev 1187 String CopyDbInstrument(String Instr, String Dst);
186 iliev 1161 String SetDbInstrumentDescription(String Instr, String Desc);
187 iliev 1187 String FindDbInstruments(String Dir, std::map<String,String> Parameters, bool Recursive = true);
188 iliev 1353 String FormatInstrumentsDb();
189 schoenebeck 1212 String EditSamplerChannelInstrument(uint uiSamplerChannel);
190 iliev 1200 String GetDbInstrumentsJobInfo(int JobId);
191 schoenebeck 53 String ResetChannel(uint uiSamplerChannel);
192 schoenebeck 212 String ResetSampler();
193 schoenebeck 563 String GetServerInfo();
194 iliev 778 String GetTotalVoiceCount();
195     String GetTotalVoiceCountMax();
196 schoenebeck 1005 String GetGlobalVolume();
197     String SetGlobalVolume(double dVolume);
198 schoenebeck 1525 String GetFileInstruments(String Filename);
199     String ListFileInstruments(String Filename);
200     String GetFileInstrumentInfo(String Filename, uint InstrumentID);
201 senkov 170 String SubscribeNotification(LSCPEvent::event_t);
202     String UnsubscribeNotification(LSCPEvent::event_t);
203 schoenebeck 210 String SetEcho(yyparse_param_t* pSession, double boolean_value);
204 schoenebeck 35 void AnswerClient(String ReturnMessage);
205 senkov 170
206     static int currentSocket;
207     static std::map<int,String> bufferedCommands;
208 senkov 184
209     static void SendLSCPNotify( LSCPEvent Event );
210 senkov 360 static int EventSubscribers( std::list<LSCPEvent::event_t> events );
211     static void LockRTNotify( void ) { RTNotifyMutex.Lock(); }
212     static void UnlockRTNotify( void ) { RTNotifyMutex.Unlock(); }
213 iliev 1161 static String FilterEndlines(String s);
214 senkov 184
215 schoenebeck 35 protected:
216 schoenebeck 53 int hSocket;
217     sockaddr_in SocketAddress;
218     Sampler* pSampler;
219 schoenebeck 211 Condition Initialized;
220 schoenebeck 35
221     int Main(); ///< Implementation of virtual method from class Thread
222 senkov 170
223 schoenebeck 35 private:
224 schoenebeck 209
225 schoenebeck 35 /**
226 capela 143 * Find a created audio output device index.
227     */
228     int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
229 schoenebeck 209
230 senkov 155 /**
231     * Find a created midi input device index.
232     */
233     int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
234 capela 143
235 iliev 1135 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 schoenebeck 705 bool HasSoloChannel();
243     void MuteNonSoloChannels();
244     void UnmuteChannels();
245 iliev 1535
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 schoenebeck 705
252 senkov 170 static std::map<int,String> bufferedNotifies;
253     static Mutex NotifyMutex;
254     static Mutex NotifyBufferMutex;
255 schoenebeck 210 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 senkov 170 static Mutex SubscriptionMutex;
259     static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
260     static fd_set fdSet;
261 senkov 360
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 iliev 1130
267 iliev 1133 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 iliev 1130 /**
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 schoenebeck 1212
281 iliev 1130 /**
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 schoenebeck 1212
287 iliev 1130 /**
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 iliev 1133
293 iliev 1130 /**
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 schoenebeck 1212
300 iliev 1130 /**
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 schoenebeck 1212
308 iliev 1133 /**
309 iliev 1130 * 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 schoenebeck 1212
320 iliev 1130 /**
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 iliev 1133
328 iliev 1130 /**
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 iliev 1133 } eventHandler;
358 iliev 1161
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 iliev 1200 virtual void JobStatusChanged(int JobId);
369 iliev 1161 } dbInstrumentsEventHandler;
370     #endif // HAVE_SQLITE3
371 schoenebeck 35 };
372    
373     #endif // __LSCPSERVER_H_

  ViewVC Help
Powered by ViewVC