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
|
/*
* Copyright (C) 2010-2022 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 "SharedMemory.h"
#include <WebCore/CopyImageOptions.h>
#include <WebCore/DestinationColorSpace.h>
#include <WebCore/IntRect.h>
#include <WebCore/PlatformImage.h>
#include <wtf/RefPtr.h>
#include <wtf/ThreadSafeRefCounted.h>
namespace WebCore {
class Image;
class GraphicsContext;
}
namespace WebKit {
class ShareableBitmap : public ThreadSafeRefCounted<ShareableBitmap> {
public:
struct Configuration {
std::optional<WebCore::DestinationColorSpace> colorSpace;
bool isOpaque { false };
void encode(IPC::Encoder&) const;
static WARN_UNUSED_RETURN bool decode(IPC::Decoder&, Configuration&);
};
class Handle {
WTF_MAKE_NONCOPYABLE(Handle);
public:
Handle();
Handle(Handle&&) = default;
Handle& operator=(Handle&&) = default;
bool isNull() const { return m_handle.isNull(); }
SharedMemory::Handle& handle() { return m_handle; }
// Take ownership of the memory for process memory accounting purposes.
void takeOwnershipOfMemory(MemoryLedger) const;
void clear();
void encode(IPC::Encoder&) const;
static WARN_UNUSED_RETURN bool decode(IPC::Decoder&, Handle&);
private:
friend class ShareableBitmap;
mutable SharedMemory::Handle m_handle;
WebCore::IntSize m_size;
Configuration m_configuration;
};
static void validateConfiguration(Configuration&);
static CheckedUint32 numBytesForSize(WebCore::IntSize, const ShareableBitmap::Configuration&);
static CheckedUint32 calculateBytesPerRow(WebCore::IntSize, const Configuration&);
static CheckedUint32 calculateBytesPerPixel(const Configuration&);
// Create a shareable bitmap whose backing memory can be shared with another process.
static RefPtr<ShareableBitmap> create(const WebCore::IntSize&, Configuration);
// Create a shareable bitmap from an already existing shared memory block.
static RefPtr<ShareableBitmap> create(const WebCore::IntSize&, Configuration, Ref<SharedMemory>&&);
// Create a shareable bitmap from a handle.
static RefPtr<ShareableBitmap> create(const Handle&, SharedMemory::Protection = SharedMemory::Protection::ReadWrite);
// Create a handle.
bool createHandle(Handle&, SharedMemory::Protection = SharedMemory::Protection::ReadWrite) const;
const WebCore::IntSize& size() const { return m_size; }
WebCore::IntRect bounds() const { return WebCore::IntRect(WebCore::IntPoint(), size()); }
void* data() const;
size_t bytesPerRow() const { return calculateBytesPerRow(m_size, m_configuration); }
size_t sizeInBytes() const { return numBytesForSize(m_size, m_configuration); }
// Create a graphics context that can be used to paint into the backing store.
std::unique_ptr<WebCore::GraphicsContext> createGraphicsContext();
// Paint the backing store into the given context.
void paint(WebCore::GraphicsContext&, const WebCore::IntPoint& destination, const WebCore::IntRect& source);
void paint(WebCore::GraphicsContext&, float scaleFactor, const WebCore::IntPoint& destination, const WebCore::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.
RefPtr<WebCore::Image> createImage();
#if USE(CG)
// This creates a copied CGImageRef (most likely a copy-on-write) of the shareable bitmap.
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.
RetainPtr<CGImageRef> makeCGImage(WebCore::ShouldInterpolate = WebCore::ShouldInterpolate::No);
WebCore::PlatformImagePtr createPlatformImage(WebCore::BackingStoreCopy = WebCore::CopyBackingStore, WebCore::ShouldInterpolate = WebCore::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.
RefPtr<cairo_surface_t> createPersistentCairoSurface();
RefPtr<cairo_surface_t> createCairoSurface();
WebCore::PlatformImagePtr createPlatformImage(WebCore::BackingStoreCopy = WebCore::CopyBackingStore, WebCore::ShouldInterpolate = WebCore::ShouldInterpolate::No) { return createCairoSurface(); }
#endif
private:
ShareableBitmap(const WebCore::IntSize&, Configuration, Ref<SharedMemory>&&);
#if USE(CG)
RetainPtr<CGImageRef> createCGImage(CGDataProviderRef, WebCore::ShouldInterpolate) const;
static void releaseBitmapContextData(void* typelessBitmap, void* typelessData);
#endif
#if USE(CAIRO)
static void releaseSurfaceData(void* typelessBitmap);
#endif
WebCore::IntSize m_size;
Configuration m_configuration;
#if USE(CG)
bool m_releaseBitmapContextDataCalled { false };
#endif
Ref<SharedMemory> m_sharedMemory;
};
} // namespace WebKit
|
