Inheritance diagram for tracktion::engine::Plugin:

Classes
struct	WindowState

struct	Wire

Public Types
enum class	Type { allPlugins , folderTrackPlugins , effectPlugins }

using	Ptr = juce::ReferenceCountedObjectPtr< Plugin >

using	Array = juce::ReferenceCountedArray< Plugin >

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

Public Member Functions
	Plugin (PluginCreationInfo)

	~Plugin () override

void	selectableAboutToBeDeleted () override
	Called just before the selectable is about to be deleted so any subclasses should still be valid at this point. More...

void	playStartedOrStopped ()
	called by the system to let the plugin manage its automation stuff More...

virtual void	initialiseFully ()
	Gives the plugin a chance to do extra initialisation when it's been added to an edit. More...

virtual void	flushPluginStateToValueTree () override

virtual juce::String	getName () const override=0
	The name of the type, e.g. More...

virtual juce::String	getPluginType ()=0

virtual juce::String	getVendor ()

virtual juce::String	getShortName (int)

virtual juce::String	getIdentifierString ()
	A unique string to idenitify plugin independant of install location. More...

virtual juce::String	getTooltip ()
	default returns the name, others can return special stuff if needed More...

virtual void	setEnabled (bool)
	Enable/disable the plugin. More...

bool	isEnabled () const noexcept

void	setFrozen (bool shouldBeFrozen)
	This is a bit different to being enabled as when frozen a plugin can't be interacted with. More...

bool	isFrozen () const noexcept

void	setProcessingEnabled (bool p)
	Enable/Disable processing. More...

bool	isProcessingEnabled () const noexcept

virtual void	initialise (const PluginInitialisationInfo &)=0
	Gives the plugin a chance to set itself up before being played. More...

virtual void	initialiseWithoutStopping (const PluginInitialisationInfo &)
	Tells the plugin that the audio graph has changed but the plugin isn't being re-initialised - i.e. More...

virtual void	deinitialise ()=0
	Called after play stops to release resources. More...

virtual void	reset ()
	Should reset synth voices, tails, clear delay buffers, etc. More...

virtual void	trackPropertiesChanged ()
	Track name or colour has changed. More...

virtual void	applyToBuffer (const PluginRenderContext &)=0
	Process the next block of data. More...

virtual void	prepareForNextBlock (TimePosition)
	Called between successive rendering blocks. More...

void	applyToBufferWithAutomation (const PluginRenderContext &)

double	getCpuUsage () const noexcept

virtual int	getNumOutputChannelsGivenInputs (int numInputChannels)
	This must return the number of output channels that the plugin will produce, given a number of input channels. More...

virtual bool	producesAudioWhenNoAudioInput ()

virtual bool	noTail ()

virtual void	getChannelNames (juce::StringArray ins, juce::StringArray outs)

virtual bool	takesAudioInput ()

virtual bool	takesMidiInput ()

virtual bool	isSynth ()

virtual double	getLatencySeconds ()

virtual double	getTailLength () const

virtual bool	canSidechain ()

juce::StringArray	getInputChannelNames ()

juce::StringArray	getSidechainSourceNames (bool allowNone)

void	setSidechainSourceByName (const juce::String &name)

juce::String	getSidechainSourceName ()

void	guessSidechainRouting ()

int	getNumWires () const

Wire *	getWire (int index) const

void	makeConnection (int srcChannel, int dstChannel, juce::UndoManager *)

void	breakConnection (int srcChannel, int dstChannel)

virtual bool	hasNameForMidiNoteNumber (int note, int midiChannel, juce::String &name)
	If it's a synth that names its notes, this can return the name it uses for this note 0-127. More...

virtual bool	hasNameForMidiProgram (int programNum, int bank, juce::String &name)
	Returns the name for a midi program, if there is one. More...

virtual bool	hasNameForMidiBank (int bank, juce::String &name)

virtual bool	canBeAddedToClip ()

virtual bool	canBeAddedToRack ()

virtual bool	canBeAddedToFolderTrack ()

virtual bool	canBeAddedToMaster ()

virtual bool	canBeDisabled ()

virtual bool	canBeMoved ()

virtual bool	needsConstantBufferSize ()=0

virtual bool	isMissing ()
	for things like VSTs where the DLL is missing. More...

virtual bool	isDisabled ()
	Plugins can be disabled to avoid them crashing Edits. More...

bool	isInRack () const

juce::ReferenceCountedObjectPtr< RackType >	getOwnerRackType () const

bool	isClipEffectPlugin () const

