Port ArrowVortex to Linux

.clang-tidy

@@ -60,7 +60,7 @@
                     modernize-loop-convert,
                     modernize-make-shared,
                     modernize-make-unique,
-                    modernize-redundant-void-arg,
+                    modernize-redundant-void-arg, #SDL3 headers
                     modernize-replace-random-shuffle,
                     modernize-shrink-to-fit,
                     modernize-use-bool-literals,
@@ -69,7 +69,7 @@
                     modernize-use-equals-default,
                     modernize-use-equals-delete,
                     modernize-use-noexcept,
-                    modernize-use-nullptr,
+                    modernize-use-nullptr, #SDL3 headers
                     modernize-use-override,
                     modernize-use-transparent-functors,
                     readability-redundant-member-init'

.github/workflows/codeql.yml

@@ -40,6 +40,7 @@ jobs:
             cmake -Bbuild
             -DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_INSTALLATION_ROOT\scripts\buildsystems\vcpkg.cmake"
             -DVCPKG_TARGET_TRIPLET=x64-windows-static-md
+            -DYML=YML
           build: cmake --build build --parallel "$env:NUMBER_OF_PROCESSORS"
 
     steps:

.github/workflows/release.yml

@@ -0,0 +1,125 @@
+name: Build & Latest Beta
+
+on:
+  push:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+env:
+  USERNAME: uvcat7
+  FEED_URL: https://nuget.pkg.github.com/uvcat7/index.json
+  VCPKG_BINARY_SOURCES: "clear;nuget,https://nuget.pkg.github.com/uvcat7/index.json,readwrite"
+
+jobs:
+  formatting:
+    name: "Check formatting"
+    runs-on: windows-2022
+    permissions:
+      contents: read
+    steps:
+      - name: Get AV
+        uses: actions/checkout@v7
+      - name: Check formatting with clang-format
+        run: >
+          clang-format --dry-run --Werror -style=file $(find src/ -type f \( -name '*.cpp' -o -name '*.h' -o -name '*.c' -o -name '*.hpp' \))
+        shell: bash
+  windows:
+    name: "Build Windows x64"
+    runs-on: windows-2022
+    permissions:
+      contents: read
+    steps:
+      - name: Get AV
+        uses: actions/checkout@v7
+      - name: Add NuGet sources
+        shell: pwsh
+        run: |
+          .$(vcpkg fetch nuget) `
+            sources add `
+            -Source "${{ env.FEED_URL }}" `
+            -StorePasswordInClearText `
+            -Name GitHubPackages `
+            -UserName "${{ env.USERNAME }}" `
+            -Password "${{ secrets.GH_PACKAGES_TOKEN }}"
+          .$(vcpkg fetch nuget) `
+            setapikey "${{ secrets.GH_PACKAGES_TOKEN }}" `
+            -Source "${{ env.FEED_URL }}"
+      - name: Configure CMake
+        run: >
+          cmake -Bbuild -DCMAKE_BUILD_TYPE=Release
+          -DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_INSTALLATION_ROOT\scripts\buildsystems\vcpkg.cmake"
+          -DVCPKG_TARGET_TRIPLET=x64-windows-static-md
+          -DYML=YML
+      - name: Build AV
+        run: cmake --build build --config Release --parallel "$env:NUMBER_OF_PROCESSORS"
+      - name: Collect into a directory
+        if: github.ref_name == 'beta'
+        run: cmake --install build --config Release --prefix ./
+      - name: Upload artifact
+        if: github.ref_name == 'beta'
+        uses: actions/upload-artifact@v5
+        with:
+          name: ArrowVortex-${{ github.sha }}
+          path: |
+            bin/assets
+            bin/noteskins
+            bin/settings
+            bin/ArrowVortex.exe
+          if-no-files-found: error
+  linux:
+    name: "Build Linux x64"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Get AV
+        uses: actions/checkout@v7
+      - name: Add NuGet sources
+        shell: bash
+        run: |
+          sudo apt-get install -qq -y mono-devel nasm libltdl-dev \
+            autoconf autoconf-archive automake libtool \
+            libx11-dev libxft-dev libxext-dev \
+            libwayland-dev libxkbcommon-dev libegl1-mesa-dev \
+            libibus-1.0-dev zenity clang-tidy clang-format build-essential git \
+            pkg-config cmake ninja-build gnome-desktop-testing libasound2-dev libpulse-dev \
+            libaudio-dev libjack-dev libsndio-dev libusb-1.0-0-dev libx11-dev libxext-dev \
+            libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev libxss-dev libwayland-dev \
+            libxkbcommon-dev libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
+            libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev fcitx-libs-dev \
+            libasound2-dev libdecor-0-dev python3-venv libthai-dev libpipewire-0.3-dev \
+            liburing-dev
+          mono `vcpkg fetch nuget | tail -n 1` \
+            sources add \
+            -Source "${{ env.FEED_URL }}" \
+            -StorePasswordInClearText \
+            -Name GitHubPackages \
+            -UserName "${{ env.USERNAME }}" \
+            -Password "${{ secrets.GH_PACKAGES_TOKEN }}"
+          mono `vcpkg fetch nuget | tail -n 1` \
+            setapikey "${{ secrets.GH_PACKAGES_TOKEN }}" \
+            -Source "${{ env.FEED_URL }}"
+      - name: Configure CMake
+        run: >
+          cmake -Bbuild -DCMAKE_BUILD_TYPE=Release
+          -DCMAKE_TOOLCHAIN_FILE="${VCPKG_INSTALLATION_ROOT}/scripts/buildsystems/vcpkg.cmake"
+          -DVCPKG_TARGET_TRIPLET=x64-linux
+          -DPRESET_NAME=linux-release
+          -DYML=YML
+      - name: Build AV
+        run: cmake --build build --config Release --parallel $(nproc)
+      - name: Collect into a directory
+        if: github.ref_name == 'beta'
+        run: cmake --install build --config Release --prefix ./
+      - name: Upload artifact
+        if: github.ref_name == 'beta'
+        uses: actions/upload-artifact@v5
+        with:
+          name: ArrowVortex-${{ github.sha }}
+          path: |
+            bin/assets
+            bin/noteskins
+            bin/settings
+            bin/ArrowVortex
+          if-no-files-found: error

