FormatConverterStream Class Reference

Converter which converts bits_per_sample, channels and the sample_rate. The conversion is supported both on the input and output side. More...

#include <AudioStreamsConverter.h>

Inheritance diagram for FormatConverterStream:

Public Member Functions
	FormatConverterStream ()=default
	FormatConverterStream (AudioOutput &print)
	FormatConverterStream (AudioStream &stream)
	FormatConverterStream (Print &print)
	FormatConverterStream (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
int	available () override
int	availableForWrite () override
bool	begin () override
	(Re-)Starts the processing: call setAudioInfo and setAudioInfoOut before
bool	begin (AudioInfo from)
	Starts the processing: call setAudioInfoOut before to define the target.
bool	begin (AudioInfo from, AudioInfo to)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end ()
virtual void	flush ()
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 info) override
	Set the input audio information.
void	setAudioInfoOut (AudioInfo to)
void	setBuffered (bool active)
	Buffering is active by default to minimize the number of output calls.
void	setMaxReadSize (int size)
	Defines the read buffer size for individual reads: same as transformationReader().setMaxReadSize(size)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setOutput (AudioOutput &print) override
void	setOutput (Print &print) override
	Defines/Changes the output target.
void	setReadResultQueueSize (int size)
	same as resizeReadResultQueue(size)
void	setStream (AudioStream &io) override
void	setStream (Stream &io) 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
ChannelFormatConverterStream	channelFormatConverter
AudioInfo &	from_cfg = info
AudioInfo	info
bool	is_active = false
bool	is_buffered = true
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
NumberFormatConverterStream	numberFormatConverter
Print *	p_print = nullptr
Stream *	p_stream = nullptr
TransformationReader< ReformatBaseStream >	reader
ResampleStream	sampleRateConverter
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
AudioInfo	to_cfg
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

Converter which converts bits_per_sample, channels and the sample_rate. The conversion is supported both on the input and output side.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

FormatConverterStream() [1/5]

FormatConverterStream ( )

default

FormatConverterStream() [2/5]

FormatConverterStream ( Stream &  stream )

inline

FormatConverterStream() [3/5]

FormatConverterStream ( Print &  print )

inline

FormatConverterStream() [4/5]

FormatConverterStream ( AudioStream &  stream )

inline

FormatConverterStream() [5/5]

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

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

int available ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

begin() [1/3]

bool begin ( )

inlineoverridevirtual

(Re-)Starts the processing: call setAudioInfo and setAudioInfoOut before

Reimplemented from BaseStream.

begin() [2/3]

bool begin ( AudioInfo  from )

inline

Starts the processing: call setAudioInfoOut before to define the target.

begin() [3/3]

bool begin ( AudioInfo  from, AudioInfo  to  )

inline

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

void end ( )

inlinevirtual

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlinevirtualinherited

Called by TransformationReader when EOF is detected on the source stream. Override in subclasses to flush any internally buffered encoder/decoder data into the current output (which at that point is the result_queue). Do NOT call the full end()/begin() cycle here – that would destroy the reader's own buffers and reset the is_eof flag.

Reimplemented from BaseStream.

Reimplemented in ResampleStream, and EncodedAudioStream.

getByteFactor()

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

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

void setAudioInfo ( AudioInfo  info )

inlineoverridevirtual

Set the input audio information.

Reimplemented from AudioStream.

setAudioInfoOut()

void setAudioInfoOut ( AudioInfo  to )

inline

setBuffered()

void setBuffered ( bool  active )

inline

Buffering is active by default to minimize the number of output calls.

setMaxReadSize()

void setMaxReadSize ( int  size )

inlineinherited

Defines the read buffer size for individual reads: same as transformationReader().setMaxReadSize(size)

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

setOutput() [1/2]

void setOutput ( AudioOutput &  print )

inlineoverridevirtual

Reimplemented from ReformatBaseStream.

setOutput() [2/2]

void setOutput ( Print &  out )

inlineoverridevirtual

Defines/Changes the output target.

Reimplemented from ReformatBaseStream.

setReadResultQueueSize()

void setReadResultQueueSize ( int  size )

inlineinherited

same as resizeReadResultQueue(size)

setStream() [1/2]

void setStream ( AudioStream &  io )

inlineoverridevirtual

Reimplemented from ReformatBaseStream.

setStream() [2/2]

void setStream ( Stream &  in )

inlineoverridevirtual

Defines/Changes the input & output.

Reimplemented from ReformatBaseStream.

setupReader()

void setupReader ( )

inlineprotectedinherited

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

channelFormatConverter

ChannelFormatConverterStream channelFormatConverter

protected

from_cfg

AudioInfo& from_cfg = info

protected

info

AudioInfo info

protectedinherited

is_active

bool is_active = false

protected

is_buffered

bool is_buffered = true

protected

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

numberFormatConverter

NumberFormatConverterStream numberFormatConverter

protected

p_print

Print* p_print = nullptr

protectedinherited

p_stream

Stream* p_stream = nullptr

protectedinherited

reader

TransformationReader<ReformatBaseStream> reader

protectedinherited

sampleRateConverter

ResampleStream sampleRateConverter

protected

tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

to_cfg

AudioInfo to_cfg

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