juce_AudioProcessorParameter.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
class AudioProcessor;
 
//==============================================================================
class JUCE_API  AudioProcessorParameter
{
public:
    AudioProcessorParameter() noexcept = default;

    explicit AudioProcessorParameter (int versionHint)
        : version (versionHint) {}

    virtual ~AudioProcessorParameter();

    virtual float getValue() const = 0;

    virtual void setValue (float newValue) = 0;

    void setValueNotifyingHost (float newValue);

    void beginChangeGesture();

    void endChangeGesture();

    virtual float getDefaultValue() const = 0;

    virtual String getName (int maximumStringLength) const = 0;

    virtual String getLabel() const = 0;

    virtual int getNumSteps() const;

    virtual bool isDiscrete() const;

    virtual bool isBoolean() const;

    virtual String getText (float normalisedValue, int /*maximumStringLength*/) const;

    virtual float getValueForText (const String& text) const = 0;

    virtual bool isOrientationInverted() const;

    virtual bool isAutomatable() const;

    virtual bool isMetaParameter() const;
 
    enum Category
    {
        genericParameter = (0 << 16) | 0,        
 
        inputGain        = (1 << 16) | 0,        
        outputGain       = (1 << 16) | 1,

        inputMeter                          = (2 << 16) | 0,
        outputMeter                         = (2 << 16) | 1,
        compressorLimiterGainReductionMeter = (2 << 16) | 2,
        expanderGateGainReductionMeter      = (2 << 16) | 3,
        analysisMeter                       = (2 << 16) | 4,
        otherMeter                          = (2 << 16) | 5
    };

    virtual Category getCategory() const;

    int getParameterIndex() const noexcept              { return parameterIndex; }
 
    //==============================================================================
    virtual String getCurrentValueAsText() const;

    virtual StringArray getAllValueStrings() const;
 
    //==============================================================================
    int getVersionHint() const                      { return version; }
 
    //==============================================================================
    class JUCE_API  Listener
    {
    public:
        virtual ~Listener()  = default;

        virtual void parameterValueChanged (int parameterIndex, float newValue) = 0;

        virtual void parameterGestureChanged (int parameterIndex, bool gestureIsStarting) = 0;
    };

    void addListener (Listener* newListener);

    void removeListener (Listener* listener);
 
    //==============================================================================
    void sendValueChangedMessageToListeners (float newValue);
 
private:
    //==============================================================================
    friend class AudioProcessor;
    friend class LegacyAudioParameter;
    AudioProcessor* processor = nullptr;
    int parameterIndex = -1;
    int version = 0;
    CriticalSection listenerLock;
    Array<Listener*> listeners;
    mutable StringArray valueStrings;
 
   #if JUCE_DEBUG
    bool isPerformingGesture = false;
   #endif
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (AudioProcessorParameter)
};
 
} // namespace juce