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

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

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

{simple_carla-1.4.0 → simple_carla-1.5.0}/simple_carla/__init__.py

@@ -233,10 +233,8 @@ from carla_backend import (
 	FILE_CALLBACK_SAVE
 )
 
-from resources_rc import qCleanupResources
 
-
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 
 
 # -------------------------------------------------------------------
@@ -285,8 +283,9 @@ class _SimpleCarla(CarlaHostDLL):
 	idle_interval		= 1 / 50
 	instance			= None
 	client_name			= None
-	__autoload_plugin	= None
-	__autoload_filename	= None
+	_autoload_plugin	= None
+	_autoload_filename	= None
+	_cptr_filename		= None # Pointer which is held onto so as not to get segfaults
 
 	# -------------------------------------------------------------------
 	# Singleton instantiation
@@ -296,14 +295,6 @@ class _SimpleCarla(CarlaHostDLL):
 			cls.instance = Carla.instance = super().__new__(cls)
 		return cls.instance
 
-	@classmethod
-	def delete(cls):
-		"""
-		Close the engine and delete the current instance to avoid hanging when exiting.
-		"""
-		cls.instance.engine_close()
-		cls.instance = Carla.instance = None
-
 	def __init__(self, client_name):
 		"""
 		client_name is the name which appears in JACK audio connection kit.
@@ -324,6 +315,8 @@ class _SimpleCarla(CarlaHostDLL):
 			self.lib.carla_set_engine_callback(self.handle, self._engine_callback, None)
 			self._file_callback = FileCallbackFunc(self.file_callback)
 			self.lib.carla_set_file_callback(self.handle, self._file_callback, None)
+			self._open_file_callback = None
+			self._save_file_callback = None
 
 			self.audioDriverForced = "JACK"
 			self.forceStereo = False
@@ -356,6 +349,14 @@ 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)
 
+	@classmethod
+	def delete(cls):
+		"""
+		Close the engine and delete the current instance to avoid hanging when exiting.
+		"""
+		cls.instance.engine_close()
+		cls.instance = Carla.instance = None
+
 	# -------------------------------------------------------------------
 	# Engine control / idle loop
 
@@ -372,13 +373,6 @@ class _SimpleCarla(CarlaHostDLL):
 			return True
 		return False
 
-	def set_ui_parent(self, window):
-		"""
-		Set the parent window of dialogs opened by the Carla engine.
-		Not needed if the file open dialog will not be needed.
-		"""
-		self._file_callback_parent = window
-
 	def engine_idle(self):
 		"""
 		Overrides CarlaHostDLL engine_idle() function, as this is handled internally.
