Add camera documentation

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

app/scrcpy.1

@@ -45,15 +45,15 @@ Set a list of comma-separated key:type=value options for the device audio encode
 
 The possible values for 'type' are 'int' (default), 'long', 'float' and 'string'.
 
-The list of possible codec options is available in the Android documentation:
-
-<https://d.android.com/reference/android/media/MediaFormat>
+The list of possible codec options is available in the Android documentation
+.UR https://d.android.com/reference/android/media/MediaFormat
+.UE .
 
 .TP
 .BI "\-\-audio\-encoder " name
 Use a specific MediaCodec audio encoder (depending on the codec provided by \fB\-\-audio\-codec\fR).
 
-The available encoders can be listed by \fB\-\-list\-encoders\fR.
+The available encoders can be listed by \-\-list\-encoders.
 
 .TP
 .BI "\-\-audio\-source " source
@@ -79,19 +79,19 @@ Default is 8M (8000000).
 .BI "\-\-camera\-ar " ar
 Select the camera size by its aspect ratio (+/- 10%).
 
-Possible values are "sensor" (use the camera sensor aspect ratio), "\fInum\fR:\fIden\fR" (e.g. "4:3") and "\fIvalue\fR" (e.g. "1.6").
+Possible values are "sensor" (use the camera sensor aspect ratio), "<num>:<den>" (e.g. "4:3") and "<value>" (e.g. "1.6").
 
 .TP
 .B \-\-camera\-high\-speed
 Enable high-speed camera capture mode.
 
-This mode is restricted to specific resolutions and frame rates, listed by \fB\-\-list\-camera\-sizes\fR.
+This mode is restricted to specific resolutions and frame rates, listed by --list-camera-sizes.
 
 .TP
 .BI "\-\-camera\-id " id
 Specify the device camera id to mirror.
 
-The available camera ids can be listed by \fB\-\-list\-cameras\fR.
+The available camera ids can be listed by \-\-list\-cameras.
 
 .TP
 .BI "\-\-camera\-facing " facing
@@ -131,7 +131,7 @@ Disable screensaver while scrcpy is running.
 .BI "\-\-display\-id " id
 Specify the device display id to mirror.
 
-The available display ids can be listed by \fB\-\-list\-displays\fR.
+The available display ids can be listed by \-\-list\-displays.
 
 Default is 0.
 
