#include <tracktion_EnvelopeFollowerModifier.h>

Inheritance diagram for engine::EnvelopeFollowerModifier:

Classes
struct	Assignment

Public Types
using	Ptr = juce::ReferenceCountedObjectPtr< EnvelopeFollowerModifier >

using	Array = juce::ReferenceCountedArray< EnvelopeFollowerModifier >

Public Types inherited from engine::Modifier
enum class	ProcessingPosition { none , preFX , postFX }
	Determines the position in the FX chain where the modifier should be processed. More...

using	Ptr = juce::ReferenceCountedObjectPtr< Modifier >

using	Array = juce::ReferenceCountedArray< Modifier >

Public Types inherited from engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >

Public Member Functions
	EnvelopeFollowerModifier (Edit &, const juce::ValueTree &)

	~EnvelopeFollowerModifier () override

void	initialise () override
	Call this once after construction to connect it to the audio graph.

float	getCurrentValue () override
	Must return the current value of the modifier.

juce::String	getName () const override

float	getEnvelopeValue () const noexcept

AutomatableParameter::ModifierAssignment *	createAssignment (const juce::ValueTree &) override
	Must return a new ModifierAssignment for a given state.

juce::StringArray	getAudioInputNames () override
	Can return an array of names represeting audio inputs.

ProcessingPosition	getProcessingPosition () override
	Should return the position in the plugin chain that this Modifier should be processed.

void	initialise (double sampleRate, int blockSizeSamples) override
	Sub classes should implement this to initialise the Modifier.

void	deinitialise () override
	Sub classes should implement this to deinitialise the Modifier.

void	applyToBuffer (const PluginRenderContext &) override
	Sub classes should implement this to process the Modifier.

juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.

Public Member Functions inherited from engine::Modifier
	Modifier (Edit &, const juce::ValueTree &)
	Creates a Modifier for a given state.

	~Modifier () override
	Destructor.

void	remove ()
	Removes this Modifier from its parent Track.

virtual juce::StringArray	getMidiInputNames ()
	Can return an array of names represeting MIDI inputs.

bool	baseClassNeedsInitialising () const noexcept
	Returns true if the Modifier needs initialising.

void	baseClassInitialise (double sampleRate, int blockSizeSamples)
	Initialises the Modifier.

void	baseClassDeinitialise ()
	Deinitialises the Modifier.

void	baseClassApplyToBuffer (const PluginRenderContext &)
	Updates internal value history and calls the subclass's applyToBuffer method.

TimePosition	getCurrentTime () const
	Returns the edit time of the current value.

float	getValueAt (TimeDuration numSecondsBeforeNow) const
	Returns the value of the at a given time in the past.

std::vector< float >	getValues (TimeDuration numSecondsBeforeNow) const
	Returns a vector of previous sample values.

double	getSampleRate () const
	Returns the sample rate the Modifier has been initialised with.

void	selectableAboutToBeDeleted () override

Public Member Functions inherited from engine::AutomatableEditItem
	AutomatableEditItem (Edit &, const juce::ValueTree &)

	~AutomatableEditItem () override

virtual void	flushPluginStateToValueTree ()

virtual void	restorePluginStateFromValueTree (const juce::ValueTree &)

juce::Array< AutomatableParameter * >	getAutomatableParameters () const

int	getNumAutomatableParameters () const

AutomatableParameter::Ptr	getAutomatableParameter (int index) const

AutomatableParameter::Ptr	getAutomatableParameterByID (const juce::String &paramID) const

void	visitAllAutomatableParams (const std::function< void(AutomatableParameter &)> &visit) const

void	deleteParameter (AutomatableParameter *)

void	deleteAutomatableParameters ()

int	indexOfAutomatableParameter (const AutomatableParameter::Ptr &) const

AutomatableParameterTree &	getParameterTree () const

juce::ReferenceCountedArray< AutomatableParameter >	getFlattenedParameterTree () const

void	addParameterListChangeListener (ParameterListChangeListener *)

void	removeParameterListChangeListener (ParameterListChangeListener *)

bool	isAutomationNeeded () const noexcept

void	setAutomatableParamPosition (TimePosition)

bool	isBeingActivelyPlayed () const

virtual void	updateAutomatableParamPosition (TimePosition)
	Updates all the auto params to their positions at this time.

void	updateParameterStreams (TimePosition)
	Updates all the parameter streams to their positions at this time.

void	resetRecordingStatus ()
	Marks the end of an automation recording stream.

void	updateStreamIterators ()

void	addActiveParameter (const AutomatableParameter &)

void	removeActiveParameter (const AutomatableParameter &)

bool	isActiveParameter (AutomatableParameter &)