BUILDING.md

@@ -11,10 +11,10 @@ Prerequsites:
 ### With CMake CLI
 With Developer PowerShell open at root folder of this project run:
 ```pwsh
-cmake -Bbuild -S. -DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET=x64-windows-static-md
+cmake -S. -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET=x64-linux -DPRESET_NAME=linux-release
 cmake --build build
 ```
-Resulting binary will be located at `build/src/System/Debug/ArrowVortex.exe`
+The resulting binary will be located at `out\build\{windows-debug | windows-release}\bin\ArrowVortex.exe`
 
 To install ArrowVortex to a folder run:
 ```pwsh
@@ -25,7 +25,72 @@ cmake --install build --prefix "<your_folder_here>"
 1. Run `vcpkg integrate install` in Developer PowerShell. This will integrate vcpkg with your installation of Visual Studio and needs to be run once.
 2. Open root folder of this project in Visual Studio
 
+## Linux
+
+Prerequsites:
+* Needed packages from package manager
+* CMake
+* vcpkg (per https://lindevs.com/install-vcpkg-on-ubuntu). Note you will need to give your user read/write access to the install folder with sudo.
+* `VCPKG_ROOT` environment variable pointing at vcpkg installation folder (env VCPKG_ROOT={path}) OR install it to /opt/vcpkg.
+
+### Build Packages
+For Ubuntu/Debian install:
+```
+sudo apt-get install build-essential git \
+pkg-config cmake ninja-build gnome-desktop-testing libasound2-dev libpulse-dev \
+libaudio-dev libjack-dev libsndio-dev libusb-1.0-0-dev libx11-dev libxext-dev \
+libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev libxss-dev libwayland-dev \
+libxkbcommon-dev libdrm-dev libgbm-dev libgl1-mesa-dev libgles2-mesa-dev \
+libegl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev fcitx-libs-dev \
+libasound2-dev libdecor-0-dev python3-venv libltdl-dev autoconf autoconf-archive \
+automake libtool libx11-dev libxft-dev libxext-dev libwayland-dev libxkbcommon-dev \
+libegl1-mesa-dev libibus-1.0-dev clang-tidy clang-format zenity python3-jinja2
+--ignore-missing
+```
+
+For Fedora install:
+```sudo dnf install gcc git-core make cmake \
+alsa-lib-devel fribidi-devel pulseaudio-libs-devel pipewire-devel \
+libX11-devel libXext-devel libXrandr-devel libXcursor-devel libXfixes-devel \
+libXi-devel libXScrnSaver-devel libXtst-devel dbus-devel ibus-devel \
+systemd-devel mesa-libGL-devel libxkbcommon-devel mesa-libGLES-devel \
+mesa-libEGL-devel vulkan-devel wayland-devel wayland-protocols-devel \
+libdrm-devel mesa-libgbm-devel libusb1-devel libdecor-devel \
+pipewire-jack-audio-connection-kit-devel libthai-devel liburing-devel zlib-ng-compat-static
+```
+
+For Arch-based distributions install:
+```sudo pacman -S --needed sdl3 libgl libx11 libxext libxrandr libxcursor \
+libxfixes libxi libxss wayland libxkbcommon libdrm mesa alsa-lib libpulse \
+jack git cmake ninja pkg-config python python-jinja curl zip unzip tar libxrandr \
+libxcursor libxfixes libxi libxss wayland-protocols libdecor libusb sndio libltdl \
+autoconf autoconf-archive nasm automake libtool libxft
+```
+
+You may be missing more packages depending on your distribution and what default packages it comes with. However, missing packages should be flagged by vcpkg or caused a build command to fail.
+
+### With CMake CLI
+In the terminal at the root folder of this project run:
+```
+cmake -S . -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE="$VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET=x64-linux -DPRESET_NAME={linux-debug | linux-release} -DCMAKE_C_COMPILER="gcc" -DCMAKE_CXX_COMPILER="g++" -DCMAKE_MAKE_PROGRAM="ninja"
+cmake --build build
+```
+The resulting binary will be located at `out/build/{linux-debug | linux-release}/bin/ArrowVortex`
+
+To install ArrowVortex to a folder run:
+```
+cmake --install build --prefix "{your_folder_here}"
+```
+
+### With Visual Studio
+1. Use the connection manager to connect to your Linux installation (preferably WSL) over SSH: https://learn.microsoft.com/en-us/cpp/linux/connect-to-your-remote-linux-computer?view=msvc-170#connect-to-wsl
+2. Install vcpkg on the remote system to /opt/vcpkg, or modify CMakePresets.json/create a user preset.
+3. Build on Windows to the Linux installation. WSL can run the GUI application.
 
 ## Troubleshooting
-### CMake can't find freetype
-CMake failed to integrate with vcpkg. Remove your build directory (either `build/` or `out/`) and follow instructions for your system.
+### No SDL3 video or audio device
+One of the dependent development packages SDL needs is missing. Delete your cached vcpkg packages so they are force rebuilt, then rerun `vcpkg integrate install` and the build process.
+### On WSL, the window border is sometimes missing
+This is a WSL bug and cannot be fixed. Restarting your PC tends to work temporarily.
+### On WSL, the audio is choppy
+This can't be fixed without desyncing the audio between the host and client, as WSL uses pulseaudio to send the sound to Windows over a virtual network audio port.

CMakeLists.txt

@@ -1,25 +1,56 @@
-cmake_minimum_required(VERSION 3.30)
+cmake_minimum_required(VERSION 3.28)
 
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 project(ArrowVortex)
 
 set(CMAKE_CONFIGURATION_TYPES Debug;Release;MinSizeRel)
 if("${CMAKE_BUILD_TYPE}" STREQUAL "MinSizeRel")
-    set(tidy_flags "--fix-errors;--fix-notes")
+    set(tidy_flags "--fix-errors;--fix-notes;")
     set(format_flags "-i")
 else()
-    set(tidy_flags "--warnings-as-errors=*")
+    set(tidy_flags "--warnings-as-errors=*;")
     set(format_flags "--dry-run")
 endif()
-set(CMAKE_CXX_CLANG_TIDY "clang-tidy;${tidy_flags};-extra-arg=/EHsc;-p=build")
+if(WIN32)
+    set(tidy_extra "-extra-arg=/EHsc;--exclude-header-filter=SDL3*;")
+endif()
+set(CMAKE_CXX_CLANG_TIDY "clang-tidy;${tidy_flags}${tidy_extra}-p=build")
+
+# Sometimes caching will cause CMAKE_TOOLCHAIN_FILE, build presets, and includes to not update/work, so include fallbacks by hand.
+if(NOT DEFINED CMAKE_TOOLCHAIN_FILE OR "${CMAKE_TOOLCHAIN_FILE}" STREQUAL "")
+    if(DEFINED ENV{VCPKG_ROOT} AND NOT "$ENV{VCPKG_ROOT}" STREQUAL "")
+        message(WARNING "CMAKE_TOOLCHAIN_FILE is not defined, manually including.")
+        include("$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
+    elseif(NOT "${VCPKG_ROOT}" STREQUAL "")
+        message(WARNING "CMAKE_TOOLCHAIN_FILE is not defined, manually including.")
+        include("${VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
+    elseif(UNIX AND NOT APPLE)
+        message(WARNING "{VCPKG_ROOT} is not defined, attempting fallback generation.")
+        include("/opt/vcpkg/scripts/buildsystems/vcpkg.cmake")
+    elseif(WIN32)
+        message(WARNING "%VCPKG_ROOT% is not defined, attempting fallback generation.")
+        include("C:/Program Files/Microsoft Visual Studio/18/Community/VC/vcpkg/scripts/buildsystems/vcpkg.cmake")
+    endif()
+endif()
 
+if("${toolchain_include}" STREQUAL "")
+    if("${YML}" STREQUAL "")
+        set(toolchain_include "${PROJECT_SOURCE_DIR}/out/build/${PRESET_NAME}/vcpkg_installed/${VCPKG_TARGET_TRIPLET}/include")
+    else()
+        set(toolchain_include "${PROJECT_SOURCE_DIR}/build/vcpkg_installed/${VCPKG_TARGET_TRIPLET}/include")
+    endif()
+endif()
+
+message(STATUS "Including toolchain folder: ${toolchain_include}") 
+include_directories("${toolchain_include}")
 include_directories("${PROJECT_SOURCE_DIR}/src")
 
-find_package(aubio CONFIG REQUIRED)
+find_package(Aubio CONFIG NAMES aubio Aubio)
 find_package(FFMPEG REQUIRED)
 find_package(Freetype REQUIRED)
 find_package(iir CONFIG REQUIRED)
@@ -43,11 +74,14 @@ install(DIRECTORY bin/noteskins DESTINATION bin)
 install(DIRECTORY bin/settings DESTINATION bin)
 
 file(GLOB_RECURSE path_sources "src/*.cpp" "src/*.hpp" "src/*.c" "src/*.h")
-add_custom_target(format ALL)
-add_custom_command(
-    TARGET format
-    POST_BUILD
-    COMMAND clang-format ${format_flags} -Werror -style=file ${path_sources}
-    USES_TERMINAL
-)
-add_dependencies(format ArrowVortex)
+# Only prevent format/building on Windows, as Linux's clang-format is slightly different
+if(WIN32)
+    add_custom_target(format ALL)
+    add_custom_command(
+        TARGET format
+        POST_BUILD
+        COMMAND clang-format ${format_flags} -Werror -style=file ${path_sources}
+        USES_TERMINAL
+    )
+    add_dependencies(format ArrowVortex)
+endif()