defines slider mode nav events

for most of the controls.

needs more testing...

README.md

@@ -6,7 +6,7 @@
 
 A remote control app for [Voicemeeter][voicemeeter], designed to be used with the [NVDA screen reader][nvda].
 
-This is still an early release but it should be usable.
+For an outline of this projects goals see the [SPECIFICATION][spec].
 
 <img src="./img/settings.png" width=350 alt="Image of Voicemeeter NVDA app settings tab">
 
@@ -18,11 +18,31 @@ This is still an early release but it should be usable.
 
 ### Installation
 
-First clone the source files from this repository
+#### `From Source`
 
-`git clone https://github.com/onyx-and-iris/nvda-voicemeeter.git`
+First clone the source files from this repository and install the dependencies.
 
-Then download the [Controller Client][controller_client] and place the files into the directory `controllerClient`.
+```
+git clone https://github.com/onyx-and-iris/nvda-voicemeeter.git
+cd nvda-voicemeeter
+pip install .
+```
+
+Then download the [Controller Client][controller_client] and place the dll files into the directory `controllerClient`.
+
+Your directory structure should look like this:
+
+├── `controllerClient/`
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── `x64/`
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── nvdaControllerClient64.dll
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── `x86/`
+
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── nvdaControllerClient32.dll
+
+#### `From Releases`
 
 If you want to get started quickly and easily I have uploaded some compiled versions of the app in the [Releases][releases] section.
 
@@ -52,24 +72,38 @@ May be one of the following:
 
 ### Use
 
-The app presents four tabs `Settings`, `Physical Strip`, `Virtual Strip` and `Buses`. Navigate between the tabs with `Control + TAB` and `Control + SHIFT + TAB`.
+#### `Tabs`
+
+The app presents four tabs `Settings`, `Physical Strip`, `Virtual Strip` and `Buses`. Navigate between the tabs with `Control + TAB` and `Control + SHIFT + TAB` or once focused on any tab, `Left` and `Right` arrow keys.
 
 All controls within the tabs may be navigated between using `TAB`.
 
+#### `Settings`
+
 The following controls offer context menus accessed by pressing `SPACE` or `ENTER`:
 
 - Hardware In
 - Hardware Out
 - Patch Composite
 
+Press `ESCAPE` to exit any context menu.
+
 All other buttons can be triggered by pressing `SPACE` or `ENTER`.
 
 To adjust Patch Asio Inputs to Strips and Patch Insert values use `UP` and `DOWN` arrows when in focus.
 
+To access Advanced Settings you may press the Advanced Settings button or use `Control + A` when in the `Settings` tab.
+
+#### `Strip/Bus`
+
 To rename a strip/bus channel navigate to the relevant tab, then press `F2`. This will open a popup window where you can set the channel index (with a spinbox) and set the new label using a text input box.
+
 Pressing the `OK` button with an empty text input will clear the label. In this case the label will be read as a default value for that channel. For example, if the leftmost Strip label were cleared, the screen reader will now read `Hardware Input 1`.
+
 Pressing `Cancel` will close the popup window with no affect on the label.
 
+#### `Menu`
+
 A single menu item `Voicemeeter` can be opened using `Alt` and then `v`. The menu allows you to:
 
 - Restart Voicemeeter audio engine
