ScreenCastPortal_impl Class Reference

Collaboration diagram for ScreenCastPortal_impl:

Public Member Functions
	ScreenCastPortal_impl ()
	~ScreenCastPortal_impl ()
GDBusConnection *	dbus_connection () const
std::future< std::string >	get_future ()
int	get_pw_fd ()
uint32_t	get_pw_node ()
GDBusProxy *	proxy ()
void	quit_loop ()
void	run (std::string restore_file, bool show_cursor)
void	run_loop ()
const std::string &	sender_name () const
const std::string &	session_path () const
const std::string &	session_token () const

Static Public Attributes
static constexpr uint32_t	REQUEST_RESPONSE_CANCELLED_BY_USER = 1
static constexpr uint32_t	REQUEST_RESPONSE_OK = 0
static constexpr uint32_t	REQUEST_RESPONSE_OTHER_ERROR = 2

Private Member Functions
template<auto callback>
void	call_with_request (const char *method_name, std::initializer_list< GVariant * > arguments, GVariantBuilder &params_builder)

Static Private Member Functions
static void	pipewire_opened (GObject *source, GAsyncResult *res, void *user_data)
static void	session_created (uint32_t response, GVariant *results, ScreenCastPortal_impl *s)
static void	sources_selected (uint32_t response, GVariant *results, ScreenCastPortal_impl *s)
static void	started (uint32_t response, GVariant *results, void *user_data)

Private Attributes
GDBusConnection *	connection
GMainLoop *	dbus_loop
std::promise< std::string >	promise
int	pw_fd = -1
uint32_t	pw_node = UINT32_MAX
std::string	restore_file
GDBusProxy *	screencast_proxy
session_path_t	session
bool	show_cursor = false
std::string	unique_name

Detailed Description

Definition at line 110 of file dbus_portal.cpp.

Constructor & Destructor Documentation

ScreenCastPortal_impl()

ScreenCastPortal_impl::ScreenCastPortal_impl

(

)

Definition at line 191 of file dbus_portal.cpp.

                                            {
        GError *error = nullptr;
 
        dbus_loop = g_main_loop_new(nullptr, false);
        connection = g_bus_get_sync(G_BUS_TYPE_SESSION, nullptr, &error);
        g_assert_no_error(error);
        assert(connection != nullptr);
 
        unique_name = g_dbus_connection_get_unique_name(connection) + 1;
        std::replace(unique_name.begin(), unique_name.end(), '.', '_');
        screencast_proxy = g_dbus_proxy_new_sync(
                        connection, G_DBUS_PROXY_FLAGS_NONE, nullptr,
                        "org.freedesktop.portal.Desktop",
                        "/org/freedesktop/portal/desktop",
                        "org.freedesktop.portal.ScreenCast", nullptr, &error);
        g_assert_no_error(error); 
        assert(screencast_proxy != nullptr);
 
        session = session_path_t::create(unique_name);
        LOG(LOG_LEVEL_VERBOSE) << MOD_NAME "session path: '" << session.path << "'" << " token: '" << session.token << "'\n";
}

References connection, dbus_loop, LOG, LOG_LEVEL_VERBOSE, MOD_NAME, screencast_proxy, session, and unique_name.

~ScreenCastPortal_impl()

ScreenCastPortal_impl::~ScreenCastPortal_impl

(

)

Definition at line 213 of file dbus_portal.cpp.

                                              {
        g_dbus_connection_call(dbus_connection(),
                        "org.freedesktop.portal.Desktop",
                        session.path.c_str(),
                        "org.freedesktop.portal.Session",
                        "Close", nullptr, nullptr,
                        G_DBUS_CALL_FLAGS_NONE, -1, nullptr, nullptr,
                        nullptr);
        g_main_loop_quit(dbus_loop);
        g_object_unref(screencast_proxy);
        g_object_unref(connection);
        g_main_loop_unref(dbus_loop);
}

References connection, dbus_connection(), dbus_loop, screencast_proxy, and session.

Here is the call graph for this function:

Member Function Documentation

call_with_request()

template<auto callback>

void ScreenCastPortal_impl::call_with_request ( const char * method_name, std::initializer_list< GVariant * > arguments, GVariantBuilder & params_builder )

private

Definition at line 253 of file dbus_portal.cpp.

