Android/scrcpy
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity
scrcpy/app/src/server.h

77 lines
1.8 KiB
C
Raw Normal View History

Add missing include guards In practice, these headers are included only once, but it's a good practice to always use include guards.
2018-02-08 20:47:31 +08:00
#ifndef SERVER_H
#define SERVER_H
Define feature test macros in common.h This enables necessary functions once for all. As a consequence, define common.h before any other header.
2021-01-09 02:24:51 +08:00
#include "common.h"
Replace SDL_Atomic by stdatomic from C11 There is no reason to use SDL atomics.
2020-04-03 01:16:33 +08:00
#include <stdatomic.h>
Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t
2019-03-03 06:52:22 +08:00
#include <stdbool.h>
#include <stdint.h>
Split command into process and adb The process API provides the system-specific implementation, the adb API uses it to expose adb commands.
2021-01-03 21:55:15 +08:00
#include "adb.h"
Provide device info directly on server connection This avoids to retrieve them in a separate step.
2021-05-09 22:52:22 +08:00
#include "coords.h"
Make scrcpy.h independant of other headers The header scrcpy.h is intended to be the "public" API. It should not depend on other internal headers. Therefore, declare all required structs in this header and adapt internal code.
2020-06-20 04:04:06 +08:00
#include "scrcpy.h"
Add cli option to set the verbosity level The verbosity was set either to info (in release mode) or debug (in debug mode). Add a command-line argument to change it, so that users can enable debug logs using the release: scrcpy -Vdebug
2020-05-25 03:51:40 +08:00
#include "util/log.h"
Move utilities to util/
2019-11-24 18:53:00 +08:00
#include "util/net.h"
Wrap SDL thread functions into scrcpy-specific API The goal is to expose a consistent API for system tools, and paves the way to make the "core" independant of SDL in the future.
2021-02-01 01:24:35 +08:00
#include "util/thread.h"
Extract server-related functions To lighten screen.c, move start_server() and stop_server() to a separate file.
2018-01-22 18:22:31 +08:00
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
struct server {
Make owned serial a pointer-to-non-const The server owns the serial, so it needs to free it. Therefore, it should not be a pointer-to-const.
2019-03-03 07:01:16 +08:00
char *serial;
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
process_t process;
Wrap SDL thread functions into scrcpy-specific API The goal is to expose a consistent API for system tools, and paves the way to make the "core" independant of SDL in the future.
2021-02-01 01:24:35 +08:00
sc_thread wait_server_thread;
Replace SDL_Atomic by stdatomic from C11 There is no reason to use SDL atomics.
2020-04-03 01:16:33 +08:00
atomic_flag server_socket_closed;
Kill the server only after a small delay Let the server terminate properly once all the sockets are closed. If it does not terminate (this can happen if the device is asleep), then kill it. Note: since the server process termination is detected by a flag set after waitpid() returns, there is a small chance that the process terminates (and the PID assigned to a new process) before the flag is set but before the kill() call. This race condition already existed before this commit. Fixes #1992 <https://github.com/Genymobile/scrcpy/issues/1992>
2021-01-01 19:41:25 +08:00
Wrap SDL thread functions into scrcpy-specific API The goal is to expose a consistent API for system tools, and paves the way to make the "core" independant of SDL in the future.
2021-02-01 01:24:35 +08:00
sc_mutex mutex;
sc_cond process_terminated_cond;
Kill the server only after a small delay Let the server terminate properly once all the sockets are closed. If it does not terminate (this can happen if the device is asleep), then kill it. Note: since the server process termination is detected by a flag set after waitpid() returns, there is a small chance that the process terminates (and the PID assigned to a new process) before the flag is set but before the kill() call. This race condition already existed before this commit. Fixes #1992 <https://github.com/Genymobile/scrcpy/issues/1992>
2021-01-01 19:41:25 +08:00
bool process_terminated;
Make it work over tcpip "adb reverse" currently does not work over tcpip (i.e. on a device connected by "adb connect"): <https://issuetracker.google.com/issues/37066218> To work around the problem, if the call to "adb reverse" fails, then fallback to "adb forward", and reverse the client/server roles. Keep the "adb reverse" mode as the default because it does not involve connection retries: when using "adb forward", the client must try to connect successively until the server listens. Due to the tunnel, every connect() will succeed, so the client must attempt to read() to detect a connection failure. For this purpose, when using the "adb forward" mode, the server initially writes a dummy byte, read by the client. Fixes <https://github.com/Genymobile/scrcpy/issues/5>.
2018-03-12 15:35:51 +08:00
socket_t server_socket; // only used if !tunnel_forward
Use two sockets for video and control The socket used the device-to-computer direction to stream the video and the computer-to-device direction to send control events. Some features, like copy-paste from device to computer, require to send non-video data from the device to the computer. To make them possible, use two sockets: - one for streaming the video from the device to the client; - one for control/events in both directions.
2019-05-29 03:03:54 +08:00
socket_t video_socket;
socket_t control_socket;
Accept port range Accept a range of ports to listen to, so that it does not fail if another instance of scrcpy is currently starting. The range can be passed via the command line: scrcpy -p 27183:27186 scrcpy -p 27183 # implicitly 27183:27183, as before The default is 27183:27199. Closes #951 <https://github.com/Genymobile/scrcpy/issues/951>
2019-12-10 04:16:09 +08:00
uint16_t local_port; // selected from port_range
Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t
2019-03-03 06:52:22 +08:00
bool tunnel_enabled;
bool tunnel_forward; // use "adb forward" instead of "adb reverse"
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
};
Move server-related functions to server.c In addition to the functions to start/stop the server, move the functions to push the jar and enable/disable the "adb reverse" tunnel.
2018-01-23 22:46:34 +08:00
Group server params in a struct Starting the server requires more and more parameters. For clarity, group them in a struct.
2019-06-05 05:59:55 +08:00
struct server_params {
Pass serial within struct server_params This was the only option passed separately.
2021-05-17 15:41:22 +08:00
const char *serial;
Add cli option to set the verbosity level The verbosity was set either to info (in release mode) or debug (in debug mode). Add a command-line argument to change it, so that users can enable debug logs using the release: scrcpy -Vdebug
2020-05-25 03:51:40 +08:00
enum sc_log_level log_level;
Group server params in a struct Starting the server requires more and more parameters. For clarity, group them in a struct.
2019-06-05 05:59:55 +08:00
const char *crop;
Add --codec-options Add a command-line parameter to pass custom options to the device encoder (as a comma-separated list of "key[:type]=value"). The list of possible codec options is available in the Android documentation: <https://d.android.com/reference/android/media/MediaFormat> PR #1325 <https://github.com/Genymobile/scrcpy/pull/1325> Refs #1226 <https://github.com/Genymobile/scrcpy/pull/1226> Co-authored-by: Romain Vimont <rom@rom1v.com>
2020-04-26 20:22:08 +08:00
const char *codec_options;
Adding new option --encoder Some devices have more than one encoder, and some encoders may cause issues or crash. With this option we can specify which encoder we want the device to use. PR #1827 <https://github.com/Genymobile/scrcpy/pull/1827> Fixes #1810 <https://github.com/Genymobile/scrcpy/issues/1810> Signed-off-by: Romain Vimont <rom@rom1v.com>
2020-10-12 17:23:06 +08:00
const char *encoder_name;
Make scrcpy.h independant of other headers The header scrcpy.h is intended to be the "public" API. It should not depend on other internal headers. Therefore, declare all required structs in this header and adapt internal code.
2020-06-20 04:04:06 +08:00
struct sc_port_range port_range;
Group server params in a struct Starting the server requires more and more parameters. For clarity, group them in a struct.
2019-06-05 05:59:55 +08:00
uint16_t max_size;
uint32_t bit_rate;
Add option --max-fps Add an option to limit the capture frame rate. It only works for devices with Android >= 10. Fixes <https://github.com/Genymobile/scrcpy/issues/488>
2019-11-18 05:07:19 +08:00
uint16_t max_fps;
Add option to lock video orientation PR #1151 <https://github.com/Genymobile/scrcpy/pull/1151> Signed-off-by: Romain Vimont <rom@rom1v.com>
2020-02-16 19:30:36 +08:00
int8_t lock_video_orientation;
Disable server controller if --no-control If --no-control is disabled, there is no need for a controller. It also avoids to power on the device on start if control is disabled.
2019-06-05 03:31:46 +08:00
bool control;
Increase display id range Some devices use big display id values. Refs #2009 <https://github.com/Genymobile/scrcpy/issues/2009>
2021-01-04 15:16:32 +08:00
uint32_t display_id;
Handle "show touches" on the device-side Now that the server can access the Android settings and clean up properly, handle the "show touches" option from the server. The initial state is now correctly restored, even on device disconnection.
2020-05-02 05:49:37 +08:00
bool show_touches;
Add an option to keep the device awake Add an option to prevent the device to sleep: scrcpy --stay-awake scrcpy -w The initial state is restored on exit. Fixes #631 <https://github.com/Genymobile/scrcpy/issues/631>
2020-05-02 07:54:48 +08:00
bool stay_awake;
Add --force-adb-forward Add a command-line option to force "adb forward", without attempting "adb reverse" first. This is especially useful for using SSH tunnels without enabling remote port forwarding.
2020-05-25 05:27:34 +08:00
bool force_adb_forward;
Support power off on close PR #824 <https://github.com/Genymobile/scrcpy/pull/824> Signed-off-by: Yu-Chen Lin <npes87184@gmail.com> Signed-off-by: Romain Vimont <rom@rom1v.com>
2021-02-21 08:42:04 +08:00
bool power_off_on_close;
Group server params in a struct Starting the server requires more and more parameters. For clarity, group them in a struct.
2019-06-05 05:59:55 +08:00
};
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
// init default values
Initialize server struct dynamically This will allow to add mutex/cond fields.
2021-01-01 23:34:47 +08:00
bool
Update code style Limit source code to 80 chars, and declare functions return type and modifiers on a separate line. This allows to avoid very long lines, and all function names are aligned. (We do this on VLC, and I like it.)
2019-03-03 03:09:56 +08:00
server_init(struct server *server);
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
// push, enable tunnel et start the server
Replace SDL types by C99 standard types Scrcpy is a C11 project. Use the C99 standard types instead of the SDL-specific types: SDL_bool -> bool SintXX -> intXX_t UintXX -> uintXX_t
2019-03-03 06:52:22 +08:00
bool
Pass serial within struct server_params This was the only option passed separately.
2021-05-17 15:41:22 +08:00
server_start(struct server *server, const struct server_params *params);
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
Provide device info directly on server connection This avoids to retrieve them in a separate step.
2021-05-09 22:52:22 +08:00
#define DEVICE_NAME_FIELD_LENGTH 64
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
// block until the communication with the server is established
Provide device info directly on server connection This avoids to retrieve them in a separate step.
2021-05-09 22:52:22 +08:00
// device_name must point to a buffer of at least DEVICE_NAME_FIELD_LENGTH bytes
Make server_connect_to() return a bool The resulting socket is accessible from the server instance, there is no need to return it. This paves the way to use several sockets in parallel.
2019-05-28 19:41:19 +08:00
bool
Provide device info directly on server connection This avoids to retrieve them in a separate step.
2021-05-09 22:52:22 +08:00
server_connect_to(struct server *server, char *device_name, struct size *size);
Move server-related code to server.c The file server.c already existed, but exposed a low-level API. Make it higher-level, so that scrcpy.c does not handle server details directly.
2018-02-08 22:16:27 +08:00
// disconnect and kill the server process
Update code style Limit source code to 80 chars, and declare functions return type and modifiers on a separate line. This allows to avoid very long lines, and all function names are aligned. (We do this on VLC, and I like it.)
2019-03-03 03:09:56 +08:00
void
server_stop(struct server *server);
Add missing include guards In practice, these headers are included only once, but it's a good practice to always use include guards.
2018-02-08 20:47:31 +08:00
Do not release TCP sockets while still in use SDLNet_TCP_Close() not only closes, but also release the resources. Therefore, we must not close the socket if another thread attempts to read it. For that purpose, move socket closing from server_stop() to server_destroy().
2018-02-09 19:59:36 +08:00
// close and release sockets
Update code style Limit source code to 80 chars, and declare functions return type and modifiers on a separate line. This allows to avoid very long lines, and all function names are aligned. (We do this on VLC, and I like it.)
2019-03-03 03:09:56 +08:00
void
server_destroy(struct server *server);
Do not release TCP sockets while still in use SDLNet_TCP_Close() not only closes, but also release the resources. Therefore, we must not close the socket if another thread attempts to read it. For that purpose, move socket closing from server_stop() to server_destroy().
2018-02-09 19:59:36 +08:00
Add missing include guards In practice, these headers are included only once, but it's a good practice to always use include guards.
2018-02-08 20:47:31 +08:00
#endif
Reference in a new issue Copy permalink