tracktion_Modifier.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
{
 
struct ModifierTimer
{
    virtual ~ModifierTimer() = default;
    virtual void updateStreamTime (TimePosition editTime, int numSamples) = 0;
};
 
//==============================================================================
struct Modifier : public AutomatableEditItem,
                  public Selectable,
                  public AutomatableParameter::ModifierSource,
                  public juce::ReferenceCountedObject
{
    using Ptr = juce::ReferenceCountedObjectPtr<Modifier>;
    using Array = juce::ReferenceCountedArray<Modifier>;
 
    Modifier (Edit&, const juce::ValueTree&);
    ~Modifier() override;
 
    void remove();
 
    virtual void initialise() = 0;
 
    virtual float getCurrentValue() = 0;
 
    virtual AutomatableParameter::ModifierAssignment* createAssignment (const juce::ValueTree&) = 0;
 
    //==============================================================================
    virtual juce::StringArray getMidiInputNames()               { return {}; }
 
    virtual juce::StringArray getAudioInputNames()              { return {}; }
 
    enum class ProcessingPosition
    {
        none,   
        preFX,  
        postFX  
    };
 
    virtual ProcessingPosition getProcessingPosition()          { return ProcessingPosition::none; }
 
    //==============================================================================
    virtual void initialise (double /*sampleRate*/, int /*blockSizeSamples*/) {}
    virtual void deinitialise() {}
    virtual void applyToBuffer (const PluginRenderContext&) {}
 
    //==============================================================================
    bool baseClassNeedsInitialising() const noexcept            { return initialiseCount == 0; }
    void baseClassInitialise (double sampleRate, int blockSizeSamples);
    void baseClassDeinitialise();
    void baseClassApplyToBuffer (const PluginRenderContext&);
 
    //==============================================================================
    static constexpr TimeDuration maxHistoryTime = TimeDuration::fromSeconds (3.0);
 
    TimePosition getCurrentTime() const;
 
    float getValueAt (TimeDuration numSecondsBeforeNow) const;
 
    std::vector<float> getValues (TimeDuration numSecondsBeforeNow) const;
 
    //==============================================================================
    juce::ValueTree state;                  
    juce::CachedValue<juce::Colour> colour; 
    juce::CachedValue<float> enabled;       
    AutomatableParameter::Ptr enabledParam; 
    double getSampleRate() const                                { return sampleRate; }
 
    void selectableAboutToBeDeleted() override;
 
protected:
    void setEditTime (TimePosition newEditTime)                 { lastEditTime = newEditTime; }
 
private:
    int initialiseCount = 0;
    double sampleRate = 44100.0;
    std::atomic<TimePosition> lastEditTime { TimePosition() };
 
    class ValueFifo;
    std::unique_ptr<ValueFifo> valueFifo, messageThreadValueFifo;
    mutable choc::fifo::SingleReaderSingleWriterFIFO<std::pair<int, float>> valueFifoQueue;
};
 
//==============================================================================
class ModifierList  : public juce::ChangeBroadcaster,
                      private ValueTreeObjectList<Modifier>
{
public:
    ModifierList (Edit&, const juce::ValueTree&);
    ~ModifierList() override;
 
    static bool isModifier (const juce::Identifier&);
 
    juce::ReferenceCountedArray<Modifier> getModifiers() const;
 
    //==============================================================================
    juce::ReferenceCountedObjectPtr<Modifier> insertModifier (juce::ValueTree, int index, SelectionManager*);
 
    //==============================================================================
    bool isSuitableType (const juce::ValueTree&) const override;
    Modifier* createNewObject (const juce::ValueTree&) override;
    void deleteObject (Modifier*) override;
 
    void newObjectAdded (Modifier*) override;
    void objectRemoved (Modifier*) override;
    void objectOrderChanged() override;
 
    Edit& edit;
    juce::ValueTree state;
};
 
//==============================================================================
template<typename ModifierType>
juce::ReferenceCountedArray<ModifierType> getModifiersOfType (const ModifierList& ml)
{
    juce::ReferenceCountedArray<ModifierType> mods;
 
    for (auto m : ml.getModifiers())
        if (auto type = dynamic_cast<ModifierType*> (m))
            mods.add (type);
 
    return mods;
}
 
Modifier::Ptr findModifierForID (ModifierList&, EditItemID);
 
}} // namespace tracktion { inline namespace engine