Merge pull request #29527 from RomanPudashkin/online_sounds_clear_cache_460

[4.6.0] Fix #29487: Add method to clear online sounds cache

Author: RomanPudashkin

src/appshell/view/appmenumodel.cpp

@@ -117,7 +117,7 @@ void AppMenuModel::setupConnections()
     });
 
 #ifdef MUSE_MODULE_WORKSPACE
-    connect(m_workspacesMenuModel.get(), &WorkspacesMenuModel::itemsChanged, this, [this](){
+    connect(m_workspacesMenuModel.get(), &WorkspacesMenuModel::itemsChanged, this, [this]() {
         MenuItem& workspacesItem = findMenu("menu-workspaces");
         workspacesItem.setSubitems(m_workspacesMenuModel->items());
     });
@@ -159,6 +159,15 @@ void AppMenuModel::onActionsStateChanges(const muse::actions::ActionCodeList& co
     }
 }
 
+bool AppMenuModel::isMuseSamplerModuleAdded() const
+{
+#ifdef MUSE_MODULE_MUSESAMPLER
+    return museSamplerInfo() != nullptr;
+#else
+    return false;
+#endif
+}
+
 MenuItemList AppMenuModel::makeChordAndFretboardDiagramsItems()
 {
     MenuItemList items {
@@ -452,8 +461,15 @@ MenuItem* AppMenuModel::makeHelpMenu(bool addDiagnosticsSubMenu)
     helpItems << makeMenuItem("about-musescore", MenuItemRole::AboutRole);
     helpItems << makeMenuItem("about-qt", MenuItemRole::AboutQtRole);
     helpItems << makeMenuItem("about-musicxml");
-
     helpItems << makeSeparator();
+
+#if defined(Q_OS_WIN) || defined(Q_OS_MACOS)
+    if (isMuseSamplerModuleAdded()) {
+        helpItems << makeMenuItem("clear-online-sounds-cache");
+        helpItems << makeSeparator();
+    }
+#endif
+
     helpItems << makeMenuItem("revert-factory");
 
     return makeMenu(TranslatableString("appshell/menu/help", "&Help"), helpItems, "menu-help");
@@ -473,9 +489,7 @@ MenuItem* AppMenuModel::makeDiagnosticsMenu()
         makeMenu(TranslatableString("appshell/menu/diagnostics", "&System"), systemItems, "menu-system")
     };
 
-#ifdef MUSE_MODULE_MUSESAMPLER
-    bool isMuseSamplerModuleAdded = museSamplerInfo() != nullptr;
-    if (isMuseSamplerModuleAdded) {
+    if (isMuseSamplerModuleAdded()) {
         MenuItemList museSamplerItems {
             makeMenuItem("musesampler-check"),
         };
@@ -486,7 +500,6 @@ MenuItem* AppMenuModel::makeDiagnosticsMenu()
 
         items << makeMenu(TranslatableString("appshell/menu/diagnostics", "&MuseSampler"), museSamplerItems, "menu-musesampler");
     }
-#endif
 
     if (globalConfiguration()->devModeEnabled()) {
         MenuItemList actionsItems {

src/appshell/view/appmenumodel.h

@@ -80,6 +80,8 @@ class AppMenuModel : public muse::uicomponents::AbstractMenuModel
 
     void onActionsStateChanges(const muse::actions::ActionCodeList& codes) override;
 
+    bool isMuseSamplerModuleAdded() const;
+
     using muse::uicomponents::AbstractMenuModel::makeMenuItem;
     muse::uicomponents::MenuItem* makeMenuItem(const muse::actions::ActionCode& actionCode, muse::uicomponents::MenuItemRole role);
 

src/framework/audio/common/rpc/irpcchannel.h

@@ -63,6 +63,9 @@ enum class Method {
     // notification
     InputParamsChanged,
 
+    ProcessInput,
+
+    ClearCache,
     ClearSources,
 
     // Play
@@ -136,6 +139,9 @@ inline std::string to_string(Method m)
     case Method::GetInputProcessingProgress: return "GetInputProcessingProgress";
     case Method::InputParamsChanged: return "InputParamsChanged";
 
+    case Method::ProcessInput: return "ProcessInput";
+
+    case Method::ClearCache: return "ClearCache";
     case Method::ClearSources: return "ClearSources";
 
     // Play

src/framework/audio/main/internal/playback.cpp

@@ -408,6 +408,14 @@ async::Channel<TrackSequenceId, TrackId, AudioInputParams> Playback::inputParams
     return m_inputParamsChanged;
 }
 
+void Playback::processInput(const TrackSequenceId sequenceId, const TrackId trackId) const
+{
+    ONLY_AUDIO_MAIN_THREAD;
+
+    Msg msg = rpc::make_request(Method::ProcessInput, RpcPacker::pack(sequenceId, trackId));
+    channel()->send(msg);
+}
+
 muse::async::Promise<InputProcessingProgress> Playback::inputProcessingProgress(const TrackSequenceId sequenceId,
                                                                                 const TrackId trackId) const
 {
@@ -437,6 +445,14 @@ muse::async::Promise<InputProcessingProgress> Playback::inputProcessingProgress(
     }, PromiseType::AsyncByBody);
 }
 
+void Playback::clearCache(const TrackSequenceId sequenceId, const TrackId trackId) const
+{
+    ONLY_AUDIO_MAIN_THREAD;
+
+    Msg msg = rpc::make_request(Method::ClearCache, RpcPacker::pack(sequenceId, trackId));
+    channel()->send(msg);
+}
+
 void Playback::clearSources()
 {
     ONLY_AUDIO_MAIN_THREAD;

src/framework/audio/main/internal/playback.h

@@ -75,8 +75,10 @@ class Playback : public IPlayback, public Injectable, public async::Asyncable
     void setInputParams(const TrackSequenceId sequenceId, const TrackId trackId, const AudioInputParams& params) override;
     async::Channel<TrackSequenceId, TrackId, AudioInputParams> inputParamsChanged() const override;
 
+    void processInput(const TrackSequenceId sequenceId, const TrackId trackId) const override;
     async::Promise<InputProcessingProgress> inputProcessingProgress(const TrackSequenceId sequenceId, const TrackId id) const override;
 
+    void clearCache(const TrackSequenceId sequenceId, const TrackId trackId) const override;
     void clearSources() override;
 
     // 3. Play Sequence

src/framework/audio/main/iplayback.h

@@ -77,8 +77,10 @@ class IPlayback : MODULE_EXPORT_INTERFACE
     virtual void setInputParams(const TrackSequenceId sequenceId, const TrackId trackId, const AudioInputParams& params) = 0;
     virtual async::Channel<TrackSequenceId, TrackId, AudioInputParams> inputParamsChanged() const = 0;
 
+    virtual void processInput(const TrackSequenceId sequenceId, const TrackId trackId) const = 0;
     virtual async::Promise<InputProcessingProgress> inputProcessingProgress(const TrackSequenceId sequenceId, const TrackId id) const = 0;
 
+    virtual void clearCache(const TrackSequenceId sequenceId, const TrackId trackId) const = 0;
     virtual void clearSources() = 0;
 
     // 3. Play Sequence

src/framework/audio/worker/internal/eventaudiosource.cpp

@@ -233,6 +233,17 @@ async::Notification EventAudioSource::readyToPlayChanged() const
     return m_synth->readyToPlayChanged();
 }
 
+void EventAudioSource::processInput()
+{
+    ONLY_AUDIO_WORKER_THREAD;
+
+    IF_ASSERT_FAILED(m_synth) {
+        return;
+    }
+
+    m_synth->processInput();
+}
+
 InputProcessingProgress EventAudioSource::inputProcessingProgress() const
 {
     ONLY_AUDIO_WORKER_THREAD;
@@ -244,6 +255,17 @@ InputProcessingProgress EventAudioSource::inputProcessingProgress() const
     return m_synth->inputProcessingProgress();
 }
 
+void EventAudioSource::clearCache()
+{
+    ONLY_AUDIO_WORKER_THREAD;
+
+    IF_ASSERT_FAILED(m_synth) {
+        return;
+    }
+
+    m_synth->clearCache();
+}
+
 EventAudioSource::SynthCtx EventAudioSource::currentSynthCtx() const
 {
     if (!m_synth) {

src/framework/audio/worker/internal/eventaudiosource.h

@@ -62,8 +62,11 @@ class EventAudioSource : public ITrackAudioInput, public muse::Injectable, publi
     bool readyToPlay() const override;
     async::Notification readyToPlayChanged() const override;
 
+    void processInput() override;
     InputProcessingProgress inputProcessingProgress() const override;
 
+    void clearCache() override;
+
 private:
     struct SynthCtx
     {

src/framework/audio/worker/internal/sequenceio.cpp

@@ -161,6 +161,22 @@ AudioSignalChanges SequenceIO::audioSignalChanges(const TrackId id) const
     return track->outputHandler->audioSignalChanges();
 }
 
+void SequenceIO::processInput(const TrackId id) const
+{
+    ONLY_AUDIO_WORKER_THREAD;
+
+    IF_ASSERT_FAILED(m_getTracks) {
+        return;
+    }
+
+    TrackPtr track = m_getTracks->track(id);
+    IF_ASSERT_FAILED(track) {
+        return;
+    }
+
+    track->inputHandler->processInput();
+}
+
 InputProcessingProgress SequenceIO::inputProcessingProgress(const TrackId id) const
 {
     ONLY_AUDIO_WORKER_THREAD;
@@ -176,3 +192,19 @@ InputProcessingProgress SequenceIO::inputProcessingProgress(const TrackId id) co
 
     return track->inputHandler->inputProcessingProgress();
 }
+
+void SequenceIO::clearCache(const TrackId id) const
+{
+    ONLY_AUDIO_WORKER_THREAD;
+
+    IF_ASSERT_FAILED(m_getTracks) {
+        return;
+    }
+
+    TrackPtr track = m_getTracks->track(id);
+    IF_ASSERT_FAILED(track) {
+        return;
+    }
+
+    track->inputHandler->clearCache();
+}

src/framework/audio/worker/internal/sequenceio.h

@@ -46,8 +46,11 @@ class SequenceIO : public ISequenceIO, public async::Asyncable
 
     AudioSignalChanges audioSignalChanges(const TrackId id) const override;
 
+    void processInput(const TrackId id) const override;
     InputProcessingProgress inputProcessingProgress(const TrackId id) const override;
 
+    void clearCache(const TrackId id) const override;
+
 private:
     worker::IGetTracks* m_getTracks = nullptr;