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/tests/test_audio_engine.cc | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) (limited to 'src/tests/test_audio_engine.cc') diff --git a/src/tests/test_audio_engine.cc b/src/tests/test_audio_engine.cc index eb6ccb1..3b29dcd 100644 --- a/src/tests/test_audio_engine.cc +++ b/src/tests/test_audio_engine.cc @@ -37,19 +37,19 @@ void test_audio_engine_music_loading() { engine.init(); // Load global music data - engine.load_music_data(&g_tracker_score, - g_tracker_samples, - g_tracker_sample_assets, - g_tracker_samples_count); + engine.load_music_data(&g_tracker_score, g_tracker_samples, + g_tracker_sample_assets, g_tracker_samples_count); - // Verify resource manager was initialized (samples registered but not loaded yet) + // Verify resource manager was initialized (samples registered but not loaded + // yet) SpectrogramResourceManager* res_mgr = engine.get_resource_manager(); assert(res_mgr != nullptr); // Initially, no samples should be loaded (lazy loading) assert(res_mgr->get_loaded_count() == 0); - printf(" ✓ Music data loaded: %u samples registered\n", g_tracker_samples_count); + printf(" ✓ Music data loaded: %u samples registered\n", + g_tracker_samples_count); engine.shutdown(); @@ -64,14 +64,12 @@ void test_audio_engine_manual_resource_loading() { engine.init(); // Load music data - engine.load_music_data(&g_tracker_score, - g_tracker_samples, - g_tracker_sample_assets, - g_tracker_samples_count); + engine.load_music_data(&g_tracker_score, g_tracker_samples, + g_tracker_sample_assets, g_tracker_samples_count); SpectrogramResourceManager* res_mgr = engine.get_resource_manager(); const int initial_loaded = res_mgr->get_loaded_count(); - assert(initial_loaded == 0); // No samples loaded yet + assert(initial_loaded == 0); // No samples loaded yet // Manually preload first few samples res_mgr->preload(0); @@ -80,7 +78,7 @@ void test_audio_engine_manual_resource_loading() { const int after_preload = res_mgr->get_loaded_count(); printf(" Samples loaded after manual preload: %d\n", after_preload); - assert(after_preload == 3); // Should have 3 samples loaded + assert(after_preload == 3); // Should have 3 samples loaded // Verify samples are accessible const Spectrogram* spec0 = res_mgr->get_spectrogram(0); @@ -103,10 +101,8 @@ void test_audio_engine_reset() { AudioEngine engine; engine.init(); - engine.load_music_data(&g_tracker_score, - g_tracker_samples, - g_tracker_sample_assets, - g_tracker_samples_count); + engine.load_music_data(&g_tracker_score, g_tracker_samples, + g_tracker_sample_assets, g_tracker_samples_count); SpectrogramResourceManager* res_mgr = engine.get_resource_manager(); @@ -143,10 +139,8 @@ void test_audio_engine_seeking() { AudioEngine engine; engine.init(); - engine.load_music_data(&g_tracker_score, - g_tracker_samples, - g_tracker_sample_assets, - g_tracker_samples_count); + engine.load_music_data(&g_tracker_score, g_tracker_samples, + g_tracker_sample_assets, g_tracker_samples_count); // Seek to t=5.0s engine.seek(5.0f); -- cgit v1.2.3