#Scrcpy 源码分析-程序员宅基地

技术标签: Scrcpy  java  网络  开发语言  

        写在前面:本文的主旨为分析Scrcpy大致原理,因此对于细节部分就不予深究,本文的Scrcpy版本基于1.22。

一、什么是Scrcpy

        Scrcpy(screen copy)是免费开源的投屏软件,即可以将手机画面投至电脑,并可直接借助鼠标在投屏窗口中进行交互和录制。


二、软件架构

Scrcpy的架构为C/S架构,其中Client为PC端运行的软件,Server为安卓手机运行的软件。Client和Server之间借助ADB进行通信,通信原理如下图所示:

        LocalSocketLocalSocket是基于UNIX-domain Socket的,UNIX-domain Socket是在Socket的基础上衍生出来的一种IPC通信机制,因此LocalSocket解决的是同一台主机上不同进程间互相通信的问题。其相对于网络通信使用的socket不需要经过网络协议栈,不需要打包拆包、计算校验,自然的执行效率也高。与大名鼎鼎的binder机制作用一样,都在Android系统中作为IPC通信手段被广泛使用。


三、架构解析

        可能有的观众看到上图的通信方式后会感觉很奇怪,为什么Scrcpy要绕这么一大圈来建立通信,而不是直接让Client通过Socket连接Server呢?其实原因很简单,就是权限的问题,因为普通的APP想要到读取屏幕内容和自动控制必须获取无障碍服务或者Root权限,而我们在使用Scrcpy的时候这两个都没用到,那它是怎么做到的呢?
        聪明的读者应该注意到了,ADB就是获取这个权限的关键,读者可以自行去了解ADB的相关知识。简言之,ADB的权限仅次于Root,因此我们需要使用ADB来启动Server端程序,让Server端程序能够不断的获取屏幕内容传给Client,并执行由Client传来的控制指令。


四、ADB forawrd

        这里面其实还有一个难点,即Client如何与ADB连接?
        adb forward的功能是建立一个转发,例如以下命令的意思是,ADB监听本地tcp的1111端口,并将收到的数据转发给到手机中的ADBD程序,然后ADBD将数据转发至手机tcp的2222端口。

adb forward tcp:1111 tcp:2222

        但这样是不能工作的,如上图所述,ADBD和Server之间的通信需要是LocalSocket而不是TCP。当然,万能的ADB也是可以做到的,只需要输入如下命令即可让ADBD以LocalSocket的方式转发数据。

adb forward tcp:1111 localabstract:scrcpy

五、Server端源码分析

        Server端是一个Java程序,由dalvik虚拟机执行,主要负责不断获取屏幕内容传输给Client,并执行由Client下发的控制指令,其Main函数位于Server.java中。接下来让我们从Main函数开始,逐步分析Server端的原理。

1、启动参数

        进入Main函数后,首先是参数解析,在createOptions函数中,我们可以看到Server程序所有的参数,这些参数的含义我们放到Client节分析。

...
322  Options options = createOptions(args);
...

2、建立LocalSocket,等待连接

        从Main函数中走到scrcpy函数,在64行,获取设备的信息,如高度,宽度和设备名称等。

...
final Device device = new Device(options);
...

        在73行,建立LocalSocket,并等待连接。

try (DesktopConnection connection = DesktopConnection.open(tunnelForward, control, sendDummyByte)) {
    
	...
}

        让我们深入DesktopConnection.open方法,在53行可以看到新建了LocalServerSocket,并在55行和62行等待连接。从变量名称就可以推断出,第一次建立的连接是用于传输屏幕数据的,第二次建立的连接是用于传输控制信息的。(有的读者可能会问,外面不是还包了个if-else吗,为什么不讲else?因为else中是Server主动连接,而不是接受连接,因此这里不进行深入。)

LocalServerSocket localServerSocket = new LocalServerSocket(SOCKET_NAME);
try {
    
    videoSocket = localServerSocket.accept();
    if (sendDummyByte) {
    
        // send one byte so the client may read() to detect a connection error
        videoSocket.getOutputStream().write(0);
    }
    if (control) {
    
        try {
    
            controlSocket = localServerSocket.accept();
        } catch (IOException | RuntimeException e) {
    
            videoSocket.close();
            throw e;
        }
    }
} finally {
    
    localServerSocket.close();
}

