screencast-portal.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895
  1. /* screencast-portal.c
  2. *
  3. * Copyright 2022 Georges Basile Stavracas Neto <[email protected]>
  4. *
  5. * This program is free software: you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation, either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17. *
  18. * SPDX-License-Identifier: GPL-2.0-or-later
  19. */
  20. #include "pipewire.h"
  21. #include "portal.h"
  22. #include <gio/gunixfdlist.h>
  23. enum portal_capture_type {
  24. PORTAL_CAPTURE_TYPE_MONITOR = 1 << 0,
  25. PORTAL_CAPTURE_TYPE_WINDOW = 1 << 1,
  26. PORTAL_CAPTURE_TYPE_VIRTUAL = 1 << 2,
  27. };
  28. enum portal_cursor_mode {
  29. PORTAL_CURSOR_MODE_HIDDEN = 1 << 0,
  30. PORTAL_CURSOR_MODE_EMBEDDED = 1 << 1,
  31. PORTAL_CURSOR_MODE_METADATA = 1 << 2,
  32. };
  33. struct screencast_portal_capture {
  34. enum portal_capture_type capture_type;
  35. GCancellable *cancellable;
  36. char *session_handle;
  37. char *restore_token;
  38. obs_source_t *source;
  39. obs_data_t *settings;
  40. uint32_t pipewire_node;
  41. bool cursor_visible;
  42. obs_pipewire *obs_pw;
  43. };
  44. /* ------------------------------------------------- */
  45. static GDBusProxy *screencast_proxy = NULL;
  46. static void ensure_screencast_portal_proxy(void)
  47. {
  48. g_autoptr(GError) error = NULL;
  49. if (!screencast_proxy) {
  50. screencast_proxy = g_dbus_proxy_new_sync(
  51. portal_get_dbus_connection(), G_DBUS_PROXY_FLAGS_NONE,
  52. NULL, "org.freedesktop.portal.Desktop",
  53. "/org/freedesktop/portal/desktop",
  54. "org.freedesktop.portal.ScreenCast", NULL, &error);
  55. if (error) {
  56. blog(LOG_WARNING,
  57. "[portals] Error retrieving D-Bus proxy: %s",
  58. error->message);
  59. return;
  60. }
  61. }
  62. }
  63. static GDBusProxy *get_screencast_portal_proxy(void)
  64. {
  65. ensure_screencast_portal_proxy();
  66. return screencast_proxy;
  67. }
  68. static uint32_t get_available_capture_types(void)
  69. {
  70. g_autoptr(GVariant) cached_source_types = NULL;
  71. uint32_t available_source_types;
  72. ensure_screencast_portal_proxy();
  73. if (!screencast_proxy)
  74. return 0;
  75. cached_source_types = g_dbus_proxy_get_cached_property(
  76. screencast_proxy, "AvailableSourceTypes");
  77. available_source_types =
  78. cached_source_types ? g_variant_get_uint32(cached_source_types)
  79. : 0;
  80. return available_source_types;
  81. }
  82. static uint32_t get_available_cursor_modes(void)
  83. {
  84. g_autoptr(GVariant) cached_cursor_modes = NULL;
  85. uint32_t available_cursor_modes;
  86. ensure_screencast_portal_proxy();
  87. if (!screencast_proxy)
  88. return 0;
  89. cached_cursor_modes = g_dbus_proxy_get_cached_property(
  90. screencast_proxy, "AvailableCursorModes");
  91. available_cursor_modes =
  92. cached_cursor_modes ? g_variant_get_uint32(cached_cursor_modes)
  93. : 0;
  94. return available_cursor_modes;
  95. }
  96. static uint32_t get_screencast_version(void)
  97. {
  98. g_autoptr(GVariant) cached_version = NULL;
  99. uint32_t version;
  100. ensure_screencast_portal_proxy();
  101. if (!screencast_proxy)
  102. return 0;
  103. cached_version =
  104. g_dbus_proxy_get_cached_property(screencast_proxy, "version");
  105. version = cached_version ? g_variant_get_uint32(cached_version) : 0;
  106. return version;
  107. }
  108. /* ------------------------------------------------- */
  109. struct dbus_call_data {
  110. struct screencast_portal_capture *capture;
  111. char *request_path;
  112. guint signal_id;
  113. gulong cancelled_id;
  114. };
  115. static const char *capture_type_to_string(enum portal_capture_type capture_type)
  116. {
  117. switch (capture_type) {
  118. case PORTAL_CAPTURE_TYPE_MONITOR:
  119. return "desktop";
  120. case PORTAL_CAPTURE_TYPE_WINDOW:
  121. return "window";
  122. case PORTAL_CAPTURE_TYPE_VIRTUAL:
  123. default:
  124. return "unknown";
  125. }
  126. return "unknown";
  127. }
  128. static void on_cancelled_cb(GCancellable *cancellable, void *data)
  129. {
  130. UNUSED_PARAMETER(cancellable);
  131. struct dbus_call_data *call = data;
  132. blog(LOG_INFO, "[pipewire] Screencast session cancelled");
  133. g_dbus_connection_call(
  134. portal_get_dbus_connection(), "org.freedesktop.portal.Desktop",
  135. call->request_path, "org.freedesktop.portal.Request", "Close",
  136. NULL, NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
  137. }
  138. static struct dbus_call_data *
  139. subscribe_to_signal(struct screencast_portal_capture *capture, const char *path,
  140. GDBusSignalCallback callback)
  141. {
  142. struct dbus_call_data *call;
  143. call = bzalloc(sizeof(struct dbus_call_data));
  144. call->capture = capture;
  145. call->request_path = bstrdup(path);
  146. call->cancelled_id = g_signal_connect(capture->cancellable, "cancelled",
  147. G_CALLBACK(on_cancelled_cb),
  148. call);
  149. call->signal_id = g_dbus_connection_signal_subscribe(
  150. portal_get_dbus_connection(), "org.freedesktop.portal.Desktop",
  151. "org.freedesktop.portal.Request", "Response",
  152. call->request_path, NULL, G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE,
  153. callback, call, NULL);
  154. return call;
  155. }
  156. static void dbus_call_data_free(struct dbus_call_data *call)
  157. {
  158. if (!call)
  159. return;
  160. if (call->signal_id)
  161. g_dbus_connection_signal_unsubscribe(
  162. portal_get_dbus_connection(), call->signal_id);
  163. if (call->cancelled_id > 0)
  164. g_signal_handler_disconnect(call->capture->cancellable,
  165. call->cancelled_id);
  166. g_clear_pointer(&call->request_path, bfree);
  167. bfree(call);
  168. }
  169. /* ------------------------------------------------- */
  170. static void on_pipewire_remote_opened_cb(GObject *source, GAsyncResult *res,
  171. void *user_data)
  172. {
  173. struct screencast_portal_capture *capture;
  174. g_autoptr(GUnixFDList) fd_list = NULL;
  175. g_autoptr(GVariant) result = NULL;
  176. g_autoptr(GError) error = NULL;
  177. int pipewire_fd;
  178. int fd_index;
  179. capture = user_data;
  180. result = g_dbus_proxy_call_with_unix_fd_list_finish(
  181. G_DBUS_PROXY(source), &fd_list, res, &error);
  182. if (error) {
  183. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  184. blog(LOG_ERROR,
  185. "[pipewire] Error retrieving pipewire fd: %s",
  186. error->message);
  187. return;
  188. }
  189. g_variant_get(result, "(h)", &fd_index, &error);
  190. pipewire_fd = g_unix_fd_list_get(fd_list, fd_index, &error);
  191. if (error) {
  192. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  193. blog(LOG_ERROR,
  194. "[pipewire] Error retrieving pipewire fd: %s",
  195. error->message);
  196. return;
  197. }
  198. capture->obs_pw = obs_pipewire_create(pipewire_fd);
  199. if (!capture->obs_pw)
  200. return;
  201. obs_pipewire_connect_stream(
  202. capture->obs_pw, capture->pipewire_node, "OBS Studio",
  203. pw_properties_new(PW_KEY_MEDIA_TYPE, "Video",
  204. PW_KEY_MEDIA_CATEGORY, "Capture",
  205. PW_KEY_MEDIA_ROLE, "Screen", NULL));
  206. obs_pipewire_set_cursor_visible(capture->obs_pw,
  207. capture->cursor_visible);
  208. }
  209. static void open_pipewire_remote(struct screencast_portal_capture *capture)
  210. {
  211. GVariantBuilder builder;
  212. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  213. g_dbus_proxy_call_with_unix_fd_list(
  214. get_screencast_portal_proxy(), "OpenPipeWireRemote",
  215. g_variant_new("(oa{sv})", capture->session_handle, &builder),
  216. G_DBUS_CALL_FLAGS_NONE, -1, NULL, capture->cancellable,
  217. on_pipewire_remote_opened_cb, capture);
  218. }
  219. /* ------------------------------------------------- */
  220. static void on_start_response_received_cb(GDBusConnection *connection,
  221. const char *sender_name,
  222. const char *object_path,
  223. const char *interface_name,
  224. const char *signal_name,
  225. GVariant *parameters, void *user_data)
  226. {
  227. UNUSED_PARAMETER(connection);
  228. UNUSED_PARAMETER(sender_name);
  229. UNUSED_PARAMETER(object_path);
  230. UNUSED_PARAMETER(interface_name);
  231. UNUSED_PARAMETER(signal_name);
  232. struct screencast_portal_capture *capture;
  233. g_autoptr(GVariant) stream_properties = NULL;
  234. g_autoptr(GVariant) streams = NULL;
  235. g_autoptr(GVariant) result = NULL;
  236. struct dbus_call_data *call = user_data;
  237. GVariantIter iter;
  238. uint32_t response;
  239. size_t n_streams;
  240. capture = call->capture;
  241. g_clear_pointer(&call, dbus_call_data_free);
  242. g_variant_get(parameters, "(u@a{sv})", &response, &result);
  243. if (response != 0) {
  244. blog(LOG_WARNING,
  245. "[pipewire] Failed to start screencast, denied or cancelled by user");
  246. return;
  247. }
  248. streams =
  249. g_variant_lookup_value(result, "streams", G_VARIANT_TYPE_ARRAY);
  250. g_variant_iter_init(&iter, streams);
  251. n_streams = g_variant_iter_n_children(&iter);
  252. if (n_streams != 1) {
  253. blog(LOG_WARNING,
  254. "[pipewire] Received more than one stream when only one was expected. "
  255. "This is probably a bug in the desktop portal implementation you are "
  256. "using.");
  257. // The KDE Desktop portal implementation sometimes sends an invalid
  258. // response where more than one stream is attached, and only the
  259. // last one is the one we're looking for. This is the only known
  260. // buggy implementation, so let's at least try to make it work here.
  261. for (size_t i = 0; i < n_streams - 1; i++) {
  262. g_autoptr(GVariant) throwaway_properties = NULL;
  263. uint32_t throwaway_pipewire_node;
  264. g_variant_iter_loop(&iter, "(u@a{sv})",
  265. &throwaway_pipewire_node,
  266. &throwaway_properties);
  267. }
  268. }
  269. g_variant_iter_loop(&iter, "(u@a{sv})", &capture->pipewire_node,
  270. &stream_properties);
  271. if (get_screencast_version() >= 4) {
  272. g_autoptr(GVariant) restore_token = NULL;
  273. g_clear_pointer(&capture->restore_token, bfree);
  274. restore_token = g_variant_lookup_value(result, "restore_token",
  275. G_VARIANT_TYPE_STRING);
  276. if (restore_token)
  277. capture->restore_token = bstrdup(
  278. g_variant_get_string(restore_token, NULL));
  279. obs_source_save(capture->source);
  280. }
  281. blog(LOG_INFO, "[pipewire] %s selected, setting up screencast",
  282. capture_type_to_string(capture->capture_type));
  283. open_pipewire_remote(capture);
  284. }
  285. static void on_started_cb(GObject *source, GAsyncResult *res, void *user_data)
  286. {
  287. UNUSED_PARAMETER(user_data);
  288. g_autoptr(GVariant) result = NULL;
  289. g_autoptr(GError) error = NULL;
  290. result = g_dbus_proxy_call_finish(G_DBUS_PROXY(source), res, &error);
  291. if (error) {
  292. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  293. blog(LOG_ERROR,
  294. "[pipewire] Error selecting screencast source: %s",
  295. error->message);
  296. return;
  297. }
  298. }
  299. static void start(struct screencast_portal_capture *capture)
  300. {
  301. GVariantBuilder builder;
  302. struct dbus_call_data *call;
  303. char *request_token;
  304. char *request_path;
  305. portal_create_request_path(&request_path, &request_token);
  306. blog(LOG_INFO, "[pipewire] Asking for %s",
  307. capture_type_to_string(capture->capture_type));
  308. call = subscribe_to_signal(capture, request_path,
  309. on_start_response_received_cb);
  310. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  311. g_variant_builder_add(&builder, "{sv}", "handle_token",
  312. g_variant_new_string(request_token));
  313. g_dbus_proxy_call(get_screencast_portal_proxy(), "Start",
  314. g_variant_new("(osa{sv})", capture->session_handle,
  315. "", &builder),
  316. G_DBUS_CALL_FLAGS_NONE, -1, capture->cancellable,
  317. on_started_cb, call);
  318. bfree(request_token);
  319. bfree(request_path);
  320. }
  321. /* ------------------------------------------------- */
  322. static void on_select_source_response_received_cb(
  323. GDBusConnection *connection, const char *sender_name,
  324. const char *object_path, const char *interface_name,
  325. const char *signal_name, GVariant *parameters, void *user_data)
  326. {
  327. UNUSED_PARAMETER(connection);
  328. UNUSED_PARAMETER(sender_name);
  329. UNUSED_PARAMETER(object_path);
  330. UNUSED_PARAMETER(interface_name);
  331. UNUSED_PARAMETER(signal_name);
  332. struct screencast_portal_capture *capture;
  333. g_autoptr(GVariant) ret = NULL;
  334. struct dbus_call_data *call = user_data;
  335. uint32_t response;
  336. capture = call->capture;
  337. blog(LOG_DEBUG, "[pipewire] Response to select source received");
  338. g_clear_pointer(&call, dbus_call_data_free);
  339. g_variant_get(parameters, "(u@a{sv})", &response, &ret);
  340. if (response != 0) {
  341. blog(LOG_WARNING,
  342. "[pipewire] Failed to select source, denied or cancelled by user");
  343. return;
  344. }
  345. start(capture);
  346. }
  347. static void on_source_selected_cb(GObject *source, GAsyncResult *res,
  348. void *user_data)
  349. {
  350. UNUSED_PARAMETER(user_data);
  351. g_autoptr(GVariant) result = NULL;
  352. g_autoptr(GError) error = NULL;
  353. result = g_dbus_proxy_call_finish(G_DBUS_PROXY(source), res, &error);
  354. if (error) {
  355. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  356. blog(LOG_ERROR,
  357. "[pipewire] Error selecting screencast source: %s",
  358. error->message);
  359. return;
  360. }
  361. }
  362. static void select_source(struct screencast_portal_capture *capture)
  363. {
  364. struct dbus_call_data *call;
  365. GVariantBuilder builder;
  366. uint32_t available_cursor_modes;
  367. char *request_token;
  368. char *request_path;
  369. portal_create_request_path(&request_path, &request_token);
  370. call = subscribe_to_signal(capture, request_path,
  371. on_select_source_response_received_cb);
  372. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  373. g_variant_builder_add(&builder, "{sv}", "types",
  374. g_variant_new_uint32(capture->capture_type));
  375. g_variant_builder_add(&builder, "{sv}", "multiple",
  376. g_variant_new_boolean(FALSE));
  377. g_variant_builder_add(&builder, "{sv}", "handle_token",
  378. g_variant_new_string(request_token));
  379. available_cursor_modes = get_available_cursor_modes();
  380. if (available_cursor_modes & PORTAL_CURSOR_MODE_METADATA)
  381. g_variant_builder_add(
  382. &builder, "{sv}", "cursor_mode",
  383. g_variant_new_uint32(PORTAL_CURSOR_MODE_METADATA));
  384. else if ((available_cursor_modes & PORTAL_CURSOR_MODE_EMBEDDED) &&
  385. capture->cursor_visible)
  386. g_variant_builder_add(
  387. &builder, "{sv}", "cursor_mode",
  388. g_variant_new_uint32(PORTAL_CURSOR_MODE_EMBEDDED));
  389. else
  390. g_variant_builder_add(
  391. &builder, "{sv}", "cursor_mode",
  392. g_variant_new_uint32(PORTAL_CURSOR_MODE_HIDDEN));
  393. if (get_screencast_version() >= 4) {
  394. g_variant_builder_add(&builder, "{sv}", "persist_mode",
  395. g_variant_new_uint32(2));
  396. if (capture->restore_token && *capture->restore_token) {
  397. g_variant_builder_add(
  398. &builder, "{sv}", "restore_token",
  399. g_variant_new_string(capture->restore_token));
  400. }
  401. }
  402. g_dbus_proxy_call(get_screencast_portal_proxy(), "SelectSources",
  403. g_variant_new("(oa{sv})", capture->session_handle,
  404. &builder),
  405. G_DBUS_CALL_FLAGS_NONE, -1, capture->cancellable,
  406. on_source_selected_cb, call);
  407. bfree(request_token);
  408. bfree(request_path);
  409. }
  410. /* ------------------------------------------------- */
  411. static void on_create_session_response_received_cb(
  412. GDBusConnection *connection, const char *sender_name,
  413. const char *object_path, const char *interface_name,
  414. const char *signal_name, GVariant *parameters, void *user_data)
  415. {
  416. UNUSED_PARAMETER(connection);
  417. UNUSED_PARAMETER(sender_name);
  418. UNUSED_PARAMETER(object_path);
  419. UNUSED_PARAMETER(interface_name);
  420. UNUSED_PARAMETER(signal_name);
  421. struct screencast_portal_capture *capture;
  422. g_autoptr(GVariant) session_handle_variant = NULL;
  423. g_autoptr(GVariant) result = NULL;
  424. struct dbus_call_data *call = user_data;
  425. uint32_t response;
  426. capture = call->capture;
  427. g_clear_pointer(&call, dbus_call_data_free);
  428. g_variant_get(parameters, "(u@a{sv})", &response, &result);
  429. if (response != 0) {
  430. blog(LOG_WARNING,
  431. "[pipewire] Failed to create session, denied or cancelled by user");
  432. return;
  433. }
  434. blog(LOG_INFO, "[pipewire] Screencast session created");
  435. session_handle_variant =
  436. g_variant_lookup_value(result, "session_handle", NULL);
  437. capture->session_handle =
  438. g_variant_dup_string(session_handle_variant, NULL);
  439. select_source(capture);
  440. }
  441. static void on_session_created_cb(GObject *source, GAsyncResult *res,
  442. void *user_data)
  443. {
  444. UNUSED_PARAMETER(user_data);
  445. g_autoptr(GVariant) result = NULL;
  446. g_autoptr(GError) error = NULL;
  447. result = g_dbus_proxy_call_finish(G_DBUS_PROXY(source), res, &error);
  448. if (error) {
  449. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  450. blog(LOG_ERROR,
  451. "[pipewire] Error creating screencast session: %s",
  452. error->message);
  453. return;
  454. }
  455. }
  456. static void create_session(struct screencast_portal_capture *capture)
  457. {
  458. struct dbus_call_data *call;
  459. GVariantBuilder builder;
  460. char *session_token;
  461. char *request_token;
  462. char *request_path;
  463. portal_create_request_path(&request_path, &request_token);
  464. portal_create_session_path(NULL, &session_token);
  465. call = subscribe_to_signal(capture, request_path,
  466. on_create_session_response_received_cb);
  467. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  468. g_variant_builder_add(&builder, "{sv}", "handle_token",
  469. g_variant_new_string(request_token));
  470. g_variant_builder_add(&builder, "{sv}", "session_handle_token",
  471. g_variant_new_string(session_token));
  472. g_dbus_proxy_call(get_screencast_portal_proxy(), "CreateSession",
  473. g_variant_new("(a{sv})", &builder),
  474. G_DBUS_CALL_FLAGS_NONE, -1, capture->cancellable,
  475. on_session_created_cb, call);
  476. bfree(session_token);
  477. bfree(request_token);
  478. bfree(request_path);
  479. }
  480. /* ------------------------------------------------- */
  481. static gboolean
  482. init_screencast_capture(struct screencast_portal_capture *capture)
  483. {
  484. GDBusConnection *connection;
  485. GDBusProxy *proxy;
  486. capture->cancellable = g_cancellable_new();
  487. connection = portal_get_dbus_connection();
  488. if (!connection)
  489. return FALSE;
  490. proxy = get_screencast_portal_proxy();
  491. if (!proxy)
  492. return FALSE;
  493. blog(LOG_INFO, "PipeWire initialized");
  494. create_session(capture);
  495. return TRUE;
  496. }
  497. static bool reload_session_cb(obs_properties_t *properties,
  498. obs_property_t *property, void *data)
  499. {
  500. UNUSED_PARAMETER(properties);
  501. UNUSED_PARAMETER(property);
  502. struct screencast_portal_capture *capture = data;
  503. g_clear_pointer(&capture->restore_token, bfree);
  504. g_clear_pointer(&capture->obs_pw, obs_pipewire_destroy);
  505. if (capture->session_handle) {
  506. blog(LOG_DEBUG, "[pipewire] Cleaning previous session %s",
  507. capture->session_handle);
  508. g_dbus_connection_call(portal_get_dbus_connection(),
  509. "org.freedesktop.portal.Desktop",
  510. capture->session_handle,
  511. "org.freedesktop.portal.Session",
  512. "Close", NULL, NULL,
  513. G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL,
  514. NULL);
  515. g_clear_pointer(&capture->session_handle, g_free);
  516. }
  517. init_screencast_capture(capture);
  518. return false;
  519. }
  520. /* obs_source_info methods */
  521. static const char *screencast_portal_desktop_capture_get_name(void *data)
  522. {
  523. UNUSED_PARAMETER(data);
  524. return obs_module_text("PipeWireDesktopCapture");
  525. }
  526. static const char *screencast_portal_window_capture_get_name(void *data)
  527. {
  528. UNUSED_PARAMETER(data);
  529. return obs_module_text("PipeWireWindowCapture");
  530. }
  531. static void *screencast_portal_desktop_capture_create(obs_data_t *settings,
  532. obs_source_t *source)
  533. {
  534. struct screencast_portal_capture *capture;
  535. capture = bzalloc(sizeof(struct screencast_portal_capture));
  536. capture->capture_type = PORTAL_CAPTURE_TYPE_MONITOR;
  537. capture->cursor_visible = obs_data_get_bool(settings, "ShowCursor");
  538. capture->restore_token =
  539. bstrdup(obs_data_get_string(settings, "RestoreToken"));
  540. capture->source = source;
  541. init_screencast_capture(capture);
  542. return capture;
  543. }
  544. static void *screencast_portal_window_capture_create(obs_data_t *settings,
  545. obs_source_t *source)
  546. {
  547. struct screencast_portal_capture *capture;
  548. capture = bzalloc(sizeof(struct screencast_portal_capture));
  549. capture->capture_type = PORTAL_CAPTURE_TYPE_WINDOW;
  550. capture->cursor_visible = obs_data_get_bool(settings, "ShowCursor");
  551. capture->restore_token =
  552. bstrdup(obs_data_get_string(settings, "RestoreToken"));
  553. capture->source = source;
  554. init_screencast_capture(capture);
  555. return capture;
  556. }
  557. static void screencast_portal_capture_destroy(void *data)
  558. {
  559. struct screencast_portal_capture *capture = data;
  560. if (!capture)
  561. return;
  562. if (capture->session_handle) {
  563. g_dbus_connection_call(portal_get_dbus_connection(),
  564. "org.freedesktop.portal.Desktop",
  565. capture->session_handle,
  566. "org.freedesktop.portal.Session",
  567. "Close", NULL, NULL,
  568. G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL,
  569. NULL);
  570. g_clear_pointer(&capture->session_handle, g_free);
  571. }
  572. g_clear_pointer(&capture->restore_token, bfree);
  573. obs_pipewire_destroy(capture->obs_pw);
  574. g_cancellable_cancel(capture->cancellable);
  575. g_clear_object(&capture->cancellable);
  576. bfree(capture);
  577. }
  578. static void screencast_portal_capture_save(void *data, obs_data_t *settings)
  579. {
  580. struct screencast_portal_capture *capture = data;
  581. obs_data_set_string(settings, "RestoreToken", capture->restore_token);
  582. }
  583. static void screencast_portal_capture_get_defaults(obs_data_t *settings)
  584. {
  585. obs_data_set_default_bool(settings, "ShowCursor", true);
  586. obs_data_set_default_string(settings, "RestoreToken", NULL);
  587. }
  588. static obs_properties_t *screencast_portal_capture_get_properties(void *data)
  589. {
  590. struct screencast_portal_capture *capture = data;
  591. const char *reload_string_id;
  592. obs_properties_t *properties;
  593. switch (capture->capture_type) {
  594. case PORTAL_CAPTURE_TYPE_MONITOR:
  595. reload_string_id = "PipeWireSelectMonitor";
  596. break;
  597. case PORTAL_CAPTURE_TYPE_WINDOW:
  598. reload_string_id = "PipeWireSelectWindow";
  599. break;
  600. case PORTAL_CAPTURE_TYPE_VIRTUAL:
  601. default:
  602. return NULL;
  603. }
  604. properties = obs_properties_create();
  605. obs_properties_add_button2(properties, "Reload",
  606. obs_module_text(reload_string_id),
  607. reload_session_cb, capture);
  608. obs_properties_add_bool(properties, "ShowCursor",
  609. obs_module_text("ShowCursor"));
  610. return properties;
  611. }
  612. static void screencast_portal_capture_update(void *data, obs_data_t *settings)
  613. {
  614. struct screencast_portal_capture *capture = data;
  615. capture->cursor_visible = obs_data_get_bool(settings, "ShowCursor");
  616. if (capture->obs_pw)
  617. obs_pipewire_set_cursor_visible(capture->obs_pw,
  618. capture->cursor_visible);
  619. }
  620. static void screencast_portal_capture_show(void *data)
  621. {
  622. struct screencast_portal_capture *capture = data;
  623. if (capture->obs_pw)
  624. obs_pipewire_show(capture->obs_pw);
  625. }
  626. static void screencast_portal_capture_hide(void *data)
  627. {
  628. struct screencast_portal_capture *capture = data;
  629. if (capture->obs_pw)
  630. obs_pipewire_hide(capture->obs_pw);
  631. }
  632. static uint32_t screencast_portal_capture_get_width(void *data)
  633. {
  634. struct screencast_portal_capture *capture = data;
  635. if (capture->obs_pw)
  636. return obs_pipewire_get_width(capture->obs_pw);
  637. else
  638. return 0;
  639. }
  640. static uint32_t screencast_portal_capture_get_height(void *data)
  641. {
  642. struct screencast_portal_capture *capture = data;
  643. if (capture->obs_pw)
  644. return obs_pipewire_get_height(capture->obs_pw);
  645. else
  646. return 0;
  647. }
  648. static void screencast_portal_capture_video_render(void *data,
  649. gs_effect_t *effect)
  650. {
  651. struct screencast_portal_capture *capture = data;
  652. if (capture->obs_pw)
  653. obs_pipewire_video_render(capture->obs_pw, effect);
  654. }
  655. void screencast_portal_load(void)
  656. {
  657. uint32_t available_capture_types = get_available_capture_types();
  658. bool desktop_capture_available =
  659. (available_capture_types & PORTAL_CAPTURE_TYPE_MONITOR) != 0;
  660. bool window_capture_available =
  661. (available_capture_types & PORTAL_CAPTURE_TYPE_WINDOW) != 0;
  662. if (available_capture_types == 0) {
  663. blog(LOG_INFO, "[pipewire] No captures available");
  664. return;
  665. }
  666. blog(LOG_INFO, "[pipewire] Available captures:");
  667. if (desktop_capture_available)
  668. blog(LOG_INFO, "[pipewire] - Desktop capture");
  669. if (window_capture_available)
  670. blog(LOG_INFO, "[pipewire] - Window capture");
  671. // Desktop capture
  672. const struct obs_source_info screencast_portal_desktop_capture_info = {
  673. .id = "pipewire-desktop-capture-source",
  674. .type = OBS_SOURCE_TYPE_INPUT,
  675. .output_flags = OBS_SOURCE_VIDEO,
  676. .get_name = screencast_portal_desktop_capture_get_name,
  677. .create = screencast_portal_desktop_capture_create,
  678. .destroy = screencast_portal_capture_destroy,
  679. .save = screencast_portal_capture_save,
  680. .get_defaults = screencast_portal_capture_get_defaults,
  681. .get_properties = screencast_portal_capture_get_properties,
  682. .update = screencast_portal_capture_update,
  683. .show = screencast_portal_capture_show,
  684. .hide = screencast_portal_capture_hide,
  685. .get_width = screencast_portal_capture_get_width,
  686. .get_height = screencast_portal_capture_get_height,
  687. .video_render = screencast_portal_capture_video_render,
  688. .icon_type = OBS_ICON_TYPE_DESKTOP_CAPTURE,
  689. };
  690. if (desktop_capture_available)
  691. obs_register_source(&screencast_portal_desktop_capture_info);
  692. // Window capture
  693. const struct obs_source_info screencast_portal_window_capture_info = {
  694. .id = "pipewire-window-capture-source",
  695. .type = OBS_SOURCE_TYPE_INPUT,
  696. .output_flags = OBS_SOURCE_VIDEO,
  697. .get_name = screencast_portal_window_capture_get_name,
  698. .create = screencast_portal_window_capture_create,
  699. .destroy = screencast_portal_capture_destroy,
  700. .save = screencast_portal_capture_save,
  701. .get_defaults = screencast_portal_capture_get_defaults,
  702. .get_properties = screencast_portal_capture_get_properties,
  703. .update = screencast_portal_capture_update,
  704. .show = screencast_portal_capture_show,
  705. .hide = screencast_portal_capture_hide,
  706. .get_width = screencast_portal_capture_get_width,
  707. .get_height = screencast_portal_capture_get_height,
  708. .video_render = screencast_portal_capture_video_render,
  709. .icon_type = OBS_ICON_TYPE_WINDOW_CAPTURE,
  710. };
  711. if (window_capture_available)
  712. obs_register_source(&screencast_portal_window_capture_info);
  713. }
  714. void screencast_portal_unload(void)
  715. {
  716. g_clear_object(&screencast_proxy);
  717. }