Host GraphicsContext's CTM inside GraphicsContextState
[WebKit-https.git] / Source / WebCore / platform / graphics / Image.h
1 /*
2  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
3  * Copyright (C) 2004, 2005, 2006, 2013 Apple 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 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 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 "Color.h"
31 #include "ColorSpace.h"
32 #include "FloatRect.h"
33 #include "FloatSize.h"
34 #include "GraphicsTypes.h"
35 #include "ImageOrientation.h"
36 #include "NativeImagePtr.h"
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefCounted.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/RetainPtr.h>
41 #include <wtf/TypeCasts.h>
42 #include <wtf/text/WTFString.h>
43
44 #if USE(APPKIT)
45 OBJC_CLASS NSImage;
46 #endif
47
48 #if USE(CG)
49 struct CGContext;
50 #endif
51
52 #if PLATFORM(WIN)
53 typedef struct tagSIZE SIZE;
54 typedef SIZE* LPSIZE;
55 typedef struct HBITMAP__ *HBITMAP;
56 #endif
57
58 #if PLATFORM(GTK)
59 typedef struct _GdkPixbuf GdkPixbuf;
60 #endif
61
62 namespace WebCore {
63
64 class AffineTransform;
65 class FloatPoint;
66 class FloatSize;
67 class GraphicsContext;
68 class SharedBuffer;
69 struct Length;
70
71 // This class gets notified when an image creates or destroys decoded frames and when it advances animation frames.
72 class ImageObserver;
73
74 class Image : public RefCounted<Image> {
75     friend class GraphicsContext;
76 public:
77     virtual ~Image();
78     
79     static PassRefPtr<Image> create(ImageObserver* = nullptr);
80     WEBCORE_EXPORT static PassRefPtr<Image> loadPlatformResource(const char* name);
81     WEBCORE_EXPORT static bool supportsType(const String&);
82
83     virtual bool isSVGImage() const { return false; }
84     virtual bool isBitmapImage() const { return false; }
85     virtual bool isPDFDocumentImage() const { return false; }
86     virtual bool currentFrameKnownToBeOpaque() = 0;
87
88     virtual bool isAnimated() { return false; }
89
90     // Derived classes should override this if they can assure that 
91     // the image contains only resources from its own security origin.
92     virtual bool hasSingleSecurityOrigin() const { return false; }
93
94     WEBCORE_EXPORT static Image* nullImage();
95     bool isNull() const { return size().isEmpty(); }
96
97     virtual void setContainerSize(const FloatSize&) { }
98     virtual bool usesContainerSize() const { return false; }
99     virtual bool hasRelativeWidth() const { return false; }
100     virtual bool hasRelativeHeight() const { return false; }
101     virtual void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio);
102
103     virtual FloatSize size() const = 0;
104     FloatRect rect() const { return FloatRect(FloatPoint(), size()); }
105     float width() const { return size().width(); }
106     float height() const { return size().height(); }
107     virtual bool getHotSpot(IntPoint&) const { return false; }
108
109 #if PLATFORM(IOS)
110     virtual FloatSize originalSize() const { return size(); }
111 #endif
112
113     WEBCORE_EXPORT bool setData(PassRefPtr<SharedBuffer> data, bool allDataReceived);
114     virtual bool dataChanged(bool /*allDataReceived*/) { return false; }
115     
116     virtual String filenameExtension() const { return String(); } // null string if unknown
117
118     virtual void destroyDecodedData(bool destroyAll = true) = 0;
119     virtual bool decodedDataIsPurgeable() const { return false; }
120
121     SharedBuffer* data() { return m_encodedImageData.get(); }
122
123     // Animation begins whenever someone draws the image, so startAnimation() is not normally called.
124     // It will automatically pause once all observers no longer want to render the image anywhere.
125     enum CatchUpAnimation { DoNotCatchUp, CatchUp };
126     virtual void startAnimation(CatchUpAnimation = CatchUp) { }
127     virtual void stopAnimation() {}
128     virtual void resetAnimation() {}
129     
130     // Typically the CachedImage that owns us.
131     ImageObserver* imageObserver() const { return m_imageObserver; }
132     void setImageObserver(ImageObserver* observer) { m_imageObserver = observer; }
133
134     enum TileRule { StretchTile, RoundTile, SpaceTile, RepeatTile };
135
136     virtual PassNativeImagePtr nativeImageForCurrentFrame() { return nullptr; }
137     virtual ImageOrientation orientationForCurrentFrame() { return ImageOrientation(); }
138
139     // Accessors for native image formats.
140
141 #if USE(APPKIT)
142     virtual NSImage* getNSImage() { return 0; }
143 #endif
144
145 #if PLATFORM(COCOA)
146     virtual CFDataRef getTIFFRepresentation() { return 0; }
147 #endif
148
149 #if USE(CG)
150     virtual CGImageRef getCGImageRef() { return 0; }
151     virtual CGImageRef getFirstCGImageRefOfSize(const IntSize&) { return 0; }
152     virtual RetainPtr<CFArrayRef> getCGImageArray() { return 0; }
153     static RetainPtr<CGImageRef> imageWithColorSpace(CGImageRef originalImage, ColorSpace);
154 #endif
155
156 #if PLATFORM(WIN)
157     virtual bool getHBITMAP(HBITMAP) { return false; }
158     virtual bool getHBITMAPOfSize(HBITMAP, const IntSize*) { return false; }
159 #endif
160
161 #if PLATFORM(GTK)
162     virtual GdkPixbuf* getGdkPixbuf() { return 0; }
163 #endif
164
165 #if PLATFORM(EFL)
166     virtual Evas_Object* getEvasObject(Evas*) { return 0; }
167 #endif
168
169     virtual void drawPattern(GraphicsContext&, const FloatRect& srcRect, const AffineTransform& patternTransform,
170         const FloatPoint& phase, const FloatSize& spacing, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect, BlendMode = BlendModeNormal);
171
172 #if ENABLE(IMAGE_DECODER_DOWN_SAMPLING)
173     FloatRect adjustSourceRectForDownSampling(const FloatRect& srcRect, const IntSize& scaledSize) const;
174 #endif
175
176 #if !ASSERT_DISABLED
177     virtual bool notSolidColor() { return true; }
178 #endif
179
180 protected:
181     Image(ImageObserver* = nullptr);
182
183     static void fillWithSolidColor(GraphicsContext&, const FloatRect& dstRect, const Color&, ColorSpace styleColorSpace, CompositeOperator);
184
185     // The ColorSpace parameter will only be used for untagged images.
186 #if PLATFORM(WIN)
187     virtual void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, ColorSpace styleColorSpace, CompositeOperator) { }
188 #endif
189     virtual void draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator, BlendMode, ImageOrientationDescription);
190     void drawTiled(GraphicsContext&, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, const FloatSize& spacing, ColorSpace styleColorSpace,
191         CompositeOperator , BlendMode);
192     void drawTiled(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, ColorSpace styleColorSpace, CompositeOperator);
193
194     // Supporting tiled drawing
195     virtual bool mayFillWithSolidColor() { return false; }
196     virtual Color solidColor() const { return Color(); }
197     
198 private:
199     RefPtr<SharedBuffer> m_encodedImageData;
200     ImageObserver* m_imageObserver;
201 };
202
203 } // namespace WebCore
204
205 #define SPECIALIZE_TYPE_TRAITS_IMAGE(ToClassName) \
206 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
207     static bool isType(const WebCore::Image& image) { return image.is##ToClassName(); } \
208 SPECIALIZE_TYPE_TRAITS_END()
209
210 #endif // Image_h