Commit Graph
100 Commits
Author SHA1 Message Date
Romain Vimont 7f0feea155 Introduce frame source trait
There was a frame sink trait, implemented by components able to receive
AVFrames, but each frame source had to manually send to frame sinks.

In order to mutualise sink management, add a frame sink trait.
2023-03-03 01:18:17 +01:00
Romain Vimont c101ec598f Use packet source trait in demuxer 2023-03-03 01:18:17 +01:00
Romain Vimont ff3ec5dc5a Introduce packet source trait
There was a packet sink trait, implemented by components able to
receive AVPackets, but each packet source had to manually send to packet
sinks.

In order to mutualise sink management, add a packet source trait.
2023-03-03 01:18:17 +01:00
Romain Vimont 3e06105f59 Extract sc_delay_buffer
A video buffer had 2 responsibilities:
 - handle the frame delaying mechanism (queuing packets and pushing them
   after the expected delay);
 - keep only the most recent frame (using a sc_frame_buffer).

In order to reuse only the frame delaying mechanism, extract it to a
separate component, sc_delay_buffer.
2023-03-03 01:18:17 +01:00
Romain Vimont 89c638282f Report video buffer downstream errors
Make the video buffer stop if its consumer could not receive a frame.
2023-03-03 01:18:17 +01:00
Romain Vimont 06f68a1570 Stop the video buffer on error
If an error occurs from the video buffer thread (typically an
out-of-memory error), then stop.
2023-03-03 01:18:17 +01:00
Romain Vimont fe7207da49 Fix possible race condition on video_buffer end
The video_buffer thread clears the queue once it is stopped, but new
frames might still be pushed asynchronously.

To avoid the problem, do not push any frame once the video_buffer is
stopped.
2023-03-03 01:18:17 +01:00
Romain Vimont 19c13651b3 Remove sc_queue
All uses have been replaced by VecDeque.
2023-03-03 01:18:17 +01:00
Romain Vimont a1f39b0227 Remove cbuf
All uses have been replaced by VecDeque.
2023-03-03 01:18:17 +01:00
Romain Vimont d9b2488880 Use VecDeque in aoa_hid
Replace cbuf by VecDeque in aoa_hid
2023-03-03 01:18:17 +01:00
Romain Vimont b5304dc9d2 Use VecDeque in file_pusher
Replace cbuf by VecDeque in file_pusher.

As a side-effect, the new implementation does not limit the queue to an
arbitrary value.
2023-03-03 01:18:17 +01:00
Romain Vimont b26af71bfb Use VecDeque in controller
Replace cbuf by VecDeque in controller.
2023-03-03 01:18:17 +01:00
Romain Vimont 7de4b8bea7 Use VecDeque in video_buffer
The packets queued for buffering were wrapped in a dynamically allocated
structure with a "next" field.

To avoid this additional layer of allocation and indirection, use a
VecDeque.
2023-03-03 01:18:17 +01:00
Romain Vimont 0ebbe4b268 Use VecDeque in recorder
The packets queued for recording were wrapped in a dynamically allocated
structure with a "next" field.

To avoid this additional layer of allocation and indirection, use a
VecDeque.
2023-03-03 01:18:17 +01:00
Romain Vimont bf8c6f9050 Introduce VecDeque
Introduce a double-ended queue implemented with a growable ring buffer.

Inspired from the Rust VecDeque type:
<https://doc.rust-lang.org/std/collections/struct.VecDeque.html>
2023-03-03 01:18:17 +01:00
Romain Vimont 8fd61c1d93 Add sc_allocarray() util
Add a function to allocate an array, which fails safely in the case
where the multiplication would overflow.
2023-03-03 01:18:17 +01:00
Romain Vimont e318aa1cb1 Use reallocarray() in sc_vector
This fails safely in case of overflow.
2023-03-03 01:18:17 +01:00
Romain Vimont f3998c280b Add compat for reallocarray()
This function fails safely in the case where the multiplication would
overflow.
2023-03-03 01:18:17 +01:00
Romain Vimont f6ae6865ed Call avcodec_receive_frame() in a loop
Since in scrcpy a video packet passed to avcodec_send_packet() is always
a complete video frame, it is sufficient to call avcodec_receive_frame()
exactly once.

