midi-controller 0.3.0

Generic MIDI controller engine: button/encoder input processing, LED rendering, preset management, and MIDI-CI Property Exchange framing. #![no_std] compatible.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
//! LED ring renderer: spatial patterns + temporal modifiers.
//!
//! Design: the SK6812 LEDs handle brightness natively via RGB values.
//! The renderer produces a 12-pixel frame, then the modifier attenuates it per tick.

use serde::{Deserialize, Serialize};

pub const LEDS_PER_RING: usize = 12;
pub type RingFrame = [Rgb; LEDS_PER_RING];

/// RGB color (matches smart_leds::RGB8 layout).
#[derive(Debug, Copy, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct Rgb {
    pub r: u8,
    pub g: u8,
    pub b: u8,
}

impl Rgb {
    pub const fn new(r: u8, g: u8, b: u8) -> Self {
        Self { r, g, b }
    }

    pub const BLACK: Self = Self::new(0, 0, 0);

    /// Scale brightness by factor 0..=255 (255 = full).
    pub fn scale(self, factor: u8) -> Self {
        Self {
            r: ((self.r as u16 * factor as u16) / 255) as u8,
            g: ((self.g as u16 * factor as u16) / 255) as u8,
            b: ((self.b as u16 * factor as u16) / 255) as u8,
        }
    }
}

/// Spatial pattern — which LEDs are lit and what color.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum Renderer {
    Off,
    /// All 12 LEDs same color.
    Solid(Rgb),
    /// Arc from rotation anchor, `count` LEDs lit (0–12).
    Fill(Rgb, u8),
    /// Potentiometer arc (7h→5h), blue→green→red. `fill` = 0–12.
    Heatmap(u8),
    /// Single LED at clock position (0–11).
    Single(Rgb, u8),
    /// N evenly-spaced LEDs (1,2,3,4,6,12).
    Dots(Rgb, u8),
}

/// Temporal modifier — how rendered pixels change over time.
#[derive(Debug, Copy, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub enum Modifier {
    /// No modulation, full brightness.
    #[default]
    Solid,
    /// Static dim (1/4 intensity) — "available but inactive".
    Glow,
    /// On/off toggle at ~4Hz.
    Blink,
    /// Sine-wave fade, period ~1.5s.
    Pulse,
    /// Rotate pattern clockwise, one step per ~100ms.
    Rotate,
    /// Cycle hue over time (ignores original color, keeps lit/unlit pattern).
    ColorCycle,
}

/// Complete ring animation state.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RingAnimation {
    pub renderer: Renderer,
    pub modifier: Modifier,
}

impl Default for RingAnimation {
    fn default() -> Self {
        Self {
            renderer: Renderer::Off,
            modifier: Modifier::Solid,
        }
    }
}

impl RingAnimation {
    pub const fn off() -> Self {
        Self {
            renderer: Renderer::Off,
            modifier: Modifier::Solid,
        }
    }

    pub const fn solid(color: Rgb) -> Self {
        Self {
            renderer: Renderer::Solid(color),
            modifier: Modifier::Solid,
        }
    }

    pub const fn glow(color: Rgb) -> Self {
        Self {
            renderer: Renderer::Solid(color),
            modifier: Modifier::Glow,
        }
    }
}

/// Stateful ring that tracks animation state.
#[derive(Copy, Clone)]
pub struct LedRing {
    pub animation: RingAnimation,
    rotation: u8,
}

impl LedRing {
    pub const fn new(rotation: u8) -> Self {
        Self {
            animation: RingAnimation {
                renderer: Renderer::Off,
                modifier: Modifier::Solid,
            },
            rotation,
        }
    }

    pub fn set(&mut self, anim: RingAnimation) {
        self.animation = anim;
    }

    /// Render current frame using a global tick (shared across all rings).
    pub fn render(&self, tick: u16) -> RingFrame {
        let base = self.render_spatial();
        self.apply_modifier(base, tick)
    }

