Node for mapping input channels to output channels. More...
#include <ChannelRouterNode.h>
Classes | |
struct | Route |
struct | RouteConnector |
Used in conjunction with operator>> and the route() methods to make connections that conduct channel routing. This class is usually not directly constructed by the user. More... | |
Public Types | |
enum | ChannelMode { ChannelMode::SPECIFIED, ChannelMode::MATCHES_INPUT, ChannelMode::MATCHES_OUTPUT } |
Public Member Functions | |
ChannelRouterNode (const Format &format=Format()) | |
Constructs a ChannelRouterNode object, with an optional format. More... | |
RouteConnector | route (size_t inputChannelIndex, size_t outputChannelIndex) |
Used in conjunction with operator>> , specified that the routing is to map the input's inputChannelIndex to the output's (this ChannelRouterNode) outputChannelIndex, routing as many channels as possible. More... | |
RouteConnector | route (size_t inputChannelIndex, size_t outputChannelIndex, size_t numChannels) |
Used in conjunction with operator>> , specified that the routing is to map the input's inputChannelIndex to the output's (this ChannelRouterNode) outputChannelIndex, routing numChannels number of channels. More... | |
void | addInputRoute (const NodeRef &input, size_t inputChannelIndex, size_t outputChannelIndex, size_t numChannels) |
Adds input to the route list, routing numChannels starting at inputChannelIndex of input to outputChannelIndex. More... | |
virtual void | disconnectAllInputs () override |
Disconnects all of this Node's inputs. 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... | |
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 bool | supportsInputNumChannels (size_t numChannels) const override |
Default implementation returns true if numChannels matches our format. More... | |
virtual bool | supportsProcessInPlace () const override |
Default implementation returns true, subclasses should return false if they must process out-of-place (summing). More... | |
virtual void | sumInputs () override |
virtual void | disconnectInput (const NodeRef &input) override |
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 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 void | connectInput (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 |
Protected Attributes | |
std::list< Route > | mRoutes |
Node for mapping input channels to output channels.
ChannelRouterNode allows one to route the channels of connected inputs to specific output channels, which can be useful for, among other things:
The class is designed to be connected using the overloaded operator>>
, similar to how typical Node's are connected but via one of the route() variants. The first variant takes an input channel index and an output channel index, and routes either all of the input's channels or as many as many channels are available based on the ChannelRouterNode's specified channel count (via its Node::Format() at construction). For example,
|
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. |
Constructs a ChannelRouterNode object, with an optional format.
ChannelRouterNode::RouteConnector cinder::audio::ChannelRouterNode::route | ( | size_t | inputChannelIndex, |
size_t | outputChannelIndex | ||
) |
Used in conjunction with operator>>
, specified that the routing is to map the input's inputChannelIndex to the output's (this ChannelRouterNode) outputChannelIndex, routing as many channels as possible.
ChannelRouterNode::RouteConnector cinder::audio::ChannelRouterNode::route | ( | size_t | inputChannelIndex, |
size_t | outputChannelIndex, | ||
size_t | numChannels | ||
) |
Used in conjunction with operator>>
, specified that the routing is to map the input's inputChannelIndex to the output's (this ChannelRouterNode) outputChannelIndex, routing numChannels number of channels.
void cinder::audio::ChannelRouterNode::addInputRoute | ( | const NodeRef & | input, |
size_t | inputChannelIndex, | ||
size_t | outputChannelIndex, | ||
size_t | numChannels | ||
) |
Adds input to the route list, routing numChannels starting at inputChannelIndex of input to outputChannelIndex.
|
overridevirtual |
Disconnects all of this Node's inputs.
Reimplemented from cinder::audio::Node.
|
overrideprotectedvirtual |
Default implementation returns true if numChannels matches our format.
Reimplemented from cinder::audio::Node.
|
overrideprotectedvirtual |
Default implementation returns true, subclasses should return false if they must process out-of-place (summing).
Reimplemented from cinder::audio::Node.
|
overrideprotectedvirtual |
Reimplemented from cinder::audio::Node.
|
overrideprotectedvirtual |
Reimplemented from cinder::audio::Node.
|
inherited |
Enables this Node for processing. Same as setEnabled( true )
.
|
inherited |
Disables this Node for processing. Same as setEnabled( false )
.
|
inherited |
Sets whether this Node is enabled for processing or not.
|
inherited |
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.
|
virtualinherited |
Disconnects this Node from all inputs and outputs.
|
virtualinherited |
Disconnects this Node from all outputs.
Reimplemented in cinder::audio::NodeAutoPullable.
|
inherited |
Returns the number of inputs connected to this Node.
|
inherited |
Returns the number of outputs this Node is connected to.
|
inherited |
Returns true if input is connected to this Node as an input, false otherwise.
|
inherited |
Returns true if output is connected to this Node as an output, false otherwise.
|
inherited |
|
inherited |
Returns the number of channels this Node will process.
|
inherited |
Returns the channel mode.
|
inherited |
Returns the maximum number of channels any input has.
|
inherited |
Returns the samplerate of this Node, which is governed by the Context's OutputNode.
|
inherited |
Returns the number of frames processed in one block by this Node, which is governed by the Context's OutputNode.
|
inherited |
Returns whether this Node is automatically enabled / disabled when connected.
|
inherited |
Sets whether this Node is automatically enabled / disabled when connected.
|
inherited |
Returns whether this Node is in an initialized state and is capable of processing audio.
|
inherited |
|
inherited |
|
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.
|
inherited |
Returns an immutable reference to the inputs container.
|
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.
|
virtualinherited |
Returns a string representing the name of this Node type. Default returns a demangled, compiler-specific class name.
|
inherited |
Sets this Node's name to a user-specified string.
|
inherited |
Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.
|
inherited |
Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.
|
protectedvirtualinherited |
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.
|
protectedvirtualinherited |
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.
|
protectedvirtualinherited |
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.
|
protectedvirtualinherited |
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.
|
protectedvirtualinherited |
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.
Reimplemented in cinder::audio::NodeAutoPullable.
|
protectedvirtualinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protected |