CPack: Refactor AppImage and Apple DMG Generation (LMMS#7252)

* CPack: Refactor AppImage and Apple DMG Generation
* Switch from linuxdeployqt to linuxdelpoy
* Add ARM64 AppImage support
* Add support for `.run` installers using `makeself`, an alternative to AppImage
* Refactor BashCompletion.cmake
* Enable CPack debugging via `WANT_DEBUG_CPACK`
* Add `download_binary`, `create_symlink` macros
* Qt6: Fix @rpath bug on macOS
* Detect and bundle LV2 UI Suil modules (Related LMMS#7201)
* Allow remote plugins to honor `LMMS_PLUGIN_DIR`
* Add .github/workflows/deps-ubuntu-24.04-gcc.txt
* Fix waveforms FileDialog

Co-authored-by: Dalton Messmer <messmer.dalton@gmail.com>

.github/workflows/build.yml

@@ -5,8 +5,8 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
-  linux:
-    name: linux
+  linux-x86_64:
+    name: linux-x86_64
     runs-on: ubuntu-latest
     container: ghcr.io/lmms/linux.gcc:20.04
     env:
@@ -39,7 +39,6 @@ jobs:
           source /opt/qt5*/bin/qt5*-env.sh || true
           cmake -S . \
                 -B build \
-                -DCMAKE_INSTALL_PREFIX=./install \
                 $CMAKE_OPTS
       - name: Build
         run: cmake --build build
@@ -49,8 +48,7 @@ jobs:
           ctest --output-on-failure -j2
       - name: Package
         run: |
-          cmake --build build --target install
-          cmake --build build --target appimage
+          cmake --build build --target package
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -65,6 +63,71 @@ jobs:
           ccache --show-stats
         env:
           CCACHE_MAXSIZE: 500M
+  linux-arm64:
+    name: linux-arm64
+    runs-on: ubuntu-24.04-arm
+    env:
+      CMAKE_OPTS: >-
+        -DUSE_WERROR=ON
+        -DCMAKE_BUILD_TYPE=RelWithDebInfo
+        -DUSE_COMPILE_CACHE=ON
+        -DWANT_DEBUG_CPACK=ON
+      CCACHE_MAXSIZE: 0
+      CCACHE_NOCOMPRESS: 1
+      MAKEFLAGS: -j2
+      DEBIAN_FRONTEND: noninteractive
+    steps:
+      - name: Configure git
+        run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+      - name: Check out
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          submodules: recursive
+      - name: Install system packages
+        run: |
+          sudo apt-get update -y
+          sudo apt-get install -y --no-install-recommends \
+            $(xargs < .github/workflows/deps-ubuntu-24.04-gcc.txt)
+      - name: Cache ccache data
+        uses: actions/cache@v3
+        with:
+          key: ccache-${{ github.job }}-${{ github.ref }}-${{ github.run_id }}
+          restore-keys: |
+            ccache-${{ github.job }}-${{ github.ref }}-
+            ccache-${{ github.job }}-
+          path: ~/.ccache
+      - name: Configure
+        run: |
+          ccache --zero-stats
+          cmake -S . \
+                -B build \
+                -DWANT_VST_32=OFF \
+                -DWANT_VST_64=OFF \
+                $CMAKE_OPTS
+      - name: Build
+        run: cmake --build build
+      - name: Run tests
+        run: |
+          cd build/tests
+          ctest --output-on-failure -j2
+      - name: Package
+        run: |
+          cmake --build build --target package
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: linux-arm64
+          path: build/lmms-*.AppImage
+      - name: Trim ccache and print statistics
+        run: |
+          ccache --cleanup
+          echo "[ccache config]"
+          ccache --show-config
+          echo "[ccache stats]"
+          ccache --show-stats
+        env:
+          CCACHE_MAXSIZE: 500M
   macos:
     strategy:
       fail-fast: false
@@ -129,7 +192,6 @@ jobs:
           mkdir build
           cmake -S . \
                 -B build \
-                -DCMAKE_INSTALL_PREFIX="../target" \
                 -DCMAKE_PREFIX_PATH="$(brew --prefix qt@5)" \
                 -DCMAKE_OSX_ARCHITECTURES=${{ matrix.arch }} \
                 $CMAKE_OPTS \
@@ -142,8 +204,7 @@ jobs:
           ctest --output-on-failure -j3
       - name: Package
         run: |
-          cmake --build build --target install
-          cmake --build build --target dmg
+          cmake --build build --target package
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
@@ -208,7 +269,6 @@ jobs:
           ccache --zero-stats
           cmake -S . \
                 -B build \
-                -DCMAKE_INSTALL_PREFIX=./install \
                 -DCMAKE_TOOLCHAIN_FILE="./cmake/toolchains/MinGW-W64-64.cmake" \
                 $CMAKE_OPTS
       - name: Build

.github/workflows/deps-ubuntu-24.04-gcc.txt

@@ -0,0 +1,52 @@
+binutils
+ca-certificates
+ccache
+cmake
+file
+fluid
+gcc
+git
+gpg
+g++
+libasound2-dev
+libc6-dev
+libfftw3-dev
+libfltk1.3-dev
+libfluidsynth-dev
+libgig-dev
+libgtk2.0-0
+libjack-jackd2-dev
+liblilv-dev
+liblist-moreutils-perl
+libmp3lame-dev
+libogg-dev
+libqt5svg5-dev
+libqt5x11extras5-dev
+libsamplerate0-dev
+libsdl2-dev
+libsndfile1-dev
+libsoundio-dev
+libstk-dev
+libsuil-dev
+libvorbis-dev
+libx11-xcb-dev
+libxcb-keysyms1-dev
+libxcb-util0-dev
+libxft-dev
+libxinerama-dev
+libxml2-utils
+libxml-perl
+lsb-release
+lv2-dev
+make
+perl
+portaudio19-dev
+qt5-qmake
+qtbase5-dev
+qtbase5-dev-tools
+qtbase5-private-dev
+qttools5-dev-tools
+software-properties-common
+ssh-client
+stk
+wget

CMakeLists.txt

@@ -104,6 +104,8 @@ option(WANT_DEBUG_MSAN	"Enable MemorySanitizer" OFF)
 option(WANT_DEBUG_UBSAN	"Enable UndefinedBehaviorSanitizer" OFF)
 option(WANT_DEBUG_GPROF	"Enable gprof profiler" OFF)
 OPTION(BUNDLE_QT_TRANSLATIONS	"Install Qt translation files for LMMS" OFF)
+option(WANT_DEBUG_CPACK "Show detailed logs for packaging commands" OFF)
+option(WANT_CPACK_TARBALL "Request CPack to create a tarball instead of an installer" OFF)
 
 
 IF(LMMS_BUILD_APPLE)
@@ -268,6 +270,7 @@ IF(WANT_SUIL)
 		IF(SUIL_FOUND)
 			SET(LMMS_HAVE_SUIL TRUE)
 			SET(STATUS_SUIL "OK")
+			find_package(SuilModules)
 		ELSE()
 			SET(STATUS_SUIL "not found, install it or set PKG_CONFIG_PATH appropriately")
 		ENDIF()
@@ -606,6 +609,17 @@ ELSE()
 	SET (STATUS_DEBUG_FPE "Disabled")
 ENDIF(WANT_DEBUG_FPE)
 
+if(WANT_DEBUG_CPACK)
+	if((LMMS_BUILD_WIN32 AND CMAKE_VERSION VERSION_LESS "3.19") OR WANT_CPACK_TARBALL)
+		set(STATUS_DEBUG_CPACK "Wanted but disabled due to unsupported configuration")
+	else()
+		set(CPACK_DEBUG TRUE)
+		set(STATUS_DEBUG_CPACK "Enabled")
+	endif()
+else()
+	set(STATUS_DEBUG_CPACK "Disabled")
+endif()
+
 # check for libsamplerate
 FIND_PACKAGE(Samplerate 0.1.8 MODULE REQUIRED)
 
@@ -679,7 +693,7 @@ if(WANT_DEBUG_GPROF)
 	add_link_options(-pg)
 	set(STATUS_GPROF "OK")
 else()
-	set(STATUS_GPROF "DISABLED ${STATUS_GPROF}")
+	set(STATUS_GPROF "Disabled ${STATUS_GPROF}")
 endif()
 
 # add enabled sanitizers
@@ -745,7 +759,7 @@ IF(LMMS_BUILD_LINUX)
 		"${CMAKE_BINARY_DIR}/lmmsconfig.h"
 		"${CMAKE_BINARY_DIR}/lmmsversion.h"
 		"${CMAKE_SOURCE_DIR}/src/gui/embed.cpp"
-		DESTINATION "${CMAKE_INSTALL_PREFIX}/include/lmms/")
+		DESTINATION "include/lmms/")
 ENDIF(LMMS_BUILD_LINUX)
 
 #
