graph::SummingNode Class Reference

An Node which sums together the multiple inputs adding additional latency to provide a coherent output. More...

#include <tracktion_SummingNode.h>

Inheritance diagram for graph::SummingNode:

Public Member Functions
	SummingNode ()=default
	SummingNode (std::vector< std::unique_ptr< Node > > inputs)
	SummingNode (std::vector< Node * > inputs)
	SummingNode (std::vector< std::unique_ptr< Node > > ownedInputs, std::vector< Node * > referencedInputs)
void	addInput (std::unique_ptr< Node > newInput)
	Adds an input to be summed in this Node.
void	setDoubleProcessingPrecision (bool shouldSumInDoublePrecision)
	Enables Nodes to be intermediately summed using double precision.
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 (TransformOptions &options) override
	Called after construction to give the node a chance to modify its topology.
void	prepareToPlay (const 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	process (ProcessContext &pc) override
	Called when the node is to be processed.
Public Member Functions inherited from 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.
bool	canShareOutputBuffer () const
	Returns true if downstream Nodes may adopt this Node's output buffer as their own process buffer, overwriting its contents.
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 graph::Node
void *	internal = nullptr
int	numOutputNodes = -1
Protected Member Functions inherited from 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

An Node which sums together the multiple inputs adding additional latency to provide a coherent output.

Constructor & Destructor Documentation

SummingNode() [1/4]

graph::SummingNode::SummingNode ( )

default

SummingNode() [2/4]

graph::SummingNode::SummingNode

(

std::vector< std::unique_ptr< Node > >

inputs

)

SummingNode() [3/4]

graph::SummingNode::SummingNode

(

std::vector< Node * >

inputs

)

SummingNode() [4/4]

graph::SummingNode::SummingNode	(	std::vector< std::unique_ptr< Node > >	ownedInputs,
		std::vector< Node * >	referencedInputs
	)

Member Function Documentation

addInput()

void graph::SummingNode::addInput

(

std::unique_ptr< Node >

newInput

)

Adds an input to be summed in this Node.

setDoubleProcessingPrecision()

void graph::SummingNode::setDoubleProcessingPrecision

(

bool

shouldSumInDoublePrecision

)

Enables Nodes to be intermediately summed using double precision.

This must be set before the node is initialised. N.B. The output will still be single-precision floats.

getNodeProperties()

NodeProperties graph::SummingNode::getNodeProperties ( )

overridevirtual

Should return the properties of the node.

This should not be called until after initialise.

Implements graph::Node.

References graph::NodeProperties::hasAudio, graph::NodeProperties::hasMidi, graph::NodeProperties::latencyNumSamples, graph::NodeProperties::nodeID, and graph::NodeProperties::numberOfChannels.

getDirectInputNodes()

std::vector< Node * > graph::SummingNode::getDirectInputNodes ( )

overridevirtual

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

Reimplemented from graph::Node.

transform()

TransformResult graph::SummingNode::transform ( TransformOptions &  )

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.

Returns

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

Reimplemented from graph::Node.

References graph::Node::TransformOptions::disableLatencyCompensation.

prepareToPlay()

void graph::SummingNode::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 graph::Node.

References graph::PlaybackInitialisationInfo::blockSize.

isReadyToProcess()

bool graph::SummingNode::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 graph::Node.

process()

void graph::SummingNode::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 graph::Node.

---

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

• tracktion_SummingNode.h