38 Commits

Author SHA1 Message Date
48614ab5fa Merge pull request #20 from onyx-and-iris/dependabot/pip/virtualenv-20.36.1
Bump virtualenv from 20.28.1 to 20.36.1
2026-03-18 06:20:31 +00:00
dependabot[bot]
99350f2c63 Bump virtualenv from 20.28.1 to 20.36.1
Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.28.1 to 20.36.1.
- [Release notes](https://github.com/pypa/virtualenv/releases)
- [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst)
- [Commits](https://github.com/pypa/virtualenv/compare/20.28.1...20.36.1)

---
updated-dependencies:
- dependency-name: virtualenv
  dependency-version: 20.36.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-03-18 06:20:07 +00:00
2a7a1c5d2a Merge pull request #19 from onyx-and-iris/dependabot/pip/filelock-3.20.3
Bump filelock from 3.16.1 to 3.20.3
2026-03-18 06:18:47 +00:00
dependabot[bot]
f0664f9cfb Bump filelock from 3.16.1 to 3.20.3
Bumps [filelock](https://github.com/tox-dev/py-filelock) from 3.16.1 to 3.20.3.
- [Release notes](https://github.com/tox-dev/py-filelock/releases)
- [Changelog](https://github.com/tox-dev/filelock/blob/main/docs/changelog.rst)
- [Commits](https://github.com/tox-dev/py-filelock/compare/3.16.1...3.20.3)

---
updated-dependencies:
- dependency-name: filelock
  dependency-version: 3.20.3
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-03-18 06:18:12 +00:00
e395e7a373 upd tested against 2026-03-15 22:02:31 +00:00
842feb2407 remote is now our ABC - as it should be because it is the launching point of the interface.
it no longer inherits from CBindings.

move steps abstract method into Remote class. This is a much more meaningful abstraction - because it is the principle behaviour that distinguishes each kind of Remote.

add wrapper methods to CBindings. This provides a cleaner api for the Remote class.

import abc as namespace throughout the package.
2026-03-15 22:02:17 +00:00
84b4426e44 add poetry hooks to pre-commit config 2026-03-15 16:27:15 +00:00
0396892530 fix url 2026-03-07 21:34:26 +00:00
919dc0d325 requires-plugins seems to be bugged on Windows... see https://github.com/python-poetry/poetry/issues/10028
upd poe dep so it uses the one in poetry environment
2026-03-07 21:27:01 +00:00
0a81c458e2 add publish+ruff actions 2026-03-07 21:23:56 +00:00
9903ecca72 run through formatter 2026-03-07 21:23:37 +00:00
00ac5b1428 fix bus.mono type (bool -> int)
patch bump
2026-03-07 21:23:08 +00:00
3d56ba99b6 patch bump 2025-06-17 09:54:00 +01:00
58ec875521 add 2.7.1 to README.
closes #17
2025-06-17 09:50:18 +01:00
4c6ec6d989 add Strip.EQ.Channel.Cell to README.
add note about API bug
2025-06-17 09:49:25 +01:00
feb6ee5821 add StripEQCh, StripEQChCell, they extend the StripEQ class.
update the kind maps
2025-06-17 09:48:09 +01:00
15f0fcda69 add link to buseqchannelcell 2025-06-15 23:50:24 +01:00
738688a8a7 Merge pull request #16 from wcyoung08/add-to-bus-class
Extends BusEQclass with BusEQChCell, giving access to all bus eq channel cell parameters.
2025-06-15 23:47:15 +01:00
1509afd4f5 add 2.7.0 to CHANGELOG 2025-06-15 23:42:23 +01:00
7232ba6248 add eqedit poe script
minor bump
2025-06-15 23:38:11 +01:00
1ff2017d51 iterate over cells. 2025-06-15 23:32:47 +01:00
William Young
fe1f4ee324 Updated example script to be sure other params work, updated readme and changed channel number from 9 to 8 2025-06-15 16:59:17 -05:00
4953751c02 instantiate types
bump poethepoet
2025-06-15 22:32:46 +01:00
William Young
abbbf57982 Added some logic to test but changes seem to work now 2025-06-15 15:43:41 -05:00
714d2fc972 pass channel + cell indices to each class
update identifier properties to reflect changes.
2025-06-15 20:03:11 +01:00
c797912458 set cell count to 6 (0 up to 5) 2025-06-15 20:02:08 +01:00
William Young
f702b4feb3 Got rid of error with channels and cells not being subscriptable, but now getting -3 error trying to set eq.channel[0].cell[0].on 2025-06-15 11:48:17 -05:00
William Young
f8f10e358f Initial setup adding classes for channels and cells 2025-06-15 10:43:50 -05:00
f7abc5248b remove html reports, keep the badges 2025-02-28 12:38:37 +00:00
fec4315be2 typo fix 2025-02-27 20:34:49 +00:00
a3e3db3c37 move callbacks/observer examples into examples/events/ 2025-02-27 20:33:59 +00:00
3e201443e0 upd env name 2025-02-27 20:26:26 +00:00
868017c79f upd report paths, regenerate badges 2025-02-27 19:57:32 +00:00
795296d71e move tox config into tox.ini
add testenv:genbadges for generating test badges

update README badges
2025-02-27 19:52:37 +00:00
e21a458c6f add py13 to tox envlist
upd Run tests section in README.
2025-02-13 10:59:20 +00:00
b79d9494a2 rename test poe scripts
add passenv = * to [testenv]
2025-01-25 01:49:18 +00:00
328bea347c upd python-requires 2025-01-16 20:22:34 +00:00
38bd284ba6 upd examples 2025-01-16 14:51:20 +00:00
41 changed files with 1058 additions and 575 deletions

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

@@ -0,0 +1,53 @@
name: Publish to PyPI
on:
release:
types: [published]
push:
tags:
- 'v*.*.*'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install Poetry
run: |
pip install poetry==2.3.1
poetry --version
- name: Build package
run: |
poetry install --only-root
poetry build
- uses: actions/upload-artifact@v4
with:
name: dist
path: ./dist
pypi-publish:
needs: build
name: Upload release to PyPI
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/project/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 Normal file
View File

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

14
.gitignore vendored
View File

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

13
.pre-commit-config.yaml Normal file
View File

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

View File

@@ -11,11 +11,21 @@ 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.
- bits kwarg for overriding the type of GUI that is launched on startup.
- Defaults to 64, set it to either 32 or 64.
### Fixed

View File

@@ -2,9 +2,9 @@
[![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/basic.svg?dummy=8484744)
![Tests Status](./tests/banana.svg?dummy=8484744)
![Tests Status](./tests/potato.svg?dummy=8484744)
![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)
# 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.1.1
- Banana 2.1.1.1
- Potato 3.1.1.1
- Basic 1.1.2.2
- Banana 2.1.2.2
- Potato 3.1.2.2
## Requirements
@@ -225,6 +225,24 @@ 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
@@ -259,7 +277,7 @@ Level properties will return -200.0 if no audio detected.
The following properties are available.
- `mono`: boolean
- `mono`: int, from 0 up to 2
- `mute`: boolean
- `sel`: boolean
- `gain`: float, from -60.0 to 12.0
@@ -276,7 +294,7 @@ example:
vm.bus[3].gain = 3.7
print(vm.bus[0].label)
vm.bus[4].mono = True
vm.bus[4].mono = 2
```
##### Bus.EQ
@@ -292,6 +310,24 @@ 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.
@@ -869,10 +905,12 @@ with voicemeeterlib.api('banana') as vm:
### Run tests
To run all tests:
Install [poetry](https://python-poetry.org/docs/#installation) and then:
```
pytest -v
```powershell
poetry poe test-basic
poetry poe test-banana
poetry poe test-potato
```
### Official Documentation
@@ -880,4 +918,4 @@ pytest -v
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
[Voicemeeter Remote Header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemote.h
[Voicemeeter Remote Header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemote.h

View File

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

View File

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

View File

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

View File

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

View File

@@ -8,18 +8,18 @@ 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!')
@@ -28,13 +28,13 @@ class App:
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():

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

View File

@@ -12,9 +12,9 @@ class App(tk.Tk):
def __init__(self, vm):
super().__init__()
self.vm = vm
self._vm = vm
self.title(f'{vm} - version {vm.version}')
self.vm.observer.add(self.on_ldirty)
self._vm.observer.add(self.on_ldirty)
# create widget variables
self.button_var = tk.BooleanVar(value=vm.strip[self.INDEX].mute)
@@ -31,7 +31,7 @@ class App(tk.Tk):
)
# 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
@@ -76,12 +76,12 @@ 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'
)
@@ -89,10 +89,10 @@ class App(tk.Tk):
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):

View File

@@ -10,31 +10,31 @@ 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()
def get_info(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)}')
return current
def on_midi_press(self):
"""if midi button 48 is pressed and strip 3 level max > -40, then set trigger for macrobutton 0"""
if (
self.vm.midi.get(self.MIDI_BUTTON) == 127
and max(self.vm.strip[3].levels.postfader) > -40
self._vm.midi.get(self.MIDI_BUTTON) == 127
and max(self._vm.strip[3].levels.postfader) > -40
):
print(
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():

View File

@@ -21,15 +21,20 @@ config.dictConfig(
}
},
'loggers': {
'voicemeeterlib.iremote': {'handlers': ['stream'], 'level': 'DEBUG'}
'voicemeeterlib.iremote': {
'handlers': ['stream'],
'level': 'DEBUG',
'propagate': False,
}
},
'root': {'handlers': ['stream'], 'level': 'WARNING'},
}
)
class MyClient:
def __init__(self, vm, stop_event):
self.vm = vm
self._vm = vm
self._stop_event = stop_event
self._client = obsws.EventClient()
self._client.callback.register(
@@ -46,16 +51,16 @@ class MyClient:
self._client.disconnect()
def on_start(self):
self.vm.strip[0].mute = True
self.vm.strip[1].B1 = True
self.vm.strip[2].B2 = True
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}},
@@ -65,10 +70,10 @@ class MyClient:
)
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):
scene = data.scene_name

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()

