• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2022 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 RS_SCREEN
17 #define RS_SCREEN
18 
19 #include <memory>
20 #include <mutex>
21 #include <optional>
22 #include <unordered_set>
23 
24 #include <common/rs_rect.h>
25 #include <surface_type.h>
26 #include <hdi_output.h>
27 #include <hdi_screen.h>
28 #include <hdi_display_type.h>
29 #include <screen_manager/screen_types.h>
30 
31 namespace OHOS {
32 namespace Rosen {
33 struct VirtualScreenConfigs {
34     ScreenId id = INVALID_SCREEN_ID;
35     ScreenId mirrorId = INVALID_SCREEN_ID;
36     std::string name;
37     uint32_t width = 0;
38     uint32_t height = 0;
39     sptr<Surface> surface = nullptr;
40     GraphicPixelFormat pixelFormat = GRAPHIC_PIXEL_FMT_RGBA_8888;
41     int32_t flags = 0; // reserve flag.
42     std::unordered_set<uint64_t> whiteList = {};
43     std::unordered_set<uint64_t> blackListSet = {};
44 };
45 
46 class RSScreen {
47 public:
48     RSScreen() = default;
49     virtual ~RSScreen() noexcept = default;
50 
51     virtual ScreenId Id() const = 0;
52     virtual ScreenId MirrorId() const = 0;
53     virtual void SetMirror(ScreenId mirrorId) = 0;
54     virtual const std::string& Name() const = 0;
55     virtual uint32_t Width() const = 0;
56     virtual uint32_t Height() const = 0;
57     virtual uint32_t PhyWidth() const = 0;
58     virtual uint32_t PhyHeight() const = 0;
59     virtual bool IsSamplingOn() const = 0;
60     virtual float GetSamplingTranslateX() const = 0;
61     virtual float GetSamplingTranslateY() const = 0;
62     virtual float GetSamplingScale() const = 0;
63     virtual RectI GetActiveRect() const = 0;
64     virtual bool IsEnable() const = 0;
65     virtual bool IsVirtual() const = 0;
66     virtual void SetActiveMode(uint32_t modeId) = 0;
67     virtual uint32_t SetScreenActiveRect(const GraphicIRect& activeRect) = 0;
68     virtual int32_t SetResolution(uint32_t width, uint32_t height) = 0;
69     virtual void SetRogResolution(uint32_t width, uint32_t height) = 0;
70     virtual void SetPowerStatus(uint32_t powerStatus) = 0;
71     virtual std::optional<GraphicDisplayModeInfo> GetActiveMode() const = 0;
72     virtual const std::vector<GraphicDisplayModeInfo>& GetSupportedModes() const = 0;
73     virtual const GraphicDisplayCapability& GetCapability() const = 0;
74     virtual uint32_t GetPowerStatus() const = 0;
75     virtual std::shared_ptr<HdiOutput> GetOutput() const = 0;
76     virtual sptr<Surface> GetProducerSurface() const = 0;
77     virtual void SetProducerSurface(sptr<Surface> producerSurface) = 0;
78     virtual bool GetAndResetVirtualSurfaceUpdateFlag() = 0;
79     virtual void DisplayDump(int32_t screenIndex, std::string& dumpString) = 0;
80     virtual void SurfaceDump(int32_t screenIndex, std::string& dumpString) = 0;
81     virtual void FpsDump(int32_t screenIndex, std::string& dumpString, std::string& arg) = 0;
82     virtual void ClearFpsDump(int32_t screenIndex, std::string& dumpString, std::string& arg) = 0;
83     virtual void HitchsDump(int32_t screenIndex, std::string& dumpString, std::string& arg) = 0;
84     virtual void SetScreenBacklight(uint32_t level) = 0;
85     virtual int32_t GetScreenBacklight() const = 0;
86     virtual void ResizeVirtualScreen(uint32_t width, uint32_t height) = 0;
87     virtual int32_t GetScreenSupportedColorGamuts(std::vector<ScreenColorGamut> &mode) const = 0;
88     virtual int32_t GetScreenSupportedMetaDataKeys(std::vector<ScreenHDRMetadataKey> &keys) const = 0;
89     virtual bool GetCanvasRotation() const = 0;
90     virtual ScreenScaleMode GetScaleMode() const = 0;
91     virtual int32_t GetScreenColorGamut(ScreenColorGamut &mode) const = 0;
92     virtual int32_t SetScreenColorGamut(int32_t modeIdx) = 0;
93     virtual int32_t SetScreenGamutMap(ScreenGamutMap mode) = 0;
94     virtual ScreenRotation GetScreenCorrection() const = 0;
95     virtual int32_t GetScreenGamutMap(ScreenGamutMap &mode) const = 0;
96     virtual int32_t GetActiveModePosByModeId(int32_t modeId) const = 0;
97     virtual const GraphicHDRCapability& GetHDRCapability() = 0;
98     virtual const RSScreenType& GetScreenType() const = 0;
99     virtual void SetScreenCorrection(ScreenRotation screenRotation) = 0;
100     virtual void SetScreenSkipFrameInterval(uint32_t skipFrameInterval) = 0;
101     virtual uint32_t GetScreenSkipFrameInterval() const = 0;
102     virtual void SetScreenExpectedRefreshRate(uint32_t expectedRefreshRate) = 0;
103     virtual uint32_t GetScreenExpectedRefreshRate() const = 0;
104     virtual SkipFrameStrategy GetScreenSkipFrameStrategy() const = 0;
105     virtual void SetEqualVsyncPeriod(bool isEqualVsyncPeriod) = 0;
106     virtual bool GetEqualVsyncPeriod() const = 0;
107     virtual void SetScreenVsyncEnabled(bool enabled) const = 0;
108     virtual bool SetVirtualMirrorScreenCanvasRotation(bool canvasRotation) = 0;
109     virtual bool SetVirtualMirrorScreenScaleMode(ScreenScaleMode scaleMode) = 0;
110     virtual int32_t GetScreenSupportedHDRFormats(std::vector<ScreenHDRFormat>& hdrFormats) const = 0;
111     virtual int32_t GetScreenHDRFormat(ScreenHDRFormat& hdrFormat) const = 0;
112     virtual int32_t SetScreenHDRFormat(int32_t modeIdx) = 0;
113     virtual int32_t GetPixelFormat(GraphicPixelFormat& pixelFormat) const = 0;
114     virtual int32_t SetPixelFormat(GraphicPixelFormat pixelFormat) = 0;
115     virtual int32_t GetScreenSupportedColorSpaces(std::vector<GraphicCM_ColorSpaceType>& colorSpaces) const = 0;
116     virtual int32_t GetScreenColorSpace(GraphicCM_ColorSpaceType& colorSpace) const = 0;
117     virtual int32_t SetScreenColorSpace(GraphicCM_ColorSpaceType colorSpace) = 0;
118     virtual const std::unordered_set<uint64_t>& GetWhiteList() const = 0;
119     virtual int32_t SetScreenConstraint(uint64_t frameId, uint64_t timestamp, ScreenConstraintType type) = 0;
120     virtual void SetBlackList(const std::unordered_set<uint64_t>& blackList) = 0;
121     virtual void AddBlackList(const std::vector<uint64_t>& blackList) = 0;
122     virtual void RemoveBlackList(const std::vector<uint64_t>& blackList) = 0;
123     virtual void SetCastScreenEnableSkipWindow(bool enable) = 0;
124     virtual const std::unordered_set<uint64_t>& GetBlackList() const = 0;
125     virtual bool GetCastScreenEnableSkipWindow() = 0;
126     virtual void SetSecurityExemptionList(const std::vector<uint64_t>& securityExemptionList) = 0;
127     virtual const std::vector<uint64_t>& GetSecurityExemptionList() const = 0;
128 };
129 
130 namespace impl {
131 class RSScreen : public OHOS::Rosen::RSScreen {
132 public:
133     RSScreen(
134         ScreenId id,
135         bool isVirtual,
136         std::shared_ptr<HdiOutput> output,
137         sptr<Surface> surface);
138     RSScreen(const VirtualScreenConfigs &configs);
139     ~RSScreen() noexcept override;
140 
141     RSScreen(const RSScreen &) = delete;
142     RSScreen &operator=(const RSScreen &) = delete;
143 
144     ScreenId Id() const override;
145     ScreenId MirrorId() const override;
146     void SetMirror(ScreenId mirrorId) override;
147     const std::string& Name() const override;
148     // render resolution
149     uint32_t Width() const override;
150     uint32_t Height() const override;
151     // physical screen resolution
152     uint32_t PhyWidth() const override;
153     uint32_t PhyHeight() const override;
154     bool IsSamplingOn() const override;
155     float GetSamplingTranslateX() const override;
156     float GetSamplingTranslateY() const override;
157     float GetSamplingScale() const override;
158     RectI GetActiveRect() const override;
159     bool IsEnable() const override;
160     bool IsVirtual() const override;
161     void SetActiveMode(uint32_t modeId) override;
162     uint32_t SetScreenActiveRect(const GraphicIRect& activeRect) override;
163     int32_t SetResolution(uint32_t width, uint32_t height) override;
164     void SetRogResolution(uint32_t width, uint32_t height) override;
165     void SetPowerStatus(uint32_t powerStatus) override;
166     std::optional<GraphicDisplayModeInfo> GetActiveMode() const override;
167     const std::vector<GraphicDisplayModeInfo>& GetSupportedModes() const override;
168     const GraphicDisplayCapability& GetCapability() const override;
169     uint32_t GetPowerStatus() const override;
170     std::shared_ptr<HdiOutput> GetOutput() const override;
171     sptr<Surface> GetProducerSurface() const override;
172     void SetProducerSurface(sptr<Surface> producerSurface) override;
173     bool GetAndResetVirtualSurfaceUpdateFlag() override;
174     void DisplayDump(int32_t screenIndex, std::string& dumpString) override;
175     void SurfaceDump(int32_t screenIndex, std::string& dumpString) override;
176     void FpsDump(int32_t screenIndex, std::string& dumpString, std::string& arg) override;
177     void ClearFpsDump(int32_t screenIndex, std::string& dumpString, std::string& arg) override;
178     void HitchsDump(int32_t screenIndex, std::string& dumpString, std::string& arg) override;
179     void ResizeVirtualScreen(uint32_t width, uint32_t height) override;
180     void SetScreenBacklight(uint32_t level) override;
181     int32_t GetScreenBacklight() const override;
182     int32_t GetScreenSupportedColorGamuts(std::vector<ScreenColorGamut> &mode) const override;
183     int32_t GetScreenSupportedMetaDataKeys(std::vector<ScreenHDRMetadataKey> &keys) const override;
184     bool GetCanvasRotation() const override;
185     ScreenScaleMode GetScaleMode() const override;
186     int32_t GetScreenColorGamut(ScreenColorGamut &mode) const override;
187     int32_t SetScreenColorGamut(int32_t modeIdx) override;
188     int32_t SetScreenGamutMap(ScreenGamutMap mode) override;
189     void SetScreenCorrection(ScreenRotation screenRotation) override;
190     ScreenRotation GetScreenCorrection() const override;
191     int32_t GetScreenGamutMap(ScreenGamutMap &mode) const override;
192     int32_t GetActiveModePosByModeId(int32_t modeId) const override;
193     const GraphicHDRCapability& GetHDRCapability() override;
194     const RSScreenType& GetScreenType() const override;
195     void SetScreenSkipFrameInterval(uint32_t skipFrameInterval) override;
196     uint32_t GetScreenSkipFrameInterval() const override;
197     void SetScreenExpectedRefreshRate(uint32_t expectedRefreshRate) override;
198     uint32_t GetScreenExpectedRefreshRate() const override;
199     SkipFrameStrategy GetScreenSkipFrameStrategy() const override;
200     void SetEqualVsyncPeriod(bool isEqualVsyncPeriod) override;
201     bool GetEqualVsyncPeriod() const override;
202     void SetScreenVsyncEnabled(bool enabled) const override;
203     bool SetVirtualMirrorScreenCanvasRotation(bool canvasRotation) override;
204     bool SetVirtualMirrorScreenScaleMode(ScreenScaleMode scaleMode) override;
205     int32_t GetScreenSupportedHDRFormats(std::vector<ScreenHDRFormat>& hdrFormats) const override;
206     int32_t GetScreenHDRFormat(ScreenHDRFormat& hdrFormat) const override;
207     int32_t SetScreenHDRFormat(int32_t modeIdx) override;
208     int32_t GetPixelFormat(GraphicPixelFormat& pixelFormat) const override;
209     int32_t SetPixelFormat(GraphicPixelFormat pixelFormat) override;
210     int32_t GetScreenSupportedColorSpaces(std::vector<GraphicCM_ColorSpaceType>& colorSpaces) const override;
211     int32_t GetScreenColorSpace(GraphicCM_ColorSpaceType& colorSpace) const override;
212     int32_t SetScreenColorSpace(GraphicCM_ColorSpaceType colorSpace) override;
213     const std::unordered_set<uint64_t>& GetWhiteList() const override;
214     void SetBlackList(const std::unordered_set<uint64_t>& blackListSet) override;
215     void AddBlackList(const std::vector<uint64_t>& blackList) override;
216     void RemoveBlackList(const std::vector<uint64_t>& blackList) override;
217     void SetCastScreenEnableSkipWindow(bool enable) override;
218     const std::unordered_set<uint64_t>& GetBlackList() const override;
219     bool GetCastScreenEnableSkipWindow() override;
220     int32_t SetScreenConstraint(uint64_t frameId, uint64_t timestamp, ScreenConstraintType type) override;
221     void SetSecurityExemptionList(const std::vector<uint64_t>& securityExemptionList) override;
222     const std::vector<uint64_t>& GetSecurityExemptionList() const override;
223 
224 private:
225     // create hdiScreen and get some information from drivers.
226     void PhysicalScreenInit() noexcept;
227     void ScreenCapabilityInit() noexcept;
228 
229     void VirtualScreenInit() noexcept;
230     void ModeInfoDump(std::string& dumpString);
231     void CapabilityDump(std::string& dumpString);
232     void PropDump(std::string& dumpString);
233     void PowerStatusDump(std::string& dumpString);
234     void CapabilityTypeDump(GraphicInterfaceType capabilityType, std::string& dumpString);
235     void ScreenTypeDump(std::string& dumpString);
236 
237     // ScreenId for this screen.
238     ScreenId id_ = INVALID_SCREEN_ID;
239     // If this screen is the mirror of other screen, this member would be a valid id.
240     ScreenId mirrorId_ = INVALID_SCREEN_ID;
241 
242     std::string name_;
243 
244     uint32_t width_ = 0;
245     uint32_t height_ = 0;
246     uint32_t phyWidth_ = 0;
247     uint32_t phyHeight_ = 0;
248     bool isSamplingOn_ = false;
249     float samplingTranslateX_ = 0.f;
250     float samplingTranslateY_ = 0.f;
251     float samplingScale_ = 1.f;
252     int32_t screenBacklightLevel_ = INVALID_BACKLIGHT_VALUE;
253     RectI activeRect_;
254 
255     bool isVirtual_ = true;
256     bool isVirtualSurfaceUpdateFlag_ = false;
257     std::shared_ptr<HdiOutput> hdiOutput_ = nullptr; // has value if the screen is physical
258     std::unique_ptr<HdiScreen> hdiScreen_ = nullptr; // has value if the screen is physical
259     std::vector<GraphicDisplayModeInfo> supportedModes_;
260     GraphicDisplayCapability capability_ = {"test1", GRAPHIC_DISP_INTF_HDMI, 1921, 1081, 0, 0, true, 0};
261     GraphicHDRCapability hdrCapability_;
262     sptr<Surface> producerSurface_ = nullptr;  // has value if the screen is virtual
263     GraphicDispPowerStatus powerStatus_ = GraphicDispPowerStatus::GRAPHIC_POWER_STATUS_ON;
264     GraphicPixelFormat pixelFormat_;
265 
266     std::vector<ScreenColorGamut> supportedVirtualColorGamuts_ = {
267         COLOR_GAMUT_SRGB,
268         COLOR_GAMUT_DCI_P3,
269         COLOR_GAMUT_ADOBE_RGB,
270         COLOR_GAMUT_DISPLAY_P3 };
271     std::vector<ScreenColorGamut> supportedPhysicalColorGamuts_;
272     int32_t currentVirtualColorGamutIdx_ = 0;
273     int32_t currentPhysicalColorGamutIdx_ = 0;
274     ScreenGamutMap currentVirtualGamutMap_ = GAMUT_MAP_CONSTANT;
275     int32_t currentVirtualHDRFormatIdx_ = 0;
276     int32_t currentPhysicalHDRFormatIdx_ = 0;
277     std::vector<ScreenHDRFormat> supportedVirtualHDRFormats_ = {
278         NOT_SUPPORT_HDR };
279     std::vector<ScreenHDRFormat> supportedPhysicalHDRFormats_;
280     RSScreenType screenType_ = RSScreenType::UNKNOWN_TYPE_SCREEN;
281     uint32_t skipFrameInterval_ = DEFAULT_SKIP_FRAME_INTERVAL;
282     uint32_t expectedRefreshRate_ = INVALID_EXPECTED_REFRESH_RATE;
283     SkipFrameStrategy skipFrameStrategy_ = SKIP_FRAME_BY_INTERVAL;
284     bool isEqualVsyncPeriod_ = true;
285     ScreenRotation screenRotation_ = ScreenRotation::ROTATION_0;
286     bool canvasRotation_ = false; // just for virtual screen to use
287     ScreenScaleMode scaleMode_ = ScreenScaleMode::UNISCALE_MODE; // just for virtual screen to use
288     static std::map<GraphicColorGamut, GraphicCM_ColorSpaceType> RS_TO_COMMON_COLOR_SPACE_TYPE_MAP;
289     static std::map<GraphicCM_ColorSpaceType, GraphicColorGamut> COMMON_COLOR_SPACE_TYPE_TO_RS_MAP;
290     static std::map<GraphicHDRFormat, ScreenHDRFormat> HDI_HDR_FORMAT_TO_RS_MAP;
291     static std::map<ScreenHDRFormat, GraphicHDRFormat> RS_TO_HDI_HDR_FORMAT_MAP;
292     std::unordered_set<uint64_t> whiteList_ = {};
293     std::unordered_set<uint64_t> blackList_ = {};
294     std::vector<uint64_t> securityExemptionList_ = {};
295     std::atomic<bool> skipWindow_ = false;
296     mutable std::mutex skipFrameMutex_;
297 };
298 } // namespace impl
299 } // namespace Rosen
300 } // namespace OHOS
301 
302 #endif // RS_SCREEN
303