3、向Client发送设备信息

        继续回到Server.java的73行,建立完成LocalSocket后,即向client发送设备名称,高度,宽度信息。

if (options.getSendDeviceMeta()) {
    
    Size videoSize = device.getScreenInfo().getVideoSize();
    connection.sendDeviceMeta(Device.getDeviceName(), videoSize.getWidth(), videoSize.getHeight());
}

        深入到sendDeviceMeta方法,这里可以看到Server是以何种格式将数据发往Client的。

public void sendDeviceMeta(String deviceName, int width, int height) throws IOException {
    
    byte[] buffer = new byte[DEVICE_NAME_FIELD_LENGTH + 4];

    byte[] deviceNameBytes = deviceName.getBytes(StandardCharsets.UTF_8);
    int len = StringUtils.getUtf8TruncationIndex(deviceNameBytes, DEVICE_NAME_FIELD_LENGTH - 1);
    System.arraycopy(deviceNameBytes, 0, buffer, 0, len);
    // byte[] are always 0-initialized in java, no need to set '\0' explicitly

    buffer[DEVICE_NAME_FIELD_LENGTH] = (byte) (width >> 8);
    buffer[DEVICE_NAME_FIELD_LENGTH + 1] = (byte) width;
    buffer[DEVICE_NAME_FIELD_LENGTH + 2] = (byte) (height >> 8);
    buffer[DEVICE_NAME_FIELD_LENGTH + 3] = (byte) height;
    IO.writeFully(videoFd, buffer, 0, buffer.length);
}

4、启动控制线程

        回到Server.java的84行,建立一个控制器对象并启动。

final Controller controller = new Controller(device, connection, options.getClipboardAutosync());

// asynchronous
controllerThread = startController(controller);
deviceMessageSenderThread = startDeviceMessageSender(controller.getSender());

device.setClipboardListener(new Device.ClipboardListener() {
    
    @Override
    public void onClipboardTextChanged(String text) {
    
        controller.getSender().pushClipboardText(text);
    }
});

        深入至startController函数,可以看到里面启动了一个线程,让其执行controller.control()方法,继续深入该方法,里面是一个死循环,执行handleEvent()方法,继续深入,在handleEvent()方法中就是获取控制信息并执行的部分了。命令的执行原理这里不予深究,感兴趣的读者自行研究,也不难。

private void handleEvent() throws IOException {
    
    ControlMessage msg = connection.receiveControlMessage();
    switch (msg.getType()) {
    
        case ControlMessage.TYPE_INJECT_KEYCODE:
            if (device.supportsInputEvents()) {
    
                injectKeycode(msg.getAction(), msg.getKeycode(), msg.getRepeat(), msg.getMetaState());
            }
            break;
        ...
        ...
        default:
            // do nothing
    }
}

        在82行读取控制信息,让我们继续深入该方法。在117行,获取一条控制信息,若为空则表示控制信息全部执行完毕,readFrom开始从socket中读取下一次的控制信息至缓冲区。next为从缓冲区解析出一条控制信息,让我们深入next函数。

public ControlMessage  receiveControlMessage() throws IOException {
    
    ControlMessage msg = reader.next();
    while (msg == null) {
    
        reader.readFrom(controlInputStream);
        msg = reader.next();
    }
    return msg;
}

        在next函数中,从buffer中获取一个字节作为控制类型,每一个case对应一种类型。

public ControlMessage next() {
    
	...
    int type = buffer.get();
    ControlMessage msg;
    switch (type) {
    
        case ControlMessage.TYPE_INJECT_KEYCODE:
            msg = parseInjectKeycode();
            break;
         ...
         ...
        default:
            Ln.w("Unknown event type: " + type);
            msg = null;
            break;
    }
	...
    return msg;
}

        以第一个TYPE_INJECT_KEYCODE为例,深入parseInjectKeycode()函数。至此,我们就可以推测出其具体的通信格式了。每一个控制类型都不一样,需要读者自行分析,但都大同小异。

