userconfigs now returns target.configs

patch bump

.gitignore

@@ -1,5 +1,5 @@
 # quick test
-z_*.py
+quick.py
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -131,3 +131,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+.vscode/

CHANGELOG.md

@@ -7,7 +7,54 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
--   [ ] Add support for forest theme (should be coming soon)
+-   [ ] Add support for forest theme (if rbende adds it to pypi)
+
+## [1.8.0] - 2023-06-29
+
+### Added
+
+-   Ability to toggle the navigation frame. This may also be set in app.toml, check example config.
+
+### Changed
+
+-   xpadding added to channel labelframes. This may also be configured through app.toml.
+-   During startup of the app there is now a twelve second grace period before parameter updates begin if the GUI was not previously launched. This is aimed at removing the stutter (due to VM engine startup) on initial launch. Be mindful of this if changing settings on the base Voicemeeter app. After the grace period all updates continue as normal.
+
+-   dependency updates:
+    -   sv_ttk updated to v2.5.1.
+    -   voicemeeter-api updated to v2.0.2.
+
+## [1.7.0] - 2023-06-26
+
+### Changed
+
+-   There are changes to how some parameters must be set in user toml configs.
+    -   use `comp.knob` to set a strip comp slider.
+    -   use `gate.knob` to set a strip gate slider.
+    -   use `eq.on` to set a bus eq.on button.
+    -   use `eq.ab` to set a bus eq.ab button.
+
+Check example configs.
+
+-   `configs` directory may now be located in one of the following locations:
+    -   \<current working directory>/configs/
+    -   \<user home directory>/.configs/vm-compact/configs/
+    -   \<user home directory>/Documents/Voicemeeter/configs/
+
+-   dependency updates:
+    -   sv_ttk updated to v2.4.5.
+    -   voicemeeter-api updated to v2.0.1.
+    -   vban-cmd updated to v2.0.0.
+
+### Fixed
+
+-   A number of changes that reduce the amount of api calls being made.
+
+## [1.6.0] - 2022-09-29
+
+### Added
+
+-   Logging module used in place of print statements across the interface.
 
 ## [1.5.1] - 2022-09-16
 
@@ -20,8 +67,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   sv_ttk updated to v2.0.
 -   event toggles used to pause updates when dragging sliders.
 
-### Removed
-
 ## [1.4.2] - 2022-09-03
 
 ### Added

configs/app.toml

@@ -3,19 +3,23 @@
 # config="example"
 # load with themes enabled? set the default mode
 [theme]
-enabled=true
-mode="light"
+enabled = true
+mode = "light"
 # load in extended mode? if so which orientation
 [extends]
-extended=true
-extends_horizontal=true
+extended = true
+extends_horizontal = true
 # default dimensions for channel label frames
 [channel]
-width=80
-height=130
+width = 80
+height = 130
+xpadding = 2
 # size of a single mouse wheel scroll step
 [mwscroll_step]
-size=3
+size = 3
 # default submix bus
 [submixes]
-default=0
+default = 0
+# show the navigation frame?
+[navigation]
+show = true

configs/banana/example.toml

@@ -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.on = true
 mode = "composite"
 
 [bus-3]
 label = "VirtBus0"
-eq_ab = true
+eq.ab = true
 mode = "upmix61"
 
 [bus-4]

configs/potato/example.toml

@@ -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"
@@ -50,7 +50,7 @@ mono = true
 
 [bus-2]
 label = "PhysBus2"
-eq = true
+eq.on = true
 
 [bus-3]
 label = "PhysBus3"
@@ -62,7 +62,7 @@ mode = "composite"
 
 [bus-5]
 label = "VirtBus0"
-eq_ab = true
+eq.ab = true
 
 [bus-6]
 label = "VirtBus1"

configs/vban.toml

@@ -4,10 +4,10 @@
 # kind = 'banana'
 # ip = '<ip address 1>'
 # streamname = 'Command1'
-# port = 6990
+# port = 6980
 
 # [connection-2]
 # kind = 'potato'
 # ip = '<ip address 2>'
 # streamname = 'Command1'
-# port = 6990
+# port = 6980

poetry.lock

@@ -1,10 +1,10 @@
 [[package]]
 name = "black"
-version = "22.8.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"
@@ -32,23 +32,37 @@ 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 = "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 = "0.4.3"
-description = "Experimental type system extensions for programs checked with the mypy typechecker."
+version = "1.0.0"
+description = "Type system extensions for programs checked with the mypy type checker."
 category = "dev"
 optional = false
-python-versions = "*"
+python-versions = ">=3.5"
 
 [[package]]
 name = "pathspec"
-version = "0.10.1"
+version = "0.11.1"
 description = "Utility library for gitignore style pattern matching of file paths."
 category = "dev"
 optional = false
@@ -56,23 +70,23 @@ python-versions = ">=3.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\"."
+version = "3.8.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 (>=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)"]
+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 = "sv-ttk"
-version = "2.0"
-description = "A gorgeous theme for Tkinter that looks like Windows 11"
+version = "2.5.1"
+description = "A gorgeous theme for Tkinter, based on Windows 11's UI"
 category = "main"
 optional = false
-python-versions = ">=3.4"
+python-versions = ">=3.7"
 
 [[package]]
 name = "tomli"
@@ -84,7 +98,7 @@ python-versions = ">=3.7"
 
 [[package]]
 name = "vban-cmd"
-version = "1.4.4"
+version = "2.0.0"
 description = "Python interface for the VBAN RT Packet Service (Sendtext)"
 category = "main"
 optional = false
@@ -95,7 +109,7 @@ tomli = {version = ">=2.0.1,<3.0.0", markers = "python_version < \"3.11\""}
 
 [[package]]
 name = "voicemeeter-api"
