summaryrefslogtreecommitdiffstats
path: root/src/java/com/jogamp/openal/ALFactory.java
blob: ecfdb2b747b6cc5ca0d747aa3eae919df480522c (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
/**
 * Copyright (c) 2003-2005 Sun Microsystems, Inc. All  Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * -Redistribution of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * -Redistribution 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.
 *
 * Neither the name of Sun Microsystems, Inc. or the names of contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * This software is provided "AS IS," without a warranty of any kind.
 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
 * ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS
 * LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A
 * RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
 * IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT
 * OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR
 * PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS
 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 *
 * You acknowledge that this software is not designed or intended for use in the
 * design, construction, operation or maintenance of any nuclear facility.
 */

package com.jogamp.openal;

import jogamp.openal.ALCImpl;
import jogamp.openal.ALExtImpl;
import jogamp.openal.ALImpl;
import jogamp.openal.Debug;

import com.jogamp.common.os.Platform;
import com.jogamp.common.util.PropertyAccess;

/**
 * This class provides factory methods for generating AL and ALC objects.
 *
 * <p>
 * Select preferred OpenAL native library type via system properties,
 * i.e. System-OpenAL or bundled Soft-OpenAL.<br/>
 * If the preferred choice fails, implementation falls back to the other.
 * <PRE>
    -Djoal.openal.lib=auto     Prefer System-OpenAL over bundled Soft-OpenAL for OSX. Prefer bundled Soft-OpenAL over System-OpenAL for all others. This is the default.
    -Djoal.openal.lib=system   Prefer System-OpenAL over bundled Soft-OpenAL for all.
    -Djoal.openal.lib=soft     Prefer bundled Soft-OpenAL over System-OpenAL for all.
   </PRE>
 * Note: You may use the 'jnlp.' prefix, allowing using above property names w/ Applets and WebStart,
 * e.g. 'jnlp.joal.openal.lib=system'.
 * </p>
 *
 * @author Athomas Goldberg, Kenneth Russell, et.al.
 */
public class ALFactory {
  public static final boolean DEBUG = Debug.debug("Factory");
  /** If true, prefer System-OpenAL, otherwise bundled Soft-OpenAL (default). */
  public static final boolean PREFER_SYSTEM_OPENAL;

  static {
      Platform.initSingleton();
      final String choice = PropertyAccess.getProperty("joal.openal.lib", true);
      boolean useSystem = false; // default on all systems
      if( null != choice ) {
          if( choice.equals("system") ) {
              useSystem = true;
          } else if( choice.equals("soft") ) {
              useSystem = false;
          }
      }
      PREFER_SYSTEM_OPENAL = useSystem;
  }

  private static boolean initialized = false;
  private static AL al;
  private static ALC alc;
  private static ALExt alext;

  private ALFactory() {}

  private static synchronized void initialize() throws ALException {
    try {
      if (!initialized) {
        if(null == ALImpl.getALProcAddressTable()) {
            throw new ALException("AL not initialized (ProcAddressTable null)");
        }
        initialized = true;
        if(DEBUG) {
            System.err.println("AL initialized");
        }
      }
    } catch (final UnsatisfiedLinkError e) {
      throw new ALException(e);
    } catch (final ExceptionInInitializerError er) {
	  throw new ALException(er);
    }
  }

  /**
   * If the system property <code>joal.SystemOpenAL</code> is set
   * @return
   * @throws ALException
   */
  public static boolean getPreferSystemOpenAL() throws ALException {
    initialize();
    return PREFER_SYSTEM_OPENAL;
  }

  /**
   * Get the default AL object. This object is used to access most of the
   * OpenAL functionality.
   *
   * @return the AL object
   */
  public static AL getAL() throws ALException {
    initialize();
    if (al == null) {
        al = new ALImpl();
    }
    return al;
  }

  /**
   * Get the default ALC object. This object is used to access most of the
   * OpenAL context functionality.
   *
   * @return the ALC object
   */
  public static ALC getALC() throws ALException{
    initialize();
    if (alc == null) {
        alc = new ALCImpl();
    }
    return alc;
  }

  /**
   * Get the default ALExt object. This object is used to access most of the
   * OpenAL extension functionality.
   *
   * @return the ALExt object
   */
  public static ALExt getALExt() throws ALException{
    initialize();
    if (alext == null) {
        alext = new ALExtImpl();
    }
    return alext;
  }
}