@@ -94,6 +128,7 @@ If you have any questions/suggestions feel free to raise an issue or open a new
 
 [PySimpleGUI](https://github.com/PySimpleGUI) team for creating an awesome GUI framework.
 
+[spec]: ./SPECIFICATION.md
 [voicemeeter]: https://voicemeeter.com/
 [nvda]: https://www.nvaccess.org/
 [controller_client]: https://github.com/nvaccess/nvda/tree/master/extras/controllerClient

SPECIFICATION.md

@@ -0,0 +1,30 @@
+# Software Specification
+
+## Description
+
+A remote control utility for Voicemeeter designed to be used with the NVDA screen reader.
+
+## Requirements
+
+#### Functional Goals
+
+- Parameter updates caused by user input should be read back to the user via the screen reader.
+- When focusing a control the current value for that control should be read back to the user.
+- The application should scale correctly according to each kind of Voicemeeter (basic, banana, potato). This means the following:
+  - Correct number of strips/buses.
+  - Correct number of bus assignments for each strip.
+  - Where certain controls are valid for one kind they may not be for another.
+- Where possible set limits on data entry and keep controls appropriate for the type of parameter.
+
+#### Accessibility Goals
+
+- Every control must be usable with a keyboard.
+- Navigation around the application must be doable with a keyboard.
+- Should use standard Windows controls only.
+
+## Limitations
+
+- May not cover 100% of the Voicemeeter GUI, for example the many EQ parameters.
+- Only designed to work with the NVDA screen reader. Other screen readers not supported.
+- Only the main Voicemeeter GUI supported by this application. No support for Matrix or other Voicemeeter products.
+- Runs on Python version 3.10 or greater.

pdm.lock

@@ -6,7 +6,7 @@ groups = ["default", "build", "lint", "test"]
 cross_platform = true
 static_urls = false
 lock_version = "4.3"
-content_hash = "sha256:9051151ac4ac0edefdfaf52faa91dbff89d8bbc942a6ffa61b6ec6fee502aa8a"
+content_hash = "sha256:ba53368b628b713c9cf4eb54e6f5c5c4af207c8e247d473417e4c2a4b47f645d"
 
 [[package]]
 name = "altgraph"

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nvda_voicemeeter"
-version = "0.1.4"
+version = "0.2.2a1"
 description = "A Voicemeeter app compatible with NVDA"
 authors = [
     { name = "onyx-and-iris", email = "code@onyxandiris.online" },
@@ -10,7 +10,7 @@ dependencies = [
     "pyparsing>=3.1.1",
     "voicemeeter-api>=2.4.9",
 ]
-requires-python = ">=3.10,<3.11"
+requires-python = ">=3.10,<3.12"
 readme = "README.md"
 
 [project.license]

src/nvda_voicemeeter/builder.py

@@ -1,14 +1,7 @@
 import PySimpleGUI as psg
 
-from .util import (
-    get_asio_checkbox_index,
-    get_asio_samples_list,
-    get_input_device_list,
-    get_insert_checkbox_index,
-    get_output_device_list,
-    get_patch_composite_list,
-    get_tabs_labels,
-)
+from . import util
+from .compound import LabelSlider
 
 
 class Builder:
@@ -27,6 +20,7 @@ class Builder:
             steps = (
                 self.make_tab0_row0,
                 self.make_tab0_row1,
+                self.make_tab0_row5,
             )
         else:
             steps = (
@@ -40,25 +34,61 @@ class Builder:
         for step in steps:
             layout0.append([step()])
 
-        layout1 = []
-        steps = (self.make_tab1_rows,)
+        layout1_1 = []
+        steps = (self.make_tab1_button_rows,)
         for step in steps:
-            layout1.append([step()])
-
-        layout2 = []
-        steps = (self.make_tab2_rows,)
+            layout1_1.append([step()])
+        layout1_2 = []
+        steps = (self.make_tab1_slider_rows,)
         for step in steps:
-            layout2.append([step()])
+            layout1_2.append([step()])
 
-        layout3 = []
-        steps = (self.make_tab3_rows,)
+        layout2_1 = []
+        steps = (self.make_tab2_button_rows,)
         for step in steps:
-            layout3.append([step()])
+            layout2_1.append([step()])
+        layout2_2 = []
+        steps = (self.make_tab2_slider_rows,)
+        for step in steps:
+            layout2_2.append([step()])
 
-        layouts = [layout0, layout1, layout2, layout3]
+        layout3_1 = []
+        steps = (self.make_tab3_button_rows,)
+        for step in steps:
+            layout3_1.append([step()])
+        layout3_2 = []
+        steps = (self.make_tab3_slider_rows,)
+        for step in steps:
+            layout3_2.append([step()])
 
-        tabs = [psg.Tab(identifier, layouts[i], key=identifier) for i, identifier in enumerate(get_tabs_labels())]
-        tab_group = psg.TabGroup([tabs], change_submits=True, key="tabs")
+        def _make_inner_tabgroup(layouts, identifier) -> psg.TabGroup:
+            inner_layout = []
+            for i, tabname in enumerate(("buttons", "sliders")):
+                inner_layout.append([psg.Tab(tabname.capitalize(), layouts[i], key=f"tab||{identifier}||{tabname}")])
+            return psg.TabGroup(
+                inner_layout,
+                change_submits=True,
+                enable_events=True,
+                key=f"tabgroup||{identifier}",
+            )
+
+        def _make_tabs(identifier) -> psg.Tab:
+            match identifier:
+                case "Settings":
+                    return psg.Tab("Settings", layout0, key="tab||Settings")
+                case "Physical Strip":
+                    tabgroup = _make_inner_tabgroup((layout1_1, layout1_2), identifier)
+                case "Virtual Strip":
+                    tabgroup = _make_inner_tabgroup((layout2_1, layout2_2), identifier)
+                case "Buses":
+                    tabgroup = _make_inner_tabgroup((layout3_1, layout3_2), identifier)
+            return psg.Tab(identifier, [[tabgroup]], key=f"tab||{identifier}")
+
+        tabs = []
+        for tab in util.get_tabs_labels():
+            tabs.append(_make_tabs(tab))
+
+        tab_group = psg.TabGroup([tabs], change_submits=True, enable_events=True, key="tabgroup")
 
         return [[menu], [tab_group]]
 
@@ -80,7 +110,7 @@ class Builder:
         """tab0 row0 represents hardware ins"""
 
         def add_physical_device_opts(layout):
-            devices = get_input_device_list(self.vm)
+            devices = util.get_input_device_list(self.vm)
             devices.append("- remove device selection -")
             layout.append(
                 [
@@ -94,7 +124,7 @@ class Builder:
                 ]
             )
 
-        hardware_in = list()
+        hardware_in = []
         [step(hardware_in) for step in (add_physical_device_opts,)]
         return psg.Frame("Hardware In", hardware_in)
 
@@ -111,14 +141,14 @@ class Builder:
                     psg.ButtonMenu(
                         f"A{i + 1}",
                         size=(6, 3),
-                        menu_def=["", get_output_device_list(i, self.vm)],
+                        menu_def=["", util.get_output_device_list(i, self.vm)],
                         key=f"HARDWARE OUT||A{i + 1}",
                     )
                     for i in range(num_outs)
                 ]
             )
 
-        hardware_out = list()
+        hardware_out = []
         [step(hardware_out) for step in (add_physical_device_opts,)]
         return psg.Frame("Hardware Out", hardware_out)
 
@@ -131,7 +161,7 @@ class Builder:
                 [
                     psg.Spin(
                         nums,
-                        initial_value=self.window.cache["asio"][f"ASIO CHECKBOX||{get_asio_checkbox_index(0, i)}"],
+                        initial_value=self.window.cache["asio"][f"ASIO CHECKBOX||{util.get_asio_checkbox_index(0, i)}"],
                         size=2,
                         enable_events=True,
                         key=f"ASIO CHECKBOX||IN{i} 0",
@@ -142,7 +172,7 @@ class Builder:
                 [
                     psg.Spin(
                         nums,
-                        initial_value=self.window.cache["asio"][f"ASIO CHECKBOX||{get_asio_checkbox_index(1, i)}"],
+                        initial_value=self.window.cache["asio"][f"ASIO CHECKBOX||{util.get_asio_checkbox_index(1, i)}"],
                         size=2,
                         enable_events=True,
                         key=f"ASIO CHECKBOX||IN{i} 1",
@@ -150,7 +180,7 @@ class Builder:
                 ],
             )
 
-        inner = list()
+        inner = []
         asio_checkboxlists = ([] for _ in range(self.kind.phys_out))
         for i, checkbox_list in enumerate(asio_checkboxlists):
             [step(checkbox_list, i + 1) for step in (add_asio_checkboxes,)]
@@ -163,7 +193,7 @@ class Builder:
         """tab0 row3 represents patch composite"""
 
         def add_physical_device_opts(layout):
-            outputs = get_patch_composite_list(self.vm.kind)
+            outputs = util.get_patch_composite_list(self.vm.kind)
             layout.append(
                 [
                     psg.ButtonMenu(
@@ -176,7 +206,7 @@ class Builder:
                 ]
             )
 
-        hardware_out = list()
+        hardware_out = []
         [step(hardware_out) for step in (add_physical_device_opts,)]
         return psg.Frame("PATCH COMPOSITE", hardware_out)
 
@@ -190,7 +220,7 @@ class Builder:
                         [
                             psg.Checkbox(
                                 text=channel,
-                                default=self.vm.patch.insert[get_insert_checkbox_index(self.kind, j, i)].on,
+                                default=self.vm.patch.insert[util.get_insert_checkbox_index(self.kind, j, i)].on,
                                 enable_events=True,
                                 key=f"INSERT CHECKBOX||IN{i} {j}",
                             )
@@ -203,7 +233,7 @@ class Builder:
                     [
                         psg.Checkbox(
                             text=channel,
-                            default=self.vm.patch.insert[get_insert_checkbox_index(self.kind, j, i)].on,
+                            default=self.vm.patch.insert[util.get_insert_checkbox_index(self.kind, j, i)].on,
                             enable_events=True,
                             key=f"INSERT CHECKBOX||IN{i} {j}",
                         )
@@ -211,8 +241,8 @@ class Builder:
                     ],
                 )
 
-        asio_checkboxes = list()
-        inner = list()
+        asio_checkboxes = []
+        inner = []
         checkbox_lists = ([] for _ in range(self.kind.num_strip))
         for i, checkbox_list in enumerate(checkbox_lists):
             if i < self.kind.phys_in:
@@ -226,27 +256,23 @@ class Builder:
         return psg.Frame("PATCH INSERT", asio_checkboxes)
 
     def make_tab0_row5(self) -> psg.Frame:
-        """tab0 row5 represents asio buffer"""
-
-        samples = get_asio_samples_list()
-        samples.append("Default")
+        """tab0 row5 represents advanced settings"""
 
         return psg.Frame(
-            "ASIO BUFFER",
+            "ADVANCED SETTINGS",
             [
                 [
-                    psg.ButtonMenu(
-                        "ASIO BUFFER",
-                        size=(14, 2),
-                        menu_def=["", samples],
-                        key="ASIO BUFFER",
+                    psg.Button(
+                        "ADVANCED SETTINGS",
+                        size=(20, 2),
+                        key="ADVANCED SETTINGS",
                     )
-                ]
+                ],
             ],
-            key="ASIO BUFFER FRAME",
+            key="ADVANCED SETTINGS FRAME",
         )
 
-    def make_tab1_row(self, i) -> psg.Frame:
+    def make_tab1_button_row(self, i) -> psg.Frame:
         """tab1 row represents a strip's outputs (A1-A5, B1-B3)"""
 
         def add_strip_outputs(layout):
@@ -270,15 +296,64 @@ class Builder:
                 ],
             )
 
-        outputs = list()
+        outputs = []
         [step(outputs) for step in (add_strip_outputs,)]
         return psg.Frame(self.window.cache["labels"][f"STRIP {i}||LABEL"], outputs, key=f"STRIP {i}||LABEL")
 
-    def make_tab1_rows(self) -> psg.Frame:
-        layout = [[self.make_tab1_row(i)] for i in range(self.kind.phys_in)]
+    def make_tab1_button_rows(self) -> psg.Frame:
+        layout = [[self.make_tab1_button_row(i)] for i in range(self.kind.phys_in)]
         return psg.Frame(None, layout, border_width=0)
 
-    def make_tab2_row(self, i) -> psg.Frame:
+    def make_tab1_slider_row(self, i) -> psg.Frame:
+        def add_gain_slider(layout):
+            layout.append(
+                [
+                    psg.Text("Gain"),
+                    psg.Slider(
+                        range=(-60, 12),
+                        default_value=self.vm.strip[i].gain,
+                        resolution=0.1,
+                        disable_number_display=True,
+                        expand_x=True,
+                        enable_events=True,
+                        orientation="horizontal",
+                        key=f"STRIP {i}||SLIDER GAIN",
+                    ),
+                ]
+            )
+
+        def add_param_sliders(layout):
+            layout.append([LabelSlider(self.window, i, param) for param in util.get_slider_params(i, self.vm)])
+
+        def add_limit_slider(layout):
+            layout.append(
+                [
+                    psg.Text("Limit"),
+                    psg.Slider(
+                        range=(-40, 12),
+                        default_value=self.vm.strip[i].limit,
+                        resolution=1,
+                        disable_number_display=True,
+                        expand_x=True,
+                        enable_events=True,
+                        orientation="horizontal",
+                        key=f"STRIP {i}||SLIDER LIMIT",
+                    ),
+                ]
+            )
+
+        layout = []
+        steps = (add_gain_slider, add_param_sliders)
+        if self.kind.name in ("banana", "potato"):
+            steps += (add_limit_slider,)
+        [step(layout) for step in steps]
+        return psg.Frame(self.window.cache["labels"][f"STRIP {i}||LABEL"], layout, key=f"STRIP {i}||LABEL||SLIDER")
+
+    def make_tab1_slider_rows(self) -> psg.Frame:
+        layout = [[self.make_tab1_slider_row(i)] for i in range(self.kind.phys_in)]
+        return psg.Frame(None, layout, border_width=0)
+
+    def make_tab2_button_row(self, i) -> psg.Frame:
         """tab2 row represents a strip's outputs (A1-A5, B1-B3)"""
 
         def add_strip_outputs(layout):
@@ -311,15 +386,77 @@ class Builder:
                     ],
                 )
 
