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 SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
        String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
        String SetMIDIInput(uint MIDIDevice, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
        String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
        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	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	35	* *
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	schoenebeck	53	#include "lscp.h"
35	schoenebeck	35	#include "lscpparser.h"
36	schoenebeck	53	#include "../Sampler.h"
37			#include "../common/Thread.h"
38	schoenebeck	35
39			/// TCP Port on which the server should listen for connection requests.
40			#define LSCP_PORT 8888
41
42	schoenebeck	53	using namespace LinuxSampler;
43
44	schoenebeck	35	/// 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	schoenebeck	53	LSCPServer(Sampler* pSampler);
58	schoenebeck	35
59			// Methods called by the parser
60	schoenebeck	123	String DestroyAudioOutputDevice(uint DeviceIndex);
61	senkov	155	String DestroyMidiInputDevice(uint DeviceIndex);
62	capela	137	String LoadInstrument(String Filename, uint uiInstrument, uint uiSamplerChannel, bool bBackground = false);
63	schoenebeck	53	String LoadEngine(String EngineName, uint uiSamplerChannel);
64	schoenebeck	35	String GetChannels();
65			String AddChannel();
66	schoenebeck	53	String RemoveChannel(uint uiSamplerChannel);
67	schoenebeck	35	String GetAvailableEngines();
68			String GetEngineInfo(String EngineName);
69	schoenebeck	53	String GetChannelInfo(uint uiSamplerChannel);
70			String GetVoiceCount(uint uiSamplerChannel);
71			String GetStreamCount(uint uiSamplerChannel);
72			String GetBufferFill(fill_response_t ResponseType, uint uiSamplerChannel);
73	schoenebeck	123	String GetAvailableAudioOutputDrivers();
74	senkov	155	String GetAvailableMidiInputDrivers();
75	schoenebeck	123	String GetAudioOutputDriverInfo(String Driver);
76	senkov	155	String GetMidiInputDriverInfo(String Driver);
77	schoenebeck	123	#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	senkov	155	String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = StringMap());
81	senkov	140	String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = StringMap());
82	senkov	155	String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = StringMap());
83	schoenebeck	123	#else
84			String GetAudioOutputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
85	senkov	155	String GetMidiInputDriverParameterInfo(String Driver, String Parameter, std::map<String,String> DependencyList = std::map<String,String>());
86	senkov	140	String CreateAudioOutputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
87	senkov	155	String CreateMidiInputDevice(String Driver, std::map<String,String> Parameters = std::map<String,String>());
88	schoenebeck	123	#endif // __GNUC__
89			String GetAudioOutputDeviceCount();
90	senkov	155	String GetMidiInputDeviceCount();
91	schoenebeck	123	String GetAudioOutputDevices();
92	senkov	155	String GetMidiInputDevices();
93	schoenebeck	123	String GetAudioOutputDeviceInfo(uint DeviceIndex);
94	senkov	155	String GetMidiInputDeviceInfo(uint DeviceIndex);
95			String GetMidiInputPortInfo(uint DeviceIndex, uint PortIndex);
96	schoenebeck	123	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	senkov	155	String SetMidiInputDeviceParameter(uint DeviceIndex, String ParamKey, String ParamVal);
101			String SetMidiInputPortParameter(uint DeviceIndex, uint PortIndex, String ParamKey, String ParamVal);
102	schoenebeck	123	String SetAudioOutputChannel(uint ChannelAudioOutputChannel, uint AudioOutputDeviceInputChannel, uint uiSamplerChannel);
103	capela	143	String SetAudioOutputType(String AudioOutputDriver, uint uiSamplerChannel);
104	schoenebeck	123	String SetMIDIInputType(String MidiInputDriver, uint uiSamplerChannel);
105	senkov	155	String SetMIDIInput(uint MIDIDevice, uint MIDIPort, uint MIDIChannel, uint uiSamplerChannel);
106	schoenebeck	123	String SetAudioOutputDevice(uint AudioDeviceId, uint SamplerChannel);
107	schoenebeck	53	String SetVolume(double Volume, uint uiSamplerChannel);
108			String ResetChannel(uint uiSamplerChannel);
109	senkov	135	String SubscribeNotification(event_t Event);
110			String UnsubscribeNotification(event_t Event);
111	schoenebeck	35	void AnswerClient(String ReturnMessage);
112			protected:
113	schoenebeck	53	int hSocket;
114			sockaddr_in SocketAddress;
115			Sampler* pSampler;
116	schoenebeck	35
117			int Main(); ///< Implementation of virtual method from class Thread
118			private:
119	capela	143
120	schoenebeck	35	/**
121	capela	143	* Find a created audio output device index.
122			*/
123			int GetAudioOutputDeviceIndex (AudioOutputDevice *pDevice);
124	senkov	155
125			/**
126			* Find a created midi input device index.
127			*/
128			int GetMidiInputDeviceIndex (MidiInputDevice *pDevice);
129	capela	143
130			/**
131	schoenebeck	35	* Converts a result_t structure into a valid LSCP answer message.
132			*/
133			inline String ConvertResult(result_t result) {
134			switch (result.type) {
135			case result_type_success: {
136			return "OK\r\n";
137			}
138			case result_type_warning: {
139			std::stringstream ss;
140			ss << "WRN:" << result.code << ":" << result.message << "\r\n";
141			return ss.str();
142			}
143			case result_type_error: {
144			std::stringstream ss;
145			ss << "ERR:" << result.code << ":" << result.message << "\r\n";
146			return ss.str();
147			}
148			}
149			}
150
151	schoenebeck	53	template<class T> inline String ToString(T o) {
152	schoenebeck	35	std::stringstream ss;
153	schoenebeck	53	ss << o;
154	schoenebeck	35	return ss.str();
155			}
156			};
157
158	capela	133
159			/**
160			* Instrument loader thread for the LinuxSampler Control Protocol (LSCP).
161			*/
162			class LSCPLoadInstrument : public Thread {
163
164			public:
165			LSCPLoadInstrument(Engine* pEngine, String Filename, uint uiInstrument);
166
167			protected:
168			// Instance variables.
169			Engine* pEngine;
170			String Filename;
171			uint uiInstrument;
172
173			// Implementation of virtual method from class Thread.
174			int Main();
175			};
176
177	schoenebeck	35	#endif // __LSCPSERVER_H_