adds version number to

announce_voicemeeter_version

.vscode/settings.json

@@ -1,8 +1,5 @@
 {
     "python.analysis.diagnosticSeverityOverrides": {
         "reportMissingImports": "none"
-    },
+    }
-    "black-formatter.args": [
-        "--line-length=120"
-    ]
 }

README.md

@@ -1,3 +1,49 @@
 # NVDA Addon Voicemeeter
 
 Control Voicemeeter GUI with customisable hotkeys.
+
+## Keybinds
+
+### Controllers
+
+- `NVDA+alt+s`: Enable strip mode
+- `NVDA+alt+b`: Enable bus mode.
+
+- `NVDA+alt+1`: Enable controller for channel 1 (strip|bus)
+- `NVDA+alt+2`: Enable controller for channel 2 (strip|bus)
+- `NVDA+alt+3`: Enable controller for channel 3 (strip|bus)
+- `NVDA+alt+4`: Enable controller for channel 4 (strip|bus)
+- `NVDA+alt+5`: Enable controller for channel 5 (strip|bus)
+- `NVDA+alt+6`: Enable controller for channel 6 (strip|bus)
+- `NVDA+alt+7`: Enable controller for channel 7 (strip|bus)
+- `NVDA+alt+8`: Enable controller for channel 8 (strip|bus)
+
+### Slider Modes
+
+- `NVDA+alt+g`: Enable gain slider mode.
+- `NVDA+alt+c`: Enable comp slider mode.
+- `NVDA+alt+t`: Enable gate sldier mode.
+- `NVDA+alt+d`: Enable denoiser slider mode.
+- `NVDA+alt+a`: Enable audibility slider mode.
+
+### Sliders
+
+- `NVDA+shift+upArrow`: Move slider up by 1 step
+- `NVDA+shift+downArrow`: Move slider down by 1 step
+- `NVDA+shift+alt+upArrow`: Move slider up by 0.1 step
+- `NVDA+shift+alt+downArrow`: Move slider down by 0.1 step
+- `NVDA+shift+control+upArrow`: Move slider up by 3 steps
+- `NVDA+shift+control+downArrow`: Move slider down by 3 steps
+
+### Channel Parameters
+
+- `NVDA+shift+o`: Mono
+- `NVDA+shift+s`: Solo
+- `NVDA+shift+m`: Mute
+- `NVDA+shift+c`: MC
+- `NVDA+shift+k`: Karaoke
+
+### Announcements
+
+- `NVDA+shift+q`: Announce current controller.
+- `NVDA+shift+a`: Announce Voicemeeter kind.

addon/globalPlugins/voicemeeter/__init__.py

