Add option to lock video orientation

PR #1151 <https://github.com/Genymobile/scrcpy/pull/1151>

Signed-off-by: Romain Vimont <rom@rom1v.com>

README.md

@@ -179,6 +179,21 @@ scrcpy --crop 1224:1440:0:0   # 1224x1440 at offset (0,0)
 If `--max-size` is also specified, resizing is applied after cropping.
 
 
+#### Lock video orientation
+
+
+To lock the orientation of the mirroring:
+
+```bash
+scrcpy --lock-video-orientation 0   # natural orientation
+scrcpy --lock-video-orientation 1   # 90° counterclockwise
+scrcpy --lock-video-orientation 2   # 180°
+scrcpy --lock-video-orientation 3   # 90° clockwise
+```
+
+This affects recording orientation.
+
+
 ### Recording
 
 It is possible to record the screen while mirroring:

app/meson.build

@@ -105,6 +105,12 @@ conf.set('DEFAULT_LOCAL_PORT_RANGE_LAST', '27199')
 # overridden by option --max-size
 conf.set('DEFAULT_MAX_SIZE', '0')  # 0: unlimited
 
+# the default video orientation
+# natural device orientation is 0 and each increment adds 90 degrees
+# counterclockwise
+# overridden by option --lock-video-orientation
+conf.set('DEFAULT_LOCK_VIDEO_ORIENTATION', '-1')  # -1: unlocked
+
 # the default video bitrate, in bits/second
 # overridden by option --bit-rate
 conf.set('DEFAULT_BIT_RATE', '8000000')  # 8Mbps

app/scrcpy.1

@@ -41,6 +41,12 @@ Start in fullscreen.
 .B \-h, \-\-help
 Print this help.
 
+.TP
+.BI "\-\-lock\-video\-orientation " value
+Lock video orientation to \fIvalue\fR. Values are integers in the range [-1..3]. Natural device orientation is 0 and each increment adds 90 degrees counterclockwise.
+
+Default is -1 (unlocked).
+
 .TP
 .BI "\-\-max\-fps " value
 Limit the framerate of screen capture (officially supported since Android 10, but may work on earlier versions).

app/src/cli.c

@@ -41,6 +41,12 @@ scrcpy_print_usage(const char *arg0) {
         "    -h, --help\n"
         "        Print this help.\n"
         "\n"
+        "    --lock-video-orientation value\n"
+        "        Lock video orientation to value. Values are integers in the\n"
+        "        range [-1..3]. Natural device orientation is 0 and each\n"
+        "        increment adds 90 degrees counterclockwise.\n"
+        "        Default is %d%s.\n"
+        "\n"
         "    --max-fps value\n"
         "        Limit the frame rate of screen capture (officially supported\n"
         "        since Android 10, but may work on earlier versions).\n"
@@ -192,6 +198,7 @@ scrcpy_print_usage(const char *arg0) {
         "\n",
         arg0,
         DEFAULT_BIT_RATE,
+        DEFAULT_LOCK_VIDEO_ORIENTATION, DEFAULT_LOCK_VIDEO_ORIENTATION >= 0 ? "" : " (unlocked)",
         DEFAULT_MAX_SIZE, DEFAULT_MAX_SIZE ? "" : " (unlimited)",
         DEFAULT_LOCAL_PORT_RANGE_FIRST, DEFAULT_LOCAL_PORT_RANGE_LAST);
 }
@@ -280,6 +287,19 @@ parse_max_fps(const char *s, uint16_t *max_fps) {
     return true;
 }
 
