NumberFormatConverterStream Class Reference

Converter which converts between bits_per_sample and 16 bits. The templated NumberFormatConverterStreamT class is used based on the information provided by the bits_per_sample in the configuration. More...

#include <AudioStreamsConverter.h>

Inheritance diagram for NumberFormatConverterStream:

Public Member Functions
	NumberFormatConverterStream ()=default
	NumberFormatConverterStream (AudioOutput &print)
	NumberFormatConverterStream (AudioStream &stream)
	NumberFormatConverterStream (Print &print)
	NumberFormatConverterStream (Stream &stream)
virtual	~NumberFormatConverterStream ()
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, AudioInfo to, float gain=1.0f)
bool	begin (AudioInfo info, int toBits, float gain=1.0f)
bool	begin (int from_bit_per_samples, int to_bit_per_samples, float gain=1.0)
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	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	setToBits (uint8_t bits)
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
void	cleanupConverter ()
template<typename TFrom , typename TTo >
NumberFormatConverterStreamT< TFrom, TTo > *	getConverter ()
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 ()
void	setupStream ()

Protected Attributes
int	_timeout = 10
int	from_bit_per_samples = 16
float	gain = 1.0
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
void *	p_converter = nullptr
Print *	p_print = nullptr
Stream *	p_stream = nullptr
TransformationReader< ReformatBaseStream >	reader
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	to_bit_per_samples = 0
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

Converter which converts between bits_per_sample and 16 bits. The templated NumberFormatConverterStreamT class is used based on the information provided by the bits_per_sample in the configuration.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

NumberFormatConverterStream() [1/5]

NumberFormatConverterStream ( )

default

NumberFormatConverterStream() [2/5]

NumberFormatConverterStream ( Stream &  stream )

inline

NumberFormatConverterStream() [3/5]

NumberFormatConverterStream ( AudioStream &  stream )

inline

NumberFormatConverterStream() [4/5]

NumberFormatConverterStream ( Print &  print )

inline

NumberFormatConverterStream() [5/5]

NumberFormatConverterStream ( AudioOutput &  print )

inline

~NumberFormatConverterStream()

virtual ~NumberFormatConverterStream ( )

inlinevirtual

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

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

virtual int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [1/4]

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [2/4]

bool begin ( AudioInfo  info, AudioInfo  to, float  gain = 1.0f  )

inline

begin() [3/4]

bool begin ( AudioInfo  info, int  toBits, float  gain = 1.0f  )

inline

begin() [4/4]

bool begin ( int  from_bit_per_samples, int  to_bit_per_samples, float  gain = 1.0  )

inline

cleanup if we call begin() multiple times w/o end

cleanupConverter()

void cleanupConverter ( )

inlineprotected

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

void end ( )

inlineoverridevirtual

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

float getByteFactor ( )

inlineoverridevirtual

Implements ReformatBaseStream.

getConverter()

template<typename TFrom , typename TTo >

NumberFormatConverterStreamT< TFrom, TTo > * getConverter ( )

inlineprotected

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

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

void setAudioInfo ( AudioInfo  info )

inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

setBuffered()

void setBuffered ( bool  flag )

inline

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.

setToBits()

void setToBits ( uint8_t  bits )

inline

setupReader()

void setupReader ( )

inlineprotectedinherited

setupStream()

void setupStream ( )

inlineprotected

setWriteBufferSize()

void setWriteBufferSize ( int  size )

inlineinherited

transformationReader()

virtual TransformationReader< ReformatBaseStream > & transformationReader ( )

inlinevirtualinherited

Provides access to the TransformationReader.

write() [1/2]

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

from_bit_per_samples

int from_bit_per_samples = 16

protected

gain

float gain = 1.0

protected

info

AudioInfo info

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_converter

void* p_converter = nullptr

protected

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

to_bit_per_samples

int to_bit_per_samples = 0

protected

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