summaryrefslogtreecommitdiff
path: root/src/audio/ring_buffer.cc
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-02-05 20:18:28 +0100
committerskal <pascal.massimino@gmail.com>2026-02-05 20:18:28 +0100
commit12816810855883472ecab454f9c0d08d66f0ae52 (patch)
tree37e294d82cfe7c6cb887ed774268e6243fae0c77 /src/audio/ring_buffer.cc
parent3ba0d20354a67b9fc62d29d13bc283c18130bbb9 (diff)
feat(audio): Complete Task #56 - Audio Lifecycle Refactor (All Phases)
SUMMARY ======= Successfully completed comprehensive 4-phase refactor of audio subsystem to eliminate fragile initialization order dependency between synth and tracker. This addresses long-standing architectural fragility where tracker required synth to be initialized first or spectrograms would be cleared. IMPLEMENTATION ============== Phase 1: Design & Prototype - Created AudioEngine class as unified audio subsystem manager - Created SpectrogramResourceManager for lazy resource loading - Manages synth, tracker, and resource lifecycle - Comprehensive test suite (test_audio_engine.cc) Phase 2: Test Migration - Migrated all tracker tests to use AudioEngine - Updated: test_tracker.cc, test_tracker_timing.cc, test_variable_tempo.cc, test_wav_dump.cc - Pattern: Replace synth_init() + tracker_init() with engine.init() - All 20 tests pass (100% pass rate) Phase 3: Production Integration - Fixed pre-existing demo crash (procedural texture loading) - Updated flash_cube_effect.cc and hybrid_3d_effect.cc - Migrated main.cc to use AudioEngine - Replaced tracker_update() calls with engine.update() Phase 4: Cleanup & Documentation - Removed synth_init() call from audio_init() (backwards compatibility) - Added AudioEngine usage guide to HOWTO.md - Added audio initialization protocols to CONTRIBUTING.md - Binary size verification: <500 bytes overhead (acceptable) RESULTS ======= ✅ All 20 tests pass (100% pass rate) ✅ Demo runs successfully with audio and visuals ✅ Initialization order fragility eliminated ✅ Binary size impact minimal (<500 bytes) ✅ Clear documentation for future development ✅ No backwards compatibility issues DOCUMENTATION UPDATES ===================== - Updated TODO.md: Moved Task #56 to "Recently Completed" - Updated PROJECT_CONTEXT.md: Added AudioEngine milestone - Updated HOWTO.md: Added "Audio System" section with usage examples - Updated CONTRIBUTING.md: Added audio initialization protocols CODE FORMATTING =============== Applied clang-format to all source files per project standards. FILES CREATED ============= - src/audio/audio_engine.h (new) - src/audio/audio_engine.cc (new) - src/audio/spectrogram_resource_manager.h (new) - src/audio/spectrogram_resource_manager.cc (new) - src/tests/test_audio_engine.cc (new) KEY FILES MODIFIED ================== - src/main.cc (migrated to AudioEngine) - src/audio/audio.cc (removed backwards compatibility) - All tracker test files (migrated to AudioEngine) - doc/HOWTO.md (added usage guide) - doc/CONTRIBUTING.md (added protocols) - TODO.md (marked complete) - PROJECT_CONTEXT.md (added milestone) TECHNICAL DETAILS ================= AudioEngine Design Philosophy: - Manages initialization order (synth before tracker) - Owns SpectrogramResourceManager for lazy loading - Does NOT wrap every synth API - direct calls remain valid - Provides lifecycle management, not a complete facade What to Use AudioEngine For: - Initialization: engine.init() instead of separate init calls - Updates: engine.update(music_time) instead of tracker_update() - Cleanup: engine.shutdown() for proper teardown - Seeking: engine.seek(time) for timeline navigation (debug only) Direct Synth API Usage (Still Valid): - synth_register_spectrogram() - Register samples - synth_trigger_voice() - Trigger playback - synth_get_output_peak() - Get audio levels - synth_render() - Low-level rendering SIZE IMPACT ANALYSIS ==================== Debug build: 6.2MB Size-optimized build: 5.0MB Stripped build: 5.0MB AudioEngine overhead: <500 bytes (0.01% of total) BACKWARD COMPATIBILITY ====================== No breaking changes. Tests that need low-level control can still call synth_init() directly. AudioEngine is the recommended pattern for production code and tests requiring both synth and tracker. handoff(Claude): Task #56 COMPLETE - All 4 phases finished. Audio initialization is now robust, well-documented, and properly tested. The fragile initialization order dependency has been eliminated. 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.cc37
1 files changed, 22 insertions, 15 deletions
diff --git a/src/audio/ring_buffer.cc b/src/audio/ring_buffer.cc
index ab51d6b..b30ebbb 100644
--- a/src/audio/ring_buffer.cc
+++ b/src/audio/ring_buffer.cc
@@ -4,14 +4,12 @@
#include "ring_buffer.h"
#include "util/debug.h"
#include <algorithm>
+#include <cstdio> // for fprintf()
+#include <cstdlib> // for abort()
#include <cstring>
-#include <cstdlib> // for abort()
-#include <cstdio> // for fprintf()
AudioRingBuffer::AudioRingBuffer()
- : capacity_(RING_BUFFER_CAPACITY_SAMPLES),
- write_pos_(0),
- read_pos_(0),
+ : capacity_(RING_BUFFER_CAPACITY_SAMPLES), write_pos_(0), read_pos_(0),
total_read_(0) {
memset(buffer_, 0, sizeof(buffer_));
}
@@ -25,7 +23,7 @@ int AudioRingBuffer::available_write() const {
const int read = read_pos_.load(std::memory_order_acquire);
if (write >= read) {
- return capacity_ - (write - read) - 1; // -1 to avoid full/empty ambiguity
+ return capacity_ - (write - read) - 1; // -1 to avoid full/empty ambiguity
} else {
return read - write - 1;
}
@@ -65,7 +63,8 @@ int AudioRingBuffer::write(const float* samples, int count) {
// 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",
+ fprintf(stderr,
+ "BOUNDS ERROR in write(): write=%d, to_write=%d, capacity=%d\n",
write, to_write, capacity_);
abort();
}
@@ -75,7 +74,9 @@ int AudioRingBuffer::write(const float* samples, int count) {
// 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",
+ fprintf(stderr,
+ "BOUNDS ERROR in write() chunk1: write=%d, space_to_end=%d, "
+ "capacity=%d\n",
write, space_to_end, capacity_);
abort();
}
@@ -83,7 +84,8 @@ int AudioRingBuffer::write(const float* samples, int count) {
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",
+ fprintf(stderr,
+ "BOUNDS ERROR in write() chunk2: remainder=%d, capacity=%d\n",
remainder, capacity_);
abort();
}
@@ -114,7 +116,8 @@ int AudioRingBuffer::read(float* samples, int count) {
// 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",
+ fprintf(stderr,
+ "BOUNDS ERROR in read(): read=%d, to_read=%d, capacity=%d\n",
read, to_read, capacity_);
abort();
}
@@ -124,7 +127,9 @@ int AudioRingBuffer::read(float* samples, int count) {
// 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",
+ fprintf(stderr,
+ "BOUNDS ERROR in read() chunk1: read=%d, space_to_end=%d, "
+ "capacity=%d\n",
read, space_to_end, capacity_);
abort();
}
@@ -132,7 +137,8 @@ int AudioRingBuffer::read(float* samples, int count) {
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",
+ fprintf(stderr,
+ "BOUNDS ERROR in read() chunk2: remainder=%d, capacity=%d\n",
remainder, capacity_);
abort();
}
@@ -148,9 +154,10 @@ int AudioRingBuffer::read(float* samples, int count) {
#if defined(DEBUG_LOG_RING_BUFFER)
// UNDERRUN DETECTED
static int underrun_count = 0;
- if (++underrun_count % 10 == 1) { // Log every 10th underrun
- DEBUG_RING_BUFFER("UNDERRUN #%d: requested=%d, available=%d, filling %d with silence\n",
- underrun_count, count, to_read, count - to_read);
+ if (++underrun_count % 10 == 1) { // Log every 10th underrun
+ DEBUG_RING_BUFFER(
+ "UNDERRUN #%d: requested=%d, available=%d, filling %d with silence\n",
+ underrun_count, count, to_read, count - to_read);
}
#endif /* defined(DEBUG_LOG_RING_BUFFER) */
memset(samples + to_read, 0, (count - to_read) * sizeof(float));