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:

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 ()
int	available () override
int	availableForWrite () override
bool	begin () override
bool	begin (AudioInfo info)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
AudioDecoder &	decoder ()
	Provides the initialized decoder.
AudioInfo	defaultConfig ()
AudioEncoder &	encoder ()
	Provides the initialized encoder.
void	end () override
virtual void	flush () override
float	getByteFactor () override
	approx compression factor: e.g. mp3 is around 4
AudioDecoder *	getDecoder ()
AudioEncoder *	getEncoder ()
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)
virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
void	setByteFactor (float factor)
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) override
void	setOutput (AudioOutput *stream)
void	setOutput (Print &out) override
	Defines/Changes the output target.
void	setOutput (Print *stream)
void	setStream (AudioStream &stream) override
void	setStream (AudioStream *stream)
void	setStream (Stream &stream) override
	Defines/Changes the input & output.
void	setStream (Stream *stream)
virtual TransformationReader< ReformatBaseStream > &	transformationReader ()
	Provides access to the TransformationReader.
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
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()
void	setupReader ()

Protected Attributes
int	_timeout = 10
float	byte_factor = 2.0f
EncodedAudioOutput	enc_out
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}

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

Copyright

GPLv3

Member Function Documentation

addNotifyAudioChange()

void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlineoverridevirtual

Adds target to be notified about audio changes.

Reimplemented from AudioInfoSource.

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

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, and ResampleStream.

available()

int available ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin()

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

end()

void end ( )

inlineoverridevirtual

Reimplemented from BaseStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

getByteFactor()

float getByteFactor ( )

inlineoverridevirtual

approx compression factor: e.g. mp3 is around 4

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  )

inlineoverridevirtual

Reimplemented from AudioStream.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in VS1053Stream, WM8960Stream, I2SBitBang, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, TimerCallbackAudioStream, AudioBLEStream, LoRaStream, AudioFFTBase, AudioKitStream, VBANStream, AnalogAudioArduino, Equalizer3Bands, AdapterAudioOutputToAudioStream, TimedStream, MeasuringStream, ProgressStream, CallbackStream, VolumeMeter, FormatConverterStream, FadeStream, Pipeline::ModifyingStreamAdapter, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, and ResampleStream.

setOutput() [1/2]

void setOutput ( AudioOutput &  stream )

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 &  stream )

inlineoverridevirtual

Reimplemented from ReformatBaseStream.

setStream() [2/2]

void setStream ( Stream &  in )

inlineoverridevirtual

Defines/Changes the input & output.

Reimplemented from ReformatBaseStream.

write() [1/2]

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/AudioCodecs/AudioEncoded.h