src/network/lscpserver.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2007 Christian Schoenebeck                       *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __LSCPSERVER_H_
#define __LSCPSERVER_H_

#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/select.h>
#include <sys/time.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <arpa/inet.h>
#include <netdb.h>

#include <list>

#include "lscp.h"
#include "lscpparser.h"
#include "lscp.h"
#include "lscpevent.h"
#include "../Sampler.h"
#include "../common/Thread.h"
#include "../common/Mutex.h"
#include "../common/Condition.h"
#include "../common/global.h"

#include "../drivers/midi/MidiInstrumentMapper.h"

#if HAVE_SQLITE3
#include "../db/InstrumentsDb.h"
#endif

/// TCP Port on which the server should listen for connection requests.
#define LSCP_ADDR INADDR_ANY
#define LSCP_PORT 8888

/// try up to 3 minutes to bind server socket
#define LSCP_SERVER_BIND_TIMEOUT 180

using namespace LinuxSampler;

// External references to the main scanner and parser functions
extern int yyparse(void* YYPARSE_PARAM);
extern void restart(yyparse_param_t* pparam, int& yychar);

/**
 * Network server for the LinuxSampler Control Protocol (LSCP).
 */
class LSCPServer : public Thread {
    public:
        LSCPServer(Sampler* pSampler, long int addr, short int port);
        virtual ~LSCPServer();
        int WaitUntilInitialized(long TimeoutSeconds = 0L, long TimeoutNanoSeconds = 0L);

