src/network/lscpserver.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *                                                                         *
 *   This program 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 program 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 program; 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 <netinet/in.h>
#include <netinet/tcp.h>
#include <arpa/inet.h>
#include <netdb.h>

#include "lscp.h"
#include "lscpparser.h"
#include "../Sampler.h"
#include "../common/Thread.h"

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

using namespace LinuxSampler;

/// 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).
extern int hSession;

// External references to the main scanner and parser functions
extern int yyparse(void* YYPARSE_PARAM);
extern int yylex_init(yyscan_t* scanner);
extern int yylex_destroy(yyscan_t yyscanner);

/**
 * Network server for the LinuxSampler Control Protocol (LSCP).
 */
class LSCPServer : public Thread {
    public:
        LSCPServer(Sampler* pSampler);

        // 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 LoadEngine(String EngineName, uint uiSamplerChannel);
        String GetChannels();
        String AddChannel();
        String RemoveChannel(uint uiSamplerChannel);
        String GetAvailableEngines();
        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 GetAvailableMidiInputDrivers();
        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 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 Volume, uint uiSamplerChannel);
        String ResetChannel(uint uiSamplerChannel);
        String SubscribeNotification(event_t Event);
        String UnsubscribeNotification(event_t Event);
        void   AnswerClient(String ReturnMessage);
    protected:
        int            hSocket;
        sockaddr_in    SocketAddress;
        Sampler*       pSampler;

        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);

        /**
         * Converts a result_t structure into a valid LSCP answer message.
         */
        inline String ConvertResult(result_t result) {
            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();
        }
};


/**
 * 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;

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

#endif // __LSCPSERVER_H_
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	* *
7	* This program is free software; you can redistribute it and/or modify *
8	* it under the terms of the GNU General Public License as published by *
9	* the Free Software Foundation; either version 2 of the License, or *
10	* (at your option) any later version. *
11	* *
12	* This program is distributed in the hope that it will be useful, *
13	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15	* GNU General Public License for more details. *
16	* *
17	* You should have received a copy of the GNU General Public License *
18	* along with this program; if not, write to the Free Software *
19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
20	* MA 02111-1307 USA *
21	***************************************************************************/
22
23	#ifndef __LSCPSERVER_H_
24	#define __LSCPSERVER_H_
25
26	#include <unistd.h>
27	#include <sys/types.h>
28	#include <sys/socket.h>
29	#include <netinet/in.h>
30	#include <netinet/tcp.h>
31	#include <arpa/inet.h>
32	#include <netdb.h>
33
34	#include "lscp.h"
35	#include "lscpparser.h"
36	#include "../Sampler.h"
37	#include "../common/Thread.h"
38
39	/// TCP Port on which the server should listen for connection requests.
40	#define LSCP_PORT 8888
41
42	using namespace LinuxSampler;
43
44	/// 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).
45	extern int hSession;
46
47	// External references to the main scanner and parser functions
48	extern int yyparse(void* YYPARSE_PARAM);
49	extern int yylex_init(yyscan_t* scanner);
50	extern int yylex_destroy(yyscan_t yyscanner);
51
52	/**
53	* Network server for the LinuxSampler Control Protocol (LSCP).
54	*/
55	class LSCPServer : public Thread {
56	public:
57	LSCPServer(Sampler* pSampler);
58
59	// Methods called by the parser
60	String DestroyAudioOutputDevice(uint DeviceIndex);
61	String DestroyMidiInputDevice(uint DeviceIndex);
62	String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
63	String LoadEngine(String EngineName, uint uiSamplerChannel);
64	String GetChannels();
65	String AddChannel();
66	String RemoveChannel(uint uiSamplerChannel);
67	String GetAvailableEngines();
68	String GetEngineInfo(String EngineName);
69	String GetChannelInfo(uint uiSamplerChannel);
70	String GetVoiceCount(uint uiSamplerChannel);
71	String GetStreamCount(uint uiSamplerChannel);
72	String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
73	String GetAvailableAudioOutputDrivers();
74	String GetAvailableMidiInputDrivers();
75	String GetAudioOutputDriverInfo(String Driver);
76	String GetMidiInputDriverInfo(String Driver);
77	#ifdef __GNUC__
78	typedef std::map<String,String> StringMap; // nasty workaround for a GCC bug (see GCC bug #15980, #57)
79	String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
80	String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
81	String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
82	String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
83	#else
84	String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
85	String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
86	String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
87	String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
88	#endif // __GNUC__
89	String GetAudioOutputDeviceCount();
90	String GetMidiInputDeviceCount();
91	String GetAudioOutputDevices();
92	String GetMidiInputDevices();
93	String GetAudioOutputDeviceInfo(uint DeviceIndex);
94	String GetMidiInputDeviceInfo(uint DeviceIndex);
95	String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
96	String GetAudioOutputChannelInfo(uint DeviceId, uint ChannelId);
97	String GetAudioOutputChannelParameterInfo(uint DeviceId, uint ChannelId, String ParameterName);
98	String SetAudioOutputChannelParameter(uint DeviceId, uint ChannelId, String ParamKey, String ParamVal);
99	String SetAudioOutputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
100	String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
101	String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
102	String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
103	String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
104	String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
105	String SetMIDIInputPort(uint MIDIPort, uint uiSamplerChannel);
106	String SetMIDIInputChannel(uint MIDIChannel, uint uiSamplerChannel);
107	String SetMIDIInputDevice(uint MIDIDeviceId, uint uiSamplerChannel);
108	String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
109	String SetMIDIInput(uint MIDIDeviceId, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
110	String SetVolume(double Volume, uint uiSamplerChannel);
111	String ResetChannel(uint uiSamplerChannel);
112	String SubscribeNotification(event_t Event);
113	String UnsubscribeNotification(event_t Event);
114	void AnswerClient(String ReturnMessage);
115	protected:
116	int hSocket;
117	sockaddr_in SocketAddress;
118	Sampler* pSampler;
119
120	int Main(); ///< Implementation of virtual method from class Thread
121	private:
122
123	/**
124	* Find a created audio output device index.
125	*/
126	int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
127
128	/**
129	* Find a created midi input device index.
130	*/
131	int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
132
133	/**
134	* Converts a result_t structure into a valid LSCP answer message.
135	*/
136	inline String ConvertResult(result_t result) {
137	switch (result.type) {
138	case result_type_success: {
139	return "OK\r\n";
140	}
141	case result_type_warning: {
142	std::stringstream ss;
143	ss << "WRN:" << result.code << ":" << result.message << "\r\n";
144	return ss.str();
145	}
146	case result_type_error: {
147	std::stringstream ss;
148	ss << "ERR:" << result.code << ":" << result.message << "\r\n";
149	return ss.str();
150	}
151	}
152	}
153
154	template<class T> inline String ToString(T o) {
155	std::stringstream ss;
156	ss << o;
157	return ss.str();
158	}
159	};
160
161
162	/**
163	* Instrument loader thread for the LinuxSampler Control Protocol (LSCP).
164	*/
165	class LSCPLoadInstrument : public Thread {
166
167	public:
168	LSCPLoadInstrument(Engine* pEngine, String Filename, uint uiInstrument);
169
170	protected:
171	// Instance variables.
172	Engine* pEngine;
173	String Filename;
174	uint uiInstrument;
175
176	// Implementation of virtual method from class Thread.
177	int Main();
178	};
179
180	#endif // __LSCPSERVER_H_