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