1 // Copyright 2012 Olivier Gillet.
2 //
3 // Author: Olivier Gillet (ol.gillet@gmail.com)
4 //
5 // Permission is hereby granted, free of charge, to any person obtaining a copy
6 // of this software and associated documentation files (the "Software"), to deal
7 // in the Software without restriction, including without limitation the rights
8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 // copies of the Software, and to permit persons to whom the Software is
10 // furnished to do so, subject to the following conditions:
11 //
12 // The above copyright notice and this permission notice shall be included in
13 // all copies or substantial portions of the Software.
14 //
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 // THE SOFTWARE.
22 //
23 // See http://creativecommons.org/licenses/MIT/ for more information.
24 //
25 // -----------------------------------------------------------------------------
26 //
27 // Settings
28
29 #include "braids/settings.h"
30
31 #include <cstring>
32
33 #include "stmlib/system/storage.h"
34 #include "stmlib/utils/murmurhash3.h"
35
36 namespace braids {
37
38 using namespace stmlib;
39
40 const SettingsData kInitSettings = {
41 MACRO_OSC_SHAPE_CSAW,
42
43 RESOLUTION_16_BIT,
44 SAMPLE_RATE_96K,
45
46 0, // AD->timbre
47 false, // Trig source
48 1, // Trig delay
49 false, // Meta modulation
50
51 PITCH_RANGE_EXTERNAL,
52 2,
53 0, // Quantizer is off
54 false,
55 false,
56 false,
57
58 2, // Brightness
59 0, // AD attack
60 5, // AD decay
61 0, // AD->FM
62 0, // AD->COLOR
63 0, // AD->VCA
64 0, // Quantizer root
65
66 50,
67 15401,
68 2048,
69 "GREETINGS FROM MUTABLE INSTRUMENTS *EDIT ME*",
70 };
71
72 Storage<0x8020000, 4> storage;
73
Init()74 void Settings::Init() {
75 if (!storage.ParsimoniousLoad(&data_, &version_token_)) {
76 Reset();
77 }
78 bool settings_within_range = true;
79 for (int32_t i = 0; i <= SETTING_LAST_EDITABLE_SETTING; ++i) {
80 const Setting setting = static_cast<Setting>(i);
81 const SettingMetadata& setting_metadata = metadata(setting);
82 uint8_t value = GetValue(setting);
83 settings_within_range = settings_within_range && \
84 value >= setting_metadata.min_value && \
85 value <= setting_metadata.max_value;
86 }
87 settings_within_range = settings_within_range && data_.magic_byte == 'M';
88 if (!settings_within_range) {
89 Reset();
90 }
91 CheckPaques();
92 }
93
Reset()94 void Settings::Reset() {
95 memcpy(&data_, &kInitSettings, sizeof(SettingsData));
96 data_.magic_byte = 'M';
97 }
98
Save()99 void Settings::Save() {
100 data_.magic_byte = 'M';
101 storage.ParsimoniousSave(data_, &version_token_);
102 CheckPaques();
103 }
104
CheckPaques()105 void Settings::CheckPaques() {
106 paques_ = !strcmp(data_.marquee_text, "49");
107 }
108
109 const char* const boolean_values[] = { "OFF ", "ON " };
110 const char* const intensity_values[] = {
111 "OFF ",
112 " 1",
113 " 2",
114 " 3",
115 "FULL" };
116
117 const char* const zero_to_fifteen_values[] = {
118 " 0",
119 " 1",
120 " 2",
121 " 3",
122 " 4",
123 " 5",
124 " 6",
125 " 7",
126 " 8",
127 " 9",
128 " 10",
129 " 11",
130 " 12",
131 " 13",
132 " 14",
133 " 15"};
134
135 const char* const algo_values[] = {
136 "CSAW",
137 "^\x88\x8D_",
138 "\x88\x8A\x8C\x8D",
139 "FOLD",
140 "\x8E\x8E\x8E\x8E",
141 "SYN\x8C",
142 "SYN\x88",
143 "\x88\x88x3",
144 "\x8C_x3",
145 "/\\x3",
146 "SIx3",
147 "RING",
148 "\x88\x89\x88\x89",
149 "\x88\x88\x8E\x8E",
150 "TOY*",
151 "ZLPF",
152 "ZPKF",
153 "ZBPF",
154 "ZHPF",
155 "VOSM",
156 "VOWL",
157 "VFOF",
158 "HARM",
159 "FM ",
160 "FBFM",
161 "WTFM",
162 "PLUK",
163 "BOWD",
164 "BLOW",
165 "FLUT",
166 "BELL",
167 "DRUM",
168 "KICK",
169 "CYMB",
170 "SNAR",
171 "WTBL",
172 "WMAP",
173 "WLIN",
174 "WTx4",
175 "NOIS",
176 "TWNQ",
177 "CLKN",
178 "CLOU",
179 "PRTC",
180 "QPSK",
181 // "NAME" // For your algorithm
182 };
183
184 const char* const bits_values[] = {
185 "2BIT",
186 "3BIT",
187 "4BIT",
188 "6BIT",
189 "8BIT",
190 "12B",
191 "16B " };
192
193 const char* const rates_values[] = {
194 "4KHZ",
195 "8KHZ",
196 "16K ",
197 "24K ",
198 "32K ",
199 "48K ",
200 "96K " };
201
202 const char* const quantization_values[] = {
203 "OFF ",
204 "SEMI",
205 "IONI",
206 "DORI",
207 "PHRY",
208 "LYDI",
209 "MIXO",
210 "AEOL",
211 "LOCR",
212 "BLU+",
213 "BLU-",
214 "PEN+",
215 "PEN-",
216 "FOLK",
217 "JAPA",
218 "GAME",
219 "GYPS",
220 "ARAB",
221 "FLAM",
222 "WHOL",
223 "PYTH",
224 "EB/4",
225 "E /4",
226 "EA/4",
227 "BHAI",
228 "GUNA",
229 "MARW",
230 "SHRI",
231 "PURV",
232 "BILA",
233 "YAMA",
234 "KAFI",
235 "BHIM",
236 "DARB",
237 "RAGE",
238 "KHAM",
239 "MIMA",
240 "PARA",
241 "RANG",
242 "GANG",
243 "KAME",
244 "PAKA",
245 "NATB",
246 "KAUN",
247 "BAIR",
248 "BTOD",
249 "CHAN",
250 "KTOD",
251 "JOGE" };
252
253 const char* const trig_source_values[] = { "EXT.", "AUTO" };
254
255 const char* const pitch_range_values[] = {
256 "EXT.",
257 "FREE",
258 "XTND",
259 "440 ",
260 "LFO "
261 };
262
263 const char* const octave_values[] = { "-2", "-1", "0", "1", "2" };
264
265 const char* const trig_delay_values[] = {
266 "NONE",
267 "125u",
268 "250u",
269 "500u",
270 "1ms ",
271 "2ms ",
272 "4ms "
273 };
274
275 const char* const brightness_values[] = {
276 "\xff ",
277 "\xff\xff ",
278 "\xff\xff\xff\xff",
279 };
280
281 const char* const note_values[] = {
282 "C",
283 "Db",
284 "D",
285 "Eb",
286 "E",
287 "F",
288 "Gb",
289 "G",
290 "Ab",
291 "A",
292 "Bb",
293 "B",
294 };
295
296 /* static */
297 const SettingMetadata Settings::metadata_[] = {
298 { 0, MACRO_OSC_SHAPE_LAST - 2, "WAVE", algo_values },
299 { 0, RESOLUTION_LAST - 1, "BITS", bits_values },
300 { 0, SAMPLE_RATE_LAST - 1, "RATE", rates_values },
301 { 0, 15, "\x8F""TIM", zero_to_fifteen_values },
302 { 0, 1, "TSRC", trig_source_values },
303 { 0, 6, "TDLY", trig_delay_values },
304 { 0, 1, "META", boolean_values },
305 { 0, 3, "RANG", pitch_range_values },
306 { 0, 4, "OCTV", octave_values },
307 { 0, 48, "QNTZ", quantization_values },
308 { 0, 1, "FLAT", boolean_values },
309 { 0, 4, "DRFT", intensity_values },
310 { 0, 4, "SIGN", intensity_values },
311 { 0, 2, "BRIG", brightness_values },
312 { 0, 15, "\x8F""ATT", zero_to_fifteen_values },
313 { 0, 15, "\x8F""DEC", zero_to_fifteen_values },
314 { 0, 15, "\x8F""FM ", zero_to_fifteen_values },
315 { 0, 15, "\x8F""COL", zero_to_fifteen_values },
316 { 0, 1, "\x8F""VCA", boolean_values },
317 { 0, 11, "ROOT", note_values },
318 { 0, 0, "CAL.", NULL },
319 { 0, 0, " ", NULL }, // Placeholder for CV tester
320 { 0, 0, " ", NULL }, // Placeholder for marquee
321 { 0, 0, "v1.8", NULL }, // Placeholder for version string
322 };
323
324 /* static */
325 const Setting Settings::settings_order_[] = {
326 SETTING_OSCILLATOR_SHAPE,
327 SETTING_META_MODULATION,
328 SETTING_RESOLUTION,
329 SETTING_SAMPLE_RATE,
330 SETTING_TRIG_SOURCE,
331 SETTING_TRIG_DELAY,
332 SETTING_AD_ATTACK,
333 SETTING_AD_DECAY,
334 SETTING_AD_FM,
335 SETTING_AD_TIMBRE,
336 SETTING_AD_COLOR,
337 SETTING_AD_VCA,
338 SETTING_PITCH_RANGE,
339 SETTING_PITCH_OCTAVE,
340 SETTING_QUANTIZER_SCALE,
341 SETTING_QUANTIZER_ROOT,
342 SETTING_VCO_FLATTEN,
343 SETTING_VCO_DRIFT,
344 SETTING_SIGNATURE,
345 SETTING_BRIGHTNESS,
346 SETTING_CALIBRATION,
347 SETTING_CV_TESTER,
348 SETTING_MARQUEE,
349 SETTING_VERSION,
350 };
351
352 /* extern */
353 Settings settings;
354
355 } // namespace braids
356