pipewire.c 42 KB

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