Clean up image subsampling code, make it less iOS-specific
[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 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 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 "GraphicsContext.h"
32 #include "ImageBuffer.h"
33 #include "ImageObserver.h"
34 #include "IntRect.h"
35 #include "MIMETypeRegistry.h"
36 #include "Timer.h"
37 #include <wtf/CurrentTime.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/WTFString.h>
40
41 #if PLATFORM(IOS)
42 #include <limits>
43 #endif
44
45 namespace WebCore {
46
47 BitmapImage::BitmapImage(ImageObserver* observer)
48     : Image(observer)
49     , m_minimumSubsamplingLevel(0)
50     , m_imageOrientation(OriginTopLeft)
51     , m_shouldRespectImageOrientation(false)
52     , m_currentFrame(0)
53     , m_repetitionCount(cAnimationNone)
54     , m_repetitionCountStatus(Unknown)
55     , m_repetitionsComplete(0)
56     , m_desiredFrameStartTime(0)
57     , m_decodedSize(0)
58     , m_decodedPropertiesSize(0)
59     , m_frameCount(0)
60 #if PLATFORM(IOS)
61     // FIXME: We should expose a setting to enable/disable progressive loading remove the PLATFORM(IOS)-guard.
62     , m_progressiveLoadChunkTime(0)
63     , m_progressiveLoadChunkCount(0)
64     , m_allowSubsampling(true)
65 #else
66     , m_allowSubsampling(false)
67 #endif
68     , m_isSolidColor(false)
69     , m_checkedForSolidColor(false)
70     , m_animationFinished(false)
71     , m_allDataReceived(false)
72     , m_haveSize(false)
73     , m_sizeAvailable(false)
74     , m_hasUniformFrameSize(true)
75     , m_haveFrameCount(false)
76     , m_cachedImage(0)
77 {
78 }
79
80 BitmapImage::~BitmapImage()
81 {
82     invalidatePlatformData();
83     stopAnimation();
84 }
85
86 bool BitmapImage::haveFrameAtIndex(size_t index)
87 {
88     if (index >= frameCount())
89         return false;
90
91     if (index >= m_frames.size())
92         return false;
93
94     return m_frames[index].m_frame;
95 }
96
97 bool BitmapImage::hasSingleSecurityOrigin() const
98 {
99     return true;
100 }
101
102 void BitmapImage::destroyDecodedData(bool destroyAll)
103 {
104     unsigned frameBytesCleared = 0;
105     const size_t clearBeforeFrame = destroyAll ? m_frames.size() : m_currentFrame;
106
107     // Because we can advance frames without always needing to decode the actual
108     // bitmap data, |m_currentFrame| may be larger than m_frames.size();
109     // make sure not to walk off the end of the container in this case.
110     for (size_t i = 0; i <  std::min(clearBeforeFrame, m_frames.size()); ++i) {
111         // The underlying frame isn't actually changing (we're just trying to
112         // save the memory for the framebuffer data), so we don't need to clear
113         // the metadata.
114         unsigned frameBytes = m_frames[i].m_frameBytes;
115         if (m_frames[i].clear(false))
116             frameBytesCleared += frameBytes;
117     }
118
119     destroyMetadataAndNotify(frameBytesCleared);
120
121     m_source.clear(destroyAll, clearBeforeFrame, data(), m_allDataReceived);
122     return;
123 }
124
125 void BitmapImage::destroyDecodedDataIfNecessary(bool destroyAll)
126 {
127     // Animated images >5MB are considered large enough that we'll only hang on
128     // to one frame at a time.
129 #if PLATFORM(IOS)
130     static const unsigned cLargeAnimationCutoff = 2097152;
131
132      // If we have decoded frames but there is no encoded data, we shouldn't destroy
133      // the decoded image since we won't be able to reconstruct it later.
134      if (!data() && m_frames.size())
135          return;
136 #else
137     static const unsigned cLargeAnimationCutoff = 5242880;
138 #endif
139
140     // If we have decoded frames but there is no encoded data, we shouldn't destroy
141     // the decoded image since we won't be able to reconstruct it later.
142     if (!data() && m_frames.size())
143         return;
144
145     unsigned allFrameBytes = 0;
146     for (size_t i = 0; i < m_frames.size(); ++i)
147         allFrameBytes += m_frames[i].m_frameBytes;
148
149     if (allFrameBytes > cLargeAnimationCutoff)
150         destroyDecodedData(destroyAll);
151 }
152
153 void BitmapImage::destroyMetadataAndNotify(unsigned frameBytesCleared)
154 {
155     m_isSolidColor = false;
156     m_checkedForSolidColor = false;
157     invalidatePlatformData();
158
159     ASSERT(m_decodedSize >= frameBytesCleared);
160     m_decodedSize -= frameBytesCleared;
161     if (frameBytesCleared > 0) {
162         frameBytesCleared += m_decodedPropertiesSize;
163         m_decodedPropertiesSize = 0;
164     }
165     if (frameBytesCleared && imageObserver())
166         imageObserver()->decodedSizeChanged(this, -safeCast<int>(frameBytesCleared));
167 }
168
169 void BitmapImage::cacheFrame(size_t index, SubsamplingLevel subsamplingLevel, ImageFrameCaching frameCaching)
170 {
171     size_t numFrames = frameCount();
172     ASSERT(m_decodedSize == 0 || numFrames > 1);
173     
174     if (m_frames.size() < numFrames)
175         m_frames.grow(numFrames);
176
177     if (frameCaching == CacheMetadataAndFrame) {
178         m_frames[index].m_frame = m_source.createFrameAtIndex(index, subsamplingLevel);
179         m_frames[index].m_subsamplingLevel = subsamplingLevel;
180         if (numFrames == 1 && m_frames[index].m_frame)
181             checkForSolidColor();
182     }
183
184     m_frames[index].m_orientation = m_source.orientationAtIndex(index);
185     m_frames[index].m_haveMetadata = true;
186     m_frames[index].m_isComplete = m_source.frameIsCompleteAtIndex(index);
187
188     if (repetitionCount(false) != cAnimationNone)
189         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
190
191     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
192     m_frames[index].m_frameBytes = m_source.frameBytesAtIndex(index, subsamplingLevel);
193
194     const IntSize frameSize(index ? m_source.frameSizeAtIndex(index, subsamplingLevel) : m_size);
195     if (!subsamplingLevel && frameSize != m_size)
196         m_hasUniformFrameSize = false;
197
198     if (m_frames[index].m_frame) {
199         int deltaBytes = safeCast<int>(m_frames[index].m_frameBytes);
200         m_decodedSize += deltaBytes;
201         // The fully-decoded frame will subsume the partially decoded data used
202         // to determine image properties.
203         deltaBytes -= m_decodedPropertiesSize;
204         m_decodedPropertiesSize = 0;
205         if (imageObserver())
206             imageObserver()->decodedSizeChanged(this, deltaBytes);
207     }
208 }
209
210 void BitmapImage::didDecodeProperties() const
211 {
212     if (m_decodedSize)
213         return;
214
215     size_t updatedSize = m_source.bytesDecodedToDetermineProperties();
216     if (m_decodedPropertiesSize == updatedSize)
217         return;
218
219     int deltaBytes = updatedSize - m_decodedPropertiesSize;
220 #if !ASSERT_DISABLED
221     bool overflow = updatedSize > m_decodedPropertiesSize && deltaBytes < 0;
222     bool underflow = updatedSize < m_decodedPropertiesSize && deltaBytes > 0;
223     ASSERT(!overflow && !underflow);
224 #endif
225     m_decodedPropertiesSize = updatedSize;
226     if (imageObserver())
227         imageObserver()->decodedSizeChanged(this, deltaBytes);
228 }
229
230 void BitmapImage::updateSize(ImageOrientationDescription description) const
231 {
232     if (!m_sizeAvailable || m_haveSize)
233         return;
234
235     m_size = m_source.size(description);
236     m_sizeRespectingOrientation = m_source.size(ImageOrientationDescription(RespectImageOrientation, description.imageOrientation()));
237
238     m_imageOrientation = static_cast<unsigned>(description.imageOrientation());
239     m_shouldRespectImageOrientation = static_cast<unsigned>(description.respectImageOrientation());
240
241     m_haveSize = true;
242
243     determineMinimumSubsamplingLevel();
244     didDecodeProperties();
245 }
246
247 FloatSize BitmapImage::size() const
248 {
249     updateSize();
250     return m_size;
251 }
252
253 IntSize BitmapImage::sizeRespectingOrientation(ImageOrientationDescription description) const
254 {
255     updateSize(description);
256     return m_sizeRespectingOrientation;
257 }
258
259 bool BitmapImage::getHotSpot(IntPoint& hotSpot) const
260 {
261     bool result = m_source.getHotSpot(hotSpot);
262     didDecodeProperties();
263     return result;
264 }
265
266 bool BitmapImage::dataChanged(bool allDataReceived)
267 {
268     // Because we're modifying the current frame, clear its (now possibly
269     // inaccurate) metadata as well.
270 #if !PLATFORM(IOS)
271     // Clear all partially-decoded frames. For most image formats, there is only
272     // one frame, but at least GIF and ICO can have more. With GIFs, the frames
273     // come in order and we ask to decode them in order, waiting to request a
274     // subsequent frame until the prior one is complete. Given that we clear
275     // incomplete frames here, this means there is at most one incomplete frame
276     // (even if we use destroyDecodedData() -- since it doesn't reset the
277     // metadata), and it is after all the complete frames.
278     //
279     // With ICOs, on the other hand, we may ask for arbitrary frames at
280     // different times (e.g. because we're displaying a higher-resolution image
281     // in the content area and using a lower-resolution one for the favicon),
282     // and the frames aren't even guaranteed to appear in the file in the same
283     // order as in the directory, so an arbitrary number of the frames might be
284     // incomplete (if we ask for frames for which we've not yet reached the
285     // start of the frame data), and any or none of them might be the particular
286     // frame affected by appending new data here. Thus we have to clear all the
287     // incomplete frames to be safe.
288     unsigned frameBytesCleared = 0;
289     for (size_t i = 0; i < m_frames.size(); ++i) {
290         // NOTE: Don't call frameIsCompleteAtIndex() here, that will try to
291         // decode any uncached (i.e. never-decoded or
292         // cleared-on-a-previous-pass) frames!
293         unsigned frameBytes = m_frames[i].m_frameBytes;
294         if (m_frames[i].m_haveMetadata && !m_frames[i].m_isComplete)
295             frameBytesCleared += (m_frames[i].clear(true) ? frameBytes : 0);
296     }
297     destroyMetadataAndNotify(frameBytesCleared);
298 #else
299     // FIXME: why is this different for iOS?
300     int deltaBytes = 0;
301     if (!m_frames.isEmpty()) {
302         int bytes = m_frames[m_frames.size() - 1].m_frameBytes;
303         if (m_frames[m_frames.size() - 1].clear(true)) {
304             deltaBytes += bytes;
305             deltaBytes += m_decodedPropertiesSize;
306             m_decodedPropertiesSize = 0;
307         }
308     }
309     destroyMetadataAndNotify(deltaBytes);
310 #endif
311     
312     // Feed all the data we've seen so far to the image decoder.
313     m_allDataReceived = allDataReceived;
314 #if PLATFORM(IOS)
315     // FIXME: We should expose a setting to enable/disable progressive loading and make this
316     // code conditional on it. Then we can remove the PLATFORM(IOS)-guard.
317     static const double chunkLoadIntervals[] = {0, 1, 3, 6, 15};
318     double interval = chunkLoadIntervals[std::min(m_progressiveLoadChunkCount, static_cast<uint16_t>(4))];
319
320     bool needsUpdate = false;
321     if (currentTime() - m_progressiveLoadChunkTime > interval) { // The first time through, the chunk time will be 0 and the image will get an update.
322         needsUpdate = true;
323         m_progressiveLoadChunkTime = currentTime();
324         ASSERT(m_progressiveLoadChunkCount <= std::numeric_limits<uint16_t>::max());
325         ++m_progressiveLoadChunkCount;
326     }
327     if (needsUpdate || allDataReceived)
328         m_source.setData(data(), allDataReceived);
329 #else
330     m_source.setData(data(), allDataReceived);
331 #endif
332
333     m_haveFrameCount = false;
334     m_hasUniformFrameSize = true;
335     return isSizeAvailable();
336 }
337
338 String BitmapImage::filenameExtension() const
339 {
340     return m_source.filenameExtension();
341 }
342
343 size_t BitmapImage::frameCount()
344 {
345     if (!m_haveFrameCount) {
346         m_frameCount = m_source.frameCount();
347         // If decoder is not initialized yet, m_source.frameCount() returns 0.
348         if (m_frameCount) {
349             didDecodeProperties();
350             m_haveFrameCount = true;
351         }
352     }
353     return m_frameCount;
354 }
355
356 bool BitmapImage::isSizeAvailable()
357 {
358     if (m_sizeAvailable)
359         return true;
360
361     m_sizeAvailable = m_source.isSizeAvailable();
362     didDecodeProperties();
363
364     return m_sizeAvailable;
365 }
366
367 bool BitmapImage::ensureFrameIsCached(size_t index, ImageFrameCaching frameCaching)
368 {
369     if (index >= frameCount())
370         return false;
371
372     if (index >= m_frames.size()
373         || (frameCaching == CacheMetadataAndFrame && !m_frames[index].m_frame)
374         || (frameCaching == CacheMetadataOnly && !m_frames[index].m_haveMetadata))
375         cacheFrame(index, 0, frameCaching);
376
377     return true;
378 }
379
380 PassNativeImagePtr BitmapImage::frameAtIndex(size_t index, float presentationScaleHint)
381 {
382     if (index >= frameCount())
383         return nullptr;
384
385     SubsamplingLevel subsamplingLevel = std::min(m_source.subsamplingLevelForScale(presentationScaleHint), m_minimumSubsamplingLevel);
386
387     // We may have cached a frame with a higher subsampling level, in which case we need to
388     // re-decode with a lower level.
389     if (index < m_frames.size() && m_frames[index].m_frame && subsamplingLevel < m_frames[index].m_subsamplingLevel) {
390         // If the image is already cached, but at too small a size, re-decode a larger version.
391         int sizeChange = -m_frames[index].m_frameBytes;
392         m_frames[index].clear(true);
393         invalidatePlatformData();
394         m_decodedSize += sizeChange;
395         if (imageObserver())
396             imageObserver()->decodedSizeChanged(this, sizeChange);
397     }
398
399     // If we haven't fetched a frame yet, do so.
400     if (index >= m_frames.size() || !m_frames[index].m_frame)
401         cacheFrame(index, subsamplingLevel, CacheMetadataAndFrame);
402
403     return m_frames[index].m_frame;
404 }
405
406 bool BitmapImage::frameIsCompleteAtIndex(size_t index)
407 {
408     if (!ensureFrameIsCached(index, CacheMetadataOnly))
409         return false;
410
411     return m_frames[index].m_isComplete;
412 }
413
414 float BitmapImage::frameDurationAtIndex(size_t index)
415 {
416     if (!ensureFrameIsCached(index, CacheMetadataOnly))
417         return 0;
418
419     return m_frames[index].m_duration;
420 }
421
422 PassNativeImagePtr BitmapImage::nativeImageForCurrentFrame()
423 {
424     return frameAtIndex(currentFrame());
425 }
426
427 bool BitmapImage::frameHasAlphaAtIndex(size_t index)
428 {
429     if (!ensureFrameIsCached(index, CacheMetadataOnly))
430         return true;
431
432     if (m_frames[index].m_haveMetadata)
433         return m_frames[index].m_hasAlpha;
434
435     return m_source.frameHasAlphaAtIndex(index);
436 }
437
438 bool BitmapImage::currentFrameKnownToBeOpaque()
439 {
440     return !frameHasAlphaAtIndex(currentFrame());
441 }
442
443 ImageOrientation BitmapImage::frameOrientationAtIndex(size_t index)
444 {
445     if (!ensureFrameIsCached(index, CacheMetadataOnly))
446         return DefaultImageOrientation;
447
448     if (m_frames[index].m_haveMetadata)
449         return m_frames[index].m_orientation;
450
451     return m_source.orientationAtIndex(index);
452 }
453
454 #if !ASSERT_DISABLED
455 bool BitmapImage::notSolidColor()
456 {
457     return size().width() != 1 || size().height() != 1 || frameCount() > 1;
458 }
459 #endif
460
461 int BitmapImage::repetitionCount(bool imageKnownToBeComplete)
462 {
463     if ((m_repetitionCountStatus == Unknown) || ((m_repetitionCountStatus == Uncertain) && imageKnownToBeComplete)) {
464         // Snag the repetition count.  If |imageKnownToBeComplete| is false, the
465         // repetition count may not be accurate yet for GIFs; in this case the
466         // decoder will default to cAnimationLoopOnce, and we'll try and read
467         // the count again once the whole image is decoded.
468         m_repetitionCount = m_source.repetitionCount();
469         didDecodeProperties();
470         m_repetitionCountStatus = (imageKnownToBeComplete || m_repetitionCount == cAnimationNone) ? Certain : Uncertain;
471     }
472     return m_repetitionCount;
473 }
474
475 bool BitmapImage::shouldAnimate()
476 {
477     return (repetitionCount(false) != cAnimationNone && !m_animationFinished && imageObserver());
478 }
479
480 void BitmapImage::startAnimation(CatchUpAnimation catchUpIfNecessary)
481 {
482     if (m_frameTimer || !shouldAnimate() || frameCount() <= 1)
483         return;
484
485     // If we aren't already animating, set now as the animation start time.
486     const double time = monotonicallyIncreasingTime();
487     if (!m_desiredFrameStartTime)
488         m_desiredFrameStartTime = time;
489
490     // Don't advance the animation to an incomplete frame.
491     size_t nextFrame = (m_currentFrame + 1) % frameCount();
492     if (!m_allDataReceived && !frameIsCompleteAtIndex(nextFrame))
493         return;
494
495     // Don't advance past the last frame if we haven't decoded the whole image
496     // yet and our repetition count is potentially unset.  The repetition count
497     // in a GIF can potentially come after all the rest of the image data, so
498     // wait on it.
499     if (!m_allDataReceived && repetitionCount(false) == cAnimationLoopOnce && m_currentFrame >= (frameCount() - 1))
500         return;
501
502     // Determine time for next frame to start.  By ignoring paint and timer lag
503     // in this calculation, we make the animation appear to run at its desired
504     // rate regardless of how fast it's being repainted.
505     const double currentDuration = frameDurationAtIndex(m_currentFrame);
506     m_desiredFrameStartTime += currentDuration;
507
508 #if !PLATFORM(IOS)
509     // When an animated image is more than five minutes out of date, the
510     // user probably doesn't care about resyncing and we could burn a lot of
511     // time looping through frames below.  Just reset the timings.
512     const double cAnimationResyncCutoff = 5 * 60;
513     if ((time - m_desiredFrameStartTime) > cAnimationResyncCutoff)
514         m_desiredFrameStartTime = time + currentDuration;
515 #else
516     // Maintaining frame-to-frame delays is more important than
517     // maintaining absolute animation timing, so reset the timings each frame.
518     m_desiredFrameStartTime = time + currentDuration;
519 #endif
520
521     // The image may load more slowly than it's supposed to animate, so that by
522     // the time we reach the end of the first repetition, we're well behind.
523     // Clamp the desired frame start time in this case, so that we don't skip
524     // frames (or whole iterations) trying to "catch up".  This is a tradeoff:
525     // It guarantees users see the whole animation the second time through and
526     // don't miss any repetitions, and is closer to what other browsers do; on
527     // the other hand, it makes animations "less accurate" for pages that try to
528     // sync an image and some other resource (e.g. audio), especially if users
529     // switch tabs (and thus stop drawing the animation, which will pause it)
530     // during that initial loop, then switch back later.
531     if (nextFrame == 0 && m_repetitionsComplete == 0 && m_desiredFrameStartTime < time)
532         m_desiredFrameStartTime = time;
533
534     if (catchUpIfNecessary == DoNotCatchUp || time < m_desiredFrameStartTime) {
535         // Haven't yet reached time for next frame to start; delay until then.
536         m_frameTimer = std::make_unique<Timer<BitmapImage>>(this, &BitmapImage::advanceAnimation);
537         m_frameTimer->startOneShot(std::max(m_desiredFrameStartTime - time, 0.));
538     } else {
539         // We've already reached or passed the time for the next frame to start.
540         // See if we've also passed the time for frames after that to start, in
541         // case we need to skip some frames entirely.  Remember not to advance
542         // to an incomplete frame.
543         for (size_t frameAfterNext = (nextFrame + 1) % frameCount(); frameIsCompleteAtIndex(frameAfterNext); frameAfterNext = (nextFrame + 1) % frameCount()) {
544             // Should we skip the next frame?
545             double frameAfterNextStartTime = m_desiredFrameStartTime + frameDurationAtIndex(nextFrame);
546             if (time < frameAfterNextStartTime)
547                 break;
548
549             // Yes; skip over it without notifying our observers.
550             if (!internalAdvanceAnimation(true))
551                 return;
552             m_desiredFrameStartTime = frameAfterNextStartTime;
553             nextFrame = frameAfterNext;
554         }
555
556         // Draw the next frame immediately.  Note that m_desiredFrameStartTime
557         // may be in the past, meaning the next time through this function we'll
558         // kick off the next advancement sooner than this frame's duration would
559         // suggest.
560         if (internalAdvanceAnimation(false)) {
561             // The image region has been marked dirty, but once we return to our
562             // caller, draw() will clear it, and nothing will cause the
563             // animation to advance again.  We need to start the timer for the
564             // next frame running, or the animation can hang.  (Compare this
565             // with when advanceAnimation() is called, and the region is dirtied
566             // while draw() is not in the callstack, meaning draw() gets called
567             // to update the region and thus startAnimation() is reached again.)
568             // NOTE: For large images with slow or heavily-loaded systems,
569             // throwing away data as we go (see destroyDecodedData()) means we
570             // can spend so much time re-decoding data above that by the time we
571             // reach here we're behind again.  If we let startAnimation() run
572             // the catch-up code again, we can get long delays without painting
573             // as we race the timer, or even infinite recursion.  In this
574             // situation the best we can do is to simply change frames as fast
575             // as possible, so force startAnimation() to set a zero-delay timer
576             // and bail out if we're not caught up.
577             startAnimation(DoNotCatchUp);
578         }
579     }
580 }
581
582 void BitmapImage::stopAnimation()
583 {
584     // This timer is used to animate all occurrences of this image.  Don't invalidate
585     // the timer unless all renderers have stopped drawing.
586     m_frameTimer = nullptr;
587 }
588
589 void BitmapImage::resetAnimation()
590 {
591     stopAnimation();
592     m_currentFrame = 0;
593     m_repetitionsComplete = 0;
594     m_desiredFrameStartTime = 0;
595     m_animationFinished = false;
596     
597     // For extremely large animations, when the animation is reset, we just throw everything away.
598     destroyDecodedDataIfNecessary(true);
599 }
600
601 void BitmapImage::drawPattern(GraphicsContext* ctxt, const FloatRect& tileRect, const AffineTransform& transform,
602     const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator op, const FloatRect& destRect, BlendMode blendMode)
603 {
604     if (tileRect.isEmpty())
605         return;
606
607     if (!ctxt->drawLuminanceMask()) {
608         Image::drawPattern(ctxt, tileRect, transform, phase, styleColorSpace, op, destRect, blendMode);
609         return;
610     }
611     if (!m_cachedImage) {
612         std::unique_ptr<ImageBuffer> buffer = ImageBuffer::create(expandedIntSize(tileRect.size()));
613         ASSERT(buffer.get());
614
615         ImageObserver* observer = imageObserver();
616         ASSERT(observer);
617
618         // Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
619         setImageObserver(0);
620
621         draw(buffer->context(), tileRect, tileRect, styleColorSpace, op, blendMode, ImageOrientationDescription());
622
623         setImageObserver(observer);
624         buffer->convertToLuminanceMask();
625
626         m_cachedImage = buffer->copyImage(DontCopyBackingStore, Unscaled);
627         m_cachedImage->setSpaceSize(spaceSize());
628
629         setImageObserver(observer);
630     }
631
632     ctxt->setDrawLuminanceMask(false);
633     m_cachedImage->drawPattern(ctxt, tileRect, transform, phase, styleColorSpace, op, destRect, blendMode);
634 }
635
636
637 void BitmapImage::advanceAnimation(Timer<BitmapImage>&)
638 {
639     internalAdvanceAnimation(false);
640     // At this point the image region has been marked dirty, and if it's
641     // onscreen, we'll soon make a call to draw(), which will call
642     // startAnimation() again to keep the animation moving.
643 }
644
645 bool BitmapImage::internalAdvanceAnimation(bool skippingFrames)
646 {
647     // Stop the animation.
648     stopAnimation();
649     
650     ++m_currentFrame;
651     bool advancedAnimation = true;
652     bool destroyAll = false;
653     if (m_currentFrame >= frameCount()) {
654         ++m_repetitionsComplete;
655
656         // Get the repetition count again.  If we weren't able to get a
657         // repetition count before, we should have decoded the whole image by
658         // now, so it should now be available.
659         // Note that we don't need to special-case cAnimationLoopOnce here
660         // because it is 0 (see comments on its declaration in ImageSource.h).
661         if (repetitionCount(true) != cAnimationLoopInfinite && m_repetitionsComplete > m_repetitionCount) {
662             m_animationFinished = true;
663             m_desiredFrameStartTime = 0;
664             --m_currentFrame;
665             advancedAnimation = false;
666         } else {
667             m_currentFrame = 0;
668             destroyAll = true;
669         }
670     }
671     destroyDecodedDataIfNecessary(destroyAll);
672
673     // We need to draw this frame if we advanced to it while not skipping, or if
674     // while trying to skip frames we hit the last frame and thus had to stop.
675     if (skippingFrames != advancedAnimation)
676         imageObserver()->animationAdvanced(this);
677     return advancedAnimation;
678 }
679
680 bool BitmapImage::mayFillWithSolidColor()
681 {
682     if (!m_checkedForSolidColor && frameCount() > 0) {
683         checkForSolidColor();
684         // WINCE PORT: checkForSolidColor() doesn't set m_checkedForSolidColor until
685         // it gets enough information to make final decision.
686 #if !OS(WINCE)
687         ASSERT(m_checkedForSolidColor);
688 #endif
689     }
690     return m_isSolidColor && !m_currentFrame;
691 }
692
693 Color BitmapImage::solidColor() const
694 {
695     return m_solidColor;
696 }
697     
698 bool BitmapImage::canAnimate()
699 {
700     return shouldAnimate() && frameCount() > 1;
701 }
702
703 }