Add C and C++ code to your project

You can add C and C++ code to your Android project by placing the code into a cpp directory in your project module. When you build your project, this code is compiled into a native library that Gradle can package with your APK. Your Java or Kotlin code can then call functions in your native library through the Java Native Interface (JNI). To learn more about using the JNI framework, read JNI tips for Android.

Android Studio supports CMake, which is good for cross-platform projects, and ndk-build, which can be faster than CMake but only supports Android. Using both CMake and ndk-build in the same module is not currently supported.

If you want to import an existing ndk-build library into your Android Studio project, learn how to link Gradle to your native library project.

This page shows you how to set up Android Studio with the necessary build tools, create a new project with C/C++ support, and add new C/C++ files to your project.

If instead you want to add native code to an existing project, you need to follow these steps:

Create new native source files and add them to your Android Studio project.
- You can skip this step if you already have native code or want to import a prebuilt native library.
Configure CMake to build your native source code into a library. You also require this build script if you are importing and linking against prebuilt or platform libraries.
- If you have an existing native library that already has a CMakeLists.txt build script, or uses ndk-build and includes an Android.mk build script, you can skip this step.
Configure Gradle by providing a path to your CMake or ndk-build script file. Gradle uses the build script to import source code into your Android Studio project and package your native library (the SO file) into the APK.

Once you configure your project, you can access your native functions from Java or Kotlin code using the JNI framework. To build and run your app, simply click Run .

Note: If your existing project uses the deprecated ndkCompile tool, you should migrate to using either CMake or ndk-build. To learn more, go to the section about how to Migrate from ndkCompile.

Attention experimental Gradle users: Consider migrating to plugin version 2.2.0 or higher, and using CMake or ndk-build to build your native libraries if any of the following apply to you: Your native project already uses CMake or ndk-build; you would rather use a stable version of the Gradle build system; or you want support for add-on tools, such as CCache. Otherwise, you can continue to use the experimental version of Gradle and the Android plugin.

Download the NDK and build tools

To compile and debug native code for your app, you need the following components:

The Android Native Development Kit (NDK): a toolset that allows you to use C and C++ code with Android, and provides platform libraries that allow you to manage native activities and access physical device components, such as sensors and touch input.
CMake: an external build tool that works alongside Gradle to build your native library. You do not need this component if you only plan to use ndk-build.
LLDB: the debugger Android Studio uses to debug native code.

For information on installing these components, see Install and configure the NDK, CMake, and LLDB.

Use CMake 3.6.0 or 3.10.2

The SDK Manager includes the 3.6.0 forked version of CMake and version 3.10.2. Projects that don't set a specific CMake version in build.gradle are built with CMake 3.6.0. To use the later included version, specify CMake version 3.10.2 in your module's build.gradle file:

android {
    ...
    externalNativeBuild {
        cmake {
            ...
            version "3.10.2"
        }
    }
}

While not a best practice, you may specify the CMake version as the minimum version by adding a + to the end of the build.gradle entry, such as 3.10.2+.

Use a custom CMake version

If you want to use a CMake version 3.7 or higher that is not included by the SDK Manager, follow these steps:

Download and install CMake 3.7 or higher from the official CMake website.

Specify the CMake version you want Gradle to use in your module's build.gradle file:

android {
    ...
    externalNativeBuild {
        cmake {
            ...
            version "cmake-version"
        }
    }
}

Either add the path to the CMake installation to your PATH environment variable or include it in your project's local.properties file, as shown below. If Gradle is unable to find the version of CMake you specified in your build.gradle file, you get a build error.
```
# If you set this property, Gradle no longer uses PATH to find CMake.
cmake.dir="path-to-cmake"
```
If you don't already have the Ninja build system installed on your workstation, go to the official Ninja website, and download and install the latest version of Ninja available for your OS. Make sure to also add the path to the Ninja installation to your PATH environment variable.

Create a new project with C/C++ support

Creating a new project with support for native code is similar to creating any other Android Studio project, but there is an additional step:

In the Choose your project section of the wizard, select the Native C++ project type.
Click Next.
Complete all other fields in the next section of the wizard.
Click Next.
In the Customize C++ Support section of the wizard, you can customize your project with the C++ Standard field. Use the drop-down list to select which standardization of C++ you want to use. Selecting Toolchain Default uses the default CMake setting.
Click Finish.

After Android Studio finishes creating your new project, open the Project pane from the left side of the IDE and select the Android view. As shown in figure 2, Android Studio adds the cpp group:

Figure 2. Android view groups for your native sources and external build scripts.

Note: This view does not reflect the actual file hierarchy on disk, but groups similar files to simplify navigating your project.

The cpp group is where you can find all the native source files, headers, build scripts for CMake or ndk-build, and prebuilt libraries that are a part of your project. For new projects, Android Studio creates a sample C++ source file, native-lib.cpp, and places it in the src/main/cpp/ directory of your app module. This sample code provides a simple C++ function, stringFromJNI(), that returns the string "Hello from C++". You can learn how to add additional source files to your project in the section about how to Create new native source files.

Similar to how build.gradle files tell Gradle how to build your app, CMake and ndk-build require a build script to know how to build your native library. For new projects, Android Studio creates a CMake build script, CMakeLists.txt, and places it in your module’s root directory. To learn more about the contents of this build script, read Configure CMake.

Build and run the sample app

When you click Run , Android Studio builds and launches an app that displays the text "Hello from C++" on your Android device or emulator. The following overview describes the events that occur in order to build and run the sample app:

Gradle calls upon your external build script, CMakeLists.txt.
CMake follows commands in the build script to compile a C++ source file, native-lib.cpp, into a shared object library and names it libnative-lib.so, which Gradle then packages into the APK.
During runtime, the app's MainActivity loads the native library using System.loadLibrary(). The library’s native function, stringFromJNI(), is now available to the app.
MainActivity.onCreate() calls stringFromJNI(), which returns "Hello from C++", and uses it to update the TextView.

Note: Instant Run is not compatible with components of your project written in native code.

If you want to verify that Gradle packages the native library in the APK, you can use the APK Analyzer:

Select Build > Build Bundles(s) / APK(s) > Build APK(s)
Select Build > Analyze APK.
Select the APK from the app/build/outputs/apk/ directory and click OK.
As shown in figure 3, you can see libnative-lib.so in the APK Analyzer window under lib/<ABI>/.
Figure 3. Locating a native library using the APK Analyzer.

Tip: If you want to experiment with other Android apps that use native code, click File > New > Import Sample and select a sample project from the Ndk list.

Create new C/C++ source files

To add new C/C++ source files to an existing project, proceed as follows:

If you don't already have a cpp/ directory in the main source set of your app, create one as follows:

Open the Project pane from the left side of the IDE and select the Project view from the drop-down menu.
Navigate to your-module > src, right-click on the main directory, and select New > Directory.
Enter cpp as the directory name and click OK.

Right-click on the cpp/ directory and select New > C/C++ Source File.

Enter a name for your source file, such as native-lib.

From the Type drop-down menu, select the file extension for your source file, such as .cpp.
- You can add other file types to the drop-down menu, such as .cxx or .hxx, by clicking Edit File Types . In the C/C++ dialog box that pops up, select another file extension from the Source Extension and Header Extension drop-down menus and click OK.

If you also want to create a header file, check the Create an associated header checkbox.

Click OK.

After you add new C/C++ files to you project, you still need to configure CMake to include them in your native library.

Additional resources

To learn more about supporting C/C++ code in your app, try the following resource.

Codelabs

Create Hello-CMake with Android Studio, a codelab that shows you how to use the Android Studio CMake template to start Android NDK project development