ChannelSplitOutput Class Reference

Simple functionality to extract mono streams from a multichannel (e.g. stereo) signal. More...

#include <CodecOpusOgg.h>

Inheritance diagram for ChannelSplitOutput:

Classes
struct	ChannelSelectionOutputDef

Public Member Functions
	ChannelSplitOutput ()=default
	ChannelSplitOutput ()=default
	ChannelSplitOutput (Print &out, int channel)
	ChannelSplitOutput (Print &out, int channel)
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 (Print &out, int channel)
void	addOutput (Print &out, int channel)
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 ()
virtual bool	begin ()
virtual bool	begin (AudioInfo info)
virtual bool	begin (AudioInfo info)
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.
virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
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
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
void	notifyAudioChange (AudioInfo info)
void	notifyAudioChange (AudioInfo info)
template<typename T = int16_t>
size_t	writeT (const uint8_t *buffer, size_t size)
template<typename T = int16_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
SingleBuffer< uint8_t >	tmp { 8 }
int	tmpPos = 0

Detailed Description

Simple functionality to extract mono streams from a multichannel (e.g. stereo) signal.

Author

Phil Schatzmann

Copyright

GPLv3

Template Parameters

T

Constructor & Destructor Documentation

ChannelSplitOutput() [1/4]

ChannelSplitOutput ( )

default

ChannelSplitOutput() [2/4]

ChannelSplitOutput ( Print & out, int channel )

inline

ChannelSplitOutput() [3/4]

ChannelSplitOutput ( )

default

ChannelSplitOutput() [4/4]

ChannelSplitOutput ( Print & out, int channel )

inline

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/2]

void addOutput ( Print & out, int channel )

inline

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

addOutput() [2/2]

void addOutput ( Print & out, int channel )

inline

Define the channel to be sent 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/4]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, HexDumpOutput, HexDumpOutput, MemoryOutput, MemoryOutput, AudioServerEx, ChannelsSelectOutput, CsvOutput< T >, EncodedAudioOutput, FFTEffect, FFTEqualizer, FFTPitchShift, HexDumpOutput, MemoryOutput, MetaDataFilter, OggContainerOutput, OSCContainerEncoder::OSCOutput, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, R2ROutput, RTSPOutput< Platform >, and RTTTLOutput< T >.

begin() [2/4]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, HexDumpOutput, HexDumpOutput, MemoryOutput, MemoryOutput, AudioServerEx, ChannelsSelectOutput, CsvOutput< T >, EncodedAudioOutput, FFTEffect, FFTEqualizer, FFTPitchShift, HexDumpOutput, MemoryOutput, MetaDataFilter, OggContainerOutput, OSCContainerEncoder::OSCOutput, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, R2ROutput, RTSPOutput< Platform >, and RTTTLOutput< T >.

begin() [3/4]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

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

begin() [4/4]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

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

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.

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]

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

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

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/3]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MultiOutput, MetaDataOutput, and MultiOutput.

write() [2/3]

size_t write ( const uint8_t * data, size_t len )

inlineoverridevirtual

Implements AudioOutput.

write() [3/3]

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

template<typename T = int16_t>

size_t writeT ( const uint8_t * buffer, size_t size )

inlineprotected

writeT() [2/2]

template<typename T = int16_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

protected

tmp

SingleBuffer< uint8_t > tmp { 8 }

protectedinherited

tmpPos

int tmpPos = 0

protectedinherited

---

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

• src/AudioTools/AudioCodecs/CodecOpusOgg.h
• src/AudioTools/AudioCodecs/CodecTSDemux.h