tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
tracktion::engine::PluginAudioNode Class Reference
Inheritance diagram for tracktion::engine::PluginAudioNode:
tracktion::engine::AudioNode

Public Member Functions

 PluginAudioNode (const Plugin::Ptr &p, AudioNode *in, bool denormalisationNoise)
 
void getAudioNodeProperties (AudioNodeProperties &info) override
 
void visitNodes (const VisitorFn &v) override
 
Plugin::Ptr getPlugin () const override
 
bool purgeSubNodes (bool keepAudio, bool keepMidi) override
 Tells the node to delete any sub-nodes that don't produce the required type of output.
 
void prepareAudioNodeToPlay (const PlaybackInitialisationInfo &info) override
 tells the node to initialise itself ready for playing from the given time.
 
bool isReadyToRender () override
 
double getLatencySeconds () const noexcept
 
void releaseAudioNodeResources () override
 tells the node that play has stopped, and it can free up anything it no longer needs.
 
void renderAdding (const AudioRenderContext &rc) override
 
void renderOver (const AudioRenderContext &rc) override
 
virtual void renderPlugin (const AudioRenderContext &rc)
 
void prepareForNextBlock (const AudioRenderContext &rc) override
 
- Public Member Functions inherited from tracktion::engine::AudioNode
void callRenderAdding (const AudioRenderContext &)
 
void callRenderOver (const AudioRenderContext &)
 

Protected Member Functions

PluginRenderContext createPluginRenderContext (const AudioRenderContext &rc)
 

Protected Attributes

Plugin::Ptr plugin
 
std::unique_ptr< AudioNode > input
 
bool hasAudioInput
 
bool hasMidiInput
 
bool applyAntiDenormalisationNoise
 
bool hasInitialised
 
double latencySeconds
 

Additional Inherited Members

- Public Types inherited from tracktion::engine::AudioNode
using VisitorFn = std::function< void(AudioNode &)>
 
- Static Public Member Functions inherited from tracktion::engine::AudioNode
template<typename CallbackType >
static void invokeSplitRender (const AudioRenderContext &rc, CallbackType &target)
 

Detailed Description

Definition at line 20 of file tracktion_PluginAudioNode.h.

Constructor & Destructor Documentation

◆ PluginAudioNode()

tracktion::engine::PluginAudioNode::PluginAudioNode ( const Plugin::Ptr &  p,
AudioNode *  in,
bool  denormalisationNoise 
)

Definition at line 23 of file tracktion_PluginAudioNode.h.

◆ ~PluginAudioNode()

tracktion::engine::PluginAudioNode::~PluginAudioNode ( )
override

Definition at line 30 of file tracktion_PluginAudioNode.h.

Member Function Documentation

◆ createPluginRenderContext()

PluginRenderContext tracktion::engine::PluginAudioNode::createPluginRenderContext ( const AudioRenderContext &  rc)
protected

Definition at line 183 of file tracktion_PluginAudioNode.h.

◆ getAudioNodeProperties()

void tracktion::engine::PluginAudioNode::getAudioNodeProperties ( AudioNodeProperties &  info)
overridevirtual

Implements tracktion::engine::AudioNode.

Definition at line 36 of file tracktion_PluginAudioNode.h.

◆ getLatencySeconds()

double tracktion::engine::PluginAudioNode::getLatencySeconds ( ) const
noexcept

Definition at line 96 of file tracktion_PluginAudioNode.h.

◆ getPlugin()

Plugin::Ptr tracktion::engine::PluginAudioNode::getPlugin ( ) const
overridevirtual

Reimplemented from tracktion::engine::AudioNode.

Definition at line 64 of file tracktion_PluginAudioNode.h.

◆ isReadyToRender()

bool tracktion::engine::PluginAudioNode::isReadyToRender ( )
overridevirtual

Implements tracktion::engine::AudioNode.

Definition at line 88 of file tracktion_PluginAudioNode.h.

◆ prepareAudioNodeToPlay()

void tracktion::engine::PluginAudioNode::prepareAudioNodeToPlay ( const PlaybackInitialisationInfo &  )
overridevirtual

tells the node to initialise itself ready for playing from the given time.

This call may be made more than once before releaseAudioNodeResources() is called

Implements tracktion::engine::AudioNode.

Definition at line 75 of file tracktion_PluginAudioNode.h.

◆ prepareForNextBlock()

void tracktion::engine::PluginAudioNode::prepareForNextBlock ( const AudioRenderContext &  rc)
overridevirtual

Reimplemented from tracktion::engine::AudioNode.

Definition at line 170 of file tracktion_PluginAudioNode.h.

◆ purgeSubNodes()

bool tracktion::engine::PluginAudioNode::purgeSubNodes ( bool  keepAudio,
bool  keepMidi 
)
overridevirtual

Tells the node to delete any sub-nodes that don't produce the required type of output.

This optimises out any unplayable bits of the audio graph. Returns true if this node should be kept, false if this node can itself be deleted.

Implements tracktion::engine::AudioNode.

Definition at line 66 of file tracktion_PluginAudioNode.h.

◆ releaseAudioNodeResources()

void tracktion::engine::PluginAudioNode::releaseAudioNodeResources ( )
overridevirtual

tells the node that play has stopped, and it can free up anything it no longer needs.

Implements tracktion::engine::AudioNode.

Definition at line 101 of file tracktion_PluginAudioNode.h.

◆ renderAdding()

void tracktion::engine::PluginAudioNode::renderAdding ( const AudioRenderContext &  rc)
overridevirtual

Implements tracktion::engine::AudioNode.

Definition at line 114 of file tracktion_PluginAudioNode.h.

◆ renderOver()

void tracktion::engine::PluginAudioNode::renderOver ( const AudioRenderContext &  rc)
overridevirtual

Implements tracktion::engine::AudioNode.

Definition at line 130 of file tracktion_PluginAudioNode.h.

◆ renderPlugin()

virtual void tracktion::engine::PluginAudioNode::renderPlugin ( const AudioRenderContext &  rc)
virtual

Definition at line 157 of file tracktion_PluginAudioNode.h.

◆ visitNodes()

void tracktion::engine::PluginAudioNode::visitNodes ( const VisitorFn &  v)
overridevirtual

Implements tracktion::engine::AudioNode.

Definition at line 56 of file tracktion_PluginAudioNode.h.

Member Data Documentation

◆ applyAntiDenormalisationNoise

bool tracktion::engine::PluginAudioNode::applyAntiDenormalisationNoise
protected

Definition at line 180 of file tracktion_PluginAudioNode.h.

◆ hasAudioInput

bool tracktion::engine::PluginAudioNode::hasAudioInput
protected

Definition at line 180 of file tracktion_PluginAudioNode.h.

◆ hasInitialised

bool tracktion::engine::PluginAudioNode::hasInitialised
protected

Definition at line 180 of file tracktion_PluginAudioNode.h.

◆ hasMidiInput

bool tracktion::engine::PluginAudioNode::hasMidiInput
protected

Definition at line 180 of file tracktion_PluginAudioNode.h.

◆ input

std::unique_ptr<AudioNode> tracktion::engine::PluginAudioNode::input
protected

Definition at line 178 of file tracktion_PluginAudioNode.h.

◆ latencySeconds

double tracktion::engine::PluginAudioNode::latencySeconds
protected

Definition at line 181 of file tracktion_PluginAudioNode.h.

◆ plugin

Plugin::Ptr tracktion::engine::PluginAudioNode::plugin
protected

Definition at line 177 of file tracktion_PluginAudioNode.h.

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