Compare commits

..

76 Commits

Author SHA1 Message Date
Simon Chan
79f9ec5801 Add workaround to capture audio on Android 11
On Android 11, it is possible to start the capture only when the running
app is in foreground. But scrcpy is not an app, it's a Java application
started from shell.

As a workaround, start an existing Android shell existing activity just
to start the capture, then close it immediately.

Co-authored-by: Romain Vimont <rom@rom1v.com>
Signed-off-by: Romain Vimont <rom@rom1v.com>
2023-02-26 22:41:07 +01:00
Romain Vimont
b7d2086508 Add audio player
Play the decoded audio using SDL.

The audio player frame sink receives the audio frames, resample them
and write them to a byte buffer (introduced by this commit).

On SDL audio callback (from an internal SDL thread), copy samples from
this byte buffer to the SDL audio buffer.

The byte buffer is protected by the SDL_AudioDeviceLock(), but it has
been designed so that the producer and the consumer may write and read
in parallel, provided that they don't access the same slices of the
ring-buffer buffer.

Co-authored-by: Simon Chan <1330321+yume-chan@users.noreply.github.com>
2023-02-26 22:41:07 +01:00
Romain Vimont
b12d1ae7cb Add two-step write feature to bytebuf
If there is exactly one producer, then it can assume that the remaining
space in the buffer will only increase until it write something.

This assumption may allow the producer to write to the buffer (up to a
known safe size) without any synchronization mechanism, thus allowing
to read and write different parts of the buffer in parallel.

The producer can then commit the write with lock held, and update its
knowledge of the safe empty remaining space.
2023-02-26 22:41:07 +01:00
Romain Vimont
28289ab881 Introduce bytebuf util
Add a ring-buffer for bytes. It will be useful for buffering audio.
2023-02-26 22:41:07 +01:00
Romain Vimont
0cf7dabfc3 Pass AVCodecContext to frame sinks
Frame consumers may need details about the frame format.
2023-02-26 22:41:07 +01:00
Romain Vimont
dc8e6c3cfe Add an audio decoder 2023-02-26 22:41:07 +01:00
Romain Vimont
cb1d98a59c Give a name to decoder instances
This will be useful in logs.
2023-02-26 22:41:07 +01:00
Romain Vimont
9400584364 Rename decoder to video_decoder 2023-02-26 22:41:07 +01:00
Romain Vimont
98c2762eaa Log display sizes in display list
This is more convenient than just the display id alone.
2023-02-26 22:41:07 +01:00
Romain Vimont
243c8cf1b3 Add --list-device-displays 2023-02-26 22:41:07 +01:00
Romain Vimont
63bc6d1053 Move log message helpers to LogUtils
This class will also contain other log helpers.
2023-02-26 22:41:07 +01:00
Romain Vimont
6926f5e4fd Quit on audio configuration failure
When audio capture fails on the device, scrcpy continue mirroring the
video stream. This allows to enable audio by default only when
supported.

