simple-carla 2.1.2__tar.gz → 2.3.0__tar.gz

{simple_carla-2.1.2 → simple_carla-2.3.0}/PKG-INFO

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

{simple_carla-2.1.2 → simple_carla-2.3.0}/simple_carla/__init__.py

@@ -240,7 +240,7 @@ from carla_backend import (
 )
 
 
-__version__ = "2.1.2"
+__version__ = "2.3.0"
 
 
 # -------------------------------------------------------------------
@@ -286,7 +286,7 @@ class _SimpleCarla(CarlaHostDLL):
 	Inherited by: Carla, CarlaQt
 	"""
 
-	idle_interval		= 1 / 50
+	idle_interval		= 1 / 20
 	instance			= None
 	client_name			= None
 	_autoload_plugin	= None
@@ -310,9 +310,10 @@ class _SimpleCarla(CarlaHostDLL):
 			self._plugins			= {}	# Plugin, indexed on Carla -generated "plugin_id"
 			self._clients			= {}	# PatchbayClient, indexed on Carla -generated "client_id"
 			self._sys_clients		= {}	# SystemPatchbayClient, indexed on "client_name"
-			self._connections		= {}	# PatchbayConnection, indexed on Carla -generated "connection_id"
-			self._plugin_by_uuid	= {}	# Plugin, indexed on "uuid", used for identifying plugin during instantiation
-			self._uuid				= 0		# Current "uuid", incremented sequentially
+			self._connections		= {}	# PatchbayConnection,
+											# indexed on Carla -generated "connection_id"
+			self._plugin_by_uuid	= {}	# Plugin, indexed on "unique_name",
+											# used for identifying plugin during instantiation
 			libname = "libcarla_standalone2.so"
 			CarlaHostDLL.__init__(self, os.path.join(carla_binaries_path, libname), False)
 
@@ -1281,13 +1282,14 @@ class _SimpleCarla(CarlaHostDLL):
 	def cb_plugin_added(self, plugin_id, plugin_type, carla_plugin_name):
 		"""
 		After Carla adds a plugin, it signals this with an assigned plugin_id. This
-		function uses the uuid given to the Plugin by this class to retrieve the
+		function uses the unique_name given to the Plugin by this class to retrieve the
 		plugin from the "_plugin_by_uuid" dict, and add the association with the plugin_id in
 		the "_plugins" dict.
 		"""
 		if plugin_id in self._plugins:
 			logging.error('cb_plugin_added: Cannot add plugin %s', plugin_id)
-			logging.error('"%s" - plugin %s already in _plugins"', carla_plugin_name, self._plugins[plugin_id])
+			logging.error('"%s" - plugin %s already in _plugins"',
+				carla_plugin_name, self._plugins[plugin_id])
 			return
 		if carla_plugin_name in self._plugin_by_uuid:
 			self._plugins[plugin_id] = self._plugin_by_uuid[carla_plugin_name]
@@ -1299,11 +1301,11 @@ class _SimpleCarla(CarlaHostDLL):
 	def cb_plugin_removed(self, plugin_id):
 		if plugin_id in self._plugins:
 			plugin = self._plugins[plugin_id]
-			if plugin.uuid in self._plugin_by_uuid:
-				del self._plugin_by_uuid[plugin.uuid]
+			if plugin.unique_name in self._plugin_by_uuid:
+				del self._plugin_by_uuid[plugin.unique_name]
 			else:
-				logging.error('cb_plugin_removed: "%s" uuid %s not in self._plugin_by_uuid',
-					plugin, plugin.uuid)
+				logging.error('cb_plugin_removed: "%s" unique_name %s not in self._plugin_by_uuid',
+					plugin, plugin.unique_name)
 			self._alert_plugin_removed(plugin)
 			# Renumber plugins per Carla plugin_id conventions:
 			for i in range(plugin_id, len(self._plugins) - 1):
@@ -1512,14 +1514,14 @@ class _SimpleCarla(CarlaHostDLL):
 	# ================================================================================
 
 	def add_plugin(self, plugin):
-		self._plugin_by_uuid[plugin.uuid] = plugin
+		self._plugin_by_uuid[plugin.unique_name] = 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
-				plugin.uuid,								# name
+				plugin.unique_name,								# name
 				plugin.plugin_def['label'],					# label
 				int(plugin.plugin_def['uniqueId'] or 0),	# uniqueId
 				None,										# extraPtr
@@ -1553,12 +1555,12 @@ class _SimpleCarla(CarlaHostDLL):
 			return  self._plugins[plugin_id]
 		raise IndexError()
 
-	def plugin_from_uuid(self, uuid):
+	def plugin_from_uuid(self, unique_name):
 		"""
 		Returns plugin.
