tracktion_AutomatableEditItem.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.
*/
 
namespace tracktion { inline namespace engine
{
 
class AutomatableEditItem  : public EditItem
{
public:
    AutomatableEditItem (Edit&, const juce::ValueTree&);
    ~AutomatableEditItem() override;
 
    //==============================================================================
    virtual void flushPluginStateToValueTree();
    virtual void restorePluginStateFromValueTree (const juce::ValueTree&) { jassertfalse; }
 
    //==============================================================================
    juce::Array<AutomatableParameter*> getAutomatableParameters() const;
    int getNumAutomatableParameters() const;
    AutomatableParameter::Ptr getAutomatableParameter (int index) const     { return automatableParams[index]; }
    AutomatableParameter::Ptr getAutomatableParameterByID (const juce::String& paramID) const;
    void visitAllAutomatableParams (const std::function<void(AutomatableParameter&)>& visit) const;
 
    void deleteParameter (AutomatableParameter*);
    void deleteAutomatableParameters();
 
    int indexOfAutomatableParameter (const AutomatableParameter::Ptr&) const;
 
    AutomatableParameterTree& getParameterTree() const;
    juce::ReferenceCountedArray<AutomatableParameter> getFlattenedParameterTree() const;
 
    struct ParameterListChangeListener
    {
        virtual ~ParameterListChangeListener() {}
        virtual void parameterListChanged (AutomatableEditItem&) = 0;
    };
 
    void addParameterListChangeListener (ParameterListChangeListener*);
    void removeParameterListChangeListener (ParameterListChangeListener*);
 
    //==============================================================================
    // true if it's got any points on any params
    bool isAutomationNeeded() const noexcept                    { return automationActive.load (std::memory_order_relaxed); }
 
    // updates any automatables to their state at this time
    void setAutomatableParamPosition (TimePosition);
 
    // true if it's not been more than a few hundred ms since a block was processed
    bool isBeingActivelyPlayed() const;
 
    virtual void updateAutomatableParamPosition (TimePosition);
 
    void updateParameterStreams (TimePosition);
 
    void updateActiveParameters();
 
    void resetRecordingStatus();
 
    //==============================================================================
    juce::ValueTree elementState;
    juce::CachedValue<bool> remapOnTempoChange;
 
protected:
    virtual void buildParameterTree() const;
 
    void updateLastPlaybackTime();
    void clearParameterList();
    void addAutomatableParameter (const AutomatableParameter::Ptr&);
    void rebuildParameterTree();
 
    void saveChangedParametersToState();
 
    void restoreChangedParametersFromState();
 
private:
    RealTimeSpinLock activeParameterLock;
    juce::ReferenceCountedArray<AutomatableParameter> automatableParams, activeParameters;
    mutable AutomatableParameterTree parameterTree;
 
    mutable bool parameterTreeBuilt = false;
    std::atomic<bool> automationActive { false };
    uint32_t systemTimeOfLastPlayedBlock = 0;
    TimePosition lastTime;
 
    struct ParameterChangeListeners  : public juce::AsyncUpdater
    {
        ParameterChangeListeners (AutomatableEditItem&);
        AutomatableEditItem& owner;
        juce::ListenerList<ParameterListChangeListener> listeners;
        void handleAsyncUpdate() override;
    };
 
    std::unique_ptr<ParameterChangeListeners> parameterChangeListeners;
    void sendListChangeMessage() const;
 
    //==============================================================================
    juce::ReferenceCountedArray<AutomatableParameter> getFlattenedParameterTree (AutomatableParameterTree::TreeNode&) const;
 
    JUCE_DECLARE_WEAK_REFERENCEABLE (AutomatableEditItem)
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AutomatableEditItem)
};
 
}} // namespace tracktion { inline namespace engine