[Chromecast] Reuse the Aura window manager across receiver apps.

chromecast/graphics/cast_window_manager_aura.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 "chromecast/graphics/cast_window_manager_aura.h"
+
+#include "ui/aura/client/default_capture_client.h"
+#include "ui/aura/env.h"
+#include "ui/aura/layout_manager.h"
+#include "ui/aura/window.h"
+#include "ui/aura/window_tree_host_platform.h"
+#include "ui/base/ime/input_method.h"
+#include "ui/base/ime/input_method_factory.h"
+#include "ui/display/display.h"
+#include "ui/display/screen.h"
+
+namespace chromecast {
+
+// An aura::WindowTreeHost that correctly converts input events.
+class CastWindowTreeHost : public aura::WindowTreeHostPlatform {
+ public:
+  CastWindowTreeHost(bool enable_input, const gfx::Rect& bounds);
+  ~CastWindowTreeHost() override;
+
+  // aura::WindowTreeHostPlatform implementation:
+  void DispatchEvent(ui::Event* event) override;
+
+ private:
+  const bool enable_input_;
+
+  DISALLOW_COPY_AND_ASSIGN(CastWindowTreeHost);
+};
+
+CastWindowTreeHost::CastWindowTreeHost(bool enable_input,
+                                       const gfx::Rect& bounds)
+    : WindowTreeHostPlatform(bounds), enable_input_(enable_input) {}
+
+CastWindowTreeHost::~CastWindowTreeHost() {}
+
+void CastWindowTreeHost::DispatchEvent(ui::Event* event) {
+  if (!enable_input_) {
+    return;
+  }
+
+  if (event->IsKeyEvent()) {
+    // Convert a RawKeyDown into a character insertion; otherwise
+    // the WebContents will ignore most keyboard input.
+    GetInputMethod()->DispatchKeyEvent(event->AsKeyEvent());
+  } else {
+    WindowTreeHostPlatform::DispatchEvent(event);
+  }
+}
+
+// A layout manager owned by the root window.
+class CastLayoutManager : public aura::LayoutManager {
+ public:
+  CastLayoutManager();
+  ~CastLayoutManager() override;
+
+ private:
+  // aura::LayoutManager implementation:
+  void OnWindowResized() override;
+  void OnWindowAddedToLayout(aura::Window* child) override;
+  void OnWillRemoveWindowFromLayout(aura::Window* child) override;
+  void OnWindowRemovedFromLayout(aura::Window* child) override;
+  void OnChildWindowVisibilityChanged(aura::Window* child,
+                                      bool visible) override;
+  void SetChildBounds(aura::Window* child,
+                      const gfx::Rect& requested_bounds) override;
+
+  DISALLOW_COPY_AND_ASSIGN(CastLayoutManager);
+};
+
+CastLayoutManager::CastLayoutManager() {}
+CastLayoutManager::~CastLayoutManager() {}
+
+void CastLayoutManager::OnWindowResized() {
+  // Invoked when the root window of the window tree host has been resized.
+}
+
+void CastLayoutManager::OnWindowAddedToLayout(aura::Window* child) {
+  // Invoked when a window is added to the window tree host.
+}
+
+void CastLayoutManager::OnWillRemoveWindowFromLayout(aura::Window* child) {
+  // Invoked when the root window of the window tree host will be removed.
+}
+
+void CastLayoutManager::OnWindowRemovedFromLayout(aura::Window* child) {
+  // Invoked when the root window of the window tree host has been removed.
+}
+
+void CastLayoutManager::OnChildWindowVisibilityChanged(aura::Window* child,
+                                                       bool visible) {
+  // Note: this is invoked for child windows of the root window.
+}
+
+void CastLayoutManager::SetChildBounds(aura::Window* child,
+                                       const gfx::Rect& requested_bounds) {
+  SetChildBoundsDirect(child, requested_bounds);
+}
+
+// static
+std::unique_ptr<CastWindowManager> CastWindowManager::Create(
+    bool enable_input) {
+  return base::WrapUnique(new CastWindowManagerAura(enable_input));
+}
+
+CastWindowManagerAura::CastWindowManagerAura(bool enable_input)
+    : enable_input_(enable_input) {}
+
+CastWindowManagerAura::~CastWindowManagerAura() {
+  TearDown();
+}
+
+void CastWindowManagerAura::Setup() {
+  if (window_tree_host_) {

[halliwell, 2017/01/18 02:55:18]

Do we expect clients to get Setup/Teardown sequence wrong?  i.e. should this be
DCHECK(!window_tree_host_) ?

+    return;
+  }
+  LOG(INFO) << "Starting window manager.";

[halliwell, 2017/01/18 02:55:18]

how important is this?  maybe at least combine with screen size logging below?

[Joshua LeVasseur, 2017/01/18 18:26:35]

Done.

+  DCHECK(display::Screen::GetScreen());
+
+  ui::InitializeInputMethodForTesting();
+
+  gfx::Size display_size =
+      display::Screen::GetScreen()->GetPrimaryDisplay().GetSizeInPixel();
+  LOG(INFO) << "Screen size: " << display_size.width() << "x"
+            << display_size.height();
+  CHECK(aura::Env::GetInstance());
+  window_tree_host_.reset(
+      new CastWindowTreeHost(enable_input_, gfx::Rect(display_size)));
+  window_tree_host_->InitHost();
+  window_tree_host_->window()->SetLayoutManager(new CastLayoutManager());
+
+  // Allow seeing through to the hardware video plane:
+  window_tree_host_->compositor()->SetHostHasTransparentBackground(true);
+  window_tree_host_->compositor()->SetBackgroundColor(SK_ColorTRANSPARENT);
+
+  capture_client_.reset(
+      new aura::client::DefaultCaptureClient(window_tree_host_->window()));
+
+  CastVSyncSettings::GetInstance()->AddObserver(this);
+  window_tree_host_->compositor()->SetAuthoritativeVSyncInterval(
+      CastVSyncSettings::GetInstance()->GetVSyncInterval());
+
+  window_tree_host_->Show();
+}
+
+void CastWindowManagerAura::TearDown() {
+  if (!window_tree_host_) {

[halliwell, 2017/01/18 02:55:18]

ditto question on calling sequence

+    return;
+  }
+  CastVSyncSettings::GetInstance()->RemoveObserver(this);
+  capture_client_.reset();
+  window_tree_host_.reset();
+}
+
+void CastWindowManagerAura::AddAndShowWindow(gfx::NativeView child) {
+  AddWindow(child);
+  child->Show();
+}
+
+void CastWindowManagerAura::AddWindow(gfx::NativeView child) {
+  LOG(INFO) << "Adding window: " << child->id() << ": " << child->GetName();

[derekjchow1, 2017/01/18 02:49:13]

DLOG perhaps? Do you expect to need this debugging the features in production?

[Joshua LeVasseur, 2017/01/18 18:26:35]

I'm not sure.  I figured it would be good to have in the log to help debug
unexpected behaviors.

+  Setup();

[halliwell, 2017/01/18 02:55:18]

I guess this would lead to multiple Setup calls.  Wonder if it's better to be an
error to add windows when it's not set up?  It kind of seems like this class
doesn't make its mind up between needing explicit setup/teardown management vs
just handling that automatically.

[Joshua LeVasseur, 2017/01/18 06:00:57]

I set it up for on-demand initialization to mimic the initialization sequence
that already existed.  I'm fine with converting it to use an explicit setup
step, but then the Cast shell will initialize in a slightly different order.

+
+  DCHECK(child);
+  aura::Window* parent = window_tree_host_->window();
+  if (!parent->Contains(child)) {
+    parent->AddChild(child);
+  }
+
+  parent->StackChildAtTop(child);
+  child->SetBounds(window_tree_host_->window()->bounds());
+}
+
+void CastWindowManagerAura::OnVSyncIntervalChanged(base::TimeDelta interval) {
+  DCHECK(window_tree_host_.get());
+  window_tree_host_->compositor()->SetAuthoritativeVSyncInterval(interval);
+}
+
+}  // namespace chromecast