Allow for running analysis on demand when selecting objects in ARATestPlugIn

Author: sgretscher

ChangeLog.txt

@@ -19,6 +19,7 @@ Changes since previous releases:
   notifications whenever any part of their persistent state changes
 - added new partial persistency split archives test case to TestHost
 - added various threading and state validations to TestHost
+- added some configurable UI test code to ARATestPlugIn
 - various cleanups in macOS info.plist files
 - added script target to remove ARATestPlugIn from where it was installed for debugging
 - updated Audio Unit SDK from the old CoreAudioUtilityClasses.zip sample code download to

TestPlugIn/ARATestDocumentController.cpp

@@ -43,16 +43,6 @@
 #endif
 
 
-// By default, the test plug-in only analyzes audio sources when explicitly requested by the host.
-// The define below allows to always trigger audio source analysis when a new audio source instance
-// is created (and the host does not provide all supported content for it), which is closer to the
-// behavior of actual plug-ins like Melodyne, and also allows for testing analysis and related
-// notifications in hosts that never request audio source analysis.
-#if !defined (ARA_ALWAYS_PERFORM_ANALYSIS)
-    #define ARA_ALWAYS_PERFORM_ANALYSIS 0
-#endif
-
-
 ARA_SETUP_DEBUG_MESSAGE_PREFIX (TEST_PLUGIN_NAME);
 
 
@@ -125,6 +115,20 @@ class ARATestNoteContentReader : public ARA::PlugIn::ContentReader
 
 /*******************************************************************************/
 
+void ARATestEditorView::doNotifySelection (const ARA::PlugIn::ViewSelection* selection) noexcept
+{
+#if !ARA_ALWAYS_PERFORM_ANALYSIS
+    for (const auto playbackRegion : selection->getEffectivePlaybackRegions ())
+    {
+        auto audioSource { playbackRegion->getAudioModification ()->getAudioSource<ARATestAudioSource> () };
+        if (audioSource->getNoteContent () == nullptr)
+            getDocumentController<ARATestDocumentController> ()->startOrScheduleAnalysisOfAudioSource (audioSource);
+    }
+#endif
+}
+
+/*******************************************************************************/
+
 // helper class to deal with string ownership for persistent IDs
 // We're subclassing the actual ARA interface struct and add members that handle the ownership,
 // which works because the host receiving the struct will not access any data beyond structSize.
@@ -810,6 +814,19 @@ ARA::PlugIn::PlaybackRenderer* ARATestDocumentController::doCreatePlaybackRender
     return new ARATestPlaybackRenderer (this);
 }
 
+ARA::PlugIn::EditorView* ARATestDocumentController::doCreateEditorView () noexcept
+{
+#if !ARA_ALWAYS_PERFORM_ANALYSIS
+    auto result = new ARATestEditorView { this };
+    // An actual plug-in would need to control setEditorOpen () from its companion API implementation -
+    // we'er only doing a crude hack here because we have no such implementation!
+    result->setEditorOpen (true);
+    return result;
+#else
+    return new ARA::PlugIn::EditorView (this);
+#endif
+}
+
 /*******************************************************************************/
 
 bool ARATestDocumentController::rendererWillAccessModelGraph (ARATestPlaybackRenderer* /*playbackRenderer*/) noexcept

TestPlugIn/ARATestDocumentController.h

@@ -26,10 +26,32 @@
 #include <unordered_set>
 
 
+// By default, the test plug-in only analyzes audio sources when explicitly requested by the host,
+// or if the user opens its (empty) UI and selects playback regions or region sequences in the host
+// for which there is no content data available yet.
+// The define below allows to always trigger audio source analysis when a new audio source instance
+// is created (and the host does not provide all supported content for it), which is closer to the
+// behavior of actual plug-ins like Melodyne, and also allows for testing analysis and related
+// notifications in hosts that never request audio source analysis.
+#if !defined (ARA_ALWAYS_PERFORM_ANALYSIS)
+    #define ARA_ALWAYS_PERFORM_ANALYSIS 0
+#endif
+
+
 class ARATestAudioSource;
 class ARATestPlaybackRenderer;
 class ARATestAnalysisTask;
 
+/*******************************************************************************/
+class ARATestEditorView : public ARA::PlugIn::EditorView
+{
+public:
+    using ARA::PlugIn::EditorView::EditorView;
+
+protected:
+    virtual void doNotifySelection (const ARA::PlugIn::ViewSelection* selection) noexcept;
+};
+
 /*******************************************************************************/
 class ARATestDocumentController : public ARA::PlugIn::DocumentController
 {
@@ -99,6 +121,7 @@ class ARATestDocumentController : public ARA::PlugIn::DocumentController
 
     // Plug-In Instance Management
     ARA::PlugIn::PlaybackRenderer* doCreatePlaybackRenderer () noexcept override;
+    ARA::PlugIn::EditorView* doCreateEditorView () noexcept override;
 
 public:
     // Render thread synchronization:
@@ -109,13 +132,13 @@ class ARATestDocumentController : public ARA::PlugIn::DocumentController
     bool rendererWillAccessModelGraph (ARATestPlaybackRenderer* playbackRenderer) noexcept;
     void rendererDidAccessModelGraph (ARATestPlaybackRenderer* playbackRenderer) noexcept;
 
+    void startOrScheduleAnalysisOfAudioSource (ARATestAudioSource* audioSource);    // does nothing if already analyzing
+    bool cancelAnalysisOfAudioSource (ARATestAudioSource* audioSource);
+
 private:
     void disableRendererModelGraphAccess () noexcept;
     void enableRendererModelGraphAccess () noexcept;
 
-    void startOrScheduleAnalysisOfAudioSource (ARATestAudioSource* audioSource);    // does nothing if already analyzing
-    bool cancelAnalysisOfAudioSource (ARATestAudioSource* audioSource);
-
     void startAnalysisTaskForAudioSource (ARATestAudioSource* audioSource);
     bool cancelAnalysisTaskForAudioSource (ARATestAudioSource* audioSource);
     ARATestAnalysisTask* getActiveAnalysisTaskForAudioSource (const ARATestAudioSource* audioSource) noexcept; // returns nullptr if no active analysis for given audio source