Add Image Super Resolution for Android

Signed-off-by: Ravi Kumar Neti <[email protected]>

ai-solutions/android/01-ImageSuperResolution/README.md

@@ -0,0 +1,133 @@
+# Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Introduction](#introduction)
+    + [About "Image Super Resolution"](#about--image-super-resolution-)
+    + [Pre-Requisites](#pre-requisites)
+- [Model Selection and DLC conversion](#model-selection-and-dlc-conversion)
+    + [Model Overview](#model-overview)
+    + [Steps to convert model to DLC](#steps-to-convert-model-to-dlc)
+- [Source Overview](#source-overview)
+    + [Source Organization](#source-organization)
+    + [Code Implementation](#code-implementation)
+- [Build APK file with Android Studio](#build-apk-file-with-android-studio)
+- [Results](#results)
+# Introduction
+
+### About "Image Super Resolution" 
+
+- Current project is an sample Android application for AI-based Image Super Resolution using [Qualcomm® Neural Processing SDK for AI](https://developer.qualcomm.com/sites/default/files/docs/snpe/index.html) framework. 
+- We have used 5 Models in this Solution
+- This sample enhances input image resolution by 4x along width, and height. If input resolution is wxh, output resolution will be 4*w x 4*h
+- DLC models take only fixed input size.
+- If users intend to use a different model in this demo framework, **image pre/post processing will be needed**. 
+- Current pre/post processing is specific to the models used. 
+
+### Pre-Requisites 
+
+- Qualcomm® Neural Processing SDK for AI setup should be completed by following the guide here : https://developer.qualcomm.com/sites/default/files/docs/snpe/setup.html
+- Android Studio to import sample project
+- Android NDK to build native code
+- Install opencv using ```pip install opencv-python```
+
+# Model Selection and DLC conversion
+
+### Model Overview
+
+Please refer to Models repository for model overview
+<TODO> Add public link
+
+### Steps to convert model to DLC
+Please refer to Models repository for model overview
+<TODO> Add public link
+
+# Source Overview
+
+### Source Organization
+
+- <DIR> demo: Contains demo video, GIF 
+- <DIR> superresolution: Contains source files in standard Android app format.
+- app\src\main\assets : Contains Model binary DLC
+- superresolution\src\main\java\com\qcom\imagesuperres : Application java source code
+- superresolution\src\main\cpp : Application C++(native) source code
+- sdk : Contains openCV sdk (Will be generated using _ResolveDependencies.sh_ )
+
+### Code Implementation
+
+- Model Initialization
+
+   `public boolean loadingMODELS(char runtime_var, String dlc_name)`
+  - runtime_var: Possible options are D, G, C. 
+  - dlc_name: Name of the DLC.
+
+- Running Model
+
+  - Following is the Java Function, that handles model execution. This function iternally calls sub functions to handle pre-processing and post-processing
+
+      `inferSNPE(inputMat.getNativeObjAddr(), outputMat.getNativeObjAddr())`
+       - inputMat is opencv Matrix that contains input image.
+       - outputMat is the destination for the output image
+
+   - C++ function that handles preprocessing for the input image.
+
+       `preprocess(std::vector<float32_t> &dest_buffer, cv::Mat &img, std::vector<int> dims) `
+
+   - C++ function that handles postprocessing after we receive input from model
+
+       `postprocess(cv::Mat &outputimg)`
+
+   - SNPE API function that runs the network and give result 
+
+       `snpe->execute(inputMap, outputMap);`
+
+
+# Build APK file with Android Studio  
+
+1. Clone this repo.
+2. Generate DLC using the steps mentioned.
+3. Run below script, from the directory where it is present, to resolve dependencies of this project.
+
+	`bash resolveDependencies.sh`
+
+   * This script will download opencv and paste to sdk directory, to enable OpenCv for android Java.
+   * This script will copy snpe-release.aar file from $SNPE_ROOT to "snpe-release" directory in Android project.
+
+	**NOTE - If you are using SNPE version 2.11 or greater, please change following line in resolveDependencies.sh.**
+   ```
+	From: cp $SNPE_ROOT/android/snpe-release.aar snpe-release
+	To : cp $SNPE_ROOT/lib/android/snpe-release.aar snpe-release
+	```
+
+4. Import folder VisionSolution2-ImageSuperResolution as a project in Android Studio 
+5. Do gradle sync
+6. Compile the project. 
+7. Output APK file should get generated : superresolution-debug.apk
+8. Prepare the Qualcomm Innovators development kit(QIDK) to install the application (Do not run APK on emulator)
+9. Install and test application : superresolution-debug.apk
+
+```java
+adb install -r -t superresolution-debug.apk
+```
+
+10. launch the application
+
+Following is the basic "Image Super Resolution" Android App 
+
+1. Select one of the models
+2. Select one of the given images from the drop-down list
+3. Select the run-time to run the model (CPU, GPU or DSP)
+4. Observe the result of model on screen
+5. Also note the performance indicator for the particular run-time in mSec
+
+Same results for the application are shown below 
+
+# Results
+
+- Demo video, and performance details as seen below:
+
+![Demo video.](demo/VisionSolution2-ImageSuperResolution.gif)
+
+
+
+
+
+###### *Qualcomm Neural Processing SDK and Snapdragon are products of Qualcomm Technologies, Inc. and/or its subsidiaries. AIMET Model Zoo is a product of Qualcomm Innovation Center, Inc.*

ai-solutions/android/01-ImageSuperResolution/build.gradle

@@ -0,0 +1,26 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+buildscript {
+    ext.kotlin_version = '1.6.10'
+    repositories {
+        google()
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:7.2.1'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        // NOTE: Do not place your application dependencies here; they belong
+        // in the individual module build.gradle files
+    }
+}
+
+allprojects {
+    repositories {
+        google()
+        jcenter()
+    }
+
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}

ai-solutions/android/01-ImageSuperResolution/gradle.properties

@@ -0,0 +1,19 @@
+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx2048m
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app"s APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true
+# Automatically convert third-party libraries to use AndroidX
+android.enableJetifier=true

ai-solutions/android/01-ImageSuperResolution/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Fri Sep 09 10:14:39 IST 2022
+distributionBase=GRADLE_USER_HOME
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME

ai-solutions/android/01-ImageSuperResolution/gradlew

@@ -0,0 +1,185 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MSYS* | MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=`expr $i + 1`
+    done
+    case $i in
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=`save "$@"`
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+exec "$JAVACMD" "$@"