game menu: add toggle keyboard and toggle mouse

Changes:
 * Include toggle keyboard action in game menu
 * Add generic game input device abstraction (which can be implemented
   by all kind of input devices)
 * Show input device game menu options
   * Implement for controller to provide mouse emulation selection

Author: Karim Mreisi

app/src/main/java/com/limelight/Game.java

@@ -4,6 +4,7 @@
 import com.limelight.binding.PlatformBinding;
 import com.limelight.binding.audio.AndroidAudioRenderer;
 import com.limelight.binding.input.ControllerHandler;
+import com.limelight.binding.input.GameInputDevice;
 import com.limelight.binding.input.KeyboardTranslator;
 import com.limelight.binding.input.capture.InputCaptureManager;
 import com.limelight.binding.input.capture.InputCaptureProvider;
@@ -2260,6 +2261,11 @@ public void onUsbPermissionPromptCompleted() {
         updatePipAutoEnter();
     }
 
+    @Override
+    public void showGameMenu(GameInputDevice device) {
+        new GameMenu(this, conn, device);
+    }
+
     @Override
     public boolean onKey(View view, int keyCode, KeyEvent keyEvent) {
         switch (keyEvent.getAction()) {
@@ -2271,7 +2277,7 @@ public boolean onKey(View view, int keyCode, KeyEvent keyEvent) {
                 // Intercept back key event before android handles it
                 // Always handle the request, the user has to select "Disconnect" within the game menu to actually disconnect
                 if (keyCode == keyEvent.KEYCODE_BACK) {
-                    new GameMenu(this, conn);
+                    showGameMenu(null);
                     return true;
                 }
             case KeyEvent.ACTION_UP:

app/src/main/java/com/limelight/GameMenu.java

@@ -4,10 +4,14 @@
 import android.os.Handler;
 import android.widget.ArrayAdapter;
 
+import com.limelight.binding.input.GameInputDevice;
 import com.limelight.binding.input.KeyboardTranslator;
 import com.limelight.nvstream.NvConnection;
 import com.limelight.nvstream.input.KeyboardPacket;
 
+import java.util.ArrayList;
+import java.util.List;
+
 /**
  * Provide options for ongoing Game Stream.
  * <p>
@@ -17,22 +21,24 @@ public class GameMenu {
 
     private static final long KEY_UP_DELAY = 25;
 
-    private static class MenuOption {
+    public static class MenuOption {
         private final String label;
         private final Runnable runnable;
 
-        MenuOption(String label, Runnable runnable) {
+        public MenuOption(String label, Runnable runnable) {
             this.label = label;
             this.runnable = runnable;
         }
     }
 
     private final Game game;
     private final NvConnection conn;
+    private final GameInputDevice device;
 
-    public GameMenu(Game game, NvConnection conn) {
+    public GameMenu(Game game, NvConnection conn, GameInputDevice device) {
         this.game = game;
         this.conn = conn;
+        this.device = device;
 
         showMenu();
     }
@@ -128,10 +134,19 @@ private void showSpecialKeysMenu() {
     }
 
     private void showMenu() {
-        showMenuDialog("Game Menu", new MenuOption[]{
-                new MenuOption(getString(R.string.game_menu_send_keys), () -> showSpecialKeysMenu()),
-                new MenuOption(getString(R.string.game_menu_disconnect), () -> game.onBackPressed()),
-                new MenuOption(getString(R.string.game_menu_cancel), null),
-        });
+        List<MenuOption> options = new ArrayList<>();
+
+        options.add(new MenuOption(getString(R.string.game_menu_toggle_keyboard),
+                () -> game.toggleKeyboard()));
+
+        if (device != null) {
+            options.addAll(device.getGameMenuOptions());
+        }
+
+        options.add(new MenuOption(getString(R.string.game_menu_send_keys), () -> showSpecialKeysMenu()));
+        options.add(new MenuOption(getString(R.string.game_menu_disconnect), () -> game.onBackPressed()));
+        options.add(new MenuOption(getString(R.string.game_menu_cancel), null));
+
+        showMenuDialog("Game Menu", options.toArray(new MenuOption[options.size()]));
     }
 }

app/src/main/java/com/limelight/binding/input/ControllerHandler.java

@@ -22,7 +22,9 @@
 import android.view.MotionEvent;
 import android.widget.Toast;
 
+import com.limelight.GameMenu;
 import com.limelight.LimeLog;
+import com.limelight.R;
 import com.limelight.binding.input.driver.AbstractController;
 import com.limelight.binding.input.driver.UsbDriverListener;
 import com.limelight.binding.input.driver.UsbDriverService;
@@ -36,6 +38,8 @@
 import org.cgutman.shieldcontrollerextensions.SceManager;
 
 import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
+import java.util.List;
 
 public class ControllerHandler implements InputManager.InputDeviceListener, UsbDriverListener {
 
@@ -1511,7 +1515,7 @@ public boolean handleButtonUp(KeyEvent event) {
             if ((context.inputMap & ControllerPacket.PLAY_FLAG) != 0 &&
                     event.getEventTime() - context.startDownTime > ControllerHandler.START_DOWN_TIME_MOUSE_MODE_MS &&
                     prefConfig.mouseEmulation) {
-                context.toggleMouseEmulation();
+                gestures.showGameMenu(context);
             }
             context.inputMap &= ~ControllerPacket.PLAY_FLAG;
             break;
@@ -1858,7 +1862,7 @@ public void deviceAdded(AbstractController controller) {
         usbDeviceContexts.put(controller.getControllerId(), context);
     }
 
-    class GenericControllerContext {
+    class GenericControllerContext implements GameInputDevice {
         public int id;
         public boolean external;
 
@@ -1901,6 +1905,16 @@ public void run() {
             }
         };
 
+        @Override
+        public List<GameMenu.MenuOption> getGameMenuOptions() {
+            List<GameMenu.MenuOption> options = new ArrayList<>();
+            options.add(new GameMenu.MenuOption(activityContext.getString(mouseEmulationActive ?
+                    R.string.game_menu_toggle_mouse_off : R.string.game_menu_toggle_mouse_on),
+                    () -> toggleMouseEmulation()));
+
+            return options;
+        }
+
         public void toggleMouseEmulation() {
             handler.removeCallbacks(mouseEmulationRunnable);
             mouseEmulationActive = !mouseEmulationActive;

app/src/main/java/com/limelight/binding/input/GameInputDevice.java

@@ -0,0 +1,16 @@
+package com.limelight.binding.input;
+
+import com.limelight.GameMenu;
+
+import java.util.List;
+
+/**
+ * Generic Input Device
+ */
+public interface GameInputDevice {
+
+    /**
+     * @return list of device specific game menu options, e.g. configure a controller's mouse mode
+     */
+    List<GameMenu.MenuOption> getGameMenuOptions();
+}

app/src/main/java/com/limelight/ui/GameGestures.java

@@ -1,5 +1,9 @@
 package com.limelight.ui;
 
+import com.limelight.binding.input.GameInputDevice;
+
 public interface GameGestures {
     void toggleKeyboard();
+
+    void showGameMenu(GameInputDevice device);
 }

app/src/main/res/values/strings.xml

@@ -132,13 +132,16 @@
     <string name="applist_details_id">App ID:</string>
 
     <!-- In Game menu -->
+    <string name="game_menu_toggle_keyboard">Toggle On-screen Keyboard</string>
+    <string name="game_menu_toggle_mouse_on">Enable Controller Mouse Emulation</string>
+    <string name="game_menu_toggle_mouse_off">Disable Controller Mouse Emulation</string>
     <string name="game_menu_disconnect">Disconnect</string>
     <string name="game_menu_cancel">Cancel</string>
-    <string name="game_menu_send_keys">Send special key(s)</string>
+    <string name="game_menu_send_keys">Send special Key(s)</string>
     <string name="game_menu_send_keys_esc">Send ESC (Menu)</string>
-    <string name="game_menu_send_keys_f11">Send F11 (Toggle full screen)</string>
-    <string name="game_menu_send_keys_ctrl_v">Send CTRL + V (Paste clipboard)</string>
-    <string name="game_menu_send_keys_win">Send WIN (Toggle Windows start menu)</string>
+    <string name="game_menu_send_keys_f11">Send F11 (Toggle Full Screen)</string>
+    <string name="game_menu_send_keys_ctrl_v">Send CTRL + V (Paste Clipboard)</string>
+    <string name="game_menu_send_keys_win">Send WIN (Toggle Windows Start Menu)</string>
     <string name="game_menu_send_keys_win_d">Send WIN + D (Switch to Desktop)</string>
     <string name="game_menu_send_keys_win_g">Send WIN + G (Open Xbox Game Bar)</string>
     <string name="game_menu_send_keys_shift_tab">Send SHIFT + TAB (Open Steam Overlay)</string>