relative levels for grid/arc led functions (#1873)

* quick test

* add remaining functions

* clang-format

Author: tehn

lua/core/arc.lua

@@ -83,15 +83,17 @@ function Arc.remove(dev) end
 --- set state of single LED on this arc device.
 -- @tparam integer ring : ring index (1-based!)
 -- @tparam integer x : led index (1-based!)
--- @tparam integer val : LED brightness in [0, 15]
-function Arc:led(ring, x, val)
-  _norns.arc_set_led(self.dev, ring, x, val)
+-- @tparam integer val : LED brightness level in [0, 15]
+-- @tparam bool rel: relative brightness (add to existing level)
+function Arc:led(ring, x, val, rel)
+  _norns.arc_set_led(self.dev, ring, x, val, rel)
 end
 
 --- set state of all LEDs on this arc device.
--- @tparam integer val : LED brightness in [0, 15]
-function Arc:all(val)
-  _norns.arc_all_led(self.dev, val)
+-- @tparam integer val : LED brightness level in [0, 15]
+-- @tparam bool rel: relative brightness (add to existing level)
+function Arc:all(val, rel)
+  _norns.arc_all_led(self.dev, val, rel)
 end
 
 --- update any dirty quads on this arc device.
@@ -106,7 +108,8 @@ end
 -- @tparam number from : from angle in radians
 -- @tparam number to : to angle in radians
 -- @tparam integer level : LED brightness in [0, 15]
-function Arc:segment(ring, from, to, level)
+-- @tparam bool rel: relative brightness (add to existing level)
+function Arc:segment(ring, from, to, level, rel)
   local tau = math.pi * 2
 
   local function overlap(a, b, c, d)
@@ -137,7 +140,7 @@ function Arc:segment(ring, from, to, level)
 
     local o = overlap_segments(from, to, sa, sb)
     m[i] = util.round(o / sl * level)
-    self:led(ring, i, m[i])
+    self:led(ring, i, m[i], rel)
   end
 end
 

lua/core/grid.lua

@@ -105,15 +105,17 @@ end
 --- set state of single LED on this grid device.
 -- @tparam integer x : column index (1-based!)
 -- @tparam integer y : row index (1-based!)
--- @tparam integer val : LED brightness in [0, 15]
-function Grid:led(x, y, val)
-  _norns.grid_set_led(self.dev, x, y, val)
+-- @tparam integer val : LED brightness level in [0, 15]
+-- @tparam bool rel: relative brightness (add to existing level)
+function Grid:led(x, y, val, rel)
+  _norns.grid_set_led(self.dev, x, y, val, rel)
 end
 
 --- set state of all LEDs on this grid device.
--- @tparam integer val : LED brightness in [0, 15]
-function Grid:all(val)
-  _norns.grid_all_led(self.dev, val)
+-- @tparam integer val : LED brightness level in [0, 15]
+-- @tparam bool rel: relative brightness (add to existing level)
+function Grid:all(val, rel)
+  _norns.grid_all_led(self.dev, val, rel)
 end
 
 --- update any dirty quads on this grid device.

matron/src/device/device_monome.c

@@ -14,6 +14,10 @@
 #include "device.h"
 #include "device_monome.h"
 
+#define clamp_upper(value, max) ((value) < (max) ? (value) : (max))
+#define clamp_lower(value, min) ((value) > (min) ? (value) : (min))
+#define clamp_range(value, min, max) clamp_lower(min, clamp_upper(value, max))
+
 // quad offset defaults
 static const int quad_xoff[] = {0, 8, 0, 8};
 static const int quad_yoff[] = {0, 0, 8, 8};
@@ -122,25 +126,41 @@ void dev_monome_tilt_disable(struct dev_monome *md, uint8_t sensor) {
 }
 
 // set a given LED value
-void dev_monome_grid_set_led(struct dev_monome *md, uint8_t x, uint8_t y, uint8_t val) {
+void dev_monome_grid_set_led(struct dev_monome *md, uint8_t x, uint8_t y, int8_t val, bool rel) {
     uint8_t q = dev_monome_quad_idx(x, y);
-    md->data[q][dev_monome_quad_offset(x, y)] = val;
+    if (rel) {
+        md->data[q][dev_monome_quad_offset(x, y)] =
+            clamp_range(md->data[q][dev_monome_quad_offset(x, y)] + val, 0, 15);
+    } else
+        md->data[q][dev_monome_quad_offset(x, y)] = val;
     md->dirty[q] = true;
 }
 
 // set a given LED value
-void dev_monome_arc_set_led(struct dev_monome *md, uint8_t n, uint8_t x, uint8_t val) {
-    md->data[n & 3][x & 63] = val;
+void dev_monome_arc_set_led(struct dev_monome *md, uint8_t n, uint8_t x, int8_t val, bool rel) {
+    if (rel)
+        md->data[n & 3][x & 63] = clamp_range(md->data[n & 3][x & 63] + val, 0, 15);
+    else
+        md->data[n & 3][x & 63] = val;
     md->dirty[n & 3] = true;
 }
 
 // set all LEDs to value
-void dev_monome_all_led(struct dev_monome *md, uint8_t val) {
-    for (uint8_t q = 0; q < md->quads; q++) {
-        for (uint8_t i = 0; i < 64; i++) {
-            md->data[q][i] = val;
+void dev_monome_all_led(struct dev_monome *md, int8_t val, bool rel) {
+    if (rel) {
+        for (uint8_t q = 0; q < md->quads; q++) {
+            for (uint8_t i = 0; i < 64; i++) {
+                md->data[q][i] = clamp_range(md->data[q][i] + val, 0, 15);
+            }
+            md->dirty[q] = true;
+        }
+    } else {
+        for (uint8_t q = 0; q < md->quads; q++) {
+            for (uint8_t i = 0; i < 64; i++) {
+                md->data[q][i] = val;
+            }
+            md->dirty[q] = true;
         }
-        md->dirty[q] = true;
     }
 }
 

matron/src/device/device_monome.h

@@ -27,11 +27,11 @@ struct dev_monome {
 };
 
 // set a single grid led
-extern void dev_monome_grid_set_led(struct dev_monome *md, uint8_t x, uint8_t y, uint8_t val);
+extern void dev_monome_grid_set_led(struct dev_monome *md, uint8_t x, uint8_t y, int8_t val, bool rel);
 // set a single arc led
-extern void dev_monome_arc_set_led(struct dev_monome *md, uint8_t n, uint8_t x, uint8_t val);
+extern void dev_monome_arc_set_led(struct dev_monome *md, uint8_t n, uint8_t x, int8_t val, bool rel);
 // set all led
-extern void dev_monome_all_led(struct dev_monome *md, uint8_t val);
+extern void dev_monome_all_led(struct dev_monome *md, int8_t val, bool rel);
 // set all data for a quad
 extern void dev_monome_set_quad(struct dev_monome *md, uint8_t quad, uint8_t *data);
 // transmit data for all dirty quads

matron/src/weaver.c

@@ -1764,25 +1764,27 @@ int _midi_clock_receive(lua_State *l) {
  * @param z level (0-15)
  */
 int _grid_set_led(lua_State *l) {
-    lua_check_num_args(4);
+    lua_check_num_args(5);
     luaL_checktype(l, 1, LUA_TLIGHTUSERDATA);
     struct dev_monome *md = lua_touserdata(l, 1);
     int x = (int)luaL_checkinteger(l, 2) - 1; // convert from 1-base
     int y = (int)luaL_checkinteger(l, 3) - 1; // convert from 1-base
     int z = (int)luaL_checkinteger(l, 4);     // don't convert value!
-    dev_monome_grid_set_led(md, x, y, z);
+    bool rel = lua_toboolean(l, 5);
+    dev_monome_grid_set_led(md, x, y, z, rel);
     lua_settop(l, 0);
     return 0;
 }
 
 int _arc_set_led(lua_State *l) {
-    lua_check_num_args(4);
+    lua_check_num_args(5);
     luaL_checktype(l, 1, LUA_TLIGHTUSERDATA);
     struct dev_monome *md = lua_touserdata(l, 1);
     int n = (int)luaL_checkinteger(l, 2) - 1; // convert from 1-base
     int x = (int)luaL_checkinteger(l, 3) - 1; // convert from 1-base
     int val = (int)luaL_checkinteger(l, 4);   // don't convert value!
-    dev_monome_arc_set_led(md, n, x, val);
+    bool rel = lua_toboolean(l, 5);
+    dev_monome_arc_set_led(md, n, x, val, rel);
     lua_settop(l, 0);
     return 0;
 }
@@ -1794,11 +1796,12 @@ int _arc_set_led(lua_State *l) {
  * @param z level (0-15)
  */
 int _grid_all_led(lua_State *l) {
-    lua_check_num_args(2);
+    lua_check_num_args(3);
     luaL_checktype(l, 1, LUA_TLIGHTUSERDATA);
     struct dev_monome *md = lua_touserdata(l, 1);
     int z = (int)luaL_checkinteger(l, 2); // don't convert value!
-    dev_monome_all_led(md, z);
+    bool rel = lua_toboolean(l, 3);
+    dev_monome_all_led(md, z, rel);
     lua_settop(l, 0);
     return 0;
 }