Android/scrcpy
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity

Update DEVELOP after recent refactorings

Browse source
This commit is contained in:
Romain Vimont 2019-05-30 22:04:20 +02:00
parent c13a24389c
commit 0125af1e46
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
DEVELOP.md
View file

@ -76,6 +76,9 @@ The server uses 2 threads:
- the **main** thread, encoding and streaming the video to the client; - the **main** thread, encoding and streaming the video to the client;
- the **controller** thread, listening for _control events_ (typically, - the **controller** thread, listening for _control events_ (typically,
keyboard and mouse events) from the client. keyboard and mouse events) from the client.
- the **receiver** thread (managed by the controller), sending _device events_
to the clients (currently, it is only used to send the device clipboard
content).
Since the video encoding is typically hardware, there would be no benefit in Since the video encoding is typically hardware, there would be no benefit in
encoding and streaming in two different threads. encoding and streaming in two different threads.
@ -114,12 +117,12 @@ https://github.com/Genymobile/scrcpy/blob/v1.8/server/src/main/java/com/genymobi
### Input events injection ### Input events injection
_Control events_ are received from the client by the [`EventController`] (run in _Control events_ are received from the client by the [`EventController`] (run in
a separate thread). There are 5 types of input events: a separate thread). There are several types of input events:
- keycode (cf [`KeyEvent`]), - keycode (cf [`KeyEvent`]),
- text (special characters may not be handled by keycodes directly), - text (special characters may not be handled by keycodes directly),
- mouse motion/click, - mouse motion/click,
- mouse scroll, - mouse scroll,
- custom command (e.g. to switch the screen on). - other commands (e.g. to switch the screen on or to copy the clipboard).
All of them may need to inject input events to the system. To do so, they use All of them may need to inject input events to the system. To do so, they use
the _hidden_ method [`InputManager.injectInputEvent`] (exposed by our the _hidden_ method [`InputManager.injectInputEvent`] (exposed by our
@ -146,8 +149,8 @@ The video stream is decoded by [libav] (FFmpeg).
### Initialization ### Initialization
On startup, in addition to _libav_ and _SDL_ initialization, the client must On startup, in addition to _libav_ and _SDL_ initialization, the client must
push and start the server on the device, and open a socket so that they may push and start the server on the device, and open two sockets (one for the video
communicate. stream, one for control) so that they may communicate.
Note that the client-server roles are expressed at the application level: Note that the client-server roles are expressed at the application level:
@ -180,12 +183,14 @@ the connection from the server (see commit [90a46b4]).
### Threading ### Threading
The client uses 3 threads: The client uses 4 threads:
- the **main** thread, executing the SDL event loop, - the **main** thread, executing the SDL event loop,
- the **stream** thread, receiving the video and used for decoding and - the **stream** thread, receiving the video and used for decoding and
recording, recording,
- the **controller** thread, sending _control events_ to the server. - the **controller** thread, sending _control events_ to the server.
- the **receiver** thread (managed by the controller), receiving _device
events_ from the client.
In addition, another thread can be started if necessary to handle APK In addition, another thread can be started if necessary to handle APK
installation or file push requests (via drag&drop on the main window). installation or file push requests (via drag&drop on the main window).
@ -235,9 +240,8 @@ in a separate thread, to avoid I/O on the main thread.
On SDL event, received on the main thread, the [input manager][inputmanager] On SDL event, received on the main thread, the [input manager][inputmanager]
creates appropriate [_control events_][controlevent]. It is responsible to creates appropriate [_control events_][controlevent]. It is responsible to
convert SDL events to Android events (using [convert]). It pushes the _control convert SDL events to Android events (using [convert]). It pushes the _control
events_ to a blocking queue hold by the controller. On its own thread, the events_ to a queue hold by the controller. On its own thread, the controller
controller takes events from the queue, that it serializes and sends to the takes events from the queue, that it serializes and sends to the client.
client.
[controller]: https://github.com/Genymobile/scrcpy/blob/v1.8/app/src/controller.h [controller]: https://github.com/Genymobile/scrcpy/blob/v1.8/app/src/controller.h
[controlevent]: https://github.com/Genymobile/scrcpy/blob/v1.8/app/src/control_event.h [controlevent]: https://github.com/Genymobile/scrcpy/blob/v1.8/app/src/control_event.h