{
        assert(method_name != nullptr);
        request_path_t request_path = request_path_t::create(sender_name());
        LOG(LOG_LEVEL_VERBOSE) << MOD_NAME "call_with_request: '" << method_name << "' request: '" << request_path.path << "'\n";
 
        g_dbus_connection_signal_subscribe(connection, "org.freedesktop.portal.Desktop",
                        "org.freedesktop.portal.Request",
                        "Response",
                        request_path.path.c_str(),
                        nullptr,
                        G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE,
                        CallbackWrapper<callback>,
                        this,
                        nullptr);
 
        auto call_finished = [](GObject *source_object, GAsyncResult *result, gpointer user_data) {
                auto s = static_cast<ScreenCastPortal_impl *>(user_data);
                GError *error = nullptr;
                GVariant_uniq result_finished(g_dbus_proxy_call_finish(G_DBUS_PROXY(source_object), result, &error));
 
                if(error != nullptr){
                        s->promise.set_value(error->message);
                        return;
                }
 
                const char *path = nullptr;
                g_variant_get(result_finished.get(), "(o)", &path);
                LOG(LOG_LEVEL_VERBOSE) << MOD_NAME "call_with_request finished: '" << path << "'\n";
        };
 
 
        g_variant_builder_add(&params_builder, "{sv}", "handle_token", g_variant_new_string(request_path.token.c_str()));
 
        GVariantBuilder args_builder;
        g_variant_builder_init(&args_builder, G_VARIANT_TYPE_TUPLE);
        for(GVariant* arg : arguments){
                g_variant_builder_add_value(&args_builder, arg);
        }
        g_variant_builder_add_value(&args_builder, g_variant_builder_end(&params_builder));
 
        g_dbus_proxy_call(screencast_proxy, method_name, g_variant_builder_end(&args_builder), G_DBUS_CALL_FLAGS_NONE, -1, nullptr, call_finished, this);     
}

References CallbackWrapper(), connection, LOG, LOG_LEVEL_VERBOSE, MOD_NAME, screencast_proxy, and sender_name().

Referenced by run(), session_created(), and sources_selected().

Here is the call graph for this function:

dbus_connection()

GDBusConnection * ScreenCastPortal_impl::dbus_connection ( ) const

inline

Definition at line 171 of file dbus_portal.cpp.

                                                 {
                return connection;
        }

References connection.

Referenced by ~ScreenCastPortal_impl(), and run().

get_future()

std::future< std::string > ScreenCastPortal_impl::get_future ( )

inline

Definition at line 150 of file dbus_portal.cpp.

                                          {
                return promise.get_future();
        }

References promise.

get_pw_fd()

int ScreenCastPortal_impl::get_pw_fd ( )

inline

Definition at line 154 of file dbus_portal.cpp.

{ return pw_fd; }

References pw_fd.

get_pw_node()

uint32_t ScreenCastPortal_impl::get_pw_node ( )

inline

Definition at line 155 of file dbus_portal.cpp.

{ return pw_node; }

References pw_node.

pipewire_opened()

void ScreenCastPortal_impl::pipewire_opened ( GObject * source, GAsyncResult * res, void * user_data )

staticprivate

Definition at line 311 of file dbus_portal.cpp.

{
        auto s = static_cast<ScreenCastPortal_impl *>(user_data);
        GError *error = nullptr;
        GUnixFDList *fd_list = nullptr;
 
        GVariant_uniq result(g_dbus_proxy_call_with_unix_fd_list_finish(G_DBUS_PROXY(source), &fd_list, res, &error));
        g_assert_no_error(error);
 
        gint32 handle;
        g_variant_get(result.get(), "(h)", &handle);
        assert(handle == 0); //it should always be the first index
 
        s->pw_fd = g_unix_fd_list_get(fd_list, handle, &error);
        g_assert_no_error(error);
 
        s->promise.set_value("");
}

Referenced by started().

proxy()

GDBusProxy * ScreenCastPortal_impl::proxy ( )

inline

Definition at line 167 of file dbus_portal.cpp.

                            {
                return screencast_proxy;
        }

References screencast_proxy.

quit_loop()

void ScreenCastPortal_impl::quit_loop ( )

inline

Definition at line 163 of file dbus_portal.cpp.

                         {
                g_main_loop_quit(dbus_loop);
        }

References dbus_loop.

run()

void ScreenCastPortal_impl::run	(	std::string	restore_file,
		bool	show_cursor )

Definition at line 424 of file dbus_portal.cpp.

                                                                       {
        this->restore_file = restore_file;
        this->show_cursor = show_cursor;
 
        g_dbus_connection_signal_subscribe(dbus_connection(), 
                        nullptr, // sender
                        "org.freedesktop.portal.Session", // interface_name
                        "closed", //signal name
                        session_path().c_str(), // object path
                        nullptr, // arg0
                        G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE,
                        on_portal_session_closed,
                        nullptr,
                        nullptr);
 
        GVariantBuilder params;
        g_variant_builder_init(&params, G_VARIANT_TYPE_VARDICT);
        g_variant_builder_add(&params, "{sv}", "session_handle_token", g_variant_new_string(session_token().c_str()));
 
        call_with_request<session_created>("CreateSession", {}, params);
        
        run_loop();
}

