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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 133 by capela, Fri Jun 18 14:29:02 2004 UTC revision 1353 by iliev, Mon Sep 17 23:15:25 2007 UTC
# Line 3  Line 3 
3   *   LinuxSampler - modular, streaming capable sampler                     *   *   LinuxSampler - modular, streaming capable sampler                     *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
6     *   Copyright (C) 2005 - 2007 Christian Schoenebeck                       *
7   *                                                                         *   *                                                                         *
8   *   This program is free software; you can redistribute it and/or modify  *   *   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  *   *   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     *   *   the Free Software Foundation; either version 2 of the License, or     *
11   *   (at your option) any later version.                                   *   *   (at your option) any later version.                                   *
12   *                                                                         *   *                                                                         *
13   *   This program is distributed in the hope that it will be useful,       *   *   This library is distributed in the hope that it will be useful,       *
14   *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *   *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15   *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *   *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16   *   GNU General Public License for more details.                          *   *   GNU General Public License for more details.                          *
17   *                                                                         *   *                                                                         *
18   *   You should have received a copy of the GNU General Public License     *   *   You should have received a copy of the GNU General Public License     *
19   *   along with this program; if not, write to the Free Software           *   *   along with this library; if not, write to the Free Software           *
20   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
21   *   MA  02111-1307  USA                                                   *   *   MA  02111-1307  USA                                                   *
22   ***************************************************************************/   ***************************************************************************/
# Line 26  Line 27 
27  #include <unistd.h>  #include <unistd.h>
28  #include <sys/types.h>  #include <sys/types.h>
29  #include <sys/socket.h>  #include <sys/socket.h>
30    #include <sys/select.h>
31    #include <sys/time.h>
32  #include <netinet/in.h>  #include <netinet/in.h>
33  #include <netinet/tcp.h>  #include <netinet/tcp.h>
34  #include <arpa/inet.h>  #include <arpa/inet.h>
35  #include <netdb.h>  #include <netdb.h>
36    
37    #include <list>
38    
39  #include "lscp.h"  #include "lscp.h"
40  #include "lscpparser.h"  #include "lscpparser.h"
41    #include "lscp.h"
42    #include "lscpevent.h"
43  #include "../Sampler.h"  #include "../Sampler.h"
44  #include "../common/Thread.h"  #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.  /// TCP Port on which the server should listen for connection requests.
56    #define LSCP_ADDR INADDR_ANY
57  #define LSCP_PORT 8888  #define LSCP_PORT 8888
58    
59  using namespace LinuxSampler;  /// try up to 3 minutes to bind server socket
60    #define LSCP_SERVER_BIND_TIMEOUT 180
61    
62  /// Handle for a client connection (FIXME: doesn't work for more than one network connections of course, thus has to be included to the yyparse() parameters instead).  using namespace LinuxSampler;
 extern int hSession;  
63    
64  // External references to the main scanner and parser functions  // External references to the main scanner and parser functions
65  extern int yyparse(void* YYPARSE_PARAM);  extern int yyparse(void* YYPARSE_PARAM);
66  extern int yylex_init(yyscan_t* scanner);  extern void restart(yyparse_param_t* pparam, int& yychar);
 extern int yylex_destroy(yyscan_t yyscanner);  
67    
68  /**  /**
69   * Network server for the LinuxSampler Control Protocol (LSCP).   * Network server for the LinuxSampler Control Protocol (LSCP).
70   */   */
71  class LSCPServer : public Thread {  class LSCPServer : public Thread {
72      public:      public:
73          LSCPServer(Sampler* pSampler);          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          // Methods called by the parser
         String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters);  
78          String DestroyAudioOutputDevice(uint DeviceIndex);          String DestroyAudioOutputDevice(uint DeviceIndex);
79          String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel);          String DestroyMidiInputDevice(uint DeviceIndex);
80          String LoadEngine(String EngineName, uint uiSamplerChannel);          String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
81            String SetEngineType(String EngineName, uint uiSamplerChannel);
82          String GetChannels();          String GetChannels();
83            String ListChannels();
84          String AddChannel();          String AddChannel();
85          String RemoveChannel(uint uiSamplerChannel);          String RemoveChannel(uint uiSamplerChannel);
86          String GetAvailableEngines();          String GetAvailableEngines();
87            String ListAvailableEngines();
88          String GetEngineInfo(String EngineName);          String GetEngineInfo(String EngineName);
89          String GetChannelInfo(uint uiSamplerChannel);          String GetChannelInfo(uint uiSamplerChannel);
90          String GetVoiceCount(uint uiSamplerChannel);          String GetVoiceCount(uint uiSamplerChannel);
91          String GetStreamCount(uint uiSamplerChannel);          String GetStreamCount(uint uiSamplerChannel);
92          String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);          String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
93          String GetAvailableAudioOutputDrivers();          String GetAvailableAudioOutputDrivers();
94            String ListAvailableAudioOutputDrivers();
95            String GetAvailableMidiInputDrivers();
96            String ListAvailableMidiInputDrivers();
97          String GetAudioOutputDriverInfo(String Driver);          String GetAudioOutputDriverInfo(String Driver);
98            String GetMidiInputDriverInfo(String Driver);
99  #ifdef __GNUC__  #ifdef __GNUC__
100          typedef std::map<String,String> StringMap; // nasty workaround for a GCC bug (see GCC bug #15980, #57)          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());          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  #else
106          String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());          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__  #endif // __GNUC__
111          String GetAudioOutputDeviceCount();          String GetAudioOutputDeviceCount();
112            String GetMidiInputDeviceCount();
113          String GetAudioOutputDevices();          String GetAudioOutputDevices();
114            String GetMidiInputDevices();
115          String GetAudioOutputDeviceInfo(uint DeviceIndex);          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);          String GetAudioOutputChannelInfo(uint DeviceId, uint ChannelId);
120          String GetAudioOutputChannelParameterInfo(uint DeviceId, uint ChannelId, String ParameterName);          String GetAudioOutputChannelParameterInfo(uint DeviceId, uint ChannelId, String ParameterName);
121          String SetAudioOutputChannelParameter(uint DeviceId, uint ChannelId, String ParamKey, String ParamVal);          String SetAudioOutputChannelParameter(uint DeviceId, uint ChannelId, String ParamKey, String ParamVal);
122          String SetAudioOutputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);          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);          String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
         String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);  
         String SetMIDIInputPort(String MIDIInputPort, uint uiSamplerchannel);  
         String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);  
