moont 1.0.0

Roland CM-32L synthesizer emulator
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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
// Copyright (C) 2021-2026 Geoff Hill <geoff@geoffhill.org>
// Copyright (C) 2003-2026 Dean Beeler, Jerome Fisher, Sergey V. Mikayev
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or (at
// your option) any later version. Read COPYING.LESSER.txt for details.

//! SysEx memory state management.

use crate::param::{
    MELODIC_PARTS_COUNT, PatchParam, PatchTemp, RHYTHM_KEYS_COUNT,
    RawPatchParam, RawPatchTemp, RawRhythmTemp, RhythmKey, TIMBRE_PARAM_SIZE,
    TimbreParam, cast_raw_timbre,
};
use crate::rom::{self, Meta, Rom};
use alloc::boxed::Box;
use core::fmt;

fn cast_patch(raw: &[u8; 8]) -> PatchParam {
    PatchParam::from(unsafe { &*(raw.as_ptr() as *const RawPatchParam) })
}

fn cast_patch_temp(raw: &[u8; 16]) -> PatchTemp {
    PatchTemp::from(unsafe { &*(raw.as_ptr() as *const RawPatchTemp) })
}

fn cast_rhythm_temp(raw: &[u8; 4]) -> RhythmKey {
    RhythmKey::from(unsafe { &*(raw.as_ptr() as *const RawRhythmTemp) })
}

fn cast_timbre(raw: &[u8; TIMBRE_PARAM_SIZE]) -> TimbreParam {
    TimbreParam::from(cast_raw_timbre(raw))
}

/// Converts a Roland SysEx address (7-bit packed) to a linear byte offset.
pub const fn memaddr(x: u32) -> u32 {
    ((x & 0x7f0000) >> 2) | ((x & 0x7f00) >> 1) | (x & 0x7f)
}

// Memory region base addresses (post-memaddr conversion).
const MEM_PATCH_TEMP: u32 = memaddr(0x030000);
const MEM_RHYTHM_TEMP: u32 = memaddr(0x030110);
const MEM_TIMBRE_TEMP: u32 = memaddr(0x040000);
const MEM_PATCHES: u32 = memaddr(0x050000);
const MEM_TIMBRES: u32 = memaddr(0x080000);
const MEM_SYSTEM: u32 = memaddr(0x100000);

pub struct SysexEffects {
    pub refresh_part_volumes: bool,
    pub refresh_reverb: bool,
    pub refresh_master_tune: bool,
    pub refresh_master_volume: bool,
    pub refresh_reserve: bool,
    pub chan_assign_first: Option<usize>,
    pub chan_assign_last: Option<usize>,
    pub timbre_changed_parts: u16,
}

impl SysexEffects {
    fn none() -> Self {
        SysexEffects {
            refresh_part_volumes: false,
            refresh_reverb: false,
            refresh_master_tune: false,
            refresh_master_volume: false,
            refresh_reserve: false,
            chan_assign_first: None,
            chan_assign_last: None,
            timbre_changed_parts: 0,
        }
    }

    fn merge(&mut self, other: SysexEffects) {
        self.refresh_part_volumes |= other.refresh_part_volumes;
        self.refresh_reverb |= other.refresh_reverb;
        self.refresh_master_tune |= other.refresh_master_tune;
        self.refresh_master_volume |= other.refresh_master_volume;
        self.refresh_reserve |= other.refresh_reserve;
        self.timbre_changed_parts |= other.timbre_changed_parts;
        if other.chan_assign_first.is_some() {
            self.chan_assign_first = other.chan_assign_first;
            self.chan_assign_last = other.chan_assign_last;
        }
    }
}

/// Writable SysEx parameter memory mirroring the CM-32L's internal state.
pub struct MemState {
    pub raw_patch_temp: [[u8; 16]; 9],
    pub raw_rhythm_temp: [[u8; 4]; RHYTHM_KEYS_COUNT],
    pub raw_timbre_temp: [[u8; TIMBRE_PARAM_SIZE]; MELODIC_PARTS_COUNT],
    pub raw_patches: [[u8; 8]; 128],
    pub raw_timbres: rom::RawTimbreBank,
    pub raw_system: [u8; 23],

    pub patch_temp: [PatchTemp; 9],
    pub rhythm_temp: [RhythmKey; RHYTHM_KEYS_COUNT],
    pub timbre_temp: [TimbreParam; MELODIC_PARTS_COUNT],
    pub patches: [PatchParam; 128],
    pub timbres: [TimbreParam; rom::TIMBRES_COUNT],
    pub master_volume: usize,
}

impl fmt::Debug for MemState {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("MemState")
            .field("master_volume", &self.master_volume)
            .finish_non_exhaustive()
    }
}

