/[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 1424 - (hide annotations) (download) (as text)
Sun Oct 14 22:00:17 2007 UTC (16 years, 5 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 18418 byte(s)
* code cleanup:
- global.h now only covers global definitions that are needed for the C++
  API header files, all implementation internal global definitions are now
  in global_private.h
- atomic.h is not exposed to the C++ API anymore (replaced the references
  in SynchronizedConfig.h for this with local definitions)
- no need to include config.h anymore for using LS's API header files
- DB instruments classes are not exposed to the C++ API
- POSIX callback functions of Thread.h are hidden
- the (optional) gig Engine benchmark compiles again
- updated Doxyfile.in
- fixed warnings in API doc generation
* preparations for release 0.5.0

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     #include <unistd.h>
28     #include <sys/types.h>
29     #include <sys/socket.h>
30 senkov 170 #include <sys/select.h>
31     #include <sys/time.h>
32 schoenebeck 35 #include <netinet/in.h>
33     #include <netinet/tcp.h>
34     #include <arpa/inet.h>
35     #include <netdb.h>
36    
37 senkov 170 #include <list>
38    
39 schoenebeck 53 #include "lscp.h"
40 schoenebeck 35 #include "lscpparser.h"
41 senkov 170 #include "lscp.h"
42     #include "lscpevent.h"
43 schoenebeck 53 #include "../Sampler.h"
44     #include "../common/Thread.h"
45 senkov 170 #include "../common/Mutex.h"
46 schoenebeck 211 #include "../common/Condition.h"
47 schoenebeck 1424 #include "../common/global_private.h"
48 schoenebeck 35
49 schoenebeck 947 #include "../drivers/midi/MidiInstrumentMapper.h"
50    
51 iliev 1161 #if HAVE_SQLITE3
52     #include "../db/InstrumentsDb.h"
53     #endif
54    
55 schoenebeck 35 /// TCP Port on which the server should listen for connection requests.
56 senkov 667 #define LSCP_ADDR INADDR_ANY
57 schoenebeck 35 #define LSCP_PORT 8888
58    
59 schoenebeck 227 /// try up to 3 minutes to bind server socket
60     #define LSCP_SERVER_BIND_TIMEOUT 180
61    
62 schoenebeck 53 using namespace LinuxSampler;
63    
64 schoenebeck 35 // External references to the main scanner and parser functions
65     extern int yyparse(void* YYPARSE_PARAM);
66 schoenebeck 219 extern void restart(yyparse_param_t* pparam, int& yychar);
67 schoenebeck 35
68     /**
69     * Network server for the LinuxSampler Control Protocol (LSCP).
70     */
71     class LSCPServer : public Thread {
72     public:
73 senkov 667 LSCPServer(Sampler* pSampler, long int addr, short int port);
74 schoenebeck 475 virtual ~LSCPServer();
75 schoenebeck 211 int WaitUntilInitialized(long TimeoutSeconds = 0L, long TimeoutNanoSeconds = 0L);
76 schoenebeck 35
77     // Methods called by the parser
78 schoenebeck 123 String DestroyAudioOutputDevice(uint DeviceIndex);
79 senkov 155 String DestroyMidiInputDevice(uint DeviceIndex);
80 capela 137 String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
81 schoenebeck 411 String SetEngineType(String EngineName, uint uiSamplerChannel);
82 schoenebeck 35 String GetChannels();
83 schoenebeck 209 String ListChannels();
84 schoenebeck 35 String AddChannel();
85 schoenebeck 53 String RemoveChannel(uint uiSamplerChannel);
86 schoenebeck 35 String GetAvailableEngines();
87 capela 527 String ListAvailableEngines();
88 schoenebeck 35 String GetEngineInfo(String EngineName);
89 schoenebeck 53 String GetChannelInfo(uint uiSamplerChannel);
90     String GetVoiceCount(uint uiSamplerChannel);
91     String GetStreamCount(uint uiSamplerChannel);
92     String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
93 schoenebeck 123 String GetAvailableAudioOutputDrivers();
94 capela 527 String ListAvailableAudioOutputDrivers();
95 senkov 155 String GetAvailableMidiInputDrivers();
96 capela 527 String ListAvailableMidiInputDrivers();
97 schoenebeck 123 String GetAudioOutputDriverInfo(String Driver);
98 senkov 155 String GetMidiInputDriverInfo(String Driver);
99 schoenebeck 123 #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 senkov 155 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
103 senkov 140 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
104 senkov 155 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
105 schoenebeck 123 #else
106     String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
107 senkov 155 String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
108 senkov 140 String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
109 senkov 155 String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
110 schoenebeck 123 #endif // __GNUC__
111     String GetAudioOutputDeviceCount();
112 senkov 155 String GetMidiInputDeviceCount();
113 schoenebeck 123 String GetAudioOutputDevices();
114 senkov 155 String GetMidiInputDevices();
115 schoenebeck 123 String GetAudioOutputDeviceInfo(uint DeviceIndex);
116 senkov 155 String GetMidiInputDeviceInfo(uint DeviceIndex);
117     String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
118 senkov 185 String GetMidiInputPortParameterInfo(uint DeviceId, uint PortId, String ParameterName);
119 schoenebeck 123 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 senkov 155 String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
124 capela 159 String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
125 schoenebeck 123 String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
126 capela 159 String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
127 capela 143 String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
128 capela 159 String SetMIDIInputPort(uint MIDIPort, uint uiSamplerChannel);
129     String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);
130     String SetMIDIInputDevice(uint MIDIDeviceId, uint uiSamplerChannel);
131 schoenebeck 123 String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
132 capela 159 String SetMIDIInput(uint MIDIDeviceId, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
133 schoenebeck 225 String SetVolume(double dVolume, uint uiSamplerChannel);
134 schoenebeck 705 String SetChannelMute(bool bMute, uint uiSamplerChannel);
135     String SetChannelSolo(bool bSolo, uint uiSamplerChannel);
136 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);
137 schoenebeck 973 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 schoenebeck 1001 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 iliev 1135 String SetFxSendName(uint uiSamplerChannel, uint FxSendID, String Name);
159 schoenebeck 1001 String SetFxSendAudioOutputChannel(uint uiSamplerChannel, uint FxSendID, uint FxSendChannel, uint DeviceChannel);
160 schoenebeck 1026 String SetFxSendMidiController(uint uiSamplerChannel, uint FxSendID, uint MidiController);
161     String SetFxSendLevel(uint uiSamplerChannel, uint FxSendID, double dLevel);
162 iliev 1161 String AddDbInstrumentDirectory(String Dir);
163     String RemoveDbInstrumentDirectory(String Dir, bool Force = false);
164 iliev 1187 String GetDbInstrumentDirectoryCount(String Dir, bool Recursive = false);
165     String GetDbInstrumentDirectories(String Dir, bool Recursive = false);
166 iliev 1161 String GetDbInstrumentDirectoryInfo(String Dir);
167     String SetDbInstrumentDirectoryName(String Dir, String Name);
168     String MoveDbInstrumentDirectory(String Dir, String Dst);
169 iliev 1187 String CopyDbInstrumentDirectory(String Dir, String Dst);
170 iliev 1161 String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
171 iliev 1187 String FindDbInstrumentDirectories(String Dir, std::map<String,String> Parameters, bool Recursive = true);
172 iliev 1200 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 iliev 1161 String RemoveDbInstrument(String Instr);
175 iliev 1187 String GetDbInstrumentCount(String Dir, bool Recursive = false);
176     String GetDbInstruments(String Dir, bool Recursive = false);
177 iliev 1161 String GetDbInstrumentInfo(String Instr);
178     String SetDbInstrumentName(String Instr, String Name);
179     String MoveDbInstrument(String Instr, String Dst);
180 iliev 1187 String CopyDbInstrument(String Instr, String Dst);
181 iliev 1161 String SetDbInstrumentDescription(String Instr, String Desc);
182 iliev 1187 String FindDbInstruments(String Dir, std::map<String,String> Parameters, bool Recursive = true);
183 iliev 1353 String FormatInstrumentsDb();
184 schoenebeck 1212 String EditSamplerChannelInstrument(uint uiSamplerChannel);
185 iliev 1200 String GetDbInstrumentsJobInfo(int JobId);
186 schoenebeck 53 String ResetChannel(uint uiSamplerChannel);
187 schoenebeck 212 String ResetSampler();
188 schoenebeck 563 String GetServerInfo();
189 iliev 778 String GetTotalVoiceCount();
190     String GetTotalVoiceCountMax();
191 schoenebeck 1005 String GetGlobalVolume();
192     String SetGlobalVolume(double dVolume);
193 senkov 170 String SubscribeNotification(LSCPEvent::event_t);
194     String UnsubscribeNotification(LSCPEvent::event_t);
195 schoenebeck 210 String SetEcho(yyparse_param_t* pSession, double boolean_value);
196 schoenebeck 35 void AnswerClient(String ReturnMessage);
197 senkov 170
198     static int currentSocket;
199     static std::map<int,String> bufferedCommands;
200 senkov 184
201     static void SendLSCPNotify( LSCPEvent Event );
202 senkov 360 static int EventSubscribers( std::list<LSCPEvent::event_t> events );
203     static void LockRTNotify( void ) { RTNotifyMutex.Lock(); }
204     static void UnlockRTNotify( void ) { RTNotifyMutex.Unlock(); }
205 iliev 1161 static String FilterEndlines(String s);
206 senkov 184
207 schoenebeck 35 protected:
208 schoenebeck 53 int hSocket;
209     sockaddr_in SocketAddress;
210     Sampler* pSampler;
211 schoenebeck 211 Condition Initialized;
212 schoenebeck 35
213     int Main(); ///< Implementation of virtual method from class Thread
214 senkov 170
215 schoenebeck 35 private:
216 schoenebeck 209
217 schoenebeck 35 /**
218 capela 143 * Find a created audio output device index.
219     */
220     int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
221 schoenebeck 209
222 senkov 155 /**
223     * Find a created midi input device index.
224     */
225     int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
226 capela 143
227 iliev 1135 EngineChannel* GetEngineChannel(uint uiSamplerChannel);
228    
229     /**
230     * Gets the specified effect send on the specified sampler channel.
231     */
232     FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);
233    
234 schoenebeck 705 bool HasSoloChannel();
235     void MuteNonSoloChannels();
236     void UnmuteChannels();
237    
238 senkov 170 static std::map<int,String> bufferedNotifies;
239     static Mutex NotifyMutex;
240     static Mutex NotifyBufferMutex;
241 schoenebeck 210 static bool GetLSCPCommand( std::vector<yyparse_param_t>::iterator iter );
242     static void CloseConnection( std::vector<yyparse_param_t>::iterator iter );
243     static std::vector<yyparse_param_t> Sessions;
244 senkov 170 static Mutex SubscriptionMutex;
245     static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
246     static fd_set fdSet;
247 senkov 360
248     //Protect main thread that generates real time notify messages
249     //like voice count, stream count and buffer fill
250     //from LSCP server removing engines and channels from underneath
251     static Mutex RTNotifyMutex;
252 iliev 1130
253 iliev 1133 class EventHandler : public ChannelCountListener, public AudioDeviceCountListener,
254     public MidiDeviceCountListener, public MidiInstrumentCountListener,
255     public MidiInstrumentInfoListener, public MidiInstrumentMapCountListener,
256     public MidiInstrumentMapInfoListener, public FxSendCountListener,
257     public VoiceCountListener, public StreamCountListener,
258     public BufferFillListener, public TotalVoiceCountListener {
259    
260     public:
261 iliev 1130 /**
262     * Invoked when the number of sampler channels has changed.
263     * @param NewCount The new number of sampler channels.
264     */
265     virtual void ChannelCountChanged(int NewCount);
266 schoenebeck 1212
267 iliev 1130 /**
268     * Invoked when the number of audio output devices has changed.
269     * @param NewCount The new number of audio output devices.
270     */
271     virtual void AudioDeviceCountChanged(int NewCount);
272 schoenebeck 1212
273 iliev 1130 /**
274     * Invoked when the number of MIDI input devices has changed.
275     * @param NewCount The new number of MIDI input devices.
276     */
277     virtual void MidiDeviceCountChanged(int NewCount);
278 iliev 1133
279 iliev 1130 /**
280     * Invoked when the number of MIDI instruments has changed.
281     * @param MapId The numerical ID of the MIDI instrument map.
282     * @param NewCount The new number of MIDI instruments.
283     */
284     virtual void MidiInstrumentCountChanged(int MapId, int NewCount);
285 schoenebeck 1212
286 iliev 1130 /**
287     * Invoked when a MIDI instrument in a MIDI instrument map is changed.
288     * @param MapId The numerical ID of the MIDI instrument map.
289     * @param Bank The index of the MIDI bank, containing the instrument.
290     * @param Program The MIDI program number of the instrument.
291     */
292     virtual void MidiInstrumentInfoChanged(int MapId, int Bank, int Program);
293 schoenebeck 1212
294 iliev 1133 /**
295 iliev 1130 * Invoked when the number of MIDI instrument maps has changed.
296     * @param NewCount The new number of MIDI instruments.
297     */
298     virtual void MidiInstrumentMapCountChanged(int NewCount);
299    
300     /**
301     * Invoked when the settings of a MIDI instrument map are changed.
302     * @param MapId The numerical ID of the MIDI instrument map.
303     */
304     virtual void MidiInstrumentMapInfoChanged(int MapId);
305 schoenebeck 1212
306 iliev 1130 /**
307     * Invoked when the number of effect sends
308     * on the specified sampler channel has changed.
309     * @param ChannelId The numerical ID of the sampler channel.
310     * @param NewCount The new number of effect sends.
311     */
312     virtual void FxSendCountChanged(int ChannelId, int NewCount);
313 iliev 1133
314 iliev 1130 /**
315     * Invoked when the number of active voices
316     * on the specified sampler channel has changed.
317     * @param ChannelId The numerical ID of the sampler channel.
318     * @param NewCount The new number of active voices.
319     */
320     virtual void VoiceCountChanged(int ChannelId, int NewCount);
321    
322     /**
323     * Invoked when the number of active disk streams
324     * on the specified sampler channel has changed.
325     * @param ChannelId The numerical ID of the sampler channel.
326     * @param NewCount The new number of active disk streams.
327     */
328     virtual void StreamCountChanged(int ChannelId, int NewCount);
329    
330     /**
331     * Invoked when the fill state of the disk stream
332     * buffers on the specified sampler channel is changed.
333     * @param ChannelId The numerical ID of the sampler channel.
334     * @param FillData The buffer fill data for the specified sampler channel.
335     */
336     virtual void BufferFillChanged(int ChannelId, String FillData);
337    
338     /**
339     * Invoked when the total number of active voices is changed.
340     * @param NewCount The new number of active voices.
341     */
342     virtual void TotalVoiceCountChanged(int NewCount);
343 iliev 1133 } eventHandler;
344 iliev 1161
345     #if HAVE_SQLITE3
346     class DbInstrumentsEventHandler : public InstrumentsDb::Listener {
347     public:
348     virtual void DirectoryCountChanged(String Dir);
349     virtual void DirectoryInfoChanged(String Dir);
350     virtual void DirectoryNameChanged(String Dir, String NewName);
351     virtual void InstrumentCountChanged(String Dir);
352     virtual void InstrumentInfoChanged(String Instr);
353     virtual void InstrumentNameChanged(String Instr, String NewName);
354 iliev 1200 virtual void JobStatusChanged(int JobId);
355 iliev 1161 } dbInstrumentsEventHandler;
356     #endif // HAVE_SQLITE3
357 schoenebeck 35 };
358    
359     #endif // __LSCPSERVER_H_

  ViewVC Help
Powered by ViewVC