Move WebCore into Source
[WebKit-https.git] / Source / WebCore / platform / graphics / BitmapImage.cpp
1 /*
2  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
3  * Copyright (C) 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #include "config.h"
28 #include "BitmapImage.h"
29
30 #include "FloatRect.h"
31 #include "ImageObserver.h"
32 #include "IntRect.h"
33 #include "MIMETypeRegistry.h"
34 #include "PlatformString.h"
35 #include "Timer.h"
36 #include <wtf/CurrentTime.h>
37 #include <wtf/Vector.h>
38
39 namespace WebCore {
40
41 static int frameBytes(const IntSize& frameSize)
42 {
43     return frameSize.width() * frameSize.height() * 4;
44 }
45
46 BitmapImage::BitmapImage(ImageObserver* observer)
47     : Image(observer)
48     , m_currentFrame(0)
49     , m_frames(0)
50     , m_frameTimer(0)
51     , m_repetitionCount(cAnimationNone)
52     , m_repetitionCountStatus(Unknown)
53     , m_repetitionsComplete(0)
54     , m_desiredFrameStartTime(0)
55     , m_isSolidColor(false)
56     , m_checkedForSolidColor(false)
57     , m_animationFinished(false)
58     , m_allDataReceived(false)
59     , m_haveSize(false)
60     , m_sizeAvailable(false)
61     , m_hasUniformFrameSize(true)
62     , m_decodedSize(0)
63     , m_haveFrameCount(false)
64     , m_frameCount(0)
65 {
66     initPlatformData();
67 }
68
69 BitmapImage::~BitmapImage()
70 {
71     invalidatePlatformData();
72     stopAnimation();
73 }
74
75 void BitmapImage::destroyDecodedData(bool destroyAll)
76 {
77     int framesCleared = 0;
78     const size_t clearBeforeFrame = destroyAll ? m_frames.size() : m_currentFrame;
79     for (size_t i = 0; i < clearBeforeFrame; ++i) {
80         // The underlying frame isn't actually changing (we're just trying to
81         // save the memory for the framebuffer data), so we don't need to clear
82         // the metadata.
83         if (m_frames[i].clear(false))
84           ++framesCleared;
85     }
86
87     destroyMetadataAndNotify(framesCleared);
88
89     m_source.clear(destroyAll, clearBeforeFrame, data(), m_allDataReceived);
90     return;
91 }
92
93 void BitmapImage::destroyDecodedDataIfNecessary(bool destroyAll)
94 {
95     // Animated images >5MB are considered large enough that we'll only hang on
96     // to one frame at a time.
97     static const unsigned cLargeAnimationCutoff = 5242880;
98     if (m_frames.size() * frameBytes(m_size) > cLargeAnimationCutoff)
99         destroyDecodedData(destroyAll);
100 }
101
102 void BitmapImage::destroyMetadataAndNotify(int framesCleared)
103 {
104     m_isSolidColor = false;
105     invalidatePlatformData();
106
107     const int deltaBytes = framesCleared * -frameBytes(m_size);
108     m_decodedSize += deltaBytes;
109     if (deltaBytes && imageObserver())
110         imageObserver()->decodedSizeChanged(this, deltaBytes);
111 }
112
113 void BitmapImage::cacheFrame(size_t index)
114 {
115     size_t numFrames = frameCount();
116     ASSERT(m_decodedSize == 0 || numFrames > 1);
117     
118     if (m_frames.size() < numFrames)
119         m_frames.grow(numFrames);
120
121     m_frames[index].m_frame = m_source.createFrameAtIndex(index);
122     if (numFrames == 1 && m_frames[index].m_frame)
123         checkForSolidColor();
124
125     m_frames[index].m_haveMetadata = true;
126     m_frames[index].m_isComplete = m_source.frameIsCompleteAtIndex(index);
127     if (repetitionCount(false) != cAnimationNone)
128         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
129     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
130
131     const IntSize frameSize(index ? m_source.frameSizeAtIndex(index) : m_size);
132     if (frameSize != m_size)
133         m_hasUniformFrameSize = false;
134     if (m_frames[index].m_frame) {
135         const int deltaBytes = frameBytes(frameSize);
136         m_decodedSize += deltaBytes;
137         if (imageObserver())
138             imageObserver()->decodedSizeChanged(this, deltaBytes);
139     }
140 }
141
142 IntSize BitmapImage::size() const
143 {
144     if (m_sizeAvailable && !m_haveSize) {
145         m_size = m_source.size();
146         m_haveSize = true;
147     }
148     return m_size;
149 }
150
151 IntSize BitmapImage::currentFrameSize() const
152 {
153     if (!m_currentFrame || m_hasUniformFrameSize)
154         return size();
155     return m_source.frameSizeAtIndex(m_currentFrame);
156 }
157
158 bool BitmapImage::getHotSpot(IntPoint& hotSpot) const
159 {
160     return m_source.getHotSpot(hotSpot);
161 }
162
163 bool BitmapImage::dataChanged(bool allDataReceived)
164 {
165     // Because we're modifying the current frame, clear its (now possibly
166     // inaccurate) metadata as well.
167     destroyMetadataAndNotify((!m_frames.isEmpty() && m_frames[m_frames.size() - 1].clear(true)) ? 1 : 0);
168     
169     // Feed all the data we've seen so far to the image decoder.
170     m_allDataReceived = allDataReceived;
171     m_source.setData(data(), allDataReceived);
172     
173     // Clear the frame count.
174     m_haveFrameCount = false;
175
176     m_hasUniformFrameSize = true;
177
178     // Image properties will not be available until the first frame of the file
179     // reaches kCGImageStatusIncomplete.
180     return isSizeAvailable();
181 }
182
183 String BitmapImage::filenameExtension() const
184 {
185     return m_source.filenameExtension();
186 }
187
188 size_t BitmapImage::frameCount()
189 {
190     if (!m_haveFrameCount) {
191         m_haveFrameCount = true;
192         m_frameCount = m_source.frameCount();
193     }
194     return m_frameCount;
195 }
196
197 bool BitmapImage::isSizeAvailable()
198 {
199     if (m_sizeAvailable)
200         return true;
201
202     m_sizeAvailable = m_source.isSizeAvailable();
203
204     return m_sizeAvailable;
205 }
206
207 NativeImagePtr BitmapImage::frameAtIndex(size_t index)
208 {
209     if (index >= frameCount())
210         return 0;
211
212     if (index >= m_frames.size() || !m_frames[index].m_frame)
213         cacheFrame(index);
214
215     return m_frames[index].m_frame;
216 }
217
218 bool BitmapImage::frameIsCompleteAtIndex(size_t index)
219 {
220     if (index >= frameCount())
221         return true;
222
223     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
224         cacheFrame(index);
225
226     return m_frames[index].m_isComplete;
227 }
228
229 float BitmapImage::frameDurationAtIndex(size_t index)
230 {
231     if (index >= frameCount())
232         return 0;
233
234     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
235         cacheFrame(index);
236
237     return m_frames[index].m_duration;
238 }
239
240 bool BitmapImage::frameHasAlphaAtIndex(size_t index)
241 {
242     if (index >= frameCount())
243         return true;
244
245     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
246         cacheFrame(index);
247
248     return m_frames[index].m_hasAlpha;
249 }
250
251 int BitmapImage::repetitionCount(bool imageKnownToBeComplete)
252 {
253     if ((m_repetitionCountStatus == Unknown) || ((m_repetitionCountStatus == Uncertain) && imageKnownToBeComplete)) {
254         // Snag the repetition count.  If |imageKnownToBeComplete| is false, the
255         // repetition count may not be accurate yet for GIFs; in this case the
256         // decoder will default to cAnimationLoopOnce, and we'll try and read
257         // the count again once the whole image is decoded.
258         m_repetitionCount = m_source.repetitionCount();
259         m_repetitionCountStatus = (imageKnownToBeComplete || m_repetitionCount == cAnimationNone) ? Certain : Uncertain;
260     }
261     return m_repetitionCount;
262 }
263
264 bool BitmapImage::shouldAnimate()
265 {
266     return (repetitionCount(false) != cAnimationNone && !m_animationFinished && imageObserver());
267 }
268
269 void BitmapImage::startAnimation(bool catchUpIfNecessary)
270 {
271     if (m_frameTimer || !shouldAnimate() || frameCount() <= 1)
272         return;
273
274     // If we aren't already animating, set now as the animation start time.
275     const double time = currentTime();
276     if (!m_desiredFrameStartTime)
277         m_desiredFrameStartTime = time;
278
279     // Don't advance the animation to an incomplete frame.
280     size_t nextFrame = (m_currentFrame + 1) % frameCount();
281     if (!m_allDataReceived && !frameIsCompleteAtIndex(nextFrame))
282         return;
283
284     // Don't advance past the last frame if we haven't decoded the whole image
285     // yet and our repetition count is potentially unset.  The repetition count
286     // in a GIF can potentially come after all the rest of the image data, so
287     // wait on it.
288     if (!m_allDataReceived && repetitionCount(false) == cAnimationLoopOnce && m_currentFrame >= (frameCount() - 1))
289         return;
290
291     // Determine time for next frame to start.  By ignoring paint and timer lag
292     // in this calculation, we make the animation appear to run at its desired
293     // rate regardless of how fast it's being repainted.
294     const double currentDuration = frameDurationAtIndex(m_currentFrame);
295     m_desiredFrameStartTime += currentDuration;
296
297     // When an animated image is more than five minutes out of date, the
298     // user probably doesn't care about resyncing and we could burn a lot of
299     // time looping through frames below.  Just reset the timings.
300     const double cAnimationResyncCutoff = 5 * 60;
301     if ((time - m_desiredFrameStartTime) > cAnimationResyncCutoff)
302         m_desiredFrameStartTime = time + currentDuration;
303
304     // The image may load more slowly than it's supposed to animate, so that by
305     // the time we reach the end of the first repetition, we're well behind.
306     // Clamp the desired frame start time in this case, so that we don't skip
307     // frames (or whole iterations) trying to "catch up".  This is a tradeoff:
308     // It guarantees users see the whole animation the second time through and
309     // don't miss any repetitions, and is closer to what other browsers do; on
310     // the other hand, it makes animations "less accurate" for pages that try to
311     // sync an image and some other resource (e.g. audio), especially if users
312     // switch tabs (and thus stop drawing the animation, which will pause it)
313     // during that initial loop, then switch back later.
314     if (nextFrame == 0 && m_repetitionsComplete == 0 && m_desiredFrameStartTime < time)
315         m_desiredFrameStartTime = time;
316
317     if (!catchUpIfNecessary || time < m_desiredFrameStartTime) {
318         // Haven't yet reached time for next frame to start; delay until then.
319         m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
320         m_frameTimer->startOneShot(std::max(m_desiredFrameStartTime - time, 0.));
321     } else {
322         // We've already reached or passed the time for the next frame to start.
323         // See if we've also passed the time for frames after that to start, in
324         // case we need to skip some frames entirely.  Remember not to advance
325         // to an incomplete frame.
326         for (size_t frameAfterNext = (nextFrame + 1) % frameCount(); frameIsCompleteAtIndex(frameAfterNext); frameAfterNext = (nextFrame + 1) % frameCount()) {
327             // Should we skip the next frame?
328             double frameAfterNextStartTime = m_desiredFrameStartTime + frameDurationAtIndex(nextFrame);
329             if (time < frameAfterNextStartTime)
330                 break;
331
332             // Yes; skip over it without notifying our observers.
333             if (!internalAdvanceAnimation(true))
334                 return;
335             m_desiredFrameStartTime = frameAfterNextStartTime;
336             nextFrame = frameAfterNext;
337         }
338
339         // Draw the next frame immediately.  Note that m_desiredFrameStartTime
340         // may be in the past, meaning the next time through this function we'll
341         // kick off the next advancement sooner than this frame's duration would
342         // suggest.
343         if (internalAdvanceAnimation(false)) {
344             // The image region has been marked dirty, but once we return to our
345             // caller, draw() will clear it, and nothing will cause the
346             // animation to advance again.  We need to start the timer for the
347             // next frame running, or the animation can hang.  (Compare this
348             // with when advanceAnimation() is called, and the region is dirtied
349             // while draw() is not in the callstack, meaning draw() gets called
350             // to update the region and thus startAnimation() is reached again.)
351             // NOTE: For large images with slow or heavily-loaded systems,
352             // throwing away data as we go (see destroyDecodedData()) means we
353             // can spend so much time re-decoding data above that by the time we
354             // reach here we're behind again.  If we let startAnimation() run
355             // the catch-up code again, we can get long delays without painting
356             // as we race the timer, or even infinite recursion.  In this
357             // situation the best we can do is to simply change frames as fast
358             // as possible, so force startAnimation() to set a zero-delay timer
359             // and bail out if we're not caught up.
360             startAnimation(false);
361         }
362     }
363 }
364
365 void BitmapImage::stopAnimation()
366 {
367     // This timer is used to animate all occurrences of this image.  Don't invalidate
368     // the timer unless all renderers have stopped drawing.
369     delete m_frameTimer;
370     m_frameTimer = 0;
371 }
372
373 void BitmapImage::resetAnimation()
374 {
375     stopAnimation();
376     m_currentFrame = 0;
377     m_repetitionsComplete = 0;
378     m_desiredFrameStartTime = 0;
379     m_animationFinished = false;
380     
381     // For extremely large animations, when the animation is reset, we just throw everything away.
382     destroyDecodedDataIfNecessary(true);
383 }
384
385 void BitmapImage::advanceAnimation(Timer<BitmapImage>*)
386 {
387     internalAdvanceAnimation(false);
388     // At this point the image region has been marked dirty, and if it's
389     // onscreen, we'll soon make a call to draw(), which will call
390     // startAnimation() again to keep the animation moving.
391 }
392
393 bool BitmapImage::internalAdvanceAnimation(bool skippingFrames)
394 {
395     // Stop the animation.
396     stopAnimation();
397     
398     // See if anyone is still paying attention to this animation.  If not, we don't
399     // advance and will remain suspended at the current frame until the animation is resumed.
400     if (!skippingFrames && imageObserver()->shouldPauseAnimation(this))
401         return false;
402
403     ++m_currentFrame;
404     bool advancedAnimation = true;
405     bool destroyAll = false;
406     if (m_currentFrame >= frameCount()) {
407         ++m_repetitionsComplete;
408
409         // Get the repetition count again.  If we weren't able to get a
410         // repetition count before, we should have decoded the whole image by
411         // now, so it should now be available.
412         // Note that we don't need to special-case cAnimationLoopOnce here
413         // because it is 0 (see comments on its declaration in ImageSource.h).
414         if (repetitionCount(true) != cAnimationLoopInfinite && m_repetitionsComplete > m_repetitionCount) {
415             m_animationFinished = true;
416             m_desiredFrameStartTime = 0;
417             --m_currentFrame;
418             advancedAnimation = false;
419         } else {
420             m_currentFrame = 0;
421             destroyAll = true;
422         }
423     }
424     destroyDecodedDataIfNecessary(destroyAll);
425
426     // We need to draw this frame if we advanced to it while not skipping, or if
427     // while trying to skip frames we hit the last frame and thus had to stop.
428     if (skippingFrames != advancedAnimation)
429         imageObserver()->animationAdvanced(this);
430     return advancedAnimation;
431 }
432
433 }