1 /* 2 * Copyright 2016 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 <memory> 20 21 // TODO(b/129481165): remove the #pragma below and fix conversion issues 22 #pragma clang diagnostic push 23 #pragma clang diagnostic ignored "-Wconversion" 24 #pragma clang diagnostic ignored "-Wextra" 25 26 #include <composer-command-buffer/2.4/ComposerCommandBuffer.h> 27 #include <gui/BufferQueue.h> 28 #include <gui/HdrMetadata.h> 29 #include <math/mat4.h> 30 #include <ui/DisplayedFrameStats.h> 31 #include <ui/GraphicBuffer.h> 32 #include <ui/PictureProfileHandle.h> 33 #include <utils/StrongPointer.h> 34 35 #include "DisplayHardware/Hal.h" 36 37 #include <aidl/android/hardware/graphics/common/DisplayDecorationSupport.h> 38 #include <aidl/android/hardware/graphics/common/HdrConversionCapability.h> 39 #include <aidl/android/hardware/graphics/common/HdrConversionStrategy.h> 40 #include <aidl/android/hardware/graphics/common/Transform.h> 41 #include <aidl/android/hardware/graphics/composer3/Capability.h> 42 #include <aidl/android/hardware/graphics/composer3/ClientTargetPropertyWithBrightness.h> 43 #include <aidl/android/hardware/graphics/composer3/Color.h> 44 #include <aidl/android/hardware/graphics/composer3/Composition.h> 45 #include <aidl/android/hardware/graphics/composer3/DisplayCapability.h> 46 #include <aidl/android/hardware/graphics/composer3/DisplayConfiguration.h> 47 #include <aidl/android/hardware/graphics/composer3/DisplayLuts.h> 48 #include <aidl/android/hardware/graphics/composer3/IComposerCallback.h> 49 #include <aidl/android/hardware/graphics/composer3/Luts.h> 50 #include <aidl/android/hardware/graphics/composer3/OverlayProperties.h> 51 52 #include <optional> 53 54 // TODO(b/129481165): remove the #pragma below and fix conversion issues 55 #pragma clang diagnostic pop // ignored "-Wconversion -Wextra" 56 57 namespace android { 58 namespace HWC2 { 59 struct ComposerCallback; 60 } // namespace HWC2 61 62 namespace Hwc2 { 63 64 namespace types = hardware::graphics::common; 65 66 namespace V2_1 = hardware::graphics::composer::V2_1; 67 namespace V2_2 = hardware::graphics::composer::V2_2; 68 namespace V2_3 = hardware::graphics::composer::V2_3; 69 namespace V2_4 = hardware::graphics::composer::V2_4; 70 namespace V3_0 = ::aidl::android::hardware::graphics::composer3; 71 72 using types::V1_0::ColorTransform; 73 using types::V1_0::Transform; 74 using types::V1_1::RenderIntent; 75 using types::V1_2::ColorMode; 76 using types::V1_2::Dataspace; 77 using types::V1_2::PixelFormat; 78 79 using hardware::graphics::composer::hal::Error; 80 using V2_1::Config; 81 using V2_1::Display; 82 using V2_1::Layer; 83 using V2_4::CommandReaderBase; 84 using V2_4::CommandWriterBase; 85 using V2_4::IComposer; 86 using V2_4::IComposerCallback; 87 using V2_4::IComposerClient; 88 using V2_4::VsyncPeriodChangeTimeline; 89 using V2_4::VsyncPeriodNanos; 90 using PerFrameMetadata = IComposerClient::PerFrameMetadata; 91 using PerFrameMetadataKey = IComposerClient::PerFrameMetadataKey; 92 using PerFrameMetadataBlob = IComposerClient::PerFrameMetadataBlob; 93 using AidlTransform = ::aidl::android::hardware::graphics::common::Transform; 94 using DisplayConfiguration = V3_0::DisplayConfiguration; 95 using aidl::android::hardware::graphics::common::Hdr; 96 97 class Composer { 98 public: 99 static std::unique_ptr<Composer> create(const std::string& serviceName); 100 101 virtual ~Composer() = 0; 102 103 enum class OptionalFeature { 104 RefreshRateSwitching, 105 ExpectedPresentTime, 106 // Whether setDisplayBrightness is able to be applied as part of a display command. 107 DisplayBrightnessCommand, 108 KernelIdleTimer, 109 PhysicalDisplayOrientation, 110 }; 111 112 virtual bool isSupported(OptionalFeature) const = 0; 113 virtual bool isVrrSupported() const = 0; 114 115 virtual std::vector<aidl::android::hardware::graphics::composer3::Capability> 116 getCapabilities() = 0; 117 virtual std::string dumpDebugInfo() = 0; 118 119 virtual void registerCallback(HWC2::ComposerCallback& callback) = 0; 120 121 // Explicitly flush all pending commands in the command buffer. 122 virtual Error executeCommands(Display) = 0; 123 124 virtual uint32_t getMaxVirtualDisplayCount() = 0; 125 virtual Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat*, 126 Display* outDisplay) = 0; 127 virtual Error destroyVirtualDisplay(Display display) = 0; 128 129 virtual Error acceptDisplayChanges(Display display) = 0; 130 131 virtual Error createLayer(Display display, Layer* outLayer) = 0; 132 virtual Error destroyLayer(Display display, Layer layer) = 0; 133 134 virtual Error getActiveConfig(Display display, Config* outConfig) = 0; 135 virtual Error getChangedCompositionTypes(Display display, std::vector<Layer>* outLayers, 136 std::vector<V3_0::Composition>* outTypes) = 0; 137 virtual Error getColorModes(Display display, std::vector<ColorMode>* outModes) = 0; 138 virtual Error getDisplayAttribute(Display display, Config config, 139 IComposerClient::Attribute attribute, int32_t* outValue) = 0; 140 virtual Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs) = 0; 141 142 virtual Error getDisplayConfigurations(Display, int32_t maxFrameIntervalNs, 143 std::vector<DisplayConfiguration>*) = 0; 144 145 virtual Error getDisplayName(Display display, std::string* outName) = 0; 146 147 virtual Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask, 148 std::vector<Layer>* outLayers, 149 std::vector<uint32_t>* outLayerRequestMasks) = 0; 150 151 virtual Error getDozeSupport(Display display, bool* outSupport) = 0; 152 virtual Error hasDisplayIdleTimerCapability(Display display, bool* outSupport) = 0; 153 virtual Error getHdrCapabilities(Display display, std::vector<Hdr>* outHdrTypes, 154 float* outMaxLuminance, float* outMaxAverageLuminance, 155 float* outMinLuminance) = 0; 156 157 virtual Error getReleaseFences(Display display, std::vector<Layer>* outLayers, 158 std::vector<int>* outReleaseFences) = 0; 159 160 virtual Error getLayerPresentFences(Display display, std::vector<Layer>* outLayers, 161 std::vector<int>* outFences, 162 std::vector<int64_t>* outLatenciesNanos) = 0; 163 164 virtual Error presentDisplay(Display display, int* outPresentFence) = 0; 165 166 virtual Error setActiveConfig(Display display, Config config) = 0; 167 168 /* 169 * The composer caches client targets internally. When target is nullptr, 170 * the composer uses slot to look up the client target from its cache. 171 * When target is not nullptr, the cache is updated with the new target. 172 */ 173 virtual Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target, 174 int acquireFence, Dataspace dataspace, 175 const std::vector<IComposerClient::Rect>& damage, 176 float hdrSdrRatio) = 0; 177 virtual Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) = 0; 178 virtual Error setColorTransform(Display display, const float* matrix) = 0; 179 virtual Error setOutputBuffer(Display display, const native_handle_t* buffer, 180 int releaseFence) = 0; 181 virtual Error setPowerMode(Display display, IComposerClient::PowerMode mode) = 0; 182 virtual Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) = 0; 183 184 virtual Error setClientTargetSlotCount(Display display) = 0; 185 186 virtual Error validateDisplay(Display display, nsecs_t expectedPresentTime, 187 int32_t frameIntervalNs, uint32_t* outNumTypes, 188 uint32_t* outNumRequests) = 0; 189 190 virtual Error presentOrValidateDisplay(Display display, nsecs_t expectedPresentTime, 191 int32_t frameIntervalNs, uint32_t* outNumTypes, 192 uint32_t* outNumRequests, int* outPresentFence, 193 uint32_t* state) = 0; 194 195 virtual Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) = 0; 196 /* see setClientTarget for the purpose of slot */ 197 virtual Error setLayerBuffer(Display display, Layer layer, uint32_t slot, 198 const sp<GraphicBuffer>& buffer, int acquireFence) = 0; 199 virtual Error setLayerBufferSlotsToClear(Display display, Layer layer, 200 const std::vector<uint32_t>& slotsToClear, 201 uint32_t activeBufferSlot) = 0; 202 virtual Error setLayerSurfaceDamage(Display display, Layer layer, 203 const std::vector<IComposerClient::Rect>& damage) = 0; 204 virtual Error setLayerBlendMode(Display display, Layer layer, 205 IComposerClient::BlendMode mode) = 0; 206 virtual Error setLayerColor( 207 Display display, Layer layer, 208 const aidl::android::hardware::graphics::composer3::Color& color) = 0; 209 virtual Error setLayerCompositionType( 210 Display display, Layer layer, 211 aidl::android::hardware::graphics::composer3::Composition type) = 0; 212 virtual Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) = 0; 213 virtual Error setLayerDisplayFrame(Display display, Layer layer, 214 const IComposerClient::Rect& frame) = 0; 215 virtual Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) = 0; 216 virtual Error setLayerSidebandStream(Display display, Layer layer, 217 const native_handle_t* stream) = 0; 218 virtual Error setLayerSourceCrop(Display display, Layer layer, 219 const IComposerClient::FRect& crop) = 0; 220 virtual Error setLayerTransform(Display display, Layer layer, Transform transform) = 0; 221 virtual Error setLayerVisibleRegion(Display display, Layer layer, 222 const std::vector<IComposerClient::Rect>& visible) = 0; 223 virtual Error setLayerZOrder(Display display, Layer layer, uint32_t z) = 0; 224 225 // Composer HAL 2.2 226 virtual Error setLayerPerFrameMetadata( 227 Display display, Layer layer, 228 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) = 0; 229 virtual std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys( 230 Display display) = 0; 231 virtual Error getRenderIntents(Display display, ColorMode colorMode, 232 std::vector<RenderIntent>* outRenderIntents) = 0; 233 virtual Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) = 0; 234 235 // Composer HAL 2.3 236 virtual Error getDisplayIdentificationData(Display display, uint8_t* outPort, 237 std::vector<uint8_t>* outData) = 0; 238 virtual Error setLayerColorTransform(Display display, Layer layer, const float* matrix) = 0; 239 virtual Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat, 240 Dataspace* outDataspace, 241 uint8_t* outComponentMask) = 0; 242 virtual Error setDisplayContentSamplingEnabled(Display display, bool enabled, 243 uint8_t componentMask, uint64_t maxFrames) = 0; 244 virtual Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp, 245 DisplayedFrameStats* outStats) = 0; 246 virtual Error setLayerPerFrameMetadataBlobs( 247 Display display, Layer layer, const std::vector<PerFrameMetadataBlob>& metadata) = 0; 248 // Options for setting the display brightness 249 struct DisplayBrightnessOptions { 250 // If true, then immediately submits a brightness change request to composer. Otherwise, 251 // submission of the brightness change may be deferred until presenting the next frame. 252 // applyImmediately should only be false if OptionalFeature::DisplayBrightnessCommand is 253 // supported. 254 bool applyImmediately = true; 255 256 bool operator==(const DisplayBrightnessOptions& other) const { 257 return applyImmediately == other.applyImmediately; 258 } 259 }; 260 virtual Error setDisplayBrightness(Display display, float brightness, float brightnessNits, 261 const DisplayBrightnessOptions& options) = 0; 262 263 // Composer HAL 2.4 264 virtual Error getDisplayCapabilities(Display display, 265 std::vector<V3_0::DisplayCapability>* outCapabilities) = 0; 266 virtual V2_4::Error getDisplayConnectionType( 267 Display display, IComposerClient::DisplayConnectionType* outType) = 0; 268 virtual V2_4::Error getDisplayVsyncPeriod(Display display, 269 VsyncPeriodNanos* outVsyncPeriod) = 0; 270 virtual Error setActiveConfigWithConstraints( 271 Display display, Config config, 272 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints, 273 VsyncPeriodChangeTimeline* outTimeline) = 0; 274 275 virtual V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) = 0; 276 virtual V2_4::Error getSupportedContentTypes( 277 Display displayId, 278 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) = 0; 279 virtual V2_4::Error setContentType(Display displayId, 280 IComposerClient::ContentType contentType) = 0; 281 virtual V2_4::Error setLayerGenericMetadata(Display display, Layer layer, 282 const std::string& key, bool mandatory, 283 const std::vector<uint8_t>& value) = 0; 284 virtual V2_4::Error getLayerGenericMetadataKeys( 285 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) = 0; 286 287 virtual Error getClientTargetProperty( 288 Display display, V3_0::ClientTargetPropertyWithBrightness* outClientTargetProperty) = 0; 289 290 // AIDL Composer 291 virtual Error setLayerBrightness(Display display, Layer layer, float brightness) = 0; 292 virtual Error setLayerBlockingRegion(Display display, Layer layer, 293 const std::vector<IComposerClient::Rect>& blocking) = 0; 294 virtual Error setBootDisplayConfig(Display displayId, Config) = 0; 295 virtual Error clearBootDisplayConfig(Display displayId) = 0; 296 virtual Error getPreferredBootDisplayConfig(Display displayId, Config*) = 0; 297 virtual Error getDisplayDecorationSupport( 298 Display display, 299 std::optional<::aidl::android::hardware::graphics::common::DisplayDecorationSupport>* 300 support) = 0; 301 virtual Error setIdleTimerEnabled(Display displayId, std::chrono::milliseconds timeout) = 0; 302 virtual Error getPhysicalDisplayOrientation(Display displayId, 303 AidlTransform* outDisplayOrientation) = 0; 304 virtual Error getOverlaySupport(V3_0::OverlayProperties* outProperties) = 0; 305 virtual void onHotplugConnect(Display) = 0; 306 virtual void onHotplugDisconnect(Display) = 0; 307 virtual Error getHdrConversionCapabilities( 308 std::vector<::aidl::android::hardware::graphics::common::HdrConversionCapability>*) = 0; 309 virtual Error setHdrConversionStrategy( 310 ::aidl::android::hardware::graphics::common::HdrConversionStrategy, Hdr*) = 0; 311 virtual Error setRefreshRateChangedCallbackDebugEnabled(Display, bool) = 0; 312 virtual Error notifyExpectedPresent(Display, nsecs_t expectedPresentTime, 313 int32_t frameIntervalNs) = 0; 314 virtual Error getRequestedLuts(Display display, std::vector<Layer>* outLayers, 315 std::vector<V3_0::DisplayLuts::LayerLut>* outLuts) = 0; 316 virtual Error setLayerLuts(Display display, Layer layer, V3_0::Luts& luts) = 0; 317 virtual Error getMaxLayerPictureProfiles(Display display, int32_t* outMaxProfiles) = 0; 318 virtual Error setDisplayPictureProfileId(Display display, PictureProfileId id) = 0; 319 virtual Error setLayerPictureProfileId(Display display, Layer layer, PictureProfileId id) = 0; 320 virtual Error startHdcpNegotiation(Display display, 321 const aidl::android::hardware::drm::HdcpLevels& levels) = 0; 322 virtual Error getLuts(Display display, const std::vector<sp<GraphicBuffer>>&, 323 std::vector<V3_0::Luts>*) = 0; 324 }; 325 326 } // namespace Hwc2 327 } // namespace android 328