/* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*- * ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Initial Developer of the Original Code is Mozilla Foundation. * Portions created by the Initial Developer are Copyright (C) 2010 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Matt Woodrow * Bas Schouten * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifdef MOZ_WIDGET_GTK2 #include #include #define GET_NATIVE_WINDOW(aWidget) GDK_WINDOW_XID((GdkWindow *) aWidget->GetNativeData(NS_NATIVE_WINDOW)) #elif defined(MOZ_WIDGET_QT) #include #include #define GET_NATIVE_WINDOW(aWidget) static_cast(aWidget->GetNativeData(NS_NATIVE_SHELLWIDGET))->handle() #endif #include #include #include "mozilla/X11Util.h" #include "GLContextProvider.h" #include "nsDebug.h" #include "nsIWidget.h" #include "GLXLibrary.h" #include "gfxXlibSurface.h" #include "gfxContext.h" #include "gfxImageSurface.h" #include "gfxPlatform.h" #include "GLContext.h" namespace mozilla { namespace gl { static PRBool gIsATI = PR_FALSE; static PRBool gIsChromium = PR_FALSE; static int gGLXMajorVersion = 0, gGLXMinorVersion = 0; // Check that we have at least version aMajor.aMinor . static inline bool GLXVersionCheck(int aMajor, int aMinor) { return aMajor < gGLXMajorVersion || (aMajor == gGLXMajorVersion && aMinor <= gGLXMinorVersion); } static inline bool HasExtension(const char* aExtensions, const char* aRequiredExtension) { return GLContext::ListHasExtension( reinterpret_cast(aExtensions), aRequiredExtension); } PRBool GLXLibrary::EnsureInitialized() { if (mInitialized) { return PR_TRUE; } // Don't repeatedly try to initialize. if (mTriedInitializing) { return PR_FALSE; } mTriedInitializing = PR_TRUE; if (!mOGLLibrary) { mOGLLibrary = PR_LoadLibrary("libGL.so.1"); if (!mOGLLibrary) { NS_WARNING("Couldn't load OpenGL shared library."); return PR_FALSE; } } LibrarySymbolLoader::SymLoadStruct symbols[] = { /* functions that were in GLX 1.0 */ { (PRFuncPtr*) &xDestroyContext, { "glXDestroyContext", NULL } }, { (PRFuncPtr*) &xMakeCurrent, { "glXMakeCurrent", NULL } }, { (PRFuncPtr*) &xSwapBuffers, { "glXSwapBuffers", NULL } }, { (PRFuncPtr*) &xQueryVersion, { "glXQueryVersion", NULL } }, { (PRFuncPtr*) &xGetCurrentContext, { "glXGetCurrentContext", NULL } }, /* functions introduced in GLX 1.1 */ { (PRFuncPtr*) &xQueryExtensionsString, { "glXQueryExtensionsString", NULL } }, { (PRFuncPtr*) &xQueryServerString, { "glXQueryServerString", NULL } }, { NULL, { NULL } } }; LibrarySymbolLoader::SymLoadStruct symbols13[] = { /* functions introduced in GLX 1.3 */ { (PRFuncPtr*) &xChooseFBConfig, { "glXChooseFBConfig", NULL } }, { (PRFuncPtr*) &xGetFBConfigAttrib, { "glXGetFBConfigAttrib", NULL } }, // WARNING: xGetFBConfigs not set in symbols13_ext { (PRFuncPtr*) &xGetFBConfigs, { "glXGetFBConfigs", NULL } }, { (PRFuncPtr*) &xGetVisualFromFBConfig, { "glXGetVisualFromFBConfig", NULL } }, // WARNING: symbols13_ext sets xCreateGLXPixmapWithConfig instead { (PRFuncPtr*) &xCreatePixmap, { "glXCreatePixmap", NULL } }, { (PRFuncPtr*) &xDestroyPixmap, { "glXDestroyPixmap", NULL } }, { (PRFuncPtr*) &xCreateNewContext, { "glXCreateNewContext", NULL } }, { NULL, { NULL } } }; LibrarySymbolLoader::SymLoadStruct symbols13_ext[] = { /* extension equivalents for functions introduced in GLX 1.3 */ // GLX_SGIX_fbconfig extension { (PRFuncPtr*) &xChooseFBConfig, { "glXChooseFBConfigSGIX", NULL } }, { (PRFuncPtr*) &xGetFBConfigAttrib, { "glXGetFBConfigAttribSGIX", NULL } }, // WARNING: no xGetFBConfigs equivalent in extensions { (PRFuncPtr*) &xGetVisualFromFBConfig, { "glXGetVisualFromFBConfig", NULL } }, // WARNING: different from symbols13: { (PRFuncPtr*) &xCreateGLXPixmapWithConfig, { "glXCreateGLXPixmapWithConfigSGIX", NULL } }, { (PRFuncPtr*) &xDestroyPixmap, { "glXDestroyGLXPixmap", NULL } }, // not from ext { (PRFuncPtr*) &xCreateNewContext, { "glXCreateContextWithConfigSGIX", NULL } }, { NULL, { NULL } } }; LibrarySymbolLoader::SymLoadStruct symbols14[] = { /* functions introduced in GLX 1.4 */ { (PRFuncPtr*) &xGetProcAddress, { "glXGetProcAddress", NULL } }, { NULL, { NULL } } }; LibrarySymbolLoader::SymLoadStruct symbols14_ext[] = { /* extension equivalents for functions introduced in GLX 1.4 */ // GLX_ARB_get_proc_address extension { (PRFuncPtr*) &xGetProcAddress, { "glXGetProcAddressARB", NULL } }, { NULL, { NULL } } }; if (!LibrarySymbolLoader::LoadSymbols(mOGLLibrary, &symbols[0])) { NS_WARNING("Couldn't find required entry point in OpenGL shared library"); return PR_FALSE; } Display *display = DefaultXDisplay(); int screen = DefaultScreen(display); if (!xQueryVersion(display, &gGLXMajorVersion, &gGLXMinorVersion)) { gGLXMajorVersion = 0; gGLXMinorVersion = 0; return PR_FALSE; } const char *vendor = xQueryServerString(display, screen, GLX_VENDOR); const char *serverVersionStr = xQueryServerString(display, screen, GLX_VERSION); if (!GLXVersionCheck(1, 1)) // Not possible to query for extensions. return PR_FALSE; const char *extensionsStr = xQueryExtensionsString(display, screen); LibrarySymbolLoader::SymLoadStruct *sym13; if (!GLXVersionCheck(1, 3)) { // Even if we don't have 1.3, we might have equivalent extensions // (as on the Intel X server). if (!HasExtension(extensionsStr, "GLX_SGIX_fbconfig")) { return PR_FALSE; } sym13 = symbols13_ext; } else { sym13 = symbols13; } if (!LibrarySymbolLoader::LoadSymbols(mOGLLibrary, sym13)) { NS_WARNING("Couldn't find required entry point in OpenGL shared library"); return PR_FALSE; } LibrarySymbolLoader::SymLoadStruct *sym14; if (!GLXVersionCheck(1, 4)) { // Even if we don't have 1.4, we might have equivalent extensions // (as on the Intel X server). if (!HasExtension(extensionsStr, "GLX_ARB_get_proc_address")) { return PR_FALSE; } sym14 = symbols14_ext; } else { sym14 = symbols14; } if (!LibrarySymbolLoader::LoadSymbols(mOGLLibrary, sym14)) { NS_WARNING("Couldn't find required entry point in OpenGL shared library"); return PR_FALSE; } gIsATI = vendor && DoesVendorStringMatch(vendor, "ATI"); gIsChromium = (vendor && DoesVendorStringMatch(vendor, "Chromium")) || (serverVersionStr && DoesVendorStringMatch(serverVersionStr, "Chromium")); mInitialized = PR_TRUE; return PR_TRUE; } GLXLibrary sGLXLibrary; static bool ctxErrorOccurred = false; static int ctxErrorHandler(Display *dpy, XErrorEvent *ev) { ctxErrorOccurred = true; return 0; } class GLContextGLX : public GLContext { public: static already_AddRefed CreateGLContext(const ContextFormat& format, Display *display, GLXDrawable drawable, GLXFBConfig cfg, XVisualInfo *vinfo, GLContextGLX *shareContext, PRBool deleteDrawable, gfxXlibSurface *pixmap = nsnull) { int db = 0, err; err = sGLXLibrary.xGetFBConfigAttrib(display, cfg, GLX_DOUBLEBUFFER, &db); if (GLX_BAD_ATTRIBUTE != err) { #ifdef DEBUG printf("[GLX] FBConfig is %sdouble-buffered\n", db ? "" : "not "); #endif } ctxErrorOccurred = false; int (*oldHandler)(Display *, XErrorEvent *); GLXContext context; TRY_AGAIN_NO_SHARING: oldHandler = XSetErrorHandler(&ctxErrorHandler); context = sGLXLibrary.xCreateNewContext(display, cfg, GLX_RGBA_TYPE, shareContext ? shareContext->mContext : NULL, True); XSync(display, False); XSetErrorHandler(oldHandler); if (!context || ctxErrorOccurred) { if (shareContext) { shareContext = nsnull; goto TRY_AGAIN_NO_SHARING; } NS_WARNING("Failed to create GLXContext!"); return nsnull; } nsRefPtr glContext(new GLContextGLX(format, shareContext, display, drawable, context, deleteDrawable, db, pixmap)); if (!glContext->Init()) { return nsnull; } return glContext.forget(); } ~GLContextGLX() { MarkDestroyed(); sGLXLibrary.xDestroyContext(mDisplay, mContext); if (mDeleteDrawable) { sGLXLibrary.xDestroyPixmap(mDisplay, mDrawable); } } GLContextType GetContextType() { return ContextTypeGLX; } PRBool Init() { MakeCurrent(); SetupLookupFunction(); if (!InitWithPrefix("gl", PR_TRUE)) { return PR_FALSE; } return IsExtensionSupported("GL_EXT_framebuffer_object"); } PRBool MakeCurrentImpl(PRBool aForce = PR_FALSE) { PRBool succeeded = PR_TRUE; // With the ATI FGLRX driver, glxMakeCurrent is very slow even when the context doesn't change. // (This is not the case with other drivers such as NVIDIA). // So avoid calling it more than necessary. Since GLX documentation says that: // "glXGetCurrentContext returns client-side information. // It does not make a round trip to the server." // I assume that it's not worth using our own TLS slot here. if (aForce || sGLXLibrary.xGetCurrentContext() != mContext) { succeeded = sGLXLibrary.xMakeCurrent(mDisplay, mDrawable, mContext); NS_ASSERTION(succeeded, "Failed to make GL context current!"); } return succeeded; } PRBool SetupLookupFunction() { mLookupFunc = (PlatformLookupFunction)sGLXLibrary.xGetProcAddress; return PR_TRUE; } void *GetNativeData(NativeDataType aType) { switch(aType) { case NativeGLContext: return mContext; case NativeThebesSurface: return mPixmap; default: return nsnull; } } PRBool IsDoubleBuffered() { return mDoubleBuffered; } PRBool SwapBuffers() { if (!mDoubleBuffered) return PR_FALSE; sGLXLibrary.xSwapBuffers(mDisplay, mDrawable); return PR_TRUE; } virtual already_AddRefed CreateBasicTextureImage(GLuint aTexture, const nsIntSize& aSize, TextureImage::ContentType aContentType, GLContext* aContext); private: friend class GLContextProviderGLX; GLContextGLX(const ContextFormat& aFormat, GLContext *aShareContext, Display *aDisplay, GLXDrawable aDrawable, GLXContext aContext, PRBool aDeleteDrawable, PRBool aDoubleBuffered, gfxXlibSurface *aPixmap) : GLContext(aFormat, aDeleteDrawable ? PR_TRUE : PR_FALSE, aShareContext), mContext(aContext), mDisplay(aDisplay), mDrawable(aDrawable), mDeleteDrawable(aDeleteDrawable), mDoubleBuffered(aDoubleBuffered), mPixmap(aPixmap) { } GLXContext mContext; Display *mDisplay; GLXDrawable mDrawable; PRPackedBool mDeleteDrawable; PRPackedBool mDoubleBuffered; nsRefPtr mPixmap; }; // FIXME/bug 575505: this is a (very slow!) placeholder // implementation. Much better would be to create a Pixmap, wrap that // in a GLXPixmap, and then glXBindTexImage() to our texture. class TextureImageGLX : public BasicTextureImage { friend already_AddRefed GLContextGLX::CreateBasicTextureImage(GLuint, const nsIntSize&, TextureImage::ContentType, GLContext*); protected: virtual already_AddRefed CreateUpdateSurface(const gfxIntSize& aSize, ImageFormat aFmt) { mUpdateFormat = aFmt; return gfxPlatform::GetPlatform()->CreateOffscreenSurface(aSize, gfxASurface::ContentFromFormat(aFmt)); } virtual already_AddRefed GetImageForUpload(gfxASurface* aUpdateSurface) { nsRefPtr image = new gfxImageSurface(gfxIntSize(mUpdateRect.width, mUpdateRect.height), mUpdateFormat); nsRefPtr tmpContext = new gfxContext(image); tmpContext->SetSource(aUpdateSurface); tmpContext->SetOperator(gfxContext::OPERATOR_SOURCE); tmpContext->Paint(); return image.forget(); } private: TextureImageGLX(GLuint aTexture, const nsIntSize& aSize, ContentType aContentType, GLContext* aContext) : BasicTextureImage(aTexture, aSize, aContentType, aContext) {} ImageFormat mUpdateFormat; }; already_AddRefed GLContextGLX::CreateBasicTextureImage(GLuint aTexture, const nsIntSize& aSize, TextureImage::ContentType aContentType, GLContext* aContext) { nsRefPtr teximage( new TextureImageGLX(aTexture, aSize, aContentType, aContext)); return teximage.forget(); } static GLContextGLX * GetGlobalContextGLX() { return static_cast(GLContextProviderGLX::GetGlobalContext()); } static PRBool AreCompatibleVisuals(XVisualInfo *one, XVisualInfo *two) { if (one->c_class != two->c_class) { return PR_FALSE; } if (one->depth != two->depth) { return PR_FALSE; } if (one->red_mask != two->red_mask || one->green_mask != two->green_mask || one->blue_mask != two->blue_mask) { return PR_FALSE; } if (one->bits_per_rgb != two->bits_per_rgb) { return PR_FALSE; } return PR_TRUE; } already_AddRefed GLContextProviderGLX::CreateForWindow(nsIWidget *aWidget) { if (!sGLXLibrary.EnsureInitialized()) { return nsnull; } // Currently, we take whatever Visual the window already has, and // try to create an fbconfig for that visual. This isn't // necessarily what we want in the long run; an fbconfig may not // be available for the existing visual, or if it is, the GL // performance might be suboptimal. But using the existing visual // is a relatively safe intermediate step. Display *display = (Display*)aWidget->GetNativeData(NS_NATIVE_DISPLAY); int xscreen = DefaultScreen(display); Window window = GET_NATIVE_WINDOW(aWidget); int numConfigs; ScopedXFree cfgs; if (gIsATI || !GLXVersionCheck(1, 3)) { const int attribs[] = { GLX_DOUBLEBUFFER, False, 0 }; cfgs = sGLXLibrary.xChooseFBConfig(display, xscreen, attribs, &numConfigs); } else { cfgs = sGLXLibrary.xGetFBConfigs(display, xscreen, &numConfigs); } if (!cfgs) { NS_WARNING("[GLX] glXGetFBConfigs() failed"); return nsnull; } NS_ASSERTION(numConfigs > 0, "No FBConfigs found!"); // XXX the visual ID is almost certainly the GLX_FBCONFIG_ID, so // we could probably do this first and replace the glXGetFBConfigs // with glXChooseConfigs. Docs are sparklingly clear as always. XWindowAttributes widgetAttrs; if (!XGetWindowAttributes(display, window, &widgetAttrs)) { NS_WARNING("[GLX] XGetWindowAttributes() failed"); return nsnull; } const VisualID widgetVisualID = XVisualIDFromVisual(widgetAttrs.visual); #ifdef DEBUG printf("[GLX] widget has VisualID 0x%lx\n", widgetVisualID); #endif ScopedXFree vi; if (gIsATI) { XVisualInfo vinfo_template; int nvisuals; vinfo_template.visual = widgetAttrs.visual; vinfo_template.visualid = XVisualIDFromVisual(vinfo_template.visual); vinfo_template.depth = widgetAttrs.depth; vinfo_template.screen = xscreen; vi = XGetVisualInfo(display, VisualIDMask|VisualDepthMask|VisualScreenMask, &vinfo_template, &nvisuals); NS_ASSERTION(vi && nvisuals == 1, "Could not locate unique matching XVisualInfo for Visual"); } int matchIndex = -1; ScopedXFree vinfo; for (int i = 0; i < numConfigs; i++) { vinfo = sGLXLibrary.xGetVisualFromFBConfig(display, cfgs[i]); if (!vinfo) { continue; } if (gIsATI) { if (AreCompatibleVisuals(vi, vinfo)) { matchIndex = i; break; } } else { if (widgetVisualID == vinfo->visualid) { matchIndex = i; break; } } } if (matchIndex == -1) { NS_WARNING("[GLX] Couldn't find a FBConfig matching widget visual"); return nsnull; } GLContextGLX *shareContext = GetGlobalContextGLX(); nsRefPtr glContext = GLContextGLX::CreateGLContext(ContextFormat(ContextFormat::BasicRGB24), display, window, cfgs[matchIndex], vinfo, shareContext, PR_FALSE); return glContext.forget(); } static already_AddRefed CreateOffscreenPixmapContext(const gfxIntSize& aSize, const ContextFormat& aFormat, PRBool aShare) { if (!sGLXLibrary.EnsureInitialized()) { return nsnull; } Display *display = DefaultXDisplay(); int xscreen = DefaultScreen(display); int attribs[] = { GLX_DOUBLEBUFFER, False, GLX_DRAWABLE_TYPE, GLX_PIXMAP_BIT, GLX_X_RENDERABLE, True, GLX_RED_SIZE, 1, GLX_GREEN_SIZE, 1, GLX_BLUE_SIZE, 1, GLX_ALPHA_SIZE, 0, GLX_DEPTH_SIZE, 0, 0 }; int numConfigs = 0; ScopedXFree cfgs; cfgs = sGLXLibrary.xChooseFBConfig(display, xscreen, attribs, &numConfigs); if (!cfgs) { return nsnull; } NS_ASSERTION(numConfigs > 0, "glXChooseFBConfig() failed to match our requested format and violated its spec (!)"); ScopedXFree vinfo; int chosenIndex; for (int i = 0; i < numConfigs; ++i) { int dtype, visid; if (sGLXLibrary.xGetFBConfigAttrib(display, cfgs[i], GLX_DRAWABLE_TYPE, &dtype) != Success || !(dtype & GLX_PIXMAP_BIT)) { continue; } if (sGLXLibrary.xGetFBConfigAttrib(display, cfgs[i], GLX_VISUAL_ID, &visid) != Success || visid == 0) { continue; } vinfo = sGLXLibrary.xGetVisualFromFBConfig(display, cfgs[i]); if (vinfo) { chosenIndex = i; break; } } if (!vinfo) { NS_WARNING("glXChooseFBConfig() didn't give us any configs with visuals!"); return nsnull; } nsRefPtr xsurface = gfxXlibSurface::Create(DefaultScreenOfDisplay(display), vinfo->visual, gfxIntSize(16, 16)); if (xsurface->CairoStatus() != 0) { return nsnull; } GLXPixmap glxpixmap; // Handle slightly different signature between glXCreatePixmap and // its pre-GLX-1.3 extension equivalent (though given the ABI, we // might not need to). if (GLXVersionCheck(1, 3)) { glxpixmap = sGLXLibrary.xCreatePixmap(display, cfgs[chosenIndex], xsurface->XDrawable(), NULL); } else { glxpixmap = sGLXLibrary.xCreateGLXPixmapWithConfig(display, cfgs[chosenIndex], xsurface-> XDrawable()); } if (glxpixmap == 0) { return nsnull; } GLContextGLX *shareContext = aShare ? GetGlobalContextGLX() : nsnull; nsRefPtr glContext = GLContextGLX::CreateGLContext(aFormat, display, glxpixmap, cfgs[chosenIndex], vinfo, shareContext, PR_TRUE, xsurface); return glContext.forget(); } already_AddRefed GLContextProviderGLX::CreateOffscreen(const gfxIntSize& aSize, const ContextFormat& aFormat) { nsRefPtr glContext = CreateOffscreenPixmapContext(aSize, aFormat, PR_TRUE); if (!glContext) { return nsnull; } if (!glContext->GetSharedContext()) { // no point in returning anything if sharing failed, we can't // render from this return nsnull; } if (!glContext->ResizeOffscreenFBO(aSize)) { // we weren't able to create the initial // offscreen FBO, so this is dead return nsnull; } return glContext.forget(); } already_AddRefed GLContextProviderGLX::CreateForNativePixmapSurface(gfxASurface *aSurface) { if (!sGLXLibrary.EnsureInitialized()) { return nsnull; } if (aSurface->GetType() != gfxASurface::SurfaceTypeXlib) { NS_WARNING("GLContextProviderGLX::CreateForNativePixmapSurface called with non-Xlib surface"); return nsnull; } nsAutoTArray attribs; #define A1_(_x) do { attribs.AppendElement(_x); } while(0) #define A2_(_x,_y) do { \ attribs.AppendElement(_x); \ attribs.AppendElement(_y); \ } while(0) A2_(GLX_DOUBLEBUFFER, False); A2_(GLX_DRAWABLE_TYPE, GLX_PIXMAP_BIT); A1_(0); int numFormats; Display *display = DefaultXDisplay(); int xscreen = DefaultScreen(display); ScopedXFree cfg(sGLXLibrary.xChooseFBConfig(display, xscreen, attribs.Elements(), &numFormats)); if (!cfg) { return nsnull; } NS_ASSERTION(numFormats > 0, "glXChooseFBConfig() failed to match our requested format and violated its spec (!)"); gfxXlibSurface *xs = static_cast(aSurface); GLXPixmap glxpixmap = sGLXLibrary.xCreatePixmap(display, cfg[0], xs->XDrawable(), NULL); nsRefPtr glContext = GLContextGLX::CreateGLContext(ContextFormat(ContextFormat::BasicRGB24), display, glxpixmap, cfg[0], NULL, NULL, PR_FALSE, xs); return glContext.forget(); } static nsRefPtr gGlobalContext; GLContext * GLContextProviderGLX::GetGlobalContext() { static bool triedToCreateContext = false; if (!triedToCreateContext && !gGlobalContext) { triedToCreateContext = true; gGlobalContext = CreateOffscreenPixmapContext(gfxIntSize(1, 1), ContextFormat(ContextFormat::BasicRGB24), PR_FALSE); if (gGlobalContext) gGlobalContext->SetIsGlobalSharedContext(PR_TRUE); } return gGlobalContext; } void GLContextProviderGLX::Shutdown() { gGlobalContext = nsnull; } } /* namespace gl */ } /* namespace mozilla */