Merge PR falkTX#2020: add support for parameter labels when running as a plugin

Author: Milkii Brewster

source/backend/engine/CarlaEngineNative.cpp

@@ -589,6 +589,9 @@ class CarlaEngineNative : public CarlaEngine
                 CARLA_SAFE_ASSERT_RETURN(fUiServer.writeEmptyMessage(),);
             }
 
+            std::snprintf(tmpBuf, STR_MAX, "%i\n", plugin->getParameterScalePointCount(i));
+            CARLA_SAFE_ASSERT_RETURN(fUiServer.writeMessage(tmpBuf),);
+
             std::snprintf(tmpBuf, STR_MAX, "PARAMETER_RANGES_%i:%i\n", pluginId, i);
             CARLA_SAFE_ASSERT_RETURN(fUiServer.writeMessage(tmpBuf),);
 
@@ -606,6 +609,20 @@ class CarlaEngineNative : public CarlaEngine
 
             std::snprintf(tmpBuf, STR_MAX, "%.12g\n", static_cast<double>(plugin->getParameterValue(i)));
             CARLA_SAFE_ASSERT_RETURN(fUiServer.writeMessage(tmpBuf),);
+
+            for (uint32_t p = 0; p < plugin->getParameterScalePointCount(i); p++) {
+                std::snprintf(tmpBuf, STR_MAX, "PARAMETER_SCALEPOINT_%i:%i:%i\n", pluginId, i, p);
+                CARLA_SAFE_ASSERT_RETURN(fUiServer.writeMessage(tmpBuf),);
+
+                std::snprintf(tmpBuf, STR_MAX, "%.12g\n", plugin->getParameterScalePointValue(i, p));
+                CARLA_SAFE_ASSERT_RETURN(fUiServer.writeMessage(tmpBuf),);
+
+                if (plugin->getParameterScalePointLabel(i, p, tmpBuf)) {
+                    CARLA_SAFE_ASSERT_RETURN(fUiServer.writeAndFixMessage(tmpBuf),);
+                } else {
+                    CARLA_SAFE_ASSERT_RETURN(fUiServer.writeEmptyMessage(),);
+                }
+            }
         }
 
         fUiServer.syncMessages();

source/frontend/carla-plugin

@@ -280,14 +280,15 @@ class CarlaMiniW(ExternalUI, HostWindow):
             paramUnit = self.readlineblock()
             paramComment = self.readlineblock()
             paramGroupName = self.readlineblock()
+            scalePointCount = int(self.readlineblock())
 
             paramInfo = {
                 'name': paramName,
                 'symbol': "",
                 'unit': paramUnit,
                 'comment': paramComment,
                 'groupName': paramGroupName,
-                'scalePointCount': 0,
+                'scalePointCount': scalePointCount,
             }
             self.host._set_parameterInfo(pluginId, paramId, paramInfo)
 
@@ -317,6 +318,12 @@ class CarlaMiniW(ExternalUI, HostWindow):
             }
             self.host._set_parameterRanges(pluginId, paramId, paramRanges)
 
+        elif msg.startswith("PARAMETER_SCALEPOINT_"):
+            pluginId, param, point = [int(i) for i in msg.replace("PARAMETER_SCALEPOINT_", "").split(":")]
+            value = float(self.readlineblock())
+            label = self.readlineblock()
+            self.host._set_parameterScalePoint(pluginId, param, point, value, label)
+
         elif msg.startswith("PROGRAM_COUNT_"):
             pluginId, count, current = [int(i) for i in msg.replace("PROGRAM_COUNT_", "").split(":")]
             self.host._set_programCount(pluginId, count)

source/frontend/carla_backend.py

@@ -3285,6 +3285,7 @@ def clear(self):
         self.parameterData   = []
         self.parameterRanges = []
         self.parameterValues = []
+        self.parameterScalePoints = []
         self.programCount   = 0
         self.programCurrent = -1
         self.programNames   = []
@@ -3497,7 +3498,7 @@ def get_parameter_info(self, pluginId, parameterId):
         return self.fPluginsInfo.get(pluginId, self.fFallbackPluginInfo).parameterInfo[parameterId]
 
     def get_parameter_scalepoint_info(self, pluginId, parameterId, scalePointId):
-        return PyCarlaScalePointInfo
+        return self.fPluginsInfo.get(pluginId, self.fFallbackPluginInfo).parameterScalePoints[parameterId][scalePointId]
 
     def get_parameter_data(self, pluginId, parameterId):
         return self.fPluginsInfo.get(pluginId, self.fFallbackPluginInfo).parameterData[parameterId]
@@ -3778,13 +3779,34 @@ def _set_parameterCountInfo(self, pluginId, count, info):
         plugin.parameterData  = []
         plugin.parameterRanges = []
         plugin.parameterValues = []
+        plugin.parameterScalePoints = []
 
         # add placeholders
         for _ in range(count):
             plugin.parameterInfo.append(PyCarlaParameterInfo.copy())
             plugin.parameterData.append(PyParameterData.copy())
             plugin.parameterRanges.append(PyParameterRanges.copy())
             plugin.parameterValues.append(0.0)
+            plugin.parameterScalePoints.append([])
+
+    def _set_parameterScalePoint(self, pluginId, param, point, value, label):
+        plugin = self.fPluginsInfo.get(pluginId, None)
+        if plugin is None:
+            print("_set_parameterScalePointCount failed for", pluginId)
+            return
+
+        if param < 0 or param >= plugin.parameterCount:
+            print("_set_parameterScalePointCount failed for parameter", param)
+            return
+
+        if point < 0 or point >= plugin.parameterInfo[param]["scalePointCount"]:
+            print("_set_parameterScalePointCount failed for scale point", point)
+            return
+
+        plugin.parameterScalePoints[param][point] = {
+            "value": value,
+            "label": label,
+        }
 
     def _set_programCount(self, pluginId, count):
         plugin = self.fPluginsInfo.get(pluginId, None)
@@ -3823,6 +3845,11 @@ def _set_parameterInfo(self, pluginId, paramIndex, info):
         else:
             print("_set_parameterInfo failed for", pluginId, "and index", paramIndex)
 
+        # add placeholders
+        plugin.parameterScalePoints[paramIndex] = []
+        for _ in range(info["scalePointCount"]):
+            plugin.parameterScalePoints[paramIndex].append({})
+
     def _set_parameterData(self, pluginId, paramIndex, data):
         plugin = self.fPluginsInfo.get(pluginId, None)
         if plugin is None: