80 Commits

Author SHA1 Message Date
5b99f8aae3 patch bump 2023-06-29 18:05:20 +01:00
59624ccb3e add VmGUI class to misc.
lets you check if gui was launched by the api
2023-06-29 18:05:07 +01:00
b2005030f2 bind double click event to slider 2023-06-28 13:57:45 +01:00
88a5686f27 upd strip comp, gate sections in readme 2023-06-25 13:47:21 +01:00
d0877dbdfd bump tested against versions 2023-06-25 11:14:22 +01:00
ce9a86de79 patch bump 2023-06-25 11:00:56 +01:00
58dba331a7 fix polling parameters in readme. 2023-06-25 11:00:32 +01:00
77003940f2 fix bus number in levels example 2023-06-25 10:59:35 +01:00
d794bd4b78 clears deprecation warning 2023-06-25 10:58:45 +01:00
b3febbe831 upd release date 2023-06-25 00:55:09 +01:00
cf18ae6fcc add gui example to added section in changelog 2023-06-24 23:36:03 +01:00
01178082d2 typo 2023-06-24 23:32:53 +01:00
3d98b2accd add gui example 2023-06-24 23:30:35 +01:00
cc26720ae2 add eq, comp, gate to apply examples. 2023-06-24 19:06:23 +01:00
2f9864cf60 version 2.0.0 section added to changelog
readme updated to reflect latest changes

test badges updated.

fixes #5
2023-06-23 18:29:41 +01:00
f57475daa0 tox added as development dependency
events, levels added to scripts

major version bump
2023-06-23 18:18:42 +01:00
8fc052d093 new examples added to scripts 2023-06-23 18:18:01 +01:00
8831277160 comp, gate, eq parameters updated 2023-06-23 18:14:18 +01:00
d428694fcf add example events. 2023-06-23 18:13:45 +01:00
0548d82295 add new levels example 2023-06-23 17:54:08 +01:00
27d7f1fcd5 add setup.py for dsl example 2023-06-23 17:53:03 +01:00
40d984c44f isort imports 2023-06-23 17:50:48 +01:00
9ef89852de midi example now registers callback on_midi 2023-06-23 17:50:16 +01:00
b81c4c4b97 modify logging config to filter out logs
script now ends when OBS is closed.
2023-06-23 17:44:51 +01:00
1ee0fc5f06 update observer example to reflect changes 2023-06-23 17:42:37 +01:00
772a3344ca add module level logger 2023-06-23 17:34:50 +01:00
b2f57a9e60 extend subject class to support callbacks 2023-06-23 17:31:49 +01:00
c23a6aff6d strip.eq, strip.comp, strip.gate, tests added
bus.eq tests added
2023-06-23 04:13:34 +01:00
342a49804f add module level loggers 2023-06-23 03:45:03 +01:00
064cfeb23d raise VMError on invalid kind 2023-06-23 03:43:34 +01:00
6c4259d6de remove unused import 2023-06-23 03:43:02 +01:00
9cf048185d reword Exception class docstrings. 2023-06-23 03:42:34 +01:00
435a9e2085 rename action_prop to action_fn 2023-06-23 03:39:07 +01:00
b10a90418e producer thread now sends job queue to updater. 2023-06-23 03:22:09 +01:00
7d4d09ff29 all CAPI calls wrapped by call().
raise CAPIError if macrobutton fns are not bound

producer thread added to init_thread()
2023-06-23 01:36:02 +01:00
6ddfe3044e apply now sets attributes if passed nested dicts.
_cmd() helper method added
2023-06-23 01:27:03 +01:00
36fe77f0f0 raise InstallError if reg key not found 2023-06-23 01:22:50 +01:00
155e597db5 request_remote_obj now raises VMError on invalid kind
all events default to False in FactoryBase.defaultkwargs
2023-06-23 01:21:20 +01:00
92e04f1419 comp, gate, denoiser, eq params updated in
TOMLStrBuilder

Path.home() / ".config" / "voicemeeter" / kind.name added to loader path
2023-06-23 01:19:55 +01:00
b5c8641c11 StripComp, StripGate, StripDenoiser, StripEQ
added to PhysicalStrip
2023-06-23 01:16:50 +01:00
c6b203a1df dynamically load macrobutton capi functions
log any exceptions raised in call()
2023-06-23 01:15:27 +01:00
9f27968c5c BUSEQ class added to Bus class 2023-06-23 01:13:56 +01:00
e6ea1e5f4f bump to major version 1 2023-06-19 20:03:26 +01:00
onyx-and-iris
a460c6aeb0 add scripts.py 2022-11-07 20:21:50 +00:00
onyx-and-iris
bc508f8982 use walrus =) 2022-10-28 02:18:39 +01:00
onyx-and-iris
a4cc7058b6 examples refactored
poetry scripts added
2022-10-28 02:14:08 +01:00
onyx-and-iris
6fa6d70f9b upd basic.svg 2022-10-27 08:50:54 +01:00
onyx-and-iris
a73ebf364b only add fx properties to phys strips
patch bump
2022-10-27 08:50:27 +01:00
onyx-and-iris
caf05aa789 fix virt strip factory method docstring 2022-10-26 14:27:59 +01:00
onyx-and-iris
405fa8d5cb upd potato.svg 2022-10-26 14:24:55 +01:00
onyx-and-iris
5ad5622612 pan_x, pan_y added to virtual strips
pan_x, pan_y virt tests added to higher.

patch bump
2022-10-26 14:24:13 +01:00
onyx-and-iris
108c327c52 fix bug in example 2022-10-19 13:51:25 +01:00
onyx-and-iris
7f1a51f86d cleanup installation section 2022-10-18 16:17:35 +01:00
onyx-and-iris
94bace4f4d add observer README 2022-10-18 15:52:12 +01:00
onyx-and-iris
4e8532e805 md fix 2022-10-17 15:21:55 +01:00
onyx-and-iris
907df78b37 add missing type hints to device mixins 2022-10-16 17:47:55 +01:00
onyx-and-iris
f4fc58cea0 added strip/bus device mixins.
device_prop added to meta

README, CHANGELOG updated to reflect changes.

minor version bump

fixes #3
2022-10-11 12:53:08 +01:00
onyx-and-iris
816fd76213 add, remove now accept iterables
update README

patch bump
2022-10-06 18:07:34 +01:00
onyx-and-iris
ad69d2cf14 fix str format 2022-10-06 16:50:00 +01:00
onyx-and-iris
86612a65cb add property setters in event class
use event property setters in examples

update README

patch bump
2022-10-06 16:45:08 +01:00
onyx-and-iris
08fdad135d patch bump 2022-10-04 14:36:58 +01:00
onyx-and-iris
30370f70ee print bus level values in observer example 2022-10-04 14:36:46 +01:00
onyx-and-iris
f62a22f563 initialize channel comps in updater 2022-10-04 14:36:08 +01:00
onyx-and-iris
c513e4db19 upd poetry.lock 2022-09-29 11:35:04 +01:00
onyx-and-iris
9c8fe0b626 use logging module in subject class
patch bump
2022-09-29 11:31:19 +01:00
onyx-and-iris
af0d51eeb1 changelog, readme updated to reflect changes
minor version bump
2022-09-29 10:26:55 +01:00
onyx-and-iris
bd686ef67d use time.time() to steady rate of updates.
reduce loop time if waiting for new event
2022-09-29 10:20:05 +01:00
onyx-and-iris
aefde48c98 loglevel INFO set for examples 2022-09-29 10:01:18 +01:00
onyx-and-iris
4c6fc2d396 fix bug in call to cache in updater 2022-09-29 09:44:50 +01:00
onyx-and-iris
eddccb66c5 event class moved into event.py
logger module used to write interface events to console
2022-09-29 09:44:14 +01:00
onyx-and-iris
81a74d136c base renamed to remote
logger module used in place of print
2022-09-29 09:42:58 +01:00
onyx-and-iris
6b7a79173c fix import... oops. 2022-09-24 12:08:43 +01:00
onyx-and-iris
ef0c94a6f1 move updater thread logic out of base class.
patch bump
2022-09-24 12:04:07 +01:00
onyx-and-iris
a54a232a82 point streamlabs example to gist 2022-09-16 13:00:38 +01:00
onyx-and-iris
b2156ffade update links in obs example readme 2022-09-16 12:46:44 +01:00
onyx-and-iris
496f9d37fa update obs example with new obs api package name 2022-09-16 12:36:12 +01:00
onyx-and-iris
3f9c486fa0 fix ver bump in changelog 2022-09-03 16:33:01 +01:00
onyx-and-iris
48b2857c58 tomli/tomllib compatibility layer added.
Type annotation Self removed.

python version requirement changed.

tomli added as runtime dependency if py ver < 3.11

minor version bump.
2022-09-03 16:28:19 +01:00
onyx-and-iris
af0740ddec obs v28 has websocket support built-in. 2022-09-01 15:16:07 +01:00
onyx-and-iris
f3eec58c25 update tested against versions 2022-08-08 16:40:59 +01:00
49 changed files with 2098 additions and 893 deletions

4
.gitignore vendored
View File

@@ -131,3 +131,7 @@ dmypy.json
# test/config
quick.py
config.toml
vm-api.log
logging.json
.vscode/

View File

@@ -11,6 +11,124 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- [x]
## [2.0.0] - 2023-06-25
Where possible I've attempted to make the changes backwards compatible. The breaking changes affect two higher classes, Strip and Bus, as well as the behaviour of events. All other changes are additive or QOL aimed at giving more options to the developer. For example, every low-level CAPI call is now logged and error raised on Exception, you can now register callback functions as well as observer classes, extra examples to demonstrate different use cases etc.
The breaking changes are as follows:
### Changed
- `strip[i].comp` now references StripComp class
- To change the comp knob you should now use the property `strip[i].comp.knob`
- `strip[i].gate` now references StripGate class
- To change the gate knob you should now use the property `strip[i].gate.knob`
- `bus[i].eq` now references BusEQ class
- To set bus[i].{eq,eq_ab} as before you should now use bus[i].eq.on and bus[i].eq.ab
- by default, <strong>NO</strong> events are checked for. This is reflected in factory.FactoryBase defaultkwargs.
- This is a fundamental behaviour change from version 1.0 of the wrapper. It means the following:
- Unless any events are explicitly requested with an event kwarg the event emitter thread will not run automatically.
- Whether using a context manager or not, you can still initiate the event thread manually and request events with the event object.<br>
see `events` example.
There are other non-breaking changes:
### Added
- `strip[i].eq` added to PhysicalStrip
- `strip[i].denoiser` added to PhysicalStrip
- `Strip.Comp`, `Strip.Gate`, `Strip.Denoiser` sections added to README.
- `Events` section in readme updated to reflect changes to events kwargs.
- new comp, gate, denoiser and eq tests added to higher tests.
- `levels` example to demonstrate use of the interface without a context manager.
- `events` example to demonstrate how to interact with event thread/event object.
- `gui` example to demonstrate GUI controls.
- `{Remote}.observer` can be used in place of `{Remote}.subject` although subject will still work. Check examples.
- Subject class extended to allow registering/de-registering callback functions (as well as observer classes). See `events` example.
### Changed
- `comp.knob`, `gate.knob`, `denoiser.knob`, `eq.on` added to phys_strip_params in config.TOMLStrBuilder
- The `example.toml` config files have been updated to demonstrate setting new comp, gate and eq settings.
- event kwargs can now be set directly. no need for `subs`. example: `voicemeeterlib.api('banana', midi=True})`
- factorybuilder steps now logged in DEBUG mode.
- now using a producer thread to send events to the updater thread.
- module level loggers implemented (with class loggers as child loggers)
- config.loader now checks `Path.home() / ".config" / "voicemeeter" / kind.name` for configs.
- note. `Path(__file__).parent / "configs" / kind.name,` was removed as a path to check.
### Fixed
- All low level CAPI calls are now wrapped by CBindings.call() which logs any errors raised.
- Dynamic binding of Macrobutton functions from the CAPI.
Should add backwards compatibility with very old versions of the api. See [Issue #4][issue 4].
- factory.request_remote_obj now raises a `VMError` if passed an incorrect kind.
## [1.0.0] - 2023-06-19
No changes to the codebase but it has been stable for several months and should already have been bumped to major version 1.0
I will move this commit to a separate branch in preparation for version 2.0.
## [0.9.0] - 2022-10-11
### Added
- StripDevice and BusDevice mixins.
- README updated to reflect changes.
- Minor version bump
### Removed
- device, sr properties for physical strip, bus moved into mixin classes
### Changed
- Event class property setters added.
- Event add/remove methods now accept multiple events.
- bus levels now printed in observer example.
### Fixed
- initialize channel comps in updater thread. Fixes bug when switching to a kind before any level updates have occurred.
## [0.8.0] - 2022-09-29
### Added
- Logging level INFO set on all examples.
- Minor version bump
- vm.subject subsection added to README
### Changed
- Logging module used in place of print statements across the interface.
- time.time() now used to steady rate of updates in updater thread.
### Fixed
- call to cache bug in updater thread
## [0.7.0] - 2022-09-03
### Added
- tomli/tomllib compatibility layer to support python 3.10
### Removed
- 3.10 branch
## [0.6.0] - 2022-08-02
### Added
@@ -243,3 +361,5 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- inst module implemented (fetch vm path from registry)
- kind maps implemented as dataclasses
- project packaged with poetry and added to pypi.
[issue 4]: https://github.com/onyx-and-iris/voicemeeter-api-python/issues/4

282
README.md
View File

@@ -14,21 +14,17 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
## Tested against
- Basic 1.0.8.2
- Banana 2.0.6.2
- Potato 3.0.2.2
- Basic 1.0.8.8
- Banana 2.0.6.8
- Potato 3.0.2.8
## Requirements
- [Voicemeeter](https://voicemeeter.com/)
- Python 3.11 or greater
- Python 3.10 or greater
## Installation
### `Pip`
Install voicemeeter-api package from your console
`pip install voicemeeter-api`
## `Use`
@@ -55,17 +51,19 @@ class ManyThings:
)
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}",
f"bus 4 eq has been set to {self.vm.bus[4].eq.on}",
)
self.vm.bus[3].gain = -6.3
self.vm.bus[4].eq = True
print("\n".join(info))
def main():
with voicemeeterlib.api(kind_id) as vm:
KIND_ID = "banana"
with voicemeeterlib.api(KIND_ID) as vm:
do = ManyThings(vm)
do.things()
do.other_things()
@@ -74,7 +72,7 @@ def main():
vm.apply(
{
"strip-2": {"A1": True, "B1": True, "gain": -6.0},
"bus-2": {"mute": True},
"bus-2": {"mute": True, "eq": {"on": True}},
"button-0": {"state": True},
"vban-in-0": {"on": True},
"vban-out-1": {"name": "streamname"},
@@ -83,16 +81,15 @@ def main():
if __name__ == "__main__":
kind_id = "banana"
main()
```
Otherwise you must remember to call `vm.login()`, `vm.logout()` at the start/end of your code.
## `kind_id`
## `KIND_ID`
Pass the kind of Voicemeeter as an argument. kind_id may be:
Pass the kind of Voicemeeter as an argument. KIND_ID may be:
- `basic`
- `banana`
@@ -108,14 +105,10 @@ The following properties are available.
- `solo`: boolean
- `mute`: boolean
- `gain`: float, from -60.0 to 12.0
- `comp`: float, from 0.0 to 10.0
- `gate`: float, from 0.0 to 10.0
- `audibility`: float, from 0.0 to 10.0
- `limit`: int, from -40 to 12
- `A1 - A5`, `B1 - B3`: boolean
- `label`: string
- `device`: string
- `sr`: int
- `mc`: boolean
- `k`: int, from 0 to 4
- `bass`: float, from -12.0 to 12.0
@@ -143,7 +136,7 @@ vm.strip[3].gain = 3.7
print(vm.strip[0].label)
```
The following methods are Available.
The following methods are available.
- `appgain(name, value)`: string, float, from 0.0 to 1.0
@@ -160,7 +153,82 @@ vm.strip[5].appmute("Spotify", True)
vm.strip[5].appgain("Spotify", 0.5)
```
##### Gainlayers
#### Strip.Comp
The following properties are available.
- `knob`: float, from 0.0 to 10.0
- `gainin`: float, from -24.0 to 24.0
- `ratio`: float, from 1.0 to 8.0
- `threshold`: float, from -40.0 to -3.0
- `attack`: float, from 0.0 to 200.0
- `release`: float, from 0.0 to 5000.0
- `knee`: float, from 0.0 to 1.0
- `gainout`: float, from -24.0 to 24.0
- `makeup`: boolean
example:
```python
print(vm.strip[4].comp.knob)
```
Strip Comp parameters are defined for PhysicalStrips.
`knob` defined for all versions, all other parameters potato only.
#### Strip.Gate
The following properties are available.
- `knob`: float, from 0.0 to 10.0
- `threshold`: float, from -60.0 to -10.0
- `damping`: float, from -60.0 to -10.0
- `bpsidechain`: int, from 100 to 4000
- `attack`: float, from 0.0 to 1000.0
- `hold`: float, from 0.0 to 5000.0
- `release`: float, from 0.0 to 5000.0
example:
```python
vm.strip[2].gate.attack = 300.8
```
Strip Gate parameters are defined for PhysicalStrips.
`knob` defined for all versions, all other parameters potato only.
#### Strip.Denoiser
The following properties are available.
- `knob`: float, from 0.0 to 10.0
example:
```python
vm.strip[0].denoiser.knob = 0.5
```
Strip Denoiser parameters are defined for PhysicalStrips, potato version only.
#### Strip.EQ
The following properties are available.
- `on`: boolean
- `ab`: boolean
example:
```python
vm.strip[0].eq.ab = True
```
Strip EQ parameters are defined for PhysicalStrips, potato version only.
##### Strip.Gainlayers
- `gain`: float, from -60.0 to 12.0
@@ -172,7 +240,7 @@ vm.strip[3].gainlayer[3].gain = 3.7
Gainlayers are defined for potato version only.
##### Levels
##### Strip.Levels
The following properties are available.
@@ -193,14 +261,10 @@ Level properties will return -200.0 if no audio detected.
The following properties are available.
- `mono`: boolean
- `eq`: boolean
- `eq_ab`: boolean
- `mute`: boolean
- `sel`: boolean
- `gain`: float, from -60.0 to 12.0
- `label`: string
- `device`: string
- `sr`: int
- `returnreverb`: float, from 0.0 to 10.0
- `returndelay`: float, from 0.0 to 10.0
- `returnfx1`: float, from 0.0 to 10.0
@@ -216,7 +280,20 @@ print(vm.bus[0].label)
vm.bus[4].mono = True
```
##### Modes
##### Bus.EQ
The following properties are available.
- `on`: boolean
- `ab`: boolean
example:
```python
vm.bus[3].eq.on = True
```
##### Bus.Modes
The following properties are available.
@@ -244,7 +321,7 @@ vm.bus[4].mode.amix = True
print(vm.bus[2].mode.get())
```
##### Levels
##### Bus.Levels
The following properties are available.
@@ -274,6 +351,28 @@ vm.strip[0].fadeto(-10.3, 1000)
vm.bus[3].fadeby(-5.6, 500)
```
#### Strip.Device | Bus.Device
The following properties are available
- `name`: str
- `sr`: int
- `wdm`: str
- `ks`: str
- `mme`: str
- `asio`: str
example:
```python
print(vm.strip[0].device.name)
vm.bus[0].device.asio = "Audient USB Audio ASIO Driver"
```
strip|bus device parameters are defined for physical channels only.
name, sr are read only. wdm, ks, mme, asio are write only.
### Macrobuttons
The following properties are available.
@@ -395,7 +494,7 @@ example:
```python
import voicemeeterlib
with voicemeeterlib.api(kind_id) as vm:
with voicemeeterlib.api(KIND_ID) as vm:
for i in range(vm.device.ins):
print(vm.device.input(i))
```
@@ -548,7 +647,7 @@ get() may return None if no value for requested key in midi cache
vm.apply(
{
"strip-2": {"A1": True, "B1": True, "gain": -6.0},
"bus-2": {"mute": True},
"bus-2": {"mute": True, "eq": {"on": True}},
"button-0": {"state": True},
"vban-in-0": {"on": True},
"vban-out-1": {"name": "streamname"},
@@ -579,73 +678,93 @@ with voicemeeterlib.api('banana') as vm:
will load a user config file at configs/banana/example.toml for Voicemeeter Banana.
## `Base Module`
## Events
### Remote class
`voicemeeterlib.api(kind_id: str)`
You may pass the following optional keyword arguments:
- `sync`: boolean=False, force the getters to wait for dirty parameters to clear. For most cases leave this as False.
- `ratelimit`: float=0.033, how often to check for updates in ms.
- `subs`: dict={"pdirty": True, "mdirty": True, "midi": True, "ldirty": False}, initialize which event updates to listen for.
- `pdirty`: parameter updates
- `mdirty`: macrobutton updates
- `midi`: midi updates
- `ldirty`: level updates
#### Event updates
To receive event updates you should do the following:
- register your app to receive updates using the `vm.subject.add(observer)` method, where observer is your app.
- define an `on_update(subject)` callback function in your app. The value of subject may be checked for the type of event.
See `examples/observer` for a demonstration.
Level updates are considered high volume, by default they are NOT listened for. However, polling them with strip.levels and bus.levels methods will still work.
So if you don't wish to receive level updates, or you prefer to handle them yourself simply leave ldirty as default (False).
Each of the update types may be enabled/disabled separately. Don't use a midi controller? You have the option to disable midi updates.
By default, NO events are listened for. Use events kwargs to enable specific event types.
example:
```python
import voicemeeterlib
# Set updates to occur every 50ms
# Listen for level updates but disable midi updates
with voicemeeterlib.api('banana', ratelimit=0.05, subs={"ldirty": True, "midi": False}) as vm:
# Set event updates to occur every 50ms
# Listen for level updates only
with voicemeeterlib.api('banana', ratelimit=0.05, ldirty=True}) as vm:
...
```
#### `vm.observer`
Use the Subject class to register an app as event observer.
The following methods are available:
- `add`: registers an app as an event observer
- `remove`: deregisters an app as an event observer
example:
```python
# register an app to receive updates
class App():
def __init__(self, vm):
vm.observer.add(self)
...
```
#### `vm.event`
You may also add/remove event subscriptions as necessary with the Event class.
Use the event class to toggle updates as necessary.
The following properties are available:
- `pdirty`: boolean
- `mdirty`: boolean
- `midi`: boolean
- `ldirty`: boolean
example:
```python
vm.event.add("ldirty")
vm.event.ldirty = True
vm.event.remove("pdirty")
vm.event.pdirty = False
```
Or add, remove a list of events.
The following methods are available:
- `add()`
- `remove()`
- `get()`
example:
```python
vm.event.remove(["pdirty", "mdirty", "midi"])
# get a list of currently subscribed
print(vm.event.get())
```
## Remote class
`voicemeeterlib.api(KIND_ID: str)`
You may pass the following optional keyword arguments:
- `sync`: boolean=False, force the getters to wait for dirty parameters to clear. For most cases leave this as False.
- `ratelimit`: float=0.033, how often to check for updates in ms.
- `pdirty`: boolean=False, parameter updates
- `mdirty`: boolean=False, macrobutton updates
- `midi`: boolean=False, midi updates
- `ldirty`: boolean=False, level updates
Access to lower level Getters and Setters are provided with these functions:
- `vm.get(param, is_string=False)`: For getting the value of any parameter. Set string to True if getting a property value expected to return a string.
- `vm.set(param, value)`: For setting the value of any parameter.
Access to lower level polling functions are provided with these functions:
- `vm.pdirty()`: Returns True if a parameter has been updated.
- `vm.mdirty()`: Returns True if a macrobutton has been updated.
- `vm.ldirty()`: Returns True if a level has been updated.
example:
```python
@@ -654,6 +773,21 @@ vm.set('Strip[4].Label', 'stripname')
vm.set('Strip[0].Gain', -3.6)
```
Access to lower level polling functions are provided with the following property objects:
#### `vm.pdirty`
True iff a parameter has been updated.
#### `vm.mdirty`
True iff a macrobutton has been updated.
#### `vm.ldirty`
True iff a level has been updated.
### Run tests
To run all tests:
@@ -664,4 +798,4 @@ 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)

View File

@@ -13,17 +13,19 @@ class ManyThings:
)
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}",
f"bus 4 eq has been set to {self.vm.bus[4].eq.on}",
)
self.vm.bus[3].gain = -6.3
self.vm.bus[4].eq = True
print("\n".join(info))
def main():
with voicemeeterlib.api(kind_id) as vm:
KIND_ID = "banana"
with voicemeeterlib.api(KIND_ID) as vm:
do = ManyThings(vm)
do.things()
do.other_things()
@@ -32,7 +34,7 @@ def main():
vm.apply(
{
"strip-2": {"A1": True, "B1": True, "gain": -6.0},
"bus-2": {"mute": True},
"bus-2": {"mute": True, "eq": {"on": True}},
"button-0": {"state": True},
"vban-in-0": {"on": True},
"vban-out-1": {"name": "streamname"},
@@ -41,6 +43,4 @@ def main():
if __name__ == "__main__":
kind_id = "banana"
main()

View File

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

View File

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

View File

@@ -1,6 +1,7 @@
import argparse
import logging
import time
import voicemeeterlib
from pyparsing import (
Combine,
Group,
@@ -13,6 +14,13 @@ from pyparsing import (
nums,
)
import voicemeeterlib
logging.basicConfig(level=logging.INFO)
argparser = argparse.ArgumentParser(description="creates a basic dsl")
argparser.add_argument("-i", action="store_true")
args = argparser.parse_args()
class Parser:
def __init__(self, vm):
@@ -53,46 +61,38 @@ class Parser:
return res
def main(cmds=None):
kind_id = "banana"
with voicemeeterlib.api(kind_id) as vm:
parser = Parser(vm)
if cmds:
res = parser.parse(cmds)
if res:
print(res)
else:
def interactive_mode(parser):
while cmd := input("Please enter command (Press <Enter> to exit)\n"):
if not cmd:
break
res = parser.parse((cmd,))
if res:
if res := parser.parse((cmd,)):
print(res)
def main():
# fmt: off
cmds = (
"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",
)
# fmt: on
KIND_ID = "banana"
with voicemeeterlib.api(KIND_ID) as vm:
parser = Parser(vm)
if args.i:
interactive_mode(parser)
return
if res := parser.parse(cmds):
print(res)
if __name__ == "__main__":
cmds = (
"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",
)
# pass cmds to parse cmds, otherwise simply run main() to test stdin parsing
main(cmds)
main()

7
examples/dsl/setup.py Normal file
View File

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

33
examples/events/README.md Normal file
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

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

13
examples/gui/README.md Normal file
View File

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

109
examples/gui/__main__.py Normal file
View File

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

13
examples/levels/README.md Normal file
View File

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

View File

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

View File

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

View File

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

View File

@@ -1,58 +1,97 @@
import obsstudio_sdk as obs
import time
from logging import config
import obsws_python as obsws
import voicemeeterlib
def on_start():
vm.strip[0].mute = True
vm.strip[1].B1 = True
vm.strip[2].B2 = True
def on_brb():
vm.strip[7].fadeto(0, 500)
vm.bus[0].mute = True
def on_end():
vm.apply(
config.dictConfig(
{
"strip-0": {"mute": True},
"strip-1": {"mute": True, "B1": False},
"version": 1,
"formatters": {
"standard": {
"format": "%(asctime)s,%(msecs)d %(name)s %(levelname)s %(message)s"
}
},
"handlers": {
"stream": {
"level": "DEBUG",
"class": "logging.StreamHandler",
"formatter": "standard",
}
},
"loggers": {
"voicemeeterlib.iremote": {"handlers": ["stream"], "level": "DEBUG"}
},
}
)
class MyClient:
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,
)
)
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
def on_brb(self):
self.vm.strip[7].fadeto(0, 500)
self.vm.bus[0].mute = True
def on_end(self):
self.vm.apply(
{
"strip-0": {"mute": True, "comp": {"ratio": 4.3}},
"strip-1": {"mute": True, "B1": False, "gate": {"attack": 2.3}},
"strip-2": {"mute": True, "B1": False},
"vban-in-0": {"on": False},
}
)
def on_live(self):
self.vm.strip[0].mute = False
self.vm.strip[7].fadeto(-6, 500)
self.vm.strip[7].A3 = True
self.vm.vban.instream[0].on = True
def on_live():
vm.strip[0].mute = False
vm.strip[7].fadeto(-6, 500)
vm.strip[7].A3 = True
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)
def on_current_program_scene_changed(data):
scene = data.scene_name
print(f"Switched to scene {scene}")
if fn := fget(scene):
fn()
match scene:
case "START":
on_start()
case "BRB":
on_brb()
case "END":
on_end()
case "LIVE":
on_live()
case _:
pass
def on_exit_started(self, _):
self.client.unsubscribe()
self.is_running = False
def main():
KIND_ID = "potato"
with voicemeeterlib.api(KIND_ID) as vm:
client = MyClient(vm)
while client.is_running:
time.sleep(0.1)
if __name__ == "__main__":
with voicemeeterlib.api("potato") as vm:
cl = obs.EventClient()
cl.callback.register(on_current_program_scene_changed)
while cmd := input("<Enter> to exit\n"):
if not cmd:
break
main()

View File

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

View File

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

View File

@@ -1,44 +1,45 @@
import logging
import voicemeeterlib
logging.basicConfig(level=logging.INFO)
class Observer:
class App:
def __init__(self, vm):
self.vm = vm
# register your app as event observer
self.vm.subject.add(self)
# add level updates, since they are disabled by default.
self.vm.event.add("ldirty")
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, subject):
if subject == "pdirty":
def on_update(self, event):
if event == "pdirty":
print("pdirty!")
elif subject == "mdirty":
elif event == "mdirty":
print("mdirty!")
elif subject == "ldirty":
info = (
f"[{self.vm.bus[0]} {self.vm.bus[0].levels.isdirty}]",
f"[{self.vm.bus[1]} {self.vm.bus[1].levels.isdirty}]",
f"[{self.vm.bus[2]} {self.vm.bus[2].levels.isdirty}]",
f"[{self.vm.bus[3]} {self.vm.bus[3].levels.isdirty}]",
f"[{self.vm.bus[4]} {self.vm.bus[4].levels.isdirty}]",
)
print(" ".join(info))
elif subject == "midi":
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():
with voicemeeterlib.api(kind_id) as vm:
obs = Observer(vm)
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"):
if not cmd:
break
pass
if __name__ == "__main__":
kind_id = "banana"
main()

365
poetry.lock generated
View File

@@ -1,38 +1,17 @@
[[package]]
name = "atomicwrites"
version = "1.4.1"
description = "Atomic file writes."
category = "dev"
optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
[[package]]
name = "attrs"
version = "22.1.0"
description = "Classes Without Boilerplate"
category = "dev"
optional = false
python-versions = ">=3.5"
[package.extras]
dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "mypy (>=0.900,!=0.940)", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit", "cloudpickle"]
docs = ["furo", "sphinx", "zope.interface", "sphinx-notfound-page"]
tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "mypy (>=0.900,!=0.940)", "pytest-mypy-plugins", "zope.interface", "cloudpickle"]
tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "mypy (>=0.900,!=0.940)", "pytest-mypy-plugins", "cloudpickle"]
[[package]]
name = "black"
version = "22.6.0"
version = "22.12.0"
description = "The uncompromising code formatter."
category = "dev"
optional = false
python-versions = ">=3.6.2"
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)"]
@@ -40,6 +19,22 @@ 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.3.1"
description = "Extensible memoizing collections and decorators"
category = "dev"
optional = false
python-versions = ">=3.7"
[[package]]
name = "chardet"
version = "5.1.0"
description = "Universal encoding detector for Python 3"
category = "dev"
optional = false
python-versions = ">=3.7"
[[package]]
name = "click"
version = "8.1.3"
@@ -53,124 +48,147 @@ colorama = {version = "*", markers = "platform_system == \"Windows\""}
[[package]]
name = "colorama"
version = "0.4.5"
version = "0.4.6"
description = "Cross-platform colored terminal text."
category = "dev"
optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
[[package]]
name = "iniconfig"
name = "distlib"
version = "0.3.6"
description = "Distribution utilities"
category = "dev"
optional = false
python-versions = "*"
[[package]]
name = "exceptiongroup"
version = "1.1.1"
description = "iniconfig: brain-dead simple config-ini parsing"
category = "dev"
optional = false
python-versions = "*"
[[package]]
name = "isort"
version = "5.10.1"
description = "A Python utility / library to sort Python imports."
category = "dev"
optional = false
python-versions = ">=3.6.1,<4.0"
[package.extras]
pipfile_deprecated_finder = ["pipreqs", "requirementslib"]
requirements_deprecated_finder = ["pipreqs", "pip-api"]
colors = ["colorama (>=0.4.3,<0.5.0)"]
plugins = ["setuptools"]
[[package]]
name = "mypy-extensions"
version = "0.4.3"
description = "Experimental type system extensions for programs checked with the mypy typechecker."
category = "dev"
optional = false
python-versions = "*"
[[package]]
name = "packaging"
version = "21.3"
description = "Core utilities for Python packages"
category = "dev"
optional = false
python-versions = ">=3.6"
[package.dependencies]
pyparsing = ">=2.0.2,<3.0.5 || >3.0.5"
[[package]]
name = "pathspec"
version = "0.9.0"
description = "Utility library for gitignore style pattern matching of file paths."
category = "dev"
optional = false
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7"
[[package]]
name = "platformdirs"
version = "2.5.2"
description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
description = "Backport of PEP 654 (exception groups)"
category = "dev"
optional = false
python-versions = ">=3.7"
[package.extras]
docs = ["furo (>=2021.7.5b38)", "proselint (>=0.10.2)", "sphinx-autodoc-typehints (>=1.12)", "sphinx (>=4)"]
test = ["appdirs (==1.4.4)", "pytest-cov (>=2.7)", "pytest-mock (>=3.6)", "pytest (>=6)"]
test = ["pytest (>=6)"]
[[package]]
name = "filelock"
version = "3.12.2"
description = "A platform independent file lock."
category = "dev"
optional = false
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"
[[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 = "23.1"
description = "Core utilities for Python packages"
category = "dev"
optional = false
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 = "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.7"
[package.extras]
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.0.0"
version = "1.1.0"
description = "plugin and hook calling mechanisms for python"
category = "dev"
optional = false
python-versions = ">=3.6"
python-versions = ">=3.7"
[package.extras]
dev = ["pre-commit", "tox"]
testing = ["pytest", "pytest-benchmark"]
[[package]]
name = "py"
version = "1.11.0"
description = "library with cross-python path, ini-parsing, io, code, log facilities"
name = "pyproject-api"
version = "1.5.2"
description = "API to interact with the python pyproject.toml based projects"
category = "dev"
optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
python-versions = ">=3.7"
[[package]]
name = "pyparsing"
version = "3.0.9"
description = "pyparsing module - Classes and methods to define and execute parsing grammars"
category = "dev"
optional = false
python-versions = ">=3.6.8"
[package.dependencies]
packaging = ">=23.1"
tomli = {version = ">=2.0.1", markers = "python_version < \"3.11\""}
[package.extras]
diagrams = ["railroad-diagrams", "jinja2"]
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 = "7.1.2"
version = "7.3.2"
description = "pytest: simple powerful testing with Python"
category = "dev"
optional = false
python-versions = ">=3.7"
[package.dependencies]
atomicwrites = {version = ">=1.0", markers = "sys_platform == \"win32\""}
attrs = ">=19.2.0"
colorama = {version = "*", markers = "sys_platform == \"win32\""}
exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
iniconfig = "*"
packaging = "*"
pluggy = ">=0.12,<2.0"
py = ">=1.8.2"
tomli = ">=1.0.0"
tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
[package.extras]
testing = ["argcomplete", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "xmlschema"]
testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
[[package]]
name = "pytest-randomly"
@@ -198,97 +216,76 @@ pytest = ">=3.6"
name = "tomli"
version = "2.0.1"
description = "A lil' TOML parser"
category = "main"
optional = false
python-versions = ">=3.7"
[[package]]
name = "tox"
version = "4.6.3"
description = "tox is a generic virtualenv management and test command line tool"
category = "dev"
optional = false
python-versions = ">=3.7"
[package.dependencies]
cachetools = ">=5.3.1"
chardet = ">=5.1"
colorama = ">=0.4.6"
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\""}
virtualenv = ">=20.23.1"
[package.extras]
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.23.1"
description = "Virtual Python Environment builder"
category = "dev"
optional = false
python-versions = ">=3.7"
[package.dependencies]
distlib = ">=0.3.6,<1"
filelock = ">=3.12,<4"
platformdirs = ">=3.5.1,<4"
[package.extras]
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 = "1.1"
python-versions = "^3.11"
content-hash = "13366a58ff2f3fa0de2cb1e3de2f66fff612610fa66bb909201ebaa434cce014"
python-versions = "^3.10"
content-hash = "5d0edd070ea010edb4e2ade88dc37324b8b4b04f22db78e49db161185365849b"
[metadata.files]
atomicwrites = []
attrs = []
black = [
{file = "black-22.6.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:f586c26118bc6e714ec58c09df0157fe2d9ee195c764f630eb0d8e7ccce72e69"},
{file = "black-22.6.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:b270a168d69edb8b7ed32c193ef10fd27844e5c60852039599f9184460ce0807"},
{file = "black-22.6.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:6797f58943fceb1c461fb572edbe828d811e719c24e03375fd25170ada53825e"},
{file = "black-22.6.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c85928b9d5f83b23cee7d0efcb310172412fbf7cb9d9ce963bd67fd141781def"},
{file = "black-22.6.0-cp310-cp310-win_amd64.whl", hash = "sha256:f6fe02afde060bbeef044af7996f335fbe90b039ccf3f5eb8f16df8b20f77666"},
{file = "black-22.6.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:cfaf3895a9634e882bf9d2363fed5af8888802d670f58b279b0bece00e9a872d"},
{file = "black-22.6.0-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:94783f636bca89f11eb5d50437e8e17fbc6a929a628d82304c80fa9cd945f256"},
{file = "black-22.6.0-cp36-cp36m-win_amd64.whl", hash = "sha256:2ea29072e954a4d55a2ff58971b83365eba5d3d357352a07a7a4df0d95f51c78"},
{file = "black-22.6.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e439798f819d49ba1c0bd9664427a05aab79bfba777a6db94fd4e56fae0cb849"},
{file = "black-22.6.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:187d96c5e713f441a5829e77120c269b6514418f4513a390b0499b0987f2ff1c"},
{file = "black-22.6.0-cp37-cp37m-win_amd64.whl", hash = "sha256:074458dc2f6e0d3dab7928d4417bb6957bb834434516f21514138437accdbe90"},
{file = "black-22.6.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:a218d7e5856f91d20f04e931b6f16d15356db1c846ee55f01bac297a705ca24f"},
{file = "black-22.6.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:568ac3c465b1c8b34b61cd7a4e349e93f91abf0f9371eda1cf87194663ab684e"},
{file = "black-22.6.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:6c1734ab264b8f7929cef8ae5f900b85d579e6cbfde09d7387da8f04771b51c6"},
{file = "black-22.6.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c9a3ac16efe9ec7d7381ddebcc022119794872abce99475345c5a61aa18c45ad"},
{file = "black-22.6.0-cp38-cp38-win_amd64.whl", hash = "sha256:b9fd45787ba8aa3f5e0a0a98920c1012c884622c6c920dbe98dbd05bc7c70fbf"},
{file = "black-22.6.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7ba9be198ecca5031cd78745780d65a3f75a34b2ff9be5837045dce55db83d1c"},
{file = "black-22.6.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:a3db5b6409b96d9bd543323b23ef32a1a2b06416d525d27e0f67e74f1446c8f2"},
{file = "black-22.6.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:560558527e52ce8afba936fcce93a7411ab40c7d5fe8c2463e279e843c0328ee"},
{file = "black-22.6.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b154e6bbde1e79ea3260c4b40c0b7b3109ffcdf7bc4ebf8859169a6af72cd70b"},
{file = "black-22.6.0-cp39-cp39-win_amd64.whl", hash = "sha256:4af5bc0e1f96be5ae9bd7aaec219c901a94d6caa2484c21983d043371c733fc4"},
{file = "black-22.6.0-py3-none-any.whl", hash = "sha256:ac609cf8ef5e7115ddd07d85d988d074ed00e10fbc3445aee393e70164a2219c"},
{file = "black-22.6.0.tar.gz", hash = "sha256:6c6d39e28aed379aec40da1c65434c77d75e65bb59a1e1c283de545fb4e7c6c9"},
]
click = [
{file = "click-8.1.3-py3-none-any.whl", hash = "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48"},
{file = "click-8.1.3.tar.gz", hash = "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e"},
]
colorama = [
{file = "colorama-0.4.5-py2.py3-none-any.whl", hash = "sha256:854bf444933e37f5824ae7bfc1e98d5bce2ebe4160d46b5edf346a89358e99da"},
{file = "colorama-0.4.5.tar.gz", hash = "sha256:e6c6b4334fc50988a639d9b98aa429a0b57da6e17b9a44f0451f930b6967b7a4"},
]
iniconfig = [
{file = "iniconfig-1.1.1-py2.py3-none-any.whl", hash = "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3"},
{file = "iniconfig-1.1.1.tar.gz", hash = "sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32"},
]
isort = [
{file = "isort-5.10.1-py3-none-any.whl", hash = "sha256:6f62d78e2f89b4500b080fe3a81690850cd254227f27f75c3a0c491a1f351ba7"},
{file = "isort-5.10.1.tar.gz", hash = "sha256:e8443a5e7a020e9d7f97f1d7d9cd17c88bcb3bc7e218bf9cf5095fe550be2951"},
]
mypy-extensions = [
{file = "mypy_extensions-0.4.3-py2.py3-none-any.whl", hash = "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d"},
{file = "mypy_extensions-0.4.3.tar.gz", hash = "sha256:2d82818f5bb3e369420cb3c4060a7970edba416647068eb4c5343488a6c604a8"},
]
packaging = [
{file = "packaging-21.3-py3-none-any.whl", hash = "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"},
{file = "packaging-21.3.tar.gz", hash = "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb"},
]
pathspec = [
{file = "pathspec-0.9.0-py2.py3-none-any.whl", hash = "sha256:7d15c4ddb0b5c802d161efc417ec1a2558ea2653c2e8ad9c19098201dc1c993a"},
{file = "pathspec-0.9.0.tar.gz", hash = "sha256:e564499435a2673d586f6b2130bb5b95f04a3ba06f81b8f895b651a3c76aabb1"},
]
platformdirs = [
{file = "platformdirs-2.5.2-py3-none-any.whl", hash = "sha256:027d8e83a2d7de06bbac4e5ef7e023c02b863d7ea5d079477e722bb41ab25788"},
{file = "platformdirs-2.5.2.tar.gz", hash = "sha256:58c8abb07dcb441e6ee4b11d8df0ac856038f944ab98b7be6b27b2a3c7feef19"},
]
pluggy = [
{file = "pluggy-1.0.0-py2.py3-none-any.whl", hash = "sha256:74134bbf457f031a36d68416e1509f34bd5ccc019f0bcc952c7b909d06b37bd3"},
{file = "pluggy-1.0.0.tar.gz", hash = "sha256:4224373bacce55f955a878bf9cfa763c1e360858e330072059e10bad68531159"},
]
py = [
{file = "py-1.11.0-py2.py3-none-any.whl", hash = "sha256:607c53218732647dff4acdfcd50cb62615cedf612e72d1724fb1a0cc6405b378"},
{file = "py-1.11.0.tar.gz", hash = "sha256:51c75c4126074b472f746a24399ad32f6053d1b34b68d2fa41e558e6f4a98719"},
]
pyparsing = [
{file = "pyparsing-3.0.9-py3-none-any.whl", hash = "sha256:5026bae9a10eeaefb61dab2f09052b9f4307d44aee4eda64b309723d8d206bbc"},
{file = "pyparsing-3.0.9.tar.gz", hash = "sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb"},
]
pytest = [
{file = "pytest-7.1.2-py3-none-any.whl", hash = "sha256:13d0e3ccfc2b6e26be000cb6568c832ba67ba32e719443bfe725814d3c42433c"},
{file = "pytest-7.1.2.tar.gz", hash = "sha256:a06a0425453864a270bc45e71f783330a7428defb4230fb5e6a731fde06ecd45"},
]
pytest-randomly = [
{file = "pytest-randomly-3.12.0.tar.gz", hash = "sha256:d60c2db71ac319aee0fc6c4110a7597d611a8b94a5590918bfa8583f00caccb2"},
{file = "pytest_randomly-3.12.0-py3-none-any.whl", hash = "sha256:f4f2e803daf5d1ba036cc22bf4fe9dbbf99389ec56b00e5cba732fb5c1d07fdd"},
]
black = []
cachetools = []
chardet = []
click = []
colorama = []
distlib = []
exceptiongroup = []
filelock = []
iniconfig = []
isort = []
mypy-extensions = []
packaging = []
pathspec = []
platformdirs = []
pluggy = []
pyproject-api = []
pytest = []
pytest-randomly = []
pytest-repeat = []
tomli = [
{file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"},
{file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"},
]
tomli = []
tox = []
virtualenv = []

View File

@@ -1,6 +1,6 @@
[tool.poetry]
name = "voicemeeter-api"
version = "0.6.0"
version = "2.0.2"
description = "A Python wrapper for the Voiceemeter API"
authors = ["onyx-and-iris <code@onyxandiris.online>"]
license = "MIT"
@@ -12,7 +12,8 @@ packages = [
]
[tool.poetry.dependencies]
python = "^3.11"
python = "^3.10"
tomli = { version = "^2.0.1", python = "<3.11" }
[tool.poetry.dev-dependencies]
pytest = "^7.1.2"
@@ -20,7 +21,30 @@ 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>=1.0.0"]
build-backend = "poetry.core.masonry.api"
[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
[testenv]
allowlist_externals = poetry
commands =
poetry install -v
poetry run pytest tests/
"""

41
scripts.py Normal file
View File

@@ -0,0 +1,41 @@
import subprocess
from pathlib import Path
def ex_dsl():
path = Path.cwd() / "examples" / "dsl" / "."
subprocess.run(["py", str(path)])
def ex_events():
path = Path.cwd() / "examples" / "events" / "."
subprocess.run(["py", str(path)])
def ex_gui():
path = Path.cwd() / "examples" / "gui" / "."
subprocess.run(["py", str(path)])
def ex_levels():
path = Path.cwd() / "examples" / "levels" / "."
subprocess.run(["py", str(path)])
def ex_midi():
path = Path.cwd() / "examples" / "midi" / "."
subprocess.run(["py", str(path)])
def ex_obs():
path = Path.cwd() / "examples" / "obs" / "."
subprocess.run(["py", str(path)])
def ex_observer():
path = Path.cwd() / "examples" / "observer" / "."
subprocess.run(["py", str(path)])
def test():
subprocess.run(["tox"])

View File

@@ -3,15 +3,13 @@ import sys
from dataclasses import dataclass
import voicemeeterlib
from voicemeeterlib.kinds import KindId, kinds_all
from voicemeeterlib.kinds import KindId
from voicemeeterlib.kinds import request_kind_map as kindmap
# let's keep things random
kind_id = random.choice(tuple(kind_id.name.lower() for kind_id in KindId))
vmrs = {kind.name: voicemeeterlib.api(kind.name) for kind in kinds_all}
tests = vmrs[kind_id]
kind = kindmap(kind_id)
KIND_ID = random.choice(tuple(kind_id.name.lower() for kind_id in KindId))
vm = voicemeeterlib.api(KIND_ID)
kind = kindmap(KIND_ID)
@dataclass
@@ -42,9 +40,9 @@ data = Data()
def setup_module():
print(f"\nRunning tests for kind [{data.name}]\n", file=sys.stdout)
tests.login()
tests.command.reset()
vm.login()
vm.command.reset()
def teardown_module():
tests.logout()
vm.logout()

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

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

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

@@ -1,36 +1,48 @@
import time
import pytest
from tests import data, tests
from tests import data, vm
class TestUserConfigs:
__test__ = True
"""example config tests"""
"""example config vm"""
@classmethod
def setup_class(cls):
tests.apply_config("example")
vm.apply_config("example")
def test_it_tests_config_string(self):
assert "PhysStrip" in tests.strip[data.phys_in].label
assert "VirtStrip" in tests.strip[data.virt_in].label
assert "PhysBus" in tests.bus[data.phys_out].label
assert "VirtBus" in tests.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_config_bool(self):
assert tests.strip[0].A1 == True
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",
)
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",
)
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",
)
def test_it_tests_config_busmode(self):
assert tests.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_config_bass_med_high(self):
assert tests.strip[data.virt_in].bass == -3.2
assert tests.strip[data.virt_in].mid == 1.5
assert tests.strip[data.virt_in].high == 2.1
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

View File

@@ -1,6 +1,6 @@
import pytest
from tests import data, tests
from tests import data, vm
class TestRemoteFactories:
@@ -10,57 +10,57 @@ class TestRemoteFactories:
data.name != "basic",
reason="Skip test if kind is not basic",
)
def test_it_tests_remote_attrs_for_basic(self):
assert hasattr(tests, "strip")
assert hasattr(tests, "bus")
assert hasattr(tests, "command")
assert hasattr(tests, "button")
assert hasattr(tests, "vban")
assert hasattr(tests, "device")
assert hasattr(tests, "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(tests.strip) == 3
assert len(tests.bus) == 2
assert len(tests.button) == 80
assert len(tests.vban.instream) == 4 and len(tests.vban.outstream) == 4
assert len(vm.strip) == 3
assert len(vm.bus) == 2
assert len(vm.button) == 80
assert len(vm.vban.instream) == 4 and len(vm.vban.outstream) == 4
@pytest.mark.skipif(
data.name != "banana",
reason="Skip test if kind is not banana",
)
def test_it_tests_remote_attrs_for_banana(self):
assert hasattr(tests, "strip")
assert hasattr(tests, "bus")
assert hasattr(tests, "command")
assert hasattr(tests, "button")
assert hasattr(tests, "vban")
assert hasattr(tests, "device")
assert hasattr(tests, "option")
assert hasattr(tests, "recorder")
assert hasattr(tests, "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(tests.strip) == 5
assert len(tests.bus) == 5
assert len(tests.button) == 80
assert len(tests.vban.instream) == 8 and len(tests.vban.outstream) == 8
assert len(vm.strip) == 5
assert len(vm.bus) == 5
assert len(vm.button) == 80
assert len(vm.vban.instream) == 8 and len(vm.vban.outstream) == 8
@pytest.mark.skipif(
data.name != "potato",
reason="Skip test if kind is not potato",
)
def test_it_tests_remote_attrs_for_potato(self):
assert hasattr(tests, "strip")
assert hasattr(tests, "bus")
assert hasattr(tests, "command")
assert hasattr(tests, "button")
assert hasattr(tests, "vban")
assert hasattr(tests, "device")
assert hasattr(tests, "option")
assert hasattr(tests, "recorder")
assert hasattr(tests, "patch")
assert hasattr(tests, "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(tests.strip) == 8
assert len(tests.bus) == 8
assert len(tests.button) == 80
assert len(tests.vban.instream) == 8 and len(tests.vban.outstream) == 8
assert len(vm.strip) == 8
assert len(vm.bus) == 8
assert len(vm.button) == 80
assert len(vm.vban.instream) == 8 and len(vm.vban.outstream) == 8

View File

@@ -1,6 +1,6 @@
import pytest
from tests import data, tests
from tests import data, vm
@pytest.mark.parametrize("value", [False, True])
@@ -19,23 +19,54 @@ class TestSetAndGetBoolHigher:
],
)
def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
setattr(tests.strip[index], param, value)
assert getattr(tests.strip[index], param) == value
setattr(vm.strip[index], param, value)
assert getattr(vm.strip[index], param) == value
""" strip EQ tests, physical """
@pytest.mark.skipif(
data.name != "potato",
reason="Skip test if kind is not potato",
)
@pytest.mark.parametrize(
"index,param",
[
(data.phys_in, "on"),
(data.phys_in, "ab"),
],
)
def test_it_sets_and_gets_strip_eq_bool_params(self, index, param, value):
assert hasattr(vm.strip[index].eq, param)
setattr(vm.strip[index].eq, param, value)
assert getattr(vm.strip[index].eq, param) == value
""" bus tests, physical and virtual """
@pytest.mark.parametrize(
"index,param",
[
(data.phys_out, "eq"),
(data.phys_out, "mute"),
(data.virt_out, "eq_ab"),
(data.virt_out, "sel"),
],
)
def test_it_sets_and_gets_bus_bool_params(self, index, param, value):
setattr(tests.bus[index], param, value)
assert getattr(tests.bus[index], param) == value
assert hasattr(vm.bus[index], param)
setattr(vm.bus[index], param, value)
assert getattr(vm.bus[index], param) == value
""" bus EQ tests, physical and virtual """
@pytest.mark.parametrize(
"index,param",
[
(data.phys_out, "on"),
(data.virt_out, "ab"),
],
)
def test_it_sets_and_gets_bus_eq_bool_params(self, index, param, value):
assert hasattr(vm.bus[index].eq, param)
setattr(vm.bus[index].eq, param, value)
assert getattr(vm.bus[index].eq, param) == value
""" bus modes tests, physical and virtual """
@@ -53,8 +84,8 @@ class TestSetAndGetBoolHigher:
],
)
def test_it_sets_and_gets_busmode_basic_bool_params(self, index, param, value):
setattr(tests.bus[index].mode, param, value)
assert getattr(tests.bus[index].mode, param) == value
setattr(vm.bus[index].mode, param, value)
assert getattr(vm.bus[index].mode, param) == value
@pytest.mark.skipif(
data.name == "basic",
@@ -72,8 +103,8 @@ class TestSetAndGetBoolHigher:
],
)
def test_it_sets_and_gets_busmode_bool_params(self, index, param, value):
setattr(tests.bus[index].mode, param, value)
assert getattr(tests.bus[index].mode, param) == value
setattr(vm.bus[index].mode, param, value)
assert getattr(vm.bus[index].mode, param) == value
""" macrobutton tests """
@@ -82,8 +113,8 @@ class TestSetAndGetBoolHigher:
[(data.button_lower, "state"), (data.button_upper, "trigger")],
)
def test_it_sets_and_gets_macrobutton_bool_params(self, index, param, value):
setattr(tests.button[index], param, value)
assert getattr(tests.button[index], param) == value
setattr(vm.button[index], param, value)
assert getattr(vm.button[index], param) == value
""" vban instream tests """
@@ -92,8 +123,8 @@ class TestSetAndGetBoolHigher:
[(data.vban_in, "on")],
)
def test_it_sets_and_gets_vban_instream_bool_params(self, index, param, value):
setattr(tests.vban.instream[index], param, value)
assert getattr(tests.vban.instream[index], param) == value
setattr(vm.vban.instream[index], param, value)
assert getattr(vm.vban.instream[index], param) == value
""" vban outstream tests """
@@ -102,8 +133,8 @@ class TestSetAndGetBoolHigher:
[(data.vban_out, "on")],
)
def test_it_sets_and_gets_vban_outstream_bool_params(self, index, param, value):
setattr(tests.vban.outstream[index], param, value)
assert getattr(tests.vban.outstream[index], param) == value
setattr(vm.vban.outstream[index], param, value)
assert getattr(vm.vban.outstream[index], param) == value
""" command tests """
@@ -112,7 +143,7 @@ class TestSetAndGetBoolHigher:
[("lock")],
)
def test_it_sets_command_bool_params(self, param, value):
setattr(tests.command, param, value)
setattr(vm.command, param, value)
""" recorder tests """
@@ -125,8 +156,8 @@ class TestSetAndGetBoolHigher:
[("A1"), ("B2")],
)
def test_it_sets_and_gets_recorder_bool_params(self, param, value):
setattr(tests.recorder, param, value)
assert getattr(tests.recorder, param) == value
setattr(vm.recorder, param, value)
assert getattr(vm.recorder, param) == value
@pytest.mark.skipif(
data.name == "basic",
@@ -137,7 +168,7 @@ class TestSetAndGetBoolHigher:
[("loop")],
)
def test_it_sets_recorder_bool_params(self, param, value):
setattr(tests.recorder, param, value)
setattr(vm.recorder, param, value)
""" fx tests """
@@ -150,8 +181,8 @@ class TestSetAndGetBoolHigher:
[("reverb"), ("reverb_ab"), ("delay"), ("delay_ab")],
)
def test_it_sets_and_gets_fx_bool_params(self, param, value):
setattr(tests.fx, param, value)
assert getattr(tests.fx, param) == value
setattr(vm.fx, param, value)
assert getattr(vm.fx, param) == value
""" patch tests """
@@ -164,8 +195,8 @@ class TestSetAndGetBoolHigher:
[("postfadercomposite")],
)
def test_it_sets_and_gets_patch_bool_params(self, param, value):
setattr(tests.patch, param, value)
assert getattr(tests.patch, param) == value
setattr(vm.patch, param, value)
assert getattr(vm.patch, param) == value
""" patch.insert tests """
@@ -178,8 +209,8 @@ class TestSetAndGetBoolHigher:
[(data.insert_lower, "on"), (data.insert_higher, "on")],
)
def test_it_sets_and_gets_patch_insert_bool_params(self, index, param, value):
setattr(tests.patch.insert[index], param, value)
assert getattr(tests.patch.insert[index], param) == value
setattr(vm.patch.insert[index], param, value)
assert getattr(vm.patch.insert[index], param) == value
""" option tests """
@@ -188,8 +219,8 @@ class TestSetAndGetBoolHigher:
[("monitoronsel")],
)
def test_it_sets_and_gets_option_bool_params(self, param, value):
setattr(tests.option, param, value)
assert getattr(tests.option, param) == value
setattr(vm.option, param, value)
assert getattr(vm.option, param) == value
class TestSetAndGetIntHigher:
@@ -207,8 +238,8 @@ class TestSetAndGetIntHigher:
],
)
def test_it_sets_and_gets_strip_bool_params(self, index, param, value):
setattr(tests.strip[index], param, value)
assert getattr(tests.strip[index], param) == value
setattr(vm.strip[index], param, value)
assert getattr(vm.strip[index], param) == value
""" vban outstream tests """
@@ -217,8 +248,8 @@ class TestSetAndGetIntHigher:
[(data.vban_out, "sr", 48000)],
)
def test_it_sets_and_gets_vban_outstream_bool_params(self, index, param, value):
setattr(tests.vban.outstream[index], param, value)
assert getattr(tests.vban.outstream[index], param) == value
setattr(vm.vban.outstream[index], param, value)
assert getattr(vm.vban.outstream[index], param) == value
""" patch.asio tests """
@@ -234,8 +265,8 @@ class TestSetAndGetIntHigher:
],
)
def test_it_sets_and_gets_patch_asio_in_int_params(self, index, value):
tests.patch.asio[index].set(value)
assert tests.patch.asio[index].get() == value
vm.patch.asio[index].set(value)
assert vm.patch.asio[index].get() == value
""" patch.A2[i]-A5[i] tests """
@@ -251,10 +282,10 @@ class TestSetAndGetIntHigher:
],
)
def test_it_sets_and_gets_patch_asio_out_int_params(self, index, value):
tests.patch.A2[index].set(value)
assert tests.patch.A2[index].get() == value
tests.patch.A5[index].set(value)
assert tests.patch.A5[index].get() == value
vm.patch.A2[index].set(value)
assert vm.patch.A2[index].get() == value
vm.patch.A5[index].set(value)
assert vm.patch.A5[index].get() == value
""" patch.composite tests """
@@ -272,8 +303,8 @@ class TestSetAndGetIntHigher:
],
)
def test_it_sets_and_gets_patch_composite_int_params(self, index, value):
tests.patch.composite[index].set(value)
assert tests.patch.composite[index].get() == value
vm.patch.composite[index].set(value)
assert vm.patch.composite[index].get() == value
""" option tests """
@@ -289,8 +320,8 @@ class TestSetAndGetIntHigher:
],
)
def test_it_sets_and_gets_patch_delay_int_params(self, index, value):
tests.option.delay[index].set(value)
assert tests.option.delay[index].get() == value
vm.option.delay[index].set(value)
assert vm.option.delay[index].get() == value
class TestSetAndGetFloatHigher:
@@ -303,29 +334,25 @@ class TestSetAndGetFloatHigher:
[
(data.phys_in, "gain", -3.6),
(data.virt_in, "gain", 5.8),
(data.phys_in, "comp", 0.0),
(data.virt_in, "comp", 8.2),
(data.phys_in, "gate", 2.3),
(data.virt_in, "gate", 6.7),
],
)
def test_it_sets_and_gets_strip_float_params(self, index, param, value):
setattr(tests.strip[index], param, value)
assert getattr(tests.strip[index], param) == value
setattr(vm.strip[index], param, value)
assert getattr(vm.strip[index], param) == value
@pytest.mark.parametrize(
"index,value",
[(data.phys_in, 2), (data.phys_in, 2), (data.virt_in, 8), (data.virt_in, 8)],
)
def test_it_gets_prefader_levels_and_compares_length_of_array(self, index, value):
assert len(tests.strip[index].levels.prefader) == value
assert len(vm.strip[index].levels.prefader) == value
@pytest.mark.parametrize(
"index,value",
[(data.phys_in, 2), (data.phys_in, 2), (data.virt_in, 8), (data.virt_in, 8)],
)
def test_it_gets_postmute_levels_and_compares_length_of_array(self, index, value):
assert len(tests.strip[index].levels.postmute) == value
assert len(vm.strip[index].levels.postmute) == value
@pytest.mark.skipif(
data.name != "potato",
@@ -341,8 +368,8 @@ class TestSetAndGetFloatHigher:
],
)
def test_it_sets_and_gets_strip_gainlayer_values(self, index, j, value):
tests.strip[index].gainlayer[j].gain = value
assert tests.strip[index].gainlayer[j].gain == value
vm.strip[index].gainlayer[j].gain = value
assert vm.strip[index].gainlayer[j].gain == value
""" strip tests, physical """
@@ -356,9 +383,9 @@ class TestSetAndGetFloatHigher:
],
)
def test_it_sets_and_gets_strip_xy_params(self, index, param, value):
assert hasattr(tests.strip[index], param)
setattr(tests.strip[index], param, value)
assert getattr(tests.strip[index], param) == value
assert hasattr(vm.strip[index], param)
setattr(vm.strip[index], param, value)
assert getattr(vm.strip[index], param) == value
@pytest.mark.skipif(
data.name != "potato",
@@ -372,23 +399,71 @@ class TestSetAndGetFloatHigher:
],
)
def test_it_sets_and_gets_strip_effects_params(self, index, param, value):
assert hasattr(tests.strip[index], param)
setattr(tests.strip[index], param, value)
assert getattr(tests.strip[index], param) == value
assert hasattr(vm.strip[index], param)
setattr(vm.strip[index], param, value)
assert getattr(vm.strip[index], param) == value
@pytest.mark.skipif(
data.name != "potato",
reason="Only test if logged into Potato version",
)
@pytest.mark.parametrize(
"index, param, value",
[
(data.phys_in, "gainin", -8.6),
(data.phys_in, "knee", 0.5),
],
)
def test_it_sets_and_gets_strip_comp_params(self, index, param, value):
assert hasattr(vm.strip[index].comp, param)
setattr(vm.strip[index].comp, param, value)
assert getattr(vm.strip[index].comp, param) == value
@pytest.mark.skipif(
data.name != "potato",
reason="Only test if logged into Potato version",
)
@pytest.mark.parametrize(
"index, param, value",
[
(data.phys_in, "bpsidechain", 120),
(data.phys_in, "hold", 3000),
],
)
def test_it_sets_and_gets_strip_gate_params(self, index, param, value):
assert hasattr(vm.strip[index].gate, param)
setattr(vm.strip[index].gate, param, value)
assert getattr(vm.strip[index].gate, param) == value
@pytest.mark.skipif(
data.name != "potato",
reason="Only test if logged into Potato version",
)
@pytest.mark.parametrize(
"index, param, value",
[
(data.phys_in, "knob", -8.6),
],
)
def test_it_sets_and_gets_strip_denoiser_params(self, index, param, value):
setattr(vm.strip[index].denoiser, param, value)
assert getattr(vm.strip[index].denoiser, param) == value
""" strip tests, virtual """
@pytest.mark.parametrize(
"index, param, value",
[
(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):
setattr(tests.strip[index], param, value)
assert getattr(tests.strip[index], param) == value
setattr(vm.strip[index], param, value)
assert getattr(vm.strip[index], param) == value
""" bus tests, physical and virtual """
@@ -401,24 +476,24 @@ class TestSetAndGetFloatHigher:
[(data.phys_out, "returnreverb", 3.6), (data.virt_out, "returnfx1", 5.8)],
)
def test_it_sets_and_gets_bus_effects_float_params(self, index, param, value):
assert hasattr(tests.bus[index], param)
setattr(tests.bus[index], param, value)
assert getattr(tests.bus[index], param) == value
assert hasattr(vm.bus[index], param)
setattr(vm.bus[index], param, value)
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)],
)
def test_it_sets_and_gets_bus_float_params(self, index, param, value):
setattr(tests.bus[index], param, value)
assert getattr(tests.bus[index], param) == value
setattr(vm.bus[index], param, value)
assert getattr(vm.bus[index], param) == value
@pytest.mark.parametrize(
"index,value",
[(data.phys_out, 8), (data.virt_out, 8)],
)
def test_it_gets_prefader_levels_and_compares_length_of_array(self, index, value):
assert len(tests.bus[index].levels.all) == value
assert len(vm.bus[index].levels.all) == value
@pytest.mark.parametrize("value", ["test0", "test1"])
@@ -432,8 +507,8 @@ class TestSetAndGetStringHigher:
[(data.phys_in, "label"), (data.virt_in, "label")],
)
def test_it_sets_and_gets_strip_string_params(self, index, param, value):
setattr(tests.strip[index], param, value)
assert getattr(tests.strip[index], param) == value
setattr(vm.strip[index], param, value)
assert getattr(vm.strip[index], param) == value
""" bus tests, physical and virtual """
@@ -442,8 +517,8 @@ class TestSetAndGetStringHigher:
[(data.phys_out, "label"), (data.virt_out, "label")],
)
def test_it_sets_and_gets_bus_string_params(self, index, param, value):
setattr(tests.bus[index], param, value)
assert getattr(tests.bus[index], param) == value
setattr(vm.bus[index], param, value)
assert getattr(vm.bus[index], param) == value
""" vban instream tests """
@@ -452,8 +527,8 @@ class TestSetAndGetStringHigher:
[(data.vban_in, "name")],
)
def test_it_sets_and_gets_vban_instream_string_params(self, index, param, value):
setattr(tests.vban.instream[index], param, value)
assert getattr(tests.vban.instream[index], param) == value
setattr(vm.vban.instream[index], param, value)
assert getattr(vm.vban.instream[index], param) == value
""" vban outstream tests """
@@ -462,8 +537,8 @@ class TestSetAndGetStringHigher:
[(data.vban_out, "name")],
)
def test_it_sets_and_gets_vban_outstream_string_params(self, index, param, value):
setattr(tests.vban.outstream[index], param, value)
assert getattr(tests.vban.outstream[index], param) == value
setattr(vm.vban.outstream[index], param, value)
assert getattr(vm.vban.outstream[index], param) == value
@pytest.mark.parametrize("value", [False, True])
@@ -484,5 +559,5 @@ class TestSetAndGetMacroButtonHigher:
],
)
def test_it_sets_and_gets_macrobutton_params(self, index, param, value):
setattr(tests.button[index], param, value)
assert getattr(tests.button[index], param) == value
setattr(vm.button[index], param, value)
assert getattr(vm.button[index], param) == value

View File

@@ -1,6 +1,6 @@
import pytest
from tests import data, tests
from tests import data, vm
class TestSetAndGetFloatLower:
@@ -18,8 +18,8 @@ class TestSetAndGetFloatLower:
],
)
def test_it_sets_and_gets_mute_eq_float_params(self, param, value):
tests.set(param, value)
assert (round(tests.get(param))) == value
vm.set(param, value)
assert (round(vm.get(param))) == value
@pytest.mark.parametrize(
"param,value",
@@ -30,8 +30,8 @@ class TestSetAndGetFloatLower:
],
)
def test_it_sets_and_gets_comp_gain_float_params(self, param, value):
tests.set(param, value)
assert (round(tests.get(param), 1)) == value
vm.set(param, value)
assert (round(vm.get(param), 1)) == value
@pytest.mark.parametrize("value", ["test0", "test1"])
@@ -45,12 +45,14 @@ class TestSetAndGetStringLower:
[(f"Strip[{data.phys_out}].label"), (f"Bus[{data.virt_out}].label")],
)
def test_it_sets_and_gets_string_params(self, param, value):
tests.set(param, value)
assert tests.get(param, string=True) == value
vm.set(param, value)
assert vm.get(param, string=True) == value
@pytest.mark.parametrize("value", [0, 1])
class TestMacroButtonsLower:
__test__ = True
"""VBVMR_MacroButton_SetStatus, VBVMR_MacroButton_GetStatus"""
@pytest.mark.parametrize(
@@ -58,21 +60,21 @@ class TestMacroButtonsLower:
[(33, 1), (49, 1)],
)
def test_it_sets_and_gets_macrobuttons_state(self, index, mode, value):
tests.set_buttonstatus(index, value, mode)
assert tests.get_buttonstatus(index, mode) == value
vm.set_buttonstatus(index, value, mode)
assert vm.get_buttonstatus(index, mode) == value
@pytest.mark.parametrize(
"index, mode",
[(14, 2), (12, 2)],
)
def test_it_sets_and_gets_macrobuttons_stateonly(self, index, mode, value):
tests.set_buttonstatus(index, value, mode)
assert tests.get_buttonstatus(index, mode) == value
vm.set_buttonstatus(index, value, mode)
assert vm.get_buttonstatus(index, mode) == value
@pytest.mark.parametrize(
"index, mode",
[(50, 3), (65, 3)],
)
def test_it_sets_and_gets_macrobuttons_trigger(self, index, mode, value):
tests.set_buttonstatus(index, value, mode)
assert tests.get_buttonstatus(index, mode) == value
vm.set_buttonstatus(index, value, mode)
assert vm.get_buttonstatus(index, mode) == value

View File

@@ -4,10 +4,9 @@ from enum import IntEnum
from math import log
from typing import Union
from .error import VMError
from .iremote import IRemote
from .kinds import kinds_all
from .meta import bool_prop, bus_mode_prop, float_prop
from .meta import bus_mode_prop, device_prop, float_prop
BusModes = IntEnum(
"BusModes",
@@ -47,22 +46,6 @@ class Bus(IRemote):
def mono(self, val: bool):
self.setter("mono", 1 if val else 0)
@property
def eq(self) -> bool:
return self.getter("eq.On") == 1
@eq.setter
def eq(self, val: bool):
self.setter("eq.On", 1 if val else 0)
@property
def eq_ab(self) -> bool:
return self.getter("eq.ab") == 1
@eq_ab.setter
def eq_ab(self, val: bool):
self.setter("eq.ab", 1 if val else 0)
@property
def sel(self) -> bool:
return self.getter("sel") == 1
@@ -104,9 +87,31 @@ class Bus(IRemote):
time.sleep(self._remote.DELAY)
class BusEQ(IRemote):
@property
def identifier(self) -> str:
return f"Bus[{self.index}].eq"
@property
def on(self) -> bool:
return self.getter("on") == 1
@on.setter
def on(self, val: bool):
self.setter("on", 1 if val else 0)
@property
def ab(self) -> bool:
return self.getter("ab") == 1
@ab.setter
def ab(self, val: bool):
self.setter("ab", 1 if val else 0)
class PhysicalBus(Bus):
@classmethod
def make(cls, kind):
def make(cls, remote, i, kind):
"""
Factory method for PhysicalBus.
@@ -116,18 +121,54 @@ class PhysicalBus(Bus):
if kind.name == "potato":
EFFECTS_cls = _make_effects_mixin()
kls += (EFFECTS_cls,)
return type("PhysicalBus", kls, {})
return type(
"PhysicalBus",
kls,
{
"device": BusDevice.make(remote, i),
},
)
def __str__(self):
return f"{type(self).__name__}{self.index}"
class BusDevice(IRemote):
@classmethod
def make(cls, remote, i):
"""
Factory function for bus.device.
Returns a BusDevice class of a kind.
"""
DEVICE_cls = type(
f"BusDevice{remote.kind}",
(cls,),
{
**{
param: device_prop(param)
for param in [
"wdm",
"ks",
"mme",
"asio",
]
},
},
)
return DEVICE_cls(remote, i)
@property
def device(self) -> str:
return self.getter("device.name", is_string=True)
def identifier(self) -> str:
return f"Bus[{self.index}].device"
@property
def name(self) -> str:
return self.getter("name", is_string=True)
@property
def sr(self) -> int:
return int(self.getter("device.sr"))
return int(self.getter("sr"))
class VirtualBus(Bus):
@@ -263,7 +304,9 @@ def bus_factory(is_phys_bus, remote, i) -> Union[PhysicalBus, VirtualBus]:
Returns a physical or virtual bus subclass
"""
BUS_cls = (
PhysicalBus.make(remote.kind) if is_phys_bus else VirtualBus.make(remote.kind)
PhysicalBus.make(remote, i, remote.kind)
if is_phys_bus
else VirtualBus.make(remote.kind)
)
BUSMODEMIXIN_cls = _make_bus_mode_mixin()
return type(
@@ -272,6 +315,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),
},
)(remote, i)

View File

@@ -1,10 +1,13 @@
import ctypes as ct
import logging
from abc import ABCMeta
from ctypes.wintypes import CHAR, FLOAT, LONG, WCHAR
from .error import CAPIError
from .inst import libc
logger = logging.getLogger(__name__)
class CBindings(metaclass=ABCMeta):
"""
@@ -13,6 +16,8 @@ class CBindings(metaclass=ABCMeta):
Maps expected ctype argument and res types for each binding.
"""
logger_cbindings = logger.getChild("Cbindings")
vm_login = libc.VBVMR_Login
vm_login.restype = LONG
vm_login.argtypes = None
@@ -33,14 +38,17 @@ class CBindings(metaclass=ABCMeta):
vm_get_version.restype = LONG
vm_get_version.argtypes = [ct.POINTER(LONG)]
if hasattr(libc, "VBVMR_MacroButton_IsDirty"):
vm_mdirty = libc.VBVMR_MacroButton_IsDirty
vm_mdirty.restype = LONG
vm_mdirty.argtypes = None
if hasattr(libc, "VBVMR_MacroButton_GetStatus"):
vm_get_buttonstatus = libc.VBVMR_MacroButton_GetStatus
vm_get_buttonstatus.restype = LONG
vm_get_buttonstatus.argtypes = [LONG, ct.POINTER(FLOAT), LONG]
if hasattr(libc, "VBVMR_MacroButton_SetStatus"):
vm_set_buttonstatus = libc.VBVMR_MacroButton_SetStatus
vm_set_buttonstatus.restype = LONG
vm_set_buttonstatus.argtypes = [LONG, FLOAT, LONG]
@@ -103,7 +111,15 @@ class CBindings(metaclass=ABCMeta):
vm_get_midi_message.restype = LONG
vm_get_midi_message.argtypes = [ct.POINTER(CHAR * 1024), LONG]
def call(self, func):
res = func()
if res != 0:
raise CAPIError(f"Function {func.func.__name__} returned {res}")
def call(self, func, *args, ok=(0,), ok_exp=None):
try:
res = func(*args)
if ok_exp is None:
if res not in ok:
raise CAPIError(f"{func.__name__} returned {res}")
elif not ok_exp(res):
raise CAPIError(f"{func.__name__} returned {res}")
return res
except CAPIError as e:
self.logger_cbindings.exception(f"{type(e).__name__}: {e}")
raise

View File

@@ -1,6 +1,5 @@
from .error import VMError
from .iremote import IRemote
from .meta import action_prop
from .meta import action_fn
class Command(IRemote):
@@ -22,10 +21,9 @@ class Command(IRemote):
(cls,),
{
**{
param: action_prop(param)
for param in ["show", "shutdown", "restart"]
param: action_fn(param) for param in ["show", "shutdown", "restart"]
},
"hide": action_prop("show", val=0),
"hide": action_fn("show", val=0),
},
)
return CMD_cls(remote)

View File

@@ -1,10 +1,18 @@
import itertools
import logging
from pathlib import Path
import tomllib
from .error import VMError
try:
import tomllib
except ModuleNotFoundError:
import tomli as tomllib
from .kinds import request_kind_map as kindmap
logger = logging.getLogger(__name__)
class TOMLStrBuilder:
"""builds a config profile, as a string, for the toml parser"""
@@ -28,10 +36,17 @@ class TOMLStrBuilder:
+ [f"B{i} = false" for i in range(1, self.kind.virt_out + 1)]
)
self.phys_strip_params = self.virt_strip_params + [
"comp = 0.0",
"gate = 0.0",
"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",
]
self.bus_bool = ["mono = false", "eq = false", "mute = false"]
if profile == "reset":
self.reset_config()
@@ -62,7 +77,7 @@ class TOMLStrBuilder:
else self.virt_strip_params
)
case "bus":
toml_str += ("\n").join(self.bus_bool)
toml_str += ("\n").join(self.bus_params)
case _:
pass
return toml_str + "\n"
@@ -70,7 +85,6 @@ class TOMLStrBuilder:
class TOMLDataExtractor:
def __init__(self, file):
self._data = dict()
with open(file, "rb") as f:
self._data = tomllib.load(f)
@@ -118,6 +132,7 @@ class Loader(metaclass=SingletonType):
def __init__(self, kind):
self._kind = kind
self.logger = logger.getChild(self.__class__.__name__)
self._configs = dict()
self.defaults(kind)
self.parser = None
@@ -129,14 +144,16 @@ class Loader(metaclass=SingletonType):
def parse(self, identifier, data):
if identifier in self._configs:
print(f"config file with name {identifier} already in memory, skipping..")
self.logger.info(
f"config file with name {identifier} already in memory, skipping.."
)
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
print(f"config {self.name}/{identifier} loaded into memory")
self.logger.info(f"config {self.name}/{identifier} loaded into memory")
def deregister(self):
self._configs.clear()
@@ -159,15 +176,16 @@ def loader(kind):
returns configs loaded into memory
"""
logger_loader = logger.getChild("loader")
loader = Loader(kind)
for path in (
Path.cwd() / "configs" / kind.name,
Path(__file__).parent / "configs" / kind.name,
Path.home() / "Documents/Voicemeeter" / "configs" / kind.name,
Path.home() / ".config" / "voicemeeter" / kind.name,
Path.home() / "Documents" / "Voicemeeter" / "configs" / kind.name,
):
if path.is_dir():
print(f"Checking [{path}] for TOML config files:")
logger_loader.info(f"Checking [{path}] for TOML config files:")
for file in path.glob("*.toml"):
identifier = file.with_suffix("").stem
if loader.parse(identifier, file):
@@ -184,5 +202,5 @@ def request_config(kind_id: str):
try:
configs = loader(kindmap(kind_id))
except KeyError as e:
print(f"Unknown Voicemeeter kind '{kind_id}'")
raise VMError(f"Unknown Voicemeeter kind {kind_id}") from e
return configs

View File

@@ -1,16 +1,10 @@
class InstallError(Exception):
"""errors related to installation"""
pass
"""Exception raised when installation errors occur"""
class CAPIError(Exception):
"""errors related to low-level C API calls"""
pass
"""Exception raised when the C-API returns error values"""
class VMError(Exception):
"""general errors"""
pass
"""Exception raised when general errors occur"""

74
voicemeeterlib/event.py Normal file
View File

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

View File

@@ -1,21 +1,25 @@
import logging
from abc import abstractmethod
from enum import IntEnum
from functools import cached_property
from typing import Iterable, NoReturn, Self
from typing import Iterable, NoReturn
from . import misc
from .base import Remote
from .bus import request_bus_obj as bus
from .command import Command
from .config import request_config as configs
from .device import Device
from .error import VMError
from .kinds import KindMapClass
from .kinds import request_kind_map as kindmap
from .macrobutton import MacroButton
from .recorder import Recorder
from .remote import Remote
from .strip import request_strip_obj as strip
from .vban import request_vban_obj as vban
logger = logging.getLogger(__name__)
class FactoryBuilder:
"""
@@ -45,55 +49,56 @@ class FactoryBuilder:
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) -> NoReturn:
"""prints progress status for each step"""
name = name.split("_")[1]
print(self._info[int(getattr(self.BuilderProgress, name))])
self.logger.debug(self._info[int(getattr(self.BuilderProgress, name))])
def make_strip(self) -> Self:
def make_strip(self):
self._factory.strip = tuple(
strip(i < self.kind.phys_in, self._factory, i)
for i in range(self.kind.num_strip)
)
return self
def make_bus(self) -> Self:
def make_bus(self):
self._factory.bus = tuple(
bus(i < self.kind.phys_out, self._factory, i)
for i in range(self.kind.num_bus)
)
return self
def make_command(self) -> Self:
def make_command(self):
self._factory.command = Command.make(self._factory)
return self
def make_macrobutton(self) -> Self:
def make_macrobutton(self):
self._factory.button = tuple(MacroButton(self._factory, i) for i in range(80))
return self
def make_vban(self) -> Self:
def make_vban(self):
self._factory.vban = vban(self._factory)
return self
def make_device(self) -> Self:
def make_device(self):
self._factory.device = Device.make(self._factory)
return self
def make_option(self) -> Self:
def make_option(self):
self._factory.option = misc.Option.make(self._factory)
return self
def make_recorder(self) -> Self:
def make_recorder(self):
self._factory.recorder = Recorder.make(self._factory)
return self
def make_patch(self) -> Self:
def make_patch(self):
self._factory.patch = misc.Patch.make(self._factory)
return self
def make_fx(self) -> Self:
def make_fx(self):
self._factory.fx = misc.FX(self._factory)
return self
@@ -102,10 +107,16 @@ class FactoryBase(Remote):
"""Base class for factories, subclasses Remote."""
def __init__(self, kind_id: str, **kwargs):
defaultevents = {"pdirty": True, "mdirty": True, "midi": True, "ldirty": False}
defaultkwargs = {
"sync": False,
"ratelimit": 0.033,
"pdirty": False,
"mdirty": False,
"midi": False,
"ldirty": False,
}
if "subs" in kwargs:
defaultevents = defaultevents | kwargs.pop("subs")
defaultkwargs = {"sync": False, "ratelimit": 0.033, "subs": defaultevents}
defaultkwargs |= kwargs.pop("subs") # for backwards compatibility
kwargs = defaultkwargs | kwargs
self.kind = kindmap(kind_id)
super().__init__(**kwargs)
@@ -229,9 +240,13 @@ def request_remote_obj(kind_id: str, **kwargs) -> Remote:
Returns a reference to a Remote class of a kind
"""
logger_entry = logger.getChild("request_remote_obj")
REMOTE_obj = None
try:
REMOTE_obj = remote_factory(kind_id, **kwargs)
except (ValueError, TypeError) as e:
raise SystemExit(e)
logger_entry.exception(f"{type(e).__name__}: {e}")
raise VMError(str(e)) from e
return REMOTE_obj

View File

@@ -25,17 +25,19 @@ def get_vmpath():
with winreg.OpenKey(
winreg.HKEY_LOCAL_MACHINE, r"{}".format(REG_KEY + "\\" + VM_KEY)
) as vm_key:
path = winreg.QueryValueEx(vm_key, r"UninstallString")[0]
return path
return winreg.QueryValueEx(vm_key, r"UninstallString")[0]
vm_path = Path(get_vmpath())
try:
vm_path = Path(get_vmpath())
except FileNotFoundError as 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_path = vm_parent.joinpath(DLL_NAME)
if not dll_path.is_file():
raise InstallError(f"Could not find {DLL_NAME}")
raise InstallError(f"Could not find {dll_path}")
libc = ct.CDLL(str(dll_path))

View File

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

View File

@@ -1,6 +1,8 @@
from dataclasses import dataclass
from enum import Enum, unique
from .error import VMError
@unique
class KindId(Enum):
@@ -105,7 +107,7 @@ def request_kind_map(kind_id):
try:
KIND_obj = kind_factory(kind_id)
except ValueError as e:
print(e)
raise VMError(str(e)) from e
return KIND_obj

View File

@@ -1,4 +1,3 @@
from .error import VMError
from .iremote import IRemote

View File

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

View File

@@ -252,43 +252,17 @@ class Midi:
self.cache[key] = velocity
class Event:
def __init__(self, subs: dict):
self.subs = subs
def info(self, msg):
info = (
f"{msg} events",
f"Now listening for {', '.join(self.get())} events",
)
print("\n".join(info))
class VmGui:
_launched = None
@property
def pdirty(self):
return self.subs["pdirty"]
def launched(self) -> bool:
return self._launched
@launched.setter
def launched(self, val: bool):
self._launched = val
@property
def mdirty(self):
return self.subs["mdirty"]
@property
def midi(self):
return self.subs["midi"]
@property
def ldirty(self):
return self.subs["ldirty"]
def get(self) -> list:
return [k for k, v in self.subs.items() if v]
def any(self) -> bool:
return any(self.subs.values())
def add(self, event):
self.subs[event] = True
self.info(f"{event} added to")
def remove(self, event):
self.subs[event] = False
self.info(f"{event} removed from")
def launched_by_api(self):
return not self.launched

View File

@@ -1,7 +1,7 @@
from .error import VMError
from .iremote import IRemote
from .kinds import kinds_all
from .meta import action_prop, bool_prop
from .meta import action_fn, bool_prop
class Recorder(IRemote):
@@ -24,7 +24,7 @@ class Recorder(IRemote):
(cls, CHANNELOUTMIXIN_cls),
{
**{
param: action_prop(param)
param: action_fn(param)
for param in [
"play",
"stop",

View File

@@ -1,17 +1,21 @@
import ctypes as ct
import logging
import time
from abc import abstractmethod
from functools import partial
from threading import Thread
from typing import Iterable, NoReturn, Optional, Self, Union
from queue import Queue
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 .kinds import KindId
from .misc import Event, Midi
from .misc import Midi, VmGui
from .subject import Subject
from .util import comp, grouper, polling, script
from .updater import Producer, Updater
from .util import grouper, polling, script
logger = logging.getLogger(__name__)
class Remote(CBindings):
@@ -22,19 +26,22 @@ class Remote(CBindings):
def __init__(self, **kwargs):
self.strip_mode = 0
self.cache = {}
self.cache["strip_level"], self.cache["bus_level"] = self._get_levels()
self.midi = Midi()
self.subject = Subject()
self.running = None
self.subject = self.observer = Subject()
self.running = False
self.event = Event(
{k: kwargs.pop(k) for k in ("pdirty", "mdirty", "midi", "ldirty")}
)
self.gui = VmGui()
self.logger = logger.getChild(self.__class__.__name__)
for attr, val in kwargs.items():
setattr(self, attr, val)
self.event = Event(self.subs)
def __enter__(self) -> Self:
def __enter__(self):
"""setup procedures"""
self.login()
if self.event.any():
self.init_thread()
return self
@@ -46,46 +53,24 @@ class Remote(CBindings):
def init_thread(self):
"""Starts updates thread."""
self.running = True
print(f"Listening for {', '.join(self.event.get())} events")
t = Thread(target=self._updates, daemon=True)
t.start()
self.event.info()
def _updates(self):
"""
Continously update observers of dirty states.
Generate _strip_comp, _bus_comp and update level cache if ldirty.
Runs updates at a rate of self.ratelimit.
"""
while self.running:
if self.event.pdirty and self.pdirty:
self.subject.notify("pdirty")
if self.event.mdirty and self.mdirty:
self.subject.notify("mdirty")
if self.event.midi and self.get_midi_message():
self.subject.notify("midi")
if self.event.ldirty and self.ldirty:
self._strip_comp, self._bus_comp = (
tuple(
not x for x in comp(self.cache["strip_level"], self._strip_buf)
),
tuple(not x for x in comp(self.cache["bus_level"], self._bus_buf)),
)
self.cache["strip_level"] = self._strip_buf
self.cache["bus_level"] = self._bus_buf
self.subject.notify("ldirty")
time.sleep(self.ratelimit if self.event.any() else 0.5)
self.logger.debug("initiating events thread")
queue = Queue()
self.updater = Updater(self, queue)
self.updater.start()
self.producer = Producer(self, queue)
self.producer.start()
def login(self) -> NoReturn:
"""Login to the API, initialize dirty parameters"""
res = self.vm_login()
if res == 1:
self.gui.launched = self.call(self.vm_login, ok=(0, 1)) == 0
if not self.gui.launched:
self.logger.info(
"Voicemeeter engine running but GUI not launched. Launching the GUI now."
)
self.run_voicemeeter(self.kind.name)
elif res != 0:
raise CAPIError(f"VBVMR_Login returned {res}")
print(f"Successfully logged into {self}")
self.logger.info(f"{type(self).__name__}: Successfully logged into {self}")
self.clear_dirty()
def run_voicemeeter(self, kind_id: str) -> NoReturn:
@@ -95,21 +80,21 @@ class Remote(CBindings):
value = KindId[kind_id.upper()].value + 3
else:
value = KindId[kind_id.upper()].value
self.vm_runvm(value)
self.call(self.vm_runvm, value)
time.sleep(1)
@property
def type(self) -> str:
"""Returns the type of Voicemeeter installation (basic, banana, potato)."""
type_ = ct.c_long()
self.vm_get_type(ct.byref(type_))
self.call(self.vm_get_type, ct.byref(type_))
return KindId(type_.value).name.lower()
@property
def version(self) -> str:
"""Returns Voicemeeter's version as a string"""
ver = ct.c_long()
self.vm_get_version(ct.byref(ver))
self.call(self.vm_get_version, ct.byref(ver))
return "{}.{}.{}.{}".format(
(ver.value & 0xFF000000) >> 24,
(ver.value & 0x00FF0000) >> 16,
@@ -120,12 +105,18 @@ class Remote(CBindings):
@property
def pdirty(self) -> bool:
"""True iff UI parameters have been updated."""
return self.vm_pdirty() == 1
return self.call(self.vm_pdirty, ok=(0, 1)) == 1
@property
def mdirty(self) -> bool:
"""True iff MB parameters have been updated."""
return self.vm_mdirty() == 1
try:
return self.call(self.vm_mdirty, ok=(0, 1)) == 1
except AttributeError as e:
self.logger.exception(f"{type(e).__name__}: {e}")
raise CAPIError(
"no bind for VBVMR_MacroButton_IsDirty. are you using an old version of the API?"
) from e
@property
def ldirty(self) -> bool:
@@ -136,23 +127,24 @@ class Remote(CBindings):
and self.cache.get("bus_level") == self._bus_buf
)
def clear_dirty(self):
def clear_dirty(self) -> NoReturn:
try:
while self.pdirty or self.mdirty:
pass
except CAPIError:
self.logger.error("no bind for mdirty, clearing pdirty only")
while self.pdirty:
pass
@polling
def get(self, param: str, is_string: Optional[bool] = False) -> Union[str, float]:
"""Gets a string or float parameter"""
if is_string:
buf = ct.create_unicode_buffer(512)
self.call(
partial(self.vm_get_parameter_string, param.encode(), ct.byref(buf))
)
self.call(self.vm_get_parameter_string, param.encode(), ct.byref(buf))
else:
buf = ct.c_float()
self.call(
partial(self.vm_get_parameter_float, param.encode(), ct.byref(buf))
)
self.call(self.vm_get_parameter_float, param.encode(), ct.byref(buf))
return buf.value
def set(self, param: str, val: Union[str, float]) -> NoReturn:
@@ -160,37 +152,41 @@ class Remote(CBindings):
if isinstance(val, str):
if len(val) >= 512:
raise VMError("String is too long")
self.call(
partial(self.vm_set_parameter_string, param.encode(), ct.c_wchar_p(val))
)
self.call(self.vm_set_parameter_string, param.encode(), ct.c_wchar_p(val))
else:
self.call(
partial(
self.vm_set_parameter_float, param.encode(), ct.c_float(float(val))
)
)
self.cache[param] = val
@polling
def get_buttonstatus(self, id: int, mode: int) -> int:
"""Gets a macrobutton parameter"""
state = ct.c_float()
try:
self.call(
partial(
self.vm_get_buttonstatus,
ct.c_long(id),
ct.byref(state),
ct.c_long(mode),
)
)
except AttributeError as e:
self.logger.exception(f"{type(e).__name__}: {e}")
raise CAPIError(
"no bind for VBVMR_MacroButton_GetStatus. are you using an old version of the API?"
) from e
return int(state.value)
def set_buttonstatus(self, id: int, state: int, mode: int) -> NoReturn:
"""Sets a macrobutton parameter. Caches value"""
c_state = ct.c_float(float(state))
self.call(
partial(self.vm_set_buttonstatus, ct.c_long(id), c_state, ct.c_long(mode))
)
try:
self.call(self.vm_set_buttonstatus, ct.c_long(id), c_state, ct.c_long(mode))
except AttributeError as e:
self.logger.exception(f"{type(e).__name__}: {e}")
raise CAPIError(
"no bind for VBVMR_MacroButton_SetStatus. are you using an old version of the API?"
) from e
self.cache[f"mb_{id}_{mode}"] = int(c_state.value)
def get_num_devices(self, direction: str = None) -> int:
@@ -198,7 +194,8 @@ class Remote(CBindings):
if direction not in ("in", "out"):
raise VMError("Expected a direction: in or out")
func = getattr(self, f"vm_get_num_{direction}devices")
return func()
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"""
@@ -208,7 +205,8 @@ class Remote(CBindings):
name = ct.create_unicode_buffer(256)
hwid = ct.create_unicode_buffer(256)
func = getattr(self, f"vm_get_desc_{direction}devices")
func(
self.call(
func,
ct.c_long(index),
ct.byref(type_),
ct.byref(name),
@@ -219,7 +217,7 @@ class Remote(CBindings):
def get_level(self, type_: int, index: int) -> float:
"""Retrieves a single level value"""
val = ct.c_float()
self.vm_get_level(ct.c_long(type_), ct.c_long(index), ct.byref(val))
self.call(self.vm_get_level, ct.c_long(type_), ct.c_long(index), ct.byref(val))
return val.value
def _get_levels(self) -> Iterable:
@@ -240,9 +238,11 @@ class Remote(CBindings):
def get_midi_message(self):
n = ct.c_long(1024)
buf = ct.create_string_buffer(1024)
res = self.vm_get_midi_message(ct.byref(buf), n)
res = self.vm_get_midi_message(ct.byref(buf), n, ok_exp=lambda r: r >= 0)
if res > 0:
vals = tuple(grouper(3, (int.from_bytes(buf[i]) for i in range(res))))
vals = tuple(
grouper(3, (int.from_bytes(buf[i], "little") for i in range(res)))
)
for msg in vals:
ch, pitch, vel = msg
if not self.midi._channel or self.midi._channel != ch:
@@ -250,15 +250,13 @@ class Remote(CBindings):
self.midi._most_recent = pitch
self.midi._set(pitch, vel)
return True
elif res == -1 or res == -2:
raise CAPIError(f"VBVMR_GetMidiMessage returned {res}")
@script
def sendtext(self, script: str):
"""Sets many parameters from a script"""
if len(script) > 48000:
raise ValueError("Script too large, max size 48kB")
self.call(partial(self.vm_set_parameter_multi, script.encode()))
self.call(self.vm_set_parameter_multi, script.encode())
time.sleep(self.DELAY * 5)
def apply(self, data: dict):
@@ -287,20 +285,19 @@ class Remote(CBindings):
)
try:
self.apply(self.configs[name])
print(f"Profile '{name}' applied!")
except KeyError as e:
print(("\n").join(error_msg))
self.logger.info(f"Profile '{name}' applied!")
except KeyError:
self.logger.error(("\n").join(error_msg))
def logout(self) -> NoReturn:
"""Wait for dirty parameters to clear, then logout of the API"""
self.clear_dirty()
time.sleep(0.1)
res = self.vm_logout()
if res != 0:
raise CAPIError(f"VBVMR_Logout returned {res}")
print(f"Successfully logged out of {self}")
self.call(self.vm_logout)
self.logger.info(f"{type(self).__name__}: Successfully logged out of {self}")
def end_thread(self):
self.logger.debug("events thread shutdown started")
self.running = False
def __exit__(self, exc_type, exc_value, exc_traceback) -> NoReturn:

View File

@@ -5,7 +5,7 @@ from typing import Union
from .iremote import IRemote
from .kinds import kinds_all
from .meta import bool_prop, float_prop
from .meta import bool_prop, device_prop, float_prop
class Strip(IRemote):
@@ -82,34 +82,28 @@ class Strip(IRemote):
class PhysicalStrip(Strip):
@classmethod
def make(cls, kind):
def make(cls, remote, i, is_phys):
"""
Factory method for PhysicalStrip.
Returns a PhysicalStrip class.
"""
EFFECTS_cls = _make_effects_mixins[kind.name]
return type(f"PhysicalStrip", (cls, EFFECTS_cls), {})
EFFECTS_cls = _make_effects_mixins(is_phys)[remote.kind.name]
return type(
f"PhysicalStrip",
(cls, EFFECTS_cls),
{
"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}"
@property
def comp(self) -> float:
return round(self.getter("Comp"), 1)
@comp.setter
def comp(self, val: float):
self.setter("Comp", val)
@property
def gate(self) -> float:
return round(self.getter("Gate"), 1)
@gate.setter
def gate(self, val: float):
self.setter("Gate", val)
@property
def audibility(self) -> float:
return round(self.getter("audibility"), 1)
@@ -118,16 +112,236 @@ class PhysicalStrip(Strip):
def audibility(self, val: float):
self.setter("audibility", val)
class StripComp(IRemote):
@property
def device(self):
return self.getter("device.name", is_string=True)
def identifier(self) -> str:
return f"Strip[{self.index}].comp"
@property
def sr(self):
return int(self.getter("device.sr"))
def knob(self) -> float:
return round(self.getter(""), 1)
@knob.setter
def knob(self, val: float):
self.setter("", val)
@property
def gainin(self) -> float:
return round(self.getter("GainIn"), 1)
@gainin.setter
def gainin(self, val: float):
self.setter("GainIn", val)
@property
def ratio(self) -> float:
return round(self.getter("Ratio"), 1)
@ratio.setter
def ratio(self, val: float):
self.setter("Ratio", val)
@property
def threshold(self) -> float:
return round(self.getter("Threshold"), 1)
@threshold.setter
def threshold(self, val: float):
self.setter("Threshold", val)
@property
def attack(self) -> float:
return round(self.getter("Attack"), 1)
@attack.setter
def attack(self, val: float):
self.setter("Attack", val)
@property
def release(self) -> float:
return round(self.getter("Release"), 1)
@release.setter
def release(self, val: float):
self.setter("Release", val)
@property
def knee(self) -> float:
return round(self.getter("Knee"), 1)
@knee.setter
def knee(self, val: float):
self.setter("Knee", val)
@property
def gainout(self) -> float:
return round(self.getter("GainOut"), 1)
@gainout.setter
def gainout(self, val: float):
self.setter("GainOut", val)
@property
def makeup(self) -> bool:
return self.getter("makeup") == 1
@makeup.setter
def makeup(self, val: bool):
self.setter("makeup", 1 if val else 0)
class StripGate(IRemote):
@property
def identifier(self) -> str:
return f"Strip[{self.index}].gate"
@property
def knob(self) -> float:
return round(self.getter(""), 1)
@knob.setter
def knob(self, val: float):
self.setter("", val)
@property
def threshold(self) -> float:
return round(self.getter("Threshold"), 1)
@threshold.setter
def threshold(self, val: float):
self.setter("Threshold", val)
@property
def damping(self) -> float:
return round(self.getter("Damping"), 1)
@damping.setter
def damping(self, val: float):
self.setter("Damping", val)
@property
def bpsidechain(self) -> int:
return int(self.getter("BPSidechain"))
@bpsidechain.setter
def bpsidechain(self, val: int):
self.setter("BPSidechain", val)
@property
def attack(self) -> float:
return round(self.getter("Attack"), 1)
@attack.setter
def attack(self, val: float):
self.setter("Attack", val)
@property
def hold(self) -> float:
return round(self.getter("Hold"), 1)
@hold.setter
def hold(self, val: float):
self.setter("Hold", val)
@property
def release(self) -> float:
return round(self.getter("Release"), 1)
@release.setter
def release(self, val: float):
self.setter("Release", val)
class StripDenoiser(IRemote):
@property
def identifier(self) -> str:
return f"Strip[{self.index}].denoiser"
@property
def knob(self) -> float:
return round(self.getter(""), 1)
@knob.setter
def knob(self, val: float):
self.setter("", val)
class StripEQ(IRemote):
@property
def identifier(self) -> str:
return f"Strip[{self.index}].eq"
@property
def on(self) -> bool:
return self.getter("on") == 1
@on.setter
def on(self, val: bool):
self.setter("on", 1 if val else 0)
@property
def ab(self) -> bool:
return self.getter("ab") == 1
@ab.setter
def ab(self, val: bool):
self.setter("ab", 1 if val else 0)
class StripDevice(IRemote):
@classmethod
def make(cls, remote, i):
"""
Factory function for strip.device.
Returns a StripDevice class of a kind.
"""
DEVICE_cls = type(
f"StripDevice{remote.kind}",
(cls,),
{
**{
param: device_prop(param)
for param in [
"wdm",
"ks",
"mme",
"asio",
]
},
},
)
return DEVICE_cls(remote, i)
@property
def identifier(self) -> str:
return f"Strip[{self.index}].device"
@property
def name(self) -> str:
return self.getter("name", is_string=True)
@property
def sr(self) -> int:
return int(self.getter("sr"))
class VirtualStrip(Strip):
@classmethod
def make(cls, remote, i, is_phys):
"""
Factory method for VirtualStrip.
Returns a VirtualStrip class.
"""
EFFECTS_cls = _make_effects_mixins(is_phys)[remote.kind.name]
return type(
f"VirtualStrip",
(cls, EFFECTS_cls),
{},
)
def __str__(self):
return f"{type(self).__name__}{self.index}"
@@ -304,36 +518,38 @@ _make_channelout_mixins = {
}
def _make_effects_mixin(kind):
def _make_effects_mixin(kind, is_phys):
"""creates an effects mixin for a kind"""
XY_cls = type(
"XY",
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"]}
if is_phys:
return type(
"XYPhys",
(),
{
param: float_prop(param)
for param in [
"pan_x",
"pan_y",
"color_x",
"color_y",
"fx_x",
"fx_y",
]
**pan,
**color,
**fx,
},
)
return type(
"XYVirt",
(),
{**pan},
)
FX_cls = type(
def _make_fx_cls():
if is_phys:
return type(
"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}")
@@ -341,13 +557,19 @@ def _make_effects_mixin(kind):
},
},
)
return type("FX", (), {})
if kind.name == "potato":
return type(f"Effects{kind}", (XY_cls, FX_cls), {})
return type(f"Effects{kind}", (XY_cls,), {})
if kind.name == "basic":
steps = (_make_xy_cls,)
elif kind.name == "banana":
steps = (_make_xy_cls,)
elif kind.name == "potato":
steps = (_make_xy_cls, _make_fx_cls)
return type(f"Effects{kind}", tuple(step() for step in steps), {})
_make_effects_mixins = {kind.name: _make_effects_mixin(kind) for kind in kinds_all}
def _make_effects_mixins(is_phys):
return {kind.name: _make_effects_mixin(kind, is_phys) for kind in kinds_all}
def strip_factory(is_phys_strip, remote, i) -> Union[PhysicalStrip, VirtualStrip]:
@@ -358,7 +580,11 @@ def strip_factory(is_phys_strip, remote, i) -> Union[PhysicalStrip, VirtualStrip
Returns a physical or virtual strip subclass
"""
STRIP_cls = PhysicalStrip.make(remote.kind) if is_phys_strip else VirtualStrip
STRIP_cls = (
PhysicalStrip.make(remote, i, is_phys_strip)
if is_phys_strip
else VirtualStrip.make(remote, i, is_phys_strip)
)
CHANNELOUTMIXIN_cls = _make_channelout_mixins[remote.kind.name]
_kls = (STRIP_cls, CHANNELOUTMIXIN_cls)

View File

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

77
voicemeeterlib/updater.py Normal file
View File

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