simple-carla 1.1.2__py2.py3-none-any.whl → 1.3.0__py2.py3-none-any.whl

simple_carla/__init__.py

@@ -234,7 +234,7 @@ from carla_backend import (
 )
 
 
-__version__ = "1.1.2"
+__version__ = "1.3.0"
 
 
 # -------------------------------------------------------------------
@@ -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,7 +690,8 @@ 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):
@@ -1515,6 +1506,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 +1518,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 +1782,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 +1814,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 +2072,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 +2096,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 +2529,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 +2691,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 +2853,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,7 +2887,7 @@ 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
 
 	# -------------------------------------------------------------------

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)
 
 

simple_carla/scripts/sc_plugin_def.py

@@ -0,0 +1,69 @@
+#  simple_carla/scripts/sc_plugin_def.py
+#
+#  Copyright 2025 Leon Dionne <ldionne@dridesign.sh.cn>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+#  MA 02110-1301, USA.
+#
+"""
+Allows the user to select a plugin using Carla's plugin dialog and writes it's
+plugin_def usable by simple_carla.Plugin to STDOUT.
+"""
+import argparse, logging, sys
+from pretty_repr import Repr
+from PyQt5.QtWidgets import QApplication, QMainWindow
+from PyQt5.QtCore import QTimer
+from simple_carla.plugin_dialog import CarlaPluginDialog
+
+ESSENTIALS = ['name', 'build', 'type', 'filename', 'label', 'uniqueId']
+
+
+class MainWindow(QMainWindow):
+
+	def __init__(self, options):
+		super().__init__()
+		self.options = options
+
+	def show_dialog(self):
+		self.plugin_def = CarlaPluginDialog(self).exec_dialog()
+		if self.plugin_def is not None:
+			if self.options.full:
+				print(Repr(self.plugin_def))
+			else:
+				print(Repr({ k:self.plugin_def[k] for k in ESSENTIALS }))
+		self.close()
+
+def main():
+	p = argparse.ArgumentParser()
+	p.epilog = __doc__
+	p.add_argument("--full", "-f", action="store_true",
+		help="Spit out the full plugin definition.")
+	p.add_argument("--verbose", "-v", action="store_true",
+		help="Show detailed debug information")
+	options = p.parse_args()
+	logging.basicConfig(
+		level = logging.DEBUG if options.verbose else logging.ERROR,
+		format = "[%(filename)24s:%(lineno)-4d] %(levelname)-8s %(message)s"
+	)
+	app = QApplication([])
+	window = MainWindow(options)
+	window.show_dialog()
+
+
+if __name__ == "__main__":
+	main()
+
+
+#  end simple_carla/scripts/sc_plugin_def.py

{simple_carla-1.1.2.dist-info → simple_carla-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: simple_carla
-Version: 1.1.2
+Version: 1.3.0
 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

simple_carla-1.3.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+simple_carla/__init__.py,sha256=97L9pDoBy0vBjuZv1am1HmLuIDico4s4qNpsow5yUyw,107952
+simple_carla/plugin_dialog.py,sha256=AHbEC-Sq_28QcJgZ-2gKJBaVEfa4-dEVQFvX9_7tYuk,1455
+simple_carla/qt.py,sha256=It4X0hc57Lk-1ve1CX77Co503FWsxCaO7Ot9ynuDszQ,12618
+simple_carla/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+simple_carla/scripts/sc_plugin_def.py,sha256=CVseichHuDCmGeD8v7CfHweeyHHXI60-RcvzU8OILqo,2214
+simple_carla-1.3.0.dist-info/entry_points.txt,sha256=oqJRVQXTCIUOmspGNnqDWq9mhz397uoRMQQOhBFbIcs,73
+simple_carla-1.3.0.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
+simple_carla-1.3.0.dist-info/WHEEL,sha256=j3d_2VkBU36k09xOc4O9RZyJJ8uFqn4BR2AtKD7MOp8,99
+simple_carla-1.3.0.dist-info/METADATA,sha256=8fjaucaoTHwJ0KuL0zIvdmBjA2ms2D8VuK5PYL77kAE,1717
+simple_carla-1.3.0.dist-info/RECORD,,

simple_carla-1.3.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+sc-plugin-def=simple_carla.scripts.sc_plugin_def:main
+

simple_carla-1.1.2.dist-info/RECORD

@@ -1,7 +0,0 @@
-simple_carla/__init__.py,sha256=Ml_f1koyl8q70R_lPB4fSGPYB06zvUrFdbwx3dyrCVw,107403
-simple_carla/plugin_dialog.py,sha256=AHbEC-Sq_28QcJgZ-2gKJBaVEfa4-dEVQFvX9_7tYuk,1455
-simple_carla/qt.py,sha256=PMxfLEwdbU5Xkx8q-91MIxoylQ6oWE0QMPdKcC1FE8o,12366
-simple_carla-1.1.2.dist-info/LICENSE,sha256=ljOS4DjXvqEo5VzGfdaRwgRZPbNScGBmfwyC8PChvmQ,32422
-simple_carla-1.1.2.dist-info/WHEEL,sha256=j3d_2VkBU36k09xOc4O9RZyJJ8uFqn4BR2AtKD7MOp8,99
-simple_carla-1.1.2.dist-info/METADATA,sha256=cSxUt39SUPDU68T4AuAGoKlPDHjKealCm7uhwyi4bL4,1717
-simple_carla-1.1.2.dist-info/RECORD,,