        // Methods called by the parser
        String DestroyAudioOutputDevice(uint DeviceIndex);
        String DestroyMidiInputDevice(uint DeviceIndex);
        String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
        String SetEngineType(String EngineName, uint uiSamplerChannel);
        String GetChannels();
        String ListChannels();
        String AddChannel();
        String RemoveChannel(uint uiSamplerChannel);
        String GetAvailableEngines();
        String ListAvailableEngines();
        String GetEngineInfo(String EngineName);
        String GetChannelInfo(uint uiSamplerChannel);
        String GetVoiceCount(uint uiSamplerChannel);
        String GetStreamCount(uint uiSamplerChannel);
        String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
        String GetAvailableAudioOutputDrivers();
        String ListAvailableAudioOutputDrivers();
        String GetAvailableMidiInputDrivers();
        String ListAvailableMidiInputDrivers();
        String GetAudioOutputDriverInfo(String Driver);
        String GetMidiInputDriverInfo(String Driver);
#ifdef __GNUC__
        typedef std::map<String,String> StringMap; // nasty workaround for a GCC bug (see GCC bug #15980, #57)
        String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
        String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
        String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
        String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
#else
        String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
        String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
        String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
        String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
#endif // __GNUC__
        String GetAudioOutputDeviceCount();
        String GetMidiInputDeviceCount();
        String GetAudioOutputDevices();
        String GetMidiInputDevices();
        String GetAudioOutputDeviceInfo(uint DeviceIndex);
        String GetMidiInputDeviceInfo(uint DeviceIndex);
        String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
        String GetMidiInputPortParameterInfo(uint DeviceId, uint PortId, String ParameterName);
        String GetAudioOutputChannelInfo(uint DeviceId, uint ChannelId);
        String GetAudioOutputChannelParameterInfo(uint DeviceId, uint ChannelId, String ParameterName);
        String SetAudioOutputChannelParameter(uint DeviceId, uint ChannelId, String ParamKey, String ParamVal);
        String SetAudioOutputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
        String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
        String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
        String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
        String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
        String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
        String SetMIDIInputPort(uint MIDIPort, uint uiSamplerChannel);
        String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);
        String SetMIDIInputDevice(uint MIDIDeviceId, uint uiSamplerChannel);
        String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
        String SetMIDIInput(uint MIDIDeviceId, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
        String SetVolume(double dVolume, uint uiSamplerChannel);
        String SetChannelMute(bool bMute, uint uiSamplerChannel);
        String SetChannelSolo(bool bSolo, uint uiSamplerChannel);
        String AddOrReplaceMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg, String EngineType, String InstrumentFile, uint InstrumentIndex, float Volume, MidiInstrumentMapper::mode_t LoadMode, String Name, bool bModal);
        String RemoveMIDIInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
        String GetMidiInstrumentMappings(uint MidiMapID);
        String GetAllMidiInstrumentMappings();
        String GetMidiInstrumentMapping(uint MidiMapID, uint MidiBank, uint MidiProg);
        String ListMidiInstrumentMappings(uint MidiMapID);
        String ListAllMidiInstrumentMappings();
        String ClearMidiInstrumentMappings(uint MidiMapID);
        String ClearAllMidiInstrumentMappings();
        String AddMidiInstrumentMap(String MapName = "");
        String RemoveMidiInstrumentMap(uint MidiMapID);
        String RemoveAllMidiInstrumentMaps();
        String GetMidiInstrumentMaps();
        String ListMidiInstrumentMaps();
        String GetMidiInstrumentMap(uint MidiMapID);
        String SetMidiInstrumentMapName(uint MidiMapID, String NewName);
        String SetChannelMap(uint uiSamplerChannel, int MidiMapID);
        String CreateFxSend(uint uiSamplerChannel, uint MidiCtrl, String Name = "");
        String DestroyFxSend(uint uiSamplerChannel, uint FxSendID);
        String GetFxSends(uint uiSamplerChannel);
        String ListFxSends(uint uiSamplerChannel);
        String GetFxSendInfo(uint uiSamplerChannel, uint FxSendID);
        String SetFxSendName(uint uiSamplerChannel, uint FxSendID, String Name);
        String SetFxSendAudioOutputChannel(uint uiSamplerChannel, uint FxSendID, uint FxSendChannel, uint DeviceChannel);
        String SetFxSendMidiController(uint uiSamplerChannel, uint FxSendID, uint MidiController);
        String SetFxSendLevel(uint uiSamplerChannel, uint FxSendID, double dLevel);
        String AddDbInstrumentDirectory(String Dir);
        String RemoveDbInstrumentDirectory(String Dir, bool Force = false);
        String GetDbInstrumentDirectoryCount(String Dir);
        String GetDbInstrumentDirectories(String Dir);
        String GetDbInstrumentDirectoryInfo(String Dir);
        String SetDbInstrumentDirectoryName(String Dir, String Name);
        String MoveDbInstrumentDirectory(String Dir, String Dst);
        String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
        String AddDbInstruments(String DbDir, String FilePath, int Index = -1);
        String AddDbInstrumentsFlat(String DbDir, String FilePath);
        String AddDbInstrumentsNonrecursive(String DbDir, String FsDir);
        String RemoveDbInstrument(String Instr);
        String GetDbInstrumentCount(String Dir);
        String GetDbInstruments(String Dir);
        String GetDbInstrumentInfo(String Instr);
        String SetDbInstrumentName(String Instr, String Name);
        String MoveDbInstrument(String Instr, String Dst);
        String SetDbInstrumentDescription(String Instr, String Desc);
        String ResetChannel(uint uiSamplerChannel);
        String ResetSampler();
        String GetServerInfo();
        String GetTotalVoiceCount();
        String GetTotalVoiceCountMax();
        String GetGlobalVolume();
        String SetGlobalVolume(double dVolume);
        String SubscribeNotification(LSCPEvent::event_t);
        String UnsubscribeNotification(LSCPEvent::event_t);
        String SetEcho(yyparse_param_t* pSession, double boolean_value);
        void   AnswerClient(String ReturnMessage);

        static int currentSocket;
        static std::map<int,String> bufferedCommands;

        static void SendLSCPNotify( LSCPEvent Event );
        static int EventSubscribers( std::list<LSCPEvent::event_t> events );
        static void LockRTNotify( void ) { RTNotifyMutex.Lock(); }
        static void UnlockRTNotify( void ) { RTNotifyMutex.Unlock(); }
    static String FilterEndlines(String s);

    protected:
        int            hSocket;
        sockaddr_in    SocketAddress;
        Sampler*       pSampler;
        Condition      Initialized;

        int Main(); ///< Implementation of virtual method from class Thread

    private:

        /**
         * Find a created audio output device index.
         */
        int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);

        /**
         * Find a created midi input device index.
         */
        int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);

        EngineChannel* GetEngineChannel(uint uiSamplerChannel);

                /**
                 * Gets the specified effect send on the specified sampler channel.
                 */
                FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);

        bool HasSoloChannel();
        void MuteNonSoloChannels();
        void UnmuteChannels();

        static std::map<int,String> bufferedNotifies;
        static Mutex NotifyMutex;
        static Mutex NotifyBufferMutex;
        static bool GetLSCPCommand( std::vector<yyparse_param_t>::iterator iter );
        static void CloseConnection( std::vector<yyparse_param_t>::iterator iter );
        static std::vector<yyparse_param_t> Sessions;
        static Mutex SubscriptionMutex;
        static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
        static fd_set fdSet;

        //Protect main thread that generates real time notify messages
        //like voice count, stream count and buffer fill
        //from LSCP server removing engines and channels from underneath
        static Mutex RTNotifyMutex;

        class EventHandler : public ChannelCountListener, public AudioDeviceCountListener,
            public MidiDeviceCountListener, public MidiInstrumentCountListener,
            public MidiInstrumentInfoListener, public MidiInstrumentMapCountListener,
            public MidiInstrumentMapInfoListener, public FxSendCountListener,
            public VoiceCountListener, public StreamCountListener,
            public BufferFillListener, public TotalVoiceCountListener {

            public:
                /**
                 * Invoked when the number of sampler channels has changed.
                 * @param NewCount The new number of sampler channels.
                 */
                virtual void ChannelCountChanged(int NewCount);
        
                /**
                 * Invoked when the number of audio output devices has changed.
                 * @param NewCount The new number of audio output devices.
                 */
                virtual void AudioDeviceCountChanged(int NewCount);
 
                /**
                 * Invoked when the number of MIDI input devices has changed.
                 * @param NewCount The new number of MIDI input devices.
                 */
                virtual void MidiDeviceCountChanged(int NewCount);

                /**
                 * Invoked when the number of MIDI instruments has changed.
                 * @param MapId The numerical ID of the MIDI instrument map.
                 * @param NewCount The new number of MIDI instruments.
                 */
                virtual void MidiInstrumentCountChanged(int MapId, int NewCount);
 
                /**
                 * Invoked when a MIDI instrument in a MIDI instrument map is changed.
                 * @param MapId The numerical ID of the MIDI instrument map.
                 * @param Bank The index of the MIDI bank, containing the instrument.
                 * @param Program The MIDI program number of the instrument.
                 */
                virtual void MidiInstrumentInfoChanged(int MapId, int Bank, int Program);
     
                /**
                 * Invoked when the number of MIDI instrument maps has changed.
                 * @param NewCount The new number of MIDI instruments.
                 */
                virtual void MidiInstrumentMapCountChanged(int NewCount);

                /**
                 * Invoked when the settings of a MIDI instrument map are changed.
                 * @param MapId The numerical ID of the MIDI instrument map.
                 */
                virtual void MidiInstrumentMapInfoChanged(int MapId);
      
                /**
                 * Invoked when the number of effect sends
                 * on the specified sampler channel has changed.
                 * @param ChannelId The numerical ID of the sampler channel.
                 * @param NewCount The new number of effect sends.
                 */
                virtual void FxSendCountChanged(int ChannelId, int NewCount);

                /**
                 * Invoked when the number of active voices
                 * on the specified sampler channel has changed.
                 * @param ChannelId The numerical ID of the sampler channel.
                 * @param NewCount The new number of active voices.
                 */
                virtual void VoiceCountChanged(int ChannelId, int NewCount);

                /**
                 * Invoked when the number of active disk streams
                 * on the specified sampler channel has changed.
                 * @param ChannelId The numerical ID of the sampler channel.
                 * @param NewCount The new number of active disk streams.
                 */
                virtual void StreamCountChanged(int ChannelId, int NewCount);

                /**
                 * Invoked when the fill state of the disk stream
                 * buffers on the specified sampler channel is changed.
                 * @param ChannelId The numerical ID of the sampler channel.
                 * @param FillData The buffer fill data for the specified sampler channel.
                 */
                virtual void BufferFillChanged(int ChannelId, String FillData);

                /**
                 * Invoked when the total number of active voices is changed.
                 * @param NewCount The new number of active voices.
                 */
                virtual void TotalVoiceCountChanged(int NewCount);
        } eventHandler;

