Add --screen-off-timeout

Change the Android "screen off timeout" (the idle delay before the
screen automatically turns off) and restore the initial value on
exit.

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

app/data/bash-completion/scrcpy

@@ -77,6 +77,7 @@ _scrcpy() {
         --rotation=
         -s --serial=
         -S --turn-screen-off
+        --screen-off-timeout=
         --shortcut-mod=
         --start-app=
         -t --show-touches

app/data/zsh-completion/_scrcpy

@@ -80,6 +80,7 @@ arguments=(
     '--require-audio=[Make scrcpy fail if audio is enabled but does not work]'
     {-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]'
+    '--screen-off-timeout=[Set the screen off timeout in seconds]'
     '--shortcut-mod=[\[key1,key2+key3,...\] Specify the modifiers to use for scrcpy shortcuts]:shortcut mod:(lctrl rctrl lalt ralt lsuper rsuper)'
     '--start-app=[Start an Android app]'
     {-t,--show-touches}'[Show physical touches]'

app/src/audio_regulator.c

@@ -288,7 +288,7 @@ sc_audio_regulator_push(struct sc_audio_regulator *ar, const AVFrame *frame) {
 
         // Enable compensation when the difference exceeds +/- 4ms.
         // Disable compensation when the difference is lower than +/- 1ms.
-        int threshold = ar->compensation != 0
+        int threshold = ar->compensation_active
                       ? ar->sample_rate     / 1000  /* 1ms */
                       : ar->sample_rate * 4 / 1000; /* 4ms */
 
@@ -309,14 +309,12 @@ sc_audio_regulator_push(struct sc_audio_regulator *ar, const AVFrame *frame) {
         LOGV("[Audio] Buffering: target=%" PRIu32 " avg=%f cur=%" PRIu32
              " compensation=%d", ar->target_buffering, avg, can_read, diff);
 
-        if (diff != ar->compensation) {
-            int ret = swr_set_compensation(swr_ctx, diff, distance);
-            if (ret < 0) {
-                LOGW("Resampling compensation failed: %d", ret);
-                // not fatal
-            } else {
-                ar->compensation = diff;
-            }
+        int ret = swr_set_compensation(swr_ctx, diff, distance);
+        if (ret < 0) {
+            LOGW("Resampling compensation failed: %d", ret);
+            // not fatal
+        } else {
+            ar->compensation_active = diff != 0;
         }
     }
 
@@ -392,7 +390,7 @@ sc_audio_regulator_init(struct sc_audio_regulator *ar, size_t sample_size,
     atomic_init(&ar->played, false);
     atomic_init(&ar->received, false);
     atomic_init(&ar->underflow, 0);
-    ar->compensation = 0;
+    ar->compensation_active = false;
 
     return true;
 

app/src/audio_regulator.h

@@ -44,8 +44,8 @@ struct sc_audio_regulator {
     // Number of silence samples inserted since the last received packet
     atomic_uint_least32_t underflow;
 
-    // Current applied compensation value (only used by the receiver thread)
-    int compensation;
+    // Non-zero compensation applied (only used by the receiver thread)
+    bool compensation_active;
 
     // Set to true the first time a sample is received
     atomic_bool received;

app/src/cli.c

@@ -106,6 +106,7 @@ enum {
     OPT_NEW_DISPLAY,
     OPT_LIST_APPS,
     OPT_START_APP,
+    OPT_SCREEN_OFF_TIMEOUT,
 };
 
 struct sc_option {
@@ -793,6 +794,13 @@ static const struct sc_option options[] = {
         .longopt = "turn-screen-off",
         .text = "Turn the device screen off immediately.",
     },
+    {
+        .longopt_id = OPT_SCREEN_OFF_TIMEOUT,
+        .longopt = "screen-off-timeout",
+        .argdesc = "seconds",
+        .text = "Set the screen off timeout while scrcpy is running (restore "
+                "the initial value on exit).",
+    },
     {
         .longopt_id = OPT_SHORTCUT_MOD,
         .longopt = "shortcut-mod",
@@ -2155,6 +2163,20 @@ parse_time_limit(const char *s, sc_tick *tick) {
     return true;
 }
 
+static bool
+parse_screen_off_timeout(const char *s, sc_tick *tick) {
+    long value;
+    // value in seconds, but must fit in 31 bits in milliseconds
+    bool ok = parse_integer_arg(s, &value, false, 0, 0x7FFFFFFF / 1000,
+                                "screen off timeout");
+    if (!ok) {
+        return false;
+    }
+
+    *tick = SC_TICK_FROM_SEC(value);
+    return true;
+}
+
 static bool
 parse_pause_on_exit(const char *s, enum sc_pause_on_exit *pause_on_exit) {
     if (!s || !strcmp(s, "true")) {
@@ -2730,6 +2752,12 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
             case OPT_START_APP:
                 opts->start_app = optarg;
                 break;
+            case OPT_SCREEN_OFF_TIMEOUT:
+                if (!parse_screen_off_timeout(optarg,
+                                              &opts->screen_off_timeout)) {
+                    return false;
+                }
+                break;
             default:
                 // getopt prints the error message on stderr
                 return false;

app/src/options.c

@@ -62,6 +62,7 @@ const struct scrcpy_options scrcpy_options_default = {
     .audio_buffer = -1, // depends on the audio format,
     .audio_output_buffer = SC_TICK_FROM_MS(5),
     .time_limit = 0,
+    .screen_off_timeout = -1,
 #ifdef HAVE_V4L2
     .v4l2_device = NULL,
     .v4l2_buffer = 0,

app/src/options.h

@@ -265,6 +265,7 @@ struct scrcpy_options {
     sc_tick audio_buffer;
     sc_tick audio_output_buffer;
     sc_tick time_limit;
+    sc_tick screen_off_timeout;
 #ifdef HAVE_V4L2
     const char *v4l2_device;
     sc_tick v4l2_buffer;

app/src/scrcpy.c

@@ -428,6 +428,7 @@ scrcpy(struct scrcpy_options *options) {
         .video_bit_rate = options->video_bit_rate,
         .audio_bit_rate = options->audio_bit_rate,
         .max_fps = options->max_fps,
+        .screen_off_timeout = options->screen_off_timeout,
         .lock_video_orientation = options->lock_video_orientation,
         .control = options->control,
         .display_id = options->display_id,

app/src/server.c

@@ -320,6 +320,11 @@ execute_server(struct sc_server *server,
     if (params->stay_awake) {
         ADD_PARAM("stay_awake=true");
     }
+    if (params->screen_off_timeout != -1) {
+        assert(params->screen_off_timeout >= 0);
+        uint64_t ms = SC_TICK_TO_MS(params->screen_off_timeout);
+        ADD_PARAM("screen_off_timeout=%" PRIu64, ms);
+    }
     if (params->video_codec_options) {
         VALIDATE_STRING(params->video_codec_options);
         ADD_PARAM("video_codec_options=%s", params->video_codec_options);

app/src/server.h

@@ -45,6 +45,7 @@ struct sc_server_params {
     uint32_t video_bit_rate;
     uint32_t audio_bit_rate;
     const char *max_fps; // float to be parsed by the server
+    sc_tick screen_off_timeout;
     int8_t lock_video_orientation;
     bool control;
     uint32_t display_id;

doc/device.md

@@ -71,6 +71,31 @@ adb shell cmd display power-on 0
 ```
 
 
+## Screen off timeout
+
+The Android screen automatically turns off after some delay.
+
+To change this delay while scrcpy is running:
+
+```bash
+scrcpy --screen-off-timeout=300  # 300 seconds (5 minutes)
+```
+
+The initial value is restored on exit.
+
+It is possible to change this setting manually:
+
+```bash
+# get the current screen_off_timeout value
+adb shell settings get system screen_off_timeout
+# set a new value (in milliseconds)
+adb shell settings put system screen_off_timeout 30000
+```
+
+Note that the Android value is in milliseconds, but the scrcpy command line
+argument is in seconds.
+
+
 ## Show touches
 
 For presentations, it may be useful to show physical touches (on the physical

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

@@ -5,6 +5,8 @@ import com.genymobile.scrcpy.util.Ln;
 import com.genymobile.scrcpy.util.Settings;
 import com.genymobile.scrcpy.util.SettingsException;
 
+import android.os.BatteryManager;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.OutputStream;
@@ -16,59 +18,131 @@ import java.io.OutputStream;
  */
 public final class CleanUp {
 
-    private static final int MSG_TYPE_MASK = 0b11;
-    private static final int MSG_TYPE_RESTORE_STAY_ON = 0;
-    private static final int MSG_TYPE_DISABLE_SHOW_TOUCHES = 1;
-    private static final int MSG_TYPE_RESTORE_DISPLAY_POWER = 2;
-    private static final int MSG_TYPE_POWER_OFF_SCREEN = 3;
+    // Dynamic options
+    private static final int PENDING_CHANGE_DISPLAY_POWER = 1 << 0;
+    private int pendingChanges;
+    private boolean pendingRestoreDisplayPower;
 
-    private static final int MSG_PARAM_SHIFT = 2;
+    private Thread thread;
 
-    private final OutputStream out;
-
-    public CleanUp(OutputStream out) {
-        this.out = out;
+    private CleanUp(int displayId, Options options) {
+        thread = new Thread(() -> runCleanUp(displayId, options), "cleanup");
+        thread.start();
     }
 
-    public static CleanUp configure(int displayId) throws IOException {
-        String[] cmd = {"app_process", "/", CleanUp.class.getName(), String.valueOf(displayId)};
+    public static CleanUp start(int displayId, Options options) {
+        return new CleanUp(displayId, options);
+    }
+
+    public void interrupt() {
+        thread.interrupt();
+    }
+
+    public void join() throws InterruptedException {
+        thread.join();
+    }
+
+    private void runCleanUp(int displayId, Options options) {
+        boolean disableShowTouches = false;
+        if (options.getShowTouches()) {
+            try {
+                String oldValue = Settings.getAndPutValue(Settings.TABLE_SYSTEM, "show_touches", "1");
+                // If "show touches" was disabled, it must be disabled back on clean up
+                disableShowTouches = !"1".equals(oldValue);
+            } catch (SettingsException e) {
+                Ln.e("Could not change \"show_touches\"", e);
+            }
+        }
+
+        int restoreStayOn = -1;
+        if (options.getStayAwake()) {
+            int stayOn = BatteryManager.BATTERY_PLUGGED_AC | BatteryManager.BATTERY_PLUGGED_USB | BatteryManager.BATTERY_PLUGGED_WIRELESS;
+            try {
+                String oldValue = Settings.getAndPutValue(Settings.TABLE_GLOBAL, "stay_on_while_plugged_in", String.valueOf(stayOn));
+                try {
+                    int currentStayOn = Integer.parseInt(oldValue);
+                    // Restore only if the current value is different
+                    if (currentStayOn != stayOn) {
+                        restoreStayOn = currentStayOn;
+                    }
+                } catch (NumberFormatException e) {
+                    // ignore
+                }
+            } catch (SettingsException e) {
+                Ln.e("Could not change \"stay_on_while_plugged_in\"", e);
+            }
+        }
+
+        int restoreScreenOffTimeout = -1;
+        int screenOffTimeout = options.getScreenOffTimeout();
+        if (screenOffTimeout != -1) {
+            try {
+                String oldValue = Settings.getAndPutValue(Settings.TABLE_SYSTEM, "screen_off_timeout", String.valueOf(screenOffTimeout));
+                try {
+                    int currentScreenOffTimeout = Integer.parseInt(oldValue);
+                    // Restore only if the current value is different
+                    if (currentScreenOffTimeout != screenOffTimeout) {
+                        restoreScreenOffTimeout = currentScreenOffTimeout;
+                    }
+                } catch (NumberFormatException e) {
+                    // ignore
+                }
+            } catch (SettingsException e) {
+                Ln.e("Could not change \"screen_off_timeout\"", e);
+            }
+        }
+
+        boolean powerOffScreen = options.getPowerOffScreenOnClose();
+
+        try {
+            run(displayId, restoreStayOn, disableShowTouches, powerOffScreen, restoreScreenOffTimeout);
+        } catch (InterruptedException e) {
+            // ignore
+        } catch (IOException e) {
+            Ln.e("Clean up I/O exception", e);
+        }
+    }
+
+    private void run(int displayId, int restoreStayOn, boolean disableShowTouches, boolean powerOffScreen, int restoreScreenOffTimeout)
+            throws IOException, InterruptedException {
+        String[] cmd = {
+                "app_process",
+                "/",
+                CleanUp.class.getName(),
+                String.valueOf(displayId),
+                String.valueOf(restoreStayOn),
+                String.valueOf(disableShowTouches),
+                String.valueOf(powerOffScreen),
+                String.valueOf(restoreScreenOffTimeout),
+        };
 
         ProcessBuilder builder = new ProcessBuilder(cmd);
         builder.environment().put("CLASSPATH", Server.SERVER_PATH);
         Process process = builder.start();
-        return new CleanUp(process.getOutputStream());
-    }
+        OutputStream out = process.getOutputStream();
 
-    private boolean sendMessage(int type, int param) {
-        assert (type & ~MSG_TYPE_MASK) == 0;
-        int msg = type | param << MSG_PARAM_SHIFT;
-        try {
-            out.write(msg);
-            out.flush();
-            return true;
-        } catch (IOException e) {
-            Ln.w("Could not configure cleanup (type=" + type + ", param=" + param + ")", e);
-            return false;
+        while (true) {
+            int localPendingChanges;
+            boolean localPendingRestoreDisplayPower;
+            synchronized (this) {
+                while (pendingChanges == 0) {
+                    wait();
+                }
+                localPendingChanges = pendingChanges;
+                localPendingRestoreDisplayPower = pendingRestoreDisplayPower;
+                pendingChanges = 0;
+            }
+            if ((localPendingChanges & PENDING_CHANGE_DISPLAY_POWER) != 0) {
+                out.write(localPendingRestoreDisplayPower ? 1 : 0);
+                out.flush();
+            }
         }
     }
 
-    public boolean setRestoreStayOn(int restoreValue) {
-        // Restore the value (between 0 and 7), -1 to not restore
-        // <https://developer.android.com/reference/android/provider/Settings.Global#STAY_ON_WHILE_PLUGGED_IN>
-        assert restoreValue >= -1 && restoreValue <= 7;
-        return sendMessage(MSG_TYPE_RESTORE_STAY_ON, restoreValue & 0b1111);
-    }
-
-    public boolean setDisableShowTouches(boolean disableOnExit) {
-        return sendMessage(MSG_TYPE_DISABLE_SHOW_TOUCHES, disableOnExit ? 1 : 0);
-    }
-
-    public boolean setRestoreDisplayPower(boolean restoreOnExit) {
-        return sendMessage(MSG_TYPE_RESTORE_DISPLAY_POWER, restoreOnExit ? 1 : 0);
-    }
-
-    public boolean setPowerOffScreen(boolean powerOffScreenOnExit) {
-        return sendMessage(MSG_TYPE_POWER_OFF_SCREEN, powerOffScreenOnExit ? 1 : 0);
+    public synchronized void setRestoreDisplayPower(boolean restoreDisplayPower) {
+        pendingRestoreDisplayPower = restoreDisplayPower;
+        pendingChanges |= PENDING_CHANGE_DISPLAY_POWER;
+        notify();
     }
 
     public static void unlinkSelf() {
@@ -83,35 +157,21 @@ public final class CleanUp {
         unlinkSelf();
 
         int displayId = Integer.parseInt(args[0]);
+        int restoreStayOn = Integer.parseInt(args[1]);
+        boolean disableShowTouches = Boolean.parseBoolean(args[2]);
+        boolean powerOffScreen = Boolean.parseBoolean(args[3]);
+        int restoreScreenOffTimeout = Integer.parseInt(args[4]);
 
-        int restoreStayOn = -1;
-        boolean disableShowTouches = false;
+        // Dynamic option
         boolean restoreDisplayPower = false;
-        boolean powerOffScreen = false;
 
         try {
             // Wait for the server to die
             int msg;
             while ((msg = System.in.read()) != -1) {
-                int type = msg & MSG_TYPE_MASK;
-                int param = msg >> MSG_PARAM_SHIFT;
-                switch (type) {
-                    case MSG_TYPE_RESTORE_STAY_ON:
-                        restoreStayOn = param > 7 ? -1 : param;
-                        break;
-                    case MSG_TYPE_DISABLE_SHOW_TOUCHES:
-                        disableShowTouches = param != 0;
-                        break;
-                    case MSG_TYPE_RESTORE_DISPLAY_POWER:
-                        restoreDisplayPower = param != 0;
-                        break;
-                    case MSG_TYPE_POWER_OFF_SCREEN:
-                        powerOffScreen = param != 0;
-                        break;
-                    default:
-                        Ln.w("Unexpected msg type: " + type);
-                        break;
-                }
+                // Only restore display power
+                assert msg == 0 || msg == 1;
+                restoreDisplayPower = msg != 0;
             }
         } catch (IOException e) {
             // Expected when the server is dead
@@ -137,6 +197,15 @@ public final class CleanUp {
             }
         }
 
+        if (restoreScreenOffTimeout != -1) {
+            Ln.i("Restoring \"screen off timeout\"");
+            try {
+                Settings.putValue(Settings.TABLE_SYSTEM, "screen_off_timeout", String.valueOf(restoreScreenOffTimeout));
+            } catch (SettingsException e) {
+                Ln.e("Could not restore \"screen_off_timeout\"", e);
+            }
+        }
+
         if (displayId != Device.DISPLAY_ID_NONE && Device.isScreenOn(displayId)) {
             if (powerOffScreen) {
                 Ln.i("Power off screen");

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

@@ -45,6 +45,7 @@ public class Options {
     private boolean cameraHighSpeed;
     private boolean showTouches;
     private boolean stayAwake;
+    private int screenOffTimeout = -1;
     private List<CodecOption> videoCodecOptions;
     private List<CodecOption> audioCodecOptions;
 
@@ -174,6 +175,10 @@ public class Options {
         return stayAwake;
     }
 
+    public int getScreenOffTimeout() {
+        return screenOffTimeout;
+    }
+
     public List<CodecOption> getVideoCodecOptions() {
         return videoCodecOptions;
     }
@@ -363,6 +368,12 @@ public class Options {
                 case "stay_awake":
                     options.stayAwake = Boolean.parseBoolean(value);
                     break;
+                case "screen_off_timeout":
+                    options.screenOffTimeout = Integer.parseInt(value);
+                    if (options.screenOffTimeout < -1) {
+                        throw new IllegalArgumentException("Invalid screen off timeout: " + options.screenOffTimeout);
+                    }
+                    break;
                 case "video_codec_options":
                     options.videoCodecOptions = CodecOption.parse(value);
                     break;

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

@@ -16,8 +16,6 @@ import com.genymobile.scrcpy.device.NewDisplay;
 import com.genymobile.scrcpy.device.Streamer;
 import com.genymobile.scrcpy.util.Ln;
 import com.genymobile.scrcpy.util.LogUtils;
-import com.genymobile.scrcpy.util.Settings;
-import com.genymobile.scrcpy.util.SettingsException;
 import com.genymobile.scrcpy.video.CameraCapture;
 import com.genymobile.scrcpy.video.NewDisplayCapture;
 import com.genymobile.scrcpy.video.ScreenCapture;
@@ -25,7 +23,6 @@ import com.genymobile.scrcpy.video.SurfaceCapture;
 import com.genymobile.scrcpy.video.SurfaceEncoder;
 import com.genymobile.scrcpy.video.VideoSource;
 
-import android.os.BatteryManager;
 import android.os.Build;
 
 import java.io.File;
@@ -76,51 +73,6 @@ public final class Server {
         // not instantiable
     }
 
-    private static void initAndCleanUp(Options options, CleanUp cleanUp) {
-        // This method is called from its own thread, so it may only configure cleanup actions which are NOT dynamic (i.e. they are configured once
-        // and for all, they cannot be changed from another thread)
-
-        if (options.getShowTouches()) {
-            try {
-                String oldValue = Settings.getAndPutValue(Settings.TABLE_SYSTEM, "show_touches", "1");
-                // If "show touches" was disabled, it must be disabled back on clean up
-                if (!"1".equals(oldValue)) {
-                    if (!cleanUp.setDisableShowTouches(true)) {
-                        Ln.e("Could not disable show touch on exit");
-                    }
-                }
-            } catch (SettingsException e) {
-                Ln.e("Could not change \"show_touches\"", e);
-            }
-        }
-
-        if (options.getStayAwake()) {
-            int stayOn = BatteryManager.BATTERY_PLUGGED_AC | BatteryManager.BATTERY_PLUGGED_USB | BatteryManager.BATTERY_PLUGGED_WIRELESS;
-            try {
-                String oldValue = Settings.getAndPutValue(Settings.TABLE_GLOBAL, "stay_on_while_plugged_in", String.valueOf(stayOn));
-                try {
-                    int restoreStayOn = Integer.parseInt(oldValue);
-                    if (restoreStayOn != stayOn) {
-                        // Restore only if the current value is different
-                        if (!cleanUp.setRestoreStayOn(restoreStayOn)) {
-                            Ln.e("Could not restore stay on on exit");
-                        }
-                    }
-                } catch (NumberFormatException e) {
-                    // ignore
-                }
-            } catch (SettingsException e) {
-                Ln.e("Could not change \"stay_on_while_plugged_in\"", e);
-            }
-        }
-
-        if (options.getPowerOffScreenOnClose()) {
-            if (!cleanUp.setPowerOffScreen(true)) {
-                Ln.e("Could not power off screen on exit");
-            }
-        }
-    }
-
     private static void scrcpy(Options options) throws IOException, ConfigurationException {
         if (Build.VERSION.SDK_INT < AndroidVersions.API_31_ANDROID_12 && options.getVideoSource() == VideoSource.CAMERA) {
             Ln.e("Camera mirroring is not supported before Android 12");
@@ -150,14 +102,12 @@ public final class Server {
         }
 
         CleanUp cleanUp = null;
-        Thread initThread = null;
 
         NewDisplay newDisplay = options.getNewDisplay();
         int displayId = newDisplay == null ? options.getDisplayId() : Device.DISPLAY_ID_NONE;
 
         if (options.getCleanup()) {
-            cleanUp = CleanUp.configure(displayId);
-            initThread = startInitThread(options, cleanUp);
+            cleanUp = CleanUp.start(displayId, options);
         }
 
         int scid = options.getScid();
@@ -240,8 +190,8 @@ public final class Server {
 
             completion.await();
         } finally {
-            if (initThread != null) {
-                initThread.interrupt();
+            if (cleanUp != null) {
+                cleanUp.interrupt();
             }
             for (AsyncProcessor asyncProcessor : asyncProcessors) {
                 asyncProcessor.stop();
@@ -250,8 +200,8 @@ public final class Server {
             connection.shutdown();
 
             try {
-                if (initThread != null) {
-                    initThread.join();
+                if (cleanUp != null) {
+                    cleanUp.join();
                 }
                 for (AsyncProcessor asyncProcessor : asyncProcessors) {
                     asyncProcessor.join();
@@ -264,12 +214,6 @@ public final class Server {
         }
     }
 
-    private static Thread startInitThread(final Options options, final CleanUp cleanUp) {
-        Thread thread = new Thread(() -> initAndCleanUp(options, cleanUp), "init-cleanup");
-        thread.start();
-        return thread;
-    }
-
     public static void main(String... args) {
         int status = 0;
         try {