LayerTreeHost::SetAnimationEvents should use AnimationRegistrar

cc/animation/layer_animation_controller.cc

 // Copyright 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 "cc/animation/layer_animation_controller.h"
 
 #include <algorithm>
 
 #include "cc/animation/animation.h"
 #include "cc/animation/animation_registrar.h"
 #include "cc/animation/keyframed_animation_curve.h"
 #include "cc/animation/layer_animation_value_observer.h"
 #include "cc/base/scoped_ptr_algorithm.h"
+#include "third_party/WebKit/Source/Platform/chromium/public/WebAnimationDelegate.h"
 #include "ui/gfx/transform.h"
 
 namespace cc {
 
 LayerAnimationController::LayerAnimationController(int id)
     : force_sync_(false),
       registrar_(0),
       id_(id),
       is_active_(false),
-      last_tick_time_(0) {}
+      last_tick_time_(0),
+      layer_animation_delegate_(NULL) {}
 
 LayerAnimationController::~LayerAnimationController() {
   if (registrar_)
     registrar_->UnregisterAnimationController(this);
 }
 
 scoped_refptr<LayerAnimationController> LayerAnimationController::Create(
     int id) {
   return make_scoped_refptr(new LayerAnimationController(id));
 }
@@ skipping 68 matching lines @@
   for (size_t i = 0; i < active_animations_.size(); ++i) {
     if (active_animations_[i]->run_state() == Animation::Paused)
       active_animations_[i]->SetRunState(Animation::Running, monotonic_time);
   }
 }
 
 // Ensures that the list of active animations on the main thread and the impl
 // thread are kept in sync.
 void LayerAnimationController::PushAnimationUpdatesTo(
     LayerAnimationController* controller_impl) {
+  DCHECK(this != controller_impl);
   if (force_sync_) {
     ReplaceImplThreadAnimations(controller_impl);
     force_sync_ = false;
   } else {
     PurgeAnimationsMarkedForDeletion();
     PushNewAnimationsToImplThread(controller_impl);
 
     // Remove finished impl side animations only after pushing,
     // and only after the animations are deleted on the main thread
     // this insures we will never push an animation twice.
     RemoveAnimationsCompletedOnMainThread(controller_impl);
 
     PushPropertiesToImplThread(controller_impl);
   }
   controller_impl->UpdateActivation(NormalActivation);
   UpdateActivation(NormalActivation);
 }
 
