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:

Classes
struct	ChannelSelectionOutputDef

Public Member Functions
	ChannelsSelectOutput ()=default
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
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	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual int	availableForWrite () override
virtual int	availableForWrite () override
virtual bool	begin (AudioInfo info)
bool	begin () override
bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	end ()
virtual void	end ()
virtual void	flush ()
virtual void	flush ()
virtual bool	isDeletable ()
	If true we need to release the related memory in the destructor.
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.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
virtual	operator bool ()
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
void	setAudioInfo (AudioInfo ai) override
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
virtual size_t	write (uint8_t ch) override
size_t	write (const uint8_t *data, size_t len) override
virtual void	writeSilence (size_t len)
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)
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< ChannelSelectionOutputDef >	out_channels {0}
SingleBuffer< uint8_t >	tmp { 8 }
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

Copyright: GPLv3

Template Parameters

T

Constructor & Destructor Documentation

◆ ChannelsSelectOutput()

ChannelsSelectOutput ( )

default

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ 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() [1/2]

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, EncodedAudioOutput, and EncodedAudioOutput.

◆ audioInfo() [2/2]

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, EncodedAudioOutput, and EncodedAudioOutput.

◆ audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ availableForWrite() [1/2]

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, MemoryOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ availableForWrite() [2/2]

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, MemoryOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ begin() [1/3]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

Reimplemented in ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, and EncodedAudioOutput.

◆ begin() [2/3]

bool begin ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

◆ begin() [3/3]

bool begin ( AudioInfo info )

inlineoverride

◆ clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ end() [1/2]

virtual void end ( )

inlinevirtualinherited

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, EncodedAudioOutput, MetaDataFilter, MetaDataOutput, OggContainerOutput, OpusOggWriter, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ end() [2/2]

virtual void end ( )

inlinevirtualinherited

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, EncodedAudioOutput, MetaDataFilter, MetaDataOutput, OggContainerOutput, OpusOggWriter, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ flush() [1/2]

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in HexDumpOutput, HexDumpOutput, MultiOutput, HexDumpOutput, and MultiOutput.

◆ flush() [2/2]

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in HexDumpOutput, HexDumpOutput, MultiOutput, HexDumpOutput, and MultiOutput.

◆ getChannels()

int getChannels	(	Print *	out,
		int	defaultChannels )

inlineprotected

Determine number of channels for destination.

◆ isDeletable() [1/2]

virtual bool isDeletable ( )

inlinevirtualinherited

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

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, and AdapterPrintToAudioOutput.

◆ isDeletable() [2/2]

virtual bool isDeletable ( )

inlinevirtualinherited

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

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, and AdapterPrintToAudioOutput.

◆ isNotifyActive() [1/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isNotifyActive() [2/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool() [1/2]

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, EncodedAudioOutput, and RTSPOutput< Platform >.

◆ operator bool() [2/2]

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, EncodedAudioOutput, and RTSPOutput< Platform >.

◆ removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

◆ removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

◆ setAudioInfo() [1/2]

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, and MultiOutput.

◆ setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo ai )

inlineoverride

◆ setNotifyActive() [1/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

◆ setNotifyActive() [2/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

◆ write() [1/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MultiOutput, MetaDataOutput, and MultiOutput.

◆ write() [2/2]

size_t write	(	const uint8_t *	data,
		size_t	len )

inlineoverridevirtual

Implements AudioOutput.

◆ writeSilence() [1/2]

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

◆ writeSilence() [2/2]

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

◆ writeT()

template<typename T>

size_t writeT	(	const uint8_t *	buffer,
		size_t	size )

inlineprotected

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ cfg

AudioInfo cfg

protectedinherited

◆ is_active

bool is_active = false

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector< AudioInfoSupport * > notify_vector

protectedinherited

◆ out_channels

Vector<ChannelSelectionOutputDef> out_channels {0}

protected

◆ tmp

SingleBuffer< uint8_t > tmp { 8 }

protectedinherited

◆ tmpPos

int tmpPos = 0

protectedinherited

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

src/AudioTools/CoreAudio/AudioIO.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ChannelsSelectOutput()

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

◆ addNotifyAudioChange() [2/2]

◆ addOutput() [1/6]

◆ addOutput() [2/6]

◆ addOutput() [3/6]

◆ addOutput() [4/6]

◆ addOutput() [5/6]

◆ addOutput() [6/6]

◆ audioInfo() [1/2]

◆ audioInfo() [2/2]

◆ audioInfoOut() [1/2]

◆ audioInfoOut() [2/2]

◆ availableForWrite() [1/2]

◆ availableForWrite() [2/2]

◆ begin() [1/3]

◆ begin() [2/3]

◆ begin() [3/3]

◆ clearNotifyAudioChange() [1/2]

◆ clearNotifyAudioChange() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ flush() [1/2]

◆ flush() [2/2]

◆ getChannels()

◆ isDeletable() [1/2]

◆ isDeletable() [2/2]

◆ isNotifyActive() [1/2]

◆ isNotifyActive() [2/2]

◆ notifyAudioChange() [1/2]

◆ notifyAudioChange() [2/2]

◆ operator bool() [1/2]

◆ operator bool() [2/2]

◆ removeNotifyAudioChange() [1/2]

◆ removeNotifyAudioChange() [2/2]

◆ setAudioInfo() [1/2]

◆ setAudioInfo() [2/2]

◆ setNotifyActive() [1/2]

◆ setNotifyActive() [2/2]

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence() [1/2]

◆ writeSilence() [2/2]

◆ writeT()

Member Data Documentation

◆ _timeout

◆ cfg

◆ is_active

◆ is_notify_active

◆ notify_vector

◆ out_channels

◆ tmp

◆ tmpPos