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 * 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 "core/platform/graphics/Color.h" 31 #include "core/platform/graphics/GraphicsTypes.h" 32 #include "core/platform/graphics/ImageOrientation.h" 33 #include "core/platform/graphics/IntRect.h" 34 #include "core/platform/graphics/skia/NativeImageSkia.h" 35 #include "third_party/skia/include/core/SkXfermode.h" 36 #include "wtf/PassRefPtr.h" 37 #include "wtf/RefCounted.h" 38 #include "wtf/RefPtr.h" 39 #include "wtf/RetainPtr.h" 40 #include "wtf/text/WTFString.h" 41 42 namespace WebCore { 43 44 class FloatPoint; 45 class FloatRect; 46 class FloatSize; 47 class GraphicsContext; 48 class SharedBuffer; 49 struct Length; 50 51 // This class gets notified when an image creates or destroys decoded frames and when it advances animation frames. 52 class ImageObserver; 53 54 class Image : public RefCounted<Image> { 55 friend class GeneratedImage; 56 friend class CrossfadeGeneratedImage; 57 friend class GeneratorGeneratedImage; 58 friend class GraphicsContext; 59 60 public: 61 virtual ~Image(); 62 63 static PassRefPtr<Image> loadPlatformResource(const char* name); 64 static bool supportsType(const String&); 65 66 virtual bool isSVGImage() const { return false; } 67 virtual bool isBitmapImage() const { return false; } 68 virtual bool currentFrameKnownToBeOpaque() = 0; 69 70 // Derived classes should override this if they can assure that 71 // the image contains only resources from its own security origin. 72 virtual bool hasSingleSecurityOrigin() const { return false; } 73 74 static Image* nullImage(); 75 bool isNull() const { return size().isEmpty(); } 76 77 virtual void setContainerSize(const IntSize&) { } 78 virtual bool usesContainerSize() const { return false; } 79 virtual bool hasRelativeWidth() const { return false; } 80 virtual bool hasRelativeHeight() const { return false; } 81 virtual void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio); 82 83 virtual IntSize size() const = 0; 84 IntRect rect() const { return IntRect(IntPoint(), size()); } 85 int width() const { return size().width(); } 86 int height() const { return size().height(); } 87 virtual bool getHotSpot(IntPoint&) const { return false; } 88 89 bool setData(PassRefPtr<SharedBuffer> data, bool allDataReceived); 90 virtual bool dataChanged(bool /*allDataReceived*/) { return false; } 91 92 virtual String filenameExtension() const { return String(); } // null string if unknown 93 94 virtual void destroyDecodedData(bool destroyAll) = 0; 95 virtual unsigned decodedSize() const = 0; 96 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 virtual void startAnimation(bool /*catchUpIfNecessary*/ = true) { } 102 virtual void stopAnimation() {} 103 virtual void resetAnimation() {} 104 105 // Typically the ImageResource that owns us. 106 ImageObserver* imageObserver() const { return m_imageObserver; } 107 void setImageObserver(ImageObserver* observer) { m_imageObserver = observer; } 108 109 enum TileRule { StretchTile, RoundTile, SpaceTile, RepeatTile }; 110 111 virtual PassRefPtr<NativeImageSkia> nativeImageForCurrentFrame() { return 0; } 112 113 virtual void drawPattern(GraphicsContext*, const FloatRect&, 114 const FloatSize&, const FloatPoint& phase, CompositeOperator, 115 const FloatRect&, BlendMode = BlendModeNormal); 116 117 #if !ASSERT_DISABLED 118 virtual bool notSolidColor() { return true; } 119 #endif 120 121 protected: 122 Image(ImageObserver* = 0); 123 124 static void fillWithSolidColor(GraphicsContext*, const FloatRect& dstRect, const Color&, CompositeOperator); 125 static FloatRect adjustForNegativeSize(const FloatRect&); // A helper method for translating negative width and height values. 126 127 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode) = 0; 128 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode, RespectImageOrientationEnum); 129 void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, 130 CompositeOperator, BlendMode); 131 void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, CompositeOperator); 132 133 // Supporting tiled drawing 134 virtual bool mayFillWithSolidColor() { return false; } 135 virtual Color solidColor() const { return Color(); } 136 137 private: 138 RefPtr<SharedBuffer> m_encodedImageData; 139 ImageObserver* m_imageObserver; 140 }; 141 142 } 143 144 #endif 145