However, if an audio configuration occurs (for example the user
explicitly selected an unknown audio encoder), this must be treated as
an error and scrcpy must exit.
2023-02-26 22:41:07 +01:00
Romain Vimont
004eb47d4a Add --list-encoders
Add an option to list the device encoders properly.
2023-02-26 22:41:07 +01:00
Romain Vimont
d720d424d8 Move await_for_server() logs
Print the logs on the caller side. This will allow to call the function
in another context without printing the logs.
2023-02-26 22:41:07 +01:00
Romain Vimont
43660079c5 Add --audio-encoder
Similar to --video-encoder, but for audio.
2023-02-26 22:41:07 +01:00
Romain Vimont
a5aba2948a Extract unknown encoder error message
This will allow to reuse the same code for audio encoder selection.
2023-02-26 22:41:07 +01:00
Romain Vimont
7a17895111 Add --audio-codec-options
Similar to --video-codec-options, but for audio.
2023-02-26 22:41:07 +01:00
Romain Vimont
fb2c9ef9e7 Extract application of codec options
This will allow to reuse the same code for audio codec options.
2023-02-26 22:41:07 +01:00
Romain Vimont
12d79686d1 Add support for AAC audio codec
Add option --audio-codec=aac.
2023-02-26 22:41:07 +01:00
Romain Vimont
923032e5ca Add --audio-codec
Introduce the selection mechanism. Alternative codecs will be added
later.
2023-02-26 22:41:07 +01:00
Romain Vimont
4689cd07d4 Add --audio-bit-rate
Add an option to configure the audio bit-rate.
2023-02-26 22:41:07 +01:00
Romain Vimont
d99c3da08f Disable MethodLength checkstyle on createOptions()
This method will grow as needed to initialize options.
2023-02-26 22:41:07 +01:00
Romain Vimont
4082cb32f9 Rename --encoder to --video-encoder
This prepares the introduction of --audio-encoder.
2023-02-26 22:41:07 +01:00
Romain Vimont
f3b4160d77 Rename --codec-options to --video-codec-options
This prepares the introduction of --audio-codec-options.
2023-02-26 22:41:07 +01:00
Romain Vimont
207ae8b73c Rename --bit-rate to --video-bit-rate
This prepares the introduction of --audio-bit-rate.
2023-02-26 22:41:07 +01:00
Romain Vimont
cf15859214 Rename --codec to --video-codec
This prepares the introduction of --audio-codec.
2023-02-26 22:41:07 +01:00
Romain Vimont
6cdd4e867b Remove default bit-rate on client side
If no bit-rate is passed, let the server use the default value (8Mbps).

This avoids to define a default value on both sides, and to pass the
default bit-rate as an argument when starting the server.
2023-02-26 22:41:07 +01:00
Romain Vimont
560002047b Record at least video packets on stop
If the recorder is stopped while it has not received any audio packet
yet, make sure the video stream is correctly recorded.
2023-02-26 22:41:07 +01:00
Romain Vimont
3233aa1c4f Disable audio before Android 11
The permission "android.permission.RECORD_AUDIO" has been added for
shell in Android 11.

Moreover, on lower versions, it may make the server segfault on the
device (happened on a Nexus 5 with Android 6.0.1).

Refs <4feeee8891%5E%21/>
2023-02-26 22:41:07 +01:00
Romain Vimont
a8a1da1a00 Disable audio on initialization error
By default, audio is enabled (--no-audio must be explicitly passed to
disable it).

However, some devices may not support audio capture (typically devices
below Android 11, or Android 11 when the shell application is not
foreground on start).

In that case, make the server notify the client to dynamically disable
audio forwarding so that it does not wait indefinitely for an audio
stream.

Also disable audio on unknown codec or missing decoder on the
client-side, for the same reasons.
2023-02-26 22:41:07 +01:00
Romain Vimont
230abb30c2 Add record audio support
Make the recorder accept two input sources (video and audio), and mux
them into a single file.
2023-02-26 22:41:07 +01:00
Romain Vimont
cb0f4799a2 Rename video-specific variables in recorder
This paves the way to add audio-specific variables.
2023-02-26 22:41:07 +01:00
Romain Vimont
5fc38264c0 Do not merge config audio packets
For video streams (at least H.264 and H.265), the config packet
containing SPS/PPS must be prepended to the next packet (the following
keyframe).

For audio streams (at least OPUS), they must not be merged.
2023-02-26 22:41:07 +01:00
Romain Vimont
3feae6d41b Add an audio demuxer
Add a demuxer which will read the stream from the audio socket.
2023-02-26 22:41:07 +01:00
Romain Vimont
8cf821471f Give a name to demuxer instances
This will be useful in logs.
2023-02-26 22:41:07 +01:00
Romain Vimont
bd51b342b4 Rename demuxer to video_demuxer
There will be another demuxer instance for audio.
2023-02-26 22:41:07 +01:00
Romain Vimont
fa85a128da Extract OPUS extradata
For OPUS codec, FFmpeg expects the raw extradata, but MediaCodec wraps
it in some structure.