@@ -189,11 +189,9 @@ Inject computer clipboard text as a sequence of key events on Ctrl+v (like MOD+S
 
 This is a workaround for some devices not behaving as expected when setting the device clipboard programmatically.
 
-.TP
 .B \-\-list\-camera\-sizes
 List the valid camera capture sizes.
 
-.TP
 .B \-\-list\-cameras
 List cameras available on the device.
 
@@ -241,7 +239,7 @@ Disable device control (mirror the device in read\-only).
 
 .TP
 .B \-N, \-\-no\-playback
-Disable video and audio playback on the computer (equivalent to \fB\-\-no\-video\-playback \-\-no\-audio\-playback\fR).
+Disable video and audio playback on the computer (equivalent to --no-video-playback --no-audio-playback).
 
 .TP
 .B \-\-no\-audio
@@ -363,7 +361,8 @@ Request SDL to use the given render driver (this is just a hint).
 
 Supported names are currently "direct3d", "opengl", "opengles2", "opengles", "metal" and "software".
 
-<https://wiki.libsdl.org/SDL_HINT_RENDER_DRIVER>
+.UR https://wiki.libsdl.org/SDL_HINT_RENDER_DRIVER
+.UE
 
 .TP
 .B \-\-require\-audio
@@ -411,13 +410,13 @@ Set the maximum mirroring time, in seconds.
 
 .TP
 .BI "\-\-tunnel\-host " ip
-Set the IP address of the adb tunnel to reach the scrcpy server. This option automatically enables \fB\-\-force\-adb\-forward\fR.
+Set the IP address of the adb tunnel to reach the scrcpy server. This option automatically enables --force-adb-forward.
 
 Default is localhost.
 
 .TP
 .BI "\-\-tunnel\-port " port
-Set the TCP port of the adb tunnel to reach the scrcpy server. This option automatically enables \fB\-\-force\-adb\-forward\fR.
+Set the TCP port of the adb tunnel to reach the scrcpy server. This option automatically enables --force-adb-forward.
 
 Default is 0 (not forced): the local port used for establishing the tunnel will be used.
 
@@ -457,15 +456,15 @@ Set a list of comma-separated key:type=value options for the device video encode
 
 The possible values for 'type' are 'int' (default), 'long', 'float' and 'string'.
 
-The list of possible codec options is available in the Android documentation:
-
-<https://d.android.com/reference/android/media/MediaFormat>
+The list of possible codec options is available in the Android documentation
+.UR https://d.android.com/reference/android/media/MediaFormat
+.UE .
 
 .TP
 .BI "\-\-video\-encoder " name
 Use a specific MediaCodec video encoder (depending on the codec provided by \fB\-\-video\-codec\fR).
 
-The available encoders can be listed by \fB\-\-list\-encoders\fR.
+The available encoders can be listed by \-\-list\-encoders.
 
 .TP
 .BI "\-\-video\-source " source
@@ -635,7 +634,7 @@ Path to adb.
 
 .TP
 .B ANDROID_SERIAL
-Device serial to use if no selector (\fB-s\fR, \fB-d\fR, \fB-e\fR or \fB\-\-tcpip=\fIaddr\fR) is specified.
+Device serial to use if no selector (-s, -d, -e or --tcpip=<addr>) is specified.
 
 .TP
 .B SCRCPY_ICON_PATH
@@ -658,14 +657,23 @@ for the Debian Project (and may be used by others).
 
 
 .SH "REPORTING BUGS"
-Report bugs to <https://github.com/Genymobile/scrcpy/issues>.
+Report bugs to
+.UR https://github.com/Genymobile/scrcpy/issues
+.UE .
 
 .SH COPYRIGHT
-Copyright \(co 2018 Genymobile <https://www.genymobile.com>
+Copyright \(co 2018 Genymobile
+.UR https://www.genymobile.com
+Genymobile
+.UE
 
-Copyright \(co 2018\-2023 Romain Vimont <rom@rom1v.com>
+Copyright \(co 2018\-2023
+.MT rom@rom1v.com
+Romain Vimont
+.ME
 
 Licensed under the Apache License, Version 2.0.
 
 .SH WWW
-<https://github.com/Genymobile/scrcpy>
+.UR https://github.com/Genymobile/scrcpy
+.UE

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

@@ -132,29 +132,20 @@ public final class DesktopConnection implements Closeable {
         return controlSocket;
     }
 
-    public void shutdown() throws IOException {
+    public void close() throws IOException {
         if (videoSocket != null) {
             videoSocket.shutdownInput();
             videoSocket.shutdownOutput();
+            videoSocket.close();
         }
         if (audioSocket != null) {
             audioSocket.shutdownInput();
             audioSocket.shutdownOutput();
+            audioSocket.close();
         }
         if (controlSocket != null) {
             controlSocket.shutdownInput();
             controlSocket.shutdownOutput();
-        }
-    }
-
-    public void close() throws IOException {
-        if (videoSocket != null) {
-            videoSocket.close();
-        }
-        if (audioSocket != null) {
-            audioSocket.close();
-        }
-        if (controlSocket != null) {
             controlSocket.close();
         }
     }

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

@@ -2,11 +2,6 @@ package com.genymobile.scrcpy;
 
 import android.util.Log;
 
-import java.io.FileDescriptor;
-import java.io.FileOutputStream;
-import java.io.OutputStream;
-import java.io.PrintStream;
-
 /**
  * Log both to Android logger (so that logs are visible in "adb logcat") and standard output/error (so that they are visible in the terminal
  * directly).
@@ -16,9 +11,6 @@ public final class Ln {
     private static final String TAG = "scrcpy";
     private static final String PREFIX = "[server] ";
 
-    private static final PrintStream consoleOut = new PrintStream(new FileOutputStream(FileDescriptor.out));
-    private static final PrintStream consoleErr = new PrintStream(new FileOutputStream(FileDescriptor.err));
-
     enum Level {
         VERBOSE, DEBUG, INFO, WARN, ERROR
     }
@@ -29,12 +21,6 @@ public final class Ln {
         // not instantiable
     }
 
-    public static void disableSystemStreams() {
-        PrintStream nullStream = new PrintStream(new NullOutputStream());
-        System.setOut(nullStream);
-        System.setErr(nullStream);
-    }
-
     /**
      * Initialize the log level.
      * <p>
@@ -53,30 +39,30 @@ public final class Ln {
     public static void v(String message) {
         if (isEnabled(Level.VERBOSE)) {
             Log.v(TAG, message);
-            consoleOut.print(PREFIX + "VERBOSE: " + message + '\n');
+            System.out.print(PREFIX + "VERBOSE: " + message + '\n');
         }
     }
 
     public static void d(String message) {
         if (isEnabled(Level.DEBUG)) {
             Log.d(TAG, message);
-            consoleOut.print(PREFIX + "DEBUG: " + message + '\n');
+            System.out.print(PREFIX + "DEBUG: " + message + '\n');
         }
     }
 
     public static void i(String message) {
         if (isEnabled(Level.INFO)) {
             Log.i(TAG, message);
-            consoleOut.print(PREFIX + "INFO: " + message + '\n');
+            System.out.print(PREFIX + "INFO: " + message + '\n');
         }
     }
 
     public static void w(String message, Throwable throwable) {
         if (isEnabled(Level.WARN)) {
             Log.w(TAG, message, throwable);
-            consoleErr.print(PREFIX + "WARN: " + message + '\n');
+            System.err.print(PREFIX + "WARN: " + message + '\n');
             if (throwable != null) {
-                throwable.printStackTrace(consoleErr);
+                throwable.printStackTrace();
             }
         }
     }
@@ -88,9 +74,9 @@ public final class Ln {
     public static void e(String message, Throwable throwable) {
         if (isEnabled(Level.ERROR)) {
             Log.e(TAG, message, throwable);
-            consoleErr.print(PREFIX + "ERROR: " + message + '\n');
+            System.err.print(PREFIX + "ERROR: " + message + "\n");
             if (throwable != null) {
-                throwable.printStackTrace(consoleErr);
+                throwable.printStackTrace();
             }
         }
     }
@@ -98,21 +84,4 @@ public final class Ln {
     public static void e(String message) {
         e(message, null);
     }
-
-    static class NullOutputStream extends OutputStream {
-        @Override
-        public void write(byte[] b) {
-            // ignore
-        }
-
-        @Override
-        public void write(byte[] b, int off, int len) {
-            // ignore
-        }
-
-        @Override
-        public void write(int b) {
-            // ignore
-        }
-    }
 }

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

@@ -87,6 +87,8 @@ public final class Server {
     }
 
     private static void scrcpy(Options options) throws IOException, ConfigurationException {
+        Ln.i("Device: [" + Build.MANUFACTURER + "] " + Build.BRAND + " " + Build.MODEL + " (Android " + Build.VERSION.RELEASE + ")");
+
         if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S && options.getVideoSource() == VideoSource.CAMERA) {
             Ln.e("Camera mirroring is not supported before Android 12");
             throw new ConfigurationException("Camera mirroring is not supported");
@@ -163,8 +165,6 @@ public final class Server {
                 asyncProcessor.stop();
             }
 
-            connection.shutdown();
-
             try {
                 initThread.join();
                 for (AsyncProcessor asyncProcessor : asyncProcessors) {
@@ -189,7 +189,7 @@ public final class Server {
         try {
             internalMain(args);
         } catch (Throwable t) {
-            Ln.e(t.getMessage(), t);
+            t.printStackTrace();
             status = 1;
         } finally {
             // By default, the Java process exits when all non-daemon threads are terminated.
@@ -206,11 +206,8 @@ public final class Server {
 
         Options options = Options.parse(args);
 
-        Ln.disableSystemStreams();
         Ln.initLogLevel(options.getLogLevel());
 
-        Ln.i("Device: [" + Build.MANUFACTURER + "] " + Build.BRAND + " " + Build.MODEL + " (Android " + Build.VERSION.RELEASE + ")");
-
         if (options.getList()) {
             if (options.getCleanup()) {
                 CleanUp.unlinkSelf();