DecoderNetworkFormat Class Reference

PCM decoder which converts from network format to the host format. More...

#include <CodecNetworkFormat.h>

Inheritance diagram for DecoderNetworkFormat:

Public Member Functions
	DecoderNetworkFormat ()=default
	DecoderNetworkFormat (Print &out_stream)
	DecoderNetworkFormat (Print &out_stream, AudioInfoSupport &bi)
	~DecoderNetworkFormat ()
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual bool	begin (AudioInfo info) override
bool	begin ()
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end ()
Print *	getOutput ()
Print *	getOutput ()
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual bool	isResultPCM ()
	The result is encoded data - by default this is false.
const char *	mime () override
	Provides the mime type of the data that is expected by this decoder.
	operator bool ()
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
virtual bool	setCodecConfig (const uint8_t *data, size_t len)
	Some decoders need e.g. a magic cookie to provide the relevant info for decoding.
virtual bool	setCodecConfig (const uint8_t *data, size_t len)
	Some decoders need e.g. a magic cookie to provide the relevant info for decoding.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
virtual void	setOutput (AudioOutput &out_stream)
	Defines where the decoded result is written to.
virtual void	setOutput (AudioStream &out_stream)
	Defines where the decoded result is written to.
virtual void	setOutput (Print &out_stream)
	Defines where the decoded result is written to.
size_t	write (const uint8_t *data, size_t len)

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
void	notifyAudioChange (AudioInfo info)
void	notifyAudioChange (AudioInfo info)
void	writeBlocking (Print *out, uint8_t *data, size_t len)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Print *	p_print = nullptr
Print *	pt_print = nullptr

Detailed Description

PCM decoder which converts from network format to the host format.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

DecoderNetworkFormat() [1/3]

DecoderNetworkFormat ( )

default

DecoderNetworkFormat() [2/3]

DecoderNetworkFormat ( Print & out_stream )

inline

DecoderNetworkFormat() [3/3]

DecoderNetworkFormat ( Print & out_stream, AudioInfoSupport & bi )

inline

~DecoderNetworkFormat()

~DecoderNetworkFormat ( )

inline

Member Function Documentation

addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

audioInfo() [1/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, CodecNOP, DecoderBasic, DSFDecoder, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

audioInfo() [2/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, CodecNOP, DecoderBasic, DSFDecoder, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, OpusAudioDecoder, OpusMultiStreamAudioDecoder, VorbisDecoder, VorbisDecoder, WAVDecoder, and WavIMADecoder.

audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

begin() [1/2]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

begin() [2/2]

bool begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

end()

void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

getOutput() [1/2]

Print * getOutput ( )

inlineinherited

getOutput() [2/2]

Print * getOutput ( )

inlineinherited

isNotifyActive() [1/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isNotifyActive() [2/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtual

The result is encoded data - by default this is false.

Reimplemented from AudioDecoder.

mime()

const char * mime ( )

inlineoverridevirtual

Provides the mime type of the data that is expected by this decoder.

Implements AudioDecoder.

notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlinevirtual

Implements AudioWriter.

removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setCodecConfig() [1/2]

virtual bool setCodecConfig ( const uint8_t * data, size_t len )

inlinevirtualinherited

Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

Reimplemented in DecoderALAC, and MultiDecoder.

setCodecConfig() [2/2]

virtual bool setCodecConfig ( const uint8_t * data, size_t len )

inlinevirtualinherited

Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

Reimplemented in DecoderALAC, and MultiDecoder.

setNotifyActive() [1/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

setNotifyActive() [2/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

setOutput() [1/3]

virtual void setOutput ( AudioOutput & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

setOutput() [2/3]

virtual void setOutput ( AudioStream & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

setOutput() [3/3]

virtual void setOutput ( Print & out_stream )

inlinevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

write()

size_t write ( const uint8_t * data, size_t len )

inlinevirtual

Implements AudioWriter.

writeBlocking() [1/2]

void writeBlocking ( Print * out, uint8_t * data, size_t len )

inlineprotectedinherited

writeBlocking() [2/2]

void writeBlocking ( Print * out, uint8_t * data, size_t len )

inlineprotectedinherited

Member Data Documentation

id

int id

inherited

custom id to be used by application

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

pt_print

Print* pt_print = nullptr

protected

---

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

• src/AudioTools/AudioCodecs/CodecNetworkFormat.h