Add --display-orientation

Deprecate the option --rotation and introduce a new option
--display-orientation with the 8 possible orientations (0, 90, 180, 270,
flip0, flip90, flip180 and flip270).

New shortcuts MOD+Shift+(arrow) dynamically change the display
(horizontal or vertical) flip.

Fixes #1380 <#1380>
Fixes #3819 <#3819>
PR #4441 <#4441>

app/data/bash-completion/scrcpy

@@ -21,6 +21,7 @@ _scrcpy() {
         --disable-screensaver
         --display-buffer=
         --display-id=
+        --display-orientation=
         -e --select-tcpip
         -f --fullscreen
         --force-adb-forward
@@ -112,6 +113,10 @@ _scrcpy() {
             COMPREPLY=($(compgen -W 'front back external' -- "$cur"))
             return
             ;;
+        --display-orientation)
+            COMPREPLY=($(compgen -> '0 90 180 270 flip0 flip90 flip180 flip270' -- "$cur"))
+            return
+            ;;
         --lock-video-orientation)
             COMPREPLY=($(compgen -W 'unlocked initial 0 1 2 3' -- "$cur"))
             return
@@ -132,10 +137,6 @@ _scrcpy() {
             COMPREPLY=($(compgen -W 'direct3d opengl opengles2 opengles metal software' -- "$cur"))
             return
             ;;
-        --rotation)
-            COMPREPLY=($(compgen -W '0 1 2 3' -- "$cur"))
-            return
-            ;;
         --shortcut-mod)
             # Only auto-complete a single key
             COMPREPLY=($(compgen -W 'lctrl rctrl lalt ralt lsuper rsuper' -- "$cur"))

app/data/zsh-completion/_scrcpy

@@ -28,6 +28,7 @@ arguments=(
     '--disable-screensaver[Disable screensaver while scrcpy is running]'
     '--display-buffer=[Add a buffering delay \(in milliseconds\) before displaying]'
     '--display-id=[Specify the display id to mirror]'
+    '--display-orientation=[Set the initial display orientation]:orientation values:(0 90 180 270 flip0 flip90 flip180 flip270)'
     {-e,--select-tcpip}'[Use TCP/IP device]'
     {-f,--fullscreen}'[Start in fullscreen]'
     '--force-adb-forward[Do not attempt to use \"adb reverse\" to connect to the device]'
@@ -68,7 +69,6 @@ arguments=(
     '--record-format=[Force recording format]:format:(mp4 mkv m4a mka opus aac flac wav)'
     '--render-driver=[Request SDL to use the given render driver]:driver name:(direct3d opengl opengles2 opengles metal software)'
     '--require-audio=[Make scrcpy fail if audio is enabled but does not work]'
-    '--rotation=[Set the initial display rotation]:rotation values:(0 1 2 3)'
     {-s,--serial=}'[The device serial number \(mandatory for multiple devices only\)]:serial:($("${ADB-adb}" devices | awk '\''$2 == "device" {print $1}'\''))'
     {-S,--turn-screen-off}'[Turn the device screen off immediately]'
     '--shortcut-mod=[\[key1,key2+key3,...\] Specify the modifiers to use for scrcpy shortcuts]:shortcut mod:(lctrl rctrl lalt ralt lsuper rsuper)'

app/meson.build

@@ -289,6 +289,10 @@ if get_option('buildtype') == 'debug'
             'tests/test_device_msg_deserialize.c',
             'src/device_msg.c',
         ]],
