implements advanced settings popup

gives access to driver buffer settings.

may open by button or ctrl-a

README.md

@@ -42,7 +42,7 @@ with voicemeeterlib.api(KIND_ID, sync=True) as vm:
         window.run()
 ```
 
-### `KIND_ID`
+### KIND_ID
 
 May be one of the following:
 
@@ -84,6 +84,16 @@ The `Save Settings` option opens a popup window with two buttons, `Browse` and `
 
 If you have any questions/suggestions feel free to raise an issue or open a new discussion.
 
+### Special Thanks
+
+[Mario Loreti](https://www.marioloreti.net/en/) for his help in testing and offering feedback during development.
+
+[NVAccess](https://www.nvaccess.org/) for creating the open source NVDA screen reader and its controller client.
+
+[Vincent Burel](https://github.com/vburel2018) for creating Voicemeeter and its SDK.
+
+[PySimpleGUI](https://github.com/PySimpleGUI) team for creating an awesome GUI framework.
+
 [voicemeeter]: https://voicemeeter.com/
 [nvda]: https://www.nvaccess.org/
 [controller_client]: https://github.com/nvaccess/nvda/tree/master/extras/controllerClient

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nvda_voicemeeter"
-version = "0.1.1"
+version = "0.1.3"
 description = "A Voicemeeter app compatible with NVDA"
 authors = [
     { name = "onyx-and-iris", email = "code@onyxandiris.online" },

src/nvda_voicemeeter/builder.py

@@ -228,24 +228,20 @@ 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:
@@ -325,12 +321,18 @@ class Builder:
         """tab3 row represents bus composite toggle"""
 
         def add_strip_outputs(layout):
+            params = ["MONO", "EQ", "MUTE", "MODE"]
+            if self.vm.kind.name == "basic":
+                params.remove("EQ")
+            label = {"MODE": "BUSMODE"}
             layout.append(
                 [
-                    psg.Button("Mono", size=(6, 2), key=f"BUS {i}||MONO"),
-                    psg.Button("EQ", size=(6, 2), key=f"BUS {i}||EQ"),
-                    psg.Button("Mute", size=(6, 2), key=f"BUS {i}||MUTE"),
-                    psg.Button(f"BUSMODE", size=(12, 2), key=f"BUS {i}||MODE"),
+                    psg.Button(
+                        label.get(param, param.capitalize()),
+                        size=(12 if param == "MODE" else 6, 2),
+                        key=f"BUS {i}||{param}",
+                    )
+                    for param in params
                 ]
             )
 

src/nvda_voicemeeter/util.py

@@ -47,28 +47,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:
@@ -94,7 +86,14 @@ def get_channel_identifier_list(vm) -> list:
     return identifiers
 
 
-def get_bus_modes() -> list:
+def get_bus_modes(vm) -> list:
+    if vm.kind.name == "basic":
+        return [
+            "normal",
+            "amix",
+            "repeat",
+            "composite",
+        ]
     return [
         "normal",
         "amix",

src/nvda_voicemeeter/window.py

@@ -18,6 +18,7 @@ from .parser import Parser
 from .util import (
     _patch_insert_channels,
     get_asio_checkbox_index,
+    get_asio_samples_list,
     get_bus_modes,
     get_channel_identifier_list,
     get_insert_checkbox_index,
@@ -62,10 +63,7 @@ class NVDAVMWindow(psg.Window):
             self[f"HARDWARE OUT||A2"].Widget.config(**buttonmenu_opts)
         if self.kind.name != "basic":
             [self[f"PATCH COMPOSITE||PC{i + 1}"].Widget.config(**buttonmenu_opts) for i in range(self.kind.phys_out)]
-            self["ASIO BUFFER"].Widget.config(**buttonmenu_opts)
-        if self.kind.name != "basic":
-            self["ASIO BUFFER FRAME"].update(visible=False)
-            self["ASIO BUFFER FRAME"].hide_row()
+
         self.register_events()
 
     def __enter__(self):
@@ -128,6 +126,7 @@ class NVDAVMWindow(psg.Window):
         self["tabs"].bind("<FocusIn>", "||FOCUS IN")
         self.bind("<Control-KeyPress-Tab>", "CTRL-TAB")
         self.bind("<Control-Shift-KeyPress-Tab>", "CTRL-SHIFT-TAB")
+        self.bind("<Control-a>", "CTRL-A")
 
         # Hardware In
         for i in range(self.vm.kind.phys_in):
@@ -167,6 +166,10 @@ class NVDAVMWindow(psg.Window):
                 else:
                     [self[f"INSERT CHECKBOX||IN{i + 1} {j}"].bind("<FocusIn>", "||FOCUS IN") for j in range(8)]
 
+        # Advanced Settings
+        if self.kind.name != "basic":
+            self["ADVANCED SETTINGS"].bind("<Return>", "||KEY ENTER")
+
         # Strip Params
         for i in range(self.kind.num_strip):
             for j in range(self.kind.phys_out):
@@ -185,17 +188,14 @@ class NVDAVMWindow(psg.Window):
                     self[f"STRIP {i}||{param}"].bind("<Return>", "||KEY ENTER")
 
         # Bus Params
+        params = ["MONO", "EQ", "MUTE", "MODE"]
+        if self.vm.kind.name == "basic":
+            params.remove("EQ")
         for i in range(self.kind.num_bus):
-            for param in ("MONO", "EQ", "MUTE", "MODE"):
+            for param in params:
                 self[f"BUS {i}||{param}"].bind("<FocusIn>", "||FOCUS IN")
                 self[f"BUS {i}||{param}"].bind("<Return>", "||KEY ENTER")
 
-        # ASIO Buffer
-        if self.kind.name != "basic":
-            self["ASIO BUFFER"].bind("<FocusIn>", "||FOCUS IN")
-            self["ASIO BUFFER"].bind("<space>", "||KEY SPACE", propagate=False)
-            self["ASIO BUFFER"].bind("<Return>", "||KEY ENTER", propagate=False)
-
     def popup_save_as(self, message, title=None, initial_folder=None):
         layout = [
             [psg.Text(message)],
@@ -216,27 +216,24 @@ class NVDAVMWindow(psg.Window):
             self.logger.debug(f"values::{values}")
             if event in (psg.WIN_CLOSED, "Cancel"):
                 break
-            elif event.endswith("||FOCUS IN"):
-                if values["Browse"]:
-                    filepath = values["Browse"]
-                    break
-                label = event.split("||")[0]
-                self.TKroot.after(
-                    200 if label == "Edit" else 1,
-                    self.nvda.speak,
-                    label,
-                )
-            elif event.endswith("||KEY ENTER"):
-                window.find_element_with_focus().click()
+            match parsed_cmd := self.parser.match.parseString(event):
+                case [[button], ["FOCUS", "IN"]]:
+                    if values["Browse"]:
+                        filepath = values["Browse"]
+                        break
+                    self.nvda.speak(button)
+                case [[button], ["KEY", "ENTER"]]:
+                    window.find_element_with_focus().click()
+            self.logger.debug(f"parsed::{parsed_cmd}")
         window.close()
         if filepath:
             return Path(filepath)
 
     def popup_rename(self, message, title=None, tab=None):
         if tab == "Physical Strip":
-            upper = self.kind.phys_out + 1
+            upper = self.kind.phys_in + 1
         elif tab == "Virtual Strip":
-            upper = self.kind.virt_out + 1
+            upper = self.kind.virt_in + 1
         elif tab == "Buses":
             upper = self.kind.num_bus + 1
 
@@ -266,24 +263,79 @@ class NVDAVMWindow(psg.Window):
             self.logger.debug(f"values::{values}")
             if event in (psg.WIN_CLOSED, "Cancel"):
                 break
-            elif event.endswith("||KEY ENTER"):
-                window.find_element_with_focus().click()
-            elif event == "Index":
-                val = values["Index"]
-                self.nvda.speak(f"Index {val}")
-            elif event.endswith("||FOCUS IN"):
-                if event.startswith("Index"):
+            match parsed_cmd := self.parser.match.parseString(event):
+                case ["Index"]:
                     val = values["Index"]
                     self.nvda.speak(f"Index {val}")
-                else:
-                    self.nvda.speak(event.split("||")[0])
-            elif event == "Ok":
-                data = values
-                break
-
+                case [[button], ["FOCUS", "IN"]]:
+                    if button == "Index":
+                        val = values["Index"]
+                        self.nvda.speak(f"Index {val}")
+                    else:
+                        self.nvda.speak(button)
+                case [[button], ["KEY", "ENTER"]]:
+                    window.find_element_with_focus().click()
+                case ["Ok"]:
+                    data = values
+                    break
+            self.logger.debug(f"parsed::{parsed_cmd}")
         window.close()
         return data
 
+    def popup_advanced_settings(self, title):
+        def _make_buffering_frame() -> psg.Frame:
+            buffer = [
+                [
+                    psg.ButtonMenu(
+                        driver,
+                        size=(14, 2),
+                        menu_def=["", get_asio_samples_list(driver)],
+                        key=f"BUFFER {driver}",
+                    )
+                    for driver in ("MME", "WDM", "KS", "ASIO")
+                ],
+            ]
+            return psg.Frame("BUFFERING", buffer)
+
+        buffer_frame = _make_buffering_frame()
+        layout = [[buffer_frame], [psg.Button("Exit")]]
+
+        window = psg.Window(title, layout, finalize=True)
+        buttonmenu_opts = {"takefocus": 1, "highlightthickness": 1}
+        for driver in ("MME", "WDM", "KS", "ASIO"):
+            window[f"BUFFER {driver}"].Widget.config(**buttonmenu_opts)
+            window[f"BUFFER {driver}"].bind("<FocusIn>", "||FOCUS IN")
+            window[f"BUFFER {driver}"].bind("<space>", "||KEY SPACE", propagate=False)
+            window[f"BUFFER {driver}"].bind("<Return>", "||KEY ENTER", propagate=False)
+        window["Exit"].bind("<FocusIn>", "||FOCUS IN")
+        window["Exit"].bind("<Return>", "||KEY ENTER")
+        while True:
+            event, values = window.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":
+                        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.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.nvda.speak(f"{driver} BUFFER {val if val else 'default'}")
+                case [["BUFFER", driver], ["KEY", "SPACE" | "ENTER"]]:
+                    open_context_menu_for_buttonmenu(window, f"BUFFER {driver}")
+                case [[button], ["FOCUS", "IN"]]:
+                    self.nvda.speak(button)
+                case [[button], ["KEY", "ENTER"]]:
+                    window.find_element_with_focus().click()
+            self.logger.debug(f"parsed::{parsed_cmd}")
+        window.close()
+
     def run(self):
         """
         Parses the event string and matches it to events
@@ -320,7 +372,8 @@ class NVDAVMWindow(psg.Window):
                                 self[f"STRIP {index}||LABEL"].update(value=label)
                                 self.cache["labels"][f"STRIP {index}||LABEL"] = label
                             case "Virtual Strip":
-                                label = data.get("Edit") or f"Virtual Input {index + 1}"
+                                index += self.kind.phys_in
+                                label = data.get("Edit") or f"Virtual Input {index - self.kind.phys_in + 1}"
                                 self.vm.strip[index].label = label
                                 self[f"STRIP {index}||LABEL"].update(value=label)
                                 self.cache["labels"][f"STRIP {index}||LABEL"] = label
@@ -491,19 +544,11 @@ class NVDAVMWindow(psg.Window):
                     num = int(in_num[-1])
                     self.nvda.speak(f"Patch INSERT IN#{num} {channel} {'on' if val else 'off'}")
 
-                # ASIO Buffer
-                case ["ASIO BUFFER"]:
-                    if values[event] == "Default":
-                        val = 0
-                    else:
-                        val = values[event]
-                    self.vm.option.buffer("asio", val)
-                    self.TKroot.after(200, self.nvda.speak, f"ASIO BUFFER {val if val else 'default'}")
-                case [["ASIO", "BUFFER"], ["FOCUS", "IN"]]:
-                    val = int(self.vm.get("option.buffer.asio"))
-                    self.nvda.speak(f"ASIO BUFFER {val if val else 'default'}")
-                case [["ASIO", "BUFFER"], ["KEY", "SPACE" | "ENTER"]]:
-                    open_context_menu_for_buttonmenu(self, "ASIO BUFFER")
+                # Advanced Settings
+                case ["ADVANCED SETTINGS"] | ["CTRL-A"]:
+                    self.popup_advanced_settings(title="Advanced Settings")
+                case [["ADVANCED", "SETTINGS"], ["KEY", "ENTER"]]:
+                    self.find_element_with_focus().click()
 
                 # Strip Params
                 case [["STRIP", index], [param]]:
@@ -583,7 +628,7 @@ class NVDAVMWindow(psg.Window):
                                 f"{label} bus {param} {'on' if val else 'off'}",
                             )
                         case "MODE":
-                            bus_modes = get_bus_modes()
+                            bus_modes = get_bus_modes(self.vm)
                             next_index = bus_modes.index(val) + 1
                             if next_index == len(bus_modes):
                                 next_index = 0