tracktion_LFOModifier.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 LFOModifier   : public Modifier,
                      private ValueTreeAllEventListener
{
public:
    LFOModifier (Edit&, const juce::ValueTree&);
    ~LFOModifier() override;
 
    using Ptr = juce::ReferenceCountedObjectPtr<LFOModifier>;
    using Array = juce::ReferenceCountedArray<LFOModifier>;
 
    using Modifier::initialise;
    void initialise() override;
    juce::String getName() const override               { return TRANS("LFO Modifier"); }
 
    //==============================================================================
    float getCurrentValue() override;
 
    float getCurrentPhase() const;
 
    AutomatableParameter::ModifierAssignment* createAssignment (const juce::ValueTree&) override;
 
    ProcessingPosition getProcessingPosition() override { return ProcessingPosition::preFX; }
 
    void applyToBuffer (const PluginRenderContext&) override;
 
    //==============================================================================
    struct Assignment : public AutomatableParameter::ModifierAssignment
    {
        Assignment (const juce::ValueTree&, const LFOModifier&);
 
        bool isForModifierSource (const ModifierSource&) const override;
        juce::ReferenceCountedObjectPtr<LFOModifier> getLFOModifier() const;
 
        const EditItemID lfoModifierID;
 
        JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Assignment)
    };
 
    //==============================================================================
    juce::String getSelectableDescription() override    { return getName(); }
 
    //==============================================================================
    enum Wave
    {
        waveSine        = 0,
        waveTriangle    = 1,
        waveSawUp       = 2,
        waveSawDown     = 3,
        waveSquare      = 4,
        fourStepsUp     = 5,
        fourStepsDown   = 6,
        eightStepsUp    = 7,
        eightStepsDown  = 8,
        random          = 9,
        noise           = 10
    };
 
    static juce::StringArray getWaveNames();
 
    juce::CachedValue<float> wave, syncType, rate, rateType, depth, bipolar, phase, offset;
 
    AutomatableParameter::Ptr waveParam, syncTypeParam, rateParam, rateTypeParam, depthParam, bipolarParam, phaseParam, offsetParam;
 
private:
    struct LFOModifierTimer;
    std::unique_ptr<LFOModifierTimer> modifierTimer;
 
    LambdaTimer changedTimer;
    std::atomic<float> currentPhase { 0.0f }, currentValue { 0.0f };
 
    void valueTreeChanged() override;
};
 
}} // namespace tracktion { inline namespace engine