Added ability to change audio drivers without restarting

Author: igorkorsukov

CMakeLists.txt

@@ -131,12 +131,6 @@ option(MUE_ENABLE_ENGRAVING_RENDER_DEBUG "Enable rendering debug" OFF)
 option(MUE_ENABLE_ENGRAVING_LD_ACCESS "Enable diagnostic engraving check layout data access" OFF)
 option(MUE_ENABLE_ENGRAVING_LD_PASSES "Enable engraving layout by passes" OFF)
 
-if (OS_IS_LIN)
-    option(MUSE_PIPEWIRE_AUDIO_DRIVER "Use PipeWire audio driver" OFF) # Turns ON on CI
-elseif (OS_IS_FBSD)
-    option(MUSE_PIPEWIRE_AUDIO_DRIVER "Use PipeWire audio driver" OFF)
-endif()
-
 ###########################################
 # Setup Configure
 ###########################################

ninja_build.sh

@@ -102,7 +102,7 @@ function do_build() {
         -DMUSE_MODULE_GLOBAL_LOGGER_DEBUGLEVEL="${MUSESCORE_DEBUGLEVEL_ENABLED}" \
         -DMUSE_MODULE_VST="${MUSESCORE_BUILD_VST_MODULE}" \
         -DMUSE_MODULE_NETWORK_WEBSOCKET="${MUSESCORE_BUILD_WEBSOCKET}" \
-        -DMUSE_PIPEWIRE_AUDIO_DRIVER="${MUSESCORE_BUILD_PIPEWIRE_AUDIO_DRIVER}" \
+        -DMUSE_MODULE_AUDIO_PIPEWIRE="${MUSESCORE_BUILD_PIPEWIRE_AUDIO_DRIVER}" \
         -DCMAKE_SKIP_RPATH="${MUSESCORE_NO_RPATH}" \
         -DMUSE_COMPILE_USE_UNITY="${MUSESCORE_COMPILE_USE_UNITY}"
 

src/appshell/qml/Preferences/internal/AudioApiSection.qml

@@ -39,8 +39,6 @@ BaseSection {
         ComboBoxWithTitle {
             id: apiComboBox
 
-            property int initialIndex: -1
-
             title: qsTrc("appshell/preferences", "Audio API")
             columnWidth: root.columnWidth
 
@@ -56,25 +54,6 @@ BaseSection {
             onValueEdited: function(newIndex, newValue) {
                 root.currentAudioApiIndexChangeRequested(newIndex)
             }
-
-            onCurrentIndexChanged: {
-                if (apiComboBox.initialIndex !== -1) {
-                    restartRequiredLabel.visible = apiComboBox.currentIndex !== apiComboBox.initialIndex
-                }
-            }
-
-            Component.onCompleted: {
-                apiComboBox.initialIndex = apiComboBox.currentIndex
-            }
-        }
-
-        StyledTextLabel {
-            id: restartRequiredLabel
-
-            anchors.verticalCenter: parent.verticalCenter
-
-            text: qsTrc("appshell/preferences", "Restart required")
-            visible: false
         }
     }
 

src/appshell/view/preferences/audiomidipreferencesmodel.cpp

@@ -50,7 +50,7 @@ void AudioMidiPreferencesModel::setCurrentAudioApiIndex(int index)
         return;
     }
 
-    audioDriverController()->setCurrentAudioApi(apiList.at(index));
+    audioDriverController()->changeAudioDriver(apiList.at(index));
     emit currentAudioApiIndexChanged(index);
 }
 
@@ -108,7 +108,7 @@ void AudioMidiPreferencesModel::init()
         emit onlineSoundsShowProgressBarModeChanged();
     });
 
