1 /* 2 * Copyright (C) 2006 Samuel Weinig (sam.weinig@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 "platform/geometry/IntSize.h" 32 #include "platform/graphics/Color.h" 33 #include "platform/graphics/FrameData.h" 34 #include "platform/graphics/Image.h" 35 #include "platform/graphics/ImageOrientation.h" 36 #include "platform/graphics/ImageSource.h" 37 #include "wtf/Forward.h" 38 39 namespace WebCore { 40 41 class NativeImageSkia; 42 template <typename T> class Timer; 43 44 class PLATFORM_EXPORT BitmapImage : public Image { 45 friend class GeneratedImage; 46 friend class CrossfadeGeneratedImage; 47 friend class GradientGeneratedImage; 48 friend class GraphicsContext; 49 public: 50 static PassRefPtr<BitmapImage> create(PassRefPtr<NativeImageSkia> nativeImage, ImageObserver* observer = 0) 51 { 52 return adoptRef(new BitmapImage(nativeImage, observer)); 53 } 54 static PassRefPtr<BitmapImage> create(ImageObserver* observer = 0) 55 { 56 return adoptRef(new BitmapImage(observer)); 57 } 58 virtual ~BitmapImage(); 59 60 virtual bool isBitmapImage() const OVERRIDE; 61 currentFrameHasSingleSecurityOrigin()62 virtual bool currentFrameHasSingleSecurityOrigin() const OVERRIDE { return true; }; 63 64 virtual IntSize size() const OVERRIDE; 65 IntSize sizeRespectingOrientation() const; 66 IntSize currentFrameSize() const; 67 virtual bool getHotSpot(IntPoint&) const OVERRIDE; 68 69 virtual bool dataChanged(bool allDataReceived) OVERRIDE; 70 virtual String filenameExtension() const OVERRIDE; 71 72 // It may look unusual that there is no start animation call as public API. This is because 73 // we start and stop animating lazily. Animation begins whenever someone draws the image. It will 74 // automatically pause once all observers no longer want to render the image anywhere. 75 virtual void stopAnimation() OVERRIDE; 76 virtual void resetAnimation() OVERRIDE; 77 78 virtual PassRefPtr<NativeImageSkia> nativeImageForCurrentFrame() OVERRIDE; 79 virtual bool currentFrameKnownToBeOpaque() OVERRIDE; 80 81 ImageOrientation currentFrameOrientation(); 82 83 #if !ASSERT_DISABLED 84 virtual bool notSolidColor() OVERRIDE; 85 #endif 86 87 private: 88 friend class BitmapImageTest; 89 90 void updateSize() const; 91 92 protected: 93 enum RepetitionCountStatus { 94 Unknown, // We haven't checked the source's repetition count. 95 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). 96 Certain // The repetition count is known to be correct. 97 }; 98 99 BitmapImage(PassRefPtr<NativeImageSkia>, ImageObserver* = 0); 100 BitmapImage(ImageObserver* = 0); 101 102 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, blink::WebBlendMode) OVERRIDE; 103 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, blink::WebBlendMode, RespectImageOrientationEnum) OVERRIDE; 104 currentFrame()105 size_t currentFrame() const { return m_currentFrame; } 106 size_t frameCount(); 107 PassRefPtr<NativeImageSkia> frameAtIndex(size_t); 108 bool frameIsCompleteAtIndex(size_t); 109 float frameDurationAtIndex(size_t); 110 bool frameHasAlphaAtIndex(size_t); 111 ImageOrientation frameOrientationAtIndex(size_t); 112 113 // Decodes and caches a frame. Never accessed except internally. 114 void cacheFrame(size_t index); 115 // Called before accessing m_frames[index]. Returns false on index out of bounds. 116 bool ensureFrameIsCached(size_t index); 117 118 // Called to invalidate cached data. When |destroyAll| is true, we wipe out 119 // the entire frame buffer cache and tell the image source to destroy 120 // everything; this is used when e.g. we want to free some room in the image 121 // cache. If |destroyAll| is false, we delete frames except the current 122 // frame; this is used while animating large images to keep memory footprint 123 // low; the decoder should preserve the current frame and may preserve some 124 // other frames to avoid redecoding the whole image on every frame. 125 virtual void destroyDecodedData(bool destroyAll) OVERRIDE; 126 127 // If the image is large enough, calls destroyDecodedData(). 128 void destroyDecodedDataIfNecessary(); 129 130 // Generally called by destroyDecodedData(), destroys whole-image metadata 131 // and notifies observers that the memory footprint has (hopefully) 132 // decreased by |frameBytesCleared|. 133 void destroyMetadataAndNotify(size_t frameBytesCleared); 134 135 // Whether or not size is available yet. 136 bool isSizeAvailable(); 137 138 // Animation. 139 int repetitionCount(bool imageKnownToBeComplete); // |imageKnownToBeComplete| should be set if the caller knows the entire image has been decoded. 140 bool shouldAnimate(); 141 virtual void startAnimation(bool catchUpIfNecessary = true) OVERRIDE; 142 void advanceAnimation(Timer<BitmapImage>*); 143 144 // Function that does the real work of advancing the animation. When 145 // skippingFrames is true, we're in the middle of a loop trying to skip over 146 // a bunch of animation frames, so we should not do things like decode each 147 // one or notify our observers. 148 // Returns whether the animation was advanced. 149 bool internalAdvanceAnimation(bool skippingFrames); 150 151 // Checks to see if the image is a 1x1 solid color. We optimize these images and just do a fill rect instead. 152 // This check should happen regardless whether m_checkedForSolidColor is already set, as the frame may have 153 // changed. 154 void checkForSolidColor(); 155 156 virtual bool mayFillWithSolidColor(); 157 virtual Color solidColor() const; 158 159 ImageSource m_source; 160 mutable IntSize m_size; // The size to use for the overall image (will just be the size of the first image). 161 mutable IntSize m_sizeRespectingOrientation; 162 163 size_t m_currentFrame; // The index of the current frame of animation. 164 Vector<FrameData, 1> m_frames; // An array of the cached frames of the animation. We have to ref frames to pin them in the cache. 165 166 Timer<BitmapImage>* m_frameTimer; 167 int m_repetitionCount; // How many total animation loops we should do. This will be cAnimationNone if this image type is incapable of animation. 168 RepetitionCountStatus m_repetitionCountStatus; 169 int m_repetitionsComplete; // How many repetitions we've finished. 170 double m_desiredFrameStartTime; // The system time at which we hope to see the next call to startAnimation(). 171 172 Color m_solidColor; // If we're a 1x1 solid color, this is the color to use to fill. 173 174 size_t m_frameCount; 175 176 bool m_isSolidColor : 1; // Whether or not we are a 1x1 solid image. 177 bool m_checkedForSolidColor : 1; // Whether we've checked the frame for solid color. 178 179 bool m_animationFinished : 1; // Whether or not we've completed the entire animation. 180 181 bool m_allDataReceived : 1; // Whether or not we've received all our data. 182 mutable bool m_haveSize : 1; // Whether or not our |m_size| member variable has the final overall image size yet. 183 bool m_sizeAvailable : 1; // Whether or not we can obtain the size of the first image frame yet from ImageIO. 184 mutable bool m_hasUniformFrameSize : 1; 185 mutable bool m_haveFrameCount : 1; 186 }; 187 188 DEFINE_IMAGE_TYPE_CASTS(BitmapImage); 189 190 } 191 192 #endif 193