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