@@ -14,11 +14,11 @@ def _make_gestures():
     defaults = {
         "kb:NVDA+alt+s": "strip_mode",
         "kb:NVDA+alt+b": "bus_mode",
-        "kb:NVDA+alt+g": "slider_mode",
+        "kb:NVDA+alt+g": "slider_mode",  # Gate
-        "kb:NVDA+alt+c": "slider_mode",
+        "kb:NVDA+alt+c": "slider_mode",  # Comp
-        "kb:NVDA+alt+t": "slider_mode",
+        "kb:NVDA+alt+t": "slider_mode",  # Gate
-        "kb:NVDA+alt+d": "slider_mode",
+        "kb:NVDA+alt+d": "slider_mode",  # Denoiser
-        "kb:NVDA+alt+a": "slider_mode",
+        "kb:NVDA+alt+a": "slider_mode",  # Audibility
         "kb:NVDA+shift+q": "announce_controller",
         "kb:NVDA+shift+a": "announce_voicemeeter_version",
         "kb:NVDA+shift+o": "toggle_mono",

addon/globalPlugins/voicemeeter/binds.py

@@ -1,51 +1,45 @@
 import ctypes as ct
-import winreg
+from ctypes.wintypes import CHAR, FLOAT, LONG
-from pathlib import Path
 
-from .error import VMError
+from .cdll import libc
+from .error import VMCAPIError
 
 
 class Binds:
-    VM_KEY = "VB:Voicemeeter {17359A74-1236-5467}"
+    bind_login = libc.VBVMR_Login
-    BITS = 64 if ct.sizeof(ct.c_voidp) == 8 else 32
+    bind_login.restype = LONG
+    bind_login.argtypes = None
 
-    def __init__(self):
+    bind_logout = libc.VBVMR_Logout
-        dll_path = Path(self.__vmpath()).parent.joinpath(
+    bind_logout.restype = LONG
-            f'VoicemeeterRemote{"64" if self.BITS == 64 else ""}.dll'
+    bind_logout.argtypes = None
-        )
-        if self.BITS == 64:
-            self.libc = ct.CDLL(str(dll_path))
-        else:
-            self.libc = ct.WinDLL(str(dll_path))
 
-    def __vmpath(self):
+    bind_run_voicemeeter = libc.VBVMR_RunVoicemeeter
-        with winreg.OpenKey(
+    bind_run_voicemeeter.restype = LONG
-            winreg.HKEY_LOCAL_MACHINE,
+    bind_run_voicemeeter.argtypes = [LONG]
-            r"{}".format(
+
-                "\\".join(
+    bind_get_voicemeeter_type = libc.VBVMR_GetVoicemeeterType
-                    (
+    bind_get_voicemeeter_type.restype = LONG
-                        "\\".join(
+    bind_get_voicemeeter_type.argtypes = [ct.POINTER(LONG)]
-                            filter(
+
-                                None,
+    bind_get_voicemeeter_version = libc.VBVMR_GetVoicemeeterVersion
-                                (
+    bind_get_voicemeeter_version.restype = LONG
-                                    "SOFTWARE",
+    bind_get_voicemeeter_version.argtypes = [ct.POINTER(LONG)]
-                                    "WOW6432Node" if self.BITS == 64 else "",
+
-                                    "Microsoft",
+    bind_is_parameters_dirty = libc.VBVMR_IsParametersDirty
-                                    "Windows",
+    bind_is_parameters_dirty.restype = LONG
-                                    "CurrentVersion",
+    bind_is_parameters_dirty.argtypes = None
-                                    "Uninstall",
+
-                                ),
+    bind_get_parameter_float = libc.VBVMR_GetParameterFloat
-                            )
+    bind_get_parameter_float.restype = LONG
-                        ),
+    bind_get_parameter_float.argtypes = [ct.POINTER(CHAR), ct.POINTER(FLOAT)]
-                        self.VM_KEY,
+
-                    )
+    bind_set_parameter_float = libc.VBVMR_SetParameterFloat
-                )
+    bind_set_parameter_float.restype = LONG
-            ),
+    bind_set_parameter_float.argtypes = [ct.POINTER(CHAR), FLOAT]
-        ) as vm_key:
-            return winreg.QueryValueEx(vm_key, r"UninstallString")[0]
 
     def call(self, fn, *args, ok=(0,)):
-        retval = getattr(self.libc, fn)(*args)
+        retval = fn(*args)
         if retval not in ok:
-            raise VMError(f"{fn} returned {retval}")
+            raise VMCAPIError(fn.__name__, retval)
         return retval

addon/globalPlugins/voicemeeter/cdll.py

@@ -0,0 +1,49 @@
+import ctypes as ct
+import platform
+import winreg
+from pathlib import Path
+
+from .error import VMError
+
+BITS = 64 if ct.sizeof(ct.c_voidp) == 8 else 32
+
+if platform.system() != "Windows":
+    raise VMError("Only Windows OS supported")
+
+
+VM_KEY = "VB:Voicemeeter {17359A74-1236-5467}"
+REG_KEY = "\\".join(
+    filter(
+        None,
+        (
+            "SOFTWARE",
+            "WOW6432Node" if BITS == 64 else "",
+            "Microsoft",
+            "Windows",
+            "CurrentVersion",
+            "Uninstall",
+        ),
+    )
+)
+
+
+def get_vmpath():
+    with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, r"{}".format("\\".join((REG_KEY, VM_KEY)))) as vm_key:
+        return winreg.QueryValueEx(vm_key, r"UninstallString")[0]
+
+
+try:
+    vm_parent = Path(get_vmpath()).parent
+except FileNotFoundError as e:
+    raise VMError("Unable to fetch DLL path from the registry") from e
+
+DLL_NAME = f'VoicemeeterRemote{"64" if BITS == 64 else ""}.dll'
+
+dll_path = vm_parent.joinpath(DLL_NAME)
+if not dll_path.is_file():
+    raise VMError(f"Could not find {dll_path}")
+
+if BITS == 64:
+    libc = ct.CDLL(str(dll_path))
+else:
+    libc = ct.WinDLL(str(dll_path))

addon/globalPlugins/voicemeeter/commands.py

@@ -8,7 +8,7 @@ class CommandsMixin:
     ### ANNOUNCEMENTS ###
 
     def script_announce_voicemeeter_version(self, _):
-        ui.message(f"Running Voicemeeter {self.kind}")
+        ui.message(f"Running Voicemeeter {self.kind} {self.controller.version}")
 
     def script_announce_controller(self, _):
         ui.message(f"Controller for {self.controller.ctx.strategy} {self.controller.ctx.index + 1}")

addon/globalPlugins/voicemeeter/context.py

@@ -8,12 +8,8 @@ class Strategy(ABC):
         self._slider_mode = "gain"
 
     @abstractmethod
-    def __str__(self):
-        pass
-
-    @property
     def identifier(self):
-        return f"{self}[{self._index}]"
+        pass
 
     @property
     def index(self):
@@ -54,11 +50,19 @@ class StripStrategy(Strategy):
     def __str__(self):
         return "Strip"
 
+    @property
+    def identifier(self):
+        return f"{self}[{self._index}]"
+
 
 class BusStrategy(Strategy):
     def __str__(self):
         return "Bus"
 
+    @property
+    def identifier(self):
+        return f"{self}[{self._index}]"
+
 
 class Context:
     def __init__(self, strategy: Strategy) -> None:

