tracktion_PluginNode.h

Go to the documentation of this file.

 /*
    ,--.                     ,--.     ,--.  ,--.
  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
 
    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
*/
 
#pragma once
 
namespace tracktion { inline namespace engine
{
 
struct InputProvider;
class TrackMuteState;
 
class PluginNode final  : public tracktion::graph::Node,
                          public TracktionEngineNode
{
public:
    //==============================================================================
    PluginNode (std::unique_ptr<Node> input,
                tracktion::engine::Plugin::Ptr,
                double sampleRateToUse, int blockSizeToUse,
                const TrackMuteState*,
                ProcessState&,
                bool rendering, bool balanceLatency,
                int maxNumChannelsToUse);
 
    ~PluginNode() override;
 
    //==============================================================================
    Plugin& getPlugin()                                 { return *plugin; }
 
    tracktion::graph::NodeProperties getNodeProperties() override;
    std::vector<Node*> getDirectInputNodes() override   { return { input.get() }; }
    bool isReadyToProcess() override                    { return input->hasProcessed(); }
    void prepareToPlay (const tracktion::graph::PlaybackInitialisationInfo&) override;
    void prefetchBlock (juce::Range<int64_t>) override;
    void preProcess (choc::buffer::FrameCount, juce::Range<int64_t>) override;
    void process (ProcessContext&) override;
 
private:
    //==============================================================================
    std::unique_ptr<Node> input;
    tracktion::engine::Plugin::Ptr plugin;
 
    const TrackMuteState* trackMuteState = nullptr;
    tracktion::graph::PlayHeadState& playHeadState;
    bool isRendering = false;
 
    bool isInitialised = false;
    double sampleRate = 44100.0;
    int latencyNumSamples = 0, maxNumChannels = -1;
    tracktion::engine::MidiMessageArray midiMessageArray;
    int subBlockSizeToUse = -1;
    bool balanceLatency = true, canProcessBypassed = false;
    TimeDuration automationAdjustmentTime;
 
    std::shared_ptr<tracktion::graph::LatencyProcessor> latencyProcessor;
    std::optional<NodeProperties> cachedNodeProperties;
    bool isPrepared = false, canUseSourceBuffers = false;
 
    //==============================================================================
    void initialisePlugin (double sampleRateToUse, int blockSizeToUse);
    PluginRenderContext getPluginRenderContext (TimeRange, juce::AudioBuffer<float>&);
    void replaceLatencyProcessorIfPossible (NodeGraph*);
};
 
}} // namespace tracktion { inline namespace engine