-        outputs = list()
+        outputs = []
         [step(outputs) for step in (add_strip_outputs,)]
         return psg.Frame(self.window.cache["labels"][f"STRIP {i}||LABEL"], outputs, key=f"STRIP {i}||LABEL")
 
-    def make_tab2_rows(self) -> psg.Frame:
-        layout = [[self.make_tab2_row(i)] for i in range(self.kind.phys_in, self.kind.phys_in + self.kind.virt_in)]
+    def make_tab2_button_rows(self) -> psg.Frame:
+        layout = [
+            [self.make_tab2_button_row(i)] for i in range(self.kind.phys_in, self.kind.phys_in + self.kind.virt_in)
+        ]
         return psg.Frame(None, layout, border_width=0)
 
-    def make_tab3_row(self, i) -> psg.Frame:
+    def make_tab2_slider_row(self, i) -> psg.Frame:
+        def add_gain_slider(layout):
+            layout.append(
+                [
+                    psg.Text("Gain"),
+                    psg.Slider(
+                        range=(-60, 12),
+                        default_value=self.vm.strip[i].gain,
+                        resolution=0.1,
+                        disable_number_display=True,
+                        expand_x=True,
+                        enable_events=True,
+                        orientation="horizontal",
+                        key=f"STRIP {i}||SLIDER GAIN",
+                    ),
+                ]
+            )
+
+        def add_param_sliders(layout):
+            if self.kind.name in ("basic", "banana"):
+                for param in util.get_slider_params(i, self.vm):
+                    layout.append([LabelSlider(self.window, i, param, range_=(-12, 12))])
+            else:
+                layout.append(
+                    [
+                        LabelSlider(self.window, i, param, range_=(-12, 12))
+                        for param in util.get_slider_params(i, self.vm)
+                    ]
+                )
+
+        def add_limit_slider(layout):
+            layout.append(
+                [
+                    psg.Text("Limit"),
+                    psg.Slider(
+                        range=(-40, 12),
+                        default_value=self.vm.strip[i].limit,
+                        resolution=1,
+                        disable_number_display=True,
+                        expand_x=True,
+                        enable_events=True,
+                        orientation="horizontal",
+                        key=f"STRIP {i}||SLIDER LIMIT",
+                    ),
+                ]
+            )
+
+        layout = []
+        steps = (add_gain_slider, add_param_sliders)
+        if self.kind.name in ("banana", "potato"):
+            steps += (add_limit_slider,)
+        [step(layout) for step in steps]
+        return psg.Frame(self.window.cache["labels"][f"STRIP {i}||LABEL"], layout, key=f"STRIP {i}||LABEL||SLIDER")
+
+    def make_tab2_slider_rows(self) -> psg.Frame:
+        layout = [
+            [self.make_tab2_slider_row(i)] for i in range(self.kind.phys_in, self.kind.phys_in + self.kind.virt_in)
+        ]
+        return psg.Frame(None, layout, border_width=0)
+
+    def make_tab3_button_row(self, i) -> psg.Frame:
         """tab3 row represents bus composite toggle"""
 
         def add_strip_outputs(layout):