privateControlMessage parseInjectKeycode() {
    
    if (buffer.remaining() < INJECT_KEYCODE_PAYLOAD_LENGTH) {
    
        return null;
    }
    int action = toUnsigned(buffer.get());
    int keycode = buffer.getInt();
    int repeat = buffer.getInt();
    int metaState = buffer.getInt();
    return ControlMessage.createInjectKeycode(action, keycode, repeat, metaState);
}

5、发送屏幕数据

        回到Server.java的100行,调用 screenEncoder.streamScreen() 函数,主线程开始不断发送屏幕数据至Client。让我们深入该函数,该函数调用了 internalStreamScreen() 方法,继续深入 internalStreamScreen() 方法,至此就是Server端的最后一个死循环了。
        99行的encode方法的功能就是将读取屏幕数据并编码然后传输至Client,具体实现与MediaCodec、Surface、Binder等机制有关,这里不展开。

private void internalStreamScreen(Device device, FileDescriptor fd) throws IOException {
    
	...
    try {
    
        do {
    
            MediaCodec codec = createCodec(encoderName);
        	...
            codec.start();
            try {
    
                alive = encode(codec, fd);
                // do not call stop() on exception, it would trigger an IllegalStateException
                codec.stop();
            } catch (IllegalStateException e) {
    
            	...
            } finally {
    
            	...
            }
        } while (alive);
    } finally {
    
    	...
    }
}

六、Client端源码分析

1、启动参数

        Scrcpy的Client端是一个C程序,使用SDL库构建跨平台图形化界面。和一切的C程序一样,让我们从main.c开始,首先是53行的scrcpy_options_default,这里面存储的是默认选项,其实现位于options.c文件中,读者可以自行查看。

int
main(int argc, char *argv[]) {
    
	...
    struct scrcpy_cli_args args = {
    
        .opts = scrcpy_options_default,
        .help = false,
        .version = false,
    };
	...
    bool ok = scrcpy(&args.opts);
	...
    return ok ? 0 : 1;
}

2、相关配置

        进入scrcpy函数,在334行sc_server_start()函数中连接Server,需要注意一下,327行的sc_server_on_connected()函数为后续连接成功时的回调函数。


bool
scrcpy(struct scrcpy_options *options) {
    
    static struct scrcpy scrcpy;
    struct scrcpy *s = &scrcpy;
	...
    static const struct sc_server_callbacks cbs = {
    
        .on_connection_failed = sc_server_on_connection_failed,
        .on_connected = sc_server_on_connected,
        .on_disconnected = sc_server_on_disconnected,
    };
    ...
    if (!sc_server_start(&s->server)) {
    
        goto end;
    }
	...
    return ret;
}

3、通过ADB发送Server端程序

        进入sc_server_start()函数,该函数创建了一下线程执行run_server()函数,深入run_server()函数,722行的push_server()就是将Server端Java程序通过ADB命令传输至Android中,其执行的shell命令如下:

adb push ./scrcpy-server /data/local/tmp/scrcpy-server.jar

4、启动Server端程序

        在run_server()函数的734行,execute_server()函数就是启动Server端Java程序,里面涉及很多参数,读者可以参考6.1中的内容。默认情况下,则其执行的shell命令如下(SCRCPY_VERSION 在本文中为1.22):

adb shell CLASSPATH=/data/local/tmp/scrcpy-server.jar app_process / com.genymobile.scrcpy.Server SCRCPY_VERSION log_level=info bit_rate=8000000 tunnel_forward=true

        若使用javacv中的FFmpegFrameGrabber,则需要再添加以下参数,否则会传输视频时会出现错误,最好再加上锁定屏幕方向,防止传输的视频宽高突然变化:

lock_video_orientation=0 send_frame_meta=false encoder_name=OMX.qcom.video.encoder.avc

