1 /* 2 * Copyright (C) 2013 Google Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef Player_h 32 #define Player_h 33 34 #include "core/animation/TimedItem.h" 35 #include "wtf/RefPtr.h" 36 37 namespace WebCore { 38 39 class DocumentTimeline; 40 41 class Player FINAL : public RefCounted<Player> { 42 43 public: 44 ~Player(); 45 static PassRefPtr<Player> create(DocumentTimeline&, TimedItem*); 46 47 // Returns whether this player is still current or in effect. 48 // timeToEffectChange returns: 49 // infinity - if this player is no longer in effect 50 // 0 - if this player requires an update on the next frame 51 // n - if this player requires an update after 'n' units of time 52 bool update(double* timeToEffectChange = 0, bool* didTriggerStyleRecalc = 0); 53 void cancel(); 54 55 double currentTime() const; 56 void setCurrentTime(double); 57 paused()58 bool paused() const { return !m_isPausedForTesting && pausedInternal(); } 59 void setPaused(bool); 60 playbackRate()61 double playbackRate() const { return m_playbackRate; } 62 void setPlaybackRate(double); 63 double timeDrift() const; timeline()64 DocumentTimeline& timeline() { return m_timeline; } 65 hasStartTime()66 bool hasStartTime() const { return !isNull(m_startTime); } startTime()67 double startTime() const { return m_startTime; } 68 void setStartTime(double); 69 source()70 TimedItem* source() { return m_content.get(); } 71 72 // Pausing via this method is not reflected in the value returned by 73 // paused() and must never overlap with pausing via setPaused(). 74 void pauseForTesting(); 75 76 bool maybeStartAnimationOnCompositor(); 77 void cancelAnimationOnCompositor(); 78 bool hasActiveAnimationsOnCompositor(); 79 80 private: 81 Player(DocumentTimeline&, TimedItem*); 82 inline double pausedTimeDrift() const; 83 inline double currentTimeBeforeDrift() const; 84 85 86 void setPausedImpl(bool); 87 // Reflects all pausing, including via pauseForTesting(). pausedInternal()88 bool pausedInternal() const { return !isNull(m_pauseStartTime); } 89 90 double m_pauseStartTime; 91 double m_playbackRate; 92 double m_timeDrift; 93 double m_startTime; 94 95 RefPtr<TimedItem> m_content; 96 DocumentTimeline& m_timeline; 97 bool m_isPausedForTesting; 98 }; 99 100 } // namespace 101 102 #endif 103