add headers

define binds explicitly in Binds.

bump to version 0.3

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,17 +14,24 @@ 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+upArrow": "increase_gain",
-        "kb:NVDA+shift+downArrow": "decrease_gain",
-        "kb:NVDA+shift+alt+upArrow": "increase_gain",
-        "kb:NVDA+shift+alt+downArrow": "decrease_gain",
-        "kb:NVDA+shift+control+upArrow": "increase_gain",
-        "kb:NVDA+shift+control+downArrow": "decrease_gain",
+        "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

addon/globalPlugins/voicemeeter/binds.py

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

@@ -1,7 +1,7 @@
 import ui
 from logHandler import log
 
-from . import context
+from . import context, util
 
 
 class CommandsMixin:
@@ -37,7 +37,20 @@ 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")
 
-    ### BOOLEAN PARMETERS ###
+    def script_slider_mode(self, gesture):
+        if gesture.displayName.endswith("g"):
+            self.controller.ctx.slider_mode = "gain"
+        elif gesture.displayName.endswith("c"):
+            self.controller.ctx.slider_mode = "comp"
+        elif gesture.displayName.endswith("t"):
+            self.controller.ctx.slider_mode = "gate"
+        elif gesture.displayName.endswith("d"):
+            self.controller.ctx.slider_mode = "denoiser"
+        elif gesture.displayName.endswith("a"):
+            self.controller.ctx.slider_mode = "audibility"
+        ui.message(f"{self.controller.ctx.slider_mode} mode enabled")
+
+    ### BOOLEAN PARAMETERS ###
 
     def script_toggle_mono(self, _):
         val = not self.controller.ctx.get_bool("mono")
@@ -54,6 +67,18 @@ class CommandsMixin:
         self.controller.ctx.set_bool("mute", val)
         ui.message("on" if val else "off")
 
+    def script_toggle_mc(self, _):
+        val = not self.controller.ctx.get_bool("mc")
+        self.controller.ctx.set_bool("mc", val)
+        ui.message("on" if val else "off")
+
+    def script_karaoke(self, _):
+        val = self.controller.ctx.get_int("karaoke") + 1
+        if val == 5:
+            val = 0
+        self.controller.ctx.set_int("karaoke", val)
+        ui.message(val)
+
     def script_bus_assignment(self, gesture):
         proposed = int(gesture.displayName[-1])
         if proposed - 1 < self.kind.phys_out:
@@ -63,3 +88,29 @@ class CommandsMixin:
         val = not self.controller.ctx.get_bool(output)
         self.controller.ctx.set_bool(output, val)
         ui.message("on" if val else "off")
+
+    ### SLIDER MODES ###
+
+    def script_slider_increase(self, gesture):
+        op = util.remove_prefix(gesture.displayName, "kb:NVDA+shift+")
+        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):
+        op = util.remove_prefix(gesture.displayName, "kb:NVDA+shift+")
+        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)))

addon/globalPlugins/voicemeeter/context.py

@@ -5,6 +5,15 @@ class Strategy(ABC):
     def __init__(self, controller, index):
         self._controller = controller
         self._index = index
+        self._slider_mode = "gain"
+
+    @abstractmethod
+    def __str__(self):
+        pass
+
+    @property
+    def identifier(self):
+        return f"{self}[{self._index}]"
 
     @property
     def index(self):
@@ -14,30 +23,42 @@ class Strategy(ABC):
     def index(self, val):
         self._index = val
 
+    @property
+    def slider_mode(self):
+        return self._slider_mode
+
+    @slider_mode.setter
+    def slider_mode(self, val):
+        self._slider_mode = val
+
     def get_bool(self, param: str) -> bool:
         return self._controller._get(f"{self.identifier}.{param}") == 1
 
     def set_bool(self, param: str, val: bool):
         self._controller._set(f"{self.identifier}.{param}", 1 if val else 0)
 
+    def get_float(self, param: str) -> float:
+        return round(self._controller._get(f"{self.identifier}.{param}"), 1)
+
+    def set_float(self, param: str, val: float):
+        self._controller._set(f"{self.identifier}.{param}", val)
+
+    def get_int(self, param: str) -> int:
+        return int(self._controller._get(f"{self.identifier}.{param}"))
+
+    def set_int(self, param: str, val: int):
+        self._controller._set(f"{self.identifier}.{param}", val)
+
 
 class StripStrategy(Strategy):
     def __str__(self):
         return "Strip"
 
-    @property
-    def identifier(self):
-        return f"strip[{self._index}]"
-
 
 class BusStrategy(Strategy):
     def __str__(self):
         return "Bus"
 
-    @property
-    def identifier(self):
-        return f"bus[{self._index}]"
-
 
 class Context:
     def __init__(self, strategy: Strategy) -> None:
@@ -59,8 +80,28 @@ class Context:
     def index(self, val):
         self._strategy._index = val
 
-    def get_bool(self, *args):
+    @property
+    def slider_mode(self):
+        return self._strategy._slider_mode
+
+    @slider_mode.setter
+    def slider_mode(self, val):
+        self._strategy._slider_mode = val
+
+    def get_bool(self, *args) -> bool:
         return self._strategy.get_bool(*args)
 
     def set_bool(self, *args):
         self._strategy.set_bool(*args)
+
+    def get_float(self, *args) -> float:
+        return self._strategy.get_float(*args)
+
+    def set_float(self, *args):
+        self._strategy.set_float(*args)
+
+    def get_int(self, *args) -> int:
+        return self._strategy.get_int(*args)
+
+    def set_int(self, *args):
+        self._strategy.set_int(*args)

addon/globalPlugins/voicemeeter/controller.py

@@ -3,45 +3,45 @@ 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()
 
     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}")

addon/globalPlugins/voicemeeter/util.py

@@ -0,0 +1,10 @@
+def remove_prefix(input_string, prefix):
+    if prefix and input_string.startswith(prefix):
+        return input_string[len(prefix) :]
+    return input_string
+
+
+def remove_suffix(input_string, suffix):
+    if suffix and input_string.endswith(suffix):
+        return input_string[: -len(suffix)]
+    return input_string

buildVars.py

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