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

52 lines
1.4 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
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
#include "command.h"
Replace SDL_net by custom implementation SDL_net is not very suitable for scrcpy. For example, SDLNet_TCP_Accept() is non-blocking, so we have to wrap it by calling many SDL_Net-specific functions to make it blocking. But above all, SDLNet_TCP_Open() is a server socket only when no IP is provided; otherwise, it's a client socket. Therefore, it is not possible to create a server socket bound to localhost, so it accepts connections from anywhere. This is a problem for scrcpy, because on start, the application listens for nearly 1 second until it accepts the first connection, supposedly from the device. If someone on the local network manages to connect to the server socket first, then they can stream arbitrary H.264 video. This may be troublesome, for example during a public presentation ;-) Provide our own simplified API (net.h) instead, implemented for the different platforms.
2018-02-16 05:59:21 +08:00
#include "net.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 {
Store serial in server instance The serial is needed for many server actions, but this is an implementation detail, so the caller should not have to provide it on every call. Instead, store the serial in the server instance on server_start(). This paves the way to implement the "adb forward" fallback properly.
2018-03-12 17:19:12 +08:00
const 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;
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
Replace SDL_net by custom implementation SDL_net is not very suitable for scrcpy. For example, SDLNet_TCP_Accept() is non-blocking, so we have to wrap it by calling many SDL_Net-specific functions to make it blocking. But above all, SDLNet_TCP_Open() is a server socket only when no IP is provided; otherwise, it's a client socket. Therefore, it is not possible to create a server socket bound to localhost, so it accepts connections from anywhere. This is a problem for scrcpy, because on start, the application listens for nearly 1 second until it accepts the first connection, supposedly from the device. If someone on the local network manages to connect to the server socket first, then they can stream arbitrary H.264 video. This may be troublesome, for example during a public presentation ;-) Provide our own simplified API (net.h) instead, implemented for the different platforms.
2018-02-16 05:59:21 +08:00
socket_t device_socket;
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
Uint16 local_port;
SDL_bool tunnel_enabled;
SDL_bool tunnel_forward; // use "adb forward" instead of "adb reverse"
Send frame meta only if recording is enabled The client needs the PTS for each frame only if recording is enabled. Otherwise, the PTS are not necessary, and the protocol is more straighforward.
2018-11-11 21:41:54 +08:00
SDL_bool send_frame_meta; // request frame PTS to be able to record properly
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
Clean up the server from temporary folder The server is copied to /data/local/tmp/scrcpy-server.jar and executed on the device. As soon as we are connected, we can unlink (rm) it from /data/local/tmp, to keep the device clean.
2018-02-28 22:13:56 +08:00
#define SERVER_INITIALIZER { \
Store serial in server instance The serial is needed for many server actions, but this is an implementation detail, so the caller should not have to provide it on every call. Instead, store the serial in the server instance on server_start(). This paves the way to implement the "adb forward" fallback properly.
2018-03-12 17:19:12 +08:00
.serial = NULL, \
Clean up the server from temporary folder The server is copied to /data/local/tmp/scrcpy-server.jar and executed on the device. As soon as we are connected, we can unlink (rm) it from /data/local/tmp, to keep the device clean.
2018-02-28 22:13:56 +08:00
.process = PROCESS_NONE, \
.server_socket = INVALID_SOCKET, \
.device_socket = INVALID_SOCKET, \
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
.local_port = 0, \
.tunnel_enabled = SDL_FALSE, \
.tunnel_forward = SDL_FALSE, \
Send frame meta only if recording is enabled The client needs the PTS for each frame only if recording is enabled. Otherwise, the PTS are not necessary, and the protocol is more straighforward.
2018-11-11 21:41:54 +08:00
.send_frame_meta = SDL_FALSE, \
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
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_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
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
SDL_bool
server_start(struct server *server, const char *serial,
Send frame meta only if recording is enabled The client needs the PTS for each frame only if recording is enabled. Otherwise, the PTS are not necessary, and the protocol is more straighforward.
2018-11-11 21:41:54 +08:00
Uint16 local_port, Uint16 max_size, Uint32 bit_rate,
const char *crop, SDL_bool send_frame_meta);
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
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
socket_t
server_connect_to(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
// 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