Enable WebVR presentation from Chrome Custom Tab

chrome/android/java/src/org/chromium/chrome/browser/vr_shell/VrShellDelegate.java

Index: chrome/android/java/src/org/chromium/chrome/browser/vr_shell/VrShellDelegate.java
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/vr_shell/VrShellDelegate.java b/chrome/android/java/src/org/chromium/chrome/browser/vr_shell/VrShellDelegate.java
index 6feb3f6da18d54b9f7bf02fb3072da8cbe8dc75d..7cc4dc24a52c5cf6b7656e7e413172ee9c779963 100644
--- a/chrome/android/java/src/org/chromium/chrome/browser/vr_shell/VrShellDelegate.java
+++ b/chrome/android/java/src/org/chromium/chrome/browser/vr_shell/VrShellDelegate.java
@@ -5,10 +5,12 @@
 package org.chromium.chrome.browser.vr_shell;
 
 import android.app.Activity;
+import android.app.ActivityManager;
 import android.app.PendingIntent;
-import android.content.ComponentName;
+import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
+import android.content.IntentFilter;
 import android.content.pm.ActivityInfo;
 import android.content.res.Configuration;
 import android.net.Uri;
@@ -36,6 +38,7 @@ import org.chromium.chrome.R;
 import org.chromium.chrome.browser.ChromeActivity;
 import org.chromium.chrome.browser.ChromeFeatureList;
 import org.chromium.chrome.browser.ChromeTabbedActivity;
+import org.chromium.chrome.browser.customtabs.CustomTabActivity;
 import org.chromium.chrome.browser.infobar.InfoBarIdentifier;
 import org.chromium.chrome.browser.infobar.SimpleConfirmInfoBarBuilder;
 import org.chromium.chrome.browser.multiwindow.MultiWindowUtils;
@@ -44,6 +47,7 @@ import org.chromium.chrome.browser.tabmodel.TabModelSelector;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
+import java.lang.ref.WeakReference;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
 
@@ -57,30 +61,32 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
     // Pseudo-random number to avoid request id collisions.
     public static final int EXIT_VR_RESULT = 721251;
 
-    public static final int ENTER_VR_NOT_NECESSARY = 0;
-    public static final int ENTER_VR_CANCELLED = 1;
-    public static final int ENTER_VR_REQUESTED = 2;
-    public static final int ENTER_VR_SUCCEEDED = 3;
+    private static final int ENTER_VR_NOT_NECESSARY = 0;
+    private static final int ENTER_VR_CANCELLED = 1;
+    private static final int ENTER_VR_REQUESTED = 2;
+    private static final int ENTER_VR_SUCCEEDED = 3;
 
     @Retention(RetentionPolicy.SOURCE)
     @IntDef({ENTER_VR_NOT_NECESSARY, ENTER_VR_CANCELLED, ENTER_VR_REQUESTED, ENTER_VR_SUCCEEDED})
-    public @interface EnterVRResult {}
+    private @interface EnterVRResult {}
 
-    public static final int VR_NOT_AVAILABLE = 0;
-    public static final int VR_CARDBOARD = 1;
-    public static final int VR_DAYDREAM = 2; // Supports both Cardboard and Daydream viewer.
+    private static final int VR_NOT_AVAILABLE = 0;
+    private static final int VR_CARDBOARD = 1;
+    private static final int VR_DAYDREAM = 2; // Supports both Cardboard and Daydream viewer.
 
     @Retention(RetentionPolicy.SOURCE)
     @IntDef({VR_NOT_AVAILABLE, VR_CARDBOARD, VR_DAYDREAM})
-    public @interface VrSupportLevel {}
+    private @interface VrSupportLevel {}
 
     // TODO(bshe): These should be replaced by string provided by NDK. Currently, it only available
     // in SDK and we don't want add dependency to SDK just to get these strings.
     private static final String DAYDREAM_CATEGORY = "com.google.intent.category.DAYDREAM";
     private static final String CARDBOARD_CATEGORY = "com.google.intent.category.CARDBOARD";
 
-    private static final String VR_ACTIVITY_ALIAS =
-            "org.chromium.chrome.browser.VRChromeTabbedActivity";
+    // Linter and formatter disagree on how the line below should be formatted.
+    /* package */
+    static final String VR_ENTRY_RESULT_ACTION =
+            "org.chromium.chrome.browser.vr_shell.VrEntryResult";
 
     private static final long REENTER_VR_TIMEOUT_MS = 1000;
 
