requires-plugins seems to be bugged on Windows... see https://github.com/python-poetry/poetry/issues/10028

upd poe dep so it uses the one in poetry environment

.github/workflows/publish.yml

@@ -0,0 +1,53 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Poetry
+        run: |
+          pip install poetry==2.3.1
+          poetry --version
+
+      - name: Build package
+        run: |
+          poetry install --only-root
+          poetry build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: ./dist
+
+  pypi-publish:
+    needs: build
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/vban-cmd/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: ./dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ./dist

.github/workflows/ruff.yml

@@ -0,0 +1,19 @@
+name: Ruff
+
+on:
+  push:
+    branches: [main]
+
+  pull_request:
+    branches: [main]
+
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: 'format --check --diff'

.gitignore

@@ -128,6 +128,12 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# test reports
+tests/reports/
+!tests/reports/badge-*.svg
+
 # test/config
-quick.py
+test-*.py
 config.toml
+
+.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

CHANGELOG.md

@@ -11,6 +11,217 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+## [2.7.1] - 2025-06-15
+
+### Added
+
+-   Strip.EQ Channel Cell commands added, see [Strip.EQ.Channel.Cell](https://github.com/onyx-and-iris/voicemeeter-api-python?tab=readme-ov-file#stripeqchannelcell)
+    - They are only available for potato version.
+
+-   Bus.EQ Channel Cell commands added, see [Bus.EQ.Channel.Cell](https://github.com/onyx-and-iris/voicemeeter-api-python?tab=readme-ov-file#buseqchannelcell).
+    - Added by [PR #16](https://github.com/onyx-and-iris/voicemeeter-api-python/pull/16)
+
+## [2.6.0] - 2024-06-29
+
+### Added
+
+-   bits kwarg for overriding the type of GUI that is launched on startup.
+    -   Defaults to 64, set it to either 32 or 64.
+
+### Fixed
+
+-   {Remote}.run_voicemeeter() now launches x64 bit GUI's for all kinds if Python detects a 64 bit system.
+
+## [2.5.0] - 2023-10-27
+
+### Fixed
+
+-   {Remote}.login() now has a configurable timeout. Use timeout kwarg to set it. Defaults to 2 seconds.
+-   Remote class section in README updated to include timeout kwarg.
+
+## [2.4.8] - 2023-08-13
+
+### Added
+
+-   Error tests added in tests/test_errors.py
+-   fn_name and code set as class attributes for CAPIError
+-   Errors section in README updated.
+
+### Changed
+
+-   InstallError and CAPIError classes now subclass VMError
+
+## [2.3.7] - 2023-08-01
+
+### Changed
+
+-   If the configs loader is passed an invalid config TOML it will log an error but continue to load further configs into memory.
+
+## [2.3.2] - 2023-07-12
+
+### Added
+
+-   vban.{instream,outstream} tuples now contain classes that represent MIDI and TEXT streams.
+
+### Fixed
+
+-   apply_config() now performs a deep merge when extending a config with another.
+
+## [2.3.0] - 2023-07-11
+
+### Added
+
+-   user configs may now extend other user configs. check `config extends` section in README.
+
+## [2.2.0] - 2023-07-10
+
+### Added
+
+-   CAPIError class now stores fn_name, error code and message as class attributes.
+
+### Changed
+
+-   macrobutton capi calls now use error code -9 on AttributeError (using an old version of the API).
+
+### Fixed
+
+-   call to `self.vm_get_midi_message` now wrapped by {CBindings}.call.
+
+## [2.1.1] - 2023-07-01
+
+### Added
+
+-   RecorderMode added to Recorder class. See Recorder section in README for new properties and methods.
+    -   recorder.loop is now a forwarder method for recorder.mode.loop for backwards compatibility
+
+-   RecorderArmStrip, RecorderArmBus mixed into Recorder class.
+
+### Removed
+
+-   Recorder.loop removed from documentation
+
+### Changed
+
+-   When out of bounds values are passed, log warnings instead of raising Errors. See [Issue #6][Issue 6].
+
+## [2.0.0] - 2023-06-25
+
+Where possible I've attempted to make the changes backwards compatible. The breaking changes affect two higher classes, Strip and Bus, as well as the behaviour of events. All other changes are additive or QOL aimed at giving more options to the developer. For example, every low-level CAPI call is now logged and error raised on Exception, you can now register callback functions as well as observer classes, extra examples to demonstrate different use cases etc.
+
+The breaking changes are as follows:
+
+### Changed
+
+-   `strip[i].comp` now references StripComp class
+    -   To change the comp knob you should now use the property `strip[i].comp.knob`
+-   `strip[i].gate` now references StripGate class
+
+    -   To change the gate knob you should now use the property `strip[i].gate.knob`
+
+-   `bus[i].eq` now references BusEQ class
+
+    -   To set bus[i].{eq,eq_ab} as before you should now use bus[i].eq.on and bus[i].eq.ab
+
+-   by default, <strong>NO</strong> events are checked for. This is reflected in factory.FactoryBase defaultkwargs.
+    -   This is a fundamental behaviour change from version 1.0 of the wrapper. It means the following:
+        -   Unless any events are explicitly requested with an event kwarg the event emitter thread will not run automatically.
+        -   Whether using a context manager or not, you can still initiate the event thread manually and request events with the event object.<br>
+            see `events` example.
+
+There are other non-breaking changes:
+
+### Added
+
+-   `strip[i].eq` added to PhysicalStrip
+-   `strip[i].denoiser` added to PhysicalStrip
+-   `Strip.Comp`, `Strip.Gate`, `Strip.Denoiser` sections added to README.
+-   `Events` section in readme updated to reflect changes to events kwargs.
+-   new comp, gate, denoiser and eq tests added to higher tests.
+-   `levels` example to demonstrate use of the interface without a context manager.
+-   `events` example to demonstrate how to interact with event thread/event object.
+-   `gui` example to demonstrate GUI controls.
+-   `{Remote}.observer` can be used in place of `{Remote}.subject` although subject will still work. Check examples.
+-   Subject class extended to allow registering/de-registering callback functions (as well as observer classes). See `events` example.
+
+### Changed
+
+-   `comp.knob`, `gate.knob`, `denoiser.knob`, `eq.on` added to phys_strip_params in config.TOMLStrBuilder
+
+    -   The `example.toml` config files have been updated to demonstrate setting new comp, gate and eq settings.
+
+-   event kwargs can now be set directly. no need for `subs`. example: `voicemeeterlib.api('banana', midi=True})`
+
+-   factorybuilder steps now logged in DEBUG mode.
+
+-   now using a producer thread to send events to the updater thread.
+
+-   module level loggers implemented (with class loggers as child loggers)
+
+-   config.loader now checks `Path.home() / ".config" / "voicemeeter" / kind.name` for configs.
+    -   note. `Path(__file__).parent / "configs" / kind.name,` was removed as a path to check.
+
+### Fixed
+
+-   All low level CAPI calls are now wrapped by CBindings.call() which logs any errors raised.
+-   Dynamic binding of Macrobutton functions from the CAPI.
+    Should add backwards compatibility with very old versions of the api. See [Issue #4][issue 4].
+-   factory.request_remote_obj now raises a `VMError` if passed an incorrect kind.
+
+## [1.0.0] - 2023-06-19
+
+No changes to the codebase but it has been stable for several months and should already have been bumped to major version 1.0
+
+I will move this commit to a separate branch in preparation for version 2.0.
+
+## [0.9.0] - 2022-10-11
+
+### Added
+
+-   StripDevice and BusDevice mixins.
+-   README updated to reflect changes.
+-   Minor version bump
+
+### Removed
+
+-   device, sr properties for physical strip, bus moved into mixin classes
+
+### Changed
+
+-   Event class property setters added.
+-   Event add/remove methods now accept multiple events.
+-   bus levels now printed in observer example.
+
+### Fixed
+
+-   initialize channel comps in updater thread. Fixes bug when switching to a kind before any level updates have occurred.
+
+## [0.8.0] - 2022-09-29
+
+### Added
+
+-   Logging level INFO set on all examples.
+-   Minor version bump
+-   vm.subject subsection added to README
+
+### Changed
+
+-   Logging module used in place of print statements across the interface.
+-   time.time() now used to steady rate of updates in updater thread.
+
+### Fixed
+
+-   call to cache bug in updater thread
+
+## [0.7.0] - 2022-09-03
+
+### Added
+
+-   tomli/tomllib compatibility layer to support python 3.10
+
+### Removed
+
+-   3.10 branch
+
 ## [0.6.0] - 2022-08-02
 
 ### Added
@@ -243,3 +454,6 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 -   inst module implemented (fetch vm path from registry)
 -   kind maps implemented as dataclasses
 -   project packaged with poetry and added to pypi.
+
+[issue 4]: https://github.com/onyx-and-iris/voicemeeter-api-python/issues/4
+[Issue 6]: https://github.com/onyx-and-iris/voicemeeter-api-python/issues/6

README.md

@@ -1,10 +1,10 @@
 [![PyPI version](https://badge.fury.io/py/voicemeeter-api.svg)](https://badge.fury.io/py/voicemeeter-api)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/voicemeeter-api-python/blob/dev/LICENSE)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![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)
-![Tests Status](./tests/basic.svg?dummy=8484744)
+![Tests Status](./tests/reports/badge-basic.svg?dummy=8484744)
-![Tests Status](./tests/banana.svg?dummy=8484744)
+![Tests Status](./tests/reports/badge-banana.svg?dummy=8484744)
-![Tests Status](./tests/potato.svg?dummy=8484744)
+![Tests Status](./tests/reports/badge-potato.svg?dummy=8484744)
 
 # Python Wrapper for Voicemeeter API
 
@@ -14,21 +14,17 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.0.8.2
+-   Basic 1.1.1.1
--   Banana 2.0.6.2
+-   Banana 2.1.1.1
--   Potato 3.0.2.2
+-   Potato 3.1.1.1
 
 ## Requirements
 
 -   [Voicemeeter](https://voicemeeter.com/)
--   Python 3.11 or greater
+-   Python 3.10 or greater
 
 ## Installation
 
-### `Pip`
-
-Install voicemeeter-api package from your console
-
 `pip install voicemeeter-api`
 
 ## `Use`
@@ -48,24 +44,26 @@ class ManyThings:
         self.vm = vm
 
     def things(self):
-        self.vm.strip[0].label = "podmic"
+        self.vm.strip[0].label = 'podmic'
         self.vm.strip[0].mute = True
         print(
-            f"strip 0 ({self.vm.strip[0].label}) mute has been set to {self.vm.strip[0].mute}"
+            f'strip 0 ({self.vm.strip[0].label}) mute has been set to {self.vm.strip[0].mute}'
         )
 
     def other_things(self):
-        info = (
-            f"bus 3 gain has been set to {self.vm.bus[3].gain}",
-            f"bus 4 eq has been set to {self.vm.bus[4].eq}",
-        )
         self.vm.bus[3].gain = -6.3
-        self.vm.bus[4].eq = True
+        self.vm.bus[4].eq.on = True
-        print("\n".join(info))
+        info = (
+            f'bus 3 gain has been set to {self.vm.bus[3].gain}',
+            f'bus 4 eq has been set to {self.vm.bus[4].eq.on}',
+        )
+        print('\n'.join(info))
 
 
 def main():
-    with voicemeeterlib.api(kind_id) as vm:
+    KIND_ID = 'banana'
+
+    with voicemeeterlib.api(KIND_ID) as vm:
         do = ManyThings(vm)
         do.things()
         do.other_things()
@@ -73,26 +71,24 @@ def main():
         # set many parameters at once
         vm.apply(
             {
-                "strip-2": {"A1": True, "B1": True, "gain": -6.0},
+                'strip-2': {'A1': True, 'B1': True, 'gain': -6.0},
-                "bus-2": {"mute": True},
+                'bus-2': {'mute': True, 'eq': {'on': True}},
-                "button-0": {"state": True},
+                'button-0': {'state': True},
-                "vban-in-0": {"on": True},
+                'vban-in-0': {'on': True},
-                "vban-out-1": {"name": "streamname"},
+                'vban-out-1': {'name': 'streamname'},
             }
         )
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
-    kind_id = "banana"
-
     main()
 ```
 
 Otherwise you must remember to call `vm.login()`, `vm.logout()` at the start/end of your code.
 
-## `kind_id`
+## `KIND_ID`
 
-Pass the kind of Voicemeeter as an argument. kind_id may be:
+Pass the kind of Voicemeeter as an argument. KIND_ID may be:
 
 -   `basic`
 -   `banana`
@@ -108,14 +104,10 @@ The following properties are available.
 -   `solo`: boolean
 -   `mute`: boolean
 -   `gain`: float, from -60.0 to 12.0
--   `comp`: float, from 0.0 to 10.0
--   `gate`: float, from 0.0 to 10.0
 -   `audibility`: float, from 0.0 to 10.0
 -   `limit`: int, from -40 to 12
 -   `A1 - A5`, `B1 - B3`: boolean
 -   `label`: string
--   `device`: string
--   `sr`: int
 -   `mc`: boolean
 -   `k`: int, from 0 to 4
 -   `bass`: float, from -12.0 to 12.0
@@ -143,7 +135,7 @@ vm.strip[3].gain = 3.7
 print(vm.strip[0].label)
 ```
 
-The following methods are Available.
+The following methods are available.
 
 -   `appgain(name, value)`: string, float, from 0.0 to 1.0
 
@@ -156,11 +148,104 @@ Set mute state as value for the app matching name.
 example:
 
 ```python
-vm.strip[5].appmute("Spotify", True)
+vm.strip[5].appmute('Spotify', True)
-vm.strip[5].appgain("Spotify", 0.5)
+vm.strip[5].appgain('Spotify', 0.5)
 ```
 
-##### Gainlayers
+#### Strip.Comp
+
+The following properties are available.
+
+-   `knob`: float, from 0.0 to 10.0
+-   `gainin`: float, from -24.0 to 24.0
+-   `ratio`: float, from 1.0 to 8.0
+-   `threshold`: float, from -40.0 to -3.0
+-   `attack`: float, from 0.0 to 200.0
+-   `release`: float, from 0.0 to 5000.0
+-   `knee`: float, from 0.0 to 1.0
+-   `gainout`: float, from -24.0 to 24.0
+-   `makeup`: boolean
+
+example:
+
+```python
+print(vm.strip[4].comp.knob)
+```
+
+Strip Comp parameters are defined for PhysicalStrips.
+
+`knob` defined for all versions, all other parameters potato only.
+
+#### Strip.Gate
+
+The following properties are available.
+
+-   `knob`: float, from 0.0 to 10.0
+-   `threshold`: float, from -60.0 to -10.0
+-   `damping`: float, from -60.0 to -10.0
+-   `bpsidechain`: int, from 100 to 4000
+-   `attack`: float, from 0.0 to 1000.0
+-   `hold`: float, from 0.0 to 5000.0
+-   `release`: float, from 0.0 to 5000.0
+
+example:
+
+```python
+vm.strip[2].gate.attack = 300.8
+```
+
+Strip Gate parameters are defined for PhysicalStrips.
+
+`knob` defined for all versions, all other parameters potato only.
+
+#### Strip.Denoiser
+
+The following properties are available.
+
+-   `knob`: float, from 0.0 to 10.0
+
+example:
+
+```python
+vm.strip[0].denoiser.knob = 0.5
+```
+
+Strip Denoiser parameters are defined for PhysicalStrips, potato version only.
+
+#### Strip.EQ
+
+The following properties are available.
+
+-   `on`: boolean
+-   `ab`: boolean
+
+example:
+
+```python
+vm.strip[0].eq.ab = True
+```
+
+##### Strip.EQ.Channel.Cell
+
+The following properties are available.
+
+-   `on`: boolean
+-   `type`: int, from 0 up to 6
+-   `f`: float, from 20.0 up to 20_000.0
+-   `gain`: float, from -36.0 up to 18.0
+    -   currently there is a bug with the remote API, only values -12 up to +12 are settable, this will be fixed in an upcoming patch.
+-   `q`: float, from 0.3 up to 100
+
+example:
+
+```python
+vm.strip[0].eq.channel[0].cell[2].on = True
+vm.strip[1].eq.channel[0].cell[2].f = 5000
+```
+
+Strip EQ parameters are defined for PhysicalStrips, potato version only.
+
+##### Strip.Gainlayers
 
 -   `gain`: float, from -60.0 to 12.0
 
@@ -172,7 +257,7 @@ vm.strip[3].gainlayer[3].gain = 3.7
 
 Gainlayers are defined for potato version only.
 
-##### Levels
+##### Strip.Levels
 
 The following properties are available.
 
@@ -192,15 +277,11 @@ Level properties will return -200.0 if no audio detected.
 
 The following properties are available.
 
--   `mono`: boolean
+-   `mono`: int, from 0 up to 2
--   `eq`: boolean
--   `eq_ab`: boolean
 -   `mute`: boolean
 -   `sel`: boolean
 -   `gain`: float, from -60.0 to 12.0
 -   `label`: string
--   `device`: string
--   `sr`: int
 -   `returnreverb`: float, from 0.0 to 10.0
 -   `returndelay`: float, from 0.0 to 10.0
 -   `returnfx1`: float, from 0.0 to 10.0
@@ -213,10 +294,41 @@ example:
 vm.bus[3].gain = 3.7
 print(vm.bus[0].label)
 
-vm.bus[4].mono = True
+vm.bus[4].mono = 2
 ```
 
-##### Modes
+##### Bus.EQ
+
+The following properties are available.
+
+-   `on`: boolean
+-   `ab`: boolean
+
+example:
+
+```python
+vm.bus[3].eq.on = True
+```
+
+##### Bus.EQ.Channel.Cell
+
+The following properties are available.
+
+-   `on`: boolean
+-   `type`: int, from 0 up to 6
+-   `f`: float, from 20.0 up to 20_000.0
+-   `gain`: float, from -36.0 up to 18.0
+    -   currently there is a bug with the remote API, only values -12 up to +12 are settable, this will be fixed in an upcoming patch.
+-   `q`: float, from 0.3 up to 100.0
+
+example:
+
+```python
+vm.bus[3].eq.channel[0].cell[2].on = True
+vm.bus[3].eq.channel[0].cell[2].f = 5000
+```
+
+##### Bus.Modes
 
 The following properties are available.
 
@@ -244,7 +356,7 @@ vm.bus[4].mode.amix = True
 print(vm.bus[2].mode.get())
 ```
 
-##### Levels
+##### Bus.Levels
 
 The following properties are available.
 
@@ -274,6 +386,28 @@ vm.strip[0].fadeto(-10.3, 1000)
 vm.bus[3].fadeby(-5.6, 500)
 ```
 
+#### Strip.Device | Bus.Device
+
+The following properties are available
+
+-   `name`: str
+-   `sr`: int
+-   `wdm`: str
+-   `ks`: str
+-   `mme`: str
+-   `asio`: str
+
+example:
+
+```python
+print(vm.strip[0].device.name)
+vm.bus[0].device.asio = 'Audient USB Audio ASIO Driver'
+```
+
+strip|bus device parameters are defined for physical channels only.
+
+name, sr are read only. wdm, ks, mme, asio are write only.
+
 ### Macrobuttons
 
 The following properties are available.
@@ -299,13 +433,19 @@ The following methods are available
 -   `record()`
 -   `ff()`
 -   `rew()`
--   `load(<filepath>)`: string
+-   `load(filepath)`: raw string
+-   `goto(time_string)`: time string in format `hh:mm:ss`
+-   `filetype(filetype)`: string, ("wav", "aiff", "bwf", "mp3")
 
 The following properties are available
 
--   `loop`: boolean
 -   `A1 - A5`: boolean
--   `B1 - A3`: boolean
+-   `B1 - B3`: boolean
+-   `samplerate`: int, (22050, 24000, 32000, 44100, 48000, 88200, 96000, 176400, 192000)
+-   `bitresolution`: int, (8, 16, 24, 32)
+-   `channel`: int, from 1 to 8
+-   `kbps`: int, (32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320)
+-   `gain`: float, from -60.0 to 12.0
 
 example:
 
@@ -313,17 +453,46 @@ example:
 vm.recorder.play()
 vm.recorder.stop()
 
-# Enable loop play
-vm.recorder.loop = True
-
 # Disable recorder out channel B2
 vm.recorder.B2 = False
 
 # filepath as raw string
 vm.recorder.load(r'C:\music\mytune.mp3')
+
+# set the goto time to 1m 30s
+vm.recorder.goto('00:01:30')
 ```
 
-Recorder properties are defined as write only.
+#### Recorder.Mode
+
+The following properties are available
+
+-   `recbus`: boolean
+-   `playonload`: boolean
+-   `loop`: boolean
+-   `multitrack`: boolean
+
+example:
+
+```python
+# Enable loop play
+vm.recorder.mode.loop = True
+```
+
+#### Recorder.ArmStrip[i]|ArmBus[i]
+
+The following method is available
+
+-   `set(val)`: boolean
+
+example:
+
+```python
+# Arm strip 3
+vm.recorder.armstrip[3].set(True)
+# Arm bus 0
+vm.recorder.armbus[0].set(True)
+```
 
 ### VBAN
 
@@ -395,7 +564,7 @@ example:
 
 ```python
 import voicemeeterlib
-with voicemeeterlib.api(kind_id) as vm:
+with voicemeeterlib.api(KIND_ID) as vm:
     for i in range(vm.device.ins):
         print(vm.device.input(i))
 ```
@@ -495,7 +664,9 @@ vm.option.sr = 48000
 
 The following methods are available:
 
--   `buffer(driver, buffer)` : Set buffer size for particular audio driver.
+-   `buffer(driver, buf)` : Set buffer size for particular audio driver.
+    -   buf: int, from 128 to 2048
+    -   driver:str, ("mme", "wdm", "ks", "asio")
 
 example:
 
@@ -503,10 +674,6 @@ example:
 vm.option.buffer("wdm", 512)
 ```
 
-driver defined as one of ("mme", "wdm", "ks", "asio")
-
-buffer, from 128 to 2048
-
 ##### delay[i]
 
 -   `get()`: int
@@ -547,11 +714,11 @@ get() may return None if no value for requested key in midi cache
 ```python
 vm.apply(
     {
-        "strip-2": {"A1": True, "B1": True, "gain": -6.0},
+        'strip-2': {'A1': True, 'B1': True, 'gain': -6.0},
-        "bus-2": {"mute": True},
+        'bus-2': {'mute': True, 'eq': {'on': True}},
-        "button-0": {"state": True},
+        'button-0': {'state': True},
-        "vban-in-0": {"on": True},
+        'vban-in-0': {'on': True},
-        "vban-out-1": {"name": "streamname"},
+        'vban-out-1': {'name': 'streamname'},
     }
 )
 ```
@@ -559,17 +726,17 @@ vm.apply(
 Or for each class you may do:
 
 ```python
-vm.strip[0].apply(mute: True, gain: 3.2, A1: True)
+vm.strip[0].apply({'mute': True, 'gain': 3.2, 'A1': True})
-vm.vban.outstream[0].apply(on: True, name: 'streamname', bit: 24)
+vm.vban.outstream[0].apply({'on': True, 'name': 'streamname', 'bit': 24})
 ```
 
 ## Config Files
 
-`vm.apply_config(<configname>)`
+`vm.apply_config(configname)`
 
 You may load config files in TOML format.
 Three example configs have been included with the package. Remember to save
-current settings before loading a user config. To set one you may do:
+current settings before loading a user config. To load one you may do:
 
 ```python
 import voicemeeterlib
@@ -577,75 +744,116 @@ with voicemeeterlib.api('banana') as vm:
     vm.apply_config('example')
 ```
 
-will load a user config file at configs/banana/example.toml for Voicemeeter Banana.
+Your configs may be located in one of the following paths:
+-   \<current working directory\> / "configs" / kind_id
+-   \<user home directory\> / ".config" / "voicemeeter" / kind_id
+-   \<user home directory\> / "Documents" / "Voicemeeter" / "configs" / kind_id
 
-## `Base Module`
+If a config with the same name is located in multiple locations, only the first one found is loaded into memory, in the above order.
 
-### Remote class
+#### `config extends`
 
-`voicemeeterlib.api(kind_id: str)`
+You may also load a config that extends another config with overrides or additional parameters.
 
-You may pass the following optional keyword arguments:
+You just need to define a key `extends` in the config TOML, that names the config to be extended.
 
--   `sync`: boolean=False, force the getters to wait for dirty parameters to clear. For most cases leave this as False.
+Three example 'extender' configs are included with the repo. You may load them with:
--   `ratelimit`: float=0.033, how often to check for updates in ms.
--   `subs`: dict={"pdirty": True, "mdirty": True, "midi": True, "ldirty": False}, initialize which event updates to listen for.
-    -   `pdirty`: parameter updates
-    -   `mdirty`: macrobutton updates
-    -   `midi`: midi updates
-    -   `ldirty`: level updates
 
-#### Event updates
+```python
+import voicemeeterlib
+with voicemeeterlib.api('banana') as vm:
+    vm.apply_config('extender')
+```
 
-To receive event updates you should do the following:
+## Events
 
--   register your app to receive updates using the `vm.subject.add(observer)` method, where observer is your app.
+By default, NO events are listened for. Use events kwargs to enable specific event types.
--   define an `on_update(subject)` callback function in your app. The value of subject may be checked for the type of event.
-
-See `examples/observer` for a demonstration.
-
-Level updates are considered high volume, by default they are NOT listened for. However, polling them with strip.levels and bus.levels methods will still work.
-
-So if you don't wish to receive level updates, or you prefer to handle them yourself simply leave ldirty as default (False).
-
-Each of the update types may be enabled/disabled separately. Don't use a midi controller? You have the option to disable midi updates.
 
 example:
 
 ```python
 import voicemeeterlib
-# Set updates to occur every 50ms
+# Set event updates to occur every 50ms
-# Listen for level updates but disable midi updates
+# Listen for level updates only
-with voicemeeterlib.api('banana', ratelimit=0.05, subs={"ldirty": True, "midi": False}) as vm:
+with voicemeeterlib.api('banana', ratelimit=0.05, ldirty=True) as vm:
     ...
 ```
 
-#### `vm.event`
+#### `vm.observer`
 
-You may also add/remove event subscriptions as necessary with the Event class.
+Use the Subject class to register an app as event observer.
+
+The following methods are available:
+
+-   `add`: registers an app as an event observer
+-   `remove`: deregisters an app as an event observer
 
 example:
 
 ```python
-vm.event.add("ldirty")
+# register an app to receive updates
+class App():
+    def __init__(self, vm):
+        vm.observer.add(self)
+        ...
+```
 
-vm.event.remove("pdirty")
+#### `vm.event`
+
+Use the event class to toggle updates as necessary.
+
+The following properties are available:
+
+-   `pdirty`: boolean
+-   `mdirty`: boolean
+-   `midi`: boolean
+-   `ldirty`: boolean
+
+example:
+
+```python
+vm.event.ldirty = True
+
+vm.event.pdirty = False
+```
+
+Or add, remove a list of events.
+
+The following methods are available:
+
+-   `add()`
+-   `remove()`
+-   `get()`
+
+example:
+
+```python
+vm.event.remove(['pdirty', 'mdirty', 'midi'])
 
 # get a list of currently subscribed
 print(vm.event.get())
 ```
 
+## Remote class
+
+`voicemeeterlib.api(KIND_ID: str)`
+
+You may pass the following optional keyword arguments:
+
+-   `sync`: boolean=False, force the getters to wait for dirty parameters to clear. For most cases leave this as False.
+-   `ratelimit`: float=0.033, how often to check for updates in ms.
+-   `pdirty`: boolean=False, parameter updates
+-   `mdirty`: boolean=False, macrobutton updates
+-   `midi`: boolean=False, midi updates
+-   `ldirty`: boolean=False, level updates
+-   `timeout`: float=2.0, maximum time to wait for a successful login in seconds
+-   `bits`: int=64, (may be one of 32 or 64), overrides the type of Voicemeeter GUI {Remote}.run_voicemeeter() will launch
+
 Access to lower level Getters and Setters are provided with these functions:
 
 -   `vm.get(param, is_string=False)`: For getting the value of any parameter. Set string to True if getting a property value expected to return a string.
 -   `vm.set(param, value)`: For setting the value of any parameter.
 
-Access to lower level polling functions are provided with these functions:
-
--   `vm.pdirty()`: Returns True if a parameter has been updated.
--   `vm.mdirty()`: Returns True if a macrobutton has been updated.
--   `vm.ldirty()`: Returns True if a level has been updated.
-
 example:
 
 ```python
@@ -654,14 +862,60 @@ vm.set('Strip[4].Label', 'stripname')
 vm.set('Strip[0].Gain', -3.6)
 ```
 
+Access to lower level polling functions are provided with the following property objects:
+
+##### `vm.pdirty`
+
+True iff a parameter has been updated.
+
+##### `vm.mdirty`
+
+True iff a macrobutton has been updated.
+
+##### `vm.ldirty`
+
+True iff a level has been updated.
+
+
+### Errors
+
+-   `errors.VMError`: Base custom exception class.
+-   `errors.InstallError`: Exception raised when installation errors occur.
+-   `errors.CAPIError`: Exception raised when the C-API returns error values.
+    -   The following attributes are available:
+        -   `fn_name`: C-API function name.
+        -   `code`: error code
+    -   For a full list of error codes check the [VoicemeeterRemote header file][Voicemeeter Remote Header].
+
+
+### Logging
+
+It's possible to see the messages sent by the interface's setters and getters, may be useful for debugging.
+
+example:
+```python
+import voicemeeterlib
+
+logging.basicConfig(level=logging.DEBUG)
+
+with voicemeeterlib.api('banana') as vm:
+    ...
+```
+
+
 ### Run tests
 
-To run all tests:
+Install [poetry](https://python-poetry.org/docs/#installation) and then:
 
-```
+```powershell
-pytest -v
+poetry poe test-basic
+poetry poe test-banana
+poetry poe test-potato
 ```
 
 ### Official Documentation
 
 -   [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
+
+
+[Voicemeeter Remote Header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemote.h

__main__.py

@@ -6,24 +6,26 @@ class ManyThings:
         self.vm = vm
 
     def things(self):
-        self.vm.strip[0].label = "podmic"
+        self.vm.strip[0].label = 'podmic'
         self.vm.strip[0].mute = True
         print(
-            f"strip 0 ({self.vm.strip[0].label}) mute has been set to {self.vm.strip[0].mute}"
+            f'strip 0 ({self.vm.strip[0].label}) mute has been set to {self.vm.strip[0].mute}'
         )
 
     def other_things(self):
-        info = (
-            f"bus 3 gain has been set to {self.vm.bus[3].gain}",
-            f"bus 4 eq has been set to {self.vm.bus[4].eq}",
-        )
         self.vm.bus[3].gain = -6.3
-        self.vm.bus[4].eq = True
+        self.vm.bus[4].eq.on = True
-        print("\n".join(info))
+        info = (
+            f'bus 3 gain has been set to {self.vm.bus[3].gain}',
+            f'bus 4 eq has been set to {self.vm.bus[4].eq.on}',
+        )
+        print('\n'.join(info))
 
 
 def main():
-    with voicemeeterlib.api(kind_id) as vm:
+    KIND_ID = 'banana'
+
+    with voicemeeterlib.api(KIND_ID) as vm:
         do = ManyThings(vm)
         do.things()
         do.other_things()
@@ -31,16 +33,14 @@ def main():
         # set many parameters at once
         vm.apply(
             {
-                "strip-2": {"A1": True, "B1": True, "gain": -6.0},
+                'strip-2': {'A1': True, 'B1': True, 'gain': -6.0},
-                "bus-2": {"mute": True},
+                'bus-2': {'mute': True, 'eq': {'on': True}},
-                "button-0": {"state": True},
+                'button-0': {'state': True},
-                "vban-in-0": {"on": True},
+                'vban-in-0': {'on': True},
-                "vban-out-1": {"name": "streamname"},
+                'vban-out-1': {'name': 'streamname'},
             }
         )
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
-    kind_id = "banana"
-
     main()

configs/banana/example.toml

@@ -2,12 +2,12 @@
 label = "PhysStrip0"
 A1 = true
 gain = -8.8
-comp = 3.2
+comp.knob = 3.2
 
 [strip-1]
 label = "PhysStrip1"
 B1 = true
-gate = 4.1
+gate.knob = 4.1
 
 [strip-2]
 label = "PhysStrip2"
@@ -34,12 +34,12 @@ mono = true
 
 [bus-2]
 label = "PhysBus2"
-eq = true
+eq.ab = true
 mode = "composite"
 
 [bus-3]
 label = "VirtBus0"
-eq_ab = true
+eq.on = true
 mode = "upmix61"
 
 [bus-4]

configs/banana/extender.toml

@@ -0,0 +1,12 @@
+extends = "example"
+[strip-0]
+label = "strip0_extended"
+A1 = false
+gain = 0.0
+
+[bus-0]
+label = "bus0_extended"
+mute = false
+
+[vban-in-3]
+name = "vban_extended"

configs/basic/extender.toml

@@ -0,0 +1,12 @@
+extends = "example"
+[strip-0]
+label = "strip0_extended"
+A1 = false
+gain = 0.0
+
+[bus-0]
+label = "bus0_extended"
+mute = false
+
+[vban-in-3]
+name = "vban_extended"

configs/potato/example.toml

@@ -2,26 +2,29 @@
 label = "PhysStrip0"
 A1 = true
 gain = -8.8
-comp = 3.2
+comp.knob = 3.2
 
 [strip-1]
 label = "PhysStrip1"
 B1 = true
-gate = 4.1
+gate.knob = 4.1
 
 [strip-2]
 label = "PhysStrip2"
 gain = 1.1
 limit = -15
+comp.threshold = -35.8
 
 [strip-3]
 label = "PhysStrip3"
 B2 = false
+eq.on = true
 
 [strip-4]
 label = "PhysStrip4"
 B3 = true
 gain = -8.8
+eq.on = true
 
 [strip-5]
 label = "VirtStrip0"
@@ -50,7 +53,7 @@ mono = true
 
 [bus-2]
 label = "PhysBus2"
-eq = true
+eq.on = true
 
 [bus-3]
 label = "PhysBus3"
@@ -62,7 +65,7 @@ mode = "composite"
 
 [bus-5]
 label = "VirtBus0"
-eq_ab = true
+eq.ab = true
 
 [bus-6]
 label = "VirtBus1"

configs/potato/extender.toml

@@ -0,0 +1,12 @@
+extends = "example"
+[strip-0]
+label = "strip0_extended"
+A1 = false
+gain = 0.0
+
+[bus-0]
+label = "bus0_extended"
+mute = false
+
+[vban-in-3]
+name = "vban_extended"

examples/dsl/__main__.py

@@ -1,6 +1,9 @@
+import argparse
+import logging
 import time
+from abc import ABC, abstractmethod
+from enum import IntEnum
 
-import voicemeeterlib
 from pyparsing import (
     Combine,
     Group,
@@ -9,19 +12,90 @@ from pyparsing import (
     Suppress,
     Word,
     alphanums,
-    alphas,
     nums,
 )
 
+import voicemeeterlib
+
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+
+argparser = argparse.ArgumentParser(description='creates a basic dsl')
+argparser.add_argument('-i', action='store_true')
+args = argparser.parse_args()
+
+
+ParamKinds = IntEnum(
+    'ParamKinds',
+    'bool float string',
+)
+
+
+class Strategy(ABC):
+    def __init__(self, target, param, val):
+        self.target = target
+        self.param = param
+        self.val = val
+
+    @abstractmethod
+    def run(self):
+        pass
+
+
+class BoolStrategy(Strategy):
+    def run(self):
+        setattr(self.target, self.param, self.strtobool(self.val))
+
+    def strtobool(self, val):
+        """Convert a string representation of truth to it's numeric form."""
+
+        val = val.lower()
+        if val in ('y', 'yes', 't', 'true', 'on', '1'):
+            return 1
+        elif val in ('n', 'no', 'f', 'false', 'off', '0'):
+            return 0
+        else:
+            raise ValueError('invalid truth value %r' % (val,))
+
+
+class FloatStrategy(Strategy):
+    def run(self):
+        setattr(self.target, self.param, float(self.val))
+
+
+class StringStrategy(Strategy):
+    def run(self):
+        setattr(self.target, self.param, ' '.join(self.val))
+
+
+class Context:
+    def __init__(self, strategy: Strategy) -> None:
+        self._strategy = strategy
+
+    @property
+    def strategy(self) -> Strategy:
+        return self._strategy
+
+    @strategy.setter
+    def strategy(self, strategy: Strategy) -> None:
+        self._strategy = strategy
+
+    def run(self):
+        self.strategy.run()
+
 
 class Parser:
+    IS_STRING = ('label',)
+
     def __init__(self, vm):
+        self.logger = logger.getChild(self.__class__.__name__)
         self.vm = vm
         self.kls = Group(OneOrMore(Word(alphanums)))
-        self.token = Suppress("->")
+        self.token = Suppress('->')
-        self.param = Word(alphanums)
+        self.param = Group(OneOrMore(Word(alphanums)))
         self.value = Combine(
-            Optional("-") + Word(nums) + Optional(".") + Optional(Word(nums))
+            Optional('-') + Word(nums) + Optional('.') + Optional(Word(nums))
         ) | Group(OneOrMore(Word(alphanums)))
         self.event = (
             self.kls
@@ -31,68 +105,94 @@ class Parser:
             + Optional(self.value)
         )
 
-    def parse(self, cmds):
+    def converter(self, cmds):
+        """determines the kind of parameter from the parsed string"""
+
         res = list()
-
         for cmd in cmds:
-            if len(self.event.parseString(cmd)) == 2:
+            self.logger.debug(f'running command: {cmd}')
-                kls, param = self.event.parseString(cmd)
+            match cmd_parsed := self.event.parseString(cmd):
-                target = getattr(self.vm, kls[0])[int(kls[-1])]
+                case [[kls, index], [param]]:
-                res.append(getattr(target, param))
+                    target = getattr(self.vm, kls)[int(index)]
-            elif len(self.event.parseString(cmd)) == 3:
+                    res.append(getattr(target, param))
-                kls, param, val = self.event.parseString(cmd)
+                case [[kls, index], [param], val] if param in self.IS_STRING:
-                target = getattr(self.vm, kls[0])[int(kls[-1])]
+                    target = getattr(self.vm, kls)[int(index)]
-                if "".join(val) in ["off", "on"]:
+                    context = self._get_context(ParamKinds.string, target, param, val)
-                    setattr(target, param, bool(["off", "on"].index("".join(val))))
+                    context.run()
-                elif param in ["gain", "comp", "gate", "limit", "audibility"]:
+                case [[kls, index], [param], [val] | val]:
-                    setattr(target, param, float("".join(val)))
+                    target = getattr(self.vm, kls)[int(index)]
-                elif param in ["label"]:
+                    try:
-                    setattr(target, param, " ".join(val))
+                        context = self._get_context(ParamKinds.bool, target, param, val)
-
+                        context.run()
+                    except ValueError as e:
+                        self.logger.error(f'{e}... switching to float strategy')
+                        context.strategy = FloatStrategy(target, param, val)
+                        context.run()
+                case [
+                    [kls, index],
+                    [secondary, param],
+                    [val]
+                    | val,
+                ]:
+                    primary = getattr(self.vm, kls)[int(index)]
+                    target = getattr(primary, secondary)
+                    try:
+                        context = self._get_context(ParamKinds.bool, target, param, val)
+                        context.run()
+                    except ValueError as e:
+                        self.logger.error(f'{e}... switching to float strategy')
+                        context.strategy = FloatStrategy(target, param, val)
+                        context.run()
+                case _:
+                    self.logger.error(
+                        f'unable to determine the kind of parameter from {cmd_parsed}'
+                    )
             time.sleep(0.05)
         return res
 
+    def _get_context(self, kind, *args):
+        """
+        determines a strategy for a kind of parameter and passes it to the context.
+        """
 
-def main(cmds=None):
+        match kind:
-    kind_id = "banana"
+            case ParamKinds.bool:
-
+                context = Context(BoolStrategy(*args))
-    with voicemeeterlib.api(kind_id) as vm:
+            case ParamKinds.float:
-        parser = Parser(vm)
+                context = Context(FloatStrategy(*args))
-        if cmds:
+            case ParamKinds.string:
-            res = parser.parse(cmds)
+                context = Context(StringStrategy(*args))
-            if res:
+        return context
-                print(res)
-        else:
-            while cmd := input("Please enter command (Press <Enter> to exit)\n"):
-                if not cmd:
-                    break
-                res = parser.parse((cmd,))
-                if res:
-                    print(res)
 
 
-if __name__ == "__main__":
+def interactive_mode(parser):
+    while cmd := input('Please enter command (Press <Enter> to exit)\n'):
+        if res := parser.parse((cmd,)):
+            print(res)
+
+
+def main():
+    # fmt: off
     cmds = (
-        "strip 0 -> mute -> on",
+        "strip 0 -> mute -> true", "strip 0 -> mute", "bus 0 -> mute -> true",
-        "strip 0 -> mute",
+        "strip 0 -> mute -> false", "bus 0 -> mute -> true", "strip 3 -> solo -> true",
-        "bus 0 -> mute -> on",
+        "strip 3 -> solo -> false", "strip 1 -> A1 -> true", "strip 1 -> A1",
-        "strip 0 -> mute -> off",
+        "strip 1 -> A1 -> false", "strip 1 -> A1", "strip 3 -> eq on -> true",
-        "bus 0 -> mute -> on",
+        "bus 3 -> eq on -> false", "strip 4 -> gain -> 1.2", "strip 0 -> gain -> -8.2",
-        "strip 3 -> solo -> on",
+        "strip 0 -> gain", "strip 1 -> label -> rode podmic", "strip 2 -> limit -> -28",
-        "strip 3 -> solo -> off",
+        "strip 2 -> limit", "strip 3 -> comp knob -> 3.8"
-        "strip 1 -> A1 -> on",
-        "strip 1 -> A1",
-        "strip 1 -> A1 -> off",
-        "strip 1 -> A1",
-        "bus 3 -> eq -> on",
-        "bus 3 -> eq -> off",
-        "strip 4 -> gain -> 1.2",
-        "strip 0 -> gain -> -8.2",
-        "strip 0 -> gain",
-        "strip 1 -> label -> rode podmic",
-        "strip 2 -> limit -> -28",
-        "strip 2 -> limit",
     )
+    # fmt: on
 
-    # pass cmds to parse cmds, otherwise simply run main() to test stdin parsing
+    with voicemeeterlib.api('potato') as vm:
-    main(cmds)
+        parser = Parser(vm)
+        if args.i:
+            interactive_mode(parser)
+            return
+
+        if res := parser.converter(cmds):
+            print(res)
+
+
+if __name__ == '__main__':
+    main()

examples/dsl/setup.py

@@ -0,0 +1,7 @@
+from setuptools import setup
+
+setup(
+    name="dsl",
+    description="dsl example",
+    install_requires=["pyparsing"],
+)

examples/eq_edit/README.md

@@ -0,0 +1,9 @@
+## About
+
+The purpose of this script is to demonstratehow to utilize the channels and cells that are available as part of the EQ. It should take audio playing in the second virtual strip and then apply a LGF on the first physical at 500 Hz.
+
+## Use
+
+Configured for banana version.
+
+Make sure you are playing audio into the second virtual strip and out of the first physical bus, both channels are unmuted and that you aren't monitoring another mixbus. Then run the script.

examples/eq_edit/__main__.py

@@ -0,0 +1,50 @@
+import time
+
+import voicemeeterlib
+
+
+def main():
+    KIND_ID = 'banana'
+    BUS_INDEX = 0  # Index of the bus to edit, can be changed as needed
+    CHANNEL_INDEX = 0  # Index of the channel to edit, can be changed as needed
+
+    with voicemeeterlib.api(KIND_ID) as vm:
+        print(f'Bus[{BUS_INDEX}].EQ.on: {vm.bus[BUS_INDEX].eq.on}')
+        print(
+            f'Bus[{BUS_INDEX}].EQ.channel[{CHANNEL_INDEX}].cell[0].on: {vm.bus[BUS_INDEX].eq.channel[CHANNEL_INDEX].cell[0].on}'
+        )
+
+        print('Check sending commands (should affect your VM Banana window)')
+
+        vm.bus[BUS_INDEX].eq.on = True
+        vm.bus[BUS_INDEX].eq.ab = 0  # corresponds to A EQ memory slot
+        vm.bus[BUS_INDEX].mute = False
+
+        for j, cell in enumerate(vm.bus[BUS_INDEX].eq.channel[CHANNEL_INDEX].cell):
+            cell.on = True
+            cell.f = 500
+            cell.gain = -10
+            cell.type = 3  # Should correspond to LPF
+            cell.q = 10
+
+            print(
+                f'Channel {CHANNEL_INDEX}, Cell {j}: on={cell.on}, f={cell.f}, type={cell.type}, gain={cell.gain}, q={cell.q}'
+            )
+
+            time.sleep(1)  # Sleep to simulate processing time
+
+            cell.on = False
+            cell.f = 50
+            cell.gain = 0
+            cell.type = 0
+            cell.q = 3
+
+            print(
+                f'Channel {CHANNEL_INDEX}, Cell {j}: on={cell.on}, f={cell.f}, type={cell.type} , gain={cell.gain}, q={cell.q}'
+            )
+
+        vm.bus[BUS_INDEX].eq.on = False
+
+
+if __name__ == '__main__':
+    main()

examples/events/README.md

@@ -0,0 +1,8 @@
+# Events
+
+If you want to receive updates on certain events there are two routes you can take:
+
+-   Register a class that implements an `on_update(self, event) -> None` method on the `{Remote}.subject` class.
+-   Register callback functions/methods on the `{Remote}.subject` class, one for each type of update.
+
+Included are examples of both approaches.

examples/events/callbacks/README.md

@@ -0,0 +1,33 @@
+## About
+
+This script demonstrates how to interact with the event thread/event object. It also demonstrates how to register event specific callbacks.
+
+By default the interface does not broadcast any events. So even though our callbacks are registered, and the event thread has been initiated, we won't receive updates.
+
+After five seconds the event object is used to subscribe to all events for a total of thirty seconds.
+
+Remember that events can also be unsubscribed to with `vm.event.remove()`. Callbacks can also be deregistered using vm.observer.remove().
+
+The same can be done without a context manager:
+
+```python
+    vm = voicemeeterlib.api(KIND_ID)
+    vm.login()
+    vm.observer.add(on_midi)    # register an `on_midi` callback function
+    vm.init_thread()
+    vm.event.add("midi")    # in this case we only subscribe to midi events.
+    ...
+    vm.end_thread()
+    vm.logout()
+```
+
+Once initialized, the event thread will continously run until end_thread() is called. Even if all events are unsubscribed to.
+
+## Use
+
+Simply run the script and trigger events and you should see the output after 5 seconds. To trigger events do the following:
+
+-   change GUI parameters to trigger pdirty
+-   press any macrobutton to trigger mdirty
+-   play audio through any bus to trigger ldirty
+-   any midi input to trigger midi

examples/events/callbacks/__main__.py

@@ -0,0 +1,53 @@
+import logging
+import time
+
+import voicemeeterlib
+
+logging.basicConfig(level=logging.INFO)
+
+
+class App:
+    def __init__(self, vm):
+        self._vm = vm
+        # register the callbacks for each event
+        self._vm.observer.add(
+            [self.on_pdirty, self.on_mdirty, self.on_ldirty, self.on_midi]
+        )
+
+    def __enter__(self):
+        self._vm.init_thread()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self._vm.end_thread()
+
+    def on_pdirty(self):
+        print('pdirty!')
+
+    def on_mdirty(self):
+        print('mdirty!')
+
+    def on_ldirty(self):
+        for bus in self._vm.bus:
+            if bus.levels.isdirty:
+                print(bus, bus.levels.all)
+
+    def on_midi(self):
+        current = self._vm.midi.current
+        print(f'Value of midi button {current} is {self._vm.midi.get(current)}')
+
+
+def main():
+    KIND_ID = 'banana'
+
+    with voicemeeterlib.api(KIND_ID) as vm:
+        with App(vm):
+            for i in range(5, 0, -1):
+                print(f'events start in {i} seconds')
+                time.sleep(1)
+            vm.event.add(['pdirty', 'ldirty', 'midi', 'mdirty'])
+            time.sleep(30)
+
+
+if __name__ == '__main__':
+    main()

examples/events/observer/README.md

@@ -0,0 +1,14 @@
+## About
+
+Registers a class as an observer and defines a callback.
+
+## Use
+
+Run the script, then:
+
+-   change GUI parameters to trigger pdirty
+-   press any macrobutton to trigger mdirty
+-   play audio through any bus to trigger ldirty
+-   any midi input to trigger midi
+
+Pressing `<Enter>` will exit.

examples/events/observer/__main__.py

@@ -0,0 +1,45 @@
+import logging
+
+import voicemeeterlib
+
+logging.basicConfig(level=logging.INFO)
+
+
+class App:
+    def __init__(self, vm):
+        self._vm = vm
+        # register your app as event observer
+        self._vm.observer.add(self)
+
+    def __str__(self):
+        return type(self).__name__
+
+    # define an 'on_update' callback function to receive event updates
+    def on_update(self, event):
+        if event == 'pdirty':
+            print('pdirty!')
+        elif event == 'mdirty':
+            print('mdirty!')
+        elif event == 'ldirty':
+            for bus in self._vm.bus:
+                if bus.levels.isdirty:
+                    print(bus, bus.levels.all)
+        elif event == 'midi':
+            current = self._vm.midi.current
+            print(f'Value of midi button {current} is {self._vm.midi.get(current)}')
+
+
+def main():
+    KIND_ID = 'banana'
+
+    with voicemeeterlib.api(
+        KIND_ID, **{k: True for k in ('pdirty', 'mdirty', 'ldirty', 'midi')}
+    ) as vm:
+        App(vm)
+
+        while _ := input('Press <Enter> to exit\n'):
+            pass
+
+
+if __name__ == '__main__':
+    main()

examples/gui/README.md

@@ -0,0 +1,13 @@
+## About
+
+A single channel GUI demonstrating controls for the first virtual strip if Voicemeeter Banana.
+
+This example demonstrates (to an extent) two way communication. 
+-   Sending parameters values to the Voicemeeter driver.
+-   Receiving level updates
+
+Parameter updates (pdirty) events are not being received so changing a UI element on the main Voicemeeter app will not be reflected in the example GUI.
+
+## Use
+
+Simply run the script and try the controls.

examples/gui/__main__.py

@@ -0,0 +1,109 @@
+import logging
+import tkinter as tk
+from tkinter import ttk
+
+import voicemeeterlib
+
+logging.basicConfig(level=logging.DEBUG)
+
+
+class App(tk.Tk):
+    INDEX = 3
+
+    def __init__(self, vm):
+        super().__init__()
+        self._vm = vm
+        self.title(f'{vm} - version {vm.version}')
+        self._vm.observer.add(self.on_ldirty)
+
+        # create widget variables
+        self.button_var = tk.BooleanVar(value=vm.strip[self.INDEX].mute)
+        self.slider_var = tk.DoubleVar(value=vm.strip[self.INDEX].gain)
+        self.meter_var = tk.DoubleVar(value=self._get_level())
+        self.gainlabel_var = tk.StringVar(value=self.slider_var.get())
+
+        # initialize style table
+        self.style = ttk.Style()
+        self.style.theme_use('clam')
+        self.style.configure(
+            'Mute.TButton',
+            foreground='#cd5c5c' if vm.strip[self.INDEX].mute else '#5a5a5a',
+        )
+
+        # create labelframe and grid it onto the mainframe
+        self.labelframe = tk.LabelFrame(self, text=self._vm.strip[self.INDEX].label)
+        self.labelframe.grid(padx=1)
+
+        # create slider and grid it onto the labelframe
+        slider = ttk.Scale(
+            self.labelframe,
+            from_=12,
+            to_=-60,
+            orient='vertical',
+            variable=self.slider_var,
+            command=lambda arg: self.on_slider_move(arg),
+        )
+        slider.grid(
+            column=0,
+            row=0,
+        )
+        slider.bind('<Double-Button-1>', self.on_button_double_click)
+
+        # create level meter and grid it onto the labelframe
+        level_meter = ttk.Progressbar(
+            self.labelframe,
+            orient='vertical',
+            variable=self.meter_var,
+            maximum=72,
+            mode='determinate',
+        )
+        level_meter.grid(column=1, row=0)
+
+        # create gainlabel and grid it onto the labelframe
+        gainlabel = ttk.Label(self.labelframe, textvariable=self.gainlabel_var)
+        gainlabel.grid(column=0, row=1, columnspan=2)
+
+        # create button and grid it onto the labelframe
+        button = ttk.Button(
+            self.labelframe,
+            text='Mute',
+            style='Mute.TButton',
+            command=lambda: self.on_button_press(),
+        )
+        button.grid(column=0, row=2, columnspan=2, padx=1, pady=2)
+
+    # define callbacks
+
+    def on_slider_move(self, *args):
+        val = round(self.slider_var.get(), 1)
+        self._vm.strip[self.INDEX].gain = val
+        self.gainlabel_var.set(val)
+
+    def on_button_press(self):
+        self.button_var.set(not self.button_var.get())
+        self._vm.strip[self.INDEX].mute = self.button_var.get()
+        self.style.configure(
+            'Mute.TButton', foreground='#cd5c5c' if self.button_var.get() else '#5a5a5a'
+        )
+
+    def on_button_double_click(self, e):
+        self.slider_var.set(0)
+        self.gainlabel_var.set(0)
+        self._vm.strip[self.INDEX].gain = 0
+
+    def _get_level(self):
+        val = max(self._vm.strip[self.INDEX].levels.postfader)
+        return 0 if self.button_var.get() else 72 + val - 12
+
+    def on_ldirty(self):
+        self.meter_var.set(self._get_level())
+
+
+def main():
+    with voicemeeterlib.api('banana', ldirty=True) as vm:
+        app = App(vm)
+        app.mainloop()
+
+
+if __name__ == '__main__':
+    main()

examples/levels/README.md

@@ -0,0 +1,13 @@
+## About
+
+The purpose of this script is to demonstrate:
+
+-   use of the interface without a context manager.
+-   retrieving level values for channels by polling (instead of receiving data as event)
+-   use of the interface without the events thread running.
+
+## Use
+
+Configured for potato version.
+
+Make sure you are playing audio into the first virtual strip and out of the first physical bus, both channels are unmuted and that you aren't monitoring another mixbus. Then run the script.

examples/levels/__main__.py

@@ -0,0 +1,28 @@
+import logging
+import time
+
+import voicemeeterlib
+
+logging.basicConfig(level=logging.INFO)
+
+
+def main():
+    KIND_ID = 'potato'
+
+    vm = voicemeeterlib.api(KIND_ID)
+    vm.login()
+    for _ in range(500):
+        print(
+            '\n'.join(
+                [
+                    f'{vm.strip[5]}: {vm.strip[5].levels.postmute}',
+                    f'{vm.bus[0]}: {vm.bus[0].levels.all}',
+                ]
+            )
+        )
+        time.sleep(0.033)
+    vm.logout()
+
+
+if __name__ == '__main__':
+    main()

examples/midi/__main__.py

@@ -1,64 +1,51 @@
+import logging
+
 import voicemeeterlib
 
+logging.basicConfig(level=logging.DEBUG)
 
-class Observer:
-    def __init__(self, vm, midi_btn, macrobutton):
-        self.vm = vm
-        self.midi_btn = midi_btn
-        self.macrobutton = macrobutton
 
-    def register(self):
+class App:
-        self.vm.subject.add(self)
+    MIDI_BUTTON = 48  # leftmost M on korg nanokontrol2 in CC mode
+    MACROBUTTON = 0
 
-    def on_update(self, subject):
+    def __init__(self, vm):
-        """
+        self._vm = vm
-        We expect to only receive midi updates.
+        self._vm.observer.add(self.on_midi)
 
-        We could skip subject check but check anyway, in case an event is added later.
+    def on_midi(self):
-        """
+        if self.get_info() == self.MIDI_BUTTON:
-        if subject == "midi":
-            self.get_info()
             self.on_midi_press()
 
     def get_info(self):
-        current = self.vm.midi.current
+        current = self._vm.midi.current
-        print(f"Value of midi button {current} is {self.vm.midi.get(current)}")
+        print(f'Value of midi button {current} is {self._vm.midi.get(current)}')
+        return current
 
     def on_midi_press(self):
-        """
+        """if midi button 48 is pressed and strip 3 level max > -40, then set trigger for macrobutton 0"""
-        checks if strip 3 level postfader mode is greater than -40
 
-        checks if midi button 48 velocity is 127 (full velocity for button press).
-        """
         if (
-            max(self.vm.strip[3].levels.postfader) > -40
+            self._vm.midi.get(self.MIDI_BUTTON) == 127
-            and self.vm.midi.get(self.midi_btn) == 127
+            and max(self._vm.strip[3].levels.postfader) > -40
         ):
             print(
-                f"Strip 3 level is greater than -40 and midi button {self.midi_btn} is pressed"
+                f'Strip 3 level max is greater than -40 and midi button {self.MIDI_BUTTON} is pressed'
             )
-            self.vm.button[self.macrobutton].trigger = True
+            self._vm.button[self.MACROBUTTON].trigger = True
         else:
-            self.vm.button[self.macrobutton].trigger = False
+            self._vm.button[self.MACROBUTTON].trigger = False
-            self.vm.button[self.macrobutton].state = False
 
 
 def main():
-    # we only care about midi events here.
+    KIND_ID = 'banana'
-    subs = {ev: False for ev in ["pdirty", "mdirty", "ldirty"]}
-    with voicemeeterlib.api(kind_id, subs=subs) as vm:
-        obs = Observer(vm, midi_btn, macrobutton)
-        obs.register()
 
-        while cmd := input("Press <Enter> to exit\n"):
+    with voicemeeterlib.api(KIND_ID, midi=True) as vm:
-            if not cmd:
+        App(vm)
-                break
+
+        while _ := input('Press <Enter> to exit\n'):
+            pass
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
-    kind_id = "banana"
-    # leftmost M on korg nanokontrol2 in CC mode
-    midi_btn = 48
-    macrobutton = 0
-
     main()

examples/obs/README.md

@@ -1,8 +1,7 @@
 ## Requirements
 
 -   [OBS Studio](https://obsproject.com/)
--   [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
+-   [OBS Python SDK for Websocket v5](https://github.com/aatikturk/obsws-python)
--   [OBS Python SDK for Websocket v5](https://github.com/aatikturk/obsstudio_sdk)
 
 ## About
 
@@ -18,8 +17,12 @@ port = 4455
 password = "mystrongpass"
 ```
 
+Closing OBS will end the script.
+
 ## Notes
 
-For a similar example for streamlabs check:
+In this example all but `voicemeeterlib.iremote` logs are filtered out. Log level set at DEBUG.
 
-[Streamlabs example](https://github.com/onyx-and-iris/PySLOBS/blob/master/examples/scenerotate.py)
+For a similar Streamlabs Desktop example:
+
+[Streamlabs example](https://gist.github.com/onyx-and-iris/c864f07126eeae389b011dc49520a19b)

examples/obs/__main__.py

@@ -1,58 +1,106 @@
-import obsstudio_sdk as obs
+import threading
+from logging import config
+
+import obsws_python as obsws
+
 import voicemeeterlib
 
-
+config.dictConfig(
-def on_start():
+    {
-    vm.strip[0].mute = True
+        'version': 1,
-    vm.strip[1].B1 = True
+        'formatters': {
-    vm.strip[2].B2 = True
+            'standard': {
+                'format': '%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s'
+            }
+        },
+        'handlers': {
+            'stream': {
+                'level': 'DEBUG',
+                'class': 'logging.StreamHandler',
+                'formatter': 'standard',
+            }
+        },
+        'loggers': {
+            'voicemeeterlib.iremote': {
+                'handlers': ['stream'],
+                'level': 'DEBUG',
+                'propagate': False,
+            }
+        },
+        'root': {'handlers': ['stream'], 'level': 'WARNING'},
+    }
+)
 
 
-def on_brb():
+class MyClient:
-    vm.strip[7].fadeto(0, 500)
+    def __init__(self, vm, stop_event):
-    vm.bus[0].mute = True
+        self._vm = vm
+        self._stop_event = stop_event
+        self._client = obsws.EventClient()
+        self._client.callback.register(
+            (
+                self.on_current_program_scene_changed,
+                self.on_exit_started,
+            )
+        )
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        self._client.disconnect()
+
+    def on_start(self):
+        self._vm.strip[0].mute = True
+        self._vm.strip[1].B1 = True
+        self._vm.strip[2].B2 = True
+
+    def on_brb(self):
+        self._vm.strip[7].fadeto(0, 500)
+        self._vm.bus[0].mute = True
+
+    def on_end(self):
+        self._vm.apply(
+            {
+                'strip-0': {'mute': True, 'comp': {'ratio': 4.3}},
+                'strip-1': {'mute': True, 'B1': False, 'gate': {'attack': 2.3}},
+                'strip-2': {'mute': True, 'B1': False},
+                'vban-in-0': {'on': False},
+            }
+        )
+
+    def on_live(self):
+        self._vm.strip[0].mute = False
+        self._vm.strip[7].fadeto(-6, 500)
+        self._vm.strip[7].A3 = True
+        self._vm.vban.instream[0].on = True
+
+    def on_current_program_scene_changed(self, data):
+        scene = data.scene_name
+        print(f'Switched to scene {scene}')
+        match scene:
+            case 'START':
+                self.on_start()
+            case 'BRB':
+                self.on_brb()
+            case 'END':
+                self.on_end()
+            case 'LIVE':
+                self.on_live()
+
+    def on_exit_started(self, _):
+        self._stop_event.set()
 
 
-def on_end():
+def main():
-    vm.apply(
+    KIND_ID = 'potato'
-        {
+
-            "strip-0": {"mute": True},
+    with voicemeeterlib.api(KIND_ID) as vm:
-            "strip-1": {"mute": True, "B1": False},
+        stop_event = threading.Event()
-            "strip-2": {"mute": True, "B1": False},
+
-            "vban-in-0": {"on": False},
+        with MyClient(vm, stop_event):
-        }
+            stop_event.wait()
-    )
 
 
-def on_live():
+if __name__ == '__main__':
-    vm.strip[0].mute = False
+    main()
-    vm.strip[7].fadeto(-6, 500)
-    vm.strip[7].A3 = True
-    vm.vban.instream[0].on = True
-
-
-def on_current_program_scene_changed(data):
-    scene = data.scene_name
-    print(f"Switched to scene {scene}")
-
-    match scene:
-        case "START":
-            on_start()
-        case "BRB":
-            on_brb()
-        case "END":
-            on_end()
-        case "LIVE":
-            on_live()
-        case _:
-            pass
-
-
-if __name__ == "__main__":
-    with voicemeeterlib.api("potato") as vm:
-        cl = obs.EventClient()
-        cl.callback.register(on_current_program_scene_changed)
-
-        while cmd := input("<Enter> to exit\n"):
-            if not cmd:
-                break

examples/obs/setup.py

@@ -3,5 +3,5 @@ from setuptools import setup
 setup(
     name="obs",
     description="OBS Example",
-    install_requires=["voicemeeter-api", "obsstudio-sdk"],
+    install_requires=["obsws-python"],
 )

examples/observer/__main__.py

@@ -1,44 +0,0 @@
-import voicemeeterlib
-
-
-class Observer:
-    def __init__(self, vm):
-        self.vm = vm
-        # register your app as event observer
-        self.vm.subject.add(self)
-        # add level updates, since they are disabled by default.
-        self.vm.event.add("ldirty")
-
-    # define an 'on_update' callback function to receive event updates
-    def on_update(self, subject):
-        if subject == "pdirty":
-            print("pdirty!")
-        elif subject == "mdirty":
-            print("mdirty!")
-        elif subject == "ldirty":
-            info = (
-                f"[{self.vm.bus[0]} {self.vm.bus[0].levels.isdirty}]",
-                f"[{self.vm.bus[1]} {self.vm.bus[1].levels.isdirty}]",
-                f"[{self.vm.bus[2]} {self.vm.bus[2].levels.isdirty}]",
-                f"[{self.vm.bus[3]} {self.vm.bus[3].levels.isdirty}]",
-                f"[{self.vm.bus[4]} {self.vm.bus[4].levels.isdirty}]",
-            )
-            print(" ".join(info))
-        elif subject == "midi":
-            current = self.vm.midi.current
-            print(f"Value of midi button {current} is {self.vm.midi.get(current)}")
-
-
-def main():
-    with voicemeeterlib.api(kind_id) as vm:
-        obs = Observer(vm)
-
-        while cmd := input("Press <Enter> to exit\n"):
-            if not cmd:
-                break
-
-
-if __name__ == "__main__":
-    kind_id = "banana"
-
-    main()

poetry.lock

@@ -1,294 +1,363 @@
-[[package]]
+# This file is automatically @generated by Poetry 2.0.1 and should not be changed by hand.
-name = "atomicwrites"
-version = "1.4.1"
-description = "Atomic file writes."
-category = "dev"
-optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
 
 [[package]]
-name = "attrs"
+name = "cachetools"
-version = "22.1.0"
+version = "5.5.0"
-description = "Classes Without Boilerplate"
+description = "Extensible memoizing collections and decorators"
-category = "dev"
-optional = false
-python-versions = ">=3.5"
-
-[package.extras]
-dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "mypy (>=0.900,!=0.940)", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit", "cloudpickle"]
-docs = ["furo", "sphinx", "zope.interface", "sphinx-notfound-page"]
-tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "mypy (>=0.900,!=0.940)", "pytest-mypy-plugins", "zope.interface", "cloudpickle"]
-tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "mypy (>=0.900,!=0.940)", "pytest-mypy-plugins", "cloudpickle"]
-
-[[package]]
-name = "black"
-version = "22.6.0"
-description = "The uncompromising code formatter."
-category = "dev"
-optional = false
-python-versions = ">=3.6.2"
-
-[package.dependencies]
-click = ">=8.0.0"
-mypy-extensions = ">=0.4.3"
-pathspec = ">=0.9.0"
-platformdirs = ">=2"
-
-[package.extras]
-colorama = ["colorama (>=0.4.3)"]
-d = ["aiohttp (>=3.7.4)"]
-jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"]
-uvloop = ["uvloop (>=0.15.2)"]
-
-[[package]]
-name = "click"
-version = "8.1.3"
-description = "Composable command line interface toolkit"
-category = "dev"
 optional = false
 python-versions = ">=3.7"
+groups = ["dev"]
+files = [
+    {file = "cachetools-5.5.0-py3-none-any.whl", hash = "sha256:02134e8439cdc2ffb62023ce1debca2944c3f289d66bb17ead3ab3dede74b292"},
+    {file = "cachetools-5.5.0.tar.gz", hash = "sha256:2cc24fb4cbe39633fb7badd9db9ca6295d766d9c2995f245725a46715d050f2a"},
+]
 
-[package.dependencies]
+[[package]]
-colorama = {version = "*", markers = "platform_system == \"Windows\""}
+name = "chardet"
+version = "5.2.0"
+description = "Universal encoding detector for Python 3"
+optional = false
+python-versions = ">=3.7"
+groups = ["dev"]
+files = [
+    {file = "chardet-5.2.0-py3-none-any.whl", hash = "sha256:e1cf59446890a00105fe7b7912492ea04b6e6f06d4b742b2c788469e34c82970"},
+    {file = "chardet-5.2.0.tar.gz", hash = "sha256:1b3b6ff479a8c414bc3fa2c0852995695c4a026dcd6d0633b2dd092ca39c1cf7"},
+]
 
 [[package]]
 name = "colorama"
-version = "0.4.5"
+version = "0.4.6"
 description = "Cross-platform colored terminal text."
-category = "dev"
 optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+groups = ["dev"]
+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 = "distlib"
+version = "0.3.9"
+description = "Distribution utilities"
+optional = false
+python-versions = "*"
+groups = ["dev"]
+files = [
+    {file = "distlib-0.3.9-py2.py3-none-any.whl", hash = "sha256:47f8c22fd27c27e25a65601af709b38e4f0a45ea4fc2e710f65755fa8caaaf87"},
+    {file = "distlib-0.3.9.tar.gz", hash = "sha256:a60f20dea646b8a33f3e7772f74dc0b2d0772d2837ee1342a00645c81edf9403"},
+]
+
+[[package]]
+name = "exceptiongroup"
+version = "1.2.2"
+description = "Backport of PEP 654 (exception groups)"
+optional = false
+python-versions = ">=3.7"
+groups = ["dev"]
+markers = "python_version < \"3.11\""
+files = [
+    {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"},
+    {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"},
+]
+
+[package.extras]
+test = ["pytest (>=6)"]
+
+[[package]]
+name = "filelock"
+version = "3.16.1"
+description = "A platform independent file lock."
+optional = false
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "filelock-3.16.1-py3-none-any.whl", hash = "sha256:2082e5703d51fbf98ea75855d9d5527e33d8ff23099bec374a134febee6946b0"},
+    {file = "filelock-3.16.1.tar.gz", hash = "sha256:c249fbfcd5db47e5e2d6d62198e565475ee65e4831e2561c8e313fa7eb961435"},
+]
+
+[package.extras]
+docs = ["furo (>=2024.8.6)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4.1)"]
+testing = ["covdefaults (>=2.3)", "coverage (>=7.6.1)", "diff-cover (>=9.2)", "pytest (>=8.3.3)", "pytest-asyncio (>=0.24)", "pytest-cov (>=5)", "pytest-mock (>=3.14)", "pytest-timeout (>=2.3.1)", "virtualenv (>=20.26.4)"]
+typing = ["typing-extensions (>=4.12.2)"]
 
 [[package]]
 name = "iniconfig"
-version = "1.1.1"
+version = "2.0.0"
-description = "iniconfig: brain-dead simple config-ini parsing"
+description = "brain-dead simple config-ini parsing"
-category = "dev"
 optional = false
-python-versions = "*"
+python-versions = ">=3.7"
-
+groups = ["dev"]
-[[package]]
+files = [
-name = "isort"
+    {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"},
-version = "5.10.1"
+    {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"},
-description = "A Python utility / library to sort Python imports."
+]
-category = "dev"
-optional = false
-python-versions = ">=3.6.1,<4.0"
-
-[package.extras]
-pipfile_deprecated_finder = ["pipreqs", "requirementslib"]
-requirements_deprecated_finder = ["pipreqs", "pip-api"]
-colors = ["colorama (>=0.4.3,<0.5.0)"]
-plugins = ["setuptools"]
-
-[[package]]
-name = "mypy-extensions"
-version = "0.4.3"
-description = "Experimental type system extensions for programs checked with the mypy typechecker."
-category = "dev"
-optional = false
-python-versions = "*"
 
 [[package]]
 name = "packaging"
-version = "21.3"
+version = "24.2"
 description = "Core utilities for Python packages"
-category = "dev"
 optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.8"
-
+groups = ["dev"]
-[package.dependencies]
+files = [
-pyparsing = ">=2.0.2,<3.0.5 || >3.0.5"
+    {file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"},
-
+    {file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"},
-[[package]]
+]
-name = "pathspec"
-version = "0.9.0"
-description = "Utility library for gitignore style pattern matching of file paths."
-category = "dev"
-optional = false
-python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7"
 
 [[package]]
 name = "platformdirs"
-version = "2.5.2"
+version = "4.3.6"
-description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
+description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
-category = "dev"
 optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "platformdirs-4.3.6-py3-none-any.whl", hash = "sha256:73e575e1408ab8103900836b97580d5307456908a03e92031bab39e4554cc3fb"},
+    {file = "platformdirs-4.3.6.tar.gz", hash = "sha256:357fb2acbc885b0419afd3ce3ed34564c13c9b95c89360cd9563f73aa5e2b907"},
+]
 
 [package.extras]
-docs = ["furo (>=2021.7.5b38)", "proselint (>=0.10.2)", "sphinx-autodoc-typehints (>=1.12)", "sphinx (>=4)"]
+docs = ["furo (>=2024.8.6)", "proselint (>=0.14)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4)"]
-test = ["appdirs (==1.4.4)", "pytest-cov (>=2.7)", "pytest-mock (>=3.6)", "pytest (>=6)"]
+test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=8.3.2)", "pytest-cov (>=5)", "pytest-mock (>=3.14)"]
+type = ["mypy (>=1.11.2)"]
 
 [[package]]
 name = "pluggy"
-version = "1.0.0"
+version = "1.5.0"
 description = "plugin and hook calling mechanisms for python"
-category = "dev"
 optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"},
+    {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"},
+]
 
 [package.extras]
 dev = ["pre-commit", "tox"]
 testing = ["pytest", "pytest-benchmark"]
 
 [[package]]
-name = "py"
+name = "pyenv-inspect"
-version = "1.11.0"
+version = "0.4.0"
-description = "library with cross-python path, ini-parsing, io, code, log facilities"
+description = "An auxiliary library for the virtualenv-pyenv and tox-pyenv-redux plugins"
-category = "dev"
 optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "pyenv-inspect-0.4.0.tar.gz", hash = "sha256:ec429d1d81b67ab0b08a0408414722a79d24fd1845a5b264267e44e19d8d60f0"},
+    {file = "pyenv_inspect-0.4.0-py3-none-any.whl", hash = "sha256:618683ae7d3e6db14778d58aa0fc6b3170180d944669b5d35a8aa4fb7db550d2"},
+]
 
 [[package]]
-name = "pyparsing"
+name = "pyproject-api"
-version = "3.0.9"
+version = "1.8.0"
-description = "pyparsing module - Classes and methods to define and execute parsing grammars"
+description = "API to interact with the python pyproject.toml based projects"
-category = "dev"
 optional = false
-python-versions = ">=3.6.8"
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "pyproject_api-1.8.0-py3-none-any.whl", hash = "sha256:3d7d347a047afe796fd5d1885b1e391ba29be7169bd2f102fcd378f04273d228"},
+    {file = "pyproject_api-1.8.0.tar.gz", hash = "sha256:77b8049f2feb5d33eefcc21b57f1e279636277a8ac8ad6b5871037b243778496"},
+]
+
+[package.dependencies]
+packaging = ">=24.1"
+tomli = {version = ">=2.0.1", markers = "python_version < \"3.11\""}
 
 [package.extras]
-diagrams = ["railroad-diagrams", "jinja2"]
+docs = ["furo (>=2024.8.6)", "sphinx-autodoc-typehints (>=2.4.1)"]
+testing = ["covdefaults (>=2.3)", "pytest (>=8.3.3)", "pytest-cov (>=5)", "pytest-mock (>=3.14)", "setuptools (>=75.1)"]
 
 [[package]]
 name = "pytest"
-version = "7.1.2"
+version = "8.3.4"
 description = "pytest: simple powerful testing with Python"
-category = "dev"
 optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "pytest-8.3.4-py3-none-any.whl", hash = "sha256:50e16d954148559c9a74109af1eaf0c945ba2d8f30f0a3d3335edde19788b6f6"},
+    {file = "pytest-8.3.4.tar.gz", hash = "sha256:965370d062bce11e73868e0335abac31b4d3de0e82f4007408d242b4f8610761"},
+]
 
 [package.dependencies]
-atomicwrites = {version = ">=1.0", markers = "sys_platform == \"win32\""}
-attrs = ">=19.2.0"
 colorama = {version = "*", markers = "sys_platform == \"win32\""}
+exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
 iniconfig = "*"
 packaging = "*"
-pluggy = ">=0.12,<2.0"
+pluggy = ">=1.5,<2"
-py = ">=1.8.2"
+tomli = {version = ">=1", markers = "python_version < \"3.11\""}
-tomli = ">=1.0.0"
 
 [package.extras]
-testing = ["argcomplete", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "xmlschema"]
+dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
 
 [[package]]
 name = "pytest-randomly"
-version = "3.12.0"
+version = "3.16.0"
 description = "Pytest plugin to randomly order tests and control random.seed."
-category = "dev"
 optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.9"
+groups = ["dev"]
+files = [
+    {file = "pytest_randomly-3.16.0-py3-none-any.whl", hash = "sha256:8633d332635a1a0983d3bba19342196807f6afb17c3eef78e02c2f85dade45d6"},
+    {file = "pytest_randomly-3.16.0.tar.gz", hash = "sha256:11bf4d23a26484de7860d82f726c0629837cf4064b79157bd18ec9d41d7feb26"},
+]
 
 [package.dependencies]
 pytest = "*"
 
 [[package]]
-name = "pytest-repeat"
+name = "ruff"
-version = "0.9.1"
+version = "0.8.6"
-description = "pytest plugin for repeating tests"
+description = "An extremely fast Python linter and code formatter, written in Rust."
-category = "dev"
 optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+python-versions = ">=3.7"
-
+groups = ["dev"]
-[package.dependencies]
+files = [
-pytest = ">=3.6"
+    {file = "ruff-0.8.6-py3-none-linux_armv6l.whl", hash = "sha256:defed167955d42c68b407e8f2e6f56ba52520e790aba4ca707a9c88619e580e3"},
+    {file = "ruff-0.8.6-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:54799ca3d67ae5e0b7a7ac234baa657a9c1784b48ec954a094da7c206e0365b1"},
+    {file = "ruff-0.8.6-py3-none-macosx_11_0_arm64.whl", hash = "sha256:e88b8f6d901477c41559ba540beeb5a671e14cd29ebd5683903572f4b40a9807"},
+    {file = "ruff-0.8.6-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0509e8da430228236a18a677fcdb0c1f102dd26d5520f71f79b094963322ed25"},
+    {file = "ruff-0.8.6-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:91a7ddb221779871cf226100e677b5ea38c2d54e9e2c8ed847450ebbdf99b32d"},
+    {file = "ruff-0.8.6-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:248b1fb3f739d01d528cc50b35ee9c4812aa58cc5935998e776bf8ed5b251e75"},
+    {file = "ruff-0.8.6-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:bc3c083c50390cf69e7e1b5a5a7303898966be973664ec0c4a4acea82c1d4315"},
+    {file = "ruff-0.8.6-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:52d587092ab8df308635762386f45f4638badb0866355b2b86760f6d3c076188"},
+    {file = "ruff-0.8.6-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:61323159cf21bc3897674e5adb27cd9e7700bab6b84de40d7be28c3d46dc67cf"},
+    {file = "ruff-0.8.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7ae4478b1471fc0c44ed52a6fb787e641a2ac58b1c1f91763bafbc2faddc5117"},
+    {file = "ruff-0.8.6-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:0c000a471d519b3e6cfc9c6680025d923b4ca140ce3e4612d1a2ef58e11f11fe"},
+    {file = "ruff-0.8.6-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:9257aa841e9e8d9b727423086f0fa9a86b6b420fbf4bf9e1465d1250ce8e4d8d"},
+    {file = "ruff-0.8.6-py3-none-musllinux_1_2_i686.whl", hash = "sha256:45a56f61b24682f6f6709636949ae8cc82ae229d8d773b4c76c09ec83964a95a"},
+    {file = "ruff-0.8.6-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:496dd38a53aa173481a7d8866bcd6451bd934d06976a2505028a50583e001b76"},
+    {file = "ruff-0.8.6-py3-none-win32.whl", hash = "sha256:e169ea1b9eae61c99b257dc83b9ee6c76f89042752cb2d83486a7d6e48e8f764"},
+    {file = "ruff-0.8.6-py3-none-win_amd64.whl", hash = "sha256:f1d70bef3d16fdc897ee290d7d20da3cbe4e26349f62e8a0274e7a3f4ce7a905"},
+    {file = "ruff-0.8.6-py3-none-win_arm64.whl", hash = "sha256:7d7fc2377a04b6e04ffe588caad613d0c460eb2ecba4c0ccbbfe2bc973cbc162"},
+    {file = "ruff-0.8.6.tar.gz", hash = "sha256:dcad24b81b62650b0eb8814f576fc65cfee8674772a6e24c9b747911801eeaa5"},
+]
 
 [[package]]
 name = "tomli"
-version = "2.0.1"
+version = "2.2.1"
 description = "A lil' TOML parser"
-category = "dev"
 optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+groups = ["main", "dev"]
+markers = "python_version < \"3.11\""
+files = [
+    {file = "tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249"},
+    {file = "tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6"},
+    {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a"},
+    {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee"},
+    {file = "tomli-2.2.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e"},
+    {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4"},
+    {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106"},
+    {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8"},
+    {file = "tomli-2.2.1-cp311-cp311-win32.whl", hash = "sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff"},
+    {file = "tomli-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b"},
+    {file = "tomli-2.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea"},
+    {file = "tomli-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8"},
+    {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192"},
+    {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222"},
+    {file = "tomli-2.2.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77"},
+    {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6"},
+    {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd"},
+    {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e"},
+    {file = "tomli-2.2.1-cp312-cp312-win32.whl", hash = "sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98"},
+    {file = "tomli-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4"},
+    {file = "tomli-2.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7"},
+    {file = "tomli-2.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c"},
+    {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13"},
+    {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281"},
+    {file = "tomli-2.2.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272"},
+    {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140"},
+    {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2"},
+    {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744"},
+    {file = "tomli-2.2.1-cp313-cp313-win32.whl", hash = "sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec"},
+    {file = "tomli-2.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69"},
+    {file = "tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc"},
+    {file = "tomli-2.2.1.tar.gz", hash = "sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff"},
+]
+
+[[package]]
+name = "tox"
+version = "4.23.2"
+description = "tox is a generic virtualenv management and test command line tool"
+optional = false
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "tox-4.23.2-py3-none-any.whl", hash = "sha256:452bc32bb031f2282881a2118923176445bac783ab97c874b8770ab4c3b76c38"},
+    {file = "tox-4.23.2.tar.gz", hash = "sha256:86075e00e555df6e82e74cfc333917f91ecb47ffbc868dcafbd2672e332f4a2c"},
+]
+
+[package.dependencies]
+cachetools = ">=5.5"
+chardet = ">=5.2"
+colorama = ">=0.4.6"
+filelock = ">=3.16.1"
+packaging = ">=24.1"
+platformdirs = ">=4.3.6"
+pluggy = ">=1.5"
+pyproject-api = ">=1.8"
+tomli = {version = ">=2.0.1", markers = "python_version < \"3.11\""}
+typing-extensions = {version = ">=4.12.2", markers = "python_version < \"3.11\""}
+virtualenv = ">=20.26.6"
+
+[package.extras]
+test = ["devpi-process (>=1.0.2)", "pytest (>=8.3.3)", "pytest-mock (>=3.14)"]
+
+[[package]]
+name = "typing-extensions"
+version = "4.12.2"
+description = "Backported and Experimental Type Hints for Python 3.8+"
+optional = false
+python-versions = ">=3.8"
+groups = ["dev"]
+markers = "python_version < \"3.11\""
+files = [
+    {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
+    {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
+]
+
+[[package]]
+name = "virtualenv"
+version = "20.28.1"
+description = "Virtual Python Environment builder"
+optional = false
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "virtualenv-20.28.1-py3-none-any.whl", hash = "sha256:412773c85d4dab0409b83ec36f7a6499e72eaf08c80e81e9576bca61831c71cb"},
+    {file = "virtualenv-20.28.1.tar.gz", hash = "sha256:5d34ab240fdb5d21549b76f9e8ff3af28252f5499fb6d6f031adac4e5a8c5329"},
+]
+
+[package.dependencies]
+distlib = ">=0.3.7,<1"
+filelock = ">=3.12.2,<4"
+platformdirs = ">=3.9.1,<5"
+
+[package.extras]
+docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
+test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"]
+
+[[package]]
+name = "virtualenv-pyenv"
+version = "0.5.0"
+description = "A virtualenv Python discovery plugin for pyenv-installed interpreters"
+optional = false
+python-versions = ">=3.8"
+groups = ["dev"]
+files = [
+    {file = "virtualenv-pyenv-0.5.0.tar.gz", hash = "sha256:7b0e5fe3dfbdf484f4cf9b01e1f98111e398db6942237910f666356e6293597f"},
+    {file = "virtualenv_pyenv-0.5.0-py3-none-any.whl", hash = "sha256:21750247e36c55b3c547cfdeb08f51a3867fe7129922991a4f9c96980c0a4a5d"},
+]
+
+[package.dependencies]
+pyenv-inspect = ">=0.4,<0.5"
+virtualenv = "*"
 
 [metadata]
-lock-version = "1.1"
+lock-version = "2.1"
-python-versions = "^3.11"
+python-versions = ">=3.10"
-content-hash = "13366a58ff2f3fa0de2cb1e3de2f66fff612610fa66bb909201ebaa434cce014"
+content-hash = "6339967c3f6cad8e4db7047ef3d12a5b059a279d0f7c98515c961477680bab8f"
-
-[metadata.files]
-atomicwrites = []
-attrs = []
-black = [
-    {file = "black-22.6.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:f586c26118bc6e714ec58c09df0157fe2d9ee195c764f630eb0d8e7ccce72e69"},
-    {file = "black-22.6.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:b270a168d69edb8b7ed32c193ef10fd27844e5c60852039599f9184460ce0807"},
-    {file = "black-22.6.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:6797f58943fceb1c461fb572edbe828d811e719c24e03375fd25170ada53825e"},
-    {file = "black-22.6.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c85928b9d5f83b23cee7d0efcb310172412fbf7cb9d9ce963bd67fd141781def"},
-    {file = "black-22.6.0-cp310-cp310-win_amd64.whl", hash = "sha256:f6fe02afde060bbeef044af7996f335fbe90b039ccf3f5eb8f16df8b20f77666"},
-    {file = "black-22.6.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:cfaf3895a9634e882bf9d2363fed5af8888802d670f58b279b0bece00e9a872d"},
-    {file = "black-22.6.0-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:94783f636bca89f11eb5d50437e8e17fbc6a929a628d82304c80fa9cd945f256"},
-    {file = "black-22.6.0-cp36-cp36m-win_amd64.whl", hash = "sha256:2ea29072e954a4d55a2ff58971b83365eba5d3d357352a07a7a4df0d95f51c78"},
-    {file = "black-22.6.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e439798f819d49ba1c0bd9664427a05aab79bfba777a6db94fd4e56fae0cb849"},
-    {file = "black-22.6.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:187d96c5e713f441a5829e77120c269b6514418f4513a390b0499b0987f2ff1c"},
-    {file = "black-22.6.0-cp37-cp37m-win_amd64.whl", hash = "sha256:074458dc2f6e0d3dab7928d4417bb6957bb834434516f21514138437accdbe90"},
-    {file = "black-22.6.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:a218d7e5856f91d20f04e931b6f16d15356db1c846ee55f01bac297a705ca24f"},
-    {file = "black-22.6.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:568ac3c465b1c8b34b61cd7a4e349e93f91abf0f9371eda1cf87194663ab684e"},
-    {file = "black-22.6.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:6c1734ab264b8f7929cef8ae5f900b85d579e6cbfde09d7387da8f04771b51c6"},
-    {file = "black-22.6.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c9a3ac16efe9ec7d7381ddebcc022119794872abce99475345c5a61aa18c45ad"},
-    {file = "black-22.6.0-cp38-cp38-win_amd64.whl", hash = "sha256:b9fd45787ba8aa3f5e0a0a98920c1012c884622c6c920dbe98dbd05bc7c70fbf"},
-    {file = "black-22.6.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7ba9be198ecca5031cd78745780d65a3f75a34b2ff9be5837045dce55db83d1c"},
-    {file = "black-22.6.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:a3db5b6409b96d9bd543323b23ef32a1a2b06416d525d27e0f67e74f1446c8f2"},
-    {file = "black-22.6.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:560558527e52ce8afba936fcce93a7411ab40c7d5fe8c2463e279e843c0328ee"},
-    {file = "black-22.6.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b154e6bbde1e79ea3260c4b40c0b7b3109ffcdf7bc4ebf8859169a6af72cd70b"},
-    {file = "black-22.6.0-cp39-cp39-win_amd64.whl", hash = "sha256:4af5bc0e1f96be5ae9bd7aaec219c901a94d6caa2484c21983d043371c733fc4"},
-    {file = "black-22.6.0-py3-none-any.whl", hash = "sha256:ac609cf8ef5e7115ddd07d85d988d074ed00e10fbc3445aee393e70164a2219c"},
-    {file = "black-22.6.0.tar.gz", hash = "sha256:6c6d39e28aed379aec40da1c65434c77d75e65bb59a1e1c283de545fb4e7c6c9"},
-]
-click = [
-    {file = "click-8.1.3-py3-none-any.whl", hash = "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48"},
-    {file = "click-8.1.3.tar.gz", hash = "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e"},
-]
-colorama = [
-    {file = "colorama-0.4.5-py2.py3-none-any.whl", hash = "sha256:854bf444933e37f5824ae7bfc1e98d5bce2ebe4160d46b5edf346a89358e99da"},
-    {file = "colorama-0.4.5.tar.gz", hash = "sha256:e6c6b4334fc50988a639d9b98aa429a0b57da6e17b9a44f0451f930b6967b7a4"},
-]
-iniconfig = [
-    {file = "iniconfig-1.1.1-py2.py3-none-any.whl", hash = "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3"},
-    {file = "iniconfig-1.1.1.tar.gz", hash = "sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32"},
-]
-isort = [
-    {file = "isort-5.10.1-py3-none-any.whl", hash = "sha256:6f62d78e2f89b4500b080fe3a81690850cd254227f27f75c3a0c491a1f351ba7"},
-    {file = "isort-5.10.1.tar.gz", hash = "sha256:e8443a5e7a020e9d7f97f1d7d9cd17c88bcb3bc7e218bf9cf5095fe550be2951"},
-]
-mypy-extensions = [
-    {file = "mypy_extensions-0.4.3-py2.py3-none-any.whl", hash = "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d"},
-    {file = "mypy_extensions-0.4.3.tar.gz", hash = "sha256:2d82818f5bb3e369420cb3c4060a7970edba416647068eb4c5343488a6c604a8"},
-]
-packaging = [
-    {file = "packaging-21.3-py3-none-any.whl", hash = "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"},
-    {file = "packaging-21.3.tar.gz", hash = "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb"},
-]
-pathspec = [
-    {file = "pathspec-0.9.0-py2.py3-none-any.whl", hash = "sha256:7d15c4ddb0b5c802d161efc417ec1a2558ea2653c2e8ad9c19098201dc1c993a"},
-    {file = "pathspec-0.9.0.tar.gz", hash = "sha256:e564499435a2673d586f6b2130bb5b95f04a3ba06f81b8f895b651a3c76aabb1"},
-]
-platformdirs = [
-    {file = "platformdirs-2.5.2-py3-none-any.whl", hash = "sha256:027d8e83a2d7de06bbac4e5ef7e023c02b863d7ea5d079477e722bb41ab25788"},
-    {file = "platformdirs-2.5.2.tar.gz", hash = "sha256:58c8abb07dcb441e6ee4b11d8df0ac856038f944ab98b7be6b27b2a3c7feef19"},
-]
-pluggy = [
-    {file = "pluggy-1.0.0-py2.py3-none-any.whl", hash = "sha256:74134bbf457f031a36d68416e1509f34bd5ccc019f0bcc952c7b909d06b37bd3"},
-    {file = "pluggy-1.0.0.tar.gz", hash = "sha256:4224373bacce55f955a878bf9cfa763c1e360858e330072059e10bad68531159"},
-]
-py = [
-    {file = "py-1.11.0-py2.py3-none-any.whl", hash = "sha256:607c53218732647dff4acdfcd50cb62615cedf612e72d1724fb1a0cc6405b378"},
-    {file = "py-1.11.0.tar.gz", hash = "sha256:51c75c4126074b472f746a24399ad32f6053d1b34b68d2fa41e558e6f4a98719"},
-]
-pyparsing = [
-    {file = "pyparsing-3.0.9-py3-none-any.whl", hash = "sha256:5026bae9a10eeaefb61dab2f09052b9f4307d44aee4eda64b309723d8d206bbc"},
-    {file = "pyparsing-3.0.9.tar.gz", hash = "sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb"},
-]
-pytest = [
-    {file = "pytest-7.1.2-py3-none-any.whl", hash = "sha256:13d0e3ccfc2b6e26be000cb6568c832ba67ba32e719443bfe725814d3c42433c"},
-    {file = "pytest-7.1.2.tar.gz", hash = "sha256:a06a0425453864a270bc45e71f783330a7428defb4230fb5e6a731fde06ecd45"},
-]
-pytest-randomly = [
-    {file = "pytest-randomly-3.12.0.tar.gz", hash = "sha256:d60c2db71ac319aee0fc6c4110a7597d611a8b94a5590918bfa8583f00caccb2"},
-    {file = "pytest_randomly-3.12.0-py3-none-any.whl", hash = "sha256:f4f2e803daf5d1ba036cc22bf4fe9dbbf99389ec56b00e5cba732fb5c1d07fdd"},
-]
-pytest-repeat = []
-tomli = [
-    {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"},
-    {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"},
-]

pyproject.toml

@@ -1,26 +1,124 @@
-[tool.poetry]
+[project]
 name = "voicemeeter-api"
-version = "0.6.0"
+version = "2.7.2"
 description = "A Python wrapper for the Voiceemeter API"
-authors = ["onyx-and-iris <code@onyxandiris.online>"]
+authors = [{ name = "Onyx and Iris", email = "code@onyxandiris.online" }]
-license = "MIT"
+license = { text = "MIT" }
 readme = "README.md"
-repository = "https://github.com/onyx-and-iris/voicemeeter-api-python"
+requires-python = ">=3.10"
+dependencies = ["tomli (>=2.0.1,<3.0) ; python_version < '3.11'"]
 
-packages = [
+[tool.poetry]
-    { include = "voicemeeterlib" },
+packages = [{ include = "voicemeeterlib" }]
-]
 
-[tool.poetry.dependencies]
+[tool.poetry.requires-plugins]
-python = "^3.11"
+poethepoet = ">=0.42.0"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
-pytest = "^7.1.2"
+pytest = "^8.3.4"
-pytest-randomly = "^3.12.0"
+pytest-randomly = "^3.16.0"
-pytest-repeat = "^0.9.1"
+ruff = "^0.8.6"
-black = "^22.3.0"
+tox = "^4.23.2"
-isort = "^5.10.1"
+virtualenv-pyenv = "^0.5.0"
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.poe.tasks]
+dsl.script = "scripts:ex_dsl"
+callbacks.script = "scripts:ex_callbacks"
+gui.script = "scripts:ex_gui"
+levels.script = "scripts:ex_levels"
+midi.script = "scripts:ex_midi"
+obs.script = "scripts:ex_obs"
+observer.script = "scripts:ex_observer"
+eqedit.script = "scripts:ex_eqedit"
+test-basic.script = "scripts:test_basic"
+test-banana.script = "scripts:test_banana"
+test-potato.script = "scripts:test_potato"
+test-all.script = "scripts:test_all"
+generate-badges.script = "scripts:generate_badges"
+
+
+[tool.ruff]
+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 = 88
+indent-width = 4
+
+# Assume Python 3.10
+target-version = "py310"
+
+[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", "EM", "F", "B"]
+ignore = []
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = ["B"]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+
+[tool.ruff.format]
+# Unlike Black, use single quotes for strings.
+quote-style = "single"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402", "F401"]

scripts.py

@@ -0,0 +1,67 @@
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+
+def ex_dsl():
+    subprocess.run(['tox', 'r', '-e', 'dsl'])
+
+
+def ex_callbacks():
+    scriptpath = Path.cwd() / 'examples' / 'events' / 'callbacks' / '.'
+    subprocess.run([sys.executable, str(scriptpath)])
+
+
+def ex_gui():
+    scriptpath = Path.cwd() / 'examples' / 'gui' / '.'
+    subprocess.run([sys.executable, str(scriptpath)])
+
+
+def ex_levels():
+    scriptpath = Path.cwd() / 'examples' / 'levels' / '.'
+    subprocess.run([sys.executable, str(scriptpath)])
+
+
+def ex_midi():
+    scriptpath = Path.cwd() / 'examples' / 'midi' / '.'
+    subprocess.run([sys.executable, str(scriptpath)])
+
+
+def ex_obs():
+    subprocess.run(['tox', 'r', '-e', 'obs'])
+
+
+def ex_observer():
+    scriptpath = Path.cwd() / 'examples' / 'events' / 'observer' / '.'
+    subprocess.run([sys.executable, str(scriptpath)])
+
+
+def ex_eqedit():
+    scriptpath = Path.cwd() / 'examples' / 'eq_edit' / '.'
+    subprocess.run([sys.executable, str(scriptpath)])
+
+
+def test_basic():
+    subprocess.run(['tox'], env=os.environ.copy() | {'KIND': 'basic'})
+
+
+def test_banana():
+    subprocess.run(['tox'], env=os.environ.copy() | {'KIND': 'banana'})
+
+
+def test_potato():
+    subprocess.run(['tox'], env=os.environ.copy() | {'KIND': 'potato'})
+
+
+def test_all():
+    steps = [test_basic, test_banana, test_potato]
+    for step in steps:
+        step()
+
+
+def generate_badges():
+    for kind in ['basic', 'banana', 'potato']:
+        subprocess.run(
+            ['tox', 'r', '-e', 'genbadge'], env=os.environ.copy() | {'KIND': kind}
+        )

tests/__init__.py

@@ -1,50 +1,63 @@
+import os
 import random
 import sys
 from dataclasses import dataclass
 
 import voicemeeterlib
-from voicemeeterlib.kinds import KindId, kinds_all
+from voicemeeterlib.kinds import KindId
 from voicemeeterlib.kinds import request_kind_map as kindmap
 
-# let's keep things random
-kind_id = random.choice(tuple(kind_id.name.lower() for kind_id in KindId))
-
-vmrs = {kind.name: voicemeeterlib.api(kind.name) for kind in kinds_all}
-tests = vmrs[kind_id]
-kind = kindmap(kind_id)
-
 
 @dataclass
 class Data:
     """bounds data to map tests to a kind"""
 
-    name: str = kind.name
+    name: str
-    phys_in: int = kind.ins[0] - 1
+    phys_in: int
-    virt_in: int = kind.ins[0] + kind.ins[-1] - 1
+    virt_in: int
-    phys_out: int = kind.outs[0] - 1
+    phys_out: int
-    virt_out: int = kind.outs[0] + kind.outs[-1] - 1
+    virt_out: int
-    vban_in: int = kind.vban[0] - 1
+    vban_in: int
-    vban_out: int = kind.vban[-1] - 1
+    vban_out: int
-    button_lower: int = 0
+    button_lower: int
-    button_upper: int = 79
+    button_upper: int
-    asio_in: int = kind.asio[0] - 1
+    asio_in: int
-    asio_out: int = kind.asio[-1] - 1
+    asio_out: int
-    insert_lower: int = 0
+    insert_lower: int
-    insert_higher: int = kind.insert - 1
+    insert_higher: int
 
     @property
     def channels(self):
         return (2 * self.phys_in) + (8 * self.virt_in)
 
 
-data = Data()
+# get KIND from environment, if not set default to potato
+KIND_ID = os.environ.get('KIND', 'potato')
+vm = voicemeeterlib.api(KIND_ID)
+kind = kindmap(KIND_ID)
+
+data = Data(
+    name=kind.name,
+    phys_in=kind.ins[0] - 1,
+    virt_in=kind.ins[0] + kind.ins[-1] - 1,
+    phys_out=kind.outs[0] - 1,
+    virt_out=kind.outs[0] + kind.outs[-1] - 1,
+    vban_in=kind.vban[0] - 1,
+    vban_out=kind.vban[-1] - 1,
+    button_lower=0,
+    button_upper=79,
+    asio_in=kind.asio[0] - 1,
+    asio_out=kind.asio[-1] - 1,
+    insert_lower=0,
+    insert_higher=kind.insert - 1,
+)
 
 
 def setup_module():
-    print(f"\nRunning tests for kind [{data.name}]\n", file=sys.stdout)
+    print(f'\nRunning tests for kind [{data.name}]\n', file=sys.stdout)
-    tests.login()
+    vm.login()
-    tests.command.reset()
+    vm.command.reset()
 
 
 def teardown_module():
-    tests.logout()
+    vm.logout()

tests/conftest.py

@@ -1,7 +1,7 @@
 def pytest_addoption(parser):
     parser.addoption(
-        "--run-slow",
+        '--run-slow',
-        action="store_true",
+        action='store_true',
         default=False,
-        help="Run slow tests",
+        help='Run slow tests',
     )

tests/pre-commit.ps1

@@ -1,31 +0,0 @@
-Function RunTests {
-    $coverage = "./tests/pytest_coverage.log"
-    $run_tests = "pytest --run-slow -v --capture=tee-sys --junitxml=./tests/.coverage.xml"
-    $match_pattern = "^=|^\s*$|^Running|^Using|^plugins|^collecting|^tests"
-
-    if ( Test-Path $coverage ) { Clear-Content $coverage }
-
-    ForEach ($line in $(Invoke-Expression $run_tests)) {
-        If ( $line -Match $match_pattern ) {
-            if ( $line -Match "^Running tests for kind \[(\w+)\]" ) { $kind = $Matches[1] }
-            $line | Tee-Object -FilePath $coverage -Append
-        }
-    }
-    Write-Output "$(Get-TimeStamp)" | Out-File $coverage -Append
-
-    Invoke-Expression "genbadge tests -t 90 -i ./tests/.coverage.xml -o ./tests/$kind.svg"
-}
-
-Function Get-TimeStamp {
-
-    return "[{0:MM/dd/yy} {0:HH:mm:ss}]" -f (Get-Date)
-
-}
-
-if ($MyInvocation.InvocationName -ne ".") {
-    Invoke-Expression ".\.venv\Scripts\Activate.ps1"
-
-    RunTests
-
-    Invoke-Expression "deactivate"
-}

tests/reports/badge-banana.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="68" height="20" role="img" aria-label="tests: 140"><title>tests: 140</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="68" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="31" height="20" fill="#4c1"/><rect width="68" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="515" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">140</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">140</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="68" height="20" role="img" aria-label="tests: 158"><title>tests: 158</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="68" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="31" height="20" fill="#4c1"/><rect width="68" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="515" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">158</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">158</text></g></svg>

tests/reports/badge-basic.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="68" height="20" role="img" aria-label="tests: 114"><title>tests: 114</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="68" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="31" height="20" fill="#4c1"/><rect width="68" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="515" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">114</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">114</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="68" height="20" role="img" aria-label="tests: 115"><title>tests: 115</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="68" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="31" height="20" fill="#4c1"/><rect width="68" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="515" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">115</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">115</text></g></svg>

tests/reports/badge-potato.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="68" height="20" role="img" aria-label="tests: 156"><title>tests: 156</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="68" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="31" height="20" fill="#4c1"/><rect width="68" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="515" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">156</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">156</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="68" height="20" role="img" aria-label="tests: 183"><title>tests: 183</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="68" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="37" height="20" fill="#555"/><rect x="37" width="31" height="20" fill="#4c1"/><rect width="68" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">tests</text><text x="195" y="140" transform="scale(.1)" fill="#fff" textLength="270">tests</text><text aria-hidden="true" x="515" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="210">183</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">183</text></g></svg>

tests/test_configs.py

@@ -1,36 +1,48 @@
-import time
-
 import pytest
 
-from tests import data, tests
+from tests import data, vm
 
 
 class TestUserConfigs:
     __test__ = True
 
-    """example config tests"""
+    """example config vm"""
 
     @classmethod
     def setup_class(cls):
-        tests.apply_config("example")
+        vm.apply_config('example')
 
-    def test_it_tests_config_string(self):
+    def test_it_tests_vm_config_string(self):
-        assert "PhysStrip" in tests.strip[data.phys_in].label
+        assert 'PhysStrip' in vm.strip[data.phys_in].label
-        assert "VirtStrip" in tests.strip[data.virt_in].label
+        assert 'VirtStrip' in vm.strip[data.virt_in].label
-        assert "PhysBus" in tests.bus[data.phys_out].label
+        assert 'PhysBus' in vm.bus[data.phys_out].label
-        assert "VirtBus" in tests.bus[data.virt_out].label
+        assert 'VirtBus' in vm.bus[data.virt_out].label
 
-    def test_it_tests_config_bool(self):
+    def test_it_tests_vm_config_bool(self):
-        assert tests.strip[0].A1 == True
+        assert vm.strip[0].A1 == True
+
+    @pytest.mark.skipif(
+        data.name != 'potato',
+        reason='Skip test if kind is not potato',
+    )
+    def test_it_tests_vm_config_bool_strip_eq_on(self):
+        assert vm.strip[data.phys_in].eq.on == True
+
+    @pytest.mark.skipif(
+        data.name != 'banana',
+        reason='Skip test if kind is not banana',
+    )
+    def test_it_tests_vm_config_bool_bus_eq_ab(self):
+        assert vm.bus[data.phys_out].eq.ab == True
 
     @pytest.mark.skipif(
         "not config.getoption('--run-slow')",
-        reason="Only run when --run-slow is given",
+        reason='Only run when --run-slow is given',
     )
-    def test_it_tests_config_busmode(self):
+    def test_it_tests_vm_config_busmode(self):
-        assert tests.bus[data.phys_out].mode.get() == "composite"
+        assert vm.bus[data.phys_out].mode.get() == 'composite'
 
-    def test_it_tests_config_bass_med_high(self):
+    def test_it_tests_vm_config_bass_med_high(self):
-        assert tests.strip[data.virt_in].bass == -3.2
+        assert vm.strip[data.virt_in].bass == -3.2
-        assert tests.strip[data.virt_in].mid == 1.5
+        assert vm.strip[data.virt_in].mid == 1.5
-        assert tests.strip[data.virt_in].high == 2.1
+        assert vm.strip[data.virt_in].high == 2.1

tests/test_errors.py

@@ -0,0 +1,49 @@
+import re
+
+import pytest
+
+import voicemeeterlib
+from tests import vm
+
+
+class TestErrors:
+    __test__ = True
+
+    def test_it_tests_an_unknown_kind(self):
+        with pytest.raises(
+            voicemeeterlib.error.VMError,
+            match="Unknown Voicemeeter kind 'unknown_kind'",
+        ):
+            voicemeeterlib.api('unknown_kind')
+
+    def test_it_tests_an_unknown_parameter(self):
+        with pytest.raises(
+            voicemeeterlib.error.CAPIError,
+            match='VBVMR_SetParameterFloat returned -3',
+        ) as exc_info:
+            vm.set('unknown.parameter', 1)
+
+        e = exc_info.value
+        assert e.code == -3
+        assert e.fn_name == 'VBVMR_SetParameterFloat'
+
+    def test_it_tests_an_unknown_config_name(self):
+        EXPECTED_MSG = (
+            "No config with name 'unknown' is loaded into memory",
+            f'Known configs: {list(vm.configs.keys())}',
+        )
+
+        with pytest.raises(
+            voicemeeterlib.error.VMError, match=re.escape('\n'.join(EXPECTED_MSG))
+        ):
+            vm.apply_config('unknown')
+
+    def test_it_tests_an_invalid_config_key(self):
+        CONFIG = {
+            'strip-0': {'A1': True, 'B1': True, 'gain': -6.0},
+            'bus-0': {'mute': True, 'eq': {'on': True}},
+            'unknown-0': {'state': True},
+            'vban-out-1': {'name': 'streamname'},
+        }
+        with pytest.raises(ValueError, match="invalid config key 'unknown-0'"):
+            vm.apply(CONFIG)

tests/test_factory.py

@@ -1,66 +1,66 @@
 import pytest
 
-from tests import data, tests
+from tests import data, vm
 
 
 class TestRemoteFactories:
     __test__ = True
 
     @pytest.mark.skipif(
-        data.name != "basic",
+        data.name != 'basic',
-        reason="Skip test if kind is not basic",
+        reason='Skip test if kind is not basic',
     )
-    def test_it_tests_remote_attrs_for_basic(self):
+    def test_it_tests_vm_remote_attrs_for_basic(self):
-        assert hasattr(tests, "strip")
+        assert hasattr(vm, 'strip')
-        assert hasattr(tests, "bus")
+        assert hasattr(vm, 'bus')
-        assert hasattr(tests, "command")
+        assert hasattr(vm, 'command')
-        assert hasattr(tests, "button")
+        assert hasattr(vm, 'button')
-        assert hasattr(tests, "vban")
+        assert hasattr(vm, 'vban')
-        assert hasattr(tests, "device")
+        assert hasattr(vm, 'device')
-        assert hasattr(tests, "option")
+        assert hasattr(vm, 'option')
 
-        assert len(tests.strip) == 3
+        assert len(vm.strip) == 3
-        assert len(tests.bus) == 2
+        assert len(vm.bus) == 2
-        assert len(tests.button) == 80
+        assert len(vm.button) == 80
-        assert len(tests.vban.instream) == 4 and len(tests.vban.outstream) == 4
+        assert len(vm.vban.instream) == 6 and len(vm.vban.outstream) == 5
 
     @pytest.mark.skipif(
-        data.name != "banana",
+        data.name != 'banana',
-        reason="Skip test if kind is not banana",
+        reason='Skip test if kind is not banana',
     )
-    def test_it_tests_remote_attrs_for_banana(self):
+    def test_it_tests_vm_remote_attrs_for_banana(self):
-        assert hasattr(tests, "strip")
+        assert hasattr(vm, 'strip')
-        assert hasattr(tests, "bus")
+        assert hasattr(vm, 'bus')
-        assert hasattr(tests, "command")
+        assert hasattr(vm, 'command')
-        assert hasattr(tests, "button")
+        assert hasattr(vm, 'button')
-        assert hasattr(tests, "vban")
+        assert hasattr(vm, 'vban')
-        assert hasattr(tests, "device")
+        assert hasattr(vm, 'device')
-        assert hasattr(tests, "option")
+        assert hasattr(vm, 'option')
-        assert hasattr(tests, "recorder")
+        assert hasattr(vm, 'recorder')
-        assert hasattr(tests, "patch")
+        assert hasattr(vm, 'patch')
 
-        assert len(tests.strip) == 5
+        assert len(vm.strip) == 5
-        assert len(tests.bus) == 5
+        assert len(vm.bus) == 5
-        assert len(tests.button) == 80
+        assert len(vm.button) == 80
-        assert len(tests.vban.instream) == 8 and len(tests.vban.outstream) == 8
+        assert len(vm.vban.instream) == 10 and len(vm.vban.outstream) == 9
 
     @pytest.mark.skipif(
-        data.name != "potato",
+        data.name != 'potato',
-        reason="Skip test if kind is not potato",
+        reason='Skip test if kind is not potato',
     )
-    def test_it_tests_remote_attrs_for_potato(self):
+    def test_it_tests_vm_remote_attrs_for_potato(self):
-        assert hasattr(tests, "strip")
+        assert hasattr(vm, 'strip')
-        assert hasattr(tests, "bus")
+        assert hasattr(vm, 'bus')
-        assert hasattr(tests, "command")
+        assert hasattr(vm, 'command')
-        assert hasattr(tests, "button")
+        assert hasattr(vm, 'button')
-        assert hasattr(tests, "vban")
+        assert hasattr(vm, 'vban')
-        assert hasattr(tests, "device")
+        assert hasattr(vm, 'device')
-        assert hasattr(tests, "option")
+        assert hasattr(vm, 'option')
-        assert hasattr(tests, "recorder")
+        assert hasattr(vm, 'recorder')
-        assert hasattr(tests, "patch")
+        assert hasattr(vm, 'patch')
-        assert hasattr(tests, "fx")
+        assert hasattr(vm, 'fx')
 
-        assert len(tests.strip) == 8
+        assert len(vm.strip) == 8
-        assert len(tests.bus) == 8
+        assert len(vm.bus) == 8
-        assert len(tests.button) == 80
+        assert len(vm.button) == 80
-        assert len(tests.vban.instream) == 8 and len(tests.vban.outstream) == 8
+        assert len(vm.vban.instream) == 10 and len(vm.vban.outstream) == 9

tests/test_higher.py

@@ -1,195 +1,275 @@
 import pytest
 
-from tests import data, tests
+from tests import data, vm
 
 
-@pytest.mark.parametrize("value", [False, True])
+@pytest.mark.parametrize('value', [False, True])
 class TestSetAndGetBoolHigher:
     __test__ = True
 
     """strip tests, physical and virtual"""
 
     @pytest.mark.parametrize(
-        "index,param",
+        'index,param',
         [
-            (data.phys_in, "mute"),
+            (data.phys_in, 'mute'),
-            (data.phys_in, "mono"),
+            (data.phys_in, 'mono'),
-            (data.virt_in, "mc"),
+            (data.virt_in, 'mc'),
-            (data.virt_in, "mono"),
         ],
     )
     def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
-        setattr(tests.strip[index], param, value)
+        setattr(vm.strip[index], param, value)
-        assert getattr(tests.strip[index], param) == value
+        assert getattr(vm.strip[index], param) == value
+
+    """ strip EQ tests, physical """
+
+    @pytest.mark.skipif(
+        data.name != 'potato',
+        reason='Skip test if kind is not potato',
+    )
+    @pytest.mark.parametrize(
+        'index,param',
+        [
+            (data.phys_in, 'on'),
+            (data.phys_in, 'ab'),
+        ],
+    )
+    def test_it_sets_and_gets_strip_eq_bool_params(self, index, param, value):
+        assert hasattr(vm.strip[index].eq, param)
+        setattr(vm.strip[index].eq, param, value)
+        assert getattr(vm.strip[index].eq, param) == value
 
     """ bus tests, physical and virtual """
 
     @pytest.mark.parametrize(
-        "index,param",
+        'index,param',
         [
-            (data.phys_out, "eq"),
+            (data.phys_out, 'mute'),
-            (data.phys_out, "mute"),
+            (data.virt_out, 'sel'),
-            (data.virt_out, "eq_ab"),
-            (data.virt_out, "sel"),
         ],
     )
     def test_it_sets_and_gets_bus_bool_params(self, index, param, value):
-        setattr(tests.bus[index], param, value)
+        assert hasattr(vm.bus[index], param)
-        assert getattr(tests.bus[index], param) == value
+        setattr(vm.bus[index], param, value)
+        assert getattr(vm.bus[index], param) == value
+
+    """ bus EQ tests, physical and virtual """
+
+    @pytest.mark.parametrize(
+        'index,param',
+        [
+            (data.phys_out, 'on'),
+            (data.virt_out, 'ab'),
+        ],
+    )
+    def test_it_sets_and_gets_bus_eq_bool_params(self, index, param, value):
+        assert hasattr(vm.bus[index].eq, param)
+        setattr(vm.bus[index].eq, param, value)
+        assert getattr(vm.bus[index].eq, param) == value
 
     """  bus modes tests, physical and virtual """
 
     @pytest.mark.skipif(
-        data.name != "basic",
+        data.name != 'basic',
-        reason="Skip test if kind is not basic",
+        reason='Skip test if kind is not basic',
     )
     @pytest.mark.parametrize(
-        "index,param",
+        'index,param',
         [
-            (data.phys_out, "normal"),
+            (data.phys_out, 'normal'),
-            (data.phys_out, "amix"),
+            (data.phys_out, 'amix'),
-            (data.virt_out, "normal"),
+            (data.virt_out, 'normal'),
-            (data.virt_out, "composite"),
+            (data.virt_out, 'composite'),
         ],
     )
     def test_it_sets_and_gets_busmode_basic_bool_params(self, index, param, value):
-        setattr(tests.bus[index].mode, param, value)
+        setattr(vm.bus[index].mode, param, value)
-        assert getattr(tests.bus[index].mode, param) == value
+        assert getattr(vm.bus[index].mode, param) == value
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "index,param",
+        'index,param',
         [
-            (data.phys_out, "normal"),
+            (data.phys_out, 'normal'),
-            (data.phys_out, "amix"),
+            (data.phys_out, 'amix'),
-            (data.phys_out, "rearonly"),
+            (data.phys_out, 'rearonly'),
-            (data.virt_out, "normal"),
+            (data.virt_out, 'normal'),
-            (data.virt_out, "upmix41"),
+            (data.virt_out, 'upmix41'),
-            (data.virt_out, "composite"),
+            (data.virt_out, 'composite'),
         ],
     )
     def test_it_sets_and_gets_busmode_bool_params(self, index, param, value):
-        setattr(tests.bus[index].mode, param, value)
+        setattr(vm.bus[index].mode, param, value)
-        assert getattr(tests.bus[index].mode, param) == value
+        assert getattr(vm.bus[index].mode, param) == value
 
     """ macrobutton tests """
 
     @pytest.mark.parametrize(
-        "index,param",
+        'index,param',
-        [(data.button_lower, "state"), (data.button_upper, "trigger")],
+        [(data.button_lower, 'state'), (data.button_upper, 'trigger')],
     )
     def test_it_sets_and_gets_macrobutton_bool_params(self, index, param, value):
-        setattr(tests.button[index], param, value)
+        setattr(vm.button[index], param, value)
-        assert getattr(tests.button[index], param) == value
+        assert getattr(vm.button[index], param) == value
 
     """ vban instream tests """
 
     @pytest.mark.parametrize(
-        "index,param",
+        'index,param',
-        [(data.vban_in, "on")],
+        [(data.vban_in, 'on')],
     )
     def test_it_sets_and_gets_vban_instream_bool_params(self, index, param, value):
-        setattr(tests.vban.instream[index], param, value)
+        setattr(vm.vban.instream[index], param, value)
-        assert getattr(tests.vban.instream[index], param) == value
+        assert getattr(vm.vban.instream[index], param) == value
 
     """ vban outstream tests """
 
     @pytest.mark.parametrize(
-        "index,param",
+        'index,param',
-        [(data.vban_out, "on")],
+        [(data.vban_out, 'on')],
     )
     def test_it_sets_and_gets_vban_outstream_bool_params(self, index, param, value):
-        setattr(tests.vban.outstream[index], param, value)
+        setattr(vm.vban.outstream[index], param, value)
-        assert getattr(tests.vban.outstream[index], param) == value
+        assert getattr(vm.vban.outstream[index], param) == value
 
     """ command tests """
 
     @pytest.mark.parametrize(
-        "param",
+        'param',
-        [("lock")],
+        [('lock')],
     )
     def test_it_sets_command_bool_params(self, param, value):
-        setattr(tests.command, param, value)
+        setattr(vm.command, param, value)
 
     """ recorder tests """
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "param",
+        'param',
-        [("A1"), ("B2")],
+        [('A1'), ('B2')],
     )
     def test_it_sets_and_gets_recorder_bool_params(self, param, value):
-        setattr(tests.recorder, param, value)
+        assert hasattr(vm.recorder, param)
-        assert getattr(tests.recorder, param) == value
+        setattr(vm.recorder, param, value)
+        assert getattr(vm.recorder, param) == value
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "param",
+        'param',
-        [("loop")],
+        [('loop')],
     )
     def test_it_sets_recorder_bool_params(self, param, value):
-        setattr(tests.recorder, param, value)
+        assert hasattr(vm.recorder, param)
+        setattr(vm.recorder, param, value)
+        assert getattr(vm.recorder, param) == value
+
+    """ recoder.mode tests """
+
+    @pytest.mark.skipif(
+        data.name == 'basic',
+        reason='Skip test if kind is basic',
+    )
+    @pytest.mark.parametrize(
+        'param',
+        [('loop'), ('recbus')],
+    )
+    def test_it_sets_recorder_mode_bool_params(self, param, value):
+        assert hasattr(vm.recorder.mode, param)
+        setattr(vm.recorder.mode, param, value)
+        assert getattr(vm.recorder.mode, param) == value
+
+    """ recorder.armstrip """
+
+    @pytest.mark.skipif(
+        data.name == 'basic',
+        reason='Skip test if kind is basic',
+    )
+    @pytest.mark.parametrize(
+        'index',
+        [
+            (data.phys_out),
+            (data.virt_out),
+        ],
+    )
+    def test_it_sets_recorder_armstrip_bool_params(self, index, value):
+        vm.recorder.armstrip[index].set(value)
+
+    """ recorder.armbus """
+
+    @pytest.mark.skipif(
+        data.name == 'basic',
+        reason='Skip test if kind is basic',
+    )
+    @pytest.mark.parametrize(
+        'index',
+        [
+            (data.phys_out),
+            (data.virt_out),
+        ],
+    )
+    def test_it_sets_recorder_armbus_bool_params(self, index, value):
+        vm.recorder.armbus[index].set(True)
 
     """ fx tests """
 
     @pytest.mark.skipif(
-        data.name != "potato",
+        data.name != 'potato',
-        reason="Skip test if kind is not potato",
+        reason='Skip test if kind is not potato',
     )
     @pytest.mark.parametrize(
-        "param",
+        'param',
-        [("reverb"), ("reverb_ab"), ("delay"), ("delay_ab")],
+        [('reverb'), ('reverb_ab'), ('delay'), ('delay_ab')],
     )
     def test_it_sets_and_gets_fx_bool_params(self, param, value):
-        setattr(tests.fx, param, value)
+        setattr(vm.fx, param, value)
-        assert getattr(tests.fx, param) == value
+        assert getattr(vm.fx, param) == value
 
     """ patch tests """
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "param",
+        'param',
-        [("postfadercomposite")],
+        [('postfadercomposite')],
     )
     def test_it_sets_and_gets_patch_bool_params(self, param, value):
-        setattr(tests.patch, param, value)
+        setattr(vm.patch, param, value)
-        assert getattr(tests.patch, param) == value
+        assert getattr(vm.patch, param) == value
 
     """ patch.insert tests """
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "index, param",
+        'index, param',
-        [(data.insert_lower, "on"), (data.insert_higher, "on")],
+        [(data.insert_lower, 'on'), (data.insert_higher, 'on')],
     )
     def test_it_sets_and_gets_patch_insert_bool_params(self, index, param, value):
-        setattr(tests.patch.insert[index], param, value)
+        setattr(vm.patch.insert[index], param, value)
-        assert getattr(tests.patch.insert[index], param) == value
+        assert getattr(vm.patch.insert[index], param) == value
 
     """ option tests """
 
     @pytest.mark.parametrize(
-        "param",
+        'param',
-        [("monitoronsel")],
+        [('monitoronsel')],
     )
     def test_it_sets_and_gets_option_bool_params(self, param, value):
-        setattr(tests.option, param, value)
+        setattr(vm.option, param, value)
-        assert getattr(tests.option, param) == value
+        assert getattr(vm.option, param) == value
 
 
 class TestSetAndGetIntHigher:
@@ -198,72 +278,85 @@ class TestSetAndGetIntHigher:
     """strip tests, physical and virtual"""
 
     @pytest.mark.parametrize(
-        "index,param,value",
+        'index,param,value',
         [
-            (data.phys_in, "limit", -40),
+            (data.phys_in, 'limit', -40),
-            (data.phys_in, "limit", 12),
+            (data.phys_in, 'limit', 12),
-            (data.virt_in, "k", 0),
+            (data.virt_in - 1, 'k', 0),
-            (data.virt_in, "k", 4),
+            (data.virt_in - 1, 'k', 4),
         ],
     )
-    def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
+    def test_it_sets_and_gets_strip_int_params(self, index, param, value):
-        setattr(tests.strip[index], param, value)
+        setattr(vm.strip[index], param, value)
-        assert getattr(tests.strip[index], param) == value
+        assert getattr(vm.strip[index], param) == value
+
+    """ bus tests, physical """
+
+    @pytest.mark.parametrize(
+        'index,param,value',
+        [
+            (data.phys_out, 'mono', 0),
+            (data.phys_out, 'mono', 2),
+        ],
+    )
+    def test_it_sets_and_gets_bus_int_params(self, index, param, value):
+        setattr(vm.bus[index], param, value)
+        assert getattr(vm.bus[index], param) == value
 
     """ vban outstream tests """
 
     @pytest.mark.parametrize(
-        "index,param,value",
+        'index,param,value',
-        [(data.vban_out, "sr", 48000)],
+        [(data.vban_out, 'sr', 48000)],
     )
-    def test_it_sets_and_gets_vban_outstream_bool_params(self, index, param, value):
+    def test_it_sets_and_gets_vban_outstream_int_params(self, index, param, value):
-        setattr(tests.vban.outstream[index], param, value)
+        setattr(vm.vban.outstream[index], param, value)
-        assert getattr(tests.vban.outstream[index], param) == value
+        assert getattr(vm.vban.outstream[index], param) == value
 
     """ patch.asio tests """
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "index,value",
+        'index,value',
         [
             (0, 1),
             (data.asio_in, 4),
         ],
     )
     def test_it_sets_and_gets_patch_asio_in_int_params(self, index, value):
-        tests.patch.asio[index].set(value)
+        vm.patch.asio[index].set(value)
-        assert tests.patch.asio[index].get() == value
+        assert vm.patch.asio[index].get() == value
 
     """ patch.A2[i]-A5[i] tests """
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "index,value",
+        'index,value',
         [
             (0, 1),
             (data.asio_out, 4),
         ],
     )
     def test_it_sets_and_gets_patch_asio_out_int_params(self, index, value):
-        tests.patch.A2[index].set(value)
+        vm.patch.A2[index].set(value)
-        assert tests.patch.A2[index].get() == value
+        assert vm.patch.A2[index].get() == value
-        tests.patch.A5[index].set(value)
+        vm.patch.A5[index].set(value)
-        assert tests.patch.A5[index].get() == value
+        assert vm.patch.A5[index].get() == value
 
     """ patch.composite tests """
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "index,value",
+        'index,value',
         [
             (0, 3),
             (0, data.channels),
@@ -272,25 +365,45 @@ class TestSetAndGetIntHigher:
         ],
     )
     def test_it_sets_and_gets_patch_composite_int_params(self, index, value):
-        tests.patch.composite[index].set(value)
+        vm.patch.composite[index].set(value)
-        assert tests.patch.composite[index].get() == value
+        assert vm.patch.composite[index].get() == value
 
     """ option tests """
 
     @pytest.mark.skipif(
-        data.name == "basic",
+        data.name == 'basic',
-        reason="Skip test if kind is basic",
+        reason='Skip test if kind is basic',
     )
     @pytest.mark.parametrize(
-        "index,value",
+        'index,value',
         [
             (data.phys_out, 30),
             (data.phys_out, 500),
         ],
     )
     def test_it_sets_and_gets_patch_delay_int_params(self, index, value):
-        tests.option.delay[index].set(value)
+        vm.option.delay[index].set(value)
-        assert tests.option.delay[index].get() == value
+        assert vm.option.delay[index].get() == value
+
+    """ recorder tests """
+
+    @pytest.mark.skipif(
+        data.name == 'basic',
+        reason='Skip test if kind is basic',
+    )
+    @pytest.mark.parametrize(
+        'param,value',
+        [
+            ('samplerate', 32000),
+            ('samplerate', 96000),
+            ('bitresolution', 16),
+            ('bitresolution', 32),
+        ],
+    )
+    def test_it_sets_and_gets_recorder_int_params(self, param, value):
+        assert hasattr(vm.recorder, param)
+        setattr(vm.recorder, param, value)
+        assert getattr(vm.recorder, param) == value
 
 
 class TestSetAndGetFloatHigher:
@@ -299,40 +412,36 @@ class TestSetAndGetFloatHigher:
     """strip tests, physical and virtual"""
 
     @pytest.mark.parametrize(
-        "index,param,value",
+        'index,param,value',
         [
-            (data.phys_in, "gain", -3.6),
+            (data.phys_in, 'gain', -3.6),
-            (data.virt_in, "gain", 5.8),
+            (data.virt_in, 'gain', 5.8),
-            (data.phys_in, "comp", 0.0),
-            (data.virt_in, "comp", 8.2),
-            (data.phys_in, "gate", 2.3),
-            (data.virt_in, "gate", 6.7),
         ],
     )
     def test_it_sets_and_gets_strip_float_params(self, index, param, value):
-        setattr(tests.strip[index], param, value)
+        setattr(vm.strip[index], param, value)
-        assert getattr(tests.strip[index], param) == value
+        assert getattr(vm.strip[index], param) == value
 
     @pytest.mark.parametrize(
-        "index,value",
+        'index,value',
         [(data.phys_in, 2), (data.phys_in, 2), (data.virt_in, 8), (data.virt_in, 8)],
     )
     def test_it_gets_prefader_levels_and_compares_length_of_array(self, index, value):
-        assert len(tests.strip[index].levels.prefader) == value
+        assert len(vm.strip[index].levels.prefader) == value
 
     @pytest.mark.parametrize(
-        "index,value",
+        'index,value',
         [(data.phys_in, 2), (data.phys_in, 2), (data.virt_in, 8), (data.virt_in, 8)],
     )
     def test_it_gets_postmute_levels_and_compares_length_of_array(self, index, value):
-        assert len(tests.strip[index].levels.postmute) == value
+        assert len(vm.strip[index].levels.postmute) == value
 
     @pytest.mark.skipif(
-        data.name != "potato",
+        data.name != 'potato',
-        reason="Only test if logged into Potato version",
+        reason='Only test if logged into Potato version',
     )
     @pytest.mark.parametrize(
-        "index, j, value",
+        'index, j, value',
         [
             (data.phys_in, 0, -20.7),
             (data.virt_in, 3, -60),
@@ -341,148 +450,196 @@ class TestSetAndGetFloatHigher:
         ],
     )
     def test_it_sets_and_gets_strip_gainlayer_values(self, index, j, value):
-        tests.strip[index].gainlayer[j].gain = value
+        vm.strip[index].gainlayer[j].gain = value
-        assert tests.strip[index].gainlayer[j].gain == value
+        assert vm.strip[index].gainlayer[j].gain == value
 
     """ strip tests, physical """
 
     @pytest.mark.parametrize(
-        "index, param, value",
+        'index, param, value',
         [
-            (data.phys_in, "pan_x", -0.6),
+            (data.phys_in, 'pan_x', -0.6),
-            (data.phys_in, "pan_x", 0.6),
+            (data.phys_in, 'pan_x', 0.6),
-            (data.phys_in, "color_y", 0.8),
+            (data.phys_in, 'color_y', 0.8),
-            (data.phys_in, "fx_x", -0.6),
+            (data.phys_in, 'fx_x', -0.6),
         ],
     )
     def test_it_sets_and_gets_strip_xy_params(self, index, param, value):
-        assert hasattr(tests.strip[index], param)
+        assert hasattr(vm.strip[index], param)
-        setattr(tests.strip[index], param, value)
+        setattr(vm.strip[index], param, value)
-        assert getattr(tests.strip[index], param) == value
+        assert getattr(vm.strip[index], param) == value
 
     @pytest.mark.skipif(
-        data.name != "potato",
+        data.name != 'potato',
-        reason="Only test if logged into Potato version",
+        reason='Only test if logged into Potato version',
     )
     @pytest.mark.parametrize(
-        "index, param, value",
+        'index, param, value',
         [
-            (data.phys_in, "reverb", -1.6),
+            (data.phys_in, 'reverb', -1.6),
-            (data.phys_in, "postfx1", True),
+            (data.phys_in, 'postfx1', True),
         ],
     )
     def test_it_sets_and_gets_strip_effects_params(self, index, param, value):
-        assert hasattr(tests.strip[index], param)
+        assert hasattr(vm.strip[index], param)
-        setattr(tests.strip[index], param, value)
+        setattr(vm.strip[index], param, value)
-        assert getattr(tests.strip[index], param) == value
+        assert getattr(vm.strip[index], param) == value
+
+    @pytest.mark.skipif(
+        data.name != 'potato',
+        reason='Only test if logged into Potato version',
+    )
+    @pytest.mark.parametrize(
+        'index, param, value',
+        [
+            (data.phys_in, 'gainin', -8.6),
+            (data.phys_in, 'knee', 0.5),
+        ],
+    )
+    def test_it_sets_and_gets_strip_comp_params(self, index, param, value):
+        assert hasattr(vm.strip[index].comp, param)
+        setattr(vm.strip[index].comp, param, value)
+        assert getattr(vm.strip[index].comp, param) == value
+
+    @pytest.mark.skipif(
+        data.name != 'potato',
+        reason='Only test if logged into Potato version',
+    )
+    @pytest.mark.parametrize(
+        'index, param, value',
+        [
+            (data.phys_in, 'bpsidechain', 120),
+            (data.phys_in, 'hold', 3000),
+        ],
+    )
+    def test_it_sets_and_gets_strip_gate_params(self, index, param, value):
+        assert hasattr(vm.strip[index].gate, param)
+        setattr(vm.strip[index].gate, param, value)
+        assert getattr(vm.strip[index].gate, param) == value
+
+    @pytest.mark.skipif(
+        data.name != 'potato',
+        reason='Only test if logged into Potato version',
+    )
+    @pytest.mark.parametrize(
+        'index, param, value',
+        [
+            (data.phys_in, 'knob', -8.6),
+        ],
+    )
+    def test_it_sets_and_gets_strip_denoiser_params(self, index, param, value):
+        setattr(vm.strip[index].denoiser, param, value)
+        assert getattr(vm.strip[index].denoiser, param) == value
 
     """ strip tests, virtual """
 
     @pytest.mark.parametrize(
-        "index, param, value",
+        'index, param, value',
         [
-            (data.virt_in, "treble", -1.6),
+            (data.virt_in, 'pan_x', -0.6),
-            (data.virt_in, "mid", 5.8),
+            (data.virt_in, 'pan_x', 0.6),
-            (data.virt_in, "bass", -8.1),
+            (data.virt_in, 'treble', -1.6),
+            (data.virt_in, 'mid', 5.8),
+            (data.virt_in, 'bass', -8.1),
         ],
     )
     def test_it_sets_and_gets_strip_eq_params(self, index, param, value):
-        setattr(tests.strip[index], param, value)
+        setattr(vm.strip[index], param, value)
-        assert getattr(tests.strip[index], param) == value
+        assert getattr(vm.strip[index], param) == value
 
     """ bus tests, physical and virtual """
 
     @pytest.mark.skipif(
-        data.name != "potato",
+        data.name != 'potato',
-        reason="Only test if logged into Potato version",
+        reason='Only test if logged into Potato version',
     )
     @pytest.mark.parametrize(
-        "index, param, value",
+        'index, param, value',
-        [(data.phys_out, "returnreverb", 3.6), (data.virt_out, "returnfx1", 5.8)],
+        [(data.phys_out, 'returnreverb', 3.6), (data.virt_out, 'returnfx1', 5.8)],
     )
     def test_it_sets_and_gets_bus_effects_float_params(self, index, param, value):
-        assert hasattr(tests.bus[index], param)
+        assert hasattr(vm.bus[index], param)
-        setattr(tests.bus[index], param, value)
+        setattr(vm.bus[index], param, value)
-        assert getattr(tests.bus[index], param) == value
+        assert getattr(vm.bus[index], param) == value
 
     @pytest.mark.parametrize(
-        "index, param, value",
+        'index, param, value',
-        [(data.phys_out, "gain", -3.6), (data.virt_out, "gain", 5.8)],
+        [(data.phys_out, 'gain', -3.6), (data.virt_out, 'gain', 5.8)],
     )
     def test_it_sets_and_gets_bus_float_params(self, index, param, value):
-        setattr(tests.bus[index], param, value)
+        setattr(vm.bus[index], param, value)
-        assert getattr(tests.bus[index], param) == value
+        assert getattr(vm.bus[index], param) == value
 
     @pytest.mark.parametrize(
-        "index,value",
+        'index,value',
         [(data.phys_out, 8), (data.virt_out, 8)],
     )
-    def test_it_gets_prefader_levels_and_compares_length_of_array(self, index, value):
+    def test_it_gets_bus_levels_and_compares_length_of_array(self, index, value):
-        assert len(tests.bus[index].levels.all) == value
+        assert len(vm.bus[index].levels.all) == value
 
 
-@pytest.mark.parametrize("value", ["test0", "test1"])
+@pytest.mark.parametrize('value', ['test0', 'test1'])
 class TestSetAndGetStringHigher:
     __test__ = True
 
     """strip tests, physical and virtual"""
 
     @pytest.mark.parametrize(
-        "index, param",
+        'index, param',
-        [(data.phys_in, "label"), (data.virt_in, "label")],
+        [(data.phys_in, 'label'), (data.virt_in, 'label')],
     )
     def test_it_sets_and_gets_strip_string_params(self, index, param, value):
-        setattr(tests.strip[index], param, value)
+        setattr(vm.strip[index], param, value)
-        assert getattr(tests.strip[index], param) == value
+        assert getattr(vm.strip[index], param) == value
 
     """ bus tests, physical and virtual """
 
     @pytest.mark.parametrize(
-        "index, param",
+        'index, param',
-        [(data.phys_out, "label"), (data.virt_out, "label")],
+        [(data.phys_out, 'label'), (data.virt_out, 'label')],
     )
     def test_it_sets_and_gets_bus_string_params(self, index, param, value):
-        setattr(tests.bus[index], param, value)
+        setattr(vm.bus[index], param, value)
-        assert getattr(tests.bus[index], param) == value
+        assert getattr(vm.bus[index], param) == value
 
     """ vban instream tests """
 
     @pytest.mark.parametrize(
-        "index, param",
+        'index, param',
-        [(data.vban_in, "name")],
+        [(data.vban_in, 'name')],
     )
     def test_it_sets_and_gets_vban_instream_string_params(self, index, param, value):
-        setattr(tests.vban.instream[index], param, value)
+        setattr(vm.vban.instream[index], param, value)
-        assert getattr(tests.vban.instream[index], param) == value
+        assert getattr(vm.vban.instream[index], param) == value
 
     """ vban outstream tests """
 
     @pytest.mark.parametrize(
-        "index, param",
+        'index, param',
-        [(data.vban_out, "name")],
+        [(data.vban_out, 'name')],
     )
     def test_it_sets_and_gets_vban_outstream_string_params(self, index, param, value):
-        setattr(tests.vban.outstream[index], param, value)
+        setattr(vm.vban.outstream[index], param, value)
-        assert getattr(tests.vban.outstream[index], param) == value
+        assert getattr(vm.vban.outstream[index], param) == value
 
 
-@pytest.mark.parametrize("value", [False, True])
+@pytest.mark.parametrize('value', [False, True])
 class TestSetAndGetMacroButtonHigher:
     __test__ = True
 
     """macrobutton tests"""
 
     @pytest.mark.parametrize(
-        "index, param",
+        'index, param',
         [
-            (0, "state"),
+            (0, 'state'),
-            (39, "stateonly"),
+            (39, 'stateonly'),
-            (69, "trigger"),
+            (69, 'trigger'),
-            (22, "stateonly"),
+            (22, 'stateonly'),
-            (45, "state"),
+            (45, 'state'),
-            (65, "trigger"),
+            (65, 'trigger'),
         ],
     )
     def test_it_sets_and_gets_macrobutton_params(self, index, param, value):
-        setattr(tests.button[index], param, value)
+        setattr(vm.button[index], param, value)
-        assert getattr(tests.button[index], param) == value
+        assert getattr(vm.button[index], param) == value

tests/test_lower.py

@@ -1,6 +1,6 @@
 import pytest
 
-from tests import data, tests
+from tests import data, vm
 
 
 class TestSetAndGetFloatLower:
@@ -9,70 +9,72 @@ class TestSetAndGetFloatLower:
     """VBVMR_SetParameterFloat, VBVMR_GetParameterFloat"""
 
     @pytest.mark.parametrize(
-        "param,value",
+        'param,value',
         [
-            (f"Strip[{data.phys_in}].Mute", 1),
+            (f'Strip[{data.phys_in}].Mute', 1),
-            (f"Bus[{data.virt_out}].Eq.on", 1),
+            (f'Bus[{data.virt_out}].Eq.on', 1),
-            (f"Strip[{data.phys_in}].Mute", 0),
+            (f'Strip[{data.phys_in}].Mute', 0),
-            (f"Bus[{data.virt_out}].Eq.on", 0),
+            (f'Bus[{data.virt_out}].Eq.on', 0),
         ],
     )
     def test_it_sets_and_gets_mute_eq_float_params(self, param, value):
-        tests.set(param, value)
+        vm.set(param, value)
-        assert (round(tests.get(param))) == value
+        assert (round(vm.get(param))) == value
 
     @pytest.mark.parametrize(
-        "param,value",
+        'param,value',
         [
-            (f"Strip[{data.phys_in}].Comp", 5.3),
+            (f'Strip[{data.phys_in}].Comp', 5.3),
-            (f"Strip[{data.virt_in}].Gain", -37.5),
+            (f'Strip[{data.virt_in}].Gain', -37.5),
-            (f"Bus[{data.virt_out}].Gain", -22.7),
+            (f'Bus[{data.virt_out}].Gain', -22.7),
         ],
     )
     def test_it_sets_and_gets_comp_gain_float_params(self, param, value):
-        tests.set(param, value)
+        vm.set(param, value)
-        assert (round(tests.get(param), 1)) == value
+        assert (round(vm.get(param), 1)) == value
 
 
-@pytest.mark.parametrize("value", ["test0", "test1"])
+@pytest.mark.parametrize('value', ['test0', 'test1'])
 class TestSetAndGetStringLower:
     __test__ = True
 
     """VBVMR_SetParameterStringW, VBVMR_GetParameterStringW"""
 
     @pytest.mark.parametrize(
-        "param",
+        'param',
-        [(f"Strip[{data.phys_out}].label"), (f"Bus[{data.virt_out}].label")],
+        [(f'Strip[{data.phys_out}].label'), (f'Bus[{data.virt_out}].label')],
     )
     def test_it_sets_and_gets_string_params(self, param, value):
-        tests.set(param, value)
+        vm.set(param, value)
-        assert tests.get(param, string=True) == value
+        assert vm.get(param, string=True) == value
 
 
-@pytest.mark.parametrize("value", [0, 1])
+@pytest.mark.parametrize('value', [0, 1])
 class TestMacroButtonsLower:
+    __test__ = True
+
     """VBVMR_MacroButton_SetStatus, VBVMR_MacroButton_GetStatus"""
 
     @pytest.mark.parametrize(
-        "index, mode",
+        'index, mode',
         [(33, 1), (49, 1)],
     )
     def test_it_sets_and_gets_macrobuttons_state(self, index, mode, value):
-        tests.set_buttonstatus(index, value, mode)
+        vm.set_buttonstatus(index, value, mode)
-        assert tests.get_buttonstatus(index, mode) == value
+        assert vm.get_buttonstatus(index, mode) == value
 
     @pytest.mark.parametrize(
-        "index, mode",
+        'index, mode',
         [(14, 2), (12, 2)],
     )
     def test_it_sets_and_gets_macrobuttons_stateonly(self, index, mode, value):
-        tests.set_buttonstatus(index, value, mode)
+        vm.set_buttonstatus(index, value, mode)
-        assert tests.get_buttonstatus(index, mode) == value
+        assert vm.get_buttonstatus(index, mode) == value
 
     @pytest.mark.parametrize(
-        "index, mode",
+        'index, mode',
         [(50, 3), (65, 3)],
     )
     def test_it_sets_and_gets_macrobuttons_trigger(self, index, mode, value):
-        tests.set_buttonstatus(index, value, mode)
+        vm.set_buttonstatus(index, value, mode)
-        assert tests.get_buttonstatus(index, mode) == value
+        assert vm.get_buttonstatus(index, mode) == value

tox.ini

@@ -0,0 +1,42 @@
+[tox]
+envlist = py310,py311,py312,py313
+
+[testenv]
+passenv = *
+setenv = VIRTUALENV_DISCOVERY=pyenv
+allowlist_externals = poetry
+commands_pre =
+    poetry install --no-interaction --no-root
+commands =
+    poetry run pytest tests
+
+[testenv:genbadge]
+passenv = *
+setenv = VIRTUALENV_DISCOVERY=pyenv
+allowlist_externals = poetry
+deps =
+    genbadge[all]
+    pytest-html
+commands_pre =
+    poetry install --no-interaction --no-root
+commands =
+    poetry run pytest --capture=tee-sys --junitxml=./tests/reports/junit-${KIND}.xml --html=./tests/reports/${KIND}.html tests
+    poetry run genbadge tests -t 90 -i ./tests/reports/junit-${KIND}.xml -o ./tests/reports/badge-${KIND}.svg
+
+[testenv:dsl]
+setenv = VIRTUALENV_DISCOVERY=pyenv
+allowlist_externals = poetry
+deps = pyparsing
+commands_pre =
+    poetry install --no-interaction --no-root --without dev
+commands =
+    poetry run python examples/dsl
+
+[testenv:obs]
+setenv = VIRTUALENV_DISCOVERY=pyenv
+allowlist_externals = poetry
+deps = obsws-python
+commands_pre =
+    poetry install --no-interaction --no-root --without dev
+commands =
+    poetry run python examples/obs

voicemeeterlib/__init__.py

@@ -1,3 +1,3 @@
 from .factory import request_remote_obj as api
 
-__ALL__ = ["api"]
+__ALL__ = ['api']

voicemeeterlib/base.py

@@ -1,309 +0,0 @@
-import ctypes as ct
-import time
-from abc import abstractmethod
-from functools import partial
-from threading import Thread
-from typing import Iterable, NoReturn, Optional, Self, Union
-
-from .cbindings import CBindings
-from .error import CAPIError, VMError
-from .inst import bits
-from .kinds import KindId
-from .misc import Event, Midi
-from .subject import Subject
-from .util import comp, grouper, polling, script
-
-
-class Remote(CBindings):
-    """Base class responsible for wrapping the C Remote API"""
-
-    DELAY = 0.001
-
-    def __init__(self, **kwargs):
-        self.strip_mode = 0
-        self.cache = {}
-        self.cache["strip_level"], self.cache["bus_level"] = self._get_levels()
-        self.midi = Midi()
-        self.subject = Subject()
-        self.running = None
-
-        for attr, val in kwargs.items():
-            setattr(self, attr, val)
-
-        self.event = Event(self.subs)
-
-    def __enter__(self) -> Self:
-        """setup procedures"""
-        self.login()
-        self.init_thread()
-        return self
-
-    @abstractmethod
-    def __str__(self):
-        """Ensure subclasses override str magic method"""
-        pass
-
-    def init_thread(self):
-        """Starts updates thread."""
-        self.running = True
-        print(f"Listening for {', '.join(self.event.get())} events")
-        t = Thread(target=self._updates, daemon=True)
-        t.start()
-
-    def _updates(self):
-        """
-        Continously update observers of dirty states.
-
-        Generate _strip_comp, _bus_comp and update level cache if ldirty.
-
-        Runs updates at a rate of self.ratelimit.
-        """
-        while self.running:
-            if self.event.pdirty and self.pdirty:
-                self.subject.notify("pdirty")
-            if self.event.mdirty and self.mdirty:
-                self.subject.notify("mdirty")
-            if self.event.midi and self.get_midi_message():
-                self.subject.notify("midi")
-            if self.event.ldirty and self.ldirty:
-                self._strip_comp, self._bus_comp = (
-                    tuple(
-                        not x for x in comp(self.cache["strip_level"], self._strip_buf)
-                    ),
-                    tuple(not x for x in comp(self.cache["bus_level"], self._bus_buf)),
-                )
-                self.cache["strip_level"] = self._strip_buf
-                self.cache["bus_level"] = self._bus_buf
-                self.subject.notify("ldirty")
-
-            time.sleep(self.ratelimit if self.event.any() else 0.5)
-
-    def login(self) -> NoReturn:
-        """Login to the API, initialize dirty parameters"""
-        res = self.vm_login()
-        if res == 1:
-            self.run_voicemeeter(self.kind.name)
-        elif res != 0:
-            raise CAPIError(f"VBVMR_Login returned {res}")
-        print(f"Successfully logged into {self}")
-        self.clear_dirty()
-
-    def run_voicemeeter(self, kind_id: str) -> NoReturn:
-        if kind_id not in (kind.name.lower() for kind in KindId):
-            raise VMError(f"Unexpected Voicemeeter type: '{kind_id}'")
-        if kind_id == "potato" and bits == 8:
-            value = KindId[kind_id.upper()].value + 3
-        else:
-            value = KindId[kind_id.upper()].value
-        self.vm_runvm(value)
-        time.sleep(1)
-
-    @property
-    def type(self) -> str:
-        """Returns the type of Voicemeeter installation (basic, banana, potato)."""
-        type_ = ct.c_long()
-        self.vm_get_type(ct.byref(type_))
-        return KindId(type_.value).name.lower()
-
-    @property
-    def version(self) -> str:
-        """Returns Voicemeeter's version as a string"""
-        ver = ct.c_long()
-        self.vm_get_version(ct.byref(ver))
-        return "{}.{}.{}.{}".format(
-            (ver.value & 0xFF000000) >> 24,
-            (ver.value & 0x00FF0000) >> 16,
-            (ver.value & 0x0000FF00) >> 8,
-            ver.value & 0x000000FF,
-        )
-
-    @property
-    def pdirty(self) -> bool:
-        """True iff UI parameters have been updated."""
-        return self.vm_pdirty() == 1
-
-    @property
-    def mdirty(self) -> bool:
-        """True iff MB parameters have been updated."""
-        return self.vm_mdirty() == 1
-
-    @property
-    def ldirty(self) -> bool:
-        """True iff levels have been updated."""
-        self._strip_buf, self._bus_buf = self._get_levels()
-        return not (
-            self.cache.get("strip_level") == self._strip_buf
-            and self.cache.get("bus_level") == self._bus_buf
-        )
-
-    def clear_dirty(self):
-        while self.pdirty or self.mdirty:
-            pass
-
-    @polling
-    def get(self, param: str, is_string: Optional[bool] = False) -> Union[str, float]:
-        """Gets a string or float parameter"""
-        if is_string:
-            buf = ct.create_unicode_buffer(512)
-            self.call(
-                partial(self.vm_get_parameter_string, param.encode(), ct.byref(buf))
-            )
-        else:
-            buf = ct.c_float()
-            self.call(
-                partial(self.vm_get_parameter_float, param.encode(), ct.byref(buf))
-            )
-        return buf.value
-
-    def set(self, param: str, val: Union[str, float]) -> NoReturn:
-        """Sets a string or float parameter. Caches value"""
-        if isinstance(val, str):
-            if len(val) >= 512:
-                raise VMError("String is too long")
-            self.call(
-                partial(self.vm_set_parameter_string, param.encode(), ct.c_wchar_p(val))
-            )
-        else:
-            self.call(
-                partial(
-                    self.vm_set_parameter_float, param.encode(), ct.c_float(float(val))
-                )
-            )
-        self.cache[param] = val
-
-    @polling
-    def get_buttonstatus(self, id: int, mode: int) -> int:
-        """Gets a macrobutton parameter"""
-        state = ct.c_float()
-        self.call(
-            partial(
-                self.vm_get_buttonstatus,
-                ct.c_long(id),
-                ct.byref(state),
-                ct.c_long(mode),
-            )
-        )
-        return int(state.value)
-
-    def set_buttonstatus(self, id: int, state: int, mode: int) -> NoReturn:
-        """Sets a macrobutton parameter. Caches value"""
-        c_state = ct.c_float(float(state))
-        self.call(
-            partial(self.vm_set_buttonstatus, ct.c_long(id), c_state, ct.c_long(mode))
-        )
-        self.cache[f"mb_{id}_{mode}"] = int(c_state.value)
-
-    def get_num_devices(self, direction: str = None) -> int:
-        """Retrieves number of physical devices connected"""
-        if direction not in ("in", "out"):
-            raise VMError("Expected a direction: in or out")
-        func = getattr(self, f"vm_get_num_{direction}devices")
-        return func()
-
-    def get_device_description(self, index: int, direction: str = None) -> tuple:
-        """Returns a tuple of device parameters"""
-        if direction not in ("in", "out"):
-            raise VMError("Expected a direction: in or out")
-        type_ = ct.c_long()
-        name = ct.create_unicode_buffer(256)
-        hwid = ct.create_unicode_buffer(256)
-        func = getattr(self, f"vm_get_desc_{direction}devices")
-        func(
-            ct.c_long(index),
-            ct.byref(type_),
-            ct.byref(name),
-            ct.byref(hwid),
-        )
-        return (name.value, type_.value, hwid.value)
-
-    def get_level(self, type_: int, index: int) -> float:
-        """Retrieves a single level value"""
-        val = ct.c_float()
-        self.vm_get_level(ct.c_long(type_), ct.c_long(index), ct.byref(val))
-        return val.value
-
-    def _get_levels(self) -> Iterable:
-        """
-        returns both level arrays (strip_levels, bus_levels) BEFORE math conversion
-        """
-        return (
-            tuple(
-                self.get_level(self.strip_mode, i)
-                for i in range(2 * self.kind.phys_in + 8 * self.kind.virt_in)
-            ),
-            tuple(
-                self.get_level(3, i)
-                for i in range(8 * (self.kind.phys_out + self.kind.virt_out))
-            ),
-        )
-
-    def get_midi_message(self):
-        n = ct.c_long(1024)
-        buf = ct.create_string_buffer(1024)
-        res = self.vm_get_midi_message(ct.byref(buf), n)
-        if res > 0:
-            vals = tuple(grouper(3, (int.from_bytes(buf[i]) for i in range(res))))
-            for msg in vals:
-                ch, pitch, vel = msg
-                if not self.midi._channel or self.midi._channel != ch:
-                    self.midi._channel = ch
-                self.midi._most_recent = pitch
-                self.midi._set(pitch, vel)
-            return True
-        elif res == -1 or res == -2:
-            raise CAPIError(f"VBVMR_GetMidiMessage returned {res}")
-
-    @script
-    def sendtext(self, script: str):
-        """Sets many parameters from a script"""
-        if len(script) > 48000:
-            raise ValueError("Script too large, max size 48kB")
-        self.call(partial(self.vm_set_parameter_multi, script.encode()))
-        time.sleep(self.DELAY * 5)
-
-    def apply(self, data: dict):
-        """
-        Sets all parameters of a dict
-
-        minor delay between each recursion
-        """
-
-        def param(key):
-            obj, m2, *rem = key.split("-")
-            index = int(m2) if m2.isnumeric() else int(*rem)
-            if obj in ("strip", "bus", "button"):
-                return getattr(self, obj)[index]
-            elif obj == "vban":
-                return getattr(getattr(self, obj), f"{m2}stream")[index]
-            raise ValueError(obj)
-
-        [param(key).apply(datum).then_wait() for key, datum in data.items()]
-
-    def apply_config(self, name):
-        """applies a config from memory"""
-        error_msg = (
-            f"No config with name '{name}' is loaded into memory",
-            f"Known configs: {list(self.configs.keys())}",
-        )
-        try:
-            self.apply(self.configs[name])
-            print(f"Profile '{name}' applied!")
-        except KeyError as e:
-            print(("\n").join(error_msg))
-
-    def logout(self) -> NoReturn:
-        """Wait for dirty parameters to clear, then logout of the API"""
-        self.clear_dirty()
-        time.sleep(0.1)
-        res = self.vm_logout()
-        if res != 0:
-            raise CAPIError(f"VBVMR_Logout returned {res}")
-        print(f"Successfully logged out of {self}")
-
-    def end_thread(self):
-        self.running = False
-
-    def __exit__(self, exc_type, exc_value, exc_traceback) -> NoReturn:
-        """teardown procedures"""
-        self.end_thread()
-        self.logout()

voicemeeterlib/bus.py

@@ -4,14 +4,13 @@ from enum import IntEnum
 from math import log
 from typing import Union
 
-from .error import VMError
+from . import kinds
 from .iremote import IRemote
-from .kinds import kinds_all
+from .meta import bus_mode_prop, device_prop, float_prop
-from .meta import bool_prop, bus_mode_prop, float_prop
 
 BusModes = IntEnum(
-    "BusModes",
+    'BusModes',
-    "normal amix bmix repeat composite tvmix upmix21 upmix41 upmix61 centeronly lfeonly rearonly",
+    'normal amix bmix repeat composite tvmix upmix21 upmix41 upmix61 centeronly lfeonly rearonly',
     start=0,
 )
 
@@ -29,110 +28,249 @@ class Bus(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"bus[{self.index}]"
+        return f'bus[{self.index}]'
 
     @property
     def mute(self) -> bool:
-        return self.getter("mute") == 1
+        return self.getter('mute') == 1
 
     @mute.setter
     def mute(self, val: bool):
-        self.setter("mute", 1 if val else 0)
+        self.setter('mute', 1 if val else 0)
 
     @property
-    def mono(self) -> bool:
+    def mono(self) -> int:
-        return self.getter("mono") == 1
+        return int(self.getter('mono'))
 
     @mono.setter
-    def mono(self, val: bool):
+    def mono(self, val: int):
-        self.setter("mono", 1 if val else 0)
+        self.setter('mono', val)
-
-    @property
-    def eq(self) -> bool:
-        return self.getter("eq.On") == 1
-
-    @eq.setter
-    def eq(self, val: bool):
-        self.setter("eq.On", 1 if val else 0)
-
-    @property
-    def eq_ab(self) -> bool:
-        return self.getter("eq.ab") == 1
-
-    @eq_ab.setter
-    def eq_ab(self, val: bool):
-        self.setter("eq.ab", 1 if val else 0)
 
     @property
     def sel(self) -> bool:
-        return self.getter("sel") == 1
+        return self.getter('sel') == 1
 
     @sel.setter
     def sel(self, val: bool):
-        self.setter("sel", 1 if val else 0)
+        self.setter('sel', 1 if val else 0)
 
     @property
     def label(self) -> str:
-        return self.getter("Label", is_string=True)
+        return self.getter('Label', is_string=True)
 
     @label.setter
     def label(self, val: str):
-        self.setter("Label", str(val))
+        self.setter('Label', str(val))
 
     @property
     def gain(self) -> float:
-        return round(self.getter("gain"), 1)
+        return round(self.getter('gain'), 1)
 
     @gain.setter
     def gain(self, val: float):
-        self.setter("gain", val)
+        self.setter('gain', val)
 
     @property
     def monitor(self) -> bool:
-        return self.getter("monitor") == 1
+        return self.getter('monitor') == 1
 
     @monitor.setter
     def monitor(self, val: bool):
-        self.setter("monitor", 1 if val else 0)
+        self.setter('monitor', 1 if val else 0)
 
     def fadeto(self, target: float, time_: int):
-        self.setter("FadeTo", f"({target}, {time_})")
+        self.setter('FadeTo', f'({target}, {time_})')
         time.sleep(self._remote.DELAY)
 
     def fadeby(self, change: float, time_: int):
-        self.setter("FadeBy", f"({change}, {time_})")
+        self.setter('FadeBy', f'({change}, {time_})')
         time.sleep(self._remote.DELAY)
 
 
+class BusEQ(IRemote):
+    @classmethod
+    def make(cls, remote, i):
+        """
+        Factory method for BusEQ.
+
+        Returns a BusEQ class.
+        """
+        BusEQ_cls = type(
+            'BusEQ',
+            (cls,),
+            {
+                'channel': tuple(
+                    BusEQCh.make(remote, i, j) for j in range(remote.kind.bus_channels)
+                )
+            },
+        )
+        return BusEQ_cls(remote, i)
+
+    @property
+    def identifier(self) -> str:
+        return f'Bus[{self.index}].eq'
+
+    @property
+    def on(self) -> bool:
+        return self.getter('on') == 1
+
+    @on.setter
+    def on(self, val: bool):
+        self.setter('on', 1 if val else 0)
+
+    @property
+    def ab(self) -> bool:
+        return self.getter('ab') == 1
+
+    @ab.setter
+    def ab(self, val: bool):
+        self.setter('ab', 1 if val else 0)
+
+
+class BusEQCh(IRemote):
+    @classmethod
+    def make(cls, remote, i, j):
+        """
+        Factory method for Bus EQ channel.
+
+        Returns a BusEQCh class.
+        """
+        BusEQCh_cls = type(
+            'BusEQCh',
+            (cls,),
+            {
+                'cell': tuple(
+                    BusEQChCell(remote, i, j, k) for k in range(remote.kind.cells)
+                )
+            },
+        )
+        return BusEQCh_cls(remote, i, j)
+
+    def __init__(self, remote, i, j):
+        super().__init__(remote, i)
+        self.channel_index = j
+
+    @property
+    def identifier(self) -> str:
+        return f'Bus[{self.index}].eq.channel[{self.channel_index}]'
+
+
+class BusEQChCell(IRemote):
+    def __init__(self, remote, i, j, k):
+        super().__init__(remote, i)
+        self.channel_index = j
+        self.cell_index = k
+
+    @property
+    def identifier(self) -> str:
+        return f'Bus[{self.index}].eq.channel[{self.channel_index}].cell[{self.cell_index}]'
+
+    @property
+    def on(self) -> bool:
+        return self.getter('on') == 1
+
+    @on.setter
+    def on(self, val: bool):
+        self.setter('on', 1 if val else 0)
+
+    @property
+    def type(self) -> int:
+        return int(self.getter('type'))
+
+    @type.setter
+    def type(self, val: int):
+        self.setter('type', val)
+
+    @property
+    def f(self) -> float:
+        return round(self.getter('f'), 1)
+
+    @f.setter
+    def f(self, val: float):
+        self.setter('f', val)
+
+    @property
+    def gain(self) -> float:
+        return round(self.getter('gain'), 1)
+
+    @gain.setter
+    def gain(self, val: float):
+        self.setter('gain', val)
+
+    @property
+    def q(self) -> float:
+        return round(self.getter('q'), 1)
+
+    @q.setter
+    def q(self, val: float):
+        self.setter('q', val)
+
+
 class PhysicalBus(Bus):
     @classmethod
-    def make(cls, kind):
+    def make(cls, remote, i, kind):
         """
         Factory method for PhysicalBus.
 
         Returns a PhysicalBus class.
         """
         kls = (cls,)
-        if kind.name == "potato":
+        if kind.name == 'potato':
             EFFECTS_cls = _make_effects_mixin()
             kls += (EFFECTS_cls,)
-        return type("PhysicalBus", kls, {})
+        return type(
+            'PhysicalBus',
+            kls,
+            {
+                'device': BusDevice.make(remote, i),
+            },
+        )
 
     def __str__(self):
-        return f"{type(self).__name__}{self.index}"
+        return f'{type(self).__name__}{self.index}'
+
+
+class BusDevice(IRemote):
+    @classmethod
+    def make(cls, remote, i):
+        """
+        Factory function for bus.device.
+
+        Returns a BusDevice class of a kind.
+        """
+        DEVICE_cls = type(
+            f'BusDevice{remote.kind}',
+            (cls,),
+            {
+                **{
+                    param: device_prop(param)
+                    for param in [
+                        'wdm',
+                        'ks',
+                        'mme',
+                        'asio',
+                    ]
+                },
+            },
+        )
+        return DEVICE_cls(remote, i)
 
     @property
-    def device(self) -> str:
+    def identifier(self) -> str:
-        return self.getter("device.name", is_string=True)
+        return f'Bus[{self.index}].device'
+
+    @property
+    def name(self) -> str:
+        return self.getter('name', is_string=True)
 
     @property
     def sr(self) -> int:
-        return int(self.getter("device.sr"))
+        return int(self.getter('sr'))
 
 
 class VirtualBus(Bus):
     @classmethod
-    def make(cls, kind):
+    def make(cls, remote, i, kind):
         """
         Factory method for VirtualBus.
 
@@ -141,15 +279,21 @@ class VirtualBus(Bus):
         Returns a VirtualBus class.
         """
         kls = (cls,)
-        if kind.name == "basic":
+        if kind.name == 'basic':
-            kls += (PhysicalBus,)
+            return type(
-        elif kind.name == "potato":
+                'VirtualBus',
+                kls,
+                {
+                    'device': BusDevice.make(remote, i),
+                },
+            )
+        elif kind.name == 'potato':
             EFFECTS_cls = _make_effects_mixin()
             kls += (EFFECTS_cls,)
-        return type("VirtualBus", kls, {})
+        return type('VirtualBus', kls, {})
 
     def __str__(self):
-        return f"{type(self).__name__}{self.index}"
+        return f'{type(self).__name__}{self.index}'
 
 
 class BusLevel(IRemote):
@@ -169,8 +313,8 @@ class BusLevel(IRemote):
         def fget(x):
             return round(20 * log(x, 10), 1) if x > 0 else -200.0
 
-        if self._remote.running and self._remote.event.ldirty:
+        if not self._remote.stopped() and self._remote.event.ldirty:
-            vals = self._remote.cache["bus_level"][self.range[0] : self.range[-1]]
+            vals = self._remote.cache['bus_level'][self.range[0] : self.range[-1]]
         else:
             vals = [self._remote.get_level(mode, i) for i in range(*self.range)]
 
@@ -178,7 +322,7 @@ class BusLevel(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Bus[{self.index}]"
+        return f'Bus[{self.index}]'
 
     @property
     def all(self) -> tuple:
@@ -191,7 +335,7 @@ class BusLevel(IRemote):
 
         Expected to be used in a callback only.
         """
-        if self._remote.running:
+        if not self._remote.stopped():
             return any(self._remote._bus_comp[self.range[0] : self.range[-1]])
 
     is_updated = isdirty
@@ -201,14 +345,14 @@ def make_bus_level_map(kind):
     return tuple((i, i + 8) for i in range(0, (kind.phys_out + kind.virt_out) * 8, 8))
 
 
-_make_bus_level_maps = {kind.name: make_bus_level_map(kind) for kind in kinds_all}
+_make_bus_level_maps = {kind.name: make_bus_level_map(kind) for kind in kinds.all}
 
 
 def _make_bus_mode_mixin():
     """Creates a mixin of Bus Modes."""
 
     def identifier(self) -> str:
-        return f"Bus[{self.index}].mode"
+        return f'Bus[{self.index}].mode'
 
     def get(self) -> str:
         time.sleep(0.01)
@@ -229,15 +373,15 @@ def _make_bus_mode_mixin():
         ):
             if val:
                 return BusModes(i + 1).name
-        return "normal"
+        return 'normal'
 
     return type(
-        "BusModeMixin",
+        'BusModeMixin',
         (IRemote,),
         {
-            "identifier": property(identifier),
+            'identifier': property(identifier),
             **{mode.name: bus_mode_prop(mode.name) for mode in BusModes},
-            "get": get,
+            'get': get,
         },
     )
 
@@ -245,12 +389,12 @@ def _make_bus_mode_mixin():
 def _make_effects_mixin():
     """creates an fx mixin"""
     return type(
-        "FX",
+        'FX',
         (),
         {
             **{
-                f"return{param}": float_prop(f"return{param}")
+                f'return{param}': float_prop(f'return{param}')
-                for param in ["reverb", "delay", "fx1", "fx2"]
+                for param in ['reverb', 'delay', 'fx1', 'fx2']
             },
         },
     )
@@ -263,15 +407,18 @@ def bus_factory(is_phys_bus, remote, i) -> Union[PhysicalBus, VirtualBus]:
     Returns a physical or virtual bus subclass
     """
     BUS_cls = (
-        PhysicalBus.make(remote.kind) if is_phys_bus else VirtualBus.make(remote.kind)
+        PhysicalBus.make(remote, i, remote.kind)
+        if is_phys_bus
+        else VirtualBus.make(remote, i, remote.kind)
     )
     BUSMODEMIXIN_cls = _make_bus_mode_mixin()
     return type(
-        f"{BUS_cls.__name__}{remote.kind}",
+        f'{BUS_cls.__name__}{remote.kind}',
         (BUS_cls,),
         {
-            "levels": BusLevel(remote, i),
+            'levels': BusLevel(remote, i),
-            "mode": BUSMODEMIXIN_cls(remote, i),
+            'mode': BUSMODEMIXIN_cls(remote, i),
+            'eq': BusEQ.make(remote, i),
         },
     )(remote, i)
 

voicemeeterlib/cbindings.py

@@ -1,10 +1,13 @@
 import ctypes as ct
+import logging
 from abc import ABCMeta
 from ctypes.wintypes import CHAR, FLOAT, LONG, WCHAR
 
 from .error import CAPIError
 from .inst import libc
 
+logger = logging.getLogger(__name__)
+
 
 class CBindings(metaclass=ABCMeta):
     """
@@ -13,97 +16,110 @@ class CBindings(metaclass=ABCMeta):
     Maps expected ctype argument and res types for each binding.
     """
 
-    vm_login = libc.VBVMR_Login
+    logger_cbindings = logger.getChild('CBindings')
-    vm_login.restype = LONG
-    vm_login.argtypes = None
 
-    vm_logout = libc.VBVMR_Logout
+    bind_login = libc.VBVMR_Login
-    vm_logout.restype = LONG
+    bind_login.restype = LONG
-    vm_logout.argtypes = None
+    bind_login.argtypes = None
 
-    vm_runvm = libc.VBVMR_RunVoicemeeter
+    bind_logout = libc.VBVMR_Logout
-    vm_runvm.restype = LONG
+    bind_logout.restype = LONG
-    vm_runvm.argtypes = [LONG]
+    bind_logout.argtypes = None
 
-    vm_get_type = libc.VBVMR_GetVoicemeeterType
+    bind_run_voicemeeter = libc.VBVMR_RunVoicemeeter
-    vm_get_type.restype = LONG
+    bind_run_voicemeeter.restype = LONG
-    vm_get_type.argtypes = [ct.POINTER(LONG)]
+    bind_run_voicemeeter.argtypes = [LONG]
 
-    vm_get_version = libc.VBVMR_GetVoicemeeterVersion
+    bind_get_voicemeeter_type = libc.VBVMR_GetVoicemeeterType
-    vm_get_version.restype = LONG
+    bind_get_voicemeeter_type.restype = LONG
-    vm_get_version.argtypes = [ct.POINTER(LONG)]
+    bind_get_voicemeeter_type.argtypes = [ct.POINTER(LONG)]
 
-    vm_mdirty = libc.VBVMR_MacroButton_IsDirty
+    bind_get_voicemeeter_version = libc.VBVMR_GetVoicemeeterVersion
-    vm_mdirty.restype = LONG
+    bind_get_voicemeeter_version.restype = LONG
-    vm_mdirty.argtypes = None
+    bind_get_voicemeeter_version.argtypes = [ct.POINTER(LONG)]
 
-    vm_get_buttonstatus = libc.VBVMR_MacroButton_GetStatus
+    if hasattr(libc, 'VBVMR_MacroButton_IsDirty'):
-    vm_get_buttonstatus.restype = LONG
+        bind_macro_button_is_dirty = libc.VBVMR_MacroButton_IsDirty
-    vm_get_buttonstatus.argtypes = [LONG, ct.POINTER(FLOAT), LONG]
+        bind_macro_button_is_dirty.restype = LONG
+        bind_macro_button_is_dirty.argtypes = None
 
-    vm_set_buttonstatus = libc.VBVMR_MacroButton_SetStatus
+    if hasattr(libc, 'VBVMR_MacroButton_GetStatus'):
-    vm_set_buttonstatus.restype = LONG
+        bind_macro_button_get_status = libc.VBVMR_MacroButton_GetStatus
-    vm_set_buttonstatus.argtypes = [LONG, FLOAT, LONG]
+        bind_macro_button_get_status.restype = LONG
+        bind_macro_button_get_status.argtypes = [LONG, ct.POINTER(FLOAT), LONG]
 
-    vm_pdirty = libc.VBVMR_IsParametersDirty
+    if hasattr(libc, 'VBVMR_MacroButton_SetStatus'):
-    vm_pdirty.restype = LONG
+        bind_macro_button_set_status = libc.VBVMR_MacroButton_SetStatus
-    vm_pdirty.argtypes = None
+        bind_macro_button_set_status.restype = LONG
+        bind_macro_button_set_status.argtypes = [LONG, FLOAT, LONG]
 
-    vm_get_parameter_float = libc.VBVMR_GetParameterFloat
+    bind_is_parameters_dirty = libc.VBVMR_IsParametersDirty
-    vm_get_parameter_float.restype = LONG
+    bind_is_parameters_dirty.restype = LONG
-    vm_get_parameter_float.argtypes = [ct.POINTER(CHAR), ct.POINTER(FLOAT)]
+    bind_is_parameters_dirty.argtypes = None
 
-    vm_set_parameter_float = libc.VBVMR_SetParameterFloat
+    bind_get_parameter_float = libc.VBVMR_GetParameterFloat
-    vm_set_parameter_float.restype = LONG
+    bind_get_parameter_float.restype = LONG
-    vm_set_parameter_float.argtypes = [ct.POINTER(CHAR), FLOAT]
+    bind_get_parameter_float.argtypes = [ct.POINTER(CHAR), ct.POINTER(FLOAT)]
 
-    vm_get_parameter_string = libc.VBVMR_GetParameterStringW
+    bind_set_parameter_float = libc.VBVMR_SetParameterFloat
-    vm_get_parameter_string.restype = LONG
+    bind_set_parameter_float.restype = LONG
-    vm_get_parameter_string.argtypes = [ct.POINTER(CHAR), ct.POINTER(WCHAR * 512)]
+    bind_set_parameter_float.argtypes = [ct.POINTER(CHAR), FLOAT]
 
-    vm_set_parameter_string = libc.VBVMR_SetParameterStringW
+    bind_get_parameter_string_w = libc.VBVMR_GetParameterStringW
-    vm_set_parameter_string.restype = LONG
+    bind_get_parameter_string_w.restype = LONG
-    vm_set_parameter_string.argtypes = [ct.POINTER(CHAR), ct.POINTER(WCHAR)]
+    bind_get_parameter_string_w.argtypes = [ct.POINTER(CHAR), ct.POINTER(WCHAR * 512)]
 
-    vm_set_parameter_multi = libc.VBVMR_SetParameters
+    bind_set_parameter_string_w = libc.VBVMR_SetParameterStringW
-    vm_set_parameter_multi.restype = LONG
+    bind_set_parameter_string_w.restype = LONG
-    vm_set_parameter_multi.argtypes = [ct.POINTER(CHAR)]
+    bind_set_parameter_string_w.argtypes = [ct.POINTER(CHAR), ct.POINTER(WCHAR)]
 
-    vm_get_level = libc.VBVMR_GetLevel
+    bind_set_parameters = libc.VBVMR_SetParameters
-    vm_get_level.restype = LONG
+    bind_set_parameters.restype = LONG
-    vm_get_level.argtypes = [LONG, LONG, ct.POINTER(FLOAT)]
+    bind_set_parameters.argtypes = [ct.POINTER(CHAR)]
 
-    vm_get_num_indevices = libc.VBVMR_Input_GetDeviceNumber
+    bind_get_level = libc.VBVMR_GetLevel
-    vm_get_num_indevices.restype = LONG
+    bind_get_level.restype = LONG
-    vm_get_num_indevices.argtypes = None
+    bind_get_level.argtypes = [LONG, LONG, ct.POINTER(FLOAT)]
 
-    vm_get_desc_indevices = libc.VBVMR_Input_GetDeviceDescW
+    bind_input_get_device_number = libc.VBVMR_Input_GetDeviceNumber
-    vm_get_desc_indevices.restype = LONG
+    bind_input_get_device_number.restype = LONG
-    vm_get_desc_indevices.argtypes = [
+    bind_input_get_device_number.argtypes = None
+
+    bind_input_get_device_desc_w = libc.VBVMR_Input_GetDeviceDescW
+    bind_input_get_device_desc_w.restype = LONG
+    bind_input_get_device_desc_w.argtypes = [
         LONG,
         ct.POINTER(LONG),
         ct.POINTER(WCHAR * 256),
         ct.POINTER(WCHAR * 256),
     ]
 
-    vm_get_num_outdevices = libc.VBVMR_Output_GetDeviceNumber
+    bind_output_get_device_number = libc.VBVMR_Output_GetDeviceNumber
-    vm_get_num_outdevices.restype = LONG
+    bind_output_get_device_number.restype = LONG
-    vm_get_num_outdevices.argtypes = None
+    bind_output_get_device_number.argtypes = None
 
-    vm_get_desc_outdevices = libc.VBVMR_Output_GetDeviceDescW
+    bind_output_get_device_desc_w = libc.VBVMR_Output_GetDeviceDescW
-    vm_get_desc_outdevices.restype = LONG
+    bind_output_get_device_desc_w.restype = LONG
-    vm_get_desc_outdevices.argtypes = [
+    bind_output_get_device_desc_w.argtypes = [
         LONG,
         ct.POINTER(LONG),
         ct.POINTER(WCHAR * 256),
         ct.POINTER(WCHAR * 256),
     ]
 
-    vm_get_midi_message = libc.VBVMR_GetMidiMessage
+    bind_get_midi_message = libc.VBVMR_GetMidiMessage
-    vm_get_midi_message.restype = LONG
+    bind_get_midi_message.restype = LONG
-    vm_get_midi_message.argtypes = [ct.POINTER(CHAR * 1024), LONG]
+    bind_get_midi_message.argtypes = [ct.POINTER(CHAR * 1024), LONG]
 
-    def call(self, func):
+    def call(self, func, *args, ok=(0,), ok_exp=None):
-        res = func()
+        try:
-        if res != 0:
+            res = func(*args)
-            raise CAPIError(f"Function {func.func.__name__} returned {res}")
+            if ok_exp is None:
+                if res not in ok:
+                    raise CAPIError(func.__name__, res)
+            elif not ok_exp(res) and res not in ok:
+                raise CAPIError(func.__name__, res)
+            return res
+        except CAPIError as e:
+            self.logger_cbindings.exception(f'{type(e).__name__}: {e}')
+            raise

voicemeeterlib/command.py

@@ -1,6 +1,5 @@
-from .error import VMError
 from .iremote import IRemote
-from .meta import action_prop
+from .meta import action_fn
 
 
 class Command(IRemote):
@@ -18,34 +17,33 @@ class Command(IRemote):
         Returns a Command class of a kind.
         """
         CMD_cls = type(
-            f"Command{remote.kind}",
+            f'Command{remote.kind}',
             (cls,),
             {
                 **{
-                    param: action_prop(param)
+                    param: action_fn(param) for param in ['show', 'shutdown', 'restart']
-                    for param in ["show", "shutdown", "restart"]
                 },
-                "hide": action_prop("show", val=0),
+                'hide': action_fn('show', val=0),
             },
         )
         return CMD_cls(remote)
 
     def __str__(self):
-        return f"{type(self).__name__}"
+        return f'{type(self).__name__}'
 
     @property
     def identifier(self) -> str:
-        return "Command"
+        return 'Command'
 
     def set_showvbanchat(self, val: bool):
-        self.setter("DialogShow.VBANCHAT", 1 if val else 0)
+        self.setter('DialogShow.VBANCHAT', 1 if val else 0)
 
     showvbanchat = property(fset=set_showvbanchat)
 
     def set_lock(self, val: bool):
-        self.setter("lock", 1 if val else 0)
+        self.setter('lock', 1 if val else 0)
 
     lock = property(fset=set_lock)
 
     def reset(self):
-        self._remote.apply_config("reset")
+        self._remote.apply_config('reset')

voicemeeterlib/config.py

@@ -1,10 +1,18 @@
 import itertools
+import logging
 from pathlib import Path
 
-import tomllib
+from .error import VMError
+
+try:
+    import tomllib
+except ModuleNotFoundError:
+    import tomli as tomllib
 
 from .kinds import request_kind_map as kindmap
 
+logger = logging.getLogger(__name__)
+
 
 class TOMLStrBuilder:
     """builds a config profile, as a string, for the toml parser"""
@@ -12,66 +20,72 @@ class TOMLStrBuilder:
     def __init__(self, kind):
         self.kind = kind
         self.higher = itertools.chain(
-            [f"strip-{i}" for i in range(kind.num_strip)],
+            [f'strip-{i}' for i in range(kind.num_strip)],
-            [f"bus-{i}" for i in range(kind.num_bus)],
+            [f'bus-{i}' for i in range(kind.num_bus)],
         )
 
     def init_config(self, profile=None):
         self.virt_strip_params = (
             [
-                "mute = false",
+                'mute = false',
-                "mono = false",
+                'mono = false',
-                "solo = false",
+                'solo = false',
-                "gain = 0.0",
+                'gain = 0.0',
             ]
-            + [f"A{i} = false" for i in range(1, self.kind.phys_out + 1)]
+            + [f'A{i} = false' for i in range(1, self.kind.phys_out + 1)]
-            + [f"B{i} = false" for i in range(1, self.kind.virt_out + 1)]
+            + [f'B{i} = false' for i in range(1, self.kind.virt_out + 1)]
         )
         self.phys_strip_params = self.virt_strip_params + [
-            "comp = 0.0",
+            'comp.knob = 0.0',
-            "gate = 0.0",
+            'gate.knob = 0.0',
+            'denoiser.knob = 0.0',
+            'eq.on = false',
+        ]
+        self.bus_params = [
+            'mono = false',
+            'eq.on = false',
+            'mute = false',
+            'gain = 0.0',
         ]
-        self.bus_bool = ["mono = false", "eq = false", "mute = false"]
 
-        if profile == "reset":
+        if profile == 'reset':
             self.reset_config()
 
     def reset_config(self):
         self.phys_strip_params = list(
-            map(lambda x: x.replace("B1 = false", "B1 = true"), self.phys_strip_params)
+            map(lambda x: x.replace('B1 = false', 'B1 = true'), self.phys_strip_params)
         )
         self.virt_strip_params = list(
-            map(lambda x: x.replace("A1 = false", "A1 = true"), self.virt_strip_params)
+            map(lambda x: x.replace('A1 = false', 'A1 = true'), self.virt_strip_params)
         )
 
-    def build(self, profile="reset"):
+    def build(self, profile='reset'):
         self.init_config(profile)
         toml_str = str()
         for eachclass in self.higher:
-            toml_str += f"[{eachclass}]\n"
+            toml_str += f'[{eachclass}]\n'
             toml_str = self.join(eachclass, toml_str)
         return toml_str
 
     def join(self, eachclass, toml_str):
-        kls, index = eachclass.split("-")
+        kls, index = eachclass.split('-')
         match kls:
-            case "strip":
+            case 'strip':
-                toml_str += ("\n").join(
+                toml_str += ('\n').join(
                     self.phys_strip_params
                     if int(index) < self.kind.phys_in
                     else self.virt_strip_params
                 )
-            case "bus":
+            case 'bus':
-                toml_str += ("\n").join(self.bus_bool)
+                toml_str += ('\n').join(self.bus_params)
             case _:
                 pass
-        return toml_str + "\n"
+        return toml_str + '\n'
 
 
 class TOMLDataExtractor:
     def __init__(self, file):
-        self._data = dict()
+        with open(file, 'rb') as f:
-        with open(file, "rb") as f:
             self._data = tomllib.load(f)
 
     @property
@@ -89,10 +103,10 @@ def dataextraction_factory(file):
 
     this opens the possibility for other parsers to be added
     """
-    if file.suffix == ".toml":
+    if file.suffix == '.toml':
         extractor = TOMLDataExtractor
     else:
-        raise ValueError("Cannot extract data from {}".format(file))
+        raise ValueError('Cannot extract data from {}'.format(file))
     return extractor(file)
 
 
@@ -118,6 +132,7 @@ class Loader(metaclass=SingletonType):
 
     def __init__(self, kind):
         self._kind = kind
+        self.logger = logger.getChild(self.__class__.__name__)
         self._configs = dict()
         self.defaults(kind)
         self.parser = None
@@ -125,18 +140,25 @@ class Loader(metaclass=SingletonType):
     def defaults(self, kind):
         self.builder = TOMLStrBuilder(kind)
         toml_str = self.builder.build()
-        self.register("reset", tomllib.loads(toml_str))
+        self.register('reset', tomllib.loads(toml_str))
 
     def parse(self, identifier, data):
         if identifier in self._configs:
-            print(f"config file with name {identifier} already in memory, skipping..")
+            self.logger.info(
-            return False
+                f'config file with name {identifier} already in memory, skipping..'
-        self.parser = dataextraction_factory(data)
+            )
+            return
+        try:
+            self.parser = dataextraction_factory(data)
+        except tomllib.TOMLDecodeError as e:
+            ERR_MSG = (str(e), f'When attempting to load {identifier}.toml')
+            self.logger.error(f"{type(e).__name__}: {' '.join(ERR_MSG)}")
+            return
         return True
 
     def register(self, identifier, data=None):
         self._configs[identifier] = data if data else self.parser.data
-        print(f"config {self.name}/{identifier} loaded into memory")
+        self.logger.info(f'config {self.name}/{identifier} loaded into memory')
 
     def deregister(self):
         self._configs.clear()
@@ -159,17 +181,18 @@ def loader(kind):
 
     returns configs loaded into memory
     """
+    logger_loader = logger.getChild('loader')
     loader = Loader(kind)
 
     for path in (
-        Path.cwd() / "configs" / kind.name,
+        Path.cwd() / 'configs' / kind.name,
-        Path(__file__).parent / "configs" / kind.name,
+        Path.home() / '.config' / 'voicemeeter' / kind.name,
-        Path.home() / "Documents/Voicemeeter" / "configs" / kind.name,
+        Path.home() / 'Documents' / 'Voicemeeter' / 'configs' / kind.name,
     ):
         if path.is_dir():
-            print(f"Checking [{path}] for TOML config files:")
+            logger_loader.info(f'Checking [{path}] for TOML config files:')
-            for file in path.glob("*.toml"):
+            for file in path.glob('*.toml'):
-                identifier = file.with_suffix("").stem
+                identifier = file.with_suffix('').stem
                 if loader.parse(identifier, file):
                     loader.register(identifier)
     return loader.configs
@@ -184,5 +207,5 @@ def request_config(kind_id: str):
     try:
         configs = loader(kindmap(kind_id))
     except KeyError as e:
-        print(f"Unknown Voicemeeter kind '{kind_id}'")
+        raise VMError(f'Unknown Voicemeeter kind {kind_id}') from e
     return configs

voicemeeterlib/device.py

@@ -31,8 +31,8 @@ class Adapter(IRemote):
             return self._remote.get_num_devices(direction)
 
         vals = self._remote.get_device_description(index, direction)
-        types = {1: "mme", 3: "wdm", 4: "ks", 5: "asio"}
+        types = {1: 'mme', 3: 'wdm', 4: 'ks', 5: 'asio'}
-        return {"name": vals[0], "type": types[vals[1]], "id": vals[2]}
+        return {'name': vals[0], 'type': types[vals[1]], 'id': vals[2]}
 
 
 class Device(Adapter):
@@ -47,26 +47,26 @@ class Device(Adapter):
         """
 
         def num_ins(cls) -> int:
-            return cls.getter(direction="in")
+            return cls.getter(direction='in')
 
         def num_outs(cls) -> int:
-            return cls.getter(direction="out")
+            return cls.getter(direction='out')
 
         DEVICE_cls = type(
-            f"Device{remote.kind}",
+            f'Device{remote.kind}',
             (cls,),
             {
-                "ins": property(num_ins),
+                'ins': property(num_ins),
-                "outs": property(num_outs),
+                'outs': property(num_outs),
             },
         )
         return DEVICE_cls(remote)
 
     def __str__(self):
-        return f"{type(self).__name__}"
+        return f'{type(self).__name__}'
 
     def input(self, index: int) -> dict:
-        return self.getter(index=index, direction="in")
+        return self.getter(index=index, direction='in')
 
     def output(self, index: int) -> dict:
-        return self.getter(index=index, direction="out")
+        return self.getter(index=index, direction='out')

voicemeeterlib/error.py

@@ -1,16 +1,24 @@
-class InstallError(Exception):
-    """errors related to installation"""
-
-    pass
-
-
-class CAPIError(Exception):
-    """errors related to low-level C API calls"""
-
-    pass
-
-
 class VMError(Exception):
-    """general errors"""
+    """Base voicemeeterlib exception class."""
 
-    pass
+
+class InstallError(VMError):
+    """Exception raised when installation errors occur"""
+
+
+class CAPIError(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
+        if self.code == -9:
+            message = ' '.join(
+                (
+                    f'no bind for {self.fn_name}.',
+                    'are you using an old version of the API?',
+                )
+            )
+        else:
+            message = f'{self.fn_name} returned {self.code}'
+        super().__init__(message)

voicemeeterlib/event.py

@@ -0,0 +1,74 @@
+import logging
+from typing import Iterable, Union
+
+logger = logging.getLogger(__name__)
+
+
+class Event:
+    """Keeps track of event subscriptions"""
+
+    def __init__(self, subs: dict):
+        self.subs = subs
+        self.logger = logger.getChild(self.__class__.__name__)
+
+    def info(self, msg=None):
+        info = (f'{msg} events',) if msg else ()
+        if self.any():
+            info += (f"now listening for {', '.join(self.get())} events",)
+        else:
+            info += ('not listening for any events',)
+        self.logger.info(', '.join(info))
+
+    @property
+    def pdirty(self) -> bool:
+        return self.subs['pdirty']
+
+    @pdirty.setter
+    def pdirty(self, val: bool):
+        self.subs['pdirty'] = val
+        self.info(f"pdirty {'added to' if val else 'removed from'}")
+
+    @property
+    def mdirty(self) -> bool:
+        return self.subs['mdirty']
+
+    @mdirty.setter
+    def mdirty(self, val: bool):
+        self.subs['mdirty'] = val
+        self.info(f"mdirty {'added to' if val else 'removed from'}")
+
+    @property
+    def midi(self) -> bool:
+        return self.subs['midi']
+
+    @midi.setter
+    def midi(self, val: bool):
+        self.subs['midi'] = val
+        self.info(f"midi {'added to' if val else 'removed from'}")
+
+    @property
+    def ldirty(self) -> bool:
+        return self.subs['ldirty']
+
+    @ldirty.setter
+    def ldirty(self, val: bool):
+        self.subs['ldirty'] = val
+        self.info(f"ldirty {'added to' if val else 'removed from'}")
+
+    def get(self) -> list:
+        return [k for k, v in self.subs.items() if v]
+
+    def any(self) -> bool:
+        return any(self.subs.values())
+
+    def add(self, events: Union[str, Iterable[str]]):
+        if isinstance(events, str):
+            events = [events]
+        for event in events:
+            setattr(self, event, True)
+
+    def remove(self, events: Union[str, Iterable[str]]):
+        if isinstance(events, str):
+            events = [events]
+        for event in events:
+            setattr(self, event, False)

voicemeeterlib/factory.py

@@ -1,21 +1,25 @@
+import logging
 from abc import abstractmethod
 from enum import IntEnum
 from functools import cached_property
-from typing import Iterable, NoReturn, Self
+from typing import Iterable
 
 from . import misc
-from .base import Remote
 from .bus import request_bus_obj as bus
 from .command import Command
 from .config import request_config as configs
 from .device import Device
+from .error import VMError
 from .kinds import KindMapClass
 from .kinds import request_kind_map as kindmap
 from .macrobutton import MacroButton
 from .recorder import Recorder
+from .remote import Remote
 from .strip import request_strip_obj as strip
 from .vban import request_vban_obj as vban
 
+logger = logging.getLogger(__name__)
+
 
 class FactoryBuilder:
     """
@@ -25,8 +29,8 @@ class FactoryBuilder:
     """
 
     BuilderProgress = IntEnum(
-        "BuilderProgress",
+        'BuilderProgress',
-        "strip bus command macrobutton vban device option recorder patch fx",
+        'strip bus command macrobutton vban device option recorder patch fx',
         start=0,
     )
 
@@ -34,66 +38,67 @@ class FactoryBuilder:
         self._factory = factory
         self.kind = kind
         self._info = (
-            f"Finished building strips for {self._factory}",
+            f'Finished building strips for {self._factory}',
-            f"Finished building buses for {self._factory}",
+            f'Finished building buses for {self._factory}',
-            f"Finished building commands for {self._factory}",
+            f'Finished building commands for {self._factory}',
-            f"Finished building macrobuttons for {self._factory}",
+            f'Finished building macrobuttons for {self._factory}',
-            f"Finished building vban in/out streams for {self._factory}",
+            f'Finished building vban in/out streams for {self._factory}',
-            f"Finished building device for {self._factory}",
+            f'Finished building device for {self._factory}',
-            f"Finished building option for {self._factory}",
+            f'Finished building option for {self._factory}',
-            f"Finished building recorder for {self._factory}",
+            f'Finished building recorder for {self._factory}',
-            f"Finished building patch for {self._factory}",
+            f'Finished building patch for {self._factory}',
-            f"Finished building fx for {self._factory}",
+            f'Finished building fx for {self._factory}',
         )
+        self.logger = logger.getChild(self.__class__.__name__)
 
-    def _pinfo(self, name: str) -> NoReturn:
+    def _pinfo(self, name: str) -> None:
         """prints progress status for each step"""
-        name = name.split("_")[1]
+        name = name.split('_')[1]
-        print(self._info[int(getattr(self.BuilderProgress, name))])
+        self.logger.debug(self._info[int(getattr(self.BuilderProgress, name))])
 
-    def make_strip(self) -> Self:
+    def make_strip(self):
         self._factory.strip = tuple(
             strip(i < self.kind.phys_in, self._factory, i)
             for i in range(self.kind.num_strip)
         )
         return self
 
-    def make_bus(self) -> Self:
+    def make_bus(self):
         self._factory.bus = tuple(
             bus(i < self.kind.phys_out, self._factory, i)
             for i in range(self.kind.num_bus)
         )
         return self
 
-    def make_command(self) -> Self:
+    def make_command(self):
         self._factory.command = Command.make(self._factory)
         return self
 
-    def make_macrobutton(self) -> Self:
+    def make_macrobutton(self):
         self._factory.button = tuple(MacroButton(self._factory, i) for i in range(80))
         return self
 
-    def make_vban(self) -> Self:
+    def make_vban(self):
         self._factory.vban = vban(self._factory)
         return self
 
-    def make_device(self) -> Self:
+    def make_device(self):
         self._factory.device = Device.make(self._factory)
         return self
 
-    def make_option(self) -> Self:
+    def make_option(self):
         self._factory.option = misc.Option.make(self._factory)
         return self
 
-    def make_recorder(self) -> Self:
+    def make_recorder(self):
         self._factory.recorder = Recorder.make(self._factory)
         return self
 
-    def make_patch(self) -> Self:
+    def make_patch(self):
         self._factory.patch = misc.Patch.make(self._factory)
         return self
 
-    def make_fx(self) -> Self:
+    def make_fx(self):
         self._factory.fx = misc.FX(self._factory)
         return self
 
@@ -102,10 +107,18 @@ class FactoryBase(Remote):
     """Base class for factories, subclasses Remote."""
 
     def __init__(self, kind_id: str, **kwargs):
-        defaultevents = {"pdirty": True, "mdirty": True, "midi": True, "ldirty": False}
+        defaultkwargs = {
-        if "subs" in kwargs:
+            'sync': False,
-            defaultevents = defaultevents | kwargs.pop("subs")
+            'ratelimit': 0.033,
-        defaultkwargs = {"sync": False, "ratelimit": 0.033, "subs": defaultevents}
+            'pdirty': False,
+            'mdirty': False,
+            'midi': False,
+            'ldirty': False,
+            'timeout': 2,
+            'bits': 64,
+        }
+        if 'subs' in kwargs:
+            defaultkwargs |= kwargs.pop('subs')  # for backwards compatibility
         kwargs = defaultkwargs | kwargs
         self.kind = kindmap(kind_id)
         super().__init__(**kwargs)
@@ -122,7 +135,7 @@ class FactoryBase(Remote):
         self._configs = None
 
     def __str__(self) -> str:
-        return f"Voicemeeter {self.kind}"
+        return f'Voicemeeter {self.kind}'
 
     @property
     @abstractmethod
@@ -212,15 +225,15 @@ def remote_factory(kind_id: str, **kwargs) -> Remote:
     Returns a Remote class of a kind
     """
     match kind_id:
-        case "basic":
+        case 'basic':
             _factory = BasicFactory
-        case "banana":
+        case 'banana':
             _factory = BananaFactory
-        case "potato":
+        case 'potato':
             _factory = PotatoFactory
         case _:
             raise ValueError(f"Unknown Voicemeeter kind '{kind_id}'")
-    return type(f"Remote{kind_id.capitalize()}", (_factory,), {})(kind_id, **kwargs)
+    return type(f'Remote{kind_id.capitalize()}', (_factory,), {})(kind_id, **kwargs)
 
 
 def request_remote_obj(kind_id: str, **kwargs) -> Remote:
@@ -229,9 +242,13 @@ def request_remote_obj(kind_id: str, **kwargs) -> Remote:
 
     Returns a reference to a Remote class of a kind
     """
+
+    logger_entry = logger.getChild('request_remote_obj')
+
     REMOTE_obj = None
     try:
         REMOTE_obj = remote_factory(kind_id, **kwargs)
     except (ValueError, TypeError) as e:
-        raise SystemExit(e)
+        logger_entry.exception(f'{type(e).__name__}: {e}')
+        raise VMError(str(e)) from e
     return REMOTE_obj

voicemeeterlib/inst.py

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

voicemeeterlib/iremote.py

@@ -1,6 +1,8 @@
+import logging
 import time
 from abc import ABCMeta, abstractmethod
-from typing import Self
+
+logger = logging.getLogger(__name__)
 
 
 class IRemote(metaclass=ABCMeta):
@@ -13,29 +15,44 @@ class IRemote(metaclass=ABCMeta):
     def __init__(self, remote, index=None):
         self._remote = remote
         self.index = index
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def getter(self, param, **kwargs):
         """Gets a parameter value"""
-        return self._remote.get(f"{self.identifier}.{param}", **kwargs)
+        self.logger.debug(f'getter: {self._cmd(param)}')
+        return self._remote.get(self._cmd(param), **kwargs)
 
     def setter(self, param, val):
         """Sets a parameter value"""
-        self._remote.set(f"{self.identifier}.{param}", val)
+        self.logger.debug(f'setter: {self._cmd(param)}={val}')
+        self._remote.set(self._cmd(param), val)
+
+    def _cmd(self, param):
+        cmd = (self.identifier,)
+        if param:
+            cmd += (f'.{param}',)
+        return ''.join(cmd)
 
     @abstractmethod
     def identifier(self):
         pass
 
-    def apply(self, data: dict) -> Self:
+    def apply(self, data: dict):
         def fget(attr, val):
-            if attr == "mode":
+            if attr == 'mode':
                 return (getattr(self, attr), val, 1)
             return (self, attr, val)
 
         for attr, val in data.items():
-            if hasattr(self, attr):
+            if not isinstance(val, dict):
-                target, attr, val = fget(attr, val)
+                if attr in dir(self):  # avoid calling getattr (with hasattr)
-                setattr(target, attr, val)
+                    target, attr, val = fget(attr, val)
+                    setattr(target, attr, val)
+                else:
+                    self.logger.error(f'invalid attribute {attr} for {self}')
+            else:
+                target = getattr(self, attr)
+                target.apply(val)
         return self
 
     def then_wait(self):

voicemeeterlib/kinds.py

@@ -1,6 +1,8 @@
 from dataclasses import dataclass
 from enum import Enum, unique
 
+from .error import VMError
+
 
 @unique
 class KindId(Enum):
@@ -20,7 +22,7 @@ class SingletonType(type):
         return cls._instances[cls]
 
 
-@dataclass
+@dataclass(frozen=True)
 class KindMapClass(metaclass=SingletonType):
     name: str
     ins: tuple
@@ -28,75 +30,96 @@ class KindMapClass(metaclass=SingletonType):
     vban: tuple
     asio: tuple
     insert: int
+    composite: int
+    strip_channels: int
+    bus_channels: int
+    cells: int
 
     @property
-    def phys_in(self):
+    def phys_in(self) -> int:
         return self.ins[0]
 
     @property
-    def virt_in(self):
+    def virt_in(self) -> int:
         return self.ins[-1]
 
     @property
-    def phys_out(self):
+    def phys_out(self) -> int:
         return self.outs[0]
 
     @property
-    def virt_out(self):
+    def virt_out(self) -> int:
         return self.outs[-1]
 
     @property
-    def num_strip(self):
+    def num_strip(self) -> int:
         return sum(self.ins)
 
     @property
-    def num_bus(self):
+    def num_bus(self) -> int:
         return sum(self.outs)
 
+    @property
+    def num_strip_levels(self) -> int:
+        return 2 * self.phys_in + 8 * self.virt_in
+
+    @property
+    def num_bus_levels(self) -> int:
+        return 8 * (self.phys_out + self.virt_out)
+
     def __str__(self) -> str:
         return self.name.capitalize()
 
 
-@dataclass
+@dataclass(frozen=True)
 class BasicMap(KindMapClass):
-    name: str
     ins: tuple = (2, 1)
     outs: tuple = (1, 1)
-    vban: tuple = (4, 4)
+    vban: tuple = (4, 4, 1, 1)
     asio: tuple = (0, 0)
     insert: int = 0
+    composite: int = 0
+    strip_channels: int = 0
+    bus_channels: int = 0
+    cells: int = 0
 
 
-@dataclass
+@dataclass(frozen=True)
 class BananaMap(KindMapClass):
-    name: str
     ins: tuple = (3, 2)
     outs: tuple = (3, 2)
-    vban: tuple = (8, 8)
+    vban: tuple = (8, 8, 1, 1)
     asio: tuple = (6, 8)
     insert: int = 22
+    composite: int = 8
+    strip_channels: int = 0
+    bus_channels: int = 8
+    cells: int = 6
 
 
-@dataclass
+@dataclass(frozen=True)
 class PotatoMap(KindMapClass):
-    name: str
     ins: tuple = (5, 3)
     outs: tuple = (5, 3)
-    vban: tuple = (8, 8)
+    vban: tuple = (8, 8, 1, 1)
     asio: tuple = (10, 8)
     insert: int = 34
+    composite: int = 8
+    strip_channels: int = 2
+    bus_channels: int = 8
+    cells: int = 6
 
 
 def kind_factory(kind_id):
     match kind_id:
-        case "basic":
+        case 'basic':
             _kind_map = BasicMap
-        case "banana":
+        case 'banana':
             _kind_map = BananaMap
-        case "potato":
+        case 'potato':
             _kind_map = PotatoMap
         case _:
-            raise ValueError(f"Unknown Voicemeeter kind {kind_id}")
+            raise ValueError(f'Unknown Voicemeeter kind {kind_id}')
     return _kind_map(name=kind_id)
 
 
@@ -105,8 +128,8 @@ def request_kind_map(kind_id):
     try:
         KIND_obj = kind_factory(kind_id)
     except ValueError as e:
-        print(e)
+        raise VMError(str(e)) from e
     return KIND_obj
 
 
-kinds_all = list(request_kind_map(kind_id.name.lower()) for kind_id in KindId)
+all = kinds_all = [request_kind_map(kind_id.name.lower()) for kind_id in KindId]

voicemeeterlib/macrobutton.py

@@ -1,6 +1,13 @@
-from .error import VMError
+from enum import IntEnum
+
 from .iremote import IRemote
 
+ButtonModes = IntEnum(
+    'ButtonModes',
+    'state stateonly trigger',
+    start=1,
+)
+
 
 class Adapter(IRemote):
     """Adapter to the common interface."""
@@ -9,9 +16,13 @@ class Adapter(IRemote):
         pass
 
     def getter(self, mode):
+        self.logger.debug(f'getter: button[{self.index}].{ButtonModes(mode).name}')
         return self._remote.get_buttonstatus(self.index, mode)
 
-    def setter(self, val, mode):
+    def setter(self, mode, val):
+        self.logger.debug(
+            f'setter: button[{self.index}].{ButtonModes(mode).name}={val}'
+        )
         self._remote.set_buttonstatus(self.index, val, mode)
 
 
@@ -19,28 +30,28 @@ class MacroButton(Adapter):
     """Defines concrete implementation for macrobutton"""
 
     def __str__(self):
-        return f"{type(self).__name__}{self._remote.kind}{self.index}"
+        return f'{type(self).__name__}{self._remote.kind}{self.index}'
 
     @property
     def state(self) -> bool:
-        return self.getter(1) == 1
+        return self.getter(ButtonModes.state) == 1
 
     @state.setter
-    def state(self, val):
+    def state(self, val: bool):
-        self.setter(1 if val else 0, 1)
+        self.setter(ButtonModes.state, 1 if val else 0)
 
     @property
     def stateonly(self) -> bool:
-        return self.getter(2) == 1
+        return self.getter(ButtonModes.stateonly) == 1
 
     @stateonly.setter
-    def stateonly(self, val):
+    def stateonly(self, val: bool):
-        self.setter(1 if val else 0, 2)
+        self.setter(ButtonModes.stateonly, 1 if val else 0)
 
     @property
     def trigger(self) -> bool:
-        return self.getter(3) == 1
+        return self.getter(ButtonModes.trigger) == 1
 
     @trigger.setter
-    def trigger(self, val):
+    def trigger(self, val: bool):
-        self.setter(1 if val else 0, 3)
+        self.setter(ButtonModes.trigger, 1 if val else 0)

voicemeeterlib/meta.py

@@ -22,8 +22,8 @@ def float_prop(param):
     return property(fget, fset)
 
 
-def action_prop(param, val: int = 1):
+def action_fn(param, val: int = 1):
-    """A param that performs an action"""
+    """meta function that performs an action"""
 
     def fdo(self):
         self.setter(param, val)
@@ -42,3 +42,12 @@ def bus_mode_prop(param):
         self.setter(param, 1 if val else 0)
 
     return property(fget, fset)
+
+
+def device_prop(param):
+    """meta function for strip device parameters"""
+
+    def fset(self, val: str):
+        self.setter(param, val)
+
+    return property(fset=fset)

voicemeeterlib/misc.py

@@ -1,49 +1,48 @@
 from typing import Optional
 
-from .error import VMError
+from . import kinds
 from .iremote import IRemote
-from .kinds import kinds_all
 
 
 class FX(IRemote):
     def __str__(self):
-        return f"{type(self).__name__}"
+        return f'{type(self).__name__}'
 
     @property
     def identifier(self) -> str:
-        return "FX"
+        return 'FX'
 
     @property
     def reverb(self) -> bool:
-        return self.getter("reverb.On") == 1
+        return self.getter('reverb.On') == 1
 
     @reverb.setter
     def reverb(self, val: bool):
-        self.setter("reverb.On", 1 if val else 0)
+        self.setter('reverb.On', 1 if val else 0)
 
     @property
     def reverb_ab(self) -> bool:
-        return self.getter("reverb.ab") == 1
+        return self.getter('reverb.ab') == 1
 
     @reverb_ab.setter
     def reverb_ab(self, val: bool):
-        self.setter("reverb.ab", 1 if val else 0)
+        self.setter('reverb.ab', 1 if val else 0)
 
     @property
     def delay(self) -> bool:
-        return self.getter("delay.On") == 1
+        return self.getter('delay.On') == 1
 
     @delay.setter
     def delay(self, val: bool):
-        self.setter("delay.On", 1 if val else 0)
+        self.setter('delay.On', 1 if val else 0)
 
     @property
     def delay_ab(self) -> bool:
-        return self.getter("delay.ab") == 1
+        return self.getter('delay.ab') == 1
 
     @delay_ab.setter
     def delay_ab(self, val: bool):
-        self.setter("delay.ab", 1 if val else 0)
+        self.setter('delay.ab', 1 if val else 0)
 
 
 class Patch(IRemote):
@@ -58,50 +57,50 @@ class Patch(IRemote):
         """
         ASIO_cls = _make_asio_mixins(remote)[remote.kind.name]
         return type(
-            f"Patch{remote.kind}",
+            f'Patch{remote.kind}',
             (cls, ASIO_cls),
             {
-                "composite": tuple(Composite(remote, i) for i in range(8)),
+                'composite': tuple(Composite(remote, i) for i in range(8)),
-                "insert": tuple(Insert(remote, i) for i in range(remote.kind.insert)),
+                'insert': tuple(Insert(remote, i) for i in range(remote.kind.insert)),
             },
         )(remote)
 
     def __str__(self):
-        return f"{type(self).__name__}"
+        return f'{type(self).__name__}'
 
     @property
     def identifier(self) -> str:
-        return f"patch"
+        return 'patch'
 
     @property
     def postfadercomp(self) -> bool:
-        return self.getter("postfadercomposite") == 1
+        return self.getter('postfadercomposite') == 1
 
     @postfadercomp.setter
     def postfadercomp(self, val: bool):
-        self.setter("postfadercomposite", 1 if val else 0)
+        self.setter('postfadercomposite', 1 if val else 0)
 
     @property
     def postfxinsert(self) -> bool:
-        return self.getter("postfxinsert") == 1
+        return self.getter('postfxinsert') == 1
 
     @postfxinsert.setter
     def postfxinsert(self, val: bool):
-        self.setter("postfxinsert", 1 if val else 0)
+        self.setter('postfxinsert', 1 if val else 0)
 
 
 class Asio(IRemote):
     @property
     def identifier(self) -> str:
-        return f"patch"
+        return 'patch'
 
 
 class AsioIn(Asio):
     def get(self) -> int:
-        return int(self.getter(f"asio[{self.index}]"))
+        return int(self.getter(f'asio[{self.index}]'))
 
     def set(self, val: int):
-        self.setter(f"asio[{self.index}]", val)
+        self.setter(f'asio[{self.index}]', val)
 
 
 class AsioOut(Asio):
@@ -110,10 +109,10 @@ class AsioOut(Asio):
         self._param = param
 
     def get(self) -> int:
-        return int(self.getter(f"out{self._param}[{self.index}]"))
+        return int(self.getter(f'out{self._param}[{self.index}]'))
 
     def set(self, val: int):
-        self.setter(f"out{self._param}[{self.index}]", val)
+        self.setter(f'out{self._param}[{self.index}]', val)
 
 
 def _make_asio_mixin(remote, kind):
@@ -121,46 +120,46 @@ def _make_asio_mixin(remote, kind):
     asio_in, asio_out = kind.asio
 
     return type(
-        f"ASIO{kind}",
+        f'ASIO{kind}',
         (IRemote,),
         {
-            "asio": tuple(AsioIn(remote, i) for i in range(asio_in)),
+            'asio': tuple(AsioIn(remote, i) for i in range(asio_in)),
             **{
                 param: tuple(AsioOut(remote, i, param) for i in range(asio_out))
-                for param in ["A2", "A3", "A4", "A5"]
+                for param in ['A2', 'A3', 'A4', 'A5']
             },
         },
     )
 
 
 def _make_asio_mixins(remote):
-    return {kind.name: _make_asio_mixin(remote, kind) for kind in kinds_all}
+    return {kind.name: _make_asio_mixin(remote, kind) for kind in kinds.all}
 
 
 class Composite(IRemote):
     @property
     def identifier(self) -> str:
-        return "patch"
+        return 'patch'
 
     def get(self) -> int:
-        return int(self.getter(f"composite[{self.index}]"))
+        return int(self.getter(f'composite[{self.index}]'))
 
     def set(self, val: int):
-        self.setter(f"composite[{self.index}]", val)
+        self.setter(f'composite[{self.index}]', val)
 
 
 class Insert(IRemote):
     @property
     def identifier(self) -> str:
-        return "patch"
+        return 'patch'
 
     @property
     def on(self) -> bool:
-        return self.getter(f"insert[{self.index}]") == 1
+        return self.getter(f'insert[{self.index}]') == 1
 
     @on.setter
     def on(self, val: bool):
-        self.setter(f"insert[{self.index}]", 1 if val else 0)
+        self.setter(f'insert[{self.index}]', 1 if val else 0)
 
 
 class Option(IRemote):
@@ -174,61 +173,61 @@ class Option(IRemote):
         Returns a Option class of a kind.
         """
         return type(
-            f"Option{remote.kind}",
+            f'Option{remote.kind}',
             (cls,),
             {
-                "delay": tuple(Delay(remote, i) for i in range(remote.kind.phys_out)),
+                'delay': tuple(Delay(remote, i) for i in range(remote.kind.phys_out)),
             },
         )(remote)
 
     def __str__(self):
-        return f"{type(self).__name__}"
+        return f'{type(self).__name__}'
 
     @property
     def identifier(self) -> str:
-        return "option"
+        return 'option'
 
     @property
     def sr(self) -> int:
-        return int(self.getter("sr"))
+        return int(self.getter('sr'))
 
     @sr.setter
     def sr(self, val: int):
         opts = (44100, 48000, 88200, 96000, 176400, 192000)
         if val not in opts:
-            raise VMError(f"Expected one of: {opts}")
+            self.logger.warning(f'sr got: {val} but expected a value in {opts}')
-        self.setter("sr", val)
+        self.setter('sr', val)
 
     @property
     def asiosr(self) -> bool:
-        return self.getter("asiosr") == 1
+        return self.getter('asiosr') == 1
 
     @asiosr.setter
     def asiosr(self, val: bool):
-        self.setter("asiosr", 1 if val else 0)
+        self.setter('asiosr', 1 if val else 0)
 
     @property
     def monitoronsel(self) -> bool:
-        return self.getter("monitoronsel") == 1
+        return self.getter('monitoronsel') == 1
 
     @monitoronsel.setter
     def monitoronsel(self, val: bool):
-        self.setter("monitoronsel", 1 if val else 0)
+        self.setter('monitoronsel', 1 if val else 0)
 
     def buffer(self, driver, buffer):
-        self.setter(f"buffer.{driver}", buffer)
+        self.setter(f'buffer.{driver}', buffer)
 
 
 class Delay(IRemote):
     @property
     def identifier(self) -> str:
-        return "option"
+        return 'option'
 
     def get(self) -> int:
-        return int(self.getter(f"delay[{self.index}]"))
+        return int(self.getter(f'delay[{self.index}]'))
 
     def set(self, val: int):
-        self.setter(f"delay[{self.index}]", val)
+        self.setter(f'delay[{self.index}]', val)
 
 
 class Midi:
@@ -252,43 +251,17 @@ class Midi:
         self.cache[key] = velocity
 
 
-class Event:
+class VmGui:
-    def __init__(self, subs: dict):
+    _launched = None
-        self.subs = subs
-
-    def info(self, msg):
-        info = (
-            f"{msg} events",
-            f"Now listening for {', '.join(self.get())} events",
-        )
-        print("\n".join(info))
 
     @property
-    def pdirty(self):
+    def launched(self) -> bool:
-        return self.subs["pdirty"]
+        return self._launched
+
+    @launched.setter
+    def launched(self, val: bool):
+        self._launched = val
 
     @property
-    def mdirty(self):
+    def launched_by_api(self):
-        return self.subs["mdirty"]
+        return not self.launched
-
-    @property
-    def midi(self):
-        return self.subs["midi"]
-
-    @property
-    def ldirty(self):
-        return self.subs["ldirty"]
-
-    def get(self) -> list:
-        return [k for k, v in self.subs.items() if v]
-
-    def any(self) -> bool:
-        return any(self.subs.values())
-
-    def add(self, event):
-        self.subs[event] = True
-        self.info(f"{event} added to")
-
-    def remove(self, event):
-        self.subs[event] = False
-        self.info(f"{event} removed from")

voicemeeterlib/recorder.py

@@ -1,7 +1,9 @@
+import re
+
+from . import kinds
 from .error import VMError
 from .iremote import IRemote
-from .kinds import kinds_all
+from .meta import action_fn, bool_prop
-from .meta import action_prop, bool_prop
 
 
 class Recorder(IRemote):
@@ -19,57 +21,222 @@ class Recorder(IRemote):
         Returns a Recorder class of a kind.
         """
         CHANNELOUTMIXIN_cls = _make_channelout_mixins[remote.kind.name]
+        ARMCHANNELMIXIN_cls = _make_armchannel_mixins(remote)[remote.kind.name]
         REC_cls = type(
-            f"Recorder{remote.kind}",
+            f'Recorder{remote.kind}',
-            (cls, CHANNELOUTMIXIN_cls),
+            (cls, CHANNELOUTMIXIN_cls, ARMCHANNELMIXIN_cls),
             {
                 **{
-                    param: action_prop(param)
+                    param: action_fn(param)
                     for param in [
-                        "play",
+                        'play',
-                        "stop",
+                        'stop',
-                        "pause",
+                        'pause',
-                        "replay",
+                        'replay',
-                        "record",
+                        'record',
-                        "ff",
+                        'ff',
-                        "rew",
+                        'rew',
                     ]
                 },
+                'mode': RecorderMode(remote),
             },
         )
         return REC_cls(remote)
 
     def __str__(self):
-        return f"{type(self).__name__}"
+        return f'{type(self).__name__}'
 
     @property
     def identifier(self) -> str:
-        return "recorder"
+        return 'recorder'
+
+    @property
+    def samplerate(self) -> int:
+        return int(self.getter('samplerate'))
+
+    @samplerate.setter
+    def samplerate(self, val: int):
+        opts = (22050, 24000, 32000, 44100, 48000, 88200, 96000, 176400, 192000)
+        if val not in opts:
+            self.logger.warning(f'samplerate got: {val} but expected a value in {opts}')
+        self.setter('samplerate', val)
+
+    @property
+    def bitresolution(self) -> int:
+        return int(self.getter('bitresolution'))
+
+    @bitresolution.setter
+    def bitresolution(self, val: int):
+        opts = (8, 16, 24, 32)
+        if val not in opts:
+            self.logger.warning(
+                f'bitresolution got: {val} but expected a value in {opts}'
+            )
+        self.setter('bitresolution', val)
+
+    @property
+    def channel(self) -> int:
+        return int(self.getter('channel'))
+
+    @channel.setter
+    def channel(self, val: int):
+        if not 1 <= val <= 8:
+            self.logger.warning(f'channel got: {val} but expected a value from 1 to 8')
+        self.setter('channel', val)
+
+    @property
+    def kbps(self):
+        return int(self.getter('kbps'))
+
+    @kbps.setter
+    def kbps(self, val: int):
+        opts = (32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320)
+        if val not in opts:
+            self.logger.warning(f'kbps got: {val} but expected a value in {opts}')
+        self.setter('kbps', val)
+
+    @property
+    def gain(self) -> float:
+        return round(self.getter('gain'), 1)
+
+    @gain.setter
+    def gain(self, val: float):
+        self.setter('gain', val)
 
     def load(self, file: str):
         try:
-            self.setter("load", file)
+            self.setter('load', file)
         except UnicodeError:
-            raise VMError("File full directory must be a raw string")
+            raise VMError('File full directory must be a raw string')
 
-    def set_loop(self, val: bool):
+    # loop forwarder methods, for backwards compatibility
-        self.setter("mode.loop", 1 if val else 0)
+    @property
+    def loop(self):
+        return self.mode.loop
 
-    loop = property(fset=set_loop)
+    @loop.setter
+    def loop(self, val: bool):
+        self.mode.loop = val
+
+    def goto(self, time_str):
+        def get_sec():
+            """Get seconds from time string"""
+            h, m, s = time_str.split(':')
+            return int(h) * 3600 + int(m) * 60 + int(s)
+
+        time_str = str(time_str)  # coerce the type
+        if (
+            re.match(
+                r'^(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)$',
+                time_str,
+            )
+            is not None
+        ):
+            self.setter('goto', get_sec())
+        else:
+            self.logger.warning(
+                "goto expects a string that matches the format 'hh:mm:ss'"
+            )
+
+    def filetype(self, val: str):
+        opts = {'wav': 1, 'aiff': 2, 'bwf': 3, 'mp3': 100}
+        try:
+            self.setter('filetype', opts[val.lower()])
+        except KeyError:
+            self.logger.warning(
+                f'filetype got: {val} but expected a value in {list(opts.keys())}'
+            )
+
+
+class RecorderMode(IRemote):
+    @property
+    def identifier(self):
+        return 'recorder.mode'
+
+    @property
+    def recbus(self) -> bool:
+        return self.getter('recbus') == 1
+
+    @recbus.setter
+    def recbus(self, val: bool):
+        self.setter('recbus', 1 if val else 0)
+
+    @property
+    def playonload(self) -> bool:
+        return self.getter('playonload') == 1
+
+    @playonload.setter
+    def playonload(self, val: bool):
+        self.setter('playonload', 1 if val else 0)
+
+    @property
+    def loop(self) -> bool:
+        return self.getter('loop') == 1
+
+    @loop.setter
+    def loop(self, val: bool):
+        self.setter('loop', 1 if val else 0)
+
+    @property
+    def multitrack(self) -> bool:
+        return self.getter('multitrack') == 1
+
+    @multitrack.setter
+    def multitrack(self, val: bool):
+        self.setter('multitrack', 1 if val else 0)
+
+
+class RecorderArmChannel(IRemote):
+    def __init__(self, remote, i):
+        super().__init__(remote)
+        self._i = i
+
+    def set(self, val: bool):
+        self.setter('', 1 if val else 0)
+
+
+class RecorderArmStrip(RecorderArmChannel):
+    @property
+    def identifier(self):
+        return f'recorder.armstrip[{self._i}]'
+
+
+class RecorderArmBus(RecorderArmChannel):
+    @property
+    def identifier(self):
+        return f'recorder.armbus[{self._i}]'
+
+
+def _make_armchannel_mixin(remote, kind):
+    """Creates an armchannel out mixin"""
+    return type(
+        f'ArmChannelMixin{kind}',
+        (),
+        {
+            'armstrip': tuple(
+                RecorderArmStrip(remote, i) for i in range(kind.num_strip)
+            ),
+            'armbus': tuple(RecorderArmBus(remote, i) for i in range(kind.num_bus)),
+        },
+    )
+
+
+def _make_armchannel_mixins(remote):
+    return {kind.name: _make_armchannel_mixin(remote, kind) for kind in kinds.all}
 
 
 def _make_channelout_mixin(kind):
-    """Creates a channel out property mixin"""
+    """Creates a channel out mixin"""
     return type(
-        f"ChannelOutMixin{kind}",
+        f'ChannelOutMixin{kind}',
         (),
         {
-            **{f"A{i}": bool_prop(f"A{i}") for i in range(1, kind.phys_out + 1)},
+            **{f'A{i}': bool_prop(f'A{i}') for i in range(1, kind.phys_out + 1)},
-            **{f"B{i}": bool_prop(f"B{i}") for i in range(1, kind.virt_out + 1)},
+            **{f'B{i}': bool_prop(f'B{i}') for i in range(1, kind.virt_out + 1)},
         },
     )
 
 
 _make_channelout_mixins = {
-    kind.name: _make_channelout_mixin(kind) for kind in kinds_all
+    kind.name: _make_channelout_mixin(kind) for kind in kinds.all
 }

voicemeeterlib/remote.py

@@ -0,0 +1,348 @@
+import ctypes as ct
+import logging
+import threading
+import time
+from abc import abstractmethod
+from queue import Queue
+from typing import Iterable, Optional, Union
+
+from .cbindings import CBindings
+from .error import CAPIError, VMError
+from .event import Event
+from .inst import BITS
+from .kinds import KindId
+from .misc import Midi, VmGui
+from .subject import Subject
+from .updater import Producer, Updater
+from .util import deep_merge, grouper, polling, script, timeout
+
+logger = logging.getLogger(__name__)
+
+
+class Remote(CBindings):
+    """Base class responsible for wrapping the C Remote API"""
+
+    DELAY = 0.001
+
+    def __init__(self, **kwargs):
+        self.strip_mode = 0
+        self.cache = {}
+        self.midi = Midi()
+        self.subject = self.observer = Subject()
+        self.event = Event(
+            {k: kwargs.pop(k) for k in ('pdirty', 'mdirty', 'midi', 'ldirty')}
+        )
+        self.gui = VmGui()
+        self.stop_event = None
+        self.logger = logger.getChild(self.__class__.__name__)
+
+        for attr, val in kwargs.items():
+            setattr(self, attr, val)
+
+        if self.bits not in (32, 64):
+            self.logger.warning(
+                f'kwarg bits got {self.bits}, expected either 32 or 64, defaulting to 64'
+            )
+            self.bits = 64
+
+    def __enter__(self):
+        """setup procedures"""
+        self.login()
+        if self.event.any():
+            self.init_thread()
+        return self
+
+    @abstractmethod
+    def __str__(self):
+        """Ensure subclasses override str magic method"""
+        pass
+
+    def init_thread(self):
+        """Starts updates thread."""
+        self.event.info()
+
+        self.logger.debug('initiating events thread')
+        self.stop_event = threading.Event()
+        self.stop_event.clear()
+        queue = Queue()
+        self.updater = Updater(self, queue)
+        self.updater.start()
+        self.producer = Producer(self, queue, self.stop_event)
+        self.producer.start()
+
+    def stopped(self):
+        return self.stop_event is None or self.stop_event.is_set()
+
+    @timeout
+    def login(self) -> None:
+        """Login to the API, initialize dirty parameters"""
+        self.gui.launched = self.call(self.bind_login, ok=(0, 1)) == 0
+        if not self.gui.launched:
+            self.logger.info(
+                'Voicemeeter engine running but GUI not launched. Launching the GUI now.'
+            )
+            self.run_voicemeeter(self.kind.name)
+
+    def run_voicemeeter(self, kind_id: str) -> None:
+        if kind_id not in (kind.name.lower() for kind in KindId):
+            raise VMError(f"Unexpected Voicemeeter type: '{kind_id}'")
+        value = KindId[kind_id.upper()].value
+        if BITS == 64 and self.bits == 64:
+            value += 3
+        self.call(self.bind_run_voicemeeter, value)
+
+    @property
+    def type(self) -> str:
+        """Returns the type of Voicemeeter installation (basic, banana, potato)."""
+        type_ = ct.c_long()
+        self.call(self.bind_get_voicemeeter_type, ct.byref(type_))
+        return KindId(type_.value).name.lower()
+
+    @property
+    def version(self) -> str:
+        """Returns Voicemeeter's version as a string"""
+        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,
+        )
+
+    @property
+    def pdirty(self) -> bool:
+        """True iff UI parameters have been updated."""
+        return self.call(self.bind_is_parameters_dirty, ok=(0, 1)) == 1
+
+    @property
+    def mdirty(self) -> bool:
+        """True iff MB parameters have been updated."""
+        try:
+            return self.call(self.bind_macro_button_is_dirty, ok=(0, 1)) == 1
+        except AttributeError as e:
+            self.logger.exception(f'{type(e).__name__}: {e}')
+            raise CAPIError('VBVMR_MacroButton_IsDirty', -9) from e
+
+    @property
+    def ldirty(self) -> bool:
+        """True iff levels have been updated."""
+        self._strip_buf, self._bus_buf = self._get_levels()
+        return not (
+            self.cache.get('strip_level') == self._strip_buf
+            and self.cache.get('bus_level') == self._bus_buf
+        )
+
+    def clear_dirty(self) -> None:
+        try:
+            while self.pdirty or self.mdirty:
+                pass
+        except CAPIError as e:
+            if not (e.fn_name == 'VBVMR_MacroButton_IsDirty' and e.code == -9):
+                raise
+            self.logger.error(f'{e} clearing pdirty only.')
+            while self.pdirty:
+                pass
+
+    @polling
+    def get(self, param: str, is_string: Optional[bool] = False) -> Union[str, float]:
+        """Gets a string or float parameter"""
+        if is_string:
+            buf = ct.create_unicode_buffer(512)
+            self.call(self.bind_get_parameter_string_w, param.encode(), ct.byref(buf))
+        else:
+            buf = ct.c_float()
+            self.call(self.bind_get_parameter_float, param.encode(), ct.byref(buf))
+        return buf.value
+
+    def set(self, param: str, val: Union[str, float]) -> None:
+        """Sets a string or float parameter. Caches value"""
+        if isinstance(val, str):
+            if len(val) >= 512:
+                raise VMError('String is too long')
+            self.call(
+                self.bind_set_parameter_string_w, param.encode(), ct.c_wchar_p(val)
+            )
+        else:
+            self.call(
+                self.bind_set_parameter_float, param.encode(), ct.c_float(float(val))
+            )
+        self.cache[param] = val
+
+    @polling
+    def get_buttonstatus(self, id_: int, mode: int) -> int:
+        """Gets a macrobutton parameter"""
+        c_state = ct.c_float()
+        try:
+            self.call(
+                self.bind_macro_button_get_status,
+                ct.c_long(id_),
+                ct.byref(c_state),
+                ct.c_long(mode),
+            )
+        except AttributeError as e:
+            self.logger.exception(f'{type(e).__name__}: {e}')
+            raise CAPIError('VBVMR_MacroButton_GetStatus', -9) from e
+        return int(c_state.value)
+
+    def set_buttonstatus(self, id_: int, val: int, mode: int) -> None:
+        """Sets a macrobutton parameter. Caches value"""
+        c_state = ct.c_float(float(val))
+        try:
+            self.call(
+                self.bind_macro_button_set_status,
+                ct.c_long(id_),
+                c_state,
+                ct.c_long(mode),
+            )
+        except AttributeError as e:
+            self.logger.exception(f'{type(e).__name__}: {e}')
+            raise CAPIError('VBVMR_MacroButton_SetStatus', -9) from e
+        self.cache[f'mb_{id_}_{mode}'] = int(c_state.value)
+
+    def get_num_devices(self, direction: str = None) -> int:
+        """Retrieves number of physical devices connected"""
+        if direction not in ('in', 'out'):
+            raise VMError('Expected a direction: in or out')
+        func = getattr(self, f'bind_{direction}put_get_device_number')
+        res = self.call(func, ok_exp=lambda r: r >= 0)
+        return res
+
+    def get_device_description(self, index: int, direction: str = None) -> tuple:
+        """Returns a tuple of device parameters"""
+        if direction not in ('in', 'out'):
+            raise VMError('Expected a direction: in or out')
+        type_ = ct.c_long()
+        name = ct.create_unicode_buffer(256)
+        hwid = ct.create_unicode_buffer(256)
+        func = getattr(self, f'bind_{direction}put_get_device_desc_w')
+        self.call(
+            func,
+            ct.c_long(index),
+            ct.byref(type_),
+            ct.byref(name),
+            ct.byref(hwid),
+        )
+        return (name.value, type_.value, hwid.value)
+
+    def get_level(self, type_: int, index: int) -> float:
+        """Retrieves a single level value"""
+        val = ct.c_float()
+        self.call(
+            self.bind_get_level, ct.c_long(type_), ct.c_long(index), ct.byref(val)
+        )
+        return val.value
+
+    def _get_levels(self) -> Iterable:
+        """
+        returns both level arrays (strip_levels, bus_levels) BEFORE math conversion
+        """
+        return (
+            tuple(
+                self.get_level(self.strip_mode, i)
+                for i in range(self.kind.num_strip_levels)
+            ),
+            tuple(self.get_level(3, i) for i in range(self.kind.num_bus_levels)),
+        )
+
+    def get_midi_message(self):
+        n = ct.c_long(1024)
+        buf = ct.create_string_buffer(1024)
+        res = self.call(
+            self.bind_get_midi_message,
+            ct.byref(buf),
+            n,
+            ok=(-5, -6),  # no data received from midi device
+            ok_exp=lambda r: r >= 0,
+        )
+        if res > 0:
+            vals = tuple(
+                grouper(3, (int.from_bytes(buf[i], 'little') for i in range(res)))
+            )
+            for msg in vals:
+                ch, pitch, vel = msg
+                if not self.midi._channel or self.midi._channel != ch:
+                    self.midi._channel = ch
+                self.midi._most_recent = pitch
+                self.midi._set(pitch, vel)
+            return True
+
+    @script
+    def sendtext(self, script: str):
+        """Sets many parameters from a script"""
+        if len(script) > 48000:
+            raise ValueError('Script too large, max size 48kB')
+        self.call(self.bind_set_parameters, script.encode())
+        time.sleep(self.DELAY * 5)
+
+    def apply(self, data: dict):
+        """
+        Sets all parameters of a dict
+
+        minor delay between each recursion
+        """
+
+        def target(key):
+            match key.split('-'):
+                case ['strip' | 'bus' | 'button' as kls, index] if index.isnumeric():
+                    target = getattr(self, kls)
+                case [
+                    'vban',
+                    'in'
+                    | 'instream'
+                    | 'out'
+                    | 'outstream' as direction,
+                    index,
+                ] if index.isnumeric():
+                    target = getattr(
+                        self.vban, f"{direction.removesuffix('stream')}stream"
+                    )
+                case _:
+                    ERR_MSG = f"invalid config key '{key}'"
+                    self.logger.error(ERR_MSG)
+                    raise ValueError(ERR_MSG)
+            return target[int(index)]
+
+        [target(key).apply(di).then_wait() for key, di in data.items()]
+
+    def apply_config(self, name):
+        """applies a config from memory"""
+        ERR_MSG = (
+            f"No config with name '{name}' is loaded into memory",
+            f'Known configs: {list(self.configs.keys())}',
+        )
+        try:
+            config = self.configs[name]
+        except KeyError as e:
+            self.logger.error(('\n').join(ERR_MSG))
+            raise VMError(('\n').join(ERR_MSG)) from e
+
+        if 'extends' in config:
+            extended = config['extends']
+            config = {
+                k: v
+                for k, v in deep_merge(self.configs[extended], config)
+                if k not in ('extends')
+            }
+            self.logger.debug(
+                f"profile '{name}' extends '{extended}', profiles merged.."
+            )
+        self.apply(config)
+        self.logger.info(f"Profile '{name}' applied!")
+
+    def end_thread(self):
+        if not self.stopped():
+            self.logger.debug('events thread shutdown started')
+            self.stop_event.set()
+            self.producer.join()  # wait for producer thread to complete cycle
+
+    def logout(self) -> None:
+        """Logout of the API"""
+        time.sleep(0.1)
+        self.call(self.bind_logout)
+        self.logger.info(f'{type(self).__name__}: Successfully logged out of {self}')
+
+    def __exit__(self, exc_type, exc_value, exc_traceback) -> None:
+        """teardown procedures"""
+        self.end_thread()
+        self.logout()

voicemeeterlib/strip.py

@@ -3,9 +3,9 @@ from abc import abstractmethod
 from math import log
 from typing import Union
 
+from . import kinds
 from .iremote import IRemote
-from .kinds import kinds_all
+from .meta import bool_prop, device_prop, float_prop
-from .meta import bool_prop, float_prop
 
 
 class Strip(IRemote):
@@ -21,167 +21,479 @@ class Strip(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"strip[{self.index}]"
+        return f'strip[{self.index}]'
 
     @property
     def mono(self) -> bool:
-        return self.getter("mono") == 1
+        return self.getter('mono') == 1
 
     @mono.setter
     def mono(self, val: bool):
-        self.setter("mono", 1 if val else 0)
+        self.setter('mono', 1 if val else 0)
 
     @property
     def solo(self) -> bool:
-        return self.getter("solo") == 1
+        return self.getter('solo') == 1
 
     @solo.setter
     def solo(self, val: bool):
-        self.setter("solo", 1 if val else 0)
+        self.setter('solo', 1 if val else 0)
 
     @property
     def mute(self) -> bool:
-        return self.getter("mute") == 1
+        return self.getter('mute') == 1
 
     @mute.setter
     def mute(self, val: bool):
-        self.setter("mute", 1 if val else 0)
+        self.setter('mute', 1 if val else 0)
 
     @property
     def limit(self) -> int:
-        return int(self.getter("limit"))
+        return int(self.getter('limit'))
 
     @limit.setter
     def limit(self, val: int):
-        self.setter("limit", val)
+        self.setter('limit', val)
 
     @property
     def label(self) -> str:
-        return self.getter("Label", is_string=True)
+        return self.getter('Label', is_string=True)
 
     @label.setter
     def label(self, val: str):
-        self.setter("Label", str(val))
+        self.setter('Label', str(val))
 
     @property
     def gain(self) -> float:
-        return round(self.getter("gain"), 1)
+        return round(self.getter('gain'), 1)
 
     @gain.setter
     def gain(self, val: float):
-        self.setter("gain", val)
+        self.setter('gain', val)
 
     def fadeto(self, target: float, time_: int):
-        self.setter("FadeTo", f"({target}, {time_})")
+        self.setter('FadeTo', f'({target}, {time_})')
         time.sleep(self._remote.DELAY)
 
     def fadeby(self, change: float, time_: int):
-        self.setter("FadeBy", f"({change}, {time_})")
+        self.setter('FadeBy', f'({change}, {time_})')
         time.sleep(self._remote.DELAY)
 
 
 class PhysicalStrip(Strip):
     @classmethod
-    def make(cls, kind):
+    def make(cls, remote, i, is_phys):
         """
         Factory method for PhysicalStrip.
 
         Returns a PhysicalStrip class.
         """
-        EFFECTS_cls = _make_effects_mixins[kind.name]
+        EFFECTS_cls = _make_effects_mixins(is_phys)[remote.kind.name]
-        return type(f"PhysicalStrip", (cls, EFFECTS_cls), {})
+        return type(
+            'PhysicalStrip',
+            (cls, EFFECTS_cls),
+            {
+                'comp': StripComp(remote, i),
+                'gate': StripGate(remote, i),
+                'denoiser': StripDenoiser(remote, i),
+                'eq': StripEQ.make(remote, i),
+                'device': StripDevice.make(remote, i),
+            },
+        )
 
     def __str__(self):
-        return f"{type(self).__name__}{self.index}"
+        return f'{type(self).__name__}{self.index}'
-
-    @property
-    def comp(self) -> float:
-        return round(self.getter("Comp"), 1)
-
-    @comp.setter
-    def comp(self, val: float):
-        self.setter("Comp", val)
-
-    @property
-    def gate(self) -> float:
-        return round(self.getter("Gate"), 1)
-
-    @gate.setter
-    def gate(self, val: float):
-        self.setter("Gate", val)
 
     @property
     def audibility(self) -> float:
-        return round(self.getter("audibility"), 1)
+        return round(self.getter('audibility'), 1)
 
     @audibility.setter
     def audibility(self, val: float):
-        self.setter("audibility", val)
+        self.setter('audibility', val)
+
+
+class StripComp(IRemote):
+    @property
+    def identifier(self) -> str:
+        return f'Strip[{self.index}].comp'
 
     @property
-    def device(self):
+    def knob(self) -> float:
-        return self.getter("device.name", is_string=True)
+        return round(self.getter(''), 1)
+
+    @knob.setter
+    def knob(self, val: float):
+        self.setter('', val)
 
     @property
-    def sr(self):
+    def gainin(self) -> float:
-        return int(self.getter("device.sr"))
+        return round(self.getter('GainIn'), 1)
+
+    @gainin.setter
+    def gainin(self, val: float):
+        self.setter('GainIn', val)
+
+    @property
+    def ratio(self) -> float:
+        return round(self.getter('Ratio'), 1)
+
+    @ratio.setter
+    def ratio(self, val: float):
+        self.setter('Ratio', val)
+
+    @property
+    def threshold(self) -> float:
+        return round(self.getter('Threshold'), 1)
+
+    @threshold.setter
+    def threshold(self, val: float):
+        self.setter('Threshold', val)
+
+    @property
+    def attack(self) -> float:
+        return round(self.getter('Attack'), 1)
+
+    @attack.setter
+    def attack(self, val: float):
+        self.setter('Attack', val)
+
+    @property
+    def release(self) -> float:
+        return round(self.getter('Release'), 1)
+
+    @release.setter
+    def release(self, val: float):
+        self.setter('Release', val)
+
+    @property
+    def knee(self) -> float:
+        return round(self.getter('Knee'), 2)
+
+    @knee.setter
+    def knee(self, val: float):
+        self.setter('Knee', val)
+
+    @property
+    def gainout(self) -> float:
+        return round(self.getter('GainOut'), 1)
+
+    @gainout.setter
+    def gainout(self, val: float):
+        self.setter('GainOut', val)
+
+    @property
+    def makeup(self) -> bool:
+        return self.getter('makeup') == 1
+
+    @makeup.setter
+    def makeup(self, val: bool):
+        self.setter('makeup', 1 if val else 0)
+
+
+class StripGate(IRemote):
+    @property
+    def identifier(self) -> str:
+        return f'Strip[{self.index}].gate'
+
+    @property
+    def knob(self) -> float:
+        return round(self.getter(''), 1)
+
+    @knob.setter
+    def knob(self, val: float):
+        self.setter('', val)
+
+    @property
+    def threshold(self) -> float:
+        return round(self.getter('Threshold'), 1)
+
+    @threshold.setter
+    def threshold(self, val: float):
+        self.setter('Threshold', val)
+
+    @property
+    def damping(self) -> float:
+        return round(self.getter('Damping'), 1)
+
+    @damping.setter
+    def damping(self, val: float):
+        self.setter('Damping', val)
+
+    @property
+    def bpsidechain(self) -> int:
+        return int(self.getter('BPSidechain'))
+
+    @bpsidechain.setter
+    def bpsidechain(self, val: int):
+        self.setter('BPSidechain', val)
+
+    @property
+    def attack(self) -> float:
+        return round(self.getter('Attack'), 1)
+
+    @attack.setter
+    def attack(self, val: float):
+        self.setter('Attack', val)
+
+    @property
+    def hold(self) -> float:
+        return round(self.getter('Hold'), 1)
+
+    @hold.setter
+    def hold(self, val: float):
+        self.setter('Hold', val)
+
+    @property
+    def release(self) -> float:
+        return round(self.getter('Release'), 1)
+
+    @release.setter
+    def release(self, val: float):
+        self.setter('Release', val)
+
+
+class StripDenoiser(IRemote):
+    @property
+    def identifier(self) -> str:
+        return f'Strip[{self.index}].denoiser'
+
+    @property
+    def knob(self) -> float:
+        return round(self.getter(''), 1)
+
+    @knob.setter
+    def knob(self, val: float):
+        self.setter('', val)
+
+
+class StripEQ(IRemote):
+    @classmethod
+    def make(cls, remote, i):
+        """
+        Factory method for Strip EQ.
+
+        Returns a StripEQ class.
+        """
+        STRIPEQ_cls = type(
+            'StripEQ',
+            (cls,),
+            {
+                'channel': tuple(
+                    StripEQCh.make(remote, i, j)
+                    for j in range(remote.kind.strip_channels)
+                )
+            },
+        )
+        return STRIPEQ_cls(remote, i)
+
+    @property
+    def identifier(self) -> str:
+        return f'Strip[{self.index}].eq'
+
+    @property
+    def on(self) -> bool:
+        return self.getter('on') == 1
+
+    @on.setter
+    def on(self, val: bool):
+        self.setter('on', 1 if val else 0)
+
+    @property
+    def ab(self) -> bool:
+        return self.getter('ab') == 1
+
+    @ab.setter
+    def ab(self, val: bool):
+        self.setter('ab', 1 if val else 0)
+
+
+class StripEQCh(IRemote):
+    @classmethod
+    def make(cls, remote, i, j):
+        """
+        Factory method for Strip EQ channel.
+
+        Returns a StripEQCh class.
+        """
+        StripEQCh_cls = type(
+            'StripEQCh',
+            (cls,),
+            {
+                'cell': tuple(
+                    StripEQChCell(remote, i, j, k) for k in range(remote.kind.cells)
+                )
+            },
+        )
+        return StripEQCh_cls(remote, i, j)
+
+    def __init__(self, remote, i, j):
+        super().__init__(remote, i)
+        self.channel_index = j
+
+    @property
+    def identifier(self) -> str:
+        return f'Strip[{self.index}].eq.channel[{self.channel_index}]'
+
+
+class StripEQChCell(IRemote):
+    def __init__(self, remote, i, j, k):
+        super().__init__(remote, i)
+        self.channel_index = j
+        self.cell_index = k
+
+    @property
+    def identifier(self) -> str:
+        return f'Strip[{self.index}].eq.channel[{self.channel_index}].cell[{self.cell_index}]'
+
+    @property
+    def on(self) -> bool:
+        return self.getter('on') == 1
+
+    @on.setter
+    def on(self, val: bool):
+        self.setter('on', 1 if val else 0)
+
+    @property
+    def type(self) -> int:
+        return int(self.getter('type'))
+
+    @type.setter
+    def type(self, val: int):
+        self.setter('type', val)
+
+    @property
+    def f(self) -> float:
+        return round(self.getter('f'), 1)
+
+    @f.setter
+    def f(self, val: float):
+        self.setter('f', val)
+
+    @property
+    def gain(self) -> float:
+        return round(self.getter('gain'), 1)
+
+    @gain.setter
+    def gain(self, val: float):
+        self.setter('gain', val)
+
+    @property
+    def q(self) -> float:
+        return round(self.getter('q'), 1)
+
+    @q.setter
+    def q(self, val: float):
+        self.setter('q', val)
+
+
+class StripDevice(IRemote):
+    @classmethod
+    def make(cls, remote, i):
+        """
+        Factory function for strip.device.
+
+        Returns a StripDevice class of a kind.
+        """
+        DEVICE_cls = type(
+            f'StripDevice{remote.kind}',
+            (cls,),
+            {
+                **{
+                    param: device_prop(param)
+                    for param in [
+                        'wdm',
+                        'ks',
+                        'mme',
+                        'asio',
+                    ]
+                },
+            },
+        )
+        return DEVICE_cls(remote, i)
+
+    @property
+    def identifier(self) -> str:
+        return f'Strip[{self.index}].device'
+
+    @property
+    def name(self) -> str:
+        return self.getter('name', is_string=True)
+
+    @property
+    def sr(self) -> int:
+        return int(self.getter('sr'))
 
 
 class VirtualStrip(Strip):
+    @classmethod
+    def make(cls, remote, i, is_phys):
+        """
+        Factory method for VirtualStrip.
+
+        Returns a VirtualStrip class.
+        """
+        EFFECTS_cls = _make_effects_mixins(is_phys)[remote.kind.name]
+        return type(
+            'VirtualStrip',
+            (cls, EFFECTS_cls),
+            {},
+        )
+
     def __str__(self):
-        return f"{type(self).__name__}{self.index}"
+        return f'{type(self).__name__}{self.index}'
 
     @property
     def mc(self) -> bool:
-        return self.getter("mc") == 1
+        return self.getter('mc') == 1
 
     @mc.setter
     def mc(self, val: bool):
-        self.setter("mc", 1 if val else 0)
+        self.setter('mc', 1 if val else 0)
 
     mono = mc
 
     @property
     def k(self) -> int:
-        return int(self.getter("karaoke"))
+        return int(self.getter('karaoke'))
 
     @k.setter
     def k(self, val: int):
-        self.setter("karaoke", val)
+        self.setter('karaoke', val)
 
     @property
-    def bass(self):
+    def bass(self) -> float:
-        return round(self.getter("EQGain1"), 1)
+        return round(self.getter('EQGain1'), 1)
 
     @bass.setter
     def bass(self, val: float):
-        self.setter("EQGain1", val)
+        self.setter('EQGain1', val)
 
     @property
-    def mid(self):
+    def mid(self) -> float:
-        return round(self.getter("EQGain2"), 1)
+        return round(self.getter('EQGain2'), 1)
 
     @mid.setter
     def mid(self, val: float):
-        self.setter("EQGain2", val)
+        self.setter('EQGain2', val)
 
     med = mid
 
     @property
-    def treble(self):
+    def treble(self) -> float:
-        return round(self.getter("EQGain3"), 1)
+        return round(self.getter('EQGain3'), 1)
 
     high = treble
 
     @treble.setter
     def treble(self, val: float):
-        self.setter("EQGain3", val)
+        self.setter('EQGain3', val)
 
     def appgain(self, name: str, gain: float):
-        self.setter("AppGain", f'("{name}", {gain})')
+        self.setter('AppGain', f'("{name}", {gain})')
 
     def appmute(self, name: str, mute: bool = None):
-        self.setter("AppMute", f'("{name}", {1 if mute else 0})')
+        self.setter('AppMute', f'("{name}", {1 if mute else 0})')
 
 
 class StripLevel(IRemote):
@@ -201,8 +513,8 @@ class StripLevel(IRemote):
         def fget(x):
             return round(20 * log(x, 10), 1) if x > 0 else -200.0
 
-        if self._remote.running and self._remote.event.ldirty:
+        if not self._remote.stopped() and self._remote.event.ldirty:
-            vals = self._remote.cache["strip_level"][self.range[0] : self.range[-1]]
+            vals = self._remote.cache['strip_level'][self.range[0] : self.range[-1]]
         else:
             vals = [self._remote.get_level(mode, i) for i in range(*self.range)]
 
@@ -210,7 +522,7 @@ class StripLevel(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}]"
+        return f'Strip[{self.index}]'
 
     @property
     def prefader(self) -> tuple:
@@ -234,7 +546,7 @@ class StripLevel(IRemote):
 
         Expected to be used in a callback only.
         """
-        if self._remote.running:
+        if not self._remote.stopped():
             return any(self._remote._strip_comp[self.range[0] : self.range[-1]])
 
     is_updated = isdirty
@@ -253,7 +565,7 @@ def make_strip_level_map(kind):
     return phys_map + virt_map
 
 
-_make_strip_level_maps = {kind.name: make_strip_level_map(kind) for kind in kinds_all}
+_make_strip_level_maps = {kind.name: make_strip_level_map(kind) for kind in kinds.all}
 
 
 class GainLayer(IRemote):
@@ -263,24 +575,24 @@ class GainLayer(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"Strip[{self.index}]"
+        return f'Strip[{self.index}]'
 
     @property
     def gain(self):
-        return self.getter(f"GainLayer[{self._i}]")
+        return self.getter(f'GainLayer[{self._i}]')
 
     @gain.setter
     def gain(self, val):
-        self.setter(f"GainLayer[{self._i}]", val)
+        self.setter(f'GainLayer[{self._i}]', val)
 
 
 def _make_gainlayer_mixin(remote, index):
     """Creates a GainLayer mixin"""
     return type(
-        f"GainlayerMixin",
+        'GainlayerMixin',
         (),
         {
-            "gainlayer": tuple(
+            'gainlayer': tuple(
                 GainLayer(remote, index, i) for i in range(remote.kind.num_bus)
             )
         },
@@ -290,64 +602,72 @@ def _make_gainlayer_mixin(remote, index):
 def _make_channelout_mixin(kind):
     """Creates a channel out property mixin"""
     return type(
-        f"ChannelOutMixin{kind}",
+        f'ChannelOutMixin{kind}',
         (),
         {
-            **{f"A{i}": bool_prop(f"A{i}") for i in range(1, kind.phys_out + 1)},
+            **{f'A{i}': bool_prop(f'A{i}') for i in range(1, kind.phys_out + 1)},
-            **{f"B{i}": bool_prop(f"B{i}") for i in range(1, kind.virt_out + 1)},
+            **{f'B{i}': bool_prop(f'B{i}') for i in range(1, kind.virt_out + 1)},
         },
     )
 
 
 _make_channelout_mixins = {
-    kind.name: _make_channelout_mixin(kind) for kind in kinds_all
+    kind.name: _make_channelout_mixin(kind) for kind in kinds.all
 }
 
 
-def _make_effects_mixin(kind):
+def _make_effects_mixin(kind, is_phys):
     """creates an effects mixin for a kind"""
-    XY_cls = type(
-        "XY",
-        (),
-        {
-            param: float_prop(param)
-            for param in [
-                "pan_x",
-                "pan_y",
-                "color_x",
-                "color_y",
-                "fx_x",
-                "fx_y",
-            ]
-        },
-    )
 
-    FX_cls = type(
+    def _make_xy_cls():
-        "FX",
+        pan = {param: float_prop(param) for param in ['pan_x', 'pan_y']}
-        (),
+        color = {param: float_prop(param) for param in ['color_x', 'color_y']}
-        {
+        fx = {param: float_prop(param) for param in ['fx_x', 'fx_y']}
-            **{
+        if is_phys:
-                param: float_prop(param)
+            return type(
-                for param in [
+                'XYPhys',
-                    "reverb",
+                (),
-                    "delay",
+                {
-                    "fx1",
+                    **pan,
-                    "fx2",
+                    **color,
-                ]
+                    **fx,
-            },
+                },
-            **{
+            )
-                f"post{param}": bool_prop(f"post{param}")
+        return type(
-                for param in ["reverb", "delay", "fx1", "fx2"]
+            'XYVirt',
-            },
+            (),
-        },
+            {**pan},
-    )
+        )
 
-    if kind.name == "potato":
+    def _make_fx_cls():
-        return type(f"Effects{kind}", (XY_cls, FX_cls), {})
+        if is_phys:
-    return type(f"Effects{kind}", (XY_cls,), {})
+            return type(
+                'FX',
+                (),
+                {
+                    **{
+                        param: float_prop(param)
+                        for param in ['reverb', 'delay', 'fx1', 'fx2']
+                    },
+                    **{
+                        f'post{param}': bool_prop(f'post{param}')
+                        for param in ['reverb', 'delay', 'fx1', 'fx2']
+                    },
+                },
+            )
+        return type('FX', (), {})
+
+    if kind.name == 'basic':
+        steps = (_make_xy_cls,)
+    elif kind.name == 'banana':
+        steps = (_make_xy_cls,)
+    elif kind.name == 'potato':
+        steps = (_make_xy_cls, _make_fx_cls)
+    return type(f'Effects{kind}', tuple(step() for step in steps), {})
 
 
-_make_effects_mixins = {kind.name: _make_effects_mixin(kind) for kind in kinds_all}
+def _make_effects_mixins(is_phys):
+    return {kind.name: _make_effects_mixin(kind, is_phys) for kind in kinds.all}
 
 
 def strip_factory(is_phys_strip, remote, i) -> Union[PhysicalStrip, VirtualStrip]:
@@ -358,18 +678,22 @@ def strip_factory(is_phys_strip, remote, i) -> Union[PhysicalStrip, VirtualStrip
 
     Returns a physical or virtual strip subclass
     """
-    STRIP_cls = PhysicalStrip.make(remote.kind) if is_phys_strip else VirtualStrip
+    STRIP_cls = (
+        PhysicalStrip.make(remote, i, is_phys_strip)
+        if is_phys_strip
+        else VirtualStrip.make(remote, i, is_phys_strip)
+    )
     CHANNELOUTMIXIN_cls = _make_channelout_mixins[remote.kind.name]
 
     _kls = (STRIP_cls, CHANNELOUTMIXIN_cls)
-    if remote.kind.name == "potato":
+    if remote.kind.name == 'potato':
         GAINLAYERMIXIN_cls = _make_gainlayer_mixin(remote, i)
         _kls += (GAINLAYERMIXIN_cls,)
     return type(
-        f"{STRIP_cls.__name__}{remote.kind}",
+        f'{STRIP_cls.__name__}{remote.kind}',
         _kls,
         {
-            "levels": StripLevel(remote, i),
+            'levels': StripLevel(remote, i),
         },
     )(remote, i)
 

voicemeeterlib/subject.py

@@ -1,10 +1,14 @@
-class Subject:
+import logging
-    """Adds support for observers"""
 
+logger = logging.getLogger(__name__)
+
+
+class Subject:
     def __init__(self):
-        """list of current observers"""
+        """Adds support for observers and callbacks"""
 
         self._observers = list()
+        self.logger = logger.getChild(self.__class__.__name__)
 
     @property
     def observers(self) -> list:
@@ -12,28 +16,57 @@ class Subject:
 
         return self._observers
 
-    def notify(self, modifier):
+    def notify(self, event):
         """run callbacks on update"""
 
-        [o.on_update(modifier) for o in self._observers]
+        for o in self._observers:
+            if hasattr(o, 'on_update'):
+                o.on_update(event)
+            else:
+                if o.__name__ == f'on_{event}':
+                    o()
 
     def add(self, observer):
-        """adds an observer to _observers"""
+        """adds an observer to observers"""
-
-        if observer not in self._observers:
-            self._observers.append(observer)
-        else:
-            print(f"Failed to add: {observer}")
-
-    def remove(self, observer):
-        """removes an observer from _observers"""
 
         try:
-            self._observers.remove(observer)
+            iterator = iter(observer)
-        except ValueError:
+            for o in iterator:
-            print(f"Failed to remove: {observer}")
+                if o not in self._observers:
+                    self._observers.append(o)
+                    self.logger.info(f'{o} added to event observers')
+                else:
+                    self.logger.error(f'Failed to add {o} to event observers')
+        except TypeError:
+            if observer not in self._observers:
+                self._observers.append(observer)
+                self.logger.info(f'{observer} added to event observers')
+            else:
+                self.logger.error(f'Failed to add {observer} to event observers')
+
+    register = add
+
+    def remove(self, observer):
+        """removes an observer from observers"""
+
+        try:
+            iterator = iter(observer)
+            for o in iterator:
+                try:
+                    self._observers.remove(o)
+                    self.logger.info(f'{o} removed from event observers')
+                except ValueError:
+                    self.logger.error(f'Failed to remove {o} from event observers')
+        except TypeError:
+            try:
+                self._observers.remove(observer)
+                self.logger.info(f'{observer} removed from event observers')
+            except ValueError:
+                self.logger.error(f'Failed to remove {observer} from event observers')
+
+    deregister = remove
 
     def clear(self):
-        """clears the _observers list"""
+        """clears the observers list"""
 
         self._observers.clear()

voicemeeterlib/updater.py

@@ -0,0 +1,75 @@
+import logging
+import threading
+import time
+
+from .util import comp
+
+logger = logging.getLogger(__name__)
+
+
+class Producer(threading.Thread):
+    """Continously send job queue to the Updater thread at a rate of self._remote.ratelimit."""
+
+    def __init__(self, remote, queue, stop_event):
+        super().__init__(name='producer', daemon=False)
+        self._remote = remote
+        self.queue = queue
+        self.stop_event = stop_event
+        self.logger = logger.getChild(self.__class__.__name__)
+
+    def stopped(self):
+        return self.stop_event.is_set()
+
+    def run(self):
+        while not self.stopped():
+            if self._remote.event.pdirty:
+                self.queue.put('pdirty')
+            if self._remote.event.mdirty:
+                self.queue.put('mdirty')
+            if self._remote.event.midi:
+                self.queue.put('midi')
+            if self._remote.event.ldirty:
+                self.queue.put('ldirty')
+            time.sleep(self._remote.ratelimit)
+        self.logger.debug(f'terminating {self.name} thread')
+        self.queue.put(None)
+
+
+class Updater(threading.Thread):
+    def __init__(self, remote, queue):
+        super().__init__(name='updater', daemon=True)
+        self._remote = remote
+        self.queue = queue
+        self._remote._strip_comp = [False] * (self._remote.kind.num_strip_levels)
+        self._remote._bus_comp = [False] * (self._remote.kind.num_bus_levels)
+        (
+            self._remote.cache['strip_level'],
+            self._remote.cache['bus_level'],
+        ) = self._remote._get_levels()
+        self.logger = logger.getChild(self.__class__.__name__)
+
+    def _update_comps(self, strip_level, bus_level):
+        self._remote._strip_comp, self._remote._bus_comp = (
+            tuple(not x for x in comp(self._remote.cache['strip_level'], strip_level)),
+            tuple(not x for x in comp(self._remote.cache['bus_level'], bus_level)),
+        )
+
+    def run(self):
+        """
+        Continously update observers of dirty states.
+
+        Generate _strip_comp, _bus_comp and update level cache if ldirty.
+        """
+        while event := self.queue.get():
+            if event == 'pdirty' and self._remote.pdirty:
+                self._remote.subject.notify(event)
+            elif event == 'mdirty' and self._remote.mdirty:
+                self._remote.subject.notify(event)
+            elif event == 'midi' and self._remote.get_midi_message():
+                self._remote.subject.notify(event)
+            elif event == 'ldirty' and self._remote.ldirty:
+                self._update_comps(self._remote._strip_buf, self._remote._bus_buf)
+                self._remote.cache['strip_level'] = self._remote._strip_buf
+                self._remote.cache['bus_level'] = self._remote._bus_buf
+                self._remote.subject.notify(event)
+        self.logger.debug(f'terminating {self.name} thread')

voicemeeterlib/util.py

@@ -1,7 +1,41 @@
 import functools
+import time
 from itertools import zip_longest
 from typing import Iterator
 
+from .error import CAPIError, VMError
+
+
+def timeout(func):
+    """
+    Times out the login function once time elapsed exceeds remote.timeout.
+    """
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        remote, *_ = args
+        func(*args, **kwargs)
+
+        err = None
+        start = time.time()
+        while time.time() < start + remote.timeout:
+            try:
+                time.sleep(0.1)  # ensure at least 0.1 delay before clearing dirty
+                remote.logger.info(
+                    f'{type(remote).__name__}: Successfully logged into {remote} version {remote.version}'
+                )
+                remote.logger.debug(f'login time: {round(time.time() - start, 2)}')
+                err = None
+                break
+            except CAPIError as e:
+                err = e
+                continue
+        if err:
+            raise VMError('Timeout logging into the api')
+        remote.clear_dirty()
+
+    return wrapper
+
 
 def polling(func):
     """
@@ -14,15 +48,15 @@ def polling(func):
 
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
-        get = func.__name__ == "get"
+        get = func.__name__ == 'get'
-        mb_get = func.__name__ == "get_buttonstatus"
+        mb_get = func.__name__ == 'get_buttonstatus'
         remote, *remaining = args
 
         if get:
             param, *rem = remaining
         elif mb_get:
             id, mode, *rem = remaining
-            param = f"mb_{id}_{mode}"
+            param = f'mb_{id}_{mode}'
 
         if param in remote.cache:
             return remote.cache.pop(param)
@@ -39,15 +73,15 @@ def script(func):
     def wrapper(*args):
         remote, script = args
         if isinstance(script, dict):
-            params = ""
+            params = ''
             for key, val in script.items():
-                obj, m2, *rem = key.split("-")
+                obj, m2, *rem = key.split('-')
                 index = int(m2) if m2.isnumeric() else int(*rem)
-                params += ";".join(
+                params += ';'.join(
                     f"{obj}{f'.{m2}stream' if not m2.isnumeric() else ''}[{index}].{k}={int(v) if isinstance(v, bool) else v}"
                     for k, v in val.items()
                 )
-                params += ";"
+                params += ';'
             script = params
         return func(remote, script)
 
@@ -70,3 +104,17 @@ def grouper(n, iterable, fillvalue=None):
     """
     args = [iter(iterable)] * n
     return zip_longest(fillvalue=fillvalue, *args)
+
+
+def deep_merge(dict1, dict2):
+    """Generator function for deep merging two dicts"""
+    for k in set(dict1) | set(dict2):
+        if k in dict1 and k in dict2:
+            if isinstance(dict1[k], dict) and isinstance(dict2[k], dict):
+                yield k, dict(deep_merge(dict1[k], dict2[k]))
+            else:
+                yield k, dict2[k]
+        elif k in dict1:
+            yield k, dict1[k]
+        else:
+            yield k, dict2[k]

voicemeeterlib/vban.py

@@ -1,6 +1,6 @@
 from abc import abstractmethod
 
-from .error import VMError
+from . import kinds
 from .iremote import IRemote
 
 
@@ -17,92 +17,94 @@ class VbanStream(IRemote):
 
     @property
     def identifier(self) -> str:
-        return f"vban.{self.direction}stream[{self.index}]"
+        return f'vban.{self.direction}stream[{self.index}]'
 
     @property
     def on(self) -> bool:
-        return self.getter("on") == 1
+        return self.getter('on') == 1
 
     @on.setter
     def on(self, val: bool):
-        self.setter("on", 1 if val else 0)
+        self.setter('on', 1 if val else 0)
 
     @property
     def name(self) -> str:
-        return self.getter("name", is_string=True)
+        return self.getter('name', is_string=True)
 
     @name.setter
     def name(self, val: str):
-        self.setter("name", val)
+        self.setter('name', val)
 
     @property
     def ip(self) -> str:
-        return self.getter("ip", is_string=True)
+        return self.getter('ip', is_string=True)
 
     @ip.setter
     def ip(self, val: str):
-        self.setter("ip", val)
+        self.setter('ip', val)
 
     @property
     def port(self) -> int:
-        return int(self.getter("port"))
+        return int(self.getter('port'))
 
     @port.setter
     def port(self, val: int):
         if not 1024 <= val <= 65535:
-            raise VMError("Expected value from 1024 to 65535")
+            self.logger.warning(
-        self.setter("port", val)
+                f'port got: {val} but expected a value from 1024 to 65535'
+            )
+        self.setter('port', val)
 
     @property
     def sr(self) -> int:
-        return int(self.getter("sr"))
+        return int(self.getter('sr'))
 
     @sr.setter
     def sr(self, val: int):
         opts = (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
         if val not in opts:
-            raise VMError(f"Expected one of: {opts}")
+            self.logger.warning(f'sr got: {val} but expected a value in {opts}')
-        self.setter("sr", val)
+        self.setter('sr', val)
 
     @property
     def channel(self) -> int:
-        return int(self.getter("channel"))
+        return int(self.getter('channel'))
 
     @channel.setter
     def channel(self, val: int):
         if not 1 <= val <= 8:
-            raise VMError("Expected value from 1 to 8")
+            self.logger.warning(f'channel got: {val} but expected a value from 1 to 8')
-        self.setter("channel", val)
+        self.setter('channel', val)
 
     @property
     def bit(self) -> int:
-        return 16 if (int(self.getter("bit") == 1)) else 24
+        return 16 if (int(self.getter('bit') == 1)) else 24
 
     @bit.setter
     def bit(self, val: int):
         if val not in (16, 24):
-            raise VMError("Expected value 16 or 24")
+            self.logger.warning(f'bit got: {val} but expected value 16 or 24')
-        self.setter("bit", 1 if (val == 16) else 2)
+        self.setter('bit', 1 if (val == 16) else 2)
 
     @property
     def quality(self) -> int:
-        return int(self.getter("quality"))
+        return int(self.getter('quality'))
 
     @quality.setter
     def quality(self, val: int):
         if not 0 <= val <= 4:
-            raise VMError("Expected value from 0 to 4")
+            self.logger.warning(f'quality got: {val} but expected a value from 0 to 4')
-        self.setter("quality", val)
+        self.setter('quality', val)
 
     @property
     def route(self) -> int:
-        return int(self.getter("route"))
+        return int(self.getter('route'))
 
     @route.setter
     def route(self, val: int):
         if not 0 <= val <= 8:
-            raise VMError("Expected value from 0 to 8")
+            self.logger.warning(f'route got: {val} but expected a value from 0 to 8')
-        self.setter("route", val)
+        self.setter('route', val)
 
 
 class VbanInstream(VbanStream):
@@ -113,11 +115,11 @@ class VbanInstream(VbanStream):
     """
 
     def __str__(self):
-        return f"{type(self).__name__}{self._remote.kind}{self.index}"
+        return f'{type(self).__name__}{self._remote.kind}{self.index}'
 
     @property
     def direction(self) -> str:
-        return "in"
+        return 'in'
 
     @property
     def sr(self) -> int:
@@ -132,6 +134,18 @@ class VbanInstream(VbanStream):
         return super(VbanInstream, self).bit
 
 
+class VbanAudioInstream(VbanInstream):
+    """Represents a VBAN Audio Instream"""
+
+
+class VbanMidiInstream(VbanInstream):
+    """Represents a VBAN Midi Instream"""
+
+
+class VbanTextInstream(VbanInstream):
+    """Represents a VBAN Text Instream"""
+
+
 class VbanOutstream(VbanStream):
     """
     class representing a vban outstream
@@ -140,11 +154,47 @@ class VbanOutstream(VbanStream):
     """
 
     def __str__(self):
-        return f"{type(self).__name__}{self._remote.kind}{self.index}"
+        return f'{type(self).__name__}{self._remote.kind}{self.index}'
 
     @property
     def direction(self) -> str:
-        return "out"
+        return 'out'
+
+
+class VbanAudioOutstream(VbanOutstream):
+    """Represents a VBAN Audio Outstream"""
+
+
+class VbanMidiOutstream(VbanOutstream):
+    """Represents a VBAN Midi Outstream"""
+
+
+def _make_stream_pair(remote, kind):
+    num_instream, num_outstream, num_midi, num_text = kind.vban
+
+    def _make_cls(i, direction):
+        match direction:
+            case 'in':
+                if i < num_instream:
+                    return VbanAudioInstream(remote, i)
+                elif i < num_instream + num_midi:
+                    return VbanMidiInstream(remote, i)
+                else:
+                    return VbanTextInstream(remote, i)
+            case 'out':
+                if i < num_outstream:
+                    return VbanAudioOutstream(remote, i)
+                else:
+                    return VbanMidiOutstream(remote, i)
+
+    return (
+        tuple(_make_cls(i, 'in') for i in range(num_instream + num_midi + num_text)),
+        tuple(_make_cls(i, 'out') for i in range(num_outstream + num_midi)),
+    )
+
+
+def _make_stream_pairs(remote):
+    return {kind.name: _make_stream_pair(remote, kind) for kind in kinds.all}
 
 
 class Vban:
@@ -156,15 +206,13 @@ class Vban:
 
     def __init__(self, remote):
         self.remote = remote
-        num_instream, num_outstream = remote.kind.vban
+        self.instream, self.outstream = _make_stream_pairs(remote)[remote.kind.name]
-        self.instream = tuple(VbanInstream(remote, i) for i in range(num_instream))
-        self.outstream = tuple(VbanOutstream(remote, i) for i in range(num_outstream))
 
     def enable(self):
-        self.remote.set("vban.Enable", 1)
+        self.remote.set('vban.Enable', 1)
 
     def disable(self):
-        self.remote.set("vban.Enable", 0)
+        self.remote.set('vban.Enable', 0)
 
 
 def vban_factory(remote) -> Vban:
@@ -174,7 +222,7 @@ def vban_factory(remote) -> Vban:
     Returns a class that represents the VBAN module.
     """
     VBAN_cls = Vban
-    return type(f"{VBAN_cls.__name__}", (VBAN_cls,), {})(remote)
+    return type(f'{VBAN_cls.__name__}', (VBAN_cls,), {})(remote)
 
 
 def request_vban_obj(remote) -> Vban: