Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageBuffer.h
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2007, 2008, 2009 Apple Inc. All rights reserved.
4  * Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
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 #ifndef ImageBuffer_h
29 #define ImageBuffer_h
30
31 #include "AffineTransform.h"
32 #include "ColorSpace.h"
33 #include "GraphicsTypes.h"
34 #include "GraphicsTypes3D.h"
35 #include "IntSize.h"
36 #include "ImageBufferData.h"
37 #include "PlatformLayer.h"
38 #include <memory>
39 #include <runtime/Uint8ClampedArray.h>
40 #include <wtf/Forward.h>
41 #include <wtf/RefPtr.h>
42 #include <wtf/Vector.h>
43
44 namespace WebCore {
45
46 class FloatRect;
47 class GraphicsContext;
48 class GraphicsContext3D;
49 class Image;
50 class ImageData;
51 class IntPoint;
52 class IntRect;
53
54 enum Multiply {
55     Premultiplied,
56     Unmultiplied
57 };
58
59 enum BackingStoreCopy {
60     CopyBackingStore, // Guarantee subsequent draws don't affect the copy.
61     DontCopyBackingStore // Subsequent draws may affect the copy.
62 };
63
64 enum ScaleBehavior {
65     Scaled,
66     Unscaled
67 };
68
69 class ImageBuffer {
70     WTF_MAKE_NONCOPYABLE(ImageBuffer); WTF_MAKE_FAST_ALLOCATED;
71     friend class IOSurface;
72 public:
73     // Will return a null pointer on allocation failure.
74     WEBCORE_EXPORT static std::unique_ptr<ImageBuffer> create(const FloatSize&, RenderingMode, float resolutionScale = 1, ColorSpace = ColorSpaceSRGB);
75 #if USE(DIRECT2D)
76     WEBCORE_EXPORT static std::unique_ptr<ImageBuffer> create(const FloatSize&, RenderingMode, const GraphicsContext*, float resolutionScale = 1, ColorSpace = ColorSpaceSRGB);
77 #endif
78
79     // Create an image buffer compatible with the context, with suitable resolution for drawing into the buffer and then into this context.
80     static std::unique_ptr<ImageBuffer> createCompatibleBuffer(const FloatSize&, const GraphicsContext&);
81     static std::unique_ptr<ImageBuffer> createCompatibleBuffer(const FloatSize&, ColorSpace, const GraphicsContext&);
82     static std::unique_ptr<ImageBuffer> createCompatibleBuffer(const FloatSize&, float resolutionScale, ColorSpace, const GraphicsContext&);
83
84     static IntSize compatibleBufferSize(const FloatSize&, const GraphicsContext&);
85     bool isCompatibleWithContext(const GraphicsContext&) const;
86
87     WEBCORE_EXPORT ~ImageBuffer();
88
89     // The actual resolution of the backing store
90     const IntSize& internalSize() const { return m_size; }
91     const IntSize& logicalSize() const { return m_logicalSize; }
92
93     FloatSize sizeForDestinationSize(FloatSize) const;
94
95     float resolutionScale() const { return m_resolutionScale; }
96
97     WEBCORE_EXPORT GraphicsContext& context() const;
98
99     WEBCORE_EXPORT RefPtr<Image> copyImage(BackingStoreCopy = CopyBackingStore, ScaleBehavior = Scaled) const;
100     WEBCORE_EXPORT static RefPtr<Image> sinkIntoImage(std::unique_ptr<ImageBuffer>, ScaleBehavior = Scaled);
101     // Give hints on the faster copyImage Mode, return DontCopyBackingStore if it supports the DontCopyBackingStore behavior
102     // or return CopyBackingStore if it doesn't.  
103     static BackingStoreCopy fastCopyImageMode();
104
105     enum CoordinateSystem { LogicalCoordinateSystem, BackingStoreCoordinateSystem };
106
107     RefPtr<Uint8ClampedArray> getUnmultipliedImageData(const IntRect&, IntSize* pixelArrayDimensions = nullptr, CoordinateSystem = LogicalCoordinateSystem) const;
108     RefPtr<Uint8ClampedArray> getPremultipliedImageData(const IntRect&, IntSize* pixelArrayDimensions = nullptr, CoordinateSystem = LogicalCoordinateSystem) const;
109
110     void putByteArray(Multiply multiplied, Uint8ClampedArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint, CoordinateSystem = LogicalCoordinateSystem);
111     
112     void convertToLuminanceMask();
113     
114     String toDataURL(const String& mimeType, std::optional<double> quality = std::nullopt, CoordinateSystem = LogicalCoordinateSystem) const;
115     Vector<uint8_t> toData(const String& mimeType, std::optional<double> quality = std::nullopt) const;
116     Vector<uint8_t> toBGRAData() const;
117
118 #if !USE(CG)
119     AffineTransform baseTransform() const { return AffineTransform(); }
120     void transformColorSpace(ColorSpace srcColorSpace, ColorSpace dstColorSpace);
121     void platformTransformColorSpace(const std::array<uint8_t, 256>&);
122 #else
123     AffineTransform baseTransform() const { return AffineTransform(1, 0, 0, -1, 0, m_data.backingStoreSize.height()); }
124 #endif
125     PlatformLayer* platformLayer() const;
126
127     size_t memoryCost() const;
128     size_t externalMemoryCost() const;
129
130     // FIXME: current implementations of this method have the restriction that they only work
131     // with textures that are RGB or RGBA format, and UNSIGNED_BYTE type.
132     bool copyToPlatformTexture(GraphicsContext3D&, GC3Denum, Platform3DObject, GC3Denum, bool, bool);
133
134     // These functions are used when clamping the ImageBuffer which is created for filter, masker or clipper.
135     static bool sizeNeedsClamping(const FloatSize&);
136     static bool sizeNeedsClamping(const FloatSize&, FloatSize& scale);
137     static FloatSize clampedSize(const FloatSize&);
138     static FloatSize clampedSize(const FloatSize&, FloatSize& scale);
139     static FloatRect clampedRect(const FloatRect&);
140
141 private:
142 #if USE(CG)
143     // The returned image might be larger than the internalSize(). If you want the smaller
144     // image, crop the result.
145     RetainPtr<CGImageRef> copyNativeImage(BackingStoreCopy = CopyBackingStore) const;
146     static RetainPtr<CGImageRef> sinkIntoNativeImage(std::unique_ptr<ImageBuffer>);
147     void flushContext() const;
148 #elif USE(DIRECT2D)
149     void flushContext() const;
150 #endif
151     
152     void draw(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1), CompositeOperator = CompositeSourceOver, BlendMode = BlendModeNormal);
153     void drawPattern(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, BlendMode = BlendModeNormal);
154
155     static void drawConsuming(std::unique_ptr<ImageBuffer>, GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1), CompositeOperator = CompositeSourceOver, BlendMode = BlendModeNormal);
156
157     inline void genericConvertToLuminanceMask();
158
159     friend class GraphicsContext;
160     friend class GeneratedImage;
161     friend class CrossfadeGeneratedImage;
162     friend class NamedImageGeneratedImage;
163     friend class GradientImage;
164
165 private:
166     ImageBufferData m_data;
167     IntSize m_size;
168     IntSize m_logicalSize;
169     float m_resolutionScale;
170
171     // This constructor will place its success into the given out-variable
172     // so that create() knows when it should return failure.
173     WEBCORE_EXPORT ImageBuffer(const FloatSize&, float resolutionScale, ColorSpace, RenderingMode, bool& success);
174 #if USE(CG)
175     ImageBuffer(const FloatSize&, float resolutionScale, CGColorSpaceRef, RenderingMode, bool& success);
176     RetainPtr<CFDataRef> toCFData(const String& mimeType, std::optional<double> quality) const;
177 #elif USE(DIRECT2D)
178     ImageBuffer(const FloatSize&, float resolutionScale, ColorSpace, RenderingMode, const GraphicsContext*, bool& success);
179 #endif
180 };
181
182 #if USE(CG)
183 String dataURL(const ImageData&, const String& mimeType, std::optional<double> quality);
184 Vector<uint8_t> data(const ImageData&, const String& mimeType, std::optional<double> quality);
185 #endif
186
187 } // namespace WebCore
188
189 #endif // ImageBuffer_h