Bug 776 GLContext Sharing: Add GLSharedContextSetter to GLJPanel

4 files changed, 367 insertions, 7 deletions

diff --git a/make/scripts/tests.sh b/make/scripts/tests.sh
index 23477b254..4d87136c3 100644
--- a/make/scripts/tests.sh
+++ b/make/scripts/tests.sh
@@ -376,7 +376,8 @@ function testawtswt() {
 #testnoawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextVBOES2NEWT1 $*
 #testnoawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextVBOES2NEWT2 $*
 #testawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextVBOES2AWT3 $*
-testawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextWithJTabbedPaneAWT $*
+testawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextVBOES2AWT3b $*
+#testawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextWithJTabbedPaneAWT $*
 #testawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextNewtAWTBug523 $*
 #testawt com.jogamp.opengl.test.junit.jogl.acore.TestSharedContextListAWT $*
 
diff --git a/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java b/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java
index 93e8b2c0b..faf00c19a 100644
--- a/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java
+++ b/src/jogl/classes/javax/media/opengl/awt/GLJPanel.java
@@ -77,6 +77,7 @@ import javax.media.opengl.GLException;
 import javax.media.opengl.GLFBODrawable;
 import javax.media.opengl.GLProfile;
 import javax.media.opengl.GLRunnable;
+import javax.media.opengl.GLSharedContextSetter;
 import javax.media.opengl.Threading;
 import javax.swing.JPanel;
 
@@ -160,7 +161,7 @@ import com.jogamp.opengl.util.texture.TextureState;
 */
 
 @SuppressWarnings("serial")
-public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosingProtocol, AWTPrintLifecycle {
+public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosingProtocol, AWTPrintLifecycle, GLSharedContextSetter {
   private static final boolean DEBUG;
   private static final boolean DEBUG_VIEWPORT;
   private static final boolean USE_GLSL_TEXTURE_RASTERIZER;
@@ -223,7 +224,6 @@ public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosing
   private final GLProfile             glProfile;
   private final GLDrawableFactoryImpl factory;
   private final GLCapabilitiesChooser chooser;
-  private final GLContext             shareWith;
   private int additionalCtxCreationFlags = 0;
 
   // Lazy reshape notification: reshapeWidth -> panelWidth -> backend.width
@@ -296,6 +296,29 @@ public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosing
       since J2D GL Context must be shared and we can only share one context.
     * @throws GLException if no GLCapabilities are given and no default profile is available for the default desktop device.
   */
+  public GLJPanel(GLCapabilitiesImmutable userCapsRequest, GLCapabilitiesChooser chooser)
+          throws GLException
+  {
+      this(userCapsRequest, chooser, null);
+  }
+
+  /** Creates a new GLJPanel component. The passed GLCapabilities
+      specifies the OpenGL capabilities for the component; if null, a
+      default set of capabilities is used. The GLCapabilitiesChooser
+      specifies the algorithm for selecting one of the available
+      GLCapabilities for the component; a DefaultGLCapabilitesChooser
+      is used if null is passed for this argument. The passed
+      GLContext specifies an OpenGL context with which to share
+      textures, display lists and other OpenGL state, and may be null
+      if sharing is not desired. See the note in the overview documentation on
+      <a href="../../../spec-summary.html#SHARING">context sharing</a>.
+      <P>
+      Note: Sharing cannot be enabled using J2D OpenGL FBO sharing,
+      since J2D GL Context must be shared and we can only share one context.
+    * @throws GLException if no GLCapabilities are given and no default profile is available for the default desktop device.
+    * @deprecated Use {@link #GLJPanel(GLCapabilitiesImmutable, GLCapabilitiesChooser)}
+    *             and set shared GLContext via {@link #setSharedContext(GLContext)} or {@link #setSharedAutoDrawable(GLAutoDrawable)}.
+    */
   public GLJPanel(GLCapabilitiesImmutable userCapsRequest, GLCapabilitiesChooser chooser, GLContext shareWith)
           throws GLException
   {
@@ -316,11 +339,22 @@ public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosing
     this.glProfile = offscreenCaps.getGLProfile();
     this.factory = GLDrawableFactoryImpl.getFactoryImpl(glProfile);
     this.chooser = ((chooser != null) ? chooser : new DefaultGLCapabilitiesChooser());
-    this.shareWith = shareWith;
-
+    if( null != shareWith ) {
+        helper.setSharedContext(null, shareWith);
+    }
     this.setFocusable(true); // allow keyboard input!
   }
 
+  @Override
+  public final void setSharedContext(GLContext sharedContext) throws IllegalStateException {
+      helper.setSharedContext(this.getContext(), sharedContext);
+  }
+
+  @Override
+  public final void setSharedAutoDrawable(GLAutoDrawable sharedAutoDrawable) throws IllegalStateException {
+      helper.setSharedAutoDrawable(this, sharedAutoDrawable);
+  }
+
   public AWTGLPixelBufferProvider getCustomPixelBufferProvider() { return customPixelBufferProvider; }
 
   /**
@@ -1301,13 +1335,17 @@ public class GLJPanel extends JPanel implements AWTGLAutoDrawable, WindowClosing
           System.err.println(getThreadName()+": OffscreenBackend: initialize()");
       }
       try {
+          final GLContext[] shareWith = { null };
+          if( helper.isSharedGLContextPending(shareWith) ) {
+              return; // pending ..
+          }
           offscreenDrawable = (GLDrawableImpl) factory.createOffscreenDrawable(
                                                     null /* default platform device */,
                                                     offscreenCaps,
                                                     chooser,
                                                     panelWidth, panelHeight);
           offscreenDrawable.setRealized(true);
-          offscreenContext = (GLContextImpl) offscreenDrawable.createContext(shareWith);
+          offscreenContext = (GLContextImpl) offscreenDrawable.createContext(shareWith[0]);
           offscreenContext.setContextCreationFlags(additionalCtxCreationFlags);
           if( GLContext.CONTEXT_NOT_CURRENT < offscreenContext.makeCurrent() ) {
               isInitialized = true;
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextVBOES2AWT3.java b/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextVBOES2AWT3.java
index 6b9169510..b2d88f8e0 100644
--- a/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextVBOES2AWT3.java
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextVBOES2AWT3.java
@@ -88,7 +88,7 @@ public class TestSharedContextVBOES2AWT3 extends UITestCase {
         frame.add(glCanvas);
         frame.setLocation(x, y);
         frame.setSize(width, height);
-        frame.setTitle("Shared Gears AWT GLCanvas Test: "+x+"/"+y+" shared true");
+        frame.setTitle("AWT GLCanvas Shared Gears Test: "+x+"/"+y+" shared true");
         return glCanvas;
     }
 
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextVBOES2AWT3b.java b/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextVBOES2AWT3b.java
new file mode 100644
index 000000000..fcfe4d512
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextVBOES2AWT3b.java
@@ -0,0 +1,321 @@
+/**
+ * Copyright 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:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+
+package com.jogamp.opengl.test.junit.jogl.acore;
+
+import java.awt.Frame;
+import java.lang.reflect.InvocationTargetException;
+import java.util.List;
+
+import javax.media.opengl.GLCapabilities;
+import javax.media.opengl.GLContext;
+import javax.media.opengl.GLProfile;
+import javax.media.opengl.awt.GLJPanel;
+
+import com.jogamp.opengl.util.Animator;
+import com.jogamp.opengl.test.junit.util.AWTRobotUtil;
+import com.jogamp.opengl.test.junit.util.MiscUtils;
+import com.jogamp.opengl.test.junit.util.UITestCase;
+import com.jogamp.opengl.test.junit.jogl.demos.es2.GearsES2;
+
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.FixMethodOrder;
+import org.junit.runners.MethodSorters;
+
+/**
+ * Sharing the VBO of 3 GearsES2 instances, each in their own GLJPanel.
+ * <p>
+ * This is achieved by using the 1st GLJPanel as the <i>master</i>
+ * and using the build-in blocking mechanism to postpone creation
+ * of the 2nd and 3rd GLJPanel until the 1st GLJPanel 's GLContext becomes created.
+ * </p>
+ * <p>
+ * Above method allows random creation of the 1st GLJPanel, which triggers
+ * creation of the <i>dependent</i> other GLJPanel sharing it's GLContext.
+ * </p>
+ */
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
+public class TestSharedContextVBOES2AWT3b extends UITestCase {
+    static GLProfile glp;
+    static GLCapabilities caps;
+    static int width, height;
+
+    @BeforeClass
+    public static void initClass() {
+        if(GLProfile.isAvailable(GLProfile.GL2ES2)) {
+            glp = GLProfile.get(GLProfile.GL2ES2);
+            Assert.assertNotNull(glp);
+            caps = new GLCapabilities(glp);
+            Assert.assertNotNull(caps);
+            width  = 256;
+            height = 256;
+        } else {
+            setTestSupported(false);
+        }
+    }
+
+    protected GLJPanel createGLJPanel(final Frame frame, int x, int y, GearsES2 gears) throws InterruptedException {
+        final GLJPanel glCanvas = new GLJPanel(caps);
+        Assert.assertNotNull(glCanvas);
+        glCanvas.addGLEventListener(gears);
+        frame.add(glCanvas);
+        frame.setLocation(x, y);
+        frame.setSize(width, height);
+        frame.setTitle("AWT GLJPanel Shared Gears Test: "+x+"/"+y+" shared true");
+        return glCanvas;
+    }
+
+    @Test
+    public void test01SyncedCommonAnimatorSharedOffscreen() throws InterruptedException, InvocationTargetException {
+        final Frame f1 = new Frame();
+        final Animator animator = new Animator();
+        final GearsES2 g1 = new GearsES2(0);
+        final GLJPanel c1 = createGLJPanel(f1, 0, 0, g1);
+        animator.add(c1);
+
+        final Frame f2 = new Frame();
+        final GearsES2 g2 = new GearsES2(0);
+        g2.setSharedGears(g1);
+        final GLJPanel c2 = createGLJPanel(f2, f1.getX()+width,
+                                           f1.getY()+0, g2);
+        c2.setSharedAutoDrawable(c1);
+        animator.add(c2);
+
+        final Frame f3 = new Frame();
+        final GearsES2 g3 = new GearsES2(0);
+        g3.setSharedGears(g1);
+        final GLJPanel c3 = createGLJPanel(f3, f1.getX()+0,
+                                           f1.getY()+height, g3);
+        c3.setSharedAutoDrawable(c1);
+        animator.add(c3);
+
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                f2.setVisible(true); // shall wait until f1 is ready
+                f1.setVisible(true); // master ..
+                f3.setVisible(true); // shall wait until f1 is ready
+            } } );
+        animator.start(); // kicks off GLContext .. and hence gears of f2 + f3 completion
+
+        Thread.sleep(1000/60*10); // wait ~10 frames giving a chance to create (blocking until master share is valid)
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c1, true));
+        Assert.assertTrue(AWTRobotUtil.waitForVisible(c1, true));
+        Assert.assertTrue(AWTRobotUtil.waitForCreated(c1.getContext(), true));
+        Assert.assertTrue("Gears1 not initialized", g1.waitForInit(true));
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c2, true));
+        Assert.assertTrue(AWTRobotUtil.waitForVisible(c2, true));
+        Assert.assertTrue(AWTRobotUtil.waitForCreated(c2.getContext(), true));
+        Assert.assertTrue("Gears2 not initialized", g2.waitForInit(true));
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c3, true));
+        Assert.assertTrue(AWTRobotUtil.waitForVisible(c3, true));
+        Assert.assertTrue(AWTRobotUtil.waitForCreated(c3.getContext(), true));
+        Assert.assertTrue("Gears3 not initialized", g3.waitForInit(true));
+
+        final GLContext ctx1 = c1.getContext();
+        final GLContext ctx2 = c2.getContext();
+        final GLContext ctx3 = c3.getContext();
+        {
+            final List<GLContext> ctx1Shares = ctx1.getCreatedShares();
+            final List<GLContext> ctx2Shares = ctx2.getCreatedShares();
+            final List<GLContext> ctx3Shares = ctx3.getCreatedShares();
+            System.err.println("XXX-C-3.1:");
+            MiscUtils.dumpSharedGLContext(ctx1);
+            System.err.println("XXX-C-3.2:");
+            MiscUtils.dumpSharedGLContext(ctx2);
+            System.err.println("XXX-C-3.3:");
+            MiscUtils.dumpSharedGLContext(ctx3);
+
+            Assert.assertTrue("Ctx1 is not shared", ctx1.isShared());
+            Assert.assertTrue("Ctx2 is not shared", ctx2.isShared());
+            Assert.assertTrue("Ctx3 is not shared", ctx3.isShared());
+            Assert.assertEquals("Ctx1 has unexpected number of created shares", 2, ctx1Shares.size());
+            Assert.assertEquals("Ctx2 has unexpected number of created shares", 2, ctx2Shares.size());
+            Assert.assertEquals("Ctx3 has unexpected number of created shares", 2, ctx3Shares.size());
+        }
+
+        Assert.assertTrue("Gears1 is shared", !g1.usesSharedGears());
+        Assert.assertTrue("Gears2 is not shared", g2.usesSharedGears());
+        Assert.assertTrue("Gears3 is not shared", g3.usesSharedGears());
+
+        try {
+            Thread.sleep(duration);
+        } catch(Exception e) {
+            e.printStackTrace();
+        }
+        animator.stop();
+
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                try {
+                    f1.dispose();
+                    f2.dispose();
+                    f3.dispose();
+                } catch (Throwable t) {
+                    throw new RuntimeException(t);
+                }
+            }});
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c1, false));
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c2, false));
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c3, false));
+    }
+
+    @Test
+    public void test02AsyncEachWithAnimatorSharedOffscreen() throws InterruptedException, InvocationTargetException {
+        final Frame f1 = new Frame();
+        final Animator a1 = new Animator();
+        final GearsES2 g1 = new GearsES2(0);
+        final GLJPanel c1 = createGLJPanel(f1, 0, 0, g1);
+        a1.add(c1);
+        a1.start();
+        // f1.setVisible(true); // we do this post f2 .. to test pending creation!
+
+        final Frame f2 = new Frame();
+        final Animator a2 = new Animator();
+        final GearsES2 g2 = new GearsES2(0);
+        g2.setSharedGears(g1);
+        final GLJPanel c2 = createGLJPanel(f2, f1.getX()+width, f1.getY()+0, g2);
+        c2.setSharedAutoDrawable(c1);
+        a2.add(c2);
+        a2.start();
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                f2.setVisible(true);
+            } } );
+
+        Thread.sleep(200); // wait a while ..
+
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                f1.setVisible(true); // test pending creation of f2
+            } } );
+
+        final Frame f3 = new Frame();
+        final Animator a3 = new Animator();
+        final GearsES2 g3 = new GearsES2(0);
+        g3.setSharedGears(g1);
+        final GLJPanel c3 = createGLJPanel(f3, f1.getX()+0, f1.getY()+height, g3);
+        c3.setSharedAutoDrawable(c1);
+        a3.add(c3);
+        a3.start();
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                f3.setVisible(true);
+            } } );
+
+        Thread.sleep(1000/60*10); // wait ~10 frames giving a chance to create (blocking until master share is valid)
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c1, true));
+        Assert.assertTrue(AWTRobotUtil.waitForVisible(c1, true));
+        Assert.assertTrue(AWTRobotUtil.waitForCreated(c1.getContext(), true));
+        Assert.assertTrue("Gears1 not initialized", g1.waitForInit(true));
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c2, true));
+        Assert.assertTrue(AWTRobotUtil.waitForVisible(c2, true));
+        Assert.assertTrue(AWTRobotUtil.waitForCreated(c2.getContext(), true));
+        Assert.assertTrue("Gears2 not initialized", g2.waitForInit(true));
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c3, true));
+        Assert.assertTrue(AWTRobotUtil.waitForVisible(c3, true));
+        Assert.assertTrue(AWTRobotUtil.waitForCreated(c3.getContext(), true));
+        Assert.assertTrue("Gears3 not initialized", g3.waitForInit(true));
+
+        final GLContext ctx1 = c1.getContext();
+        final GLContext ctx2 = c2.getContext();
+        final GLContext ctx3 = c3.getContext();
+        {
+            final List<GLContext> ctx1Shares = ctx1.getCreatedShares();
+            final List<GLContext> ctx2Shares = ctx2.getCreatedShares();
+            final List<GLContext> ctx3Shares = ctx3.getCreatedShares();
+            System.err.println("XXX-C-3.1:");
+            MiscUtils.dumpSharedGLContext(ctx1);
+            System.err.println("XXX-C-3.2:");
+            MiscUtils.dumpSharedGLContext(ctx2);
+            System.err.println("XXX-C-3.3:");
+            MiscUtils.dumpSharedGLContext(ctx3);
+
+            Assert.assertTrue("Ctx1 is not shared", ctx1.isShared());
+            Assert.assertTrue("Ctx2 is not shared", ctx2.isShared());
+            Assert.assertTrue("Ctx3 is not shared", ctx3.isShared());
+            Assert.assertEquals("Ctx1 has unexpected number of created shares", 2, ctx1Shares.size());
+            Assert.assertEquals("Ctx2 has unexpected number of created shares", 2, ctx2Shares.size());
+            Assert.assertEquals("Ctx3 has unexpected number of created shares", 2, ctx3Shares.size());
+        }
+
+        Assert.assertTrue("Gears1 is shared", !g1.usesSharedGears());
+        Assert.assertTrue("Gears2 is not shared", g2.usesSharedGears());
+        Assert.assertTrue("Gears3 is not shared", g3.usesSharedGears());
+
+        try {
+            Thread.sleep(duration);
+        } catch(Exception e) {
+            e.printStackTrace();
+        }
+        a1.stop();
+        a2.stop();
+        a3.stop();
+
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                try {
+                    f1.dispose();
+                    f2.dispose();
+                    f3.dispose();
+                } catch (Throwable t) {
+                    throw new RuntimeException(t);
+                }
+            }});
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c1, false));
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c2, false));
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(c3, false));
+    }
+
+    static long duration = 1000; // ms
+
+    public static void main(String args[]) {
+        for(int i=0; i<args.length; i++) {
+            if(args[i].equals("-time")) {
+                i++;
+                try {
+                    duration = Integer.parseInt(args[i]);
+                } catch (Exception ex) { ex.printStackTrace(); }
+            }
+        }
+        /**
+        BufferedReader stdin = new BufferedReader(new InputStreamReader(System.in));
+        System.err.println("Press enter to continue");
+        System.err.println(stdin.readLine()); */
+        org.junit.runner.JUnitCore.main(TestSharedContextVBOES2AWT3b.class.getName());
+    }
+}