impl MemState {
    pub fn new(rom: &Rom) -> Box<MemState> {
        let meta = rom.meta();

        let mut mem = Box::new(MemState {
            raw_patch_temp: [[0u8; 16]; 9],
            raw_rhythm_temp: [[0u8; 4]; RHYTHM_KEYS_COUNT],
            raw_timbre_temp: [[0u8; TIMBRE_PARAM_SIZE]; MELODIC_PARTS_COUNT],
            raw_patches: [[0u8; 8]; 128],
            raw_timbres: [[0u8; 256]; 256],
            raw_system: [0u8; 23],
            patch_temp: [PatchTemp::default(); 9],
            rhythm_temp: [RhythmKey::default(); RHYTHM_KEYS_COUNT],
            timbre_temp: [TimbreParam::default(); MELODIC_PARTS_COUNT],
            patches: [PatchParam::default(); 128],
            timbres: [TimbreParam::default(); 256],
            master_volume: 100,
        });

        // Init patches: program N maps to timbre group N/64, num N%64.
        for i in 0..128 {
            let raw = &mut mem.raw_patches[i];
            raw[0] = (i / 64) as u8; // timbreGroup
            raw[1] = (i % 64) as u8; // timbreNum
            raw[2] = 24; // keyShift (default = no shift)
            raw[3] = 50; // fineTune (default = no detune)
            raw[4] = 12; // benderRange
            raw[5] = 0; // assignMode
            raw[6] = 1; // reverbSwitch
            raw[7] = 0; // dummy
            mem.patches[i] = cast_patch(raw);
        }

        // Init system.
        mem.raw_system[0] = 0x4A; // masterTune
        mem.raw_system[1] = 0; // reverbMode
        mem.raw_system[2] = 5; // reverbTime
        mem.raw_system[3] = 3; // reverbLevel
        mem.raw_system[4..13].copy_from_slice(&meta.reserve_settings);
        mem.raw_system[13] = 1; // chanAssign part 1
        mem.raw_system[14] = 2;
        mem.raw_system[15] = 3;
        mem.raw_system[16] = 4;
        mem.raw_system[17] = 5;
        mem.raw_system[18] = 6;
        mem.raw_system[19] = 7;
        mem.raw_system[20] = 8;
        mem.raw_system[21] = 9; // chanAssign part 9 (rhythm)
        mem.raw_system[22] = 100; // masterVol
        mem.master_volume = 100;

        // Init rhythm_temp from ROM rhythm_keys.
        for i in 0..RHYTHM_KEYS_COUNT {
            let rk = &meta.rhythm_keys[i];
            let raw = &mut mem.raw_rhythm_temp[i];
            raw[0] = rk.timbre as u8;
            raw[1] = rk.level as u8;
            raw[2] = rk.panpot as u8;
            raw[3] = if rk.reverb { 1 } else { 0 };
            mem.rhythm_temp[i] = *rk;
        }

        // Init patch_temp for 9 parts.
        for i in 0..9 {
            let raw = &mut mem.raw_patch_temp[i];
            // PatchParam defaults.
            raw[0] = 0; // timbreGroup
            raw[1] = 0; // timbreNum
            raw[2] = 24; // keyShift
            raw[3] = 50; // fineTune
            raw[4] = 12; // benderRange
            raw[5] = 0; // assignMode
            raw[6] = 1; // reverbSwitch
            raw[7] = 0; // dummy
            raw[8] = 80; // outputLevel
            raw[9] = meta.default_panpots[i] as u8;
            raw[10] = 0; // dummyv[0]
            raw[11] = 127; // dummyv[1]
            // Rest is 0.
            mem.patch_temp[i] = cast_patch_temp(raw);
        }

        // For melodic parts, apply default programs (like setProgram).
        for i in 0..MELODIC_PARTS_COUNT {
            let prog = meta.default_programs[i];
            let patch = &mem.patches[prog];
            // Copy patch into patch_temp.
            mem.raw_patch_temp[i][0] = patch.timbre_group;
            mem.raw_patch_temp[i][1] = patch.timbre_num;
            mem.raw_patch_temp[i][2] = patch.key_shift as u8;
            mem.raw_patch_temp[i][3] = patch.fine_tune as u8;
            mem.raw_patch_temp[i][4] = patch.bender_range;
            mem.raw_patch_temp[i][5] = patch.assign_mode;
            mem.raw_patch_temp[i][6] = if patch.reverb_switch { 1 } else { 0 };
            mem.raw_patch_temp[i][7] = 0;
            mem.patch_temp[i] = cast_patch_temp(&mem.raw_patch_temp[i]);
        }

        // Init raw_timbres + timbres from ROM.
        rom.fill_raw_timbres(&mut mem.raw_timbres);
        for i in 0..rom::MELODIC_TIMBRES_COUNT {
            mem.timbres[i] = meta.melodic_timbres[i];
        }
        for i in 0..rom::RHYTHM_TIMBRES_COUNT {
            mem.timbres[192 + i] = meta.rhythm_timbres[i];
        }

        // Init timbre_temp + raw_timbre_temp: for each melodic part,
        // copy the timbre referenced by its default program.
        for i in 0..MELODIC_PARTS_COUNT {
            let pt = &mem.patch_temp[i];
            let abs = pt.patch.timbre_group as usize * 64
                + pt.patch.timbre_num as usize;
            mem.timbre_temp[i] = mem.timbres[abs];
            mem.raw_timbre_temp[i]
                .copy_from_slice(&mem.raw_timbres[abs][..TIMBRE_PARAM_SIZE]);
        }

        mem
    }

