[layer titles] This is #292, give the adaptation the possibility to d…

…efine custom layer titles

The-Orm/CurrentPatchDisplay.cpp

@@ -193,8 +193,13 @@ void CurrentPatchDisplay::setupPatchProperties(std::shared_ptr<midikraft::PatchH
 	// Check if the patch is a layered patch
 	auto layers = midikraft::Capability::hasCapability<midikraft::LayeredPatchCapability>(patch->patch());
 	if (layers) {
+		auto titles = layers->layerTitles();
 		for (int i = 0; i < layers->numberOfLayers(); i++) {
-			TypedNamedValue v("Layer " + String(i), "Patch name", String(layers->layerName(i)), 20);
+			String title = "Layer " + String(i);
+			if (i < (int) titles.size()) {
+				title = titles[i];
+			}
+			TypedNamedValue v(title, "Patch name", String(layers->layerName(i)), 20);
 			metaDataValues_.push_back(std::make_shared<TypedNamedValue>(v));
 		}
 	}

adaptations/Adaptation Programming Guide.md

@@ -742,6 +742,17 @@ Optionally, if you want to allow the user to change a layer name, implement the
 
 This work like renamePatch, just with the added layerNo parameter.
 
+Optionally, you can implement this to return a list of names for the layers itself, or rather the layer titles. Without it, the
+UI will just display Layer 0, Layer 1, Layer 2, ...
+
+    def friendlyLayerTitles():
+
+To make it work, just return a list of strings like this:
+
+    def friendlyLayerTitles():
+        return ["Patch", "Upper tone", "Lower tone"]
+
+
 ## Importing categories stored in the patch in the synth
 
 Some synths store sound categories or tags. As the KnobKraft Orm has these as a central part of the UI, of course we want to be able to import them as well. It is easy enough and requires two steps: Implementing a function and then defining an import mapping.

adaptations/GenericAdaptation.cpp

@@ -60,6 +60,7 @@ namespace knobkraft {
 		* kExtractPatchesFromBank = "extractPatchesFromBank",
 		* kExtractPatchesFromAllBankMessages = "extractPatchesFromAllBankMessages",
 		* kNumberOfLayers = "numberOfLayers",
+		* kLayerTitles = "friendlyLayerTitles",
 		* kLayerName = "layerName",
 		* kSetLayerName = "setLayerName",
 		* kGeneralMessageDelay = "generalMessageDelay",

adaptations/GenericAdaptation.h

@@ -36,6 +36,7 @@ namespace knobkraft {
 		*kIsSingleProgramDump, *kIsPartOfSingleProgramDump, *kCreateProgramDumpRequest, *kConvertToProgramDump, *kNumberFromDump,
 		*kCreateBankDumpRequest, *kIsPartOfBankDump, *kIsBankDumpFinished, *kExtractPatchesFromBank, *kExtractPatchesFromAllBankMessages,
 		*kNumberOfLayers,
+		*kLayerTitles,
 		*kLayerName,
 		*kSetLayerName,
 		*kGetStoredTags

adaptations/GenericPatch.cpp

@@ -176,11 +176,37 @@ namespace knobkraft {
 		return 1;
 	}
 
+	std::vector<std::string> GenericLayeredPatchCapability::layerTitles() const {
+		py::gil_scoped_acquire acquire;
+		if (!me_.expired()) {
+			auto patch = me_.lock();
+			if (patch->pythonModuleHasFunction(kLayerTitles)) {
+				try {
+					py::object result = patch->callMethod(kLayerTitles);
+					return py::cast<std::vector<std::string>>(result);
+				}
+				catch (py::error_already_set& ex) {
+					if (!me_.expired())
+						me_.lock()->logAdaptationError(kLayerTitles, ex);
+					ex.restore();
+				}
+				catch (std::exception& ex) {
+					if (!me_.expired())
+						me_.lock()->logAdaptationError(kLayerTitles, ex);
+				}
+				catch (...) {
+					spdlog::error("Uncaught exception in {} of Patch of GenericAdaptation", kLayerTitles);
+				}
+			}
+		}
+		return {};
+	}
+
 	std::string GenericLayeredPatchCapability::layerName(int layerNo) const
 	{
 		py::gil_scoped_acquire acquire;
 		if (!me_.expired()) {
-			auto patch = me_.lock();
+			auto patch = me_.lock();			
 			try {
 				std::vector<int> v(me_.lock()->data().data(), me_.lock()->data().data() + me_.lock()->data().size());
 				py::object result = patch->callMethod(kLayerName, v, layerNo);

adaptations/GenericPatch.h

@@ -52,6 +52,7 @@ namespace knobkraft {
         virtual ~GenericLayeredPatchCapability() = default;
 		virtual LayerMode layerMode() const override;
 		virtual int numberOfLayers() const override;
+		virtual std::vector<std::string> layerTitles() const override;
 		virtual std::string layerName(int layerNo) const override;
 		virtual void setLayerName(int layerNo, std::string const& layerName) override;
 

adaptations/Roland_MKS70V4.py

@@ -981,6 +981,10 @@ def numberOfLayers(messages):
     return 3
 
 
+def friendlyLayerTitles():
+    return ["Patch", "Upper tone", "Lower tone"]
+
+
 def layerName(messages, layerNo):
     index = knobkraft.sysex.findSysexDelimiters(messages)
     if isEditBufferDump2(messages):

adaptations/sequential/GenericSequential.py

@@ -194,6 +194,9 @@ def renamePatch(self, message, new_name):
     def numberOfLayers(self, messages):
         return self.number_of_layers
 
+    def friendlyLayerTitles(self):
+        return ["Layer A", "Layer B"]
+
     def layerName(self, messages, layerNo):
         dataBlock = self.getDataBlock(messages)
         if len(dataBlock) > 0:
@@ -286,5 +289,6 @@ def install(self, module):
             setattr(module, 'friendlyProgramName', self.friendly_program_name)
         if self.number_of_layers is not None:
             setattr(module, 'numberOfLayers', self.numberOfLayers)
+            setattr(module, 'friendlyLayerTitles', self.friendlyLayerTitles)
             setattr(module, 'layerName', self.layerName)
             setattr(module, 'setLayerName', self.setLayerName)

synths/sequential-rev2/Rev2Patch.cpp

@@ -301,6 +301,10 @@ namespace midikraft {
 		return 2;
 	}
 
+	std::vector<std::string> Rev2Patch::layerTitles() const {
+		return {"Layer A", "Layer B"};
+	}
+
 	std::string Rev2Patch::layerName(int layerNo) const
 	{
 		// The Rev2 has a 20 character patch name storage for each of the 2 layers...	

synths/sequential-rev2/Rev2Patch.h

@@ -30,6 +30,7 @@ namespace midikraft {
 		// Interface for layered Patches (for the Librarian)
 		virtual LayerMode layerMode() const override;
 		virtual int numberOfLayers() const override;
+		virtual std::vector<std::string> layerTitles() const override;
 		virtual std::string layerName(int layerNo) const override;
 		virtual void setLayerName(int layerNo, std::string const &layerName) override;