Build OTIO for Android and add GitHub Actions workflow (#3)

* Initialize android build

* Update gradle.yml

* Update gradle.yml

* Add Android build instructions to README.md

* Update OpenTimelineIO and fix include paths

* remove submodule

* Fix submodule and abi

* Remove comments and unintentional debug leftovers

Author: KarthikRIyer

.github/workflows/gradle.yml

@@ -43,6 +43,25 @@ jobs:
         name: Package-${{ matrix.os }}
         path: build/natives/bin/Release
 
+  android:
+    name: Build for android
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install NDK and CMake
+        shell: bash
+        run: $ANDROID_HOME/tools/bin/sdkmanager "ndk;22.0.7026061" "cmake;3.10.2.4988404"
+      - uses: actions/checkout@v2
+        with:
+          submodules: 'recursive'
+      - name: Build
+        shell: bash
+        run: ./gradlew build -x test -PandroidBuild -Psdk_path=$ANDROID_HOME
+      - name: Upload artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: Android-JAR
+          path: build/libs
+  
   combine:
     name: Download platform-specific binaries and combine into single JAR
     needs: [build]

.gitmodules

@@ -1,4 +1,3 @@
 [submodule "deps/OpenTimelineIO"]
 	path = deps/OpenTimelineIO
 	url = https://github.com/PixarAnimationStudios/OpenTimelineIO
-	branch = master

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
 
 project(jotio VERSION 0.14.0 LANGUAGES CXX)
 
@@ -11,7 +11,11 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/$<CONFIG>/${CMAKE_SYS
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/${CMAKE_SYSTEM_NAME})
 
 # jvm
-find_package(Java REQUIRED)
+if(NOT DEFINED ANDROID_ABI)
+    find_package(Java REQUIRED)
+else()
+    set(JAVA_INCLUDE_PATH2 NotNeeded)
+endif()
 # https://stackoverflow.com/questions/51047978/cmake-could-not-find-jni
 set(JAVA_AWT_LIBRARY NotNeeded)
 set(JAVA_JVM_LIBRARY NotNeeded)
@@ -36,6 +40,14 @@ if(NOT CMAKE_BUILD_TYPE)
       FORCE)
 endif()
 
+set(OTIO_PYTHON_INSTALL OFF CACHE BOOL "")
+set(OTIO_CXX_INSTALL OFF CACHE BOOL "")
+set(OTIO_DEPENDENCIES_INSTALL OFF CACHE BOOL "")
+set(OTIO_INSTALL_COMMANDLINE_TOOLS OFF CACHE BOOL "")
+set(OTIO_SHARED_LIBS ON)
+
+set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
+
 include_directories(src/main/include)
 add_subdirectory(deps/OpenTimelineIO build/natives)
 add_subdirectory(src/main/cpp)

README.md

@@ -65,6 +65,70 @@ gradle build # this builds and runs all tests
 
 You can find the generated jar file in the `build/libs` directory.
 
