This patch dramatically reduces the memory consumed by animated images. ...
[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 Apple Computer, 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 >1MB are considered large enough that we'll only hang on to
41 // one frame at a time.
42 const unsigned cLargeAnimationCutoff = 1048576;
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_haveSize(false)
55     , m_sizeAvailable(false)
56     , m_decodedSize(0)
57 {
58     initPlatformData();
59 }
60
61 BitmapImage::~BitmapImage()
62 {
63     // Null out the image observer so that we don't incorrectly communicate that decoded data is being destroyed during destruction.
64     m_imageObserver = 0;
65     destroyDecodedData();
66     stopAnimation();
67 }
68
69 void BitmapImage::destroyDecodedData(bool incremental)
70 {
71     // Destroy the cached images and release them.
72     if (m_frames.size()) {
73         int sizeChange = 0;
74         int frameSize = m_size.width() * m_size.height() * 4;
75         for (unsigned i = incremental ? m_frames.size() - 1 : 0; i < m_frames.size(); i++) {
76             if (m_frames[i].m_frame) {
77                 sizeChange -= frameSize;
78                 m_frames[i].clear();
79                 if (!incremental)
80                     m_source.destroyFrameAtIndex(i);
81             }
82         }
83
84         // We just always invalidate our platform data, even in the incremental case.
85         // This could be better, but it's not a big deal.
86         m_isSolidColor = false;
87         invalidatePlatformData();
88         
89         if (sizeChange) {
90             m_decodedSize += sizeChange;
91             if (imageObserver())
92                 imageObserver()->decodedSizeChanged(this, sizeChange);
93         }
94         
95         if (!incremental && frameCount() * frameSize > cLargeAnimationCutoff) {
96             // Reset the image source, since Image I/O has an underlying cache that it uses
97             // while animating that it seems to never clear.
98             m_source.clear();
99             setData(true);
100         }
101     }
102 }
103
104 void BitmapImage::cacheFrame(size_t index)
105 {
106     size_t numFrames = frameCount();
107     if (!m_frames.size() && shouldAnimate()) {            
108         // Snag the repetition count.
109         m_repetitionCount = m_source.repetitionCount();
110         if (m_repetitionCount == cAnimationNone)
111             m_animatingImageType = false;
112     }
113     
114     if (m_frames.size() < numFrames)
115         m_frames.resize(numFrames);
116
117     m_frames[index].m_frame = m_source.createFrameAtIndex(index);
118     if (numFrames == 1 && m_frames[index].m_frame)
119         checkForSolidColor();
120
121     if (shouldAnimate())
122         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
123     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
124     
125     int sizeChange = m_size.width() * m_size.height() * 4;
126     if (sizeChange) {
127         m_decodedSize += sizeChange;
128         if (imageObserver())
129             imageObserver()->decodedSizeChanged(this, sizeChange);
130     }
131 }
132
133 IntSize BitmapImage::size() const
134 {
135     if (m_sizeAvailable && !m_haveSize) {
136         m_size = m_source.size();
137         m_haveSize = true;
138     }
139     return m_size;
140 }
141
142 bool BitmapImage::setNativeData(NativeBytePtr data, bool allDataReceived)
143 {
144     destroyDecodedData(true);
145     
146     // Feed all the data we've seen so far to the image decoder.
147     m_source.setData(data, 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     m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
213     m_frameTimer->startOneShot(frameDurationAtIndex(m_currentFrame));
214 }
215
216 void BitmapImage::stopAnimation()
217 {
218     // This timer is used to animate all occurrences of this image.  Don't invalidate
219     // the timer unless all renderers have stopped drawing.
220     delete m_frameTimer;
221     m_frameTimer = 0;
222 }
223
224 void BitmapImage::resetAnimation()
225 {
226     stopAnimation();
227     m_currentFrame = 0;
228     m_repetitionsComplete = 0;
229     m_animationFinished = false;
230     int frameSize = m_size.width() * m_size.height() * 4;
231     
232     // For extremely large animations, when the animation is reset, we just throw everything away.
233     if (frameCount() * frameSize > cLargeAnimationCutoff)
234         destroyDecodedData();
235 }
236
237 void BitmapImage::advanceAnimation(Timer<BitmapImage>* timer)
238 {
239     // Stop the animation.
240     stopAnimation();
241     
242     // See if anyone is still paying attention to this animation.  If not, we don't
243     // advance and will remain suspended at the current frame until the animation is resumed.
244     if (imageObserver()->shouldPauseAnimation(this))
245         return;
246
247     size_t previousFrame = m_currentFrame++;
248     if (m_currentFrame >= frameCount()) {
249         m_repetitionsComplete += 1;
250         if (m_repetitionCount && m_repetitionsComplete >= m_repetitionCount) {
251             m_animationFinished = true;
252             m_currentFrame--;
253             return;
254         }
255         m_currentFrame = 0;
256     }
257
258     // Notify our observer that the animation has advanced.
259     imageObserver()->animationAdvanced(this);
260
261     // For large animated images, go ahead and throw away frames as we go to save
262     // footprint.
263     int frameSize = m_size.width() * m_size.height() * 4;
264     if (frameCount() * frameSize > cLargeAnimationCutoff) {
265         // Go ahead and decode the next frame so that it can rely on the previous frame.
266         frameAtIndex(m_currentFrame);
267         
268         // Now throw away the previous frame.
269         if (m_frames[previousFrame].m_frame) {
270             m_frames[previousFrame].clear();
271             m_source.destroyFrameAtIndex(previousFrame);
272             m_decodedSize -= frameSize;
273             if (imageObserver())
274                 imageObserver()->decodedSizeChanged(this, -frameSize);
275         }
276     }
277     
278     // Kick off a timer to move to the next frame.
279     m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
280     m_frameTimer->startOneShot(frameDurationAtIndex(m_currentFrame));
281 }
282
283 }