arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ChannelFormatConverterStreamT< T > Class Template Reference
Arduino Audio Tools » Converting Streams

Converter for reducing or increasing the number of Channels. More...

#include <AudioStreamsConverter.h>

Inheritance diagram for ChannelFormatConverterStreamT< T >:
ReformatBaseStream ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 ChannelFormatConverterStreamT (ChannelFormatConverterStreamT const &)=delete
 
 ChannelFormatConverterStreamT (Print &print)
 
 ChannelFormatConverterStreamT (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
 Returns the AudioInfo with the to_channels.
 
virtual int available () override
 
virtual int availableForWrite () override
 
bool begin () override
 
bool begin (int fromChannels, int toChannels)
 
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 ()
 
ChannelFormatConverterStreamT & operator= (ChannelFormatConverterStreamT const &)=delete
 
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 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 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

size_t convert (const uint8_t *in_data, size_t size)
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 
void setupReader ()
 

Protected Attributes

int _timeout = 10
 
Vector< T > buffer {0}
 
Vector< uint8_t > bufferTmp {0}
 
ChannelConverter< T > converter
 
float factor = 1
 
int from_channels = 2
 
AudioInfo info
 
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

template<typename T>
class audio_tools::ChannelFormatConverterStreamT< T >

Converter for reducing or increasing the number of Channels.

Author
Phil Schatzmann
Copyright
GPLv3

Constructor & Destructor Documentation

◆ ChannelFormatConverterStreamT() [1/3]

template<typename T >
ChannelFormatConverterStreamT ( Stream &  stream)
inline

◆ ChannelFormatConverterStreamT() [2/3]

template<typename T >
ChannelFormatConverterStreamT ( Print &  print)
inline

◆ ChannelFormatConverterStreamT() [3/3]

template<typename T >
ChannelFormatConverterStreamT ( ChannelFormatConverterStreamT< T > const &  )
delete

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 T >
AudioInfo audioInfoOut ( )
inlineoverridevirtual

Returns the AudioInfo with the to_channels.

Reimplemented from AudioInfoSupport.

◆ available()

template<typename T >
virtual int available ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ availableForWrite()

template<typename T >
virtual int availableForWrite ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [1/2]

template<typename T >
bool begin ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [2/2]

template<typename T >
bool begin ( int  fromChannels,
int  toChannels 
)
inline

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ convert()

template<typename T >
size_t convert ( const uint8_t *  in_data,
size_t  size 
)
inlineprotected

◆ 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 T >
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.

◆ operator=()

template<typename T >
ChannelFormatConverterStreamT & operator= ( ChannelFormatConverterStreamT< T > const &  )
delete

◆ readBytes()

template<typename T >
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

◆ 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 T >
void setAudioInfo ( AudioInfo  info)
inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

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

◆ setToChannels()

template<typename T >
void setToChannels ( uint16_t  channels)
inline

◆ 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 T >
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 T >
Vector<T> buffer {0}
protected

◆ bufferTmp

template<typename T >
Vector<uint8_t> bufferTmp {0}
protected

◆ converter

template<typename T >
ChannelConverter<T> converter
protected

◆ factor

template<typename T >
float factor = 1
protected

◆ from_channels

template<typename T >
int from_channels = 2
protected

◆ info

AudioInfo info
protectedinherited

◆ 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

template<typename T >
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:
Generated by doxygen 1.9.8