+Building OpenTimelineIO-Java-Bindings for Android
+------------------------
+
+This has been built and tested on Ubuntu 18.04LTS.
+
+Install Android Studio according to these [steps](https://developer.android.com/studio).
+
+Install NDK and CMake using [sdkmanager](https://developer.android.com/studio/command-line/sdkmanager) as follows:
+
+`sdkmanager "ndk;22.0.7026061" "cmake;3.10.2.4988404"`
+
+You can find `sdkmanager` in `$ANDROID_HOME/tools/bin/`. `$ANDROID_HOME` is the location of Android SDK which is generally `~/Android/Sdk`.
+
+Set the `ANDROID_HOME` environment variable and from the root directory of the project run:
+
+```console
+gradle clean
+gradle build -x test -PandroidBuild -Psdk_path=$ANDROID_HOME
+```
+
+You'll find the JAR in `build/libs`
+
+#### How to include the Android JAR in your project
+
+Copy the JAR to the `libs` directory and add this to the app level `build.gradle`:
+
+```groovy
+android {
+    ...
+    
+    ndkVersion '22.0.7026061'
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+    ...
+}
+
+task unjar {
+    ant.unzip(src: 'libs/java-opentimelineio-0.14.0.jar', dest: 'JARUnzip')
+
+    copy {
+        from 'JARUnzip/arm64-v8a'
+        into 'src/main/jniLibs/arm64-v8a'
+    }
+    copy {
+        from 'JARUnzip/x86_64'
+        into 'src/main/jniLibs/x86_64'
+    }
+}
+
+build.dependsOn unjar
+
+dependencies {
+    ...
+    implementation fileTree(dir: "libs", include: ["*.jar"])
+    implementation files('libs/java-opentimelineio-0.14.0.jar')
+    ...
+}
+
+```
+
+
 Examples
 --------
 

build.gradle

@@ -66,7 +66,21 @@ task compileJNI {
             if (OperatingSystem.current().isLinux() ||
                     OperatingSystem.current().isMacOsX() ||
                     OperatingSystem.current().isUnix()) {
-                commandLine 'sh', '-c', 'mkdir -p build/natives && cd build/natives && cmake ../.. && cmake --build . --config Release'
+                if (project.hasProperty("androidBuild") && project.hasProperty("sdk_path")){
+                    def sdk_path = project.getProperties().getAt('sdk_path').toString()
+                    commandLine 'sh', '-c', 'mkdir -p build/natives && ' +
+                            'cd build/natives && ' +
+                            'cmake -G"Ninja" -DANDROID_ABI=arm64-v8a -DANDROID_NDK='+sdk_path+'/ndk/22.0.7026061 -DCMAKE_BUILD_TYPE=Release -DCMAKE_MAKE_PROGRAM='+sdk_path+'/cmake/3.10.2.4988404/bin/ninja -DCMAKE_TOOLCHAIN_FILE='+sdk_path+'/ndk/22.0.7026061/build/cmake/android.toolchain.cmake -DANDROID_NATIVE_API_LEVEL=23 -DANDROID_TOOLCHAIN=clang ../.. && ' +
+                            'cmake --build . --config Release && ' +
+                            'mv lib/Release/Android/ lib/Release/arm64-v8a && ' +
+                            'rm CMakeCache.txt && ' +
+                            'cmake -G"Ninja" -DANDROID_ABI=x86_64 -DANDROID_NDK='+sdk_path+'/ndk/22.0.7026061 -DCMAKE_BUILD_TYPE=Release -DCMAKE_MAKE_PROGRAM='+sdk_path+'/cmake/3.10.2.4988404/bin/ninja -DCMAKE_TOOLCHAIN_FILE='+sdk_path+'/ndk/22.0.7026061/build/cmake/android.toolchain.cmake -DANDROID_NATIVE_API_LEVEL=23 -DANDROID_TOOLCHAIN=clang ../.. && ' +
+                            'cmake --build . --config Release && ' +
+                            'mv lib/Release/Android/ lib/Release/x86_64'
+                }
+                else {
+                    commandLine 'sh', '-c', 'mkdir -p build/natives && cd build/natives && cmake ../.. && cmake --build . --config Release'
+                }
             } else if (OperatingSystem.current().isWindows()) {
                 commandLine "cmd", "/c", 'if not exist "build\\natives" mkdir build\\natives && cd build\\natives && cmake ..\\.. && cmake --build . --config Release'
             }

deps/OpenTimelineIO

@@ -1,4 +1,4 @@
-add_library(jotio-${CMAKE_PROJECT_VERSION} SHARED
+add_library(jotio SHARED
         io_opentimeline_OTIOFinalizer.cpp
         class_codes.cpp
         utilities.cpp
@@ -41,8 +41,10 @@ add_library(jotio-${CMAKE_PROJECT_VERSION} SHARED
         io_opentimeline_opentimelineio_Deserialization.cpp
         io_opentimeline_opentimelineio_OTIOTest.cpp)
 
-target_include_directories(jotio-${CMAKE_PROJECT_VERSION} PUBLIC
-        "${PROJECT_SOURCE_DIR}/../")
+target_include_directories(jotio PUBLIC
+        "${PROJECT_SOURCE_DIR}/deps/OpenTimelineIO/src"
+        "${PROJECT_SOURCE_DIR}/deps/OpenTimelineIO/src/deps"
+        "${PROJECT_SOURCE_DIR}/deps/OpenTimelineIO/src/deps/optional-lite/include")
 
-target_link_libraries(jotio-${CMAKE_PROJECT_VERSION} opentime)
-target_link_libraries(jotio-${CMAKE_PROJECT_VERSION} opentimelineio)
+target_link_libraries(jotio opentime)
+target_link_libraries(jotio opentimelineio)

src/main/cpp/CMakeLists.txt

@@ -18,14 +18,17 @@ private static String getOSName() {
         String osName = System.getProperty("os.name").toLowerCase();
         if (osName.contains("win")) return "Windows";
         else if (osName.contains("mac")) return "Darwin";
-        else if (osName.contains("nux")) return "Linux";
+        else if (osName.contains("nux")) {
+            if(System.getProperty("java.vm.name").toLowerCase().contains("dalvik"))
+                return "Android";
+            return "Linux";
+        }
         return "";
     }
 
     public static void load(String name) {
         if (libLoaded)
             return;
-        name += ("-" + OTIO_VERSION);
         final String libname = System.mapLibraryName(name);
         final String opentimelibname = System.mapLibraryName("opentime");
         final String OTIOlibname = System.mapLibraryName("opentimelineio");