Fix the config packet to send only the raw extradata.
2023-02-26 22:41:07 +01:00
Romain Vimont
cd099f7a2b Use a streamer to send the audio stream
Send each encoded audio packet using a streamer.
2023-02-26 22:41:07 +01:00
Romain Vimont
20042addd4 Encode recorded audio on the device
For now, the encoded packets are just logged into the console.
2023-02-26 22:41:07 +01:00
Simon Chan
4d39bb9d26 Capture device audio
Create an AudioRecorder to capture the audio source REMOTE_SUBMIX.

For now, the captured packets are just logged into the console.

Co-authored-by: Romain Vimont <rom@rom1v.com>
Signed-off-by: Romain Vimont <rom@rom1v.com>
2023-02-26 22:41:07 +01:00
Simon Chan
50d180abf2 Add a new socket for audio stream
When audio is enabled, open a new socket to send the audio stream from
the device to the client.

Co-authored-by: Romain Vimont <rom@rom1v.com>
Signed-off-by: Romain Vimont <rom@rom1v.com>
2023-02-26 22:41:07 +01:00
Simon Chan
634ba5d7c4 Add --no-audio option
Audio will be enabled by default (when supported). Add an option to
disable it.

Co-authored-by: Romain Vimont <rom@rom1v.com>
Signed-off-by: Romain Vimont <rom@rom1v.com>
2023-02-26 22:41:07 +01:00
Romain Vimont
cadf95cfc4 Use FakeContext for Application instance
This will expose the correct package name and UID to the application
context.
2023-02-26 22:41:07 +01:00
Romain Vimont
13c8209071 Use shell package name for workarounds
For consistency.
2023-02-26 22:41:07 +01:00
Romain Vimont
c21f604f30 Use ROOT_UID from FakeContext
Remove USER_ID from ServiceManager, and replace it by a constant in
FakeContext.

This is the same as android.os.Process.ROOT_UID, but this constant has
been introduced in API 29.
2023-02-26 22:41:07 +01:00
Romain Vimont
db0bf6f34b Use PACKAGE_NAME from FakeContext
Remove duplicated constant.
2023-02-26 22:41:06 +01:00
Romain Vimont
09388f5352 Use AttributionSource from FakeContext
FakeContext already provides an AttributeSource instance.

Co-authored-by: Simon Chan <1330321+yume-chan@users.noreply.github.com>
2023-02-26 22:41:06 +01:00
Simon Chan
2f3092e6b4 Add a fake Android Context
Since scrcpy-server is not an Android application (it's a java
executable), it has no Context.

Some features will require a Context instance to get the package name
and the UID. Add a FakeContext for this purpose.

Co-authored-by: Romain Vimont <rom@rom1v.com>
Signed-off-by: Romain Vimont <rom@rom1v.com>
2023-02-26 22:41:06 +01:00
Romain Vimont
0ee541fe26 Improve error message for unknown encoder
The provided encoder name depends on the selected codec. Improve the
error message and the suggestions.
2023-02-26 22:41:06 +01:00
Romain Vimont
58249715ac Rename "codec" variable to "mediaCodec"
This will allow to use "codec" for the Codec type.
2023-02-26 22:41:06 +01:00
Romain Vimont
bbf9eeadf1 Make streamer independent of codec type
Rename VideoStreamer to Streamer, and extract a Codec interface which
will also support audio codecs.
2023-02-26 22:41:06 +01:00
Romain Vimont
3b8bb5feb5 Pass all args to ScreenEncoder constructor
There is no good reason to pass some of them in the constructor and some
others as parameters of the streamScreen() method.
2023-02-26 22:41:06 +01:00
Romain Vimont
fa31aaaba8 Move screen encoder initialization
This prepares further refactors.
2023-02-26 22:41:06 +01:00
Romain Vimont
5b6ae2fef3 Write streamer header from ScreenEncoder
The screen encoder is responsible to write data to the video streamer.
2023-02-26 22:41:06 +01:00
Romain Vimont
bf1a4ae266 Use VideoStreamer directly from ScreenEncoder
The Callbacks interface notifies new packets. But in addition, the
screen encoder will need to write headers on start.