In practice, it also works for audio packets: the decoder produces
exactly 1 frame for 1 input packet.

In theory, it is an implementation detail though, so
avcodec_receive_frame() should be called in a loop.
2023-03-03 01:18:17 +01:00
Romain Vimont f0f277ba71 Add --require-audio
By default, scrcpy mirrors only the video when audio capture fails on
the device. Add a flag to force scrcpy to fail if audio is enabled but
does not work.
2023-03-03 01:18:17 +01:00
Romain Vimont 35689a73ab Add compat support for FFmpeg < 5.1
The new chlayout API has been introduced in FFmpeg 5.1. Use the old
channel_layout API on older versions.
2023-03-03 01:18:17 +01:00
Romain VimontandSimon Chan 9896cf0f9a 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-03-03 01:18:17 +01:00
Romain Vimont 3c18cfb23b 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-03-03 01:18:17 +01:00
Romain Vimont e9fc35e9b1 Introduce bytebuf util
Add a ring-buffer for bytes. It will be useful for buffering audio.
2023-03-03 01:18:17 +01:00
Romain Vimont ffe3b87f3c Pass AVCodecContext to frame sinks
Frame consumers may need details about the frame format.
2023-03-03 01:18:17 +01:00
Romain Vimont 5d8f891153 Add an audio decoder 2023-03-03 01:18:17 +01:00
Romain Vimont c2b3985f80 Give a name to decoder instances
This will be useful in logs.
2023-03-03 01:18:17 +01:00
Romain Vimont d81804359e Rename decoder to video_decoder 2023-03-03 01:18:17 +01:00
Romain Vimont 96385b531c Log display sizes in display list
This is more convenient than just the display id alone.
2023-03-03 01:18:17 +01:00
Romain Vimont 954c774894 Add --list-device-displays 2023-03-03 01:18:17 +01:00
Romain Vimont 1bdf0f1594 Move log message helpers to LogUtils
This class will also contain other log helpers.
2023-03-03 01:18:17 +01:00
Romain Vimont d358139656 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-03-03 01:18:17 +01:00
Romain Vimont f816558e7a Add --list-encoders
Add an option to list the device encoders properly.
2023-03-03 01:18:17 +01:00
Romain Vimont c0fe77d0b4 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-03-03 01:18:17 +01:00
Romain Vimont 74e380c8e0 Add --audio-encoder
Similar to --video-encoder, but for audio.
2023-03-03 01:18:17 +01:00
Romain Vimont 67d9396db1 Extract unknown encoder error message
This will allow to reuse the same code for audio encoder selection.
2023-03-03 01:18:17 +01:00
Romain Vimont 9ae632ca2f Add --audio-codec-options
Similar to --video-codec-options, but for audio.
2023-03-03 01:18:17 +01:00
Romain Vimont 092b683402 Extract application of codec options
This will allow to reuse the same code for audio codec options.
2023-03-03 01:18:17 +01:00
Romain Vimont b1ccbbea55 Add support for AAC audio codec
Add option --audio-codec=aac.
2023-03-03 01:18:17 +01:00
Romain Vimont bcd51211f2 Add --audio-codec
Introduce the selection mechanism. Alternative codecs will be added
later.
2023-03-03 01:18:17 +01:00
Romain Vimont de2b17873a Add --audio-bit-rate
Add an option to configure the audio bit-rate.
2023-03-03 01:18:17 +01:00
Romain Vimont 38e317f3b7 Disable MethodLength checkstyle on createOptions()
This method will grow as needed to initialize options.
2023-03-03 01:18:17 +01:00
Romain Vimont 5ba37b0522 Rename --encoder to --video-encoder
This prepares the introduction of --audio-encoder.
2023-03-03 01:18:17 +01:00
Romain Vimont b6b178f6cf Rename --codec-options to --video-codec-options
This prepares the introduction of --audio-codec-options.
2023-03-03 01:18:17 +01:00
Romain Vimont 4d83cc3ec6 Rename --bit-rate to --video-bit-rate
This prepares the introduction of --audio-bit-rate.
2023-03-03 01:18:17 +01:00
Romain Vimont 26e7d495d4 Rename --codec to --video-codec
This prepares the introduction of --audio-codec.
2023-03-03 01:18:17 +01:00
Romain Vimont 0dfa43a6a1 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-03-03 01:18:17 +01:00
Romain Vimont 484c3dedc0 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-03-03 01:18:17 +01:00
Romain Vimont dfb3347633 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 <https://android.googlesource.com/platform/frameworks/base/+/4feeee88911503cc365b223a712437abcd91c94f%5E%21/>
2023-03-03 01:18:17 +01:00
Romain Vimont 9a89e21527 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-03-03 01:18:17 +01:00
Romain Vimont fd4fffa436 Add record audio support
Make the recorder accept two input sources (video and audio), and mux
them into a single file.
2023-03-03 01:18:17 +01:00
Romain Vimont c54a087e44 Rename video-specific variables in recorder
This paves the way to add audio-specific variables.
2023-03-03 01:18:17 +01:00
Romain Vimont f3da281ce8 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-03-03 01:18:17 +01:00
Romain Vimont 8fc3e20cd7 Add an audio demuxer
Add a demuxer which will read the stream from the audio socket.
2023-03-03 01:18:17 +01:00
Romain Vimont 0026ea4cd9 Force --no-audio if no display and no recording
The client does not use the audio stream if there is no display and no
recording (i.e. only V4L2), so disable audio so that the device does not
attempt to capture it.
2023-03-03 01:18:17 +01:00
Romain Vimont fa5e40c6b8 Give a name to demuxer instances
This will be useful in logs.
2023-03-03 01:18:17 +01:00
Romain Vimont 42b12a0ee8 Rename demuxer to video_demuxer
There will be another demuxer instance for audio.
2023-03-03 01:18:17 +01:00
Romain Vimont e04add64d8 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-03-03 01:18:17 +01:00
Romain Vimont 2ee2660ef7 Use a streamer to send the audio stream
Send each encoded audio packet using a streamer.
2023-03-03 01:18:17 +01:00
Romain Vimont 2be2376cf7 Encode recorded audio on the device
For now, the encoded packets are just logged into the console.
2023-03-03 01:18:17 +01:00
Romain Vimont 72aa2ebd03 Use FakeContext for Application instance
This will expose the correct package name and UID to the application
context.
2023-03-03 01:18:17 +01:00
Romain Vimont 792d2f2c66 Use shell package name for workarounds
For consistency.
2023-03-03 01:18:17 +01:00
Romain Vimont bebff7989f 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-03-03 01:18:17 +01:00
Romain Vimont 4f09051835 Use PACKAGE_NAME from FakeContext
Remove duplicated constant.
2023-03-03 01:18:17 +01:00
Romain VimontandSimon Chan 740a57ec4f Use AttributionSource from FakeContext
FakeContext already provides an AttributeSource instance.

