#include <tracktion_TestNodes.h>

Inheritance diagram for tracktion::graph::ReturnNode:

Public Member Functions
	ReturnNode (int busIDToUse, std::optional< size_t > extraHashToUse={})

	ReturnNode (std::unique_ptr< Node > inputNode, int busIDToUse)

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.

TransformResult	transform (Node &rootNode, const std::vector< Node * > &postOrderedNodes, TransformCache &cache) override
	Called after construction to give the node a chance to modify its topology.

void	prepareToPlay (const tracktion::graph::PlaybackInitialisationInfo &info) override
	Called once before playback begins for each node.

bool	isReadyToProcess () override
	Should return true when this node is ready to be processed.

void	preProcess (choc::buffer::FrameCount, juce::Range< int64_t >) override
	Called when the node is to be processed, just before process.

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

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

◆ ReturnNode() [1/2]

tracktion::graph::ReturnNode::ReturnNode	(	int	busIDToUse,
		std::optional< size_t >	extraHashToUse = `{}`
	)

◆ ReturnNode() [2/2]

tracktion::graph::ReturnNode::ReturnNode	(	std::unique_ptr< Node >	inputNode,
		int	busIDToUse
	)

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

Member Function Documentation

◆ getNodeProperties()

NodeProperties tracktion::graph::ReturnNode::getNodeProperties ( )

overridevirtual

Should return the properties of the node.

This should not be called until after initialise.

Implements tracktion::graph::Node.

References getDirectInputNodes(), tracktion::graph::NodeProperties::hasAudio, tracktion::graph::NodeProperties::hasMidi, tracktion::graph::NodeProperties::latencyNumSamples, tracktion::graph::NodeProperties::nodeID, and tracktion::graph::NodeProperties::numberOfChannels.

Referenced by prepareToPlay().

◆ getDirectInputNodes()

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

overridevirtual

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

Reimplemented from tracktion::graph::Node.

Referenced by getNodeProperties().

◆ transform()

TransformResult tracktion::graph::ReturnNode::transform	(	Node &	,
		const std::vector< Node * > &	,
		TransformCache &
	)

overridevirtual

Called after construction to give the node a chance to modify its topology.

This should return true if any changes were made to the topology as this indicates that the method may need to be called again after other nodes have had their toplogy changed.

Parameters

postOrderedNodes	This is an ordered list obtained from visiting all the Nodes and can be used for quicker introspection of the graph
TransformCache	A cache which can be used to speed up operations during the transform stage.

Returns: TransformResult The type of transformation that has taken place. If connections have been made AND nodes deleted, return nodesDeleted

Reimplemented from tracktion::graph::Node.

References tracktion::graph::connectionsMade, and tracktion::graph::none.

◆ prepareToPlay()

void tracktion::graph::ReturnNode::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.

References tracktion::graph::PlaybackInitialisationInfo::enableNodeMemorySharing, getNodeProperties(), tracktion::graph::no, tracktion::graph::NodeProperties::numberOfChannels, and tracktion::graph::Node::setOptimisations().

◆ isReadyToProcess()

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

◆ preProcess()

void tracktion::graph::ReturnNode::preProcess	(	choc::buffer::FrameCount	,
		juce::Range< int64_t >
	)

overridevirtual

Called when the node is to be processed, just before process.

You shouldn't normally have to use this but it gives Nodes an opportunity to perform optimisations like steal input buffers from source if appropriate.

Reimplemented from tracktion::graph::Node.

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