@@ -849,6 +863,7 @@ MESSAGE(
 "* Debug using ThreadSanitizer       : ${STATUS_DEBUG_TSAN}\n"
 "* Debug using MemorySanitizer       : ${STATUS_DEBUG_MSAN}\n"
 "* Debug using UBSanitizer           : ${STATUS_DEBUG_UBSAN}\n"
+"* Debug packaging commands          : ${STATUS_DEBUG_CPACK}\n"
 "* Profile using GNU profiler        : ${STATUS_GPROF}\n"
 )
 

cmake/CMakeLists.txt

@@ -14,10 +14,14 @@ ENDIF()
 SET(CPACK_PACKAGE_INSTALL_DIRECTORY             "${PROJECT_NAME_UCASE}")
 SET(CPACK_SOURCE_GENERATOR                      "TBZ2")
 SET(CPACK_SOURCE_PACKAGE_FILE_NAME              "${CMAKE_PROJECT_NAME}-${VERSION}")
-IF(NOT DEFINED WIN32)
-	SET(CPACK_STRIP_FILES                   "bin/${CMAKE_PROJECT_NAME};${PLUGIN_DIR}/*.so")
-	SET(CPACK_PACKAGE_EXECUTABLES           "${CMAKE_PROJECT_NAME}" "${PROJECT_NAME_UCASE} binary")
-ENDIF()
+SET(CPACK_PACKAGE_EXECUTABLES                   "${CMAKE_PROJECT_NAME}" "${PROJECT_NAME_UCASE} binary")
+
+# Disable strip for Debug|RelWithDebInfo
+if(CMAKE_BUILD_TYPE MATCHES "Deb")
+	unset(CPACK_STRIP_FILES)
+else()
+	set(CPACK_STRIP_FILES TRUE)
+endif()
 
 IF(LMMS_BUILD_WIN32)
 	ADD_SUBDIRECTORY(nsis)

