blob: 677001700a2d44e9e8fbe9bce4886da565b63f55 [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
Ady Abrahambea99ba2021-12-15 18:17:52 -080048using aidl::android::hardware::graphics::composer3::ComposerClientReader;
49using aidl::android::hardware::graphics::composer3::ComposerClientWriter;
Ady Abraham9fc28052021-10-14 17:21:38 -070050
51class AidlIComposerCallbackWrapper;
52
Ady Abraham9fc28052021-10-14 17:21:38 -070053// Composer is a wrapper to IComposer, a proxy to server-side composer.
54class AidlComposer final : public Hwc2::Composer {
55public:
56 static bool isDeclared(const std::string& serviceName);
57
58 explicit AidlComposer(const std::string& serviceName);
59 ~AidlComposer() override;
60
Ady Abraham4d211cf2021-12-14 16:19:03 -080061 bool isSupported(OptionalFeature) const;
62
Ady Abraham9fc28052021-10-14 17:21:38 -070063 std::vector<IComposer::Capability> getCapabilities() override;
64 std::string dumpDebugInfo() override;
65
66 void registerCallback(const sp<IComposerCallback>& callback) override;
67
68 // Reset all pending commands in the command buffer. Useful if you want to
69 // skip a frame but have already queued some commands.
70 void resetCommands() override;
71
72 // Explicitly flush all pending commands in the command buffer.
73 Error executeCommands() override;
74
75 uint32_t getMaxVirtualDisplayCount() override;
76 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
77 Display* outDisplay) override;
78 Error destroyVirtualDisplay(Display display) override;
79
80 Error acceptDisplayChanges(Display display) override;
81
82 Error createLayer(Display display, Layer* outLayer) override;
83 Error destroyLayer(Display display, Layer layer) override;
84
85 Error getActiveConfig(Display display, Config* outConfig) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -050086 Error getChangedCompositionTypes(
87 Display display, std::vector<Layer>* outLayers,
88 std::vector<aidl::android::hardware::graphics::composer3::Composition>* outTypes)
89 override;
Ady Abraham9fc28052021-10-14 17:21:38 -070090 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override;
91 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute,
92 int32_t* outValue) override;
93 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs);
94 Error getDisplayName(Display display, std::string* outName) override;
95
96 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
97 std::vector<Layer>* outLayers,
98 std::vector<uint32_t>* outLayerRequestMasks) override;
99
100 Error getDozeSupport(Display display, bool* outSupport) override;
101 Error getHdrCapabilities(Display display, std::vector<Hdr>* outTypes, float* outMaxLuminance,
102 float* outMaxAverageLuminance, float* outMinLuminance) override;
103
104 Error getReleaseFences(Display display, std::vector<Layer>* outLayers,
105 std::vector<int>* outReleaseFences) override;
106
107 Error presentDisplay(Display display, int* outPresentFence) override;
108
109 Error setActiveConfig(Display display, Config config) override;
110
111 /*
112 * The composer caches client targets internally. When target is nullptr,
113 * the composer uses slot to look up the client target from its cache.
114 * When target is not nullptr, the cache is updated with the new target.
115 */
116 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target,
117 int acquireFence, Dataspace dataspace,
118 const std::vector<IComposerClient::Rect>& damage) override;
119 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override;
Ady Abrahamdc011a92021-12-21 14:06:44 -0800120 Error setColorTransform(Display display, const float* matrix) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700121 Error setOutputBuffer(Display display, const native_handle_t* buffer,
122 int releaseFence) override;
123 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override;
124 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override;
125
126 Error setClientTargetSlotCount(Display display) override;
127
Ady Abraham43065bd2021-12-10 17:22:15 -0800128 Error validateDisplay(Display display, nsecs_t expectedPresentTime, uint32_t* outNumTypes,
Ady Abraham9fc28052021-10-14 17:21:38 -0700129 uint32_t* outNumRequests) override;
130
Ady Abraham43065bd2021-12-10 17:22:15 -0800131 Error presentOrValidateDisplay(Display display, nsecs_t expectedPresentTime,
132 uint32_t* outNumTypes, uint32_t* outNumRequests,
Ady Abraham9fc28052021-10-14 17:21:38 -0700133 int* outPresentFence, uint32_t* state) override;
134
135 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override;
136 /* see setClientTarget for the purpose of slot */
137 Error setLayerBuffer(Display display, Layer layer, uint32_t slot,
138 const sp<GraphicBuffer>& buffer, int acquireFence) override;
139 Error setLayerSurfaceDamage(Display display, Layer layer,
140 const std::vector<IComposerClient::Rect>& damage) override;
141 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override;
Ady Abraham6e60b142022-01-06 18:10:35 -0800142 Error setLayerColor(Display display, Layer layer, const Color& color) override;
Leon Scroggins III2e1aa182021-12-01 17:33:12 -0500143 Error setLayerCompositionType(
144 Display display, Layer layer,
145 aidl::android::hardware::graphics::composer3::Composition type) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700146 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override;
147 Error setLayerDisplayFrame(Display display, Layer layer,
148 const IComposerClient::Rect& frame) override;
149 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override;
150 Error setLayerSidebandStream(Display display, Layer layer,
151 const native_handle_t* stream) override;
152 Error setLayerSourceCrop(Display display, Layer layer,
153 const IComposerClient::FRect& crop) override;
154 Error setLayerTransform(Display display, Layer layer, Transform transform) override;
155 Error setLayerVisibleRegion(Display display, Layer layer,
156 const std::vector<IComposerClient::Rect>& visible) override;
157 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override;
158
159 // Composer HAL 2.2
160 Error setLayerPerFrameMetadata(
161 Display display, Layer layer,
162 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override;
163 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
164 Display display) override;
165 Error getRenderIntents(Display display, ColorMode colorMode,
166 std::vector<RenderIntent>* outRenderIntents) override;
167 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override;
168
169 // Composer HAL 2.3
170 Error getDisplayIdentificationData(Display display, uint8_t* outPort,
171 std::vector<uint8_t>* outData) override;
172 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override;
173 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
174 Dataspace* outDataspace,
175 uint8_t* outComponentMask) override;
176 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask,
177 uint64_t maxFrames) override;
178 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
179 DisplayedFrameStats* outStats) override;
180 Error setLayerPerFrameMetadataBlobs(
181 Display display, Layer layer,
182 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override;
Alec Mouricdf16792021-12-10 13:16:06 -0800183 Error setDisplayBrightness(Display display, float brightness,
184 const DisplayBrightnessOptions& options) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700185
186 // Composer HAL 2.4
Leon Scroggins III5967aec2021-12-29 11:14:22 -0500187 Error getDisplayCapabilities(
188 Display display,
189 std::vector<aidl::android::hardware::graphics::composer3::DisplayCapability>*
190 outCapabilities) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700191 V2_4::Error getDisplayConnectionType(Display display,
192 IComposerClient::DisplayConnectionType* outType) override;
193 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override;
194 V2_4::Error setActiveConfigWithConstraints(
195 Display display, Config config,
196 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
197 VsyncPeriodChangeTimeline* outTimeline) override;
198 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override;
199 V2_4::Error getSupportedContentTypes(
200 Display displayId,
201 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override;
202 V2_4::Error setContentType(Display displayId,
203 IComposerClient::ContentType contentType) override;
204 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key,
205 bool mandatory, const std::vector<uint8_t>& value) override;
206 V2_4::Error getLayerGenericMetadataKeys(
207 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override;
Alec Mouricdf6cbc2021-11-01 17:21:15 -0700208 Error getClientTargetProperty(Display display,
209 IComposerClient::ClientTargetProperty* outClientTargetProperty,
210 float* outClientTargetWhitePointNits) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500211
212 // AIDL Composer HAL
Alec Mouricdf6cbc2021-11-01 17:21:15 -0700213 Error setLayerWhitePointNits(Display display, Layer layer, float whitePointNits) override;
Leon Scroggins IIId77d3162022-01-05 10:42:28 -0500214 Error setLayerBlockingRegion(Display display, Layer layer,
215 const std::vector<IComposerClient::Rect>& blocking) override;
Kriti Dang7defaf32021-11-15 11:55:43 +0100216 Error setBootDisplayConfig(Display displayId, Config) override;
217 Error clearBootDisplayConfig(Display displayId) override;
218 Error getPreferredBootDisplayConfig(Display displayId, Config*) override;
Ady Abraham9fc28052021-10-14 17:21:38 -0700219
220private:
Ady Abraham9fc28052021-10-14 17:21:38 -0700221 // Many public functions above simply write a command into the command
222 // queue to batch the calls. validateDisplay and presentDisplay will call
223 // this function to execute the command queue.
224 Error execute();
225
226 // returns the default instance name for the given service
227 static std::string instance(const std::string& serviceName);
228
229 // 64KiB minus a small space for metadata such as read/write pointers
230 static constexpr size_t kWriterInitialSize = 64 * 1024 / sizeof(uint32_t) - 16;
231 // Max number of buffers that may be cached for a given layer
232 // We obtain this number by:
233 // 1. Tightly coupling this cache to the max size of BufferQueue
234 // 2. Adding an additional slot for the layer caching feature in SurfaceFlinger (see: Planner.h)
235 static const constexpr uint32_t kMaxLayerBufferCount = BufferQueue::NUM_BUFFER_SLOTS + 1;
Ady Abrahambea99ba2021-12-15 18:17:52 -0800236 ComposerClientWriter mWriter;
237 ComposerClientReader mReader;
Ady Abraham9fc28052021-10-14 17:21:38 -0700238
239 // Aidl interface
240 using AidlIComposer = aidl::android::hardware::graphics::composer3::IComposer;
241 using AidlIComposerClient = aidl::android::hardware::graphics::composer3::IComposerClient;
242 std::shared_ptr<AidlIComposer> mAidlComposer;
243 std::shared_ptr<AidlIComposerClient> mAidlComposerClient;
244 std::shared_ptr<AidlIComposerCallbackWrapper> mAidlComposerCallback;
245};
246
247} // namespace android::Hwc2