A Stream implementation for resamping using a specified interpolation algorithm. More...

#include <ResampleStreamT.h>

Inheritance diagram for ResampleStreamT< TInterpolator >:

Public Member Functions
	ResampleStreamT ()=default
	Default constructor.

	ResampleStreamT (AudioOutput &out)
	Constructor for output to an AudioOutput interface.

	ResampleStreamT (AudioStream &io)
	Constructor for input/output via an AudioStream interface.

	ResampleStreamT (Print &out)
	Constructor for output to a Print interface.

	ResampleStreamT (Stream &io)
	Constructor for input/output via a Stream interface.

virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo

AudioInfo	audioInfoOut () override
	Returns the output audio information, adjusting the sample rate according to the step size.

int	available () override

int	availableForWrite () override

bool	begin ()

bool	begin (AudioInfo info, float step)
	Initializes the resampler with audio info and a step size.

bool	begin (ResampleConfig cfg)
	Initializes the resampler with the given configuration.

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

ResampleConfig	defaultConfig ()

void	end () override

virtual void	flush () override

float	getByteFactor () override

virtual Print *	getPrint ()

float	getStepSize () const
	Gets the current resampling step size.

virtual Stream *	getStream ()

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

virtual	operator bool ()

size_t	readBytes (uint8_t *data, size_t len) override

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.

void	resizeReadResultQueue (int size)

void	setAudioInfo (AudioInfo newInfo) override
	Sets the audio format information and updates the channel count.

void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)

virtual void	setOutput (AudioOutput &print)

virtual void	setOutput (Print &print) override
	Defines/Changes the output target.

void	setStepSize (float step)
	Sets the resampling step size for all channels.

virtual void	setStream (AudioStream &stream)

virtual void	setStream (Stream &stream) override
	Defines/Changes the input & output.

void	setWriteBufferSize (int size)

virtual TransformationReader< ReformatBaseStream > &	transformationReader ()
	Provides access to the TransformationReader.

size_t	write (const uint8_t *data, size_t len) override
	Write interleaved samples to the stream.

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 ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

void	setupReader ()

template<typename T >
size_t	writeT (Print p_out, const uint8_t buffer, size_t bytes, size_t &written)
	Writes the buffer to defined output after resampling.

Protected Attributes
MultiChannelResampler< TInterpolator >	_resampler

int	_timeout = 10

ResampleConfig	cfg

AudioInfo	info

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

Print *	p_print = nullptr

Stream *	p_stream = nullptr

TransformationReader< ReformatBaseStream >	reader

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

template<class TInterpolator>
class audio_tools::ResampleStreamT< TInterpolator >

A Stream implementation for resamping using a specified interpolation algorithm.

Template Parameters

TInterpolator The resampler type (must derive from BaseInterpolator).

Constructor & Destructor Documentation

◆ ResampleStreamT() [1/5]

template<class TInterpolator >

ResampleStreamT ( )

default

Default constructor.

◆ ResampleStreamT() [2/5]

template<class TInterpolator >

ResampleStreamT ( Print & out )

inline

Constructor for output to a Print interface.

Parameters

out	The Print interface to write resampled data to.

◆ ResampleStreamT() [3/5]

template<class TInterpolator >

ResampleStreamT ( AudioOutput & out )

inline

Constructor for output to an AudioOutput interface.

Parameters

out	The AudioOutput interface to write resampled data to.

◆ ResampleStreamT() [4/5]

template<class TInterpolator >

ResampleStreamT ( Stream & io )

inline

Constructor for input/output via a Stream interface.

Parameters

io	The Stream interface to read/write data.

◆ ResampleStreamT() [5/5]

template<class TInterpolator >

ResampleStreamT ( AudioStream & io )

inline

Constructor for input/output via an AudioStream interface.

Parameters

io	The AudioStream interface to read/write data.

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, EncodedAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and InputMerge< T >.

◆ audioInfoOut()

template<class TInterpolator >

AudioInfo audioInfoOut ( )

inlineoverridevirtual

Returns the output audio information, adjusting the sample rate according to the step size.

Returns: The output AudioInfo.

Reimplemented from AudioInfoSupport.

◆ available()

int available ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

◆ availableForWrite()

int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

◆ begin() [1/3]

template<class TInterpolator >

bool begin ( )

inlinevirtual

Reimplemented from BaseStream.

◆ begin() [2/3]

template<class TInterpolator >

bool begin	(	AudioInfo	info,
		float	step
	)

inline

Initializes the resampler with audio info and a step size.

Parameters

info	The audio format information.
step	The resampling step size.

Returns: True if initialization was successful.

◆ begin() [3/3]

template<class TInterpolator >

bool begin ( ResampleConfig cfg )

inline

Initializes the resampler with the given configuration.

Parameters

cfg	The resampling configuration.

Returns: True if initialization was successful.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ defaultConfig()

template<class TInterpolator >

ResampleConfig defaultConfig ( )

inline

◆ end()

void end ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

◆ flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, AudioStreamWrapper, ResampleStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.

◆ getByteFactor()

