2014-02-13 22:05:23 +01:00
|
|
|
/*
|
|
|
|
|
Copyright (C) 2014 by Leonhard Oelke <leonhard@in-verted.de>
|
|
|
|
|
|
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
|
the Free Software Foundation, either version 2 of the License, or
|
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
*/
|
2014-02-10 19:09:44 +01:00
|
|
|
#include <obs-module.h>
|
2020-04-09 04:58:43 +02:00
|
|
|
#include <obs-nix-platform.h>
|
2014-02-09 13:50:15 +01:00
|
|
|
|
linux-capture: Add PipeWire-based capture
Add a new Linux capture based on PipeWire [1] and the Desktop portal [2].
This new capture starts by asking the Desktop portal for a screencapture session.
There are quite a few D-Bus calls involved in this, but the key points are:
1. A connection to org.freedesktop.portal.ScreenCast is estabilished, and the
available cursor modes are updated.
2. CreateSession() is called. This is the first step of the negotiation.
3. SelectSources() is called. This is when a system dialog pops up asking the
user to either select a monitor (desktop capture) or a window (window capture).
4. Start() is called. This signals the compositor that it can setup a PipeWire
stream, and start sending buffers.
The reply to this fourth call gives OBS Studio the PipeWire fd, and the id of the
PipeWire node where the buffers are being sent to. This allows creating a consumer
PipeWire stream, and receive the buffers.
Metadata cursor is always preferred, but on the lack of it, we ask the stream for
an embedded cursor (i.e. the cursor is drawn at the buffer, and OBS Studio has no
control over it.)
Window capturing is implemented as a crop operation on the buffer. Compositors
can send big buffers, and a crop rectangle, and this is used to paint a subregion
of the buffer in the scene.
The new capture is only loaded when running on EGL, since it depends on EGL to
call gs_texture_create_from_dmabuf().
[1] https://pipewire.org/
[2] https://github.com/flatpak/xdg-desktop-portal/
2021-02-25 20:57:33 +01:00
|
|
|
#ifdef ENABLE_PIPEWIRE
|
|
|
|
|
#include "pipewire-capture.h"
|
|
|
|
|
#endif
|
|
|
|
|
|
2014-02-10 19:09:44 +01:00
|
|
|
OBS_DECLARE_MODULE()
|
2014-07-10 07:12:57 +02:00
|
|
|
OBS_MODULE_USE_DEFAULT_LOCALE("linux-xshm", "en-US")
|
2018-09-11 10:51:38 +02:00
|
|
|
MODULE_EXPORT const char *obs_module_description(void)
|
|
|
|
|
{
|
2021-03-23 16:56:54 +01:00
|
|
|
#ifdef ENABLE_PIPEWIRE
|
|
|
|
|
if (obs_get_nix_platform() != OBS_NIX_PLATFORM_X11_GLX)
|
|
|
|
|
return "PipeWire based window/screen capture for X11 and Wayland";
|
|
|
|
|
else
|
|
|
|
|
#endif
|
|
|
|
|
return "xcomposite/xshm based window/screen capture for X11";
|
2018-09-11 10:51:38 +02:00
|
|
|
}
|
2014-02-09 13:50:15 +01:00
|
|
|
|
2014-02-10 19:09:44 +01:00
|
|
|
extern struct obs_source_info xshm_input;
|
2014-02-09 13:50:15 +01:00
|
|
|
|
2014-08-30 02:05:32 +02:00
|
|
|
extern void xcomposite_load(void);
|
|
|
|
|
extern void xcomposite_unload(void);
|
|
|
|
|
|
2014-07-27 21:42:43 +02:00
|
|
|
bool obs_module_load(void)
|
2014-02-09 13:50:15 +01:00
|
|
|
{
|
linux-capture: Add PipeWire-based capture
Add a new Linux capture based on PipeWire [1] and the Desktop portal [2].
This new capture starts by asking the Desktop portal for a screencapture session.
There are quite a few D-Bus calls involved in this, but the key points are:
1. A connection to org.freedesktop.portal.ScreenCast is estabilished, and the
available cursor modes are updated.
2. CreateSession() is called. This is the first step of the negotiation.
3. SelectSources() is called. This is when a system dialog pops up asking the
user to either select a monitor (desktop capture) or a window (window capture).
4. Start() is called. This signals the compositor that it can setup a PipeWire
stream, and start sending buffers.
The reply to this fourth call gives OBS Studio the PipeWire fd, and the id of the
PipeWire node where the buffers are being sent to. This allows creating a consumer
PipeWire stream, and receive the buffers.
Metadata cursor is always preferred, but on the lack of it, we ask the stream for
an embedded cursor (i.e. the cursor is drawn at the buffer, and OBS Studio has no
control over it.)
Window capturing is implemented as a crop operation on the buffer. Compositors
can send big buffers, and a crop rectangle, and this is used to paint a subregion
of the buffer in the scene.
The new capture is only loaded when running on EGL, since it depends on EGL to
call gs_texture_create_from_dmabuf().
[1] https://pipewire.org/
[2] https://github.com/flatpak/xdg-desktop-portal/
2021-02-25 20:57:33 +01:00
|
|
|
if (obs_get_nix_platform() == OBS_NIX_PLATFORM_X11_GLX) {
|
|
|
|
|
obs_register_source(&xshm_input);
|
|
|
|
|
xcomposite_load();
|
|
|
|
|
#ifdef ENABLE_PIPEWIRE
|
|
|
|
|
} else {
|
|
|
|
|
pipewire_capture_load();
|
|
|
|
|
#endif
|
2020-04-09 04:58:43 +02:00
|
|
|
}
|
|
|
|
|
|
2014-02-20 19:41:04 +01:00
|
|
|
return true;
|
2014-02-09 13:50:15 +01:00
|
|
|
}
|
2014-08-30 02:05:32 +02:00
|
|
|
|
|
|
|
|
void obs_module_unload(void)
|
|
|
|
|
{
|
linux-capture: Add PipeWire-based capture
Add a new Linux capture based on PipeWire [1] and the Desktop portal [2].
This new capture starts by asking the Desktop portal for a screencapture session.
There are quite a few D-Bus calls involved in this, but the key points are:
1. A connection to org.freedesktop.portal.ScreenCast is estabilished, and the
available cursor modes are updated.
2. CreateSession() is called. This is the first step of the negotiation.
3. SelectSources() is called. This is when a system dialog pops up asking the
user to either select a monitor (desktop capture) or a window (window capture).
4. Start() is called. This signals the compositor that it can setup a PipeWire
stream, and start sending buffers.
The reply to this fourth call gives OBS Studio the PipeWire fd, and the id of the
PipeWire node where the buffers are being sent to. This allows creating a consumer
PipeWire stream, and receive the buffers.
Metadata cursor is always preferred, but on the lack of it, we ask the stream for
an embedded cursor (i.e. the cursor is drawn at the buffer, and OBS Studio has no
control over it.)
Window capturing is implemented as a crop operation on the buffer. Compositors
can send big buffers, and a crop rectangle, and this is used to paint a subregion
of the buffer in the scene.
The new capture is only loaded when running on EGL, since it depends on EGL to
call gs_texture_create_from_dmabuf().
[1] https://pipewire.org/
[2] https://github.com/flatpak/xdg-desktop-portal/
2021-02-25 20:57:33 +01:00
|
|
|
if (obs_get_nix_platform() == OBS_NIX_PLATFORM_X11_GLX)
|
|
|
|
|
xcomposite_unload();
|
|
|
|
|
#ifdef ENABLE_PIPEWIRE
|
|
|
|
|
else
|
|
|
|
|
pipewire_capture_unload();
|
|
|
|
|
#endif
|
2014-08-30 02:05:32 +02:00
|
|
|
}
|