Fundamental building block for creating an audio processing graph. More...
#include <Node.h>
Classes | |
struct | Format |
Public Types | |
enum | ChannelMode { ChannelMode::SPECIFIED, ChannelMode::MATCHES_INPUT, ChannelMode::MATCHES_OUTPUT } |
Public Member Functions | |
Node (const Format &format) | |
virtual | ~Node () |
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< NodeRef > | getOutputs () 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... | |
Buffer * | getInternalBuffer () |
Usually used internally by a Node subclass, returns a pointer to the internal buffer storage. More... | |
const Buffer * | getInternalBuffer () 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 | |
virtual void | initialize () |
Called before audio buffers need to be used. There is always a valid Context at this point. 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 | process (Buffer *buffer) |
Override to perform audio processing on buffer. More... | |
virtual void | sumInputs () |
virtual bool | supportsInputNumChannels (size_t numChannels) const |
Default implementation returns true if numChannels matches our format. More... | |
virtual bool | supportsCycles () const |
Default implementation returns false, return true if it makes sense for the Node to be processed in a cycle (eg. Delay). 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 () |
BufferDynamic * | getSummingBuffer () |
const BufferDynamic * | getSummingBuffer () const |
Friends | |
class | Context |
class | Param |
Fundamental building block for creating an audio processing graph.
Node's allow for flexible combinations of synthesis, analysis, effects, file reading/writing, etc, and are designed so that that it is easy for users to add their own custom subclasses to a processing graph.
A Node is owned by a Context, and as such must by created using its makeNode() method, or one of the specializations for platform specific Node's.
Audio Node's are designed to operate on two different threads: a 'user' thread (i.e. main / UI) and an audio thread. Specifically, methods for connecting and disconnecting are expected to come from the 'user' thread, while the Node's process() and internal pulling methods are called from a hard real-time thread. A mutex is used (Context::getMutex()) to synchronize connection changes and pulling the audio graph. Note that if the Node's initialize() method is heavy, it can be called before connected to anything, so as to not block the audio graph. This must be done throught the Context::initializeNode() interface.
Subclassing: implement process( Buffer *buffer ) to perform audio processing. A Node does not have access to its owning Context until initialize() is called, uninitialize() is called before a Node is deallocated or channel counts change.
|
strong |
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. |
cinder::audio::Node::Node | ( | const Format & | format | ) |
|
virtual |
void cinder::audio::Node::disable | ( | ) |
Disables this Node for processing. Same as setEnabled( false )
.
void cinder::audio::Node::setEnabled | ( | bool | b = true | ) |
Sets whether this Node is enabled for processing or not.
bool cinder::audio::Node::isEnabled | ( | ) | const |
Returns whether this Node is enabled for processing or not.
Connects this Node to output.
Reimplemented in cinder::audio::NodeAutoPullable.
Disconnects this Node from output.
|
virtual |
Disconnects this Node from all inputs and outputs.
|
virtual |
Disconnects this Node from all outputs.
Reimplemented in cinder::audio::NodeAutoPullable.
|
virtual |
Disconnects all of this Node's inputs.
Reimplemented in cinder::audio::ChannelRouterNode.
size_t cinder::audio::Node::getNumConnectedInputs | ( | ) | const |
Returns the number of inputs connected to this Node.
size_t cinder::audio::Node::getNumConnectedOutputs | ( | ) | const |
Returns the number of outputs this Node is connected to.
bool cinder::audio::Node::isConnectedToInput | ( | const NodeRef & | input | ) | const |
Returns true if input is connected to this Node as an input, false otherwise.
bool cinder::audio::Node::isConnectedToOutput | ( | const NodeRef & | output | ) | const |
Returns true if output is connected to this Node as an output, false otherwise.
ContextRef cinder::audio::Node::getContext | ( | ) | const |
size_t cinder::audio::Node::getNumChannels | ( | ) | const |
Returns the number of channels this Node will process.
ChannelMode cinder::audio::Node::getChannelMode | ( | ) | const |
Returns the channel mode.
size_t cinder::audio::Node::getMaxNumInputChannels | ( | ) | const |
Returns the maximum number of channels any input has.
size_t cinder::audio::Node::getSampleRate | ( | ) | const |
Returns the samplerate of this Node, which is governed by the Context's OutputNode.
size_t cinder::audio::Node::getFramesPerBlock | ( | ) | const |
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 |
Returns whether this Node is automatically enabled / disabled when connected.
void cinder::audio::Node::setAutoEnabled | ( | bool | b = true | ) |
Sets whether this Node is automatically enabled / disabled when connected.
bool cinder::audio::Node::isInitialized | ( | ) | const |
Returns whether this Node is in an initialized state and is capable of processing audio.
bool cinder::audio::Node::getProcessesInPlace | ( | ) | const |
bool cinder::audio::Node::canConnectToInput | ( | const NodeRef & | input | ) |
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 |
Returns an immutable reference to the inputs container.
vector< NodeRef > cinder::audio::Node::getOutputs | ( | ) | 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.
|
virtual |
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 | ) |
Sets this Node's name to a user-specified string.
Buffer* cinder::audio::Node::getInternalBuffer | ( | ) |
Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.
const Buffer* cinder::audio::Node::getInternalBuffer | ( | ) | const |
Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.
|
protectedvirtual |
Called before audio buffers need to be used. There is always a valid Context at this point.
Reimplemented in cinder::audio::GenPulseNode, cinder::audio::GenOscNode, cinder::audio::FilePlayerNode, cinder::audio::MonitorSpectralNode, cinder::audio::GenTableNode, cinder::audio::cocoa::EffectAudioUnitNode, cinder::audio::cocoa::InputDeviceNodeAudioUnit, cinder::audio::BufferRecorderNode, cinder::audio::MonitorNode, cinder::audio::cocoa::OutputDeviceNodeAudioUnit, cinder::audio::FilterBiquadNode, cinder::audio::DelayNode, and cinder::audio::GenNode.
|
protectedvirtual |
Called once the contents of initialize are no longer relevant, i.e. connections have changed.
Reimplemented in cinder::audio::FilePlayerNode, cinder::audio::cocoa::EffectAudioUnitNode, cinder::audio::cocoa::InputDeviceNodeAudioUnit, cinder::audio::cocoa::OutputDeviceNodeAudioUnit, and cinder::audio::FilterBiquadNode.
|
protectedvirtual |
Callled when this Node should enable processing. Initiated from Node::enable().
Reimplemented in cinder::audio::FilePlayerNode, cinder::audio::BufferPlayerNode, cinder::audio::cocoa::InputDeviceNodeAudioUnit, and cinder::audio::cocoa::OutputDeviceNodeAudioUnit.
|
protectedvirtual |
Callled when this Node should disable processing. Initiated from Node::disable().
Reimplemented in cinder::audio::FilePlayerNode, cinder::audio::cocoa::InputDeviceNodeAudioUnit, and cinder::audio::cocoa::OutputDeviceNodeAudioUnit.
Override to perform audio processing on buffer.
Reimplemented in cinder::audio::GenPulseNode, cinder::audio::GenOscNode, cinder::audio::FilePlayerNode, cinder::audio::GenTableNode, cinder::audio::BufferPlayerNode, cinder::audio::cocoa::EffectAudioUnitNode, cinder::audio::GenTriangleNode, cinder::audio::cocoa::InputDeviceNodeAudioUnit, cinder::audio::GenSineNode, cinder::audio::CallbackProcessorNode, cinder::audio::BufferRecorderNode, cinder::audio::DivideNode, cinder::audio::MonitorNode, cinder::audio::GenPhasorNode, cinder::audio::MultiplyNode, cinder::audio::GenNoiseNode, cinder::audio::FilterBiquadNode, cinder::audio::SubtractNode, cinder::audio::DelayNode, cinder::audio::AddNode, and cinder::audio::Pan2dNode.
|
protectedvirtual |
Reimplemented in cinder::audio::ChannelRouterNode.
|
protectedvirtual |
Default implementation returns true if numChannels matches our format.
Reimplemented in cinder::audio::ChannelRouterNode.
|
protectedvirtual |
Default implementation returns false, return true if it makes sense for the Node to be processed in a cycle (eg. Delay).
Reimplemented in cinder::audio::DelayNode.
|
protectedvirtual |
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.
Reimplemented in cinder::audio::NodeAutoPullable.
Reimplemented in cinder::audio::NodeAutoPullable, and cinder::audio::ChannelRouterNode.
|
protectedvirtual |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
friend |
|
friend |