dom/animation/PendingPlayerTracker.cpp

   1 /* vim: set shiftwidth=2 tabstop=8 autoindent cindent expandtab: */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "PendingPlayerTracker.h"
   7
   8 #include "mozilla/dom/AnimationTimeline.h"
   9 #include "nsIFrame.h"
  10 #include "nsIPresShell.h"
  11
  12 using namespace mozilla;
  13
  14 namespace mozilla {
  15
  16 NS_IMPL_CYCLE_COLLECTION(PendingPlayerTracker, mPlayPendingSet, mDocument)
  17
  18 NS_IMPL_CYCLE_COLLECTION_ROOT_NATIVE(PendingPlayerTracker, AddRef)
  19 NS_IMPL_CYCLE_COLLECTION_UNROOT_NATIVE(PendingPlayerTracker, Release)
  20
  21 void
  22 PendingPlayerTracker::AddPlayPending(dom::AnimationPlayer& aPlayer)
  23 {
  24   mPlayPendingSet.PutEntry(&aPlayer);
  25
  26   // Schedule a paint. Otherwise animations that don't trigger a paint by
  27   // themselves (e.g. CSS animations with an empty keyframes rule) won't
  28   // start until something else paints.
  29   EnsurePaintIsScheduled();
  30 }
  31
  32 void
  33 PendingPlayerTracker::RemovePlayPending(dom::AnimationPlayer& aPlayer)
  34 {
  35   mPlayPendingSet.RemoveEntry(&aPlayer);
  36 }
  37
  38 bool
  39 PendingPlayerTracker::IsWaitingToPlay(dom::AnimationPlayer const& aPlayer) const
  40 {
  41   return mPlayPendingSet.Contains(const_cast<dom::AnimationPlayer*>(&aPlayer));
  42 }
  43
  44 PLDHashOperator
  45 StartPlayerAtTime(nsRefPtrHashKey<dom::AnimationPlayer>* aKey,
  46                   void* aReadyTime)
  47 {
  48   dom::AnimationPlayer* player = aKey->GetKey();
  49   dom::AnimationTimeline* timeline = player->Timeline();
  50
  51   // When the timeline's refresh driver is under test control, its values
  52   // have no correspondance to wallclock times so we shouldn't try to convert
  53   // aReadyTime (which is a wallclock time) to a timeline value. Instead, the
  54   // animation player will be started when the refresh driver is next
  55   // advanced since this will trigger a call to StartPendingPlayersNow.
  56   if (timeline->IsUnderTestControl()) {
  57     return PL_DHASH_NEXT;
  58   }
  59
  60   Nullable<TimeDuration> readyTime =
  61     timeline->ToTimelineTime(*static_cast<const TimeStamp*>(aReadyTime));
  62   player->StartOnNextTick(readyTime);
  63
  64   return PL_DHASH_REMOVE;
  65 }
  66
  67 void
  68 PendingPlayerTracker::StartPendingPlayersOnNextTick(const TimeStamp& aReadyTime)
  69 {
  70   mPlayPendingSet.EnumerateEntries(StartPlayerAtTime,
  71                                    const_cast<TimeStamp*>(&aReadyTime));
  72 }
  73
  74 PLDHashOperator
  75 StartPlayerNow(nsRefPtrHashKey<dom::AnimationPlayer>* aKey, void*)
  76 {
  77   aKey->GetKey()->StartNow();
  78   return PL_DHASH_NEXT;
  79 }
  80
  81 void
  82 PendingPlayerTracker::StartPendingPlayersNow()
  83 {
  84   mPlayPendingSet.EnumerateEntries(StartPlayerNow, nullptr);
  85   mPlayPendingSet.Clear();
  86 }
  87
  88 void
  89 PendingPlayerTracker::EnsurePaintIsScheduled()
  90 {
  91   if (!mDocument) {
  92     return;
  93   }
  94
  95   nsIPresShell* presShell = mDocument->GetShell();
  96   if (!presShell) {
  97     return;
  98   }
  99
 100   nsIFrame* rootFrame = presShell->GetRootFrame();
 101   if (!rootFrame) {
 102     return;
 103   }
 104
 105   rootFrame->SchedulePaint();
 106 }
 107
 108 } // namespace mozilla