Fix ordered comparison warnings in BitmapImage::drawPattern
[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 COMPUTER, 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 COMPUTER, 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 "ImageBuffer.h"
32 #include "ImageObserver.h"
33 #include "IntRect.h"
34 #include "MIMETypeRegistry.h"
35 #include "Timer.h"
36 #include <wtf/CurrentTime.h>
37 #include <wtf/Vector.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 BitmapImage::BitmapImage(ImageObserver* observer)
43     : Image(observer)
44     , m_currentFrame(0)
45     , m_frames(0)
46     , m_frameTimer(0)
47     , m_repetitionCount(cAnimationNone)
48     , m_repetitionCountStatus(Unknown)
49     , m_repetitionsComplete(0)
50     , m_desiredFrameStartTime(0)
51     , m_decodedSize(0)
52     , m_decodedPropertiesSize(0)
53     , m_frameCount(0)
54     , m_isSolidColor(false)
55     , m_checkedForSolidColor(false)
56     , m_animationFinished(false)
57     , m_allDataReceived(false)
58     , m_haveSize(false)
59     , m_sizeAvailable(false)
60     , m_hasUniformFrameSize(true)
61     , m_haveFrameCount(false)
62     , m_cachedImage(0)
63 {
64 }
65
66 BitmapImage::~BitmapImage()
67 {
68     invalidatePlatformData();
69     stopAnimation();
70 }
71
72 bool BitmapImage::hasSingleSecurityOrigin() const
73 {
74     return true;
75 }
76
77 void BitmapImage::destroyDecodedData(bool destroyAll)
78 {
79     unsigned frameBytesCleared = 0;
80     const size_t clearBeforeFrame = destroyAll ? m_frames.size() : m_currentFrame;
81     for (size_t i = 0; i < clearBeforeFrame; ++i) {
82         // The underlying frame isn't actually changing (we're just trying to
83         // save the memory for the framebuffer data), so we don't need to clear
84         // the metadata.
85         unsigned frameBytes = m_frames[i].m_frameBytes;
86         if (m_frames[i].clear(false))
87             frameBytesCleared += frameBytes;
88     }
89
90     destroyMetadataAndNotify(frameBytesCleared);
91
92     m_source.clear(destroyAll, clearBeforeFrame, data(), m_allDataReceived);
93     return;
94 }
95
96 void BitmapImage::destroyDecodedDataIfNecessary(bool destroyAll)
97 {
98     // Animated images >5MB are considered large enough that we'll only hang on
99     // to one frame at a time.
100     static const unsigned cLargeAnimationCutoff = 5242880;
101     unsigned allFrameBytes = 0;
102     for (size_t i = 0; i < m_frames.size(); ++i)
103         allFrameBytes += m_frames[i].m_frameBytes;
104
105     if (allFrameBytes > cLargeAnimationCutoff)
106         destroyDecodedData(destroyAll);
107 }
108
109 void BitmapImage::destroyMetadataAndNotify(unsigned frameBytesCleared)
110 {
111     m_isSolidColor = false;
112     m_checkedForSolidColor = false;
113     invalidatePlatformData();
114
115     ASSERT(m_decodedSize >= frameBytesCleared);
116     m_decodedSize -= frameBytesCleared;
117     if (frameBytesCleared > 0) {
118         frameBytesCleared += m_decodedPropertiesSize;
119         m_decodedPropertiesSize = 0;
120     }
121     if (frameBytesCleared && imageObserver())
122         imageObserver()->decodedSizeChanged(this, -safeCast<int>(frameBytesCleared));
123 }
124
125 void BitmapImage::cacheFrame(size_t index)
126 {
127     size_t numFrames = frameCount();
128     ASSERT(m_decodedSize == 0 || numFrames > 1);
129     
130     if (m_frames.size() < numFrames)
131         m_frames.grow(numFrames);
132
133     m_frames[index].m_frame = m_source.createFrameAtIndex(index);
134     if (numFrames == 1 && m_frames[index].m_frame)
135         checkForSolidColor();
136
137     m_frames[index].m_orientation = m_source.orientationAtIndex(index);
138     m_frames[index].m_haveMetadata = true;
139     m_frames[index].m_isComplete = m_source.frameIsCompleteAtIndex(index);
140     if (repetitionCount(false) != cAnimationNone)
141         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
142     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
143     m_frames[index].m_frameBytes = m_source.frameBytesAtIndex(index);
144
145     const IntSize frameSize(index ? m_source.frameSizeAtIndex(index) : m_size);
146     if (frameSize != m_size)
147         m_hasUniformFrameSize = false;
148     if (m_frames[index].m_frame) {
149         int deltaBytes = safeCast<int>(m_frames[index].m_frameBytes);
150         m_decodedSize += deltaBytes;
151         // The fully-decoded frame will subsume the partially decoded data used
152         // to determine image properties.
153         deltaBytes -= m_decodedPropertiesSize;
154         m_decodedPropertiesSize = 0;
155         if (imageObserver())
156             imageObserver()->decodedSizeChanged(this, deltaBytes);
157     }
158 }
159
160 void BitmapImage::didDecodeProperties() const
161 {
162     if (m_decodedSize)
163         return;
164     size_t updatedSize = m_source.bytesDecodedToDetermineProperties();
165     if (m_decodedPropertiesSize == updatedSize)
166         return;
167     int deltaBytes = updatedSize - m_decodedPropertiesSize;
168 #if !ASSERT_DISABLED
169     bool overflow = updatedSize > m_decodedPropertiesSize && deltaBytes < 0;
170     bool underflow = updatedSize < m_decodedPropertiesSize && deltaBytes > 0;
171     ASSERT(!overflow && !underflow);
172 #endif
173     m_decodedPropertiesSize = updatedSize;
174     if (imageObserver())
175         imageObserver()->decodedSizeChanged(this, deltaBytes);
176 }
177
178 void BitmapImage::updateSize() const
179 {
180     if (!m_sizeAvailable || m_haveSize)
181         return;
182
183     m_size = m_source.size();
184     m_sizeRespectingOrientation = m_source.size(ImageOrientationDescription(RespectImageOrientation));
185     m_haveSize = true;
186     didDecodeProperties();
187 }
188
189 IntSize BitmapImage::size() const
190 {
191     updateSize();
192     return m_size;
193 }
194
195 IntSize BitmapImage::sizeRespectingOrientation() const
196 {
197     updateSize();
198     return m_sizeRespectingOrientation;
199 }
200
201 IntSize BitmapImage::currentFrameSize() const
202 {
203     if (!m_currentFrame || m_hasUniformFrameSize)
204         return size();
205     IntSize frameSize = m_source.frameSizeAtIndex(m_currentFrame);
206     didDecodeProperties();
207     return frameSize;
208 }
209
210 bool BitmapImage::getHotSpot(IntPoint& hotSpot) const
211 {
212     bool result = m_source.getHotSpot(hotSpot);
213     didDecodeProperties();
214     return result;
215 }
216
217 bool BitmapImage::dataChanged(bool allDataReceived)
218 {
219     // Clear all partially-decoded frames. For most image formats, there is only
220     // one frame, but at least GIF and ICO can have more. With GIFs, the frames
221     // come in order and we ask to decode them in order, waiting to request a
222     // subsequent frame until the prior one is complete. Given that we clear
223     // incomplete frames here, this means there is at most one incomplete frame
224     // (even if we use destroyDecodedData() -- since it doesn't reset the
225     // metadata), and it is after all the complete frames.
226     //
227     // With ICOs, on the other hand, we may ask for arbitrary frames at
228     // different times (e.g. because we're displaying a higher-resolution image
229     // in the content area and using a lower-resolution one for the favicon),
230     // and the frames aren't even guaranteed to appear in the file in the same
231     // order as in the directory, so an arbitrary number of the frames might be
232     // incomplete (if we ask for frames for which we've not yet reached the
233     // start of the frame data), and any or none of them might be the particular
234     // frame affected by appending new data here. Thus we have to clear all the
235     // incomplete frames to be safe.
236     unsigned frameBytesCleared = 0;
237     for (size_t i = 0; i < m_frames.size(); ++i) {
238         // NOTE: Don't call frameIsCompleteAtIndex() here, that will try to
239         // decode any uncached (i.e. never-decoded or
240         // cleared-on-a-previous-pass) frames!
241         unsigned frameBytes = m_frames[i].m_frameBytes;
242         if (m_frames[i].m_haveMetadata && !m_frames[i].m_isComplete)
243             frameBytesCleared += (m_frames[i].clear(true) ? frameBytes : 0);
244     }
245     destroyMetadataAndNotify(frameBytesCleared);
246     
247     // Feed all the data we've seen so far to the image decoder.
248     m_allDataReceived = allDataReceived;
249     m_source.setData(data(), allDataReceived);
250     
251     m_haveFrameCount = false;
252     m_hasUniformFrameSize = true;
253     return isSizeAvailable();
254 }
255
256 String BitmapImage::filenameExtension() const
257 {
258     return m_source.filenameExtension();
259 }
260
261 size_t BitmapImage::frameCount()
262 {
263     if (!m_haveFrameCount) {
264         m_frameCount = m_source.frameCount();
265         // If decoder is not initialized yet, m_source.frameCount() returns 0.
266         if (m_frameCount) {
267             didDecodeProperties();
268             m_haveFrameCount = true;
269         }
270     }
271     return m_frameCount;
272 }
273
274 bool BitmapImage::isSizeAvailable()
275 {
276     if (m_sizeAvailable)
277         return true;
278
279     m_sizeAvailable = m_source.isSizeAvailable();
280     didDecodeProperties();
281
282     return m_sizeAvailable;
283 }
284
285 bool BitmapImage::ensureFrameIsCached(size_t index)
286 {
287     if (index >= frameCount())
288         return false;
289
290     if (index >= m_frames.size() || !m_frames[index].m_frame)
291         cacheFrame(index);
292     return true;
293 }
294
295 PassNativeImagePtr BitmapImage::frameAtIndex(size_t index)
296 {
297     if (!ensureFrameIsCached(index))
298         return 0;
299     return m_frames[index].m_frame;
300 }
301
302 bool BitmapImage::frameIsCompleteAtIndex(size_t index)
303 {
304     if (!ensureFrameIsCached(index))
305         return false;
306     return m_frames[index].m_isComplete;
307 }
308
309 float BitmapImage::frameDurationAtIndex(size_t index)
310 {
311     if (!ensureFrameIsCached(index))
312         return 0;
313     return m_frames[index].m_duration;
314 }
315
316 PassNativeImagePtr BitmapImage::nativeImageForCurrentFrame()
317 {
318     return frameAtIndex(currentFrame());
319 }
320
321 bool BitmapImage::frameHasAlphaAtIndex(size_t index)
322 {
323     if (m_frames.size() <= index)
324         return true;
325
326     if (m_frames[index].m_haveMetadata)
327         return m_frames[index].m_hasAlpha;
328
329     return m_source.frameHasAlphaAtIndex(index);
330 }
331
332 bool BitmapImage::currentFrameKnownToBeOpaque()
333 {
334     return !frameHasAlphaAtIndex(currentFrame());
335 }
336
337 ImageOrientation BitmapImage::frameOrientationAtIndex(size_t index)
338 {
339     if (!ensureFrameIsCached(index))
340         return DefaultImageOrientation;
341
342     if (m_frames[index].m_haveMetadata)
343         return m_frames[index].m_orientation;
344
345     return m_source.orientationAtIndex(index);
346 }
347
348 #if !ASSERT_DISABLED
349 bool BitmapImage::notSolidColor()
350 {
351     return size().width() != 1 || size().height() != 1 || frameCount() > 1;
352 }
353 #endif
354
355
356
357 int BitmapImage::repetitionCount(bool imageKnownToBeComplete)
358 {
359     if ((m_repetitionCountStatus == Unknown) || ((m_repetitionCountStatus == Uncertain) && imageKnownToBeComplete)) {
360         // Snag the repetition count.  If |imageKnownToBeComplete| is false, the
361         // repetition count may not be accurate yet for GIFs; in this case the
362         // decoder will default to cAnimationLoopOnce, and we'll try and read
363         // the count again once the whole image is decoded.
364         m_repetitionCount = m_source.repetitionCount();
365         didDecodeProperties();
366         m_repetitionCountStatus = (imageKnownToBeComplete || m_repetitionCount == cAnimationNone) ? Certain : Uncertain;
367     }
368     return m_repetitionCount;
369 }
370
371 bool BitmapImage::shouldAnimate()
372 {
373     return (repetitionCount(false) != cAnimationNone && !m_animationFinished && imageObserver());
374 }
375
376 void BitmapImage::startAnimation(bool catchUpIfNecessary)
377 {
378     if (m_frameTimer || !shouldAnimate() || frameCount() <= 1)
379         return;
380
381     // If we aren't already animating, set now as the animation start time.
382     const double time = monotonicallyIncreasingTime();
383     if (!m_desiredFrameStartTime)
384         m_desiredFrameStartTime = time;
385
386     // Don't advance the animation to an incomplete frame.
387     size_t nextFrame = (m_currentFrame + 1) % frameCount();
388     if (!m_allDataReceived && !frameIsCompleteAtIndex(nextFrame))
389         return;
390
391     // Don't advance past the last frame if we haven't decoded the whole image
392     // yet and our repetition count is potentially unset.  The repetition count
393     // in a GIF can potentially come after all the rest of the image data, so
394     // wait on it.
395     if (!m_allDataReceived && repetitionCount(false) == cAnimationLoopOnce && m_currentFrame >= (frameCount() - 1))
396         return;
397
398     // Determine time for next frame to start.  By ignoring paint and timer lag
399     // in this calculation, we make the animation appear to run at its desired
400     // rate regardless of how fast it's being repainted.
401     const double currentDuration = frameDurationAtIndex(m_currentFrame);
402     m_desiredFrameStartTime += currentDuration;
403
404     // When an animated image is more than five minutes out of date, the
405     // user probably doesn't care about resyncing and we could burn a lot of
406     // time looping through frames below.  Just reset the timings.
407     const double cAnimationResyncCutoff = 5 * 60;
408     if ((time - m_desiredFrameStartTime) > cAnimationResyncCutoff)
409         m_desiredFrameStartTime = time + currentDuration;
410
411     // The image may load more slowly than it's supposed to animate, so that by
412     // the time we reach the end of the first repetition, we're well behind.
413     // Clamp the desired frame start time in this case, so that we don't skip
414     // frames (or whole iterations) trying to "catch up".  This is a tradeoff:
415     // It guarantees users see the whole animation the second time through and
416     // don't miss any repetitions, and is closer to what other browsers do; on
417     // the other hand, it makes animations "less accurate" for pages that try to
418     // sync an image and some other resource (e.g. audio), especially if users
419     // switch tabs (and thus stop drawing the animation, which will pause it)
420     // during that initial loop, then switch back later.
421     if (nextFrame == 0 && m_repetitionsComplete == 0 && m_desiredFrameStartTime < time)
422         m_desiredFrameStartTime = time;
423
424     if (!catchUpIfNecessary || time < m_desiredFrameStartTime) {
425         // Haven't yet reached time for next frame to start; delay until then.
426         m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
427         m_frameTimer->startOneShot(std::max(m_desiredFrameStartTime - time, 0.));
428     } else {
429         // We've already reached or passed the time for the next frame to start.
430         // See if we've also passed the time for frames after that to start, in
431         // case we need to skip some frames entirely.  Remember not to advance
432         // to an incomplete frame.
433         for (size_t frameAfterNext = (nextFrame + 1) % frameCount(); frameIsCompleteAtIndex(frameAfterNext); frameAfterNext = (nextFrame + 1) % frameCount()) {
434             // Should we skip the next frame?
435             double frameAfterNextStartTime = m_desiredFrameStartTime + frameDurationAtIndex(nextFrame);
436             if (time < frameAfterNextStartTime)
437                 break;
438
439             // Yes; skip over it without notifying our observers.
440             if (!internalAdvanceAnimation(true))
441                 return;
442             m_desiredFrameStartTime = frameAfterNextStartTime;
443             nextFrame = frameAfterNext;
444         }
445
446         // Draw the next frame immediately.  Note that m_desiredFrameStartTime
447         // may be in the past, meaning the next time through this function we'll
448         // kick off the next advancement sooner than this frame's duration would
449         // suggest.
450         if (internalAdvanceAnimation(false)) {
451             // The image region has been marked dirty, but once we return to our
452             // caller, draw() will clear it, and nothing will cause the
453             // animation to advance again.  We need to start the timer for the
454             // next frame running, or the animation can hang.  (Compare this
455             // with when advanceAnimation() is called, and the region is dirtied
456             // while draw() is not in the callstack, meaning draw() gets called
457             // to update the region and thus startAnimation() is reached again.)
458             // NOTE: For large images with slow or heavily-loaded systems,
459             // throwing away data as we go (see destroyDecodedData()) means we
460             // can spend so much time re-decoding data above that by the time we
461             // reach here we're behind again.  If we let startAnimation() run
462             // the catch-up code again, we can get long delays without painting
463             // as we race the timer, or even infinite recursion.  In this
464             // situation the best we can do is to simply change frames as fast
465             // as possible, so force startAnimation() to set a zero-delay timer
466             // and bail out if we're not caught up.
467             startAnimation(false);
468         }
469     }
470 }
471
472 void BitmapImage::stopAnimation()
473 {
474     // This timer is used to animate all occurrences of this image.  Don't invalidate
475     // the timer unless all renderers have stopped drawing.
476     delete m_frameTimer;
477     m_frameTimer = 0;
478 }
479
480 void BitmapImage::resetAnimation()
481 {
482     stopAnimation();
483     m_currentFrame = 0;
484     m_repetitionsComplete = 0;
485     m_desiredFrameStartTime = 0;
486     m_animationFinished = false;
487     
488     // For extremely large animations, when the animation is reset, we just throw everything away.
489     destroyDecodedDataIfNecessary(true);
490 }
491
492 unsigned BitmapImage::decodedSize() const
493 {
494     return m_decodedSize;
495 }
496
497 void BitmapImage::drawPattern(GraphicsContext* ctxt, const FloatRect& tileRect, const AffineTransform& transform,
498     const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator op, const FloatRect& destRect, BlendMode blendMode)
499 {
500     if (tileRect.isEmpty())
501         return;
502
503     if (!ctxt->drawLuminanceMask()) {
504         Image::drawPattern(ctxt, tileRect, transform, phase, styleColorSpace, op, destRect, blendMode);
505         return;
506     }
507     if (!m_cachedImage) {
508         OwnPtr<ImageBuffer> buffer = ImageBuffer::create(expandedIntSize(tileRect.size()));
509         ASSERT(buffer.get());
510
511         ImageObserver* observer = imageObserver();
512         ASSERT(observer);
513
514         // Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
515         setImageObserver(0);
516
517         draw(buffer->context(), tileRect, tileRect, styleColorSpace, op, blendMode);
518
519         setImageObserver(observer);
520         buffer->convertToLuminanceMask();
521
522         m_cachedImage = buffer->copyImage(DontCopyBackingStore, Unscaled);
523         m_cachedImage->setSpaceSize(spaceSize());
524
525         setImageObserver(observer);
526     }
527
528     ctxt->setDrawLuminanceMask(false);
529     m_cachedImage->drawPattern(ctxt, tileRect, transform, phase, styleColorSpace, op, destRect, blendMode);
530 }
531
532
533 void BitmapImage::advanceAnimation(Timer<BitmapImage>*)
534 {
535     internalAdvanceAnimation(false);
536     // At this point the image region has been marked dirty, and if it's
537     // onscreen, we'll soon make a call to draw(), which will call
538     // startAnimation() again to keep the animation moving.
539 }
540
541 bool BitmapImage::internalAdvanceAnimation(bool skippingFrames)
542 {
543     // Stop the animation.
544     stopAnimation();
545     
546     // See if anyone is still paying attention to this animation.  If not, we don't
547     // advance and will remain suspended at the current frame until the animation is resumed.
548     if (!skippingFrames && imageObserver()->shouldPauseAnimation(this))
549         return false;
550
551     ++m_currentFrame;
552     bool advancedAnimation = true;
553     bool destroyAll = false;
554     if (m_currentFrame >= frameCount()) {
555         ++m_repetitionsComplete;
556
557         // Get the repetition count again.  If we weren't able to get a
558         // repetition count before, we should have decoded the whole image by
559         // now, so it should now be available.
560         // Note that we don't need to special-case cAnimationLoopOnce here
561         // because it is 0 (see comments on its declaration in ImageSource.h).
562         if (repetitionCount(true) != cAnimationLoopInfinite && m_repetitionsComplete > m_repetitionCount) {
563             m_animationFinished = true;
564             m_desiredFrameStartTime = 0;
565             --m_currentFrame;
566             advancedAnimation = false;
567         } else {
568             m_currentFrame = 0;
569             destroyAll = true;
570         }
571     }
572     destroyDecodedDataIfNecessary(destroyAll);
573
574     // We need to draw this frame if we advanced to it while not skipping, or if
575     // while trying to skip frames we hit the last frame and thus had to stop.
576     if (skippingFrames != advancedAnimation)
577         imageObserver()->animationAdvanced(this);
578     return advancedAnimation;
579 }
580
581 bool BitmapImage::mayFillWithSolidColor()
582 {
583     if (!m_checkedForSolidColor && frameCount() > 0) {
584         checkForSolidColor();
585         // WINCE PORT: checkForSolidColor() doesn't set m_checkedForSolidColor until
586         // it gets enough information to make final decision.
587 #if !OS(WINCE)
588         ASSERT(m_checkedForSolidColor);
589 #endif
590     }
591     return m_isSolidColor && !m_currentFrame;
592 }
593
594 Color BitmapImage::solidColor() const
595 {
596     return m_solidColor;
597 }
598     
599 bool BitmapImage::canAnimate()
600 {
601     return shouldAnimate() && frameCount() > 1;
602 }
603
604 }