blob: 5408d5515c5679c9834aed25430008da80093b45 [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;
Ray Zhang49d5d0d2020-03-27 19:53:33 +0800192 virtual Error setLayerType(Display display, Layer layer, uint32_t type) = 0;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700193
194 // Composer HAL 2.2
Peiyong Lin0ac5f4e2018-04-19 22:06:34 -0700195 virtual Error setLayerPerFrameMetadata(
196 Display display, Layer layer,
197 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) = 0;
Chia-I Wud7e01d72018-06-21 13:39:09 +0800198 virtual std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
199 Display display) = 0;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700200 virtual Error getRenderIntents(Display display, ColorMode colorMode,
201 std::vector<RenderIntent>* outRenderIntents) = 0;
202 virtual Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) = 0;
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700203
204 // Composer HAL 2.3
205 virtual Error getDisplayIdentificationData(Display display, uint8_t* outPort,
206 std::vector<uint8_t>* outData) = 0;
Peiyong Lin698147a2018-09-14 13:27:18 -0700207 virtual Error setLayerColorTransform(Display display, Layer layer,
208 const float* matrix) = 0;
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700209 virtual Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
210 Dataspace* outDataspace,
211 uint8_t* outComponentMask) = 0;
Kevin DuBois74e53772018-11-19 10:52:38 -0800212 virtual Error setDisplayContentSamplingEnabled(Display display, bool enabled,
213 uint8_t componentMask, uint64_t maxFrames) = 0;
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700214 virtual Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
215 DisplayedFrameStats* outStats) = 0;
Valerie Haue9e843a2018-12-18 13:39:23 -0800216 virtual Error setLayerPerFrameMetadataBlobs(
217 Display display, Layer layer, const std::vector<PerFrameMetadataBlob>& metadata) = 0;
Dan Gittik57e63c52019-01-18 16:37:54 +0000218 virtual Error setDisplayBrightness(Display display, float brightness) = 0;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700219
220 // Composer HAL 2.4
Ady Abraham7159f572019-10-11 11:10:18 -0700221 virtual bool isVsyncPeriodSwitchSupported() = 0;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700222 virtual Error getDisplayCapabilities(Display display,
223 std::vector<DisplayCapability>* outCapabilities) = 0;
Ady Abraham7159f572019-10-11 11:10:18 -0700224 virtual V2_4::Error getDisplayConnectionType(
225 Display display, IComposerClient::DisplayConnectionType* outType) = 0;
226 virtual V2_4::Error getDisplayVsyncPeriod(Display display,
227 VsyncPeriodNanos* outVsyncPeriod) = 0;
228 virtual V2_4::Error setActiveConfigWithConstraints(
229 Display display, Config config,
230 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
231 VsyncPeriodChangeTimeline* outTimeline) = 0;
Galia Peycheva5492cb52019-10-30 14:13:16 +0100232
233 virtual V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) = 0;
234 virtual V2_4::Error getSupportedContentTypes(
235 Display displayId,
236 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) = 0;
237 virtual V2_4::Error setContentType(Display displayId,
238 IComposerClient::ContentType contentType) = 0;
Dan Stoza18d48cb2019-10-21 15:39:24 -0700239 virtual V2_4::Error setLayerGenericMetadata(Display display, Layer layer,
240 const std::string& key, bool mandatory,
241 const std::vector<uint8_t>& value) = 0;
242 virtual V2_4::Error getLayerGenericMetadataKeys(
243 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) = 0;
Peiyong Lindfc3f7c2020-05-07 20:15:50 -0700244 virtual Error getClientTargetProperty(
245 Display display, IComposerClient::ClientTargetProperty* outClientTargetProperty) = 0;
Padmanabhan Komanduru2a2048f2019-11-13 17:33:43 +0530246 virtual Error setDisplayElapseTime(Display display, uint64_t timeStamp) = 0;
Lloyd Piquea822d522017-12-20 16:42:57 -0800247};
248
249namespace impl {
250
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800251class CommandReader : public CommandReaderBase {
252public:
253 ~CommandReader();
254
255 // Parse and execute commands from the command queue. The commands are
256 // actually return values from the server and will be saved in ReturnData.
257 Error parse();
258
259 // Get and clear saved errors.
260 struct CommandError {
261 uint32_t location;
262 Error error;
263 };
264 std::vector<CommandError> takeErrors();
265
Chia-I Wu67e376d2016-12-19 11:36:22 +0800266 bool hasChanges(Display display, uint32_t* outNumChangedCompositionTypes,
267 uint32_t* outNumLayerRequestMasks) const;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800268
269 // Get and clear saved changed composition types.
270 void takeChangedCompositionTypes(Display display,
Chia-I Wu67e376d2016-12-19 11:36:22 +0800271 std::vector<Layer>* outLayers,
272 std::vector<IComposerClient::Composition>* outTypes);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800273
274 // Get and clear saved display requests.
275 void takeDisplayRequests(Display display,
Chia-I Wu67e376d2016-12-19 11:36:22 +0800276 uint32_t* outDisplayRequestMask, std::vector<Layer>* outLayers,
277 std::vector<uint32_t>* outLayerRequestMasks);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800278
279 // Get and clear saved release fences.
Chia-I Wu67e376d2016-12-19 11:36:22 +0800280 void takeReleaseFences(Display display, std::vector<Layer>* outLayers,
281 std::vector<int>* outReleaseFences);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800282
283 // Get and clear saved present fence.
Chia-I Wu67e376d2016-12-19 11:36:22 +0800284 void takePresentFence(Display display, int* outPresentFence);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800285
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700286 // Get what stage succeeded during PresentOrValidate: Present or Validate
287 void takePresentOrValidateStage(Display display, uint32_t * state);
288
Peiyong Lindfc3f7c2020-05-07 20:15:50 -0700289 // Get the client target properties requested by hardware composer.
290 void takeClientTargetProperty(Display display,
291 IComposerClient::ClientTargetProperty* outClientTargetProperty);
292
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800293private:
294 void resetData();
295
296 bool parseSelectDisplay(uint16_t length);
297 bool parseSetError(uint16_t length);
298 bool parseSetChangedCompositionTypes(uint16_t length);
299 bool parseSetDisplayRequests(uint16_t length);
300 bool parseSetPresentFence(uint16_t length);
301 bool parseSetReleaseFences(uint16_t length);
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700302 bool parseSetPresentOrValidateDisplayResult(uint16_t length);
Peiyong Linafa0f572020-01-13 16:35:02 -0800303 bool parseSetClientTargetProperty(uint16_t length);
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800304
305 struct ReturnData {
306 uint32_t displayRequests = 0;
307
308 std::vector<Layer> changedLayers;
309 std::vector<IComposerClient::Composition> compositionTypes;
310
311 std::vector<Layer> requestedLayers;
312 std::vector<uint32_t> requestMasks;
313
314 int presentFence = -1;
315
316 std::vector<Layer> releasedLayers;
317 std::vector<int> releaseFences;
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700318
319 uint32_t presentOrValidateState;
Peiyong Linafa0f572020-01-13 16:35:02 -0800320
321 // Composer 2.4 implementation can return a client target property
322 // structure to indicate the client target properties that hardware
323 // composer requests. The composer client must change the client target
324 // properties to match this request.
325 IComposerClient::ClientTargetProperty clientTargetProperty{PixelFormat::RGBA_8888,
326 Dataspace::UNKNOWN};
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800327 };
328
329 std::vector<CommandError> mErrors;
330 std::unordered_map<Display, ReturnData> mReturnData;
331
332 // When SELECT_DISPLAY is parsed, this is updated to point to the
333 // display's return data in mReturnData. We use it to avoid repeated
334 // map lookups.
335 ReturnData* mCurrentReturnData;
336};
337
Chia-I Wuaab99f52016-10-05 12:59:58 +0800338// Composer is a wrapper to IComposer, a proxy to server-side composer.
Lloyd Piquea822d522017-12-20 16:42:57 -0800339class Composer final : public Hwc2::Composer {
Chia-I Wuaab99f52016-10-05 12:59:58 +0800340public:
Chih-Hung Hsieh22749042018-12-20 15:50:39 -0800341 explicit Composer(const std::string& serviceName);
Lloyd Piquea822d522017-12-20 16:42:57 -0800342 ~Composer() override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800343
Lloyd Piquea822d522017-12-20 16:42:57 -0800344 std::vector<IComposer::Capability> getCapabilities() override;
345 std::string dumpDebugInfo() override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800346
Lloyd Piquea822d522017-12-20 16:42:57 -0800347 void registerCallback(const sp<IComposerCallback>& callback) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800348
Steven Thomas94e35b92017-07-26 18:48:28 -0700349 // Returns true if the connected composer service is running in a remote
350 // process, false otherwise. This will return false if the service is
351 // configured in passthrough mode, for example.
Lloyd Piquea822d522017-12-20 16:42:57 -0800352 bool isRemote() override;
Steven Thomas94e35b92017-07-26 18:48:28 -0700353
Steven Thomas0af4b9f2017-04-26 14:34:01 -0700354 // Reset all pending commands in the command buffer. Useful if you want to
355 // skip a frame but have already queued some commands.
Lloyd Piquea822d522017-12-20 16:42:57 -0800356 void resetCommands() override;
Steven Thomas0af4b9f2017-04-26 14:34:01 -0700357
Chia-I Wuae5a6b82017-10-10 09:09:22 -0700358 // Explicitly flush all pending commands in the command buffer.
Lloyd Piquea822d522017-12-20 16:42:57 -0800359 Error executeCommands() override;
Chia-I Wuae5a6b82017-10-10 09:09:22 -0700360
Lloyd Piquea822d522017-12-20 16:42:57 -0800361 uint32_t getMaxVirtualDisplayCount() override;
362 bool isUsingVrComposer() const override { return mIsUsingVrComposer; }
363 Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
364 Display* outDisplay) override;
365 Error destroyVirtualDisplay(Display display) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800366
Lloyd Piquea822d522017-12-20 16:42:57 -0800367 Error acceptDisplayChanges(Display display) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800368
Lloyd Piquea822d522017-12-20 16:42:57 -0800369 Error createLayer(Display display, Layer* outLayer) override;
370 Error destroyLayer(Display display, Layer layer) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800371
Lloyd Piquea822d522017-12-20 16:42:57 -0800372 Error getActiveConfig(Display display, Config* outConfig) override;
373 Error getChangedCompositionTypes(Display display, std::vector<Layer>* outLayers,
374 std::vector<IComposerClient::Composition>* outTypes) override;
375 Error getColorModes(Display display, std::vector<ColorMode>* outModes) override;
376 Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute,
377 int32_t* outValue) override;
Chia-I Wu67e376d2016-12-19 11:36:22 +0800378 Error getDisplayConfigs(Display display, std::vector<Config>* outConfigs);
Lloyd Piquea822d522017-12-20 16:42:57 -0800379 Error getDisplayName(Display display, std::string* outName) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800380
Chia-I Wu67e376d2016-12-19 11:36:22 +0800381 Error getDisplayRequests(Display display, uint32_t* outDisplayRequestMask,
Lloyd Piquea822d522017-12-20 16:42:57 -0800382 std::vector<Layer>* outLayers,
383 std::vector<uint32_t>* outLayerRequestMasks) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800384
Lloyd Piquea822d522017-12-20 16:42:57 -0800385 Error getDozeSupport(Display display, bool* outSupport) override;
386 Error getHdrCapabilities(Display display, std::vector<Hdr>* outTypes, float* outMaxLuminance,
387 float* outMaxAverageLuminance, float* outMinLuminance) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800388
Chia-I Wu67e376d2016-12-19 11:36:22 +0800389 Error getReleaseFences(Display display, std::vector<Layer>* outLayers,
Lloyd Piquea822d522017-12-20 16:42:57 -0800390 std::vector<int>* outReleaseFences) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800391
Lloyd Piquea822d522017-12-20 16:42:57 -0800392 Error presentDisplay(Display display, int* outPresentFence) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800393
Lloyd Piquea822d522017-12-20 16:42:57 -0800394 Error setActiveConfig(Display display, Config config) override;
Chia-I Wu06d63de2017-01-04 14:58:51 +0800395
396 /*
397 * The composer caches client targets internally. When target is nullptr,
398 * the composer uses slot to look up the client target from its cache.
399 * When target is not nullptr, the cache is updated with the new target.
400 */
Lloyd Piquea822d522017-12-20 16:42:57 -0800401 Error setClientTarget(Display display, uint32_t slot, const sp<GraphicBuffer>& target,
402 int acquireFence, Dataspace dataspace,
403 const std::vector<IComposerClient::Rect>& damage) override;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700404 Error setColorMode(Display display, ColorMode mode, RenderIntent renderIntent) override;
Lloyd Piquea822d522017-12-20 16:42:57 -0800405 Error setColorTransform(Display display, const float* matrix, ColorTransform hint) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800406 Error setOutputBuffer(Display display, const native_handle_t* buffer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800407 int releaseFence) override;
408 Error setPowerMode(Display display, IComposerClient::PowerMode mode) override;
409 Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800410
Lloyd Piquea822d522017-12-20 16:42:57 -0800411 Error setClientTargetSlotCount(Display display) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800412
Chia-I Wu67e376d2016-12-19 11:36:22 +0800413 Error validateDisplay(Display display, uint32_t* outNumTypes,
Lloyd Piquea822d522017-12-20 16:42:57 -0800414 uint32_t* outNumRequests) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800415
Lloyd Piquea822d522017-12-20 16:42:57 -0800416 Error presentOrValidateDisplay(Display display, uint32_t* outNumTypes, uint32_t* outNumRequests,
417 int* outPresentFence, uint32_t* state) override;
Fabien Sanglard249c0ae2017-06-19 19:22:36 -0700418
Lloyd Piquea822d522017-12-20 16:42:57 -0800419 Error setCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override;
Chia-I Wu06d63de2017-01-04 14:58:51 +0800420 /* see setClientTarget for the purpose of slot */
421 Error setLayerBuffer(Display display, Layer layer, uint32_t slot,
Lloyd Piquea822d522017-12-20 16:42:57 -0800422 const sp<GraphicBuffer>& buffer, int acquireFence) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800423 Error setLayerSurfaceDamage(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800424 const std::vector<IComposerClient::Rect>& damage) override;
425 Error setLayerBlendMode(Display display, Layer layer, IComposerClient::BlendMode mode) override;
426 Error setLayerColor(Display display, Layer layer, const IComposerClient::Color& color) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800427 Error setLayerCompositionType(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800428 IComposerClient::Composition type) override;
429 Error setLayerDataspace(Display display, Layer layer, Dataspace dataspace) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800430 Error setLayerDisplayFrame(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800431 const IComposerClient::Rect& frame) override;
432 Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800433 Error setLayerSidebandStream(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800434 const native_handle_t* stream) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800435 Error setLayerSourceCrop(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800436 const IComposerClient::FRect& crop) override;
437 Error setLayerTransform(Display display, Layer layer, Transform transform) override;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800438 Error setLayerVisibleRegion(Display display, Layer layer,
Lloyd Piquea822d522017-12-20 16:42:57 -0800439 const std::vector<IComposerClient::Rect>& visible) override;
440 Error setLayerZOrder(Display display, Layer layer, uint32_t z) override;
441 Error setLayerInfo(Display display, Layer layer, uint32_t type, uint32_t appId) override;
Ray Zhang49d5d0d2020-03-27 19:53:33 +0800442 Error setLayerType(Display display, Layer layer, uint32_t type) override;
Lloyd Piquea822d522017-12-20 16:42:57 -0800443
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700444 // Composer HAL 2.2
Peiyong Lin0ac5f4e2018-04-19 22:06:34 -0700445 Error setLayerPerFrameMetadata(
446 Display display, Layer layer,
447 const std::vector<IComposerClient::PerFrameMetadata>& perFrameMetadatas) override;
Chia-I Wud7e01d72018-06-21 13:39:09 +0800448 std::vector<IComposerClient::PerFrameMetadataKey> getPerFrameMetadataKeys(
449 Display display) override;
Peiyong Lin0e7a7912018-04-05 14:36:36 -0700450 Error getRenderIntents(Display display, ColorMode colorMode,
451 std::vector<RenderIntent>* outRenderIntents) override;
452 Error getDataspaceSaturationMatrix(Dataspace dataspace, mat4* outMatrix) override;
453
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700454 // Composer HAL 2.3
455 Error getDisplayIdentificationData(Display display, uint8_t* outPort,
456 std::vector<uint8_t>* outData) override;
Peiyong Lin698147a2018-09-14 13:27:18 -0700457 Error setLayerColorTransform(Display display, Layer layer, const float* matrix) override;
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700458 Error getDisplayedContentSamplingAttributes(Display display, PixelFormat* outFormat,
459 Dataspace* outDataspace,
460 uint8_t* outComponentMask) override;
Kevin DuBois74e53772018-11-19 10:52:38 -0800461 Error setDisplayContentSamplingEnabled(Display display, bool enabled, uint8_t componentMask,
462 uint64_t maxFrames) override;
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700463 Error getDisplayedContentSample(Display display, uint64_t maxFrames, uint64_t timestamp,
464 DisplayedFrameStats* outStats) override;
Valerie Haue9e843a2018-12-18 13:39:23 -0800465 Error setLayerPerFrameMetadataBlobs(
466 Display display, Layer layer,
467 const std::vector<IComposerClient::PerFrameMetadataBlob>& metadata) override;
Dan Gittik57e63c52019-01-18 16:37:54 +0000468 Error setDisplayBrightness(Display display, float brightness) override;
Padmanabhan Komanduru2a2048f2019-11-13 17:33:43 +0530469 Error setDisplayElapseTime(Display display, uint64_t timeStamp) override;
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700470
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700471 // Composer HAL 2.4
Ady Abraham7159f572019-10-11 11:10:18 -0700472 bool isVsyncPeriodSwitchSupported() override { return mClient_2_4 != nullptr; }
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700473 Error getDisplayCapabilities(Display display,
474 std::vector<DisplayCapability>* outCapabilities) override;
Ady Abraham7159f572019-10-11 11:10:18 -0700475 V2_4::Error getDisplayConnectionType(Display display,
476 IComposerClient::DisplayConnectionType* outType) override;
477 V2_4::Error getDisplayVsyncPeriod(Display display, VsyncPeriodNanos* outVsyncPeriod) override;
478 V2_4::Error setActiveConfigWithConstraints(
479 Display display, Config config,
480 const IComposerClient::VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
481 VsyncPeriodChangeTimeline* outTimeline) override;
Galia Peycheva5492cb52019-10-30 14:13:16 +0100482 V2_4::Error setAutoLowLatencyMode(Display displayId, bool on) override;
483 V2_4::Error getSupportedContentTypes(
484 Display displayId,
485 std::vector<IComposerClient::ContentType>* outSupportedContentTypes) override;
486 V2_4::Error setContentType(Display displayId,
487 IComposerClient::ContentType contentType) override;
Dan Stoza18d48cb2019-10-21 15:39:24 -0700488 V2_4::Error setLayerGenericMetadata(Display display, Layer layer, const std::string& key,
489 bool mandatory, const std::vector<uint8_t>& value) override;
490 V2_4::Error getLayerGenericMetadataKeys(
491 std::vector<IComposerClient::LayerGenericMetadataKey>* outKeys) override;
Peiyong Lindfc3f7c2020-05-07 20:15:50 -0700492 Error getClientTargetProperty(
493 Display display,
494 IComposerClient::ClientTargetProperty* outClientTargetProperty) override;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700495
Chia-I Wuaab99f52016-10-05 12:59:58 +0800496private:
mamik94e91f62019-08-19 09:11:33 -0700497#if defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500498 class CommandWriter : public CommandWriterBase {
499 public:
Chih-Hung Hsieh22749042018-12-20 15:50:39 -0800500 explicit CommandWriter(uint32_t initialMaxSize);
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500501 ~CommandWriter() override;
502
503 void setLayerInfo(uint32_t type, uint32_t appId);
Ray Zhang49d5d0d2020-03-27 19:53:33 +0800504 void setLayerType(uint32_t type);
Daniel Nicoara1f42e3a2017-04-10 13:27:32 -0400505 void setClientTargetMetadata(
506 const IVrComposerClient::BufferMetadata& metadata);
507 void setLayerBufferMetadata(
508 const IVrComposerClient::BufferMetadata& metadata);
Padmanabhan Komanduru2a2048f2019-11-13 17:33:43 +0530509 void setDisplayElapseTime(uint64_t time);
Daniel Nicoara1f42e3a2017-04-10 13:27:32 -0400510
511 private:
512 void writeBufferMetadata(
513 const IVrComposerClient::BufferMetadata& metadata);
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500514 };
mamik94e91f62019-08-19 09:11:33 -0700515#else
516 class CommandWriter : public CommandWriterBase {
517 public:
518 explicit CommandWriter(uint32_t initialMaxSize) : CommandWriterBase(initialMaxSize) {}
519 ~CommandWriter() override {}
Padmanabhan Komanduru2a2048f2019-11-13 17:33:43 +0530520
521 void setDisplayElapseTime(uint64_t time);
Ray Zhang49d5d0d2020-03-27 19:53:33 +0800522 void setLayerType(uint32_t type);
mamik94e91f62019-08-19 09:11:33 -0700523 };
524#endif // defined(USE_VR_COMPOSER) && USE_VR_COMPOSER
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500525
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800526 // Many public functions above simply write a command into the command
527 // queue to batch the calls. validateDisplay and presentDisplay will call
528 // this function to execute the command queue.
529 Error execute();
530
Dominik Laskowski6231aaf2018-04-02 17:10:23 -0700531 sp<V2_1::IComposer> mComposer;
532
533 sp<V2_1::IComposerClient> mClient;
Dominik Laskowskie9ef7c42018-03-12 19:34:30 -0700534 sp<V2_2::IComposerClient> mClient_2_2;
Dominik Laskowski25a4e7d2019-09-20 14:50:10 -0700535 sp<V2_3::IComposerClient> mClient_2_3;
536 sp<IComposerClient> mClient_2_4;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800537
538 // 64KiB minus a small space for metadata such as read/write pointers
539 static constexpr size_t kWriterInitialSize =
540 64 * 1024 / sizeof(uint32_t) - 16;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500541 CommandWriter mWriter;
Chia-I Wucd8d7f02016-11-16 11:02:31 +0800542 CommandReader mReader;
Daniel Nicoara2f5f8a52016-12-20 16:11:58 -0500543
Hendrik Wagenaar87670ff2017-02-01 12:10:46 -0800544 // When true, the we attach to the vr_hwcomposer service instead of the
545 // hwcomposer. This allows us to redirect surfaces to 3d surfaces in vr.
546 const bool mIsUsingVrComposer;
Chia-I Wuaab99f52016-10-05 12:59:58 +0800547};
548
Lloyd Piquea822d522017-12-20 16:42:57 -0800549} // namespace impl
550
Chia-I Wuaab99f52016-10-05 12:59:58 +0800551} // namespace Hwc2
552
553} // namespace android
554
555#endif // ANDROID_SF_COMPOSER_HAL_H