Jamba C++ API  4.1.0
Parameters Class Reference

This is the class which maintains all the registered parameters. More...

#include <Parameters.h>

Classes

class  IChangeListener
 Interface to implement to receive parameter changes. More...
 
struct  JmbParamDefBuilder
 Implements the builder pattern for ease of build. More...
 
struct  RawVstParamDefBuilder
 Implements the builder pattern for ease of build. More...
 
struct  VstParamDefBuilder
 Implements the builder pattern for ease of build. More...
 

Public Types

using ChangeCallback = std::function< void()>
 A callback that will be invoked for changes. More...
 
template<typename Param >
using ChangeCallback1 = std::function< void(Param &)>
 A callback which will be invoked for changes with the param as an argument. More...
 
template<typename TView , typename Param >
using ChangeCallback2 = std::function< void(TView *, Param &)>
 A callback which will be invoked for changes with the view and param as arguments. More...
 

Public Member Functions

std::vector< ParamID > const & getAllRegistrationOrder () const
 
NormalizedState::SaveOrder const & getGUISaveStateOrder () const
 
std::shared_ptr< IJmbParamDef > getJmbParamDef (ParamID iParamID) const
 
std::shared_ptr< RawVstParamDef > getRawVstParamDef (ParamID iParamID) const
 
NormalizedState::SaveOrder const & getRTSaveStateOrder () const
 
std::vector< ParamID > const & getVstRegistrationOrder () const
 
template<typename ParamSerializer , typename... Args>
JmbParamDefBuilder< typename ParamSerializer::ParamType > jmb (ParamID iParamID, VstString16 iTitle, Args &&...iSerializerArgs)
 Used from derived classes to build a non vst parameter (not convertible to a ParamValue) More...
 
template<typename ParamSerializer >
JmbParamDefBuilder< typename ParamSerializer::ParamType > jmb (int32 iParamID, VstString16 iTitle, typename ParamSerializer::ConstructorType initValue)
 This flavor allows the ParamSerializer to provide an actual type for the primary constructor. More...
 
template<typename T >
JmbParamDefBuilder< T > jmbFromType (ParamID iParamID, VstString16 iTitle)
 Used from derived classes to build a non vst parameter (not convertible to a ParamValue). More...
 
virtual std::unique_ptr< NormalizedStatenewRTState () const
 
 Parameters ()=default
 
RawVstParamDefBuilder raw (ParamID iParamID, VstString16 iTitle)
 Used from derived classes to build a parameter backed by a raw VST parameter. More...
 
virtual ParamValue readNormalizedValue (ParamID iParamID, IBStreamer &iStreamer) const
 
virtual tresult readRTState (IBStreamer &iStreamer, NormalizedState *oNormalizedState) const
 This method is called to read the RTState from the stream. More...
 
void registerVstParameters (Vst::ParameterContainer &iParameterContainer) const
 This method is called from the GUI controller to register all the parameters to the ParameterContainer class which is the class managing the parameters in the vst sdk. More...
 
template<typename... Args>
tresult setGUISaveStateOrder (int16 iVersion, Args &&...args)
 Used to change the default order (registration order) used when saving the GUI state (getState/setState in the controller) More...
 
tresult setGUISaveStateOrder (NormalizedState::SaveOrder const &iSaveOrder)
 Used to change the default order (registration order) used when saving the GUI state (getState/setState in the controller) More...
 
template<typename... Args>
tresult setRTSaveStateOrder (int16 iVersion, Args &&...args)
 Used to change the default order (registration order) used when saving the RT state (getState/setState in the processor, setComponentState in the controller) More...
 
tresult setRTSaveStateOrder (NormalizedState::SaveOrder const &iSaveOrder)
 Used to change the default order (registration order) used when saving the RT state (getState/setState in the processor, setComponentState in the controller) More...
 