@@ -1720,34 +1714,74 @@ class _SimpleCarla(CarlaHostDLL):
 		liquidsfz does not have an input file parameter, but instead, requests the host to display an open file dialog from which the user may select an SFZ file to load. This function triggers the plugin's host gui display which will call __file_callback(). When there is a plugin to autoload on deck, __file_callback() will return the "autoload_filename" property of the plugin, instead of showing the file open dialog and returning the result.
 
 		"""
-		if self.__autoload_plugin is not None:
-			raise Exception("Cannot set autoload plugin as it is already used by " + self.__autoload_plugin)
-		self.__autoload_plugin = plugin
-		self.__autoload_filename = filename
+		if self._autoload_plugin is not None:
+			raise Exception("Cannot set autoload plugin as it is already used by " + self._autoload_plugin)
+		self._autoload_plugin = plugin
+		self._autoload_filename = filename
 		#logging.debug('Autoloading "%s"', filename)
 		self.show_custom_ui(plugin.plugin_id, True)
-		self.__autoload_plugin = None
-		self.__autoload_filename = None
+		self._autoload_plugin = None
+		self._autoload_filename = None
 		if callable(callback):
 			callback()
 
-	def file_callback(self, ptr, action, is_dir, title, filter):
-		if self.__autoload_plugin is None:
-			if self._file_callback_parent is None:
-				raise Exception("Cannot open file dialog without parent window (see Carla.set_ui_parent)")
-			title  = charPtrToString(title)
+	def set_open_file_callback(self, callback):
+		"""
+		Set the callback function that Carla will call when it needs a file name.
+
+		The callback must have this signature:
+
+			def funct(self, caption: str, filter: str)
+
+		A typical implementation in Qt might be:
+
+			carla.set_open_file_callback(self.open_file_dialog)
+
+			def open_file_dialog(self, caption, filter):
+				filename, ok = QFileDialog.getOpenFileName(self, caption, "", filter)
+				return filename if ok else None
+
+		"""
+		self._open_file_callback = callback
+
+	def set_save_file_callback(self, callback):
+		"""
+		Set the callback function that Carla will call when it needs a file name.
+
+		The callback must have this signature:
+
+			def funct(self, caption: str, filter: str, dirs_only: bool)
+
+		A typical implementation in Qt might be:
+
+			carla.set_save_file_callback(self.save_file_dialog)
+
+			def save_file_dialog(self, caption, filter):
+				filename, ok = QFileDialog.getOpenFileName(self, caption, "", filter)
+				return filename if ok else None
+
+		"""
+		self._save_file_callback = callback
+
+	def file_callback(self, ptr, action, dirs_only, caption, filter):
+		if self._autoload_plugin is None:
+			caption  = charPtrToString(caption)
 			filter = charPtrToString(filter)
 			if action == FILE_CALLBACK_OPEN:
-				ret, ok = QFileDialog.getOpenFileName(self._file_callback_parent, title, "", filter)
+				if self._open_file_callback is None:
+					raise RuntimeError('Carla wants to open a file, but no callback function is defined')
+				str_filename = self._open_file_callback(caption, filter)
 			elif action == FILE_CALLBACK_SAVE:
-				ret, ok = QFileDialog.getSaveFileName(self._file_callback_parent, title, "", filter, QFileDialog.ShowDirsOnly if is_dir else 0x0)
+				if self._save_file_callback is None:
+					raise RuntimeError('Carla wants to open a file, but no callback function is defined')
+				str_filename = self._save_file_callback(caption, filter)
 			else:
 				return None
 		else:
-			ret = self.__autoload_filename
-		if ret:
-			return_file = c_char_p(ret.encode("utf-8"))
-			retval = cast(byref(return_file), POINTER(c_uintptr))
+			str_filename = self._autoload_filename
+		if str_filename:
+			self._cptr_filename = c_char_p(str_filename.encode("utf-8"))
+			retval = cast(byref(self._cptr_filename), POINTER(c_uintptr))
 			return retval.contents.value
 		return None
 
@@ -2663,7 +2697,6 @@ class Plugin(PatchbayClient):
 	"""
 
 	plugin_def			= None
-	has_user_interface	= False
 
 	_cb_ready			= None
 	_cb_removed			= None
@@ -2737,6 +2770,13 @@ class Plugin(PatchbayClient):
 
 		carla = Carla.instance
 
+		counts = carla.get_audio_port_count_info(self.plugin_id)
+		self._audio_in_count = counts['ins']
+		self._audio_out_count = counts['outs']
+		counts = carla.get_midi_port_count_info(self.plugin_id)
+		self._midi_in_count = counts['ins']
+		self._midi_out_count = counts['outs']
+
 		# basic info
 		# 'type', 'category', 'hints', 'optionsAvailable', 'optionsEnabled', 'filename', 'name', 'label', 'maker', 'copyright', 'iconName', 'uniqueId'
 		info = carla.get_plugin_info(self.plugin_id)
@@ -2785,13 +2825,6 @@ class Plugin(PatchbayClient):
 			with StreamToLogger() as slog:
 				print(carla.get_chunk_data(self.plugin_id), file = slog)
 
-		counts = carla.get_audio_port_count_info(self.plugin_id)
-		self._audio_in_count = counts['ins']
-		self._audio_out_count = counts['outs']
-		counts = carla.get_midi_port_count_info(self.plugin_id)
-		self._midi_in_count = counts['ins']
-		self._midi_out_count = counts['outs']
-
 		# Parameters
 		for parameter_id in range(carla.get_parameter_count(self.plugin_id)):
 			param = Parameter(self.plugin_id, parameter_id)

{simple_carla-1.4.0 → simple_carla-1.5.0}/simple_carla/plugin_dialog.py

@@ -11,6 +11,7 @@ import sys, os
 from simple_carla import carla_binaries_path
 from carla_frontend import CarlaFrontendLib
 from carla_shared import DLL_EXTENSION
+from resources_rc import qCleanupResources
 
 
 class CarlaPluginDialog():