/***************************************************************************************** * * * OpenSpace * * * * Copyright (c) 2014-2021 * * * * Permission is hereby granted, free of charge, to any person obtaining a copy of this * * software and associated documentation files (the "Software"), to deal in the Software * * without restriction, including without limitation the rights to use, copy, modify, * * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to * * permit persons to whom the Software is furnished to do so, subject to the following * * conditions: * * * * The above copyright notice and this permission notice shall be included in all copies * * or substantial portions of the Software. * * * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, * * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A * * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF * * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE * * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * ****************************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace std::string_literals; namespace { constexpr const char* _loggerCat = "SoftwareIntegrationModule"; } // namespace namespace openspace { SoftwareIntegrationModule::SoftwareIntegrationModule() : OpenSpaceModule(Name) {} void SoftwareIntegrationModule::internalInitialize(const ghoul::Dictionary&) { auto fRenderable = FactoryManager::ref().factory(); ghoul_assert(fRenderable, "No renderable factory existed"); fRenderable->registerClass("RenderablePointsCloud"); // Open port start(4700); global::callback::preSync->emplace_back([this]() { preSyncUpdate(); }); } void SoftwareIntegrationModule::internalDeinitialize() { stop(); } void SoftwareIntegrationModule::preSyncUpdate() { if (_onceNodeExistsCallbacks.empty()) { return; } // Check if the scene graph node has been created. If so, call the corresponding // callback function to set up any subscriptions auto it = _onceNodeExistsCallbacks.begin(); while (it != _onceNodeExistsCallbacks.end()) { const std::string& identifier = it->first; const std::function& callback = it->second; const SceneGraphNode* sgn = global::renderEngine->scene()->sceneGraphNode(identifier); if (sgn) { callback(); it = _onceNodeExistsCallbacks.erase(it); continue; } it++; } } void SoftwareIntegrationModule::start(int port) { _socketServer.listen(port); _serverThread = std::thread([this]() { handleNewPeers(); }); _eventLoopThread = std::thread([this]() { eventLoop(); }); } void SoftwareIntegrationModule::stop() { _shouldStop = true; _socketServer.close(); if (_serverThread.joinable()) { _serverThread.join(); } if (_eventLoopThread.joinable()) { _eventLoopThread.join(); } } bool SoftwareIntegrationModule::isConnected(const Peer& peer) const { return peer.status != SoftwareConnection::Status::Connecting && peer.status != SoftwareConnection::Status::Disconnected; } std::shared_ptr SoftwareIntegrationModule::peer(size_t id) { std::lock_guard lock(_peerListMutex); auto it = _peers.find(id); if (it == _peers.end()) { return nullptr; } return it->second; } void SoftwareIntegrationModule::disconnect(Peer& peer) { if (isConnected(peer)) { _nConnections -= 1; } peer.connection.disconnect(); peer.thread.join(); _peers.erase(peer.id); } void SoftwareIntegrationModule::eventLoop() { while (!_shouldStop) { if (!_incomingMessages.empty()) { PeerMessage pm = _incomingMessages.pop(); handlePeerMessage(std::move(pm)); } } } void SoftwareIntegrationModule::handleNewPeers() { while (!_shouldStop) { std::unique_ptr socket = _socketServer.awaitPendingTcpSocket(); if (!socket) { return; } socket->startStreams(); const size_t id = _nextConnectionId++; std::shared_ptr p = std::make_shared(Peer{ id, "", std::thread(), SoftwareConnection(std::move(socket)), SoftwareConnection::Status::Connecting }); auto it = _peers.emplace(p->id, p); it.first->second->thread = std::thread([this, id]() { handlePeer(id); }); } } void SoftwareIntegrationModule::handlePeer(size_t id) { while (!_shouldStop) { std::shared_ptr p = peer(id); if (!p) { return; } if (!p->connection.isConnectedOrConnecting()) { return; } try { SoftwareConnection::Message m = p->connection.receiveMessage(); _incomingMessages.push({ id, m }); } catch (const SoftwareConnection::SoftwareConnectionLostError&) { LERROR(fmt::format("Connection lost to {}", p->id)); _incomingMessages.push({ id, SoftwareConnection::Message( SoftwareConnection::MessageType::Disconnection, std::vector() ) }); return; } } } void SoftwareIntegrationModule::handlePeerMessage(PeerMessage peerMessage) { const size_t peerId = peerMessage.peerId; auto it = _peers.find(peerId); if (it == _peers.end()) { return; } std::shared_ptr& peer = it->second; const SoftwareConnection::MessageType messageType = peerMessage.message.type; std::vector& message = peerMessage.message.content; switch (messageType) { case SoftwareConnection::MessageType::Connection: { std::string software(message.begin(), message.end()); LINFO(fmt::format("OpenSpace has connected with {} through socket.", software)); break; } case SoftwareConnection::MessageType::ReadPointData: { messageOffset = 0; // Resets message offset std::vector xCoordinates = readData(message); std::vector yCoordinates = readData(message); std::vector zCoordinates = readData(message); int size = xCoordinates.size(); pointData.clear(); for (int i = 0; i < size; i++) { float x = xCoordinates[i]; float y = yCoordinates[i]; float z = zCoordinates[i]; pointData.push_back({ x, y, z }); } break; } case SoftwareConnection::MessageType::ReadLuminosityData: { messageOffset = 0; // Resets message offset luminosityData.clear(); luminosityData = readData(message); break; } case SoftwareConnection::MessageType::ReadVelocityData: { messageOffset = 0; // Resets message offset velocityData.clear(); velocityData = readData(message); break; } case SoftwareConnection::MessageType::AddSceneGraphNode: { std::string sgnMessage(message.begin(), message.end()); LDEBUG(fmt::format("Message recieved.. Scene Graph Node Data: {}", sgnMessage)); // The following order of creating variables is the exact order they're received in the message // If the order is not the same, the global variable 'message offset' will be wrong std::string identifier = readIdentifier(message); glm::vec3 color = readColor(message); float opacity = readFloatValue(message); float size = readFloatValue(message); std::string guiName = readGUI(message); ghoul::Dictionary pointDataDictonary; for (int i = 0; i < pointData.size(); ++i) { pointDataDictonary.setValue(fmt::format("[{}]", i + 1), pointData[i]); } // Create a renderable depending on what data was received ghoul::Dictionary renderable; renderable.setValue("Type", "RenderablePointsCloud"s); renderable.setValue("Color", static_cast(color)); renderable.setValue("Opacity", static_cast(opacity)); renderable.setValue("Size", static_cast(size)); renderable.setValue("Data", pointDataDictonary); bool hasLuminosityData = !luminosityData.empty(); bool hasVelocityData = !velocityData.empty(); if (hasLuminosityData) { ghoul::Dictionary luminosityDataDictonary; for (int i = 0; i < luminosityData.size(); ++i) { luminosityDataDictonary.setValue(fmt::format("[{}]", i + 1), luminosityData[i]); } renderable.setValue("Luminosity", luminosityDataDictonary); } if (hasVelocityData) { ghoul::Dictionary velocityDataDictionary; for (int i = 0; i < velocityData.size(); ++i) { velocityDataDictionary.setValue(fmt::format("[{}]", i + 1), velocityData[i]); } renderable.setValue("Velocity", velocityDataDictionary); } ghoul::Dictionary gui; gui.setValue("Name", guiName); gui.setValue("Path", "/Software Integration"s); ghoul::Dictionary node; node.setValue("Identifier", identifier); node.setValue("Renderable", renderable); node.setValue("GUI", gui); openspace::global::scriptEngine->queueScript( "openspace.addSceneGraphNode(" + ghoul::formatLua(node) + ")", scripting::ScriptEngine::RemoteScripting::Yes ); openspace::global::scriptEngine->queueScript( "openspace.setPropertyValueSingle('NavigationHandler.OrbitalNavigator.RetargetAnchor', nil)" "openspace.setPropertyValueSingle('NavigationHandler.OrbitalNavigator.Anchor', '" + identifier + "')" "openspace.setPropertyValueSingle('NavigationHandler.OrbitalNavigator.Aim', '')", scripting::ScriptEngine::RemoteScripting::Yes ); // We have to wait until the renderable exists before we can subscribe to // changes in its properties auto callback = [this, identifier, peerId]() { subscribeToRenderableUpdates(identifier, peerId); }; _onceNodeExistsCallbacks.emplace(identifier, callback); break; } case SoftwareConnection::MessageType::RemoveSceneGraphNode: { std::string identifier(message.begin(), message.end()); LDEBUG(fmt::format("Message recieved.. Delete SGN: {}", identifier)); if (global::navigationHandler->orbitalNavigator().anchorNode()->identifier() == identifier) { // If the deleted node is the current anchor, first change focus to the Sun openspace::global::scriptEngine->queueScript( "openspace.setPropertyValueSingle('NavigationHandler.OrbitalNavigator.Anchor', 'Sun')" "openspace.setPropertyValueSingle('NavigationHandler.OrbitalNavigator.Aim', '')", scripting::ScriptEngine::RemoteScripting::Yes ); } openspace::global::scriptEngine->queueScript( "openspace.removeSceneGraphNode('" + identifier + "');", scripting::ScriptEngine::RemoteScripting::Yes ); LDEBUG(fmt::format("Scengraph {} removed.", identifier)); break; } case SoftwareConnection::MessageType::Color: { std::string colorMessage(message.begin(), message.end()); LDEBUG(fmt::format("Message recieved.. New Color: {}", colorMessage)); std::string identifier = readIdentifier(message); glm::vec3 color = readColor(message); // Get color of renderable const Renderable* myRenderable = renderable(identifier); properties::Property* colorProperty = myRenderable->property("Color"); auto propertyAny = colorProperty->get(); glm::vec3 propertyColor = std::any_cast(propertyAny); bool isUpdated = (propertyColor != color); // Update color of renderable if (isUpdated) { colorProperty->set(color); } break; } case SoftwareConnection::MessageType::Opacity: { std::string opacityMessage(message.begin(), message.end()); LDEBUG(fmt::format("Message recieved.. New Opacity: {}", opacityMessage)); std::string identifier = readIdentifier(message); float opacity = readFloatValue(message); // Get opacity of renderable const Renderable* myRenderable = renderable(identifier); properties::Property* opacityProperty = myRenderable->property("Opacity"); auto propertyAny = opacityProperty->get(); float propertyOpacity = std::any_cast(propertyAny); bool isUpdated = (propertyOpacity != opacity); // Update opacity of renderable if (isUpdated) { opacityProperty->set(opacity); } break; } case SoftwareConnection::MessageType::Size: { std::string sizeMessage(message.begin(), message.end()); LDEBUG(fmt::format("Message recieved.. New Size: {}", sizeMessage)); std::string identifier = readIdentifier(message); float size = readFloatValue(message); // Get size of renderable const Renderable* myRenderable = renderable(identifier); properties::Property* sizeProperty = myRenderable->property("Size"); auto propertyAny = sizeProperty->get(); float propertySize = std::any_cast(propertyAny); bool isUpdated = (propertySize != size); // Update size of renderable if (isUpdated) { sizeProperty->set(size); } break; } case SoftwareConnection::MessageType::Visibility: { std::string visibilityMessage(message.begin(), message.end()); LDEBUG(fmt::format("Message recieved.. New Visibility: {}", visibilityMessage)); std::string identifier = readIdentifier(message); std::string visibility; visibility.push_back(message[messageOffset]); bool boolValue = (visibility == "F") ? false : true; // Toggle visibility of renderable const Renderable* myRenderable = renderable(identifier); properties::Property* visibilityProperty = myRenderable->property("ToggleVisibility"); visibilityProperty->set(boolValue); break; } case SoftwareConnection::MessageType::Disconnection: { disconnect(*peer); break; } default: LERROR(fmt::format( "Unsupported message type: {}", static_cast(messageType) )); break; } } void SoftwareIntegrationModule::subscribeToRenderableUpdates(std::string identifier, size_t peerId) { const Renderable* aRenderable = renderable(identifier); if (!aRenderable) { LERROR(fmt::format("Renderable with identifier '{}' doesn't exist", identifier)); return; } std::shared_ptr peer = this->peer(peerId); if (!peer) { LERROR(fmt::format("Peer connection with id '{}' could not be found", peerId)); return; } properties::Property* colorProperty = aRenderable->property("Color"); properties::Property* opacityProperty = aRenderable->property("Opacity"); properties::Property* sizeProperty = aRenderable->property("Size"); properties::Property* visibilityProperty = aRenderable->property("ToggleVisibility"); // Update color of renderable auto updateColor = [colorProperty, identifier, peer]() { std::string lengthOfIdentifier = std::to_string(identifier.length()); std::string propertyValue = colorProperty->getStringValue(); std::string lengthOfValue = std::to_string(propertyValue.length()); std::string messageType = "UPCO"; std::string subject = lengthOfIdentifier + identifier + lengthOfValue + propertyValue; // Format length of subject to always be 4 digits std::ostringstream os; os << std::setfill('0') << std::setw(4) << subject.length(); std::string lengthOfSubject = os.str(); std::string message = messageType + lengthOfSubject + subject; peer->connection.sendMessage(message); }; if (colorProperty) { colorProperty->onChange(updateColor); } // Update opacity of renderable auto updateOpacity = [opacityProperty, identifier, peer]() { std::string lengthOfIdentifier = std::to_string(identifier.length()); std::string propertyValue = opacityProperty->getStringValue(); std::string lengthOfValue = std::to_string(propertyValue.length()); std::string messageType = "UPOP"; std::string subject = lengthOfIdentifier + identifier + lengthOfValue + propertyValue; // Format length of subject to always be 4 digits std::ostringstream os; os << std::setfill('0') << std::setw(4) << subject.length(); std::string lengthOfSubject = os.str(); std::string message = messageType + lengthOfSubject + subject; peer->connection.sendMessage(message); }; if (opacityProperty) { opacityProperty->onChange(updateOpacity); } // Update size of renderable auto updateSize = [sizeProperty, identifier, peer]() { std::string lengthOfIdentifier = std::to_string(identifier.length()); std::string propertyValue = sizeProperty->getStringValue(); std::string lengthOfValue = std::to_string(propertyValue.length()); std::string messageType = "UPSI"; std::string subject = lengthOfIdentifier + identifier + lengthOfValue + propertyValue; // Format length of subject to always be 4 digits std::ostringstream os; os << std::setfill('0') << std::setw(4) << subject.length(); std::string lengthOfSubject = os.str(); std::string message = messageType + lengthOfSubject + subject; peer->connection.sendMessage(message); }; if (sizeProperty) { sizeProperty->onChange(updateSize); } // Toggle visibility of renderable auto toggleVisibility = [visibilityProperty, identifier, peer]() { std::string lengthOfIdentifier = std::to_string(identifier.length()); std::string messageType = "TOVI"; bool isVisible = visibilityProperty->getStringValue() == "true"; std::string visibilityFlag = isVisible ? "T" : "F"; std::string subject = lengthOfIdentifier + identifier + visibilityFlag; // We don't need a lengthOfValue here because it will always be 1 character // Format length of subject to always be 4 digits std::ostringstream os; os << std::setfill('0') << std::setw(4) << subject.length(); std::string lengthOfSubject = os.str(); std::string message = messageType + lengthOfSubject + subject; peer->connection.sendMessage(message); }; if (visibilityProperty) { visibilityProperty->onChange(toggleVisibility); } } // Read size value or opacity value float SoftwareIntegrationModule::readFloatValue(std::vector& message) { std::string length; length.push_back(message[messageOffset]); messageOffset++; int lengthOfValue = stoi(length); std::string value; int counter = 0; while (counter != lengthOfValue) { value.push_back(message[messageOffset]); messageOffset++; counter++; } return std::stof(value); } glm::vec3 SoftwareIntegrationModule::readColor(std::vector& message) { std::string lengthOfColor; // Not used for now, but sent in message lengthOfColor.push_back(message[messageOffset]); messageOffset++; lengthOfColor.push_back(message[messageOffset]); messageOffset++; // Color is recieved in a string-format of (redValue, greenValue, blueValue) // Therefore, we have to iterate through the message and ignore characters // "( , )" and separate the values in the string std::string red; while (message[messageOffset] != ',') { if (message[messageOffset] == '(') { messageOffset++; } else { red.push_back(message[messageOffset]); messageOffset++; } } messageOffset++; std::string green; while (message[messageOffset] != ',') { green.push_back(message[messageOffset]); messageOffset++; } messageOffset++; std::string blue; while (message[messageOffset] != ')') { blue.push_back(message[messageOffset]); messageOffset++; } messageOffset++; // Convert red, green, blue strings to floats float r = std::stof(red); float g = std::stof(green); float b = std::stof(blue); return glm::vec3(r, g, b); } std::string SoftwareIntegrationModule::readGUI(std::vector& message) { std::string length; length.push_back(message[messageOffset]); messageOffset++; length.push_back(message[messageOffset]); messageOffset++; int lengthOfGuiName = stoi(length); std::string guiName; int counter = 0; while (counter != lengthOfGuiName) { guiName.push_back(message[messageOffset]); messageOffset++; counter++; } return guiName; } std::string SoftwareIntegrationModule::readIdentifier(std::vector& message) { std::string length; length.push_back(message[0]); length.push_back(message[1]); int lengthOfIdentifier = stoi(length); int counter = 0; messageOffset = 2; // Resets messageOffset std::string identifier; while (counter != lengthOfIdentifier) { identifier.push_back(message[messageOffset]); messageOffset++; counter++; } return identifier; } std::vector SoftwareIntegrationModule::readData(std::vector& message) { std::string length; int lengthOffset = messageOffset + 9; // 9 first bytes is the length of the data for (int i = messageOffset; i < lengthOffset; i++) { length.push_back(message[i]); messageOffset++; } int lengthOfData = stoi(length); int counter = 0; std::vector data; std::string value; while (counter != lengthOfData) { while (message[messageOffset] != ',') { value.push_back(message[messageOffset]); messageOffset++; counter++; } float dataValue = stof(value); data.push_back(dataValue); value = ""; messageOffset++; counter++; } return data; } size_t SoftwareIntegrationModule::nConnections() const { return _nConnections; } std::vector SoftwareIntegrationModule::documentations() const { return { RenderablePointsCloud::Documentation(), }; } } // namespace openspace