Orchestra pit: rework sorting/filtering the plugins list (#309)

helio-fm · Aug 18, 2024 · 4aa2a0c · 4aa2a0c
1 parent 9db567d
commit 4aa2a0c
Show file tree

Hide file tree

Showing 8 changed files with 161 additions and 57 deletions.
diff --git a/Source/Core/Audio/Instruments/PluginScanner.cpp b/Source/Core/Audio/Instruments/PluginScanner.cpp
@@ -28,10 +28,10 @@
 #include "SoundFontSynthAudioPlugin.h"
 #include "SerializablePluginDescription.h"
 
-#if PLATFORM_DESKTOP
-#   define SAFE_SCAN 1
-#else
+#if PLATFORM_MOBILE || JUCE_MAC
 #   define SAFE_SCAN 0
+#else
+#   define SAFE_SCAN 1
 #endif
 
 PluginScanner::PluginScanner() : Thread("Plugin Scanner") {}
@@ -81,6 +81,7 @@ void PluginScanner::removePlugin(const PluginDescription &description)
 void PluginScanner::sortList(KnownPluginList::SortMethod fieldToSortBy, bool forwards)
 {
     this->pluginsList.sort(fieldToSortBy, forwards);
+    this->sendChangeMessage();
 }
 
 bool PluginScanner::isWorking() const
@@ -214,6 +215,9 @@ void PluginScanner::run()
             }
         }
 
+        const auto pluginSorting = App::Config().getUiFlags()->getPluginSorting();
+        const auto pluginSortingForwards = App::Config().getUiFlags()->isPluginSortingForwards();
+
         try
         {
             for (const auto &pluginPath : this->filesToScan)
@@ -266,8 +270,8 @@ void PluginScanner::run()
                                     pluginDescription.deserialize(e);
                                     this->pluginsList.addType(pluginDescription);
                                 }
-                                    
-                                this->sendChangeMessage();
+
+                                this->sortList(pluginSorting, pluginSortingForwards); // will also sendChangeMessage();
                             }
                         }
                         catch (...) {}
@@ -278,7 +282,7 @@ void PluginScanner::run()
 #else
                 KnownPluginList knownPluginList;
                 OwnedArray<PluginDescription> typesFound;
-                    
+
                 try
                 {
                     for (int j = 0; j < formatManager.getNumFormats(); ++j)
@@ -296,9 +300,10 @@ void PluginScanner::run()
                     {
                         this->pluginsList.addType(*type);
                     }
+
+                    this->sortList(pluginSorting, pluginSortingForwards); // will also sendChangeMessage();
                 }
-
-                this->sendChangeMessage();
+
                 Thread::sleep(150);
 #endif
             }
@@ -312,7 +317,7 @@ void PluginScanner::run()
             DBG("Done scanning audio plugins");
             this->sendChangeMessage();
         }
-        
+
         WaitableEvent::wait();
     }
 }
@@ -407,13 +412,21 @@ void PluginScanner::deserialize(const SerializedData &data)
 
     if (!root.isValid()) { return; }
 
+    Array<SerializablePluginDescription> descriptions;
     for (const auto &child : root)
     {
         SerializablePluginDescription pluginDescription;
         pluginDescription.deserialize(child);
-        if (pluginDescription.isValid())
+        descriptions.add(move(pluginDescription));
+    }
+
+    // for whatever reason addType inserts in the beginning of the array,
+    // so we have to iterate backwards to preserve the serialized order
+    for (int i = descriptions.size(); i --> 0 ;)
+    {
+        if (descriptions.getUnchecked(i).isValid())
         {
-            this->pluginsList.addType(pluginDescription);
+            this->pluginsList.addType(descriptions.getUnchecked(i));
         }
     }
 

diff --git a/Source/Core/Audio/Instruments/PluginScanner.h b/Source/Core/Audio/Instruments/PluginScanner.h
@@ -33,18 +33,14 @@ class PluginScanner final :
     bool hasInstruments() const;
 
     void removePlugin(const PluginDescription &description);
-    void sortList(KnownPluginList::SortMethod method, bool forwards);
+    void sortList(KnownPluginList::SortMethod method =
+        KnownPluginList::SortMethod::sortByFormat, bool forwards = true);
 
     inline const Array<PluginDescription> getPlugins() const noexcept
     {
         return this->pluginsList.getTypes();
     }
 
