arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
DecoderL16 Class Reference
Arduino Audio Tools » Codecs | Arduino Audio Tools » Codecs » Decoder

DecoderL16 - Converts an 16 Bit Stream into 16Bits network byte order. More...

#include <CodecL16.h>

Inheritance diagram for DecoderL16:
AudioDecoder AudioWriter AudioInfoSource AudioInfoSupport

Public Member Functions

 DecoderL16 ()
 Construct a new DecoderL16 object.
 
 DecoderL16 (Print &out_stream, AudioInfoSupport &bi)
 Construct a new DecoderL16 object.
 
 DecoderL16 (Print &out_stream, bool active=true)
 Construct a new DecoderL16 object.
 
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
 
virtual bool begin (AudioInfo info) override
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
void end () override
 
Print * getOutput ()
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual bool isResultPCM ()
 Returns true to indicate that the decoding result is PCM data.
 
virtual operator bool () override
 
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.
 
void setOutput (Print &out_stream) override
 Defines the output Stream.
 
virtual size_t write (const uint8_t *data, size_t len) override
 

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
 
Vector< AudioInfoSupport * > notify_vector
 
Print * p_print = nullptr
 

Detailed Description

DecoderL16 - Converts an 16 Bit Stream into 16Bits network byte order.

Author
Phil Schatzmann
Copyright
GPLv3

Constructor & Destructor Documentation

◆ DecoderL16() [1/3]

DecoderL16 ( )
inline

Construct a new DecoderL16 object.

◆ DecoderL16() [2/3]

DecoderL16 ( Print &  out_stream,
bool  active = true 
)
inline

Construct a new DecoderL16 object.

Parameters
out_streamOutput Stream to which we write the decoded result

◆ DecoderL16() [3/3]

DecoderL16 ( Print &  out_stream,
AudioInfoSupport &  bi 
)
inline

Construct a new DecoderL16 object.

Parameters
out_streamOutput Stream to which we write the decoded result
biObject that will be notified about the Audio Formt (Changes)

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

Implements AudioWriter.

Reimplemented in CodecNOP, CodecChain, Codec2Decoder, CopyDecoder, DSFDecoder, FLACDecoderFoxen, G722Decoder, GSMDecoder, ILBCDecoder, LC3Decoder, MP3DecoderMini, DecoderNetworkFormat, SBCDecoder, WavIMADecoder, BinaryContainerDecoder, OSCContainerDecoder, DecoderBase64, DecoderBasic, G7xxDecoder, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, OpusAudioDecoder, OpusOggDecoder, MTSDecoderTSDemux, VorbisDecoder, WAVDecoder, AVIDecoder, ContainerM4A, OggContainerDecoder, MultiDecoder, DecoderAdapter, VorbisDecoder, and MetaDataFilterDecoder.

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

Implements AudioWriter.

Reimplemented in CodecNOP, Codec2Decoder, CopyDecoder, FLACDecoderFoxen, G722Decoder, GSMDecoder, ILBCDecoder, LC3Decoder, MP3DecoderMini, DecoderNetworkFormat, SBCDecoder, WavIMADecoder, BinaryContainerDecoder, OSCContainerDecoder, DecoderBase64, DecoderBasic, CodecChain, DSFDecoder, G7xxDecoder, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, OpusAudioDecoder, OpusOggDecoder, MTSDecoderTSDemux, VorbisDecoder, WAVDecoder, AVIDecoder, ContainerM4A, OggContainerDecoder, MultiDecoder, DecoderAdapter, VorbisDecoder, and MetaDataFilterDecoder.

◆ getOutput()

Print * getOutput ( )
inlineinherited

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

virtual operator bool ( )
inlineoverridevirtual

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]

void setOutput ( Print &  out_stream)
inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioDecoder.

◆ write()

virtual size_t write ( const uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

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

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector
protectedinherited

◆ p_print

Print* p_print = nullptr
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8