Skip to content

Latest commit

 

History

History
216 lines (168 loc) · 8.93 KB

README.md

File metadata and controls

216 lines (168 loc) · 8.93 KB

NNStreamer API Library for Android

Prerequisite

We assume that you already have experienced Android application developments with Android Studio.

  • Host PC:
    • OS: Ubuntu 16.04 / 18.04 x86_64 LTS
    • Android Studio: Ubuntu version
    • Android SDK: Min version 24 (Nougat)
    • Android NDK: Use default ndk-bundle in Android Studio
    • GStreamer: gstreamer-1.0-android-universal-1.16.2

Build library

Environment variables

First of all, you need to set-up the development environment as following:

$ export ANDROID_DEV_ROOT=$HOME/Android           # Set your own path (default location: $HOME/Android)
$ mkdir -p $ANDROID_DEV_ROOT/tools/sdk
$ mkdir -p $ANDROID_DEV_ROOT/tools/ndk
$ mkdir -p $ANDROID_DEV_ROOT/gstreamer-1.0
$ mkdir -p $ANDROID_DEV_ROOT/workspace
$
$ vi ~/.bashrc
# The environment variables to develop an Android application with NNStreamer
#
export JAVA_HOME=/opt/android-studio/jre            # JRE path in Android Studio
export ANDROID_DEV_ROOT=$HOME/android               # Set your own path (default location: "$HOME/Android".)

# $ANDROID_DEV_ROOT/tools/sdk/: Android SDK root directory (default location: $HOME/Android/Sdk)
# $ANDROID_DEV_ROOT/tools/ndk/: Android NDK root directory (default location: $HOME/Android/Sdk/ndk/<ndk-version>)
# $ANDROID_DEV_ROOT/gstreamer-1.0/: GStreamer binaries
# $ANDROID_DEV_ROOT/workspace/nnstreamer/: The git repository of NNStreamer

export ANDROID_SDK=$ANDROID_DEV_ROOT/tools/sdk
export ANDROID_NDK=$ANDROID_DEV_ROOT/tools/ndk
export ANDROID_SDK_ROOT=$ANDROID_SDK
export ANDROID_NDK_ROOT=$ANDROID_NDK
export GSTREAMER_ROOT_ANDROID=$ANDROID_DEV_ROOT/gstreamer-1.0
export NNSTREAMER_ROOT=$ANDROID_DEV_ROOT/workspace/nnstreamer

Install required packages

Some required packages should be installed as below.

$ sudo apt install subversion curl pkg-config

Download Android Studio

Download and install Android Studio to compile an Android source code. You can see the installation guide here.

For example,

$ firefox  https://developer.android.com/studio &
Then, download the **Android Studio** IDE into the /opt folder as follows.
$ cd /opt
$ sudo curl -O https://r1---sn-n5hn0ob-pjoe.gvt1.com/edgedl/android/studio/ide-zips/3.6.3.0/android-studio-ide-192.6392135-linux.tar.gz
$ sudo tar xvzf ./android-studio-ide-183.5452501-linux.tar.gz

Now, run the Android Studio IDE as follows.

$ /opt/android-studio/bin/studio.sh

Finally, install SDK into the $ANDROID_SDK folder as follows. The yes command automatically agrees to the license question for the Android SDK.

$ cd $ANDROID_SDK/tools/bin
$ yes | ./sdkmanager --licenses

Proxy Setting

If your network is maintained a proxy of the office, you need to set-up the proxy and SSL configuration.

  • Proxy setting: File > Settings > Appearance & Behavior > System Settings > HTTP Proxy
  • SSL Certificate: File > Settings > Tools > Server Certificates > Register your certificate and check Accept non-trusted certificates automatically

Download NDK

Use the default NDK in Android Studio. To install NDK in Android Studio, navigate to configure -> Appearance & Behavior -> System Settings -> Android SDK -> SDK Tools and then select NDK.

If you need to set a specific version, download and decompress it to compile normally a GStreamer-based plugin (e.g., NNStreamer). You can download older version from here.

Download GStreamer binaries

You can get the prebuilt GStreamer binaries from here.

For example,

$ cd $ANDROID_DEV_ROOT/gstreamer-1.0
$ curl -O https://gstreamer.freedesktop.org/data/pkg/android/1.16.2/gstreamer-1.0-android-universal-1.16.2.tar.xz
$ tar xJf gstreamer-1.0-android-universal-1.16.2.tar.xz

Modify the gstreamer-1.0.mk file for NDK build to prevent build error. Supported target ABIs are arm64 and armv7.

$GSTREAMER_ROOT_ANDROID/{Target-ABI}/share/gst-android/ndk-build/gstreamer-1.0.mk
  • Add directory separator.
@@ -127,2 +127,2 @@