template<typename ParamConverter , typename... Args>
VstParamDefBuilder< typename ParamConverter::ParamType > vst (ParamID iParamID, VstString16 iTitle, Args &&...iConverterArgs)
 Used from derived classes to build a parameter backed by a VST parameter. More...
 
template<typename ParamConverter >
VstParamDefBuilder< typename ParamConverter::ParamType > vst (int32 iParamID, VstString16 iTitle, typename ParamConverter::ConstructorType initValue)
 This flavor allows the ParamConverter to provide an actual type for the primary constructor. More...
 
template<typename T >
VstParamDefBuilder< T > vstFromType (ParamID iParamID, VstString16 iTitle)
 Used from derived classes to build a parameter backed by a VST parameter. More...
 
virtual tresult writeRTState (NormalizedState const *iNormalizedState, IBStreamer &oStreamer) const
 This method is called to write the NormalizedState to the stream. More...
 
virtual ~Parameters ()=default
 

Protected Member Functions

RawVstParam add (RawVstParamDefBuilder const &iBuilder)
 
template<typename T >
VstParam< T > add (VstParamDefBuilder< T > const &iBuilder)
 
template<typename T >
JmbParam< T > add (JmbParamDefBuilder< T > const &iBuilder)
 
tresult addJmbParamDef (std::shared_ptr< IJmbParamDef > iParamDef)
 
tresult addVstParamDef (std::shared_ptr< RawVstParamDef > iParamDef)
 

Private Member Functions

tresult buildParamIDs (std::vector< ParamID > &iParamIDs)
 
template<typename... Args>
tresult buildParamIDs (std::vector< ParamID > &iParamIDs, ParamID id, Args &&...args)
 
template<typename... Args>
tresult buildParamIDs (std::vector< ParamID > &iParamIDs, std::shared_ptr< IJmbParamDef > &iParamDef, Args &&...args)
 
template<typename T , typename... Args>
tresult buildParamIDs (std::vector< ParamID > &iParamIDs, std::shared_ptr< JmbParamDef< T >> &iParamDef, Args &&...args)
 
template<typename ParamConverver , typename... Args>
tresult buildParamIDs (std::vector< ParamID > &iParamIDs, std::shared_ptr< VstParamDef< ParamConverver >> &iParamDef, Args &&...args)
 
template<typename... Args>
tresult buildParamIDs (std::vector< ParamID > &iParamIDs, std::shared_ptr< RawVstParamDef > &iParamDef, Args &&...args)
 

Private Attributes

std::vector< ParamID > fAllRegistrationOrder {}
 
NormalizedState::SaveOrder fGUISaveStateOrder {}
 
std::map< ParamID, std::shared_ptr< IJmbParamDef > > fJmbParams {}
 
NormalizedState::SaveOrder fRTSaveStateOrder {}
 
std::map< ParamID, std::shared_ptr< RawVstParamDef > > fVstParams {}
 
std::vector< ParamID > fVstRegistrationOrder {}
 

Friends

class Debug::ParamDisplay
 

Detailed Description

This is the class which maintains all the registered parameters.

Member Typedef Documentation

◆ ChangeCallback

using ChangeCallback = std::function<void()>

A callback that will be invoked for changes.

Note that unlike the IChangeListener, there is no parameter since it is expected to be used like this:

fMyParam = registerVstParam(myParamId, [this]() { .... ; });

◆ ChangeCallback1

using ChangeCallback1 = std::function<void(Param &)>

A callback which will be invoked for changes with the param as an argument.

◆ ChangeCallback2

using ChangeCallback2 = std::function<void(TView *, Param &)>

A callback which will be invoked for changes with the view and param as arguments.

Constructor & Destructor Documentation

◆ Parameters()

Parameters ( )
explicitdefault

◆ ~Parameters()

virtual ~Parameters ( )
virtualdefault

Member Function Documentation

◆ add() [1/3]

RawVstParam add ( RawVstParamDefBuilder const &  iBuilder)
protected

◆ add() [2/3]