References call_with_request(), dbus_connection(), on_portal_session_closed(), params, restore_file, run_loop(), session_path(), session_token(), and show_cursor.

Here is the call graph for this function:

run_loop()

void ScreenCastPortal_impl::run_loop ( )

inline

Definition at line 158 of file dbus_portal.cpp.

                        {
                g_main_loop_run(dbus_loop);
                LOG(LOG_LEVEL_VERBOSE) << MOD_NAME "finished dbus loop \n";
        }

References dbus_loop, LOG, LOG_LEVEL_VERBOSE, and MOD_NAME.

Referenced by run().

sender_name()

const std::string & ScreenCastPortal_impl::sender_name ( ) const

inline

Definition at line 175 of file dbus_portal.cpp.

        {
                return unique_name;
        }

References unique_name.

Referenced by call_with_request().

session_created()

void ScreenCastPortal_impl::session_created ( uint32_t response, GVariant * results, ScreenCastPortal_impl * s )

staticprivate

Definition at line 384 of file dbus_portal.cpp.

                                                                                                          {
        if(response != ScreenCastPortal_impl::REQUEST_RESPONSE_OK) {
                s->promise.set_value("Failed to create session");
                return;
        }
 
        const char *session_handle = nullptr;
        g_variant_lookup(results, "session_handle", "s", &session_handle);
 
        LOG(LOG_LEVEL_DEBUG) << MOD_NAME "session created with handle: " << session_handle << "\n";
        assert(s->session_path() == session_handle);
 
        {
                GVariantBuilder params;
                g_variant_builder_init(&params, G_VARIANT_TYPE_VARDICT);
                g_variant_builder_add(&params, "{sv}", "types", g_variant_new_uint32(3)); // 1 full screen, 2 - a window, 3 - both
                g_variant_builder_add(&params, "{sv}", "multiple", g_variant_new_boolean(false));
                if(s->show_cursor)
                        g_variant_builder_add(&params, "{sv}", "cursor_mode", g_variant_new_uint32(2));
 
                if(!s->restore_file.empty()){
                        std::string token;
                        std::ifstream file(s->restore_file);
 
                        if(file.is_open()) {
                                std::ostringstream ss;
                                ss << file.rdbuf();
                                token = ss.str();
                        }
 
                        //  0: Do not persist (default), 1: Permissions persist as long as the application is running, 2: Permissions persist until explicitly revoked
                        g_variant_builder_add(&params, "{sv}", "persist_mode", g_variant_new_uint32(2)); 
                        if(!token.empty())
                                g_variant_builder_add(&params, "{sv}", "restore_token", g_variant_new_string(token.c_str())); 
                }
 
                s->call_with_request<sources_selected>("SelectSources", {g_variant_new_object_path(s->session_path().c_str())}, params);
        }
};

References call_with_request(), LOG, LOG_LEVEL_DEBUG, MOD_NAME, params, promise, REQUEST_RESPONSE_OK, restore_file, session_path(), show_cursor, and sources_selected().

Here is the call graph for this function:

session_path()

const std::string & ScreenCastPortal_impl::session_path ( ) const

inline

Definition at line 180 of file dbus_portal.cpp.

        {
                return session.path;
        }

References session.

Referenced by run(), session_created(), and sources_selected().

session_token()

const std::string & ScreenCastPortal_impl::session_token ( ) const

inline

Definition at line 185 of file dbus_portal.cpp.

        {
                return session.token;
        }

References session.

Referenced by run().

sources_selected()

void ScreenCastPortal_impl::sources_selected ( uint32_t response, GVariant * results, ScreenCastPortal_impl * s )

staticprivate

Definition at line 367 of file dbus_portal.cpp.

                                                                                                           {
        gchar *pretty = g_variant_print(results, true);
        LOG(LOG_LEVEL_INFO) << MOD_NAME "selected sources: " << pretty << "\n";
        g_free((gpointer) pretty);
 
        if(response != ScreenCastPortal_impl::REQUEST_RESPONSE_OK) {
                s->promise.set_value("Failed to select sources");
                return;
        }
 
        {
                GVariantBuilder options;
                g_variant_builder_init(&options, G_VARIANT_TYPE_VARDICT);
                s->call_with_request<started>("Start", {g_variant_new_object_path(s->session_path().c_str()),  /*parent window: */ g_variant_new_string("")}, options);
        }
};

References call_with_request(), LOG, LOG_LEVEL_INFO, MOD_NAME, promise, REQUEST_RESPONSE_OK, session_path(), and started().

Referenced by session_created().

Here is the call graph for this function:

started()

void ScreenCastPortal_impl::started ( uint32_t response, GVariant * results, void * user_data )

staticprivate

