1 /* 2 * Copyright (C) 2006 Samuel Weinig (sam.weinig (at) gmail.com) 3 * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc. All rights reserved. 4 * Copyright (C) 2008-2009 Torch Mobile, Inc. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY 16 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR 19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 22 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 23 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef BitmapImage_h 29 #define BitmapImage_h 30 31 #include "Image.h" 32 #include "Color.h" 33 #include "IntSize.h" 34 35 #if PLATFORM(MAC) 36 #include <wtf/RetainPtr.h> 37 #ifdef __OBJC__ 38 @class NSImage; 39 #else 40 class NSImage; 41 #endif 42 #endif 43 44 #if PLATFORM(WIN) 45 typedef struct HBITMAP__ *HBITMAP; 46 #endif 47 48 #if PLATFORM(HAIKU) 49 class BBitmap; 50 #endif 51 52 namespace WebCore { 53 struct FrameData; 54 } 55 56 namespace WTF { 57 // FIXME: This declaration gives FrameData a default constructor that zeroes 58 // all its data members, even though FrameData's default constructor defined 59 // below does not zero all its data members. One of these must be wrong! 60 template<> struct VectorTraits<WebCore::FrameData> : public SimpleClassVectorTraits { }; 61 } 62 63 namespace WebCore { 64 65 template <typename T> class Timer; 66 67 // ================================================ 68 // FrameData Class 69 // ================================================ 70 71 struct FrameData { 72 WTF_MAKE_NONCOPYABLE(FrameData); 73 public: 74 FrameData() 75 : m_frame(0) 76 , m_haveMetadata(false) 77 , m_isComplete(false) 78 , m_duration(0) 79 , m_hasAlpha(true) 80 { 81 } 82 83 ~FrameData() 84 { 85 clear(true); 86 } 87 88 // Clear the cached image data on the frame, and (optionally) the metadata. 89 // Returns whether there was cached image data to clear. 90 bool clear(bool clearMetadata); 91 92 NativeImagePtr m_frame; 93 bool m_haveMetadata; 94 bool m_isComplete; 95 float m_duration; 96 bool m_hasAlpha; 97 }; 98 99 // ================================================= 100 // BitmapImage Class 101 // ================================================= 102 103 class BitmapImage : public Image { 104 friend class GeneratedImage; 105 friend class GraphicsContext; 106 public: 107 static PassRefPtr<BitmapImage> create(NativeImagePtr nativeImage, ImageObserver* observer = 0) 108 { 109 return adoptRef(new BitmapImage(nativeImage, observer)); 110 } 111 static PassRefPtr<BitmapImage> create(ImageObserver* observer = 0) 112 { 113 return adoptRef(new BitmapImage(observer)); 114 } 115 ~BitmapImage(); 116 117 virtual bool isBitmapImage() const { return true; } 118 119 virtual bool hasSingleSecurityOrigin() const { return true; } 120 121 virtual IntSize size() const; 122 IntSize currentFrameSize() const; 123 virtual bool getHotSpot(IntPoint&) const; 124 125 virtual bool dataChanged(bool allDataReceived); 126 virtual String filenameExtension() const; 127 128 // It may look unusual that there is no start animation call as public API. This is because 129 // we start and stop animating lazily. Animation begins whenever someone draws the image. It will 130 // automatically pause once all observers no longer want to render the image anywhere. 131 virtual void stopAnimation(); 132 virtual void resetAnimation(); 133 134 virtual unsigned decodedSize() const { return m_decodedSize; } 135 136 #if PLATFORM(MAC) 137 // Accessors for native image formats. 138 virtual NSImage* getNSImage(); 139 virtual CFDataRef getTIFFRepresentation(); 140 #endif 141 142 #if USE(CG) 143 virtual CGImageRef getCGImageRef(); 144 virtual CGImageRef getFirstCGImageRefOfSize(const IntSize&); 145 #endif 146 147 #if PLATFORM(WIN) || (PLATFORM(QT) && OS(WINDOWS)) 148 static PassRefPtr<BitmapImage> create(HBITMAP); 149 #endif 150 #if PLATFORM(WIN) 151 virtual bool getHBITMAP(HBITMAP); 152 virtual bool getHBITMAPOfSize(HBITMAP, LPSIZE); 153 #endif 154 155 #if PLATFORM(ANDROID) 156 virtual void setURL(const String& str); 157 #endif 158 159 #if PLATFORM(GTK) 160 virtual GdkPixbuf* getGdkPixbuf(); 161 #endif 162 163 virtual NativeImagePtr nativeImageForCurrentFrame() { return frameAtIndex(currentFrame()); } 164 bool frameHasAlphaAtIndex(size_t); 165 166 #if !ASSERT_DISABLED 167 bool notSolidColor() 168 { 169 return size().width() != 1 || size().height() != 1 || frameCount() > 1; 170 } 171 #endif 172 173 protected: 174 enum RepetitionCountStatus { 175 Unknown, // We haven't checked the source's repetition count. 176 Uncertain, // We have a repetition count, but it might be wrong (some GIFs have a count after the image data, and will report "loop once" until all data has been decoded). 177 Certain // The repetition count is known to be correct. 178 }; 179 180 BitmapImage(NativeImagePtr, ImageObserver* = 0); 181 BitmapImage(ImageObserver* = 0); 182 183 #if PLATFORM(WIN) 184 virtual void drawFrameMatchingSourceSize(GraphicsContext*, const FloatRect& dstRect, const IntSize& srcSize, ColorSpace styleColorSpace, CompositeOperator); 185 #endif 186 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator); 187 188 #if (OS(WINCE) && !PLATFORM(QT)) 189 virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform, 190 const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect); 191 #endif 192 193 #if PLATFORM(HAIKU) 194 virtual BBitmap* getBBitmap() const; 195 #endif 196 197 size_t currentFrame() const { return m_currentFrame; } 198 size_t frameCount(); 199 NativeImagePtr frameAtIndex(size_t); 200 bool frameIsCompleteAtIndex(size_t); 201 float frameDurationAtIndex(size_t); 202 203 // Decodes and caches a frame. Never accessed except internally. 204 void cacheFrame(size_t index); 205 206 // Called to invalidate cached data. When |destroyAll| is true, we wipe out 207 // the entire frame buffer cache and tell the image source to destroy 208 // everything; this is used when e.g. we want to free some room in the image 209 // cache. If |destroyAll| is false, we only delete frames up to the current 210 // one; this is used while animating large images to keep memory footprint 211 // low without redecoding the whole image on every frame. 212 virtual void destroyDecodedData(bool destroyAll = true); 213 214 // If the image is large enough, calls destroyDecodedData() and passes 215 // |destroyAll| along. 216 void destroyDecodedDataIfNecessary(bool destroyAll); 217 218 // Generally called by destroyDecodedData(), destroys whole-image metadata 219 // and notifies observers that the memory footprint has (hopefully) 220 // decreased by |framesCleared| times the size (in bytes) of a frame. 221 void destroyMetadataAndNotify(int framesCleared); 222 223 // Whether or not size is available yet. 224 bool isSizeAvailable(); 225 226 // Called after asking the source for any information that may require 227 // decoding part of the image (e.g., the image size). We need to report 228 // the partially decoded data to our observer so it has an accurate 229 // account of the BitmapImage's memory usage. 230 void didDecodeProperties() const; 231 232 // Animation. 233 int repetitionCount(bool imageKnownToBeComplete); // |imageKnownToBeComplete| should be set if the caller knows the entire image has been decoded. 234 bool shouldAnimate(); 235 virtual void startAnimation(bool catchUpIfNecessary = true); 236 void advanceAnimation(Timer<BitmapImage>*); 237 238 // Function that does the real work of advancing the animation. When 239 // skippingFrames is true, we're in the middle of a loop trying to skip over 240 // a bunch of animation frames, so we should not do things like decode each 241 // one or notify our observers. 242 // Returns whether the animation was advanced. 243 bool internalAdvanceAnimation(bool skippingFrames); 244 245 // Handle platform-specific data 246 void initPlatformData(); 247 void invalidatePlatformData(); 248 249 // Checks to see if the image is a 1x1 solid color. We optimize these images and just do a fill rect instead. 250 // This check should happen regardless whether m_checkedForSolidColor is already set, as the frame may have 251 // changed. 252 void checkForSolidColor(); 253 254 virtual bool mayFillWithSolidColor() 255 { 256 if (!m_checkedForSolidColor && frameCount() > 0) { 257 checkForSolidColor(); 258 // WINCE PORT: checkForSolidColor() doesn't set m_checkedForSolidColor until 259 // it gets enough information to make final decision. 260 #if !OS(WINCE) 261 ASSERT(m_checkedForSolidColor); 262 #endif 263 } 264 return m_isSolidColor && m_currentFrame == 0; 265 } 266 virtual Color solidColor() const { return m_solidColor; } 267 268 ImageSource m_source; 269 mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image). 270 271 size_t m_currentFrame; // The index of the current frame of animation. 272 Vector<FrameData> m_frames; // An array of the cached frames of the animation. We have to ref frames to pin them in the cache. 273 274 Timer<BitmapImage>* m_frameTimer; 275 int m_repetitionCount; // How many total animation loops we should do. This will be cAnimationNone if this image type is incapable of animation. 276 RepetitionCountStatus m_repetitionCountStatus; 277 int m_repetitionsComplete; // How many repetitions we've finished. 278 double m_desiredFrameStartTime; // The system time at which we hope to see the next call to startAnimation(). 279 280 #if PLATFORM(MAC) 281 mutable RetainPtr<NSImage> m_nsImage; // A cached NSImage of frame 0. Only built lazily if someone actually queries for one. 282 mutable RetainPtr<CFDataRef> m_tiffRep; // Cached TIFF rep for frame 0. Only built lazily if someone queries for one. 283 #endif 284 285 Color m_solidColor; // If we're a 1x1 solid color, this is the color to use to fill. 286 bool m_isSolidColor; // Whether or not we are a 1x1 solid image. 287 bool m_checkedForSolidColor; // Whether we've checked the frame for solid color. 288 289 bool m_animationFinished; // Whether or not we've completed the entire animation. 290 291 bool m_allDataReceived; // Whether or not we've received all our data. 292 293 mutable bool m_haveSize; // Whether or not our |m_size| member variable has the final overall image size yet. 294 bool m_sizeAvailable; // Whether or not we can obtain the size of the first image frame yet from ImageIO. 295 mutable bool m_hasUniformFrameSize; 296 297 unsigned m_decodedSize; // The current size of all decoded frames. 298 mutable unsigned m_decodedPropertiesSize; // The size of data decoded by the source to determine image properties (e.g. size, frame count, etc). 299 300 mutable bool m_haveFrameCount; 301 size_t m_frameCount; 302 }; 303 304 } 305 306 #endif 307
