c893000e57cc4ffce8abff6472168961cd7f8805
[WebKit-https.git] / 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 "PlatformString.h"
34 #include "SystemTime.h"
35 #include "Timer.h"
36 #include <wtf/Vector.h>
37 #include "MIMETypeRegistry.h"
38
39 namespace WebCore {
40
41 // Animated images >5MB are considered large enough that we'll only hang on to
42 // one frame at a time.
43 const unsigned cLargeAnimationCutoff = 5242880;
44
45 // When an animated image is more than five minutes out of date, don't try to
46 // resync on repaint, so we don't waste CPU cycles on an edge case the user
47 // doesn't care about.
48 const double cAnimationResyncCutoff = 5 * 60;
49
50 BitmapImage::BitmapImage(ImageObserver* observer)
51     : Image(observer)
52     , m_currentFrame(0)
53     , m_frames(0)
54     , m_frameTimer(0)
55     , m_repetitionCount(cAnimationNone)
56     , m_repetitionCountStatus(Unknown)
57     , m_repetitionsComplete(0)
58     , m_desiredFrameStartTime(0)
59     , m_isSolidColor(false)
60     , m_animationFinished(false)
61     , m_allDataReceived(false)
62     , m_haveSize(false)
63     , m_sizeAvailable(false)
64     , m_hasUniformFrameSize(true)
65     , m_decodedSize(0)
66     , m_haveFrameCount(false)
67     , m_frameCount(0)
68 {
69     initPlatformData();
70 }
71
72 BitmapImage::~BitmapImage()
73 {
74     invalidatePlatformData();
75     stopAnimation();
76 }
77
78 void BitmapImage::destroyDecodedData(bool incremental, bool preserveNearbyFrames)
79 {
80     // Destroy the cached images and release them.
81     if (m_frames.size()) {
82         int sizeChange = 0;
83         int frameSize = m_size.width() * m_size.height() * 4;
84         const size_t nextFrame = (preserveNearbyFrames && frameCount()) ? ((m_currentFrame + 1) % frameCount()) : 0;
85         for (unsigned i = incremental ? m_frames.size() - 1 : 0; i < m_frames.size(); i++) {
86             if (m_frames[i].m_frame && (!preserveNearbyFrames || (i != m_currentFrame && i != nextFrame))) {
87                 sizeChange -= frameSize;
88                 m_frames[i].clear();
89             }
90         }
91
92         // We just always invalidate our platform data, even in the incremental case.
93         // This could be better, but it's not a big deal.
94         m_isSolidColor = false;
95         invalidatePlatformData();
96         
97         if (sizeChange) {
98             m_decodedSize += sizeChange;
99             if (imageObserver())
100                 imageObserver()->decodedSizeChanged(this, sizeChange);
101         }
102     }
103     if (!incremental) {
104         // Reset the image source, since Image I/O has an underlying cache that it uses
105         // while animating that it seems to never clear.
106         m_source.clear();
107         m_source.setData(m_data.get(), m_allDataReceived);
108     }    
109 }
110
111 void BitmapImage::cacheFrame(size_t index)
112 {
113     size_t numFrames = frameCount();
114     ASSERT(m_decodedSize == 0 || numFrames > 1);
115     
116     if (m_frames.size() < numFrames)
117         m_frames.grow(numFrames);
118
119     m_frames[index].m_frame = m_source.createFrameAtIndex(index);
120     if (numFrames == 1 && m_frames[index].m_frame)
121         checkForSolidColor();
122
123     m_frames[index].m_haveMetadata = true;
124     m_frames[index].m_isComplete = m_source.frameIsCompleteAtIndex(index);
125     if (repetitionCount(false) != cAnimationNone)
126         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
127     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
128
129     int sizeChange;
130     if (index) {
131         IntSize frameSize = m_source.frameSizeAtIndex(index);
132         if (frameSize != m_size)
133             m_hasUniformFrameSize = false;
134         sizeChange = m_frames[index].m_frame ? frameSize.width() * frameSize.height() * 4 : 0;
135     } else
136         sizeChange = m_frames[index].m_frame ? m_size.width() * m_size.height() * 4 : 0;
137
138     if (sizeChange) {
139         m_decodedSize += sizeChange;
140         if (imageObserver())
141             imageObserver()->decodedSizeChanged(this, sizeChange);
142     }
143 }
144
145 IntSize BitmapImage::size() const
146 {
147     if (m_sizeAvailable && !m_haveSize) {
148         m_size = m_source.size();
149         m_haveSize = true;
150     }
151     return m_size;
152 }
153
154 IntSize BitmapImage::currentFrameSize() const
155 {
156     if (!m_currentFrame || m_hasUniformFrameSize)
157         return size();
158     return m_source.frameSizeAtIndex(m_currentFrame);
159 }
160
161 bool BitmapImage::dataChanged(bool allDataReceived)
162 {
163     destroyDecodedData(true);
164     
165     // Feed all the data we've seen so far to the image decoder.
166     m_allDataReceived = allDataReceived;
167     m_source.setData(m_data.get(), allDataReceived);
168     
169     // Clear the frame count.
170     m_haveFrameCount = false;
171
172     m_hasUniformFrameSize = true;
173
174     // Image properties will not be available until the first frame of the file
175     // reaches kCGImageStatusIncomplete.
176     return isSizeAvailable();
177 }
178
179 size_t BitmapImage::frameCount()
180 {
181     if (!m_haveFrameCount) {
182         m_haveFrameCount = true;
183         m_frameCount = m_source.frameCount();
184     }
185     return m_frameCount;
186 }
187
188 bool BitmapImage::isSizeAvailable()
189 {
190     if (m_sizeAvailable)
191         return true;
192
193     m_sizeAvailable = m_source.isSizeAvailable();
194
195     return m_sizeAvailable;
196 }
197
198 NativeImagePtr BitmapImage::frameAtIndex(size_t index)
199 {
200     if (index >= frameCount())
201         return 0;
202
203     if (index >= m_frames.size() || !m_frames[index].m_frame)
204         cacheFrame(index);
205
206     return m_frames[index].m_frame;
207 }
208
209 bool BitmapImage::frameIsCompleteAtIndex(size_t index)
210 {
211     if (index >= frameCount())
212         return true;
213
214     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
215         cacheFrame(index);
216
217     return m_frames[index].m_isComplete;
218 }
219
220 float BitmapImage::frameDurationAtIndex(size_t index)
221 {
222     if (index >= frameCount())
223         return 0;
224
225     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
226         cacheFrame(index);
227
228     return m_frames[index].m_duration;
229 }
230
231 bool BitmapImage::frameHasAlphaAtIndex(size_t index)
232 {
233     if (index >= frameCount())
234         return true;
235
236     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
237         cacheFrame(index);
238
239     return m_frames[index].m_hasAlpha;
240 }
241
242 int BitmapImage::repetitionCount(bool imageKnownToBeComplete)
243 {
244     if ((m_repetitionCountStatus == Unknown) || ((m_repetitionCountStatus == Uncertain) && imageKnownToBeComplete)) {
245         // Snag the repetition count.  If |imageKnownToBeComplete| is false, the
246         // repetition count may not be accurate yet for GIFs; in this case the
247         // decoder will default to cAnimationLoopOnce, and we'll try and read
248         // the count again once the whole image is decoded.
249         m_repetitionCount = m_source.repetitionCount();
250         m_repetitionCountStatus = (imageKnownToBeComplete || m_repetitionCount == cAnimationNone) ? Certain : Uncertain;
251     }
252     return m_repetitionCount;
253 }
254
255 bool BitmapImage::shouldAnimate()
256 {
257     return (repetitionCount(false) != cAnimationNone && !m_animationFinished && imageObserver());
258 }
259
260 void BitmapImage::startAnimation(bool catchUpIfNecessary)
261 {
262     if (m_frameTimer || !shouldAnimate() || frameCount() <= 1)
263         return;
264
265     // Determine time for next frame to start.  By ignoring paint and timer lag
266     // in this calculation, we make the animation appear to run at its desired
267     // rate regardless of how fast it's being repainted.
268     const double currentDuration = frameDurationAtIndex(m_currentFrame);
269     const double time = currentTime();
270     if (m_desiredFrameStartTime == 0) {
271         m_desiredFrameStartTime = time + currentDuration;
272     } else {
273         m_desiredFrameStartTime += currentDuration;
274         // If we're too far behind, the user probably doesn't care about
275         // resyncing and we could burn a lot of time looping through frames
276         // below.  Just reset the timings.
277         if ((time - m_desiredFrameStartTime) > cAnimationResyncCutoff)
278             m_desiredFrameStartTime = time + currentDuration;
279     }
280
281     // Don't advance the animation to an incomplete frame.
282     size_t nextFrame = (m_currentFrame + 1) % frameCount();
283     if (!frameIsCompleteAtIndex(nextFrame))
284         return;
285
286     // Don't advance past the last frame if we haven't decoded the whole image
287     // yet and our repetition count is potentially unset.  The repetition count
288     // in a GIF can potentially come after all the rest of the image data, so
289     // wait on it.
290     if (!m_allDataReceived && repetitionCount(false) == cAnimationLoopOnce && m_currentFrame >= (frameCount() - 1))
291         return;
292
293     // The image may load more slowly than it's supposed to animate, so that by
294     // the time we reach the end of the first repetition, we're well behind.
295     // Clamp the desired frame start time in this case, so that we don't skip
296     // frames (or whole iterations) trying to "catch up".  This is a tradeoff:
297     // It guarantees users see the whole animation the second time through and
298     // don't miss any repetitions, and is closer to what other browsers do; on
299     // the other hand, it makes animations "less accurate" for pages that try to
300     // sync an image and some other resource (e.g. audio), especially if users
301     // switch tabs (and thus stop drawing the animation, which will pause it)
302     // during that initial loop, then switch back later.
303     if (nextFrame == 0 && m_repetitionsComplete == 0 && m_desiredFrameStartTime < time)
304       m_desiredFrameStartTime = time;
305
306     if (!catchUpIfNecessary || time < m_desiredFrameStartTime) {
307         // Haven't yet reached time for next frame to start; delay until then.
308         m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
309         m_frameTimer->startOneShot(std::max(m_desiredFrameStartTime - time, 0.));
310     } else {
311         // We've already reached or passed the time for the next frame to start.
312         // See if we've also passed the time for frames after that to start, in
313         // case we need to skip some frames entirely.  Remember not to advance
314         // to an incomplete frame.
315         for (size_t frameAfterNext = (nextFrame + 1) % frameCount(); frameIsCompleteAtIndex(frameAfterNext); frameAfterNext = (nextFrame + 1) % frameCount()) {
316             // Should we skip the next frame?
317             double frameAfterNextStartTime = m_desiredFrameStartTime + frameDurationAtIndex(nextFrame);
318             if (time < frameAfterNextStartTime)
319                 break;
320
321             // Yes; skip over it without notifying our observers.
322             if (!internalAdvanceAnimation(true))
323                 return;
324             m_desiredFrameStartTime = frameAfterNextStartTime;
325             nextFrame = frameAfterNext;
326         }
327
328         // Draw the next frame immediately.  Note that m_desiredFrameStartTime
329         // may be in the past, meaning the next time through this function we'll
330         // kick off the next advancement sooner than this frame's duration would
331         // suggest.
332         if (internalAdvanceAnimation(false)) {
333             // The image region has been marked dirty, but once we return to our
334             // caller, draw() will clear it, and nothing will cause the
335             // animation to advance again.  We need to start the timer for the
336             // next frame running, or the animation can hang.  (Compare this
337             // with when advanceAnimation() is called, and the region is dirtied
338             // while draw() is not in the callstack, meaning draw() gets called
339             // to update the region and thus startAnimation() is reached again.)
340             // NOTE: For large images with slow or heavily-loaded systems,
341             // throwing away data as we go (see destroyDecodedData()) means we
342             // can spend so much time re-decoding data above that by the time we
343             // reach here we're behind again.  If we let startAnimation() run
344             // the catch-up code again, we can get long delays without painting
345             // as we race the timer, or even infinite recursion.  In this
346             // situation the best we can do is to simply change frames as fast
347             // as possible, so force startAnimation() to set a zero-delay timer
348             // and bail out if we're not caught up.
349             startAnimation(false);
350         }
351     }
352 }
353
354 void BitmapImage::stopAnimation()
355 {
356     // This timer is used to animate all occurrences of this image.  Don't invalidate
357     // the timer unless all renderers have stopped drawing.
358     delete m_frameTimer;
359     m_frameTimer = 0;
360 }
361
362 void BitmapImage::resetAnimation()
363 {
364     stopAnimation();
365     m_currentFrame = 0;
366     m_repetitionsComplete = 0;
367     m_desiredFrameStartTime = 0;
368     m_animationFinished = false;
369     int frameSize = m_size.width() * m_size.height() * 4;
370     
371     // For extremely large animations, when the animation is reset, we just throw everything away.
372     if (frameCount() * frameSize > cLargeAnimationCutoff)
373         destroyDecodedData();
374 }
375
376 void BitmapImage::advanceAnimation(Timer<BitmapImage>* timer)
377 {
378     internalAdvanceAnimation(false);
379     // At this point the image region has been marked dirty, and if it's
380     // onscreen, we'll soon make a call to draw(), which will call
381     // startAnimation() again to keep the animation moving.
382 }
383
384 bool BitmapImage::internalAdvanceAnimation(bool skippingFrames)
385 {
386     // Stop the animation.
387     stopAnimation();
388     
389     // See if anyone is still paying attention to this animation.  If not, we don't
390     // advance and will remain suspended at the current frame until the animation is resumed.
391     if (!skippingFrames && imageObserver()->shouldPauseAnimation(this))
392         return false;
393
394     m_currentFrame++;
395     if (m_currentFrame >= frameCount()) {
396         ++m_repetitionsComplete;
397         // Get the repetition count again.  If we weren't able to get a
398         // repetition count before, we should have decoded the whole image by
399         // now, so it should now be available.
400         if (repetitionCount(true) && m_repetitionsComplete >= m_repetitionCount) {
401             m_animationFinished = true;
402             m_desiredFrameStartTime = 0;
403             m_currentFrame--;
404             if (skippingFrames) {
405                 // Uh oh.  We tried to skip past the end of the animation.  We'd
406                 // better draw this last frame.
407                 notifyObserverAndTrimDecodedData();
408             }
409             return false;
410         }
411         m_currentFrame = 0;
412     }
413
414     if (!skippingFrames)
415         notifyObserverAndTrimDecodedData();
416
417     return true;
418 }
419
420 void BitmapImage::notifyObserverAndTrimDecodedData()
421 {
422     // Notify our observer that the animation has advanced.
423     imageObserver()->animationAdvanced(this);
424
425     // For large animated images, go ahead and throw away frames as we go to
426     // save footprint.
427     int frameSize = m_size.width() * m_size.height() * 4;
428     if (frameCount() * frameSize > cLargeAnimationCutoff) {
429         // Destroy all of our frames and just redecode every time.  We save the
430         // current frame since we'll need it in draw() anyway.
431         destroyDecodedData(false, true);
432     }
433 }
434
435 }