Merge branch 'nightly' into patch-13

.dockerignore

@@ -8,13 +8,15 @@
 !/.rstcheck.cfg
 
 # ignore repo directories and files
+docker/
 gh-pages-template/
 scripts/
 tools/
 crowdin.yml
 
 # ignore dev directories
 build/
+cmake-*/
 venv/
 
 # ignore artifacts

.github/workflows/CI.yml

@@ -500,18 +500,20 @@ jobs:
         run: |
           ${{ steps.python.outputs.python-path }} -m pip install gcovr
           ${{ steps.python.outputs.python-path }} -m gcovr -r .. \
-            --exclude ../tests/ \
-            --exclude ../third-party/ \
+            --exclude '.*tests/.*' \
+            --exclude '.*tests/.*' \
             --xml-pretty \
             -o coverage.xml
 
       - name: Upload coverage
         # any except canceled or skipped
         if: always() && (steps.test_report.outcome == 'success')
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
+          fail_ci_if_error: true
           files: ./build/coverage.xml
           flags: ${{ runner.os }}
+          token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Create/Update GitHub Release
         if: ${{ needs.setup_release.outputs.create_release == 'true' }}
@@ -562,10 +564,12 @@ jobs:
             echo "This is a PUSH event"
             clone_url=${{ github.event.repository.clone_url }}
             branch="${{ github.ref_name }}"
+            default_branch="${{ github.event.repository.default_branch }}"
           else
             echo "This is a PR event"
             clone_url=${{ github.event.pull_request.head.repo.clone_url }}
             branch="${{ github.event.pull_request.head.ref }}"
+            default_branch="${{ github.event.pull_request.head.repo.default_branch }}"
           fi
           echo "Branch: ${branch}"
           echo "Clone URL: ${clone_url}"
@@ -575,6 +579,7 @@ jobs:
           cmake \
             -DGITHUB_BRANCH="${branch}" \
             -DGITHUB_CLONE_URL="${clone_url}" \
+            -DGITHUB_DEFAULT_BRANCH="${default_branch}" \
             -DSUNSHINE_CONFIGURE_HOMEBREW=ON \
             -DSUNSHINE_CONFIGURE_ONLY=ON \
             ..
@@ -610,7 +615,7 @@ jobs:
           echo "publish=${PUBLISH}" >> $GITHUB_OUTPUT
 
       - name: Validate and Publish Homebrew Formula
-        uses: LizardByte/homebrew-release-action@v2024.314.134529
+        uses: LizardByte/homebrew-release-action@v2024.409.24405
         with:
           formula_file: ${{ github.workspace }}/homebrew/sunshine.rb
           git_email: ${{ secrets.GH_BOT_EMAIL }}
@@ -791,7 +796,6 @@ jobs:
           done
 
       - name: Run tests
-        if: always()
         id: test
         timeout-minutes: 10
         run: |
@@ -819,8 +823,8 @@ jobs:
           cd ${build_dir}
           ${{ steps.python.outputs.python-path }} -m pip install gcovr
           sudo ${{ steps.python.outputs.python-path }} -m gcovr -r ../${dir} \
-            --exclude ../${dir}/tests/ \
-            --exclude ../${dir}/third-party/ \
+            --exclude '.*${dir}/tests/.*' \
+            --exclude '.*${dir}/third-party/.*' \
             --gcov-object-directory $(pwd) \
             --verbose \
             --xml-pretty \
@@ -829,10 +833,12 @@ jobs:
       - name: Upload coverage
         # any except canceled or skipped
         if: always() && (steps.test_report.outcome == 'success')
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
+          fail_ci_if_error: false  # todo: re-enable this when action is fixed
           files: ./build/coverage.xml
           flags: ${{ runner.os }}-${{ matrix.os_version }}
+          token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Create/Update GitHub Release
         if: ${{ needs.setup_release.outputs.create_release == 'true' && matrix.release }}
@@ -966,28 +972,30 @@ jobs:
       - name: Setup Dependencies Windows
         uses: msys2/setup-msys2@v2
         with:
-          msystem: ucrt64
           update: true
           install: >-
+            base-devel
+            diffutils
             doxygen
             git
