How do I build for arm64-v8a using android-cmake?

Set the ANDROID_ABI variable to 'arm64-v8a' when running cmake, and ensure you have NDK r10 or newer installed. The toolchain will automatically configure the appropriate compiler and API level for this ABI.

android-cmake vs ndk-build: which should I use?

Choose android-cmake if you're porting existing CMake projects or prefer CMake workflows; it integrates well but lacks some ndk-build features. Use ndk-build for full feature support, including armeabi-v7a-hard and single-command multi-ABI builds.

Does android-cmake support Clang compiler?

Yes, you can use Clang by setting the ANDROID_TOOLCHAIN_NAME to a Clang version like 'arm-linux-androideabi-clang3.5'. The README lists available toolchains for different NDK versions and ABIs.

What Android NDK versions are compatible with android-cmake?

android-cmake supports NDK versions from r5 onward, including r10 for 64-bit ABIs like arm64-v8a. It automatically detects the NDK layout and configures based on the installed release.

How to set up android-cmake on Windows for native builds?

Use Ninja by passing -GNinja to CMake for fast builds, or ensure a compatible make.exe is in PATH. The README specifies that cygwin is not supported and provides steps for using Ninja or MinGW makefiles.

Can I use android-cmake with Android Studio's CMake integration?

Yes, integrate it by specifying the android.toolchain.cmake file in your CMake arguments within Android Studio. This allows building native libraries alongside Java code using CMake's cross-compilation features.

How does android-cmake handle assembler source files?

It should correctly process .s or .S assembler files, but if issues occur, upgrading CMake to version 2.8.5 or newer is recommended, as noted in the troubleshooting section of the README.

android-cmake — CMake Toolchain for Android NDK

What is android-cmake?

android-cmake is a collection of CMake scripts and a toolchain file that enables developers to build native C/C++ code for Android using the Android NDK. It provides a CMake-based alternative to the traditional ndk-build system, allowing projects using CMake as their build system to target Android platforms seamlessly. The project originated from experience porting the OpenCV library to Android and aims to share these scripts with the broader Android NDK community.

Target Audience

Android developers and C/C++ engineers who need to build native libraries or applications for Android using CMake as their build system, particularly those porting existing CMake-based projects to the Android platform.

Value Proposition

Developers choose android-cmake because it integrates CMake's powerful cross-platform build capabilities with Android's native development requirements, providing a familiar workflow for CMake users while handling Android-specific complexities like ABI selection, toolchain configuration, and NDK discovery automatically.

CMake toolchain file and other scripts for the Android NDK

Use Cases

Best For

Porting existing CMake-based C/C++ projects to Android
Building native Android libraries with complex CMake configurations
Developing Android applications with mixed Java and native C/C++ components
Cross-compiling performance-critical code for multiple Android ABIs
Using modern CMake features while targeting Android platforms
Integrating third-party C/C++ libraries into Android projects via CMake

Not Ideal For

Projects requiring armeabi-v7a-hard ABI for enhanced floating-point performance
Teams that depend on libc++ STL runtime (static or shared) as their C++ standard library
Build pipelines needing single-command compilation for multiple Android ABIs (e.g., using ndk-build's multi-ABI support)
Environments where the official ndk-build system is mandated or preferred without CMake integration

Pros & Cons

Pros

Automatic NDK Discovery

Searches for Android NDK in standard paths and environment variables, reducing manual configuration overhead, as it automatically locates NDK installs from common locations.

Comprehensive ABI Support

Builds for a wide range of Android ABIs including armeabi-v7a, x86, arm64-v8a, and more, with detailed options listed in the README for targeting different architectures.

CMake Native Integration

Provides a toolchain file that seamlessly integrates Android NDK with CMake, enabling cross-compilation using CMake's standard commands and workflows.

Flexible Toolchain Configuration

Allows selection of various GCC and Clang compiler versions and STL runtimes like GNU STL or STLport, as detailed in the ANDROID_TOOLCHAIN_NAME and ANDROID_STL options.

Cons

Restricted Build Configurations

Forces use of only Release or Debug build types, unlike standard CMake which supports more configurations, potentially limiting development and testing workflows.

Incomplete ndk-build Feature Parity

Lacks support for key ndk-build features such as armeabi-v7a-hard ABI and libc++ STL runtime, as admitted in the README, which may hinder projects relying on these.

No Multi-ABI Single Build

Requires separate CMake invocations for each Android ABI, unlike ndk-build's ability to compile for multiple platforms in one command, increasing build complexity and time.

Frequently Asked Questions

What is android-cmake?

Target Audience

Value Proposition

Use Cases

Best For

Porting existing CMake-based C/C++ projects to Android
Building native Android libraries with complex CMake configurations
Developing Android applications with mixed Java and native C/C++ components
Cross-compiling performance-critical code for multiple Android ABIs
Using modern CMake features while targeting Android platforms
Integrating third-party C/C++ libraries into Android projects via CMake

Not Ideal For

Projects requiring armeabi-v7a-hard ABI for enhanced floating-point performance
Teams that depend on libc++ STL runtime (static or shared) as their C++ standard library
Build pipelines needing single-command compilation for multiple Android ABIs (e.g., using ndk-build's multi-ABI support)
Environments where the official ndk-build system is mandated or preferred without CMake integration

Pros & Cons

Pros

Automatic NDK Discovery

Searches for Android NDK in standard paths and environment variables, reducing manual configuration overhead, as it automatically locates NDK installs from common locations.

Comprehensive ABI Support

Builds for a wide range of Android ABIs including armeabi-v7a, x86, arm64-v8a, and more, with detailed options listed in the README for targeting different architectures.

CMake Native Integration

Provides a toolchain file that seamlessly integrates Android NDK with CMake, enabling cross-compilation using CMake's standard commands and workflows.

Flexible Toolchain Configuration

Allows selection of various GCC and Clang compiler versions and STL runtimes like GNU STL or STLport, as detailed in the ANDROID_TOOLCHAIN_NAME and ANDROID_STL options.

Cons

Restricted Build Configurations

Forces use of only Release or Debug build types, unlike standard CMake which supports more configurations, potentially limiting development and testing workflows.

Incomplete ndk-build Feature Parity

Lacks support for key ndk-build features such as armeabi-v7a-hard ABI and libc++ STL runtime, as admitted in the README, which may hinder projects relying on these.

No Multi-ABI Single Build

Requires separate CMake invocations for each Android ABI, unlike ndk-build's ability to compile for multiple platforms in one command, increasing build complexity and time.

Frequently Asked Questions

android-cmake

What is android-cmake?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

android-cmake

What is android-cmake?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?