-version = "0.7.0"
+version = "2.0.2"
 description = "A Python wrapper for the Voiceemeter API"
 category = "main"
 optional = false
@@ -107,12 +121,13 @@ tomli = {version = ">=2.0.1,<3.0.0", markers = "python_version < \"3.11\""}
 [metadata]
 lock-version = "1.1"
 python-versions = "^3.10"
-content-hash = "1013fe45920526153e77b65bd21f9cdaac34841917159ea85565bec747c1e455"
+content-hash = "3a59de3a76e4c0ca11c0166750fa1af7d7c887750f855b48c45359068ef04798"
 
 [metadata.files]
 black = []
 click = []
 colorama = []
+isort = []
 mypy-extensions = []
 pathspec = []
 platformdirs = []

pyproject.toml

@@ -1,26 +1,25 @@
 [tool.poetry]
 name = "voicemeeter-compact"
-version = "1.5.3"
+version = "1.8.4"
 description = "A Compact Voicemeeter Remote App"
 authors = ["onyx-and-iris <code@onyxandiris.online>"]
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/onyx-and-iris/voicemeeter-compact"
 
-packages = [
-    { include = "vmcompact" },
-]
+packages = [{ include = "vmcompact" }]
 include = ["vmcompact/img/cat.ico"]
 
 [tool.poetry.dependencies]
 python = "^3.10"
-sv-ttk = "^2.0"
+sv-ttk = "^2.5.1"
 tomli = { version = "^2.0.1", python = "<3.11" }
-voicemeeter-api = "^0.7.0"
-vban-cmd = "^1.4.4"
+voicemeeter-api = "^2.0.2"
+vban-cmd = "^2.0.0"
 
 [tool.poetry.dev-dependencies]
-black = {version = "^22.6.0", allow-prereleases = true}
+black = { version = "^22.6.0", allow-prereleases = true }
+isort = "^5.12.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

vmcompact/app.py

@@ -1,14 +1,19 @@
+import logging
 import tkinter as tk
+from functools import cached_property
 from pathlib import Path
 from tkinter import ttk
 from typing import NamedTuple
 
 from .builders import MainFrameBuilder
+from .configurations import loader
 from .data import _base_values, _configuration, _kinds_all
-from .errors import VMCompactErrors
+from .errors import VMCompactError
 from .menu import Menus
 from .subject import Subject
 
+logger = logging.getLogger(__name__)
+
 
 class App(tk.Tk):
     """App mainframe"""
@@ -32,14 +37,17 @@ class App(tk.Tk):
 
     def __init__(self, vmr):
         super().__init__()
-
+        self.logger = logger.getChild(self.__class__.__name__)
         self._vmr = vmr
-        self._vmr.event.add("ldirty")
+        self._vmr.event.add(["pdirty", "ldirty"])
+        self.after(12000 if self._vmr.gui.launched_by_api else 1, self.start_updates)
+        self._vmr.init_thread()
         icon_path = Path(__file__).parent.resolve() / "img" / "cat.ico"
         if icon_path.is_file():
             self.iconbitmap(str(icon_path))
         self.minsize(275, False)
         self.subject = Subject()
+        self._configs = None
         self["menu"] = Menus(self, vmr)
         self.styletable = ttk.Style()
         if _configuration.config:
@@ -50,6 +58,15 @@ class App(tk.Tk):
         self.drag_id = ""
         self.bind("<Configure>", self.dragging)
 
+    def start_updates(self):
+        self.logger.debug("updates started")
+        _base_values.run_update = True
+        if self._vmr.gui.launched_by_api:
+            self.on_pdirty()
+
+    def __str__(self):
+        return f"{type(self).__name__}App"
+
     @property
     def target(self):
         """returns the current interface"""
@@ -74,8 +91,8 @@ class App(tk.Tk):
         if kind:
             self.kind = kind
 
-        # register app as observer
-        self.target.subject.add(self)
+        # register event callbacks
+        self.target.subject.add([self.on_pdirty, self.on_ldirty])
 
         self.bus_frame = None
         self.submix_frame = None
@@ -90,12 +107,12 @@ class App(tk.Tk):
         if self.kind.name == "potato":
             self.builder.create_banner()
 
-    def on_update(self, subject):
-        """called whenever notified of update"""
-
-        if subject == "pdirty" and _base_values.run_update:
+    def on_pdirty(self):
+        if _base_values.run_update:
             self.after(1, self.subject.notify, "pdirty")
-        elif subject == "ldirty" and not _base_values.dragging:
+
+    def on_ldirty(self):
+        if not _base_values.dragging:
             self.after(1, self.subject.notify, "ldirty")
 
     def _destroy_top_level_frames(self):