-            mingw-w64-ucrt-x86_64-boost
-            mingw-w64-ucrt-x86_64-cmake
-            mingw-w64-ucrt-x86_64-cppwinrt
-            mingw-w64-ucrt-x86_64-curl
-            mingw-w64-ucrt-x86_64-graphviz
-            mingw-w64-ucrt-x86_64-miniupnpc
-            mingw-w64-ucrt-x86_64-nlohmann-json
-            mingw-w64-ucrt-x86_64-nodejs
-            mingw-w64-ucrt-x86_64-nsis
-            mingw-w64-ucrt-x86_64-onevpl
-            mingw-w64-ucrt-x86_64-openssl
-            mingw-w64-ucrt-x86_64-opus
-            mingw-w64-ucrt-x86_64-toolchain
+
+            make
+            mingw-w64-x86_64-binutils
+            mingw-w64-x86_64-boost
+            mingw-w64-x86_64-cmake
+            mingw-w64-x86_64-curl
+            mingw-w64-x86_64-graphviz
+            mingw-w64-x86_64-miniupnpc
+            mingw-w64-x86_64-nlohmann-json
+            mingw-w64-x86_64-nodejs
+            mingw-w64-x86_64-nsis
+            mingw-w64-x86_64-onevpl
+            mingw-w64-x86_64-openssl
+            mingw-w64-x86_64-opus
+            mingw-w64-x86_64-toolchain
             nasm
             wget
             yasm
-            make
 
       - name: Setup python
         # use this instead of msys2 python due to known issues using wheels, https://www.msys2.org/docs/python/
@@ -1056,18 +1064,20 @@ jobs:
         run: |
           ${{ steps.python-path.outputs.python-path }} -m pip install gcovr
           ${{ steps.python-path.outputs.python-path }} -m gcovr -r .. \
-            --exclude ../tests/ \
-            --exclude ../third-party/ \
+            --exclude '.*tests/.*' \
+            --exclude '.*tests/.*' \
             --xml-pretty \
             -o coverage.xml
 
       - name: Upload coverage
         # any except canceled or skipped
         if: always() && (steps.test_report.outcome == 'success')
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
+          fail_ci_if_error: true
           files: ./build/coverage.xml
           flags: ${{ runner.os }}
+          token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Package Windows Debug Info
         working-directory: build

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [0.23.0] - 2024-04-06
+Attention, this release contains critical security fixes. Please update as soon as possible.
+
+**Breaking**
+- (Linux) Drop support for Ubuntu 20.04
+- (Linux) No longer provide arm64 rpm packages, due to extreme compile time on GitHub hosted runners
+
+**Fixed**
+- (Network) Ensure unpairing takes effect without restart
+- (Capture/Linux) Fix logical comparison of texture size
+- (Service/Windows) Quote the path to sunshinesvc.exe when launching the termination helper
+
+**Added**
+- (WebUI) Localization support
+- (Capture/Linux) Populate host latency for kmx/x11 grab
+- (Capture/Windows) AMF rate control improvements
+- (Linux) Add support for Ubuntu 24.04 (x86_64 only)
+
+**Dependencies**
+- Bump rstcheck from 6.2.0 to 6.2.1
+- Bump org.flatpak.Builder.BaseApp from 644487f to 6e295e6
+- Bump ffmpeg
+- Bump @fortawesome/fontawesome-free from 6.5.1 to 6.5.2
+
+**Misc**
+- (Style) Refactored video encoder declarations
+- (CI) Refactored Linux build in CI
+- (CI) Added unit testing and code coverage
+- (Docs/macOS) Update curl command for Portfile install
+- (Style) Refactor logging initialization
+
+
 ## [0.22.2] - 2024-03-15
 **Fixed**
 - (Tray/Windows) Fix broken system tray icon on some systems
@@ -766,3 +798,4 @@ settings. In v0.17.0, games now run under your user account without elevated pri
 [0.22.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.22.0
 [0.22.1]: https://github.com/LizardByte/Sunshine/releases/tag/v0.22.1
 [0.22.2]: https://github.com/LizardByte/Sunshine/releases/tag/v0.22.2
+[0.23.0]: https://github.com/LizardByte/Sunshine/releases/tag/v0.23.0

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.18)
 # todo - set this conditionally
 
 # todo - set version to 0.0.0 once confident in automated versioning
