onyx_online/voicemeeter-api-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-api-python.git synced 2026-04-06 23:43:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: onyx_online:dev
Branches Tags
onyx_online:dev onyx_online:add-to-bus-class onyx_online:add-bits-kwarg onyx_online:add-event-stop-object onyx_online:add-button-color-commands onyx_online:bounds-check-log-warnings onyx_online:add-to-recorder-class onyx_online:v1.0.0 onyx_online:main
onyx_online:v2.7.2
..
compare: onyx_online:add-button-color-commands
Branches Tags
onyx_online:dev onyx_online:add-to-bus-class onyx_online:add-bits-kwarg onyx_online:add-event-stop-object onyx_online:add-button-color-commands onyx_online:bounds-check-log-warnings onyx_online:add-to-recorder-class onyx_online:v1.0.0 onyx_online:main
onyx_online:v2.7.2

2 Commits
dev ... add-button

Author SHA1 Message Date
onyx-and-iris
2d5c611ed8 add button color example to readme 2023-07-23 08:33:54 +01:00
onyx-and-iris
46e7ffe478 adds MacroButtonColorMixin. 2023-07-23 07:56:09 +01:00
56 changed files with 1474 additions and 2390 deletions
Expand all files Collapse all files

53
.github/workflows/publish.yml vendored
View File

@@ -1,53 +0,0 @@
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/voicemeeter-api/
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

19
.github/workflows/ruff.yml vendored
View File

@@ -1,19 +0,0 @@
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'

10
.gitignore vendored
View File

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

13
.pre-commit-config.yaml
View File

@@ -1,13 +0,0 @@
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
- repo: https://github.com/python-poetry/poetry
rev: '2.3.2'
hooks:
- id: poetry-check
- id: poetry-lock

46
CHANGELOG.md
View File

@@ -11,52 +11,6 @@ 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

133
README.md
View File

