simple-carla 1.2.0__tar.gz → 1.3.1__tar.gz

{simple_carla-1.2.0 → simple_carla-1.3.1}/PKG-INFO

@@ -1,10 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: simple_carla
-Version: 1.2.0
+Version: 1.3.1
 Summary: An easy-to-use, object-oriented interface to the carla plugin host.
 Author-email: Leon Dionne <ldionne@dridesign.sh.cn>
 Description-Content-Type: text/markdown
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: log_soso
 Requires-Dist: PyQt5

{simple_carla-1.2.0 → simple_carla-1.3.1}/pyproject.toml

@@ -18,7 +18,7 @@ build-backend = "flit_core.buildapi"
 sc-plugin-def = "simple_carla.scripts.sc_plugin_def:main"
 
 [bumpver]
-current_version = "1.2.0"
+current_version = "1.3.1"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "Bump version {old_version} -> {new_version}"
 commit = true

{simple_carla-1.2.0 → simple_carla-1.3.1}/simple_carla/__init__.py

@@ -22,7 +22,7 @@ An easy-to-use, object-oriented interface to the carla plugin host.
 """
 import os, sys, threading, time, logging, traceback
 from ctypes import byref, cast, c_char_p, c_void_p, POINTER
-from functools import wraps, cache
+from functools import wraps
 from struct import pack
 from numpy import zeros as np_zeros
 from log_soso import StreamToLogger
@@ -234,7 +234,7 @@ from carla_backend import (
 )
 
 
-__version__ = "1.2.0"
+__version__ = "1.3.1"
 
 
 # -------------------------------------------------------------------
@@ -354,16 +354,6 @@ class _SimpleCarla(CarlaHostDLL):
 			self.set_engine_option(ENGINE_OPTION_DEBUG_CONSOLE_OUTPUT, self.showLogs, "")
 			self.set_engine_option(ENGINE_OPTION_CLIENT_NAME_PREFIX, 0, self.client_name)
 
-	# -------------------------------------------------------------------
-	# Save state (pathcbay connections)
-
-	def encode_saved_state(self):
-		"""
-		Return an object comprised of only basic data types for serialization as JSON
-		in prepration for saving the current project.
-		"""
-		return [ conn.encode_saved_state() for conn in self._connections.values() ]
-
 	# -------------------------------------------------------------------
 	# Engine control / idle loop
 
@@ -700,13 +690,16 @@ class _SimpleCarla(CarlaHostDLL):
 		Remove a plugin.
 		plugin_id:		Plugin to remove.
 		"""
-		return bool(self.lib.carla_remove_plugin(self.handle, plugin_id))
+		if not self.lib.carla_remove_plugin(self.handle, plugin_id):
+			raise RuntimeError('Carla will not remove plugin')
 
 	@polite_function
 	def remove_all_plugins(self):
 		"""
 		Remove all plugins.
 		"""
+		for plugin in self._plugin_by_uuid.values():
+			plugin.removing_from_carla = True
 		return bool(self.lib.carla_remove_all_plugins(self.handle))
 
 	@polite_function
@@ -1515,6 +1508,7 @@ class _SimpleCarla(CarlaHostDLL):
 		in_port.connection_added(connection)
 		out_client.output_connection_change(connection, True)
 		in_client.input_connection_change(connection, True)
+		self._alert_connection_added(connection)
 
 	def cb_patchbay_connection_removed(self, connection_id, zero_1, zero_2):
 		"""
@@ -1526,6 +1520,7 @@ class _SimpleCarla(CarlaHostDLL):
 			connection.in_port.connection_removed(connection)
 			self._clients[connection.out_port.client_id].output_connection_change(connection, False)
 			self._clients[connection.in_port.client_id].input_connection_change(connection, False)
+			self._alert_connection_removed(connection)
 			del self._connections[connection_id]
 		else:
 			logging.warning('cb_patchbay_connection_removed: Connection %s not in ._connections',
@@ -1789,6 +1784,8 @@ class Carla(_SimpleCarla):
 	_cb_client_removed			= None
 	_cb_port_added				= None
 	_cb_port_removed			= None
+	_cb_connection_added		= None
+	_cb_connection_removed		= None
 	_cb_plugin_removed			= None
 	_cb_last_plugin_removed		= None
 	_cb_engine_started			= None
@@ -1819,6 +1816,12 @@ class Carla(_SimpleCarla):
 	def on_port_removed(self, callback):
 		self._cb_port_removed = callback
 
+	def on_connection_added(self, callback):
+		self._cb_connection_added = callback
+
+	def on_connection_removed(self, callback):
+		self._cb_connection_removed = callback
+
 	def on_plugin_removed(self, callback):
 		self._cb_plugin_removed = callback
 
@@ -2071,6 +2074,14 @@ class Carla(_SimpleCarla):
 		if self._cb_port_removed is not None:
 			self._cb_port_removed(port)
 
+	def _alert_connection_added(self, connection):
+		if self._cb_connection_added is not None:
+			self._cb_connection_added(connection)
+
+	def _alert_connection_removed(self, connection):
+		if self._cb_connection_removed is not None:
+			self._cb_connection_removed(connection)
+
 	def _alert_plugin_removed(self, plugin):
 		if self._cb_plugin_removed is not None:
 			self._cb_plugin_removed(plugin)
@@ -2087,6 +2098,9 @@ class PatchbayClient:
 	"""
 	Patchbay client which has patchbay ports.
 
