commit	2c6ef039587eaaa50dcd1dbb13d71d7e8e7e99ca	[log] [tgz]
author	android-build-team Robot <android-build-team-robot@google.com>	Sat Jan 11 04:13:41 2020 +0000
committer	android-build-team Robot <android-build-team-robot@google.com>	Sat Jan 11 04:13:41 2020 +0000
tree	c3575afb20ebe00bbf1bf734eae4616b1e3bbb27
parent	4d80c7cc17c135d4c72e6c0ac31800a9c700c54d [diff]
parent	96e7474da70c90db0c1c5da58a0de281fc582756 [diff]

tree: c3575afb20ebe00bbf1bf734eae4616b1e3bbb27

README.md

ndkports

A collection of Android build scripts for various third-party libraries and the tooling to build them.

If you're an Android app developer looking to consume these libraries, this is probably not what you want. This project builds AARs to be published to Maven. You most likely want to use the AAR, not build it yourself.

Note: Gradle support for consuming these artifacts from an AAR is a work in progress.

Ports

Each third-party project is called a “port”. Ports consist of a description of where to fetch the source, apply any patches needed, build, install, and package the library into an AAR.

A port is a subclass of the abstract Kotlin class com.android.ndkports.Port. Projects define the name and version of the port, the URL to fetch source from, a list of modules (libraries) to build, and the build steps.

abstract class Port {
    abstract val name: String
    abstract val version: String
    abstract val url: String

    open val dependencies: List<String> = emptyList()
    abstract val modules: List<Module>

    open fun fetchSource(
        sourceDirectory: File,
        workingDirectory: File
    ): Result<Unit, String>

    open fun configure(
        toolchain: Toolchain,
        sourceDirectory: File,
        buildDirectory: File,
        installDirectory: File,
        workingDirectory: File
    ): Result<Unit, String>

    open fun build(
        toolchain: Toolchain,
        buildDirectory: File
    ): Result<Unit, String>

    open fun install(
        toolchain: Toolchain,
        buildDirectory: File,
        installDirectory: File
    ): Result<Unit, String>
}

Individual port files are kept in ports/$name/port.kts. For example, the cURL port is ports/curl/port.kts.

Building a Port

ndkports requires an NDK to be used for building to be specified on the command line as well as a list of packages to build. For example, to build cURL:

$ ./gradlew run --args='--ndk /path/to/android-ndk-r20 openssl curl'
Build output...
$ find  -name '*.aar'
./out/curl/curl.aar
./out/openssl/openssl.aar

Note that dependencies currently need to be already built or ordered explicitly.