pulp::test::audio::ChannelMetrics Struct Reference

Per-channel facts about a rendered buffer. More...

#include <audio_metrics.hpp>

Public Member Functions
double	peak_dbfs () const
double	rms_dbfs () const

Public Attributes
double	peak = 0.0
	Max |sample|, linear.
double	rms = 0.0
	Root mean square, linear.
double	dc_offset = 0.0
	Mean sample value.
std::uint64_t	nan_samples = 0
	Count of NaN samples.
std::uint64_t	inf_samples = 0
	Count of ±Inf samples.
std::uint64_t	clipped_samples = 0
	Count at/above clip threshold.
std::uint64_t	longest_silence_run = 0
	Longest consecutive sub-threshold run.

Detailed Description

Per-channel facts about a rendered buffer.

Member Function Documentation

peak_dbfs()

double pulp::test::audio::ChannelMetrics::peak_dbfs ( ) const

inline

rms_dbfs()

double pulp::test::audio::ChannelMetrics::rms_dbfs ( ) const

inline

Member Data Documentation

clipped_samples

std::uint64_t pulp::test::audio::ChannelMetrics::clipped_samples = 0

Count at/above clip threshold.

dc_offset

double pulp::test::audio::ChannelMetrics::dc_offset = 0.0

Mean sample value.

inf_samples

std::uint64_t pulp::test::audio::ChannelMetrics::inf_samples = 0

Count of ±Inf samples.

longest_silence_run

std::uint64_t pulp::test::audio::ChannelMetrics::longest_silence_run = 0

Longest consecutive sub-threshold run.

nan_samples

std::uint64_t pulp::test::audio::ChannelMetrics::nan_samples = 0

Count of NaN samples.

peak

double pulp::test::audio::ChannelMetrics::peak = 0.0

Max |sample|, linear.

rms

double pulp::test::audio::ChannelMetrics::rms = 0.0

Root mean square, linear.

---

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

• /home/runner/work/pulp/pulp/tools/audio/analysis/include/pulp/audio/analysis/audio_metrics.hpp