/* Part of the Fluid Corpus Manipulation Project (http://www.flucoma.org/) Copyright 2017-2019 University of Huddersfield. Licensed under the BSD-3 License. See license.md file in the project root for full license information. This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899). */ #pragma once #include "SCBufferAdaptor.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace fluid { namespace client { template class FluidSCWrapper; template struct WrapperState { typename Client::ParamSetType params; Client client; Node* mNode; std::atomic mCancelled{false}; std::atomic mJobDone{false}; std::atomic mHasTriggered{false}; std::atomic mSynchronous{false}; std::atomic mInNRT{false}; std::atomic mNodeAlive{true}; Result mResult{}; ~WrapperState() { if(!mJobDone && !mSynchronous && mHasTriggered) { std::cout << "Processing Cancelled" << std::endl; } } }; /// Named, shared clients already have a lookup table in their adaptor class template struct IsPersistent { using type = std::false_type; }; //TODO: make less tied to current implementation template struct IsPersistent>> { using type = std::true_type; }; template using IsPersistent_t = typename IsPersistent::type; /// Models don't, but still need to survive CMD-. template struct IsModel { using type = std::false_type; }; template struct IsModel>> { using type = typename ClientWrapper::isModelObject; }; template struct IsModel> { using type = typename ClientWrapper::isModelObject; }; template using IsModel_t = typename IsModel::type; namespace impl { template struct AssignBuffer { void operator()(const typename BufferT::type& p, World* w) { if (auto b = static_cast(p.get())) b->assignToRT(w); } }; template struct CleanUpBuffer { void operator()(const typename BufferT::type& p) { if (auto b = static_cast(p.get())) b->cleanUp(); } }; // Iterate over kr/ir inputs via callbacks from params object struct FloatControlsIter { FloatControlsIter(float** vals, index N) : mValues(vals), mSize(N) {} float next() { return mCount >= mSize ? 0 : *mValues[mCount++]; } void reset(float** vals) { mValues = vals; mCount = 0; } index size() const noexcept { return mSize; } index remain() { return mSize - mCount; } private: float** mValues; index mSize; index mCount{0}; }; //////////////////////////////////////////////////////////////////////////////// // Real Time Processor template class RealTime : public SCUnit { using HostVector = FluidTensorView; using ParamSetType = typename Client::ParamSetType; template struct doExpectedCount; template struct doExpectedCount { static void count(const T& d,FloatControlsIter& c,Result& status) { if(!status.ok()) return; if(c.remain()) { index statedSize = d.fixedSize; if(c.remain() < statedSize) status = {Result::Status::kError,"Ran out of arguments at ", d.name}; //fastforward for(index i=0; i < statedSize; ++i) c.next(); } } }; template struct doExpectedCount { static void count(const T& d,FloatControlsIter& c,Result& status) { if(!status.ok()) return; if(c.remain()) { index statedSize = static_cast(c.next()); if(c.remain() < statedSize) status = {Result::Status::kError,"Ran out of arguments at ", d.name}; //fastforward for(index i=0; i < statedSize; ++i) c.next(); } } }; template struct ExpectedCount{ void operator ()(const T& descriptor,FloatControlsIter& c, Result& status) { doExpectedCount::value>::count(descriptor,c,status); } }; Result expectedSize(FloatControlsIter& controls) { if(controls.size() < Client::getParameterDescriptors().count()) { return {Result::Status::kError,"Fewer parameters than exepected. Got ", controls.size(), "expect at least", Client::getParameterDescriptors().count()}; } Result countScan; Client::getParameterDescriptors().template iterate( std::forward(mWrapper->mControlsIterator), std::forward(countScan)); return countScan; } public: static index ControlOffset(Unit* unit) { return unit->mSpecialIndex + 1; } static index ControlSize(Unit* unit) { return static_cast(unit->mNumInputs) - unit->mSpecialIndex - 1 -(IsModel_t::value ? 1 : 0); } static void setup(InterfaceTable* ft, const char* name) { ft->fDefineUnitCmd(name, "latency", doLatency); } static void doLatency(Unit* unit, sc_msg_iter*) { float l[]{ static_cast(static_cast(unit)->client().latency()) }; auto ft = Wrapper::getInterfaceTable(); std::stringstream ss; ss << '/' << Wrapper::getName() << "_latency"; std::cout << ss.str() << std::endl; ft->fSendNodeReply(&unit->mParent->mNode, -1, ss.str().c_str(), 1, l); } RealTime() {} void init() { auto& client =static_cast(this)->client(); assert( !(client.audioChannelsOut() > 0 && client.controlChannelsOut() > 0) && "Client can't have both audio and control outputs"); Result r; if(!(r = expectedSize(mWrapper->mControlsIterator)).ok()) { mCalcFunc = Wrapper::getInterfaceTable()->fClearUnitOutputs; std::cout << "ERROR: " << Wrapper::getName() << " wrong number of arguments." << r.message() << std::endl; return; } mWrapper->mControlsIterator.reset(mInBuf + mSpecialIndex + 1); client.sampleRate(fullSampleRate()); mInputConnections.reserve(asUnsigned(client.audioChannelsIn())); mOutputConnections.reserve(asUnsigned(client.audioChannelsOut())); mAudioInputs.reserve(asUnsigned(client.audioChannelsIn())); mOutputs.reserve(asUnsigned( std::max(client.audioChannelsOut(), client.controlChannelsOut()))); for (index i = 0; i < client.audioChannelsIn(); ++i) { mInputConnections.emplace_back(isAudioRateIn(static_cast(i))); mAudioInputs.emplace_back(nullptr, 0, 0); } for (index i = 0; i < client.audioChannelsOut(); ++i) { mOutputConnections.emplace_back(true); mOutputs.emplace_back(nullptr, 0, 0); } for (index i = 0; i < client.controlChannelsOut(); ++i) { mOutputs.emplace_back(nullptr, 0, 0); } mCalcFunc = make_calc_function(); Wrapper::getInterfaceTable()->fClearUnitOutputs(this, 1); } void next(int) { auto& client = mWrapper->client(); auto& params = mWrapper->params(); mWrapper->mControlsIterator.reset(mInBuf + mSpecialIndex + 1); // mClient.audioChannelsIn()); Wrapper::setParams(mWrapper, params, mWrapper->mControlsIterator); // forward on inputs N + audio inputs as params params.constrainParameterValues(); const Unit* unit = this; for (index i = 0; i < client.audioChannelsIn(); ++i) { if (mInputConnections[asUnsigned(i)]) { mAudioInputs[asUnsigned(i)].reset(IN(i), 0, fullBufferSize()); } } for (index i = 0; i < client.audioChannelsOut(); ++i) { assert(i <= std::numeric_limits::max()); if (mOutputConnections[asUnsigned(i)]) mOutputs[asUnsigned(i)].reset(out(static_cast(i)), 0, fullBufferSize()); } for (index i = 0; i < client.controlChannelsOut(); ++i) { assert(i <= std::numeric_limits::max()); mOutputs[asUnsigned(i)].reset(out(static_cast(i)), 0, 1); } client.process(mAudioInputs, mOutputs, mContext); } private: std::vector mInputConnections; std::vector mOutputConnections; std::vector mAudioInputs; std::vector mOutputs; FluidContext mContext; Wrapper* mWrapper{static_cast(this)}; }; //////////////////////////////////////////////////////////////////////////////// /// Non Real Time Processor /// This is also a UGen, but the main action is delegated off to a worker /// thread, via the NRT thread. The RT bit is there to allow us (a) to poll our /// thread and (b) emit a kr progress update template class NonRealTime : public SCUnit { using ParamSetType = typename Client::ParamSetType; using SharedState = std::shared_ptr>; public: static index ControlOffset(Unit*) { return 0; } static index ControlSize(Unit* unit) { return index(unit->mNumInputs) - unit->mSpecialIndex - 2 - (IsModel_t::value ? 1 : 0); } static void setup(InterfaceTable* ft, const char* name) { ft->fDefineUnitCmd(name, "cancel", doCancel); // ft->fDefineUnitCmd( // name, "queue_enabled", [](struct Unit* unit, struct sc_msg_iter* args) { // auto w = static_cast(unit); // w->mQueueEnabled = args->geti(0); // w->mFifoMsg.Set( // w->mWorld, // [](FifoMsg* f) { // auto w = static_cast(f->mData); // w->client().setQueueEnabled(w->mQueueEnabled); // }, // nullptr, w); // Wrapper::getInterfaceTable()->fSendMsgFromRT(w->mWorld, w->mFifoMsg); // }); // ft->fDefineUnitCmd( // name, "synchronous", [](struct Unit* unit, struct sc_msg_iter* args) { // auto w = static_cast(unit); // w->mSynchronous = args->geti(0); // w->mFifoMsg.Set( // w->mWorld, // [](FifoMsg* f) { // auto w = static_cast(f->mData); // w->client().setSynchronous(w->mSynchronous); // }, // nullptr, w); // Wrapper::getInterfaceTable()->fSendMsgFromRT(w->mWorld, w->mFifoMsg); // }); } /// Penultimate input is the trigger, final is blocking mode. Neither are /// params, so we skip them in the controlsIterator NonRealTime() : mSynchronous{mNumInputs > 2 ? (in0(int(mNumInputs) - 1) > 0) : false} {} ~NonRealTime() { auto state = mWrapper->client().state(); if (state == ProcessState::kProcessing) { std::cout << Wrapper::getName() << ": Processing cancelled" << std::endl; Wrapper::getInterfaceTable()->fSendNodeReply(&mParent->mNode, 1, "/done", 0, nullptr); } // processing will be cancelled in ~NRTThreadAdaptor() } /// No option of not using a worker thread for now /// init() sets up the NRT process via the SC NRT thread, and then sets our /// UGen calc function going void init() { mWrapper->state()->mSynchronous = mSynchronous; mFifoMsg.Set(mWorld, initNRTJob, nullptr, this); // we want to poll thread roughly every 20ms checkThreadInterval = static_cast(0.02 / controlDur()); set_calc_function(); Wrapper::getInterfaceTable()->fClearUnitOutputs(this, 1); }; /// The calc function. Checks to see if we've cancelled, spits out progress, /// launches tidy up when complete void poll(int) { out0(0) = mDone ? 1.0f : static_cast(mWrapper->client().progress()); index triggerInput = static_cast(mInBuf[static_cast(mNumInputs) - mSpecialIndex - 2][0]); bool trigger = (mPreviousTrigger <= 0) && triggerInput > 0; mPreviousTrigger = triggerInput; auto& sharedState = mWrapper->state(); mWrapper->mDone = sharedState->mJobDone; if(trigger) { mWrapper->mControlsIterator.reset(mInBuf + ControlOffset(this)); Wrapper::setParams(mWrapper, mWrapper->params(), mWrapper->mControlsIterator); // forward on inputs N + audio inputs as params mWrapper->params().constrainParameterValues(); SharedState* statePtr = static_cast(mWorld->ft->fRTAlloc(mWorld, sizeof(SharedState))); statePtr = new (statePtr) SharedState(sharedState); mFifoMsg.Set(mWorld, initNRTJob, nullptr, statePtr); mWorld->ft->fSendMsgFromRT(mWorld, mFifoMsg); return; } if (0 == pollCounter++ && !sharedState->mInNRT && sharedState->mHasTriggered) { sharedState->mInNRT = true; SharedState* statePtr = static_cast(mWorld->ft->fRTAlloc(mWorld, sizeof(SharedState))); statePtr = new (statePtr) SharedState(sharedState); mWorld->ft->fDoAsynchronousCommand(mWorld, nullptr, Wrapper::getName(), statePtr, postProcess, exchangeBuffers, tidyUp, destroy, 0, nullptr); } pollCounter %= checkThreadInterval; } /// To be called on NRT thread. Validate parameters and commence processing in /// new thread static void initNRTJob(FifoMsg* f) { if(!f->mData) return; auto w = static_cast(f->mData); SharedState& s = *w; Result result = validateParameters(s->params); if (!result.ok()) { std::cout << "ERROR: " << Wrapper::getName() << ": " << result.message().c_str() << std::endl; s->mInNRT = false; return; } s->client.setSynchronous(s->mSynchronous); result = s->client.enqueue(s->params); if (!result.ok()) { std::cout << "ERROR: " << Wrapper::getName() << ": " << result.message().c_str() << std::endl; s->mInNRT = false; return; } s->mJobDone = false; s->mCancelled = false; s->mHasTriggered = true; s->mResult = s->client.process(); s->mInNRT = false; w->~SharedState(); f->mWorld->ft->fRTFree(f->mWorld,w); } /// Check result and report if bad static bool postProcess(World*, void* data) { if(!data) return false; auto& w = *static_cast(data); Result r; w->mInNRT = true; ProcessState s = w->client.checkProgress(r); if(w->mSynchronous) r = w->mResult; if ((s == ProcessState::kDone || s == ProcessState::kDoneStillProcessing) || (w->mSynchronous && s == ProcessState::kNoProcess)) // I think this hinges on the fact that // when mSynchrous = true, this call // will always be behind process() on // the command FIFO, so we can assume // that if the state is kNoProcess, it // has run (vs never having run) { // Given that cancellation from the language now always happens by freeing // the synth, this block isn't reached normally. HOwever, if someone // cancels using u_cmd, this is what will fire if (r.status() == Result::Status::kCancelled) { std::cout << Wrapper::getName() << ": Processing cancelled" << std::endl; w->mCancelled = true; w->mHasTriggered = false; w->mJobDone = true; return false; } if (!r.ok()) { if(!w->mJobDone) std::cout << "ERROR: " << Wrapper::getName() << ": " << r.message().c_str() << std::endl; w->mJobDone = true; w->mHasTriggered = false; return false; } w->mHasTriggered = false; w->mJobDone = true; return true; } return false; } /// swap NRT buffers back to RT-land static bool exchangeBuffers(World* world, void* data) { if(!data) return false; SharedState& s = *(static_cast(data)); if(!s->mNodeAlive) return false; s->params.template forEachParamType(world); // At this point, we can see if we're finished and let the language know (or // it can wait for the doneAction, but that takes extra time) use replyID to // convey status (0 = normal completion, 1 = cancelled) if (s->mJobDone && !s->mCancelled) world->ft->fSendNodeReply(s->mNode, 0, "/done", 0, nullptr); if (s->mCancelled) world->ft->fSendNodeReply(s->mNode, 1, "/done", 0, nullptr); return true; } /// Tidy up any temporary buffers static bool tidyUp(World* , void* data) { if(!data) return false; SharedState& s = *(static_cast(data)); s->params.template forEachParamType(); return true; } /// if we're properly done set the Unit done flag static void destroy(World* world, void* data) { if(!data) return; auto& s = *static_cast(data); s->mInNRT = false; s.~SharedState(); world->ft->fRTFree(world,data); } static void doCancel(Unit* unit, sc_msg_iter*) { static_cast(unit)->client().cancel(); } private: static Result validateParameters(ParamSetType& p) { auto results = p.constrainParameterValues(); for (auto& r : results) { if (!r.ok()) return r; } return {}; } template struct AssignBuffer { void operator()(const typename BufferT::type& p, World* w) { if (auto b = static_cast(p.get())) b->assignToRT(w); } }; template struct CleanUpBuffer { void operator()(const typename BufferT::type& p) { if (auto b = static_cast(p.get())) b->cleanUp(); } }; FifoMsg mFifoMsg; char* mCompletionMessage = nullptr; void* mReplyAddr = nullptr; const char* mName = nullptr; index checkThreadInterval; index pollCounter{0}; index mPreviousTrigger{0}; bool mSynchronous{true}; Wrapper* mWrapper{static_cast(this)}; Result mResult; }; //////////////////////////////////////////////////////////////////////////////// /// An impossible monstrosty template class NonRealTimeAndRealTime : public RealTime, public NonRealTime { static void setup(InterfaceTable* ft, const char* name) { RealTime::setup(ft, name); NonRealTime::setup(ft, name); } }; //////////////////////////////////////////////////////////////////////////////// //Discovery for clients that need persistent storage (Dataset and friends) template struct LifetimePolicy; //template //struct LifetimePolicy //{ //// static_assert(false,"Shared Objecthood and Model Objecthood are not compatible"); //}; /// Default policy template struct LifetimePolicy { static void constructClass(Unit* unit) { FloatControlsIter controlsReader{unit->mInBuf + Wrapper::ControlOffset(unit),Wrapper::ControlSize(unit)}; auto params = typename Wrapper::ParamSetType{Client::getParameterDescriptors()}; Wrapper::setParams(unit, params, controlsReader,true); Client client{params}; new (static_cast(unit)) Wrapper(std::move(controlsReader), std::move(client), std::move(params)); } static void destroyClass(Unit* unit) { static_cast(unit)->~Wrapper(); } static void setup(InterfaceTable*, const char*){} }; /// Model objects template struct LifetimePolicy { index uid; struct CacheRecord { typename Client::ParamSetType params{Client::getParameterDescriptors()}; Client client{params}; bool leased{false}; }; using Cache = std::unordered_map; static void constructClass(Unit* unit) { index uid = static_cast(unit->mInBuf[Wrapper::ControlOffset(unit)+Wrapper::ControlSize(unit)][0]); FloatControlsIter controlsReader{unit->mInBuf + Wrapper::ControlOffset(unit),Wrapper::ControlSize(unit)}; auto& entry = mRegistry[uid]; auto& client = entry.client; auto& params = entry.params; if(entry.leased) //if this happens, then the client has probably messed up { std::cout << "ERROR: ID " << uid << "is already being used by the cache" << std::endl; return; } Wrapper::setParams(unit, entry.params,controlsReader,true); new (static_cast(unit)) Wrapper{std::move(controlsReader),std::move(client),std::move(params)}; static_cast(unit)->uid = uid; entry.leased = true; } static void destroyClass(Unit* unit) { auto wrapper = static_cast(unit); index uid = wrapper->uid; auto pos = mRegistry.find(uid); if( pos != mRegistry.end() ) { //on cmd-. live to fight another day auto& entry = *pos; entry.second.client = std::move(wrapper->client()); entry.second.params = std::move(wrapper->params()); entry.second.leased = false; } wrapper->~Wrapper(); } static void setup(InterfaceTable* ft, const char* name) { auto freeName = std::stringstream(); freeName << "free" << name; ft->fDefinePlugInCmd(freeName.str().c_str(), [](World*,void*,sc_msg_iter* args, void*/*replyAddr*/) { auto objectID = args->geti(); auto pos = mRegistry.find(objectID); if(pos != mRegistry.end()) mRegistry.erase(objectID); }, &mRegistry); } private: static std::unordered_map mRegistry; }; template typename LifetimePolicy::Cache LifetimePolicy::mRegistry{}; /// Shared objects template struct LifetimePolicy { template struct GetSharedType; template struct GetSharedType>> { using type = NRTSharedInstanceAdaptor; }; using SharedType = typename GetSharedType::type; using ClientPointer = typename SharedType::ClientPointer; using ParamType = typename Client::ParamSetType; static void constructClass(Unit* unit) { FloatControlsIter controlsReader{unit->mInBuf + Wrapper::ControlOffset(unit),Wrapper::ControlSize(unit)}; auto params = typename Client::ParamSetType{Client::getParameterDescriptors()}; Wrapper::setParams(unit, params,controlsReader,true); auto& name = params.template get<0>(); mParamsRegistry.emplace(name, ParamType{params}); mClientRegistry.emplace(name, Client{params}); auto client = Client{params}; new (static_cast(unit)) Wrapper(std::move(controlsReader),std::move(client),std::move(params)); } static void destroyClass(Unit* unit) { static_cast(unit)->~Wrapper(); } static void setup(InterfaceTable* ft, const char* name) { auto freeName = std::stringstream(); freeName << "free" << name; ft->fDefinePlugInCmd(freeName.str().c_str(), [](World*,void*,sc_msg_iter* args, void* /*replyAddr*/) { auto objectName = std::string(args->gets()); mClientRegistry.erase(objectName); mParamsRegistry.erase(objectName); }, &mClientRegistry); } private: static ClientPointer getClientPointer(Wrapper* wrapper) { auto& params = wrapper->params(); auto name = params.template get<0>(); return SharedType::lookup(name); } static std::unordered_map mClientRegistry; static std::unordered_map mParamsRegistry; }; template std::unordered_map LifetimePolicy::mClientRegistry{}; template std::unordered_map::ParamType> LifetimePolicy::mParamsRegistry{}; //// Template Specialisations for NRT/RT template class FluidSCWrapperImpl; template class FluidSCWrapperImpl : public NonRealTime, public LifetimePolicy, IsPersistent_t> { public: void init(){ NonRealTime::init(); } static void setup(InterfaceTable* ft, const char* name) { NonRealTime::setup(ft,name); LifetimePolicy, IsPersistent_t>::setup(ft,name); } }; template class FluidSCWrapperImpl : public RealTime, public LifetimePolicy, IsPersistent_t> { public: void init(){ RealTime::init(); } static void setup(InterfaceTable* ft, const char* name) { RealTime::setup(ft,name); LifetimePolicy, IsPersistent_t>::setup(ft,name); } }; //////////////////////////////////////////////////////////////////////////////// // Make base class(es), full of CRTP mixin goodness template using FluidSCWrapperBase = FluidSCWrapperImpl, typename Client::isNonRealTime, typename Client::isRealTime>; } // namespace impl //////////////////////////////////////////////////////////////////////////////// /// The main wrapper template class FluidSCWrapper : public impl::FluidSCWrapperBase { using FloatControlsIter = impl::FloatControlsIter; using SharedState = std::shared_ptr>; //I would like to template these to something more scaleable, but baby steps friend class impl::RealTime; friend class impl::NonRealTime; template struct ParamReader { static const char* oscTagToString(char tag) { switch (tag) { case 'i': return "integer"; break; case 'f': return "float"; break; case 'd': return "double"; break; case 's': return "string"; break; case 'b': return "blob"; break; case 't': return "time tag"; break; default: return "unknown type"; } } static const char* argTypeToString(std::string&) { return "string"; } template static std::enable_if_t::value, const char*> argTypeToString(T&) { return "integer"; } template static std::enable_if_t::value, const char*> argTypeToString(T&) { return "float"; } static const char* argTypeToString(BufferT::type&) { return "buffer"; } static const char* argTypeToString(InputBufferT::type&) { return "buffer"; } template static std::enable_if_t::value,const char*> argTypeToString(P&) { return "shared_object"; //not ideal } static bool argTypeOK(std::string&, char tag) { return tag == 's'; } template static std::enable_if_t::value || std::is_floating_point::value, bool> argTypeOK(T&, char tag) { return tag == 'i' || tag == 'f' || tag == 'd'; } static bool argTypeOK(BufferT::type&, char tag) { return tag == 'i'; } static bool argTypeOK(InputBufferT::type&, char tag) { return tag == 'i'; } template static std::enable_if_t::value,bool> argTypeOK(P&, char tag) { return tag == 's'; } static auto fromArgs(Unit*, sc_msg_iter* args, std::string, int) { const char* recv = args->gets(""); return std::string(recv ? recv : ""); } static auto fromArgs(Unit* x, FloatControlsIter& args, std::string, int) { // first is string size, then chars index size = static_cast(args.next()); auto ft = FluidSCWrapper::getInterfaceTable(); auto w = x->mWorld; char* chunk = static_cast(ft->fRTAlloc(w, asUnsigned(size + 1))); if (!chunk) { std::cout << "ERROR: " << FluidSCWrapper::getName() << ": RT memory allocation failed\n"; return std::string{""}; } for (index i = 0; i < size; ++i) chunk[i] = static_cast(args.next()); chunk[size] = 0; // terminate string auto res = std::string{chunk}; ft->fRTFree(w,chunk); return res; } static auto fromArgs(Unit*, FloatControlsIter& args,typename LongArrayT::type&, int) { //first is array size, then items using Container = typename LongArrayT::type; using Value = typename Container::type; index size = static_cast(args.next()); Container res(size); for (index i = 0; i < size; ++i) res[i] = static_cast(args.next()); return res; } template static std::enable_if_t::value, T> fromArgs(Unit*, FloatControlsIter& args, T, int) { return static_cast(args.next()); } template static std::enable_if_t::value, T> fromArgs(Unit*, FloatControlsIter& args, T, int) { return args.next(); } template static std::enable_if_t::value, T> fromArgs(Unit*, sc_msg_iter* args, T, int defVal) { return args->geti(defVal); } template static std::enable_if_t::value, T> fromArgs(Unit*, sc_msg_iter* args, T, int) { return args->getf(); } static SCBufferAdaptor* fetchBuffer(Unit* x, index bufnum) { if(bufnum >= x->mWorld->mNumSndBufs) { index localBufNum = bufnum - x->mWorld->mNumSndBufs; Graph* parent = x->mParent; return localBufNum <= parent->localMaxBufNum ? new SCBufferAdaptor(parent->mLocalSndBufs + localBufNum,x->mWorld,true) : nullptr; } else return bufnum >= 0 ? new SCBufferAdaptor(bufnum, x->mWorld) : nullptr; } static auto fromArgs(Unit* x, ArgType args, BufferT::type&, int) { typename LongT::type bufnum = static_cast( ParamReader::fromArgs(x, args, typename LongT::type(), -1)); return BufferT::type(fetchBuffer(x, bufnum)); } static auto fromArgs(Unit* x, ArgType args, InputBufferT::type&, int) { typename LongT::type bufnum = static_cast(fromArgs(x, args, LongT::type(), -1)); return InputBufferT::type(fetchBuffer(x, bufnum)); } template static std::enable_if_t::value, P> fromArgs(Unit* x, ArgType args, P&, int) { return {fromArgs(x, args, std::string{}, 0).c_str()}; } }; // Iterate over arguments via callbacks from params object template struct Setter { static constexpr index argSize = C::getParameterDescriptors().template get().fixedSize; typename T::type operator()(Unit* x, ArgType args) { // Just return default if there's nothing left to grab if (args.remain() == 0) { std::cout << "WARNING: " << getName() << " received fewer parameters than expected\n"; return C::getParameterDescriptors().template makeValue(); } ParamLiteralConvertor a; using LiteralType = typename ParamLiteralConvertor::LiteralType; for (index i = 0; i < argSize; i++) a[i] = static_cast( ParamReader::fromArgs(x, args, a[0], 0)); return a.value(); } }; template using ArgumentSetter = Setter; template using ControlSetter = Setter; // CryingEmoji.png: SC API hides all the useful functions for sending // replies back to the language with things like, uh, strings and stuff. // We have Node_SendReply, which assumes you are sending an array of float, // and must be called only from the RT thread. Thanks. // So, we do in reverse what the SendReply Ugen does, and parse // an array of floats as characters in the language. VomitEmoji.png struct ToFloatArray { static index allocSize(typename BufferT::type) { return 1; } template static std::enable_if_t< std::is_integral::value || std::is_floating_point::value, index> allocSize(T) { return 1; } static index allocSize(std::string s) { return asSigned(s.size()) + 1; } // put null char at end when we send static index allocSize(FluidTensor s) { index count = 0; for (auto& str : s) count += (str.size() + 1); return count; } template static index allocSize(FluidTensor s) { return s.size(); } template static std::tuple, index> allocSize(std::tuple&& t) { return allocSizeImpl(std::forward(t), std::index_sequence_for()); }; template static std::tuple, index> allocSizeImpl(std::tuple&& t, std::index_sequence) { index size{0}; std::array res; (void) std::initializer_list{ (res[Is] = size, size += ToFloatArray::allocSize(std::get(t)), 0)...}; return std::make_tuple(res, size); // array of offsets into allocated buffer & // total number of floats to alloc }; static void convert(float* f, typename BufferT::type buf) { f[0] = static_cast(buf.get())->bufnum(); } template static std::enable_if_t::value || std::is_floating_point::value> convert(float* f, T x) { f[0] = static_cast(x); } static void convert(float* f, std::string s) { std::copy(s.begin(), s.end(), f); f[s.size()] = 0; // terminate } static void convert(float* f, FluidTensor s) { for (auto& str : s) { std::copy(str.begin(), str.end(), f); f += str.size(); *f++ = 0; } } template static void convert(float* f, FluidTensor s) { static_assert(std::is_convertible::value, "Can't convert this to float output"); std::copy(s.begin(), s.end(), f); } template static void convert(float* f, std::tuple&& t, std::array offsets, std::index_sequence) { (void) std::initializer_list{ (convert(f + offsets[Is], std::get(t)), 0)...}; } }; // So, to handle a message to a plugin we will need to // (1) Launch the invovation of the message on the SC NRT Queue using FIFO // Message (2) Run the actual function (maybe asynchronously, in our own // thread) (3) Launch an asynchronous command to send the reply back (in Stage // 3) template struct MessageDispatch { static constexpr size_t Message = N; SharedState state; ArgTuple args; Ret result; std::string name; }; // Sets up a single /u_cmd template struct SetupMessage { void operator()(const T& message) { auto ft = getInterfaceTable(); ft->fDefineUnitCmd(getName(), message.name, launchMessage); } }; template static void launchMessage(Unit* u, sc_msg_iter* args) { FluidSCWrapper* x = static_cast(u); using IndexList = typename Client::MessageSetType::template MessageDescriptorAt< N>::IndexList; if(!x->init) { std::cout << "ERROR: Synth constructor not yet called" << std::endl; return; } launchMessageImpl(x, args, IndexList()); } template static void launchMessageImpl(FluidSCWrapper* x, sc_msg_iter* inArgs, std::index_sequence) { using MessageDescriptor = typename Client::MessageSetType::template MessageDescriptorAt; using ArgTuple = typename MessageDescriptor::ArgumentTypes; using ReturnType = typename MessageDescriptor::ReturnType; using IndexList = typename MessageDescriptor::IndexList; using MessageData = MessageDispatch; auto ft = getInterfaceTable(); void* msgptr = ft->fRTAlloc(x->mWorld, sizeof(MessageData)); MessageData* msg = new (msgptr) MessageData; msg->name = '/' + Client::getMessageDescriptors().template name(); msg->state = x->state(); ArgTuple& args = msg->args; // type check OSC message std::string tags(inArgs->tags + inArgs->count);//evidently this needs commenting: construct string at pointer offset by tag count, to pick up args bool willContinue = true; bool typesMatch = true; constexpr size_t expectedArgCount = std::tuple_size::value; if(tags.size() > expectedArgCount) { std::cout << "WARNING: " << msg->name << " received more arguments than expected (got " << tags.size() << ", expect " << expectedArgCount << ")\n"; } if(tags.size() < expectedArgCount) { std::cout << "ERROR: " << msg->name << " received fewer arguments than expected (got " << tags.size() << ", expect " << expectedArgCount << ")\n"; willContinue = false; } auto tagsIter = tags.begin(); auto tagsEnd = tags.end(); ForEach(args,[&typesMatch,&tagsIter,&tagsEnd](auto& arg){ if(tagsIter == tagsEnd) { typesMatch = false; return; } char t = *(tagsIter++); typesMatch = typesMatch && ParamReader::argTypeOK(arg,t); }); willContinue = willContinue && typesMatch; if(!typesMatch) { auto& report = std::cout; report << "ERROR: " << msg->name << " type signature incorrect.\nExpect: ("; size_t i{0}; ForEach(args, [&i,&expectedArgCount,&report](auto& x){ report << ParamReader::argTypeToString(x); if(i < ( expectedArgCount - 1 ) ) { report << " ,"; } i++; }); report << ")\nReceived: ("; i = 0; for(auto t: tags) { report << ParamReader::oscTagToString(t); if( i < ( tags.size() - 1 ) ) { report << ", "; } i++; } report << ")\n"; } if(!willContinue) { msg->~MessageData(); ft->fRTFree(x->mWorld, msgptr); return; } ForEach(args,[x,&inArgs](auto& arg){ arg = ParamReader::fromArgs(x, inArgs,arg,0); }); x->client().setParams(x->params()); ft->fDoAsynchronousCommand( x->mWorld, nullptr, getName(), msg, [](World*, void* data) // NRT thread: invocation { MessageData* m = static_cast(data); m->result = ReturnType{invokeImpl(m->state, m->args, IndexList{})}; if (!m->result.ok()) printResult(m->state, m->result); return true; }, [](World* world, void* data) // RT thread: response { MessageData* m = static_cast(data); MessageDescriptor::template forEachArg(m->args, world); if(m->result.status() != Result::Status::kError) messageOutput(m->state, m->name, m->result); else { auto ft = getInterfaceTable(); if(m->state->mNodeAlive) ft->fSendNodeReply(m->state->mNode, -1, m->name.c_str(),0, nullptr); } return true; }, nullptr, // NRT Thread: No-op [](World* w, void* data) // RT thread: clean up { MessageData* m = static_cast(data); m->~MessageData(); getInterfaceTable()->fRTFree(w, data); }, 0, nullptr); } template // Call from NRT static decltype(auto) invokeImpl(SharedState& x, ArgsTuple& args, std::index_sequence) { return x->client.template invoke(x->client, std::get(args)...); } template // call from RT static void messageOutput(SharedState& x, const std::string& s, MessageResult& result) { auto ft = getInterfaceTable(); if(!x->mNodeAlive) return; // allocate return values index numArgs = ToFloatArray::allocSize(static_cast(result)); if(numArgs > 2048) { std::cout << "ERROR: Message response too big to send (" << asUnsigned(numArgs) * sizeof(float) << " bytes)." << std::endl; return; } float* values = static_cast( ft->fRTAlloc(x->mNode->mWorld, asUnsigned(numArgs) * sizeof(float))); // copy return data ToFloatArray::convert(values, static_cast(result)); ft->fSendNodeReply(x->mNode, -1, s.c_str(), static_cast(numArgs), values); } static void messageOutput(SharedState& x, const std::string& s, MessageResult&) { auto ft = getInterfaceTable(); if(!x->mNodeAlive) return; ft->fSendNodeReply(x->mNode, -1, s.c_str(), 0, nullptr); } template static void messageOutput(SharedState& x, const std::string& s, MessageResult>& result) { auto ft = getInterfaceTable(); std::array offsets; index numArgs; if(!x->mNodeAlive) return; std::tie(offsets, numArgs) = ToFloatArray::allocSize(static_cast>(result)); if(numArgs > 2048) { std::cout << "ERROR: Message response too big to send (" << asUnsigned(numArgs) * sizeof(float) << " bytes)." << std::endl; return; } float* values = static_cast( ft->fRTAlloc(x->mNode->mWorld, asUnsigned(numArgs) * sizeof(float))); ToFloatArray::convert(values, std::tuple(result), offsets, std::index_sequence_for()); ft->fSendNodeReply(x->mNode, -1, s.c_str(), static_cast(numArgs), values); } static void doVersion(Unit*, sc_msg_iter*) { std::cout << "Fluid Corpus Manipualtion Toolkit version " << fluidVersion() << std::endl; } bool init{false}; public: using Client = C; using ParamSetType = typename C::ParamSetType; FluidSCWrapper(FloatControlsIter&& i, Client&& c, ParamSetType&& p): mControlsIterator{std::move(i)}, mState{new WrapperState{std::move(p),std::move(c),&SCUnit::mParent->mNode}} { client().setParams(params()); //<-IMPORTANT: client's ref to params is by address, and this has just changed impl::FluidSCWrapperBase::init(); init = true; } ~FluidSCWrapper() { mState->mNodeAlive = false; } std::shared_ptr>& state() { return mState; } static const char* getName(const char* setName = nullptr) { static const char* name = nullptr; return (name = setName ? setName : name); } static InterfaceTable* getInterfaceTable(InterfaceTable* setTable = nullptr) { static InterfaceTable* ft = nullptr; return (ft = setTable ? setTable : ft); } static void setup(InterfaceTable* ft, const char* name) { getName(name); getInterfaceTable(ft); registerUnit(ft, name); impl::FluidSCWrapperBase::setup(ft, name); Client::getMessageDescriptors().template iterate(); ft->fDefineUnitCmd(name, "version", doVersion); } static auto& setParams(Unit* x, ParamSetType& p, FloatControlsIter& inputs, bool constrain = false) { //TODO: Regain this robustness if possible? // We won't even try and set params if the arguments don't match // if (inputs.size() == C::getParameterDescriptors().count()) // { p.template setParameterValues(x->mWorld->mVerbosity > 0, x, inputs); if (constrain) p.constrainParameterValues(); // } // else // { // std::cout << "ERROR: " << getName() // << ": parameter count mismatch. Perhaps your binary plugins " // "and SC sources are different versions" // << std::endl; // } return p; } static void printResult(SharedState& x, Result& r) { if (!x.get() || !x->mNodeAlive) return; switch (r.status()) { case Result::Status::kWarning: { if (x->mNode->mWorld->mVerbosity > 0) std::cout << "WARNING: " << r.message().c_str() << '\n'; break; } case Result::Status::kError: { std::cout << "ERROR: " << r.message().c_str() << '\n'; break; } case Result::Status::kCancelled: { std::cout << "Task cancelled\n" << '\n'; break; } default: { } } } auto& client() { return mState->client; } auto& params() { return mState->params; } private: static void registerUnit(InterfaceTable* ft, const char* name) { UnitCtorFunc ctor =impl::FluidSCWrapperBase::constructClass; UnitDtorFunc dtor = impl::FluidSCWrapperBase::destroyClass; (*ft->fDefineUnit)(name, sizeof(FluidSCWrapper), ctor, dtor, 0); } FloatControlsIter mControlsIterator; std::shared_ptr> mState; }; template void makeSCWrapper(const char* name, InterfaceTable* ft) { FluidSCWrapper::setup(ft, name); } } // namespace client } // namespace fluid