--- linuxsampler/trunk/src/network/lscpserver.cpp 2007/05/16 14:22:26 1187 +++ linuxsampler/trunk/src/network/lscpserver.cpp 2008/02/14 14:58:50 1686 @@ -3,7 +3,7 @@ * LinuxSampler - modular, streaming capable sampler * * * * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * - * Copyright (C) 2005 - 2007 Christian Schoenebeck * + * Copyright (C) 2005 - 2008 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 * @@ -25,7 +25,11 @@ #include "lscpresultset.h" #include "lscpevent.h" +#if defined(WIN32) +#include +#else #include +#endif #if ! HAVE_SQLITE3 #define DOESNT_HAVE_SQLITE3 "No database support. SQLITE3 was not installed when linuxsampler was built." @@ -36,6 +40,42 @@ #include "../drivers/audio/AudioOutputDeviceFactory.h" #include "../drivers/midi/MidiInputDeviceFactory.h" + +/** + * Returns a copy of the given string where all special characters are + * replaced by LSCP escape sequences ("\xHH"). This function shall be used + * to escape LSCP response fields in case the respective response field is + * actually defined as using escape sequences in the LSCP specs. + * + * @e Caution: DO NOT use this function for escaping path based responses, + * use the Path class (src/common/Path.h) for this instead! + */ +static String _escapeLscpResponse(String txt) { + for (int i = 0; i < txt.length(); i++) { + const char c = txt.c_str()[i]; + if ( + !(c >= '0' && c <= '9') && + !(c >= 'a' && c <= 'z') && + !(c >= 'A' && c <= 'Z') && + !(c == ' ') && !(c == '!') && !(c == '#') && !(c == '$') && + !(c == '%') && !(c == '&') && !(c == '(') && !(c == ')') && + !(c == '*') && !(c == '+') && !(c == ',') && !(c == '-') && + !(c == '.') && !(c == '/') && !(c == ':') && !(c == ';') && + !(c == '<') && !(c == '=') && !(c == '>') && !(c == '?') && + !(c == '@') && !(c == '[') && !(c == ']') && + !(c == '^') && !(c == '_') && !(c == '`') && !(c == '{') && + !(c == '|') && !(c == '}') && !(c == '~') + ) { + // convert the "special" character into a "\xHH" LSCP escape sequence + char buf[5]; + snprintf(buf, sizeof(buf), "\\x%02x", static_cast(c)); + txt.replace(i, 1, buf); + i += 3; + } + } + return txt; +} + /** * Below are a few static members of the LSCPServer class. * The big assumption here is that LSCPServer is going to remain a singleton. @@ -52,6 +92,7 @@ fd_set LSCPServer::fdSet; int LSCPServer::currentSocket = -1; std::vector LSCPServer::Sessions = std::vector(); +std::vector::iterator itCurrentSession = std::vector::iterator(); std::map LSCPServer::bufferedNotifies = std::map(); std::map LSCPServer::bufferedCommands = std::map(); std::map< LSCPEvent::event_t, std::list > LSCPServer::eventSubscriptions = std::map< LSCPEvent::event_t, std::list >(); @@ -60,7 +101,7 @@ Mutex LSCPServer::SubscriptionMutex = Mutex(); Mutex LSCPServer::RTNotifyMutex = Mutex(); -LSCPServer::LSCPServer(Sampler* pSampler, long int addr, short int port) : Thread(true, false, 0, -4) { +LSCPServer::LSCPServer(Sampler* pSampler, long int addr, short int port) : Thread(true, false, 0, -4), eventHandler(this) { SocketAddress.sin_family = AF_INET; SocketAddress.sin_addr.s_addr = addr; SocketAddress.sin_port = port; @@ -84,20 +125,80 @@ LSCPEvent::RegisterEvent(LSCPEvent::event_db_instr_dir_info, "DB_INSTRUMENT_DIRECTORY_INFO"); LSCPEvent::RegisterEvent(LSCPEvent::event_db_instr_count, "DB_INSTRUMENT_COUNT"); LSCPEvent::RegisterEvent(LSCPEvent::event_db_instr_info, "DB_INSTRUMENT_INFO"); + LSCPEvent::RegisterEvent(LSCPEvent::event_db_instrs_job_info, "DB_INSTRUMENTS_JOB_INFO"); LSCPEvent::RegisterEvent(LSCPEvent::event_misc, "MISCELLANEOUS"); + LSCPEvent::RegisterEvent(LSCPEvent::event_total_stream_count, "TOTAL_STREAM_COUNT"); LSCPEvent::RegisterEvent(LSCPEvent::event_total_voice_count, "TOTAL_VOICE_COUNT"); LSCPEvent::RegisterEvent(LSCPEvent::event_global_info, "GLOBAL_INFO"); + LSCPEvent::RegisterEvent(LSCPEvent::event_channel_midi, "CHANNEL_MIDI"); hSocket = -1; } LSCPServer::~LSCPServer() { +#if defined(WIN32) + if (hSocket >= 0) closesocket(hSocket); +#else if (hSocket >= 0) close(hSocket); +#endif +} + +LSCPServer::EventHandler::EventHandler(LSCPServer* pParent) { + this->pParent = pParent; +} + +LSCPServer::EventHandler::~EventHandler() { + std::vector l = channelMidiListeners; + channelMidiListeners.clear(); + for (int i = 0; i < l.size(); i++) + delete l[i].pMidiListener; } void LSCPServer::EventHandler::ChannelCountChanged(int NewCount) { LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_channel_count, NewCount)); } +void LSCPServer::EventHandler::ChannelAdded(SamplerChannel* pChannel) { + pChannel->AddEngineChangeListener(this); +} + +void LSCPServer::EventHandler::ChannelToBeRemoved(SamplerChannel* pChannel) { + if (!pChannel->GetEngineChannel()) return; + EngineToBeChanged(pChannel->Index()); +} + +void LSCPServer::EventHandler::EngineToBeChanged(int ChannelId) { + SamplerChannel* pSamplerChannel = + pParent->pSampler->GetSamplerChannel(ChannelId); + if (!pSamplerChannel) return; + EngineChannel* pEngineChannel = + pSamplerChannel->GetEngineChannel(); + if (!pEngineChannel) return; + for (std::vector::iterator iter = channelMidiListeners.begin(); iter != channelMidiListeners.end(); ++iter) { + if ((*iter).pEngineChannel == pEngineChannel) { + VirtualMidiDevice* pMidiListener = (*iter).pMidiListener; + pEngineChannel->Disconnect(pMidiListener); + channelMidiListeners.erase(iter); + delete pMidiListener; + return; + } + } +} + +void LSCPServer::EventHandler::EngineChanged(int ChannelId) { + SamplerChannel* pSamplerChannel = + pParent->pSampler->GetSamplerChannel(ChannelId); + if (!pSamplerChannel) return; + EngineChannel* pEngineChannel = + pSamplerChannel->GetEngineChannel(); + if (!pEngineChannel) return; + VirtualMidiDevice* pMidiListener = new VirtualMidiDevice; + pEngineChannel->Connect(pMidiListener); + midi_listener_entry entry = { + pSamplerChannel, pEngineChannel, pMidiListener + }; + channelMidiListeners.push_back(entry); +} + void LSCPServer::EventHandler::AudioDeviceCountChanged(int NewCount) { LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_audio_device_count, NewCount)); } @@ -142,33 +243,42 @@ LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_total_voice_count, NewCount)); } +void LSCPServer::EventHandler::TotalStreamCountChanged(int NewCount) { + LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_total_stream_count, NewCount)); +} + #if HAVE_SQLITE3 void LSCPServer::DbInstrumentsEventHandler::DirectoryCountChanged(String Dir) { - LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_dir_count, Dir)); + LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_dir_count, InstrumentsDb::toEscapedPath(Dir))); } void LSCPServer::DbInstrumentsEventHandler::DirectoryInfoChanged(String Dir) { - LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_dir_info, Dir)); + LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_dir_info, InstrumentsDb::toEscapedPath(Dir))); } void LSCPServer::DbInstrumentsEventHandler::DirectoryNameChanged(String Dir, String NewName) { - Dir = "'" + Dir + "'"; - NewName = "'" + NewName + "'"; + Dir = "'" + InstrumentsDb::toEscapedPath(Dir) + "'"; + NewName = "'" + InstrumentsDb::toEscapedPath(NewName) + "'"; LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_dir_info, "NAME", Dir, NewName)); } void LSCPServer::DbInstrumentsEventHandler::InstrumentCountChanged(String Dir) { - LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_count, Dir)); + LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_count, InstrumentsDb::toEscapedPath(Dir))); } void LSCPServer::DbInstrumentsEventHandler::InstrumentInfoChanged(String Instr) { - LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_info, Instr)); + LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_info, InstrumentsDb::toEscapedPath(Instr))); } + void LSCPServer::DbInstrumentsEventHandler::InstrumentNameChanged(String Instr, String NewName) { - Instr = "'" + Instr + "'"; - NewName = "'" + NewName + "'"; + Instr = "'" + InstrumentsDb::toEscapedPath(Instr) + "'"; + NewName = "'" + InstrumentsDb::toEscapedPath(NewName) + "'"; LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instr_info, "NAME", Instr, NewName)); } + +void LSCPServer::DbInstrumentsEventHandler::JobStatusChanged(int JobId) { + LSCPServer::SendLSCPNotify(LSCPEvent(LSCPEvent::event_db_instrs_job_info, JobId)); +} #endif // HAVE_SQLITE3 @@ -187,6 +297,15 @@ } int LSCPServer::Main() { + #if defined(WIN32) + WSADATA wsaData; + int iResult; + iResult = WSAStartup(MAKEWORD(2,2), &wsaData); + if (iResult != 0) { + std::cerr << "LSCPServer: WSAStartup failed: " << iResult << "\n"; + exit(EXIT_FAILURE); + } + #endif hSocket = socket(AF_INET, SOCK_STREAM, 0); if (hSocket < 0) { std::cerr << "LSCPServer: Could not create server socket." << std::endl; @@ -200,7 +319,11 @@ if (bind(hSocket, (sockaddr*) &SocketAddress, sizeof(sockaddr_in)) < 0) { if (trial > LSCP_SERVER_BIND_TIMEOUT) { std::cerr << "gave up!" << std::endl; + #if defined(WIN32) + closesocket(hSocket); + #else close(hSocket); + #endif //return -1; exit(EXIT_FAILURE); } @@ -212,7 +335,7 @@ listen(hSocket, 1); Initialized.Set(true); - + // Registering event listeners pSampler->AddChannelCountListener(&eventHandler); pSampler->AddAudioDeviceCountListener(&eventHandler); @@ -220,6 +343,7 @@ pSampler->AddVoiceCountListener(&eventHandler); pSampler->AddStreamCountListener(&eventHandler); pSampler->AddBufferFillListener(&eventHandler); + pSampler->AddTotalStreamCountListener(&eventHandler); pSampler->AddTotalVoiceCountListener(&eventHandler); pSampler->AddFxSendCountListener(&eventHandler); MidiInstrumentMapper::AddMidiInstrumentCountListener(&eventHandler); @@ -239,6 +363,9 @@ timeval timeout; while (true) { + #if CONFIG_PTHREAD_TESTCANCEL + TestCancel(); + #endif // check if some engine channel's parameter / status changed, if so notify the respective LSCP event subscribers { std::set engineChannels = EngineChannelFactory::EngineChannelInstances(); @@ -260,6 +387,30 @@ } } + // check if MIDI data arrived on some engine channel + for (int i = 0; i < eventHandler.channelMidiListeners.size(); ++i) { + const EventHandler::midi_listener_entry entry = + eventHandler.channelMidiListeners[i]; + VirtualMidiDevice* pMidiListener = entry.pMidiListener; + if (pMidiListener->NotesChanged()) { + for (int iNote = 0; iNote < 128; iNote++) { + if (pMidiListener->NoteChanged(iNote)) { + const bool bActive = pMidiListener->NoteIsActive(iNote); + LSCPServer::SendLSCPNotify( + LSCPEvent( + LSCPEvent::event_channel_midi, + entry.pSamplerChannel->Index(), + std::string(bActive ? "NOTE_ON" : "NOTE_OFF"), + iNote, + bActive ? pMidiListener->NoteOnVelocity(iNote) + : pMidiListener->NoteOffVelocity(iNote) + ) + ); + } + } + } + } + //Now let's deliver late notifies (if any) NotifyBufferMutex.Lock(); for (std::map::iterator iterNotify = bufferedNotifies.begin(); iterNotify != bufferedNotifies.end(); iterNotify++) { @@ -282,7 +433,11 @@ continue; //Nothing try again if (retval == -1) { std::cerr << "LSCPServer: Socket select error." << std::endl; + #if defined(WIN32) + closesocket(hSocket); + #else close(hSocket); + #endif exit(EXIT_FAILURE); } @@ -294,10 +449,18 @@ exit(EXIT_FAILURE); } + #if defined(WIN32) + u_long nonblock_io = 1; + if( ioctlsocket(socket, FIONBIO, &nonblock_io) ) { + std::cerr << "LSCPServer: ioctlsocket: set FIONBIO failed. Error " << WSAGetLastError() << std::endl; + exit(EXIT_FAILURE); + } + #else if (fcntl(socket, F_SETFL, O_NONBLOCK)) { std::cerr << "LSCPServer: F_SETFL O_NONBLOCK failed." << std::endl; exit(EXIT_FAILURE); } + #endif // Parser initialization yyparse_param_t yyparse_param; @@ -321,12 +484,14 @@ int dummy; // just a temporary hack to fulfill the restart() function prototype restart(NULL, dummy); // restart the 'scanner' currentSocket = (*iter).hSession; //a hack + itCurrentSession = iter; // another hack dmsg(2,("LSCPServer: [%s]\n",bufferedCommands[currentSocket].c_str())); if ((*iter).bVerbose) { // if echo mode enabled AnswerClient(bufferedCommands[currentSocket]); } int result = yyparse(&(*iter)); currentSocket = -1; //continuation of a hack + itCurrentSession = Sessions.end(); // hack as well dmsg(3,("LSCPServer: Done parsing on socket %d.\n", currentSocket)); if (result == LSCP_QUIT) { //Was it a quit command by any chance? CloseConnection(iter); @@ -354,10 +519,22 @@ NotifyMutex.Lock(); bufferedCommands.erase(socket); bufferedNotifies.erase(socket); + #if defined(WIN32) + closesocket(socket); + #else close(socket); + #endif NotifyMutex.Unlock(); } +void LSCPServer::LockRTNotify() { + RTNotifyMutex.Lock(); +} + +void LSCPServer::UnlockRTNotify() { + RTNotifyMutex.Unlock(); +} + int LSCPServer::EventSubscribers( std::list events ) { int subs = 0; SubscriptionMutex.Lock(); @@ -419,6 +596,10 @@ return command.size(); } +extern yyparse_param_t* GetCurrentYaccSession() { + return &(*itCurrentSession); +} + /** * Will be called to try to read the command from the socket * If command is read, it will return true. Otherwise false is returned. @@ -429,7 +610,11 @@ char c; int i = 0; while (true) { + #if defined(WIN32) + int result = recv(socket, (char *)&c, 1, 0); //Read one character at a time for now + #else int result = recv(socket, (void *)&c, 1, 0); //Read one character at a time for now + #endif if (result == 0) { //socket was selected, so 0 here means client has closed the connection CloseConnection(iter); break; @@ -444,6 +629,16 @@ } bufferedCommands[socket] += c; } + #if defined(WIN32) + if (result == SOCKET_ERROR) { + int wsa_lasterror = WSAGetLastError(); + if (wsa_lasterror == WSAEWOULDBLOCK) //Would block, try again later. + return false; + dmsg(2,("LSCPScanner: Socket error after recv() Error %d.\n", wsa_lasterror)); + CloseConnection(iter); + break; + } + #else if (result == -1) { if (errno == EAGAIN) //Would block, try again later. return false; @@ -482,6 +677,7 @@ CloseConnection(iter); break; } + #endif } return false; } @@ -606,7 +802,7 @@ EngineChannel* pEngineChannel = pSamplerChannel->GetEngineChannel(); if (!pEngineChannel) throw Exception("There is no engine deployed on this sampler channel yet"); - return pEngineChannel; + return pEngineChannel; } /** @@ -755,7 +951,7 @@ LockRTNotify(); try { Engine* pEngine = EngineFactory::Create(EngineName); - result.Add("DESCRIPTION", pEngine->Description()); + result.Add("DESCRIPTION", _escapeLscpResponse(pEngine->Description())); result.Add("VERSION", pEngine->Version()); EngineFactory::Destroy(pEngine); } @@ -828,9 +1024,20 @@ if (pSamplerChannel->GetMidiInputChannel() == midi_chan_all) result.Add("MIDI_INPUT_CHANNEL", "ALL"); else result.Add("MIDI_INPUT_CHANNEL", pSamplerChannel->GetMidiInputChannel()); + // convert the filename into the correct encoding as defined for LSCP + // (especially in terms of special characters -> escape sequences) + if (InstrumentFileName != "NONE" && InstrumentFileName != "") { +#if WIN32 + InstrumentFileName = Path::fromWindows(InstrumentFileName).toLscp(); +#else + // assuming POSIX + InstrumentFileName = Path::fromPosix(InstrumentFileName).toLscp(); +#endif + } + result.Add("INSTRUMENT_FILE", InstrumentFileName); result.Add("INSTRUMENT_NR", InstrumentIndex); - result.Add("INSTRUMENT_NAME", InstrumentName); + result.Add("INSTRUMENT_NAME", _escapeLscpResponse(InstrumentName)); result.Add("INSTRUMENT_STATUS", InstrumentStatus); result.Add("MUTE", Mute == -1 ? "MUTED_BY_SOLO" : (Mute ? "true" : "false")); result.Add("SOLO", Solo); @@ -1772,9 +1979,19 @@ std::map::iterator iter = mappings.find(idx); if (iter == mappings.end()) result.Error("there is no map entry with that index"); else { // found - result.Add("NAME", iter->second.Name); + + // convert the filename into the correct encoding as defined for LSCP + // (especially in terms of special characters -> escape sequences) +#if WIN32 + const String instrumentFileName = Path::fromWindows(iter->second.InstrumentFile).toLscp(); +#else + // assuming POSIX + const String instrumentFileName = Path::fromPosix(iter->second.InstrumentFile).toLscp(); +#endif + + result.Add("NAME", _escapeLscpResponse(iter->second.Name)); result.Add("ENGINE_NAME", iter->second.EngineName); - result.Add("INSTRUMENT_FILE", iter->second.InstrumentFile); + result.Add("INSTRUMENT_FILE", instrumentFileName); result.Add("INSTRUMENT_NR", (int) iter->second.InstrumentIndex); String instrumentName; Engine* pEngine = EngineFactory::Create(iter->second.EngineName); @@ -1787,7 +2004,7 @@ } EngineFactory::Destroy(pEngine); } - result.Add("INSTRUMENT_NAME", instrumentName); + result.Add("INSTRUMENT_NAME", _escapeLscpResponse(instrumentName)); switch (iter->second.LoadMode) { case MidiInstrumentMapper::ON_DEMAND: result.Add("LOAD_MODE", "ON_DEMAND"); @@ -1942,7 +2159,7 @@ dmsg(2,("LSCPServer: GetMidiInstrumentMap()\n")); LSCPResultSet result; try { - result.Add("NAME", MidiInstrumentMapper::MapName(MidiMapID)); + result.Add("NAME", _escapeLscpResponse(MidiInstrumentMapper::MapName(MidiMapID))); result.Add("DEFAULT", MidiInstrumentMapper::GetDefaultMap() == MidiMapID); } catch (Exception e) { result.Error(e); @@ -1993,7 +2210,7 @@ LSCPResultSet result; try { EngineChannel* pEngineChannel = GetEngineChannel(uiSamplerChannel); - + FxSend* pFxSend = pEngineChannel->AddFxSend(MidiCtrl, Name); if (!pFxSend) throw Exception("Could not add FxSend, don't ask, I don't know why (probably a bug)"); @@ -2077,7 +2294,7 @@ try { EngineChannel* pEngineChannel = GetEngineChannel(uiSamplerChannel); FxSend* pFxSend = GetFxSend(uiSamplerChannel, FxSendID); - + // gather audio routing informations String AudioRouting; for (int chan = 0; chan < pEngineChannel->Channels(); chan++) { @@ -2086,7 +2303,7 @@ } // success - result.Add("NAME", pFxSend->Name()); + result.Add("NAME", _escapeLscpResponse(pFxSend->Name())); result.Add("MIDI_CONTROLLER", pFxSend->MidiController()); result.Add("LEVEL", ToString(pFxSend->Level())); result.Add("AUDIO_OUTPUT_ROUTING", AudioRouting); @@ -2152,6 +2369,28 @@ return result.Produce(); } +String LSCPServer::EditSamplerChannelInstrument(uint uiSamplerChannel) { + dmsg(2,("LSCPServer: EditSamplerChannelInstrument(SamplerChannel=%d)\n", uiSamplerChannel)); + LSCPResultSet result; + try { + SamplerChannel* pSamplerChannel = pSampler->GetSamplerChannel(uiSamplerChannel); + if (!pSamplerChannel) throw Exception("Invalid sampler channel number " + ToString(uiSamplerChannel)); + EngineChannel* pEngineChannel = pSamplerChannel->GetEngineChannel(); + if (!pEngineChannel) throw Exception("No engine type assigned to sampler channel"); + if (pEngineChannel->InstrumentStatus() < 0) throw Exception("No instrument loaded to sampler channel"); + Engine* pEngine = pEngineChannel->GetEngine(); + InstrumentManager* pInstrumentManager = pEngine->GetInstrumentManager(); + if (!pInstrumentManager) throw Exception("Engine does not provide an instrument manager"); + InstrumentManager::instrument_id_t instrumentID; + instrumentID.FileName = pEngineChannel->InstrumentFileName(); + instrumentID.Index = pEngineChannel->InstrumentIndex(); + pInstrumentManager->LaunchInstrumentEditor(instrumentID); + } catch (Exception e) { + result.Error(e); + } + return result.Produce(); +} + /** * Will be called by the parser to reset a particular sampler channel. */ @@ -2187,8 +2426,10 @@ */ String LSCPServer::GetServerInfo() { dmsg(2,("LSCPServer: GetServerInfo()\n")); + const std::string description = + _escapeLscpResponse("LinuxSampler - modular, streaming capable sampler"); LSCPResultSet result; - result.Add("DESCRIPTION", "LinuxSampler - modular, streaming capable sampler"); + result.Add("DESCRIPTION", description); result.Add("VERSION", VERSION); result.Add("PROTOCOL_VERSION", ToString(LSCP_RELEASE_MAJOR) + "." + ToString(LSCP_RELEASE_MINOR)); #if HAVE_SQLITE3 @@ -2196,7 +2437,17 @@ #else result.Add("INSTRUMENTS_DB_SUPPORT", "no"); #endif - + + return result.Produce(); +} + +/** + * Will be called by the parser to return the current number of all active streams. + */ +String LSCPServer::GetTotalStreamCount() { + dmsg(2,("LSCPServer: GetTotalStreamCount()\n")); + LSCPResultSet result; + result.Add(pSampler->GetDiskStreamCount()); return result.Produce(); } @@ -2238,6 +2489,166 @@ return result.Produce(); } +String LSCPServer::GetFileInstruments(String Filename) { + dmsg(2,("LSCPServer: GetFileInstruments(String Filename=%s)\n",Filename.c_str())); + LSCPResultSet result; + try { + VerifyFile(Filename); + } catch (Exception e) { + result.Error(e); + return result.Produce(); + } + // try to find a sampler engine that can handle the file + bool bFound = false; + std::vector engineTypes = EngineFactory::AvailableEngineTypes(); + for (int i = 0; !bFound && i < engineTypes.size(); i++) { + Engine* pEngine = NULL; + try { + pEngine = EngineFactory::Create(engineTypes[i]); + if (!pEngine) throw Exception("Internal error: could not create '" + engineTypes[i] + "' engine"); + InstrumentManager* pManager = pEngine->GetInstrumentManager(); + if (pManager) { + std::vector IDs = + pManager->GetInstrumentFileContent(Filename); + // return the amount of instruments in the file + result.Add(IDs.size()); + // no more need to ask other engine types + bFound = true; + } else dmsg(1,("Warning: engine '%s' does not provide an instrument manager\n", engineTypes[i].c_str())); + } catch (Exception e) { + // NOOP, as exception is thrown if engine doesn't support file + } + if (pEngine) EngineFactory::Destroy(pEngine); + } + + if (!bFound) result.Error("Unknown file format"); + return result.Produce(); +} + +String LSCPServer::ListFileInstruments(String Filename) { + dmsg(2,("LSCPServer: ListFileInstruments(String Filename=%s)\n",Filename.c_str())); + LSCPResultSet result; + try { + VerifyFile(Filename); + } catch (Exception e) { + result.Error(e); + return result.Produce(); + } + // try to find a sampler engine that can handle the file + bool bFound = false; + std::vector engineTypes = EngineFactory::AvailableEngineTypes(); + for (int i = 0; !bFound && i < engineTypes.size(); i++) { + Engine* pEngine = NULL; + try { + pEngine = EngineFactory::Create(engineTypes[i]); + if (!pEngine) throw Exception("Internal error: could not create '" + engineTypes[i] + "' engine"); + InstrumentManager* pManager = pEngine->GetInstrumentManager(); + if (pManager) { + std::vector IDs = + pManager->GetInstrumentFileContent(Filename); + // return a list of IDs of the instruments in the file + String s; + for (int j = 0; j < IDs.size(); j++) { + if (s.size()) s += ","; + s += ToString(IDs[j].Index); + } + result.Add(s); + // no more need to ask other engine types + bFound = true; + } else dmsg(1,("Warning: engine '%s' does not provide an instrument manager\n", engineTypes[i].c_str())); + } catch (Exception e) { + // NOOP, as exception is thrown if engine doesn't support file + } + if (pEngine) EngineFactory::Destroy(pEngine); + } + + if (!bFound) result.Error("Unknown file format"); + return result.Produce(); +} + +String LSCPServer::GetFileInstrumentInfo(String Filename, uint InstrumentID) { + dmsg(2,("LSCPServer: GetFileInstrumentInfo(String Filename=%s, InstrumentID=%d)\n",Filename.c_str(),InstrumentID)); + LSCPResultSet result; + try { + VerifyFile(Filename); + } catch (Exception e) { + result.Error(e); + return result.Produce(); + } + InstrumentManager::instrument_id_t id; + id.FileName = Filename; + id.Index = InstrumentID; + // try to find a sampler engine that can handle the file + bool bFound = false; + bool bFatalErr = false; + std::vector engineTypes = EngineFactory::AvailableEngineTypes(); + for (int i = 0; !bFound && !bFatalErr && i < engineTypes.size(); i++) { + Engine* pEngine = NULL; + try { + pEngine = EngineFactory::Create(engineTypes[i]); + if (!pEngine) throw Exception("Internal error: could not create '" + engineTypes[i] + "' engine"); + InstrumentManager* pManager = pEngine->GetInstrumentManager(); + if (pManager) { + // check if the instrument index is valid + // FIXME: this won't work if an engine only supports parts of the instrument file + std::vector IDs = + pManager->GetInstrumentFileContent(Filename); + if (std::find(IDs.begin(), IDs.end(), id) == IDs.end()) { + std::stringstream ss; + ss << "Invalid instrument index " << InstrumentID << " for instrument file '" << Filename << "'"; + bFatalErr = true; + throw Exception(ss.str()); + } + // get the info of the requested instrument + InstrumentManager::instrument_info_t info = + pManager->GetInstrumentInfo(id); + // return detailed informations about the file + result.Add("NAME", info.InstrumentName); + result.Add("FORMAT_FAMILY", engineTypes[i]); + result.Add("FORMAT_VERSION", info.FormatVersion); + result.Add("PRODUCT", info.Product); + result.Add("ARTISTS", info.Artists); + // no more need to ask other engine types + bFound = true; + } else dmsg(1,("Warning: engine '%s' does not provide an instrument manager\n", engineTypes[i].c_str())); + } catch (Exception e) { + // usually NOOP, as exception is thrown if engine doesn't support file + if (bFatalErr) result.Error(e); + } + if (pEngine) EngineFactory::Destroy(pEngine); + } + + if (!bFound && !bFatalErr) result.Error("Unknown file format"); + return result.Produce(); +} + +void LSCPServer::VerifyFile(String Filename) { + #if WIN32 + WIN32_FIND_DATA win32FileAttributeData; + BOOL res = GetFileAttributesEx( Filename.c_str(), GetFileExInfoStandard, &win32FileAttributeData ); + if (!res) { + std::stringstream ss; + ss << "File does not exist, GetFileAttributesEx failed `" << Filename << "`: Error " << GetLastError(); + throw Exception(ss.str()); + } + if ( win32FileAttributeData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY ) { + throw Exception("Directory is specified"); + } + #else + struct stat statBuf; + int res = stat(Filename.c_str(), &statBuf); + if (res) { + std::stringstream ss; + ss << "Fail to stat `" << Filename << "`: " << strerror(errno); + throw Exception(ss.str()); + } + + if (S_ISDIR(statBuf.st_mode)) { + throw Exception("Directory is specified"); + } + #endif +} + /** * Will be called by the parser to subscribe a client (frontend) on the * server for receiving event messages. @@ -2319,7 +2730,7 @@ for (int i = 0; i < dirs->size(); i++) { if (list != "") list += ","; - list += "'" + dirs->at(i) + "'"; + list += "'" + InstrumentsDb::toEscapedPath(dirs->at(i)) + "'"; } result.Add(list); @@ -2339,7 +2750,7 @@ try { DbDirectory info = InstrumentsDb::GetInstrumentsDb()->GetDirectoryInfo(Dir); - result.Add("DESCRIPTION", info.Description); + result.Add("DESCRIPTION", _escapeLscpResponse(info.Description)); result.Add("CREATED", info.Created); result.Add("MODIFIED", info.Modified); } catch (Exception e) { @@ -2411,12 +2822,15 @@ return result.Produce(); } -String LSCPServer::AddDbInstruments(String DbDir, String FilePath, int Index) { - dmsg(2,("LSCPServer: AddDbInstruments(DbDir=%s,FilePath=%s,Index=%d)\n", DbDir.c_str(), FilePath.c_str(), Index)); +String LSCPServer::AddDbInstruments(String DbDir, String FilePath, int Index, bool bBackground) { + dmsg(2,("LSCPServer: AddDbInstruments(DbDir=%s,FilePath=%s,Index=%d,bBackground=%d)\n", DbDir.c_str(), FilePath.c_str(), Index, bBackground)); LSCPResultSet result; #if HAVE_SQLITE3 try { - InstrumentsDb::GetInstrumentsDb()->AddInstruments(DbDir, FilePath, Index); + int id; + InstrumentsDb* db = InstrumentsDb::GetInstrumentsDb(); + id = db->AddInstruments(DbDir, FilePath, Index, bBackground); + if (bBackground) result = id; } catch (Exception e) { result.Error(e); } @@ -2426,27 +2840,24 @@ return result.Produce(); } -String LSCPServer::AddDbInstrumentsFlat(String DbDir, String FsDir) { - dmsg(2,("LSCPServer: AddDbInstrumentsFlat(DbDir=%s,FilePath=%s)\n", DbDir.c_str(), FsDir.c_str())); +String LSCPServer::AddDbInstruments(String ScanMode, String DbDir, String FsDir, bool bBackground) { + dmsg(2,("LSCPServer: AddDbInstruments(ScanMode=%s,DbDir=%s,FsDir=%s,bBackground=%d)\n", ScanMode.c_str(), DbDir.c_str(), FsDir.c_str(), bBackground)); LSCPResultSet result; #if HAVE_SQLITE3 try { - InstrumentsDb::GetInstrumentsDb()->AddInstrumentsRecursive(DbDir, FsDir, true); - } catch (Exception e) { - result.Error(e); - } -#else - result.Error(String(DOESNT_HAVE_SQLITE3), 0); -#endif - return result.Produce(); -} + int id; + InstrumentsDb* db = InstrumentsDb::GetInstrumentsDb(); + if (ScanMode.compare("RECURSIVE") == 0) { + id = db->AddInstruments(RECURSIVE, DbDir, FsDir, bBackground); + } else if (ScanMode.compare("NON_RECURSIVE") == 0) { + id = db->AddInstruments(NON_RECURSIVE, DbDir, FsDir, bBackground); + } else if (ScanMode.compare("FLAT") == 0) { + id = db->AddInstruments(FLAT, DbDir, FsDir, bBackground); + } else { + throw Exception("Unknown scan mode: " + ScanMode); + } -String LSCPServer::AddDbInstrumentsNonrecursive(String DbDir, String FsDir) { - dmsg(2,("LSCPServer: AddDbInstrumentsNonrecursive(DbDir=%s,FilePath=%s)\n", DbDir.c_str(), FsDir.c_str())); - LSCPResultSet result; -#if HAVE_SQLITE3 - try { - InstrumentsDb::GetInstrumentsDb()->AddInstrumentsNonrecursive(DbDir, FsDir); + if (bBackground) result = id; } catch (Exception e) { result.Error(e); } @@ -2496,7 +2907,7 @@ for (int i = 0; i < instrs->size(); i++) { if (list != "") list += ","; - list += "'" + instrs->at(i) + "'"; + list += "'" + InstrumentsDb::toEscapedPath(instrs->at(i)) + "'"; } result.Add(list); @@ -2523,11 +2934,31 @@ result.Add("SIZE", (int)info.Size); result.Add("CREATED", info.Created); result.Add("MODIFIED", info.Modified); - result.Add("DESCRIPTION", FilterEndlines(info.Description)); + result.Add("DESCRIPTION", _escapeLscpResponse(info.Description)); result.Add("IS_DRUM", info.IsDrum); - result.Add("PRODUCT", FilterEndlines(info.Product)); - result.Add("ARTISTS", FilterEndlines(info.Artists)); - result.Add("KEYWORDS", FilterEndlines(info.Keywords)); + result.Add("PRODUCT", _escapeLscpResponse(info.Product)); + result.Add("ARTISTS", _escapeLscpResponse(info.Artists)); + result.Add("KEYWORDS", _escapeLscpResponse(info.Keywords)); + } catch (Exception e) { + result.Error(e); + } +#else + result.Error(String(DOESNT_HAVE_SQLITE3), 0); +#endif + return result.Produce(); +} + +String LSCPServer::GetDbInstrumentsJobInfo(int JobId) { + dmsg(2,("LSCPServer: GetDbInstrumentsJobInfo(JobId=%d)\n", JobId)); + LSCPResultSet result; +#if HAVE_SQLITE3 + try { + ScanJob job = InstrumentsDb::GetInstrumentsDb()->Jobs.GetJobById(JobId); + + result.Add("FILES_TOTAL", job.FilesTotal); + result.Add("FILES_SCANNED", job.FilesScanned); + result.Add("SCANNING", job.Scanning); + result.Add("STATUS", job.Status); } catch (Exception e) { result.Error(e); } @@ -2624,7 +3055,7 @@ for (int i = 0; i < pDirectories->size(); i++) { if (list != "") list += ","; - list += "'" + pDirectories->at(i) + "'"; + list += "'" + InstrumentsDb::toEscapedPath(pDirectories->at(i)) + "'"; } result.Add(list); @@ -2680,7 +3111,7 @@ for (int i = 0; i < pInstruments->size(); i++) { if (list != "") list += ","; - list += "'" + pInstruments->at(i) + "'"; + list += "'" + InstrumentsDb::toEscapedPath(pInstruments->at(i)) + "'"; } result.Add(list); @@ -2693,6 +3124,21 @@ return result.Produce(); } +String LSCPServer::FormatInstrumentsDb() { + dmsg(2,("LSCPServer: FormatInstrumentsDb()\n")); + LSCPResultSet result; +#if HAVE_SQLITE3 + try { + InstrumentsDb::GetInstrumentsDb()->Format(); + } catch (Exception e) { + result.Error(e); + } +#else + result.Error(String(DOESNT_HAVE_SQLITE3), 0); +#endif + return result.Produce(); +} + /** * Will be called by the parser to enable or disable echo mode; if echo @@ -2712,13 +3158,3 @@ } return result.Produce(); } - -String LSCPServer::FilterEndlines(String s) { - String s2 = s; - for (int i = 0; i < s2.length(); i++) { - if (s2.at(i) == '\r') s2.at(i) = ' '; - else if (s2.at(i) == '\n') s2.at(i) = ' '; - } - - return s2; -}