45eee2dc951c76a5a7a34df4b767d035054ddb25
[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 "ImageObserver.h"
33 #include "ImageOrientation.h"
34 #include "ImageSource.h"
35 #include "IntSize.h"
36 #include "URL.h"
37
38 #if USE(CG) || USE(APPKIT)
39 #include <wtf/RetainPtr.h>
40 #endif
41
42 #if USE(APPKIT)
43 OBJC_CLASS NSImage;
44 #endif
45
46 #if PLATFORM(WIN)
47 typedef struct HBITMAP__ *HBITMAP;
48 #endif
49
50 namespace WebCore {
51
52 class Settings;
53 class Timer;
54
55 class BitmapImage final : public Image {
56 public:
57     static Ref<BitmapImage> create(NativeImagePtr&& nativeImage, ImageObserver* observer = nullptr)
58     {
59         return adoptRef(*new BitmapImage(WTFMove(nativeImage), observer));
60     }
61     static Ref<BitmapImage> create(ImageObserver* observer = nullptr)
62     {
63         return adoptRef(*new BitmapImage(observer));
64     }
65 #if PLATFORM(WIN)
66     WEBCORE_EXPORT static RefPtr<BitmapImage> create(HBITMAP);
67 #endif
68     virtual ~BitmapImage();
69
70     void updateFromSettings(const Settings&);
71
72     bool hasSingleSecurityOrigin() const override { return true; }
73
74     EncodedDataStatus dataChanged(bool allDataReceived) override;
75     unsigned decodedSize() const { return m_source.decodedSize(); }
76
77     EncodedDataStatus encodedDataStatus() const { return m_source.encodedDataStatus(); }
78     size_t frameCount() const { return m_source.frameCount(); }
79     RepetitionCount repetitionCount() const { return m_source.repetitionCount(); }
80     String uti() const override { return m_source.uti(); }
81     String filenameExtension() const override { return m_source.filenameExtension(); }
82     std::optional<IntPoint> hotSpot() const override { return m_source.hotSpot(); }
83
84     // FloatSize due to override.
85     FloatSize size() const override { return m_source.size(); }
86     IntSize sizeRespectingOrientation() const { return m_source.sizeRespectingOrientation(); }
87     Color singlePixelSolidColor() const override { return m_source.singlePixelSolidColor(); }
88     bool frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(size_t index, const DecodingOptions& decodingOptions) const { return m_source.frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(index, decodingOptions); }
89     bool frameIsCompleteAtIndex(size_t index) const { return m_source.frameIsCompleteAtIndex(index); }
90     bool frameHasAlphaAtIndex(size_t index) const { return m_source.frameHasAlphaAtIndex(index); }
91
92     bool frameHasFullSizeNativeImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel) { return m_source.frameHasFullSizeNativeImageAtIndex(index, subsamplingLevel); }
93     bool frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(size_t index, const std::optional<SubsamplingLevel>& subsamplingLevel, const DecodingOptions& decodingOptions) { return m_source.frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(index, subsamplingLevel, decodingOptions); }
94
95     SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) const { return m_source.frameSubsamplingLevelAtIndex(index); }
96
97     float frameDurationAtIndex(size_t index) const { return m_source.frameDurationAtIndex(index); }
98     ImageOrientation frameOrientationAtIndex(size_t index) const { return m_source.frameOrientationAtIndex(index); }
99
100     size_t currentFrame() const { return m_currentFrame; }
101     bool currentFrameKnownToBeOpaque() const override { return !frameHasAlphaAtIndex(currentFrame()); }
102     ImageOrientation orientationForCurrentFrame() const override { return frameOrientationAtIndex(currentFrame()); }
103
104     bool shouldUseAsyncDecodingForAnimatedImagesForTesting() const { return m_frameDecodingDurationForTesting > 0_s; }
105     void setFrameDecodingDurationForTesting(Seconds duration) { m_frameDecodingDurationForTesting = duration; }
106     bool shouldUseAsyncDecodingForLargeImages();
107     bool shouldUseAsyncDecodingForAnimatedImages();
108     void setClearDecoderAfterAsyncFrameRequestForTesting(bool value) { m_clearDecoderAfterAsyncFrameRequestForTesting = value; }
109
110     // Accessors for native image formats.
111 #if USE(APPKIT)
112     NSImage *nsImage() override;
113     RetainPtr<NSImage> snapshotNSImage() override;
114 #endif
115
116 #if PLATFORM(COCOA)
117     CFDataRef tiffRepresentation() override;
118 #endif
119
120 #if PLATFORM(WIN)
121     bool getHBITMAP(HBITMAP) override;
122     bool getHBITMAPOfSize(HBITMAP, const IntSize*) override;
123 #endif
124
125 #if PLATFORM(GTK)
126     GdkPixbuf* getGdkPixbuf() override;
127 #endif
128
129     WEBCORE_EXPORT NativeImagePtr nativeImage(const GraphicsContext* = nullptr) override;
130     NativeImagePtr nativeImageForCurrentFrame(const GraphicsContext* = nullptr) override;
131 #if USE(CG)
132     NativeImagePtr nativeImageOfSize(const IntSize&, const GraphicsContext* = nullptr) override;
133     Vector<NativeImagePtr> framesNativeImages() override;
134 #endif
135
136 protected:
137     WEBCORE_EXPORT BitmapImage(NativeImagePtr&&, ImageObserver* = nullptr);
138     WEBCORE_EXPORT BitmapImage(ImageObserver* = nullptr);
139
140     NativeImagePtr frameImageAtIndex(size_t index) { return m_source.frameImageAtIndex(index); }
141     NativeImagePtr frameImageAtIndexCacheIfNeeded(size_t, SubsamplingLevel = SubsamplingLevel::Default, const GraphicsContext* = nullptr);
142
143     // Called to invalidate cached data. When |destroyAll| is true, we wipe out
144     // the entire frame buffer cache and tell the image source to destroy
145     // everything; this is used when e.g. we want to free some room in the image
146     // cache. If |destroyAll| is false, we only delete frames up to the current
147     // one; this is used while animating large images to keep memory footprint
148     // low without redecoding the whole image on every frame.
149     void destroyDecodedData(bool destroyAll = true) override;
150
151     // If the image is large enough, calls destroyDecodedData() and passes
152     // |destroyAll| along.
153     void destroyDecodedDataIfNecessary(bool destroyAll = true);
154
155     void draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode, DecodingMode, ImageOrientationDescription) override;
156     void drawPattern(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, BlendMode = BlendModeNormal) override;
157 #if PLATFORM(WIN)
158     void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) override;
159 #endif
160
161     // Animation.
162     enum class StartAnimationStatus { CannotStart, IncompleteData, TimerActive, DecodingActive, Started };
163     bool isAnimated() const override { return m_source.frameCount() > 1; }
164     bool shouldAnimate();
165     bool canAnimate();
166     void startAnimation() override { internalStartAnimation(); }
167     StartAnimationStatus internalStartAnimation();
168     void advanceAnimation();
169     void internalAdvanceAnimation();
170     bool isAnimating() const final;
171
172     // It may look unusual that there is no start animation call as public API. This is because
173     // we start and stop animating lazily. Animation begins whenever someone draws the image. It will
174     // automatically pause once all observers no longer want to render the image anywhere.
175     void stopAnimation() override;
176     void resetAnimation() override;
177     void imageFrameAvailableAtIndex(size_t) override;
178
179     // Handle platform-specific data
180     void invalidatePlatformData();
181
182 #if !ASSERT_DISABLED
183     bool notSolidColor() override;
184 #endif
185
186 #if PLATFORM(COCOA)
187     RetainPtr<CFDataRef> tiffRepresentation(const Vector<NativeImagePtr>&);
188 #endif
189
190 private:
191     void clearTimer();
192     void startTimer(Seconds delay);
193     bool isBitmapImage() const override { return true; }
194     void dump(TextStream&) const override;
195
196     // Animated images over a certain size are considered large enough that we'll only hang on to one frame at a time.
197     static const unsigned LargeAnimationCutoff = 30 * 1014 * 1024;
198
199     mutable ImageSource m_source;
200
201     size_t m_currentFrame { 0 }; // The index of the current frame of animation.
202     SubsamplingLevel m_currentSubsamplingLevel { SubsamplingLevel::Default };
203     std::unique_ptr<Timer> m_frameTimer;
204     RepetitionCount m_repetitionsComplete { RepetitionCountNone }; // How many repetitions we've finished.
205     MonotonicTime m_desiredFrameStartTime; // The system time at which we hope to see the next call to startAnimation().
206
207     Seconds m_frameDecodingDurationForTesting;
208     MonotonicTime m_desiredFrameDecodeTimeForTesting;
209
210     bool m_animationFinished { false };
211
212     // The default value of m_allowSubsampling should be the same as defaultImageSubsamplingEnabled in Settings.cpp
213 #if PLATFORM(IOS)
214     bool m_allowSubsampling { true };
215 #else
216     bool m_allowSubsampling { false };
217 #endif
218     bool m_allowLargeImageAsyncDecoding { false };
219     bool m_allowAnimatedImageAsyncDecoding { false };
220     bool m_showDebugBackground { false };
221
222     bool m_clearDecoderAfterAsyncFrameRequestForTesting { false };
223
224 #if !LOG_DISABLED
225     size_t m_lateFrameCount { 0 };
226     size_t m_earlyFrameCount { 0 };
227     size_t m_cachedFrameCount { 0 };
228 #endif
229
230 #if USE(APPKIT)
231     mutable RetainPtr<NSImage> m_nsImage; // A cached NSImage of all the frames. Only built lazily if someone actually queries for one.
232 #endif
233 #if USE(CG)
234     mutable RetainPtr<CFDataRef> m_tiffRep; // Cached TIFF rep for all the frames. Only built lazily if someone queries for one.
235 #endif
236     RefPtr<Image> m_cachedImage;
237 };
238
239 } // namespace WebCore
240
241 SPECIALIZE_TYPE_TRAITS_IMAGE(BitmapImage)