CopyDecoder Class Reference

Dummy Decoder which just copies the provided data to the output. You can define if it is PCM data. More...

#include <CodecCopy.h>

Inheritance diagram for CopyDecoder:

Public Member Functions
	CopyDecoder (bool isPcm=false)
	CopyDecoder (Print &out_stream)
	CopyDecoder (Print &out_stream, AudioInfoSupport &bi)
	~CopyDecoder ()
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin ()
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end ()
Print *	getOutput ()
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual bool	isResultPCM ()
	The result is encoded data - by default this is false.
	operator bool ()
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
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)
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.
void	setResultPCM (bool pcm)
	Defines that the source and therefor the result is also PCM data.
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	writeBlocking (Print *out, uint8_t *data, size_t len)

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

Detailed Description

Dummy Decoder which just copies the provided data to the output. You can define if it is PCM data.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

CopyDecoder() [1/3]

CopyDecoder ( bool  isPcm = false )

inline

CopyDecoder() [2/3]

CopyDecoder ( Print &  out_stream )

inline

CopyDecoder() [3/3]

CopyDecoder ( Print &  out_stream, AudioInfoSupport &  bi  )

inline

~CopyDecoder()

~CopyDecoder ( )

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

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

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

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

begin() [1/2]

bool begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

Reimplemented in DecoderBasic, and OggContainerDecoder.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

getOutput()

Print * getOutput ( )

inlineinherited

isNotifyActive()

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.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlinevirtual

Implements AudioWriter.

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

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in DecoderALAC, CodecChain, DSFDecoder, DecoderL8, OpusAudioDecoder, CodecNOP, and G7xxDecoder.

setCodecConfig()

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

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.

Reimplemented in ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [2/3]

virtual void setOutput ( AudioStream &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

setOutput() [3/3]

virtual void setOutput ( Print &  out_stream )

inlinevirtual

Defines where the decoded result is written to.

Reimplemented from AudioDecoder.

setResultPCM()

void setResultPCM ( bool  pcm )

inline

Defines that the source and therefor the result is also PCM data.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlinevirtual

Implements AudioWriter.

writeBlocking()

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

is_pcm

bool is_pcm = false

protected

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/CodecCopy.h