/** * @file src/platform/linux/portalgrab.cpp * @brief Definitions for XDG portal grab. */ // standard includes #include #include #include #include #include #include #include #include #include // lib includes #include #include #include #include #include #include #include // local includes #include "cuda.h" #include "graphics.h" #include "src/main.h" #include "src/platform/common.h" #include "src/video.h" #include "vaapi.h" #include "wayland.h" namespace { // Buffer and limit constants constexpr int SPA_POD_BUFFER_SIZE = 4096; constexpr int MAX_PARAMS = 200; constexpr int MAX_DMABUF_FORMATS = 200; constexpr int MAX_DMABUF_MODIFIERS = 200; // Portal configuration constants constexpr uint32_t SOURCE_TYPE_MONITOR = 1; constexpr uint32_t CURSOR_MODE_EMBEDDED = 2; constexpr uint32_t PERSIST_FORGET = 0; constexpr uint32_t PERSIST_WHILE_RUNNING = 2; // Portal D-Bus interface names and paths constexpr const char *PORTAL_NAME = "org.freedesktop.portal.Desktop"; constexpr const char *PORTAL_PATH = "/org/freedesktop/portal/desktop"; constexpr const char *REMOTE_DESKTOP_IFACE = "org.freedesktop.portal.RemoteDesktop"; constexpr const char *SCREENCAST_IFACE = "org.freedesktop.portal.ScreenCast"; constexpr const char *REQUEST_IFACE = "org.freedesktop.portal.Request"; constexpr const char REQUEST_PREFIX[] = "/org/freedesktop/portal/desktop/request/"; constexpr const char SESSION_PREFIX[] = "/org/freedesktop/portal/desktop/session/"; } // namespace using namespace std::literals; namespace portal { // Forward declarations class session_cache_t; class restore_token_t { public: static std::string get() { return *token_; } static void set(std::string_view value) { *token_ = value; } static bool empty() { return token_->empty(); } static void load() { std::ifstream file(get_file_path()); if (file.is_open()) { std::getline(file, *token_); if (!token_->empty()) { BOOST_LOG(info) << "Loaded portal restore token from disk"sv; } } } static void save() { if (token_->empty()) { return; } std::ofstream file(get_file_path()); if (file.is_open()) { file << *token_; BOOST_LOG(info) << "Saved portal restore token to disk"sv; } else { BOOST_LOG(warning) << "Failed to save portal restore token"sv; } } private: static inline const std::unique_ptr token_ = std::make_unique(); static std::string get_file_path() { return platf::appdata().string() + "/portal_token"; } }; struct format_map_t { uint64_t fourcc; int32_t pw_format; }; static constexpr std::array format_map = {{ {DRM_FORMAT_ARGB8888, SPA_VIDEO_FORMAT_BGRA}, {DRM_FORMAT_XRGB8888, SPA_VIDEO_FORMAT_BGRx}, {0, 0}, }}; struct dbus_response_t { GMainLoop *loop; GVariant *response; guint subscription_id; }; struct stream_data_t { struct pw_stream *stream; struct spa_hook stream_listener; struct spa_video_info format; struct pw_buffer *current_buffer; uint64_t drm_format; }; struct dmabuf_format_info_t { int32_t format; uint64_t *modifiers; int n_modifiers; }; class dbus_t { public: ~dbus_t() { if (screencast_proxy) { g_object_unref(screencast_proxy); } if (remote_desktop_proxy) { g_object_unref(remote_desktop_proxy); } if (conn) { g_object_unref(conn); } } int init() { restore_token_t::load(); conn = g_bus_get_sync(G_BUS_TYPE_SESSION, nullptr, nullptr); if (!conn) { return -1; } remote_desktop_proxy = g_dbus_proxy_new_sync(conn, G_DBUS_PROXY_FLAGS_NONE, nullptr, PORTAL_NAME, PORTAL_PATH, REMOTE_DESKTOP_IFACE, nullptr, nullptr); if (!remote_desktop_proxy) { return -1; } screencast_proxy = g_dbus_proxy_new_sync(conn, G_DBUS_PROXY_FLAGS_NONE, nullptr, PORTAL_NAME, PORTAL_PATH, SCREENCAST_IFACE, nullptr, nullptr); if (!screencast_proxy) { return -1; } return 0; } int connect_to_portal() { g_autoptr(GMainLoop) loop = g_main_loop_new(nullptr, FALSE); g_autofree gchar *session_path = nullptr; g_autofree gchar *session_token = nullptr; create_session_path(conn, nullptr, &session_token); // Try combined RemoteDesktop + ScreenCast session first bool use_screencast_only = !try_remote_desktop_session(loop, &session_path, session_token); // Fall back to ScreenCast-only if RemoteDesktop failed if (use_screencast_only && try_screencast_only_session(loop, &session_path) < 0) { return -1; } if (start_portal_session(loop, session_path, pipewire_node, width, height, use_screencast_only) < 0) { return -1; } if (open_pipewire_remote(session_path, pipewire_fd) < 0) { return -1; } return 0; } // Try to create a combined RemoteDesktop + ScreenCast session // Returns true on success, false if should fall back to ScreenCast-only bool try_remote_desktop_session(GMainLoop *loop, gchar **session_path, const gchar *session_token) { if (create_portal_session(loop, session_path, session_token, false) < 0) { return false; } if (select_remote_desktop_devices(loop, *session_path) < 0) { BOOST_LOG(warning) << "RemoteDesktop.SelectDevices failed, falling back to ScreenCast-only mode"sv; g_free(*session_path); *session_path = nullptr; return false; } if (select_screencast_sources(loop, *session_path) < 0) { BOOST_LOG(warning) << "ScreenCast.SelectSources failed with RemoteDesktop session, trying ScreenCast-only mode"sv; g_free(*session_path); *session_path = nullptr; return false; } return true; } // Create a ScreenCast-only session int try_screencast_only_session(GMainLoop *loop, gchar **session_path) { g_autofree gchar *new_session_token = nullptr; create_session_path(conn, nullptr, &new_session_token); if (create_portal_session(loop, session_path, new_session_token, true) < 0) { return -1; } if (select_screencast_sources(loop, *session_path) < 0) { return -1; } return 0; } int pipewire_fd; int pipewire_node; int width; int height; private: GDBusConnection *conn; GDBusProxy *screencast_proxy; GDBusProxy *remote_desktop_proxy; int create_portal_session(GMainLoop *loop, gchar **session_path_out, const gchar *session_token, bool use_screencast) { GDBusProxy *proxy = use_screencast ? screencast_proxy : remote_desktop_proxy; const char *session_type = use_screencast ? "ScreenCast" : "RemoteDesktop"; dbus_response_t response = { nullptr, }; g_autofree gchar *request_token = nullptr; create_request_path(conn, nullptr, &request_token); GVariantBuilder builder; g_variant_builder_init(&builder, G_VARIANT_TYPE("(a{sv})")); g_variant_builder_open(&builder, G_VARIANT_TYPE("a{sv}")); g_variant_builder_add(&builder, "{sv}", "handle_token", g_variant_new_string(request_token)); g_variant_builder_add(&builder, "{sv}", "session_handle_token", g_variant_new_string(session_token)); g_variant_builder_close(&builder); g_autoptr(GError) err = nullptr; g_autoptr(GVariant) reply = g_dbus_proxy_call_sync(proxy, "CreateSession", g_variant_builder_end(&builder), G_DBUS_CALL_FLAGS_NONE, -1, nullptr, &err); if (err) { BOOST_LOG(error) << "Could not create "sv << session_type << " session: "sv << err->message; return -1; } const gchar *request_path = nullptr; g_variant_get(reply, "(o)", &request_path); dbus_response_init(&response, loop, conn, request_path); g_autoptr(GVariant) create_response = dbus_response_wait(&response); if (!create_response) { BOOST_LOG(error) << session_type << " CreateSession: no response received"sv; return -1; } guint32 response_code; g_autoptr(GVariant) results = nullptr; g_variant_get(create_response, "(u@a{sv})", &response_code, &results); BOOST_LOG(debug) << session_type << " CreateSession response_code: "sv << response_code; if (response_code != 0) { BOOST_LOG(error) << session_type << " CreateSession failed with response code: "sv << response_code; return -1; } g_autoptr(GVariant) session_handle_v = g_variant_lookup_value(results, "session_handle", nullptr); if (!session_handle_v) { BOOST_LOG(error) << session_type << " CreateSession: session_handle not found in response"sv; return -1; } if (g_variant_is_of_type(session_handle_v, G_VARIANT_TYPE_VARIANT)) { g_autoptr(GVariant) inner = g_variant_get_variant(session_handle_v); *session_path_out = g_strdup(g_variant_get_string(inner, nullptr)); } else { *session_path_out = g_strdup(g_variant_get_string(session_handle_v, nullptr)); } BOOST_LOG(debug) << session_type << " CreateSession: got session handle: "sv << *session_path_out; return 0; } int select_remote_desktop_devices(GMainLoop *loop, const gchar *session_path) { dbus_response_t response = { nullptr, }; g_autofree gchar *request_token = nullptr; create_request_path(conn, nullptr, &request_token); GVariantBuilder builder; g_variant_builder_init(&builder, G_VARIANT_TYPE("(oa{sv})")); g_variant_builder_add(&builder, "o", session_path); g_variant_builder_open(&builder, G_VARIANT_TYPE("a{sv}")); g_variant_builder_add(&builder, "{sv}", "handle_token", g_variant_new_string(request_token)); g_variant_builder_add(&builder, "{sv}", "persist_mode", g_variant_new_uint32(PERSIST_WHILE_RUNNING)); if (!restore_token_t::empty()) { g_variant_builder_add(&builder, "{sv}", "restore_token", g_variant_new_string(restore_token_t::get().c_str())); } g_variant_builder_close(&builder); g_autoptr(GError) err = nullptr; g_autoptr(GVariant) reply = g_dbus_proxy_call_sync(remote_desktop_proxy, "SelectDevices", g_variant_builder_end(&builder), G_DBUS_CALL_FLAGS_NONE, -1, nullptr, &err); if (err) { BOOST_LOG(error) << "Could not select devices: "sv << err->message; return -1; } const gchar *request_path = nullptr; g_variant_get(reply, "(o)", &request_path); dbus_response_init(&response, loop, conn, request_path); g_autoptr(GVariant) devices_response = dbus_response_wait(&response); if (!devices_response) { BOOST_LOG(error) << "SelectDevices: no response received"sv; return -1; } guint32 response_code; g_variant_get(devices_response, "(u@a{sv})", &response_code, nullptr); BOOST_LOG(debug) << "SelectDevices response_code: "sv << response_code; if (response_code != 0) { BOOST_LOG(error) << "SelectDevices failed with response code: "sv << response_code; return -1; } return 0; } int select_screencast_sources(GMainLoop *loop, const gchar *session_path) { dbus_response_t response = { nullptr, }; g_autofree gchar *request_token = nullptr; create_request_path(conn, nullptr, &request_token); GVariantBuilder builder; g_variant_builder_init(&builder, G_VARIANT_TYPE("(oa{sv})")); g_variant_builder_add(&builder, "o", session_path); g_variant_builder_open(&builder, G_VARIANT_TYPE("a{sv}")); g_variant_builder_add(&builder, "{sv}", "handle_token", g_variant_new_string(request_token)); g_variant_builder_add(&builder, "{sv}", "types", g_variant_new_uint32(SOURCE_TYPE_MONITOR)); g_variant_builder_add(&builder, "{sv}", "cursor_mode", g_variant_new_uint32(CURSOR_MODE_EMBEDDED)); g_variant_builder_add(&builder, "{sv}", "persist_mode", g_variant_new_uint32(PERSIST_WHILE_RUNNING)); if (!restore_token_t::empty()) { g_variant_builder_add(&builder, "{sv}", "restore_token", g_variant_new_string(restore_token_t::get().c_str())); } g_variant_builder_close(&builder); g_autoptr(GError) err = nullptr; g_autoptr(GVariant) reply = g_dbus_proxy_call_sync(screencast_proxy, "SelectSources", g_variant_builder_end(&builder), G_DBUS_CALL_FLAGS_NONE, -1, nullptr, &err); if (err) { BOOST_LOG(error) << "Could not select sources: "sv << err->message; return -1; } const gchar *request_path = nullptr; g_variant_get(reply, "(o)", &request_path); dbus_response_init(&response, loop, conn, request_path); g_autoptr(GVariant) sources_response = dbus_response_wait(&response); if (!sources_response) { BOOST_LOG(error) << "SelectSources: no response received"sv; return -1; } guint32 response_code; g_variant_get(sources_response, "(u@a{sv})", &response_code, nullptr); BOOST_LOG(debug) << "SelectSources response_code: "sv << response_code; if (response_code != 0) { BOOST_LOG(error) << "SelectSources failed with response code: "sv << response_code; return -1; } return 0; } int start_portal_session(GMainLoop *loop, const gchar *session_path, int &out_pipewire_node, int &out_width, int &out_height, bool use_screencast) { GDBusProxy *proxy = use_screencast ? screencast_proxy : remote_desktop_proxy; const char *session_type = use_screencast ? "ScreenCast" : "RemoteDesktop"; dbus_response_t response = { nullptr, }; g_autofree gchar *request_token = nullptr; create_request_path(conn, nullptr, &request_token); GVariantBuilder builder; g_variant_builder_init(&builder, G_VARIANT_TYPE("(osa{sv})")); g_variant_builder_add(&builder, "o", session_path); g_variant_builder_add(&builder, "s", ""); // parent_window g_variant_builder_open(&builder, G_VARIANT_TYPE("a{sv}")); g_variant_builder_add(&builder, "{sv}", "handle_token", g_variant_new_string(request_token)); g_variant_builder_close(&builder); g_autoptr(GError) err = nullptr; g_autoptr(GVariant) reply = g_dbus_proxy_call_sync(proxy, "Start", g_variant_builder_end(&builder), G_DBUS_CALL_FLAGS_NONE, -1, nullptr, &err); if (err) { BOOST_LOG(error) << "Could not start "sv << session_type << " session: "sv << err->message; return -1; } const gchar *request_path = nullptr; g_variant_get(reply, "(o)", &request_path); dbus_response_init(&response, loop, conn, request_path); g_autoptr(GVariant) start_response = dbus_response_wait(&response); if (!start_response) { BOOST_LOG(error) << session_type << " Start: no response received"sv; return -1; } guint32 response_code; g_autoptr(GVariant) dict = nullptr; g_autoptr(GVariant) streams = nullptr; g_variant_get(start_response, "(u@a{sv})", &response_code, &dict); BOOST_LOG(debug) << session_type << " Start response_code: "sv << response_code; if (response_code != 0) { BOOST_LOG(error) << session_type << " Start failed with response code: "sv << response_code; return -1; } streams = g_variant_lookup_value(dict, "streams", G_VARIANT_TYPE("a(ua{sv})")); if (!streams) { BOOST_LOG(error) << session_type << " Start: no streams in response"sv; return -1; } if (const gchar *new_token = nullptr; g_variant_lookup(dict, "restore_token", "s", &new_token) && new_token && new_token[0] != '\0' && restore_token_t::get() != new_token) { restore_token_t::set(new_token); restore_token_t::save(); } GVariantIter iter; g_autoptr(GVariant) value = nullptr; g_variant_iter_init(&iter, streams); while (g_variant_iter_next(&iter, "(u@a{sv})", &out_pipewire_node, &value)) { g_variant_lookup(value, "size", "(ii)", &out_width, &out_height, nullptr); } return 0; } int open_pipewire_remote(const gchar *session_path, int &fd) { GUnixFDList *fd_list; GVariant *msg = g_variant_new("(oa{sv})", session_path, nullptr); g_autoptr(GError) err = nullptr; g_autoptr(GVariant) reply = g_dbus_proxy_call_with_unix_fd_list_sync(screencast_proxy, "OpenPipeWireRemote", msg, G_DBUS_CALL_FLAGS_NONE, -1, nullptr, &fd_list, nullptr, &err); if (err) { BOOST_LOG(error) << "Could not open pipewire remote: "sv << err->message; return -1; } int fd_handle; g_variant_get(reply, "(h)", &fd_handle); fd = g_unix_fd_list_get(fd_list, fd_handle, nullptr); return 0; } static void on_response_received_cb([[maybe_unused]] GDBusConnection *connection, [[maybe_unused]] const gchar *sender_name, [[maybe_unused]] const gchar *object_path, [[maybe_unused]] const gchar *interface_name, [[maybe_unused]] const gchar *signal_name, GVariant *parameters, gpointer user_data) { auto *response = static_cast(user_data); response->response = g_variant_ref_sink(parameters); g_main_loop_quit(response->loop); } static gchar *get_sender_string(GDBusConnection *conn) { gchar *sender = g_strdup(g_dbus_connection_get_unique_name(conn) + 1); gchar *dot; while ((dot = strstr(sender, ".")) != nullptr) { *dot = '_'; } return sender; } static void create_request_path(GDBusConnection *conn, gchar **out_path, gchar **out_token) { static uint32_t request_count = 0; request_count++; if (out_token) { *out_token = g_strdup_printf("Sunshine%u", request_count); } if (out_path) { g_autofree gchar *sender = get_sender_string(conn); *out_path = g_strdup(std::format("{}{}{}{}", REQUEST_PREFIX, sender, "/Sunshine", request_count).c_str()); } } static void create_session_path(GDBusConnection *conn, gchar **out_path, gchar **out_token) { static uint32_t session_count = 0; session_count++; if (out_token) { *out_token = g_strdup_printf("Sunshine%u", session_count); } if (out_path) { g_autofree gchar *sender = get_sender_string(conn); *out_path = g_strdup(std::format("{}{}{}{}", SESSION_PREFIX, sender, "/Sunshine", session_count).c_str()); } } static void dbus_response_init(struct dbus_response_t *response, GMainLoop *loop, GDBusConnection *conn, const char *request_path) { response->loop = loop; response->subscription_id = g_dbus_connection_signal_subscribe(conn, PORTAL_NAME, REQUEST_IFACE, "Response", request_path, nullptr, G_DBUS_SIGNAL_FLAGS_NONE, on_response_received_cb, response, nullptr); } static GVariant *dbus_response_wait(struct dbus_response_t *response) { g_main_loop_run(response->loop); return response->response; } }; /** * @brief Singleton cache for portal session data. * * This prevents creating multiple portal sessions during encoder probing, * which would show multiple screen recording indicators in the system tray. */ class session_cache_t { public: static session_cache_t &instance(); /** * @brief Get or create a portal session. * * If a cached session exists and is valid, returns the cached data. * Otherwise, creates a new session and caches it. * * @return 0 on success, -1 on failure */ int get_or_create_session(int &pipewire_fd, int &pipewire_node, int &width, int &height) { std::scoped_lock lock(mutex_); if (valid_) { // Return cached session data pipewire_fd = dup(pipewire_fd_); // Duplicate FD for each caller pipewire_node = pipewire_node_; width = width_; height = height_; BOOST_LOG(debug) << "Reusing cached portal session"sv; return 0; } // Create new session dbus_ = std::make_unique(); if (dbus_->init() < 0) { return -1; } if (dbus_->connect_to_portal() < 0) { dbus_.reset(); return -1; } // Cache the session data pipewire_fd_ = dbus_->pipewire_fd; pipewire_node_ = dbus_->pipewire_node; width_ = dbus_->width; height_ = dbus_->height; valid_ = true; // Return to caller (duplicate FD so each caller has their own) pipewire_fd = dup(pipewire_fd_); pipewire_node = pipewire_node_; width = width_; height = height_; BOOST_LOG(debug) << "Created new portal session (cached)"sv; return 0; } /** * @brief Invalidate the cached session. * * Call this when the session becomes invalid (e.g., on error). */ void invalidate() { std::scoped_lock lock(mutex_); if (valid_) { BOOST_LOG(debug) << "Invalidating cached portal session"sv; if (pipewire_fd_ >= 0) { close(pipewire_fd_); pipewire_fd_ = -1; } dbus_.reset(); valid_ = false; } } private: session_cache_t() = default; ~session_cache_t() { if (pipewire_fd_ >= 0) { close(pipewire_fd_); } } // Prevent copying session_cache_t(const session_cache_t &) = delete; session_cache_t &operator=(const session_cache_t &) = delete; std::mutex mutex_; std::unique_ptr dbus_; int pipewire_fd_ = -1; int pipewire_node_ = 0; int width_ = 0; int height_ = 0; bool valid_ = false; }; session_cache_t &session_cache_t::instance() { alignas(session_cache_t) static std::array storage; static auto instance_ = new (storage.data()) session_cache_t(); return *instance_; } class pipewire_t { public: pipewire_t(): loop(pw_thread_loop_new("Pipewire thread", nullptr)) { pw_thread_loop_start(loop); } ~pipewire_t() { pw_thread_loop_stop(loop); if (stream_data.stream) { pw_stream_set_active(stream_data.stream, false); pw_stream_disconnect(stream_data.stream); pw_stream_destroy(stream_data.stream); } if (core) { pw_core_disconnect(core); } if (context) { pw_context_destroy(context); } if (fd >= 0) { close(fd); } pw_thread_loop_destroy(loop); } void init(int stream_fd, int stream_node) { fd = stream_fd; node = stream_node; context = pw_context_new(pw_thread_loop_get_loop(loop), nullptr, 0); core = pw_context_connect_fd(context, dup(fd), nullptr, 0); pw_core_add_listener(core, &core_listener, &core_events, nullptr); } void ensure_stream(const platf::mem_type_e mem_type, const uint32_t width, const uint32_t height, const uint32_t refresh_rate, const struct dmabuf_format_info_t *dmabuf_infos, const int n_dmabuf_infos, const bool display_is_nvidia) { pw_thread_loop_lock(loop); if (!stream_data.stream) { struct pw_properties *props = pw_properties_new(PW_KEY_MEDIA_TYPE, "Video", PW_KEY_MEDIA_CATEGORY, "Capture", PW_KEY_MEDIA_ROLE, "Screen", nullptr); stream_data.stream = pw_stream_new(core, "Sunshine Video Capture", props); pw_stream_add_listener(stream_data.stream, &stream_data.stream_listener, &stream_events, &stream_data); std::array buffer; struct spa_pod_builder pod_builder = SPA_POD_BUILDER_INIT(buffer.data(), buffer.size()); int n_params = 0; std::array params; // Add preferred parameters for DMA-BUF with modifiers // Use DMA-BUF for VAAPI, or for CUDA when the display GPU is NVIDIA (pure NVIDIA system). // On hybrid GPU systems (Intel+NVIDIA), DMA-BUFs come from the Intel GPU and cannot // be imported into CUDA, so we fall back to memory buffers in that case. bool use_dmabuf = n_dmabuf_infos > 0 && (mem_type == platf::mem_type_e::vaapi || (mem_type == platf::mem_type_e::cuda && display_is_nvidia)); if (use_dmabuf) { for (int i = 0; i < n_dmabuf_infos; i++) { auto format_param = build_format_parameter(&pod_builder, width, height, refresh_rate, dmabuf_infos[i].format, dmabuf_infos[i].modifiers, dmabuf_infos[i].n_modifiers); params[n_params] = format_param; n_params++; } } // Add fallback for memptr for (const auto &fmt : format_map) { if (fmt.fourcc == 0) { break; } auto format_param = build_format_parameter(&pod_builder, width, height, refresh_rate, fmt.pw_format, nullptr, 0); params[n_params] = format_param; n_params++; } pw_stream_connect(stream_data.stream, PW_DIRECTION_INPUT, node, (enum pw_stream_flags)(PW_STREAM_FLAG_AUTOCONNECT | PW_STREAM_FLAG_MAP_BUFFERS), params.data(), n_params); } pw_thread_loop_unlock(loop); } void fill_img(platf::img_t *img) { pw_thread_loop_lock(loop); if (stream_data.current_buffer) { struct spa_buffer *buf; buf = stream_data.current_buffer->buffer; if (buf->datas[0].chunk->size != 0) { if (buf->datas[0].type == SPA_DATA_DmaBuf) { const auto img_descriptor = static_cast(img); img_descriptor->sd.width = stream_data.format.info.raw.size.width; img_descriptor->sd.height = stream_data.format.info.raw.size.height; img_descriptor->sd.modifier = stream_data.format.info.raw.modifier; img_descriptor->sd.fourcc = stream_data.drm_format; for (int i = 0; i < MIN(buf->n_datas, 4); i++) { img_descriptor->sd.fds[i] = dup(buf->datas[i].fd); img_descriptor->sd.pitches[i] = buf->datas[i].chunk->stride; img_descriptor->sd.offsets[i] = buf->datas[i].chunk->offset; } } else { img->data = static_cast(buf->datas[0].data); img->row_pitch = buf->datas[0].chunk->stride; } } } pw_thread_loop_unlock(loop); } private: struct pw_thread_loop *loop; struct pw_context *context; struct pw_core *core; struct spa_hook core_listener; struct stream_data_t stream_data; int fd; int node; static struct spa_pod *build_format_parameter(struct spa_pod_builder *b, uint32_t width, uint32_t height, uint32_t refresh_rate, int32_t format, uint64_t *modifiers, int n_modifiers) { struct spa_pod_frame object_frame; struct spa_pod_frame modifier_frame; std::array sizes; std::array framerates; sizes[0] = SPA_RECTANGLE(width, height); // Preferred sizes[1] = SPA_RECTANGLE(1, 1); sizes[2] = SPA_RECTANGLE(8192, 4096); framerates[0] = SPA_FRACTION(0, 1); // we only want variable rate, thus bypassing compositor pacing framerates[1] = SPA_FRACTION(0, 1); framerates[2] = SPA_FRACTION(0, 1); spa_pod_builder_push_object(b, &object_frame, SPA_TYPE_OBJECT_Format, SPA_PARAM_EnumFormat); spa_pod_builder_add(b, SPA_FORMAT_mediaType, SPA_POD_Id(SPA_MEDIA_TYPE_video), 0); spa_pod_builder_add(b, SPA_FORMAT_mediaSubtype, SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw), 0); spa_pod_builder_add(b, SPA_FORMAT_VIDEO_format, SPA_POD_Id(format), 0); spa_pod_builder_add(b, SPA_FORMAT_VIDEO_size, SPA_POD_CHOICE_RANGE_Rectangle(&sizes[0], &sizes[1], &sizes[2]), 0); spa_pod_builder_add(b, SPA_FORMAT_VIDEO_framerate, SPA_POD_CHOICE_RANGE_Fraction(&framerates[0], &framerates[1], &framerates[2]), 0); spa_pod_builder_add(b, SPA_FORMAT_VIDEO_maxFramerate, SPA_POD_CHOICE_RANGE_Fraction(&framerates[0], &framerates[1], &framerates[2]), 0); if (n_modifiers) { spa_pod_builder_prop(b, SPA_FORMAT_VIDEO_modifier, SPA_POD_PROP_FLAG_MANDATORY | SPA_POD_PROP_FLAG_DONT_FIXATE); spa_pod_builder_push_choice(b, &modifier_frame, SPA_CHOICE_Enum, 0); // Preferred value, we pick the first modifier be the preferred one spa_pod_builder_long(b, modifiers[0]); for (uint32_t i = 0; i < n_modifiers; i++) { spa_pod_builder_long(b, modifiers[i]); } spa_pod_builder_pop(b, &modifier_frame); } return static_cast(spa_pod_builder_pop(b, &object_frame)); } static void on_core_info_cb([[maybe_unused]] void *user_data, const struct pw_core_info *pw_info) { BOOST_LOG(info) << "Connected to pipewire version "sv << pw_info->version; } static void on_core_error_cb([[maybe_unused]] void *user_data, const uint32_t id, const int seq, [[maybe_unused]] int res, const char *message) { BOOST_LOG(info) << "Pipewire Error, id:"sv << id << " seq:"sv << seq << " message: "sv << message; } constexpr static const struct pw_core_events core_events = { .version = PW_VERSION_CORE_EVENTS, .info = on_core_info_cb, .error = on_core_error_cb, }; static void on_process(void *user_data) { const auto d = static_cast(user_data); struct pw_buffer *b = nullptr; while (true) { struct pw_buffer *aux = pw_stream_dequeue_buffer(d->stream); if (!aux) { break; } if (b) { pw_stream_queue_buffer(d->stream, b); } b = aux; } if (b == nullptr) { BOOST_LOG(warning) << "out of pipewire buffers"sv; return; } if (d->current_buffer) { pw_stream_queue_buffer(d->stream, d->current_buffer); } d->current_buffer = b; } static void on_param_changed(void *user_data, uint32_t id, const struct spa_pod *param) { const auto d = static_cast(user_data); d->current_buffer = nullptr; if (param == nullptr || id != SPA_PARAM_Format) { return; } if (spa_format_parse(param, &d->format.media_type, &d->format.media_subtype) < 0) { return; } if (d->format.media_type != SPA_MEDIA_TYPE_video || d->format.media_subtype != SPA_MEDIA_SUBTYPE_raw) { return; } if (spa_format_video_raw_parse(param, &d->format.info.raw) < 0) { return; } BOOST_LOG(info) << "Video format: "sv << d->format.info.raw.format; BOOST_LOG(info) << "Size: "sv << d->format.info.raw.size.width << "x"sv << d->format.info.raw.size.height; if (d->format.info.raw.max_framerate.num == 0 && d->format.info.raw.max_framerate.denom == 1) { BOOST_LOG(info) << "Framerate (from compositor): 0/1 (variable rate capture)"; } else { BOOST_LOG(info) << "Framerate (from compositor): "sv << d->format.info.raw.framerate.num << "/"sv << d->format.info.raw.framerate.denom; BOOST_LOG(info) << "Framerate (from compositor, max): "sv << d->format.info.raw.max_framerate.num << "/"sv << d->format.info.raw.max_framerate.denom; } uint64_t drm_format = 0; for (const auto &fmt : format_map) { if (fmt.fourcc == 0) { break; } if (fmt.pw_format == d->format.info.raw.format) { drm_format = fmt.fourcc; } } d->drm_format = drm_format; uint32_t buffer_types = 0; if (spa_pod_find_prop(param, nullptr, SPA_FORMAT_VIDEO_modifier) != nullptr && d->drm_format) { BOOST_LOG(info) << "using DMA-BUF buffers"sv; buffer_types |= 1 << SPA_DATA_DmaBuf; } else { BOOST_LOG(info) << "using memory buffers"sv; buffer_types |= 1 << SPA_DATA_MemPtr; } // Ack the buffer type std::array buffer; std::array params; int n_params = 0; struct spa_pod_builder pod_builder = SPA_POD_BUILDER_INIT(buffer.data(), buffer.size()); auto buffer_param = static_cast(spa_pod_builder_add_object(&pod_builder, SPA_TYPE_OBJECT_ParamBuffers, SPA_PARAM_Buffers, SPA_PARAM_BUFFERS_dataType, SPA_POD_Int(buffer_types))); params[n_params] = buffer_param; n_params++; pw_stream_update_params(d->stream, params.data(), n_params); } constexpr static const struct pw_stream_events stream_events = { .version = PW_VERSION_STREAM_EVENTS, .param_changed = on_param_changed, .process = on_process, }; }; class portal_t: public platf::display_t { public: int init(platf::mem_type_e hwdevice_type, const std::string &display_name, const ::video::config_t &config) { framerate = config.framerate; delay = std::chrono::nanoseconds {1s} / framerate; mem_type = hwdevice_type; if (get_dmabuf_modifiers() < 0) { return -1; } // Use cached portal session to avoid creating multiple screen recordings int pipewire_fd = -1; int pipewire_node = 0; if (session_cache_t::instance().get_or_create_session(pipewire_fd, pipewire_node, width, height) < 0) { return -1; } framerate = config.framerate; pipewire.init(pipewire_fd, pipewire_node); return 0; } platf::capture_e snapshot(const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr &img_out, std::chrono::milliseconds timeout, bool show_cursor) { // FIXME: show_cursor is ignored if (!pull_free_image_cb(img_out)) { return platf::capture_e::interrupted; } const auto img_egl = static_cast(img_out.get()); img_egl->reset(); pipewire.fill_img(img_egl); // Check if we got valid data (either DMA-BUF fd or memory pointer) if (img_egl->sd.fds[0] < 0 && img_egl->data == nullptr) { // No buffer available yet from pipewire return platf::capture_e::timeout; } img_egl->sequence = ++sequence; return platf::capture_e::ok; } std::shared_ptr alloc_img() override { // Note: this img_t type is also used for memory buffers auto img = std::make_shared(); img->width = width; img->height = height; img->pixel_pitch = 4; img->row_pitch = img->pixel_pitch * width; img->sequence = 0; img->serial = std::numeric_limitsserial)>::max(); img->data = nullptr; std::fill_n(img->sd.fds, 4, -1); return img; } platf::capture_e capture(const push_captured_image_cb_t &push_captured_image_cb, const pull_free_image_cb_t &pull_free_image_cb, bool *cursor) override { auto next_frame = std::chrono::steady_clock::now(); pipewire.ensure_stream(mem_type, width, height, framerate, dmabuf_infos.data(), n_dmabuf_infos, display_is_nvidia); sleep_overshoot_logger.reset(); while (true) { auto now = std::chrono::steady_clock::now(); if (next_frame > now) { std::this_thread::sleep_for(next_frame - now); sleep_overshoot_logger.first_point(next_frame); sleep_overshoot_logger.second_point_now_and_log(); } next_frame += delay; if (next_frame < now) { // some major slowdown happened; we couldn't keep up next_frame = now + delay; } std::shared_ptr img_out; switch (const auto status = snapshot(pull_free_image_cb, img_out, 1000ms, *cursor)) { case platf::capture_e::reinit: case platf::capture_e::error: case platf::capture_e::interrupted: return status; case platf::capture_e::timeout: push_captured_image_cb(std::move(img_out), false); break; case platf::capture_e::ok: push_captured_image_cb(std::move(img_out), true); break; default: BOOST_LOG(error) << "Unrecognized capture status ["sv << std::to_underlying(status) << ']'; return status; } } return platf::capture_e::ok; } 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, n_dmabuf_infos > 0); } #endif #ifdef SUNSHINE_BUILD_CUDA if (mem_type == platf::mem_type_e::cuda) { if (display_is_nvidia && n_dmabuf_infos > 0) { // Display GPU is NVIDIA - can use DMA-BUF directly return cuda::make_avcodec_gl_encode_device(width, height, 0, 0); } else { // Hybrid system (Intel display + NVIDIA encode) - use memory buffer path // DMA-BUFs from Intel GPU cannot be imported into CUDA return cuda::make_avcodec_encode_device(width, height, false); } } #endif return std::make_unique(); } int dummy_img(platf::img_t *img) override { if (!img) { return -1; } img->data = new std::uint8_t[img->height * img->row_pitch]; std::fill_n(img->data, img->height * img->row_pitch, 0); return 0; } private: static uint32_t lookup_pw_format(uint64_t fourcc) { for (const auto &fmt : format_map) { if (fmt.fourcc == 0) { break; } if (fmt.fourcc == fourcc) { return fmt.pw_format; } } return 0; } void query_dmabuf_formats(EGLDisplay egl_display) { EGLint num_dmabuf_formats = 0; std::array dmabuf_formats = {0}; eglQueryDmaBufFormatsEXT(egl_display, MAX_DMABUF_FORMATS, dmabuf_formats.data(), &num_dmabuf_formats); if (num_dmabuf_formats > MAX_DMABUF_FORMATS) { BOOST_LOG(warning) << "Some DMA-BUF formats are being ignored"sv; } for (EGLint i = 0; i < MIN(num_dmabuf_formats, MAX_DMABUF_FORMATS); i++) { uint32_t pw_format = lookup_pw_format(dmabuf_formats[i]); if (pw_format == 0) { continue; } EGLint num_modifiers = 0; std::array mods = {0}; EGLBoolean external_only; eglQueryDmaBufModifiersEXT(egl_display, dmabuf_formats[i], MAX_DMABUF_MODIFIERS, mods.data(), &external_only, &num_modifiers); if (num_modifiers > MAX_DMABUF_MODIFIERS) { BOOST_LOG(warning) << "Some DMA-BUF modifiers are being ignored"sv; } dmabuf_infos[n_dmabuf_infos].format = pw_format; dmabuf_infos[n_dmabuf_infos].n_modifiers = MIN(num_modifiers, MAX_DMABUF_MODIFIERS); dmabuf_infos[n_dmabuf_infos].modifiers = static_cast(g_memdup2(mods.data(), sizeof(uint64_t) * dmabuf_infos[n_dmabuf_infos].n_modifiers)); ++n_dmabuf_infos; } } int get_dmabuf_modifiers() { if (wl_display.init() < 0) { return -1; } auto egl_display = egl::make_display(wl_display.get()); if (!egl_display) { return -1; } // Detect if this is a pure NVIDIA system (not hybrid Intel+NVIDIA) // On hybrid systems, the wayland compositor typically runs on Intel, // so DMA-BUFs from portal will come from Intel and cannot be imported into CUDA. // Check if Intel GPU exists - if so, assume hybrid system and disable CUDA DMA-BUF. bool has_intel_gpu = std::ifstream("/sys/class/drm/card0/device/vendor").good() || std::ifstream("/sys/class/drm/card1/device/vendor").good(); if (has_intel_gpu) { // Read vendor IDs to check for Intel (0x8086) auto check_intel = [](const std::string &path) { if (std::ifstream f(path); f.good()) { std::string vendor; f >> vendor; return vendor == "0x8086"; } return false; }; bool intel_present = check_intel("/sys/class/drm/card0/device/vendor") || check_intel("/sys/class/drm/card1/device/vendor"); if (intel_present) { BOOST_LOG(info) << "Hybrid GPU system detected (Intel + discrete) - CUDA will use memory buffers"sv; display_is_nvidia = false; } else { // No Intel GPU found, check if NVIDIA is present const char *vendor = eglQueryString(egl_display.get(), EGL_VENDOR); if (vendor && std::string_view(vendor).contains("NVIDIA")) { BOOST_LOG(info) << "Pure NVIDIA system - DMA-BUF will be enabled for CUDA"sv; display_is_nvidia = true; } } } if (eglQueryDmaBufFormatsEXT && eglQueryDmaBufModifiersEXT) { query_dmabuf_formats(egl_display.get()); } return 0; } platf::mem_type_e mem_type; wl::display_t wl_display; pipewire_t pipewire; std::array dmabuf_infos; int n_dmabuf_infos; bool display_is_nvidia = false; // Track if display GPU is NVIDIA std::chrono::nanoseconds delay; std::uint64_t sequence {}; uint32_t framerate; }; } // namespace portal namespace platf { std::shared_ptr portal_display(mem_type_e hwdevice_type, const std::string &display_name, const video::config_t &config) { using enum platf::mem_type_e; if (hwdevice_type != system && hwdevice_type != vaapi && hwdevice_type != cuda) { BOOST_LOG(error) << "Could not initialize display with the given hw device type."sv; return nullptr; } auto portal = std::make_shared(); if (portal->init(hwdevice_type, display_name, config)) { return nullptr; } return portal; } std::vector portal_display_names() { std::vector display_names; auto dbus = std::make_shared(); if (dbus->init() < 0) { return {}; } pw_init(nullptr, nullptr); display_names.emplace_back("org.freedesktop.portal.Desktop"); return display_names; } } // namespace platf