Always prefer text events by default

This improves text input, but it breaks the expected behavior in games
again: <https://github.com/Genymobile/scrcpy/issues/87>.

To get the previous behavior back, pass an explicit option:

    scrcpy --prefer-text-events=non-alpha

DEVELOP.md

@@ -268,3 +268,33 @@ For more details, go read the code!
 
 If you find a bug, or have an awesome idea to implement, please discuss and
 contribute ;-)
+
+
+### Debug the server
+
+The server is pushed to the device by the client on startup.
+
+To debug it, enable the server debugger during configuration:
+
+```bash
+meson x -Dserver_debugger=true
+# or, if x is already configured
+meson configure x -Dserver_debugger=true
+```
+
+Then recompile.
+
+When you start scrcpy, it will start a debugger on port 5005 on the device.
+Redirect that port to the computer:
+
+```bash
+adb forward tcp:5005 tcp:5005
+```
+
+In Android Studio, _Run_ > _Debug_ > _Edit configurations..._ On the left, click on
+`+`, _Remote_, and fill the form:
+
+ - Host: `localhost`
+ - Port: `5005`
+
+Then click on _Debug_.

app/meson.build

@@ -115,6 +115,9 @@ conf.set('HIDPI_SUPPORT', get_option('hidpi_support'))
 # disable console on Windows
 conf.set('WINDOWS_NOCONSOLE', get_option('windows_noconsole'))
 
+# run a server debugger and wait for a client to be attached
+conf.set('SERVER_DEBUGGER', get_option('server_debugger'))
+
 configure_file(configuration: conf, output: 'config.h')
 
 src_dir = include_directories('src')

app/scrcpy.1

@@ -61,6 +61,16 @@ Set the TCP port the client listens on.
 
 Default is 27183.
 
+.TP
+.BI \-\-prefer\-text\-events " mode
+Configure how key/text events are forwarded to the Android device.
+
+Possible \fImode\fRs are "always" (every text is sent as text), "non-alpha"
+(only letters are sent as a sequence of key events, other characters are sent
+as text) and "never" (every text is sent as a sequence of key events).
+
+Default is "always".
+
 .TP
 .BI "\-\-push\-target " path
 Set the target directory for pushing files to the device by drag & drop. It is passed as\-is to "adb push".

app/src/event_converter.c

@@ -5,7 +5,7 @@
 #define MAP(FROM, TO) case FROM: *to = TO; return true
 #define FAIL default: return false
 