Public Member Functions inherited from engine::EditItem
	EditItem (EditItemID, Edit &)

	EditItem (Edit &, const juce::ValueTree &)

virtual	~EditItem ()=default

Public Member Functions inherited from engine::Selectable
	Selectable ()

virtual	~Selectable ()

virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected.

virtual void	changed ()
	This should be called to send a change notification to any SelectableListeners that are registered with this object.

void	addListener (SelectableListener *)

void	removeListener (SelectableListener *)

void	addSelectableListener (SelectableListener *)

void	removeSelectableListener (SelectableListener *)

void	cancelAnyPendingUpdates ()
	If changed() has been called, this will cancel any pending async change notificaions.

void	deselect ()

void	propertiesChanged ()

void	notifyListenersOfDeletion ()

WeakRef	getWeakRef ()

Public Member Functions inherited from engine::AutomatableParameter::ModifierSource
	ModifierSource ()=default

virtual	~ModifierSource ()

Public Attributes
juce::CachedValue< float >	gainDb

juce::CachedValue< float >	attack

juce::CachedValue< float >	hold

juce::CachedValue< float >	release

juce::CachedValue< float >	depth

juce::CachedValue< float >	offset

juce::CachedValue< float >	lowPassEnabled

juce::CachedValue< float >	highPassEnabled

juce::CachedValue< float >	lowPassFrequency

juce::CachedValue< float >	highPassFrequency

AutomatableParameter::Ptr	gainDbParam

AutomatableParameter::Ptr	attackParam

AutomatableParameter::Ptr	holdParam

AutomatableParameter::Ptr	releaseParam

AutomatableParameter::Ptr	depthParam

AutomatableParameter::Ptr	offsetParam

AutomatableParameter::Ptr	lowPassEnabledParam

AutomatableParameter::Ptr	highPassEnabledParam

AutomatableParameter::Ptr	lowPassFrequencyParam

AutomatableParameter::Ptr	highPassFrequencyParam

Public Attributes inherited from engine::Modifier
juce::ValueTree	state
	Modifier internal state.

juce::CachedValue< juce::Colour >	colour
	Colour property.

juce::CachedValue< float >	enabled
	Enabled property.

AutomatableParameter::Ptr	enabledParam
	Parameter to change the enabled state.

Public Attributes inherited from engine::AutomatableEditItem
juce::ValueTree	elementState

juce::CachedValue< bool >	remapOnTempoChange

Public Attributes inherited from engine::EditItem
Edit &	edit

const EditItemID	itemID
	Every EditItem has an ID which is unique within the edit.

Public Attributes inherited from engine::Selectable
WeakRef::Master	masterReference

Additional Inherited Members
Static Public Member Functions inherited from engine::Selectable
static void	initialise ()

static bool	isSelectableValid (const Selectable *) noexcept
	checks whether this object has been deleted.

Static Public Attributes inherited from engine::Modifier
static constexpr TimeDuration	maxHistoryTime = TimeDuration::fromSeconds (3.0)
	The max number of seconds of modifier value history that is stored.

Protected Member Functions inherited from engine::Modifier
void	setEditTime (TimePosition newEditTime)
	Subclasses can call this to update the edit time of the current value.

Protected Member Functions inherited from engine::AutomatableEditItem
virtual void	buildParameterTree () const

void	updateLastPlaybackTime ()

void	clearParameterList ()

void	addAutomatableParameter (const AutomatableParameter::Ptr &)

void	rebuildParameterTree ()

void	saveChangedParametersToState ()
	Saves the explicit value of any parameters that have deviated to the state.

void	restoreChangedParametersFromState ()
	Restores the value of any explicitly set parameters.

Member Typedef Documentation

◆ Ptr

using engine::EnvelopeFollowerModifier::Ptr = juce::ReferenceCountedObjectPtr<EnvelopeFollowerModifier>

◆ Array

using engine::EnvelopeFollowerModifier::Array = juce::ReferenceCountedArray<EnvelopeFollowerModifier>

Constructor & Destructor Documentation

◆ EnvelopeFollowerModifier()

engine::EnvelopeFollowerModifier::EnvelopeFollowerModifier	(	Edit &	,
		const juce::ValueTree &
	)

◆ ~EnvelopeFollowerModifier()

engine::EnvelopeFollowerModifier::~EnvelopeFollowerModifier ( )

override

Member Function Documentation

◆ initialise() [1/2]

void engine::EnvelopeFollowerModifier::initialise ( )

overridevirtual

Call this once after construction to connect it to the audio graph.

Implements engine::Modifier.

◆ getCurrentValue()

float engine::EnvelopeFollowerModifier::getCurrentValue ( )

overridevirtual