5、连接Servrver端程序

        在run_server()函数的752行,sc_server_connect_to()函数就是通过Socket连接Server端程序,if中的是等待Server端连接,这里不予讨论。主要看else中的连接流程,首先通过connect_to_server()函数连接用于传输视频的socket,再连接传输控制信息的socket,其中connect_to_server()函数就是连接后读取一个字节验证是否连接成功,这里和5.2节中讨论的是一致的,就不继续深入了。


static bool
sc_server_connect_to(struct sc_server *server, struct sc_server_info *info) {
    
	...
    if (!tunnel->forward) {
    
    	...
    } else {
    
    	...
        video_socket = connect_to_server(server, attempts, delay, tunnel_host,
                                         tunnel_port);
  		...
        if (control) {
    
            // we know that the device is listening, we don't need several
            // attempts
            control_socket = net_socket();
            ...
            bool ok = net_connect_intr(&server->intr, control_socket,
                                       tunnel_host, tunnel_port);
			...
        }
    }
	...
}

6、启动控制

        连接成功后,在run_server()函数的763行调用连接成功回调函数,即scrcpy.c中250行的sc_server_on_connected()函数,其主要为基于SDL图形库的事件和Server端程序进行交互,这里就不深入了。

七、总结

        通过本文的分析,能够对Scrcpy有一个总体的掌握,请读者们自行尝试手动启动Server端Java程序,并使用喜爱的编程语言进行连接,发送和接收数据。

adb forward tcp:5000 localabstract:scrcpy

adb push ./scrcpy-server /data/local/tmp/scrcpy-server.jar

adb shell CLASSPATH=/data/local/tmp/scrcpy-server.jar app_process / com.genymobile.scrcpy.Server 1.22 log_level=info bit_rate=8000000 tunnel_forward=true lock_video_orientation=0 send_frame_meta=false encoder_name=OMX.qcom.video.encoder.avc
版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/qq_43519779/article/details/123073615

智能推荐

MySQL 语法问题:You can‘t specify target table ‘xxx‘ for update in FROM clause. 原因及解决方法_you can't specify target table 't_bill' for update-程序员宅基地

文章浏览阅读429次。报错信息如下:[Code: 1093, SQL State: HY000] You can’t specify target table ‘bd_bankaccbas’ for update in FROM clause译文:不能在FROM子句中指定目标表‘bd_bankaccbas’进行更新。有问题的SQL语句如下,它在oracle数据库的语法是支持的,但是mysql就不支持直接这么写:from和update都是同一张表。<span style="col..._you can't specify target table 't_bill' for update in from clause

Spring Boot与消息(JMS、AMQP、RabbitMQ)-程序员宅基地

文章浏览阅读421次。为什么80%的码农都做不了架构师?>>> ..._@jmslistener rabitmq

转载:CPU 是如何制造出来的?高清图解_测试版cpu是怎么流出的?-程序员宅基地

文章浏览阅读414次。转载:https://mp.weixin.qq.com/s/VQb_mAFbStQXurtByBa0oQ_测试版cpu是怎么流出的?

【学相伴】Nginx最新教程通俗易懂-狂神说_遇见狂神说 nginx-程序员宅基地

文章浏览阅读1.5w次,点赞91次,收藏384次。Nginx - 学相伴分享人:秦疆(遇见狂神说)公司产品出现瓶颈?我们公司项目刚刚上线的时候,并发量小,用户使用的少,所以在低并发的情况下,一个jar包启动应用就够了,然后内部tomcat返回内容给用户。但是慢慢的,使用我们平台的用户越来越多了,并发量慢慢增大了,这时候一台服务器满足不了我们的需求了。于是我们横向扩展,又增加了服务器。这个时候几个项目启动在不同的服务器上,用户要访问,就需要增加一个代理服务器了,通过代理服务器来帮我们转发和处理请求。我们希望这个代理服务器可以帮助我们接_遇见狂神说 nginx

分包组包 北斗通信_一种基于北斗的低功耗双向非实时通信方法-程序员宅基地

