Clean up VR Shell mode transitions (and fix potential webvr startup race).

BUG=668541
CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.linux:closure_compilation

Review-Url: https://codereview.chromium.org/2536873002
Cr-Commit-Position: refs/heads/master@{#435010}

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

@@ -16,7 +16,7 @@ public interface VrShell {
     /**
      * Performs native VrShell initialization.
      */
-    void initializeNative(Tab currentTab, VrShellDelegate delegate);
+    void initializeNative(Tab currentTab, VrShellDelegate delegate, boolean forWebVR);
 
     /**
      * Pauses VrShell.

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

@@ -154,10 +154,7 @@ public class VrShellDelegate {
             return;
         }
         if (enterVR()) {
-            if (mRequestedWebVR) {
-                nativeSetPresentResult(mNativeVrShellDelegate, true);
-                mVrShell.setWebVrModeEnabled(true);
-            }
+            if (mRequestedWebVR) nativeSetPresentResult(mNativeVrShellDelegate, true);
         } else {
             if (mRequestedWebVR) nativeSetPresentResult(mNativeVrShellDelegate, false);
             if (!mVrDaydreamApi.exitFromVr(EXIT_VR_RESULT, new Intent())) {
@@ -186,7 +183,7 @@ public class VrShellDelegate {
         mTab.addObserver(mTabObserver);
         addVrViews();
         setupVrModeWindowFlags();
-        mVrShell.initializeNative(mTab, this);
+        mVrShell.initializeNative(mTab, this, mRequestedWebVR);
         mVrShell.setCloseButtonListener(new Runnable() {
             @Override
             public void run() {

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

@@ -108,7 +108,7 @@ public class VrShellImpl extends GvrLayout implements GLSurfaceView.Renderer, Vr
     }
 
     @Override
-    public void initializeNative(Tab currentTab, VrShellDelegate delegate) {
+    public void initializeNative(Tab currentTab, VrShellDelegate delegate, boolean forWebVR) {
         assert currentTab.getContentViewCore() != null;
         mTab = currentTab;
         mContentCVC = mTab.getContentViewCore();
@@ -122,8 +122,8 @@ public class VrShellImpl extends GvrLayout implements GLSurfaceView.Renderer, Vr
                 uiContentView, mUiContents, mUiVrWindowAndroid);
 
         mNativeVrShell = nativeInit(mContentCVC.getWebContents(),
-                mContentVrWindowAndroid.getNativePointer(),
-                mUiContents, mUiVrWindowAndroid.getNativePointer());
+                mContentVrWindowAndroid.getNativePointer(), mUiContents,
+                mUiVrWindowAndroid.getNativePointer(), forWebVR);
         mGlSurfaceView.setOnTouchListener(new View.OnTouchListener() {
             @Override
             @SuppressLint("ClickableViewAccessibility")
@@ -362,7 +362,7 @@ public class VrShellImpl extends GvrLayout implements GLSurfaceView.Renderer, Vr
     }
 
     private native long nativeInit(WebContents contentWebContents, long nativeContentWindowAndroid,
-            WebContents uiWebContents, long nativeUiWindowAndroid);
+            WebContents uiWebContents, long nativeUiWindowAndroid, boolean forWebVR);
     private native void nativeSetDelegate(long nativeVrShell, VrShellDelegate delegate);
     private native void nativeGvrInit(long nativeVrShell, long nativeGvrApi);
     private native void nativeDestroy(long nativeVrShell);

chrome/browser/android/vr_shell/ui_interface.cc

@@ -9,15 +9,31 @@
 
 namespace vr_shell {
 
-UiInterface::UiInterface() {
-  SetMode(Mode::STANDARD);
+UiInterface::UiInterface(Mode initial_mode) {
+  SetMode(initial_mode);
 }
 
 UiInterface::~UiInterface() {}
 
 void UiInterface::SetMode(Mode mode) {
   mode_ = mode;
-  updates_.SetInteger("mode", static_cast<int>(mode));
+  FlushModeState();
+}
+
+void UiInterface::SetMenuMode(bool enabled) {
+  menu_mode_ = enabled;
+  FlushModeState();
+}
+
+void UiInterface::SetCinemaMode(bool enabled) {
+  cinema_mode_ = enabled;
+  FlushModeState();
+}
+
+void UiInterface::FlushModeState() {
+  updates_.SetInteger("mode", static_cast<int>(mode_));
+  updates_.SetBoolean("menuMode", menu_mode_);
+  updates_.SetBoolean("cinemaMode", cinema_mode_);
   FlushUpdates();
 }
 

chrome/browser/android/vr_shell/ui_interface.h

@@ -23,16 +23,19 @@ class UiInterface {
  public:
   enum Mode {
     STANDARD,
-    WEB_VR,
-    MENU,
-    CINEMA,
+    WEB_VR
   };
 
-  UiInterface();
+  explicit UiInterface(Mode initial_mode);
   virtual ~UiInterface();
 
   void SetMode(Mode mode);
   Mode GetMode() { return mode_; }
+  void SetMenuMode(bool enabled);
+  bool GetMenuMode() { return menu_mode_; }
+  void SetCinemaMode(bool enabled);
+  bool GetCinemaMode() { return cinema_mode_; }
+
   void SetSecureOrigin(bool secure);
   void SetLoading(bool loading);
   void SetURL(const GURL& url);
@@ -43,8 +46,11 @@ class UiInterface {
 
  private:
   void FlushUpdates();
+  void FlushModeState();
 
   Mode mode_;
+  bool menu_mode_ = false;
+  bool cinema_mode_ = false;
   UiCommandHandler* handler_;
   bool loaded_ = false;
   base::DictionaryValue updates_;

chrome/browser/android/vr_shell/vr_shell.cc

@@ -151,7 +151,8 @@ VrShell::VrShell(JNIEnv* env,
                  content::WebContents* main_contents,
                  ui::WindowAndroid* content_window,
                  content::WebContents* ui_contents,
-                 ui::WindowAndroid* ui_window)
+                 ui::WindowAndroid* ui_window,
+                 bool for_web_vr)
     : WebContentsObserver(ui_contents),
       main_contents_(main_contents),
       ui_contents_(ui_contents),
@@ -162,7 +163,11 @@ VrShell::VrShell(JNIEnv* env,
   g_instance = this;
   j_vr_shell_.Reset(env, obj);
   scene_.reset(new UiScene);
-  html_interface_.reset(new UiInterface);
+
+  if (for_web_vr)
+    metrics_helper_->SetWebVREnabled(true);
+  html_interface_.reset(new UiInterface(
+      for_web_vr ? UiInterface::Mode::WEB_VR : UiInterface::Mode::STANDARD));
   content_compositor_.reset(new VrCompositor(content_window, false));
   ui_compositor_.reset(new VrCompositor(ui_window, true));
   vr_web_contents_observer_.reset(
@@ -230,7 +235,6 @@ void VrShell::GvrInit(JNIEnv* env,
   base::AutoLock lock(gvr_init_lock_);
 
   // set the initial webvr state
-  metrics_helper_->SetWebVREnabled(webvr_mode_);
   metrics_helper_->SetVRActive(true);
 
   gvr_api_ =
@@ -349,26 +353,17 @@ void VrShell::UpdateController(const gvr::Vec3f& forward_vector) {
   // Note that button up/down state is transient, so IsButtonUp only returns
   // true for a single frame (and we're guaranteed not to miss it).
   if (controller_->IsButtonUp(
-      gvr::ControllerButton::GVR_CONTROLLER_BUTTON_APP)) {
-    if (html_interface_->GetMode() == UiInterface::Mode::MENU) {
-      // Temporary: Hit app button a second time to exit menu mode.
-      if (webvr_mode_) {
-        html_interface_->SetMode(UiInterface::Mode::WEB_VR);
-        main_thread_task_runner_->PostTask(
-            FROM_HERE, base::Bind(&device::GvrDeviceProvider::OnDisplayFocus,
-                                  delegate_->GetDeviceProvider()));
-      } else {
-        html_interface_->SetMode(UiInterface::Mode::STANDARD);
-      }
-    } else {
-      if (html_interface_->GetMode() == UiInterface::Mode::WEB_VR) {
-        main_thread_task_runner_->PostTask(
-            FROM_HERE, base::Bind(&device::GvrDeviceProvider::OnDisplayBlur,
-                                  delegate_->GetDeviceProvider()));
-      }
-      html_interface_->SetMode(UiInterface::Mode::MENU);
-      // TODO(mthiesse): The page is no longer visible here. We should unfocus
-      // or otherwise let it know it's hidden.
+          gvr::ControllerButton::GVR_CONTROLLER_BUTTON_APP)) {
+    html_interface_->SetMenuMode(!html_interface_->GetMenuMode());
+
+    // TODO(mthiesse): The page is no longer visible when in menu mode. We
+    // should unfocus or otherwise let it know it's hidden.
+    if (html_interface_->GetMode() == UiInterface::Mode::WEB_VR) {
+      const auto&& task = html_interface_->GetMenuMode() ?
+          &device::GvrDeviceProvider::OnDisplayBlur :
+          &device::GvrDeviceProvider::OnDisplayFocus;
+      main_thread_task_runner_->PostTask(
+          FROM_HERE, base::Bind(task, delegate_->GetDeviceProvider()));
     }
   }
 #endif
@@ -903,8 +898,7 @@ void VrShell::OnDomContentsLoaded() {
 void VrShell::SetWebVrMode(JNIEnv* env,
                            const base::android::JavaParamRef<jobject>& obj,
                            bool enabled) {
-  webvr_mode_ = enabled;
-  metrics_helper_->SetWebVREnabled(webvr_mode_);
+  metrics_helper_->SetWebVREnabled(enabled);
   if (enabled) {
     html_interface_->SetMode(UiInterface::Mode::WEB_VR);
   } else {
@@ -916,8 +910,7 @@ void VrShell::SetWebVRSecureOrigin(bool secure_origin) {
   html_interface_->SetSecureOrigin(secure_origin);
 }
 
-void VrShell::SubmitWebVRFrame() {
-}
+void VrShell::SubmitWebVRFrame() {}
 
 void VrShell::UpdateWebVRTextureBounds(const gvr::Rectf& left_bounds,
                                        const gvr::Rectf& right_bounds) {
@@ -1018,8 +1011,7 @@ void VrShell::DoUiAction(const UiAction action) {
 #if defined(ENABLE_VR_SHELL_UI_DEV)
     case RELOAD_UI:
       ui_contents_->GetController().Reload(false);
-      html_interface_.reset(new UiInterface);
-      html_interface_->SetMode(UiInterface::Mode::STANDARD);
+      html_interface_.reset(new UiInterface(UiInterface::Mode::STANDARD));
       vr_web_contents_observer_->SetUiInterface(html_interface_.get());
       break;
 #endif
@@ -1045,12 +1037,14 @@ jlong Init(JNIEnv* env,
            const JavaParamRef<jobject>& content_web_contents,
            jlong content_window_android,
            const JavaParamRef<jobject>& ui_web_contents,
-           jlong ui_window_android) {
+           jlong ui_window_android,
+           jboolean for_web_vr) {
   return reinterpret_cast<intptr_t>(new VrShell(
       env, obj, content::WebContents::FromJavaWebContents(content_web_contents),
       reinterpret_cast<ui::WindowAndroid*>(content_window_android),
       content::WebContents::FromJavaWebContents(ui_web_contents),
-      reinterpret_cast<ui::WindowAndroid*>(ui_window_android)));
+      reinterpret_cast<ui::WindowAndroid*>(ui_window_android),
+      for_web_vr));
 }
 
 }  // namespace vr_shell

chrome/browser/android/vr_shell/vr_shell.h

@@ -61,7 +61,8 @@ class VrShell : public device::GvrDelegate, content::WebContentsObserver {
           content::WebContents* main_contents,
           ui::WindowAndroid* content_window,
           content::WebContents* ui_contents,
-          ui::WindowAndroid* ui_window);
+          ui::WindowAndroid* ui_window,
+          bool for_web_vr);
 
   void UpdateCompositorLayers(JNIEnv* env,
                               const base::android::JavaParamRef<jobject>& obj);
@@ -196,8 +197,6 @@ class VrShell : public device::GvrDelegate, content::WebContentsObserver {
   int content_tex_height_ = 0;
   gvr::Sizei content_tex_pixels_for_webvr_ = {0, 0};
 
-  bool webvr_mode_ = false;
-
   // The pose ring buffer size must be a power of two to avoid glitches when
   // the pose index wraps around. It should be large enough to handle the
   // current backlog of poses which is 2-3 frames.

chrome/browser/android/vr_shell/vr_web_contents_observer.cc

@@ -46,13 +46,7 @@ void VrWebContentsObserver::DidFinishNavigation(
 void VrWebContentsObserver::DidToggleFullscreenModeForTab(
     bool entered_fullscreen, bool will_cause_resize) {
   // TODO(amp): Use will_cause_resize to signal ui of pending size changes.
-  int mode = ui_interface_->GetMode();
-  if (entered_fullscreen && mode == UiInterface::Mode::STANDARD) {
-    ui_interface_->SetMode(UiInterface::Mode::CINEMA);
-  }
-  if (!entered_fullscreen && mode == UiInterface::Mode::CINEMA) {
-    ui_interface_->SetMode(UiInterface::Mode::STANDARD);
-  }
+  ui_interface_->SetCinemaMode(entered_fullscreen);
 }
 
 }  // namespace vr_shell

chrome/browser/resources/vr_shell/vr_shell_ui.js

@@ -125,11 +125,12 @@ var vrShellUi = (function() {
       let descriptors = [
           ['#back', function() {
             // If we are in cinema mode, revert to standard mode on back press.
-            if (sceneManager.mode == api.Mode.CINEMA) {
+            if (sceneManager.cinemaMode) {
               // TODO(crbug/644511): Send a message back to native to handle
               // switching back to standard mode and out of full screen instead
               // of only changing the mode here.
-              sceneManager.setMode(api.Mode.STANDARD);
+              sceneManager.setMode(sceneManager.mode, sceneManager.menuMode,
+                false /* Cinema Mode */);
             } else {
               api.doAction(api.Action.HISTORY_BACK);
             }
