Implement WebVR presentation pausing for VR Shell Menu Mode

chrome/browser/android/vr_shell/vr_shell.cc

 // 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.
 
 #include "chrome/browser/android/vr_shell/vr_shell.h"
 
 #include "base/metrics/histogram_macros.h"
 #include "chrome/browser/android/vr_shell/ui_elements.h"
 #include "chrome/browser/android/vr_shell/ui_interface.h"
 #include "chrome/browser/android/vr_shell/ui_scene.h"
 #include "chrome/browser/android/vr_shell/vr_compositor.h"
 #include "chrome/browser/android/vr_shell/vr_controller.h"
 #include "chrome/browser/android/vr_shell/vr_gl_util.h"
 #include "chrome/browser/android/vr_shell/vr_input_manager.h"
 #include "chrome/browser/android/vr_shell/vr_shell_delegate.h"
 #include "chrome/browser/android/vr_shell/vr_shell_renderer.h"
 #include "content/public/browser/navigation_controller.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/render_widget_host.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/common/referrer.h"
 #include "content/public/common/screen_info.h"
+#include "device/vr/android/gvr/gvr_device_provider.h"
 #include "jni/VrShellImpl_jni.h"
 #include "ui/android/view_android.h"
 #include "ui/android/window_android.h"
 #include "ui/base/page_transition_types.h"
 #include "ui/gl/gl_bindings.h"
 #include "ui/gl/init/gl_factory.h"
 
 using base::android::JavaParamRef;
 
 namespace {
@@ skipping 142 matching lines @@
   g_instance = nullptr;
   gl::init::ClearGLBindings();
 }
 
 void VrShell::SetDelegate(JNIEnv* env,
     const base::android::JavaParamRef<jobject>& obj,
     const base::android::JavaParamRef<jobject>& delegate) {
   delegate_ = VrShellDelegate::getNativeDelegate(env, delegate);
 }
 
-enum class ViewerType
-{
+enum class ViewerType {
   UNKNOWN_TYPE = 0,
   CARDBOARD = 1,
   DAYDREAM = 2,
   VIEWER_TYPE_MAX,
 };
 
 void VrShell::GvrInit(JNIEnv* env,
                       const JavaParamRef<jobject>& obj,
                       jlong native_gvr_api) {
   gvr_api_ =
       gvr::GvrApi::WrapNonOwned(reinterpret_cast<gvr_context*>(native_gvr_api));
 
   if (delegate_)
     delegate_->OnVrShellReady(this);
   controller_.reset(
       new VrController(reinterpret_cast<gvr_context*>(native_gvr_api)));
   content_input_manager_ = new VrInputManager(main_contents_);
   ui_input_manager_ = new VrInputManager(ui_contents_);
 
   ViewerType viewerType;
-  switch (gvr_api_->GetViewerType())
-  {
+  switch (gvr_api_->GetViewerType()) {
     case gvr::ViewerType::GVR_VIEWER_TYPE_DAYDREAM:
       viewerType = ViewerType::DAYDREAM;
       break;
     case gvr::ViewerType::GVR_VIEWER_TYPE_CARDBOARD:
       viewerType = ViewerType::CARDBOARD;
       break;
     default:
       NOTREACHED();
       viewerType = ViewerType::UNKNOWN_TYPE;
       break;
@@ skipping 41 matching lines @@
       new gvr::BufferViewport(gvr_api_->CreateBufferViewport()));
   buffer_viewport_list_->GetBufferViewport(GVR_RIGHT_EYE,
                                            headlocked_right_viewport_.get());
   headlocked_right_viewport_->SetSourceBufferIndex(kFrameHeadlockedBuffer);
   headlocked_right_viewport_->SetReprojection(GVR_REPROJECTION_NONE);
 }
 
 void VrShell::UpdateController(const gvr::Vec3f& forward_vector) {
   controller_->UpdateState();
   std::unique_ptr<WebGestureEvent> gesture = controller_->DetectGesture();
-
+#if defined(ENABLE_VR_SHELL)
+  // 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);
+        delegate_->GetDeviceProvider()->ResumePresent();
+      } else {
+        html_interface_->SetMode(UiInterface::Mode::STANDARD);
+      }
+    } else {
+      if (html_interface_->GetMode() == UiInterface::Mode::WEB_VR) {
+        delegate_->GetDeviceProvider()->PausePresent();
+      }
+      html_interface_->SetMode(UiInterface::Mode::MENU);
+      // TODO(mthiesse): Also pause tracking for all webvr pages.

[bajones, 2016/11/01 18:11:31]

Is this comment accurate? Seems like we're already doing that?

[mthiesse, 2016/11/02 14:39:02]

As discussed offline, we're going to ignore the non-presenting WebVR case for
now as it's causing a lot of problems and we may not ship with it.

[bshe, 2016/11/02 14:58:40]

Does this mean magic window mode won't ship in normal 2d browser? Or do you mean
it won't be available in ChromeVR?

[mthiesse, 2016/11/02 15:03:32]

It doesn't mean either of those things. It means we haven't decided yet, so I'm
going to hold off on writing the code to pause WebVR for now. Right now we don't
even have a way to know which Device VR Shell is using, so we don't have a way
to find all of the WebVR pages using the same device.

+    }
+  }
+#endif
+  if (html_interface_->GetMode() == UiInterface::Mode::WEB_VR) {
+    return;
+  }
   // TODO(asimjour) for now, scroll is sent to the main content.
   if (gesture->type == WebInputEvent::GestureScrollBegin ||
       gesture->type == WebInputEvent::GestureScrollUpdate ||
       gesture->type == WebInputEvent::GestureScrollEnd) {
     content_input_manager_->ProcessUpdatedGesture(*gesture.get());
   }
 
   WebInputEvent::Type original_type = gesture->type;
   gvr::Vec3f ergo_neutral_pose;
   if (!controller_->IsConnected()) {
@@ skipping 119 matching lines @@
 void VrShell::SetGvrPoseForWebVr(const gvr::Mat4f& pose, uint32_t pose_num) {
   webvr_head_pose_[pose_num % kPoseRingBufferSize] = pose;
 }
 
 uint32_t GetPixelEncodedPoseIndex() {
   // Read the pose index encoded in a bottom left pixel as color values.
   // See also third_party/WebKit/Source/modules/vr/VRDisplay.cpp which
   // encodes the pose index, and device/vr/android/gvr/gvr_device.cc
   // which tracks poses.
   uint8_t pixels[4];
-  // Assume we're reading from the frambebuffer we just wrote to.
+  // Assume we're reading from the framebuffer we just wrote to.
   // That's true currently, we may need to use glReadBuffer(GL_BACK)
   // or equivalent if the rendering setup changes in the future.
   glReadPixels(0, 0, 1, 1, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
   return pixels[0] | (pixels[1] << 8) | (pixels[2] << 16);
 }
 
 void VrShell::DrawFrame(JNIEnv* env, const JavaParamRef<jobject>& obj) {
   buffer_viewport_list_->SetToRecommendedBufferViewports();
 
   gvr::Frame frame = swap_chain_->AcquireFrame();
@@ skipping 400 matching lines @@
            const JavaParamRef<jobject>& ui_web_contents,
            jlong ui_window_android) {
   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)));
 }
 
 }  // namespace vr_shell