Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::dataplane::MeterFrame Struct Reference

A single multi-channel meter reading. More...

#include <value_source.hpp>

Public Attributes

std::array< float, kMaxChannels > rms {}
std::array< float, kMaxChannels > peak {}
int channels = 0
 Number of valid channels in rms/peak.

Static Public Attributes

static constexpr int kMaxChannels = 8

Detailed Description

A single multi-channel meter reading.

Fixed-capacity and trivially copyable so it can ride a TripleBuffer with no allocation on the publish path. Stereo is the common case; kMaxChannels is the surround ceiling.

Member Data Documentation

◆ channels

int pulp::dataplane::MeterFrame::channels = 0

Number of valid channels in rms/peak.

Publishers should keep this in [0, kMaxChannels]; consumers must still bound their index by min(channels, kMaxChannels) since publish() stores the frame verbatim and never trusts the count to gate an array access.

◆ kMaxChannels

int pulp::dataplane::MeterFrame::kMaxChannels = 8
staticconstexpr

◆ peak

std::array<float, kMaxChannels> pulp::dataplane::MeterFrame::peak {}

◆ rms

std::array<float, kMaxChannels> pulp::dataplane::MeterFrame::rms {}

The documentation for this struct was generated from the following file:
  • /home/runner/work/pulp/pulp/core/dataplane/include/pulp/dataplane/value_source.hpp