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 ()=default
	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)
virtual	~EncodedAudioStream ()
void	addNotifyAudioChange (AudioInfoSupport &bi) override
	Adds target to be notified about audio changes.
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
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 ()
EncodedAudioStream &	operator= (EncodedAudioStream const &src)
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 newInfo) override
	Defines the input AudioInfo.
void	setByteFactor (float factor)
	Define the compression factor: e.g. mp3 is around 4.
void	setDecoder (AudioDecoder *decoder)
void	setEncoder (AudioEncoder *encoder)
void	setFrameSize (int size)
	defines the size of the decoded frame in bytes
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)
void	setOutput (AudioOutput &stream) override
	Defines/Changes the output target and registers for audio change notifications.
void	setOutput (AudioOutput *stream)
void	setOutput (Print &out) override
	Defines/Changes the output target.
void	setOutput (Print *stream)
void	setReadResultQueueSize (int size)
	same as resizeReadResultQueue(size)
void	setStream (AudioStream &stream) override
	Defines/Changes the input & output and registers for audio change notifications.
void	setStream (AudioStream *stream)
void	setStream (Stream &stream) override
	Defines/Changes the input & output.
void	setStream (Stream *stream)
void	setWriteBufferSize (int size)
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 ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()
void	setupReader ()

Protected Attributes
int	_timeout = 10
float	byte_factor = 3.0f
EncodedAudioOutput	enc_out
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
NullStream	null_stream
Print *	p_print = nullptr
Stream *	p_stream = nullptr
TransformationReader< ReformatBaseStream >	reader
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = MAX_SINGLE_CHARS

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

Constructor & Destructor Documentation

EncodedAudioStream() [1/8]

EncodedAudioStream ( )

default

EncodedAudioStream() [2/8]

EncodedAudioStream ( AudioStream *  ioStream, AudioDecoder *  decoder  )

inline

EncodedAudioStream() [3/8]

EncodedAudioStream ( Stream *  ioStream, AudioDecoder *  decoder  )

inline

EncodedAudioStream() [4/8]

EncodedAudioStream ( AudioOutput *  outputStream, AudioDecoder *  decoder  )

inline

EncodedAudioStream() [5/8]

EncodedAudioStream ( Print *  outputStream, AudioDecoder *  decoder  )

inline

EncodedAudioStream() [6/8]

EncodedAudioStream ( Print *  outputStream, AudioEncoder *  encoder  )

inline

EncodedAudioStream() [7/8]

EncodedAudioStream ( AudioDecoder *  decoder )

inline

EncodedAudioStream() [8/8]

EncodedAudioStream ( AudioEncoder *  encoder )

inline

~EncodedAudioStream()

virtual ~EncodedAudioStream ( )

inlinevirtual

Member Function Documentation

addNotifyAudioChange()

void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlineoverridevirtual

Adds target to be notified about audio changes.

Reimplemented from AudioInfoSource.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioStream.

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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

available()

int available ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Reimplemented from BaseStream.

begin() [2/2]

bool begin ( AudioInfo  info )

inline

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

decoder()

AudioDecoder & decoder ( )

inline

Provides the initialized decoder.

defaultConfig()

AudioInfo defaultConfig ( )

inline

encoder()

AudioEncoder & encoder ( )

inline

Provides the initialized encoder.

end()

void end ( )

inlineoverridevirtual

Reimplemented from BaseStream.

flush()

void flush ( )

inlineoverridevirtual

Flushes the encoder without tearing down the reader infrastructure. Called by TransformationReader on EOF so that final encoded bytes are written into the result_queue while it is still the active output.

Reimplemented from ReformatBaseStream.

getByteFactor()

float getByteFactor ( )

inlineoverridevirtual

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

Implements ReformatBaseStream.

getDecoder()

AudioDecoder * getDecoder ( )

inline

getEncoder()

AudioEncoder * getEncoder ( )

inline

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, PortAudioStream, URLStream, USBAudioDeviceBase, I2SStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, Pipeline, and AudioFFTBase.

operator=()

EncodedAudioStream & operator= ( EncodedAudioStream const &  src )

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.

setByteFactor()

void setByteFactor ( float  factor )

inline

Define the compression factor: e.g. mp3 is around 4.

setDecoder()

void setDecoder ( AudioDecoder *  decoder )

inline

setEncoder()

void setEncoder ( AudioEncoder *  encoder )

inline

setFrameSize()

void setFrameSize ( int  size )

inline

defines the size of the decoded frame in bytes

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/4]

void setOutput ( AudioOutput &  out )

inlineoverridevirtual

Defines/Changes the output target and registers for audio change notifications.

Reimplemented from ReformatBaseStream.

setOutput() [2/4]

void setOutput ( AudioOutput *  stream )

inline

setOutput() [3/4]

void setOutput ( Print &  out )

inlineoverridevirtual

Defines/Changes the output target.

Reimplemented from ReformatBaseStream.

setOutput() [4/4]

void setOutput ( Print *  stream )

inline

setReadResultQueueSize()

void setReadResultQueueSize ( int  size )

inlineinherited

same as resizeReadResultQueue(size)

setStream() [1/4]

void setStream ( AudioStream &  io )

inlineoverridevirtual

Defines/Changes the input & output and registers for audio change notifications.

Reimplemented from ReformatBaseStream.

setStream() [2/4]

void setStream ( AudioStream *  stream )

inline

setStream() [3/4]

void setStream ( Stream &  in )

inlineoverridevirtual

Defines/Changes the input & output.

Reimplemented from ReformatBaseStream.

setStream() [4/4]

void setStream ( Stream *  stream )

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]

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

byte_factor

float byte_factor = 3.0f

protected

enc_out

EncodedAudioOutput enc_out

protected

info

AudioInfo info

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

null_stream

NullStream null_stream

protected

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

write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

---

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

• src/AudioTools/AudioCodecs/AudioEncoded.h