@@ -390,6 +391,8 @@ var vrShellUi = (function() {
   class SceneManager {
     constructor() {
       this.mode = api.Mode.UNKNOWN;
+      this.menuMode = false;
+      this.cinemaMode = false;
 
       this.contentQuad = new ContentQuad();
       let contentId = this.contentQuad.getElementId();
@@ -399,17 +402,17 @@ var vrShellUi = (function() {
       this.omnibox = new Omnibox(contentId);
     }
 
-    setMode(mode) {
+    setMode(mode, menuMode, cinemaMode) {
       this.mode = mode;
-      this.contentQuad.setEnabled(
-          mode == api.Mode.STANDARD || mode == api.Mode.CINEMA);
-      this.contentQuad.setCinemaMode(mode == api.Mode.CINEMA);
+      this.menuMode = menuMode;
+      this.cinemaMode = cinemaMode;
+
+      this.contentQuad.setEnabled(mode == api.Mode.STANDARD && !menuMode);
+      this.contentQuad.setCinemaMode(cinemaMode);
       // TODO(crbug/643815): Set aspect ratio on content quad when available.
       // TODO(amp): Don't show controls in CINEMA mode once MENU mode lands.
-      this.controls.setEnabled(
-          mode == api.Mode.STANDARD || mode == api.Mode.CINEMA);
-      this.omnibox.setEnabled(
-          mode == api.Mode.STANDARD || mode == api.Mode.CINEMA);
+      this.controls.setEnabled(mode == api.Mode.STANDARD && !menuMode);
+      this.omnibox.setEnabled(mode == api.Mode.STANDARD && !menuMode);
       this.secureOriginWarnings.setEnabled(mode == api.Mode.WEB_VR);
     }
 
@@ -432,7 +435,7 @@ var vrShellUi = (function() {
 
   function command(dict) {
     if ('mode' in dict) {
-      sceneManager.setMode(dict['mode']);
+      sceneManager.setMode(dict['mode'], dict['menuMode'], dict['cinemaMode']);
     }
     if ('secureOrigin' in dict) {
       sceneManager.setSecureOrigin(dict['secureOrigin']);

chrome/browser/resources/vr_shell/vr_shell_ui_api.js

@@ -83,8 +83,6 @@ var api = (function() {
     'UNKNOWN': -1,
     'STANDARD': 0,
     'WEB_VR': 1,
-    'MENU': 2,
-    'CINEMA': 3
   });
 
   /**