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