bump to 0.5

config.py added. loads custom user settings

_make_gestures moved into util.py

.vscode/settings.json

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

README.md

@@ -1,3 +1,53 @@
 # NVDA Addon Voicemeeter
 
-Control Voicemeeter GUI with customisable hotkeys.
+Control Voicemeeter with global hotkeys.
+
+## Install
+
+This addon can be installed through the Add-on store, `Install from external source`. Simply download the latest Release and load it with NVDA.
+
+## 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 slider 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

@@ -1,63 +1,16 @@
-import json
 import time
-from pathlib import Path
 
 import globalPluginHandler
-from logHandler import log
 
+from . import config, util
 from .commands import CommandsMixin
 from .controller import Controller
 from .kinds import KindId, request_kind_map
 
 
-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+c": "slider_mode",
-        "kb:NVDA+alt+t": "slider_mode",
-        "kb:NVDA+alt+d": "slider_mode",
-        "kb:NVDA+alt+a": "slider_mode",
-        "kb:NVDA+shift+q": "announce_controller",
-        "kb:NVDA+shift+a": "announce_voicemeeter_version",
-        "kb:NVDA+shift+o": "toggle_mono",
-        "kb:NVDA+shift+s": "toggle_solo",
-        "kb:NVDA+shift+m": "toggle_mute",
-        "kb:NVDA+shift+c": "toggle_mc",
-        "kb:NVDA+shift+k": "karaoke",
-        "kb:NVDA+shift+upArrow": "slider_increase",
-        "kb:NVDA+shift+downArrow": "slider_decrease",
-        "kb:NVDA+shift+alt+upArrow": "slider_increase",
-        "kb:NVDA+shift+alt+downArrow": "slider_decrease",
-        "kb:NVDA+shift+control+upArrow": "slider_increase",
-        "kb:NVDA+shift+control+downArrow": "slider_decrease",
-    }
-
-    overrides = None
-    pn = Path.home() / "Documents" / "Voicemeeter" / "keybinds.json"
-    if pn.exists():
-        with open(pn, "r") as f:
-            data = json.load(f)
-        overrides = {f"kb:{v}": k for k, v in data.items()}
-        log.info("INFO - loading settings from keybinds.json")
-    if overrides:
-        return {**defaults, **overrides}
-    return defaults
-
-
-def _get_kind_id():
-    pn = Path.home() / "Documents" / "Voicemeeter" / "settings.json"
-    if pn.exists():
-        with open(pn, "r") as f:
-            data = json.load(f)
-        return data["voicemeeter"]
-    return "potato"
-
-
 class GlobalPlugin(globalPluginHandler.GlobalPlugin, CommandsMixin):
-    __gestures = _make_gestures()
+    __kind_id = config.get("voicemeeter", "potato")
-    __kind_id = _get_kind_id()
+    __gestures = util._make_gestures(__kind_id)
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -65,12 +18,7 @@ class GlobalPlugin(globalPluginHandler.GlobalPlugin, CommandsMixin):
         if self.controller.login() == 1:
             self.controller.run_voicemeeter(KindId[self.__kind_id.upper()])
             time.sleep(1)
-        self.kind = request_kind_map(self.controller.kind_id)
+        self.kind = request_kind_map(self.__kind_id)
-
-        for i in range(1, self.kind.num_strip + 1):
-            self.bindGesture(f"kb:NVDA+alt+{i}", "index")
-        for i in range(1, self.kind.phys_out + self.kind.virt_out + 1):
-            self.bindGesture(f"kb:NVDA+shift+{i}", "bus_assignment")
 
     def terminate(self, *args, **kwargs):
         super().terminate(*args, **kwargs)

addon/globalPlugins/voicemeeter/binds.py

@@ -22,6 +22,10 @@ class Binds:
     bind_get_voicemeeter_type.restype = LONG
     bind_get_voicemeeter_type.argtypes = [ct.POINTER(LONG)]
 
+    bind_get_voicemeeter_version = libc.VBVMR_GetVoicemeeterVersion
+    bind_get_voicemeeter_version.restype = LONG
+    bind_get_voicemeeter_version.argtypes = [ct.POINTER(LONG)]
+
     bind_is_parameters_dirty = libc.VBVMR_IsParametersDirty
     bind_is_parameters_dirty.restype = LONG
     bind_is_parameters_dirty.argtypes = None
