Initial work for host-visible state

Signed-off-by: falkTX <falktx@falktx.com>
DISTRHO · Feb 1, 2022 · 7e6e3cc · 7e6e3cc
1 parent e9f41ad
commit 7e6e3cc
Show file tree

Hide file tree

Showing 6 changed files with 167 additions and 88 deletions.
diff --git a/distrho/DistrhoPlugin.hpp b/distrho/DistrhoPlugin.hpp
@@ -1,6 +1,6 @@
 /*
  * DISTRHO Plugin Framework (DPF)
- * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+ * Copyright (C) 2012-2022 Filipe Coelho <falktx@falktx.com>
  *
  * Permission to use, copy, modify, and/or distribute this software for any purpose with
  * or without fee is hereby granted, provided that the above copyright notice and this
@@ -135,6 +135,29 @@ static const uint32_t kParameterIsTrigger = 0x20 | kParameterIsBoolean;
 
 /** @} */
 
+/* ------------------------------------------------------------------------------------------------------------
+ * State Hints */
+
+/**
+   @defgroup StateHints State Hints
+
+   Various state hints.
+   @see Plugin::getStateHints
+   @{
+ */
+
+/**
+   State is available for the host to see and change.
+ */
+static const uint32_t kStateIsHostVisible = 0x01;
+
+/**
+   State is a filename path.
+ */
+static const uint32_t kStateIsFilenamePath = 0x02 | kStateIsHostVisible;
+
+/** @} */
+
 /* ------------------------------------------------------------------------------------------------------------
  * Base Plugin structs */
 
@@ -993,13 +1016,17 @@ class Plugin
       Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.
     */
     virtual void initState(uint32_t index, String& stateKey, String& defaultStateValue);
-#endif
 
-#if DISTRHO_PLUGIN_WANT_STATEFILES
    /**
-      TODO API under construction
+      TODO API under construction, should likely be put in a new State struct with key, name defValue and hints
+      Returns StateHints mask.
     */
-    virtual bool isStateFile(uint32_t index) = 0;
+    virtual uint32_t getStateHints(uint32_t index);
+#endif
+
+#if DISTRHO_PLUGIN_WANT_STATEFILES
+    DISTRHO_DEPRECATED_BY("getStateHints")
+    virtual bool isStateFile(uint32_t index) { return false; }
 #endif
 
    /* --------------------------------------------------------------------------------------------------------

diff --git a/distrho/src/DistrhoPlugin.cpp b/distrho/src/DistrhoPlugin.cpp
@@ -1,6 +1,6 @@
 /*
  * DISTRHO Plugin Framework (DPF)
- * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+ * Copyright (C) 2012-2022 Filipe Coelho <falktx@falktx.com>
  *
  * Permission to use, copy, modify, and/or distribute this software for any purpose with
  * or without fee is hereby granted, provided that the above copyright notice and this
@@ -200,6 +200,16 @@ String Plugin::getState(const char*) const { return String(); }
 #endif
 
 #if DISTRHO_PLUGIN_WANT_STATE
+uint32_t Plugin::getStateHints(const uint32_t index)
+{
+   #if DISTRHO_PLUGIN_WANT_STATEFILES
+    if isStateFile(index)
+        return kStateIsFilenamePath;
+   #endif
+
+    return 0x0;
+}
+
 void Plugin::setState(const char*, const char*) {}
 #endif
 

diff --git a/distrho/src/DistrhoPluginInternal.hpp b/distrho/src/DistrhoPluginInternal.hpp
@@ -727,6 +727,13 @@ class PluginExporter
         return fData->stateCount;
     }
 
+    uint32_t getStateHints(const uint32_t index) const noexcept
+    {
+        DISTRHO_SAFE_ASSERT_RETURN(fData != nullptr && index < fData->stateCount, 0x0);
+
+        return fPlugin->getStateHints(index);
+    }
+
     const String& getStateKey(const uint32_t index) const noexcept
     {
         DISTRHO_SAFE_ASSERT_RETURN(fData != nullptr && index < fData->stateCount, sFallbackString);
@@ -741,15 +748,6 @@ class PluginExporter
         return fData->stateDefValues[index];
     }
 
-# if DISTRHO_PLUGIN_WANT_STATEFILES
-    bool isStateFile(const uint32_t index) const
-    {
-        DISTRHO_SAFE_ASSERT_RETURN(fData != nullptr && index < fData->stateCount, false);
-
-        return fPlugin->isStateFile(index);
-    }
-# endif
-
 # if DISTRHO_PLUGIN_WANT_FULL_STATE
     String getState(const char* key) const
     {