/* * This file is part of vimix - video live mixer * * **Copyright** (C) 2020-2021 Bruno Herbelin * * 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 3 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, see . **/ #include #include #include #include "osc/OscOutboundPacketStream.h" #include "Log.h" #include "Settings.h" #include "BaseToolkit.h" #include "Mixer.h" #include "Source.h" #include "ControlManager.h" #ifndef NDEBUG #define CONTROL_DEBUG #endif #define CONTROL_OSC_MSG "OSC: " void Control::RequestListener::ProcessMessage( const osc::ReceivedMessage& m, const IpEndpointName& remoteEndpoint ) { char sender[IpEndpointName::ADDRESS_AND_PORT_STRING_LENGTH]; remoteEndpoint.AddressAndPortAsString(sender); try{ #ifdef CONTROL_DEBUG Log::Info(CONTROL_OSC_MSG "received '%s' from %s", m.AddressPattern(), sender); #endif // TODO Preprocessing with Translator // structured OSC address std::list address = BaseToolkit::splitted(m.AddressPattern(), OSC_SEPARATOR); // // A wellformed OSC address is in the form '/vimix/target/attribute {arguments}' // First test: should have 3 elements and start with APP_NAME ('vimix') // if (address.size() > 2 && address.front().compare(OSC_PREFIX) == 0 ){ // done with the first part of the OSC address address.pop_front(); // next part of the OSC message is the target std::string target = address.front(); // next part of the OSC message is the attribute address.pop_front(); std::string attribute = address.front(); // Log target: just print text in log window if ( target.compare(OSC_INFO) == 0 ) { if ( attribute.compare(OSC_INFO_SYNC) == 0) { // send the global status Control::manager().sendStatus(remoteEndpoint); // // send the status of all sources // // (if an argument is given, it indicates the number of sources to update) float N = 0.f; if ( !m.ArgumentStream().Eos()) m.ArgumentStream() >> N >> osc::EndMessage; // send the status of all sources Control::manager().sendSourcesStatus(remoteEndpoint, N); } else if ( attribute.compare(OSC_INFO_LOG) == 0) Log::Info(CONTROL_OSC_MSG "received '%s' from %s", m.AddressPattern(), sender); } // Output target: concerns attributes of the rendering output else if ( target.compare(OSC_OUTPUT) == 0 ) { Control::manager().receiveOutputAttribute(attribute, m.ArgumentStream()); } // ALL sources target: apply attribute to all sources of the session else if ( target.compare(OSC_ALL) == 0 ) { // Loop over selected sources for (SourceList::iterator it = Mixer::manager().session()->begin(); it != Mixer::manager().session()->end(); ++it) { // attributes operate on current source Control::manager().receiveSourceAttribute( *it, attribute, m.ArgumentStream()); } } // Selected sources target: apply attribute to all sources of the selection else if ( target.compare(OSC_SELECTED) == 0 ) { // Loop over selected sources for (SourceList::iterator it = Mixer::selection().begin(); it != Mixer::selection().end(); ++it) { // attributes operate on current source Control::manager().receiveSourceAttribute( *it, attribute, m.ArgumentStream()); } } // Current source target: apply attribute to the current sources else if ( target.compare(OSC_CURRENT) == 0 ) { int sourceid = -1; if ( attribute.compare(OSC_NEXT) == 0) { // set current to NEXT Mixer::manager().setCurrentNext(); // confirm by sending back the current source attributes Control::manager().sendCurrentSourceAttibutes(remoteEndpoint); // send the updated status of all sources Control::manager().sendSourcesStatus(remoteEndpoint); } else if ( attribute.compare(OSC_PREVIOUS) == 0) { // set current to PREVIOUS Mixer::manager().setCurrentPrevious(); // confirm by sending back the current source attributes Control::manager().sendCurrentSourceAttibutes(remoteEndpoint); // send the updated status of all sources Control::manager().sendSourcesStatus(remoteEndpoint); } else if ( BaseToolkit::is_a_number( attribute.substr(1), &sourceid) ){ // set current to given INDEX Mixer::manager().setCurrentIndex(sourceid); // confirm by sending back the current source attributes Control::manager().sendCurrentSourceAttibutes(remoteEndpoint); // // send the status of all sources // // (if an argument is given, it indicates the number of sources to update) float N = 0.f; if ( !m.ArgumentStream().Eos()) m.ArgumentStream() >> N >> osc::EndMessage; Control::manager().sendSourcesStatus(remoteEndpoint, N); } // all other attributes operate on current source else Control::manager().receiveSourceAttribute( Mixer::manager().currentSource(), attribute, m.ArgumentStream()); } // General case: try to identify the target else { // remove osc separator target.erase(0,1); // try to find source by name Source *s = Mixer::manager().findSource(target); // if failed, try to find source by index int sourceid = -1; if (s == nullptr && BaseToolkit::is_a_number(target, &sourceid) ) s = Mixer::manager().sourceAtIndex(sourceid); // if a source with the given target nameor index was found if (s) Control::manager().receiveSourceAttribute(s, attribute, m.ArgumentStream()); else Log::Info(CONTROL_OSC_MSG "Unknown target '%s' requested by %s.", target.c_str(), sender); } } #ifdef CONTROL_DEBUG else { Log::Info(CONTROL_OSC_MSG "Ignoring malformed message '%s' from %s.", m.AddressPattern(), sender); } #endif } catch( osc::Exception& e ){ // any parsing errors such as unexpected argument types, or // missing arguments get thrown as exceptions. Log::Info(CONTROL_OSC_MSG "Ignoring error in message '%s' from %s : %s", m.AddressPattern(), sender, e.what()); } } void Control::listen() { #ifdef CONTROL_DEBUG Log::Info(CONTROL_OSC_MSG "Accepting messages on port %d", Settings::application.control.osc_port_receive); #endif if (Control::manager().receiver_) Control::manager().receiver_->Run(); } Control::Control() : receiver_(nullptr) { } Control::~Control() { if (receiver_!=nullptr) { receiver_->Break(); delete receiver_; } } bool Control::init() { try { // try to create listenning socket // through exception runtime if fails receiver_ = new UdpListeningReceiveSocket( IpEndpointName( IpEndpointName::ANY_ADDRESS, Settings::application.control.osc_port_receive ), &listener_ ); } catch (const std::runtime_error&) { // arg, the receiver could not be initialized // because the port was not available receiver_ = nullptr; } // listen for answers std::thread(listen).detach(); return receiver_ != nullptr; } void Control::terminate() { if (receiver_!=nullptr) receiver_->AsynchronousBreak(); } void Control::receiveOutputAttribute(const std::string &attribute, osc::ReceivedMessageArgumentStream arguments) { try { /// e.g. '/vimix/output/enable' or '/vimix/output/enable T' or '/vimix/output/enable F' if ( attribute.compare(OSC_OUTPUT_ENABLE) == 0) { float on = 1.f; if ( !arguments.Eos()) { arguments >> on >> osc::EndMessage; } Settings::application.render.disabled = on < 0.5f; } /// e.g. '/vimix/output/disable' or '/vimix/output/disable T' or '/vimix/output/disable F' else if ( attribute.compare(OSC_OUTPUT_DISABLE) == 0) { float on = 1.f; if ( !arguments.Eos()) { arguments >> on >> osc::EndMessage; } Settings::application.render.disabled = on > 0.5f; } /// e.g. '/vimix/output/fading f 0.2' else if ( attribute.compare(OSC_OUTPUT_FADING) == 0) { float fading = 0.f; arguments >> fading >> osc::EndMessage; Mixer::manager().session()->setFading(fading); // TODO move cursor when in Mixing view } #ifdef CONTROL_DEBUG else { Log::Info(CONTROL_OSC_MSG "Ignoring attribute '%s' for target 'output'", attribute.c_str()); } #endif } catch (osc::MissingArgumentException &e) { Log::Info(CONTROL_OSC_MSG "Missing argument for attribute '%s' for target 'output'", attribute.c_str()); } catch (osc::ExcessArgumentException &e) { Log::Info(CONTROL_OSC_MSG "Too many arguments for attribute '%s' for target 'output'", attribute.c_str()); } catch (osc::WrongArgumentTypeException &e) { Log::Info(CONTROL_OSC_MSG "Invalid argument for attribute '%s' for target 'output'", attribute.c_str()); } } void Control::receiveSourceAttribute(Source *target, const std::string &attribute, osc::ReceivedMessageArgumentStream arguments) { if (target == nullptr) return; try { /// e.g. '/vimix/current/play' or '/vimix/current/play T' or '/vimix/current/play F' if ( attribute.compare(OSC_SOURCE_PLAY) == 0) { float on = 1.f; if ( !arguments.Eos()) { arguments >> on >> osc::EndMessage; } target->call( new SetPlay(on > 0.5f) ); } /// e.g. '/vimix/current/pause' or '/vimix/current/pause T' or '/vimix/current/pause F' else if ( attribute.compare(OSC_SOURCE_PAUSE) == 0) { float on = 1.f; if ( !arguments.Eos()) { arguments >> on >> osc::EndMessage; } target->call( new SetPlay(on < 0.5f) ); } /// e.g. '/vimix/current/replay' else if ( attribute.compare(OSC_SOURCE_REPLAY) == 0) { target->call( new RePlay() ); } /// e.g. '/vimix/current/alpha f 0.3' else if ( attribute.compare(OSC_SOURCE_ALPHA) == 0) { float x = 1.f; arguments >> x >> osc::EndMessage; target->call( new SetAlpha(x), true ); } /// e.g. '/vimix/current/transparency f 0.7' else if ( attribute.compare(OSC_SOURCE_TRANSPARENCY) == 0) { float x = 0.f; arguments >> x >> osc::EndMessage; target->call( new SetAlpha(1.f - x), true ); } /// e.g. '/vimix/current/depth f 5.0' else if ( attribute.compare(OSC_SOURCE_DEPTH) == 0) { float x = 0.f; arguments >> x >> osc::EndMessage; target->call( new SetDepth(x) ); } /// e.g. '/vimix/current/translation ff 10.0 2.2' else if ( attribute.compare(OSC_SOURCE_GRAB) == 0) { float x = 0.f, y = 0.f; arguments >> x >> y >> osc::EndMessage; target->call( new Grab( x, y), true ); } /// e.g. '/vimix/current/scale ff 10.0 2.2' else if ( attribute.compare(OSC_SOURCE_RESIZE) == 0) { float x = 0.f, y = 0.f; arguments >> x >> y >> osc::EndMessage; target->call( new Resize( x, y), true ); } /// e.g. '/vimix/current/turn f 1.0' else if ( attribute.compare(OSC_SOURCE_TURN) == 0) { float x = 0.f; arguments >> x >> osc::EndMessage; target->call( new Turn( x ), true ); } /// e.g. '/vimix/current/reset' else if ( attribute.compare(OSC_SOURCE_RESET) == 0) { target->call( new ResetGeometry(), true ); } #ifdef CONTROL_DEBUG else { Log::Info(CONTROL_OSC_MSG "Ignoring attribute '%s' for target %s.", attribute.c_str(), target->name().c_str()); } #endif } catch (osc::MissingArgumentException &e) { Log::Info(CONTROL_OSC_MSG "Missing argument for attribute '%s' for target %s.", attribute.c_str(), target->name().c_str()); } catch (osc::ExcessArgumentException &e) { Log::Info(CONTROL_OSC_MSG "Too many arguments for attribute '%s' for target %s.", attribute.c_str(), target->name().c_str()); } catch (osc::WrongArgumentTypeException &e) { Log::Info(CONTROL_OSC_MSG "Invalid argument for attribute '%s' for target %s.", attribute.c_str(), target->name().c_str()); } } void Control::sendCurrentSourceAttibutes(const IpEndpointName &remoteEndpoint) { // default values char name[21] = {"\0"}; float play = 0.f; float depth = 0.f; float alpha = 0.f; // fill values if the current source is valid Source *s = Mixer::manager().currentSource(); if (s!=nullptr) { strncpy(name, s->name().c_str(), 20); play = s->playing() ? 1.f : 0.f; depth = s->depth(); alpha = s->alpha(); } // build socket to send message to indicated endpoint UdpTransmitSocket socket( IpEndpointName( remoteEndpoint.address, Settings::application.control.osc_port_send ) ); // build messages packet char buffer[IP_MTU_SIZE]; osc::OutboundPacketStream p( buffer, IP_MTU_SIZE ); // create bundle p.Clear(); p << osc::BeginBundle(); /// name p << osc::BeginMessage( OSC_PREFIX OSC_CURRENT OSC_SOURCE_NAME ) << name << osc::EndMessage; /// Play status p << osc::BeginMessage( OSC_PREFIX OSC_CURRENT OSC_SOURCE_PLAY ) << play << osc::EndMessage; /// Depth p << osc::BeginMessage( OSC_PREFIX OSC_CURRENT OSC_SOURCE_DEPTH ) << depth << osc::EndMessage; /// Alpha p << osc::BeginMessage( OSC_PREFIX OSC_CURRENT OSC_SOURCE_ALPHA ) << alpha << osc::EndMessage; // send bundle p << osc::EndBundle; socket.Send( p.Data(), p.Size() ); } void Control::sendSourcesStatus(const IpEndpointName &remoteEndpoint, float max_count) { // build socket to send message to indicated endpoint UdpTransmitSocket socket( IpEndpointName( remoteEndpoint.address, Settings::application.control.osc_port_send ) ); // build messages packet char buffer[IP_MTU_SIZE]; osc::OutboundPacketStream p( buffer, IP_MTU_SIZE ); p.Clear(); p << osc::BeginBundle(); int i = 0; char oscaddr[128]; int index_current = Mixer::manager().indexCurrentSource(); for (; i < Mixer::manager().count(); ++i) { // send status of currently selected sprintf(oscaddr, OSC_PREFIX OSC_CURRENT "/%d", i); p << osc::BeginMessage( oscaddr ) << (index_current == i ? 1.f : 0.f) << osc::EndMessage; // send status of alpha sprintf(oscaddr, OSC_PREFIX "/%d" OSC_SOURCE_ALPHA, i); p << osc::BeginMessage( oscaddr ) << Mixer::manager().sourceAtIndex(i)->alpha() << osc::EndMessage; } for (; i < max_count; ++i) { // reset status of currently selected sprintf(oscaddr, OSC_PREFIX OSC_CURRENT "/%d", i); p << osc::BeginMessage( oscaddr ) << 0.f << osc::EndMessage; // reset status of alpha sprintf(oscaddr, OSC_PREFIX "/%d" OSC_SOURCE_ALPHA, i); p << osc::BeginMessage( oscaddr ) << 0.f << osc::EndMessage; } p << osc::EndBundle; socket.Send( p.Data(), p.Size() ); } void Control::sendStatus(const IpEndpointName &remoteEndpoint) { // build socket to send message to indicated endpoint UdpTransmitSocket socket( IpEndpointName( remoteEndpoint.address, Settings::application.control.osc_port_send ) ); // build messages packet char buffer[IP_MTU_SIZE]; osc::OutboundPacketStream p( buffer, IP_MTU_SIZE ); p.Clear(); p << osc::BeginBundle(); /// /// messages /// /// Agree to test p << osc::BeginMessage( OSC_PREFIX OSC_INFO OSC_INFO_SYNC ); p << true; p << osc::EndMessage; /// output attributes p << osc::BeginMessage( OSC_PREFIX OSC_OUTPUT OSC_OUTPUT_ENABLE ); p << (Settings::application.render.disabled ? 0.f : 1.f); p << osc::EndMessage; p << osc::BeginMessage( OSC_PREFIX OSC_OUTPUT OSC_OUTPUT_FADING ); p << Mixer::manager().session()->fading(); p << osc::EndMessage; p << osc::EndBundle; socket.Send( p.Data(), p.Size() ); }