virtual juce::AudioProcessor *	getWrappedAudioProcessor () const

AutomatableParameter::Ptr	getQuickControlParameter () const

void	setQuickControlParameter (AutomatableParameter *)

virtual void	deleteFromParent ()
	Attempts to delete this plugin, whether it's a master plugin, track plugin, etc. More...

void	removeFromParent ()
	Detaches the plugin from any parent it might be in. More...

Track *	getOwnerTrack () const
	Returns the track if it's a track or clip plugin. More...

Clip *	getOwnerClip () const
	Returns the clip if that's what it's in. More...

PluginList *	getOwnerList () const

Ptr	findPluginThatFeedsIntoThis () const

Ptr	findPluginThatThisFeedsInto () const

void	changed () override
	method from Selectable, that's been overridden here to also tell the edit that it's changed. More...

juce::Array< ReferencedItem >	getReferencedItems () override

void	reassignReferencedItem (const ReferencedItem &, ProjectItemID newID, double newStartTime) override

virtual void	sourceMediaChanged ()
	Called when ProjectItem sources are re-assigned so you can reload from the new source. More...

bool	setPluginToMirror (const Plugin::Ptr &)

virtual void	updateFromMirroredPluginIfNeeded (Plugin &)

Plugin::Ptr	getMirroredPlugin () const

bool	baseClassNeedsInitialising () const noexcept

void	baseClassInitialise (const PluginInitialisationInfo &)

void	baseClassDeinitialise ()

void	setSidechainSourceID (EditItemID newID)

EditItemID	getSidechainSourceID () const

void	showWindowExplicitly ()

void	hideWindowForShutdown ()

juce::UndoManager *	getUndoManager () const noexcept

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

virtual	~Selectable ()

virtual juce::String	getSelectableDescription ()=0
	Subclasses must return a description of what they are. More...

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

void	addSelectableListener (SelectableListener *)

void	removeSelectableListener (SelectableListener *)

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

void	deselect ()

void	propertiesChanged ()

void	notifyListenersOfDeletion ()

WeakRef	getWeakRef ()

Public Member Functions inherited from tracktion::engine::Exportable
virtual	~Exportable ()=default

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

virtual	~AutomatableEditItem ()

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	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. More...

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

void	updateActiveParameters ()
	Iterates all the parameters to find out which ones need to be automated. More...

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

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

virtual	~EditItem ()=default

Public Member Functions inherited from tracktion::engine::MacroParameterElement
	MacroParameterElement (Edit &, const juce::ValueTree &)
	Constructor. More...

virtual	~MacroParameterElement ()=default
	Destructor. More...

int	getNumMacroParameters () const
	Returns the number of macro parameters for this object. More...

Static Public Member Functions
static bool	areSelectedPluginsRackable (SelectionManager &)

static RackInstance *	wrapSelectedPluginsInRack (SelectionManager &)

static void	sortPlugins (Plugin::Array &)

static void	sortPlugins (std::vector< Plugin * > &)

Static Public Member Functions inherited from tracktion::engine::Selectable
static void	initialise ()

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

Static Public Member Functions inherited from tracktion::engine::Exportable
static juce::Array< Exportable * >	addAllExportables (Edit &)
	Returns all the Exportables contained in an Edit. More...

Public Attributes
std::unique_ptr< WindowState >	windowState

Engine &	engine

juce::ValueTree	state

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

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

juce::CachedValue< bool >	remapOnTempoChange

Public Attributes inherited from tracktion::engine::EditItem
Edit &	edit

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

Public Attributes inherited from tracktion::engine::MacroParameterElement
MacroParameterList	macroParameterList

Protected Member Functions
void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override

void	valueTreeChanged () override

void	valueTreeChildAdded (juce::ValueTree &, juce::ValueTree &) override

void	valueTreeChildRemoved (juce::ValueTree &, juce::ValueTree &, int) override

void	valueTreeParentChanged (juce::ValueTree &) override

virtual void	processingChanged ()

AutomatableParameter *	addParam (const juce::String &paramID, const juce::String &name, juce::NormalisableRange< float > valueRange)

AutomatableParameter *	addParam (const juce::String &paramID, const juce::String &name, juce::NormalisableRange< float > valueRange, std::function< juce::String(float)> valueToStringFunction, std::function< float(const juce::String &)> stringToValueFunction)

Protected Member Functions inherited from tracktion::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. More...

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

Protected Member Functions inherited from tracktion::engine::ValueTreeAllEventListener
void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override

