refac: Implement gvr/noGvr App flavours (#372)

* Implement gvr/noGvr variants

* Probably fix tests

* hopefully fix tests fr this time (they pass on my physical device)

* fix screenshot path for CI

* Upgrade zxing-cpp for x86 support

* address review comments

* add flavour doc to readme

* minor fixes and cleanups

---------

Co-authored-by: Harsha Raghu <[email protected]>

Author: nift4

.github/workflows/release.yml

@@ -201,22 +201,22 @@ jobs:
           Store: ${{ secrets.STORE }}
         run:  |
           cd code/mobile/android/PhoneVR
-          ./gradlew :${{ env.MAIN_PROJECT_MODULE }}:assemble --warning-mode=all --stacktrace -Dorg.gradle.java.home=${{env.JAVA_HOME}}
+          ./gradlew :${{ env.MAIN_PROJECT_MODULE }}:assembleRelease --warning-mode=all --stacktrace -Dorg.gradle.java.home=${{env.JAVA_HOME}}
 
       # Upload Artifact Build
-      # Noted For Output [MAIN_PROJECT_MODULE]/build/outputs/apk/debug/
-      - name: Upload APK Debug
+      # Noted For Output eg. [MAIN_PROJECT_MODULE]/build/outputs/apk/gvr/debug/
+      - name: Upload Debug APKs
         uses: actions/upload-artifact@v2
         with:
           name: ${{ env.PROJECT_NAME }}-debug-${{ steps.vars.outputs.sha_short }}-${{ env.date_today }} APK
-          path: ${{env.GRADLE_DIR}}/${{ env.MAIN_PROJECT_MODULE }}/build/outputs/apk/debug/
+          path: ${{env.GRADLE_DIR}}/${{ env.MAIN_PROJECT_MODULE }}/build/outputs/apk/**/debug/
 
-      # Noted For Output [MAIN_PROJECT_MODULE]/build/outputs/apk/release/
-      - name: Upload APK Release
+      # Noted For Output eg. [MAIN_PROJECT_MODULE]/build/outputs/apk/gvr/release/
+      - name: Upload Release APKs
         uses: actions/upload-artifact@v2
         with:
           name: ${{ env.PROJECT_NAME }}-${{ steps.vars.outputs.sha_short }}-${{ env.date_today }} APK
-          path: ${{env.GRADLE_DIR}}/${{ env.MAIN_PROJECT_MODULE }}/build/outputs/apk/release/
+          path: ${{env.GRADLE_DIR}}/${{ env.MAIN_PROJECT_MODULE }}/build/outputs/apk/**/release/
 
       - name: Upload Build outputs on failure
         if: failure()
@@ -230,18 +230,31 @@ jobs:
           GRADLE_PVR_DIR: ${{ env.GRADLE_DIR }}
           MODULE: ${{ env.MAIN_PROJECT_MODULE }}
         run: |
-          cd "$GRADLE_DIR/$MAIN_PROJECT_MODULE/build/outputs/apk/release/"
+          cd "$GRADLE_DIR/$MAIN_PROJECT_MODULE/build/outputs/apk/gvr/release/"
           mv -f PhoneVR*.apk PhoneVR.apk
+          cd -
+          cd "$GRADLE_DIR/$MAIN_PROJECT_MODULE/build/outputs/apk/noGvr/release/"
+          mv -f PhoneVR*.apk PhoneVR-noGvr.apk
 
       - name: Upload PVR APK
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ needs.prepare_release.outputs.upload_url }}
-          asset_path: ${{env.GRADLE_DIR}}/${{ env.MAIN_PROJECT_MODULE }}/build/outputs/apk/release/PhoneVR.apk
+          asset_path: ${{env.GRADLE_DIR}}/${{ env.MAIN_PROJECT_MODULE }}/build/outputs/apk/gvr/release/PhoneVR.apk
           asset_name: PhoneVR-v${{ github.event.inputs.version }}.apk
           asset_content_type: application/vnd.android.package-archive
