Add --audio-encoder option

Similar to --video-encoder, but for audio.

app/scrcpy.1

@@ -31,6 +31,10 @@ Select an audio codec (opus or aac).
 
 Default is opus.
 
+.TP
+.BI "\-\-audio\-encoder " name
+Use a specific MediaCodec audio encoder (depending on the codec provided by \fB\-\-audio\-codec\fR).
+
 .TP
 .BI "\-b, \-\-bit\-rate " value
 Encode the video at the given bit\-rate, expressed in bits/s. Unit suffixes are supported: '\fBK\fR' (x1000) and '\fBM\fR' (x1000000).
@@ -94,7 +98,7 @@ Also see \fB\-d\fR (\fB\-\-select\-usb\fR).
 
 .TP
 .BI "\-\-encoder " name
-Use a specific MediaCodec encoder (must be a H.264 encoder).
+Use a specific MediaCodec encoder (depending on the codec provided by \fB\-\-codec\fR).
 
 .TP
 .B \-\-force\-adb\-forward

app/src/cli.c

@@ -61,6 +61,7 @@
 #define OPT_NO_AUDIO               1041
 #define OPT_AUDIO_BIT_RATE         1042
 #define OPT_AUDIO_CODEC            1043
+#define OPT_AUDIO_ENCODER_NAME     1044
 
 struct sc_option {
     char shortopt;
@@ -116,6 +117,13 @@ static const struct sc_option options[] = {
         .text = "Select an audio codec (opus or aac).\n"
                 "Default is opus.",
     },
+    {
+        .longopt_id = OPT_AUDIO_ENCODER_NAME,
+        .longopt = "audio-encoder",
+        .argdesc = "name",
+        .text = "Use a specific MediaCodec audio encoder (depending on the "
+                "codec provided by --audio-codec).",
+    },
     {
         .shortopt = 'b',
         .longopt = "bit-rate",
@@ -191,7 +199,8 @@ static const struct sc_option options[] = {
         .longopt_id = OPT_ENCODER_NAME,
         .longopt = "encoder",
         .argdesc = "name",
-        .text = "Use a specific MediaCodec encoder (must be a H.264 encoder).",
+        .text = "Use a specific MediaCodec encoder (depending on the codec "
+                "provided by --codec).",
     },
     {
         .longopt_id = OPT_FORCE_ADB_FORWARD,
@@ -1634,6 +1643,9 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
             case OPT_ENCODER_NAME:
                 opts->encoder_name = optarg;
                 break;
+            case OPT_AUDIO_ENCODER_NAME:
+                opts->audio_encoder_name = optarg;
+                break;
             case OPT_FORCE_ADB_FORWARD:
                 opts->force_adb_forward = true;
                 break;

app/src/options.h

@@ -97,6 +97,7 @@ struct scrcpy_options {
     const char *render_driver;
     const char *codec_options;
     const char *encoder_name;
+    const char *audio_encoder_name;
 #ifdef HAVE_V4L2
     const char *v4l2_device;
 #endif

app/src/recorder.c

@@ -630,7 +630,6 @@ sc_recorder_audio_packet_sink_close(struct sc_packet_sink *sink) {
 
     sc_mutex_lock(&recorder->mutex);
     // EOS also stops the recorder
-    // TODO must stop only once both video and audio stream are complete
     recorder->stopped = true;
     sc_cond_signal(&recorder->queue_cond);
     sc_mutex_unlock(&recorder->mutex);

app/src/scrcpy.c

@@ -368,6 +368,7 @@ scrcpy(struct scrcpy_options *options) {
         .stay_awake = options->stay_awake,
         .codec_options = options->codec_options,
         .encoder_name = options->encoder_name,
+        .audio_encoder_name = options->audio_encoder_name,
         .force_adb_forward = options->force_adb_forward,
         .power_off_on_close = options->power_off_on_close,
         .clipboard_autosync = options->clipboard_autosync,

app/src/server.c

@@ -73,6 +73,7 @@ sc_server_params_destroy(struct sc_server_params *params) {
     free((char *) params->crop);
     free((char *) params->codec_options);
     free((char *) params->encoder_name);
+    free((char *) params->audio_encoder_name);
     free((char *) params->tcpip_dst);
 }
 
@@ -97,6 +98,7 @@ sc_server_params_copy(struct sc_server_params *dst,
     COPY(crop);
     COPY(codec_options);
     COPY(encoder_name);
+    COPY(audio_encoder_name);
     COPY(tcpip_dst);
 #undef COPY
 
@@ -270,6 +272,9 @@ execute_server(struct sc_server *server,
     if (params->encoder_name) {
         ADD_PARAM("encoder_name=%s", params->encoder_name);
     }
+    if (params->audio_encoder_name) {
+        ADD_PARAM("audio_encoder_name=%s", params->audio_encoder_name);
+    }
     if (params->power_off_on_close) {
         ADD_PARAM("power_off_on_close=true");
     }

app/src/server.h

@@ -30,6 +30,7 @@ struct sc_server_params {
     const char *crop;
     const char *codec_options;
     const char *encoder_name;
+    const char *audio_encoder_name;
     struct sc_port_range port_range;
     uint32_t tunnel_host;
     uint16_t tunnel_port;

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

@@ -45,6 +45,7 @@ public final class AudioEncoder {
 
     private final Streamer streamer;
     private final int bitRate;
+    private final String encoderName;
 
     private AudioRecord recorder;
     private MediaCodec mediaCodec;
@@ -62,9 +63,10 @@ public final class AudioEncoder {
 
     private boolean ended;
 
-    public AudioEncoder(Streamer streamer, int bitRate) {
+    public AudioEncoder(Streamer streamer, int bitRate, String encoderName) {
         this.streamer = streamer;
         this.bitRate = bitRate;
+        this.encoderName = encoderName;
     }
 
     private static AudioFormat createAudioFormat() {
@@ -200,17 +202,23 @@ public final class AudioEncoder {
 
     @TargetApi(Build.VERSION_CODES.M)
     public void encode() throws IOException {
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.R) {
+            Ln.w("Audio disabled: it is not supported before Android 11");
+            streamer.writeDisableStream();
+            return;
+        }
+
         try {
             try {
-                String mimeType = streamer.getCodec().getMimeType();
+                Codec codec = streamer.getCodec();
 
-                mediaCodec = MediaCodec.createEncoderByType(mimeType); // may throw IOException
+                mediaCodec = createMediaCodec(codec, encoderName);
                 recorder = createAudioRecord();
 
                 mediaCodecThread = new HandlerThread("AudioEncoder");
                 mediaCodecThread.start();
 
-                MediaFormat format = createFormat(mimeType, bitRate);
+                MediaFormat format = createFormat(codec.getMimeType(), bitRate);
                 mediaCodec.setCallback(new EncoderCallback(), new Handler(mediaCodecThread.getLooper()));
                 mediaCodec.configure(format, null, null, MediaCodec.CONFIGURE_FLAG_ENCODE);
 
@@ -249,6 +257,8 @@ public final class AudioEncoder {
             mediaCodec.start();
             inputThread.start();
             outputThread.start();
+        } catch (ConfigurationException e) {
+            // Do not print stack trace, a user-friendly error-message has already been logged
         } catch (Throwable e) {
             if (mediaCodec != null) {
                 mediaCodec.release();
@@ -266,6 +276,21 @@ public final class AudioEncoder {
         }
     }
 
+    private static MediaCodec createMediaCodec(Codec codec, String encoderName) throws IOException, ConfigurationException {
+        if (encoderName != null) {
+            Ln.d("Creating audio encoder by name: '" + encoderName + "'");
+            try {
+                return MediaCodec.createByCodecName(encoderName);
+            } catch (IllegalArgumentException e) {
+                Ln.e(CodecUtils.buildUnknownEncoderMessage(codec, encoderName));
+                throw new ConfigurationException("Unknown encoder: " + encoderName);
+            }
+        }
+        MediaCodec mediaCodec = MediaCodec.createEncoderByType(codec.getMimeType());
+        Ln.d("Using audio encoder: '" + mediaCodec.getName() + "'");
+        return mediaCodec;
+    }
+
     private void cleanUp() {
         mediaCodecThread.getLooper().quit();
         inputThread.interrupt();

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

@@ -0,0 +1,40 @@
+package com.genymobile.scrcpy;
+
+import android.media.MediaCodecInfo;
+import android.media.MediaCodecList;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
+public final class CodecUtils {
+
+    private CodecUtils() {
+        // not instantiable
+    }
+
+    public static String buildUnknownEncoderMessage(Codec codec, String encoderName) {
+        StringBuilder msg = new StringBuilder("Encoder '").append(encoderName).append("' for ").append(codec.getName()).append(" not found");
+        MediaCodecInfo[] encoders = listEncoders(codec.getMimeType());
+        if (encoders != null && encoders.length > 0) {
+            msg.append("\nTry to use one of the available encoders:");
+            String codecOption = codec.getType() == Codec.Type.VIDEO ? "codec" : "audio-codec";
+            for (MediaCodecInfo encoder : encoders) {
+                msg.append("\n    scrcpy --").append(codecOption).append("=").append(codec.getName());
+                msg.append(" --encoder='").append(encoder.getName()).append("'");
+            }
+        }
+        return msg.toString();
+    }
+
+    private static MediaCodecInfo[] listEncoders(String mimeType) {
+        List<MediaCodecInfo> result = new ArrayList<>();
+        MediaCodecList list = new MediaCodecList(MediaCodecList.REGULAR_CODECS);
+        for (MediaCodecInfo codecInfo : list.getCodecInfos()) {
+            if (codecInfo.isEncoder() && Arrays.asList(codecInfo.getSupportedTypes()).contains(mimeType)) {
+                result.add(codecInfo);
+            }
+        }
+        return result.toArray(new MediaCodecInfo[result.size()]);
+    }
+}

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

@@ -0,0 +1,7 @@
+package com.genymobile.scrcpy;
+
+public class ConfigurationException extends Exception {
+    public ConfigurationException(String message) {
+        super(message);
+    }
+}

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

@@ -61,12 +61,12 @@ public final class Device {
 
     private final boolean supportsInputEvents;
 
-    public Device(Options options) {
+    public Device(Options options) throws ConfigurationException {
         displayId = options.getDisplayId();
         DisplayInfo displayInfo = ServiceManager.getDisplayManager().getDisplayInfo(displayId);
         if (displayInfo == null) {
-            int[] displayIds = ServiceManager.getDisplayManager().getDisplayIds();
-            throw new InvalidDisplayIdException(displayId, displayIds);
+            Ln.e(buildUnknownDisplayIdMessage(displayId));
+            throw new ConfigurationException("Unknown display id: " + displayId);
         }
 
         int displayInfoFlags = displayInfo.getFlags();
@@ -130,6 +130,18 @@ public final class Device {
         }
     }
 
+    private static String buildUnknownDisplayIdMessage(int displayId) {
+        StringBuilder msg = new StringBuilder("Display ").append(displayId).append(" not found");
+        int[] displayIds = ServiceManager.getDisplayManager().getDisplayIds();
+        if (displayIds != null && displayIds.length > 0) {
+            msg.append("\nTry to use one of the available display ids:");
+            for (int id : displayIds) {
+                msg.append("\n    scrcpy --display=").append(id);
+            }
+        }
+        return msg.toString();
+    }
+
     public synchronized void setMaxSize(int newMaxSize) {
         maxSize = newMaxSize;
         screenInfo = ScreenInfo.computeScreenInfo(screenInfo.getReverseVideoRotation(), deviceSize, crop, newMaxSize, lockVideoOrientation);

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

@@ -1,21 +0,0 @@
-package com.genymobile.scrcpy;
-
-public class InvalidDisplayIdException extends RuntimeException {
-
-    private final int displayId;
-    private final int[] availableDisplayIds;
-
-    public InvalidDisplayIdException(int displayId, int[] availableDisplayIds) {
-        super("There is no display having id " + displayId);
-        this.displayId = displayId;
-        this.availableDisplayIds = availableDisplayIds;
-    }
-
-    public int getDisplayId() {
-        return displayId;
-    }
-
-    public int[] getAvailableDisplayIds() {
-        return availableDisplayIds;
-    }
-}

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

@@ -1,23 +0,0 @@
-package com.genymobile.scrcpy;
-
-import android.media.MediaCodecInfo;
-
-public class InvalidEncoderException extends RuntimeException {
-
-    private final String name;
-    private final MediaCodecInfo[] availableEncoders;
-
-    public InvalidEncoderException(String name, MediaCodecInfo[] availableEncoders) {
-        super("There is no encoder having name '" + name + '"');
-        this.name = name;
-        this.availableEncoders = availableEncoders;
-    }
-
-    public String getName() {
-        return name;
-    }
-
-    public MediaCodecInfo[] getAvailableEncoders() {
-        return availableEncoders;
-    }
-}

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

@@ -24,6 +24,7 @@ public class Options {
     private boolean stayAwake;
     private List<CodecOption> codecOptions;
     private String encoderName;
+    private String audioEncoderName;
     private boolean powerOffScreenOnClose;
     private boolean clipboardAutosync = true;
     private boolean downsizeOnError = true;
@@ -180,6 +181,14 @@ public class Options {
         this.encoderName = encoderName;
     }
 
+    public String getAudioEncoderName() {
+        return audioEncoderName;
+    }
+
+    public void setAudioEncoderName(String audioEncoderName) {
+        this.audioEncoderName = audioEncoderName;
+    }
+
     public void setPowerOffScreenOnClose(boolean powerOffScreenOnClose) {
         this.powerOffScreenOnClose = powerOffScreenOnClose;
     }

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

@@ -5,7 +5,6 @@ import com.genymobile.scrcpy.wrappers.SurfaceControl;
 import android.graphics.Rect;
 import android.media.MediaCodec;
 import android.media.MediaCodecInfo;
-import android.media.MediaCodecList;
 import android.media.MediaFormat;
 import android.os.Build;
 import android.os.IBinder;
@@ -14,8 +13,6 @@ import android.view.Surface;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;
-import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 
@@ -62,10 +59,10 @@ public class ScreenEncoder implements Device.RotationListener {
         return rotationChanged.getAndSet(false);
     }
 
-    public void streamScreen() throws IOException {
-        String videoMimeType = streamer.getCodec().getMimeType();
-        MediaCodec codec = createCodec(videoMimeType, encoderName);
-        MediaFormat format = createFormat(videoMimeType, bitRate, maxFps, codecOptions);
+    public void streamScreen() throws IOException, ConfigurationException {
+        Codec codec = streamer.getCodec();
+        MediaCodec mediaCodec = createMediaCodec(codec, encoderName);
+        MediaFormat format = createFormat(codec.getMimeType(), bitRate, maxFps, codecOptions);
         IBinder display = createDisplay();
         device.setRotationListener(this);
 
@@ -84,8 +81,8 @@ public class ScreenEncoder implements Device.RotationListener {
 
                 Surface surface = null;
                 try {
-                    codec.configure(format, null, null, MediaCodec.CONFIGURE_FLAG_ENCODE);
-                    surface = codec.createInputSurface();
+                    mediaCodec.configure(format, null, null, MediaCodec.CONFIGURE_FLAG_ENCODE);
+                    surface = mediaCodec.createInputSurface();
 
                     // does not include the locked video orientation
                     Rect unlockedVideoRect = screenInfo.getUnlockedVideoSize().toRect();
@@ -93,11 +90,11 @@ public class ScreenEncoder implements Device.RotationListener {
                     int layerStack = device.getLayerStack();
                     setDisplaySurface(display, surface, videoRotation, contentRect, unlockedVideoRect, layerStack);
 
-                    codec.start();
+                    mediaCodec.start();
 
-                    alive = encode(codec, streamer);
+                    alive = encode(mediaCodec, streamer);
                     // do not call stop() on exception, it would trigger an IllegalStateException
-                    codec.stop();
+                    mediaCodec.stop();
                 } catch (IllegalStateException | IllegalArgumentException e) {
                     Ln.e("Encoding error: " + e.getClass().getName() + ": " + e.getMessage());
                     if (!prepareRetry(device, screenInfo)) {
@@ -106,14 +103,14 @@ public class ScreenEncoder implements Device.RotationListener {
                     Ln.i("Retrying...");
                     alive = true;
                 } finally {
-                    codec.reset();
+                    mediaCodec.reset();
                     if (surface != null) {
                         surface.release();
                     }
                 }
             } while (alive);
         } finally {
-            codec.release();
+            mediaCodec.release();
             device.setRotationListener(null);
             SurfaceControl.destroyDisplay(display);
         }
@@ -199,30 +196,19 @@ public class ScreenEncoder implements Device.RotationListener {
         return !eof;
     }
 
-    private static MediaCodecInfo[] listEncoders(String videoMimeType) {
-        List<MediaCodecInfo> result = new ArrayList<>();
-        MediaCodecList list = new MediaCodecList(MediaCodecList.REGULAR_CODECS);
-        for (MediaCodecInfo codecInfo : list.getCodecInfos()) {
-            if (codecInfo.isEncoder() && Arrays.asList(codecInfo.getSupportedTypes()).contains(videoMimeType)) {
-                result.add(codecInfo);
-            }
-        }
-        return result.toArray(new MediaCodecInfo[result.size()]);
-    }
-
-    private static MediaCodec createCodec(String videoMimeType, String encoderName) throws IOException {
+    private static MediaCodec createMediaCodec(Codec codec, String encoderName) throws IOException, ConfigurationException {
         if (encoderName != null) {
             Ln.d("Creating encoder by name: '" + encoderName + "'");
             try {
                 return MediaCodec.createByCodecName(encoderName);
             } catch (IllegalArgumentException e) {
-                MediaCodecInfo[] encoders = listEncoders(videoMimeType);
-                throw new InvalidEncoderException(encoderName, encoders);
+                Ln.e(CodecUtils.buildUnknownEncoderMessage(codec, encoderName));
+                throw new ConfigurationException("Unknown encoder: " + encoderName);
             }
         }
-        MediaCodec codec = MediaCodec.createEncoderByType(videoMimeType);
-        Ln.d("Using encoder: '" + codec.getName() + "'");
-        return codec;
+        MediaCodec mediaCodec = MediaCodec.createEncoderByType(codec.getMimeType());
+        Ln.d("Using encoder: '" + mediaCodec.getName() + "'");
+        return mediaCodec;
     }
 
     private static void setCodecOption(MediaFormat format, CodecOption codecOption) {

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

@@ -1,7 +1,6 @@
 package com.genymobile.scrcpy;
 
 import android.graphics.Rect;
-import android.media.MediaCodecInfo;
 import android.os.BatteryManager;
 import android.os.Build;
 
@@ -59,7 +58,7 @@ public final class Server {
         }
     }
 
-    private static void scrcpy(Options options) throws IOException {
+    private static void scrcpy(Options options) throws IOException, ConfigurationException {
         Ln.i("Device: " + Build.MANUFACTURER + " " + Build.MODEL + " (Android " + Build.VERSION.RELEASE + ")");
         final Device device = new Device(options);
         List<CodecOption> codecOptions = options.getCodecOptions();
@@ -93,6 +92,9 @@ public final class Server {
             Workarounds.fillAppInfo();
         }
 
+        Controller controller = null;
+        AudioEncoder audioEncoder = null;
+
         try (DesktopConnection connection = DesktopConnection.open(scid, tunnelForward, audio, control, sendDummyByte)) {
             VideoCodec codec = options.getCodec();
             if (options.getSendDeviceMeta()) {
@@ -100,7 +102,6 @@ public final class Server {
                 connection.sendDeviceMeta(Device.getDeviceName(), videoSize.getWidth(), videoSize.getHeight());
             }
 
-            Controller controller = null;
             if (control) {
                 controller = new Controller(device, connection, options.getClipboardAutosync(), options.getPowerOn());
                 controller.start();
@@ -109,11 +110,10 @@ public final class Server {
                 device.setClipboardListener(text -> controllerRef.getSender().pushClipboardText(text));
             }
 
-            AudioEncoder audioEncoder = null;
             if (audio) {
                 Streamer audioStreamer = new Streamer(connection.getAudioFd(), options.getAudioCodec(), options.getSendCodecId(),
                         options.getSendFrameMeta());
-                audioEncoder = new AudioEncoder(audioStreamer, options.getAudioBitRate());
+                audioEncoder = new AudioEncoder(audioStreamer, options.getAudioBitRate(), options.getAudioEncoderName());
                 audioEncoder.start();
             }
 
@@ -128,27 +128,27 @@ public final class Server {
                 if (!IO.isBrokenPipe(e)) {
                     Ln.e("Video encoding error", e);
                 }
-            } finally {
-                Ln.d("Screen streaming stopped");
-                initThread.interrupt();
+            }
+        } finally {
+            Ln.d("Screen streaming stopped");
+            initThread.interrupt();
+            if (audioEncoder != null) {
+                audioEncoder.stop();
+            }
+            if (controller != null) {
+                controller.stop();
+            }
+
+            try {
+                initThread.join();
                 if (audioEncoder != null) {
-                    audioEncoder.stop();
+                    audioEncoder.join();
                 }
                 if (controller != null) {
-                    controller.stop();
-                }
-
-                try {
-                    initThread.join();
-                    if (audioEncoder != null) {
-                        audioEncoder.join();
-                    }
-                    if (controller != null) {
-                        controller.join();
-                    }
-                } catch (InterruptedException e) {
-                    // ignore
+                    controller.join();
                 }
+            } catch (InterruptedException e) {
+                // ignore
             }
         }
     }
@@ -264,6 +264,10 @@ public final class Server {
                         options.setEncoderName(value);
                     }
                     break;
+                case "audio_encoder_name":
+                    if (!value.isEmpty()) {
+                        options.setAudioEncoderName(value);
+                    }
                 case "power_off_on_close":
                     boolean powerOffScreenOnClose = Boolean.parseBoolean(value);
                     options.setPowerOffScreenOnClose(powerOffScreenOnClose);
@@ -334,38 +338,19 @@ public final class Server {
         return new Rect(x, y, x + width, y + height);
     }
 
-    private static void suggestFix(Throwable e) {
-        if (e instanceof InvalidDisplayIdException) {
-            InvalidDisplayIdException idie = (InvalidDisplayIdException) e;
-            int[] displayIds = idie.getAvailableDisplayIds();
-            if (displayIds != null && displayIds.length > 0) {
-                Ln.e("Try to use one of the available display ids:");
-                for (int id : displayIds) {
-                    Ln.e("    scrcpy --display " + id);
-                }
-            }
-        } else if (e instanceof InvalidEncoderException) {
-            InvalidEncoderException iee = (InvalidEncoderException) e;
-            MediaCodecInfo[] encoders = iee.getAvailableEncoders();
-            if (encoders != null && encoders.length > 0) {
-                Ln.e("Try to use one of the available encoders:");
-                for (MediaCodecInfo encoder : encoders) {
-                    Ln.e("    scrcpy --encoder '" + encoder.getName() + "'");
-                }
-            }
-        }
-    }
-
     public static void main(String... args) throws Exception {
         Thread.setDefaultUncaughtExceptionHandler((t, e) -> {
             Ln.e("Exception on thread " + t, e);
-            suggestFix(e);
         });
 
         Options options = createOptions(args);
 
         Ln.initLogLevel(options.getLogLevel());
 
-        scrcpy(options);
+        try {
+            scrcpy(options);
+        } catch (ConfigurationException e) {
+            // Do not print stack trace, a user-friendly error-message has already been logged
+        }
     }
 }