blob: f2a59a5b952e14c97952761548d8d9f1561fd602 [file] [log] [blame]
Ady Abraham9fc28052021-10-14 17:21:38 -07001/*
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 <optional>
22#include <string>
23#include <unordered_map>
24#include <utility>
25#include <vector>
26
27// TODO(b/129481165): remove the #pragma below and fix conversion issues
28#pragma clang diagnostic push
29#pragma clang diagnostic ignored "-Wconversion"
30#pragma clang diagnostic ignored "-Wextra"
31
32#include <android/hardware/graphics/composer/2.4/IComposer.h>
33#include <android/hardware/graphics/composer/2.4/IComposerClient.h>
34
35#include <aidl/android/hardware/graphics/composer3/IComposer.h>
36#include <aidl/android/hardware/graphics/composer3/IComposerClient.h>
Ady Abrahambea99ba2021-12-15 18:17:52 -080037#include <android/hardware/graphics/composer3/ComposerClientReader.h>
38#include <android/hardware/graphics/composer3/ComposerClientWriter.h>
Ady Abraham9fc28052021-10-14 17:21:38 -070039
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050040#include <aidl/android/hardware/graphics/composer3/Composition.h>
Leon Scroggins III5967aec2021-12-29 11:14:22 -050041#include <aidl/android/hardware/graphics/composer3/DisplayCapability.h>
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050042
Ady Abraham9fc28052021-10-14 17:21:38 -070043// TODO(b/129481165): remove the #pragma below and fix conversion issues
44#pragma clang diagnostic pop // ignored "-Wconversion -Wextra"
45
46namespace android::Hwc2 {
47
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -050048using aidl::android::hardware::graphics::common::DisplayDecorationSupport;
Ady Abrahambea99ba2021-12-15 18:17:52 -080049using aidl::android::hardware::graphics::composer3::ComposerClientReader;
50using aidl::android::hardware::graphics::composer3::ComposerClientWriter;
Sally Qi0cbd08b2022-08-17 12:12:28 -070051using aidl::android::hardware::graphics::composer3::OverlayProperties;
Ady Abraham9fc28052021-10-14 17:21:38 -070052
53class AidlIComposerCallbackWrapper;
54
Ady Abraham9fc28052021-10-14 17:21:38 -070055// Composer is a wrapper to IComposer, a proxy to server-side composer.
56class AidlComposer final : public Hwc2::Composer {
57public:
58 static bool isDeclared(const std::string& serviceName);
59
60 explicit AidlComposer(const std::string& serviceName);
61 ~AidlComposer() override;
62
Ady Abraham4d211cf2021-12-14 16:19:03 -080063 bool isSupported(OptionalFeature) const;
64
Ady Abrahamde549d42022-01-26 19:19:17 -080065 std::vector<aidl::android::hardware::graphics::composer3::Capability> getCapabilities()
66 override;
Ady Abraham9fc28052021-10-14 17:21:38 -070067 std::string dumpDebugInfo() override;
68
Yichi Chen3401b562022-01-17 15:42:35 +080069 void registerCallback(HWC2::ComposerCallback& callback) override;
Ady Abraham9fc28052021-10-14 17:21:38 -070070
71 // Reset all pending commands in the command buffer. Useful if you want to
72 // skip a frame but have already queued some commands.
73 void resetCommands() override;
74
75 // Explicitly flush all pending commands in the command buffer.
76 Error executeCommands() override;
77
78 uint32_t getMaxVirtualDisplayCount() override;
79 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
80 Display* outDisplay) override;
81 Error destroyVirtualDisplay(Display display) override;
82
83 Error acceptDisplayChanges(Display display) override;
84
85 Error createLayer(Display display, Layer* outLayer) override;
86 Error destroyLayer(Display display, Layer layer) override;
87
88 Error getActiveConfig(Display display, Config* outConfig) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050089 Error getChangedCompositionTypes(
90 Display display, std::vector<Layer>* outLayers,
91 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes)
92 override;
Ady Abraham9fc28052021-10-14 17:21:38 -070093 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override;
94 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute,
95 int32_t* outValue) override;
96 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs);
97 Error getDisplayName(Display display, std::string* outName) override;
98
99 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
100 std::vector<Layer>* outLayers,
101 std::vector<uint32_t>* outLayerRequestMasks) override;
102
103 Error getDozeSupport(Display display, bool* outSupport) override;
ramindani32cf0602022-03-02 02:30:29 +0000104 Error hasDisplayIdleTimerCapability(Display display, bool* outSupport) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700105 Error getHdrCapabilities(Display display, std::vector<Hdr>* outTypes, float* outMaxLuminance,
106 float* outMaxAverageLuminance, float* outMinLuminance) override;
Sally Qi0cbd08b2022-08-17 12:12:28 -0700107 Error getOverlaySupport(OverlayProperties* outProperties) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700108
109 Error getReleaseFences(Display display, std::vector<Layer>* outLayers,
110 std::vector<int>* outReleaseFences) override;
111
112 Error presentDisplay(Display display, int* outPresentFence) override;
113
114 Error setActiveConfig(Display display, Config config) override;
115
116 /*
117 * The composer caches client targets internally. When target is nullptr,
118 * the composer uses slot to look up the client target from its cache.
119 * When target is not nullptr, the cache is updated with the new target.
120 */
121 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target,
122 int acquireFence, Dataspace dataspace,
123 const std::vector<IComposerClient::Rect>& damage) override;
124 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override;
Ady Abrahamdc011a92021-12-21 14:06:44 -0800125 Error setColorTransform(Display display, const float* matrix) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700126 Error setOutputBuffer(Display display, const native_handle_t* buffer,
127 int releaseFence) override;
128 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override;
129 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override;
130
131 Error setClientTargetSlotCount(Display display) override;
132
Ady Abraham43065bd2021-12-10 17:22:15 -0800133 Error validateDisplay(Display display, nsecs_t expectedPresentTime, uint32_t* outNumTypes,
Ady Abraham9fc28052021-10-14 17:21:38 -0700134 uint32_t* outNumRequests) override;
135
Ady Abraham43065bd2021-12-10 17:22:15 -0800136 Error presentOrValidateDisplay(Display display, nsecs_t expectedPresentTime,
137 uint32_t* outNumTypes, uint32_t* outNumRequests,
Ady Abraham9fc28052021-10-14 17:21:38 -0700138 int* outPresentFence, uint32_t* state) override;
139
140 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override;
141 /* see setClientTarget for the purpose of slot */
142 Error setLayerBuffer(Display display, Layer layer, uint32_t slot,
143 const sp<GraphicBuffer>& buffer, int acquireFence) override;
144 Error setLayerSurfaceDamage(Display display, Layer layer,
145 const std::vector<IComposerClient::Rect>& damage) override;
146 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override;
Ady Abraham6e60b142022-01-06 18:10:35 -0800147 Error setLayerColor(Display display, Layer layer, const Color& color) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500148 Error setLayerCompositionType(
149 Display display, Layer layer,
150 aidl::android::hardware::graphics::composer3::Composition type) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700151 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override;
152 Error setLayerDisplayFrame(Display display, Layer layer,
153 const IComposerClient::Rect& frame) override;
154 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override;
155 Error setLayerSidebandStream(Display display, Layer layer,
156 const native_handle_t* stream) override;
157 Error setLayerSourceCrop(Display display, Layer layer,
158 const IComposerClient::FRect& crop) override;
159 Error setLayerTransform(Display display, Layer layer, Transform transform) override;
160 Error setLayerVisibleRegion(Display display, Layer layer,
161 const std::vector<IComposerClient::Rect>& visible) override;
162 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override;
163
164 // Composer HAL 2.2
165 Error setLayerPerFrameMetadata(
166 Display display, Layer layer,
167 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override;
168 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
169 Display display) override;
170 Error getRenderIntents(Display display, ColorMode colorMode,
171 std::vector<RenderIntent>* outRenderIntents) override;
172 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override;
173
174 // Composer HAL 2.3
175 Error getDisplayIdentificationData(Display display, uint8_t* outPort,
176 std::vector<uint8_t>* outData) override;
177 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override;
178 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
179 Dataspace* outDataspace,
180 uint8_t* outComponentMask) override;
181 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask,
182 uint64_t maxFrames) override;
183 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
184 DisplayedFrameStats* outStats) override;
185 Error setLayerPerFrameMetadataBlobs(
186 Display display, Layer layer,
187 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override;
Alec Mouri4d8a05d2022-03-23 18:14:26 +0000188 Error setDisplayBrightness(Display display, float brightness, float brightnessNits,
Alec Mouricdf16792021-12-10 13:16:06 -0800189 const DisplayBrightnessOptions& options) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700190
191 // Composer HAL 2.4
Leon Scroggins III5967aec2021-12-29 11:14:22 -0500192 Error getDisplayCapabilities(
193 Display display,
194 std::vector<aidl::android::hardware::graphics::composer3::DisplayCapability>*
195 outCapabilities) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700196 V2_4::Error getDisplayConnectionType(Display display,
197 IComposerClient::DisplayConnectionType* outType) override;
198 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override;
199 V2_4::Error setActiveConfigWithConstraints(
200 Display display, Config config,
201 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
202 VsyncPeriodChangeTimeline* outTimeline) override;
203 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override;
204 V2_4::Error getSupportedContentTypes(
205 Display displayId,
206 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override;
207 V2_4::Error setContentType(Display displayId,
208 IComposerClient::ContentType contentType) override;
209 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key,
210 bool mandatory, const std::vector<uint8_t>& value) override;
211 V2_4::Error getLayerGenericMetadataKeys(
212 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override;
Alec Mouri85065692022-03-18 00:58:26 +0000213 Error getClientTargetProperty(
214 Display display,
215 aidl::android::hardware::graphics::composer3::ClientTargetPropertyWithBrightness*
216 outClientTargetProperty) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500217
218 // AIDL Composer HAL
Alec Mouri6da0e272022-02-07 12:45:57 -0800219 Error setLayerBrightness(Display display, Layer layer, float brightness) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500220 Error setLayerBlockingRegion(Display display, Layer layer,
221 const std::vector<IComposerClient::Rect>& blocking) override;
Kriti Dang7defaf32021-11-15 11:55:43 +0100222 Error setBootDisplayConfig(Display displayId, Config) override;
223 Error clearBootDisplayConfig(Display displayId) override;
224 Error getPreferredBootDisplayConfig(Display displayId, Config*) override;
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -0500225 Error getDisplayDecorationSupport(Display display,
226 std::optional<DisplayDecorationSupport>* support) override;
ramindani32cf0602022-03-02 02:30:29 +0000227 Error setIdleTimerEnabled(Display displayId, std::chrono::milliseconds timeout) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700228
ramindani06e518e2022-03-14 18:47:53 +0000229 Error getPhysicalDisplayOrientation(Display displayId,
230 AidlTransform* outDisplayOrientation) override;
231
Ady Abraham9fc28052021-10-14 17:21:38 -0700232private:
Ady Abraham9fc28052021-10-14 17:21:38 -0700233 // Many public functions above simply write a command into the command
234 // queue to batch the calls. validateDisplay and presentDisplay will call
235 // this function to execute the command queue.
236 Error execute();
237
238 // returns the default instance name for the given service
239 static std::string instance(const std::string& serviceName);
240
241 // 64KiB minus a small space for metadata such as read/write pointers
242 static constexpr size_t kWriterInitialSize = 64 * 1024 / sizeof(uint32_t) - 16;
243 // Max number of buffers that may be cached for a given layer
244 // We obtain this number by:
245 // 1. Tightly coupling this cache to the max size of BufferQueue
246 // 2. Adding an additional slot for the layer caching feature in SurfaceFlinger (see: Planner.h)
247 static const constexpr uint32_t kMaxLayerBufferCount = BufferQueue::NUM_BUFFER_SLOTS + 1;
Ady Abrahambea99ba2021-12-15 18:17:52 -0800248 ComposerClientWriter mWriter;
249 ComposerClientReader mReader;
Ady Abraham9fc28052021-10-14 17:21:38 -0700250
251 // Aidl interface
252 using AidlIComposer = aidl::android::hardware::graphics::composer3::IComposer;
253 using AidlIComposerClient = aidl::android::hardware::graphics::composer3::IComposerClient;
254 std::shared_ptr<AidlIComposer> mAidlComposer;
255 std::shared_ptr<AidlIComposerClient> mAidlComposerClient;
256 std::shared_ptr<AidlIComposerCallbackWrapper> mAidlComposerCallback;
257};
258
259} // namespace android::Hwc2