Use explicit file protocol for AVIO

AVIO expects a `url` to locate a resource.

Use the file protocol to handle filenames containing colons.

Fixes #5487 <https://github.com/Genymobile/scrcpy/issues/5487>
PR #5499 <https://github.com/Genymobile/scrcpy/pull/5499>
Signed-off-by: Romain Vimont <rom@rom1v.com>

app/src/recorder.c

@@ -143,8 +143,14 @@ sc_recorder_open_output_file(struct sc_recorder *recorder) {
         return false;
     }
 
-    int ret = avio_open(&recorder->ctx->pb, recorder->filename,
-                        AVIO_FLAG_WRITE);
+    char *file_url = sc_str_concat("file:", recorder->filename);
+    if (!file_url) {
+        avformat_free_context(recorder->ctx);
+        return false;
+    }
+
+    int ret = avio_open(&recorder->ctx->pb, file_url, AVIO_FLAG_WRITE);
+    free(file_url);
     if (ret < 0) {
         LOGE("Failed to open output file: %s", recorder->filename);
         avformat_free_context(recorder->ctx);

app/src/util/str.c

@@ -64,6 +64,26 @@ sc_str_quote(const char *src) {
     return quoted;
 }
 
+char *
+sc_str_concat(const char *start, const char *end) {
+    assert(start);
+    assert(end);
+
+    size_t start_len = strlen(start);
+    size_t end_len = strlen(end);
+
+    char *result = malloc(start_len + end_len + 1);
+    if (!result) {
+        LOG_OOM();
+        return NULL;
+    }
+
+    memcpy(result, start, start_len);
+    memcpy(result + start_len, end, end_len + 1);
+
+    return result;
+}
+
 bool
 sc_str_parse_integer(const char *s, long *out) {
     char *endptr;

app/src/util/str.h

@@ -38,6 +38,15 @@ sc_str_join(char *dst, const char *const tokens[], char sep, size_t n);
 char *
 sc_str_quote(const char *src);
 
+/**
+ * Concat two strings
+ *
+ * Return a new allocated string, contanining the concatenation of the two
+ * input strings.
+ */
+char *
+sc_str_concat(const char *start, const char *end);
+
 /**
  * Parse `s` as an integer into `out`
  *

app/tests/test_str.c

@@ -141,6 +141,16 @@ static void test_quote(void) {
     free(out);
 }
 
+static void test_concat(void) {
+    const char *s = "2024:11";
+    char *out = sc_str_concat("my-prefix:", s);
+
+    // contains the concat
+    assert(!strcmp("my-prefix:2024:11", out));
+
+    free(out);
+}
+
 static void test_utf8_truncate(void) {
     const char *s = "aÉbÔc";
     assert(strlen(s) == 7); // É and Ô are 2 bytes-wide
@@ -389,6 +399,7 @@ int main(int argc, char *argv[]) {
     test_join_truncated_before_sep();
     test_join_truncated_after_sep();
     test_quote();
+    test_concat();
     test_utf8_truncate();
     test_parse_integer();
     test_parse_integers();

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

@@ -25,13 +25,13 @@ public final class CleanUp {
 
     private Thread thread;
 
-    private CleanUp(int displayId, Options options) {
-        thread = new Thread(() -> runCleanUp(displayId, options), "cleanup");
+    private CleanUp(Options options) {
+        thread = new Thread(() -> runCleanUp(options), "cleanup");
         thread.start();
     }
 
-    public static CleanUp start(int displayId, Options options) {
-        return new CleanUp(displayId, options);
+    public static CleanUp start(Options options) {
+        return new CleanUp(options);
     }
 
     public void interrupt() {
@@ -42,7 +42,7 @@ public final class CleanUp {
         thread.join();
     }
 
-    private void runCleanUp(int displayId, Options options) {
+    private void runCleanUp(Options options) {
         boolean disableShowTouches = false;
         if (options.getShowTouches()) {
             try {
@@ -93,6 +93,7 @@ public final class CleanUp {
         }
 
         boolean powerOffScreen = options.getPowerOffScreenOnClose();
+        int displayId = options.getDisplayId();
 
         try {
             run(displayId, restoreStayOn, disableShowTouches, powerOffScreen, restoreScreenOffTimeout);

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

@@ -479,6 +479,11 @@ public class Options {
             }
         }
 
+        if (options.newDisplay != null) {
+            assert options.displayId == 0 : "Must not set both displayId and newDisplay";
+            options.displayId = Device.DISPLAY_ID_NONE;
+        }
+
         return options;
     }
 

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

@@ -103,11 +103,8 @@ public final class Server {
 
         CleanUp cleanUp = null;
 
-        NewDisplay newDisplay = options.getNewDisplay();
-        int displayId = newDisplay == null ? options.getDisplayId() : Device.DISPLAY_ID_NONE;
-
         if (options.getCleanup()) {
-            cleanUp = CleanUp.start(displayId, options);
+            cleanUp = CleanUp.start(options);
         }
 
         int scid = options.getScid();
@@ -131,7 +128,7 @@ public final class Server {
 
             if (control) {
                 ControlChannel controlChannel = connection.getControlChannel();
-                controller = new Controller(displayId, controlChannel, cleanUp, options.getClipboardAutosync(), options.getPowerOn());
+                controller = new Controller(controlChannel, cleanUp, options);
                 asyncProcessors.add(controller);
             }
 
@@ -150,8 +147,7 @@ public final class Server {
                 if (audioCodec == AudioCodec.RAW) {
                     audioRecorder = new AudioRawRecorder(audioCapture, audioStreamer);
                 } else {
-                    audioRecorder = new AudioEncoder(audioCapture, audioStreamer, options.getAudioBitRate(), options.getAudioCodecOptions(),
-                            options.getAudioEncoder());
+                    audioRecorder = new AudioEncoder(audioCapture, audioStreamer, options);
                 }
                 asyncProcessors.add(audioRecorder);
             }
@@ -161,19 +157,17 @@ public final class Server {
                         options.getSendFrameMeta());
                 SurfaceCapture surfaceCapture;
                 if (options.getVideoSource() == VideoSource.DISPLAY) {
+                    NewDisplay newDisplay = options.getNewDisplay();
                     if (newDisplay != null) {
-                        surfaceCapture = new NewDisplayCapture(controller, newDisplay, options.getMaxSize());
+                        surfaceCapture = new NewDisplayCapture(controller, options);
                     } else {
-                        assert displayId != Device.DISPLAY_ID_NONE;
-                        surfaceCapture = new ScreenCapture(controller, displayId, options.getMaxSize(), options.getCrop(),
-                                options.getLockVideoOrientation());
+                        assert options.getDisplayId() != Device.DISPLAY_ID_NONE;
+                        surfaceCapture = new ScreenCapture(controller, options);
                     }
                 } else {
-                    surfaceCapture = new CameraCapture(options.getCameraId(), options.getCameraFacing(), options.getCameraSize(),
-                            options.getMaxSize(), options.getCameraAspectRatio(), options.getCameraFps(), options.getCameraHighSpeed());
+                    surfaceCapture = new CameraCapture(options);
                 }
-                SurfaceEncoder surfaceEncoder = new SurfaceEncoder(surfaceCapture, videoStreamer, options.getVideoBitRate(), options.getMaxFps(),
-                        options.getVideoCodecOptions(), options.getVideoEncoder(), options.getDownsizeOnError());
+                SurfaceEncoder surfaceEncoder = new SurfaceEncoder(surfaceCapture, videoStreamer, options);
                 asyncProcessors.add(surfaceEncoder);
 
                 if (controller != null) {

server/src/main/java/com/genymobile/scrcpy/audio/AudioEncoder.java

@@ -2,6 +2,7 @@ package com.genymobile.scrcpy.audio;
 
 import com.genymobile.scrcpy.AndroidVersions;
 import com.genymobile.scrcpy.AsyncProcessor;
+import com.genymobile.scrcpy.Options;
 import com.genymobile.scrcpy.device.ConfigurationException;
 import com.genymobile.scrcpy.device.Streamer;
 import com.genymobile.scrcpy.util.Codec;
@@ -67,12 +68,12 @@ public final class AudioEncoder implements AsyncProcessor {
 
     private boolean ended;
 
-    public AudioEncoder(AudioCapture capture, Streamer streamer, int bitRate, List<CodecOption> codecOptions, String encoderName) {
+    public AudioEncoder(AudioCapture capture, Streamer streamer, Options options) {
         this.capture = capture;
         this.streamer = streamer;
-        this.bitRate = bitRate;
-        this.codecOptions = codecOptions;
-        this.encoderName = encoderName;
+        this.bitRate = options.getAudioBitRate();
+        this.codecOptions = options.getAudioCodecOptions();
+        this.encoderName = options.getAudioEncoder();
     }
 
     private static MediaFormat createFormat(String mimeType, int bitRate, List<CodecOption> codecOptions) {

server/src/main/java/com/genymobile/scrcpy/control/Controller.java

@@ -3,6 +3,7 @@ package com.genymobile.scrcpy.control;
 import com.genymobile.scrcpy.AndroidVersions;
 import com.genymobile.scrcpy.AsyncProcessor;
 import com.genymobile.scrcpy.CleanUp;
+import com.genymobile.scrcpy.Options;
 import com.genymobile.scrcpy.device.Device;
 import com.genymobile.scrcpy.device.DeviceApp;
 import com.genymobile.scrcpy.device.Point;
@@ -97,12 +98,12 @@ public class Controller implements AsyncProcessor, VirtualDisplayListener {
     // Used for resetting video encoding on RESET_VIDEO message
     private SurfaceCapture surfaceCapture;
 
-    public Controller(int displayId, ControlChannel controlChannel, CleanUp cleanUp, boolean clipboardAutosync, boolean powerOn) {
-        this.displayId = displayId;
+    public Controller(ControlChannel controlChannel, CleanUp cleanUp, Options options) {
+        this.displayId = options.getDisplayId();
         this.controlChannel = controlChannel;
         this.cleanUp = cleanUp;
-        this.clipboardAutosync = clipboardAutosync;
-        this.powerOn = powerOn;
+        this.clipboardAutosync = options.getClipboardAutosync();
+        this.powerOn = options.getPowerOn();
         initPointers();
         sender = new DeviceMessageSender(controlChannel);
 

server/src/main/java/com/genymobile/scrcpy/util/LogUtils.java

@@ -236,7 +236,7 @@ public final class LogUtils {
             } else {
                 builder.append("\n   ").append(String.format("%" + column + "s", " "));
             }
-            builder.append(" [").append(app.getPackageName()).append(']');
+            builder.append(" ").append(app.getPackageName());
         }
 
         return builder.toString();

server/src/main/java/com/genymobile/scrcpy/video/CameraCapture.java

@@ -1,9 +1,12 @@
 package com.genymobile.scrcpy.video;
 
 import com.genymobile.scrcpy.AndroidVersions;
+import com.genymobile.scrcpy.Options;
+import com.genymobile.scrcpy.device.ConfigurationException;
 import com.genymobile.scrcpy.device.Size;
 import com.genymobile.scrcpy.util.HandlerExecutor;
 import com.genymobile.scrcpy.util.Ln;
+import com.genymobile.scrcpy.util.LogUtils;
 import com.genymobile.scrcpy.wrappers.ServiceManager;
 
 import android.annotation.SuppressLint;
@@ -56,19 +59,18 @@ public class CameraCapture extends SurfaceCapture {
 
     private final AtomicBoolean disconnected = new AtomicBoolean();
 
-    public CameraCapture(String explicitCameraId, CameraFacing cameraFacing, Size explicitSize, int maxSize, CameraAspectRatio aspectRatio, int fps,
-            boolean highSpeed) {
-        this.explicitCameraId = explicitCameraId;
-        this.cameraFacing = cameraFacing;
-        this.explicitSize = explicitSize;
-        this.maxSize = maxSize;
-        this.aspectRatio = aspectRatio;
-        this.fps = fps;
-        this.highSpeed = highSpeed;
+    public CameraCapture(Options options) {
+        this.explicitCameraId = options.getCameraId();
+        this.cameraFacing = options.getCameraFacing();
+        this.explicitSize = options.getCameraSize();
+        this.maxSize = options.getMaxSize();
+        this.aspectRatio = options.getCameraAspectRatio();
+        this.fps = options.getCameraFps();
+        this.highSpeed = options.getCameraHighSpeed();
     }
 
     @Override
-    protected void init() throws IOException {
+    protected void init() throws ConfigurationException, IOException {
         cameraThread = new HandlerThread("camera");
         cameraThread.start();
         cameraHandler = new Handler(cameraThread.getLooper());
@@ -77,12 +79,7 @@ public class CameraCapture extends SurfaceCapture {
         try {
             cameraId = selectCamera(explicitCameraId, cameraFacing);
             if (cameraId == null) {
-                throw new IOException("No matching camera found");
-            }
-
-            size = selectSize(cameraId, explicitSize, maxSize, aspectRatio, highSpeed);
-            if (size == null) {
-                throw new IOException("Could not select camera size");
+                throw new ConfigurationException("No matching camera found");
             }
 
             Ln.i("Using camera '" + cameraId + "'");
@@ -92,14 +89,30 @@ public class CameraCapture extends SurfaceCapture {
         }
     }
 
-    private static String selectCamera(String explicitCameraId, CameraFacing cameraFacing) throws CameraAccessException {
-        if (explicitCameraId != null) {
-            return explicitCameraId;
+    @Override
+    public void prepare() throws IOException {
+        try {
+            size = selectSize(cameraId, explicitSize, maxSize, aspectRatio, highSpeed);
+            if (size == null) {
+                throw new IOException("Could not select camera size");
+            }
+        } catch (CameraAccessException e) {
+            throw new IOException(e);
         }
+    }
 
+    private static String selectCamera(String explicitCameraId, CameraFacing cameraFacing) throws CameraAccessException, ConfigurationException {
         CameraManager cameraManager = ServiceManager.getCameraManager();
 
         String[] cameraIds = cameraManager.getCameraIdList();
+        if (explicitCameraId != null) {
+            if (!Arrays.asList(cameraIds).contains(explicitCameraId)) {
+                Ln.e("Camera with id " + explicitCameraId + " not found\n" + LogUtils.buildCameraListMessage(false));
+                throw new ConfigurationException("Camera id not found");
+            }
+            return explicitCameraId;
+        }
+
         if (cameraFacing == null) {
             // Use the first one
             return cameraIds.length > 0 ? cameraIds[0] : null;
@@ -232,13 +245,7 @@ public class CameraCapture extends SurfaceCapture {
         }
 
         this.maxSize = maxSize;
-        try {
-            size = selectSize(cameraId, null, maxSize, aspectRatio, highSpeed);
-            return size != null;
-        } catch (CameraAccessException e) {
-            Ln.w("Could not select camera size", e);
-            return false;
-        }
+        return true;
     }
 
     @SuppressLint("MissingPermission")

server/src/main/java/com/genymobile/scrcpy/video/NewDisplayCapture.java

@@ -1,6 +1,7 @@
 package com.genymobile.scrcpy.video;
 
 import com.genymobile.scrcpy.AndroidVersions;
+import com.genymobile.scrcpy.Options;
 import com.genymobile.scrcpy.control.PositionMapper;
 import com.genymobile.scrcpy.device.DisplayInfo;
 import com.genymobile.scrcpy.device.NewDisplay;
@@ -19,6 +20,8 @@ import java.io.IOException;
 public class NewDisplayCapture extends SurfaceCapture {
 
     // Internal fields copied from android.hardware.display.DisplayManager
+    private static final int VIRTUAL_DISPLAY_FLAG_PUBLIC = DisplayManager.VIRTUAL_DISPLAY_FLAG_PUBLIC;
+    private static final int VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY = DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY;
     private static final int VIRTUAL_DISPLAY_FLAG_SUPPORTS_TOUCH = 1 << 6;
     private static final int VIRTUAL_DISPLAY_FLAG_ROTATES_WITH_CONTENT = 1 << 7;
     private static final int VIRTUAL_DISPLAY_FLAG_DESTROY_CONTENT_ON_REMOVAL = 1 << 8;
@@ -41,10 +44,11 @@ public class NewDisplayCapture extends SurfaceCapture {
     private Size size;
     private int dpi;
 
-    public NewDisplayCapture(VirtualDisplayListener vdListener, NewDisplay newDisplay, int maxSize) {
+    public NewDisplayCapture(VirtualDisplayListener vdListener, Options options) {
         this.vdListener = vdListener;
-        this.newDisplay = newDisplay;
-        this.maxSize = maxSize;
+        this.newDisplay = options.getNewDisplay();
+        assert newDisplay != null;
+        this.maxSize = options.getMaxSize();
     }
 
     @Override
@@ -74,12 +78,11 @@ public class NewDisplayCapture extends SurfaceCapture {
         }
     }
 
-
     public void startNew(Surface surface) {
         int virtualDisplayId;
         try {
-            int flags = DisplayManager.VIRTUAL_DISPLAY_FLAG_PUBLIC
-                    | DisplayManager.VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY
+            int flags = VIRTUAL_DISPLAY_FLAG_PUBLIC
+                    | VIRTUAL_DISPLAY_FLAG_OWN_CONTENT_ONLY
                     | VIRTUAL_DISPLAY_FLAG_SUPPORTS_TOUCH
                     | VIRTUAL_DISPLAY_FLAG_ROTATES_WITH_CONTENT
                     | VIRTUAL_DISPLAY_FLAG_DESTROY_CONTENT_ON_REMOVAL

server/src/main/java/com/genymobile/scrcpy/video/ScreenCapture.java

@@ -1,8 +1,10 @@
 package com.genymobile.scrcpy.video;
 
 import com.genymobile.scrcpy.AndroidVersions;
+import com.genymobile.scrcpy.Options;
 import com.genymobile.scrcpy.control.PositionMapper;
 import com.genymobile.scrcpy.device.ConfigurationException;
+import com.genymobile.scrcpy.device.Device;
 import com.genymobile.scrcpy.device.DisplayInfo;
 import com.genymobile.scrcpy.device.Size;
 import com.genymobile.scrcpy.util.Ln;
@@ -48,12 +50,13 @@ public class ScreenCapture extends SurfaceCapture {
     private IRotationWatcher rotationWatcher;
     private IDisplayFoldListener displayFoldListener;
 
-    public ScreenCapture(VirtualDisplayListener vdListener, int displayId, int maxSize, Rect crop, int lockVideoOrientation) {
+    public ScreenCapture(VirtualDisplayListener vdListener, Options options) {
         this.vdListener = vdListener;
-        this.displayId = displayId;
-        this.maxSize = maxSize;
-        this.crop = crop;
-        this.lockVideoOrientation = lockVideoOrientation;
+        this.displayId = options.getDisplayId();
+        assert displayId != Device.DISPLAY_ID_NONE;
+        this.maxSize = options.getMaxSize();
+        this.crop = options.getCrop();
+        this.lockVideoOrientation = options.getLockVideoOrientation();
     }
 
     @Override

server/src/main/java/com/genymobile/scrcpy/video/SurfaceCapture.java

@@ -46,7 +46,7 @@ public abstract class SurfaceCapture {
     /**
      * Called once before each capture starts, before {@link #getSize()}.
      */
-    public void prepare() throws ConfigurationException {
+    public void prepare() throws ConfigurationException, IOException {
         // empty by default
     }
 

server/src/main/java/com/genymobile/scrcpy/video/SurfaceEncoder.java

@@ -2,6 +2,7 @@ package com.genymobile.scrcpy.video;
 
 import com.genymobile.scrcpy.AndroidVersions;
 import com.genymobile.scrcpy.AsyncProcessor;
+import com.genymobile.scrcpy.Options;
 import com.genymobile.scrcpy.device.ConfigurationException;
 import com.genymobile.scrcpy.device.Size;
 import com.genymobile.scrcpy.device.Streamer;
@@ -51,15 +52,14 @@ public class SurfaceEncoder implements AsyncProcessor {
 
     private final CaptureReset reset = new CaptureReset();
 
-    public SurfaceEncoder(SurfaceCapture capture, Streamer streamer, int videoBitRate, float maxFps, List<CodecOption> codecOptions,
-            String encoderName, boolean downsizeOnError) {
+    public SurfaceEncoder(SurfaceCapture capture, Streamer streamer, Options options) {
         this.capture = capture;
         this.streamer = streamer;
-        this.videoBitRate = videoBitRate;
-        this.maxFps = maxFps;
-        this.codecOptions = codecOptions;
-        this.encoderName = encoderName;
-        this.downsizeOnError = downsizeOnError;
+        this.videoBitRate = options.getVideoBitRate();
+        this.maxFps = options.getMaxFps();
+        this.codecOptions = options.getVideoCodecOptions();
+        this.encoderName = options.getVideoEncoder();
+        this.downsizeOnError = options.getDownsizeOnError();
     }
 
     private void streamCapture() throws IOException, ConfigurationException {
@@ -116,7 +116,6 @@ public class SurfaceEncoder implements AsyncProcessor {
                     if (!prepareRetry(size)) {
                         throw e;
                     }
-                    Ln.i("Retrying...");
                     alive = true;
                 } finally {
                     reset.setRunningMediaCodec(null);