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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef MOZILLA_LAYERS_COMPOSITABLEFORWARDER
#define MOZILLA_LAYERS_COMPOSITABLEFORWARDER
#include <stdint.h> // for int32_t, uint32_t, uint64_t
#include "mozilla/Assertions.h" // for AssertionConditionType, MOZ_ASSERT, MOZ_ASSERT_HELPER1
#include "mozilla/Atomics.h"
#include "mozilla/RefPtr.h" // for RefPtr
#include "mozilla/TimeStamp.h" // for TimeStamp
#include "mozilla/ipc/ProtocolUtils.h" // for IToplevelProtocol, ProtocolID
#include "mozilla/layers/KnowsCompositor.h" // for KnowsCompositor
#include "nsRect.h" // for nsIntRect
#include "nsRegion.h" // for nsIntRegion
#include "nsTArray.h" // for nsTArray
namespace mozilla {
namespace layers {
class CompositableClient;
class CompositableHandle;
class ImageContainer;
class PTextureChild;
class SurfaceDescriptorTiles;
class TextureClient;
/**
* FwdTransactionCounter issues forwarder transaction numbers that represent a
* sequential stream of transactions to be transported over IPDL. Since every
* top-level protocol represents its own independently-sequenced IPDL queue,
* transaction numbers most naturally align with top-level protocols, rather
* than have different sub-protocols with their own independent transaction
* numbers that can't be usefully sequenced. FwdTransactionCounter expects
* users of it to provide themselves as proof they are a top-level protocol
* to avoid issues.
*/
struct FwdTransactionCounter {
explicit FwdTransactionCounter(mozilla::ipc::IToplevelProtocol* aToplevel)
: mFwdTransactionType(aToplevel->GetProtocolId()) {}
/**
* The ID of the top-level protocol. This is useful to tag the source of
* the transaction numbers in case different sources must be disambiguated.
*/
mozilla::ipc::ProtocolId mFwdTransactionType;
/**
* Transaction id of ShadowLayerForwarder.
* It is incremented by UpdateFwdTransactionId() in each BeginTransaction()
* call.
*/
uint64_t mFwdTransactionId = 0;
};
/**
* FwdTransactionTracker is to be used by CompositableForwarder consumers that
* must remember the last transaction in which they were used.
*/
class FwdTransactionTracker {
public:
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(FwdTransactionTracker)
static already_AddRefed<FwdTransactionTracker> GetOrCreate(
RefPtr<FwdTransactionTracker>& aTracker) {
if (!aTracker) {
aTracker = new FwdTransactionTracker;
}
return do_AddRef(aTracker);
}
bool IsUsed() const { return mFwdTransactionType && mFwdTransactionId; }
void Use(const FwdTransactionCounter& aCounter) {
mFwdTransactionType = aCounter.mFwdTransactionType;
mFwdTransactionId = aCounter.mFwdTransactionId;
}
Atomic<mozilla::ipc::ProtocolId> mFwdTransactionType{
(mozilla::ipc::ProtocolId)0};
Atomic<uint64_t> mFwdTransactionId{0};
private:
FwdTransactionTracker() = default;
~FwdTransactionTracker() = default;
};
inline RemoteTextureTxnType ToRemoteTextureTxnType(
const RefPtr<FwdTransactionTracker>& aTracker) {
return aTracker ? (RemoteTextureTxnType)aTracker->mFwdTransactionType : 0;
}
inline RemoteTextureTxnId ToRemoteTextureTxnId(
const RefPtr<FwdTransactionTracker>& aTracker) {
return aTracker ? (RemoteTextureTxnId)aTracker->mFwdTransactionId : 0;
}
/**
* A transaction is a set of changes that happenned on the content side, that
* should be sent to the compositor side.
* CompositableForwarder is an interface to manage a transaction of
* compositable objetcs.
*
* ShadowLayerForwarder is an example of a CompositableForwarder (that can
* additionally forward modifications of the Layer tree).
* ImageBridgeChild is another CompositableForwarder.
*
* CompositableForwarder implements KnowsCompositor for simplicity as all
* implementations of CompositableForwarder currently also implement
* KnowsCompositor. This dependency could be split if we add new use cases.
*/
class CompositableForwarder : public KnowsCompositor {
public:
CompositableForwarder();
~CompositableForwarder();
/**
* Setup the IPDL actor for aCompositable to be part of layers
* transactions.
*/
virtual void Connect(CompositableClient* aCompositable,
ImageContainer* aImageContainer = nullptr) = 0;
virtual void ReleaseCompositable(const CompositableHandle& aHandle) = 0;
virtual bool DestroyInTransaction(PTextureChild* aTexture) = 0;
/**
* Tell the CompositableHost on the compositor side to remove the texture
* from the CompositableHost.
* This function does not delete the TextureHost corresponding to the
* TextureClient passed in parameter.
* When the TextureClient has TEXTURE_DEALLOCATE_CLIENT flag,
* the transaction becomes synchronous.
*/
virtual void RemoveTextureFromCompositable(CompositableClient* aCompositable,
TextureClient* aTexture) = 0;
struct TimedTextureClient {
TimedTextureClient()
: mTextureClient(nullptr), mFrameID(0), mProducerID(0) {}
TextureClient* mTextureClient;
TimeStamp mTimeStamp;
nsIntRect mPictureRect;
int32_t mFrameID;
int32_t mProducerID;
};
/**
* Tell the CompositableHost on the compositor side what textures to use for
* the next composition.
*/
virtual void UseTextures(CompositableClient* aCompositable,
const nsTArray<TimedTextureClient>& aTextures) = 0;
virtual void UseRemoteTexture(
CompositableClient* aCompositable, const RemoteTextureId aTextureId,
const RemoteTextureOwnerId aOwnerId, const gfx::IntSize aSize,
const TextureFlags aFlags,
const RefPtr<layers::FwdTransactionTracker>& aTracker) = 0;
void UpdateFwdTransactionId() {
++GetFwdTransactionCounter().mFwdTransactionId;
}
uint64_t GetFwdTransactionId() {
return GetFwdTransactionCounter().mFwdTransactionId;
}
mozilla::ipc::ProtocolId GetFwdTransactionType() {
return GetFwdTransactionCounter().mFwdTransactionType;
}
virtual bool InForwarderThread() = 0;
void AssertInForwarderThread() { MOZ_ASSERT(InForwarderThread()); }
protected:
virtual FwdTransactionCounter& GetFwdTransactionCounter() = 0;
void TrackFwdTransaction(const RefPtr<FwdTransactionTracker>& aTracker) {
if (aTracker) {
aTracker->Use(GetFwdTransactionCounter());
}
}
nsTArray<RefPtr<TextureClient>> mTexturesToRemove;
nsTArray<RefPtr<CompositableClient>> mCompositableClientsToRemove;
};
} // namespace layers
} // namespace mozilla
#endif
|
