Android

トリプレット x64-android、arm-neon-android、arm64-android は、vcpkg のパブリック カタログ CI によってテストされます。

Android のビルド要件

  1. Android NDK をダウンロードする

  2. ANDROID_NDK_HOME Android ツールチェーンを設定するには、環境変数を Android NDK インストールに設定します。 次に例を示します。

    export ANDROID_NDK_HOME=/home/your-account/Android/Sdk/ndk-bundle
    

    または:

    export ANDROID_NDK_HOME=/home/your-account/Android/android-ndk-r25c
    

注: ホストの依存関係についてホストを対象とする g++ または C++ コンパイラをインストールする必要があります。

vcpkg トリプレットとそれに対応する Android ABI

6 つの異なる Android ABI があり、それぞれが vcpkg トリプレットにマップされます。 次の表は、vcpkg アーキテクチャから Android アーキテクチャへのマッピングの概要を示しています。

VCPKG_TARGET_TRIPLET ANDROID_ABI ANDROID_ARM_NEON
arm64-android arm64-v8a
arm-android armeabi-v7a OFF
arm-neon-android armeabi-v7a ON
x64-android x86_64
x86-android x86
armv6-android armeabi

Docker コンテナーでの Android ライブラリのビルド

Ubuntu Docker コンテナーなど jsoncpp 、Android ライブラリを構築できます。

次の内容で a Dockerfile を作成します。

FROM ubuntu:22.04

ENV DEBIAN_FRONTEND noninteractive

RUN \
  apt-get update && \
  apt-get -y upgrade

RUN \
  apt-get -y --no-install-recommends install git g++ wget curl zip vim pkg-config tar cmake unzip ca-certificates

# Download Android NDK
RUN \
  wget https://dl.google.com/android/repository/android-ndk-r25c-linux.zip && \
  unzip android-ndk-r25c-linux.zip && \
  rm -rf android-ndk-r25c-linux.zip

ENV ANDROID_NDK_HOME /android-ndk-r25c

RUN git clone https://github.com/microsoft/vcpkg
WORKDIR vcpkg
RUN ./bootstrap-vcpkg.sh

ENV PATH "/vcpkg:$PATH"
ENV VCPKG_ROOT "/vcpkg"

WORKDIR /project

イメージをビルドし、新しいコンテナーを起動します。

docker build . -t "vcpkg-android"
docker run -it "vcpkg-android" bash

コンテナーで、次の内容を使用して作成 /project/vcpkg.json します。

{
  "dependencies": [
    "jsoncpp"
  ],
  "builtin-baseline": "1e68748a7c6914642ed686b2e19c3d688bca150a"
}

最後に、Android 用にビルドjsoncppするために実行vcpkg install --triplet x64-androidします。

Vulkan SDK の使用

vcpkg には、vulkanfind_package(Vulkan)... これを使用するには、環境変数を指定する VULKAN_SDK 必要があります。

export VULKAN_SDK=/usr/local
./vcpkg install vulkan

NDK には、 各アーキテクチャの Vulkan ヘッダーと libvulkan.so バイナリが既に含まれています。

vcpkg に公開するには、インストールごとに検討 export VULKAN_SDK=... できます。 しかし、トリプレットファイルに配置 set(ENV{VULKAN_SDK} ...) することで、面倒な作業をスキップすることができます。

NDK 21.3.6528147 以前のバージョンを使用している場合は、次のようになります。

# In android triplets... (e.g. arm64-android.cmake)
set(VCPKG_CMAKE_SYSTEM_NAME Android)
# ...
# If your API level is 30, libvulkan.so is at $ENV{ANDROID_NDK_HOME}/platforms/android-30/arch-arm64/usr/lib
set(ENV{VULKAN_SDK} $ENV{ANDROID_NDK_HOME}/sysroot/usr)

sysroot の場所が NDK 22 以降に変更されていることに注意してください。 (詳細については、 [BUG] r22?以降の sysroot ヘッダーがありません)。

最新バージョンを使用する場合は、NDK ドキュメントの BuildSystemMaintainers.md をチェックし、システムに適切なパスを配置します。

たとえば、Mac OS ユーザーは次の例のようなパスを使用します。