GSTREAMER_PLUGINS_CLASSES    := $(strip \
            $(subst $(GSTREAMER_NDK_BUILD_PATH),, \
            $(foreach plugin,$(GSTREAMER_PLUGINS), \
-           $(wildcard $(GSTREAMER_NDK_BUILD_PATH)$(plugin)/*.java))))
+           $(wildcard $(GSTREAMER_NDK_BUILD_PATH)/$(plugin)/*.java))))

GSTREAMER_PLUGINS_WITH_CLASSES := $(strip \
            $(subst $(GSTREAMER_NDK_BUILD_PATH),, \
            $(foreach plugin, $(GSTREAMER_PLUGINS), \
-           $(wildcard $(GSTREAMER_NDK_BUILD_PATH)$(plugin)))))
+           $(wildcard $(GSTREAMER_NDK_BUILD_PATH)/$(plugin)))))

@@ -257,1 +257,1 @@

copyjavasource_$(TARGET_ARCH_ABI):
  $(hide)$(call host-mkdir,$(GSTREAMER_JAVA_SRC_DIR)/org/freedesktop/gstreamer)
    $(hide)$(foreach plugin,$(GSTREAMER_PLUGINS_WITH_CLASSES), \
        $(call host-mkdir,$(GSTREAMER_JAVA_SRC_DIR)/org/freedesktop/gstreamer/$(plugin)) && ) echo Done mkdir
    $(hide)$(foreach file,$(GSTREAMER_PLUGINS_CLASSES), \
-       $(call host-cp,$(GSTREAMER_NDK_BUILD_PATH)$(file),$(GSTREAMER_JAVA_SRC_DIR)/org/freedesktop/gstreamer/$(file)) && ) echo Done cp
+       $(call host-cp,$(GSTREAMER_NDK_BUILD_PATH)/$(file),$(GSTREAMER_JAVA_SRC_DIR)/org/freedesktop/gstreamer/$(file)) && ) echo Done cp

Download NNStreamer source code

$ cd $ANDROID_DEV_ROOT/workspace
$ git clone https://github.com/nnstreamer/nnstreamer.git

Build Android API

Run the build script in NNStreamer.

  • Build options
    1. Target ABI: Default arm64-v8a, specify the ABI (armeabi-v7a, arm64-v8a) to be built for with --target_abi={TARGET-ABI}.
    2. Type: Default all.
      • --build_type=all to include all features.
      • --build_type=single to enable SingleShot API only.
      • --build_type=lite to get the minimized library with GStreamer core elements.
    3. Including sub-plugins: Default TensorFlow-Lite and NNFW enabled. To enable each neural network frameworks, you should download and set-up proper environment.
      • --enable_tflite=yes to build with TensorFlow-Lite.
      • --enable_snpe=yes to build with SNPE (Qualcomm Snapdragon Neural Processing Engine).
      • --enable_nnfw=yes to build with NNFW (Samsung on-device neural network inference framework).
      • --enable_snap=yes to build with SNAP (Samsung Neural Acceleration Platform).
    4. Run test: Default no. --run_test=yes to run the instrumentation test.
    5. Other options
      • --nnstreamer_dir=<path> path to NNStreamer root directory. Default NNSTREAMER_ROOT is used if this is not set.
      • --result_dir=<path> path to build result. Default path is NNSTREAMER_ROOT/android_lib.
      • --gstreamer_dir=<path> path to GStreamer binaries. Default path is GSTREAMER_ROOT_ANDROID.
      • --android_sdk_dir=<path> path to Android SDK. Default path is ANDROID_SDK_ROOT.
      • --android_ndk_dir=<path> path to Android NDK. Default path is ANDROID_NDK_ROOT.
$ cd $NNSTREAMER_ROOT
$ bash ./api/android/build-android-lib.sh

After building the Android API, you can find the library(.aar) in $NNSTREAMER_ROOT/android_lib.

  • Build result
    1. nnstreamer-[BUILD_DATE].aar: NNStreamer library for Android
    2. nnstreamer-native-[BUILD_DATE].zip: shared objects and header files for native developer

Run the unit-test (Optional)

To run the unit-test, you will need an Android Emulator running or a physical device connected and in usb debugging mode. Make sure to select the appropriate target ABI for the emulator. Before running the unit-test, you should download the test model and copy it into your target device manually.

Make directory and copy test model and label files into the internal storage of your own Android target device.

You can download these files from nnsuite testcases repository.

# You must put the below model and label files in the internal storage of your Android target device.

## For TensorFlow Lite
# Copy {nnsuite testcases repository}/tensorflow-lite/Mobilenet_v1_1.0_224_quant/* into
{INTERNAL_STORAGE}/nnstreamer/test/mobilenet_v1_1.0_224_quant.tflite
{INTERNAL_STORAGE}/nnstreamer/test/labels.txt
{INTERNAL_STORAGE}/nnstreamer/test/orange.png
{INTERNAL_STORAGE}/nnstreamer/test/orange.raw

# Copy {nnsuite testcases repository}/tensorflow-lite/add_tflite/add.tflite into
{INTERNAL_STORAGE}/nnstreamer/test/add.tflite

## For SNPE
# Copy {nnsuite testcases repository}/snpe/inception_v3/* into
{INTERNAL_STORAGE}/nnstreamer/snpe_data/inception_v3_quantized.dlc
{INTERNAL_STORAGE}/nnstreamer/snpe_data/imagenet_slim_labels.txt
{INTERNAL_STORAGE}/nnstreamer/snpe_data/plastic_cup.jpg
{INTERNAL_STORAGE}/nnstreamer/snpe_data/plastic_cup.raw

To check the testcases, run the build script with an option --run_test=yes. You can find the result in $NNSTREAMER_ROOT/android_lib.

$ cd $NNSTREAMER_ROOT
$ bash ./api/android/build-android-lib.sh --run_test=yes