[Win][Direct2D] Implement basic SVG support
[WebKit-https.git] / Source / WebCore / platform / graphics / BitmapImage.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  * 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 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 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 #pragma once
29
30 #include "Image.h"
31 #include "Color.h"
32 #include "ImageOrientation.h"
33 #include "ImageSource.h"
34 #include "IntSize.h"
35
36 #if USE(CG) || USE(APPKIT)
37 #include <wtf/RetainPtr.h>
38 #endif
39
40 #if USE(APPKIT)
41 OBJC_CLASS NSImage;
42 #endif
43
44 #if PLATFORM(WIN)
45 typedef struct HBITMAP__ *HBITMAP;
46 #endif
47
48 namespace WebCore {
49
50 class Timer;
51
52 class BitmapImage final : public Image {
53 public:
54     static Ref<BitmapImage> create(NativeImagePtr&& nativeImage, ImageObserver* observer = nullptr)
55     {
56         return adoptRef(*new BitmapImage(WTFMove(nativeImage), observer));
57     }
58     static Ref<BitmapImage> create(ImageObserver* observer = nullptr)
59     {
60         return adoptRef(*new BitmapImage(observer));
61     }
62 #if PLATFORM(WIN)
63     WEBCORE_EXPORT static RefPtr<BitmapImage> create(HBITMAP);
64 #endif
65     virtual ~BitmapImage();
66     
67     bool hasSingleSecurityOrigin() const override { return true; }
68
69     bool dataChanged(bool allDataReceived) override;
70     unsigned decodedSize() const { return m_source.decodedSize(); }
71
72     bool isSizeAvailable() const { return m_source.isSizeAvailable(); }
73     size_t frameCount() const { return m_source.frameCount(); }
74     RepetitionCount repetitionCount() const { return m_source.repetitionCount(); }
75     String filenameExtension() const override { return m_source.filenameExtension(); }
76     Optional<IntPoint> hotSpot() const override { return m_source.hotSpot(); }
77
78     // FloatSize due to override.
79     FloatSize size() const override { return m_source.size(); }
80     IntSize sizeRespectingOrientation() const { return m_source.sizeRespectingOrientation(); }
81     Color singlePixelSolidColor() const override { return m_source.singlePixelSolidColor(); }
82
83     void setAllowSubsampling(bool allowSubsampling) { m_source.setAllowSubsampling(allowSubsampling); }
84
85     bool frameIsCompleteAtIndex(size_t index) const { return m_source.frameIsCompleteAtIndex(index); }
86     bool frameHasAlphaAtIndex(size_t index) const { return m_source.frameHasAlphaAtIndex(index); }
87     bool frameHasInvalidNativeImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel) const { return m_source.frameHasInvalidNativeImageAtIndex(index, subsamplingLevel); }
88     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) const { return m_source.frameSubsamplingLevelAtIndex(index); }
89
90     float frameDurationAtIndex(size_t index) const { return m_source.frameDurationAtIndex(index); }
91     ImageOrientation frameOrientationAtIndex(size_t index) const { return m_source.frameOrientationAtIndex(index); }
92
93     size_t currentFrame() const { return m_currentFrame; }
94     bool currentFrameKnownToBeOpaque() const override { return !frameHasAlphaAtIndex(currentFrame()); }
95     ImageOrientation orientationForCurrentFrame() const override { return frameOrientationAtIndex(currentFrame()); }
96
97     // Accessors for native image formats.
98 #if USE(APPKIT)
99     NSImage *nsImage() override;
100     RetainPtr<NSImage> snapshotNSImage() override;
101 #endif
102
103 #if PLATFORM(COCOA)
104     CFDataRef tiffRepresentation() override;
105 #endif
106
107 #if PLATFORM(WIN)
108     bool getHBITMAP(HBITMAP) override;
109     bool getHBITMAPOfSize(HBITMAP, const IntSize*) override;
110 #endif
111
112 #if PLATFORM(GTK)
113     GdkPixbuf* getGdkPixbuf() override;
114 #endif
115
116 #if PLATFORM(EFL)
117     Evas_Object* getEvasObject(Evas*) override;
118 #endif
119
120     WEBCORE_EXPORT NativeImagePtr nativeImage(const GraphicsContext* = nullptr) override;
121     NativeImagePtr nativeImageForCurrentFrame(const GraphicsContext* = nullptr) override;
122 #if USE(CG)
123     NativeImagePtr nativeImageOfSize(const IntSize&, const GraphicsContext* = nullptr) override;
124     Vector<NativeImagePtr> framesNativeImages() override;
125 #endif
126
127 protected:
128     WEBCORE_EXPORT BitmapImage(NativeImagePtr&&, ImageObserver* = nullptr);
129     WEBCORE_EXPORT BitmapImage(ImageObserver* = nullptr);
130
131     NativeImagePtr frameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default, const GraphicsContext* = nullptr);
132
133     // Called to invalidate cached data. When |destroyAll| is true, we wipe out
134     // the entire frame buffer cache and tell the image source to destroy
135     // everything; this is used when e.g. we want to free some room in the image
136     // cache. If |destroyAll| is false, we only delete frames up to the current
137     // one; this is used while animating large images to keep memory footprint
138     // low without redecoding the whole image on every frame.
139     void destroyDecodedData(bool destroyAll = true) override;
140
141     // If the image is large enough, calls destroyDecodedData() and passes
142     // |destroyAll| along.
143     void destroyDecodedDataIfNecessary(bool destroyAll = true);
144
145     void draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode, ImageOrientationDescription) override;
146     void drawPattern(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, BlendMode = BlendModeNormal) override;
147 #if PLATFORM(WIN)
148     void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) override;
149 #endif
150
151     // Animation.
152     bool isAnimated() const override { return m_source.frameCount() > 1; }
153     bool shouldAnimate();
154     bool canAnimate();
155     void startAnimation(CatchUpAnimation = CatchUp) override;
156     void advanceAnimation();
157
158     // Function that does the real work of advancing the animation. When
159     // skippingFrames is true, we're in the middle of a loop trying to skip over
160     // a bunch of animation frames, so we should not do things like decode each
161     // one or notify our observers.
162     // Returns whether the animation was advanced.
163     enum AnimationAdvancement { Normal, SkippingFramesToCatchUp };
164     bool internalAdvanceAnimation(AnimationAdvancement = Normal);
165
166     // It may look unusual that there is no start animation call as public API. This is because
167     // we start and stop animating lazily. Animation begins whenever someone draws the image. It will
168     // automatically pause once all observers no longer want to render the image anywhere.
169     void stopAnimation() override;
170     void resetAnimation() override;
171
172     // Handle platform-specific data
173     void invalidatePlatformData();
174
175 #if !ASSERT_DISABLED
176     bool notSolidColor() override;
177 #endif
178
179 #if PLATFORM(COCOA)
180     RetainPtr<CFDataRef> tiffRepresentation(const Vector<NativeImagePtr>&);
181 #endif
182
183 private:
184     void clearTimer();
185     void startTimer(double delay);
186     bool isBitmapImage() const override { return true; }
187     void dump(TextStream&) const override;
188
189     mutable ImageSource m_source;
190
191     size_t m_currentFrame { 0 }; // The index of the current frame of animation.
192     std::unique_ptr<Timer> m_frameTimer;
193     RepetitionCount m_repetitionsComplete { RepetitionCountNone }; // How many repetitions we've finished.
194     double m_desiredFrameStartTime { 0 }; // The system time at which we hope to see the next call to startAnimation().
195     bool m_animationFinished { false };
196     bool m_animationFinishedWhenCatchingUp { false };
197
198 #if USE(APPKIT)
199     mutable RetainPtr<NSImage> m_nsImage; // A cached NSImage of all the frames. Only built lazily if someone actually queries for one.
200 #endif
201 #if USE(CG)
202     mutable RetainPtr<CFDataRef> m_tiffRep; // Cached TIFF rep for all the frames. Only built lazily if someone queries for one.
203 #endif
204     RefPtr<Image> m_cachedImage;
205 };
206
207 } // namespace WebCore
208
209 SPECIALIZE_TYPE_TRAITS_IMAGE(BitmapImage)