InputMerge< T > Class Template Reference

Merges multiple input streams. So if you provide 2 mono channels you get a stereo signal as result with the left channel from channel 0 and the right from channel 1. More...

#include <AudioStreams.h>

Inheritance diagram for InputMerge< T >:

Classes
struct	MergeRecord

Public Member Functions
	InputMerge ()=default
	Default constructor.
	InputMerge (Stream &left, Stream &right)
	Constructor for stereo signal from to mono input stream.
void	add (Stream &in, int channelCount, float weight=1.0)
	Adds a new input stream with 1 channel.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	Provides the audio info with the total channel count.
virtual AudioInfo	audioInfoOut ()
int	available () override
	Provides the min available data from all streams.
virtual int	availableForWrite () override
virtual bool	begin ()
virtual bool	begin (AudioInfo info)
int	channelCount ()
	Number of channels to which are mixed together = number of result channels.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
	Remove all input streams.
virtual void	flush () override
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
size_t	readBytes (uint8_t *data, size_t len) override
	Provides the data from all streams mixed together.
virtual size_t	readSilence (uint8_t *buffer, size_t length)
	Source to generate silence: just sets the buffer to 0.
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	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setWeight (int channel, float weight)
virtual 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)
	Writes len bytes of silence (=0).

Protected Member Functions
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()

Protected Attributes
int	_timeout = 10
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Vector< MergeRecord >	records
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	total_channel_count = 0

Detailed Description

template<typename T>
class audio_tools::InputMerge< T >

Merges multiple input streams. So if you provide 2 mono channels you get a stereo signal as result with the left channel from channel 0 and the right from channel 1.

Author

Phil Schatzmann

Copyright

GPLv3

Template Parameters

T

Constructor & Destructor Documentation

InputMerge()

template<typename T >

InputMerge ( Stream &  left, Stream &  right  )

inline

Constructor for stereo signal from to mono input stream.

Parameters

left
right

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, MP3DecoderMAD, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

template<typename T >

AudioInfo audioInfo ( )

inlineoverridevirtual

Provides the audio info with the total channel count.

Reimplemented from AudioStream.

audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, and ResampleStream.

available()

template<typename T >

int available ( )

inlineoverridevirtual

Provides the min available data from all streams.

Reimplemented from BaseStream.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in UDPStream, A2DPStream, AudioFFTBase, I2SCodecStream, AbstractURLStream, URLStreamESP32, I2SStream, MeasuringStream, ProgressStream, and VolumeStream.

begin()

template<typename T >

virtual bool begin ( )

inlinevirtual

Reimplemented from BaseStream.

end()

template<typename T >

void end ( )

inlineoverridevirtual

Remove all input streams.

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, Pipeline, I2SStream, and MemoryStream.

readBytes()

template<typename T >

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

Provides the data from all streams mixed together.

Reimplemented from AudioStream.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in VS1053Stream, WM8960Stream, I2SBitBang, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, MeasuringStream, VolumeMeter, TimerCallbackAudioStream, AudioBLEStream, LoRaStream, AudioFFTBase, AudioKitStream, VBANStream, AnalogAudioArduino, Equalizer3Bands, AdapterAudioOutputToAudioStream, TimedStream, ProgressStream, FormatConverterStream, FadeStream, Pipeline::ModifyingStreamAdapter, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, and ResampleStream.

setWeight()

template<typename T >

void setWeight ( int  channel, float  weight  )

inline

Defines a new weight for the indicated channel: If you set it to 0 it is muted.

write() [1/2]

virtual size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in I2SCodecStream, MozziStream, SPDIFOutput, I2SStream, A2DPStream, FaustStream< DSP >, AudioFFTBase, TfLiteAudioStream, VS1053Stream, AnalogAudioStream, AudioEffectStreamT< T >, BufferedTaskStream, TimedStream, BufferedStream, MeasuringStream, ProgressStream, VolumeStream, TfLiteAudioStreamBase, and AnalogDriverESP32V2::IO16Bit.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in BufferedTaskStream, and BufferedStream.

---

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

• src/AudioTools/CoreAudio/AudioStreams.h