//------------------------------------------------------------------------ // Project : VST SDK // // Category : Helpers // Filename : public.sdk/source/vst/vstparameters.h // Created by : Steinberg, 03/2008 // Description : VST Parameter Implementation // //----------------------------------------------------------------------------- // LICENSE // (c) 2018, 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 #include //------------------------------------------------------------------------ namespace Steinberg { namespace Vst { //------------------------------------------------------------------------ /** Description of a Parameter. \ingroup vstClasses */ //------------------------------------------------------------------------ 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); virtual ~Parameter (); /** Returns its read only info. */ const ParameterInfo& getInfo () const { return info; } /** Returns its writable info. */ ParameterInfo& getInfo () { return info; } /** Sets its associated UnitId. */ void setUnitID (UnitID id) { info.unitId = id; } /** Gets its associated UnitId. */ UnitID getUnitID () { return info.unitId; } /** Gets its normalized value [0.0, 1.0]. */ ParamValue getNormalized () const { return valueNormalized; } /** Sets its normalized value [0.0, 1.0]. */ virtual bool setNormalized (ParamValue v); /** Converts a normalized value to a string. */ virtual void toString (ParamValue valueNormalized, String128 string) const; /** Converts a string to a normalized value. */ virtual bool fromString (const TChar* string, ParamValue& valueNormalized) const; /** Converts a normalized value to plain value (e.g. 0.5 to 10000.0Hz). */ virtual ParamValue toPlain (ParamValue valueNormalized) const; /** Converts a plain value to a normalized value (e.g. 10000 to 0.5). */ virtual ParamValue toNormalized (ParamValue plainValue) const; /** Gets the current precision (used for string representation of float). */ int32 getPrecision () const { return precision; } /** Sets the precision for string representation of float value (for example 4.34 with 2 as * precision). */ void setPrecision (int32 val) { precision = val; } OBJ_METHODS (Parameter, FObject) //------------------------------------------------------------------------ protected: ParameterInfo info; ParamValue valueNormalized; int32 precision; }; //------------------------------------------------------------------------ /** Description of a RangeParameter. \ingroup vstClasses */ //------------------------------------------------------------------------ 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); /** Gets the minimum plain value, same as toPlain (0). */ virtual ParamValue getMin () const { return minPlain; } /** Sets the minimum plain value. */ virtual void setMin (ParamValue value) { minPlain = value; } /** Gets the maximum plain value, same as toPlain (1). */ virtual ParamValue getMax () const { return maxPlain; } /** Sets the maximum plain value. */ virtual void setMax (ParamValue value) { maxPlain = value; } /** Converts a normalized value to a string. */ void toString (ParamValue _valueNormalized, String128 string) const SMTG_OVERRIDE; /** Converts a string to a normalized value. */ bool fromString (const TChar* string, ParamValue& _valueNormalized) const SMTG_OVERRIDE; /** Converts a normalized value to plain value (e.g. 0.5 to 10000.0Hz). */ ParamValue toPlain (ParamValue _valueNormalized) const SMTG_OVERRIDE; /** Converts a plain value to a normalized value (e.g. 10000 to 0.5). */ ParamValue toNormalized (ParamValue plainValue) const SMTG_OVERRIDE; OBJ_METHODS (RangeParameter, Parameter) //------------------------------------------------------------------------ protected: RangeParameter (); ParamValue minPlain; ParamValue maxPlain; }; //------------------------------------------------------------------------ /** Description of a StringListParameter. \ingroup vstClasses */ //------------------------------------------------------------------------ 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); virtual ~StringListParameter (); /** Appends a string and increases the stepCount. */ virtual void appendString (const String128 string); /** Replaces the string at index. Index must be between 0 and stepCount+1 */ virtual bool replaceString (int32 index, const String128 string); /** Converts a normalized value to a string. */ void toString (ParamValue _valueNormalized, String128 string) const SMTG_OVERRIDE; /** Converts a string to a normalized value. */ bool fromString (const TChar* string, ParamValue& _valueNormalized) const SMTG_OVERRIDE; /** Converts a normalized value to plain value (e.g. 0.5 to 10000.0Hz). */ ParamValue toPlain (ParamValue _valueNormalized) const SMTG_OVERRIDE; /** Converts a plain value to a normalized value (e.g. 10000 to 0.5). */ ParamValue toNormalized (ParamValue plainValue) const SMTG_OVERRIDE; OBJ_METHODS (StringListParameter, Parameter) //------------------------------------------------------------------------ protected: typedef std::vector StringVector; StringVector strings; }; //------------------------------------------------------------------------ /** Collection of parameters. \ingroup vstClasses */ //------------------------------------------------------------------------ class ParameterContainer { public: //------------------------------------------------------------------------ ParameterContainer (); ~ParameterContainer (); /** Init param array. */ void init (int32 initialSize = 10, int32 resizeDelta = 100); /** Creates and adds a new parameter from a ParameterInfo. */ Parameter* addParameter (const ParameterInfo& info); /** Creates and adds a new parameter with given properties. */ 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); /** Adds a given parameter. */ Parameter* addParameter (Parameter* p); /** Returns the count of parameters. */ int32 getParameterCount () const { return params ? static_cast (params->size ()) : 0; } /** Gets parameter by index. */ Parameter* getParameterByIndex (int32 index) { return params ? params->at (index) : nullptr; } /** Removes all parameters. */ void removeAll () { if (params) params->clear (); id2index.clear (); } /** Gets parameter by ID. */ Parameter* getParameter (ParamID tag); //------------------------------------------------------------------------ protected: typedef std::vector> ParameterPtrVector; typedef std::map IndexMap; ParameterPtrVector* params; IndexMap id2index; }; //------------------------------------------------------------------------ } // namespace Vst } // namespace Steinberg