60
poetry.lock generated
View File

@@ -1,4 +1,4 @@
# This file is automatically @generated by Poetry 2.0.1 and should not be changed by hand.
# This file is automatically @generated by Poetry 2.2.1 and should not be changed by hand.
[[package]]
name = "cachetools"
@@ -55,7 +55,7 @@ description = "Backport of PEP 654 (exception groups)"
optional = false
python-versions = ">=3.7"
groups = ["dev"]
markers = "python_version < \"3.11\""
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"},
@@ -66,21 +66,16 @@ test = ["pytest (>=6)"]
[[package]]
name = "filelock"
version = "3.16.1"
version = "3.20.3"
description = "A platform independent file lock."
optional = false
python-versions = ">=3.8"
python-versions = ">=3.10"
groups = ["dev"]
files = [
{file = "filelock-3.16.1-py3-none-any.whl", hash = "sha256:2082e5703d51fbf98ea75855d9d5527e33d8ff23099bec374a134febee6946b0"},
{file = "filelock-3.16.1.tar.gz", hash = "sha256:c249fbfcd5db47e5e2d6d62198e565475ee65e4831e2561c8e313fa7eb961435"},
{file = "filelock-3.20.3-py3-none-any.whl", hash = "sha256:4b0dda527ee31078689fc205ec4f1c1bf7d56cf88b6dc9426c4f230e46c2dce1"},
{file = "filelock-3.20.3.tar.gz", hash = "sha256:18c57ee915c7ec61cff0ecf7f0f869936c7c30191bb0cf406f1341778d0834e1"},
]
[package.extras]
docs = ["furo (>=2024.8.6)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4.1)"]
testing = ["covdefaults (>=2.3)", "coverage (>=7.6.1)", "diff-cover (>=9.2)", "pytest (>=8.3.3)", "pytest-asyncio (>=0.24)", "pytest-cov (>=5)", "pytest-mock (>=3.14)", "pytest-timeout (>=2.3.1)", "virtualenv (>=20.26.4)"]
typing = ["typing-extensions (>=4.12.2)"]
[[package]]
name = "iniconfig"
version = "2.0.0"
@@ -172,14 +167,14 @@ testing = ["covdefaults (>=2.3)", "pytest (>=8.3.3)", "pytest-cov (>=5)", "pytes
[[package]]
name = "pytest"
version = "7.4.4"
version = "8.3.4"
description = "pytest: simple powerful testing with Python"
optional = false
python-versions = ">=3.7"
python-versions = ">=3.8"
groups = ["dev"]
files = [
{file = "pytest-7.4.4-py3-none-any.whl", hash = "sha256:b090cdf5ed60bf4c45261be03239c2c1c22df034fbffe691abe93cd80cea01d8"},
{file = "pytest-7.4.4.tar.gz", hash = "sha256:2cf0005922c6ace4a3e2ec8b4080eb0d9753fdc93107415332f50ce9e7994280"},
{file = "pytest-8.3.4-py3-none-any.whl", hash = "sha256:50e16d954148559c9a74109af1eaf0c945ba2d8f30f0a3d3335edde19788b6f6"},
{file = "pytest-8.3.4.tar.gz", hash = "sha256:965370d062bce11e73868e0335abac31b4d3de0e82f4007408d242b4f8610761"},
]
[package.dependencies]
@@ -187,11 +182,11 @@ colorama = {version = "*", markers = "sys_platform == \"win32\""}
exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
iniconfig = "*"
packaging = "*"
pluggy = ">=0.12,<2.0"
tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
pluggy = ">=1.5,<2"
tomli = {version = ">=1", markers = "python_version < \"3.11\""}
[package.extras]
testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
[[package]]
name = "pytest-randomly"
@@ -243,7 +238,7 @@ description = "A lil' TOML parser"
optional = false
python-versions = ">=3.8"
groups = ["main", "dev"]
markers = "python_version < \"3.11\""
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"},
@@ -309,37 +304,38 @@ test = ["devpi-process (>=1.0.2)", "pytest (>=8.3.3)", "pytest-mock (>=3.14)"]
[[package]]
name = "typing-extensions"
version = "4.12.2"
description = "Backported and Experimental Type Hints for Python 3.8+"
version = "4.15.0"
description = "Backported and Experimental Type Hints for Python 3.9+"
optional = false
python-versions = ">=3.8"
python-versions = ">=3.9"
groups = ["dev"]
markers = "python_version < \"3.11\""
markers = "python_version == \"3.10\""
files = [
{file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
{file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
{file = "typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548"},
{file = "typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466"},
]
[[package]]
name = "virtualenv"
version = "20.28.1"
version = "20.36.1"
description = "Virtual Python Environment builder"
optional = false
python-versions = ">=3.8"
groups = ["dev"]
files = [
{file = "virtualenv-20.28.1-py3-none-any.whl", hash = "sha256:412773c85d4dab0409b83ec36f7a6499e72eaf08c80e81e9576bca61831c71cb"},
{file = "virtualenv-20.28.1.tar.gz", hash = "sha256:5d34ab240fdb5d21549b76f9e8ff3af28252f5499fb6d6f031adac4e5a8c5329"},
{file = "virtualenv-20.36.1-py3-none-any.whl", hash = "sha256:575a8d6b124ef88f6f51d56d656132389f961062a9177016a50e4f507bbcc19f"},
{file = "virtualenv-20.36.1.tar.gz", hash = "sha256:8befb5c81842c641f8ee658481e42641c68b5eab3521d8e092d18320902466ba"},
]
[package.dependencies]
distlib = ">=0.3.7,<1"
filelock = ">=3.12.2,<4"
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\""}
[package.extras]
docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"]
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"
@@ -359,5 +355,5 @@ virtualenv = "*"
[metadata]
lock-version = "2.1"
python-versions = "<4.0,>=3.10"
content-hash = "fd3332b6e69588ff2902930c08a7882610bb8b18430f8b41edb11420ad2b597d"
python-versions = ">=3.10"
content-hash = "6339967c3f6cad8e4db7047ef3d12a5b059a279d0f7c98515c961477680bab8f"

View File

@@ -1,26 +1,22 @@
[project]
name = "voicemeeter-api"
version = "2.6.1"
version = "2.7.2"
description = "A Python wrapper for the Voiceemeter API"
authors = [
{name = "Onyx and Iris",email = "code@onyxandiris.online"}
]
license = {text = "MIT"}
authors = [{ name = "Onyx and Iris", email = "code@onyxandiris.online" }]
license = { text = "MIT" }
readme = "README.md"
requires-python = "<4.0,>=3.10"
dependencies = [
"tomli (>=2.0.1,<3.0) ; python_version < '3.11'",
]
requires-python = ">=3.10"
dependencies = ["tomli (>=2.0.1,<3.0) ; python_version < '3.11'"]
[tool.poetry]
packages = [{ include = "voicemeeterlib" }]
[tool.poetry.requires-plugins]
poethepoet = "^0.32.1"
poethepoet = ">=0.42.0"
[tool.poetry.group.dev.dependencies]
pytest = "^7.4.4"
pytest-randomly = "^3.12.0"
pytest = "^8.3.4"
pytest-randomly = "^3.16.0"
ruff = "^0.8.6"
tox = "^4.23.2"
virtualenv-pyenv = "^0.5.0"
@@ -31,45 +27,19 @@ build-backend = "poetry.core.masonry.api"
[tool.poe.tasks]
dsl.script = "scripts:ex_dsl"
events.script = "scripts:ex_events"
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"
basic.script = "scripts:test_basic"
banana.script = "scripts:test_banana"
potato.script = "scripts:test_potato"
all.script = "scripts:test_all"
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.tox]
legacy_tox_ini = """
[tox]
envlist = py310,py311,py312
[testenv]
setenv = VIRTUALENV_DISCOVERY=pyenv
allowlist_externals = poetry
commands =
poetry install -v
poetry run pytest tests/
[testenv:dsl]
setenv = VIRTUALENV_DISCOVERY=pyenv
allowlist_externals = poetry
deps = pyparsing
commands =
poetry install -v --without dev
poetry run python examples/dsl/
[testenv:obs]
setenv = VIRTUALENV_DISCOVERY=pyenv
allowlist_externals = poetry
deps = obsws-python
commands =
poetry install -v --without dev
poetry run python examples/obs/
"""
[tool.ruff]
exclude = [
@@ -105,14 +75,16 @@ 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", "F"]
select = ["E4", "E7", "E9", "EM", "F", "B"]
ignore = []
# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []
unfixable = ["B"]
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
@@ -149,7 +121,4 @@ docstring-code-line-length = "dynamic"
max-complexity = 10
[tool.ruff.lint.per-file-ignores]
"__init__.py" = [
"E402",
"F401",
]
"__init__.py" = ["E402", "F401"]

View File

@@ -5,53 +5,63 @@ from pathlib import Path
def ex_dsl():
subprocess.run(["tox", "r", "-e", "dsl"])
subprocess.run(['tox', 'r', '-e', 'dsl'])
def ex_events():
scriptpath = Path.cwd() / "examples" / "events" / "."
def ex_callbacks():
scriptpath = Path.cwd() / 'examples' / 'events' / 'callbacks' / '.'
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"])
subprocess.run(['tox', 'r', '-e', 'obs'])
def ex_observer():
scriptpath = Path.cwd() / "examples" / "observer" / "."
scriptpath = Path.cwd() / 'examples' / 'events' / 'observer' / '.'
subprocess.run([sys.executable, str(scriptpath)])
def ex_eqedit():
scriptpath = Path.cwd() / 'examples' / 'eq_edit' / '.'
subprocess.run([sys.executable, str(scriptpath)])
def test_basic():
os.environ["KIND"] = "basic"
subprocess.run(["tox"])
subprocess.run(['tox'], env=os.environ.copy() | {'KIND': 'basic'})
def test_banana():
os.environ["KIND"] = "banana"
subprocess.run(["tox"])
subprocess.run(['tox'], env=os.environ.copy() | {'KIND': 'banana'})
def test_potato():
os.environ["KIND"] = "potato"
subprocess.run(["tox"])
subprocess.run(['tox'], env=os.environ.copy() | {'KIND': 'potato'})
def test_all():
steps = [test_basic, test_banana, test_potato]
[step() for step in steps]
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}
)