    pub fn set_program(&mut self, part: usize, program: usize) {
        let patch = self.patches[program];
        self.raw_patch_temp[part][0] = patch.timbre_group;
        self.raw_patch_temp[part][1] = patch.timbre_num;
        self.raw_patch_temp[part][2] = patch.key_shift as u8;
        self.raw_patch_temp[part][3] = patch.fine_tune as u8;
        self.raw_patch_temp[part][4] = patch.bender_range;
        self.raw_patch_temp[part][5] = patch.assign_mode;
        self.raw_patch_temp[part][6] = if patch.reverb_switch { 1 } else { 0 };
        self.raw_patch_temp[part][7] = 0;
        self.patch_temp[part] = cast_patch_temp(&self.raw_patch_temp[part]);

        let abs = patch.timbre_group as usize * 64 + patch.timbre_num as usize;
        self.timbre_temp[part] = self.timbres[abs];
        self.raw_timbre_temp[part]
            .copy_from_slice(&self.raw_timbres[abs][..TIMBRE_PARAM_SIZE]);
    }

    pub fn write_sysex(
        &mut self,
        mut addr: u32,
        mut data: &[u8],
        meta: &Meta,
    ) -> SysexEffects {
        let mut effects = SysexEffects::none();
        while !data.is_empty() {
            if addr >= MEM_PATCH_TEMP && addr < MEM_PATCH_TEMP + 16 * 9 {
                let end = MEM_PATCH_TEMP + 16 * 9;
                let n = data.len().min((end - addr) as usize);
                effects.merge(self.write_patch_temp(addr, &data[..n], meta));
                addr += n as u32;
                data = &data[n..];
            } else if addr >= MEM_RHYTHM_TEMP
                && addr < MEM_RHYTHM_TEMP + 4 * RHYTHM_KEYS_COUNT as u32
            {
                let end = MEM_RHYTHM_TEMP + 4 * RHYTHM_KEYS_COUNT as u32;
                let n = data.len().min((end - addr) as usize);
                self.write_rhythm_temp(addr, &data[..n], meta);
                addr += n as u32;
                data = &data[n..];
            } else if addr >= MEM_TIMBRE_TEMP
                && addr
                    < MEM_TIMBRE_TEMP
                        + TIMBRE_PARAM_SIZE as u32 * MELODIC_PARTS_COUNT as u32
            {
                let end = MEM_TIMBRE_TEMP
                    + TIMBRE_PARAM_SIZE as u32 * MELODIC_PARTS_COUNT as u32;
                let n = data.len().min((end - addr) as usize);
                effects.merge(self.write_timbre_temp(addr, &data[..n], meta));
                addr += n as u32;
                data = &data[n..];
            } else if addr >= MEM_PATCHES && addr < MEM_PATCHES + 8 * 128 {
                let end = MEM_PATCHES + 8 * 128;
                let n = data.len().min((end - addr) as usize);
                self.write_patches(addr, &data[..n], meta);
                addr += n as u32;
                data = &data[n..];
            } else if addr >= MEM_TIMBRES && addr < MEM_TIMBRES + 128 * 256 {
                let end = MEM_TIMBRES + 128 * 256;
                let n = data.len().min((end - addr) as usize);
                effects.merge(self.write_timbres(addr, &data[..n], meta));
                addr += n as u32;
                data = &data[n..];
            } else if addr >= MEM_SYSTEM && addr < MEM_SYSTEM + 23 {
                let end = MEM_SYSTEM + 23;
                let n = data.len().min((end - addr) as usize);
                effects.merge(self.write_system(addr, &data[..n], meta));
                addr += n as u32;
                data = &data[n..];
            } else {
                break;
            }
        }
        effects
    }

    fn write_patch_temp(
        &mut self,
        addr: u32,
        data: &[u8],
        meta: &Meta,
    ) -> SysexEffects {
        let base = (addr - MEM_PATCH_TEMP) as usize;
        let first = base / 16;
        let off = base % 16;
        let last = (base + data.len() - 1) / 16;
        let max = &meta.patch_max_table;

        for (i, &byte) in data.iter().enumerate() {
            let pos = off + i;
            let entry = first + pos / 16;
            let slot = pos % 16;
            let clamped = byte.min(max[slot]);
            self.raw_patch_temp[entry][slot] = clamped;
        }

        let mut effects = SysexEffects::none();
        for entry in first..=last.min(8) {
            self.patch_temp[entry] =
                cast_patch_temp(&self.raw_patch_temp[entry]);

            if entry < MELODIC_PARTS_COUNT {
                let should_reset = if entry == first { off <= 2 } else { true };
                if should_reset {
                    let pt = &self.patch_temp[entry];
                    let abs = pt.patch.timbre_group as usize * 64
                        + pt.patch.timbre_num as usize;
                    self.timbre_temp[entry] = self.timbres[abs];
                    self.raw_timbre_temp[entry].copy_from_slice(
                        &self.raw_timbres[abs][..TIMBRE_PARAM_SIZE],
                    );
                    effects.timbre_changed_parts |= 1 << entry;
                }
                effects.refresh_part_volumes = true;
            }
        }
        effects
    }

    fn write_rhythm_temp(&mut self, addr: u32, data: &[u8], meta: &Meta) {
        let base = (addr - MEM_RHYTHM_TEMP) as usize;
        let first = base / 4;
        let off = base % 4;
        let last = (base + data.len() - 1) / 4;
        let max = &meta.rhythm_max_table;

        for (i, &byte) in data.iter().enumerate() {
            let pos = off + i;
            let entry = first + pos / 4;
            let slot = pos % 4;
            let clamped = byte.min(max[slot]);
            self.raw_rhythm_temp[entry][slot] = clamped;
        }

        for entry in first..=last.min(RHYTHM_KEYS_COUNT - 1) {
            self.rhythm_temp[entry] =
                cast_rhythm_temp(&self.raw_rhythm_temp[entry]);
        }
    }

    fn write_timbre_temp(
        &mut self,
        addr: u32,
        data: &[u8],
        meta: &Meta,
    ) -> SysexEffects {
        let base = (addr - MEM_TIMBRE_TEMP) as usize;
        let first = base / TIMBRE_PARAM_SIZE;
        let off = base % TIMBRE_PARAM_SIZE;
        let last = (base + data.len() - 1) / TIMBRE_PARAM_SIZE;
        let max = &meta.timbre_max_table;

        for (i, &byte) in data.iter().enumerate() {
            let pos = off + i;
            let entry = first + pos / TIMBRE_PARAM_SIZE;
            let slot = pos % TIMBRE_PARAM_SIZE;
            let max_val = max[slot];
            let clamped = byte.min(max_val);
            self.raw_timbre_temp[entry][slot] = clamped;
        }

        let mut effects = SysexEffects::none();
        for entry in first..=last.min(MELODIC_PARTS_COUNT - 1) {
            self.timbre_temp[entry] = cast_timbre(&self.raw_timbre_temp[entry]);
            effects.timbre_changed_parts |= 1 << entry;
        }
        effects
    }

