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