    fn render_spatial(&self) -> RingFrame {
        match self.animation.renderer {
            Renderer::Off => [Rgb::BLACK; LEDS_PER_RING],
            Renderer::Solid(c) => [c; LEDS_PER_RING],
            Renderer::Fill(c, count) => {
                let mut frame = [Rgb::BLACK; LEDS_PER_RING];
                for i in 0..(count as usize).min(LEDS_PER_RING) {
                    frame[(self.rotation as usize + LEDS_PER_RING - i) % LEDS_PER_RING] = c;
                }
                frame
            }
            Renderer::Heatmap(fill) => {
                const ARC_HOURS: [usize; 11] = [7, 8, 9, 10, 11, 0, 1, 2, 3, 4, 5];
                let mut frame = [Rgb::BLACK; LEDS_PER_RING];
                let lit = ((fill as usize) * ARC_HOURS.len() / 12).min(ARC_HOURS.len());
                for i in 0..lit {
                    frame[CLOCK[ARC_HOURS[i]]] = heatmap_color(i, ARC_HOURS.len());
                }
                frame
            }
            Renderer::Single(c, pos) => {
                let mut frame = [Rgb::BLACK; LEDS_PER_RING];
                let p = (pos as usize) % 12;
                frame[CLOCK[p]] = c;
                frame[CLOCK[(p + 11) % 12]] = c; // neighbor left
                frame[CLOCK[(p + 1) % 12]] = c; // neighbor right
                frame
            }
            Renderer::Dots(c, count) => {
                let mut frame = [Rgb::BLACK; LEDS_PER_RING];
                let n = (count as usize).clamp(1, 12);
                let spacing = LEDS_PER_RING / n;
                for i in 0..n {
                    frame[CLOCK[(i * spacing) % 12]] = c;
                }
                frame
            }
        }
    }

    fn apply_modifier(&self, mut frame: RingFrame, tick: u16) -> RingFrame {
        match self.animation.modifier {
            Modifier::Solid => frame,
            Modifier::Glow => {
                for px in frame.iter_mut() {
                    *px = px.scale(32); // 1/8 brightness, preserves spatial pattern
                }
                frame
            }
            Modifier::Blink => {
                // Toggle every 25 ticks (0.5s at 50Hz, or 1 beat at 24ppqn BPM)
                if (tick / 25) % 2 == 1 {
                    [Rgb::BLACK; LEDS_PER_RING]
                } else {
                    frame
                }
            }
            Modifier::Pulse => {
                // Smooth version of blink: bright during ON phase, dark during OFF
                // Same boundaries as blink: period 50, first half = bright, second = dark
                let pos = tick % 50;
                let factor = sine_u8(pos, 50);
                for px in &mut frame {
                    *px = px.scale(factor);
                }
                frame
            }
            Modifier::Rotate => {
                // One step every 25 ticks (0.5s, or 1 beat)
                let shift = (tick / 25) as usize % LEDS_PER_RING;
                let mut rotated = [Rgb::BLACK; LEDS_PER_RING];
                for i in 0..LEDS_PER_RING {
                    rotated[(i + shift) % LEDS_PER_RING] = frame[i];
                }
                rotated
            }
            Modifier::ColorCycle => {
                let hue = (tick * 3) as u8;
                let color = hue_to_rgb(hue);
                for px in frame.iter_mut() {
                    if *px != Rgb::BLACK {
                        *px = color;
                    }
                }
                frame
            }
        }
    }
}

impl Default for LedRing {
    fn default() -> Self {
        Self::new(8)
    }
}

// --- Lookup tables ---

/// Physical LED index for each clock-hour position.
/// PCB layout: D1=3h, D2=2h, ..., D12=4h. 0-based.
const CLOCK: [usize; 12] = [
    3,  //  0: 12h
    2,  //  1:  1h
    1,  //  2:  2h
    0,  //  3:  3h
    11, //  4:  4h
    10, //  5:  5h
    9,  //  6:  6h
    8,  //  7:  7h
    7,  //  8:  8h
    6,  //  9:  9h
    5,  // 10: 10h
    4,  // 11: 11h
];

/// Blue (0) → Green (mid) → Red (max-1)
fn heatmap_color(pos: usize, max: usize) -> Rgb {
    if max <= 1 {
        return Rgb::new(0, 0, 255);
    }
    let t = (pos * 255) / (max - 1);
    if t < 128 {
        let g = (t * 2) as u8;
        Rgb::new(0, g, 255 - g)
    } else {
        let r = ((t - 128) * 2) as u8;
        Rgb::new(r, 255 - r, 0)
    }
}

/// HSV hue (0–255) to RGB at full saturation/value.
fn hue_to_rgb(h: u8) -> Rgb {
    let region = h / 43;
    let remainder = (h % 43) * 6;
    match region {
        0 => Rgb::new(255, remainder, 0),
        1 => Rgb::new(255 - remainder, 255, 0),
        2 => Rgb::new(0, 255, remainder),
        3 => Rgb::new(0, 255 - remainder, 255),
        4 => Rgb::new(remainder, 0, 255),
        _ => Rgb::new(255, 0, 255 - remainder),
    }
}

