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/spectrogram_resource_manager.cc | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) (limited to 'src/audio/spectrogram_resource_manager.cc') diff --git a/src/audio/spectrogram_resource_manager.cc b/src/audio/spectrogram_resource_manager.cc index dbed09e..30939e0 100644 --- a/src/audio/spectrogram_resource_manager.cc +++ b/src/audio/spectrogram_resource_manager.cc @@ -42,7 +42,8 @@ void SpectrogramResourceManager::reset() { loaded_count_ = 0; } -void SpectrogramResourceManager::register_asset(int sample_id, AssetId asset_id) { +void SpectrogramResourceManager::register_asset(int sample_id, + AssetId asset_id) { if (sample_id < 0 || sample_id >= MAX_SPECTROGRAM_RESOURCES) { return; } @@ -57,13 +58,14 @@ void SpectrogramResourceManager::register_asset(int sample_id, AssetId asset_id) #endif } -void SpectrogramResourceManager::register_procedural(int sample_id, const NoteParams& params) { +void SpectrogramResourceManager::register_procedural(int sample_id, + const NoteParams& params) { if (sample_id < 0 || sample_id >= MAX_SPECTROGRAM_RESOURCES) { return; } Resource& resource = resources_[sample_id]; - resource.asset_id = AssetId::ASSET_LAST_ID; // Mark as procedural + resource.asset_id = AssetId::ASSET_LAST_ID; // Mark as procedural resource.proc_params = params; resource.state = REGISTERED; @@ -83,7 +85,7 @@ const Spectrogram* SpectrogramResourceManager::get_or_load(int sample_id) { // Already loaded? if (resource.state == LOADED) { #if defined(DEMO_ENABLE_CACHE_EVICTION) - resource.last_access_time = 0.0f; // TODO: Get actual time + resource.last_access_time = 0.0f; // TODO: Get actual time #endif return &resource.spec; } @@ -113,7 +115,8 @@ void SpectrogramResourceManager::preload_range(int start_id, int end_id) { } } -const Spectrogram* SpectrogramResourceManager::get_spectrogram(int sample_id) const { +const Spectrogram* +SpectrogramResourceManager::get_spectrogram(int sample_id) const { if (sample_id < 0 || sample_id >= MAX_SPECTROGRAM_RESOURCES) { return nullptr; } @@ -164,7 +167,8 @@ void SpectrogramResourceManager::try_evict_lru(float current_time) { float oldest_time = current_time; for (int i = 0; i < MAX_SPECTROGRAM_RESOURCES; ++i) { - if (resources_[i].state == LOADED && resources_[i].last_access_time < oldest_time) { + if (resources_[i].state == LOADED && + resources_[i].last_access_time < oldest_time) { oldest_time = resources_[i].last_access_time; lru_id = i; } @@ -183,7 +187,8 @@ void SpectrogramResourceManager::load_asset(Resource* resource) { if (data == nullptr || size < sizeof(SpecHeader)) { #if defined(DEBUG_LOG_ASSETS) - DEBUG_ASSETS("[ResourceMgr ERROR] Failed to load asset %d\n", (int)resource->asset_id); + DEBUG_ASSETS("[ResourceMgr ERROR] Failed to load asset %d\n", + (int)resource->asset_id); #endif return; } @@ -194,7 +199,7 @@ void SpectrogramResourceManager::load_asset(Resource* resource) { resource->spec.spectral_data_a = spectral_data; resource->spec.spectral_data_b = spectral_data; resource->spec.num_frames = header->num_frames; - resource->owned_data = nullptr; // Asset data is not owned + resource->owned_data = nullptr; // Asset data is not owned #if defined(DEBUG_LOG_ASSETS) DEBUG_ASSETS("[ResourceMgr] Loaded asset %d: %d frames\n", @@ -204,7 +209,8 @@ void SpectrogramResourceManager::load_asset(Resource* resource) { void SpectrogramResourceManager::load_procedural(Resource* resource) { int note_frames = 0; - std::vector note_data = generate_note_spectrogram(resource->proc_params, ¬e_frames); + std::vector note_data = + generate_note_spectrogram(resource->proc_params, ¬e_frames); if (note_frames <= 0 || note_data.empty()) { #if defined(DEBUG_LOG_ASSETS) @@ -215,7 +221,8 @@ void SpectrogramResourceManager::load_procedural(Resource* resource) { // Allocate persistent storage resource->owned_data = new float[note_data.size()]; - memcpy(resource->owned_data, note_data.data(), note_data.size() * sizeof(float)); + memcpy(resource->owned_data, note_data.data(), + note_data.size() * sizeof(float)); resource->spec.spectral_data_a = resource->owned_data; resource->spec.spectral_data_b = resource->owned_data; -- cgit v1.2.3