screencast-portal.c 25 KB

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