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