blob: 00ef782ef71431973b83f3b9e9b280042a237c16 [file] [log] [blame]
Chia-I Wuaab99f52016-10-05 12:59:58 +08001/*
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#ifndef ANDROID_SF_COMPOSER_HAL_H
18#define ANDROID_SF_COMPOSER_HAL_H
19
Chia-I Wucd8d7f02016-11-16 11:02:31 +080020#include <memory>
Chia-I Wuaab99f52016-10-05 12:59:58 +080021#include <string>
Chia-I Wucd8d7f02016-11-16 11:02:31 +080022#include <unordered_map>
23#include <utility>
Chia-I Wuaab99f52016-10-05 12:59:58 +080024#include <vector>
25
Ady Abraham8a82ba62020-01-17 12:43:17 -080026// TODO(b/129481165): remove the #pragma below and fix conversion issues
27#pragma clang diagnostic push
28#pragma clang diagnostic ignored "-Wconversion"
29
mamik94e91f62019-08-19 09:11:33 -070030#if defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
31#include <android/frameworks/vr/composer/2.0/IVrComposerClient.h>
32#endif // defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
Peiyong Lin34beb7a2018-03-28 11:57:12 -070033#include <android/hardware/graphics/common/1.1/types.h>
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -070034#include <android/hardware/graphics/composer/2.4/IComposer.h>
35#include <android/hardware/graphics/composer/2.4/IComposerClient.h>
Peiyong Linafa0f572020-01-13 16:35:02 -080036#include <composer-command-buffer/2.4/ComposerCommandBuffer.h>
Courtney Goeltzenleuchterf9c98e52018-02-12 07:23:17 -070037#include <gui/HdrMetadata.h>
Peiyong Lin0e7a7912018-04-05 14:36:36 -070038#include <math/mat4.h>
Kevin DuBois1d4249a2018-08-29 10:45:14 -070039#include <ui/DisplayedFrameStats.h>
Lloyd Piqued0094aa2017-12-20 16:43:28 -080040#include <ui/GraphicBuffer.h>
Chia-I Wuaab99f52016-10-05 12:59:58 +080041#include <utils/StrongPointer.h>
42
Ady Abraham8a82ba62020-01-17 12:43:17 -080043// TODO(b/129481165): remove the #pragma below and fix conversion issues
44#pragma clang diagnostic pop // ignored "-Wconversion"
45
Chia-I Wuaab99f52016-10-05 12:59:58 +080046namespace android {
47
48namespace Hwc2 {
49
mamik94e91f62019-08-19 09:11:33 -070050#if defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
51using frameworks::vr::composer::V2_0::IVrComposerClient;
52#endif // defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
Daniel Nicoara1f42e3a2017-04-10 13:27:32 -040053
Dominik Laskowski6231aaf2018-04-02 17:10:23 -070054namespace types = hardware::graphics::common;
Chia-I Wuaab99f52016-10-05 12:59:58 +080055
Dominik Laskowski6231aaf2018-04-02 17:10:23 -070056namespace V2_1 = hardware::graphics::composer::V2_1;
57namespace V2_2 = hardware::graphics::composer::V2_2;
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -070058namespace V2_3 = hardware::graphics::composer::V2_3;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -070059namespace V2_4 = hardware::graphics::composer::V2_4;
Chia-I Wuaab99f52016-10-05 12:59:58 +080060
Dominik Laskowski6231aaf2018-04-02 17:10:23 -070061using types::V1_0::ColorTransform;
Dominik Laskowski6231aaf2018-04-02 17:10:23 -070062using types::V1_0::Transform;
Dominik Laskowski6231aaf2018-04-02 17:10:23 -070063using types::V1_1::RenderIntent;
Valerie Hau9758ae02018-10-09 16:05:09 -070064using types::V1_2::ColorMode;
65using types::V1_2::Dataspace;
Valerie Haue9e843a2018-12-18 13:39:23 -080066using types::V1_2::Hdr;
Kevin DuBois73d0f482019-01-25 11:18:03 -080067using types::V1_2::PixelFormat;
Valerie Haue9e843a2018-12-18 13:39:23 -080068
Dominik Laskowski6231aaf2018-04-02 17:10:23 -070069using V2_1::Config;
70using V2_1::Display;
71using V2_1::Error;
Dominik Laskowski6231aaf2018-04-02 17:10:23 -070072using V2_1::Layer;
Peiyong Linafa0f572020-01-13 16:35:02 -080073using V2_4::CommandReaderBase;
74using V2_4::CommandWriterBase;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -070075using V2_4::IComposer;
Ady Abraham7159f572019-10-11 11:10:18 -070076using V2_4::IComposerCallback;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -070077using V2_4::IComposerClient;
Ady Abraham7159f572019-10-11 11:10:18 -070078using V2_4::VsyncPeriodChangeTimeline;
79using V2_4::VsyncPeriodNanos;
Peiyong Lined531a32018-10-26 18:27:56 -070080using DisplayCapability = IComposerClient::DisplayCapability;
Peiyong Lin0ac5f4e2018-04-19 22:06:34 -070081using PerFrameMetadata = IComposerClient::PerFrameMetadata;
82using PerFrameMetadataKey = IComposerClient::PerFrameMetadataKey;
Valerie Haue9e843a2018-12-18 13:39:23 -080083using PerFrameMetadataBlob = IComposerClient::PerFrameMetadataBlob;
Peiyong Lin0ac5f4e2018-04-19 22:06:34 -070084
Lloyd Piquea822d522017-12-20 16:42:57 -080085class Composer {
86public:
87 virtual ~Composer() = 0;
88
89 virtual std::vector<IComposer::Capability> getCapabilities() = 0;
90 virtual std::string dumpDebugInfo() = 0;
91
92 virtual void registerCallback(const sp<IComposerCallback>& callback) = 0;
93
94 // Returns true if the connected composer service is running in a remote
95 // process, false otherwise. This will return false if the service is
96 // configured in passthrough mode, for example.
97 virtual bool isRemote() = 0;
98
99 // Reset all pending commands in the command buffer. Useful if you want to
100 // skip a frame but have already queued some commands.
101 virtual void resetCommands() = 0;
102
103 // Explicitly flush all pending commands in the command buffer.
104 virtual Error executeCommands() = 0;
105
106 virtual uint32_t getMaxVirtualDisplayCount() = 0;
107 virtual bool isUsingVrComposer() const = 0;
108 virtual Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
109 Display* outDisplay) = 0;
110 virtual Error destroyVirtualDisplay(Display display) = 0;
111
112 virtual Error acceptDisplayChanges(Display display) = 0;
113
114 virtual Error createLayer(Display display, Layer* outLayer) = 0;
115 virtual Error destroyLayer(Display display, Layer layer) = 0;
116
117 virtual Error getActiveConfig(Display display, Config* outConfig) = 0;
118 virtual Error getChangedCompositionTypes(
119 Display display, std::vector<Layer>* outLayers,
120 std::vector<IComposerClient::Composition>* outTypes) = 0;
121 virtual Error getColorModes(Display display, std::vector<ColorMode>* outModes) = 0;
122 virtual Error getDisplayAttribute(Display display, Config config,
123 IComposerClient::Attribute attribute, int32_t* outValue) = 0;
124 virtual Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs) = 0;
125 virtual Error getDisplayName(Display display, std::string* outName) = 0;
126
127 virtual Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
128 std::vector<Layer>* outLayers,
129 std::vector<uint32_t>* outLayerRequestMasks) = 0;
130
Lloyd Piquea822d522017-12-20 16:42:57 -0800131 virtual Error getDozeSupport(Display display, bool* outSupport) = 0;
132 virtual Error getHdrCapabilities(Display display, std::vector<Hdr>* outTypes,
133 float* outMaxLuminance, float* outMaxAverageLuminance,
134 float* outMinLuminance) = 0;
135
136 virtual Error getReleaseFences(Display display, std::vector<Layer>* outLayers,
137 std::vector<int>* outReleaseFences) = 0;
138
139 virtual Error presentDisplay(Display display, int* outPresentFence) = 0;
140
141 virtual Error setActiveConfig(Display display, Config config) = 0;
142
143 /*
144 * The composer caches client targets internally. When target is nullptr,
145 * the composer uses slot to look up the client target from its cache.
146 * When target is not nullptr, the cache is updated with the new target.
147 */
148 virtual Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target,
149 int acquireFence, Dataspace dataspace,
150 const std::vector<IComposerClient::Rect>& damage) = 0;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700151 virtual Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) = 0;
Lloyd Piquea822d522017-12-20 16:42:57 -0800152 virtual Error setColorTransform(Display display, const float* matrix, ColorTransform hint) = 0;
153 virtual Error setOutputBuffer(Display display, const native_handle_t* buffer,
154 int releaseFence) = 0;
155 virtual Error setPowerMode(Display display, IComposerClient::PowerMode mode) = 0;
156 virtual Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) = 0;
157
158 virtual Error setClientTargetSlotCount(Display display) = 0;
159
160 virtual Error validateDisplay(Display display, uint32_t* outNumTypes,
161 uint32_t* outNumRequests) = 0;
162
163 virtual Error presentOrValidateDisplay(Display display, uint32_t* outNumTypes,
164 uint32_t* outNumRequests, int* outPresentFence,
165 uint32_t* state) = 0;
166
167 virtual Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) = 0;
168 /* see setClientTarget for the purpose of slot */
169 virtual Error setLayerBuffer(Display display, Layer layer, uint32_t slot,
170 const sp<GraphicBuffer>& buffer, int acquireFence) = 0;
171 virtual Error setLayerSurfaceDamage(Display display, Layer layer,
172 const std::vector<IComposerClient::Rect>& damage) = 0;
173 virtual Error setLayerBlendMode(Display display, Layer layer,
174 IComposerClient::BlendMode mode) = 0;
175 virtual Error setLayerColor(Display display, Layer layer,
176 const IComposerClient::Color& color) = 0;
177 virtual Error setLayerCompositionType(Display display, Layer layer,
178 IComposerClient::Composition type) = 0;
179 virtual Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) = 0;
180 virtual Error setLayerDisplayFrame(Display display, Layer layer,
181 const IComposerClient::Rect& frame) = 0;
182 virtual Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) = 0;
183 virtual Error setLayerSidebandStream(Display display, Layer layer,
184 const native_handle_t* stream) = 0;
185 virtual Error setLayerSourceCrop(Display display, Layer layer,
186 const IComposerClient::FRect& crop) = 0;
187 virtual Error setLayerTransform(Display display, Layer layer, Transform transform) = 0;
188 virtual Error setLayerVisibleRegion(Display display, Layer layer,
189 const std::vector<IComposerClient::Rect>& visible) = 0;
190 virtual Error setLayerZOrder(Display display, Layer layer, uint32_t z) = 0;
191 virtual Error setLayerInfo(Display display, Layer layer, uint32_t type, uint32_t appId) = 0;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700192
193 // Composer HAL 2.2
Peiyong Lin0ac5f4e2018-04-19 22:06:34 -0700194 virtual Error setLayerPerFrameMetadata(
195 Display display, Layer layer,
196 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) = 0;
Chia-I Wud7e01d72018-06-21 13:39:09 +0800197 virtual std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
198 Display display) = 0;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700199 virtual Error getRenderIntents(Display display, ColorMode colorMode,
200 std::vector<RenderIntent>* outRenderIntents) = 0;
201 virtual Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) = 0;
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700202
203 // Composer HAL 2.3
204 virtual Error getDisplayIdentificationData(Display display, uint8_t* outPort,
205 std::vector<uint8_t>* outData) = 0;
Peiyong Lin698147a2018-09-14 13:27:18 -0700206 virtual Error setLayerColorTransform(Display display, Layer layer,
207 const float* matrix) = 0;
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700208 virtual Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
209 Dataspace* outDataspace,
210 uint8_t* outComponentMask) = 0;
Kevin DuBois74e53772018-11-19 10:52:38 -0800211 virtual Error setDisplayContentSamplingEnabled(Display display, bool enabled,
212 uint8_t componentMask, uint64_t maxFrames) = 0;
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700213 virtual Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
214 DisplayedFrameStats* outStats) = 0;
Valerie Haue9e843a2018-12-18 13:39:23 -0800215 virtual Error setLayerPerFrameMetadataBlobs(
216 Display display, Layer layer, const std::vector<PerFrameMetadataBlob>& metadata) = 0;
Dan Gittik57e63c52019-01-18 16:37:54 +0000217 virtual Error setDisplayBrightness(Display display, float brightness) = 0;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700218
219 // Composer HAL 2.4
Ady Abraham7159f572019-10-11 11:10:18 -0700220 virtual bool isVsyncPeriodSwitchSupported() = 0;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700221 virtual Error getDisplayCapabilities(Display display,
222 std::vector<DisplayCapability>* outCapabilities) = 0;
Ady Abraham7159f572019-10-11 11:10:18 -0700223 virtual V2_4::Error getDisplayConnectionType(
224 Display display, IComposerClient::DisplayConnectionType* outType) = 0;
225 virtual V2_4::Error getDisplayVsyncPeriod(Display display,
226 VsyncPeriodNanos* outVsyncPeriod) = 0;
227 virtual V2_4::Error setActiveConfigWithConstraints(
228 Display display, Config config,
229 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
230 VsyncPeriodChangeTimeline* outTimeline) = 0;
Galia Peycheva5492cb52019-10-30 14:13:16 +0100231
232 virtual V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) = 0;
233 virtual V2_4::Error getSupportedContentTypes(
234 Display displayId,
235 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) = 0;
236 virtual V2_4::Error setContentType(Display displayId,
237 IComposerClient::ContentType contentType) = 0;
Dan Stoza18d48cb2019-10-21 15:39:24 -0700238 virtual V2_4::Error setLayerGenericMetadata(Display display, Layer layer,
239 const std::string& key, bool mandatory,
240 const std::vector<uint8_t>& value) = 0;
241 virtual V2_4::Error getLayerGenericMetadataKeys(
242 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) = 0;
Peiyong Lindfc3f7c2020-05-07 20:15:50 -0700243 virtual Error getClientTargetProperty(
244 Display display, IComposerClient::ClientTargetProperty* outClientTargetProperty) = 0;
Lloyd Piquea822d522017-12-20 16:42:57 -0800245};
246
247namespace impl {
248
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800249class CommandReader : public CommandReaderBase {
250public:
251 ~CommandReader();
252
253 // Parse and execute commands from the command queue. The commands are
254 // actually return values from the server and will be saved in ReturnData.
255 Error parse();
256
257 // Get and clear saved errors.
258 struct CommandError {
259 uint32_t location;
260 Error error;
261 };
262 std::vector<CommandError> takeErrors();
263
Chia-I Wu67e376d2016-12-19 11:36:22 +0800264 bool hasChanges(Display display, uint32_t* outNumChangedCompositionTypes,
265 uint32_t* outNumLayerRequestMasks) const;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800266
267 // Get and clear saved changed composition types.
268 void takeChangedCompositionTypes(Display display,
Chia-I Wu67e376d2016-12-19 11:36:22 +0800269 std::vector<Layer>* outLayers,
270 std::vector<IComposerClient::Composition>* outTypes);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800271
272 // Get and clear saved display requests.
273 void takeDisplayRequests(Display display,
Chia-I Wu67e376d2016-12-19 11:36:22 +0800274 uint32_t* outDisplayRequestMask, std::vector<Layer>* outLayers,
275 std::vector<uint32_t>* outLayerRequestMasks);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800276
277 // Get and clear saved release fences.
Chia-I Wu67e376d2016-12-19 11:36:22 +0800278 void takeReleaseFences(Display display, std::vector<Layer>* outLayers,
279 std::vector<int>* outReleaseFences);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800280
281 // Get and clear saved present fence.
Chia-I Wu67e376d2016-12-19 11:36:22 +0800282 void takePresentFence(Display display, int* outPresentFence);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800283
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700284 // Get what stage succeeded during PresentOrValidate: Present or Validate
285 void takePresentOrValidateStage(Display display, uint32_t * state);
286
Peiyong Lindfc3f7c2020-05-07 20:15:50 -0700287 // Get the client target properties requested by hardware composer.
288 void takeClientTargetProperty(Display display,
289 IComposerClient::ClientTargetProperty* outClientTargetProperty);
290
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800291private:
292 void resetData();
293
294 bool parseSelectDisplay(uint16_t length);
295 bool parseSetError(uint16_t length);
296 bool parseSetChangedCompositionTypes(uint16_t length);
297 bool parseSetDisplayRequests(uint16_t length);
298 bool parseSetPresentFence(uint16_t length);
299 bool parseSetReleaseFences(uint16_t length);
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700300 bool parseSetPresentOrValidateDisplayResult(uint16_t length);
Peiyong Linafa0f572020-01-13 16:35:02 -0800301 bool parseSetClientTargetProperty(uint16_t length);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800302
303 struct ReturnData {
304 uint32_t displayRequests = 0;
305
306 std::vector<Layer> changedLayers;
307 std::vector<IComposerClient::Composition> compositionTypes;
308
309 std::vector<Layer> requestedLayers;
310 std::vector<uint32_t> requestMasks;
311
312 int presentFence = -1;
313
314 std::vector<Layer> releasedLayers;
315 std::vector<int> releaseFences;
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700316
317 uint32_t presentOrValidateState;
Peiyong Linafa0f572020-01-13 16:35:02 -0800318
319 // Composer 2.4 implementation can return a client target property
320 // structure to indicate the client target properties that hardware
321 // composer requests. The composer client must change the client target
322 // properties to match this request.
323 IComposerClient::ClientTargetProperty clientTargetProperty{PixelFormat::RGBA_8888,
324 Dataspace::UNKNOWN};
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800325 };
326
327 std::vector<CommandError> mErrors;
328 std::unordered_map<Display, ReturnData> mReturnData;
329
330 // When SELECT_DISPLAY is parsed, this is updated to point to the
331 // display's return data in mReturnData. We use it to avoid repeated
332 // map lookups.
333 ReturnData* mCurrentReturnData;
334};
335
Chia-I Wuaab99f52016-10-05 12:59:58 +0800336// Composer is a wrapper to IComposer, a proxy to server-side composer.
Lloyd Piquea822d522017-12-20 16:42:57 -0800337class Composer final : public Hwc2::Composer {
Chia-I Wuaab99f52016-10-05 12:59:58 +0800338public:
Chih-Hung Hsieh22749042018-12-20 15:50:39 -0800339 explicit Composer(const std::string& serviceName);
Lloyd Piquea822d522017-12-20 16:42:57 -0800340 ~Composer() override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800341
Lloyd Piquea822d522017-12-20 16:42:57 -0800342 std::vector<IComposer::Capability> getCapabilities() override;
343 std::string dumpDebugInfo() override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800344
Lloyd Piquea822d522017-12-20 16:42:57 -0800345 void registerCallback(const sp<IComposerCallback>& callback) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800346
Steven Thomas94e35b92017-07-26 18:48:28 -0700347 // Returns true if the connected composer service is running in a remote
348 // process, false otherwise. This will return false if the service is
349 // configured in passthrough mode, for example.
Lloyd Piquea822d522017-12-20 16:42:57 -0800350 bool isRemote() override;
Steven Thomas94e35b92017-07-26 18:48:28 -0700351
Steven Thomas0af4b9f2017-04-26 14:34:01 -0700352 // Reset all pending commands in the command buffer. Useful if you want to
353 // skip a frame but have already queued some commands.
Lloyd Piquea822d522017-12-20 16:42:57 -0800354 void resetCommands() override;
Steven Thomas0af4b9f2017-04-26 14:34:01 -0700355
Chia-I Wuae5a6b82017-10-10 09:09:22 -0700356 // Explicitly flush all pending commands in the command buffer.
Lloyd Piquea822d522017-12-20 16:42:57 -0800357 Error executeCommands() override;
Chia-I Wuae5a6b82017-10-10 09:09:22 -0700358
Lloyd Piquea822d522017-12-20 16:42:57 -0800359 uint32_t getMaxVirtualDisplayCount() override;
360 bool isUsingVrComposer() const override { return mIsUsingVrComposer; }
361 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
362 Display* outDisplay) override;
363 Error destroyVirtualDisplay(Display display) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800364
Lloyd Piquea822d522017-12-20 16:42:57 -0800365 Error acceptDisplayChanges(Display display) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800366
Lloyd Piquea822d522017-12-20 16:42:57 -0800367 Error createLayer(Display display, Layer* outLayer) override;
368 Error destroyLayer(Display display, Layer layer) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800369
Lloyd Piquea822d522017-12-20 16:42:57 -0800370 Error getActiveConfig(Display display, Config* outConfig) override;
371 Error getChangedCompositionTypes(Display display, std::vector<Layer>* outLayers,
372 std::vector<IComposerClient::Composition>* outTypes) override;
373 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override;
374 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute,
375 int32_t* outValue) override;
Chia-I Wu67e376d2016-12-19 11:36:22 +0800376 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs);
Lloyd Piquea822d522017-12-20 16:42:57 -0800377 Error getDisplayName(Display display, std::string* outName) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800378
Chia-I Wu67e376d2016-12-19 11:36:22 +0800379 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
Lloyd Piquea822d522017-12-20 16:42:57 -0800380 std::vector<Layer>* outLayers,
381 std::vector<uint32_t>* outLayerRequestMasks) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800382
Lloyd Piquea822d522017-12-20 16:42:57 -0800383 Error getDozeSupport(Display display, bool* outSupport) override;
384 Error getHdrCapabilities(Display display, std::vector<Hdr>* outTypes, float* outMaxLuminance,
385 float* outMaxAverageLuminance, float* outMinLuminance) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800386
Chia-I Wu67e376d2016-12-19 11:36:22 +0800387 Error getReleaseFences(Display display, std::vector<Layer>* outLayers,
Lloyd Piquea822d522017-12-20 16:42:57 -0800388 std::vector<int>* outReleaseFences) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800389
Lloyd Piquea822d522017-12-20 16:42:57 -0800390 Error presentDisplay(Display display, int* outPresentFence) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800391
Lloyd Piquea822d522017-12-20 16:42:57 -0800392 Error setActiveConfig(Display display, Config config) override;
Chia-I Wu06d63de2017-01-04 14:58:51 +0800393
394 /*
395 * The composer caches client targets internally. When target is nullptr,
396 * the composer uses slot to look up the client target from its cache.
397 * When target is not nullptr, the cache is updated with the new target.
398 */
Lloyd Piquea822d522017-12-20 16:42:57 -0800399 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target,
400 int acquireFence, Dataspace dataspace,
401 const std::vector<IComposerClient::Rect>& damage) override;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700402 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override;
Lloyd Piquea822d522017-12-20 16:42:57 -0800403 Error setColorTransform(Display display, const float* matrix, ColorTransform hint) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800404 Error setOutputBuffer(Display display, const native_handle_t* buffer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800405 int releaseFence) override;
406 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override;
407 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800408
Lloyd Piquea822d522017-12-20 16:42:57 -0800409 Error setClientTargetSlotCount(Display display) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800410
Chia-I Wu67e376d2016-12-19 11:36:22 +0800411 Error validateDisplay(Display display, uint32_t* outNumTypes,
Lloyd Piquea822d522017-12-20 16:42:57 -0800412 uint32_t* outNumRequests) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800413
Lloyd Piquea822d522017-12-20 16:42:57 -0800414 Error presentOrValidateDisplay(Display display, uint32_t* outNumTypes, uint32_t* outNumRequests,
415 int* outPresentFence, uint32_t* state) override;
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700416
Lloyd Piquea822d522017-12-20 16:42:57 -0800417 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override;
Chia-I Wu06d63de2017-01-04 14:58:51 +0800418 /* see setClientTarget for the purpose of slot */
419 Error setLayerBuffer(Display display, Layer layer, uint32_t slot,
Lloyd Piquea822d522017-12-20 16:42:57 -0800420 const sp<GraphicBuffer>& buffer, int acquireFence) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800421 Error setLayerSurfaceDamage(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800422 const std::vector<IComposerClient::Rect>& damage) override;
423 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override;
424 Error setLayerColor(Display display, Layer layer, const IComposerClient::Color& color) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800425 Error setLayerCompositionType(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800426 IComposerClient::Composition type) override;
427 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800428 Error setLayerDisplayFrame(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800429 const IComposerClient::Rect& frame) override;
430 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800431 Error setLayerSidebandStream(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800432 const native_handle_t* stream) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800433 Error setLayerSourceCrop(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800434 const IComposerClient::FRect& crop) override;
435 Error setLayerTransform(Display display, Layer layer, Transform transform) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800436 Error setLayerVisibleRegion(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800437 const std::vector<IComposerClient::Rect>& visible) override;
438 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override;
439 Error setLayerInfo(Display display, Layer layer, uint32_t type, uint32_t appId) override;
440
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700441 // Composer HAL 2.2
Peiyong Lin0ac5f4e2018-04-19 22:06:34 -0700442 Error setLayerPerFrameMetadata(
443 Display display, Layer layer,
444 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override;
Chia-I Wud7e01d72018-06-21 13:39:09 +0800445 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
446 Display display) override;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700447 Error getRenderIntents(Display display, ColorMode colorMode,
448 std::vector<RenderIntent>* outRenderIntents) override;
449 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override;
450
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700451 // Composer HAL 2.3
452 Error getDisplayIdentificationData(Display display, uint8_t* outPort,
453 std::vector<uint8_t>* outData) override;
Peiyong Lin698147a2018-09-14 13:27:18 -0700454 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override;
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700455 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
456 Dataspace* outDataspace,
457 uint8_t* outComponentMask) override;
Kevin DuBois74e53772018-11-19 10:52:38 -0800458 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask,
459 uint64_t maxFrames) override;
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700460 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
461 DisplayedFrameStats* outStats) override;
Valerie Haue9e843a2018-12-18 13:39:23 -0800462 Error setLayerPerFrameMetadataBlobs(
463 Display display, Layer layer,
464 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override;
Dan Gittik57e63c52019-01-18 16:37:54 +0000465 Error setDisplayBrightness(Display display, float brightness) override;
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700466
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700467 // Composer HAL 2.4
Ady Abraham7159f572019-10-11 11:10:18 -0700468 bool isVsyncPeriodSwitchSupported() override { return mClient_2_4 != nullptr; }
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700469 Error getDisplayCapabilities(Display display,
470 std::vector<DisplayCapability>* outCapabilities) override;
Ady Abraham7159f572019-10-11 11:10:18 -0700471 V2_4::Error getDisplayConnectionType(Display display,
472 IComposerClient::DisplayConnectionType* outType) override;
473 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override;
474 V2_4::Error setActiveConfigWithConstraints(
475 Display display, Config config,
476 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
477 VsyncPeriodChangeTimeline* outTimeline) override;
Galia Peycheva5492cb52019-10-30 14:13:16 +0100478 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override;
479 V2_4::Error getSupportedContentTypes(
480 Display displayId,
481 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override;
482 V2_4::Error setContentType(Display displayId,
483 IComposerClient::ContentType contentType) override;
Dan Stoza18d48cb2019-10-21 15:39:24 -0700484 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key,
485 bool mandatory, const std::vector<uint8_t>& value) override;
486 V2_4::Error getLayerGenericMetadataKeys(
487 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override;
Peiyong Lindfc3f7c2020-05-07 20:15:50 -0700488 Error getClientTargetProperty(
489 Display display,
490 IComposerClient::ClientTargetProperty* outClientTargetProperty) override;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700491
Chia-I Wuaab99f52016-10-05 12:59:58 +0800492private:
mamik94e91f62019-08-19 09:11:33 -0700493#if defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500494 class CommandWriter : public CommandWriterBase {
495 public:
Chih-Hung Hsieh22749042018-12-20 15:50:39 -0800496 explicit CommandWriter(uint32_t initialMaxSize);
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500497 ~CommandWriter() override;
498
499 void setLayerInfo(uint32_t type, uint32_t appId);
Daniel Nicoara1f42e3a2017-04-10 13:27:32 -0400500 void setClientTargetMetadata(
501 const IVrComposerClient::BufferMetadata& metadata);
502 void setLayerBufferMetadata(
503 const IVrComposerClient::BufferMetadata& metadata);
504
505 private:
506 void writeBufferMetadata(
507 const IVrComposerClient::BufferMetadata& metadata);
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500508 };
mamik94e91f62019-08-19 09:11:33 -0700509#else
510 class CommandWriter : public CommandWriterBase {
511 public:
512 explicit CommandWriter(uint32_t initialMaxSize) : CommandWriterBase(initialMaxSize) {}
513 ~CommandWriter() override {}
514 };
515#endif // defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500516
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800517 // Many public functions above simply write a command into the command
518 // queue to batch the calls. validateDisplay and presentDisplay will call
519 // this function to execute the command queue.
520 Error execute();
521
Dominik Laskowski6231aaf2018-04-02 17:10:23 -0700522 sp<V2_1::IComposer> mComposer;
523
524 sp<V2_1::IComposerClient> mClient;
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700525 sp<V2_2::IComposerClient> mClient_2_2;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700526 sp<V2_3::IComposerClient> mClient_2_3;
527 sp<IComposerClient> mClient_2_4;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800528
529 // 64KiB minus a small space for metadata such as read/write pointers
530 static constexpr size_t kWriterInitialSize =
531 64 * 1024 / sizeof(uint32_t) - 16;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500532 CommandWriter mWriter;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800533 CommandReader mReader;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500534
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800535 // When true, the we attach to the vr_hwcomposer service instead of the
536 // hwcomposer. This allows us to redirect surfaces to 3d surfaces in vr.
537 const bool mIsUsingVrComposer;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800538};
539
Lloyd Piquea822d522017-12-20 16:42:57 -0800540} // namespace impl
541
Chia-I Wuaab99f52016-10-05 12:59:58 +0800542} // namespace Hwc2
543
544} // namespace android
545
546#endif // ANDROID_SF_COMPOSER_HAL_H