Improve NativeLibraryLoader

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

@@ -285,7 +285,7 @@ public void initialize(AppSettings settings) {
         logger.log(Level.INFO, getBuildInfo());
         if (!lowPermissions) {
             if (NativeLibraryLoader.isUsingNativeBullet()) {
-                NativeLibraryLoader.loadNativeLibrary("bulletjme", true);
+                NativeLibraryLoader.loadNativeLibrary(NativeLibraries.BulletJme.getName(), true);
             }
         }
     }

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

@@ -0,0 +1,235 @@
+/*
+ * Copyright (c) 2009-2023 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * 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.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "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 THE COPYRIGHT OWNER 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.
+ */
+package com.jme3.system;
+
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.Consumer;
+
+/**
+ * Defines default native libraries that are loaded by
+ * {@link NativeLibraryLoader}.
+ *
+ * @author Ali-RS
+ */
+public enum NativeLibraries {
+
+    // Note: LWJGL 3 handles its native library extracting & loading using
+    // its own SharedLibraryLoader.
+
+    /**
+     * Native lwjgl libraries for LWJGL 2 required by jme3-lwjgl backend.
+     */
+    Lwjgl(new LibraryInfo("lwjgl", libPath ->
+            // Delegate loading to lwjgl.
+            System.setProperty("org.lwjgl.librarypath",
+                    Paths.get(libPath).getParent().toAbsolutePath().toString()))
+            .addNativeVariant(Platform.Windows32, "lwjgl.dll")
+            .addNativeVariant(Platform.Windows64, "lwjgl64.dll")
+            .addNativeVariant(Platform.Linux32, "liblwjgl.so")
+            .addNativeVariant(Platform.Linux64, "liblwjgl64.so")
+            .addNativeVariant(Platform.MacOSX32, "liblwjgl.dylib")
+            .addNativeVariant(Platform.MacOSX64, "liblwjgl.dylib")
+    ),
+
+    // OpenAL for LWJGL 2
+    // For OSX: Need to add lib prefix when extracting
+    /**
+     * Native OpenAL audio libraries for LWJGL 2 required by jme3-lwjgl backend.
+     */
+    OpenAL(new LibraryInfo("openal")
+            .addNativeVariant(Platform.Windows32, "OpenAL32.dll")
+            .addNativeVariant(Platform.Windows64, "OpenAL64.dll")
+            .addNativeVariant(Platform.Linux32,   "libopenal.so")
+            .addNativeVariant(Platform.Linux64,   "libopenal64.so")
+            .addNativeVariant(Platform.MacOSX32,  "openal.dylib", "libopenal.dylib")
+            .addNativeVariant(Platform.MacOSX64,  "openal.dylib", "libopenal.dylib")
+    ),
+
+    /**
+     * Native bullet physics libraries required by Minie library.
+     */
+    BulletJme(new LibraryInfo("bulletjme")
+            .addNativeVariant(Platform.Windows32, "native/windows/x86/bulletjme.dll", "bulletjme-x86.dll")
+            .addNativeVariant(Platform.Windows64, "native/windows/x86_64/bulletjme.dll", "bulletjme-x86_64.dll")
+            .addNativeVariant(Platform.Windows_ARM64, "native/windows/arm64/bulletjme.dll", "bulletjme-arm64.dll")
+            .addNativeVariant(Platform.Linux32, "native/linux/x86/libbulletjme.so", "libbulletjme-x86.so")
+            .addNativeVariant(Platform.Linux64, "native/linux/x86_64/libbulletjme.so", "libbulletjme-x86_64.so")
+            .addNativeVariant(Platform.Linux_ARM32, "native/linux/arm32/libbulletjme.so", "libbulletjme-arm32.so")
+            .addNativeVariant(Platform.Linux_ARM64, "native/linux/arm64/libbulletjme.so", "libbulletjme-arm64.so")
+            .addNativeVariant(Platform.MacOSX32, "native/osx/x86/libbulletjme.dylib", "libbulletjme-x86.dylib")
+            .addNativeVariant(Platform.MacOSX64, "native/osx/x86_64/libbulletjme.dylib", "libbulletjme-x86_64.dylib")
+            .addNativeVariant(Platform.MacOSX_ARM64, "native/osx/arm64/libbulletjme.dylib", "libbulletjme-arm64.dylib")
+    ),
+
+    // For OSX: Need to rename extension jnilib -> dylib when extracting
+    /**
+     * Native JInput joystick libraries required by jme3-lwjgl backend.
+     */
+    JInput(new LibraryInfo("jinput", libPath ->
+            // Delegate loading to jinput.
+            System.setProperty("net.java.games.input.librarypath",
+                    Paths.get(libPath).getParent().toAbsolutePath().toString()))
+            .addNativeVariant(Platform.Windows32, "jinput-raw.dll")
+            .addNativeVariant(Platform.Windows64, "jinput-raw_64.dll")
+            .addNativeVariant(Platform.Linux32, "libjinput-linux.so")
+            .addNativeVariant(Platform.Linux64, "libjinput-linux64.so")
+            .addNativeVariant(Platform.MacOSX32, "libjinput-osx.jnilib", "libjinput-osx.dylib")
+            .addNativeVariant(Platform.MacOSX64, "libjinput-osx.jnilib", "libjinput-osx.dylib")
+    ),
+
+    /**
+     * Native JInput DirectX 8 auxiliary libraries required by jme3-lwjgl backend.
+     * (only required on Windows)
+     */
+    JInputDX8(new LibraryInfo("jinput-dx8")
+            .addNativeVariant(Platform.Windows32, "jinput-dx8.dll", null)
+            .addNativeVariant(Platform.Windows64, "jinput-dx8_64.dll", null)
+            .addNativeVariant(Platform.Linux32, null)
+            .addNativeVariant(Platform.Linux64, null)
+            .addNativeVariant(Platform.MacOSX32, null)
+            .addNativeVariant(Platform.MacOSX64, null)
+    );
+
+    private final LibraryInfo library;
+
+
+    NativeLibraries(LibraryInfo library) {
+        this.library = library;
+    }
+
+    /**
+     * Register native libraries on {@link NativeLibraryLoader} so we can load them
+     * later on via {@link NativeLibraryLoader#loadNativeLibrary(String, boolean)}.
+     */
+    public static void registerDefaultLibraries() {
+        Lwjgl.registerLibrary();
+        OpenAL.registerLibrary();
+        BulletJme.registerLibrary();
+        JInput.registerLibrary();
+        JInputDX8.registerLibrary();
+    }
+
+    public LibraryInfo getLibrary() {
+        return library;
+    }
+
+    /**
+     * @return the library name. This is effectively equivalent to the
+     * call {@link LibraryInfo#getName()}
+     */
+    public String getName() {
+        return library.getName();
+    }
+
+    /**
+     * Registers this library's native variants into {@link NativeLibraryLoader} that can
+     * be loaded later via {@link NativeLibraryLoader#loadNativeLibrary(String, boolean)}.
+     */
+    private void registerLibrary() {
+        library.getNativeVariants().forEach(NativeLibraryLoader::registerNativeLibrary);
+    }
+
+    /**
+     * A helper class that defines a native library by name, list of its native variants
+     * for target platforms and a load function used to load library from an absolute
+     * path after extracted by {@link NativeLibraryLoader}.
+     */
+    public static class LibraryInfo {
+
+        private final String name;
+        private final List<NativeLibrary> nativeVariants = new ArrayList<>();
+        private final Consumer<String> loadFunction;
+
+        /**
+         * Define a library by the specified name and a default load function
+         * that uses {@link System#load(String)} to load extracted native from
+         * absolute path.
+         * @param name The library name. (not null)
+         */
+        public LibraryInfo(String name) {
+            this(name, System::load);
+        }
+
+        /**
+         * Define a library by the specified name and specified load function
+         * that is used to load extracted native from an absolute path string.
+         *
+         * @param name The library name (not null)
+         * @param loadFunction The load function for loading library from
+         *                     an absolute path string. (not null)
+         */
+        public LibraryInfo(String name, Consumer<String> loadFunction) {
+            this.name = name;
+            this.loadFunction = loadFunction;
+        }
+
+        /**
+         * @return the library name.
+         */
+        public String getName() {
+            return name;
+        }
+
+        /**
+         * @return the list of native variants, each targeting a specific platform.
+         */
+        public List<NativeLibrary> getNativeVariants() {
+            return nativeVariants;
+        }
+
+        /**
+         * Adds a new native library that targets specified platform.
+         *
+         * @param platform The platform this library targets
+         * @param pathInNativesJar The path of native file inside library jar
+         * @return this
+         */
+        public LibraryInfo addNativeVariant(Platform platform, String pathInNativesJar) {
+            return addNativeVariant(platform, pathInNativesJar, null);
+        }
+
+        /**
+         * Adds a new native library that targets specified platform.
+         *
+         * @param platform The platform this library targets
+         * @param pathInNativesJar The path of native file inside library jar
+         * @param extractedAsFileName The filename that the library should be extracted as
+         * @return this
+         */
+        public LibraryInfo addNativeVariant(Platform platform, String pathInNativesJar, String extractedAsFileName) {
+             nativeVariants.add(new NativeLibrary(name, platform, pathInNativesJar, extractedAsFileName, loadFunction));
+             return this;
+        }
+    }
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2023 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -31,6 +31,8 @@
  */
 package com.jme3.system;
 
+import java.util.function.Consumer;
+
 /**
  * Holds information about a native library for a particular platform.
  * 
@@ -42,6 +44,7 @@ final class NativeLibrary {
     private final Platform platform;
     private final String pathInNativesJar;
     private final String extractedAsFileName;
+    private final Consumer<String> loadFunction;
 
     /**
      * Key for map to find a library for a name and platform.
@@ -76,6 +79,55 @@ public boolean equals(Object obj) {
             return true;
         }
     }
+
+    /**
+     * Create a new NativeLibrary. The extracted file name will be the same as
+     * in jar and will be loaded via {@link System#load(String)}.
+     *
+     * @param name The name of the library (not null)
+     * @param platform The platform associated to this native library (not null)
+     * @param pathInNativesJar The path to the library in the classpath (if it is null,
+     *                         the library loading will be ignored on this platform)
+     **/
+    public NativeLibrary(String name, Platform platform, String pathInNativesJar) {
+        this(name, platform, pathInNativesJar, null);
+    }
+
+    /**
+     * Create a new NativeLibrary. The extracted file will be loaded
+     * via {@link System#load(String)}.
+     *
+     * @param name The name of the library (not null)
+     * @param platform The platform associated to this native library (not null)
+     * @param pathInNativesJar The path to the library in the classpath (if it is null,
+     *                         the library loading will be ignored on this platform)
+     * @param extractedAsFileName The name that should be given to the extracted file
+     *                            (if set to null, then the filename in the natives
+     *                            jar shall be used)
+     */
+    public NativeLibrary(String name, Platform platform, String pathInNativesJar, String extractedAsFileName) {
+        this(name, platform, pathInNativesJar, extractedAsFileName, System::load);
+    }
+
+    /**
+     * Create a new NativeLibrary.
+     *
+     * @param name The name of the library (not null)
+     * @param platform The platform associated to this native library (not null)
+     * @param pathInNativesJar The path to the library in the classpath (if it is null,
+     *                         the library loading will be ignored on this platform)
+     * @param extractedAsFileName The name that should be given to the extracted file
+     *                            (if set to null, then the filename in the natives
+     *                            jar shall be used)
+     * @param loadFunction The function used to load the library from absolute path (not null)
+     */
+    public NativeLibrary(String name, Platform platform, String pathInNativesJar, String extractedAsFileName, Consumer<String> loadFunction) {
+        this.name = name;
+        this.platform = platform;
+        this.pathInNativesJar = pathInNativesJar;
+        this.extractedAsFileName = extractedAsFileName;
+        this.loadFunction = loadFunction;
+    }
 
     /**
      * The name of the library. 
@@ -90,7 +142,7 @@ public String getName() {
     /**
      * The OS + architecture combination for which this library
      * should be extracted.
-     * 
+     *
      * @return platform associated to this native library
      */
     public Platform getPlatform() {
@@ -99,12 +151,12 @@ public Platform getPlatform() {
 
     /**
      * The filename that the library should be extracted as.
-     * 
+     *
      * In some cases, this differs from the {@link #getPathInNativesJar() path in the natives jar},
      * since the names of the libraries specified in the jars are often incorrect.
      * If set to <code>null</code>, then the filename in the
      * natives jar shall be used.
-     * 
+     *
      * @return the name that should be given to the extracted file.
      */
     public String getExtractedAsName() {
@@ -113,30 +165,29 @@ public String getExtractedAsName() {
 
     /**
      * Path inside the natives jar or classpath where the library is located.
-     * 
+     *
      * This library must be compatible with the {@link #getPlatform() platform}
      * which this library is associated with.
-     * 
+     *
      * @return path to the library in the classpath
      */
     public String getPathInNativesJar() {
         return pathInNativesJar;
     }
 
     /**
-     * Create a new NativeLibrary.
+     * @return the load function used for loading this native library.
+     * It loads the native library from absolute path on disk.
+     * By default, it loads with {@link System#load(java.lang.String) }.
      */
-    public NativeLibrary(String name, Platform platform, String pathInNativesJar, String extractedAsFileName) {
-        this.name = name;
-        this.platform = platform;
-        this.pathInNativesJar = pathInNativesJar;
-        this.extractedAsFileName = extractedAsFileName;
+    public Consumer<String> getLoadFunction() {
+        return loadFunction;
     }
 
     /**
-     * Create a new NativeLibrary.
+     * @return key for map to find a library for a name and platform.
      */
-    public NativeLibrary(String name, Platform platform, String pathInNativesJar) {
-        this(name, platform, pathInNativesJar, null);
+    public Key getKey() {
+        return new NativeLibrary.Key(getName(), getPlatform());
     }
 }