/* * Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * - Redistribution of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * - Redistribution in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of Sun Microsystems, Inc. or the names of * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * This software is provided "AS IS," without a warranty of any kind. ALL * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. * * You acknowledge that this software is not designed or intended for use * in the design, construction, operation or maintenance of any nuclear * facility. * * Sun gratefully acknowledges that this software was originally authored * and developed by Kenneth Bradley Russell and Christopher John Kline. */ package net.java.games.jogl.impl.x11; import java.awt.Component; import java.security.*; import java.util.*; import net.java.games.gluegen.runtime.*; // for PROCADDRESS_VAR_PREFIX import net.java.games.jogl.*; import net.java.games.jogl.impl.*; public abstract class X11GLContext extends GLContextImpl { protected long display; protected long drawable; protected long visualID; protected long context; private boolean glXQueryExtensionsStringInitialized; private boolean glXQueryExtensionsStringAvailable; private static final Map/**/ functionNameMap; private boolean isGLX13; // Table that holds the addresses of the native C-language entry points for // OpenGL functions. private GLProcAddressTable glProcAddressTable; private static boolean haveResetGLXProcAddressTable; // Cache the most recent value of the "display" variable (which we // only guarantee to be valid in between makeCurrent / free pairs) // so that we can implement displayImpl() (which must be done when // the context is not current) protected long mostRecentDisplay; // There is currently a bug on Linux/AMD64 distributions in glXGetProcAddressARB protected static boolean isLinuxAMD64; static { functionNameMap = new HashMap(); functionNameMap.put("glAllocateMemoryNV", "glXAllocateMemoryNV"); functionNameMap.put("glFreeMemoryNV", "glXFreeMemoryNV"); AccessController.doPrivileged(new PrivilegedAction() { public Object run() { String os = System.getProperty("os.name").toLowerCase(); String arch = System.getProperty("os.arch").toLowerCase(); if (os.startsWith("linux") && arch.equals("amd64")) { isLinuxAMD64 = true; } return null; } }); } public X11GLContext(Component component, GLCapabilities capabilities, GLCapabilitiesChooser chooser, GLContext shareWith) { super(component, capabilities, chooser, shareWith); } protected GL createGL() { return new X11GLImpl(this); } protected String mapToRealGLFunctionName(String glFunctionName) { String lookup = (String) functionNameMap.get(glFunctionName); if (lookup != null) { return lookup; } return glFunctionName; } protected String mapToRealGLExtensionName(String glExtensionName) { return glExtensionName; } protected abstract boolean isOffscreen(); public int getOffscreenContextWidth() { throw new GLException("Should not call this"); } public int getOffscreenContextHeight() { throw new GLException("Should not call this"); } public int getOffscreenContextPixelDataType() { throw new GLException("Should not call this"); } public abstract int getOffscreenContextReadBuffer(); public abstract boolean offscreenImageNeedsVerticalFlip(); /** * Creates and initializes an appropriate OpenGl context. Should only be * called by {@link makeCurrentImpl()}. */ protected abstract void create(); public boolean isExtensionAvailable(String glExtensionName) { if (glExtensionName.equals("GL_ARB_pbuffer") || glExtensionName.equals("GL_ARB_pixel_format")) { return isGLX13; } return super.isExtensionAvailable(glExtensionName); } protected int makeCurrentImpl() throws GLException { boolean created = false; if (context == 0) { create(); if (DEBUG) { System.err.println("!!! Created GL context for " + getClass().getName()); } created = true; } if (drawable == 0) { throw new GLException("Unable to make context current; drawable was null"); } // FIXME: this cast to int would be wrong on 64-bit platforms // where the argument type to glXMakeCurrent would change (should // probably make GLXDrawable, and maybe XID, Opaque as long) if (!GLX.glXMakeCurrent(display, (int) drawable, context)) { throw new GLException("Error making context current"); } if (created) { resetGLFunctionAvailability(); return CONTEXT_CURRENT_NEW; } return CONTEXT_CURRENT; } protected void releaseImpl() throws GLException { if (!GLX.glXMakeCurrent(display, 0, 0)) { throw new GLException("Error freeing OpenGL context"); } } protected void destroyImpl() throws GLException { lockAWT(); if (context != 0) { GLX.glXDestroyContext(mostRecentDisplay, context); if (DEBUG) { System.err.println("!!! Destroyed OpenGL context " + context); } context = 0; } unlockAWT(); } public abstract void swapBuffers() throws GLException; protected long dynamicLookupFunction(String glFuncName) { long res = 0; if (!isLinuxAMD64) { res = GLX.glXGetProcAddressARB(glFuncName); } if (res == 0) { // GLU routines aren't known to the OpenGL function lookup res = GLX.dlsym(glFuncName); } return res; } public boolean isCreated() { return (context != 0); } protected void resetGLFunctionAvailability() { super.resetGLFunctionAvailability(); if (DEBUG) { System.err.println("!!! Initializing OpenGL extension address table"); } resetProcAddressTable(getGLProcAddressTable()); if (!haveResetGLXProcAddressTable) { resetProcAddressTable(GLX.getGLXProcAddressTable()); } // Figure out whether we are running GLX version 1.3 or above and // therefore have pbuffer support if (display == 0) { throw new GLException("Expected non-null DISPLAY for querying GLX version"); } int[] major = new int[1]; int[] minor = new int[1]; if (!GLX.glXQueryVersion(display, major, 0, minor, 0)) { throw new GLException("glXQueryVersion failed"); } if (DEBUG) { System.err.println("!!! GLX version: major " + major[0] + ", minor " + minor[0]); } // Work around bugs in ATI's Linux drivers where they report they // only implement GLX version 1.2 but actually do support pbuffers if (major[0] == 1 && minor[0] == 2) { GL gl = getGL(); String str = gl.glGetString(GL.GL_VENDOR); if (str != null && str.indexOf("ATI") >= 0) { isGLX13 = true; return; } } isGLX13 = ((major[0] > 1) || (minor[0] > 2)); } public GLProcAddressTable getGLProcAddressTable() { if (glProcAddressTable == null) { // FIXME: cache ProcAddressTables by capability bits so we can // share them among contexts with the same capabilities glProcAddressTable = new GLProcAddressTable(); } return glProcAddressTable; } public synchronized String getPlatformExtensionsString() { if (display == 0) { throw new GLException("Context not current"); } if (!glXQueryExtensionsStringInitialized) { glXQueryExtensionsStringAvailable = (dynamicLookupFunction("glXQueryExtensionsString") != 0); glXQueryExtensionsStringInitialized = true; } if (glXQueryExtensionsStringAvailable) { lockAWT(); try { String ret = GLX.glXQueryExtensionsString(display, GLX.DefaultScreen(display)); if (DEBUG) { System.err.println("!!! GLX extensions: " + ret); } return ret; } finally { unlockAWT(); } } else { return ""; } } protected boolean isFunctionAvailable(String glFunctionName) { boolean available = super.isFunctionAvailable(glFunctionName); // Sanity check for implementations that use proc addresses for run-time // linking: if the function IS available, then make sure there's a proc // address for it if it's an extension or not part of the OpenGL 1.1 core // (post GL 1.1 functions are run-time linked on windows). assert(!available || (getGLProcAddressTable().getAddressFor(mapToRealGLFunctionName(glFunctionName)) != 0 || FunctionAvailabilityCache.isPartOfGLCore("1.1", mapToRealGLFunctionName(glFunctionName))) ); return available; } //---------------------------------------------------------------------- // Internals only below this point // protected JAWT getJAWT() { return X11GLContextFactory.getJAWT(); } protected XVisualInfo chooseVisual() { if (!isOffscreen()) { // The visual has already been chosen by the time we get here; // it's specified by the GraphicsConfiguration of the // GLCanvas. Fortunately, the JAWT supplies the visual ID for // the component in a portable fashion, so all we have to do is // use XGetVisualInfo with a VisualIDMask to get the // corresponding XVisualInfo to pass into glXChooseVisual. int[] count = new int[1]; XVisualInfo template = new XVisualInfo(); // FIXME: probably not 64-bit clean template.visualid((int) visualID); XVisualInfo[] infos = GLX.XGetVisualInfo(display, GLX.VisualIDMask, template, count, 0); if (infos == null || infos.length == 0) { throw new GLException("Error while getting XVisualInfo for visual ID " + visualID); } // FIXME: the storage for the infos array is leaked (should // clean it up somehow when we're done with the visual we're // returning) return infos[0]; } else { // It isn't clear to me whether we need this much code to handle // the offscreen case, where we're creating a pixmap into which // to render...this is what we (incorrectly) used to do for the // onscreen case int screen = 0; // FIXME: provide way to specify this? XVisualInfo vis = null; int[] count = new int[1]; XVisualInfo template = new XVisualInfo(); template.screen(screen); XVisualInfo[] infos = GLX.XGetVisualInfo(display, GLX.VisualScreenMask, template, count, 0); if (infos == null) { throw new GLException("Error while enumerating available XVisualInfos"); } GLCapabilities[] caps = new GLCapabilities[infos.length]; for (int i = 0; i < infos.length; i++) { caps[i] = X11GLContextFactory.xvi2GLCapabilities(display, infos[i]); } int chosen = chooser.chooseCapabilities(capabilities, caps, -1); if (chosen < 0 || chosen >= caps.length) { throw new GLException("GLCapabilitiesChooser specified invalid index (expected 0.." + (caps.length - 1) + ")"); } if (DEBUG) { System.err.println("Chosen visual (" + chosen + "):"); System.err.println(caps[chosen]); } vis = infos[chosen]; if (vis == null) { throw new GLException("GLCapabilitiesChooser chose an invalid visual"); } // FIXME: the storage for the infos array is leaked (should // clean it up somehow when we're done with the visual we're // returning) return vis; } } protected long createContext(XVisualInfo vis, boolean onscreen) { X11GLContext other = (X11GLContext) GLContextShareSet.getShareContext(this); long share = 0; if (other != null) { share = other.getContext(); if (share == 0) { throw new GLException("GLContextShareSet returned an invalid OpenGL context"); } } long res = GLX.glXCreateContext(display, vis, share, onscreen); if (res != 0) { GLContextShareSet.contextCreated(this); } return res; } // Helper routine for the overridden create() to call protected void chooseVisualAndCreateContext(boolean onscreen) { XVisualInfo vis = chooseVisual(); context = createContext(vis, onscreen); if (context == 0) { throw new GLException("Unable to create OpenGL context"); } } protected long getContext() { return context; } // These synchronization primitives prevent the AWT from making // requests from the X server asynchronously to this code. protected void lockAWT() { X11GLContextFactory.lockAWT(); } protected void unlockAWT() { X11GLContextFactory.unlockAWT(); } }