View File

@@ -31,10 +31,8 @@ class Data:
return (2 * self.phys_in) + (8 * self.virt_in)
# get KIND_ID from env var, otherwise set to random
KIND_ID = os.environ.get(
"KIND", random.choice(tuple(kind_id.name.lower() for kind_id in KindId))
)
# get KIND from environment, if not set default to potato
KIND_ID = os.environ.get('KIND', 'potato')
vm = voicemeeterlib.api(KIND_ID)
kind = kindmap(KIND_ID)
@@ -56,7 +54,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()

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',
)

View File

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

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

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

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

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

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

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

@@ -10,37 +10,37 @@ 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
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):
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):
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):
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"
assert vm.bus[data.phys_out].mode.get() == 'composite'
def test_it_tests_vm_config_bass_med_high(self):
assert vm.strip[data.virt_in].bass == -3.2

View File

@@ -3,7 +3,7 @@ import re
import pytest
import voicemeeterlib
from tests import data, vm
from tests import vm
class TestErrors:
@@ -14,36 +14,36 @@ class TestErrors:
voicemeeterlib.error.VMError,
match="Unknown Voicemeeter kind 'unknown_kind'",
):
voicemeeterlib.api("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",
match='VBVMR_SetParameterFloat returned -3',
) as exc_info:
vm.set("unknown.parameter", 1)
vm.set('unknown.parameter', 1)
e = exc_info.value
assert e.code == -3
assert e.fn_name == "VBVMR_SetParameterFloat"
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())}",
f'Known configs: {list(vm.configs.keys())}',
)
with pytest.raises(
voicemeeterlib.error.VMError, match=re.escape("\n".join(EXPECTED_MSG))
voicemeeterlib.error.VMError, match=re.escape('\n'.join(EXPECTED_MSG))
):
vm.apply_config("unknown")
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"},
'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)

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")
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")
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")
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

