#include <tracktion_LatencyNode.h>

Inheritance diagram for tracktion::graph::LatencyNode:

Public Member Functions
	LatencyNode (std::unique_ptr< Node > inputNode, int numSamplesToDelay)

	LatencyNode (std::shared_ptr< Node > inputNode, int numSamplesToDelay)

	LatencyNode (Node *inputNode, int numSamplesToDelay)

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 PlaybackInitialisationInfo &info) override
	Called once before playback begins for each node.

void	process (ProcessContext &pc) 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 (Node &, const std::vector< Node * > &, TransformCache &)
	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.

Constructor & Destructor Documentation

◆ LatencyNode() [1/3]

tracktion::graph::LatencyNode::LatencyNode	(	std::unique_ptr< Node >	inputNode,
		int	numSamplesToDelay
	)

References tracktion::graph::no, tracktion::graph::Node::setOptimisations(), and tracktion::graph::yes.

◆ LatencyNode() [2/3]

tracktion::graph::LatencyNode::LatencyNode	(	std::shared_ptr< Node >	inputNode,
		int	numSamplesToDelay
	)

References tracktion::graph::no, tracktion::graph::Node::setOptimisations(), and tracktion::graph::yes.

◆ LatencyNode() [3/3]

tracktion::graph::LatencyNode::LatencyNode	(	Node *	inputNode,
		int	numSamplesToDelay
	)

References tracktion::graph::no, tracktion::graph::Node::setOptimisations(), and tracktion::graph::yes.

Member Function Documentation

◆ getNodeProperties()

NodeProperties tracktion::graph::LatencyNode::getNodeProperties ( )

overridevirtual

Should return the properties of the node.

This should not be called until after initialise.

Implements tracktion::graph::Node.

References tracktion::graph::Node::getNodeProperties(), and tracktion::graph::NodeProperties::latencyNumSamples.

Referenced by prepareToPlay().

◆ getDirectInputNodes()

std::vector< Node * > tracktion::graph::LatencyNode::getDirectInputNodes ( )

overridevirtual

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

Reimplemented from tracktion::graph::Node.

◆ isReadyToProcess()

bool tracktion::graph::LatencyNode::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.

References tracktion::graph::Node::hasProcessed().

◆ prepareToPlay()

void tracktion::graph::LatencyNode::prepareToPlay ( const 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.

References tracktion::graph::PlaybackInitialisationInfo::blockSize, getNodeProperties(), tracktion::graph::PlaybackInitialisationInfo::nodeGraphToReplace, and tracktion::graph::PlaybackInitialisationInfo::sampleRate.