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::TrackWaveInputDeviceNode Class Referencefinal

A Node that takes audio from the output of a track and sends it to its corresponding InputDevice. More...

#include "tracktion_TrackWaveInputDeviceNode.h"

Inheritance diagram for tracktion::engine::TrackWaveInputDeviceNode:
tracktion::graph::Node tracktion::engine::TracktionEngineNode

Public Member Functions

 TrackWaveInputDeviceNode (ProcessState &, WaveInputDevice &, std::unique_ptr< Node >, bool copyInputsToOutputs)
 
std::vector< Node * > getDirectInputNodes () override
 Should return all the inputs directly feeding in to this node.
 
tracktion::graph::NodeProperties getNodeProperties () override
 Should return the properties of the node.
 
void prepareToPlay (const tracktion::graph::PlaybackInitialisationInfo &) 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 &) 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.
 
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

A Node that takes audio from the output of a track and sends it to its corresponding InputDevice.

Definition at line 17 of file tracktion_TrackWaveInputDeviceNode.h.

Constructor & Destructor Documentation

◆ TrackWaveInputDeviceNode()

tracktion::engine::TrackWaveInputDeviceNode::TrackWaveInputDeviceNode ( ProcessState processState_,
WaveInputDevice owner,
std::unique_ptr< Node inputNode,
bool  copyInputsToOutputs 
)

Definition at line 15 of file tracktion_TrackWaveInputDeviceNode.cpp.

Member Function Documentation

◆ getDirectInputNodes()

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

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

Reimplemented from tracktion::graph::Node.

Definition at line 27 of file tracktion_TrackWaveInputDeviceNode.cpp.

◆ getNodeProperties()

tracktion::graph::NodeProperties tracktion::engine::TrackWaveInputDeviceNode::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_TrackWaveInputDeviceNode.cpp.

◆ isReadyToProcess()

bool tracktion::engine::TrackWaveInputDeviceNode::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 46 of file tracktion_TrackWaveInputDeviceNode.cpp.

◆ prepareToPlay()

void tracktion::engine::TrackWaveInputDeviceNode::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 37 of file tracktion_TrackWaveInputDeviceNode.cpp.

◆ process()

void tracktion::engine::TrackWaveInputDeviceNode::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 51 of file tracktion_TrackWaveInputDeviceNode.cpp.


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