+static bool
+parse_lock_video_orientation(const char *s, int8_t *lock_video_orientation) {
+    long value;
+    bool ok = parse_integer_arg(s, &value, false, -1, 3,
+                                "lock video orientation");
+    if (!ok) {
+        return false;
+    }
+
+    *lock_video_orientation = (int8_t) value;
+    return true;
+}
+
 static bool
 parse_window_position(const char *s, int16_t *position) {
     long value;
@@ -377,6 +397,7 @@ guess_record_format(const char *filename) {
 #define OPT_WINDOW_HEIGHT          1010
 #define OPT_WINDOW_BORDERLESS      1011
 #define OPT_MAX_FPS                1012
+#define OPT_LOCK_VIDEO_ORIENTATION 1013
 
 bool
 scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
@@ -386,6 +407,8 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
         {"crop",                   required_argument, NULL, OPT_CROP},
         {"fullscreen",             no_argument,       NULL, 'f'},
         {"help",                   no_argument,       NULL, 'h'},
+        {"lock-video-orientation", required_argument, NULL,
+                                                  OPT_LOCK_VIDEO_ORIENTATION},
         {"max-fps",                required_argument, NULL, OPT_MAX_FPS},
         {"max-size",               required_argument, NULL, 'm'},
         {"no-control",             no_argument,       NULL, 'n'},
@@ -454,6 +477,11 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
                     return false;
                 }
                 break;
+            case OPT_LOCK_VIDEO_ORIENTATION:
+                if (!parse_lock_video_orientation(optarg, &opts->lock_video_orientation)) {
+                    return false;
+                }
+                break;
             case 'n':
                 opts->control = false;
                 break;

app/src/scrcpy.c

@@ -284,6 +284,7 @@ scrcpy(const struct scrcpy_options *options) {
         .max_size = options->max_size,
         .bit_rate = options->bit_rate,
         .max_fps = options->max_fps,
+        .lock_video_orientation = options->lock_video_orientation,
         .control = options->control,
     };
     if (!server_start(&server, options->serial, &params)) {

app/src/scrcpy.h

@@ -20,6 +20,7 @@ struct scrcpy_options {
     uint16_t max_size;
     uint32_t bit_rate;
     uint16_t max_fps;
+    int8_t lock_video_orientation;
     int16_t window_x;
     int16_t window_y;
     uint16_t window_width;
@@ -49,6 +50,7 @@ struct scrcpy_options {
     .max_size = DEFAULT_MAX_SIZE, \
     .bit_rate = DEFAULT_BIT_RATE, \
     .max_fps = 0, \
+    .lock_video_orientation = DEFAULT_LOCK_VIDEO_ORIENTATION, \
     .window_x = -1, \
     .window_y = -1, \
     .window_width = 0, \

app/src/server.c

@@ -233,9 +233,11 @@ execute_server(struct server *server, const struct server_params *params) {
     char max_size_string[6];
     char bit_rate_string[11];
     char max_fps_string[6];
+    char lock_video_orientation_string[3];
     sprintf(max_size_string, "%"PRIu16, params->max_size);
     sprintf(bit_rate_string, "%"PRIu32, params->bit_rate);
     sprintf(max_fps_string, "%"PRIu16, params->max_fps);
+    sprintf(lock_video_orientation_string, "%"PRIi8, params->lock_video_orientation);
     const char *const cmd[] = {
         "shell",
         "CLASSPATH=" DEVICE_SERVER_PATH,
@@ -251,6 +253,7 @@ execute_server(struct server *server, const struct server_params *params) {
         max_size_string,
         bit_rate_string,
         max_fps_string,
+        lock_video_orientation_string,
         server->tunnel_forward ? "true" : "false",
         params->crop ? params->crop : "-",
         "true", // always send frame meta (packet boundaries + timestamp)

app/src/server.h

@@ -42,6 +42,7 @@ struct server_params {
     uint16_t max_size;
     uint32_t bit_rate;
     uint16_t max_fps;
+    int8_t lock_video_orientation;
     bool control;
 };
 

app/tests/test_cli.c

@@ -48,6 +48,7 @@ static void test_options(void) {
         "--fullscreen",
         "--max-fps", "30",
         "--max-size", "1024",
+        "--lock-video-orientation", "2",
         // "--no-control" is not compatible with "--turn-screen-off"
         // "--no-display" is not compatible with "--fulscreen"
         "--port", "1234:1236",
@@ -78,6 +79,7 @@ static void test_options(void) {
     assert(opts->fullscreen);
     assert(opts->max_fps == 30);
     assert(opts->max_size == 1024);
+    assert(opts->lock_video_orientation == 2);
     assert(opts->port_range.first == 1234);
     assert(opts->port_range.last == 1236);
     assert(!strcmp(opts->push_target, "/sdcard/Movies"));

server/src/main/java/com/genymobile/scrcpy/Device.java

@@ -22,10 +22,12 @@ public final class Device {
 
     private final ServiceManager serviceManager = new ServiceManager();
 
+    private final int lockedVideoOrientation;
     private ScreenInfo screenInfo;
     private RotationListener rotationListener;
 
     public Device(Options options) {
+        lockedVideoOrientation = options.getLockedVideoOrientation();
         screenInfo = computeScreenInfo(options.getCrop(), options.getMaxSize());
         registerRotationWatcher(new IRotationWatcher.Stub() {
             @Override
@@ -48,11 +50,11 @@ public final class Device {
 
     private ScreenInfo computeScreenInfo(Rect crop, int maxSize) {
         DisplayInfo displayInfo = serviceManager.getDisplayManager().getDisplayInfo();
-        boolean rotated = (displayInfo.getRotation() & 1) != 0;
+        int rotation = displayInfo.getRotation();
         Size deviceSize = displayInfo.getSize();
         Rect contentRect = new Rect(0, 0, deviceSize.getWidth(), deviceSize.getHeight());
         if (crop != null) {
-            if (rotated) {
+            if (rotation % 2 != 0) { // 180s preserve dimensions
                 // the crop (provided by the user) is expressed in the natural orientation
                 crop = flipRect(crop);
             }
@@ -64,7 +66,7 @@ public final class Device {
         }
 
         Size videoSize = computeVideoSize(contentRect.width(), contentRect.height(), maxSize);
-        return new ScreenInfo(contentRect, videoSize, rotated);
+        return new ScreenInfo(contentRect, videoSize, rotation);
     }
 
     private static String formatCrop(Rect rect) {
@@ -99,22 +101,56 @@ public final class Device {
         return new Size(w, h);
     }
 
+    /**
+     * Return the rotation to apply to the device rotation to get the requested locked video orientation
+     *
+     * @param deviceRotation the device rotation
+     * @return the rotation offset
+     */
+    public int getVideoRotation(int deviceRotation) {
+        if (lockedVideoOrientation == -1) {
+            // no offset
+            return 0;
+        }
+        return (deviceRotation + 4 - lockedVideoOrientation) % 4;
+    }
+
+    /**
+     * Return the rotation to apply to the requested locked video orientation to get the device rotation
+     *
+     * @param deviceRotation the device rotation
+     * @return the (reverse) rotation offset
+     */
+    private int getReverseVideoRotation(int deviceRotation) {
+        if (lockedVideoOrientation == -1) {
+            // no offset
+            return 0;
+        }
+        return (lockedVideoOrientation + 4 - deviceRotation) % 4;
+    }
+
     public Point getPhysicalPoint(Position position) {
         // it hides the field on purpose, to read it with a lock
         @SuppressWarnings("checkstyle:HiddenField")
         ScreenInfo screenInfo = getScreenInfo(); // read with synchronization
         Size videoSize = screenInfo.getVideoSize();
-        Size clientVideoSize = position.getScreenSize();
+
+        int deviceRotation = screenInfo.getRotation();
+        int reverseVideoRotation = getReverseVideoRotation(deviceRotation);
+        // reverse the video rotation to apply the events
+        Position devicePosition = position.rotate(reverseVideoRotation);
+
+        Size clientVideoSize = devicePosition.getScreenSize();
         if (!videoSize.equals(clientVideoSize)) {
             // The client sends a click relative to a video with wrong dimensions,
             // the device may have been rotated since the event was generated, so ignore the event
             return null;
         }
         Rect contentRect = screenInfo.getContentRect();
-        Point point = position.getPoint();
+        Point point = devicePosition.getPoint();
-        int scaledX = contentRect.left + point.getX() * contentRect.width() / videoSize.getWidth();
+        int convertedX = contentRect.left + point.getX() * contentRect.width() / videoSize.getWidth();
-        int scaledY = contentRect.top + point.getY() * contentRect.height() / videoSize.getHeight();
+        int convertedY = contentRect.top + point.getY() * contentRect.height() / videoSize.getHeight();
-        return new Point(scaledX, scaledY);
+        return new Point(convertedX, convertedY);
     }
 
     public static String getDeviceName() {

server/src/main/java/com/genymobile/scrcpy/Options.java

@@ -6,6 +6,7 @@ public class Options {
     private int maxSize;
     private int bitRate;
     private int maxFps;
+    private int lockedVideoOrientation;
     private boolean tunnelForward;
     private Rect crop;
     private boolean sendFrameMeta; // send PTS so that the client may record properly
@@ -35,6 +36,14 @@ public class Options {
         this.maxFps = maxFps;
     }
 
+    public int getLockedVideoOrientation() {
+        return lockedVideoOrientation;
+    }
+
+    public void setLockedVideoOrientation(int lockedVideoOrientation) {
+        this.lockedVideoOrientation = lockedVideoOrientation;
+    }
+
     public boolean isTunnelForward() {
         return tunnelForward;
     }

server/src/main/java/com/genymobile/scrcpy/Position.java

@@ -23,6 +23,19 @@ public class Position {
         return screenSize;
     }
 
+    public Position rotate(int rotation) {
+        switch (rotation) {
+            case 1:
+                return new Position(new Point(screenSize.getHeight() - point.getY(), point.getX()), screenSize.rotate());
+            case 2:
+                return new Position(new Point(screenSize.getWidth() - point.getX(), screenSize.getHeight() - point.getY()), screenSize);
+            case 3:
+                return new Position(new Point(point.getY(), screenSize.getWidth() - point.getX()), screenSize.rotate());
+            default:
+                return this;
+        }
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {

server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java

@@ -28,19 +28,21 @@ public class ScreenEncoder implements Device.RotationListener {
 
     private int bitRate;
     private int maxFps;
+    private int lockedVideoOrientation;
     private int iFrameInterval;
     private boolean sendFrameMeta;
     private long ptsOrigin;
 
-    public ScreenEncoder(boolean sendFrameMeta, int bitRate, int maxFps, int iFrameInterval) {
+    public ScreenEncoder(boolean sendFrameMeta, int bitRate, int maxFps, int lockedVideoOrientation, int iFrameInterval) {
         this.sendFrameMeta = sendFrameMeta;
         this.bitRate = bitRate;
         this.maxFps = maxFps;
+        this.lockedVideoOrientation = lockedVideoOrientation;
         this.iFrameInterval = iFrameInterval;
     }
 
-    public ScreenEncoder(boolean sendFrameMeta, int bitRate, int maxFps) {
+    public ScreenEncoder(boolean sendFrameMeta, int bitRate, int maxFps, int lockedVideoOrientation) {
-        this(sendFrameMeta, bitRate, maxFps, DEFAULT_I_FRAME_INTERVAL);
+        this(sendFrameMeta, bitRate, maxFps, lockedVideoOrientation, DEFAULT_I_FRAME_INTERVAL);
     }
 
     @Override
@@ -66,10 +68,11 @@ public class ScreenEncoder implements Device.RotationListener {
                 ScreenInfo screenInfo = device.getScreenInfo();
                 Rect contentRect = screenInfo.getContentRect();
                 Rect videoRect = screenInfo.getVideoSize().toRect();
-                setSize(format, videoRect.width(), videoRect.height());
+                int videoRotation = device.getVideoRotation(screenInfo.getRotation());
+                setSize(format, videoRotation, videoRect.width(), videoRect.height());
                 configure(codec, format);
                 Surface surface = codec.createInputSurface();
-                setDisplaySurface(display, surface, contentRect, videoRect);
+                setDisplaySurface(display, surface, videoRotation, contentRect, videoRect);
                 codec.start();
                 try {
                     alive = encode(codec, fd);
@@ -168,16 +171,21 @@ public class ScreenEncoder implements Device.RotationListener {
         codec.configure(format, null, null, MediaCodec.CONFIGURE_FLAG_ENCODE);
     }
 
-    private static void setSize(MediaFormat format, int width, int height) {
+    private static void setSize(MediaFormat format, int orientation, int width, int height) {
+        if (orientation % 2 == 0) {
             format.setInteger(MediaFormat.KEY_WIDTH, width);
             format.setInteger(MediaFormat.KEY_HEIGHT, height);
+            return;
+        }
+        format.setInteger(MediaFormat.KEY_WIDTH, height);
+        format.setInteger(MediaFormat.KEY_HEIGHT, width);
     }
 
-    private static void setDisplaySurface(IBinder display, Surface surface, Rect deviceRect, Rect displayRect) {
+    private static void setDisplaySurface(IBinder display, Surface surface, int orientation, Rect deviceRect, Rect displayRect) {
         SurfaceControl.openTransaction();
         try {
             SurfaceControl.setDisplaySurface(display, surface);
-            SurfaceControl.setDisplayProjection(display, 0, deviceRect, displayRect);
+            SurfaceControl.setDisplayProjection(display, orientation, deviceRect, displayRect);
             SurfaceControl.setDisplayLayerStack(display, 0);
         } finally {
             SurfaceControl.closeTransaction();

server/src/main/java/com/genymobile/scrcpy/ScreenInfo.java

@@ -5,12 +5,12 @@ import android.graphics.Rect;
 public final class ScreenInfo {
     private final Rect contentRect; // device size, possibly cropped
     private final Size videoSize;
-    private final boolean rotated;
+    private final int rotation;
 
-    public ScreenInfo(Rect contentRect, Size videoSize, boolean rotated) {
+    public ScreenInfo(Rect contentRect, Size videoSize, int rotation) {
         this.contentRect = contentRect;
         this.videoSize = videoSize;
-        this.rotated = rotated;
+        this.rotation = rotation;
     }
 
     public Rect getContentRect() {
@@ -21,11 +21,25 @@ public final class ScreenInfo {
         return videoSize;
     }
 
-    public ScreenInfo withRotation(int rotation) {
+    public int getRotation() {
-        boolean newRotated = (rotation & 1) != 0;
+        return rotation;
-        if (rotated == newRotated) {
+    }
+
+    public ScreenInfo withRotation(int newRotation) {
+        if (newRotation == rotation) {
             return this;
         }
-        return new ScreenInfo(Device.flipRect(contentRect), videoSize.rotate(), newRotated);
+        // true if changed between portrait and landscape
+        boolean orientationChanged = (rotation + newRotation) % 2 != 0;
+        Rect newContentRect;
+        Size newVideoSize;
+        if (orientationChanged) {
+            newContentRect = Device.flipRect(contentRect);
+            newVideoSize = videoSize.rotate();
+        } else {
+            newContentRect = contentRect;
+            newVideoSize = videoSize;
+        }
+        return new ScreenInfo(newContentRect, newVideoSize, newRotation);
     }
 }

server/src/main/java/com/genymobile/scrcpy/Server.java

@@ -19,7 +19,8 @@ public final class Server {
         final Device device = new Device(options);
         boolean tunnelForward = options.isTunnelForward();
         try (DesktopConnection connection = DesktopConnection.open(device, tunnelForward)) {
-            ScreenEncoder screenEncoder = new ScreenEncoder(options.getSendFrameMeta(), options.getBitRate(), options.getMaxFps());
+            ScreenEncoder screenEncoder = new ScreenEncoder(options.getSendFrameMeta(), options.getBitRate(), options.getMaxFps(),
+                    options.getLockedVideoOrientation());
 
             if (options.getControl()) {
                 Controller controller = new Controller(device, connection);
@@ -79,8 +80,8 @@ public final class Server {
                     "The server version (" + clientVersion + ") does not match the client " + "(" + BuildConfig.VERSION_NAME + ")");
         }
 
-        if (args.length != 8) {
+        if (args.length != 9) {
-            throw new IllegalArgumentException("Expecting 8 parameters");
+            throw new IllegalArgumentException("Expecting 9 parameters");
         }
 
         Options options = new Options();
@@ -94,17 +95,20 @@ public final class Server {
         int maxFps = Integer.parseInt(args[3]);
         options.setMaxFps(maxFps);
 
+        int lockedVideoOrientation = Integer.parseInt(args[4]);
+        options.setLockedVideoOrientation(lockedVideoOrientation);
+
         // use "adb forward" instead of "adb tunnel"? (so the server must listen)
-        boolean tunnelForward = Boolean.parseBoolean(args[4]);
+        boolean tunnelForward = Boolean.parseBoolean(args[5]);
         options.setTunnelForward(tunnelForward);
 
-        Rect crop = parseCrop(args[5]);
+        Rect crop = parseCrop(args[6]);
         options.setCrop(crop);
 
-        boolean sendFrameMeta = Boolean.parseBoolean(args[6]);
+        boolean sendFrameMeta = Boolean.parseBoolean(args[7]);
         options.setSendFrameMeta(sendFrameMeta);
 
-        boolean control = Boolean.parseBoolean(args[7]);
+        boolean control = Boolean.parseBoolean(args[8]);
         options.setControl(control);
 
         return options;