sbl::diagnostics::AudioBudget Class Reference

Detailed Description

Definition at line 41 of file audio_budget.hpp.

#include <audio_budget.hpp>

Public Member Functions
void	init (uint32_t sample_rate, uint16_t block_size)
void	on_block_start ()
	Mark the start of audio processing (call first in callback)
void	on_block_end ()
	Mark the end of audio processing (call last in callback)
float	avg_load () const
	Average load as fraction [0.0, 1.0+].
float	peak_load () const
	Peak (worst-case) load since last reset.
float	min_load () const
	Minimum load since last reset.
uint32_t	avg_ticks () const
	Raw tick counts.
uint32_t	peak_ticks () const
uint32_t	min_ticks () const
uint32_t	budget_ticks () const
uint32_t	overruns () const
	Number of callbacks that exceeded the tick budget.
uint32_t	count () const
	Total callbacks measured.
uint32_t	hist_bucket (size_t i) const
	Read histogram bucket count (0-indexed, last bucket is >100%)
void	reset ()
	Reset statistics (budget preserved)

Static Public Member Functions
static constexpr size_t	hist_size ()
	Number of histogram buckets.

Member Function Documentation

init()

void sbl::diagnostics::AudioBudget::init ( uint32_t  sample_rate, uint16_t  block_size  )

inline

Configure budget from audio parameters. budget_ticks = (tick_rate() / sample_rate) * block_size

Definition at line 47 of file audio_budget.hpp.

References reset(), and sbl::diagnostics::tick_rate().

on_block_start()

void sbl::diagnostics::AudioBudget::on_block_start ( )

inline

Mark the start of audio processing (call first in callback)

Definition at line 57 of file audio_budget.hpp.

References sbl::diagnostics::ticks().

on_block_end()

void sbl::diagnostics::AudioBudget::on_block_end ( )

inline

Mark the end of audio processing (call last in callback)

Definition at line 64 of file audio_budget.hpp.

References sbl::diagnostics::ticks().

avg_load()

float sbl::diagnostics::AudioBudget::avg_load ( ) const

inline

Average load as fraction [0.0, 1.0+].

Definition at line 87 of file audio_budget.hpp.

Referenced by sbl::diagnostics::format_report(), and sbl::diagnostics::format_tagged_report().

peak_load()

float sbl::diagnostics::AudioBudget::peak_load ( ) const

inline

Peak (worst-case) load since last reset.

Definition at line 96 of file audio_budget.hpp.

Referenced by sbl::diagnostics::format_report(), and sbl::diagnostics::format_tagged_report().

min_load()

float sbl::diagnostics::AudioBudget::min_load ( ) const

inline

Minimum load since last reset.

Definition at line 105 of file audio_budget.hpp.

Referenced by sbl::diagnostics::format_tagged_report().

avg_ticks()

uint32_t sbl::diagnostics::AudioBudget::avg_ticks ( ) const

inline

Raw tick counts.

Definition at line 114 of file audio_budget.hpp.

peak_ticks()

uint32_t sbl::diagnostics::AudioBudget::peak_ticks ( ) const

inline

Definition at line 122 of file audio_budget.hpp.

min_ticks()

uint32_t sbl::diagnostics::AudioBudget::min_ticks ( ) const

inline

Definition at line 130 of file audio_budget.hpp.

budget_ticks()

uint32_t sbl::diagnostics::AudioBudget::budget_ticks ( ) const

inline

Definition at line 138 of file audio_budget.hpp.

overruns()

uint32_t sbl::diagnostics::AudioBudget::overruns ( ) const

inline

Number of callbacks that exceeded the tick budget.

Definition at line 147 of file audio_budget.hpp.

Referenced by sbl::diagnostics::format_report(), and sbl::diagnostics::format_tagged_report().

count()

uint32_t sbl::diagnostics::AudioBudget::count ( ) const

inline

Total callbacks measured.

Definition at line 156 of file audio_budget.hpp.

Referenced by sbl::diagnostics::format_tagged_report().

hist_size()

static constexpr size_t sbl::diagnostics::AudioBudget::hist_size ( )

inlinestaticconstexpr

Number of histogram buckets.

Definition at line 167 of file audio_budget.hpp.

Referenced by sbl::diagnostics::format_tagged_histogram().

hist_bucket()

uint32_t sbl::diagnostics::AudioBudget::hist_bucket ( size_t  i ) const

inline

Read histogram bucket count (0-indexed, last bucket is >100%)

Definition at line 170 of file audio_budget.hpp.

Referenced by sbl::diagnostics::format_tagged_histogram().

reset()

void sbl::diagnostics::AudioBudget::reset ( )

inline

Reset statistics (budget preserved)

Definition at line 179 of file audio_budget.hpp.

Referenced by init().

---

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

• src/sbl/common/diagnostics/audio_budget.hpp