template<class TInterpolator >

float getByteFactor ( )

inlineoverridevirtual

Implements ReformatBaseStream.

◆ getPrint()

virtual Print * getPrint ( )

inlinevirtualinherited

◆ getStepSize()

template<class TInterpolator >

float getStepSize ( ) const

inline

Gets the current resampling step size.

Returns: The step size.

◆ getStream()

virtual Stream * getStream ( )

inlinevirtualinherited

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ not_supported()

virtual int not_supported	(	int	out,
		const char *	msg = `""`
	)

inlineprotectedvirtualinherited

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, ICYStreamT< T >, AudioBLEStream, AudioFFTBase, PortAudioStream, URLStream, I2SStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and Pipeline.

◆ readBytes()

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtualinherited

Reimplemented from AudioStream.

◆ readSilence()

virtual size_t readSilence	(	uint8_t *	buffer,
		size_t	length
	)

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

◆ refillReadBuffer()

void refillReadBuffer ( )

inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

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

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ resizeReadResultQueue()

void resizeReadResultQueue ( int size )

inlineinherited

Define the size of the interal read result queue: same as transformationReader().resizeResultQueue(size)

◆ setAudioInfo()

template<class TInterpolator >

void setAudioInfo ( AudioInfo newInfo )

inlineoverridevirtual

Sets the audio format information and updates the channel count.

Parameters

newInfo The new audio format information.

Reimplemented from AudioStream.

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setOutput() [1/2]

virtual void setOutput ( AudioOutput & print )

inlinevirtualinherited

Reimplemented in FormatConverterStream, and EncodedAudioStream.

◆ setOutput() [2/2]

virtual void setOutput ( Print & out )

inlineoverridevirtualinherited

Defines/Changes the output target.

Implements ModifyingStream.

Reimplemented in EncodedAudioStream, and FormatConverterStream.

◆ setStepSize()

template<class TInterpolator >

void setStepSize ( float step )

inline

Sets the resampling step size for all channels.

Parameters

step	The new step size.

◆ setStream() [1/2]

virtual void setStream ( AudioStream & stream )

inlinevirtualinherited

Reimplemented in FormatConverterStream, and EncodedAudioStream.

◆ setStream() [2/2]

virtual void setStream ( Stream & in )

inlineoverridevirtualinherited

Defines/Changes the input & output.

Implements ModifyingStream.

Reimplemented in FormatConverterStream, and EncodedAudioStream.

◆ setupReader()

void setupReader ( )

inlineprotectedinherited

◆ setWriteBufferSize()

void setWriteBufferSize ( int size )

inlineinherited

◆ transformationReader()

virtual TransformationReader< ReformatBaseStream > & transformationReader ( )

inlinevirtualinherited

Provides access to the TransformationReader.

◆ write() [1/2]

template<class TInterpolator >

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Write interleaved samples to the stream.

Reimplemented from AudioStream.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

◆ writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes len bytes of silence (=0).

◆ writeT()

template<class TInterpolator >

template<typename T >

size_t writeT	(	Print *	p_out,
		const uint8_t *	buffer,
		size_t	bytes,
		size_t &	written
	)

inlineprotected

Writes the buffer to defined output after resampling.

Member Data Documentation

◆ _resampler

template<class TInterpolator >

MultiChannelResampler<TInterpolator> _resampler

protected

◆ _timeout

int _timeout = 10

protectedinherited

◆ cfg

template<class TInterpolator >

ResampleConfig cfg

protected

◆ info

AudioInfo info

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ p_print

Print* p_print = nullptr

protectedinherited

◆ p_stream

Stream* p_stream = nullptr

protectedinherited

◆ reader

TransformationReader<ReformatBaseStream> reader

protectedinherited

◆ tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

◆ tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

◆ write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

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

src/AudioTools/CoreAudio/ResampleStreamT.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ResampleStreamT() [1/5]

◆ ResampleStreamT() [2/5]

◆ ResampleStreamT() [3/5]

◆ ResampleStreamT() [4/5]

◆ ResampleStreamT() [5/5]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/3]

◆ begin() [2/3]

◆ begin() [3/3]

◆ clearNotifyAudioChange()

◆ defaultConfig()

◆ end()

◆ flush()

◆ getByteFactor()

◆ getPrint()

◆ getStepSize()

◆ getStream()

◆ isNotifyActive()

◆ not_supported()

◆ notifyAudioChange()

◆ operator bool()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ resizeReadResultQueue()

◆ setAudioInfo()

◆ setNotifyActive()

◆ setOutput() [1/2]

◆ setOutput() [2/2]

◆ setStepSize()

◆ setStream() [1/2]

◆ setStream() [2/2]

◆ setupReader()

◆ setWriteBufferSize()

◆ transformationReader()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

◆ writeT()

Member Data Documentation

◆ _resampler

◆ _timeout

◆ cfg

◆ info

◆ is_notify_active

◆ notify_vector

◆ p_print

◆ p_stream

◆ reader

◆ tmp_in

◆ tmp_out

◆ write_buffer_size