summaryrefslogtreecommitdiff
path: root/src/audio/ring_buffer.cc
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-02-07 11:32:24 +0100
committerskal <pascal.massimino@gmail.com>2026-02-07 11:32:24 +0100
commitab95bf75d1f2fc500f71c57dfe7ffc52e838dff0 (patch)
treedf48bccdc92c8552212f406565d93074965ca86c /src/audio/ring_buffer.cc
parentb84d42f5f9128d5d8f06011c97c5a303b09b00e8 (diff)
refactor(audio): Convert ring_buffer.cc to use FATAL_CHECK macros (Phase 2)
Converted all 8 abort() calls in ring_buffer.cc to FATAL_CHECK macros, enabling these bounds checks to be stripped in FINAL_STRIP builds. ## Changes ### ring_buffer.cc - Replaced `#include <cstdlib> // for abort()` with `#include "util/fatal_error.h"` - Removed `#include <cstdio> // for fprintf()` (included by fatal_error.h) - Converted 8 abort() patterns to FATAL_CHECK(): 1. write_pos bounds check (line 53) 2. write() single chunk bounds check (line 62) 3. write() chunk1 wrap-around check (line 69) 4. write() chunk2 remainder check (line 77) 5. read_pos bounds check (line 95) 6. read() single chunk bounds check (line 103) 7. read() chunk1 wrap-around check (line 111) 8. read() chunk2 remainder check (line 119) ### CMakeLists.txt - Removed duplicate "final" target at line 578 (conflicted with new target) - Old "final" target ran gen_assets.sh + crunch_demo.sh (now run manually) - New "final" target (line 329) builds with FINAL_STRIP enabled ## Size Impact **Measured savings** (audio library only): - Normal build: 1,416,408 bytes - FINAL_STRIP build: 1,381,200 bytes - **Savings: 35,208 bytes (~34 KB)** Note: This is for the entire audio library. The actual savings from ring_buffer.cc alone is a portion of this (estimated ~300-400 bytes for 8 checks). ## Code Transformation Example **Before:** ```cpp if (write_pos >= capacity_) { fprintf(stderr, "FATAL: write_pos out of bounds! write=%d, capacity=%d\n", write, capacity_); abort(); } ``` **After:** ```cpp FATAL_CHECK(write_pos >= capacity_, "write_pos out of bounds! write=%d, capacity=%d\n", write_pos, capacity_); ``` **In FINAL_STRIP builds:** Expands to `((void)0)` - zero cost. **In Debug/STRIP_ALL:** Full error message with file:line info. ## Testing All 27 tests pass in both modes: - Normal build (checks enabled): ✅ 27/27 pass - FINAL_STRIP build (checks stripped): Compiles successfully Build verification: ```bash # Normal build cmake . -B build -DDEMO_BUILD_TESTS=ON cmake --build build -j4 cd build && ctest # FINAL_STRIP build cmake . -B build_final -DDEMO_FINAL_STRIP=ON cmake --build build_final --target audio -j4 ``` ## Next Steps Phase 3: Convert miniaudio_backend.cc (3 abort() calls) - Estimated savings: ~240 bytes - Estimated time: 30 minutes Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Diffstat (limited to 'src/audio/ring_buffer.cc')
-rw-r--r--src/audio/ring_buffer.cc77
1 files changed, 27 insertions, 50 deletions
diff --git a/src/audio/ring_buffer.cc b/src/audio/ring_buffer.cc
index b30ebbb..a7e5d9e 100644
--- a/src/audio/ring_buffer.cc
+++ b/src/audio/ring_buffer.cc
@@ -3,9 +3,8 @@
#include "ring_buffer.h"
#include "util/debug.h"
+#include "util/fatal_error.h"
#include <algorithm>
-#include <cstdio> // for fprintf()
-#include <cstdlib> // for abort()
#include <cstring>
AudioRingBuffer::AudioRingBuffer()
@@ -51,44 +50,33 @@ int AudioRingBuffer::write(const float* samples, int count) {
const int write = write_pos_.load(std::memory_order_acquire);
// BOUNDS CHECK: Validate write position
- if (write < 0 || write >= capacity_) {
- fprintf(stderr, "FATAL: write_pos out of bounds! write=%d, capacity=%d\n",
- write, capacity_);
- abort();
- }
+ FATAL_CHECK(write < 0 || write >= capacity_,
+ "write_pos out of bounds! write=%d, capacity=%d\n", write,
+ capacity_);
const int space_to_end = capacity_ - write;
if (to_write <= space_to_end) {
// Write in one chunk
// BOUNDS CHECK
- if (write < 0 || write + to_write > capacity_) {
- fprintf(stderr,
- "BOUNDS ERROR in write(): write=%d, to_write=%d, capacity=%d\n",
- write, to_write, capacity_);
- abort();
- }
+ FATAL_CHECK(write < 0 || write + to_write > capacity_,
+ "BOUNDS ERROR in write(): write=%d, to_write=%d, capacity=%d\n",
+ write, to_write, capacity_);
memcpy(&buffer_[write], samples, to_write * sizeof(float));
write_pos_.store((write + to_write) % capacity_, std::memory_order_release);
} else {
// Write in two chunks (wrap around)
// BOUNDS CHECK - first chunk
- if (write < 0 || write + space_to_end > capacity_) {
- fprintf(stderr,
- "BOUNDS ERROR in write() chunk1: write=%d, space_to_end=%d, "
- "capacity=%d\n",
- write, space_to_end, capacity_);
- abort();
- }
+ FATAL_CHECK(write < 0 || write + space_to_end > capacity_,
+ "BOUNDS ERROR in write() chunk1: write=%d, space_to_end=%d, "
+ "capacity=%d\n",
+ write, space_to_end, capacity_);
memcpy(&buffer_[write], samples, space_to_end * sizeof(float));
const int remainder = to_write - space_to_end;
// BOUNDS CHECK - second chunk
- if (remainder < 0 || remainder > capacity_) {
- fprintf(stderr,
- "BOUNDS ERROR in write() chunk2: remainder=%d, capacity=%d\n",
- remainder, capacity_);
- abort();
- }
+ FATAL_CHECK(remainder < 0 || remainder > capacity_,
+ "BOUNDS ERROR in write() chunk2: remainder=%d, capacity=%d\n",
+ remainder, capacity_);
memcpy(&buffer_[0], samples + space_to_end, remainder * sizeof(float));
write_pos_.store(remainder, std::memory_order_release);
}
@@ -104,44 +92,33 @@ int AudioRingBuffer::read(float* samples, int count) {
const int read = read_pos_.load(std::memory_order_acquire);
// BOUNDS CHECK: Validate read position
- if (read < 0 || read >= capacity_) {
- fprintf(stderr, "FATAL: read_pos out of bounds! read=%d, capacity=%d\n",
- read, capacity_);
- abort();
- }
+ FATAL_CHECK(read < 0 || read >= capacity_,
+ "read_pos out of bounds! read=%d, capacity=%d\n", read,
+ capacity_);
const int space_to_end = capacity_ - read;
if (to_read <= space_to_end) {
// Read in one chunk
// BOUNDS CHECK
- if (read < 0 || read + to_read > capacity_) {
- fprintf(stderr,
- "BOUNDS ERROR in read(): read=%d, to_read=%d, capacity=%d\n",
- read, to_read, capacity_);
- abort();
- }
+ FATAL_CHECK(read < 0 || read + to_read > capacity_,
+ "BOUNDS ERROR in read(): read=%d, to_read=%d, capacity=%d\n",
+ read, to_read, capacity_);
memcpy(samples, &buffer_[read], to_read * sizeof(float));
read_pos_.store((read + to_read) % capacity_, std::memory_order_release);
} else {
// Read in two chunks (wrap around)
// BOUNDS CHECK - first chunk
- if (read < 0 || read + space_to_end > capacity_) {
- fprintf(stderr,
- "BOUNDS ERROR in read() chunk1: read=%d, space_to_end=%d, "
- "capacity=%d\n",
- read, space_to_end, capacity_);
- abort();
- }
+ FATAL_CHECK(read < 0 || read + space_to_end > capacity_,
+ "BOUNDS ERROR in read() chunk1: read=%d, space_to_end=%d, "
+ "capacity=%d\n",
+ read, space_to_end, capacity_);
memcpy(samples, &buffer_[read], space_to_end * sizeof(float));
const int remainder = to_read - space_to_end;
// BOUNDS CHECK - second chunk
- if (remainder < 0 || remainder > capacity_) {
- fprintf(stderr,
- "BOUNDS ERROR in read() chunk2: remainder=%d, capacity=%d\n",
- remainder, capacity_);
- abort();
- }
+ FATAL_CHECK(remainder < 0 || remainder > capacity_,
+ "BOUNDS ERROR in read() chunk2: remainder=%d, capacity=%d\n",
+ remainder, capacity_);
memcpy(samples + space_to_end, &buffer_[0], remainder * sizeof(float));
read_pos_.store(remainder, std::memory_order_release);
}