Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(capture/linux): Support XDG portal and Pipewire #2507

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
+843 −2
Draft

feat(capture/linux): Support XDG portal and Pipewire #2507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bce513
third-party: Add stubs for EGL DMA-BUF query APIs
garnacho May 4, 2024
e6101e3
linux: Support streaming through XDG portals and Pipewire
garnacho May 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion cmake/compile_definitions/linux.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,12 +189,29 @@ if(X11_FOUND)
"${CMAKE_SOURCE_DIR}/src/platform/linux/x11grab.cpp")
endif()

# XDG portal
if (${SUNSHINE_ENABLE_PORTAL})
pkg_check_modules(GIO gio-2.0 gio-unix-2.0)
pkg_check_modules(PIPEWIRE libpipewire-0.3)
Comment on lines +194 to +195
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Runtime deps will need to be added here: https://github.com/LizardByte/Sunshine/blob/master/cmake/packaging/linux.cmake#L43-L73

And for packaging need to be added in these different places:

else()
set(GIO_FOUND OFF)
set(PIPEWIRE_FOUND OFF)
endif()
if(PIPEWIRE_FOUND)
add_compile_definitions(SUNSHINE_BUILD_PORTAL)
include_directories(${GIO_INCLUDE_DIRS} ${PIPEWIRE_INCLUDE_DIRS})
list(APPEND PLATFORM_LIBRARIES ${GIO_LIBRARIES} ${PIPEWIRE_LIBRARIES})
list(APPEND PLATFORM_TARGET_FILES
"${CMAKE_SOURCE_DIR}/src/platform/linux/portalgrab.cpp")
endif()

if(NOT ${CUDA_FOUND}
AND NOT ${WAYLAND_FOUND}
AND NOT ${X11_FOUND}
AND NOT ${PIPEWIRE_FOUND}
AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND})
AND NOT ${LIBVA_FOUND})
Comment on lines 209 to 213
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
AND NOT ${WAYLAND_FOUND}
AND NOT ${X11_FOUND}
AND NOT ${PIPEWIRE_FOUND}
AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND})
AND NOT ${LIBVA_FOUND})
AND NOT ${LIBVA_FOUND}
AND NOT ${PIPEWIRE_FOUND}
AND NOT ${WAYLAND_FOUND}
AND NOT ${X11_FOUND}
AND NOT (${LIBDRM_FOUND} AND ${LIBCAP_FOUND})
)

message(FATAL_ERROR "Couldn't find either cuda, wayland, x11, (libdrm and libcap), or libva")
message(FATAL_ERROR "Couldn't find either cuda, wayland, x11, pipewire, (libdrm and libcap), or libva")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
message(FATAL_ERROR "Couldn't find either cuda, wayland, x11, pipewire, (libdrm and libcap), or libva")
message(FATAL_ERROR "Couldn't find either cuda, libva, pipewire, wayland, x11, or (libdrm and libcap)")

Let's alphabetize these.

endif()

# tray icon
Expand Down
2 changes: 2 additions & 0 deletions cmake/prep/options.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,6 @@ elseif(UNIX) # Linux
"Enable building wayland specific code." ON)
option(SUNSHINE_ENABLE_X11
"Enable X11 grab if available." ON)
option(SUNSHINE_ENABLE_PORTAL
"Enable XDG portal grab if available" ON)
endif()
31 changes: 31 additions & 0 deletions src/platform/linux/misc.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,9 @@ namespace platf {
#endif
#ifdef SUNSHINE_BUILD_X11
X11,
#endif
#ifdef SUNSHINE_BUILD_PORTAL
PORTAL,
#endif
MAX_FLAGS
};
Expand Down Expand Up @@ -822,6 +825,18 @@ namespace platf {
}
#endif

#ifdef SUNSHINE_BUILD_PORTAL
std::vector<std::string>
portal_display_names();
std::shared_ptr<display_t>
portal_display(mem_type_e hwdevice_type, const std::string &display_name, const video::config_t &config);

bool
verify_portal() {
return !portal_display_names().empty();
}
#endif

std::vector<std::string>
display_names(mem_type_e hwdevice_type) {
#ifdef SUNSHINE_BUILD_CUDA
Expand All @@ -836,6 +851,9 @@ namespace platf {
#endif
#ifdef SUNSHINE_BUILD_X11
if (sources[source::X11]) return x11_display_names();
#endif
#ifdef SUNSHINE_BUILD_PORTAL
if (sources[source::PORTAL]) return portal_display_names();
#endif
return {};
}
Expand All @@ -852,6 +870,12 @@ namespace platf {

std::shared_ptr<display_t>
display(mem_type_e hwdevice_type, const std::string &display_name, const video::config_t &config) {
#ifdef SUNSHINE_BUILD_PORTAL
if (sources[source::PORTAL]) {
BOOST_LOG(info) << "Screencasting with XDG portal"sv;
return portal_display(hwdevice_type, display_name, config);
}
#endif
#ifdef SUNSHINE_BUILD_CUDA
if (sources[source::NVFBC] && hwdevice_type == mem_type_e::cuda) {
BOOST_LOG(info) << "Screencasting with NvFBC"sv;
Expand Down Expand Up @@ -931,6 +955,13 @@ namespace platf {
}
}
#endif
#ifdef SUNSHINE_BUILD_PORTAL
if (config::video.capture.empty() || config::video.capture == "portal") {
if (verify_portal()) {
sources[source::PORTAL] = true;
}
}
#endif

if (sources.none()) {
BOOST_LOG(error) << "Unable to initialize capture method"sv;
Expand Down
Loading