obs-studio/plugins/linux-capture/xcompcap-helper.cpp

455 lines
7.3 KiB
C++
Raw Normal View History

2014-04-28 17:59:53 -07:00
#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include <X11/Xutil.h>
#include <X11/extensions/Xcomposite.h>
#include <unordered_set>
#include <pthread.h>
#include <obs-module.h>
#include "xcompcap-helper.hpp"
2014-04-28 17:59:53 -07:00
namespace XCompcap
{
static Display* xdisplay = 0;
Display *disp()
{
if (!xdisplay)
2014-04-28 17:59:53 -07:00
xdisplay = XOpenDisplay(NULL);
return xdisplay;
}
void cleanupDisplay()
{
if (!xdisplay)
2014-04-28 17:59:53 -07:00
return;
XCloseDisplay(xdisplay);
xdisplay = 0;
}
static void getAllWindows(Window parent, std::list<Window>& windows)
{
UNUSED_PARAMETER(parent);
UNUSED_PARAMETER(windows);
}
std::list<Window> getAllWindows()
{
std::list<Window> res;
for (int i = 0; i < ScreenCount(disp()); ++i)
2014-04-28 17:59:53 -07:00
getAllWindows(RootWindow(disp(), i), res);
return res;
}
// Specification for checking for ewmh support at
// http://standards.freedesktop.org/wm-spec/wm-spec-latest.html#idm140200472693600
bool ewmhIsSupported()
{
Display *display = disp();
Atom netSupportingWmCheck = XInternAtom(display,
"_NET_SUPPORTING_WM_CHECK", true);
Atom actualType;
int format = 0;
unsigned long num = 0, bytes = 0;
unsigned char *data = NULL;
Window ewmh_window = 0;
int status = XGetWindowProperty(
display,
DefaultRootWindow(display),
netSupportingWmCheck,
0L,
1L,
false,
XA_WINDOW,
&actualType,
&format,
&num,
&bytes,
&data);
if (status == Success) {
if (num > 0) {
ewmh_window = ((Window*)data)[0];
}
if (data) {
XFree(data);
data = NULL;
}
}
if (ewmh_window) {
status = XGetWindowProperty(
display,
ewmh_window,
netSupportingWmCheck,
0L,
1L,
false,
XA_WINDOW,
&actualType,
&format,
&num,
&bytes,
&data);
if (status != Success || num == 0 ||
ewmh_window != ((Window*)data)[0]) {
ewmh_window = 0;
}
if (status == Success && data) {
XFree(data);
}
}
return ewmh_window != 0;
}
2014-04-28 17:59:53 -07:00
std::list<Window> getTopLevelWindows()
{
std::list<Window> res;
if (!ewmhIsSupported()) {
blog(LOG_WARNING, "Unable to query window list "
"because window manager "
"does not support extended "
"window manager Hints");
return res;
}
Atom netClList = XInternAtom(disp(), "_NET_CLIENT_LIST", true);
2014-04-28 17:59:53 -07:00
Atom actualType;
int format;
unsigned long num, bytes;
Window* data = 0;
for (int i = 0; i < ScreenCount(disp()); ++i) {
2014-04-28 17:59:53 -07:00
Window rootWin = RootWindow(disp(), i);
int status = XGetWindowProperty(
disp(),
rootWin,
netClList,
0L,
~0L,
false,
AnyPropertyType,
&actualType,
&format,
&num,
&bytes,
(uint8_t**)&data);
if (status != Success) {
blog(LOG_WARNING, "Failed getting root "
"window properties");
2014-04-28 17:59:53 -07:00
continue;
}
for (unsigned long i = 0; i < num; ++i)
2014-04-28 17:59:53 -07:00
res.push_back(data[i]);
XFree(data);
}
return res;
}
int getRootWindowScreen(Window root)
{
XWindowAttributes attr;
if (!XGetWindowAttributes(disp(), root, &attr))
2014-04-28 17:59:53 -07:00
return DefaultScreen(disp());
return XScreenNumberOfScreen(attr.screen);
}
std::string getWindowName(Window win)
{
Atom netWmName = XInternAtom(disp(), "_NET_WM_NAME", false);
int n;
char **list = 0;
XTextProperty tp;
std::string res = "unknown";
XGetTextProperty(disp(), win, &tp, netWmName);
if (!tp.nitems)
2014-04-28 17:59:53 -07:00
XGetWMName(disp(), win, &tp);
if (!tp.nitems)
2014-04-28 17:59:53 -07:00
return "error";
if (tp.encoding == XA_STRING) {
2014-04-28 17:59:53 -07:00
res = (char*)tp.value;
} else {
int ret = XmbTextPropertyToTextList(disp(), &tp, &list,
&n);
if (ret >= Success && n > 0 && *list) {
res = *list;
XFreeStringList(list);
}
2014-04-28 17:59:53 -07:00
}
XFree(tp.value);
return res;
}
std::string getWindowCommand(Window win)
{
Atom xi = XInternAtom(disp(), "WM_COMMAND", false);
int n;
char **list = 0;
XTextProperty tp;
std::string res = "error";
XGetTextProperty(disp(), win, &tp, xi);
if (!tp.nitems)
2014-04-28 17:59:53 -07:00
return std::string();
if (tp.encoding == XA_STRING) {
2014-04-28 17:59:53 -07:00
res = (char*)tp.value;
} else {
int ret = XmbTextPropertyToTextList(disp(), &tp, &list,
&n);
if (ret >= Success && n > 0 && *list) {
res = *list;
XFreeStringList(list);
}
2014-04-28 17:59:53 -07:00
}
XFree(tp.value);
return res;
}
int getWindowPid(Window win)
{
UNUSED_PARAMETER(win);
return 1234; //TODO
}
static std::unordered_set<Window> changedWindows;
static pthread_mutex_t changeLock = PTHREAD_MUTEX_INITIALIZER;
void processEvents()
{
PLock lock(&changeLock);
XLockDisplay(disp());
while (XEventsQueued(disp(), QueuedAfterReading) > 0) {
2014-04-28 17:59:53 -07:00
XEvent ev;
XNextEvent(disp(), &ev);
if (ev.type == ConfigureNotify)
2014-04-28 17:59:53 -07:00
changedWindows.insert(ev.xconfigure.event);
if (ev.type == MapNotify)
2014-04-28 17:59:53 -07:00
changedWindows.insert(ev.xmap.event);
if (ev.type == Expose)
changedWindows.insert(ev.xexpose.window);
if (ev.type == DestroyNotify)
2014-04-28 17:59:53 -07:00
changedWindows.insert(ev.xdestroywindow.event);
}
XUnlockDisplay(disp());
}
bool windowWasReconfigured(Window win)
{
PLock lock(&changeLock);
auto it = changedWindows.find(win);
if (it != changedWindows.end()) {
2014-04-28 17:59:53 -07:00
changedWindows.erase(it);
return true;
}
return false;
}
}
PLock::PLock(pthread_mutex_t* mtx, bool trylock)
:m(mtx)
{
if (trylock)
2014-04-28 17:59:53 -07:00
islock = mtx && pthread_mutex_trylock(mtx) == 0;
else
islock = mtx && pthread_mutex_lock(mtx) == 0;
}
PLock::~PLock()
{
if (islock) {
2014-04-28 17:59:53 -07:00
pthread_mutex_unlock(m);
}
}
bool PLock::isLocked()
{
return islock;
}
void PLock::unlock()
{
if (islock) {
2014-04-28 17:59:53 -07:00
pthread_mutex_unlock(m);
islock = false;
}
}
void PLock::lock()
{
if (!islock) {
2014-04-28 17:59:53 -07:00
pthread_mutex_lock(m);
islock = true;
}
}
static bool* curErrorTarget = 0;
static char curErrorText[200];
static int xerrorlock_handler(Display* disp, XErrorEvent* err)
{
if (curErrorTarget)
2014-04-28 17:59:53 -07:00
*curErrorTarget = true;
XGetErrorText(disp, err->error_code, curErrorText, 200);
return 0;
}
XErrorLock::XErrorLock()
{
goterr = false;
islock = false;
prevhandler = 0;
lock();
}
XErrorLock::~XErrorLock()
{
unlock();
}
bool XErrorLock::isLocked()
{
return islock;
}
void XErrorLock::lock()
{
if (!islock) {
2014-04-28 17:59:53 -07:00
XLockDisplay(XCompcap::disp());
XSync(XCompcap::disp(), 0);
curErrorTarget = &goterr;
curErrorText[0] = 0;
prevhandler = XSetErrorHandler(xerrorlock_handler);
islock = true;
}
}
void XErrorLock::unlock()
{
if (islock) {
XSync(XCompcap::disp(), 0);
2014-04-28 17:59:53 -07:00
curErrorTarget = 0;
XSetErrorHandler(prevhandler);
prevhandler = 0;
XUnlockDisplay(XCompcap::disp());
islock = false;
}
}
bool XErrorLock::gotError()
{
if (!islock)
2014-04-28 17:59:53 -07:00
return false;
XSync(XCompcap::disp(), 0);
bool res = goterr;
goterr = false;
return res;
}
std::string XErrorLock::getErrorText()
{
return curErrorText;
}
void XErrorLock::resetError()
{
if (islock)
2014-04-28 17:59:53 -07:00
XSync(XCompcap::disp(), 0);
goterr = false;
curErrorText[0] = 0;
}
linux-capture: Fix window capture crashes The xcomposite window capture crashes were due to a few factors: ------------------------------- 1.) The source's X error handler was possibly being overwritten by another part of the program despite us locking the display, presumably something in Qt which isn't locking the display when pushing/popping its own error handler (though this is not yet certain). The source's calls to X functions happen in the graphics thread, which is separate from the UI thread, and it was noticed that somehow the error handler would be overwritten almost seemingly at random, indicating that something else in the program outside of OBS code was not locking the display while pushing/popping the error handler. To replicate this, make it so that the source cannot find the target window and so it continually searches for it each video_tick call, then resize the main OBS window continually (which causes Qt to push/pop its own error handlers). A crash will almost always occur due to BadWindow despite our error handling. 2.) Calling X functions with a window ID that no longer exists, particularly XGetWindowAttributes, in conjunction the unknown error handler set in case #1 would cause the program to outright crash because that error handler is programmed to crash on BadWindow for whatever reason. The source would call X functions without even checking if 'win' was 0. 3.) The source stored window IDs (in JSON, even if they've long since become invalid/pointless, such as system restarts). This is a bad practice and will result in more cases of BadWindow. Fixing the problem (reducing the possibility of getting BadWindow): ------------------------------- Step 1.) Deprecate and ignore window IDs in stored settings. Instead of using window IDs to find the window, we now must always search the windows and find the target window via the window name exclusively. This helps ensure that we actually consistently have a working window ID. Step 2.) Do not call any X functions if the window ID is 0. Step 3.) Reset the window ID to 0 any time the window has updated, and make the source find the window again to ensure it still exists before attempting to use any X functions on the window ID again.
2016-06-04 14:20:41 -07:00
XDisplayLock::XDisplayLock()
{
islock = false;
lock();
}
XDisplayLock::~XDisplayLock()
{
unlock();
}
bool XDisplayLock::isLocked()
{
return islock;
}
void XDisplayLock::lock()
{
if (!islock) {
XLockDisplay(XCompcap::disp());
islock = true;
}
}
void XDisplayLock::unlock()
{
if (islock) {
XSync(XCompcap::disp(), 0);
XUnlockDisplay(XCompcap::disp());
islock = false;
}
}
2014-04-28 17:59:53 -07:00
ObsGsContextHolder::ObsGsContextHolder()
{
obs_enter_graphics();
2014-04-28 17:59:53 -07:00
}
ObsGsContextHolder::~ObsGsContextHolder()
{
obs_leave_graphics();
2014-04-28 17:59:53 -07:00
}