# In android triplets... (e.g. arm64-android.cmake)
set(VCPKG_CMAKE_SYSTEM_NAME Android)
# ...
# If your API level is 30, libvulkan.so is at $ENV{ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/darwin-x86_64/sysroot/usr/lib/aarch64-linux-android/30
set(ENV{VULKAN_SDK} $ENV{ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/darwin-x86_64/sysroot/usr)

すべてのAndroidトリプレットに対してこれを行うことで、それを必要とするパッケージをインストール vulkan できます。 (例: vulkan-hpp)

'vcpkg install vulkan-hpp:arm64-android'
user@host$ ./vcpkg install vulkan-hpp:arm64-android
Computing installation plan...
The following packages will be built and installed:
  * vulkan[core]:arm64-android -> 1.1.82.1-1
    vulkan-hpp[core]:arm64-android -> 2019-05-11-1
Additional packages (*) will be modified to complete this operation.
Detecting compiler hash for triplet arm64-android...
...
Starting package 1/2: vulkan:arm64-android
Building package vulkan[core]:arm64-android...
-- Using community triplet arm64-android. This triplet configuration is not guaranteed to succeed.
-- [COMMUNITY] Loading triplet configuration from: /.../vcpkg/triplets/community/arm64-android.cmake
-- Querying VULKAN_SDK Environment variable
-- Searching /.../Library/Android/sdk/ndk/22.1.7171670/toolchains/llvm/prebuilt/darwin-x86_64/sysroot/usr/include/vulkan/ for vulkan.h
-- Found vulkan.h
-- Performing post-build validation
-- Performing post-build validation done
...
Building package vulkan[core]:arm64-android... done
Installing package vulkan[core]:arm64-android...
Installing package vulkan[core]:arm64-android... done
Elapsed time for package vulkan:arm64-android: 35.9 ms
Starting package 2/2: vulkan-hpp:arm64-android
Building package vulkan-hpp[core]:arm64-android...
-- Using community triplet arm64-android. This triplet configuration is not guaranteed to succeed.
-- [COMMUNITY] Loading triplet configuration from: /.../vcpkg/triplets/community/arm64-android.cmake
-- Using cached /.../vcpkg/downloads/KhronosGroup-Vulkan-Hpp-5ce8ae7fd0d9c0543d02f33cfa8a66e6a43e2150.tar.gz
-- Cleaning sources at /.../vcpkg/buildtrees/vulkan-hpp/src/e6a43e2150-4f344cd911.clean. Use --editable to skip cleaning for the packages you specify.
-- Extracting source /.../vcpkg/downloads/KhronosGroup-Vulkan-Hpp-5ce8ae7fd0d9c0543d02f33cfa8a66e6a43e2150.tar.gz
-- Using source at /.../vcpkg/buildtrees/vulkan-hpp/src/e6a43e2150-4f344cd911.clean
-- Performing post-build validation
-- Performing post-build validation done
...
Building package vulkan-hpp[core]:arm64-android... done
Installing package vulkan-hpp[core]:arm64-android...
Installing package vulkan-hpp[core]:arm64-android... done
Elapsed time for package vulkan-hpp:arm64-android: 144.5 ms

Total elapsed time: 1.013 s

The package vulkan-hpp:arm64-android is header only and can be used from CMake via:

    find_path(VULKAN_HPP_INCLUDE_DIRS "vulkan/vulkan.hpp")
    target_include_directories(main PRIVATE ${VULKAN_HPP_INCLUDE_DIRS})

Android プロジェクトの例

フォルダー docs/examples/vcpkg_android_example_cmake は、jsoncpp ライブラリを使用する Android ライブラリを使用した、動作例を提供します。

詳細

  • CMakeLists.txt では、単にfind_packagetarget_link_library

  • compile.sh スクリプトを使用すると、"android abi" / "vcpkg triplet" の一致するペアを選択し、コンパイルをテストできます。

  • ダミー my_lib.cpp ファイルは jsoncpp ライブラリを使用します

Note

この例では、本格的な Android アプリのコンパイルがこのドキュメントの範囲外であるため、Android ライブラリのみをコンパイルします。

例でテストします。 vcpkg_android.cmake

vcpkg_android.cmake を使用して テストします

フォルダー vcpkg_android_example_cmake_script は同じ例を提供し、使用を簡略化するために cmake スクリプトを使用します。

詳細

  • フラグが設定されている場合、メイン CMakeLists.txt は vcpkg_android.cmakeVCPKG_TARGET_ANDROID読み込みます

    if (VCPKG_TARGET_ANDROID)
        include("cmake/vcpkg_android.cmake")
    endif()
    

    重要

    呼び出す project()前にこれらの行を配置します。

  • compile.sh スクリプトは、次のような単純な cmake 呼び出しを使用して Android 用にコンパイルすることが可能であることを示しています。

    cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7a
    

vcpkg と Android プレハブ アーカイブ (AAR ファイル) を使用してライブラリを使用する

Note

このセクションでは、いつでも変更または削除できる vcpkg の試験的な機能について説明します。

vcpkg は Android アーカイブ (AAR ファイル) をエクスポートできます。 アーカイブが作成されると、Android Studio でネイティブ依存としてインポートできます。 アーカイブは、Android Studio のプレハブ ツールを使用して自動的に使用されます。

プレハブの詳細については、以下を参照してください。

Note

Android Studio ユーザー: プレハブ パッケージは Android Studio 4 以降でサポートされています。

要件

  1. ndk <required>

環境変数 ANDROID_NDK_HOME を android ndk インストールに設定します。 次に例を示します。

export ANDROID_NDK_HOME=/home/your-account/Android/Sdk/ndk-bundle
  1. 7zip <required on windows> または zip <required on linux>

  2. maven <optional>

  3. Android トリプレット

Note

"プレハブ" を使用するには (以下を参照)、4 つのアーキテクチャがすべて必要です。 存在しない場合、エクスポートは失敗します。

エクスポートの例 [jsoncpp]

まず、4 つの Android アーキテクチャを "vcpkg install" します (4 つすべてをエクスポートする必要があります)。

./vcpkg install jsoncpp:arm-android  jsoncpp:arm64-android  jsoncpp:x64-android  jsoncpp:x86-android

次に、プレハブをエクスポートします。

注:

  • --prefab-maven フラグは省略できます。 maven がインストールされている場合は呼び出します。
  • このフラグは --prefab-debug 、gradle を介してプレハブ アーカイブを使用する方法に関する手順を出力します。
./vcpkg export --triplet x64-android jsoncpp --prefab --prefab-maven --prefab-debug

次のような出力が表示されます。

The following packages are already built and will be exported:
    jsoncpp:arm64-android

Exporting package jsoncpp...
[DEBUG] Found 4 triplets
  arm64-android
  x64-android
  x86-android
  arm-android

...
... Lots of output...
...

[INFO] Scanning for projects...
Downloading from central: https://repo.maven.apache.org/maven2/org/apache/maven/plugins/maven-clean-plugin/2.5/maven-clean-plugin-2.5.pom

...
... Lots of output...
...

[INFO] BUILD SUCCESS
[INFO] Total time:  2.207 s
[INFO] Finished at: 2020-05-10T14:42:28+02:00


...
... Lots of output...
...

[DEBUG] Configuration properties in Android Studio
In app/build.gradle

  com.vcpkg.ndk.support:jsoncpp:1.9.2

And cmake flags

    externalNativeBuild {
                cmake {
                    arguments '-DANDROID_STL=c++_shared'
                    cppFlags "-std=c++17"
                }
            }

In gradle.properties

    android.enablePrefab=true
    android.enableParallelJsonGen=false
    android.prefabVersion=${prefab.version}

Successfully exported jsoncpp. Checkout .../vcpkg/prefab 

エクスポート後の出力ディレクトリ

prefab
└── jsoncpp/
    ├── aar/
    │   ├── AndroidManifest.xml
    │   ├── META-INF/
    │   │   └── LICENSE
    │   └── prefab/
    │       ├── modules/
    │       │   └── jsoncpp/
    │       │       ├── libs/
    │       │       │   ├── android.arm64-v8a/
    │       │       │   │   ├── abi.json
    │       │       │   │   ├── include/
    │       │       │   │   │   └── json/
    │       │       │   │   │       ├── json.h
    │       │       │   │   │       └── ....
    │       │       │   │   └── libjsoncpp.so
    │       │       │   ├── android.armeabi-v7a/
    │       │       │   │   ├── abi.json
    │       │       │   │   ├── include/
    │       │       │   │   │   └── json/
    │       │       │   │   │       ├── json.h
    │       │       │   │   │       └── ....
    │       │       │   │   └── libjsoncpp.so
    │       │       │   ├── android.x86/
    │       │       │   │   ├── abi.json
    │       │       │   │   ├── include/
    │       │       │   │   │   └── json/
    │       │       │   │   │       ├── json.h
    │       │       │   │   │       └── ....
    │       │       │   │   └── libjsoncpp.so
    │       │       │   └── android.x86_64/
    │       │       │       ├── abi.json
    │       │       │       ├── include/
    │       │       │       │   └── json/
    │       │       │       │       ├── json.h
    │       │       │       │       └── ....
    │       │       │       └── libjsoncpp.so
    │       │       └── module.json
    │       └── prefab.json
    ├── jsoncpp-1.9.2.aar
    └── pom.xml

vcpkg とプレハブを介した [jsoncpp] の使用例

GitHub リポジトリの例については、以下を参照してください。

atkawa7/prefab-vpkg-integration-sample