+void LayerAnimationController::TransferAnimationsTo(
+    LayerAnimationController* other_controller) {
+  other_controller->active_animations_.clear();
+  active_animations_.swap(other_controller->active_animations_);
+  UpdateActivation(NormalActivation);
+  set_force_sync();

[Ian Vollick, 2013/04/04 18:38:58]

other_controller->UpdateActivation(NormalActivation)?

[ajuma, 2013/04/05 14:38:18]

Done.

+  other_controller->set_force_sync();
+  other_controller->SetAnimationRegistrar(registrar_);
+}
+
 void LayerAnimationController::Animate(double monotonic_time) {
   if (!HasActiveObserver())
     return;
 
   StartAnimationsWaitingForNextTick(monotonic_time);
   StartAnimationsWaitingForStartTime(monotonic_time);
   StartAnimationsWaitingForTargetAvailability(monotonic_time);
   ResolveConflicts(monotonic_time);
   TickAnimations(monotonic_time);
   last_tick_time_ = monotonic_time;
@@ skipping 78 matching lines @@
   for (size_t i = 0; i < active_animations_.size(); ++i) {
     if (!active_animations_[i]->is_finished())
       return true;
   }
   return false;
 }
 
 bool LayerAnimationController::IsAnimatingProperty(
     Animation::TargetProperty target_property) const {
   for (size_t i = 0; i < active_animations_.size(); ++i) {
-    if (active_animations_[i]->run_state() != Animation::Finished &&
-        active_animations_[i]->run_state() != Animation::Aborted &&
+    if (!active_animations_[i]->is_finished() &&
         active_animations_[i]->target_property() == target_property)
       return true;
   }
   return false;
 }
 
-void LayerAnimationController::OnAnimationStarted(
-    const AnimationEvent& event) {
-  for (size_t i = 0; i < active_animations_.size(); ++i) {
-    if (active_animations_[i]->group() == event.group_id &&
-        active_animations_[i]->target_property() == event.target_property &&
-        active_animations_[i]->needs_synchronized_start_time()) {
-      active_animations_[i]->set_needs_synchronized_start_time(false);
-      active_animations_[i]->set_start_time(event.monotonic_time);
-      return;
-    }
-  }
-}
-
 void LayerAnimationController::SetAnimationRegistrar(
     AnimationRegistrar* registrar) {
   if (registrar_ == registrar)
     return;
 
   if (registrar_)
     registrar_->UnregisterAnimationController(this);
 
   registrar_ = registrar;
   if (registrar_)
     registrar_->RegisterAnimationController(this);
 
   UpdateActivation(ForceActivation);
 }
 
-void LayerAnimationController::AddObserver(
-    LayerAnimationValueObserver* observer) {
-  if (!observers_.HasObserver(observer))
-    observers_.AddObserver(observer);
+void LayerAnimationController::NotifyAnimationStarted(
+    const AnimationEvent& event,
+    double wall_clock_time) {
+  for (size_t i = 0; i < active_animations_.size(); ++i) {
+    if (active_animations_[i]->group() == event.group_id &&
+        active_animations_[i]->target_property() == event.target_property &&
+        active_animations_[i]->needs_synchronized_start_time()) {
+      active_animations_[i]->set_needs_synchronized_start_time(false);
+      active_animations_[i]->set_start_time(event.monotonic_time);
+
+      FOR_EACH_OBSERVER(LayerAnimationEventObserver, event_observers_,
+                        OnAnimationStarted(event));
+      if (layer_animation_delegate_)
+        layer_animation_delegate_->notifyAnimationStarted(wall_clock_time);
+
+      return;
+    }
+  }
 }
 
-void LayerAnimationController::RemoveObserver(
+void LayerAnimationController::NotifyAnimationFinished(
+    const AnimationEvent& event,
+    double wall_clock_time) {
+  for (size_t i = 0; i < active_animations_.size(); ++i) {
+    if (active_animations_[i]->group() == event.group_id &&
+        active_animations_[i]->target_property() == event.target_property) {
+      active_animations_[i]->set_received_finished_event(true);
+      if (layer_animation_delegate_)
+        layer_animation_delegate_->notifyAnimationFinished(wall_clock_time);
+
+      return;
+    }
+  }
+}
+
+void LayerAnimationController::NotifyAnimationPropertyUpdate(
+    const AnimationEvent& event) {
+  switch (event.target_property) {
+    case Animation::Opacity:
+      NotifyObserversOpacityAnimated(event.opacity);
+      break;
+    case Animation::Transform:
+      NotifyObserversTransformAnimated(event.transform);
+      break;
+    default:
+      NOTREACHED();
+  }
+}
+
+void LayerAnimationController::AddValueObserver(
     LayerAnimationValueObserver* observer) {
-  observers_.RemoveObserver(observer);
+  if (!value_observers_.HasObserver(observer))
+    value_observers_.AddObserver(observer);
+}
+
+void LayerAnimationController::RemoveValueObserver(
+    LayerAnimationValueObserver* observer) {
+  value_observers_.RemoveObserver(observer);
+}
+
+void LayerAnimationController::AddEventObserver(
+    LayerAnimationEventObserver* observer) {
+  if (!event_observers_.HasObserver(observer))
+    event_observers_.AddObserver(observer);
+}
+
+void LayerAnimationController::RemoveEventObserver(
+    LayerAnimationEventObserver* observer) {
+  event_observers_.RemoveObserver(observer);
 }
 
 void LayerAnimationController::PushNewAnimationsToImplThread(
     LayerAnimationController* controller_impl) const {
   // Any new animations owned by the main thread's controller are cloned and
   // add to the impl thread's controller.
   for (size_t i = 0; i < active_animations_.size(); ++i) {
     // If the animation is already running on the impl thread, there is no
     // need to copy it over.
     if (controller_impl->GetAnimation(active_animations_[i]->group(),
@@ skipping 17 matching lines @@
         Animation::ControllingInstance, initial_run_state, start_time));
     DCHECK(!to_add->needs_synchronized_start_time());
     controller_impl->AddAnimation(to_add.Pass());
   }
 }
 
 struct IsCompleted {
   explicit IsCompleted(const LayerAnimationController& main_thread_controller)
       : main_thread_controller_(main_thread_controller) {}
   bool operator()(Animation* animation) const {
-    if (animation->is_impl_only())
-      return false;
-    return !main_thread_controller_.GetAnimation(animation->group(),
-                                                 animation->target_property());
+    if (animation->is_impl_only()) {

[Ian Vollick, 2013/04/04 18:38:58]

nit: no braces.

[ajuma, 2013/04/05 14:38:18]

Since the 'else' requires braces, so does the 'if' (according to the style
guide).

+      return (animation->run_state() == Animation::WaitingForDeletion);
+    } else {
+      return !main_thread_controller_.GetAnimation(
+          animation->group(),
+          animation->target_property());
+    }
   }
 
  private:
   const LayerAnimationController& main_thread_controller_;
 };
 
 void LayerAnimationController::RemoveAnimationsCompletedOnMainThread(
     LayerAnimationController* controller_impl) const {
   // Delete all impl thread animations for which there is no corresponding
   // main thread animation. Each iteration,
@@ skipping 36 matching lines @@
       active_animations_[i]->SetRunState(Animation::Starting, monotonic_time);
   }
 }
 
 void LayerAnimationController::StartAnimationsWaitingForTargetAvailability(
     double monotonic_time) {
   // First collect running properties.
   TargetProperties blocked_properties;
   for (size_t i = 0; i < active_animations_.size(); ++i) {
     if (active_animations_[i]->run_state() == Animation::Starting ||
-        active_animations_[i]->run_state() == Animation::Running ||
-        active_animations_[i]->run_state() == Animation::Finished)
+        active_animations_[i]->run_state() == Animation::Running)
       blocked_properties.insert(active_animations_[i]->target_property());
   }
 
   for (size_t i = 0; i < active_animations_.size(); ++i) {
     if (active_animations_[i]->run_state() ==
         Animation::WaitingForTargetAvailability) {
       // Collect all properties for animations with the same group id (they
       // should all also be in the list of animations).
       TargetProperties enqueued_properties;
       enqueued_properties.insert(active_animations_[i]->target_property());
@@ skipping 46 matching lines @@
             active_animations_[i]->group(),
             active_animations_[i]->target_property(),
             monotonic_time));
       }
     }
   }
 }
 
 void LayerAnimationController::MarkFinishedAnimations(double monotonic_time) {
   for (size_t i = 0; i < active_animations_.size(); ++i) {
-    if (active_animations_[i]->IsFinishedAt(monotonic_time))
+    if (active_animations_[i]->IsFinishedAt(monotonic_time) &&
+        active_animations_[i]->run_state() != Animation::WaitingForDeletion)
       active_animations_[i]->SetRunState(Animation::Finished, monotonic_time);
   }
 }
 
 void LayerAnimationController::ResolveConflicts(double monotonic_time) {
   // Find any animations that are animating the same property and resolve the
   // confict. We could eventually blend, but for now we'll just abort the
   // previous animation (where 'previous' means: (1) has a prior start time or
   // (2) has an equal start time, but was added to the queue earlier, i.e.,
   // has a lower index in active_animations_).
@@ skipping 14 matching lines @@
                                                monotonic_time);
           }
         }
       }
     }
   }
 }
 
 void LayerAnimationController::MarkAnimationsForDeletion(
     double monotonic_time, AnimationEventsVector* events) {
+  // Non-aborted animations are marked for deletion after a corresponding
+  // AnimationEvent::Finished event is sent or received. This means that if
+  // we don't have an events vector, we must ensure that non-aborted animations
+  // have received a finished event before marking them for deletion.
   for (size_t i = 0; i < active_animations_.size(); i++) {
     int group_id = active_animations_[i]->group();
     bool all_anims_with_same_id_are_finished = false;
     // If an animation is finished, and not already marked for deletion,
-    // Find out if all other animations in the same group are also finished.
-    if (active_animations_[i]->is_finished() &&
-        active_animations_[i]->run_state() != Animation::WaitingForDeletion) {
+    // find out if all other animations in the same group are also finished.
+    if (active_animations_[i]->run_state() == Animation::Aborted ||
+        (active_animations_[i]->run_state() == Animation::Finished &&
+         (events || active_animations_[i]->received_finished_event()))) {

[Ian Vollick, 2013/04/04 18:38:58]

Please put (events || active_animations_[i]->received_finished_event()) in a
temporary and add a comment to the temporary explaining why the rules are
different on each thread.

[ajuma, 2013/04/05 14:38:18]

Done.

       all_anims_with_same_id_are_finished = true;
       for (size_t j = 0; j < active_animations_.size(); ++j) {
         if (group_id == active_animations_[j]->group() &&
-            !active_animations_[j]->is_finished()) {
+            (!active_animations_[j]->is_finished() ||
+             (active_animations_[j]->run_state() == Animation::Finished &&
+              !events &&
+              !active_animations_[j]->received_finished_event()))) {

[Ian Vollick, 2013/04/04 18:38:58]

Same thing here (these complicated conditions are quite hard to follow).

[ajuma, 2013/04/05 14:38:18]

Done.

           all_anims_with_same_id_are_finished = false;
           break;
         }
       }
     }
     if (all_anims_with_same_id_are_finished) {
       // We now need to remove all animations with the same group id as
       // group_id (and send along animation finished notifications, if
       // necessary).
       for (size_t j = i; j < active_animations_.size(); j++) {
@@ skipping 100 matching lines @@
     if (!active_animations_.empty() && (!is_active_ || force))
       registrar_->DidActivateAnimationController(this);
     else if (active_animations_.empty() && (is_active_ || force))
       registrar_->DidDeactivateAnimationController(this);
     is_active_ = !active_animations_.empty();
   }
 }
 
 void LayerAnimationController::NotifyObserversOpacityAnimated(float opacity) {
   FOR_EACH_OBSERVER(LayerAnimationValueObserver,
-                    observers_,
+                    value_observers_,
                     OnOpacityAnimated(opacity));
 }
 
 void LayerAnimationController::NotifyObserversTransformAnimated(
     const gfx::Transform& transform) {
   FOR_EACH_OBSERVER(LayerAnimationValueObserver,
-                    observers_,
+                    value_observers_,
                     OnTransformAnimated(transform));
 }
 
 bool LayerAnimationController::HasActiveObserver() {

[Ian Vollick, 2013/04/04 18:38:58]

HasActiveValueObserver

[ajuma, 2013/04/05 14:38:18]

Done.

-  if (observers_.might_have_observers()) {
-    ObserverListBase<LayerAnimationValueObserver>::Iterator it(observers_);
+  if (value_observers_.might_have_observers()) {
+    ObserverListBase<LayerAnimationValueObserver>::Iterator it(
+        value_observers_);
     LayerAnimationValueObserver* obs;
     while ((obs = it.GetNext()) != NULL)
       if (obs->IsActive())
         return true;
   }
   return false;
 }
 
 }  // namespace cc