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