We could add a function onStart(), but for simplicity, just remove the
interface, which brings no value, and call the streamer directly.

Refs 87972e2022
2023-02-26 22:41:06 +01:00
Romain Vimont
a29da81f1a Simplify error handling on socket creation
On any error, all previously opened sockets must be closed.

Handle these errors in a single catch-block. Currently, there are only 2
sockets, but this will simplify even more with more sockets.

Note: this commit is better displayed with --ignore-space-change (-b).
2023-02-26 22:41:06 +01:00
Romain Vimont
145ba93bd3 Reorder initialization
Initialize components in the pipeline order: demuxer first, decoder and
recorder second.
2023-02-26 22:41:06 +01:00
Romain Vimont
57356a3a09 Refactor recorder logic
Process the initial config packet (necessary to write the header)
separately.
2023-02-26 22:41:06 +01:00
Romain Vimont
4b1f27bdee Move last packet recording
Write the last packet at the end.
2023-02-26 22:41:06 +01:00
Romain Vimont
e45c499358 Add start() function for recorder
For consistency with the other components, do not start the internal
thread from an init() function.
2023-02-26 22:41:06 +01:00
Romain Vimont
3f99f59394 Open recording file from the recorder thread
The recorder opened the target file from the packet sink open()
callback, called by the demuxer. Only then the recorder thread was
started.

One golden rule for the recorder is to never block the demuxer for I/O,
because it would impact mirroring. This rule is respected on recording
packets, but not for the initial recorder opening.

Therefore, start the recorder thread from sc_recorder_init(), open the
file immediately from the recorder thread, then make it wait for the
stream to start (on packet sink open()).

Now that the recorder can report errors directly (rather than making the
demuxer call fail), it is possible to report file opening error even
before the packet sink is open.
2023-02-26 22:41:06 +01:00
Romain Vimont
c976698e40 Inline packet_sink impl in recorder
Remove useless wrappers.
2023-02-26 22:41:06 +01:00
Romain Vimont
3bf4712cef Initialize recorder fields from init()
The recorder has two initialization phases: one to initialize the
concrete recorder object, and one to open its packet_sink trait.

Initialize mutex and condvar as part of the object initialization.

If there were several packet_sink traits, the mutex and condvar would
still be initialized only once.
2023-02-26 22:41:06 +01:00
Romain Vimont
31ffb6d33d Report recorder errors
Stop scrcpy on recorder errors.

It was previously indirectly stopped by the demuxer, which failed to
push packets to a recorder in error. Report it directly instead:
 - it avoids to wait for the next demuxer call;
 - it will allow to open the target file from a separate thread and stop
   immediately on any I/O error.
2023-02-26 22:41:06 +01:00
Romain Vimont
9acd03b5c3 Move previous packet to a local variable
It is only used from run_recorder().
2023-02-26 22:41:06 +01:00
Romain Vimont
cdc4b47ea2 Move pts_origin to a local variable
It is only used from run_recorder().
2023-02-26 22:41:06 +01:00
Romain Vimont
f0fce4125e Change PTS origin type from uint64_t to int64_t
It is initialized from AVPacket.pts, which is an int64_t.
2023-02-26 22:41:06 +01:00
Romain Vimont
6630c6dbb4 Fix --encoder documentation
Mention that it depends on the codec provided by --codec (which is not
necessarily H264 anymore).
2023-02-26 22:41:06 +01:00
Romain Vimont
82c7752cc4 Do not print stacktraces when unnecessary
User-friendly error messages are printed on specific configuration
exceptions. In that case, do not print the stacktrace.

