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