2006-12-27 Eric Seidel <eric@webkit.org>
[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 "ImageAnimationObserver.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 BitmapImage::BitmapImage(ImageAnimationObserver* observer)
41     : Image(observer)
42     , m_currentFrame(0)
43     , m_frames(0)
44     , m_frameTimer(0)
45     , m_repetitionCount(0)
46     , m_repetitionsComplete(0)
47     , m_isSolidColor(false)
48     , m_animatingImageType(true)
49     , m_animationFinished(false)
50     , m_haveSize(false)
51     , m_sizeAvailable(false)
52 {
53     initPlatformData();
54 }
55
56 BitmapImage::~BitmapImage()
57 {
58     invalidateData();
59     stopAnimation();
60 }
61
62 void BitmapImage::invalidateData()
63 {
64     // Destroy the cached images and release them.
65     if (m_frames.size()) {
66         m_frames.last().clear();
67         m_isSolidColor = false;
68         invalidatePlatformData();
69     }
70 }
71
72 void BitmapImage::cacheFrame(size_t index)
73 {
74     size_t numFrames = frameCount();
75     if (!m_frames.size() && shouldAnimate()) {            
76         // Snag the repetition count.
77         m_repetitionCount = m_source.repetitionCount();
78         if (m_repetitionCount == cAnimationNone)
79             m_animatingImageType = false;
80     }
81     
82     if (m_frames.size() < numFrames)
83         m_frames.resize(numFrames);
84
85     m_frames[index].m_frame = m_source.createFrameAtIndex(index);
86     if (m_frames[index].m_frame)
87         checkForSolidColor();
88
89     if (shouldAnimate())
90         m_frames[index].m_duration = m_source.frameDurationAtIndex(index);
91     m_frames[index].m_hasAlpha = m_source.frameHasAlphaAtIndex(index);
92 }
93
94 IntSize BitmapImage::size() const
95 {
96     if (m_sizeAvailable && !m_haveSize) {
97         m_size = m_source.size();
98         m_haveSize = true;
99     }
100     return m_size;
101 }
102
103 bool BitmapImage::setNativeData(NativeBytePtr data, bool allDataReceived)
104 {
105     invalidateData();
106     
107     // Feed all the data we've seen so far to the image decoder.
108     m_source.setData(data, allDataReceived);
109     
110     // Image properties will not be available until the first frame of the file
111     // reaches kCGImageStatusIncomplete.
112     return isSizeAvailable();
113 }
114
115 size_t BitmapImage::frameCount()
116 {
117     return m_source.frameCount();
118 }
119
120 bool BitmapImage::isSizeAvailable()
121 {
122     if (m_sizeAvailable)
123         return true;
124
125     m_sizeAvailable = m_source.isSizeAvailable();
126
127     return m_sizeAvailable;
128 }
129
130 NativeImagePtr BitmapImage::frameAtIndex(size_t index)
131 {
132     if (index >= frameCount())
133         return 0;
134
135     if (index >= m_frames.size() || !m_frames[index].m_frame)
136         cacheFrame(index);
137
138     return m_frames[index].m_frame;
139 }
140
141 float BitmapImage::frameDurationAtIndex(size_t index)
142 {
143     if (index >= frameCount())
144         return 0;
145
146     if (index >= m_frames.size() || !m_frames[index].m_frame)
147         cacheFrame(index);
148
149     return m_frames[index].m_duration;
150 }
151
152 bool BitmapImage::frameHasAlphaAtIndex(size_t index)
153 {
154     if (index >= frameCount())
155         return 0;
156
157     if (index >= m_frames.size() || !m_frames[index].m_frame)
158         cacheFrame(index);
159
160     return m_frames[index].m_hasAlpha;
161 }
162
163 bool BitmapImage::shouldAnimate()
164 {
165     return (m_animatingImageType && !m_animationFinished && animationObserver());
166 }
167
168 void BitmapImage::startAnimation()
169 {
170     if (m_frameTimer || !shouldAnimate() || frameCount() <= 1)
171         return;
172
173     m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
174     m_frameTimer->startOneShot(frameDurationAtIndex(m_currentFrame));
175 }
176
177 void BitmapImage::stopAnimation()
178 {
179     // This timer is used to animate all occurrences of this image.  Don't invalidate
180     // the timer unless all renderers have stopped drawing.
181     delete m_frameTimer;
182     m_frameTimer = 0;
183 }
184
185 void BitmapImage::resetAnimation()
186 {
187     stopAnimation();
188     m_currentFrame = 0;
189     m_repetitionsComplete = 0;
190     m_animationFinished = false;
191 }
192
193
194 void BitmapImage::advanceAnimation(Timer<BitmapImage>* timer)
195 {
196     // Stop the animation.
197     stopAnimation();
198     
199     // See if anyone is still paying attention to this animation.  If not, we don't
200     // advance and will simply pause the animation.
201     if (animationObserver()->shouldStopAnimation(this))
202         return;
203
204     m_currentFrame++;
205     if (m_currentFrame >= frameCount()) {
206         m_repetitionsComplete += 1;
207         if (m_repetitionCount && m_repetitionsComplete >= m_repetitionCount) {
208             m_animationFinished = false;
209             m_currentFrame--;
210             return;
211         }
212         m_currentFrame = 0;
213     }
214
215     // Notify our observer that the animation has advanced.
216     animationObserver()->animationAdvanced(this);
217         
218     // Kick off a timer to move to the next frame.
219     m_frameTimer = new Timer<BitmapImage>(this, &BitmapImage::advanceAnimation);
220     m_frameTimer->startOneShot(frameDurationAtIndex(m_currentFrame));
221 }
222
223 }