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