ChannelFormatConverterStream Class Reference

Channel converter which does not use a template. More...

#include <AudioStreamsConverter.h>

Inheritance diagram for ChannelFormatConverterStream:

Public Member Functions
	ChannelFormatConverterStream ()=default
	ChannelFormatConverterStream (ChannelFormatConverterStream &from)
	ChannelFormatConverterStream (Print &print)
	ChannelFormatConverterStream (Stream &stream)
virtual	~ChannelFormatConverterStream ()
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 AudioInfo with the to_channels.
virtual int	available () override
virtual int	availableForWrite () override
bool	begin () override
bool	begin (AudioInfo cfg, int toChannels)
bool	begin (AudioInfo from, AudioInfo to)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
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 ()
ChannelFormatConverterStream &	operator= (ChannelFormatConverterStream &from)
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 cfg) override
	Defines the input AudioInfo.
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)
virtual void	setOutput (AudioOutput &print)
virtual void	setOutput (Print &print) override
	Defines/Changes the output target.
void	setReadResultQueueSize (int size)
	same as resizeReadResultQueue(size)
virtual void	setStream (AudioStream &stream)
virtual void	setStream (Stream &stream) override
	Defines/Changes the input & output.
void	setToChannels (uint16_t channels)
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 ()
void	copy (ChannelFormatConverterStream &from)
template<typename T >
ChannelFormatConverterStreamT< T > *	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()
bool	setupConverter (int fromChannels, int toChannels)
void	setupReader ()

Protected Attributes
int	_timeout = 10
int	bits_per_sample = 0
void *	converter = nullptr
int	from_channels = 2
AudioInfo	info
bool	is_active = false
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	to_channels = 2
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

Channel converter which does not use a template.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

ChannelFormatConverterStream() [1/4]

ChannelFormatConverterStream ( )

default

ChannelFormatConverterStream() [2/4]

ChannelFormatConverterStream ( Stream &  stream )

inline

ChannelFormatConverterStream() [3/4]

ChannelFormatConverterStream ( Print &  print )

inline

ChannelFormatConverterStream() [4/4]

ChannelFormatConverterStream ( ChannelFormatConverterStream &  from )

inline

~ChannelFormatConverterStream()

virtual ~ChannelFormatConverterStream ( )

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

Returns the AudioInfo with the to_channels.

Reimplemented from AudioInfoSupport.

available()

virtual int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [1/3]

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [2/3]

bool begin ( AudioInfo  cfg, int  toChannels  )

inline

begin() [3/3]

bool begin ( AudioInfo  from, AudioInfo  to  )

inline

cleanupConverter()

void cleanupConverter ( )

inlineprotected

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

copy()

void copy ( ChannelFormatConverterStream &  from )

inlineprotected

end()

void end ( )

inlineoverridevirtual

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.

getConverter()

template<typename T >

ChannelFormatConverterStreamT< T > * 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.

operator=()

ChannelFormatConverterStream & operator= ( ChannelFormatConverterStream &  from )

inline

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.

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]

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.

setReadResultQueueSize()

void setReadResultQueueSize ( int  size )

inlineinherited

same as resizeReadResultQueue(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.

setToChannels()

void setToChannels ( uint16_t  channels )

inline

setupConverter()

bool setupConverter ( int  fromChannels, int  toChannels  )

inlineprotected

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

bits_per_sample

int bits_per_sample = 0

protected

converter

void* converter = nullptr

protected

from_channels

int from_channels = 2

protected

info

AudioInfo info

protectedinherited

is_active

bool is_active = false

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

to_channels

int to_channels = 2

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