From 12816810855883472ecab454f9c0d08d66f0ae52 Mon Sep 17 00:00:00 2001 From: skal Date: Thu, 5 Feb 2026 20:18:28 +0100 Subject: feat(audio): Complete Task #56 - Audio Lifecycle Refactor (All Phases) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- src/audio/audio_engine.cc | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) (limited to 'src/audio/audio_engine.cc') diff --git a/src/audio/audio_engine.cc b/src/audio/audio_engine.cc index 184e4aa..6d2ee92 100644 --- a/src/audio/audio_engine.cc +++ b/src/audio/audio_engine.cc @@ -3,8 +3,8 @@ #include "audio_engine.h" #include "util/debug.h" -#include #include +#include void AudioEngine::init() { if (initialized_) { @@ -48,7 +48,7 @@ void AudioEngine::reset() { return; } - synth_init(); // Re-init synth (clears all state) + synth_init(); // Re-init synth (clears all state) tracker_reset(); resource_mgr_.reset(); @@ -65,9 +65,9 @@ void AudioEngine::reset() { } void AudioEngine::load_music_data(const TrackerScore* score, - const NoteParams* samples, - const AssetId* sample_assets, - uint32_t sample_count) { + const NoteParams* samples, + const AssetId* sample_assets, + uint32_t sample_count) { // Register sample metadata (lazy loading - don't load yet!) for (uint32_t i = 0; i < sample_count; ++i) { if (sample_assets[i] != AssetId::ASSET_LAST_ID) { @@ -118,7 +118,9 @@ void AudioEngine::trigger_sample(int sample_id, float volume, float pan) { const int synth_id = get_or_register_synth_id(sample_id); if (synth_id == -1) { #if defined(DEBUG_LOG_AUDIO) - DEBUG_AUDIO("[AudioEngine ERROR] Failed to register sample_id=%d with synth\n", sample_id); + DEBUG_AUDIO( + "[AudioEngine ERROR] Failed to register sample_id=%d with synth\n", + sample_id); #endif return; } @@ -148,7 +150,8 @@ int AudioEngine::get_or_register_synth_id(int sample_id) { sample_to_synth_id_[sample_id] = synth_id; #if defined(DEBUG_LOG_AUDIO) - DEBUG_AUDIO("[AudioEngine] Registered sample_id=%d → synth_id=%d\n", sample_id, synth_id); + DEBUG_AUDIO("[AudioEngine] Registered sample_id=%d → synth_id=%d\n", + sample_id, synth_id); #endif return synth_id; @@ -161,7 +164,8 @@ void AudioEngine::seek(float target_time) { } #if defined(DEBUG_LOG_AUDIO) - DEBUG_AUDIO("[AudioEngine] Seeking to t=%.3fs (from t=%.3fs)\n", target_time, current_time_); + DEBUG_AUDIO("[AudioEngine] Seeking to t=%.3fs (from t=%.3fs)\n", target_time, + current_time_); #endif // 1. Reset synth state (clear all active voices) @@ -203,7 +207,8 @@ void AudioEngine::prewarm_for_time_range(float start_time, float end_time) { // and pattern data to determine which samples will be needed. #if defined(DEBUG_LOG_AUDIO) - DEBUG_AUDIO("[AudioEngine] Pre-warming samples for t=%.2f-%.2f\n", start_time, end_time); + DEBUG_AUDIO("[AudioEngine] Pre-warming samples for t=%.2f-%.2f\n", start_time, + end_time); #endif } -- cgit v1.2.3