Add option to disable UI updates during playback

Author: juzzlin

CHANGELOG

@@ -5,6 +5,8 @@ Release date:
 
 New features:
 
+* Add option to disable UI updates during playback
+
 Bug fixes:
 
 Other:

src/application/service/editor_service.cpp

@@ -15,6 +15,7 @@
 
 #include "editor_service.hpp"
 
+#include "../../infra/settings.hpp"
 #include "../../common/constants.hpp"
 #include "../../contrib/SimpleLogger/src/simple_logger.hpp"
 #include "../../domain/note_data.hpp"
@@ -1582,13 +1583,18 @@ void EditorService::requestPositionByTick(quint64 tick)
         return;
     }
 
-    const auto oldPosition = m_state.cursorPosition;
     if (auto && songPosition = m_song->songPositionByTick(tick); songPosition.has_value()) {
-        m_state.cursorPosition.pattern = songPosition->pattern;
-        m_state.cursorPosition.line = static_cast<quint64>(songPosition->line);
-        notifyPositionChange(oldPosition);
-        setSongPositionInternal(songPosition->position, false);
-        updateTimes(songPosition->currentTime, m_song->lineToTime(songPosition->line));
+        if (Settings::uiUpdatesDisabledDuringPlayback()) {
+            setSongPositionInternal(songPosition->position, false);
+            updateTimes(songPosition->currentTime, m_song->lineToTime(songPosition->line));
+        } else {
+            const auto oldPosition = m_state.cursorPosition;
+            m_state.cursorPosition.pattern = songPosition->pattern;
+            m_state.cursorPosition.line = static_cast<quint64>(songPosition->line);
+            notifyPositionChange(oldPosition);
+            setSongPositionInternal(songPosition->position, false);
+            updateTimes(songPosition->currentTime, m_song->lineToTime(songPosition->line));
+        }
     }
 }
 

src/application/service/settings_service.cpp

@@ -26,6 +26,7 @@ static const auto TAG = "SettingsService";
 
 SettingsService::SettingsService()
   : m_controllerPort { Settings::controllerPort("") }
+  , m_uiUpdatesDisabledDuringPlayback { Settings::uiUpdatesDisabledDuringPlayback() }
   , m_visibleLines { Settings::visibleLines(32) }
   , m_trackHeaderFontSize { Settings::trackHeaderFontSize(20) }
 {
@@ -56,6 +57,20 @@ void SettingsService::setControllerPort(QString controllerPort)
     }
 }
 
+bool SettingsService::uiUpdatesDisabledDuringPlayback() const
+{
+    return m_uiUpdatesDisabledDuringPlayback;
+}
+
+void SettingsService::setUiUpdatesDisabledDuringPlayback(bool disabled)
+{
+    if (m_uiUpdatesDisabledDuringPlayback != disabled) {
+        m_uiUpdatesDisabledDuringPlayback = disabled;
+        Settings::setUiUpdatesDisabledDuringPlayback(disabled);
+        emit uiUpdatesDisabledDuringPlaybackChanged();
+    }
+}
+
 QSize SettingsService::windowSize(QSize defaultSize) const
 {
     return Settings::windowSize(defaultSize);

src/application/service/settings_service.hpp

@@ -26,6 +26,7 @@ class SettingsService : public QObject
     Q_OBJECT
 
     Q_PROPERTY(QString controllerPort READ controllerPort WRITE setControllerPort NOTIFY controllerPortChanged)
+    Q_PROPERTY(bool uiUpdatesDisabledDuringPlayback READ uiUpdatesDisabledDuringPlayback WRITE setUiUpdatesDisabledDuringPlayback NOTIFY uiUpdatesDisabledDuringPlaybackChanged)
     Q_PROPERTY(int visibleLines READ visibleLines WRITE setVisibleLines NOTIFY visibleLinesChanged)
     Q_PROPERTY(int trackHeaderFontSize READ trackHeaderFontSize WRITE setTrackHeaderFontSize NOTIFY trackHeaderFontSizeChanged)
 
@@ -39,6 +40,9 @@ class SettingsService : public QObject
     virtual Q_INVOKABLE QString controllerPort() const;
     virtual Q_INVOKABLE void setControllerPort(QString controllerPort);
 
+    virtual Q_INVOKABLE bool uiUpdatesDisabledDuringPlayback() const;
+    virtual Q_INVOKABLE void setUiUpdatesDisabledDuringPlayback(bool disabled);
+
     virtual Q_INVOKABLE QSize windowSize(QSize defaultSize) const;
     virtual Q_INVOKABLE void setWindowSize(QSize size);
 
@@ -65,12 +69,14 @@ class SettingsService : public QObject
 
 signals:
     void controllerPortChanged();
+    void uiUpdatesDisabledDuringPlaybackChanged();
 
     void visibleLinesChanged();
     void trackHeaderFontSizeChanged();
 
 private:
     QString m_controllerPort;
+    bool m_uiUpdatesDisabledDuringPlayback;
 
     int m_visibleLines;
     int m_trackHeaderFontSize;

src/infra/settings.cpp

@@ -38,6 +38,7 @@ const auto stepKey = "step";
 const auto velocityKey = "velocity";
 
 const auto trackHeaderFontSizeKey = "trackHeaderFontSize";
+const auto uiUpdatesDisabledDuringPlaybackKey = "uiUpdatesDisabledDuringPlayback";
 const auto visibleLinesKey = "visibleLines";
 const auto windowSizeKey = "size";
 
@@ -184,6 +185,23 @@ void setTrackHeaderFontSize(int trackHeaderFontSize)
     settings.endGroup();
 }
 
+bool uiUpdatesDisabledDuringPlayback()
+{
+    QSettings settings;
+    settings.beginGroup(settingsGroupEditor);
+    const auto disabled = settings.value(uiUpdatesDisabledDuringPlaybackKey, false).toBool();
+    settings.endGroup();
+    return disabled;
+}
+
+void setUiUpdatesDisabledDuringPlayback(bool disabled)
+{
+    QSettings settings;
+    settings.beginGroup(settingsGroupEditor);
+    settings.setValue(uiUpdatesDisabledDuringPlaybackKey, disabled);
+    settings.endGroup();
+}
+
 bool recordingEnabled()
 {
     QSettings settings;

src/infra/settings.hpp

@@ -46,6 +46,9 @@ void setVisibleLines(int visibleLines);
 int trackHeaderFontSize(int defaultTrackHeaderFontSize);
 void setTrackHeaderFontSize(int trackHeaderFontSize);
 
+bool uiUpdatesDisabledDuringPlayback();
+void setUiUpdatesDisabledDuringPlayback(bool disabled);
+
 bool recordingEnabled();
 void setRecordingEnabled(bool enabled);
 

src/unit_tests/editor_service_test/CMakeLists.txt

@@ -41,6 +41,7 @@ set(SRC
     ../../domain/play_order.cpp
     ../../domain/song.cpp
     ../../domain/track.cpp
+    ../../infra/settings.cpp
 )
 qt_add_executable(${NAME} ${SRC})
 set_target_properties(${NAME} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${UNIT_TEST_BASE_DIR})

src/unit_tests/editor_service_test/editor_service_test.cpp

@@ -21,6 +21,7 @@
 #include "../../application/service/automation_service.hpp"
 #include "../../application/service/editor_service.hpp"
 #include "../../application/service/mixer_service.hpp"
+#include "../../infra/settings.hpp"
 #include "../../application/service/selection_service.hpp"
 #include "../../application/service/side_chain_service.hpp"
 #include "../../domain/column_settings.hpp"
@@ -2122,6 +2123,48 @@ void EditorServiceTest::test_velocityAtPosition_shouldReturnCorrectVelocity()
     QCOMPARE(editorService.velocityAtPosition(0, 1, 0, 0), 0);
 }
 
+void EditorServiceTest::test_requestPositionByTick_shouldRespectUiUpdatesDisabledSetting()
+{
+    EditorService editorService;
+    QSignalSpy positionChangedSpy { &editorService, &EditorService::positionChanged };
+    QSignalSpy currentTimeChangedSpy { &editorService, &EditorService::currentTimeChanged };
+    QSignalSpy songPositionChangedSpy { &editorService, &EditorService::songPositionChanged };
+
+    // Enable disabling UI updates
+    Settings::setUiUpdatesDisabledDuringPlayback(true);
+
+    // Initial position
+    QCOMPARE(editorService.songPosition(), 0);
+
+    // Populate song position map manually as we don't have a PlayerService rendering
+    editorService.song()->updateTickToSongPositionMapping(0, 0, 0, editorService.lineCount(0));
+
+    // Tick update that triggers a line change
+    const auto tick = editorService.ticksPerLine(); // Move to next line
+    editorService.requestPositionByTick(tick);
+
+    // Assert: Position should NOT change (UI update suppressed)
+    QCOMPARE(positionChangedSpy.count(), 0);
+    // Assert: Time should change
+    QCOMPARE(currentTimeChangedSpy.count(), 1);
+    // Assert: Song position should NOT change (we are still in the same pattern)
+    QCOMPARE(songPositionChangedSpy.count(), 0);
+    QCOMPARE(editorService.songPosition(), 0);
+
+    // Reset setting
+    Settings::setUiUpdatesDisabledDuringPlayback(false);
+
+    // Another tick
+    const auto nextTick = tick * 2;
+    editorService.requestPositionByTick(nextTick);
+
+    // Assert: Position should change now
+    QCOMPARE(positionChangedSpy.count(), 1);
+    QCOMPARE(currentTimeChangedSpy.count(), 2);
+    // Assert: Song position still 0
+    QCOMPARE(songPositionChangedSpy.count(), 0);
+}
+
 } // namespace noteahead
 
 QTEST_GUILESS_MAIN(noteahead::EditorServiceTest)

src/unit_tests/editor_service_test/editor_service_test.hpp

@@ -89,6 +89,7 @@ private slots:
     void test_requestPosition_validPosition_shouldChangePosition();
     void test_requestPosition_shouldChangePosition();
     void test_requestPosition_shouldNotChangePosition();
+    void test_requestPositionByTick_shouldRespectUiUpdatesDisabledSetting();
     void test_resetSongPosition_firstTrackRemoved_shouldResetPosition();
 
     void test_requestScroll_shouldChangePosition();

src/unit_tests/editor_service_undo_test/CMakeLists.txt

@@ -41,6 +41,7 @@ set(SRC
     ../../domain/play_order.cpp
     ../../domain/song.cpp
     ../../domain/track.cpp
+    ../../infra/settings.cpp
 )
 qt_add_executable(${NAME} ${SRC})
 set_target_properties(${NAME} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${UNIT_TEST_BASE_DIR})