Also handle the user-friendly error message directly where the error
occurs, and print multiline messages in a single log call, to avoid
confusing interleaving.
2023-02-26 22:41:06 +01:00
Romain Vimont
d2dd3bf434 Fix --no-clipboard-autosync bash completion
Fix typo.
2023-02-26 22:41:06 +01:00
Romain Vimont
061dae3790 Split server stop() and join()
For consistency with the other components, call stop() and join()
separately.

This allows to stop all components, then join them all.
2023-02-26 22:41:06 +01:00
Romain Vimont
52eeb197b3 Print FFmpeg logs
FFmpeg logs are redirected to a specific SDL log category.

Initialize the log level for this category to print them as expected.
2023-02-26 22:41:06 +01:00
Romain Vimont
693570fef1 Move FFmpeg callback initialization
Configure FFmpeg log redirection on start from a log helper.
2023-02-26 22:41:06 +01:00
Romain Vimont
346145f4bd Silence lint warning about constant in API 29
MediaFormat.MIMETYPE_VIDEO_AV1 has been added in API 29, but it is not
a problem to inline the constant in older versions.
2023-02-26 22:41:06 +01:00
Romain Vimont
d6aff0e5d7 Remove manifest package name
As reported by gradle:

> Setting the namespace via a source AndroidManifest.xml's package
> attribute is deprecated.
>
> Please instead set the namespace (or testNamespace) in the module's
> build.gradle file, as described here:
> https://developer.android.com/studio/build/configure-app-module#set-namespace
2023-02-26 22:41:06 +01:00
Romain Vimont
79d127b5f1 Upgrade gradle build tools to 7.4.0
Plugin version 7.4.0.
Gradle version 7.5.

Refs <https://developer.android.com/studio/releases/gradle-plugin#updating-gradle>
2023-02-26 22:11:37 +01:00
9 changed files with 17 additions and 16 deletions

View File

@@ -7,7 +7,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:7.2.2'
classpath 'com.android.tools.build:gradle:7.4.0'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files

View File

@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-all.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

View File

