fix regression, login should allow a return value of 1.

- solo + mc will give error warning if not currently using a Strip controller.
- karaoke and mc will give error warning if the Strip controller doesn't have the correct index.
- bus assignments will give error warning if not on a Strip controller.

mono now toggles for the Strip controller but rotates through modes for the Bus controller.

.github/workflows/build_addon.yml

@@ -1,40 +1,35 @@
-name: build addon
+name: Build Addon
 
 on:
   push:
-    tags: ["*"]
-    # To build on main/master branch, uncomment the following line:
-    # branches: [ main , master ]
-
-  pull_request:
-    branches: [ main, master ]
+    tags:
+      - 'v*.*.*'
 
   workflow_dispatch:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.11']
-        os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
+
       - name: Set up PDM
         uses: pdm-project/setup-pdm@v4
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: '3.11'
 
       - name: Install dependencies
         run: |
           pdm sync -d -G build
 
-      - name: building addon
+      - name: Build addon
         run: pdm run scons
 
-      - uses: actions/upload-artifact@v4
+      - name: Upload build artifacts
+        if: success()
+        uses: actions/upload-artifact@v4
         with:
           name: packaged_addon
           path: ./*.nvda-addon
@@ -42,15 +37,16 @@ jobs:
   upload_release:
     runs-on: ubuntu-latest
     if: ${{ startsWith(github.ref, 'refs/tags/') }}
-    needs: ["build"]
+    needs: build
+
     steps:
-    - uses: actions/checkout@v4
-    - name: download releases files
+      - name: Download releases files
         uses: actions/download-artifact@v4.1.7
         with:
           name: packaged_addon
+
       - name: Display structure of downloaded files
-      run: ls -R
+        run: tree
 
       - name: Release
         uses: softprops/action-gh-release@v1

README.md

@@ -1,4 +1,4 @@
-[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev)
+[![pdm-managed](https://img.shields.io/endpoint?url=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fpdm-project%2F.github%2Fbadge.json)](https://pdm-project.org)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 # NVDA Addon Voicemeeter

Taskfile.yml

@@ -0,0 +1,41 @@
+version: '3'
+
+vars:
+  SHELL: pwsh
+
+tasks:
+  default:
+    desc: Build the addon
+    cmds:
+      - task: build
+
+  copy:
+    desc: Copy sources files to scratchpad directory
+    platforms: [windows]
+    vars:
+      SOURCE: addon\globalPlugins\voicemeeter
+      DEST: ${env:appdata}\nvda\scratchpad\globalPlugins\voicemeeter\
+    cmds:
+      - "{{.SHELL}} -Command 'robocopy {{.SOURCE}} {{.DEST}} /NDL'"
+    ignore_error: true
+
+  build:
+    desc: Build the addon
+    platforms: [windows]
+    cmds:
+      - '{{.SHELL}} -Command "pdm run scons"'
+
+  bump:
+    desc: Bump the version number
+    preconditions:
+      - sh: '{{.SHELL}} -c "if (Get-Command bump) { exit 0 } else { exit 1 }"'
+        msg: "The 'bump' command is not available. Run `go install github.com/onyx-and-iris/bump/cmd/bump@latest`."
+    cmds:
+      - |
+        {{if eq .CLI_ARGS "show"}}
+          {{.SHELL}} -c "bump show -f buildVars.py -p \"'addon_version': '(\d+\.\d+\.\d+)'\""
+          {{.SHELL}} -c "bump show -f pyproject.toml -p \"version = .(\d+\.\d+\.\d+).\""
+        {{else}}
+          {{.SHELL}} -c "bump {{.CLI_ARGS}} -w -f buildVars.py -p \"'addon_version': '(\d+\.\d+\.\d+)'\""
+          {{.SHELL}} -c "bump {{.CLI_ARGS}} -w -f pyproject.toml -p \"version = .(\d+\.\d+\.\d+).\""
+        {{end}}

addon/globalPlugins/voicemeeter/binds.py

@@ -2,7 +2,7 @@ import ctypes as ct
 from ctypes.wintypes import CHAR, FLOAT, LONG
 
 from .cdll import libc
-from .error import VMCAPIError
+from .error import VMAddonCAPIError
 
 
 class Binds:
@@ -38,8 +38,32 @@ class Binds:
     bind_set_parameter_float.restype = LONG
     bind_set_parameter_float.argtypes = [ct.POINTER(CHAR), FLOAT]
 
-    def call(self, fn, *args, ok=(0,)):
+    def _call(self, fn, *args, ok=(0,)):
         retval = fn(*args)
         if retval not in ok:
-            raise VMCAPIError(fn.__name__, retval)
+            raise VMAddonCAPIError(fn.__name__, retval)
         return retval
+
+    def login(self):
+        return self._call(self.bind_login, ok=(0, 1))
+
+    def logout(self):
+        return self._call(self.bind_logout)
+
+    def run_voicemeeter(self, kind_val):
+        return self._call(self.bind_run_voicemeeter, kind_val)
+
+    def get_voicemeeter_type(self, c_type):
+        return self._call(self.bind_get_voicemeeter_type, ct.byref(c_type))
+
+    def get_voicemeeter_version(self, ver):
+        return self._call(self.bind_get_voicemeeter_version, ct.byref(ver))
+
+    def is_parameters_dirty(self):
+        return self._call(self.bind_is_parameters_dirty, ok=(0, 1))
+
+    def get_parameter_float(self, param, buf):
+        return self._call(self.bind_get_parameter_float, param, ct.byref(buf))
+
+    def set_parameter_float(self, param, val):
+        return self._call(self.bind_set_parameter_float, param, val)

addon/globalPlugins/voicemeeter/cdll.py

@@ -1,16 +1,22 @@
 import ctypes as ct
 import platform
-import winreg
 from pathlib import Path
 
-from .error import VMError
+from .error import VMAddonError
+
+try:
+    import winreg
+except ImportError as e:
+    ERR_MSG = 'winreg module not found, only Windows OS supported'
+    raise VMAddonError(ERR_MSG) from e
+
+# Defense against edge cases where winreg imports but we're not on Windows
+if platform.system() != 'Windows':
+    ERR_MSG = f'Unsupported OS: {platform.system()}, only Windows OS supported'
+    raise VMAddonError(ERR_MSG)
 
 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(
@@ -35,12 +41,14 @@ def get_vmpath():
 try:
     vm_parent = Path(get_vmpath()).parent
 except FileNotFoundError as e:
-    raise VMError('Unable to fetch DLL path from the registry') from e
+    ERR_MSG = 'Voicemeeter installation not found in registry'
+    raise VMAddonError(ERR_MSG) 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}')
+    ERR_MSG = f'Could not find {dll_path}'
+    raise VMAddonError(ERR_MSG)
 
 libc = ct.WinDLL(str(dll_path))

addon/globalPlugins/voicemeeter/commands.py

@@ -56,14 +56,27 @@ class CommandsMixin:
     def script_audibility_mode(self, _):
         self.__set_slider_mode('audibility')
 
-    ### BOOLEAN PARAMETERS ###
+    # Mono is a special case because the parameter is a boolean for strips and an int for buses
 
-    def script_toggle_mono(self, _):
+    def script_rotate_mono(self, _):
+        if isinstance(self.controller.ctx.strategy, context.StripStrategy):
             val = not self.controller.ctx.get_bool('mono')
             self.controller.ctx.set_bool('mono', val)
             ui.message('on' if val else 'off')
+        else:
+            opts = ['off', 'on', 'stereo reverse']
+            val = self.controller.ctx.get_int('mono')
+            new_val = (val + 1) % len(opts)
+            self.controller.ctx.set_int('mono', new_val)
+            ui.message(opts[new_val])
+
+    ### BOOLEAN PARAMETERS ###
 
     def script_toggle_solo(self, _):
+        if not isinstance(self.controller.ctx.strategy, context.StripStrategy):
+            ui.message('Solo only available for strips')
+            return
+
         val = not self.controller.ctx.get_bool('solo')
         self.controller.ctx.set_bool('solo', val)
         ui.message('on' if val else 'off')
@@ -74,19 +87,50 @@ class CommandsMixin:
         ui.message('on' if val else 'off')
 
     def script_toggle_mc(self, _):
+        if not isinstance(self.controller.ctx.strategy, context.StripStrategy):
+            ui.message('MC only available for strips')
+            return
+
+        valid_indices = [self.kind.phys_in + 1]
+        match self.kind.name:
+            case 'potato':
+                valid_indices.append(self.kind.phys_in + self.kind.virt_in)
+
+        if self.controller.ctx.index + 1 not in valid_indices:
+            if len(valid_indices) == 1:
+                ui.message(f'MC only available for strip {valid_indices[0]} for Voicemeeter {self.kind}')
+            else:
+                ui.message(
+                    f'MC only available for strips {valid_indices[0]} and {valid_indices[1]} for Voicemeeter {self.kind}'
+                )
+            return
+
         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, _):
+        if not isinstance(self.controller.ctx.strategy, context.StripStrategy):
+            ui.message('Karaoke mode only available for strips')
+            return
+
+        valid_index = self.kind.phys_in + self.kind.virt_in - 1
+        # controller index is 0 based and the gesture display is 1 based, so subtract 1 from valid_index
+        if self.controller.ctx.index != valid_index - 1:
+            ui.message(f'Karaoke mode only available for strip {valid_index} for Voicemeeter {self.kind}')
+            return
+
         opts = ['off', 'k m', 'k 1', 'k 2', 'k v']
-        val = self.controller.ctx.get_int('karaoke') + 1
-        if val == len(opts):
-            val = 0
-        self.controller.ctx.set_int('karaoke', val)
-        ui.message(opts[val])
+        val = self.controller.ctx.get_int('karaoke')
+        new_val = (val + 1) % len(opts)
+        self.controller.ctx.set_int('karaoke', new_val)
+        ui.message(opts[new_val])
 
     def script_bus_assignment(self, gesture):
+        if not isinstance(self.controller.ctx.strategy, context.StripStrategy):
+            ui.message('Bus assignment only available for strips')
+            return
+
         proposed = int(gesture.displayName[-1])
         if proposed - 1 < self.kind.phys_out:
             output = f'A{proposed}'

addon/globalPlugins/voicemeeter/context.py

@@ -28,22 +28,22 @@ class Strategy(ABC):
         self._slider_mode = val
 
     def get_bool(self, param: str) -> bool:
-        return self._controller._get(f'{self.identifier}.{param}') == 1
+        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)
+        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)
+        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)
+        self._controller.set(f'{self.identifier}.{param}', val)
 
     def get_int(self, param: str) -> int:
-        return int(self._controller._get(f'{self.identifier}.{param}'))
+        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)
+        self._controller.set(f'{self.identifier}.{param}', val)
 
 
 class StripStrategy(Strategy):

addon/globalPlugins/voicemeeter/controller.py

@@ -9,30 +9,31 @@ from .context import Context, StripStrategy
 from .kinds import KindId
 
 
-class Controller(Binds):
+class Controller:
     def __init__(self):
+        self._binds = Binds()
         self.ctx = Context(StripStrategy(self, 0))
         self.bits = config.get('bits', BITS)
 
     def login(self):
-        retval = self.call(self.bind_login, ok=(0, 1))
+        retval = self._binds.login()
         log.info('INFO - logged into Voicemeeter Remote API')
         return retval
 
     def logout(self):
-        self.call(self.bind_logout)
+        self._binds.logout()
         log.info('NFO - logged out of Voicemeeter Remote API')
 
     @property
     def kind_id(self):
         c_type = ct.c_long()
-        self.call(self.bind_get_voicemeeter_type, ct.byref(c_type))
+        self._binds.get_voicemeeter_type(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))
+        self._binds.get_voicemeeter_version(ver)
         return '{}.{}.{}.{}'.format(
             (ver.value & 0xFF000000) >> 24,
             (ver.value & 0x00FF0000) >> 16,
@@ -44,17 +45,17 @@ class Controller(Binds):
         val = kind_id.value
         if self.bits == 64:
             val += 3
-        self.call(self.bind_run_voicemeeter, val)
+        self._binds.run_voicemeeter(val)
 
     def __clear(self):
-        while self.call(self.bind_is_parameters_dirty, ok=(0, 1)) == 1:
+        while self._binds.is_parameters_dirty() == 1:
             pass
 
-    def _get(self, param):
+    def get(self, param):
         self.__clear()
         buf = ct.c_float()
-        self.call(self.bind_get_parameter_float, param.encode(), ct.byref(buf))
+        self._binds.get_parameter_float(param.encode(), buf)
         return buf.value
 
-    def _set(self, param, val):
-        self.call(self.bind_set_parameter_float, param.encode(), ct.c_float(float(val)))
+    def set(self, param, val):
+        self._binds.set_parameter_float(param.encode(), ct.c_float(float(val)))

addon/globalPlugins/voicemeeter/error.py

@@ -1,9 +1,9 @@
-class VMError(Exception):
-    """Base voicemeeterlib exception class"""
+class VMAddonError(Exception):
+    """Base voicemeeter add-on exception class"""
 
 
-class VMCAPIError(VMError):
-    """Exception raised when the C-API returns an error code"""
+class VMAddonCAPIError(VMAddonError):
+    """Exception raised when the Voicemeeter C-API returns an error code"""
 
     def __init__(self, fn_name, code):
         self.fn_name = fn_name

addon/globalPlugins/voicemeeter/kinds.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 from enum import Enum, unique
 
-from .error import VMError
+from .error import VMAddonError
 
 
 @unique
@@ -78,7 +78,8 @@ def kind_factory(kind_id):
     elif kind_id == 'potato':
         _kind_map = PotatoMap
     else:
-        raise ValueError(f'Unknown Voicemeeter kind {kind_id}')
+        ERR_MSG = f'Unknown Voicemeeter kind {kind_id}'
+        raise ValueError(ERR_MSG)
     return _kind_map(name=kind_id)
 
 
@@ -87,5 +88,5 @@ def request_kind_map(kind_id):
     try:
         KIND_obj = kind_factory(kind_id)
     except ValueError as e:
-        raise VMError(str(e)) from e
+        raise VMAddonError(str(e)) from e
     return KIND_obj

addon/globalPlugins/voicemeeter/util.py

@@ -26,7 +26,7 @@ def _make_gestures(kind_id):
         '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+o': 'rotate_mono',
         'kb:NVDA+shift+s': 'toggle_solo',
         'kb:NVDA+shift+m': 'toggle_mute',
         'kb:NVDA+shift+c': 'toggle_mc',

build.ps1

@@ -1,25 +0,0 @@
-param (
-    [switch]$build
-)
-
-function Copy-FilesToScratchpad {
-    $source = Join-Path $PSScriptRoot "addon" "globalPlugins" "voicemeeter"
-    $target = Join-Path $env:appdata "nvda" "scratchpad" "globalPlugins" "voicemeeter"
-    Robocopy $source $target | Out-Null
-}
-
-function Build-Addon {
-    "Building add-on" | Write-Host
-    scons
-}
-
-function Main {
-    "Copying updated files to Scratchpad" | Write-Host
-    Copy-FilesToScratchpad
-
-    if ($build) {
-        Build-Addon
-    }
-}
-
-if ($MyInvocation.InvocationName -ne '.') { Main }

buildVars.py

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

pyproject.toml

@@ -1,27 +1,22 @@
 [project]
 name = "nvda-addon-voicemeeter"
-version = "1.1.0"
+version = "1.2.0"
 description = "A GUI-less NVDA Addon for Voicemeeter using the Remote API"
-authors = [
-    {name = "Onyx and Iris", email = "code@onyxandiris.online"},
-]
+authors = [{ name = "Onyx and Iris", email = "code@onyxandiris.online" }]
 dependencies = []
 requires-python = "==3.11.*"
 readme = "README.md"
-license = {text = "MIT"}
+license = { text = "MIT" }
 
 [dependency-groups]
-build = [
-    "scons>=4.8.1",
-    "markdown>=3.7",
-]
+build = ["scons>=4.8.1", "markdown>=3.7"]
 
 [tool.pdm]
 distribution = false
 
 [tool.pdm.scripts]
-copy = "pwsh build.ps1"
-build = "pwsh build.ps1 -build"
+copy = "task copy"
+release = "task build"
 
 [tool.ruff]
 exclude = [
@@ -56,9 +51,11 @@ target-version = "py311"
 
 [tool.ruff.lint]
 # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Enable flake8-errmsg (EM) warnings.
+# Enable flake8-bugbear (B) warnings.
 # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
 # McCabe complexity (`C901`) by default.
-select = ["E4", "E7", "E9", "F"]
+select = ["E4", "E7", "E9", "EM", "F", "B"]
 ignore = []
 
 # Allow fix for all enabled rules (when `--fix`) is provided.
@@ -100,7 +97,4 @@ docstring-code-line-length = "dynamic"
 max-complexity = 10
 
 [tool.ruff.lint.per-file-ignores]
-"__init__.py" = [
-    "E402",
-    "F401",
-]
+"__init__.py" = ["E402", "F401"]