Fix #22382 Part 1: Add a shortcut to toggle hear when playing editing

src/playback/internal/playbackconfiguration.cpp

@@ -129,6 +129,10 @@ void PlaybackConfiguration::init()
             m_isAuxChannelVisibleChanged.send(idx, val.toBool());
         });
     }
+
+    settings()->valueChanged(PLAY_NOTES_WHEN_EDITING).onReceive(this, [this](const Val&) {
+        m_isPlayNotesWhenEditingChanged.notify();
+    });
 }
 
 bool PlaybackConfiguration::playNotesWhenEditing() const
@@ -161,6 +165,11 @@ void PlaybackConfiguration::setPlayHarmonyWhenEditing(bool value)
     settings()->setSharedValue(PLAY_HARMONY_WHEN_EDITING, Val(value));
 }
 
+muse::async::Notification PlaybackConfiguration::playNotesWhenEditingChanged() const
+{
+    return m_isPlayNotesWhenEditingChanged;
+}
+
 PlaybackCursorType PlaybackConfiguration::cursorType() const
 {
     return settings()->value(PLAYBACK_CURSOR_TYPE_KEY).toEnum<PlaybackCursorType>();

src/playback/internal/playbackconfiguration.h

@@ -38,6 +38,7 @@ class PlaybackConfiguration : public IPlaybackConfiguration, public muse::async:
 public:
     void init();
 
+    muse::async::Notification playNotesWhenEditingChanged() const override;
     bool playNotesWhenEditing() const override;
     void setPlayNotesWhenEditing(bool value) override;
 
@@ -92,6 +93,8 @@ class PlaybackConfiguration : public IPlaybackConfiguration, public muse::async:
     muse::async::Channel<MixerSectionType, bool> m_isMixerSectionVisibleChanged;
 
     muse::async::Channel<bool> m_muteHiddenInstrumentsChanged;
+
+    muse::async::Notification m_isPlayNotesWhenEditingChanged;
 };
 }
 

src/playback/internal/playbackcontroller.cpp

@@ -59,6 +59,7 @@ static const ActionCode PAN_CODE("pan");
 static const ActionCode REPEAT_CODE("repeat");
 static const ActionCode PLAY_CHORD_SYMBOLS_CODE("play-chord-symbols");
 static const ActionCode PLAYBACK_SETUP("playback-setup");
+static const ActionCode TOGGLE_HEAR_PLAYBACK_WHEN_EDITING("toggle-hear-playback-when-editing");
 
 static AudioOutputParams makeReverbOutputParams()
 {
@@ -113,6 +114,7 @@ void PlaybackController::init()
     dispatcher()->reg(this, INPUT_SOUNDING_PITCH, [this]() { PlaybackController::setMidiUseWrittenPitch(false); });
     dispatcher()->reg(this, COUNT_IN_CODE, this, &PlaybackController::toggleCountIn);
     dispatcher()->reg(this, PLAYBACK_SETUP, this, &PlaybackController::openPlaybackSetupDialog);
+    dispatcher()->reg(this, TOGGLE_HEAR_PLAYBACK_WHEN_EDITING, this, &PlaybackController::toggleHearPlaybackWhenEditing);
 
     globalContext()->currentNotationChanged().onNotify(this, [this]() {
         onNotationChanged();
@@ -140,6 +142,10 @@ void PlaybackController::init()
         updateLoop();
     });
 
+    configuration()->playNotesWhenEditingChanged().onNotify(this, [this]() {
+        notifyActionCheckedChanged(TOGGLE_HEAR_PLAYBACK_WHEN_EDITING);
+    });
+
     m_measureInputLag = configuration()->shouldMeasureInputLag();
 }
 
@@ -1436,7 +1442,8 @@ bool PlaybackController::actionChecked(const ActionCode& actionCode) const
         { PLAY_CHORD_SYMBOLS_CODE, notationConfiguration()->isPlayChordSymbolsEnabled() },
         { PAN_CODE, notationConfiguration()->isAutomaticallyPanEnabled() },
         { METRONOME_CODE, notationConfiguration()->isMetronomeEnabled() },
-        { COUNT_IN_CODE, notationConfiguration()->isCountInEnabled() }
+        { COUNT_IN_CODE, notationConfiguration()->isCountInEnabled() },
+        { TOGGLE_HEAR_PLAYBACK_WHEN_EDITING, configuration()->playNotesWhenEditing() }
     };
 
     return isChecked[actionCode];
@@ -1631,3 +1638,9 @@ muse::audio::secs_t PlaybackController::playedTickToSecs(int tick) const
 {
     return secs_t(notationPlayback()->playedTickToSec(tick));
 }
+
+void PlaybackController::toggleHearPlaybackWhenEditing()
+{
+    bool wasPlayNotesWhenEditing = configuration()->playNotesWhenEditing();
+    configuration()->setPlayNotesWhenEditing(!wasPlayNotesWhenEditing);
+}

src/playback/internal/playbackcontroller.h

@@ -112,6 +112,7 @@ class PlaybackController : public IPlaybackController, public muse::actions::Act
     void setIsExportingAudio(bool exporting) override;
 
     bool canReceiveAction(const muse::actions::ActionCode& code) const override;
+
 private:
     muse::audio::IPlayerPtr currentPlayer() const;
 