@@ -93,6 +99,7 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
             "market://details?id=" + VrCoreVersionChecker.VR_CORE_PACKAGE_ID;
 
     private static VrShellDelegate sInstance;
+    private static VrBroadcastReceiver sVrBroadcastReceiver;
 
     private ChromeActivity mActivity;
 
@@ -107,7 +114,11 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
     private TabModelSelector mTabModelSelector;
 
     private boolean mInVr;
-    private boolean mEnteringVr;
+
+    // Whether or not the VR Device ON flow succeeded. If this is true it means the user has a VR
+    // headset on, but we haven't switched into VR mode yet.
+    // See further documentation here: https://developers.google.com/vr/daydream/guides/vr-entry
+    private boolean mDonSucceeded;
     private boolean mPaused;
     private int mRestoreSystemUiVisibilityFlag = -1;
     private Integer mRestoreOrientation = null;
@@ -117,6 +128,32 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
     private boolean mListeningForWebVrActivate;
     private boolean mListeningForWebVrActivateBeforePause;
 
+    private static class VrBroadcastReceiver extends BroadcastReceiver {
+        private final WeakReference<ChromeActivity> mTargetActivity;
+
+        public VrBroadcastReceiver(ChromeActivity activity) {
+            mTargetActivity = new WeakReference<ChromeActivity>(activity);
+        }
+
+        @Override
+        public void onReceive(Context context, Intent intent) {
+            ChromeActivity activity = mTargetActivity.get();
+            if (activity == null) return;
+            getInstance(activity).mDonSucceeded = true;
+            ((ActivityManager) context.getSystemService(Context.ACTIVITY_SERVICE))
+                    .moveTaskToFront(activity.getTaskId(), 0);
+        }
+
+        /**
+         * Unregisters this {@link BroadcastReceiver} from the activity it's registered to.
+         */
+        public void unregister() {
+            ChromeActivity activity = mTargetActivity.get();
+            if (activity == null) return;
+            activity.unregisterReceiver(VrBroadcastReceiver.this);
+        }
+    }
+
     /**
      * Called when the native library is first available.
      */
