arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
DSFDecoder Class Reference

Decodes DSF files containing DSD audio and converts to PCM. More...

#include <CodecDSF.h>

Inheritance diagram for DSFDecoder:
AudioDecoder AudioWriter AudioInfoSource AudioInfoSupport

Public Member Functions

 DSFDecoder ()=default
 
 DSFDecoder (DSFMetadata metaData)
 
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 () override
 
const DSFMetadata getMetadata ()
 
PrintgetOutput ()
 
bool isHeaderAvailable ()
 
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 ()
 
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 setInfoCallback (void(*callback)(const DSFFormat &fmt))
 Register a callback that receives the raw DSFFormat header after parsing.
 
void setMetaData (DSFMetadata metaData)
 
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) override
 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

bool allChannelsHaveData (int bytesNeeded)
 
size_t bufferDSDData (const uint8_t *data, size_t len, size_t startPos)
 
float clip (float value)
 
void convertDSDToPCM ()
 
int findTag (const char *tag, const uint8_t *data, size_t len)
 
int getFilterStages ()
 
int getOutputBufferSize ()
 
void notifyAudioChange (AudioInfo info)
 
bool parseData (const uint8_t *data, size_t len)
 
bool parseFMT (const uint8_t *data, size_t len)
 
int popcount8 (uint8_t v)
 
size_t processDSDData (const uint8_t *data, size_t len, size_t startPos)
 
size_t processHeader (const uint8_t *data, size_t len)
 
void setupDecimationStep ()
 
void setupFilters ()
 
void writeBlocking (Print *out, uint8_t *data, size_t len)
 
void writePCMSample (float filteredValue)
 

Protected Attributes

uint32_t blockPos = 0
 
Vector< SingleBuffer< uint8_t > > channelDsdBuffers
 
Vector< LowPassFilter< float > > channelFilters
 
uint32_t decimationStep
 
bool headerParsed = false
 
AudioInfo info
 
void(* infoCallback )(const DSFFormat &fmt) = nullptr
 
bool is_notify_active = true
 
bool isActive = false
 
DSFMetadata meta
 
Vector< AudioInfoSupport * > notify_vector
 
Printp_print = nullptr
 
SingleBuffer< uint8_tpcmBuffer {0}
 

Detailed Description

Decodes DSF files containing DSD audio and converts to PCM.

Author
pschatzmann

Uses per-channel buffers for correct block-level de-interleaving, bit-counting decimation, and cascaded Butterworth low-pass filters for anti-aliasing.

Constructor & Destructor Documentation

◆ DSFDecoder() [1/2]

DSFDecoder ( )
default

◆ DSFDecoder() [2/2]

DSFDecoder ( DSFMetadata  metaData)
inline

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport bi)
inlinevirtualinherited

◆ allChannelsHaveData()

bool allChannelsHaveData ( int  bytesNeeded)
inlineprotected

◆ audioInfo()

AudioInfo audioInfo ( )
inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

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

◆ bufferDSDData()

size_t bufferDSDData ( const uint8_t data,
size_t  len,
size_t  startPos 
)
inlineprotected

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ clip()

float clip ( float  value)
inlineprotected

◆ convertDSDToPCM()

void convertDSDToPCM ( )
inlineprotected

◆ end()

void end ( )
inlineoverridevirtual

Reimplemented from AudioDecoder.

◆ findTag()

int findTag ( const char tag,
const uint8_t data,
size_t  len 
)
inlineprotected

◆ getFilterStages()

int getFilterStages ( )
inlineprotected

◆ getMetadata()

const DSFMetadata getMetadata ( )
inline

◆ getOutput()

Print * getOutput ( )
inlineinherited

◆ getOutputBufferSize()

int getOutputBufferSize ( )
inlineprotected

◆ isHeaderAvailable()

bool isHeaderAvailable ( )
inline

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

Implements AudioWriter.

◆ parseData()

bool parseData ( const uint8_t data,
size_t  len 
)
inlineprotected

◆ parseFMT()

bool parseFMT ( const uint8_t data,
size_t  len 
)
inlineprotected

◆ popcount8()

int popcount8 ( uint8_t  v)
inlineprotected

◆ processDSDData()

size_t processDSDData ( const uint8_t data,
size_t  len,
size_t  startPos 
)
inlineprotected

◆ processHeader()

size_t processHeader ( const uint8_t data,
size_t  len 
)
inlineprotected

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

for most decoders this is not needed

Reimplemented from AudioDecoder.

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

◆ setInfoCallback()

void setInfoCallback ( void(*)(const DSFFormat &fmt callback)
inline

Register a callback that receives the raw DSFFormat header after parsing.

◆ setMetaData()

void setMetaData ( DSFMetadata  metaData)
inline

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

◆ setupDecimationStep()

void setupDecimationStep ( )
inlineprotected

◆ setupFilters()

void setupFilters ( )
inlineprotected

◆ 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

◆ writePCMSample()

void writePCMSample ( float  filteredValue)
inlineprotected

Member Data Documentation

◆ blockPos

uint32_t blockPos = 0
protected

◆ channelDsdBuffers

Vector<SingleBuffer<uint8_t> > channelDsdBuffers
protected

◆ channelFilters

Vector<LowPassFilter<float> > channelFilters
protected

◆ decimationStep

uint32_t decimationStep
protected

◆ headerParsed

bool headerParsed = false
protected

◆ id

int id
inherited

custom id to be used by application

◆ info

AudioInfo info
protectedinherited

◆ infoCallback

void(* infoCallback) (const DSFFormat &fmt) = nullptr
protected

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ isActive

bool isActive = false
protected

◆ meta

DSFMetadata meta
protected

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector
protectedinherited

◆ p_print

Print* p_print = nullptr
protectedinherited

◆ pcmBuffer

SingleBuffer<uint8_t> pcmBuffer {0}
protected

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