sbl::diagnostics Namespace Reference

Diagnostics and profiling. More...

Detailed Description

Diagnostics and profiling.

Classes
class	AudioBudget
class	AudioCapture
struct	NamedSection
struct	SectionProfile
struct	TickScope

Functions
int	format_report (char *buf, size_t size, const AudioBudget &budget, const NamedSection *sections, size_t n)
	Format a profiling report into a buffer.
int	format_tagged_report (char *buf, size_t size, const AudioBudget &budget, const NamedSection *sections, size_t n)
	Format profiling data as tagged output lines.
int	format_tagged_histogram (char *buf, size_t size, const AudioBudget &budget)
	Format CPU load histogram as a tagged output line.
void	ticks_init ()
	Initialize the platform timing backend. Call once at startup.
uint32_t	ticks ()
	Read current tick count (free-running, wraps at 2^32).
constexpr uint32_t	tick_rate ()
	Tick rate in Hz (ticks per second).

Function Documentation

format_report()

int sbl::diagnostics::format_report ( char *  buf, size_t  size, const AudioBudget &  budget, const NamedSection *  sections, size_t  n  )

inline

Format a profiling report into a buffer.

Parameters

buf	Output buffer
size	Buffer size
budget	AudioBudget instance
sections	Array of named section profiles
n	Number of sections

Returns

Number of characters written

Definition at line 57 of file report.hpp.

References sbl::diagnostics::AudioBudget::avg_load(), sbl::log::format(), sbl::diagnostics::AudioBudget::overruns(), and sbl::diagnostics::AudioBudget::peak_load().

format_tagged_report()

int sbl::diagnostics::format_tagged_report ( char *  buf, size_t  size, const AudioBudget &  budget, const NamedSection *  sections, size_t  n  )

inline

Format profiling data as tagged output lines.

Emits one #PROF summary line followed by one #PROF.<NAME> line per section. Section names are uppercased in the tag (e.g., "osc" → #PROF.OSC).

Returns

Number of characters written

Definition at line 109 of file report.hpp.

References sbl::diagnostics::AudioBudget::avg_load(), sbl::diagnostics::AudioBudget::count(), sbl::log::format(), sbl::diagnostics::AudioBudget::min_load(), sbl::diagnostics::AudioBudget::overruns(), and sbl::diagnostics::AudioBudget::peak_load().

format_tagged_histogram()

int sbl::diagnostics::format_tagged_histogram ( char *  buf, size_t  size, const AudioBudget &  budget  )

inline

Format CPU load histogram as a tagged output line.

Emits a single #HIST line with 11 bucket counts (10% each, last is >100%).

Returns

Number of characters written

Definition at line 145 of file report.hpp.

References sbl::log::format(), sbl::diagnostics::AudioBudget::hist_bucket(), and sbl::diagnostics::AudioBudget::hist_size().

ticks_init()

void sbl::diagnostics::ticks_init ( )

inline

Initialize the platform timing backend. Call once at startup.

Definition at line 26 of file ticks.hpp.

ticks()

uint32_t sbl::diagnostics::ticks ( )

inline

Read current tick count (free-running, wraps at 2^32).

Definition at line 29 of file ticks.hpp.

Referenced by sbl::diagnostics::AudioBudget::on_block_end(), sbl::diagnostics::AudioBudget::on_block_start(), and sbl::diagnostics::TickScope::~TickScope().

tick_rate()

constexpr uint32_t sbl::diagnostics::tick_rate ( )

inlineconstexpr

Tick rate in Hz (ticks per second).

Definition at line 32 of file ticks.hpp.

Referenced by sbl::diagnostics::AudioBudget::init().