nord-format 0.3.0

Read and write Clavia / Nord keyboard file formats — programs, samples, set lists, settings, backups — with byte-exact round-trips
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

//! The Stage 4 synth preset body (`.ns4y`): 497 bytes.
//!
//! One synth section as a program stores it, moved down 327 bytes. The keyboard
//! zone and the extern CC values ride along for every layer, though a preset has
//! no use for them. Layers are 408 bits apart; layer A's zone is confirmed
//! against the corpus (it varies exactly as B's and C's do), its extern CC block
//! is placed by the stride alone, since no specimen sets any layer's.

use super::fx::FxChain;
use super::synth_voice::SynthVoice;
use crate::cbin::{self, Cbin};
use crate::components::{
    ArpPattern, KbZone4, Level, LibraryRef, MorphTarget, OctaveShiftNibble, Pan, Selector, Time,
};
use crate::error::Error;
use crate::types::{RangedU16, RangedU8};
use std::io::{Read, Seek};

pub const FORMAT: &str = "ns4y";
/// Stored ×100. The corpus holds 2.08; ns4decode was tested from 2.03.
pub const KNOWN_VERSIONS: &[u32] = &[203, 204, 205, 206, 207, 208];
pub const BODY_LEN: usize = 497;

/// The 497-byte preset body: one synth section as a program stores it.
///
/// Reads and writes byte-exactly. A read verifies the container checksum, gates
/// on [`KNOWN_VERSIONS`], and range-checks every field; unclaimed bits survive a
/// re-encode verbatim. Placements derived from ns4decode's published tables;
/// values raw. Not confirmed on hardware.
#[nord_bits_derive::bitbody(497)]
pub struct SynthPreset {
    #[bits(42..=42)]
    pub synth_c_layer_enabled: bool,
    #[bits(43..=43)]
    pub synth_b_layer_enabled: bool,
    #[bits(44..=44)]
    pub synth_a_layer_enabled: bool,
    #[bits(47..=47)]
    pub synth_c_layer_enabled_scene_2: bool,
    #[bits(48..=48)]
    pub synth_b_layer_enabled_scene_2: bool,
    #[bits(49..=49)]
    pub synth_a_layer_enabled_scene_2: bool,
    #[bits(50..=56)]
    pub synth_a_volume: Level,
    #[bits(57..=64)]
    pub synth_a_volume_wheel: MorphTarget,
    #[bits(65..=72)]
    pub synth_a_volume_aftertouch: MorphTarget,
    #[bits(73..=80)]
    pub synth_a_volume_ctrl_pedal: MorphTarget,
    #[bits(81..=87)]
    pub synth_b_volume: Level,
    #[bits(88..=95)]
    pub synth_b_volume_wheel: MorphTarget,
    #[bits(96..=103)]
    pub synth_b_volume_aftertouch: MorphTarget,
    #[bits(104..=111)]
    pub synth_b_volume_ctrl_pedal: MorphTarget,
    #[bits(112..=118)]
    pub synth_c_volume: Level,
    #[bits(119..=126)]
    pub synth_c_volume_wheel: MorphTarget,
    #[bits(127..=134)]
    pub synth_c_volume_aftertouch: MorphTarget,
    #[bits(135..=142)]
    pub synth_c_volume_ctrl_pedal: MorphTarget,
    #[bits(143..=148)]
    pub synth_a_pan: Pan,
    #[bits(174..=179)]
    pub synth_b_pan: Pan,
    #[bits(205..=210)]
    pub synth_c_pan: Pan,
    #[bits(288..=288)]
    pub synth_a_samples_analog: bool,
    #[bits(294..=305)]
    pub synth_a_sample_slot: RangedU16<4095>,
    #[bits(306..=337)]
    pub synth_a_sample_id: LibraryRef,
    #[bits(338..=341)]
    pub synth_a_kb_zones: KbZone4,
    #[bits(342..=345)]
    pub synth_a_octave_shift: OctaveShiftNibble,
    #[bits(346..=346)]
    pub synth_a_pitch_stick_enabled: bool,
    #[bits(347..=350)]
    pub synth_a_pitch_stick_range: Selector<4>,
    #[bits(351..=351)]
    pub synth_a_sustain_pedal_enabled: bool,
    #[bits(352..=354)]
    pub synth_a_vibrato_mode: Selector<3>,
    #[bits(357..=357)]
    pub synth_a_legato_enabled: bool,
    #[bits(358..=358)]
    pub synth_a_mono_enabled: bool,
    #[bits(359..=360)]
    pub synth_a_voice_priority: Selector<2>,
    #[bits(361..=367)]
    pub synth_a_glide: Time,
    #[bits(368..=368)]
    pub synth_a_extern_enabled: bool,
    #[bits(399..=405)]
    pub synth_a_extern_program: Level,
    #[bits(414..=414)]
    pub synth_a_kb_hold: bool,
    #[bits(415..=415)]
    pub synth_a_arpeggiator_run_enabled: bool,
    #[bits(416..=417)]
    pub synth_a_arpeggiator_mode: Selector<2>,
    #[bits(418..=418)]
    pub synth_a_arp_pattern_enabled: bool,
    #[bits(419..=419)]
    pub synth_a_kb_sync_enabled: bool,
    #[bits(420..=426)]
    pub synth_a_arp_range_env: Level,
    #[bits(427..=434)]
    pub synth_a_arp_range_env_wheel: MorphTarget,
    #[bits(435..=442)]
    pub synth_a_arp_range_env_aftertouch: MorphTarget,
    #[bits(443..=450)]
    pub synth_a_arp_range_env_ctrl_pedal: MorphTarget,
    #[bits(451..=452)]
    pub synth_a_arp_direction: Selector<2>,
    #[bits(453..=453)]
    pub synth_a_arp_zigzag_enabled: bool,
    #[bits(454..=454)]
    pub synth_a_arp_master_clock_enabled: bool,
    #[bits(455..=461)]
    pub synth_a_arp_rate_time: Time,
    #[bits(462..=469)]
    pub synth_a_arp_rate_time_wheel: MorphTarget,
    #[bits(470..=477)]
    pub synth_a_arp_rate_time_aftertouch: MorphTarget,
    #[bits(478..=485)]
    pub synth_a_arp_rate_time_ctrl_pedal: MorphTarget,
    #[bits(486..=489)]
    pub synth_a_arp_pattern_length: RangedU8<15>,
    #[bits(490..=521)]
    pub synth_a_arpeggiator_accent: ArpPattern,
    #[bits(522..=553)]
    pub synth_a_arpeggiator_gate: ArpPattern,
    #[bits(554..=585)]
    pub synth_a_arpeggiator_pan: ArpPattern,
    #[bits(586..=587)]
    pub synth_a_unison_level: Selector<2>,
    #[bits(588..=594)]
    pub synth_a_extern_cc_val1: Level,
    #[bits(595..=602)]
    pub synth_a_extern_cc_val1_wheel: MorphTarget,
    #[bits(603..=610)]
    pub synth_a_extern_cc_val1_aftertouch: MorphTarget,
    #[bits(611..=618)]
    pub synth_a_extern_cc_val1_ctrl_pedal: MorphTarget,
    #[bits(619..=625)]
    pub synth_a_extern_cc_val2: Level,
    #[bits(626..=633)]
    pub synth_a_extern_cc_val2_wheel: MorphTarget,
    #[bits(634..=641)]
    pub synth_a_extern_cc_val2_aftertouch: MorphTarget,
    #[bits(642..=649)]
    pub synth_a_extern_cc_val2_ctrl_pedal: MorphTarget,
    #[bits(652..=656)]
    pub synth_a_vibrato_delay: Selector<5>,
    #[bits(696..=696)]
    pub synth_b_samples_analog: bool,
    #[bits(702..=713)]
    pub synth_b_sample_slot: RangedU16<4095>,
    #[bits(714..=745)]
    pub synth_b_sample_id: LibraryRef,
    #[bits(746..=749)]
    pub synth_b_kb_zones: KbZone4,
    #[bits(750..=753)]
    pub synth_b_octave_shift: OctaveShiftNibble,
    #[bits(754..=754)]
    pub synth_b_pitch_stick_enabled: bool,
    #[bits(755..=758)]
    pub synth_b_pitch_stick_range: Selector<4>,
    #[bits(759..=759)]
    pub synth_b_sustain_pedal_enabled: bool,
    #[bits(760..=762)]
    pub synth_b_vibrato_mode: Selector<3>,
    #[bits(765..=765)]
    pub synth_b_legato_enabled: bool,
    #[bits(766..=766)]
    pub synth_b_mono_enabled: bool,
    #[bits(767..=768)]
    pub synth_b_voice_priority: Selector<2>,
    #[bits(769..=775)]
    pub synth_b_glide: Time,
    #[bits(776..=776)]
    pub synth_b_extern_enabled: bool,
    #[bits(807..=813)]
    pub synth_b_extern_program: Level,
    #[bits(822..=822)]
    pub synth_b_kb_hold: bool,
    #[bits(823..=823)]
    pub synth_b_arpeggiator_run_enabled: bool,
    #[bits(824..=825)]
    pub synth_b_arpeggiator_mode: Selector<2>,
    #[bits(826..=826)]
    pub synth_b_arp_pattern_enabled: bool,
    #[bits(827..=827)]
    pub synth_b_kb_sync_enabled: bool,
    #[bits(828..=834)]
    pub synth_b_arp_range_env: Level,
    #[bits(835..=842)]
    pub synth_b_arp_range_env_wheel: MorphTarget,
    #[bits(843..=850)]
    pub synth_b_arp_range_env_aftertouch: MorphTarget,
    #[bits(851..=858)]
    pub synth_b_arp_range_env_ctrl_pedal: MorphTarget,
    #[bits(859..=860)]
    pub synth_b_arp_direction: Selector<2>,
    #[bits(861..=861)]
    pub synth_b_arp_zigzag_enabled: bool,
    #[bits(862..=862)]
    pub synth_b_arp_master_clock_enabled: bool,
    #[bits(863..=869)]
    pub synth_b_arp_rate_time: Time,
    #[bits(870..=877)]
    pub synth_b_arp_rate_time_wheel: MorphTarget,
    #[bits(878..=885)]
    pub synth_b_arp_rate_time_aftertouch: MorphTarget,
    #[bits(886..=893)]
    pub synth_b_arp_rate_time_ctrl_pedal: MorphTarget,
    #[bits(894..=897)]
    pub synth_b_arp_pattern_length: RangedU8<15>,
    #[bits(898..=929)]
    pub synth_b_arpeggiator_accent: ArpPattern,
    #[bits(930..=961)]
    pub synth_b_arpeggiator_gate: ArpPattern,
    #[bits(962..=993)]
    pub synth_b_arpeggiator_pan: ArpPattern,
    #[bits(994..=995)]
    pub synth_b_unison_level: Selector<2>,
    #[bits(996..=1002)]
    pub synth_b_extern_cc_val1: Level,
    #[bits(1003..=1010)]
    pub synth_b_extern_cc_val1_wheel: MorphTarget,
    #[bits(1011..=1018)]
    pub synth_b_extern_cc_val1_aftertouch: MorphTarget,
    #[bits(1019..=1026)]
    pub synth_b_extern_cc_val1_ctrl_pedal: MorphTarget,
    #[bits(1027..=1033)]
    pub synth_b_extern_cc_val2: Level,
    #[bits(1034..=1041)]
    pub synth_b_extern_cc_val2_wheel: MorphTarget,
    #[bits(1042..=1049)]
    pub synth_b_extern_cc_val2_aftertouch: MorphTarget,
    #[bits(1050..=1057)]
    pub synth_b_extern_cc_val2_ctrl_pedal: MorphTarget,
    #[bits(1060..=1064)]
    pub synth_b_vibrato_delay: Selector<5>,
    #[bits(1104..=1104)]
    pub synth_c_samples_analog: bool,
    #[bits(1110..=1121)]
    pub synth_c_sample_slot: RangedU16<4095>,
    #[bits(1122..=1153)]
    pub synth_c_sample_id: LibraryRef,
    #[bits(1154..=1157)]
    pub synth_c_kb_zones: KbZone4,
    #[bits(1158..=1161)]
    pub synth_c_octave_shift: OctaveShiftNibble,
    #[bits(1162..=1162)]
    pub synth_c_pitch_stick_enabled: bool,
    #[bits(1163..=1166)]
    pub synth_c_pitch_stick_range: Selector<4>,
    #[bits(1167..=1167)]
    pub synth_c_sustain_pedal_enabled: bool,
    #[bits(1168..=1170)]
    pub synth_c_vibrato_mode: Selector<3>,
    #[bits(1173..=1173)]
    pub synth_c_legato_enabled: bool,
    #[bits(1174..=1174)]
    pub synth_c_mono_enabled: bool,
    #[bits(1175..=1176)]
    pub synth_c_voice_priority: Selector<2>,
    #[bits(1177..=1183)]
    pub synth_c_glide: Time,
    #[bits(1184..=1184)]
    pub synth_c_extern_enabled: bool,
    #[bits(1215..=1221)]
    pub synth_c_extern_program: Level,
    #[bits(1230..=1230)]
    pub synth_c_kb_hold: bool,
    #[bits(1231..=1231)]
    pub synth_c_arpeggiator_run_enabled: bool,
    #[bits(1232..=1233)]
    pub synth_c_arpeggiator_mode: Selector<2>,
    #[bits(1234..=1234)]
    pub synth_c_arp_pattern_enabled: bool,
    #[bits(1235..=1235)]
    pub synth_c_kb_sync_enabled: bool,
    #[bits(1236..=1242)]
    pub synth_c_arp_range_env: Level,
    #[bits(1243..=1250)]
    pub synth_c_arp_range_env_wheel: MorphTarget,
    #[bits(1251..=1258)]
    pub synth_c_arp_range_env_aftertouch: MorphTarget,
    #[bits(1259..=1266)]
    pub synth_c_arp_range_env_ctrl_pedal: MorphTarget,
    #[bits(1267..=1268)]
    pub synth_c_arp_direction: Selector<2>,
    #[bits(1269..=1269)]
    pub synth_c_arp_zigzag_enabled: bool,
    #[bits(1270..=1270)]
    pub synth_c_arp_master_clock_enabled: bool,
    #[bits(1271..=1277)]
    pub synth_c_arp_rate_time: Time,
    #[bits(1278..=1285)]
    pub synth_c_arp_rate_time_wheel: MorphTarget,
    #[bits(1286..=1293)]
    pub synth_c_arp_rate_time_aftertouch: MorphTarget,
    #[bits(1294..=1301)]
    pub synth_c_arp_rate_time_ctrl_pedal: MorphTarget,
    #[bits(1302..=1305)]
    pub synth_c_arp_pattern_length: RangedU8<15>,
    #[bits(1306..=1337)]
    pub synth_c_arpeggiator_accent: ArpPattern,
    #[bits(1338..=1369)]
    pub synth_c_arpeggiator_gate: ArpPattern,
    #[bits(1370..=1401)]
    pub synth_c_arpeggiator_pan: ArpPattern,
    #[bits(1402..=1403)]
    pub synth_c_unison_level: Selector<2>,
    #[bits(1404..=1410)]
    pub synth_c_extern_cc_val1: Level,
    #[bits(1411..=1418)]
    pub synth_c_extern_cc_val1_wheel: MorphTarget,
    #[bits(1419..=1426)]
    pub synth_c_extern_cc_val1_aftertouch: MorphTarget,
    #[bits(1427..=1434)]
    pub synth_c_extern_cc_val1_ctrl_pedal: MorphTarget,
    #[bits(1435..=1441)]
    pub synth_c_extern_cc_val2: Level,
    #[bits(1442..=1449)]
    pub synth_c_extern_cc_val2_wheel: MorphTarget,
    #[bits(1450..=1457)]
    pub synth_c_extern_cc_val2_aftertouch: MorphTarget,
    #[bits(1458..=1465)]
    pub synth_c_extern_cc_val2_ctrl_pedal: MorphTarget,
    #[bits(1468..=1472)]
    pub synth_c_vibrato_delay: Selector<5>,

    #[at(189..233)]
    pub synth_a_voice: SynthVoice,
    #[at(237..281)]
    pub synth_b_voice: SynthVoice,
    #[at(285..329)]
    pub synth_c_voice: SynthVoice,
    /// The synth a section's effects chain.
    #[at(333..385)]
    pub synth_a_fx: FxChain,
    /// The synth b section's effects chain.
    #[at(388..440)]
    pub synth_b_fx: FxChain,
    /// The synth c section's effects chain.
    #[at(443..495)]
    pub synth_c_fx: FxChain,
}

pub fn read_from(reader: &mut (impl Read + Seek)) -> Result<Cbin<SynthPreset>, Error> {
    let file: Cbin<SynthPreset> = cbin::read(reader, FORMAT)?;
    crate::formats::known_version(FORMAT, file.header.version, KNOWN_VERSIONS)?;
    Ok(file)
}