9ef1d6ab5e6456e1759b369c8658f4f076bca38a
[WebKit-https.git] / 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 "ImageObserver.h"
32 #include "IntRect.h"
33 #include "PlatformString.h"
34 #include "Timer.h"
35 #include <wtf/Vector.h>
36 #include "MIMETypeRegistry.h"
37
38 namespace WebCore {
39
40 // Animated images >5MB are considered large enough that we'll only hang on to
41 // one frame at a time.
42 const unsigned cLargeAnimationCutoff = 5242880;
43
44 BitmapImage::BitmapImage(ImageObserver* observer)
45     : Image(observer)
46     , m_currentFrame(0)
47     , m_frames(0)
48     , m_frameTimer(0)
49     , m_repetitionCount(0)
50     , m_repetitionsComplete(0)
51     , m_isSolidColor(false)
52     , m_animatingImageType(true)
53     , m_animationFinished(false)
54     , m_allDataReceived(false)
55     , m_haveSize(false)
56     , m_sizeAvailable(false)
57     , m_decodedSize(0)
58 {
59     initPlatformData();
60 }
61
62 BitmapImage::~BitmapImage()
63 {
64     invalidatePlatformData();
65     stopAnimation();
66 }
67
68 void BitmapImage::destroyDecodedData(bool incremental)
69 {
70     // Destroy the cached images and release them.
71     if (m_frames.size()) {
72         int sizeChange = 0;
73         int frameSize = m_size.width() * m_size.height() * 4;
74         for (unsigned i = incremental ? m_frames.size() - 1 : 0; i < m_frames.size(); i++) {
75             if (m_frames[i].m_frame) {
76                 sizeChange -= frameSize;
77                 m_frames[i].clear();
78             }
79         }
80
81         // We just always invalidate our platform data, even in the incremental case.
82         // This could be better, but it's not a big deal.
83         m_isSolidColor = false;
84         invalidatePlatformData();
85         
86         if (sizeChange) {
87             m_decodedSize += sizeChange;
88             if (imageObserver())
89                 imageObserver()->decodedSizeChanged(this, sizeChange);
90         }
91         
92         if (!incremental) {
93             // Reset the image source, since Image I/O has an underlying cache that it uses
94             // while animating that it seems to never clear.
95             m_source.clear();
96             m_source.setData(m_data.get(), m_allDataReceived);
97         }
98     }
99 }
100
101 void BitmapImage::cacheFrame(size_t index)
102 {
103     size_t numFrames = frameCount();
104     ASSERT(m_decodedSize == 0 || numFrames > 1);
105     
106     if (!m_frames.size() && shouldAnimate()) {            
107         // Snag the repetition count.
108         m_repetitionCount = m_source.repetitionCount();
109         if (m_repetitionCount == cAnimationNone)
110             m_animatingImageType = false;
111     }
112     
113     if (m_frames.size() < numFrames)
114         m_frames.grow(numFrames);
115
116     m_frames[index].m_frame = m_source.createFrameAtIndex(index);
117     if (numFrames == 1 && m_frames[index].m_frame)
118         checkForSolidColor();
119
120     if (shouldAnimate())
121         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
122     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
123     
124     int sizeChange = m_frames[index].m_frame ? m_size.width() * m_size.height() * 4 : 0;
125     if (sizeChange) {
126         m_decodedSize += sizeChange;
127         if (imageObserver())
128             imageObserver()->decodedSizeChanged(this, sizeChange);
129     }
130 }
131
132 IntSize BitmapImage::size() const
133 {
134     if (m_sizeAvailable && !m_haveSize) {
135         m_size = m_source.size();
136         m_haveSize = true;
137     }
138     return m_size;
139 }
140
141 bool BitmapImage::dataChanged(bool allDataReceived)
142 {
143     destroyDecodedData(true);
144     
145     // Feed all the data we've seen so far to the image decoder.
146     m_allDataReceived = allDataReceived;
147     m_source.setData(m_data.get(), allDataReceived);
148     
149     // Image properties will not be available until the first frame of the file
150     // reaches kCGImageStatusIncomplete.
151     return isSizeAvailable();
152 }
153
154 size_t BitmapImage::frameCount()
155 {
156     return m_source.frameCount();
157 }
158
159 bool BitmapImage::isSizeAvailable()
160 {
161     if (m_sizeAvailable)
162         return true;
163
164     m_sizeAvailable = m_source.isSizeAvailable();
165
166     return m_sizeAvailable;
167 }
168
169 NativeImagePtr BitmapImage::frameAtIndex(size_t index)
170 {
171     if (index >= frameCount())
172         return 0;
173
174     if (index >= m_frames.size() || !m_frames[index].m_frame)
175         cacheFrame(index);
176
177     return m_frames[index].m_frame;
178 }
179
180 float BitmapImage::frameDurationAtIndex(size_t index)
181 {
182     if (index >= frameCount())
183         return 0;
184
185     if (index >= m_frames.size() || !m_frames[index].m_frame)
186         cacheFrame(index);
187
188     return m_frames[index].m_duration;
189 }
190
191 bool BitmapImage::frameHasAlphaAtIndex(size_t index)
192 {
193     if (index >= frameCount())
194         return 0;
195
196     if (index >= m_frames.size() || !m_frames[index].m_frame)
197         cacheFrame(index);
198
199     return m_frames[index].m_hasAlpha;
200 }
201
202 bool BitmapImage::shouldAnimate()
203 {
204     return (m_animatingImageType && !m_animationFinished && imageObserver());
205 }
206
207 void BitmapImage::startAnimation()
208 {
209     if (m_frameTimer || !shouldAnimate() || frameCount() <= 1)
210         return;
211
212     // Don't advance the animation until the current frame has completely loaded.
213     if (!m_source.frameIsCompleteAtIndex(m_currentFrame))
214         return;
215
216     m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
217     m_frameTimer->startOneShot(frameDurationAtIndex(m_currentFrame));
218 }
219
220 void BitmapImage::stopAnimation()
221 {
222     // This timer is used to animate all occurrences of this image.  Don't invalidate
223     // the timer unless all renderers have stopped drawing.
224     delete m_frameTimer;
225     m_frameTimer = 0;
226 }
227
228 void BitmapImage::resetAnimation()
229 {
230     stopAnimation();
231     m_currentFrame = 0;
232     m_repetitionsComplete = 0;
233     m_animationFinished = false;
234     int frameSize = m_size.width() * m_size.height() * 4;
235     
236     // For extremely large animations, when the animation is reset, we just throw everything away.
237     if (frameCount() * frameSize > cLargeAnimationCutoff)
238         destroyDecodedData();
239 }
240
241 void BitmapImage::advanceAnimation(Timer<BitmapImage>* timer)
242 {
243     // Stop the animation.
244     stopAnimation();
245     
246     // See if anyone is still paying attention to this animation.  If not, we don't
247     // advance and will remain suspended at the current frame until the animation is resumed.
248     if (imageObserver()->shouldPauseAnimation(this))
249         return;
250
251     m_currentFrame++;
252     if (m_currentFrame >= frameCount()) {
253         m_repetitionsComplete += 1;
254         if (m_repetitionCount && m_repetitionsComplete >= m_repetitionCount) {
255             m_animationFinished = true;
256             m_currentFrame--;
257             return;
258         }
259         m_currentFrame = 0;
260     }
261
262     // Notify our observer that the animation has advanced.
263     imageObserver()->animationAdvanced(this);
264
265     // For large animated images, go ahead and throw away frames as we go to save
266     // footprint.
267     int frameSize = m_size.width() * m_size.height() * 4;
268     if (frameCount() * frameSize > cLargeAnimationCutoff) {
269         // Destroy all of our frames and just redecode every time.
270         destroyDecodedData();
271
272         // Go ahead and decode the next frame.
273         frameAtIndex(m_currentFrame);
274     }
275     
276     // We do not advance the animation explicitly.  We rely on a subsequent draw of the image
277     // to force a request for the next frame via startAnimation().  This allows images that move offscreen while
278     // scrolling to stop animating (thus saving memory from additional decoded frames and
279     // CPU time spent doing the decoding).
280 }
281
282 }