simple-carla 1.3.0__tar.gz → 1.4.0__tar.gz

{simple_carla-1.3.0 → simple_carla-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: simple_carla
-Version: 1.3.0
+Version: 1.4.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 → simple_carla-1.4.0}/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.3.0"
+current_version = "1.4.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "Bump version {old_version} -> {new_version}"
 commit = true

{simple_carla-1.3.0 → simple_carla-1.4.0}/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
@@ -233,8 +233,10 @@ from carla_backend import (
 	FILE_CALLBACK_SAVE
 )
 
+from resources_rc import qCleanupResources
 
-__version__ = "1.3.0"
+
+__version__ = "1.4.0"
 
 
 # -------------------------------------------------------------------
@@ -698,6 +700,8 @@ class _SimpleCarla(CarlaHostDLL):
 		"""
 		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
@@ -1532,7 +1536,7 @@ class _SimpleCarla(CarlaHostDLL):
 		self._plugin_by_uuid[plugin.uuid] = plugin
 		if self.is_engine_running():
 			if not self._add_plugin(						# Carla parameter
-															# ---------------
+				# ----------------------------------------- # ---------------
 				plugin.plugin_def['build'],					# btype
 				plugin.plugin_def['type'],					# ptype
 				plugin.plugin_def['filename'],				# filename
@@ -1541,7 +1545,7 @@ class _SimpleCarla(CarlaHostDLL):
 				int(plugin.plugin_def['uniqueId'] or 0),	# uniqueId
 				None,										# extraPtr
 				PLUGIN_OPTIONS_NULL							# options
-															# ---------------
+				# ----------------------------------------- # ---------------
 			): raise Exception("Failed to add plugin")
 
 	# -------------------------------------------------------------------
@@ -2678,7 +2682,7 @@ class Plugin(PatchbayClient):
 	# -------------------------------------------------------------------
 	# Internal lifecycle events
 
-	def __init__(self, plugin_def=None, saved_state=None):
+	def __init__(self, plugin_def = None, saved_state = None):
 		if plugin_def is None:
 			if self.plugin_def is None:
 				raise RuntimeError("No definition for plugin")
@@ -2891,7 +2895,7 @@ class Plugin(PatchbayClient):
 				self.parameters[int(key)].value = value
 
 	# -------------------------------------------------------------------
-	# Misc functions
+	# Port parameter counts
 
 	@property
 	def audio_in_count(self):
@@ -2995,7 +2999,7 @@ class Plugin(PatchbayClient):
 
 	def parameter_internal_value_changed(self, parameter, value):
 		"""
-		Called by the Carls host engine when the internal value of a parameter has changed.
+		Called by the Carla host engine when the internal value of a parameter has changed.
 		"parameter" is a Parameter object.
 		"value" is the new value of the Parameter.
 		The value of the Parameter object will have already been set when this is called.
@@ -3227,7 +3231,7 @@ class Plugin(PatchbayClient):
 		self._ctrl_channel = value
 
 	# -------------------------------------------------------------------
-	# Functions called from GUI
+	# Functions called from outside
 
 	def mute(self):
 		"""
@@ -3305,27 +3309,17 @@ class Parameter:
 				setattr(self, k, v)
 			self.range = self.max - self.min
 
-			#logging.debug('%s min %s max %s step %s stepSmall %s stepLarge %s using unit "%s"',
-				#self.name, self.min, self.max, self.step, self.stepSmall, self.stepLarge, self.unit)
-
 			# Scale points (get_parameter_scalepoint_info) if necessary
-			self.__scale_points = {
-				sp['label']:sp['value'] \
-				for sp in [
-					carla.get_parameter_scalepoint_info(self.plugin_id, self.parameter_id, sc_idx) \
-					for sc_idx in range(self.scalePointCount)
-				]} if self.uses_scalepoints else None
-			if not self.__scale_points is None and len(self.__scale_points) > 2:
-				logging.debug('%s SCALEPOINTS USED:', str(self.plugin()))
-				with StreamToLogger() as slog:
-					print(self.__scale_points, file = slog)
+			self.scale_points = [ ( sp['label'], sp['value'] ) for sp in [
+				carla.get_parameter_scalepoint_info(self.plugin_id, self.parameter_id, sc_idx) \
+				for sc_idx in range(self.scalePointCount)
+			]] if self.uses_scalepoints else None
 
 	def internal_value_changed(self, value):
 		"""
-		Called from Carla engine when the value of this Parameter changed.
+		Called from Carla engine when the value of this Parameter changed, as by a
+		custom dialog rendered via carla.
 		"""
-		#TODO: Test if called when parameter is set, and note in docs
-		#logging.debug('internal_value_changed %s %s', self, value)
 		self.__value = value
 
 	@property
@@ -3342,19 +3336,13 @@ class Parameter:
 		Sets the value of this Parameter both in Carla and cached.
 		"value" must be in the range of this Parameter's "min" and "max".
 		"""
-		if hasattr(self, "min"):
-			if hasattr(self, "max"):
-				if self.min <= value <= self.max:
-					if self.__value != value:
-						self.__value = value
-						Carla.instance.set_parameter_value(self.plugin_id, self.parameter_id, value)
-				else:
-					logging.warning('Parameter "%s" (%s) out of range. Min: %s Max %s',
-						self.name, value, self.min, self.max)
+		if self.__value != value:
+			if self.min <= value <= self.max:
+				self.__value = value
+				Carla.instance.set_parameter_value(self.plugin_id, self.parameter_id, value)
 			else:
-				logging.debug('PLUGIN %s PARAMETER %s HAS NO max', self.plugin(), self)
-		else:
-			logging.debug('PLUGIN %s PARAMETER %s HAS NO min', self.plugin(), self)
+				logging.warning('Parameter "%s" (%s) out of range. Min: %s Max %s',
+					self.name, value, self.min, self.max)
 
 	def get_internal_value(self):
 		"""

{simple_carla-1.3.0 → simple_carla-1.4.0}/simple_carla/qt.py

@@ -22,8 +22,9 @@ 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, PatchbayConnection
+from PyQt5.QtCore import	QObject, pyqtSignal
+from simple_carla import	_SimpleCarla, Plugin, Parameter, \
+							PatchbayClient, PatchbayPort, PatchbayConnection
 
 from carla_backend import (
 
@@ -314,27 +315,36 @@ class CarlaQt(_SimpleCarla, QObject):
 
 
 
-class QtPlugin(Plugin, QObject):
+class AbstractQtPlugin(Plugin):
 	"""
-	This is an abstract class which inherits from QObject, for use by plugins which
-	have no direct user-interface, (i.e. track & channel filter instantiated by a
-	TrackWidget). (Qt does not allow inheriting from multiple classes which
-	extend QObject)
+	This is an abstract class for use by classes which you wish to inherit from a
+	class which itself already inherits from QObject.
 
-	To use:
-		plugin = QtPlugin(plugin_def)
-		plugin.sig_ready.connect(self.plugin_ready)
-		plugin.add_to_carla()
+	Qt does not allow inheriting from multiple classes which extend QObject, so
+	extending QObject in THIS class would make it impossible for you to use it as
+	a base class.
 
-	"""
+	For example:
 
-	sig_ready				= pyqtSignal(Plugin)
-	sig_removed 			= pyqtSignal(Plugin)
-	sig_connection_change	= pyqtSignal(PatchbayPort, PatchbayPort, bool)
+	class MyVisualPlugin(QFrame, AbstractQtPlugin):
 
-	def __init__(self, plugin_def=None, saved_state=None):
-		QObject.__init__(self)
-		Plugin.__init__(self, plugin_def, saved_state)
+		# You must define these signals!
+		sig_ready				= pyqtSignal(Plugin)
+		sig_removed 			= pyqtSignal(Plugin)
+		sig_connection_change	= pyqtSignal(PatchbayPort, PatchbayPort, bool)
+		sig_parameter_changed	= pyqtSignal(Plugin, Parameter, float)
+
+		plugin_def = {...}
+
+		def __init__(self, parent, plugin_def, saved_state = None):
+			QFrame.__init__(self, parent)
+			AbstractQtPlugin.__init__(self, plugin_def, saved_state)
+
+	plugin = MyVisualPlugin()
+	plugin.sig_ready.connect(self.plugin_ready)
+	plugin.add_to_carla()
+	layout.addWidget(plugin)
+	"""
 
 	def ready(self):
 		"""
@@ -354,5 +364,40 @@ class QtPlugin(Plugin, QObject):
 		if not self.removing_from_carla:
 			self.sig_connection_change.emit(connection.out_port, connection.in_port, state)
 
+	def parameter_internal_value_changed(self, parameter, value):
+		"""
+		Called by the Carla host engine when the internal value of a parameter has changed.
+		"parameter" is a Parameter object.
+		"value" is the new value of the Parameter.
+
+		The value of the Parameter object will have already been set when this is called.
+		"""
+		self.sig_parameter_changed.emit(self, parameter, value)
+
+
+
+class QtPlugin(AbstractQtPlugin, QObject):
+	"""
+	A class which inherits from both Plugin and QObject. It can be used by plugins
+	which have no direct user-interface, but still need to emit signals.
+
+	For example:
+
+	plugin = QtPlugin(plugin_def)
+	plugin.sig_ready.connect(self.plugin_ready)
+	plugin.add_to_carla()
+
+	"""
+
+	sig_ready				= pyqtSignal(Plugin)
+	sig_removed 			= pyqtSignal(Plugin)
+	sig_connection_change	= pyqtSignal(PatchbayPort, PatchbayPort, bool)
+	sig_parameter_changed	= pyqtSignal(Plugin, Parameter, float)
+
+	def __init__(self, plugin_def=None, saved_state=None):
+		QObject.__init__(self)
+		Plugin.__init__(self, plugin_def, saved_state)
+
+
 
 #  end simple_carla/qt.py