Update playback settings

Author: CrSjimo

src/plugins/audio/internal/AudioPlugin.cpp

@@ -23,6 +23,7 @@
 #include <audio/internal/AudioPreference.h>
 #include <audio/internal/ProjectAudioAddOn.h>
 #include <audio/internal/PlaybackAddOn.h>
+#include <audio/internal/PlaybackPage.h>
 #include <audio/internal/AudioSystem.h>
 #include <audio/internal/OutputSystem.h>
 
@@ -83,6 +84,7 @@ namespace Audio::Internal {
         auto sc = Core::CoreInterface::settingCatalog();
         auto audioAndMidiPage = new AudioAndMidiPage;
         audioAndMidiPage->addPage(new AudioOutputPage);
+        audioAndMidiPage->addPage(new PlaybackPage);
         sc->addPage(audioAndMidiPage);
     }
 

src/plugins/audio/internal/AudioPreference.cpp

@@ -9,6 +9,7 @@ namespace Audio::Internal {
     class AudioPreferencePrivate {
     public:
         AudioPreference::PlayheadBehavior playbackBehavior{};
+        AudioPreference::PlaybackTogglingAction playbackTogglingAction{AudioPreference::PTA_PlayStop};
     };
 
     static AudioPreference *m_instance = nullptr;
@@ -31,7 +32,9 @@ namespace Audio::Internal {
         auto settings = Core::RuntimeInterface::settings();
         settings->beginGroup(staticMetaObject.className());
         d->playbackBehavior = settings->value("playbackBehavior", QVariant::fromValue(PB_ReturnToStart)).value<PlayheadBehavior>();
+        d->playbackTogglingAction = settings->value("playbackTogglingAction", QVariant::fromValue(PTA_PlayStop)).value<PlaybackTogglingAction>();
         emit playbackBehaviorChanged();
+        emit playbackTogglingActionChanged();
         settings->endGroup();
     }
 
@@ -40,6 +43,7 @@ namespace Audio::Internal {
         auto settings = Core::RuntimeInterface::settings();
         settings->beginGroup(staticMetaObject.className());
         settings->setValue("playbackBehavior", d->playbackBehavior);
+        settings->setValue("playbackTogglingAction", d->playbackTogglingAction);
         settings->endGroup();
     }
 
@@ -60,4 +64,17 @@ namespace Audio::Internal {
         emit m_instance->playbackBehaviorChanged();
     }
 
+    AudioPreference::PlaybackTogglingAction AudioPreference::playbackTogglingAction() {
+        M_INSTANCE_D;
+        return d->playbackTogglingAction;
+    }
+
+    void AudioPreference::setPlaybackTogglingAction(PlaybackTogglingAction playbackTogglingAction) {
+        M_INSTANCE_D;
+        if (d->playbackTogglingAction == playbackTogglingAction)
+            return;
+        d->playbackTogglingAction = playbackTogglingAction;
+        emit m_instance->playbackTogglingActionChanged();
+    }
+
 }

src/plugins/audio/internal/AudioPreference.h

@@ -20,6 +20,7 @@ namespace Audio::Internal {
         QML_SINGLETON
         Q_DECLARE_PRIVATE(AudioPreference)
         Q_PROPERTY(AudioPreference::PlayheadBehavior playbackBehavior READ playbackBehavior WRITE setPlaybackBehavior NOTIFY playbackBehaviorChanged)
+        Q_PROPERTY(AudioPreference::PlaybackTogglingAction playbackTogglingAction READ playbackTogglingAction WRITE setPlaybackTogglingAction NOTIFY playbackTogglingActionChanged)
 
     public:
         ~AudioPreference() override;
@@ -40,11 +41,20 @@ namespace Audio::Internal {
         };
         Q_ENUM(PlayheadBehavior)
 
+        enum PlaybackTogglingAction {
+            PTA_PlayStop,
+            PTA_PlayPause,
+        };
+        Q_ENUM(PlaybackTogglingAction)
+
         static PlayheadBehavior playbackBehavior();
         static void setPlaybackBehavior(PlayheadBehavior playbackBehavior);
+        static PlaybackTogglingAction playbackTogglingAction();
+        static void setPlaybackTogglingAction(PlaybackTogglingAction playbackTogglingAction);
 
     Q_SIGNALS:
         void playbackBehaviorChanged();
+        void playbackTogglingActionChanged();
 
     private:
         friend class AudioPlugin;

src/plugins/audio/internal/addon/PlaybackAddOn.cpp

@@ -119,8 +119,11 @@ namespace Audio::Internal {
     void PlaybackAddOn::togglePlayback() {
         if (m_context) {
             if (m_context->status() == ProjectAudioContext::Playing) {
-                // TODO use configuration to decide whether to stop or to pause
-                stop();
+                if (AudioPreference::playbackTogglingAction() == AudioPreference::PTA_PlayPause) {
+                    pause();
+                } else {
+                    stop();
+                }
             } else {
                 play();
             }

src/plugins/audio/internal/settings/PlaybackPage.cpp

@@ -0,0 +1,79 @@
+#include "PlaybackPage.h"
+
+#include <QLoggingCategory>
+#include <QQmlComponent>
+
+#include <CoreApi/runtimeinterface.h>
+
+#include <audio/internal/AudioPreference.h>
+
+namespace Audio::Internal {
+
+    Q_STATIC_LOGGING_CATEGORY(lcPlaybackPage, "diffscope.audio.playbackpage")
+
+    PlaybackPage::PlaybackPage(QObject *parent) : Core::ISettingPage("audio.Playback", parent) {
+        setTitle(tr("Playback"));
+        setDescription(tr("Configure playback behavior"));
+    }
+
+    PlaybackPage::~PlaybackPage() {
+        delete m_widget;
+    }
+
+    bool PlaybackPage::matches(const QString &word) {
+        return ISettingPage::matches(word) || widgetMatches(word);
+    }
+
+    QString PlaybackPage::sortKeyword() const {
+        return QStringLiteral("Playback");
+    }
+
+    QObject *PlaybackPage::widget() {
+        if (m_widget)
+            return m_widget;
+        qCDebug(lcPlaybackPage) << "Creating widget";
+        QQmlComponent component(Core::RuntimeInterface::qmlEngine(), "DiffScope.Audio", "PlaybackPage");
+        if (component.isError()) {
+            qFatal() << component.errorString();
+        }
+        m_widget = component.createWithInitialProperties({{"pageHandle", QVariant::fromValue(this)}});
+        m_widget->setParent(this);
+        return m_widget;
+    }
+
+    void PlaybackPage::beginSetting() {
+        qCInfo(lcPlaybackPage) << "Beginning setting";
+        widget();
+        m_widget->setProperty("playbackBehavior", AudioPreference::instance()->property("playbackBehavior"));
+        qCDebug(lcPlaybackPage) << "playbackBehavior" << m_widget->property("playbackBehavior");
+        m_widget->setProperty("playbackTogglingAction", AudioPreference::instance()->property("playbackTogglingAction"));
+        qCDebug(lcPlaybackPage) << "playbackTogglingAction" << m_widget->property("playbackTogglingAction");
+        m_widget->setProperty("started", true);
+        ISettingPage::beginSetting();
+    }
+
+    bool PlaybackPage::accept() {
+        qCInfo(lcPlaybackPage) << "Accepting";
+        qCDebug(lcPlaybackPage) << "playbackBehavior" << m_widget->property("playbackBehavior");
+        AudioPreference::instance()->setProperty("playbackBehavior", m_widget->property("playbackBehavior"));
+        qCDebug(lcPlaybackPage) << "playbackTogglingAction" << m_widget->property("playbackTogglingAction");
+        AudioPreference::instance()->setProperty("playbackTogglingAction", m_widget->property("playbackTogglingAction"));
+        AudioPreference::instance()->save();
+        return ISettingPage::accept();
+    }
+
+    void PlaybackPage::endSetting() {
+        qCInfo(lcPlaybackPage) << "Ending setting";
+        m_widget->setProperty("started", false);
+        ISettingPage::endSetting();
+    }
+
+    bool PlaybackPage::widgetMatches(const QString &word) {
+        widget();
+        auto matcher = m_widget->property("matcher").value<QObject *>();
+        bool ret = false;
+        QMetaObject::invokeMethod(matcher, "matches", qReturnArg(ret), word);
+        return ret;
+    }
+
+}

src/plugins/audio/internal/settings/PlaybackPage.h

@@ -0,0 +1,28 @@
+#ifndef DIFFSCOPE_AUDIOPLUGIN_PLAYBACKPAGE_H
+#define DIFFSCOPE_AUDIOPLUGIN_PLAYBACKPAGE_H
+
+#include <CoreApi/isettingpage.h>
+
+namespace Audio::Internal {
+
+    class PlaybackPage : public Core::ISettingPage {
+        Q_OBJECT
+    public:
+        explicit PlaybackPage(QObject *parent = nullptr);
+        ~PlaybackPage() override;
+
+        bool matches(const QString &word) override;
+        QString sortKeyword() const override;
+        QObject *widget() override;
+        void beginSetting() override;
+        bool accept() override;
+        void endSetting() override;
+
+    private:
+        bool widgetMatches(const QString &word);
+        QObject *m_widget{};
+    };
+
+}
+
+#endif // DIFFSCOPE_AUDIOPLUGIN_PLAYBACKPAGE_H

src/plugins/audio/qml/settings/PlaybackPage.qml

@@ -0,0 +1,87 @@
+import QtQml
+import QtQuick
+import QtQuick.Controls
+import QtQuick.Layouts
+
+import SVSCraft
+import SVSCraft.UIComponents
+
+import DiffScope.Audio
+
+ScrollView {
+    id: page
+
+    required property QtObject pageHandle
+    property bool started: false
+
+    property int playbackBehavior
+    property int playbackTogglingAction
+
+    readonly property var playbackBehaviorModel: [
+        {text: qsTr("Return to start position"), value: AudioPreference.PB_ReturnToStart},
+        {text: qsTr("Keep at current position"), value: AudioPreference.PB_KeepAtCurrent},
+        {text: qsTr("Keep at current position, but play from start position next time"), value: AudioPreference.PB_KeepAtCurrentButPlayFromStart},
+    ]
+    readonly property var playbackTogglingActionModel: [
+        {text: qsTr("Play/Stop"), value: AudioPreference.PTA_PlayStop},
+        {text: qsTr("Play/Pause"), value: AudioPreference.PTA_PlayPause},
+    ]
+
+    onPlaybackBehaviorChanged: if (started) pageHandle.markDirty()
+    onPlaybackTogglingActionChanged: if (started) pageHandle.markDirty()
+
+    anchors.fill: parent
+    contentWidth: availableWidth
+
+    readonly property TextMatcher matcher: TextMatcher {}
+
+    ColumnLayout {
+        width: page.width
+        ColumnLayout {
+            Layout.fillWidth: true
+            Layout.margins: 12
+            spacing: 32
+            GroupBox {
+                title: qsTr("Playback")
+                TextMatcherItem on title {
+                    matcher: page.matcher
+                }
+                Layout.fillWidth: true
+                GridLayout {
+                    columns: 2
+                    anchors.fill: parent
+                    Label {
+                        Layout.columnSpan: 2
+                        text: qsTr("When playback stops, make playhead")
+                        TextMatcherItem on text {
+                            matcher: page.matcher
+                        }
+                    }
+                    ComboBox {
+                        Layout.columnSpan: 2
+                        Layout.fillWidth: true
+                        textRole: "text"
+                        valueRole: "value"
+                        model: page.playbackBehaviorModel
+                        currentIndex: page.playbackBehavior
+                        onCurrentValueChanged: page.playbackBehavior = currentValue
+                    }
+                    Label {
+                        text: qsTr("Playback toggling action")
+                        TextMatcherItem on text {
+                            matcher: page.matcher
+                        }
+                    }
+                    ComboBox {
+                        Layout.fillWidth: true
+                        textRole: "text"
+                        valueRole: "value"
+                        model: page.playbackTogglingActionModel
+                        currentIndex: page.playbackTogglingAction
+                        onCurrentValueChanged: page.playbackTogglingAction = currentValue
+                    }
+                }
+            }
+        }
+    }
+}