cleanup glfw mapper, and add SDL based joystick handling

Author: riccardobl

.gitignore

@@ -50,3 +50,4 @@ javadoc_deploy.pub
 !.vscode/settings.json
 !.vscode/JME_style.xml
 !.vscode/extensions.json
+joysticks-*.txt

gradle/libs.versions.toml

@@ -32,6 +32,7 @@ lwjgl3-jemalloc = { module = "org.lwjgl:lwjgl-jemalloc", version.ref = "lwjgl3"
 lwjgl3-openal   = { module = "org.lwjgl:lwjgl-openal",   version.ref = "lwjgl3" }
 lwjgl3-opencl   = { module = "org.lwjgl:lwjgl-opencl",   version.ref = "lwjgl3" }
 lwjgl3-opengl   = { module = "org.lwjgl:lwjgl-opengl",   version.ref = "lwjgl3" }
+lwjgl3-sdl      = { module = "org.lwjgl:lwjgl-sdl",      version.ref = "lwjgl3" }
 
 mokito-core = "org.mockito:mockito-core:3.12.4"
 

jme3-core/src/main/java/com/jme3/input/DefaultJoystickAxis.java

@@ -48,6 +48,7 @@ public class DefaultJoystickAxis implements JoystickAxis {
     private final boolean isAnalog;
     private final boolean isRelative;
     private float deadZone;
+    private float jitterThreshold = 0f;
 
     /**
      *  Creates a new joystick axis instance. Only used internally.
@@ -166,6 +167,12 @@ public void setDeadZone(float f) {
     public String toString() {
         return "JoystickAxis[name=" + name + ", parent=" + parent.getName() + ", id=" + axisIndex
                                     + ", logicalId=" + logicalId + ", isAnalog=" + isAnalog
-                                    + ", isRelative=" + isRelative + ", deadZone=" + deadZone + "]";
+                                    + ", isRelative=" + isRelative + ", deadZone=" + deadZone + 
+                                    ", jitterThreshold=" + jitterThreshold + "]";
+    }
+
+    @Override
+    public float getJitterThreshold() {
+        return jitterThreshold;
     }
 }

jme3-core/src/main/java/com/jme3/input/JoystickAxis.java

@@ -115,4 +115,15 @@ public interface JoystickAxis {
      * @return the radius of the dead zone
      */
     public float getDeadZone();
+
+
+    /**
+     * Returns the suggested jitter threshold for this axis. Movements with a delta
+     * smaller than this threshold will be ignored by the backend input system
+     * 
+     * @return the jitter threshold
+     */
+    public default float getJitterThreshold(){
+        return 0;
+    }
 }

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

@@ -268,6 +268,31 @@ public final class AppSettings extends HashMap<String, Object> {
      */
     public static final String JOAL = "JOAL";
 
+    /**
+     * Map gamepads to Xbox-like layout.
+     */
+    public static final String JOYSTICKS_XBOX_MAPPER = "JOYSTICKS_XBOX_MAPPER";
+
+    /**
+     * Map gamepads to an Xbox-like layout, with fallback to raw if the gamepad is not recognized.
+     */
+    public static final String JOYSTICKS_XBOX_WITH_FALLBACK_MAPPER = "JOYSTICKS_XBOX_WITH_FALLBACK_MAPPER";
+
+    /**
+     * Map gamepads to an Xbox-like layout using the legacy jME input
+     */
+    public static final String JOYSTICKS_XBOX_LEGACY_MAPPER = "JOYSTICKS_XBOX_LEGACY_MAPPER";
+
+    /**
+     * Map gamepads using the legacy jME mapper and input.
+     */
+    public static final String JOYSTICKS_LEGACY_MAPPER = "JOYSTICKS_LEGACY_MAPPER";
+
+    /**
+     * Don't map gamepads, use raw events instead (ie. bring your own mapper)
+     */
+    public static final String JOYSTICKS_RAW_MAPPER = "JOYSTICKS_RAW_MAPPER";
+
     static {
         defaults.put("Display", 0);
         defaults.put("CenterWindow", true);
@@ -300,8 +325,10 @@ public final class AppSettings extends HashMap<String, Object> {
         defaults.put("WindowYPosition", 0);
         defaults.put("WindowXPosition", 0);
         defaults.put("X11PlatformPreferred", false);
-        defaults.put("XboxLikeControllerLayout", true);
-        defaults.put("TriggerToButtonThreshold", 0.5f);
+        defaults.put("JoysticksMapper", JOYSTICKS_XBOX_MAPPER);
+        defaults.put("JoysticksTriggerToButtonThreshold", 0.5f);
+        defaults.put("JoysticksAxisJitterThreshold", 0.0001f);
+        defaults.put("SDLGameControllerDBResourcePath", "");
         //  defaults.put("Icons", null);
     }
 
@@ -1616,27 +1643,20 @@ public boolean isX11PlatformPreferred() {
     }
 
     /**
-     * Enable/disable automatic normalization of gamepad mappings to an Xbox-like layout,
-     * when possible.
-     *
-     * <p>
-     * Depending on the platform and controller model, this setting might have no effect.
-     * It is primarily intended to provide a consistent default button/axis layout across common
-     * controllers.
+     * Set which joystick mapping to use for normalization of controller inputs
      *
-     * @param enabled true to enable, false to disable (default: true)
+     * @param mapper
+     *            JOYSTICKS_MAPPER_* constant defining which mapping to use
      */
-    public void setXboxLikeControllerLayout(boolean enabled){
-        putBoolean("XboxLikeControllerLayout", enabled);
+    public void setJoysticksMapper(String mapper) {
+        putString("JoysticksMapper", mapper);
     }
 
     /**
-     * Whether automatic normalization of controller mappings to an Xbox-like layout is enabled.
-     *
-     * @return true if enabled, otherwise false
+     * Get which joystick mapping to use for normalization of controller inputs
      */
-    public boolean isXboxLikeControllerLayout(){
-        return getBoolean("XboxLikeControllerLayout");
+    public String getJoysticksMapper() {
+        return getString("JoysticksMapper");
     }
 
     /**
@@ -1649,17 +1669,57 @@ public boolean isXboxLikeControllerLayout(){
      *
      * @param threshold the trigger threshold in the range [0, 1] (default: 0.5f) 
      */
-    public void setTriggerToButtonThreshold(float threshold) {
-        putFloat("TriggerToButtonThreshold", threshold);
+    public void setJoysticksTriggerToButtonThreshold(float threshold) {
+        putFloat("JoysticksTriggerToButtonThreshold", threshold);
     }
 
     /**
      * Gets the threshold above which an analog trigger should also generate a button-press event.
      *
      * @return the trigger threshold in the range [0, 1] (default: 0.5f)
-     * @see #setTriggerToButtonThreshold(float)
+     * @see #setJoysticksTriggerToButtonThreshold(float)
      */
-    public float getTriggerToButtonThreshold() {
-        return getFloat("TriggerToButtonThreshold");
+    public float getJoysticksTriggerToButtonThreshold() {
+        return getFloat("JoysticksTriggerToButtonThreshold");
+    }
+
+    /**
+     * Sets the jitter threshold for joystick axes.
+     * 
+     * <p>
+     * Axis movements with a delta smaller than this threshold will be ignored. This is intended to reduce
+     * noise from analog joysticks.
+     */
+    public void setJoysticksAxisJitterThreshold(float threshold) {
+        putFloat("JoysticksAxisJitterThreshold", threshold);
+    }
+
+    /**
+     * Gets the jitter threshold for joystick axes.
+     * 
+     * @return the jitter threshold
+     * @see #setJoysticksAxisJitterThreshold(float)
+     */
+    public float getJoysticksAxisJitterThreshold() {
+        return getFloat("JoysticksAxisJitterThreshold");
+    }
+
+    /**
+     * Set resource path for a custom SDL game controller database.
+     * 
+     * @param path
+     */
+    public void setSDLGameControllerDBResourcePath(String path) {
+        putString("SDLGameControllerDBResourcePath", path);
+    }
+
+    /**
+     * Get resource path for a custom SDL game controller database.
+     * 
+     * @return resource path
+     */
+    public String getSDLGameControllerDBResourcePath() {
+        return getString("SDLGameControllerDBResourcePath");
     }
 }
+

jme3-examples/build.gradle

@@ -19,8 +19,8 @@ dependencies {
     implementation project(':jme3-effects')
     implementation project(':jme3-jbullet')
     implementation project(':jme3-jogg')
-    implementation project(':jme3-lwjgl')
-//    implementation project(':jme3-lwjgl3')
+    // implementation project(':jme3-lwjgl')
+    implementation project(':jme3-lwjgl3')
     implementation project(':jme3-networking')
     implementation project(':jme3-niftygui')
     implementation project(':jme3-plugins')

jme3-examples/src/main/java/jme3test/input/TestJoystick.java

@@ -46,7 +46,9 @@ public class TestJoystick extends SimpleApplication {
     public static void main(String[] args){
         TestJoystick app = new TestJoystick();
         AppSettings settings = new AppSettings(true);
+        settings.setJoysticksMapper(AppSettings.JOYSTICKS_XBOX_MAPPER);
         settings.setUseJoysticks(true);
+        settings.setX11PlatformPreferred(true);
         app.setSettings(settings);
         app.start();
     }
@@ -155,7 +157,7 @@ protected void setViewedJoystick( Joystick stick ) {
 
         } 
     }
- 
+
     /**
      *  Easier to watch for all button and axis events with a raw input listener.
      */   
@@ -184,13 +186,15 @@ public void onJoyAxisEvent(JoyAxisEvent evt) {
             gamepad.setAxisValue( evt.getAxis(), value );
             if( value != 0 ) {
                 lastValues.put(evt.getAxis(), value);
+                evt.getAxis().getJoystick().rumble(0.5f);
             } 
         }
 
         @Override
         public void onJoyButtonEvent(JoyButtonEvent evt) {
             setViewedJoystick( evt.getButton().getJoystick() );
             gamepad.setButtonValue( evt.getButton(), evt.isPressed() ); 
+            evt.getButton().getJoystick().rumble(1f);
         }
 
         @Override
@@ -299,7 +303,7 @@ private void addButton( String name, float x, float y, float width, float height
         }
 
         public void setAxisValue( JoystickAxis axis, float value ) {
-                
+
             if( axis == axis.getJoystick().getAxis(JoystickAxis.AXIS_XBOX_LEFT_THUMB_STICK_X)){
                 setXAxis(value);
             } else if( axis == axis.getJoystick().getAxis(JoystickAxis.AXIS_XBOX_LEFT_THUMB_STICK_Y)){

jme3-lwjgl3/build.gradle

@@ -12,6 +12,7 @@ dependencies {
     api libs.lwjgl3.openal
     api libs.lwjgl3.opencl
     api libs.lwjgl3.opengl
+    api libs.lwjgl3.sdl
 
     runtimeOnly(variantOf(libs.lwjgl3.base){ classifier('natives-windows') })
     runtimeOnly(variantOf(libs.lwjgl3.base){ classifier('natives-windows-x86') })
@@ -52,6 +53,14 @@ dependencies {
     runtimeOnly(variantOf(libs.lwjgl3.openal){ classifier('natives-linux-arm64') })
     runtimeOnly(variantOf(libs.lwjgl3.openal){ classifier('natives-macos') })
     runtimeOnly(variantOf(libs.lwjgl3.openal){ classifier('natives-macos-arm64') })
+
+    runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-windows') })
+    runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-windows-x86') })
+    runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-linux') })
+    runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-linux-arm32') })
+    runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-linux-arm64') })
+    runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-macos') })
+    runtimeOnly(variantOf(libs.lwjgl3.sdl){ classifier('natives-macos-arm64') })
 }
 
 javadoc {