rill-lofi 0.5.0

Lo-fi audio emulation: 8-bit, 12-bit, NES, AY-3-8910, Akai S900
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
#[derive(Clone)]
struct NesPulseChannel {
    duty_cycle: f32,
    frequency: f32,
    volume: f32,
    phase: f32,
    enabled: bool,
}

#[derive(Clone)]
struct NesTriangleChannel {
    frequency: f32,
    volume: f32,
    phase: f32,
    linear_counter: u8,
    enabled: bool,
}

struct NesNoiseChannel {
    mode: NoiseMode,
    frequency: f32,
    volume: f32,
    shift_register: u16,
    tick_counter: f32,
    enabled: bool,
}

#[derive(Clone)]
struct NesDpcmChannel {
    sample_rate: f32,
    delta: f32,
    sample_buffer: Vec<i8>,
    position: usize,
    current_output: f32,
    tick_counter: f32,
    enabled: bool,
}

#[derive(Debug, Clone, Copy)]
enum NoiseMode {
    Short,
    Long,
}

/// NES 2A03 APU sweep unit for pulse channels.
///
/// Modifies the channel's period at a configurable rate and direction.
/// Clocked at ~120 Hz. Can mute the channel when the period underflows
/// or exceeds 11 bits.
struct NesSweepUnit {
    enabled: bool,
    reload: bool,
    divider_period: u8,
    divider_counter: u8,
    negate: bool,
    shift: u8,
    target_period: u16,
}

impl NesSweepUnit {
    fn new() -> Self {
        Self {
            enabled: false,
            reload: false,
            divider_period: 0,
            divider_counter: 0,
            negate: false,
            shift: 0,
            target_period: 0,
        }
    }

    fn write_register(&mut self, value: u8) {
        self.enabled = (value & 0x80) != 0;
        self.divider_period = (value >> 4) & 0x07;
        self.negate = (value & 0x08) != 0;
        self.shift = value & 0x07;
        self.reload = true;
    }

    fn set_target_period(&mut self, period: u16) {
        self.target_period = period & 0x07FF;
    }

    /// Clock the sweep unit. Returns the current period,
    /// or `None` if the channel should be silenced.
    fn clock(&mut self) -> Option<u16> {
        if self.divider_period == 0 && !self.reload {
            return Some(self.target_period);
        }
        if self.reload {
            self.divider_counter = self.divider_period;
            self.reload = false;
        }
        if self.divider_counter > 0 {
            self.divider_counter -= 1;
        }
        if self.divider_counter == 0 && self.divider_period > 0 {
            let delta = self.target_period >> self.shift as u32;
            let new = if self.negate {
                self.target_period.saturating_sub(delta + 1)
            } else {
                self.target_period + delta
            };
            if !(8..=0x07FF).contains(&new) {
                return None;
            }
            self.target_period = new;
            self.divider_counter = self.divider_period;
        }
        Some(self.target_period)
    }
}

/// Pure NES 2A03 APU chip emulation logic.
///
/// No graph node, no lofi processing. Directly testable.
/// Registers are memory-mapped at $4000–$4015 (22 bytes).
pub struct NesChip {
    pulse1: NesPulseChannel,
    pulse2: NesPulseChannel,
    triangle: NesTriangleChannel,
    noise: NesNoiseChannel,
    dpcm: NesDpcmChannel,
    sweep1: NesSweepUnit,
    sweep2: NesSweepUnit,
    sweep_phase: f32,
}

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