+	This class is not instantiated directly, but is inherited by
+	SystemPatchbayClient and Plugin
+
 	Members of interest
 	-------------------
 	ports:        (dict)  PatchbayPort objects indexed on port_id
@@ -2517,12 +2531,14 @@ class PatchbayPort:
 		Returns PatchbayClient.
 		(May return class extending PatchbayClient, i.e. SystemPatchbayClient / Plugin)
 		"""
+		# TODO: Make this a cached property
 		return Carla.instance.client(self.client_id)
 
 	def client_name(self):
 		"""
 		Returns (str) the JACK client name of the PatchbayClient which "owns" this PatchbayPort.
 		"""
+		# TODO: Make this a property
 		return self.client().client_name
 
 	def jack_name(self):
@@ -2677,6 +2693,7 @@ class Plugin(PatchbayClient):
 		self.moniker				= None
 		self.ports_ready			= False
 		self.added_to_carla			= False
+		self.removing_from_carla	= False
 		self.is_ready				= False
 		self.can_drywet				= False
 		self.can_volume				= False
@@ -2838,6 +2855,7 @@ class Plugin(PatchbayClient):
 
 		(See also "got_removed")
 		"""
+		self.removing_from_carla = True
 		Carla.instance.remove_plugin(self.plugin_id)
 
 	def plugin_id_changed(self, new_plugin_id):
@@ -2871,11 +2889,11 @@ class Plugin(PatchbayClient):
 		for key, value in self.saved_state["vars"].items():
 			setattr(self, key, value)
 		for key, value in self.saved_state["parameters"].items():
-			if not value is None:
+			if not value is None and int(key) in self.parameters:
 				self.parameters[int(key)].value = value
 
 	# -------------------------------------------------------------------
-	# Misc functions
+	# Port parameter counts
 
 	@property
 	def audio_in_count(self):
@@ -3211,7 +3229,7 @@ class Plugin(PatchbayClient):
 		self._ctrl_channel = value
 
 	# -------------------------------------------------------------------
-	# Functions called from GUI
+	# Functions called from outside
 
 	def mute(self):
 		"""

{simple_carla-1.2.0 → simple_carla-1.3.1}/simple_carla/qt.py

@@ -23,7 +23,7 @@ Qt -enabled classes which utilize signals rather than callbacks.
 import logging, traceback, os, sys
 import qt_extras.autofit
 from PyQt5.QtCore import QObject, pyqtSignal
-from simple_carla import _SimpleCarla, Plugin, PatchbayClient, PatchbayPort
+from simple_carla import _SimpleCarla, Plugin, PatchbayClient, PatchbayPort, PatchbayConnection
 
 from carla_backend import (
 
@@ -92,6 +92,8 @@ class CarlaQt(_SimpleCarla, QObject):
 	sig_patchbay_client_removed = pyqtSignal(PatchbayClient)
 	sig_patchbay_port_added = pyqtSignal(PatchbayPort)
 	sig_patchbay_port_removed = pyqtSignal(PatchbayPort)
+	sig_connection_added = pyqtSignal(PatchbayConnection)
+	sig_connection_removed = pyqtSignal(PatchbayConnection)
 	sig_plugin_removed = pyqtSignal(QObject)
 	sig_last_plugin_removed = pyqtSignal()
 	sig_engine_started = pyqtSignal(int, int, int, int, float, str)
@@ -298,6 +300,12 @@ class CarlaQt(_SimpleCarla, QObject):
 	def _alert_port_removed(self, port):
 		self.sig_patchbay_port_removed.emit(port)
 
+	def _alert_connection_added(self, connection):
+		self.sig_connection_added.emit(connection)
+
+	def _alert_connection_removed(self, connection):
+		self.sig_connection_removed.emit(connection)
+
 	def _alert_plugin_removed(self, plugin):
 		self.sig_plugin_removed.emit(plugin)
 
@@ -327,26 +335,23 @@ class QtPlugin(Plugin, QObject):
 	def __init__(self, plugin_def=None, saved_state=None):
 		QObject.__init__(self)
 		Plugin.__init__(self, plugin_def, saved_state)
-		self.was_removed = False
 
 	def ready(self):
 		"""
 		Called after post_embed_init() and all ports ready.
 		You can check the state of this plugin using the "Plugin.is_ready" property.
 		"""
-		#logging.debug('%s ready', self)
 		self.sig_ready.emit(self)
 
 	def got_removed(self):
-		self.was_removed = True
 		self.sig_removed.emit(self)
 
 	def input_connection_change(self, connection, state):
-		if not self.was_removed:
+		if not self.removing_from_carla:
 			self.sig_connection_change.emit(connection.in_port, connection.out_port, state)
 
 	def output_connection_change(self, connection, state):
-		if not self.was_removed:
+		if not self.removing_from_carla:
 			self.sig_connection_change.emit(connection.out_port, connection.in_port, state)