Definition at line 332 of file dbus_portal.cpp.

                                                                                         {
        auto s = static_cast<ScreenCastPortal_impl *>(user_data);
        LOG(LOG_LEVEL_DEBUG) << MOD_NAME "started: " << g_variant_print(results, true) << "\n";
 
        if(response == ScreenCastPortal_impl::REQUEST_RESPONSE_CANCELLED_BY_USER) {
                s->promise.set_value("failed to start (dialog cancelled by user)");
                return;
        } else if(response != ScreenCastPortal_impl::REQUEST_RESPONSE_OK) {
                s->promise.set_value("failed to start (unknown reason)");
                return;
        }
 
        const char *restore_token = nullptr;
        if (g_variant_lookup(results, "restore_token", "s", &restore_token)){
                std::ofstream file(s->restore_file);
                file<<restore_token;
        }
 
        GVariant *streams = g_variant_lookup_value(results, "streams", G_VARIANT_TYPE_ARRAY);
        GVariant *stream_properties;
        GVariantIter iter;
        g_variant_iter_init(&iter, streams);
        assert(g_variant_iter_n_children(&iter) == 1);
        bool got_item = g_variant_iter_loop(&iter, "(u@a{sv})", &s->pw_node, &stream_properties);
        assert(got_item);
 
        GVariantBuilder builder;
        g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
        g_dbus_proxy_call_with_unix_fd_list(s->proxy(), "OpenPipeWireRemote",
                        g_variant_new("(oa{sv})", s->session_path().c_str(), &builder),
                        G_DBUS_CALL_FLAGS_NONE, -1,
                        nullptr, nullptr, ScreenCastPortal_impl::pipewire_opened, s);
        g_variant_builder_clear(&builder);
}

References LOG, LOG_LEVEL_DEBUG, MOD_NAME, pipewire_opened(), REQUEST_RESPONSE_CANCELLED_BY_USER, and REQUEST_RESPONSE_OK.

Referenced by sources_selected().

Here is the call graph for this function:

Member Data Documentation

connection

GDBusConnection* ScreenCastPortal_impl::connection

private

Definition at line 126 of file dbus_portal.cpp.

Referenced by ScreenCastPortal_impl(), ~ScreenCastPortal_impl(), call_with_request(), and dbus_connection().

dbus_loop

GMainLoop* ScreenCastPortal_impl::dbus_loop

private

Definition at line 125 of file dbus_portal.cpp.

Referenced by ScreenCastPortal_impl(), ~ScreenCastPortal_impl(), quit_loop(), and run_loop().

promise

std::promise<std::string> ScreenCastPortal_impl::promise

private

Definition at line 137 of file dbus_portal.cpp.

Referenced by get_future(), session_created(), and sources_selected().

pw_fd

int ScreenCastPortal_impl::pw_fd = -1

private

Definition at line 134 of file dbus_portal.cpp.

Referenced by get_pw_fd().

pw_node

uint32_t ScreenCastPortal_impl::pw_node = UINT32_MAX

private

Definition at line 135 of file dbus_portal.cpp.

Referenced by get_pw_node().

REQUEST_RESPONSE_CANCELLED_BY_USER

uint32_t ScreenCastPortal_impl::REQUEST_RESPONSE_CANCELLED_BY_USER = 1

staticconstexpr

Definition at line 142 of file dbus_portal.cpp.

Referenced by started().

REQUEST_RESPONSE_OK

uint32_t ScreenCastPortal_impl::REQUEST_RESPONSE_OK = 0

staticconstexpr

Definition at line 141 of file dbus_portal.cpp.

Referenced by session_created(), sources_selected(), and started().

REQUEST_RESPONSE_OTHER_ERROR

uint32_t ScreenCastPortal_impl::REQUEST_RESPONSE_OTHER_ERROR = 2

staticconstexpr

Definition at line 143 of file dbus_portal.cpp.

restore_file

std::string ScreenCastPortal_impl::restore_file

private

Definition at line 131 of file dbus_portal.cpp.

Referenced by run(), and session_created().

screencast_proxy

GDBusProxy* ScreenCastPortal_impl::screencast_proxy

private

Definition at line 127 of file dbus_portal.cpp.

Referenced by ScreenCastPortal_impl(), ~ScreenCastPortal_impl(), call_with_request(), and proxy().

session

session_path_t ScreenCastPortal_impl::session

private

Definition at line 129 of file dbus_portal.cpp.

Referenced by ScreenCastPortal_impl(), ~ScreenCastPortal_impl(), session_path(), and session_token().

show_cursor

bool ScreenCastPortal_impl::show_cursor = false

private

Definition at line 132 of file dbus_portal.cpp.

Referenced by run(), and session_created().

unique_name

std::string ScreenCastPortal_impl::unique_name

private

Definition at line 128 of file dbus_portal.cpp.

Referenced by ScreenCastPortal_impl(), and sender_name().

---

The documentation for this class was generated from the following file:

• src/utils/dbus_portal.cpp