void	valueTreeChildAdded (juce::ValueTree &, juce::ValueTree &) override

void	valueTreeChildRemoved (juce::ValueTree &, juce::ValueTree &, int) override

void	valueTreeChildOrderChanged (juce::ValueTree &, int, int) override

void	valueTreeParentChanged (juce::ValueTree &) override

void	valueTreeRedirected (juce::ValueTree &) override

Static Protected Member Functions
static void	getLeftRightChannelNames (juce::StringArray ins, juce::StringArray outs)

static void	getLeftRightChannelNames (juce::StringArray *chans)

Protected Attributes
juce::CachedValue< AtomicWrapper< bool > >	enabled

juce::CachedValue< bool >	frozen

juce::CachedValue< bool >	processing

juce::CachedValue< juce::String >	quickParamName

juce::CachedValue< EditItemID >	masterPluginID

juce::CachedValue< EditItemID >	sidechainSourceID

double	sampleRate = 44100.0

int	blockSizeSamples = 512

Member Typedef Documentation

◆ Ptr

using tracktion::engine::Plugin::Ptr = juce::ReferenceCountedObjectPtr<Plugin>

◆ Array

using tracktion::engine::Plugin::Array = juce::ReferenceCountedArray<Plugin>

Member Enumeration Documentation

◆ Type

enum tracktion::engine::Plugin::Type

strong

Enumerator
allPlugins
folderTrackPlugins
effectPlugins

Constructor & Destructor Documentation

◆ Plugin()

tracktion::engine::Plugin::Plugin ( PluginCreationInfo )

◆ ~Plugin()

tracktion::engine::Plugin::~Plugin ( )

override

Member Function Documentation

◆ selectableAboutToBeDeleted()

void tracktion::engine::Plugin::selectableAboutToBeDeleted ( )

overridevirtual

Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.

Reimplemented from tracktion::engine::Selectable.

◆ playStartedOrStopped()

void tracktion::engine::Plugin::playStartedOrStopped ( )

called by the system to let the plugin manage its automation stuff

◆ initialiseFully()

virtual void tracktion::engine::Plugin::initialiseFully ( )

virtual

Gives the plugin a chance to do extra initialisation when it's been added to an edit.

Reimplemented in tracktion::engine::FreezePointPlugin, and tracktion::engine::ExternalPlugin.

◆ flushPluginStateToValueTree()

virtual void tracktion::engine::Plugin::flushPluginStateToValueTree ( )

overridevirtual

Reimplemented from tracktion::engine::AutomatableEditItem.

Reimplemented in tracktion::engine::ExternalPlugin, and tracktion::engine::AirWindowsPlugin.

◆ getName()

virtual juce::String tracktion::engine::Plugin::getName ( ) const

overridepure virtual

The name of the type, e.g.

"Compressor"

Implements tracktion::engine::EditItem.

Referenced by getShortName().

◆ getPluginType()

virtual juce::String tracktion::engine::Plugin::getPluginType ( )

pure virtual

Referenced by getIdentifierString().

◆ getVendor()

virtual juce::String tracktion::engine::Plugin::getVendor ( )

virtual

Reimplemented in tracktion::engine::ExternalPlugin.

◆ getShortName()

virtual juce::String tracktion::engine::Plugin::getShortName ( int )

virtual

References getName().

◆ getIdentifierString()

virtual juce::String tracktion::engine::Plugin::getIdentifierString ( )

virtual

A unique string to idenitify plugin independant of install location.

Reimplemented in tracktion::engine::ExternalPlugin.

References getPluginType().

◆ getTooltip()

virtual juce::String tracktion::engine::Plugin::getTooltip ( )

virtual

default returns the name, others can return special stuff if needed

Reimplemented in tracktion::engine::RackInstance, tracktion::engine::LevelMeterPlugin, tracktion::engine::FreezePointPlugin, tracktion::engine::ExternalPlugin, and tracktion::engine::EqualiserPlugin.

◆ setEnabled()

virtual void tracktion::engine::Plugin::setEnabled ( bool )

virtual

Enable/disable the plugin.

Reimplemented in tracktion::engine::ExternalPlugin.

◆ isEnabled()

bool tracktion::engine::Plugin::isEnabled ( ) const

noexcept

References enabled.

◆ setFrozen()

void tracktion::engine::Plugin::setFrozen ( bool shouldBeFrozen )

This is a bit different to being enabled as when frozen a plugin can't be interacted with.

◆ isFrozen()

bool tracktion::engine::Plugin::isFrozen ( ) const

noexcept

References frozen.

◆ setProcessingEnabled()

void tracktion::engine::Plugin::setProcessingEnabled ( bool p )

Enable/Disable processing.

If processing is disabled, plugin should minimize memory usage and release any resources possilbe

References processing.

◆ isProcessingEnabled()

bool tracktion::engine::Plugin::isProcessingEnabled ( ) const

noexcept

References processing.

◆ initialise()

virtual void tracktion::engine::Plugin::initialise ( const PluginInitialisationInfo & )

pure virtual

Gives the plugin a chance to set itself up before being played.

This won't be called concurrently with the process thread.

The sample rate and the average block size - although the blocks won't always be the same, and may be bigger.

Don't call this directly or the initialise count will become out of sync.

See also: baseClassInitialise [[ message_thread ]]

◆ initialiseWithoutStopping()

virtual void tracktion::engine::Plugin::initialiseWithoutStopping ( const PluginInitialisationInfo & )

virtual

Tells the plugin that the audio graph has changed but the plugin isn't being re-initialised - i.e.

it's being re-used, maybe by being moved to a different track, etc. This can be called concurrently whilst the plugin is being processed so implementations of it must be thread safe. [[ message_thread ]]

Reimplemented in tracktion::engine::VolumeAndPanPlugin, tracktion::engine::LevelMeterPlugin, tracktion::engine::InsertPlugin, and tracktion::engine::AuxSendPlugin.

◆ deinitialise()

virtual void tracktion::engine::Plugin::deinitialise ( )

pure virtual

Called after play stops to release resources.

Don't call this directly or the initialise count will become out of sync.

See also: baseClassDeinitialise

◆ reset()

virtual void tracktion::engine::Plugin::reset ( )

virtual

Should reset synth voices, tails, clear delay buffers, etc.

Reimplemented in tracktion::engine::ExternalPlugin, tracktion::engine::ReverbPlugin, tracktion::engine::ImpulseResponsePlugin, tracktion::engine::FourOscPlugin, and tracktion::engine::DelayPlugin.

◆ trackPropertiesChanged()

virtual void tracktion::engine::Plugin::trackPropertiesChanged ( )

virtual

Track name or colour has changed.

Reimplemented in tracktion::engine::ExternalPlugin.

◆ applyToBuffer()

virtual void tracktion::engine::Plugin::applyToBuffer ( const PluginRenderContext & )

pure virtual

Process the next block of data.

The incoming buffer will have an unknown number of channels, and the plugin has to deal with them however it wants to.

The buffer should be resized to the number of output channels that the plugin wants to return (which should be the same or less than the number of output channel names it returns from getChannelNames() - never more than this).

◆ prepareForNextBlock()

virtual void tracktion::engine::Plugin::prepareForNextBlock ( TimePosition )

virtual

Called between successive rendering blocks.

Reimplemented in tracktion::engine::RackInstance.

◆ applyToBufferWithAutomation()

void tracktion::engine::Plugin::applyToBufferWithAutomation ( const PluginRenderContext & )

◆ getCpuUsage()

double tracktion::engine::Plugin::getCpuUsage ( ) const

noexcept

◆ getNumOutputChannelsGivenInputs()

virtual int tracktion::engine::Plugin::getNumOutputChannelsGivenInputs ( int numInputChannels )

virtual

This must return the number of output channels that the plugin will produce, given a number of input channels.

E.g. some might be able to do mono, so will return 1 if the input is 1, 2 if it is 2, etc.

The default impl just returns the number of items that getChannelNames() returns.

◆ producesAudioWhenNoAudioInput()

virtual bool tracktion::engine::Plugin::producesAudioWhenNoAudioInput ( )

virtual

Reimplemented in tracktion::engine::TextPlugin, tracktion::engine::RackInstance, tracktion::engine::FreezePointPlugin, tracktion::engine::AuxReturnPlugin, tracktion::engine::ExternalPlugin, tracktion::engine::ToneGeneratorPlugin, tracktion::engine::SamplerPlugin, tracktion::engine::FourOscPlugin, and tracktion::engine::AirWindowsPlugin.

References tracktion::engine::AutomatableEditItem::isAutomationNeeded().

◆ noTail()

virtual bool tracktion::engine::Plugin::noTail ( )

virtual

Reimplemented in tracktion::engine::ExternalPlugin.

◆ getChannelNames()

virtual void tracktion::engine::Plugin::getChannelNames	(	juce::StringArray *	ins,
		juce::StringArray *	outs
	)

virtual