@@ -106,7 +123,7 @@ class App(tk.Tk):
 
         Destroy all top level frames.
         """
-        self.target.subject.remove(self)
+        self.target.subject.remove([self.on_pdirty, self.on_ldirty])
         self.subject.clear()
         [
             frame.destroy()
@@ -126,6 +143,11 @@ class App(tk.Tk):
         self.drag_id = ""
         _base_values.dragging = False
 
+    @cached_property
+    def userconfigs(self):
+        self._configs = loader(self.kind.name, self.target)
+        return self._configs
+
 
 _apps = {kind.name: App.make(kind) for kind in _kinds_all}
 
@@ -136,5 +158,5 @@ def connect(kind_id: str, vmr) -> App:
     try:
         VMMIN_cls = _apps[kind_id]
     except KeyError:
-        raise VMCompactErrors(f"Invalid kind: {kind_id}")
+        raise VMCompactError(f"Invalid kind: {kind_id}")
     return VMMIN_cls(vmr)

vmcompact/banner.py

@@ -1,15 +1,19 @@
+import logging
 import tkinter as tk
 from tkinter import ttk
 
 from .data import _base_values, _configuration
 
+logger = logging.getLogger(__name__)
+
 
 class Banner(ttk.Frame):
     def __init__(self, parent):
         super().__init__()
         self.parent = parent
-        self.submix = tk.StringVar()
-        self.submix.set(self.target.bus[_configuration.submixes].label)
+        self.parent.subject.add(self)
+        self.logger = logger.getChild(self.__class__.__name__)
+        self.submix = tk.StringVar(value=self.target.bus[_configuration.submixes].label)
 
         self.label = ttk.Label(
             self,
@@ -17,19 +21,15 @@ class Banner(ttk.Frame):
         )
         self.label.grid(column=0, row=0, sticky=(tk.N, tk.S, tk.W, tk.E))
 
-        self.upd_submix()
-
     @property
     def target(self):
         """returns the current interface"""
 
         return self.parent.target
 
-    def upd_submix(self):
-        self.after(1, self.upd_submix_step)
-
-    def upd_submix_step(self):
-        if not _base_values.dragging:
-            self.submix.set(self.target.bus[_configuration.submixes].label)
-            self.label["text"] = f"SUBMIX: {self.submix.get().upper()}"
-        self.after(100, self.upd_submix_step)
+    def on_update(self, subject):
+        if subject == "submix":
+            if not _base_values.dragging:
+                self.logger.debug("checking submix for banner")
+                self.submix.set(self.target.bus[_configuration.submixes].label)
+                self.label["text"] = f"SUBMIX: {self.submix.get().upper()}"

vmcompact/builders.py

@@ -1,4 +1,5 @@
 import abc
+import logging
 import tkinter as tk
 from functools import partial
 from tkinter import ttk
@@ -11,6 +12,8 @@ from .config import BusConfig, StripConfig
 from .data import _base_values, _configuration
 from .navigation import Navigation
 
+logger = logging.getLogger(__name__)
+
 
 class AbstractBuilder(abc.ABC):
     @abc.abstractmethod
@@ -30,6 +33,7 @@ class MainFrameBuilder(AbstractBuilder):
     def __init__(self, app):
         self.kind = app.kind
         self.app = app
+        self.logger = logger.getChild(self.__class__.__name__)
 
     def setup(self):
         self.app.title(
@@ -39,24 +43,26 @@ class MainFrameBuilder(AbstractBuilder):
         if _configuration.themes_enabled:
             if sv_ttk.get_theme() not in ("light", "dark"):
                 sv_ttk.set_theme(_configuration.theme_mode)
-                print(f"Sunvalley {sv_ttk.get_theme().capitalize()} Theme applied")
-
-        self.app.target.event.remove("mdirty")
-        self.app.target.event.remove("midi")
+                self.logger.info(
+                    f"Sunvalley {sv_ttk.get_theme().capitalize()} Theme applied"
+                )
 
     def create_channelframe(self, type_):
         if type_ == "strip":
             self.app.strip_frame = _make_channelframe(self.app, type_)
         else:
             self.app.bus_frame = _make_channelframe(self.app, type_)
+        self.logger.info(f"Finished building channelframe type {type_}")
 
     def create_separator(self):
         self.app.sep = ttk.Separator(self.app, orient="vertical")
         self.app.sep.grid(row=0, column=1, sticky=(tk.N, tk.S))
         self.app.columnconfigure(1, minsize=15)
+        self.logger.info(f"Finished building separator")
 
     def create_navframe(self):
         self.app.nav_frame = Navigation(self.app)
+        self.logger.info(f"Finished building navframe")
 
     def create_configframe(self, type_, index, id):
         if type_ == "strip":
@@ -102,6 +108,7 @@ class MainFrameBuilder(AbstractBuilder):
                     )
                     for _, frame in enumerate(self.app.bus_frame.labelframes)
                 ]
+        self.logger.info(f"Finished building configframe for {type_}[{index}]")
         self.app.after(5, self.reset_config_frames)
 
     def reset_config_frames(self):
@@ -114,6 +121,7 @@ class MainFrameBuilder(AbstractBuilder):
     def create_banner(self):
         self.app.banner = Banner(self.app)
         self.app.banner.grid(row=4, column=0, columnspan=3)
+        self.logger.info(f"Finished building banner")
 
     def teardown(self):
         pass
@@ -187,9 +195,9 @@ class NavigationFrameBuilder(AbstractBuilder):
             if isinstance(child, ttk.Checkbutton)
         ]
         if _configuration.themes_enabled:
-            self.navframe.rowconfigure(1, minsize=_configuration.level_height)
+            self.navframe.rowconfigure(1, minsize=_configuration.channel_height)
         else:
-            self.navframe.rowconfigure(1, minsize=_configuration.level_height + 10)
+            self.navframe.rowconfigure(1, minsize=_configuration.channel_height + 10)
 
     def teardown(self):
         pass
@@ -219,7 +227,7 @@ class ChannelLabelFrameBuilder(AbstractBuilder):
         """Adds a progress bar widget to a single label frame"""
         self.labelframe.pb = ttk.Progressbar(
             self.labelframe,
-            maximum=100,
+            maximum=72,
             orient="vertical",
             mode="determinate",
             variable=self.labelframe.level,
@@ -235,7 +243,7 @@ class ChannelLabelFrameBuilder(AbstractBuilder):
             orient="vertical",
             variable=self.labelframe.gain,
             command=self.labelframe.scale_callback,
-            length=_configuration.level_height,
+            length=_configuration.channel_height,
         )
         self.scale.grid(column=1, row=0)
         self.scale.bind("<Double-Button-1>", self.labelframe.reset_gain)
@@ -316,7 +324,7 @@ class ChannelConfigFrameBuilder(AbstractBuilder):
         ]
         self.configframe.grid(sticky=(tk.W))
         [
-            self.configframe.columnconfigure(i, minsize=_configuration.level_width)
+            self.configframe.columnconfigure(i, minsize=_configuration.channel_width)
             for i in range(self.configframe.phys_out + self.configframe.virt_out)
         ]
 
@@ -329,7 +337,7 @@ class StripConfigFrameBuilder(ChannelConfigFrameBuilder):
             self.configframe.slider_params = ("audibility",)
             self.configframe.slider_vars = (tk.DoubleVar(),)
         else:
-            self.configframe.slider_params = ("comp", "gate", "limit")
+            self.configframe.slider_params = ("comp.knob", "gate.knob", "limit")
             self.configframe.slider_vars = [
                 tk.DoubleVar() for _ in self.configframe.slider_params
             ]
@@ -384,18 +392,18 @@ class StripConfigFrameBuilder(ChannelConfigFrameBuilder):
             from_=0.0,
             to=10.0,
             orient="horizontal",
-            length=_configuration.level_width,
+            length=_configuration.channel_width,
             variable=self.configframe.slider_vars[
-                self.configframe.slider_params.index("comp")
+                self.configframe.slider_params.index("comp.knob")
             ],
-            command=partial(self.configframe.scale_callback, "comp"),
+            command=partial(self.configframe.scale_callback, "comp.knob"),
         )
         comp_scale.bind(
-            "<Double-Button-1>", partial(self.configframe.reset_scale, "comp", 0)
+            "<Double-Button-1>", partial(self.configframe.reset_scale, "comp.knob", 0)
         )
         comp_scale.bind("<Button-1>", self.configframe.scale_press)
         comp_scale.bind("<ButtonRelease-1>", self.configframe.scale_release)
-        comp_scale.bind("<Enter>", partial(self.configframe.scale_enter, "comp"))
+        comp_scale.bind("<Enter>", partial(self.configframe.scale_enter, "comp.knob"))
         comp_scale.bind("<Leave>", self.configframe.scale_leave)
 
         comp_label.grid(column=0, row=0)
@@ -408,18 +416,18 @@ class StripConfigFrameBuilder(ChannelConfigFrameBuilder):
             from_=0.0,
             to=10.0,
             orient="horizontal",
-            length=_configuration.level_width,
+            length=_configuration.channel_width,
             variable=self.configframe.slider_vars[
-                self.configframe.slider_params.index("gate")
+                self.configframe.slider_params.index("gate.knob")
             ],
-            command=partial(self.configframe.scale_callback, "gate"),
+            command=partial(self.configframe.scale_callback, "gate.knob"),
         )
         gate_scale.bind(
-            "<Double-Button-1>", partial(self.configframe.reset_scale, "gate", 0)
+            "<Double-Button-1>", partial(self.configframe.reset_scale, "gate.knob", 0)
         )
         gate_scale.bind("<Button-1>", self.configframe.scale_press)
         gate_scale.bind("<ButtonRelease-1>", self.configframe.scale_release)
-        gate_scale.bind("<Enter>", partial(self.configframe.scale_enter, "gate"))
+        gate_scale.bind("<Enter>", partial(self.configframe.scale_enter, "gate.knob"))
         gate_scale.bind("<Leave>", self.configframe.scale_leave)
 
         gate_label.grid(column=2, row=0)
@@ -432,7 +440,7 @@ class StripConfigFrameBuilder(ChannelConfigFrameBuilder):
             from_=-40,
             to=12,
             orient="horizontal",
-            length=_configuration.level_width,
+            length=_configuration.channel_width,
             variable=self.configframe.slider_vars[
                 self.configframe.slider_params.index("limit")
             ],
@@ -456,7 +464,7 @@ class StripConfigFrameBuilder(ChannelConfigFrameBuilder):
             from_=0.0,
             to=10.0,
             orient="horizontal",
-            length=_configuration.level_width,
+            length=_configuration.channel_width,
             variable=self.configframe.slider_vars[
                 self.configframe.slider_params.index("audibility")
             ],
@@ -556,7 +564,7 @@ class BusConfigFrameBuilder(ChannelConfigFrameBuilder):
         }
         self.configframe.bus_modes = list(self.configframe.bus_mode_map.keys())
         # fmt: on
-        self.configframe.params = ("mono", "eq", "eq_ab")
+        self.configframe.params = ("mono", "eq.on", "eq.ab")
         self.configframe.param_vars = [tk.BooleanVar() for _ in self.configframe.params]
         self.configframe.bus_mode_label_text = tk.StringVar(
             value=self.configframe.bus_mode_map[self.configframe.current_bus_mode()]

vmcompact/channels.py

@@ -1,10 +1,12 @@
+import logging
 import tkinter as tk
-from math import log
 from tkinter import ttk
 
 from . import builders
 from .data import _base_values, _configuration
 
+logger = logging.getLogger(__name__)
+
 
 class ChannelLabelFrame(ttk.LabelFrame):
     """Base class for a single channel"""
@@ -14,6 +16,7 @@ class ChannelLabelFrame(ttk.LabelFrame):
         self.parent = parent
         self.index = index
         self.id = id
+        self.logger = logger.getChild(self.__class__.__name__)
         self.styletable = self.parent.parent.styletable
 
         self.builder = builders.ChannelLabelFrameBuilder(self, index, id)
@@ -40,18 +43,21 @@ class ChannelLabelFrame(ttk.LabelFrame):
         return self.parent.target
 
     def getter(self, param):
-        if hasattr(self.target, param):
+        try:
             return getattr(self.target, param)
+        except AttributeError as e:
+            self.logger(f"{type(e).__name__}: {e}")
 
     def setter(self, param, value):
-        if hasattr(self.target, param):
+        if param in dir(self.target):  # avoid calling getattr (with hasattr)
             setattr(self.target, param, value)
 
     def scale_callback(self, *args):
         """callback function for scale widget"""
 
-        self.setter("gain", self.gain.get())
-        self.gainlabel.set(round(self.gain.get(), 1))
+        val = round(self.gain.get(), 1)
+        self.setter("gain", val)
+        self.gainlabel.set(val)
 
     def toggle_mute(self, *args):
         self.target.mute = self.mute.get()
@@ -148,7 +154,7 @@ class ChannelLabelFrame(ttk.LabelFrame):
         self.configure(text=retval)
 
     def grid_configure(self):
-        self.grid(sticky=(tk.N, tk.S))
+        self.grid(padx=_configuration.channel_xpadding, sticky=(tk.N, tk.S))
         [
             child.grid_configure(padx=1, pady=1, sticky=(tk.W, tk.E))
             for child in self.winfo_children()
@@ -186,7 +192,7 @@ class Strip(ChannelLabelFrame):
             if self.target.levels.is_updated:
                 val = max(self.target.levels.prefader)
                 self.level.set(
-                    (0 if self.mute.get() else 100 + val - 18 + self.gain.get())
+                    (0 if self.mute.get() else 72 + val - 12 + self.gain.get())
                 )
 
 
@@ -208,7 +214,7 @@ class Bus(ChannelLabelFrame):
         if self.index < self.parent.parent.kind.num_bus:
             if self.target.levels.is_updated or self.level.get() != -118:
                 val = max(self.target.levels.all)
-                self.level.set((0 if self.mute.get() else 100 + val - 18))
+                self.level.set((0 if self.mute.get() else 72 + val - 12))
 
 
 class ChannelFrame(ttk.Frame):
@@ -252,7 +258,7 @@ class ChannelFrame(ttk.Frame):
 
     def grid_configure(self):
         [
-            self.columnconfigure(i, minsize=_configuration.level_width)
+            self.columnconfigure(i, minsize=_configuration.channel_width)
             for i, _ in enumerate(self.labelframes)
         ]
         [self.rowconfigure(0, minsize=100) for i, _ in enumerate(self.labelframes)]

vmcompact/config.py

@@ -1,10 +1,11 @@
-import tkinter as tk
-from functools import partial
+import logging
 from tkinter import ttk
 
 from . import builders
 from .data import _base_values, _configuration
 
+logger = logging.getLogger(__name__)
+
 
 class Config(ttk.Frame):
     def __init__(self, parent, index, _id):
@@ -12,6 +13,7 @@ class Config(ttk.Frame):
         self.parent = parent
         self.index = index
         self.id = _id
+        self.logger = logger.getChild(self.__class__.__name__)
         self.styletable = parent.styletable
         self.phys_in, self.virt_in = parent.kind.ins
         self.phys_out, self.virt_out = parent.kind.outs
@@ -29,12 +31,26 @@ class Config(ttk.Frame):
         return self.parent.target
 
     def getter(self, param):
-        if hasattr(self.target, param):
-            return getattr(self.target, param)
+        param = param.split(".")
+        try:
+            if len(param) == 2:
+                target = getattr(self.target, param[0])
+                return getattr(target, param[1])
+            else:
+                return getattr(self.target, param[0])
+        except AttributeError as e:
+            self.logger.error(f"{type(e).__name__}: {e}")
 
     def setter(self, param, value):
-        if hasattr(self.target, param):
-            setattr(self.target, param, value)
+        param = param.split(".")
+        try:
+            if len(param) == 2:
+                target = getattr(self.target, param[0])
+                setattr(target, param[1], value)
+            else:
+                setattr(self.target, param[0], value)
+        except AttributeError as e:
+            self.logger(f"{type(e).__name__}: {e}")
 
     def scale_press(self, *args):
         self.after(1, self.remove_events)
@@ -66,7 +82,7 @@ class Config(ttk.Frame):
         """callback function for scale widget"""
 
         val = self.slider_vars[self.slider_params.index(param)].get()
-        self.setter(param, val)
+        self.setter(param, round(val, 1))
         self.parent.nav_frame.info_text.set(round(val, 1))
 
     def reset_scale(self, param, val, *args):
@@ -98,6 +114,7 @@ class StripConfig(Config):
         self.make_row_2()
         self.builder.grid_configure()
 
+        self.parent.target.clear_dirty()
         self.sync()
 
     @property
@@ -155,6 +172,12 @@ class StripConfig(Config):
             self.param_vars[i].set(self.getter(param))
             for i, param in enumerate(self.params)
         ]
+        if not _base_values.vban_connected:  # slider vars not defined in RT Packet
+            [
+                self.slider_vars[i].set(self.getter(param))
+                for i, param in enumerate(self.slider_params)
+                if self.index < self.phys_in
+            ]
 
         if not _configuration.themes_enabled:
             [
@@ -193,6 +216,7 @@ class BusConfig(Config):
         self.make_row_1()
         self.builder.grid_configure()
 
+        self.parent.target.clear_dirty()
         self.sync()
 
     @property

vmcompact/configurations.py

@@ -1,3 +1,4 @@
+import logging
 from pathlib import Path
 
 try:
@@ -5,24 +6,36 @@ try:
 except ModuleNotFoundError:
     import tomli as tomllib
 
+logger = logging.getLogger(__name__)
+
 configuration = {}
 
-config_path = [Path.cwd() / "configs"]
-for path in config_path:
-    if path.is_dir():
-        filenames = list(path.glob("*.toml"))
-        configs = {}
-        for filename in filenames:
-            name = filename.with_suffix("").stem
-            try:
-                with open(filename, "rb") as f:
-                    configs[name] = tomllib.load(f)
-            except tomllib.TOMLDecodeError:
-                print(f"Invalid TOML config: configs/{filename.stem}")
 
-        for name, cfg in configs.items():
-            print(f"Loaded configuration configs/{name}")
-            configuration[name] = cfg
+def get_configpath():
+    configpaths = [
+        Path.cwd() / "configs",
+        Path.home() / ".config" / "vm-compact" / "configs",
+        Path.home() / "Documents" / "Voicemeeter" / "configs",
+    ]
+    for configpath in configpaths:
+        if configpath.exists():
+            return configpath
+
+
+if configpath := get_configpath():
+    filepaths = list(configpath.glob("*.toml"))
+    if any(f.stem in ("app", "vban") for f in filepaths):
+        configs = {}
+        for filepath in filepaths:
+            filename = filepath.with_suffix("").stem
+            if filename in ("app", "vban"):
+                try:
+                    with open(filepath, "rb") as f:
+                        configs[filename] = tomllib.load(f)
+                    logger.info(f"configuration: {filename} loaded into memory")
+                except tomllib.TOMLDecodeError:
+                    logger.error(f"Invalid TOML config: configs/{filename.stem}")
+        configuration |= configs
 
 _defaults = {
     "configs": {
@@ -39,6 +52,7 @@ _defaults = {
     "channel": {
         "width": 80,
         "height": 130,
+        "xpadding": 3,
     },
     "mwscroll_step": {
         "size": 3,
@@ -46,10 +60,16 @@ _defaults = {
     "submixes": {
         "default": 0,
     },
+    "navigation": {"show": True},
 }
 
+
 if "app" in configuration:
-    configuration["app"] = _defaults | configuration["app"]
+    for key in _defaults:
+        if key in configuration["app"]:
+            configuration["app"][key] = _defaults[key] | configuration["app"][key]
+        else:
+            configuration["app"][key] = _defaults[key]
 else:
     configuration["app"] = _defaults
 
@@ -57,3 +77,22 @@ else:
 def get_configuration(key):
     if key in configuration:
         return configuration[key]
+
+
+def loader(kind_id, target):
+    configs = {"reset": target.configs["reset"]}
+    if configpath := get_configpath():
+        userconfigpath = configpath / kind_id
+        if userconfigpath.exists():
+            filepaths = list(userconfigpath.glob("*.toml"))
+            for filepath in filepaths:
+                identifier = filepath.with_suffix("").stem
+                try:
+                    with open(filepath, "rb") as f:
+                        configs[identifier] = tomllib.load(f)
+                    logger.info(f"loader: {identifier} loaded into memory")
+                except tomllib.TOMLDecodeError:
+                    logger.error(f"Invalid TOML config: configs/{filename.stem}")
+
+    target.configs = configs
+    return target.configs

vmcompact/data.py

@@ -32,10 +32,15 @@ class Configurations(metaclass=SingletonMeta):
     # bus assigned as current submix
     submixes: int = configuration["submixes"]["default"]
 
-    # width of a single labelframe
-    level_width: int = configuration["channel"]["width"]
-    # height of a single labelframe
-    level_height: int = configuration["channel"]["height"]
+    # width of a single channel labelframe
+    channel_width: int = configuration["channel"]["width"]
+    # height of a single channel labelframe
+    channel_height: int = configuration["channel"]["height"]
+    # xpadding for a single channel labelframe
+    channel_xpadding: int = configuration["channel"]["xpadding"]
+
+    # do we grid the navigation frame?
+    navigation_show: bool = configuration["navigation"]["show"]
 
     @property
     def config(self):
@@ -46,7 +51,7 @@ class Configurations(metaclass=SingletonMeta):
 @dataclass
 class BaseValues(metaclass=SingletonMeta):
     # pause updates after releasing scale
-    run_update: bool = True
+    run_update: bool = False
     # are we dragging main window with mouse 1
     dragging: bool = False
     # a vban connection established

vmcompact/errors.py

@@ -1,4 +1,2 @@
-class VMCompactErrors(Exception):
-    """Base classs for VMCompact Errors"""
-
-    pass
+class VMCompactError(Exception):
+    """Exception raised when general errors occur"""

vmcompact/gainlayer.py

@@ -1,5 +1,4 @@
 import tkinter as tk
-from math import log
 from tkinter import ttk
 
 from . import builders
@@ -42,11 +41,13 @@ class GainLayer(ttk.LabelFrame):
         return "gainlayer"
 
     def getter(self, param):
-        if hasattr(self.target, param):
+        try:
             return getattr(self.target, param)
+        except AttributeError as e:
+            self.logger(f"{type(e).__name__}: {e}")
 
     def setter(self, param, value):
-        if hasattr(self.target, param):
+        if param in dir(self.target):  # avoid calling getattr (with hasattr)
             setattr(self.target, param, value)
 
     def reset_gain(self, *args):
@@ -57,8 +58,9 @@ class GainLayer(ttk.LabelFrame):
     def scale_callback(self, *args):
         """callback function for scale widget"""
 
-        self.setter("gain", self.gain.get())
-        self.gainlabel.set(round(self.gain.get(), 1))
+        val = round(self.gain.get(), 1)
+        self.setter("gain", val)
+        self.gainlabel.set(val)
 
     def scale_press(self, *args):
         self.after(1, self.remove_events)
@@ -157,12 +159,14 @@ class GainLayer(ttk.LabelFrame):
             self.level.set(
                 (
                     0
-                    if self.parent.target.strip[self.index].mute or not self.on.get()
-                    else 100 + val - 18 + self.gain.get()
+                    if self.parent.parent.strip_frame.strips[self.index].mute.get()
+                    or not self.on.get()
+                    else 72 + val - 12 + self.gain.get()
                 )
             )
 
     def grid_configure(self):
+        self.grid(padx=_configuration.channel_xpadding, sticky=(tk.N, tk.S))
         [
             child.grid_configure(padx=1, pady=1, sticky=(tk.N, tk.S, tk.W, tk.E))
             for child in self.winfo_children()
@@ -250,11 +254,11 @@ class SubMixFrame(ttk.Frame):
 
     def grid_configure(self):
         [
-            self.columnconfigure(i, minsize=_configuration.level_width)
+            self.columnconfigure(i, minsize=_configuration.channel_width)
             for i, _ in enumerate(self.labelframes)
         ]
         [
-            self.rowconfigure(0, minsize=_configuration.level_height)
+            self.rowconfigure(0, minsize=_configuration.channel_height)
             for i, _ in enumerate(self.labelframes)
         ]
 

vmcompact/menu.py

@@ -1,25 +1,31 @@
+import logging
 import tkinter as tk
 import webbrowser
 from functools import partial
-from tkinter import messagebox, ttk
+from tkinter import messagebox
 
 import sv_ttk
 import vban_cmd
-from vban_cmd.error import VBANCMDError
+from vban_cmd.error import VBANCMDConnectionError
 
 from .data import _base_values, _configuration, get_configuration, kind_get
 
+logger = logging.getLogger(__name__)
+
 
 class Menus(tk.Menu):
     def __init__(self, parent, vmr):
         super().__init__()
         self.parent = parent
         self.vmr = vmr
+        self.logger = logger.getChild(self.__class__.__name__)
         self.vban_config = get_configuration("vban")
         self.app_config = get_configuration("app")
         self._is_topmost = tk.BooleanVar()
         self._lock = tk.BooleanVar()
         self._unlock = tk.BooleanVar()
+        self._navigation_show = tk.BooleanVar(value=_configuration.navigation_show)
+        self._navigation_hide = tk.BooleanVar(value=not _configuration.navigation_show)
         self._selected_bus = list(tk.BooleanVar() for _ in range(8))
 
         # voicemeeter menu
@@ -79,14 +85,14 @@ class Menus(tk.Menu):
         self.menu_configs_load = tk.Menu(self.menu_configs, tearoff=0)
         self.menu_configs.add_cascade(menu=self.menu_configs_load, label="Load config")
         self.config_defaults = {"reset"}
-        if len(self.target.configs) > len(self.config_defaults) and all(
-            key in self.target.configs for key in self.config_defaults
+        if len(self.parent.userconfigs) > len(self.config_defaults) and all(
+            key in self.parent.userconfigs for key in self.config_defaults
         ):
             [
                 self.menu_configs_load.add_command(
                     label=profile, command=partial(self.load_profile, profile)
                 )
-                for profile in self.target.configs.keys()
+                for profile in self.parent.userconfigs.keys()
                 if profile not in self.config_defaults
             ]
         else:
@@ -150,6 +156,23 @@ class Menus(tk.Menu):
         )
         if not _configuration.themes_enabled:
             self.menu_layout.entryconfig(2, state="disabled")
+        # layout/navigation
+        self.menu_navigation = tk.Menu(self.menu_layout, tearoff=0)
+        self.menu_layout.add_cascade(menu=self.menu_navigation, label="Navigation")
+        self.menu_navigation.add_checkbutton(
+            label="show",
+            onvalue=1,
+            offvalue=0,
+            variable=self._navigation_show,
+            command=partial(self.toggle_navigation, "show"),
+        )
+        self.menu_navigation.add_checkbutton(
+            label="hide",
+            onvalue=1,
+            offvalue=0,
+            variable=self._navigation_hide,
+            command=partial(self.toggle_navigation, "hide"),
+        )
 
         # vban connect menu
         self.menu_vban = tk.Menu(self, tearoff=0)
@@ -209,15 +232,24 @@ class Menus(tk.Menu):
             self._unlock.set(not self._lock.get())
         setattr(self.target.command, cmd, val)
 
+    def load_custom_profile(self, profile):
+        self.logger.info(f"loading user profile {profile}")
+        self.target.apply(profile)
+
     def load_profile(self, profile):
+        self.logger.info(f"loading user profile {profile}")
         self.target.apply_config(profile)
 
     def load_defaults(self):
-        resp = messagebox.askyesno(
-            message="Are you sure you want to Reset values to defaults?\nPhysical strips B1, Virtual strips A1\nMono, Solo, Mute, EQ all OFF"
+        msg = (
+            "Are you sure you want to Reset values to defaults?",
+            "Physical strips B1, Virtual strips A1",
+            "Mono, Solo, Mute, EQ all OFF",
+            "Gain sliders for Strip/Bus at 0.0",
         )
+        resp = messagebox.askyesno(message="\n".join(msg))
         if resp:
-            self.target.apply_config("reset")
+            self.load_profile("reset")
 
     def always_on_top(self):
         self.parent.attributes("-topmost", self._is_topmost.get())
@@ -239,6 +271,7 @@ class Menus(tk.Menu):
                 self.parent.nav_frame.show_submix()
             for j, var in enumerate(self._selected_bus):
                 var.set(i == j)
+            self.parent.subject.notify("submix")
 
     def load_theme(self, theme):
         sv_ttk.set_theme(theme)
@@ -268,14 +301,19 @@ class Menus(tk.Menu):
             for menu in self.menu_layout.winfo_children()
             if isinstance(menu, tk.Menu)
         ]
+        self.logger.info(
+            f"Finished loading theme Sunvalley {sv_ttk.get_theme().capitalize()} theme"
+        )
 
     def menu_teardown(self, i):
         # remove config load menus
-        [
-            self.menu_configs_load.delete(key)
-            for key in self.target.configs.keys()
-            if key not in self.config_defaults
-        ]
+        if len(self.parent.userconfigs) > len(self.config_defaults):
+            for profile in self.parent.userconfigs:
+                if profile not in self.config_defaults:
+                    try:
+                        self.menu_configs_load.delete(profile)
+                    except tk._tkinter.tclError as e:
+                        self.logger.warning(f"{type(e).__name__}: {e}")
 
         [
             self.menu_vban.entryconfig(j, state="disabled")
@@ -284,19 +322,28 @@ class Menus(tk.Menu):
         ]
 
     def menu_setup(self):
-        if len(self.target.configs) > len(self.config_defaults) and all(
-            key in self.target.configs for key in self.config_defaults
-        ):
-            [
-                self.menu_configs_load.add_command(
-                    label=profile, command=partial(self.load_profile, profile)
-                )
-                for profile in self.target.configs.keys()
-                if profile not in self.config_defaults
-            ]
+        if len(self.parent.userconfigs) > len(self.config_defaults):
+            for profile in self.parent.userconfigs:
+                if profile not in self.config_defaults:
+                    self.menu_configs_load.add_command(
+                        label=profile, command=partial(self.load_profile, profile)
+                    )
+                    self.menu_configs.entryconfig(0, state="normal")
         else:
             self.menu_configs.entryconfig(0, state="disabled")
 
+    def toggle_navigation(self, cmd=None):
+        if cmd == "show":
+            self.logger.debug("show navframe")
+            self.parent.nav_frame.grid()
+            self._navigation_show.set(True)
+            self._navigation_hide.set(not self._navigation_show.get())
+        else:
+            self.logger.debug("hide navframe")
+            self.parent.nav_frame.grid_remove()
+            self._navigation_hide.set(True)
+            self._navigation_show.set(not self._navigation_hide.get())
+
     def vban_connect(self, i):
         opts = {}
         opts |= self.vban_config[f"connection-{i+1}"]
@@ -304,15 +351,21 @@ class Menus(tk.Menu):
         self.vban = vban_cmd.api(kind_id, **opts)
         # login to vban interface
         try:
+            self.logger.info(f"Attempting vban connection to {opts.get('ip')}")
             self.vban.login()
-        except VBANCMDError as e:
-            msg = (str(e), f"Please check your connection settings")
-            messagebox.showerror("Connection Error", "\n".join(msg))
+        except VBANCMDConnectionError as e:
             self.vban.logout()
+            msg = (
+                f"Timeout attempting to establish connection to {opts.get('ip')}",
+                f"Please check your connection settings",
+            )
+            messagebox.showerror("Connection Error", "\n".join(msg))
+            msg = (str(e), f"resuming local connection")
+            self.logger.error(", ".join(msg))
             self.after(1, self.enable_vban_menus)
             return
         self.menu_teardown(i)
-        self.vban.event.add("ldirty")
+        self.vban.event.add(["pdirty", "ldirty"])
         # destroy the current App frames
         self.parent._destroy_top_level_frames()
         _base_values.vban_connected = True
@@ -327,6 +380,11 @@ class Menus(tk.Menu):
         self.menu_layout.entryconfig(
             0, state=f"{'normal' if kind.name == 'potato' else 'disabled'}"
         )
+        # ensure the configs are reloaded into memory
+        if "config" in self.parent.target.__dict__:
+            del self.parent.target.__dict__["config"]
+        if "userconfigs" in self.parent.__dict__:
+            del self.parent.__dict__["userconfigs"]
         self.menu_setup()
 
     def vban_disconnect(self, i):
@@ -347,6 +405,11 @@ class Menus(tk.Menu):
         self.menu_layout.entryconfig(
             0, state=f"{'normal' if kind.name == 'potato' else 'disabled'}"
         )
+        # ensure the configs are reloaded into memory
+        if "config" in self.parent.target.__dict__:
+            del self.parent.target.__dict__["config"]
+        if "userconfigs" in self.parent.__dict__:
+            del self.parent.__dict__["userconfigs"]
         self.menu_setup()
 
         self.after(15000, self.enable_vban_menus)

vmcompact/navigation.py

@@ -1,3 +1,4 @@
+import logging
 import tkinter as tk
 from tkinter import ttk
 
@@ -5,12 +6,17 @@ from . import builders
 from .data import _configuration
 from .gainlayer import SubMixFrame
 
+logger = logging.getLogger(__name__)
+
 
 class Navigation(ttk.Frame):
     def __init__(self, parent):
         super().__init__(parent)
         self.parent = parent
+        self.logger = logger.getChild(self.__class__.__name__)
         self.grid(row=0, column=3, padx=(0, 2), pady=(5, 5), sticky=(tk.W, tk.E))
+        if not _configuration.navigation_show:
+            self.grid_remove()
         self.styletable = self.parent.styletable
 
         self.builder = builders.NavigationFrameBuilder(self)
@@ -26,6 +32,9 @@ class Navigation(ttk.Frame):
     def show_submix(self):
         if self.submix.get():
             self.parent.submix_frame = SubMixFrame(self.parent)
+            self.logger.info(
+                f"Finished building submixframe for submix {_configuration.submixes}"
+            )
         else:
             if _configuration.extends_horizontal:
                 self.parent.submix_frame.teardown()
@@ -39,6 +48,9 @@ class Navigation(ttk.Frame):
                     self.parent.bus_frame.grid()
                 else:
                     self.parent.rowconfigure(2, weight=0, minsize=0)
+            self.logger.info(
+                f"Finished tearing down submixframe for submix {_configuration.submixes}"
+            )
 
         if not _configuration.themes_enabled:
             self.styletable.configure(