cmake/apple/CMakeLists.txt

@@ -1,24 +1,3 @@
-SET(MACOSX_BUNDLE_ICON_FILE             "icon.icns")
-SET(MACOSX_BUNDLE_GUI_IDENTIFIER        "${PROJECT_NAME_UCASE}")
-SET(MACOSX_BUNDLE_LONG_VERSION_STRING   "${VERSION}")
-SET(MACOSX_BUNDLE_BUNDLE_NAME           "${PROJECT_NAME_UCASE}")
-SET(MACOSX_BUNDLE_SHORT_VERSION_STRING  "${VERSION}")
-SET(MACOSX_BUNDLE_BUNDLE_VERSION        "${VERSION}")
-SET(MACOSX_BUNDLE_COPYRIGHT             "${PROJECT_COPYRIGHT}")
-SET(MACOSX_BUNDLE_MIMETYPE              "application/x-lmms-project")
-SET(MACOSX_BUNDLE_MIMETYPE_ICON         "project.icns")
-SET(MACOSX_BUNDLE_MIMETYPE_ID           "io.lmms")
-SET(MACOSX_BUNDLE_PROJECT_URL           "${PROJECT_URL}")
-SET(MACOSX_BUNDLE_DMG_TITLE             "${MACOSX_BUNDLE_BUNDLE_NAME} ${MACOSX_BUNDLE_LONG_VERSION_STRING}")
-
-# FIXME: appdmg won't allow volume names > 27 char
-# See also https://github.com/LinusU/node-appdmg/issues/48
-STRING(SUBSTRING "${MACOSX_BUNDLE_DMG_TITLE}" 0 27 MACOSX_BUNDLE_DMG_TITLE)
-
-CONFIGURE_FILE("lmms.plist.in"          "${CMAKE_BINARY_DIR}/Info.plist")
-CONFIGURE_FILE("install_apple.sh.in"    "${CMAKE_BINARY_DIR}/install_apple.sh" @ONLY)
-CONFIGURE_FILE("package_apple.json.in"  "${CMAKE_BINARY_DIR}/package_apple.json" @ONLY)
-
 IF(CMAKE_OSX_ARCHITECTURES)
 	SET(DMG_ARCH "${CMAKE_OSX_ARCHITECTURES}")
 ELSEIF(IS_ARM64)
