tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
tracktion::engine::LevelMeasurerProcessingNode Class Referencefinal

A Node that introduces latency to balance the latency at the root Node and its position in the graph. More...

#include "tracktion_LevelMeasurerProcessingNode.h"

Inheritance diagram for tracktion::engine::LevelMeasurerProcessingNode:
tracktion::graph::Node

Public Member Functions

 LevelMeasurerProcessingNode (std::unique_ptr< tracktion::graph::Node > inputNode, LevelMeterPlugin &levelMeterPlugin)
 
tracktion::graph::NodeProperties getNodeProperties () override
 Should return the properties of the node.
 
std::vector< tracktion::graph::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 &info) override
 Called once before playback begins for each node.
 
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
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
 
int numOutputNodes
 
- 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.
 

Detailed Description

A Node that introduces latency to balance the latency at the root Node and its position in the graph.

Definition at line 17 of file tracktion_LevelMeasurerProcessingNode.h.

Constructor & Destructor Documentation

◆ LevelMeasurerProcessingNode()

tracktion::engine::LevelMeasurerProcessingNode::LevelMeasurerProcessingNode ( std::unique_ptr< tracktion::graph::Node inputNode,
LevelMeterPlugin levelMeterPlugin 
)

Definition at line 20 of file tracktion_LevelMeasurerProcessingNode.h.

◆ ~LevelMeasurerProcessingNode()

tracktion::engine::LevelMeasurerProcessingNode::~LevelMeasurerProcessingNode ( )
override

Definition at line 26 of file tracktion_LevelMeasurerProcessingNode.h.

Member Function Documentation

◆ getDirectInputNodes()

std::vector< tracktion::graph::Node * > tracktion::engine::LevelMeasurerProcessingNode::getDirectInputNodes ( )
overridevirtual

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

Reimplemented from tracktion::graph::Node.

Definition at line 37 of file tracktion_LevelMeasurerProcessingNode.h.

◆ getNodeProperties()

tracktion::graph::NodeProperties tracktion::engine::LevelMeasurerProcessingNode::getNodeProperties ( )
overridevirtual

Should return the properties of the node.

This should not be called until after initialise.

Implements tracktion::graph::Node.

Definition at line 32 of file tracktion_LevelMeasurerProcessingNode.h.

◆ isReadyToProcess()

bool tracktion::engine::LevelMeasurerProcessingNode::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.

Definition at line 42 of file tracktion_LevelMeasurerProcessingNode.h.

◆ prepareToPlay()

void tracktion::engine::LevelMeasurerProcessingNode::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.

Definition at line 47 of file tracktion_LevelMeasurerProcessingNode.h.

◆ preProcess()

void tracktion::engine::LevelMeasurerProcessingNode::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.

Definition at line 83 of file tracktion_LevelMeasurerProcessingNode.h.

◆ process()

void tracktion::engine::LevelMeasurerProcessingNode::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.

Definition at line 89 of file tracktion_LevelMeasurerProcessingNode.h.


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