@@ -163,17 +200,6 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
     }
 
     /**
-     * Handles a VR intent, entering VR in the process.
-     */
-    public static void enterVRFromIntent(Intent intent) {
-        assert isDaydreamVrIntent(intent);
-        boolean created_delegate = sInstance == null;
-        VrShellDelegate instance = getInstance();
-        if (instance == null) return;
-        if (!instance.enterVRFromIntent() && created_delegate) instance.destroy();
-    }
-
-    /**
      * Whether or not the intent is a Daydream VR Intent.
      */
     public static boolean isDaydreamVrIntent(Intent intent) {
@@ -208,10 +234,10 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
      * If VR Shell is enabled, and the activity is supported, register with the Daydream
      * platform that this app would like to be launched in VR when the device enters VR.
      */
-    public static void maybeRegisterVREntryHook(Activity activity) {
+    public static void maybeRegisterVREntryHook(ChromeActivity activity) {
         if (sInstance != null) return; // Will be handled in onResume.
         if (!(activity instanceof ChromeTabbedActivity)) return;
-        VrClassesWrapper wrapper = createVrClassesWrapper();
+        VrClassesWrapper wrapper = getVrClassesWrapper();
         if (wrapper == null) return;
         VrDaydreamApi api = wrapper.createVrDaydreamApi(activity);
         if (api == null) return;
@@ -226,7 +252,7 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
     public static void maybeUnregisterVREntryHook(Activity activity) {

[bshe, 2017/04/13 21:18:33]

nit: ChromeActivity too?

         if (sInstance != null) return; // Will be handled in onPause.
         if (!(activity instanceof ChromeTabbedActivity)) return;
-        VrClassesWrapper wrapper = createVrClassesWrapper();
+        VrClassesWrapper wrapper = getVrClassesWrapper();
         if (wrapper == null) return;
         VrDaydreamApi api = wrapper.createVrDaydreamApi(activity);
         if (api == null) return;
@@ -235,21 +261,27 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
 
     @CalledByNative
     private static VrShellDelegate getInstance() {
-        return getInstance(ApplicationStatus.getLastTrackedFocusedActivity());
+        Activity activity = ApplicationStatus.getLastTrackedFocusedActivity();
+        if (!(activity instanceof ChromeActivity)) return null;
+        return getInstance((ChromeActivity) activity);
     }
 
-    private static VrShellDelegate getInstance(Activity activity) {
+    private static VrShellDelegate getInstance(ChromeActivity activity) {
         if (!LibraryLoader.isInitialized()) return null;
-        if (activity == null || !isSupportedActivity(activity)) return null;
+        if (activity == null || !activitySupportsPresentation(activity)) return null;
         if (sInstance != null) return sInstance;
         VrClassesWrapper wrapper = getVrClassesWrapper();
         if (wrapper == null) return null;
-        sInstance = new VrShellDelegate((ChromeActivity) activity, wrapper);
+        sInstance = new VrShellDelegate(activity, wrapper);
 
         return sInstance;
     }
 
-    private static boolean isSupportedActivity(Activity activity) {
+    private static boolean activitySupportsPresentation(Activity activity) {
+        return activity instanceof ChromeTabbedActivity || activity instanceof CustomTabActivity;
+    }
+
+    private static boolean activitySupportsVRBrowsing(Activity activity) {
         return activity instanceof ChromeTabbedActivity;
     }
 
@@ -279,25 +311,29 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
         }
     }
 
-    private static PendingIntent getEnterVRPendingIntent(
-            VrDaydreamApi dayreamApi, Activity activity) {
-        return PendingIntent.getActivity(activity, 0,
-                dayreamApi.createVrIntent(new ComponentName(activity, VR_ACTIVITY_ALIAS)),
-                PendingIntent.FLAG_ONE_SHOT);
+    private static PendingIntent getEnterVRPendingIntent(ChromeActivity activity) {
+        Intent vrIntent = new Intent(VR_ENTRY_RESULT_ACTION);
+        return PendingIntent.getBroadcast(activity, 0, vrIntent,
+                PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_ONE_SHOT);
     }
 
     /**
      * Registers the Intent to fire after phone inserted into a headset.
      */
-    private static void registerDaydreamIntent(VrDaydreamApi dayreamApi, Activity activity) {
-        dayreamApi.registerDaydreamIntent(getEnterVRPendingIntent(dayreamApi, activity));
+    private static void registerDaydreamIntent(
+            final VrDaydreamApi daydreamApi, final ChromeActivity activity) {
+        if (sVrBroadcastReceiver != null) sVrBroadcastReceiver.unregister();
+        IntentFilter filter = new IntentFilter(VR_ENTRY_RESULT_ACTION);
+        sVrBroadcastReceiver = new VrBroadcastReceiver(activity);
+        activity.registerReceiver(sVrBroadcastReceiver, filter);
+        daydreamApi.registerDaydreamIntent(getEnterVRPendingIntent(activity));
     }
 
     /**
      * Unregisters the Intent which registered by this context if any.
      */
-    private static void unregisterDaydreamIntent(VrDaydreamApi dayreamApi) {
-        dayreamApi.unregisterDaydreamIntent();
+    private static void unregisterDaydreamIntent(VrDaydreamApi daydreamApi) {
+        daydreamApi.unregisterDaydreamIntent();
     }
 
     /**
@@ -341,7 +377,7 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
                 break;
             case ActivityState.RESUMED:
                 assert !mInVr;
-                if (!isSupportedActivity(activity)) return;
+                if (!activitySupportsPresentation(activity)) return;
                 mActivity = (ChromeActivity) activity;
                 resumeVR();
                 break;
@@ -370,46 +406,41 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
                 mVrDaydreamApi, mVrCoreVersionChecker, mActivity.getActivityTab());
     }
 
+    private void maybeSetPresentResult(boolean result) {
+        if (mNativeVrShellDelegate != 0 && mRequestedWebVR) {
+            nativeSetPresentResult(mNativeVrShellDelegate, result);
+        }
+        mRequestedWebVR = false;
+    }
+
     /**
-     * Handle a VR intent, entering VR in the process unless we're unable to.
+     * Handle a successful VR DON flow, entering VR in the process unless we're unable to.
+     * @return False if VR entry failed.
      */
-    private boolean enterVRFromIntent() {
-        // Vr Intent is only used on Daydream devices.
-        if (mVrSupportLevel != VR_DAYDREAM) return false;
+    private boolean enterVRAfterDON() {

[Ted C, 2017/04/13 20:17:19]

this should be enterVrAfterDon per naming.

We could have a follow up CL to unify the capitalization of vr in this file
though :-P

[mthiesse, 2017/04/13 20:27:21]

Done. Fixed most others too.

         if (mNativeVrShellDelegate == 0) return false;
         if (mListeningForWebVrActivateBeforePause && !mRequestedWebVR) {
             nativeDisplayActivate(mNativeVrShellDelegate);
-            return false;
+            return true;
         }
+
         // Normally, if the active page doesn't have a vrdisplayactivate listener, and WebVR was not
-        // presenting and VrShell was not enabled, we shouldn't enter VR and Daydream Homescreen
-        // should show after DON flow. But due to a failure in unregisterDaydreamIntent, we still
-        // try to enterVR. Here we detect this case and force switch to Daydream Homescreen.
+        // presenting and VrShell was not enabled, the Daydream Homescreen should show after the DON
+        // flow. However, due to a failure in unregisterDaydreamIntent, we still try to enterVR, so
+        // detect this case and fail to enter VR.
         if (!mListeningForWebVrActivateBeforePause && !mRequestedWebVR
-                && !isVrShellEnabled(mVrSupportLevel)) {
-            mVrDaydreamApi.launchVrHomescreen();
+                && !canEnterVR(mActivity.getActivityTab())) {
             return false;
         }
 
-        if (mInVr) {
-            setEnterVRResult(true);
-            return false;
-        }
-        if (!canEnterVR(mActivity.getActivityTab())) {
-            setEnterVRResult(false);
-            return false;
-        }
-        if (mPaused) {
-            // We can't enter VR before the application resumes, or we encounter bizarre crashes
-            // related to gpu surfaces. Set this flag to enter VR on the next resume.
-            mEnteringVr = true;
-        } else {
-            enterVR();
-        }
+        enterVR();
         return true;
     }
 
     private void enterVR() {
+        // We can't enter VR before the application resumes, or we encounter bizarre crashes
+        // related to gpu surfaces. Set this flag to enter VR on the next resume.

[amp, 2017/04/13 20:13:56]

This comment (especially last sentence) seems to be slightly off.  It looks like
we got rid of the mEnteringVr flag it was referencing before.

[mthiesse, 2017/04/13 20:27:21]

Done.

+        assert !mPaused;
         if (mNativeVrShellDelegate == 0) return;
         if (mInVr) return;
         if (!isWindowModeCorrectForVr()) {
@@ -422,10 +453,9 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
             });
             return;
         }
-        mEnteringVr = false;
         if (!createVrShell()) {
-            restoreWindowMode();
-            setEnterVRResult(false);
+            maybeSetPresentResult(false);
+            mVrDaydreamApi.launchVrHomescreen();
             return;
         }
         mVrClassesWrapper.setVrModeEnabled(mActivity, true);
@@ -441,7 +471,7 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
         // properly.
         mVrShell.resume();
 
-        setEnterVRResult(true);
+        maybeSetPresentResult(true);
         mVrShell.getContainer().setOnSystemUiVisibilityChangeListener(this);
     }
 
@@ -472,16 +502,6 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
         clearVrModeWindowFlags();
     }
 
-    private void setEnterVRResult(boolean success) {
-        if (mRequestedWebVR && mNativeVrShellDelegate != 0) {
-            nativeSetPresentResult(mNativeVrShellDelegate, success);
-        }
-        if (!success && !mVrDaydreamApi.exitFromVr(EXIT_VR_RESULT, new Intent())) {
-            mVrClassesWrapper.setVrModeEnabled(mActivity, false);
-        }
-        mRequestedWebVR = false;
-    }
-
     /* package */ boolean canEnterVR(Tab tab) {
         if (!LibraryLoader.isInitialized()) {
             return false;
@@ -510,31 +530,19 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
 
     @CalledByNative
     private void presentRequested() {
-        // TODO(mthiesse): There's a GVR bug where they're not calling us back with the intent we
-        // ask them to when we call DaydreamApi#launchInVr. As a temporary hack, remember locally
-        // that we want to enter webVR.
         mRequestedWebVR = true;
         switch (enterVRInternal()) {
             case ENTER_VR_NOT_NECESSARY:
                 mVrShell.setWebVrModeEnabled(true);
-                if (mNativeVrShellDelegate != 0) {
-                    nativeSetPresentResult(mNativeVrShellDelegate, true);
-                }
-                mRequestedWebVR = false;
+                maybeSetPresentResult(true);
                 break;
             case ENTER_VR_CANCELLED:
-                if (mNativeVrShellDelegate != 0) {
-                    nativeSetPresentResult(mNativeVrShellDelegate, false);
-                }
-                mRequestedWebVR = false;
+                maybeSetPresentResult(false);
                 break;
             case ENTER_VR_REQUESTED:
                 break;
             case ENTER_VR_SUCCEEDED:
-                if (mNativeVrShellDelegate != 0) {
-                    nativeSetPresentResult(mNativeVrShellDelegate, true);
-                }
-                mRequestedWebVR = false;
+                maybeSetPresentResult(true);
                 break;
             default:
                 Log.e(TAG, "Unexpected enum.");
@@ -561,7 +569,7 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
             // the device is at LANDSCAPE orientation once it is finished. So here we use SENSOR to
             // avoid forcing LANDSCAPE orientation in order to have a smoother transition.
             setWindowModeForVr(ActivityInfo.SCREEN_ORIENTATION_SENSOR);
-            if (!mVrDaydreamApi.launchInVr(getEnterVRPendingIntent(mVrDaydreamApi, mActivity))) {
+            if (!mVrDaydreamApi.launchInVr(getEnterVRPendingIntent(mActivity))) {
                 restoreWindowMode();
                 return ENTER_VR_CANCELLED;
             }
@@ -581,21 +589,10 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
 
     private void resumeVR() {
         mPaused = false;
-        if (mVrSupportLevel == VR_NOT_AVAILABLE) return;
-        if (mVrSupportLevel == VR_DAYDREAM
-                && (isVrShellEnabled(mVrSupportLevel) || mListeningForWebVrActivateBeforePause)) {
-            registerDaydreamIntent(mVrDaydreamApi, mActivity);
-        }
 
-        if (mEnteringVr) {
-            enterVR();
-        } else if (mRequestedWebVR) {
-            // If this is still set, it means the user backed out of the DON flow, and we won't be
-            // receiving an intent from daydream.
-            if (mNativeVrShellDelegate != 0) nativeSetPresentResult(mNativeVrShellDelegate, false);
-            restoreWindowMode();
-            mRequestedWebVR = false;
-        }
+        // TODO(mthiesse): If we ever support staying in VR while paused, make sure to call resume
+        // on VrShell.
+        assert !mInVr;
 
         StrictMode.ThreadPolicy oldPolicy = StrictMode.allowThreadDiskWrites();
         try {
@@ -604,19 +601,28 @@ public class VrShellDelegate implements ApplicationStatus.ActivityStateListener,
             StrictMode.setThreadPolicy(oldPolicy);
         }
 
-        if (mInVr) {
-            setupVrModeWindowFlags();
-            oldPolicy = StrictMode.allowThreadDiskWrites();
-            try {
-                mVrShell.resume();
-            } catch (IllegalArgumentException e) {
-                Log.e(TAG, "Unable to resume VrShell", e);
-            } finally {
-                StrictMode.setThreadPolicy(oldPolicy);
-            }
-        } else if (mVrSupportLevel == VR_DAYDREAM && mVrDaydreamApi.isDaydreamCurrentViewer()
+        if (mVrSupportLevel != VR_DAYDREAM) return;

[amp, 2017/04/13 20:13:56]

What does this do to cardboard support?

[mthiesse, 2017/04/13 20:27:21]

Nothing. Cardboard will never hit this point because it doesn't go through the
DON flow (meaning we won't get paused or resumed when entering VR in cardboard
mode).

[amp, 2017/04/13 20:40:00]

Oh yea, totally forgot that part.  And because I'm paranoid I pulled down the
patch and tried out cardboard anyway and it worked great. :D

+        if (mListeningForWebVrActivateBeforePause
+                || (isVrShellEnabled(mVrSupportLevel) && activitySupportsVRBrowsing(mActivity))) {
+            registerDaydreamIntent(mVrDaydreamApi, mActivity);
+        }
+
+        if (mVrDaydreamApi.isDaydreamCurrentViewer()
                 && mLastVRExit + REENTER_VR_TIMEOUT_MS > SystemClock.uptimeMillis()) {
-            enterVRInternal();
+            mDonSucceeded = true;
+        }
+
+        if (mDonSucceeded) {
+            mDonSucceeded = false;
+            // If we fail to enter VR when we should have entered VR, return to the home screen.
+            if (!enterVRAfterDON()) {
+                maybeSetPresentResult(false);
+                mVrDaydreamApi.launchVrHomescreen();
+            }
+        } else if (mRestoreOrientation != null) {
+            // This means the user backed out of the DON flow, and we won't be entering VR.
+            maybeSetPresentResult(false);
+            restoreWindowMode();
         }
     }