-		"uuid" is the uuid property of a Plugin object, generated by this class.
+		"unique_name" is the unique_name property of a Plugin object, generated by this class.
 		"""
-		return self._plugin_by_uuid[uuid] if uuid in self._plugin_by_uuid else None
+		return self._plugin_by_uuid[unique_name] if unique_name in self._plugin_by_uuid else None
 
 	def client(self, client_id):
 		"""
@@ -1705,7 +1707,7 @@ class _SimpleCarla(CarlaHostDLL):
 		"""
 		if not self.patchbay_connect(True, port1.client_id, port1.port_id,
 			port2.client_id, port2.port_id):
-			logging.error('Patchbay connect FAILED! %s -> %s', port1, port2)
+			raise RuntimeError('Patchbay connect FAILED! %s -> %s', port1, port2)
 
 	# -------------------------------------------------------------------
 	# Plugin filename autoload trick
@@ -1793,26 +1795,21 @@ class _SimpleCarla(CarlaHostDLL):
 		return None
 
 	# -------------------------------------------------------------------
-	# Plugin autogenerate uuid / moniker helper
+	# Plugin autogenerate unique_name / moniker helper
 
-	def provide_identity(self, plugin):
+	def get_unique_name(self, plugin):
 		"""
-		Helper function which generates a unique "uuid" string for internal plugin
-		identification, and a unique "moniker" for human-readable identification.
+		Generates a "unique_name" string for internal plugin identification.
 		"""
-		self._uuid += 1
-		plugin.uuid = '%03d' % self._uuid
-		while plugin.uuid in self._plugin_by_uuid:
-			self._uuid += 1
-			plugin.uuid = '%03d' % self._uuid
-		monikers = [ existing_plugin.moniker \
+		unique_names = [ existing_plugin.unique_name \
 			for existing_plugin in self._plugin_by_uuid.values() \
 			if existing_plugin.original_plugin_name == plugin.original_plugin_name ]
-		idx = 1
-		plugin.moniker = '{} {}'.format(plugin.original_plugin_name, idx)
-		while plugin.moniker in monikers:
+		idx = len(unique_names) + 1
+		unique_name = f'{plugin.original_plugin_name} {idx}'
+		while unique_name in unique_names:
 			idx += 1
-			plugin.moniker = '{} {}'.format(plugin.original_plugin_name, idx)
+			unique_name = f'{plugin.original_plugin_name} {idx}'
+		return unique_name
 
 
 class Carla(_SimpleCarla):
@@ -2385,6 +2382,22 @@ class PatchbayClient:
 		"""
 		return self._exclusive_clients(self.input_ports())
 
+	def audio_input_clients(self):
+		"""
+		Returns list of PatchbayClient.
+		Return all clients which are connected to all of this PatchbayClient's audio input ports.
+		(May return classes extending PatchbayClient, i.e. SystemPatchbayClient / Plugin)
+		"""
+		return self._exclusive_clients(self.audio_ins())
+
+	def midi_input_clients(self):
+		"""
+		Returns list of PatchbayClient.
+		Return all clients which are connected to all of this PatchbayClient's midi input ports.
+		(May return classes extending PatchbayClient, i.e. SystemPatchbayClient / Plugin)
+		"""
+		return self._exclusive_clients(self.midi_ins())
+
 	def output_clients(self):
 		"""
 		Returns list of PatchbayClient.
@@ -2393,11 +2406,27 @@ class PatchbayClient:
 		"""
 		return self._exclusive_clients(self.output_ports())
 
+	def audio_output_clients(self):
+		"""
+		Returns list of PatchbayClient.
+		Return all clients which are connected to all of this PatchbayClient's audio output ports.
+		(May return classes extending PatchbayClient, i.e. SystemPatchbayClient / Plugin)
+		"""
+		return self._exclusive_clients(self.audio_outs())
+
+	def midi_output_clients(self):
+		"""
+		Returns list of PatchbayClient.
+		Return all clients which are connected to all of this PatchbayClient's midi output ports.
+		(May return classes extending PatchbayClient, i.e. SystemPatchbayClient / Plugin)
+		"""
+		return self._exclusive_clients(self.midi_outs())
+
 	def _exclusive_clients(self, ports):
 		"""
 		Returns list of PatchbayClient.
 		Implements the reduction of port clients to an exlusive set.
-		Used by both "input_clients" and "output_clients" functions.
+		Used by "input_clients", "audio_input_clients", "output_clients", etc.
 		"""
 		return list(set( [
 			client \
@@ -2685,7 +2714,7 @@ class Plugin(PatchbayClient):
 	_cb_ready			= None
 	_cb_removed			= None
 
-	_save_state_keys	= [	'uuid', 'moniker',
+	_save_state_keys	= [	'unique_name', 'moniker',
 							'active', 'volume', 'dry_wet', 'panning', 'balance_left', 'balance_right',
 							'prefer_generic_dialog', 'send_all_sound_off', 'send_channel_pressure', 'send_control_changes',
 							'send_note_aftertouch', 'send_pitchbend', 'send_program_changes', 'skip_sending_notes', 'force_stereo' ]
@@ -2732,11 +2761,8 @@ class Plugin(PatchbayClient):
 		self.parameters				= {}								# Parameter objects. Key is parameter_id.
 		self._midi_notes			= np_zeros((16, 128), dtype=bool)	# array for determining whether midi active.
 
-		if saved_state is None:
-			Carla.instance.provide_identity(self)
-		else:
-			self.uuid = saved_state["vars"]["uuid"]
-			self.moniker = saved_state["vars"]["moniker"]
+		self.unique_name = Carla.instance.get_unique_name(self)
+		self.moniker = self.unique_name if saved_state is None else saved_state["vars"]["moniker"]
 
 	def add_to_carla(self):
 		"""
@@ -2913,7 +2939,7 @@ class Plugin(PatchbayClient):
 				self.parameters[int(key)].value = value
 
 	# -------------------------------------------------------------------
-	# Port parameter counts
+	# Port counts
 
 	@property
 	def audio_in_count(self):
@@ -2943,19 +2969,8 @@ class Plugin(PatchbayClient):
 		"""
 		return self._midi_out_count
 
-	@property
-	def input_parameter_count(self):
-		"""
-		Returns (int)
-		"""
-		return len(self.input_parameters())
-
-	@property
-	def output_parameter_count(self):
-		"""
-		Returns (int)
-		"""
-		return len(self.output_parameters())
+	# -------------------------------------------------------------------
+	# Peaks
 
 	@property
 	def peak_mono(self):
@@ -2978,6 +2993,23 @@ class Plugin(PatchbayClient):
 		"""
 		return Carla.instance.get_input_peak_value(self.plugin_id, False)
 
+	# -------------------------------------------------------------------
+	# Parameters
+
+	@property
+	def input_parameter_count(self):
+		"""
+		Returns (int)
+		"""
+		return len(self.input_parameters())
+
+	@property
+	def output_parameter_count(self):
+		"""
+		Returns (int)
+		"""
+		return len(self.output_parameters())
+
 	def input_parameters(self):
 		"""
 		Returns a list of Parameter objects.
@@ -2990,9 +3022,22 @@ class Plugin(PatchbayClient):
 		"""
 		return [ param for param in self.parameters.values() if param.is_used and param.is_output ]
 
+	def parameter(self, name):
+		"""
+		Returns the parameter with the given (str) "name"
+
+		Raises IndexError
+		"""
+		for param in self.parameters.values():
+			if param.name == name:
+				return param
+		raise IndexError
+
+	# -------------------------------------------------------------------
+	# Str
+
 	def __str__(self):
-		return '<{0} "{1}" (uuid {2}, client_id {3})>'.format(
-			type(self).__name__, self.moniker, self.uuid, self.client_id)
+		return f'<{type(self).__name__} "{self.unique_name}" (client_id {self.client_id})>'
 
 	# -------------------------------------------------------------------
 	# Functions called from Carla engine callbacks:
@@ -3462,8 +3507,13 @@ class Parameter:
 		return '<Parameter [{0}] "{1}" {2} {3} value: {4}>'.format(
 			self.index,
 			self.name,
-			("input" if self.is_input else "output" if self.is_output else "unused"),
-			("integer" if self.is_integer else "Bool" if self.is_boolean else "log" if self.is_logarithmic else "float"),
+			("input" if self.is_input \
+				else "output" if self.is_output \
+				else "unused"),
+			("integer" if self.is_integer \
+				else "Bool" if self.is_boolean \
+				else "log" if self.is_logarithmic \
+				else "float"),
 			self.__value
 		)