blob: ad7bcb7d12a0782a0e6c3479a52249b5b9993dd5 [file] [log] [blame]
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 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
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080017#pragma once
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080018
John Reck22be6962021-03-10 12:59:54 -050019#include <android/gui/DisplayBrightness.h>
Alec Mouriadebf5c2021-01-05 12:57:36 -080020#include <android/gui/IFpsListener.h>
John Reck88270902021-03-18 11:27:35 -040021#include <android/gui/IHdrLayerInfoListener.h>
chaviw0ef7caa2021-01-05 11:04:50 -080022#include <android/gui/IScreenCaptureListener.h>
Pablo Gamito6ee484d2020-07-30 14:26:28 +000023#include <android/gui/ITransactionTraceListener.h>
Galia Peycheva8f04b302021-04-27 13:25:38 +020024#include <android/gui/ITunnelModeEnabledListener.h>
chaviw60c9d3e2021-06-04 12:52:17 -050025#include <android/gui/IWindowInfosListener.h>
Alec Mouriadebf5c2021-01-05 12:57:36 -080026#include <binder/IBinder.h>
27#include <binder/IInterface.h>
chaviw3277faf2021-05-19 16:45:23 -050028#include <ftl/Flags.h>
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -100029#include <gui/FrameTimelineInfo.h>
Marissa Wall3dad52d2019-03-22 14:03:19 -070030#include <gui/ITransactionCompletedListener.h>
Vishnu Nairb13bb952019-11-15 10:24:08 -080031#include <math/vec4.h>
Alec Mouriadebf5c2021-01-05 12:57:36 -080032#include <stdint.h>
33#include <sys/types.h>
Daniel Solomon42d04562019-01-20 21:03:19 -080034#include <ui/ConfigStoreTypes.h>
Marin Shalamanova524a092020-07-27 21:39:55 +020035#include <ui/DisplayId.h>
Marin Shalamanov228f46b2021-01-28 21:11:45 +010036#include <ui/DisplayMode.h>
Kevin DuBois1d4249a2018-08-29 10:45:14 -070037#include <ui/DisplayedFrameStats.h>
Svetoslavd85084b2014-03-20 10:28:31 -070038#include <ui/FrameStats.h>
Chavi Weingarten40482ff2017-11-30 01:51:40 +000039#include <ui/GraphicBuffer.h>
Peiyong Lin9f034472018-03-28 15:29:00 -070040#include <ui/GraphicTypes.h>
Kevin DuBois1d4249a2018-08-29 10:45:14 -070041#include <ui/PixelFormat.h>
Dominik Laskowski718f9602019-11-09 20:01:35 -080042#include <ui/Rotation.h>
Marissa Wall3dad52d2019-03-22 14:03:19 -070043#include <utils/Errors.h>
44#include <utils/RefBase.h>
45#include <utils/Timers.h>
46#include <utils/Vector.h>
47
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -080048#include <optional>
Robert Carr866455f2019-04-02 16:28:26 -070049#include <unordered_set>
Brian Anderson069b3652016-07-22 10:32:47 -070050#include <vector>
51
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080052namespace android {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080053
Marissa Wall947d34e2019-03-29 14:03:53 -070054struct client_cache_t;
Colin Crossa2362b42016-09-26 13:48:25 -070055struct ComposerState;
chaviwd2432892020-07-24 17:42:39 -070056struct DisplayCaptureArgs;
Lajos Molnare7bda062014-09-18 20:05:27 -070057struct DisplayStatInfo;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080058struct DisplayState;
chaviw273171b2018-12-26 11:46:30 -080059struct InputWindowCommands;
chaviwd2432892020-07-24 17:42:39 -070060struct LayerCaptureArgs;
Kalle Raitaa099a242017-01-11 11:17:29 -080061class LayerDebugInfo;
Dan Stozac4f471e2016-03-24 09:31:08 -070062class HdrCapabilities;
Mathias Agopiand0566bc2011-11-17 17:49:17 -080063class IDisplayEventConnection;
Mathias Agopian2b5dd402017-02-07 17:36:19 -080064class IGraphicBufferProducer;
65class ISurfaceComposerClient;
Dan Stoza84ab9372018-12-17 15:27:57 -080066class IRegionSamplingListener;
Dan Stozac1879002014-05-22 15:59:05 -070067class Rect;
Brian Anderson3890c392016-07-25 12:48:08 -070068enum class FrameEvent;
Mathias Agopiana67932f2011-04-20 14:20:59 -070069
chaviw0ef7caa2021-01-05 11:04:50 -080070using gui::IScreenCaptureListener;
71
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080072namespace ui {
73
Marin Shalamanova7fe3042021-01-29 21:02:08 +010074struct DisplayMode;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080075struct DisplayState;
Marin Shalamanov228f46b2021-01-28 21:11:45 +010076struct DynamicDisplayInfo;
77struct StaticDisplayInfo;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080078
79} // namespace ui
80
Andy McFadden882e3a32013-01-08 16:06:15 -080081/*
82 * This class defines the Binder IPC interface for accessing various
83 * SurfaceFlinger features.
84 */
Mathias Agopian3165cc22012-08-08 19:42:09 -070085class ISurfaceComposer: public IInterface {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080086public:
Colin Cross17576de2016-09-26 13:07:06 -070087 DECLARE_META_INTERFACE(SurfaceComposer)
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080088
Ady Abraham0a525092020-03-03 12:51:24 -080089 static constexpr size_t MAX_LAYERS = 4096;
90
Mathias Agopian3165cc22012-08-08 19:42:09 -070091 // flags for setTransactionState()
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080092 enum {
Mathias Agopian3165cc22012-08-08 19:42:09 -070093 eSynchronous = 0x01,
Ady Abrahambf1349c2020-06-12 14:26:18 -070094 eAnimation = 0x02,
Dan Stoza84d619e2018-03-28 17:07:36 -070095
Ady Abrahambf1349c2020-06-12 14:26:18 -070096 // Explicit indication that this transaction and others to follow will likely result in a
97 // lot of layers being composed, and thus, SurfaceFlinger should wake-up earlier to avoid
98 // missing frame deadlines. In this case SurfaceFlinger will wake up at
99 // (sf vsync offset - debug.sf.early_phase_offset_ns). SurfaceFlinger will continue to be
Ady Abraham8cbd3072021-03-15 16:39:06 -0700100 // in the early configuration until it receives eEarlyWakeupEnd. These flags are
Ady Abrahambf1349c2020-06-12 14:26:18 -0700101 // expected to be used by WindowManager only and are guarded by
102 // android.permission.ACCESS_SURFACE_FLINGER
Ady Abraham8cbd3072021-03-15 16:39:06 -0700103 eEarlyWakeupStart = 0x08,
104 eEarlyWakeupEnd = 0x10,
Jamie Gennis28378392011-10-12 17:39:00 -0700105 };
106
Jorim Jaggib1e2f8d2017-06-08 15:43:59 -0700107 enum VsyncSource {
108 eVsyncSourceApp = 0,
109 eVsyncSourceSurfaceFlinger = 1
110 };
111
Ady Abraham62f216c2020-10-13 19:07:23 -0700112 enum class EventRegistration {
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100113 modeChanged = 1 << 0,
Ady Abraham62f216c2020-10-13 19:07:23 -0700114 frameRateOverride = 1 << 1,
115 };
116
117 using EventRegistrationFlags = Flags<EventRegistration>;
Ady Abraham0f4a1b12019-06-04 16:04:04 -0700118
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800119 /*
Robert Carrb89ea9d2018-12-10 13:01:14 -0800120 * Create a connection with SurfaceFlinger.
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800121 */
Mathias Agopian7e27f052010-05-28 14:22:23 -0700122 virtual sp<ISurfaceComposerClient> createConnection() = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800123
Mathias Agopiane57f2922012-08-09 16:29:12 -0700124 /* return an IDisplayEventConnection */
Jorim Jaggib1e2f8d2017-06-08 15:43:59 -0700125 virtual sp<IDisplayEventConnection> createDisplayEventConnection(
Ady Abraham0f4a1b12019-06-04 16:04:04 -0700126 VsyncSource vsyncSource = eVsyncSourceApp,
Ady Abraham62f216c2020-10-13 19:07:23 -0700127 EventRegistrationFlags eventRegistration = {}) = 0;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700128
Jesse Hall6c913be2013-08-08 12:15:49 -0700129 /* create a virtual display
Mathias Agopiane57f2922012-08-09 16:29:12 -0700130 * requires ACCESS_SURFACE_FLINGER permission.
131 */
Jamie Gennisdd3cb842012-10-19 18:19:11 -0700132 virtual sp<IBinder> createDisplay(const String8& displayName,
133 bool secure) = 0;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700134
Jesse Hall6c913be2013-08-08 12:15:49 -0700135 /* destroy a virtual display
136 * requires ACCESS_SURFACE_FLINGER permission.
137 */
138 virtual void destroyDisplay(const sp<IBinder>& display) = 0;
139
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800140 /* get stable IDs for connected physical displays.
Mathias Agopiane57f2922012-08-09 16:29:12 -0700141 */
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800142 virtual std::vector<PhysicalDisplayId> getPhysicalDisplayIds() const = 0;
143
144 // TODO(b/74619554): Remove this stopgap once the framework is display-agnostic.
145 std::optional<PhysicalDisplayId> getInternalDisplayId() const {
146 const auto displayIds = getPhysicalDisplayIds();
147 return displayIds.empty() ? std::nullopt : std::make_optional(displayIds.front());
148 }
149
150 /* get token for a physical display given its stable ID obtained via getPhysicalDisplayIds or a
151 * DisplayEventReceiver hotplug event.
152 */
153 virtual sp<IBinder> getPhysicalDisplayToken(PhysicalDisplayId displayId) const = 0;
154
155 // TODO(b/74619554): Remove this stopgap once the framework is display-agnostic.
156 sp<IBinder> getInternalDisplayToken() const {
157 const auto displayId = getInternalDisplayId();
158 return displayId ? getPhysicalDisplayToken(*displayId) : nullptr;
159 }
Mathias Agopiane57f2922012-08-09 16:29:12 -0700160
Mathias Agopian9cce3252010-02-09 17:46:37 -0800161 /* open/close transactions. requires ACCESS_SURFACE_FLINGER permission */
chaviw308ddba2020-08-11 16:23:51 -0700162 virtual status_t setTransactionState(
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000163 const FrameTimelineInfo& frameTimelineInfo, const Vector<ComposerState>& state,
Ady Abraham22c7b5c2020-09-22 19:33:40 -0700164 const Vector<DisplayState>& displays, uint32_t flags, const sp<IBinder>& applyToken,
chaviw308ddba2020-08-11 16:23:51 -0700165 const InputWindowCommands& inputWindowCommands, int64_t desiredPresentTime,
Ady Abrahamf0c56492020-12-17 18:04:15 -0800166 bool isAutoTimestamp, const client_cache_t& uncacheBuffer, bool hasListenerCallbacks,
Pablo Gamito7eb7ee72020-08-05 10:57:05 +0000167 const std::vector<ListenerCallbacks>& listenerCallbacks, uint64_t transactionId) = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800168
169 /* signal that we're done booting.
Mathias Agopian9cce3252010-02-09 17:46:37 -0800170 * Requires ACCESS_SURFACE_FLINGER permission
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800171 */
172 virtual void bootFinished() = 0;
173
Andy McFadden2adaf042012-12-18 09:49:45 -0800174 /* verify that an IGraphicBufferProducer was created by SurfaceFlinger.
Mathias Agopiane57f2922012-08-09 16:29:12 -0700175 */
176 virtual bool authenticateSurfaceTexture(
Andy McFadden2adaf042012-12-18 09:49:45 -0800177 const sp<IGraphicBufferProducer>& surface) const = 0;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700178
Brian Anderson6b376712017-04-04 10:51:39 -0700179 /* Returns the frame timestamps supported by SurfaceFlinger.
180 */
181 virtual status_t getSupportedFrameTimestamps(
182 std::vector<FrameEvent>* outSupported) const = 0;
183
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700184 /* set display power mode. depending on the mode, it can either trigger
185 * screen on, off or low power mode and wait for it to complete.
Mathias Agopian041a0752013-03-15 18:31:56 -0700186 * requires ACCESS_SURFACE_FLINGER permission.
187 */
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700188 virtual void setPowerMode(const sp<IBinder>& display, int mode) = 0;
Mathias Agopian3094df32012-06-18 18:06:45 -0700189
Dan Stoza7f7da322014-05-02 15:26:25 -0700190
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700191 /* returns display statistics for a given display
192 * intended to be used by the media framework to properly schedule
193 * video frames */
194 virtual status_t getDisplayStats(const sp<IBinder>& display,
195 DisplayStatInfo* stats) = 0;
196
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800197 /**
198 * Get transactional state of given display.
199 */
200 virtual status_t getDisplayState(const sp<IBinder>& display, ui::DisplayState*) = 0;
201
202 /**
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100203 * Gets immutable information about given physical display.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800204 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100205 virtual status_t getStaticDisplayInfo(const sp<IBinder>& display, ui::StaticDisplayInfo*) = 0;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800206
207 /**
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100208 * Gets dynamic information about given physical display.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800209 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100210 virtual status_t getDynamicDisplayInfo(const sp<IBinder>& display, ui::DynamicDisplayInfo*) = 0;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800211
Daniel Solomon42d04562019-01-20 21:03:19 -0800212 virtual status_t getDisplayNativePrimaries(const sp<IBinder>& display,
213 ui::DisplayPrimaries& primaries) = 0;
Michael Wright28f24d02016-07-12 13:30:53 -0700214 virtual status_t setActiveColorMode(const sp<IBinder>& display,
Peiyong Lin9f034472018-03-28 15:29:00 -0700215 ui::ColorMode colorMode) = 0;
Michael Wright28f24d02016-07-12 13:30:53 -0700216
Chia-I Wuff79ef82018-08-22 15:27:32 -0700217 /**
Galia Peycheva5492cb52019-10-30 14:13:16 +0100218 * Switches Auto Low Latency Mode on/off on the connected display, if it is
Marin Shalamanovb173f752021-02-16 19:38:36 +0100219 * available. This should only be called if the display supports Auto Low
220 * Latency Mode as reported in #getDynamicDisplayInfo.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100221 * For more information, see the HDMI 2.1 specification.
222 */
223 virtual void setAutoLowLatencyMode(const sp<IBinder>& display, bool on) = 0;
224
225 /**
Galia Peycheva5492cb52019-10-30 14:13:16 +0100226 * This will start sending infoframes to the connected display with
Marin Shalamanovb173f752021-02-16 19:38:36 +0100227 * ContentType=Game (if on=true). This should only be called if the display
228 * Game Content Type as reported in #getDynamicDisplayInfo.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100229 * For more information, see the HDMI 1.4 specification.
230 */
231 virtual void setGameContentType(const sp<IBinder>& display, bool on) = 0;
232
233 /**
Chia-I Wuff79ef82018-08-22 15:27:32 -0700234 * Capture the specified screen. This requires READ_FRAME_BUFFER
235 * permission. This function will fail if there is a secure window on
chaviwd2432892020-07-24 17:42:39 -0700236 * screen and DisplayCaptureArgs.captureSecureLayers is false.
Chia-I Wuff79ef82018-08-22 15:27:32 -0700237 *
238 * This function can capture a subregion (the source crop) of the screen.
239 * The subregion can be optionally rotated. It will also be scaled to
240 * match the size of the output buffer.
Peiyong Lin0e003c92018-09-17 11:09:51 -0700241 */
chaviwd2432892020-07-24 17:42:39 -0700242 virtual status_t captureDisplay(const DisplayCaptureArgs& args,
chaviw8ffc7b82020-08-18 11:25:37 -0700243 const sp<IScreenCaptureListener>& captureListener) = 0;
Svetoslavd85084b2014-03-20 10:28:31 -0700244
chaviwd2432892020-07-24 17:42:39 -0700245 virtual status_t captureDisplay(uint64_t displayOrLayerStack,
chaviw8ffc7b82020-08-18 11:25:37 -0700246 const sp<IScreenCaptureListener>& captureListener) = 0;
chaviw93df2ea2019-04-30 16:45:12 -0700247
Robert Carr866455f2019-04-02 16:28:26 -0700248 template <class AA>
249 struct SpHash {
250 size_t operator()(const sp<AA>& k) const { return std::hash<AA*>()(k.get()); }
251 };
252
Robert Carr578038f2018-03-09 12:25:24 -0800253 /**
254 * Capture a subtree of the layer hierarchy, potentially ignoring the root node.
chaviw3efadb12020-07-27 10:07:15 -0700255 * This requires READ_FRAME_BUFFER permission. This function will fail if there
256 * is a secure window on screen
Robert Carr578038f2018-03-09 12:25:24 -0800257 */
chaviw3efadb12020-07-27 10:07:15 -0700258 virtual status_t captureLayers(const LayerCaptureArgs& args,
chaviw8ffc7b82020-08-18 11:25:37 -0700259 const sp<IScreenCaptureListener>& captureListener) = 0;
Peiyong Lin0e003c92018-09-17 11:09:51 -0700260
Svetoslavd85084b2014-03-20 10:28:31 -0700261 /* Clears the frame statistics for animations.
262 *
263 * Requires the ACCESS_SURFACE_FLINGER permission.
264 */
265 virtual status_t clearAnimationFrameStats() = 0;
266
267 /* Gets the frame statistics for animations.
268 *
269 * Requires the ACCESS_SURFACE_FLINGER permission.
270 */
271 virtual status_t getAnimationFrameStats(FrameStats* outStats) const = 0;
Dan Stozac4f471e2016-03-24 09:31:08 -0700272
Kriti Dang49ad4132021-01-08 11:49:56 +0100273 /* Overrides the supported HDR modes for the given display device.
274 *
275 * Requires the ACCESS_SURFACE_FLINGER permission.
276 */
277 virtual status_t overrideHdrTypes(const sp<IBinder>& display,
278 const std::vector<ui::Hdr>& hdrTypes) = 0;
279
Tej Singhe2751772021-04-06 22:05:29 -0700280 /* Pulls surfaceflinger atoms global stats and layer stats to pipe to statsd.
281 *
282 * Requires the calling uid be from system server.
283 */
284 virtual status_t onPullAtom(const int32_t atomId, std::string* outData, bool* success) = 0;
285
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -0700286 virtual status_t enableVSyncInjections(bool enable) = 0;
287
288 virtual status_t injectVSync(nsecs_t when) = 0;
Kalle Raitaa099a242017-01-11 11:17:29 -0800289
290 /* Gets the list of active layers in Z order for debugging purposes
291 *
292 * Requires the ACCESS_SURFACE_FLINGER permission.
293 */
Vishnu Nair43bccf82020-06-05 10:53:37 -0700294 virtual status_t getLayerDebugInfo(std::vector<LayerDebugInfo>* outLayers) = 0;
Peiyong Lin0256f722018-08-31 15:45:10 -0700295
Ady Abraham37965d42018-11-01 13:43:32 -0700296 virtual status_t getColorManagement(bool* outGetColorManagement) const = 0;
Peiyong Linc6780972018-10-28 15:24:08 -0700297
298 /* Gets the composition preference of the default data space and default pixel format,
299 * as well as the wide color gamut data space and wide color gamut pixel format.
300 * If the wide color gamut data space is V0_SRGB, then it implies that the platform
301 * has no wide color gamut support.
302 *
303 * Requires the ACCESS_SURFACE_FLINGER permission.
304 */
305 virtual status_t getCompositionPreference(ui::Dataspace* defaultDataspace,
306 ui::PixelFormat* defaultPixelFormat,
307 ui::Dataspace* wideColorGamutDataspace,
308 ui::PixelFormat* wideColorGamutPixelFormat) const = 0;
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700309 /*
310 * Requires the ACCESS_SURFACE_FLINGER permission.
311 */
312 virtual status_t getDisplayedContentSamplingAttributes(const sp<IBinder>& display,
313 ui::PixelFormat* outFormat,
314 ui::Dataspace* outDataspace,
315 uint8_t* outComponentMask) const = 0;
Kevin DuBois74e53772018-11-19 10:52:38 -0800316
317 /* Turns on the color sampling engine on the display.
318 *
319 * Requires the ACCESS_SURFACE_FLINGER permission.
320 */
321 virtual status_t setDisplayContentSamplingEnabled(const sp<IBinder>& display, bool enable,
322 uint8_t componentMask,
Dominik Laskowski470df5f2020-04-02 22:27:42 -0700323 uint64_t maxFrames) = 0;
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700324
325 /* Returns statistics on the color profile of the last frame displayed for a given display
326 *
327 * Requires the ACCESS_SURFACE_FLINGER permission.
328 */
329 virtual status_t getDisplayedContentSample(const sp<IBinder>& display, uint64_t maxFrames,
330 uint64_t timestamp,
331 DisplayedFrameStats* outStats) const = 0;
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800332
333 /*
334 * Gets whether SurfaceFlinger can support protected content in GPU composition.
335 * Requires the ACCESS_SURFACE_FLINGER permission.
336 */
337 virtual status_t getProtectedContentSupport(bool* outSupported) const = 0;
Marissa Wallebc2c052019-01-16 19:16:55 -0800338
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800339 /*
340 * Queries whether the given display is a wide color display.
341 * Requires the ACCESS_SURFACE_FLINGER permission.
342 */
343 virtual status_t isWideColorDisplay(const sp<IBinder>& token,
344 bool* outIsWideColorDisplay) const = 0;
Dan Stoza84ab9372018-12-17 15:27:57 -0800345
346 /* Registers a listener to stream median luma updates from SurfaceFlinger.
347 *
348 * The sampling area is bounded by both samplingArea and the given stopLayerHandle
349 * (i.e., only layers behind the stop layer will be captured and sampled).
350 *
351 * Multiple listeners may be provided so long as they have independent listeners.
352 * If multiple listeners are provided, the effective sampling region for each listener will
353 * be bounded by whichever stop layer has a lower Z value.
354 *
355 * Requires the same permissions as captureLayers and captureScreen.
356 */
357 virtual status_t addRegionSamplingListener(const Rect& samplingArea,
358 const sp<IBinder>& stopLayerHandle,
359 const sp<IRegionSamplingListener>& listener) = 0;
360
361 /*
362 * Removes a listener that was streaming median luma updates from SurfaceFlinger.
363 */
364 virtual status_t removeRegionSamplingListener(const sp<IRegionSamplingListener>& listener) = 0;
Ady Abraham838de062019-02-04 10:24:03 -0800365
Alec Mouriadebf5c2021-01-05 12:57:36 -0800366 /* Registers a listener that streams fps updates from SurfaceFlinger.
367 *
Alec Mouria9a68a62021-03-04 19:14:50 -0800368 * The listener will stream fps updates for the layer tree rooted at the layer denoted by the
369 * task ID, i.e., the layer must have the task ID as part of its layer metadata with key
370 * METADATA_TASK_ID. If there is no such layer, then no fps is expected to be reported.
Alec Mouriadebf5c2021-01-05 12:57:36 -0800371 *
372 * Multiple listeners may be supported.
373 *
Alec Mouria9a68a62021-03-04 19:14:50 -0800374 * Requires the READ_FRAME_BUFFER permission.
Alec Mouriadebf5c2021-01-05 12:57:36 -0800375 */
Alec Mouria9a68a62021-03-04 19:14:50 -0800376 virtual status_t addFpsListener(int32_t taskId, const sp<gui::IFpsListener>& listener) = 0;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800377 /*
378 * Removes a listener that was streaming fps updates from SurfaceFlinger.
379 */
380 virtual status_t removeFpsListener(const sp<gui::IFpsListener>& listener) = 0;
381
Galia Peycheva8f04b302021-04-27 13:25:38 +0200382 /* Registers a listener to receive tunnel mode enabled updates from SurfaceFlinger.
383 *
384 * Requires ACCESS_SURFACE_FLINGER permission.
385 */
386 virtual status_t addTunnelModeEnabledListener(
387 const sp<gui::ITunnelModeEnabledListener>& listener) = 0;
388
389 /*
390 * Removes a listener that was receiving tunnel mode enabled updates from SurfaceFlinger.
391 *
392 * Requires ACCESS_SURFACE_FLINGER permission.
393 */
394 virtual status_t removeTunnelModeEnabledListener(
395 const sp<gui::ITunnelModeEnabledListener>& listener) = 0;
396
Steven Thomasf734df42020-04-13 21:09:28 -0700397 /* Sets the refresh rate boundaries for the display.
398 *
399 * The primary refresh rate range represents display manager's general guidance on the display
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100400 * modes we'll consider when switching refresh rates. Unless we get an explicit signal from an
Steven Thomasf734df42020-04-13 21:09:28 -0700401 * app, we should stay within this range.
402 *
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100403 * The app request refresh rate range allows us to consider more display modes when switching
Steven Thomasf734df42020-04-13 21:09:28 -0700404 * refresh rates. Although we should generally stay within the primary range, specific
405 * considerations, such as layer frame rate settings specified via the setFrameRate() api, may
406 * cause us to go outside the primary range. We never go outside the app request range. The app
407 * request range will be greater than or equal to the primary refresh rate range, never smaller.
408 *
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100409 * defaultMode is used to narrow the list of display modes SurfaceFlinger will consider
410 * switching between. Only modes with a mode group and resolution matching defaultMode
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100411 * will be considered for switching. The defaultMode corresponds to an ID of mode in the list
412 * of supported modes returned from getDynamicDisplayInfo().
Ana Krulec0782b882019-10-15 17:34:54 -0700413 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100414 virtual status_t setDesiredDisplayModeSpecs(
415 const sp<IBinder>& displayToken, ui::DisplayModeId defaultMode,
416 bool allowGroupSwitching, float primaryRefreshRateMin, float primaryRefreshRateMax,
417 float appRequestRefreshRateMin, float appRequestRefreshRateMax) = 0;
Ana Krulec0782b882019-10-15 17:34:54 -0700418
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100419 virtual status_t getDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
420 ui::DisplayModeId* outDefaultMode,
421 bool* outAllowGroupSwitching,
422 float* outPrimaryRefreshRateMin,
423 float* outPrimaryRefreshRateMax,
424 float* outAppRequestRefreshRateMin,
425 float* outAppRequestRefreshRateMax) = 0;
Ana Krulec0782b882019-10-15 17:34:54 -0700426 /*
Dan Gittik57e63c52019-01-18 16:37:54 +0000427 * Gets whether brightness operations are supported on a display.
428 *
429 * displayToken
430 * The token of the display.
431 * outSupport
432 * An output parameter for whether brightness operations are supported.
433 *
434 * Returns NO_ERROR upon success. Otherwise,
435 * NAME_NOT_FOUND if the display is invalid, or
436 * BAD_VALUE if the output parameter is invalid.
437 */
438 virtual status_t getDisplayBrightnessSupport(const sp<IBinder>& displayToken,
439 bool* outSupport) const = 0;
440
441 /*
442 * Sets the brightness of a display.
443 *
444 * displayToken
445 * The token of the display whose brightness is set.
446 * brightness
John Reck22be6962021-03-10 12:59:54 -0500447 * The DisplayBrightness info to set on the desired display.
Dan Gittik57e63c52019-01-18 16:37:54 +0000448 *
449 * Returns NO_ERROR upon success. Otherwise,
450 * NAME_NOT_FOUND if the display is invalid, or
451 * BAD_VALUE if the brightness is invalid, or
452 * INVALID_OPERATION if brightness operations are not supported.
453 */
John Reck22be6962021-03-10 12:59:54 -0500454 virtual status_t setDisplayBrightness(const sp<IBinder>& displayToken,
455 const gui::DisplayBrightness& brightness) = 0;
Ady Abraham8532d012019-05-08 14:50:56 -0700456
457 /*
John Reck88270902021-03-18 11:27:35 -0400458 * Adds a listener that receives HDR layer information. This is used in combination
459 * with setDisplayBrightness to adjust the display brightness depending on factors such
460 * as whether or not HDR is in use.
461 *
462 * Returns NO_ERROR upon success or NAME_NOT_FOUND if the display is invalid.
463 */
464 virtual status_t addHdrLayerInfoListener(const sp<IBinder>& displayToken,
465 const sp<gui::IHdrLayerInfoListener>& listener) = 0;
466 /*
467 * Removes a listener that was added with addHdrLayerInfoListener.
468 *
469 * Returns NO_ERROR upon success, NAME_NOT_FOUND if the display is invalid, and BAD_VALUE if
470 * the listener wasn't registered.
471 *
472 */
473 virtual status_t removeHdrLayerInfoListener(const sp<IBinder>& displayToken,
474 const sp<gui::IHdrLayerInfoListener>& listener) = 0;
475
476 /*
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100477 * Sends a power boost to the composer. This function is asynchronous.
Ady Abraham8532d012019-05-08 14:50:56 -0700478 *
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100479 * boostId
480 * boost id according to android::hardware::power::Boost
Ady Abraham8532d012019-05-08 14:50:56 -0700481 *
482 * Returns NO_ERROR upon success.
483 */
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100484 virtual status_t notifyPowerBoost(int32_t boostId) = 0;
Vishnu Nairb13bb952019-11-15 10:24:08 -0800485
486 /*
487 * Sets the global configuration for all the shadows drawn by SurfaceFlinger. Shadow follows
488 * material design guidelines.
489 *
490 * ambientColor
491 * Color to the ambient shadow. The alpha is premultiplied.
492 *
493 * spotColor
494 * Color to the spot shadow. The alpha is premultiplied. The position of the spot shadow
495 * depends on the light position.
496 *
497 * lightPosY/lightPosZ
498 * Position of the light used to cast the spot shadow. The X value is always the display
499 * width / 2.
500 *
501 * lightRadius
502 * Radius of the light casting the shadow.
503 */
504 virtual status_t setGlobalShadowSettings(const half4& ambientColor, const half4& spotColor,
505 float lightPosY, float lightPosZ,
506 float lightRadius) = 0;
Steven Thomas62a4cf82020-01-31 12:04:03 -0800507
508 /*
509 * Sets the intended frame rate for a surface. See ANativeWindow_setFrameRate() for more info.
510 */
511 virtual status_t setFrameRate(const sp<IGraphicBufferProducer>& surface, float frameRate,
Marin Shalamanovc5986772021-03-16 16:09:49 +0100512 int8_t compatibility, int8_t changeFrameRateStrategy) = 0;
Steven Thomasd4071902020-03-24 16:02:53 -0700513
514 /*
515 * Acquire a frame rate flexibility token from SurfaceFlinger. While this token is acquired,
516 * surface flinger will freely switch between frame rates in any way it sees fit, regardless of
517 * the current restrictions applied by DisplayManager. This is useful to get consistent behavior
518 * for tests. Release the token by releasing the returned IBinder reference.
519 */
520 virtual status_t acquireFrameRateFlexibilityToken(sp<IBinder>* outToken) = 0;
Ady Abraham74e17562020-08-24 18:18:19 -0700521
522 /*
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000523 * Sets the frame timeline vsync info received from choreographer that corresponds to next
Ady Abraham74e17562020-08-24 18:18:19 -0700524 * buffer submitted on that surface.
525 */
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000526 virtual status_t setFrameTimelineInfo(const sp<IGraphicBufferProducer>& surface,
527 const FrameTimelineInfo& frameTimelineInfo) = 0;
Pablo Gamito6ee484d2020-07-30 14:26:28 +0000528
529 /*
530 * Adds a TransactionTraceListener to listen for transaction tracing state updates.
531 */
532 virtual status_t addTransactionTraceListener(
533 const sp<gui::ITransactionTraceListener>& listener) = 0;
Ana Krulec31f2b3c2020-12-14 14:30:09 -0800534
535 /**
536 * Gets priority of the RenderEngine in SurfaceFlinger.
537 */
538 virtual int getGPUContextPriority() = 0;
Ady Abraham564f9de2021-02-03 18:34:33 -0800539
540 /**
Ady Abraham899dcdb2021-06-15 16:56:21 -0700541 * Gets the number of buffers SurfaceFlinger would need acquire. This number
542 * would be propagated to the client via MIN_UNDEQUEUED_BUFFERS so that the
543 * client could allocate enough buffers to match SF expectations of the
544 * pipeline depth. SurfaceFlinger will make sure that it will give the app at
545 * least the time configured as the 'appDuration' before trying to latch
546 * the buffer.
Ady Abraham564f9de2021-02-03 18:34:33 -0800547 *
548 * The total buffers needed for a given configuration is basically the
549 * numbers of vsyncs a single buffer is used across the stack. For the default
550 * configuration a buffer is held ~1 vsync by the app, ~1 vsync by SurfaceFlinger
551 * and 1 vsync by the display. The extra buffers are calculated as the
Ady Abraham899dcdb2021-06-15 16:56:21 -0700552 * number of additional buffers on top of the 2 buffers already present
553 * in MIN_UNDEQUEUED_BUFFERS.
Ady Abraham564f9de2021-02-03 18:34:33 -0800554 */
Ady Abraham899dcdb2021-06-15 16:56:21 -0700555 virtual status_t getMaxAcquiredBufferCount(int* buffers) const = 0;
chaviw60c9d3e2021-06-04 12:52:17 -0500556
557 virtual status_t addWindowInfosListener(
558 const sp<gui::IWindowInfosListener>& windowInfosListener) const = 0;
559 virtual status_t removeWindowInfosListener(
560 const sp<gui::IWindowInfosListener>& windowInfosListener) const = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800561};
562
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800563// ----------------------------------------------------------------------------
564
Mathias Agopian3165cc22012-08-08 19:42:09 -0700565class BnSurfaceComposer: public BnInterface<ISurfaceComposer> {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800566public:
Ana Krulec13be8ad2018-08-21 02:43:56 +0000567 enum ISurfaceComposerTag {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800568 // Note: BOOT_FINISHED must remain this value, it is called from
569 // Java by ActivityManagerService.
570 BOOT_FINISHED = IBinder::FIRST_CALL_TRANSACTION,
571 CREATE_CONNECTION,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100572 GET_STATIC_DISPLAY_INFO,
Mathias Agopiand0566bc2011-11-17 17:49:17 -0800573 CREATE_DISPLAY_EVENT_CONNECTION,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700574 CREATE_DISPLAY,
Jesse Hall6c913be2013-08-08 12:15:49 -0700575 DESTROY_DISPLAY,
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800576 GET_PHYSICAL_DISPLAY_TOKEN,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700577 SET_TRANSACTION_STATE,
578 AUTHENTICATE_SURFACE,
Brian Anderson069b3652016-07-22 10:32:47 -0700579 GET_SUPPORTED_FRAME_TIMESTAMPS,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100580 GET_DISPLAY_MODES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
581 GET_ACTIVE_DISPLAY_MODE, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800582 GET_DISPLAY_STATE,
chaviwd2432892020-07-24 17:42:39 -0700583 CAPTURE_DISPLAY,
chaviwa76b2712017-09-20 12:02:26 -0700584 CAPTURE_LAYERS,
Svetoslavd85084b2014-03-20 10:28:31 -0700585 CLEAR_ANIMATION_FRAME_STATS,
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700586 GET_ANIMATION_FRAME_STATS,
587 SET_POWER_MODE,
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700588 GET_DISPLAY_STATS,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100589 GET_HDR_CAPABILITIES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
590 GET_DISPLAY_COLOR_MODES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
591 GET_ACTIVE_COLOR_MODE, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Michael Wright28f24d02016-07-12 13:30:53 -0700592 SET_ACTIVE_COLOR_MODE,
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -0700593 ENABLE_VSYNC_INJECTIONS,
Robert Carr1db73f62016-12-21 12:58:51 -0800594 INJECT_VSYNC,
Kalle Raitaa099a242017-01-11 11:17:29 -0800595 GET_LAYER_DEBUG_INFO,
Peiyong Lin0256f722018-08-31 15:45:10 -0700596 GET_COMPOSITION_PREFERENCE,
Ady Abraham37965d42018-11-01 13:43:32 -0700597 GET_COLOR_MANAGEMENT,
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700598 GET_DISPLAYED_CONTENT_SAMPLING_ATTRIBUTES,
Kevin DuBois74e53772018-11-19 10:52:38 -0800599 SET_DISPLAY_CONTENT_SAMPLING_ENABLED,
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700600 GET_DISPLAYED_CONTENT_SAMPLE,
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800601 GET_PROTECTED_CONTENT_SUPPORT,
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800602 IS_WIDE_COLOR_DISPLAY,
Daniel Solomon42d04562019-01-20 21:03:19 -0800603 GET_DISPLAY_NATIVE_PRIMARIES,
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800604 GET_PHYSICAL_DISPLAY_IDS,
Dan Stoza84ab9372018-12-17 15:27:57 -0800605 ADD_REGION_SAMPLING_LISTENER,
606 REMOVE_REGION_SAMPLING_LISTENER,
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100607 SET_DESIRED_DISPLAY_MODE_SPECS,
608 GET_DESIRED_DISPLAY_MODE_SPECS,
Dan Gittik57e63c52019-01-18 16:37:54 +0000609 GET_DISPLAY_BRIGHTNESS_SUPPORT,
610 SET_DISPLAY_BRIGHTNESS,
chaviwd2432892020-07-24 17:42:39 -0700611 CAPTURE_DISPLAY_BY_ID,
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100612 NOTIFY_POWER_BOOST,
Vishnu Nairb13bb952019-11-15 10:24:08 -0800613 SET_GLOBAL_SHADOW_SETTINGS,
Marin Shalamanovb173f752021-02-16 19:38:36 +0100614 GET_AUTO_LOW_LATENCY_MODE_SUPPORT, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100615 SET_AUTO_LOW_LATENCY_MODE,
Marin Shalamanovb173f752021-02-16 19:38:36 +0100616 GET_GAME_CONTENT_TYPE_SUPPORT, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100617 SET_GAME_CONTENT_TYPE,
Steven Thomas62a4cf82020-01-31 12:04:03 -0800618 SET_FRAME_RATE,
Steven Thomasd4071902020-03-24 16:02:53 -0700619 ACQUIRE_FRAME_RATE_FLEXIBILITY_TOKEN,
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000620 SET_FRAME_TIMELINE_INFO,
Pablo Gamito6ee484d2020-07-30 14:26:28 +0000621 ADD_TRANSACTION_TRACE_LISTENER,
Ana Krulec31f2b3c2020-12-14 14:30:09 -0800622 GET_GPU_CONTEXT_PRIORITY,
Ady Abraham899dcdb2021-06-15 16:56:21 -0700623 GET_MAX_ACQUIRED_BUFFER_COUNT,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100624 GET_DYNAMIC_DISPLAY_INFO,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800625 ADD_FPS_LISTENER,
626 REMOVE_FPS_LISTENER,
Kriti Dang49ad4132021-01-08 11:49:56 +0100627 OVERRIDE_HDR_TYPES,
John Reck88270902021-03-18 11:27:35 -0400628 ADD_HDR_LAYER_INFO_LISTENER,
629 REMOVE_HDR_LAYER_INFO_LISTENER,
Tej Singhe2751772021-04-06 22:05:29 -0700630 ON_PULL_ATOM,
Galia Peycheva8f04b302021-04-27 13:25:38 +0200631 ADD_TUNNEL_MODE_ENABLED_LISTENER,
632 REMOVE_TUNNEL_MODE_ENABLED_LISTENER,
chaviw60c9d3e2021-06-04 12:52:17 -0500633 ADD_WINDOW_INFOS_LISTENER,
634 REMOVE_WINDOW_INFOS_LISTENER,
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800635 // Always append new enum to the end.
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800636 };
637
Mathias Agopian3165cc22012-08-08 19:42:09 -0700638 virtual status_t onTransact(uint32_t code, const Parcel& data,
639 Parcel* reply, uint32_t flags = 0);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800640};
641
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800642} // namespace android