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