NumberFormatConverterStreamT< TFrom, TTo > Class Template Reference

A more generic templated Converter which converts from a source type to a target type: You can use e.g. uint8_t, int8_t, int16_t, uint16_t, int24_t, uint32_t, int32_t, FloatAudio.AbstractMetaDat. This is quite handy because unsigned values and floating values are supported and you do not need to resort to use a Codec. More...

#include <AudioStreamsConverter.h>

Inheritance diagram for NumberFormatConverterStreamT< TFrom, TTo >:

Public Member Functions
	NumberFormatConverterStreamT ()=default
	NumberFormatConverterStreamT (AudioOutput &print)
	NumberFormatConverterStreamT (AudioStream &stream)
	NumberFormatConverterStreamT (float gain)
	NumberFormatConverterStreamT (Print &print)
	NumberFormatConverterStreamT (Stream &stream)
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
virtual int	available () override
virtual int	availableForWrite () override
bool	begin () override
bool	begin (AudioInfo info)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
virtual void	flush () override
float	getByteFactor () override
virtual Print *	getPrint ()
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
	Defines the input AudioInfo.
void	setBuffered (bool flag)
void	setGain (float value)
	Defines the gain (only available when buffered is true)
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.
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.
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 ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()
void	setupReader ()

Protected Attributes
int	_timeout = 10
SingleBuffer< uint8_t >	buffer {0}
float	gain = 1.0f
AudioInfo	info
bool	is_buffered = true
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<typename TFrom, typename TTo>
class audio_tools::NumberFormatConverterStreamT< TFrom, TTo >

A more generic templated Converter which converts from a source type to a target type: You can use e.g. uint8_t, int8_t, int16_t, uint16_t, int24_t, uint32_t, int32_t, FloatAudio.AbstractMetaDat. This is quite handy because unsigned values and floating values are supported and you do not need to resort to use a Codec.

Author

Phil Schatzmann

Copyright

GPLv3

Template Parameters

TFrom	specifies the source data type
TTo	spesifies the target data type.

Constructor & Destructor Documentation

NumberFormatConverterStreamT() [1/6]

template<typename TFrom , typename TTo >

NumberFormatConverterStreamT ( )

default

NumberFormatConverterStreamT() [2/6]

template<typename TFrom , typename TTo >

NumberFormatConverterStreamT ( float  gain )

inline

NumberFormatConverterStreamT() [3/6]

template<typename TFrom , typename TTo >

NumberFormatConverterStreamT ( Stream &  stream )

inline

NumberFormatConverterStreamT() [4/6]

template<typename TFrom , typename TTo >

NumberFormatConverterStreamT ( AudioStream &  stream )

inline

NumberFormatConverterStreamT() [5/6]

template<typename TFrom , typename TTo >

NumberFormatConverterStreamT ( Print &  print )

inline

NumberFormatConverterStreamT() [6/6]

template<typename TFrom , typename TTo >

NumberFormatConverterStreamT ( AudioOutput &  print )

inline

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<typename TFrom , typename TTo >

AudioInfo audioInfoOut ( )

inlineoverridevirtual

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

Reimplemented from AudioInfoSupport.

available()

template<typename TFrom , typename TTo >

virtual int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

template<typename TFrom , typename TTo >

virtual int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [1/2]

template<typename TFrom , typename TTo >

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [2/2]

template<typename TFrom , typename TTo >

bool begin ( AudioInfo  info )

inline

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

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<typename TFrom , typename TTo >

float getByteFactor ( )

inlineoverridevirtual

Implements ReformatBaseStream.

getPrint()

virtual Print * getPrint ( )

inlinevirtualinherited

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()

template<typename TFrom , typename TTo >

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtual

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<typename TFrom , typename TTo >

void setAudioInfo ( AudioInfo  info )

inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

setBuffered()

template<typename TFrom , typename TTo >

void setBuffered ( bool  flag )

inline

if set to true we do one big write, else we get a lot of single writes per sample

setGain()

template<typename TFrom , typename TTo >

void setGain ( float  value )

inline

Defines the gain (only available when buffered is true)

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.

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<typename TFrom , typename TTo >

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

inlineoverridevirtual

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).

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

buffer

template<typename TFrom , typename TTo >

SingleBuffer<uint8_t> buffer {0}

protected

gain

template<typename TFrom , typename TTo >

float gain = 1.0f

protected

info

AudioInfo info

protectedinherited

is_buffered

template<typename TFrom , typename TTo >

bool is_buffered = true

protected

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/AudioStreamsConverter.h