blob: 5128648218dccc3d01f710e3925a8039e2597ae2 [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"
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -040020#include <ftl/shared_mutex.h>
21#include <ftl/small_map.h>
Ady Abraham9fc28052021-10-14 17:21:38 -070022
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -040023#include <functional>
Ady Abraham9fc28052021-10-14 17:21:38 -070024#include <optional>
25#include <string>
Ady Abraham9fc28052021-10-14 17:21:38 -070026#include <utility>
27#include <vector>
28
29// TODO(b/129481165): remove the #pragma below and fix conversion issues
30#pragma clang diagnostic push
31#pragma clang diagnostic ignored "-Wconversion"
32#pragma clang diagnostic ignored "-Wextra"
33
34#include <android/hardware/graphics/composer/2.4/IComposer.h>
35#include <android/hardware/graphics/composer/2.4/IComposerClient.h>
36
37#include <aidl/android/hardware/graphics/composer3/IComposer.h>
38#include <aidl/android/hardware/graphics/composer3/IComposerClient.h>
Ady Abrahambea99ba2021-12-15 18:17:52 -080039#include <android/hardware/graphics/composer3/ComposerClientReader.h>
40#include <android/hardware/graphics/composer3/ComposerClientWriter.h>
Ady Abraham9fc28052021-10-14 17:21:38 -070041
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050042#include <aidl/android/hardware/graphics/composer3/Composition.h>
Leon Scroggins III5967aec2021-12-29 11:14:22 -050043#include <aidl/android/hardware/graphics/composer3/DisplayCapability.h>
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050044
Ady Abraham9fc28052021-10-14 17:21:38 -070045// TODO(b/129481165): remove the #pragma below and fix conversion issues
46#pragma clang diagnostic pop // ignored "-Wconversion -Wextra"
47
48namespace android::Hwc2 {
49
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -050050using aidl::android::hardware::graphics::common::DisplayDecorationSupport;
Ady Abrahambea99ba2021-12-15 18:17:52 -080051using aidl::android::hardware::graphics::composer3::ComposerClientReader;
52using aidl::android::hardware::graphics::composer3::ComposerClientWriter;
Sally Qi0cbd08b2022-08-17 12:12:28 -070053using aidl::android::hardware::graphics::composer3::OverlayProperties;
Ady Abraham9fc28052021-10-14 17:21:38 -070054
55class AidlIComposerCallbackWrapper;
56
Ady Abraham9fc28052021-10-14 17:21:38 -070057// Composer is a wrapper to IComposer, a proxy to server-side composer.
58class AidlComposer final : public Hwc2::Composer {
59public:
60 static bool isDeclared(const std::string& serviceName);
61
62 explicit AidlComposer(const std::string& serviceName);
63 ~AidlComposer() override;
64
Ady Abraham4d211cf2021-12-14 16:19:03 -080065 bool isSupported(OptionalFeature) const;
66
Ady Abrahamde549d42022-01-26 19:19:17 -080067 std::vector<aidl::android::hardware::graphics::composer3::Capability> getCapabilities()
68 override;
Ady Abraham9fc28052021-10-14 17:21:38 -070069 std::string dumpDebugInfo() override;
70
Yichi Chen3401b562022-01-17 15:42:35 +080071 void registerCallback(HWC2::ComposerCallback& callback) override;
Ady Abraham9fc28052021-10-14 17:21:38 -070072
73 // Reset all pending commands in the command buffer. Useful if you want to
74 // skip a frame but have already queued some commands.
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -040075 void resetCommands(Display) override;
Ady Abraham9fc28052021-10-14 17:21:38 -070076
77 // Explicitly flush all pending commands in the command buffer.
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -040078 Error executeCommands(Display) override;
Ady Abraham9fc28052021-10-14 17:21:38 -070079
80 uint32_t getMaxVirtualDisplayCount() override;
81 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
82 Display* outDisplay) override;
83 Error destroyVirtualDisplay(Display display) override;
84
85 Error acceptDisplayChanges(Display display) override;
86
87 Error createLayer(Display display, Layer* outLayer) override;
88 Error destroyLayer(Display display, Layer layer) override;
89
90 Error getActiveConfig(Display display, Config* outConfig) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050091 Error getChangedCompositionTypes(
92 Display display, std::vector<Layer>* outLayers,
93 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes)
94 override;
Ady Abraham9fc28052021-10-14 17:21:38 -070095 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override;
96 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute,
97 int32_t* outValue) override;
98 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs);
99 Error getDisplayName(Display display, std::string* outName) override;
100
101 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
102 std::vector<Layer>* outLayers,
103 std::vector<uint32_t>* outLayerRequestMasks) override;
104
105 Error getDozeSupport(Display display, bool* outSupport) override;
ramindani32cf0602022-03-02 02:30:29 +0000106 Error hasDisplayIdleTimerCapability(Display display, bool* outSupport) override;
Marc Kassisbdf7e4b2022-11-04 17:26:48 +0100107 Error getHdrCapabilities(Display display, std::vector<Hdr>* outHdrTypes, float* outMaxLuminance,
Ady Abraham9fc28052021-10-14 17:21:38 -0700108 float* outMaxAverageLuminance, float* outMinLuminance) override;
Sally Qi0cbd08b2022-08-17 12:12:28 -0700109 Error getOverlaySupport(OverlayProperties* outProperties) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700110
111 Error getReleaseFences(Display display, std::vector<Layer>* outLayers,
112 std::vector<int>* outReleaseFences) override;
113
114 Error presentDisplay(Display display, int* outPresentFence) override;
115
116 Error setActiveConfig(Display display, Config config) override;
117
118 /*
119 * The composer caches client targets internally. When target is nullptr,
120 * the composer uses slot to look up the client target from its cache.
121 * When target is not nullptr, the cache is updated with the new target.
122 */
123 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target,
124 int acquireFence, Dataspace dataspace,
125 const std::vector<IComposerClient::Rect>& damage) override;
126 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override;
Ady Abrahamdc011a92021-12-21 14:06:44 -0800127 Error setColorTransform(Display display, const float* matrix) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700128 Error setOutputBuffer(Display display, const native_handle_t* buffer,
129 int releaseFence) override;
130 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override;
131 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override;
132
133 Error setClientTargetSlotCount(Display display) override;
134
Ady Abraham43065bd2021-12-10 17:22:15 -0800135 Error validateDisplay(Display display, nsecs_t expectedPresentTime, uint32_t* outNumTypes,
Ady Abraham9fc28052021-10-14 17:21:38 -0700136 uint32_t* outNumRequests) override;
137
Ady Abraham43065bd2021-12-10 17:22:15 -0800138 Error presentOrValidateDisplay(Display display, nsecs_t expectedPresentTime,
139 uint32_t* outNumTypes, uint32_t* outNumRequests,
Ady Abraham9fc28052021-10-14 17:21:38 -0700140 int* outPresentFence, uint32_t* state) override;
141
142 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override;
143 /* see setClientTarget for the purpose of slot */
144 Error setLayerBuffer(Display display, Layer layer, uint32_t slot,
145 const sp<GraphicBuffer>& buffer, int acquireFence) override;
Brian Lindahl90553da2022-12-06 13:36:30 -0700146 Error clearLayerBufferSlot(Display display, Layer layer, uint32_t slot) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700147 Error setLayerSurfaceDamage(Display display, Layer layer,
148 const std::vector<IComposerClient::Rect>& damage) override;
149 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override;
Ady Abraham6e60b142022-01-06 18:10:35 -0800150 Error setLayerColor(Display display, Layer layer, const Color& color) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500151 Error setLayerCompositionType(
152 Display display, Layer layer,
153 aidl::android::hardware::graphics::composer3::Composition type) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700154 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override;
155 Error setLayerDisplayFrame(Display display, Layer layer,
156 const IComposerClient::Rect& frame) override;
157 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override;
158 Error setLayerSidebandStream(Display display, Layer layer,
159 const native_handle_t* stream) override;
160 Error setLayerSourceCrop(Display display, Layer layer,
161 const IComposerClient::FRect& crop) override;
162 Error setLayerTransform(Display display, Layer layer, Transform transform) override;
163 Error setLayerVisibleRegion(Display display, Layer layer,
164 const std::vector<IComposerClient::Rect>& visible) override;
165 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override;
166
167 // Composer HAL 2.2
168 Error setLayerPerFrameMetadata(
169 Display display, Layer layer,
170 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override;
171 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
172 Display display) override;
173 Error getRenderIntents(Display display, ColorMode colorMode,
174 std::vector<RenderIntent>* outRenderIntents) override;
175 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override;
176
177 // Composer HAL 2.3
178 Error getDisplayIdentificationData(Display display, uint8_t* outPort,
179 std::vector<uint8_t>* outData) override;
180 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override;
181 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
182 Dataspace* outDataspace,
183 uint8_t* outComponentMask) override;
184 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask,
185 uint64_t maxFrames) override;
186 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
187 DisplayedFrameStats* outStats) override;
188 Error setLayerPerFrameMetadataBlobs(
189 Display display, Layer layer,
190 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override;
Alec Mouri4d8a05d2022-03-23 18:14:26 +0000191 Error setDisplayBrightness(Display display, float brightness, float brightnessNits,
Alec Mouricdf16792021-12-10 13:16:06 -0800192 const DisplayBrightnessOptions& options) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700193
194 // Composer HAL 2.4
Leon Scroggins III5967aec2021-12-29 11:14:22 -0500195 Error getDisplayCapabilities(
196 Display display,
197 std::vector<aidl::android::hardware::graphics::composer3::DisplayCapability>*
198 outCapabilities) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700199 V2_4::Error getDisplayConnectionType(Display display,
200 IComposerClient::DisplayConnectionType* outType) override;
201 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override;
202 V2_4::Error setActiveConfigWithConstraints(
203 Display display, Config config,
204 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
205 VsyncPeriodChangeTimeline* outTimeline) override;
206 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override;
207 V2_4::Error getSupportedContentTypes(
208 Display displayId,
209 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override;
210 V2_4::Error setContentType(Display displayId,
211 IComposerClient::ContentType contentType) override;
212 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key,
213 bool mandatory, const std::vector<uint8_t>& value) override;
214 V2_4::Error getLayerGenericMetadataKeys(
215 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override;
Alec Mouri85065692022-03-18 00:58:26 +0000216 Error getClientTargetProperty(
217 Display display,
218 aidl::android::hardware::graphics::composer3::ClientTargetPropertyWithBrightness*
219 outClientTargetProperty) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500220
221 // AIDL Composer HAL
Alec Mouri6da0e272022-02-07 12:45:57 -0800222 Error setLayerBrightness(Display display, Layer layer, float brightness) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500223 Error setLayerBlockingRegion(Display display, Layer layer,
224 const std::vector<IComposerClient::Rect>& blocking) override;
Kriti Dang7defaf32021-11-15 11:55:43 +0100225 Error setBootDisplayConfig(Display displayId, Config) override;
226 Error clearBootDisplayConfig(Display displayId) override;
227 Error getPreferredBootDisplayConfig(Display displayId, Config*) override;
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -0500228 Error getDisplayDecorationSupport(Display display,
229 std::optional<DisplayDecorationSupport>* support) override;
ramindani32cf0602022-03-02 02:30:29 +0000230 Error setIdleTimerEnabled(Display displayId, std::chrono::milliseconds timeout) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700231
ramindani06e518e2022-03-14 18:47:53 +0000232 Error getPhysicalDisplayOrientation(Display displayId,
233 AidlTransform* outDisplayOrientation) override;
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -0400234 void onHotplugConnect(Display) override;
235 void onHotplugDisconnect(Display) override;
ramindani06e518e2022-03-14 18:47:53 +0000236
Ady Abraham9fc28052021-10-14 17:21:38 -0700237private:
Ady Abraham9fc28052021-10-14 17:21:38 -0700238 // Many public functions above simply write a command into the command
239 // queue to batch the calls. validateDisplay and presentDisplay will call
240 // this function to execute the command queue.
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -0400241 Error execute(Display) REQUIRES_SHARED(mMutex);
Ady Abraham9fc28052021-10-14 17:21:38 -0700242
243 // returns the default instance name for the given service
244 static std::string instance(const std::string& serviceName);
245
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -0400246 ftl::Optional<std::reference_wrapper<ComposerClientWriter>> getWriter(Display)
247 REQUIRES_SHARED(mMutex);
248 ftl::Optional<std::reference_wrapper<ComposerClientReader>> getReader(Display)
249 REQUIRES_SHARED(mMutex);
250 void addDisplay(Display) EXCLUDES(mMutex);
251 void removeDisplay(Display) EXCLUDES(mMutex);
252 void addReader(Display) REQUIRES(mMutex);
253 void removeReader(Display) REQUIRES(mMutex);
254
255 bool hasMultiThreadedPresentSupport(Display);
256
Ady Abraham9fc28052021-10-14 17:21:38 -0700257 // 64KiB minus a small space for metadata such as read/write pointers
258 static constexpr size_t kWriterInitialSize = 64 * 1024 / sizeof(uint32_t) - 16;
259 // Max number of buffers that may be cached for a given layer
260 // We obtain this number by:
261 // 1. Tightly coupling this cache to the max size of BufferQueue
262 // 2. Adding an additional slot for the layer caching feature in SurfaceFlinger (see: Planner.h)
263 static const constexpr uint32_t kMaxLayerBufferCount = BufferQueue::NUM_BUFFER_SLOTS + 1;
Leon Scroggins IIIe24d78f2022-09-20 16:38:19 -0400264
265 // Without DisplayCapability::MULTI_THREADED_PRESENT, we use a single reader
266 // for all displays. With the capability, we use a separate reader for each
267 // display.
268 bool mSingleReader = true;
269 // Invalid displayId used as a key to mReaders when mSingleReader is true.
270 static constexpr int64_t kSingleReaderKey = 0;
271
272 // TODO (b/256881188): Use display::PhysicalDisplayMap instead of hard-coded `3`
273 ftl::SmallMap<Display, ComposerClientWriter, 3> mWriters GUARDED_BY(mMutex);
274 ftl::SmallMap<Display, ComposerClientReader, 3> mReaders GUARDED_BY(mMutex);
275 // Protect access to mWriters and mReaders with a shared_mutex. Adding and
276 // removing a display require exclusive access, since the iterator or the
277 // writer/reader may be invalidated. Other calls need shared access while
278 // using the writer/reader, so they can use their display's writer/reader
279 // without it being deleted or the iterator being invalidated.
280 // TODO (b/257958323): Use std::shared_mutex and RAII once they support
281 // threading annotations.
282 ftl::SharedMutex mMutex;
Ady Abraham9fc28052021-10-14 17:21:38 -0700283
Brian Lindahl90553da2022-12-06 13:36:30 -0700284 // Buffer slots for layers are cleared by setting the slot buffer to this buffer.
285 sp<GraphicBuffer> mClearSlotBuffer;
286
Ady Abraham9fc28052021-10-14 17:21:38 -0700287 // Aidl interface
288 using AidlIComposer = aidl::android::hardware::graphics::composer3::IComposer;
289 using AidlIComposerClient = aidl::android::hardware::graphics::composer3::IComposerClient;
290 std::shared_ptr<AidlIComposer> mAidlComposer;
291 std::shared_ptr<AidlIComposerClient> mAidlComposerClient;
292 std::shared_ptr<AidlIComposerCallbackWrapper> mAidlComposerCallback;
293};
294
295} // namespace android::Hwc2