-    inline const int getNumPlugins() const noexcept
-    {
-        return this->pluginsList.getNumTypes();
-    }
-
     void runInitialScan();
     void scanFolderAndAddResults(const File &dir);
     void cancelRunningScan();

diff --git a/Source/Core/Configuration/UserInterfaceFlags.cpp b/Source/Core/Configuration/UserInterfaceFlags.cpp
@@ -272,6 +272,29 @@ AffineTransform UserInterfaceFlags::getScaledTransformFor(Component *component)
     return component->getTransform().scaled(this->uiScaleFactor, this->uiScaleFactor);
 }
 
+KnownPluginList::SortMethod UserInterfaceFlags::getPluginSorting() const noexcept
+{
+    return this->pluginSorting;
+}
+
+bool UserInterfaceFlags::isPluginSortingForwards() const noexcept
+{
+    return this->pluginSortingForwards;
+}
+
+void UserInterfaceFlags::setPluginSorting(KnownPluginList::SortMethod sorting, bool forwards)
+{
+    if (this->pluginSorting == sorting && this->pluginSortingForwards == forwards)
+    {
+        return;
+    }
+
+    this->pluginSorting = sorting;
+    this->pluginSortingForwards = forwards;
+    // no listener event here, not needed yet
+    this->startTimer(UserInterfaceFlags::saveTimeoutMs);
+}
+
 //===----------------------------------------------------------------------===//
 // Serializable
 //===----------------------------------------------------------------------===//
@@ -297,6 +320,9 @@ SerializedData UserInterfaceFlags::serialize() const
 
     tree.setProperty(UI::Flags::metronomeEnabled, this->metronomeEnabled);
 
+    const auto pluginSortingValue = int(this->pluginSorting) * (this->pluginSortingForwards ? 1 : -1);
+    tree.setProperty(UI::Flags::pluginsSorting, pluginSortingValue);
+
     // skips experimentalFeaturesOn, it's read only
 
     return tree;
@@ -336,6 +362,10 @@ void UserInterfaceFlags::deserialize(const SerializedData &data)
 
     this->metronomeEnabled = root.getProperty(UI::Flags::metronomeEnabled, this->metronomeEnabled);
 
+    const int pluginsSortMethod = root.getProperty(UI::Flags::pluginsSorting, int(this->pluginSorting));
+    this->pluginSorting = KnownPluginList::SortMethod(abs(pluginsSortMethod));
+    this->pluginSortingForwards = pluginsSortMethod >= 0;
+
     this->editorPanelVisible = false; // not serializing that
 
     this->experimentalFeaturesOn = root.getProperty(UI::Flags::experimentalFeaturesOn, this->experimentalFeaturesOn);

diff --git a/Source/Core/Configuration/UserInterfaceFlags.h b/Source/Core/Configuration/UserInterfaceFlags.h
@@ -117,6 +117,10 @@ class UserInterfaceFlags final : public Serializable, private Timer
     bool isMetronomeEnabled() const noexcept;
     void toggleMetronome();
 
+    KnownPluginList::SortMethod getPluginSorting() const noexcept;
+    bool isPluginSortingForwards() const noexcept;
+    void setPluginSorting(KnownPluginList::SortMethod sorting, bool forwards);
+
     //===------------------------------------------------------------------===//
     // Serializable
     //===------------------------------------------------------------------===//
@@ -174,11 +178,15 @@ class UserInterfaceFlags final : public Serializable, private Timer
 
     bool metronomeEnabled = false;
 
+    bool pluginSortingForwards = true;
+    KnownPluginList::SortMethod pluginSorting =
+        KnownPluginList::SortMethod::sortByFormat;
+
 private:
 
     // all these options are expected to be toggled by hotkeys,
     // so let's have a sensible delay before we serialize anything:
-    static constexpr auto saveTimeoutMs = 3000;
+    static constexpr auto saveTimeoutMs = 2000;
 
     void timerCallback() override;
     ListenerList<Listener> listeners;

diff --git a/Source/Core/Serialization/SerializationKeys.h b/Source/Core/Serialization/SerializationKeys.h
@@ -307,6 +307,7 @@ namespace Serialization
             static const Identifier mouseWheelVerticalPanningByDefault = "wheelVerticalPan";
             static const Identifier mouseWheelVerticalZoomingByDefault = "wheelVerticalZoom";
             static const Identifier metronomeEnabled = "metronome";
+            static const Identifier pluginsSorting = "pluginsSorting";
             } // namespace Flags
 
         namespace Hotkeys