Use bitfield for bool data members in BitmapImage.
[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_decodedSize(0)
56     , m_decodedPropertiesSize(0)
57     , m_frameCount(0)
58     , m_isSolidColor(false)
59     , m_checkedForSolidColor(false)
60     , m_animationFinished(false)
61     , m_allDataReceived(false)
62     , m_haveSize(false)
63     , m_sizeAvailable(false)
64     , m_hasUniformFrameSize(true)
65     , m_haveFrameCount(false)
66 {
67     initPlatformData();
68 }
69
70 BitmapImage::~BitmapImage()
71 {
72     invalidatePlatformData();
73     stopAnimation();
74 }
75
76 void BitmapImage::destroyDecodedData(bool destroyAll)
77 {
78     int framesCleared = 0;
79     const size_t clearBeforeFrame = destroyAll ? m_frames.size() : m_currentFrame;
80     for (size_t i = 0; i < clearBeforeFrame; ++i) {
81         // The underlying frame isn't actually changing (we're just trying to
82         // save the memory for the framebuffer data), so we don't need to clear
83         // the metadata.
84         if (m_frames[i].clear(false))
85           ++framesCleared;
86     }
87
88     destroyMetadataAndNotify(framesCleared);
89
90     m_source.clear(destroyAll, clearBeforeFrame, data(), m_allDataReceived);
91     return;
92 }
93
94 void BitmapImage::destroyDecodedDataIfNecessary(bool destroyAll)
95 {
96     // Animated images >5MB are considered large enough that we'll only hang on
97     // to one frame at a time.
98     static const unsigned cLargeAnimationCutoff = 5242880;
99     if (m_frames.size() * frameBytes(m_size) > cLargeAnimationCutoff)
100         destroyDecodedData(destroyAll);
101 }
102
103 void BitmapImage::destroyMetadataAndNotify(int framesCleared)
104 {
105     m_isSolidColor = false;
106     m_checkedForSolidColor = false;
107     invalidatePlatformData();
108
109     int deltaBytes = framesCleared * -frameBytes(m_size);
110     m_decodedSize += deltaBytes;
111     if (framesCleared > 0) {
112         deltaBytes -= m_decodedPropertiesSize;
113         m_decodedPropertiesSize = 0;
114     }
115     if (deltaBytes && imageObserver())
116         imageObserver()->decodedSizeChanged(this, deltaBytes);
117 }
118
119 void BitmapImage::cacheFrame(size_t index)
120 {
121     size_t numFrames = frameCount();
122     ASSERT(m_decodedSize == 0 || numFrames > 1);
123     
124     if (m_frames.size() < numFrames)
125         m_frames.grow(numFrames);
126
127     m_frames[index].m_frame = m_source.createFrameAtIndex(index);
128     if (numFrames == 1 && m_frames[index].m_frame)
129         checkForSolidColor();
130
131     m_frames[index].m_haveMetadata = true;
132     m_frames[index].m_isComplete = m_source.frameIsCompleteAtIndex(index);
133     if (repetitionCount(false) != cAnimationNone)
134         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
135     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
136
137     const IntSize frameSize(index ? m_source.frameSizeAtIndex(index) : m_size);
138     if (frameSize != m_size)
139         m_hasUniformFrameSize = false;
140     if (m_frames[index].m_frame) {
141         int deltaBytes = frameBytes(frameSize);
142         m_decodedSize += deltaBytes;
143         // The fully-decoded frame will subsume the partially decoded data used
144         // to determine image properties.
145         deltaBytes -= m_decodedPropertiesSize;
146         m_decodedPropertiesSize = 0;
147         if (imageObserver())
148             imageObserver()->decodedSizeChanged(this, deltaBytes);
149     }
150 }
151
152 void BitmapImage::didDecodeProperties() const
153 {
154     if (m_decodedSize)
155         return;
156     size_t updatedSize = m_source.bytesDecodedToDetermineProperties();
157     if (m_decodedPropertiesSize == updatedSize)
158         return;
159     int deltaBytes = updatedSize - m_decodedPropertiesSize;
160 #if !ASSERT_DISABLED
161     bool overflow = updatedSize > m_decodedPropertiesSize && deltaBytes < 0;
162     bool underflow = updatedSize < m_decodedPropertiesSize && deltaBytes > 0;
163     ASSERT(!overflow && !underflow);
164 #endif
165     m_decodedPropertiesSize = updatedSize;
166     if (imageObserver())
167         imageObserver()->decodedSizeChanged(this, deltaBytes);
168 }
169
170 IntSize BitmapImage::size() const
171 {
172     if (m_sizeAvailable && !m_haveSize) {
173         m_size = m_source.size();
174         m_haveSize = true;
175         didDecodeProperties();
176     }
177     return m_size;
178 }
179
180 IntSize BitmapImage::currentFrameSize() const
181 {
182     if (!m_currentFrame || m_hasUniformFrameSize)
183         return size();
184     IntSize frameSize = m_source.frameSizeAtIndex(m_currentFrame);
185     didDecodeProperties();
186     return frameSize;
187 }
188
189 bool BitmapImage::getHotSpot(IntPoint& hotSpot) const
190 {
191     bool result = m_source.getHotSpot(hotSpot);
192     didDecodeProperties();
193     return result;
194 }
195
196 bool BitmapImage::dataChanged(bool allDataReceived)
197 {
198     // Clear all partially-decoded frames. For most image formats, there is only
199     // one frame, but at least GIF and ICO can have more. With GIFs, the frames
200     // come in order and we ask to decode them in order, waiting to request a
201     // subsequent frame until the prior one is complete. Given that we clear
202     // incomplete frames here, this means there is at most one incomplete frame
203     // (even if we use destroyDecodedData() -- since it doesn't reset the
204     // metadata), and it is after all the complete frames.
205     //
206     // With ICOs, on the other hand, we may ask for arbitrary frames at
207     // different times (e.g. because we're displaying a higher-resolution image
208     // in the content area and using a lower-resolution one for the favicon),
209     // and the frames aren't even guaranteed to appear in the file in the same
210     // order as in the directory, so an arbitrary number of the frames might be
211     // incomplete (if we ask for frames for which we've not yet reached the
212     // start of the frame data), and any or none of them might be the particular
213     // frame affected by appending new data here. Thus we have to clear all the
214     // incomplete frames to be safe.
215     int framesCleared = 0;
216     for (size_t i = 0; i < m_frames.size(); ++i) {
217         // NOTE: Don't call frameIsCompleteAtIndex() here, that will try to
218         // decode any uncached (i.e. never-decoded or
219         // cleared-on-a-previous-pass) frames!
220         if (m_frames[i].m_haveMetadata && !m_frames[i].m_isComplete)
221             framesCleared += (m_frames[i].clear(true) ? 1 : 0);
222     }
223     destroyMetadataAndNotify(framesCleared);
224     
225     // Feed all the data we've seen so far to the image decoder.
226     m_allDataReceived = allDataReceived;
227     m_source.setData(data(), allDataReceived);
228     
229     m_haveFrameCount = false;
230     m_hasUniformFrameSize = true;
231     return isSizeAvailable();
232 }
233
234 String BitmapImage::filenameExtension() const
235 {
236     return m_source.filenameExtension();
237 }
238
239 size_t BitmapImage::frameCount()
240 {
241     if (!m_haveFrameCount) {
242         m_haveFrameCount = true;
243         m_frameCount = m_source.frameCount();
244         didDecodeProperties();
245     }
246     return m_frameCount;
247 }
248
249 bool BitmapImage::isSizeAvailable()
250 {
251     if (m_sizeAvailable)
252         return true;
253
254     m_sizeAvailable = m_source.isSizeAvailable();
255     didDecodeProperties();
256
257     return m_sizeAvailable;
258 }
259
260 NativeImagePtr BitmapImage::frameAtIndex(size_t index)
261 {
262     if (index >= frameCount())
263         return 0;
264
265     if (index >= m_frames.size() || !m_frames[index].m_frame)
266         cacheFrame(index);
267
268     return m_frames[index].m_frame;
269 }
270
271 bool BitmapImage::frameIsCompleteAtIndex(size_t index)
272 {
273     if (index >= frameCount())
274         return true;
275
276     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
277         cacheFrame(index);
278
279     return m_frames[index].m_isComplete;
280 }
281
282 float BitmapImage::frameDurationAtIndex(size_t index)
283 {
284     if (index >= frameCount())
285         return 0;
286
287     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
288         cacheFrame(index);
289
290     return m_frames[index].m_duration;
291 }
292
293 bool BitmapImage::frameHasAlphaAtIndex(size_t index)
294 {
295     if (index >= frameCount())
296         return true;
297
298     if (index >= m_frames.size() || !m_frames[index].m_haveMetadata)
299         cacheFrame(index);
300
301     return m_frames[index].m_hasAlpha;
302 }
303
304 int BitmapImage::repetitionCount(bool imageKnownToBeComplete)
305 {
306     if ((m_repetitionCountStatus == Unknown) || ((m_repetitionCountStatus == Uncertain) && imageKnownToBeComplete)) {
307         // Snag the repetition count.  If |imageKnownToBeComplete| is false, the
308         // repetition count may not be accurate yet for GIFs; in this case the
309         // decoder will default to cAnimationLoopOnce, and we'll try and read
310         // the count again once the whole image is decoded.
311         m_repetitionCount = m_source.repetitionCount();
312         didDecodeProperties();
313         m_repetitionCountStatus = (imageKnownToBeComplete || m_repetitionCount == cAnimationNone) ? Certain : Uncertain;
314     }
315     return m_repetitionCount;
316 }
317
318 bool BitmapImage::shouldAnimate()
319 {
320     return (repetitionCount(false) != cAnimationNone && !m_animationFinished && imageObserver());
321 }
322
323 void BitmapImage::startAnimation(bool catchUpIfNecessary)
324 {
325     if (m_frameTimer || !shouldAnimate() || frameCount() <= 1)
326         return;
327
328     // If we aren't already animating, set now as the animation start time.
329     const double time = monotonicallyIncreasingTime();
330     if (!m_desiredFrameStartTime)
331         m_desiredFrameStartTime = time;
332
333     // Don't advance the animation to an incomplete frame.
334     size_t nextFrame = (m_currentFrame + 1) % frameCount();
335     if (!m_allDataReceived && !frameIsCompleteAtIndex(nextFrame))
336         return;
337
338     // Don't advance past the last frame if we haven't decoded the whole image
339     // yet and our repetition count is potentially unset.  The repetition count
340     // in a GIF can potentially come after all the rest of the image data, so
341     // wait on it.
342     if (!m_allDataReceived && repetitionCount(false) == cAnimationLoopOnce && m_currentFrame >= (frameCount() - 1))
343         return;
344
345     // Determine time for next frame to start.  By ignoring paint and timer lag
346     // in this calculation, we make the animation appear to run at its desired
347     // rate regardless of how fast it's being repainted.
348     const double currentDuration = frameDurationAtIndex(m_currentFrame);
349     m_desiredFrameStartTime += currentDuration;
350
351     // When an animated image is more than five minutes out of date, the
352     // user probably doesn't care about resyncing and we could burn a lot of
353     // time looping through frames below.  Just reset the timings.
354     const double cAnimationResyncCutoff = 5 * 60;
355     if ((time - m_desiredFrameStartTime) > cAnimationResyncCutoff)
356         m_desiredFrameStartTime = time + currentDuration;
357
358     // The image may load more slowly than it's supposed to animate, so that by
359     // the time we reach the end of the first repetition, we're well behind.
360     // Clamp the desired frame start time in this case, so that we don't skip
361     // frames (or whole iterations) trying to "catch up".  This is a tradeoff:
362     // It guarantees users see the whole animation the second time through and
363     // don't miss any repetitions, and is closer to what other browsers do; on
364     // the other hand, it makes animations "less accurate" for pages that try to
365     // sync an image and some other resource (e.g. audio), especially if users
366     // switch tabs (and thus stop drawing the animation, which will pause it)
367     // during that initial loop, then switch back later.
368     if (nextFrame == 0 && m_repetitionsComplete == 0 && m_desiredFrameStartTime < time)
369         m_desiredFrameStartTime = time;
370
371     if (!catchUpIfNecessary || time < m_desiredFrameStartTime) {
372         // Haven't yet reached time for next frame to start; delay until then.
373         m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
374         m_frameTimer->startOneShot(std::max(m_desiredFrameStartTime - time, 0.));
375     } else {
376         // We've already reached or passed the time for the next frame to start.
377         // See if we've also passed the time for frames after that to start, in
378         // case we need to skip some frames entirely.  Remember not to advance
379         // to an incomplete frame.
380         for (size_t frameAfterNext = (nextFrame + 1) % frameCount(); frameIsCompleteAtIndex(frameAfterNext); frameAfterNext = (nextFrame + 1) % frameCount()) {
381             // Should we skip the next frame?
382             double frameAfterNextStartTime = m_desiredFrameStartTime + frameDurationAtIndex(nextFrame);
383             if (time < frameAfterNextStartTime)
384                 break;
385
386             // Yes; skip over it without notifying our observers.
387             if (!internalAdvanceAnimation(true))
388                 return;
389             m_desiredFrameStartTime = frameAfterNextStartTime;
390             nextFrame = frameAfterNext;
391         }
392
393         // Draw the next frame immediately.  Note that m_desiredFrameStartTime
394         // may be in the past, meaning the next time through this function we'll
395         // kick off the next advancement sooner than this frame's duration would
396         // suggest.
397         if (internalAdvanceAnimation(false)) {
398             // The image region has been marked dirty, but once we return to our
399             // caller, draw() will clear it, and nothing will cause the
400             // animation to advance again.  We need to start the timer for the
401             // next frame running, or the animation can hang.  (Compare this
402             // with when advanceAnimation() is called, and the region is dirtied
403             // while draw() is not in the callstack, meaning draw() gets called
404             // to update the region and thus startAnimation() is reached again.)
405             // NOTE: For large images with slow or heavily-loaded systems,
406             // throwing away data as we go (see destroyDecodedData()) means we
407             // can spend so much time re-decoding data above that by the time we
408             // reach here we're behind again.  If we let startAnimation() run
409             // the catch-up code again, we can get long delays without painting
410             // as we race the timer, or even infinite recursion.  In this
411             // situation the best we can do is to simply change frames as fast
412             // as possible, so force startAnimation() to set a zero-delay timer
413             // and bail out if we're not caught up.
414             startAnimation(false);
415         }
416     }
417 }
418
419 void BitmapImage::stopAnimation()
420 {
421     // This timer is used to animate all occurrences of this image.  Don't invalidate
422     // the timer unless all renderers have stopped drawing.
423     delete m_frameTimer;
424     m_frameTimer = 0;
425 }
426
427 void BitmapImage::resetAnimation()
428 {
429     stopAnimation();
430     m_currentFrame = 0;
431     m_repetitionsComplete = 0;
432     m_desiredFrameStartTime = 0;
433     m_animationFinished = false;
434     
435     // For extremely large animations, when the animation is reset, we just throw everything away.
436     destroyDecodedDataIfNecessary(true);
437 }
438
439 void BitmapImage::advanceAnimation(Timer<BitmapImage>*)
440 {
441     internalAdvanceAnimation(false);
442     // At this point the image region has been marked dirty, and if it's
443     // onscreen, we'll soon make a call to draw(), which will call
444     // startAnimation() again to keep the animation moving.
445 }
446
447 bool BitmapImage::internalAdvanceAnimation(bool skippingFrames)
448 {
449     // Stop the animation.
450     stopAnimation();
451     
452     // See if anyone is still paying attention to this animation.  If not, we don't
453     // advance and will remain suspended at the current frame until the animation is resumed.
454     if (!skippingFrames && imageObserver()->shouldPauseAnimation(this))
455         return false;
456
457     ++m_currentFrame;
458     bool advancedAnimation = true;
459     bool destroyAll = false;
460     if (m_currentFrame >= frameCount()) {
461         ++m_repetitionsComplete;
462
463         // Get the repetition count again.  If we weren't able to get a
464         // repetition count before, we should have decoded the whole image by
465         // now, so it should now be available.
466         // Note that we don't need to special-case cAnimationLoopOnce here
467         // because it is 0 (see comments on its declaration in ImageSource.h).
468         if (repetitionCount(true) != cAnimationLoopInfinite && m_repetitionsComplete > m_repetitionCount) {
469             m_animationFinished = true;
470             m_desiredFrameStartTime = 0;
471             --m_currentFrame;
472             advancedAnimation = false;
473         } else {
474             m_currentFrame = 0;
475             destroyAll = true;
476         }
477     }
478     destroyDecodedDataIfNecessary(destroyAll);
479
480     // We need to draw this frame if we advanced to it while not skipping, or if
481     // while trying to skip frames we hit the last frame and thus had to stop.
482     if (skippingFrames != advancedAnimation)
483         imageObserver()->animationAdvanced(this);
484     return advancedAnimation;
485 }
486
487 }