+
+      - name: Upload PVR noGvr APK
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.prepare_release.outputs.upload_url }}
+          asset_path: ${{env.GRADLE_DIR}}/${{ env.MAIN_PROJECT_MODULE }}/build/outputs/apk/noGvr/release/PhoneVR-noGvr.apk
+          asset_name: PhoneVR-v${{ github.event.inputs.version }}-noGvr.apk
+          asset_content_type: application/vnd.android.package-archive
 
   # Step is needed because the PVRServerBuild runs as a matrix and adds files to the same artifact
   Upload_release_assets:
@@ -278,4 +291,4 @@ jobs:
           upload_url: ${{ needs.prepare_release.outputs.upload_url }}
           asset_path: ${{ env.PROJECT_NAME }}-Server-Release.zip
           asset_name: ${{ env.PROJECT_NAME }}-Server-v${{ github.event.inputs.version }}.zip
-          asset_content_type: application/gzip
+          asset_content_type: application/gzip

README.md

@@ -73,6 +73,7 @@ PhoneVR(PVR) can be used with two servers ALVR and PVRServer. ALVR Server is rec
 
 ### Common Instructions for both Servers
 * Install the Android Apk on your mobile from [`Releases`](https://github.com/PhoneVR-Developers/PhoneVR/releases/latest) page.
+  * There are two Apks on the release page, one with GoogleVR(GVR) SDK and other without GVR SDK. If you plan to use ALVR-Server only you can install `PhoneVR-vX.X.X.noGvr.apk`.
 * Make sure that "Run in Background", "Auto Start"(Restart on Crash) permissions, if exists on your device(especially Xiaomi users), are given. Also make sure that any kind of 3rd party battery saver app dosen't kill PhoneVR when in background.
 * After opening the installed app, Choose ALVR(recommended) or PhoneVR Server, according to the server you installed.
 
@@ -141,9 +142,18 @@ This Project is presently under testing. But, pull requests are welcome.
 * Android App: App folder: `<root>/code/mobile/android/PhoneVR`
   * Compiled/Tested on `Android Studio 4.0.1`
   * For testing, this project has 2 Build Configs, Debug and Release. Debug has lots of debugging callouts to logcat from both JAVA and JNI.
-  * PhoneVR is Android AVD compatible, though PhoneVR Server networking is also AVD compatible, but ALVR Server networking need some more work for simulation.
-    * PhoneVR APK when run on AVD automatically assigns 10.0.2.2 (default emu addr) to pcIP
-    * After starting the AVD Emulator, need to run "adb forward tcp:33333 tcp:33333", in terminal/cmd, this will enable PVRServer -> Android Emulator based PVRAndroidApp communication.
+  * There are also two build flavours: gvr and noGvr. The gvr flavour is a superset of the noGvr flavour that adds support for legacy PhoneVR server with Google VR SDK (deprecated).
+    * The source code of the gvr flavour is in app/src/gvr/ and app/src/main/. The code of the noGvr flavour is in app/src/noGvr/ and app/src/main/. Respectively, any shared code in app/src/main/ has to be tested with both flavours.
+    * The prepare-alvr-deps.sh script, which needs to be run before building supports the optional "nogvr" argument. If you run the script without arguments, you can build both flavours. If you run the script with the "nogvr" argument, you can only build the noGvr flavour.
+  * PhoneVR is Android AVD compatible.
+    * PhoneVR Legacy Server networking
+      * PhoneVR with GVR APK when run on AVD automatically assigns 10.0.2.2 (default emu addr) to pcIP
+      * After starting the AVD Emulator, need to run `adb forward tcp:33333 tcp:33333`, in terminal/cmd, this will enable PVRServer -> Android Emulator based PVRAndroidApp communication.
+    * ALVR Server networking
+      * Similar to ALVR-Over-USB (https://github.com/alvr-org/ALVR/wiki/ALVR-wired-setup-(ALVR-over-USB))
+      * Once `ALVR Streamer (PC) Configuration` is done from the above link. Then you should, in terminal/cmd, execute
+        * `adb forward tcp:9943 tcp:9943`
+        * `adb forward tcp:9944 tcp:9944`
 
 * External Vendor Libraries used (all Headers included in respective Projects):
   * Json v3.8.0 (https://github.com/nlohmann/json) (code\windows\libs\json)

code/mobile/android/PhoneVR/.gitignore

@@ -12,6 +12,7 @@
 /cardboard
 /gvr-android-sdk-1.200
 /app/libraries
+/app/libraries_gvr
 
 # Android Gitignore https://github.com/github/gitignore/blob/main/Android.gitignore
 # Gradle files

code/mobile/android/PhoneVR/app/CMakeLists.txt

@@ -14,11 +14,6 @@ file(GLOB_RECURSE LIB_SRC
     ../../../../common/libs/json/single_include/*.hpp
 )
 
-file(GLOB_RECURSE GVR_SRC
-    ../../../../common/src/*.cpp
-    ../../../mobile-common/*.cpp
-)
-
 add_library(native-lib-alvr SHARED
     src/main/cpp/alvr_main.cpp
     ${LIB_SRC}
@@ -44,27 +39,6 @@ target_link_libraries(native-lib-alvr
     ${libs_dir}/jni/${ANDROID_ABI}/libGfxPluginCardboard.so
 )
 
-IF (NOT "${ANDROID_ABI}" STREQUAL "x86_64")
-    add_library(native-lib-gvr SHARED
-        src/main/cpp/native-lib.cpp
-        ${LIB_SRC}
-        ${GVR_SRC}
-    )
-
-    target_include_directories(native-lib-gvr
-        PUBLIC ./libraries/headers
-        PUBLIC ../../../../common/libs/asio/asio/include
-        PUBLIC ../../../../common/libs/eigen/Eigen
-        PUBLIC ../../../../common/libs/ifaddrs
-        PUBLIC ../../../../common/libs/json/single_include/
-
-        PUBLIC ../../../../common/src
-        PUBLIC ../../../mobile-common
-    )
-
-    target_link_libraries(native-lib-gvr
-        log android EGL GLESv3 mediandk
-        ${libs_dir}/jni/${ANDROID_ABI}/libgvr.so
-        ${libs_dir}/jni/${ANDROID_ABI}/libgvr_audio.so
-    )
-ENDIF ()
+IF(${HAVEGVR})
+add_subdirectory(src/gvr)
+ENDIF()

code/mobile/android/PhoneVR/app/build-pr.gradle

@@ -2,7 +2,6 @@ import com.android.build.gradle.internal.dsl.PackagingOptions
 
 apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-android-extensions'
 apply plugin: 'com.android.application'
 apply plugin: 'com.google.gms.google-services'
 apply from: '../versioning.gradle'
@@ -35,8 +34,7 @@ android {
             }
         }
     }
-    compileSdkVersion 33
-    buildToolsVersion = "33.0.0"
+    compileSdkVersion 34
     namespace 'viritualisres.phonevr'
     ndkVersion '25.2.9519653' // r25c
     defaultConfig {
@@ -80,12 +78,31 @@ android {
         }
     }
     buildFeatures {
-        buildConfig = true // TODO: Remove BuildConifg, Gradle suggests this usage is inefficient > v8 disabled by default
+        buildConfig = true // TODO: Remove BuildConfig, Gradle suggests this usage is inefficient > v8 disabled by default
+        viewBinding true
+    }
+    flavorDimensions "gvr"
+    productFlavors {
+        gvr {
+            dimension "gvr"
+            externalNativeBuild {
+                cmake {
+                    arguments "-D HAVEGVR=true"
+                }
+            }
+        }
+        noGvr {
+            dimension "gvr"
+            versionNameSuffix "-nogvr"
+        }
     }
     sourceSets {
         main {
             jniLibs.srcDirs = ["libraries/jni", "../ALVR/build/alvr_client_core"]
         }
+        gvr {
+            jniLibs.srcDirs = ["libraries/jni", "libraries_gvr/jni", "../ALVR/build/alvr_client_core"]
+        }
     }
     externalNativeBuild {
         cmake {
@@ -115,6 +132,7 @@ android {
     }
 
     packagingOptions {
+        jniLibs.useLegacyPackaging = true
         gradle.startParameter.getTaskNames().each { task ->
             println("[PVR] task is " + task)
             if (task.contains('debug') || task.contains('Debug')) {
@@ -135,9 +153,9 @@ android {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation 'androidx.appcompat:appcompat:1.6.1'
+    implementation 'androidx.appcompat:appcompat:1.7.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
-    implementation 'com.google.android.material:material:1.2.1'
+    implementation 'com.google.android.material:material:1.6.1'
 
     implementation "androidx.tracing:tracing:1.1.0"
     testImplementation 'junit:junit:4.13.2'
@@ -148,10 +166,14 @@ dependencies {
     androidTestImplementation "androidx.test:rules:$androidXTestVersion"
     androidTestUtil "androidx.test.services:test-services:$servicesVersion"
 
-    implementation 'com.google.vr:sdk-base:1.200.0@aar'
+    gvrImplementation 'com.google.vr:sdk-base:1.200.0@aar'
     implementation 'com.google.cardboard.sdk:cardboard-sdk:1.17.0@aar'
-    implementation 'com.google.android.gms:play-services-vision:20.1.3'
+    implementation 'io.github.zxing-cpp:android:2.2.0-SNAPSHOT'
     implementation 'com.google.protobuf:protobuf-javalite:3.19.4'
+    implementation 'androidx.camera:camera-core:1.3.4'
+    implementation 'androidx.camera:camera-view:1.3.4'
+    implementation 'androidx.camera:camera-lifecycle:1.3.4'
+    implementation 'androidx.camera:camera-camera2:1.3.4'
 
     def acraVersion = '5.7.0'
     implementation "ch.acra:acra-mail:$acraVersion"
@@ -169,12 +191,14 @@ task extractNdk(type: Copy)  {
         into "libraries/"
         include "jni/**/libGfxPluginCardboard.so"
     }
-    copy {
-        from zipTree("../gvr-android-sdk-1.200/libraries/sdk-base-1.200.0.aar")
-        into "libraries/"
-        include "headers/vr/gvr/capi/**/*h"
-        include "jni/**/libgvr_audio.so"
-        include "jni/**/libgvr.so"
+    if (file("../gvr-android-sdk-1.200/libraries/sdk-base-1.200.0.aar").exists()) {
+        copy {
+            from zipTree("../gvr-android-sdk-1.200/libraries/sdk-base-1.200.0.aar")
+            into "libraries_gvr/"
+            include "headers/vr/gvr/capi/**/*h"
+            include "jni/**/libgvr_audio.so"
+            include "jni/**/libgvr.so"
+        }
     }
 }
 

code/mobile/android/PhoneVR/app/build.gradle

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application>
+        <activity
+            android:name=".MainActivity"
+            android:launchMode="singleTop" />
+        <activity
+            android:name=".GameActivity"
+            android:configChanges="orientation|keyboardHidden|screenSize"
+            android:enableVrMode="@string/gvr_vr_mode_component"
+            android:resizeableActivity="false"
+            android:screenOrientation="landscape"
+            android:theme="@style/GameTheme" />
+        <activity
+            android:name=".SettingsActivity"
+            android:label="Settings"
+            android:parentActivityName=".MainActivity" />
+    </application>
+
+</manifest>