@@ -37,5 +41,5 @@ class Binds:
     def call(self, fn, *args, ok=(0,)):
         retval = fn(*args)
         if retval not in ok:
-            raise VMCAPIError(fn.bind_namebind_, retval)
+            raise VMCAPIError(fn.__name__, retval)
         return retval

addon/globalPlugins/voicemeeter/cdll.py

@@ -35,7 +35,7 @@ def get_vmpath():
 try:
     vm_parent = Path(get_vmpath()).parent
 except FileNotFoundError as e:
-    raise VMError(f"Unable to fetch DLL path from the registry") from e
+    raise VMError("Unable to fetch DLL path from the registry") from e
 
 DLL_NAME = f'VoicemeeterRemote{"64" if BITS == 64 else ""}.dll'
 

addon/globalPlugins/voicemeeter/commands.py

@@ -1,14 +1,14 @@
 import ui
 from logHandler import log
 
-from . import context, util
+from . import context
 
 
 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}")
@@ -37,18 +37,24 @@ class CommandsMixin:
         ui.message(f"Controller for {self.controller.ctx.strategy} {self.controller.ctx.index + 1}")
         log.info(f"INFO - {self.controller.ctx.strategy} {self.controller.ctx.index} mode")
 
-    def script_slider_mode(self, gesture):
+    def __set_slider_mode(self, mode):
-        if gesture.displayName.endswith("g"):
+        self.controller.ctx.slider_mode = mode
-            self.controller.ctx.slider_mode = "gain"
+        ui.message(f"{mode} mode enabled")
-        elif gesture.displayName.endswith("c"):
+
-            self.controller.ctx.slider_mode = "comp"
+    def script_gain_mode(self, _):
-        elif gesture.displayName.endswith("t"):
+        self.__set_slider_mode("gain")
-            self.controller.ctx.slider_mode = "gate"
+
-        elif gesture.displayName.endswith("d"):
+    def script_comp_mode(self, _):
-            self.controller.ctx.slider_mode = "denoiser"
+        self.__set_slider_mode("comp")
-        elif gesture.displayName.endswith("a"):
+
-            self.controller.ctx.slider_mode = "audibility"
+    def script_gate_mode(self, _):
-        ui.message(f"{self.controller.ctx.slider_mode} mode enabled")
+        self.__set_slider_mode("gate")
+
+    def script_denoiser_mode(self, _):
+        self.__set_slider_mode("denoiser")
+
+    def script_audibility_mode(self, _):
+        self.__set_slider_mode("audibility")
 
     ### BOOLEAN PARAMETERS ###
 
@@ -89,28 +95,34 @@ class CommandsMixin:
         self.controller.ctx.set_bool(output, val)
         ui.message("on" if val else "off")
 
-    ### SLIDER MODES ###
+    ### CONTROL SLIDERS ###
 
-    def script_slider_increase(self, gesture):
+    def script_slider_increase_by_point_one(self, gesture):
-        op = util.remove_prefix(gesture.displayName, "kb:NVDA+shift+")
+        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) + 0.1
-        if op.startswith("alt"):
-            offset = 0.1
-        elif op.startswith("ctrl"):
-            offset = 3
-        else:
-            offset = 1
-        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) + offset
         self.controller.ctx.set_float(self.controller.ctx.slider_mode, val)
         ui.message(str(round(val, 1)))
 
-    def script_slider_decrease(self, gesture):
+    def script_slider_decrease_by_point_one(self, gesture):
-        op = util.remove_prefix(gesture.displayName, "kb:NVDA+shift+")
+        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) - 0.1
-        if op.startswith("alt"):
+        self.controller.ctx.set_float(self.controller.ctx.slider_mode, val)
-            offset = 0.1
+        ui.message(str(round(val, 1)))
-        elif op.startswith("ctrl"):
+
-            offset = 3
+    def script_slider_increase_by_one(self, gesture):
-        else:
+        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) + 1
-            offset = 1
+        self.controller.ctx.set_float(self.controller.ctx.slider_mode, val)
-        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) - offset
+        ui.message(str(round(val, 1)))
+
+    def script_slider_decrease_by_one(self, gesture):
+        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) - 1
+        self.controller.ctx.set_float(self.controller.ctx.slider_mode, val)
+        ui.message(str(round(val, 1)))
+
+    def script_slider_increase_by_three(self, gesture):
+        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) + 3
+        self.controller.ctx.set_float(self.controller.ctx.slider_mode, val)
+        ui.message(str(round(val, 1)))
+
+    def script_slider_decrease_by_three(self, gesture):
+        val = self.controller.ctx.get_float(self.controller.ctx.slider_mode) - 3
         self.controller.ctx.set_float(self.controller.ctx.slider_mode, val)
         ui.message(str(round(val, 1)))