    fn write_patches(&mut self, addr: u32, data: &[u8], meta: &Meta) {
        let base = (addr - MEM_PATCHES) as usize;
        let first = base / 8;
        let off = base % 8;
        let last = (base + data.len() - 1) / 8;
        let max = &meta.patch_max_table;

        for (i, &byte) in data.iter().enumerate() {
            let pos = off + i;
            let entry = first + pos / 8;
            let slot = pos % 8;
            let clamped = byte.min(max[slot]);
            self.raw_patches[entry][slot] = clamped;
        }

        for entry in first..=last.min(127) {
            self.patches[entry] = cast_patch(&self.raw_patches[entry]);
        }
    }

    fn write_timbres(
        &mut self,
        addr: u32,
        data: &[u8],
        meta: &Meta,
    ) -> SysexEffects {
        let base = (addr - MEM_TIMBRES) as usize;
        let first_raw = base / 256;
        let off = base % 256;
        let last_raw = (base + data.len() - 1) / 256;
        let max = &meta.timbre_max_table;

        // Timbres region covers all 256 entries in raw memory,
        // but SysEx address 0x080000 maps to index 128.
        let first = first_raw + 128;
        let last = last_raw + 128;

        for (i, &byte) in data.iter().enumerate() {
            let pos = off + i;
            let entry = first_raw + pos / 256;
            let slot = pos % 256;
            let max_val = if slot < TIMBRE_PARAM_SIZE {
                max[slot]
            } else {
                0
            };
            let clamped = byte.min(max_val);
            self.raw_timbres[entry + 128][slot] = clamped;
        }

        for entry in first..=last.min(255) {
            let raw = &self.raw_timbres[entry];
            let mut raw_timbre = [0u8; TIMBRE_PARAM_SIZE];
            raw_timbre.copy_from_slice(&raw[..TIMBRE_PARAM_SIZE]);
            self.timbres[entry] = cast_timbre(&raw_timbre);
        }

        let mut effects = SysexEffects::none();
        for entry in first..=last.min(255) {
            for part in 0..MELODIC_PARTS_COUNT {
                let pt = &self.patch_temp[part];
                let abs_timbre = pt.patch.timbre_group as usize * 64
                    + pt.patch.timbre_num as usize;
                if abs_timbre == entry {
                    self.timbre_temp[part] = self.timbres[entry];
                    effects.timbre_changed_parts |= 1 << part;
                }
            }
        }
        effects
    }

    fn write_system(
        &mut self,
        addr: u32,
        data: &[u8],
        meta: &Meta,
    ) -> SysexEffects {
        let off = (addr - MEM_SYSTEM) as usize;
        let max = &meta.system_max_table;

        for (i, &byte) in data.iter().enumerate() {
            let pos = off + i;
            if pos < 23 {
                let clamped = byte.min(max[pos]);
                self.raw_system[pos] = clamped;
            }
        }

        let end = off + data.len();
        let mut effects = SysexEffects::none();

        // Master tune (offset 0).
        if off == 0 {
            effects.refresh_master_tune = true;
        }

        // Reverb parameters (offsets 1-3).
        if off <= 3 && end > 1 {
            effects.refresh_reverb = true;
        }

        // Reserve settings (offsets 4-12).
        if off <= 12 && end > 4 {
            effects.refresh_reserve = true;
        }

        // Channel assignment (offsets 13-21).
        if off <= 21 && end > 13 {
            let first = off.saturating_sub(13);
            let last = (end - 13).min(8);
            effects.chan_assign_first = Some(first);
            effects.chan_assign_last = Some(last);
        }

        // Master volume (offset 22).
        if off <= 22 && end > 22 {
            self.master_volume = self.raw_system[22] as usize;
            effects.refresh_master_volume = true;
        }

        effects
    }
}