impl NesChip {
    /// Create with default power-on state.
    pub fn new() -> Self {
        Self {
            pulse1: NesPulseChannel {
                duty_cycle: 0.25,
                frequency: 440.0,
                volume: 0.5,
                phase: 0.0,
                enabled: true,
            },
            pulse2: NesPulseChannel {
                duty_cycle: 0.125,
                frequency: 660.0,
                volume: 0.3,
                phase: 0.0,
                enabled: true,
            },
            triangle: NesTriangleChannel {
                frequency: 220.0,
                volume: 0.4,
                phase: 0.0,
                linear_counter: 0,
                enabled: true,
            },
            noise: NesNoiseChannel {
                mode: NoiseMode::Short,
                frequency: 1000.0,
                volume: 0.2,
                shift_register: 1,
                tick_counter: 0.0,
                enabled: true,
            },
            dpcm: NesDpcmChannel {
                sample_rate: 22050.0,
                delta: 0.01,
                sample_buffer: Vec::new(),
                position: 0,
                current_output: 0.0,
                tick_counter: 0.0,
                enabled: false,
            },
            sweep1: NesSweepUnit::new(),
            sweep2: NesSweepUnit::new(),
            sweep_phase: 0.0,
        }
    }

    /// Write register data. `regs` must be 22 bytes ($4000–$4015).
    pub fn write_registers(&mut self, regs: &[u8]) {
        if regs.len() < 22 {
            return;
        }

        let duty_table: [f32; 4] = [0.125, 0.25, 0.5, 0.75];

        // Pulse 1 ($4000–$4003)
        self.pulse1.duty_cycle = duty_table[((regs[0] >> 6) & 0x03) as usize];
        self.pulse1.volume = (regs[0] & 0x0F) as f32 / 15.0;
        let p1_period = (regs[2] as u16) | (((regs[3] as u16) & 0x07) << 8);
        self.pulse1.frequency = if p1_period > 0 {
            1_789_773.0 / (16.0 * (p1_period + 1) as f32)
        } else {
            0.0
        };
        self.sweep1.write_register(regs[1]);
        self.sweep1.set_target_period(p1_period);

        // Pulse 2 ($4004–$4007)
        self.pulse2.duty_cycle = duty_table[((regs[4] >> 6) & 0x03) as usize];
        self.pulse2.volume = (regs[4] & 0x0F) as f32 / 15.0;
        let p2_period = (regs[6] as u16) | (((regs[7] as u16) & 0x07) << 8);
        self.pulse2.frequency = if p2_period > 0 {
            1_789_773.0 / (16.0 * (p2_period + 1) as f32)
        } else {
            0.0
        };
        self.sweep2.write_register(regs[5]);
        self.sweep2.set_target_period(p2_period);

        // Triangle ($4008–$400B)
        self.triangle.volume = if (regs[8] & 0x80) != 0 { 0.4 } else { 0.0 };
        self.triangle.linear_counter = regs[8] & 0x7F;
        let tri_period = (regs[10] as u16) | (((regs[11] as u16) & 0x07) << 8);
        self.triangle.frequency = if tri_period > 0 {
            1_789_773.0 / (32.0 * (tri_period + 1) as f32)
        } else {
            0.0
        };

        // Noise ($400C–$400F)
        self.noise.mode = if (regs[12] & 0x80) != 0 {
            NoiseMode::Short
        } else {
            NoiseMode::Long
        };
        self.noise.volume = (regs[12] & 0x0F) as f32 / 15.0;
        let noise_period_idx = regs[14] & 0x0F;
        let noise_periods: [u16; 16] = [
            4, 8, 16, 32, 64, 96, 128, 160, 202, 254, 380, 508, 762, 1016, 2034, 4068,
        ];
        self.noise.frequency = 1_789_773.0 / noise_periods[noise_period_idx as usize] as f32;

        // Channel enable ($4015)
        let enable = regs[21];
        self.pulse1.enabled = (enable & 0x01) != 0;
        self.pulse2.enabled = (enable & 0x02) != 0;
        self.triangle.enabled = (enable & 0x04) != 0;
        self.noise.enabled = (enable & 0x08) != 0;
        self.dpcm.enabled = (enable & 0x10) != 0;
    }

    /// Generate one audio sample. `sample_rate` is the output sample rate.
    pub fn generate_sample(&mut self, sample_rate: f32) -> f32 {
        // Sweep clock at ~120 Hz
        self.sweep_phase += 120.0 / sample_rate;
        while self.sweep_phase >= 1.0 {
            self.sweep_phase -= 1.0;

            let p1 = self.sweep1.clock();
            if let Some(period) = p1 {
                self.pulse1.frequency = if period > 0 {
                    1_789_773.0 / (16.0 * (period + 1) as f32)
                } else {
                    0.0
                };
            } else {
                self.pulse1.enabled = false;
            }

            let p2 = self.sweep2.clock();
            if let Some(period) = p2 {
                self.pulse2.frequency = if period > 0 {
                    1_789_773.0 / (16.0 * (period + 1) as f32)
                } else {
                    0.0
                };
            } else {
                self.pulse2.enabled = false;
            }
        }

        // Pulse 1
        let p1 = if self.pulse1.frequency > 0.0 && self.pulse1.enabled {
            self.pulse1.phase += self.pulse1.frequency / sample_rate;
            if self.pulse1.phase >= 1.0 {
                self.pulse1.phase -= 1.0;
            }
            (if self.pulse1.phase < self.pulse1.duty_cycle {
                1.0
            } else {
                -1.0
            }) * self.pulse1.volume
        } else {
            0.0
        };

        // Pulse 2
        let p2 = if self.pulse2.frequency > 0.0 && self.pulse2.enabled {
            self.pulse2.phase += self.pulse2.frequency / sample_rate;
            if self.pulse2.phase >= 1.0 {
                self.pulse2.phase -= 1.0;
            }
            (if self.pulse2.phase < self.pulse2.duty_cycle {
                1.0
            } else {
                -1.0
            }) * self.pulse2.volume
        } else {
            0.0
        };

        // Triangle
        let tri = if self.triangle.frequency > 0.0 && self.triangle.enabled {
            self.triangle.phase += self.triangle.frequency / sample_rate;
            if self.triangle.phase >= 1.0 {
                self.triangle.phase -= 1.0;
            }
            (if self.triangle.phase < 0.5 {
                self.triangle.phase * 4.0 - 1.0
            } else {
                3.0 - self.triangle.phase * 4.0
            }) * self.triangle.volume
        } else {
            0.0
        };

        // Noise
        let ns = if self.noise.enabled {
            self.generate_noise(sample_rate)
        } else {
            0.0
        };

        // DPCM
        let dpcm = if self.dpcm.enabled {
            self.generate_dpcm(sample_rate)
        } else {
            0.0
        };

        let pulse_mix = (p1 + p2) * 0.5;
        let tnd_mix = (tri * 3.0 + ns * 2.0 + dpcm) / 6.0;
        (pulse_mix * 0.5 + tnd_mix * 0.5) * 0.5
    }

    /// Reset all channels and sweep units to initial state.
    pub fn reset(&mut self) {
        self.pulse1.phase = 0.0;
        self.pulse2.phase = 0.0;
        self.triangle.phase = 0.0;
        self.noise.shift_register = 1;
        self.noise.tick_counter = 0.0;
        self.dpcm.position = 0;
        self.dpcm.current_output = 0.0;
        self.dpcm.tick_counter = 0.0;
        self.sweep1 = NesSweepUnit::new();
        self.sweep2 = NesSweepUnit::new();
        self.sweep_phase = 0.0;
    }

    fn generate_noise(&mut self, sample_rate: f32) -> f32 {
        let ticks_per_sample = sample_rate / self.noise.frequency;
        self.noise.tick_counter += 1.0;
        if self.noise.tick_counter >= ticks_per_sample {
            self.noise.tick_counter = 0.0;
            let feedback = match self.noise.mode {
                NoiseMode::Short => {
                    (self.noise.shift_register & 0x0001)
                        ^ ((self.noise.shift_register >> 6) & 0x0001)
                }
                NoiseMode::Long => {
                    (self.noise.shift_register & 0x0001)
                        ^ ((self.noise.shift_register >> 1) & 0x0001)
                }
            };
            self.noise.shift_register >>= 1;
            self.noise.shift_register |= feedback << 14;
        }
        let sample = if (self.noise.shift_register & 0x0001) == 0 {
            1.0
        } else {
            -1.0
        };
        sample * self.noise.volume
    }

