From 8f4e1ece7512c2b911491d87edc475b803c3989c Mon Sep 17 00:00:00 2001 From: jacqueline Date: Wed, 28 Aug 2024 09:43:41 +1000 Subject: Some minor cleanup, docs, assertions --- src/tangara/audio/processor.hpp | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'src/tangara/audio/processor.hpp') diff --git a/src/tangara/audio/processor.hpp b/src/tangara/audio/processor.hpp index f1b1d921..45e05291 100644 --- a/src/tangara/audio/processor.hpp +++ b/src/tangara/audio/processor.hpp @@ -87,15 +87,20 @@ class SampleProcessor { StreamBufferHandle_t source_; drivers::PcmBuffer& sink_; + /* Internal utility for managing buffering samples between our filters. */ class Buffer { public: Buffer(); ~Buffer(); + /* Returns a span of the unused space within the buffer. */ auto writeAcquire() -> std::span; + /* Signals how many samples were just added to the writeAcquire span. */ auto writeCommit(size_t) -> void; + /* Returns a span of the samples stored within the buffer. */ auto readAcquire() -> std::span; + /* Signals how many samples from the readAcquire span were consumed. */ auto readCommit(size_t) -> void; auto isEmpty() -> bool; -- cgit v1.2.3