-project(Sunshine VERSION 0.22.2
+project(Sunshine VERSION 0.23.0
         DESCRIPTION "Self-hosted game stream host for Moonlight"
         HOMEPAGE_URL "https://app.lizardbyte.dev/Sunshine")
 
@@ -29,6 +29,9 @@ include(${CMAKE_MODULE_PATH}/prep/build_version.cmake)
 # cmake build flags
 include(${CMAKE_MODULE_PATH}/prep/options.cmake)
 
+# initial prep
+include(${CMAKE_MODULE_PATH}/prep/init.cmake)
+
 # configure special package files, such as sunshine.desktop, Flatpak manifest, Portfile , etc.
 include(${CMAKE_MODULE_PATH}/prep/special_package_configuration.cmake)
 

README.rst

@@ -17,69 +17,48 @@ System Requirements
 
 **Minimum Requirements**
 
-+------------+------------------------------------------------------------+
-| GPU        | AMD: VCE 1.0 or higher, see `obs-amd hardware support`_    |
-|            +------------------------------------------------------------+
-|            | Intel: VAAPI-compatible, see: `VAAPI hardware support`_    |
-|            +------------------------------------------------------------+
-|            | Nvidia: NVENC enabled cards, see `nvenc support matrix`_   |
-+------------+------------------------------------------------------------+
-| CPU        | AMD: Ryzen 3 or higher                                     |
-|            +------------------------------------------------------------+
-|            | Intel: Core i3 or higher                                   |
-+------------+------------------------------------------------------------+
-| RAM        | 4GB or more                                                |
-+------------+------------------------------------------------------------+
-| OS         | Windows: 10+ (Windows Server not supported)                |
-|            +------------------------------------------------------------+
-|            | macOS: 12+                                                 |
-|            +------------------------------------------------------------+
-|            | Linux/Debian: 11 (bullseye)                                |
-|            +------------------------------------------------------------+
-|            | Linux/Fedora: 38+                                          |
-|            +------------------------------------------------------------+
-|            | Linux/Ubuntu: 20.04+ (focal)                               |
-+------------+------------------------------------------------------------+
-| Network    | Host: 5GHz, 802.11ac                                       |
-|            +------------------------------------------------------------+
-|            | Client: 5GHz, 802.11ac                                     |
-+------------+------------------------------------------------------------+
+.. csv-table::
+   :widths: 15, 60
+
+   "GPU", "AMD: VCE 1.0 or higher, see: `obs-amd hardware support <https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support>`_"
+   "", "Intel: VAAPI-compatible, see: `VAAPI hardware support <https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html>`_"
+   "", "Nvidia: NVENC enabled cards, see: `nvenc support matrix <https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new>`_"
+   "CPU", "AMD: Ryzen 3 or higher"
+   "", "Intel: Core i3 or higher"
+   "RAM", "4GB or more"
+   "OS", "Windows: 10+ (Windows Server does not support virtual gamepads)"
+   "", "macOS: 12+"
+   "", "Linux/Debian: 11 (bullseye)"
+   "", "Linux/Fedora: 38+"
+   "", "Linux/Ubuntu: 22.04+ (jammy)"
+   "Network", "Host: 5GHz, 802.11ac"
+   "", "Client: 5GHz, 802.11ac"
 
 **4k Suggestions**
 
-+------------+------------------------------------------------------------+
-| GPU        | AMD: Video Coding Engine 3.1 or higher                     |
-|            +------------------------------------------------------------+
-|            | Intel: HD Graphics 510 or higher                           |
-|            +------------------------------------------------------------+
-|            | Nvidia: GeForce GTX 1080 or higher                         |
-+------------+------------------------------------------------------------+
-| CPU        | AMD: Ryzen 5 or higher                                     |
-|            +------------------------------------------------------------+
-|            | Intel: Core i5 or higher                                   |
-+------------+------------------------------------------------------------+
-| Network    | Host: CAT5e ethernet or better                             |
-|            +------------------------------------------------------------+
-|            | Client: CAT5e ethernet or better                           |
-+------------+------------------------------------------------------------+
+.. csv-table::
+   :widths: 15, 60
+
+   "GPU", "AMD: Video Coding Engine 3.1 or higher"
+   "", "Intel: HD Graphics 510 or higher"
+   "", "Nvidia: GeForce GTX 1080 or higher"
+   "CPU", "AMD: Ryzen 5 or higher"
+   "", "Intel: Core i5 or higher"
+   "Network", "Host: CAT5e ethernet or better"
+   "", "Client: CAT5e ethernet or better"
 
 **HDR Suggestions**
 
-+------------+------------------------------------------------------------+
-| GPU        | AMD: Video Coding Engine 3.4 or higher                     |
-|            +------------------------------------------------------------+
-|            | Intel: UHD Graphics 730 or higher                          |
-|            +------------------------------------------------------------+
-|            | Nvidia: Pascal-based GPU (GTX 10-series) or higher         |
-+------------+------------------------------------------------------------+
-| CPU        | AMD: todo                                                  |
-|            +------------------------------------------------------------+
-|            | Intel: todo                                                |
-+------------+------------------------------------------------------------+
-| Network    | Host: CAT5e ethernet or better                             |
-|            +------------------------------------------------------------+
-|            | Client: CAT5e ethernet or better                           |
-+------------+------------------------------------------------------------+
+.. csv-table::
+   :widths: 15, 60
+
+   "GPU", "AMD: Video Coding Engine 3.4 or higher"
+   "", "Intel: UHD Graphics 730 or higher"
+   "", "Nvidia: Pascal-based GPU (GTX 10-series) or higher"
+   "CPU", "AMD: todo"
+   "", "Intel: todo"
+   "Network", "Host: CAT5e ethernet or better"
+   "", "Client: CAT5e ethernet or better"
 
 Integrations
 ------------
@@ -126,7 +105,3 @@ Stats
 .. image:: https://img.shields.io/github/stars/lizardbyte/sunshine.svg?logo=github&style=for-the-badge
    :alt: GitHub stars
    :target: https://github.com/LizardByte/Sunshine
-
-.. _nvenc support matrix: https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new
-.. _obs-amd hardware support: https://github.com/obsproject/obs-amd-encoder/wiki/Hardware-Support
-.. _VAAPI hardware support: https://www.intel.com/content/www/us/en/developer/articles/technical/linuxmedia-vaapi.html

cmake/compile_definitions/linux.cmake

@@ -8,10 +8,6 @@ if(${SUNSHINE_BUILD_APPIMAGE})
     string(REPLACE "${CMAKE_INSTALL_PREFIX}" ".${CMAKE_INSTALL_PREFIX}" SUNSHINE_ASSETS_DIR_DEF ${SUNSHINE_ASSETS_DIR})
 endif()
 
-if(NOT DEFINED SUNSHINE_EXECUTABLE_PATH)
-    set(SUNSHINE_EXECUTABLE_PATH "sunshine")
-endif()
-
 # cuda
 set(CUDA_FOUND OFF)
 if(${SUNSHINE_ENABLE_CUDA})
@@ -203,13 +199,13 @@ endif()
 
 # tray icon
 if(${SUNSHINE_ENABLE_TRAY})
-    pkg_check_modules(APPINDICATOR appindicator3-0.1)
+    pkg_check_modules(APPINDICATOR ayatana-appindicator3-0.1)
     if(APPINDICATOR_FOUND)
-        list(APPEND SUNSHINE_DEFINITIONS TRAY_LEGACY_APPINDICATOR=1)
+        list(APPEND SUNSHINE_DEFINITIONS TRAY_AYATANA_APPINDICATOR=1)
     else()
-        pkg_check_modules(APPINDICATOR ayatana-appindicator3-0.1)
+        pkg_check_modules(APPINDICATOR appindicator3-0.1)
         if(APPINDICATOR_FOUND)
-            list(APPEND SUNSHINE_DEFINITIONS TRAY_AYATANA_APPINDICATOR=1)
+            list(APPEND SUNSHINE_DEFINITIONS TRAY_LEGACY_APPINDICATOR=1)
         endif ()
     endif()
     pkg_check_modules(LIBNOTIFY libnotify)

cmake/compile_definitions/windows.cmake

@@ -9,9 +9,6 @@ set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static")
 # gcc complains about misleading indentation in some mingw includes
 list(APPEND SUNSHINE_COMPILE_OPTIONS -Wno-misleading-indentation)
 
-# see gcc bug 98723
-add_definitions(-DUSE_BOOST_REGEX)
-
 # curl
 add_definitions(-DCURL_STATICLIB)
 include_directories(SYSTEM ${CURL_STATIC_INCLUDE_DIRS})
@@ -50,7 +47,6 @@ set(PLATFORM_TARGET_FILES
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_base.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_vram.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_ram.cpp"
-        "${CMAKE_SOURCE_DIR}/src/platform/windows/display_wgc.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/audio.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_device/device_hdr_states.cpp"
         "${CMAKE_SOURCE_DIR}/src/platform/windows/display_device/device_modes.cpp"