From ff688d92358d68332e0bb016e6bfb442a8cc734b Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Mon, 16 Oct 2023 09:11:27 -0400 Subject: [PATCH 001/197] ci: update release notifier (#1755) --- .github/workflows/release-notifier.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release-notifier.yml b/.github/workflows/release-notifier.yml index 5161fc5f5d5..2827224b8bf 100644 --- a/.github/workflows/release-notifier.yml +++ b/.github/workflows/release-notifier.yml @@ -15,7 +15,7 @@ on: jobs: discord: if: >- - (github.repository, 'LizardByte/') and + startsWith(github.repository, 'LizardByte/') and not(github.event.release.prerelease) and not(github.event.release.draft) runs-on: ubuntu-latest @@ -34,7 +34,7 @@ jobs: facebook_group: if: >- - (github.repository, 'LizardByte/') and + startsWith(github.repository, 'LizardByte/') and not(github.event.release.prerelease) and not(github.event.release.draft) runs-on: ubuntu-latest @@ -51,7 +51,7 @@ jobs: facebook_page: if: >- - (github.repository, 'LizardByte/') and + startsWith(github.repository, 'LizardByte/') and not(github.event.release.prerelease) and not(github.event.release.draft) runs-on: ubuntu-latest @@ -68,7 +68,7 @@ jobs: reddit: if: >- - (github.repository, 'LizardByte/') and + startsWith(github.repository, 'LizardByte/') and not(github.event.release.prerelease) and not(github.event.release.draft) runs-on: ubuntu-latest @@ -88,7 +88,7 @@ jobs: twitter: if: >- - (github.repository, 'LizardByte/') and + startsWith(github.repository, 'LizardByte/') and not(github.event.release.prerelease) and not(github.event.release.draft) runs-on: ubuntu-latest From 82d0ff6699ccadc85a18b578421f8a44a4211f67 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Oct 2023 23:10:29 -0400 Subject: [PATCH 002/197] build(deps): bump third-party/wayland-protocols from `681c33c` to `d70af2e` (#1753) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- third-party/wayland-protocols | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/wayland-protocols b/third-party/wayland-protocols index 681c33c8547..d70af2ea1e9 160000 --- a/third-party/wayland-protocols +++ b/third-party/wayland-protocols @@ -1 +1 @@ -Subproject commit 681c33c8547d6aefe24455ba2bffe1c5ae11fee5 +Subproject commit d70af2ea1e9892f16ec5d25fd04e36826b7e3aef From e7fc2ed49af0a309ddeae4c82bc95bd7e993c7c9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 17 Oct 2023 09:04:39 -0400 Subject: [PATCH 003/197] build(deps): bump third-party/nv-codec-headers from `9402b5a` to `22441b5` (#1725) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- third-party/nv-codec-headers | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/nv-codec-headers b/third-party/nv-codec-headers index 9402b5a7693..22441b505d9 160000 --- a/third-party/nv-codec-headers +++ b/third-party/nv-codec-headers @@ -1 +1 @@ -Subproject commit 9402b5a7693e9841f8a4f4488cd2df21ac55c685 +Subproject commit 22441b505d9d9afc1e3002290820909846c24bdc From 48a6d2af6f6f29d79b8f0c10fa2b439afaa49590 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 17 Oct 2023 09:52:13 -0400 Subject: [PATCH 004/197] Bump third-party/nanors from `395e5ad` to `e9e242e` (#1090) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- third-party/nanors | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/nanors b/third-party/nanors index 395e5ada44d..e9e242e98e2 160000 --- a/third-party/nanors +++ b/third-party/nanors @@ -1 +1 @@ -Subproject commit 395e5ada44dd8d5974eaf6bb6b17f23406e3ca72 +Subproject commit e9e242e98e27037830490b2a752895ca68f75f8b From 2617241d7bcbf2ed81245983ced9e14ac90eeb37 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 17 Oct 2023 10:56:05 -0400 Subject: [PATCH 005/197] build(deps): bump third-party/Simple-Web-Server from `2f29926` to `27b41f5` (#1217) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- third-party/Simple-Web-Server | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/Simple-Web-Server b/third-party/Simple-Web-Server index 2f29926dbbc..27b41f5ee15 160000 --- a/third-party/Simple-Web-Server +++ b/third-party/Simple-Web-Server @@ -1 +1 @@ -Subproject commit 2f29926dbbcd8a0425064d98c24f37ac50bd0b5b +Subproject commit 27b41f5ee154cca0fce4fe2955dd886d04e3a4ed From f80251f1723fa67a20c7ba7e2379ddcc702f8619 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 17 Oct 2023 11:31:15 -0400 Subject: [PATCH 006/197] build(deps): bump third-party/miniupnp from `e439318` to `fb5c328` (#1511) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- third-party/miniupnp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/miniupnp b/third-party/miniupnp index e439318cf78..fb5c328a5e8 160000 --- a/third-party/miniupnp +++ b/third-party/miniupnp @@ -1 +1 @@ -Subproject commit e439318cf782e30066d430f27a1365e013a5ab94 +Subproject commit fb5c328a5e8fd57a3ec0f5d33915377a5d3581f3 From 8096364a0a72f9799e0e6bead61f43d6c94a5599 Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Tue, 17 Oct 2023 13:16:05 -0400 Subject: [PATCH 007/197] Bump ffmpeg (#1717) --- third-party/ffmpeg-linux-aarch64 | 2 +- third-party/ffmpeg-linux-powerpc64le | 2 +- third-party/ffmpeg-linux-x86_64 | 2 +- third-party/ffmpeg-macos-aarch64 | 2 +- third-party/ffmpeg-macos-x86_64 | 2 +- third-party/ffmpeg-windows-x86_64 | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/third-party/ffmpeg-linux-aarch64 b/third-party/ffmpeg-linux-aarch64 index 8b8848d40df..315b077e231 160000 --- a/third-party/ffmpeg-linux-aarch64 +++ b/third-party/ffmpeg-linux-aarch64 @@ -1 +1 @@ -Subproject commit 8b8848d40df336cb290e58b7e57c396009100595 +Subproject commit 315b077e23127a4c0bf3cff3bb6576e64497ff29 diff --git a/third-party/ffmpeg-linux-powerpc64le b/third-party/ffmpeg-linux-powerpc64le index 9dadebb470b..4074d524629 160000 --- a/third-party/ffmpeg-linux-powerpc64le +++ b/third-party/ffmpeg-linux-powerpc64le @@ -1 +1 @@ -Subproject commit 9dadebb470b99483ab7a5c9d5ac52f299bae42f7 +Subproject commit 4074d524629ca53f8df2365be30ec93abe5439e9 diff --git a/third-party/ffmpeg-linux-x86_64 b/third-party/ffmpeg-linux-x86_64 index e0169be4b69..c887d24822c 160000 --- a/third-party/ffmpeg-linux-x86_64 +++ b/third-party/ffmpeg-linux-x86_64 @@ -1 +1 @@ -Subproject commit e0169be4b6929ca8ed0068ea25db3d62baa1335d +Subproject commit c887d24822cccbf1dc01a0cfacc977db46e318db diff --git a/third-party/ffmpeg-macos-aarch64 b/third-party/ffmpeg-macos-aarch64 index 4537513b457..fe12a607ed8 160000 --- a/third-party/ffmpeg-macos-aarch64 +++ b/third-party/ffmpeg-macos-aarch64 @@ -1 +1 @@ -Subproject commit 4537513b457ec50926d5ef81c579504364d0fa21 +Subproject commit fe12a607ed8357611ec2dabc7e31a6cc1557b003 diff --git a/third-party/ffmpeg-macos-x86_64 b/third-party/ffmpeg-macos-x86_64 index 7057139d873..97ff12c2282 160000 --- a/third-party/ffmpeg-macos-x86_64 +++ b/third-party/ffmpeg-macos-x86_64 @@ -1 +1 @@ -Subproject commit 7057139d8731cfb577859f832ff59402137fdff2 +Subproject commit 97ff12c22822bf33553be7789b6c5e152b00221a diff --git a/third-party/ffmpeg-windows-x86_64 b/third-party/ffmpeg-windows-x86_64 index bbf911e6b2a..9bebfe2cfab 160000 --- a/third-party/ffmpeg-windows-x86_64 +++ b/third-party/ffmpeg-windows-x86_64 @@ -1 +1 @@ -Subproject commit bbf911e6b2a2f3c2c0ca1675a11ed3e1bdd36e9a +Subproject commit 9bebfe2cfab475549bc2b700449586a4a458fce5 From 5b052d7c2c059aa26fdf79cc87885af2f461f544 Mon Sep 17 00:00:00 2001 From: Ehab Ajmal <33014707+ehabajmal@users.noreply.github.com> Date: Thu, 19 Oct 2023 10:43:42 -0400 Subject: [PATCH 008/197] Add guide for setting custom res with nvidia on linux (#1767) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> --- docs/source/about/guides/app_examples.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/about/guides/app_examples.rst b/docs/source/about/guides/app_examples.rst index 4cb45b7d5c1..e0bc543253a 100644 --- a/docs/source/about/guides/app_examples.rst +++ b/docs/source/about/guides/app_examples.rst @@ -197,6 +197,28 @@ Changing Resolution and Refresh Rate (Linux - KDE Plasma - Wayland and X11) | | Undo: ``kscreen-doctor output.HDMI-A-1.mode.3840x2160@120`` | +----------------------+----------------------------------------------------------------------------------------------------------------------------------+ +Changing Resolution (Linux - NVIDIA) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++----------------------+------------------------------------------------------------------------------------------------------+ +| **Field** | **Value** | ++----------------------+------------------------------------------------------------------------------------------------------+ +| Command Preparations | Do: ``sh -c "${HOME}/scripts/set-custom-res.sh ${SUNSHINE_CLIENT_WIDTH} ${SUNSHINE_CLIENT_HEIGHT}"`` | +| +------------------------------------------------------------------------------------------------------+ +| | Undo: ``sh -c "${HOME}/scripts/set-custom-res.sh 3840 2160"`` | ++----------------------+------------------------------------------------------------------------------------------------------+ + +The ``set-custom-res.sh`` will have this content: + .. code-block:: bash + + #!/bin/bash + + # Get params and set any defaults + width=${1:-1920} + height=${2:-1080} + output=${3:-HDMI-1} + nvidia-settings -a CurrentMetaMode="${output}: nvidia-auto-select { ViewPortIn=${width}x${height}, ViewPortOut=${width}x${height}+0+0 }" + Flatpak ^^^^^^^ From 3212b036a1822c7225673c7c1eb742998700a03f Mon Sep 17 00:00:00 2001 From: Erick C Date: Sun, 22 Oct 2023 15:03:33 -0400 Subject: [PATCH 009/197] Manual DS4 mode: Allow Back/Select to trigger Touchpad click (#1772) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> --- docs/source/about/advanced_usage.rst | 17 +++++++++++++++++ src/config.cpp | 2 ++ src/config.h | 1 + src/platform/windows/input.cpp | 5 ++++- src_assets/common/assets/web/config.html | 24 ++++++++++++++++++++++++ 5 files changed, 48 insertions(+), 1 deletion(-) diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index e9bba6781f1..c9d9ebae3b4 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -152,6 +152,23 @@ gamepad .. code-block:: text gamepad = auto + +ds4_back_as_touchpad_click +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + .. Hint:: Only applies when gamepad is set to ds4 manually. Unused in other gamepad modes. + + Allow Select/Back inputs to also trigger DS4 touchpad click. Useful for clients looking to emulate touchpad click + on Xinput devices. + +**Default** + ``enabled`` + +**Example** + .. code-block:: text + + ds4_back_as_touchpad_click = enabled back_button_timeout ^^^^^^^^^^^^^^^^^^^ diff --git a/src/config.cpp b/src/config.cpp index 726f67f8ca7..d5932d62cfe 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -418,6 +418,7 @@ namespace config { platf::supported_gamepads().front().data(), platf::supported_gamepads().front().size(), }, // Default gamepad + true, // back as touchpad click enabled (manual DS4 only) true, // keyboard enabled true, // mouse enabled @@ -1041,6 +1042,7 @@ namespace config { } string_restricted_f(vars, "gamepad"s, input.gamepad, platf::supported_gamepads()); + bool_f(vars, "ds4_back_as_touchpad_click", input.ds4_back_as_touchpad_click); bool_f(vars, "mouse", input.mouse); bool_f(vars, "keyboard", input.keyboard); diff --git a/src/config.h b/src/config.h index 090e6b6864d..749a8556d11 100644 --- a/src/config.h +++ b/src/config.h @@ -112,6 +112,7 @@ namespace config { std::chrono::duration key_repeat_period; std::string gamepad; + bool ds4_back_as_touchpad_click; bool keyboard; bool mouse; diff --git a/src/platform/windows/input.cpp b/src/platform/windows/input.cpp index ca9cfba7b93..29dd758acc1 100644 --- a/src/platform/windows/input.cpp +++ b/src/platform/windows/input.cpp @@ -1174,7 +1174,7 @@ namespace platf { BOOST_LOG(info) << "Gamepad " << id.globalIndex << " will be Xbox 360 controller (manual selection)"sv; selectedGamepadType = Xbox360Wired; } - else if (config::input.gamepad == "ps4"sv || config::input.gamepad == "ds4"sv) { + else if (config::input.gamepad == "ds4"sv) { BOOST_LOG(info) << "Gamepad " << id.globalIndex << " will be DualShock 4 controller (manual selection)"sv; selectedGamepadType = DualShock4Wired; } @@ -1334,6 +1334,9 @@ namespace platf { // Allow either PS4/PS5 clickpad button or Xbox Series X share button to activate DS4 clickpad if (gamepad_state.buttonFlags & (TOUCHPAD_BUTTON | MISC_BUTTON)) buttons |= DS4_SPECIAL_BUTTON_TOUCHPAD; + // Manual DS4 emulation: check if BACK button should also trigger DS4 touchpad click + if (config::input.gamepad == "ds4"sv && config::input.ds4_back_as_touchpad_click && (gamepad_state.buttonFlags & BACK)) buttons |= DS4_SPECIAL_BUTTON_TOUCHPAD; + return (DS4_SPECIAL_BUTTONS) buttons; } diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 6f9e89de027..6e2b61b760c 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -105,6 +105,29 @@

Configuration

Choose which type of gamepad to emulate on the host
+
+
+

+ +

+
+
+
+ + +
When forcing DS4 emulation, map Back/Select to Touchpad Click
+
+
+
+
+
@@ -1136,6 +1159,7 @@

"capture": "", "controller": "enabled", "install_steam_audio_drivers": "enabled", + "ds4_back_as_touchpad_click": "enabled", "dwmflush": "enabled", "encoder": "", "fps": "[10,30,60,90,120]", From ab3ff2d355985a61d6d3420a3982333b6010000f Mon Sep 17 00:00:00 2001 From: detiam <44510779+detiam@users.noreply.github.com> Date: Thu, 26 Oct 2023 02:14:28 +0800 Subject: [PATCH 010/197] Update linux sunshine.desktop (#1768) --- cmake/packaging/linux.cmake | 7 ++++++- cmake/prep/special_package_configuration.cmake | 2 ++ packaging/linux/AppImage/sunshine.desktop | 3 ++- packaging/linux/flatpak/sunshine.desktop | 15 +++++++++++++-- packaging/linux/flatpak/sunshine_kms.desktop | 7 ++----- packaging/linux/sunshine.desktop | 12 +++++++++--- packaging/linux/sunshine_terminal.desktop | 6 ++++++ 7 files changed, 40 insertions(+), 12 deletions(-) create mode 100644 packaging/linux/sunshine_terminal.desktop diff --git a/cmake/packaging/linux.cmake b/cmake/packaging/linux.cmake index aee40cb7f1b..842277b9d27 100644 --- a/cmake/packaging/linux.cmake +++ b/cmake/packaging/linux.cmake @@ -88,7 +88,12 @@ endif() # desktop file # todo - validate desktop files with `desktop-file-validate` -install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.desktop" DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications") +install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.desktop" + DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications") +if(NOT ${SUNSHINE_BUILD_APPIMAGE}) + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_terminal.desktop" + DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications") +endif() if(${SUNSHINE_BUILD_FLATPAK}) install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_kms.desktop" DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications") diff --git a/cmake/prep/special_package_configuration.cmake b/cmake/prep/special_package_configuration.cmake index cd285a65acc..3094c2399a5 100644 --- a/cmake/prep/special_package_configuration.cmake +++ b/cmake/prep/special_package_configuration.cmake @@ -9,8 +9,10 @@ elseif (UNIX) elseif(${SUNSHINE_BUILD_FLATPAK}) configure_file(packaging/linux/flatpak/sunshine.desktop sunshine.desktop @ONLY) configure_file(packaging/linux/flatpak/sunshine_kms.desktop sunshine_kms.desktop @ONLY) + configure_file(packaging/linux/sunshine_terminal.desktop sunshine_terminal.desktop @ONLY) else() configure_file(packaging/linux/sunshine.desktop sunshine.desktop @ONLY) + configure_file(packaging/linux/sunshine_terminal.desktop sunshine_terminal.desktop @ONLY) endif() # configure metadata file diff --git a/packaging/linux/AppImage/sunshine.desktop b/packaging/linux/AppImage/sunshine.desktop index a345e5dc467..911735c8c2f 100644 --- a/packaging/linux/AppImage/sunshine.desktop +++ b/packaging/linux/AppImage/sunshine.desktop @@ -5,7 +5,8 @@ Exec=sunshine Version=1.0 Comment=@PROJECT_DESCRIPTION@ Icon=sunshine -Categories=Utility; +Keywords=gamestream;stream;moonlight;remote play; +Categories=AudioVideo;Network;RemoteAccess; Terminal=true X-AppImage-Name=sunshine X-AppImage-Version=@PROJECT_VERSION@ diff --git a/packaging/linux/flatpak/sunshine.desktop b/packaging/linux/flatpak/sunshine.desktop index acfced8d7a6..33124ab842f 100644 --- a/packaging/linux/flatpak/sunshine.desktop +++ b/packaging/linux/flatpak/sunshine.desktop @@ -5,5 +5,16 @@ Exec=flatpak run dev.lizardbyte.sunshine Version=1.0 Comment=@PROJECT_DESCRIPTION@ Icon=sunshine -Categories=Utility; -Terminal=true +Keywords=gamestream;stream;moonlight;remote play; +Categories=AudioVideo;Network;RemoteAccess; +Actions=RunInTerminal;KMS; + +[Desktop Action RunInTerminal] +Name=Run in Terminal +Icon=application-x-executable +Exec=gio launch @CMAKE_INSTALL_PREFIX@/share/applications/sunshine_terminal.desktop + +[Desktop Action KMS] +Name=Run in Terminal (KMS) +Icon=application-x-executable +Exec=gio launch @CMAKE_INSTALL_PREFIX@/share/applications/sunshine_kms.desktop diff --git a/packaging/linux/flatpak/sunshine_kms.desktop b/packaging/linux/flatpak/sunshine_kms.desktop index 139fd0c4cb7..521f4b936ae 100644 --- a/packaging/linux/flatpak/sunshine_kms.desktop +++ b/packaging/linux/flatpak/sunshine_kms.desktop @@ -1,9 +1,6 @@ [Desktop Entry] -Type=Application Name=@PROJECT_NAME@ (KMS) Exec=sudo -i PULSE_SERVER=unix:$(pactl info | awk '/Server String/{print$3}') flatpak run dev.lizardbyte.sunshine -Version=1.0 -Comment=@PROJECT_DESCRIPTION@ -Icon=sunshine -Categories=Utility; Terminal=true +Type=Application +NoDisplay=true diff --git a/packaging/linux/sunshine.desktop b/packaging/linux/sunshine.desktop index d5cf7c03f18..6bb8687fd1c 100644 --- a/packaging/linux/sunshine.desktop +++ b/packaging/linux/sunshine.desktop @@ -1,9 +1,15 @@ [Desktop Entry] Type=Application Name=@PROJECT_NAME@ -Exec=sunshine +Exec=/usr/bin/env systemctl start --u sunshine Version=1.0 Comment=@PROJECT_DESCRIPTION@ Icon=sunshine -Categories=Utility; -Terminal=true +Keywords=gamestream;stream;moonlight;remote play; +Categories=AudioVideo;Network;RemoteAccess; +Actions=RunInTerminal; + +[Desktop Action RunInTerminal] +Name=Run in Terminal +Icon=application-x-executable +Exec=gio launch @CMAKE_INSTALL_PREFIX@/share/applications/sunshine_terminal.desktop diff --git a/packaging/linux/sunshine_terminal.desktop b/packaging/linux/sunshine_terminal.desktop new file mode 100644 index 00000000000..c26889123cb --- /dev/null +++ b/packaging/linux/sunshine_terminal.desktop @@ -0,0 +1,6 @@ +[Desktop Entry] +Name=@PROJECT_NAME@ +Exec=sunshine +Terminal=true +Type=Application +NoDisplay=true From 842a4cf7b2d318c470883e3e3995cdfbbfc87246 Mon Sep 17 00:00:00 2001 From: everything411 Date: Fri, 27 Oct 2023 21:28:29 +0800 Subject: [PATCH 011/197] fix(audio:windows): set cbSize correctly (#1787) --- src/platform/windows/audio.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform/windows/audio.cpp b/src/platform/windows/audio.cpp index c02f1626fd6..1311a694fd1 100644 --- a/src/platform/windows/audio.cpp +++ b/src/platform/windows/audio.cpp @@ -156,7 +156,7 @@ namespace platf::audio { wave_format.Format.wBitsPerSample = 16; wave_format.Format.nBlockAlign = wave_format.Format.nChannels * wave_format.Format.wBitsPerSample / 8; wave_format.Format.nAvgBytesPerSec = wave_format.Format.nSamplesPerSec * wave_format.Format.nBlockAlign; - wave_format.Format.cbSize = sizeof(wave_format); + wave_format.Format.cbSize = sizeof(WAVEFORMATEXTENSIBLE) - sizeof(WAVEFORMATEX); wave_format.Samples.wValidBitsPerSample = 16; wave_format.dwChannelMask = format.channel_mask; From df72135ea16f3d26f46cacdc3997b57cc65a4f53 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 30 Oct 2023 22:29:04 -0400 Subject: [PATCH 012/197] build(deps): bump third-party/tray from `2664388` to `e08bdbe` (#1802) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- third-party/tray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/tray b/third-party/tray index 2664388b0ed..e08bdbe5aa7 160000 --- a/third-party/tray +++ b/third-party/tray @@ -1 +1 @@ -Subproject commit 2664388b0ed88234674a37f8cd569747522247b4 +Subproject commit e08bdbe5aa7de0ad9c0ce36257016e07c7e6e2c0 From ca41c9d6f471386232e8e94a8f28bef2f09b154c Mon Sep 17 00:00:00 2001 From: Timo Gurr Date: Sun, 5 Nov 2023 01:48:52 +0100 Subject: [PATCH 013/197] config: add 2K resolution (WQHD - 16:9) (#1816) --- src/config.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/config.cpp b/src/config.cpp index d5932d62cfe..c08f5a9c4eb 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -395,6 +395,7 @@ namespace config { "1280x720"s, "1920x1080"s, "2560x1080"s, + "2560x1440"s, "3440x1440"s, "1920x1200"s, "3840x2160"s, From 0a563947eada3bbfa84c0bc1dc502689174b576d Mon Sep 17 00:00:00 2001 From: Justin Dhillon Date: Sat, 4 Nov 2023 21:47:22 -0700 Subject: [PATCH 014/197] docs: fix broken links (#1813) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> --- .github/workflows/CI.yml | 2 +- cmake/packaging/windows.cmake | 2 +- docs/source/about/third_party_packages.rst | 7 ------- packaging/linux/Arch/PKGBUILD | 2 +- src/platform/windows/PolicyConfig.h | 2 +- 5 files changed, 4 insertions(+), 11 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 254a1940dd5..b802e2346a9 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -325,7 +325,7 @@ jobs: # install newer tar from focal... appimagelint fails on 18.04 without this echo "original tar version" tar --version - wget -O tar.deb http://security.ubuntu.com/ubuntu/pool/main/t/tar/tar_1.30+dfsg-7ubuntu0.20.04.2_amd64.deb + wget -O tar.deb http://security.ubuntu.com/ubuntu/pool/main/t/tar/tar_1.30+dfsg-7ubuntu0.20.04.3_amd64.deb sudo apt-get -y install -f ./tar.deb echo "new tar version" tar --version diff --git a/cmake/packaging/windows.cmake b/cmake/packaging/windows.cmake index 0d4f1dd9cce..3231d761f8c 100644 --- a/cmake/packaging/windows.cmake +++ b/cmake/packaging/windows.cmake @@ -103,7 +103,7 @@ set(CPACK_NSIS_DELETE_ICONS_EXTRA # Checking for previous installed versions set(CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL "ON") -set(CPACK_NSIS_HELP_LINK "https://sunshinestream.readthedocs.io/about/installation.html") +set(CPACK_NSIS_HELP_LINK "https://sunshinestream.readthedocs.io/en/latest/about/installation.html") set(CPACK_NSIS_URL_INFO_ABOUT "${CMAKE_PROJECT_HOMEPAGE_URL}") set(CPACK_NSIS_CONTACT "${CMAKE_PROJECT_HOMEPAGE_URL}/support") diff --git a/docs/source/about/third_party_packages.rst b/docs/source/about/third_party_packages.rst index 69204dc266e..d45188c4a0d 100644 --- a/docs/source/about/third_party_packages.rst +++ b/docs/source/about/third_party_packages.rst @@ -3,13 +3,6 @@ Third Party Packages .. Danger:: These packages are not maintained by LizardByte. Use at your own risk. -AOSC ----- - -.. image:: https://img.shields.io/badge/dynamic/xml.svg?color=orange&label=AOSC&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27aosc%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQEAAAEBCAMAAABPMuDPAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAMAUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMAAAP/AAABwwP/////LAMkAAI0AAIhnAP/CAP/JAP/IAMcAAMsAAAEAAMwAAAB3zMoAAAAIDsEAAMIAAP/MAABptP/GAMQAAAByxP/KAABxwsgAAABzxsYAAMMAAAB1yf/EAAgGAQwAAAgAAAUBAAB2ywB0x/m9AAECBCQAAC0AAFoAAB4WAL8AAKYAAKEAACoAAB8AABQPAJsAAAAKEvW6AK0AAGAAAPK4AGYAAFAAAIEAAMqaAI1rAJYAAL0AACkeAOCqAP/NADQnAOuzALYAAAAmQi4jAEAwALyOAEEAALaKADgAAFUAAHZZABsAAF1HAEgAALMAABoTABYAAOWvAABnsQBiqSMaAAAwU7GGAG9UAHcAAJRwANqlAJAAANKeAA8AAIgAAA4LAAAhOUg2AMaWAHxeADAAALAAAIoAAKkAAJ4AAFlEAGRLAAAZK6mAAAAGChMAAABSjc8AAABPhwBlrnIAALsAAGtQAD0AAABWlKF5AGoAADQAAPrBAEwAAAAOGJMAAAAWJQASIPj4+G4AAJx2AFE9AABeogAdM8KTAFVAAABsuQwMDBMTEycnJ6ampkw6AABFdqV9AAA8ZnwAAABJfoRjAABAbzkrALq6unV1deXl5a6urr+/v4QAAAAsTABbnABuvNakADAwMHx8fJKSkh4eHjw8PIYAANCdAAA1W52dnUpKSsjIyNnZ2f39/UJCQtHR0f3AAAA4YYqKivHx8WJiYmVlZf/YAFBQUGFhYdUAANQAAFGemg8AAABAdFJOUwAWxv0T8QHmCfeYDc4GMNWB2t0Er47MU7RxHWwlyS6mqz/uooZOYyG5Gjnr4mi+nH7DXlmLRLt4SCmTM0sD9HS9ZbqkAAAXLElEQVR42uWdeVxTV77ALyI7IijIJrigAooIUq17T4KJsiQhJjEhBJIoIJuCigp1QbHgrrWudaVO3Wu11VGpe1tbq9V2bKfW7naZLtqZdqbtrO/Ni5IAQnLPcs9NLr7fX/1UcnLPN/f8tvM7v8MwThZPv9jRI4aGB46KCY5L7NQkw+N6DwlJikwZFh3hzTzC4jdyTPioMH+vcXLgSOQeCVHBIYOHxT5yIDoPHOyb7OUOUMWn2/CQoQF+j8bkPWNDQ5IHAQJx94oLHBHfwafv1n+Uvw/gIh7JgX066rvgOTI8ri+gIV69h0Z0vOmPDvR3B/RkXGJkbEea/8gkqtO3asfEwR1EKXQekOgD+BGP3mOEbyZH+w4CfEq3QEGvBu+UZHfAt/j07uMpVNP3RDfgHIlKEeJiiOg3CDhPgiKF5iREPOYBnCsJ4UJiEO/0+T9gECmUteCX1Be4RoKGdhfA/LsPSACukx7DXA6gTxRwrQT3dK0CjJEDV8u4QNepg7GRfYEQJGiMiwAEJAOhSIwrYqYuST5AOOKV4nQA0VFAWNLLzbkAwscBoUmCM7VBfBgQooR0cRaAEV5AmBI10jkpwCSqPoDcItQG6+sMhdiZxgooOF6y5lLZ+Z13G2oqK8p3UgT6GO+RQkAQx7lvurD29ITyelWmUiFTKqWGzLzfN9B8p+J4tgmhXMLgqaVrF1Q05slk0jyjSiWyiXQCXQ8xgE8Aj5P/9jPLDh/SKZR5RlFboUwAePTnLxD2Jf3xz5wuNyqkOpXIntAmANwj+cqEkOnA/DO3DhlkefZnzwsBiz7kxw3qRGLrSk/Pk8p0IjbhgQCI4cEk9OyK/xx75lfqFOzT54kACKaeNIjG3wuY9eYGhUElErmEABhOOZUcgO0Iz1ywGP7z80gAdOrsUgClh3UytUjkSgIgys11AGYe1ilVIpGLCVBEEI0HYNYCI8b8eSQAkinpgp5YSnDP+UaFWiQSBAEwnIpFiMcxg/Jn5imMIhEBgY/XHV1/fd/HS6Y/TzP4DqbgF/jhJARnTVDmiUREBBb9W5+eoTX/Wr353updO95bMoUOgiHcU8IYrnBB2WKlSERIYKJE/EDMZm26RJJRVLty4lvPFnBH0I8rgSHo31VSg70A7BCwSpo5XZJe9Nyu6xu5IuAYJiWhf9NaohfAEYEmDFpJevXKHc9yixQ5BcspyN9z/C6iB4hD4AGFdE3R2zumc0keRpMDGIi8K3Bhnkwl4oVAE4S5298jV41diT2jeOScYJkxUyTijcB9CPqM3euIVUIwYfHZWFQzkH9LZhTxS8AiWk31riXONQj9EIffVKlQifgnYDGUmqJzhAxCidLCqGHQPKVI5BQClsVgYUBkGQYRVJrEIoZDZxoNIqcRuM9g7sTZBAgSsd1jzzi0kS8ZdSJnErAwWLr5qNwJqgBxZ2BtJmcAuAQs+kDy9lP4OdsRmJ4AWoFIldQocj4BsVh/8Ta2exCElTXz7oEGQKYWuYSAZSnc+5jXMLGfEwEQERCL0y8eKODPJA5EOiVQRgcAIQHLa7ASM1rohuwdd0FKisw30AFASkAslmzeh4fAl6odWKUzilxMQKw1r8NDgFiF3BOlRuDgYp3I5QQs/tE5LJvgj5Y57Y2SENyQKRIAAbF46dtYEePjKAD6o6TEK5QiYRAQS77BCZb6IsQH3v4I/tXvFCKhEBDrN+M4iDEI1aIIwzxJEwBXAuKMuhUYCPpA80IIIeGqPLWQCIi11RgIEmEEHkPQgvV5IkERwEMQytkSFtQoRQIjYEGAHiX4s1cf+zpbCdAhINbWLUdGMIB1nxweFF/QqQVIQJxeixwkdPXmtEc2tdwgEiIBsWTh8xRegpHwV+A07TVAi4BYs72A+0swygVrgBoB8dJFqC/BUIfpYaghyK+gvgboEUjLWI9IoMdY4sxQFd01oNJlKmWK/75Gh4DYXI3qHzvYTu4MPUA8q5FaSCxSZ8pk6kOVd86XPVNKiYA4/R6iNgyzT2Aw9IMLZJSmb5TKFh/ZeWnmnpbEPw0C4qVXEGsKBtrdI+kBV4MqKu++QdZ4eP6sNrseVAiIM17kkC8bBo2Ja6Q0fn6Zrmbtpvaj0yGg3YzmGA2yd0y3F+xTz1CIB4yKxluldve86BAQa15CewnCCUxhQQXnxJha0Xj6aQfDUyIgTkdbBz3aF1U8Ac2Oc1aDSvXOpx0OT4uAthZta7l9pgS2R5BfzjEroJO9NpNl/IlL6RBAdQ3b6cKB0G1yjlpAWT+fdc/7drr5fiWlmTOBtItIfpFX243UEJghOJLJTQM02F0AxXMuH7u2t9jyX7OXr7i+7sr+OrMmPY0bAv1qklyRN6xsbBWXgGBGnq6q3Qvw8rFt75/dOjk123RjUsv/nb3iwMpqCTcIGW+hEOiN6Qw0cPEFpBvWtBnu1W0nT2VnFZpys3NysidPevgfpx9deVHDYTlkLESJk/vGY8XFM9Uc3EFZxayHf/1lJ74uLMxOtUo7AhZZvqiOAwM9UpA4FGsR7OQQFCoa9rQeas5vpwpNOaktYo+AZTncrtOQrgXtc1Nwl0EfWNXwBvKgUHE4v/X8P7iRlZv6kNgnYGGwqEjP50vwkDXox583pLjbalEWb9uSlZ2aikbAshZWSsw8aoL+GO5QDbElUExo9Qa8/lXb35+dAJC/Up1Otg7ew3OKekIypCUq0uygrHJqyzA/pppSU7EIALBkoYY3n6Bry97JAL42SQwvtMTBc060XwBwAmDKOQmBQkz7FcExdA9ADYzlpFGhrrElEnh9a1ZqKgEBAA5oCZSBZhfCS9B8AMcbcqBwppHMGVBJn2keY+8NUyohAXD0Ij4C82aEEDG4+VCtnJ9FoGhpMrMsJzeVmAB4kQABikFM8ENMkVaSLQJDxVQUAAgEwHpzGi+6cLSVQAwkR76YyBKojRealwAbABQCYAd2rJQ2F+EgwmBrg5WuvLhDijebleANNgBIBMAibKMoeQW5qigW4g3cIcqN5M2zRQNztppSORMoWI2bRUtfieARjEUpn5s6jygmkF2yDXAyK5U7AbCxVou5DKrhiXOfpjbwgex/VUq0T2KotBmYHyEAEAmA93C1IYo1aDp2EQwpISexhSrDGZsS+DobQiAXjQDYhakKJH9ErDGFKUIiNWCotH38bCH79AsLc7eiEZiNuQ7MtfAsQa8HPYfZj9bmv0CiBpq9wW1sAHJMplMffnlsDuKe93rMdEEaPDbwR8iOEHkDeeXWmHjSKRZDWJhzYtnLGOWg8rfxQmXJDvj+oRs8MFxFkiJVlFk//YFjNZhrOnEM73QAeA9vGegR9hCj4VWkJEGBsdG6OTBnskM1WDh5GcAWvJdAuxuuCELhxwlIFKHyd9YP/+bwFcg6+yo+AHA9A0sPFMEd43BohkxeQbBdqLTqwZe3OtIChR8WEwAAU77BWgcIWye+DOOdAMkS4x8nMtZbM0PLHBmCrPcBmRzA8gk0B1AqimLZjWEJwVZJc4ulkw4IZJ1s9Q3v/O3bm5988cmfP/0BIcm/pCiNrir092RGs//FGYIsscxqCV69YV8Pmq622MDv//7ZeJv8/O270CdeiaMLtffgmwZ+zBj2v1iLbwpURmt28Ev7r0B2arMVLP70H+Nby2f/hCYKJFipMmh1nUcEzB14Ez85oJtnzQ19aJ9A1ge2wd/9ZHxbufkO+/Ms/zUNxxgsQXAIIMcrFyiJ1YADS9ASBnz/y/j28gk7ggIsa6CFnz3pA3OICHbNZeebPnosJ8euIdxmU4E/jbcnn7PbyXM4yyB9PYJLNIR66YjNG7CvBrK32AKhP4+3L9/SUwQa+KncwZDsAEFkqNKVNn32I7sECm2uwF8cABj/xp/YnmgFTuJcAq+qeoIZzvrve/C3zdW2oOCE3fTgtL3Wt+snRwTGf872RM/OxVCF+nNQAoEMex/mTfVGUlNQfDXX7iKw6sG/OQQw/o0/sDnGtRgvgX47lEAIw37I9ulG7OxAXkVThnDSFnv+kOkERAtANcFCLdV8sS/DniMrmYFNwFBj9Qi/tmcKCj+y/pQ/sxD4gu2RVmN4hRn7EfJkEAIibALSw9YUaWoOiy38/g0WAp+x+QR/lOC4xXI4gQTaqXLlAjZ3oNCaF/mBBQC7IrjiZAJ5xASuZdsjYNoLsYX35a9s9nARXQJh/+8JxPGwCu50qFUAewdINKE1MLrcUTQhf9bwBps1LP6FhcAnArKGszh4RKfsekRnrSN/x0LgUyd6RL0gPiEHrxhcncYWGv4gEK/YFxIXcImMTrJGRuALhwRuOjMyCoHEhkTR8UG2HbPm6NhhaPQPtlcA7NPSjY4DIfkBkgyJrXrE/m5B9uQ5EE3wqVMzJE/A2k404GfLZdYSqstf28+S/Whb0V/grwGLMdTTzZINhuUJCTKlhtcAS4IgNfeU7SV41x6Cz9n3TabsxlkFZnimNBSWKybJlh+yVpG97yBb/lHzdtHNdgC+mwLLlovpZsv7wPYLSHZMbKpwmf0qupyca83D//Ozh+b/839gD7yO8o4JiIbtGZHsmimqAEuWyGIQt7bUzbz76S9/tcVDP/3rHXgFAc7+uXYhdDyPCNi+IcnOqU0RONo0Si080WpPoPhP//ru5uc3//4/f0DYUKe+c+rlB9s7Pl5PsHtu84muOSofyCIrH+Bh99zfE1Y/QFRBIZtv/fRX0xwhOPkyCQA8SyDOgJ82CoOfsrpLUEUjbQCsu8f3EXx1mYDAi1h1RChVNL7wOiKSSir1jBJYGU2q6cY2fAL7seqItLvhZ+7C4bVkZNV0T8ILKrMLz+7FBPAW/Wq6UHg9IVFFZXOEXHyVpbLeNO3sl3MwABQsxHoFUCoqH9QTQmpKyapqm3Xh3mk5bFW1hZNP/ngNta7uKO4hXHhV7YOaUkhdMZEqFGVW2Jbgh+zF9dmmLNMWtMrqjZvxzluZEQoq/VFqy4mq65uLCMCrW3LpnC8AV3Cr6+Hpkabactj5goNEJywybbXVYBnbOsAgcB3zjIlYj9CX53GUMyaEp2yai6vBR1RO2Ty7mYdTNtYzJrA23USKQKSrt7VeKT6RxZ3AlJXYJ60QDhxazxnBzpqtJTttJ7tlG2DO1kLOBHbxctrOetYMpgoJdk0epAkyV9lGuLzFxJHAOuyOVUiLIAbtzKmc8NRt3rzjtiFeZ0OAQOAVLf6p2+0IyiUS8dwx6clr2Z3mIV4/VciBAAEAtA5toxHPnpeSdmaUNdsDcPlqFjEBEgDmWoSGnc1nz2H9BwoqCJuyGdUtnZgmncjKISNwm6RDlQalP1swcnNG4i4cefUlLdmwD3KnERB4/iWStkRpRcsx1AC8Dwl5JxZpeauGnHtP2X0NWAk89RxZJxYUPdiqDwmsFw15N54ZsspWDakmvZ9rwiJQsK4ogwSAWIty01GrXjTQfkRryTsyyWpa9+S6drZwGjqBp/ZLyBpzZexHuf/PF6Mn1fF6HQcEx1sPtewrkykHicD0KxfJ2jGhNivtj9OhcieHJqWyioeaMxbvPZGTlZsDIzB9UTVxZza0plwP9SWD9qYr5dKsWXmo9OHRXv/ganaWKdsxAflTV6o5dOdDewV64fXt59ShMXPGpTbDFR/77ezk3MJC07Tc7Lb9B+RL1i38VcOhS2U6khZo08Mf2qNyFad+1Trpzvx2Q066tu2jk19t3fL1qRYC8o37Ji4s0mSIuQiSIWjboxK6DDj2a1YpKhy06n150pwHmdLZH+87evule9VaSQbHTq0SFF+gXZ9SaK9azg2bDeon89nGn7hUK5HotRxnj+wOtr/XCGoN8ss5Nu02KsrPsBHQiOnI0olIANr1K4Y6RRS6dmdKJzjuWk2ta/dutFscfPH7lnN+CSzaQKm7U8o3AaRmxfb6lsOvcaHRvV+t1DWsyueRgOYcGoAoT4L7C+SVNC6yUUmlL5yfKeeJgLYW8crLcJI7LMCaTCq3eIh0CvWRJy9M5YFAGuoasHuHBfweE3CX1k0uqkxF3qHDVWdm5dMlsHQXGgAH9/7C77KZ1Ujrht/7NXdShWHxvJoFb1adoUVAvxDx5lv7d9kg3GdE/WY/tc6glP1vDSUC5jrUS1/DiO+0EvatXtrrqLUY/YnvNQNrBHyzm+Y2KgCH95oh3G0n4Nv9lr6ECsDx3XYo9xtOLc8UJgHJ28g3PLJdcgm/45KHdUCFgP4b9Nu/B3C75xScF+JNrxmb0e/+Zr3nFOWu24JK4d32m1GHcfP3AK73HYNZ9TqBEcACALnvGOXOa/CMQVi3fmfUod/3DL3zGunec8qqgCuBdJw3AH7vOROOMIr8sEI4BPS1yzEA2MmMtBVvf4Rh9pRLhUJAc286DoAYBi79UQYqqc8UBoGlq2fjAOjbE4EA7MBBk1wQ6QRAwCzZVYADwFpDChMUi2gxCHlGlxPQXnwFa/7A3xuJAOwQpq2mQKp2MQFN7Qo8AGAYGgCmSxTScFVKtSsJmCXbZ2MC8GVQZaA70oBPKlSuI5BetANz/qCbGzIBhGyR1TNSu4hAmmbhclwAUG/wIacAbR1YFoLRJQQkc9cVYAMYwuDIQB+0UcsMRucT0KavXoI9fxDUGYsAoj0AYL5O52QCZk3tdfz5A/kIPACMZxziyKsWZzqTQJqm+sDzBABAPwZXYr0Qhz64Qek0Ammaubs2kswfJHbHJsCEog7+9BGFcwiYNdW7niWaPxjUkyGQfqjDT13AySoiEtBq6iZOB4QSSgKAGRuGrGWqdHn8EjBLtPdemU06fwIlYM0XBSF/xZpDMv4IpOkldedWFBDPHwR7EhJgBo5D/pJNExRGXgiY9fq5q4+S//z30+NuDLGkYNjbMpGUNoG0DI22bvvR6YCT9I1mOEgSxjfNPEL2GtglkKbVa7TV+yfumw04int/hpMMwfiugqoZSo4E0tLM2gy9Rm+eu3v7gX0bAQWJ5AaA6RKG820lr8l0hAQW/VuSrjX/WlS3e/9LE4+umF4A6Eg/hqv4ReF8n/zSIWzfoInA8vUvvrVvxfLps6cAmjKE4S7xXbG+cs+bM2QqAgL8SHB3CgSYnt3wvrXkjk6pEgaB4d4MFYn2wvzigxMyMRjwRyDZj6EkAbgIwJoGHXIelTcCUW4M4zoE4OBdlULnUgI0ARAhACWn6xUodbg8EejUmaEq0d0IHuL42iN5cAeBHwLD/RjK0rMryXPID+48pFTqnE8g2JuhLvGdyJ5l6qoFG5QylvOKfBCI6c7wIH5hpM+zZ9WtF3QKqQMKPBDox/Aj3X3Jnym/tKphQ55CaacakToB90iGN3mc05PtOVh2p7zRIJMZdEYVfwQ8+jM8SqgHx8creHpN2c6aFxrVBoVMJpMaMjN1v2+gCiAogOFVAoJoPGX+ppln5ledXnD4tcoj5Rtu0QQQ58bwLJ3DqP5icnlBfgHF8R7rzvAunklyIFTpm8I4RUZ4CRRA1EjGSRIfJkgAIV0Y50n4OMHNP2EM41SJjhIYgF5ujJOlS5KPgObvlcK4QAKSBQMgJp5xiYyN7CuI+QeNYVwmETGu9w3GBXozrpQ+rtaIwT0ZF0v3AQkunH+PYYwAxC/JVeogaGh3RhgS/5iHC+afEOnNCEcinM4gIdyPEZZE9BvkzPc/Umjzvy9uT3Rz0vyjUrwZYYp3SrI779P36d3HkxGwjPbldzF0C4xlhC6dByTyFTN59B7jzXQIGfm4P/3V4JM4OJ7pOOI5OpAqhHGJkbFMRxPPkeFxdJxFr95DI5gOKm79R/lzUwoeyYF9/JgOLZ6xoSHJRPbB3SsucEQ882hI54GDfZO90BWDT7fhIUMD/JhHTPxGjgkfFebvNc5xVkXukRAVHDJ4WKw38+iKp1/s6BFDwwNHxQTHJXZqkuFxvYeEJEWmDIuOcP7U/w+C7XCu0wHHigAAAABJRU5ErkJggg== - :alt: AOSC Version - :target: https://packages.aosc.io/packages/sunshine - AUR --- diff --git a/packaging/linux/Arch/PKGBUILD b/packaging/linux/Arch/PKGBUILD index 11b699823b0..cfd760653df 100644 --- a/packaging/linux/Arch/PKGBUILD +++ b/packaging/linux/Arch/PKGBUILD @@ -1,4 +1,4 @@ -# Edit on github: https://github.com/LizardByte/Sunshine/tree/nightly/packaging/linux/aur/PKGBUILD +# Edit on github: https://github.com/LizardByte/Sunshine/blob/nightly/packaging/linux/Arch/PKGBUILD # Reference: https://wiki.archlinux.org/title/PKGBUILD pkgname='sunshine' diff --git a/src/platform/windows/PolicyConfig.h b/src/platform/windows/PolicyConfig.h index 21772227c19..087f85fa84f 100644 --- a/src/platform/windows/PolicyConfig.h +++ b/src/platform/windows/PolicyConfig.h @@ -3,7 +3,7 @@ * @brief Undocumented COM-interface IPolicyConfig. * @details Use for setting default audio render endpoint. * @author EreTIk - * @see http://eretik.omegahg.com/ + * @see https://kitere.github.io/ */ #pragma once From 29a1b1539fb2e0e82d02e521954b163c6d9d55d1 Mon Sep 17 00:00:00 2001 From: ns6089 <61738816+ns6089@users.noreply.github.com> Date: Fri, 17 Nov 2023 16:43:12 +0300 Subject: [PATCH 015/197] Fix incorrect portrait mode rotation center on Windows (#1851) --- .../windows/assets/shaders/directx/include/base_vs.hlsl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src_assets/windows/assets/shaders/directx/include/base_vs.hlsl b/src_assets/windows/assets/shaders/directx/include/base_vs.hlsl index 5fc9226bd4f..c04fad39018 100644 --- a/src_assets/windows/assets/shaders/directx/include/base_vs.hlsl +++ b/src_assets/windows/assets/shaders/directx/include/base_vs.hlsl @@ -2,7 +2,7 @@ #if defined(LEFT_SUBSAMPLING) vertex_t generate_fullscreen_triangle_vertex(uint vertex_id, float subsample_offset, int rotate_texture_steps) -#elif defined (TOPLEFT_SUBSAMPLING) +#elif defined(TOPLEFT_SUBSAMPLING) vertex_t generate_fullscreen_triangle_vertex(uint vertex_id, float2 subsample_offset, int rotate_texture_steps) #else vertex_t generate_fullscreen_triangle_vertex(uint vertex_id, int rotate_texture_steps) @@ -29,7 +29,7 @@ vertex_t generate_fullscreen_triangle_vertex(uint vertex_id, int rotate_texture_ float2x2 rotation_matrix = { cos(rotation_radians), -sin(rotation_radians), sin(rotation_radians), cos(rotation_radians) }; float2 rotation_center = { 0.5, 0.5 }; - tex_coord = round(tex_coord + mul(rotation_matrix, tex_coord - rotation_center)); + tex_coord = round(rotation_center + mul(rotation_matrix, tex_coord - rotation_center)); } #if defined(LEFT_SUBSAMPLING) From 336062d467d5f48ba56d05a523c212f791421108 Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Thu, 23 Nov 2023 23:28:07 -0500 Subject: [PATCH 016/197] ci: update global workflows (#1863) --- .github/workflows/automerge.yml | 2 +- .github/workflows/codeql.yml | 4 ++-- .github/workflows/issues.yml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml index 49ddebf4ec1..733b4de8521 100644 --- a/.github/workflows/automerge.yml +++ b/.github/workflows/automerge.yml @@ -31,7 +31,7 @@ jobs: github-token: "${{ secrets.GITHUB_TOKEN }}" - name: Label autoapproved - uses: actions/github-script@v6 + uses: actions/github-script@v7 with: github-token: ${{ secrets.GH_BOT_TOKEN }} script: | diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 95349bbc477..358ff9c99f6 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -28,7 +28,7 @@ jobs: continue: ${{ steps.continue.outputs.result }} steps: - name: Get repo languages - uses: actions/github-script@v6 + uses: actions/github-script@v7 id: lang with: script: | @@ -70,7 +70,7 @@ jobs: return matrix - name: Continue - uses: actions/github-script@v6 + uses: actions/github-script@v7 id: continue with: script: | diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml index d7a1025cdce..aec6006c870 100644 --- a/.github/workflows/issues.yml +++ b/.github/workflows/issues.yml @@ -20,6 +20,6 @@ jobs: runs-on: ubuntu-latest steps: - name: Label Actions - uses: dessant/label-actions@v3 + uses: dessant/label-actions@v4 with: github-token: ${{ secrets.GH_BOT_TOKEN }} From 3b9e37e1ddc54eb5a6a320f5271e5e438ddab06f Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Thu, 30 Nov 2023 23:51:45 -0600 Subject: [PATCH 017/197] Don't hardcode the signature length to RSA-2048 (#1872) --- docs/source/about/advanced_usage.rst | 8 ++++++-- src/config.h | 4 ++-- src/crypto.cpp | 9 +++++---- src/crypto.h | 1 - src/nvhttp.cpp | 10 +++++++--- src_assets/common/assets/web/config.html | 10 ++++++---- 6 files changed, 26 insertions(+), 16 deletions(-) diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index c9d9ebae3b4..0b4a687b6fe 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -605,7 +605,9 @@ pkey ^^^^ **Description** - The private key. This must be 2048 bits. + The private key used for the web UI and Moonlight client pairing. For best compatibility, this should be an RSA-2048 private key. + + .. Warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. **Default** ``credentials/cakey.pem`` @@ -619,7 +621,9 @@ cert ^^^^ **Description** - The certificate. Must be signed with a 2048 bit key. + The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have an RSA-2048 public key. + + .. Warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. **Default** ``credentials/cacert.pem`` diff --git a/src/config.h b/src/config.h index 749a8556d11..6e481a1f641 100644 --- a/src/config.h +++ b/src/config.h @@ -92,8 +92,8 @@ namespace config { // pc|lan|wan std::string origin_web_ui_allowed; - std::string pkey; // must be 2048 bits - std::string cert; // must be signed with a key of 2048 bits + std::string pkey; + std::string cert; std::string sunshine_name; diff --git a/src/crypto.cpp b/src/crypto.cpp index 5dec0f8dd57..26af3e7df47 100644 --- a/src/crypto.cpp +++ b/src/crypto.cpp @@ -409,11 +409,12 @@ namespace crypto { return {}; } - std::size_t slen = digest_size; - - std::vector digest; - digest.resize(slen); + std::size_t slen; + if (EVP_DigestSignFinal(ctx.get(), nullptr, &slen) != 1) { + return {}; + } + std::vector digest(slen); if (EVP_DigestSignFinal(ctx.get(), digest.data(), &slen) != 1) { return {}; } diff --git a/src/crypto.h b/src/crypto.h index d8d0a35a607..b75d013ca1c 100644 --- a/src/crypto.h +++ b/src/crypto.h @@ -17,7 +17,6 @@ namespace crypto { std::string x509; std::string pkey; }; - constexpr std::size_t digest_size = 256; void md_ctx_destroy(EVP_MD_CTX *); diff --git a/src/nvhttp.cpp b/src/nvhttp.cpp index 5bde7b079bc..fa7847c3fde 100644 --- a/src/nvhttp.cpp +++ b/src/nvhttp.cpp @@ -380,11 +380,15 @@ namespace nvhttp { auto &client = sess.client; auto pairingsecret = util::from_hex_vec(get_arg(args, "clientpairingsecret"), true); + if (pairingsecret.size() <= 16) { + tree.put("root.paired", 0); + tree.put("root..status_code", 400); + tree.put("root..status_message", "Clientpairingsecret too short"); + return; + } std::string_view secret { pairingsecret.data(), 16 }; - std::string_view sign { pairingsecret.data() + secret.size(), crypto::digest_size }; - - assert((secret.size() + sign.size()) == pairingsecret.size()); + std::string_view sign { pairingsecret.data() + secret.size(), pairingsecret.size() - secret.size() }; auto x509 = crypto::x509(client.cert); auto x509_sign = crypto::signature(x509); diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 6e2b61b760c..927ef945564 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -316,11 +316,13 @@

placeholder="/dir/pkey.pem" v-model="config.pkey" /> -
The private key must be 2048 bits
+
+ The private key used for the web UI and Moonlight client pairing. For best compatibility, this should be an RSA-2048 private key. +

- +
- + v-model="config.cert" />
- The certificate must be signed with a 2048 bit key + The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have an RSA-2048 public key.
From bd03ef974cb06faf13151976bdf5c19f599afe7b Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 3 Dec 2023 17:20:47 -0500 Subject: [PATCH 018/197] docs(windows): add drive permissions troubleshooting (#1883) --- docs/source/troubleshooting/windows.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/source/troubleshooting/windows.rst b/docs/source/troubleshooting/windows.rst index 9190fc300f7..313bef9a3ee 100644 --- a/docs/source/troubleshooting/windows.rst +++ b/docs/source/troubleshooting/windows.rst @@ -4,3 +4,11 @@ Windows No gamepad detected ------------------- #. Verify that you've installed `Nefarius Virtual Gamepad `__. + +Permission denied +----------------- +Since Sunshine runs as a service on Windows, it may not have the same level of access that your regular user account +has. You may get permission denied errors when attempting to launch a game or application from a non system drive. + +You will need to modify the security permissions on your disk. Ensure that user/principal SYSTEM has full +permissions on the disk. From 6dcc5e7c0fba408823ade3a3e6e460f448b9f0ee Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Mon, 4 Dec 2023 18:12:14 -0500 Subject: [PATCH 019/197] ci: update release notifier (#1891) --- .github/workflows/release-notifier.yml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release-notifier.yml b/.github/workflows/release-notifier.yml index 2827224b8bf..5735465e4a0 100644 --- a/.github/workflows/release-notifier.yml +++ b/.github/workflows/release-notifier.yml @@ -15,8 +15,8 @@ on: jobs: discord: if: >- - startsWith(github.repository, 'LizardByte/') and - not(github.event.release.prerelease) and + startsWith(github.repository, 'LizardByte/') && + not(github.event.release.prerelease) && not(github.event.release.draft) runs-on: ubuntu-latest steps: @@ -34,8 +34,8 @@ jobs: facebook_group: if: >- - startsWith(github.repository, 'LizardByte/') and - not(github.event.release.prerelease) and + startsWith(github.repository, 'LizardByte/') && + not(github.event.release.prerelease) && not(github.event.release.draft) runs-on: ubuntu-latest steps: @@ -51,8 +51,8 @@ jobs: facebook_page: if: >- - startsWith(github.repository, 'LizardByte/') and - not(github.event.release.prerelease) and + startsWith(github.repository, 'LizardByte/') && + not(github.event.release.prerelease) && not(github.event.release.draft) runs-on: ubuntu-latest steps: @@ -68,8 +68,8 @@ jobs: reddit: if: >- - startsWith(github.repository, 'LizardByte/') and - not(github.event.release.prerelease) and + startsWith(github.repository, 'LizardByte/') && + not(github.event.release.prerelease) && not(github.event.release.draft) runs-on: ubuntu-latest steps: @@ -88,8 +88,8 @@ jobs: twitter: if: >- - startsWith(github.repository, 'LizardByte/') and - not(github.event.release.prerelease) and + startsWith(github.repository, 'LizardByte/') && + not(github.event.release.prerelease) && not(github.event.release.draft) runs-on: ubuntu-latest steps: From 4a2f7023ec687c3ecf928632cc58aa30ade3268a Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 3 Dec 2023 21:45:10 -0600 Subject: [PATCH 020/197] Fix discovery of Windows hosts by Apple devices --- src/platform/windows/publish.cpp | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/platform/windows/publish.cpp b/src/platform/windows/publish.cpp index 187868b6fa7..30aa30e24cb 100644 --- a/src/platform/windows/publish.cpp +++ b/src/platform/windows/publish.cpp @@ -119,6 +119,21 @@ namespace platf::publish { instance.wPort = map_port(nvhttp::PORT_HTTP); instance.pszHostName = host.data(); + // Setting these values ensures Windows mDNS answers comply with RFC 1035. + // If these are unset, Windows will send a TXT record that has zero strings, + // which is illegal. Setting them to a single empty value causes Windows to + // send a single empty string for the TXT record, which is the correct thing + // to do when advertising a service without any TXT strings. + // + // Most clients aren't strictly checking TXT record compliance with RFC 1035, + // but Apple's mDNS resolver does and rejects the entire answer if an invalid + // TXT record is present. + PWCHAR keys[] = { nullptr }; + PWCHAR values[] = { nullptr }; + instance.dwPropertyCount = 1; + instance.keys = keys; + instance.values = values; + DNS_SERVICE_REGISTER_REQUEST req {}; req.Version = DNS_QUERY_REQUEST_VERSION1; req.pQueryContext = alarm.get(); From 47b5fc1fc0266bbc8185649bc12ea822f8efcdfc Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Thu, 7 Dec 2023 11:48:02 -0500 Subject: [PATCH 021/197] ci: update global python (#1896) --- .github/workflows/cpp-lint.yml | 2 +- .github/workflows/python-flake8.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/cpp-lint.yml b/.github/workflows/cpp-lint.yml index 86a2b8d686b..b5d4ff7765e 100644 --- a/.github/workflows/cpp-lint.yml +++ b/.github/workflows/cpp-lint.yml @@ -79,7 +79,7 @@ jobs: uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: '3.11' diff --git a/.github/workflows/python-flake8.yml b/.github/workflows/python-flake8.yml index 4b0d30810da..e08ab10fcac 100644 --- a/.github/workflows/python-flake8.yml +++ b/.github/workflows/python-flake8.yml @@ -24,7 +24,7 @@ jobs: uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 # https://github.com/actions/setup-python + uses: actions/setup-python@v5 # https://github.com/actions/setup-python with: python-version: '3.10' From a009d1314f76f983213efb5b4b60f23ead27e6de Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 8 Dec 2023 09:07:08 -0500 Subject: [PATCH 022/197] build(deps): bump actions/setup-python from 4 to 5 (#1893) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/localize.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/localize.yml b/.github/workflows/localize.yml index eb7e77974a2..f9cd64859bb 100644 --- a/.github/workflows/localize.yml +++ b/.github/workflows/localize.yml @@ -23,7 +23,7 @@ jobs: uses: actions/checkout@v4 - name: Install Python 3.9 - uses: actions/setup-python@v4 # https://github.com/actions/setup-python + uses: actions/setup-python@v5 # https://github.com/actions/setup-python with: python-version: '3.9' From a851ef606879ee2dc3fdb74fce6fe49ecbd88926 Mon Sep 17 00:00:00 2001 From: zoeyjodon <76182954+zoeyjodon@users.noreply.github.com> Date: Sat, 9 Dec 2023 09:31:04 -0500 Subject: [PATCH 023/197] Extend session timeout (#1890) --- src/rtsp.cpp | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/src/rtsp.cpp b/src/rtsp.cpp index 5a12253de17..9aa3ea1c220 100644 --- a/src/rtsp.cpp +++ b/src/rtsp.cpp @@ -307,6 +307,19 @@ namespace rtsp_stream { _map_cmd_cb.emplace(type, std::move(cb)); } + /** + * @brief Launch a new streaming session. + * @note If the client does not begin streaming within the ping_timeout, + * the session will be discarded. + * @param launch_session Streaming session information. + * + * EXAMPLES: + * ```cpp + * launch_session_t launch_session; + * rtsp_server_t server {}; + * server.session_raise(launch_session); + * ``` + */ void session_raise(rtsp_stream::launch_session_t launch_session) { auto now = std::chrono::steady_clock::now(); @@ -315,7 +328,7 @@ namespace rtsp_stream { if (raised_timeout > now && launch_event.peek()) { return; } - raised_timeout = now + 10s; + raised_timeout = now + config::stream.ping_timeout; --_slot_count; launch_event.raise(launch_session); @@ -328,12 +341,22 @@ namespace rtsp_stream { safe::event_t launch_event; + /** + * @brief Clear launch sessions. + * @param all If true, clear all sessions. Otherwise, only clear timed out and stopped sessions. + * + * EXAMPLES: + * ```cpp + * clear(false); + * ``` + */ void clear(bool all = true) { // if a launch event timed out --> Remove it. if (raised_timeout < std::chrono::steady_clock::now()) { auto discarded = launch_event.pop(0s); if (discarded) { + BOOST_LOG(debug) << "Event timeout: "sv << discarded->unique_id; ++_slot_count; } } From a932f6bee8fd617ff6dc18ef0dfefd451d73b6e2 Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Sat, 9 Dec 2023 14:38:22 -0500 Subject: [PATCH 024/197] ci: update global workflows (#1904) --- .github/workflows/issues-stale.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/issues-stale.yml b/.github/workflows/issues-stale.yml index aecc8243f34..deb3d74b961 100644 --- a/.github/workflows/issues-stale.yml +++ b/.github/workflows/issues-stale.yml @@ -18,7 +18,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Stale - uses: actions/stale@v8 + uses: actions/stale@v9 with: close-issue-message: > This issue was closed because it has been stalled for 10 days with no activity. @@ -43,7 +43,7 @@ jobs: repo-token: ${{ secrets.GH_BOT_TOKEN }} - name: Invalid Template - uses: actions/stale@v8 + uses: actions/stale@v9 with: close-issue-message: > This issue was closed because the the template was not completed after 5 days. From 1dbfdbcf4fced78674a0ebe05e65019aac0743aa Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 9 Dec 2023 16:53:48 -0500 Subject: [PATCH 025/197] docs: fix failing images (#1903) --- docs/source/contributing/localization.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing/localization.rst b/docs/source/contributing/localization.rst index ec6a43a5daf..ef2c811c4a9 100644 --- a/docs/source/contributing/localization.rst +++ b/docs/source/contributing/localization.rst @@ -3,7 +3,7 @@ Localization Sunshine and related LizardByte projects are being localized into various languages. The default language is `en` (English). - .. image:: https://badges.awesome-crowdin.com/translation-15178612-606145.png + .. image:: https://app.lizardbyte.dev/uno/crowdin/LizardByte_graph.svg CrowdIn ------- From 09ab49a869e60347b8ac140a5b9437eb8a83c15b Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Sat, 9 Dec 2023 19:06:42 -0500 Subject: [PATCH 026/197] ci: update global workflows (#1906) --- .github/workflows/ci-qodana.yml | 292 ------------------------------- .github/workflows/dispatcher.yml | 69 -------- 2 files changed, 361 deletions(-) delete mode 100644 .github/workflows/ci-qodana.yml delete mode 100644 .github/workflows/dispatcher.yml diff --git a/.github/workflows/ci-qodana.yml b/.github/workflows/ci-qodana.yml deleted file mode 100644 index efc56349b30..00000000000 --- a/.github/workflows/ci-qodana.yml +++ /dev/null @@ -1,292 +0,0 @@ ---- -# This action is centrally managed in https://github.com//.github/ -# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in -# the above-mentioned repo. - -name: Qodana - -on: - pull_request: - branches: [master, nightly] - types: [opened, synchronize, reopened] - push: - branches: [master, nightly] - workflow_dispatch: - -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: true - -jobs: - qodana_initial_check: - name: Qodana Initial Check - permissions: - actions: write # required to use workflow dispatch on fork PRs - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Prepare - id: prepare - run: | - # check the branch variable - if [ "${{ github.event_name }}" == "push" ] - then - echo "This is a PUSH event" - # use the branch name - destination=${{ github.ref_name }} - target=${{ github.ref_name }} - else - echo "This is a PR event" - # use the PR number - destination=${{ github.event.pull_request.number }} - target=${{ github.event.pull_request.base.ref }} - fi - - echo "checkout_repo=$checkout_repo" >> $GITHUB_OUTPUT - echo "checkout_ref=$checkout_ref" >> $GITHUB_OUTPUT - echo "destination=$destination" >> $GITHUB_OUTPUT - echo "target=$target" >> $GITHUB_OUTPUT - - # prepare urls - base=https://${{ github.repository_owner }}.github.io - report_url=${base}/qodana-reports/${{ github.event.repository.name }}/${destination} - echo "report_url=$report_url" >> $GITHUB_OUTPUT - - # build matrix - files=$(find . -type f -iname "qodana*.yaml") - - echo "files: ${files}" - - # do not quote to keep this as a single line - echo files=${files} >> $GITHUB_OUTPUT - - MATRIX_COMBINATIONS="" - REPORTS_MARKDOWN="" - for FILE in ${files}; do - # extract the language from file name after `qodana-` and before `.yaml` - language=$(echo $FILE | sed -r -z -e 's/(\.\/)*.*\/(qodana.yaml)/default/gm') - if [[ $language != "default" ]]; then - language=$(echo $FILE | sed -r -z -e 's/(\.\/)*.*qodana-(.*).yaml/\2/gm') - fi - MATRIX_COMBINATIONS="$MATRIX_COMBINATIONS {\"file\": \"$FILE\", \"language\": \"$language\"}," - REPORTS_MARKDOWN="$REPORTS_MARKDOWN
- [${language}](${report_url}/${language})" - done - - # removes the last character (i.e. comma) - MATRIX_COMBINATIONS=${MATRIX_COMBINATIONS::-1} - - # setup matrix for later jobs - matrix=$(( - echo "{ \"include\": [$MATRIX_COMBINATIONS] }" - ) | jq -c .) - - echo $matrix - echo $matrix | jq . - echo "matrix=$matrix" >> $GITHUB_OUTPUT - - echo "reports_markdown=$REPORTS_MARKDOWN" >> $GITHUB_OUTPUT - - - name: Setup initial notification inputs - id: inputs - if: >- - startsWith(github.event_name, 'pull_request') && - steps.prepare.outputs.files != '' - run: | - # workflow logs - workflow_url_a=https://github.com/${{ github.repository_owner }}/${{ github.event.repository.name }} - workflow_url=${workflow_url_a}/actions/runs/${{ github.run_id }} - - # multiline message - message=$(cat <<- EOF - :warning: **Qodana is checking this PR** :warning: - Live results available [here](${workflow_url}) - EOF - ) - - # escape json control characters - message=$(jq -n --arg message "$message" '$message' | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g') - - secondary_inputs=$(echo '{ - "issue_message": "'"${message}"'", - "issue_message_id": "'"qodana"'", - "issue_number": "'"${{ github.event.number }}"'", - "issue_repo_owner": "'"${{ github.repository_owner }}"'", - "issue_repo_name": "'"${{ github.event.repository.name }}"'" - }' | jq -r .) - - #escape json control characters - secondary_inputs=$(jq -n --arg secondary_inputs "$secondary_inputs" '$secondary_inputs' \ - | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g') - - echo $secondary_inputs - - # secondary input as string, not JSON - # todo - change dispatch_ref to master instead of nightly - primary_inputs=$(echo '{ - "dispatch_repository": "'"${{ github.repository_owner }}/.github"'", - "dispatch_workflow": "'"dispatch-issue-comment.yml"'", - "dispatch_ref": "'"nightly"'", - "dispatch_inputs": "'"${secondary_inputs}"'" - }' | jq -c .) - - echo $primary_inputs - echo $primary_inputs | jq . - echo "primary_inputs=$primary_inputs" >> $GITHUB_OUTPUT - - - name: Workflow Dispatch - if: >- - startsWith(github.event_name, 'pull_request') && - steps.prepare.outputs.files != '' - uses: benc-uk/workflow-dispatch@v1.2.2 - continue-on-error: true # this might error if the workflow is not found, but we still want to run the next job - with: - ref: ${{ github.base_ref || github.ref_name }} # base ref for PR and branch name for push - workflow: dispatcher.yml - inputs: ${{ steps.inputs.outputs.primary_inputs }} - token: ${{ github.token }} - - outputs: - destination: ${{ steps.prepare.outputs.destination }} - target: ${{ steps.prepare.outputs.target }} - files: ${{ steps.prepare.outputs.files }} - reports_markdown: ${{ steps.prepare.outputs.reports_markdown }} - matrix: ${{ steps.prepare.outputs.matrix }} - - qodana: - if: ${{ needs.qodana_initial_check.outputs.files != '' }} - needs: [qodana_initial_check] - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: ${{ fromJson(needs.qodana_initial_check.outputs.matrix) }} - name: Qodana-Scan-${{ matrix.language }} - continue-on-error: true - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - submodules: recursive - - - name: Get baseline - id: baseline - run: | - # check if destination is not an integer - if ! [[ "${{ needs.qodana_initial_check.outputs.destination }}" =~ ^[0-9]+$ ]] - then - echo "Running for a branch update" - echo "baseline_args=" >> $GITHUB_OUTPUT - else - echo "Running for a PR" - - sarif_file=qodana.sarif.json - repo=${{ github.event.repository.name }} - target=${{ needs.qodana_initial_check.outputs.target }} - language=${{ matrix.language }} - - baseline_file="${repo}/${target}/${language}/results/${sarif_file}" - baseline_file_url="https://lizardbyte.github.io/qodana-reports/${baseline_file}" - - # don't fail if file does not exist - wget ${baseline_file_url} || true - - # check if file exists - if [ -f ${sarif_file} ] - then - echo "baseline exists" - echo "baseline_args=--baseline,${sarif_file}" >> $GITHUB_OUTPUT - else - echo "baseline does not exist" - echo "baseline_args=" >> $GITHUB_OUTPUT - fi - fi - - - name: Rename Qodana config file - id: rename - run: | - # rename the file - if [ "${{ matrix.file }}" != "./qodana.yaml" ] - then - mv -f ${{ matrix.file }} ./qodana.yaml - fi - - - name: Qodana - id: qodana - continue-on-error: true # ensure dispatch-qodana job is run - uses: JetBrains/qodana-action@v2023.2.6 - with: - additional-cache-hash: ${{ github.ref }}-${{ matrix.language }} - artifact-name: qodana-${{ matrix.language }} # yamllint disable-line rule:line-length - args: '--print-problems,${{ steps.baseline.outputs.baseline_args }}' - pr-mode: false - upload-result: true - use-caches: true - - - name: Set output status - id: status - run: | - # check if qodana failed - echo "qodana_status=${{ steps.qodana.outcome }}" >> $GITHUB_OUTPUT - - outputs: - qodana_status: ${{ steps.status.outputs.qodana_status }} - - dispatch-qodana: - # trigger qodana-reports to download artifacts from the matrix runs - needs: [qodana_initial_check, qodana] - runs-on: ubuntu-latest - name: Dispatch Qodana - permissions: - actions: write # required to use workflow dispatch on fork PRs - if: ${{ needs.qodana_initial_check.outputs.files != '' }} - steps: - - name: Setup qodana publish inputs - id: inputs - run: | - # get the artifacts - artifacts=${{ toJson(steps.artifacts.outputs.result) }} - artifacts=$(echo $artifacts | jq -c .) - - # get the target branch - target=${{ needs.qodana_initial_check.outputs.target }} - - # get the destination branch - destination=${{ needs.qodana_initial_check.outputs.destination }} - - # client payload - secondary_inputs=$(echo '{ - "destination": "'"${destination}"'", - "ref": "'"${{ github.ref }}"'", - "repo": "'"${{ github.repository }}"'", - "repo_name": "'"${{ github.event.repository.name }}"'", - "run_id": "'"${{ github.run_id }}"'", - "reports_markdown": "'"${{ needs.qodana_initial_check.outputs.reports_markdown }}"'", - "status": "'"${{ needs.qodana.outputs.qodana_status }}"'" - }' | jq -r .) - - #escape json control characters - secondary_inputs=$(jq -n --arg secondary_inputs "$secondary_inputs" '$secondary_inputs' \ - | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g') - - echo $secondary_inputs - - primary_inputs=$(echo '{ - "dispatch_repository": "'"${{ github.repository_owner }}/qodana-reports"'", - "dispatch_workflow": "'"dispatch-qodana.yml"'", - "dispatch_ref": "'"master"'", - "dispatch_inputs": "'"$secondary_inputs"'" - }' | jq -c .) - - echo $primary_inputs - echo $primary_inputs | jq . - echo "primary_inputs=$primary_inputs" >> $GITHUB_OUTPUT - - - name: Workflow Dispatch - uses: benc-uk/workflow-dispatch@v1.2.2 - continue-on-error: true # this might error if the workflow is not found, but we don't want to fail the workflow - with: - ref: ${{ github.base_ref || github.ref_name }} # base ref for PR and branch name for push - workflow: dispatcher.yml - inputs: ${{ steps.inputs.outputs.primary_inputs }} - token: ${{ github.token }} diff --git a/.github/workflows/dispatcher.yml b/.github/workflows/dispatcher.yml deleted file mode 100644 index c83a233ecea..00000000000 --- a/.github/workflows/dispatcher.yml +++ /dev/null @@ -1,69 +0,0 @@ ---- -# This action is centrally managed in https://github.com//.github/ -# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in -# the above-mentioned repo. - -# This action receives a dispatch event and passes it through to another repo. This is a workaround to avoid issues -# where fork PRs do not have access to secrets. - -name: Dispatcher - -on: - workflow_dispatch: - inputs: - dispatch_repository: - description: 'Repository to dispatch to' - required: true - dispatch_workflow: - description: 'Workflow to dispatch to' - required: true - dispatch_ref: - description: 'Ref/branch to dispatch to' - required: true - dispatch_inputs: - description: 'Inputs to send' - required: true - -jobs: - dispatcher: - name: Repository Dispatch - runs-on: ubuntu-latest - steps: - - name: Unescape JSON control characters - id: inputs - run: | - # get the inputs - dispatch_inputs=${{ github.event.inputs.dispatch_inputs }} - echo "$dispatch_inputs" - - # temporarily replace newlines with a placeholder - dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/\\\\n/_!new_line!_/g') - - # remove newline characters - dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/\\n//g') - - # replace placeholder with newline - dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/_!new_line!_/\\n/g') - - # replace escaped quotes with unescaped quotes - dispatch_inputs=$(echo ${dispatch_inputs} | sed 's/\\"//g') - - # debug echo - echo "$dispatch_inputs" - - # parse as JSON - dispatch_inputs=$(echo "$dispatch_inputs" | jq -c .) - - # debug echo - echo "$dispatch_inputs" - - echo "dispatch_inputs=$dispatch_inputs" >> $GITHUB_OUTPUT - - - name: Workflow Dispatch - uses: benc-uk/workflow-dispatch@v1.2.2 - with: - repo: ${{ github.event.inputs.dispatch_repository }} - ref: ${{ github.event.inputs.dispatch_ref || 'master' }} # default to master if not specified - workflow: ${{ github.event.inputs.dispatch_workflow }} - inputs: ${{ steps.inputs.outputs.dispatch_inputs }} - token: ${{ secrets.GH_BOT_TOKEN || github.token }} # fallback to default token if not specified From ef9ec405099454015e59db2ff809943eca7ad3d5 Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Sun, 10 Dec 2023 10:01:58 -0500 Subject: [PATCH 027/197] ci: update global workflows (#1907) --- qodana-js.yaml | 21 --------------------- qodana-python.yaml | 29 ----------------------------- 2 files changed, 50 deletions(-) delete mode 100644 qodana-js.yaml delete mode 100644 qodana-python.yaml diff --git a/qodana-js.yaml b/qodana-js.yaml deleted file mode 100644 index d130951323f..00000000000 --- a/qodana-js.yaml +++ /dev/null @@ -1,21 +0,0 @@ ---- -version: "1.0" -linter: jetbrains/qodana-js:2023.1-eap - -bootstrap: | - # install npm dependencies - npm install - -exclude: - - name: All - paths: - - gh-pages - - third-party - -failThreshold: 100 - -include: - - name: CheckDependencyLicenses - -profile: - name: qodana.recommended diff --git a/qodana-python.yaml b/qodana-python.yaml deleted file mode 100644 index efbf876ee3d..00000000000 --- a/qodana-python.yaml +++ /dev/null @@ -1,29 +0,0 @@ ---- -version: "1.0" -linter: jetbrains/qodana-python:2023.1-eap - -bootstrap: | - # setup python - - python3 -m venv /data/cache/venv - source /data/cache/venv/bin/activate - python3 -m pip install -r /data/project/docs/requirements.txt - python3 -m pip install -r /data/project/scripts/requirements.txt - - # remove idea directory (No Python interpreter configured for the project) - # https://github.com/JetBrains/Qodana/discussions/134#discussioncomment-4329981 - rm -rf .idea - -exclude: - - name: All - paths: - - gh-pages - - third-party - -failThreshold: 100 - -include: - - name: CheckDependencyLicenses - -profile: - name: qodana.recommended From 88fc8f845b28c2554020ebc3ddd666bec979bcaf Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Mon, 11 Dec 2023 14:53:32 -0500 Subject: [PATCH 028/197] build(docker): add fedora 39 and drop fedora 37 (#1827) --- ...ora-37.dockerfile => fedora-39.dockerfile} | 56 ++++++++++--------- docs/source/about/installation.rst | 2 +- docs/source/building/linux.rst | 2 +- 3 files changed, 31 insertions(+), 29 deletions(-) rename docker/{fedora-37.dockerfile => fedora-39.dockerfile} (72%) diff --git a/docker/fedora-37.dockerfile b/docker/fedora-39.dockerfile similarity index 72% rename from docker/fedora-37.dockerfile rename to docker/fedora-39.dockerfile index c6aa0593a6b..6c6db891bbf 100644 --- a/docker/fedora-37.dockerfile +++ b/docker/fedora-39.dockerfile @@ -4,7 +4,7 @@ # platforms_pr: linux/amd64 # no-cache-filters: sunshine-base,artifacts,sunshine ARG BASE=fedora -ARG TAG=37 +ARG TAG=39 FROM ${BASE}:${TAG} AS sunshine-base FROM sunshine-base as sunshine-build @@ -30,10 +30,10 @@ set -e dnf -y update dnf -y group install "Development Tools" dnf -y install \ - boost-devel-1.78.* \ + boost-devel-1.81.0* \ cmake-3.27.* \ - gcc-12.2.* \ - gcc-c++-12.2.* \ + gcc-13.2.* \ + gcc-c++-13.2.* \ git \ libappindicator-gtk3-devel \ libcap-devel \ @@ -67,27 +67,28 @@ dnf clean all rm -rf /var/cache/yum _DEPS -# install cuda -WORKDIR /build/cuda -# versions: https://developer.nvidia.com/cuda-toolkit-archive -ENV CUDA_VERSION="12.0.0" -ENV CUDA_BUILD="525.60.13" -# hadolint ignore=SC3010 -RUN <<_INSTALL_CUDA -#!/bin/bash -set -e -cuda_prefix="https://developer.download.nvidia.com/compute/cuda/" -cuda_suffix="" -if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then - cuda_suffix="_sbsa" -fi -url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run" -echo "cuda url: ${url}" -wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run -chmod a+x ./cuda.run -./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm -rm ./cuda.run -_INSTALL_CUDA +# todo - enable cuda once it's supported for gcc 13 and fedora 39 +## install cuda +#WORKDIR /build/cuda +## versions: https://developer.nvidia.com/cuda-toolkit-archive +#ENV CUDA_VERSION="12.0.0" +#ENV CUDA_BUILD="525.60.13" +## hadolint ignore=SC3010 +#RUN <<_INSTALL_CUDA +##!/bin/bash +#set -e +#cuda_prefix="https://developer.download.nvidia.com/compute/cuda/" +#cuda_suffix="" +#if [[ "${TARGETPLATFORM}" == 'linux/arm64' ]]; then +# cuda_suffix="_sbsa" +#fi +#url="${cuda_prefix}${CUDA_VERSION}/local_installers/cuda_${CUDA_VERSION}_${CUDA_BUILD}_linux${cuda_suffix}.run" +#echo "cuda url: ${url}" +#wget "$url" --progress=bar:force:noscroll -q --show-progress -O ./cuda.run +#chmod a+x ./cuda.run +#./cuda.run --silent --toolkit --toolkitpath=/build/cuda --no-opengl-libs --no-man-page --no-drm +#rm ./cuda.run +#_INSTALL_CUDA # copy repository WORKDIR /build/sunshine/ @@ -100,11 +101,12 @@ RUN npm install WORKDIR /build/sunshine/build # cmake and cpack +# todo - add cmake argument back in for cuda support "-DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \" +# todo - re-enable "DSUNSHINE_ENABLE_CUDA" RUN <<_MAKE #!/bin/bash set -e cmake \ - -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=/usr \ -DSUNSHINE_ASSETS_DIR=share/sunshine \ @@ -112,7 +114,7 @@ cmake \ -DSUNSHINE_ENABLE_WAYLAND=ON \ -DSUNSHINE_ENABLE_X11=ON \ -DSUNSHINE_ENABLE_DRM=ON \ - -DSUNSHINE_ENABLE_CUDA=ON \ + -DSUNSHINE_ENABLE_CUDA=OFF \ /build/sunshine make -j "$(nproc)" cpack -G RPM diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst index 3d20a020b30..be7510ad7ec 100644 --- a/docs/source/about/installation.rst +++ b/docs/source/about/installation.rst @@ -41,8 +41,8 @@ CUDA is used for NVFBC capture. sunshine_{arch}.flatpak 12.0.0 525.60.13 50;52;60;61;62;70;75;80;86;90 sunshine-debian-bookworm-{arch}.deb 12.0.0 525.60.13 50;52;60;61;62;70;75;80;86;90 sunshine-debian-bullseye-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 - sunshine-fedora-37-{arch}.rpm 12.0.0 525.60.13 50;52;60;61;62;70;75;80;86;90 sunshine-fedora-38-{arch}.rpm unavailable unavailable none + sunshine-fedora-39-{arch}.rpm unavailable unavailable none sunshine-ubuntu-20.04-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 sunshine-ubuntu-22.04-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 =========================================== ============== ============== ================================ diff --git a/docs/source/building/linux.rst b/docs/source/building/linux.rst index 82a3ed17462..0ac90079e39 100644 --- a/docs/source/building/linux.rst +++ b/docs/source/building/linux.rst @@ -46,7 +46,7 @@ Install Requirements nvidia-cuda-dev \ # Cuda, NvFBC nvidia-cuda-toolkit # Cuda, NvFBC -Fedora 37, 38 +Fedora 38, 39 ^^^^^^^^^^^^^ Install Requirements From 4c984cacb54c09ee954e8855b6341e699bbfd535 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 15 Dec 2023 17:50:06 -0500 Subject: [PATCH 029/197] build(deps): bump actions/upload-artifact from 3 to 4 (#1915) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/CI.yml | 10 +++++----- .github/workflows/ci-docker.yml | 2 +- .github/workflows/cpp-lint.yml | 2 +- .github/workflows/update-pages.yml | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index b802e2346a9..8eadad4140c 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -251,7 +251,7 @@ jobs: ../artifacts/sunshine_debug_${{ matrix.arch }}.flatpak dev.lizardbyte.sunshine.Debug' - name: Upload Artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: sunshine-linux-flatpak-${{ matrix.arch }} path: artifacts/ @@ -483,7 +483,7 @@ jobs: ./appimagelint-x86_64.AppImage ./artifacts/sunshine.AppImage - name: Upload Artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: sunshine-linux-${{ matrix.type }}-${{ matrix.dist }} path: artifacts/ @@ -551,7 +551,7 @@ jobs: # mv ./cpack_artifacts/Sunshine.dmg ../artifacts/sunshine-bundle.dmg - name: Upload Artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: sunshine-macos path: artifacts/ @@ -676,7 +676,7 @@ jobs: echo "::endgroup::" - name: Upload Artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: sunshine-macports path: artifacts/ @@ -771,7 +771,7 @@ jobs: a "../artifacts/sunshine-debuginfo-win32.zip" "*.exe" - name: Upload Artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: sunshine-windows path: artifacts/ diff --git a/.github/workflows/ci-docker.yml b/.github/workflows/ci-docker.yml index edeeb2bd9b7..70e940d68d9 100644 --- a/.github/workflows/ci-docker.yml +++ b/.github/workflows/ci-docker.yml @@ -395,7 +395,7 @@ jobs: - name: Upload Artifacts if: ${{ steps.prepare.outputs.artifacts == 'true' }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: Docker${{ matrix.tag }} path: artifacts/ diff --git a/.github/workflows/cpp-lint.yml b/.github/workflows/cpp-lint.yml index b5d4ff7765e..921641c593e 100644 --- a/.github/workflows/cpp-lint.yml +++ b/.github/workflows/cpp-lint.yml @@ -65,7 +65,7 @@ jobs: - name: Upload Artifacts if: failure() - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: clang-format-fixes path: ${{ steps.find_files.outputs.found_files }} diff --git a/.github/workflows/update-pages.yml b/.github/workflows/update-pages.yml index 5fbbf97f9f4..5fb435d1602 100644 --- a/.github/workflows/update-pages.yml +++ b/.github/workflows/update-pages.yml @@ -39,7 +39,7 @@ jobs: - name: Upload Artifacts if: ${{ github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: gh-pages if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn` From 068c3fa303fe871555598bedbecd8ade302f1a32 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 17 Dec 2023 10:37:54 -0500 Subject: [PATCH 030/197] docs: use glob pattern to match source code docs (#1918) --- docs/source/source/src/platform.rst | 10 --- docs/source/source/src/platform/linux.rst | 12 ---- docs/source/source/src/platform/macos.rst | 11 ---- docs/source/source/src/platform/windows.rst | 9 --- .../src.rst => source_code/source_code.rst} | 65 ++++++++++--------- .../{source => source_code}/src/audio.rst | 0 .../{source => source_code}/src/cbs.rst | 0 .../{source => source_code}/src/config.rst | 0 .../src/confighttp.rst | 0 .../{source => source_code}/src/crypto.rst | 0 .../src/httpcommon.rst | 0 .../{source => source_code}/src/input.rst | 0 .../{source => source_code}/src/main.rst | 0 .../src/move_by_copy.rst | 0 .../{source => source_code}/src/network.rst | 0 .../{source => source_code}/src/nvhttp.rst | 0 .../src/platform/common.rst | 0 .../src/platform/linux/cuda.rst | 0 .../src/platform/linux/graphics.rst | 0 .../src/platform/linux/misc.rst | 0 .../src/platform/linux/vaapi.rst | 0 .../src/platform/linux/wayland.rst | 0 .../src/platform/linux/x11grab.rst | 0 .../src/platform/macos/av_audio.rst | 0 .../src/platform/macos/av_img_t.rst | 0 .../src/platform/macos/av_video.rst | 0 .../src/platform/macos/misc.rst | 0 .../src/platform/macos/nv12_zero_device.rst | 0 .../src/platform/windows/PolicyConfig.rst | 0 .../src/platform/windows/display.rst | 0 .../src/platform/windows/misc.rst | 0 .../{source => source_code}/src/process.rst | 0 .../src/round_robin.rst | 0 .../{source => source_code}/src/rtsp.rst | 0 .../{source => source_code}/src/stream.rst | 0 .../{source => source_code}/src/sync.rst | 0 .../src/system_tray.rst | 0 .../{source => source_code}/src/task_pool.rst | 0 .../src/thread_pool.rst | 0 .../src/thread_safe.rst | 0 .../{source => source_code}/src/upnp.rst | 0 .../{source => source_code}/src/utility.rst | 0 .../{source => source_code}/src/uuid.rst | 0 .../{source => source_code}/src/video.rst | 0 docs/source/toc.rst | 2 +- 45 files changed, 36 insertions(+), 73 deletions(-) delete mode 100644 docs/source/source/src/platform.rst delete mode 100644 docs/source/source/src/platform/linux.rst delete mode 100644 docs/source/source/src/platform/macos.rst delete mode 100644 docs/source/source/src/platform/windows.rst rename docs/source/{source/src.rst => source_code/source_code.rst} (73%) rename docs/source/{source => source_code}/src/audio.rst (100%) rename docs/source/{source => source_code}/src/cbs.rst (100%) rename docs/source/{source => source_code}/src/config.rst (100%) rename docs/source/{source => source_code}/src/confighttp.rst (100%) rename docs/source/{source => source_code}/src/crypto.rst (100%) rename docs/source/{source => source_code}/src/httpcommon.rst (100%) rename docs/source/{source => source_code}/src/input.rst (100%) rename docs/source/{source => source_code}/src/main.rst (100%) rename docs/source/{source => source_code}/src/move_by_copy.rst (100%) rename docs/source/{source => source_code}/src/network.rst (100%) rename docs/source/{source => source_code}/src/nvhttp.rst (100%) rename docs/source/{source => source_code}/src/platform/common.rst (100%) rename docs/source/{source => source_code}/src/platform/linux/cuda.rst (100%) rename docs/source/{source => source_code}/src/platform/linux/graphics.rst (100%) rename docs/source/{source => source_code}/src/platform/linux/misc.rst (100%) rename docs/source/{source => source_code}/src/platform/linux/vaapi.rst (100%) rename docs/source/{source => source_code}/src/platform/linux/wayland.rst (100%) rename docs/source/{source => source_code}/src/platform/linux/x11grab.rst (100%) rename docs/source/{source => source_code}/src/platform/macos/av_audio.rst (100%) rename docs/source/{source => source_code}/src/platform/macos/av_img_t.rst (100%) rename docs/source/{source => source_code}/src/platform/macos/av_video.rst (100%) rename docs/source/{source => source_code}/src/platform/macos/misc.rst (100%) rename docs/source/{source => source_code}/src/platform/macos/nv12_zero_device.rst (100%) rename docs/source/{source => source_code}/src/platform/windows/PolicyConfig.rst (100%) rename docs/source/{source => source_code}/src/platform/windows/display.rst (100%) rename docs/source/{source => source_code}/src/platform/windows/misc.rst (100%) rename docs/source/{source => source_code}/src/process.rst (100%) rename docs/source/{source => source_code}/src/round_robin.rst (100%) rename docs/source/{source => source_code}/src/rtsp.rst (100%) rename docs/source/{source => source_code}/src/stream.rst (100%) rename docs/source/{source => source_code}/src/sync.rst (100%) rename docs/source/{source => source_code}/src/system_tray.rst (100%) rename docs/source/{source => source_code}/src/task_pool.rst (100%) rename docs/source/{source => source_code}/src/thread_pool.rst (100%) rename docs/source/{source => source_code}/src/thread_safe.rst (100%) rename docs/source/{source => source_code}/src/upnp.rst (100%) rename docs/source/{source => source_code}/src/utility.rst (100%) rename docs/source/{source => source_code}/src/uuid.rst (100%) rename docs/source/{source => source_code}/src/video.rst (100%) diff --git a/docs/source/source/src/platform.rst b/docs/source/source/src/platform.rst deleted file mode 100644 index ca74092992e..00000000000 --- a/docs/source/source/src/platform.rst +++ /dev/null @@ -1,10 +0,0 @@ -platform -======== - -.. toctree:: - :maxdepth: 1 - - platform/common - platform/linux - platform/macos - platform/windows diff --git a/docs/source/source/src/platform/linux.rst b/docs/source/source/src/platform/linux.rst deleted file mode 100644 index f67235b6438..00000000000 --- a/docs/source/source/src/platform/linux.rst +++ /dev/null @@ -1,12 +0,0 @@ -linux -===== - -.. toctree:: - :maxdepth: 1 - - linux/cuda - linux/graphics - linux/misc - linux/vaapi - linux/wayland - linux/x11grab diff --git a/docs/source/source/src/platform/macos.rst b/docs/source/source/src/platform/macos.rst deleted file mode 100644 index 1031eb63551..00000000000 --- a/docs/source/source/src/platform/macos.rst +++ /dev/null @@ -1,11 +0,0 @@ -macos -===== - -.. toctree:: - :maxdepth: 1 - - macos/av_audio - macos/av_img_t - macos/av_video - macos/misc - macos/nv12_zero_device diff --git a/docs/source/source/src/platform/windows.rst b/docs/source/source/src/platform/windows.rst deleted file mode 100644 index 9bcece68c3a..00000000000 --- a/docs/source/source/src/platform/windows.rst +++ /dev/null @@ -1,9 +0,0 @@ -windows -======= - -.. toctree:: - :maxdepth: 1 - - windows/display - windows/misc - windows/PolicyConfig diff --git a/docs/source/source/src.rst b/docs/source/source_code/source_code.rst similarity index 73% rename from docs/source/source/src.rst rename to docs/source/source_code/source_code.rst index bdba0c359c4..fecc6801c92 100644 --- a/docs/source/source/src.rst +++ b/docs/source/source_code/source_code.rst @@ -1,5 +1,5 @@ -src -=== +Source Code +=========== We are in process of improving the source code documentation. Code should be documented using Doxygen syntax. Some examples exist in `main.h` and `main.cpp`. In order for documentation within the code to appear in the rendered docs, the definition of the object must be in a header file, although the documentation itself can (and @@ -52,35 +52,40 @@ Example Documentation Blocks // do stuff } -Code ----- +Source +------ .. toctree:: - :maxdepth: 2 :caption: src + :maxdepth: 1 + :glob: - src/main - src/audio - src/cbs - src/config - src/confighttp - src/crypto - src/httpcommon - src/input - src/move_by_copy - src/network - src/nvhttp - src/process - src/round_robin - src/rtsp - src/stream - src/sync - src/system_tray - src/task_pool - src/thread_pool - src/thread_safe - src/upnp - src/utility - src/uuid - src/video - src/platform + src/* + +.. toctree:: + :caption: src/platform + :maxdepth: 1 + :glob: + + src/platform/* + +.. toctree:: + :caption: src/platform/linux + :maxdepth: 1 + :glob: + + src/platform/linux/* + +.. toctree:: + :caption: src/platform/macos + :maxdepth: 1 + :glob: + + src/platform/macos/* + +.. toctree:: + :caption: src/platform/windows + :maxdepth: 1 + :glob: + + src/platform/windows/* diff --git a/docs/source/source/src/audio.rst b/docs/source/source_code/src/audio.rst similarity index 100% rename from docs/source/source/src/audio.rst rename to docs/source/source_code/src/audio.rst diff --git a/docs/source/source/src/cbs.rst b/docs/source/source_code/src/cbs.rst similarity index 100% rename from docs/source/source/src/cbs.rst rename to docs/source/source_code/src/cbs.rst diff --git a/docs/source/source/src/config.rst b/docs/source/source_code/src/config.rst similarity index 100% rename from docs/source/source/src/config.rst rename to docs/source/source_code/src/config.rst diff --git a/docs/source/source/src/confighttp.rst b/docs/source/source_code/src/confighttp.rst similarity index 100% rename from docs/source/source/src/confighttp.rst rename to docs/source/source_code/src/confighttp.rst diff --git a/docs/source/source/src/crypto.rst b/docs/source/source_code/src/crypto.rst similarity index 100% rename from docs/source/source/src/crypto.rst rename to docs/source/source_code/src/crypto.rst diff --git a/docs/source/source/src/httpcommon.rst b/docs/source/source_code/src/httpcommon.rst similarity index 100% rename from docs/source/source/src/httpcommon.rst rename to docs/source/source_code/src/httpcommon.rst diff --git a/docs/source/source/src/input.rst b/docs/source/source_code/src/input.rst similarity index 100% rename from docs/source/source/src/input.rst rename to docs/source/source_code/src/input.rst diff --git a/docs/source/source/src/main.rst b/docs/source/source_code/src/main.rst similarity index 100% rename from docs/source/source/src/main.rst rename to docs/source/source_code/src/main.rst diff --git a/docs/source/source/src/move_by_copy.rst b/docs/source/source_code/src/move_by_copy.rst similarity index 100% rename from docs/source/source/src/move_by_copy.rst rename to docs/source/source_code/src/move_by_copy.rst diff --git a/docs/source/source/src/network.rst b/docs/source/source_code/src/network.rst similarity index 100% rename from docs/source/source/src/network.rst rename to docs/source/source_code/src/network.rst diff --git a/docs/source/source/src/nvhttp.rst b/docs/source/source_code/src/nvhttp.rst similarity index 100% rename from docs/source/source/src/nvhttp.rst rename to docs/source/source_code/src/nvhttp.rst diff --git a/docs/source/source/src/platform/common.rst b/docs/source/source_code/src/platform/common.rst similarity index 100% rename from docs/source/source/src/platform/common.rst rename to docs/source/source_code/src/platform/common.rst diff --git a/docs/source/source/src/platform/linux/cuda.rst b/docs/source/source_code/src/platform/linux/cuda.rst similarity index 100% rename from docs/source/source/src/platform/linux/cuda.rst rename to docs/source/source_code/src/platform/linux/cuda.rst diff --git a/docs/source/source/src/platform/linux/graphics.rst b/docs/source/source_code/src/platform/linux/graphics.rst similarity index 100% rename from docs/source/source/src/platform/linux/graphics.rst rename to docs/source/source_code/src/platform/linux/graphics.rst diff --git a/docs/source/source/src/platform/linux/misc.rst b/docs/source/source_code/src/platform/linux/misc.rst similarity index 100% rename from docs/source/source/src/platform/linux/misc.rst rename to docs/source/source_code/src/platform/linux/misc.rst diff --git a/docs/source/source/src/platform/linux/vaapi.rst b/docs/source/source_code/src/platform/linux/vaapi.rst similarity index 100% rename from docs/source/source/src/platform/linux/vaapi.rst rename to docs/source/source_code/src/platform/linux/vaapi.rst diff --git a/docs/source/source/src/platform/linux/wayland.rst b/docs/source/source_code/src/platform/linux/wayland.rst similarity index 100% rename from docs/source/source/src/platform/linux/wayland.rst rename to docs/source/source_code/src/platform/linux/wayland.rst diff --git a/docs/source/source/src/platform/linux/x11grab.rst b/docs/source/source_code/src/platform/linux/x11grab.rst similarity index 100% rename from docs/source/source/src/platform/linux/x11grab.rst rename to docs/source/source_code/src/platform/linux/x11grab.rst diff --git a/docs/source/source/src/platform/macos/av_audio.rst b/docs/source/source_code/src/platform/macos/av_audio.rst similarity index 100% rename from docs/source/source/src/platform/macos/av_audio.rst rename to docs/source/source_code/src/platform/macos/av_audio.rst diff --git a/docs/source/source/src/platform/macos/av_img_t.rst b/docs/source/source_code/src/platform/macos/av_img_t.rst similarity index 100% rename from docs/source/source/src/platform/macos/av_img_t.rst rename to docs/source/source_code/src/platform/macos/av_img_t.rst diff --git a/docs/source/source/src/platform/macos/av_video.rst b/docs/source/source_code/src/platform/macos/av_video.rst similarity index 100% rename from docs/source/source/src/platform/macos/av_video.rst rename to docs/source/source_code/src/platform/macos/av_video.rst diff --git a/docs/source/source/src/platform/macos/misc.rst b/docs/source/source_code/src/platform/macos/misc.rst similarity index 100% rename from docs/source/source/src/platform/macos/misc.rst rename to docs/source/source_code/src/platform/macos/misc.rst diff --git a/docs/source/source/src/platform/macos/nv12_zero_device.rst b/docs/source/source_code/src/platform/macos/nv12_zero_device.rst similarity index 100% rename from docs/source/source/src/platform/macos/nv12_zero_device.rst rename to docs/source/source_code/src/platform/macos/nv12_zero_device.rst diff --git a/docs/source/source/src/platform/windows/PolicyConfig.rst b/docs/source/source_code/src/platform/windows/PolicyConfig.rst similarity index 100% rename from docs/source/source/src/platform/windows/PolicyConfig.rst rename to docs/source/source_code/src/platform/windows/PolicyConfig.rst diff --git a/docs/source/source/src/platform/windows/display.rst b/docs/source/source_code/src/platform/windows/display.rst similarity index 100% rename from docs/source/source/src/platform/windows/display.rst rename to docs/source/source_code/src/platform/windows/display.rst diff --git a/docs/source/source/src/platform/windows/misc.rst b/docs/source/source_code/src/platform/windows/misc.rst similarity index 100% rename from docs/source/source/src/platform/windows/misc.rst rename to docs/source/source_code/src/platform/windows/misc.rst diff --git a/docs/source/source/src/process.rst b/docs/source/source_code/src/process.rst similarity index 100% rename from docs/source/source/src/process.rst rename to docs/source/source_code/src/process.rst diff --git a/docs/source/source/src/round_robin.rst b/docs/source/source_code/src/round_robin.rst similarity index 100% rename from docs/source/source/src/round_robin.rst rename to docs/source/source_code/src/round_robin.rst diff --git a/docs/source/source/src/rtsp.rst b/docs/source/source_code/src/rtsp.rst similarity index 100% rename from docs/source/source/src/rtsp.rst rename to docs/source/source_code/src/rtsp.rst diff --git a/docs/source/source/src/stream.rst b/docs/source/source_code/src/stream.rst similarity index 100% rename from docs/source/source/src/stream.rst rename to docs/source/source_code/src/stream.rst diff --git a/docs/source/source/src/sync.rst b/docs/source/source_code/src/sync.rst similarity index 100% rename from docs/source/source/src/sync.rst rename to docs/source/source_code/src/sync.rst diff --git a/docs/source/source/src/system_tray.rst b/docs/source/source_code/src/system_tray.rst similarity index 100% rename from docs/source/source/src/system_tray.rst rename to docs/source/source_code/src/system_tray.rst diff --git a/docs/source/source/src/task_pool.rst b/docs/source/source_code/src/task_pool.rst similarity index 100% rename from docs/source/source/src/task_pool.rst rename to docs/source/source_code/src/task_pool.rst diff --git a/docs/source/source/src/thread_pool.rst b/docs/source/source_code/src/thread_pool.rst similarity index 100% rename from docs/source/source/src/thread_pool.rst rename to docs/source/source_code/src/thread_pool.rst diff --git a/docs/source/source/src/thread_safe.rst b/docs/source/source_code/src/thread_safe.rst similarity index 100% rename from docs/source/source/src/thread_safe.rst rename to docs/source/source_code/src/thread_safe.rst diff --git a/docs/source/source/src/upnp.rst b/docs/source/source_code/src/upnp.rst similarity index 100% rename from docs/source/source/src/upnp.rst rename to docs/source/source_code/src/upnp.rst diff --git a/docs/source/source/src/utility.rst b/docs/source/source_code/src/utility.rst similarity index 100% rename from docs/source/source/src/utility.rst rename to docs/source/source_code/src/utility.rst diff --git a/docs/source/source/src/uuid.rst b/docs/source/source_code/src/uuid.rst similarity index 100% rename from docs/source/source/src/uuid.rst rename to docs/source/source_code/src/uuid.rst diff --git a/docs/source/source/src/video.rst b/docs/source/source_code/src/video.rst similarity index 100% rename from docs/source/source/src/video.rst rename to docs/source/source_code/src/video.rst diff --git a/docs/source/toc.rst b/docs/source/toc.rst index 6121e4402e3..7b182a2c91d 100644 --- a/docs/source/toc.rst +++ b/docs/source/toc.rst @@ -53,4 +53,4 @@ :maxdepth: 2 :caption: source - source/src + source_code/source_code From 6b7b5996ccd040375b62d930e064abddcc533a72 Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Tue, 19 Dec 2023 16:41:03 -0500 Subject: [PATCH 031/197] chore: update global workflows (#1921) --- .github/workflows/codeql.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 358ff9c99f6..ae5248763ec 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -116,7 +116,7 @@ jobs: # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v2 + uses: github/codeql-action/init@v3 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -139,9 +139,9 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift). - name: Autobuild - uses: github/codeql-action/autobuild@v2 + uses: github/codeql-action/autobuild@v3 - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + uses: github/codeql-action/analyze@v3 with: category: "/language:${{matrix.language}}" From 5bdbda90b5458e25f8b2d8d6f394bc542c610517 Mon Sep 17 00:00:00 2001 From: TheElixZammuto Date: Thu, 28 Dec 2023 01:25:49 +0100 Subject: [PATCH 032/197] Web UI migration to Vite and Vue3 and improvements to the UX (#1673) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> --- .github/workflows/CI.yml | 11 +- cmake/dependencies/common.cmake | 1 + cmake/packaging/common.cmake | 11 +- cmake/packaging/linux.cmake | 6 +- cmake/packaging/macos.cmake | 2 - cmake/packaging/unix.cmake | 3 - cmake/packaging/windows.cmake | 3 - cmake/targets/common.cmake | 6 + docker/debian-bookworm.dockerfile | 3 - docker/debian-bullseye.dockerfile | 21 +- docker/fedora-38.dockerfile | 5 +- docker/fedora-39.dockerfile | 5 +- docker/ubuntu-20.04.dockerfile | 21 +- docker/ubuntu-22.04.dockerfile | 22 +- docs/source/building/linux.rst | 7 - docs/source/building/macos.rst | 7 - docs/source/building/windows.rst | 13 +- docs/source/conf.py | 2 +- docs/source/contributing/contributing.rst | 20 + package.json | 10 +- packaging/linux/Arch/PKGBUILD | 4 - .../linux/flatpak/dev.lizardbyte.sunshine.yml | 3 - packaging/macos/Portfile | 4 - scripts/icons/convert_and_pack.sh | 6 +- src/confighttp.cpp | 32 +- src_assets/common/assets/web/Navbar.vue | 60 + src_assets/common/assets/web/ResourceCard.vue | 36 + src_assets/common/assets/web/apps.html | 812 ++++---- src_assets/common/assets/web/clients.html | 3 - src_assets/common/assets/web/config.html | 1828 +++++++---------- .../common/assets/web/header-no-nav.html | 14 - src_assets/common/assets/web/header.html | 83 - src_assets/common/assets/web/index.html | 147 +- src_assets/common/assets/web/password.html | 164 +- src_assets/common/assets/web/pin.html | 56 +- .../{ => public}/images/logo-sunshine-16.png | Bin .../{ => public}/images/logo-sunshine-45.png | Bin .../images/sunshine-locked-16.png | Bin .../images/sunshine-locked-45.png | Bin .../{ => public}/images/sunshine-locked.ico | Bin .../{ => public}/images/sunshine-locked.png | Bin .../{ => public}/images/sunshine-locked.svg | 0 .../images/sunshine-pausing-16.png | Bin .../images/sunshine-pausing-45.png | Bin .../{ => public}/images/sunshine-pausing.ico | Bin .../{ => public}/images/sunshine-pausing.png | Bin .../{ => public}/images/sunshine-pausing.svg | 0 .../images/sunshine-playing-16.png | Bin .../images/sunshine-playing-45.png | Bin .../{ => public}/images/sunshine-playing.ico | Bin .../{ => public}/images/sunshine-playing.png | Bin .../{ => public}/images/sunshine-playing.svg | 0 .../web/{ => public}/images/sunshine.ico | Bin .../common/assets/web/template_header.html | 9 + .../common/assets/web/troubleshooting.html | 353 ++-- src_assets/common/assets/web/welcome.html | 125 +- vite.config.js | 53 + 57 files changed, 1831 insertions(+), 2140 deletions(-) create mode 100644 src_assets/common/assets/web/Navbar.vue create mode 100644 src_assets/common/assets/web/ResourceCard.vue delete mode 100644 src_assets/common/assets/web/clients.html delete mode 100644 src_assets/common/assets/web/header-no-nav.html delete mode 100644 src_assets/common/assets/web/header.html rename src_assets/common/assets/web/{ => public}/images/logo-sunshine-16.png (100%) rename src_assets/common/assets/web/{ => public}/images/logo-sunshine-45.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-locked-16.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-locked-45.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-locked.ico (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-locked.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-locked.svg (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-pausing-16.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-pausing-45.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-pausing.ico (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-pausing.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-pausing.svg (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-playing-16.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-playing-45.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-playing.ico (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-playing.png (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine-playing.svg (100%) rename src_assets/common/assets/web/{ => public}/images/sunshine.ico (100%) create mode 100644 src_assets/common/assets/web/template_header.html create mode 100644 vite.config.js diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 8eadad4140c..38907881d2c 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -398,8 +398,6 @@ jobs: mkdir -p build mkdir -p artifacts - npm install - cd build cmake -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=/usr \ @@ -527,8 +525,6 @@ jobs: BUILD_VERSION: ${{ needs.check_changelog.outputs.next_version_bare }} COMMIT: ${{ github.event.pull_request.head.sha || github.sha }} run: | - npm install - mkdir build cd build cmake -DCMAKE_BUILD_TYPE=Release \ @@ -719,8 +715,9 @@ jobs: mingw-w64-x86_64-boost mingw-w64-x86_64-cmake mingw-w64-x86_64-curl - mingw-w64-x86_64-onevpl + 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 @@ -728,10 +725,6 @@ jobs: wget yasm - - name: Install npm packages - run: | - npm install - - name: Build Windows shell: msys2 {0} env: diff --git a/cmake/dependencies/common.cmake b/cmake/dependencies/common.cmake index 9bc7c56ceee..34ea09f7a3a 100644 --- a/cmake/dependencies/common.cmake +++ b/cmake/dependencies/common.cmake @@ -84,3 +84,4 @@ elseif(UNIX) include(${CMAKE_MODULE_PATH}/dependencies/linux.cmake) endif() endif() + diff --git a/cmake/packaging/common.cmake b/cmake/packaging/common.cmake index 0b41524f6cb..ad3f9bc0682 100644 --- a/cmake/packaging/common.cmake +++ b/cmake/packaging/common.cmake @@ -12,9 +12,14 @@ set(CPACK_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/sunshine.png) set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}") set(CPACK_STRIP_FILES YES) -# install npm modules -install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/node_modules" - DESTINATION "${SUNSHINE_ASSETS_DIR}/web") +#install common assets +install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" + DESTINATION "${SUNSHINE_ASSETS_DIR}" + PATTERN "web" EXCLUDE) + +# install built vite assets +install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/assets/web" + DESTINATION "${SUNSHINE_ASSETS_DIR}") # platform specific packaging if(WIN32) diff --git a/cmake/packaging/linux.cmake b/cmake/packaging/linux.cmake index 842277b9d27..8106345ffe8 100644 --- a/cmake/packaging/linux.cmake +++ b/cmake/packaging/linux.cmake @@ -70,11 +70,11 @@ if(${SUNSHINE_TRAY} STREQUAL 1) install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg" DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status" RENAME "sunshine-tray.svg") - install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/images/sunshine-playing.svg" + install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-playing.svg" DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status") - install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/images/sunshine-pausing.svg" + install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-pausing.svg" DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status") - install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/images/sunshine-locked.svg" + install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-locked.svg" DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status") set(CPACK_DEBIAN_PACKAGE_DEPENDS "\ diff --git a/cmake/packaging/macos.cmake b/cmake/packaging/macos.cmake index 2b173393bbf..f7c3a518c97 100644 --- a/cmake/packaging/macos.cmake +++ b/cmake/packaging/macos.cmake @@ -10,8 +10,6 @@ if(SUNSHINE_PACKAGE_MACOS) # todo set(MAC_PREFIX "${CMAKE_PROJECT_NAME}.app/Contents") set(INSTALL_RUNTIME_DIR "${MAC_PREFIX}/MacOS") - install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" - DESTINATION "${SUNSHINE_ASSETS_DIR}") install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/macos/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}") diff --git a/cmake/packaging/unix.cmake b/cmake/packaging/unix.cmake index 660811f3b33..bacbfc910de 100644 --- a/cmake/packaging/unix.cmake +++ b/cmake/packaging/unix.cmake @@ -13,6 +13,3 @@ if(NOT CMAKE_INSTALL_PREFIX) endif() install(TARGETS sunshine RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}") - -install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" - DESTINATION "${SUNSHINE_ASSETS_DIR}") diff --git a/cmake/packaging/windows.cmake b/cmake/packaging/windows.cmake index 3231d761f8c..dc2add19854 100644 --- a/cmake/packaging/windows.cmake +++ b/cmake/packaging/windows.cmake @@ -36,9 +36,6 @@ install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/misc/gamepad/" COMPONENT gamepad) # Sunshine assets -install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/" - DESTINATION "${SUNSHINE_ASSETS_DIR}" - COMPONENT assets) install(DIRECTORY "${SUNSHINE_SOURCE_ASSETS_DIR}/windows/assets/" DESTINATION "${SUNSHINE_ASSETS_DIR}" COMPONENT assets) diff --git a/cmake/targets/common.cmake b/cmake/targets/common.cmake index 72f89bf5182..7c446e466df 100644 --- a/cmake/targets/common.cmake +++ b/cmake/targets/common.cmake @@ -33,3 +33,9 @@ foreach(flag IN LISTS SUNSHINE_COMPILE_OPTIONS) endforeach() target_compile_options(sunshine PRIVATE $<$:${SUNSHINE_COMPILE_OPTIONS}>;$<$:${SUNSHINE_COMPILE_OPTIONS_CUDA};-std=c++17>) # cmake-lint: disable=C0301 + +#WebUI build +add_custom_target(web-ui ALL + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "Installing NPM Dependencies and Building the Web UI" + COMMAND bash -c \"npm install && SUNSHINE_SOURCE_ASSETS_DIR=${SUNSHINE_SOURCE_ASSETS_DIR} SUNSHINE_ASSETS_DIR=${CMAKE_BINARY_DIR} npm run build\") # cmake-lint: disable=C0301 diff --git a/docker/debian-bookworm.dockerfile b/docker/debian-bookworm.dockerfile index 1172d35a5e9..c9d4fccdede 100644 --- a/docker/debian-bookworm.dockerfile +++ b/docker/debian-bookworm.dockerfile @@ -95,9 +95,6 @@ _INSTALL_CUDA WORKDIR /build/sunshine/ COPY --link .. . -# setup npm dependencies -RUN npm install - # setup build directory WORKDIR /build/sunshine/build diff --git a/docker/debian-bullseye.dockerfile b/docker/debian-bullseye.dockerfile index 6d7ebdd30af..3e602105cb2 100644 --- a/docker/debian-bullseye.dockerfile +++ b/docker/debian-bullseye.dockerfile @@ -31,6 +31,7 @@ set -e apt-get update -y apt-get install -y --no-install-recommends \ build-essential \ + ca-certificates \ cmake=3.18.* \ git \ libavdevice-dev \ @@ -58,8 +59,6 @@ apt-get install -y --no-install-recommends \ libxfixes-dev \ libxrandr-dev \ libxtst-dev \ - nodejs \ - npm \ wget if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then apt-get install -y --no-install-recommends \ @@ -69,6 +68,17 @@ apt-get clean rm -rf /var/lib/apt/lists/* _DEPS +#Install Node +# hadolint ignore=SC1091 +RUN <<_INSTALL_NODE +#!/bin/bash +set -e +wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash +source "$HOME/.nvm/nvm.sh" +nvm install 20.9.0 +nvm use 20.9.0 +_INSTALL_NODE + # install cuda WORKDIR /build/cuda # versions: https://developer.nvidia.com/cuda-toolkit-archive @@ -95,16 +105,17 @@ _INSTALL_CUDA WORKDIR /build/sunshine/ COPY --link .. . -# setup npm dependencies -RUN npm install - # setup build directory WORKDIR /build/sunshine/build # cmake and cpack +# hadolint ignore=SC1091 RUN <<_MAKE #!/bin/bash set -e +#Set Node version +source "$HOME/.nvm/nvm.sh" +nvm use 20.9.0 cmake \ -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \ -DCMAKE_BUILD_TYPE=Release \ diff --git a/docker/fedora-38.dockerfile b/docker/fedora-38.dockerfile index 2245ba9b9aa..9f836fb889a 100644 --- a/docker/fedora-38.dockerfile +++ b/docker/fedora-38.dockerfile @@ -52,7 +52,7 @@ dnf -y install \ libXrandr-devel \ libXtst-devel \ mesa-libGL-devel \ - nodejs-npm \ + nodejs \ numactl-devel \ openssl-devel \ opus-devel \ @@ -94,9 +94,6 @@ _DEPS WORKDIR /build/sunshine/ COPY --link .. . -# setup npm dependencies -RUN npm install - # setup build directory WORKDIR /build/sunshine/build diff --git a/docker/fedora-39.dockerfile b/docker/fedora-39.dockerfile index 6c6db891bbf..26b10f4b004 100644 --- a/docker/fedora-39.dockerfile +++ b/docker/fedora-39.dockerfile @@ -52,7 +52,7 @@ dnf -y install \ libXrandr-devel \ libXtst-devel \ mesa-libGL-devel \ - nodejs-npm \ + nodejs \ numactl-devel \ openssl-devel \ opus-devel \ @@ -94,9 +94,6 @@ _DEPS WORKDIR /build/sunshine/ COPY --link .. . -# setup npm dependencies -RUN npm install - # setup build directory WORKDIR /build/sunshine/build diff --git a/docker/ubuntu-20.04.dockerfile b/docker/ubuntu-20.04.dockerfile index 5634d48e0c0..bad8285d648 100644 --- a/docker/ubuntu-20.04.dockerfile +++ b/docker/ubuntu-20.04.dockerfile @@ -31,6 +31,7 @@ set -e apt-get update -y apt-get install -y --no-install-recommends \ build-essential \ + ca-certificates \ gcc-10=10.5.* \ g++-10=10.5.* \ git \ @@ -59,8 +60,6 @@ apt-get install -y --no-install-recommends \ libxfixes-dev \ libxrandr-dev \ libxtst-dev \ - nodejs \ - npm \ wget if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then apt-get install -y --no-install-recommends \ @@ -70,6 +69,17 @@ apt-get clean rm -rf /var/lib/apt/lists/* _DEPS +#Install Node +# hadolint ignore=SC1091 +RUN <<_INSTALL_NODE +#!/bin/bash +set -e +wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash +source "$HOME/.nvm/nvm.sh" +nvm install 20.9.0 +nvm use 20.9.0 +_INSTALL_NODE + # Update gcc alias # https://stackoverflow.com/a/70653945/11214013 RUN <<_GCC_ALIAS @@ -131,16 +141,17 @@ _INSTALL_CUDA WORKDIR /build/sunshine/ COPY --link .. . -# setup npm dependencies -RUN npm install - # setup build directory WORKDIR /build/sunshine/build # cmake and cpack +# hadolint ignore=SC1091 RUN <<_MAKE #!/bin/bash set -e +#Set Node version +source "$HOME/.nvm/nvm.sh" +nvm use 20.9.0 cmake \ -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \ -DCMAKE_BUILD_TYPE=Release \ diff --git a/docker/ubuntu-22.04.dockerfile b/docker/ubuntu-22.04.dockerfile index c9c6b70db89..2f37a691bc7 100644 --- a/docker/ubuntu-22.04.dockerfile +++ b/docker/ubuntu-22.04.dockerfile @@ -32,6 +32,7 @@ apt-get update -y apt-get install -y --no-install-recommends \ build-essential \ cmake=3.22.* \ + ca-certificates \ git \ libayatana-appindicator3-dev \ libavdevice-dev \ @@ -58,8 +59,6 @@ apt-get install -y --no-install-recommends \ libxfixes-dev \ libxrandr-dev \ libxtst-dev \ - nodejs \ - npm \ wget if [[ "${TARGETPLATFORM}" == 'linux/amd64' ]]; then apt-get install -y --no-install-recommends \ @@ -69,6 +68,17 @@ apt-get clean rm -rf /var/lib/apt/lists/* _DEPS +#Install Node +# hadolint ignore=SC1091 +RUN <<_INSTALL_NODE +#!/bin/bash +set -e +wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash +source "$HOME/.nvm/nvm.sh" +nvm install 20.9.0 +nvm use 20.9.0 +_INSTALL_NODE + # install cuda WORKDIR /build/cuda # versions: https://developer.nvidia.com/cuda-toolkit-archive @@ -95,16 +105,18 @@ _INSTALL_CUDA WORKDIR /build/sunshine/ COPY --link .. . -# setup npm dependencies -RUN npm install - # setup build directory WORKDIR /build/sunshine/build # cmake and cpack +# hadolint ignore=SC1091 RUN <<_MAKE #!/bin/bash set -e +#Set Node version +source "$HOME/.nvm/nvm.sh" +nvm use 20.9.0 +#Actually build cmake \ -DCMAKE_CUDA_COMPILER:PATH=/build/cuda/bin/nvcc \ -DCMAKE_BUILD_TYPE=Release \ diff --git a/docs/source/building/linux.rst b/docs/source/building/linux.rst index 0ac90079e39..eab0aaab607 100644 --- a/docs/source/building/linux.rst +++ b/docs/source/building/linux.rst @@ -192,13 +192,6 @@ If the version of CUDA available from your distro is not adequate, manually inst ./cuda.run --silent --toolkit --toolkitpath=/usr --no-opengl-libs --no-man-page --no-drm rm ./cuda.run -npm dependencies ----------------- -Install npm dependencies. - .. code-block:: bash - - npm install - Build ----- .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. diff --git a/docs/source/building/macos.rst b/docs/source/building/macos.rst index 2d39ec17951..6bfa2c7061e 100644 --- a/docs/source/building/macos.rst +++ b/docs/source/building/macos.rst @@ -24,13 +24,6 @@ Install Requirements cd /usr/local/include ln -s ../opt/openssl/include/openssl . -npm dependencies ----------------- -Install npm dependencies. - .. code-block:: bash - - npm install - Build ----- .. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. diff --git a/docs/source/building/windows.rst b/docs/source/building/windows.rst index 623bd16a409..a8164d3cb20 100644 --- a/docs/source/building/windows.rst +++ b/docs/source/building/windows.rst @@ -16,17 +16,8 @@ Install dependencies: pacman -S base-devel cmake diffutils gcc git 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-onevpl mingw-w64-x86_64-openssl mingw-w64-x86_64-opus \ - mingw-w64-x86_64-toolchain - -npm dependencies ----------------- -Install nodejs and npm. Downloads available `here `__. - -Install npm dependencies. - .. code-block:: bash - - npm install + mingw-w64-x86_64-nodejs mingw-w64-x86_64-onevpl mingw-w64-x86_64-openssl \ + mingw-w64-x86_64-opus mingw-w64-x86_64-toolchain Build ----- diff --git a/docs/source/conf.py b/docs/source/conf.py index 3c9e338bb07..c2b66a56635 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -69,7 +69,7 @@ # -- Options for HTML output ------------------------------------------------- # images -html_favicon = os.path.join(root_dir, 'src_assets', 'common', 'assets', 'web', 'images', 'sunshine.ico') +html_favicon = os.path.join(root_dir, 'src_assets', 'common', 'assets', 'web', 'public', 'images', 'sunshine.ico') html_logo = os.path.join(root_dir, 'sunshine.png') # Add any paths that contain custom static files (such as style sheets) here, diff --git a/docs/source/contributing/contributing.rst b/docs/source/contributing/contributing.rst index a50300d2327..ab85e13deee 100644 --- a/docs/source/contributing/contributing.rst +++ b/docs/source/contributing/contributing.rst @@ -3,3 +3,23 @@ Contributing Read our contribution guide in our organization level `docs `__. + +Web UI +------ +The Web UI uses `Vite `__ as its build system, to handle the integration of the NPM libraries. + +The HTML pages used by the Web UI are found in ``src_assets/common/assets/web``. + +`EJS `__ is used as a templating system for the pages (check ``template_header.html`` and ``template_header_main.html``). + +The Style System is provided by `Bootstrap `__. + +The JS framework used by the more interactive pages is `Vue `__. + +Building +^^^^^^^^ +Sunshine already builds the UI as part of its build process, but you can make faster changes by starting vite manually. + +.. code-block:: bash + + npm run dev \ No newline at end of file diff --git a/package.json b/package.json index f5152b6a54a..8ed5b32d933 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,15 @@ { + "scripts": { + "build": "vite build --debug", + "dev": "vite build --watch" + }, "dependencies": { "@fortawesome/fontawesome-free": "6.4.2", + "@popperjs/core": "2.11.8", + "@vitejs/plugin-vue": "4.3.4", "bootstrap": "5.3.2", - "vue": "2.6.12" + "vite": "4.4.9", + "vite-plugin-ejs": "1.6.4", + "vue": "3.2.25" } } diff --git a/packaging/linux/Arch/PKGBUILD b/packaging/linux/Arch/PKGBUILD index cfd760653df..68cbecb872b 100644 --- a/packaging/linux/Arch/PKGBUILD +++ b/packaging/linux/Arch/PKGBUILD @@ -70,10 +70,6 @@ prepare() { } build() { - pushd "$pkgname" - npm install - popd - export BRANCH="@GITHUB_BRANCH@" export BUILD_VERSION="@GITHUB_BUILD_VERSION@" export COMMIT="@GITHUB_COMMIT@" diff --git a/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml b/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml index be1ae8adbf2..d4f0c164753 100644 --- a/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml +++ b/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml @@ -312,9 +312,6 @@ modules: env: npm_config_nodedir: /usr/lib/sdk/node18 NPM_CONFIG_LOGLEVEL: info - build-commands: - # Install npm dependencies - - cd ${FLATPAK_BUILDER_BUILDDIR} && npm install config-opts: - -DCMAKE_BUILD_TYPE=Release - -DCMAKE_INSTALL_PREFIX=/app diff --git a/packaging/macos/Portfile b/packaging/macos/Portfile index c22c1cb9dca..73a775a1dc5 100644 --- a/packaging/macos/Portfile +++ b/packaging/macos/Portfile @@ -55,10 +55,6 @@ platform darwin { } } -pre-build { - system -W ${worksrcpath} "npm install" -} - notes-append "Run @PROJECT_NAME@ by executing 'sunshine ', e.g. 'sunshine ~/sunshine.conf' " notes-append "The config file will be created if it doesn't exist." notes-append "It is recommended to set a location for the apps file in the config." diff --git a/scripts/icons/convert_and_pack.sh b/scripts/icons/convert_and_pack.sh index dd1183b9992..950effc98d6 100644 --- a/scripts/icons/convert_and_pack.sh +++ b/scripts/icons/convert_and_pack.sh @@ -37,9 +37,9 @@ icon_sizes=${!icon_sizes_keys[@]} echo "using icon sizes:" echo ${icon_sizes[@]} -src_vectors=("../../src_assets/common/assets/web/images/sunshine-locked.svg" - "../../src_assets/common/assets/web/images/sunshine-pausing.svg" - "../../src_assets/common/assets/web/images/sunshine-playing.svg" +src_vectors=("../../src_assets/common/assets/web/public/images/sunshine-locked.svg" + "../../src_assets/common/assets/web/public/images/sunshine-pausing.svg" + "../../src_assets/common/assets/web/public/images/sunshine-playing.svg" "../../sunshine.svg") echo "using sources vectors:" diff --git a/src/confighttp.cpp b/src/confighttp.cpp index 0de9cfb90c6..50bd87d3df4 100644 --- a/src/confighttp.cpp +++ b/src/confighttp.cpp @@ -161,11 +161,10 @@ namespace confighttp { print_req(request); - std::string header = read_file(WEB_DIR "header.html"); std::string content = read_file(WEB_DIR "index.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -174,11 +173,10 @@ namespace confighttp { print_req(request); - std::string header = read_file(WEB_DIR "header.html"); std::string content = read_file(WEB_DIR "pin.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -187,12 +185,11 @@ namespace confighttp { print_req(request); - std::string header = read_file(WEB_DIR "header.html"); std::string content = read_file(WEB_DIR "apps.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); headers.emplace("Access-Control-Allow-Origin", "https://images.igdb.com/"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -201,11 +198,10 @@ namespace confighttp { print_req(request); - std::string header = read_file(WEB_DIR "header.html"); std::string content = read_file(WEB_DIR "clients.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -214,11 +210,10 @@ namespace confighttp { print_req(request); - std::string header = read_file(WEB_DIR "header.html"); std::string content = read_file(WEB_DIR "config.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -227,11 +222,10 @@ namespace confighttp { print_req(request); - std::string header = read_file(WEB_DIR "header.html"); std::string content = read_file(WEB_DIR "password.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -241,11 +235,10 @@ namespace confighttp { send_redirect(response, request, "/"); return; } - std::string header = read_file(WEB_DIR "header-no-nav.html"); std::string content = read_file(WEB_DIR "welcome.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -254,11 +247,10 @@ namespace confighttp { print_req(request); - std::string header = read_file(WEB_DIR "header.html"); std::string content = read_file(WEB_DIR "troubleshooting.html"); SimpleWeb::CaseInsensitiveMultimap headers; headers.emplace("Content-Type", "text/html; charset=utf-8"); - response->write(header + content, headers); + response->write(content, headers); } void @@ -295,14 +287,14 @@ namespace confighttp { getNodeModules(resp_https_t response, req_https_t request) { print_req(request); fs::path webDirPath(WEB_DIR); - fs::path nodeModulesPath(webDirPath / "node_modules"); + fs::path nodeModulesPath(webDirPath / "assets"); // .relative_path is needed to shed any leading slash that might exist in the request path auto filePath = fs::weakly_canonical(webDirPath / fs::path(request->path).relative_path()); - // Don't do anything if file does not exist or is outside the node_modules directory + // Don't do anything if file does not exist or is outside the assets directory if (!isChildPath(filePath, nodeModulesPath)) { - BOOST_LOG(warning) << "Someone requested a path " << filePath << " that is outside the node_modules folder"; + BOOST_LOG(warning) << "Someone requested a path " << filePath << " that is outside the assets folder"; response->write(SimpleWeb::StatusCode::client_error_bad_request, "Bad Request"); } else if (!fs::exists(filePath)) { @@ -757,7 +749,7 @@ namespace confighttp { server.resource["^/api/covers/upload$"]["POST"] = uploadCover; server.resource["^/images/sunshine.ico$"]["GET"] = getFaviconImage; server.resource["^/images/logo-sunshine-45.png$"]["GET"] = getSunshineLogoImage; - server.resource["^/node_modules\\/.+$"]["GET"] = getNodeModules; + server.resource["^/assets\\/.+$"]["GET"] = getNodeModules; server.config.reuse_address = true; server.config.address = net::af_to_any_address_string(address_family); server.config.port = port_https; diff --git a/src_assets/common/assets/web/Navbar.vue b/src_assets/common/assets/web/Navbar.vue new file mode 100644 index 00000000000..948fb4d7244 --- /dev/null +++ b/src_assets/common/assets/web/Navbar.vue @@ -0,0 +1,60 @@ + + + + + diff --git a/src_assets/common/assets/web/ResourceCard.vue b/src_assets/common/assets/web/ResourceCard.vue new file mode 100644 index 00000000000..8bdfb5f9311 --- /dev/null +++ b/src_assets/common/assets/web/ResourceCard.vue @@ -0,0 +1,36 @@ + diff --git a/src_assets/common/assets/web/apps.html b/src_assets/common/assets/web/apps.html index bd09051d669..c9131440340 100644 --- a/src_assets/common/assets/web/apps.html +++ b/src_assets/common/assets/web/apps.html @@ -1,370 +1,383 @@ -
-
-

Applications

-
Applications are refreshed only when Client is restarted
-
-
- - - - - - - - - - - - - -
NameActions
{{app.name}} - - -
-
-
-
- -
- - -
- Application Name, as shown on Moonlight -
-
- -
- - -
- The file where the output of the command is stored, if it is not - specified, the output is ignored -
-
- -
- - -
- Enable/Disable the execution of Global Prep Commands for this - application. -
-
-
- -
- A list of commands to be run before/after this application.
- If any of the prep-commands fail, starting the application is aborted. + + + + + <%- header %> + + + + + +
+
+

Applications

+
Applications are refreshed only when Client is restarted
+
+
+ + + + + + + + + + + + + +
NameActions
{{app.name}} + + +
+
+
+
+ +
+ + +
+ Application Name, as shown on Moonlight +
-
- + +
+ + +
+ The file where the output of the command is stored, if it is not + specified, the output is ignored +
- - - - - - - - - - - - - - - - - -
Do Command Undo Command - Run as Admin -
- - - - -
- - -
- 		- - -
-
- -
- -
- 
{{c}}
- + +
+ + +
+ Enable/Disable the execution of Global Prep Commands for this + application. +
-
- - +
+ +
+ A list of commands to be run before/after this application.
+ If any of the prep-commands fail, starting the application is aborted. +
+
+ +
+ + + + + + + + + + + + + + + + + +
Do Command Undo Command + Run as Admin +
+ + + + +
+ + +
+ 		+ + +
-
- A list of commands to be run and forgotten about + +
+ +
+ + +
+
+ +
+
+ A list of commands to be run and forgotten about +
-
- -
- - -
- The main application, if it is not specified, a process is started - that sleeps indefinitely + +
+ + +
+ The main application, if it is not specified, a process is started + that sleeps indefinitely +
-
- -
- - -
- The working directory that should be passed to the process. For - example, some applications use the working directory to search for - configuration files. If not set, Sunshine will default to the parent - directory of the command + +
+ + +
+ The working directory that should be passed to the process. For + example, some applications use the working directory to search for + configuration files. If not set, Sunshine will default to the parent + directory of the command +
-
- -
- - -
- This can be necessary for some applications that require administrator - permissions to run properly. + +
+ + +
+ This can be necessary for some applications that require administrator + permissions to run properly. +
-
- -
- - -
- This will attempt to automatically detect launcher-type apps that close - quickly after launching another program or instance of themselves. When - a launcher-type app is detected, it is treated as a detached app. + +
+ + +
+ This will attempt to automatically detect launcher-type apps that close + quickly after launching another program or instance of themselves. When + a launcher-type app is detected, it is treated as a detached app. +
-
- -
- -
- - -
-
-

Covers Found

- -
-
-
-
-
- -
- -
-
- - - + diff --git a/src_assets/common/assets/web/clients.html b/src_assets/common/assets/web/clients.html deleted file mode 100644 index 5eaf56a4dfa..00000000000 --- a/src_assets/common/assets/web/clients.html +++ /dev/null @@ -1,3 +0,0 @@ -
-

Clients

-
diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 927ef945564..7d3b01cacb1 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -1,630 +1,462 @@ -
-

Configuration

-
- - - -
- -
- - -
- The name displayed by Moonlight. If not specified, the PC's hostname is used + + + + + <%- header %> + + + + + +
+

Configuration

+
+ + + +
+ +
+ + +
+ The name displayed by Moonlight. If not specified, the PC's hostname is used +
-
- -
- - -
- The minimum log level printed to standard out + +
+ + +
+ The minimum log level printed to standard out +
-
- -
- - -
- The file where the current logs of Sunshine are stored. + +
+ + +
+ The file where the current logs of Sunshine are stored. +
-
- -
- - -
- The origin of the remote endpoint address that is not denied access to Web UI + +
+ + +
+ The origin of the remote endpoint address that is not denied access to Web UI +
- -
- Exposing the Web UI to the internet is a security risk! Proceed at your own risk! + +
+ + +
Automatically configure port forwarding
-
- -
- - -
Automatically configure port forwarding
-
- -
- - -
Choose which type of gamepad to emulate on the host
-
-
-
-

- -

-
-
-
- - -
When forcing DS4 emulation, map Back/Select to Touchpad Click
+ +
+ + +
Choose which type of gamepad to emulate on the host
+
+
+
+

+ +

+
+
+
+ + +
When forcing DS4 emulation, map Back/Select to Touchpad Click
+
-
- -
- - -
- How long to wait in milliseconds for data from moonlight before shutting down the stream + +
+ + +
+ How long to wait in milliseconds for data from moonlight before shutting down the stream +
-
- -
- -
- -
-
- {{r}} - × -
-
- + +
+ +
+
+ {{r}} + × +
+ + - - -
-
-
- -
-
- {{f}} - × + " class="form-control" /> + +
-
- + +
+
+ {{f}} + × +
+ + - - + " class="form-control" /> + + +
+
+
+ The display modes advertised by Sunshine
+ Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested + resolutions and fps are supported.
+ This setting does not change how the screen stream is sent to Moonlight
-
- The display modes advertised by Sunshine
- Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested - resolutions and fps are supported.
- This setting does not change how the screen stream is sent to Moonlight -
-
- -
- - -
- It may be possible that you cannot send the Windows Key from Moonlight directly.
- In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key + +
+ + +
+ It may be possible that you cannot send the Windows Key from Moonlight directly.
+ In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key +
-
- -
- -
- Configure a list of commands to be executed before or after running any application. - If any of the specified preparation commands fail, the application launch process will be aborted. + +
+ +
+ Configure a list of commands to be executed before or after running any application. + If any of the specified preparation commands fail, the application launch process will be aborted. +
+ + + + + + + + + + + + + + + + + +
Do Command Undo Command + Run as Admin +
+ + + + +
+ + +
+ 		+ + +
+
- - - - - - - - - - - - - - - - - -
Do Command Undo Command - Run as Admin -
- - - - -
- - -
- 		- - -
-
-
- -
- -
- - -
- The private key used for the web UI and Moonlight client pairing. For best compatibility, this should be an RSA-2048 private key. + +
+ +
+ + +
The private key used for the web UI and Moonlight client pairing. For best + compatibility, this should be an RSA-2048 private key.
-
- -
- - -
- The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have an RSA-2048 public key. + +
+ + +
+ The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have + an RSA-2048 public key. +
-
- -
- - -
- The file where current state of Sunshine is stored + +
+ + +
+ The file where current state of Sunshine is stored +
-
- -
- - -
- The file where current apps of Sunshine are stored + +
+ + +
+ The file where current apps of Sunshine are stored +
-
-
- -
- - -
- If the Back/Select button is held down for the specified number of milliseconds, a Home/Guide button press is emulated.
- If set to a value < 0 (default), holding the Back/Select button will not emulate the Home/Guide button.
+
+ +
+ + +
+ If the Back/Select button is held down for the specified number of milliseconds, a Home/Guide button press + is + emulated.
+ If set to a value < 0 (default), holding the Back/Select button will not emulate the Home/Guide + button.
+
-
- -
- - -
- Allows guests to control the host system with the mouse + +
+ + +
+ Allows guests to control the host system with the mouse +
-
- -
- - -
- Allows guests to control the host system with the keyboard + +
+ + +
+ Allows guests to control the host system with the keyboard +
-
- -
- - -
- Allows guests to control the host system with a gamepad / controller + +
+ + +
+ Allows guests to control the host system with a gamepad / controller +
-
- -
- - -
- Control how fast keys will repeat themselves
- The initial delay in milliseconds before repeating keys + +
+ + +
+ Control how fast keys will repeat themselves
+ The initial delay in milliseconds before repeating keys +
-
- -
- - -
- How often keys repeat every second
- This configurable option supports decimals + +
+ + +
+ How often keys repeat every second
+ This configurable option supports decimals +
-
- -
- - -
- Sending scancodes enhances compatibility with games and apps - but may result in incorrect keyboard input from certain clients - that aren't using a US English keyboard layout.
- Enable if keyboard input is not working at all in certain applications.
- Disable if keys on the client are generating the wrong input on the host. + +
+ + +
+ Sending scancodes enhances compatibility with games and apps + but may result in incorrect keyboard input from certain clients + that aren't using a US English keyboard layout.
+ Enable if keyboard input is not working at all in certain applications.
+ Disable if keys on the client are generating the wrong input on the host. +
-
- -
- -
- - -
- Manually specify a specific audio device to capture. If unset, the device is chosen automatically.
- We strongly recommend leaving this field blank to use automatic device selection!
- If you have multiple audio devices with identical names, you can get the Device ID using the following command:
- 
tools\audio-info.exe
+ +
+ +
+ + +
+ Manually specify a specific audio device to capture. If unset, the device is chosen automatically.
+ We strongly recommend leaving this field blank to use automatic device selection!
+ If you have multiple audio devices with identical names, you can get the Device ID using the following + command:
+ 
tools\audio-info.exe
+
-
-
- - -
- The name of the audio sink used for Audio Loopback
- If you do not specify this variable, pulseaudio will select the default monitor device.
-
- You can find the name of the audio sink using either command:
- 
pacmd list-sinks | grep "name:"
- 
pactl info | grep Source
-
+
+ + +
+ The name of the audio sink used for Audio Loopback
+ If you do not specify this variable, pulseaudio will select the default monitor device.
+
+ You can find the name of the audio sink using either command:
+ 
pacmd list-sinks | grep "name:"
+ 
pactl info | grep Source
+
+
-
-
- - -
- The name of the audio sink used for Audio Loopback
- Sunshine can only access microphones on macOS due to system limitations.
- To stream system audio using - Soundflower - or - BlackHole - . +
+ + +
+ The name of the audio sink used for Audio Loopback
+ Sunshine can only access microphones on macOS due to system limitations.
+ To stream system audio using + Soundflower + or + BlackHole + . +
-
- -
- - -
- Manually specify a virtual audio device to use. If unset, the device is chosen automatically.
- We strongly recommend leaving this field blank to use automatic device selection!
+ +
+ + +
+ Manually specify a virtual audio device to use. If unset, the device is chosen automatically.
+ We strongly recommend leaving this field blank to use automatic device selection!
+
-
- -
- - -
- If Steam is installed, this will automatically install the Steam Streaming Speakers driver to support - 5.1/7.1 surround sound and muting host audio. + +
+ + +
+ If Steam is installed, this will automatically install the Steam Streaming Speakers driver to support + 5.1/7.1 surround sound and muting host audio. +
-
- -
- - -
- Manually specify a GPU to use for capture. If unset, the GPU is chosen automatically.
- We strongly recommend leaving this field blank to use automatic GPU selection!
- Note: This GPU must have a display connected and powered on.
- The appropriate values can be found using the following command:
- 
tools\dxgi-info.exe
+ +
+ + +
+ Manually specify a GPU to use for capture. If unset, the GPU is chosen automatically.
+ We strongly recommend leaving this field blank to use automatic GPU selection!
+ Note: This GPU must have a display connected and powered on.
+ The appropriate values can be found using the following command:
+ 
tools\dxgi-info.exe
+
-
- -
- - -
- Manually specify a display to use for capture. If unset, the primary display is captured.
- Note: If you specified a GPU above, this display must be connected to that GPU.
- The appropriate values can be found using the following command:
- tools\dxgi-info.exe
+ +
+ + +
+ Manually specify a display to use for capture. If unset, the primary display is captured.
+ Note: If you specified a GPU above, this display must be connected to that GPU.
+ The appropriate values can be found using the following command:
+ tools\dxgi-info.exe
+
-
-
- - -
- During Sunshine startup, you should see the list of detected monitors, e.g.:
-
- 
+        

+          
+          
+          

+            During Sunshine startup, you should see the list of detected monitors, e.g.:

+            

+            
             Info: Detecting connected monitors
             Info: Detected monitor 0: DVI-D-0, connected: false
             Info: Detected monitor 1: HDMI-0, connected: true
@@ -632,522 +464,348 @@ 

             Info: Detected monitor 3: DP-1, connected: false
             Info: Detected monitor 4: DVI-D-1, connected: false
           

-          You need to use the value before the colon in the output, e.g. 1.
+            You need to use the value before the colon in the output, e.g. 1.
+
-
-
- -
- - -
Set the address family used by Sunshine
-
- -
- - -
Set the family of ports used by Sunshine
- -
- Sunshine cannot use ports below 1024! +
+ +
+ + +
Set the address family used by Sunshine
- -
- Ports above 65535 are not available! + +
+ + +
Set the family of ports used by Sunshine
+ +
+ Sunshine cannot use ports below 1024! +
+ +
+ Ports above 65535 are not available! +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ProtocolPortNote
TCP{{+effectivePort - 5}}
TCP{{+effectivePort}} + +
TCP{{+effectivePort + 1}}Web UI
TCP{{+effectivePort + 21}}
UDP{{+effectivePort + 9}} - {{+effectivePort + 11}}
+ +
+ Exposing the Web UI to the internet is a security + risk! + Proceed at your own risk! +
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ProtocolPortNote
TCP{{+effectivePort - 5}}
TCP{{+effectivePort}} - -
TCP{{+effectivePort + 1}}Web UI
TCP{{+effectivePort + 21}}
UDP{{+effectivePort + 9}} - {{+effectivePort + 11}}
- -
- Exposing the Web UI to the internet is a security risk! - Proceed at your own risk! + +
+ + +
+ Quantization Parameter
+ Some devices may not support Constant Bit Rate.
+ For those devices, QP is used instead.
+ Higher value means more compression, but less quality
+
- -
- - -
- Quantization Parameter
- Some devices may not support Constant Bit Rate.
- For those devices, QP is used instead.
- Higher value means more compression, but less quality
+ +
+
+ + +
+ Optimize the trade-off between encoding speed (encoded frames per second) and compression efficiency + (quality + per bit in the bitstream). Defaults to superfast. +
-
- -
- - -
- Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually
- worth it to gain the use of more CPU cores for encoding. The ideal value is the lowest
- value that can reliably encode at your desired streaming settings on your hardware. +
+ + +
+ Tuning options, which are applied after the preset. Defaults to zerolatency. +
- -
- - -
- Allows the client to request HEVC Main or HEVC Main10 video streams.
- HEVC is more CPU-intensive to encode, so enabling this may reduce performance when using software encoding. + +
+ +
+ + +
Higher numbers improve compression (quality at given bitrate) at the cost of + increased encoding latency.
+ Recommended to change only when limited by network or decoder, otherwise similar effect can be + accomplished + by + increasing bitrate. +
-
- -
- - -
- Allows the client to request AV1 Main 8-bit or 10-bit video streams.
- AV1 is more CPU-intensive to encode, so enabling this may reduce performance when using software encoding. +
+ + +
Adds preliminary encoding pass.
+ This allows to detect more motion vectors, better distribute bitrate across the frame and more strictly + adhere + to + bitrate limits.
+ Disabling it is not recommended since this can lead to occasional bitrate overshoot and subsequent packet + loss. +
-
- -
- - -
- Force a specific capture method, otherwise Sunshine will use the first one that works. NvFBC requires patched nvidia drivers. +
+
+

+ +

+
+
+
+ + +
Currently NVIDIA drivers may freeze in encoder when + HAGS + is enabled, realtime priority is used and VRAM utilization is close to maximum.
+ Disabling this option lowers the priority to high, sidestepping the freeze at the cost of reduced + capture + performance when the GPU is heavily loaded. +
+
+
+ + +
Simpler form of entropy coding.
+ CAVLC needs around 10% more bitrate for same quality.
+ Only relevant for really old decoding devices. +
+
+
+
+
- -
- - -
- Force a specific encoder, otherwise Sunshine will use the first encoder that is available
- Note: If you specify a hardware encoder on Windows, it must match the GPU where the display is connected. + +
+
+ +
-
- -
- - -
- Percentage of error correcting packets per data packet in each video frame.
- Higher values can correct for more network packet loss, but at the cost of increasing bandwidth usage.
- The default value of 20 is what GeForce Experience uses. +
+ +
- -
- - -
- When multicasting, it could be useful to have different configurations for each connected Client. For example: -
    -
  • - Clients connected through WAN and LAN have different bitrate constraints. -
    • -
  • - Decoders may require different settings for color -
    • -
- Unlike simply broadcasting to multiple Client, this will generate distinct video streams.
- Note, CPU usage increases for each distinct video stream generated + +
+ +
+ +
-
- -
- - -
- Store Username/Password separately from Sunshine's state file. +
+ +
-
- -
- - -
- If no external IP address is given, Sunshine will automatically detect external IP +
+ +
-
-
- -
-
- - -
- Optimize the trade-off between encoding speed (encoded frames per second) and compression efficiency (quality per bit in the bitstream). Defaults to superfast. +
+ +
-
-
- - -
- Tuning options, which are applied after the preset. Defaults to zerolatency. +
+ +
-
-
- -
- -
- - -
Higher numbers improve compression (quality at given bitrate) at the cost of - increased encoding latency.
- Recommended to change only when limited by network or decoder, otherwise similar effect can be accomplished by - increasing bitrate. +
+ +
-
- - -
Adds preliminary encoding pass.
- This allows to detect more motion vectors, better distribute bitrate across the frame and more strictly adhere to - bitrate limits.
- Disabling it is not recommended since this can lead to occasional bitrate overshoot and subsequent packet loss. -
+ +
+
-
-
-

- -

-
-
-
- - -
Currently NVIDIA drivers may freeze in encoder when - HAGS - is enabled, realtime priority is used and VRAM utilization is close to maximum.
- Disabling this option lowers the priority to high, sidestepping the freeze at the cost of reduced capture - performance when the GPU is heavily loaded. -
-
-
- - -
Simpler form of entropy coding.
- CAVLC needs around 10% more bitrate for same quality.
- Only relevant for really old decoding devices. -
-
-
-
+ +
+ +
+ + +
+
+ + +
+
+ +
- -
-
- - -
-
- - -
-
- -
- -
- - -
-
- - -
-
- - -
-
- - -
-
- - -
-
- - -
+
+ Success! Click 'Apply' to restart Sunshine and apply changes. This will terminate any running sessions.
- -
- +
+ Success! Sunshine is restarting to apply changes.
- -
- -
- - -
-
- - -
-
- - -
+
+ +
-
- Click 'Apply' to restart Sunshine and apply changes. - This will terminate any running sessions. -
-
- Sunshine is restarting to apply changes. -
-
- - -
-
+ + - - + app.mount("#app"); + diff --git a/src_assets/common/assets/web/header-no-nav.html b/src_assets/common/assets/web/header-no-nav.html deleted file mode 100644 index 28ef76defe5..00000000000 --- a/src_assets/common/assets/web/header-no-nav.html +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - Sunshine - - - - - - - diff --git a/src_assets/common/assets/web/header.html b/src_assets/common/assets/web/header.html deleted file mode 100644 index cf93a0c2333..00000000000 --- a/src_assets/common/assets/web/header.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - Sunshine - - - - - - - - - - - - - - - - - - diff --git a/src_assets/common/assets/web/index.html b/src_assets/common/assets/web/index.html index 2fe713e63e8..3efd27f165b 100644 --- a/src_assets/common/assets/web/index.html +++ b/src_assets/common/assets/web/index.html @@ -1,93 +1,81 @@ -
-

Hello, Sunshine!

-

Sunshine is a self-hosted game stream host for Moonlight.

-
-
- - Attention! Sunshine detected these errors during startup. These errors MUST be fixed before using - Sunshine.
-
-
    -
  • {{v.value}}
    • -
-
- -
-
-

Version {{version}}

-
-
- Loading Latest Release... -
-
- Thank you for helping to make Sunshine a better software! 🌇 + + + + + <%- header %> + + + + +
+

Hello, Sunshine!

+

Sunshine is a self-hosted game stream host for Moonlight.

+
+
+ + Attention! Sunshine detected these errors during startup. These errors MUST be fixed before using + Sunshine.
-
-
- You're running the latest version of Sunshine +
    +
  • {{v.value}}
    • +
+
+ +
+
+

Version {{version}}

+
+
+ Loading Latest Release...
-
-
-
-
-
A new Nightly Version is Available!
- Download +
+ Thank you for helping to make Sunshine a better software! 🌇 +
+
+
+ You're running the latest version of Sunshine
- 
{{nightlyData.head_sha}}
- 
{{nightlyData.display_title}}
-
-
-
-
-
A new Stable Version is Available!
- Download +
+
+
+
A new Nightly Version is Available!
+ Download +
+ 
{{nightlyData.head_sha}}
+ 
{{nightlyData.display_title}}
+
+
+
+
+
+
A new Stable Version is Available!
+ Download +
+

{{githubVersion.name}}

+ 
{{githubVersion.body}}
-

{{githubVersion.name}}

- 
{{githubVersion.body}}
-
- -
-
-

Resources

-
-

- Resources for Sunshine! -

-
- LizardByte Website - - Discord - - Github Discussions -
-
-
- -
-
-

Legal

-
-

- By continuing to use this software you agree to the terms and conditions in the following documents. -

-
- - License - - Third Party Notice -
+ +
+
-
+ - diff --git a/src_assets/common/assets/web/password.html b/src_assets/common/assets/web/password.html index 6ad76d5e748..2480c22fd99 100644 --- a/src_assets/common/assets/web/password.html +++ b/src_assets/common/assets/web/password.html @@ -1,85 +1,81 @@ -
-

Password Change

-
-
-
-

Current Credentials

-
- - -
 
-
-
- - -
-
-
-

New Credentials

-
- - -
- If not specified, the username will not change + + + + + <%- header %> + + + + + +
+

Password Change

+ +
+
+

Current Credentials

+
+ + +
 
+
+
+ +
-
- - -
-
- - +
+

New Credentials

+
+ + +
+ If not specified, the username will not change +
+
+
+ + +
+
+ + +
-
-
Error: {{error}}
-
- Success! This page will reload soon, your browser will ask you for - the new credentials -
-
- -
- -
+
Error: {{error}}
+
+ Success! This page will reload soon, your browser will ask you for + the new credentials +
+
+ +
+ +
+ + - + app.mount("#app"); + diff --git a/src_assets/common/assets/web/pin.html b/src_assets/common/assets/web/pin.html index 12911a4e08d..492ddd8a2cb 100644 --- a/src_assets/common/assets/web/pin.html +++ b/src_assets/common/assets/web/pin.html @@ -1,25 +1,39 @@ -
-

PIN Pairing

-
-
- - -
-
- Warning! Make sure you have access to the client you are pairing - with.
- This software can give total control to your computer, so be careful! -
-
-
-
+ + - diff --git a/src_assets/common/assets/web/troubleshooting.html b/src_assets/common/assets/web/troubleshooting.html index 0ada5a8ae33..58fcb395410 100644 --- a/src_assets/common/assets/web/troubleshooting.html +++ b/src_assets/common/assets/web/troubleshooting.html @@ -1,190 +1,209 @@ -
-

Troubleshooting

- -
-
-

Force Close

-
-

- If Moonlight complains about an app currently running, force closing the - app should fix the issue. -

-
- Application Closed Successfully! -
-
- Error while closing Application -
-
- + + + + + <%- header %> + + + + + +
+

Troubleshooting

+ +
+
+

Force Close

+
+

+ If Moonlight complains about an app currently running, force closing the + app should fix the issue. +

+
+ Application Closed Successfully! +
+
+ Error while closing Application +
+
+ +
-
- -
-
-

Restart Sunshine

-
-

- If Sunshine isn't working properly, you can try restarting it. - This will terminate any running sessions. -

-
- Sunshine is restarting -
-
- + +
+
+

Restart Sunshine

+
+

+ If Sunshine isn't working properly, you can try restarting it. + This will terminate any running sessions. +

+
+ Sunshine is restarting +
+
+ +
-
- -
-
-

Unpair All Clients

-
-

Remove all your paired devices

-
- Unpair Successful! -
-
- Error while unpairing -
-
- + +
+
+

Unpair All Clients

+
+

Remove all your paired devices

+
+ Unpair Successful! +
+
+ Error while unpairing +
+
+ +
-
- -
-
-

Logs

-
-
-

See the logs uploaded by Sunshine

- -
-
-
- {{actualLogs}} + +
+
+

Logs

+
+
+

See the logs uploaded by Sunshine

+ +
+
+
+ {{actualLogs}} +
-
- + }); - + diff --git a/src_assets/common/assets/web/welcome.html b/src_assets/common/assets/web/welcome.html index 8b728609c7e..348ca96c46b 100644 --- a/src_assets/common/assets/web/welcome.html +++ b/src_assets/common/assets/web/welcome.html @@ -1,67 +1,67 @@ -
-
-

Welcome to Sunshine!

-

- Before Getting Started, we need you to make a new username and password for accessing the Web UI. -

-
-
- The credentials below are needed to access Sunshine's Web UI.
- Keep them safe, since you will never see them again! -
-
-
- - -
-
- - -
-
- - -
- -
Error: {{error}}
-
- Success! This page will reload soon, your browser will ask you for - the new credentials + + + + + <%- header %> + + + +
+
+
+
+

+ + Welcome to Sunshine! +

+
+

+ Before Getting Started, we need you to make a new username and password for accessing the Web UI. +

+
+ The credentials below are needed to access Sunshine's Web UI.
+ Keep them safe, since you will never see them again! +
+ +
+ + +
+
+ + +
+
+ + +
+ +
Error: {{error}}
+
+ Success! This page will reload soon, your browser will ask you for + the new credentials +
+ +
+
+ +
- -
+
+ - diff --git a/vite.config.js b/vite.config.js new file mode 100644 index 00000000000..a41470e4bf5 --- /dev/null +++ b/vite.config.js @@ -0,0 +1,53 @@ +import { fileURLToPath, URL } from 'node:url' +import fs from 'fs'; +import { resolve } from 'path' +import { defineConfig } from 'vite' +import { ViteEjsPlugin } from "vite-plugin-ejs"; +import vue from '@vitejs/plugin-vue' +import process from 'process' + +/** + * Before actually building the pages with Vite, we do an intermediate build step using ejs + * Importing this separately and joining them using ejs + * allows us to split some repeating HTML that cannot be added + * by Vue itself (e.g. style/script loading, common meta head tags, Widgetbot) + * The vite-plugin-ejs handles this automatically + */ +let assetsSrcPath = 'src_assets/common/assets/web'; +let assetsDstPath = 'build/assets/web'; + +if (process.env.SUNSHINE_SOURCE_ASSETS_DIR) { + console.log("Using srcdir from Cmake: " + resolve(process.env.SUNSHINE_SOURCE_ASSETS_DIR,"common/assets/web")); + assetsSrcPath = resolve(process.env.SUNSHINE_SOURCE_ASSETS_DIR,"common/assets/web") +} +if (process.env.SUNSHINE_ASSETS_DIR) { + console.log("Using destdir from Cmake: " + resolve(process.env.SUNSHINE_ASSETS_DIR,"assets/web")); + assetsDstPath = resolve(process.env.SUNSHINE_ASSETS_DIR,"assets/web") +} + +let header = fs.readFileSync(resolve(assetsSrcPath, "template_header.html")) + +// https://vitejs.dev/config/ +export default defineConfig({ + resolve: { + alias: { + vue: 'vue/dist/vue.esm-bundler.js' + } + }, + plugins: [vue(), ViteEjsPlugin({ header })], + root: resolve(assetsSrcPath), + build: { + outDir: resolve(assetsDstPath), + rollupOptions: { + input: { + apps: resolve(assetsSrcPath, 'apps.html'), + config: resolve(assetsSrcPath, 'config.html'), + index: resolve(assetsSrcPath, 'index.html'), + password: resolve(assetsSrcPath, 'password.html'), + pin: resolve(assetsSrcPath, 'pin.html'), + troubleshooting: resolve(assetsSrcPath, 'troubleshooting.html'), + welcome: resolve(assetsSrcPath, 'welcome.html'), + }, + }, + }, +}) From 96e7443cab4f3226be078696aec8477d4e9003e8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 27 Dec 2023 20:27:06 -0500 Subject: [PATCH 033/197] build(deps): bump @fortawesome/fontawesome-free from 6.4.2 to 6.5.1 (#1876) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 8ed5b32d933..738fd70d144 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "dev": "vite build --watch" }, "dependencies": { - "@fortawesome/fontawesome-free": "6.4.2", + "@fortawesome/fontawesome-free": "6.5.1", "@popperjs/core": "2.11.8", "@vitejs/plugin-vue": "4.3.4", "bootstrap": "5.3.2", From 0e479bd47628aac3d8c261c502cdd1579fbf301e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 28 Dec 2023 10:45:31 -0500 Subject: [PATCH 034/197] build(deps): bump third-party/wayland-protocols from `d70af2e` to `46f201b` (#1943) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- third-party/wayland-protocols | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/wayland-protocols b/third-party/wayland-protocols index d70af2ea1e9..46f201bd7b3 160000 --- a/third-party/wayland-protocols +++ b/third-party/wayland-protocols @@ -1 +1 @@ -Subproject commit d70af2ea1e9892f16ec5d25fd04e36826b7e3aef +Subproject commit 46f201bd7b328ab5ac531231c030ca5c4090b1da From c27725c73b11ac60b09a7c2a73cb862355d260e1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 28 Dec 2023 11:28:55 -0500 Subject: [PATCH 035/197] build(deps): bump babel from 2.13.0 to 2.14.0 (#1912) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- scripts/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 4cb6e551faf..c65a1d30930 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1 +1 @@ -Babel==2.13.0 +Babel==2.14.0 From b215fe0cd9651354de757fc0b4a4c3e354c6de00 Mon Sep 17 00:00:00 2001 From: jensaymoo <45825226+jensaymoo@users.noreply.github.com> Date: Fri, 29 Dec 2023 04:06:54 +0300 Subject: [PATCH 036/197] fix: ensure user supplied framerates are used (#1548) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> --- src/config.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/config.cpp b/src/config.cpp index c08f5a9c4eb..74bb612137c 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -836,6 +836,10 @@ namespace config { std::vector list; list_string_f(vars, name, list); + // The framerate list must be cleared before adding values from the file configuration. + // If the list is not cleared, then the specified parameters do not affect the behavior of the sunshine server. + // That is, if you set only 30 fps in the configuration file, it will not work because by default, during initialization the list includes 10, 30, 60, 90 and 120 fps. + input.clear(); for (auto &el : list) { std::string_view val = el; From 1540f2cd5289628d17637e7b73db8776f37e4d12 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 29 Dec 2023 01:07:30 +0000 Subject: [PATCH 037/197] build(deps): bump third-party/moonlight-common-c Bumps [third-party/moonlight-common-c](https://github.com/moonlight-stream/moonlight-common-c) from `f78f213` to `6e9ed87`. - [Commits](https://github.com/moonlight-stream/moonlight-common-c/compare/f78f2135fa49e19855c2028b6865657d42d511f1...6e9ed871bc3e013386c775b2ee7d31deb1151068) --- updated-dependencies: - dependency-name: third-party/moonlight-common-c dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- third-party/moonlight-common-c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/moonlight-common-c b/third-party/moonlight-common-c index f78f2135fa4..6e9ed871bc3 160000 --- a/third-party/moonlight-common-c +++ b/third-party/moonlight-common-c @@ -1 +1 @@ -Subproject commit f78f2135fa49e19855c2028b6865657d42d511f1 +Subproject commit 6e9ed871bc3e013386c775b2ee7d31deb1151068 From eca26e664bd3b35bb44a45b701d04bd5457888d3 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Fri, 29 Dec 2023 21:18:47 -0600 Subject: [PATCH 038/197] Make wording about fatal errors a little less strong Some "fatal" errors might be expected for some esoteric configurations. --- src_assets/common/assets/web/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src_assets/common/assets/web/index.html b/src_assets/common/assets/web/index.html index 3efd27f165b..5cff0873944 100644 --- a/src_assets/common/assets/web/index.html +++ b/src_assets/common/assets/web/index.html @@ -13,8 +13,8 @@

Hello, Sunshine!

- Attention! Sunshine detected these errors during startup. These errors MUST be fixed before using - Sunshine.
+ Attention! Sunshine detected these errors during startup. We STRONGLY RECOMMEND fixing them + before streaming.
  • {{v.value}}
    • From 0d7811ad431baafb58cca2e1cb16598ae1de9183 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Fri, 29 Dec 2023 21:20:13 -0600 Subject: [PATCH 039/197] Demote FFmpeg fatal errors Fixes #1849 --- src/main.cpp | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/main.cpp b/src/main.cpp index 6cd3545ef4f..45febf7025b 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -517,10 +517,9 @@ main(int argc, char *argv[]) { char buffer[1024]; av_log_format_line(ptr, level, fmt, vl, buffer, sizeof(buffer), &print_prefix); - if (level <= AV_LOG_FATAL) { - BOOST_LOG(fatal) << buffer; - } - else if (level <= AV_LOG_ERROR) { + if (level <= AV_LOG_ERROR) { + // We print AV_LOG_FATAL at the error level. FFmpeg prints things as fatal that + // are expected in some cases, such as lack of codec support or similar things. BOOST_LOG(error) << buffer; } else if (level <= AV_LOG_WARNING) { From 11d472362cb1f5896c8a2d3de4b2184a2f0a37ad Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Fri, 29 Dec 2023 21:21:06 -0600 Subject: [PATCH 040/197] Print a fatal warning for lack of ViGEmBus While this is not technically fatal, it's almost certainly not what the user wants. --- src/platform/windows/input.cpp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/platform/windows/input.cpp b/src/platform/windows/input.cpp index 29dd758acc1..ab4d7262417 100644 --- a/src/platform/windows/input.cpp +++ b/src/platform/windows/input.cpp @@ -200,6 +200,8 @@ namespace platf { if (!VIGEM_SUCCESS(status)) { BOOST_LOG(warning) << "Couldn't setup connection to ViGEm for gamepad support ["sv << util::hex(status).to_string_view() << ']'; + // Log a special fatal message for this case to show the error in the web UI + BOOST_LOG(fatal) << "ViGEmBus is not installed or running. You must install ViGEmBus for gamepad support!"sv; return -1; } From a9f2679a491d6e73aa7ee361159d3963b1be35b3 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Thu, 28 Dec 2023 18:38:00 -0600 Subject: [PATCH 041/197] Implement new protocol extension to match client connections together Fixes #1804 Fixes #1862 Fixes #1852 --- src/nvhttp.cpp | 6 + src/rtsp.cpp | 30 ++++- src/rtsp.h | 3 + src/stream.cpp | 295 ++++++++++++++++++++++++------------------------- src/stream.h | 5 +- 5 files changed, 182 insertions(+), 157 deletions(-) diff --git a/src/nvhttp.cpp b/src/nvhttp.cpp index fa7847c3fde..ea4f3c82ddf 100644 --- a/src/nvhttp.cpp +++ b/src/nvhttp.cpp @@ -290,6 +290,12 @@ namespace nvhttp { launch_session.gcmap = util::from_view(get_arg(args, "gcmap", "0")); launch_session.enable_hdr = util::from_view(get_arg(args, "hdrMode", "0")); + // Generate the unique identifiers for this connection that we will send later during RTSP handshake + unsigned char raw_payload[8]; + RAND_bytes(raw_payload, sizeof(raw_payload)); + launch_session.av_ping_payload = util::hex_vec(raw_payload); + RAND_bytes((unsigned char *) &launch_session.control_connect_data, sizeof(launch_session.control_connect_data)); + uint32_t prepend_iv = util::endian::big(util::from_view(get_arg(args, "rikeyid"))); auto prepend_iv_p = (uint8_t *) &prepend_iv; diff --git a/src/rtsp.cpp b/src/rtsp.cpp index 9aa3ea1c220..7a5a532e836 100644 --- a/src/rtsp.cpp +++ b/src/rtsp.cpp @@ -563,17 +563,26 @@ namespace rtsp_stream { void cmd_setup(rtsp_server_t *server, tcp::socket &sock, msg_t &&req) { - OPTION_ITEM options[3] {}; + OPTION_ITEM options[4] {}; auto &seqn = options[0]; auto &session_option = options[1]; auto &port_option = options[2]; + auto &payload_option = options[3]; seqn.option = const_cast("CSeq"); auto seqn_str = std::to_string(req->sequenceNumber); seqn.content = const_cast(seqn_str.c_str()); + if (!server->launch_event.peek()) { + // /launch has not been used + + respond(sock, &seqn, 503, "Service Unavailable", req->sequenceNumber, {}); + return; + } + auto launch_session { server->launch_event.view() }; + std::string_view target { req->message.request.target }; auto begin = std::find(std::begin(target), std::end(target), '=') + 1; auto end = std::find(begin, std::end(target), '/'); @@ -608,6 +617,19 @@ namespace rtsp_stream { port_option.option = const_cast("Transport"); port_option.content = port_value.data(); + // Send identifiers that will be echoed in the other connections + auto connect_data = std::to_string(launch_session->control_connect_data); + if (type == "control"sv) { + payload_option.option = const_cast("X-SS-Connect-Data"); + payload_option.content = connect_data.data(); + } + else { + payload_option.option = const_cast("X-SS-Ping-Payload"); + payload_option.content = launch_session->av_ping_payload.data(); + } + + port_option.next = &payload_option; + respond(sock, &seqn, 200, "OK", req->sequenceNumber, {}); } @@ -679,6 +701,7 @@ namespace rtsp_stream { args.try_emplace("x-nv-general.useReliableUdp"sv, "1"sv); args.try_emplace("x-nv-vqos[0].fec.minRequiredFecPackets"sv, "0"sv); args.try_emplace("x-nv-general.featureFlags"sv, "135"sv); + args.try_emplace("x-ml-general.featureFlags"sv, "0"sv); args.try_emplace("x-nv-vqos[0].qosTrafficType"sv, "5"sv); args.try_emplace("x-nv-aqos.qosTrafficType"sv, "4"sv); @@ -696,7 +719,8 @@ namespace rtsp_stream { config.controlProtocolType = util::from_view(args.at("x-nv-general.useReliableUdp"sv)); config.packetsize = util::from_view(args.at("x-nv-video[0].packetSize"sv)); config.minRequiredFecPackets = util::from_view(args.at("x-nv-vqos[0].fec.minRequiredFecPackets"sv)); - config.featureFlags = util::from_view(args.at("x-nv-general.featureFlags"sv)); + config.nvFeatureFlags = util::from_view(args.at("x-nv-general.featureFlags"sv)); + config.mlFeatureFlags = util::from_view(args.at("x-ml-general.featureFlags"sv)); config.audioQosType = util::from_view(args.at("x-nv-aqos.qosTrafficType"sv)); config.videoQosType = util::from_view(args.at("x-nv-vqos[0].qosTrafficType"sv)); @@ -742,7 +766,7 @@ namespace rtsp_stream { return; } - auto session = stream::session::alloc(config, launch_session->gcm_key, launch_session->iv); + auto session = stream::session::alloc(config, launch_session->gcm_key, launch_session->iv, launch_session->av_ping_payload, launch_session->control_connect_data); auto slot = server->accept(session); if (!slot) { diff --git a/src/rtsp.h b/src/rtsp.h index 4d426070c2c..3cdd5c7c5ea 100644 --- a/src/rtsp.h +++ b/src/rtsp.h @@ -16,6 +16,9 @@ namespace rtsp_stream { crypto::aes_t gcm_key; crypto::aes_t iv; + std::string av_ping_payload; + uint32_t control_connect_data; + bool host_audio; std::string unique_id; int width; diff --git a/src/stream.cpp b/src/stream.cpp index c212b255f8c..54bed0ab179 100644 --- a/src/stream.cpp +++ b/src/stream.cpp @@ -13,8 +13,7 @@ #include extern "C" { -#include -#include +#include #include } @@ -229,8 +228,9 @@ namespace stream { using audio_fec_packet_t = util::c_ptr; using audio_aes_t = std::array; - using message_queue_t = std::shared_ptr>>; - using message_queue_queue_t = std::shared_ptr>>; + using av_session_id_t = std::variant; // IP address or SS-Ping-Payload from RTSP handshake + using message_queue_t = std::shared_ptr>>; + using message_queue_queue_t = std::shared_ptr>>; // return bytes written on success // return -1 on error @@ -264,18 +264,11 @@ namespace stream { return !(bool) _host; } - void - emplace_addr_to_session(const std::string &addr, session_t &session) { - auto lg = _map_addr_session.lock(); - - _map_addr_session->emplace(addr, std::make_pair(0u, &session)); - } - // Get session associated with address. // If none are found, try to find a session not yet claimed. (It will be marked by a port of value 0 // If none of those are found, return nullptr session_t * - get_session(const net::peer_t peer); + get_session(const net::peer_t peer, uint32_t connect_data); // Circular dependency: // iterate refers to session @@ -313,8 +306,11 @@ namespace stream { // Callbacks std::unordered_map> _map_type_cb; - // Mapping ip:port to session - sync_util::sync_t>> _map_addr_session; + // All active sessions (including those still waiting for a peer to connect) + sync_util::sync_t> _sessions; + + // ENet peer to session mapping for sessions with a peer connected + sync_util::sync_t> _peer_to_session; ENetAddress _addr; net::host_t _host; @@ -333,12 +329,6 @@ namespace stream { udp::socket video_sock { io }; udp::socket audio_sock { io }; - // This is purely for administrative purposes. - // It's possible two instances of Moonlight are behind a NAT. - // From Sunshine's point of view, the ip addresses are identical - // We need some way to know what ports are already used for different streams - sync_util::sync_t>> audio_video_connections; - control_server_t control_server; }; @@ -359,15 +349,20 @@ namespace stream { boost::asio::ip::address localAddress; struct { + std::string ping_payload; + int lowseq; udp::endpoint peer; + safe::mail_raw_t::event_t idr_events; safe::mail_raw_t::event_t> invalidate_ref_frames_events; + std::unique_ptr qos; } video; struct { crypto::cipher::cbc_t cipher; + std::string ping_payload; std::uint16_t sequenceNumber; // avRiKeyId == util::endian::big(First (sizeof(avRiKeyId)) bytes of launch_session->iv) @@ -386,6 +381,9 @@ namespace stream { crypto::cipher::gcm_t cipher; crypto::aes_t iv; + uint32_t connect_data; // Used for new clients with ML_FF_SESSION_ID_V1 + std::string expected_peer_address; // Only used for legacy clients without ML_FF_SESSION_ID_V1 + net::peer_t peer; std::uint8_t seq; @@ -445,29 +443,47 @@ namespace stream { static auto broadcast = safe::make_shared(start_broadcast, end_broadcast); session_t * - control_server_t::get_session(const net::peer_t peer) { - TUPLE_2D(port, addr_string, platf::from_sockaddr_ex((sockaddr *) &peer->address.address)); + control_server_t::get_session(const net::peer_t peer, uint32_t connect_data) { + { + // Fast path - look up existing session by peer + auto lg = _peer_to_session.lock(); + auto it = _peer_to_session->find(peer); + if (it != _peer_to_session->end()) { + return it->second; + } + } - auto lg = _map_addr_session.lock(); - TUPLE_2D(begin, end, _map_addr_session->equal_range(addr_string)); + // Slow path - process new session + TUPLE_2D(peer_port, peer_addr, platf::from_sockaddr_ex((sockaddr *) &peer->address.address)); + auto lg = _sessions.lock(); + for (auto pos = std::begin(*_sessions); pos != std::end(*_sessions); ++pos) { + auto session_p = *pos; - auto it = std::end(_map_addr_session.raw); - for (auto pos = begin; pos != end; ++pos) { - TUPLE_2D_REF(session_port, session_p, pos->second); + // Skip sessions that are already established + if (session_p->control.peer) { + continue; + } - if (port == session_port) { - return session_p; + // Identify the connection by the unique connect data if the client supports it. + // Only fall back to IP address matching for clients without session ID support. + if (session_p->config.mlFeatureFlags & ML_FF_SESSION_ID_V1) { + if (session_p->control.connect_data != connect_data) { + continue; + } + else { + BOOST_LOG(debug) << "Initialized new control stream session by connect data match [v2]"sv; + } } - else if (session_port == 0) { - it = pos; + else { + if (session_p->control.expected_peer_address != peer_addr) { + continue; + } + else { + BOOST_LOG(debug) << "Initialized new control stream session by IP address match [v1]"sv; + } } - } - - if (it != std::end(_map_addr_session.raw)) { - TUPLE_2D_REF(session_port, session_p, it->second); session_p->control.peer = peer; - session_port = port; // Use the local address from the control connection as the source address // for other communications to the client. This is necessary to ensure @@ -475,6 +491,12 @@ namespace stream { auto local_address = platf::from_sockaddr((sockaddr *) &peer->localAddress.address); session_p->localAddress = boost::asio::ip::make_address(local_address); + BOOST_LOG(debug) << "Control local address ["sv << local_address << ']'; + BOOST_LOG(debug) << "Control peer address ["sv << peer_addr << ':' << peer_port << ']'; + + // Insert this into the map for O(1) lookups in the future + auto ptslg = _peer_to_session.lock(); + _peer_to_session->emplace(peer, session_p); return session_p; } @@ -502,7 +524,7 @@ namespace stream { auto res = enet_host_service(_host.get(), &event, timeout.count()); if (res > 0) { - auto session = get_session(event.peer); + auto session = get_session(event.peer, event.data); if (!session) { BOOST_LOG(warning) << "Rejected connection from ["sv << platf::from_sockaddr((sockaddr *) &event.peer->address.address) << "]: it's not properly set up"sv; enet_peer_disconnect_now(event.peer, 0); @@ -936,23 +958,28 @@ namespace stream { bool has_session_awaiting_peer = false; { - auto lg = server->_map_addr_session.lock(); + auto lg = server->_sessions.lock(); auto now = std::chrono::steady_clock::now(); - KITTY_WHILE_LOOP(auto pos = std::begin(*server->_map_addr_session), pos != std::end(*server->_map_addr_session), { - TUPLE_2D_REF(addr, port_session, *pos); - auto session = port_session.second; + KITTY_WHILE_LOOP(auto pos = std::begin(*server->_sessions), pos != std::end(*server->_sessions), { + auto session = *pos; if (now > session->pingTimeout) { - BOOST_LOG(info) << addr << ": Ping Timeout"sv; + auto address = session->control.peer ? platf::from_sockaddr((sockaddr *) &session->control.peer->address.address) : session->control.expected_peer_address; + BOOST_LOG(info) << address << ": Ping Timeout"sv; session::stop(*session); } if (session->state.load(std::memory_order_acquire) == session::state_e::STOPPING) { - pos = server->_map_addr_session->erase(pos); + pos = server->_sessions->erase(pos); if (session->control.peer) { + { + auto ptslg = server->_peer_to_session.lock(); + server->_peer_to_session->erase(session->control.peer); + } + enet_peer_disconnect_now(session->control.peer, 0); } @@ -1008,9 +1035,9 @@ namespace stream { sizeof(control_encrypted_t) + crypto::cipher::round_to_pkcs7_padded(sizeof(plaintext)) + crypto::cipher::tag_size> encrypted_payload; - auto lg = server->_map_addr_session.lock(); - for (auto pos = std::begin(*server->_map_addr_session); pos != std::end(*server->_map_addr_session); ++pos) { - auto session = pos->second.second; + auto lg = server->_sessions.lock(); + for (auto pos = std::begin(*server->_sessions); pos != std::end(*server->_sessions); ++pos) { + auto session = *pos; // We may not have gotten far enough to have an ENet connection yet if (session->control.peer) { @@ -1031,8 +1058,8 @@ namespace stream { void recvThread(broadcast_ctx_t &ctx) { - std::map peer_to_video_session; - std::map peer_to_audio_session; + std::map peer_to_video_session; + std::map peer_to_audio_session; auto &video_sock = ctx.video_sock; auto &audio_sock = ctx.audio_sock; @@ -1050,30 +1077,30 @@ namespace stream { auto populate_peer_to_session = [&]() { while (message_queue_queue->peek()) { auto message_queue_opt = message_queue_queue->pop(); - TUPLE_3D_REF(socket_type, addr, message_queue, *message_queue_opt); + TUPLE_3D_REF(socket_type, session_id, message_queue, *message_queue_opt); switch (socket_type) { case socket_e::video: if (message_queue) { - peer_to_video_session.emplace(addr, message_queue); + peer_to_video_session.emplace(session_id, message_queue); } else { - peer_to_video_session.erase(addr); + peer_to_video_session.erase(session_id); } break; case socket_e::audio: if (message_queue) { - peer_to_audio_session.emplace(addr, message_queue); + peer_to_audio_session.emplace(session_id, message_queue); } else { - peer_to_audio_session.erase(addr); + peer_to_audio_session.erase(session_id); } break; } } }; - auto recv_func_init = [&](udp::socket &sock, int buf_elem, std::map &peer_to_session) { + auto recv_func_init = [&](udp::socket &sock, int buf_elem, std::map &peer_to_session) { recv_func[buf_elem] = [&, buf_elem](const boost::system::error_code &ec, size_t bytes) { auto fg = util::fail_guard([&]() { sock.async_receive_from(asio::buffer(buf[buf_elem]), peer, 0, recv_func[buf_elem]); @@ -1094,10 +1121,23 @@ namespace stream { return; } - auto it = peer_to_session.find(peer.address()); - if (it != std::end(peer_to_session)) { - BOOST_LOG(debug) << "RAISE: "sv << peer.address().to_string() << ':' << peer.port() << " :: " << type_str; - it->second->raise(peer.port(), std::string { buf[buf_elem].data(), bytes }); + if (bytes == 4) { + // For legacy PING packets, find the matching session by address. + auto it = peer_to_session.find(peer.address()); + if (it != std::end(peer_to_session)) { + BOOST_LOG(debug) << "RAISE: "sv << peer.address().to_string() << ':' << peer.port() << " :: " << type_str; + it->second->raise(peer, std::string { buf[buf_elem].data(), bytes }); + } + } + else if (bytes >= sizeof(SS_PING)) { + auto ping = (PSS_PING) buf[buf_elem].data(); + + // For new PING packets that include a client identifier, search by payload. + auto it = peer_to_session.find(std::string { ping->payload, sizeof(ping->payload) }); + if (it != std::end(peer_to_session)) { + BOOST_LOG(debug) << "RAISE: "sv << peer.address().to_string() << ':' << peer.port() << " :: " << type_str; + it->second->raise(peer, std::string { buf[buf_elem].data(), bytes }); + } } }; }; @@ -1375,7 +1415,7 @@ namespace stream { // For now, encode_audio needs it to be the proper sequenceNumber audio_packet->rtp.sequenceNumber = sequenceNumber; - auto bytes = encode_audio(session->config.featureFlags, packet_data, audio_packet, session->audio.avRiKeyId, session->audio.cipher); + auto bytes = encode_audio(session->config.nvFeatureFlags, packet_data, audio_packet, session->audio.avRiKeyId, session->audio.cipher); if (bytes < 0) { BOOST_LOG(error) << "Couldn't encode audio packet"sv; break; @@ -1531,17 +1571,24 @@ namespace stream { } int - recv_ping(decltype(broadcast)::ptr_t ref, socket_e type, udp::endpoint &peer, std::chrono::milliseconds timeout) { - auto constexpr ping = "PING"sv; - + recv_ping(session_t *session, decltype(broadcast)::ptr_t ref, socket_e type, std::string_view expected_payload, udp::endpoint &peer, std::chrono::milliseconds timeout) { auto messages = std::make_shared(30); - ref->message_queue_queue->raise(type, peer.address(), messages); + av_session_id_t session_id = std::string { expected_payload }; + + // Only allow matches on the peer address for legacy clients + if (!(session->config.mlFeatureFlags & ML_FF_SESSION_ID_V1)) { + ref->message_queue_queue->raise(type, peer.address(), messages); + } + ref->message_queue_queue->raise(type, session_id, messages); auto fg = util::fail_guard([&]() { messages->stop(); // remove message queue from session - ref->message_queue_queue->raise(type, peer.address(), nullptr); + if (!(session->config.mlFeatureFlags & ML_FF_SESSION_ID_V1)) { + ref->message_queue_queue->raise(type, peer.address(), nullptr); + } + ref->message_queue_queue->raise(type, session_id, nullptr); }); auto start_time = std::chrono::steady_clock::now(); @@ -1555,45 +1602,24 @@ namespace stream { break; } - TUPLE_2D_REF(port, msg, *msg_opt); - if (msg == ping) { - BOOST_LOG(debug) << "Received ping from "sv << peer.address() << ':' << port << " ["sv << util::hex_vec(msg) << ']'; - - // Update connection details. - { - auto addr_str = peer.address().to_string(); - - auto &connections = ref->audio_video_connections; - - auto lg = connections.lock(); - - std::remove_reference_t::iterator pos = std::end(*connections); - - for (auto it = std::begin(*connections); it != std::end(*connections); ++it) { - TUPLE_2D_REF(addr, port_ref, *it); - - if (!port_ref && addr_str == addr) { - pos = it; - } - else if (port_ref == port) { - break; - } - } - - if (pos == std::end(*connections)) { - continue; - } - - pos->second = port; - peer.port(port); - } - - return port; + TUPLE_2D_REF(recv_peer, msg, *msg_opt); + if (msg.find(expected_payload) != std::string::npos) { + // Match the new PING payload format + BOOST_LOG(debug) << "Received ping [v2] from "sv << recv_peer.address() << ':' << recv_peer.port() << " ["sv << util::hex_vec(msg) << ']'; + } + else if (!(session->config.mlFeatureFlags & ML_FF_SESSION_ID_V1) && msg == "PING"sv) { + // Match the legacy fixed PING payload only if the new type is not supported + BOOST_LOG(debug) << "Received ping [v1] from "sv << recv_peer.address() << ':' << recv_peer.port() << " ["sv << util::hex_vec(msg) << ']'; + } + else { + BOOST_LOG(debug) << "Received non-ping from "sv << recv_peer.address() << ':' << recv_peer.port() << " ["sv << util::hex_vec(msg) << ']'; + current_time = std::chrono::steady_clock::now(); + continue; } - BOOST_LOG(debug) << "Received non-ping from "sv << peer.address() << ':' << port << " ["sv << util::hex_vec(msg) << ']'; - - current_time = std::chrono::steady_clock::now(); + // Update connection details. + peer = recv_peer; + return 0; } BOOST_LOG(error) << "Initial Ping Timeout"sv; @@ -1609,8 +1635,8 @@ namespace stream { while_starting_do_nothing(session->state); auto ref = broadcast.ref(); - auto port = recv_ping(ref, socket_e::video, session->video.peer, config::stream.ping_timeout); - if (port < 0) { + auto error = recv_ping(session, ref, socket_e::video, session->video.ping_payload, session->video.peer, config::stream.ping_timeout); + if (error < 0) { return; } @@ -1634,8 +1660,8 @@ namespace stream { while_starting_do_nothing(session->state); auto ref = broadcast.ref(); - auto port = recv_ping(ref, socket_e::audio, session->audio.peer, config::stream.ping_timeout); - if (port < 0) { + auto error = recv_ping(session, ref, socket_e::audio, session->audio.ping_payload, session->audio.peer, config::stream.ping_timeout); + if (error < 0) { return; } @@ -1696,41 +1722,6 @@ namespace stream { BOOST_LOG(debug) << "Resetting Input..."sv; input::reset(session.input); - BOOST_LOG(debug) << "Removing references to any connections..."sv; - { - auto video_addr = session.video.peer.address().to_string(); - auto audio_addr = session.audio.peer.address().to_string(); - - auto video_port = session.video.peer.port(); - auto audio_port = session.audio.peer.port(); - - auto &connections = session.broadcast_ref->audio_video_connections; - - auto lg = connections.lock(); - - auto validate_size = connections->size(); - for (auto it = std::begin(*connections); it != std::end(*connections);) { - TUPLE_2D_REF(addr, port, *it); - - if ((video_port == port && video_addr == addr) || - (audio_port == port && audio_addr == addr)) { - it = connections->erase(it); - } - else { - ++it; - } - } - - auto new_size = connections->size(); - if (validate_size != new_size + 2) { - BOOST_LOG(warning) << "Couldn't remove reference to session connections: ending all broadcasts"sv; - - // A reference to the event object is still stored somewhere else. So no need to keep - // a reference to it. - mail::man->event(mail::broadcast_shutdown)->raise(true); - } - } - // If this is the last session, invoke the platform callbacks if (--running_sessions == 0) { #if defined SUNSHINE_TRAY && SUNSHINE_TRAY >= 1 @@ -1753,7 +1744,14 @@ namespace stream { return -1; } - session.broadcast_ref->control_server.emplace_addr_to_session(addr_string, session); + session.control.expected_peer_address = addr_string; + BOOST_LOG(debug) << "Expecting incoming session connections from "sv << addr_string; + + // Insert this session into the session list + { + auto lg = session.broadcast_ref->control_server._sessions.lock(); + session.broadcast_ref->control_server._sessions->push_back(&session); + } auto addr = boost::asio::ip::make_address(addr_string); session.video.peer.address(addr); @@ -1762,16 +1760,6 @@ namespace stream { session.audio.peer.address(addr); session.audio.peer.port(0); - { - auto &connections = session.broadcast_ref->audio_video_connections; - - auto lg = connections.lock(); - - // allocate a location for connections - connections->emplace_back(addr_string, 0); - connections->emplace_back(addr_string, 0); - } - session.pingTimeout = std::chrono::steady_clock::now() + config::stream.ping_timeout; session.audioThread = std::thread { audioThread, &session }; @@ -1791,7 +1779,7 @@ namespace stream { } std::shared_ptr - alloc(config_t &config, crypto::aes_t &gcm_key, crypto::aes_t &iv) { + alloc(config_t &config, crypto::aes_t &gcm_key, crypto::aes_t &iv, std::string_view av_ping_payload, uint32_t control_connect_data) { auto session = std::make_shared(); auto mail = std::make_shared(); @@ -1800,6 +1788,7 @@ namespace stream { session->config = config; + session->control.connect_data = control_connect_data; session->control.feedback_queue = mail->queue(mail::gamepad_feedback); session->control.hdr_queue = mail->event(mail::hdr); session->control.iv = iv; @@ -1810,6 +1799,7 @@ namespace stream { session->video.idr_events = mail->event(mail::idr); session->video.invalidate_ref_frames_events = mail->event>(mail::invalidate_ref_frames); session->video.lowseq = 0; + session->video.ping_payload = av_ping_payload; constexpr auto max_block_size = crypto::cipher::round_to_pkcs7_padded(2048); @@ -1839,6 +1829,7 @@ namespace stream { gcm_key, true }; + session->audio.ping_payload = av_ping_payload; session->audio.avRiKeyId = util::endian::big(*(std::uint32_t *) iv.data()); session->audio.sequenceNumber = 0; session->audio.timestamp = 0; diff --git a/src/stream.h b/src/stream.h index 302b9c0e64e..ca87168ef2e 100644 --- a/src/stream.h +++ b/src/stream.h @@ -22,7 +22,8 @@ namespace stream { int packetsize; int minRequiredFecPackets; - int featureFlags; + int nvFeatureFlags; + int mlFeatureFlags; int controlProtocolType; int audioQosType; int videoQosType; @@ -39,7 +40,7 @@ namespace stream { }; std::shared_ptr - alloc(config_t &config, crypto::aes_t &gcm_key, crypto::aes_t &iv); + alloc(config_t &config, crypto::aes_t &gcm_key, crypto::aes_t &iv, std::string_view av_ping_payload, uint32_t control_connect_data); int start(session_t &session, const std::string &addr_string); void From 081936879b4c6139e3219a29baf2413d1f4d79a6 Mon Sep 17 00:00:00 2001 From: LizardByte-bot <108553330+LizardByte-bot@users.noreply.github.com> Date: Sat, 30 Dec 2023 14:21:43 -0500 Subject: [PATCH 042/197] Bump ffmpeg (#1895) --- third-party/ffmpeg-linux-aarch64 | 2 +- third-party/ffmpeg-linux-powerpc64le | 2 +- third-party/ffmpeg-linux-x86_64 | 2 +- third-party/ffmpeg-macos-aarch64 | 2 +- third-party/ffmpeg-macos-x86_64 | 2 +- third-party/ffmpeg-windows-x86_64 | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/third-party/ffmpeg-linux-aarch64 b/third-party/ffmpeg-linux-aarch64 index 315b077e231..801ace9c3c9 160000 --- a/third-party/ffmpeg-linux-aarch64 +++ b/third-party/ffmpeg-linux-aarch64 @@ -1 +1 @@ -Subproject commit 315b077e23127a4c0bf3cff3bb6576e64497ff29 +Subproject commit 801ace9c3c9b9e6e9a0bd97fbcb5fd0259a30d9b diff --git a/third-party/ffmpeg-linux-powerpc64le b/third-party/ffmpeg-linux-powerpc64le index 4074d524629..c244d56b566 160000 --- a/third-party/ffmpeg-linux-powerpc64le +++ b/third-party/ffmpeg-linux-powerpc64le @@ -1 +1 @@ -Subproject commit 4074d524629ca53f8df2365be30ec93abe5439e9 +Subproject commit c244d56b5664618b5b0b3d821a4f35dea4c49d8f diff --git a/third-party/ffmpeg-linux-x86_64 b/third-party/ffmpeg-linux-x86_64 index c887d24822c..7f69cc20eb8 160000 --- a/third-party/ffmpeg-linux-x86_64 +++ b/third-party/ffmpeg-linux-x86_64 @@ -1 +1 @@ -Subproject commit c887d24822cccbf1dc01a0cfacc977db46e318db +Subproject commit 7f69cc20eb8e5888ba7d92177e662a0c81963fae diff --git a/third-party/ffmpeg-macos-aarch64 b/third-party/ffmpeg-macos-aarch64 index fe12a607ed8..afaa32210e4 160000 --- a/third-party/ffmpeg-macos-aarch64 +++ b/third-party/ffmpeg-macos-aarch64 @@ -1 +1 @@ -Subproject commit fe12a607ed8357611ec2dabc7e31a6cc1557b003 +Subproject commit afaa32210e45de2255097be6f51dd692f3da7188 diff --git a/third-party/ffmpeg-macos-x86_64 b/third-party/ffmpeg-macos-x86_64 index 97ff12c2282..afc6772ce85 160000 --- a/third-party/ffmpeg-macos-x86_64 +++ b/third-party/ffmpeg-macos-x86_64 @@ -1 +1 @@ -Subproject commit 97ff12c22822bf33553be7789b6c5e152b00221a +Subproject commit afc6772ce850b2f548b894c797723015533fade9 diff --git a/third-party/ffmpeg-windows-x86_64 b/third-party/ffmpeg-windows-x86_64 index 9bebfe2cfab..c9dc6e931aa 160000 --- a/third-party/ffmpeg-windows-x86_64 +++ b/third-party/ffmpeg-windows-x86_64 @@ -1 +1 @@ -Subproject commit 9bebfe2cfab475549bc2b700449586a4a458fce5 +Subproject commit c9dc6e931aa6e2faf87c0003ca4abff6fdf4c846 From 7640c504fab723af0a2ce23cdae0f5f571457591 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 30 Dec 2023 17:36:36 -0500 Subject: [PATCH 043/197] build(deps): use a single submodule for ffmpeg (#1952) --- .gitmodules | 28 ++++------------------------ cmake/dependencies/common.cmake | 12 ++++++------ docs/Doxyfile | 2 +- packaging/linux/Arch/PKGBUILD | 23 +---------------------- third-party/build-deps | 1 + third-party/ffmpeg-linux-aarch64 | 1 - third-party/ffmpeg-linux-powerpc64le | 1 - third-party/ffmpeg-linux-x86_64 | 1 - third-party/ffmpeg-macos-aarch64 | 1 - third-party/ffmpeg-macos-x86_64 | 1 - third-party/ffmpeg-windows-x86_64 | 1 - 11 files changed, 13 insertions(+), 59 deletions(-) create mode 160000 third-party/build-deps delete mode 160000 third-party/ffmpeg-linux-aarch64 delete mode 160000 third-party/ffmpeg-linux-powerpc64le delete mode 160000 third-party/ffmpeg-linux-x86_64 delete mode 160000 third-party/ffmpeg-macos-aarch64 delete mode 160000 third-party/ffmpeg-macos-x86_64 delete mode 160000 third-party/ffmpeg-windows-x86_64 diff --git a/.gitmodules b/.gitmodules index 92820c24c47..108269ff512 100644 --- a/.gitmodules +++ b/.gitmodules @@ -22,26 +22,6 @@ path = third-party/TPCircularBuffer url = https://github.com/michaeltyson/TPCircularBuffer branch = master -[submodule "third-party/ffmpeg-windows-x86_64"] - path = third-party/ffmpeg-windows-x86_64 - url = https://github.com/LizardByte/build-deps - branch = ffmpeg-windows-x86_64 -[submodule "third-party/ffmpeg-macos-x86_64"] - path = third-party/ffmpeg-macos-x86_64 - url = https://github.com/LizardByte/build-deps - branch = ffmpeg-macos-x86_64 -[submodule "third-party/ffmpeg-linux-x86_64"] - path = third-party/ffmpeg-linux-x86_64 - url = https://github.com/LizardByte/build-deps - branch = ffmpeg-linux-x86_64 -[submodule "third-party/ffmpeg-linux-aarch64"] - path = third-party/ffmpeg-linux-aarch64 - url = https://github.com/LizardByte/build-deps - branch = ffmpeg-linux-aarch64 -[submodule "third-party/ffmpeg-macos-aarch64"] - path = third-party/ffmpeg-macos-aarch64 - url = https://github.com/LizardByte/build-deps - branch = ffmpeg-macos-aarch64 [submodule "third-party/nanors"] path = third-party/nanors url = https://github.com/sleepybishop/nanors.git @@ -54,10 +34,6 @@ path = third-party/nvapi-open-source-sdk url = https://github.com/LizardByte/nvapi-open-source-sdk branch = sdk -[submodule "third-party/ffmpeg-linux-powerpc64le"] - path = third-party/ffmpeg-linux-powerpc64le - url = https://github.com/LizardByte/build-deps - branch = ffmpeg-linux-powerpc64le [submodule "third-party/wayland-protocols"] path = third-party/wayland-protocols url = https://gitlab.freedesktop.org/wayland/wayland-protocols @@ -66,3 +42,7 @@ path = third-party/wlr-protocols url = https://gitlab.freedesktop.org/wlroots/wlr-protocols branch = master +[submodule "third-party/build-deps"] + path = third-party/build-deps + url = https://github.com/LizardByte/build-deps.git + branch = dist diff --git a/cmake/dependencies/common.cmake b/cmake/dependencies/common.cmake index 34ea09f7a3a..316de3f9272 100644 --- a/cmake/dependencies/common.cmake +++ b/cmake/dependencies/common.cmake @@ -23,12 +23,12 @@ if(WIN32) message(FATAL_ERROR "Unsupported system processor:" ${CMAKE_SYSTEM_PROCESSOR}) endif() set(FFMPEG_PLATFORM_LIBRARIES mfplat ole32 strmiids mfuuid vpl) - set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-windows-x86_64") + set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/build-deps/ffmpeg/windows-x86_64") elseif(APPLE) if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64") - set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-macos-x86_64") + set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/build-deps/ffmpeg/macos-x86_64") elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "arm64") - set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-macos-aarch64") + set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/build-deps/ffmpeg/macos-aarch64") elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "powerpc") message(FATAL_ERROR "PowerPC is not supported on macOS") else() @@ -38,13 +38,13 @@ elseif(UNIX) set(FFMPEG_PLATFORM_LIBRARIES va va-drm va-x11 vdpau X11) if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64") list(APPEND FFMPEG_PLATFORM_LIBRARIES mfx) - set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-linux-x86_64") + set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/build-deps/ffmpeg/linux-x86_64") set(CPACK_DEB_PLATFORM_PACKAGE_DEPENDS "libmfx1,") set(CPACK_RPM_PLATFORM_PACKAGE_REQUIRES "intel-mediasdk >= 22.3.0,") elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "aarch64") - set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-linux-aarch64") + set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/build-deps/ffmpeg/linux-aarch64") elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "ppc64le" OR CMAKE_SYSTEM_PROCESSOR STREQUAL "ppc64") - set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/ffmpeg-linux-powerpc64le") + set(FFMPEG_PREPARED_BINARIES "${CMAKE_CURRENT_SOURCE_DIR}/third-party/build-deps/ffmpeg/linux-powerpc64le") else() message(FATAL_ERROR "Unsupported system processor:" ${CMAKE_SYSTEM_PROCESSOR}) endif() diff --git a/docs/Doxyfile b/docs/Doxyfile index 5d909b5335e..d6e79cd2571 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -2355,7 +2355,7 @@ SEARCH_INCLUDES = YES # RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = ../third-party/ffmpeg-linux-x86_64/include/ +INCLUDE_PATH = ../third-party/build-deps/ffmpeg/linux-x86_64/include/ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the diff --git a/packaging/linux/Arch/PKGBUILD b/packaging/linux/Arch/PKGBUILD index 68cbecb872b..c14b40db243 100644 --- a/packaging/linux/Arch/PKGBUILD +++ b/packaging/linux/Arch/PKGBUILD @@ -45,28 +45,7 @@ sha256sums=('SKIP') prepare() { cd "$pkgname" - # Skip submodules that we don't want - if [[ $CARCH == "x86_64" ]]; then - git -c submodule."ffmpeg-macos-x86_64".update=none \ - -c submodule."ffmpeg-windows-x86_64".update=none \ - -c submodule."ffmpeg-linux-aarch64".update=none \ - -c submodule."ffmpeg-macos-aarch64".update=none \ - submodule update --recursive --init - elif [[ $CARCH == "aarch64" ]]; then - git -c submodule."ffmpeg-macos-x86_64".update=none \ - -c submodule."ffmpeg-windows-x86_64".update=none \ - -c submodule."ffmpeg-linux-x86_64".update=none \ - -c submodule."ffmpeg-macos-aarch64".update=none \ - submodule update --recursive --init - - # It's unlikely that someone could get this far on a system with an incorrect arch, but we should handle it anyway - # Pull linux ffmpeg submodules - else - git -c submodule."ffmpeg-macos-x86_64".update=none \ - -c submodule."ffmpeg-windows-x86_64".update=none \ - -c submodule."ffmpeg-macos-aarch64".update=none \ - submodule update --recursive --init - fi + git submodule update --recursive --init } build() { diff --git a/third-party/build-deps b/third-party/build-deps new file mode 160000 index 00000000000..6e23b580e65 --- /dev/null +++ b/third-party/build-deps @@ -0,0 +1 @@ +Subproject commit 6e23b580e653595df1e6f680062fa08d6eff3dfe diff --git a/third-party/ffmpeg-linux-aarch64 b/third-party/ffmpeg-linux-aarch64 deleted file mode 160000 index 801ace9c3c9..00000000000 --- a/third-party/ffmpeg-linux-aarch64 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 801ace9c3c9b9e6e9a0bd97fbcb5fd0259a30d9b diff --git a/third-party/ffmpeg-linux-powerpc64le b/third-party/ffmpeg-linux-powerpc64le deleted file mode 160000 index c244d56b566..00000000000 --- a/third-party/ffmpeg-linux-powerpc64le +++ /dev/null @@ -1 +0,0 @@ -Subproject commit c244d56b5664618b5b0b3d821a4f35dea4c49d8f diff --git a/third-party/ffmpeg-linux-x86_64 b/third-party/ffmpeg-linux-x86_64 deleted file mode 160000 index 7f69cc20eb8..00000000000 --- a/third-party/ffmpeg-linux-x86_64 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 7f69cc20eb8e5888ba7d92177e662a0c81963fae diff --git a/third-party/ffmpeg-macos-aarch64 b/third-party/ffmpeg-macos-aarch64 deleted file mode 160000 index afaa32210e4..00000000000 --- a/third-party/ffmpeg-macos-aarch64 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit afaa32210e45de2255097be6f51dd692f3da7188 diff --git a/third-party/ffmpeg-macos-x86_64 b/third-party/ffmpeg-macos-x86_64 deleted file mode 160000 index afc6772ce85..00000000000 --- a/third-party/ffmpeg-macos-x86_64 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit afc6772ce850b2f548b894c797723015533fade9 diff --git a/third-party/ffmpeg-windows-x86_64 b/third-party/ffmpeg-windows-x86_64 deleted file mode 160000 index c9dc6e931aa..00000000000 --- a/third-party/ffmpeg-windows-x86_64 +++ /dev/null @@ -1 +0,0 @@ -Subproject commit c9dc6e931aa6e2faf87c0003ca4abff6fdf4c846 From 66e31a21fb7629816918b0a92956751c40765a56 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sat, 30 Dec 2023 13:08:30 -0600 Subject: [PATCH 044/197] Compute the bitrate on the host side for supported clients --- src/audio.cpp | 2 ++ src/rtsp.cpp | 30 ++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/src/audio.cpp b/src/audio.cpp index b2c8f458f7f..44791122b72 100644 --- a/src/audio.cpp +++ b/src/audio.cpp @@ -39,6 +39,8 @@ namespace audio { constexpr auto SAMPLE_RATE = 48000; + // NOTE: If you adjust the bitrates listed here, make sure to update the + // corresponding bitrate adjustment logic in rtsp_stream::cmd_announce() opus_stream_config_t stream_configs[MAX_STREAM_CONFIG] { { SAMPLE_RATE, diff --git a/src/rtsp.cpp b/src/rtsp.cpp index 7a5a532e836..21a98745e56 100644 --- a/src/rtsp.cpp +++ b/src/rtsp.cpp @@ -704,9 +704,11 @@ namespace rtsp_stream { args.try_emplace("x-ml-general.featureFlags"sv, "0"sv); args.try_emplace("x-nv-vqos[0].qosTrafficType"sv, "5"sv); args.try_emplace("x-nv-aqos.qosTrafficType"sv, "4"sv); + args.try_emplace("x-ml-video.configuredBitrateKbps"sv, "0"sv); stream::config_t config; + std::int64_t configuredBitrateKbps; config.audio.flags[audio::config_t::HOST_AUDIO] = launch_session->host_audio; try { config.audio.channels = util::from_view(args.at("x-nv-audio.surround.numChannels"sv)); @@ -733,6 +735,8 @@ namespace rtsp_stream { config.monitor.encoderCscMode = util::from_view(args.at("x-nv-video[0].encoderCscMode"sv)); config.monitor.videoFormat = util::from_view(args.at("x-nv-vqos[0].bitStreamFormat"sv)); config.monitor.dynamicRange = util::from_view(args.at("x-nv-video[0].dynamicRangeMode"sv)); + + configuredBitrateKbps = util::from_view(args.at("x-ml-video.configuredBitrateKbps"sv)); } catch (std::out_of_range &) { respond(sock, &option, 400, "BAD REQUEST", req->sequenceNumber, {}); @@ -752,6 +756,32 @@ namespace rtsp_stream { } } + // If the client sent a configured bitrate, we will choose the actual bitrate ourselves + // by using FEC percentage and audio quality settings. If the calculated bitrate ends up + // too low, we'll allow it to exceed the limits rather than reducing the encoding bitrate + // down to nearly nothing. + if (configuredBitrateKbps) { + BOOST_LOG(debug) << "Client configured bitrate is "sv << configuredBitrateKbps << " Kbps"sv; + + // If the FEC percentage isn't too high, adjust the configured bitrate to ensure video + // traffic doesn't exceed the user's selected bitrate when the FEC shards are included. + if (config::stream.fec_percentage <= 80) { + configuredBitrateKbps /= 100.f / (100 - config::stream.fec_percentage); + } + + // Adjust the bitrate to account for audio traffic bandwidth usage (capped at 20% reduction). + // The bitrate per channel is 256 Kbps for high quality mode and 96 Kbps for normal quality. + auto audioBitrateAdjustment = (config.audio.flags[audio::config_t::HIGH_QUALITY] ? 256 : 96) * config.audio.channels; + configuredBitrateKbps -= std::min((std::int64_t) audioBitrateAdjustment, configuredBitrateKbps / 5); + + // Reduce it by another 500Kbps to account for A/V packet overhead and control data + // traffic (capped at 10% reduction). + configuredBitrateKbps -= std::min((std::int64_t) 500, configuredBitrateKbps / 10); + + BOOST_LOG(debug) << "Final adjusted video encoding bitrate is "sv << configuredBitrateKbps << " Kbps"sv; + config.monitor.bitrate = configuredBitrateKbps; + } + if (config.monitor.videoFormat == 1 && video::active_hevc_mode == 1) { BOOST_LOG(warning) << "HEVC is disabled, yet the client requested HEVC"sv; From a6ffeb4b53a6d7a5089d7b4fc0479a9fb575ba5e Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sat, 30 Dec 2023 21:48:48 -0600 Subject: [PATCH 045/197] Don't install/update ViGEmBus if 1.17 or later is already installed (#1953) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> --- .../windows/misc/gamepad/install-gamepad.bat | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/src_assets/windows/misc/gamepad/install-gamepad.bat b/src_assets/windows/misc/gamepad/install-gamepad.bat index b4b63ca5d42..cf164cb5109 100644 --- a/src_assets/windows/misc/gamepad/install-gamepad.bat +++ b/src_assets/windows/misc/gamepad/install-gamepad.bat @@ -1,6 +1,32 @@ @echo off setlocal enabledelayedexpansion +rem Check if a compatible version of ViGEmBus is already installed (1.17 or later) +set Version= +for /f "usebackq delims=" %%a in (`wmic product where "name='ViGEm Bus Driver' or name='Nefarius Virtual Gamepad Emulation Bus Driver'" get Version /format:Textvaluelist`) do ( + for /f "delims=" %%# in ("%%a") do set "%%#" +) + +rem Extract Major and Minor versions +for /f "tokens=1,2 delims=." %%a in ("%Version%") do ( + set "MajorVersion=%%a" + set "MinorVersion=%%b" +) + +rem Compare the version to 1.17 +if /i !MajorVersion! gtr 1 goto skip +if /i !MajorVersion! equ 1 ( + if /i !MinorVersion! geq 17 ( + goto skip + ) +) +goto continue + +:skip +echo "The installed version is %Version%, no update needed. Exiting." +exit /b 0 + +:continue rem Get temp directory set temp_dir=%temp%/Sunshine From 8efc15b58fe9c05f05d3f00b2e732b9c62221a25 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 31 Dec 2023 14:25:18 -0500 Subject: [PATCH 046/197] build(cmake): do not include unneeded headers (#1957) --- cmake/compile_definitions/linux.cmake | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/cmake/compile_definitions/linux.cmake b/cmake/compile_definitions/linux.cmake index f28152ee9bb..c4950809196 100644 --- a/cmake/compile_definitions/linux.cmake +++ b/cmake/compile_definitions/linux.cmake @@ -91,6 +91,7 @@ endif() if(CUDA_FOUND) include_directories(SYSTEM third-party/nvfbc) list(APPEND PLATFORM_TARGET_FILES + src/platform/linux/cuda.h src/platform/linux/cuda.cu src/platform/linux/cuda.cpp third-party/nvfbc/NvFBC.h) @@ -110,7 +111,8 @@ if(LIBDRM_FOUND AND LIBCAP_FOUND) add_compile_definitions(SUNSHINE_BUILD_DRM) include_directories(SYSTEM ${LIBDRM_INCLUDE_DIRS} ${LIBCAP_INCLUDE_DIRS}) list(APPEND PLATFORM_LIBRARIES ${LIBDRM_LIBRARIES} ${LIBCAP_LIBRARIES}) - list(APPEND PLATFORM_TARGET_FILES src/platform/linux/kmsgrab.cpp) + list(APPEND PLATFORM_TARGET_FILES + src/platform/linux/kmsgrab.cpp) list(APPEND SUNSHINE_DEFINITIONS EGL_NO_X11=1) elseif(NOT LIBDRM_FOUND) message(WARNING "Missing libdrm") @@ -139,6 +141,7 @@ if(WAYLAND_FOUND) list(APPEND PLATFORM_LIBRARIES ${WAYLAND_LIBRARIES}) list(APPEND PLATFORM_TARGET_FILES src/platform/linux/wlgrab.cpp + src/platform/linux/wayland.h src/platform/linux/wayland.cpp) endif() @@ -152,7 +155,9 @@ if(X11_FOUND) add_compile_definitions(SUNSHINE_BUILD_X11) include_directories(SYSTEM ${X11_INCLUDE_DIR}) list(APPEND PLATFORM_LIBRARIES ${X11_LIBRARIES}) - list(APPEND PLATFORM_TARGET_FILES src/platform/linux/x11grab.cpp) + list(APPEND PLATFORM_TARGET_FILES + src/platform/linux/x11grab.h + src/platform/linux/x11grab.cpp) endif() if(NOT ${CUDA_FOUND} AND NOT ${WAYLAND_FOUND} AND NOT ${X11_FOUND} AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND})) @@ -196,15 +201,12 @@ list(APPEND PLATFORM_TARGET_FILES src/platform/linux/publish.cpp src/platform/linux/vaapi.h src/platform/linux/vaapi.cpp - src/platform/linux/cuda.h src/platform/linux/graphics.h src/platform/linux/graphics.cpp src/platform/linux/misc.h src/platform/linux/misc.cpp src/platform/linux/audio.cpp src/platform/linux/input.cpp - src/platform/linux/x11grab.h - src/platform/linux/wayland.h third-party/glad/src/egl.c third-party/glad/src/gl.c third-party/glad/include/EGL/eglplatform.h From d97f724e3ba99ca77b6e84c94f30d98205f26b8d Mon Sep 17 00:00:00 2001 From: James Le Cuirot Date: Sun, 31 Dec 2023 20:10:48 +0000 Subject: [PATCH 047/197] Use dl handle for libva's vaTerminate rather than actual function (#1955) --- src/platform/linux/vaapi.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platform/linux/vaapi.cpp b/src/platform/linux/vaapi.cpp index 18b0dff8998..77daeab5b12 100644 --- a/src/platform/linux/vaapi.cpp +++ b/src/platform/linux/vaapi.cpp @@ -520,7 +520,7 @@ namespace va { auto hwctx = (AVVAAPIDeviceContext *) ctx->hwctx; auto priv = (VAAPIDevicePriv *) ctx->user_opaque; - vaTerminate(hwctx->display); + terminate(hwctx->display); close(priv->drm_fd); av_freep(&priv); } From 64be0aa67a4ca30dd551ea50845af906999f5455 Mon Sep 17 00:00:00 2001 From: James Le Cuirot Date: Sun, 31 Dec 2023 20:57:45 +0000 Subject: [PATCH 048/197] Fix grabbing code when DRM is enabled and X11 is disabled (#1956) --- src/platform/linux/x11grab.h | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/platform/linux/x11grab.h b/src/platform/linux/x11grab.h index 24e96f6a1fd..4c2f347834d 100644 --- a/src/platform/linux/x11grab.h +++ b/src/platform/linux/x11grab.h @@ -51,9 +51,6 @@ namespace platf::x11 { xdisplay_t make_display(); #else - // It's never something different from nullptr - util::safe_ptr<_XDisplay, std::default_delete<_XDisplay>>; - class cursor_t { public: static std::optional @@ -65,7 +62,7 @@ namespace platf::x11 { blend(img_t &, int, int) {} }; - xdisplay_t + void * make_display() { return nullptr; } #endif } // namespace platf::x11 From fe3bf0ee6ffd1b0361ad1a8ea20bbb01be2233d3 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 31 Dec 2023 16:34:33 -0500 Subject: [PATCH 049/197] fix(tray): use PROJECT_NAME definition for tooltip (#1958) --- src/system_tray.cpp | 10 ++++------ third-party/tray | 2 +- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/src/system_tray.cpp b/src/system_tray.cpp index 8a06a0a79c1..95a492dc297 100644 --- a/src/system_tray.cpp +++ b/src/system_tray.cpp @@ -40,12 +40,12 @@ #include "main.h" #include "platform/common.h" #include "process.h" + #include "version.h" using namespace std::literals; // system_tray namespace namespace system_tray { - /** * @brief Callback for opening the UI from the system tray. * @param item The tray menu item. @@ -126,9 +126,7 @@ namespace system_tray { // Tray menu static struct tray tray = { .icon = TRAY_ICON, - #if defined(_WIN32) - .tooltip = const_cast("Sunshine"), // cast the string literal to a non-const char* pointer - #endif + .tooltip = PROJECT_NAME, .menu = (struct tray_menu[]) { // todo - use boost/locale to translate menu strings @@ -340,7 +338,7 @@ namespace system_tray { tray.notification_icon = TRAY_ICON; tray.notification_title = "Application Stopped"; tray.notification_text = msg; - tray.tooltip = "Sunshine"; + tray.tooltip = PROJECT_NAME; tray_update(&tray); } @@ -359,7 +357,7 @@ namespace system_tray { tray.notification_title = "Incoming Pairing Request"; tray.notification_text = "Click here to complete the pairing process"; tray.notification_icon = TRAY_ICON_LOCKED; - tray.tooltip = "Sunshine"; + tray.tooltip = PROJECT_NAME; tray.notification_cb = []() { launch_ui_with_path("/pin"); }; diff --git a/third-party/tray b/third-party/tray index e08bdbe5aa7..8bb9978991a 160000 --- a/third-party/tray +++ b/third-party/tray @@ -1 +1 @@ -Subproject commit e08bdbe5aa7de0ad9c0ce36257016e07c7e6e2c0 +Subproject commit 8bb9978991a1438fe0665513012628d85f0783ce From 44b34d1e23ed4420007f8f2154e42fe85828f70e Mon Sep 17 00:00:00 2001 From: James Le Cuirot Date: Mon, 1 Jan 2024 01:04:04 +0000 Subject: [PATCH 050/197] Optionally allow the system installation of MiniUPnP to be used (#1959) --- cmake/compile_definitions/common.cmake | 2 +- cmake/dependencies/common.cmake | 39 +++++++++++++++++--------- cmake/prep/options.cmake | 2 ++ 3 files changed, 29 insertions(+), 14 deletions(-) diff --git a/cmake/compile_definitions/common.cmake b/cmake/compile_definitions/common.cmake index f10b2006cf6..c096920a06b 100644 --- a/cmake/compile_definitions/common.cmake +++ b/cmake/compile_definitions/common.cmake @@ -118,7 +118,7 @@ else() endif() list(APPEND SUNSHINE_EXTERNAL_LIBRARIES - libminiupnpc-static + ${MINIUPNP_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT} enet opus diff --git a/cmake/dependencies/common.cmake b/cmake/dependencies/common.cmake index 316de3f9272..1113832c921 100644 --- a/cmake/dependencies/common.cmake +++ b/cmake/dependencies/common.cmake @@ -9,13 +9,33 @@ add_subdirectory(third-party/moonlight-common-c/enet) # web server add_subdirectory(third-party/Simple-Web-Server) +# common dependencies +find_package(OpenSSL REQUIRED) +find_package(PkgConfig REQUIRED) +find_package(Threads REQUIRED) +pkg_check_modules(CURL REQUIRED libcurl) + # miniupnp -set(UPNPC_BUILD_SHARED OFF CACHE BOOL "No shared libraries") -set(UPNPC_BUILD_TESTS OFF CACHE BOOL "Don't build tests for miniupnpc") -set(UPNPC_BUILD_SAMPLE OFF CACHE BOOL "Don't build samples for miniupnpc") -set(UPNPC_NO_INSTALL ON CACHE BOOL "Don't install any libraries build for miniupnpc") -add_subdirectory(third-party/miniupnp/miniupnpc) -include_directories(SYSTEM third-party/miniupnp/miniupnpc/include) +if(SUNSHINE_SYSTEM_MINIUPNP) + pkg_check_modules(MINIUPNP miniupnpc REQUIRED) + + # Use includedir pkg-config variable rather than MINIUPNP_INCLUDE_DIRS + # defined above. The latter may be blank, as pkg-config sometimes omits -I + # flags for directories that are searched by default (e.g. /usr/include), + # but we need a value to append /miniupnpc to. Normally source files would + # prefix their #include directives with miniupnpc/, but this does not align + # with the directory structure of the git submodule used below. + pkg_get_variable(MINIUPNP_INCLUDE_DIR miniupnpc includedir) + include_directories(SYSTEM ${MINIUPNP_INCLUDE_DIR}/miniupnpc) +else() + set(UPNPC_BUILD_SHARED OFF CACHE BOOL "No shared libraries") + set(UPNPC_BUILD_TESTS OFF CACHE BOOL "Don't build tests for miniupnpc") + set(UPNPC_BUILD_SAMPLE OFF CACHE BOOL "Don't build samples for miniupnpc") + set(UPNPC_NO_INSTALL ON CACHE BOOL "Don't install any libraries build for miniupnpc") + set(MINIUPNP_LIBRARIES libminiupnpc-static) + add_subdirectory(third-party/miniupnp/miniupnpc) + include_directories(SYSTEM third-party/miniupnp/miniupnpc/include) +endif() # ffmpeg pre-compiled binaries if(WIN32) @@ -66,12 +86,6 @@ set(FFMPEG_LIBRARIES ${HDR10_PLUS_LIBRARY} ${FFMPEG_PLATFORM_LIBRARIES}) -# common dependencies -find_package(OpenSSL REQUIRED) -find_package(PkgConfig REQUIRED) -find_package(Threads REQUIRED) -pkg_check_modules(CURL REQUIRED libcurl) - # platform specific dependencies if(WIN32) include(${CMAKE_MODULE_PATH}/dependencies/windows.cmake) @@ -84,4 +98,3 @@ elseif(UNIX) include(${CMAKE_MODULE_PATH}/dependencies/linux.cmake) endif() endif() - diff --git a/cmake/prep/options.cmake b/cmake/prep/options.cmake index 1a216d263c8..cb2646188e6 100644 --- a/cmake/prep/options.cmake +++ b/cmake/prep/options.cmake @@ -4,6 +4,8 @@ option(SUNSHINE_CONFIGURE_ONLY "Configure special files only, then exit." OFF) option(SUNSHINE_ENABLE_TRAY "Enable system tray icon. This option will be ignored on macOS." ON) option(SUNSHINE_REQUIRE_TRAY "Require system tray icon. Fail the build if tray requirements are not met." ON) +option(SUNSHINE_SYSTEM_MINIUPNP "Use system installation of MiniUPnP rather than the submodule." OFF) + if(APPLE) option(SUNSHINE_CONFIGURE_PORTFILE "Configure macOS Portfile. Recommended to use with SUNSHINE_CONFIGURE_ONLY" OFF) From faeeb7ec573590c798111024510b2d46c03beaeb Mon Sep 17 00:00:00 2001 From: Timo Gurr Date: Mon, 1 Jan 2024 03:53:16 +0100 Subject: [PATCH 051/197] build(cmake): Use GNUInstallDirs to install data and lib directories (#1817) --- cmake/packaging/linux.cmake | 22 +++++++++++----------- cmake/packaging/unix.cmake | 2 ++ packaging/linux/flatpak/sunshine.desktop | 4 ++-- packaging/linux/sunshine.desktop | 2 +- 4 files changed, 16 insertions(+), 14 deletions(-) diff --git a/cmake/packaging/linux.cmake b/cmake/packaging/linux.cmake index 8106345ffe8..b6ef24e5cbb 100644 --- a/cmake/packaging/linux.cmake +++ b/cmake/packaging/linux.cmake @@ -9,9 +9,9 @@ if(${SUNSHINE_BUILD_APPIMAGE} OR ${SUNSHINE_BUILD_FLATPAK}) DESTINATION "${SUNSHINE_ASSETS_DIR}/systemd/user") else() install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/linux/misc/85-sunshine.rules" - DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/udev/rules.d") + DESTINATION "${CMAKE_INSTALL_LIBDIR}/udev/rules.d") install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.service" - DESTINATION "${CMAKE_INSTALL_PREFIX}/lib/systemd/user") + DESTINATION "${CMAKE_INSTALL_LIBDIR}/systemd/user") endif() # Post install @@ -63,19 +63,19 @@ set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS OFF) # application icon install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/apps") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/apps") # tray icon if(${SUNSHINE_TRAY} STREQUAL 1) install(FILES "${CMAKE_SOURCE_DIR}/sunshine.svg" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status" + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status" RENAME "sunshine-tray.svg") install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-playing.svg" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status") install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-pausing.svg" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status") install(FILES "${SUNSHINE_SOURCE_ASSETS_DIR}/common/assets/web/public/images/sunshine-locked.svg" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/scalable/status") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/scalable/status") set(CPACK_DEBIAN_PACKAGE_DEPENDS "\ ${CPACK_DEBIAN_PACKAGE_DEPENDS}, \ @@ -89,17 +89,17 @@ endif() # desktop file # todo - validate desktop files with `desktop-file-validate` install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.desktop" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/applications") if(NOT ${SUNSHINE_BUILD_APPIMAGE}) install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_terminal.desktop" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/applications") endif() if(${SUNSHINE_BUILD_FLATPAK}) install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine_kms.desktop" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/applications") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/applications") endif() # metadata file # todo - validate file with `appstream-util validate-relax` install(FILES "${CMAKE_CURRENT_BINARY_DIR}/sunshine.appdata.xml" - DESTINATION "${CMAKE_INSTALL_PREFIX}/share/metainfo") + DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/metainfo") diff --git a/cmake/packaging/unix.cmake b/cmake/packaging/unix.cmake index bacbfc910de..d6a4ae93575 100644 --- a/cmake/packaging/unix.cmake +++ b/cmake/packaging/unix.cmake @@ -1,6 +1,8 @@ # unix specific packaging # put anything here that applies to both linux and macos +include(GNUInstallDirs) + # return here if building a macos package if(SUNSHINE_PACKAGE_MACOS) return() diff --git a/packaging/linux/flatpak/sunshine.desktop b/packaging/linux/flatpak/sunshine.desktop index 33124ab842f..be702701e08 100644 --- a/packaging/linux/flatpak/sunshine.desktop +++ b/packaging/linux/flatpak/sunshine.desktop @@ -12,9 +12,9 @@ Actions=RunInTerminal;KMS; [Desktop Action RunInTerminal] Name=Run in Terminal Icon=application-x-executable -Exec=gio launch @CMAKE_INSTALL_PREFIX@/share/applications/sunshine_terminal.desktop +Exec=gio launch @CMAKE_INSTALL_DATAROOTDIR@/applications/sunshine_terminal.desktop [Desktop Action KMS] Name=Run in Terminal (KMS) Icon=application-x-executable -Exec=gio launch @CMAKE_INSTALL_PREFIX@/share/applications/sunshine_kms.desktop +Exec=gio launch @CMAKE_INSTALL_DATAROOTDIR@/applications/sunshine_kms.desktop diff --git a/packaging/linux/sunshine.desktop b/packaging/linux/sunshine.desktop index 6bb8687fd1c..b0f2ce327ec 100644 --- a/packaging/linux/sunshine.desktop +++ b/packaging/linux/sunshine.desktop @@ -12,4 +12,4 @@ Actions=RunInTerminal; [Desktop Action RunInTerminal] Name=Run in Terminal Icon=application-x-executable -Exec=gio launch @CMAKE_INSTALL_PREFIX@/share/applications/sunshine_terminal.desktop +Exec=gio launch @CMAKE_INSTALL_DATAROOTDIR@/applications/sunshine_terminal.desktop From 8d14e7c6f15a3dd5d29f99268bf0fdd4982da753 Mon Sep 17 00:00:00 2001 From: James Le Cuirot Date: Mon, 1 Jan 2024 16:49:00 +0000 Subject: [PATCH 052/197] Optionally allow the system installation of wayland-protocols to be used (#1966) --- cmake/compile_definitions/linux.cmake | 11 +++++++++-- cmake/macros/linux.cmake | 8 ++++---- cmake/prep/options.cmake | 1 + 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/cmake/compile_definitions/linux.cmake b/cmake/compile_definitions/linux.cmake index c4950809196..af35a09d19f 100644 --- a/cmake/compile_definitions/linux.cmake +++ b/cmake/compile_definitions/linux.cmake @@ -129,8 +129,15 @@ endif() if(WAYLAND_FOUND) add_compile_definitions(SUNSHINE_BUILD_WAYLAND) - GEN_WAYLAND("wayland-protocols" "unstable/xdg-output" xdg-output-unstable-v1) - GEN_WAYLAND("wlr-protocols" "unstable" wlr-export-dmabuf-unstable-v1) + if(NOT SUNSHINE_SYSTEM_WAYLAND_PROTOCOLS) + set(WAYLAND_PROTOCOLS_DIR "${CMAKE_SOURCE_DIR}/third-party/wayland-protocols") + else() + pkg_get_variable(WAYLAND_PROTOCOLS_DIR wayland-protocols pkgdatadir) + pkg_check_modules(WAYLAND_PROTOCOLS wayland-protocols REQUIRED) + endif() + + GEN_WAYLAND("${WAYLAND_PROTOCOLS_DIR}" "unstable/xdg-output" xdg-output-unstable-v1) + GEN_WAYLAND("${CMAKE_SOURCE_DIR}/third-party/wlr-protocols" "unstable" wlr-export-dmabuf-unstable-v1) include_directories( SYSTEM diff --git a/cmake/macros/linux.cmake b/cmake/macros/linux.cmake index d84d0452568..0bb5e043bf2 100644 --- a/cmake/macros/linux.cmake +++ b/cmake/macros/linux.cmake @@ -5,17 +5,17 @@ macro(GEN_WAYLAND wayland_directory subdirectory filename) file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/generated-src) message("wayland-scanner private-code \ -${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml \ +${wayland_directory}/${subdirectory}/${filename}.xml \ ${CMAKE_BINARY_DIR}/generated-src/${filename}.c") message("wayland-scanner client-header \ -${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml \ +${wayland_directory}/${subdirectory}/${filename}.xml \ ${CMAKE_BINARY_DIR}/generated-src/${filename}.h") execute_process( COMMAND wayland-scanner private-code - ${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml + ${wayland_directory}/${subdirectory}/${filename}.xml ${CMAKE_BINARY_DIR}/generated-src/${filename}.c COMMAND wayland-scanner client-header - ${CMAKE_SOURCE_DIR}/third-party/${wayland_directory}/${subdirectory}/${filename}.xml + ${wayland_directory}/${subdirectory}/${filename}.xml ${CMAKE_BINARY_DIR}/generated-src/${filename}.h RESULT_VARIABLE EXIT_INT diff --git a/cmake/prep/options.cmake b/cmake/prep/options.cmake index cb2646188e6..dc6b5f6ebc1 100644 --- a/cmake/prep/options.cmake +++ b/cmake/prep/options.cmake @@ -5,6 +5,7 @@ option(SUNSHINE_ENABLE_TRAY "Enable system tray icon. This option will be ignore option(SUNSHINE_REQUIRE_TRAY "Require system tray icon. Fail the build if tray requirements are not met." ON) option(SUNSHINE_SYSTEM_MINIUPNP "Use system installation of MiniUPnP rather than the submodule." OFF) +option(SUNSHINE_SYSTEM_WAYLAND_PROTOCOLS "Use system installation of wayland-protocols rather than the submodule." OFF) if(APPLE) option(SUNSHINE_CONFIGURE_PORTFILE From a452402267ba6f9d7dc6f57fbd3194e5d1c65057 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Mon, 1 Jan 2024 14:42:19 -0500 Subject: [PATCH 053/197] ci(macos): install boost from source (#1954) --- .github/workflows/CI.yml | 48 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 45 insertions(+), 3 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 38907881d2c..64e28c6b3c6 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -504,6 +504,8 @@ jobs: name: MacOS runs-on: macos-11 needs: [check_changelog, setup_release] + env: + BOOST_VERSION: 1.83.0 steps: - name: Checkout @@ -514,10 +516,50 @@ jobs: - name: Setup Dependencies MacOS run: | # install dependencies using homebrew - brew install boost cmake curl node opus pkg-config + brew install cmake curl node openssl opus pkg-config # fix openssl header not found - ln -sf /usr/local/opt/openssl/include/openssl /usr/local/include/openssl + # ln -sf /usr/local/opt/openssl/include/openssl /usr/local/include/openssl + + # by installing boost from source, several headers cannot be found... + # the above commented out link only works if boost is installed from homebrew... does not make sense + ln -sf $(find /usr/local/Cellar -type d -name "openssl" -path "*/openssl@3/*/include" | head -n 1) \ + /usr/local/include/openssl + + # fix opus header not found + ln -sf $(find /usr/local/Cellar -type d -name "opus" -path "*/opus/*/include" | head -n 1) \ + /usr/local/include/opus + + - name: Install Boost + # installing boost from homebrew takes 30 minutes in a GitHub runner + run: | + export BOOST_ROOT=${HOME}/boost-${BOOST_VERSION} + + # install boost + wget \ + https://github.com/boostorg/boost/releases/download/boost-${BOOST_VERSION}/boost-${BOOST_VERSION}.tar.gz \ + --progress=bar:force:noscroll -q --show-progress + tar xf boost-${BOOST_VERSION}.tar.gz + cd boost-${BOOST_VERSION} + + # libdir should be set by --prefix but isn't + ./bootstrap.sh \ + --prefix=${BOOST_ROOT} \ + --libdir=${BOOST_ROOT}/lib \ + --with-libraries=locale,log,program_options,system,thread + ./b2 headers + ./b2 install \ + --prefix=${BOOST_ROOT} \ + --libdir=${BOOST_ROOT}/lib \ + -j$(sysctl -n hw.ncpu) \ + link=shared,static \ + variant=release \ + cxxflags=-std=c++14 \ + cxxflags=-stdlib=libc++ \ + linkflags=-stdlib=libc++ + + # put boost in cmake prefix path + echo "BOOST_ROOT=${BOOST_ROOT}" >> ${GITHUB_ENV} - name: Build MacOS env: @@ -532,7 +574,7 @@ jobs: -DSUNSHINE_ASSETS_DIR=local/sunshine/assets \ -DSUNSHINE_EXECUTABLE_PATH=/usr/bin/sunshine \ .. - make -j ${nproc} + make -j $(sysctl -n hw.ncpu) - name: Package MacOS run: | From c0164caaaae1cb18b740c2762e23601229f96529 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Mon, 1 Jan 2024 18:48:27 -0500 Subject: [PATCH 054/197] builds(deps): use miniupnpc package instead of submodule (#1971) Co-authored-by: Cameron Gutman --- .codeql-prebuild-cpp.sh | 1 + .github/workflows/CI.yml | 12 ++++++++-- .gitmodules | 4 ---- cmake/compile_definitions/windows.cmake | 4 ++++ cmake/dependencies/common.cmake | 22 ++----------------- cmake/prep/options.cmake | 1 - docker/debian-bookworm.dockerfile | 1 + docker/debian-bullseye.dockerfile | 1 + docker/fedora-38.dockerfile | 1 + docker/fedora-39.dockerfile | 1 + docker/ubuntu-20.04.dockerfile | 1 + docker/ubuntu-22.04.dockerfile | 1 + docs/source/building/linux.rst | 4 ++++ docs/source/building/macos.rst | 4 ++-- docs/source/building/windows.rst | 21 ++++++++++++++---- packaging/linux/Arch/PKGBUILD | 1 + .../linux/flatpak/dev.lizardbyte.sunshine.yml | 17 ++++++++++++++ packaging/macos/Portfile | 1 + src/upnp.cpp | 4 ++-- third-party/miniupnp | 1 - 20 files changed, 67 insertions(+), 36 deletions(-) delete mode 160000 third-party/miniupnp diff --git a/.codeql-prebuild-cpp.sh b/.codeql-prebuild-cpp.sh index ba4e4016e0e..c3e09d84e1a 100644 --- a/.codeql-prebuild-cpp.sh +++ b/.codeql-prebuild-cpp.sh @@ -15,6 +15,7 @@ sudo apt-get install -y \ libcurl4-openssl-dev \ libdrm-dev \ libevdev-dev \ + libminiupnpc-dev \ libmfx-dev \ libnotify-dev \ libnuma-dev \ diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 64e28c6b3c6..fb74710eda1 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -350,6 +350,7 @@ jobs: libcurl4-openssl-dev \ libdrm-dev \ libevdev-dev \ + libminiupnpc-dev \ libmfx-dev \ libnotify-dev \ libnuma-dev \ @@ -425,7 +426,9 @@ jobs: fi - name: Set AppImage Version - if: ${{ matrix.type == 'AppImage' && ( needs.check_changelog.outputs.next_version_bare != needs.check_changelog.outputs.last_version ) }} # yamllint disable-line rule:line-length + if: | + matrix.type == 'AppImage' && + (needs.check_changelog.outputs.next_version_bare != needs.check_changelog.outputs.last_version) run: | version=${{ needs.check_changelog.outputs.next_version_bare }} echo "VERSION=${version}" >> $GITHUB_ENV @@ -516,7 +519,7 @@ jobs: - name: Setup Dependencies MacOS run: | # install dependencies using homebrew - brew install cmake curl node openssl opus pkg-config + brew install cmake curl miniupnpc node openssl opus pkg-config # fix openssl header not found # ln -sf /usr/local/opt/openssl/include/openssl /usr/local/include/openssl @@ -530,6 +533,10 @@ jobs: ln -sf $(find /usr/local/Cellar -type d -name "opus" -path "*/opus/*/include" | head -n 1) \ /usr/local/include/opus + # fix miniupnpc header not found + ln -sf $(find /usr/local/Cellar -type d -name "miniupnpc" -path "*/miniupnpc/*/include" | head -n 1) \ + /usr/local/include/miniupnpc + - name: Install Boost # installing boost from homebrew takes 30 minutes in a GitHub runner run: | @@ -757,6 +764,7 @@ jobs: mingw-w64-x86_64-boost mingw-w64-x86_64-cmake mingw-w64-x86_64-curl + mingw-w64-x86_64-miniupnpc mingw-w64-x86_64-nodejs mingw-w64-x86_64-nsis mingw-w64-x86_64-onevpl diff --git a/.gitmodules b/.gitmodules index 108269ff512..cf12ef6b844 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,10 +10,6 @@ path = third-party/ViGEmClient url = https://github.com/nefarius/ViGEmClient branch = master -[submodule "third-party/miniupnp"] - path = third-party/miniupnp - url = https://github.com/miniupnp/miniupnp - branch = master [submodule "third-party/nv-codec-headers"] path = third-party/nv-codec-headers url = https://github.com/FFmpeg/nv-codec-headers diff --git a/cmake/compile_definitions/windows.cmake b/cmake/compile_definitions/windows.cmake index ec3e076f4de..703106f189a 100644 --- a/cmake/compile_definitions/windows.cmake +++ b/cmake/compile_definitions/windows.cmake @@ -11,6 +11,9 @@ add_definitions(-DCURL_STATICLIB) include_directories(SYSTEM ${CURL_STATIC_INCLUDE_DIRS}) link_directories(${CURL_STATIC_LIBRARY_DIRS}) +# miniupnpc +add_definitions(-DMINIUPNP_STATICLIB) + # extra tools/binaries for audio/display devices add_subdirectory(tools) # todo - this is temporary, only tools for Windows are needed, for now @@ -70,6 +73,7 @@ list(PREPEND PLATFORM_LIBRARIES userenv synchronization.lib avrt + iphlpapi ${CURL_STATIC_LIBRARIES}) if(SUNSHINE_ENABLE_TRAY) diff --git a/cmake/dependencies/common.cmake b/cmake/dependencies/common.cmake index 1113832c921..8aeb92a8d87 100644 --- a/cmake/dependencies/common.cmake +++ b/cmake/dependencies/common.cmake @@ -16,26 +16,8 @@ find_package(Threads REQUIRED) pkg_check_modules(CURL REQUIRED libcurl) # miniupnp -if(SUNSHINE_SYSTEM_MINIUPNP) - pkg_check_modules(MINIUPNP miniupnpc REQUIRED) - - # Use includedir pkg-config variable rather than MINIUPNP_INCLUDE_DIRS - # defined above. The latter may be blank, as pkg-config sometimes omits -I - # flags for directories that are searched by default (e.g. /usr/include), - # but we need a value to append /miniupnpc to. Normally source files would - # prefix their #include directives with miniupnpc/, but this does not align - # with the directory structure of the git submodule used below. - pkg_get_variable(MINIUPNP_INCLUDE_DIR miniupnpc includedir) - include_directories(SYSTEM ${MINIUPNP_INCLUDE_DIR}/miniupnpc) -else() - set(UPNPC_BUILD_SHARED OFF CACHE BOOL "No shared libraries") - set(UPNPC_BUILD_TESTS OFF CACHE BOOL "Don't build tests for miniupnpc") - set(UPNPC_BUILD_SAMPLE OFF CACHE BOOL "Don't build samples for miniupnpc") - set(UPNPC_NO_INSTALL ON CACHE BOOL "Don't install any libraries build for miniupnpc") - set(MINIUPNP_LIBRARIES libminiupnpc-static) - add_subdirectory(third-party/miniupnp/miniupnpc) - include_directories(SYSTEM third-party/miniupnp/miniupnpc/include) -endif() +pkg_check_modules(MINIUPNP miniupnpc REQUIRED) +include_directories(SYSTEM ${MINIUPNP_INCLUDE_DIRS}) # ffmpeg pre-compiled binaries if(WIN32) diff --git a/cmake/prep/options.cmake b/cmake/prep/options.cmake index dc6b5f6ebc1..0198decb2b1 100644 --- a/cmake/prep/options.cmake +++ b/cmake/prep/options.cmake @@ -4,7 +4,6 @@ option(SUNSHINE_CONFIGURE_ONLY "Configure special files only, then exit." OFF) option(SUNSHINE_ENABLE_TRAY "Enable system tray icon. This option will be ignored on macOS." ON) option(SUNSHINE_REQUIRE_TRAY "Require system tray icon. Fail the build if tray requirements are not met." ON) -option(SUNSHINE_SYSTEM_MINIUPNP "Use system installation of MiniUPnP rather than the submodule." OFF) option(SUNSHINE_SYSTEM_WAYLAND_PROTOCOLS "Use system installation of wayland-protocols rather than the submodule." OFF) if(APPLE) diff --git a/docker/debian-bookworm.dockerfile b/docker/debian-bookworm.dockerfile index c9d4fccdede..6eb1108bf11 100644 --- a/docker/debian-bookworm.dockerfile +++ b/docker/debian-bookworm.dockerfile @@ -43,6 +43,7 @@ apt-get install -y --no-install-recommends \ libcurl4-openssl-dev \ libdrm-dev \ libevdev-dev \ + libminiupnpc-dev \ libnotify-dev \ libnuma-dev \ libopus-dev \ diff --git a/docker/debian-bullseye.dockerfile b/docker/debian-bullseye.dockerfile index 3e602105cb2..d9862432cec 100644 --- a/docker/debian-bullseye.dockerfile +++ b/docker/debian-bullseye.dockerfile @@ -44,6 +44,7 @@ apt-get install -y --no-install-recommends \ libcurl4-openssl-dev \ libdrm-dev \ libevdev-dev \ + libminiupnpc-dev \ libnotify-dev \ libnuma-dev \ libopus-dev \ diff --git a/docker/fedora-38.dockerfile b/docker/fedora-38.dockerfile index 9f836fb889a..5408782d074 100644 --- a/docker/fedora-38.dockerfile +++ b/docker/fedora-38.dockerfile @@ -52,6 +52,7 @@ dnf -y install \ libXrandr-devel \ libXtst-devel \ mesa-libGL-devel \ + miniupnpc-devel \ nodejs \ numactl-devel \ openssl-devel \ diff --git a/docker/fedora-39.dockerfile b/docker/fedora-39.dockerfile index 26b10f4b004..cc781a6730f 100644 --- a/docker/fedora-39.dockerfile +++ b/docker/fedora-39.dockerfile @@ -52,6 +52,7 @@ dnf -y install \ libXrandr-devel \ libXtst-devel \ mesa-libGL-devel \ + miniupnpc-devel \ nodejs \ numactl-devel \ openssl-devel \ diff --git a/docker/ubuntu-20.04.dockerfile b/docker/ubuntu-20.04.dockerfile index bad8285d648..4715475ac6e 100644 --- a/docker/ubuntu-20.04.dockerfile +++ b/docker/ubuntu-20.04.dockerfile @@ -45,6 +45,7 @@ apt-get install -y --no-install-recommends \ libcurl4-openssl-dev \ libdrm-dev \ libevdev-dev \ + libminiupnpc-dev \ libnotify-dev \ libnuma-dev \ libopus-dev \ diff --git a/docker/ubuntu-22.04.dockerfile b/docker/ubuntu-22.04.dockerfile index 2f37a691bc7..0e975df0558 100644 --- a/docker/ubuntu-22.04.dockerfile +++ b/docker/ubuntu-22.04.dockerfile @@ -44,6 +44,7 @@ apt-get install -y --no-install-recommends \ libcurl4-openssl-dev \ libdrm-dev \ libevdev-dev \ + libminiupnpc-dev \ libnotify-dev \ libnuma-dev \ libopus-dev \ diff --git a/docs/source/building/linux.rst b/docs/source/building/linux.rst index eab0aaab607..e3d51f6a57f 100644 --- a/docs/source/building/linux.rst +++ b/docs/source/building/linux.rst @@ -25,6 +25,7 @@ Install Requirements libcurl4-openssl-dev \ libdrm-dev \ # KMS libevdev-dev \ + libminiupnpc-dev \ libmfx-dev \ # x86_64 only libnotify-dev \ libnuma-dev \ @@ -77,6 +78,7 @@ Install Requirements libXrandr-devel \ # X11 libXtst-devel \ # X11 mesa-libGL-devel \ + miniupnpc-devel \ npm \ numactl-devel \ openssl-devel \ @@ -106,6 +108,7 @@ Install Requirements libcap-dev \ # KMS libdrm-dev \ # KMS libevdev-dev \ + libminiupnpc-dev \ libmfx-dev \ # x86_64 only libnotify-dev \ libnuma-dev \ @@ -155,6 +158,7 @@ Install Requirements libcap-dev \ # KMS libdrm-dev \ # KMS libevdev-dev \ + libminiupnpc-dev \ libmfx-dev \ # x86_64 only libnotify-dev \ libnuma-dev \ diff --git a/docs/source/building/macos.rst b/docs/source/building/macos.rst index 6bfa2c7061e..d64e4572a6e 100644 --- a/docs/source/building/macos.rst +++ b/docs/source/building/macos.rst @@ -12,14 +12,14 @@ MacPorts Install Requirements .. code-block:: bash - sudo port install avahi boost180 cmake curl libopus npm9 pkgconfig + sudo port install avahi boost180 cmake curl libopus miniupnpc npm9 pkgconfig Homebrew """""""" Install Requirements .. code-block:: bash - brew install boost cmake node opus pkg-config + brew install boost cmake miniupnpc node opus pkg-config # if there are issues with an SSL header that is not found: cd /usr/local/include ln -s ../opt/openssl/include/openssl . diff --git a/docs/source/building/windows.rst b/docs/source/building/windows.rst index a8164d3cb20..6c8b844fdac 100644 --- a/docs/source/building/windows.rst +++ b/docs/source/building/windows.rst @@ -14,10 +14,23 @@ Update all packages: Install dependencies: .. code-block:: bash - pacman -S base-devel cmake diffutils gcc git 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-nodejs mingw-w64-x86_64-onevpl mingw-w64-x86_64-openssl \ - mingw-w64-x86_64-opus mingw-w64-x86_64-toolchain + pacman -S \ + base-devel \ + cmake \ + diffutils \ + gcc \ + git \ + 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-miniupnpc \ + mingw-w64-x86_64-nodejs \ + mingw-w64-x86_64-onevpl \ + mingw-w64-x86_64-openssl \ + mingw-w64-x86_64-opus \ + mingw-w64-x86_64-toolchain Build ----- diff --git a/packaging/linux/Arch/PKGBUILD b/packaging/linux/Arch/PKGBUILD index c14b40db243..a0ceb6b5684 100644 --- a/packaging/linux/Arch/PKGBUILD +++ b/packaging/linux/Arch/PKGBUILD @@ -24,6 +24,7 @@ depends=('avahi' 'libxfixes' 'libxrandr' 'libxtst' + 'miniupnpc' 'numactl' 'openssl' 'opus' diff --git a/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml b/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml index d4f0c164753..b62f0e1d667 100644 --- a/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml +++ b/packaging/linux/flatpak/dev.lizardbyte.sunshine.yml @@ -253,6 +253,23 @@ modules: commands: - for n in $(cat patches/series); do if [[ $n != "#"* ]]; then patch -Np1 -i "patches/$n" -d .; fi; done + - name: miniupnpc + buildsystem: cmake + config-opts: + - -DUPNPC_BUILD_SAMPLE=OFF + - -DUPNPC_BUILD_SHARED=ON + - -DUPNPC_BUILD_TESTS=OFF + sources: + - type: archive + url: http://archive.ubuntu.com/ubuntu/pool/main/m/miniupnpc/miniupnpc_2.2.5.orig.tar.gz + sha256: 38acd5f4602f7cf8bcdc1ec30b2d58db2e9912e5d9f5350dd99b06bfdffb517c + - type: archive + url: http://archive.ubuntu.com/ubuntu/pool/main/m/miniupnpc/miniupnpc_2.2.5-1.debian.tar.xz + sha256: f6ab181f3c999ae0630508ea1e6c76ae302262414061acaab12bf8763431ffd1 + - type: shell + commands: + - for n in $(cat patches/series); do if [[ $n != "#"* ]]; then patch -Np1 -i "patches/$n" -d .; fi; done + - name: numactl buildsystem: autotools make-args: diff --git a/packaging/macos/Portfile b/packaging/macos/Portfile index 73a775a1dc5..19aeccf2dbd 100644 --- a/packaging/macos/Portfile +++ b/packaging/macos/Portfile @@ -34,6 +34,7 @@ post-fetch { depends_lib port:avahi \ port:curl \ port:libopus \ + port:miniupnpc \ port:npm9 \ port:pkgconfig diff --git a/src/upnp.cpp b/src/upnp.cpp index 55ef25fd173..7a296a8b358 100644 --- a/src/upnp.cpp +++ b/src/upnp.cpp @@ -2,8 +2,8 @@ * @file src/upnp.cpp * @brief todo */ -#include -#include +#include +#include #include "config.h" #include "confighttp.h" diff --git a/third-party/miniupnp b/third-party/miniupnp deleted file mode 160000 index fb5c328a5e8..00000000000 --- a/third-party/miniupnp +++ /dev/null @@ -1 +0,0 @@ -Subproject commit fb5c328a5e8fd57a3ec0f5d33915377a5d3581f3 From 852db4877d69ed24509ea27672ccca74ed9c62ac Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Mon, 1 Jan 2024 19:36:00 -0500 Subject: [PATCH 055/197] refactor(process): re-order variables to avoid unused variable when tray is disabled (#1963) --- src/process.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/process.cpp b/src/process.cpp index 227c6fda148..bacaf754204 100644 --- a/src/process.cpp +++ b/src/process.cpp @@ -258,13 +258,11 @@ namespace proc { void proc_t::terminate() { - bool has_run = _app_id > 0; std::error_code ec; placebo = false; process_end(_process, _process_handle); _process = bp::child(); _process_handle = bp::group(); - _app_id = -1; for (; _app_prep_it != _app_prep_begin; --_app_prep_it) { auto &cmd = *(_app_prep_it - 1); @@ -293,12 +291,16 @@ namespace proc { _pipe.reset(); #if defined SUNSHINE_TRAY && SUNSHINE_TRAY >= 1 + bool has_run = _app_id > 0; + // Only show the Stopped notification if we actually have an app to stop // Since terminate() is always run when a new app has started if (proc::proc.get_last_run_app_name().length() > 0 && has_run) { system_tray::update_tray_stopped(proc::proc.get_last_run_app_name()); } #endif + + _app_id = -1; } const std::vector & From 97c921629a5b354fa303be14dfb63207b37c3fae Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 31 Dec 2023 18:59:51 -0600 Subject: [PATCH 056/197] Move Alt to Windows mapping option to Input tab --- src_assets/common/assets/web/config.html | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 7d3b01cacb1..ccf2b6aa5d7 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -179,18 +179,6 @@

    This setting does not change how the screen stream is sent to Moonlight

- -
- - -
- It may be possible that you cannot send the Windows Key from Moonlight directly.
- In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key -
-
@@ -359,6 +347,18 @@

Disable if keys on the client are generating the wrong input on the host.

+ +
+ + +
+ It may be possible that you cannot send the Windows Key from Moonlight directly.
+ In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key +
+
From 6ea836c511f3ffffffdff72dfd885644401a99d2 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 31 Dec 2023 19:01:37 -0600 Subject: [PATCH 057/197] Add options to control gamepad autoselection heuristics Also move gamepad type selection to the input tab while we're here --- docs/source/about/advanced_usage.rst | 36 ++++++++ src/config.cpp | 4 + src/config.h | 2 + src/platform/windows/input.cpp | 24 +++++- src_assets/common/assets/web/config.html | 103 +++++++++++++++-------- 5 files changed, 133 insertions(+), 36 deletions(-) diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index 0b4a687b6fe..729265573d6 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -170,6 +170,42 @@ ds4_back_as_touchpad_click ds4_back_as_touchpad_click = enabled +motion_as_ds4 +^^^^^^^^^^^^^ + +**Description** + .. Hint:: Only applies when gamepad is set to auto. + + If a client reports that a connected gamepad has motion sensor support, emulate it on the host as a DS4 controller. + + When disabled, motion sensors will not be taken into account during gamepad type selection. + +**Default** + ``enabled`` + +**Example** + .. code-block:: text + + motion_as_ds4 = enabled + +touchpad_as_ds4 +^^^^^^^^^^^^^^^ + +**Description** + .. Hint:: Only applies when gamepad is set to auto. + + If a client reports that a connected gamepad has a touchpad, emulate it on the host as a DS4 controller. + + When disabled, touchpad presence will not be taken into account during gamepad type selection. + +**Default** + ``enabled`` + +**Example** + .. code-block:: text + + touchpad_as_ds4 = enabled + back_button_timeout ^^^^^^^^^^^^^^^^^^^ diff --git a/src/config.cpp b/src/config.cpp index 74bb612137c..030bdb1da22 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -420,6 +420,8 @@ namespace config { platf::supported_gamepads().front().size(), }, // Default gamepad true, // back as touchpad click enabled (manual DS4 only) + true, // client gamepads with motion events are emulated as DS4 + true, // client gamepads with touchpads are emulated as DS4 true, // keyboard enabled true, // mouse enabled @@ -1048,6 +1050,8 @@ namespace config { string_restricted_f(vars, "gamepad"s, input.gamepad, platf::supported_gamepads()); bool_f(vars, "ds4_back_as_touchpad_click", input.ds4_back_as_touchpad_click); + bool_f(vars, "motion_as_ds4", input.motion_as_ds4); + bool_f(vars, "touchpad_as_ds4", input.touchpad_as_ds4); bool_f(vars, "mouse", input.mouse); bool_f(vars, "keyboard", input.keyboard); diff --git a/src/config.h b/src/config.h index 6e481a1f641..9df7a144d2e 100644 --- a/src/config.h +++ b/src/config.h @@ -113,6 +113,8 @@ namespace config { std::string gamepad; bool ds4_back_as_touchpad_click; + bool motion_as_ds4; + bool touchpad_as_ds4; bool keyboard; bool mouse; diff --git a/src/platform/windows/input.cpp b/src/platform/windows/input.cpp index ab4d7262417..5559719bfd7 100644 --- a/src/platform/windows/input.cpp +++ b/src/platform/windows/input.cpp @@ -1188,11 +1188,11 @@ namespace platf { BOOST_LOG(info) << "Gamepad " << id.globalIndex << " will be Xbox 360 controller (auto-selected by client-reported type)"sv; selectedGamepadType = Xbox360Wired; } - else if (metadata.capabilities & (LI_CCAP_ACCEL | LI_CCAP_GYRO)) { + else if (config::input.motion_as_ds4 && (metadata.capabilities & (LI_CCAP_ACCEL | LI_CCAP_GYRO))) { BOOST_LOG(info) << "Gamepad " << id.globalIndex << " will be DualShock 4 controller (auto-selected by motion sensor presence)"sv; selectedGamepadType = DualShock4Wired; } - else if (metadata.capabilities & LI_CCAP_TOUCHPAD) { + else if (config::input.touchpad_as_ds4 && (metadata.capabilities & LI_CCAP_TOUCHPAD)) { BOOST_LOG(info) << "Gamepad " << id.globalIndex << " will be DualShock 4 controller (auto-selected by touchpad presence)"sv; selectedGamepadType = DualShock4Wired; } @@ -1201,6 +1201,26 @@ namespace platf { selectedGamepadType = Xbox360Wired; } + if (selectedGamepadType == Xbox360Wired) { + if (metadata.capabilities & (LI_CCAP_ACCEL | LI_CCAP_GYRO)) { + BOOST_LOG(warning) << "Gamepad " << id.globalIndex << " has motion sensors, but they are not usable when emulating an Xbox 360 controller"sv; + } + if (metadata.capabilities & LI_CCAP_TOUCHPAD) { + BOOST_LOG(warning) << "Gamepad " << id.globalIndex << " has a touchpad, but it is not usable when emulating an Xbox 360 controller"sv; + } + if (metadata.capabilities & LI_CCAP_RGB_LED) { + BOOST_LOG(warning) << "Gamepad " << id.globalIndex << " has an RGB LED, but it is not usable when emulating an Xbox 360 controller"sv; + } + } + else if (selectedGamepadType == DualShock4Wired) { + if (!(metadata.capabilities & (LI_CCAP_ACCEL | LI_CCAP_GYRO))) { + BOOST_LOG(warning) << "Gamepad " << id.globalIndex << " is emulating a DualShock 4 controller, but the client gamepad doesn't have motion sensors active"sv; + } + if (!(metadata.capabilities & LI_CCAP_TOUCHPAD)) { + BOOST_LOG(warning) << "Gamepad " << id.globalIndex << " is emulating a DualShock 4 controller, but the client gamepad doesn't have a touchpad"sv; + } + } + return raw->vigem->alloc_gamepad_internal(id, feedback_queue, selectedGamepadType); } diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index ccf2b6aa5d7..d49bee691df 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -90,40 +90,6 @@

Configuration

Automatically configure port forwarding
- -
- - -
Choose which type of gamepad to emulate on the host
-
-
-
-

- -

-
-
-
- - -
When forcing DS4 emulation, map Back/Select to Touchpad Click
-
-
-
-
-
@@ -266,6 +232,73 @@

+ +
+ + +
Choose which type of gamepad to emulate on the host
+
+
+
+

+ +

+
+
+
+ + +
When forcing DS4 emulation, map Back/Select to Touchpad Click
+
+
+
+
+
+
+
+

+ +

+
+
+
+ + +
If disabled, motion sensors will not be taken into account during gamepad type selection.
+
+
+ + +
If disabled, touchpad presence will not be taken into account during gamepad type selection.
+
+
+
+
+
@@ -829,6 +862,7 @@

"key_rightalt_to_key_win": "disabled", "keyboard": "enabled", "min_log_level": 2, + "motion_as_ds4": "enabled", "mouse": "enabled", "nvenc_h264_cavlc": "disabled", "nvenc_preset": "1", @@ -840,6 +874,7 @@

"resolutions": "[352x240,480x360,858x480,1280x720,1920x1080,2560x1080,3440x1440,1920x1200,3840x2160,3840x1600]", "sw_preset": "superfast", "sw_tune": "zerolatency", + "touchpad_as_ds4": "enabled", "upnp": "disabled", "vt_coder": "auto", "vt_realtime": "enabled", From 729922d2c0a0b6f7cbca49102d1b38fb3e686047 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 31 Dec 2023 19:02:36 -0600 Subject: [PATCH 058/197] Add option to disable high resolution scroll events --- docs/source/about/advanced_usage.rst | 16 +++++++ src/config.cpp | 2 + src/config.h | 2 + src/input.cpp | 56 +++++++++++++++++++++--- src_assets/common/assets/web/config.html | 13 ++++++ 5 files changed, 82 insertions(+), 7 deletions(-) diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index 729265573d6..c2726347287 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -273,6 +273,22 @@ always_send_scancodes always_send_scancodes = enabled +high_resolution_scrolling +^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Description** + When enabled, Sunshine will pass through high resolution scroll events from Moonlight clients. + + This can be useful to disable for older applications that scroll too fast with high resolution scroll events. + +**Default** + ``enabled`` + +**Example** + .. code-block:: text + + high_resolution_scrolling = enabled + keybindings ^^^^^^^^^^^ diff --git a/src/config.cpp b/src/config.cpp index 030bdb1da22..c0c4d59ff07 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -427,6 +427,7 @@ namespace config { true, // mouse enabled true, // controller enabled true, // always send scancodes + true, // high resolution scrolling }; sunshine_t sunshine { @@ -1059,6 +1060,7 @@ namespace config { bool_f(vars, "always_send_scancodes", input.always_send_scancodes); + bool_f(vars, "high_resolution_scrolling", input.high_resolution_scrolling); int port = sunshine.port; int_between_f(vars, "port"s, port, { 1024 + nvhttp::PORT_HTTPS, 65535 - rtsp_stream::RTSP_SETUP_PORT }); sunshine.port = (std::uint16_t) port; diff --git a/src/config.h b/src/config.h index 9df7a144d2e..ce1cc4182e8 100644 --- a/src/config.h +++ b/src/config.h @@ -121,6 +121,8 @@ namespace config { bool controller; bool always_send_scancodes; + + bool high_resolution_scrolling; }; namespace flag { diff --git a/src/input.cpp b/src/input.cpp index a2c85256031..63c10d8be77 100644 --- a/src/input.cpp +++ b/src/input.cpp @@ -25,6 +25,11 @@ extern "C" { #include +// Win32 WHEEL_DELTA constant +#ifndef WHEEL_DELTA + #define WHEEL_DELTA 120 +#endif + using namespace std::literals; namespace input { @@ -160,7 +165,9 @@ namespace input { touch_port_event { std::move(touch_port_event) }, feedback_queue { std::move(feedback_queue) }, mouse_left_button_timeout {}, - touch_port { { 0, 0, 0, 0 }, 0, 0, 1.0f } {} + touch_port { { 0, 0, 0, 0 }, 0, 0, 1.0f }, + accumulated_vscroll_delta {}, + accumulated_hscroll_delta {} {} // Keep track of alt+ctrl+shift key combo int shortcutFlags; @@ -177,6 +184,9 @@ namespace input { thread_pool_util::ThreadPool::task_id_t mouse_left_button_timeout; input::touch_port_t touch_port; + + int32_t accumulated_vscroll_delta; + int32_t accumulated_hscroll_delta; }; /** @@ -790,22 +800,54 @@ namespace input { update_shortcutFlags(&input->shortcutFlags, map_keycode(keyCode), release); } + /** + * @brief Called to pass a vertical scroll message the platform backend. + * @param input The input context pointer. + * @param packet The scroll packet. + */ void - passthrough(PNV_SCROLL_PACKET packet) { + passthrough(std::shared_ptr &input, PNV_SCROLL_PACKET packet) { if (!config::input.mouse) { return; } - platf::scroll(platf_input, util::endian::big(packet->scrollAmt1)); + if (config::input.high_resolution_scrolling) { + platf::scroll(platf_input, util::endian::big(packet->scrollAmt1)); + } + else { + input->accumulated_vscroll_delta += util::endian::big(packet->scrollAmt1); + auto full_ticks = input->accumulated_vscroll_delta / WHEEL_DELTA; + if (full_ticks) { + // Send any full ticks that have accumulated and store the rest + platf::scroll(platf_input, full_ticks * WHEEL_DELTA); + input->accumulated_vscroll_delta -= full_ticks * WHEEL_DELTA; + } + } } + /** + * @brief Called to pass a horizontal scroll message the platform backend. + * @param input The input context pointer. + * @param packet The scroll packet. + */ void - passthrough(PSS_HSCROLL_PACKET packet) { + passthrough(std::shared_ptr &input, PSS_HSCROLL_PACKET packet) { if (!config::input.mouse) { return; } - platf::hscroll(platf_input, util::endian::big(packet->scrollAmount)); + if (config::input.high_resolution_scrolling) { + platf::hscroll(platf_input, util::endian::big(packet->scrollAmount)); + } + else { + input->accumulated_hscroll_delta += util::endian::big(packet->scrollAmount); + auto full_ticks = input->accumulated_hscroll_delta / WHEEL_DELTA; + if (full_ticks) { + // Send any full ticks that have accumulated and store the rest + platf::hscroll(platf_input, full_ticks * WHEEL_DELTA); + input->accumulated_hscroll_delta -= full_ticks * WHEEL_DELTA; + } + } } void @@ -1540,10 +1582,10 @@ namespace input { passthrough(input, (PNV_MOUSE_BUTTON_PACKET) payload); break; case SCROLL_MAGIC_GEN5: - passthrough((PNV_SCROLL_PACKET) payload); + passthrough(input, (PNV_SCROLL_PACKET) payload); break; case SS_HSCROLL_MAGIC: - passthrough((PSS_HSCROLL_PACKET) payload); + passthrough(input, (PSS_HSCROLL_PACKET) payload); break; case KEY_DOWN_EVENT_MAGIC: case KEY_UP_EVENT_MAGIC: diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index d49bee691df..49a51dcf3a1 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -392,6 +392,18 @@

In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key

+ +
+ + +
+ When enabled, Sunshine will pass through high resolution scroll events from Moonlight clients.
+ This can be useful to disable for older applications that scroll too fast with high resolution scroll events. +
+
@@ -851,6 +863,7 @@

"amd_vbaq": "enabled", "capture": "", "controller": "enabled", + "high_resolution_scrolling": "enabled", "install_steam_audio_drivers": "enabled", "ds4_back_as_touchpad_click": "enabled", "dwmflush": "enabled", From 3ca75bee1962aacbf4a022d1e531ec2ffece202a Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 31 Dec 2023 19:03:07 -0600 Subject: [PATCH 059/197] Add option to disable native pen/touch support --- docs/source/about/advanced_usage.rst | 18 ++++++++++++++++++ src/config.cpp | 3 +++ src/config.h | 1 + src/platform/windows/input.cpp | 4 +++- src_assets/common/assets/web/config.html | 13 +++++++++++++ 5 files changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index c2726347287..dc6e5f165ec 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -289,6 +289,24 @@ high_resolution_scrolling high_resolution_scrolling = enabled +native_pen_touch +^^^^^^^^^^^^^^^^ + +**Description** + When enabled, Sunshine will pass through native pen/touch events from Moonlight clients. + + This can be useful to disable for older applications without native pen/touch support. + + .. Caution:: Applies to Windows only. + +**Default** + ``enabled`` + +**Example** + .. code-block:: text + + native_pen_touch = enabled + keybindings ^^^^^^^^^^^ diff --git a/src/config.cpp b/src/config.cpp index c0c4d59ff07..cde646a7718 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -428,6 +428,7 @@ namespace config { true, // controller enabled true, // always send scancodes true, // high resolution scrolling + true, // native pen/touch support }; sunshine_t sunshine { @@ -1061,6 +1062,8 @@ namespace config { bool_f(vars, "always_send_scancodes", input.always_send_scancodes); bool_f(vars, "high_resolution_scrolling", input.high_resolution_scrolling); + bool_f(vars, "native_pen_touch", input.native_pen_touch); + int port = sunshine.port; int_between_f(vars, "port"s, port, { 1024 + nvhttp::PORT_HTTPS, 65535 - rtsp_stream::RTSP_SETUP_PORT }); sunshine.port = (std::uint16_t) port; diff --git a/src/config.h b/src/config.h index ce1cc4182e8..44b89974627 100644 --- a/src/config.h +++ b/src/config.h @@ -123,6 +123,7 @@ namespace config { bool always_send_scancodes; bool high_resolution_scrolling; + bool native_pen_touch; }; namespace flag { diff --git a/src/platform/windows/input.cpp b/src/platform/windows/input.cpp index 5559719bfd7..b978748b906 100644 --- a/src/platform/windows/input.cpp +++ b/src/platform/windows/input.cpp @@ -1720,7 +1720,9 @@ namespace platf { // We support pen and touch input on Win10 1809+ if (GetProcAddress(GetModuleHandleA("user32.dll"), "CreateSyntheticPointerDevice") != nullptr) { - caps |= platform_caps::pen_touch; + if (config::input.native_pen_touch) { + caps |= platform_caps::pen_touch; + } } else { BOOST_LOG(warning) << "Touch input requires Windows 10 1809 or later"sv; diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 49a51dcf3a1..71fc09d9e81 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -404,6 +404,18 @@

This can be useful to disable for older applications that scroll too fast with high resolution scroll events.

+ +
+ + +
+ When enabled, Sunshine will pass through native pen/touch events from Moonlight clients.
+ This can be useful to disable for older applications without native pen/touch support. +
+
@@ -877,6 +889,7 @@

"min_log_level": 2, "motion_as_ds4": "enabled", "mouse": "enabled", + "native_pen_touch": "enabled", "nvenc_h264_cavlc": "disabled", "nvenc_preset": "1", "nvenc_realtime_hags": "enabled", From caf5e02d8bd623ee17cf7087b1ac3abca8b66527 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 31 Dec 2023 19:56:04 -0600 Subject: [PATCH 060/197] Alphabetize defaultConfig --- src_assets/common/assets/web/config.html | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src_assets/common/assets/web/config.html b/src_assets/common/assets/web/config.html index 71fc09d9e81..ab370ee92a8 100644 --- a/src_assets/common/assets/web/config.html +++ b/src_assets/common/assets/web/config.html @@ -863,7 +863,9 @@

import { createApp } from 'vue' import Navbar from './Navbar.vue' - // create dictionary for defaultConfig + // Create dictionary for defaultConfig + // + // Note: Please keep this in alphabetical order! const defaultConfig = { "address_family": "ipv4", "always_send_scancodes": "enabled", @@ -873,17 +875,18 @@

"amd_rc": "vbr_latency", "amd_usage": "ultralowlatency", "amd_vbaq": "enabled", + "av1_mode": 0, "capture": "", "controller": "enabled", - "high_resolution_scrolling": "enabled", - "install_steam_audio_drivers": "enabled", "ds4_back_as_touchpad_click": "enabled", "dwmflush": "enabled", "encoder": "", "fps": "[10,30,60,90,120]", "gamepad": "auto", + "global_prep_cmd": "[]", "hevc_mode": 0, - "av1_mode": 0, + "high_resolution_scrolling": "enabled", + "install_steam_audio_drivers": "enabled", "key_rightalt_to_key_win": "disabled", "keyboard": "enabled", "min_log_level": 2, @@ -905,7 +908,6 @@

"vt_coder": "auto", "vt_realtime": "enabled", "vt_software": "auto", - "global_prep_cmd": "[]", } const app = createApp({ From 9a3106fcef185f7ccae42d170c42944ffb6e270d Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Tue, 2 Jan 2024 17:25:32 -0500 Subject: [PATCH 061/197] fix(ui): fix missing favicon (#1972) --- src_assets/common/assets/web/template_header.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src_assets/common/assets/web/template_header.html b/src_assets/common/assets/web/template_header.html index db271b3745a..ef0824971f6 100644 --- a/src_assets/common/assets/web/template_header.html +++ b/src_assets/common/assets/web/template_header.html @@ -3,7 +3,7 @@ Sunshine - + From e7a3c485ee7e7c36d57cb6cd92b5d632fdb27255 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Sun, 31 Dec 2023 19:42:48 -0600 Subject: [PATCH 062/197] Only keep the ViGEmBus connection alive while gamepads are attached --- src/platform/windows/input.cpp | 42 +++++++++++++++++++++++++++------- 1 file changed, 34 insertions(+), 8 deletions(-) diff --git a/src/platform/windows/input.cpp b/src/platform/windows/input.cpp index b978748b906..65d89c0eb9c 100644 --- a/src/platform/windows/input.cpp +++ b/src/platform/windows/input.cpp @@ -192,17 +192,16 @@ namespace platf { public: int init() { - VIGEM_ERROR status; - - client.reset(vigem_alloc()); - - status = vigem_connect(client.get()); + // Probe ViGEm during startup to see if we can successfully attach gamepads. This will allow us to + // immediately display the error message in the web UI even before the user tries to stream. + client_t client { vigem_alloc() }; + VIGEM_ERROR status = vigem_connect(client.get()); if (!VIGEM_SUCCESS(status)) { - BOOST_LOG(warning) << "Couldn't setup connection to ViGEm for gamepad support ["sv << util::hex(status).to_string_view() << ']'; - // Log a special fatal message for this case to show the error in the web UI BOOST_LOG(fatal) << "ViGEmBus is not installed or running. You must install ViGEmBus for gamepad support!"sv; - return -1; + } + else { + vigem_disconnect(client.get()); } gamepads.resize(MAX_GAMEPADS); @@ -225,6 +224,19 @@ namespace platf { gamepad.client_relative_index = id.clientRelativeIndex; gamepad.last_report_ts = std::chrono::steady_clock::now(); + // Establish a connect to the ViGEm driver if we don't have one yet + if (!client) { + BOOST_LOG(debug) << "Connecting to ViGEmBus driver"sv; + client.reset(vigem_alloc()); + + auto status = vigem_connect(client.get()); + if (!VIGEM_SUCCESS(status)) { + BOOST_LOG(warning) << "Couldn't setup connection to ViGEm for gamepad support ["sv << util::hex(status).to_string_view() << ']'; + client.reset(); + return -1; + } + } + if (gp_type == Xbox360Wired) { gamepad.gp.reset(vigem_target_x360_alloc()); XUSB_REPORT_INIT(&gamepad.report.x360); @@ -291,6 +303,20 @@ namespace platf { } gamepad.gp.reset(); + + // Disconnect from ViGEm if we just removed the last gamepad + bool disconnect = true; + for (auto &gamepad : gamepads) { + if (gamepad.gp && vigem_target_is_attached(gamepad.gp.get())) { + disconnect = false; + break; + } + } + if (disconnect) { + BOOST_LOG(debug) << "Disconnecting from ViGEmBus driver"sv; + vigem_disconnect(client.get()); + client.reset(); + } } /** From 52e5662dd9981b38efc8b98b1d8843d4cb8e3b0f Mon Sep 17 00:00:00 2001 From: Mariotaku Date: Thu, 4 Jan 2024 06:04:21 +0900 Subject: [PATCH 063/197] docs: add reset credential examples for unique pacakges (#1973) --- docs/source/troubleshooting/general.rst | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/source/troubleshooting/general.rst b/docs/source/troubleshooting/general.rst index a936f35aa33..f37effeac57 100644 --- a/docs/source/troubleshooting/general.rst +++ b/docs/source/troubleshooting/general.rst @@ -4,9 +4,24 @@ General Forgotten Credentials --------------------- If you forgot your credentials to the web UI, try this. - .. code-block:: bash + .. tab:: General + + .. code-block:: bash + + sunshine --creds {new-username} {new-password} + + .. tab:: AppImage + + .. code-block:: bash + + ./sunshine.AppImage --creds {new-username} {new-password} + + .. tab:: Flatpak + + .. code-block:: bash + + flatpak run --command=sunshine dev.lizardbyte.Sunshine --creds {new-username} {new-password} - sunshine --creds {new-username} {new-password} Web UI Access ------------- From beb51cc9255c9b0d9d316c4f461f16d415caf620 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Tue, 2 Jan 2024 21:33:14 -0600 Subject: [PATCH 064/197] Correctly passthrough plane format and modifiers when importing VA surface --- src/platform/linux/graphics.cpp | 12 ++++++++---- src/platform/linux/vaapi.cpp | 18 +++++++++--------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/src/platform/linux/graphics.cpp b/src/platform/linux/graphics.cpp index 448051f446b..ab6702c26e1 100644 --- a/src/platform/linux/graphics.cpp +++ b/src/platform/linux/graphics.cpp @@ -560,21 +560,25 @@ namespace egl { std::optional import_target(display_t::pointer egl_display, std::array &&fds, const surface_descriptor_t &r8, const surface_descriptor_t &gr88) { - EGLAttrib img_attr_planes[2][13] { - { EGL_LINUX_DRM_FOURCC_EXT, DRM_FORMAT_R8, + EGLAttrib img_attr_planes[2][17] { + { EGL_LINUX_DRM_FOURCC_EXT, r8.fourcc, EGL_WIDTH, r8.width, EGL_HEIGHT, r8.height, EGL_DMA_BUF_PLANE0_FD_EXT, r8.fds[0], EGL_DMA_BUF_PLANE0_OFFSET_EXT, r8.offsets[0], EGL_DMA_BUF_PLANE0_PITCH_EXT, r8.pitches[0], + EGL_DMA_BUF_PLANE0_MODIFIER_LO_EXT, (EGLAttrib) (r8.modifier & 0xFFFFFFFF), + EGL_DMA_BUF_PLANE0_MODIFIER_HI_EXT, (EGLAttrib) (r8.modifier >> 32), EGL_NONE }, - { EGL_LINUX_DRM_FOURCC_EXT, DRM_FORMAT_GR88, + { EGL_LINUX_DRM_FOURCC_EXT, gr88.fourcc, EGL_WIDTH, gr88.width, EGL_HEIGHT, gr88.height, - EGL_DMA_BUF_PLANE0_FD_EXT, r8.fds[0], + EGL_DMA_BUF_PLANE0_FD_EXT, gr88.fds[0], EGL_DMA_BUF_PLANE0_OFFSET_EXT, gr88.offsets[0], EGL_DMA_BUF_PLANE0_PITCH_EXT, gr88.pitches[0], + EGL_DMA_BUF_PLANE0_MODIFIER_LO_EXT, (EGLAttrib) (gr88.modifier & 0xFFFFFFFF), + EGL_DMA_BUF_PLANE0_MODIFIER_HI_EXT, (EGLAttrib) (gr88.modifier >> 32), EGL_NONE }, }; diff --git a/src/platform/linux/vaapi.cpp b/src/platform/linux/vaapi.cpp index 77daeab5b12..f210bba4bba 100644 --- a/src/platform/linux/vaapi.cpp +++ b/src/platform/linux/vaapi.cpp @@ -37,7 +37,7 @@ extern "C" struct AVBufferRef; namespace va { constexpr auto SURFACE_ATTRIB_MEM_TYPE_DRM_PRIME_2 = 0x40000000; constexpr auto EXPORT_SURFACE_WRITE_ONLY = 0x0002; - constexpr auto EXPORT_SURFACE_COMPOSED_LAYERS = 0x0008; + constexpr auto EXPORT_SURFACE_SEPARATE_LAYERS = 0x0004; using VADisplay = void *; using VAStatus = int; @@ -350,7 +350,7 @@ namespace va { this->va_display, surface, va::SURFACE_ATTRIB_MEM_TYPE_DRM_PRIME_2, - va::EXPORT_SURFACE_WRITE_ONLY | va::EXPORT_SURFACE_COMPOSED_LAYERS, + va::EXPORT_SURFACE_WRITE_ONLY | va::EXPORT_SURFACE_SEPARATE_LAYERS, &prime); if (status) { BOOST_LOG(error) << "Couldn't export va surface handle: ["sv << (int) surface << "]: "sv << va::errorStr(status); @@ -370,17 +370,17 @@ namespace va { { (int) prime.width, (int) prime.height, { prime.objects[prime.layers[0].object_index[0]].fd, -1, -1, -1 }, - 0, - 0, + prime.layers[0].drm_format, + prime.objects[prime.layers[0].object_index[0]].drm_format_modifier, { prime.layers[0].pitch[0] }, { prime.layers[0].offset[0] } }, { (int) prime.width / 2, (int) prime.height / 2, - { prime.objects[prime.layers[0].object_index[1]].fd, -1, -1, -1 }, - 0, - 0, - { prime.layers[0].pitch[1] }, - { prime.layers[0].offset[1] } }); + { prime.objects[prime.layers[1].object_index[0]].fd, -1, -1, -1 }, + prime.layers[1].drm_format, + prime.objects[prime.layers[1].object_index[0]].drm_format_modifier, + { prime.layers[1].pitch[0] }, + { prime.layers[1].offset[0] } }); if (!nv12_opt) { return -1; From a9b459cdb10456efd32f6d61cc11951d76bc95d9 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Tue, 2 Jan 2024 21:33:32 -0600 Subject: [PATCH 065/197] Use P010 instead of YUV420P10 for 10-bit VAAPI encoding --- src/video.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/video.cpp b/src/video.cpp index 1191a8684bf..05e22209ca8 100644 --- a/src/video.cpp +++ b/src/video.cpp @@ -884,7 +884,7 @@ namespace video { std::make_unique( AV_HWDEVICE_TYPE_VAAPI, AV_HWDEVICE_TYPE_NONE, AV_PIX_FMT_VAAPI, - AV_PIX_FMT_NV12, AV_PIX_FMT_YUV420P10, + AV_PIX_FMT_NV12, AV_PIX_FMT_P010, vaapi_init_avcodec_hardware_input_buffer), { // Common options From 0f640b8dd951f2336b252d57a3cf49342ebc77f6 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Tue, 2 Jan 2024 23:42:20 -0600 Subject: [PATCH 066/197] Fix clear color when rendering to VA surfaces --- src/platform/linux/graphics.cpp | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/platform/linux/graphics.cpp b/src/platform/linux/graphics.cpp index ab6702c26e1..b25032b393a 100644 --- a/src/platform/linux/graphics.cpp +++ b/src/platform/linux/graphics.cpp @@ -605,6 +605,22 @@ namespace egl { nv12->buf.bind(std::begin(nv12->tex), std::end(nv12->tex)); + GLenum attachments[] { + GL_COLOR_ATTACHMENT0, + GL_COLOR_ATTACHMENT1 + }; + + for (int x = 0; x < sizeof(attachments) / sizeof(decltype(attachments[0])); ++x) { + gl::ctx.BindFramebuffer(GL_FRAMEBUFFER, nv12->buf[x]); + gl::ctx.DrawBuffers(1, &attachments[x]); + + const float y_black[] = { 0.0f, 0.0f, 0.0f, 0.0f }; + const float uv_black[] = { 0.5f, 0.5f, 0.5f, 0.5f }; + gl::ctx.ClearBufferfv(GL_COLOR, 0, x == 0 ? y_black : uv_black); + } + + gl::ctx.BindFramebuffer(GL_FRAMEBUFFER, 0); + gl_drain_errors; return nv12; From 43992e7e9b66562e04034bfa78574f501c6cc887 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Wed, 3 Jan 2024 00:03:32 -0600 Subject: [PATCH 067/197] Don't fail kmsgrab init entirely if a single card doesn't work --- src/platform/linux/kmsgrab.cpp | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/src/platform/linux/kmsgrab.cpp b/src/platform/linux/kmsgrab.cpp index bfbe3935c1d..fd4b74d4a61 100644 --- a/src/platform/linux/kmsgrab.cpp +++ b/src/platform/linux/kmsgrab.cpp @@ -522,7 +522,7 @@ namespace platf { kms::card_t card; if (card.init(entry.path().c_str())) { - return {}; + continue; } auto end = std::end(card); @@ -560,6 +560,12 @@ namespace platf { } } + auto crtc = card.crtc(plane->crtc_id); + if (!crtc) { + BOOST_LOG(error) << "Couldn't get CRTC info: "sv << strerror(errno); + continue; + } + BOOST_LOG(info) << "Found monitor for DRM screencasting"sv; // We need to find the correct /dev/dri/card{nr} to correlate the crtc_id with the monitor descriptor @@ -576,13 +582,12 @@ namespace platf { // TODO: surf_sd = fb->to_sd(); - auto crct = card.crtc(plane->crtc_id); - kms::print(plane.get(), fb.get(), crct.get()); + kms::print(plane.get(), fb.get(), crtc.get()); img_width = fb->width; img_height = fb->height; - img_offset_x = crct->x; - img_offset_y = crct->y; + img_offset_x = crtc->x; + img_offset_y = crtc->y; this->env_width = ::platf::kms::env_width; this->env_height = ::platf::kms::env_height; @@ -614,10 +619,10 @@ namespace platf { // crtc_to_monitor is part of the guesswork after all. else { BOOST_LOG(warning) << "Couldn't find crtc_id, this shouldn't have happened :\\"sv; - width = crct->width; - height = crct->height; - offset_x = crct->x; - offset_y = crct->y; + width = crtc->width; + height = crtc->height; + offset_x = crtc->x; + offset_y = crtc->y; } this->card = std::move(card); @@ -1112,7 +1117,7 @@ namespace platf { kms::card_t card; if (card.init(entry.path().c_str())) { - return {}; + continue; } auto crtc_to_monitor = kms::map_crtc_to_monitor(card.monitors(conn_type_count)); @@ -1138,8 +1143,8 @@ namespace platf { // This appears to return the offset of the monitor auto crtc = card.crtc(plane->crtc_id); if (!crtc) { - BOOST_LOG(error) << "Couldn't get crtc info: "sv << strerror(errno); - return {}; + BOOST_LOG(error) << "Couldn't get CRTC info: "sv << strerror(errno); + continue; } auto it = crtc_to_monitor.find(plane->crtc_id); From a01a15a54b157b0aed3f2722b203c712797253bd Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Tue, 2 Jan 2024 18:17:09 -0600 Subject: [PATCH 068/197] Fix termination of child processes when the parent terminates --- src/process.cpp | 27 ++++++++++++++++----------- src/process.h | 2 +- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/src/process.cpp b/src/process.cpp index bacaf754204..929e0114020 100644 --- a/src/process.cpp +++ b/src/process.cpp @@ -57,17 +57,22 @@ namespace proc { return std::make_unique(); } + /** + * @brief Terminates all child processes in a process group. + * @param proc The child process itself. + * @param group The group of all children in the process tree. + */ void - process_end(bp::child &proc, bp::group &proc_handle) { - if (!proc.running()) { - return; + terminate_process_group(bp::child &proc, bp::group &group) { + if (group.valid()) { + BOOST_LOG(debug) << "Terminating child processes"sv; + group.terminate(); } - BOOST_LOG(debug) << "Force termination Child-Process"sv; - proc_handle.terminate(); - - // avoid zombie process - proc.wait(); + if (proc.valid()) { + // avoid zombie process + proc.wait(); + } } boost::filesystem::path @@ -220,7 +225,7 @@ namespace proc { find_working_directory(_app.cmd, _env) : boost::filesystem::path(_app.working_dir); BOOST_LOG(info) << "Executing: ["sv << _app.cmd << "] in ["sv << working_dir << ']'; - _process = platf::run_command(_app.elevated, true, _app.cmd, working_dir, _env, _pipe.get(), ec, &_process_handle); + _process = platf::run_command(_app.elevated, true, _app.cmd, working_dir, _env, _pipe.get(), ec, &_process_group); if (ec) { BOOST_LOG(warning) << "Couldn't run ["sv << _app.cmd << "]: System: "sv << ec.message(); return -1; @@ -260,9 +265,9 @@ namespace proc { proc_t::terminate() { std::error_code ec; placebo = false; - process_end(_process, _process_handle); + terminate_process_group(_process, _process_group); _process = bp::child(); - _process_handle = bp::group(); + _process_group = bp::group(); for (; _app_prep_it != _app_prep_begin; --_app_prep_it) { auto &cmd = *(_app_prep_it - 1); diff --git a/src/process.h b/src/process.h index c1ff28afd5b..c3b13d89534 100644 --- a/src/process.h +++ b/src/process.h @@ -100,7 +100,7 @@ namespace proc { bool placebo {}; boost::process::child _process; - boost::process::group _process_handle; + boost::process::group _process_group; file_t _pipe; std::vector::const_iterator _app_prep_it; From 556d9586e9190759c1364d248a6ffc9db5897058 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Tue, 2 Jan 2024 19:22:32 -0600 Subject: [PATCH 069/197] Switch to LizardByte ViGEmClient submodule --- .gitmodules | 2 +- third-party/ViGEmClient | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitmodules b/.gitmodules index cf12ef6b844..faccb0d5b59 100644 --- a/.gitmodules +++ b/.gitmodules @@ -8,7 +8,7 @@ branch = master [submodule "third-party/ViGEmClient"] path = third-party/ViGEmClient - url = https://github.com/nefarius/ViGEmClient + url = https://github.com/LizardByte/Virtual-Gamepad-Emulation-Client.git branch = master [submodule "third-party/nv-codec-headers"] path = third-party/nv-codec-headers diff --git a/third-party/ViGEmClient b/third-party/ViGEmClient index b66d02d57e3..19202603d40 160000 --- a/third-party/ViGEmClient +++ b/third-party/ViGEmClient @@ -1 +1 @@ -Subproject commit b66d02d57e32cc8595369c53418b843e958649b4 +Subproject commit 19202603d40202e34e06bf3a1a42c1eec0b1ec02 From 1bd45ca80341f8d7e58de479f38294c8c457b283 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Tue, 2 Jan 2024 21:23:35 -0600 Subject: [PATCH 070/197] Fix low-res scrolling on Linux --- src/platform/linux/input.cpp | 49 ++++++++++++++++++++++++------------ 1 file changed, 33 insertions(+), 16 deletions(-) diff --git a/src/platform/linux/input.cpp b/src/platform/linux/input.cpp index bccbf8ad8d2..e3f1d70f251 100644 --- a/src/platform/linux/input.cpp +++ b/src/platform/linux/input.cpp @@ -847,6 +847,9 @@ namespace platf { evdev_t mouse_dev; evdev_t keyboard_dev; + int accumulated_vscroll_delta = 0; + int accumulated_hscroll_delta = 0; + #ifdef SUNSHINE_BUILD_X11 Display *display; #endif @@ -1296,17 +1299,24 @@ namespace platf { */ void scroll(input_t &input, int high_res_distance) { - int distance = high_res_distance / 120; + auto raw = ((input_raw_t *) input.get()); - auto mouse = ((input_raw_t *) input.get())->mouse_input.get(); - if (!mouse) { - x_scroll(input, distance, 4, 5); - return; + raw->accumulated_vscroll_delta += high_res_distance; + int full_ticks = raw->accumulated_vscroll_delta / 120; + + auto mouse = raw->mouse_input.get(); + if (mouse) { + if (full_ticks) { + libevdev_uinput_write_event(mouse, EV_REL, REL_WHEEL, full_ticks); + } + libevdev_uinput_write_event(mouse, EV_REL, REL_WHEEL_HI_RES, high_res_distance); + libevdev_uinput_write_event(mouse, EV_SYN, SYN_REPORT, 0); + } + else if (full_ticks) { + x_scroll(input, full_ticks, 4, 5); } - libevdev_uinput_write_event(mouse, EV_REL, REL_WHEEL, distance); - libevdev_uinput_write_event(mouse, EV_REL, REL_WHEEL_HI_RES, high_res_distance); - libevdev_uinput_write_event(mouse, EV_SYN, SYN_REPORT, 0); + raw->accumulated_vscroll_delta -= full_ticks * 120; } /** @@ -1321,17 +1331,24 @@ namespace platf { */ void hscroll(input_t &input, int high_res_distance) { - int distance = high_res_distance / 120; + auto raw = ((input_raw_t *) input.get()); - auto mouse = ((input_raw_t *) input.get())->mouse_input.get(); - if (!mouse) { - x_scroll(input, distance, 6, 7); - return; + raw->accumulated_hscroll_delta += high_res_distance; + int full_ticks = raw->accumulated_hscroll_delta / 120; + + auto mouse = raw->mouse_input.get(); + if (mouse) { + if (full_ticks) { + libevdev_uinput_write_event(mouse, EV_REL, REL_HWHEEL, full_ticks); + } + libevdev_uinput_write_event(mouse, EV_REL, REL_HWHEEL_HI_RES, high_res_distance); + libevdev_uinput_write_event(mouse, EV_SYN, SYN_REPORT, 0); + } + else if (full_ticks) { + x_scroll(input, full_ticks, 6, 7); } - libevdev_uinput_write_event(mouse, EV_REL, REL_HWHEEL, distance); - libevdev_uinput_write_event(mouse, EV_REL, REL_HWHEEL_HI_RES, high_res_distance); - libevdev_uinput_write_event(mouse, EV_SYN, SYN_REPORT, 0); + raw->accumulated_hscroll_delta -= full_ticks * 120; } static keycode_t From 0403ad147ab79d5004c2af5737634129276b8cd2 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Wed, 3 Jan 2024 10:14:50 -0600 Subject: [PATCH 071/197] Fix capturing scaled output with wlgrab --- src/platform/linux/wayland.cpp | 25 +++++++++++++++++-------- src/platform/linux/wayland.h | 17 +++++++++++++++-- 2 files changed, 32 insertions(+), 10 deletions(-) diff --git a/src/platform/linux/wayland.cpp b/src/platform/linux/wayland.cpp index d601ba95daa..bc1e416f75a 100644 --- a/src/platform/linux/wayland.cpp +++ b/src/platform/linux/wayland.cpp @@ -67,7 +67,14 @@ namespace wl { } inline monitor_t::monitor_t(wl_output *output): - output { output }, listener { + output { output }, + wl_listener { + &CLASS_CALL(monitor_t, wl_geometry), + &CLASS_CALL(monitor_t, wl_mode), + &CLASS_CALL(monitor_t, wl_done), + &CLASS_CALL(monitor_t, wl_scale), + }, + xdg_listener { &CLASS_CALL(monitor_t, xdg_position), &CLASS_CALL(monitor_t, xdg_size), &CLASS_CALL(monitor_t, xdg_done), @@ -99,21 +106,23 @@ namespace wl { void monitor_t::xdg_size(zxdg_output_v1 *, std::int32_t width, std::int32_t height) { + BOOST_LOG(info) << "Logical size: "sv << width << 'x' << height; + } + + void + monitor_t::wl_mode(wl_output *wl_output, std::uint32_t flags, + std::int32_t width, std::int32_t height, std::int32_t refresh) { viewport.width = width; viewport.height = height; BOOST_LOG(info) << "Resolution: "sv << width << 'x' << height; } - void - monitor_t::xdg_done(zxdg_output_v1 *) { - BOOST_LOG(info) << "All info about monitor ["sv << name << "] has been send"sv; - } - void monitor_t::listen(zxdg_output_manager_v1 *output_manager) { auto xdg_output = zxdg_output_manager_v1_get_xdg_output(output_manager, output); - zxdg_output_v1_add_listener(xdg_output, &listener, this); + zxdg_output_v1_add_listener(xdg_output, &xdg_listener, this); + wl_output_add_listener(output, &wl_listener, this); } interface_t::interface_t() noexcept @@ -137,7 +146,7 @@ namespace wl { BOOST_LOG(info) << "Found interface: "sv << interface << '(' << id << ") version "sv << version; monitors.emplace_back( std::make_unique( - (wl_output *) wl_registry_bind(registry, id, &wl_output_interface, version))); + (wl_output *) wl_registry_bind(registry, id, &wl_output_interface, 2))); } else if (!std::strcmp(interface, zxdg_output_manager_v1_interface.name)) { BOOST_LOG(info) << "Found interface: "sv << interface << '(' << id << ") version "sv << version; diff --git a/src/platform/linux/wayland.h b/src/platform/linux/wayland.h index a4c3aef17d9..e4c1c1a9800 100644 --- a/src/platform/linux/wayland.h +++ b/src/platform/linux/wayland.h @@ -118,7 +118,19 @@ namespace wl { void xdg_size(zxdg_output_v1 *, std::int32_t width, std::int32_t height); void - xdg_done(zxdg_output_v1 *); + xdg_done(zxdg_output_v1 *) {} + + void + wl_geometry(wl_output *wl_output, std::int32_t x, std::int32_t y, + std::int32_t physical_width, std::int32_t physical_height, std::int32_t subpixel, + const char *make, const char *model, std::int32_t transform) {} + void + wl_mode(wl_output *wl_output, std::uint32_t flags, + std::int32_t width, std::int32_t height, std::int32_t refresh); + void + wl_done(wl_output *wl_output) {} + void + wl_scale(wl_output *wl_output, std::int32_t factor) {} void listen(zxdg_output_manager_v1 *output_manager); @@ -130,7 +142,8 @@ namespace wl { platf::touch_port_t viewport; - zxdg_output_v1_listener listener; + wl_output_listener wl_listener; + zxdg_output_v1_listener xdg_listener; }; class interface_t { From e1771de37afac716c0371e03aeebd5a75aaf069f Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Wed, 3 Jan 2024 15:42:12 -0600 Subject: [PATCH 072/197] Fix race condition causing hangs and EGL import errors due to concurrent snapshot() calls --- src/platform/linux/graphics.cpp | 30 ++++++++++++++++++++++++++++++ src/platform/linux/graphics.h | 3 +++ src/platform/linux/vaapi.cpp | 6 +++++- src/platform/linux/wlgrab.cpp | 14 ++++---------- 4 files changed, 42 insertions(+), 11 deletions(-) diff --git a/src/platform/linux/graphics.cpp b/src/platform/linux/graphics.cpp index b25032b393a..ccdf54d4fc2 100644 --- a/src/platform/linux/graphics.cpp +++ b/src/platform/linux/graphics.cpp @@ -558,6 +558,36 @@ namespace egl { return rgb; } + /** + * @brief Creates a black RGB texture of the specified image size. + * @param img The image to use for texture sizing. + * @return The new RGB texture. + */ + rgb_t + create_blank(platf::img_t &img) { + rgb_t rgb { + EGL_NO_DISPLAY, + EGL_NO_IMAGE, + gl::tex_t::make(1) + }; + + gl::ctx.BindTexture(GL_TEXTURE_2D, rgb->tex[0]); + gl::ctx.TexStorage2D(GL_TEXTURE_2D, 1, GL_RGBA8, img.width, img.height); + gl::ctx.BindTexture(GL_TEXTURE_2D, 0); + + auto framebuf = gl::frame_buf_t::make(1); + framebuf.bind(&rgb->tex[0], &rgb->tex[0] + 1); + + GLenum attachment = GL_COLOR_ATTACHMENT0; + gl::ctx.DrawBuffers(1, &attachment); + const GLuint rgb_black[] = { 0, 0, 0, 0 }; + gl::ctx.ClearBufferuiv(GL_COLOR, 0, rgb_black); + + gl_drain_errors; + + return rgb; + } + std::optional import_target(display_t::pointer egl_display, std::array &&fds, const surface_descriptor_t &r8, const surface_descriptor_t &gr88) { EGLAttrib img_attr_planes[2][17] { diff --git a/src/platform/linux/graphics.h b/src/platform/linux/graphics.h index ee72c46e766..fa658f41a48 100644 --- a/src/platform/linux/graphics.h +++ b/src/platform/linux/graphics.h @@ -268,6 +268,9 @@ namespace egl { display_t::pointer egl_display, const surface_descriptor_t &xrgb); + rgb_t + create_blank(platf::img_t &img); + std::optional import_target( display_t::pointer egl_display, diff --git a/src/platform/linux/vaapi.cpp b/src/platform/linux/vaapi.cpp index f210bba4bba..085ca7bb9c5 100644 --- a/src/platform/linux/vaapi.cpp +++ b/src/platform/linux/vaapi.cpp @@ -436,7 +436,11 @@ namespace va { convert(platf::img_t &img) override { auto &descriptor = (egl::img_descriptor_t &) img; - if (descriptor.sequence > sequence) { + if (descriptor.sequence == 0) { + // For dummy images, use a blank RGB texture instead of importing a DMA-BUF + rgb = egl::create_blank(img); + } + else if (descriptor.sequence > sequence) { sequence = descriptor.sequence; rgb = egl::rgb_t {}; diff --git a/src/platform/linux/wlgrab.cpp b/src/platform/linux/wlgrab.cpp index b57b332d7b2..8f3ef299d42 100644 --- a/src/platform/linux/wlgrab.cpp +++ b/src/platform/linux/wlgrab.cpp @@ -313,6 +313,8 @@ namespace wl { alloc_img() override { auto img = std::make_shared(); + img->width = width; + img->height = height; img->sequence = 0; img->serial = std::numeric_limitsserial)>::max(); img->data = nullptr; @@ -334,16 +336,8 @@ namespace wl { int dummy_img(platf::img_t *img) override { - // TODO: stop cheating and give black image - if (!img) { - return -1; - }; - auto pull_dummy_img_callback = [&img](std::shared_ptr &img_out) -> bool { - img_out = img->shared_from_this(); - return true; - }; - std::shared_ptr img_out; - return snapshot(pull_dummy_img_callback, img_out, 1000ms, false) != platf::capture_e::ok; + // Empty images are recognized as dummies by the zero sequence number + return 0; } std::uint64_t sequence {}; From 3adf9e596745abe6121e83f93c120bfbc56bc9b6 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Wed, 3 Jan 2024 16:08:46 -0600 Subject: [PATCH 073/197] Don't busy loop during wlgrab capture --- src/platform/linux/wayland.cpp | 33 +++++++++++++++++++++++++++++++++ src/platform/linux/wayland.h | 4 ++++ src/platform/linux/wlgrab.cpp | 6 +++--- 3 files changed, 40 insertions(+), 3 deletions(-) diff --git a/src/platform/linux/wayland.cpp b/src/platform/linux/wayland.cpp index bc1e416f75a..b762492b6ae 100644 --- a/src/platform/linux/wayland.cpp +++ b/src/platform/linux/wayland.cpp @@ -2,6 +2,7 @@ * @file src/platform/linux/wayland.cpp * @brief todo */ +#include #include #include @@ -61,6 +62,38 @@ namespace wl { wl_display_roundtrip(display_internal.get()); } + /** + * @brief Waits up to the specified timeout to dispatch new events on the wl_display. + * @param timeout The timeout in milliseconds. + * @return true if new events were dispatched or false if the timeout expired. + */ + bool + display_t::dispatch(std::chrono::milliseconds timeout) { + // Check if any events are queued already. If not, flush + // outgoing events, and prepare to wait for readability. + if (wl_display_prepare_read(display_internal.get()) == 0) { + wl_display_flush(display_internal.get()); + + // Wait for an event to come in + struct pollfd pfd = {}; + pfd.fd = wl_display_get_fd(display_internal.get()); + pfd.events = POLLIN; + if (poll(&pfd, 1, timeout.count()) == 1 && (pfd.revents & POLLIN)) { + // Read the new event(s) + wl_display_read_events(display_internal.get()); + } + else { + // We timed out, so unlock the queue now + wl_display_cancel_read(display_internal.get()); + return false; + } + } + + // Dispatch any existing or new pending events + wl_display_dispatch_pending(display_internal.get()); + return true; + } + wl_registry * display_t::registry() { return wl_display_get_registry(display_internal.get()); diff --git a/src/platform/linux/wayland.h b/src/platform/linux/wayland.h index e4c1c1a9800..062aa65f1ea 100644 --- a/src/platform/linux/wayland.h +++ b/src/platform/linux/wayland.h @@ -206,6 +206,10 @@ namespace wl { void roundtrip(); + // Wait up to the timeout to read and dispatch new events + bool + dispatch(std::chrono::milliseconds timeout); + // Get the registry associated with the display // No need to manually free the registry wl_registry * diff --git a/src/platform/linux/wlgrab.cpp b/src/platform/linux/wlgrab.cpp index 8f3ef299d42..5ba0d9e24c1 100644 --- a/src/platform/linux/wlgrab.cpp +++ b/src/platform/linux/wlgrab.cpp @@ -87,11 +87,11 @@ namespace wl { snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr &img_out, std::chrono::milliseconds timeout, bool cursor) { auto to = std::chrono::steady_clock::now() + timeout; + // Dispatch events until we get a new frame or the timeout expires dmabuf.listen(interface.dmabuf_manager, output, cursor); do { - display.roundtrip(); - - if (to < std::chrono::steady_clock::now()) { + auto remaining_time_ms = std::chrono::duration_cast(to - std::chrono::steady_clock::now()); + if (remaining_time_ms.count() < 0 || !display.dispatch(remaining_time_ms)) { return platf::capture_e::timeout; } } while (dmabuf.status == dmabuf_t::WAITING); From ebe01ce20b06c6f10392f945c1c7083ed3aa733f Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Thu, 4 Jan 2024 00:20:14 -0600 Subject: [PATCH 074/197] Remove useless texture size queries for every frame in display_ram_t --- src/platform/linux/kmsgrab.cpp | 8 +------- src/platform/linux/wlgrab.cpp | 6 ------ 2 files changed, 1 insertion(+), 13 deletions(-) diff --git a/src/platform/linux/kmsgrab.cpp b/src/platform/linux/kmsgrab.cpp index fd4b74d4a61..4e5d8af89be 100644 --- a/src/platform/linux/kmsgrab.cpp +++ b/src/platform/linux/kmsgrab.cpp @@ -819,17 +819,11 @@ namespace platf { auto &rgb = *rgb_opt; - gl::ctx.BindTexture(GL_TEXTURE_2D, rgb->tex[0]); - - int w, h; - gl::ctx.GetTexLevelParameteriv(GL_TEXTURE_2D, 0, GL_TEXTURE_WIDTH, &w); - gl::ctx.GetTexLevelParameteriv(GL_TEXTURE_2D, 0, GL_TEXTURE_HEIGHT, &h); - BOOST_LOG(debug) << "width and height: w "sv << w << " h "sv << h; - if (!pull_free_image_cb(img_out)) { return platf::capture_e::interrupted; } + gl::ctx.BindTexture(GL_TEXTURE_2D, rgb->tex[0]); gl::ctx.GetTextureSubImage(rgb->tex[0], 0, img_offset_x, img_offset_y, 0, width, height, 1, GL_BGRA, GL_UNSIGNED_BYTE, img_out->height * img_out->row_pitch, img_out->data); if (cursor_opt && cursor) { diff --git a/src/platform/linux/wlgrab.cpp b/src/platform/linux/wlgrab.cpp index 5ba0d9e24c1..2162fe61a74 100644 --- a/src/platform/linux/wlgrab.cpp +++ b/src/platform/linux/wlgrab.cpp @@ -182,12 +182,6 @@ namespace wl { } gl::ctx.BindTexture(GL_TEXTURE_2D, (*rgb_opt)->tex[0]); - - int w, h; - gl::ctx.GetTexLevelParameteriv(GL_TEXTURE_2D, 0, GL_TEXTURE_WIDTH, &w); - gl::ctx.GetTexLevelParameteriv(GL_TEXTURE_2D, 0, GL_TEXTURE_HEIGHT, &h); - BOOST_LOG(debug) << "width and height: w "sv << w << " h "sv << h; - gl::ctx.GetTextureSubImage((*rgb_opt)->tex[0], 0, 0, 0, 0, width, height, 1, GL_BGRA, GL_UNSIGNED_BYTE, img_out->height * img_out->row_pitch, img_out->data); gl::ctx.BindTexture(GL_TEXTURE_2D, 0); From 0dff8b16fdf81c0efe2b57895e3b460d4daec9a3 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Thu, 4 Jan 2024 00:21:46 -0600 Subject: [PATCH 075/197] Use the new VAAPI dummy image support for kmsgrab too --- src/platform/linux/kmsgrab.cpp | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/src/platform/linux/kmsgrab.cpp b/src/platform/linux/kmsgrab.cpp index 4e5d8af89be..8b9780ae068 100644 --- a/src/platform/linux/kmsgrab.cpp +++ b/src/platform/linux/kmsgrab.cpp @@ -874,6 +874,8 @@ namespace platf { alloc_img() override { auto img = std::make_shared(); + img->width = width; + img->height = height; img->serial = std::numeric_limitsserial)>::max(); img->data = nullptr; img->pixel_pitch = 4; @@ -886,16 +888,8 @@ namespace platf { int dummy_img(platf::img_t *img) override { - // TODO: stop cheating and give black image - if (!img) { - return -1; - }; - auto pull_dummy_img_callback = [&img](std::shared_ptr &img_out) -> bool { - img_out = img->shared_from_this(); - return true; - }; - std::shared_ptr img_out; - return snapshot(pull_dummy_img_callback, img_out, 1s, false) != platf::capture_e::ok; + // Empty images are recognized as dummies by the zero sequence number + return 0; } capture_e @@ -988,12 +982,10 @@ namespace platf { return -1; } - sequence = 0; - return 0; } - std::uint64_t sequence; + std::uint64_t sequence {}; }; } // namespace kms From bc6cc2078e8032b28b2ec0e04b05bf8116de8386 Mon Sep 17 00:00:00 2001 From: James Le Cuirot Date: Fri, 5 Jan 2024 15:59:41 +0000 Subject: [PATCH 076/197] build(linux) make vaapi optional without dlopen (#1979) Co-authored-by: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> --- cmake/FindLibva.cmake | 70 +++++++ cmake/compile_definitions/linux.cmake | 25 ++- cmake/prep/options.cmake | 2 + docs/source/building/linux.rst | 7 +- src/platform/linux/kmsgrab.cpp | 8 + src/platform/linux/misc.cpp | 1 - src/platform/linux/vaapi.cpp | 266 +++----------------------- src/platform/linux/vaapi.h | 3 - src/platform/linux/wlgrab.cpp | 4 + src/platform/linux/x11grab.cpp | 2 + 10 files changed, 136 insertions(+), 252 deletions(-) create mode 100644 cmake/FindLibva.cmake diff --git a/cmake/FindLibva.cmake b/cmake/FindLibva.cmake new file mode 100644 index 00000000000..f8dfddc1496 --- /dev/null +++ b/cmake/FindLibva.cmake @@ -0,0 +1,70 @@ +# - Try to find Libva +# This module defines the following variables: +# +# * LIBVA_FOUND - The component was found +# * LIBVA_INCLUDE_DIRS - The component include directory +# * LIBVA_LIBRARIES - The component library Libva +# * LIBVA_DRM_LIBRARIES - The component library Libva DRM + +# Use pkg-config to get the directories and then use these values in the +# find_path() and find_library() calls +# cmake-format: on + +find_package(PkgConfig QUIET) +if(PKG_CONFIG_FOUND) + pkg_check_modules(_LIBVA libva) + pkg_check_modules(_LIBVA_DRM libva-drm) +endif() + +find_path( + LIBVA_INCLUDE_DIR + NAMES va/va.h va/va_drm.h + HINTS ${_LIBVA_INCLUDE_DIRS} + PATHS /usr/include /usr/local/include /opt/local/include) + +find_library( + LIBVA_LIB + NAMES ${_LIBVA_LIBRARIES} libva + HINTS ${_LIBVA_LIBRARY_DIRS} + PATHS /usr/lib /usr/local/lib /opt/local/lib) + +find_library( + LIBVA_DRM_LIB + NAMES ${_LIBVA_DRM_LIBRARIES} libva-drm + HINTS ${_LIBVA_DRM_LIBRARY_DIRS} + PATHS /usr/lib /usr/local/lib /opt/local/lib) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(Libva REQUIRED_VARS LIBVA_INCLUDE_DIR LIBVA_LIB LIBVA_DRM_LIB) +mark_as_advanced(LIBVA_INCLUDE_DIR LIBVA_LIB LIBVA_DRM_LIB) + +if(LIBVA_FOUND) + set(LIBVA_INCLUDE_DIRS ${LIBVA_INCLUDE_DIR}) + set(LIBVA_LIBRARIES ${LIBVA_LIB}) + set(LIBVA_DRM_LIBRARIES ${LIBVA_DRM_LIB}) + + if(NOT TARGET Libva::va) + if(IS_ABSOLUTE "${LIBVA_LIBRARIES}") + add_library(Libva::va UNKNOWN IMPORTED) + set_target_properties(Libva::va PROPERTIES IMPORTED_LOCATION "${LIBVA_LIBRARIES}") + else() + add_library(Libva::va INTERFACE IMPORTED) + set_target_properties(Libva::va PROPERTIES IMPORTED_LIBNAME "${LIBVA_LIBRARIES}") + endif() + + set_target_properties(Libva::va PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${LIBVA_INCLUDE_DIRS}") + endif() + + if(NOT TARGET Libva::drm) + if(IS_ABSOLUTE "${LIBVA_DRM_LIBRARIES}") + add_library(Libva::drm UNKNOWN IMPORTED) + set_target_properties(Libva::drm PROPERTIES IMPORTED_LOCATION "${LIBVA_DRM_LIBRARIES}") + else() + add_library(Libva::drm INTERFACE IMPORTED) + set_target_properties(Libva::drm PROPERTIES IMPORTED_LIBNAME "${LIBVA_DRM_LIBRARIES}") + endif() + + set_target_properties(Libva::drm PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${LIBVA_INCLUDE_DIRS}") + endif() + +endif() diff --git a/cmake/compile_definitions/linux.cmake b/cmake/compile_definitions/linux.cmake index af35a09d19f..d4ebb597312 100644 --- a/cmake/compile_definitions/linux.cmake +++ b/cmake/compile_definitions/linux.cmake @@ -120,6 +120,21 @@ elseif(NOT LIBDRM_FOUND) message(WARNING "Missing libcap") endif() +# vaapi +if(${SUNSHINE_ENABLE_VAAPI}) + find_package(Libva) +else() + set(LIBVA_FOUND OFF) +endif() +if(LIBVA_FOUND) + add_compile_definitions(SUNSHINE_BUILD_VAAPI) + include_directories(SYSTEM ${LIBVA_INCLUDE_DIR}) + list(APPEND PLATFORM_LIBRARIES ${LIBVA_LIBRARIES} ${LIBVA_DRM_LIBRARIES}) + list(APPEND PLATFORM_TARGET_FILES + src/platform/linux/vaapi.h + src/platform/linux/vaapi.cpp) +endif() + # wayland if(${SUNSHINE_ENABLE_WAYLAND}) find_package(Wayland) @@ -167,8 +182,12 @@ if(X11_FOUND) src/platform/linux/x11grab.cpp) endif() -if(NOT ${CUDA_FOUND} AND NOT ${WAYLAND_FOUND} AND NOT ${X11_FOUND} AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND})) - message(FATAL_ERROR "Couldn't find either x11, wayland, cuda or (libdrm and libcap)") +if(NOT ${CUDA_FOUND} + AND NOT ${WAYLAND_FOUND} + AND NOT ${X11_FOUND} + AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND}) + AND NOT ${LIBVA_FOUND}) + message(FATAL_ERROR "Couldn't find either cuda, wayland, x11, (libdrm and libcap), or libva") endif() # tray icon @@ -206,8 +225,6 @@ endif() list(APPEND PLATFORM_TARGET_FILES src/platform/linux/publish.cpp - src/platform/linux/vaapi.h - src/platform/linux/vaapi.cpp src/platform/linux/graphics.h src/platform/linux/graphics.cpp src/platform/linux/misc.h diff --git a/cmake/prep/options.cmake b/cmake/prep/options.cmake index 0198decb2b1..7a8d728ba47 100644 --- a/cmake/prep/options.cmake +++ b/cmake/prep/options.cmake @@ -26,6 +26,8 @@ elseif(UNIX) # Linux "Enable cuda specific code." ON) option(SUNSHINE_ENABLE_DRM "Enable KMS grab if available." ON) + option(SUNSHINE_ENABLE_VAAPI + "Enable building vaapi specific code." ON) option(SUNSHINE_ENABLE_WAYLAND "Enable building wayland specific code." ON) option(SUNSHINE_ENABLE_X11 diff --git a/docs/source/building/linux.rst b/docs/source/building/linux.rst index e3d51f6a57f..9982998ca2d 100644 --- a/docs/source/building/linux.rst +++ b/docs/source/building/linux.rst @@ -32,7 +32,7 @@ Install Requirements libopus-dev \ libpulse-dev \ libssl-dev \ - libva-dev \ + libva-dev \ # VA-API libvdpau-dev \ libwayland-dev \ # Wayland libx11-dev \ # X11 @@ -67,7 +67,7 @@ Install Requirements libdrm-devel \ libevdev-devel \ libnotify-devel \ - libva-devel \ + libva-devel \ # VA-API libvdpau-devel \ libX11-devel \ # X11 libxcb-devel \ # X11 @@ -115,7 +115,7 @@ Install Requirements libopus-dev \ libpulse-dev \ libssl-dev \ - libva-dev \ + libva-dev \ # VA-API libvdpau-dev \ libwayland-dev \ # Wayland libx11-dev \ # X11 @@ -165,6 +165,7 @@ Install Requirements libopus-dev \ libpulse-dev \ libssl-dev \ + libva-dev \ # VA-API libwayland-dev \ # Wayland libx11-dev \ # X11 libxcb-shm0-dev \ # X11 diff --git a/src/platform/linux/kmsgrab.cpp b/src/platform/linux/kmsgrab.cpp index 8b9780ae068..2273c528a63 100644 --- a/src/platform/linux/kmsgrab.cpp +++ b/src/platform/linux/kmsgrab.cpp @@ -793,9 +793,11 @@ namespace platf { std::unique_ptr make_avcodec_encode_device(pix_fmt_e pix_fmt) override { +#ifdef SUNSHINE_BUILD_VAAPI if (mem_type == mem_type_e::vaapi) { return va::make_avcodec_encode_device(width, height, false); } +#endif return std::make_unique(); } @@ -862,9 +864,11 @@ namespace platf { std::unique_ptr make_avcodec_encode_device(pix_fmt_e pix_fmt) override { +#ifdef SUNSHINE_BUILD_VAAPI if (mem_type == mem_type_e::vaapi) { return va::make_avcodec_encode_device(width, height, dup(card.render_fd.el), img_offset_x, img_offset_y, true); } +#endif BOOST_LOG(error) << "Unsupported pixel format for egl::display_vram_t: "sv << platf::from_pix_fmt(pix_fmt); return nullptr; @@ -977,7 +981,11 @@ namespace platf { return -1; } +#ifdef SUNSHINE_BUILD_VAAPI if (!va::validate(card.render_fd.el)) { +#else + if (true) { +#endif BOOST_LOG(warning) << "Monitor "sv << display_name << " doesn't support hardware encoding. Reverting back to GPU -> RAM -> GPU"sv; return -1; } diff --git a/src/platform/linux/misc.cpp b/src/platform/linux/misc.cpp index aee35b9e28a..a4fe1167219 100644 --- a/src/platform/linux/misc.cpp +++ b/src/platform/linux/misc.cpp @@ -724,7 +724,6 @@ namespace platf { init() { // These are allowed to fail. gbm::init(); - va::init(); window_system = window_system_e::NONE; #ifdef SUNSHINE_BUILD_WAYLAND diff --git a/src/platform/linux/vaapi.cpp b/src/platform/linux/vaapi.cpp index 085ca7bb9c5..8bd0ef16f79 100644 --- a/src/platform/linux/vaapi.cpp +++ b/src/platform/linux/vaapi.cpp @@ -10,6 +10,7 @@ extern "C" { #include #include +#include #if !VA_CHECK_VERSION(1, 9, 0) // vaSyncBuffer stub allows Sunshine built against libva <2.9.0 to link against ffmpeg on libva 2.9.0 or later VAStatus @@ -85,209 +86,7 @@ namespace va { } layers[4]; }; - /** - * @brief Defined profiles - */ - enum class profile_e { - // Profile ID used for video processing. - ProfileNone = -1, - MPEG2Simple = 0, - MPEG2Main = 1, - MPEG4Simple = 2, - MPEG4AdvancedSimple = 3, - MPEG4Main = 4, - H264Baseline = 5, - H264Main = 6, - H264High = 7, - VC1Simple = 8, - VC1Main = 9, - VC1Advanced = 10, - H263Baseline = 11, - JPEGBaseline = 12, - H264ConstrainedBaseline = 13, - VP8Version0_3 = 14, - H264MultiviewHigh = 15, - H264StereoHigh = 16, - HEVCMain = 17, - HEVCMain10 = 18, - VP9Profile0 = 19, - VP9Profile1 = 20, - VP9Profile2 = 21, - VP9Profile3 = 22, - HEVCMain12 = 23, - HEVCMain422_10 = 24, - HEVCMain422_12 = 25, - HEVCMain444 = 26, - HEVCMain444_10 = 27, - HEVCMain444_12 = 28, - HEVCSccMain = 29, - HEVCSccMain10 = 30, - HEVCSccMain444 = 31, - AV1Profile0 = 32, - AV1Profile1 = 33, - HEVCSccMain444_10 = 34, - - // Profile ID used for protected video playback. - Protected = 35 - }; - - enum class entry_e { - VLD = 1, - IZZ = 2, - IDCT = 3, - MoComp = 4, - Deblocking = 5, - EncSlice = 6, /** slice level encode */ - EncPicture = 7, /** picture encode, JPEG, etc */ - /** - * For an implementation that supports a low power/high performance variant - * for slice level encode, it can choose to expose the - * VAEntrypointEncSliceLP entrypoint. Certain encoding tools may not be - * available with this entrypoint (e.g. interlace, MBAFF) and the - * application can query the encoding configuration attributes to find - * out more details if this entrypoint is supported. - */ - EncSliceLP = 8, - VideoProc = 10, /**< Video pre/post-processing. */ - /** - * @brief FEI - * - * The purpose of FEI (Flexible Encoding Infrastructure) is to allow applications to - * have more controls and trade off quality for speed with their own IPs. - * The application can optionally provide input to ENC for extra encode control - * and get the output from ENC. Application can chose to modify the ENC - * output/PAK input during encoding, but the performance impact is significant. - * - * On top of the existing buffers for normal encode, there will be - * one extra input buffer (VAEncMiscParameterFEIFrameControl) and - * three extra output buffers (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType - * and VAEncFEIDistortionBufferType) for FEI entry function. - * If separate PAK is set, two extra input buffers - * (VAEncFEIMVBufferType, VAEncFEIMBModeBufferType) are needed for PAK input. - */ - FEI = 11, - /** - * @brief Stats - * - * A pre-processing function for getting some statistics and motion vectors is added, - * and some extra controls for Encode pipeline are provided. The application can - * optionally call the statistics function to get motion vectors and statistics like - * variances, distortions before calling Encode function via this entry point. - * - * Checking whether Statistics is supported can be performed with vaQueryConfigEntrypoints(). - * If Statistics entry point is supported, then the list of returned entry-points will - * include #Stats. Supported pixel format, maximum resolution and statistics - * specific attributes can be obtained via normal attribute query. One input buffer - * (VAStatsStatisticsParameterBufferType) and one or two output buffers - * (VAStatsStatisticsBufferType, VAStatsStatisticsBottomFieldBufferType (for interlace only) - * and VAStatsMVBufferType) are needed for this entry point. - */ - Stats = 12, - /** - * @brief ProtectedTEEComm - * - * A function for communicating with TEE (Trusted Execution Environment). - */ - ProtectedTEEComm = 13, - /** - * @brief ProtectedContent - * - * A function for protected content to decrypt encrypted content. - */ - ProtectedContent = 14, - }; - - typedef VAStatus (*queryConfigEntrypoints_fn)(VADisplay dpy, profile_e profile, entry_e *entrypoint_list, int *num_entrypoints); - typedef int (*maxNumEntrypoints_fn)(VADisplay dpy); - typedef VADisplay (*getDisplayDRM_fn)(int fd); - typedef VAStatus (*terminate_fn)(VADisplay dpy); - typedef VAStatus (*initialize_fn)(VADisplay dpy, int *major_version, int *minor_version); - typedef const char *(*errorStr_fn)(VAStatus error_status); - typedef void (*VAMessageCallback)(void *user_context, const char *message); - typedef VAMessageCallback (*setErrorCallback_fn)(VADisplay dpy, VAMessageCallback callback, void *user_context); - typedef VAMessageCallback (*setInfoCallback_fn)(VADisplay dpy, VAMessageCallback callback, void *user_context); - typedef const char *(*queryVendorString_fn)(VADisplay dpy); - typedef VAStatus (*exportSurfaceHandle_fn)( - VADisplay dpy, VASurfaceID surface_id, - uint32_t mem_type, uint32_t flags, - void *descriptor); - - static maxNumEntrypoints_fn maxNumEntrypoints; - static queryConfigEntrypoints_fn queryConfigEntrypoints; - static getDisplayDRM_fn getDisplayDRM; - static terminate_fn terminate; - static initialize_fn initialize; - static errorStr_fn errorStr; - static setErrorCallback_fn setErrorCallback; - static setInfoCallback_fn setInfoCallback; - static queryVendorString_fn queryVendorString; - static exportSurfaceHandle_fn exportSurfaceHandle; - - using display_t = util::dyn_safe_ptr_v2; - - int - init_main_va() { - static void *handle { nullptr }; - static bool funcs_loaded = false; - - if (funcs_loaded) return 0; - - if (!handle) { - handle = dyn::handle({ "libva.so.2", "libva.so" }); - if (!handle) { - return -1; - } - } - - std::vector> funcs { - { (dyn::apiproc *) &maxNumEntrypoints, "vaMaxNumEntrypoints" }, - { (dyn::apiproc *) &queryConfigEntrypoints, "vaQueryConfigEntrypoints" }, - { (dyn::apiproc *) &terminate, "vaTerminate" }, - { (dyn::apiproc *) &initialize, "vaInitialize" }, - { (dyn::apiproc *) &errorStr, "vaErrorStr" }, - { (dyn::apiproc *) &setErrorCallback, "vaSetErrorCallback" }, - { (dyn::apiproc *) &setInfoCallback, "vaSetInfoCallback" }, - { (dyn::apiproc *) &queryVendorString, "vaQueryVendorString" }, - { (dyn::apiproc *) &exportSurfaceHandle, "vaExportSurfaceHandle" }, - }; - - if (dyn::load(handle, funcs)) { - return -1; - } - - funcs_loaded = true; - return 0; - } - - int - init() { - if (init_main_va()) { - return -1; - } - - static void *handle { nullptr }; - static bool funcs_loaded = false; - - if (funcs_loaded) return 0; - - if (!handle) { - handle = dyn::handle({ "libva-drm.so.2", "libva-drm.so" }); - if (!handle) { - return -1; - } - } - - std::vector> funcs { - { (dyn::apiproc *) &getDisplayDRM, "vaGetDisplayDRM" }, - }; - - if (dyn::load(handle, funcs)) { - return -1; - } - - funcs_loaded = true; - return 0; - } + using display_t = util::safe_ptr_v2; int vaapi_init_avcodec_hardware_input_buffer(platf::avcodec_encode_device_t *encode_device, AVBufferRef **hw_device_buf); @@ -298,9 +97,8 @@ namespace va { init(int in_width, int in_height, file_t &&render_device) { file = std::move(render_device); - if (!va::initialize || !gbm::create_device) { - if (!va::initialize) BOOST_LOG(warning) << "libva not initialized"sv; - if (!gbm::create_device) BOOST_LOG(warning) << "libgbm not initialized"sv; + if (!gbm::create_device) { + BOOST_LOG(warning) << "libgbm not initialized"sv; return -1; } @@ -346,14 +144,14 @@ namespace va { va::DRMPRIMESurfaceDescriptor prime; va::VASurfaceID surface = (std::uintptr_t) frame->data[3]; - auto status = va::exportSurfaceHandle( + auto status = vaExportSurfaceHandle( this->va_display, surface, va::SURFACE_ATTRIB_MEM_TYPE_DRM_PRIME_2, va::EXPORT_SURFACE_WRITE_ONLY | va::EXPORT_SURFACE_SEPARATE_LAYERS, &prime); if (status) { - BOOST_LOG(error) << "Couldn't export va surface handle: ["sv << (int) surface << "]: "sv << va::errorStr(status); + BOOST_LOG(error) << "Couldn't export va surface handle: ["sv << (int) surface << "]: "sv << vaErrorStr(status); return -1; } @@ -524,23 +322,13 @@ namespace va { auto hwctx = (AVVAAPIDeviceContext *) ctx->hwctx; auto priv = (VAAPIDevicePriv *) ctx->user_opaque; - terminate(hwctx->display); + vaTerminate(hwctx->display); close(priv->drm_fd); av_freep(&priv); } int vaapi_init_avcodec_hardware_input_buffer(platf::avcodec_encode_device_t *base, AVBufferRef **hw_device_buf) { - if (!va::initialize) { - BOOST_LOG(warning) << "libva not loaded"sv; - return -1; - } - - if (!va::getDisplayDRM) { - BOOST_LOG(warning) << "libva-drm not loaded"sv; - return -1; - } - auto va = (va::va_t *) base; auto fd = dup(va->file.el); @@ -552,7 +340,7 @@ namespace va { av_free(priv); }); - va::display_t display { va::getDisplayDRM(fd) }; + va::display_t display { vaGetDisplayDRM(fd) }; if (!display) { auto render_device = config::video.adapter_name.empty() ? "/dev/dri/renderD128" : config::video.adapter_name.c_str(); @@ -562,17 +350,17 @@ namespace va { va->va_display = display.get(); - va::setErrorCallback(display.get(), __log, &error); - va::setErrorCallback(display.get(), __log, &info); + vaSetErrorCallback(display.get(), __log, &error); + vaSetErrorCallback(display.get(), __log, &info); int major, minor; - auto status = va::initialize(display.get(), &major, &minor); + auto status = vaInitialize(display.get(), &major, &minor); if (status) { - BOOST_LOG(error) << "Couldn't initialize va display: "sv << va::errorStr(status); + BOOST_LOG(error) << "Couldn't initialize va display: "sv << vaErrorStr(status); return -1; } - BOOST_LOG(debug) << "vaapi vendor: "sv << va::queryVendorString(display.get()); + BOOST_LOG(debug) << "vaapi vendor: "sv << vaQueryVendorString(display.get()); *hw_device_buf = av_hwdevice_ctx_alloc(AV_HWDEVICE_TYPE_VAAPI); auto ctx = (AVHWDeviceContext *) (*hw_device_buf)->data; @@ -596,20 +384,20 @@ namespace va { } static bool - query(display_t::pointer display, profile_e profile) { - std::vector entrypoints; - entrypoints.resize(maxNumEntrypoints(display)); + query(display_t::pointer display, VAProfile profile) { + std::vector entrypoints; + entrypoints.resize(vaMaxNumEntrypoints(display)); int count; - auto status = queryConfigEntrypoints(display, profile, entrypoints.data(), &count); + auto status = vaQueryConfigEntrypoints(display, profile, entrypoints.data(), &count); if (status) { - BOOST_LOG(error) << "Couldn't query entrypoints: "sv << va::errorStr(status); + BOOST_LOG(error) << "Couldn't query entrypoints: "sv << vaErrorStr(status); return false; } entrypoints.resize(count); for (auto entrypoint : entrypoints) { - if (entrypoint == entry_e::EncSlice || entrypoint == entry_e::EncSliceLP) { + if (entrypoint == VAEntrypointEncSlice || entrypoint == VAEntrypointEncSliceLP) { return true; } } @@ -619,11 +407,7 @@ namespace va { bool validate(int fd) { - if (init()) { - return false; - } - - va::display_t display { va::getDisplayDRM(fd) }; + va::display_t display { vaGetDisplayDRM(fd) }; if (!display) { char string[1024]; @@ -636,21 +420,21 @@ namespace va { } int major, minor; - auto status = initialize(display.get(), &major, &minor); + auto status = vaInitialize(display.get(), &major, &minor); if (status) { - BOOST_LOG(error) << "Couldn't initialize va display: "sv << va::errorStr(status); + BOOST_LOG(error) << "Couldn't initialize va display: "sv << vaErrorStr(status); return false; } - if (!query(display.get(), profile_e::H264Main)) { + if (!query(display.get(), VAProfileH264Main)) { return false; } - if (video::active_hevc_mode > 1 && !query(display.get(), profile_e::HEVCMain)) { + if (video::active_hevc_mode > 1 && !query(display.get(), VAProfileHEVCMain)) { return false; } - if (video::active_hevc_mode > 2 && !query(display.get(), profile_e::HEVCMain10)) { + if (video::active_hevc_mode > 2 && !query(display.get(), VAProfileHEVCMain10)) { return false; } diff --git a/src/platform/linux/vaapi.h b/src/platform/linux/vaapi.h index 95760e55bd4..50d58b7d8d0 100644 --- a/src/platform/linux/vaapi.h +++ b/src/platform/linux/vaapi.h @@ -28,7 +28,4 @@ namespace va { // Ensure the render device pointed to by fd is capable of encoding h264 with the hevc_mode configured bool validate(int fd); - - int - init(); } // namespace va diff --git a/src/platform/linux/wlgrab.cpp b/src/platform/linux/wlgrab.cpp index 2162fe61a74..0e22cbe2248 100644 --- a/src/platform/linux/wlgrab.cpp +++ b/src/platform/linux/wlgrab.cpp @@ -211,9 +211,11 @@ namespace wl { std::unique_ptr make_avcodec_encode_device(platf::pix_fmt_e pix_fmt) override { +#ifdef SUNSHINE_BUILD_VAAPI if (mem_type == platf::mem_type_e::vaapi) { return va::make_avcodec_encode_device(width, height, false); } +#endif return std::make_unique(); } @@ -321,9 +323,11 @@ namespace wl { std::unique_ptr make_avcodec_encode_device(platf::pix_fmt_e pix_fmt) override { +#ifdef SUNSHINE_BUILD_VAAPI if (mem_type == platf::mem_type_e::vaapi) { return va::make_avcodec_encode_device(width, height, 0, 0, true); } +#endif return std::make_unique(); } diff --git a/src/platform/linux/x11grab.cpp b/src/platform/linux/x11grab.cpp index 6bd3018cf74..9022a10741e 100644 --- a/src/platform/linux/x11grab.cpp +++ b/src/platform/linux/x11grab.cpp @@ -555,9 +555,11 @@ namespace platf { std::unique_ptr make_avcodec_encode_device(pix_fmt_e pix_fmt) override { +#ifdef SUNSHINE_BUILD_VAAPI if (mem_type == mem_type_e::vaapi) { return va::make_avcodec_encode_device(width, height, false); } +#endif #ifdef SUNSHINE_BUILD_CUDA if (mem_type == mem_type_e::cuda) { From c7e5df5976ed101bedc4c1adad0c1e8bd7bdaa7d Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Fri, 5 Jan 2024 18:00:18 -0600 Subject: [PATCH 077/197] Refactor EGLAttrib logic into a shared function --- src/platform/linux/graphics.cpp | 99 ++++++++++++++------------------- src/platform/linux/graphics.h | 2 +- 2 files changed, 44 insertions(+), 57 deletions(-) diff --git a/src/platform/linux/graphics.cpp b/src/platform/linux/graphics.cpp index ccdf54d4fc2..aa8178b27c7 100644 --- a/src/platform/linux/graphics.cpp +++ b/src/platform/linux/graphics.cpp @@ -14,11 +14,6 @@ #define fourcc_code(a, b, c, d) ((std::uint32_t)(a) | ((std::uint32_t)(b) << 8) | \ ((std::uint32_t)(c) << 16) | ((std::uint32_t)(d) << 24)) #define fourcc_mod_code(vendor, val) ((((uint64_t) vendor) << 56) | ((val) &0x00ffffffffffffffULL)) -#define DRM_FORMAT_R8 fourcc_code('R', '8', ' ', ' ') /* [7:0] R */ -#define DRM_FORMAT_GR88 fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */ -#define DRM_FORMAT_ARGB8888 fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */ -#define DRM_FORMAT_XRGB8888 fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */ -#define DRM_FORMAT_XBGR8888 fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */ #define DRM_FORMAT_MOD_INVALID fourcc_mod_code(0, ((1ULL << 56) - 1)) #define SUNSHINE_SHADERS_DIR SUNSHINE_ASSETS_DIR "/shaders/opengl" @@ -500,45 +495,56 @@ namespace egl { return {}; } - std::optional - import_source(display_t::pointer egl_display, const surface_descriptor_t &xrgb) { - EGLAttrib attribs[47]; - int atti = 0; - attribs[atti++] = EGL_WIDTH; - attribs[atti++] = xrgb.width; - attribs[atti++] = EGL_HEIGHT; - attribs[atti++] = xrgb.height; - attribs[atti++] = EGL_LINUX_DRM_FOURCC_EXT; - attribs[atti++] = xrgb.fourcc; + /** + * @brief Returns EGL attributes for eglCreateImage() to import the provided surface. + * @param surface The surface descriptor. + * @return Vector of EGL attributes. + */ + std::vector + surface_descriptor_to_egl_attribs(const surface_descriptor_t &surface) { + std::vector attribs; - for (auto x = 0; x < 4; ++x) { - auto fd = xrgb.fds[x]; + attribs.emplace_back(EGL_WIDTH); + attribs.emplace_back(surface.width); + attribs.emplace_back(EGL_HEIGHT); + attribs.emplace_back(surface.height); + attribs.emplace_back(EGL_LINUX_DRM_FOURCC_EXT); + attribs.emplace_back(surface.fourcc); + for (auto x = 0; x < 4; ++x) { + auto fd = surface.fds[x]; if (fd < 0) { continue; } auto plane_attr = get_plane(x); - attribs[atti++] = plane_attr.fd; - attribs[atti++] = fd; - attribs[atti++] = plane_attr.offset; - attribs[atti++] = xrgb.offsets[x]; - attribs[atti++] = plane_attr.pitch; - attribs[atti++] = xrgb.pitches[x]; - - if (xrgb.modifier != DRM_FORMAT_MOD_INVALID) { - attribs[atti++] = plane_attr.lo; - attribs[atti++] = xrgb.modifier & 0xFFFFFFFF; - attribs[atti++] = plane_attr.hi; - attribs[atti++] = xrgb.modifier >> 32; + attribs.emplace_back(plane_attr.fd); + attribs.emplace_back(fd); + attribs.emplace_back(plane_attr.offset); + attribs.emplace_back(surface.offsets[x]); + attribs.emplace_back(plane_attr.pitch); + attribs.emplace_back(surface.pitches[x]); + + if (surface.modifier != DRM_FORMAT_MOD_INVALID) { + attribs.emplace_back(plane_attr.lo); + attribs.emplace_back(surface.modifier & 0xFFFFFFFF); + attribs.emplace_back(plane_attr.hi); + attribs.emplace_back(surface.modifier >> 32); } } - attribs[atti++] = EGL_NONE; + + attribs.emplace_back(EGL_NONE); + return attribs; + } + + std::optional + import_source(display_t::pointer egl_display, const surface_descriptor_t &xrgb) { + auto attribs = surface_descriptor_to_egl_attribs(xrgb); rgb_t rgb { egl_display, - eglCreateImage(egl_display, EGL_NO_CONTEXT, EGL_LINUX_DMA_BUF_EXT, nullptr, attribs), + eglCreateImage(egl_display, EGL_NO_CONTEXT, EGL_LINUX_DMA_BUF_EXT, nullptr, attribs.data()), gl::tex_t::make(1) }; @@ -589,40 +595,21 @@ namespace egl { } std::optional - import_target(display_t::pointer egl_display, std::array &&fds, const surface_descriptor_t &r8, const surface_descriptor_t &gr88) { - EGLAttrib img_attr_planes[2][17] { - { EGL_LINUX_DRM_FOURCC_EXT, r8.fourcc, - EGL_WIDTH, r8.width, - EGL_HEIGHT, r8.height, - EGL_DMA_BUF_PLANE0_FD_EXT, r8.fds[0], - EGL_DMA_BUF_PLANE0_OFFSET_EXT, r8.offsets[0], - EGL_DMA_BUF_PLANE0_PITCH_EXT, r8.pitches[0], - EGL_DMA_BUF_PLANE0_MODIFIER_LO_EXT, (EGLAttrib) (r8.modifier & 0xFFFFFFFF), - EGL_DMA_BUF_PLANE0_MODIFIER_HI_EXT, (EGLAttrib) (r8.modifier >> 32), - EGL_NONE }, - - { EGL_LINUX_DRM_FOURCC_EXT, gr88.fourcc, - EGL_WIDTH, gr88.width, - EGL_HEIGHT, gr88.height, - EGL_DMA_BUF_PLANE0_FD_EXT, gr88.fds[0], - EGL_DMA_BUF_PLANE0_OFFSET_EXT, gr88.offsets[0], - EGL_DMA_BUF_PLANE0_PITCH_EXT, gr88.pitches[0], - EGL_DMA_BUF_PLANE0_MODIFIER_LO_EXT, (EGLAttrib) (gr88.modifier & 0xFFFFFFFF), - EGL_DMA_BUF_PLANE0_MODIFIER_HI_EXT, (EGLAttrib) (gr88.modifier >> 32), - EGL_NONE }, - }; + import_target(display_t::pointer egl_display, std::array &&fds, const surface_descriptor_t &y, const surface_descriptor_t &uv) { + auto y_attribs = surface_descriptor_to_egl_attribs(y); + auto uv_attribs = surface_descriptor_to_egl_attribs(uv); nv12_t nv12 { egl_display, - eglCreateImage(egl_display, EGL_NO_CONTEXT, EGL_LINUX_DMA_BUF_EXT, nullptr, img_attr_planes[0]), - eglCreateImage(egl_display, EGL_NO_CONTEXT, EGL_LINUX_DMA_BUF_EXT, nullptr, img_attr_planes[1]), + eglCreateImage(egl_display, EGL_NO_CONTEXT, EGL_LINUX_DMA_BUF_EXT, nullptr, y_attribs.data()), + eglCreateImage(egl_display, EGL_NO_CONTEXT, EGL_LINUX_DMA_BUF_EXT, nullptr, uv_attribs.data()), gl::tex_t::make(2), gl::frame_buf_t::make(2), std::move(fds) }; if (!nv12->r8 || !nv12->bg88) { - BOOST_LOG(error) << "Couldn't create KHR Image"sv; + BOOST_LOG(error) << "Couldn't import YUV target: "sv << util::hex(eglGetError()).to_string_view(); return std::nullopt; } diff --git a/src/platform/linux/graphics.h b/src/platform/linux/graphics.h index fa658f41a48..ff59c87e302 100644 --- a/src/platform/linux/graphics.h +++ b/src/platform/linux/graphics.h @@ -275,7 +275,7 @@ namespace egl { import_target( display_t::pointer egl_display, std::array &&fds, - const surface_descriptor_t &r8, const surface_descriptor_t &gr88); + const surface_descriptor_t &y, const surface_descriptor_t &uv); class cursor_t: public platf::img_t { public: From 7d751f050e19651e251e7e347d721be77eb47a44 Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Fri, 5 Jan 2024 18:01:21 -0600 Subject: [PATCH 078/197] Fix EGL import for modifiers that require aux planes --- src/platform/linux/vaapi.cpp | 44 ++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 17 deletions(-) diff --git a/src/platform/linux/vaapi.cpp b/src/platform/linux/vaapi.cpp index 8bd0ef16f79..e2846b30f0c 100644 --- a/src/platform/linux/vaapi.cpp +++ b/src/platform/linux/vaapi.cpp @@ -162,24 +162,34 @@ namespace va { fds[x] = prime.objects[x].fd; } - auto nv12_opt = egl::import_target( - display.get(), - std::move(fds), - { (int) prime.width, - (int) prime.height, - { prime.objects[prime.layers[0].object_index[0]].fd, -1, -1, -1 }, - prime.layers[0].drm_format, - prime.objects[prime.layers[0].object_index[0]].drm_format_modifier, - { prime.layers[0].pitch[0] }, - { prime.layers[0].offset[0] } }, - { (int) prime.width / 2, - (int) prime.height / 2, - { prime.objects[prime.layers[1].object_index[0]].fd, -1, -1, -1 }, - prime.layers[1].drm_format, - prime.objects[prime.layers[1].object_index[0]].drm_format_modifier, - { prime.layers[1].pitch[0] }, - { prime.layers[1].offset[0] } }); + if (prime.num_layers != 2) { + BOOST_LOG(error) << "Invalid layer count for VA surface: expected 2, got "sv << prime.num_layers; + return -1; + } + + egl::surface_descriptor_t sds[2] = {}; + for (int plane = 0; plane < 2; ++plane) { + auto &sd = sds[plane]; + auto &layer = prime.layers[plane]; + + sd.fourcc = layer.drm_format; + + // UV plane is subsampled + sd.width = prime.width / (plane == 0 ? 1 : 2); + sd.height = prime.height / (plane == 0 ? 1 : 2); + + // The modifier must be the same for all planes + sd.modifier = prime.objects[layer.object_index[0]].drm_format_modifier; + + std::fill_n(sd.fds, 4, -1); + for (int x = 0; x < layer.num_planes; ++x) { + sd.fds[x] = prime.objects[layer.object_index[x]].fd; + sd.pitches[x] = layer.pitch[x]; + sd.offsets[x] = layer.offset[x]; + } + } + auto nv12_opt = egl::import_target(display.get(), std::move(fds), sds[0], sds[1]); if (!nv12_opt) { return -1; } From 791ed48a3fbfd6271cfba4ee515a6e2a53841c03 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 5 Jan 2024 23:28:50 -0500 Subject: [PATCH 079/197] fix(macos): replace depreciated AbsoluteToNanoseconds (#1986) Co-authored-by: Cameron Gutman <2695644+cgutman@users.noreply.github.com> --- src/platform/macos/input.cpp | 36 +++++++++++------------------------- 1 file changed, 11 insertions(+), 25 deletions(-) diff --git a/src/platform/macos/input.cpp b/src/platform/macos/input.cpp index 1401c169cae..66d0d130861 100644 --- a/src/platform/macos/input.cpp +++ b/src/platform/macos/input.cpp @@ -3,16 +3,18 @@ * @brief todo */ #import +#include #include -#include #include "src/main.h" #include "src/platform/common.h" #include "src/utility.h" -// Delay for a double click -// FIXME: we probably want to make this configurable -#define MULTICLICK_DELAY_NS 500000000 +/** + * @brief Delay for a double click, in milliseconds. + * @todo Make this configurable. + */ +constexpr std::chrono::milliseconds MULTICLICK_DELAY_MS(500); namespace platf { using namespace std::literals; @@ -30,7 +32,7 @@ namespace platf { // mouse related stuff CGEventRef mouse_event; // mouse event source bool mouse_down[3]; // mouse button status - uint64_t last_mouse_event[3][2]; // timestamp of last mouse events + std::chrono::steady_clock::steady_clock::time_point last_mouse_event[3][2]; // timestamp of last mouse events }; // A struct to hold a Windows keycode to Mac virtual keycode mapping. @@ -384,17 +386,6 @@ const KeyCodeMap kKeyCodesMap[] = { post_mouse(input, kCGMouseButtonLeft, event_type_mouse(input), location, 0); } - uint64_t - time_diff(uint64_t start) { - uint64_t elapsed; - Nanoseconds elapsedNano; - - elapsed = mach_absolute_time() - start; - elapsedNano = AbsoluteToNanoseconds(*(AbsoluteTime *) &elapsed); - - return *(uint64_t *) &elapsedNano; - } - void button_mouse(input_t &input, int button, bool release) { CGMouseButton mac_button; @@ -422,15 +413,16 @@ const KeyCodeMap kKeyCodesMap[] = { mouse->mouse_down[mac_button] = !release; - // if the last mouse down was less than MULTICLICK_DELAY_NS, we send a double click event - if (time_diff(mouse->last_mouse_event[mac_button][release]) < MULTICLICK_DELAY_NS) { + // if the last mouse down was less than MULTICLICK_DELAY_MS, we send a double click event + auto now = std::chrono::steady_clock::now(); + if (now < mouse->last_mouse_event[mac_button][release] + MULTICLICK_DELAY_MS) { post_mouse(input, mac_button, event, get_mouse_loc(input), 2); } else { post_mouse(input, mac_button, event, get_mouse_loc(input), 1); } - mouse->last_mouse_event[mac_button][release] = mach_absolute_time(); + mouse->last_mouse_event[mac_button][release] = now; } void @@ -534,12 +526,6 @@ const KeyCodeMap kKeyCodesMap[] = { macos_input->mouse_down[0] = false; macos_input->mouse_down[1] = false; macos_input->mouse_down[2] = false; - macos_input->last_mouse_event[0][0] = 0; - macos_input->last_mouse_event[0][1] = 0; - macos_input->last_mouse_event[1][0] = 0; - macos_input->last_mouse_event[1][1] = 0; - macos_input->last_mouse_event[2][0] = 0; - macos_input->last_mouse_event[2][1] = 0; BOOST_LOG(debug) << "Display "sv << macos_input->display << ", pixel dimension: " << CGDisplayPixelsWide(macos_input->display) << "x"sv << CGDisplayPixelsHigh(macos_input->display); From f88df0f59625b26b36d16f8e9d6426dee7560d8d Mon Sep 17 00:00:00 2001 From: Cameron Gutman Date: Fri, 5 Jan 2024 23:02:39 -0600 Subject: [PATCH 080/197] Implement support for KMS cursor plane capture (#1981) --- src/platform/linux/graphics.cpp | 2 +- src/platform/linux/graphics.h | 1 + src/platform/linux/kmsgrab.cpp | 355 +++++++++++++++++++++++++++++--- src/platform/linux/misc.cpp | 5 - src/platform/linux/x11grab.cpp | 4 +- src/platform/linux/x11grab.h | 17 -- 6 files changed, 329 insertions(+), 55 deletions(-) diff --git a/src/platform/linux/graphics.cpp b/src/platform/linux/graphics.cpp index aa8178b27c7..3673ef137a1 100644 --- a/src/platform/linux/graphics.cpp +++ b/src/platform/linux/graphics.cpp @@ -858,7 +858,7 @@ namespace egl { if (serial != img.serial) { serial = img.serial; - gl::ctx.TexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, img.width, img.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, img.data); + gl::ctx.TexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, img.src_w, img.src_h, 0, GL_BGRA, GL_UNSIGNED_BYTE, img.data); } gl::ctx.Enable(GL_BLEND); diff --git a/src/platform/linux/graphics.h b/src/platform/linux/graphics.h index ff59c87e302..d2874bde1d4 100644 --- a/src/platform/linux/graphics.h +++ b/src/platform/linux/graphics.h @@ -280,6 +280,7 @@ namespace egl { class cursor_t: public platf::img_t { public: int x, y; + int src_w, src_h; unsigned long serial; diff --git a/src/platform/linux/kmsgrab.cpp b/src/platform/linux/kmsgrab.cpp index 2273c528a63..bc8e567f3a4 100644 --- a/src/platform/linux/kmsgrab.cpp +++ b/src/platform/linux/kmsgrab.cpp @@ -5,7 +5,9 @@ #include #include #include +#include #include +#include #include #include #include @@ -18,11 +20,9 @@ #include "src/utility.h" #include "src/video.h" -// Cursor rendering support through x11 #include "graphics.h" #include "vaapi.h" #include "wayland.h" -#include "x11grab.h" using namespace std::literals; namespace fs = std::filesystem; @@ -194,20 +194,16 @@ namespace platf { for (; plane_p != end; ++plane_p) { plane_t plane = drmModeGetPlane(fd, *plane_p); - if (!plane) { BOOST_LOG(error) << "Couldn't get drm plane ["sv << (end - plane_p) << "]: "sv << strerror(errno); continue; } - // If this plane is unused - if (plane->fb_id) { - this->plane = util::make_shared(plane.release()); + this->plane = util::make_shared(plane.release()); - // One last increment - ++plane_p; - break; - } + // One last increment + ++plane_p; + break; } } @@ -228,6 +224,20 @@ namespace platf { util::shared_t plane; }; + struct cursor_t { + // Public properties used during blending + bool visible = false; + std::int32_t x, y; + std::uint32_t dst_w, dst_h; + std::uint32_t src_w, src_h; + std::vector pixels; + unsigned long serial; + + // Private properties used for tracking cursor changes + std::uint64_t prop_src_x, prop_src_y, prop_src_w, prop_src_h; + std::uint32_t fb_id; + }; + class card_t { public: using connector_interal_t = util::safe_ptr; @@ -339,6 +349,17 @@ namespace platf { return DRM_MODE_ROTATE_0; } + int + get_crtc_index_by_id(std::uint32_t crtc_id) { + auto resources = res(); + for (int i = 0; i < resources->count_crtcs; i++) { + if (resources->crtcs[i] == crtc_id) { + return i; + } + } + return -1; + } + connector_interal_t connector(std::uint32_t id) { return drmModeGetConnector(fd.el, id); @@ -527,6 +548,11 @@ namespace platf { auto end = std::end(card); for (auto plane = std::begin(card); plane != end; ++plane) { + // Skip unused planes + if (!plane->fb_id) { + continue; + } + if (card.is_cursor(plane->plane_id)) { continue; } @@ -628,6 +654,8 @@ namespace platf { this->card = std::move(card); plane_id = plane->plane_id; + crtc_id = plane->crtc_id; + crtc_index = this->card.get_crtc_index_by_id(plane->crtc_id); goto break_loop; } @@ -641,11 +669,216 @@ namespace platf { return -1; } - cursor_opt = x11::cursor_t::make(); + // Look for the cursor plane for this CRTC + cursor_plane_id = -1; + auto end = std::end(card); + for (auto plane = std::begin(card); plane != end; ++plane) { + if (!card.is_cursor(plane->plane_id)) { + continue; + } + + // NB: We do not skip unused planes here because cursor planes + // will look unused if the cursor is currently hidden. + + if (!(plane->possible_crtcs & (1 << crtc_index))) { + // Skip cursor planes for other CRTCs + continue; + } + else if (plane->possible_crtcs != (1 << crtc_index)) { + // We assume a 1:1 mapping between cursor planes and CRTCs, which seems to + // match the behavior of drivers in the real world. If it's violated, we'll + // proceed anyway but print a warning in the log. + BOOST_LOG(warning) << "Cursor plane spans multiple CRTCs!"sv; + } + + BOOST_LOG(info) << "Found cursor plane ["sv << plane->plane_id << ']'; + cursor_plane_id = plane->plane_id; + break; + } + + if (cursor_plane_id < 0) { + BOOST_LOG(warning) << "No KMS cursor plane found. Cursor may not be displayed while streaming!"sv; + } return 0; } + void + update_cursor() { + if (cursor_plane_id < 0) { + return; + } + + plane_t plane = drmModeGetPlane(card.fd.el, cursor_plane_id); + + std::optional prop_crtc_x; + std::optional prop_crtc_y; + std::optional prop_crtc_w; + std::optional prop_crtc_h; + + std::optional prop_src_x; + std::optional prop_src_y; + std::optional prop_src_w; + std::optional prop_src_h; + + auto props = card.plane_props(cursor_plane_id); + for (auto &[prop, val] : props) { + if (prop->name == "CRTC_X"sv) { + prop_crtc_x = val; + } + else if (prop->name == "CRTC_Y"sv) { + prop_crtc_y = val; + } + else if (prop->name == "CRTC_W"sv) { + prop_crtc_w = val; + } + else if (prop->name == "CRTC_H"sv) { + prop_crtc_h = val; + } + else if (prop->name == "SRC_X"sv) { + prop_src_x = val; + } + else if (prop->name == "SRC_Y"sv) { + prop_src_y = val; + } + else if (prop->name == "SRC_W"sv) { + prop_src_w = val; + } + else if (prop->name == "SRC_H"sv) { + prop_src_h = val; + } + } + + if (!prop_crtc_w || !prop_crtc_h || !prop_crtc_x || !prop_crtc_y) { + BOOST_LOG(error) << "Cursor plane is missing required plane CRTC properties!"sv; + cursor_plane_id = -1; + captured_cursor.visible = false; + return; + } + if (!prop_src_x || !prop_src_y || !prop_src_w || !prop_src_h) { + BOOST_LOG(error) << "Cursor plane is missing required plane SRC properties!"sv; + cursor_plane_id = -1; + captured_cursor.visible = false; + return; + } + + // Update the cursor position and size unconditionally + captured_cursor.x = *prop_crtc_x; + captured_cursor.y = *prop_crtc_y; + captured_cursor.dst_w = *prop_crtc_w; + captured_cursor.dst_h = *prop_crtc_h; + + // We're technically cheating a bit here by assuming that we can detect + // changes to the cursor plane via property adjustments. If this isn't + // true, we'll really have to mmap() the dmabuf and draw that every time. + bool cursor_dirty = false; + + if (!plane->fb_id) { + captured_cursor.visible = false; + captured_cursor.fb_id = 0; + } + else if (plane->fb_id != captured_cursor.fb_id) { + BOOST_LOG(debug) << "Refreshing cursor image after FB changed"sv; + cursor_dirty = true; + } + else if (*prop_src_x != captured_cursor.prop_src_x || + *prop_src_y != captured_cursor.prop_src_y || + *prop_src_w != captured_cursor.prop_src_w || + *prop_src_h != captured_cursor.prop_src_h) { + BOOST_LOG(debug) << "Refreshing cursor image after source dimensions changed"sv; + cursor_dirty = true; + } + + // If the cursor is dirty, map it so we can download the new image + if (cursor_dirty) { + auto fb = card.fb(plane.get()); + if (!fb || !fb->handles[0]) { + // This means the cursor is not currently visible + captured_cursor.visible = false; + return; + } + + // All known cursor planes in the wild are ARGB8888 + if (fb->pixel_format != DRM_FORMAT_ARGB8888) { + BOOST_LOG(error) << "Unsupported non-ARGB8888 cursor format: "sv << fb->pixel_format; + captured_cursor.visible = false; + cursor_plane_id = -1; + return; + } + + // All known cursor planes in the wild require linear buffers + if (fb->modifier != DRM_FORMAT_MOD_LINEAR && fb->modifier != DRM_FORMAT_MOD_INVALID) { + BOOST_LOG(error) << "Unsupported non-linear cursor modifier: "sv << fb->modifier; + captured_cursor.visible = false; + cursor_plane_id = -1; + return; + } + + // The SRC_* properties are in Q16.16 fixed point, so convert to integers + auto src_x = *prop_src_x >> 16; + auto src_y = *prop_src_y >> 16; + auto src_w = *prop_src_w >> 16; + auto src_h = *prop_src_h >> 16; + + // Check for a legal source rectangle + if (src_x + src_w > fb->width || src_y + src_h > fb->height) { + BOOST_LOG(error) << "Illegal source size: ["sv << src_x + src_w << ',' << src_y + src_h << "] > ["sv << fb->width << ',' << fb->height << ']'; + captured_cursor.visible = false; + return; + } + + file_t plane_fd = card.handleFD(fb->handles[0]); + if (plane_fd.el < 0) { + captured_cursor.visible = false; + return; + } + + // We will map the entire region, but only copy what the source rectangle specifies + size_t mapped_size = ((size_t) fb->pitches[0]) * fb->height; + void *mapped_data = mmap(nullptr, mapped_size, PROT_READ, MAP_SHARED, plane_fd.el, fb->offsets[0]); + if (mapped_data == MAP_FAILED) { + BOOST_LOG(error) << "Failed to mmap cursor FB: "sv << strerror(errno); + captured_cursor.visible = false; + return; + } + + captured_cursor.pixels.resize(src_w * src_h * 4); + + // Prepare to read the dmabuf from the CPU + struct dma_buf_sync sync; + sync.flags = DMA_BUF_SYNC_START | DMA_BUF_SYNC_READ; + drmIoctl(plane_fd.el, DMA_BUF_IOCTL_SYNC, &sync); + + // If the image is tightly packed, copy it in one shot + if (fb->pitches[0] == src_w * 4 && src_x == 0) { + memcpy(captured_cursor.pixels.data(), &((std::uint8_t *) mapped_data)[src_y * fb->pitches[0]], src_h * fb->pitches[0]); + } + else { + // Copy row by row to deal with mismatched pitch or an X offset + auto pixel_dst = captured_cursor.pixels.data(); + for (int y = 0; y < src_h; y++) { + memcpy(&pixel_dst[y * (src_w * 4)], &((std::uint8_t *) mapped_data)[(y + src_y) * fb->pitches[0] + (src_x * 4)], src_w * 4); + } + } + + // End the CPU read and unmap the dmabuf + sync.flags = DMA_BUF_SYNC_END | DMA_BUF_SYNC_READ; + drmIoctl(plane_fd.el, DMA_BUF_IOCTL_SYNC, &sync); + + munmap(mapped_data, mapped_size); + + captured_cursor.visible = true; + captured_cursor.src_w = src_w; + captured_cursor.src_h = src_h; + captured_cursor.prop_src_x = *prop_src_x; + captured_cursor.prop_src_y = *prop_src_y; + captured_cursor.prop_src_w = *prop_src_w; + captured_cursor.prop_src_h = *prop_src_h; + captured_cursor.fb_id = plane->fb_id; + ++captured_cursor.serial; + } + } + inline capture_e refresh(file_t *file, egl::surface_descriptor_t *sd) { plane_t plane = drmModeGetPlane(card.fd.el, plane_id); @@ -695,6 +928,8 @@ namespace platf { return capture_e::reinit; } + update_cursor(); + return capture_e::ok; } @@ -706,10 +941,13 @@ namespace platf { int img_offset_x, img_offset_y; int plane_id; + int crtc_id; + int crtc_index; - card_t card; + int cursor_plane_id; + cursor_t captured_cursor {}; - std::optional cursor_opt; + card_t card; }; class display_ram_t: public display_t { @@ -802,6 +1040,51 @@ namespace platf { return std::make_unique(); } + void + blend_cursor(img_t &img) { + // TODO: Cursor scaling is not supported in this codepath. + // We always draw the cursor at the source size. + auto pixels = (int *) img.data; + + int32_t screen_height = img.height; + int32_t screen_width = img.width; + + // This is the position in the target that we will start drawing the cursor + auto cursor_x = std::max(0, captured_cursor.x - img_offset_x); + auto cursor_y = std::max(0, captured_cursor.y - img_offset_y); + + // If the cursor is partially off screen, the coordinates may be negative + // which means we will draw the top-right visible portion of the cursor only. + auto cursor_delta_x = cursor_x - std::max(-captured_cursor.src_w, captured_cursor.x - img_offset_x); + auto cursor_delta_y = cursor_y - std::max(-captured_cursor.src_h, captured_cursor.y - img_offset_y); + + auto delta_height = std::min(captured_cursor.src_h, std::max(0, screen_height - cursor_y)) - cursor_delta_y; + auto delta_width = std::min(captured_cursor.src_w, std::max(0, screen_width - cursor_x)) - cursor_delta_x; + for (auto y = 0; y < delta_height; ++y) { + // Offset into the cursor image to skip drawing the parts of the cursor image that are off screen + auto cursor_begin = (uint32_t *) &captured_cursor.pixels[((y + cursor_delta_y) * captured_cursor.src_w + cursor_delta_x) * 4]; + auto cursor_end = (uint32_t *) &captured_cursor.pixels[((y + cursor_delta_y) * captured_cursor.src_w + delta_width + cursor_delta_x) * 4]; + + auto pixels_begin = &pixels[(y + cursor_y) * (img.row_pitch / img.pixel_pitch) + cursor_x]; + + std::for_each(cursor_begin, cursor_end, [&](uint32_t cursor_pixel) { + auto colors_in = (uint8_t *) pixels_begin; + + auto alpha = (*(uint *) &cursor_pixel) >> 24u; + if (alpha == 255) { + *pixels_begin = cursor_pixel; + } + else { + auto colors_out = (uint8_t *) &cursor_pixel; + colors_in[0] = colors_out[0] + (colors_in[0] * (255 - alpha) + 255 / 2) / 255; + colors_in[1] = colors_out[1] + (colors_in[1] * (255 - alpha) + 255 / 2) / 255; + colors_in[2] = colors_out[2] + (colors_in[2] * (255 - alpha) + 255 / 2) / 255; + } + ++pixels_begin; + }); + } + } + capture_e snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr &img_out, std::chrono::milliseconds timeout, bool cursor) { file_t fb_fd[4]; @@ -828,8 +1111,8 @@ namespace platf { gl::ctx.BindTexture(GL_TEXTURE_2D, rgb->tex[0]); gl::ctx.GetTextureSubImage(rgb->tex[0], 0, img_offset_x, img_offset_y, 0, width, height, 1, GL_BGRA, GL_UNSIGNED_BYTE, img_out->height * img_out->row_pitch, img_out->data); - if (cursor_opt && cursor) { - cursor_opt->blend(*img_out, img_offset_x, img_offset_y); + if (cursor && captured_cursor.visible) { + blend_cursor(*img_out); } return capture_e::ok; @@ -955,19 +1238,26 @@ namespace platf { img->sequence = ++sequence; - if (!cursor || !cursor_opt) { - img->data = nullptr; - - for (auto x = 0; x < 4; ++x) { - fb_fd[x].release(); + if (cursor && captured_cursor.visible) { + // Copy new cursor pixel data if it's been updated + if (img->serial != captured_cursor.serial) { + img->buffer = captured_cursor.pixels; + img->serial = captured_cursor.serial; } - return capture_e::ok; - } - - cursor_opt->capture(*img); - img->x -= offset_x; - img->y -= offset_y; + img->x = captured_cursor.x; + img->y = captured_cursor.y; + img->src_w = captured_cursor.src_w; + img->src_h = captured_cursor.src_h; + img->width = captured_cursor.dst_w; + img->height = captured_cursor.dst_h; + img->pixel_pitch = 4; + img->row_pitch = img->pixel_pitch * img->width; + img->data = img->buffer.data(); + } + else { + img->data = nullptr; + } for (auto x = 0; x < 4; ++x) { fb_fd[x].release(); @@ -1118,6 +1408,15 @@ namespace platf { auto end = std::end(card); for (auto plane = std::begin(card); plane != end; ++plane) { + // Skip unused planes + if (!plane->fb_id) { + continue; + } + + if (card.is_cursor(plane->plane_id)) { + continue; + } + auto fb = card.fb(plane.get()); if (!fb) { BOOST_LOG(error) << "Couldn't get drm fb for plane ["sv << plane->fb_id << "]: "sv << strerror(errno); @@ -1130,10 +1429,6 @@ namespace platf { break; } - if (card.is_cursor(plane->plane_id)) { - continue; - } - // This appears to return the offset of the monitor auto crtc = card.crtc(plane->crtc_id); if (!crtc) { diff --git a/src/platform/linux/misc.cpp b/src/platform/linux/misc.cpp index a4fe1167219..76c686ba2d8 100644 --- a/src/platform/linux/misc.cpp +++ b/src/platform/linux/misc.cpp @@ -758,11 +758,6 @@ namespace platf { #ifdef SUNSHINE_BUILD_DRM if (config::video.capture.empty() || config::video.capture == "kms") { if (verify_kms()) { - if (window_system == window_system_e::WAYLAND) { - // On Wayland, using KMS, the cursor is unreliable. - // Hide it by default - display_cursor = false; - } sources[source::KMS] = true; } } diff --git a/src/platform/linux/x11grab.cpp b/src/platform/linux/x11grab.cpp index 9022a10741e..5cdf2d63d39 100644 --- a/src/platform/linux/x11grab.cpp +++ b/src/platform/linux/x11grab.cpp @@ -883,8 +883,8 @@ namespace platf { } img.data = img.buffer.data(); - img.width = xcursor->width; - img.height = xcursor->height; + img.width = img.src_w = xcursor->width; + img.height = img.src_h = xcursor->height; img.x = xcursor->x - xcursor->xhot; img.y = xcursor->y - xcursor->yhot; img.pixel_pitch = 4; diff --git a/src/platform/linux/x11grab.h b/src/platform/linux/x11grab.h index 4c2f347834d..f03339cc45b 100644 --- a/src/platform/linux/x11grab.h +++ b/src/platform/linux/x11grab.h @@ -17,8 +17,6 @@ namespace egl { } namespace platf::x11 { - -#ifdef SUNSHINE_BUILD_X11 struct cursor_ctx_raw_t; void freeCursorCtx(cursor_ctx_raw_t *ctx); @@ -50,19 +48,4 @@ namespace platf::x11 { xdisplay_t make_display(); -#else - class cursor_t { - public: - static std::optional - make() { return std::nullopt; } - - void - capture(egl::cursor_t &) {} - void - blend(img_t &, int, int) {} - }; - - void * - make_display() { return nullptr; } -#endif } // namespace platf::x11 From 60c95d638542eb97d8518857acb176ce5540c595 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 6 Jan 2024 10:56:35 -0500 Subject: [PATCH 081/197] fix(web-api): allow trailing slash on endpoints (#1985) --- src/confighttp.cpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/confighttp.cpp b/src/confighttp.cpp index 50bd87d3df4..2c7d3b21a39 100644 --- a/src/confighttp.cpp +++ b/src/confighttp.cpp @@ -728,13 +728,13 @@ namespace confighttp { https_server_t server { config::nvhttp.cert, config::nvhttp.pkey }; server.default_resource["GET"] = not_found; server.resource["^/$"]["GET"] = getIndexPage; - server.resource["^/pin$"]["GET"] = getPinPage; - server.resource["^/apps$"]["GET"] = getAppsPage; - server.resource["^/clients$"]["GET"] = getClientsPage; - server.resource["^/config$"]["GET"] = getConfigPage; - server.resource["^/password$"]["GET"] = getPasswordPage; - server.resource["^/welcome$"]["GET"] = getWelcomePage; - server.resource["^/troubleshooting$"]["GET"] = getTroubleshootingPage; + server.resource["^/pin/?$"]["GET"] = getPinPage; + server.resource["^/apps/?$"]["GET"] = getAppsPage; + server.resource["^/clients/?$"]["GET"] = getClientsPage; + server.resource["^/config/?$"]["GET"] = getConfigPage; + server.resource["^/password/?$"]["GET"] = getPasswordPage; + server.resource["^/welcome/?$"]["GET"] = getWelcomePage; + server.resource["^/troubleshooting/?$"]["GET"] = getTroubleshootingPage; server.resource["^/api/pin$"]["POST"] = savePin; server.resource["^/api/apps$"]["GET"] = getApps; server.resource["^/api/logs$"]["GET"] = getLogs; From 88d46914ca5be9552d3bdc308f5ccdf4f59bd517 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 7 Jan 2024 11:30:30 -0500 Subject: [PATCH 082/197] build(deps): bump @vitejs/plugin-vue from 4.3.4 to 4.6.2 (#1965) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 738fd70d144..26e61e31031 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "dependencies": { "@fortawesome/fontawesome-free": "6.5.1", "@popperjs/core": "2.11.8", - "@vitejs/plugin-vue": "4.3.4", + "@vitejs/plugin-vue": "4.6.2", "bootstrap": "5.3.2", "vite": "4.4.9", "vite-plugin-ejs": "1.6.4", From b5fae464b638d770c12d9bcd7e3ca5e6b2e10806 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 7 Jan 2024 11:58:13 -0500 Subject: [PATCH 083/197] docs: refactor and general cleanup (#1992) --- README.rst | 2 +- docs/source/about/advanced_usage.rst | 118 ++-- docs/source/about/guides/app_examples.rst | 465 +++++++------ docs/source/about/guides/guides.rst | 2 +- .../source/about/guides/{linux => }/linux.rst | 3 +- .../about/guides/linux/headless_ssh.rst | 10 +- docs/source/about/installation.rst | 258 -------- docs/source/about/setup.rst | 610 ++++++++++++++++++ docs/source/about/third_party_packages.rst | 17 +- docs/source/about/usage.rst | 314 --------- docs/source/building/linux.rst | 4 +- docs/source/building/macos.rst | 2 +- docs/source/building/windows.rst | 2 +- docs/source/contributing/localization.rst | 4 +- docs/source/contributing/testing.rst | 2 +- docs/source/gamestream/gamestream.rst | 2 +- docs/source/{about => history}/changelog.rst | 0 docs/source/legal/legal.rst | 2 +- .../source_code/src/platform/common.rst | 2 +- .../src/platform/linux/graphics.rst | 2 +- .../source_code/src/platform/linux/misc.rst | 2 +- .../src/platform/linux/x11grab.rst | 2 +- .../src/platform/macos/av_audio.rst | 2 +- .../src/platform/macos/av_img_t.rst | 2 +- .../src/platform/macos/av_video.rst | 2 +- .../src/platform/macos/nv12_zero_device.rst | 2 +- .../src/platform/windows/PolicyConfig.rst | 2 +- .../src/platform/windows/display.rst | 2 +- docs/source/source_code/src/utility.rst | 2 +- docs/source/toc.rst | 10 +- docs/source/troubleshooting/linux.rst | 4 +- 31 files changed, 974 insertions(+), 879 deletions(-) rename docs/source/about/guides/{linux => }/linux.rst (80%) delete mode 100644 docs/source/about/installation.rst create mode 100644 docs/source/about/setup.rst delete mode 100644 docs/source/about/usage.rst rename docs/source/{about => history}/changelog.rst (100%) diff --git a/README.rst b/README.rst index 41ae6d8488e..fbc78658668 100644 --- a/README.rst +++ b/README.rst @@ -36,7 +36,7 @@ System Requirements | +------------------------------------------------------------+ | | Linux/Debian: 11 (bullseye) | | +------------------------------------------------------------+ -| | Linux/Fedora: 36+ | +| | Linux/Fedora: 37+ | | +------------------------------------------------------------+ | | Linux/Ubuntu: 20.04+ (focal) | +------------+------------------------------------------------------------+ diff --git a/docs/source/about/advanced_usage.rst b/docs/source/about/advanced_usage.rst index dc6e5f165ec..7a43779c6e1 100644 --- a/docs/source/about/advanced_usage.rst +++ b/docs/source/about/advanced_usage.rst @@ -43,7 +43,7 @@ location by modifying the configuration file. To manually configure sunshine you may edit the `conf` file in a text editor. Use the examples as reference. -.. Hint:: Some settings are not available within the web ui. +.. hint:: Some settings are not available within the web ui. General ------- @@ -130,7 +130,7 @@ gamepad **Description** The type of gamepad to emulate on the host. - .. Caution:: Applies to Windows only. + .. caution:: Applies to Windows only. **Choices** @@ -157,7 +157,7 @@ ds4_back_as_touchpad_click ^^^^^^^^^^^^^^^^^^^^^^^^^^ **Description** - .. Hint:: Only applies when gamepad is set to ds4 manually. Unused in other gamepad modes. + .. hint:: Only applies when gamepad is set to ds4 manually. Unused in other gamepad modes. Allow Select/Back inputs to also trigger DS4 touchpad click. Useful for clients looking to emulate touchpad click on Xinput devices. @@ -174,7 +174,7 @@ motion_as_ds4 ^^^^^^^^^^^^^ **Description** - .. Hint:: Only applies when gamepad is set to auto. + .. hint:: Only applies when gamepad is set to auto. If a client reports that a connected gamepad has motion sensor support, emulate it on the host as a DS4 controller. @@ -192,7 +192,7 @@ touchpad_as_ds4 ^^^^^^^^^^^^^^^ **Description** - .. Hint:: Only applies when gamepad is set to auto. + .. hint:: Only applies when gamepad is set to auto. If a client reports that a connected gamepad has a touchpad, emulate it on the host as a DS4 controller. @@ -212,7 +212,7 @@ back_button_timeout **Description** If the Back/Select button is held down for the specified number of milliseconds, a Home/Guide button press is emulated. - .. Tip:: If back_button_timeout < 0, then the Home/Guide button will not be emulated. + .. tip:: If back_button_timeout < 0, then the Home/Guide button will not be emulated. **Default** ``-1`` @@ -242,7 +242,7 @@ key_repeat_frequency **Description** How often keys repeat every second. - .. Tip:: This configurable option supports decimals. + .. tip:: This configurable option supports decimals. **Default** ``24.9`` @@ -263,7 +263,7 @@ always_send_scancodes Disable if keys on the client are generating the wrong input on the host. - .. Caution:: Applies to Windows only. + .. caution:: Applies to Windows only. **Default** ``enabled`` @@ -297,7 +297,7 @@ native_pen_touch This can be useful to disable for older applications without native pen/touch support. - .. Caution:: Applies to Windows only. + .. caution:: Applies to Windows only. **Default** ``enabled`` @@ -313,9 +313,9 @@ keybindings **Description** Sometimes it may be useful to map keybindings. Wayland won't allow clients to capture the Win Key for example. - .. Tip:: See `virtual key codes `__ + .. tip:: See `virtual key codes `__ - .. Hint:: keybindings needs to have a multiple of two elements. + .. hint:: keybindings needs to have a multiple of two elements. **Default** .. code-block:: text @@ -358,7 +358,7 @@ adapter_name **Description** Select the video card you want to stream. - .. Tip:: To find the name of the appropriate values follow these instructions. + .. tip:: To find the name of the appropriate values follow these instructions. **Linux + VA-API** Unlike with `amdvce` and `nvenc`, it doesn't matter if video encoding is done on a different GPU. @@ -374,13 +374,17 @@ adapter_name To be supported by Sunshine, it needs to have at the very minimum: ``VAProfileH264High : VAEntrypointEncSlice`` - .. Todo:: macOS + .. todo:: macOS **Windows** .. code-block:: batch tools\dxgi-info.exe + .. note:: For hybrid graphics systems, DXGI reports the outputs are connected to whichever graphics adapter + that the application is configured to use, so it's not a reliable indicator of how the display is + physically connected. + **Default** Sunshine will select the default video card. @@ -390,7 +394,7 @@ adapter_name adapter_name = /dev/dri/renderD128 - .. Todo:: macOS + .. todo:: macOS **Windows** .. code-block:: text @@ -403,7 +407,7 @@ output_name **Description** Select the display number you want to stream. - .. Tip:: To find the name of the appropriate values follow these instructions. + .. tip:: To find the name of the appropriate values follow these instructions. **Linux** During Sunshine startup, you should see the list of detected monitors: @@ -419,7 +423,7 @@ output_name You need to use the value before the colon in the output, e.g. ``1``. - .. Todo:: macOS + .. todo:: macOS **Windows** .. code-block:: batch @@ -435,7 +439,7 @@ output_name output_name = 0 - .. Todo:: macOS + .. todo:: macOS **Windows** .. code-block:: text @@ -448,7 +452,7 @@ fps **Description** The fps modes advertised by Sunshine. - .. Note:: Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested + .. note:: Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested fps is supported. **Default** @@ -465,7 +469,7 @@ resolutions **Description** The resolutions advertised by Sunshine. - .. Note:: Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested + .. note:: Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested resolution is supported. **Default** @@ -509,7 +513,7 @@ audio_sink **Description** The name of the audio sink used for audio loopback. - .. Tip:: To find the name of the audio sink follow these instructions. + .. tip:: To find the name of the audio sink follow these instructions. **Linux + pulseaudio** .. code-block:: bash @@ -533,9 +537,9 @@ audio_sink tools\audio-info.exe - .. Tip:: If you have multiple audio devices with identical names, use the Device ID instead. + .. tip:: If you have multiple audio devices with identical names, use the Device ID instead. - .. Tip:: If you want to mute the host speakers, use `virtual_sink`_ instead. + .. tip:: If you want to mute the host speakers, use `virtual_sink`_ instead. **Default** Sunshine will select the default audio device. @@ -563,9 +567,9 @@ virtual_sink The audio device that's virtual, like Steam Streaming Speakers. This allows Sunshine to stream audio, while muting the speakers. - .. Tip:: See `audio_sink`_! + .. tip:: See `audio_sink`_! - .. Tip:: These are some options for virtual sound devices. + .. tip:: These are some options for virtual sound devices. - Stream Streaming Speakers (Linux, macOS, Windows) @@ -585,7 +589,7 @@ install_steam_audio_drivers **Description** Installs the Steam Streaming Speakers driver (if Steam is installed) to support surround sound and muting host audio. - .. Tip:: This option is only supported on Windows. + .. tip:: This option is only supported on Windows. **Default** ``enabled`` @@ -634,7 +638,7 @@ port Mic (unused) 48002 UDP +13 ================ ============ =========================== -.. Attention:: Custom ports may not be supported by all Moonlight clients. +.. attention:: Custom ports may not be supported by all Moonlight clients. **Default** ``47989`` @@ -677,7 +681,7 @@ pkey **Description** The private key used for the web UI and Moonlight client pairing. For best compatibility, this should be an RSA-2048 private key. - .. Warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. + .. warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. **Default** ``credentials/cakey.pem`` @@ -693,7 +697,7 @@ cert **Description** The certificate used for the web UI and Moonlight client pairing. For best compatibility, this should have an RSA-2048 public key. - .. Warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. + .. warning:: Not all Moonlight clients support ECDSA keys or RSA key lengths other than 2048 bits. **Default** ``credentials/cacert.pem`` @@ -786,7 +790,7 @@ channels - Clients connected through WAN and LAN have different bitrate constraints. - Decoders may require different settings for color. - .. Warning:: CPU usage increases for each distinct video stream generated. + .. warning:: CPU usage increases for each distinct video stream generated. **Default** ``1`` @@ -802,7 +806,7 @@ fec_percentage **Description** Percentage of error correcting packets per data packet in each video frame. - .. Warning:: Higher values can correct for more network packet loss, but at the cost of increasing bandwidth usage. + .. warning:: Higher values can correct for more network packet loss, but at the cost of increasing bandwidth usage. **Default** ``20`` @@ -821,7 +825,7 @@ qp **Description** Quantization Parameter. Some devices don't support Constant Bit Rate. For those devices, QP is used instead. - .. Warning:: Higher value means more compression, but less quality. + .. warning:: Higher value means more compression, but less quality. **Default** ``28`` @@ -837,7 +841,7 @@ min_threads **Description** Minimum number of threads used for software encoding. - .. Note:: Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually worth it to gain + .. note:: Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually worth it to gain the use of more CPU cores for encoding. The ideal value is the lowest value that can reliably encode at your desired streaming settings on your hardware. @@ -855,7 +859,7 @@ hevc_mode **Description** Allows the client to request HEVC Main or HEVC Main10 video streams. - .. Warning:: HEVC is more CPU-intensive to encode, so enabling this may reduce performance when using software + .. warning:: HEVC is more CPU-intensive to encode, so enabling this may reduce performance when using software encoding. **Choices** @@ -886,7 +890,7 @@ av1_mode **Description** Allows the client to request AV1 Main 8-bit or 10-bit video streams. - .. Warning:: AV1 is more CPU-intensive to encode, so enabling this may reduce performance when using software + .. warning:: AV1 is more CPU-intensive to encode, so enabling this may reduce performance when using software encoding. **Choices** @@ -917,7 +921,7 @@ capture **Description** Force specific screen capture method. - .. Caution:: Applies to Linux only. + .. caution:: Applies to Linux only. **Choices** @@ -933,7 +937,7 @@ capture or `nvlax `__. wlr Capture for wlroots based Wayland compositors via DMA-BUF. kms DRM/KMS screen capture from the kernel. This requires that sunshine has cap_sys_admin capability. - See :ref:`Linux Setup `. + See :ref:`Linux Setup `. x11 Uses XCB. This is the slowest and most CPU intensive so should be avoided if possible. ========= =========== @@ -979,9 +983,9 @@ sw_preset **Description** The encoder preset to use. - .. Note:: This option only applies when using software `encoder`_. + .. note:: This option only applies when using software `encoder`_. - .. Note:: From `FFmpeg `__. + .. note:: From `FFmpeg `__. A preset is a collection of options that will provide a certain encoding speed to compression ratio. A slower preset will provide better compression (compression is quality per filesize). This means that, for example, if @@ -1023,9 +1027,9 @@ sw_tune **Description** The tuning preset to use. - .. Note:: This option only applies when using software `encoder`_. + .. note:: This option only applies when using software `encoder`_. - .. Note:: From `FFmpeg `__. + .. note:: From `FFmpeg `__. You can optionally use -tune to change settings based upon the specifics of your input. @@ -1061,7 +1065,7 @@ nvenc_preset Higher numbers improve compression (quality at given bitrate) at the cost of increased encoding latency. Recommended to change only when limited by network or decoder, otherwise similar effect can be accomplished by increasing bitrate. - .. Note:: This option only applies when using NVENC `encoder`_. + .. note:: This option only applies when using NVENC `encoder`_. **Choices** @@ -1096,7 +1100,7 @@ nvenc_twopass This allows to detect more motion vectors, better distribute bitrate across the frame and more strictly adhere to bitrate limits. Disabling it is not recommended since this can lead to occasional bitrate overshoot and subsequent packet loss. - .. Note:: This option only applies when using NVENC `encoder`_. + .. note:: This option only applies when using NVENC `encoder`_. **Choices** @@ -1127,9 +1131,9 @@ nvenc_realtime_hags Currently NVIDIA drivers may freeze in encoder when HAGS is enabled, realtime priority is used and VRAM utilization is close to maximum. Disabling this option lowers the priority to high, sidestepping the freeze at the cost of reduced capture performance when the GPU is heavily loaded. - .. Note:: This option only applies when using NVENC `encoder`_. + .. note:: This option only applies when using NVENC `encoder`_. - .. Caution:: Applies to Windows only. + .. caution:: Applies to Windows only. **Choices** @@ -1158,7 +1162,7 @@ nvenc_h264_cavlc Prefer CAVLC entropy coding over CABAC in H.264 when using NVENC. CAVLC is outdated and needs around 10% more bitrate for same quality, but provides slightly faster decoding when using software decoder. - .. Note:: This option only applies when using H.264 format with NVENC `encoder`_. + .. note:: This option only applies when using H.264 format with NVENC `encoder`_. **Choices** @@ -1186,7 +1190,7 @@ qsv_preset **Description** The encoder preset to use. - .. Note:: This option only applies when using quicksync `encoder`_. + .. note:: This option only applies when using quicksync `encoder`_. **Choices** @@ -1219,7 +1223,7 @@ qsv_coder **Description** The entropy encoding to use. - .. Note:: This option only applies when using H264 with quicksync `encoder`_. + .. note:: This option only applies when using H264 with quicksync `encoder`_. **Choices** @@ -1248,7 +1252,7 @@ amd_quality **Description** The encoder preset to use. - .. Note:: This option only applies when using amdvce `encoder`_. + .. note:: This option only applies when using amdvce `encoder`_. **Choices** @@ -1277,7 +1281,7 @@ amd_rc **Description** The encoder rate control. - .. Note:: This option only applies when using amdvce `encoder`_. + .. note:: This option only applies when using amdvce `encoder`_. **Choices** @@ -1307,7 +1311,7 @@ amd_usage **Description** The encoder usage profile, used to balance latency with encoding quality. - .. Note:: This option only applies when using amdvce `encoder`_. + .. note:: This option only applies when using amdvce `encoder`_. **Choices** @@ -1337,7 +1341,7 @@ amd_preanalysis **Description** Preanalysis can increase encoding quality at the cost of latency. - .. Note:: This option only applies when using amdvce `encoder`_. + .. note:: This option only applies when using amdvce `encoder`_. **Default** ``disabled`` @@ -1353,7 +1357,7 @@ amd_vbaq **Description** Variance Based Adaptive Quantization (VBAQ) can increase subjective visual quality. - .. Note:: This option only applies when using amdvce `encoder`_. + .. note:: This option only applies when using amdvce `encoder`_. **Default** ``enabled`` @@ -1369,7 +1373,7 @@ amd_coder **Description** The entropy encoding to use. - .. Note:: This option only applies when using H264 with amdvce `encoder`_. + .. note:: This option only applies when using H264 with amdvce `encoder`_. **Choices** @@ -1398,7 +1402,7 @@ vt_software **Description** Force Video Toolbox to use software encoding. - .. Note:: This option only applies when using macOS. + .. note:: This option only applies when using macOS. **Choices** @@ -1428,9 +1432,9 @@ vt_realtime **Description** Realtime encoding. - .. Note:: This option only applies when using macOS. + .. note:: This option only applies when using macOS. - .. Warning:: Disabling realtime encoding might result in a delayed frame encoding or frame drop. + .. warning:: Disabling realtime encoding might result in a delayed frame encoding or frame drop. **Default** ``enabled`` @@ -1446,7 +1450,7 @@ vt_coder **Description** The entropy encoding to use. - .. Note:: This option only applies when using macOS. + .. note:: This option only applies when using macOS. **Choices** diff --git a/docs/source/about/guides/app_examples.rst b/docs/source/about/guides/app_examples.rst index e0bc543253a..514bb5c710d 100644 --- a/docs/source/about/guides/app_examples.rst +++ b/docs/source/about/guides/app_examples.rst @@ -3,7 +3,7 @@ App Examples Since not all applications behave the same, we decided to create some examples to help you get started adding games and applications to Sunshine. -.. Attention:: Throughout these examples, any fields not shown are left blank. You can enhance your experience by +.. attention:: Throughout these examples, any fields not shown are left blank. You can enhance your experience by adding an image or a log file (via the ``Output`` field). Common Examples @@ -23,267 +23,330 @@ Desktop Steam Big Picture ^^^^^^^^^^^^^^^^^ -.. Note:: Steam is launched as a detached command because Steam starts with a process that self updates itself and the original +.. note:: Steam is launched as a detached command because Steam starts with a process that self updates itself and the original process is killed. Since the original process ends it will not work as a regular command. -+----------------------+------------------------------------------+----------------------------------+-----------------------------------+ -| **Field** | **Linux** | **macOS** | **Windows** | -+----------------------+------------------------------------------+----------------------------------+-----------------------------------+ -| Application Name | ``Steam Big Picture`` | -+----------------------+------------------------------------------+----------------------------------+-----------------------------------+ -| Detached Commands | ``setsid steam steam://open/bigpicture`` | ``open steam://open/bigpicture`` | ``steam steam://open/bigpicture`` | -+----------------------+------------------------------------------+----------------------------------+-----------------------------------+ -| Image | ``steam.png`` | -+----------------------+------------------------------------------+----------------------------------+-----------------------------------+ +.. tab:: Linux + + +----------------------+------------------------------------------+ + | Application Name | ``Steam Big Picture`` | + +----------------------+------------------------------------------+ + | Detached Commands | ``setsid steam steam://open/bigpicture`` | + +----------------------+------------------------------------------+ + | Image | ``steam.png`` | + +----------------------+------------------------------------------+ + +.. tab:: macOS + + +----------------------+----------------------------------+ + | Application Name | ``Steam Big Picture`` | + +----------------------+----------------------------------+ + | Detached Commands | ``open steam://open/bigpicture`` | + +----------------------+----------------------------------+ + | Image | ``steam.png`` | + +----------------------+----------------------------------+ + +.. tab:: Windows + + +----------------------+-----------------------------------+ + | Application Name | ``Steam Big Picture`` | + +----------------------+-----------------------------------+ + | Detached Commands | ``steam steam://open/bigpicture`` | + +----------------------+-----------------------------------+ + | Image | ``steam.png`` | + +----------------------+-----------------------------------+ Epic Game Store game ^^^^^^^^^^^^^^^^^^^^ -.. Note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched +.. note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched using the "Command" and therefore the stream will not end when the game ends. URI (Epic) """""""""" -+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Field** | **Windows** | -+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Application Name | ``Surviving Mars`` | -+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Detached Commands | ``cmd /C "start com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true"`` | -+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +.. tab:: Windows + + +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Detached Commands | ``cmd /C "start com.epicgames.launcher://apps/d759128018124dcabb1fbee9bb28e178%3A20729b9176c241f0b617c5723e70ec2d%3AOvenbird?action=launch&silent=true"`` | + +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Binary (Epic w/ working directory) """""""""""""""""""""""""""""""""" -+----------------------+-----------------------------------------------+ -| **Field** | **Windows** | -+----------------------+-----------------------------------------------+ -| Application Name | ``Surviving Mars`` | -+----------------------+-----------------------------------------------+ -| Command | ``cmd /c "MarsEpic.exe"`` | -+----------------------+-----------------------------------------------+ -| Working Directory | ``C:\Program Files\Epic Games\SurvivingMars`` | -+----------------------+-----------------------------------------------+ +.. tab:: Windows + + +----------------------+-----------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+-----------------------------------------------+ + | Command | ``cmd /c "MarsEpic.exe"`` | + +----------------------+-----------------------------------------------+ + | Working Directory | ``C:\Program Files\Epic Games\SurvivingMars`` | + +----------------------+-----------------------------------------------+ Binary (Epic w/o working directory) """"""""""""""""""""""""""""""""""" -+----------------------+--------------------------------------------------------------+ -| **Field** | **Windows** | -+----------------------+--------------------------------------------------------------+ -| Application Name | ``Surviving Mars`` | -+----------------------+--------------------------------------------------------------+ -| Command | ``"C:\Program Files\Epic Games\SurvivingMars\MarsEpic.exe"`` | -+----------------------+--------------------------------------------------------------+ +.. tab:: Windows + +----------------------+--------------------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+--------------------------------------------------------------+ + | Command | ``"C:\Program Files\Epic Games\SurvivingMars\MarsEpic.exe"`` | + +----------------------+--------------------------------------------------------------+ Steam game ^^^^^^^^^^ -.. Note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched +.. note:: Using URI method will be the most consistent between various games, but does not allow a game to be launched using the "Command" and therefore the stream will not end when the game ends. URI (Steam) """"""""""" -+----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+ -| **Field** | **Linux** | **macOS** | **Windows** | -+----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+ -| Application Name | ``Surviving Mars`` | -+----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+ -| Detached Commands | ``setsid steam steam://rungameid/464920`` | ``open steam://rungameid/464920`` | ``cmd /C "start steam://rungameid/464920"`` | -+----------------------+-------------------------------------------+-----------------------------------+---------------------------------------------+ +.. tab:: Linux + + +----------------------+-------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+-------------------------------------------+ + | Detached Commands | ``setsid steam steam://rungameid/464920`` | + +----------------------+-------------------------------------------+ + +.. tab:: macOS + + +----------------------+-----------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+-----------------------------------+ + | Detached Commands | ``open steam://rungameid/464920`` | + +----------------------+-----------------------------------+ + +.. tab:: Windows + + +----------------------+---------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+---------------------------------------------+ + | Detached Commands | ``cmd /C "start steam://rungameid/464920"`` | + +----------------------+---------------------------------------------+ Binary (Steam w/ working directory) """"""""""""""""""""""""""""""""""" -+----------------------+-------------------------+-------------------------+------------------------------------------------------------------+ -| **Field** | **Linux** | **macOS** | **Windows** | -+----------------------+-------------------------+-------------------------+------------------------------------------------------------------+ -| Application Name | ``Surviving Mars`` | -+----------------------+-------------------------+-------------------------+------------------------------------------------------------------+ -| Command | ``MarsSteam`` | ``cmd /c "MarsSteam.exe"`` | -+----------------------+-------------------------+-------------------------+------------------------------------------------------------------+ -| Working Directory | ``~/.steam/steam/SteamApps/common/Survivng Mars`` | ``C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars`` | -+----------------------+-------------------------+-------------------------+------------------------------------------------------------------+ +.. tab:: Linux + + +----------------------+---------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+---------------------------------------------------+ + | Command | ``MarsSteam`` | + +----------------------+---------------------------------------------------+ + | Working Directory | ``~/.steam/steam/SteamApps/common/Survivng Mars`` | + +----------------------+---------------------------------------------------+ + +.. tab:: macOS + + +----------------------+---------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+---------------------------------------------------+ + | Command | ``MarsSteam`` | + +----------------------+---------------------------------------------------+ + | Working Directory | ``~/.steam/steam/SteamApps/common/Survivng Mars`` | + +----------------------+---------------------------------------------------+ + +.. tab:: Windows + + +----------------------+------------------------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+------------------------------------------------------------------+ + | Command | ``MarsSteam.exe`` | + +----------------------+------------------------------------------------------------------+ + | Working Directory | ``C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars`` | + +----------------------+------------------------------------------------------------------+ Binary (Steam w/o working directory) """""""""""""""""""""""""""""""""""" -+----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+ -| **Field** | **Linux** | **macOS** | **Windows** | -+----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+ -| Application Name | ``Surviving Mars`` | -+----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+ -| Command | ``~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam`` | ``"C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars\MarsSteam.exe"`` | -+----------------------+------------------------------+------------------------------+----------------------------------------------------------------------------------+ +.. tab:: Linux -Linux ------ + +----------------------+-------------------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+-------------------------------------------------------------+ + | Command | ``~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam`` | + +----------------------+-------------------------------------------------------------+ -Changing Resolution and Refresh Rate (Linux - X11) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. tab:: macOS -+----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| **Field** | **Value** | -+----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ -| Command Preparations | Do: ``sh -c "xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}\" --rate ${SUNSHINE_CLIENT_FPS}"`` | -| +---------------------------------------------------------------------------------------------------------------------------------------+ -| | Undo: ``xrandr --output HDMI-1 --mode 3840x2160 --rate 120`` | -+----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------+-------------------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+-------------------------------------------------------------+ + | Command | ``~/.steam/steam/SteamApps/common/Survivng Mars/MarsSteam`` | + +----------------------+-------------------------------------------------------------+ -.. hint:: - The above only works if the xrandr mode already exists. You will need to create new modes to stream to macOS and iOS devices, since they use non standard resolutions. +.. tab:: Windows - You can update the ``Do`` command to this: - .. code-block:: bash + +----------------------+----------------------------------------------------------------------------------+ + | Application Name | ``Surviving Mars`` | + +----------------------+----------------------------------------------------------------------------------+ + | Command | ``"C:\Program Files (x86)\Steam\steamapps\common\Surviving Mars\MarsSteam.exe"`` | + +----------------------+----------------------------------------------------------------------------------+ - bash -c "${HOME}/scripts/set-custom-res.sh \"${SUNSHINE_CLIENT_WIDTH}\" \"${SUNSHINE_CLIENT_HEIGHT}\" \"${SUNSHINE_CLIENT_FPS}\"" +Prep Commands +------------- - The ``set-custom-res.sh`` will have this content: - .. code-block:: bash +Changing Resolution and Refresh Rate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - #!/bin/bash +.. tab:: Linux - # Get params and set any defaults - width=${1:-1920} - height=${2:-1080} - refresh_rate=${3:-60} + .. tab:: X11 - # You may need to adjust the scaling differently so the UI/text isn't too small / big - scale=${4:-0.55} + +----------------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Command Preparations | Do: ``sh -c "xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}\" --rate ${SUNSHINE_CLIENT_FPS}"`` | + | +------------------------------------------------------------------------------------------------------------------------------------+ + | | Undo: ``xrandr --output HDMI-1 --mode 3840x2160 --rate 120`` | + +----------------------+------------------------------------------------------------------------------------------------------------------------------------+ - # Get the name of the active display - display_output=$(xrandr | grep " connected" | awk '{ print $1 }') + .. hint:: + The above only works if the xrandr mode already exists. You will need to create new modes to stream to macOS and iOS devices, since they use non standard resolutions. - # Get the modeline info from the 2nd row in the cvt output - modeline=$(cvt ${width} ${height} ${refresh_rate} | awk 'FNR == 2') - xrandr_mode_str=${modeline//Modeline \"*\" /} - mode_alias="${width}x${height}" + You can update the ``Do`` command to this: + .. code-block:: bash - echo "xrandr setting new mode ${mode_alias} ${xrandr_mode_str}" - xrandr --newmode ${mode_alias} ${xrandr_mode_str} - xrandr --addmode ${display_output} ${mode_alias} + bash -c "${HOME}/scripts/set-custom-res.sh \"${SUNSHINE_CLIENT_WIDTH}\" \"${SUNSHINE_CLIENT_HEIGHT}\" \"${SUNSHINE_CLIENT_FPS}\"" - # Reset scaling - xrandr --output ${display_output} --scale 1 + The ``set-custom-res.sh`` will have this content: + .. code-block:: bash - # Apply new xrandr mode - xrandr --output ${display_output} --primary --mode ${mode_alias} --pos 0x0 --rotate normal --scale ${scale} + #!/bin/bash - # Optional reset your wallpaper to fit to new resolution - # xwallpaper --zoom /path/to/wallpaper.png + # Get params and set any defaults + width=${1:-1920} + height=${2:-1080} + refresh_rate=${3:-60} -Changing Resolution and Refresh Rate (Linux - Wayland) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + # You may need to adjust the scaling differently so the UI/text isn't too small / big + scale=${4:-0.55} -+----------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| **Field** | **Value** | -+----------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| Command Preparations | Do: ``sh -c "wlr-xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}Hz\""`` | -| +-------------------------------------------------------------------------------------------------------------------------------------+ -| | Undo: ``wlr-xrandr --output HDMI-1 --mode 3840x2160@120Hz`` | -+----------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + # Get the name of the active display + display_output=$(xrandr | grep " connected" | awk '{ print $1 }') -Changing Resolution and Refresh Rate (Linux - KDE Plasma - Wayland and X11) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + # Get the modeline info from the 2nd row in the cvt output + modeline=$(cvt ${width} ${height} ${refresh_rate} | awk 'FNR == 2') + xrandr_mode_str=${modeline//Modeline \"*\" /} + mode_alias="${width}x${height}" -+----------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| **Field** | **Value** | -+----------------------+----------------------------------------------------------------------------------------------------------------------------------+ -| Command Preparations | Do: ``sh -c "kscreen-doctor output.HDMI-A-1.mode.${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}"`` | -| +----------------------------------------------------------------------------------------------------------------------------------+ -| | Undo: ``kscreen-doctor output.HDMI-A-1.mode.3840x2160@120`` | -+----------------------+----------------------------------------------------------------------------------------------------------------------------------+ + echo "xrandr setting new mode ${mode_alias} ${xrandr_mode_str}" + xrandr --newmode ${mode_alias} ${xrandr_mode_str} + xrandr --addmode ${display_output} ${mode_alias} -Changing Resolution (Linux - NVIDIA) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + # Reset scaling + xrandr --output ${display_output} --scale 1 -+----------------------+------------------------------------------------------------------------------------------------------+ -| **Field** | **Value** | -+----------------------+------------------------------------------------------------------------------------------------------+ -| Command Preparations | Do: ``sh -c "${HOME}/scripts/set-custom-res.sh ${SUNSHINE_CLIENT_WIDTH} ${SUNSHINE_CLIENT_HEIGHT}"`` | -| +------------------------------------------------------------------------------------------------------+ -| | Undo: ``sh -c "${HOME}/scripts/set-custom-res.sh 3840 2160"`` | -+----------------------+------------------------------------------------------------------------------------------------------+ + # Apply new xrandr mode + xrandr --output ${display_output} --primary --mode ${mode_alias} --pos 0x0 --rotate normal --scale ${scale} -The ``set-custom-res.sh`` will have this content: - .. code-block:: bash + # Optional reset your wallpaper to fit to new resolution + # xwallpaper --zoom /path/to/wallpaper.png - #!/bin/bash + .. tab:: Wayland - # Get params and set any defaults - width=${1:-1920} - height=${2:-1080} - output=${3:-HDMI-1} - nvidia-settings -a CurrentMetaMode="${output}: nvidia-auto-select { ViewPortIn=${width}x${height}, ViewPortOut=${width}x${height}+0+0 }" + +----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Command Preparations | Do: ``sh -c "wlr-xrandr --output HDMI-1 --mode \"${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}Hz\""`` | + | +-----------------------------------------------------------------------------------------------------------------------------------+ + | | Undo: ``wlr-xrandr --output HDMI-1 --mode 3840x2160@120Hz`` | + +----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -Flatpak -^^^^^^^ + .. tab:: KDE Plasma (Wayland, X11) + + +----------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | Command Preparations | Do: ``sh -c "kscreen-doctor output.HDMI-A-1.mode.${SUNSHINE_CLIENT_WIDTH}x${SUNSHINE_CLIENT_HEIGHT}@${SUNSHINE_CLIENT_FPS}"`` | + | +----------------------------------------------------------------------------------------------------------------------------------+ + | | Undo: ``kscreen-doctor output.HDMI-A-1.mode.3840x2160@120`` | + +----------------------+----------------------------------------------------------------------------------------------------------------------------------+ + + .. tab:: NVIDIA + + +----------------------+------------------------------------------------------------------------------------------------------+ + | Command Preparations | Do: ``sh -c "${HOME}/scripts/set-custom-res.sh ${SUNSHINE_CLIENT_WIDTH} ${SUNSHINE_CLIENT_HEIGHT}"`` | + | +------------------------------------------------------------------------------------------------------+ + | | Undo: ``sh -c "${HOME}/scripts/set-custom-res.sh 3840 2160"`` | + +----------------------+------------------------------------------------------------------------------------------------------+ + + The ``set-custom-res.sh`` will have this content: + .. code-block:: bash + + #!/bin/bash + + # Get params and set any defaults + width=${1:-1920} + height=${2:-1080} + output=${3:-HDMI-1} + nvidia-settings -a CurrentMetaMode="${output}: nvidia-auto-select { ViewPortIn=${width}x${height}, ViewPortOut=${width}x${height}+0+0 }" + +.. tab:: macOS + + .. tab:: displayplacer + + .. note:: This example uses the `displayplacer` tool to change the resolution. + This tool can be installed following instructions in their + `GitHub repository `__. + + +----------------------+-----------------------------------------------------------------------------------------------+ + | Command Preparations | Do: ``displayplacer "id: res:1920x1080 hz:60 scaling:on origin:(0,0) degree:0"`` | + | +-----------------------------------------------------------------------------------------------+ + | | Undo: ``displayplacer "id: res:3840x2160 hz:120 scaling:on origin:(0,0) degree:0"`` | + +----------------------+-----------------------------------------------------------------------------------------------+ + +.. tab:: Windows + + .. tab:: QRes + + .. note:: This example uses the `QRes` tool to change the resolution and refresh rate. + This tool can be downloaded from their `SourceForge repository `__. + + +----------------------+------------------------------------------------------------------------------------------------------------------+ + | Command Preparations | Do: ``cmd /C FullPath\qres.exe /x:%SUNSHINE_CLIENT_WIDTH% /y:%SUNSHINE_CLIENT_HEIGHT% /r:%SUNSHINE_CLIENT_FPS%`` | + | +------------------------------------------------------------------------------------------------------------------+ + | | Undo: ``cmd /C FullPath\qres.exe /x:3840 /y:2160 /r:120`` | + +----------------------+------------------------------------------------------------------------------------------------------------------+ + +Additional Considerations +------------------------- + +.. tab:: Linux + + .. tab:: Flatpak + + .. attention:: Because Flatpak packages run in a sandboxed environment and do not normally have access to the + host, the Flatpak of Sunshine requires commands to be prefixed with ``flatpak-spawn --host``. + +.. tab:: Windows + + **Elevating Commands (Windows)** + + If you've installed Sunshine as a service (default), you can specify if a command should be elevated with + administrative privileges. Simply enable the elevated option in the WEB UI, or add it to the JSON configuration. + This is an option for both prep-cmd and regular commands and will launch the process with the current user without a + UAC prompt. + + .. note:: It is important to write the values "true" and "false" as string values, not as the typical true/false + values in most JSON. + + **Example** + .. code-block:: json -.. Attention:: Because Flatpak packages run in a sandboxed environment and do not normally have access to the host, - the Flatpak of Sunshine requires commands to be prefixed with ``flatpak-spawn --host``. - -macOS ------ - -Changing Resolution and Refresh Rate (macOS) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. Note:: This example uses the `displayplacer` tool to change the resolution. - This tool can be installed following instructions in their - `GitHub repository `__. - -+----------------------+-----------------------------------------------------------------------------------------------+ -| **Field** | **Value** | -+----------------------+-----------------------------------------------------------------------------------------------+ -| Command Preparations | Do: ``displayplacer "id: res:1920x1080 hz:60 scaling:on origin:(0,0) degree:0"`` | -| +-----------------------------------------------------------------------------------------------+ -| | Undo: ``displayplacer "id: res:3840x2160 hz:120 scaling:on origin:(0,0) degree:0"`` | -+----------------------+-----------------------------------------------------------------------------------------------+ - -Windows -------- - -Changing Resolution and Refresh Rate (Windows) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. Note:: This example uses the `QRes` tool to change the resolution and refresh rate. - This tool can be downloaded from their `SourceForge repository `__. - -+----------------------+------------------------------------------------------------------------------------------------------------------+ -| **Field** | **Value** | -+----------------------+------------------------------------------------------------------------------------------------------------------+ -| Command Preparations | Do: ``cmd /C FullPath\qres.exe /x:%SUNSHINE_CLIENT_WIDTH% /y:%SUNSHINE_CLIENT_HEIGHT% /r:%SUNSHINE_CLIENT_FPS%`` | -| +------------------------------------------------------------------------------------------------------------------+ -| | Undo: ``cmd /C FullPath\qres.exe /x:3840 /y:2160 /r:120`` | -+----------------------+------------------------------------------------------------------------------------------------------------------+ - -Elevating Commands (Windows) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -If you've installed Sunshine as a service (default), you can now specify if a command should be elevated with adminsitrative privileges. -Simply enable the elevated option in the WEB UI, or add it to the JSON configuration. -This is an option for both prep-cmd and regular commands and will launch the process with the current user without a UAC prompt. - -.. Note:: It's important to write the values "true" and "false" as string values, not as the typical true/false values in most JSON. - -**Example** - .. code-block:: json - - { - "name": "Game With AntiCheat that Requires Admin", - "output": "", - "cmd": "ping 127.0.0.1", - "exclude-global-prep-cmd": "false", - "elevated": "true", - "prep-cmd": [ - { - "do": "powershell.exe -command \"Start-Streaming\"", - "undo": "powershell.exe -command \"Stop-Streaming\"", - "elevated": "false" - } - ], - "image-path": "" - } + { + "name": "Game With AntiCheat that Requires Admin", + "output": "", + "cmd": "ping 127.0.0.1", + "exclude-global-prep-cmd": "false", + "elevated": "true", + "prep-cmd": [ + { + "do": "powershell.exe -command \"Start-Streaming\"", + "undo": "powershell.exe -command \"Stop-Streaming\"", + "elevated": "false" + } + ], + "image-path": "" + } diff --git a/docs/source/about/guides/guides.rst b/docs/source/about/guides/guides.rst index 3bda39ede6d..2e72e94ffa7 100644 --- a/docs/source/about/guides/guides.rst +++ b/docs/source/about/guides/guides.rst @@ -7,4 +7,4 @@ Collection of guides written by the community! :maxdepth: 2 app_examples - linux/linux + linux diff --git a/docs/source/about/guides/linux/linux.rst b/docs/source/about/guides/linux.rst similarity index 80% rename from docs/source/about/guides/linux/linux.rst rename to docs/source/about/guides/linux.rst index 4af2a8c1aa2..a7c456d201e 100644 --- a/docs/source/about/guides/linux/linux.rst +++ b/docs/source/about/guides/linux.rst @@ -5,5 +5,6 @@ Collection of Sunshine Linux host guides. .. toctree:: :maxdepth: 1 + :glob: - headless_ssh + linux/* diff --git a/docs/source/about/guides/linux/headless_ssh.rst b/docs/source/about/guides/linux/headless_ssh.rst index 1a4e9439b3e..b86bc8a7caa 100644 --- a/docs/source/about/guides/linux/headless_ssh.rst +++ b/docs/source/about/guides/linux/headless_ssh.rst @@ -42,7 +42,7 @@ Once you are done, you will need to perform these 3 steps: **Step 2** can be replaced with autologin and starting sunshine as a service or putting ``sunshine &`` in your ``.xinitrc`` file if you start your X server with ``startx``. In this case, the workaround for ``/dev/uinput`` permissions is not needed because the udev rule would be triggered - for "physical" login. See :ref:`Linux Setup `. I personally think autologin compromises the + for "physical" login. See :ref:`Linux Setup `. I personally think autologin compromises the security of the PC, so I went with the remote SSH route. I use the PC more than for gaming, so I don't need a virtual display everytime I turn on the PC (E.g running updates, config changes, file/media server). @@ -264,7 +264,7 @@ we will need to update the sudo configuration to execute this without being prom script to be executed with ``sudo``. .. note:: - After I setup the :ref:`udev rule ` to get access to ``/dev/uinput``, + After I setup the :ref:`udev rule ` to get access to ``/dev/uinput``, I noticed when I sshed into the host without physical login, the ACL permissions on ``/dev/uinput`` were not changed. So I asked `reddit `__. @@ -273,7 +273,7 @@ we will need to update the sudo configuration to execute this without being prom **Setup Script** -This script will take care of any precondtions prior to starting up sunshine. +This script will take care of any preconditions prior to starting up sunshine. Run the following to create a script named something like ``sunshine-setup.sh``: .. code-block:: bash @@ -522,5 +522,5 @@ If you have any feedback and any suggestions, feel free to make a post on Discor .. seealso:: Now that you have a virtual display, you may want to automate changing the resolution - and refresh rate prior to connecting to an app. See :ref:`Changing Resolution and - Refresh Rate ` for more information. + and refresh rate prior to connecting to an app. See :ref:`Changing Resolution and Refresh Rate + ` for more information. diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst deleted file mode 100644 index be7510ad7ec..00000000000 --- a/docs/source/about/installation.rst +++ /dev/null @@ -1,258 +0,0 @@ -Installation -============ -The recommended method for running Sunshine is to use the `binaries`_ bundled with the `latest release`_. - -.. Attention:: Additional setup is required after installation. See - :ref:`Setup `. - -Binaries --------- -Binaries of Sunshine are created for each release. They are available for Linux, macOS, and Windows. -Binaries can be found in the `latest release`_. - -.. Tip:: Some third party packages also exist. See - :ref:`Third Party Packages `. - -Docker ------- -Docker images are available on `Dockerhub.io`_ and `ghcr.io`_. - -See :ref:`Docker ` for additional information. - -Linux ------ -Follow the instructions for your preferred package type below. - -**CUDA Compatibility** - -CUDA is used for NVFBC capture. - -.. Tip:: See `CUDA GPUS `__ to cross reference Compute Capability to your GPU. - -.. table:: - :widths: auto - - =========================================== ============== ============== ================================ - Package CUDA Version Min Driver CUDA Compute Capabilities - =========================================== ============== ============== ================================ - PKGBUILD User dependent User dependent User dependent - sunshine.AppImage 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 - sunshine.pkg.tar.zst 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 - sunshine_{arch}.flatpak 12.0.0 525.60.13 50;52;60;61;62;70;75;80;86;90 - sunshine-debian-bookworm-{arch}.deb 12.0.0 525.60.13 50;52;60;61;62;70;75;80;86;90 - sunshine-debian-bullseye-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 - sunshine-fedora-38-{arch}.rpm unavailable unavailable none - sunshine-fedora-39-{arch}.rpm unavailable unavailable none - sunshine-ubuntu-20.04-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 - sunshine-ubuntu-22.04-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 - =========================================== ============== ============== ================================ - -AppImage -^^^^^^^^ -According to AppImageLint the supported distro matrix of the AppImage is below. - -- [✖] Debian oldstable (buster) -- [✔] Debian stable (bullseye) -- [✔] Debian testing (bookworm) -- [✔] Debian unstable (sid) -- [✔] Ubuntu kinetic -- [✔] Ubuntu jammy -- [✔] Ubuntu focal -- [✖] Ubuntu bionic -- [✖] Ubuntu xenial -- [✖] Ubuntu trusty -- [✖] CentOS 7 - -#. Download ``sunshine.AppImage`` to your home directory. -#. Open terminal and run the following code. - - .. code-block:: bash - - ./sunshine.AppImage --install - -Start: - .. code-block:: bash - - ./sunshine.AppImage --install && ./sunshine.AppImage - -Uninstall: - .. code-block:: bash - - ./sunshine.AppImage --remove - -Archlinux PKGBUILD -^^^^^^^^^^^^^^^^^^ -#. Open terminal and run the following code. - - .. code-block:: bash - - wget https://github.com/LizardByte/Sunshine/releases/latest/download/PKGBUILD - makepkg -fi - -Uninstall: - .. code-block:: bash - - pacman -R sunshine - -Archlinux pkg -^^^^^^^^^^^^^ -#. Open terminal and run the following code. - - .. code-block:: bash - - wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.pkg.tar.zst - pacman -U --noconfirm sunshine.pkg.tar.zst - -Uninstall: - .. code-block:: bash - - pacman -R sunshine - -Debian Package -^^^^^^^^^^^^^^ -#. Download ``sunshine-{ubuntu-version}.deb`` and run the following code. - - .. code-block:: bash - - sudo apt install -f ./sunshine-{ubuntu-version}.deb - -.. Note:: The ``{ubuntu-version}`` is the version of ubuntu we built the package on. If you are not using Ubuntu and - have an issue with one package, you can try another. - -.. Tip:: You can double click the deb file to see details about the package and begin installation. - -Uninstall: - .. code-block:: bash - - sudo apt remove sunshine - -Flatpak Package -^^^^^^^^^^^^^^^ -#. Install `Flatpak `__ as required. -#. Download ``sunshine_{arch}.flatpak`` and run the following code. - - .. Note:: Be sure to replace ``{arch}`` with the architecture for your operating system. - - System level (recommended) - .. code-block:: bash - - flatpak install --system ./sunshine_{arch}.flatpak - - User level - .. code-block:: bash - - flatpak install --user ./sunshine_{arch}.flatpak - - Additional installation (required) - .. code-block:: bash - - flatpak run --command=additional-install.sh dev.lizardbyte.sunshine - -Start: - X11 and NVFBC capture (X11 Only) - .. code-block:: bash - - flatpak run dev.lizardbyte.sunshine - - KMS capture (Wayland & X11) - .. code-block:: bash - - sudo -i PULSE_SERVER=unix:$(pactl info | awk '/Server String/{print$3}') flatpak run dev.lizardbyte.sunshine - -Uninstall: - .. code-block:: bash - - flatpak run --command=remove-additional-install.sh dev.lizardbyte.sunshine - flatpak uninstall --delete-data dev.lizardbyte.sunshine - -RPM Package -^^^^^^^^^^^ -#. Add `rpmfusion` repositories by running the following code. - - .. code-block:: bash - - sudo dnf install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \ - https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm - -#. Download ``sunshine.rpm`` and run the following code. - - .. code-block:: bash - - sudo dnf install ./sunshine.rpm - -.. Tip:: You can double click the rpm file to see details about the package and begin installation. - -Uninstall: - .. code-block:: bash - - sudo dnf remove sunshine - -macOS ------ -Sunshine on macOS is experimental. Gamepads do not work. Other features may not work as expected. - -dmg -^^^ -.. Warning:: The `dmg` does not include runtime dependencies. - -#. Download the ``sunshine.dmg`` file and install it. - -Uninstall: - .. code-block:: bash - - cd /etc/sunshine/assets - uninstall_pkg.sh - -Portfile -^^^^^^^^ -#. Install `MacPorts `__ -#. Update the Macports sources. - - .. code-block:: bash - - sudo nano /opt/local/etc/macports/sources.conf - - Add this line, replacing your username, below the line that starts with ``rsync``. - ``file:///Users//ports`` - - ``Ctrl+x``, then ``Y`` to exit and save changes. - -#. Download the ``Portfile`` to ``~/Downloads`` and run the following code. - - .. code-block:: bash - - mkdir -p ~/ports/multimedia/sunshine - mv ~/Downloads/Portfile ~/ports/multimedia/sunshine/ - cd ~/ports - portindex - sudo port install sunshine - -#. The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone. - -Uninstall: - .. code-block:: bash - - sudo port uninstall sunshine - -Windows -------- - -Installer -^^^^^^^^^ -#. Download and install ``sunshine-windows-installer.exe`` - -.. Attention:: You should carefully select or unselect the options you want to install. Do not blindly install or enable - features. - -To uninstall, find Sunshine in the list `here `__ and select "Uninstall" from the overflow -menu. Different versions of Windows may provide slightly different steps for uninstall. - -Standalone -^^^^^^^^^^ -#. Download and extract ``sunshine-windows-portable.zip`` - -To uninstall, delete the extracted directory which contains the ``sunshine.exe`` file. - -.. _latest release: https://github.com/LizardByte/Sunshine/releases/latest -.. _Dockerhub.io: https://hub.docker.com/repository/docker/lizardbyte/sunshine -.. _ghcr.io: https://github.com/orgs/LizardByte/packages?repo_name=sunshine diff --git a/docs/source/about/setup.rst b/docs/source/about/setup.rst new file mode 100644 index 00000000000..bed5d8b735c --- /dev/null +++ b/docs/source/about/setup.rst @@ -0,0 +1,610 @@ +Setup +===== +.. _latest release: https://github.com/LizardByte/Sunshine/releases/latest + +The recommended method for running Sunshine is to use the `binaries`_ bundled with the `latest release`_. + +Binaries +-------- +Binaries of Sunshine are created for each release. They are available for Linux, macOS, and Windows. +Binaries can be found in the `latest release`_. + +.. tip:: Some third party packages also exist. See + :ref:`Third Party Packages `. + No support will be provided for third party packages! + +Install +------- +.. tab:: Docker + + .. warning:: The Docker images are not recommended for most users. No support will be provided! + + Docker images are available on `Dockerhub.io `__ + and `ghcr.io `__. + + See :ref:`Docker ` for additional information. + +.. tab:: Linux + + **CUDA Compatibility** + + CUDA is used for NVFBC capture. + + .. tip:: See `CUDA GPUS `__ to cross reference Compute Capability to your GPU. + + .. table:: + :widths: auto + + =========================================== ============== ============== ================================ + Package CUDA Version Min Driver CUDA Compute Capabilities + =========================================== ============== ============== ================================ + PKGBUILD User dependent User dependent User dependent + sunshine.AppImage 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 + sunshine.pkg.tar.zst 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 + sunshine_{arch}.flatpak 12.0.0 525.60.13 50;52;60;61;62;70;75;80;86;90 + sunshine-debian-bookworm-{arch}.deb 12.0.0 525.60.13 50;52;60;61;62;70;75;80;86;90 + sunshine-debian-bullseye-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 + sunshine-fedora-38-{arch}.rpm unavailable unavailable none + sunshine-fedora-39-{arch}.rpm unavailable unavailable none + sunshine-ubuntu-20.04-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 + sunshine-ubuntu-22.04-{arch}.deb 11.8.0 450.80.02 35;50;52;60;61;62;70;75;80;86;90 + =========================================== ============== ============== ================================ + + .. tab:: AppImage + + According to AppImageLint the supported distro matrix of the AppImage is below. + + - ✔ Debian bullseye + - ✔ Debian bookworm + - ✔ Debian trixie + - ✖ Debian sid + - ✔ Ubuntu mantic + - ✔ Ubuntu lunar + - ✔ Ubuntu jammy + - ✔ Ubuntu focal + - ✖ Ubuntu bionic + - ✖ Ubuntu xenial + - ✖ Ubuntu trusty + - ✖ CentOS 7 + + #. Download ``sunshine.AppImage`` to your home directory. + + .. code-block:: bash + + cd ~ + wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.AppImage + + #. Open terminal and run the following code. + + .. code-block:: bash + + ./sunshine.AppImage --install + + Start: + .. code-block:: bash + + ./sunshine.AppImage --install && ./sunshine.AppImage + + Uninstall: + .. code-block:: bash + + ./sunshine.AppImage --remove + + .. tab:: Archlinux PKGBUILD + + #. Open terminal and run the following code. + + .. code-block:: bash + + wget https://github.com/LizardByte/Sunshine/releases/latest/download/PKGBUILD + makepkg -fi + + Uninstall: + .. code-block:: bash + + pacman -R sunshine + + .. tab:: Archlinux pkg + + #. Open terminal and run the following code. + + .. code-block:: bash + + wget https://github.com/LizardByte/Sunshine/releases/latest/download/sunshine.pkg.tar.zst + pacman -U --noconfirm sunshine.pkg.tar.zst + + Uninstall: + .. code-block:: bash + + pacman -R sunshine + + .. tab:: Debian Package + + #. Download ``sunshine-{distro}-{distro-version}-{arch}.deb`` and run the following code. + + .. code-block:: bash + + sudo apt install -f ./sunshine-{distro}-{distro-version}-{arch}.deb + + .. note:: The ``{distro-version}`` is the version of the distro we built the package on. The ``{arch}`` is the + architecture of your operating system. + + .. tip:: You can double click the deb file to see details about the package and begin installation. + + Uninstall: + .. code-block:: bash + + sudo apt remove sunshine + + .. tab:: Flatpak Package + + .. important:: The instructions provided here are for the version supplied in the `latest release`_, which does + not necessarily match the version in the Flathub repository! + + #. Install `Flatpak `__ as required. + #. Download ``sunshine_{arch}.flatpak`` and run the following code. + + .. note:: Be sure to replace ``{arch}`` with the architecture for your operating system. + + System level (recommended) + .. code-block:: bash + + flatpak install --system ./sunshine_{arch}.flatpak + + User level + .. code-block:: bash + + flatpak install --user ./sunshine_{arch}.flatpak + + Additional installation (required) + .. code-block:: bash + + flatpak run --command=additional-install.sh dev.lizardbyte.sunshine + + Start: + X11 and NVFBC capture (X11 Only) + .. code-block:: bash + + flatpak run dev.lizardbyte.sunshine + + KMS capture (Wayland & X11) + .. code-block:: bash + + sudo -i PULSE_SERVER=unix:$(pactl info | awk '/Server String/{print$3}') \ + flatpak run dev.lizardbyte.sunshine + + Uninstall: + .. code-block:: bash + + flatpak run --command=remove-additional-install.sh dev.lizardbyte.sunshine + flatpak uninstall --delete-data dev.lizardbyte.sunshine + + .. tab:: RPM Package + + #. Add `rpmfusion` repositories by running the following code. + + .. code-block:: bash + + sudo dnf install \ + https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm \ + https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm + + #. Download ``sunshine-{distro}-{distro-version}-{arch}.rpm`` and run the following code. + + .. code-block:: bash + + sudo dnf install ./sunshine-{distro}-{distro-version}-{arch}.rpm + + .. note:: The ``{distro-version}`` is the version of the distro we built the package on. The ``{arch}`` is the + architecture of your operating system. + + .. tip:: You can double click the rpm file to see details about the package and begin installation. + + Uninstall: + .. code-block:: bash + + sudo dnf remove sunshine + + The `deb`, `rpm`, `Flatpak` and `AppImage` packages should handle these steps automatically. + Third party packages may not. + + Sunshine needs access to `uinput` to create mouse and gamepad events. + + #. Create `udev` rules. + .. code-block:: bash + + echo 'KERNEL=="uinput", SUBSYSTEM=="misc", OPTIONS+="static_node=uinput", TAG+="uaccess"' | \ + sudo tee /etc/udev/rules.d/85-sunshine.rules + + #. Optionally, configure autostart service + + - filename: ``~/.config/systemd/user/sunshine.service`` + - contents: + .. code-block:: cfg + + [Unit] + Description=Sunshine self-hosted game stream host for Moonlight. + StartLimitIntervalSec=500 + StartLimitBurst=5 + + [Service] + ExecStart= + Restart=on-failure + RestartSec=5s + #Flatpak Only + #ExecStop=flatpak kill dev.lizardbyte.sunshine + + [Install] + WantedBy=graphical-session.target + + .. table:: + :widths: auto + + ======== ============================================== =============== + package ExecStart Auto Configured + ======== ============================================== =============== + aur /usr/bin/sunshine ✔ + deb /usr/bin/sunshine ✔ + rpm /usr/bin/sunshine ✔ + AppImage ~/sunshine.AppImage ✔ + Flatpak flatpak run dev.lizardbyte.sunshine ✔ + ======== ============================================== =============== + + **Start once** + .. code-block:: bash + + systemctl --user start sunshine + + **Start on boot** + .. code-block:: bash + + systemctl --user enable sunshine + + #. Additional Setup for KMS + .. note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to + allow Sunshine to use KMS. + + **Enable** + .. code-block:: bash + + sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine)) + + **Disable (for Xorg/X11)** + .. code-block:: bash + + sudo setcap -r $(readlink -f $(which sunshine)) + + #. Reboot + .. code-block:: bash + + sudo reboot now + +.. tab:: macOS + + .. important:: Sunshine on macOS is experimental. Gamepads do not work. Other features may not work as expected. + + .. tab:: dmg + + .. warning:: The `dmg` does not include runtime dependencies. This package is not recommended for most users. + No support will be provided! + + #. Download the ``sunshine.dmg`` file and install it. + + Uninstall: + .. code-block:: bash + + cd /etc/sunshine/assets + uninstall_pkg.sh + + .. tab:: Portfile + + #. Install `MacPorts `__ + #. Update the Macports sources. + + .. code-block:: bash + + sudo nano /opt/local/etc/macports/sources.conf + + Add this line, replacing your username, below the line that starts with ``rsync``. + ``file:///Users//ports`` + + ``Ctrl+x``, then ``Y`` to exit and save changes. + + #. Download the ``Portfile`` to ``~/Downloads`` and run the following code. + + .. code-block:: bash + + mkdir -p ~/ports/multimedia/sunshine + cd ~/ports/multimedia/sunshine + curl -O https://github.com/LizardByte/Sunshine/releases/latest/download/Portfile + cd ~/ports + portindex + sudo port install sunshine + + #. The first time you start Sunshine, you will be asked to grant access to screen recording and your microphone. + + #. Optionally, install service + + .. code-block:: bash + + sudo port load Sunshine + + Uninstall: + .. code-block:: bash + + sudo port uninstall sunshine + + Sunshine can only access microphones on macOS due to system limitations. To stream system audio use + `Soundflower `__ or + `BlackHole `__. + + .. note:: Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key. + + .. caution:: Gamepads are not currently supported. + +.. tab:: Windows + + .. tab:: Installer + + #. Download and install ``sunshine-windows-installer.exe`` + + .. attention:: You should carefully select or unselect the options you want to install. Do not blindly install or + enable features. + + To uninstall, find Sunshine in the list `here `__ and select "Uninstall" from the + overflow menu. Different versions of Windows may provide slightly different steps for uninstall. + + .. tab:: Standalone + + .. warning:: By using this package instead of the installer, performance will be reduced. This package is not + recommended for most users. No support will be provided! + + #. Download and extract ``sunshine-windows-portable.zip`` + #. Open command prompt as administrator + #. Firewall rules + + Install: + .. code-block:: bash + + cd /d {path to extracted directory} + scripts/add-firewall-rule.bat + + Uninstall: + .. code-block:: bash + + cd /d {path to extracted directory} + scripts/delete-firewall-rule.bat + + #. Virtual Gamepad Support + + Install: + .. code-block:: bash + + cd /d {path to extracted directory} + scripts/install-gamepad.bat + + Uninstall: + .. code-block:: bash + + cd /d {path to extracted directory} + scripts/uninstall-gamepad.bat + + #. Windows service + + Install: + .. code-block:: bash + + cd /d {path to extracted directory} + scripts/install-service.bat + scripts/autostart-service.bat + + Uninstall: + .. code-block:: bash + + cd /d {path to extracted directory} + scripts/uninstall-service.bat + + To uninstall, delete the extracted directory which contains the ``sunshine.exe`` file. + +Usage +----- +#. If Sunshine is not installed/running as a service, then start sunshine with the following command, unless a start + command is listed in the specified package `install`_ instructions above. + + .. note:: A service is a process that runs in the background. This is the default when installing Sunshine from the + Windows installer. Running multiple instances of Sunshine is not advised. + + **Basic usage** + .. code-block:: bash + + sunshine + + **Specify config file** + .. code-block:: bash + + sunshine /sunshine.conf + + .. note:: You do not need to specify a config file. + If no config file is entered the default location will be used. + + .. attention:: The configuration file specified will be created if it doesn't exist. + + **Start Sunshine over SSH (Linux/X11)** + Assuming you are already logged into the host, you can use this command + + .. code-block:: bash + + ssh @ 'export DISPLAY=:0; sunshine' + + If you are logged into the host with only a tty (teletypewriter), you can use ``startx`` to start the + X server prior to executing sunshine. + You nay need to add ``sleep`` between ``startx`` and ``sunshine`` to allow more time for the display to be ready. + + .. code-block:: bash + + ssh @ 'startx &; export DISPLAY=:0; sunshine' + + .. tip:: You could also utilize the ``~/.bash_profile`` or ``~/.bashrc`` files to setup the ``DISPLAY`` + variable. + + .. seealso:: + + See :ref:`Remote SSH Headless Setup + ` on + how to setup a headless streaming server without autologin and dummy plugs (X11 + NVidia GPUs) + +#. Configure Sunshine in the web ui + + The web ui is available on `https://localhost:47990 `__ by default. You may replace + `localhost` with your internal ip address. + + .. attention:: Ignore any warning given by your browser about "insecure website". This is due to the SSL certificate + being self signed. + + .. caution:: If running for the first time, make sure to note the username and password that you created. + + #. Add games and applications. + #. Adjust any configuration settings as needed. + +#. In Moonlight, you may need to add the PC manually. +#. When Moonlight requests for you insert the pin: + + - Login to the web ui + - Go to "PIN" in the Navbar + - Type in your PIN and press Enter, you should get a Success Message + - In Moonlight, select one of the Applications listed + +Network +------- +The Sunshine user interface will be available on port 47990 by default. + +.. warning:: Exposing ports to the internet can be dangerous. Do this at your own risk. + +Arguments +--------- +To get a list of available arguments run the following: + +.. tab:: General + + .. code-block:: bash + + sunshine --help + +.. tab:: AppImage + + .. code-block:: bash + + ./sunshine.AppImage --help + +.. tab:: Flatpak + + .. code-block:: bash + + flatpak run --command=sunshine dev.lizardbyte.Sunshine --help + +Shortcuts +--------- +All shortcuts start with ``CTRL + ALT + SHIFT``, just like Moonlight + +- ``CTRL + ALT + SHIFT + N`` - Hide/Unhide the cursor (This may be useful for Remote Desktop Mode for Moonlight) +- ``CTRL + ALT + SHIFT + F1/F12`` - Switch to different monitor for Streaming + +Application List +---------------- +- Applications should be configured via the web UI. +- A basic understanding of working directories and commands is required. +- You can use Environment variables in place of values +- ``$(HOME)`` will be replaced by the value of ``$HOME`` +- ``$$`` will be replaced by ``$``, e.g. ``$$(HOME)`` will be become ``$(HOME)`` +- ``env`` - Adds or overwrites Environment variables for the commands/applications run by Sunshine +- ``"Variable name":"Variable value"`` +- ``apps`` - The list of applications +- Advanced users may want to edit the application list manually. The format is ``json``. +- Example ``json`` application: + .. code-block:: json + + { + "cmd": "command to open app", + "detached": [ + "some-command", + "another-command" + ], + "image-path": "/full-path/to/png-image", + "name": "An App", + "output": "/full-path/to/command-log-file", + "prep-cmd": [ + { + "do": "some-command", + "undo": "undo-that-command" + } + ], + "working-dir": "/full-path/to/working-directory" + } + + - ``cmd`` - The main application + - ``detached`` - A list of commands to be run and forgotten about + + - If not specified, a process is started that sleeps indefinitely + + - ``image-path`` - The full path to the cover art image to use. + - ``name`` - The name of the application/game + - ``output`` - The file where the output of the command is stored + - ``auto-detach`` - Specifies whether the app should be treated as detached if it exits quickly + - ``prep-cmd`` - A list of commands to be run before/after the application + + - If any of the prep-commands fail, starting the application is aborted + - ``do`` - Run before the application + + - If it fails, all ``undo`` commands of the previously succeeded ``do`` commands are run + + - ``undo`` - Run after the application has terminated + + - Failures of ``undo`` commands are ignored + + - ``working-dir`` - The working directory to use. If not specified, Sunshine will use the application directory. + +- For more examples see :ref:`app examples `. + +Considerations +-------------- +- On Windows, Sunshine uses the Desktop Duplication API which only supports capturing from the GPU used for display. + If you want to capture and encode on the eGPU, connect a display or HDMI dummy display dongle to it and run the games + on that display. +- When an application is started, if there is an application already running, it will be terminated. +- When the application has been shutdown, the stream shuts down as well. + + - For example, if you attempt to run ``steam`` as a ``cmd`` instead of ``detached`` the stream will immediately fail. + This is due to the method in which the steam process is executed. Other applications may behave similarly. + - This does not apply to ``detached`` applications. + +- The "Desktop" app works the same as any other application except it has no commands. It does not start an application, + instead it simply starts a stream. If you removed it and would like to get it back, just add a new application with + the name "Desktop" and "desktop.png" as the image path. +- For the Linux flatpak you must prepend commands with ``flatpak-spawn --host``. + +HDR Support +----------- +Streaming HDR content is supported for Windows hosts with NVIDIA, AMD, or Intel GPUs that support encoding HEVC Main 10. +You must have an HDR-capable display or EDID emulator dongle connected to your host PC to activate HDR in Windows. + +- Ensure you enable the HDR option in your Moonlight client settings, otherwise the stream will be SDR. +- A good HDR experience relies on proper HDR display calibration both in Windows and in game. HDR calibration can differ significantly between client and host displays. +- We recommend calibrating the display by streaming the Windows HDR Calibration app to your client device and saving an HDR calibration profile to use while streaming. +- You may also need to tune the brightness slider or HDR calibration options in game to the different HDR brightness capabilities of your client's display. +- Older games that use NVIDIA-specific NVAPI HDR rather than native Windows 10 OS HDR support may not display in HDR. +- Some GPUs can produce lower image quality or encoding performance when streaming in HDR compared to SDR. + +.. seealso:: + `Arch wiki on HDR Support for Linux `__ and + `Reddit Guide for HDR Support for AMD GPUs + `__ + +Tutorials and Guides +-------------------- +Tutorial videos are available `here `_. + +Guides are available :doc:`here <./guides/guides>`. + +.. admonition:: Community! + + Tutorials and Guides are community generated. Want to contribute? Reach out to us on our discord server. diff --git a/docs/source/about/third_party_packages.rst b/docs/source/about/third_party_packages.rst index d45188c4a0d..3d650928f91 100644 --- a/docs/source/about/third_party_packages.rst +++ b/docs/source/about/third_party_packages.rst @@ -1,7 +1,7 @@ Third Party Packages ==================== -.. Danger:: These packages are not maintained by LizardByte. Use at your own risk. +.. danger:: These packages are not maintained by LizardByte. Use at your own risk. AUR --- @@ -35,18 +35,3 @@ Solus .. image:: https://img.shields.io/badge/dynamic/xml.svg?color=orange&label=Solus&style=for-the-badge&prefix=v&query=%2F%2Ftr%5B%40id%3D%27solus%27%5D%2Ftd%5B3%5D%2Fspan%2Fa&url=https%3A%2F%2Frepology.org%2Fproject%2Fsunshine%2Fversions&logo=solus :alt: Solus Version :target: https://dev.getsol.us/source/sunshine - -Legacy GitHub Repo ------------------- - -.. Attention:: This repo is not maintained. Thank you to Loki for bringing this amazing project to life! - -.. image:: https://img.shields.io/static/v1.svg?label=repo&message=loki-47-6F-64/sunshine&color=blue&style=for-the-badge&logo=github - :alt: GitHub Maintainer - :target: https://github.com/loki-47-6F-64/sunshine/releases - -.. image:: https://img.shields.io/github/last-commit/loki-47-6F-64/sunshine.svg?style=for-the-badge&logo=github - :alt: GitHub last commit - -.. image:: https://img.shields.io/github/release-date/loki-47-6F-64/sunshine.svg?style=for-the-badge&logo=github - :alt: GitHub Release Date diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst deleted file mode 100644 index b59df1281d3..00000000000 --- a/docs/source/about/usage.rst +++ /dev/null @@ -1,314 +0,0 @@ -Usage -===== -#. See the `setup`_ section for your specific OS. -#. If you did not install the service, then start sunshine with the following command, unless a start command is listed - in the specified package :ref:`installation ` instructions. - - .. Note:: A service is a process that runs in the background. Running multiple instances of Sunshine is not - advised. - - **Basic usage** - .. code-block:: bash - - sunshine - - **Specify config file** - .. code-block:: bash - - sunshine /sunshine.conf - - .. Note:: You do not need to specify a config file. If no config file is entered the default location will be used. - - .. Attention:: The configuration file specified will be created if it doesn't exist. - - **Start Sunshine over SSH (Linux/X11)** - Assuming you are already logged into the host, you can use this command - - .. code-block:: bash - - ssh @ 'export DISPLAY=:0; sunshine' - - If you are logged into the host with only a tty (teletypewriter), you can use ``startx`` to start the - X server prior to executing sunshine. - You nay need to add ``sleep`` between ``startx`` and ``sunshine`` to allow more time for the display to be ready. - - .. code-block:: bash - - ssh @ 'startx &; export DISPLAY=:0; sunshine' - - .. tip:: You could also utilize the ``~/.bash_profile`` or ``~/.bashrc`` files to setup the ``DISPLAY`` - variable. - - .. seealso:: - - See :ref:`Remote SSH Headless Setup - ` on - how to setup a headless streaming server without autologin and dummy plugs (X11 + NVidia GPUs) - -#. Configure Sunshine in the web ui - - The web ui is available on `https://localhost:47990 `__ by default. You may replace - `localhost` with your internal ip address. - - .. Attention:: Ignore any warning given by your browser about "insecure website". This is due to the SSL certificate - being self signed. - - .. Caution:: If running for the first time, make sure to note the username and password that you created. - - **Add games and applications.** - This can be configured in the web ui. - - .. Note:: Additionally, apps can be configured manually. `src_assets//config/apps.json` is an example of a - list of applications that are started just before running a stream. This is the directory within the GitHub - repo. - -#. In Moonlight, you may need to add the PC manually. -#. When Moonlight request you insert the correct pin on sunshine: - - - Login to the web ui - - Go to "PIN" in the Navbar - - Type in your PIN and press Enter, you should get a Success Message - - In Moonlight, select one of the Applications listed - -Network -------- -The Sunshine user interface will be available on port 47990 by default. - -.. Warning:: Exposing ports to the internet can be dangerous. Do this at your own risk. - -Arguments ---------- -To get a list of available arguments run the following: - .. code-block:: bash - - sunshine --help - -Setup ------ - -Linux -^^^^^ -The `deb`, `rpm`, `Flatpak` and `AppImage` packages handle these steps automatically. Third party packages may not. - -Sunshine needs access to `uinput` to create mouse and gamepad events. - -#. Create `udev` rules. - .. code-block:: bash - - echo 'KERNEL=="uinput", SUBSYSTEM=="misc", OPTIONS+="static_node=uinput", TAG+="uaccess"' | \ - sudo tee /etc/udev/rules.d/85-sunshine.rules - -#. Optionally, configure autostart service - - - filename: ``~/.config/systemd/user/sunshine.service`` - - contents: - .. code-block:: cfg - - [Unit] - Description=Sunshine self-hosted game stream host for Moonlight. - StartLimitIntervalSec=500 - StartLimitBurst=5 - - [Service] - ExecStart= - Restart=on-failure - RestartSec=5s - #Flatpak Only - #ExecStop=flatpak kill dev.lizardbyte.sunshine - - [Install] - WantedBy=graphical-session.target - - .. table:: - :widths: auto - - ======== ============================================== =============== - package ExecStart Auto Configured - ======== ============================================== =============== - aur /usr/bin/sunshine ✔ - deb /usr/bin/sunshine ✔ - rpm /usr/bin/sunshine ✔ - AppImage ~/sunshine.AppImage ✔ - Flatpak flatpak run dev.lizardbyte.sunshine ✔ - ======== ============================================== =============== - - **Start once** - .. code-block:: bash - - systemctl --user start sunshine - - **Start on boot** - .. code-block:: bash - - systemctl --user enable sunshine - -#. Additional Setup for KMS - .. Note:: ``cap_sys_admin`` may as well be root, except you don't need to be root to run it. It is necessary to - allow Sunshine to use KMS. - - **Enable** - .. code-block:: bash - - sudo setcap cap_sys_admin+p $(readlink -f $(which sunshine)) - - **Disable (for Xorg/X11)** - .. code-block:: bash - - sudo setcap -r $(readlink -f $(which sunshine)) - -#. Reboot - .. code-block:: bash - - sudo reboot now - -macOS -^^^^^ -Sunshine can only access microphones on macOS due to system limitations. To stream system audio use -`Soundflower `__ or -`BlackHole `__. - -.. Note:: Command Keys are not forwarded by Moonlight. Right Option-Key is mapped to CMD-Key. - -.. Caution:: Gamepads are not currently supported. - -Configure autostart service - **MacPorts** - .. code-block:: bash - - sudo port load Sunshine - -Windows -^^^^^^^ -For gamepad support, install `Nefarius Virtual Gamepad `__ - -Sunshine firewall - **Add rule** - .. code-block:: batch - - cd /d "C:\Program Files\Sunshine\scripts" - add-firewall-rule.bat - - **Remove rule** - .. code-block:: batch - - cd /d "C:\Program Files\Sunshine\scripts" - remove-firewall-rule.bat - -Sunshine service - **Enable** - .. code-block:: batch - - cd /d "C:\Program Files\Sunshine\scripts" - install-service.bat - - **Disable** - .. code-block:: batch - - cd /d "C:\Program Files\Sunshine\scripts" - uninstall-service.bat - -Shortcuts ---------- -All shortcuts start with ``CTRL + ALT + SHIFT``, just like Moonlight - -- ``CTRL + ALT + SHIFT + N`` - Hide/Unhide the cursor (This may be useful for Remote Desktop Mode for Moonlight) -- ``CTRL + ALT + SHIFT + F1/F12`` - Switch to different monitor for Streaming - -Application List ----------------- -- Applications should be configured via the web UI. -- A basic understanding of working directories and commands is required. -- You can use Environment variables in place of values -- ``$(HOME)`` will be replaced by the value of ``$HOME`` -- ``$$`` will be replaced by ``$``, e.g. ``$$(HOME)`` will be become ``$(HOME)`` -- ``env`` - Adds or overwrites Environment variables for the commands/applications run by Sunshine -- ``"Variable name":"Variable value"`` -- ``apps`` - The list of applications -- Advanced users may want to edit the application list manually. The format is ``json``. -- Example ``json`` application: - .. code-block:: json - - { - "cmd": "command to open app", - "detached": [ - "some-command", - "another-command" - ], - "image-path": "/full-path/to/png-image", - "name": "An App", - "output": "/full-path/to/command-log-file", - "prep-cmd": [ - { - "do": "some-command", - "undo": "undo-that-command" - } - ], - "working-dir": "/full-path/to/working-directory" - } - - - ``cmd`` - The main application - - ``detached`` - A list of commands to be run and forgotten about - - - If not specified, a process is started that sleeps indefinitely - - - ``image-path`` - The full path to the cover art image to use. - - ``name`` - The name of the application/game - - ``output`` - The file where the output of the command is stored - - ``auto-detach`` - Specifies whether the app should be treated as detached if it exits quickly - - ``prep-cmd`` - A list of commands to be run before/after the application - - - If any of the prep-commands fail, starting the application is aborted - - ``do`` - Run before the application - - - If it fails, all ``undo`` commands of the previously succeeded ``do`` commands are run - - - ``undo`` - Run after the application has terminated - - - Failures of ``undo`` commands are ignored - - - ``working-dir`` - The working directory to use. If not specified, Sunshine will use the application directory. - -- For more examples see :ref:`app examples `. - -Considerations --------------- -- On Windows, Sunshine uses the Desktop Duplication API which only supports capturing from the GPU used for display. - If you want to capture and encode on the eGPU, connect a display or HDMI dummy display dongle to it and run the games - on that display. -- When an application is started, if there is an application already running, it will be terminated. -- When the application has been shutdown, the stream shuts down as well. - - - For example, if you attempt to run ``steam`` as a ``cmd`` instead of ``detached`` the stream will immediately fail. - This is due to the method in which the steam process is executed. Other applications may behave similarly. - -- The "Desktop" app works the same as any other application except it has no commands. It does not start an application, - instead it simply starts a stream. If you removed it and would like to get it back, just add a new application with - the name "Desktop" and "desktop.png" as the image path. -- For the Linux flatpak you must prepend commands with ``flatpak-spawn --host``. - -HDR Support ------------ -Streaming HDR content is supported for Windows hosts with NVIDIA, AMD, or Intel GPUs that support encoding HEVC Main 10. -You must have an HDR-capable display or EDID emulator dongle connected to your host PC to activate HDR in Windows. - -- Ensure you enable the HDR option in your Moonlight client settings, otherwise the stream will be SDR. -- A good HDR experience relies on proper HDR display calibration both in Windows and in game. HDR calibration can differ significantly between client and host displays. -- We recommend calibrating the display by streaming the Windows HDR Calibration app to your client device and saving an HDR calibration profile to use while streaming. -- You may also need to tune the brightness slider or HDR calibration options in game to the different HDR brightness capabilities of your client's display. -- Older games that use NVIDIA-specific NVAPI HDR rather than native Windows 10 OS HDR support may not display in HDR. -- Some GPUs can produce lower image quality or encoding performance when streaming in HDR compared to SDR. - -.. seealso:: - `Arch wiki on HDR Support for Linux `__ and - `Reddit Guide for HDR Support for AMD GPUs - `__ - -Tutorials and Guides --------------------- -Tutorial videos are available `here `_. - -Guides are available :doc:`here <./guides/guides>`. - -.. admonition:: Community! - - Tutorials and Guides are community generated. Want to contribute? Reach out to us on our discord server. diff --git a/docs/source/building/linux.rst b/docs/source/building/linux.rst index 9982998ca2d..fdd8be7f155 100644 --- a/docs/source/building/linux.rst +++ b/docs/source/building/linux.rst @@ -183,7 +183,7 @@ CUDA ---- If the version of CUDA available from your distro is not adequate, manually install CUDA. -.. Tip:: The version of CUDA you use will determine compatibility with various GPU generations. +.. tip:: The version of CUDA you use will determine compatibility with various GPU generations. See `CUDA compatibility `__ for more info. Select the appropriate run file based on your desired CUDA version and architecture according to @@ -199,7 +199,7 @@ If the version of CUDA available from your distro is not adequate, manually inst Build ----- -.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. +.. attention:: Ensure you are in the build directory created during the clone step earlier before continuing. .. code-block:: bash diff --git a/docs/source/building/macos.rst b/docs/source/building/macos.rst index d64e4572a6e..c14751c28f8 100644 --- a/docs/source/building/macos.rst +++ b/docs/source/building/macos.rst @@ -26,7 +26,7 @@ Install Requirements Build ----- -.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. +.. attention:: Ensure you are in the build directory created during the clone step earlier before continuing. .. code-block:: bash diff --git a/docs/source/building/windows.rst b/docs/source/building/windows.rst index 6c8b844fdac..8e83c58e99d 100644 --- a/docs/source/building/windows.rst +++ b/docs/source/building/windows.rst @@ -34,7 +34,7 @@ Install dependencies: Build ----- -.. Attention:: Ensure you are in the build directory created during the clone step earlier before continuing. +.. attention:: Ensure you are in the build directory created during the clone step earlier before continuing. .. code-block:: bash diff --git a/docs/source/contributing/localization.rst b/docs/source/contributing/localization.rst index ef2c811c4a9..2ca912805e1 100644 --- a/docs/source/contributing/localization.rst +++ b/docs/source/contributing/localization.rst @@ -41,10 +41,10 @@ situations. For example if a system tray icon is added it should be localized as std::string msg = boost::locale::translate("Hello world!"); -.. Tip:: More examples can be found in the documentation for +.. tip:: More examples can be found in the documentation for `boost locale `__. -.. Warning:: This is for information only. Contributors should never include manually updated template files, or +.. warning:: This is for information only. Contributors should never include manually updated template files, or manually compiled language files in Pull Requests. Strings are automatically extracted from the code to the `locale/sunshine.po` template file. The generated file is diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst index e3ed073447a..e4b3ae10502 100644 --- a/docs/source/contributing/testing.rst +++ b/docs/source/contributing/testing.rst @@ -59,5 +59,5 @@ Format inplace with rstfmt Unit Testing ------------ -.. Todo:: Sunshine does not currently have any unit tests. If you would like to help us improve please get in contact +.. todo:: Sunshine does not currently have any unit tests. If you would like to help us improve please get in contact with us, or make a PR with suggested changes. diff --git a/docs/source/gamestream/gamestream.rst b/docs/source/gamestream/gamestream.rst index a0cabbd3f17..74e468f4bb3 100644 --- a/docs/source/gamestream/gamestream.rst +++ b/docs/source/gamestream/gamestream.rst @@ -8,7 +8,7 @@ Migration --------- We have developed a simple migration tool to help you migrate your GameStream games and apps to Sunshine automatically. Please check out our `GSMS `__ project if you're interested in an automated -migration option. At the time of writing this GSMS offers the ability to migrate your custom games and apps. The +migration option. GSMS offers the ability to migrate your custom and auto-detected games and apps. The working directory, command, and image are all set in Sunshine's ``apps.json`` file. The box-art image is also copied to a specified directory. diff --git a/docs/source/about/changelog.rst b/docs/source/history/changelog.rst similarity index 100% rename from docs/source/about/changelog.rst rename to docs/source/history/changelog.rst diff --git a/docs/source/legal/legal.rst b/docs/source/legal/legal.rst index 4fb55b0450b..3fd3b8f2c28 100644 --- a/docs/source/legal/legal.rst +++ b/docs/source/legal/legal.rst @@ -1,6 +1,6 @@ Legal ===== -.. Attention:: This documentation is for informational purposes only and is not intended as legal advice. If you have +.. attention:: This documentation is for informational purposes only and is not intended as legal advice. If you have any legal questions or concerns about using Sunshine, we recommend consulting with a lawyer. Sunshine is licensed under the GPL-3.0 license, which allows for free use and modification of the software. diff --git a/docs/source/source_code/src/platform/common.rst b/docs/source/source_code/src/platform/common.rst index 3e09f6db049..ec0ca47a9b6 100644 --- a/docs/source/source_code/src/platform/common.rst +++ b/docs/source/source_code/src/platform/common.rst @@ -1,4 +1,4 @@ common ====== -.. Todo:: Add common.h +.. todo:: Add common.h diff --git a/docs/source/source_code/src/platform/linux/graphics.rst b/docs/source/source_code/src/platform/linux/graphics.rst index 0ecd4b99403..2f44e10986e 100644 --- a/docs/source/source_code/src/platform/linux/graphics.rst +++ b/docs/source/source_code/src/platform/linux/graphics.rst @@ -1,4 +1,4 @@ graphics ======== -.. Todo:: Add graphics.h +.. todo:: Add graphics.h diff --git a/docs/source/source_code/src/platform/linux/misc.rst b/docs/source/source_code/src/platform/linux/misc.rst index 155a8302eee..2e30a58eda1 100644 --- a/docs/source/source_code/src/platform/linux/misc.rst +++ b/docs/source/source_code/src/platform/linux/misc.rst @@ -1,4 +1,4 @@ misc ==== -.. Todo:: Add misc.h +.. todo:: Add misc.h diff --git a/docs/source/source_code/src/platform/linux/x11grab.rst b/docs/source/source_code/src/platform/linux/x11grab.rst index 8b8ef0f362a..c0c2f7cccce 100644 --- a/docs/source/source_code/src/platform/linux/x11grab.rst +++ b/docs/source/source_code/src/platform/linux/x11grab.rst @@ -1,4 +1,4 @@ x11grab ======= -.. Todo:: Add x11grab.h +.. todo:: Add x11grab.h diff --git a/docs/source/source_code/src/platform/macos/av_audio.rst b/docs/source/source_code/src/platform/macos/av_audio.rst index 4d36dfd764e..92f04868e19 100644 --- a/docs/source/source_code/src/platform/macos/av_audio.rst +++ b/docs/source/source_code/src/platform/macos/av_audio.rst @@ -1,4 +1,4 @@ av_audio ======== -.. Todo:: Add av_audio.h +.. todo:: Add av_audio.h diff --git a/docs/source/source_code/src/platform/macos/av_img_t.rst b/docs/source/source_code/src/platform/macos/av_img_t.rst index 74ef60c98ab..4fa8510ddea 100644 --- a/docs/source/source_code/src/platform/macos/av_img_t.rst +++ b/docs/source/source_code/src/platform/macos/av_img_t.rst @@ -1,4 +1,4 @@ av_img_t ======== -.. Todo:: Add av_img_t.h +.. todo:: Add av_img_t.h diff --git a/docs/source/source_code/src/platform/macos/av_video.rst b/docs/source/source_code/src/platform/macos/av_video.rst index f6fd1e5ba36..179b180b8b9 100644 --- a/docs/source/source_code/src/platform/macos/av_video.rst +++ b/docs/source/source_code/src/platform/macos/av_video.rst @@ -1,4 +1,4 @@ av_video ======== -.. Todo:: Add av_video.h +.. todo:: Add av_video.h diff --git a/docs/source/source_code/src/platform/macos/nv12_zero_device.rst b/docs/source/source_code/src/platform/macos/nv12_zero_device.rst index ecab415e0d8..8e236a5125e 100644 --- a/docs/source/source_code/src/platform/macos/nv12_zero_device.rst +++ b/docs/source/source_code/src/platform/macos/nv12_zero_device.rst @@ -1,4 +1,4 @@ nv12_zero_device ================ -.. Todo:: Add nv12_zero_device.h +.. todo:: Add nv12_zero_device.h diff --git a/docs/source/source_code/src/platform/windows/PolicyConfig.rst b/docs/source/source_code/src/platform/windows/PolicyConfig.rst index 1e6bb024e13..a47e89ac4b0 100644 --- a/docs/source/source_code/src/platform/windows/PolicyConfig.rst +++ b/docs/source/source_code/src/platform/windows/PolicyConfig.rst @@ -1,4 +1,4 @@ PolicyConfig ============ -.. Todo:: Add PolicyConfig.h +.. todo:: Add PolicyConfig.h diff --git a/docs/source/source_code/src/platform/windows/display.rst b/docs/source/source_code/src/platform/windows/display.rst index b8566de8ed3..033e22e29fa 100644 --- a/docs/source/source_code/src/platform/windows/display.rst +++ b/docs/source/source_code/src/platform/windows/display.rst @@ -1,4 +1,4 @@ display ======= -.. Todo:: Add display.h +.. todo:: Add display.h diff --git a/docs/source/source_code/src/utility.rst b/docs/source/source_code/src/utility.rst index 08174df61ce..80ffd14ad5a 100644 --- a/docs/source/source_code/src/utility.rst +++ b/docs/source/source_code/src/utility.rst @@ -1,4 +1,4 @@ utility ======= -.. Todo:: Add utility.h +.. todo:: Add utility.h diff --git a/docs/source/toc.rst b/docs/source/toc.rst index 7b182a2c91d..53ffe687c92 100644 --- a/docs/source/toc.rst +++ b/docs/source/toc.rst @@ -3,13 +3,11 @@ :caption: About about/overview - about/installation + about/setup about/docker about/third_party_packages - about/usage about/guides/guides about/advanced_usage - about/changelog .. toctree:: :maxdepth: 2 @@ -54,3 +52,9 @@ :caption: source source_code/source_code + +.. toctree:: + :maxdepth: 2 + :caption: History + + history/changelog diff --git a/docs/source/troubleshooting/linux.rst b/docs/source/troubleshooting/linux.rst index 7458aa587d2..8fc08b2e5e4 100644 --- a/docs/source/troubleshooting/linux.rst +++ b/docs/source/troubleshooting/linux.rst @@ -13,14 +13,14 @@ If you see the above error in the Sunshine logs, compiling `Mesa` manually, may be required. See the official Mesa3D `Compiling and Installing `__ documentation for instructions. -.. Important:: You must re-enable the disabled encoders. You can do so, by passing the following argument to the build +.. important:: You must re-enable the disabled encoders. You can do so, by passing the following argument to the build system. You may also want to enable decoders, however that is not required for Sunshine and is not covered here. .. code-block:: bash -Dvideo-codecs=h264enc,h265enc -.. Note:: Other build options are listed in the +.. note:: Other build options are listed in the `meson options `__ file. KMS Streaming fails From d873c8b0882203d2cebca983a5ee252245966173 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 7 Jan 2024 12:31:36 -0500 Subject: [PATCH 084/197] build(deps): bump vue from 3.2.25 to 3.4.5 (#1983) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 26e61e31031..b9a70637337 100644 --- a/package.json +++ b/package.json @@ -10,6 +10,6 @@ "bootstrap": "5.3.2", "vite": "4.4.9", "vite-plugin-ejs": "1.6.4", - "vue": "3.2.25" + "vue": "3.4.5" } } From de7b81e3b4fd4d4a986a8a83fe3a71919da1f873 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 7 Jan 2024 13:32:32 -0500 Subject: [PATCH 085/197] fix(ui): reorder and add missing config options (#1993) --- src_assets/common/assets/web/ResourceCard.vue | 6 +- src_assets/common/assets/web/apps.html | 16 +- src_assets/common/assets/web/config.html | 714 +++++++++++------- src_assets/common/assets/web/index.html | 6 +- src_assets/common/assets/web/pin.html | 2 +- .../common/assets/web/troubleshooting.html | 16 +- src_assets/common/assets/web/welcome.html | 2 +- 7 files changed, 486 insertions(+), 276 deletions(-) diff --git a/src_assets/common/assets/web/ResourceCard.vue b/src_assets/common/assets/web/ResourceCard.vue index 8bdfb5f9311..e2481ca475a 100644 --- a/src_assets/common/assets/web/ResourceCard.vue +++ b/src_assets/common/assets/web/ResourceCard.vue @@ -2,7 +2,7 @@

Resources

-
+

Resources for Sunshine!

@@ -15,11 +15,11 @@

- +

Legal

-
+

By continuing to use this software you agree to the terms and conditions in the following documents.

diff --git a/src_assets/common/assets/web/apps.html b/src_assets/common/assets/web/apps.html index c9131440340..21e3ced6954 100644 --- a/src_assets/common/assets/web/apps.html +++ b/src_assets/common/assets/web/apps.html @@ -102,7 +102,7 @@

Applications

- +
@@ -110,7 +110,7 @@

Applications

Application Name, as shown on Moonlight
- +
Applications specified, the output is ignored
- +
Applications that sleeps indefinitely
- +
About Environment Variables href="https://docs.lizardbyte.dev/projects/sunshine/en/latest/about/guides/app_examples.html" target="_blank">See More
- +
- -
-
-
- -
-
- {{f}} - × -
-
- - -
-
-
-
- The display modes advertised by Sunshine
- Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested - resolutions and fps are supported.
- This setting does not change how the screen stream is sent to Moonlight -
-
+
@@ -189,21 +108,50 @@

Configuration

-
- + +
- + +
+ + +
+ The file where current apps of Sunshine are stored +
+
+ + +
+ + +
+ Store Username/Password separately from Sunshine's state file. +
+
+ + +
+ + +
+ The file where the current logs of Sunshine are stored. +
+
+ +
The private key used for the web UI and Moonlight client pairing. For best compatibility, this should be an RSA-2048 private key.
- + +
@@ -213,7 +161,7 @@

Configuration

- +
Configuration The file where current state of Sunshine is stored
- + +
+ + +
+
- - + +
- The file where current apps of Sunshine are stored + Allows guests to control the host system with a gamepad / controller
-
-
- -
+ + +
+ v-model="config.ds4_back_as_touchpad_click"> @@ -266,21 +221,21 @@

-
+

+ aria-labelledby="panelsStayOpen-headingOne">
@@ -289,7 +244,7 @@

@@ -299,31 +254,21 @@

- -
+ + +
+ v-model="config.back_button_timeout" />
If the Back/Select button is held down for the specified number of milliseconds, a Home/Guide button press - is - emulated.
- If set to a value < 0 (default), holding the Back/Select button will not emulate the Home/Guide - button.
+ is emulated.
+ If set to a value < 0 (default), holding the Back/Select button will not emulate the Home/Guide button.
- -
- - -
- Allows guests to control the host system with the mouse -
-
- + + +
- - - -
- Allows guests to control the host system with a gamepad / controller -
-
+ -
+
+ v-model="config.key_repeat_delay" />
- Control how fast keys will repeat themselves
+ Control how fast keys will repeat themselves
The initial delay in milliseconds before repeating keys
+ -
+
+ v-model="config.key_repeat_frequency" />
- How often keys repeat every second
+ How often keys repeat every second
This configurable option supports decimals
+ -
+
- Sending scancodes enhances compatibility with games and apps - but may result in incorrect keyboard input from certain clients - that aren't using a US English keyboard layout.
- Enable if keyboard input is not working at all in certain applications.
+ Sending scancodes enhances compatibility with games and apps but may result in incorrect keyboard + input from certain clients that aren't using a US English keyboard layout.
+ Enable if keyboard input is not working at all in certain applications.
Disable if keys on the client are generating the wrong input on the host.
+ -
+
- It may be possible that you cannot send the Windows Key from Moonlight directly.
+ It may be possible that you cannot send the Windows Key from Moonlight directly.
In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key
- + + +
+ + +
+ Allows guests to control the host system with the mouse +
+
+ + +
- When enabled, Sunshine will pass through high resolution scroll events from Moonlight clients.
- This can be useful to disable for older applications that scroll too fast with high resolution scroll events. + When enabled, Sunshine will pass through high resolution scroll events from Moonlight clients.
+ This can be useful to disable for older applications that scroll too fast with high resolution + scroll events.
+ -
+
- When enabled, Sunshine will pass through native pen/touch events from Moonlight clients.
+ When enabled, Sunshine will pass through native pen/touch events from Moonlight clients.
This can be useful to disable for older applications without native pen/touch support.
+
- + +
- +
- Manually specify a specific audio device to capture. If unset, the device is chosen automatically.
- We strongly recommend leaving this field blank to use automatic device selection!
+ Manually specify a specific audio device to capture. If unset, the device is chosen automatically.
+ We strongly recommend leaving this field blank to use automatic device selection!
If you have multiple audio devices with identical names, you can get the Device ID using the following - command:
+ command:
tools\audio-info.exe
@@ -437,13 +392,13 @@

- The name of the audio sink used for Audio Loopback
- If you do not specify this variable, pulseaudio will select the default monitor device.
-
- You can find the name of the audio sink using either command:
+ The name of the audio sink used for Audio Loopback
+ If you do not specify this variable, pulseaudio will select the default monitor device.
+
+ You can find the name of the audio sink using either command:
pacmd list-sinks | grep "name:"
pactl info | grep Source
-
+

@@ -451,26 +406,26 @@

- The name of the audio sink used for Audio Loopback
- Sunshine can only access microphones on macOS due to system limitations.
- To stream system audio using - Soundflower - or - BlackHole - . + The name of the audio sink used for Audio Loopback
+ Sunshine can only access microphones on macOS due to system limitations.
+ To stream system audio using + Soundflower or + BlackHole.

- + +
- Manually specify a virtual audio device to use. If unset, the device is chosen automatically.
- We strongly recommend leaving this field blank to use automatic device selection!
+ Manually specify a virtual audio device to use. If unset, the device is chosen automatically.
+ We strongly recommend leaving this field blank to use automatic device selection!
- + +
-
- Manually specify a GPU to use for capture. If unset, the GPU is chosen automatically.
- We strongly recommend leaving this field blank to use automatic GPU selection!
- Note: This GPU must have a display connected and powered on.
- The appropriate values can be found using the following command:
+
+ Manually specify a GPU to use for capture. If unset, the GPU is chosen automatically.
+ We strongly recommend leaving this field blank to use automatic GPU selection!
+ Note: This GPU must have a display connected and powered on.
+ The appropriate values can be found using the following command:
tools\dxgi-info.exe
- +
+ + +
+ Manually specify a GPU to use for capture.
+ 
ls /dev/dri/renderD*  # to find all devices capable of VAAPI
+ 
+              vainfo --display drm --device /dev/dri/renderD129 | \
+                grep -E "((VAProfileH264High|VAProfileHEVCMain|VAProfileHEVCMain10).*VAEntrypointEncSlice)|Driver version"
+
+ Replace ``renderD129`` with the device from above to lists the name and capabilities of the device.
+ To be supported by Sunshine, it needs to have at the very minimum: + VAProfileH264High : VAEntrypointEncSlice +
+
+ +
- Manually specify a display to use for capture. If unset, the primary display is captured.
- Note: If you specified a GPU above, this display must be connected to that GPU.
- The appropriate values can be found using the following command:
- tools\dxgi-info.exe
+ Manually specify a display to use for capture. If unset, the primary display is captured.
+ Note: If you specified a GPU above, this display must be connected to that GPU.
+ The appropriate values can be found using the following command:
+ tools\dxgi-info.exe
- During Sunshine startup, you should see the list of detected monitors, e.g.:
-
+ During Sunshine startup, you should see the list of detected monitors, e.g.:
+ 
             Info: Detecting connected monitors
             Info: Detected monitor 0: DVI-D-0, connected: false
@@ -524,9 +496,64 @@ 

             You need to use the value before the colon in the output, e.g. 1.
+ + +
+ +
+ +
+
+ {{r}} + × +
+
+
+ + +
+
+ + +
+ +
+
+ {{f}} + × +
+
+
+ + +
+
+ +
+ The display modes advertised by Sunshine.
+ Some versions of Moonlight, such as Moonlight-nx (Switch), rely on these lists to ensure that the requested + resolutions and fps are supported.
+ This setting does not change how the screen stream is sent to Moonlight. +
+
+
-
- + + +
+
Set the address family used by Sunshine
- + +
Exposing the Web UI to the internet is a security - risk! - Proceed at your own risk! + risk! Proceed at your own risk! +
+
+ + +
+ + +
+ The origin of the remote endpoint address that is not denied access to Web UI +
+
+ + +
+ + +
Automatically configure port forwarding
+
+ + +
+ + +
+ If no external IP address is given, Sunshine will automatically detect external IP
+ + +
+ + +
+ How long to wait in milliseconds for data from moonlight before shutting down the stream +
+
+ +
+ + +
+ +
+ + +
+ When multicasting, it could be useful to have different configurations for each connected Client. For example: +
    +
  • Clients connected through WAN and LAN have different bitrate constraints.
    • +
  • Decoders may require different settings for color
    • +
+ Unlike simply broadcasting to multiple Client, this will generate distinct video streams.
+ Note, CPU usage increases for each distinct video stream generated +
+
+ + +
+ + +
+ Percentage of error correcting packets per data packet in each video frame.
+ Higher values can correct for more network packet loss, but at the cost of increasing bandwidth usage.
+ The default value of 20 is what GeForce Experience uses. +
+
+
- Quantization Parameter
- Some devices may not support Constant Bit Rate.
- For those devices, QP is used instead.
- Higher value means more compression, but less quality
+ Quantization Parameter
+ Some devices may not support Constant Bit Rate.
+ For those devices, QP is used instead.
+ Higher value means more compression, but less quality
-
- -
+ +
- - +
+ Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually
+ worth it to gain the use of more CPU cores for encoding. The ideal value is the lowest
+ value that can reliably encode at your desired streaming settings on your hardware. +
+
+ + +
+ +
- Optimize the trade-off between encoding speed (encoded frames per second) and compression efficiency - (quality - per bit in the bitstream). Defaults to superfast. + Allows the client to request HEVC Main or HEVC Main10 video streams.
+ HEVC is more CPU-intensive to encode, so enabling this may reduce performance when using software encoding.
+ +
- - + - - - - + +
- Tuning options, which are applied after the preset. Defaults to zerolatency. + Allows the client to request AV1 Main 8-bit or 10-bit video streams.
+ AV1 is more CPU-intensive to encode, so enabling this may reduce performance when using software encoding.
+ + +
+ + +
+ Force a specific capture method, otherwise Sunshine will use the first one that works. + NvFBC requires patched nvidia drivers. +
+
+ + +
+ + +
+ Force a specific encoder, otherwise Sunshine will select the best available option.
+ Note: If you specify a hardware encoder on Windows, it must match the GPU where the display is connected. +
+
+
- + +
- +
@@ -689,13 +843,13 @@

Adds preliminary encoding pass.
This allows to detect more motion vectors, better distribute bitrate across the frame and more strictly - adhere - to - bitrate limits.
+ adhere to bitrate limits.
Disabling it is not recommended since this can lead to occasional bitrate overshoot and subsequent packet loss.

+ +

@@ -707,6 +861,7 @@

+
+ +
@@ -753,6 +911,8 @@

+ +
+
- + +
- +
+ +
+ +
+ +
+ +
+ +
- -
- -
- + +
- +
+ + +
+
+ + +
+ Optimize the trade-off between encoding speed (encoded frames per second) and compression efficiency + (quality per bit in the bitstream). Defaults to superfast. +
+
+
+ + +
+ Tuning options, which are applied after the preset. Defaults to zerolatency. +
+
+
+

+ +
Success! Click 'Apply' to restart Sunshine and apply changes. This will terminate any running sessions.
@@ -857,6 +1067,7 @@

+