Support autopresenting WebVr content.

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

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.vr_shell;
 
 import android.app.Activity;
 import android.app.ActivityManager;
 import android.app.PendingIntent;
 import android.content.BroadcastReceiver;
@@ skipping 23 matching lines @@
 import org.chromium.base.Log;
 import org.chromium.base.ThreadUtils;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.annotations.CalledByNative;
 import org.chromium.base.annotations.JNINamespace;
 import org.chromium.base.library_loader.LibraryLoader;
 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.IntentHandler;
 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.tab.Tab;
 import org.chromium.chrome.browser.tabmodel.TabModelSelector;
 import org.chromium.chrome.browser.webapps.WebappActivity;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.ref.WeakReference;
@@ skipping 20 matching lines @@
     private @interface EnterVRResult {}
 
     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})
     private @interface VrSupportLevel {}
 
+    private static final String DAYDREAM_VR_EXTRA = "android.intent.extra.VR_LAUNCH";
+
     // 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;
 
     private static final int VR_SYSTEM_UI_FLAGS = View.SYSTEM_UI_FLAG_LAYOUT_STABLE
             | View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN
             | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_FULLSCREEN
@@ skipping 24 matching lines @@
     // 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;
     private long mNativeVrShellDelegate;
     private boolean mRequestedWebVr;
     private long mLastVrExit;
     private boolean mListeningForWebVrActivate;
     private boolean mListeningForWebVrActivateBeforePause;
+    // Whether or not we should autopresent WebVr. If this is set, it means that a first
+    // party app (e.g Daydream home) has asked us to autopresent WebVr content and we're waiting
+    // for the WebVr content to call requestPresent.
+    private boolean mAutopresentWebVr = false;

[mthiesse, 2017/05/10 14:52:14]

To be on the safe side, you probably also want to reset this on top-level page
navs?

[Ted C, 2017/05/11 00:05:03]

false/null/0 are defaults in java and including them actually slightly increases
binary size.  So drop = false here.

[ymalik, 2017/05/11 03:32:27]

Are you referring to WebVr to WebVr? I thought that would happen still go
through shutdownVr.
Done

 
     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) {
@@ skipping 367 matching lines @@
         mVrShell.setWebVrModeEnabled(mRequestedWebVr || tentativeWebVrMode);
 
         // onResume needs to be called on GvrLayout after initialization to make sure DON flow work
         // properly.
         mVrShell.resume();
 
         maybeSetPresentResult(true);
         mVrShell.getContainer().setOnSystemUiVisibilityChangeListener(this);
     }
 
