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_FINGERPRINT,
40     SURFACE_NODE_SET_COLOR_SPACE,
41     SURFACE_NODE_UPDATE_SURFACE_SIZE,
42     SURFACE_NODE_CONNECT_TO_NODE_IN_RENDER_SERVICE,
43     SURFACE_NODE_SET_CALLBACK_FOR_RENDER_THREAD,
44     SURFACE_NODE_SET_CONTEXT_BOUNDS,
45     SURFACE_NODE_SET_ABILITY_BG_ALPHA,
46     SURFACE_NODE_SET_IS_NOTIFY_BUFFER_AVAILABLE,
47     SURFACE_NODE_SET_SURFACE_NODE_TYPE,
48     SURFACE_NODE_SET_CONTAINER_WINDOW,
49     SURFACE_NODE_SET_ANIMATION_FINISHED,
50     SURFACE_NODE_MARK_UIHIDDEN,
51     SURFACE_NODE_SET_IS_TEXTURE_EXPORT_NODE,
52     SURFACE_NODE_ATTACH_TO_DISPLAY,
53     SURFACE_NODE_DETACH_TO_DISPLAY,
54     SURFACE_NODE_SET_FORCE_HARDWARE_AND_FIX_ROTATION,
55     SURFACE_NODE_SET_BOOT_ANIMATION,
56     SURFACE_NODE_CREATE_SURFACE_EXT,
57     SURFACE_NODE_SET_FOREGROUND,
58     SURFACE_NODE_SET_SURFACE_ID,
59     SURFACE_NODE_SET_FORCE_UIFIRST,
60     SURFACE_NODE_SET_ANCO_FLAGS,
61     SURFACE_NODE_SET_HDR_PRESENT,
62     SURFACE_NODE_SET_SKIP_DRAW,
63     SURFACE_NODE_SET_ABILITY_STATE,
64     SURFACE_NODE_SET_LEASH_PERSISTENT_ID,
65     SURFACE_NODE_SET_API_COMPATIBLE_VERSION,
66 };
67 
68 class RSB_EXPORT SurfaceNodeCommandHelper {
69 public:
70     static void Create(RSContext& context, NodeId nodeId,
71         RSSurfaceNodeType surfaceNodeType = RSSurfaceNodeType::DEFAULT, bool isTextureExportNode = false);
72     static void CreateWithConfig(
73         RSContext& context, NodeId nodeId, std::string name, uint8_t type,
74         std::string bundleName, enum SurfaceWindowType surfaceWindowType);
75     static std::shared_ptr<RSSurfaceRenderNode> CreateWithConfigInRS(
76         const RSSurfaceRenderNodeConfig& config, RSContext& context);
77     static void SetContextMatrix(RSContext& context, NodeId nodeId, const std::optional<Drawing::Matrix>& matrix);
78     static void SetContextAlpha(RSContext& context, NodeId nodeId, float alpha);
79     static void SetContextClipRegion(RSContext& context, NodeId nodeId, const std::optional<Drawing::Rect>& clipRect);
80     static void SetSecurityLayer(RSContext& context, NodeId nodeId, bool isSecurityLayer);
81     static void SetLeashPersistentId(RSContext& context, NodeId nodeId, uint64_t leashPersistentId);
82     static void SetSkipLayer(RSContext& context, NodeId nodeId, bool isSkipLayer);
83     static void SetFingerprint(RSContext& context, NodeId nodeId, bool hasFingerprint);
84     static void SetColorSpace(RSContext& context, NodeId nodeId, GraphicColorGamut colorSpace);
85     static void UpdateSurfaceDefaultSize(RSContext& context, NodeId nodeId, float width, float height);
86     static void ConnectToNodeInRenderService(RSContext& context, NodeId id);
87     static void SetCallbackForRenderThreadRefresh(RSContext& context, NodeId id, bool isRefresh);
88     static void SetContextBounds(RSContext& context, NodeId id, Vector4f bounds);
89     static void SetIsTextureExportNode(RSContext& context, NodeId id, bool isTextureExportNode);
90     static void SetAbilityBGAlpha(RSContext& context, NodeId id, uint8_t alpha);
91     static void SetIsNotifyUIBufferAvailable(RSContext& context, NodeId nodeId, bool available);
92     static void MarkUIHidden(RSContext& context, NodeId nodeId, bool isHidden);
93     static void SetSurfaceNodeType(RSContext& context, NodeId nodeId, uint8_t surfaceNodeType);
94     static void SetContainerWindow(RSContext& context, NodeId nodeId, bool hasContainerWindow, float density);
95     static void SetAnimationFinished(RSContext& context, NodeId nodeId);
96     static void AttachToDisplay(RSContext& context, NodeId nodeId, uint64_t screenId);
97     static void DetachToDisplay(RSContext& context, NodeId nodeId, uint64_t screenId);
98     static void SetBootAnimation(RSContext& context, NodeId nodeId, bool isBootAnimation);
99     static void SetForceHardwareAndFixRotation(RSContext& context, NodeId nodeId, bool flag);
100 #ifdef USE_SURFACE_TEXTURE
101     static void CreateSurfaceExt(RSContext& context, NodeId id, const std::shared_ptr<RSSurfaceTexture>& surfaceExt);
102 #endif
103     static void SetForeground(RSContext& context, NodeId nodeId, bool isForeground);
104     static void SetSurfaceId(RSContext& context, NodeId nodeId, SurfaceId surfaceId);
105     static void SetForceUIFirst(RSContext& context, NodeId nodeId, bool forceUIFirst);
106     static void SetAncoFlags(RSContext& context, NodeId nodeId, uint32_t flags);
107     static void SetHDRPresent(RSContext& context, NodeId nodeId, bool hdrPresent);
108     static void SetSkipDraw(RSContext& context, NodeId nodeId, bool skip);
109     static void SetAbilityState(RSContext& context, NodeId nodeId, RSSurfaceNodeAbilityState abilityState);
110     static void SetApiCompatibleVersion(RSContext& context, NodeId nodeId, uint32_t apiCompatibleVersion);
111 };
112 
113 ADD_COMMAND(RSSurfaceNodeCreate,
114     ARG(SURFACE_NODE, SURFACE_NODE_CREATE, SurfaceNodeCommandHelper::Create, NodeId, RSSurfaceNodeType, bool))
115 ADD_COMMAND(RSSurfaceNodeCreateWithConfig,
116     ARG(SURFACE_NODE, SURFACE_NODE_CREATE_WITH_CONFIG, SurfaceNodeCommandHelper::CreateWithConfig, NodeId, std::string,
117         uint8_t, std::string, enum SurfaceWindowType))
118 ADD_COMMAND(RSSurfaceNodeSetContextMatrix, ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_MATRIX,
119     SurfaceNodeCommandHelper::SetContextMatrix, NodeId, std::optional<Drawing::Matrix>))
120 ADD_COMMAND(RSSurfaceNodeSetContextAlpha,
121     ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_ALPHA, SurfaceNodeCommandHelper::SetContextAlpha, NodeId, float))
122 ADD_COMMAND(RSSurfaceNodeSetContextClipRegion, ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_CLIP_REGION,
123     SurfaceNodeCommandHelper::SetContextClipRegion, NodeId, std::optional<Drawing::Rect>))
124 ADD_COMMAND(RSSurfaceNodeSetHardwareAndFixRotation, ARG(SURFACE_NODE, SURFACE_NODE_SET_FORCE_HARDWARE_AND_FIX_ROTATION,
125     SurfaceNodeCommandHelper::SetForceHardwareAndFixRotation, NodeId, bool))
126 ADD_COMMAND(RSSurfaceNodeSetBootAnimation,
127     ARG(SURFACE_NODE, SURFACE_NODE_SET_BOOT_ANIMATION, SurfaceNodeCommandHelper::SetBootAnimation, NodeId, bool))
128 ADD_COMMAND(RSSurfaceNodeSetSecurityLayer,
129     ARG(SURFACE_NODE, SURFACE_NODE_SET_SECURITY_LAYER, SurfaceNodeCommandHelper::SetSecurityLayer, NodeId, bool))
130 ADD_COMMAND(RSSurfaceNodeSetSkipLayer,
131     ARG(SURFACE_NODE, SURFACE_NODE_SET_SKIP_LAYER, SurfaceNodeCommandHelper::SetSkipLayer, NodeId, bool))
132 ADD_COMMAND(RSSurfaceNodeSetFingerprint,
133     ARG(SURFACE_NODE, SURFACE_NODE_SET_FINGERPRINT, SurfaceNodeCommandHelper::SetFingerprint, NodeId, bool))
134 ADD_COMMAND(RSSurfaceNodeUpdateSurfaceDefaultSize, ARG(SURFACE_NODE, SURFACE_NODE_UPDATE_SURFACE_SIZE,
135     SurfaceNodeCommandHelper::UpdateSurfaceDefaultSize, NodeId, float, float))
136 ADD_COMMAND(RSSurfaceNodeConnectToNodeInRenderService,
137     ARG(SURFACE_NODE, SURFACE_NODE_CONNECT_TO_NODE_IN_RENDER_SERVICE,
138     SurfaceNodeCommandHelper::ConnectToNodeInRenderService, NodeId))
139 ADD_COMMAND(RSSurfaceNodeSetCallbackForRenderThreadRefresh,
140     ARG(SURFACE_NODE, SURFACE_NODE_SET_CALLBACK_FOR_RENDER_THREAD,
141     SurfaceNodeCommandHelper::SetCallbackForRenderThreadRefresh, NodeId, bool))
142 ADD_COMMAND(RSSurfaceNodeSetBounds,
143     ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTEXT_BOUNDS, SurfaceNodeCommandHelper::SetContextBounds, NodeId, Vector4f))
144 ADD_COMMAND(RSSurfaceNodeSetAbilityBGAlpha,
145     ARG(SURFACE_NODE, SURFACE_NODE_SET_ABILITY_BG_ALPHA, SurfaceNodeCommandHelper::SetAbilityBGAlpha, NodeId, uint8_t))
146 ADD_COMMAND(RSSurfaceNodeSetIsNotifyUIBufferAvailable,
147     ARG(SURFACE_NODE, SURFACE_NODE_SET_IS_NOTIFY_BUFFER_AVAILABLE,
148     SurfaceNodeCommandHelper::SetIsNotifyUIBufferAvailable, NodeId, bool))
149 ADD_COMMAND(RSSurfaceNodeMarkUIHidden,
150     ARG(SURFACE_NODE, SURFACE_NODE_MARK_UIHIDDEN, SurfaceNodeCommandHelper::MarkUIHidden, NodeId, bool))
151 ADD_COMMAND(RSSurfaceNodeSetIsTextureExportNode,
152     ARG(SURFACE_NODE, SURFACE_NODE_SET_IS_TEXTURE_EXPORT_NODE,
153     SurfaceNodeCommandHelper::SetIsTextureExportNode, NodeId, bool))
154 ADD_COMMAND(RSSurfaceNodeSetSurfaceNodeType,
155     ARG(SURFACE_NODE, SURFACE_NODE_SET_SURFACE_NODE_TYPE,
156     SurfaceNodeCommandHelper::SetSurfaceNodeType, NodeId, uint8_t))
157 ADD_COMMAND(RSSurfaceNodeSetContainerWindow,
158     ARG(SURFACE_NODE, SURFACE_NODE_SET_CONTAINER_WINDOW, SurfaceNodeCommandHelper::SetContainerWindow,
159     NodeId, bool, float))
160 ADD_COMMAND(RSSurfaceNodeSetAnimationFinished,
161     ARG(SURFACE_NODE, SURFACE_NODE_SET_ANIMATION_FINISHED, SurfaceNodeCommandHelper::SetAnimationFinished, NodeId))
162 ADD_COMMAND(RSSurfaceNodeAttachToDisplay,
163     ARG(SURFACE_NODE, SURFACE_NODE_ATTACH_TO_DISPLAY, SurfaceNodeCommandHelper::AttachToDisplay, NodeId, uint64_t))
164 ADD_COMMAND(RSSurfaceNodeDetachToDisplay,
165     ARG(SURFACE_NODE, SURFACE_NODE_DETACH_TO_DISPLAY, SurfaceNodeCommandHelper::DetachToDisplay, NodeId, uint64_t))
166 ADD_COMMAND(RSSurfaceNodeSetColorSpace,
167     ARG(SURFACE_NODE, SURFACE_NODE_SET_COLOR_SPACE, SurfaceNodeCommandHelper::SetColorSpace, NodeId, GraphicColorGamut))
168 ADD_COMMAND(RSurfaceNodeSetSurfaceId,
169     ARG(SURFACE_NODE, SURFACE_NODE_SET_SURFACE_ID, SurfaceNodeCommandHelper::SetSurfaceId, NodeId, SurfaceId))
170 ADD_COMMAND(RSurfaceNodeSetLeashPersistentId,
171     ARG(SURFACE_NODE, SURFACE_NODE_SET_LEASH_PERSISTENT_ID,
172     SurfaceNodeCommandHelper::SetLeashPersistentId, NodeId, LeashPersistentId))
173 
174 #ifdef USE_SURFACE_TEXTURE
175 ADD_COMMAND(RSSurfaceNodeCreateSurfaceExt,
176     ARG(SURFACE_NODE, SURFACE_NODE_CREATE_SURFACE_EXT,
177     SurfaceNodeCommandHelper::CreateSurfaceExt, NodeId, std::shared_ptr<RSSurfaceTexture>))
178 #endif
179 ADD_COMMAND(RSSurfaceNodeSetForeground,
180     ARG(SURFACE_NODE, SURFACE_NODE_SET_FOREGROUND, SurfaceNodeCommandHelper::SetForeground, NodeId, bool))
181 ADD_COMMAND(RSSurfaceNodeSetForceUIFirst,
182     ARG(SURFACE_NODE, SURFACE_NODE_SET_FORCE_UIFIRST, SurfaceNodeCommandHelper::SetForceUIFirst, NodeId, bool))
183 ADD_COMMAND(RSSurfaceNodeSetAncoFlags,
184     ARG(SURFACE_NODE, SURFACE_NODE_SET_ANCO_FLAGS, SurfaceNodeCommandHelper::SetAncoFlags, NodeId, uint32_t))
185 ADD_COMMAND(RSSurfaceNodeSetHDRPresent,
186     ARG(SURFACE_NODE, SURFACE_NODE_SET_HDR_PRESENT, SurfaceNodeCommandHelper::SetHDRPresent, NodeId, bool))
187 ADD_COMMAND(RSSurfaceNodeSetSkipDraw,
188     ARG(SURFACE_NODE, SURFACE_NODE_SET_SKIP_DRAW, SurfaceNodeCommandHelper::SetSkipDraw, NodeId, bool))
189 ADD_COMMAND(RSSurfaceNodeSetAbilityState,
190     ARG(SURFACE_NODE, SURFACE_NODE_SET_ABILITY_STATE, SurfaceNodeCommandHelper::SetAbilityState,
191     NodeId, RSSurfaceNodeAbilityState))
192 ADD_COMMAND(
193     RSSurfaceNodeSetApiCompatibleVersion, ARG(SURFACE_NODE, SURFACE_NODE_SET_API_COMPATIBLE_VERSION,
194                                               SurfaceNodeCommandHelper::SetApiCompatibleVersion, NodeId, uint32_t))
195 } // namespace Rosen
196 } // namespace OHOS
197 #endif // ROSEN_RENDER_SERVICE_BASE_COMMAND_RS_SURFACE_NODE_COMMAND_H
198