aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/opengl/util/stereo/StereoDeviceFactory.java
blob: 105fe6c70a3ee737c674f5e95e7916662caa7129 (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
/**
 * 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;

import java.lang.ref.WeakReference;
import java.util.ArrayList;

import com.jogamp.common.util.ReflectionUtil;
import com.jogamp.nativewindow.NativeWindowFactory;

/**
 * Platform agnostic {@link StereoDevice} factory.
 * <p>
 * To implement a new {@link StereoDevice}, the following interfaces/classes must be implemented:
 * <ul>
 *   <li>{@link StereoDeviceFactory}</li>
 *   <li>{@link StereoDevice}</li>
 *   <li>{@link StereoDeviceRenderer}</li>
 * </ul>
 * </p>
 */
public abstract class StereoDeviceFactory {
    private static final String OVRStereoDeviceClazzName = "jogamp.opengl.oculusvr.OVRStereoDeviceFactory";
    private static final String GenericStereoDeviceClazzName = com.jogamp.opengl.util.stereo.generic.GenericStereoDeviceFactory.class.getName();
    private static final String isAvailableMethodName = "isAvailable";
    static {
        NativeWindowFactory.addCustomShutdownHook(false /* head */, new Runnable() {
           @Override
           public void run() {
               shutdownAll();
           }
        });
    }

    /** {@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 DK1 implementation.
         */
        OculusVR,
        /**
         * OculusVR DK2 implementation.
         */
        OculusVR_DK2
    };

    public static StereoDeviceFactory createDefaultFactory() {
        final ClassLoader cl = StereoDeviceFactory.class.getClassLoader();
        StereoDeviceFactory sink = createFactory(cl, OVRStereoDeviceClazzName);
        if( null == sink ) {
            sink = createFactory(cl, GenericStereoDeviceClazzName);
        }
        return sink;
    }

    public static StereoDeviceFactory createFactory(final DeviceType type) {
        final String className;
        switch( type ) {
            case Default: return createDefaultFactory();
            case Generic: className = GenericStereoDeviceClazzName; break;
            case OculusVR: className = OVRStereoDeviceClazzName; break;
            default: throw new InternalError("Unsupported type "+type);
        }
        final ClassLoader cl = StereoDeviceFactory.class.getClassLoader();
        return createFactory(cl, className);
    }

    public static StereoDeviceFactory createFactory(final ClassLoader cl, final String implName) {
        StereoDeviceFactory res = null;
        try {
            if(((Boolean)ReflectionUtil.callStaticMethod(implName, isAvailableMethodName, null, null, cl)).booleanValue()) {
                res = (StereoDeviceFactory) ReflectionUtil.createInstance(implName, cl);
            }
        } catch (final Throwable t) { if(StereoDevice.DEBUG) { System.err.println("Caught "+t.getClass().getName()+": "+t.getMessage()); t.printStackTrace(); } }
        if( null != res ) {
            addFactory2List(res);
        }
        return res;
    }

    /**
     *
     * @param deviceIndex
     * @param config optional custom configuration, matching the implementation, i.e. {@link StereoDeviceConfig.GenericStereoDeviceConfig}.
     * @param verbose
     * @return
     */
    public final StereoDevice createDevice(final int deviceIndex, final StereoDeviceConfig config, final boolean verbose) {
        final StereoDevice device = createDeviceImpl(deviceIndex, config, verbose);
        if( null != device ) {
            addDevice2List(device);
        }
        return device;
    }
    protected abstract StereoDevice createDeviceImpl(final int deviceIndex, final StereoDeviceConfig config, final boolean verbose);

    /**
     * Returns {@code true}, if instance is created and not {@link #shutdown()}
     * otherwise returns {@code false}.
     */
    public abstract boolean isValid();

    /**
     * Shutdown factory if {@link #isValid() valid}.
     */
    public abstract void shutdown();

    private static final ArrayList<WeakReference<StereoDeviceFactory>> factoryList = new ArrayList<WeakReference<StereoDeviceFactory>>();
    private static void addFactory2List(final StereoDeviceFactory factory) {
        synchronized(factoryList) {
            // GC before add
            int i=0;
            while( i < factoryList.size() ) {
                if( null == factoryList.get(i).get() ) {
                    factoryList.remove(i);
                } else {
                    i++;
                }
            }
            factoryList.add(new WeakReference<StereoDeviceFactory>(factory));
        }
    }
    private static final ArrayList<WeakReference<StereoDevice>> deviceList = new ArrayList<WeakReference<StereoDevice>>();
    private static void addDevice2List(final StereoDevice device) {
        synchronized(deviceList) {
            // GC before add
            int i=0;
            while( i < deviceList.size() ) {
                if( null == deviceList.get(i).get() ) {
                    deviceList.remove(i);
                } else {
                    i++;
                }
            }
            deviceList.add(new WeakReference<StereoDevice>(device));
        }
    }

    private final static void shutdownAll() {
        shutdownDevices();
        shutdownFactories();
    }
    private final static void shutdownFactories() {
        while( 0 < factoryList.size() ) {
            final StereoDeviceFactory f = factoryList.remove(0).get();
            if( null != f && f.isValid() ) {
                f.shutdown();
            }
        }
    }
    private final static void shutdownDevices() {
        while( 0 < deviceList.size() ) {
            final StereoDevice d = deviceList.remove(0).get();
            if( null != d && d.isValid() ) {
                d.dispose();
            }
        }
    }
}