initial commit

initial commit

voicemeeterlib/vban.py

@@ -0,0 +1,188 @@
+from abc import abstractmethod
+
+from .error import VMError
+from .iremote import IRemote
+
+
+class VbanStream(IRemote):
+    """
+    Implements the common interface
+
+    Defines concrete implementation for vban stream
+    """
+
+    @abstractmethod
+    def __str__(self):
+        pass
+
+    @property
+    def identifier(self) -> str:
+        return f"vban.{self.direction}stream[{self.index}]"
+
+    @property
+    def on(self) -> bool:
+        return self.getter("on") == 1
+
+    @on.setter
+    def on(self, val: bool):
+        if not isinstance(val, bool) and val not in (0, 1):
+            raise VMError("True or False expected")
+        self.setter("on", 1 if val else 0)
+
+    @property
+    def name(self) -> str:
+        return self.getter("name", is_string=True)
+
+    @name.setter
+    def name(self, val: str):
+        self.setter("name", val)
+
+    @property
+    def ip(self) -> str:
+        return self.getter("ip", is_string=True)
+
+    @ip.setter
+    def ip(self, val: str):
+        self.setter("ip", val)
+
+    @property
+    def port(self) -> int:
+        return int(self.getter("port"))
+
+    @port.setter
+    def port(self, val: int):
+        if val not in range(1024, 65536):
+            raise VMError("Expected value from 1024 to 65535")
+        self.setter("port", val)
+
+    @property
+    def sr(self) -> int:
+        return int(self.getter("sr"))
+
+    @sr.setter
+    def sr(self, val: int):
+        opts = (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
+        if val not in opts:
+            raise VMError("Expected one of: {opts}")
+        self.setter("sr", val)
+
+    @property
+    def channel(self) -> int:
+        return int(self.getter("channel"))
+
+    @channel.setter
+    def channel(self, val: int):
+        if val not in range(1, 9):
+            raise VMError("Expected value from 1 to 8")
+        self.setter("channel", val)
+
+    @property
+    def bit(self) -> int:
+        return 16 if (int(self.getter("bit") == 1)) else 24
+
+    @bit.setter
+    def bit(self, val: int):
+        if val not in (16, 24):
+            raise VMError("Expected value 16 or 24")
+        self.setter("bit", 1 if (val == 16) else 2)
+
+    @property
+    def quality(self) -> int:
+        return int(self.getter("quality"))
+
+    @quality.setter
+    def quality(self, val: int):
+        if val not in range(5):
+            raise VMError("Expected value from 0 to 4")
+        self.setter("quality", val)
+
+    @property
+    def route(self) -> int:
+        return int(self.getter("route"))
+
+    @route.setter
+    def route(self, val: int):
+        if val not in range(9):
+            raise VMError("Expected value from 0 to 8")
+        self.setter("route", val)
+
+
+class VbanInstream(VbanStream):
+    """
+    class representing a vban instream
+
+    subclasses VbanStream
+    """
+
+    def __str__(self):
+        return f"{type(self).__name__}{self._remote.kind}{self.index}"
+
+    @property
+    def direction(self) -> str:
+        return "in"
+
+    @property
+    def sr(self) -> int:
+        return super(VbanInstream, self).sr
+
+    @property
+    def channel(self) -> int:
+        return super(VbanInstream, self).channel
+
+    @property
+    def bit(self) -> int:
+        return super(VbanInstream, self).bit
+
+
+class VbanOutstream(VbanStream):
+    """
+    class representing a vban outstream
+
+    Subclasses VbanStream
+    """
+
+    def __str__(self):
+        return f"{type(self).__name__}{self._remote.kind}{self.index}"
+
+    @property
+    def direction(self) -> str:
+        return "out"
+
+
+class Vban:
+    """
+    class representing the vban module
+
+    Contains two tuples, one for each stream type
+    """
+
+    def __init__(self, remote):
+        self.remote = remote
+        num_instream, num_outstream = remote.kind.vban
+        self.instream = tuple(VbanInstream(remote, i) for i in range(num_instream))
+        self.outstream = tuple(VbanOutstream(remote, i) for i in range(num_outstream))
+
+    def enable(self):
+        self.remote.set("vban.Enable", 1)
+
+    def disable(self):
+        self.remote.set("vban.Enable", 0)
+
+
+def vban_factory(remote) -> Vban:
+    """
+    Factory method for vban
+
+    Returns a class that represents the VBAN module.
+    """
+    VBAN_cls = Vban
+    return type(f"{VBAN_cls.__name__}", (VBAN_cls,), {})(remote)
+
+
+def request_vban_obj(remote) -> Vban:
+    """
+    Vban entry point.
+
+    Returns a reference to a Vban class of a kind
+    """
+    return vban_factory(remote)