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 (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 () 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)
	Define the size of the interal read result queue: same as transformationReader().resizeResultQueue(size)
void	setAudioInfo (AudioInfo info) override
	Defines the input AudioInfo.
void	setAudioInfoOut (AudioInfo to)
void	setBuffered (bool active)
	Buffering is active by default to minimize the number of output calls.
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	setStream (AudioStream &io) override
void	setStream (Stream &io) override
	Defines/Changes the input & output.
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
float	byteFactor ()
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()
void	setupReader ()

Protected Attributes
int	_timeout = 10
ChannelFormatConverterStream	channelFormatConverter
AudioInfo	from_cfg
AudioInfo	info
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

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

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, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, 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()

bool begin ( )

inlineoverridevirtual

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

Reimplemented from BaseStream.

byteFactor()

float byteFactor ( )

inlineprotected

e.g if we do channels 2->1 we nead to double the input data

Returns

end()

void end ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

getByteFactor()

float getByteFactor ( )

inlineoverridevirtual

Implements ReformatBaseStream.

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, I2SStream, MemoryStream, and Pipeline.

readBytes()

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Reimplemented from AudioStream.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

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.

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.

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 BufferedTaskStream, and BufferedStream.

---

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

• src/AudioTools/CoreAudio/AudioStreamsConverter.h