Reimplemented in tracktion::engine::ExternalPlugin, tracktion::engine::InsertPlugin, tracktion::engine::PatchBayPlugin, tracktion::engine::MidiPatchBayPlugin, tracktion::engine::MidiModifierPlugin, and tracktion::engine::CompressorPlugin.

◆ takesAudioInput()

virtual bool tracktion::engine::Plugin::takesAudioInput ( )

virtual

Reimplemented in tracktion::engine::RackInstance, tracktion::engine::InsertPlugin, tracktion::engine::AuxSendPlugin, tracktion::engine::AuxReturnPlugin, tracktion::engine::ExternalPlugin, tracktion::engine::SamplerPlugin, tracktion::engine::MidiPatchBayPlugin, tracktion::engine::MidiModifierPlugin, tracktion::engine::FourOscPlugin, and tracktion::engine::AirWindowsPlugin.

References isSynth().

◆ takesMidiInput()

virtual bool tracktion::engine::Plugin::takesMidiInput ( )

virtual

Reimplemented in tracktion::engine::RackInstance, tracktion::engine::InsertPlugin, tracktion::engine::AuxReturnPlugin, tracktion::engine::ExternalPlugin, tracktion::engine::SamplerPlugin, tracktion::engine::FourOscPlugin, and tracktion::engine::AirWindowsPlugin.

◆ isSynth()

virtual bool tracktion::engine::Plugin::isSynth ( )

virtual

Reimplemented in tracktion::engine::RackInstance, tracktion::engine::ExternalPlugin, tracktion::engine::ToneGeneratorPlugin, tracktion::engine::SamplerPlugin, and tracktion::engine::FourOscPlugin.

Referenced by takesAudioInput().

◆ getLatencySeconds()

virtual double tracktion::engine::Plugin::getLatencySeconds ( )

virtual

Reimplemented in tracktion::engine::RackInstance, tracktion::engine::InsertPlugin, tracktion::engine::ExternalPlugin, tracktion::engine::PitchShiftPlugin, tracktion::engine::MidiModifierPlugin, tracktion::engine::LatencyPlugin, and tracktion::engine::ImpulseResponsePlugin.

◆ getTailLength()

virtual double tracktion::engine::Plugin::getTailLength ( ) const

virtual

Reimplemented in tracktion::engine::ExternalPlugin, and tracktion::engine::FourOscPlugin.

◆ canSidechain()

virtual bool tracktion::engine::Plugin::canSidechain ( )

virtual

◆ getInputChannelNames()

juce::StringArray tracktion::engine::Plugin::getInputChannelNames ( )

◆ getSidechainSourceNames()

juce::StringArray tracktion::engine::Plugin::getSidechainSourceNames ( bool allowNone )

◆ setSidechainSourceByName()

void tracktion::engine::Plugin::setSidechainSourceByName ( const juce::String & name )

◆ getSidechainSourceName()

juce::String tracktion::engine::Plugin::getSidechainSourceName ( )

◆ guessSidechainRouting()

void tracktion::engine::Plugin::guessSidechainRouting ( )

◆ getNumWires()

int tracktion::engine::Plugin::getNumWires ( ) const

◆ getWire()

Wire* tracktion::engine::Plugin::getWire ( int index ) const

◆ makeConnection()

void tracktion::engine::Plugin::makeConnection	(	int	srcChannel,
		int	dstChannel,
		juce::UndoManager *
	)

◆ breakConnection()

void tracktion::engine::Plugin::breakConnection	(	int	srcChannel,
		int	dstChannel
	)

◆ hasNameForMidiNoteNumber()

virtual bool tracktion::engine::Plugin::hasNameForMidiNoteNumber	(	int	note,
		int	midiChannel,
		juce::String &	name
	)

virtual

If it's a synth that names its notes, this can return the name it uses for this note 0-127.

Midi channel is 1-16

Reimplemented in tracktion::engine::ExternalPlugin, and tracktion::engine::SamplerPlugin.

◆ hasNameForMidiProgram()

virtual bool tracktion::engine::Plugin::hasNameForMidiProgram	(	int	programNum,
		int	bank,
		juce::String &	name
	)

virtual

Returns the name for a midi program, if there is one.

programNum = 0 to 127.

Reimplemented in tracktion::engine::ExternalPlugin.

◆ hasNameForMidiBank()

virtual bool tracktion::engine::Plugin::hasNameForMidiBank	(	int	bank,
		juce::String &	name
	)

virtual

◆ canBeAddedToClip()