-static bool
+bool
 convert_keycode_action(SDL_EventType from, enum android_keyevent_action *to) {
     switch (from) {
         MAP(SDL_KEYDOWN, AKEY_EVENT_ACTION_DOWN);
@@ -33,7 +33,7 @@ autocomplete_metastate(enum android_metastate metastate) {
     return metastate;
 }
 
-static enum android_metastate
+enum android_metastate
 convert_meta_state(SDL_Keymod mod) {
     enum android_metastate metastate = 0;
     if (mod & KMOD_LSHIFT) {
@@ -74,8 +74,9 @@ convert_meta_state(SDL_Keymod mod) {
     return autocomplete_metastate(metastate);
 }
 
-static bool
+bool
-convert_keycode(SDL_Keycode from, enum android_keycode *to, uint16_t mod) {
+convert_keycode(SDL_Keycode from, enum android_keycode *to, uint16_t mod,
+                enum text_events_pref pref) {
     switch (from) {
         MAP(SDLK_RETURN,       AKEYCODE_ENTER);
         MAP(SDLK_KP_ENTER,     AKEYCODE_NUMPAD_ENTER);
@@ -92,6 +93,16 @@ convert_keycode(SDL_Keycode from, enum android_keycode *to, uint16_t mod) {
         MAP(SDLK_DOWN,         AKEYCODE_DPAD_DOWN);
         MAP(SDLK_UP,           AKEYCODE_DPAD_UP);
     }
+
+    if (pref == PREFER_TEXT_EVENTS_ALWAYS) {
+        // never forward key events
+        return false;
+    }
+
+    // forward all supported key events
+    SDL_assert(pref == PREFER_TEXT_EVENTS_NEVER ||
+               pref == PREFER_TEXT_EVENTS_NON_ALPHA);
+
     if (mod & (KMOD_LALT | KMOD_RALT | KMOD_LGUI | KMOD_RGUI)) {
         return false;
     }
@@ -128,7 +139,7 @@ convert_keycode(SDL_Keycode from, enum android_keycode *to, uint16_t mod) {
     }
 }
 
-static enum android_motionevent_buttons
+enum android_motionevent_buttons
 convert_mouse_buttons(uint32_t state) {
     enum android_motionevent_buttons buttons = 0;
     if (state & SDL_BUTTON_LMASK) {
@@ -150,24 +161,6 @@ convert_mouse_buttons(uint32_t state) {
 }
 
 bool
-convert_input_key(const SDL_KeyboardEvent *from, struct control_msg *to) {
-    to->type = CONTROL_MSG_TYPE_INJECT_KEYCODE;
-
-    if (!convert_keycode_action(from->type, &to->inject_keycode.action)) {
-        return false;
-    }
-
-    uint16_t mod = from->keysym.mod;
-    if (!convert_keycode(from->keysym.sym, &to->inject_keycode.keycode, mod)) {
-        return false;
-    }
-
-    to->inject_keycode.metastate = convert_meta_state(mod);
-
-    return true;
-}
-
-static bool
 convert_mouse_action(SDL_EventType from, enum android_motionevent_action *to) {
     switch (from) {
         MAP(SDL_MOUSEBUTTONDOWN, AMOTION_EVENT_ACTION_DOWN);
@@ -177,41 +170,6 @@ convert_mouse_action(SDL_EventType from, enum android_motionevent_action *to) {
 }
 
 bool
-convert_mouse_button(const SDL_MouseButtonEvent *from, struct size screen_size,
-                     struct control_msg *to) {
-    to->type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT;
-
-    if (!convert_mouse_action(from->type, &to->inject_touch_event.action)) {
-        return false;
-    }
-
-    to->inject_touch_event.pointer_id = POINTER_ID_MOUSE;
-    to->inject_touch_event.position.screen_size = screen_size;
-    to->inject_touch_event.position.point.x = from->x;
-    to->inject_touch_event.position.point.y = from->y;
-    to->inject_touch_event.pressure = 1.f;
-    to->inject_touch_event.buttons =
-        convert_mouse_buttons(SDL_BUTTON(from->button));
-
-    return true;
-}
-
-bool
-convert_mouse_motion(const SDL_MouseMotionEvent *from, struct size screen_size,
-                     struct control_msg *to) {
-    to->type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT;
-    to->inject_touch_event.action = AMOTION_EVENT_ACTION_MOVE;
-    to->inject_touch_event.pointer_id = POINTER_ID_MOUSE;
-    to->inject_touch_event.position.screen_size = screen_size;
-    to->inject_touch_event.position.point.x = from->x;
-    to->inject_touch_event.position.point.y = from->y;
-    to->inject_touch_event.pressure = 1.f;
-    to->inject_touch_event.buttons = convert_mouse_buttons(from->state);
-
-    return true;
-}
-
-static bool
 convert_touch_action(SDL_EventType from, enum android_motionevent_action *to) {
     switch (from) {
         MAP(SDL_FINGERMOTION, AMOTION_EVENT_ACTION_MOVE);
@@ -220,39 +178,3 @@ convert_touch_action(SDL_EventType from, enum android_motionevent_action *to) {
         FAIL;
     }
 }
-
-bool
-convert_touch(const SDL_TouchFingerEvent *from, struct size screen_size,
-              struct control_msg *to) {
-    to->type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT;
-
-    if (!convert_touch_action(from->type, &to->inject_touch_event.action)) {
-        return false;
-    }
-
-    to->inject_touch_event.pointer_id = from->fingerId;
-    to->inject_touch_event.position.screen_size = screen_size;
-    // SDL touch event coordinates are normalized in the range [0; 1]
-    to->inject_touch_event.position.point.x = from->x * screen_size.width;
-    to->inject_touch_event.position.point.y = from->y * screen_size.height;
-    to->inject_touch_event.pressure = from->pressure;
-    to->inject_touch_event.buttons = 0;
-    return true;
-}
-
-bool
-convert_mouse_wheel(const SDL_MouseWheelEvent *from, struct position position,
-                    struct control_msg *to) {
-    to->type = CONTROL_MSG_TYPE_INJECT_SCROLL_EVENT;
-
-    to->inject_scroll_event.position = position;
-
-    int mul = from->direction == SDL_MOUSEWHEEL_NORMAL ? 1 : -1;
-    // SDL behavior seems inconsistent between horizontal and vertical scrolling
-    // so reverse the horizontal
-    // <https://wiki.libsdl.org/SDL_MouseWheelEvent#Remarks>
-    to->inject_scroll_event.hscroll = -mul * from->x;
-    to->inject_scroll_event.vscroll = mul * from->y;
-
-    return true;
-}

app/src/event_converter.h

@@ -2,41 +2,30 @@
 #define CONVERT_H
 
 #include <stdbool.h>
+#include <SDL2/SDL_assert.h>
 #include <SDL2/SDL_events.h>
 
 #include "config.h"
 #include "control_msg.h"
-
+#include "input_manager.h"
-struct complete_mouse_motion_event {
-    SDL_MouseMotionEvent *mouse_motion_event;
-    struct size screen_size;
-};
-
-struct complete_mouse_wheel_event {
-    SDL_MouseWheelEvent *mouse_wheel_event;
-    struct point position;
-};
 
 bool
-convert_input_key(const SDL_KeyboardEvent *from, struct control_msg *to);
+convert_keycode_action(SDL_EventType from, enum android_keyevent_action *to);
+
+enum android_metastate
+convert_meta_state(SDL_Keymod mod);
 
 bool
-convert_mouse_button(const SDL_MouseButtonEvent *from, struct size screen_size,
+convert_keycode(SDL_Keycode from, enum android_keycode *to, uint16_t mod,
-                     struct control_msg *to);
+                enum text_events_pref pref);
 
-// the video size may be different from the real device size, so we need the
+enum android_motionevent_buttons
-// size to which the absolute position apply, to scale it accordingly
+convert_mouse_buttons(uint32_t state);
-bool
-convert_mouse_motion(const SDL_MouseMotionEvent *from, struct size screen_size,
-                     struct control_msg *to);
 
 bool
-convert_touch(const SDL_TouchFingerEvent *from, struct size screen_size,
+convert_mouse_action(SDL_EventType from, enum android_motionevent_action *to);
-              struct control_msg *to);
 
-// on Android, a scroll event requires the current mouse position
 bool
-convert_mouse_wheel(const SDL_MouseWheelEvent *from, struct position position,
+convert_touch_action(SDL_EventType from, enum android_motionevent_action *to);
-                    struct control_msg *to);
 
 #endif

app/src/input_manager.c

@@ -212,14 +212,22 @@ clipboard_paste(struct controller *controller) {
 }
 
 void
-input_manager_process_text_input(struct input_manager *input_manager,
+input_manager_process_text_input(struct input_manager *im,
                                  const SDL_TextInputEvent *event) {
-    char c = event->text[0];
+    if (im->text_events_pref == PREFER_TEXT_EVENTS_NEVER) {
-    if (isalpha(c) || c == ' ') {
+        // ignore all text events (key events will be injected instead)
-        SDL_assert(event->text[1] == '\0');
-        // letters and space are handled as raw key event
         return;
     }
+
+    if (im->text_events_pref == PREFER_TEXT_EVENTS_NON_ALPHA) {
+        char c = event->text[0];
+        if (isalpha(c) || c == ' ') {
+            SDL_assert(event->text[1] == '\0');
+            // letters and space are handled as raw key event
+            return;
+        }
+    }
+
     struct control_msg msg;
     msg.type = CONTROL_MSG_TYPE_INJECT_TEXT;
     msg.inject_text.text = SDL_strdup(event->text);
@@ -227,14 +235,34 @@ input_manager_process_text_input(struct input_manager *input_manager,
         LOGW("Could not strdup input text");
         return;
     }
-    if (!controller_push_msg(input_manager->controller, &msg)) {
+    if (!controller_push_msg(im->controller, &msg)) {
         SDL_free(msg.inject_text.text);
         LOGW("Could not request 'inject text'");
     }
 }
 
+static bool
+convert_input_key(const SDL_KeyboardEvent *from, struct control_msg *to,
+                  enum text_events_pref pref) {
+    to->type = CONTROL_MSG_TYPE_INJECT_KEYCODE;
+
+    if (!convert_keycode_action(from->type, &to->inject_keycode.action)) {
+        return false;
+    }
+
+    uint16_t mod = from->keysym.mod;
+    if (!convert_keycode(from->keysym.sym, &to->inject_keycode.keycode, mod,
+                         pref)) {
+        return false;
+    }
+
+    to->inject_keycode.metastate = convert_meta_state(mod);
+
+    return true;
+}
+
 void
-input_manager_process_key(struct input_manager *input_manager,
+input_manager_process_key(struct input_manager *im,
                           const SDL_KeyboardEvent *event,
                           bool control) {
     // control: indicates the state of the command-line option --no-control
@@ -261,7 +289,7 @@ input_manager_process_key(struct input_manager *input_manager,
         return;
     }
 
-    struct controller *controller = input_manager->controller;
+    struct controller *controller = im->controller;
 
     // capture all Ctrl events
     if (ctrl || cmd) {
@@ -336,23 +364,23 @@ input_manager_process_key(struct input_manager *input_manager,
                 return;
             case SDLK_f:
                 if (!shift && cmd && !repeat && down) {
-                    screen_switch_fullscreen(input_manager->screen);
+                    screen_switch_fullscreen(im->screen);
                 }
                 return;
             case SDLK_x:
                 if (!shift && cmd && !repeat && down) {
-                    screen_resize_to_fit(input_manager->screen);
+                    screen_resize_to_fit(im->screen);
                 }
                 return;
             case SDLK_g:
                 if (!shift && cmd && !repeat && down) {
-                    screen_resize_to_pixel_perfect(input_manager->screen);
+                    screen_resize_to_pixel_perfect(im->screen);
                 }
                 return;
             case SDLK_i:
                 if (!shift && cmd && !repeat && down) {
                     struct fps_counter *fps_counter =
-                        input_manager->video_buffer->fps_counter;
+                        im->video_buffer->fps_counter;
                     switch_fps_counter_state(fps_counter);
                 }
                 return;
@@ -375,15 +403,30 @@ input_manager_process_key(struct input_manager *input_manager,
     }
 
     struct control_msg msg;
-    if (convert_input_key(event, &msg)) {
+    if (convert_input_key(event, &msg, im->text_events_pref)) {
         if (!controller_push_msg(controller, &msg)) {
             LOGW("Could not request 'inject keycode'");
         }
     }
 }
 
+static bool
+convert_mouse_motion(const SDL_MouseMotionEvent *from, struct screen *screen,
+                     struct control_msg *to) {
+    to->type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT;
+    to->inject_touch_event.action = AMOTION_EVENT_ACTION_MOVE;
+    to->inject_touch_event.pointer_id = POINTER_ID_MOUSE;
+    to->inject_touch_event.position.screen_size = screen->frame_size;
+    to->inject_touch_event.position.point.x = from->x;
+    to->inject_touch_event.position.point.y = from->y;
+    to->inject_touch_event.pressure = 1.f;
+    to->inject_touch_event.buttons = convert_mouse_buttons(from->state);
+
+    return true;
+}
+
 void
-input_manager_process_mouse_motion(struct input_manager *input_manager,
+input_manager_process_mouse_motion(struct input_manager *im,
                                    const SDL_MouseMotionEvent *event) {
     if (!event->state) {
         // do not send motion events when no button is pressed
@@ -394,33 +437,74 @@ input_manager_process_mouse_motion(struct input_manager *input_manager,
         return;
     }
     struct control_msg msg;
-    if (convert_mouse_motion(event, input_manager->screen->frame_size, &msg)) {
+    if (convert_mouse_motion(event, im->screen, &msg)) {
-        if (!controller_push_msg(input_manager->controller, &msg)) {
+        if (!controller_push_msg(im->controller, &msg)) {
             LOGW("Could not request 'inject mouse motion event'");
         }
     }
 }
 
+static bool
+convert_touch(const SDL_TouchFingerEvent *from, struct screen *screen,
+              struct control_msg *to) {
+    to->type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT;
+
+    if (!convert_touch_action(from->type, &to->inject_touch_event.action)) {
+        return false;
+    }
+
+    struct size frame_size = screen->frame_size;
+
+    to->inject_touch_event.pointer_id = from->fingerId;
+    to->inject_touch_event.position.screen_size = frame_size;
+    // SDL touch event coordinates are normalized in the range [0; 1]
+    to->inject_touch_event.position.point.x = from->x * frame_size.width;
+    to->inject_touch_event.position.point.y = from->y * frame_size.height;
+    to->inject_touch_event.pressure = from->pressure;
+    to->inject_touch_event.buttons = 0;
+    return true;
+}
+
 void
-input_manager_process_touch(struct input_manager *input_manager,
+input_manager_process_touch(struct input_manager *im,
                             const SDL_TouchFingerEvent *event) {
     struct control_msg msg;
-    if (convert_touch(event, input_manager->screen->frame_size, &msg)) {
+    if (convert_touch(event, im->screen, &msg)) {
-        if (!controller_push_msg(input_manager->controller, &msg)) {
+        if (!controller_push_msg(im->controller, &msg)) {
             LOGW("Could not request 'inject touch event'");
         }
     }
 }
 
 static bool
-is_outside_device_screen(struct input_manager *input_manager, int x, int y)
+is_outside_device_screen(struct input_manager *im, int x, int y)
 {
-    return x < 0 || x >= input_manager->screen->frame_size.width ||
+    return x < 0 || x >= im->screen->frame_size.width ||
-           y < 0 || y >= input_manager->screen->frame_size.height;
+           y < 0 || y >= im->screen->frame_size.height;
+}
+
+static bool
+convert_mouse_button(const SDL_MouseButtonEvent *from, struct screen *screen,
+                     struct control_msg *to) {
+    to->type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT;
+
+    if (!convert_mouse_action(from->type, &to->inject_touch_event.action)) {
+        return false;
+    }
+
+    to->inject_touch_event.pointer_id = POINTER_ID_MOUSE;
+    to->inject_touch_event.position.screen_size = screen->frame_size;
+    to->inject_touch_event.position.point.x = from->x;
+    to->inject_touch_event.position.point.y = from->y;
+    to->inject_touch_event.pressure = 1.f;
+    to->inject_touch_event.buttons =
+        convert_mouse_buttons(SDL_BUTTON(from->button));
+
+    return true;
 }
 
 void
-input_manager_process_mouse_button(struct input_manager *input_manager,
+input_manager_process_mouse_button(struct input_manager *im,
                                    const SDL_MouseButtonEvent *event,
                                    bool control) {
     if (event->which == SDL_TOUCH_MOUSEID) {
@@ -429,19 +513,19 @@ input_manager_process_mouse_button(struct input_manager *input_manager,
     }
     if (event->type == SDL_MOUSEBUTTONDOWN) {
         if (control && event->button == SDL_BUTTON_RIGHT) {
-            press_back_or_turn_screen_on(input_manager->controller);
+            press_back_or_turn_screen_on(im->controller);
             return;
         }
         if (control && event->button == SDL_BUTTON_MIDDLE) {
-            action_home(input_manager->controller, ACTION_DOWN | ACTION_UP);
+            action_home(im->controller, ACTION_DOWN | ACTION_UP);
             return;
         }
         // double-click on black borders resize to fit the device screen
         if (event->button == SDL_BUTTON_LEFT && event->clicks == 2) {
             bool outside =
-                is_outside_device_screen(input_manager, event->x, event->y);
+                is_outside_device_screen(im, event->x, event->y);
             if (outside) {
-                screen_resize_to_fit(input_manager->screen);
+                screen_resize_to_fit(im->screen);
                 return;
             }
         }
@@ -453,23 +537,41 @@ input_manager_process_mouse_button(struct input_manager *input_manager,
     }
 
     struct control_msg msg;
-    if (convert_mouse_button(event, input_manager->screen->frame_size, &msg)) {
+    if (convert_mouse_button(event, im->screen, &msg)) {
-        if (!controller_push_msg(input_manager->controller, &msg)) {
+        if (!controller_push_msg(im->controller, &msg)) {
             LOGW("Could not request 'inject mouse button event'");
         }
     }
 }
 
-void
+static bool
-input_manager_process_mouse_wheel(struct input_manager *input_manager,
+convert_mouse_wheel(const SDL_MouseWheelEvent *from, struct screen *screen,
-                                  const SDL_MouseWheelEvent *event) {
+                    struct control_msg *to) {
     struct position position = {
-        .screen_size = input_manager->screen->frame_size,
+        .screen_size = screen->frame_size,
-        .point = get_mouse_point(input_manager->screen),
+        .point = get_mouse_point(screen),
     };
+
+    to->type = CONTROL_MSG_TYPE_INJECT_SCROLL_EVENT;
+
+    to->inject_scroll_event.position = position;
+
+    int mul = from->direction == SDL_MOUSEWHEEL_NORMAL ? 1 : -1;
+    // SDL behavior seems inconsistent between horizontal and vertical scrolling
+    // so reverse the horizontal
+    // <https://wiki.libsdl.org/SDL_MouseWheelEvent#Remarks>
+    to->inject_scroll_event.hscroll = -mul * from->x;
+    to->inject_scroll_event.vscroll = mul * from->y;
+
+    return true;
+}
+
+void
+input_manager_process_mouse_wheel(struct input_manager *im,
+                                  const SDL_MouseWheelEvent *event) {
     struct control_msg msg;
-    if (convert_mouse_wheel(event, position, &msg)) {
+    if (convert_mouse_wheel(event, im->screen, &msg)) {
-        if (!controller_push_msg(input_manager->controller, &msg)) {
+        if (!controller_push_msg(im->controller, &msg)) {
             LOGW("Could not request 'inject mouse wheel event'");
         }
     }

app/src/input_manager.h

@@ -10,36 +10,43 @@
 #include "video_buffer.h"
 #include "screen.h"
 
+enum text_events_pref {
+    PREFER_TEXT_EVENTS_ALWAYS,
+    PREFER_TEXT_EVENTS_NON_ALPHA,
+    PREFER_TEXT_EVENTS_NEVER,
+};
+
 struct input_manager {
     struct controller *controller;
     struct video_buffer *video_buffer;
     struct screen *screen;
+    enum text_events_pref text_events_pref;
 };
 
 void
-input_manager_process_text_input(struct input_manager *input_manager,
+input_manager_process_text_input(struct input_manager *im,
                                  const SDL_TextInputEvent *event);
 
 void
-input_manager_process_key(struct input_manager *input_manager,
+input_manager_process_key(struct input_manager *im,
                           const SDL_KeyboardEvent *event,
                           bool control);
 
 void
-input_manager_process_mouse_motion(struct input_manager *input_manager,
+input_manager_process_mouse_motion(struct input_manager *im,
                                    const SDL_MouseMotionEvent *event);
 
 void
-input_manager_process_touch(struct input_manager *input_manager,
+input_manager_process_touch(struct input_manager *im,
                             const SDL_TouchFingerEvent *event);
 
 void
-input_manager_process_mouse_button(struct input_manager *input_manager,
+input_manager_process_mouse_button(struct input_manager *im,
                                    const SDL_MouseButtonEvent *event,
                                    bool control);
 
 void
-input_manager_process_mouse_wheel(struct input_manager *input_manager,
+input_manager_process_mouse_wheel(struct input_manager *im,
                                   const SDL_MouseWheelEvent *event);
 
 #endif

app/src/main.c

@@ -11,27 +11,13 @@
 #include "config.h"
 #include "compat.h"
 #include "log.h"
+#include "input_manager.h"
 #include "recorder.h"
 
 struct args {
-    const char *serial;
+    struct scrcpy_options opts;
-    const char *crop;
-    const char *record_filename;
-    const char *window_title;
-    const char *push_target;
-    enum recorder_format record_format;
-    bool fullscreen;
-    bool no_control;
-    bool no_display;
     bool help;
     bool version;
-    bool show_touches;
-    uint16_t port;
-    uint16_t max_size;
-    uint32_t bit_rate;
-    bool always_on_top;
-    bool turn_screen_off;
-    bool render_expired_frames;
 };
 
 static void usage(const char *arg0) {
@@ -82,6 +68,18 @@ static void usage(const char *arg0) {
         "        Set the TCP port the client listens on.\n"
         "        Default is %d.\n"
         "\n"
+        "    --prefer-text-events mode\n"
+        "        Configure how key/text events are forwarded to the Android\n"
+        "        device.\n"
+        "        Possible values are:\n"
+        "          always:\n"
+        "            Every text is sent as text. (default)\n"
+        "          non-alpha:\n"
+        "            Only letters are sent as a sequence of key events, other\n"
+        "            characters are sent as text.\n"
+        "          never:\n"
+        "            Every text is sent as a sequence of key events.\n"
+        "\n"
         "    --push-target path\n"
         "        Set the target directory for pushing files to the device by\n"
         "        drag & drop. It is passed as-is to \"adb push\".\n"
@@ -309,9 +307,33 @@ guess_record_format(const char *filename) {
     return 0;
 }
 
+static bool
+parse_prefer_text_events(const char *optarg,
+                         enum text_events_pref *pref) {
+    if (!strcmp(optarg, "always")) {
+        *pref = PREFER_TEXT_EVENTS_ALWAYS;
+        return true;
+    }
+
+    if (!strcmp(optarg, "non-alpha")) {
+        *pref = PREFER_TEXT_EVENTS_NON_ALPHA;
+        return true;
+    }
+
+    if (!strcmp(optarg, "never")) {
+        *pref = PREFER_TEXT_EVENTS_NEVER;
+        return true;
+    }
+
+    LOGE("Unsupported text events preference: %s"
+         "(expected 'always', 'non-alpha' or 'never')", optarg);
+    return false;
+}
+
 #define OPT_RENDER_EXPIRED_FRAMES 1000
 #define OPT_WINDOW_TITLE          1001
 #define OPT_PUSH_TARGET           1002
+#define OPT_PREFER_TEXT_EVENTS    1003
 
 static bool
 parse_args(struct args *args, int argc, char *argv[]) {
@@ -334,28 +356,33 @@ parse_args(struct args *args, int argc, char *argv[]) {
         {"serial",                required_argument, NULL, 's'},
         {"show-touches",          no_argument,       NULL, 't'},
         {"turn-screen-off",       no_argument,       NULL, 'S'},
+        {"prefer-text-events",    required_argument, NULL,
+                                                 OPT_PREFER_TEXT_EVENTS},
         {"version",               no_argument,       NULL, 'v'},
         {"window-title",          required_argument, NULL,
                                                  OPT_WINDOW_TITLE},
         {NULL,                    0,                 NULL, 0  },
     };
+
+    struct scrcpy_options *opts = &args->opts;
+
     int c;
     while ((c = getopt_long(argc, argv, "b:c:fF:hm:nNp:r:s:StTv", long_options,
                             NULL)) != -1) {
         switch (c) {
             case 'b':
-                if (!parse_bit_rate(optarg, &args->bit_rate)) {
+                if (!parse_bit_rate(optarg, &opts->bit_rate)) {
                     return false;
                 }
                 break;
             case 'c':
-                args->crop = optarg;
+                opts->crop = optarg;
                 break;
             case 'f':
-                args->fullscreen = true;
+                opts->fullscreen = true;
                 break;
             case 'F':
-                if (!parse_record_format(optarg, &args->record_format)) {
+                if (!parse_record_format(optarg, &opts->record_format)) {
                     return false;
                 }
                 break;
@@ -363,47 +390,53 @@ parse_args(struct args *args, int argc, char *argv[]) {
                 args->help = true;
                 break;
             case 'm':
-                if (!parse_max_size(optarg, &args->max_size)) {
+                if (!parse_max_size(optarg, &opts->max_size)) {
                     return false;
                 }
                 break;
             case 'n':
-                args->no_control = true;
+                opts->control = false;
                 break;
             case 'N':
-                args->no_display = true;
+                opts->display = false;
                 break;
             case 'p':
-                if (!parse_port(optarg, &args->port)) {
+                if (!parse_port(optarg, &opts->port)) {
                     return false;
                 }
                 break;
             case 'r':
-                args->record_filename = optarg;
+                opts->record_filename = optarg;
                 break;
             case 's':
-                args->serial = optarg;
+                opts->serial = optarg;
                 break;
             case 'S':
-                args->turn_screen_off = true;
+                opts->turn_screen_off = true;
                 break;
             case 't':
-                args->show_touches = true;
+                opts->show_touches = true;
                 break;
             case 'T':
-                args->always_on_top = true;
+                opts->always_on_top = true;
                 break;
             case 'v':
                 args->version = true;
                 break;
             case OPT_RENDER_EXPIRED_FRAMES:
-                args->render_expired_frames = true;
+                opts->render_expired_frames = true;
                 break;
             case OPT_WINDOW_TITLE:
-                args->window_title = optarg;
+                opts->window_title = optarg;
                 break;
             case OPT_PUSH_TARGET:
-                args->push_target = optarg;
+                opts->push_target = optarg;
+                break;
+            case OPT_PREFER_TEXT_EVENTS:
+                if (!parse_prefer_text_events(optarg,
+                                              &opts->text_events_pref)) {
+                    return false;
+                }
                 break;
             default:
                 // getopt prints the error message on stderr
@@ -411,12 +444,12 @@ parse_args(struct args *args, int argc, char *argv[]) {
         }
     }
 
-    if (args->no_display && !args->record_filename) {
+    if (!opts->display && !opts->record_filename) {
         LOGE("-N/--no-display requires screen recording (-r/--record)");
         return false;
     }
 
-    if (args->no_display && args->fullscreen) {
+    if (!opts->display && opts->fullscreen) {
         LOGE("-f/--fullscreen-window is incompatible with -N/--no-display");
         return false;
     }
@@ -427,21 +460,21 @@ parse_args(struct args *args, int argc, char *argv[]) {
         return false;
     }
 
-    if (args->record_format && !args->record_filename) {
+    if (opts->record_format && !opts->record_filename) {
         LOGE("Record format specified without recording");
         return false;
     }
 
-    if (args->record_filename && !args->record_format) {
+    if (opts->record_filename && !opts->record_format) {
-        args->record_format = guess_record_format(args->record_filename);
+        opts->record_format = guess_record_format(opts->record_filename);
-        if (!args->record_format) {
+        if (!opts->record_format) {
             LOGE("No format specified for \"%s\" (try with -F mkv)",
-                 args->record_filename);
+                 opts->record_filename);
             return false;
         }
     }
 
-    if (args->no_control && args->turn_screen_off) {
+    if (!opts->control && opts->turn_screen_off) {
         LOGE("Could not request to turn screen off if control is disabled");
         return false;
     }
@@ -458,24 +491,11 @@ main(int argc, char *argv[]) {
     setbuf(stderr, NULL);
 #endif
     struct args args = {
-        .serial = NULL,
+        .opts = SCRCPY_OPTIONS_DEFAULT,
-        .crop = NULL,
-        .record_filename = NULL,
-        .window_title = NULL,
-        .push_target = NULL,
-        .record_format = 0,
         .help = false,
         .version = false,
-        .show_touches = false,
-        .port = DEFAULT_LOCAL_PORT,
-        .max_size = DEFAULT_MAX_SIZE,
-        .bit_rate = DEFAULT_BIT_RATE,
-        .always_on_top = false,
-        .no_control = false,
-        .no_display = false,
-        .turn_screen_off = false,
-        .render_expired_frames = false,
     };
+
     if (!parse_args(&args, argc, argv)) {
         return 1;
     }
@@ -504,25 +524,7 @@ main(int argc, char *argv[]) {
     SDL_LogSetAllPriority(SDL_LOG_PRIORITY_DEBUG);
 #endif
 
-    struct scrcpy_options options = {
+    int res = scrcpy(&args.opts) ? 0 : 1;
-        .serial = args.serial,
-        .crop = args.crop,
-        .port = args.port,
-        .record_filename = args.record_filename,
-        .window_title = args.window_title,
-        .push_target = args.push_target,
-        .record_format = args.record_format,
-        .max_size = args.max_size,
-        .bit_rate = args.bit_rate,
-        .show_touches = args.show_touches,
-        .fullscreen = args.fullscreen,
-        .always_on_top = args.always_on_top,
-        .control = !args.no_control,
-        .display = !args.no_display,
-        .turn_screen_off = args.turn_screen_off,
-        .render_expired_frames = args.render_expired_frames,
-    };
-    int res = scrcpy(&options) ? 0 : 1;
 
     avformat_network_deinit(); // ignore failure
 

app/src/recorder.h

@@ -11,7 +11,8 @@
 #include "queue.h"
 
 enum recorder_format {
-    RECORDER_FORMAT_MP4 = 1,
+    RECORDER_FORMAT_AUTO,
+    RECORDER_FORMAT_MP4,
     RECORDER_FORMAT_MKV,
 };
 

app/src/scrcpy.c

@@ -42,6 +42,7 @@ static struct input_manager input_manager = {
     .controller = &controller,
     .video_buffer = &video_buffer,
     .screen = &screen,
+    .text_events_pref = 0, // initialized later
 };
 
 // init SDL and set appropriate hints
@@ -414,6 +415,8 @@ scrcpy(const struct scrcpy_options *options) {
         show_touches_waited = true;
     }
 
+    input_manager.text_events_pref = options->text_events_pref;
+
     ret = event_loop(options->display, options->control);
     LOGD("quit...");
 

app/src/scrcpy.h

@@ -3,9 +3,10 @@
 
 #include <stdbool.h>
 #include <stdint.h>
-#include <recorder.h>
 
 #include "config.h"
+#include "input_manager.h"
+#include "recorder.h"
 
 struct scrcpy_options {
     const char *serial;
@@ -14,6 +15,7 @@ struct scrcpy_options {
     const char *window_title;
     const char *push_target;
     enum recorder_format record_format;
+    enum text_events_pref text_events_pref;
     uint16_t port;
     uint16_t max_size;
     uint32_t bit_rate;
@@ -26,6 +28,26 @@ struct scrcpy_options {
     bool render_expired_frames;
 };
 
+#define SCRCPY_OPTIONS_DEFAULT { \
+    .serial = NULL, \
+    .crop = NULL, \
+    .record_filename = NULL, \
+    .window_title = NULL, \
+    .push_target = NULL, \
+    .record_format = RECORDER_FORMAT_AUTO, \
+    .text_events_pref = PREFER_TEXT_EVENTS_ALWAYS, \
+    .port = DEFAULT_LOCAL_PORT, \
+    .max_size = DEFAULT_LOCAL_PORT, \
+    .bit_rate = DEFAULT_BIT_RATE, \
+    .show_touches = false, \
+    .fullscreen = false, \
+    .always_on_top = false, \
+    .control = true, \
+    .display = true, \
+    .turn_screen_off = false, \
+    .render_expired_frames = false, \
+}
+
 bool
 scrcpy(const struct scrcpy_options *options);
 

app/src/server.c

@@ -124,6 +124,11 @@ execute_server(struct server *server, const struct server_params *params) {
         "shell",
         "CLASSPATH=/data/local/tmp/" SERVER_FILENAME,
         "app_process",
+#ifdef SERVER_DEBUGGER
+# define SERVER_DEBUGGER_PORT "5005"
+        "-agentlib:jdwp=transport=dt_socket,suspend=y,server=y,address="
+            SERVER_DEBUGGER_PORT,
+#endif
         "/", // unused
         "com.genymobile.scrcpy.Server",
         max_size_string,
@@ -133,6 +138,17 @@ execute_server(struct server *server, const struct server_params *params) {
         "true", // always send frame meta (packet boundaries + timestamp)
         params->control ? "true" : "false",
     };
+#ifdef SERVER_DEBUGGER
+    LOGI("Server debugger waiting for a client on device port "
+         SERVER_DEBUGGER_PORT "...");
+    // From the computer, run
+    //     adb forward tcp:5005 tcp:5005
+    // Then, from Android Studio: Run > Debug > Edit configurations...
+    // On the left, click on '+', "Remote", with:
+    //     Host: localhost
+    //     Port: 5005
+    // Then click on "Debug"
+#endif
     return adb_execute(server->serial, cmd, sizeof(cmd) / sizeof(cmd[0]));
 }
 

meson_options.txt

@@ -5,3 +5,4 @@ option('windows_noconsole', type: 'boolean', value: false, description: 'Disable
 option('prebuilt_server', type: 'string', description: 'Path of the prebuilt server')
 option('portable', type: 'boolean', value: false, description: 'Use scrcpy-server from the same directory as the scrcpy executable')
 option('hidpi_support', type: 'boolean', value: true, description: 'Enable High DPI support')
+option('server_debugger', type: 'boolean', value: false, description: 'Run a server debugger and wait for a client to be attached')