vstparameters.h

Go to the documentation of this file.

 //------------------------------------------------------------------------
// Project     : VST SDK
//
// Category    : Helpers
// Filename    : public.sdk/source/vst/vstparameters.h
// Created by  : Steinberg, 03/2008
// Description : VST Parameter Implementation
//
//-----------------------------------------------------------------------------
// LICENSE
// (c) 2023, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 
//   * Redistributions of source code must retain the above copyright notice, 
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation 
//     and/or other materials provided with the distribution.
//   * Neither the name of the Steinberg Media Technologies nor the names of its
//     contributors may be used to endorse or promote products derived from this 
//     software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
 
#pragma once
 
#include "base/source/fobject.h"
#include "pluginterfaces/vst/ivsteditcontroller.h"
#include "pluginterfaces/vst/ivstunits.h"
 
#include <map>
#include <vector>
 
//------------------------------------------------------------------------
namespace Steinberg {
namespace Vst {
 
//------------------------------------------------------------------------
class Parameter : public FObject
{
public:
//------------------------------------------------------------------------
    Parameter ();
    Parameter (const ParameterInfo&);
    Parameter (const TChar* title, ParamID tag, const TChar* units = nullptr,
               ParamValue defaultValueNormalized = 0., int32 stepCount = 0,
               int32 flags = ParameterInfo::kCanAutomate, UnitID unitID = kRootUnitId,
               const TChar* shortTitle = nullptr);
    ~Parameter () override;
 
    virtual const ParameterInfo& getInfo () const { return info; }
 
    virtual ParameterInfo& getInfo () { return info; }
 
    virtual void setUnitID (UnitID id) { info.unitId = id; }
    virtual UnitID getUnitID () { return info.unitId; }
 
    ParamValue getNormalized () const { return valueNormalized; }
    virtual bool setNormalized (ParamValue v);
 
    virtual void toString (ParamValue valueNormalized, String128 string) const;
    virtual bool fromString (const TChar* string, ParamValue& valueNormalized) const;
 
    virtual ParamValue toPlain (ParamValue valueNormalized) const;
    virtual ParamValue toNormalized (ParamValue plainValue) const;
 
    virtual int32 getPrecision () const { return precision; }
    virtual void setPrecision (int32 val) { precision = val; }
 
    OBJ_METHODS (Parameter, FObject)
//------------------------------------------------------------------------
protected:
    ParameterInfo info {0};
    ParamValue valueNormalized {0.};
    int32 precision {4};
};
 
//------------------------------------------------------------------------
class RangeParameter : public Parameter
{
public:
//------------------------------------------------------------------------
    RangeParameter (const ParameterInfo& paramInfo, ParamValue min, ParamValue max);
    RangeParameter (const TChar* title, ParamID tag, const TChar* units = nullptr,
                    ParamValue minPlain = 0., ParamValue maxPlain = 1.,
                    ParamValue defaultValuePlain = 0., int32 stepCount = 0,
                    int32 flags = ParameterInfo::kCanAutomate, UnitID unitID = kRootUnitId,
                    const TChar* shortTitle = nullptr);
 
    virtual ParamValue getMin () const { return minPlain; }
    virtual void setMin (ParamValue value) { minPlain = value; }
    virtual ParamValue getMax () const { return maxPlain; }
    virtual void setMax (ParamValue value) { maxPlain = value; }
 
    void toString (ParamValue _valueNormalized, String128 string) const SMTG_OVERRIDE;
    bool fromString (const TChar* string, ParamValue& _valueNormalized) const SMTG_OVERRIDE;
 
    ParamValue toPlain (ParamValue _valueNormalized) const SMTG_OVERRIDE;
    ParamValue toNormalized (ParamValue plainValue) const SMTG_OVERRIDE;
 
    OBJ_METHODS (RangeParameter, Parameter)
//------------------------------------------------------------------------
protected:
    RangeParameter ();
 
    ParamValue minPlain;
    ParamValue maxPlain;
};
 
//------------------------------------------------------------------------
class StringListParameter : public Parameter
{
public:
//------------------------------------------------------------------------
    StringListParameter (const ParameterInfo& paramInfo);
    StringListParameter (const TChar* title, ParamID tag, const TChar* units = nullptr,
                         int32 flags = ParameterInfo::kCanAutomate | ParameterInfo::kIsList,
                         UnitID unitID = kRootUnitId, const TChar* shortTitle= nullptr);
    ~StringListParameter () override;
 
    virtual void appendString (const String128 string);
    virtual bool replaceString (int32 index, const String128 string);
 
    void toString (ParamValue _valueNormalized, String128 string) const SMTG_OVERRIDE;
    bool fromString (const TChar* string, ParamValue& _valueNormalized) const SMTG_OVERRIDE;
 
    ParamValue toPlain (ParamValue _valueNormalized) const SMTG_OVERRIDE;
    ParamValue toNormalized (ParamValue plainValue) const SMTG_OVERRIDE;
 
    OBJ_METHODS (StringListParameter, Parameter)
//------------------------------------------------------------------------
protected:
    using StringVector = std::vector<TChar*>;
    StringVector strings;
};
 
//------------------------------------------------------------------------
class ParameterContainer
{
public:
//------------------------------------------------------------------------
    ParameterContainer ();
    ~ParameterContainer ();
 
    void init (int32 initialSize = 10, int32 resizeDelta = 100);
 
    Parameter* addParameter (const ParameterInfo& info);
 
    Parameter* addParameter (const TChar* title, const TChar* units = nullptr, int32 stepCount = 0,
                             ParamValue defaultValueNormalized = 0.,
                             int32 flags = ParameterInfo::kCanAutomate, int32 tag = -1,
                             UnitID unitID = kRootUnitId, const TChar* shortTitle = nullptr);
 
    Parameter* addParameter (Parameter* p);
 
    int32 getParameterCount () const { return params ? static_cast<int32> (params->size ()) : 0; }
 
    Parameter* getParameterByIndex (int32 index) const;
 
    void removeAll ()
    {
        if (params)
            params->clear ();
        id2index.clear ();
    }
 
    Parameter* getParameter (ParamID tag) const;
 
    bool removeParameter (ParamID tag);
    //------------------------------------------------------------------------
protected:
    using ParameterPtrVector = std::vector<IPtr<Parameter>>;
    using IndexMap = std::map<ParamID, ParameterPtrVector::size_type>;
    ParameterPtrVector* params {nullptr};
    IndexMap id2index;
};
 
//------------------------------------------------------------------------
} // namespace Vst
} // namespace Steinberg