arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ProgressStream Class Referenceabstract
Arduino Audio Tools » IO

Generic calss to measure the the total bytes which were processed in order to calculate the progress as a percentage of the total size. More...

#include <AudioStreams.h>

Inheritance diagram for ProgressStream:
ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 ProgressStream ()=default
 
 ProgressStream (AudioStream &stream)
 
 ProgressStream (Print &print)
 
 ProgressStream (Stream &stream)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 
int available () override
 
virtual int availableForWrite () override
 Provides the nubmer of bytes we can write.
 
bool begin () override
 
bool begin (ProgressStreamInfo info)
 
bool begin (size_t len)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
ProgressStreamInfo & defaultConfig ()
 
virtual void end ()
 
virtual void flush () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
float percentage ()
 Provides the processed percentage: If no size has been defined we return 0.
 
size_t processedBytes ()
 Provides the number of processed bytes.
 
size_t processedSecs ()
 Provides the number of processed seconds.
 
size_t readBytes (uint8_t *data, size_t len) override
 Provides the data from all streams mixed together.
 
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 setAudioInfo (AudioInfo info) override
 Defines the input AudioInfo.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual void setOutput (Print &out)=0
 Defines/Changes the output target.
 
void setPrint (Print &print)
 
void setSize (size_t len)
 Updates the total size and restarts the percent calculation.
 
void setStream (Print &print)
 
void setStream (Stream &stream) override
 Defines/Changes the input & output.
 
void setWriteBufferSize (int size)
 
size_t size ()
 Provides the current total size (defined by setSize)
 
size_t totalBytes ()
 Provides the total_size provided in the configuration.
 
size_t totalSecs ()
 Converts the totalBytes() to seconds.
 
virtual size_t write (const uint8_t *data, size_t len) override
 Writes raw PCM audio data, which will be the input for the volume control.
 
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 byteRate ()
 
size_t measure (size_t len)
 
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()
 

Protected Attributes

int _timeout = 10
 
AudioInfo info
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
AudioInfoSupport * p_info_from = nullptr
 
Print * p_print = nullptr
 
Stream * p_stream = nullptr
 
ProgressStreamInfo progress_info
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
size_t total_processed = 0
 
int write_buffer_size = MAX_SINGLE_CHARS
 

Detailed Description

Generic calss to measure the the total bytes which were processed in order to calculate the progress as a percentage of the total size.

Author
Phil Schatzmann
Copyright
GPLv3

Constructor & Destructor Documentation

◆ ProgressStream() [1/4]

ProgressStream ( )
default

◆ ProgressStream() [2/4]

ProgressStream ( Print &  print)
inline

◆ ProgressStream() [3/4]

ProgressStream ( Stream &  stream)
inline

◆ ProgressStream() [4/4]

ProgressStream ( AudioStream &  stream)
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()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ available()

int available ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ availableForWrite()

virtual int availableForWrite ( )
inlineoverridevirtual

Provides the nubmer of bytes we can write.

Reimplemented from BaseStream.

◆ begin() [1/3]

bool begin ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [2/3]

bool begin ( ProgressStreamInfo  info)
inline

◆ begin() [3/3]

bool begin ( size_t  len)
inline

Updates the total size and restarts the percent calculation: Same as calling setSize()

◆ byteRate()

size_t byteRate ( )
inlineprotected

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ defaultConfig()

ProgressStreamInfo & defaultConfig ( )
inline

◆ end()

virtual void end ( )
inlinevirtualinherited

Reimplemented in FaustStream< DSP >, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, BufferedTaskStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, Equalizer3Bands, I2SStream, AudioStreamWrapper, TimerCallbackAudioStream, FormatConverterStream, GoertzelStream, FileLoopT< FileType >, FileLoopT< File >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, LoRaStream, EncodedAudioStream, AudioFFTBase, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, A2DPStream, HLSStreamT< URLStream >, HttpRequest, ICYStreamT< T >, URLStream, URLStreamESP32, AnalogAudioArduino, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3BandsPerChannel, ReformatBaseStream, AdapterAudioOutputToAudioStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMixer< T >, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStream, NumberFormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, Pipeline, Pipeline::ModifyingStreamAdapter, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AbstractURLStream, and AudioBLEStream.

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

◆ isNotifyActive()

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ measure()

size_t measure ( size_t  len)
inlineprotected

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

◆ percentage()

float percentage ( )
inline

Provides the processed percentage: If no size has been defined we return 0.

◆ processedBytes()

size_t processedBytes ( )
inline

Provides the number of processed bytes.

◆ processedSecs()

size_t processedSecs ( )
inline

Provides the number of processed seconds.

◆ readBytes()

size_t readBytes ( uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

Provides the data from all streams mixed together.

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

◆ setAudioInfo()

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

virtual void setOutput ( Print &  out)
pure virtualinherited

Defines/Changes the output target.

Implemented in ConverterStream< T >, EncodedAudioStream, Equalizer3Bands, Equalizer3BandsPerChannel, TimedStream, BufferedStream, MeasuringStream, Throttle, CallbackStream, VolumeMeter, AudioInputMonitor, FadeStream, Pipeline::ModifyingStreamAdapter, VolumeStream, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, AudioEffectStreamT< T >, ReformatBaseStream, FormatConverterStream, FilteredStream< T, TF >, and FilteredStream< int16_t, int16_t >.

◆ setPrint()

void setPrint ( Print &  print)
inline

◆ setSize()

void setSize ( size_t  len)
inline

Updates the total size and restarts the percent calculation.

◆ setStream() [1/2]

void setStream ( Print &  print)
inline

◆ setStream() [2/2]

void setStream ( Stream &  in)
inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

◆ setWriteBufferSize()

void setWriteBufferSize ( int  size)
inlineinherited

◆ size()

size_t size ( )
inline

Provides the current total size (defined by setSize)

◆ totalBytes()

size_t totalBytes ( )
inline

Provides the total_size provided in the configuration.

◆ totalSecs()

size_t totalSecs ( )
inline

Converts the totalBytes() to seconds.

◆ write() [1/2]

virtual size_t write ( const uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

Writes raw PCM audio data, which will be the input for the volume control.

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

◆ info

AudioInfo info
protectedinherited

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector
protectedinherited

◆ p_info_from

AudioInfoSupport* p_info_from = nullptr
protected

◆ p_print

Print* p_print = nullptr
protected

◆ p_stream

Stream* p_stream = nullptr
protected

◆ progress_info

ProgressStreamInfo progress_info
protected

◆ tmp_in

RingBuffer<uint8_t> tmp_in {0}
protectedinherited

◆ tmp_out

RingBuffer<uint8_t> tmp_out {0}
protectedinherited

◆ total_processed

size_t total_processed = 0
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