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
|
/*
* Copyright (C) 2010-2024 Apple Inc. 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. AND ITS CONTRIBUTORS ``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 ITS 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 "CopyImageOptions.h"
#include "DestinationColorSpace.h"
#include "IntRect.h"
#include "PlatformImage.h"
#include "SharedMemory.h"
#include <wtf/ArgumentCoder.h>
#include <wtf/DebugHeap.h>
#include <wtf/ExportMacros.h>
#include <wtf/RefPtr.h>
#include <wtf/ThreadSafeRefCounted.h>
#if USE(SKIA)
#include <skia/core/SkImageInfo.h>
#endif
namespace WebCore {
class GraphicsContext;
class Image;
class NativeImage;
class ShareableBitmapConfiguration {
public:
ShareableBitmapConfiguration() = default;
WEBCORE_EXPORT ShareableBitmapConfiguration(const IntSize&, std::optional<DestinationColorSpace> = std::nullopt, bool isOpaque = false);
WEBCORE_EXPORT ShareableBitmapConfiguration(const IntSize&, std::optional<DestinationColorSpace>, bool isOpaque, unsigned bytesPerPixel, unsigned bytesPerRow
#if USE(CG)
, CGBitmapInfo
#endif
);
#if USE(CG)
ShareableBitmapConfiguration(NativeImage&);
#endif
IntSize size() const { return m_size; }
const DestinationColorSpace& colorSpace() const { return m_colorSpace ? *m_colorSpace : DestinationColorSpace::SRGB(); }
PlatformColorSpaceValue platformColorSpace() const { return colorSpace().platformColorSpace(); }
bool isOpaque() const { return m_isOpaque; }
unsigned bytesPerPixel() const { ASSERT(!m_bytesPerPixel.hasOverflowed()); return m_bytesPerPixel; }
unsigned bytesPerRow() const { ASSERT(!m_bytesPerRow.hasOverflowed()); return m_bytesPerRow; }
#if USE(CG)
CGBitmapInfo bitmapInfo() const { return m_bitmapInfo; }
#endif
#if USE(SKIA)
const SkImageInfo& imageInfo() const { return m_imageInfo; }
#endif
CheckedUint32 sizeInBytes() const { return m_bytesPerRow * m_size.height(); }
WEBCORE_EXPORT static CheckedUint32 calculateBytesPerRow(const IntSize&, const DestinationColorSpace&);
WEBCORE_EXPORT static CheckedUint32 calculateSizeInBytes(const IntSize&, const DestinationColorSpace&);
private:
friend struct IPC::ArgumentCoder<ShareableBitmapConfiguration, void>;
static std::optional<DestinationColorSpace> validateColorSpace(std::optional<DestinationColorSpace>);
static CheckedUint32 calculateBytesPerPixel(const DestinationColorSpace&);
#if USE(CG)
static CGBitmapInfo calculateBitmapInfo(const DestinationColorSpace&, bool isOpaque);
#endif
IntSize m_size;
std::optional<DestinationColorSpace> m_colorSpace;
bool m_isOpaque { false };
CheckedUint32 m_bytesPerPixel;
CheckedUint32 m_bytesPerRow;
#if USE(CG)
CGBitmapInfo m_bitmapInfo { 0 };
#endif
#if USE(SKIA)
SkImageInfo m_imageInfo;
#endif
};
class ShareableBitmapHandle {
public:
ShareableBitmapHandle(ShareableBitmapHandle&&) = default;
explicit ShareableBitmapHandle(const ShareableBitmapHandle&) = default;
WEBCORE_EXPORT ShareableBitmapHandle(SharedMemory::Handle&&, const ShareableBitmapConfiguration&);
ShareableBitmapHandle& operator=(ShareableBitmapHandle&&) = default;
SharedMemory::Handle& handle() { return m_handle; }
// Take ownership of the memory for process memory accounting purposes.
WEBCORE_EXPORT void takeOwnershipOfMemory(MemoryLedger) const;
// Transfer ownership of the memory for process memory accounting purposes.
WEBCORE_EXPORT void setOwnershipOfMemory(const ProcessIdentity&, MemoryLedger) const;
private:
friend struct IPC::ArgumentCoder<ShareableBitmapHandle, void>;
friend class ShareableBitmap;
SharedMemory::Handle m_handle;
ShareableBitmapConfiguration m_configuration;
};
class ShareableBitmap : public ThreadSafeRefCounted<ShareableBitmap> {
public:
using Handle = ShareableBitmapHandle;
// Create a shareable bitmap whose backing memory can be shared with another process.
WEBCORE_EXPORT static RefPtr<ShareableBitmap> create(const ShareableBitmapConfiguration&);
// Create a shareable bitmap from an already existing shared memory block.
WEBCORE_EXPORT static RefPtr<ShareableBitmap> create(const ShareableBitmapConfiguration&, Ref<SharedMemory>&&);
// Create a shareable bitmap from a NativeImage.
#if USE(CG)
WEBCORE_EXPORT static RefPtr<ShareableBitmap> createFromImagePixels(NativeImage&);
#endif
WEBCORE_EXPORT static RefPtr<ShareableBitmap> createFromImageDraw(NativeImage&);
WEBCORE_EXPORT static RefPtr<ShareableBitmap> createFromImageDraw(NativeImage&, const DestinationColorSpace&);
WEBCORE_EXPORT static RefPtr<ShareableBitmap> createFromImageDraw(NativeImage&, const DestinationColorSpace&, const IntSize&);
// Create a shareable bitmap from a handle.
WEBCORE_EXPORT static RefPtr<ShareableBitmap> create(Handle&&, SharedMemory::Protection = SharedMemory::Protection::ReadWrite);
// Create a shareable bitmap from a ReadOnly handle.
WEBCORE_EXPORT static std::optional<Ref<ShareableBitmap>> createReadOnly(std::optional<Handle>&&);
WEBCORE_EXPORT std::optional<Handle> createHandle(SharedMemory::Protection = SharedMemory::Protection::ReadWrite) const;
// Create a ReadOnly handle.
WEBCORE_EXPORT std::optional<Handle> createReadOnlyHandle() const;
WEBCORE_EXPORT void setOwnershipOfMemory(const ProcessIdentity&);
IntSize size() const { return m_configuration.size(); }
IntRect bounds() const { return IntRect(IntPoint(), size()); }
WEBCORE_EXPORT std::span<const uint8_t> span() const;
WEBCORE_EXPORT std::span<uint8_t> mutableSpan();
size_t bytesPerRow() const { return m_configuration.bytesPerRow(); }
size_t sizeInBytes() const { return m_configuration.sizeInBytes(); }
// Create a graphics context that can be used to paint into the backing store.
WEBCORE_EXPORT std::unique_ptr<GraphicsContext> createGraphicsContext();
// Paint the backing store into the given context.
WEBCORE_EXPORT void paint(GraphicsContext&, const IntPoint& destination, const IntRect& source);
WEBCORE_EXPORT void paint(GraphicsContext&, float scaleFactor, const IntPoint& destination, const IntRect& source);
// This creates a bitmap image that directly references the shared bitmap data.
// This is only safe to use when we know that the contents of the shareable bitmap won't change.
WEBCORE_EXPORT RefPtr<Image> createImage();
#if USE(CG)
// This creates a copied CGImageRef (most likely a copy-on-write) of the shareable bitmap.
WEBCORE_EXPORT RetainPtr<CGImageRef> makeCGImageCopy();
// This creates a CGImageRef that directly references the shared bitmap data.
// This is only safe to use when we know that the contents of the shareable bitmap won't change.
WEBCORE_EXPORT RetainPtr<CGImageRef> makeCGImage(ShouldInterpolate = ShouldInterpolate::No);
WEBCORE_EXPORT PlatformImagePtr createPlatformImage(BackingStoreCopy = CopyBackingStore, ShouldInterpolate = ShouldInterpolate::No);
#elif USE(CAIRO)
// This creates a BitmapImage that directly references the shared bitmap data.
// This is only safe to use when we know that the contents of the shareable bitmap won't change.
WEBCORE_EXPORT RefPtr<cairo_surface_t> createPersistentCairoSurface();
WEBCORE_EXPORT RefPtr<cairo_surface_t> createCairoSurface();
PlatformImagePtr createPlatformImage(BackingStoreCopy = CopyBackingStore, ShouldInterpolate = ShouldInterpolate::No) { return createCairoSurface(); }
#elif USE(SKIA)
WEBCORE_EXPORT PlatformImagePtr createPlatformImage(BackingStoreCopy = CopyBackingStore, ShouldInterpolate = ShouldInterpolate::No);
#endif
private:
ShareableBitmap(ShareableBitmapConfiguration, Ref<SharedMemory>&&);
#if USE(CG)
RetainPtr<CGImageRef> createCGImage(CGDataProviderRef, ShouldInterpolate) const;
static void releaseBitmapContextData(void* typelessBitmap, void* typelessData);
#endif
#if USE(CAIRO)
static void releaseSurfaceData(void* typelessBitmap);
#endif
ShareableBitmapConfiguration m_configuration;
const Ref<SharedMemory> m_sharedMemory;
#if USE(CG)
std::optional<SharedMemoryHandle> m_ownershipHandle;
bool m_releaseBitmapContextDataCalled : 1 { false };
#endif
};
} // namespace WebCore
|
