arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
EncodedAudioStream Class Reference

A more natural Stream class to process encoded data (aac, wav, mp3...) which also supports the decoding by calling readBytes(). More...

#include <AudioEncoded.h>

Inheritance diagram for EncodedAudioStream:
ReformatBaseStream ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 EncodedAudioStream (AudioDecoder *decoder)
 
 EncodedAudioStream (AudioEncoder *encoder)
 
 EncodedAudioStream (AudioOutput *outputStream, AudioDecoder *decoder)
 
 EncodedAudioStream (AudioStream *ioStream, AudioDecoder *decoder)
 
 EncodedAudioStream (Print *outputStream, AudioDecoder *decoder)
 
 EncodedAudioStream (Print *outputStream, AudioEncoder *encoder)
 
 EncodedAudioStream (Stream *ioStream, AudioDecoder *decoder)
 
void addNotifyAudioChange (AudioInfoSupport &bi) override
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
int available () override
 
int availableForWrite ()
 
bool begin ()
 
bool begin (AudioInfo info)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
AudioDecoderdecoder ()
 Provides the initialized decoder.
 
AudioInfo defaultConfig ()
 
AudioEncoderencoder ()
 Provides the initialized encoder.
 
void end ()
 
virtual void flush () override
 
float getByteFactor ()
 
AudioDecodergetDecoder ()
 
AudioEncodergetEncoder ()
 
virtual PrintgetPrint ()
 
virtual StreamgetStream ()
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
size_t readBytes (uint8_t *data, size_t len)
 
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.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
void setDecoder (AudioDecoder *decoder)
 
void setEncoder (AudioEncoder *encoder)
 
void setFrameSize (int size)
 defines the size of the decoded frame in bytes
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setOutput (AudioOutput &stream)
 
void setOutput (AudioOutput *stream)
 
void setOutput (Print &out)
 Defines/Changes the output target.
 
void setOutput (Print *stream)
 
void setStream (AudioStream &stream)
 
void setStream (AudioStream *stream)
 
void setStream (Stream &stream)
 Defines/Changes the input & output.
 
void setStream (Stream *stream)
 
size_t write (const uint8_t *data, size_t len)
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

void addNotifyOnFirstWrite ()
 Add notification on first call of write.
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 
void setNotifyOnOutput (AudioInfoSupport &info)
 Define potential notification.
 
void setupReader ()
 

Protected Attributes

int _timeout = 10
 
EncodedAudioOutput enc_out
 
AudioInfo info
 
bool is_notify_active = true
 
bool is_output_notify = false
 
Vector< AudioInfoSupport * > notify_vector
 
AudioInfoSupportp_notify_on_output = nullptr
 
Printp_print = nullptr
 
Streamp_stream = nullptr
 
TransformationReader< ReformatBaseStreamreader
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

A more natural Stream class to process encoded data (aac, wav, mp3...) which also supports the decoding by calling readBytes().

Author
Phil Schatzmann

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