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