1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*
* Copyright (C) 2024 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "ImageFrameAnimator.h"
#include "BitmapImageSource.h"
#include "Logging.h"
#include <wtf/TZoneMallocInlines.h>
namespace WebCore {
WTF_MAKE_TZONE_ALLOCATED_IMPL(ImageFrameAnimator);
ImageFrameAnimator::ImageFrameAnimator(BitmapImageSource& source)
: m_source(source)
, m_frameCount(source.frameCount())
, m_repetitionCount(source.repetitionCount())
, m_currentFrameIndex(source.primaryFrameIndex())
{
ASSERT(m_frameCount > 0);
ASSERT(m_repetitionCount != RepetitionCountNone);
ASSERT(m_currentFrameIndex < m_frameCount);
}
void ImageFrameAnimator::ref() const
{
m_source.get()->ref();
}
void ImageFrameAnimator::deref() const
{
m_source.get()->deref();
}
ImageFrameAnimator::~ImageFrameAnimator()
{
clearTimer();
}
void ImageFrameAnimator::destroyDecodedData(bool destroyAll)
{
// Animated images over a certain size are considered large enough that we'll
// only hang on to one frame at a time.
static constexpr unsigned LargeAnimationCutoff = 30 * 1024 * 1024;
RefPtr source = m_source.get();
if (source->decodedSize() < LargeAnimationCutoff)
return;
source->destroyDecodedData(destroyAll);
}
void ImageFrameAnimator::startTimer(Seconds delay)
{
ASSERT(!m_frameTimer);
m_frameTimer = makeUnique<Timer>(*this, &ImageFrameAnimator::timerFired);
m_frameTimer->startOneShot(delay);
}
void ImageFrameAnimator::clearTimer()
{
m_frameTimer = nullptr;
}
void ImageFrameAnimator::timerFired()
{
clearTimer();
RefPtr source = m_source.get();
// Don't advance to nextFrame if the next frame is being decoded.
if (source->isPendingDecodingAtIndex(nextFrameIndex(), m_nextFrameSubsamplingLevel, m_nextFrameOptions))
return;
advanceAnimation();
source->imageFrameAtIndexAvailable(m_currentFrameIndex, ImageAnimatingState::Yes, source->frameDecodingStatusAtIndex(m_currentFrameIndex));
}
bool ImageFrameAnimator::imageFrameDecodeAtIndexHasFinished(unsigned index, ImageAnimatingState animatingState, DecodingStatus decodingStatus)
{
if (animatingState != ImageAnimatingState::Yes)
return false;
if (index != nextFrameIndex())
return false;
if (!hasEverAnimated())
return false;
// Don't advance to nextFrame if the timer has not fired yet.
if (isAnimating())
return true;
advanceAnimation();
m_source.get()->imageFrameAtIndexAvailable(m_currentFrameIndex, animatingState, decodingStatus);
return true;
}
bool ImageFrameAnimator::startAnimation(SubsamplingLevel subsamplingLevel, const DecodingOptions& options)
{
if (m_frameTimer)
return true;
RefPtr source = m_source.get();
// ImageObserver may disallow animation.
if (!source->isAnimationAllowed())
return false;
m_nextFrameSubsamplingLevel = subsamplingLevel;
m_nextFrameOptions = options;
LOG(Images, "ImageFrameAnimator::%s - %p - url: %s. Animation at index = %d will be started.", __FUNCTION__, this, sourceUTF8().data(), m_currentFrameIndex);
if (options.decodingMode() == DecodingMode::Asynchronous) {
LOG(Images, "ImageFrameAnimator::%s - %p - url: %s. Decoding for frame at index = %d will be requested.", __FUNCTION__, this, sourceUTF8().data(), nextFrameIndex());
source->requestNativeImageAtIndexIfNeeded(nextFrameIndex(), subsamplingLevel, ImageAnimatingState::Yes, options);
}
auto time = MonotonicTime::now();
// Handle initial state.
if (!m_desiredFrameStartTime)
m_desiredFrameStartTime = time;
auto duration = source->frameDurationAtIndex(m_currentFrameIndex);
// Setting 'm_desiredFrameStartTime' to 'time' means we are late; otherwise we are early.
m_desiredFrameStartTime = std::max(time, m_desiredFrameStartTime + duration);
startTimer(m_desiredFrameStartTime - time);
return true;
}
void ImageFrameAnimator::advanceAnimation()
{
LOG(Images, "ImageFrameAnimator::%s - %p - url: %s. Animation at index = %d will be advanced.", __FUNCTION__, this, sourceUTF8().data(), m_currentFrameIndex);
m_currentFrameIndex = nextFrameIndex();
if (m_currentFrameIndex == m_frameCount - 1) {
LOG(Images, "ImageFrameAnimator::%s - %p - url: %s. Animation loop %d has ended.", __FUNCTION__, this, sourceUTF8().data(), m_repetitionsComplete);
++m_repetitionsComplete;
}
destroyDecodedData(false);
}
void ImageFrameAnimator::stopAnimation()
{
clearTimer();
}
void ImageFrameAnimator::resetAnimation()
{
stopAnimation();
m_currentFrameIndex = m_source.get()->primaryFrameIndex();
m_repetitionsComplete = RepetitionCountNone;
m_desiredFrameStartTime = { };
// For extremely large animations, when the animation is reset, we just throw everything away.
destroyDecodedData(true);
}
bool ImageFrameAnimator::isAnimationAllowed() const
{
return m_repetitionCount == RepetitionCountInfinite || m_repetitionsComplete < m_repetitionCount;
}
CString ImageFrameAnimator::sourceUTF8() const
{
return m_source.get()->sourceUTF8();
}
void ImageFrameAnimator::dump(TextStream& ts) const
{
ts.dumpProperty("current-frame-index", m_currentFrameIndex);
ts.dumpProperty("repetitions-complete", m_repetitionsComplete);
}
} // namespace WebCore
|