@@ -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)
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
![Tests Status](./tests/reports/badge-basic.svg?dummy=8484744)
![Tests Status](./tests/reports/badge-banana.svg?dummy=8484744)
![Tests Status](./tests/reports/badge-potato.svg?dummy=8484744)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
![Tests Status](./tests/basic.svg?dummy=8484744)
![Tests Status](./tests/banana.svg?dummy=8484744)
![Tests Status](./tests/potato.svg?dummy=8484744)
# Python Wrapper for Voicemeeter API
@@ -14,9 +14,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
## Tested against
- Basic 1.1.2.2
- Banana 2.1.2.2
- Potato 3.1.2.2
- Basic 1.0.8.8
- Banana 2.0.6.8
- Potato 3.0.2.8
## Requirements
@@ -44,24 +44,24 @@ 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):
self.vm.bus[3].gain = -6.3
self.vm.bus[4].eq.on = True
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}',
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))
print("\n".join(info))
def main():
KIND_ID = 'banana'
KIND_ID = "banana"
with voicemeeterlib.api(KIND_ID) as vm:
do = ManyThings(vm)
@@ -71,17 +71,18 @@ def main():
# set many parameters at once
vm.apply(
{
'strip-2': {'A1': True, 'B1': True, 'gain': -6.0},
'bus-2': {'mute': True, 'eq': {'on': True}},
'button-0': {'state': True},
'vban-in-0': {'on': True},
'vban-out-1': {'name': 'streamname'},
"strip-2": {"A1": True, "B1": True, "gain": -6.0},
"bus-2": {"mute": True, "eq": {"on": True}},
"button-0": {"state": True},
"vban-in-0": {"on": True},
"vban-out-1": {"name": "streamname"},
}
)
if __name__ == '__main__':
if __name__ == "__main__":
main()
```
Otherwise you must remember to call `vm.login()`, `vm.logout()` at the start/end of your code.
@@ -148,8 +149,8 @@ Set mute state as value for the app matching name.
example:
```python
vm.strip[5].appmute('Spotify', True)
vm.strip[5].appgain('Spotify', 0.5)
vm.strip[5].appmute("Spotify", True)
vm.strip[5].appgain("Spotify", 0.5)
```
#### Strip.Comp
@@ -225,24 +226,6 @@ example:
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
@@ -277,7 +260,7 @@ Level properties will return -200.0 if no audio detected.
The following properties are available.
- `mono`: int, from 0 up to 2
- `mono`: boolean
- `mute`: boolean
- `sel`: boolean
- `gain`: float, from -60.0 to 12.0
@@ -294,7 +277,7 @@ example:
vm.bus[3].gain = 3.7
print(vm.bus[0].label)
vm.bus[4].mono = 2
vm.bus[4].mono = True
```
##### Bus.EQ
@@ -310,24 +293,6 @@ example:
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.
@@ -401,7 +366,7 @@ example:
```python
print(vm.strip[0].device.name)
vm.bus[0].device.asio = 'Audient USB Audio ASIO Driver'
vm.bus[0].device.asio = "Audient USB Audio ASIO Driver"
```
strip|bus device parameters are defined for physical channels only.
@@ -415,12 +380,13 @@ The following properties are available.
- `state`: boolean
- `stateonly`: boolean
- `trigger`: boolean
- `color`: int, from 0 to 8
example:
```python
vm.button[37].state = True
vm.button[55].trigger = False
vm.button[4].color = 1
```
### Recorder
@@ -460,7 +426,7 @@ vm.recorder.B2 = False
vm.recorder.load(r'C:\music\mytune.mp3')
# set the goto time to 1m 30s
vm.recorder.goto('00:01:30')
vm.recorder.goto("00:01:30")
```
#### Recorder.Mode
@@ -714,11 +680,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},
'bus-2': {'mute': True, 'eq': {'on': True}},
'button-0': {'state': True},
'vban-in-0': {'on': True},
'vban-out-1': {'name': 'streamname'},
"strip-2": {"A1": True, "B1": True, "gain": -6.0},
"bus-2": {"mute": True, "eq": {"on": True}},
"button-0": {"state": True},
"vban-in-0": {"on": True},
"vban-out-1": {"name": "streamname"},
}
)
```
@@ -726,8 +692,8 @@ vm.apply(
Or for each class you may do:
```python
vm.strip[0].apply({'mute': True, 'gain': 3.2, 'A1': True})
vm.vban.outstream[0].apply({'on': True, 'name': 'streamname', 'bit': 24})
vm.strip[0].apply({"mute": True, "gain": 3.2, "A1": True})
vm.vban.outstream[0].apply({"on": True, "name": "streamname", "bit": 24})
```
## Config Files
@@ -828,7 +794,7 @@ The following methods are available:
example:
```python
vm.event.remove(['pdirty', 'mdirty', 'midi'])
vm.event.remove(["pdirty", "mdirty", "midi"])
# get a list of currently subscribed
print(vm.event.get())
@@ -846,8 +812,6 @@ You may pass the following optional keyword arguments:
- `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:
@@ -879,13 +843,10 @@ True iff a level has been updated.
### Errors
- `errors.VMError`: Base custom exception class.
- `errors.VMError`: Exception raised when general errors occur.
- `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].
- Error codes are stored in {Exception Class}.code. For a full list of error codes [check the VoicemeeterRemote header file][Voicemeeter Remote Header].
### Logging
@@ -898,24 +859,22 @@ import voicemeeterlib
logging.basicConfig(level=logging.DEBUG)
with voicemeeterlib.api('banana') as vm:
...
with voicemeeterlib.api("banana") as vm:
...
```
### Run tests
Install [poetry](https://python-poetry.org/docs/#installation) and then:
To run all tests:
```powershell
poetry poe test-basic
poetry poe test-banana
poetry poe test-potato
```
pytest -v
```
### Official Documentation
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemoteAPI.pdf)
[Voicemeeter Remote Header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemote.h
[Voicemeeter Remote Header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemote.h

24
__main__.py
View File

@@ -6,24 +6,24 @@ 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):
self.vm.bus[3].gain = -6.3
self.vm.bus[4].eq.on = True
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}',
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))
print("\n".join(info))
def main():
KIND_ID = 'banana'
KIND_ID = "banana"
with voicemeeterlib.api(KIND_ID) as vm:
do = ManyThings(vm)
@@ -33,14 +33,14 @@ def main():
# set many parameters at once
vm.apply(
{
'strip-2': {'A1': True, 'B1': True, 'gain': -6.0},
'bus-2': {'mute': True, 'eq': {'on': True}},
'button-0': {'state': True},
'vban-in-0': {'on': True},
'vban-out-1': {'name': 'streamname'},
"strip-2": {"A1": True, "B1": True, "gain": -6.0},
"bus-2": {"mute": True, "eq": {"on": True}},
"button-0": {"state": True},
"vban-in-0": {"on": True},
"vban-out-1": {"name": "streamname"},
}
)
if __name__ == '__main__':
if __name__ == "__main__":
main()

172
examples/dsl/__main__.py
View File

@@ -1,8 +1,6 @@
import argparse
import logging
import time
from abc import ABC, abstractmethod
from enum import IntEnum
from pyparsing import (
Combine,
@@ -12,90 +10,26 @@ 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')
logging.basicConfig(level=logging.INFO)
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.param = Group(OneOrMore(Word(alphanums)))
self.token = Suppress("->")
self.param = 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
@@ -105,68 +39,30 @@ class Parser:
+ Optional(self.value)
)
def converter(self, cmds):
"""determines the kind of parameter from the parsed string"""
def parse(self, cmds):
res = list()
for cmd in cmds:
self.logger.debug(f'running command: {cmd}')
match cmd_parsed := self.event.parseString(cmd):
case [[kls, index], [param]]:
target = getattr(self.vm, kls)[int(index)]
res.append(getattr(target, param))
case [[kls, index], [param], val] if param in self.IS_STRING:
target = getattr(self.vm, kls)[int(index)]
context = self._get_context(ParamKinds.string, target, param, val)
context.run()
case [[kls, index], [param], [val] | val]:
target = getattr(self.vm, kls)[int(index)]
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 [
[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}'
)
if len(self.event.parseString(cmd)) == 2:
kls, param = self.event.parseString(cmd)
target = getattr(self.vm, kls[0])[int(kls[-1])]
res.append(getattr(target, param))
elif len(self.event.parseString(cmd)) == 3:
kls, param, val = self.event.parseString(cmd)
target = getattr(self.vm, kls[0])[int(kls[-1])]
if "".join(val) in ["off", "on"]:
setattr(target, param, bool(["off", "on"].index("".join(val))))
elif param in ["gain", "comp", "gate", "limit", "audibility"]:
setattr(target, param, float("".join(val)))
elif param in ["label"]:
setattr(target, param, " ".join(val))
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.
"""
match kind:
case ParamKinds.bool:
context = Context(BoolStrategy(*args))
case ParamKinds.float:
context = Context(FloatStrategy(*args))
case ParamKinds.string:
context = Context(StringStrategy(*args))
return context
def interactive_mode(parser):
while cmd := input('Please enter command (Press <Enter> to exit)\n'):
while cmd := input("Please enter command (Press <Enter> to exit)\n"):
if res := parser.parse((cmd,)):
print(res)
@@ -174,25 +70,27 @@ def interactive_mode(parser):
def main():
# fmt: off
cmds = (
"strip 0 -> mute -> true", "strip 0 -> mute", "bus 0 -> mute -> true",
"strip 0 -> mute -> false", "bus 0 -> mute -> true", "strip 3 -> solo -> true",
"strip 3 -> solo -> false", "strip 1 -> A1 -> true", "strip 1 -> A1",
"strip 1 -> A1 -> false", "strip 1 -> A1", "strip 3 -> eq on -> true",
"bus 3 -> eq on -> false", "strip 4 -> gain -> 1.2", "strip 0 -> gain -> -8.2",
"strip 0 -> mute -> on", "strip 0 -> mute", "bus 0 -> mute -> on",
"strip 0 -> mute -> off", "bus 0 -> mute -> on", "strip 3 -> solo -> on",
"strip 3 -> solo -> off", "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", "strip 3 -> comp knob -> 3.8"
"strip 2 -> limit",
)
# fmt: on
with voicemeeterlib.api('potato') as vm:
KIND_ID = "banana"
with voicemeeterlib.api(KIND_ID) as vm:
parser = Parser(vm)
if args.i:
interactive_mode(parser)
return
if res := parser.converter(cmds):
if res := parser.parse(cmds):
print(res)
if __name__ == '__main__':
if __name__ == "__main__":
main()

9
examples/eq_edit/README.md
View File

@@ -1,9 +0,0 @@
## 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.

50
examples/eq_edit/__main__.py
View File

@@ -1,50 +0,0 @@
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()

35
examples/events/README.md
View File

@@ -1,8 +1,33 @@
# Events
## About
If you want to receive updates on certain events there are two routes you can take:
This script demonstrates how to interact with the event thread/event object. It also demonstrates how to register event specific callbacks.
- 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.
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.
Included are examples of both approaches.
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

30
examples/events/callbacks/__main__.py → examples/events/__main__.py
View File

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

33
examples/events/callbacks/README.md
View File

@@ -1,33 +0,0 @@
## 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

45
examples/events/observer/__main__.py
View File

@@ -1,45 +0,0 @@
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()

44
examples/gui/__main__.py
View File

@@ -1,10 +1,10 @@
import logging
import tkinter as tk
from tkinter import ttk
import voicemeeterlib
logging.basicConfig(level=logging.DEBUG)
import tkinter as tk
from tkinter import ttk
class App(tk.Tk):
@@ -12,9 +12,9 @@ class App(tk.Tk):
def __init__(self, vm):
super().__init__()
self._vm = vm
self.title(f'{vm} - version {vm.version}')
self._vm.observer.add(self.on_ldirty)
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)
@@ -24,14 +24,14 @@ class App(tk.Tk):
# initialize style table
self.style = ttk.Style()
self.style.theme_use('clam')
self.style.theme_use("clam")
self.style.configure(
'Mute.TButton',
foreground='#cd5c5c' if vm.strip[self.INDEX].mute else '#5a5a5a',
"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 = tk.LabelFrame(self, text=self.vm.strip[self.INDEX].label)
self.labelframe.grid(padx=1)
# create slider and grid it onto the labelframe
@@ -39,7 +39,7 @@ class App(tk.Tk):
self.labelframe,
from_=12,
to_=-60,
orient='vertical',
orient="vertical",
variable=self.slider_var,
command=lambda arg: self.on_slider_move(arg),
)
@@ -47,15 +47,15 @@ class App(tk.Tk):
column=0,
row=0,
)
slider.bind('<Double-Button-1>', self.on_button_double_click)
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',
orient="vertical",
variable=self.meter_var,
maximum=72,
mode='determinate',
mode="determinate",
)
level_meter.grid(column=1, row=0)
@@ -66,8 +66,8 @@ class App(tk.Tk):
# create button and grid it onto the labelframe
button = ttk.Button(
self.labelframe,
text='Mute',
style='Mute.TButton',
text="Mute",
style="Mute.TButton",
command=lambda: self.on_button_press(),
)
button.grid(column=0, row=2, columnspan=2, padx=1, pady=2)
@@ -76,23 +76,23 @@ class App(tk.Tk):
def on_slider_move(self, *args):
val = round(self.slider_var.get(), 1)
self._vm.strip[self.INDEX].gain = val
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.vm.strip[self.INDEX].mute = self.button_var.get()
self.style.configure(
'Mute.TButton', foreground='#cd5c5c' if self.button_var.get() else '#5a5a5a'
"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
self.vm.strip[self.INDEX].gain = 0
def _get_level(self):
val = max(self._vm.strip[self.INDEX].levels.postfader)
val = max(self.vm.strip[self.INDEX].levels.postfader)
return 0 if self.button_var.get() else 72 + val - 12
def on_ldirty(self):
@@ -100,10 +100,10 @@ class App(tk.Tk):
def main():
with voicemeeterlib.api('banana', ldirty=True) as vm:
with voicemeeterlib.api("banana", ldirty=True) as vm:
app = App(vm)
app.mainloop()
if __name__ == '__main__':
if __name__ == "__main__":
main()

10
examples/levels/__main__.py
View File

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

31
examples/midi/__main__.py
View File

@@ -10,42 +10,41 @@ class App:
MACROBUTTON = 0
def __init__(self, vm):
self._vm = vm
self._vm.observer.add(self.on_midi)
self.vm = vm
self.vm.observer.add(self.on_midi)
def on_midi(self):
if self.get_info() == self.MIDI_BUTTON:
self.on_midi_press()
self.get_info()
self.on_midi_press()
def get_info(self):
current = self._vm.midi.current
print(f'Value of midi button {current} is {self._vm.midi.get(current)}')
return current
current = self.vm.midi.current
print(f"Value of midi button {current} is {self.vm.midi.get(current)}")
def on_midi_press(self):
"""if midi button 48 is pressed and strip 3 level max > -40, then set trigger for macrobutton 0"""
"""if strip 3 level max > -40 and midi button 48 is pressed, then set trigger for macrobutton 0"""
if (
self._vm.midi.get(self.MIDI_BUTTON) == 127
and max(self._vm.strip[3].levels.postfader) > -40
max(self.vm.strip[3].levels.postfader) > -40
and self.vm.midi.get(self.MIDI_BUTTON) == 127
):
print(
f'Strip 3 level max is greater than -40 and midi button {self.MIDI_BUTTON} 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
def main():
KIND_ID = 'banana'
KIND_ID = "banana"
with voicemeeterlib.api(KIND_ID, midi=True) as vm:
App(vm)
while _ := input('Press <Enter> to exit\n'):
while cmd := input("Press <Enter> to exit\n"):
pass
if __name__ == '__main__':
if __name__ == "__main__":
main()

109
examples/obs/__main__.py
View File

@@ -1,4 +1,4 @@
import threading
import time
from logging import config
import obsws_python as obsws
@@ -7,100 +7,91 @@ import voicemeeterlib
config.dictConfig(
{
'version': 1,
'formatters': {
'standard': {
'format': '%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s'
"version": 1,
"formatters": {
"standard": {
"format": "%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s"
}
},
'handlers': {
'stream': {
'level': 'DEBUG',
'class': 'logging.StreamHandler',
'formatter': 'standard',
"handlers": {
"stream": {
"level": "DEBUG",
"class": "logging.StreamHandler",
"formatter": "standard",
}
},
'loggers': {
'voicemeeterlib.iremote': {
'handlers': ['stream'],
'level': 'DEBUG',
'propagate': False,
}
"loggers": {
"voicemeeterlib.iremote": {"handlers": ["stream"], "level": "DEBUG"}
},
'root': {'handlers': ['stream'], 'level': 'WARNING'},
}
)
class MyClient:
def __init__(self, vm, stop_event):
self._vm = vm
self._stop_event = stop_event
self._client = obsws.EventClient()
self._client.callback.register(
def __init__(self, vm):
self.vm = vm
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()
self.is_running = True
def on_start(self):
self._vm.strip[0].mute = True
self._vm.strip[1].B1 = True
self._vm.strip[2].B2 = True
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
self.vm.strip[7].fadeto(0, 500)
self.vm.bus[0].mute = True
def on_end(self):
self._vm.apply(
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},
"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
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):
def fget(scene):
run = {
"START": self.on_start,
"BRB": self.on_brb,
"END": self.on_end,
"LIVE": self.on_live,
}
return run.get(scene)
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()
print(f"Switched to scene {scene}")
if fn := fget(scene):
fn()
def on_exit_started(self, _):
self._stop_event.set()
self.client.unsubscribe()
self.is_running = False
def main():
KIND_ID = 'potato'
KIND_ID = "potato"
with voicemeeterlib.api(KIND_ID) as vm:
stop_event = threading.Event()
with MyClient(vm, stop_event):
stop_event.wait()
client = MyClient(vm)
while client.is_running:
time.sleep(0.1)
if __name__ == '__main__':
if __name__ == "__main__":
main()

0
examples/events/observer/README.md → examples/observer/README.md
View File

45
examples/observer/__main__.py Normal file
View File

@@ -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 cmd := input("Press <Enter> to exit\n"):
pass
if __name__ == "__main__":
main()

396
poetry.lock generated
View File

@@ -1,359 +1,291 @@
# This file is automatically @generated by Poetry 2.2.1 and should not be changed by hand.
[[package]]
name = "black"
version = "22.12.0"
description = "The uncompromising code formatter."
category = "dev"
optional = false
python-versions = ">=3.7"
[package.dependencies]
click = ">=8.0.0"
mypy-extensions = ">=0.4.3"
pathspec = ">=0.9.0"
platformdirs = ">=2"
tomli = {version = ">=1.1.0", markers = "python_full_version < \"3.11.0a7\""}
[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 = "cachetools"
version = "5.5.0"
version = "5.3.1"
description = "Extensible memoizing collections and decorators"
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]]
name = "chardet"
version = "5.2.0"
version = "5.1.0"
description = "Universal encoding detector for Python 3"
category = "dev"
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 = "click"
version = "8.1.3"
description = "Composable command line interface toolkit"
category = "dev"
optional = false
python-versions = ">=3.7"
[package.dependencies]
colorama = {version = "*", markers = "platform_system == \"Windows\""}
[[package]]
name = "colorama"
version = "0.4.6"
description = "Cross-platform colored terminal text."
category = "dev"
optional = false
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"
version = "0.3.6"
description = "Distribution utilities"
category = "dev"
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"
version = "1.1.1"
description = "Backport of PEP 654 (exception groups)"
category = "dev"
optional = false
python-versions = ">=3.7"
groups = ["dev"]
markers = "python_version == \"3.10\""
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.20.3"
version = "3.12.2"
description = "A platform independent file lock."
category = "dev"
optional = false
python-versions = ">=3.10"
groups = ["dev"]
files = [
{file = "filelock-3.20.3-py3-none-any.whl", hash = "sha256:4b0dda527ee31078689fc205ec4f1c1bf7d56cf88b6dc9426c4f230e46c2dce1"},
{file = "filelock-3.20.3.tar.gz", hash = "sha256:18c57ee915c7ec61cff0ecf7f0f869936c7c30191bb0cf406f1341778d0834e1"},
]
python-versions = ">=3.7"
[package.extras]
docs = ["furo (>=2023.5.20)", "sphinx-autodoc-typehints (>=1.23,!=1.23.4)", "sphinx (>=7.0.1)"]
testing = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "diff-cover (>=7.5)", "pytest-cov (>=4.1)", "pytest-mock (>=3.10)", "pytest-timeout (>=2.1)", "pytest (>=7.3.1)"]
[[package]]
name = "iniconfig"
version = "2.0.0"
description = "brain-dead simple config-ini parsing"
category = "dev"
optional = false
python-versions = ">=3.7"
groups = ["dev"]
files = [
{file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"},
{file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"},
]
[[package]]
name = "isort"
version = "5.12.0"
description = "A Python utility / library to sort Python imports."
category = "dev"
optional = false
python-versions = ">=3.8.0"
[package.extras]
colors = ["colorama (>=0.4.3)"]
requirements-deprecated-finder = ["pip-api", "pipreqs"]
pipfile-deprecated-finder = ["pip-shims (>=0.5.2)", "pipreqs", "requirementslib"]
plugins = ["setuptools"]
[[package]]
name = "mypy-extensions"
version = "1.0.0"
description = "Type system extensions for programs checked with the mypy type checker."
category = "dev"
optional = false
python-versions = ">=3.5"
[[package]]
name = "packaging"
version = "24.2"
version = "23.1"
description = "Core utilities for Python packages"
category = "dev"
optional = false
python-versions = ">=3.8"
groups = ["dev"]
files = [
{file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"},
{file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"},
]
python-versions = ">=3.7"
[[package]]
name = "pathspec"
version = "0.11.1"
description = "Utility library for gitignore style pattern matching of file paths."
category = "dev"
optional = false
python-versions = ">=3.7"
[[package]]
name = "platformdirs"
version = "4.3.6"
description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
version = "3.6.0"
description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
category = "dev"
optional = false
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"},
]
python-versions = ">=3.7"
[package.extras]
docs = ["furo (>=2024.8.6)", "proselint (>=0.14)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4)"]
test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=8.3.2)", "pytest-cov (>=5)", "pytest-mock (>=3.14)"]
type = ["mypy (>=1.11.2)"]
docs = ["furo (>=2023.5.20)", "proselint (>=0.13)", "sphinx-autodoc-typehints (>=1.23,!=1.23.4)", "sphinx (>=7.0.1)"]
test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.10)", "pytest (>=7.3.1)"]
[[package]]
name = "pluggy"
version = "1.5.0"
version = "1.1.0"
description = "plugin and hook calling mechanisms for python"
category = "dev"
optional = false
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"},
]
python-versions = ">=3.7"
[package.extras]
dev = ["pre-commit", "tox"]
testing = ["pytest", "pytest-benchmark"]
[[package]]
name = "pyenv-inspect"
version = "0.4.0"
description = "An auxiliary library for the virtualenv-pyenv and tox-pyenv-redux plugins"
optional = false
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 = "pyproject-api"
version = "1.8.0"
version = "1.5.2"
description = "API to interact with the python pyproject.toml based projects"
category = "dev"
optional = false
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"},
]
python-versions = ">=3.7"
[package.dependencies]
packaging = ">=24.1"
packaging = ">=23.1"
tomli = {version = ">=2.0.1", markers = "python_version < \"3.11\""}
[package.extras]
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)"]
docs = ["furo (>=2023.5.20)", "sphinx-autodoc-typehints (>=1.23,!=1.23.4)", "sphinx (>=7.0.1)"]
testing = ["covdefaults (>=2.3)", "importlib-metadata (>=6.6)", "pytest-cov (>=4.1)", "pytest-mock (>=3.10)", "pytest (>=7.3.1)", "setuptools (>=67.8)", "wheel (>=0.40)"]
[[package]]
name = "pytest"
version = "8.3.4"
version = "7.3.2"
description = "pytest: simple powerful testing with Python"
category = "dev"
optional = false
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"},
]
python-versions = ">=3.7"
[package.dependencies]
colorama = {version = "*", markers = "sys_platform == \"win32\""}
exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
iniconfig = "*"
packaging = "*"
pluggy = ">=1.5,<2"
tomli = {version = ">=1", markers = "python_version < \"3.11\""}
pluggy = ">=0.12,<2.0"
tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
[package.extras]
dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
[[package]]
name = "pytest-randomly"
version = "3.16.0"
version = "3.12.0"
description = "Pytest plugin to randomly order tests and control random.seed."
category = "dev"
optional = false
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"},
]
python-versions = ">=3.7"
[package.dependencies]
pytest = "*"
[[package]]
name = "ruff"
version = "0.8.6"
description = "An extremely fast Python linter and code formatter, written in Rust."
name = "pytest-repeat"
version = "0.9.1"
description = "pytest plugin for repeating tests"
category = "dev"
optional = false
python-versions = ">=3.7"
groups = ["dev"]
files = [
{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"},
]
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
[package.dependencies]
pytest = ">=3.6"
[[package]]
name = "tomli"
version = "2.2.1"
version = "2.0.1"
description = "A lil' TOML parser"
category = "main"
optional = false
python-versions = ">=3.8"
groups = ["main", "dev"]
markers = "python_version == \"3.10\""
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"},
]
python-versions = ">=3.7"
[[package]]
name = "tox"
version = "4.23.2"
version = "4.6.3"
description = "tox is a generic virtualenv management and test command line tool"
category = "dev"
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"},
]
python-versions = ">=3.7"
[package.dependencies]
cachetools = ">=5.5"
chardet = ">=5.2"
cachetools = ">=5.3.1"
chardet = ">=5.1"
colorama = ">=0.4.6"
filelock = ">=3.16.1"
packaging = ">=24.1"
platformdirs = ">=4.3.6"
pluggy = ">=1.5"
pyproject-api = ">=1.8"
filelock = ">=3.12.2"
packaging = ">=23.1"
platformdirs = ">=3.5.3"
pluggy = ">=1"
pyproject-api = ">=1.5.2"
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"
virtualenv = ">=20.23.1"
[package.extras]
test = ["devpi-process (>=1.0.2)", "pytest (>=8.3.3)", "pytest-mock (>=3.14)"]
[[package]]
name = "typing-extensions"
version = "4.15.0"
description = "Backported and Experimental Type Hints for Python 3.9+"
optional = false
python-versions = ">=3.9"
groups = ["dev"]
markers = "python_version == \"3.10\""
files = [
{file = "typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548"},
{file = "typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466"},
]
docs = ["furo (>=2023.5.20)", "sphinx-argparse-cli (>=1.11.1)", "sphinx-autodoc-typehints (>=1.23.2,!=1.23.4)", "sphinx-copybutton (>=0.5.2)", "sphinx-inline-tabs (>=2023.4.21)", "sphinx (>=7.0.1)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
testing = ["build[virtualenv] (>=0.10)", "covdefaults (>=2.3)", "detect-test-pollution (>=1.1.1)", "devpi-process (>=0.3.1)", "diff-cover (>=7.6)", "distlib (>=0.3.6)", "flaky (>=3.7)", "hatch-vcs (>=0.3)", "hatchling (>=1.17.1)", "psutil (>=5.9.5)", "pytest-cov (>=4.1)", "pytest-mock (>=3.11.1)", "pytest-xdist (>=3.3.1)", "pytest (>=7.3.2)", "re-assert (>=1.1)", "time-machine (>=2.10)", "wheel (>=0.40)"]
[[package]]
name = "virtualenv"
version = "20.36.1"
version = "20.23.1"
description = "Virtual Python Environment builder"
category = "dev"
optional = false
python-versions = ">=3.8"
groups = ["dev"]
files = [
{file = "virtualenv-20.36.1-py3-none-any.whl", hash = "sha256:575a8d6b124ef88f6f51d56d656132389f961062a9177016a50e4f507bbcc19f"},
{file = "virtualenv-20.36.1.tar.gz", hash = "sha256:8befb5c81842c641f8ee658481e42641c68b5eab3521d8e092d18320902466ba"},
]
python-versions = ">=3.7"
[package.dependencies]
distlib = ">=0.3.7,<1"
filelock = {version = ">=3.20.1,<4", markers = "python_version >= \"3.10\""}
platformdirs = ">=3.9.1,<5"
typing-extensions = {version = ">=4.13.2", markers = "python_version < \"3.11\""}
distlib = ">=0.3.6,<1"
filelock = ">=3.12,<4"
platformdirs = ">=3.5.1,<4"
[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) ; platform_python_implementation == \"PyPy\" or platform_python_implementation == \"GraalVM\" or platform_python_implementation == \"CPython\" and sys_platform == \"win32\" and python_version >= \"3.13\"", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10) ; platform_python_implementation == \"CPython\""]
[[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 = "*"
docs = ["furo (>=2023.5.20)", "proselint (>=0.13)", "sphinx-argparse (>=0.4)", "sphinx (>=7.0.1)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
test = ["covdefaults (>=2.3)", "coverage-enable-subprocess (>=1)", "coverage (>=7.2.7)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest-env (>=0.8.1)", "pytest-freezer (>=0.4.6)", "pytest-mock (>=3.10)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "pytest (>=7.3.1)", "setuptools (>=67.8)", "time-machine (>=2.9)"]
[metadata]
lock-version = "2.1"
python-versions = ">=3.10"
content-hash = "6339967c3f6cad8e4db7047ef3d12a5b059a279d0f7c98515c961477680bab8f"
lock-version = "1.1"
python-versions = "^3.10"
content-hash = "5d0edd070ea010edb4e2ade88dc37324b8b4b04f22db78e49db161185365849b"
[metadata.files]
black = []
cachetools = []
chardet = []
click = []
colorama = []
distlib = []
exceptiongroup = []
filelock = []
iniconfig = []
isort = []
mypy-extensions = []
packaging = []
pathspec = []
platformdirs = []
pluggy = []
pyproject-api = []
pytest = []
pytest-randomly = []
pytest-repeat = []
tomli = []
tox = []
virtualenv = []

152
pyproject.toml
View File

@@ -1,124 +1,48 @@
[project]
name = "voicemeeter-api"
version = "2.7.2"
description = "A Python wrapper for the Voiceemeter API"
authors = [{ name = "Onyx and Iris", email = "code@onyxandiris.online" }]
license = { text = "MIT" }
readme = "README.md"
requires-python = ">=3.10"
dependencies = ["tomli (>=2.0.1,<3.0) ; python_version < '3.11'"]
[tool.poetry]
name = "voicemeeter-api"
version = "2.3.6"
description = "A Python wrapper for the Voiceemeter API"
authors = ["onyx-and-iris <code@onyxandiris.online>"]
license = "MIT"
readme = "README.md"
repository = "https://github.com/onyx-and-iris/voicemeeter-api-python"
packages = [{ include = "voicemeeterlib" }]
[tool.poetry.requires-plugins]
poethepoet = ">=0.42.0"
[tool.poetry.dependencies]
python = "^3.10"
tomli = { version = "^2.0.1", python = "<3.11" }
[tool.poetry.group.dev.dependencies]
pytest = "^8.3.4"
pytest-randomly = "^3.16.0"
ruff = "^0.8.6"
tox = "^4.23.2"
virtualenv-pyenv = "^0.5.0"
[tool.poetry.dev-dependencies]
pytest = "^7.1.2"
pytest-randomly = "^3.12.0"
pytest-repeat = "^0.9.1"
black = "^22.3.0"
isort = "^5.10.1"
tox = "^4.6.3"
[build-system]
requires = ["poetry-core>=2.0.0,<3.0.0"]
requires = ["poetry-core>=1.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.poetry.scripts]
dsl = "scripts:ex_dsl"
events = "scripts:ex_events"
gui = "scripts:ex_gui"
levels = "scripts:ex_levels"
midi = "scripts:ex_midi"
obs = "scripts:ex_obs"
observer = "scripts:ex_observer"
test = "scripts:test"
[tool.tox]
legacy_tox_ini = """
[tox]
envlist = py310,py311
[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"]
[testenv]
allowlist_externals = poetry
commands =
poetry install -v
poetry run pytest tests/
"""

49
scripts.py
View File

@@ -1,67 +1,42 @@
import os
import subprocess
import sys
from pathlib import Path
def ex_dsl():
subprocess.run(['tox', 'r', '-e', 'dsl'])
scriptpath = Path.cwd() / "examples" / "dsl" / "."
subprocess.run([sys.executable, str(scriptpath)])
def ex_callbacks():
scriptpath = Path.cwd() / 'examples' / 'events' / 'callbacks' / '.'
def ex_events():
scriptpath = Path.cwd() / "examples" / "events" / "."
subprocess.run([sys.executable, str(scriptpath)])
def ex_gui():
scriptpath = Path.cwd() / 'examples' / 'gui' / '.'
scriptpath = Path.cwd() / "examples" / "gui" / "."
subprocess.run([sys.executable, str(scriptpath)])
def ex_levels():
scriptpath = Path.cwd() / 'examples' / 'levels' / '.'
scriptpath = Path.cwd() / "examples" / "levels" / "."
subprocess.run([sys.executable, str(scriptpath)])
def ex_midi():
scriptpath = Path.cwd() / 'examples' / 'midi' / '.'
scriptpath = Path.cwd() / "examples" / "midi" / "."
subprocess.run([sys.executable, str(scriptpath)])
def ex_obs():
subprocess.run(['tox', 'r', '-e', 'obs'])
scriptpath = Path.cwd() / "examples" / "obs" / "."
subprocess.run([sys.executable, str(scriptpath)])
def ex_observer():
scriptpath = Path.cwd() / 'examples' / 'events' / 'observer' / '.'
scriptpath = Path.cwd() / "examples" / "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}
)
def test():
subprocess.run(["tox"])

7
tests/__init__.py
View File

@@ -1,4 +1,3 @@
import os
import random
import sys
from dataclasses import dataclass
@@ -31,8 +30,8 @@ class Data:
return (2 * self.phys_in) + (8 * self.virt_in)
# get KIND from environment, if not set default to potato
KIND_ID = os.environ.get('KIND', 'potato')
# let's keep things random
KIND_ID = random.choice(tuple(kind_id.name.lower() for kind_id in KindId))
vm = voicemeeterlib.api(KIND_ID)
kind = kindmap(KIND_ID)
@@ -54,7 +53,7 @@ data = Data(
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)
vm.login()
vm.command.reset()

2
tests/reports/badge-banana.svg → tests/banana.svg
View File

@@ -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: 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>
<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: 155"><title>tests: 155</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">155</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">155</text></g></svg>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

2
tests/reports/badge-basic.svg → tests/basic.svg
View File

@@ -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: 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>
<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: 112"><title>tests: 112</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">112</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">112</text></g></svg>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

6
tests/conftest.py
View File

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

2
tests/reports/badge-potato.svg → tests/potato.svg
View File

@@ -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: 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>
<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: 164"><title>tests: 164</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">164</text><text x="515" y="140" transform="scale(.1)" fill="#fff" textLength="210">164</text></g></svg>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

31
tests/pre-commit.ps1 Normal file
View File

@@ -0,0 +1,31 @@
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"
}

34
tests/test_configs.py
View File

@@ -10,39 +10,39 @@ class TestUserConfigs:
@classmethod
def setup_class(cls):
vm.apply_config('example')
vm.apply_config("example")
def test_it_tests_vm_config_string(self):
assert 'PhysStrip' in vm.strip[data.phys_in].label
assert 'VirtStrip' in vm.strip[data.virt_in].label
assert 'PhysBus' in vm.bus[data.phys_out].label
assert 'VirtBus' in vm.bus[data.virt_out].label
def test_it_vm_config_string(self):
assert "PhysStrip" in vm.strip[data.phys_in].label
assert "VirtStrip" in vm.strip[data.virt_in].label
assert "PhysBus" in vm.bus[data.phys_out].label
assert "VirtBus" in vm.bus[data.virt_out].label
def test_it_tests_vm_config_bool(self):
def test_it_vm_config_bool(self):
assert vm.strip[0].A1 == True
@pytest.mark.skipif(
data.name != 'potato',
reason='Skip test if kind is not potato',
data.name != "potato",
reason="Skip test if kind is not potato",
)
def test_it_tests_vm_config_bool_strip_eq_on(self):
def test_it_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',
data.name != "banana",
reason="Skip test if kind is not banana",
)
def test_it_tests_vm_config_bool_bus_eq_ab(self):
def test_it_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_vm_config_busmode(self):
assert vm.bus[data.phys_out].mode.get() == 'composite'
def test_it_vm_config_busmode(self):
assert vm.bus[data.phys_out].mode.get() == "composite"
def test_it_tests_vm_config_bass_med_high(self):
def test_it_vm_config_bass_med_high(self):
assert vm.strip[data.virt_in].bass == -3.2
assert vm.strip[data.virt_in].mid == 1.5
assert vm.strip[data.virt_in].high == 2.1

49
tests/test_errors.py
View File

@@ -1,49 +0,0 @@
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)

70
tests/test_factory.py
View File

@@ -7,17 +7,17 @@ class TestRemoteFactories:
__test__ = True
@pytest.mark.skipif(
data.name != 'basic',
reason='Skip test if kind is not basic',
data.name != "basic",
reason="Skip test if kind is not basic",
)
def test_it_tests_vm_remote_attrs_for_basic(self):
assert hasattr(vm, 'strip')
assert hasattr(vm, 'bus')
assert hasattr(vm, 'command')
assert hasattr(vm, 'button')
assert hasattr(vm, 'vban')
assert hasattr(vm, 'device')
assert hasattr(vm, 'option')
def test_it_vm_remote_attrs_for_basic(self):
assert hasattr(vm, "strip")
assert hasattr(vm, "bus")
assert hasattr(vm, "command")
assert hasattr(vm, "button")
assert hasattr(vm, "vban")
assert hasattr(vm, "device")
assert hasattr(vm, "option")
assert len(vm.strip) == 3
assert len(vm.bus) == 2
@@ -25,19 +25,19 @@ class TestRemoteFactories:
assert len(vm.vban.instream) == 6 and len(vm.vban.outstream) == 5
@pytest.mark.skipif(
data.name != 'banana',
reason='Skip test if kind is not banana',
data.name != "banana",
reason="Skip test if kind is not banana",
)
def test_it_tests_vm_remote_attrs_for_banana(self):
assert hasattr(vm, 'strip')
assert hasattr(vm, 'bus')
assert hasattr(vm, 'command')
assert hasattr(vm, 'button')
assert hasattr(vm, 'vban')
assert hasattr(vm, 'device')
assert hasattr(vm, 'option')
assert hasattr(vm, 'recorder')
assert hasattr(vm, 'patch')
def test_it_vm_remote_attrs_for_banana(self):
assert hasattr(vm, "strip")
assert hasattr(vm, "bus")
assert hasattr(vm, "command")
assert hasattr(vm, "button")
assert hasattr(vm, "vban")
assert hasattr(vm, "device")
assert hasattr(vm, "option")
assert hasattr(vm, "recorder")
assert hasattr(vm, "patch")
assert len(vm.strip) == 5
assert len(vm.bus) == 5
@@ -45,20 +45,20 @@ class TestRemoteFactories:
assert len(vm.vban.instream) == 10 and len(vm.vban.outstream) == 9
@pytest.mark.skipif(
data.name != 'potato',
reason='Skip test if kind is not potato',
data.name != "potato",
reason="Skip test if kind is not potato",
)
def test_it_tests_vm_remote_attrs_for_potato(self):
assert hasattr(vm, 'strip')
assert hasattr(vm, 'bus')
assert hasattr(vm, 'command')
assert hasattr(vm, 'button')
assert hasattr(vm, 'vban')
assert hasattr(vm, 'device')
assert hasattr(vm, 'option')
assert hasattr(vm, 'recorder')
assert hasattr(vm, 'patch')
assert hasattr(vm, 'fx')
def test_it_vm_remote_attrs_for_potato(self):
assert hasattr(vm, "strip")
assert hasattr(vm, "bus")
assert hasattr(vm, "command")
assert hasattr(vm, "button")
assert hasattr(vm, "vban")
assert hasattr(vm, "device")
assert hasattr(vm, "option")
assert hasattr(vm, "recorder")
assert hasattr(vm, "patch")
assert hasattr(vm, "fx")
assert len(vm.strip) == 8
assert len(vm.bus) == 8

340
tests/test_higher.py
View File

@@ -3,18 +3,19 @@ import pytest
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, 'mono'),
(data.virt_in, 'mc'),
(data.phys_in, "mute"),
(data.phys_in, "mono"),
(data.virt_in, "mc"),
(data.virt_in, "mono"),
],
)
def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
@@ -24,14 +25,14 @@ class TestSetAndGetBoolHigher:
""" strip EQ tests, physical """
@pytest.mark.skipif(
data.name != 'potato',
reason='Skip test if kind is not potato',
data.name != "potato",
reason="Skip test if kind is not potato",
)
@pytest.mark.parametrize(
'index,param',
"index,param",
[
(data.phys_in, 'on'),
(data.phys_in, 'ab'),
(data.phys_in, "on"),
(data.phys_in, "ab"),
],
)
def test_it_sets_and_gets_strip_eq_bool_params(self, index, param, value):
@@ -42,10 +43,10 @@ class TestSetAndGetBoolHigher:
""" bus tests, physical and virtual """
@pytest.mark.parametrize(
'index,param',
"index,param",
[
(data.phys_out, 'mute'),
(data.virt_out, 'sel'),
(data.phys_out, "mute"),
(data.virt_out, "sel"),
],
)
def test_it_sets_and_gets_bus_bool_params(self, index, param, value):
@@ -56,10 +57,10 @@ class TestSetAndGetBoolHigher:
""" bus EQ tests, physical and virtual """
@pytest.mark.parametrize(
'index,param',
"index,param",
[
(data.phys_out, 'on'),
(data.virt_out, 'ab'),
(data.phys_out, "on"),
(data.virt_out, "ab"),
],
)
def test_it_sets_and_gets_bus_eq_bool_params(self, index, param, value):
@@ -70,16 +71,16 @@ class TestSetAndGetBoolHigher:
""" bus modes tests, physical and virtual """
@pytest.mark.skipif(
data.name != 'basic',
reason='Skip test if kind is not basic',
data.name != "basic",
reason="Skip test if kind is not basic",
)
@pytest.mark.parametrize(
'index,param',
"index,param",
[
(data.phys_out, 'normal'),
(data.phys_out, 'amix'),
(data.virt_out, 'normal'),
(data.virt_out, 'composite'),
(data.phys_out, "normal"),
(data.phys_out, "amix"),
(data.virt_out, "normal"),
(data.virt_out, "composite"),
],
)
def test_it_sets_and_gets_busmode_basic_bool_params(self, index, param, value):
@@ -87,18 +88,18 @@ class TestSetAndGetBoolHigher:
assert getattr(vm.bus[index].mode, param) == value
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index,param',
"index,param",
[
(data.phys_out, 'normal'),
(data.phys_out, 'amix'),
(data.phys_out, 'rearonly'),
(data.virt_out, 'normal'),
(data.virt_out, 'upmix41'),
(data.virt_out, 'composite'),
(data.phys_out, "normal"),
(data.phys_out, "amix"),
(data.phys_out, "rearonly"),
(data.virt_out, "normal"),
(data.virt_out, "upmix41"),
(data.virt_out, "composite"),
],
)
def test_it_sets_and_gets_busmode_bool_params(self, index, param, value):
@@ -108,8 +109,8 @@ class TestSetAndGetBoolHigher:
""" macrobutton tests """
@pytest.mark.parametrize(
'index,param',
[(data.button_lower, 'state'), (data.button_upper, 'trigger')],
"index,param",
[(data.button_lower, "state"), (data.button_upper, "trigger")],
)
def test_it_sets_and_gets_macrobutton_bool_params(self, index, param, value):
setattr(vm.button[index], param, value)
@@ -118,8 +119,8 @@ class TestSetAndGetBoolHigher:
""" vban instream tests """
@pytest.mark.parametrize(
'index,param',
[(data.vban_in, 'on')],
"index,param",
[(data.vban_in, "on")],
)
def test_it_sets_and_gets_vban_instream_bool_params(self, index, param, value):
setattr(vm.vban.instream[index], param, value)
@@ -128,8 +129,8 @@ class TestSetAndGetBoolHigher:
""" vban outstream tests """
@pytest.mark.parametrize(
'index,param',
[(data.vban_out, 'on')],
"index,param",
[(data.vban_out, "on")],
)
def test_it_sets_and_gets_vban_outstream_bool_params(self, index, param, value):
setattr(vm.vban.outstream[index], param, value)
@@ -138,8 +139,8 @@ class TestSetAndGetBoolHigher:
""" command tests """
@pytest.mark.parametrize(
'param',
[('lock')],
"param",
[("lock")],
)
def test_it_sets_command_bool_params(self, param, value):
setattr(vm.command, param, value)
@@ -147,12 +148,12 @@ class TestSetAndGetBoolHigher:
""" recorder tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'param',
[('A1'), ('B2')],
"param",
[("A1"), ("B2")],
)
def test_it_sets_and_gets_recorder_bool_params(self, param, value):
assert hasattr(vm.recorder, param)
@@ -160,12 +161,12 @@ class TestSetAndGetBoolHigher:
assert getattr(vm.recorder, param) == value
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'param',
[('loop')],
"param",
[("loop")],
)
def test_it_sets_recorder_bool_params(self, param, value):
assert hasattr(vm.recorder, param)
@@ -175,12 +176,12 @@ class TestSetAndGetBoolHigher:
""" recoder.mode tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'param',
[('loop'), ('recbus')],
"param",
[("loop"), ("recbus")],
)
def test_it_sets_recorder_mode_bool_params(self, param, value):
assert hasattr(vm.recorder.mode, param)
@@ -190,11 +191,11 @@ class TestSetAndGetBoolHigher:
""" recorder.armstrip """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index',
"index",
[
(data.phys_out),
(data.virt_out),
@@ -206,11 +207,11 @@ class TestSetAndGetBoolHigher:
""" recorder.armbus """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index',
"index",
[
(data.phys_out),
(data.virt_out),
@@ -222,12 +223,12 @@ class TestSetAndGetBoolHigher:
""" fx tests """
@pytest.mark.skipif(
data.name != 'potato',
reason='Skip test if kind is not potato',
data.name != "potato",
reason="Skip test if kind is not potato",
)
@pytest.mark.parametrize(
'param',
[('reverb'), ('reverb_ab'), ('delay'), ('delay_ab')],
"param",
[("reverb"), ("reverb_ab"), ("delay"), ("delay_ab")],
)
def test_it_sets_and_gets_fx_bool_params(self, param, value):
setattr(vm.fx, param, value)
@@ -236,12 +237,12 @@ class TestSetAndGetBoolHigher:
""" patch tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'param',
[('postfadercomposite')],
"param",
[("postfadercomposite")],
)
def test_it_sets_and_gets_patch_bool_params(self, param, value):
setattr(vm.patch, param, value)
@@ -250,12 +251,12 @@ class TestSetAndGetBoolHigher:
""" patch.insert tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index, param',
[(data.insert_lower, 'on'), (data.insert_higher, 'on')],
"index, param",
[(data.insert_lower, "on"), (data.insert_higher, "on")],
)
def test_it_sets_and_gets_patch_insert_bool_params(self, index, param, value):
setattr(vm.patch.insert[index], param, value)
@@ -264,8 +265,8 @@ class TestSetAndGetBoolHigher:
""" option tests """
@pytest.mark.parametrize(
'param',
[('monitoronsel')],
"param",
[("monitoronsel")],
)
def test_it_sets_and_gets_option_bool_params(self, param, value):
setattr(vm.option, param, value)
@@ -278,49 +279,36 @@ 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', 12),
(data.virt_in - 1, 'k', 0),
(data.virt_in - 1, 'k', 4),
(data.phys_in, "limit", -40),
(data.phys_in, "limit", 12),
(data.virt_in, "k", 0),
(data.virt_in, "k", 4),
],
)
def test_it_sets_and_gets_strip_int_params(self, index, param, value):
def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
setattr(vm.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',
[(data.vban_out, 'sr', 48000)],
"index,param,value",
[(data.vban_out, "sr", 48000)],
)
def test_it_sets_and_gets_vban_outstream_int_params(self, index, param, value):
def test_it_sets_and_gets_vban_outstream_bool_params(self, index, param, value):
setattr(vm.vban.outstream[index], param, value)
assert getattr(vm.vban.outstream[index], param) == value
""" patch.asio tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index,value',
"index,value",
[
(0, 1),
(data.asio_in, 4),
@@ -333,11 +321,11 @@ class TestSetAndGetIntHigher:
""" patch.A2[i]-A5[i] tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index,value',
"index,value",
[
(0, 1),
(data.asio_out, 4),
@@ -352,11 +340,11 @@ class TestSetAndGetIntHigher:
""" patch.composite tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index,value',
"index,value",
[
(0, 3),
(0, data.channels),
@@ -371,11 +359,11 @@ class TestSetAndGetIntHigher:
""" option tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'index,value',
"index,value",
[
(data.phys_out, 30),
(data.phys_out, 500),
@@ -388,16 +376,16 @@ class TestSetAndGetIntHigher:
""" recorder tests """
@pytest.mark.skipif(
data.name == 'basic',
reason='Skip test if kind is basic',
data.name == "basic",
reason="Skip test if kind is basic",
)
@pytest.mark.parametrize(
'param,value',
"param,value",
[
('samplerate', 32000),
('samplerate', 96000),
('bitresolution', 16),
('bitresolution', 32),
("samplerate", 32000),
("samplerate", 96000),
("bitresolution", 16),
("bitresolution", 32),
],
)
def test_it_sets_and_gets_recorder_int_params(self, param, value):
@@ -412,10 +400,10 @@ class TestSetAndGetFloatHigher:
"""strip tests, physical and virtual"""
@pytest.mark.parametrize(
'index,param,value',
"index,param,value",
[
(data.phys_in, 'gain', -3.6),
(data.virt_in, 'gain', 5.8),
(data.phys_in, "gain", -3.6),
(data.virt_in, "gain", 5.8),
],
)
def test_it_sets_and_gets_strip_float_params(self, index, param, value):
@@ -423,25 +411,25 @@ class TestSetAndGetFloatHigher:
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(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(vm.strip[index].levels.postmute) == value
@pytest.mark.skipif(
data.name != 'potato',
reason='Only test if logged into Potato version',
data.name != "potato",
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),
@@ -456,12 +444,12 @@ class TestSetAndGetFloatHigher:
""" 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, 'color_y', 0.8),
(data.phys_in, 'fx_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, "fx_x", -0.6),
],
)
def test_it_sets_and_gets_strip_xy_params(self, index, param, value):
@@ -470,14 +458,14 @@ class TestSetAndGetFloatHigher:
assert getattr(vm.strip[index], param) == value
@pytest.mark.skipif(
data.name != 'potato',
reason='Only test if logged into Potato version',
data.name != "potato",
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, 'postfx1', True),
(data.phys_in, "reverb", -1.6),
(data.phys_in, "postfx1", True),
],
)
def test_it_sets_and_gets_strip_effects_params(self, index, param, value):
@@ -486,14 +474,14 @@ class TestSetAndGetFloatHigher:
assert getattr(vm.strip[index], param) == value
@pytest.mark.skipif(
data.name != 'potato',
reason='Only test if logged into Potato version',
data.name != "potato",
reason="Only test if logged into Potato version",
)
@pytest.mark.parametrize(
'index, param, value',
"index, param, value",
[
(data.phys_in, 'gainin', -8.6),
(data.phys_in, 'knee', 0.5),
(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):
@@ -502,14 +490,14 @@ class TestSetAndGetFloatHigher:
assert getattr(vm.strip[index].comp, param) == value
@pytest.mark.skipif(
data.name != 'potato',
reason='Only test if logged into Potato version',
data.name != "potato",
reason="Only test if logged into Potato version",
)
@pytest.mark.parametrize(
'index, param, value',
"index, param, value",
[
(data.phys_in, 'bpsidechain', 120),
(data.phys_in, 'hold', 3000),
(data.phys_in, "bpsidechain", 120),
(data.phys_in, "hold", 3000),
],
)
def test_it_sets_and_gets_strip_gate_params(self, index, param, value):
@@ -518,13 +506,13 @@ class TestSetAndGetFloatHigher:
assert getattr(vm.strip[index].gate, param) == value
@pytest.mark.skipif(
data.name != 'potato',
reason='Only test if logged into Potato version',
data.name != "potato",
reason="Only test if logged into Potato version",
)
@pytest.mark.parametrize(
'index, param, value',
"index, param, value",
[
(data.phys_in, 'knob', -8.6),
(data.phys_in, "knob", -8.6),
],
)
def test_it_sets_and_gets_strip_denoiser_params(self, index, param, value):
@@ -534,13 +522,13 @@ class TestSetAndGetFloatHigher:
""" strip tests, virtual """
@pytest.mark.parametrize(
'index, param, value',
"index, param, value",
[
(data.virt_in, 'pan_x', -0.6),
(data.virt_in, 'pan_x', 0.6),
(data.virt_in, 'treble', -1.6),
(data.virt_in, 'mid', 5.8),
(data.virt_in, 'bass', -8.1),
(data.virt_in, "pan_x", -0.6),
(data.virt_in, "pan_x", 0.6),
(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):
@@ -550,12 +538,12 @@ class TestSetAndGetFloatHigher:
""" bus tests, physical and virtual """
@pytest.mark.skipif(
data.name != 'potato',
reason='Only test if logged into Potato version',
data.name != "potato",
reason="Only test if logged into Potato version",
)
@pytest.mark.parametrize(
'index, param, value',
[(data.phys_out, 'returnreverb', 3.6), (data.virt_out, 'returnfx1', 5.8)],
"index, param, value",
[(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(vm.bus[index], param)
@@ -563,30 +551,30 @@ class TestSetAndGetFloatHigher:
assert getattr(vm.bus[index], param) == value
@pytest.mark.parametrize(
'index, param, value',
[(data.phys_out, 'gain', -3.6), (data.virt_out, 'gain', 5.8)],
"index, param, value",
[(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(vm.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_bus_levels_and_compares_length_of_array(self, index, value):
def test_it_gets_prefader_levels_and_compares_length_of_array(self, index, 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',
[(data.phys_in, 'label'), (data.virt_in, 'label')],
"index, param",
[(data.phys_in, "label"), (data.virt_in, "label")],
)
def test_it_sets_and_gets_strip_string_params(self, index, param, value):
setattr(vm.strip[index], param, value)
@@ -595,8 +583,8 @@ class TestSetAndGetStringHigher:
""" bus tests, physical and virtual """
@pytest.mark.parametrize(
'index, param',
[(data.phys_out, 'label'), (data.virt_out, 'label')],
"index, param",
[(data.phys_out, "label"), (data.virt_out, "label")],
)
def test_it_sets_and_gets_bus_string_params(self, index, param, value):
setattr(vm.bus[index], param, value)
@@ -605,8 +593,8 @@ class TestSetAndGetStringHigher:
""" vban instream tests """
@pytest.mark.parametrize(
'index, param',
[(data.vban_in, 'name')],
"index, param",
[(data.vban_in, "name")],
)
def test_it_sets_and_gets_vban_instream_string_params(self, index, param, value):
setattr(vm.vban.instream[index], param, value)
@@ -615,29 +603,29 @@ class TestSetAndGetStringHigher:
""" vban outstream tests """
@pytest.mark.parametrize(
'index, param',
[(data.vban_out, 'name')],
"index, param",
[(data.vban_out, "name")],
)
def test_it_sets_and_gets_vban_outstream_string_params(self, index, param, value):
setattr(vm.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'),
(39, 'stateonly'),
(69, 'trigger'),
(22, 'stateonly'),
(45, 'state'),
(65, 'trigger'),
(0, "state"),
(39, "stateonly"),
(69, "trigger"),
(22, "stateonly"),
(45, "state"),
(65, "trigger"),
],
)
def test_it_sets_and_gets_macrobutton_params(self, index, param, value):

32
tests/test_lower.py
View File

@@ -9,12 +9,12 @@ class TestSetAndGetFloatLower:
"""VBVMR_SetParameterFloat, VBVMR_GetParameterFloat"""
@pytest.mark.parametrize(
'param,value',
"param,value",
[
(f'Strip[{data.phys_in}].Mute', 1),
(f'Bus[{data.virt_out}].Eq.on', 1),
(f'Strip[{data.phys_in}].Mute', 0),
(f'Bus[{data.virt_out}].Eq.on', 0),
(f"Strip[{data.phys_in}].Mute", 1),
(f"Bus[{data.virt_out}].Eq.on", 1),
(f"Strip[{data.phys_in}].Mute", 0),
(f"Bus[{data.virt_out}].Eq.on", 0),
],
)
def test_it_sets_and_gets_mute_eq_float_params(self, param, value):
@@ -22,11 +22,11 @@ class TestSetAndGetFloatLower:
assert (round(vm.get(param))) == value
@pytest.mark.parametrize(
'param,value',
"param,value",
[
(f'Strip[{data.phys_in}].Comp', 5.3),
(f'Strip[{data.virt_in}].Gain', -37.5),
(f'Bus[{data.virt_out}].Gain', -22.7),
(f"Strip[{data.phys_in}].Comp", 5.3),
(f"Strip[{data.virt_in}].Gain", -37.5),
(f"Bus[{data.virt_out}].Gain", -22.7),
],
)
def test_it_sets_and_gets_comp_gain_float_params(self, param, value):
@@ -34,29 +34,29 @@ class TestSetAndGetFloatLower:
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',
[(f'Strip[{data.phys_out}].label'), (f'Bus[{data.virt_out}].label')],
"param",
[(f"Strip[{data.phys_out}].label"), (f"Bus[{data.virt_out}].label")],
)
def test_it_sets_and_gets_string_params(self, param, value):
vm.set(param, 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):
@@ -64,7 +64,7 @@ class TestMacroButtonsLower:
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):
@@ -72,7 +72,7 @@ class TestMacroButtonsLower:
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):

42
tox.ini
View File

@@ -1,42 +0,0 @@
[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

2
voicemeeterlib/__init__.py
View File

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

229
voicemeeterlib/bus.py
View File

@@ -1,16 +1,16 @@
import abc
import time
from abc import abstractmethod
from enum import IntEnum
from math import log
from typing import Union
from . import kinds
from .iremote import IRemote
from .kinds import kinds_all
from .meta import bus_mode_prop, device_prop, float_prop
BusModes = IntEnum(
'BusModes',
'normal amix bmix repeat composite tvmix upmix21 upmix41 upmix61 centeronly lfeonly rearonly',
"BusModes",
"normal amix bmix repeat composite tvmix upmix21 upmix41 upmix61 centeronly lfeonly rearonly",
start=0,
)
@@ -22,188 +22,91 @@ class Bus(IRemote):
Defines concrete implementation for bus
"""
@abc.abstractmethod
@abstractmethod
def __str__(self):
pass
@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) -> int:
return int(self.getter('mono'))
def mono(self) -> bool:
return self.getter("mono") == 1
@mono.setter
def mono(self, val: int):
self.setter('mono', val)
def mono(self, val: bool):
self.setter("mono", 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'
return f"Bus[{self.index}].eq"
@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 ab(self) -> bool:
return self.getter('ab') == 1
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)
self.setter("ab", 1 if val else 0)
class PhysicalBus(Bus):
@@ -215,19 +118,19 @@ class PhysicalBus(Bus):
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',
"PhysicalBus",
kls,
{
'device': BusDevice.make(remote, i),
"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):
@@ -239,16 +142,16 @@ class BusDevice(IRemote):
Returns a BusDevice class of a kind.
"""
DEVICE_cls = type(
f'BusDevice{remote.kind}',
f"BusDevice{remote.kind}",
(cls,),
{
**{
param: device_prop(param)
for param in [
'wdm',
'ks',
'mme',
'asio',
"wdm",
"ks",
"mme",
"asio",
]
},
},
@@ -257,20 +160,20 @@ class BusDevice(IRemote):
@property
def identifier(self) -> str:
return f'Bus[{self.index}].device'
return f"Bus[{self.index}].device"
@property
def name(self) -> str:
return self.getter('name', is_string=True)
return self.getter("name", is_string=True)
@property
def sr(self) -> int:
return int(self.getter('sr'))
return int(self.getter("sr"))
class VirtualBus(Bus):
@classmethod
def make(cls, remote, i, kind):
def make(cls, kind):
"""
Factory method for VirtualBus.
@@ -279,21 +182,15 @@ class VirtualBus(Bus):
Returns a VirtualBus class.
"""
kls = (cls,)
if kind.name == 'basic':
return type(
'VirtualBus',
kls,
{
'device': BusDevice.make(remote, i),
},
)
elif kind.name == 'potato':
if kind.name == "basic":
kls += (PhysicalBus,)
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):
@@ -313,8 +210,8 @@ class BusLevel(IRemote):
def fget(x):
return round(20 * log(x, 10), 1) if x > 0 else -200.0
if not self._remote.stopped() and self._remote.event.ldirty:
vals = self._remote.cache['bus_level'][self.range[0] : self.range[-1]]
if self._remote.running and self._remote.event.ldirty:
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)]
@@ -322,7 +219,7 @@ class BusLevel(IRemote):
@property
def identifier(self) -> str:
return f'Bus[{self.index}]'
return f"Bus[{self.index}]"
@property
def all(self) -> tuple:
@@ -335,7 +232,7 @@ class BusLevel(IRemote):
Expected to be used in a callback only.
"""
if not self._remote.stopped():
if self._remote.running:
return any(self._remote._bus_comp[self.range[0] : self.range[-1]])
is_updated = isdirty
@@ -345,14 +242,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)
@@ -373,15 +270,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,
},
)
@@ -389,12 +286,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}')
for param in ['reverb', 'delay', 'fx1', 'fx2']
f"return{param}": float_prop(f"return{param}")
for param in ["reverb", "delay", "fx1", "fx2"]
},
},
)
@@ -409,16 +306,16 @@ def bus_factory(is_phys_bus, remote, i) -> Union[PhysicalBus, VirtualBus]:
BUS_cls = (
PhysicalBus.make(remote, i, remote.kind)
if is_phys_bus
else VirtualBus.make(remote, i, remote.kind)
else VirtualBus.make(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),
'mode': BUSMODEMIXIN_cls(remote, i),
'eq': BusEQ.make(remote, i),
"levels": BusLevel(remote, i),
"mode": BUSMODEMIXIN_cls(remote, i),
"eq": BusEQ(remote, i),
},
)(remote, i)

111
voicemeeterlib/cbindings.py
View File

@@ -1,5 +1,6 @@
import ctypes as ct
import logging
from abc import ABCMeta
from ctypes.wintypes import CHAR, FLOAT, LONG, WCHAR
from .error import CAPIError
@@ -8,13 +9,14 @@ from .inst import libc
logger = logging.getLogger(__name__)
class CBindings:
"""Class responsible for defining C function bindings.
class CBindings(metaclass=ABCMeta):
"""
C bindings defined here.
Wrapper methods are provided for each C function to handle error checking and logging.
Maps expected ctype argument and res types for each binding.
"""
logger_cbindings = logger.getChild('CBindings')
logger_cbindings = logger.getChild("CBindings")
bind_login = libc.VBVMR_Login
bind_login.restype = LONG
@@ -36,17 +38,17 @@ class CBindings:
bind_get_voicemeeter_version.restype = LONG
bind_get_voicemeeter_version.argtypes = [ct.POINTER(LONG)]
if hasattr(libc, 'VBVMR_MacroButton_IsDirty'):
if hasattr(libc, "VBVMR_MacroButton_IsDirty"):
bind_macro_button_is_dirty = libc.VBVMR_MacroButton_IsDirty
bind_macro_button_is_dirty.restype = LONG
bind_macro_button_is_dirty.argtypes = None
if hasattr(libc, 'VBVMR_MacroButton_GetStatus'):
if hasattr(libc, "VBVMR_MacroButton_GetStatus"):
bind_macro_button_get_status = libc.VBVMR_MacroButton_GetStatus
bind_macro_button_get_status.restype = LONG
bind_macro_button_get_status.argtypes = [LONG, ct.POINTER(FLOAT), LONG]
if hasattr(libc, 'VBVMR_MacroButton_SetStatus'):
if hasattr(libc, "VBVMR_MacroButton_SetStatus"):
bind_macro_button_set_status = libc.VBVMR_MacroButton_SetStatus
bind_macro_button_set_status.restype = LONG
bind_macro_button_set_status.argtypes = [LONG, FLOAT, LONG]
@@ -109,8 +111,7 @@ class CBindings:
bind_get_midi_message.restype = LONG
bind_get_midi_message.argtypes = [ct.POINTER(CHAR * 1024), LONG]
def _call(self, func, *args, ok=(0,), ok_exp=None):
"""Call a C function and handle errors."""
def call(self, func, *args, ok=(0,), ok_exp=None):
try:
res = func(*args)
if ok_exp is None:
@@ -120,95 +121,5 @@ class CBindings:
raise CAPIError(func.__name__, res)
return res
except CAPIError as e:
self.logger_cbindings.exception(f'{type(e).__name__}: {e}')
self.logger_cbindings.exception(str(e))
raise
def login(self, **kwargs):
"""Login to Voicemeeter API"""
return self._call(self.bind_login, **kwargs)
def logout(self):
"""Logout from Voicemeeter API"""
return self._call(self.bind_logout)
def run_voicemeeter(self, value):
"""Run Voicemeeter with specified type"""
return self._call(self.bind_run_voicemeeter, value)
def get_voicemeeter_type(self, type_ref):
"""Get Voicemeeter type"""
return self._call(self.bind_get_voicemeeter_type, type_ref)
def get_voicemeeter_version(self, version_ref):
"""Get Voicemeeter version"""
return self._call(self.bind_get_voicemeeter_version, version_ref)
def is_parameters_dirty(self, **kwargs):
"""Check if parameters are dirty"""
return self._call(self.bind_is_parameters_dirty, **kwargs)
def macro_button_is_dirty(self, **kwargs):
"""Check if macro button parameters are dirty"""
if hasattr(self, 'bind_macro_button_is_dirty'):
return self._call(self.bind_macro_button_is_dirty, **kwargs)
raise AttributeError('macro_button_is_dirty not available')
def get_parameter_float(self, param_name, value_ref):
"""Get float parameter value"""
return self._call(self.bind_get_parameter_float, param_name, value_ref)
def set_parameter_float(self, param_name, value):
"""Set float parameter value"""
return self._call(self.bind_set_parameter_float, param_name, value)
def get_parameter_string_w(self, param_name, buffer_ref):
"""Get string parameter value (Unicode)"""
return self._call(self.bind_get_parameter_string_w, param_name, buffer_ref)
def set_parameter_string_w(self, param_name, value):
"""Set string parameter value (Unicode)"""
return self._call(self.bind_set_parameter_string_w, param_name, value)
def macro_button_get_status(self, id_, state_ref, mode):
"""Get macro button status"""
if hasattr(self, 'bind_macro_button_get_status'):
return self._call(self.bind_macro_button_get_status, id_, state_ref, mode)
raise AttributeError('macro_button_get_status not available')
def macro_button_set_status(self, id_, state, mode):
"""Set macro button status"""
if hasattr(self, 'bind_macro_button_set_status'):
return self._call(self.bind_macro_button_set_status, id_, state, mode)
raise AttributeError('macro_button_set_status not available')
def get_level(self, type_, index, value_ref):
"""Get audio level"""
return self._call(self.bind_get_level, type_, index, value_ref)
def input_get_device_number(self, **kwargs):
"""Get number of input devices"""
return self._call(self.bind_input_get_device_number, **kwargs)
def output_get_device_number(self, **kwargs):
"""Get number of output devices"""
return self._call(self.bind_output_get_device_number, **kwargs)
def input_get_device_desc_w(self, index, type_ref, name_ref, hwid_ref):
"""Get input device description"""
return self._call(
self.bind_input_get_device_desc_w, index, type_ref, name_ref, hwid_ref
)
def output_get_device_desc_w(self, index, type_ref, name_ref, hwid_ref):
"""Get output device description"""
return self._call(
self.bind_output_get_device_desc_w, index, type_ref, name_ref, hwid_ref
)
def get_midi_message(self, buffer_ref, length, **kwargs):
"""Get MIDI message"""
return self._call(self.bind_get_midi_message, buffer_ref, length, **kwargs)
def set_parameters(self, script):
"""Set multiple parameters via script"""
return self._call(self.bind_set_parameters, script)

16
voicemeeterlib/command.py
View File

@@ -17,33 +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_fn(param) for param in ['show', 'shutdown', 'restart']
param: action_fn(param) for param in ["show", "shutdown", "restart"]
},
'hide': action_fn('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")

91
voicemeeterlib/config.py
View File

@@ -20,72 +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'bus-{i}' for i in range(kind.num_bus)],
[f"strip-{i}" for i in range(kind.num_strip)],
[f"bus-{i}" for i in range(kind.num_bus)],
)
def init_config(self, profile=None):
self.virt_strip_params = (
[
'mute = false',
'mono = false',
'solo = false',
'gain = 0.0',
"mute = false",
"mono = false",
"solo = false",
"gain = 0.0",
]
+ [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"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)]
)
self.phys_strip_params = self.virt_strip_params + [
'comp.knob = 0.0',
'gate.knob = 0.0',
'denoiser.knob = 0.0',
'eq.on = false',
"comp.knob = 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',
"mono = false",
"eq.on = false",
"mute = false",
"gain = 0.0",
]
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':
toml_str += ('\n').join(
case "strip":
toml_str += ("\n").join(
self.phys_strip_params
if int(index) < self.kind.phys_in
else self.virt_strip_params
)
case 'bus':
toml_str += ('\n').join(self.bus_params)
case "bus":
toml_str += ("\n").join(self.bus_params)
case _:
pass
return toml_str + '\n'
return toml_str + "\n"
class TOMLDataExtractor:
def __init__(self, file):
with open(file, 'rb') as f:
with open(file, "rb") as f:
self._data = tomllib.load(f)
@property
@@ -103,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)
@@ -140,25 +140,20 @@ 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:
self.logger.info(
f'config file with name {identifier} already in memory, skipping..'
f"config file with name {identifier} already in memory, skipping.."
)
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 False
self.parser = dataextraction_factory(data)
return True
def register(self, identifier, data=None):
self._configs[identifier] = data if data else self.parser.data
self.logger.info(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()
@@ -181,18 +176,18 @@ def loader(kind):
returns configs loaded into memory
"""
logger_loader = logger.getChild('loader')
logger_loader = logger.getChild("loader")
loader = Loader(kind)
for path in (
Path.cwd() / 'configs' / kind.name,
Path.home() / '.config' / 'voicemeeter' / kind.name,
Path.home() / 'Documents' / 'Voicemeeter' / 'configs' / kind.name,
Path.cwd() / "configs" / kind.name,
Path.home() / ".config" / "voicemeeter" / kind.name,
Path.home() / "Documents" / "Voicemeeter" / "configs" / kind.name,
):
if path.is_dir():
logger_loader.info(f'Checking [{path}] for TOML config files:')
for file in path.glob('*.toml'):
identifier = file.with_suffix('').stem
logger_loader.info(f"Checking [{path}] for TOML config files:")
for file in path.glob("*.toml"):
identifier = file.with_suffix("").stem
if loader.parse(identifier, file):
loader.register(identifier)
return loader.configs
@@ -207,5 +202,5 @@ def request_config(kind_id: str):
try:
configs = loader(kindmap(kind_id))
except KeyError as e:
raise VMError(f'Unknown Voicemeeter kind {kind_id}') from e
raise VMError(f"Unknown Voicemeeter kind {kind_id}") from e
return configs

31
voicemeeterlib/device.py
View File

@@ -1,4 +1,4 @@
import abc
from abc import abstractmethod
from typing import Union
from .iremote import IRemote
@@ -7,22 +7,23 @@ from .iremote import IRemote
class Adapter(IRemote):
"""Adapter to the common interface."""
@abc.abstractmethod
@abstractmethod
def ins(self):
pass
@abc.abstractmethod
@abstractmethod
def outs(self):
pass
@abc.abstractmethod
@abstractmethod
def input(self):
pass
@abc.abstractmethod
@abstractmethod
def output(self):
pass
@property
def identifier(self):
pass
@@ -31,8 +32,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'}
return {'name': vals[0], 'type': types[vals[1]], 'id': vals[2]}
types = {1: "mme", 3: "wdm", 4: "ks", 5: "asio"}
return {"name": vals[0], "type": types[vals[1]], "id": vals[2]}
class Device(Adapter):
@@ -47,26 +48,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),
'outs': property(num_outs),
"ins": property(num_ins),
"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")

31
voicemeeterlib/error.py
View File

@@ -1,24 +1,19 @@
class VMError(Exception):
"""Base voicemeeterlib exception class."""
class InstallError(VMError):
class InstallError(Exception):
"""Exception raised when installation errors occur"""
class CAPIError(VMError):
"""Exception raised when the C-API returns an error code"""
class CAPIError(Exception):
"""Exception raised when the C-API returns error values"""
def __init__(self, fn_name, code):
def __init__(self, fn_name, code, msg=None):
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)
self.message = msg if msg else f"{fn_name} returned {code}"
super().__init__(self.message)
def __str__(self):
return f"{type(self).__name__}: {self.message}"
class VMError(Exception):
"""Exception raised when general errors occur"""

22
voicemeeterlib/event.py
View File

@@ -12,47 +12,47 @@ class Event:
self.logger = logger.getChild(self.__class__.__name__)
def info(self, msg=None):
info = (f'{msg} events',) if msg else ()
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))
info += (f"not listening for any events",)
self.logger.info(", ".join(info))
@property
def pdirty(self) -> bool:
return self.subs['pdirty']
return self.subs["pdirty"]
@pdirty.setter
def pdirty(self, val: bool):
self.subs['pdirty'] = val
self.subs["pdirty"] = val
self.info(f"pdirty {'added to' if val else 'removed from'}")
@property
def mdirty(self) -> bool:
return self.subs['mdirty']
return self.subs["mdirty"]
@mdirty.setter
def mdirty(self, val: bool):
self.subs['mdirty'] = val
self.subs["mdirty"] = val
self.info(f"mdirty {'added to' if val else 'removed from'}")
@property
def midi(self) -> bool:
return self.subs['midi']
return self.subs["midi"]
@midi.setter
def midi(self, val: bool):
self.subs['midi'] = val
self.subs["midi"] = val
self.info(f"midi {'added to' if val else 'removed from'}")
@property
def ldirty(self) -> bool:
return self.subs['ldirty']
return self.subs["ldirty"]
@ldirty.setter
def ldirty(self, val: bool):
self.subs['ldirty'] = val
self.subs["ldirty"] = val
self.info(f"ldirty {'added to' if val else 'removed from'}")
def get(self) -> list:

68
voicemeeterlib/factory.py
View File

@@ -1,7 +1,8 @@
import logging
from abc import abstractmethod
from enum import IntEnum
from functools import cached_property
from typing import Iterable
from typing import Iterable, NoReturn
from . import misc
from .bus import request_bus_obj as bus
@@ -28,8 +29,8 @@ class FactoryBuilder:
"""
BuilderProgress = IntEnum(
'BuilderProgress',
'strip bus command macrobutton vban device option recorder patch fx',
"BuilderProgress",
"strip bus command macrobutton vban device option recorder patch fx",
start=0,
)
@@ -37,22 +38,22 @@ class FactoryBuilder:
self._factory = factory
self.kind = kind
self._info = (
f'Finished building strips for {self._factory}',
f'Finished building buses for {self._factory}',
f'Finished building commands for {self._factory}',
f'Finished building macrobuttons for {self._factory}',
f'Finished building vban in/out streams for {self._factory}',
f'Finished building device for {self._factory}',
f'Finished building option for {self._factory}',
f'Finished building recorder for {self._factory}',
f'Finished building patch for {self._factory}',
f'Finished building fx for {self._factory}',
f"Finished building strips for {self._factory}",
f"Finished building buses for {self._factory}",
f"Finished building commands for {self._factory}",
f"Finished building macrobuttons for {self._factory}",
f"Finished building vban in/out streams for {self._factory}",
f"Finished building device for {self._factory}",
f"Finished building option for {self._factory}",
f"Finished building recorder for {self._factory}",
f"Finished building patch for {self._factory}",
f"Finished building fx for {self._factory}",
)
self.logger = logger.getChild(self.__class__.__name__)
def _pinfo(self, name: str) -> None:
def _pinfo(self, name: str) -> NoReturn:
"""prints progress status for each step"""
name = name.split('_')[1]
name = name.split("_")[1]
self.logger.debug(self._info[int(getattr(self.BuilderProgress, name))])
def make_strip(self):
@@ -107,17 +108,15 @@ class FactoryBase(Remote):
def __init__(self, kind_id: str, **kwargs):
defaultkwargs = {
'sync': False,
'ratelimit': 0.033,
'pdirty': False,
'mdirty': False,
'midi': False,
'ldirty': False,
'timeout': 2,
'bits': 64,
"sync": False,
"ratelimit": 0.033,
"pdirty": False,
"mdirty": False,
"midi": False,
"ldirty": False,
}
if 'subs' in kwargs:
defaultkwargs |= kwargs.pop('subs') # for backwards compatibility
if "subs" in kwargs:
defaultkwargs |= kwargs.pop("subs") # for backwards compatibility
kwargs = defaultkwargs | kwargs
self.kind = kindmap(kind_id)
super().__init__(**kwargs)
@@ -134,7 +133,12 @@ class FactoryBase(Remote):
self._configs = None
def __str__(self) -> str:
return f'Voicemeeter {self.kind}'
return f"Voicemeeter {self.kind}"
@property
@abstractmethod
def steps(self):
pass
@cached_property
def configs(self):
@@ -219,15 +223,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:
@@ -237,12 +241,12 @@ 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')
logger_entry = logger.getChild("request_remote_obj")
REMOTE_obj = None
try:
REMOTE_obj = remote_factory(kind_id, **kwargs)
except (ValueError, TypeError) as e:
logger_entry.exception(f'{type(e).__name__}: {e}')
logger_entry.exception(f"{type(e).__name__}: {e}")
raise VMError(str(e)) from e
return REMOTE_obj

39
voicemeeterlib/inst.py
View File

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

19
voicemeeterlib/iremote.py
View File

@@ -1,11 +1,11 @@
import abc
import logging
import time
from abc import ABCMeta, abstractmethod
logger = logging.getLogger(__name__)
class IRemote(abc.ABC):
class IRemote(metaclass=ABCMeta):
"""
Common interface between base class and extended (higher) classes
@@ -19,27 +19,28 @@ class IRemote(abc.ABC):
def getter(self, param, **kwargs):
"""Gets a parameter value"""
self.logger.debug(f'getter: {self._cmd(param)}')
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.logger.debug(f'setter: {self._cmd(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)
cmd += (f".{param}",)
return "".join(cmd)
@abc.abstractmethod
@property
@abstractmethod
def identifier(self):
pass
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)
@@ -49,7 +50,7 @@ class IRemote(abc.ABC):
target, attr, val = fget(attr, val)
setattr(target, attr, val)
else:
self.logger.error(f'invalid attribute {attr} for {self}')
self.logger.error(f"invalid attribute {attr} for {self}")
else:
target = getattr(self, attr)
target.apply(val)

37
voicemeeterlib/kinds.py
View File

@@ -22,7 +22,7 @@ class SingletonType(type):
return cls._instances[cls]
@dataclass(frozen=True)
@dataclass
class KindMapClass(metaclass=SingletonType):
name: str
ins: tuple
@@ -30,10 +30,6 @@ 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) -> int:
@@ -71,55 +67,46 @@ class KindMapClass(metaclass=SingletonType):
return self.name.capitalize()
@dataclass(frozen=True)
@dataclass
class BasicMap(KindMapClass):
name: str
ins: tuple = (2, 1)
outs: tuple = (1, 1)
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(frozen=True)
@dataclass
class BananaMap(KindMapClass):
name: str
ins: tuple = (3, 2)
outs: tuple = (3, 2)
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(frozen=True)
@dataclass
class PotatoMap(KindMapClass):
name: str
ins: tuple = (5, 3)
outs: tuple = (5, 3)
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)
@@ -132,4 +119,4 @@ def request_kind_map(kind_id):
return KIND_obj
all = kinds_all = [request_kind_map(kind_id.name.lower()) for kind_id in KindId]
kinds_all = list(request_kind_map(kind_id.name.lower()) for kind_id in KindId)

29
voicemeeterlib/macrobutton.py
View File

@@ -3,8 +3,8 @@ from enum import IntEnum
from .iremote import IRemote
ButtonModes = IntEnum(
'ButtonModes',
'state stateonly trigger',
"ButtonModes",
"state stateonly trigger",
start=1,
)
@@ -12,25 +12,36 @@ ButtonModes = IntEnum(
class Adapter(IRemote):
"""Adapter to the common interface."""
def identifier(self):
pass
def getter(self, mode):
self.logger.debug(f'getter: button[{self.index}].{ButtonModes(mode).name}')
self.logger.debug(f"getter: button[{self.index}].{ButtonModes(mode).name}")
return self._remote.get_buttonstatus(self.index, mode)
def setter(self, mode, val):
self.logger.debug(
f'setter: button[{self.index}].{ButtonModes(mode).name}={val}'
f"setter: button[{self.index}].{ButtonModes(mode).name}={val}"
)
self._remote.set_buttonstatus(self.index, val, mode)
class MacroButton(Adapter):
class MacroButtonColorMixin(IRemote):
@property
def identifier(self):
return f"command.button[{self.index}]"
@property
def color(self) -> int:
return int(IRemote.getter(self, "color"))
@color.setter
def color(self, val: int):
IRemote.setter(self, "color", val)
class MacroButton(Adapter, MacroButtonColorMixin):
"""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:

100
voicemeeterlib/misc.py
View File

@@ -1,48 +1,48 @@
from typing import Optional
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):
@@ -57,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)),
'insert': tuple(Insert(remote, i) for i in range(remote.kind.insert)),
"composite": tuple(Composite(remote, i) for i in range(8)),
"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 'patch'
return f"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 'patch'
return f"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):
@@ -109,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):
@@ -120,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):
@@ -173,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:
self.logger.warning(f'sr got: {val} but expected a value in {opts}')
self.setter('sr', val)
self.logger.warning(f"sr got: {val} but expected a value in {opts}")
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:

112
voicemeeterlib/recorder.py
View File

@@ -1,8 +1,8 @@
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
@@ -23,91 +23,91 @@ class Recorder(IRemote):
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, ARMCHANNELMIXIN_cls),
{
**{
param: action_fn(param)
for param in [
'play',
'stop',
'pause',
'replay',
'record',
'ff',
'rew',
"play",
"stop",
"pause",
"replay",
"record",
"ff",
"rew",
]
},
'mode': RecorderMode(remote),
"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'))
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)
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'))
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}'
f"bitresolution got: {val} but expected a value in {opts}"
)
self.setter('bitresolution', val)
self.setter("bitresolution", 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:
self.logger.warning(f'channel got: {val} but expected a value from 1 to 8')
self.setter('channel', val)
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'))
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)
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)
return round(self.getter("gain"), 1)
@gain.setter
def gain(self, val: float):
self.setter('gain', val)
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")
# loop forwarder methods, for backwards compatibility
@property
@@ -121,69 +121,69 @@ class Recorder(IRemote):
def goto(self, time_str):
def get_sec():
"""Get seconds from time string"""
h, m, s = time_str.split(':')
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)$',
match := re.match(
r"^(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)$",
time_str,
)
is not None
):
self.setter('goto', get_sec())
self.setter("goto", get_sec())
else:
self.logger.warning(
"goto expects a string that matches the format 'hh:mm:ss'"
f"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}
opts = {"wav": 1, "aiff": 2, "bwf": 3, "mp3": 100}
try:
self.setter('filetype', opts[val.lower()])
self.setter("filetype", opts[val.lower()])
except KeyError:
self.logger.warning(
f'filetype got: {val} but expected a value in {list(opts.keys())}'
f"filetype got: {val} but expected a value in {list(opts.keys())}"
)
class RecorderMode(IRemote):
@property
def identifier(self):
return 'recorder.mode'
return "recorder.mode"
@property
def recbus(self) -> bool:
return self.getter('recbus') == 1
return self.getter("recbus") == 1
@recbus.setter
def recbus(self, val: bool):
self.setter('recbus', 1 if val else 0)
self.setter("recbus", 1 if val else 0)
@property
def playonload(self) -> bool:
return self.getter('playonload') == 1
return self.getter("playonload") == 1
@playonload.setter
def playonload(self, val: bool):
self.setter('playonload', 1 if val else 0)
self.setter("playonload", 1 if val else 0)
@property
def loop(self) -> bool:
return self.getter('loop') == 1
return self.getter("loop") == 1
@loop.setter
def loop(self, val: bool):
self.setter('loop', 1 if val else 0)
self.setter("loop", 1 if val else 0)
@property
def multitrack(self) -> bool:
return self.getter('multitrack') == 1
return self.getter("multitrack") == 1
@multitrack.setter
def multitrack(self, val: bool):
self.setter('multitrack', 1 if val else 0)
self.setter("multitrack", 1 if val else 0)
class RecorderArmChannel(IRemote):
@@ -192,51 +192,51 @@ class RecorderArmChannel(IRemote):
self._i = i
def set(self, val: bool):
self.setter('', 1 if val else 0)
self.setter("", 1 if val else 0)
class RecorderArmStrip(RecorderArmChannel):
@property
def identifier(self):
return f'recorder.armstrip[{self._i}]'
return f"recorder.armstrip[{self._i}]"
class RecorderArmBus(RecorderArmChannel):
@property
def identifier(self):
return f'recorder.armbus[{self._i}]'
return f"recorder.armbus[{self._i}]"
def _make_armchannel_mixin(remote, kind):
"""Creates an armchannel out mixin"""
return type(
f'ArmChannelMixin{kind}',
f"ArmChannelMixin{kind}",
(),
{
'armstrip': tuple(
"armstrip": tuple(
RecorderArmStrip(remote, i) for i in range(kind.num_strip)
),
'armbus': tuple(RecorderArmBus(remote, i) for i in range(kind.num_bus)),
"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}
return {kind.name: _make_armchannel_mixin(remote, kind) for kind in kinds_all}
def _make_channelout_mixin(kind):
"""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'B{i}': bool_prop(f'B{i}') for i in range(1, kind.virt_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)},
},
)
_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
}

228
voicemeeterlib/remote.py
View File

@@ -1,51 +1,43 @@
import abc
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 typing import Iterable, NoReturn, Optional, Union
from .cbindings import CBindings
from .error import CAPIError, VMError
from .event import Event
from .inst import BITS
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
from .util import deep_merge, grouper, polling, script
logger = logging.getLogger(__name__)
class Remote(abc.ABC):
"""An abstract base class for Voicemeeter Remote API wrappers. Defines common methods and properties."""
class Remote(CBindings):
"""Base class responsible for wrapping the C Remote API"""
DELAY = 0.001
def __init__(self, **kwargs):
self._bindings = CBindings()
self.strip_mode = 0
self.cache = {}
self.midi = Midi()
self.subject = self.observer = Subject()
self.running = False
self.event = Event(
{k: kwargs.pop(k) for k in ('pdirty', 'mdirty', 'midi', 'ldirty')}
{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()
@@ -53,58 +45,59 @@ class Remote(abc.ABC):
self.init_thread()
return self
@property
@abc.abstractmethod
def steps(self):
"""Steps required to build the interface for this Voicemeeter kind"""
@abstractmethod
def __str__(self):
"""Ensure subclasses override str magic method"""
pass
def init_thread(self):
"""Starts updates thread."""
self.running = True
self.event.info()
self.logger.debug('initiating events thread')
self.stop_event = threading.Event()
self.stop_event.clear()
self.logger.debug("initiating events thread")
queue = Queue()
self.updater = Updater(self, queue)
self.updater.start()
self.producer = Producer(self, queue, self.stop_event)
self.producer = Producer(self, queue)
self.producer.start()
def stopped(self):
return self.stop_event is None or self.stop_event.is_set()
@timeout
def login(self) -> None:
def login(self) -> NoReturn:
"""Login to the API, initialize dirty parameters"""
self.gui.launched = self._bindings.login(ok=(0, 1)) == 0
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.'
"Voicemeeter engine running but GUI not launched. Launching the GUI now."
)
self.run_voicemeeter(self.kind.name)
self.logger.info(
f"{type(self).__name__}: Successfully logged into {self} version {self.version}"
)
self.clear_dirty()
def run_voicemeeter(self, kind_id: str) -> None:
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}'")
value = KindId[kind_id.upper()].value
if BITS == 64 and self.bits == 64:
value += 3
self._bindings.run_voicemeeter(value)
if kind_id == "potato" and bits == 8:
value = KindId[kind_id.upper()].value + 3
else:
value = KindId[kind_id.upper()].value
self.call(self.bind_run_voicemeeter, value)
time.sleep(1)
@property
def type(self) -> str:
"""Returns the type of Voicemeeter installation (basic, banana, potato)."""
type_ = ct.c_long()
self._bindings.get_voicemeeter_type(ct.byref(type_))
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._bindings.get_voicemeeter_version(ct.byref(ver))
return '{}.{}.{}.{}'.format(
self.call(self.bind_get_voicemeeter_version, ct.byref(ver))
return "{}.{}.{}.{}".format(
(ver.value & 0xFF000000) >> 24,
(ver.value & 0x00FF0000) >> 16,
(ver.value & 0x0000FF00) >> 8,
@@ -114,34 +107,40 @@ class Remote(abc.ABC):
@property
def pdirty(self) -> bool:
"""True iff UI parameters have been updated."""
return self._bindings.is_parameters_dirty(ok=(0, 1)) == 1
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._bindings.macro_button_is_dirty(ok=(0, 1)) == 1
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
self.logger.exception(f"{type(e).__name__}: {e}")
ERR_MSG = (
"no bind for VBVMR_MacroButton_IsDirty.",
"are you using an old version of the API?",
)
raise CAPIError(
"VBVMR_MacroButton_IsDirty", -9, msg=" ".join(ERR_MSG)
) 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
self.cache.get("strip_level") == self._strip_buf
and self.cache.get("bus_level") == self._bus_buf
)
def clear_dirty(self) -> None:
def clear_dirty(self) -> NoReturn:
try:
while self.pdirty or self.mdirty:
pass
except CAPIError as e:
if not (e.fn_name == 'VBVMR_MacroButton_IsDirty' and e.code == -9):
if not (e.fn_name == "VBVMR_MacroButton_IsDirty" and e.code == -9):
raise
self.logger.error(f'{e} clearing pdirty only.')
self.logger.error(f"{e} clearing pdirty only.")
while self.pdirty:
pass
@@ -150,22 +149,23 @@ class Remote(abc.ABC):
"""Gets a string or float parameter"""
if is_string:
buf = ct.create_unicode_buffer(512)
self._bindings.get_parameter_string_w(param.encode(), ct.byref(buf))
self.call(self.bind_get_parameter_string_w, param.encode(), ct.byref(buf))
else:
buf = ct.c_float()
self._bindings.get_parameter_float(param.encode(), ct.byref(buf))
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:
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._bindings.set_parameter_string_w(param.encode(), ct.c_wchar_p(val))
raise VMError("String is too long")
self.call(
self.bind_set_parameter_string_w, param.encode(), ct.c_wchar_p(val)
)
else:
self._bindings.set_parameter_float(
param.encode(),
ct.c_float(float(val)),
self.call(
self.bind_set_parameter_float, param.encode(), ct.c_float(float(val))
)
self.cache[param] = val
@@ -174,47 +174,62 @@ class Remote(abc.ABC):
"""Gets a macrobutton parameter"""
c_state = ct.c_float()
try:
self._bindings.macro_button_get_status(
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
self.logger.exception(f"{type(e).__name__}: {e}")
ERR_MSG = (
"no bind for VBVMR_MacroButton_GetStatus.",
"are you using an old version of the API?",
)
raise CAPIError(
"VBVMR_MacroButton_GetStatus", -9, msg=" ".join(ERR_MSG)
) from e
return int(c_state.value)
def set_buttonstatus(self, id_: int, val: int, mode: int) -> None:
def set_buttonstatus(self, id_: int, val: int, mode: int) -> NoReturn:
"""Sets a macrobutton parameter. Caches value"""
c_state = ct.c_float(float(val))
try:
self._bindings.macro_button_set_status(
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)
self.logger.exception(f"{type(e).__name__}: {e}")
ERR_MSG = (
"no bind for VBVMR_MacroButton_SetStatus.",
"are you using an old version of the API?",
)
raise CAPIError(
"VBVMR_MacroButton_SetStatus", -9, msg=" ".join(ERR_MSG)
) 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._bindings, f'{direction}put_get_device_number')
res = func(ok_exp=lambda r: r >= 0)
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')
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._bindings, f'{direction}put_get_device_desc_w')
func(
func = getattr(self, f"bind_{direction}put_get_device_desc_w")
self.call(
func,
ct.c_long(index),
ct.byref(type_),
ct.byref(name),
@@ -225,7 +240,9 @@ class Remote(abc.ABC):
def get_level(self, type_: int, index: int) -> float:
"""Retrieves a single level value"""
val = ct.c_float()
self._bindings.get_level(ct.c_long(type_), ct.c_long(index), ct.byref(val))
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:
@@ -243,7 +260,8 @@ class Remote(abc.ABC):
def get_midi_message(self):
n = ct.c_long(1024)
buf = ct.create_string_buffer(1024)
res = self._bindings.get_midi_message(
res = self.call(
self.bind_get_midi_message,
ct.byref(buf),
n,
ok=(-5, -6), # no data received from midi device
@@ -251,7 +269,7 @@ class Remote(abc.ABC):
)
if res > 0:
vals = tuple(
grouper(3, (int.from_bytes(buf[i], 'little') for i in range(res)))
grouper(3, (int.from_bytes(buf[i], "little") for i in range(res)))
)
for msg in vals:
ch, pitch, vel = msg
@@ -265,8 +283,8 @@ class Remote(abc.ABC):
def sendtext(self, script: str):
"""Sets many parameters from a script"""
if len(script) > 48000:
raise ValueError('Script too large, max size 48kB')
self._bindings.set_parameters(script.encode())
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):
@@ -276,47 +294,35 @@ class Remote(abc.ABC):
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)]
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)
[target(key).apply(di).then_wait() for key, di in data.items()]
[param(key).apply(datum).then_wait() for key, datum 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())}',
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
self.logger.error(("\n").join(ERR_MSG))
raise VMError(("\n").join(ERR_MSG)) from e
if 'extends' in config:
extended = config['extends']
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')
if k not in ("extends")
}
self.logger.debug(
f"profile '{name}' extends '{extended}', profiles merged.."
@@ -325,18 +331,16 @@ class Remote(abc.ABC):
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
self.logger.debug("events thread shutdown started")
self.running = False
def logout(self) -> None:
def logout(self) -> NoReturn:
"""Logout of the API"""
time.sleep(0.1)
self._bindings.logout()
self.logger.info(f'{type(self).__name__}: Successfully logged out of {self}')
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:
def __exit__(self, exc_type, exc_value, exc_traceback) -> NoReturn:
"""teardown procedures"""
self.end_thread()
self.logout()

344
voicemeeterlib/strip.py
View File

@@ -1,10 +1,10 @@
import abc
import time
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
@@ -15,68 +15,68 @@ class Strip(IRemote):
Defines concrete implementation for strip
"""
@abc.abstractmethod
@abstractmethod
def __str__(self):
pass
@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)
@@ -90,301 +90,203 @@ class PhysicalStrip(Strip):
"""
EFFECTS_cls = _make_effects_mixins(is_phys)[remote.kind.name]
return type(
'PhysicalStrip',
f"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),
"comp": StripComp(remote, i),
"gate": StripGate(remote, i),
"denoiser": StripDenoiser(remote, i),
"eq": StripEQ(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 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'
return f"Strip[{self.index}].comp"
@property
def knob(self) -> float:
return round(self.getter(''), 1)
return round(self.getter(""), 1)
@knob.setter
def knob(self, val: float):
self.setter('', val)
self.setter("", val)
@property
def gainin(self) -> float:
return round(self.getter('GainIn'), 1)
return round(self.getter("GainIn"), 1)
@gainin.setter
def gainin(self, val: float):
self.setter('GainIn', val)
self.setter("GainIn", val)
@property
def ratio(self) -> float:
return round(self.getter('Ratio'), 1)
return round(self.getter("Ratio"), 1)
@ratio.setter
def ratio(self, val: float):
self.setter('Ratio', val)
self.setter("Ratio", val)
@property
def threshold(self) -> float:
return round(self.getter('Threshold'), 1)
return round(self.getter("Threshold"), 1)
@threshold.setter
def threshold(self, val: float):
self.setter('Threshold', val)
self.setter("Threshold", val)
@property
def attack(self) -> float:
return round(self.getter('Attack'), 1)
return round(self.getter("Attack"), 1)
@attack.setter
def attack(self, val: float):
self.setter('Attack', val)
self.setter("Attack", val)
@property
def release(self) -> float:
return round(self.getter('Release'), 1)
return round(self.getter("Release"), 1)
@release.setter
def release(self, val: float):
self.setter('Release', val)
self.setter("Release", val)
@property
def knee(self) -> float:
return round(self.getter('Knee'), 2)
return round(self.getter("Knee"), 1)
@knee.setter
def knee(self, val: float):
self.setter('Knee', val)
self.setter("Knee", val)
@property
def gainout(self) -> float:
return round(self.getter('GainOut'), 1)
return round(self.getter("GainOut"), 1)
@gainout.setter
def gainout(self, val: float):
self.setter('GainOut', val)
self.setter("GainOut", val)
@property
def makeup(self) -> bool:
return self.getter('makeup') == 1
return self.getter("makeup") == 1
@makeup.setter
def makeup(self, val: bool):
self.setter('makeup', 1 if val else 0)
self.setter("makeup", 1 if val else 0)
class StripGate(IRemote):
@property
def identifier(self) -> str:
return f'Strip[{self.index}].gate'
return f"Strip[{self.index}].gate"
@property
def knob(self) -> float:
return round(self.getter(''), 1)
return round(self.getter(""), 1)
@knob.setter
def knob(self, val: float):
self.setter('', val)
self.setter("", val)
@property
def threshold(self) -> float:
return round(self.getter('Threshold'), 1)
return round(self.getter("Threshold"), 1)
@threshold.setter
def threshold(self, val: float):
self.setter('Threshold', val)
self.setter("Threshold", val)
@property
def damping(self) -> float:
return round(self.getter('Damping'), 1)
return round(self.getter("Damping"), 1)
@damping.setter
def damping(self, val: float):
self.setter('Damping', val)
self.setter("Damping", val)
@property
def bpsidechain(self) -> int:
return int(self.getter('BPSidechain'))
return int(self.getter("BPSidechain"))
@bpsidechain.setter
def bpsidechain(self, val: int):
self.setter('BPSidechain', val)
self.setter("BPSidechain", val)
@property
def attack(self) -> float:
return round(self.getter('Attack'), 1)
return round(self.getter("Attack"), 1)
@attack.setter
def attack(self, val: float):
self.setter('Attack', val)
self.setter("Attack", val)
@property
def hold(self) -> float:
return round(self.getter('Hold'), 1)
return round(self.getter("Hold"), 1)
@hold.setter
def hold(self, val: float):
self.setter('Hold', val)
self.setter("Hold", val)
@property
def release(self) -> float:
return round(self.getter('Release'), 1)
return round(self.getter("Release"), 1)
@release.setter
def release(self, val: float):
self.setter('Release', val)
self.setter("Release", val)
class StripDenoiser(IRemote):
@property
def identifier(self) -> str:
return f'Strip[{self.index}].denoiser'
return f"Strip[{self.index}].denoiser"
@property
def knob(self) -> float:
return round(self.getter(''), 1)
return round(self.getter(""), 1)
@knob.setter
def knob(self, val: float):
self.setter('', val)
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'
return f"Strip[{self.index}].eq"
@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 ab(self) -> bool:
return self.getter('ab') == 1
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)
self.setter("ab", 1 if val else 0)
class StripDevice(IRemote):
@@ -396,16 +298,16 @@ class StripDevice(IRemote):
Returns a StripDevice class of a kind.
"""
DEVICE_cls = type(
f'StripDevice{remote.kind}',
f"StripDevice{remote.kind}",
(cls,),
{
**{
param: device_prop(param)
for param in [
'wdm',
'ks',
'mme',
'asio',
"wdm",
"ks",
"mme",
"asio",
]
},
},
@@ -414,15 +316,15 @@ class StripDevice(IRemote):
@property
def identifier(self) -> str:
return f'Strip[{self.index}].device'
return f"Strip[{self.index}].device"
@property
def name(self) -> str:
return self.getter('name', is_string=True)
return self.getter("name", is_string=True)
@property
def sr(self) -> int:
return int(self.getter('sr'))
return int(self.getter("sr"))
class VirtualStrip(Strip):
@@ -435,65 +337,65 @@ class VirtualStrip(Strip):
"""
EFFECTS_cls = _make_effects_mixins(is_phys)[remote.kind.name]
return type(
'VirtualStrip',
f"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) -> 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) -> 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) -> 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):
@@ -513,8 +415,8 @@ class StripLevel(IRemote):
def fget(x):
return round(20 * log(x, 10), 1) if x > 0 else -200.0
if not self._remote.stopped() and self._remote.event.ldirty:
vals = self._remote.cache['strip_level'][self.range[0] : self.range[-1]]
if self._remote.running and self._remote.event.ldirty:
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)]
@@ -522,7 +424,7 @@ class StripLevel(IRemote):
@property
def identifier(self) -> str:
return f'Strip[{self.index}]'
return f"Strip[{self.index}]"
@property
def prefader(self) -> tuple:
@@ -546,7 +448,7 @@ class StripLevel(IRemote):
Expected to be used in a callback only.
"""
if not self._remote.stopped():
if self._remote.running:
return any(self._remote._strip_comp[self.range[0] : self.range[-1]])
is_updated = isdirty
@@ -565,7 +467,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):
@@ -575,24 +477,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(
'GainlayerMixin',
f"GainlayerMixin",
(),
{
'gainlayer': tuple(
"gainlayer": tuple(
GainLayer(remote, index, i) for i in range(remote.kind.num_bus)
)
},
@@ -602,17 +504,17 @@ 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'B{i}': bool_prop(f'B{i}') for i in range(1, kind.virt_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)},
},
)
_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
}
@@ -620,12 +522,12 @@ def _make_effects_mixin(kind, is_phys):
"""creates an effects mixin for a kind"""
def _make_xy_cls():
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']}
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:
return type(
'XYPhys',
"XYPhys",
(),
{
**pan,
@@ -634,7 +536,7 @@ def _make_effects_mixin(kind, is_phys):
},
)
return type(
'XYVirt',
"XYVirt",
(),
{**pan},
)
@@ -642,32 +544,32 @@ def _make_effects_mixin(kind, is_phys):
def _make_fx_cls():
if is_phys:
return type(
'FX',
"FX",
(),
{
**{
param: float_prop(param)
for param in ['reverb', 'delay', 'fx1', 'fx2']
for param in ["reverb", "delay", "fx1", "fx2"]
},
**{
f'post{param}': bool_prop(f'post{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', (), {})
return type("FX", (), {})
if kind.name == 'basic':
if kind.name == "basic":
steps = (_make_xy_cls,)
elif kind.name == 'banana':
elif kind.name == "banana":
steps = (_make_xy_cls,)
elif kind.name == 'potato':
elif kind.name == "potato":
steps = (_make_xy_cls, _make_fx_cls)
return type(f'Effects{kind}', tuple(step() for step in steps), {})
return type(f"Effects{kind}", tuple(step() for step in steps), {})
def _make_effects_mixins(is_phys):
return {kind.name: _make_effects_mixin(kind, is_phys) for kind in kinds.all}
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]:
@@ -686,14 +588,14 @@ def strip_factory(is_phys_strip, remote, i) -> Union[PhysicalStrip, VirtualStrip
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)

20
voicemeeterlib/subject.py
View File

@@ -20,10 +20,10 @@ class Subject:
"""run callbacks on update"""
for o in self._observers:
if hasattr(o, 'on_update'):
if hasattr(o, "on_update"):
o.on_update(event)
else:
if o.__name__ == f'on_{event}':
if o.__name__ == f"on_{event}":
o()
def add(self, observer):
@@ -34,15 +34,15 @@ class Subject:
for o in iterator:
if o not in self._observers:
self._observers.append(o)
self.logger.info(f'{o} added to event observers')
self.logger.info(f"{o} added to event observers")
else:
self.logger.error(f'Failed to add {o} to event observers')
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')
self.logger.info(f"{observer} added to event observers")
else:
self.logger.error(f'Failed to add {observer} to event observers')
self.logger.error(f"Failed to add {observer} to event observers")
register = add
@@ -54,15 +54,15 @@ class Subject:
for o in iterator:
try:
self._observers.remove(o)
self.logger.info(f'{o} removed from event observers')
self.logger.info(f"{o} removed from event observers")
except ValueError:
self.logger.error(f'Failed to remove {o} from event observers')
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')
self.logger.info(f"{observer} removed from event observers")
except ValueError:
self.logger.error(f'Failed to remove {observer} from event observers')
self.logger.error(f"Failed to remove {observer} from event observers")
deregister = remove

50
voicemeeterlib/updater.py
View File

@@ -10,48 +10,44 @@ 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)
def __init__(self, remote, queue):
super().__init__(name="producer", daemon=True)
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():
while self._remote.running:
if self._remote.event.pdirty:
self.queue.put('pdirty')
self.queue.put("pdirty")
if self._remote.event.mdirty:
self.queue.put('mdirty')
self.queue.put("mdirty")
if self._remote.event.midi:
self.queue.put('midi')
self.queue.put("midi")
if self._remote.event.ldirty:
self.queue.put('ldirty')
self.queue.put("ldirty")
time.sleep(self._remote.ratelimit)
self.logger.debug(f'terminating {self.name} thread')
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)
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.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)),
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):
@@ -60,16 +56,20 @@ class Updater(threading.Thread):
Generate _strip_comp, _bus_comp and update level cache if ldirty.
"""
while event := self.queue.get():
if event == 'pdirty' and self._remote.pdirty:
while True:
event = self.queue.get()
if event is None:
self.logger.debug(f"terminating {self.name} thread")
break
if event == "pdirty" and self._remote.pdirty:
self._remote.subject.notify(event)
elif event == 'mdirty' and self._remote.mdirty:
elif event == "mdirty" and self._remote.mdirty:
self._remote.subject.notify(event)
elif event == 'midi' and self._remote.get_midi_message():
elif event == "midi" and self._remote.get_midi_message():
self._remote.subject.notify(event)
elif event == 'ldirty' and self._remote.ldirty:
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.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')

48
voicemeeterlib/util.py
View File

@@ -1,41 +1,7 @@
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):
"""
@@ -48,15 +14,15 @@ def polling(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
get = func.__name__ == 'get'
mb_get = func.__name__ == 'get_buttonstatus'
get = func.__name__ == "get"
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)
@@ -73,15 +39,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)

112
voicemeeterlib/vban.py
View File

@@ -1,7 +1,7 @@
import abc
from abc import abstractmethod
from . import kinds
from .iremote import IRemote
from .kinds import kinds_all
class VbanStream(IRemote):
@@ -11,100 +11,100 @@ class VbanStream(IRemote):
Defines concrete implementation for vban stream
"""
@abc.abstractmethod
@abstractmethod
def __str__(self):
pass
@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:
self.logger.warning(
f'port got: {val} but expected a value from 1024 to 65535'
f"port got: {val} but expected a value from 1024 to 65535"
)
self.setter('port', val)
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:
self.logger.warning(f'sr got: {val} but expected a value in {opts}')
self.setter('sr', val)
self.logger.warning(f"sr got: {val} but expected a value in {opts}")
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:
self.logger.warning(f'channel got: {val} but expected a value from 1 to 8')
self.setter('channel', val)
self.logger.warning(f"channel got: {val} but expected a value from 1 to 8")
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):
self.logger.warning(f'bit got: {val} but expected value 16 or 24')
self.setter('bit', 1 if (val == 16) else 2)
self.logger.warning(f"bit got: {val} but expected value 16 or 24")
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:
self.logger.warning(f'quality got: {val} but expected a value from 0 to 4')
self.setter('quality', val)
self.logger.warning(f"quality got: {val} but expected a value from 0 to 4")
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:
self.logger.warning(f'route got: {val} but expected a value from 0 to 8')
self.setter('route', val)
self.logger.warning(f"route got: {val} but expected a value from 0 to 8")
self.setter("route", val)
class VbanInstream(VbanStream):
@@ -115,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:
@@ -154,11 +154,11 @@ 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):
@@ -172,29 +172,37 @@ class VbanMidiOutstream(VbanOutstream):
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)
def _generate_streams(i, dir):
"""generator function for instream/outstream types"""
if dir == "in":
if i < num_instream:
yield VbanAudioInstream
elif i < num_instream + num_midi:
yield VbanMidiInstream
else:
yield VbanTextInstream
else:
if i < num_outstream:
yield VbanAudioOutstream
else:
yield VbanMidiOutstream
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)),
tuple(
cls(remote, i)
for i in range(num_instream + num_midi + num_text)
for cls in _generate_streams(i, "in")
),
tuple(
cls(remote, i)
for i in range(num_outstream + num_midi)
for cls in _generate_streams(i, "out")
),
)
def _make_stream_pairs(remote):
return {kind.name: _make_stream_pair(remote, kind) for kind in kinds.all}
return {kind.name: _make_stream_pair(remote, kind) for kind in kinds_all}
class Vban:
@@ -209,10 +217,10 @@ class Vban:
self.instream, self.outstream = _make_stream_pairs(remote)[remote.kind.name]
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:
@@ -222,7 +230,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: