add button color example to readme

README.md

@@ -380,12 +380,13 @@ The following properties are available.
 -   `state`: boolean
 -   `stateonly`: boolean
 -   `trigger`: boolean
+-   `color`: int, from 0 to 8
 
 example:
 
 ```python
 vm.button[37].state = True
-vm.button[55].trigger = False
+vm.button[4].color = 1
 ```
 
 ### Recorder

examples/events/__main__.py

@@ -1,5 +1,7 @@
+import json
 import logging
 import time
+from logging import config
 
 import voicemeeterlib
 

examples/midi/__main__.py

@@ -14,20 +14,19 @@ class App:
         self.vm.observer.add(self.on_midi)
 
     def on_midi(self):
-        if self.get_info() == self.MIDI_BUTTON:
-            self.on_midi_press()
+        self.get_info()
+        self.on_midi_press()
 
     def get_info(self):
         current = self.vm.midi.current
         print(f"Value of midi button {current} is {self.vm.midi.get(current)}")
-        return current
 
     def on_midi_press(self):
-        """if midi button 48 is pressed and strip 3 level max > -40, then set trigger for macrobutton 0"""
+        """if strip 3 level max > -40 and midi button 48 is pressed, then set trigger for macrobutton 0"""
 
         if (
-            self.vm.midi.get(self.MIDI_BUTTON) == 127
-            and max(self.vm.strip[3].levels.postfader) > -40
+            max(self.vm.strip[3].levels.postfader) > -40
+            and self.vm.midi.get(self.MIDI_BUTTON) == 127
         ):
             print(
                 f"Strip 3 level max is greater than -40 and midi button {self.MIDI_BUTTON} is pressed"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "voicemeeter-api"
-version = "2.4.4"
+version = "2.3.6"
 description = "A Python wrapper for the Voiceemeter API"
 authors = ["onyx-and-iris <code@onyxandiris.online>"]
 license = "MIT"

voicemeeterlib/bus.py

@@ -210,7 +210,7 @@ class BusLevel(IRemote):
         def fget(x):
             return round(20 * log(x, 10), 1) if x > 0 else -200.0
 
-        if not self._remote.stopped() and self._remote.event.ldirty:
+        if self._remote.running and self._remote.event.ldirty:
             vals = self._remote.cache["bus_level"][self.range[0] : self.range[-1]]
         else:
             vals = [self._remote.get_level(mode, i) for i in range(*self.range)]
@@ -232,7 +232,7 @@ class BusLevel(IRemote):
 
         Expected to be used in a callback only.
         """
-        if not self._remote.stopped():
+        if self._remote.running:
             return any(self._remote._bus_comp[self.range[0] : self.range[-1]])
 
     is_updated = isdirty

voicemeeterlib/config.py

@@ -147,13 +147,8 @@ class Loader(metaclass=SingletonType):
             self.logger.info(
                 f"config file with name {identifier} already in memory, skipping.."
             )
-            return
-        try:
-            self.parser = dataextraction_factory(data)
-        except tomllib.TOMLDecodeError as e:
-            ERR_MSG = (str(e), f"When attempting to load {identifier}.toml")
-            self.logger.error(f"{type(e).__name__}: {' '.join(ERR_MSG)}")
-            return
+            return False
+        self.parser = dataextraction_factory(data)
         return True
 
     def register(self, identifier, data=None):

voicemeeterlib/device.py

@@ -23,6 +23,7 @@ class Adapter(IRemote):
     def output(self):
         pass
 
+    @property
     def identifier(self):
         pass
 

voicemeeterlib/error.py

@@ -1,22 +1,19 @@
-class VMError(Exception):
-    """Base VM Exception class. Raised when general errors occur."""
+class InstallError(Exception):
+    """Exception raised when installation errors occur"""
 
-    def __init__(self, msg):
-        self.message = msg
+
+class CAPIError(Exception):
+    """Exception raised when the C-API returns error values"""
+
+    def __init__(self, fn_name, code, msg=None):
+        self.fn_name = fn_name
+        self.code = code
+        self.message = msg if msg else f"{fn_name} returned {code}"
         super().__init__(self.message)
 
     def __str__(self):
         return f"{type(self).__name__}: {self.message}"
 
 
-class InstallError(VMError):
-    """Exception raised when installation errors occur"""
-
-
-class CAPIError(VMError):
-    """Exception raised when the C-API returns an error code"""
-
-    def __init__(self, fn_name, code, msg=None):
-        self.fn_name = fn_name
-        self.code = code
-        super(CAPIError, self).__init__(msg if msg else f"{fn_name} returned {code}")
+class VMError(Exception):
+    """Exception raised when general errors occur"""

voicemeeterlib/factory.py

@@ -2,7 +2,7 @@ import logging
 from abc import abstractmethod
 from enum import IntEnum
 from functools import cached_property
-from typing import Iterable
+from typing import Iterable, NoReturn
 
 from . import misc
 from .bus import request_bus_obj as bus
@@ -51,7 +51,7 @@ class FactoryBuilder:
         )
         self.logger = logger.getChild(self.__class__.__name__)
 
-    def _pinfo(self, name: str) -> None:
+    def _pinfo(self, name: str) -> NoReturn:
         """prints progress status for each step"""
         name = name.split("_")[1]
         self.logger.debug(self._info[int(getattr(self.BuilderProgress, name))])

voicemeeterlib/iremote.py

@@ -33,6 +33,7 @@ class IRemote(metaclass=ABCMeta):
             cmd += (f".{param}",)
         return "".join(cmd)
 
+    @property
     @abstractmethod
     def identifier(self):
         pass

voicemeeterlib/macrobutton.py

@@ -12,9 +12,6 @@ ButtonModes = IntEnum(
 class Adapter(IRemote):
     """Adapter to the common interface."""
 
-    def identifier(self):
-        pass
-
     def getter(self, mode):
         self.logger.debug(f"getter: button[{self.index}].{ButtonModes(mode).name}")
         return self._remote.get_buttonstatus(self.index, mode)
@@ -26,7 +23,21 @@ class Adapter(IRemote):
         self._remote.set_buttonstatus(self.index, val, mode)
 
 
-class MacroButton(Adapter):
+class MacroButtonColorMixin(IRemote):
+    @property
+    def identifier(self):
+        return f"command.button[{self.index}]"
+
+    @property
+    def color(self) -> int:
+        return int(IRemote.getter(self, "color"))
+
+    @color.setter
+    def color(self, val: int):
+        IRemote.setter(self, "color", val)
+
+
+class MacroButton(Adapter, MacroButtonColorMixin):
     """Defines concrete implementation for macrobutton"""
 
     def __str__(self):

voicemeeterlib/remote.py

@@ -1,10 +1,9 @@
 import ctypes as ct
 import logging
-import threading
 import time
 from abc import abstractmethod
 from queue import Queue
-from typing import Iterable, Optional, Union
+from typing import Iterable, NoReturn, Optional, Union
 
 from .cbindings import CBindings
 from .error import CAPIError, VMError
@@ -29,11 +28,11 @@ class Remote(CBindings):
         self.cache = {}
         self.midi = Midi()
         self.subject = self.observer = Subject()
+        self.running = False
         self.event = Event(
             {k: kwargs.pop(k) for k in ("pdirty", "mdirty", "midi", "ldirty")}
         )
         self.gui = VmGui()
-        self.stop_event = None
         self.logger = logger.getChild(self.__class__.__name__)
 
         for attr, val in kwargs.items():
@@ -53,21 +52,17 @@ class Remote(CBindings):
 
     def init_thread(self):
         """Starts updates thread."""
+        self.running = True
         self.event.info()
 
         self.logger.debug("initiating events thread")
-        self.stop_event = threading.Event()
-        self.stop_event.clear()
         queue = Queue()
         self.updater = Updater(self, queue)
         self.updater.start()
-        self.producer = Producer(self, queue, self.stop_event)
+        self.producer = Producer(self, queue)
         self.producer.start()
 
-    def stopped(self):
-        return self.stop_event is None or self.stop_event.is_set()
-
-    def login(self) -> None:
+    def login(self) -> NoReturn:
         """Login to the API, initialize dirty parameters"""
         self.gui.launched = self.call(self.bind_login, ok=(0, 1)) == 0
         if not self.gui.launched:
@@ -80,7 +75,7 @@ class Remote(CBindings):
         )
         self.clear_dirty()
 
-    def run_voicemeeter(self, kind_id: str) -> None:
+    def run_voicemeeter(self, kind_id: str) -> NoReturn:
         if kind_id not in (kind.name.lower() for kind in KindId):
             raise VMError(f"Unexpected Voicemeeter type: '{kind_id}'")
         if kind_id == "potato" and bits == 8:
@@ -138,7 +133,7 @@ class Remote(CBindings):
             and self.cache.get("bus_level") == self._bus_buf
         )
 
-    def clear_dirty(self) -> None:
+    def clear_dirty(self) -> NoReturn:
         try:
             while self.pdirty or self.mdirty:
                 pass
@@ -160,7 +155,7 @@ class Remote(CBindings):
             self.call(self.bind_get_parameter_float, param.encode(), ct.byref(buf))
         return buf.value
 
-    def set(self, param: str, val: Union[str, float]) -> None:
+    def set(self, param: str, val: Union[str, float]) -> NoReturn:
         """Sets a string or float parameter. Caches value"""
         if isinstance(val, str):
             if len(val) >= 512:
@@ -196,7 +191,7 @@ class Remote(CBindings):
             ) from e
         return int(c_state.value)
 
-    def set_buttonstatus(self, id_: int, val: int, mode: int) -> None:
+    def set_buttonstatus(self, id_: int, val: int, mode: int) -> NoReturn:
         """Sets a macrobutton parameter. Caches value"""
         c_state = ct.c_float(float(val))
         try:
@@ -336,18 +331,16 @@ class Remote(CBindings):
         self.logger.info(f"Profile '{name}' applied!")
 
     def end_thread(self):
-        if not self.stopped():
-            self.logger.debug("events thread shutdown started")
-            self.stop_event.set()
-            self.producer.join()  # wait for producer thread to complete cycle
+        self.logger.debug("events thread shutdown started")
+        self.running = False
 
-    def logout(self) -> None:
+    def logout(self) -> NoReturn:
         """Logout of the API"""
         time.sleep(0.1)
         self.call(self.bind_logout)
         self.logger.info(f"{type(self).__name__}: Successfully logged out of {self}")
 
-    def __exit__(self, exc_type, exc_value, exc_traceback) -> None:
+    def __exit__(self, exc_type, exc_value, exc_traceback) -> NoReturn:
         """teardown procedures"""
         self.end_thread()
         self.logout()

voicemeeterlib/strip.py

@@ -415,7 +415,7 @@ class StripLevel(IRemote):
         def fget(x):
             return round(20 * log(x, 10), 1) if x > 0 else -200.0
 
-        if not self._remote.stopped() and self._remote.event.ldirty:
+        if self._remote.running and self._remote.event.ldirty:
             vals = self._remote.cache["strip_level"][self.range[0] : self.range[-1]]
         else:
             vals = [self._remote.get_level(mode, i) for i in range(*self.range)]
@@ -448,7 +448,7 @@ class StripLevel(IRemote):
 
         Expected to be used in a callback only.
         """
-        if not self._remote.stopped():
+        if self._remote.running:
             return any(self._remote._strip_comp[self.range[0] : self.range[-1]])
 
     is_updated = isdirty

voicemeeterlib/updater.py

@@ -10,18 +10,14 @@ logger = logging.getLogger(__name__)
 class Producer(threading.Thread):
     """Continously send job queue to the Updater thread at a rate of self._remote.ratelimit."""
 
-    def __init__(self, remote, queue, stop_event):
-        super().__init__(name="producer", daemon=False)
+    def __init__(self, remote, queue):
+        super().__init__(name="producer", daemon=True)
         self._remote = remote
         self.queue = queue
-        self.stop_event = stop_event
         self.logger = logger.getChild(self.__class__.__name__)
 
-    def stopped(self):
-        return self.stop_event.is_set()
-
     def run(self):
-        while not self.stopped():
+        while self._remote.running:
             if self._remote.event.pdirty:
                 self.queue.put("pdirty")
             if self._remote.event.mdirty:
@@ -60,7 +56,12 @@ class Updater(threading.Thread):
 
         Generate _strip_comp, _bus_comp and update level cache if ldirty.
         """
-        while event := self.queue.get():
+        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:
@@ -72,4 +73,3 @@ class Updater(threading.Thread):
                 self._remote.cache["strip_level"] = self._remote._strip_buf
                 self._remote.cache["bus_level"] = self._remote._bus_buf
                 self._remote.subject.notify(event)
-        self.logger.debug(f"terminating {self.name} thread")

voicemeeterlib/vban.py

@@ -172,24 +172,32 @@ class VbanMidiOutstream(VbanOutstream):
 def _make_stream_pair(remote, kind):
     num_instream, num_outstream, num_midi, num_text = kind.vban
 
-    def _make_cls(i, dir):
-        match dir:
-            case "in":
-                if i < num_instream:
-                    return VbanAudioInstream(remote, i)
-                elif i < num_instream + num_midi:
-                    return VbanMidiInstream(remote, i)
-                else:
-                    return VbanTextInstream(remote, i)
-            case "out":
-                if i < num_outstream:
-                    return VbanAudioOutstream(remote, i)
-                else:
-                    return VbanMidiOutstream(remote, i)
+    def _generate_streams(i, dir):
+        """generator function for instream/outstream types"""
+        if dir == "in":
+            if i < num_instream:
+                yield VbanAudioInstream
+            elif i < num_instream + num_midi:
+                yield VbanMidiInstream
+            else:
+                yield VbanTextInstream
+        else:
+            if i < num_outstream:
+                yield VbanAudioOutstream
+            else:
+                yield VbanMidiOutstream
 
     return (
-        tuple(_make_cls(i, "in") for i in range(num_instream + num_midi + num_text)),
-        tuple(_make_cls(i, "out") for i in range(num_outstream + num_midi)),
+        tuple(
+            cls(remote, i)
+            for i in range(num_instream + num_midi + num_text)
+            for cls in _generate_streams(i, "in")
+        ),
+        tuple(
+            cls(remote, i)
+            for i in range(num_outstream + num_midi)
+            for cls in _generate_streams(i, "out")
+        ),
     )