Start on TTS support by logging the data that will become TTS lines

Includes some misc cleanup of haptic double-triggering (or non-triggering), since those cases all end up being TTS event double-reporting, which to me crosses the threshold from "annoying" to "usability issue"
2024-05-29 14:45:49 +10:00
parent ef812a53e5
commit 2ff8eac022
18 changed files with 474 additions and 161 deletions
@@ -126,6 +126,7 @@ return screen:new {
      range = { min = 0, max = 100 },
      value = 0,
    }
+    local scrubber_desc = widgets.Description(scrubber, "Scrubber")

    scrubber:onevent(lvgl.EVENT.RELEASED, function()
      local track = playback.track:get()
@@ -165,6 +166,7 @@ return screen:new {
    end)
    local repeat_img = repeat_btn:Image { src = img.repeat_src }
    theme.set_style(repeat_img, icon_enabled_class)
+    local repeat_desc = widgets.Description(repeat_btn)


    local prev_btn = controls:Button {}
@@ -177,6 +179,7 @@ return screen:new {
    end)
    local prev_img = prev_btn:Image { src = img.prev }
    theme.set_style(prev_img, icon_enabled_class)
+    local prev_desc = widgets.Description(prev_btn, "Previous track")

    local play_pause_btn = controls:Button {}
    play_pause_btn:onClicked(function()
@@ -185,11 +188,13 @@ return screen:new {
    play_pause_btn:focus()
    local play_pause_img = play_pause_btn:Image { src = img.pause }
    theme.set_style(play_pause_img, icon_enabled_class)
+    local play_pause_desc = widgets.Description(play_pause_btn, "Play")

    local next_btn = controls:Button {}
    next_btn:onClicked(queue.next)
    local next_img = next_btn:Image { src = img.next }
    theme.set_style(next_img, icon_disabled_class)
+    local next_desc = widgets.Description(next_btn, "Next track")

    local shuffle_btn = controls:Button {}
    shuffle_btn:onClicked(function()
@@ -197,6 +202,7 @@ return screen:new {
    end)
    local shuffle_img = shuffle_btn:Image { src = img.shuffle }
    theme.set_style(shuffle_img, icon_enabled_class)
+    local shuffle_desc = widgets.Description(shuffle_btn)

    controls:Object({ flex_grow = 1, h = 1 }) -- spacer

@@ -205,8 +211,10 @@ return screen:new {
      playback.playing:bind(function(playing)
        if playing then
          play_pause_img:set_src(img.pause)
+          play_pause_desc:set { text = "Pause" }
        else
          play_pause_img:set_src(img.play)
+          play_pause_desc:set { text = "Play" }
        end
      end),
      playback.position:bind(function(pos)
@@ -241,9 +249,19 @@ return screen:new {
      end),
      queue.random:bind(function(shuffling)
        theme.set_style(shuffle_img, shuffling and icon_enabled_class or icon_disabled_class)
+        if shuffling then
+          shuffle_desc:set { text = "Disable shuffle" }
+        else
+          shuffle_desc:set { text = "Enable shuffle" }
+        end
      end),
      queue.repeat_track:bind(function(en)
        theme.set_style(repeat_img, en and icon_enabled_class or icon_disabled_class)
+        if en then
+          repeat_desc:set { text = "Disable track repeat" }
+        else
+          repeat_desc:set { text = "Enable track repeat" }
+        end
      end),
      queue.size:bind(function(num)
        if not num then return end
@@ -10,21 +10,30 @@ local theme = require("theme")
 local screen = require("screen")

 local img = {
-    db = lvgl.ImgData("//lua/img/db.png"),
-    chg = lvgl.ImgData("//lua/img/bat/chg.png"),
-    bat_100 = lvgl.ImgData("//lua/img/bat/100.png"),
-    bat_80 = lvgl.ImgData("//lua/img/bat/80.png"),
-    bat_60 = lvgl.ImgData("//lua/img/bat/60.png"),
-    bat_40 = lvgl.ImgData("//lua/img/bat/40.png"),
-    bat_20 = lvgl.ImgData("//lua/img/bat/20.png"),
-    bat_0 = lvgl.ImgData("//lua/img/bat/0.png"),
-    bat_0chg = lvgl.ImgData("//lua/img/bat/0chg.png"),
-    bt_conn = lvgl.ImgData("//lua/assets/bt_conn.png"),
-    bt = lvgl.ImgData("//lua/assets/bt.png")
+  db = lvgl.ImgData("//lua/img/db.png"),
+  chg = lvgl.ImgData("//lua/img/bat/chg.png"),
+  bat_100 = lvgl.ImgData("//lua/img/bat/100.png"),
+  bat_80 = lvgl.ImgData("//lua/img/bat/80.png"),
+  bat_60 = lvgl.ImgData("//lua/img/bat/60.png"),
+  bat_40 = lvgl.ImgData("//lua/img/bat/40.png"),
+  bat_20 = lvgl.ImgData("//lua/img/bat/20.png"),
+  bat_0 = lvgl.ImgData("//lua/img/bat/0.png"),
+  bat_0chg = lvgl.ImgData("//lua/img/bat/0chg.png"),
+  bt_conn = lvgl.ImgData("//lua/assets/bt_conn.png"),
+  bt = lvgl.ImgData("//lua/assets/bt.png")
 }

 local widgets = {}

+function widgets.Description(obj, text)
+  local label = obj:Label {}
+  if text then
+    label:set { text = text }
+  end
+  label:add_flag(lvgl.FLAG.HIDDEN)
+  return label
+end
+
 widgets.MenuScreen = screen:new {
  show_back = false,
  title = "",
@@ -50,24 +59,24 @@ widgets.MenuScreen = screen:new {
 }

 function widgets.Row(parent, left, right)
-    local container = parent:Object{
-        flex = {
-            flex_direction = "row",
-            justify_content = "flex-start",
-            align_items = "flex-start",
-            align_content = "flex-start"
-        },
-        w = lvgl.PCT(100),
-        h = lvgl.SIZE_CONTENT
-    }
-    container:add_style(styles.list_item)
-    container:Label{
-        text = left,
-        flex_grow = 1
-    }
-    container:Label{
-        text = right
-    }
+  local container = parent:Object {
+    flex = {
+      flex_direction = "row",
+      justify_content = "flex-start",
+      align_items = "flex-start",
+      align_content = "flex-start"
+    },
+    w = lvgl.PCT(100),
+    h = lvgl.SIZE_CONTENT
+  }
+  container:add_style(styles.list_item)
+  container:Label {
+    text = left,
+    flex_grow = 1
+  }
+  container:Label {
+    text = right
+  }
 end

 local bindings_meta = {
@@ -102,7 +111,8 @@ function widgets.StatusBar(parent, opts)
      w = lvgl.SIZE_CONTENT,
      h = 12,
    }
-    back:Label({ text = "<", align = lvgl.ALIGN.CENTER })
+    local label = back:Label({ text = "<", align = lvgl.ALIGN.CENTER })
+    widgets.Description(label, "Back")
    back:onClicked(opts.back_cb)
  end

@@ -125,8 +135,8 @@ function widgets.StatusBar(parent, opts)
  local charge_icon = battery_icon:Image { src = img.chg }
  charge_icon:center()

-    local is_charging = nil
-    local percent = nil
+  local is_charging = nil
+  local percent = nil

  local function update_battery_icon()
    if is_charging == nil or percent == nil then return end
@@ -191,135 +201,138 @@ function widgets.StatusBar(parent, opts)
 end

 function widgets.IconBtn(parent, icon, text)
-    local btn = parent:Button{
-        flex = {
-            flex_direction = "row",
-            justify_content = "flex-start",
-            align_items = "center",
-            align_content = "center"
-        },
-        w = lvgl.SIZE_CONTENT,
-        h = lvgl.SIZE_CONTENT,
-        pad_top = 1,
-        pad_bottom = 1,
-        pad_left = 1,
-        pad_column = 1
-    }
-    btn:Image{
-        src = icon
-    }
-    btn:Label{
-        text = text,
-        text_font = font.fusion_10
-    }
-    return btn
+  local btn = parent:Button {
+    flex = {
+      flex_direction = "row",
+      justify_content = "flex-start",
+      align_items = "center",
+      align_content = "center"
+    },
+    w = lvgl.SIZE_CONTENT,
+    h = lvgl.SIZE_CONTENT,
+    pad_top = 1,
+    pad_bottom = 1,
+    pad_left = 1,
+    pad_column = 1
+  }
+  btn:Image {
+    src = icon
+  }
+  btn:Label {
+    text = text,
+    text_font = font.fusion_10
+  }
+  return btn
 end

 function widgets.InfiniteList(parent, iterator, opts)
-    local infinite_list = {}
+  local infinite_list = {}

-    infinite_list.root = lvgl.List(parent, {
-        w = lvgl.PCT(100),
-        h = lvgl.PCT(100),
-        flex_grow = 1,
-        scrollbar_mode = lvgl.SCROLLBAR_MODE.OFF
-    })
+  infinite_list.root = lvgl.List(parent, {
+    w = lvgl.PCT(100),
+    h = lvgl.PCT(100),
+    flex_grow = 1,
+    scrollbar_mode = lvgl.SCROLLBAR_MODE.OFF
+  })

-    local refreshing = false -- Used so that we can ignore focus events during this phase
-    local function refresh_group() 
-        refreshing = true
-        local group = lvgl.group.get_default()
-        local focused_obj = group:get_focused()
-        local num_children = infinite_list.root:get_child_cnt()
-        -- remove all children from the group and re-add them
-        for i = 0, num_children-1 do
-            lvgl.group.remove_obj(infinite_list.root:get_child(i))
-        end
-        for i = 0, num_children-1 do
-            group:add_obj(infinite_list.root:get_child(i))
-        end
-        if (focused_obj) then
-            lvgl.group.focus_obj(focused_obj)
-        end
-        refreshing = false
+  local refreshing = false -- Used so that we can ignore focus events during this phase
+  local function refresh_group()
+    refreshing = true
+    local group = lvgl.group.get_default()
+    local focused_obj = group:get_focused()
+    local num_children = infinite_list.root:get_child_cnt()
+    if (focused_obj) then
+      group:clear_focus()
    end
-
-    local fwd_iterator = iterator:clone()
-    local bck_iterator = iterator:clone()
-
-    local last_selected = 0
-    local last_index = 0
-    local first_index = 0
-
-    local function remove_top() 
-        local obj = infinite_list.root:get_child(0)
-        obj:delete()
-        first_index = first_index + 1
-        bck_iterator:next()
+    -- remove all children from the group and re-add them
+    for i = 0, num_children - 1 do
+      lvgl.group.remove_obj(infinite_list.root:get_child(i))
    end
-
-    local function remove_last() 
-        local obj = infinite_list.root:get_child(-1)
-        obj:delete()
-        last_index = last_index - 1
-        fwd_iterator:prev()
+    for i = 0, num_children - 1 do
+      group:add_obj(infinite_list.root:get_child(i))
    end
+    if (focused_obj) then
+      lvgl.group.focus_obj(focused_obj)
+    end
+    refreshing = false
+  end

-    local function add_item(item, index)
-        if not item then
-            return
+  local fwd_iterator = iterator:clone()
+  local bck_iterator = iterator:clone()
+
+  local last_selected = 0
+  local last_index = 0
+  local first_index = 0
+
+  local function remove_top()
+    local obj = infinite_list.root:get_child(0)
+    obj:delete()
+    first_index = first_index + 1
+    bck_iterator:next()
+  end
+
+  local function remove_last()
+    local obj = infinite_list.root:get_child(-1)
+    obj:delete()
+    last_index = last_index - 1
+    fwd_iterator:prev()
+  end
+
+  local function add_item(item, index)
+    if not item then
+      return
+    end
+    local this_item = index
+    local add_to_top = false
+    if this_item < first_index then
+      first_index = this_item
+      add_to_top = true
+    end
+    if this_item > last_index then last_index = index end
+    local btn = infinite_list.root:add_btn(nil, tostring(item))
+    if add_to_top then
+      btn:move_to_index(0)
+    end
+    -- opts.callback should take an item and return a function matching the arg of onClicked
+    if opts.callback then
+      btn:onClicked(opts.callback(item))
+    end
+    btn:onevent(lvgl.EVENT.FOCUSED, function()
+      if refreshing then return end
+      if this_item > last_selected and this_item - first_index > 3 then
+        -- moving forward
+        local to_add = fwd_iterator:next()
+        if to_add then
+          remove_top()
+          add_item(to_add, last_index + 1)
        end
-        local this_item = index
-        local add_to_top = false
-        if this_item < first_index then 
-            first_index = this_item 
-            add_to_top = true
-        end
-        if this_item > last_index then last_index = index end
-        local btn = infinite_list.root:add_btn(nil, tostring(item))
-        if add_to_top then
-            btn:move_to_index(0)
-        end
-        -- opts.callback should take an item and return a function matching the arg of onClicked
-        if opts.callback then
-          btn:onClicked(opts.callback(item))
-        end
-        btn:onevent(lvgl.EVENT.FOCUSED, function()
-          if refreshing then return end
-          if this_item > last_selected and this_item - first_index > 3 then
-            -- moving forward
-            local to_add = fwd_iterator:next()
-            if to_add then
-                remove_top()
-                add_item(to_add, last_index+1)
-            end
+      end
+      if this_item < last_selected then
+        -- moving backward
+        if (first_index > 0 and last_index - this_item > 3) then
+          local to_add = bck_iterator:prev();
+          if to_add then
+            remove_last()
+            add_item(to_add, first_index - 1)
+            refresh_group()
          end
-          if this_item < last_selected then
-            -- moving backward
-            if (first_index > 0 and last_index - this_item > 3) then
-                local to_add = bck_iterator:prev();
-                if to_add then
-                  remove_last()
-                  add_item(to_add, first_index-1)
-                  refresh_group()
-                end
-            end
-          end
-          last_selected = this_item
-        end)
-        btn:add_style(styles.list_item)
-        return btn
-    end
-
-    for idx = 0, 8 do
-        local val = fwd_iterator()
-        if not val then
-            break
        end
-        add_item(val, idx)
-    end
+      end
+      last_selected = this_item
+    end)
+    btn:add_style(styles.list_item)
+    return btn
+  end

-    return infinite_list
+  for idx = 0, 8 do
+    local val = fwd_iterator()
+    if not val then
+      break
+    end
+    add_item(val, idx)
+  end
+
+  return infinite_list
 end

 return widgets