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