#if HAVE_SQLITE3
        class DbInstrumentsEventHandler : public InstrumentsDb::Listener {
            public:

                /**
                 * Invoked when the number of instrument directories
                 * in a specific directory has changed.
                 * @param Dir The absolute pathname of the directory in
                 * which the number of directories is changed.
                 */
                virtual void DirectoryCountChanged(String Dir);

                /**
                 * Invoked when the settings of an instrument directory
                 * are changed.
                 * @param Dir The absolute pathname of the directory
                 * whose settings are changed.
                 */
                virtual void DirectoryInfoChanged(String Dir);

                /**
                 * Invoked when an instrument directory is renamed.
                 * @param Dir The old absolute pathname of the directory.
                 * @param NewName The new name of the directory.
                 */
                virtual void DirectoryNameChanged(String Dir, String NewName);

                /**
                 * Invoked when the number of instruments
                 * in a specific directory has changed.
                 * @param Dir The absolute pathname of the directory in
                 * which the number of instruments is changed.
                 */
                virtual void InstrumentCountChanged(String Dir);

                /**
                 * Invoked when the settings of an instrument are changed.
                 * @param Instr The absolute pathname of the instrument
                 * whose settings are changed.
                 */
                virtual void InstrumentInfoChanged(String Instr);

                /**
                 * Invoked when an instrument is renamed.
                 * @param Instr The old absolute pathname of the instrument.
                 * @param NewName The new name of the directory.
                 */
                virtual void InstrumentNameChanged(String Instr, String NewName);
        } dbInstrumentsEventHandler;