addon/globalPlugins/voicemeeter/controller.py

@@ -3,45 +3,56 @@ import ctypes as ct
 from logHandler import log
 
 from .binds import Binds
+from .cdll import BITS
 from .context import Context, StripStrategy
 from .kinds import KindId
 
 
-class Controller:
+class Controller(Binds):
     def __init__(self):
-        self.binds = Binds()
         self.ctx = Context(StripStrategy(self, 0))
 
     def login(self):
-        retval = self.binds.call("VBVMR_Login", ok=(0, 1))
+        retval = self.call(self.bind_login, ok=(0, 1))
         log.info("INFO - logged into Voicemeeter Remote API")
         return retval
 
     def logout(self):
-        self.binds.call("VBVMR_Logout")
+        self.call(self.bind_logout)
         log.info("NFO - logged out of Voicemeeter Remote API")
 
     @property
     def kind_id(self):
         c_type = ct.c_long()
-        self.binds.call("VBVMR_GetVoicemeeterType", ct.byref(c_type))
+        self.call(self.bind_get_voicemeeter_type, ct.byref(c_type))
         return KindId(c_type.value).name.lower()
 
+    @property
+    def version(self):
+        ver = ct.c_long()
+        self.call(self.bind_get_voicemeeter_version, ct.byref(ver))
+        return "{}.{}.{}.{}".format(
+            (ver.value & 0xFF000000) >> 24,
+            (ver.value & 0x00FF0000) >> 16,
+            (ver.value & 0x0000FF00) >> 8,
+            ver.value & 0x000000FF,
+        )
+
     def run_voicemeeter(self, kind_id):
         val = kind_id.value
-        if val == 3 and Binds.BITS == 64:
+        if val == 3 and BITS == 64:
             val = 6
-        self.binds.call("VBVMR_RunVoicemeeter", val)
+        self.call(self.bind_run_voicemeeter, val)
 
     def __clear(self):
-        while self.binds.call("VBVMR_IsParametersDirty", ok=(0, 1)) == 1:
+        while self.call(self.bind_is_parameters_dirty, ok=(0, 1)) == 1:
             pass
 
     def _get(self, param):
         self.__clear()
         buf = ct.c_float()
-        self.binds.call("VBVMR_GetParameterFloat", param.encode(), ct.byref(buf))
+        self.call(self.bind_get_parameter_float, param.encode(), ct.byref(buf))
         return buf.value
 
     def _set(self, param, val):
-        self.binds.call("VBVMR_SetParameterFloat", param.encode(), ct.c_float(float(val)))
+        self.call(self.bind_set_parameter_float, param.encode(), ct.c_float(float(val)))

addon/globalPlugins/voicemeeter/error.py

@@ -1,2 +1,11 @@
 class VMError(Exception):
-    """Base VMError class"""
+    """Base voicemeeterlib exception class"""
+
+
+class VMCAPIError(VMError):
+    """Exception raised when the 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}")

build.ps1

@@ -4,8 +4,8 @@ param(
 
 function Copy-FilestoScratchpad {
     $source = Join-Path $PSScriptRoot "addon" "globalPlugins" "voicemeeter"
-    $target = Join-Path $env:appdata "nvda" "scratchpad" "globalPlugins"
+    $target = Join-Path $env:appdata "nvda" "scratchpad" "globalPlugins" "voicemeeter"
-    Copy-Item -Path $source -Destination $target -Recurse -Force
+    Robocopy $source $target /MIR /NFL /NDL /NJH /NJS /nc /ns /np
 }
 
 function main {

buildVars.py

@@ -28,7 +28,7 @@ addon_info = {
 The add-on requires Voicemeeter to be installed."""
     ),
     # version
-    "addon_version": "0.2",
+    "addon_version": "0.4",
     # Author(s)
     "addon_author": "onyx-and-iris <code@onyxandiris.online>",
     # URL for the add-on documentation support

pyproject.toml

@@ -0,0 +1,46 @@
+[tool.black]
+line-length = 119
+
+[tool.ruff]
+# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
+select = ["E", "F"]
+# Avoid enforcing line-length violations (`E501`). Let Black deal with this.
+ignore = ["E501"]
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["A", "B", "C", "D", "E", "F", "G", "I", "N", "Q", "S", "T", "W", "ANN", "ARG", "BLE", "COM", "DJ", "DTZ", "EM", "ERA", "EXE", "FBT", "ICN", "INP", "ISC", "NPY", "PD", "PGH", "PIE", "PL", "PT", "PTH", "PYI", "RET", "RSE", "RUF", "SIM", "SLF", "TCH", "TID", "TRY", "UP", "YTT"]
+unfixable = []
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+]
+# Same as Black.
+line-length = 119
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+# Assume Python 3.7
+target-version = "py37"
+[tool.ruff.mccabe]
+# Unlike Flake8, default to a complexity level of 10.
+max-complexity = 10
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["E402", "F401"] # Ignore unused import and variable not accessed violations