pipewire.c 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560
  1. /* pipewire.c
  2. *
  3. * Copyright 2020 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 <util/darray.h>
  23. #include <util/dstr.h>
  24. #include <gio/gio.h>
  25. #include <gio/gunixfdlist.h>
  26. #include <fcntl.h>
  27. #include <glad/glad.h>
  28. #include <linux/dma-buf.h>
  29. #include <libdrm/drm_fourcc.h>
  30. #include <spa/param/video/format-utils.h>
  31. #include <spa/debug/format.h>
  32. #include <spa/debug/types.h>
  33. #include <spa/param/video/type-info.h>
  34. #include <spa/utils/result.h>
  35. #ifndef SPA_POD_PROP_FLAG_DONT_FIXATE
  36. #define SPA_POD_PROP_FLAG_DONT_FIXATE (1 << 4)
  37. #endif
  38. #define REQUEST_PATH "/org/freedesktop/portal/desktop/request/%s/obs%u"
  39. #define SESSION_PATH "/org/freedesktop/portal/desktop/session/%s/obs%u"
  40. #define CURSOR_META_SIZE(width, height) \
  41. (sizeof(struct spa_meta_cursor) + sizeof(struct spa_meta_bitmap) + \
  42. width * height * 4)
  43. struct obs_pw_version {
  44. int major;
  45. int minor;
  46. int micro;
  47. };
  48. struct format_info {
  49. uint32_t spa_format;
  50. uint32_t drm_format;
  51. DARRAY(uint64_t) modifiers;
  52. };
  53. struct _obs_pipewire_data {
  54. GCancellable *cancellable;
  55. char *sender_name;
  56. char *session_handle;
  57. char *restore_token;
  58. uint32_t pipewire_node;
  59. int pipewire_fd;
  60. uint32_t available_cursor_modes;
  61. obs_source_t *source;
  62. obs_data_t *settings;
  63. gs_texture_t *texture;
  64. struct pw_thread_loop *thread_loop;
  65. struct pw_context *context;
  66. struct pw_core *core;
  67. struct spa_hook core_listener;
  68. int server_version_sync;
  69. struct obs_pw_version server_version;
  70. struct pw_stream *stream;
  71. struct spa_hook stream_listener;
  72. struct spa_source *reneg;
  73. struct spa_video_info format;
  74. struct {
  75. bool valid;
  76. int x, y;
  77. uint32_t width, height;
  78. } crop;
  79. struct {
  80. bool visible;
  81. bool valid;
  82. int x, y;
  83. int hotspot_x, hotspot_y;
  84. int width, height;
  85. gs_texture_t *texture;
  86. } cursor;
  87. enum obs_pw_capture_type capture_type;
  88. struct obs_video_info video_info;
  89. bool negotiated;
  90. DARRAY(struct format_info) format_info;
  91. };
  92. struct dbus_call_data {
  93. obs_pipewire_data *obs_pw;
  94. char *request_path;
  95. guint signal_id;
  96. gulong cancelled_id;
  97. };
  98. /* auxiliary methods */
  99. static bool parse_pw_version(struct obs_pw_version *dst, const char *version)
  100. {
  101. int n_matches = sscanf(version, "%d.%d.%d", &dst->major, &dst->minor,
  102. &dst->micro);
  103. return n_matches == 3;
  104. }
  105. static bool check_pw_version(const struct obs_pw_version *pw_version, int major,
  106. int minor, int micro)
  107. {
  108. if (pw_version->major != major)
  109. return pw_version->major > major;
  110. if (pw_version->minor != minor)
  111. return pw_version->minor > minor;
  112. return pw_version->micro >= micro;
  113. }
  114. static void update_pw_versions(obs_pipewire_data *obs_pw, const char *version)
  115. {
  116. blog(LOG_INFO, "[pipewire] server version: %s", version);
  117. blog(LOG_INFO, "[pipewire] library version: %s",
  118. pw_get_library_version());
  119. blog(LOG_INFO, "[pipewire] header version: %s",
  120. pw_get_headers_version());
  121. if (!parse_pw_version(&obs_pw->server_version, version))
  122. blog(LOG_WARNING, "[pipewire] failed to parse server version");
  123. }
  124. static const char *capture_type_to_string(enum obs_pw_capture_type capture_type)
  125. {
  126. switch (capture_type) {
  127. case DESKTOP_CAPTURE:
  128. return "desktop";
  129. case WINDOW_CAPTURE:
  130. return "window";
  131. }
  132. return "unknown";
  133. }
  134. static void new_request_path(obs_pipewire_data *data, char **out_path,
  135. char **out_token)
  136. {
  137. static uint32_t request_token_count = 0;
  138. request_token_count++;
  139. if (out_token) {
  140. struct dstr str;
  141. dstr_init(&str);
  142. dstr_printf(&str, "obs%u", request_token_count);
  143. *out_token = str.array;
  144. }
  145. if (out_path) {
  146. struct dstr str;
  147. dstr_init(&str);
  148. dstr_printf(&str, REQUEST_PATH, data->sender_name,
  149. request_token_count);
  150. *out_path = str.array;
  151. }
  152. }
  153. static void new_session_path(obs_pipewire_data *data, char **out_path,
  154. char **out_token)
  155. {
  156. static uint32_t session_token_count = 0;
  157. session_token_count++;
  158. if (out_token) {
  159. struct dstr str;
  160. dstr_init(&str);
  161. dstr_printf(&str, "obs%u", session_token_count);
  162. *out_token = str.array;
  163. }
  164. if (out_path) {
  165. struct dstr str;
  166. dstr_init(&str);
  167. dstr_printf(&str, SESSION_PATH, data->sender_name,
  168. session_token_count);
  169. *out_path = str.array;
  170. }
  171. }
  172. static void on_cancelled_cb(GCancellable *cancellable, void *data)
  173. {
  174. UNUSED_PARAMETER(cancellable);
  175. struct dbus_call_data *call = data;
  176. blog(LOG_INFO, "[pipewire] screencast session cancelled");
  177. g_dbus_connection_call(
  178. portal_get_dbus_connection(), "org.freedesktop.portal.Desktop",
  179. call->request_path, "org.freedesktop.portal.Request", "Close",
  180. NULL, NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
  181. }
  182. static struct dbus_call_data *subscribe_to_signal(obs_pipewire_data *obs_pw,
  183. const char *path,
  184. GDBusSignalCallback callback)
  185. {
  186. struct dbus_call_data *call;
  187. call = bzalloc(sizeof(struct dbus_call_data));
  188. call->obs_pw = obs_pw;
  189. call->request_path = bstrdup(path);
  190. call->cancelled_id = g_signal_connect(obs_pw->cancellable, "cancelled",
  191. G_CALLBACK(on_cancelled_cb),
  192. call);
  193. call->signal_id = g_dbus_connection_signal_subscribe(
  194. portal_get_dbus_connection(), "org.freedesktop.portal.Desktop",
  195. "org.freedesktop.portal.Request", "Response",
  196. call->request_path, NULL, G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE,
  197. callback, call, NULL);
  198. return call;
  199. }
  200. static void dbus_call_data_free(struct dbus_call_data *call)
  201. {
  202. if (!call)
  203. return;
  204. if (call->signal_id)
  205. g_dbus_connection_signal_unsubscribe(
  206. portal_get_dbus_connection(), call->signal_id);
  207. if (call->cancelled_id > 0)
  208. g_signal_handler_disconnect(call->obs_pw->cancellable,
  209. call->cancelled_id);
  210. g_clear_pointer(&call->request_path, bfree);
  211. bfree(call);
  212. }
  213. static void teardown_pipewire(obs_pipewire_data *obs_pw)
  214. {
  215. if (obs_pw->thread_loop) {
  216. pw_thread_loop_wait(obs_pw->thread_loop);
  217. pw_thread_loop_stop(obs_pw->thread_loop);
  218. }
  219. if (obs_pw->stream)
  220. pw_stream_disconnect(obs_pw->stream);
  221. g_clear_pointer(&obs_pw->stream, pw_stream_destroy);
  222. g_clear_pointer(&obs_pw->context, pw_context_destroy);
  223. g_clear_pointer(&obs_pw->thread_loop, pw_thread_loop_destroy);
  224. if (obs_pw->pipewire_fd > 0) {
  225. close(obs_pw->pipewire_fd);
  226. obs_pw->pipewire_fd = 0;
  227. }
  228. obs_pw->negotiated = false;
  229. }
  230. static void destroy_session(obs_pipewire_data *obs_pw)
  231. {
  232. if (obs_pw->session_handle) {
  233. g_dbus_connection_call(portal_get_dbus_connection(),
  234. "org.freedesktop.portal.Desktop",
  235. obs_pw->session_handle,
  236. "org.freedesktop.portal.Session",
  237. "Close", NULL, NULL,
  238. G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL,
  239. NULL);
  240. g_clear_pointer(&obs_pw->session_handle, g_free);
  241. }
  242. g_clear_pointer(&obs_pw->sender_name, bfree);
  243. g_clear_pointer(&obs_pw->cursor.texture, gs_texture_destroy);
  244. g_clear_pointer(&obs_pw->texture, gs_texture_destroy);
  245. g_cancellable_cancel(obs_pw->cancellable);
  246. g_clear_object(&obs_pw->cancellable);
  247. }
  248. static inline bool has_effective_crop(obs_pipewire_data *obs_pw)
  249. {
  250. return obs_pw->crop.valid &&
  251. (obs_pw->crop.x != 0 || obs_pw->crop.y != 0 ||
  252. obs_pw->crop.width < obs_pw->format.info.raw.size.width ||
  253. obs_pw->crop.height < obs_pw->format.info.raw.size.height);
  254. }
  255. static const struct {
  256. uint32_t spa_format;
  257. uint32_t drm_format;
  258. enum gs_color_format gs_format;
  259. bool swap_red_blue;
  260. const char *pretty_name;
  261. } supported_formats[] = {
  262. {
  263. SPA_VIDEO_FORMAT_BGRA,
  264. DRM_FORMAT_ARGB8888,
  265. GS_BGRA,
  266. false,
  267. "ARGB8888",
  268. },
  269. {
  270. SPA_VIDEO_FORMAT_RGBA,
  271. DRM_FORMAT_ABGR8888,
  272. GS_RGBA,
  273. false,
  274. "ABGR8888",
  275. },
  276. {
  277. SPA_VIDEO_FORMAT_BGRx,
  278. DRM_FORMAT_XRGB8888,
  279. GS_BGRX,
  280. false,
  281. "XRGB8888",
  282. },
  283. {
  284. SPA_VIDEO_FORMAT_RGBx,
  285. DRM_FORMAT_XBGR8888,
  286. GS_BGRX,
  287. true,
  288. "XBGR8888",
  289. },
  290. };
  291. #define N_SUPPORTED_FORMATS \
  292. (sizeof(supported_formats) / sizeof(supported_formats[0]))
  293. static bool lookup_format_info_from_spa_format(
  294. uint32_t spa_format, uint32_t *out_drm_format,
  295. enum gs_color_format *out_gs_format, bool *out_swap_red_blue)
  296. {
  297. for (size_t i = 0; i < N_SUPPORTED_FORMATS; i++) {
  298. if (supported_formats[i].spa_format != spa_format)
  299. continue;
  300. if (out_drm_format)
  301. *out_drm_format = supported_formats[i].drm_format;
  302. if (out_gs_format)
  303. *out_gs_format = supported_formats[i].gs_format;
  304. if (out_swap_red_blue)
  305. *out_swap_red_blue = supported_formats[i].swap_red_blue;
  306. return true;
  307. }
  308. return false;
  309. }
  310. static void swap_texture_red_blue(gs_texture_t *texture)
  311. {
  312. GLuint gl_texure = *(GLuint *)gs_texture_get_obj(texture);
  313. glBindTexture(GL_TEXTURE_2D, gl_texure);
  314. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_SWIZZLE_B, GL_RED);
  315. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_SWIZZLE_R, GL_BLUE);
  316. glBindTexture(GL_TEXTURE_2D, 0);
  317. }
  318. static inline struct spa_pod *build_format(struct spa_pod_builder *b,
  319. struct obs_video_info *ovi,
  320. uint32_t format, uint64_t *modifiers,
  321. size_t modifier_count)
  322. {
  323. struct spa_pod_frame format_frame;
  324. /* Make an object of type SPA_TYPE_OBJECT_Format and id SPA_PARAM_EnumFormat.
  325. * The object type is important because it defines the properties that are
  326. * acceptable. The id gives more context about what the object is meant to
  327. * contain. In this case we enumerate supported formats. */
  328. spa_pod_builder_push_object(b, &format_frame, SPA_TYPE_OBJECT_Format,
  329. SPA_PARAM_EnumFormat);
  330. /* add media type and media subtype properties */
  331. spa_pod_builder_add(b, SPA_FORMAT_mediaType,
  332. SPA_POD_Id(SPA_MEDIA_TYPE_video), 0);
  333. spa_pod_builder_add(b, SPA_FORMAT_mediaSubtype,
  334. SPA_POD_Id(SPA_MEDIA_SUBTYPE_raw), 0);
  335. /* formats */
  336. spa_pod_builder_add(b, SPA_FORMAT_VIDEO_format, SPA_POD_Id(format), 0);
  337. /* modifier */
  338. if (modifier_count > 0) {
  339. struct spa_pod_frame modifier_frame;
  340. /* build an enumeration of modifiers */
  341. spa_pod_builder_prop(b, SPA_FORMAT_VIDEO_modifier,
  342. SPA_POD_PROP_FLAG_MANDATORY |
  343. SPA_POD_PROP_FLAG_DONT_FIXATE);
  344. spa_pod_builder_push_choice(b, &modifier_frame, SPA_CHOICE_Enum,
  345. 0);
  346. /* The first element of choice pods is the preferred value. Here
  347. * we arbitrarily pick the first modifier as the preferred one.
  348. */
  349. spa_pod_builder_long(b, modifiers[0]);
  350. /* modifiers from an array */
  351. for (uint32_t i = 0; i < modifier_count; i++)
  352. spa_pod_builder_long(b, modifiers[i]);
  353. spa_pod_builder_pop(b, &modifier_frame);
  354. }
  355. /* add size and framerate ranges */
  356. spa_pod_builder_add(b, SPA_FORMAT_VIDEO_size,
  357. SPA_POD_CHOICE_RANGE_Rectangle(
  358. &SPA_RECTANGLE(320, 240), // Arbitrary
  359. &SPA_RECTANGLE(1, 1),
  360. &SPA_RECTANGLE(8192, 4320)),
  361. SPA_FORMAT_VIDEO_framerate,
  362. SPA_POD_CHOICE_RANGE_Fraction(
  363. &SPA_FRACTION(ovi->fps_num, ovi->fps_den),
  364. &SPA_FRACTION(0, 1), &SPA_FRACTION(360, 1)),
  365. 0);
  366. return spa_pod_builder_pop(b, &format_frame);
  367. }
  368. static bool build_format_params(obs_pipewire_data *obs_pw,
  369. struct spa_pod_builder *pod_builder,
  370. const struct spa_pod ***param_list,
  371. uint32_t *n_params)
  372. {
  373. uint32_t params_count = 0;
  374. const struct spa_pod **params;
  375. params =
  376. bzalloc(2 * obs_pw->format_info.num * sizeof(struct spa_pod *));
  377. if (!params) {
  378. blog(LOG_ERROR,
  379. "[pipewire] Failed to allocate memory for param pointers");
  380. return false;
  381. }
  382. if (!check_pw_version(&obs_pw->server_version, 0, 3, 33))
  383. goto build_shm;
  384. for (size_t i = 0; i < obs_pw->format_info.num; i++) {
  385. if (obs_pw->format_info.array[i].modifiers.num == 0) {
  386. continue;
  387. }
  388. params[params_count++] = build_format(
  389. pod_builder, &obs_pw->video_info,
  390. obs_pw->format_info.array[i].spa_format,
  391. obs_pw->format_info.array[i].modifiers.array,
  392. obs_pw->format_info.array[i].modifiers.num);
  393. }
  394. build_shm:
  395. for (size_t i = 0; i < obs_pw->format_info.num; i++) {
  396. params[params_count++] = build_format(
  397. pod_builder, &obs_pw->video_info,
  398. obs_pw->format_info.array[i].spa_format, NULL, 0);
  399. }
  400. *param_list = params;
  401. *n_params = params_count;
  402. return true;
  403. }
  404. static bool drm_format_available(uint32_t drm_format, uint32_t *drm_formats,
  405. size_t n_drm_formats)
  406. {
  407. for (size_t j = 0; j < n_drm_formats; j++) {
  408. if (drm_format == drm_formats[j]) {
  409. return true;
  410. }
  411. }
  412. return false;
  413. }
  414. static void init_format_info(obs_pipewire_data *obs_pw)
  415. {
  416. da_init(obs_pw->format_info);
  417. obs_enter_graphics();
  418. enum gs_dmabuf_flags dmabuf_flags;
  419. uint32_t *drm_formats = NULL;
  420. size_t n_drm_formats;
  421. bool capabilities_queried = gs_query_dmabuf_capabilities(
  422. &dmabuf_flags, &drm_formats, &n_drm_formats);
  423. for (size_t i = 0; i < N_SUPPORTED_FORMATS; i++) {
  424. struct format_info *info;
  425. if (!drm_format_available(supported_formats[i].drm_format,
  426. drm_formats, n_drm_formats))
  427. continue;
  428. info = da_push_back_new(obs_pw->format_info);
  429. da_init(info->modifiers);
  430. info->spa_format = supported_formats[i].spa_format;
  431. info->drm_format = supported_formats[i].drm_format;
  432. if (!capabilities_queried)
  433. continue;
  434. size_t n_modifiers;
  435. uint64_t *modifiers = NULL;
  436. if (gs_query_dmabuf_modifiers_for_format(
  437. supported_formats[i].drm_format, &modifiers,
  438. &n_modifiers)) {
  439. da_push_back_array(info->modifiers, modifiers,
  440. n_modifiers);
  441. }
  442. bfree(modifiers);
  443. if (dmabuf_flags &
  444. GS_DMABUF_FLAG_IMPLICIT_MODIFIERS_SUPPORTED) {
  445. uint64_t modifier_implicit = DRM_FORMAT_MOD_INVALID;
  446. da_push_back(info->modifiers, &modifier_implicit);
  447. }
  448. }
  449. obs_leave_graphics();
  450. bfree(drm_formats);
  451. }
  452. static void clear_format_info(obs_pipewire_data *obs_pw)
  453. {
  454. for (size_t i = 0; i < obs_pw->format_info.num; i++) {
  455. da_free(obs_pw->format_info.array[i].modifiers);
  456. }
  457. da_free(obs_pw->format_info);
  458. }
  459. static void remove_modifier_from_format(obs_pipewire_data *obs_pw,
  460. uint32_t spa_format, uint64_t modifier)
  461. {
  462. for (size_t i = 0; i < obs_pw->format_info.num; i++) {
  463. if (obs_pw->format_info.array[i].spa_format != spa_format)
  464. continue;
  465. if (!check_pw_version(&obs_pw->server_version, 0, 3, 40)) {
  466. da_erase_range(
  467. obs_pw->format_info.array[i].modifiers, 0,
  468. obs_pw->format_info.array[i].modifiers.num - 1);
  469. continue;
  470. }
  471. int idx = da_find(obs_pw->format_info.array[i].modifiers,
  472. &modifier, 0);
  473. while (idx != -1) {
  474. da_erase(obs_pw->format_info.array[i].modifiers, idx);
  475. idx = da_find(obs_pw->format_info.array[i].modifiers,
  476. &modifier, 0);
  477. }
  478. }
  479. }
  480. static void renegotiate_format(void *data, uint64_t expirations)
  481. {
  482. UNUSED_PARAMETER(expirations);
  483. obs_pipewire_data *obs_pw = (obs_pipewire_data *)data;
  484. const struct spa_pod **params = NULL;
  485. blog(LOG_DEBUG, "[pipewire] Renegotiating stream ...");
  486. pw_thread_loop_lock(obs_pw->thread_loop);
  487. uint8_t params_buffer[2048];
  488. struct spa_pod_builder pod_builder =
  489. SPA_POD_BUILDER_INIT(params_buffer, sizeof(params_buffer));
  490. uint32_t n_params;
  491. if (!build_format_params(obs_pw, &pod_builder, &params, &n_params)) {
  492. teardown_pipewire(obs_pw);
  493. pw_thread_loop_unlock(obs_pw->thread_loop);
  494. return;
  495. }
  496. pw_stream_update_params(obs_pw->stream, params, n_params);
  497. pw_thread_loop_unlock(obs_pw->thread_loop);
  498. bfree(params);
  499. }
  500. /* ------------------------------------------------- */
  501. static void on_process_cb(void *user_data)
  502. {
  503. obs_pipewire_data *obs_pw = user_data;
  504. struct spa_meta_cursor *cursor;
  505. uint32_t drm_format;
  506. struct spa_meta_region *region;
  507. struct spa_buffer *buffer;
  508. struct pw_buffer *b;
  509. bool swap_red_blue = false;
  510. bool has_buffer;
  511. /* Find the most recent buffer */
  512. b = NULL;
  513. while (true) {
  514. struct pw_buffer *aux =
  515. pw_stream_dequeue_buffer(obs_pw->stream);
  516. if (!aux)
  517. break;
  518. if (b)
  519. pw_stream_queue_buffer(obs_pw->stream, b);
  520. b = aux;
  521. }
  522. if (!b) {
  523. blog(LOG_DEBUG, "[pipewire] Out of buffers!");
  524. return;
  525. }
  526. buffer = b->buffer;
  527. has_buffer = buffer->datas[0].chunk->size != 0;
  528. obs_enter_graphics();
  529. if (!has_buffer)
  530. goto read_metadata;
  531. if (buffer->datas[0].type == SPA_DATA_DmaBuf) {
  532. uint32_t planes = buffer->n_datas;
  533. uint32_t offsets[planes];
  534. uint32_t strides[planes];
  535. uint64_t modifiers[planes];
  536. int fds[planes];
  537. bool use_modifiers;
  538. blog(LOG_DEBUG,
  539. "[pipewire] DMA-BUF info: fd:%ld, stride:%d, offset:%u, size:%dx%d",
  540. buffer->datas[0].fd, buffer->datas[0].chunk->stride,
  541. buffer->datas[0].chunk->offset,
  542. obs_pw->format.info.raw.size.width,
  543. obs_pw->format.info.raw.size.height);
  544. if (!lookup_format_info_from_spa_format(
  545. obs_pw->format.info.raw.format, &drm_format, NULL,
  546. NULL)) {
  547. blog(LOG_ERROR,
  548. "[pipewire] unsupported DMA buffer format: %d",
  549. obs_pw->format.info.raw.format);
  550. goto read_metadata;
  551. }
  552. for (uint32_t plane = 0; plane < planes; plane++) {
  553. fds[plane] = buffer->datas[plane].fd;
  554. offsets[plane] = buffer->datas[plane].chunk->offset;
  555. strides[plane] = buffer->datas[plane].chunk->stride;
  556. modifiers[plane] = obs_pw->format.info.raw.modifier;
  557. }
  558. g_clear_pointer(&obs_pw->texture, gs_texture_destroy);
  559. use_modifiers = obs_pw->format.info.raw.modifier !=
  560. DRM_FORMAT_MOD_INVALID;
  561. obs_pw->texture = gs_texture_create_from_dmabuf(
  562. obs_pw->format.info.raw.size.width,
  563. obs_pw->format.info.raw.size.height, drm_format,
  564. GS_BGRX, planes, fds, strides, offsets,
  565. use_modifiers ? modifiers : NULL);
  566. if (obs_pw->texture == NULL) {
  567. remove_modifier_from_format(
  568. obs_pw, obs_pw->format.info.raw.format,
  569. obs_pw->format.info.raw.modifier);
  570. pw_loop_signal_event(
  571. pw_thread_loop_get_loop(obs_pw->thread_loop),
  572. obs_pw->reneg);
  573. }
  574. } else {
  575. blog(LOG_DEBUG, "[pipewire] Buffer has memory texture");
  576. enum gs_color_format gs_format;
  577. if (!lookup_format_info_from_spa_format(
  578. obs_pw->format.info.raw.format, NULL, &gs_format,
  579. &swap_red_blue)) {
  580. blog(LOG_ERROR,
  581. "[pipewire] unsupported DMA buffer format: %d",
  582. obs_pw->format.info.raw.format);
  583. goto read_metadata;
  584. }
  585. g_clear_pointer(&obs_pw->texture, gs_texture_destroy);
  586. obs_pw->texture = gs_texture_create(
  587. obs_pw->format.info.raw.size.width,
  588. obs_pw->format.info.raw.size.height, gs_format, 1,
  589. (const uint8_t **)&buffer->datas[0].data, GS_DYNAMIC);
  590. }
  591. if (swap_red_blue)
  592. swap_texture_red_blue(obs_pw->texture);
  593. /* Video Crop */
  594. region = spa_buffer_find_meta_data(buffer, SPA_META_VideoCrop,
  595. sizeof(*region));
  596. if (region && spa_meta_region_is_valid(region)) {
  597. blog(LOG_DEBUG,
  598. "[pipewire] Crop Region available (%dx%d+%d+%d)",
  599. region->region.position.x, region->region.position.y,
  600. region->region.size.width, region->region.size.height);
  601. obs_pw->crop.x = region->region.position.x;
  602. obs_pw->crop.y = region->region.position.y;
  603. obs_pw->crop.width = region->region.size.width;
  604. obs_pw->crop.height = region->region.size.height;
  605. obs_pw->crop.valid = true;
  606. } else {
  607. obs_pw->crop.valid = false;
  608. }
  609. read_metadata:
  610. /* Cursor */
  611. cursor = spa_buffer_find_meta_data(buffer, SPA_META_Cursor,
  612. sizeof(*cursor));
  613. obs_pw->cursor.valid = cursor && spa_meta_cursor_is_valid(cursor);
  614. if (obs_pw->cursor.visible && obs_pw->cursor.valid) {
  615. struct spa_meta_bitmap *bitmap = NULL;
  616. enum gs_color_format gs_format;
  617. if (cursor->bitmap_offset)
  618. bitmap = SPA_MEMBER(cursor, cursor->bitmap_offset,
  619. struct spa_meta_bitmap);
  620. if (bitmap && bitmap->size.width > 0 &&
  621. bitmap->size.height > 0 &&
  622. lookup_format_info_from_spa_format(
  623. bitmap->format, NULL, &gs_format, &swap_red_blue)) {
  624. const uint8_t *bitmap_data;
  625. bitmap_data =
  626. SPA_MEMBER(bitmap, bitmap->offset, uint8_t);
  627. obs_pw->cursor.hotspot_x = cursor->hotspot.x;
  628. obs_pw->cursor.hotspot_y = cursor->hotspot.y;
  629. obs_pw->cursor.width = bitmap->size.width;
  630. obs_pw->cursor.height = bitmap->size.height;
  631. g_clear_pointer(&obs_pw->cursor.texture,
  632. gs_texture_destroy);
  633. obs_pw->cursor.texture = gs_texture_create(
  634. obs_pw->cursor.width, obs_pw->cursor.height,
  635. gs_format, 1, &bitmap_data, GS_DYNAMIC);
  636. if (swap_red_blue)
  637. swap_texture_red_blue(obs_pw->cursor.texture);
  638. }
  639. obs_pw->cursor.x = cursor->position.x;
  640. obs_pw->cursor.y = cursor->position.y;
  641. }
  642. pw_stream_queue_buffer(obs_pw->stream, b);
  643. obs_leave_graphics();
  644. }
  645. static void on_param_changed_cb(void *user_data, uint32_t id,
  646. const struct spa_pod *param)
  647. {
  648. obs_pipewire_data *obs_pw = user_data;
  649. struct spa_pod_builder pod_builder;
  650. const struct spa_pod *params[3];
  651. uint32_t buffer_types;
  652. uint8_t params_buffer[1024];
  653. int result;
  654. if (!param || id != SPA_PARAM_Format)
  655. return;
  656. result = spa_format_parse(param, &obs_pw->format.media_type,
  657. &obs_pw->format.media_subtype);
  658. if (result < 0)
  659. return;
  660. if (obs_pw->format.media_type != SPA_MEDIA_TYPE_video ||
  661. obs_pw->format.media_subtype != SPA_MEDIA_SUBTYPE_raw)
  662. return;
  663. spa_format_video_raw_parse(param, &obs_pw->format.info.raw);
  664. buffer_types = 1 << SPA_DATA_MemPtr;
  665. bool has_modifier =
  666. spa_pod_find_prop(param, NULL, SPA_FORMAT_VIDEO_modifier) !=
  667. NULL;
  668. if (has_modifier || check_pw_version(&obs_pw->server_version, 0, 3, 24))
  669. buffer_types |= 1 << SPA_DATA_DmaBuf;
  670. blog(LOG_DEBUG, "[pipewire] Negotiated format:");
  671. blog(LOG_DEBUG, "[pipewire] Format: %d (%s)",
  672. obs_pw->format.info.raw.format,
  673. spa_debug_type_find_name(spa_type_video_format,
  674. obs_pw->format.info.raw.format));
  675. blog(LOG_DEBUG, "[pipewire] Size: %dx%d",
  676. obs_pw->format.info.raw.size.width,
  677. obs_pw->format.info.raw.size.height);
  678. blog(LOG_DEBUG, "[pipewire] Framerate: %d/%d",
  679. obs_pw->format.info.raw.framerate.num,
  680. obs_pw->format.info.raw.framerate.denom);
  681. /* Video crop */
  682. pod_builder =
  683. SPA_POD_BUILDER_INIT(params_buffer, sizeof(params_buffer));
  684. params[0] = spa_pod_builder_add_object(
  685. &pod_builder, SPA_TYPE_OBJECT_ParamMeta, SPA_PARAM_Meta,
  686. SPA_PARAM_META_type, SPA_POD_Id(SPA_META_VideoCrop),
  687. SPA_PARAM_META_size,
  688. SPA_POD_Int(sizeof(struct spa_meta_region)));
  689. /* Cursor */
  690. params[1] = spa_pod_builder_add_object(
  691. &pod_builder, SPA_TYPE_OBJECT_ParamMeta, SPA_PARAM_Meta,
  692. SPA_PARAM_META_type, SPA_POD_Id(SPA_META_Cursor),
  693. SPA_PARAM_META_size,
  694. SPA_POD_CHOICE_RANGE_Int(CURSOR_META_SIZE(64, 64),
  695. CURSOR_META_SIZE(1, 1),
  696. CURSOR_META_SIZE(1024, 1024)));
  697. /* Buffer options */
  698. params[2] = spa_pod_builder_add_object(
  699. &pod_builder, SPA_TYPE_OBJECT_ParamBuffers, SPA_PARAM_Buffers,
  700. SPA_PARAM_BUFFERS_dataType, SPA_POD_Int(buffer_types));
  701. pw_stream_update_params(obs_pw->stream, params, 3);
  702. obs_pw->negotiated = true;
  703. }
  704. static void on_state_changed_cb(void *user_data, enum pw_stream_state old,
  705. enum pw_stream_state state, const char *error)
  706. {
  707. UNUSED_PARAMETER(old);
  708. UNUSED_PARAMETER(error);
  709. obs_pipewire_data *obs_pw = user_data;
  710. blog(LOG_DEBUG, "[pipewire] stream %p state: \"%s\" (error: %s)",
  711. obs_pw->stream, pw_stream_state_as_string(state),
  712. error ? error : "none");
  713. }
  714. static const struct pw_stream_events stream_events = {
  715. PW_VERSION_STREAM_EVENTS,
  716. .state_changed = on_state_changed_cb,
  717. .param_changed = on_param_changed_cb,
  718. .process = on_process_cb,
  719. };
  720. static void on_core_info_cb(void *user_data, const struct pw_core_info *info)
  721. {
  722. obs_pipewire_data *obs_pw = user_data;
  723. update_pw_versions(obs_pw, info->version);
  724. }
  725. static void on_core_error_cb(void *user_data, uint32_t id, int seq, int res,
  726. const char *message)
  727. {
  728. UNUSED_PARAMETER(seq);
  729. obs_pipewire_data *obs_pw = user_data;
  730. blog(LOG_ERROR, "[pipewire] Error id:%u seq:%d res:%d (%s): %s", id,
  731. seq, res, g_strerror(res), message);
  732. pw_thread_loop_signal(obs_pw->thread_loop, FALSE);
  733. }
  734. static void on_core_done_cb(void *user_data, uint32_t id, int seq)
  735. {
  736. obs_pipewire_data *obs_pw = user_data;
  737. if (id == PW_ID_CORE && obs_pw->server_version_sync == seq)
  738. pw_thread_loop_signal(obs_pw->thread_loop, FALSE);
  739. }
  740. static const struct pw_core_events core_events = {
  741. PW_VERSION_CORE_EVENTS,
  742. .info = on_core_info_cb,
  743. .done = on_core_done_cb,
  744. .error = on_core_error_cb,
  745. };
  746. static void play_pipewire_stream(obs_pipewire_data *obs_pw)
  747. {
  748. struct spa_pod_builder pod_builder;
  749. const struct spa_pod **params = NULL;
  750. uint32_t n_params;
  751. uint8_t params_buffer[2048];
  752. obs_pw->thread_loop = pw_thread_loop_new("PipeWire thread loop", NULL);
  753. obs_pw->context = pw_context_new(
  754. pw_thread_loop_get_loop(obs_pw->thread_loop), NULL, 0);
  755. if (pw_thread_loop_start(obs_pw->thread_loop) < 0) {
  756. blog(LOG_WARNING, "Error starting threaded mainloop");
  757. return;
  758. }
  759. pw_thread_loop_lock(obs_pw->thread_loop);
  760. /* Core */
  761. obs_pw->core = pw_context_connect_fd(
  762. obs_pw->context, fcntl(obs_pw->pipewire_fd, F_DUPFD_CLOEXEC, 5),
  763. NULL, 0);
  764. if (!obs_pw->core) {
  765. blog(LOG_WARNING, "Error creating PipeWire core: %m");
  766. pw_thread_loop_unlock(obs_pw->thread_loop);
  767. return;
  768. }
  769. pw_core_add_listener(obs_pw->core, &obs_pw->core_listener, &core_events,
  770. obs_pw);
  771. /* Signal to renegotiate */
  772. obs_pw->reneg =
  773. pw_loop_add_event(pw_thread_loop_get_loop(obs_pw->thread_loop),
  774. renegotiate_format, obs_pw);
  775. blog(LOG_DEBUG, "[pipewire] registered event %p", obs_pw->reneg);
  776. // Dispatch to receive the info core event
  777. obs_pw->server_version_sync = pw_core_sync(obs_pw->core, PW_ID_CORE,
  778. obs_pw->server_version_sync);
  779. pw_thread_loop_wait(obs_pw->thread_loop);
  780. /* Stream */
  781. obs_pw->stream = pw_stream_new(
  782. obs_pw->core, "OBS Studio",
  783. pw_properties_new(PW_KEY_MEDIA_TYPE, "Video",
  784. PW_KEY_MEDIA_CATEGORY, "Capture",
  785. PW_KEY_MEDIA_ROLE, "Screen", NULL));
  786. pw_stream_add_listener(obs_pw->stream, &obs_pw->stream_listener,
  787. &stream_events, obs_pw);
  788. blog(LOG_INFO, "[pipewire] created stream %p", obs_pw->stream);
  789. /* Stream parameters */
  790. pod_builder =
  791. SPA_POD_BUILDER_INIT(params_buffer, sizeof(params_buffer));
  792. obs_get_video_info(&obs_pw->video_info);
  793. if (!build_format_params(obs_pw, &pod_builder, &params, &n_params)) {
  794. pw_thread_loop_unlock(obs_pw->thread_loop);
  795. teardown_pipewire(obs_pw);
  796. return;
  797. }
  798. pw_stream_connect(
  799. obs_pw->stream, PW_DIRECTION_INPUT, obs_pw->pipewire_node,
  800. PW_STREAM_FLAG_AUTOCONNECT | PW_STREAM_FLAG_MAP_BUFFERS, params,
  801. n_params);
  802. blog(LOG_INFO, "[pipewire] playing stream…");
  803. pw_thread_loop_unlock(obs_pw->thread_loop);
  804. bfree(params);
  805. }
  806. /* ------------------------------------------------- */
  807. static void on_pipewire_remote_opened_cb(GObject *source, GAsyncResult *res,
  808. void *user_data)
  809. {
  810. g_autoptr(GUnixFDList) fd_list = NULL;
  811. g_autoptr(GVariant) result = NULL;
  812. g_autoptr(GError) error = NULL;
  813. obs_pipewire_data *obs_pw = user_data;
  814. int fd_index;
  815. result = g_dbus_proxy_call_with_unix_fd_list_finish(
  816. G_DBUS_PROXY(source), &fd_list, res, &error);
  817. if (error) {
  818. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  819. blog(LOG_ERROR,
  820. "[pipewire] Error retrieving pipewire fd: %s",
  821. error->message);
  822. return;
  823. }
  824. g_variant_get(result, "(h)", &fd_index, &error);
  825. obs_pw->pipewire_fd = g_unix_fd_list_get(fd_list, fd_index, &error);
  826. if (error) {
  827. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  828. blog(LOG_ERROR,
  829. "[pipewire] Error retrieving pipewire fd: %s",
  830. error->message);
  831. return;
  832. }
  833. play_pipewire_stream(obs_pw);
  834. }
  835. static void open_pipewire_remote(obs_pipewire_data *obs_pw)
  836. {
  837. GVariantBuilder builder;
  838. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  839. g_dbus_proxy_call_with_unix_fd_list(
  840. portal_get_dbus_proxy(), "OpenPipeWireRemote",
  841. g_variant_new("(oa{sv})", obs_pw->session_handle, &builder),
  842. G_DBUS_CALL_FLAGS_NONE, -1, NULL, obs_pw->cancellable,
  843. on_pipewire_remote_opened_cb, obs_pw);
  844. }
  845. /* ------------------------------------------------- */
  846. static void on_start_response_received_cb(GDBusConnection *connection,
  847. const char *sender_name,
  848. const char *object_path,
  849. const char *interface_name,
  850. const char *signal_name,
  851. GVariant *parameters, void *user_data)
  852. {
  853. UNUSED_PARAMETER(connection);
  854. UNUSED_PARAMETER(sender_name);
  855. UNUSED_PARAMETER(object_path);
  856. UNUSED_PARAMETER(interface_name);
  857. UNUSED_PARAMETER(signal_name);
  858. g_autoptr(GVariant) stream_properties = NULL;
  859. g_autoptr(GVariant) streams = NULL;
  860. g_autoptr(GVariant) result = NULL;
  861. struct dbus_call_data *call = user_data;
  862. obs_pipewire_data *obs_pw = call->obs_pw;
  863. GVariantIter iter;
  864. uint32_t response;
  865. size_t n_streams;
  866. g_clear_pointer(&call, dbus_call_data_free);
  867. g_variant_get(parameters, "(u@a{sv})", &response, &result);
  868. if (response != 0) {
  869. blog(LOG_WARNING,
  870. "[pipewire] Failed to start screencast, denied or cancelled by user");
  871. return;
  872. }
  873. streams =
  874. g_variant_lookup_value(result, "streams", G_VARIANT_TYPE_ARRAY);
  875. g_variant_iter_init(&iter, streams);
  876. n_streams = g_variant_iter_n_children(&iter);
  877. if (n_streams != 1) {
  878. blog(LOG_WARNING,
  879. "[pipewire] Received more than one stream when only one was expected. "
  880. "This is probably a bug in the desktop portal implementation you are "
  881. "using.");
  882. // The KDE Desktop portal implementation sometimes sends an invalid
  883. // response where more than one stream is attached, and only the
  884. // last one is the one we're looking for. This is the only known
  885. // buggy implementation, so let's at least try to make it work here.
  886. for (size_t i = 0; i < n_streams - 1; i++) {
  887. g_autoptr(GVariant) throwaway_properties = NULL;
  888. uint32_t throwaway_pipewire_node;
  889. g_variant_iter_loop(&iter, "(u@a{sv})",
  890. &throwaway_pipewire_node,
  891. &throwaway_properties);
  892. }
  893. }
  894. g_variant_iter_loop(&iter, "(u@a{sv})", &obs_pw->pipewire_node,
  895. &stream_properties);
  896. if (portal_get_screencast_version() >= 4) {
  897. g_autoptr(GVariant) restore_token = NULL;
  898. g_clear_pointer(&obs_pw->restore_token, bfree);
  899. restore_token = g_variant_lookup_value(result, "restore_token",
  900. G_VARIANT_TYPE_STRING);
  901. if (restore_token)
  902. obs_pw->restore_token = bstrdup(
  903. g_variant_get_string(restore_token, NULL));
  904. obs_source_save(obs_pw->source);
  905. }
  906. blog(LOG_INFO, "[pipewire] %s selected, setting up screencast",
  907. capture_type_to_string(obs_pw->capture_type));
  908. open_pipewire_remote(obs_pw);
  909. }
  910. static void on_started_cb(GObject *source, GAsyncResult *res, void *user_data)
  911. {
  912. UNUSED_PARAMETER(user_data);
  913. g_autoptr(GVariant) result = NULL;
  914. g_autoptr(GError) error = NULL;
  915. result = g_dbus_proxy_call_finish(G_DBUS_PROXY(source), res, &error);
  916. if (error) {
  917. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  918. blog(LOG_ERROR,
  919. "[pipewire] Error selecting screencast source: %s",
  920. error->message);
  921. return;
  922. }
  923. }
  924. static void start(obs_pipewire_data *obs_pw)
  925. {
  926. GVariantBuilder builder;
  927. struct dbus_call_data *call;
  928. char *request_token;
  929. char *request_path;
  930. new_request_path(obs_pw, &request_path, &request_token);
  931. blog(LOG_INFO, "[pipewire] asking for %s…",
  932. capture_type_to_string(obs_pw->capture_type));
  933. call = subscribe_to_signal(obs_pw, request_path,
  934. on_start_response_received_cb);
  935. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  936. g_variant_builder_add(&builder, "{sv}", "handle_token",
  937. g_variant_new_string(request_token));
  938. g_dbus_proxy_call(portal_get_dbus_proxy(), "Start",
  939. g_variant_new("(osa{sv})", obs_pw->session_handle, "",
  940. &builder),
  941. G_DBUS_CALL_FLAGS_NONE, -1, obs_pw->cancellable,
  942. on_started_cb, call);
  943. bfree(request_token);
  944. bfree(request_path);
  945. }
  946. /* ------------------------------------------------- */
  947. static void on_select_source_response_received_cb(
  948. GDBusConnection *connection, const char *sender_name,
  949. const char *object_path, const char *interface_name,
  950. const char *signal_name, GVariant *parameters, void *user_data)
  951. {
  952. UNUSED_PARAMETER(connection);
  953. UNUSED_PARAMETER(sender_name);
  954. UNUSED_PARAMETER(object_path);
  955. UNUSED_PARAMETER(interface_name);
  956. UNUSED_PARAMETER(signal_name);
  957. g_autoptr(GVariant) ret = NULL;
  958. struct dbus_call_data *call = user_data;
  959. obs_pipewire_data *obs_pw = call->obs_pw;
  960. uint32_t response;
  961. blog(LOG_DEBUG, "[pipewire] Response to select source received");
  962. g_clear_pointer(&call, dbus_call_data_free);
  963. g_variant_get(parameters, "(u@a{sv})", &response, &ret);
  964. if (response != 0) {
  965. blog(LOG_WARNING,
  966. "[pipewire] Failed to select source, denied or cancelled by user");
  967. return;
  968. }
  969. start(obs_pw);
  970. }
  971. static void on_source_selected_cb(GObject *source, GAsyncResult *res,
  972. void *user_data)
  973. {
  974. UNUSED_PARAMETER(user_data);
  975. g_autoptr(GVariant) result = NULL;
  976. g_autoptr(GError) error = NULL;
  977. result = g_dbus_proxy_call_finish(G_DBUS_PROXY(source), res, &error);
  978. if (error) {
  979. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  980. blog(LOG_ERROR,
  981. "[pipewire] Error selecting screencast source: %s",
  982. error->message);
  983. return;
  984. }
  985. }
  986. static void select_source(obs_pipewire_data *obs_pw)
  987. {
  988. struct dbus_call_data *call;
  989. GVariantBuilder builder;
  990. char *request_token;
  991. char *request_path;
  992. new_request_path(obs_pw, &request_path, &request_token);
  993. call = subscribe_to_signal(obs_pw, request_path,
  994. on_select_source_response_received_cb);
  995. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  996. g_variant_builder_add(&builder, "{sv}", "types",
  997. g_variant_new_uint32(obs_pw->capture_type));
  998. g_variant_builder_add(&builder, "{sv}", "multiple",
  999. g_variant_new_boolean(FALSE));
  1000. g_variant_builder_add(&builder, "{sv}", "handle_token",
  1001. g_variant_new_string(request_token));
  1002. if (obs_pw->available_cursor_modes & 4)
  1003. g_variant_builder_add(&builder, "{sv}", "cursor_mode",
  1004. g_variant_new_uint32(4));
  1005. else if ((obs_pw->available_cursor_modes & 2) && obs_pw->cursor.visible)
  1006. g_variant_builder_add(&builder, "{sv}", "cursor_mode",
  1007. g_variant_new_uint32(2));
  1008. else
  1009. g_variant_builder_add(&builder, "{sv}", "cursor_mode",
  1010. g_variant_new_uint32(1));
  1011. if (portal_get_screencast_version() >= 4) {
  1012. g_variant_builder_add(&builder, "{sv}", "persist_mode",
  1013. g_variant_new_uint32(2));
  1014. if (obs_pw->restore_token && *obs_pw->restore_token) {
  1015. g_variant_builder_add(
  1016. &builder, "{sv}", "restore_token",
  1017. g_variant_new_string(obs_pw->restore_token));
  1018. }
  1019. }
  1020. g_dbus_proxy_call(portal_get_dbus_proxy(), "SelectSources",
  1021. g_variant_new("(oa{sv})", obs_pw->session_handle,
  1022. &builder),
  1023. G_DBUS_CALL_FLAGS_NONE, -1, obs_pw->cancellable,
  1024. on_source_selected_cb, call);
  1025. bfree(request_token);
  1026. bfree(request_path);
  1027. }
  1028. /* ------------------------------------------------- */
  1029. static void on_create_session_response_received_cb(
  1030. GDBusConnection *connection, const char *sender_name,
  1031. const char *object_path, const char *interface_name,
  1032. const char *signal_name, GVariant *parameters, void *user_data)
  1033. {
  1034. UNUSED_PARAMETER(connection);
  1035. UNUSED_PARAMETER(sender_name);
  1036. UNUSED_PARAMETER(object_path);
  1037. UNUSED_PARAMETER(interface_name);
  1038. UNUSED_PARAMETER(signal_name);
  1039. g_autoptr(GVariant) session_handle_variant = NULL;
  1040. g_autoptr(GVariant) result = NULL;
  1041. struct dbus_call_data *call = user_data;
  1042. obs_pipewire_data *obs_pw = call->obs_pw;
  1043. uint32_t response;
  1044. g_clear_pointer(&call, dbus_call_data_free);
  1045. g_variant_get(parameters, "(u@a{sv})", &response, &result);
  1046. if (response != 0) {
  1047. blog(LOG_WARNING,
  1048. "[pipewire] Failed to create session, denied or cancelled by user");
  1049. return;
  1050. }
  1051. blog(LOG_INFO, "[pipewire] screencast session created");
  1052. session_handle_variant =
  1053. g_variant_lookup_value(result, "session_handle", NULL);
  1054. obs_pw->session_handle =
  1055. g_variant_dup_string(session_handle_variant, NULL);
  1056. select_source(obs_pw);
  1057. }
  1058. static void on_session_created_cb(GObject *source, GAsyncResult *res,
  1059. void *user_data)
  1060. {
  1061. UNUSED_PARAMETER(user_data);
  1062. g_autoptr(GVariant) result = NULL;
  1063. g_autoptr(GError) error = NULL;
  1064. result = g_dbus_proxy_call_finish(G_DBUS_PROXY(source), res, &error);
  1065. if (error) {
  1066. if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
  1067. blog(LOG_ERROR,
  1068. "[pipewire] Error creating screencast session: %s",
  1069. error->message);
  1070. return;
  1071. }
  1072. }
  1073. static void create_session(obs_pipewire_data *obs_pw)
  1074. {
  1075. struct dbus_call_data *call;
  1076. GVariantBuilder builder;
  1077. char *session_token;
  1078. char *request_token;
  1079. char *request_path;
  1080. new_request_path(obs_pw, &request_path, &request_token);
  1081. new_session_path(obs_pw, NULL, &session_token);
  1082. call = subscribe_to_signal(obs_pw, request_path,
  1083. on_create_session_response_received_cb);
  1084. g_variant_builder_init(&builder, G_VARIANT_TYPE_VARDICT);
  1085. g_variant_builder_add(&builder, "{sv}", "handle_token",
  1086. g_variant_new_string(request_token));
  1087. g_variant_builder_add(&builder, "{sv}", "session_handle_token",
  1088. g_variant_new_string(session_token));
  1089. g_dbus_proxy_call(portal_get_dbus_proxy(), "CreateSession",
  1090. g_variant_new("(a{sv})", &builder),
  1091. G_DBUS_CALL_FLAGS_NONE, -1, obs_pw->cancellable,
  1092. on_session_created_cb, call);
  1093. bfree(session_token);
  1094. bfree(request_token);
  1095. bfree(request_path);
  1096. }
  1097. /* ------------------------------------------------- */
  1098. static void update_available_cursor_modes(obs_pipewire_data *obs_pw,
  1099. GDBusProxy *proxy)
  1100. {
  1101. g_autoptr(GVariant) cached_cursor_modes = NULL;
  1102. uint32_t available_cursor_modes;
  1103. cached_cursor_modes =
  1104. g_dbus_proxy_get_cached_property(proxy, "AvailableCursorModes");
  1105. available_cursor_modes =
  1106. cached_cursor_modes ? g_variant_get_uint32(cached_cursor_modes)
  1107. : 0;
  1108. obs_pw->available_cursor_modes = available_cursor_modes;
  1109. blog(LOG_INFO, "[pipewire] available cursor modes:");
  1110. if (available_cursor_modes & 4)
  1111. blog(LOG_INFO, "[pipewire] - Metadata");
  1112. if (available_cursor_modes & 2)
  1113. blog(LOG_INFO, "[pipewire] - Always visible");
  1114. if (available_cursor_modes & 1)
  1115. blog(LOG_INFO, "[pipewire] - Hidden");
  1116. }
  1117. /* ------------------------------------------------- */
  1118. static gboolean init_obs_pipewire(obs_pipewire_data *obs_pw)
  1119. {
  1120. GDBusConnection *connection;
  1121. GDBusProxy *proxy;
  1122. char *aux;
  1123. obs_pw->cancellable = g_cancellable_new();
  1124. connection = portal_get_dbus_connection();
  1125. if (!connection)
  1126. return FALSE;
  1127. proxy = portal_get_dbus_proxy();
  1128. if (!proxy)
  1129. return FALSE;
  1130. update_available_cursor_modes(obs_pw, proxy);
  1131. obs_pw->sender_name =
  1132. bstrdup(g_dbus_connection_get_unique_name(connection) + 1);
  1133. /* Replace dots by underscores */
  1134. while ((aux = strstr(obs_pw->sender_name, ".")) != NULL)
  1135. *aux = '_';
  1136. blog(LOG_INFO, "PipeWire initialized (sender name: %s)",
  1137. obs_pw->sender_name);
  1138. create_session(obs_pw);
  1139. return TRUE;
  1140. }
  1141. static bool reload_session_cb(obs_properties_t *properties,
  1142. obs_property_t *property, void *data)
  1143. {
  1144. UNUSED_PARAMETER(properties);
  1145. UNUSED_PARAMETER(property);
  1146. obs_pipewire_data *obs_pw = data;
  1147. g_clear_pointer(&obs_pw->restore_token, bfree);
  1148. teardown_pipewire(obs_pw);
  1149. destroy_session(obs_pw);
  1150. init_obs_pipewire(obs_pw);
  1151. return false;
  1152. }
  1153. /* obs_source_info methods */
  1154. void *obs_pipewire_create(enum obs_pw_capture_type capture_type,
  1155. obs_data_t *settings, obs_source_t *source)
  1156. {
  1157. obs_pipewire_data *obs_pw = bzalloc(sizeof(obs_pipewire_data));
  1158. obs_pw->source = source;
  1159. obs_pw->settings = settings;
  1160. obs_pw->capture_type = capture_type;
  1161. obs_pw->cursor.visible = obs_data_get_bool(settings, "ShowCursor");
  1162. obs_pw->restore_token =
  1163. bstrdup(obs_data_get_string(settings, "RestoreToken"));
  1164. if (!init_obs_pipewire(obs_pw))
  1165. g_clear_pointer(&obs_pw, bfree);
  1166. init_format_info(obs_pw);
  1167. return obs_pw;
  1168. }
  1169. void obs_pipewire_destroy(obs_pipewire_data *obs_pw)
  1170. {
  1171. if (!obs_pw)
  1172. return;
  1173. teardown_pipewire(obs_pw);
  1174. destroy_session(obs_pw);
  1175. g_clear_pointer(&obs_pw->restore_token, bfree);
  1176. clear_format_info(obs_pw);
  1177. bfree(obs_pw);
  1178. }
  1179. void obs_pipewire_save(obs_pipewire_data *obs_pw, obs_data_t *settings)
  1180. {
  1181. obs_data_set_string(settings, "RestoreToken", obs_pw->restore_token);
  1182. }
  1183. void obs_pipewire_get_defaults(obs_data_t *settings)
  1184. {
  1185. obs_data_set_default_bool(settings, "ShowCursor", true);
  1186. obs_data_set_default_string(settings, "RestoreToken", NULL);
  1187. }
  1188. obs_properties_t *obs_pipewire_get_properties(obs_pipewire_data *obs_pw,
  1189. const char *reload_string_id)
  1190. {
  1191. obs_properties_t *properties;
  1192. properties = obs_properties_create();
  1193. obs_properties_add_button2(properties, "Reload",
  1194. obs_module_text(reload_string_id),
  1195. reload_session_cb, obs_pw);
  1196. obs_properties_add_bool(properties, "ShowCursor",
  1197. obs_module_text("ShowCursor"));
  1198. return properties;
  1199. }
  1200. void obs_pipewire_update(obs_pipewire_data *obs_pw, obs_data_t *settings)
  1201. {
  1202. obs_pw->cursor.visible = obs_data_get_bool(settings, "ShowCursor");
  1203. }
  1204. void obs_pipewire_show(obs_pipewire_data *obs_pw)
  1205. {
  1206. if (obs_pw->stream)
  1207. pw_stream_set_active(obs_pw->stream, true);
  1208. }
  1209. void obs_pipewire_hide(obs_pipewire_data *obs_pw)
  1210. {
  1211. if (obs_pw->stream)
  1212. pw_stream_set_active(obs_pw->stream, false);
  1213. }
  1214. uint32_t obs_pipewire_get_width(obs_pipewire_data *obs_pw)
  1215. {
  1216. if (!obs_pw->negotiated)
  1217. return 0;
  1218. if (obs_pw->crop.valid)
  1219. return obs_pw->crop.width;
  1220. else
  1221. return obs_pw->format.info.raw.size.width;
  1222. }
  1223. uint32_t obs_pipewire_get_height(obs_pipewire_data *obs_pw)
  1224. {
  1225. if (!obs_pw->negotiated)
  1226. return 0;
  1227. if (obs_pw->crop.valid)
  1228. return obs_pw->crop.height;
  1229. else
  1230. return obs_pw->format.info.raw.size.height;
  1231. }
  1232. void obs_pipewire_video_render(obs_pipewire_data *obs_pw, gs_effect_t *effect)
  1233. {
  1234. gs_eparam_t *image;
  1235. if (!obs_pw->texture)
  1236. return;
  1237. image = gs_effect_get_param_by_name(effect, "image");
  1238. gs_effect_set_texture(image, obs_pw->texture);
  1239. if (has_effective_crop(obs_pw)) {
  1240. gs_draw_sprite_subregion(obs_pw->texture, 0, obs_pw->crop.x,
  1241. obs_pw->crop.y, obs_pw->crop.width,
  1242. obs_pw->crop.height);
  1243. } else {
  1244. gs_draw_sprite(obs_pw->texture, 0, 0, 0);
  1245. }
  1246. if (obs_pw->cursor.visible && obs_pw->cursor.valid &&
  1247. obs_pw->cursor.texture) {
  1248. float cursor_x = obs_pw->cursor.x - obs_pw->cursor.hotspot_x;
  1249. float cursor_y = obs_pw->cursor.y - obs_pw->cursor.hotspot_y;
  1250. gs_matrix_push();
  1251. gs_matrix_translate3f(cursor_x, cursor_y, 0.0f);
  1252. gs_effect_set_texture(image, obs_pw->cursor.texture);
  1253. gs_draw_sprite(obs_pw->texture, 0, obs_pw->cursor.width,
  1254. obs_pw->cursor.height);
  1255. gs_matrix_pop();
  1256. }
  1257. }
  1258. enum obs_pw_capture_type
  1259. obs_pipewire_get_capture_type(obs_pipewire_data *obs_pw)
  1260. {
  1261. return obs_pw->capture_type;
  1262. }