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 #ifndef Image_h 28 #define Image_h 29 30 #include "platform/PlatformExport.h" 31 #include "platform/geometry/IntRect.h" 32 #include "platform/graphics/Color.h" 33 #include "platform/graphics/GraphicsTypes.h" 34 #include "platform/graphics/ImageOrientation.h" 35 #include "platform/graphics/skia/NativeImageSkia.h" 36 #include "third_party/skia/include/core/SkXfermode.h" 37 #include "wtf/PassRefPtr.h" 38 #include "wtf/RefCounted.h" 39 #include "wtf/RefPtr.h" 40 #include "wtf/RetainPtr.h" 41 #include "wtf/text/WTFString.h" 42 43 namespace WebCore { 44 45 class FloatPoint; 46 class FloatRect; 47 class FloatSize; 48 class GraphicsContext; 49 class Length; 50 class SharedBuffer; 51 52 // This class gets notified when an image creates or destroys decoded frames and when it advances animation frames. 53 class ImageObserver; 54 55 class PLATFORM_EXPORT Image : public RefCounted<Image> { 56 friend class GeneratedImage; 57 friend class CrossfadeGeneratedImage; 58 friend class GradientGeneratedImage; 59 friend class GraphicsContext; 60 61 public: 62 virtual ~Image(); 63 64 static PassRefPtr<Image> loadPlatformResource(const char* name); 65 static bool supportsType(const String&); 66 isSVGImage()67 virtual bool isSVGImage() const { return false; } isBitmapImage()68 virtual bool isBitmapImage() const { return false; } 69 virtual bool currentFrameKnownToBeOpaque() = 0; 70 71 // Derived classes should override this if they can assure that the current 72 // image frame contains only resources from its own security origin. currentFrameHasSingleSecurityOrigin()73 virtual bool currentFrameHasSingleSecurityOrigin() const { return false; } 74 75 static Image* nullImage(); isNull()76 bool isNull() const { return size().isEmpty(); } 77 setContainerSize(const IntSize &)78 virtual void setContainerSize(const IntSize&) { } usesContainerSize()79 virtual bool usesContainerSize() const { return false; } hasRelativeWidth()80 virtual bool hasRelativeWidth() const { return false; } hasRelativeHeight()81 virtual bool hasRelativeHeight() const { return false; } 82 virtual void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio); 83 84 virtual IntSize size() const = 0; rect()85 IntRect rect() const { return IntRect(IntPoint(), size()); } width()86 int width() const { return size().width(); } height()87 int height() const { return size().height(); } getHotSpot(IntPoint &)88 virtual bool getHotSpot(IntPoint&) const { return false; } 89 90 bool setData(PassRefPtr<SharedBuffer> data, bool allDataReceived); dataChanged(bool)91 virtual bool dataChanged(bool /*allDataReceived*/) { return false; } 92 filenameExtension()93 virtual String filenameExtension() const { return String(); } // null string if unknown 94 95 virtual void destroyDecodedData(bool destroyAll) = 0; 96 data()97 SharedBuffer* data() { return m_encodedImageData.get(); } 98 99 // Animation begins whenever someone draws the image, so startAnimation() is not normally called. 100 // It will automatically pause once all observers no longer want to render the image anywhere. 101 enum CatchUpAnimation { DoNotCatchUp, CatchUp }; 102 virtual void startAnimation(CatchUpAnimation = CatchUp) { } stopAnimation()103 virtual void stopAnimation() {} resetAnimation()104 virtual void resetAnimation() {} 105 106 // True if this image can potentially animate. maybeAnimated()107 virtual bool maybeAnimated() { return false; } 108 109 // Typically the ImageResource that owns us. imageObserver()110 ImageObserver* imageObserver() const { return m_imageObserver; } setImageObserver(ImageObserver * observer)111 void setImageObserver(ImageObserver* observer) { m_imageObserver = observer; } 112 113 enum TileRule { StretchTile, RoundTile, SpaceTile, RepeatTile }; 114 nativeImageForCurrentFrame()115 virtual PassRefPtr<NativeImageSkia> nativeImageForCurrentFrame() { return nullptr; } 116 117 virtual void drawPattern(GraphicsContext*, const FloatRect&, 118 const FloatSize&, const FloatPoint& phase, CompositeOperator, 119 const FloatRect&, blink::WebBlendMode = blink::WebBlendModeNormal, const IntSize& repeatSpacing = IntSize()); 120 121 #if ASSERT_ENABLED notSolidColor()122 virtual bool notSolidColor() { return true; } 123 #endif 124 125 protected: 126 Image(ImageObserver* = 0); 127 128 static void fillWithSolidColor(GraphicsContext*, const FloatRect& dstRect, const Color&, CompositeOperator); 129 static FloatRect adjustForNegativeSize(const FloatRect&); // A helper method for translating negative width and height values. 130 131 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, blink::WebBlendMode) = 0; 132 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, blink::WebBlendMode, RespectImageOrientationEnum); 133 void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, 134 CompositeOperator, blink::WebBlendMode, const IntSize& repeatSpacing); 135 void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, CompositeOperator); 136 137 // Supporting tiled drawing mayFillWithSolidColor()138 virtual bool mayFillWithSolidColor() { return false; } solidColor()139 virtual Color solidColor() const { return Color(); } 140 141 private: 142 RefPtr<SharedBuffer> m_encodedImageData; 143 ImageObserver* m_imageObserver; 144 }; 145 146 #define DEFINE_IMAGE_TYPE_CASTS(typeName) \ 147 DEFINE_TYPE_CASTS(typeName, Image, image, image->is##typeName(), image.is##typeName()) 148 149 } 150 151 #endif 152