arduino-audio-tools
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ChannelsSelectOutput Class Reference

Flexible functionality to extract one or more channels from a multichannel signal. Warning: the destinatios added with addOutput are not automatically notified about audio changes. More...

#include <AudioIO.h>

Inheritance diagram for ChannelsSelectOutput:
AudioOutput Print AudioInfoSupport AudioInfoSource

Classes

struct  ChannelSelectionOutputDef
 

Public Member Functions

virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
void addOutput (AudioOutput &out, uint16_t channel)
 
void addOutput (AudioOutput &out, uint16_t left, uint16_t right)
 
void addOutput (AudioStream &out, uint16_t channel)
 
void addOutput (AudioStream &out, uint16_t left, uint16_t right)
 
void addOutput (Print &out, uint16_t channel)
 
void addOutput (Print &out, uint16_t left, uint16_t right)
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
virtual int availableForWrite () override
 
bool begin ()
 
bool begin (AudioInfo info)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual void end ()
 
virtual void flush ()
 
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
void setAudioInfo (AudioInfo ai) override
 Defines the input AudioInfo.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
size_t write (const uint8_t *data, size_t len) override
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 

Protected Member Functions

int getChannels (Print *out, int defaultChannels)
 Determine number of channels for destination.
 
void notifyAudioChange (AudioInfo info)
 
template<typename T >
size_t writeT (const uint8_t *buffer, size_t size)
 

Protected Attributes

int _timeout = 10
 
AudioInfo cfg
 
bool is_active = false
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
Vector< ChannelSelectionOutputDefout_channels {0}
 
SingleBuffer< uint8_ttmp {MAX_SINGLE_CHARS}
 
int tmpPos = 0
 

Detailed Description

Flexible functionality to extract one or more channels from a multichannel signal. Warning: the destinatios added with addOutput are not automatically notified about audio changes.

Author
Phil Schatzmann
Template Parameters
T

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport bi)
inlinevirtualinherited

◆ addOutput() [1/6]

void addOutput ( AudioOutput out,
uint16_t  channel 
)
inline

Define the channel to be selected to the specified output. 0: first (=left) channel, 1: second (=right) channel

◆ addOutput() [2/6]

void addOutput ( AudioOutput out,
uint16_t  left,
uint16_t  right 
)
inline

Define the stereo channels to be selected to the specified output. 0: first (=left) channel, 1: second (=right) channel

◆ addOutput() [3/6]

void addOutput ( AudioStream out,
uint16_t  channel 
)
inline

Define the channel to be selected to the specified output. 0: first (=left) channel, 1: second (=right) channel

◆ addOutput() [4/6]

void addOutput ( AudioStream out,
uint16_t  left,
uint16_t  right 
)
inline

Define the stereo channels to be selected to the specified output. 0: first (=left) channel, 1: second (=right) channel

◆ addOutput() [5/6]

void addOutput ( Print out,
uint16_t  channel 
)
inline

Define the channel to be selected to the specified output. 0: first (=left) channel, 1: second (=right) channel

◆ addOutput() [6/6]

void addOutput ( Print out,
uint16_t  left,
uint16_t  right 
)
inline

Define the stereo channels to be selected to the specified output. 0: first (=left) channel, 1: second (=right) channel

◆ audioInfo()

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ availableForWrite()

virtual int availableForWrite ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in RTSPOutput, and AudioFFTBase.

◆ begin() [1/2]

bool begin ( )
inlinevirtual

Reimplemented from AudioOutput.

◆ begin() [2/2]

bool begin ( AudioInfo  info)
inlinevirtual

Reimplemented from AudioOutput.

◆ end()

virtual void end ( )
inlinevirtualinherited

◆ flush()

virtual void flush ( )
inlinevirtualinherited

Reimplemented from Print.

◆ isDeletable()

virtual bool isDeletable ( )
inlinevirtualinherited

If true we need to release the related memory in the destructor.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ operator bool()

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in EncodedAudioOutput, and RTSPOutput.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo  info)
inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioOutput.

◆ write() [1/2]

size_t write ( const uint8_t data,
size_t  len 
)
inlineoverridevirtual

Implements AudioOutput.

◆ write() [2/2]

virtual size_t write ( uint8_t  ch)
inlineoverridevirtualinherited

Reimplemented in OversamplingDAC.

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtualinherited

Writes n 0 values (= silence)

Parameters
len

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