Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cinder::audio::DelayNode Class Reference

General purpose delay line, supporting variable delay with linear interpolation. More...

#include <DelayNode.h>

Inheritance diagram for cinder::audio::DelayNode:
[legend]

Public Types

enum  ChannelMode { ChannelMode::SPECIFIED, ChannelMode::MATCHES_INPUT, ChannelMode::MATCHES_OUTPUT }
 

Public Member Functions

 DelayNode (const Format &format=Format())
 Constructs a DelayNode with an optional format. More...
 
void setMaxDelaySeconds (float seconds)
 Sets the maximimum delay in seconds. More...
 
float getMaxDelaySeconds () const
 Returns the maximum delay in seconds. More...
 
void setDelaySeconds (float seconds)
 Sets the delay value in seconds. Must be at least at least the length of one processing block. More...
 
float getDelaySeconds () const
 Returns the delay value in seconds. More...
 
ParamgetParamDelaySeconds ()
 Returns the Param used to automate the delay seconds. More...
 
void enable ()
 Enables this Node for processing. Same as setEnabled( true ). More...
 
void disable ()
 Disables this Node for processing. Same as setEnabled( false ). More...
 
void setEnabled (bool b=true)
 Sets whether this Node is enabled for processing or not. More...
 
bool isEnabled () const
 Returns whether this Node is enabled for processing or not. More...
 
virtual void connect (const NodeRef &output)
 Connects this Node to output. More...
 
virtual void disconnect (const NodeRef &output)
 Disconnects this Node from output. More...
 
virtual void disconnectAll ()
 Disconnects this Node from all inputs and outputs. More...
 
virtual void disconnectAllOutputs ()
 Disconnects this Node from all outputs. More...
 
virtual void disconnectAllInputs ()
 Disconnects all of this Node's inputs. More...
 
size_t getNumConnectedInputs () const
 Returns the number of inputs connected to this Node. More...
 
size_t getNumConnectedOutputs () const
 Returns the number of outputs this Node is connected to. More...
 
bool isConnectedToInput (const NodeRef &input) const
 Returns true if input is connected to this Node as an input, false otherwise. More...
 
bool isConnectedToOutput (const NodeRef &output) const
 Returns true if output is connected to this Node as an output, false otherwise. More...
 
ContextRef getContext () const
 Returns the Context associated with this Node. More...
 
size_t getNumChannels () const
 Returns the number of channels this Node will process. More...
 
ChannelMode getChannelMode () const
 Returns the channel mode. More...
 
size_t getMaxNumInputChannels () const
 Returns the maximum number of channels any input has. More...
 
size_t getSampleRate () const
 Returns the samplerate of this Node, which is governed by the Context's OutputNode. More...
 
size_t getFramesPerBlock () const
 Returns the number of frames processed in one block by this Node, which is governed by the Context's OutputNode. More...
 
bool isAutoEnabled () const
 Returns whether this Node is automatically enabled / disabled when connected. More...
 
void setAutoEnabled (bool b=true)
 Sets whether this Node is automatically enabled / disabled when connected. More...
 
bool isInitialized () const
 Returns whether this Node is in an initialized state and is capable of processing audio. More...
 
bool getProcessesInPlace () const
 Returns whether this Node will process audio with an in-place Buffer. More...
 
bool canConnectToInput (const NodeRef &input)
 Returns whether it is possible to connect to input, example reasons of failure would be this == Node, or Node is already an input. More...
 
bool checkCycle (const NodeRef &sourceNode, const NodeRef &destNode) const
 Returns true if there is an unmanageable cycle betweeen sourceNode and destNode. If any Node's in the traversal returns true for supportsCycles(), this method will return false. More...
 
const std::set< NodeRef > & getInputs () const
 Returns an immutable reference to the inputs container. More...
 
std::vector< NodeRefgetOutputs () const
 Returns a copy of the NodeRef's referenced by the this Node as outputs. The copy is necessary because outputs are stored internally with weak_ptr's. More...
 
virtual std::string getName ()
 Returns a string representing the name of this Node type. Default returns a demangled, compiler-specific class name. More...
 
