blob: b436408fb179c871bf5a4d9ffc2793f2afd2d7b6 [file] [log] [blame]
Ady Abraham9fc28052021-10-14 17:21:38 -07001/*
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 "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 <composer-command-buffer/2.4/ComposerCommandBuffer.h>
33#include <gui/BufferQueue.h>
34#include <gui/HdrMetadata.h>
35#include <math/mat4.h>
36#include <ui/DisplayedFrameStats.h>
37#include <ui/GraphicBuffer.h>
38#include <utils/StrongPointer.h>
39
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050040#include <aidl/android/hardware/graphics/composer3/Composition.h>
41
Ady Abraham9fc28052021-10-14 17:21:38 -070042// TODO(b/129481165): remove the #pragma below and fix conversion issues
43#pragma clang diagnostic pop // ignored "-Wconversion -Wextra"
44
45namespace android::Hwc2 {
46
47namespace types = hardware::graphics::common;
48
49namespace V2_1 = hardware::graphics::composer::V2_1;
50namespace V2_2 = hardware::graphics::composer::V2_2;
51namespace V2_3 = hardware::graphics::composer::V2_3;
52namespace V2_4 = hardware::graphics::composer::V2_4;
53
54using types::V1_0::ColorTransform;
55using types::V1_0::Transform;
56using types::V1_1::RenderIntent;
57using types::V1_2::ColorMode;
58using types::V1_2::Dataspace;
59using types::V1_2::Hdr;
60using types::V1_2::PixelFormat;
61
62using V2_1::Config;
63using V2_1::Display;
64using V2_1::Error;
65using V2_1::Layer;
66using V2_4::CommandReaderBase;
67using V2_4::CommandWriterBase;
68using V2_4::IComposer;
69using V2_4::IComposerCallback;
70using V2_4::IComposerClient;
71using V2_4::VsyncPeriodChangeTimeline;
72using V2_4::VsyncPeriodNanos;
Ady Abraham9fc28052021-10-14 17:21:38 -070073using PerFrameMetadata = IComposerClient::PerFrameMetadata;
74using PerFrameMetadataKey = IComposerClient::PerFrameMetadataKey;
75using PerFrameMetadataBlob = IComposerClient::PerFrameMetadataBlob;
76
77class CommandReader : public CommandReaderBase {
78public:
79 ~CommandReader();
80
81 // Parse and execute commands from the command queue. The commands are
82 // actually return values from the server and will be saved in ReturnData.
83 Error parse();
84
85 // Get and clear saved errors.
86 struct CommandError {
87 uint32_t location;
88 Error error;
89 };
90 std::vector<CommandError> takeErrors();
91
92 bool hasChanges(Display display, uint32_t* outNumChangedCompositionTypes,
93 uint32_t* outNumLayerRequestMasks) const;
94
95 // Get and clear saved changed composition types.
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050096 void takeChangedCompositionTypes(
97 Display display, std::vector<Layer>* outLayers,
98 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes);
Ady Abraham9fc28052021-10-14 17:21:38 -070099
100 // Get and clear saved display requests.
101 void takeDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
102 std::vector<Layer>* outLayers,
103 std::vector<uint32_t>* outLayerRequestMasks);
104
105 // Get and clear saved release fences.
106 void takeReleaseFences(Display display, std::vector<Layer>* outLayers,
107 std::vector<int>* outReleaseFences);
108
109 // Get and clear saved present fence.
110 void takePresentFence(Display display, int* outPresentFence);
111
112 // Get what stage succeeded during PresentOrValidate: Present or Validate
113 void takePresentOrValidateStage(Display display, uint32_t* state);
114
115 // Get the client target properties requested by hardware composer.
116 void takeClientTargetProperty(Display display,
117 IComposerClient::ClientTargetProperty* outClientTargetProperty);
118
119private:
120 void resetData();
121
122 bool parseSelectDisplay(uint16_t length);
123 bool parseSetError(uint16_t length);
124 bool parseSetChangedCompositionTypes(uint16_t length);
125 bool parseSetDisplayRequests(uint16_t length);
126 bool parseSetPresentFence(uint16_t length);
127 bool parseSetReleaseFences(uint16_t length);
128 bool parseSetPresentOrValidateDisplayResult(uint16_t length);
129 bool parseSetClientTargetProperty(uint16_t length);
130
131 struct ReturnData {
132 uint32_t displayRequests = 0;
133
134 std::vector<Layer> changedLayers;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500135 std::vector<aidl::android::hardware::graphics::composer3::Composition> compositionTypes;
Ady Abraham9fc28052021-10-14 17:21:38 -0700136
137 std::vector<Layer> requestedLayers;
138 std::vector<uint32_t> requestMasks;
139
140 int presentFence = -1;
141
142 std::vector<Layer> releasedLayers;
143 std::vector<int> releaseFences;
144
145 uint32_t presentOrValidateState;
146
147 // Composer 2.4 implementation can return a client target property
148 // structure to indicate the client target properties that hardware
149 // composer requests. The composer client must change the client target
150 // properties to match this request.
151 IComposerClient::ClientTargetProperty clientTargetProperty{PixelFormat::RGBA_8888,
152 Dataspace::UNKNOWN};
153 };
154
155 std::vector<CommandError> mErrors;
156 std::unordered_map<Display, ReturnData> mReturnData;
157
158 // When SELECT_DISPLAY is parsed, this is updated to point to the
159 // display's return data in mReturnData. We use it to avoid repeated
160 // map lookups.
161 ReturnData* mCurrentReturnData;
162};
163
164// Composer is a wrapper to IComposer, a proxy to server-side composer.
165class HidlComposer final : public Composer {
166public:
167 explicit HidlComposer(const std::string& serviceName);
168 ~HidlComposer() override;
169
Ady Abraham4d211cf2021-12-14 16:19:03 -0800170 bool isSupported(OptionalFeature) const;
171
Ady Abrahamde549d42022-01-26 19:19:17 -0800172 std::vector<aidl::android::hardware::graphics::composer3::Capability> getCapabilities()
173 override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700174 std::string dumpDebugInfo() override;
175
Yichi Chen3401b562022-01-17 15:42:35 +0800176 void registerCallback(HWC2::ComposerCallback& callback) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700177
178 // Reset all pending commands in the command buffer. Useful if you want to
179 // skip a frame but have already queued some commands.
180 void resetCommands() override;
181
182 // Explicitly flush all pending commands in the command buffer.
183 Error executeCommands() override;
184
185 uint32_t getMaxVirtualDisplayCount() override;
186 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
187 Display* outDisplay) override;
188 Error destroyVirtualDisplay(Display display) override;
189
190 Error acceptDisplayChanges(Display display) override;
191
192 Error createLayer(Display display, Layer* outLayer) override;
193 Error destroyLayer(Display display, Layer layer) override;
194
195 Error getActiveConfig(Display display, Config* outConfig) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500196 Error getChangedCompositionTypes(
197 Display display, std::vector<Layer>* outLayers,
198 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes)
199 override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700200 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override;
201 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute,
202 int32_t* outValue) override;
203 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs);
204 Error getDisplayName(Display display, std::string* outName) override;
205
206 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
207 std::vector<Layer>* outLayers,
208 std::vector<uint32_t>* outLayerRequestMasks) override;
209
210 Error getDozeSupport(Display display, bool* outSupport) override;
ramindani32cf0602022-03-02 02:30:29 +0000211 Error hasDisplayIdleTimerCapability(Display display, bool* outSupport) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700212 Error getHdrCapabilities(Display display, std::vector<Hdr>* outTypes, float* outMaxLuminance,
213 float* outMaxAverageLuminance, float* outMinLuminance) override;
Sally Qi0cbd08b2022-08-17 12:12:28 -0700214 Error getOverlaySupport(aidl::android::hardware::graphics::composer3::OverlayProperties*
215 outProperties) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700216
217 Error getReleaseFences(Display display, std::vector<Layer>* outLayers,
218 std::vector<int>* outReleaseFences) override;
219
220 Error presentDisplay(Display display, int* outPresentFence) override;
221
222 Error setActiveConfig(Display display, Config config) override;
223
224 /*
225 * The composer caches client targets internally. When target is nullptr,
226 * the composer uses slot to look up the client target from its cache.
227 * When target is not nullptr, the cache is updated with the new target.
228 */
229 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target,
230 int acquireFence, Dataspace dataspace,
231 const std::vector<IComposerClient::Rect>& damage) override;
232 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override;
Ady Abrahamdc011a92021-12-21 14:06:44 -0800233 Error setColorTransform(Display display, const float* matrix) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700234 Error setOutputBuffer(Display display, const native_handle_t* buffer,
235 int releaseFence) override;
236 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override;
237 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override;
238
239 Error setClientTargetSlotCount(Display display) override;
240
Ady Abraham43065bd2021-12-10 17:22:15 -0800241 Error validateDisplay(Display display, nsecs_t expectedPresentTime, uint32_t* outNumTypes,
Ady Abraham9fc28052021-10-14 17:21:38 -0700242 uint32_t* outNumRequests) override;
243
Ady Abraham43065bd2021-12-10 17:22:15 -0800244 Error presentOrValidateDisplay(Display display, nsecs_t expectedPresentTime,
245 uint32_t* outNumTypes, uint32_t* outNumRequests,
Ady Abraham9fc28052021-10-14 17:21:38 -0700246 int* outPresentFence, uint32_t* state) override;
247
248 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override;
249 /* see setClientTarget for the purpose of slot */
250 Error setLayerBuffer(Display display, Layer layer, uint32_t slot,
251 const sp<GraphicBuffer>& buffer, int acquireFence) override;
252 Error setLayerSurfaceDamage(Display display, Layer layer,
253 const std::vector<IComposerClient::Rect>& damage) override;
254 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override;
Ady Abraham6e60b142022-01-06 18:10:35 -0800255 Error setLayerColor(Display display, Layer layer,
256 const aidl::android::hardware::graphics::composer3::Color& color) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500257 Error setLayerCompositionType(
258 Display display, Layer layer,
259 aidl::android::hardware::graphics::composer3::Composition type) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700260 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override;
261 Error setLayerDisplayFrame(Display display, Layer layer,
262 const IComposerClient::Rect& frame) override;
263 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override;
264 Error setLayerSidebandStream(Display display, Layer layer,
265 const native_handle_t* stream) override;
266 Error setLayerSourceCrop(Display display, Layer layer,
267 const IComposerClient::FRect& crop) override;
268 Error setLayerTransform(Display display, Layer layer, Transform transform) override;
269 Error setLayerVisibleRegion(Display display, Layer layer,
270 const std::vector<IComposerClient::Rect>& visible) override;
271 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override;
272
273 // Composer HAL 2.2
274 Error setLayerPerFrameMetadata(
275 Display display, Layer layer,
276 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override;
277 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
278 Display display) override;
279 Error getRenderIntents(Display display, ColorMode colorMode,
280 std::vector<RenderIntent>* outRenderIntents) override;
281 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override;
282
283 // Composer HAL 2.3
284 Error getDisplayIdentificationData(Display display, uint8_t* outPort,
285 std::vector<uint8_t>* outData) override;
286 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override;
287 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
288 Dataspace* outDataspace,
289 uint8_t* outComponentMask) override;
290 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask,
291 uint64_t maxFrames) override;
292 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
293 DisplayedFrameStats* outStats) override;
294 Error setLayerPerFrameMetadataBlobs(
295 Display display, Layer layer,
296 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override;
Alec Mouri4d8a05d2022-03-23 18:14:26 +0000297 Error setDisplayBrightness(Display display, float brightness, float brightnessNits,
Alec Mouricdf16792021-12-10 13:16:06 -0800298 const DisplayBrightnessOptions& options) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700299
300 // Composer HAL 2.4
Leon Scroggins III5967aec2021-12-29 11:14:22 -0500301 Error getDisplayCapabilities(
302 Display display,
303 std::vector<aidl::android::hardware::graphics::composer3::DisplayCapability>*
304 outCapabilities) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700305 V2_4::Error getDisplayConnectionType(Display display,
306 IComposerClient::DisplayConnectionType* outType) override;
307 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override;
308 V2_4::Error setActiveConfigWithConstraints(
309 Display display, Config config,
310 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
311 VsyncPeriodChangeTimeline* outTimeline) override;
312 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override;
313 V2_4::Error getSupportedContentTypes(
314 Display displayId,
315 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override;
316 V2_4::Error setContentType(Display displayId,
317 IComposerClient::ContentType contentType) override;
318 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key,
319 bool mandatory, const std::vector<uint8_t>& value) override;
320 V2_4::Error getLayerGenericMetadataKeys(
321 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override;
Alec Mouri85065692022-03-18 00:58:26 +0000322 Error getClientTargetProperty(
323 Display display,
324 aidl::android::hardware::graphics::composer3::ClientTargetPropertyWithBrightness*
325 outClientTargetProperty) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500326
327 // AIDL Composer HAL
Alec Mouri6da0e272022-02-07 12:45:57 -0800328 Error setLayerBrightness(Display display, Layer layer, float brightness) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500329 Error setLayerBlockingRegion(Display display, Layer layer,
330 const std::vector<IComposerClient::Rect>& blocking) override;
Kriti Dang7defaf32021-11-15 11:55:43 +0100331 Error setBootDisplayConfig(Display displayId, Config) override;
332 Error clearBootDisplayConfig(Display displayId) override;
333 Error getPreferredBootDisplayConfig(Display displayId, Config*) override;
Leon Scroggins IIIe7c51c62022-02-01 15:53:54 -0500334 Error getDisplayDecorationSupport(
335 Display display,
336 std::optional<aidl::android::hardware::graphics::common::DisplayDecorationSupport>*
337 support) override;
ramindani32cf0602022-03-02 02:30:29 +0000338 Error setIdleTimerEnabled(Display displayId, std::chrono::milliseconds timeout) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700339
ramindani06e518e2022-03-14 18:47:53 +0000340 Error getPhysicalDisplayOrientation(Display displayId,
341 AidlTransform* outDisplayOrientation) override;
342
Ady Abraham9fc28052021-10-14 17:21:38 -0700343private:
344 class CommandWriter : public CommandWriterBase {
345 public:
346 explicit CommandWriter(uint32_t initialMaxSize) : CommandWriterBase(initialMaxSize) {}
347 ~CommandWriter() override {}
348 };
349
Yichi Chen3401b562022-01-17 15:42:35 +0800350 void registerCallback(const sp<IComposerCallback>& callback);
351
Ady Abraham9fc28052021-10-14 17:21:38 -0700352 // Many public functions above simply write a command into the command
353 // queue to batch the calls. validateDisplay and presentDisplay will call
354 // this function to execute the command queue.
355 Error execute();
356
357 sp<V2_1::IComposer> mComposer;
358
359 sp<V2_1::IComposerClient> mClient;
360 sp<V2_2::IComposerClient> mClient_2_2;
361 sp<V2_3::IComposerClient> mClient_2_3;
362 sp<IComposerClient> mClient_2_4;
363
364 // 64KiB minus a small space for metadata such as read/write pointers
365 static constexpr size_t kWriterInitialSize = 64 * 1024 / sizeof(uint32_t) - 16;
366 // Max number of buffers that may be cached for a given layer
367 // We obtain this number by:
368 // 1. Tightly coupling this cache to the max size of BufferQueue
369 // 2. Adding an additional slot for the layer caching feature in SurfaceFlinger (see: Planner.h)
370 static const constexpr uint32_t kMaxLayerBufferCount = BufferQueue::NUM_BUFFER_SLOTS + 1;
371 CommandWriter mWriter;
372 CommandReader mReader;
373};
374
375} // namespace android::Hwc2