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

//! The Stage 4 organ preset body (`.ns4o`): 139 bytes.
//!
//! One organ section as a program stores it, moved down 45 bytes, keyboard zone
//! included on both layers though a preset has no use for it — layer A's is
//! confirmed against the corpus, where it varies as a zone does. The two layers
//! still share one effects chain, so its fields carry no layer.

use super::fx::FxChain;
use crate::cbin::{self, Cbin};
use crate::components::{
    Drawbar, DrawbarMorph, KbZone4, Level, MorphTarget, OctaveShiftNibble, Selector,
};
use crate::error::Error;
use std::io::{Read, Seek};

pub const FORMAT: &str = "ns4o";
/// Stored ×100. The corpus holds 2.05; ns4decode was tested on 2.01.
pub const KNOWN_VERSIONS: &[u32] = &[201, 202, 203, 204, 205];
pub const BODY_LEN: usize = 139;

/// The 139-byte preset body: one organ 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(139)]
pub struct OrganPreset {
    #[bits(41..=41)]
    pub organ_b_layer_enabled: bool,
    #[bits(42..=42)]
    pub organ_a_layer_enabled: bool,
    #[bits(44..=44)]
    pub organ_b_layer_enabled_scene_2: bool,
    #[bits(45..=45)]
    pub organ_a_layer_enabled_scene_2: bool,
    #[bits(46..=52)]
    pub organ_a_volume: Level,
    #[bits(53..=60)]
    pub organ_a_volume_wheel: MorphTarget,
    #[bits(61..=68)]
    pub organ_a_volume_aftertouch: MorphTarget,
    #[bits(69..=76)]
    pub organ_a_volume_ctrl_pedal: MorphTarget,
    #[bits(77..=83)]
    pub organ_b_volume: Level,
    #[bits(84..=91)]
    pub organ_b_volume_wheel: MorphTarget,
    #[bits(92..=99)]
    pub organ_b_volume_aftertouch: MorphTarget,
    #[bits(100..=107)]
    pub organ_b_volume_ctrl_pedal: MorphTarget,
    #[bits(184..=187)]
    pub organ_a_kb_zones: KbZone4,
    #[bits(188..=191)]
    pub organ_a_octave_shift: OctaveShiftNibble,
    #[bits(192..=192)]
    pub organ_a_sustain_pedal_enabled: bool,
    #[bits(193..=195)]
    pub organ_a_model: Selector<3>,
    #[bits(196..=196)]
    pub organ_a_preset_enabled: bool,
    #[bits(216..=219)]
    pub organ_a_drawbar_1: Drawbar,
    #[bits(220..=224)]
    pub organ_a_drawbar_1_wheel: DrawbarMorph,
    #[bits(225..=229)]
    pub organ_a_drawbar_1_aftertouch: DrawbarMorph,
    #[bits(230..=234)]
    pub organ_a_drawbar_1_ctrl_pedal: DrawbarMorph,
    #[bits(235..=238)]
    pub organ_a_drawbar_2: Drawbar,
    #[bits(239..=243)]
    pub organ_a_drawbar_2_wheel: DrawbarMorph,
    #[bits(244..=248)]
    pub organ_a_drawbar_2_aftertouch: DrawbarMorph,
    #[bits(249..=253)]
    pub organ_a_drawbar_2_ctrl_pedal: DrawbarMorph,
    #[bits(254..=257)]
    pub organ_a_drawbar_3: Drawbar,
    #[bits(258..=262)]
    pub organ_a_drawbar_3_wheel: DrawbarMorph,
    #[bits(263..=267)]
    pub organ_a_drawbar_3_aftertouch: DrawbarMorph,
    #[bits(268..=272)]
    pub organ_a_drawbar_3_ctrl_pedal: DrawbarMorph,
    #[bits(273..=276)]
    pub organ_a_drawbar_4: Drawbar,
    #[bits(277..=281)]
    pub organ_a_drawbar_4_wheel: DrawbarMorph,
    #[bits(282..=286)]
    pub organ_a_drawbar_4_aftertouch: DrawbarMorph,
    #[bits(287..=291)]
    pub organ_a_drawbar_4_ctrl_pedal: DrawbarMorph,
    #[bits(292..=295)]
    pub organ_a_drawbar_5: Drawbar,
    #[bits(296..=300)]
    pub organ_a_drawbar_5_wheel: DrawbarMorph,
    #[bits(301..=305)]
    pub organ_a_drawbar_5_aftertouch: DrawbarMorph,
    #[bits(306..=310)]
    pub organ_a_drawbar_5_ctrl_pedal: DrawbarMorph,
    #[bits(311..=314)]
    pub organ_a_drawbar_6: Drawbar,
    #[bits(315..=319)]
    pub organ_a_drawbar_6_wheel: DrawbarMorph,
    #[bits(320..=324)]
    pub organ_a_drawbar_6_aftertouch: DrawbarMorph,
    #[bits(325..=329)]
    pub organ_a_drawbar_6_ctrl_pedal: DrawbarMorph,
    #[bits(330..=333)]
    pub organ_a_drawbar_7: Drawbar,
    #[bits(334..=338)]
    pub organ_a_drawbar_7_wheel: DrawbarMorph,
    #[bits(339..=343)]
    pub organ_a_drawbar_7_aftertouch: DrawbarMorph,
    #[bits(344..=348)]
    pub organ_a_drawbar_7_ctrl_pedal: DrawbarMorph,
    #[bits(349..=352)]
    pub organ_a_drawbar_8: Drawbar,
    #[bits(353..=357)]
    pub organ_a_drawbar_8_wheel: DrawbarMorph,
    #[bits(358..=362)]
    pub organ_a_drawbar_8_aftertouch: DrawbarMorph,
    #[bits(363..=367)]
    pub organ_a_drawbar_8_ctrl_pedal: DrawbarMorph,
    #[bits(368..=371)]
    pub organ_a_drawbar_9: Drawbar,
    #[bits(372..=376)]
    pub organ_a_drawbar_9_wheel: DrawbarMorph,
    #[bits(377..=381)]
    pub organ_a_drawbar_9_aftertouch: DrawbarMorph,
    #[bits(382..=386)]
    pub organ_a_drawbar_9_ctrl_pedal: DrawbarMorph,
    #[bits(408..=408)]
    pub organ_a_vib_chorus_enabled: bool,
    #[bits(409..=409)]
    pub organ_a_percussion_enabled: bool,
    #[bits(410..=410)]
    pub organ_a_percussion_harmonic_3rd_enabled: bool,
    #[bits(411..=411)]
    pub organ_a_percussion_decay_fast_enabled: bool,
    #[bits(412..=412)]
    pub organ_a_percussion_volume_soft_enabled: bool,
    #[bits(432..=435)]
    pub organ_b_kb_zones: KbZone4,
    #[bits(436..=439)]
    pub organ_b_octave_shift: OctaveShiftNibble,
    #[bits(440..=440)]
    pub organ_b_sustain_pedal_enabled: bool,
    #[bits(441..=443)]
    pub organ_b_model: Selector<3>,
    #[bits(444..=444)]
    pub organ_b_preset_enabled: bool,
    #[bits(464..=467)]
    pub organ_b_drawbar_1: Drawbar,
    #[bits(468..=472)]
    pub organ_b_drawbar_1_wheel: DrawbarMorph,
    #[bits(473..=477)]
    pub organ_b_drawbar_1_aftertouch: DrawbarMorph,
    #[bits(478..=482)]
    pub organ_b_drawbar_1_ctrl_pedal: DrawbarMorph,
    #[bits(483..=486)]
    pub organ_b_drawbar_2: Drawbar,
    #[bits(487..=491)]
    pub organ_b_drawbar_2_wheel: DrawbarMorph,
    #[bits(492..=496)]
    pub organ_b_drawbar_2_aftertouch: DrawbarMorph,
    #[bits(497..=501)]
    pub organ_b_drawbar_2_ctrl_pedal: DrawbarMorph,
    #[bits(502..=505)]
    pub organ_b_drawbar_3: Drawbar,
    #[bits(506..=510)]
    pub organ_b_drawbar_3_wheel: DrawbarMorph,
    #[bits(511..=515)]
    pub organ_b_drawbar_3_aftertouch: DrawbarMorph,
    #[bits(516..=520)]
    pub organ_b_drawbar_3_ctrl_pedal: DrawbarMorph,
    #[bits(521..=524)]
    pub organ_b_drawbar_4: Drawbar,
    #[bits(525..=529)]
    pub organ_b_drawbar_4_wheel: DrawbarMorph,
    #[bits(530..=534)]
    pub organ_b_drawbar_4_aftertouch: DrawbarMorph,
    #[bits(535..=539)]
    pub organ_b_drawbar_4_ctrl_pedal: DrawbarMorph,
    #[bits(540..=543)]
    pub organ_b_drawbar_5: Drawbar,
    #[bits(544..=548)]
    pub organ_b_drawbar_5_wheel: DrawbarMorph,
    #[bits(549..=553)]
    pub organ_b_drawbar_5_aftertouch: DrawbarMorph,
    #[bits(554..=558)]
    pub organ_b_drawbar_5_ctrl_pedal: DrawbarMorph,
    #[bits(559..=562)]
    pub organ_b_drawbar_6: Drawbar,
    #[bits(563..=567)]
    pub organ_b_drawbar_6_wheel: DrawbarMorph,
    #[bits(568..=572)]
    pub organ_b_drawbar_6_aftertouch: DrawbarMorph,
    #[bits(573..=577)]
    pub organ_b_drawbar_6_ctrl_pedal: DrawbarMorph,
    #[bits(578..=581)]
    pub organ_b_drawbar_7: Drawbar,
    #[bits(582..=586)]
    pub organ_b_drawbar_7_wheel: DrawbarMorph,
    #[bits(587..=591)]
    pub organ_b_drawbar_7_aftertouch: DrawbarMorph,
    #[bits(592..=596)]
    pub organ_b_drawbar_7_ctrl_pedal: DrawbarMorph,
    #[bits(597..=600)]
    pub organ_b_drawbar_8: Drawbar,
    #[bits(601..=605)]
    pub organ_b_drawbar_8_wheel: DrawbarMorph,
    #[bits(606..=610)]
    pub organ_b_drawbar_8_aftertouch: DrawbarMorph,
    #[bits(611..=615)]
    pub organ_b_drawbar_8_ctrl_pedal: DrawbarMorph,
    #[bits(616..=619)]
    pub organ_b_drawbar_9: Drawbar,
    #[bits(620..=624)]
    pub organ_b_drawbar_9_wheel: DrawbarMorph,
    #[bits(625..=629)]
    pub organ_b_drawbar_9_aftertouch: DrawbarMorph,
    #[bits(630..=634)]
    pub organ_b_drawbar_9_ctrl_pedal: DrawbarMorph,
    #[bits(656..=656)]
    pub organ_b_vib_chorus_enabled: bool,
    #[bits(657..=657)]
    pub organ_b_percussion_enabled: bool,
    #[bits(658..=658)]
    pub organ_b_percussion_harmonic_3rd_enabled: bool,
    #[bits(659..=659)]
    pub organ_b_percussion_decay_fast_enabled: bool,
    #[bits(660..=660)]
    pub organ_b_percussion_volume_soft_enabled: bool,

    /// The organ section's effects chain.
    #[at(85..137)]
    pub organ_fx: FxChain,
}

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