addon/globalPlugins/voicemeeter/config.py

@@ -0,0 +1,20 @@
+import json
+from pathlib import Path
+
+
+def config_from_json():
+    pn = Path.home() / "Documents" / "Voicemeeter" / "nvda_settings.json"
+    data = None
+    if pn.exists():
+        with open(pn, "r") as f:
+            data = json.load(f)
+    return data or {}
+
+
+__config = config_from_json()
+
+
+def get(name, default=None):
+    if name in __config:
+        return __config[name]
+    return default

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

@@ -27,6 +27,17 @@ class Controller(Binds):
         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 BITS == 64:

addon/globalPlugins/voicemeeter/error.py

@@ -1,5 +1,5 @@
 class VMError(Exception):
-    """Base voicemeeterlib exception class."""
+    """Base voicemeeterlib exception class"""
 
 
 class VMCAPIError(VMError):

addon/globalPlugins/voicemeeter/util.py

@@ -1,3 +1,7 @@
+from . import config, util
+from .kinds import request_kind_map
+
+
 def remove_prefix(input_string, prefix):
     if prefix and input_string.startswith(prefix):
         return input_string[len(prefix) :]
@@ -8,3 +12,40 @@ def remove_suffix(input_string, suffix):
     if suffix and input_string.endswith(suffix):
         return input_string[: -len(suffix)]
     return input_string
+
+
+def _make_gestures(kind_id):
+    kind = request_kind_map(kind_id)
+    defaults = {
+        "kb:NVDA+alt+s": "strip_mode",
+        "kb:NVDA+alt+b": "bus_mode",
+        "kb:NVDA+alt+g": "gain_mode",
+        "kb:NVDA+alt+c": "comp_mode",
+        "kb:NVDA+alt+t": "gate_mode",
+        "kb:NVDA+alt+d": "denoiser_mode",
+        "kb:NVDA+alt+a": "audibility_mode",
+        "kb:NVDA+shift+q": "announce_controller",
+        "kb:NVDA+shift+v": "announce_voicemeeter_version",
+        "kb:NVDA+shift+o": "toggle_mono",
+        "kb:NVDA+shift+s": "toggle_solo",
+        "kb:NVDA+shift+m": "toggle_mute",
+        "kb:NVDA+shift+c": "toggle_mc",
+        "kb:NVDA+shift+k": "karaoke",
+        "kb:NVDA+shift+upArrow": "slider_increase_by_point_one",
+        "kb:NVDA+shift+downArrow": "slider_decrease_by_point_one",
+        "kb:NVDA+shift+alt+upArrow": "slider_increase_by_one",
+        "kb:NVDA+shift+alt+downArrow": "slider_decrease_by_one",
+        "kb:NVDA+shift+control+upArrow": "slider_increase_by_three",
+        "kb:NVDA+shift+control+downArrow": "slider_decrease_by_three",
+    }
+    for i in range(1, kind.num_strip + 1):
+        defaults[f"kb:NVDA+alt+{i}"] = "index"
+    for i in range(1, kind.phys_out + kind.virt_out + 1):
+        defaults[f"kb:NVDA+alt+{i}"] = "bus_assignment"
+    abc = config.get("keybinds")
+    if abc:
+        overrides = {f"kb:{util.remove_prefix(k, 'kb:')}": v for k, v in abc.items()}
+        matching_values = set(defaults.values()).intersection(set(overrides.values()))
+        defaults = {k: v for k, v in defaults.items() if v not in matching_values}
+        return {**defaults, **overrides}
+    return defaults

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 | Out-Null
 }
 
 function main {

buildVars.py

@@ -28,7 +28,7 @@ addon_info = {
 The add-on requires Voicemeeter to be installed."""
     ),
     # version
-    "addon_version": "0.3",
+    "addon_version": "0.5",
     # 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