virtual bool tracktion::engine::Plugin::canBeAddedToClip ( )

virtual

Reimplemented in tracktion::engine::VCAPlugin, tracktion::engine::InsertPlugin, tracktion::engine::FreezePointPlugin, tracktion::engine::AuxSendPlugin, tracktion::engine::AuxReturnPlugin, tracktion::engine::PatchBayPlugin, tracktion::engine::MidiPatchBayPlugin, tracktion::engine::MidiModifierPlugin, and tracktion::engine::AirWindowsPlugin.

◆ canBeAddedToRack()

virtual bool tracktion::engine::Plugin::canBeAddedToRack ( )

virtual

Reimplemented in tracktion::engine::VolumeAndPanPlugin, tracktion::engine::VCAPlugin, tracktion::engine::RackInstance, tracktion::engine::FreezePointPlugin, tracktion::engine::AuxSendPlugin, tracktion::engine::AuxReturnPlugin, tracktion::engine::PatchBayPlugin, tracktion::engine::MidiPatchBayPlugin, and tracktion::engine::AirWindowsPlugin.

◆ canBeAddedToFolderTrack()

virtual bool tracktion::engine::Plugin::canBeAddedToFolderTrack ( )

virtual

Reimplemented in tracktion::engine::VCAPlugin, and tracktion::engine::TextPlugin.

◆ canBeAddedToMaster()

virtual bool tracktion::engine::Plugin::canBeAddedToMaster ( )

virtual

Reimplemented in tracktion::engine::FreezePointPlugin.

◆ canBeDisabled()

virtual bool tracktion::engine::Plugin::canBeDisabled ( )

virtual

Reimplemented in tracktion::engine::LevelMeterPlugin, tracktion::engine::FreezePointPlugin, and tracktion::engine::PatchBayPlugin.

◆ canBeMoved()

virtual bool tracktion::engine::Plugin::canBeMoved ( )

virtual

Reimplemented in tracktion::engine::VolumeAndPanPlugin, and tracktion::engine::VCAPlugin.

◆ needsConstantBufferSize()

virtual bool tracktion::engine::Plugin::needsConstantBufferSize ( )

pure virtual

◆ isMissing()

virtual bool tracktion::engine::Plugin::isMissing ( )

virtual

for things like VSTs where the DLL is missing.

Reimplemented in tracktion::engine::ExternalPlugin.

◆ isDisabled()

virtual bool tracktion::engine::Plugin::isDisabled ( )

virtual

Plugins can be disabled to avoid them crashing Edits.

Reimplemented in tracktion::engine::ExternalPlugin.

◆ isInRack()

bool tracktion::engine::Plugin::isInRack ( ) const

◆ getOwnerRackType()

juce::ReferenceCountedObjectPtr<RackType> tracktion::engine::Plugin::getOwnerRackType ( ) const

◆ isClipEffectPlugin()

bool tracktion::engine::Plugin::isClipEffectPlugin ( ) const

◆ getWrappedAudioProcessor()

virtual juce::AudioProcessor* tracktion::engine::Plugin::getWrappedAudioProcessor ( ) const

virtual

Reimplemented in tracktion::engine::ExternalPlugin.

◆ getQuickControlParameter()

AutomatableParameter::Ptr tracktion::engine::Plugin::getQuickControlParameter ( ) const

◆ setQuickControlParameter()

void tracktion::engine::Plugin::setQuickControlParameter ( AutomatableParameter * )

◆ deleteFromParent()

virtual void tracktion::engine::Plugin::deleteFromParent ( )

virtual

Attempts to delete this plugin, whether it's a master plugin, track plugin, etc.

This will call removeFromParent but also hide any automation parameters etc. being shown on tracks and hide plugin windows etc. Use this method if the plugin is being fully deleted from the Edit.

Reimplemented in tracktion::engine::ExternalPlugin.

◆ removeFromParent()

void tracktion::engine::Plugin::removeFromParent ( )

Detaches the plugin from any parent it might be in.

This is a little more complicated than just removing its ValueTree from its parent one. Use this method if the plugin is to be inserted somewhere else in the Edit.

◆ getOwnerTrack()

Track* tracktion::engine::Plugin::getOwnerTrack ( ) const

Returns the track if it's a track or clip plugin.

◆ getOwnerClip()

Clip* tracktion::engine::Plugin::getOwnerClip ( ) const

Returns the clip if that's what it's in.

◆ getOwnerList()

PluginList* tracktion::engine::Plugin::getOwnerList ( ) const

◆ findPluginThatFeedsIntoThis()

Ptr tracktion::engine::Plugin::findPluginThatFeedsIntoThis ( ) const

◆ findPluginThatThisFeedsInto()

Ptr tracktion::engine::Plugin::findPluginThatThisFeedsInto ( ) const

◆ changed()

void tracktion::engine::Plugin::changed ( )

overridevirtual

method from Selectable, that's been overridden here to also tell the edit that it's changed.

Reimplemented from tracktion::engine::Selectable.

◆ getReferencedItems()

juce::Array<ReferencedItem> tracktion::engine::Plugin::getReferencedItems ( )

overridevirtual

Implements tracktion::engine::Exportable.

◆ reassignReferencedItem()

void tracktion::engine::Plugin::reassignReferencedItem	(	const ReferencedItem &	,
		ProjectItemID	newID,
		double	newStartTime
	)

overridevirtual

Implements tracktion::engine::Exportable.

◆ sourceMediaChanged()

virtual void tracktion::engine::Plugin::sourceMediaChanged ( )

virtual

Called when ProjectItem sources are re-assigned so you can reload from the new source.

Reimplemented in tracktion::engine::SamplerPlugin.

◆ areSelectedPluginsRackable()

static bool tracktion::engine::Plugin::areSelectedPluginsRackable ( SelectionManager & )

static

◆ wrapSelectedPluginsInRack()

static RackInstance* tracktion::engine::Plugin::wrapSelectedPluginsInRack ( SelectionManager & )

static

◆ sortPlugins() [1/2]

static void tracktion::engine::Plugin::sortPlugins ( Plugin::Array & )

static

◆ sortPlugins() [2/2]

static void tracktion::engine::Plugin::sortPlugins ( std::vector< Plugin * > & )

static

◆ setPluginToMirror()

bool tracktion::engine::Plugin::setPluginToMirror ( const Plugin::Ptr & )

◆ updateFromMirroredPluginIfNeeded()

virtual void tracktion::engine::Plugin::updateFromMirroredPluginIfNeeded ( Plugin & )

virtual

Reimplemented in tracktion::engine::ExternalPlugin.

◆ getMirroredPlugin()

Plugin::Ptr tracktion::engine::Plugin::getMirroredPlugin ( ) const

◆ baseClassNeedsInitialising()

bool tracktion::engine::Plugin::baseClassNeedsInitialising ( ) const

noexcept

Referenced by tracktion::engine::LevelMeasurerProcessingNode::~LevelMeasurerProcessingNode().

◆ baseClassInitialise()

void tracktion::engine::Plugin::baseClassInitialise ( const PluginInitialisationInfo & )

◆ baseClassDeinitialise()

void tracktion::engine::Plugin::baseClassDeinitialise ( )

Referenced by tracktion::engine::LevelMeasurerProcessingNode::~LevelMeasurerProcessingNode().

◆ setSidechainSourceID()

void tracktion::engine::Plugin::setSidechainSourceID ( EditItemID newID )

References sidechainSourceID.

◆ getSidechainSourceID()

EditItemID tracktion::engine::Plugin::getSidechainSourceID ( ) const

References sidechainSourceID.

◆ showWindowExplicitly()

void tracktion::engine::Plugin::showWindowExplicitly ( )

◆ hideWindowForShutdown()

void tracktion::engine::Plugin::hideWindowForShutdown ( )

◆ getUndoManager()

juce::UndoManager* tracktion::engine::Plugin::getUndoManager ( ) const

noexcept

◆ valueTreePropertyChanged()

void tracktion::engine::Plugin::valueTreePropertyChanged	(	juce::ValueTree &	,
		const juce::Identifier &
	)

overrideprotected

◆ valueTreeChanged()

void tracktion::engine::Plugin::valueTreeChanged ( )

overrideprotectedvirtual

Implements tracktion::engine::ValueTreeAllEventListener.

◆ valueTreeChildAdded()

void tracktion::engine::Plugin::valueTreeChildAdded	(	juce::ValueTree &	,
		juce::ValueTree &
	)

overrideprotected

◆ valueTreeChildRemoved()

void tracktion::engine::Plugin::valueTreeChildRemoved	(	juce::ValueTree &	,
		juce::ValueTree &	,
		int
	)

overrideprotected

◆ valueTreeParentChanged()

void tracktion::engine::Plugin::valueTreeParentChanged ( juce::ValueTree & )

overrideprotected

◆ processingChanged()

virtual void tracktion::engine::Plugin::processingChanged ( )