+    private boolean launchInVr() {
+        if (mVrDaydreamApi == null || mActivity == null) return false;

[mthiesse, 2017/05/10 14:52:14]

mActivity should never be null. If you're worried, add an assert?

As long as mVrSupportLevel > VR_NOT_AVAILABLE, mVrDaydreamApi will also not be
null. So maybe just assert mVrSupportLevel != VR_NOT_AVAILABLE as well.

[ymalik, 2017/05/11 03:32:27]

Done.

+        return mVrDaydreamApi.launchInVr(getEnterVrPendingIntent(mActivity));
+    }
+
+    private void onAutopresentIntent() {
+        // Autopresent intents are only expected from trusted first party apps while
+        // we're not in vr (e.g. deep-linked from day dream home).
+        assert !mInVr;
+        mAutopresentWebVr = true;
+    }
+
+    /**
+     * This is called every time ChromeActivity gets a intent. Its currently used to
+     * autopresent WebVr from Daydream Home.
+     */
+    public static void onNewIntent(ChromeActivity activity, Intent intent) {

[Ted C, 2017/05/11 00:05:03]

you should probably return a boolean here to give a signal it was consumed and
we shouldn't continue processing it?  Or would we expect this to include a URL
as well that we would then enter VR for?

[ymalik, 2017/05/11 03:32:27]

That's right. This intent will have the url as well.

+        if (intent.getBooleanExtra(DAYDREAM_VR_EXTRA, false) && activity.canAutopresentVr()
+                && IntentHandler.isIntentChromeOrFirstParty(intent)) {
+            VrShellDelegate instance = getInstance(activity);
+            if (instance == null) return;
+            Log.i(TAG, String.format("received intent to autopresent WebVr"));

[mthiesse, 2017/05/10 14:52:14]

No need for String.format. Probably no need for this logging at all?

For binary size reasons we should probably only log errors.

[ymalik, 2017/05/11 03:32:27]

Done.

+            instance.onAutopresentIntent();
+        }
+    }
+
     @Override
     public void onSystemUiVisibilityChange(int visibility) {
         if (mInVr && !isWindowModeCorrectForVr()) {
             setWindowModeForVr(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE);
         }
     }
 
     private boolean isWindowModeCorrectForVr() {
         int flags = mActivity.getWindow().getDecorView().getSystemUiVisibility();
         int orientation = mActivity.getResources().getConfiguration().orientation;
@@ skipping 32 matching lines @@
         // For now we don't handle sad tab page. crbug.com/661609
         if (tab.isShowingSadTab()) {
             return false;
         }
         return true;
     }
 
     @CalledByNative
     private void presentRequested() {
         mRequestedWebVr = true;
+        mAutopresentWebVr = false;
         switch (enterVrInternal()) {
             case ENTER_VR_NOT_NECESSARY:
                 mVrShell.setWebVrModeEnabled(true);
                 maybeSetPresentResult(true);
                 break;
             case ENTER_VR_CANCELLED:
                 maybeSetPresentResult(false);
                 break;
             case ENTER_VR_REQUESTED:
                 break;
@@ skipping 18 matching lines @@
 
         if (mVrSupportLevel == VR_CARDBOARD || !mVrDaydreamApi.isDaydreamCurrentViewer()) {
             // Avoid using launchInVr which would trigger DON flow regardless current viewer type
             // due to the lack of support for unexported activities.
             enterVr(false);
         } else {
             // LANDSCAPE orientation is needed before we can safely enter VR. DON can make sure that
             // 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(mActivity))) {
+            if (!launchInVr()) {
                 restoreWindowMode();
                 return ENTER_VR_CANCELLED;
             }
         }
         return ENTER_VR_REQUESTED;
     }
 
     @CalledByNative
     private boolean exitWebVRPresent() {
         if (!mInVr) return false;
@@ skipping 109 matching lines @@
     }
 
     @CalledByNative
     private void setListeningForWebVrActivate(boolean listening) {
         // Non-Daydream devices may not have the concept of display activate. So disable
         // mListeningForWebVrActivate for them.
         if (mVrSupportLevel != VR_DAYDREAM) return;
         mListeningForWebVrActivate = listening;
         if (listening && !mPaused) {
             registerDaydreamIntent(mVrDaydreamApi, mActivity);
+            if (mAutopresentWebVr) {
+                // Dispatch vrdisplayactivate so that the WebVr page can call requestPresent
+                // to start presentation.
+                // TODO(ymalik): There will be a delay between when we're asked to autopresent and
+                // when the WebVr site calls requestPresent. In this time, the user sees 2D Chrome
+                // UI which is suboptimal.
+                nativeDisplayActivate(mNativeVrShellDelegate);
+            }
         } else {
             unregisterDaydreamIntent(mVrDaydreamApi);
         }
     }
 
     /**
      * Exits VR Shell, performing all necessary cleanup.
      */
     /* package */ void shutdownVr(boolean isPausing, boolean showTransition) {
         if (!mInVr) return;
         mInVr = false;
         mRequestedWebVr = false;
+        mAutopresentWebVr = false;
         // Transition screen is not available for Cardboard only (non-Daydream) devices.
         // TODO(bshe): Fix this once b/33490788 is fixed.
         boolean transition = mVrSupportLevel == VR_DAYDREAM && showTransition;
         if (!isPausing) {
             if (!transition || !mVrDaydreamApi.exitFromVr(EXIT_VR_RESULT, new Intent())) {
                 mVrClassesWrapper.setVrModeEnabled(mActivity, false);
             }
         } else {
             mVrClassesWrapper.setVrModeEnabled(mActivity, false);
             mLastVrExit = SystemClock.uptimeMillis();
@@ skipping 157 matching lines @@
     private native long nativeInit();
     private static native void nativeOnLibraryAvailable();
     private native void nativeSetPresentResult(long nativeVrShellDelegate, boolean result);
     private native void nativeDisplayActivate(long nativeVrShellDelegate);
     private native void nativeUpdateVSyncInterval(long nativeVrShellDelegate, long timebaseNanos,
             double intervalSeconds);
     private native void nativeOnPause(long nativeVrShellDelegate);
     private native void nativeOnResume(long nativeVrShellDelegate);
     private native void nativeDestroy(long nativeVrShellDelegate);
 }