aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/opengl/util/stereo/generic/GenericStereoDeviceConfig.java
blob: 44129de025ac37897f19557f8d33079f0e3431cb (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
/**
 * Copyright 2015 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 java.util.Arrays;

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

import com.jogamp.nativewindow.util.DimensionImmutable;
import com.jogamp.opengl.util.stereo.EyeParameter;
import com.jogamp.opengl.util.stereo.StereoDeviceConfig;
import com.jogamp.opengl.util.stereo.StereoDeviceRenderer;
import com.jogamp.opengl.util.stereo.StereoUtil;
import com.jogamp.opengl.util.stereo.StereoDevice;

/**
 * Configuration for {@link GenericStereoDevice}s.
 */
public class GenericStereoDeviceConfig extends StereoDeviceConfig {
    public static enum ShutterType {
        Global, RollingLeftToRight, RollingRightToLeft, RollingTopToBottom
    }
    public GenericStereoDeviceConfig(final String name,
                  final GenericStereoDeviceConfig.ShutterType shutterType,
                  final DimensionImmutable surfaceSizeInPixels,
                  final float[] screenSizeInMeters,
                  final DimensionImmutable[/*pre-eye*/] eyeTextureSize,
                  final float pupilCenterFromScreenTopInMeters,
                  final float interpupillaryDistanceInMeters,
                  final int[] eyeRenderOrder,
                  final EyeParameter[] defaultEyeParam,
                  final int supportedSensorBits,
                  final DistortionMesh.Producer distortionMeshProducer,
                  final int supportedDistortionBits,
                  final int recommendedDistortionBits,
                  final int minimumDistortionBits
                  ) {
        if( eyeRenderOrder.length != defaultEyeParam.length ) {
            throw new IllegalArgumentException("eye arrays of different length");
        }
        this.name = name;
        this.shutterType = shutterType;
        this.surfaceSizeInPixels = surfaceSizeInPixels;
        this.screenSizeInMeters = screenSizeInMeters;
        this.eyeTextureSizes = eyeTextureSize;
        this.pupilCenterFromScreenTopInMeters = pupilCenterFromScreenTopInMeters;
        this.interpupillaryDistanceInMeters = interpupillaryDistanceInMeters;
        this.eyeRenderOrder = eyeRenderOrder;
        this.defaultEyeParam = defaultEyeParam;
        this.supportedSensorBits = supportedSensorBits;
        this.distortionMeshProducer = distortionMeshProducer;
        this.supportedDistortionBits = supportedDistortionBits;
        this.recommendedDistortionBits = recommendedDistortionBits;
        this.minimumDistortionBits = minimumDistortionBits;
        this.pupilCenterFromTopLeft = new float[2][2];
        calcPupilCenterFromTopLeft();
    }
    /** A variation w/ different surface/screen specs */
    public GenericStereoDeviceConfig(final GenericStereoDeviceConfig source,
                  final DimensionImmutable surfaceSizeInPixels,
                  final float[] screenSizeInMeters,
                  final DimensionImmutable[/*pre-eye*/] eyeTextureSize) {
        this.name = source.name;
        this.shutterType = source.shutterType;
        this.surfaceSizeInPixels = surfaceSizeInPixels;
        this.screenSizeInMeters = screenSizeInMeters;
        this.eyeTextureSizes = eyeTextureSize;
        this.pupilCenterFromScreenTopInMeters = source.pupilCenterFromScreenTopInMeters;
        this.interpupillaryDistanceInMeters = source.interpupillaryDistanceInMeters;
        this.eyeRenderOrder = source.eyeRenderOrder;
        this.defaultEyeParam = source.defaultEyeParam;
        this.supportedSensorBits = source.supportedSensorBits;
        this.distortionMeshProducer = source.distortionMeshProducer;
        this.supportedDistortionBits = source.supportedDistortionBits;
        this.recommendedDistortionBits = source.recommendedDistortionBits;
        this.minimumDistortionBits = source.minimumDistortionBits;
        this.pupilCenterFromTopLeft = new float[2][2];
        calcPupilCenterFromTopLeft();
    }
    private void calcPupilCenterFromTopLeft() {
        final float visibleWidthOfOneEye = 0.5f * screenSizeInMeters[0];
        final float leftPupilCenterFromLeftInMeters = ( screenSizeInMeters[0] - interpupillaryDistanceInMeters ) * 0.5f;
        final float rightPupilCenterFromMiddleInMeters = leftPupilCenterFromLeftInMeters + interpupillaryDistanceInMeters - visibleWidthOfOneEye;
        pupilCenterFromTopLeft[0][0] = leftPupilCenterFromLeftInMeters / visibleWidthOfOneEye;
        pupilCenterFromTopLeft[0][1] = pupilCenterFromScreenTopInMeters     / screenSizeInMeters[1];
        pupilCenterFromTopLeft[1][0] = rightPupilCenterFromMiddleInMeters / visibleWidthOfOneEye;
        pupilCenterFromTopLeft[1][1] =  pupilCenterFromTopLeft[0][1];
    }

    /**
     * One time lazy initialization before use.
     * @see #isInitialized()
     */
    public synchronized void init() {
        if( !isInitialized ) {
            if( null != distortionMeshProducer ) {
                final float[] eyeReliefInMeters = new float[defaultEyeParam.length];
                if( 0 < defaultEyeParam.length ) {
                    eyeReliefInMeters[0] = defaultEyeParam[0].eyeReliefZ;
                }
                if( 1 < defaultEyeParam.length ) {
                    eyeReliefInMeters[1] = defaultEyeParam[1].eyeReliefZ;
                }
                distortionMeshProducer.init(this, eyeReliefInMeters);
            }
            isInitialized = true;
        }
    }
    /**
     * Returns {@code true} if {@link #init() initialized}, otherwise {@code false}.
     * @see #init()
     */
    public final boolean isInitialized() { return isInitialized; }

    @Override
    public String toString() { return "StereoConfig["+name+", shutter "+shutterType+", surfaceSize "+surfaceSizeInPixels+
                               ", screenSize "+screenSizeInMeters[0]+" x "+screenSizeInMeters[0]+
                               " [m], eyeTexSize "+Arrays.toString(eyeTextureSizes)+", IPD "+interpupillaryDistanceInMeters+
                               " [m], eyeParam "+Arrays.toString(defaultEyeParam)+
                               ", distortionBits[supported ["+StereoUtil.distortionBitsToString(supportedDistortionBits)+
                                              "], recommended ["+StereoUtil.distortionBitsToString(recommendedDistortionBits)+
                                              "], minimum ["+StereoUtil.distortionBitsToString(minimumDistortionBits)+"]]"+
                               ", sensorBits[supported ["+StereoUtil.sensorBitsToString(supportedSensorBits)+"]]]";
    }

    /** Configuration Name */
    public final String name;
    public final GenericStereoDeviceConfig.ShutterType shutterType;

    public final DimensionImmutable surfaceSizeInPixels;
    public final float[] screenSizeInMeters;
    /** Texture size per eye */
    public final DimensionImmutable[/*pre-eye*/] eyeTextureSizes;

    /** Vertical distance from pupil to screen-top in meters */
    public final float pupilCenterFromScreenTopInMeters;
    /** Horizontal interpupillary distance (IPD) in meters */
    public final float interpupillaryDistanceInMeters;
    /**
     * Pupil center from top left per eye, ranging from [0..1], maybe used to produce FovHVHalves,
     * see {@link #getHorizPupilCenterFromLeft(float, float)} and {@link #getVertPupilCenterFromTop(float, float)}.
     */
    public final float[/*per-eye*/][/*xy*/] pupilCenterFromTopLeft;
    public final int[] eyeRenderOrder;
    public final EyeParameter[] defaultEyeParam;

    /** Supported sensor bits, see {@link StereoDevice#SENSOR_ORIENTATION}. */
    public final int supportedSensorBits;

    public final DistortionMesh.Producer distortionMeshProducer;

    /** Supported distortion bits, see {@link StereoDeviceRenderer#DISTORTION_BARREL}. */
    public final int supportedDistortionBits;
    /** Recommended distortion bits, see {@link StereoDeviceRenderer.DISTORTION_BARREL}. */
    public final int recommendedDistortionBits;
    /** Required distortion bits, see {@link StereoDeviceRenderer.DISTORTION_BARREL}. */
    public final int minimumDistortionBits;

    private boolean isInitialized = false;
}