FlowGraphNode.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef FlowGraphNode_h
#define FlowGraphNode_h
 
class OscilloscopeChannel;
class WaveformBase;
class StreamDescriptor;
class InputDescriptor;
class InputConstraint;
 
#include "FilterParameter.h"
#include "Waveform.h"
#include "Stream.h"
#include "SerializableObject.h"
#include "log.h"
 
 
class FlowGraphNodeMessage
{
public:
    FlowGraphNodeMessage(Severity severity, const std::string& title, const std::string& msg)
    : m_severity(severity), m_title(title), m_message(msg) {}
    Severity GetSeverity() const { return m_severity; }
    const std::string& GetTitle() const {return m_title; }
    const std::string& GetMessage() const {return m_message; }
private:
    Severity m_severity;
    std::string m_title;
    std::string m_message;
};
 
class FlowGraphNode : public SerializableObject
{
public:
    FlowGraphNode();
    virtual ~FlowGraphNode();
 
    void DetachInputs();
 
    //Inputs
public:
    size_t GetInputCount();
    std::string GetInputName(size_t i);
 
    void SetInput(size_t i, StreamDescriptor stream, bool force = false);
    void SetInput(const std::string& name, StreamDescriptor stream, bool force = false);
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream);
 
    bool HasInput(StreamDescriptor desc);
 
    StreamDescriptor GetInput(size_t i);
    std::shared_ptr<InputConstraint> GetInputConstraints(size_t i);
 
protected:
    virtual void OnInputChanged(size_t i);
 
    //Parameters
public:
    FilterParameter& GetParameter(std::string s);
 
    typedef std::map<std::string, FilterParameter> ParameterMapType;
 
    bool HasParameter(std::string s)
    { return (m_parameters.find(s) != m_parameters.end()); }
 
    ParameterMapType::iterator GetParamBegin()
    { return m_parameters.begin(); }
 
    ParameterMapType::iterator GetParamEnd()
    { return m_parameters.end(); }
 
    size_t GetParamCount()
    { return m_parameters.size(); }
 
    virtual YAML::Node SerializeConfiguration(IDTable& table);
 
    virtual void LoadParameters(const YAML::Node& node, IDTable& table);
    virtual void LoadInputs(const YAML::Node& node, IDTable& table);
 
    bool IsDownstreamOf(std::set<FlowGraphNode*> nodes);
 
    // Tail call optimization etc
 
    enum class ExecutionCapabilities
    {
        //Nothing special
        None                    = 0,
 
        //Node does not call begin() on the command buffer, executor must do that for us
        CommandBufferAppend     = 1,
 
        //Node does not call SubmitAndBlock() on the command buffer, executor must do that for us
        CommandBufferTailCall   = 2,
 
        //Node has essentially zero CPU-side compute, refresh just enqueues stuff
        VulkanOnly              = 4,
 
        //Node supports dynamic shader generation
        DynamicShader           = 8
    };
 
    virtual uint32_t GetExecutionCapabilitiesMask()
    { return (uint32_t) ExecutionCapabilities::None; }
 
    // Filter evaluation
 
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) =0;
 
    // Error detection and reporting
public:
 
    bool HasMessages() const
    { return not m_messages.empty(); }
 
    const std::vector<FlowGraphNodeMessage>& GetMessages() const
    { return m_messages; }
 
    const FlowGraphNodeMessage* GetMostSevereMessage() const;
 
    //Input handling helpers
protected:
 
    WaveformBase* GetInputWaveform(size_t i);   //implementation in FlowGraphNode_inlines.h
 
    SparseAnalogWaveform* GetSparseAnalogInputWaveform(size_t i)
    { return dynamic_cast<SparseAnalogWaveform*>(GetInputWaveform(i)); }
 
    UniformAnalogWaveform* GetUniformAnalogInputWaveform(size_t i)
    { return dynamic_cast<UniformAnalogWaveform*>(GetInputWaveform(i)); }
 
    SparseDigitalWaveform* GetSparseDigitalInputWaveform(size_t i)
    { return dynamic_cast<SparseDigitalWaveform*>(GetInputWaveform(i)); }
 
    UniformDigitalWaveform* GetUniformDigitalInputWaveform(size_t i)
    { return dynamic_cast<UniformDigitalWaveform*>(GetInputWaveform(i)); }
 
    //SparseDigitalBusWaveform* GetSparseDigitalBusInputWaveform(size_t i)
    //{ return dynamic_cast<SparseDigitalBusWaveform*>(GetInputWaveform(i)); }
 
    virtual void CreateInput(const std::string& name);
 
    //Helper for creating a stream with constraints
    template<class T, class... Args>
    void CreateInput(const std::string& name, Args&&... args);
 
    std::string GetInputDisplayName(size_t i);
 
public:
    //Sink management (used for special stuff that doesn't call SetInput directly)
    void AddSink(size_t stream, FlowGraphNode* node)
    { m_sinks[stream].emplace(node); }
 
    void RemoveSink(size_t stream, FlowGraphNode* node)
    { m_sinks[stream].erase(node); }
 
    const std::set<FlowGraphNode*>& GetSinks(size_t stream)
    { return m_sinks[stream]; }
 
protected:
 
    std::vector< std::shared_ptr<InputDescriptor> > m_inputs;
 
    std::vector< std::set<FlowGraphNode*> > m_sinks;
 
    //Parameters
    ParameterMapType m_parameters;
 
public:
 
    sigc::signal<void()> signal_parametersChanged()
    { return m_parametersChangedSignal; }
 
    sigc::signal<void()> signal_inputsChanged()
    { return m_inputsChangedSignal; }
 
protected:
 
    void ClearMessages()
    { m_messages.clear(); }
 
    void AddMessage(const FlowGraphNodeMessage& msg)
    { m_messages.push_back(msg); }
 
    void AddMessage(Severity severity, const std::string& title, const std::string& message)
    { AddMessage(FlowGraphNodeMessage(severity, title, message)); }
 
    void AddErrorMessage(const std::string& err)
    { AddErrorMessage("Unknown", std::string("• ") + err); }
 
    void AddErrorMessage(const std::string& title, const std::string& err)
    { AddMessage(Severity::ERROR, title, err); }
 
    sigc::signal<void()> m_parametersChangedSignal;
 
    sigc::signal<void()> m_inputsChangedSignal;
 
    //@brief All the messages the Node accumulates
    std::vector<FlowGraphNodeMessage> m_messages;
};
 
#endif