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