void setName (const std::string &name)
 Sets this Node's name to a user-specified string. More...
 
BuffergetInternalBuffer ()
 Usually used internally by a Node subclass, returns a pointer to the internal buffer storage. More...
 
const BuffergetInternalBuffer () const
 Usually used internally by a Node subclass, returns a pointer to the internal buffer storage. More...
 
void pullInputs (Buffer *inPlaceBuffer)
 Usually called internally by the Node, in special cases sub-classes may need to call this on other Node's. More...
 

Protected Member Functions

void initialize () override
 Called before audio buffers need to be used. There is always a valid Context at this point. More...
 
void process (Buffer *buffer) override
 Override to perform audio processing on buffer. More...
 
bool supportsCycles () const override
 Default implementation returns false, return true if it makes sense for the Node to be processed in a cycle (eg. Delay). More...
 
virtual void uninitialize ()
 Called once the contents of initialize are no longer relevant, i.e. connections have changed. More...
 
virtual void enableProcessing ()
 Callled when this Node should enable processing. Initiated from Node::enable(). More...
 
virtual void disableProcessing ()
 Callled when this Node should disable processing. Initiated from Node::disable(). More...
 
virtual void sumInputs ()
 
virtual bool supportsInputNumChannels (size_t numChannels) const
 Default implementation returns true if numChannels matches our format. More...
 
virtual bool supportsProcessInPlace () const
 Default implementation returns true, subclasses should return false if they must process out-of-place (summing). More...
 
virtual void connectInput (const NodeRef &input)
 
virtual void disconnectInput (const NodeRef &input)
 
virtual void disconnectOutput (const NodeRef &output)
 
virtual void configureConnections ()
 
void setupProcessWithSumming ()
 
void notifyConnectionsDidChange ()
 
bool inputChannelsAreUnequal () const
 
void setNumChannels (size_t numChannels)
 Only Node subclasses can specify num channels directly - users specify via Format at construction time. More...
 
void setChannelMode (ChannelMode mode)
 Only Node subclasses can specify channel mode directly - users specify via Format at construction time. More...
 
void initializeImpl ()
 
void uninitializeImpl ()
 
BufferDynamicgetSummingBuffer ()
 
const BufferDynamicgetSummingBuffer () const
 

Protected Attributes

size_t mWriteIndex
 
float mMaxDelaySeconds
 
float mSampleRate
 
Param mParamDelaySeconds
 
BufferDynamic mDelayBuffer
 

Detailed Description

General purpose delay line, supporting variable delay with linear interpolation.

Enables feedback if connected in a graph cycle.

Note
Restrictions: The current minimum delay length is one processing block. Restricts channel count to 1 (mixes down inputs).

Member Enumeration Documentation

enum cinder::audio::Node::ChannelMode
stronginherited

Used to specifiy how the corresponding channels are to be resolved between two connected Node's, based on either a Node's input (the default), it's output, or specified by user.

Enumerator
SPECIFIED 

Number of channels has been specified by user or is non-settable.

MATCHES_INPUT 

This Node matches it's channels with it's input.

MATCHES_OUTPUT 

This Node matches it's channels with it's output.

Constructor & Destructor Documentation

cinder::audio::DelayNode::DelayNode ( const Format format = Format())

Constructs a DelayNode with an optional format.

Member Function Documentation

void cinder::audio::DelayNode::setMaxDelaySeconds ( float  seconds)

Sets the maximimum delay in seconds.

float cinder::audio::DelayNode::getMaxDelaySeconds ( ) const

Returns the maximum delay in seconds.

void cinder::audio::DelayNode::setDelaySeconds ( float  seconds)

Sets the delay value in seconds. Must be at least at least the length of one processing block.

float cinder::audio::DelayNode::getDelaySeconds ( ) const

Returns the delay value in seconds.

Param* cinder::audio::DelayNode::getParamDelaySeconds ( )

Returns the Param used to automate the delay seconds.

Note
Values over max delay seconds will be clipped, causing pops.
void cinder::audio::DelayNode::initialize ( )
overrideprotectedvirtual

Called before audio buffers need to be used. There is always a valid Context at this point.