Co-authored-by: Simon Chan <1330321+yume-chan@users.noreply.github.com>
2023-03-03 01:18:17 +01:00
Romain Vimont 3c3e743726 Improve error message for unknown encoder
The provided encoder name depends on the selected codec. Improve the
error message and the suggestions.
2023-03-03 01:18:17 +01:00
Romain Vimont c0b26a90cb Rename "codec" variable to "mediaCodec"
This will allow to use "codec" for the Codec type.
2023-03-03 01:18:17 +01:00
Romain Vimont 050fe55b6f Make streamer independent of codec type
Rename VideoStreamer to Streamer, and extract a Codec interface which
will also support audio codecs.
2023-03-03 01:18:17 +01:00
Romain Vimont 4182b29a91 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-03-03 01:18:17 +01:00
Romain Vimont 6c29c2a3c7 Move screen encoder initialization
This prepares further refactors.
2023-03-03 01:18:17 +01:00
Romain Vimont 3b4727761e Write streamer header from ScreenEncoder
The screen encoder is responsible to write data to the video streamer.
2023-03-03 01:18:17 +01:00
Romain Vimont 0c3ae37d86 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-03-03 01:18:17 +01:00
Romain Vimont fe0dd73835 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-03-03 01:18:17 +01:00
Romain Vimont 51091f8465 Reorder initialization
Initialize components in the pipeline order: demuxer first, decoder and
recorder second.
2023-03-03 01:18:17 +01:00
Romain Vimont 93cc1fcff0 Refactor recorder logic
Process the initial config packet (necessary to write the header)
separately.
2023-03-03 01:18:17 +01:00
Romain Vimont 0f818e5d87 Move last packet recording
Write the last packet at the end.
2023-03-03 01:18:17 +01:00
Romain Vimont 113eb864da Add start() function for recorder
For consistency with the other components, do not start the internal
thread from an init() function.
2023-03-03 01:18:17 +01:00
Romain Vimont 72811e7b1f 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-03-03 01:18:17 +01:00
Romain Vimont 51365ca8d4 Inline packet_sink impl in recorder
Remove useless wrappers.
2023-03-03 01:18:17 +01:00
Romain Vimont db7f27deb1 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-03-03 01:18:17 +01:00
Romain Vimont 54e5cf1e24 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-03-03 01:18:17 +01:00
Romain Vimont 5d67a9e7f3 Move previous packet to a local variable
It is only used from run_recorder().
2023-03-03 01:18:17 +01:00
Romain Vimont 97890db385 Move pts_origin to a local variable
It is only used from run_recorder().
2023-03-03 01:18:17 +01:00
Romain Vimont 1d12fc2409 Change PTS origin type from uint64_t to int64_t
It is initialized from AVPacket.pts, which is an int64_t.
2023-03-03 01:18:17 +01:00
Romain Vimont f2b23fc977 Fix --encoder documentation
Mention that it depends on the codec provided by --codec (which is not
necessarily H264 anymore).
2023-03-03 01:18:17 +01:00
Romain Vimont 1b88ae4db0 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-03-03 01:18:17 +01:00
Romain Vimont 67b22517f4 Fix --no-clipboard-autosync bash completion
Fix typo.
2023-03-03 01:18:17 +01:00
Romain Vimont 0e44b3158b 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-03-03 01:18:17 +01:00
Romain Vimont 6bf861ec2c 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-03-03 01:18:17 +01:00
Romain Vimont 251ea6dfff Move FFmpeg callback initialization
Configure FFmpeg log redirection on start from a log helper.
2023-03-03 01:18:17 +01:00
Romain Vimont 976978abe6 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-03-03 01:18:17 +01:00
Romain Vimont fd463a0220 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-03-03 01:18:17 +01:00
Romain Vimont 2731c60896 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-03-03 01:18:17 +01:00
Romain Vimont 389dd77b50 Fix MIN/MAX macros
Expressions like "x < MAX(y, z)" were broken.
2023-03-03 01:18:10 +01:00
Romain Vimont 3c3c07db05 Initialize server->serial in all cases
Running scrcpy --tcpip on a device already connected via TCP/IP did not
initialize server->serial.

