aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/opengl/util/stereo/generic/GenericStereoDeviceFactory.java
blob: a25e923dcbf4076eba7764dadacf329469a3f7bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/**
 * Copyright 2014 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.util.stereo.generic;

import jogamp.opengl.util.stereo.DistortionMesh;
import jogamp.opengl.util.stereo.GenericStereoDevice;

import com.jogamp.common.util.ReflectionUtil;
import com.jogamp.math.FloatUtil;
import com.jogamp.math.FovHVHalves;
import com.jogamp.math.Vec3f;
import com.jogamp.nativewindow.util.Dimension;
import com.jogamp.nativewindow.util.DimensionImmutable;
import com.jogamp.opengl.util.stereo.EyeParameter;
import com.jogamp.opengl.util.stereo.StereoDevice;
import com.jogamp.opengl.util.stereo.StereoDeviceConfig;
import com.jogamp.opengl.util.stereo.StereoDeviceFactory;
import com.jogamp.opengl.util.stereo.StereoDeviceRenderer;
import com.jogamp.opengl.util.stereo.StereoUtil;

public class GenericStereoDeviceFactory extends StereoDeviceFactory {

    /**
     * Create a generic monoscopic {@link GenericStereoDeviceConfig generic device config}.
     * @param name
     * @param surfaceSizeInPixel
     * @param screenSizeInMeters
     * @param defaultEyePositionOffset
     */
    public static GenericStereoDeviceConfig createMono(final String name,
                             final DimensionImmutable surfaceSizeInPixel, final float[] screenSizeInMeters,
                             final Vec3f defaultEyePositionOffset) {
        final float pupilCenterFromScreenTopInMeters = screenSizeInMeters[1] / 2f;
        final float d2r = FloatUtil.PI / 180.0f;
        return new GenericStereoDeviceConfig(
                        name,
                        GenericStereoDeviceConfig.ShutterType.RollingTopToBottom,
                        surfaceSizeInPixel,                // resolution
                        screenSizeInMeters,                // screenSize [m]
                        new DimensionImmutable[] { surfaceSizeInPixel }, // eye textureSize
                        pupilCenterFromScreenTopInMeters,  // pupilCenterFromScreenTop [m]
                        0f,                                // IPD [m]
                        new int[] { 0 },                   // eye order
                        new EyeParameter[] {
                            new EyeParameter(0, defaultEyePositionOffset,
                                             // degrees: 45/2 l, 45/2 r, 45/2 * aspect t, 45/2 * aspect b
                                             FovHVHalves.byFovyRadianAndAspect(45f*d2r, 1280f / 800f),
                                             0f /* distNoseToPupil */, 0f /* verticalDelta */, 0f /* eyeReliefInMeters */) },
                        0,      // supported sensor bits
                        null, // mash producer distortion bits
                        0,    // supported distortion bits
                        0,    // recommended distortion bits
                        0     // minimum distortion bits
                        );
    }

    /**
     * Create a generic homogenous side-by-side stereoscopic {@link GenericStereoDeviceConfig generic device config}.
     * @param name
     * @param surfaceSizeInPixel
     * @param screenSizeInMeters
     * @param interpupillaryDistanceInMeters
     * @param fovy
     * @param defaultEyePositionOffset
     */
    public static GenericStereoDeviceConfig createStereoSBS(final String name,
                             final DimensionImmutable surfaceSizeInPixel, final float[] screenSizeInMeters,
                             final float interpupillaryDistanceInMeters, final float fovy,
                             final Vec3f defaultEyePositionOffset) {
        final float pupilCenterFromScreenTopInMeters = screenSizeInMeters[1] / 2f;
        final float d2r = FloatUtil.PI / 180.0f;

        final DimensionImmutable eyeTextureSize = new Dimension(surfaceSizeInPixel.getWidth()/2, surfaceSizeInPixel.getHeight());
        final float[] horizPupilCenterFromLeft = StereoUtil.getHorizPupilCenterFromLeft(screenSizeInMeters[0], interpupillaryDistanceInMeters);
        final float vertPupilCenterFromTop = StereoUtil.getVertPupilCenterFromTop(screenSizeInMeters[1], pupilCenterFromScreenTopInMeters);
        final float aspect = (float)eyeTextureSize.getWidth() / (float)eyeTextureSize.getHeight();
        final FovHVHalves defaultSBSEyeFovLeft = FovHVHalves.byFovyRadianAndAspect(fovy * d2r, vertPupilCenterFromTop, aspect, horizPupilCenterFromLeft[0]);
        final FovHVHalves defaultSBSEyeFovRight = FovHVHalves.byFovyRadianAndAspect(fovy * d2r, vertPupilCenterFromTop, aspect, horizPupilCenterFromLeft[1]);

        return new GenericStereoDeviceConfig(
                        name,
                        GenericStereoDeviceConfig.ShutterType.RollingTopToBottom,
                        surfaceSizeInPixel,                // resolution
                        screenSizeInMeters,                // screenSize [m]
                        new DimensionImmutable[] { eyeTextureSize, eyeTextureSize }, // eye textureSize
                        pupilCenterFromScreenTopInMeters,  // pupilCenterFromScreenTop [m]
                        interpupillaryDistanceInMeters,    // IPD [m]
                        new int[] { 0, 1 },                // eye order
                        new EyeParameter[] {
                            new EyeParameter(0, defaultEyePositionOffset, defaultSBSEyeFovLeft,
                                          interpupillaryDistanceInMeters/2f /* distNoseToPupil */, 0f /* verticalDelta */, 0.010f /* eyeReliefInMeters */),
                            new EyeParameter(1, defaultEyePositionOffset, defaultSBSEyeFovRight,
                                         -interpupillaryDistanceInMeters/2f /* distNoseToPupil */, 0f /* verticalDelta */, 0.010f /* eyeReliefInMeters */) },
                        0,      // supported sensor bits
                        null,   // mash producer distortion bits
                        0,      // supported distortion bits
                        0,      // recommended distortion bits
                        0       // minimum distortion bits
                        );

    }

    /**
     * Create a generic lense distorted side-by-side stereoscopic {@link GenericStereoDeviceConfig generic device config}.
     * @param name
     * @param surfaceSizeInPixel
     * @param screenSizeInMeters
     * @param interpupillaryDistanceInMeters
     * @param fovy
     * @param eyeTextureSize
     * @param defaultEyePositionOffset
     */
    public static GenericStereoDeviceConfig createStereoSBSLense(final String name,
                             final DimensionImmutable surfaceSizeInPixel, final float[] screenSizeInMeters,
                             final float interpupillaryDistanceInMeters, final float fovy,
                             final DimensionImmutable eyeTextureSize,
                             final Vec3f defaultEyePositionOffset) {
        DistortionMesh.Producer lenseDistMeshProduce = null;
        try {
            lenseDistMeshProduce =
                (DistortionMesh.Producer)
                ReflectionUtil.createInstance("jogamp.opengl.oculusvr.stereo.lense.DistortionMeshProducer", GenericStereoDevice.class.getClassLoader());
        } catch (final Throwable t) {
            if(StereoDevice.DEBUG) { System.err.println("Caught: "+t.getMessage()); t.printStackTrace(); }
        }
        if( null == lenseDistMeshProduce ) {
            return null;
        }
        final float pupilCenterFromScreenTopInMeters = screenSizeInMeters[1] / 2f;
        final float d2r = FloatUtil.PI / 180.0f;

        final float[] horizPupilCenterFromLeft = StereoUtil.getHorizPupilCenterFromLeft(screenSizeInMeters[0], interpupillaryDistanceInMeters);
        final float vertPupilCenterFromTop = StereoUtil.getVertPupilCenterFromTop(screenSizeInMeters[1], pupilCenterFromScreenTopInMeters);
        final float aspect = (float)eyeTextureSize.getWidth() / (float)eyeTextureSize.getHeight();
        final FovHVHalves defaultSBSEyeFovLeft = FovHVHalves.byFovyRadianAndAspect(fovy * d2r, vertPupilCenterFromTop, aspect, horizPupilCenterFromLeft[0]);
        final FovHVHalves defaultSBSEyeFovRight = FovHVHalves.byFovyRadianAndAspect(fovy * d2r, vertPupilCenterFromTop, aspect, horizPupilCenterFromLeft[1]);

        return new GenericStereoDeviceConfig(
                        name,
                        GenericStereoDeviceConfig.ShutterType.RollingTopToBottom,
                        surfaceSizeInPixel,                // resolution
                        screenSizeInMeters,                // screenSize [m]
                        new DimensionImmutable[] { eyeTextureSize, eyeTextureSize }, // eye textureSize
                        pupilCenterFromScreenTopInMeters,  // pupilCenterFromScreenTop [m]
                        interpupillaryDistanceInMeters,    // IPD [m]
                        new int[] { 0, 1 },                // eye order
                        new EyeParameter[] {
                            new EyeParameter(0, defaultEyePositionOffset, defaultSBSEyeFovLeft,
                                          interpupillaryDistanceInMeters/2f /* distNoseToPupil */, 0f /* verticalDelta */, 0.010f /* eyeReliefInMeters */),
                            new EyeParameter(1, defaultEyePositionOffset, defaultSBSEyeFovRight,
                                         -interpupillaryDistanceInMeters/2f /* distNoseToPupil */, 0f /* verticalDelta */, 0.010f /* eyeReliefInMeters */) },
                        0,      // supported sensor bits
                        lenseDistMeshProduce,
                        // supported distortion bits
                        StereoDeviceRenderer.DISTORTION_BARREL | StereoDeviceRenderer.DISTORTION_CHROMATIC | StereoDeviceRenderer.DISTORTION_VIGNETTE,
                        // recommended distortion bits
                        StereoDeviceRenderer.DISTORTION_BARREL | StereoDeviceRenderer.DISTORTION_CHROMATIC | StereoDeviceRenderer.DISTORTION_VIGNETTE,
                        // minimum distortion bits
                        StereoDeviceRenderer.DISTORTION_BARREL
                        );
    }


    public static boolean isAvailable() {
        return true;
    }

    @Override
    protected final StereoDevice createDeviceImpl(final int deviceIndex, final StereoDeviceConfig config, final boolean verbose) {
        return new GenericStereoDevice(this, deviceIndex, config);
    }

    private boolean isValid = true;

    @Override
    public boolean isValid() {
        return isValid;
    }

    @Override
    public final void shutdown() {
        if( isValid ) {
            // NOP
            isValid = false;
        }
    }
}