    fn generate_dpcm(&mut self, sample_rate: f32) -> f32 {
        if self.dpcm.sample_buffer.is_empty()
            || self.dpcm.position >= self.dpcm.sample_buffer.len() * 8
        {
            return self.dpcm.current_output;
        }
        let ticks_per_sample = sample_rate / self.dpcm.sample_rate;
        self.dpcm.tick_counter += 1.0;
        if self.dpcm.tick_counter >= ticks_per_sample {
            self.dpcm.tick_counter = 0.0;
            let byte_idx = self.dpcm.position / 8;
            let bit_idx = self.dpcm.position % 8;
            if byte_idx < self.dpcm.sample_buffer.len() {
                let bit = (self.dpcm.sample_buffer[byte_idx] >> bit_idx) & 1;
                if bit != 0 {
                    self.dpcm.current_output =
                        (self.dpcm.current_output + self.dpcm.delta).min(1.0);
                } else {
                    self.dpcm.current_output =
                        (self.dpcm.current_output - self.dpcm.delta).max(-1.0);
                }
                self.dpcm.position += 1;
            }
        }
        self.dpcm.current_output
    }
}

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

    #[test]
    fn test_nes_chip_silent_when_all_disabled() {
        let mut chip = NesChip::new();
        let mut regs = [0u8; 22];
        regs[21] = 0x00; // all channels disabled
        chip.write_registers(&regs);
        let s = chip.generate_sample(44100.0);
        assert!(s.abs() < 0.001, "all disabled should be silent, got {}", s);
    }

    #[test]
    fn test_nes_chip_produces_audio() {
        let mut chip = NesChip::new();
        let mut regs = [0u8; 22];
        // Pulse 1: 50% duty, max volume, period=0x100 (~438 Hz)
        regs[0] = 0x8F; // duty=10 (50%), volume=15
        regs[2] = 0x00; // period low
        regs[3] = 0x01; // period high
        regs[21] = 0x01; // pulse1 enabled
        chip.write_registers(&regs);
        let mut max_abs = 0.0f32;
        for _ in 0..1024 {
            let s = chip.generate_sample(44100.0);
            max_abs = max_abs.max(s.abs());
        }
        assert!(max_abs > 0.1, "should produce audio, max_abs={}", max_abs);
    }

    #[test]
    fn test_nes_chip_reset() {
        let mut chip = NesChip::new();
        let mut regs = [0u8; 22];
        regs[21] = 0x01; // pulse1 enabled
        chip.write_registers(&regs);
        for _ in 0..100 {
            chip.generate_sample(44100.0);
        }
        chip.reset();
        assert_eq!(chip.pulse1.phase, 0.0);
        assert_eq!(chip.noise.shift_register, 1);
    }

    #[test]
    fn test_sweep_unit_decreases_period() {
        let mut unit = NesSweepUnit::new();
        unit.write_register(0xCF); // enabled, divider=4, negate, shift=7
        unit.set_target_period(0x100);
        let initial = unit.target_period;
        // Clock many times; negate + shift=7 should decrease period
        let mut last = initial;
        for _ in 0..200 {
            if let Some(p) = unit.clock() {
                last = p;
            }
        }
        assert!(
            last < initial,
            "sweep should decrease period (negate), initial={}, last={}",
            initial,
            last
        );
    }

    #[test]
    fn test_sweep_mutes_on_underflow() {
        let mut unit = NesSweepUnit::new();
        unit.write_register(0xCF); // aggressive sweep
        unit.set_target_period(0x10);
        let mut muted = false;
        for _ in 0..200 {
            if unit.clock().is_none() {
                muted = true;
                break;
            }
        }
        assert!(muted, "should mute when period underflows below 8");
    }

    #[test]
    fn test_sweep_disabled_when_divider_zero() {
        let mut unit = NesSweepUnit::new();
        unit.write_register(0x08); // enabled=false equivalent? Actually bit7=0
        unit.set_target_period(0x100);
        let initial = unit.target_period;
        for _ in 0..100 {
            unit.clock();
        }
        assert_eq!(
            unit.target_period, initial,
            "disabled sweep should not change period"
        );
    }
}