{"id":842,"date":"2023-11-08T15:59:37","date_gmt":"2023-11-08T12:59:37","guid":{"rendered":"https:\/\/barisuslucan.com\/en\/?p=842"},"modified":"2023-11-08T16:02:27","modified_gmt":"2023-11-08T13:02:27","slug":"kotlin-and-c-module-interaction-android-ndk","status":"publish","type":"post","link":"https:\/\/barisuslucan.com\/en\/kotlin\/kotlin-and-c-module-interaction-android-ndk\/","title":{"rendered":"Kotlin and C++ Module Interaction: Android NDK"},"content":{"rendered":"

In certain situations, you may need to utilize a C++ module within Kotlin through the Android NDK. In this article, I will elucidate the process of executing C++ code in Kotlin and explore the reasons why such a need may arise.<\/p>\n

There may be several reasons why C++ code is needed in Kotlin:<\/strong><\/p>\n

Performance:<\/strong> <\/span>C++ is usually faster than Kotlin because it is a low-level language and closer to the hardware. This is important for applications that are CPU-intensive.<\/p>\n

Existing Libraries:<\/strong><\/span> There are many powerful and optimized libraries written in C++. Using these libraries can be more efficient for solving specific problems.<\/p>\n

Language Features:<\/span><\/strong> C++ has some language features that may not be available in Kotlin. These features may be required for an application that needs them.<\/p>\n

Platform Independence:<\/span><\/strong> C++ code can run on various platforms. This allows the same code to be used on multiple platforms.<\/p>\n

Hardware Access:<\/span><\/strong> C++ provides more direct access to the hardware. This is useful for situations that require hardware-specific operations.<\/p>\n

For these reasons, running C++ code in Kotlin is sometimes necessary. However, this may not always be the right approach and it is important to carefully evaluate the requirements of the project to determine what is the best solution for each situation.<\/p>\n

Android NDK and JNI<\/strong><\/h4>\n

The Android NDK (Native Development Kit) is a toolkit that enables the use of C and C++ code in conjunction with Android. The NDK operates in conjunction with the Java Native Interface (JNI), managing the interaction between Java code and native code.<\/p>\n

\"Android<\/p>\n


Incorporating a C++ Module into a Kotlin Project<\/strong><\/h4>\n

It is relatively straightforward. Open Android Studio and your project, then follow these steps:<\/p>\n

    \n
  1. Navigate to: File > New > New Module > Android Native Library.
    2. This will integrate the C++ module into your project, and you will observe the presence of your C++ module directory. In this article, I will refer to it as “nativelib,” which is the name of my project’s module.<\/li>\n<\/ol>\n

    Now, let’s analyze nativelib.cpp and the NativeLib Kotlin class.<\/p>\n\n\n

    <\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
    extern <\/span>"C"<\/span> JNIEXPORT jstring JNICALL<\/span><\/span>\nJava_com_example_nativelib_NativeLib_stringFromJNI<\/span>(<\/span><\/span>\n        JNIEnv<\/span>*<\/span> env,<\/span><\/span>\n        jobject <\/span>\/* this *\/<\/span>) {<\/span><\/span>\n    std::<\/span>string<\/span> hello <\/span>=<\/span> <\/span>"Hello from C++"<\/span>;<\/span><\/span>\n    <\/span>return<\/span> env<\/span>-><\/span>NewStringUTF<\/span>(hello.<\/span>c_str<\/span>());<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

    JNIEnv is the Java Native Interface (JNI) environment. It is a data structure that provides access to the Java environment from native code. The JNI environment is passed to native functions by the Java Virtual Machine (JVM) when a native function is called from Java code.<\/p>\n
    jobject is a handle to a Java object. It is a value that represents a Java object in native code. The JNI environment provides functions for creating, accessing, and destroying jobjects.<\/p>\n
    In the provided code snippet, the Java_com_example_nativelib_NativeLib_stringFromJNI()<\/em><\/strong> function is a native function that is called from Java code. The function takes two arguments:<\/p>\n
    JNIEnv* env:<\/strong> This is the JNI environment.
    jobject \/* this *\/:<\/strong> This is a handle to the Java object that called the native function. The placeholder \/* this *\/ indicates that the value of this argument is not used in the function.
    The function creates a std::string object that contains the string “Hello from C++”. It then calls the env->NewStringUTF() function to create a new Java string object from the std::string object. Finally, it returns the Java string object to the JVM.<\/p>\n\n\n
    <\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
    class<\/span> <\/span>NativeLib<\/span> {<\/span><\/span>\n<\/span>\n    <\/span>\/**<\/span><\/span>\n     * A native method that is implemented by the 'nativelib' native library,<\/span><\/span>\n     * which is packaged with this application.<\/span><\/span>\n     *\/<\/span><\/span>\n    <\/span>external<\/span> <\/span>fun<\/span> <\/span>stringFromJNI<\/span>(): String<\/span><\/span>\n<\/span>\n    <\/span>companion<\/span> <\/span>object<\/span> {<\/span><\/span>\n        <\/span>\/\/ Used to load the 'nativelib' library on application startup.<\/span><\/span>\n        <\/span>init<\/span> {<\/span><\/span>\n            System.<\/span>loadLibrary<\/span>(<\/span>"nativelib"<\/span>)<\/span><\/span>\n        }<\/span><\/span>\n    }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

    This code defines a Kotlin class NativeLib. The class has one method, stringFromJNI(), which is a native method. This means that the method is implemented in native code, such as C or C++. The external keyword tells Kotlin that the method is implemented in native code and that it needs to be loaded from a native library.<\/p>\n
    The class also has a companion object, which is a special type of object that is associated with the class itself, rather than with individual instances of the class. The companion object contains an initialization block (init), which is used to load the ‘nativelib’ native library on application startup. The System.loadLibrary() function is used to load the library from the application’s APK file.\u00a0<\/p>\n
    Let us create a function in C++ that adds two integers and returns the result as an integer.<\/p>\n\n\n
    <\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
    #include <\/span><<\/span>jni.h<\/span>><\/span><\/span>\n#include <\/span><<\/span>string<\/span>><\/span><\/span>\n<\/span>\n<\/span>\nextern <\/span>"C"<\/span> JNIEXPORT jint JNICALL<\/span><\/span>\nJava_com_example_nativelib_NativeLib_sumTwoNumbers<\/span>(JNIEnv <\/span>*<\/span>env,jobject, int x, int y) {<\/span><\/span>\n    <\/span>return<\/span> x<\/span>+<\/span>y;<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

    Subsequently, create an external function to facilitate access to this C++ function in Kotlin<\/p>\n\n\n
    <\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
    class<\/span> <\/span>NativeLib<\/span> {<\/span><\/span>\n    <\/span>external<\/span> <\/span>fun<\/span> <\/span>sumTwoNumbers<\/span>(x:Int, y:Int): Int<\/span><\/span>\n    <\/span>companion<\/span> <\/span>object<\/span> {<\/span><\/span>\n        <\/span>init<\/span> {<\/span><\/span>\n            System.<\/span>loadLibrary<\/span>(<\/span>"nativelib"<\/span>)<\/span><\/span>\n        }<\/span><\/span>\n    }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n\n\n
    <\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
    class<\/span> <\/span>MainActivity<\/span> : ComponentActivity() {<\/span><\/span>\n    <\/span>override<\/span> <\/span>fun<\/span> <\/span>onCreate<\/span>(savedInstanceState: Bundle?) {<\/span><\/span>\n        <\/span>super<\/span>.<\/span>onCreate<\/span>(savedInstanceState)<\/span><\/span>\n<\/span>\n        <\/span>val<\/span> nativeLib <\/span>=<\/span> <\/span>NativeLib<\/span>()<\/span><\/span>\n        <\/span>val<\/span> total <\/span>=<\/span> nativeLib.<\/span>sumTwoNumbers<\/span>(<\/span>15<\/span>, <\/span>17<\/span>)<\/span><\/span>\n        <\/span>setContent<\/span> {<\/span><\/span>\n            <\/span>TestCProjectTheme<\/span> {<\/span><\/span>\n                <\/span>Surface<\/span>(<\/span><\/span>\n                    modifier <\/span>=<\/span> Modifier.<\/span>fillMaxSize<\/span>(),<\/span><\/span>\n                    color <\/span>=<\/span> MaterialTheme.colorScheme.background<\/span><\/span>\n                ) {<\/span><\/span>\n                    <\/span>Text<\/span>(<\/span><\/span>\n                        text <\/span>=<\/span> total.<\/span>toString<\/span>()<\/span><\/span>\n                    )<\/span><\/span>\n                }<\/span><\/span>\n            }<\/span><\/span>\n        }<\/span><\/span>\n    }<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n

    Here, it is important to note that the C++ code’s function name must include the module name you used when creating the C++ module.<\/p>","protected":false},"excerpt":{"rendered":"
    In certain situations, you may need to utilize a C++ module within Kotlin through the Android NDK. In this article, I will elucidate the process of executing C++ code in Kotlin and explore the reasons why such a need may arise. There may be several reasons why C++ code is needed in Kotlin: Performance: C++ is usually faster than Kotlin because it is a low-level language and closer to the hardware. This is important for applications that are CPU-intensive. Existing Libraries: There are many powerful and optimized libraries written in C++. Using these libraries can be more efficient for solving…<\/p>\n","protected":false},"author":1,"featured_media":827,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[29],"tags":[],"class_list":["post-842","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-kotlin"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/842","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/comments?post=842"}],"version-history":[{"count":6,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/842\/revisions"}],"predecessor-version":[{"id":849,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/posts\/842\/revisions\/849"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/media\/827"}],"wp:attachment":[{"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/media?parent=842"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/categories?post=842"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/barisuslucan.com\/en\/wp-json\/wp\/v2\/tags?post=842"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}