#endif // HAVE_SQLITE3
};

#endif // __LSCPSERVER_H_
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);
165	String GetDbInstrumentDirectories(String Dir);
166	String GetDbInstrumentDirectoryInfo(String Dir);
167	String SetDbInstrumentDirectoryName(String Dir, String Name);
168	String MoveDbInstrumentDirectory(String Dir, String Dst);
169	String SetDbInstrumentDirectoryDescription(String Dir, String Desc);
170	String AddDbInstruments(String DbDir, String FilePath, int Index = -1);
171	String AddDbInstrumentsFlat(String DbDir, String FilePath);
172	String AddDbInstrumentsNonrecursive(String DbDir, String FsDir);
173	String RemoveDbInstrument(String Instr);
174	String GetDbInstrumentCount(String Dir);
175	String GetDbInstruments(String Dir);
176	String GetDbInstrumentInfo(String Instr);
177	String SetDbInstrumentName(String Instr, String Name);
178	String MoveDbInstrument(String Instr, String Dst);
179	String SetDbInstrumentDescription(String Instr, String Desc);
180	String ResetChannel(uint uiSamplerChannel);
181	String ResetSampler();
182	String GetServerInfo();
183	String GetTotalVoiceCount();
184	String GetTotalVoiceCountMax();
185	String GetGlobalVolume();
186	String SetGlobalVolume(double dVolume);
187	String SubscribeNotification(LSCPEvent::event_t);
188	String UnsubscribeNotification(LSCPEvent::event_t);
189	String SetEcho(yyparse_param_t* pSession, double boolean_value);
190	void AnswerClient(String ReturnMessage);
191
192	static int currentSocket;
193	static std::map<int,String> bufferedCommands;
194
195	static void SendLSCPNotify( LSCPEvent Event );
196	static int EventSubscribers( std::list<LSCPEvent::event_t> events );
197	static void LockRTNotify( void ) { RTNotifyMutex.Lock(); }
198	static void UnlockRTNotify( void ) { RTNotifyMutex.Unlock(); }
199	static String FilterEndlines(String s);
200
201	protected:
202	int hSocket;
203	sockaddr_in SocketAddress;
204	Sampler* pSampler;
205	Condition Initialized;
206
207	int Main(); ///< Implementation of virtual method from class Thread
208
209	private:
210
211	/**
212	* Find a created audio output device index.
213	*/
214	int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
215
216	/**
217	* Find a created midi input device index.
218	*/
219	int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
220
221	EngineChannel* GetEngineChannel(uint uiSamplerChannel);
222
223	/**
224	* Gets the specified effect send on the specified sampler channel.
225	*/
226	FxSend* GetFxSend(uint uiSamplerChannel, uint FxSendID);
227
228	bool HasSoloChannel();
229	void MuteNonSoloChannels();
230	void UnmuteChannels();
231
232	static std::map<int,String> bufferedNotifies;
233	static Mutex NotifyMutex;
234	static Mutex NotifyBufferMutex;
235	static bool GetLSCPCommand( std::vector<yyparse_param_t>::iterator iter );
236	static void CloseConnection( std::vector<yyparse_param_t>::iterator iter );
237	static std::vector<yyparse_param_t> Sessions;
238	static Mutex SubscriptionMutex;
239	static std::map< LSCPEvent::event_t, std::list<int> > eventSubscriptions;
240	static fd_set fdSet;
241
242	//Protect main thread that generates real time notify messages
243	//like voice count, stream count and buffer fill
244	//from LSCP server removing engines and channels from underneath
245	static Mutex RTNotifyMutex;
246
247	class EventHandler : public ChannelCountListener, public AudioDeviceCountListener,
248	public MidiDeviceCountListener, public MidiInstrumentCountListener,
249	public MidiInstrumentInfoListener, public MidiInstrumentMapCountListener,
250	public MidiInstrumentMapInfoListener, public FxSendCountListener,
251	public VoiceCountListener, public StreamCountListener,
252	public BufferFillListener, public TotalVoiceCountListener {
253
254	public:
255	/**
256	* Invoked when the number of sampler channels has changed.
257	* @param NewCount The new number of sampler channels.
258	*/
259	virtual void ChannelCountChanged(int NewCount);
260
261	/**
262	* Invoked when the number of audio output devices has changed.
263	* @param NewCount The new number of audio output devices.
264	*/
265	virtual void AudioDeviceCountChanged(int NewCount);
266
267	/**
268	* Invoked when the number of MIDI input devices has changed.
269	* @param NewCount The new number of MIDI input devices.
270	*/
271	virtual void MidiDeviceCountChanged(int NewCount);
272
273	/**
274	* Invoked when the number of MIDI instruments has changed.
275	* @param MapId The numerical ID of the MIDI instrument map.
276	* @param NewCount The new number of MIDI instruments.
277	*/
278	virtual void MidiInstrumentCountChanged(int MapId, int NewCount);
279
280	/**
281	* Invoked when a MIDI instrument in a MIDI instrument map is changed.
282	* @param MapId The numerical ID of the MIDI instrument map.
283	* @param Bank The index of the MIDI bank, containing the instrument.
284	* @param Program The MIDI program number of the instrument.
285	*/
286	virtual void MidiInstrumentInfoChanged(int MapId, int Bank, int Program);
287
288	/**
289	* Invoked when the number of MIDI instrument maps has changed.
290	* @param NewCount The new number of MIDI instruments.
291	*/
292	virtual void MidiInstrumentMapCountChanged(int NewCount);
293
294	/**
295	* Invoked when the settings of a MIDI instrument map are changed.
296	* @param MapId The numerical ID of the MIDI instrument map.
297	*/
298	virtual void MidiInstrumentMapInfoChanged(int MapId);
299
300	/**
301	* Invoked when the number of effect sends
302	* on the specified sampler channel has changed.
303	* @param ChannelId The numerical ID of the sampler channel.
304	* @param NewCount The new number of effect sends.
305	*/
306	virtual void FxSendCountChanged(int ChannelId, int NewCount);
307
308	/**
309	* Invoked when the number of active voices
310	* on the specified sampler channel has changed.
311	* @param ChannelId The numerical ID of the sampler channel.
312	* @param NewCount The new number of active voices.
313	*/
314	virtual void VoiceCountChanged(int ChannelId, int NewCount);
315
316	/**
317	* Invoked when the number of active disk streams
318	* on the specified sampler channel has changed.
319	* @param ChannelId The numerical ID of the sampler channel.
320	* @param NewCount The new number of active disk streams.
321	*/
322	virtual void StreamCountChanged(int ChannelId, int NewCount);
323
324	/**
325	* Invoked when the fill state of the disk stream
326	* buffers on the specified sampler channel is changed.
327	* @param ChannelId The numerical ID of the sampler channel.
328	* @param FillData The buffer fill data for the specified sampler channel.
329	*/
330	virtual void BufferFillChanged(int ChannelId, String FillData);
331
332	/**
333	* Invoked when the total number of active voices is changed.
334	* @param NewCount The new number of active voices.
335	*/
336	virtual void TotalVoiceCountChanged(int NewCount);
337	} eventHandler;
338
339	#if HAVE_SQLITE3
340	class DbInstrumentsEventHandler : public InstrumentsDb::Listener {
341	public:
342
343	/**
344	* Invoked when the number of instrument directories
345	* in a specific directory has changed.
346	* @param Dir The absolute pathname of the directory in
347	* which the number of directories is changed.
348	*/
349	virtual void DirectoryCountChanged(String Dir);
350
351	/**
352	* Invoked when the settings of an instrument directory
353	* are changed.
354	* @param Dir The absolute pathname of the directory
355	* whose settings are changed.
356	*/
357	virtual void DirectoryInfoChanged(String Dir);
358
359	/**
360	* Invoked when an instrument directory is renamed.
361	* @param Dir The old absolute pathname of the directory.
362	* @param NewName The new name of the directory.
363	*/
364	virtual void DirectoryNameChanged(String Dir, String NewName);
365
366	/**
367	* Invoked when the number of instruments
368	* in a specific directory has changed.
369	* @param Dir The absolute pathname of the directory in
370	* which the number of instruments is changed.
371	*/
372	virtual void InstrumentCountChanged(String Dir);
373
374	/**
375	* Invoked when the settings of an instrument are changed.
376	* @param Instr The absolute pathname of the instrument
377	* whose settings are changed.
378	*/
379	virtual void InstrumentInfoChanged(String Instr);
380
381	/**
382	* Invoked when an instrument is renamed.
383	* @param Instr The old absolute pathname of the instrument.
384	* @param NewName The new name of the directory.
385	*/
386	virtual void InstrumentNameChanged(String Instr, String NewName);
387	} dbInstrumentsEventHandler;
388	#endif // HAVE_SQLITE3
389	};
390
391	#endif // __LSCPSERVER_H_