@@ -338,10 +475,35 @@ class Builder:
                 ]
             )
 
-        outputs = list()
+        outputs = []
         [step(outputs) for step in (add_strip_outputs,)]
         return psg.Frame(self.window.cache["labels"][f"BUS {i}||LABEL"], outputs, key=f"BUS {i}||LABEL")
 
-    def make_tab3_rows(self) -> psg.Frame:
-        layout = [[self.make_tab3_row(i)] for i in range(self.kind.num_bus)]
+    def make_tab3_button_rows(self) -> psg.Frame:
+        layout = [[self.make_tab3_button_row(i)] for i in range(self.kind.num_bus)]
+        return psg.Frame(None, layout, border_width=0)
+
+    def make_tab3_slider_row(self, i) -> psg.Frame:
+        def add_gain_slider(layout):
+            layout.append(
+                [
+                    psg.Slider(
+                        range=(-60, 12),
+                        default_value=self.vm.bus[i].gain,
+                        resolution=0.1,
+                        disable_number_display=True,
+                        expand_x=True,
+                        enable_events=True,
+                        orientation="horizontal",
+                        key=f"BUS {i}||SLIDER GAIN",
+                    )
+                ]
+            )
+
+        outputs = []
+        [step(outputs) for step in (add_gain_slider,)]
+        return psg.Frame(self.window.cache["labels"][f"BUS {i}||LABEL"], outputs, key=f"BUS {i}||LABEL||SLIDER")
+
+    def make_tab3_slider_rows(self) -> psg.Frame:
+        layout = [[self.make_tab3_slider_row(i)] for i in range(self.kind.num_bus)]
         return psg.Frame(None, layout, border_width=0)

