tracktion::engine::ModifierNode Class Reference

Node for processing a Modifier. More...

#include <tracktion_ModifierNode.h>

Inheritance diagram for tracktion::engine::ModifierNode:

Public Types
enum class	ClearOutputs : bool { no , yes }

Public Member Functions
	ModifierNode (std::unique_ptr< Node > input, tracktion::engine::Modifier::Ptr, double sampleRateToUse, int blockSizeToUse, const TrackMuteState *, tracktion::graph::PlayHeadState &, bool rendering, ClearOutputs)
	Creates a ModifierNode to process a Modifier.
	ModifierNode (std::unique_ptr< Node > input, tracktion::engine::Modifier::Ptr, double sampleRateToUse, int blockSizeToUse, std::shared_ptr< InputProvider >)
	Creates a ModifierNode to process a plugin on in a Rack with an InputProvider.
	~ModifierNode () override
	Destructor.
Modifier &	getModifier ()
tracktion::graph::NodeProperties	getNodeProperties () override
	Should return the properties of the node.
std::vector< Node * >	getDirectInputNodes () override
	Should return all the inputs directly feeding in to this node.
bool	isReadyToProcess () override
	Should return true when this node is ready to be processed.
void	prepareToPlay (const tracktion::graph::PlaybackInitialisationInfo &) override
	Called once before playback begins for each node.
void	process (ProcessContext &) override
	Called when the node is to be processed.
Public Member Functions inherited from tracktion::graph::Node
	Node ()=default
virtual	~Node ()=default
void	initialise (const PlaybackInitialisationInfo &)
	Call once after the graph has been constructed to initialise buffers etc.
void	prepareForNextBlock (juce::Range< int64_t > referenceSampleRange)
	Call before processing the next block, used to reset the process status.
void	process (choc::buffer::FrameCount numSamples, juce::Range< int64_t > referenceSampleRange)
	Call to process the node, which will in turn call the process method with the buffers to fill.
bool	hasProcessed () const
	Returns true if this node has processed and its outputs can be retrieved.
AudioAndMidiBuffer	getProcessedOutput ()
	Returns the processed audio and MIDI output.
virtual TransformResult	transform (TransformOptions &)
	Called after construction to give the node a chance to modify its topology.
virtual std::vector< Node * >	getInternalNodes ()
	Can return Nodes that are internal to this Node but don't make up the main graph constructed from getDirectInputNodes().
void	retain ()
	Retains the buffers so they won't be deallocated after the Node has processed.
void	release ()
	Releases the buffers allowing internal storage to be deallocated.
virtual size_t	getAllocatedBytes () const
void	enablePreProcess (bool)

Additional Inherited Members
Public Attributes inherited from tracktion::graph::Node
void *	internal = nullptr
int	numOutputNodes = -1
Protected Member Functions inherited from tracktion::graph::Node
virtual void	prefetchBlock (juce::Range< int64_t >)
	Called before once on all Nodes before they are processed.
virtual void	preProcess (choc::buffer::FrameCount, juce::Range< int64_t >)
	Called when the node is to be processed, just before process.
void	setOptimisations (NodeOptimisations)
	This can be called to provide some hints about allocating or playing back a Node to improve efficiency.
void	setBufferViewToUse (Node *sourceNode, const choc::buffer::ChannelArrayView< float > &)
	This can be called during prepareToPlay to set a BufferView to use which can improve efficiency.
void	setAudioOutput (Node *sourceNode, const choc::buffer::ChannelArrayView< float > &)
	This can be called during your process function to set a view to the output.

Detailed Description

Node for processing a Modifier.

Member Enumeration Documentation

ClearOutputs

enum class tracktion::engine::ModifierNode::ClearOutputs : bool

strong

Enumerator
no
yes

Constructor & Destructor Documentation

ModifierNode() [1/2]

tracktion::engine::ModifierNode::ModifierNode	(	std::unique_ptr< Node >	input,
		tracktion::engine::Modifier::Ptr	,
		double	sampleRateToUse,
		int	blockSizeToUse,
		const TrackMuteState *	,
		tracktion::graph::PlayHeadState &	,
		bool	rendering,
		ClearOutputs
	)

Creates a ModifierNode to process a Modifier.

Parameters

const	TrackMuteState* The optional TrackMuteState to use
PlayHeadState	The PlayHeadState to monitor for jumps
rendering	Should be true if this is an offline render
ClearOutputs	Whether to clear the outputs or pass them through

ModifierNode() [2/2]

tracktion::engine::ModifierNode::ModifierNode	(	std::unique_ptr< Node >	input,
		tracktion::engine::Modifier::Ptr	,
		double	sampleRateToUse,
		int	blockSizeToUse,
		std::shared_ptr< InputProvider >
	)

Creates a ModifierNode to process a plugin on in a Rack with an InputProvider.

Parameters

InputProvider

The InputProvider to provide inputs and a PluginRenderContext

~ModifierNode()

tracktion::engine::ModifierNode::~ModifierNode ( )

override

Destructor.

Member Function Documentation

getModifier()

Modifier & tracktion::engine::ModifierNode::getModifier

(

)

getNodeProperties()

tracktion::graph::NodeProperties tracktion::engine::ModifierNode::getNodeProperties ( )

overridevirtual

Should return the properties of the node.

This should not be called until after initialise.

Implements tracktion::graph::Node.

getDirectInputNodes()

std::vector< Node * > tracktion::engine::ModifierNode::getDirectInputNodes ( )

overridevirtual

Should return all the inputs directly feeding in to this node.

Reimplemented from tracktion::graph::Node.

isReadyToProcess()

bool tracktion::engine::ModifierNode::isReadyToProcess ( )

overridevirtual

Should return true when this node is ready to be processed.

This is usually when its input's output buffers are ready.

Implements tracktion::graph::Node.

prepareToPlay()

void tracktion::engine::ModifierNode::prepareToPlay ( const tracktion::graph::PlaybackInitialisationInfo &  )

overridevirtual

Called once before playback begins for each node.

Use this to allocate buffers etc. This step can be used to modify the topology of the graph (i.e. add/remove nodes). However, if you do this, you must make sure to call initialise on them so they are fully prepared for processing.

Reimplemented from tracktion::graph::Node.

process()

void tracktion::engine::ModifierNode::process ( ProcessContext &  )

overridevirtual

Called when the node is to be processed.

This should add in to the buffers available making sure not to change their size at all.

Implements tracktion::graph::Node.

---

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

• tracktion_ModifierNode.h