Component.h

/******************************************************************************
DSPatch - The Refreshingly Simple C++ Dataflow Framework
Copyright (c) 2023, Marcus Tomlinson
 
BSD 2-Clause License
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
2. 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.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS BE 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.
******************************************************************************/
 
#pragma once
 
#include <dspatch/SignalBus.h>
 
#include <string>
#include <vector>
 
namespace DSPatch
{
 
namespace internal
{
class Component;
class ComponentThread;
}  // namespace internal
 
 
class DLLEXPORT Component
{
public:
    NONCOPYABLE( Component );
 
    using SPtr = std::shared_ptr<Component>;
    using SCPtr = std::shared_ptr<const Component>;
 
    enum class ProcessOrder
    {
        InOrder,
        OutOfOrder
    };
 
    enum class TickMode
    {
        Series,
        Parallel
    };
 
    Component( ProcessOrder processOrder = ProcessOrder::InOrder );
    virtual ~Component();
 
    bool ConnectInput( const Component::SPtr& fromComponent, int fromOutput, int toInput );
 
    void DisconnectInput( int inputNo );
    void DisconnectInput( const Component::SCPtr& fromComponent );
    void DisconnectAllInputs();
 
    int GetInputCount() const;
    int GetOutputCount() const;
 
    std::string GetInputName( int inputNo ) const;
    std::string GetOutputName( int outputNo ) const;
 
    void SetBufferCount( int bufferCount );
    int GetBufferCount() const;
 
    void Tick( TickMode mode = TickMode::Series, int bufferNo = 0 );
    void Reset( TickMode mode = TickMode::Series, int bufferNo = 0 );
 
protected:
    virtual void Process_( SignalBus&, SignalBus& ) = 0;
 
    void SetInputCount_( int inputCount, const std::vector<std::string>& inputNames = {} );
    void SetOutputCount_( int outputCount, const std::vector<std::string>& outputNames = {} );
 
private:
    friend class internal::ComponentThread;
    void _DoTick( Component::TickMode mode, int bufferNo );
 
    internal::Component* p;
};
 
}  // namespace DSPatch