src/nvda_voicemeeter/compound.py

@@ -0,0 +1,35 @@
+import PySimpleGUI as psg
+
+
+class LabelSlider(psg.Frame):
+    """Compound Label Slider element"""
+
+    def __init__(self, parent, i, param, range_=(0, 10), *args, **kwargs):
+        self.parent = parent
+        if param in ("AUDIBILITY", "DENOISER"):
+            size = 7
+        else:
+            size = 4
+        layout = [
+            [
+                psg.Text(param.capitalize(), size=size),
+                psg.Slider(
+                    range=range_,
+                    default_value=self.default_value(i, param),
+                    resolution=0.1,
+                    disable_number_display=True,
+                    size=(12, 16),
+                    expand_x=True,
+                    enable_events=True,
+                    orientation="horizontal",
+                    key=f"STRIP {i}||SLIDER {param}",
+                ),
+            ]
+        ]
+        super().__init__(None, layout=layout, border_width=0, pad=0, *args, **kwargs)
+
+    def default_value(self, i, param):
+        target = getattr(self.parent.vm.strip[i], param.lower())
+        if param in ("COMP", "GATE", "DENOISER"):
+            return target.knob
+        return target

src/nvda_voicemeeter/models.py

@@ -42,14 +42,14 @@ def _make_param_cache(vm, channel_type) -> dict:
             **{f"STRIP {i}||SOLO": vm.strip[i].solo for i in range(vm.kind.num_strip)},
             **{f"STRIP {i}||MUTE": vm.strip[i].mute for i in range(vm.kind.num_strip)},
         }
