DSFMetadata Struct Reference

Metadata structure for DSF (DSD Stream File) format. More...

#include <CodecDSF.h>

Inheritance diagram for DSFMetadata:

Public Member Functions
	DSFMetadata ()=default
	DSFMetadata (int rate)
virtual void	clear ()
void	copyFrom (AudioInfo info)
	Same as set.
bool	equals (AudioInfo alt)
	Returns true if alt values are the same like the current values.
bool	equalsExSampleRate (AudioInfo alt)
	Checks if only the sample rate is different.
virtual void	logInfo (const char *source="")
	operator bool ()
	Returns true if all components are defined (no component is 0)
bool	operator!= (AudioInfo alt)
	Returns true if alt values are the different from the current values.
bool	operator== (AudioInfo alt)
	Returns true if alt values are the same like the current values.
void	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.

Public Attributes
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
uint8_t	dsd_bits = 1
	BitSize always 1!
uint32_t	dsd_buffer_size
	Internal buffer size for DSD processing.
uint64_t	dsd_data_bytes = 0
	Size of DSD bitstream data in bytes.
uint32_t	dsd_sample_rate
	DSD sample rate (e.g. 2822400 Hz for DSD64)
float	duration_sec = 0
	Approximate audio duration in seconds.
float	filter_cutoff = 0.4f
	Cutoff frequency as fraction of Nyquist.
float	filter_q = 0.5f
int	output_buffer_size = 1024
uint64_t	pcm_frames = 0
	Estimated number of PCM frames after conversion.
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.

Detailed Description

Metadata structure for DSF (DSD Stream File) format.

Author

pschatzmann

Contains format information and metadata extracted from DSF file headers, including DSD sample rates, data sizes, and calculated PCM conversion parameters.

Constructor & Destructor Documentation

DSFMetadata() [1/2]

DSFMetadata ( )

default

DSFMetadata() [2/2]

DSFMetadata ( int  rate )

inline

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtualinherited

copyFrom()

void copyFrom ( AudioInfo  info )

inlineinherited

Same as set.

equals()

bool equals ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inlineinherited

Checks if only the sample rate is different.

logInfo()

virtual void logInfo ( const char *  source = "" )

inlinevirtualinherited

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, and I2SConfigStd.

operator bool()

operator bool ( )

inlineinherited

Returns true if all components are defined (no component is 0)

operator!=()

bool operator!= ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the different from the current values.

operator==()

bool operator== ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

Number of channels: 2=stereo, 1=mono.

dsd_bits

uint8_t dsd_bits = 1

BitSize always 1!

dsd_buffer_size

uint32_t dsd_buffer_size

Initial value:

=
       1024 * 2

Internal buffer size for DSD processing.

dsd_data_bytes

uint64_t dsd_data_bytes = 0

Size of DSD bitstream data in bytes.

dsd_sample_rate

uint32_t dsd_sample_rate

Initial value:

=
      0

DSD sample rate (e.g. 2822400 Hz for DSD64)

duration_sec

float duration_sec = 0

Approximate audio duration in seconds.

filter_cutoff

float filter_cutoff = 0.4f

Cutoff frequency as fraction of Nyquist.

filter_q

float filter_q = 0.5f

output_buffer_size

int output_buffer_size = 1024

pcm_frames

uint64_t pcm_frames = 0

Estimated number of PCM frames after conversion.

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

---

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

• src/AudioTools/AudioCodecs/CodecDSF.h