View File

@@ -3,19 +3,18 @@ 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.virt_in, "mono"),
(data.phys_in, 'mute'),
(data.phys_in, 'mono'),
(data.virt_in, 'mc'),
],
)
def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
@@ -25,14 +24,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):
@@ -43,10 +42,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):
@@ -57,10 +56,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):
@@ -71,16 +70,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):
@@ -88,18 +87,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):
@@ -109,8 +108,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)
@@ -119,8 +118,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)
@@ -129,8 +128,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)
@@ -139,8 +138,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)
@@ -148,12 +147,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)
@@ -161,12 +160,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)
@@ -176,12 +175,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)
@@ -191,11 +190,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),
@@ -207,11 +206,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),
@@ -223,12 +222,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)
@@ -237,12 +236,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)
@@ -251,12 +250,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)
@@ -265,8 +264,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)
@@ -279,36 +278,49 @@ 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, "k", 0),
(data.virt_in, "k", 4),
(data.phys_in, 'limit', -40),
(data.phys_in, 'limit', 12),
(data.virt_in - 1, 'k', 0),
(data.virt_in - 1, 'k', 4),
],
)
def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
def test_it_sets_and_gets_strip_int_params(self, index, param, value):
setattr(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_bool_params(self, index, param, value):
def test_it_sets_and_gets_vban_outstream_int_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),
@@ -321,11 +333,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),
@@ -340,11 +352,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),
@@ -359,11 +371,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),
@@ -376,16 +388,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):
@@ -400,10 +412,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):
@@ -411,25 +423,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),
@@ -444,12 +456,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):
@@ -458,14 +470,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):
@@ -474,14 +486,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):
@@ -490,14 +502,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):
@@ -506,13 +518,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):
@@ -522,13 +534,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):
@@ -538,12 +550,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)
@@ -551,30 +563,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_prefader_levels_and_compares_length_of_array(self, index, value):
def test_it_gets_bus_levels_and_compares_length_of_array(self, index, value):
assert len(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)
@@ -583,8 +595,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)
@@ -593,8 +605,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)
@@ -603,29 +615,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):

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 Normal file
View File

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

View File

@@ -1,5 +1,5 @@
import abc
import time
from abc import abstractmethod
from enum import IntEnum
from math import log
from typing import Union
@@ -22,7 +22,7 @@ class Bus(IRemote):
Defines concrete implementation for bus
"""
@abstractmethod
@abc.abstractmethod
def __str__(self):
pass
@@ -39,12 +39,12 @@ class Bus(IRemote):
self.setter('mute', 1 if val else 0)
@property
def mono(self) -> bool:
return self.getter('mono') == 1
def mono(self) -> int:
return int(self.getter('mono'))
@mono.setter
def mono(self, val: bool):
self.setter('mono', 1 if val else 0)
def mono(self, val: int):
self.setter('mono', val)
@property
def sel(self) -> bool:
@@ -88,6 +88,24 @@ class Bus(IRemote):
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'
@@ -109,6 +127,85 @@ class BusEQ(IRemote):
self.setter('ab', 1 if val else 0)
class BusEQCh(IRemote):
@classmethod
def make(cls, remote, i, j):
"""
Factory method for Bus EQ channel.
Returns a BusEQCh class.
"""
BusEQCh_cls = type(
'BusEQCh',
(cls,),
{
'cell': tuple(
BusEQChCell(remote, i, j, k) for k in range(remote.kind.cells)
)
},
)
return BusEQCh_cls(remote, i, j)
def __init__(self, remote, i, j):
super().__init__(remote, i)
self.channel_index = j
@property
def identifier(self) -> str:
return f'Bus[{self.index}].eq.channel[{self.channel_index}]'
class BusEQChCell(IRemote):
def __init__(self, remote, i, j, k):
super().__init__(remote, i)
self.channel_index = j
self.cell_index = k
@property
def identifier(self) -> str:
return f'Bus[{self.index}].eq.channel[{self.channel_index}].cell[{self.cell_index}]'
@property
def on(self) -> bool:
return self.getter('on') == 1
@on.setter
def on(self, val: bool):
self.setter('on', 1 if val else 0)
@property
def type(self) -> int:
return int(self.getter('type'))
@type.setter
def type(self, val: int):
self.setter('type', val)
@property
def f(self) -> float:
return round(self.getter('f'), 1)
@f.setter
def f(self, val: float):
self.setter('f', val)
@property
def gain(self) -> float:
return round(self.getter('gain'), 1)
@gain.setter
def gain(self, val: float):
self.setter('gain', val)
@property
def q(self) -> float:
return round(self.getter('q'), 1)
@q.setter
def q(self, val: float):
self.setter('q', val)
class PhysicalBus(Bus):
@classmethod
def make(cls, remote, i, kind):
@@ -321,7 +418,7 @@ def bus_factory(is_phys_bus, remote, i) -> Union[PhysicalBus, VirtualBus]:
{
'levels': BusLevel(remote, i),
'mode': BUSMODEMIXIN_cls(remote, i),
'eq': BusEQ(remote, i),
'eq': BusEQ.make(remote, i),
},
)(remote, i)

View File

@@ -1,6 +1,5 @@
import ctypes as ct
import logging
from abc import ABCMeta
from ctypes.wintypes import CHAR, FLOAT, LONG, WCHAR
from .error import CAPIError
@@ -9,11 +8,10 @@ from .inst import libc
logger = logging.getLogger(__name__)
class CBindings(metaclass=ABCMeta):
"""
C bindings defined here.
class CBindings:
"""Class responsible for defining C function bindings.
Maps expected ctype argument and res types for each binding.
Wrapper methods are provided for each C function to handle error checking and logging.
"""
logger_cbindings = logger.getChild('CBindings')
@@ -111,7 +109,8 @@ class CBindings(metaclass=ABCMeta):
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):
def _call(self, func, *args, ok=(0,), ok_exp=None):
"""Call a C function and handle errors."""
try:
res = func(*args)
if ok_exp is None:
@@ -123,3 +122,93 @@ class CBindings(metaclass=ABCMeta):
except CAPIError as e:
self.logger_cbindings.exception(f'{type(e).__name__}: {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)

View File

@@ -1,4 +1,4 @@
from abc import abstractmethod
import abc
from typing import Union
from .iremote import IRemote
@@ -7,19 +7,19 @@ from .iremote import IRemote
class Adapter(IRemote):
"""Adapter to the common interface."""
@abstractmethod
@abc.abstractmethod
def ins(self):
pass
@abstractmethod
@abc.abstractmethod
def outs(self):
pass
@abstractmethod
@abc.abstractmethod
def input(self):
pass
@abstractmethod
@abc.abstractmethod
def output(self):
pass

View File

@@ -1,5 +1,4 @@
import logging
from abc import abstractmethod
from enum import IntEnum
from functools import cached_property
from typing import Iterable
@@ -137,11 +136,6 @@ class FactoryBase(Remote):
def __str__(self) -> str:
return f'Voicemeeter {self.kind}'
@property
@abstractmethod
def steps(self):
pass
@cached_property
def configs(self):
self._configs = configs(self.kind.name)

View File

@@ -1,11 +1,11 @@
import abc
import logging
import time
from abc import ABCMeta, abstractmethod
logger = logging.getLogger(__name__)
class IRemote(metaclass=ABCMeta):
class IRemote(abc.ABC):
"""
Common interface between base class and extended (higher) classes
@@ -33,7 +33,7 @@ class IRemote(metaclass=ABCMeta):
cmd += (f'.{param}',)
return ''.join(cmd)
@abstractmethod
@abc.abstractmethod
def identifier(self):
pass

View File

@@ -31,6 +31,9 @@ class KindMapClass(metaclass=SingletonType):
asio: tuple
insert: int
composite: int
strip_channels: int
bus_channels: int
cells: int
@property
def phys_in(self) -> int:
@@ -76,6 +79,9 @@ class BasicMap(KindMapClass):
asio: tuple = (0, 0)
insert: int = 0
composite: int = 0
strip_channels: int = 0
bus_channels: int = 0
cells: int = 0
@dataclass(frozen=True)
@@ -86,6 +92,9 @@ class BananaMap(KindMapClass):
asio: tuple = (6, 8)
insert: int = 22
composite: int = 8
strip_channels: int = 0
bus_channels: int = 8
cells: int = 6
@dataclass(frozen=True)
@@ -96,6 +105,9 @@ class PotatoMap(KindMapClass):
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):

View File

@@ -1,8 +1,8 @@
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
@@ -19,12 +19,13 @@ from .util import deep_merge, grouper, polling, script, timeout
logger = logging.getLogger(__name__)
class Remote(CBindings):
"""Base class responsible for wrapping the C Remote API"""
class Remote(abc.ABC):
"""An abstract base class for Voicemeeter Remote API wrappers. Defines common methods and properties."""
DELAY = 0.001
def __init__(self, **kwargs):
self._bindings = CBindings()
self.strip_mode = 0
self.cache = {}
self.midi = Midi()
@@ -52,10 +53,10 @@ class Remote(CBindings):
self.init_thread()
return self
@abstractmethod
def __str__(self):
"""Ensure subclasses override str magic method"""
pass
@property
@abc.abstractmethod
def steps(self):
"""Steps required to build the interface for this Voicemeeter kind"""
def init_thread(self):
"""Starts updates thread."""
@@ -76,7 +77,7 @@ class Remote(CBindings):
@timeout
def login(self) -> None:
"""Login to the API, initialize dirty parameters"""
self.gui.launched = self.call(self.bind_login, ok=(0, 1)) == 0
self.gui.launched = self._bindings.login(ok=(0, 1)) == 0
if not self.gui.launched:
self.logger.info(
'Voicemeeter engine running but GUI not launched. Launching the GUI now.'
@@ -89,20 +90,20 @@ class Remote(CBindings):
value = KindId[kind_id.upper()].value
if BITS == 64 and self.bits == 64:
value += 3
self.call(self.bind_run_voicemeeter, value)
self._bindings.run_voicemeeter(value)
@property
def type(self) -> str:
"""Returns the type of Voicemeeter installation (basic, banana, potato)."""
type_ = ct.c_long()
self.call(self.bind_get_voicemeeter_type, ct.byref(type_))
self._bindings.get_voicemeeter_type(ct.byref(type_))
return KindId(type_.value).name.lower()
@property
def version(self) -> str:
"""Returns Voicemeeter's version as a string"""
ver = ct.c_long()
self.call(self.bind_get_voicemeeter_version, ct.byref(ver))
self._bindings.get_voicemeeter_version(ct.byref(ver))
return '{}.{}.{}.{}'.format(
(ver.value & 0xFF000000) >> 24,
(ver.value & 0x00FF0000) >> 16,
@@ -113,13 +114,13 @@ class Remote(CBindings):
@property
def pdirty(self) -> bool:
"""True iff UI parameters have been updated."""
return self.call(self.bind_is_parameters_dirty, ok=(0, 1)) == 1
return self._bindings.is_parameters_dirty(ok=(0, 1)) == 1
@property
def mdirty(self) -> bool:
"""True iff MB parameters have been updated."""
try:
return self.call(self.bind_macro_button_is_dirty, ok=(0, 1)) == 1
return self._bindings.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
@@ -149,10 +150,10 @@ class Remote(CBindings):
"""Gets a string or float parameter"""
if is_string:
buf = ct.create_unicode_buffer(512)
self.call(self.bind_get_parameter_string_w, param.encode(), ct.byref(buf))
self._bindings.get_parameter_string_w(param.encode(), ct.byref(buf))
else:
buf = ct.c_float()
self.call(self.bind_get_parameter_float, param.encode(), ct.byref(buf))
self._bindings.get_parameter_float(param.encode(), ct.byref(buf))
return buf.value
def set(self, param: str, val: Union[str, float]) -> None:
@@ -160,12 +161,11 @@ class Remote(CBindings):
if isinstance(val, str):
if len(val) >= 512:
raise VMError('String is too long')
self.call(
self.bind_set_parameter_string_w, param.encode(), ct.c_wchar_p(val)
)
self._bindings.set_parameter_string_w(param.encode(), ct.c_wchar_p(val))
else:
self.call(
self.bind_set_parameter_float, param.encode(), ct.c_float(float(val))
self._bindings.set_parameter_float(
param.encode(),
ct.c_float(float(val)),
)
self.cache[param] = val
@@ -174,8 +174,7 @@ class Remote(CBindings):
"""Gets a macrobutton parameter"""
c_state = ct.c_float()
try:
self.call(
self.bind_macro_button_get_status,
self._bindings.macro_button_get_status(
ct.c_long(id_),
ct.byref(c_state),
ct.c_long(mode),
@@ -189,8 +188,7 @@ class Remote(CBindings):
"""Sets a macrobutton parameter. Caches value"""
c_state = ct.c_float(float(val))
try:
self.call(
self.bind_macro_button_set_status,
self._bindings.macro_button_set_status(
ct.c_long(id_),
c_state,
ct.c_long(mode),
@@ -204,8 +202,8 @@ class Remote(CBindings):
"""Retrieves number of physical devices connected"""
if direction not in ('in', 'out'):
raise VMError('Expected a direction: in or out')
func = getattr(self, f'bind_{direction}put_get_device_number')
res = self.call(func, ok_exp=lambda r: r >= 0)
func = getattr(self._bindings, f'{direction}put_get_device_number')
res = func(ok_exp=lambda r: r >= 0)
return res
def get_device_description(self, index: int, direction: str = None) -> tuple:
@@ -215,9 +213,8 @@ class Remote(CBindings):
type_ = ct.c_long()
name = ct.create_unicode_buffer(256)
hwid = ct.create_unicode_buffer(256)
func = getattr(self, f'bind_{direction}put_get_device_desc_w')
self.call(
func,
func = getattr(self._bindings, f'{direction}put_get_device_desc_w')
func(
ct.c_long(index),
ct.byref(type_),
ct.byref(name),
@@ -228,9 +225,7 @@ class Remote(CBindings):
def get_level(self, type_: int, index: int) -> float:
"""Retrieves a single level value"""
val = ct.c_float()
self.call(
self.bind_get_level, ct.c_long(type_), ct.c_long(index), ct.byref(val)
)
self._bindings.get_level(ct.c_long(type_), ct.c_long(index), ct.byref(val))
return val.value
def _get_levels(self) -> Iterable:
@@ -248,8 +243,7 @@ class Remote(CBindings):
def get_midi_message(self):
n = ct.c_long(1024)
buf = ct.create_string_buffer(1024)
res = self.call(
self.bind_get_midi_message,
res = self._bindings.get_midi_message(
ct.byref(buf),
n,
ok=(-5, -6), # no data received from midi device
@@ -272,7 +266,7 @@ class Remote(CBindings):
"""Sets many parameters from a script"""
if len(script) > 48000:
raise ValueError('Script too large, max size 48kB')
self.call(self.bind_set_parameters, script.encode())
self._bindings.set_parameters(script.encode())
time.sleep(self.DELAY * 5)
def apply(self, data: dict):
@@ -339,7 +333,7 @@ class Remote(CBindings):
def logout(self) -> None:
"""Logout of the API"""
time.sleep(0.1)
self.call(self.bind_logout)
self._bindings.logout()
self.logger.info(f'{type(self).__name__}: Successfully logged out of {self}')
def __exit__(self, exc_type, exc_value, exc_traceback) -> None:

View File

@@ -1,5 +1,5 @@
import abc
import time
from abc import abstractmethod
from math import log
from typing import Union
@@ -15,7 +15,7 @@ class Strip(IRemote):
Defines concrete implementation for strip
"""
@abstractmethod
@abc.abstractmethod
def __str__(self):
pass
@@ -96,7 +96,7 @@ class PhysicalStrip(Strip):
'comp': StripComp(remote, i),
'gate': StripGate(remote, i),
'denoiser': StripDenoiser(remote, i),
'eq': StripEQ(remote, i),
'eq': StripEQ.make(remote, i),
'device': StripDevice.make(remote, i),
},
)
@@ -268,6 +268,25 @@ class StripDenoiser(IRemote):
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'
@@ -289,6 +308,85 @@ class StripEQ(IRemote):
self.setter('ab', 1 if val else 0)
class StripEQCh(IRemote):
@classmethod
def make(cls, remote, i, j):
"""
Factory method for Strip EQ channel.
Returns a StripEQCh class.
"""
StripEQCh_cls = type(
'StripEQCh',
(cls,),
{
'cell': tuple(
StripEQChCell(remote, i, j, k) for k in range(remote.kind.cells)
)
},
)
return StripEQCh_cls(remote, i, j)
def __init__(self, remote, i, j):
super().__init__(remote, i)
self.channel_index = j
@property
def identifier(self) -> str:
return f'Strip[{self.index}].eq.channel[{self.channel_index}]'
class StripEQChCell(IRemote):
def __init__(self, remote, i, j, k):
super().__init__(remote, i)
self.channel_index = j
self.cell_index = k
@property
def identifier(self) -> str:
return f'Strip[{self.index}].eq.channel[{self.channel_index}].cell[{self.cell_index}]'
@property
def on(self) -> bool:
return self.getter('on') == 1
@on.setter
def on(self, val: bool):
self.setter('on', 1 if val else 0)
@property
def type(self) -> int:
return int(self.getter('type'))
@type.setter
def type(self, val: int):
self.setter('type', val)
@property
def f(self) -> float:
return round(self.getter('f'), 1)
@f.setter
def f(self, val: float):
self.setter('f', val)
@property
def gain(self) -> float:
return round(self.getter('gain'), 1)
@gain.setter
def gain(self, val: float):
self.setter('gain', val)
@property
def q(self) -> float:
return round(self.getter('q'), 1)
@q.setter
def q(self, val: float):
self.setter('q', val)
class StripDevice(IRemote):
@classmethod
def make(cls, remote, i):

View File

@@ -1,4 +1,4 @@
from abc import abstractmethod
import abc
from . import kinds
from .iremote import IRemote
@@ -11,7 +11,7 @@ class VbanStream(IRemote):
Defines concrete implementation for vban stream
"""
@abstractmethod
@abc.abstractmethod
def __str__(self):
pass