Reimplemented from cinder::audio::Node.

void cinder::audio::DelayNode::process ( Buffer buffer)
overrideprotectedvirtual

Override to perform audio processing on buffer.

Reimplemented from cinder::audio::Node.

bool cinder::audio::DelayNode::supportsCycles ( ) const
overrideprotectedvirtual

Default implementation returns false, return true if it makes sense for the Node to be processed in a cycle (eg. Delay).

Reimplemented from cinder::audio::Node.

void cinder::audio::Node::enable ( )
inherited

Enables this Node for processing. Same as setEnabled( true ).

void cinder::audio::Node::disable ( )
inherited

Disables this Node for processing. Same as setEnabled( false ).

void cinder::audio::Node::setEnabled ( bool  b = true)
inherited

Sets whether this Node is enabled for processing or not.

bool cinder::audio::Node::isEnabled ( ) const
inherited

Returns whether this Node is enabled for processing or not.

void cinder::audio::Node::connect ( const NodeRef output)
virtualinherited

Connects this Node to output.

Reimplemented in cinder::audio::NodeAutoPullable.

void cinder::audio::Node::disconnect ( const NodeRef output)
virtualinherited

Disconnects this Node from output.

void cinder::audio::Node::disconnectAll ( )
virtualinherited

Disconnects this Node from all inputs and outputs.

void cinder::audio::Node::disconnectAllOutputs ( )
virtualinherited

Disconnects this Node from all outputs.

Reimplemented in cinder::audio::NodeAutoPullable.

void cinder::audio::Node::disconnectAllInputs ( )
virtualinherited

Disconnects all of this Node's inputs.

Reimplemented in cinder::audio::ChannelRouterNode.

size_t cinder::audio::Node::getNumConnectedInputs ( ) const
inherited

Returns the number of inputs connected to this Node.

size_t cinder::audio::Node::getNumConnectedOutputs ( ) const
inherited

Returns the number of outputs this Node is connected to.

bool cinder::audio::Node::isConnectedToInput ( const NodeRef input) const
inherited

Returns true if input is connected to this Node as an input, false otherwise.

bool cinder::audio::Node::isConnectedToOutput ( const NodeRef output) const
inherited

Returns true if output is connected to this Node as an output, false otherwise.

ContextRef cinder::audio::Node::getContext ( ) const
inherited

Returns the Context associated with this Node.

Note
Cannot be called from within a Node's constructor. Use initialize instead.
size_t cinder::audio::Node::getNumChannels ( ) const
inherited

Returns the number of channels this Node will process.

ChannelMode cinder::audio::Node::getChannelMode ( ) const
inherited

Returns the channel mode.

See also
ChannelMode.
size_t cinder::audio::Node::getMaxNumInputChannels ( ) const
inherited

Returns the maximum number of channels any input has.

size_t cinder::audio::Node::getSampleRate ( ) const
inherited

Returns the samplerate of this Node, which is governed by the Context's OutputNode.

size_t cinder::audio::Node::getFramesPerBlock ( ) const
inherited

Returns the number of frames processed in one block by this Node, which is governed by the Context's OutputNode.

bool cinder::audio::Node::isAutoEnabled ( ) const
inherited

Returns whether this Node is automatically enabled / disabled when connected.

void cinder::audio::Node::setAutoEnabled ( bool  b = true)
inherited

Sets whether this Node is automatically enabled / disabled when connected.

bool cinder::audio::Node::isInitialized ( ) const
inherited

Returns whether this Node is in an initialized state and is capable of processing audio.

bool cinder::audio::Node::getProcessesInPlace ( ) const
inherited

Returns whether this Node will process audio with an in-place Buffer.

bool cinder::audio::Node::canConnectToInput ( const NodeRef input)
inherited

Returns whether it is possible to connect to input, example reasons of failure would be this == Node, or Node is already an input.

bool cinder::audio::Node::checkCycle ( const NodeRef sourceNode,
const NodeRef destNode 
) const
inherited

Returns true if there is an unmanageable cycle betweeen sourceNode and destNode. If any Node's in the traversal returns true for supportsCycles(), this method will return false.

const std::set<NodeRef>& cinder::audio::Node::getInputs ( ) const
inherited

Returns an immutable reference to the inputs container.

vector< NodeRef > cinder::audio::Node::getOutputs ( ) const
inherited

Returns a copy of the NodeRef's referenced by the this Node as outputs. The copy is necessary because outputs are stored internally with weak_ptr's.

std::string cinder::audio::Node::getName ( )
virtualinherited

Returns a string representing the name of this Node type. Default returns a demangled, compiler-specific class name.

void cinder::audio::Node::setName ( const std::string name)
inherited

Sets this Node's name to a user-specified string.

Buffer* cinder::audio::Node::getInternalBuffer ( )
inherited

Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.

const Buffer* cinder::audio::Node::getInternalBuffer ( ) const
inherited

Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.

void cinder::audio::Node::pullInputs ( Buffer inPlaceBuffer)
inherited

Usually called internally by the Node, in special cases sub-classes may need to call this on other Node's.

virtual void cinder::audio::Node::uninitialize ( )
protectedvirtualinherited

Called once the contents of initialize are no longer relevant, i.e. connections have changed.

Note
Not guaranteed to be called at Node destruction.

Reimplemented in cinder::audio::FilePlayerNode, cinder::audio::cocoa::EffectAudioUnitNode, cinder::audio::cocoa::InputDeviceNodeAudioUnit, cinder::audio::cocoa::OutputDeviceNodeAudioUnit, and cinder::audio::FilterBiquadNode.

virtual void cinder::audio::Node::enableProcessing ( )
protectedvirtualinherited
virtual void cinder::audio::Node::disableProcessing ( )
protectedvirtualinherited
void cinder::audio::Node::sumInputs ( )
protectedvirtualinherited
virtual bool cinder::audio::Node::supportsInputNumChannels ( size_t  numChannels) const
protectedvirtualinherited

Default implementation returns true if numChannels matches our format.

Reimplemented in cinder::audio::ChannelRouterNode.

virtual bool cinder::audio::Node::supportsProcessInPlace ( ) const
protectedvirtualinherited

Default implementation returns true, subclasses should return false if they must process out-of-place (summing).

Reimplemented in cinder::audio::ChannelRouterNode, and cinder::audio::cocoa::OutputDeviceNodeAudioUnit.

void cinder::audio::Node::connectInput ( const NodeRef input)
protectedvirtualinherited
Note
Connection methods be called on a non-audio thread and synchronized with the Context's mutex.

Reimplemented in cinder::audio::NodeAutoPullable.

void cinder::audio::Node::disconnectInput ( const NodeRef input)
protectedvirtualinherited
void cinder::audio::Node::disconnectOutput ( const NodeRef output)
protectedvirtualinherited
void cinder::audio::Node::configureConnections ( )
protectedvirtualinherited
void cinder::audio::Node::setupProcessWithSumming ( )
protectedinherited
void cinder::audio::Node::notifyConnectionsDidChange ( )
protectedinherited
bool cinder::audio::Node::inputChannelsAreUnequal ( ) const
protectedinherited
void cinder::audio::Node::setNumChannels ( size_t  numChannels)
protectedinherited

Only Node subclasses can specify num channels directly - users specify via Format at construction time.

void cinder::audio::Node::setChannelMode ( ChannelMode  mode)
protectedinherited

Only Node subclasses can specify channel mode directly - users specify via Format at construction time.

void cinder::audio::Node::initializeImpl ( )
protectedinherited
void cinder::audio::Node::uninitializeImpl ( )
protectedinherited
BufferDynamic* cinder::audio::Node::getSummingBuffer ( )
protectedinherited
const BufferDynamic* cinder::audio::Node::getSummingBuffer ( ) const
protectedinherited

Member Data Documentation

size_t cinder::audio::DelayNode::mWriteIndex
protected
float cinder::audio::DelayNode::mMaxDelaySeconds
protected
float cinder::audio::DelayNode::mSampleRate
protected
Param cinder::audio::DelayNode::mParamDelaySeconds
protected
BufferDynamic cinder::audio::DelayNode::mDelayBuffer
protected

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