-
Notifications
You must be signed in to change notification settings - Fork 2
/
mod.lua
executable file
·559 lines (442 loc) · 17.1 KB
/
mod.lua
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
local MOD_NAME = 'gridkeys'
local mod = require 'core/mods'
local script = require 'core/script'
local tabutil = require 'tabutil'
local music = require 'musicutil'
local nb = include(MOD_NAME .. "/lib/nb/lib/nb")
local grid = util.file_exists(_path.code.."midigrid") and include "midigrid/lib/midigrid" or grid
local midiutils = include(MOD_NAME .. "/lib/midiutils")
local grid_utils = require(MOD_NAME .. '/lib/grid_utils')
local Q7GridKeys = require(MOD_NAME .. '/lib/Q7GridKeys')
-- -------------------------------------------------------------------------
-- utils: core
local function tab_save(t, filepath)
local file, err = io.open(filepath, "wb")
if err then return err end
file:write("return "..inspect(t))
file:close()
end
local function tab_copy(t)
local u = { }
for k, v in pairs(t) do u[k] = v end
return setmetatable(u, getmetatable(t))
end
local function clone_function(fn)
local dumped=string.dump(fn)
local cloned=load(dumped)
local i=1
while true do
local name=debug.getupvalue(fn,i)
if not name then
break
end
debug.upvaluejoin(cloned,i,fn,i)
i=i+1
end
return cloned
end
local function bool_as_str(v)
return v and "true" or "false"
end
-- -------------------------------------------------------------------------
-- consts
local OFF_ON = {"off", "on"}
local ON_OFF = {"on", "off"}
-- -------------------------------------------------------------------------
-- state
local gridkeys_modes = {'basic', 'q7'}
local default_mode = 2
local init_state = {
grid_device = nil,
script_uses_grid = false,
midi_in_devices = {},
midi_out_device = nil,
active_notes = {},
}
GRIDKEYS_STATE = tab_copy(init_state)
local function is_gridkeys_on()
if not GRIDKEYS_STATE.grid_device then
return false
end
return ( GRIDKEYS_STATE.grid_device.gridkeys_on == true )
end
-- -------------------------------------------------------------------------
-- grid key cb - basic
local function basic_grid_key(x, y, z)
local note_num = util.clamp(((7 - y) * 5) + x + 33, 0, 127)
local midi_d_is_active = false
if z == 1 then
midi_d_is_active = midiutils.note_on(GRIDKEYS_STATE, note_num, params:get("gridkeys_velocity"), params:get("gridkeys_midi_virtual_channel"))
if midi_d_is_active then
GRIDKEYS_STATE.grid_device.og_led(GRIDKEYS_STATE.grid_device, x, y, 15)
end
else
midi_d_is_active = midiutils.note_off(GRIDKEYS_STATE, note_num, params:get("gridkeys_midi_virtual_channel"))
if midi_d_is_active then
GRIDKEYS_STATE.grid_device.og_led(GRIDKEYS_STATE.grid_device, x, y, 0)
end
end
if midi_d_is_active then
GRIDKEYS_STATE.grid_device.og_refresh(GRIDKEYS_STATE.grid_device)
end
end
-- -------------------------------------------------------------------------
-- grid key cb - q7
local q7gridkeys
local q7gridkeys_default_layout_mode = 2
local gridNbLevels = 15
local q7_is_affecting = false
local function init_q7gridkeys()
-- GRIDKEYS_STATE.grid_device.nb_levels = grid_utils.nb_levels(GRIDKEYS_STATE.grid_device)
-- q7gridkeys = Q7GridKeys.new(GRIDKEYS_STATE.grid_device.cols,GRIDKEYS_STATE.grid_device.rows)
-- NB: we set dumy values for dimensions & will update them later
-- we need to set it to the largest dimesion we would support as `Q7GridKeys` allocates buffers of the size of what we pass it
q7gridkeys = Q7GridKeys.new(32, 32)
q7gridkeys.id = 1
q7gridkeys.midi_device = 1
q7gridkeys.midi_channel = 1 -- unused
q7gridkeys.sound_mode = 2 -- MIDI
q7gridkeys.note_on = q7grid_note_on
q7gridkeys.note_off = q7grid_note_off
q7gridkeys.key_pushed = q7grid_key_pushed
q7gridkeys.layout_mode = q7gridkeys_default_layout_mode
-- all_gridSeqs[i] = Q7GridSeq.new(q7gridkeys)
-- q7gridkeys.gridSeq = all_gridSeqs[i]
-- all_gridSeqs[i].on_pat_changed = gridSeq_pat_changed
end
local function q7grid_redraw()
-- NB: see `GridPlay.grid_redraw`
GRIDKEYS_STATE.grid_device.og_all(GRIDKEYS_STATE.grid_device, 0)
-- GRIDKEYS_STATE.grid_device.nb_levels = grid_utils.nb_levels(GRIDKEYS_STATE.grid_device)
local toolbar_btn_brightness = 6
if GRIDKEYS_STATE.grid_device.nb_levels == 1 then
toolbar_btn_brightness = 15
end
q7gridkeys:draw_grid(GRIDKEYS_STATE.grid_device, q7_is_affecting)
-- toolbar
GRIDKEYS_STATE.grid_device.og_led(GRIDKEYS_STATE.grid_device, GRIDKEYS_STATE.grid_device.cols - 1, GRIDKEYS_STATE.grid_device.rows, toolbar_btn_brightness) -- down
GRIDKEYS_STATE.grid_device.og_led(GRIDKEYS_STATE.grid_device, GRIDKEYS_STATE.grid_device.cols, GRIDKEYS_STATE.grid_device.rows, toolbar_btn_brightness) -- up
GRIDKEYS_STATE.grid_device.og_refresh(GRIDKEYS_STATE.grid_device)
end
local function q7grid_key(x, y, z)
-- NB: see `GridPlay.grid_key`
if y == GRIDKEYS_STATE.grid_device.rows and x == GRIDKEYS_STATE.grid_device.cols - 1 then
if (z == 1) then
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
q7gridkeys:scroll_down()
end
elseif y == GRIDKEYS_STATE.grid_device.rows and x == GRIDKEYS_STATE.grid_device.cols then
if (z == 1) then
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
q7gridkeys:scroll_up()
end
else
q7gridkeys:grid_key(x,y,z)
end
q7grid_redraw()
GRIDKEYS_STATE.grid_device.og_refresh(GRIDKEYS_STATE.grid_device)
end
function q7grid_note_on(gKeys, noteNum, vel)
-- print("Note On: " .. noteNum.. " " .. vel .. " " .. music.note_num_to_name(noteNum))
if gKeys.sound_mode == 2 then -- midi out
q7_is_affecting = midiutils.note_on(GRIDKEYS_STATE, noteNum, params:get("gridkeys_velocity"), params:get("gridkeys_midi_virtual_channel"))
end
end
function q7grid_note_off(gKeys, noteNum)
-- print("Note Off: " .. noteNum .. " " .. music.note_num_to_name(noteNum))
if gKeys.sound_mode == 2 then
midiutils.note_off(GRIDKEYS_STATE, noteNum, params:get("gridkeys_midi_virtual_channel"))
end
end
function q7grid_key_pushed(gKeys, noteNum, vel)
return
end
function change_q7gridkeys_layout(new_layout_mode)
-- NB: see `change_gridKey_layout`
-- gridKeys.layout_mode = (gridKeys.layout_mode == 1) and 2 or 1
-- new_layout_mode = new_layout_mode or ((q7gridkeys.layout_mode % 3) + 1)
new_layout_mode = new_layout_mode or q7gridkeys.layout_mode
q7gridkeys.layout_mode = new_layout_mode
if q7gridkeys.layout_mode == 3 then
q7gridkeys:zero_vertical_offset()
end
-- if q7gridkeys.sound_mode == 2 then
-- all_midi_notes_off(q7gridkeys.midi_device)
-- end
end
-- -------------------------------------------------------------------------
-- grid key cb
local function grid_key(x, y, z)
if params:string("gridkeys_mode") == 'basic' then
basic_grid_key(x, y, z)
else
q7grid_key(x, y, z)
end
end
-- -------------------------------------------------------------------------
-- state - grid fns
local function snapshot_og_grid_fns(g)
-- methods
g.og_all = clone_function(g.all)
if g.intensity ~= nil then
g.og_intensity = clone_function(g.intensity)
else
-- NB: workaround for `midigrid`
g.og_intensity = function(...) end
end
g.og_led = clone_function(g.led)
g.og_refresh = clone_function(g.refresh)
end
local function remove_snapshoted_grid_fns(g)
-- methods
g.og_all = nil
g.og_intensity = nil
g.og_led = nil
g.og_refresh = nil
-- callbacks
g.og_key = nil
end
local function restore_og_grid_fns(g)
if not g.og_all then
return
end
-- methods
g.all = g.og_all
g.intensity = g.og_intensity
g.led = g.og_led
g.refresh = g.og_refresh
-- callbacks
g.key = g.og_key
end
local function gridkeys_takeover(g)
g.all = function(...) end
g.intensity = function(...) end
g.led = function(...) end
g.refresh = function(...) end
g.key = grid_key
g.gridkeys_on = true
end
-- -------------------------------------------------------------------------
-- state - grid fns
local function set_gridkeys(status)
print("mod - gridkeys - SET_GRIDKEYS = "..bool_as_str(status))
if not grid_utils.valid(GRIDKEYS_STATE.grid_device) then
print("mod - gridkeys - SET_GRIDKEYS - no grid -> ABORT")
return
end
if not GRIDKEYS_STATE.grid_device.og_all then
print('status='..bool_as_str(status))
tab.print(GRIDKEYS_STATE.grid_device)
end
GRIDKEYS_STATE.grid_device.og_all(GRIDKEYS_STATE.grid_device, 0)
GRIDKEYS_STATE.grid_device.og_refresh(GRIDKEYS_STATE.grid_device)
if status == false then
if is_gridkeys_on() then
restore_og_grid_fns(GRIDKEYS_STATE.grid_device)
GRIDKEYS_STATE.grid_device.gridkeys_on = nil
else
print("mod - gridkeys - SET_GRIDKEYS -> NO CHANGE")
end
else
if not is_gridkeys_on() then
-- print("ACTIVATE GRIDKEYS")
gridkeys_takeover(GRIDKEYS_STATE.grid_device)
GRIDKEYS_STATE.grid_device.gridkeys_on = true
if params:string("gridkeys_mode") == 'q7' then
q7grid_redraw()
end
else
print("mod - gridkeys - SET_GRIDKEYS -> NO CHANGE")
end
end
end
local function enable_gridkeys()
set_gridkeys(true)
end
local function disable_gridkeys()
set_gridkeys(false)
end
local function associate_grid(g)
if grid_utils.valid(g) then
g.nb_levels = grid_utils.nb_levels(g)
q7gridkeys.grid_width = g.cols
q7gridkeys.grid_height = g.rows
snapshot_og_grid_fns(g)
end
end
local function unassociate_grid(g)
restore_og_grid_fns(g)
remove_snapshoted_grid_fns(g)
g.gridkeys_on = nil
end
-- -------------------------------------------------------------------------
-- main
local function init_params()
params:add_separator("mod_gridkeys", "gridkeys")
params:add_option("gridkeys_active", "gridkeys active", OFF_ON,
GRIDKEYS_STATE.script_uses_grid and tab.key(OFF_ON, "off") or tab.key(OFF_ON, "on"))
params:set_action("gridkeys_active",
function(v)
set_gridkeys(OFF_ON[v] == "on")
end)
params:add{ type = "number", id = "gridkeys_grid", name = "grid", min = 1, max = 4, default = 1,
formatter = function(param)
local v = param:get()
return grid_utils.shortname(grid.connect(v)) .. " - " .. v
end}
params:set_action("gridkeys_grid",
function(v)
if not GRIDKEYS_STATE.done_init then
return
end
if GRIDKEYS_STATE.grid_device then
disable_gridkeys()
unassociate_grid(GRIDKEYS_STATE.grid_device)
end
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
GRIDKEYS_STATE.grid_device = grid.connect(v)
associate_grid(GRIDKEYS_STATE.grid_device)
set_gridkeys(params:string("gridkeys_active") == "on")
end)
params:add_option("gridkeys_midi_virtual", "midi virtual", ON_OFF)
params:set_action("gridkeys_midi_virtual",
function(v)
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
if ON_OFF[v] == "on" then
params:show("gridkeys_midi_virtual_channel")
else
params:hide("gridkeys_midi_virtual_channel")
end
_menu.rebuild_params()
end)
params:add{type = "number", id = "gridkeys_midi_virtual_channel", name = "MIDI Out Channel", min = 1, max = 16, default = 1}
params:set_action("gridkeys_midi_virtual_channel",
function(v)
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
end)
nb:add_param("gridkeys_nb_voice", "nb Voice")
params:add{type = "number", id = "gridkeys_velocity", name = "Velocity", min = 1, max = 127, default = 100}
params:add_option("gridkeys_mode", "Mode", gridkeys_modes, default_mode)
params:set_action("gridkeys_mode",
function(v)
local prev_mode = params:string("gridkeys_mode")
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
if prev_mode == 'basic' then
if is_gridkeys_on() then
GRIDKEYS_STATE.grid_device.og_all(GRIDKEYS_STATE.grid_device, 0)
GRIDKEYS_STATE.grid_device.og_refresh(GRIDKEYS_STATE.grid_device)
end
params:hide("gridkeys_q7_layout")
params:hide("gridkeys_q7_scale")
params:hide("gridkeys_q7_root_note")
else
if is_gridkeys_on() then
q7grid_redraw()
end
params:show("gridkeys_q7_layout")
params:show("gridkeys_q7_scale")
params:show("gridkeys_q7_root_note")
end
_menu.rebuild_params()
end)
params:add_option("gridkeys_q7_layout", "Q7 layout", Q7GridKeys.layout_names, q7gridkeys_default_layout_mode)
params:set_action("gridkeys_q7_layout",
function(v)
q7gridkeys.layout_mode = v
change_q7gridkeys_layout()
if params:string("gridkeys_mode") == "q7" then
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
q7grid_redraw()
end
end)
local scale_names = {}
for _, scale in pairs(music.SCALES) do
table.insert(scale_names, scale.name)
end
params:add_option("gridkeys_q7_scale", "Q7 scale", scale_names)
params:set_action("gridkeys_q7_scale",
function(v)
q7gridkeys:change_scale(params:get("gridkeys_q7_root_note"), v)
if params:string("gridkeys_mode") == "q7" then
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
q7grid_redraw()
end
end)
params:add_option("gridkeys_q7_root_note", "Q7 root note", music.NOTE_NAMES)
params:set_action("gridkeys_q7_root_note",
function(v)
q7gridkeys:change_scale(v, params:get("gridkeys_q7_scale"))
if params:string("gridkeys_mode") == "q7" then
midiutils.all_midi_notes_off(GRIDKEYS_STATE)
q7grid_redraw()
end
end)
if gridkeys_modes[default_mode] ~= 'q7' then
params:hide("gridkeys_q7_layout")
params:hide("gridkeys_q7_scale")
params:hide("gridkeys_q7_root_note")
-- _menu.rebuild_params()
end
-- TODO: conditionally add those if script not using nb
nb:add_player_params()
end
-- -------------------------------------------------------------------------
-- mod lifecycle - init
local function default_conf()
local default_conf_file = _path.data .. MOD_NAME .. "/defaults.lua"
if util.file_exists(default_conf_file) then
return dofile(default_conf_file)
end
return {}
end
local function script_init_grid()
local i = params:get("gridkeys_grid")
GRIDKEYS_STATE.grid_device = grid.connect(i)
-- NB: we always mark it as off explicitely to prevent this porperty persisting after a crash (improper mod `cleanup` call)
-- ideally we should not polute each grid object w/ custom fields like that...
GRIDKEYS_STATE.grid_device.gridkeys_on = nil
if not grid_utils.valid(GRIDKEYS_STATE.grid_device) then
print("mod - gridkeys - no grid detected at position "..i)
return
end
-- snapshot_og_grid_fns(GRIDKEYS_STATE.grid_device)
associate_grid(GRIDKEYS_STATE.grid_device)
if GRIDKEYS_STATE.grid_device.key ~= nil then
print("mod - gridkeys - OFF as grid bound by script")
GRIDKEYS_STATE.grid_device.og_key = clone_function(GRIDKEYS_STATE.grid_device.key)
GRIDKEYS_STATE.script_uses_grid = true
else
print("mod - gridkeys - ON as grid is free")
enable_gridkeys()
end
end
-- -------------------------------------------------------------------------
-- mod lifecycle - hooks
--- on script load, conditionally activate gridkeys
mod.hook.register("script_post_init", "gridkeys-script-post-init", function()
print("mod - gridkeys - mod init")
nb.voice_count = 1
nb:init()
local default_conf = default_conf()
init_q7gridkeys()
init_params()
if default_conf['gridkeys_grid'] then
params:set("gridkeys_grid", default_conf['gridkeys_grid'])
end
script_init_grid()
params:set('gridkeys_active', (GRIDKEYS_STATE.script_uses_grid and tab.key(OFF_ON, 'off') or tab.key(OFF_ON, 'on')))
GRIDKEYS_STATE.done_init = true
end)
--- before any script load, restore grid API &
--- NB: appears to get triggered BEFORE loading any script, even if no script previously loaded + when stopping a script (before a `script.clear`)
mod.hook.register("script_post_cleanup", "gridkeys-script-post-cleanup", function()
print("mod - gridkeys - script post cleanup")
for i=1,16 do
local g = grid.connect(i)
if g then
unassociate_grid(g)
end
end
state = tab_copy(init_state)
GRIDKEYS_STATE.done_init = false
end)