Must return the current value of the modifier.

See also: getValueAt, getValues

Implements engine::Modifier.

◆ getName()

juce::String engine::EnvelopeFollowerModifier::getName ( ) const

overridevirtual

Implements engine::EditItem.

◆ getEnvelopeValue()

float engine::EnvelopeFollowerModifier::getEnvelopeValue ( ) const

noexcept

◆ createAssignment()

AutomatableParameter::ModifierAssignment * engine::EnvelopeFollowerModifier::createAssignment ( const juce::ValueTree & )

overridevirtual

Must return a new ModifierAssignment for a given state.

Implements engine::Modifier.

◆ getAudioInputNames()

juce::StringArray engine::EnvelopeFollowerModifier::getAudioInputNames ( )

overridevirtual

Can return an array of names represeting audio inputs.

Reimplemented from engine::Modifier.

◆ getProcessingPosition()

ProcessingPosition engine::EnvelopeFollowerModifier::getProcessingPosition ( )

overridevirtual

Should return the position in the plugin chain that this Modifier should be processed.

Reimplemented from engine::Modifier.

◆ initialise() [2/2]

void engine::EnvelopeFollowerModifier::initialise	(	double	,
		int
	)

overridevirtual

Sub classes should implement this to initialise the Modifier.

Reimplemented from engine::Modifier.

◆ deinitialise()

void engine::EnvelopeFollowerModifier::deinitialise ( )

overridevirtual

Sub classes should implement this to deinitialise the Modifier.

Reimplemented from engine::Modifier.

◆ applyToBuffer()

void engine::EnvelopeFollowerModifier::applyToBuffer ( const PluginRenderContext & )

overridevirtual

Sub classes should implement this to process the Modifier.

Reimplemented from engine::Modifier.

◆ getSelectableDescription()

juce::String engine::EnvelopeFollowerModifier::getSelectableDescription ( )

overridevirtual

Subclasses must return a description of what they are.

Implements engine::Selectable.

References engine::getName().

Member Data Documentation

◆ gainDb

juce::CachedValue<float> engine::EnvelopeFollowerModifier::gainDb

◆ attack

juce::CachedValue<float> engine::EnvelopeFollowerModifier::attack

◆ hold

juce::CachedValue<float> engine::EnvelopeFollowerModifier::hold

◆ release

juce::CachedValue<float> engine::EnvelopeFollowerModifier::release

◆ depth

juce::CachedValue<float> engine::EnvelopeFollowerModifier::depth

◆ offset

juce::CachedValue<float> engine::EnvelopeFollowerModifier::offset

◆ lowPassEnabled

juce::CachedValue<float> engine::EnvelopeFollowerModifier::lowPassEnabled

◆ highPassEnabled

juce::CachedValue<float> engine::EnvelopeFollowerModifier::highPassEnabled

◆ lowPassFrequency

juce::CachedValue<float> engine::EnvelopeFollowerModifier::lowPassFrequency

◆ highPassFrequency

juce::CachedValue<float> engine::EnvelopeFollowerModifier::highPassFrequency

◆ gainDbParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::gainDbParam

◆ attackParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::attackParam

◆ holdParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::holdParam

◆ releaseParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::releaseParam

◆ depthParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::depthParam

◆ offsetParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::offsetParam

◆ lowPassEnabledParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::lowPassEnabledParam

◆ highPassEnabledParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::highPassEnabledParam

◆ lowPassFrequencyParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::lowPassFrequencyParam

◆ highPassFrequencyParam

AutomatableParameter::Ptr engine::EnvelopeFollowerModifier::highPassFrequencyParam

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

tracktion_EnvelopeFollowerModifier.h

Classes

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Ptr

◆ Array

Constructor & Destructor Documentation

◆ EnvelopeFollowerModifier()

◆ ~EnvelopeFollowerModifier()

Member Function Documentation

◆ initialise() [1/2]

◆ getCurrentValue()

◆ getName()

◆ getEnvelopeValue()

◆ createAssignment()

◆ getAudioInputNames()

◆ getProcessingPosition()

◆ initialise() [2/2]

◆ deinitialise()

◆ applyToBuffer()

◆ getSelectableDescription()

Member Data Documentation

◆ gainDb

◆ attack

◆ hold

◆ release

◆ depth

◆ offset

◆ lowPassEnabled

◆ highPassEnabled

◆ lowPassFrequency

◆ highPassFrequency

◆ gainDbParam

◆ attackParam

◆ holdParam

◆ releaseParam

◆ depthParam

◆ offsetParam

◆ lowPassEnabledParam

◆ highPassEnabledParam

◆ lowPassFrequencyParam

◆ highPassFrequencyParam