• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef ROSEN_RENDER_SERVICE_BASE_COMMAND_RS_SURFACE_NODE_COMMAND_H
17 #define ROSEN_RENDER_SERVICE_BASE_COMMAND_RS_SURFACE_NODE_COMMAND_H
18 
19 #include "command/rs_command_templates.h"
20 #include "common/rs_macros.h"
21 #include "common/rs_vector4.h"
22 #include "platform/common/rs_surface_ext.h"
23 #include "surface_type.h"
24 
25 #include "utils/matrix.h"
26 #include "utils/rect.h"
27 
28 namespace OHOS {
29 namespace Rosen {
30 
31 enum RSSurfaceNodeCommandType : uint16_t {
32     SURFACE_NODE_CREATE,
33     SURFACE_NODE_CREATE_WITH_CONFIG,
34     SURFACE_NODE_SET_CONTEXT_MATRIX,
35     SURFACE_NODE_SET_CONTEXT_ALPHA,
36     SURFACE_NODE_SET_CONTEXT_CLIP_REGION,
37     SURFACE_NODE_SET_SECURITY_LAYER,
38     SURFACE_NODE_SET_SKIP_LAYER,
39     SURFACE_NODE_SET_SNAPSHOT_SKIP_LAYER,
40     SURFACE_NODE_SET_FINGERPRINT,
41     SURFACE_NODE_SET_COLOR_SPACE,
42     SURFACE_NODE_UPDATE_SURFACE_SIZE,
43     SURFACE_NODE_CONNECT_TO_NODE_IN_RENDER_SERVICE,
44     SURFACE_NODE_SET_CALLBACK_FOR_RENDER_THREAD,
45     SURFACE_NODE_SET_CONTEXT_BOUNDS,
46     SURFACE_NODE_SET_ABILITY_BG_ALPHA,
47     SURFACE_NODE_SET_IS_NOTIFY_BUFFER_AVAILABLE,
48     SURFACE_NODE_SET_SURFACE_NODE_TYPE,
49     SURFACE_NODE_SET_CONTAINER_WINDOW,
50     SURFACE_NODE_SET_ANIMATION_FINISHED,
51     SURFACE_NODE_MARK_UIHIDDEN,
52     SURFACE_NODE_SET_IS_TEXTURE_EXPORT_NODE,
53     SURFACE_NODE_ATTACH_TO_DISPLAY,
54     SURFACE_NODE_DETACH_TO_DISPLAY,
55     SURFACE_NODE_SET_FORCE_HARDWARE_AND_FIX_ROTATION,
56     SURFACE_NODE_SET_BOOT_ANIMATION,
57     SURFACE_NODE_CREATE_SURFACE_EXT,
58     SURFACE_NODE_SET_FOREGROUND,
59     SURFACE_NODE_SET_SURFACE_ID,
60     SURFACE_NODE_SET_FORCE_UIFIRST,
61     SURFACE_NODE_SET_ANCO_FLAGS,
62     SURFACE_NODE_SET_HDR_PRESENT,
63     SURFACE_NODE_SET_SKIP_DRAW,
64     SURFACE_NODE_SET_ABILITY_STATE,
65     SURFACE_NODE_SET_LEASH_PERSISTENT_ID,
66     SURFACE_NODE_SET_API_COMPATIBLE_VERSION,
67     SURFACE_NODE_ATTACH_TO_WINDOW_CONTAINER,
68     SURFACE_NODE_DETACH_FROM_WINDOW_CONTAINER,
69 };
70 
71 class RSB_EXPORT SurfaceNodeCommandHelper {
72 public:
73     static void Create(RSContext& context, NodeId nodeId,
74         RSSurfaceNodeType surfaceNodeType = RSSurfaceNodeType::DEFAULT, bool isTextureExportNode = false);
75     static void CreateWithConfig(
76         RSContext& context, NodeId nodeId, std::string name, uint8_t type,
77         std::string bundleName, enum SurfaceWindowType surfaceWindowType);
78     static std::shared_ptr<RSSurfaceRenderNode> CreateWithConfigInRS(
79         const RSSurfaceRenderNodeConfig& config, RSContext& context, bool unobscured = false);
80     static void SetContextMatrix(RSContext& context, NodeId nodeId, const std::optional<Drawing::Matrix>& matrix);
81     static void SetContextAlpha(RSContext& context, NodeId nodeId, float alpha);
82     static void SetContextClipRegion(RSContext& context, NodeId nodeId, const std::optional<Drawing::Rect>& clipRect);
83     static void SetSecurityLayer(RSContext& context, NodeId nodeId, bool isSecurityLayer);
84     static void SetLeashPersistentId(RSContext& context, NodeId nodeId, uint64_t leashPersistentId);
85     static void SetSkipLayer(RSContext& context, NodeId nodeId, bool isSkipLayer);
86     static void SetSnapshotSkipLayer(RSContext& context, NodeId nodeId, bool isSnapshotSkipLayer);
87     static void SetFingerprint(RSContext& context, NodeId nodeId, bool hasFingerprint);
88     static void SetColorSpace(RSContext& context, NodeId nodeId, GraphicColorGamut colorSpace);
89     static void UpdateSurfaceDefaultSize(RSContext& context, NodeId nodeId, float width, float height);
90     static void ConnectToNodeInRenderService(RSContext& context, NodeId id);
91     static void SetCallbackForRenderThreadRefresh(RSContext& context, NodeId id, bool isRefresh);
92     static void SetContextBounds(RSContext& context, NodeId id, Vector4f bounds);
93     static void SetIsTextureExportNode(RSContext& context, NodeId id, bool isTextureExportNode);
94     static void SetAbilityBGAlpha(RSContext& context, NodeId id, uint8_t alpha);
95     static void SetIsNotifyUIBufferAvailable(RSContext& context, NodeId nodeId, bool available);
96     static void MarkUIHidden(RSContext& context, NodeId nodeId, bool isHidden);
97     static void SetSurfaceNodeType(RSContext& context, NodeId nodeId, uint8_t surfaceNodeType);
98     static void SetContainerWindow(RSContext& context, NodeId nodeId, bool hasContainerWindow, float density);
99     static void SetAnimationFinished(RSContext& context, NodeId nodeId);
100     static void AttachToDisplay(RSContext& context, NodeId nodeId, uint64_t screenId);
101     static void DetachToDisplay(RSContext& context, NodeId nodeId, uint64_t screenId);
102     static void SetBootAnimation(RSContext& context, NodeId nodeId, bool isBootAnimation);
103     static void SetForceHardwareAndFixRotation(RSContext& context, NodeId nodeId, bool flag);
104 #ifdef USE_SURFACE_TEXTURE
105     static void CreateSurfaceExt(RSContext& context, NodeId id, const std::shared_ptr<RSSurfaceTexture>& surfaceExt);
106 #endif
107     static void SetForeground(RSContext& context, NodeId nodeId, bool isForeground);
108     static void SetSurfaceId(RSContext& context, NodeId nodeId, SurfaceId surfaceId);
109     static void SetForceUIFirst(RSContext& context, NodeId nodeId, bool forceUIFirst);
110     static void SetAncoFlags(RSContext& context, NodeId nodeId, uint32_t flags);
111     static void SetHDRPresent(RSContext& context, NodeId nodeId, bool hdrPresent);
112     static void SetSkipDraw(RSContext& context, NodeId nodeId, bool skip);
113     static void SetAbilityState(RSContext& context, NodeId nodeId, RSSurfaceNodeAbilityState abilityState);
114     static void SetApiCompatibleVersion(RSContext& context, NodeId nodeId, uint32_t apiCompatibleVersion);
115     static void AttachToWindowContainer(RSContext& context, NodeId nodeId, ScreenId screenId);
116     static void DetachFromWindowContainer(RSContext& context, NodeId nodeId, ScreenId screenId);
117 };
118 
119 ADD_COMMAND(RSSurfaceNodeCreate,
120     ARG(SURFACE_NODE, SURFACE_NODE_CREATE, SurfaceNodeCommandHelper::Create, NodeId, RSSurfaceNodeType, bool))
121 ADD_COMMAND(RSSurfaceNodeCreateWithConfig,
122     ARG(SURFACE_NODE, SURFACE_NODE_CREATE_WITH_CONFIG, SurfaceNodeCommandHelper::CreateWithConfig, NodeId, std::string,
123         uint8_t, std::string, enum SurfaceWindowType))
124 ADD_COMMAND(RSSurfaceNodeSetContextMatrix, ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_MATRIX,
125     SurfaceNodeCommandHelper::SetContextMatrix, NodeId, std::optional<Drawing::Matrix>))
126 ADD_COMMAND(RSSurfaceNodeSetContextAlpha,
127     ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_ALPHA, SurfaceNodeCommandHelper::SetContextAlpha, NodeId, float))
128 ADD_COMMAND(RSSurfaceNodeSetContextClipRegion, ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_CLIP_REGION,
129     SurfaceNodeCommandHelper::SetContextClipRegion, NodeId, std::optional<Drawing::Rect>))
130 ADD_COMMAND(RSSurfaceNodeSetHardwareAndFixRotation, ARG(SURFACE_NODE, SURFACE_NODE_SET_FORCE_HARDWARE_AND_FIX_ROTATION,
131     SurfaceNodeCommandHelper::SetForceHardwareAndFixRotation, NodeId, bool))
132 ADD_COMMAND(RSSurfaceNodeSetBootAnimation,
133     ARG(SURFACE_NODE, SURFACE_NODE_SET_BOOT_ANIMATION, SurfaceNodeCommandHelper::SetBootAnimation, NodeId, bool))
134 ADD_COMMAND(RSSurfaceNodeSetSecurityLayer,
135     ARG(SURFACE_NODE, SURFACE_NODE_SET_SECURITY_LAYER, SurfaceNodeCommandHelper::SetSecurityLayer, NodeId, bool))
136 ADD_COMMAND(RSSurfaceNodeSetSkipLayer,
137     ARG(SURFACE_NODE, SURFACE_NODE_SET_SKIP_LAYER, SurfaceNodeCommandHelper::SetSkipLayer, NodeId, bool))
138 ADD_COMMAND(RSSurfaceNodeSetSnapshotSkipLayer, ARG(SURFACE_NODE, SURFACE_NODE_SET_SNAPSHOT_SKIP_LAYER,
139     SurfaceNodeCommandHelper::SetSnapshotSkipLayer, NodeId, bool))
140 ADD_COMMAND(RSSurfaceNodeSetFingerprint,
141     ARG(SURFACE_NODE, SURFACE_NODE_SET_FINGERPRINT, SurfaceNodeCommandHelper::SetFingerprint, NodeId, bool))
142 ADD_COMMAND(RSSurfaceNodeUpdateSurfaceDefaultSize, ARG(SURFACE_NODE, SURFACE_NODE_UPDATE_SURFACE_SIZE,
143     SurfaceNodeCommandHelper::UpdateSurfaceDefaultSize, NodeId, float, float))
144 ADD_COMMAND(RSSurfaceNodeConnectToNodeInRenderService,
145     ARG(SURFACE_NODE, SURFACE_NODE_CONNECT_TO_NODE_IN_RENDER_SERVICE,
146     SurfaceNodeCommandHelper::ConnectToNodeInRenderService, NodeId))
147 ADD_COMMAND(RSSurfaceNodeSetCallbackForRenderThreadRefresh,
148     ARG(SURFACE_NODE, SURFACE_NODE_SET_CALLBACK_FOR_RENDER_THREAD,
149     SurfaceNodeCommandHelper::SetCallbackForRenderThreadRefresh, NodeId, bool))
150 ADD_COMMAND(RSSurfaceNodeSetBounds,
151     ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_BOUNDS, SurfaceNodeCommandHelper::SetContextBounds, NodeId, Vector4f))
152 ADD_COMMAND(RSSurfaceNodeSetAbilityBGAlpha,
153     ARG(SURFACE_NODE, SURFACE_NODE_SET_ABILITY_BG_ALPHA, SurfaceNodeCommandHelper::SetAbilityBGAlpha, NodeId, uint8_t))
154 ADD_COMMAND(RSSurfaceNodeSetIsNotifyUIBufferAvailable,
155     ARG(SURFACE_NODE, SURFACE_NODE_SET_IS_NOTIFY_BUFFER_AVAILABLE,
156     SurfaceNodeCommandHelper::SetIsNotifyUIBufferAvailable, NodeId, bool))
157 ADD_COMMAND(RSSurfaceNodeMarkUIHidden,
158     ARG(SURFACE_NODE, SURFACE_NODE_MARK_UIHIDDEN, SurfaceNodeCommandHelper::MarkUIHidden, NodeId, bool))
159 ADD_COMMAND(RSSurfaceNodeSetIsTextureExportNode,
160     ARG(SURFACE_NODE, SURFACE_NODE_SET_IS_TEXTURE_EXPORT_NODE,
161     SurfaceNodeCommandHelper::SetIsTextureExportNode, NodeId, bool))
162 ADD_COMMAND(RSSurfaceNodeSetSurfaceNodeType,
163     ARG(SURFACE_NODE, SURFACE_NODE_SET_SURFACE_NODE_TYPE,
164     SurfaceNodeCommandHelper::SetSurfaceNodeType, NodeId, uint8_t))
165 ADD_COMMAND(RSSurfaceNodeSetContainerWindow,
166     ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTAINER_WINDOW, SurfaceNodeCommandHelper::SetContainerWindow,
167     NodeId, bool, float))
168 ADD_COMMAND(RSSurfaceNodeSetAnimationFinished,
169     ARG(SURFACE_NODE, SURFACE_NODE_SET_ANIMATION_FINISHED, SurfaceNodeCommandHelper::SetAnimationFinished, NodeId))
170 ADD_COMMAND(RSSurfaceNodeAttachToDisplay,
171     ARG(SURFACE_NODE, SURFACE_NODE_ATTACH_TO_DISPLAY, SurfaceNodeCommandHelper::AttachToDisplay, NodeId, uint64_t))
172 ADD_COMMAND(RSSurfaceNodeDetachToDisplay,
173     ARG(SURFACE_NODE, SURFACE_NODE_DETACH_TO_DISPLAY, SurfaceNodeCommandHelper::DetachToDisplay, NodeId, uint64_t))
174 ADD_COMMAND(RSSurfaceNodeSetColorSpace,
175     ARG(SURFACE_NODE, SURFACE_NODE_SET_COLOR_SPACE, SurfaceNodeCommandHelper::SetColorSpace, NodeId, GraphicColorGamut))
176 ADD_COMMAND(RSurfaceNodeSetSurfaceId,
177     ARG(SURFACE_NODE, SURFACE_NODE_SET_SURFACE_ID, SurfaceNodeCommandHelper::SetSurfaceId, NodeId, SurfaceId))
178 ADD_COMMAND(RSurfaceNodeSetLeashPersistentId,
179     ARG(SURFACE_NODE, SURFACE_NODE_SET_LEASH_PERSISTENT_ID,
180     SurfaceNodeCommandHelper::SetLeashPersistentId, NodeId, LeashPersistentId))
181 
182 #ifdef USE_SURFACE_TEXTURE
183 ADD_COMMAND(RSSurfaceNodeCreateSurfaceExt,
184     ARG(SURFACE_NODE, SURFACE_NODE_CREATE_SURFACE_EXT,
185     SurfaceNodeCommandHelper::CreateSurfaceExt, NodeId, std::shared_ptr<RSSurfaceTexture>))
186 #endif
187 ADD_COMMAND(RSSurfaceNodeSetForeground,
188     ARG(SURFACE_NODE, SURFACE_NODE_SET_FOREGROUND, SurfaceNodeCommandHelper::SetForeground, NodeId, bool))
189 ADD_COMMAND(RSSurfaceNodeSetForceUIFirst,
190     ARG(SURFACE_NODE, SURFACE_NODE_SET_FORCE_UIFIRST, SurfaceNodeCommandHelper::SetForceUIFirst, NodeId, bool))
191 ADD_COMMAND(RSSurfaceNodeSetAncoFlags,
192     ARG(SURFACE_NODE, SURFACE_NODE_SET_ANCO_FLAGS, SurfaceNodeCommandHelper::SetAncoFlags, NodeId, uint32_t))
193 ADD_COMMAND(RSSurfaceNodeSetHDRPresent,
194     ARG(SURFACE_NODE, SURFACE_NODE_SET_HDR_PRESENT, SurfaceNodeCommandHelper::SetHDRPresent, NodeId, bool))
195 ADD_COMMAND(RSSurfaceNodeSetSkipDraw,
196     ARG(SURFACE_NODE, SURFACE_NODE_SET_SKIP_DRAW, SurfaceNodeCommandHelper::SetSkipDraw, NodeId, bool))
197 ADD_COMMAND(RSSurfaceNodeSetAbilityState,
198     ARG(SURFACE_NODE, SURFACE_NODE_SET_ABILITY_STATE, SurfaceNodeCommandHelper::SetAbilityState,
199     NodeId, RSSurfaceNodeAbilityState))
200 ADD_COMMAND(
201     RSSurfaceNodeSetApiCompatibleVersion, ARG(SURFACE_NODE, SURFACE_NODE_SET_API_COMPATIBLE_VERSION,
202                                               SurfaceNodeCommandHelper::SetApiCompatibleVersion, NodeId, uint32_t))
203 ADD_COMMAND(RSSurfaceNodeAttachToWindowContainer,
204     ARG(SURFACE_NODE, SURFACE_NODE_ATTACH_TO_WINDOW_CONTAINER,
205         SurfaceNodeCommandHelper::AttachToWindowContainer, NodeId, ScreenId))
206 ADD_COMMAND(RSSurfaceNodeDetachFromWindowContainer,
207     ARG(SURFACE_NODE, SURFACE_NODE_DETACH_FROM_WINDOW_CONTAINER,
208         SurfaceNodeCommandHelper::DetachFromWindowContainer, NodeId, ScreenId))
209 } // namespace Rosen
210 } // namespace OHOS
211 #endif // ROSEN_RENDER_SERVICE_BASE_COMMAND_RS_SURFACE_NODE_COMMAND_H
212