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