From eafb03ad38ebd2e051f426ba5d4582819d33d974 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Felix=20N=C3=BCsse?= <felix.nuesse@t-online.de>
Date: Mon, 15 Jul 2024 19:16:03 +0200
Subject: [PATCH] allow remapping of unknown keycodes (#189)

---
 .../citra_emu/activities/EmulationActivity.kt |  3 +-
 .../model/view/InputBindingSetting.kt         | 32 +++++++++++++++++--
 2 files changed, 31 insertions(+), 4 deletions(-)

diff --git a/src/android/app/src/main/java/org/citra/citra_emu/activities/EmulationActivity.kt b/src/android/app/src/main/java/org/citra/citra_emu/activities/EmulationActivity.kt
index 68e173e7c..0f3a5fb81 100644
--- a/src/android/app/src/main/java/org/citra/citra_emu/activities/EmulationActivity.kt
+++ b/src/android/app/src/main/java/org/citra/citra_emu/activities/EmulationActivity.kt
@@ -194,8 +194,7 @@ class EmulationActivity : AppCompatActivity() {
             return false
         }
 
-        val button =
-            preferences.getInt(InputBindingSetting.getInputButtonKey(event.keyCode), event.keyCode)
+        val button = preferences.getInt(InputBindingSetting.getInputButtonKey(event), event.scanCode)
         val action: Int = when (event.action) {
             KeyEvent.ACTION_DOWN -> {
                 // On some devices, the back gesture / button press is not intercepted by androidx
diff --git a/src/android/app/src/main/java/org/citra/citra_emu/features/settings/model/view/InputBindingSetting.kt b/src/android/app/src/main/java/org/citra/citra_emu/features/settings/model/view/InputBindingSetting.kt
index 8165830f6..c3756abf7 100644
--- a/src/android/app/src/main/java/org/citra/citra_emu/features/settings/model/view/InputBindingSetting.kt
+++ b/src/android/app/src/main/java/org/citra/citra_emu/features/settings/model/view/InputBindingSetting.kt
@@ -224,8 +224,10 @@ class InputBindingSetting(
             Toast.makeText(context, R.string.input_message_analog_only, Toast.LENGTH_LONG).show()
             return
         }
-        writeButtonMapping(getInputButtonKey(keyEvent.keyCode))
-        val uiString = "${keyEvent.device.name}: Button ${keyEvent.keyCode}"
+
+        val code = translateEventToKeyId(keyEvent)
+        writeButtonMapping(getInputButtonKey(code))
+        val uiString = "${keyEvent.device.name}: Button $code"
         value = uiString
     }
 
@@ -285,9 +287,17 @@ class InputBindingSetting(
 
         /**
          * Helper function to get the settings key for an gamepad button.
+         *
          */
+        @Deprecated("Use the new getInputButtonKey(keyEvent) method to handle unknown keys")
         fun getInputButtonKey(keyCode: Int): String = "${INPUT_MAPPING_PREFIX}_HostAxis_${keyCode}"
 
+        /**
+         * Helper function to get the settings key for an gamepad button.
+         *
+         */
+        fun getInputButtonKey(event: KeyEvent): String = "${INPUT_MAPPING_PREFIX}_HostAxis_${translateEventToKeyId(event)}"
+
         /**
          * Helper function to get the settings key for an gamepad axis.
          */
@@ -303,5 +313,23 @@ class InputBindingSetting(
          */
         fun getInputAxisOrientationKey(axis: Int): String =
             "${getInputAxisKey(axis)}_GuestOrientation"
+
+
+        /**
+         * This function translates a keyEvent into an "keyid"
+         * This key id is either the keyCode from the event, or
+         * the raw scanCode.
+         * Only when the keyCode itself is 0, (so it is an unknown key)
+         * we fall back to the raw scan code.
+         * This handles keys like the media-keys on google statia-controllers
+         * that don't have a conventional "mapping" and report as "unknown"
+         */
+        fun translateEventToKeyId(event: KeyEvent): Int {
+            return if (event.keyCode == 0) {
+                event.scanCode
+            } else {
+                event.keyCode
+            }
+        }
     }
 }