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