From 94031dfe97402d322e50c4d156456057fad53da0 Mon Sep 17 00:00:00 2001
From: Romain Vimont <rom@rom1v.com>
Date: Mon, 20 Nov 2023 20:56:36 +0100
Subject: [PATCH] Update documentation about video orientation

PR #4441 <https://github.com/Genymobile/scrcpy/pull/4441>
---
 doc/camera.md    | 10 ++++++++++
 doc/recording.md |  6 ++++++
 doc/video.md     | 45 ++++++++++++++++++++++++++++-----------------
 3 files changed, 44 insertions(+), 17 deletions(-)

diff --git a/doc/camera.md b/doc/camera.md
index d1008bda..fcc410fa 100644
--- a/doc/camera.md
+++ b/doc/camera.md
@@ -101,6 +101,16 @@ scrcpy --video-source=camera --camera-size=1920x1080 -m3000  # error
 ```
 
 
+## Rotation
+
+To rotate the captured video, use the [video orientation](video.md#orientation)
+option:
+
+```
+scrcpy --video-source=camera --camera-size=1920x1080 --orientation=90
+```
+
+
 ## Frame rate
 
 By default, camera is captured at Android's default frame rate (30 fps).
diff --git a/doc/recording.md b/doc/recording.md
index c1a8445e..216542e9 100644
--- a/doc/recording.md
+++ b/doc/recording.md
@@ -50,6 +50,12 @@ scrcpy --record=file --record-format=mkv
 ```
 
 
+## Rotation
+
+The video can be recorded rotated. See [video
+orientation](video.md#orientation).
+
+
 ## No playback
 
 To disable playback while recording:
diff --git a/doc/video.md b/doc/video.md
index 512e0aba..ed92cb22 100644
--- a/doc/video.md
+++ b/doc/video.md
@@ -97,39 +97,50 @@ scrcpy --video-codec=h264 --video-encoder='OMX.qcom.video.encoder.avc'
 ```
 
 
-## Rotation
+## Orientation
 
-The rotation may be applied at 3 different levels:
+The orientation may be applied at 3 different levels:
  - The [shortcut](shortcuts.md) <kbd>MOD</kbd>+<kbd>r</kbd> requests the
    device to switch between portrait and landscape (the current running app may
    refuse, if it does not support the requested orientation).
  - `--lock-video-orientation` changes the mirroring orientation (the orientation
    of the video sent from the device to the computer). This affects the
    recording.
- - `--rotation` rotates only the window content. This only affects the display,
-   not the recording. It may be changed dynamically at any time using the
-   [shortcuts](shortcuts.md) <kbd>MOD</kbd>+<kbd>←</kbd> and
-   <kbd>MOD</kbd>+<kbd>→</kbd>.
+ - `--orientation` is applied on the client side, and affects display and
+   recording. For the display, it can be changed dynamically using
+   [shortcuts](shortcuts.md).
 
-To lock the mirroring orientation:
+To lock the mirroring orientation (on the capture side):
 
 ```bash
-scrcpy --lock-video-orientation     # initial (current) orientation
-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
+scrcpy --lock-video-orientation      # initial (current) orientation
+scrcpy --lock-video-orientation=0    # natural orientation
+scrcpy --lock-video-orientation=90   # 90° clockwise
+scrcpy --lock-video-orientation=180  # 180°
+scrcpy --lock-video-orientation=270  # 270° clockwise
 ```
 
-To set an initial window rotation:
+To orient the video (on the rendering side):
 
 ```bash
-scrcpy --rotation=0   # no rotation
-scrcpy --rotation=1   # 90 degrees counterclockwise
-scrcpy --rotation=2   # 180 degrees
-scrcpy --rotation=3   # 90 degrees clockwise
+scrcpy --orientation=0
+scrcpy --orientation=90       # 90° clockwise
+scrcpy --orientation=180      # 180°
+scrcpy --orientation=270      # 270° clockwise
+scrcpy --orientation=flip0    # hflip
+scrcpy --orientation=flip90   # hflip + 90° clockwise
+scrcpy --orientation=flip180  # vflip (hflip + 180°)
+scrcpy --orientation=flip270  # hflip + 270° clockwise
 ```
 
+The orientation can be set separately for display and record if necessary, via
+`--display-orientation` and `--record-orientation`.
+
+The rotation is applied to a recorded file by writing a display transformation
+to the MP4 or MKV target file. Flipping is not supported, so only the 4 first
+values are allowed when recording.
+
+
 ## Crop
 
 The device screen may be cropped to mirror only part of the screen.