Merge pull request #446 from tlecomte/pyqt6

feat(UI): migrate to PyQt6

Author: tlecomte

.github/workflows/install-linux.sh

@@ -13,7 +13,7 @@ sudo apt-get install -y fuse # AppImages require FUSE to run
 
 # when PyInstaller collect libraries, it ignores libraries that are not found on the host.
 # Those missing libs prevent proper startup.
-# For example, PyQt5 bundles Qt5 libs that depend on libxcb-xinerama.so.0
+# For example, PyQt6 bundles Qt6 libs that depend on libxcb-xinerama.so.0
 # which would not be bundled unless explicitly installed.
 sudo apt-get install libxcb-xinerama0
 sudo apt-get install libxkbcommon-x11-0

INSTALL.md

@@ -8,7 +8,7 @@ Get the latest binary releases for Windows, macOS and Linux on the [Releases](ht
 
 The following steps can be used to prepare a development environment for Friture on Ubuntu.
 
-Prerequisite: a 64 bits Linux installation (PyQt5 wheels for Linux are only available for 64 bits).
+Prerequisite: a 64 bits Linux installation (PyQt6 wheels for Linux are only available for 64 bits).
 
 This has been tested in a Virtualbox image for Ubuntu Trusty 16.04 LTS 64 bits from osboxes.org. The following custom settings have been set on the VM: increase video memory, enable 3d acceleration, enable audio input, install guest addition, add user to vboxsf (for file sharing with the host), keyboard layout setup.
 
@@ -40,7 +40,7 @@ git fetch
 git checkout origin/<branchName>
 ```
 
-6. Create a virtual environment, install Friture dependencies (PyQt5, etc.), and build Cython extensions
+6. Create a virtual environment, install Friture dependencies (PyQt6, etc.), and build Cython extensions
 ```
 uv sync
 ```
@@ -92,8 +92,8 @@ See [pyproject.toml](pyproject.toml)
 If `settings.ui` or `resource.qrc` are changed, the corresponding python files need to be rebuilt:
 
 ```
-uv run pyuic5 ui/settings.ui --from-imports > friture/ui_settings.py
-uv run pyrcc5 resources/friture.qrc -o friture/friture_rc.py
+uv run pyuic6 ui/settings.ui -o friture/ui_settings.py
+uv run pyrcc6 resources/friture.qrc -o friture/friture_rc.py
 ```
 
 ## Filters parameters

friture.spec

@@ -8,57 +8,43 @@ from PyInstaller.utils.hooks import collect_data_files
 
 block_cipher = None
 
-# pyinstaller is conservative: it includes all Qt5 modules by default
+# pyinstaller is conservative: it includes all Qt6 modules by default
 # to reduce our frozen image size, we exclude unused modules
 excludes = [
-        'PyQt5.QtHelp',
-        'PyQt5.QtMultimedia',
-        'PyQt5.QtScript',
-        'PyQt5.QtScriptTools',
-        'PyQt5.QtSql',
-        'PyQt5.QtDesigner',
-        'PyQt5.QtTest',
-        'PyQt5.QtWebKit',
-        'PyQt5.QtXMLPatterns',
-        'PyQt5.QtCLucene',
-        'PyQt5.QtBluetooth',
-        'PyQt5.QtConcurrent',
-        'PyQt5.QtMultimediaWidgets',
-        'PyQt5.QtPositioning',
-        'PyQt5.QtSensors',
-        'PyQt5.QtSerialPort',
-        'PyQt5.QtWebChannel',
-        'PyQt5.QtWebEngine',
-        'PyQt5.QtWebEngineCore',
-        'PyQt5.QtWebEngineWidgets',
-        'PyQt5.QtWebKitWidgets',
-        'PyQt5.QtWebSockets']
+        'PyQt6.QtHelp',
+        'PyQt6.QtMultimedia',
+        'PyQt6.QtSql',
+        'PyQt6.QtDesigner',
+        'PyQt6.QtTest',
+        'PyQt6.QtPositioning',
+        'PyQt6.QtSensors',
+        'PyQt6.QtSerialPort',
+        'PyQt6.QtWebChannel',
+        'PyQt6.QtWebEngine',
+        'PyQt6.QtWebEngineCore',
+        'PyQt6.QtWebEngineWidgets',
+        'PyQt6.QtWebSockets']
 
 excluded_binaries = [
-        'Qt5Bluetooth.dll',
-        'Qt5DBus.dll',
-        'Qt5Location.dll',
-        'Qt5Nfc.dll',
-        'Qt5Positioning.dll',
-        'Qt5PositioningQuick.dll',
-        'Qt5PrintSupport.dll',
-        'Qt5RemoteObjects.dll',
-        'Qt5WebSockets.dll',
-        'Qt5WinExtras.dll',
-        'Qt5Xml.dll',
-        'Qt5XmlPatterns.dll',
+        'Qt6Bluetooth.dll',
+        'Qt6DBus.dll',
+        'Qt6Location.dll',
+        'Qt6Nfc.dll',
+        'Qt6Positioning.dll',
+        'Qt6PositioningQuick.dll',
+        'Qt6PrintSupport.dll',
+        'Qt6RemoteObjects.dll',
+        'Qt6WebSockets.dll',
+        'Qt6WinExtras.dll',
+        'Qt6Xml.dll',
 
         # # macos
         'QtHelp.framework',
         'QtMultimedia.framework',
-        'QtScript.framework',
-        'QtScriptTools.framework',
         'QtSql.framework',
         'QtDesigner.framework',
         'QtTest.framework',
-        'QtWebKit.framework',
         'QtXMLPatterns.framework',
-        'QtCLucene.framework',
         'QtBluetooth.framework',
         'QtConcurrent.framework',
         'QtMultimediaWidgets.framework',
@@ -69,15 +55,14 @@ excluded_binaries = [
         'QtWebEngine.framework',
         'QtWebEngineCore.framework',
         'QtWebEngineWidgets.framework',
-        'QtWebKitWidgets.framework',
         'QtWebSockets.framework'
         ]
 
 pathex = []
 if platform.system() == "Windows":
-  # workaround for PyInstaller that does not look where the new PyQt5 official wheels put the Qt dlls
+  # workaround for PyInstaller that does not look where the new PyQt6 official wheels put the Qt dlls
   from PyInstaller.compat import getsitepackages
-  pathex += [os.path.join(x, 'PyQt5', 'Qt', 'bin') for x in getsitepackages()]
+  pathex += [os.path.join(x, 'PyQt6', 'Qt', 'bin') for x in getsitepackages()]
 
 a = Analysis(['main.py'],
              pathex=pathex,
@@ -120,6 +105,6 @@ app = BUNDLE(coll,
          bundle_identifier="org.silentgain.friture",
          version=friture.__version__,
          info_plist={
-            'NSMicrophoneUsageDescription': 'Friture reads from the audio inputs to show visualizations',
-            'CFBundleVersion': friture.__version__
+             'NSMicrophoneUsageDescription': 'Friture reads from the audio inputs to show visualizations',
+             'CFBundleVersion': friture.__version__
          })

friture/ControlBar.qml

@@ -9,8 +9,6 @@ RowLayout {
 
     SystemPalette { id: systemPalette; colorGroup: SystemPalette.Active }
 
-    required property var viewModel
-
     ComboBox {
         id: widgetSelector
         model: [
@@ -38,31 +36,31 @@ RowLayout {
         icon.source: "qrc:/images-src/dock-settings.svg"
         ToolTip.text: "Customize the audio widget"
         icon.color: systemPalette.windowText
-        onClicked: viewModel.onSettingsClicked()
+        onClicked: viewModel.triggerSettingsClicked()
     }
-
+    
     ToolButton {
         id: movePreviousButton
         icon.source: "qrc:/images-src/dock-move-previous.svg"
         ToolTip.text: "Move widget to previous slot"
         icon.color: systemPalette.windowText
-        onClicked: viewModel.onMovePreviousClicked()
+        onClicked: viewModel.triggerMovePreviousClicked()
     }
-
+    
     ToolButton {
         id: moveNextButton
         icon.source: "qrc:/images-src/dock-move-next.svg"
         ToolTip.text: "Move widget to next slot"
         icon.color: systemPalette.windowText
-        onClicked: viewModel.onMoveNextClicked()
+        onClicked: viewModel.triggerMoveNextClicked()
     }
-
+    
     ToolButton {
         id: closeButton
         icon.source: "qrc:/images-src/dock-close.svg"
         ToolTip.text: "Close the audio widget"
         icon.color: systemPalette.windowText
-        onClicked: viewModel.onCloseClicked()
+        onClicked: viewModel.triggerCloseClicked()
     }
 
     Item {

friture/DelayEstimator.qml

@@ -3,8 +3,6 @@ import QtQuick.Controls 2.15
 
 Rectangle {
     id: root
-    required property var viewModel
-    required property string fixedFont
 
     SystemPalette { id: systemPalette; colorGroup: SystemPalette.Active }
     color: systemPalette.window

friture/FritureMainWindow.qml

@@ -9,8 +9,7 @@ Rectangle { // eventually move to ApplicationWindow
     // title: qsTr("Friture") // ApplicationWindow
     // icon.source: "qrc:/images-src/window-icon.svg" // ApplicationWindow
 
-    required property MainWindowViewModel main_window_view_model
-    required property string fixedFont
+    property string fixedFont
 
     ColumnLayout { // remove once we use ApplicationWindow
         anchors.fill: parent
@@ -26,15 +25,19 @@ Rectangle { // eventually move to ApplicationWindow
                 ToolButton {
                     id: startButton
                     checkable: true
-                    checked: mainWindow.main_window_view_model.toolbar_view_model.recording
+                    checked: main_window_view_model.toolbar_view_model.recording
                     icon.source: startButton.checked ? "qrc:/images-src/stop.svg" : "qrc:/images-src/start.svg"
                     text: startButton.checked ? qsTr("Stop") : qsTr("Start")
                     ToolTip.text: qsTr("Start/Stop")
                     icon.height: 32
                     icon.width: 32
-                    //shortcut: "Space"
+                    Shortcut {
+                        context: Qt.ApplicationShortcut
+                        sequences: ["Space"]
+                        onActivated: startButton.clicked()
+                    }
                     onClicked: {
-                        mainWindow.main_window_view_model.toolbar_view_model.recording_toggle()
+                        main_window_view_model.toolbar_view_model.recording_toggle()
                     }
                 }
                 ToolButton {
@@ -45,7 +48,7 @@ Rectangle { // eventually move to ApplicationWindow
                     icon.height: 32
                     icon.width: 32
                     onClicked: {
-                        mainWindow.main_window_view_model.toolbar_view_model.new_dock()
+                        main_window_view_model.toolbar_view_model.new_dock()
                     }
                 }
                 ToolButton {
@@ -56,7 +59,7 @@ Rectangle { // eventually move to ApplicationWindow
                     icon.height: 32
                     icon.width: 32
                     onClicked: {
-                        mainWindow.main_window_view_model.toolbar_view_model.settings()
+                        main_window_view_model.toolbar_view_model.settings()
                     }
                 }
                 ToolButton {
@@ -66,7 +69,7 @@ Rectangle { // eventually move to ApplicationWindow
                     icon.height: 32
                     icon.width: 32
                     onClicked: {
-                        mainWindow.main_window_view_model.toolbar_view_model.about()
+                        main_window_view_model.toolbar_view_model.about()
                     }
                 }
             }
@@ -77,7 +80,6 @@ Rectangle { // eventually move to ApplicationWindow
             Layout.fillWidth: true
             Layout.fillHeight: true
             fixedFont: mainWindow.fixedFont
-            main_window_view_model: mainWindow.main_window_view_model
         }
     }
 }

friture/Generator.qml

@@ -1,14 +1,11 @@
 import QtQuick 2.15
 import QtQuick.Controls 2.15
 import QtQuick.Layouts 1.15
-import QtQuick.Dialogs 1.3
 import QtQml 2.15
 import "./generators"
 
 Rectangle {
     id: generatorRoot
-    required property var viewModel
-    required property string fixedFont
 
     SystemPalette { id: systemPalette; colorGroup: SystemPalette.Active }
     color: systemPalette.window
@@ -34,28 +31,33 @@ Rectangle {
         }
 
         SineSettings {
-            viewModel: generatorRoot.viewModel.sineGenerator
-            visible: generatorRoot.viewModel.generatorIndex === 0
+            Layout.fillWidth: true
+            settingsViewModel: viewModel.sineGenerator
+            visible: viewModel.generatorIndex === 0
         }
 
         WhiteSettings {
-            viewModel: generatorRoot.viewModel.whiteGenerator
-            visible: generatorRoot.viewModel.generatorIndex === 1
+            Layout.fillWidth: true
+            settingsViewModel: viewModel.whiteGenerator
+            visible: viewModel.generatorIndex === 1
         }
 
         PinkSettings {
-            viewModel: generatorRoot.viewModel.pinkGenerator
-            visible: generatorRoot.viewModel.generatorIndex === 2
+            Layout.fillWidth: true
+            settingsViewModel: viewModel.pinkGenerator
+            visible: viewModel.generatorIndex === 2
         }
 
         SweepSettings {
-            viewModel: generatorRoot.viewModel.sweepGenerator
-            visible: generatorRoot.viewModel.generatorIndex === 3
+            Layout.fillWidth: true
+            settingsViewModel: viewModel.sweepGenerator
+            visible: viewModel.generatorIndex === 3
         }
 
         BurstSettings {
-            viewModel: generatorRoot.viewModel.burstGenerator
-            visible: generatorRoot.viewModel.generatorIndex === 4
+            Layout.fillWidth: true
+            settingsViewModel: viewModel.burstGenerator
+            visible: viewModel.generatorIndex === 4
         }
     }
 }

friture/HistPlot.qml

@@ -5,9 +5,6 @@ import QtQuick.Shapes 1.15
 import Friture 1.0
 
 Plot {
-    required property var viewModel
-    required property string fixedFont
-
     scopedata: viewModel
 
     Repeater {

friture/ImagePlot.qml

@@ -5,9 +5,6 @@ import QtQuick.Shapes 1.15
 import Friture 1.0
 
 Plot {
-    required property var viewModel
-    required property string fixedFont
-
     scopedata: viewModel
 
     Repeater {

friture/MainWindow.qml

@@ -9,21 +9,20 @@ Rectangle {
     SystemPalette { id: systemPalette; colorGroup: SystemPalette.Active }
     color: systemPalette.window
 
-    required property MainWindowViewModel main_window_view_model
-    required property string fixedFont
+    property string fixedFont
 
     GridLayout {
         objectName: "main_row_layout"
         anchors.fill: parent
-        rows: main_window.main_window_view_model.playback_control_enabled ? 2 : 1
+        rows: main_window_view_model.playback_control_enabled ? 2 : 1
         columns: 2
         rowSpacing: 3
         columnSpacing: 3
 
         Levels {
-            level_view_model: main_window.main_window_view_model.level_view_model
+            level_view_model: main_window_view_model.level_view_model
             Layout.row: 0
-            Layout.rowSpan: main_window.main_window_view_model.playback_control_enabled ? 2 : 1
+            Layout.rowSpan: main_window_view_model.playback_control_enabled ? 2 : 1
             Layout.column: 0
             Layout.fillHeight: true
             Layout.margins: 5
@@ -47,9 +46,9 @@ Rectangle {
             Layout.fillWidth: true
             Layout.margins: 5
 
-            viewModel: main_window.main_window_view_model.playback_control_view_model
+            viewModel: main_window_view_model.playback_control_view_model
 
-            visible: main_window.main_window_view_model.playback_control_enabled
+            visible: main_window_view_model.playback_control_enabled
         }
     }
 }