[WebGL2] Teach WebGLRenderingContextBase about new texture internal formats
[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
37 #if USE(CG) || USE(APPKIT)
38 #include <wtf/RetainPtr.h>
39 #endif
40
41 #if USE(APPKIT)
42 OBJC_CLASS NSImage;
43 #endif
44
45 #if PLATFORM(WIN)
46 typedef struct HBITMAP__ *HBITMAP;
47 #endif
48
49 namespace WebCore {
50
51 class Timer;
52
53 class BitmapImage final : public Image {
54 public:
55     static Ref<BitmapImage> create(NativeImagePtr&& nativeImage, ImageObserver* observer = nullptr)
56     {
57         return adoptRef(*new BitmapImage(WTFMove(nativeImage), observer));
58     }
59     static Ref<BitmapImage> create(ImageObserver* observer = nullptr)
60     {
61         return adoptRef(*new BitmapImage(observer));
62     }
63 #if PLATFORM(WIN)
64     WEBCORE_EXPORT static RefPtr<BitmapImage> create(HBITMAP);
65 #endif
66     virtual ~BitmapImage();
67     
68     bool hasSingleSecurityOrigin() const override { return true; }
69
70     bool dataChanged(bool allDataReceived) override;
71     unsigned decodedSize() const { return m_source.decodedSize(); }
72
73     bool isSizeAvailable() const { return m_source.isSizeAvailable(); }
74     size_t frameCount() const { return m_source.frameCount(); }
75     RepetitionCount repetitionCount() const { return m_source.repetitionCount(); }
76     String filenameExtension() const override { return m_source.filenameExtension(); }
77     Optional<IntPoint> hotSpot() const override { return m_source.hotSpot(); }
78
79     // FloatSize due to override.
80     FloatSize size() const override { return m_source.size(); }
81     IntSize sizeRespectingOrientation() const { return m_source.sizeRespectingOrientation(); }
82     Color singlePixelSolidColor() const override { return m_source.singlePixelSolidColor(); }
83
84     bool frameIsBeingDecodedAtIndex(size_t index) const { return m_source.frameIsBeingDecodedAtIndex(index); }
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 frameHasValidNativeImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel) const { return m_source.frameHasValidNativeImageAtIndex(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     bool isAsyncDecodingForcedForTesting() const { return m_frameDecodingDurationForTesting > 0; }
98     void setFrameDecodingDurationForTesting(float duration) { m_frameDecodingDurationForTesting = duration; }
99
100     // Accessors for native image formats.
101 #if USE(APPKIT)
102     NSImage *nsImage() override;
103     RetainPtr<NSImage> snapshotNSImage() override;
104 #endif
105
106 #if PLATFORM(COCOA)
107     CFDataRef tiffRepresentation() override;
108 #endif
109
110 #if PLATFORM(WIN)
111     bool getHBITMAP(HBITMAP) override;
112     bool getHBITMAPOfSize(HBITMAP, const IntSize*) override;
113 #endif
114
115 #if PLATFORM(GTK)
116     GdkPixbuf* getGdkPixbuf() override;
117 #endif
118
119 #if PLATFORM(EFL)
120     Evas_Object* getEvasObject(Evas*) override;
121 #endif
122
123     WEBCORE_EXPORT NativeImagePtr nativeImage(const GraphicsContext* = nullptr) override;
124     NativeImagePtr nativeImageForCurrentFrame(const GraphicsContext* = nullptr) override;
125 #if USE(CG)
126     NativeImagePtr nativeImageOfSize(const IntSize&, const GraphicsContext* = nullptr) override;
127     Vector<NativeImagePtr> framesNativeImages() override;
128 #endif
129
130 protected:
131     WEBCORE_EXPORT BitmapImage(NativeImagePtr&&, ImageObserver* = nullptr);
132     WEBCORE_EXPORT BitmapImage(ImageObserver* = nullptr);
133
134     NativeImagePtr frameImageAtIndex(size_t, SubsamplingLevel = SubsamplingLevel::Default, const GraphicsContext* = nullptr);
135
136     bool allowSubsampling() const { return imageObserver() && imageObserver()->allowSubsampling(); }
137     bool allowAsyncImageDecoding() const { return imageObserver() && imageObserver()->allowAsyncImageDecoding(); }
138     bool showDebugBackground() const { return imageObserver() && imageObserver()->showDebugBackground(); }
139
140     // Called to invalidate cached data. When |destroyAll| is true, we wipe out
141     // the entire frame buffer cache and tell the image source to destroy
142     // everything; this is used when e.g. we want to free some room in the image
143     // cache. If |destroyAll| is false, we only delete frames up to the current
144     // one; this is used while animating large images to keep memory footprint
145     // low without redecoding the whole image on every frame.
146     void destroyDecodedData(bool destroyAll = true) override;
147
148     // If the image is large enough, calls destroyDecodedData() and passes
149     // |destroyAll| along.
150     void destroyDecodedDataIfNecessary(bool destroyAll = true);
151
152     void draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode, ImageOrientationDescription) override;
153     void drawPattern(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, BlendMode = BlendModeNormal) override;
154 #if PLATFORM(WIN)
155     void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) override;
156 #endif
157
158     // Animation.
159     enum class StartAnimationResult { CannotStart, IncompleteData, TimerActive, DecodingActive, Started };
160     bool isAnimated() const override { return m_source.frameCount() > 1; }
161     bool shouldAnimate();
162     bool canAnimate();
163     void startAnimation() override { internalStartAnimation(); }
164     StartAnimationResult internalStartAnimation();
165     void advanceAnimation();
166     void internalAdvanceAnimation();
167
168     // It may look unusual that there is no start animation call as public API. This is because
169     // we start and stop animating lazily. Animation begins whenever someone draws the image. It will
170     // automatically pause once all observers no longer want to render the image anywhere.
171     void stopAnimation() override;
172     void resetAnimation() override;
173     void newFrameNativeImageAvailableAtIndex(size_t) override;
174
175     // Handle platform-specific data
176     void invalidatePlatformData();
177
178 #if !ASSERT_DISABLED
179     bool notSolidColor() override;
180 #endif
181
182 #if PLATFORM(COCOA)
183     RetainPtr<CFDataRef> tiffRepresentation(const Vector<NativeImagePtr>&);
184 #endif
185
186 private:
187     void clearTimer();
188     void startTimer(double delay);
189     bool isBitmapImage() const override { return true; }
190     void dump(TextStream&) const override;
191
192     mutable ImageSource m_source;
193
194     size_t m_currentFrame { 0 }; // The index of the current frame of animation.
195     SubsamplingLevel m_currentSubsamplingLevel { SubsamplingLevel::Default };
196     std::unique_ptr<Timer> m_frameTimer;
197     RepetitionCount m_repetitionsComplete { RepetitionCountNone }; // How many repetitions we've finished.
198     double m_desiredFrameStartTime { 0 }; // The system time at which we hope to see the next call to startAnimation().
199     bool m_animationFinished { false };
200
201     float m_frameDecodingDurationForTesting { 0 };
202     double m_desiredFrameDecodeTimeForTesting { 0 };
203 #if !LOG_DISABLED
204     size_t m_lateFrameCount { 0 };
205     size_t m_earlyFrameCount { 0 };
206     size_t m_cachedFrameCount { 0 };
207 #endif
208
209 #if USE(APPKIT)
210     mutable RetainPtr<NSImage> m_nsImage; // A cached NSImage of all the frames. Only built lazily if someone actually queries for one.
211 #endif
212 #if USE(CG)
213     mutable RetainPtr<CFDataRef> m_tiffRep; // Cached TIFF rep for all the frames. Only built lazily if someone queries for one.
214 #endif
215     RefPtr<Image> m_cachedImage;
216 };
217
218 } // namespace WebCore
219
220 SPECIALIZE_TYPE_TRAITS_IMAGE(BitmapImage)