DSFEncoder Class Reference

DSF (DSD Stream File) format encoder. More...

#include <CodecDSF.h>

Inheritance diagram for DSFEncoder:

Classes
struct	ChannelModState

Public Member Functions
	DSFEncoder ()=default
	DSFEncoder (DSFMetadata metaData)
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin () override
virtual bool	begin (AudioInfo info)
void	end () override
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual int	frameSize ()
const DSFMetadata	getMetadata ()
const char *	mime () override
	Provides the mime type of the encoded result.
	operator bool () override
virtual uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
void	setAudioInfo (AudioInfo from) override
	Defines the sample rate, number of channels and bits per sample.
void	setMetaData (DSFMetadata metaData)
void	setOutput (Print &out) override
	Default output assignment (encoders may override to store Print reference)
size_t	write (const uint8_t *data, size_t len) override

Protected Member Functions
bool	allBlocksFull ()
void	convertSampleToDSD (int ch, float currentSample)
void	flushPartialBlocks ()
float	readPCMSample (const uint8_t *ptr)
void	writeBlocking (Print *out, uint8_t *data, size_t len)
void	writeBlockSet ()
void	writeDSFHeader ()

Protected Attributes
Vector< SingleBuffer< uint8_t > >	channelBlocks
Vector< ChannelModState >	chState
bool	headerWritten = false
AudioInfo	info
bool	isOpen = false
DSFMetadata	meta
uint32_t	oversamplingRatio = 64
Print *	p_print = nullptr
uint64_t	totalDsdBytes = 0

Detailed Description

DSF (DSD Stream File) format encoder.

Author

pschatzmann

Encodes PCM audio into DSD format and writes DSF files. Uses a 2nd order error-feedback delta-sigma modulator with linear interpolation between PCM samples. Output uses correct DSF block-level channel interleaving.

Constructor & Destructor Documentation

DSFEncoder() [1/2]

DSFEncoder ( )

default

DSFEncoder() [2/2]

DSFEncoder ( DSFMetadata  metaData )

inline

Member Function Documentation

allBlocksFull()

bool allBlocksFull ( )

inlineprotected

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, MP3EncoderShine, BinaryContainerEncoder, and MP3ParserEncoder.

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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in OpusOggEncoder, OggContainerEncoder, DecoderBasic, AudioDecoder, AACEncoderFDK, AACEncoderVO, OggContainerDecoder, and MetaDataFilterEncoder.

convertSampleToDSD()

void convertSampleToDSD ( int  ch, float  currentSample  )

inlineprotected

end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

flushPartialBlocks()

void flushPartialBlocks ( )

inlineprotected

frameDurationUs()

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, MP3EncoderShine, OpusOggEncoder, MP3ParserEncoder, and MetaDataFilterEncoder.

frameSize()

virtual int frameSize ( )

inlinevirtualinherited

Optional rtsp function: provide the encoded size (in bytes) of one frame, once known (e.g. after the encoder has seen real data). Lets an RTSPFormat size its RTP fragments to match one frame instead of a fixed guess, so throughput actually tracks frameDurationUs() - a fragment size covering several frames' worth of bytes sent at one-frame timing overruns real-time bandwidth and, over UDP (no flow control), causes packet loss. Returns 0 if not yet known/not applicable (fixed-frame-size codecs have no need to override this).

Reimplemented in ADPCMEncoder, EncoderALAC, AMRNBEncoder, AMRWBEncoder, and MP3ParserEncoder.

getMetadata()

const DSFMetadata getMetadata ( )

inline

mime()

const char * mime ( )

inlineoverridevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

readPCMSample()

float readPCMSample ( const uint8_t *  ptr )

inlineprotected

samplesPerFrame()

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

Reimplemented in OpusAudioEncoder, OpusMultiStreamAudioEncoder, MP3EncoderShine, MP3ParserEncoder, and MetaDataFilterEncoder.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtual

Defines the sample rate, number of channels and bits per sample.

Reimplemented from AudioEncoder.

setMetaData()

void setMetaData ( DSFMetadata  metaData )

inline

setOutput()

void setOutput ( Print &  out_stream )

inlineoverridevirtual

Default output assignment (encoders may override to store Print reference)

Reimplemented from AudioEncoder.

write()

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

writeBlockSet()

void writeBlockSet ( )

inlineprotected

writeDSFHeader()

void writeDSFHeader ( )

inlineprotected

Member Data Documentation

channelBlocks

Vector<SingleBuffer<uint8_t> > channelBlocks

protected

chState

Vector<ChannelModState> chState

protected

headerWritten

bool headerWritten = false

protected

info

AudioInfo info

protectedinherited

isOpen

bool isOpen = false

protected

meta

DSFMetadata meta

protected

oversamplingRatio

uint32_t oversamplingRatio = 64

protected

p_print

Print* p_print = nullptr

protected

totalDsdBytes

uint64_t totalDsdBytes = 0

protected

---

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

• src/AudioTools/AudioCodecs/CodecDSF.h