JNI Builds Enhancements & CMake Dependency Enhancements (#1237)

* Build optimizations

* Build PIC in JNI only path

* Make parallel optional

Author: sirknightj

.github/workflows/ci.yml

@@ -45,6 +45,14 @@ jobs:
 
   mac-os-build-gcc:
     runs-on: macos-13
+    strategy:
+      matrix:
+        parallel-build:
+          - ON
+          - OFF
+
+      fail-fast: false
+
     permissions:
       id-token: write
       contents: read
@@ -62,17 +70,25 @@ jobs:
       - name: Build repository
         run: |
           mkdir build && cd build
-          cmake .. -DBUILD_TEST=TRUE -DCMAKE_INSTALL_PREFIX=.
-          make
-          make install
+          cmake .. -DBUILD_TEST=TRUE -DCMAKE_INSTALL_PREFIX=. -DPARALLEL_BUILD=${{ matrix.parallel-build }}
+
+          if [[ "${{ matrix.parallel-build }}" == 'ON' ]]; then
+            make
+            make -j install
+          else
+            make
+            make install
+          fi
       - name: Configure AWS Credentials
+        if: ${{ matrix.parallel-build == 'ON' }} # Only need to run the tests once
         uses: aws-actions/configure-aws-credentials@v1-node16
         with:
           role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
           role-session-name: ${{ secrets.AWS_ROLE_SESSION_NAME }}
           aws-region: ${{ secrets.AWS_REGION }}
           role-duration-seconds: 10800
       - name: Run tests
+        if: ${{ matrix.parallel-build == 'ON' }}
         run: |
           cd build
           ./tst/producerTest
@@ -242,6 +258,15 @@ jobs:
 
   ubuntu-gcc:
     runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        parallel-build:
+          - ON
+          - OFF
+
+      fail-fast: false
+
     env:
       AWS_KVS_LOG_LEVEL: 2
       CC: gcc
@@ -260,17 +285,24 @@ jobs:
       - name: Build repository
         run: |
           mkdir build && cd build
-          cmake .. -DBUILD_TEST=TRUE -DBUILD_GSTREAMER_PLUGIN=TRUE -DBUILD_JNI=TRUE -DCMAKE_INSTALL_PREFIX=.
-          make
-          make install
+          cmake .. -DBUILD_TEST=TRUE -DBUILD_GSTREAMER_PLUGIN=TRUE -DBUILD_JNI=TRUE -DCMAKE_INSTALL_PREFIX=. -DPARALLEL_BUILD=${{ matrix.parallel-build }}
+          
+          if [[ "${{ matrix.parallel-build }}" == 'ON' ]]; then
+            make -j install
+          else
+            make install
+          fi
+
       - name: Configure AWS Credentials
+        if: ${{ matrix.parallel-build == 'ON' }} # Only need to run the tests once
         uses: aws-actions/configure-aws-credentials@v1-node16
         with:
           role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
           role-session-name: ${{ secrets.AWS_ROLE_SESSION_NAME }}
           aws-region: ${{ secrets.AWS_REGION }}
           role-duration-seconds: 10800
       - name: Run tests
+        if: ${{ matrix.parallel-build == 'ON' }}
         run: |
           cd build
           ulimit -c unlimited -S

.github/workflows/jni.yml

@@ -0,0 +1,76 @@
+name: Producer CPP JNI Builds
+
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+    branches:
+      - develop
+      - master
+
+jobs:
+  mac-os:
+    strategy:
+      matrix:
+        config:
+          - name: Intel x86_64
+            runner: macos-13
+          - name: Apple Silicon
+            runner: macos-15
+          - name: Ubuntu 22.04
+            runner: ubuntu-latest
+            container: public.ecr.aws/ubuntu/ubuntu:22.04_stable
+          - name: Ubuntu 20.04
+            runner: ubuntu-latest
+            container: public.ecr.aws/ubuntu/ubuntu:20.04_stable
+
+        java:
+          - 11
+          - 17
+          - 21
+
+      fail-fast: false
+
+    name: JNI ${{ matrix.config.name }} (Java ${{ matrix.java }})
+    runs-on: ${{ matrix.config.runner }}
+    container: ${{ matrix.config.container || '' }}
+
+    env:
+      DEBIAN_FRONTEND: noninteractive
+
+    steps:
+      - name: Setup XCode
+        if: ${{ runner.os == 'macOS' }}
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: latest-stable
+
+      - name: Install Dependencies (Linux only)
+        if: runner.os == 'Linux'
+        run: |
+          apt-get update
+          apt-get install -y git cmake build-essential
+
+      - name: Set up Java (JDK ${{ matrix.java }})
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'corretto'
+          java-version: ${{ matrix.java }}
+
+      - name: Clone repository
+        uses: actions/checkout@v4
+
+      - name: Build JNI (CMake)
+        run: |
+          mkdir build && cd build
+          cmake .. -DBUILD_JNI_ONLY=ON
+
+          # Note: Dependencies on/off shouldn't make any difference since
+          # the only dependency for the JNI is PIC
+
+      - name: Build JNI (make)
+        working-directory: ./build
+        run: |
+          make -j

CMake/Dependencies/libautoconf-CMakeLists.txt

@@ -7,6 +7,8 @@ find_program(MAKE_EXE NAMES make)
 include(ExternalProject)
 ExternalProject_Add(project_libautoconf
     URL               http://ftp.gnu.org/gnu/autoconf/autoconf-2.69.tar.gz
+    GIT_SHALLOW       TRUE
+    GIT_PROGRESS      TRUE
     PREFIX            ${CMAKE_CURRENT_BINARY_DIR}/build
     CONFIGURE_COMMAND ${CMAKE_CURRENT_BINARY_DIR}/build/src/project_libautoconf/configure --prefix=${OPEN_SRC_INSTALL_PREFIX}
     BUILD_COMMAND     ${MAKE_EXE} -j 4

CMake/Dependencies/libautomake-CMakeLists.txt

@@ -7,6 +7,8 @@ find_program(MAKE_EXE NAMES make)
 include(ExternalProject)
 ExternalProject_Add(project_libautomake
     URL               http://ftp.gnu.org/gnu/automake/automake-1.16.1.tar.gz
+    GIT_SHALLOW       TRUE
+    GIT_PROGRESS      TRUE
     PREFIX            ${CMAKE_CURRENT_BINARY_DIR}/build
     CONFIGURE_COMMAND ${CMAKE_CURRENT_BINARY_DIR}/build/src/project_libautomake/configure --prefix=${OPEN_SRC_INSTALL_PREFIX}
     BUILD_COMMAND     ${MAKE_EXE} -j 4

CMake/Dependencies/libkvscproducer-CMakeLists.txt

@@ -8,6 +8,8 @@ include(ExternalProject)
 ExternalProject_Add(libkvscproducer-download
 	GIT_REPOSITORY    https://github.com/awslabs/amazon-kinesis-video-streams-producer-c.git
 	GIT_TAG           v1.5.3
+    GIT_SHALLOW       TRUE
+    GIT_PROGRESS      TRUE
 	SOURCE_DIR        "${CMAKE_CURRENT_BINARY_DIR}/kvscproducer-src"
 	BINARY_DIR        "${CMAKE_CURRENT_BINARY_DIR}/kvscproducer-build"
 	CONFIGURE_COMMAND ""

CMake/Dependencies/libkvspic-CMakeLists.txt

@@ -0,0 +1,23 @@
+cmake_minimum_required(VERSION 3.6.3)
+
+project(libkvspic-download LANGUAGES C)
+
+include(ExternalProject)
+
+# Normally, PIC is built through Producer-C
+# When building the JNI only, Producer-C is not used at all, meaning
+# that we need to download PIC directly.
+ExternalProject_Add(libkvspic-download
+	GIT_REPOSITORY    https://github.com/awslabs/amazon-kinesis-video-streams-pic.git
+	GIT_TAG           v1.2.0
+    GIT_SHALLOW       TRUE
+    GIT_PROGRESS      TRUE
+    SOURCE_DIR        "${CMAKE_CURRENT_BINARY_DIR}/kvspic-src"
+	BINARY_DIR        "${CMAKE_CURRENT_BINARY_DIR}/kvspic-build"
+	CMAKE_ARGS
+	  -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+	CONFIGURE_COMMAND ""
+	BUILD_COMMAND     ""
+	INSTALL_COMMAND   ""
+	TEST_COMMAND      ""
+)

CMake/Dependencies/liblog4cplus-CMakeLists.txt

@@ -26,6 +26,8 @@ if (WIN32)
   ExternalProject_Add(project_log4cplus
       GIT_REPOSITORY    https://github.com/log4cplus/log4cplus
       GIT_TAG           REL_2_0_1
+      GIT_SHALLOW       TRUE
+      GIT_PROGRESS      TRUE
       PREFIX            ${CMAKE_CURRENT_BINARY_DIR}/build
       TEST_COMMAND      ""
       CMAKE_ARGS        -DCMAKE_INSTALL_PREFIX=${OPEN_SRC_INSTALL_PREFIX} -DLOG4CPLUS_BUILD_TESTING=0 -DLOG4CPLUS_BUILD_LOGGINGSERVER=0 -DUNICODE=0 -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS}
@@ -34,6 +36,8 @@ else()
   ExternalProject_Add(project_log4cplus
        GIT_REPOSITORY    https://github.com/log4cplus/log4cplus
        GIT_TAG           REL_2_0_1
+       GIT_SHALLOW       TRUE
+       GIT_PROGRESS      TRUE
        PREFIX            ${CMAKE_CURRENT_BINARY_DIR}/build
        CONFIGURE_COMMAND ${CONFIGURE_COMMAND}
        BUILD_COMMAND     ${MAKE_EXE}

CMake/Utilities.cmake

@@ -1,13 +1,20 @@
 # only fetch target repo for add_subdirectory later
 function(fetch_repo lib_name)
   set(supported_libs
+      kvspic
       kvscproducer)
   list(FIND supported_libs ${lib_name} index)
   if(${index} EQUAL -1)
     message(WARNING "${lib_name} is not supported for fetch_repo")
     return()
   endif()
 
+  if (WIN32 OR NOT PARALLEL_BUILD)
+    set(PARALLEL_BUILD "")  # No parallel build for Windows
+  else()
+    set(PARALLEL_BUILD "--parallel")  # Enable parallel builds for Unix-like systems
+  endif()
+
   # build library
   configure_file(
     ./CMake/Dependencies/lib${lib_name}-CMakeLists.txt
@@ -21,7 +28,7 @@ function(fetch_repo lib_name)
     message(FATAL_ERROR "CMake step for lib${lib_name} failed: ${result}")
   endif()
   execute_process(
-    COMMAND ${CMAKE_COMMAND} --build .
+    COMMAND ${CMAKE_COMMAND} --build . ${PARALLEL_BUILD}
     RESULT_VARIABLE result
     WORKING_DIRECTORY ${DEPENDENCY_DOWNLOAD_PATH}/lib${lib_name})
   if(result)
@@ -34,6 +41,7 @@ function(build_dependency lib_name)
   set(supported_libs
       autoconf
       automake
+      kvspic
       log4cplus)
   list(FIND supported_libs ${lib_name} index)
   if(${index} EQUAL -1)
@@ -73,6 +81,12 @@ function(build_dependency lib_name)
 
   file(REMOVE_RECURSE ${KINESIS_VIDEO_OPEN_SOURCE_SRC}/lib${lib_name})
 
+  if (WIN32 OR NOT PARALLEL_BUILD)
+    set(PARALLEL_BUILD "")  # No parallel build for Windows
+  else()
+    set(PARALLEL_BUILD "--parallel")  # Enable parallel builds for Unix-like systems
+  endif()
+
   # build library
   configure_file(
     ${CMAKE_CURRENT_SOURCE_DIR}/CMake/Dependencies/lib${lib_name}-CMakeLists.txt
@@ -87,7 +101,7 @@ function(build_dependency lib_name)
     message(FATAL_ERROR "CMake step for lib${lib_name} failed: ${result}")
   endif()
   execute_process(
-    COMMAND ${CMAKE_COMMAND} --build .
+    COMMAND ${CMAKE_COMMAND} --build . ${PARALLEL_BUILD}
     RESULT_VARIABLE result
     WORKING_DIRECTORY ${KINESIS_VIDEO_OPEN_SOURCE_SRC}/lib${lib_name})
   if(result)