Bug 1021: Refine Stereo API; Fix GenericStereoDevice; Fix StereoDemo01 for movie playback and OSX usage (HiDPI surfaceSize)

- StereoDevice.DeviceType: Add API doc

- StereoDevice: Add getFactory()

- GenericStereoDevice
  - Use common static vars for configurations for simplicity

  - Fix createRenderer(..)'s eyeViewport in case no post-processing
    is performed, i.e. needs viewport X offset.

- StereoDemo01
  - Use 'movie' eyePosition instead of default if:
    - using a movie player _and_ using lenses!

  - Fix NEWT window pixel-unit size after window creation!

4 files changed, 53 insertions, 22 deletions

diff --git a/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java b/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java
index 2091d0843..d32c981a3 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDevice.java
@@ -46,6 +46,9 @@ public interface StereoDevice {
         // NOP
     }
 
+    /** Return the factory used to create this device. */
+    public StereoDeviceFactory getFactory();
+
     /** Disposes this {@link StereoDevice}. */
     public void dispose();
 
diff --git a/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDeviceFactory.java b/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDeviceFactory.java
index 46ce82f03..c4180585c 100644
--- a/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDeviceFactory.java
+++ b/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDeviceFactory.java
@@ -45,7 +45,25 @@ public abstract class StereoDeviceFactory {
     private static final String GenericStereoDeviceClazzName = "jogamp.opengl.util.stereo.GenericStereoDeviceFactory";
     private static final String isAvailableMethodName = "isAvailable";
 
-    public static enum DeviceType { Default, Generic, OculusVR };
+    /** {@link StereoDevice} type used for {@link StereoDeviceFactory#createFactory(DeviceType) createFactory(type)}. */
+    public static enum DeviceType {
+        /**
+         * Auto selection of device in the following order:
+         * <ol>
+         *   <li>{@link DeviceType#OculusVR}</li>
+         *   <li>{@link DeviceType#Generic}</li>
+         * </ol>
+         */
+        Default,
+        /**
+         * Generic software implementation.
+         */
+        Generic,
+        /**
+         * OculusVR implementation.
+         */
+        OculusVR
+    };
 
     public static StereoDeviceFactory createDefaultFactory() {
         final ClassLoader cl = StereoDeviceFactory.class.getClassLoader();
diff --git a/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java b/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java
index 30559924d..36e8bc5a5 100644
--- a/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java
+++ b/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDevice.java
@@ -41,6 +41,7 @@ import com.jogamp.opengl.math.FloatUtil;
 import com.jogamp.opengl.math.FovHVHalves;
 import com.jogamp.opengl.util.stereo.EyeParameter;
 import com.jogamp.opengl.util.stereo.StereoDevice;
+import com.jogamp.opengl.util.stereo.StereoDeviceFactory;
 import com.jogamp.opengl.util.stereo.StereoDeviceRenderer;
 import com.jogamp.opengl.util.stereo.StereoUtil;
 
@@ -207,16 +208,20 @@ public class GenericStereoDevice implements StereoDevice {
         final float[] DEFAULT_EYE_POSITION_OFFSET_STEREO        = { 0.0f, 0.3f,  3.0f };  // 0.3 up, 3 back
         final float[] DEFAULT_EYE_POSITION_OFFSET_MONO          = { 0.0f, 0.0f,  3.0f };  //         3 back
 
+        final DimensionImmutable surfaceSizeInPixel = new Dimension(1280, 800);
+        final float[] screenSizeInMeters = new float[] { 0.1498f, 0.0936f };
+        final float interpupillaryDistanceInMeters = 0.0635f;
+        final float pupilCenterFromScreenTopInMeters = screenSizeInMeters[1] / 2f;
         final float d2r = FloatUtil.PI / 180.0f;
         {
             config01Mono01 = new Config(
                             "Def01Mono01",
                             ShutterType.RollingTopToBottom,
-                            new Dimension(1280, 800),          // resolution
-                            new float[] { 0.1498f, 0.0936f },  // screenSize [m]
-                            new Dimension(1280, 800),          // eye textureSize
-                            0.0936f/2f,                        // pupilCenterFromScreenTop [m]
-                            0.0635f,                           // IPD [m]
+                            surfaceSizeInPixel,                // resolution
+                            screenSizeInMeters,                // screenSize [m]
+                            surfaceSizeInPixel,                // eye textureSize
+                            pupilCenterFromScreenTopInMeters,  // pupilCenterFromScreenTop [m]
+                            interpupillaryDistanceInMeters,    // IPD [m]
                             new int[] { 0 },                   // eye order
                             new EyeParameter[] {
                                 new EyeParameter(0, DEFAULT_EYE_POSITION_OFFSET_MONO,
@@ -231,11 +236,7 @@ public class GenericStereoDevice implements StereoDevice {
         }
 
         {
-            final DimensionImmutable surfaceSizeInPixel = new Dimension(1280, 800);
-            final float[] screenSizeInMeters = new float[] { 0.1498f, 0.0936f };
             final DimensionImmutable eyeTextureSize = new Dimension(surfaceSizeInPixel.getWidth()/2, surfaceSizeInPixel.getHeight());
-            final float interpupillaryDistanceInMeters = 0.0635f;
-            final float pupilCenterFromScreenTopInMeters = screenSizeInMeters[1] / 2f;
             final float[] horizPupilCenterFromLeft = Config.getHorizPupilCenterFromLeft(screenSizeInMeters[0], interpupillaryDistanceInMeters);
             final float vertPupilCenterFromTop = Config.getVertPupilCenterFromTop(screenSizeInMeters[1], pupilCenterFromScreenTopInMeters);
             final float fovy = 45f;
@@ -249,7 +250,7 @@ public class GenericStereoDevice implements StereoDevice {
                             surfaceSizeInPixel,                // resolution
                             screenSizeInMeters,                // screenSize [m]
                             eyeTextureSize,                    // eye textureSize
-                            0.0936f/2f,                        // pupilCenterFromScreenTop [m]
+                            pupilCenterFromScreenTopInMeters,  // pupilCenterFromScreenTop [m]
                             interpupillaryDistanceInMeters,    // IPD [m]
                             new int[] { 0, 1 },                // eye order
                             new EyeParameter[] {
@@ -274,11 +275,7 @@ public class GenericStereoDevice implements StereoDevice {
                 if(StereoDevice.DEBUG) { System.err.println("Caught: "+t.getMessage()); t.printStackTrace(); }
             }
 
-            final DimensionImmutable surfaceSizeInPixel = new Dimension(1280, 800);
-            final float[] screenSizeInMeters = new float[] { 0.1498f, 0.0936f };
             final DimensionImmutable eyeTextureSize = new Dimension(1122, 1553);
-            final float interpupillaryDistanceInMeters = 0.0635f;
-            final float pupilCenterFromScreenTopInMeters = screenSizeInMeters[1] / 2f;
             final float[] horizPupilCenterFromLeft = Config.getHorizPupilCenterFromLeft(screenSizeInMeters[0], interpupillaryDistanceInMeters);
             final float vertPupilCenterFromTop = Config.getVertPupilCenterFromTop(screenSizeInMeters[1], pupilCenterFromScreenTopInMeters);
             final float fovy = 129f;
@@ -313,6 +310,7 @@ public class GenericStereoDevice implements StereoDevice {
         configs = new Config[] { config01Mono01, config02StereoSBS01, config03StereoSBSLense01 };
     }
 
+    private final StereoDeviceFactory factory;
     public final int deviceIndex;
     public final Config config;
 
@@ -321,7 +319,8 @@ public class GenericStereoDevice implements StereoDevice {
 
     private boolean sensorsStarted = false;
 
-    public GenericStereoDevice(final int deviceIndex, final StereoDevice.Config customConfig) {
+    public GenericStereoDevice(final StereoDeviceFactory factory, final int deviceIndex, final StereoDevice.Config customConfig) {
+        this.factory = factory;
         this.deviceIndex = deviceIndex;
 
         if( customConfig instanceof GenericStereoDevice.Config) {
@@ -341,6 +340,9 @@ public class GenericStereoDevice implements StereoDevice {
     }
 
     @Override
+    public final StereoDeviceFactory getFactory() { return factory; }
+
+    @Override
     public String toString() {
         return "GenericStereoDevice["+config+", surfacePos "+surfacePos+"]";
     }
@@ -431,26 +433,34 @@ public class GenericStereoDevice implements StereoDevice {
                                           defaultEyeParam.distNoseToPupilX, defaultEyeParam.distMiddleToPupilY, defaultEyeParam.eyeReliefZ);
        }
 
+       final boolean usePP = null != config.distortionMeshProducer && 0 != distortionBits; // use post-processing
+
        final RectangleImmutable[] eyeViewports = new RectangleImmutable[eyeParam.length];
        final DimensionImmutable eyeTextureSize = config.eyeTextureSize;
        final DimensionImmutable totalTextureSize;
        if( 1 < eyeParam.length ) {
            // Stereo SBS
            totalTextureSize = new Dimension(eyeTextureSize.getWidth()*2, eyeTextureSize.getHeight());
+
            if( 1 == textureCount ) { // validated in ctor below!
                eyeViewports[0] = new Rectangle(0, 0,
-                       totalTextureSize.getWidth() / 2, totalTextureSize.getHeight());
+                                               eyeTextureSize.getWidth(), eyeTextureSize.getHeight());
 
-               eyeViewports[1] = new Rectangle((totalTextureSize.getWidth() + 1) / 2, 0,
-                       totalTextureSize.getWidth() / 2, totalTextureSize.getHeight());
+               eyeViewports[1] = new Rectangle(eyeTextureSize.getWidth(), 0,
+                                               eyeTextureSize.getWidth(), eyeTextureSize.getHeight());
            } else {
                eyeViewports[0] = new Rectangle(0, 0, eyeTextureSize.getWidth(), eyeTextureSize.getHeight());
-               eyeViewports[1] = eyeViewports[0];
+               if( usePP ) {
+                   eyeViewports[1] = eyeViewports[0];
+               } else {
+                   eyeViewports[1] = new Rectangle(eyeTextureSize.getWidth(), 0,
+                                                   eyeTextureSize.getWidth(), eyeTextureSize.getHeight());
+               }
            }
        } else {
            // Mono
            totalTextureSize = eyeTextureSize;
-           eyeViewports[0] = new Rectangle(0, 0, totalTextureSize.getWidth(), totalTextureSize.getHeight());
+           eyeViewports[0] = new Rectangle(0, 0, eyeTextureSize.getWidth(), eyeTextureSize.getHeight());
        }
        return new GenericStereoDeviceRenderer(this, distortionBits, textureCount, eyePositionOffset, eyeParam, pixelsPerDisplayPixel, textureUnit,
                                               eyeTextureSize, totalTextureSize, eyeViewports);
diff --git a/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDeviceFactory.java b/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDeviceFactory.java
index a59e8d833..f2fa74743 100644
--- a/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDeviceFactory.java
+++ b/src/jogl/classes/jogamp/opengl/util/stereo/GenericStereoDeviceFactory.java
@@ -38,6 +38,6 @@ public class GenericStereoDeviceFactory extends StereoDeviceFactory {
 
     @Override
     public final StereoDevice createDevice(final int deviceIndex, final StereoDevice.Config config, final boolean verbose) {
-        return new GenericStereoDevice(deviceIndex, config);
+        return new GenericStereoDevice(this, deviceIndex, config);
     }
 }