arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
QualityStats Struct Reference

Statistics collected by QualityAnalysisStream. More...

#include <QualityAnalysisStream.h>

Public Member Functions

void clear ()
 

Public Attributes

uint32_t click_count = 0
 
uint32_t clipping_count = 0
 
uint32_t dropout_count = 0
 
float noise_floor = 0.0f
 Slowly tracked noise floor estimate (linear, same scale as rms_level)
 
float rms_level = 0.0f
 Most recent block RMS level (linear, same scale as the sample values)
 
uint32_t signal_detected_count = 0
 Number of times the signal transitioned from lost/absent to present.
 
uint32_t signal_lost_count = 0
 Number of times the signal transitioned from present to lost.
 
bool signal_present = false
 
float snr_db = 0.0f
 Signal-to-noise ratio of the most recent block, in dB.
 
float tonality_confidence = 0.0f
 
uint32_t total_samples = 0
 

Detailed Description

Statistics collected by QualityAnalysisStream.

Member Function Documentation

◆ clear()

void clear ( )
inline

Member Data Documentation

◆ click_count

uint32_t click_count = 0

◆ clipping_count

uint32_t clipping_count = 0

◆ dropout_count

uint32_t dropout_count = 0

◆ noise_floor

float noise_floor = 0.0f

Slowly tracked noise floor estimate (linear, same scale as rms_level)

◆ rms_level

float rms_level = 0.0f

Most recent block RMS level (linear, same scale as the sample values)

◆ signal_detected_count

uint32_t signal_detected_count = 0

Number of times the signal transitioned from lost/absent to present.

◆ signal_lost_count

uint32_t signal_lost_count = 0

Number of times the signal transitioned from present to lost.

◆ signal_present

bool signal_present = false

True while rms_level is sustained above the noise floor by the configured margin (see setSignalMargin()) AND, if a tonality source is set, the signal is periodic/tonal rather than broadband noise

◆ snr_db

float snr_db = 0.0f

Signal-to-noise ratio of the most recent block, in dB.

◆ tonality_confidence

float tonality_confidence = 0.0f

Tonality/periodicity confidence (0-1) from the optional autocorrelation source, see setTonalitySource(). Stays 0 if no source is set.

◆ total_samples

uint32_t total_samples = 0

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