@@ -29,18 +8,31 @@ ELSE()
 	SET(DMG_ARCH "x86_64")
 ENDIF()
 
-# DMG creation target
-SET(DMG_FILE "${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}-${VERSION}-mac${APPLE_OS_VER}-${DMG_ARCH}.dmg")
-
-FILE(REMOVE "${DMG_FILE}")
-ADD_CUSTOM_TARGET(removedmg
-	COMMAND touch "\"${DMG_FILE}\"" && rm "\"${DMG_FILE}\""
-	COMMENT "Removing old DMG")
-ADD_CUSTOM_TARGET(dmg 
-	COMMAND appdmg "\"${CMAKE_BINARY_DIR}/package_apple.json\"" "\"${DMG_FILE}\""
-	DEPENDS "${CMAKE_BINARY_DIR}/package_apple.json"
-	COMMENT "Generating DMG")
-ADD_DEPENDENCIES(dmg removedmg)
+# Standard CPack options
+set(CPACK_GENERATOR "External" PARENT_SCOPE)
+set(CPACK_EXTERNAL_ENABLE_STAGING TRUE PARENT_SCOPE)
+set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${VERSION}-mac${APPLE_OS_VER}-${DMG_ARCH}")
+set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_FILE_NAME}" PARENT_SCOPE)
+set(CPACK_PRE_BUILD_SCRIPTS "${CMAKE_CURRENT_SOURCE_DIR}/MacDeployQt.cmake" PARENT_SCOPE)
+# disable cpack's strip: causes missing symbols on macOS
+set(CPACK_STRIP_FILES_ORIG "${CPACK_STRIP_FILES}" PARENT_SCOPE)
+set(CPACK_STRIP_FILES FALSE PARENT_SCOPE)
 
-# see also ../postinstall/CMakeLists.txt
+# Custom vars to expose to Cpack
+# must be prefixed with "CPACK_" per https://stackoverflow.com/a/46526757/3196753)
+set(CPACK_CURRENT_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}" PARENT_SCOPE)
+set(CPACK_CURRENT_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}" PARENT_SCOPE)
+set(CPACK_BINARY_DIR "${CMAKE_BINARY_DIR}" PARENT_SCOPE)
+set(CPACK_SOURCE_DIR "${CMAKE_SOURCE_DIR}" PARENT_SCOPE)
+set(CPACK_QMAKE_EXECUTABLE "${QT_QMAKE_EXECUTABLE}" PARENT_SCOPE)
+set(CPACK_CARLA_LIBRARIES "${CARLA_LIBRARIES}" PARENT_SCOPE)
+set(CPACK_PROJECT_NAME "${PROJECT_NAME}" PARENT_SCOPE)
+set(CPACK_PROJECT_VERSION "${VERSION}" PARENT_SCOPE)
+set(CPACK_PROJECT_NAME_UCASE "${PROJECT_NAME_UCASE}" PARENT_SCOPE)
+set(CPACK_PROJECT_URL "${PROJECT_URL}" PARENT_SCOPE)
+set(CPACK_SUIL_MODULES "${Suil_MODULES}" PARENT_SCOPE)
+set(CPACK_SUIL_MODULES_PREFIX "${Suil_MODULES_PREFIX}" PARENT_SCOPE)
 
+if(CMAKE_VERSION VERSION_LESS "3.19")
+    message(WARNING "DMG creation requires at least CMake 3.19")
+endif()