-        return params
     else:
-        return {
+        params |= {
             **{f"BUS {i}||MONO": vm.bus[i].mono for i in range(vm.kind.num_bus)},
             **{f"BUS {i}||EQ": vm.bus[i].eq.on for i in range(vm.kind.num_bus)},
             **{f"BUS {i}||MUTE": vm.bus[i].mute for i in range(vm.kind.num_bus)},
             **{f"BUS {i}||MODE": vm.bus[i].mode.get() for i in range(vm.kind.num_bus)},
         }
+    return params
 
 
 def _make_label_cache(vm) -> dict:

src/nvda_voicemeeter/popup.py

@@ -0,0 +1,162 @@
+import logging
+from pathlib import Path
+
+import PySimpleGUI as psg
+
+from . import util
+
+logger = logging.getLogger(__name__)
+
+
+class Popup:
+    def __init__(self, window):
+        self.window = window
+        self.logger = logger.getChild(type(self).__name__)
+
+    def save_as(self, message, title=None, initial_folder=None):
+        layout = [
+            [psg.Text(message)],
+            [
+                psg.FileSaveAs("Browse", initial_folder=str(initial_folder), file_types=(("XML", ".xml"),)),
+                psg.Button("Cancel"),
+            ],
+        ]
+        popup = psg.Window(title, layout, finalize=True)
+        popup["Browse"].bind("<FocusIn>", "||FOCUS IN")
+        popup["Browse"].bind("<Return>", "||KEY ENTER")
+        popup["Cancel"].bind("<FocusIn>", "||FOCUS IN")
+        popup["Cancel"].bind("<Return>", "||KEY ENTER")
+        filepath = None
+        while True:
+            event, values = popup.read()
+            self.logger.debug(f"event::{event}")
+            self.logger.debug(f"values::{values}")
+            if event in (psg.WIN_CLOSED, "Cancel"):
+                break
+            match parsed_cmd := self.window.parser.match.parseString(event):
+                case [[button], ["FOCUS", "IN"]]:
+                    if values["Browse"]:
+                        filepath = values["Browse"]
+                        break
+                    self.window.nvda.speak(button)
+                case [[button], ["KEY", "ENTER"]]:
+                    popup.find_element_with_focus().click()
+            self.logger.debug(f"parsed::{parsed_cmd}")
+        popup.close()
+        if filepath:
+            return Path(filepath)
+
+    def rename(self, message, title=None, tab=None):
+        if tab == "Physical Strip":
+            upper = self.window.kind.phys_in + 1
+        elif tab == "Virtual Strip":
+            upper = self.window.kind.virt_in + 1
+        elif tab == "Buses":
+            upper = self.window.kind.num_bus + 1
+
+        layout = [
+            [psg.Text(message)],
+            [
+                [
+                    psg.Spin(
+                        list(range(1, upper)), initial_value=1, size=2, enable_events=True, key=f"Index", readonly=True
+                    ),
+                    psg.Input(key="Edit"),
+                ],
+                [psg.Button("Ok"), psg.Button("Cancel")],
+            ],
+        ]
+        popup = psg.Window(title, layout, finalize=True)
+        popup["Index"].bind("<FocusIn>", "||FOCUS IN")
+        popup["Edit"].bind("<FocusIn>", "||FOCUS IN")
+        popup["Ok"].bind("<FocusIn>", "||FOCUS IN")
+        popup["Ok"].bind("<Return>", "||KEY ENTER")
+        popup["Cancel"].bind("<FocusIn>", "||FOCUS IN")
+        popup["Cancel"].bind("<Return>", "||KEY ENTER")
+        data = {}
+        while True:
+            event, values = popup.read()
+            self.logger.debug(f"event::{event}")
+            self.logger.debug(f"values::{values}")
+            if event in (psg.WIN_CLOSED, "Cancel"):
+                break
+            match parsed_cmd := self.window.parser.match.parseString(event):
+                case ["Index"]:
+                    val = values["Index"]
+                    self.window.nvda.speak(f"Index {val}")
+                case [[button], ["FOCUS", "IN"]]:
+                    if button == "Index":
+                        val = values["Index"]
+                        self.window.nvda.speak(f"Index {val}")
+                    else:
+                        self.window.nvda.speak(button)
+                case [[button], ["KEY", "ENTER"]]:
+                    popup.find_element_with_focus().click()
+                case ["Ok"]:
+                    data = values
+                    break
+            self.logger.debug(f"parsed::{parsed_cmd}")
+        popup.close()
+        return data
+
+    def advanced_settings(self, title):
+        def _make_buffering_frame() -> psg.Frame:
+            buffer = [
+                [
+                    psg.ButtonMenu(
+                        driver,
+                        size=(14, 2),
+                        menu_def=["", util.get_asio_samples_list(driver)],
+                        key=f"BUFFER {driver}",
+                    )
+                    for driver in ("MME", "WDM", "KS", "ASIO")
+                ],
+            ]
+            return psg.Frame("BUFFERING", buffer)
+
+        layout = []
+        steps = (_make_buffering_frame,)
+        for step in steps:
+            layout.append([step()])
+        layout.append([psg.Button("Exit", size=(8, 2))])
+
+        popup = psg.Window(title, layout, finalize=True)
+        buttonmenu_opts = {"takefocus": 1, "highlightthickness": 1}
+        for driver in ("MME", "WDM", "KS", "ASIO"):
+            popup[f"BUFFER {driver}"].Widget.config(**buttonmenu_opts)
+            popup[f"BUFFER {driver}"].bind("<FocusIn>", "||FOCUS IN")
+            popup[f"BUFFER {driver}"].bind("<space>", "||KEY SPACE", propagate=False)
+            popup[f"BUFFER {driver}"].bind("<Return>", "||KEY ENTER", propagate=False)
+        popup["Exit"].bind("<FocusIn>", "||FOCUS IN")
+        popup["Exit"].bind("<Return>", "||KEY ENTER")
+        while True:
+            event, values = popup.read()
+            self.logger.debug(f"event::{event}")
+            self.logger.debug(f"values::{values}")
+            if event in (psg.WIN_CLOSED, "Exit"):
+                break
+            match parsed_cmd := self.parser.match.parseString(event):
+                case ["BUFFER MME" | "BUFFER WDM" | "BUFFER KS" | "BUFFER ASIO"]:
+                    if values[event] == "Default":
+                        if "MME" in event:
+                            val = 1024
+                        elif "WDM" in event or "KS" in event:
+                            val = 512
+                        else:
+                            val = 0
+                    else:
+                        val = int(values[event])
+                    driver = event.split()[1]
+                    self.vm.set(f"option.buffer.{driver.lower()}", val)
+                    self.TKroot.after(200, self.window.nvda.speak, f"{driver} BUFFER {val if val else 'default'}")
+                case [["BUFFER", driver], ["FOCUS", "IN"]]:
+                    val = int(self.vm.get(f"option.buffer.{driver.lower()}"))
+                    self.window.nvda.speak(f"{driver} BUFFER {val if val else 'default'}")
+                case [["BUFFER", driver], ["KEY", "SPACE" | "ENTER"]]:
+                    util.open_context_menu_for_buttonmenu(popup, f"BUFFER {driver}")
+                case [[button], ["FOCUS", "IN"]]:
+                    self.window.nvda.speak(button)
+                case [[button], ["KEY", "ENTER"]]:
+                    popup.find_element_with_focus().click()
+            self.logger.debug(f"parsed::{parsed_cmd}")
+        popup.close()

src/nvda_voicemeeter/util.py

@@ -1,3 +1,6 @@
+from typing import Iterable
+
+
 def get_asio_checkbox_index(channel, num) -> int:
     if channel == 0:
         return 2 * num - 2
@@ -8,17 +11,32 @@ def get_insert_checkbox_index(kind, channel, num) -> int:
     if num <= kind.phys_in:
         if channel == 0:
             return 2 * num - 2
-        else:
-            return 2 * num - 1
+        return 2 * num - 1
     return (2 * kind.phys_in) + (8 * (num - kind.phys_in - 1)) + channel
 
 
+_rejected_ids = (
+    "VBAudio100VMVAIO3",
+    "{F5735BD4-6EAF-4758-9710-9886E5AD0FF3}",
+    "{0239BE07-CEEF-4236-A900-AA778D432FD4}",
+)
+
+
 def get_input_device_list(vm) -> list:
-    return ["{type}: {name}".format(**vm.device.input(i)) for i in range(vm.device.ins)]
+    devices = []
+    for j in range(vm.device.ins):
+        device = vm.device.input(j)
+        if device["id"] not in _rejected_ids:
+            devices.append("{type}: {name}".format(**device))
+    return devices
 
 
 def get_output_device_list(i, vm) -> list:
-    devices = ["{type}: {name}".format(**vm.device.output(j)) for j in range(vm.device.outs)]
+    devices = []
+    for j in range(vm.device.outs):
+        device = vm.device.output(j)
+        if device["id"] not in _rejected_ids:
+            devices.append("{type}: {name}".format(**device))
     if i == 0:
         return devices
     devices.append("- remove device selection -")
@@ -51,28 +69,20 @@ def get_patch_insert_channels() -> list:
 _patch_insert_channels = get_patch_insert_channels()
 
 
-def get_asio_samples_list() -> list:
-    return [
-        "1024",
-        "768",
-        "704",
-        "640",
-        "576",
-        "512",
-        "480",
-        "448",
-        "441",
-        "416",
-        "384",
-        "352",
-        "320",
-        "288",
-        "256",
-        "224",
-        "192",
-        "160",
-        "128",
-    ]
+def get_asio_samples_list(driver) -> list:
+    if driver == "MME":
+        samples = ["2048", "1536", "1024", "896", "768", "704", "640", "576", "512", "480", "441"]
+    else:
+        # fmt: off
+        samples = [
+            "2048", "1536", "1024", "768", "704", "640", "576", "512", "480", "448", "441", "416", "384",
+            "352", "320", "288", "256", "224", "192", "160", "128"
+        ]
+        # fmt: on
+        if driver == "ASIO":
+            samples = [x for x in samples if x not in ("2048", "1536")]
+    samples.append("Default")
+    return samples
 
 
 def get_tabs_labels() -> list:
@@ -120,3 +130,23 @@ def get_bus_modes(vm) -> list:
         "lfeonly",
         "rearonly",
     ]
+
+
+def check_bounds(val, bounds: tuple) -> int | float:
+    lower, upper = bounds
+    if val > upper:
+        val = upper
+    elif val < lower:
+        val = lower
+    return val
+
+
+def get_slider_params(i, vm) -> Iterable:
+    if i < vm.kind.phys_in:
+        if vm.kind.name == "basic":
+            return ("AUDIBILITY",)
+        if vm.kind.name == "banana":
+            return ("COMP", "GATE")
+        if vm.kind.name == "potato":
+            return ("COMP", "GATE", "DENOISER")
+    return ("BASS", "MID", "TREBLE")