126          String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);          String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
127          String SetVolume(double Volume, uint uiSamplerChannel);          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 FormatInstrumentsDb();
184            String EditSamplerChannelInstrument(uint uiSamplerChannel);
185            String GetDbInstrumentsJobInfo(int JobId);
186          String ResetChannel(uint uiSamplerChannel);          String ResetChannel(uint uiSamplerChannel);
187          String SubscribeNotification(uint UDPPort);          String ResetSampler();
188          String UnsubscribeNotification(String SessionID);          String GetServerInfo();
189            String GetTotalVoiceCount();
190            String GetTotalVoiceCountMax();
191            String GetGlobalVolume();
192            String SetGlobalVolume(double dVolume);
193            String SubscribeNotification(LSCPEvent::event_t);
194            String UnsubscribeNotification(LSCPEvent::event_t);
195            String SetEcho(yyparse_param_t* pSession, double boolean_value);
196          void   AnswerClient(String ReturnMessage);          void   AnswerClient(String ReturnMessage);
197    
198            static int currentSocket;
199            static std::map<int,String> bufferedCommands;
200    
201            static void SendLSCPNotify( LSCPEvent Event );
202            static int EventSubscribers( std::list<LSCPEvent::event_t> events );
203            static void LockRTNotify( void ) { RTNotifyMutex.Lock(); }
204            static void UnlockRTNotify( void ) { RTNotifyMutex.Unlock(); }
205        static String FilterEndlines(String s);
206    
207      protected:      protected:
208          int            hSocket;          int            hSocket;
209          sockaddr_in    SocketAddress;          sockaddr_in    SocketAddress;
210          Sampler*       pSampler;          Sampler*       pSampler;
211            Condition      Initialized;
212    
213          int Main(); ///< Implementation of virtual method from class Thread          int Main(); ///< Implementation of virtual method from class Thread
214    
215      private:      private:
216    
217          /**          /**
218           * Converts a result_t structure into a valid LSCP answer message.           * Find a created audio output device index.
219           */           */
220          inline String ConvertResult(result_t result) {          int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
             switch (result.type) {  
                 case result_type_success: {  
                     return "OK\r\n";  
                 }  
                 case result_type_warning: {  
                     std::stringstream ss;  
                     ss << "WRN:" << result.code << ":" << result.message << "\r\n";  
                     return ss.str();  
                 }  
                 case result_type_error: {  
                     std::stringstream ss;  
                     ss << "ERR:" << result.code << ":" << result.message << "\r\n";  
                     return ss.str();  
                 }  
             }  
         }  
   
         template<class T> inline String ToString(T o) {  
             std::stringstream ss;  
             ss << o;  
             return ss.str();  
         }  
 };  
221    
222            /**
223             * Find a created midi input device index.
224             */
225            int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
226    
227  /**          EngineChannel* GetEngineChannel(uint uiSamplerChannel);
  * Instrument loader thread for the LinuxSampler Control Protocol (LSCP).  
  */  
 class LSCPLoadInstrument : public Thread {  
   
     public:  
         LSCPLoadInstrument(Engine* pEngine, String Filename, uint uiInstrument);  
   
     protected:  
         // Instance variables.  
         Engine* pEngine;  
         String  Filename;  
         uint    uiInstrument;  
228    
229          // Implementation of virtual method from class Thread.                  /**
230          int Main();                   * Gets the specified effect send on the specified sampler channel.
231                     */
232                    FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);
233    
234            bool HasSoloChannel();
235            void MuteNonSoloChannels();
236            void UnmuteChannels();
237    
238            static std::map<int,String> bufferedNotifies;
239            static Mutex NotifyMutex;
240            static Mutex NotifyBufferMutex;
241            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            static Mutex SubscriptionMutex;
245            static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
246            static fd_set fdSet;
247    
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    
253            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                    /**
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    
267                    /**
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    
273                    /**
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    
279                    /**
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    
286                    /**
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    
294                    /**
295                     * 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    
306                    /**
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    
314                    /**
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            } eventHandler;
344    
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                    virtual void JobStatusChanged(int JobId);
355            } dbInstrumentsEventHandler;
356    #endif // HAVE_SQLITE3
357  };  };
358    
359  #endif // __LSCPSERVER_H_  #endif // __LSCPSERVER_H_
Legend:
Removed from v.133  
changed lines
  Added in v.1353
  ViewVC Help
Powered by ViewVC