@@ -1,6 +1,7 @@
apply plugin: 'com.android.application'
android {
namespace 'com.genymobile.scrcpy'
compileSdkVersion 33
defaultConfig {
applicationId "com.genymobile.scrcpy"

View File

@@ -1,2 +1,2 @@
<!-- not a real Android application, it is run by app_process manually -->
<manifest package="com.genymobile.scrcpy"/>
<manifest />

View File

@@ -9,6 +9,7 @@ import android.os.Process;
public final class FakeContext extends ContextWrapper {
public static final String PACKAGE_NAME = "com.android.shell";
public static final int ROOT_UID = 0; // Like android.os.Process.ROOT_UID, but before API 29
private static final FakeContext INSTANCE = new FakeContext();

View File

@@ -1,10 +1,12 @@
package com.genymobile.scrcpy;
import android.annotation.SuppressLint;
import android.media.MediaFormat;
public enum VideoCodec implements Codec {
H264(0x68_32_36_34, "h264", MediaFormat.MIMETYPE_VIDEO_AVC),
H265(0x68_32_36_35, "h265", MediaFormat.MIMETYPE_VIDEO_HEVC),
@SuppressLint("InlinedApi") // introduced in API 21
AV1(0x00_61_76_31, "av1", MediaFormat.MIMETYPE_VIDEO_AV1);
private final int id; // 4-byte ASCII representation of the name

View File

@@ -11,7 +11,6 @@ import android.os.Build;
import android.os.Bundle;
import android.os.IBinder;
import android.os.IInterface;
import android.os.Process;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
@@ -59,10 +58,10 @@ public class ActivityManager {
Object[] args;
if (getContentProviderExternalMethodNewVersion) {
// new version
args = new Object[]{name, Process.ROOT_UID, token, null};
args = new Object[]{name, FakeContext.ROOT_UID, token, null};
} else {
// old version
args = new Object[]{name, Process.ROOT_UID, token};
args = new Object[]{name, FakeContext.ROOT_UID, token};
}
// ContentProviderHolder providerHolder = getContentProviderExternal(...);
Object providerHolder = method.invoke(manager, args);

View File

@@ -7,7 +7,6 @@ import android.content.ClipData;
import android.content.IOnPrimaryClipChangedListener;
import android.os.Build;
import android.os.IInterface;
import android.os.Process;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
@@ -63,9 +62,9 @@ public class ClipboardManager {
return (ClipData) method.invoke(manager, FakeContext.PACKAGE_NAME);
}
if (alternativeMethod) {
return (ClipData) method.invoke(manager, FakeContext.PACKAGE_NAME, null, Process.ROOT_UID);
return (ClipData) method.invoke(manager, FakeContext.PACKAGE_NAME, null, FakeContext.ROOT_UID);
}
return (ClipData) method.invoke(manager, FakeContext.PACKAGE_NAME, Process.ROOT_UID);
return (ClipData) method.invoke(manager, FakeContext.PACKAGE_NAME, FakeContext.ROOT_UID);
}
private static void setPrimaryClip(Method method, boolean alternativeMethod, IInterface manager, ClipData clipData)
@@ -73,9 +72,9 @@ public class ClipboardManager {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
method.invoke(manager, clipData, FakeContext.PACKAGE_NAME);
} else if (alternativeMethod) {
method.invoke(manager, clipData, FakeContext.PACKAGE_NAME, null, Process.ROOT_UID);
method.invoke(manager, clipData, FakeContext.PACKAGE_NAME, null, FakeContext.ROOT_UID);
} else {
method.invoke(manager, clipData, FakeContext.PACKAGE_NAME, Process.ROOT_UID);
method.invoke(manager, clipData, FakeContext.PACKAGE_NAME, FakeContext.ROOT_UID);
}
}
@@ -110,9 +109,9 @@ public class ClipboardManager {
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
method.invoke(manager, listener, FakeContext.PACKAGE_NAME);
} else if (alternativeMethod) {
method.invoke(manager, listener, FakeContext.PACKAGE_NAME, null, Process.ROOT_UID);
method.invoke(manager, listener, FakeContext.PACKAGE_NAME, null, FakeContext.ROOT_UID);
} else {
method.invoke(manager, listener, FakeContext.PACKAGE_NAME, Process.ROOT_UID);
method.invoke(manager, listener, FakeContext.PACKAGE_NAME, FakeContext.ROOT_UID);
}
}

View File

@@ -9,7 +9,6 @@ import android.content.AttributionSource;
import android.os.Build;
import android.os.Bundle;
import android.os.IBinder;
import android.os.Process;
import java.io.Closeable;
import java.lang.reflect.InvocationTargetException;
@@ -139,7 +138,7 @@ public class ContentProvider implements Closeable {
public String getValue(String table, String key) throws SettingsException {
String method = getGetMethod(table);
Bundle arg = new Bundle();
arg.putInt(CALL_METHOD_USER_KEY, Process.ROOT_UID);
arg.putInt(CALL_METHOD_USER_KEY, FakeContext.ROOT_UID);
try {
Bundle bundle = call(method, key, arg);
if (bundle == null) {
@@ -155,7 +154,7 @@ public class ContentProvider implements Closeable {
public void putValue(String table, String key, String value) throws SettingsException {
String method = getPutMethod(table);
Bundle arg = new Bundle();
arg.putInt(CALL_METHOD_USER_KEY, Process.ROOT_UID);
arg.putInt(CALL_METHOD_USER_KEY, FakeContext.ROOT_UID);
arg.putString(NAME_VALUE_TABLE_VALUE, value);
try {
call(method, key, arg);