As a consequence, in debug mode, an assertion failed:

    scrcpy: ../app/src/server.c:770: run_server: Assertion
    `server->serial' failed.

In release mode, scrcpy failed with this error:

    adb: -s requires an argument
2023-02-28 12:34:34 +01:00
Romain Vimont 6b422e21bf Fix error message on icon loading failure 2023-02-27 20:51:54 +01:00
Romain Vimont 8e8b039a63 Do not use avformat network
Scrcpy does not use FFmpeg network features. Initialize network locally
instead (useful only for Windows).

The include block has been moved to fix the following warning:

    Please include winsock2.h before windows.h
2023-02-27 20:51:54 +01:00
Romain Vimont 0702be86d8 Accept Windows Sockets from version 1.1
Version 2.2 is probably not necessary (1.1 is the version required by
FFmpeg when network is enabled).

Refs <https://github.com/FFmpeg/FFmpeg/blob/891ed24f77da99c6d41bb7c116ba5925e3206ce2/libavformat/network.c#L63>
Refs <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-wsastartup>
2023-02-27 20:51:54 +01:00
Romain Vimont 0cea7fb24c Fix WSAStartup() error check on Windows 2023-02-27 20:51:35 +01:00
Romain Vimont 3d10fbd9b4 Fix --bit-rate option in bash completion script
The option is --bit-rate, not --bitrate.
2023-02-21 19:50:01 +01:00