Cinder  0.9.1
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cinder::audio::ChannelRouterNode Class Reference

#include <ChannelRouterNode.h>

Inherits cinder::audio::Node.

Classes

struct  Route
 
struct  RouteConnector
 

Public Types

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

Public Member Functions

 ChannelRouterNode (const Format &format=Format())
 
RouteConnector route (size_t inputChannelIndex, size_t outputChannelIndex)
 
RouteConnector route (size_t inputChannelIndex, size_t outputChannelIndex, size_t numChannels)
 
void addInputRoute (const NodeRef &input, size_t inputChannelIndex, size_t outputChannelIndex, size_t numChannels)
 
void disconnectAllInputs () override
 
void enable ()
 
void enable (double when)
 
void disable ()
 
void disable (double when)
 
void setEnabled (bool b)
 
void setEnabled (bool b, double when)
 
bool isEnabled () const
 
virtual void connect (const NodeRef &output)
 
virtual void disconnect (const NodeRef &output)
 
virtual void disconnectAll ()
 
virtual void disconnectAllOutputs ()
 
size_t getNumConnectedInputs () const
 
size_t getNumConnectedOutputs () const
 
bool isConnectedToInput (const NodeRef &input) const
 
bool isConnectedToOutput (const NodeRef &output) const
 
ContextRef getContext () const
 
size_t getNumChannels () const
 
ChannelMode getChannelMode () const
 
size_t getMaxNumInputChannels () const
 
size_t getSampleRate () const
 
size_t getFramesPerBlock () const
 
bool isAutoEnabled () const
 
void setAutoEnabled (bool b=true)
 
bool isInitialized () const
 
bool getProcessesInPlace () const
 
bool canConnectToInput (const NodeRef &input)
 
bool checkCycle (const NodeRef &sourceNode, const NodeRef &destNode) const
 
const std::set< NodeRef > & getInputs () const
 
std::vector< NodeRefgetOutputs () const
 
virtual std::string getName ()
 
void setName (const std::string &name)
 
BuffergetInternalBuffer ()
 
const BuffergetInternalBuffer () const
 
void pullInputs (Buffer *inPlaceBuffer)
 

Protected Member Functions

bool supportsInputNumChannels (size_t numChannels) const override
 
bool supportsProcessInPlace () const override
 
void sumInputs () override
 
void disconnectInput (const NodeRef &input) override
 
virtual void initialize ()
 
virtual void uninitialize ()
 
virtual void enableProcessing ()
 
virtual void disableProcessing ()
 
virtual void process (Buffer *buffer)
 
virtual bool supportsCycles () const
 
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)
 
void setChannelMode (ChannelMode mode)
 
const std::pair< size_t, size_t > & getProcessFramesRange () const
 
void initializeImpl ()
 
void uninitializeImpl ()
 
BufferDynamicgetSummingBuffer ()
 
const BufferDynamicgetSummingBuffer () const
 

Protected Attributes

std::list< RoutemRoutes
 

Detailed Description

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,

samplePlayer >> router->route( 0, 3 ); // routes channel 0 of samplePlayer to router's channel 3, taking as many channels from samplePlayer as possible.
samplePlayer >> router->route( 1, 0, 1 ); // routes channel 1 of samplePlayer to router's channel 0, taking only one channel.

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::ChannelRouterNode::ChannelRouterNode ( const Format format = Format())

Constructs a ChannelRouterNode object, with an optional format.

Member Function Documentation

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.

void cinder::audio::ChannelRouterNode::disconnectAllInputs ( )
overridevirtual

Disconnects all of this Node's inputs.

Reimplemented from cinder::audio::Node.

bool cinder::audio::ChannelRouterNode::supportsInputNumChannels ( size_t  numChannels) const
overrideprotectedvirtual

Default implementation returns true if numChannels matches our format.

Reimplemented from cinder::audio::Node.

bool cinder::audio::ChannelRouterNode::supportsProcessInPlace ( ) const
overrideprotectedvirtual

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

Reimplemented from cinder::audio::Node.

void cinder::audio::ChannelRouterNode::sumInputs ( )
overrideprotectedvirtual

Reimplemented from cinder::audio::Node.

void cinder::audio::ChannelRouterNode::disconnectInput ( const NodeRef input)
overrideprotectedvirtual

Reimplemented from cinder::audio::Node.

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

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

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

Enables this Node for processing at when seconds, measured against Context::getNumProcessedSeconds(). Same as setEnabled( true, when ).

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

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

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

Disables this Node for processing at when seconds, measured against Context::getNumProcessedSeconds(). Same as setEnabled( false, when ).

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

Sets whether this Node is enabled for processing or not.

void cinder::audio::Node::setEnabled ( bool  b,
double  when 
)
inherited

Sets whether this Node is enabled for processing or not at when seconds, measured against Context::getNumProcessedSeconds().

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.

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::initialize ( )
protectedvirtualinherited
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
virtual void cinder::audio::Node::process ( Buffer buffer)
protectedvirtualinherited
virtual bool cinder::audio::Node::supportsCycles ( ) const
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.

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::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.

const std::pair<size_t, size_t>& cinder::audio::Node::getProcessFramesRange ( ) const
protectedinherited

Returns a pair of frame indices for Nodes that wish to support sample accurate enable and disable.

The first index is where processing should start, the second is where it should end. Should only be called on the audio thread from within a Node's process() method. Unless scheduled (with Context::schedule()), this will be [0, getFramesPerBlock()]

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

std::list<Route> cinder::audio::ChannelRouterNode::mRoutes
protected

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