文章浏览阅读474次。一种基于北斗的低功耗双向非实时通信方法【技术领域】[0001]本发明涉及一种基于北斗的低功耗双向非实时通信方法,属于北斗系统通信技术领域。【背景技术】[0002]北斗卫星系统具备的短报文通信功能在水文、气象、海洋、林业领域的遥测系统已经广泛应用。但鉴于目前北斗通讯终端的功耗较大,发信频度受限的问题,这些遥测系统在应用北斗卫星作为数据传输载体时,一般只实现了野外遥测站向数据采集中心站的单向传输功能,..._北斗双向通信

windows域名映射_windows域名映射文件-程序员宅基地

文章浏览阅读981次,点赞2次,收藏2次。windows域名映射_windows域名映射文件

随便推点

macbook 的 charles 使用-程序员宅基地

文章浏览阅读171次。1 安装在官网下载对应版本, 如果要破解,请找到破解用 charles.jar(charles用java写的),替换掉安装目录中 jar 文件2 取得管理权限下载证书pc移动端证书help -> proxy ssl -> 选择对应的选项,安装好选项,授权永久信任,再输入当前用户密,最后输入 grant 用户权限密码(如果自己的电脑无需)3 使用charles 配置..._macbook charles method connection

2023最新Android Studio安装、卸载、解决c盘占用教程_build configuration language-程序员宅基地

文章浏览阅读7.3k次,点赞30次,收藏133次。2023最新Android Studio安装、卸载、解决c盘占用教程,从安装到hello world运行_build configuration language

【论文精读】Temporally Refined Graph U-Nets for Human Shape and Pose Estimation From Monocular Videos-程序员宅基地

文章浏览阅读245次。摘要:这项工作解决了一个具有挑战性的问题,即从单目视频中估计完整的三维人体形状和姿态。由于现实世界的三维网格标记数据集有限,目前大多数的三维人体形状重建方法只关注单一的RGB图像,丢失了所有的时间信息。与此相反,我们提出了一种临时细化的图形网,包括图像级模块和视频级模块,来解决这一问题。imagelevel模块是用于从图像中进行人体形状和姿态估计的图U-Nets,其中图卷积神经网络(Graph CNN)有助于相邻顶点的信息交流,U-Nets架构扩大了每个顶点的接受域,融合了高层和低层特征。videolev_temporally refined graph u-nets for human shape and pose estimation from mon

ubuntu 安装完oracle之后没有sqlplus,Linux安装Oracle成功后,启动sqlplus问题集合(详解)...-程序员宅基地

文章浏览阅读2.0k次。注意:Oracle安装不能用root用户安装,必须新建用户安装1、 sqlplus命令不识别问题(bash :sqlplus command not found)当你首次安装oracle后,也许会出现这种情况,第一次或许有点棘手,不知道如何改怎么办。这时不用着急,想想Linux里面的命令是如何运行的,如adduser等,我们发现是因为在/bin/文件夹下有这样的一个文件adduser,于是我们也想..._ubuntu中oracle提示sqlpus: command not found

elasticsearch-setup-passwords interactive_bash: elasticsearch-setup-passwords: command not f-程序员宅基地

文章浏览阅读2.6k次。elasticsearch-setup-passwords interactive[root@node-zwf ~]# su elasticsearch[elasticsearch@node-zwf root]$ cd /home/elasticsearch/elasticsearch-7.8.0/[elasticsearch@node-zwf elasticsearch-7.8.0]$ elasticsearch-setup-passwords interactiveba..._bash: elasticsearch-setup-passwords: command not found

学校公共计算机保用规定,湖南中医药大学涉密计算机和涉密移动存储介质保密管理规定...-程序员宅基地

文章浏览阅读922次。第一条为了进一步加强学校涉密计算机和涉密移动存储介质(移动硬盘、U盘、软盘、光盘、存储卡等)的安全保密工作,维护国家安全和利益,维护学校稳定和发展,结合我校工作实际,特制定本规定。第二条学校保密委员会负责全校涉密计算机、移动存储介质保密管理的指导、协调和监督工作。保密技术防范和管理工作由学校网络中心负责。第三条涉密计算机的日常管理制度(一)涉密计算机不得直接或间接接入国际互联网、校园网和其他公共信..._大学 涉密计算机安全保密策略