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