You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update to v1.2.0 - Complete microtonality system implementation
- Update project status from v1.1 A- to v1.2 A Grade
- Update test count from 25 to 31 comprehensive tests
- Document completed microtonality system:
- Global detune with cent-based precision (±200¢)
- Alternative tuning systems: 19-TET, 24-TET, 31-TET
- Keyboard controls: comma/period/slash keys for detune
- Scale selection: 8/9/0 keys for alternative tunings
- Restructure S-Tier roadmap with 3D Interactive UI as next priority
- Add comprehensive microtonality controls documentation
- Mark microtonality achievements in all documentation files
<ahref='https://ko-fi.com/N4N31DPNUS'target='_blank'><imgheight='36'style='border:0px;height:36px;'src='https://storage.ko-fi.com/cdn/kofi2.png?v=6'border='0'alt='Buy Me a Coffee at ko-fi.com' /></a>
9
9
<hr />
10
10
</div>
11
11
12
-
### Project Status (v1.1 - A- Grade)
12
+
### Project Status (v1.2 - A Grade)
13
13
14
14
**🎵 Advanced Audio Engine:**
15
15
16
16
- 3-voice polyphonic system with configurable parameters (trigger probability, octave offset, duration)
17
17
- Complete musical alphabet support (A-G keys) with 7 diatonic modes (1-7 keys)
18
+
-**Microtonality system**: global detune (±200¢), alternative tuning systems (19-TET, 24-TET, 31-TET)
18
19
- Professional spatial audio: per-voice `PannerNode` with real-time 3D positioning
Copy file name to clipboardExpand all lines: docs/SPEC.md
+31-18Lines changed: 31 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,13 @@ This project is an **interactive generative music visualizer** built with Rust,
6
6
7
7
Users can **influence and interact** with the generative music without manually composing it. The interface is subtle and minimalistic – a hint overlay shows status and keys; primary controls are embedded in-scene and via keyboard. The primary target platform is **desktop web browsers** supporting WebGPU (no WebGL fallback by design). Mobile is not a focus.
8
8
9
-
### Current Capabilities (v1.1 - A- Grade)
9
+
### Current Capabilities (v1.2 - A Grade)
10
10
11
11
**Core Audio System:**
12
12
13
13
- 3 generative voices (sine/saw/triangle) with configurable parameters (trigger probability, octave offset, base duration)
-**Position Adjustment:** Click+drag on a voice's invisible interaction zone to move it on the horizontal plane; movement is clamped to a radius. Positions update the corresponding `PannerNode` in real time.
338
341
-**Tempo:** ArrowRight/ArrowLeft adjust BPM.
339
-
-**Overlay:** Start overlay for audio unlock; `H` toggles visibility. It does not show live BPM/Paused/Muted state.
342
+
-**Overlay:** Start overlay for audio unlock; `H` toggles visibility. Shows live BPM, detune, and scale information.
340
343
341
344
**Possible UI Elements/Controls (future):**
342
345
We identify additional interactions that could be mapped to in-scene controls:
@@ -386,7 +389,7 @@ We identify additional interactions that could be mapped to in-scene controls:
386
389
387
390
## Development Status and S-Tier Roadmap
388
391
389
-
### ✅ **Completed Development Phases (v1.1 - A- Grade)**
392
+
### ✅ **Completed Development Phases (v1.2 - A Grade)**
390
393
391
394
1.**✅ Initial Setup & Infrastructure**
392
395
@@ -420,30 +423,39 @@ We identify additional interactions that could be mapped to in-scene controls:
420
423
- Start overlay for audio gesture unlock with professional styling
421
424
422
425
5.**✅ Quality Assurance & Testing**
423
-
- 25 comprehensive tests including property-based testing for mathematical functions
426
+
427
+
- 31 comprehensive tests including property-based testing for mathematical functions
424
428
- Enhanced browser testing with performance validation and keyboard interaction simulation
425
429
- Zero compilation warnings with strict linting (clippy -D warnings)
426
430
- Professional error handling and graceful WebGPU fallback behavior
427
431
- Automated formatting and comprehensive code documentation
428
432
429
-
### 🚀 **S-Tier Development Roadmap**
430
-
431
-
**Phase S1: Microtonality System (Next Priority)**
433
+
6.**✅ Microtonality System Implementation**
434
+
- Global microtonal detune system with cent-based precision (±200¢ range)
435
+
- Alternative tuning systems: 19-TET, 24-TET, 31-TET pentatonic scales
436
+
- Comprehensive keyboard controls: `,``.``/` keys for detune adjustment with fine/coarse modes
437
+
- Scale selection shortcuts: `8``9``0` keys for alternative tuning systems
438
+
- Real-time visual feedback in hint overlay showing current detune and tuning system
432
439
433
-
- Global microtonal detune system with cent-based precision
434
-
- Alternative tuning systems: 19-TET, 24-TET, 31-TET, Just Intonation
435
-
- Keyboard controls: `,``.``/` keys for detune adjustment with fine/coarse modes
436
-
- Scale selection shortcuts: `8``9``0` keys for alternative tuning systems
437
-
- Visual feedback in hint overlay showing current detune and tuning system
440
+
### 🚀 **S-Tier Development Roadmap**
438
441
439
-
**Phase S2: 3D Interactive UI Revolution**
442
+
**Phase S1: 3D Interactive UI Revolution (Next Priority)**
440
443
441
444
- Replace keyboard shortcuts with immersive 3D scene objects
442
445
- Floating control orbs: play/pause sphere, tempo dial, regenerate button
443
446
- Advanced spatial mixing interface with visual voice objects
- AudioWorklet implementation for sample-accurate timing
455
+
- Modular architecture with pipeline builders and comprehensive API documentation
456
+
- Advanced memory management and GPU buffer reuse optimization
457
+
- Professional hover effects, click animations, and state indicators
458
+
447
459
**Phase S3: Advanced Architecture & Performance**
448
460
449
461
- Strong typing with newtypes: `MidiNote`, `Frequency`, `Cents`, `BPM`
@@ -472,11 +484,12 @@ We identify additional interactions that could be mapped to in-scene controls:
472
484
473
485
This specification documents the evolution of an interactive 3D music visualizer from its initial concept to its current **A-** grade implementation and future **S-tier** vision. Built with Rust, WebAssembly, and WebGPU, the project demonstrates cutting-edge web technologies applied to creative audio-visual applications.
474
486
475
-
### **Current Achievement (v1.1 - A- Grade)**
487
+
### **Current Achievement (v1.2 - A Grade)**
476
488
477
489
The project has successfully implemented a sophisticated generative music system with:
Copy file name to clipboardExpand all lines: docs/TODO.md
+53-53Lines changed: 53 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Project TODO and S-Tier Roadmap
2
2
3
-
This document outlines the path from the current **A-** grade to **S-tier** status. Tasks are prioritized by impact and organized into clear milestones.
3
+
This document outlines the path from the current **A** grade to **S-tier** status. Tasks are prioritized by impact and organized into clear milestones.
4
4
5
-
## 🏆 **Current Status: A- Grade**
5
+
## 🏆 **Current Status: A Grade**
6
6
7
7
### ✅ **Completed (Recent Improvements)**
8
8
@@ -12,53 +12,21 @@ This document outlines the path from the current **A-** grade to **S-tier** stat
12
12
-[x] Property-based testing for mathematical functions
13
13
-[x] Improved WebGPU error handling with user feedback
14
14
-[x] Comprehensive shader documentation
15
-
-[x] 31 tests passing with zero warnings
15
+
-[x] 31 comprehensive tests including property-based testing for mathematical functions
16
+
-[x]**COMPLETED: Full microtonality system implementation**
17
+
-[x] Global detune system with cent-based precision (±200¢)
18
+
-[x] Alternative tuning systems: 19-TET, 24-TET, 31-TET pentatonic scales
19
+
-[x] Keyboard controls: `,``.``/` keys for detune with fine/coarse adjustment
20
+
-[x] Scale selection: `8``9``0` keys for alternative tuning systems
21
+
-[x] Real-time visual feedback in hint overlay
16
22
17
23
---
18
24
19
25
## 🚀 **S-Tier Roadmap: Core Features**
20
26
21
-
### **Phase 1: Microtonality System (HIGH IMPACT - Makes project unique)**
22
-
23
-
#### 1.1 Foundation
24
-
25
-
-[x]**Add microtonal detune support**
26
-
-[x] Add `detune_cents: f32` to `EngineParams` (default 0.0, range ±200¢)
27
-
-[x] Update `midi_to_hz()` to accept fractional MIDI values for cent precision
0 commit comments