Fix black background when locking with fullscreen window:

ash/wm/session_state_controller_impl2.cc

 // Copyright (c) 2012 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 "ash/wm/session_state_controller_impl2.h"
 
 #include "ash/ash_switches.h"
 #include "ash/shell.h"
 #include "ash/shell_delegate.h"
 #include "ash/shell_window_ids.h"
 #include "ash/wm/session_state_animator.h"
 #include "base/bind_helpers.h"
 #include "base/command_line.h"
+#include "base/timer.h"
 #include "ui/aura/root_window.h"
+#include "ui/compositor/scoped_layer_animation_settings.h"
 #include "ui/views/corewm/compound_event_filter.h"
 
 #if defined(OS_CHROMEOS)
 #include "base/chromeos/chromeos_version.h"
 #endif
 
 namespace ash {
 
+namespace {
+
+aura::Window* GetBackground() {
+  aura::RootWindow* root_window = Shell::GetPrimaryRootWindow();
+  return Shell::GetContainer(root_window,
+      internal::kShellWindowId_DesktopBackgroundContainer);
+}
+
+bool IsBackgroundHidden() {
+  return !GetBackground()->IsVisible();
+}
+
+void ShowBackground() {
+  ui::ScopedLayerAnimationSettings settings(
+      GetBackground()->layer()->GetAnimator());
+  settings.SetTransitionDuration(base::TimeDelta());
+  GetBackground()->Show();
+}
+
+void HideBackground() {
+  ui::ScopedLayerAnimationSettings settings(
+      GetBackground()->layer()->GetAnimator());
+  settings.SetTransitionDuration(base::TimeDelta());
+  GetBackground()->Hide();
+}
+
+} // namespace
+
 SessionStateControllerImpl2::TestApi::TestApi(
     SessionStateControllerImpl2* controller)
     : controller_(controller) {
 }
 
 SessionStateControllerImpl2::TestApi::~TestApi() {
 }
 
 SessionStateControllerImpl2::SessionStateControllerImpl2()
     : login_status_(user::LOGGED_IN_NONE),
       system_is_locked_(false),
       shutting_down_(false),
-      shutdown_after_lock_(false) {
+      shutdown_after_lock_(false),
+      animating_lock_(false),
+      undoable_lock_animation_(false) {
   Shell::GetPrimaryRootWindow()->AddRootWindowObserver(this);
 }
 
 SessionStateControllerImpl2::~SessionStateControllerImpl2() {
   Shell::GetPrimaryRootWindow()->RemoveRootWindowObserver(this);
 }
 
 void SessionStateControllerImpl2::OnLoginStateChanged(
     user::LoginStatus status) {
   if (status != user::LOGGED_IN_LOCKED)
     login_status_ = status;
   system_is_locked_ = (status == user::LOGGED_IN_LOCKED);
 }
 
 void SessionStateControllerImpl2::OnAppTerminating() {
   // If we hear that Chrome is exiting but didn't request it ourselves, all we
   // can really hope for is that we'll have time to clear the screen.
+  // This is also a case when user signs off.
   if (!shutting_down_) {
     shutting_down_ = true;
     Shell* shell = ash::Shell::GetInstance();
     shell->env_filter()->set_cursor_hidden_by_filter(false);
     shell->cursor_manager()->ShowCursor(false);
     animator_->StartAnimation(
         internal::SessionStateAnimator::kAllContainersMask,
         internal::SessionStateAnimator::ANIMATION_HIDE_IMMEDIATELY,
         internal::SessionStateAnimator::ANIMATION_SPEED_IMMEDIATE);
   }
 }
 
 void SessionStateControllerImpl2::OnLockStateChanged(bool locked) {
   if (shutting_down_ || (system_is_locked_ == locked))
     return;
 
   system_is_locked_ = locked;
 
   if (locked) {
-    base::Callback<void(void)> callback =
-        base::Bind(&SessionStateControllerImpl2::OnLockScreenAnimationFinished,
-        base::Unretained(this));
-    animator_->StartAnimationWithCallback(
-        internal::SessionStateAnimator::LOCK_SCREEN_CONTAINERS,
-        internal::SessionStateAnimator::ANIMATION_RAISE_TO_SCREEN,
-        internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
-        callback);
-    lock_timer_.Stop();
+    StartLockAnimationPhaseTwo();
     lock_fail_timer_.Stop();
   } else {
-    animator_->StartAnimation(
-        internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS |
-        internal::SessionStateAnimator::LAUNCHER,
-        internal::SessionStateAnimator::ANIMATION_DROP,
-        internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS);
+    StartUnlockAnimationPhaseTwo();
   }
 }
 
 void SessionStateControllerImpl2::SetLockScreenDisplayedCallback(
     base::Closure& callback) {
   lock_screen_displayed_callback_ = callback;
 }
 
-void SessionStateControllerImpl2::OnLockScreenAnimationFinished() {
-  FOR_EACH_OBSERVER(SessionStateObserver, observers_,
-      OnSessionStateEvent(
-          SessionStateObserver::EVENT_LOCK_ANIMATION_FINISHED));
-  if (!lock_screen_displayed_callback_.is_null()) {
-    lock_screen_displayed_callback_.Run();
-    lock_screen_displayed_callback_.Reset();
-  }
-  if (shutdown_after_lock_) {
-    shutdown_after_lock_ = false;
-    StartLockToShutdownTimer();
-  }
-}
-
 void SessionStateControllerImpl2::OnStartingLock() {
   if (shutting_down_ || system_is_locked_)
     return;
-
-  animator_->StartAnimation(
-      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS |
-      internal::SessionStateAnimator::LAUNCHER,
-      internal::SessionStateAnimator::ANIMATION_LIFT,
-      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS);
-  FOR_EACH_OBSERVER(SessionStateObserver, observers_,
-      OnSessionStateEvent(SessionStateObserver::EVENT_LOCK_ANIMATION_STARTED));
-  // Hide the screen locker containers so we can raise them later.
-  animator_->StartAnimation(
-      internal::SessionStateAnimator::LOCK_SCREEN_CONTAINERS,
-      internal::SessionStateAnimator::ANIMATION_HIDE_IMMEDIATELY,
-      internal::SessionStateAnimator::ANIMATION_SPEED_IMMEDIATE);
+  if (animating_lock_)
+    return;
+  StartImmediateLockAnimationPhaseOne();
 }
 
 void SessionStateControllerImpl2::StartLockAnimationAndLockImmediately() {
-  animator_->StartAnimation(
-      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS |
-      internal::SessionStateAnimator::LAUNCHER,
-      internal::SessionStateAnimator::ANIMATION_LIFT,
-      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS);
-  FOR_EACH_OBSERVER(SessionStateObserver, observers_,
-      OnSessionStateEvent(SessionStateObserver::EVENT_LOCK_ANIMATION_STARTED));
-  OnLockTimeout();
+  if (animating_lock_)
+    return;
+  StartImmediateLockAnimationPhaseOne();
 }
 
 void SessionStateControllerImpl2::StartLockAnimation(bool shutdown_after_lock) {
+  if (animating_lock_)
+    return;
   shutdown_after_lock_ = shutdown_after_lock;
+  undoable_lock_animation_ = true;
 
-  animator_->StartAnimation(
-      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS |
-      internal::SessionStateAnimator::LAUNCHER,
-      internal::SessionStateAnimator::ANIMATION_LIFT,
-      internal::SessionStateAnimator::ANIMATION_SPEED_UNDOABLE);
-  FOR_EACH_OBSERVER(SessionStateObserver, observers_,
-      OnSessionStateEvent(
-          SessionStateObserver::EVENT_PRELOCK_ANIMATION_STARTED));
-  StartLockTimer();
-}
-
-void SessionStateControllerImpl2::StartShutdownAnimation() {
-  animator_->StartGlobalAnimation(
-      internal::SessionStateAnimator::ANIMATION_GRAYSCALE_BRIGHTNESS,
-      internal::SessionStateAnimator::ANIMATION_SPEED_SHUTDOWN);
-  StartPreShutdownAnimationTimer();
+  StartUndoableLockAnimationPhaseOne();
 }
 
 bool SessionStateControllerImpl2::LockRequested() {
   return lock_fail_timer_.IsRunning();
 }
 
 bool SessionStateControllerImpl2::ShutdownRequested() {
   return shutting_down_;
 }
 
 bool SessionStateControllerImpl2::CanCancelLockAnimation() {
-  return lock_timer_.IsRunning();
+  return undoable_lock_animation_;
 }
 
 void SessionStateControllerImpl2::CancelLockAnimation() {
   if (!CanCancelLockAnimation())
     return;
   shutdown_after_lock_ = false;
-  animator_->StartAnimation(
-      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS |
-      internal::SessionStateAnimator::LAUNCHER,
-      internal::SessionStateAnimator::ANIMATION_DROP,
-      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS);
-  lock_timer_.Stop();
+  animating_lock_ = false;
+  UndoLockAnimationPhaseOne();
 }
 
 bool SessionStateControllerImpl2::CanCancelShutdownAnimation() {
   return pre_shutdown_timer_.IsRunning() ||
          shutdown_after_lock_ ||
          lock_to_shutdown_timer_.IsRunning();
 }
 
+void SessionStateControllerImpl2::StartShutdownAnimation() {
+  animator_->StartGlobalAnimation(
+      internal::SessionStateAnimator::ANIMATION_GRAYSCALE_BRIGHTNESS,
+      internal::SessionStateAnimator::ANIMATION_SPEED_SHUTDOWN);
+  StartPreShutdownAnimationTimer();
+}
+
 void SessionStateControllerImpl2::CancelShutdownAnimation() {
   if (!CanCancelShutdownAnimation())
     return;
   if (lock_to_shutdown_timer_.IsRunning()) {
     lock_to_shutdown_timer_.Stop();
     return;
   }
   if (shutdown_after_lock_) {
     shutdown_after_lock_ = false;
     return;
@@ skipping 13 matching lines @@
   DCHECK(!shutting_down_);
   shutting_down_ = true;
 
   Shell* shell = ash::Shell::GetInstance();
   shell->env_filter()->set_cursor_hidden_by_filter(false);
   shell->cursor_manager()->ShowCursor(false);
 
   animator_->StartGlobalAnimation(
       internal::SessionStateAnimator::ANIMATION_GRAYSCALE_BRIGHTNESS,
       internal::SessionStateAnimator::ANIMATION_SPEED_SHUTDOWN);
+
   StartRealShutdownTimer();
 }
 
 void SessionStateControllerImpl2::OnRootWindowHostCloseRequested(
                                                 const aura::RootWindow*) {
   Shell::GetInstance()->delegate()->Exit();
 }
 
-void SessionStateControllerImpl2::StartLockTimer() {
-  lock_timer_.Stop();
-  lock_timer_.Start(
-      FROM_HERE,
-      animator_->GetDuration(
-          internal::SessionStateAnimator::ANIMATION_SPEED_UNDOABLE),
-      this, &SessionStateControllerImpl2::OnLockTimeout);
-}
-
-void SessionStateControllerImpl2::OnLockTimeout() {
-  delegate_->RequestLockScreen();
-  lock_fail_timer_.Start(
-      FROM_HERE,
-      base::TimeDelta::FromMilliseconds(kLockFailTimeoutMs),
-      this, &SessionStateControllerImpl2::OnLockFailTimeout);
-}
-
 void SessionStateControllerImpl2::OnLockFailTimeout() {
   DCHECK(!system_is_locked_);
   // Undo lock animation.
-  animator_->StartAnimation(
-      internal::SessionStateAnimator::LAUNCHER |
-      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS,
-      internal::SessionStateAnimator::ANIMATION_DROP,
-      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS);
+  StartUnlockAnimationPhaseTwo();
 }
 
 void SessionStateControllerImpl2::StartLockToShutdownTimer() {
   shutdown_after_lock_ = false;
   lock_to_shutdown_timer_.Stop();
   lock_to_shutdown_timer_.Start(
       FROM_HERE,
       base::TimeDelta::FromMilliseconds(kLockToShutdownTimeoutMs),
       this, &SessionStateControllerImpl2::OnLockToShutdownTimeout);
 }
 
-
 void SessionStateControllerImpl2::OnLockToShutdownTimeout() {
   DCHECK(system_is_locked_);
   StartShutdownAnimation();
 }
 
 void SessionStateControllerImpl2::StartPreShutdownAnimationTimer() {
   pre_shutdown_timer_.Stop();
   pre_shutdown_timer_.Start(
       FROM_HERE,
       base::TimeDelta::FromMilliseconds(kShutdownTimeoutMs),
@@ skipping 25 matching lines @@
       delegate->Exit();
       return;
     }
   }
 #endif
   delegate_->RequestShutdown();
 }
 
 void SessionStateControllerImpl2::OnLockScreenHide(
   base::Callback<void(void)>& callback) {
+  StartUnlockAnimationPhaseOne(callback);
+}
+
+void SessionStateControllerImpl2::LockAnimationUndone() {
+  undoable_lock_animation_ = false;
+  RestoreUnlockedProperties();
+}
+
+void SessionStateControllerImpl2::LockAnimationPhaseOneCompleted() {
+  undoable_lock_animation_ = false;
+
+  delegate_->RequestLockScreen();
+  lock_fail_timer_.Start(
+      FROM_HERE,
+      base::TimeDelta::FromMilliseconds(kLockFailTimeoutMs),
+      this, &SessionStateControllerImpl2::OnLockFailTimeout);
+}
+
+void SessionStateControllerImpl2::LockAnimationPhaseTwoCompleted() {
+  animating_lock_ = false;
+
+  FOR_EACH_OBSERVER(SessionStateObserver, observers_,
+      OnSessionStateEvent(
+          SessionStateObserver::EVENT_LOCK_ANIMATION_FINISHED));
+  if (!lock_screen_displayed_callback_.is_null()) {
+    lock_screen_displayed_callback_.Run();
+    lock_screen_displayed_callback_.Reset();
+  }
+  if (shutdown_after_lock_) {
+    shutdown_after_lock_ = false;
+    StartLockToShutdownTimer();
+  }
+}
+
+void SessionStateControllerImpl2::UnlockAnimationPhaseTwoCompleted() {
+  RestoreUnlockedProperties();
+}
+
+void SessionStateControllerImpl2::StartImmediateLockAnimationPhaseOne() {
+  animating_lock_ = true;
+
+  StoreUnlockedProperties();
+
+  base::Closure next_animation_starter =
+      base::Bind(&SessionStateControllerImpl2::LockAnimationPhaseOneCompleted,
+      base::Unretained(this));
+  ui::LayerAnimationObserver* observer =
+      new ui::AnimationFinishedObserver(next_animation_starter);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS,
+      internal::SessionStateAnimator::ANIMATION_LIFT,
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::LAUNCHER,
+      internal::SessionStateAnimator::ANIMATION_FADE_OUT,
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+
+  // Hide the screen locker containers so we can raise them later.
+  animator_->StartAnimation(
+      internal::SessionStateAnimator::LOCK_SCREEN_CONTAINERS,
+      internal::SessionStateAnimator::ANIMATION_HIDE_IMMEDIATELY,
+      internal::SessionStateAnimator::ANIMATION_SPEED_IMMEDIATE);
+
+  AnimateBackgroundAppearanceIfNecessary(
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+
+  FOR_EACH_OBSERVER(SessionStateObserver, observers_,
+      OnSessionStateEvent(SessionStateObserver::EVENT_LOCK_ANIMATION_STARTED));
+}
+
+void SessionStateControllerImpl2::StartUndoableLockAnimationPhaseOne() {
+  animating_lock_ = true;
+  StoreUnlockedProperties();
+
+  base::Closure next_animation_starter =
+      base::Bind(&SessionStateControllerImpl2::LockAnimationPhaseOneCompleted,
+      base::Unretained(this));
+  ui::LayerAnimationObserver* observer =
+      new ui::AnimationFinishedObserver(next_animation_starter);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS,
+      internal::SessionStateAnimator::ANIMATION_LIFT,
+      internal::SessionStateAnimator::ANIMATION_SPEED_UNDOABLE,
+      observer);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::LAUNCHER,
+      internal::SessionStateAnimator::ANIMATION_FADE_OUT,
+      internal::SessionStateAnimator::ANIMATION_SPEED_UNDOABLE,
+      observer);
+
+  // Hide the screen locker containers so we can raise them later.
+  animator_->StartAnimation(
+      internal::SessionStateAnimator::LOCK_SCREEN_CONTAINERS,
+      internal::SessionStateAnimator::ANIMATION_HIDE_IMMEDIATELY,
+      internal::SessionStateAnimator::ANIMATION_SPEED_IMMEDIATE);
+
+  AnimateBackgroundAppearanceIfNecessary(
+      internal::SessionStateAnimator::ANIMATION_SPEED_UNDOABLE,
+      observer);
+
+  FOR_EACH_OBSERVER(SessionStateObserver, observers_,
+      OnSessionStateEvent(
+          SessionStateObserver::EVENT_PRELOCK_ANIMATION_STARTED));
+}
+
+void SessionStateControllerImpl2::UndoLockAnimationPhaseOne() {
+  base::Closure next_animation_starter =
+      base::Bind(&SessionStateControllerImpl2::LockAnimationUndone,
+      base::Unretained(this));
+  ui::AnimationFinishedObserver* observer =
+      new ui::AnimationFinishedObserver(next_animation_starter);
+
+  observer->Pause();
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS,
+      internal::SessionStateAnimator::ANIMATION_DROP,
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::LAUNCHER,
+      internal::SessionStateAnimator::ANIMATION_FADE_IN,
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+
+  AnimateBackgroundHidingIfNecessary(
+      internal::SessionStateAnimator::ANIMATION_SPEED_UNDOABLE,
+      observer);
+
+  observer->Unpause();
+}
+
+void SessionStateControllerImpl2::StartLockAnimationPhaseTwo() {
+  base::Closure next_animation_starter =
+      base::Bind(&SessionStateControllerImpl2::LockAnimationPhaseTwoCompleted,
+      base::Unretained(this));
+
+  ui::LayerAnimationObserver* observer =
+      new ui::AnimationFinishedObserver(next_animation_starter);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::LOCK_SCREEN_CONTAINERS,
+      internal::SessionStateAnimator::ANIMATION_RAISE_TO_SCREEN,
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+}
+
+void SessionStateControllerImpl2::StartUnlockAnimationPhaseOne(
+    base::Closure& callback) {
   animator_->StartAnimationWithCallback(
       internal::SessionStateAnimator::LOCK_SCREEN_CONTAINERS,
       internal::SessionStateAnimator::ANIMATION_LIFT,
       internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
       callback);
 }
 
+void SessionStateControllerImpl2::StartUnlockAnimationPhaseTwo() {
+  base::Closure next_animation_starter =
+      base::Bind(&SessionStateControllerImpl2::UnlockAnimationPhaseTwoCompleted,
+      base::Unretained(this));
+
+  ui::LayerAnimationObserver* observer =
+      new ui::AnimationFinishedObserver(next_animation_starter);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::NON_LOCK_SCREEN_CONTAINERS,
+      internal::SessionStateAnimator::ANIMATION_DROP,
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+
+  animator_->StartAnimationWithObserver(
+      internal::SessionStateAnimator::LAUNCHER,
+      internal::SessionStateAnimator::ANIMATION_FADE_IN,
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+
+  AnimateBackgroundHidingIfNecessary(
+      internal::SessionStateAnimator::ANIMATION_SPEED_MOVE_WINDOWS,
+      observer);
+}
+
+void SessionStateControllerImpl2::StoreUnlockedProperties() {
+  if (!unlocked_properties_.get()) {
+    unlocked_properties_.reset(new UnlockedStateProperties());
+    unlocked_properties_->background_is_hidden = IsBackgroundHidden();
+  }
+  if (unlocked_properties_->background_is_hidden) {
+    // Hide background so that it can be animated later.
+    animator_->StartAnimation(
+        internal::SessionStateAnimator::DESKTOP_BACKGROUND,
+        internal::SessionStateAnimator::ANIMATION_HIDE_IMMEDIATELY,
+        internal::SessionStateAnimator::ANIMATION_SPEED_IMMEDIATE);
+    ShowBackground();
+  }
+}
+
+void SessionStateControllerImpl2::RestoreUnlockedProperties() {
+  if (!unlocked_properties_.get())
+    return;
+  if (unlocked_properties_->background_is_hidden) {
+    HideBackground();
+    // Restore background visibility.
+    animator_->StartAnimation(
+        internal::SessionStateAnimator::DESKTOP_BACKGROUND,
+        internal::SessionStateAnimator::ANIMATION_FADE_IN,
+        internal::SessionStateAnimator::ANIMATION_SPEED_IMMEDIATE);
+  }
+  unlocked_properties_.reset();
+}
+
+void SessionStateControllerImpl2::AnimateBackgroundAppearanceIfNecessary(
+    internal::SessionStateAnimator::AnimationSpeed speed,
+    ui::LayerAnimationObserver* observer) {
+  if (unlocked_properties_.get() &&
+      unlocked_properties_->background_is_hidden) {
+    animator_->StartAnimationWithObserver(
+        internal::SessionStateAnimator::DESKTOP_BACKGROUND,
+        internal::SessionStateAnimator::ANIMATION_FADE_IN,
+        speed,
+        observer);
+  }
+}
+
+void SessionStateControllerImpl2::AnimateBackgroundHidingIfNecessary(
+    internal::SessionStateAnimator::AnimationSpeed speed,
+    ui::LayerAnimationObserver* observer) {
+  if (unlocked_properties_.get() &&
+      unlocked_properties_->background_is_hidden) {
+    animator_->StartAnimationWithObserver(
+        internal::SessionStateAnimator::DESKTOP_BACKGROUND,
+        internal::SessionStateAnimator::ANIMATION_FADE_OUT,
+        speed,
+        observer);
+  }
+}
+
 }  // namespace ash