@@ -166,6 +167,7 @@ class PlaybackController : public IPlaybackController, public muse::actions::Act
     void setMidiUseWrittenPitch(bool useWrittenPitch);
     void toggleCountIn();
     void toggleLoopPlayback();
+    void toggleHearPlaybackWhenEditing();
 
     void openPlaybackSetupDialog();
 

src/playback/internal/playbackuiactions.cpp

@@ -143,6 +143,17 @@ const UiActionList PlaybackUiActions::m_settingsActions = {
 //             ),
 };
 
+const UiActionList PlaybackUiActions::m_hearPlaybackWhenEditingActions = {
+    UiAction("toggle-hear-playback-when-editing",
+             mu::context::UiCtxAny,
+             mu::context::CTX_ANY,
+             TranslatableString("action", "Toggle hear playback when editing"),
+             TranslatableString("action", "Toggle hear playback when editing"),
+             IconCode::Code::EDIT,
+             Checkable::Yes
+             ),
+};
+
 const UiActionList PlaybackUiActions::m_loopBoundaryActions = {
     UiAction("loop-in",
              mu::context::UiCtxAny,
@@ -190,6 +201,7 @@ const UiActionList& PlaybackUiActions::actionsList() const
         alist.insert(alist.end(), m_midiInputActions.cbegin(), m_midiInputActions.cend());
         alist.insert(alist.end(), m_midiInputPitchActions.cbegin(), m_midiInputPitchActions.cend());
         alist.insert(alist.end(), m_settingsActions.cbegin(), m_settingsActions.cend());
+        alist.insert(alist.end(), m_hearPlaybackWhenEditingActions.cbegin(), m_hearPlaybackWhenEditingActions.cend());
         alist.insert(alist.end(), m_loopBoundaryActions.cbegin(), m_loopBoundaryActions.cend());
     }
     return alist;
@@ -243,6 +255,11 @@ const UiActionList& PlaybackUiActions::loopBoundaryActions()
     return m_loopBoundaryActions;
 }
 
+const UiActionList& PlaybackUiActions::hearPlaybackWhenEditingActions()
+{
+    return m_hearPlaybackWhenEditingActions;
+}
+
 const muse::ui::ToolConfig& PlaybackUiActions::defaultPlaybackToolConfig()
 {
     static ToolConfig config;

src/playback/internal/playbackuiactions.h

@@ -50,6 +50,7 @@ class PlaybackUiActions : public muse::ui::IUiActionsModule, public muse::async:
     static const muse::ui::UiActionList& midiInputActions();
     static const muse::ui::UiActionList& midiInputPitchActions();
     static const muse::ui::UiActionList& settingsActions();
+    static const muse::ui::UiActionList& hearPlaybackWhenEditingActions();
     static const muse::ui::UiActionList& loopBoundaryActions();
 
     static const muse::ui::ToolConfig& defaultPlaybackToolConfig();
@@ -60,6 +61,7 @@ class PlaybackUiActions : public muse::ui::IUiActionsModule, public muse::async:
     static const muse::ui::UiActionList m_midiInputPitchActions;
     static const muse::ui::UiActionList m_settingsActions;
     static const muse::ui::UiActionList m_loopBoundaryActions;
+    static const muse::ui::UiActionList m_hearPlaybackWhenEditingActions;
 
     std::shared_ptr<PlaybackController> m_controller;
     muse::async::Channel<muse::actions::ActionCodeList> m_actionEnabledChanged;

src/playback/iplaybackconfiguration.h

@@ -43,6 +43,8 @@ class IPlaybackConfiguration : MODULE_EXPORT_INTERFACE
     virtual bool playHarmonyWhenEditing() const = 0;
     virtual void setPlayHarmonyWhenEditing(bool value) = 0;
 
+    virtual muse::async::Notification playNotesWhenEditingChanged() const = 0;
+
     virtual PlaybackCursorType cursorType() const = 0;
 
     virtual bool isMixerSectionVisible(MixerSectionType sectionType) const = 0;

src/playback/view/playbacktoolbarmodel.cpp

@@ -106,6 +106,14 @@ void PlaybackToolBarModel::updateActions()
         settingsItems << makeMenuItem(action.code);
     }
 
+    settingsItems << makeSeparator();
+
+    for (const UiAction& action : PlaybackUiActions::hearPlaybackWhenEditingActions()) {
+        settingsItems << makeMenuItem(action.code);
+    }
+
+    settingsItems << makeSeparator();
+
     if (!m_isToolbarFloating) {
         settingsItems << makeSeparator();
     }

src/stubs/playback/playbackconfigurationstub.cpp

@@ -51,6 +51,11 @@ void PlaybackConfigurationStub::setPlayHarmonyWhenEditing(bool)
 {
 }
 
+muse::async::Notification PlaybackConfigurationStub::playNotesWhenEditingChanged() const
+{
+    return muse::async::Notification();
+}
+
 PlaybackCursorType PlaybackConfigurationStub::cursorType() const
 {
     return PlaybackCursorType::SMOOTH;

src/stubs/playback/playbackconfigurationstub.h

@@ -37,6 +37,8 @@ class PlaybackConfigurationStub : public IPlaybackConfiguration
     bool playHarmonyWhenEditing() const override;
     void setPlayHarmonyWhenEditing(bool value) override;
 
+    muse::async::Notification playNotesWhenEditingChanged() const override;
+
     PlaybackCursorType cursorType() const override;
 
     bool isMixerSectionVisible(MixerSectionType sectionType) const override;