1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
* Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
* Copyright (C) 2007-2022 Apple Inc. All rights reserved.
* Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "GraphicsContextFlushIdentifier.h"
#include "ImageBufferAllocator.h"
#include "ImageBufferBackend.h"
#include "RenderingMode.h"
#include "RenderingResourceIdentifier.h"
#include <wtf/OptionSet.h>
#include <wtf/RefCounted.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class Filter;
class HostWindow;
#if HAVE(IOSURFACE)
class IOSurfacePool;
#endif
enum class ImageBufferOptions : uint8_t {
Accelerated = 1 << 0,
UseDisplayList = 1 << 1
};
class ImageBuffer : public ThreadSafeRefCounted<ImageBuffer, WTF::DestructionThread::Main>, public CanMakeWeakPtr<ImageBuffer> {
public:
struct CreationContext {
// clang 13.1.6 throws errors if we use default initializers here.
HostWindow* hostWindow;
#if HAVE(IOSURFACE)
IOSurfacePool* surfacePool;
#endif
bool avoidIOSurfaceSizeCheckInWebProcessForTesting = false;
enum class UseOutOfLineSurfaces : bool { No, Yes };
#if ENABLE(CG_DISPLAY_LIST_BACKED_IMAGE_BUFFER)
UseOutOfLineSurfaces useOutOfLineSurfacesForCGDisplayLists;
#endif
CreationContext(HostWindow* window = nullptr
#if HAVE(IOSURFACE)
, IOSurfacePool* pool = nullptr
#endif
, bool avoidCheck = false
#if ENABLE(CG_DISPLAY_LIST_BACKED_IMAGE_BUFFER)
, UseOutOfLineSurfaces useOutOfLineSurfacesForCGDisplayLists = UseOutOfLineSurfaces::No
#endif
)
: hostWindow(window)
#if HAVE(IOSURFACE)
, surfacePool(pool)
#endif
, avoidIOSurfaceSizeCheckInWebProcessForTesting(avoidCheck)
#if ENABLE(CG_DISPLAY_LIST_BACKED_IMAGE_BUFFER)
, useOutOfLineSurfacesForCGDisplayLists(useOutOfLineSurfacesForCGDisplayLists)
#endif
{ }
};
WEBCORE_EXPORT static RefPtr<ImageBuffer> create(const FloatSize&, RenderingPurpose, float resolutionScale, const DestinationColorSpace&, PixelFormat, OptionSet<ImageBufferOptions> = { }, const CreationContext& = { });
template<typename BackendType, typename ImageBufferType = ImageBuffer, typename... Arguments>
static RefPtr<ImageBufferType> create(const FloatSize& size, float resolutionScale, const DestinationColorSpace& colorSpace, PixelFormat pixelFormat, RenderingPurpose purpose, const CreationContext& creationContext, Arguments&&... arguments)
{
auto parameters = ImageBufferBackend::Parameters { size, resolutionScale, colorSpace, pixelFormat, purpose };
auto backend = BackendType::create(parameters, creationContext);
if (!backend)
return nullptr;
auto backendInfo = populateBackendInfo<BackendType>(parameters);
return create<ImageBufferType>(parameters, backendInfo, WTFMove(backend), std::forward<Arguments>(arguments)...);
}
template<typename BackendType, typename ImageBufferType = ImageBuffer, typename... Arguments>
static RefPtr<ImageBufferType> create(const FloatSize& size, const GraphicsContext& context, RenderingPurpose purpose, Arguments&&... arguments)
{
auto parameters = ImageBufferBackend::Parameters { size, 1, DestinationColorSpace::SRGB(), PixelFormat::BGRA8, purpose };
auto backend = BackendType::create(parameters, context);
if (!backend)
return nullptr;
auto backendInfo = populateBackendInfo<BackendType>(parameters);
return create<ImageBufferType>(parameters, backendInfo, WTFMove(backend), std::forward<Arguments>(arguments)...);
}
template<typename ImageBufferType = ImageBuffer, typename... Arguments>
static RefPtr<ImageBufferType> create(const ImageBufferBackend::Parameters& parameters, const ImageBufferBackend::Info& backendInfo, std::unique_ptr<ImageBufferBackend>&& backend, Arguments&&... arguments)
{
return adoptRef(new ImageBufferType(parameters, backendInfo, WTFMove(backend), std::forward<Arguments>(arguments)...));
}
template<typename BackendType>
static ImageBufferBackend::Info populateBackendInfo(const ImageBufferBackend::Parameters& parameters)
{
return {
BackendType::renderingMode,
BackendType::canMapBackingStore,
BackendType::calculateBaseTransform(parameters, BackendType::isOriginAtBottomLeftCorner),
BackendType::calculateMemoryCost(parameters),
BackendType::calculateExternalMemoryCost(parameters)
};
}
WEBCORE_EXPORT virtual ~ImageBuffer();
// These functions are used when clamping the ImageBuffer which is created for filter, masker or clipper.
static bool sizeNeedsClamping(const FloatSize&);
static bool sizeNeedsClamping(const FloatSize&, FloatSize& scale);
static FloatSize clampedSize(const FloatSize&);
static FloatSize clampedSize(const FloatSize&, FloatSize& scale);
static FloatRect clampedRect(const FloatRect&);
RefPtr<ImageBuffer> clone() const;
WEBCORE_EXPORT virtual GraphicsContext& context() const;
WEBCORE_EXPORT virtual void flushContext();
virtual GraphicsContext* drawingContext() { return nullptr; }
virtual bool prefersPreparationForDisplay() { return false; }
virtual void flushDrawingContext() { }
virtual bool flushDrawingContextAsync() { return false; }
virtual void didFlush(GraphicsContextFlushIdentifier) { }
virtual void backingStoreWillChange() { }
WEBCORE_EXPORT void setBackend(std::unique_ptr<ImageBufferBackend>&&);
WEBCORE_EXPORT IntSize backendSize() const;
virtual void clearBackend() { m_backend = nullptr; }
ImageBufferBackend* backend() const { return m_backend.get(); }
virtual ImageBufferBackend* ensureBackendCreated() const { return m_backend.get(); }
RenderingResourceIdentifier renderingResourceIdentifier() const { return m_renderingResourceIdentifier; }
FloatSize logicalSize() const { return m_parameters.logicalSize; }
IntSize truncatedLogicalSize() const { return IntSize(m_parameters.logicalSize); } // You probably should be calling logicalSize() instead.
float resolutionScale() const { return m_parameters.resolutionScale; }
DestinationColorSpace colorSpace() const { return m_parameters.colorSpace; }
RenderingPurpose renderingPurpose() const { return m_parameters.purpose; }
PixelFormat pixelFormat() const { return m_parameters.pixelFormat; }
const ImageBufferBackend::Parameters& parameters() const { return m_parameters; }
RenderingMode renderingMode() const { return m_backendInfo.renderingMode; }
bool canMapBackingStore() const { return m_backendInfo.canMapBackingStore; }
AffineTransform baseTransform() const { return m_backendInfo.baseTransform; }
size_t memoryCost() const { return m_backendInfo.memoryCost; }
size_t externalMemoryCost() const { return m_backendInfo.externalMemoryCost; }
void setBackendInfo(ImageBufferBackend::Info&& parameters) { m_backendInfo = WTFMove(parameters); }
WEBCORE_EXPORT virtual RefPtr<NativeImage> copyNativeImage(BackingStoreCopy = CopyBackingStore) const;
WEBCORE_EXPORT virtual RefPtr<NativeImage> copyNativeImageForDrawing(BackingStoreCopy = CopyBackingStore) const;
WEBCORE_EXPORT virtual RefPtr<NativeImage> sinkIntoNativeImage();
WEBCORE_EXPORT RefPtr<Image> copyImage(BackingStoreCopy = CopyBackingStore, PreserveResolution = PreserveResolution::No) const;
WEBCORE_EXPORT virtual RefPtr<Image> filteredImage(Filter&);
#if USE(CAIRO)
RefPtr<cairo_surface_t> createCairoSurface();
#endif
static RefPtr<NativeImage> sinkIntoNativeImage(RefPtr<ImageBuffer>);
WEBCORE_EXPORT static RefPtr<Image> sinkIntoImage(RefPtr<ImageBuffer>, PreserveResolution = PreserveResolution::No);
WEBCORE_EXPORT virtual void draw(GraphicsContext& destContext, const FloatRect& destRect, const FloatRect& srcRect, const ImagePaintingOptions&);
WEBCORE_EXPORT virtual void drawPattern(GraphicsContext& destContext, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, const ImagePaintingOptions&);
WEBCORE_EXPORT virtual void drawConsuming(GraphicsContext& destContext, const FloatRect& destRect, const FloatRect& srcRect, const ImagePaintingOptions&);
static void drawConsuming(RefPtr<ImageBuffer>, GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const ImagePaintingOptions& = { });
void clipToMask(GraphicsContext& destContext, const FloatRect& destRect);
WEBCORE_EXPORT virtual void convertToLuminanceMask();
WEBCORE_EXPORT virtual void transformToColorSpace(const DestinationColorSpace& newColorSpace);
WEBCORE_EXPORT String toDataURL(const String& mimeType, std::optional<double> quality = std::nullopt, PreserveResolution = PreserveResolution::No) const;
WEBCORE_EXPORT Vector<uint8_t> toData(const String& mimeType, std::optional<double> quality = std::nullopt, PreserveResolution = PreserveResolution::No) const;
WEBCORE_EXPORT static String toDataURL(Ref<ImageBuffer> source, const String& mimeType, std::optional<double> quality = std::nullopt, PreserveResolution = PreserveResolution::No);
WEBCORE_EXPORT static Vector<uint8_t> toData(Ref<ImageBuffer> source, const String& mimeType, std::optional<double> quality = std::nullopt, PreserveResolution = PreserveResolution::No);
WEBCORE_EXPORT virtual RefPtr<PixelBuffer> getPixelBuffer(const PixelBufferFormat& outputFormat, const IntRect& srcRect, const ImageBufferAllocator& = ImageBufferAllocator()) const;
WEBCORE_EXPORT virtual void putPixelBuffer(const PixelBuffer&, const IntRect& srcRect, const IntPoint& destPoint = { }, AlphaPremultiplication destFormat = AlphaPremultiplication::Premultiplied);
PlatformLayer* platformLayer() const;
bool copyToPlatformTexture(GraphicsContextGL&, GCGLenum target, PlatformGLObject destinationTexture, GCGLenum internalformat, bool premultiplyAlpha, bool flipY) const;
WEBCORE_EXPORT bool isInUse() const;
WEBCORE_EXPORT void releaseGraphicsContext();
WEBCORE_EXPORT bool setVolatile();
WEBCORE_EXPORT SetNonVolatileResult setNonVolatile();
WEBCORE_EXPORT VolatilityState volatilityState() const;
WEBCORE_EXPORT void setVolatilityState(VolatilityState);
WEBCORE_EXPORT void clearContents();
WEBCORE_EXPORT virtual std::unique_ptr<ThreadSafeImageBufferFlusher> createFlusher();
protected:
WEBCORE_EXPORT ImageBuffer(const ImageBufferBackend::Parameters&, const ImageBufferBackend::Info&, std::unique_ptr<ImageBufferBackend>&& = nullptr, RenderingResourceIdentifier = RenderingResourceIdentifier::generate());
ImageBufferBackend::Parameters m_parameters;
ImageBufferBackend::Info m_backendInfo;
std::unique_ptr<ImageBufferBackend> m_backend;
RenderingResourceIdentifier m_renderingResourceIdentifier;
};
inline OptionSet<ImageBufferOptions> bufferOptionsForRendingMode(RenderingMode renderingMode)
{
if (renderingMode == RenderingMode::Accelerated)
return { ImageBufferOptions::Accelerated };
return { };
}
} // namespace WebCore
|