/// Half-sine: 0 → 255 → 0 over one period. Peak at period/2.
fn sine_u8(phase: u16, period: u16) -> u8 {
    const TABLE: [u8; 16] = [
        0, 25, 50, 74, 98, 120, 142, 162, 180, 197, 213, 226, 237, 245, 251, 255,
    ];
    let pos = phase % period;
    let half = period / 2;
    // Distance from peak (0 at peak, half at edges)
    let dist = half.abs_diff(pos);
    // Map dist (0..half) to table index (15..0)
    let idx = ((half - dist) as usize * 15) / half.max(1) as usize;
    TABLE[idx.min(15)]
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn off_renders_black() {
        let ring = LedRing::default();
        let frame = ring.render(0);
        assert!(frame.iter().all(|px| *px == Rgb::BLACK));
    }

    #[test]
    fn solid_renders_all_same() {
        let mut ring = LedRing::default();
        let c = Rgb::new(255, 0, 0);
        ring.set(RingAnimation::solid(c));
        let frame = ring.render(0);
        assert!(frame.iter().all(|px| *px == c));
    }

    #[test]
    fn glow_dims_uniformly() {
        let mut ring = LedRing::default();
        ring.set(RingAnimation::glow(Rgb::new(255, 255, 255)));
        let frame = ring.render(0);
        // All LEDs dimmed uniformly to 1/8
        assert!(frame
            .iter()
            .all(|px| px.r == 32 && px.g == 32 && px.b == 32));
    }

    #[test]
    fn blink_alternates() {
        let mut ring = LedRing::default();
        let c = Rgb::new(255, 0, 0);
        ring.set(RingAnimation {
            renderer: Renderer::Solid(c),
            modifier: Modifier::Blink,
        });
        // tick 0: on
        assert!(ring.render(0).iter().all(|px| *px == c));
        // tick 25: off
        assert!(ring.render(25).iter().all(|px| *px == Rgb::BLACK));
    }

    #[test]
    fn wings_2_lights_opposing() {
        let mut ring = LedRing::default();
        let c = Rgb::new(0, 255, 0);
        ring.set(RingAnimation {
            renderer: Renderer::Dots(c, 2),
            modifier: Modifier::Solid,
        });
        let frame = ring.render(0);
        let lit = frame.iter().filter(|px| **px != Rgb::BLACK).count();
        assert_eq!(lit, 2);
    }

    #[test]
    fn wings_3_lights_three() {
        let mut ring = LedRing::default();
        ring.set(RingAnimation {
            renderer: Renderer::Dots(Rgb::new(0, 0, 255), 3),
            modifier: Modifier::Solid,
        });
        let frame = ring.render(0);
        let lit = frame.iter().filter(|px| **px != Rgb::BLACK).count();
        assert_eq!(lit, 3);
    }

    #[test]
    fn heatmap_full_lights_11() {
        let mut ring = LedRing::default();
        ring.set(RingAnimation {
            renderer: Renderer::Heatmap(12),
            modifier: Modifier::Solid,
        });
        let frame = ring.render(0);
        let lit = frame.iter().filter(|px| **px != Rgb::BLACK).count();
        assert_eq!(lit, 11);
    }

    #[test]
    fn rotate_shifts_single() {
        let mut ring = LedRing::default();
        let c = Rgb::new(255, 255, 0);
        ring.set(RingAnimation {
            renderer: Renderer::Single(c, 0),
            modifier: Modifier::Rotate,
        });
        let f0 = ring.render(0);
        let f1 = ring.render(25);
        // Pattern should have shifted
        assert_ne!(f0, f1);
    }

    #[test]
    fn pulse_starts_dim() {
        let mut ring = LedRing::default();
        ring.set(RingAnimation {
            renderer: Renderer::Solid(Rgb::new(255, 255, 255)),
            modifier: Modifier::Pulse,
        });
        // tick=0, phase=0 → sine at edge, should be dim
        let frame = ring.render(0);
        assert!(frame[0].r < 30);
    }

    #[test]
    #[test]
    fn scale_zero_is_black() {
        assert_eq!(Rgb::new(255, 128, 64).scale(0), Rgb::BLACK);
    }

    #[test]
    fn scale_255_is_identity() {
        let c = Rgb::new(200, 100, 50);
        assert_eq!(c.scale(255), c);
    }

    #[test]
    fn struct_sizes() {
        assert_eq!(core::mem::size_of::<Rgb>(), 3);
        assert_eq!(core::mem::size_of::<RingAnimation>(), 6);
        assert!(core::mem::size_of::<LedRing>() <= 8);
    }
}