Android OpenCV（七十七）：官方指南方式编译 OpenCV Android SDK.md

前言

众所周知😳， OpenCV 4.9.0 罕见的在 Android 平台上做出调整，具体更新内容请移步难得一见的 Android OpenCV ChangeLog。然而，近期笔者在查阅 OpenCV Github Wiki 时，又发现了新东西🤡，一篇名为 "Custom OpenCV Android SDK and AAR package build"的 Wiki。以前我们编译 SDK 采用的是CMake方式，具体可参考全网首发微信二维码引擎Android平台移植，而本篇新 Wiki 起草于 2023年11月23日，内容比较新，但是整体还是基于 CMake，只是采用 python 封装脚本方便执行而已，以前应该也可以采用这种方式执行，只是官方一直未正式发布指南。本文主要记录实践过。

环境准备

• Ubuntu 20.04+（笔者版本 Ubuntu 20.04.6 LTS）
• Android Studio（笔者未使用）
• OpenJDK 17
• CMake
• Ninja build tool
• OpenCV source code (https://github.com/opencv/opencv)
• (Optional) OpenCV contrib modules source code (https://github.com/opencv/opencv_contrib)
• (Optional) OpenCV test data (https://github.com/opencv/opencv_extra)

步骤

1. 安装环境

• 安装 OpenJDK 17

  sudo apt install openjdk-17-jdk openjdk-17-jre

• 安装 CMake

  sudo apt install cmake

• 安装 Ninja build tool

  sudo apt install ninja-build

• 安装 build-tools、sdk和 ndk

  Install SDK 21.1.2 and NDK 18.1 using SDK manager in Android Studio (use checkbox “Show package details” to choose a version)

  文中的 21.1.2 应该指代的是 build-tools，因为 Android API级别向来都是大版本，ndk 版本则是 18.1.5063045，sdk 由于文中暂未明确指出，所以我们采用的是 Android 21。

  sdkmanager "platforms;android-21"
  sdkmanager --install "ndk;18.1.5063045"
  sdkmanager --install "build-tools;21.1.2"
  

• 安装 python3

  若 Ubuntu 系统默认未安装，需手动安装 sudo apt install python3。

2. 下载源码

• 下载 opencv 源码

  git clone https://github.com/opencv/opencv.git

• （可选）下载 opencv_contrib 源码

  git clone https://github.com/opencv/opencv_contrib.git

• （?🚫）下载 opencv_extra 源码

  未发现使用的地方，暂时先不下载

笔者将二个源码文件夹放在同一层级目录，方便后续配置变量。

3. 配置编译目录和环境变量

• 新建 build 目录

  笔者此处在二个源码文件夹同一层级目录下创建 build 文件夹

• 配置环境变量

  笔者修改 .bashrc 文件，并在文档末尾追加如下内容

  export YOUR_OPENCV_SRC_FOLDER=/home/yi/opencv  # opencv 源码路径
  export YOUR_CONTRIB_SRC_FOLDER=/home/yi/opencv_contrib # opencv_contrib 源码路径
  export YOUR_OPENCV_BUILD_FOLDER=/home/yi/build # 构建目录
  export ANDROID_SDK=/home/yi/sdk   # Android SDK目录
  export ANDROID_NDK_HOME=/home/yi/sdk/ndk/18.1.5063045 # ndk目录
  

4. 编译 SDK

python3 $YOUR_OPENCV_SRC_FOLDER/platforms/android/build_sdk.py $YOUR_OPENCV_BUILD_FOLDER $YOUR_OPENCV_SRC_FOLDER --ndk_path $ANDROID_NDK_HOME --sdk_path $ANDROID_SDK --extra_modules_path $YOUR_CONTRIB_SRC_FOLDER/modules --config $YOUR_OPENCV_SRC_FOLDER/platforms/android/ndk-18-api-level-21.config.py

配置 ANDROID_PROJECTS_BUILD_TYPE="GRADLE"，可编译生成libopencv_java.so 与对应的 Java Wrapper 文件。由于使用的是 ndk-18-api-level-21.config.py配置文件，会生成 armeabi-v7a、arm64-v8a、x86_64、x86 四种架构的二进制共享库文件。

ABIs = [
    ABI("2", "armeabi-v7a", None, 21, cmake_vars=dict(ANDROID_ABI='armeabi-v7a with NEON')),
    ABI("3", "arm64-v8a",   None, 21),
    ABI("5", "x86_64",      None, 21),
    ABI("4", "x86",         None, 21),
]

如果只需要部分架构的 so 文件，调整文件留下对应的ABI变量即可。

cmake_vars 参数用来传递自定义 CMake 编译参数。例如：

• arm64-v8a架构下不编译 G-API 和 DNN 模块

ABI("3", "arm64-v8a",   None, 21, cmake_vars=dict('BUILD_opencv_gapi': 'OFF', 'BUILD_opencv_dnn': 'OFF'))

• 指定 OpenCV 部分构建工具的版本

ABI("3", "arm64-v8a",   None, 21, cmake_vars=dict('ANDROID_GRADLE_PLUGIN_VERSION': '7.3.1', 'GRADLE_VERSION': '7.5.1', 'KOTLIN_PLUGIN_VERSION': '1.5.20'))

• 指定 CMake find_package 过程的外部库位置

ABI("3", "arm64-v8a",   None, 21, cmake_vars=dict('libavif_DIR': '<path to libavif library cross-compiled for Android arm-v8a>')

所以刚才我们提到的 BUILD_ANDROID_PROJECTS="OFF" 或者 ANDROID_PROJECTS_BUILD_TYPE="GRADLE" 均可以在这里配置。

比如，我们将 ndk-18-api-level-21.config.py 调整为

ABIs = [
    ABI("2", "armeabi-v7a", None, 21, cmake_vars=dict(ANDROID_ABI='armeabi-v7a with NEON', ANDROID_PROJECTS_BUILD_TYPE='GRADLE'))
]

则只会生成 armeabi-v7a 架构的 so 文件。

5. 编译 AAR

python3 $YOUR_OPENCV_SRC_FOLDER/platforms/android/build_java_shared_aar.py $YOUR_OPENCV_BUILD_FOLDER/OpenCV-android-sdk

6. 脚本参数与编译参数

以build_sdk.py 举例如何查找脚本参数与编译参数，虽然脚本参数最后都会落脚到编译参数。

• build_sdk.py 脚本参数

parser = argparse.ArgumentParser(description='Build OpenCV for Android SDK')
parser.add_argument("work_dir", nargs='?', default='.', help="Working directory (and output)")
parser.add_argument("opencv_dir", nargs='?', default=os.path.join(SCRIPT_DIR, '../..'), help="Path to OpenCV source dir")
parser.add_argument('--config', default='ndk-18-api-level-21.config.py', type=str, help="Package build configuration", )
parser.add_argument('--ndk_path', help="Path to Android NDK to use for build")
parser.add_argument('--sdk_path', help="Path to Android SDK to use for build")
parser.add_argument('--use_android_buildtools', action="store_true", help='Use cmake/ninja build tools from Android SDK')
parser.add_argument("--modules_list", help="List of  modules to include for build")
parser.add_argument("--extra_modules_path", help="Path to extra modules to use for build")
parser.add_argument('--sign_with', help="Certificate to sign the Manager apk")
parser.add_argument('--build_doc', action="store_true", help="Build javadoc")
parser.add_argument('--no_ccache', action="store_true", help="Do not use ccache during library build")
parser.add_argument('--force_copy', action="store_true", help="Do not use file move during library build (useful for debug)")
parser.add_argument('--force_opencv_toolchain', action="store_true", help="Do not use toolchain from Android NDK")
parser.add_argument('--debug', action="store_true", help="Build 'Debug' binaries (CMAKE_BUILD_TYPE=Debug)")
parser.add_argument('--debug_info', action="store_true", help="Build with debug information (useful for Release mode: BUILD_WITH_DEBUG_INFO=ON)")
parser.add_argument('--no_samples_build', action="store_true", help="Do not build samples (speeds up build)")
parser.add_argument('--opencl', action="store_true", help="Enable OpenCL support")
parser.add_argument('--no_kotlin', action="store_true", help="Disable Kotlin extensions")
parser.add_argument('--shared', action="store_true", help="Build shared libraries")
parser.add_argument('--no_media_ndk', action="store_true", help="Do not link Media NDK (required for video I/O support)")
args = parser.parse_args()

• CMake 编译参数

cmake_vars = dict(
    CMAKE_TOOLCHAIN_FILE=self.get_toolchain_file(),
    INSTALL_CREATE_DISTRIB="ON",
    WITH_OPENCL="OFF",
    BUILD_KOTLIN_EXTENSIONS="ON",
    WITH_IPP=("ON" if abi.haveIPP() else "OFF"),
    WITH_TBB="ON",
    BUILD_EXAMPLES="OFF",
    BUILD_TESTS="OFF",
    BUILD_PERF_TESTS="OFF",
    BUILD_DOCS="OFF",
    BUILD_ANDROID_EXAMPLES=("OFF" if self.no_samples_build else "ON"),
    INSTALL_ANDROID_EXAMPLES=("OFF" if self.no_samples_build else "ON"),
    # BUILD_ANDROID_PROJECTS="OFF",
    # ANDROID_PROJECTS_BUILD_TYPE="GRADLE"
)

查找并理解编译参数，配合实践，应该可以编译出你想要的文件。

FAQ

?????Android SDK: Can’t build Android projects as requested by BUILD_ANDROID_PROJECTS=ON variable.

?**解决办法：**配置 BUILD_ANDROID_PROJECTS=”OFF“ 或者 ANDROID_PROJECTS_BUILD_TYPE="GRADLE" # 或者 ”ANT“。作为 Android 开发自然是配置 Gradle 嘛，不然颜面何在，当然我们也可以在 config 文件中配置。

?????MainActivity.java:57: 错误: 找不到符号
mModelBuffer = loadFileFromResource(R.raw.mobilenet_iter_73000);
^
符号: 变量 raw
位置: 类 R
/home/yi/opencv/samples/android/mobilenet-objdetect/src/org/opencv/samples/opencv_mobilenet/MainActivity.java:58: 错误: 找不到符号
mConfigBuffer = loadFileFromResource(R.raw.deploy);
^
符号: 变量 raw
位置: 类 R

?**解决办法：**从官方 SDK 文件中手动复制。

?????gradle-7.6.3-all.zip 下载失败

?**解决办法：**下载离线版本存放至 .gradle 对应目录下即可。