webRTC Android源码拉取与编译与运行

前言

webRTC源码，有RTC web的，也是默认的，也有RTC android的，还有RTC ios的，可以根据项目需要，拉取不同的源码。当然了，其实不同的仓库源码，底层库基本一样的，直白的说，C++的代码基本一样，大部分是公共的代码，不然它也不敢宣称自己是跨平台的。RTC所谓跨平台，就是底层库（C++实现）是同一个，但针对不同的平台，比如对android，会包一层java API来是适配，给android开发着使用，ios或者web也一样（web就是包一层JS API）。

话不多说，下面开始介绍如何拉取源码，以及如何编译。

1 源码拉取

1.1 安装必备工具depot

git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git

设置环境变量, home目录的.bashrc，末尾添加两句话

export WEBRTC_DEPOT_TOOLS=/home/chenxiaofeng/webRTC_Source/depot_tools
export PATH=$PATH:$WEBRTC_DEPOT_TOOLS

使变量生效, 命令行执行
source ~/.bashrc

1.2 拉取源码

创建一个目录，然后进到目录，拉取。
如前文说的，webRTC源码，有基于浏览器的，也是最基本的，也有基于android的和ios的。根据你的需要，建议分开拉取。本文以android为例子说明，命令如下：

mkdir webrtc_android
cd webrtc_android
fetch --nohooks webrtc_android
gclient sync

命令fetch和gclient，甚至包括下面编译用的gn，就是上面1.1 安装的工具，所以如果你执行失败，请确认1.1有没有设置正确喔。

命令执行了，会拉取webRTC源码，且额外加了android相关的依赖，例如Android SDK/ NDK。整个工程大概21G，主要占用的是第三方依赖，在third_party目录下，大概17G+，其中third_party/Android相关依赖有6G+。所以拉取时，请确保存储空间充裕。

另外，如果是基于浏览器的，那命令如下：

mkdir webrtc
cd webrtc
fetch --nohooks webrtc
gclient sync

同理，ios的fetch改成fetch --nohooks webrtc_ios就可以了。
三种类型，webRTC的基础代码基本一样。只是平台依赖不一样。

2 编译

编译以android的webRTC源码来说明。
代码拉下来，就一个src目录。
进入src目录，使用gn命令，生成编译RTC android需要的文件。

$ gn gen out/Debug --args='target_os="android" target_cpu="arm"'

然后开始编译:

autoninja -C out/Debug

这个命令是编译代码，生成so库。不会生成android apk。如果要生成demo apk，用如下命令：

autoninja -C out/Debug AppRTCMobile

此时，进入out目录，有apk生成：
out/Debug/apks/AppRTCMobile.apk

ps:
如果你之前ubuntu没有下载android sdk/ndk，那么，在源码目录下，设置一下sdk/ndk的环境变量：

source build/android/envsetup.sh

3 使用AndroidStudio开发

这里介绍3种开发方式。

3.1官方推荐方式

3.1.1 生成Android demo app源码

用如下命令，生成一个AndroidStudio可以打开的工程。

build/android/gradle/generate_gradle.py --output-directory $PWD/out/Debug \
  --target "//examples:AppRTCMobile" --use-gradle-process-resources \
  --split-projects --canary

3.1.2 引入工程

打开AndroidStudio，引入工程，工程的目录是
out/Debug/gradle

一切顺利的话，可以编译成功，但是注意，在2021-04-15左右的master的代码，Sync时会遇到失败。

Cannot resolve external dependency com.android.tools.build:aapt2:4.1.1-6503028 because no repositories
很明显，gradle文件，确实没有加仓库地址，看来3.1.1的脚本还不够完善。没事，忍住，我们在最外层的build.gradle加下面这一句：

allprojects {
    repositories {
        google()
        jcenter()
    }
}

再Sync，应该过了，但是遇到了新的错误：
Entry name 'org/appspot/apprtc/R.class' collided
也就是说，有同样的R.class在不同的module出现。

官方讨论群，也有这个问题抛出来。
https://groups.google.com/g/discuss-webrtc/c/dtD7rXKeaHc

这个问题，还没有得到解决。所以下面提出另外的开发方式。

3.2 拷贝android demo源码 + rtc android java层源码+ RTC底层so

上面的方法，编译有问题，而且工程很多是相对路径，要看代码特别不方便。所以，我们可以自己把rtc源码抓出来，自己编译。
如标题说的，总共需要3个东西：
android demo源码，就是一个使用RTC android API的例子工程，在examples/androidapp目录下。
rtc android java层源码，指的就是RTC给android封装的JAVA API。当然了，API就是薄薄的一层，实际工作在so完成，所以还需要一个so。so名字是libjingle_peerconnection_so.so。

下面给出具体步骤：

3.2.1 创建一个干净的工程，app模块放官方的example代码

工程创建好了，就有一个默认的app 模块。

从webrtc-android/src/examples/androidapp目录中，复制目录src res AndroidManifest.xml 替换到新建的工程。

把webrtc-android/src/examples/androidapp/third_party/autobanh/lib的autobanh.jar放到新建的工程的app/libs目录。（autobanh.jar是WebSocket的java包，rtc android有依赖）

3.2.2 创建一个新的Module，存放rtc源码