protectedvirtual

Reimplemented in tracktion::engine::ExternalPlugin.

◆ addParam() [1/2]

AutomatableParameter* tracktion::engine::Plugin::addParam	(	const juce::String &	paramID,
		const juce::String &	name,
		juce::NormalisableRange< float >	valueRange
	)

protected

◆ addParam() [2/2]

AutomatableParameter* tracktion::engine::Plugin::addParam	(	const juce::String &	paramID,
		const juce::String &	name,
		juce::NormalisableRange< float >	valueRange,
		std::function< juce::String(float)>	valueToStringFunction,
		std::function< float(const juce::String &)>	stringToValueFunction
	)

protected

◆ getLeftRightChannelNames() [1/2]

static void tracktion::engine::Plugin::getLeftRightChannelNames	(	juce::StringArray *	ins,
		juce::StringArray *	outs
	)

staticprotected

◆ getLeftRightChannelNames() [2/2]

static void tracktion::engine::Plugin::getLeftRightChannelNames ( juce::StringArray * chans )

staticprotected

Member Data Documentation

◆ windowState

std::unique_ptr<WindowState> tracktion::engine::Plugin::windowState

◆ engine

Engine& tracktion::engine::Plugin::engine

◆ state

juce::ValueTree tracktion::engine::Plugin::state

◆ enabled

juce::CachedValue<AtomicWrapper<bool> > tracktion::engine::Plugin::enabled

protected

Referenced by isEnabled().

◆ frozen

juce::CachedValue<bool> tracktion::engine::Plugin::frozen

protected

Referenced by isFrozen().

◆ processing

juce::CachedValue<bool> tracktion::engine::Plugin::processing

protected

Referenced by isProcessingEnabled(), and setProcessingEnabled().

◆ quickParamName

juce::CachedValue<juce::String> tracktion::engine::Plugin::quickParamName

protected

◆ masterPluginID

juce::CachedValue<EditItemID> tracktion::engine::Plugin::masterPluginID

protected

◆ sidechainSourceID

juce::CachedValue<EditItemID> tracktion::engine::Plugin::sidechainSourceID

protected

Referenced by getSidechainSourceID(), and setSidechainSourceID().

◆ sampleRate

double tracktion::engine::Plugin::sampleRate = 44100.0

protected

◆ blockSizeSamples

int tracktion::engine::Plugin::blockSizeSamples = 512

protected

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

tracktion_Plugin.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ Ptr

◆ Array

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Plugin()

◆ ~Plugin()

Member Function Documentation

◆ selectableAboutToBeDeleted()

◆ playStartedOrStopped()

◆ initialiseFully()

◆ flushPluginStateToValueTree()

◆ getName()

◆ getPluginType()

◆ getVendor()

◆ getShortName()

◆ getIdentifierString()

◆ getTooltip()

◆ setEnabled()

◆ isEnabled()

◆ setFrozen()

◆ isFrozen()

◆ setProcessingEnabled()

◆ isProcessingEnabled()

◆ initialise()

◆ initialiseWithoutStopping()

◆ deinitialise()

◆ reset()

◆ trackPropertiesChanged()

◆ applyToBuffer()

◆ prepareForNextBlock()

◆ applyToBufferWithAutomation()

◆ getCpuUsage()

◆ getNumOutputChannelsGivenInputs()

◆ producesAudioWhenNoAudioInput()

◆ noTail()

◆ getChannelNames()

◆ takesAudioInput()

◆ takesMidiInput()

◆ isSynth()

◆ getLatencySeconds()

◆ getTailLength()

◆ canSidechain()

◆ getInputChannelNames()

◆ getSidechainSourceNames()

◆ setSidechainSourceByName()

◆ getSidechainSourceName()

◆ guessSidechainRouting()

◆ getNumWires()

◆ getWire()

◆ makeConnection()

◆ breakConnection()

◆ hasNameForMidiNoteNumber()

◆ hasNameForMidiProgram()

◆ hasNameForMidiBank()

◆ canBeAddedToClip()

◆ canBeAddedToRack()

◆ canBeAddedToFolderTrack()

◆ canBeAddedToMaster()

◆ canBeDisabled()

◆ canBeMoved()

◆ needsConstantBufferSize()

◆ isMissing()

◆ isDisabled()

◆ isInRack()

◆ getOwnerRackType()

◆ isClipEffectPlugin()

◆ getWrappedAudioProcessor()

◆ getQuickControlParameter()

◆ setQuickControlParameter()

◆ deleteFromParent()