refactor audio renderer handling and deprecate legacy methods

Author: riccardobl

jme3-android/src/main/java/com/jme3/system/android/JmeAndroidSystem.java

@@ -51,6 +51,18 @@ public JmeAndroidSystem(){
             });
         });
     }
+
+    /**
+     * Returns the default Android audio renderer type.
+     *
+     * @return the default Android audio renderer type
+     * @deprecated Use {@link AppSettings#getAudioRenderer()} and
+     * {@link AppSettings#OPENAL} instead.
+     */
+    @Deprecated
+    public String getAudioRendererType() {
+        return AppSettings.OPENAL;
+    }
 
     @Override
     public URL getPlatformAssetConfigURL() {

jme3-core/src/main/java/com/jme3/system/AppSettings.java

@@ -224,6 +224,11 @@ public final class AppSettings extends HashMap<String, Object> {
 
     public static final String ANGLE_GLES3 = "ANGLE_GLES3";
 
+    /**
+     * Use the default OpenAL renderer for the current platform.
+     *
+     * @see AppSettings#setAudioRenderer(java.lang.String)
+     */
     public static final String OPENAL = "OPENAL";
 
 
@@ -233,15 +238,14 @@ public final class AppSettings extends HashMap<String, Object> {
      * NOTE: Supports Android 2.2+ platforms.
      *
      * @see AppSettings#setAudioRenderer(java.lang.String)
-     * @deprecated This audio renderer has too many limitations. Use {@link #OPENAL} instead..
+     * @deprecated This audio renderer has too many limitations. Use {@link #OPENAL} instead.
      */
     @Deprecated
     public static final String ANDROID_MEDIAPLAYER = "MediaPlayer";
 
     /**
      * Use the OpenAL Soft based renderer for Android audio capabilities.
      * <p>
-     * This is the current default for Android platforms.
      * NOTE: Only to be used on Android 2.3+ platforms due to using OpenSL.
      *
      * @see AppSettings#setAudioRenderer(java.lang.String)
@@ -826,12 +830,13 @@ public void setCustomRenderer(Class<? extends JmeContext> clazz) {
     /**
      * Set the audio renderer to use. One of:<br>
      * <ul>
-     * <li>AppSettings.LWJGL_OPENAL - Default for LWJGL</li>
+     * <li>AppSettings.OPENAL - Default OpenAL renderer for the current platform</li>
+     * <li>AppSettings.LWJGL_OPENAL - Deprecated LWJGL OpenAL renderer identifier</li>
      * <li>AppSettings.JOAL</li>
      * <li>null - Disable audio</li>
      * </ul>
      * @param audioRenderer
-     * (Default: LWJGL)
+     * (Default: AppSettings.OPENAL)
      */
     public void setAudioRenderer(String audioRenderer) {
         putString("AudioRenderer", audioRenderer);
@@ -1266,7 +1271,7 @@ public boolean useJoysticks() {
     /**
      * Get the audio renderer
      *
-     * @return the audio renderer's name, for example "LWJGL"
+     * @return the audio renderer's name, for example "OPENAL"
      * @see #setAudioRenderer(java.lang.String)
      */
     public String getAudioRenderer() {

jme3-desktop/src/main/java/com/jme3/system/JmeDesktopSystem.java

@@ -257,18 +257,22 @@ public AudioRenderer newAudioRenderer(AppSettings settings) {
         AL al;
         ALC alc;
         EFX efx;
-        if (settings.getAudioRenderer().startsWith("LWJGL") || settings.getAudioRenderer().equals(AppSettings.OPENAL)) {
+        String audioRenderer = settings.getAudioRenderer();
+        if (audioRenderer == null) {
+            return null;
+        }
+        if (audioRenderer.startsWith("LWJGL") || AppSettings.OPENAL.equals(audioRenderer)) {
             al = newObject("com.jme3.audio.lwjgl.LwjglAL");
             alc = newObject("com.jme3.audio.lwjgl.LwjglALC");
             efx = newObject("com.jme3.audio.lwjgl.LwjglEFX");
-        } else if (settings.getAudioRenderer().startsWith("JOAL")) {
+        } else if (audioRenderer.startsWith("JOAL")) {
             al = newObject("com.jme3.audio.joal.JoalAL");
             alc = newObject("com.jme3.audio.joal.JoalALC");
             efx = newObject("com.jme3.audio.joal.JoalEFX");
         } else {
             throw new UnsupportedOperationException(
                     "Unrecognizable audio renderer specified: "
-                    + settings.getAudioRenderer());
+                    + audioRenderer);
         }
 
         if (al == null || alc == null || efx == null) {

jme3-lwjgl/src/main/java/com/jme3/system/lwjgl/LwjglContext.java

@@ -224,7 +224,8 @@ protected void loadNatives() {
         if (JmeSystem.isLowPermissions()) {
             return;
         }
-        if (AppSettings.LWJGL_OPENAL.equals(settings.getAudioRenderer())) {
+        String audioRenderer = settings.getAudioRenderer();
+        if (AppSettings.LWJGL_OPENAL.equals(audioRenderer) || AppSettings.OPENAL.equals(audioRenderer)) {
             NativeLibraryLoader.loadNativeLibrary(NativeLibraries.OpenAL.getName(), true);
         }
         if (settings.useJoysticks()) {