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