+        ['test_orientation', [
+            'tests/test_orientation.c',
+            'src/options.c',
+        ]],
         ['test_strbuf', [
             'tests/test_strbuf.c',
             'src/util/strbuf.c',

app/scrcpy.1

@@ -141,6 +141,14 @@ The available display ids can be listed by \fB\-\-list\-displays\fR.
 
 Default is 0.
 
+.TP
+.BI "\-\-display\-orientation " value
+Set the initial display orientation.
+
+Possible values are 0, 90, 180, 270, flip0, flip90, flip180 and flip270. The number represents the clockwise rotation in degrees; the "flip" keyword applies a horizontal flip before the rotation.
+
+Default is 0.
+
 .TP
 .B \-e, \-\-select\-tcpip
 Use TCP/IP device (if there is exactly one, like adb -e).
@@ -369,10 +377,6 @@ Supported names are currently "direct3d", "opengl", "opengles2", "opengles", "me
 .B \-\-require\-audio
 By default, scrcpy mirrors only the video if audio capture fails on the device. This option makes scrcpy fail if audio is enabled but does not work.
 
-.TP
-.BI "\-\-rotation " value
-Set the initial display rotation. Possibles values are 0, 1, 2 and 3. Each increment adds a 90 degrees rotation counterclockwise.
-
 .TP
 .BI "\-s, \-\-serial " number
 The device serial number. Mandatory only if several devices are connected to adb.
@@ -534,6 +538,14 @@ Rotate display left
 .B MOD+Right
 Rotate display right
 
+.TP
+.B MOD+Shift+Left, MOD+Shift+Right
+Flip display horizontally
+
+.TP
+.B MOD+Shift+Up, MOD+Shift+Down
+Flip display vertically
+
 .TP
 .B MOD+g
 Resize window to 1:1 (pixel\-perfect)

app/src/cli.c

@@ -90,6 +90,7 @@ enum {
     OPT_CAMERA_AR,
     OPT_CAMERA_FPS,
     OPT_CAMERA_HIGH_SPEED,
+    OPT_DISPLAY_ORIENTATION,
 };
 
 struct sc_option {
@@ -309,6 +310,17 @@ static const struct sc_option options[] = {
                 "    scrcpy --list-displays\n"
                 "Default is 0.",
     },
+    {
+        .longopt_id = OPT_DISPLAY_ORIENTATION,
+        .longopt = "display-orientation",
+        .argdesc = "value",
+        .text = "Set the initial display orientation.\n"
+                "Possible values are 0, 90, 180, 270, flip0, flip90, flip180 "
+                "and flip270. The number represents the clockwise rotation "
+                "in degrees; the \"flip\" keyword applies a horizontal flip "
+                "before the rotation.\n"
+                "Default is 0.",
+    },
     {
         .shortopt = 'e',
         .longopt = "select-tcpip",
@@ -615,12 +627,10 @@ static const struct sc_option options[] = {
                 "is enabled but does not work."
     },
     {
+        // deprecated
         .longopt_id = OPT_ROTATION,
         .longopt = "rotation",
         .argdesc = "value",
-        .text = "Set the initial display rotation.\n"
-                "Possible values are 0, 1, 2 and 3. Each increment adds a 90 "
-                "degrees rotation counterclockwise.",
     },
     {
         .shortopt = 's',
@@ -824,6 +834,14 @@ static const struct sc_shortcut shortcuts[] = {
         .shortcuts = { "MOD+Right" },
         .text = "Rotate display right",
     },
+    {
+        .shortcuts = { "MOD+Shift+Left", "MOD+Shift+Right" },
+        .text = "Flip display horizontally",
+    },
+    {
+        .shortcuts = { "MOD+Shift+Up", "MOD+Shift+Down" },
+        .text = "Flip display vertically",
+    },
     {
         .shortcuts = { "MOD+g" },
         .text = "Resize window to 1:1 (pixel-perfect)",
@@ -1405,6 +1423,45 @@ parse_rotation(const char *s, uint8_t *rotation) {
     return true;
 }
 
+static bool
+parse_orientation(const char *s, enum sc_orientation *orientation) {
+    if (!strcmp(s, "0")) {
+        *orientation = SC_ORIENTATION_0;
+        return true;
+    }
+    if (!strcmp(s, "90")) {
+        *orientation = SC_ORIENTATION_90;
+        return true;
+    }
+    if (!strcmp(s, "180")) {
+        *orientation = SC_ORIENTATION_180;
+        return true;
+    }
+    if (!strcmp(s, "270")) {
+        *orientation = SC_ORIENTATION_270;
+        return true;
+    }
+    if (!strcmp(s, "flip0")) {
+        *orientation = SC_ORIENTATION_FLIP_0;
+        return true;
+    }
+    if (!strcmp(s, "flip90")) {
+        *orientation = SC_ORIENTATION_FLIP_90;
+        return true;
+    }
+    if (!strcmp(s, "flip180")) {
+        *orientation = SC_ORIENTATION_FLIP_180;
+        return true;
+    }
+    if (!strcmp(s, "flip270")) {
+        *orientation = SC_ORIENTATION_FLIP_270;
+        return true;
+    }
+    LOGE("Unsupported orientation: %s (expected 0, 90, 180, 270, flip0, "
+         "flip90, flip180 or flip270)", optarg);
+    return false;
+}
+
 static bool
 parse_window_position(const char *s, int16_t *position) {
     // special value for "auto"
@@ -2008,7 +2065,34 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
                 opts->key_inject_mode = SC_KEY_INJECT_MODE_RAW;
                 break;
             case OPT_ROTATION:
-                if (!parse_rotation(optarg, &opts->rotation)) {
+                LOGW("--rotation is deprecated, use --display-orientation "
+                     "instead.");
+                uint8_t rotation;
+                if (!parse_rotation(optarg, &rotation)) {
+                    return false;
+                }
+                assert(rotation <= 3);
+                switch (rotation) {
+                    case 0:
+                        opts->display_orientation = SC_ORIENTATION_0;
+                        break;
+                    case 1:
+                        // rotation 1 was 90° counterclockwise, but orientation
+                        // is expressed clockwise
+                        opts->display_orientation = SC_ORIENTATION_270;
+                        break;
+                    case 2:
+                        opts->display_orientation = SC_ORIENTATION_180;
+                        break;
+                    case 3:
+                        // rotation 3 was 270° counterclockwise, but orientation
+                        // is expressed clockwise
+                        opts->display_orientation = SC_ORIENTATION_90;
+                        break;
+                }
+                break;
+            case OPT_DISPLAY_ORIENTATION:
+                if (!parse_orientation(optarg, &opts->display_orientation)) {
                     return false;
                 }
                 break;

app/src/display.c

@@ -234,7 +234,7 @@ sc_display_update_texture(struct sc_display *display, const AVFrame *frame) {
 
 enum sc_display_result
 sc_display_render(struct sc_display *display, const SDL_Rect *geometry,
-                  unsigned rotation) {
+                  enum sc_orientation orientation) {
     SDL_RenderClear(display->renderer);
 
     if (display->pending.flags) {
@@ -247,33 +247,33 @@ sc_display_render(struct sc_display *display, const SDL_Rect *geometry,
     SDL_Renderer *renderer = display->renderer;
     SDL_Texture *texture = display->texture;
 
-    if (rotation == 0) {
+    if (orientation == SC_ORIENTATION_0) {
         int ret = SDL_RenderCopy(renderer, texture, NULL, geometry);
         if (ret) {
             LOGE("Could not render texture: %s", SDL_GetError());
             return SC_DISPLAY_RESULT_ERROR;
         }
     } else {
-        // rotation in RenderCopyEx() is clockwise, while screen->rotation is
-        // counterclockwise (to be consistent with --lock-video-orientation)
-        int cw_rotation = (4 - rotation) % 4;
+        unsigned cw_rotation = sc_orientation_get_rotation(orientation);
         double angle = 90 * cw_rotation;
 
         const SDL_Rect *dstrect = NULL;
         SDL_Rect rect;
-        if (rotation & 1) {
+        if (sc_orientation_is_swap(orientation)) {
             rect.x = geometry->x + (geometry->w - geometry->h) / 2;
             rect.y = geometry->y + (geometry->h - geometry->w) / 2;
             rect.w = geometry->h;
             rect.h = geometry->w;
             dstrect = ▭
         } else {
-            assert(rotation == 2);
             dstrect = geometry;
         }
 
+        SDL_RendererFlip flip = sc_orientation_is_mirror(orientation)
+                              ? SDL_FLIP_HORIZONTAL : 0;
+
         int ret = SDL_RenderCopyEx(renderer, texture, NULL, dstrect, angle,
-                                   NULL, 0);
+                                   NULL, flip);
         if (ret) {
             LOGE("Could not render texture: %s", SDL_GetError());
             return SC_DISPLAY_RESULT_ERROR;

app/src/display.h

@@ -9,6 +9,7 @@
 
 #include "coords.h"
 #include "opengl.h"
+#include "options.h"
 
 #ifdef __APPLE__
 # define SC_DISPLAY_FORCE_OPENGL_CORE_PROFILE
@@ -54,6 +55,6 @@ sc_display_update_texture(struct sc_display *display, const AVFrame *frame);
 
 enum sc_display_result
 sc_display_render(struct sc_display *display, const SDL_Rect *geometry,
-                  unsigned rotation);
+                  enum sc_orientation orientation);
 
 #endif

app/src/input_manager.c

@@ -293,15 +293,11 @@ rotate_device(struct sc_controller *controller) {
 }
 
 static void
-rotate_client_left(struct sc_screen *screen) {
-    unsigned new_rotation = (screen->rotation + 1) % 4;
-    sc_screen_set_rotation(screen, new_rotation);
-}
-
-static void
-rotate_client_right(struct sc_screen *screen) {
-    unsigned new_rotation = (screen->rotation + 3) % 4;
-    sc_screen_set_rotation(screen, new_rotation);
+apply_orientation_transform(struct sc_screen *screen,
+                            enum sc_orientation transform) {
+    enum sc_orientation new_orientation =
+        sc_orientation_apply(screen->orientation, transform);
+    sc_screen_set_orientation(screen, new_orientation);
 }
 
 static void
@@ -421,25 +417,47 @@ sc_input_manager_process_key(struct sc_input_manager *im,
                 }
                 return;
             case SDLK_DOWN:
-                if (controller && !shift) {
+                if (shift) {
+                    if (!repeat & down) {
+                        apply_orientation_transform(im->screen,
+                                                    SC_ORIENTATION_FLIP_180);
+                    }
+                } else if (controller) {
                     // forward repeated events
                     action_volume_down(controller, action);
                 }
                 return;
             case SDLK_UP:
-                if (controller && !shift) {
+                if (shift) {
+                    if (!repeat & down) {
+                        apply_orientation_transform(im->screen,
+                                                    SC_ORIENTATION_FLIP_180);
+                    }
+                } else if (controller) {
                     // forward repeated events
                     action_volume_up(controller, action);
                 }
                 return;
             case SDLK_LEFT:
-                if (!shift && !repeat && down) {
-                    rotate_client_left(im->screen);
+                if (!repeat && down) {
+                    if (shift) {
+                        apply_orientation_transform(im->screen,
+                                                    SC_ORIENTATION_FLIP_0);
+                    } else {
+                        apply_orientation_transform(im->screen,
+                                                    SC_ORIENTATION_270);
+                    }
                 }
                 return;
             case SDLK_RIGHT:
-                if (!shift && !repeat && down) {
-                    rotate_client_right(im->screen);
+                if (!repeat && down) {
+                    if (shift) {
+                        apply_orientation_transform(im->screen,
+                                                    SC_ORIENTATION_FLIP_0);
+                    } else {
+                        apply_orientation_transform(im->screen,
+                                                    SC_ORIENTATION_90);
+                    }
                 }
                 return;
             case SDLK_c: