mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
This change fixes an issue where opening multiple OpenGLContexts on certain versions of macOS (observed on 10.13) could cause a deadlock. The issue can be reproduced by: - Attaching an OpenGL context to the AudioPluginDemo editor - Opening multiple copies of the editor simultaneously in a plugin host. I tested with Live 10. I also observed the issue in a standalone app that opened new windows containing OpenGLContexts on a timer.
345 lines
12 KiB
C++
345 lines
12 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2022 - Raw Material Software Limited
|
|
|
|
JUCE is an open source library subject to commercial or open-source
|
|
licensing.
|
|
|
|
By using JUCE, you agree to the terms of both the JUCE 7 End-User License
|
|
Agreement and JUCE Privacy Policy.
|
|
|
|
End User License Agreement: www.juce.com/juce-7-licence
|
|
Privacy Policy: www.juce.com/juce-privacy-policy
|
|
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
|
www.gnu.org/licenses).
|
|
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
|
DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
extern XContext windowHandleXContext;
|
|
|
|
struct XFreeDeleter
|
|
{
|
|
void operator() (void* ptr) const
|
|
{
|
|
if (ptr != nullptr)
|
|
X11Symbols::getInstance()->xFree (ptr);
|
|
}
|
|
};
|
|
|
|
template <typename Data>
|
|
std::unique_ptr<Data, XFreeDeleter> makeXFreePtr (Data* raw) { return std::unique_ptr<Data, XFreeDeleter> (raw); }
|
|
|
|
//==============================================================================
|
|
// Defined juce_linux_Windowing.cpp
|
|
void juce_LinuxAddRepaintListener (ComponentPeer*, Component* dummy);
|
|
void juce_LinuxRemoveRepaintListener (ComponentPeer*, Component* dummy);
|
|
|
|
//==============================================================================
|
|
class OpenGLContext::NativeContext
|
|
{
|
|
private:
|
|
struct DummyComponent : public Component
|
|
{
|
|
DummyComponent (OpenGLContext::NativeContext& nativeParentContext)
|
|
: native (nativeParentContext)
|
|
{
|
|
}
|
|
|
|
void handleCommandMessage (int commandId) override
|
|
{
|
|
if (commandId == 0)
|
|
native.triggerRepaint();
|
|
}
|
|
|
|
OpenGLContext::NativeContext& native;
|
|
};
|
|
|
|
public:
|
|
NativeContext (Component& comp,
|
|
const OpenGLPixelFormat& cPixelFormat,
|
|
void* shareContext,
|
|
bool useMultisamplingIn,
|
|
OpenGLVersion)
|
|
: component (comp), contextToShareWith (shareContext), dummy (*this)
|
|
{
|
|
display = XWindowSystem::getInstance()->getDisplay();
|
|
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
|
|
X11Symbols::getInstance()->xSync (display, False);
|
|
|
|
const std::vector<GLint> optionalAttribs
|
|
{
|
|
GLX_SAMPLE_BUFFERS, useMultisamplingIn ? 1 : 0,
|
|
GLX_SAMPLES, cPixelFormat.multisamplingLevel
|
|
};
|
|
|
|
if (! tryChooseVisual (cPixelFormat, optionalAttribs) && ! tryChooseVisual (cPixelFormat, {}))
|
|
return;
|
|
|
|
auto* peer = component.getPeer();
|
|
jassert (peer != nullptr);
|
|
|
|
auto windowH = (Window) peer->getNativeHandle();
|
|
auto visual = glXGetVisualFromFBConfig (display, *bestConfig);
|
|
auto colourMap = X11Symbols::getInstance()->xCreateColormap (display, windowH, visual->visual, AllocNone);
|
|
|
|
XSetWindowAttributes swa;
|
|
swa.colormap = colourMap;
|
|
swa.border_pixel = 0;
|
|
swa.event_mask = embeddedWindowEventMask;
|
|
|
|
auto glBounds = component.getTopLevelComponent()->getLocalArea (&component, component.getLocalBounds());
|
|
|
|
glBounds = Desktop::getInstance().getDisplays().logicalToPhysical (glBounds);
|
|
|
|
embeddedWindow = X11Symbols::getInstance()->xCreateWindow (display, windowH,
|
|
glBounds.getX(), glBounds.getY(),
|
|
(unsigned int) jmax (1, glBounds.getWidth()),
|
|
(unsigned int) jmax (1, glBounds.getHeight()),
|
|
0, visual->depth,
|
|
InputOutput,
|
|
visual->visual,
|
|
CWBorderPixel | CWColormap | CWEventMask,
|
|
&swa);
|
|
|
|
X11Symbols::getInstance()->xSaveContext (display, (XID) embeddedWindow, windowHandleXContext, (XPointer) peer);
|
|
|
|
X11Symbols::getInstance()->xMapWindow (display, embeddedWindow);
|
|
X11Symbols::getInstance()->xFreeColormap (display, colourMap);
|
|
|
|
X11Symbols::getInstance()->xSync (display, False);
|
|
|
|
juce_LinuxAddRepaintListener (peer, &dummy);
|
|
}
|
|
|
|
~NativeContext()
|
|
{
|
|
if (auto* peer = component.getPeer())
|
|
{
|
|
juce_LinuxRemoveRepaintListener (peer, &dummy);
|
|
|
|
if (embeddedWindow != 0)
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
|
|
X11Symbols::getInstance()->xUnmapWindow (display, embeddedWindow);
|
|
X11Symbols::getInstance()->xDestroyWindow (display, embeddedWindow);
|
|
X11Symbols::getInstance()->xSync (display, False);
|
|
|
|
XEvent event;
|
|
while (X11Symbols::getInstance()->xCheckWindowEvent (display,
|
|
embeddedWindow,
|
|
embeddedWindowEventMask,
|
|
&event) == True)
|
|
{
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
bool initialiseOnRenderThread (OpenGLContext& c)
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
|
|
const auto components = [&]() -> Optional<Version>
|
|
{
|
|
switch (c.versionRequired)
|
|
{
|
|
case OpenGLVersion::openGL3_2: return Version { 3, 2 };
|
|
case OpenGLVersion::openGL4_1: return Version { 4, 1 };
|
|
case OpenGLVersion::openGL4_3: return Version { 4, 3 };
|
|
|
|
case OpenGLVersion::defaultGLVersion: break;
|
|
}
|
|
|
|
return {};
|
|
}();
|
|
|
|
if (components.hasValue())
|
|
{
|
|
using GLXCreateContextAttribsARB = GLXContext (*) (Display*, GLXFBConfig, GLXContext, Bool, const int*);
|
|
|
|
if (const auto glXCreateContextAttribsARB = (GLXCreateContextAttribsARB) OpenGLHelpers::getExtensionFunction ("glXCreateContextAttribsARB"))
|
|
{
|
|
#if JUCE_DEBUG
|
|
constexpr auto contextFlags = GLX_CONTEXT_DEBUG_BIT_ARB;
|
|
#else
|
|
constexpr auto contextFlags = 0;
|
|
#endif
|
|
|
|
const int attribs[]
|
|
{
|
|
GLX_CONTEXT_MAJOR_VERSION_ARB, components->major,
|
|
GLX_CONTEXT_MINOR_VERSION_ARB, components->minor,
|
|
GLX_CONTEXT_PROFILE_MASK_ARB, GLX_CONTEXT_CORE_PROFILE_BIT_ARB,
|
|
GLX_CONTEXT_FLAGS_ARB, contextFlags,
|
|
None
|
|
};
|
|
|
|
renderContext = glXCreateContextAttribsARB (display, *bestConfig, (GLXContext) contextToShareWith, GL_TRUE, attribs);
|
|
}
|
|
}
|
|
|
|
if (renderContext == nullptr)
|
|
renderContext = glXCreateNewContext (display, *bestConfig, GLX_RGBA_TYPE, (GLXContext) contextToShareWith, GL_TRUE);
|
|
|
|
if (renderContext == nullptr)
|
|
return false;
|
|
|
|
c.makeActive();
|
|
context = &c;
|
|
return true;
|
|
}
|
|
|
|
void shutdownOnRenderThread()
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
context = nullptr;
|
|
deactivateCurrentContext();
|
|
glXDestroyContext (display, renderContext);
|
|
renderContext = nullptr;
|
|
}
|
|
|
|
bool makeActive() const noexcept
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
return renderContext != nullptr
|
|
&& glXMakeCurrent (display, embeddedWindow, renderContext);
|
|
}
|
|
|
|
bool isActive() const noexcept
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
return glXGetCurrentContext() == renderContext && renderContext != nullptr;
|
|
}
|
|
|
|
static void deactivateCurrentContext()
|
|
{
|
|
if (auto* display = XWindowSystem::getInstance()->getDisplay())
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
glXMakeCurrent (display, None, nullptr);
|
|
}
|
|
}
|
|
|
|
void swapBuffers()
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
glXSwapBuffers (display, embeddedWindow);
|
|
}
|
|
|
|
void updateWindowPosition (Rectangle<int> newBounds)
|
|
{
|
|
bounds = newBounds;
|
|
auto physicalBounds = Desktop::getInstance().getDisplays().logicalToPhysical (bounds);
|
|
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
X11Symbols::getInstance()->xMoveResizeWindow (display, embeddedWindow,
|
|
physicalBounds.getX(), physicalBounds.getY(),
|
|
(unsigned int) jmax (1, physicalBounds.getWidth()),
|
|
(unsigned int) jmax (1, physicalBounds.getHeight()));
|
|
}
|
|
|
|
bool setSwapInterval (int numFramesPerSwap)
|
|
{
|
|
if (numFramesPerSwap == swapFrames)
|
|
return true;
|
|
|
|
if (auto GLXSwapIntervalSGI
|
|
= (PFNGLXSWAPINTERVALSGIPROC) OpenGLHelpers::getExtensionFunction ("glXSwapIntervalSGI"))
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
swapFrames = numFramesPerSwap;
|
|
GLXSwapIntervalSGI (numFramesPerSwap);
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
int getSwapInterval() const { return swapFrames; }
|
|
bool createdOk() const noexcept { return true; }
|
|
void* getRawContext() const noexcept { return renderContext; }
|
|
GLuint getFrameBufferID() const noexcept { return 0; }
|
|
|
|
void triggerRepaint()
|
|
{
|
|
if (context != nullptr)
|
|
context->triggerRepaint();
|
|
}
|
|
|
|
struct Locker
|
|
{
|
|
explicit Locker (NativeContext& ctx) : lock (ctx.mutex) {}
|
|
const ScopedLock lock;
|
|
};
|
|
|
|
private:
|
|
bool tryChooseVisual (const OpenGLPixelFormat& format, const std::vector<GLint>& optionalAttribs)
|
|
{
|
|
std::vector<GLint> allAttribs
|
|
{
|
|
GLX_RENDER_TYPE, GLX_RGBA_BIT,
|
|
GLX_DOUBLEBUFFER, True,
|
|
GLX_RED_SIZE, format.redBits,
|
|
GLX_GREEN_SIZE, format.greenBits,
|
|
GLX_BLUE_SIZE, format.blueBits,
|
|
GLX_ALPHA_SIZE, format.alphaBits,
|
|
GLX_DEPTH_SIZE, format.depthBufferBits,
|
|
GLX_STENCIL_SIZE, format.stencilBufferBits,
|
|
GLX_ACCUM_RED_SIZE, format.accumulationBufferRedBits,
|
|
GLX_ACCUM_GREEN_SIZE, format.accumulationBufferGreenBits,
|
|
GLX_ACCUM_BLUE_SIZE, format.accumulationBufferBlueBits,
|
|
GLX_ACCUM_ALPHA_SIZE, format.accumulationBufferAlphaBits
|
|
};
|
|
|
|
allAttribs.insert (allAttribs.end(), optionalAttribs.begin(), optionalAttribs.end());
|
|
|
|
allAttribs.push_back (None);
|
|
|
|
int nElements = 0;
|
|
bestConfig = makeXFreePtr (glXChooseFBConfig (display, X11Symbols::getInstance()->xDefaultScreen (display), allAttribs.data(), &nElements));
|
|
|
|
return nElements != 0 && bestConfig != nullptr;
|
|
}
|
|
|
|
static constexpr int embeddedWindowEventMask = ExposureMask | StructureNotifyMask;
|
|
|
|
CriticalSection mutex;
|
|
Component& component;
|
|
GLXContext renderContext = {};
|
|
Window embeddedWindow = {};
|
|
|
|
int swapFrames = 1;
|
|
Rectangle<int> bounds;
|
|
std::unique_ptr<GLXFBConfig, XFreeDeleter> bestConfig;
|
|
void* contextToShareWith;
|
|
|
|
OpenGLContext* context = nullptr;
|
|
DummyComponent dummy;
|
|
|
|
::Display* display = nullptr;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (NativeContext)
|
|
};
|
|
|
|
//==============================================================================
|
|
bool OpenGLHelpers::isContextActive()
|
|
{
|
|
XWindowSystemUtilities::ScopedXLock xLock;
|
|
return glXGetCurrentContext() != nullptr;
|
|
}
|
|
|
|
} // namespace juce
|