DecoderAdapter Class Reference

Adapter class which allows the AudioDecoder API on a StreamingDecoder. More...

#include <StreamingDecoder.h>

Inheritance diagram for DecoderAdapter:

Public Member Functions
	DecoderAdapter (StreamingDecoder &dec, int bufferSize)
	Constructor.
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 () override
	Starts the processing.
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
	Stops the processing.
Print *	getOutput ()
StreamingDecoder *	getStreamingDecoder ()
	Gets the wrapped StreamingDecoder.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual bool	isResultPCM ()
	Returns true to indicate that the decoding result is PCM data.
	operator bool () override
	Checks if the adapter is active.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	resize (int size)
	Resizes the internal buffer.
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	setInput (Stream &in)
	Sets the input stream for the wrapped decoder.
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.
void	setOutput (Print &out) override
	Defines the output Stream.
size_t	write (const uint8_t *data, size_t len) override
	Writes encoded audio data to be decoded.

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
void	notifyAudioChange (AudioInfo info)
void	setupLazy ()
	Performs lazy initialization of the ring buffer.
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
bool	active = false
	Whether the adapter is active.
int	buffer_size
	Size of the ring buffer.
AudioInfo	info
bool	is_notify_active = true
bool	is_setup = false
	Whether lazy setup has been performed.
Vector< AudioInfoSupport * >	notify_vector
StreamingDecoder *	p_dec = nullptr
	Wrapped StreamingDecoder instance.
Print *	p_print = nullptr
QueueStream< uint8_t >	queue {rbuffer}
	Stream interface to the ring buffer.
RingBuffer< uint8_t >	rbuffer {0}
	Ring buffer for data storage.

Detailed Description

Adapter class which allows the AudioDecoder API on a StreamingDecoder.

This adapter provides the reverse functionality of StreamingDecoderAdapter: it allows you to use a StreamingDecoder with the write-based AudioDecoder API. It uses a ring buffer and queue to convert write() calls into a stream that the StreamingDecoder can read from.

Note

This is useful when you have a StreamingDecoder but need to integrate it into code that expects the AudioDecoder write-based interface.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

DecoderAdapter()

DecoderAdapter ( StreamingDecoder &  dec, int  bufferSize  )

inline

Constructor.

Parameters

dec	The StreamingDecoder to wrap
bufferSize	Size of the internal ring buffer for data transfer

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

inlineoverridevirtual

Starts the processing.

Initializes the wrapped StreamingDecoder and marks this adapter as active.

Returns

true if the StreamingDecoder was started successfully

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

inlineoverridevirtual

Stops the processing.

Marks this adapter as inactive. The wrapped StreamingDecoder is not explicitly stopped to allow continued use.

Reimplemented from AudioDecoder.

getOutput()

Print * getOutput ( )

inlineinherited

getStreamingDecoder()

StreamingDecoder * getStreamingDecoder ( )

inline

Gets the wrapped StreamingDecoder.

Provides direct access to the underlying StreamingDecoder for advanced use cases.

Returns

Pointer to the wrapped StreamingDecoder

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

Returns true to indicate that the decoding result is PCM data.

Reimplemented in CopyDecoder, DecoderNetworkFormat, and ContainerM4A.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

operator bool ( )

inlineoverridevirtual

Checks if the adapter is active.

Returns

true if the adapter is active, false otherwise

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

resize()

void resize ( int  size )

inline

Resizes the internal buffer.

Changes the size of the ring buffer used for data transfer. The buffer is only allocated when first needed (lazy setup).

Parameters

size	New buffer size in bytes

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in DecoderALAC, CodecChain, DSFDecoder, DecoderL8, OpusAudioDecoder, CodecNOP, G729Decoder, 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.

setInput()

void setInput ( Stream &  in )

inline

Sets the input stream for the wrapped decoder.

Parameters

in	The input stream containing encoded audio data

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]

void setOutput ( Print &  out )

inlineoverridevirtual

Defines the output Stream.

Sets the output stream for the wrapped StreamingDecoder.

Parameters

out	The output stream for decoded audio data

Reimplemented from AudioDecoder.

setupLazy()

void setupLazy ( )

inlineprotected

Performs lazy initialization of the ring buffer.

The ring buffer is only allocated when first needed to save memory.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Writes encoded audio data to be decoded.

The data is written to an internal queue, which is then processed by calling copy() on the wrapped StreamingDecoder.

Parameters

data	Buffer containing encoded audio data
len	Number of bytes to write

Returns

Number of bytes actually written

Implements AudioWriter.

writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

active

bool active = false

protected

Whether the adapter is active.

buffer_size

int buffer_size

protected

Size of the ring buffer.

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_setup

bool is_setup = false

protected

Whether lazy setup has been performed.

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_dec

StreamingDecoder* p_dec = nullptr

protected

Wrapped StreamingDecoder instance.

p_print

Print* p_print = nullptr

protectedinherited

queue

QueueStream<uint8_t> queue {rbuffer}

protected

Stream interface to the ring buffer.

rbuffer

RingBuffer<uint8_t> rbuffer {0}

protected

Ring buffer for data storage.

---

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

• src/AudioTools/AudioCodecs/StreamingDecoder.h