summaryrefslogtreecommitdiff
path: root/src/util/debug.h
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/util/debug.h
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/util/debug.h')
-rw-r--r--src/util/debug.h70
1 files changed, 35 insertions, 35 deletions
diff --git a/src/util/debug.h b/src/util/debug.h
index c247007..6272960 100644
--- a/src/util/debug.h
+++ b/src/util/debug.h
@@ -9,27 +9,27 @@
// All-or-nothing convenience macro (for pre-commit checks)
// This must be defined BEFORE the individual category checks
#if defined(DEBUG_LOG_ALL)
- #ifndef DEBUG_LOG_AUDIO
- #define DEBUG_LOG_AUDIO
- #endif
- #ifndef DEBUG_LOG_RING_BUFFER
- #define DEBUG_LOG_RING_BUFFER
- #endif
- #ifndef DEBUG_LOG_TRACKER
- #define DEBUG_LOG_TRACKER
- #endif
- #ifndef DEBUG_LOG_SYNTH
- #define DEBUG_LOG_SYNTH
- #endif
- #ifndef DEBUG_LOG_3D
- #define DEBUG_LOG_3D
- #endif
- #ifndef DEBUG_LOG_ASSETS
- #define DEBUG_LOG_ASSETS
- #endif
- #ifndef DEBUG_LOG_GPU
- #define DEBUG_LOG_GPU
- #endif
+#ifndef DEBUG_LOG_AUDIO
+#define DEBUG_LOG_AUDIO
+#endif
+#ifndef DEBUG_LOG_RING_BUFFER
+#define DEBUG_LOG_RING_BUFFER
+#endif
+#ifndef DEBUG_LOG_TRACKER
+#define DEBUG_LOG_TRACKER
+#endif
+#ifndef DEBUG_LOG_SYNTH
+#define DEBUG_LOG_SYNTH
+#endif
+#ifndef DEBUG_LOG_3D
+#define DEBUG_LOG_3D
+#endif
+#ifndef DEBUG_LOG_ASSETS
+#define DEBUG_LOG_ASSETS
+#endif
+#ifndef DEBUG_LOG_GPU
+#define DEBUG_LOG_GPU
+#endif
#endif /* defined(DEBUG_LOG_ALL) */
// Individual debug log category macros
@@ -37,49 +37,49 @@
// Audio subsystem debug logs
#if defined(DEBUG_LOG_AUDIO)
- #define DEBUG_AUDIO(...) fprintf(stderr, __VA_ARGS__)
+#define DEBUG_AUDIO(...) fprintf(stderr, __VA_ARGS__)
#else
- #define DEBUG_AUDIO(...) ((void)0)
+#define DEBUG_AUDIO(...) ((void)0)
#endif
// Ring buffer debug logs
#if defined(DEBUG_LOG_RING_BUFFER)
- #define DEBUG_RING_BUFFER(...) fprintf(stderr, __VA_ARGS__)
+#define DEBUG_RING_BUFFER(...) fprintf(stderr, __VA_ARGS__)
#else
- #define DEBUG_RING_BUFFER(...) ((void)0)
+#define DEBUG_RING_BUFFER(...) ((void)0)
#endif
// Tracker debug logs
#if defined(DEBUG_LOG_TRACKER)
- #define DEBUG_TRACKER(...) fprintf(stderr, __VA_ARGS__)
+#define DEBUG_TRACKER(...) fprintf(stderr, __VA_ARGS__)
#else
- #define DEBUG_TRACKER(...) ((void)0)
+#define DEBUG_TRACKER(...) ((void)0)
#endif
// Synth debug logs
#if defined(DEBUG_LOG_SYNTH)
- #define DEBUG_SYNTH(...) fprintf(stderr, __VA_ARGS__)
+#define DEBUG_SYNTH(...) fprintf(stderr, __VA_ARGS__)
#else
- #define DEBUG_SYNTH(...) ((void)0)
+#define DEBUG_SYNTH(...) ((void)0)
#endif
// 3D rendering debug logs
#if defined(DEBUG_LOG_3D)
- #define DEBUG_3D(...) fprintf(stderr, __VA_ARGS__)
+#define DEBUG_3D(...) fprintf(stderr, __VA_ARGS__)
#else
- #define DEBUG_3D(...) ((void)0)
+#define DEBUG_3D(...) ((void)0)
#endif
// Asset system debug logs
#if defined(DEBUG_LOG_ASSETS)
- #define DEBUG_ASSETS(...) fprintf(stderr, __VA_ARGS__)
+#define DEBUG_ASSETS(...) fprintf(stderr, __VA_ARGS__)
#else
- #define DEBUG_ASSETS(...) ((void)0)
+#define DEBUG_ASSETS(...) ((void)0)
#endif
// GPU/WebGPU debug logs
#if defined(DEBUG_LOG_GPU)
- #define DEBUG_GPU(...) fprintf(stderr, __VA_ARGS__)
+#define DEBUG_GPU(...) fprintf(stderr, __VA_ARGS__)
#else
- #define DEBUG_GPU(...) ((void)0)
+#define DEBUG_GPU(...) ((void)0)
#endif