fixes regression, bus focus in/out readded

patch bump

.gitignore

@@ -161,4 +161,17 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-controllerClient/
+# nvda files
+controllerClient/*
+!.gitkeep
+
+# build files
+basic.py
+banana.py
+potato.py
+
+# persistent storage
+settings.json
+
+# quick test
+quick.py

README.md

@@ -1 +1,172 @@
-# example-package
+[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+
+# NVDA Voicemeeter
+
+A remote control app for [Voicemeeter][voicemeeter], designed to be used with the [NVDA screen reader][nvda].
+
+For an outline of this projects goals see the [SPECIFICATION][spec].
+
+<img src="./img/nvda-voicemeeter.png" width=960 alt="Image of Voicemeeter NVDA app settings tab">
+
+## Requirements
+
+- [NVDA screen reader][nvda]
+- [NVDA's Controller Client files][controller_client]
+- Python 3.10 or greater
+
+### Installation
+
+#### `From Source`
+
+First clone the source files from this repository and install the dependencies.
+
+```
+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.
+
+### Run
+
+Once the repository is downloaded and the controller client files in place you can launch the GUI with the following `__main__.py`:
+
+```python
+import voicemeeterlib
+
+import nvda_voicemeeter
+
+KIND_ID = "potato"
+
+with voicemeeterlib.api(KIND_ID) as vm:
+    with nvda_voicemeeter.draw(KIND_ID, vm) as window:
+        window.run()
+```
+
+### KIND_ID
+
+May be one of the following:
+
+- `basic`
+- `banana`
+- `potato`
+
+### Use
+
+#### `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.
+
+#### `Physical Strip|Virtual Strip|Buses`
+
+You will find in each of these tabs two nested tabs,`Buttons` and `Sliders`. For each nested tab you will find the controls appropriate for the Voicemeeter kind and channel type.
+
+All buttons may be triggered by pressing `SPACE` or `ENTER`.
+
+All sliders may be controlled in three different ways:
+
+- `Left|Right arrow` to move a slider by 1 step.
+- `Shift + Left|Right arrow` to move a slider by 0.1 steps.
+- `Control + Left|Right arrow` to move a slider by 3 steps.
+
+To rename a strip/bus channel focus on the channel in question and press `F2`. Then enter the new channel name into the text input widget and press the `Ok` button.
+
+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
+- Save/Load current settings (as an xml file)
+- Set a config to load automatically on app startup.
+
+The `Save Settings` option opens a popup window with two buttons, `Browse` and `Cancel`. Browse opens a Save As dialog, Cancel returns to the main app window.
+
+`Load Settings` and `Load on Startup` both open an Open dialog box immediately.
+
+### `Quick access binds`
+
+There are a number of quick binds available to assist with faster navigation and general use.
+
+When focused on any one of "Physical Strip", "Virtual Strip" or "Buses" you may use `Control + Number` to skip to the corresponding channel.
+
+When focused on any single channel (Strip or Bus), the following binds exist:
+
+- `Alt + Number` will trigger the Bus output button corresponding to the number. For example `Alt + 3` will trigger the `A3` button
+- `Control + O` will trigger the Mono button
+- `Control + S` will trigger the Solo button
+- `Control + M` will trigger the Mute button
+
+You may also enter slider modes which allow for control of the channels sliders until the slider mode is exited. You may access the slider modes with the following binds:
+
+- `Control + U` will enter Audibility mode
+- `Control + G` will enter Gain mode
+- `Control + T` will enter Gate mode
+- `Control + L` will enter Limit mode
+- `Control + B` will enter Bass mode
+- `Control + I` will enter Mid mode
+- `Control + R` will enter Treble mode
+
+To exit any of the slider modes press `Escape`.
+
+Once you are in a slider mode you may now control the slider that matches the slider mode. Slider mode binds are the same as the normal slider binds with the addition of the Alt keypress. For example, where you would normally use `Right Arrow` to shift a slider rightwards by 1 step, in slider mode you would now use `Alt + Right Arrow`.
+
+### Issues
+
+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.
+
+[spec]: ./SPECIFICATION.md
+[voicemeeter]: https://voicemeeter.com/
+[nvda]: https://www.nvaccess.org/
+[controller_client]: https://github.com/nvaccess/nvda/tree/master/extras/controllerClient
+[releases]: https://github.com/onyx-and-iris/nvda-voicemeeter/releases

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.

__main__.py

@@ -2,8 +2,8 @@ import voicemeeterlib
 
 import nvda_voicemeeter
 
-kind_id = "potato"
+KIND_ID = "potato"
 
-with voicemeeterlib.api("potato") as vm:
+with voicemeeterlib.api(KIND_ID) as vm:
-    with nvda_voicemeeter.build(f"Voicemeeter {kind_id.capitalize()} NVDA", vm) as window:
+    with nvda_voicemeeter.draw(KIND_ID, vm) as window:
         window.run()

build.ps1

@@ -0,0 +1,20 @@
+function Compress-Builds {
+    $target = Join-Path -Path $PSScriptRoot -ChildPath "dist"
+    @("basic", "banana", "potato") | ForEach-Object {
+        Compress-Archive -Path $(Join-Path -Path $target -ChildPath $_) -DestinationPath $(Join-Path -Path $target -ChildPath "${_}.zip") -Force
+    } 
+}
+
+function Get-Builds {
+    @("basic", "banana", "potato") | ForEach-Object {
+        pdm run pyinstaller "${_}.spec" --noconfirm
+    }  
+}
+
+function main {
+    Get-Builds
+
+    Compress-Builds
+}
+
+if ($MyInvocation.InvocationName -ne '.') { main }

pdm.lock

@@ -2,11 +2,223 @@
 # It is not intended for manual editing.
 
 [metadata]
-groups = ["default"]
+groups = ["default", "build", "lint", "test"]
 cross_platform = true
 static_urls = false
 lock_version = "4.3"
-content_hash = "sha256:0dfd1ea07c294dd2b837a34ff9d286134e5119c6249e4f9cd6c1ed121de97851"
+content_hash = "sha256:ba53368b628b713c9cf4eb54e6f5c5c4af207c8e247d473417e4c2a4b47f645d"
+
+[[package]]
+name = "altgraph"
+version = "0.17.3"
+summary = "Python graph (network) package"
+files = [
+    {file = "altgraph-0.17.3-py2.py3-none-any.whl", hash = "sha256:c8ac1ca6772207179ed8003ce7687757c04b0b71536f81e2ac5755c6226458fe"},
+    {file = "altgraph-0.17.3.tar.gz", hash = "sha256:ad33358114df7c9416cdb8fa1eaa5852166c505118717021c6a8c7c7abbd03dd"},
+]
+
+[[package]]
+name = "black"
+version = "23.7.0"
+requires_python = ">=3.8"
+summary = "The uncompromising code formatter."
+dependencies = [
+    "click>=8.0.0",
+    "mypy-extensions>=0.4.3",
+    "packaging>=22.0",
+    "pathspec>=0.9.0",
+    "platformdirs>=2",
+    "tomli>=1.1.0; python_version < \"3.11\"",
+]
+files = [
+    {file = "black-23.7.0-cp310-cp310-macosx_10_16_arm64.whl", hash = "sha256:5c4bc552ab52f6c1c506ccae05681fab58c3f72d59ae6e6639e8885e94fe2587"},
+    {file = "black-23.7.0-cp310-cp310-macosx_10_16_universal2.whl", hash = "sha256:552513d5cd5694590d7ef6f46e1767a4df9af168d449ff767b13b084c020e63f"},
+    {file = "black-23.7.0-cp310-cp310-macosx_10_16_x86_64.whl", hash = "sha256:86cee259349b4448adb4ef9b204bb4467aae74a386bce85d56ba4f5dc0da27be"},
+    {file = "black-23.7.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:501387a9edcb75d7ae8a4412bb8749900386eaef258f1aefab18adddea1936bc"},
+    {file = "black-23.7.0-cp310-cp310-win_amd64.whl", hash = "sha256:fb074d8b213749fa1d077d630db0d5f8cc3b2ae63587ad4116e8a436e9bbe995"},
+    {file = "black-23.7.0-py3-none-any.whl", hash = "sha256:9fd59d418c60c0348505f2ddf9609c1e1de8e7493eab96198fc89d9f865e7a96"},
+    {file = "black-23.7.0.tar.gz", hash = "sha256:022a582720b0d9480ed82576c920a8c1dde97cc38ff11d8d8859b3bd6ca9eedb"},
+]
+
+[[package]]
+name = "click"
+version = "8.1.7"
+requires_python = ">=3.7"
+summary = "Composable command line interface toolkit"
+dependencies = [
+    "colorama; platform_system == \"Windows\"",
+]
+files = [
+    {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"},
+    {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"},
+]
+
+[[package]]
+name = "colorama"
+version = "0.4.6"
+requires_python = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+summary = "Cross-platform colored terminal text."
+files = [
+    {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
+    {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
+]
+
+[[package]]
+name = "flake8"
+version = "6.1.0"
+requires_python = ">=3.8.1"
+summary = "the modular source code checker: pep8 pyflakes and co"
+dependencies = [
+    "mccabe<0.8.0,>=0.7.0",
+    "pycodestyle<2.12.0,>=2.11.0",
+    "pyflakes<3.2.0,>=3.1.0",
+]
+files = [
+    {file = "flake8-6.1.0-py2.py3-none-any.whl", hash = "sha256:ffdfce58ea94c6580c77888a86506937f9a1a227dfcd15f245d694ae20a6b6e5"},
+    {file = "flake8-6.1.0.tar.gz", hash = "sha256:d5b3857f07c030bdb5bf41c7f53799571d75c4491748a3adcd47de929e34cd23"},
+]
+
+[[package]]
+name = "macholib"
+version = "1.16.2"
+summary = "Mach-O header analysis and editing"
+dependencies = [
+    "altgraph>=0.17",
+]
+files = [
+    {file = "macholib-1.16.2-py2.py3-none-any.whl", hash = "sha256:44c40f2cd7d6726af8fa6fe22549178d3a4dfecc35a9cd15ea916d9c83a688e0"},
+    {file = "macholib-1.16.2.tar.gz", hash = "sha256:557bbfa1bb255c20e9abafe7ed6cd8046b48d9525db2f9b77d3122a63a2a8bf8"},
+]
+
+[[package]]
+name = "mccabe"
+version = "0.7.0"
+requires_python = ">=3.6"
+summary = "McCabe checker, plugin for flake8"
+files = [
+    {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"},
+    {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"},
+]
+
+[[package]]
+name = "mypy-extensions"
+version = "1.0.0"
+requires_python = ">=3.5"
+summary = "Type system extensions for programs checked with the mypy type checker."
+files = [
+    {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"},
+    {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"},
+]
+
+[[package]]
+name = "packaging"
+version = "23.1"
+requires_python = ">=3.7"
+summary = "Core utilities for Python packages"
+files = [
+    {file = "packaging-23.1-py3-none-any.whl", hash = "sha256:994793af429502c4ea2ebf6bf664629d07c1a9fe974af92966e4b8d2df7edc61"},
+    {file = "packaging-23.1.tar.gz", hash = "sha256:a392980d2b6cffa644431898be54b0045151319d1e7ec34f0cfed48767dd334f"},
+]
+
+[[package]]
+name = "pathspec"
+version = "0.11.2"
+requires_python = ">=3.7"
+summary = "Utility library for gitignore style pattern matching of file paths."
+files = [
+    {file = "pathspec-0.11.2-py3-none-any.whl", hash = "sha256:1d6ed233af05e679efb96b1851550ea95bbb64b7c490b0f5aa52996c11e92a20"},
+    {file = "pathspec-0.11.2.tar.gz", hash = "sha256:e0d8d0ac2f12da61956eb2306b69f9469b42f4deb0f3cb6ed47b9cce9996ced3"},
+]
+
+[[package]]
+name = "pefile"
+version = "2023.2.7"
+requires_python = ">=3.6.0"
+summary = "Python PE parsing module"
+files = [
+    {file = "pefile-2023.2.7-py3-none-any.whl", hash = "sha256:da185cd2af68c08a6cd4481f7325ed600a88f6a813bad9dea07ab3ef73d8d8d6"},
+    {file = "pefile-2023.2.7.tar.gz", hash = "sha256:82e6114004b3d6911c77c3953e3838654b04511b8b66e8583db70c65998017dc"},
+]
+
+[[package]]
+name = "platformdirs"
+version = "3.10.0"
+requires_python = ">=3.7"
+summary = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
+files = [
+    {file = "platformdirs-3.10.0-py3-none-any.whl", hash = "sha256:d7c24979f292f916dc9cbf8648319032f551ea8c49a4c9bf2fb556a02070ec1d"},
+    {file = "platformdirs-3.10.0.tar.gz", hash = "sha256:b45696dab2d7cc691a3226759c0d3b00c47c8b6e293d96f6436f733303f77f6d"},
+]
+
+[[package]]
+name = "psgdemos"
+version = "1.12.1"
+summary = "Installs the full set of PySimpleGUI Demo Programs and the Demo Browser."
+dependencies = [
+    "PySimpleGUI",
+]
+files = [
+    {file = "psgdemos-1.12.1-py3-none-any.whl", hash = "sha256:a035540dd0ff92f410aed9b7af8d5a641d9d5a9eac3e0072ef115adf06abb447"},
+    {file = "psgdemos-1.12.1.tar.gz", hash = "sha256:4108af795477531a9b1c8675b9aa9b6628c109e660f6954baf8ba2dc3b5806e9"},
+]
+
+[[package]]
+name = "pycodestyle"
+version = "2.11.0"
+requires_python = ">=3.8"
+summary = "Python style guide checker"
+files = [
+    {file = "pycodestyle-2.11.0-py2.py3-none-any.whl", hash = "sha256:5d1013ba8dc7895b548be5afb05740ca82454fd899971563d2ef625d090326f8"},
+    {file = "pycodestyle-2.11.0.tar.gz", hash = "sha256:259bcc17857d8a8b3b4a2327324b79e5f020a13c16074670f9c8c8f872ea76d0"},
+]
+
+[[package]]
+name = "pyflakes"
+version = "3.1.0"
+requires_python = ">=3.8"
+summary = "passive checker of Python programs"
+files = [
+    {file = "pyflakes-3.1.0-py2.py3-none-any.whl", hash = "sha256:4132f6d49cb4dae6819e5379898f2b8cce3c5f23994194c24b77d5da2e36f774"},
+    {file = "pyflakes-3.1.0.tar.gz", hash = "sha256:a0aae034c444db0071aa077972ba4768d40c830d9539fd45bf4cd3f8f6992efc"},
+]
+
+[[package]]
+name = "pyinstaller"
+version = "5.13.0"
+requires_python = "<3.13,>=3.7"
+summary = "PyInstaller bundles a Python application and all its dependencies into a single package."
+dependencies = [
+    "altgraph",
+    "macholib>=1.8; sys_platform == \"darwin\"",
+    "pefile>=2022.5.30; sys_platform == \"win32\"",
+    "pyinstaller-hooks-contrib>=2021.4",
+    "pywin32-ctypes>=0.2.1; sys_platform == \"win32\"",
+    "setuptools>=42.0.0",
+]
+files = [
+    {file = "pyinstaller-5.13.0-py3-none-macosx_10_13_universal2.whl", hash = "sha256:7fdd319828de679f9c5e381eff998ee9b4164bf4457e7fca56946701cf002c3f"},
+    {file = "pyinstaller-5.13.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:0df43697c4914285ecd333be968d2cd042ab9b2670124879ee87931d2344eaf5"},
+    {file = "pyinstaller-5.13.0-py3-none-manylinux2014_i686.whl", hash = "sha256:28d9742c37e9fb518444b12f8c8ab3cb4ba212d752693c34475c08009aa21ccf"},
+    {file = "pyinstaller-5.13.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:e5fb17de6c325d3b2b4ceaeb55130ad7100a79096490e4c5b890224406fa42f4"},
+    {file = "pyinstaller-5.13.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:78975043edeb628e23a73fb3ef0a273cda50e765f1716f75212ea3e91b09dede"},
+    {file = "pyinstaller-5.13.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:cd7d5c06f2847195a23d72ede17c60857d6f495d6f0727dc6c9bc1235f2eb79c"},
+    {file = "pyinstaller-5.13.0-py3-none-musllinux_1_1_aarch64.whl", hash = "sha256:24009eba63cfdbcde6d2634e9c87f545eb67249ddf3b514e0cd3b2cdaa595828"},
+    {file = "pyinstaller-5.13.0-py3-none-musllinux_1_1_x86_64.whl", hash = "sha256:1fde4381155f21d6354dc450dcaa338cd8a40aaacf6bd22b987b0f3e1f96f3ee"},
+    {file = "pyinstaller-5.13.0-py3-none-win32.whl", hash = "sha256:2d03419904d1c25c8968b0ad21da0e0f33d8d65716e29481b5bd83f7f342b0c5"},
+    {file = "pyinstaller-5.13.0-py3-none-win_amd64.whl", hash = "sha256:9fc27c5a853b14a90d39c252707673c7a0efec921cd817169aff3af0fca8c127"},
+    {file = "pyinstaller-5.13.0-py3-none-win_arm64.whl", hash = "sha256:3a331951f9744bc2379ea5d65d36f3c828eaefe2785f15039592cdc08560b262"},
+    {file = "pyinstaller-5.13.0.tar.gz", hash = "sha256:5e446df41255e815017d96318e39f65a3eb807e74a796c7e7ff7f13b6366a2e9"},
+]
+
+[[package]]
+name = "pyinstaller-hooks-contrib"
+version = "2023.7"
+requires_python = ">=3.7"
+summary = "Community maintained hooks for PyInstaller"
+files = [
+    {file = "pyinstaller-hooks-contrib-2023.7.tar.gz", hash = "sha256:0c436a4c3506020e34116a8a7ddfd854c1ad6ddca9a8cd84500bd6e69c9e68f9"},
+    {file = "pyinstaller_hooks_contrib-2023.7-py2.py3-none-any.whl", hash = "sha256:3c10df14c0f71ab388dfbf1625375b087e7330d9444cbfd2b310ba027fa0cff0"},
+]
 
 [[package]]
 name = "pyparsing"
@@ -27,6 +239,26 @@ files = [
     {file = "PySimpleGUI-4.60.5.tar.gz", hash = "sha256:31014d1cc5eef1373d7e93564ff2604662645cc774a939b1f01aa253e7f9d78b"},
 ]
 
+[[package]]
+name = "pywin32-ctypes"
+version = "0.2.2"
+requires_python = ">=3.6"
+summary = "A (partial) reimplementation of pywin32 using ctypes/cffi"
+files = [
+    {file = "pywin32-ctypes-0.2.2.tar.gz", hash = "sha256:3426e063bdd5fd4df74a14fa3cf80a0b42845a87e1d1e81f6549f9daec593a60"},
+    {file = "pywin32_ctypes-0.2.2-py3-none-any.whl", hash = "sha256:bf490a1a709baf35d688fe0ecf980ed4de11d2b3e37b51e5442587a75d9957e7"},
+]
+
+[[package]]
+name = "setuptools"
+version = "68.1.2"
+requires_python = ">=3.8"
+summary = "Easily download, build, install, upgrade, and uninstall Python packages"
+files = [
+    {file = "setuptools-68.1.2-py3-none-any.whl", hash = "sha256:3d8083eed2d13afc9426f227b24fd1659489ec107c0e86cec2ffdde5c92e790b"},
+    {file = "setuptools-68.1.2.tar.gz", hash = "sha256:3d4dfa6d95f1b101d695a6160a7626e15583af71a5f52176efa5d39a054d475d"},
+]
+
 [[package]]
 name = "tomli"
 version = "2.0.1"
@@ -39,13 +271,13 @@ files = [
 
 [[package]]
 name = "voicemeeter-api"
-version = "2.4.8"
+version = "2.4.9"
 requires_python = ">=3.10,<4.0"
 summary = "A Python wrapper for the Voiceemeter API"
 dependencies = [
     "tomli<3.0.0,>=2.0.1; python_version < \"3.11\"",
 ]
 files = [
-    {file = "voicemeeter_api-2.4.8-py3-none-any.whl", hash = "sha256:a3ff9e6f7516d2adedde93f6976526b385d8ae6d86598bfe541a44f498f42ea6"},
+    {file = "voicemeeter_api-2.4.9-py3-none-any.whl", hash = "sha256:a09fd07fe3799cd5c880d491048da81d94e49aa97ec753aa1f9289acd27be965"},
-    {file = "voicemeeter_api-2.4.8.tar.gz", hash = "sha256:0d37a9f2af0f68087aa9c76a8cfb2ba44c6b75bb344e8dfa9fd18ad2c862730c"},
+    {file = "voicemeeter_api-2.4.9.tar.gz", hash = "sha256:47ad614a8b9ccb0b4e47acf65666ce0f0537a0890fffda9949e995bea70e679c"},
 ]

pyproject.toml

@@ -1,16 +1,32 @@
 [project]
 name = "nvda_voicemeeter"
-version = "0.1.0"
+version = "0.4.1"
 description = "A Voicemeeter app compatible with NVDA"
 authors = [
-    {name = "onyx-and-iris", email = "code@onyxandiris.online"},
+    { name = "onyx-and-iris", email = "code@onyxandiris.online" },
 ]
 dependencies = [
     "pysimplegui>=4.60.5",
     "pyparsing>=3.1.1",
-    "voicemeeter-api>=2.4.8",
+    "voicemeeter-api>=2.4.9",
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.10,<3.12"
 readme = "README.md"
-license = {text = "MIT"}
 
+[project.license]
+text = "MIT"
+
+[tool.pdm.dev-dependencies]
+build = [
+    "pyinstaller>=5.1",
+]
+lint = [
+    "black>=23.7.0",
+    "flake8>=6.1.0",
+]
+test = [
+    "psgdemos>=1.12.1",
+]
+
+[tool.pdm.scripts.build]
+shell = "build.ps1"

src/nvda_voicemeeter/__init__.py

@@ -1 +1,14 @@
-from .window import request_window_object as build
+import subprocess as sp
+import time
+
+from .cdll import NVDA_PATH
+from .window import request_window_object as draw
+
+
+def launch(delay=1):
+    if NVDA_PATH:
+        sp.Popen([NVDA_PATH], shell=True)
+        time.sleep(delay)
+
+
+__ALL__ = ["launch", "draw"]

src/nvda_voicemeeter/builder.py

@@ -0,0 +1,513 @@
+import PySimpleGUI as psg
+
+from . import util
+from .compound import LabelSlider
+
+
+class Builder:
+    """Responsible for building the Window layout"""
+
+    def __init__(self, window):
+        self.window = window
+        self.vm = self.window.vm
+        self.kind = self.vm.kind
+
+    def run(self) -> list:
+        menu = [[self.make_menu()]]
+
+        layout0 = []
+        if self.kind.name == "basic":
+            steps = (
+                self.make_tab0_row0,
+                self.make_tab0_row1,
+                self.make_tab0_row5,
+            )
+        else:
+            steps = (
+                self.make_tab0_row0,
+                self.make_tab0_row1,
+                self.make_tab0_row2,
+                self.make_tab0_row3,
+                self.make_tab0_row4,
+                self.make_tab0_row5,
+            )
+        for step in steps:
+            layout0.append([step()])
+
+        layout1_1 = []
+        steps = (self.make_tab1_button_rows,)
+        for step in steps:
+            layout1_1.append([step()])
+        layout1_2 = []
+        steps = (self.make_tab1_slider_rows,)
+        for step in steps:
+            layout1_2.append([step()])
+
+        layout2_1 = []
+        steps = (self.make_tab2_button_rows,)
+        for step in steps:
+            layout2_1.append([step()])
+        layout2_2 = []
+        steps = (self.make_tab2_slider_rows,)
+        for step in steps:
+            layout2_2.append([step()])
+
+        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()])
+
+        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]]
+
+    def make_menu(self) -> psg.Menu:
+        menu_def = [
+            [
+                "&Voicemeeter",
+                [
+                    "Restart Audio Engine::MENU",
+                    "Save Settings::MENU",
+                    "Load Settings::MENU",
+                    "Load Settings on Startup ::MENU",
+                ],
+            ],
+        ]
+        return psg.Menu(menu_def, key="menus")
+
+    def make_tab0_row0(self) -> psg.Frame:
+        """tab0 row0 represents hardware ins"""
+
+        def add_physical_device_opts(layout):
+            devices = util.get_input_device_list(self.vm)
+            devices.append("- remove device selection -")
+            layout.append(
+                [
+                    psg.ButtonMenu(
+                        f"IN {i + 1}",
+                        size=(6, 3),
+                        menu_def=["", devices],
+                        key=f"HARDWARE IN||{i + 1}",
+                    )
+                    for i in range(self.kind.phys_in)
+                ]
+            )
+
+        hardware_in = []
+        [step(hardware_in) for step in (add_physical_device_opts,)]
+        return psg.Frame("Hardware In", hardware_in)
+
+    def make_tab0_row1(self) -> psg.Frame:
+        """tab0 row1 represents hardware outs"""
+
+        def add_physical_device_opts(layout):
+            if self.kind.name == "basic":
+                num_outs = self.kind.phys_out + self.kind.virt_out
+            else:
+                num_outs = self.kind.phys_out
+            layout.append(
+                [
+                    psg.ButtonMenu(
+                        f"A{i + 1}",
+                        size=(6, 3),
+                        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 = []
+        [step(hardware_out) for step in (add_physical_device_opts,)]
+        return psg.Frame("Hardware Out", hardware_out)
+
+    def make_tab0_row2(self) -> psg.Frame:
+        """tab0 row2 represents patch asio inputs to strips"""
+
+        def add_asio_checkboxes(layout, i):
+            nums = list(range(99))
+            layout.append(
+                [
+                    psg.Spin(
+                        nums,
+                        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",
+                    )
+                ],
+            )
+            layout.append(
+                [
+                    psg.Spin(
+                        nums,
+                        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",
+                    )
+                ],
+            )
+
+        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,)]
+            inner.append(psg.Frame(f"In#{i + 1}", checkbox_list))
+
+        asio_checkboxes = [inner]
+        return psg.Frame("PATCH ASIO Inputs to Strips", asio_checkboxes)
+
+    def make_tab0_row3(self) -> psg.Frame:
+        """tab0 row3 represents patch composite"""
+
+        def add_physical_device_opts(layout):
+            outputs = util.get_patch_composite_list(self.vm.kind)
+            layout.append(
+                [
+                    psg.ButtonMenu(
+                        f"PC{i + 1}",
+                        size=(6, 2),
+                        menu_def=["", outputs],
+                        key=f"PATCH COMPOSITE||PC{i + 1}",
+                    )
+                    for i in range(self.kind.phys_out)
+                ]
+            )
+
+        hardware_out = []
+        [step(hardware_out) for step in (add_physical_device_opts,)]
+        return psg.Frame("PATCH COMPOSITE", hardware_out)
+
+    def make_tab0_row4(self) -> psg.Frame:
+        """tab0 row4 represents patch insert"""
+
+        def add_insert_checkboxes(layout, i):
+            if i <= self.kind.phys_in:
+                [
+                    layout.append(
+                        [
+                            psg.Checkbox(
+                                text=channel,
+                                default=self.window.cache["insert"][
+                                    f"INSERT CHECKBOX||{util.get_insert_checkbox_index(self.kind, j, i)}"
+                                ],
+                                enable_events=True,
+                                key=f"INSERT CHECKBOX||IN{i} {j}",
+                            )
+                        ],
+                    )
+                    for j, channel in enumerate(("LEFT", "RIGHT"))
+                ]
+            else:
+                layout.append(
+                    [
+                        psg.Checkbox(
+                            text=channel,
+                            default=self.window.cache["insert"][
+                                f"INSERT CHECKBOX||{util.get_insert_checkbox_index(self.kind, j, i)}"
+                            ],
+                            enable_events=True,
+                            key=f"INSERT CHECKBOX||IN{i} {j}",
+                        )
+                        for j, channel in enumerate(("LEFT", "RIGHT", "C", "LFE", "SL", "SR", "BL", "BR"))
+                    ],
+                )
+
+        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:
+                [step(checkbox_list, i + 1) for step in (add_insert_checkboxes,)]
+                inner.append(psg.Frame(f"In#{i + 1}", checkbox_list))
+            else:
+                [step(checkbox_list, i + 1) for step in (add_insert_checkboxes,)]
+                asio_checkboxes.append([psg.Frame(f"In#{i + 1}", checkbox_list)])
+        asio_checkboxes.insert(0, inner)
+
+        return psg.Frame("PATCH INSERT", asio_checkboxes)
+
+    def make_tab0_row5(self) -> psg.Frame:
+        """tab0 row5 represents advanced settings"""
+
+        return psg.Frame(
+            "ADVANCED SETTINGS",
+            [
+                [
+                    psg.Button(
+                        "ADVANCED SETTINGS",
+                        size=(20, 2),
+                        key="ADVANCED SETTINGS",
+                    )
+                ],
+            ],
+            key="ADVANCED SETTINGS 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):
+            layout.append(
+                [
+                    psg.Button(
+                        f"A{j + 1}" if j < self.kind.phys_out else f"B{j - self.kind.phys_out + 1}",
+                        size=(4, 2),
+                        key=f"STRIP {i}||A{j + 1}"
+                        if j < self.kind.phys_out
+                        else f"STRIP {i}||B{j - self.kind.phys_out + 1}",
+                    )
+                    for j in range(self.kind.phys_out + self.kind.virt_out)
+                ],
+            )
+            layout.append(
+                [
+                    psg.Button("Mono", size=(6, 2), key=f"STRIP {i}||MONO"),
+                    psg.Button("Solo", size=(6, 2), key=f"STRIP {i}||SOLO"),
+                    psg.Button("Mute", size=(6, 2), key=f"STRIP {i}||MUTE"),
+                ],
+            )
+
+        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_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_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.kind)])
+
+        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):
+            layout.append(
+                [
+                    psg.Button(
+                        f"A{j + 1}" if j < self.kind.phys_out else f"B{j - self.kind.phys_out + 1}",
+                        size=(4, 2),
+                        key=f"STRIP {i}||A{j + 1}"
+                        if j < self.kind.phys_out
+                        else f"STRIP {i}||B{j - self.kind.phys_out + 1}",
+                    )
+                    for j in range(self.kind.phys_out + self.kind.virt_out)
+                ]
+            )
+            if i == self.kind.phys_in + 1:
+                layout.append(
+                    [
+                        psg.Button("K", size=(6, 2), key=f"STRIP {i}||MONO"),
+                        psg.Button("Solo", size=(6, 2), key=f"STRIP {i}||SOLO"),
+                        psg.Button("Mute", size=(6, 2), key=f"STRIP {i}||MUTE"),
+                    ],
+                )
+            else:
+                layout.append(
+                    [
+                        psg.Button("MC", size=(6, 2), key=f"STRIP {i}||MONO"),
+                        psg.Button("Solo", size=(6, 2), key=f"STRIP {i}||SOLO"),
+                        psg.Button("Mute", size=(6, 2), key=f"STRIP {i}||MUTE"),
+                    ],
+                )
+
+        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_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_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.kind):
+                    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.kind)
+                    ]
+                )
+
+        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):
+            params = ["MONO", "EQ", "MUTE", "MODE"]
+            if self.vm.kind.name == "basic":
+                params.remove("EQ")
+            label = {"MODE": "BUSMODE"}
+            layout.append(
+                [
+                    psg.Button(
+                        label.get(param, param.capitalize()),
+                        size=(12 if param == "MODE" else 6, 2),
+                        key=f"BUS {i}||{param}",
+                    )
+                    for param in params
+                ]
+            )
+
+        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_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/cdll.py

@@ -1,9 +1,45 @@
 import ctypes as ct
+import platform
+import winreg
 from pathlib import Path
 
+from .errors import NVDAVMError
+
 bits = 64 if ct.sizeof(ct.c_voidp) == 8 else 32
 
+if platform.system() != "Windows":
+    raise NVDAVMError("Only Windows OS supported")
+
+REG_KEY = "\\".join(
+    filter(
+        None,
+        (
+            "SOFTWARE",
+            "WOW6432Node" if bits == 64 else "",
+            "Microsoft",
+            "Windows",
+            "CurrentVersion",
+            "Uninstall",
+            "NVDA",
+        ),
+    )
+)
+
+
+def get_nvdapath():
+    with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"{}".format(REG_KEY)) as nvda_key:
+        return winreg.QueryValueEx(nvda_key, r"UninstallDirectory")[0]
+
+
+try:
+    NVDA_PATH = Path(get_nvdapath()) / "nvda.exe"
+except FileNotFoundError as e:
+    NVDA_PATH = ""
+
+
 controller_path = Path(__file__).parents[2].resolve() / "controllerClient"
+if not controller_path.exists():
+    controller_path = Path("controllerClient")
 
 DLL_PATH = controller_path / f"x{64 if bits == 64 else 86}" / f"nvdaControllerClient{bits}.dll"
 

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/errors.py

@@ -0,0 +1,11 @@
+class NVDAVMError(Exception):
+    """Base NVDAVM error class"""
+
+
+class NVDAVMCAPIError(NVDAVMError):
+    """Exception raised when the NVDA C-API returns an error code"""
+
+    def __init__(self, fn_name, code):
+        self.fn_name = fn_name
+        self.code = code
+        super().__init__(f"{self.fn_name} returned {self.code}")

src/nvda_voicemeeter/models.py

@@ -1,26 +1,83 @@
-def _make_cache(vm) -> dict:
+def _make_hardware_ins_cache(vm) -> dict:
+    return {**{f"HARDWARE IN||{i + 1}": vm.strip[i].device.name for i in range(vm.kind.phys_in)}}
+
+
+def _make_hardware_outs_cache(vm) -> dict:
+    hw_outs = {**{f"HARDWARE OUT||A{i + 1}": vm.bus[i].device.name for i in range(vm.kind.phys_out)}}
+    if vm.kind.name == "basic":
+        hw_outs |= {f"HARDWARE OUT||A2": vm.bus[1].device.name}
+    return hw_outs
+
+
+def _make_param_cache(vm, channel_type) -> dict:
+    params = {}
+    if channel_type == "strip":
         match vm.kind.name:
             case "basic":
-            return {
+                params |= {
-                **{f"BUTTON||strip {i} A1": vm.strip[i].A1 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A1": vm.strip[i].A1 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} B1": vm.strip[i].B1 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||B1": vm.strip[i].B1 for i in range(vm.kind.num_strip)},
                 }
             case "banana":
-            return {
+                params |= {
-                **{f"BUTTON||strip {i} A1": vm.strip[i].A1 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A1": vm.strip[i].A1 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} A2": vm.strip[i].A2 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A2": vm.strip[i].A2 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} A3": vm.strip[i].A3 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A3": vm.strip[i].A3 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} B1": vm.strip[i].B1 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||B1": vm.strip[i].B1 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} B2": vm.strip[i].B2 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||B2": vm.strip[i].B2 for i in range(vm.kind.num_strip)},
                 }
             case "potato":
-            return {
+                params |= {
-                **{f"BUTTON||strip {i} A1": vm.strip[i].A1 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A1": vm.strip[i].A1 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} A2": vm.strip[i].A2 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A2": vm.strip[i].A2 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} A3": vm.strip[i].A3 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A3": vm.strip[i].A3 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} A4": vm.strip[i].A4 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A4": vm.strip[i].A4 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} A5": vm.strip[i].A5 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||A5": vm.strip[i].A5 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} B1": vm.strip[i].B1 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||B1": vm.strip[i].B1 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} B2": vm.strip[i].B2 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||B2": vm.strip[i].B2 for i in range(vm.kind.num_strip)},
-                **{f"BUTTON||strip {i} B3": vm.strip[i].B3 for i in range(vm.kind.num_strip)},
+                    **{f"STRIP {i}||B3": vm.strip[i].B3 for i in range(vm.kind.num_strip)},
                 }
+        params |= {
+            **{f"STRIP {i}||MONO": vm.strip[i].mono for i in range(vm.kind.num_strip)},
+            **{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)},
+        }
+    else:
+        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:
+    return {
+        **{
+            f"STRIP {i}||LABEL": vm.strip[i].label if vm.strip[i].label else f"Hardware Input {i + 1}"
+            for i in range(vm.kind.phys_in)
+        },
+        **{
+            f"STRIP {i}||LABEL": vm.strip[i].label if vm.strip[i].label else f"Virtual Input {i - vm.kind.phys_in + 1}"
+            for i in range(vm.kind.phys_in, vm.kind.phys_in + vm.kind.virt_in)
+        },
+        **{
+            f"BUS {i}||LABEL": vm.bus[i].label if vm.bus[i].label else f"Physical Bus {i + 1}"
+            for i in range(vm.kind.phys_out)
+        },
+        **{
+            f"BUS {i}||LABEL": vm.bus[i].label if vm.bus[i].label else f"Virtual Bus {i - vm.kind.phys_out + 1}"
+            for i in range(vm.kind.phys_out, vm.kind.phys_out + vm.kind.virt_out)
+        },
+    }
+
+
+def _make_patch_asio_cache(vm) -> dict:
+    if vm.kind.name != "basic":
+        return {**{f"ASIO CHECKBOX||{i}": vm.patch.asio[i].get() for i in range(vm.kind.phys_out * 2)}}
+
+
+def _make_patch_insert_cache(vm) -> dict:
+    if vm.kind.name != "basic":
+        return {**{f"INSERT CHECKBOX||{i}": vm.patch.insert[i].on for i in range(vm.kind.num_strip_levels)}}

src/nvda_voicemeeter/nvda.py

@@ -1,4 +1,5 @@
 from .cdll import libc
+from .errors import NVDAVMCAPIError
 
 
 class CBindings:
@@ -10,14 +11,14 @@ class CBindings:
     def call(self, fn, *args, ok=(0,)):
         retval = fn(*args)
         if retval not in ok:
-            raise RuntimeError(f"{fn.__name__} returned {retval}")
+            raise NVDAVMCAPIError(fn.__name__, retval)
         return retval
 
 
 class Nvda(CBindings):
     @property
     def is_running(self):
-        return self.call(self.bind_test_if_running, ok=(0, 1)) == 0
+        return self.call(self.bind_test_if_running) == 0
 
     def speak(self, text):
         self.call(self.bind_speak_text, text)

src/nvda_voicemeeter/parser.py

@@ -1,10 +1,15 @@
-from pyparsing import Group, OneOrMore, Optional, Suppress, Word, alphanums
+from pyparsing import Group, OneOrMore, Optional, Suppress, Word, alphanums, restOfLine
 
 
 class Parser:
     def __init__(self):
         self.widget = Group(OneOrMore(Word(alphanums)))
-        self.token = Suppress("||")
+        self.widget_token = Suppress("||")
         self.identifier = Group(OneOrMore(Word(alphanums)))
-        self.event = OneOrMore(Word(alphanums))
+        self.event = Group(OneOrMore(Word(alphanums)))
-        self.match = self.widget + self.token + self.identifier + Optional(self.token) + Optional(self.event)
+        self.menu_token = Suppress("::")
+        self.match = (
+            self.widget + self.widget_token + self.identifier + Optional(self.widget_token) + Optional(self.event)
+            | self.identifier + self.menu_token + self.event
+            | restOfLine
+        )

src/nvda_voicemeeter/popup.py

@@ -0,0 +1,157 @@
+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.kind = self.window.kind
+        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, index, title=None, tab=None):
+        if "Strip" in tab:
+            if index < self.kind.phys_in:
+                title += f" Physical Strip {index + 1}"
+            else:
+                title += f" Virtual Strip {index - self.kind.phys_in + 1}"
+        else:
+            if index < self.kind.phys_out:
+                title += f" Physical Bus {index + 1}"
+            else:
+                title += f" Virtual Bus {index - self.kind.phys_out + 1}"
+        layout = [
+            [psg.Text(message)],
+            [
+                [
+                    psg.Input(key="Edit"),
+                ],
+                [psg.Button("Ok"), psg.Button("Cancel")],
+            ],
+        ]
+        popup = psg.Window(title, layout, finalize=True)
+        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 [[button], ["FOCUS", "IN"]]:
+                    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.window.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.window.vm.set(f"option.buffer.{driver.lower()}", val)
+                    self.window.TKroot.after(
+                        200, self.window.nvda.speak, f"{driver} BUFFER {val if val else 'default'}"
+                    )
+                case [["BUFFER", driver], ["FOCUS", "IN"]]:
+                    val = int(self.window.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

@@ -0,0 +1,159 @@
+from typing import Iterable
+
+
+def get_asio_checkbox_index(channel, num) -> int:
+    if channel == 0:
+        return 2 * num - 2
+    return 2 * num - 1
+
+
+def get_insert_checkbox_index(kind, channel, num) -> int:
+    if num <= kind.phys_in:
+        if channel == 0:
+            return 2 * num - 2
+        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:
+    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 = []
+    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 -")
+    return [device for device in devices if not device.startswith("asio")]
+
+
+def get_patch_composite_list(kind) -> list:
+    temp = []
+    for i in range(kind.phys_out):
+        [temp.append(f"IN#{i + 1} {channel}") for channel in ("Left", "Right")]
+    for i in range(kind.phys_out, kind.phys_out + kind.virt_out):
+        [temp.append(f"IN#{i + 1} {channel}") for channel in ("Left", "Right", "Center", "LFE", "SL", "SR", "BL", "BR")]
+    temp.append(f"BUS Channel")
+    return temp
+
+
+def get_patch_insert_channels() -> list:
+    return [
+        "left",
+        "right",
+        "center",
+        "low frequency effect",
+        "surround left",
+        "surround right",
+        "back left",
+        "back right",
+    ]
+
+
+_patch_insert_channels = get_patch_insert_channels()
+
+
+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:
+    return ["Settings", "Physical Strip", "Virtual Strip", "Buses"]
+
+
+def open_context_menu_for_buttonmenu(window, identifier) -> None:
+    element = window[identifier]
+    widget = element.widget
+    x = widget.winfo_rootx()
+    y = widget.winfo_rooty() + widget.winfo_height()
+    element.TKMenu.post(x, y)
+
+
+def get_channel_identifier_list(vm) -> list:
+    identifiers = []
+    for i in range(vm.kind.phys_in):
+        for j in range(2):
+            identifiers.append(f"IN{i + 1} {j}")
+    for i in range(vm.kind.phys_in, vm.kind.phys_in + vm.kind.virt_in):
+        for j in range(8):
+            identifiers.append(f"IN{i + 1} {j}")
+    return identifiers
+
+
+def get_bus_modes(vm) -> list:
+    if vm.kind.name == "basic":
+        return [
+            "normal",
+            "amix",
+            "repeat",
+            "composite",
+        ]
+    return [
+        "normal",
+        "amix",
+        "bmix",
+        "repeat",
+        "composite",
+        "tvmix",
+        "upmix21",
+        "upmix41",
+        "upmix61",
+        "centeronly",
+        "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, kind) -> Iterable:
+    if i < kind.phys_in:
+        if kind.name == "basic":
+            return ("AUDIBILITY",)
+        if kind.name == "banana":
+            return ("COMP", "GATE")
+        if kind.name == "potato":
+            return ("COMP", "GATE", "DENOISER")
+    return ("BASS", "MID", "TREBLE")
+
+
+def get_full_slider_params(i, kind) -> Iterable:
+    params = list(get_slider_params(i, kind) + ("GAIN", "LIMIT"))
+    if kind.name == "basic":
+        params.remove("LIMIT")
+    return params