包名如上。module_name可以自己随便取。包名用org.webrtc，是因为RTC android的java API都是这个包名，咱得一致。

该模块都需要拷贝什么目录呢？
其实可以根据3.1，生成的工程来看，目前需要如下目录：
a) 自动生成的文件
out/Debug/gen/sdk/android/peerconnection_java/generated_java/input_srcjars/org/webrtc
这个数量很少，截至2021-5-1，只有3个。
NetworkPreference.java Priority.java VideoCodecType.java

b) sdk/android/src/java/

c) sdk/android/api

d) rtc_base/java/src

e) modules/audio_device/android/java/src

上面的文件全部拷贝到新模块的org/webrtc目录下。

3.2.3 加入so库

前面第二节，提到了编译。会生成so库。
out/Debug/libjingle_peerconnection_so.so
在@ 3.2.2 建立的模块内，src/main下，建立jniLibs/armeabi，然后把上面的库，拷贝到目录中。

ps:
如果项目需要修改so，可以修改对应的c++代码，然后用第二节的编译命令来编译。

3.2.4 Sync并解决问题

app模块加上对新建模块的依赖，然后Sync，此时可能会有annotation找不到。那是因为RTC源码还依赖用android-support，而最新AS开发，一般都换成androidx的了，所以，两个模块都声明对androidx的依赖：
implementation ‘androidx.appcompat:appcompat:1.2.0’

然后做如下替换：
Edit->Find->Replace In Path

（ps: 当然了，你也可以自己加上android-support的库，也能Sync过）

3.2.5 收尾

一切顺利的话，就可以编译出apk了。这个工程，我已上传到github。项目地址：
https://github.com/newchenxf/AppRTCMobile

3.3 编译libwebrtc.aar + 创建新工程

千万我们自己手动拷贝了android java api和so，其实这个组合在一起就是一个aar。webRTC的android源码，最后对外输出的就是一个aar。所以，如果你不需要修改java api，那也可以直接用RTC的工具，生成aar来使用。

所以要跑Demo的话，可以自己编译aar，然后用examples/androidapp的源码，自己弄一个工程，工程依赖aar，就可以跑起和3.1一样的Demo了。下面是具体步骤：

3.3.1 编译aar

执行如下脚本：

./tools_webrtc/android/build_aar.py

这个脚本，会把所有平台的so都编译出来
DEFAULT_ARCHS = ['armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64']

如果想修改，可以打开脚本文件，修改DEFAULT_ARCHS变量。

最后的aar，就生成在src根目录。叫做libwebrtc.aar。

3.3.2 建立工程并做一些修改

建立一个新工程，包名如下：

创建好了，就有一个默认的app目录。

从webrtc-android/src/examples/androidapp目录中，复制目录src res AndroidManifest.xml 替换到新建的工程。

把webrtc-android/src/examples/androidapp/third_party/autobanh/lib的autobanh.jar和生成的libwebrtc.aar放到新建的工程的app/libs目录。

修改app/build.gradle

最后Sync，会发生一个错误，是Nullable找不到。没关系，全局替换成androidx的就行。

Edit->Find->Replace In Path， 做如下替换：
import android.support.annotation.Nullable;
import androidx.annotation.Nullable;

最后再Sync，然后编译apk，理论上可以编译成功。

4 运行

第三步，各种操作猛如虎，终于编译出官方给的demo apk了，也能看代码，也能自己加日志学习了。但是apk跑起来，怎么运行呢？

首先，最基本的RTC功能就是视频通话，那就需要2个端，需要把两个apk装在2个手机上。

跑起来怎么运行呢？
如这篇文章说的webRTC基本原理，运行demo还需要一个信令服务器。google官方的客户端demo，就要用google官方的信令服务器了。

google官方信令服务器，也是开源，项目地址：
https://github.com/webrtc/apprtc

Google自己线上也运行了这个服务器，地址是www.appr.tc。打开后是这样：

第三节编译的apk，默认就是连接到这个服务器。不信代码可以搜一下appr.tc。

apk使用这里随机创建的room id，理论上就可以建立通话。
不过，不过，我这没运行起来！有可能这个服务只是示例，实际需要自己本地部署。本地部署，可以参考AppRTC(WebRTC)服务器搭建。本地部署好了，记得apk的信令服务器地址代码，也改成你自己部署的服务器地址喔。本文不再展开。

另外，如果是纯学习用，不是商用，那不需要用google官方的信令服务器+demo，可以有另一套简单的，后面另一篇文章展开。

总结

RTC Android的开发，如果是纯粹应用层开发，可以参考@3.3，编译官方aar使用即可，安全可靠。如果不想自己编译，只想同步最新的官方aar，那也行，在模块的gradle加如下依赖即可：
implementation 'org.webrtc:google-webrtc:1.0.+

如果想写死版本号，去官网查看具体版本号：
https://bintray.com/google/webrtc/google-webrtc

而如果修改Android java API，可以参考@3.2。

如果还需要修改so，建议用Virtual Studio来作为IDE开发。查代码用Virtual Studio，编译so用第二节的命令。

参考

[1] https://webrtc.googlesource.com/src/+/refs/heads/master/docs/native-code/development/index.md
[2] https://blog.csdn.net/H_O_W_E/article/details/105819423