/*
* Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
* Copyright (c) 2010 JogAmp Community. 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.
*/
package jogamp.opengl.x11.glx;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.nio.*;
import javax.media.nativewindow.*;
import javax.media.nativewindow.x11.*;
import javax.media.opengl.*;
import jogamp.opengl.*;
import com.jogamp.common.util.*;
import jogamp.nativewindow.WrappedSurface;
import jogamp.nativewindow.x11.*;
public class X11GLXDrawableFactory extends GLDrawableFactoryImpl {
private static final DesktopGLDynamicLookupHelper x11GLXDynamicLookupHelper;
static {
DesktopGLDynamicLookupHelper tmp = null;
try {
tmp = new DesktopGLDynamicLookupHelper(new X11GLXDynamicLibraryBundleInfo());
} catch (GLException gle) {
if(DEBUG) {
gle.printStackTrace();
}
}
x11GLXDynamicLookupHelper = tmp;
if(null!=x11GLXDynamicLookupHelper) {
GLX.getGLXProcAddressTable().reset(x11GLXDynamicLookupHelper);
}
}
public static VersionNumber getGLXVersion(X11GraphicsDevice device) {
int[] major = new int[1];
int[] minor = new int[1];
GLXUtil.getGLXVersion(device.getHandle(), major, minor);
return new VersionNumber(major[0], minor[0], 0);
}
public GLDynamicLookupHelper getGLDynamicLookupHelper(int profile) {
return x11GLXDynamicLookupHelper;
}
public X11GLXDrawableFactory() {
super();
// Register our GraphicsConfigurationFactory implementations
// The act of constructing them causes them to be registered
X11GLXGraphicsConfigurationFactory.registerFactory();
defaultDevice = new X11GraphicsDevice(X11Util.getNullDisplayName(), AbstractGraphicsDevice.DEFAULT_UNIT);
// Init shared resources off thread
// Will be released via ShutdownHook
sharedResourceImpl = new SharedResourceImplementation();
sharedResourceRunner = new SharedResourceRunner(sharedResourceImpl);
sharedResourceThread = new Thread(sharedResourceRunner, Thread.currentThread().getName()+"-SharedResourceRunner");
sharedResourceThread.setDaemon(true); // Allow JVM to exit, even if this one is running
sharedResourceThread.start();
}
X11GraphicsDevice defaultDevice;
SharedResourceImplementation sharedResourceImpl;
SharedResourceRunner sharedResourceRunner;
Thread sharedResourceThread;
HashMap<String /* connection */, SharedResourceRunner.Resource> sharedMap = new HashMap<String, SharedResourceRunner.Resource>();
static class SharedResource implements SharedResourceRunner.Resource {
X11GraphicsDevice device;
X11GraphicsScreen screen;
X11DummyGLXDrawable drawable;
X11GLXContext context;
String glXVendorName;
boolean isGLXVendorATI;
boolean isGLXVendorNVIDIA;
VersionNumber glXVersion;
SharedResource(X11GraphicsDevice dev, X11GraphicsScreen scrn,
X11DummyGLXDrawable draw, X11GLXContext ctx,
VersionNumber glXVer, String glXVendor) {
device = dev;
screen = scrn;
drawable = draw;
context = ctx;
glXVersion = glXVer;
glXVendorName = glXVendor;
isGLXVendorATI = GLXUtil.isVendorATI(glXVendorName);
isGLXVendorNVIDIA = GLXUtil.isVendorNVIDIA(glXVendorName);
}
final public AbstractGraphicsDevice getDevice() { return device; }
final public AbstractGraphicsScreen getScreen() { return screen; }
final public GLDrawableImpl getDrawable() { return drawable; }
final public GLContextImpl getContext() { return context; }
final String getGLXVendorName() { return glXVendorName; }
final boolean isGLXVendorATI() { return isGLXVendorATI; }
final boolean isGLXVendorNVIDIA() { return isGLXVendorNVIDIA; }
final VersionNumber getGLXVersion() { return glXVersion; }
final boolean isGLXVersionGreaterEqualOneThree() {
return ( null != glXVersion ) ? glXVersion.compareTo(versionOneThree) >= 0 : false ;
}
}
class SharedResourceImplementation implements SharedResourceRunner.Implementation {
public void clear() {
synchronized(sharedMap) {
sharedMap.clear();
}
}
public SharedResourceRunner.Resource mapPut(String connection, SharedResourceRunner.Resource resource) {
synchronized(sharedMap) {
return sharedMap.put(connection, resource);
}
}
public SharedResourceRunner.Resource mapGet(String connection) {
synchronized(sharedMap) {
return sharedMap.get(connection);
}
}
public Collection<SharedResourceRunner.Resource> mapValues() {
synchronized(sharedMap) {
return sharedMap.values();
}
}
public SharedResourceRunner.Resource createSharedResource(String connection) {
X11GraphicsDevice sharedDevice =
new X11GraphicsDevice(X11Util.openDisplay(connection), AbstractGraphicsDevice.DEFAULT_UNIT,
NativeWindowFactory.getNullToolkitLock(), true); // own non-shared display connection, no locking
sharedDevice.lock();
try {
String glXVendorName = GLXUtil.getVendorName(sharedDevice.getHandle());
if(X11Util.ATI_HAS_XCLOSEDISPLAY_BUG && GLXUtil.isVendorATI(glXVendorName)) {
X11Util.setMarkAllDisplaysUnclosable(true);
X11Util.markDisplayUncloseable(sharedDevice.getHandle());
}
X11GraphicsScreen sharedScreen = new X11GraphicsScreen(sharedDevice, 0);
GLProfile glp = GLProfile.get(sharedDevice, GLProfile.GL_PROFILE_LIST_MIN_DESKTOP);
if (null == glp) {
throw new GLException("Couldn't get default GLProfile for device: "+sharedDevice);
}
X11DummyGLXDrawable sharedDrawable = X11DummyGLXDrawable.create(sharedScreen, X11GLXDrawableFactory.this, glp);
if (null == sharedDrawable) {
throw new GLException("Couldn't create shared drawable for screen: "+sharedScreen+", "+glp);
}
X11GLXContext sharedContext = (X11GLXContext) sharedDrawable.createContext(null);
if (null == sharedContext) {
throw new GLException("Couldn't create shared context for drawable: "+sharedDrawable);
}
sharedContext.setSynchronized(true);
VersionNumber glXVersion = getGLXVersion(sharedDevice);
boolean madeCurrent = false;
sharedContext.makeCurrent();
try {
madeCurrent = sharedContext.isCurrent();
} finally {
sharedContext.release();
}
if (DEBUG) {
System.err.println("!!! SharedDevice: " + sharedDevice);
System.err.println("!!! SharedScreen: " + sharedScreen);
System.err.println("!!! SharedContext: " + sharedContext + ", madeCurrent " + madeCurrent);
System.err.println("!!! GLX Vendor: " + glXVendorName);
System.err.println("!!! GLX Version: " + glXVersion
+ " >= 1.3: " + (glXVersion.compareTo(versionOneThree) >= 0));
}
return new SharedResource(sharedDevice, sharedScreen, sharedDrawable, sharedContext, glXVersion, glXVendorName);
} catch (Throwable t) {
throw new GLException("X11GLXDrawableFactory - Could not initialize shared resources for "+connection, t);
} finally {
sharedDevice.unlock();
}
}
public void releaseSharedResource(SharedResourceRunner.Resource shared) {
SharedResource sr = (SharedResource) shared;
if (DEBUG) {
System.err.println("!!! Shutdown Shared:");
System.err.println("!!! Device : " + sr.device);
System.err.println("!!! Screen : " + sr.screen);
System.err.println("!!! Drawable: " + sr.drawable);
System.err.println("!!! CTX : " + sr.context);
}
if (null != sr.context) {
// may cause JVM SIGSEGV: sharedContext.destroy();
sr.context = null;
}
if (null != sr.drawable) {
// may cause JVM SIGSEGV: sharedDrawable.destroy();
sr.drawable = null;
}
if (null != sr.screen) {
sr.screen = null;
}
if (null != sr.device) {
sr.device.close();
sr.device = null;
}
}
}
public final AbstractGraphicsDevice getDefaultDevice() {
return defaultDevice;
}
public final boolean getIsDeviceCompatible(AbstractGraphicsDevice device) {
if(device instanceof X11GraphicsDevice) {
return true;
}
return false;
}
public final boolean getWasSharedContextCreated(AbstractGraphicsDevice device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return null != sr.getContext();
}
return false;
}
protected final GLContext getOrCreateSharedContextImpl(AbstractGraphicsDevice device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return sr.getContext();
}
return null;
}
protected AbstractGraphicsDevice getOrCreateSharedDeviceImpl(AbstractGraphicsDevice device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return sr.getDevice();
}
return null;
}
protected final long getOrCreateSharedDpy(AbstractGraphicsDevice device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return sr.getDevice().getHandle();
}
return 0;
}
SharedResource getOrCreateSharedResource(AbstractGraphicsDevice device) {
return (SharedResource) sharedResourceRunner.getOrCreateShared(device);
}
public final String getGLXVendorName(AbstractGraphicsDevice device) {
if(null != device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return ((SharedResource)sr).getGLXVendorName();
}
return GLXUtil.getVendorName(device.getHandle());
}
return null;
}
public final boolean isGLXVendorATI(AbstractGraphicsDevice device) {
if(null != device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return ((SharedResource)sr).isGLXVendorATI();
}
return GLXUtil.isVendorATI(device.getHandle());
}
return false;
}
public final boolean isGLXVendorNVIDIA(AbstractGraphicsDevice device) {
if(null != device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return ((SharedResource)sr).isGLXVendorNVIDIA();
}
return GLXUtil.isVendorNVIDIA(device.getHandle());
}
return false;
}
protected final void shutdownInstance() {
sharedResourceRunner.releaseAndWait();
// Don't really close pending Display connections,
// since this may trigger a JVM exception
X11Util.shutdown( false, DEBUG );
}
protected List<GLCapabilitiesImmutable> getAvailableCapabilitiesImpl(AbstractGraphicsDevice device) {
return X11GLXGraphicsConfigurationFactory.getAvailableCapabilities(this, device);
}
protected final GLDrawableImpl createOnscreenDrawableImpl(NativeSurface target) {
if (target == null) {
throw new IllegalArgumentException("Null target");
}
return new X11OnscreenGLXDrawable(this, target);
}
protected final GLDrawableImpl createOffscreenDrawableImpl(NativeSurface target) {
if (target == null) {
throw new IllegalArgumentException("Null target");
}
AbstractGraphicsConfiguration config = target.getGraphicsConfiguration();
GLCapabilitiesImmutable caps = (GLCapabilitiesImmutable) config.getChosenCapabilities();
if(!caps.isPBuffer()) {
return new X11PixmapGLXDrawable(this, target);
}
// PBuffer GLDrawable Creation
GLDrawableImpl pbufferDrawable;
AbstractGraphicsDevice device = config.getScreen().getDevice();
/**
* Due to the ATI Bug https://bugzilla.mozilla.org/show_bug.cgi?id=486277,
* we need to have a context current on the same Display to create a PBuffer.
* The dummy context shall also use the same Display,
* since switching Display in this regard is another ATI bug.
*/
SharedResource sr = (SharedResource) sharedResourceRunner.getOrCreateShared(device);
if( null!=sr && sr.isGLXVendorATI() && null == GLContext.getCurrent() ) {
sr.getContext().makeCurrent();
try {
pbufferDrawable = new X11PbufferGLXDrawable(this, target);
} finally {
sr.getContext().release();
}
} else {
pbufferDrawable = new X11PbufferGLXDrawable(this, target);
}
return pbufferDrawable;
}
public final boolean isGLXVersionGreaterEqualOneThree(AbstractGraphicsDevice device) {
if(null != device) {
SharedResource sr = (SharedResource) sharedResourceRunner.getOrCreateShared(device);
if(null!=sr) {
return sr.isGLXVersionGreaterEqualOneThree();
}
if( device instanceof X11GraphicsDevice ) {
VersionNumber v = getGLXVersion( (X11GraphicsDevice) device);
return ( null != v ) ? v.compareTo(versionOneThree) >= 0 : false ;
}
}
return false;
}
public final boolean canCreateGLPbuffer(AbstractGraphicsDevice device) {
if(null == device) {
SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(defaultDevice);
if(null!=sr) {
device = sr.getDevice();
}
}
return isGLXVersionGreaterEqualOneThree(device);
}
protected final NativeSurface createOffscreenSurfaceImpl(AbstractGraphicsDevice deviceReq,
GLCapabilitiesImmutable capsChosen, GLCapabilitiesImmutable capsRequested,
GLCapabilitiesChooser chooser,
int width, int height) {
if(null == deviceReq) {
throw new InternalError("deviceReq is null");
}
final SharedResourceRunner.Resource sr = sharedResourceRunner.getOrCreateShared(deviceReq);
if(null==sr) {
throw new InternalError("No SharedResource for: "+deviceReq);
}
final X11GraphicsScreen sharedScreen = (X11GraphicsScreen) sr.getScreen();
final AbstractGraphicsDevice sharedDevice = sharedScreen.getDevice(); // should be same ..
// create screen/device pair - Null X11 locking, due to private non-shared Display handle
final X11GraphicsDevice device = new X11GraphicsDevice(X11Util.openDisplay(sharedDevice.getConnection()), AbstractGraphicsDevice.DEFAULT_UNIT, NativeWindowFactory.getNullToolkitLock(), true);
final X11GraphicsScreen screen = new X11GraphicsScreen(device, sharedScreen.getIndex());
WrappedSurface ns = new WrappedSurface(
X11GLXGraphicsConfigurationFactory.chooseGraphicsConfigurationStatic(capsChosen, capsRequested, chooser, screen) );
if(ns != null) {
ns.surfaceSizeChanged(width, height);
}
return ns;
}
protected final ProxySurface createProxySurfaceImpl(AbstractGraphicsDevice adevice, long windowHandle, GLCapabilitiesImmutable capsRequested, GLCapabilitiesChooser chooser) {
// FIXME device/windowHandle -> screen ?!
X11GraphicsDevice device = (X11GraphicsDevice) adevice;
X11GraphicsScreen screen = new X11GraphicsScreen(device, 0);
X11GLXGraphicsConfiguration cfg = X11GLXGraphicsConfigurationFactory.chooseGraphicsConfigurationStatic(capsRequested, capsRequested, chooser, screen);
WrappedSurface ns = new WrappedSurface(cfg, windowHandle);
return ns;
}
protected final GLContext createExternalGLContextImpl() {
return X11ExternalGLXContext.create(this, null);
}
public final boolean canCreateExternalGLDrawable(AbstractGraphicsDevice device) {
return canCreateGLPbuffer(device);
}
protected final GLDrawable createExternalGLDrawableImpl() {
return X11ExternalGLXDrawable.create(this, null);
}
public final boolean canCreateContextOnJava2DSurface(AbstractGraphicsDevice device) {
return false;
}
public final GLContext createContextOnJava2DSurface(Object graphics, GLContext shareWith)
throws GLException {
throw new GLException("Unimplemented on this platform");
}
//----------------------------------------------------------------------
// Gamma-related functionality
//
private boolean gotGammaRampLength;
private int gammaRampLength;
protected final synchronized int getGammaRampLength() {
if (gotGammaRampLength) {
return gammaRampLength;
}
long display = getOrCreateSharedDpy(defaultDevice);
if(0 == display) {
return 0;
}
int[] size = new int[1];
boolean res = X11Util.XF86VidModeGetGammaRampSize(display,
X11Util.DefaultScreen(display),
size, 0);
if (!res) {
return 0;
}
gotGammaRampLength = true;
gammaRampLength = size[0];
return gammaRampLength;
}
protected final boolean setGammaRamp(float[] ramp) {
long display = getOrCreateSharedDpy(defaultDevice);
if(0 == display) {
return false;
}
int len = ramp.length;
short[] rampData = new short[len];
for (int i = 0; i < len; i++) {
rampData[i] = (short) (ramp[i] * 65535);
}
boolean res = X11Util.XF86VidModeSetGammaRamp(display,
X11Util.DefaultScreen(display),
rampData.length,
rampData, 0,
rampData, 0,
rampData, 0);
return res;
}
protected final Buffer getGammaRamp() {
long display = getOrCreateSharedDpy(defaultDevice);
if(0 == display) {
return null;
}
int size = getGammaRampLength();
ShortBuffer rampData = ShortBuffer.wrap(new short[3 * size]);
rampData.position(0);
rampData.limit(size);
ShortBuffer redRampData = rampData.slice();
rampData.position(size);
rampData.limit(2 * size);
ShortBuffer greenRampData = rampData.slice();
rampData.position(2 * size);
rampData.limit(3 * size);
ShortBuffer blueRampData = rampData.slice();
boolean res = X11Util.XF86VidModeGetGammaRamp(display,
X11Util.DefaultScreen(display),
size,
redRampData,
greenRampData,
blueRampData);
if (!res) {
return null;
}
return rampData;
}
protected final void resetGammaRamp(Buffer originalGammaRamp) {
if (originalGammaRamp == null) {
return; // getGammaRamp failed originally
}
long display = getOrCreateSharedDpy(defaultDevice);
if(0 == display) {
return;
}
ShortBuffer rampData = (ShortBuffer) originalGammaRamp;
int capacity = rampData.capacity();
if ((capacity % 3) != 0) {
throw new IllegalArgumentException("Must not be the original gamma ramp");
}
int size = capacity / 3;
rampData.position(0);
rampData.limit(size);
ShortBuffer redRampData = rampData.slice();
rampData.position(size);
rampData.limit(2 * size);
ShortBuffer greenRampData = rampData.slice();
rampData.position(2 * size);
rampData.limit(3 * size);
ShortBuffer blueRampData = rampData.slice();
X11Util.XF86VidModeSetGammaRamp(display,
X11Util.DefaultScreen(display),
size,
redRampData,
greenRampData,
blueRampData);
}
}