-    audioDriverController()->currentAudioApiChanged().onNotify(this, [this]() {
+    audioDriverController()->audioDriverChanged().onNotify(this, [this]() {
         emit currentAudioApiIndexChanged(currentAudioApiIndex());
     });
 

src/appshell/view/preferences/commonaudioapiconfigurationmodel.cpp

@@ -79,7 +79,7 @@ QVariantList CommonAudioApiConfigurationModel::deviceList() const
 
 void CommonAudioApiConfigurationModel::deviceSelected(const QString& deviceId)
 {
-    audioConfiguration()->setAudioOutputDeviceId(deviceId.toStdString());
+    audioDriverController()->selectOutputDevice(deviceId.toStdString());
 }
 
 unsigned int CommonAudioApiConfigurationModel::bufferSize() const
@@ -102,7 +102,7 @@ QList<unsigned int> CommonAudioApiConfigurationModel::bufferSizeList() const
 
 void CommonAudioApiConfigurationModel::bufferSizeSelected(const QString& bufferSizeStr)
 {
-    audioConfiguration()->setDriverBufferSize(bufferSizeStr.toInt());
+    audioDriverController()->changeBufferSize(bufferSizeStr.toInt());
 }
 
 unsigned int CommonAudioApiConfigurationModel::sampleRate() const
@@ -124,7 +124,7 @@ QList<unsigned int> CommonAudioApiConfigurationModel::sampleRateList() const
 
 void CommonAudioApiConfigurationModel::sampleRateSelected(const QString& sampleRateStr)
 {
-    audioConfiguration()->setSampleRate(sampleRateStr.toInt());
+    audioDriverController()->changeSampleRate(sampleRateStr.toInt());
 }
 
 muse::audio::IAudioDriverPtr CommonAudioApiConfigurationModel::audioDriver() const

src/framework/audio/CMakeLists.txt

@@ -81,7 +81,7 @@ else ()
         find_package(ALSA REQUIRED)
         set(MODULE_INCLUDE_PRIVATE ${MODULE_INCLUDE_PRIVATE} ${ALSA_INCLUDE_DIRS} )
         set(MODULE_LINK ${MODULE_LINK} ${ALSA_LIBRARIES} pthread )
-        if (MUSE_PIPEWIRE_AUDIO_DRIVER)
+        if (MUSE_MODULE_AUDIO_PIPEWIRE)
             pkg_check_modules(PipeWire libpipewire-0.3)
             if (PipeWire_FOUND)
                 message(STATUS "Found Pipewire: ${PipeWire_LIBRARIES}")
@@ -91,7 +91,6 @@ else ()
                 )
                 set(MODULE_INCLUDE ${MODULE_INCLUDE} ${PipeWire_INCLUDE_DIRS} )
                 set(MODULE_LINK ${MODULE_LINK} ${PipeWire_LIBRARIES})
-                set(MODULE_DEF ${MODULE_DEF} -DMUSE_PIPEWIRE_AUDIO_DRIVER)
             else()
                 message(WARNING "Pipewire development files not found.\nPipewire support is disabled from the build.")
             endif()

src/framework/audio/common/audiotypes.h

@@ -37,6 +37,8 @@
 
 #include "mpe/events.h"
 
+#include "log.h"
+
 namespace muse::audio {
 using msecs_t = int64_t;
 using secs_t = muse::secs_t;
@@ -404,7 +406,16 @@ struct AudioSignalsNotifier {
         }
     }
 
-    AudioSignalChanges audioSignalChanges;
+    //! NOTE It would be nice if the driver callback was called in one thread.
+    //! But some drivers, for example PipeWire, use queues
+    //! And then the callback can be called in different threads.
+    //! If a score is open, we will change the audio API (change the driver)
+    //! then the number of threads used may increase...
+    //! Channels allow 10 threads by default. Here we're increasing that to the maximum...
+    //! If this is not enough, then we need to make sure that the callback is called in one thread,
+    //! or use something else here instead of channels, some kind of queues.
+    const int _max_threads = 100;
+    AudioSignalChanges audioSignalChanges = AudioSignalChanges(_max_threads);
 
 private:
     static constexpr volume_dbfs_t PRESSURE_MINIMAL_VALUABLE_DIFF = volume_dbfs_t::make(2.5f);

src/framework/audio/driver/audio_driver.cmake

@@ -76,7 +76,7 @@ elseif(OS_IS_LIN OR OS_IS_FBSD)
         ${CMAKE_CURRENT_LIST_DIR}/platform/lin/audiodeviceslistener.cpp
         ${CMAKE_CURRENT_LIST_DIR}/platform/lin/audiodeviceslistener.h
     )
-    if (MUSE_PIPEWIRE_AUDIO_DRIVER)
+    if (MUSE_MODULE_AUDIO_PIPEWIRE)
         # this is conditionally added to module source if
         # pipewire is actually found on the system
         set(PW_AUDIO_DRIVER_SRC

src/framework/audio/driver/platform/lin/alsaaudiodriver.cpp

@@ -128,7 +128,7 @@ void AlsaAudioDriver::init()
 
 std::string AlsaAudioDriver::name() const
 {
-    return "MUAUDIO(ALSA)";
+    return "ALSA";
 }
 
 bool AlsaAudioDriver::open(const Spec& spec, Spec* activeSpec)

src/framework/audio/driver/platform/lin/pwaudiodriver.cpp

@@ -614,7 +614,7 @@ void PwAudioDriver::init()
     LOGD() << "Running with version " << pw_get_library_version();
 }
 
-std::string PwAudioDriver::name() const { return "MUAUDIO(PipeWire)"; }
+std::string PwAudioDriver::name() const { return "PipeWire"; }
 
 bool PwAudioDriver::open(const Spec& spec, Spec* activeSpec)
 {