VstParam< T > add ( VstParamDefBuilder< T > const &  iBuilder)
protected

◆ add() [3/3]

JmbParam< T > add ( Parameters::JmbParamDefBuilder< T > const &  iBuilder)
protected

◆ addJmbParamDef()

tresult addJmbParamDef ( std::shared_ptr< IJmbParamDef >  iParamDef)
protected

◆ addVstParamDef()

tresult addVstParamDef ( std::shared_ptr< RawVstParamDef >  iParamDef)
protected

◆ buildParamIDs() [1/6]

tresult buildParamIDs ( std::vector< ParamID > &  iParamIDs)
inlineprivate

◆ buildParamIDs() [2/6]

tresult buildParamIDs ( std::vector< ParamID > &  iParamIDs,
ParamID  id,
Args &&...  args 
)
private

◆ buildParamIDs() [3/6]

tresult buildParamIDs ( std::vector< ParamID > &  iParamIDs,
std::shared_ptr< IJmbParamDef > &  iParamDef,
Args &&...  args 
)
inlineprivate

◆ buildParamIDs() [4/6]

tresult buildParamIDs ( std::vector< ParamID > &  iParamIDs,
std::shared_ptr< JmbParamDef< T >> &  iParamDef,
Args &&...  args 
)
inlineprivate

◆ buildParamIDs() [5/6]

tresult buildParamIDs ( std::vector< ParamID > &  iParamIDs,
std::shared_ptr< VstParamDef< ParamConverver >> &  iParamDef,
Args &&...  args 
)
inlineprivate

◆ buildParamIDs() [6/6]

tresult buildParamIDs ( std::vector< ParamID > &  iParamIDs,
std::shared_ptr< RawVstParamDef > &  iParamDef,
Args &&...  args 
)
inlineprivate

◆ getAllRegistrationOrder()

std::vector<ParamID> const& getAllRegistrationOrder ( ) const
inline

◆ getGUISaveStateOrder()

NormalizedState::SaveOrder const& getGUISaveStateOrder ( ) const
inline
Returns
the order used when saving the GUI state (getState/setState in the controller)

◆ getJmbParamDef()

std::shared_ptr< IJmbParamDef > getJmbParamDef ( ParamID  iParamID) const

◆ getRawVstParamDef()

std::shared_ptr< RawVstParamDef > getRawVstParamDef ( ParamID  iParamID) const

◆ getRTSaveStateOrder()

NormalizedState::SaveOrder const& getRTSaveStateOrder ( ) const
inline
Returns
the order used when saving the RT state (getState/setState in the processor, setComponentState in the controller)

◆ getVstRegistrationOrder()

std::vector<ParamID> const& getVstRegistrationOrder ( ) const
inline

◆ jmb() [1/2]

Parameters::JmbParamDefBuilder< typename ParamSerializer::ParamType > jmb ( ParamID  iParamID,
VstString16  iTitle,
Args &&...  iSerializerArgs 
)

Used from derived classes to build a non vst parameter (not convertible to a ParamValue)

◆ jmb() [2/2]

Parameters::JmbParamDefBuilder< typename ParamSerializer::ParamType > jmb ( int32  iParamID,
VstString16  iTitle,
typename ParamSerializer::ConstructorType  initValue 
)

This flavor allows the ParamSerializer to provide an actual type for the primary constructor.

◆ jmbFromType()

Parameters::JmbParamDefBuilder< T > jmbFromType ( ParamID  iParamID,
VstString16  iTitle 
)

Used from derived classes to build a non vst parameter (not convertible to a ParamValue).

Use this version if you want to provide a different serializer.

◆ newRTState()

std::unique_ptr< NormalizedState > newRTState ( ) const
virtual
Returns
a new normalized state for RT (can be overridden to return a subclass!)

◆ raw()

Parameters::RawVstParamDefBuilder raw ( ParamID  iParamID,
VstString16  iTitle 
)

Used from derived classes to build a parameter backed by a raw VST parameter.

◆ readNormalizedValue()

ParamValue readNormalizedValue ( ParamID  iParamID,
IBStreamer &  iStreamer 
) const
virtual
Returns
normalized value read from the stream for the given parameter

◆ readRTState()

tresult readRTState ( IBStreamer &  iStreamer,
NormalizedState oNormalizedState 
) const
virtual

This method is called to read the RTState from the stream.

Todo:
handle multiple versions

◆ registerVstParameters()

void registerVstParameters ( Vst::ParameterContainer &  iParameterContainer) const

This method is called from the GUI controller to register all the parameters to the ParameterContainer class which is the class managing the parameters in the vst sdk.

◆ setGUISaveStateOrder() [1/2]

tresult setGUISaveStateOrder ( int16  iVersion,
Args &&...  args 
)

Used to change the default order (registration order) used when saving the GUI state (getState/setState in the controller)

Parameters
iVersionshould be a >= 0 number. If negative it will be ignored
argscan be any combination of ParamID, RawVstParamDef, VstParamDef, JmbParamDef

◆ setGUISaveStateOrder() [2/2]

tresult setGUISaveStateOrder ( NormalizedState::SaveOrder const &  iSaveOrder)

Used to change the default order (registration order) used when saving the GUI state (getState/setState in the controller)

◆ setRTSaveStateOrder() [1/2]

tresult setRTSaveStateOrder ( int16  iVersion,
Args &&...  args 
)

Used to change the default order (registration order) used when saving the RT state (getState/setState in the processor, setComponentState in the controller)

Parameters
iVersionshould be a >= 0 number. If negative it will be ignored
argscan be any combination of ParamID, RawVstParamDef, VstParamDef, JmbParamDef

◆ setRTSaveStateOrder() [2/2]

tresult setRTSaveStateOrder ( NormalizedState::SaveOrder const &  iSaveOrder)

Used to change the default order (registration order) used when saving the RT state (getState/setState in the processor, setComponentState in the controller)

◆ vst() [1/2]

Parameters::VstParamDefBuilder< typename ParamConverter::ParamType > vst ( ParamID  iParamID,
VstString16  iTitle,
Args &&...  iConverterArgs 
)

Used from derived classes to build a parameter backed by a VST parameter.

◆ vst() [2/2]

Parameters::VstParamDefBuilder< typename ParamConverter::ParamType > vst ( int32  iParamID,
VstString16  iTitle,
typename ParamConverter::ConstructorType  initValue 
)

This flavor allows the ParamConverter to provide an actual type for the primary constructor.

◆ vstFromType()

Parameters::VstParamDefBuilder< T > vstFromType ( ParamID  iParamID,
VstString16  iTitle 
)

Used from derived classes to build a parameter backed by a VST parameter.

Use this version if you want to provide a different converter.

◆ writeRTState()

tresult writeRTState ( NormalizedState const *  iNormalizedState,
IBStreamer &  oStreamer 
) const
virtual

This method is called to write the NormalizedState to the stream.

Friends And Related Function Documentation

◆ Debug::ParamDisplay

friend class Debug::ParamDisplay
friend

Member Data Documentation

◆ fAllRegistrationOrder

std::vector<ParamID> fAllRegistrationOrder {}
private

◆ fGUISaveStateOrder

NormalizedState::SaveOrder fGUISaveStateOrder {}
private

◆ fJmbParams

std::map<ParamID, std::shared_ptr<IJmbParamDef> > fJmbParams {}
private

◆ fRTSaveStateOrder

NormalizedState::SaveOrder fRTSaveStateOrder {}
private
Todo:
Handle multiple versions with upgrade

◆ fVstParams

std::map<ParamID, std::shared_ptr<RawVstParamDef> > fVstParams {}
private

◆ fVstRegistrationOrder

std::vector<ParamID> fVstRegistrationOrder {}
private

The documentation for this class was generated from the following files: