1 /* 2 * Copyright 2021 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #pragma once 18 19 #include "ComposerHal.h" 20 21 #include <ftl/shared_mutex.h> 22 #include <ui/DisplayMap.h> 23 24 #include <functional> 25 #include <optional> 26 #include <string> 27 #include <utility> 28 #include <vector> 29 30 #include <android/hardware/graphics/composer/2.4/IComposer.h> 31 #include <android/hardware/graphics/composer/2.4/IComposerClient.h> 32 33 #include <aidl/android/hardware/graphics/composer3/IComposer.h> 34 #include <aidl/android/hardware/graphics/composer3/IComposerClient.h> 35 #include <android/hardware/graphics/composer3/ComposerClientReader.h> 36 #include <android/hardware/graphics/composer3/ComposerClientWriter.h> 37 38 #include <aidl/android/hardware/graphics/composer3/Composition.h> 39 #include <aidl/android/hardware/graphics/composer3/DisplayCapability.h> 40 41 namespace android::Hwc2 { 42 43 using aidl::android::hardware::graphics::common::DisplayDecorationSupport; 44 using aidl::android::hardware::graphics::common::HdrConversionCapability; 45 using aidl::android::hardware::graphics::common::HdrConversionStrategy; 46 using aidl::android::hardware::graphics::composer3::ComposerClientReader; 47 using aidl::android::hardware::graphics::composer3::ComposerClientWriter; 48 using aidl::android::hardware::graphics::composer3::Luts; 49 using aidl::android::hardware::graphics::composer3::OverlayProperties; 50 51 class AidlIComposerCallbackWrapper; 52 53 // Composer is a wrapper to IComposer, a proxy to server-side composer. 54 class AidlComposer final : public Hwc2::Composer { 55 public: 56 static bool isDeclared(const std::string& serviceName); 57 58 explicit AidlComposer(const std::string& serviceName); 59 ~AidlComposer() override; 60 61 bool isSupported(OptionalFeature) const; 62 bool isVrrSupported() const; 63 64 std::vector<aidl::android::hardware::graphics::composer3::Capability> getCapabilities() 65 override; 66 std::string dumpDebugInfo() override; 67 68 void registerCallback(HWC2::ComposerCallback& callback) override; 69 70 // Explicitly flush all pending commands in the command buffer. 71 Error executeCommands(Display) override; 72 73 uint32_t getMaxVirtualDisplayCount() override; 74 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format, 75 Display* outDisplay) override; 76 Error destroyVirtualDisplay(Display display) override; 77 78 Error acceptDisplayChanges(Display display) override; 79 80 Error createLayer(Display display, Layer* outLayer) override; 81 Error destroyLayer(Display display, Layer layer) override; 82 83 Error getActiveConfig(Display display, Config* outConfig) override; 84 Error getChangedCompositionTypes( 85 Display display, std::vector<Layer>* outLayers, 86 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes) 87 override; 88 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override; 89 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute, 90 int32_t* outValue) override; 91 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs); 92 Error getDisplayConfigurations(Display, int32_t maxFrameIntervalNs, 93 std::vector<DisplayConfiguration>*); 94 Error getDisplayName(Display display, std::string* outName) override; 95 96 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask, 97 std::vector<Layer>* outLayers, 98 std::vector<uint32_t>* outLayerRequestMasks) override; 99 100 Error getDozeSupport(Display display, bool* outSupport) override; 101 Error hasDisplayIdleTimerCapability(Display display, bool* outSupport) override; 102 Error getHdrCapabilities(Display display, std::vector<Hdr>* outHdrTypes, float* outMaxLuminance, 103 float* outMaxAverageLuminance, float* outMinLuminance) override; 104 Error getOverlaySupport(OverlayProperties* outProperties) override; 105 106 Error getReleaseFences(Display display, std::vector<Layer>* outLayers, 107 std::vector<int>* outReleaseFences) override; 108 109 Error presentDisplay(Display display, int* outPresentFence) override; 110 111 Error setActiveConfig(Display display, Config config) override; 112 113 /* 114 * The composer caches client targets internally. When target is nullptr, 115 * the composer uses slot to look up the client target from its cache. 116 * When target is not nullptr, the cache is updated with the new target. 117 */ 118 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target, 119 int acquireFence, Dataspace dataspace, 120 const std::vector<IComposerClient::Rect>& damage, 121 float hdrSdrRatio) override; 122 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override; 123 Error setColorTransform(Display display, const float* matrix) override; 124 Error setOutputBuffer(Display display, const native_handle_t* buffer, 125 int releaseFence) override; 126 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override; 127 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override; 128 129 Error setClientTargetSlotCount(Display display) override; 130 131 Error validateDisplay(Display display, nsecs_t expectedPresentTime, int32_t frameIntervalNs, 132 uint32_t* outNumTypes, uint32_t* outNumRequests) override; 133 134 Error presentOrValidateDisplay(Display display, nsecs_t expectedPresentTime, 135 int32_t frameIntervalNs, uint32_t* outNumTypes, 136 uint32_t* outNumRequests, int* outPresentFence, 137 uint32_t* state) override; 138 139 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override; 140 /* see setClientTarget for the purpose of slot */ 141 Error setLayerBuffer(Display display, Layer layer, uint32_t slot, 142 const sp<GraphicBuffer>& buffer, int acquireFence) override; 143 Error setLayerBufferSlotsToClear(Display display, Layer layer, 144 const std::vector<uint32_t>& slotsToClear, 145 uint32_t activeBufferSlot) override; 146 Error setLayerSurfaceDamage(Display display, Layer layer, 147 const std::vector<IComposerClient::Rect>& damage) override; 148 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override; 149 Error setLayerColor(Display display, Layer layer, const Color& color) override; 150 Error setLayerCompositionType( 151 Display display, Layer layer, 152 aidl::android::hardware::graphics::composer3::Composition type) override; 153 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override; 154 Error setLayerDisplayFrame(Display display, Layer layer, 155 const IComposerClient::Rect& frame) override; 156 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override; 157 Error setLayerSidebandStream(Display display, Layer layer, 158 const native_handle_t* stream) override; 159 Error setLayerSourceCrop(Display display, Layer layer, 160 const IComposerClient::FRect& crop) override; 161 Error setLayerTransform(Display display, Layer layer, Transform transform) override; 162 Error setLayerVisibleRegion(Display display, Layer layer, 163 const std::vector<IComposerClient::Rect>& visible) override; 164 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override; 165 166 // Composer HAL 2.2 167 Error setLayerPerFrameMetadata( 168 Display display, Layer layer, 169 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override; 170 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys( 171 Display display) override; 172 Error getRenderIntents(Display display, ColorMode colorMode, 173 std::vector<RenderIntent>* outRenderIntents) override; 174 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override; 175 176 // Composer HAL 2.3 177 Error getDisplayIdentificationData(Display display, uint8_t* outPort, 178 std::vector<uint8_t>* outData) override; 179 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override; 180 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat, 181 Dataspace* outDataspace, 182 uint8_t* outComponentMask) override; 183 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask, 184 uint64_t maxFrames) override; 185 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp, 186 DisplayedFrameStats* outStats) override; 187 Error setLayerPerFrameMetadataBlobs( 188 Display display, Layer layer, 189 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override; 190 Error setDisplayBrightness(Display display, float brightness, float brightnessNits, 191 const DisplayBrightnessOptions& options) override; 192 193 // Composer HAL 2.4 194 Error getDisplayCapabilities( 195 Display display, 196 std::vector<aidl::android::hardware::graphics::composer3::DisplayCapability>* 197 outCapabilities) override; 198 V2_4::Error getDisplayConnectionType(Display display, 199 IComposerClient::DisplayConnectionType* outType) override; 200 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override; 201 Error setActiveConfigWithConstraints( 202 Display display, Config config, 203 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints, 204 VsyncPeriodChangeTimeline* outTimeline) override; 205 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override; 206 V2_4::Error getSupportedContentTypes( 207 Display displayId, 208 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override; 209 V2_4::Error setContentType(Display displayId, 210 IComposerClient::ContentType contentType) override; 211 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key, 212 bool mandatory, const std::vector<uint8_t>& value) override; 213 V2_4::Error getLayerGenericMetadataKeys( 214 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override; 215 Error getClientTargetProperty( 216 Display display, 217 aidl::android::hardware::graphics::composer3::ClientTargetPropertyWithBrightness* 218 outClientTargetProperty) override; 219 220 // AIDL Composer HAL 221 Error setLayerBrightness(Display display, Layer layer, float brightness) override; 222 Error setLayerBlockingRegion(Display display, Layer layer, 223 const std::vector<IComposerClient::Rect>& blocking) override; 224 Error setBootDisplayConfig(Display displayId, Config) override; 225 Error clearBootDisplayConfig(Display displayId) override; 226 Error getPreferredBootDisplayConfig(Display displayId, Config*) override; 227 Error getDisplayDecorationSupport(Display display, 228 std::optional<DisplayDecorationSupport>* support) override; 229 Error setIdleTimerEnabled(Display displayId, std::chrono::milliseconds timeout) override; 230 231 Error getPhysicalDisplayOrientation(Display displayId, 232 AidlTransform* outDisplayOrientation) override; 233 void onHotplugConnect(Display) override; 234 void onHotplugDisconnect(Display) override; 235 Error getHdrConversionCapabilities(std::vector<HdrConversionCapability>*) override; 236 Error setHdrConversionStrategy(HdrConversionStrategy, Hdr*) override; 237 Error setRefreshRateChangedCallbackDebugEnabled(Display, bool) override; 238 Error notifyExpectedPresent(Display, nsecs_t expectedPresentTime, 239 int32_t frameIntervalNs) override; 240 Error getRequestedLuts( 241 Display display, std::vector<Layer>* outLayers, 242 std::vector<aidl::android::hardware::graphics::composer3::DisplayLuts::LayerLut>* 243 outLuts) override; 244 Error setLayerLuts(Display display, Layer layer, Luts& luts) override; 245 Error getMaxLayerPictureProfiles(Display, int32_t* outMaxProfiles) override; 246 Error setDisplayPictureProfileId(Display, PictureProfileId id) override; 247 Error setLayerPictureProfileId(Display, Layer, PictureProfileId id) override; 248 249 private: 250 // Many public functions above simply write a command into the command 251 // queue to batch the calls. validateDisplay and presentDisplay will call 252 // this function to execute the command queue. 253 Error execute(Display) REQUIRES_SHARED(mMutex); 254 255 // returns the default instance name for the given service 256 static std::string instance(const std::string& serviceName); 257 258 ftl::Optional<std::reference_wrapper<ComposerClientWriter>> getWriter(Display) 259 REQUIRES_SHARED(mMutex); 260 ftl::Optional<std::reference_wrapper<ComposerClientReader>> getReader(Display) 261 REQUIRES_SHARED(mMutex); 262 void addDisplay(Display) EXCLUDES(mMutex); 263 void removeDisplay(Display) EXCLUDES(mMutex); 264 void addReader(Display) REQUIRES(mMutex); 265 void removeReader(Display) REQUIRES(mMutex); 266 bool getLayerLifecycleBatchCommand(); 267 bool hasMultiThreadedPresentSupport(Display); 268 269 // 64KiB minus a small space for metadata such as read/write pointers 270 static constexpr size_t kWriterInitialSize = 64 * 1024 / sizeof(uint32_t) - 16; 271 // Max number of buffers that may be cached for a given layer 272 // We obtain this number by: 273 // 1. Tightly coupling this cache to the max size of BufferQueue 274 // 2. Adding an additional slot for the layer caching feature in SurfaceFlinger (see: Planner.h) 275 static const constexpr uint32_t kMaxLayerBufferCount = BufferQueue::NUM_BUFFER_SLOTS + 1; 276 277 // Without DisplayCapability::MULTI_THREADED_PRESENT, we use a single reader 278 // for all displays. With the capability, we use a separate reader for each 279 // display. 280 bool mSingleReader = true; 281 // Invalid displayId used as a key to mReaders when mSingleReader is true. 282 static constexpr int64_t kSingleReaderKey = 0; 283 284 ui::PhysicalDisplayMap<Display, ComposerClientWriter> mWriters GUARDED_BY(mMutex); 285 ui::PhysicalDisplayMap<Display, ComposerClientReader> mReaders GUARDED_BY(mMutex); 286 287 // Protect access to mWriters and mReaders with a shared_mutex. Adding and 288 // removing a display require exclusive access, since the iterator or the 289 // writer/reader may be invalidated. Other calls need shared access while 290 // using the writer/reader, so they can use their display's writer/reader 291 // without it being deleted or the iterator being invalidated. 292 // TODO (b/257958323): Use std::shared_mutex and RAII once they support 293 // threading annotations. 294 ftl::SharedMutex mMutex; 295 296 int32_t mComposerInterfaceVersion = 1; 297 bool mEnableLayerCommandBatchingFlag = false; 298 std::atomic<int64_t> mLayerID = 1; 299 300 // Buffer slots for layers are cleared by setting the slot buffer to this buffer. 301 sp<GraphicBuffer> mClearSlotBuffer; 302 303 // Aidl interface 304 using AidlIComposer = aidl::android::hardware::graphics::composer3::IComposer; 305 using AidlIComposerClient = aidl::android::hardware::graphics::composer3::IComposerClient; 306 std::shared_ptr<AidlIComposer> mAidlComposer; 307 std::shared_ptr<AidlIComposerClient> mAidlComposerClient; 308 std::shared_ptr<AidlIComposerCallbackWrapper> mAidlComposerCallback; 309 }; 310 311 } // namespace android::Hwc2 312