Groupcalls

.github/workflows/build.yml

@@ -0,0 +1,89 @@
+name: Build and publish snapshots
+on:
+  push:
+    branches: [ javabuild ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: javabuild
+    - name: Install latest bash on macOS
+      if: runner.os == 'macOS'
+      run: |
+        brew update
+        brew install bash
+        brew install coreutils
+    - name: Set environment variables
+      run: |
+        echo "OS=${RUNNER_OS,,}" >> $GITHUB_ENV
+        echo "ARCH=${RUNNER_ARCH,,}" >> $GITHUB_ENV
+        if [[ ${{ runner.os }} == "Linux" ]]
+        then
+          platform=unix
+          classifier=linux-x86_64
+        elif [[ ${{ runner.os }} == "macOS" ]]
+        then
+          platform=mac
+          if [[ ${{ runner.arch }} == "X64" ]]
+          then
+            classifier=darwin-x86_64
+          else
+            classifier=darwin-aarch64
+          fi
+        elif [[ ${{ runner.os }} == "Windows" ]]
+        then
+          platform=windows
+          classifier=win-x86_64
+        fi
+        echo "PLATFORM=$platform" >> $GITHUB_ENV
+        echo "CLASSIFIER=$classifier" >> $GITHUB_ENV
+      shell: bash
+    - name: Download OpenJDK 19
+      id: download
+      uses: oracle-actions/setup-java@v1
+      with:
+        website: jdk.java.net
+        release: 19
+        install: false
+    - name: Setup Java and Apache Maven
+      uses: actions/setup-java@v3
+      with:
+        distribution: jdkfile
+        jdkFile: ${{ steps.download.outputs.archive }}
+        java-version: ${{ steps.download.outputs.version }}
+        server-id: gluon-nexus
+        server-username: MAVEN_USERNAME
+        server-password: MAVEN_CENTRAL_TOKEN
+    - name: Checkout tools repo
+      run: |
+        echo "print env variables"
+        echo ${{ env.OS }}
+        echo ${{ env.ARCH }}
+        echo ${{ env.PLATFORM }}
+        echo ${{ env.CLASSIFIER }}
+        cd $GITHUB_WORKSPACE
+        git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git
+    - name: Install rustup
+      run: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+    - name: Download and extract JEXTRACT
+      run: |
+        download_url="https://download.java.net/java/early_access/jextract/2/openjdk-19-jextract+2-3_${{ env.OS }}-${{ env.ARCH }}_bin.tar.gz"
+        wget -q --show-progress -O $RUNNER_TEMP/jextract.tar.gz $download_url
+        tar -xvzf $RUNNER_TEMP/jextract.tar.gz -C $GITHUB_WORKSPACE
+    - name: Build
+      run: |
+        export PATH=$GITHUB_WORKSPACE/depot_tools/:$PATH
+        make java PLATFORM=${{ env.PLATFORM }} JEXTRACT=$GITHUB_WORKSPACE/jextract-19 JDK=$JAVA_HOME TARGET_ARCH=${{ env.ARCH }} MACOS_SDK_VERSION=12.1
+    - name: Deploy snapshot
+      run: |
+        cd src/java/tring
+        mvn -Dclassifier=${{ env.CLASSIFIER }} deploy
+      env:
+        MAVEN_USERNAME: ${{ secrets.GLUON_NEXUS_USERNAME }}
+        MAVEN_CENTRAL_TOKEN: ${{ secrets.GLUON_NEXUS_PASSWORD }}

.gitignore

@@ -14,3 +14,9 @@ src/jar.list
 .project
 .classpath
 org.eclipse.buildship.core.prefs
+src/java/build
+src/java/tring/src/gen-sources
+src/java/tring/src/main/resources/libringrtc.dylib
+src/java/tring/target
+src/java/tringapi/target/
+src/rust/tringlib.h

Makefile

@@ -32,10 +32,11 @@ help:
 	$(Q) echo "  ios      -- download WebRTC and build for the iOS platform"
 	$(Q) echo "  android  -- download WebRTC and build for the Android platform"
 	$(Q) echo "  electron -- build an Electron library"
+	$(Q) echo "  java     -- build a Java library"
 	$(Q) echo "  cli      -- build the test cli (1:1 calls)"
 	$(Q) echo "  gctc     -- build the test cli (group calls)"
 	$(Q) echo
-	$(Q) echo "For the electon/cli/gctc builds, you can specify an optional platform"
+	$(Q) echo "For the electron/java/cli/gctc builds, you can specify an optional platform"
 	$(Q) echo "which will download WebRTC. For example:"
 	$(Q) echo "  $ make electron PLATFORM=unix"
 	$(Q) echo
@@ -86,6 +87,14 @@ electron:
 	fi
 	$(Q) (cd src/node && yarn install && yarn build)
 
+java:
+	$(Q) if [ "$(PLATFORM)" != "" ] ; then \
+		echo "java: Preparing workspace for $(PLATFORM)" ; \
+		./bin/prepare-workspace $(PLATFORM) ; \
+	fi
+	echo "java: Release build" ; \
+	./bin/build-java -r
+
 cli:
 	$(Q) if [ "$(PLATFORM)" != "" ] ; then \
 		echo "cli: Preparing workspace for $(PLATFORM)" ; \
@@ -119,6 +128,7 @@ clean:
 	$(Q) ./bin/build-gctc --clean
 	$(Q) ./bin/build-electron --clean
 	$(Q) ./bin/build-ios --clean
+	$(Q) ./bin/build-java --clean
 	$(Q) rm -rf ./src/webrtc/src/out
 
 PHONY += distclean

bin/build-java

@@ -0,0 +1,163 @@
+#!/bin/sh
+
+#
+# Copyright 2019-2021 Signal Messenger, LLC
+# SPDX-License-Identifier: AGPL-3.0-only
+#
+
+set -e
+
+# shellcheck source=bin/env.sh
+. "$(dirname "$0")"/env.sh
+
+JEXTRACT=${JEXTRACT:-/opt/jextract-19}
+JDK=${JDK:-/opt/jdk-19}
+TARGET_ARCH=${TARGET_ARCH:-x64}
+
+# darwin only
+DEFAULT_MACOS_SDK_VERSION="12.3"
+MACOS_SDK_VERSION=${MACOS_SDK_VERSION:-$DEFAULT_MACOS_SDK_VERSION}
+MACOS_SDK_PATH="/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX${MACOS_SDK_VERSION}.sdk"
+
+usage()
+{
+    echo 'usage: build-java [-d|-r|-c]
+    where:
+        -r to create a release build
+        -d to create a debug build (which may fail to build!)
+        -c to clean the build artifacts'
+}
+
+clean()
+{
+    # Remove all possible artifact directories.
+    rm -rf ./src/rust/target/debug
+    rm -rf ./src/rust/target/release
+    rm -rf ./src/webrtc/src/out/debug
+    rm -rf ./src/webrtc/src/out/release
+    mvn -f ./src/java/tring clean
+}
+
+BUILD_TYPE=release
+
+while [ "$1" != "" ]; do
+    case $1 in
+        -d | --debug )
+            BUILD_TYPE=debug
+            ;;
+        -r | --release )
+            BUILD_TYPE=release
+            ;;
+        -c | --clean )
+            clean
+            exit
+            ;;
+        -h | --help )
+            usage
+            exit
+            ;;
+        * )
+            usage
+            exit 1
+    esac
+    shift
+done
+
+case "$TARGET_ARCH" in
+    "x64")
+        GN_ARCH=x64
+        CARGO_ARCH=x86_64
+        ;;
+    "ia32")
+        GN_ARCH=x86
+        CARGO_ARCH=i686
+        ;;
+    "arm64")
+        GN_ARCH=arm64
+        CARGO_ARCH=aarch64
+        ;;
+    *)
+        echo "Unsupported architecture"
+        exit 1
+        ;;
+esac
+
+hash rustup 2>/dev/null || { echo >&2 "Make sure you have rustup installed and properly configured! Aborting."; exit 1; }
+
+RUSTFLAGS_WIN=
+
+case "$(rustup show active-toolchain)" in 
+    *"x86_64-apple-darwin"* | *"aarch64-apple-darwin"* )
+        DEFAULT_PLATFORM="darwin"
+        CARGO_TARGET="${CARGO_ARCH}-apple-darwin"
+        ;;
+    *"x86_64-pc-windows"* )
+        DEFAULT_PLATFORM="win32"
+        CARGO_TARGET="${CARGO_ARCH}-pc-windows-msvc"
+        # Static linking to prevent build errors on Windows ia32
+        RUSTFLAGS_WIN="-C target-feature=+crt-static"
+        ;;
+    *"x86_64-unknown-linux"* )
+        DEFAULT_PLATFORM="linux"
+        CARGO_TARGET="${CARGO_ARCH}-unknown-linux-gnu"
+        ;;
+    * )
+        printf "Unknown platform detected!\nPlease make sure you have installed a valid Rust toolchain via rustup! Aborting.\n"
+        exit 1
+esac
+
+echo "Building for platform ${DEFAULT_PLATFORM}, TARGET_ARCH=${TARGET_ARCH}, GN_ARCH=${GN_ARCH}, CARGO_TARGET=${CARGO_TARGET}", OUTPUT_DIR=${OUTPUT_DIR}
+
+export MACOSX_DEPLOYMENT_TARGET="10.10"
+
+# Build WebRTC.
+(
+    cd src/webrtc/src
+    WEBRTC_ARGS="target_cpu=\"${GN_ARCH}\" rtc_build_examples=false rtc_build_tools=false rtc_include_tests=false rtc_enable_protobuf=false rtc_use_x11=false rtc_enable_sctp=false rtc_libvpx_build_vp9=true rtc_include_ilbc=false"
+
+    if [ "${BUILD_TYPE}" = "debug" ]
+    then
+        gn gen -C "${OUTPUT_DIR}"/debug "--args=${WEBRTC_ARGS}"
+        ninja -C "${OUTPUT_DIR}"/debug
+    else
+        gn gen -C "${OUTPUT_DIR}"/release "--args=${WEBRTC_ARGS} is_debug=false"
+        ninja -C "${OUTPUT_DIR}"/release
+    fi
+)
+
+# Build and link the final RingRTC library.
+(
+    cd src/rust
+
+    if [ "${BUILD_TYPE}" = "debug" ]
+    then
+        RUSTFLAGS="${RUSTFLAGS_WIN}" OUTPUT_DIR="${OUTPUT_DIR}" cargo build --target ${CARGO_TARGET} --features java
+    else
+        OUTPUT_DIR="${OUTPUT_DIR}" cargo build --target ${CARGO_TARGET} --lib --features java --release
+    fi
+
+    mkdir -p ../java/tring/src/main/resources
+    if [ $DEFAULT_PLATFORM = "darwin" ]
+    then
+        mkdir -p ../java/build/darwin
+        cp -f target/${CARGO_TARGET}/${BUILD_TYPE}/libringrtc.dylib ../java/tring/src/main/resources/libringrtc.dylib
+        # cp -f target/${CARGO_TARGET}/${BUILD_TYPE}/libringrtc.dylib ../java/build/darwin/libringrtc-"${TARGET_ARCH}"
+        ${JEXTRACT}/bin/jextract -I${JDK}include -I${JDK}/include/darwin -I${MACOS_SDK_PATH}/usr/include --output ../java/tring/src/gen-sources/java --source -t io.privacyresearch.tring tringlib.h
+    elif [ $DEFAULT_PLATFORM = "win32" ]
+    then
+        mkdir -p ../java/build/win32
+        cp -f target/${CARGO_TARGET}/${BUILD_TYPE}/ringrtc.dll ../java/build/win32/libringrtc-"${TARGET_ARCH}".java
+        ${JEXTRACT}/bin/jextract -I${JDK}include -I${JDK}/include/win32 --output ../java/tring/src/main/java --source -t io.privacyresearch.tring tringlib.h
+    elif [ $DEFAULT_PLATFORM = "linux" ]
+    then
+        mkdir -p ../java/build/linux
+        cp -f target/${CARGO_TARGET}/${BUILD_TYPE}/libringrtc.so ../java/tring/src/main/resources/libringrtc.so
+        #cp -f target/${CARGO_TARGET}/${BUILD_TYPE}/libringrtc.so ../java/build/linux/libringrtc-"${TARGET_ARCH}".java
+        ${JEXTRACT}/bin/jextract -I${JDK}include -I${JDK}/include/linux --output ../java/tring/src/main/java --source -t io.privacyresearch.tring tringlib.h
+    fi
+    cd ../java/tringapi
+    mvn clean install
+    cd ../tring
+    echo "mvn -Dclassifier=$DEFAULT_PLATFORM-$CARGO_ARCH clean install"
+    mvn -Dclassifier=$DEFAULT_PLATFORM-$CARGO_ARCH clean install
+)

src/java/README.md

@@ -0,0 +1,14 @@
+The Java implementation consists of 2 Java projects, and a Rust component.
+
+tringapi: this contains the API that can be accessed by the application,
+without any dependencies (no application model classes or ringrtc structs).
+It uses the Java ServiceLoader concept to find implementations of the
+TringService.
+
+tring: this contains platform-specific implementations of the TringService.
+The source code is mainly auto-generated by jextract. The implementation
+itself is in TringServiceImpl, and it is made available via module-info.java
+
+Rust component:
+java.rs contains the implementation of methods invoked by TringServiceImpl.
+It is similar to electron.js