blob: 71b80d3929da4840f24c5d1559729857e838e17d [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>
Alec Mouriadebf5c2021-01-05 12:57:36 -080025#include <binder/IBinder.h>
26#include <binder/IInterface.h>
chaviw3277faf2021-05-19 16:45:23 -050027#include <ftl/Flags.h>
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -100028#include <gui/FrameTimelineInfo.h>
Marissa Wall3dad52d2019-03-22 14:03:19 -070029#include <gui/ITransactionCompletedListener.h>
Vishnu Nairb13bb952019-11-15 10:24:08 -080030#include <math/vec4.h>
Alec Mouriadebf5c2021-01-05 12:57:36 -080031#include <stdint.h>
32#include <sys/types.h>
Daniel Solomon42d04562019-01-20 21:03:19 -080033#include <ui/ConfigStoreTypes.h>
Marin Shalamanova524a092020-07-27 21:39:55 +020034#include <ui/DisplayId.h>
Marin Shalamanov228f46b2021-01-28 21:11:45 +010035#include <ui/DisplayMode.h>
Kevin DuBois1d4249a2018-08-29 10:45:14 -070036#include <ui/DisplayedFrameStats.h>
Svetoslavd85084b2014-03-20 10:28:31 -070037#include <ui/FrameStats.h>
Chavi Weingarten40482ff2017-11-30 01:51:40 +000038#include <ui/GraphicBuffer.h>
Peiyong Lin9f034472018-03-28 15:29:00 -070039#include <ui/GraphicTypes.h>
Kevin DuBois1d4249a2018-08-29 10:45:14 -070040#include <ui/PixelFormat.h>
Dominik Laskowski718f9602019-11-09 20:01:35 -080041#include <ui/Rotation.h>
Marissa Wall3dad52d2019-03-22 14:03:19 -070042#include <utils/Errors.h>
43#include <utils/RefBase.h>
44#include <utils/Timers.h>
45#include <utils/Vector.h>
46
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -080047#include <optional>
Robert Carr866455f2019-04-02 16:28:26 -070048#include <unordered_set>
Brian Anderson069b3652016-07-22 10:32:47 -070049#include <vector>
50
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080051namespace android {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080052
Marissa Wall947d34e2019-03-29 14:03:53 -070053struct client_cache_t;
Colin Crossa2362b42016-09-26 13:48:25 -070054struct ComposerState;
chaviwd2432892020-07-24 17:42:39 -070055struct DisplayCaptureArgs;
Lajos Molnare7bda062014-09-18 20:05:27 -070056struct DisplayStatInfo;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080057struct DisplayState;
chaviw273171b2018-12-26 11:46:30 -080058struct InputWindowCommands;
chaviwd2432892020-07-24 17:42:39 -070059struct LayerCaptureArgs;
Kalle Raitaa099a242017-01-11 11:17:29 -080060class LayerDebugInfo;
Dan Stozac4f471e2016-03-24 09:31:08 -070061class HdrCapabilities;
Mathias Agopiand0566bc2011-11-17 17:49:17 -080062class IDisplayEventConnection;
Mathias Agopian2b5dd402017-02-07 17:36:19 -080063class IGraphicBufferProducer;
64class ISurfaceComposerClient;
Dan Stoza84ab9372018-12-17 15:27:57 -080065class IRegionSamplingListener;
Dan Stozac1879002014-05-22 15:59:05 -070066class Rect;
Brian Anderson3890c392016-07-25 12:48:08 -070067enum class FrameEvent;
Mathias Agopiana67932f2011-04-20 14:20:59 -070068
chaviw0ef7caa2021-01-05 11:04:50 -080069using gui::IScreenCaptureListener;
70
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080071namespace ui {
72
Marin Shalamanova7fe3042021-01-29 21:02:08 +010073struct DisplayMode;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080074struct DisplayState;
Marin Shalamanov228f46b2021-01-28 21:11:45 +010075struct DynamicDisplayInfo;
76struct StaticDisplayInfo;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -080077
78} // namespace ui
79
Andy McFadden882e3a32013-01-08 16:06:15 -080080/*
81 * This class defines the Binder IPC interface for accessing various
82 * SurfaceFlinger features.
83 */
Mathias Agopian3165cc22012-08-08 19:42:09 -070084class ISurfaceComposer: public IInterface {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080085public:
Colin Cross17576de2016-09-26 13:07:06 -070086 DECLARE_META_INTERFACE(SurfaceComposer)
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080087
Ady Abraham0a525092020-03-03 12:51:24 -080088 static constexpr size_t MAX_LAYERS = 4096;
89
Mathias Agopian3165cc22012-08-08 19:42:09 -070090 // flags for setTransactionState()
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -080091 enum {
Mathias Agopian3165cc22012-08-08 19:42:09 -070092 eSynchronous = 0x01,
Ady Abrahambf1349c2020-06-12 14:26:18 -070093 eAnimation = 0x02,
Dan Stoza84d619e2018-03-28 17:07:36 -070094
Ady Abrahambf1349c2020-06-12 14:26:18 -070095 // Explicit indication that this transaction and others to follow will likely result in a
96 // lot of layers being composed, and thus, SurfaceFlinger should wake-up earlier to avoid
97 // missing frame deadlines. In this case SurfaceFlinger will wake up at
98 // (sf vsync offset - debug.sf.early_phase_offset_ns). SurfaceFlinger will continue to be
Ady Abraham8cbd3072021-03-15 16:39:06 -070099 // in the early configuration until it receives eEarlyWakeupEnd. These flags are
Ady Abrahambf1349c2020-06-12 14:26:18 -0700100 // expected to be used by WindowManager only and are guarded by
101 // android.permission.ACCESS_SURFACE_FLINGER
Ady Abraham8cbd3072021-03-15 16:39:06 -0700102 eEarlyWakeupStart = 0x08,
103 eEarlyWakeupEnd = 0x10,
Jamie Gennis28378392011-10-12 17:39:00 -0700104 };
105
Jorim Jaggib1e2f8d2017-06-08 15:43:59 -0700106 enum VsyncSource {
107 eVsyncSourceApp = 0,
108 eVsyncSourceSurfaceFlinger = 1
109 };
110
Ady Abraham62f216c2020-10-13 19:07:23 -0700111 enum class EventRegistration {
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100112 modeChanged = 1 << 0,
Ady Abraham62f216c2020-10-13 19:07:23 -0700113 frameRateOverride = 1 << 1,
114 };
115
116 using EventRegistrationFlags = Flags<EventRegistration>;
Ady Abraham0f4a1b12019-06-04 16:04:04 -0700117
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800118 /*
Robert Carrb89ea9d2018-12-10 13:01:14 -0800119 * Create a connection with SurfaceFlinger.
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800120 */
Mathias Agopian7e27f052010-05-28 14:22:23 -0700121 virtual sp<ISurfaceComposerClient> createConnection() = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800122
Mathias Agopiane57f2922012-08-09 16:29:12 -0700123 /* return an IDisplayEventConnection */
Jorim Jaggib1e2f8d2017-06-08 15:43:59 -0700124 virtual sp<IDisplayEventConnection> createDisplayEventConnection(
Ady Abraham0f4a1b12019-06-04 16:04:04 -0700125 VsyncSource vsyncSource = eVsyncSourceApp,
Ady Abraham62f216c2020-10-13 19:07:23 -0700126 EventRegistrationFlags eventRegistration = {}) = 0;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700127
Jesse Hall6c913be2013-08-08 12:15:49 -0700128 /* create a virtual display
Mathias Agopiane57f2922012-08-09 16:29:12 -0700129 * requires ACCESS_SURFACE_FLINGER permission.
130 */
Jamie Gennisdd3cb842012-10-19 18:19:11 -0700131 virtual sp<IBinder> createDisplay(const String8& displayName,
132 bool secure) = 0;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700133
Jesse Hall6c913be2013-08-08 12:15:49 -0700134 /* destroy a virtual display
135 * requires ACCESS_SURFACE_FLINGER permission.
136 */
137 virtual void destroyDisplay(const sp<IBinder>& display) = 0;
138
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800139 /* get stable IDs for connected physical displays.
Mathias Agopiane57f2922012-08-09 16:29:12 -0700140 */
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800141 virtual std::vector<PhysicalDisplayId> getPhysicalDisplayIds() const = 0;
142
143 // TODO(b/74619554): Remove this stopgap once the framework is display-agnostic.
144 std::optional<PhysicalDisplayId> getInternalDisplayId() const {
145 const auto displayIds = getPhysicalDisplayIds();
146 return displayIds.empty() ? std::nullopt : std::make_optional(displayIds.front());
147 }
148
149 /* get token for a physical display given its stable ID obtained via getPhysicalDisplayIds or a
150 * DisplayEventReceiver hotplug event.
151 */
152 virtual sp<IBinder> getPhysicalDisplayToken(PhysicalDisplayId displayId) const = 0;
153
154 // TODO(b/74619554): Remove this stopgap once the framework is display-agnostic.
155 sp<IBinder> getInternalDisplayToken() const {
156 const auto displayId = getInternalDisplayId();
157 return displayId ? getPhysicalDisplayToken(*displayId) : nullptr;
158 }
Mathias Agopiane57f2922012-08-09 16:29:12 -0700159
Mathias Agopian9cce3252010-02-09 17:46:37 -0800160 /* open/close transactions. requires ACCESS_SURFACE_FLINGER permission */
chaviw308ddba2020-08-11 16:23:51 -0700161 virtual status_t setTransactionState(
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000162 const FrameTimelineInfo& frameTimelineInfo, const Vector<ComposerState>& state,
Ady Abraham22c7b5c2020-09-22 19:33:40 -0700163 const Vector<DisplayState>& displays, uint32_t flags, const sp<IBinder>& applyToken,
chaviw308ddba2020-08-11 16:23:51 -0700164 const InputWindowCommands& inputWindowCommands, int64_t desiredPresentTime,
Ady Abrahamf0c56492020-12-17 18:04:15 -0800165 bool isAutoTimestamp, const client_cache_t& uncacheBuffer, bool hasListenerCallbacks,
Pablo Gamito7eb7ee72020-08-05 10:57:05 +0000166 const std::vector<ListenerCallbacks>& listenerCallbacks, uint64_t transactionId) = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800167
168 /* signal that we're done booting.
Mathias Agopian9cce3252010-02-09 17:46:37 -0800169 * Requires ACCESS_SURFACE_FLINGER permission
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800170 */
171 virtual void bootFinished() = 0;
172
Andy McFadden2adaf042012-12-18 09:49:45 -0800173 /* verify that an IGraphicBufferProducer was created by SurfaceFlinger.
Mathias Agopiane57f2922012-08-09 16:29:12 -0700174 */
175 virtual bool authenticateSurfaceTexture(
Andy McFadden2adaf042012-12-18 09:49:45 -0800176 const sp<IGraphicBufferProducer>& surface) const = 0;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700177
Brian Anderson6b376712017-04-04 10:51:39 -0700178 /* Returns the frame timestamps supported by SurfaceFlinger.
179 */
180 virtual status_t getSupportedFrameTimestamps(
181 std::vector<FrameEvent>* outSupported) const = 0;
182
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700183 /* set display power mode. depending on the mode, it can either trigger
184 * screen on, off or low power mode and wait for it to complete.
Mathias Agopian041a0752013-03-15 18:31:56 -0700185 * requires ACCESS_SURFACE_FLINGER permission.
186 */
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700187 virtual void setPowerMode(const sp<IBinder>& display, int mode) = 0;
Mathias Agopian3094df32012-06-18 18:06:45 -0700188
Dan Stoza7f7da322014-05-02 15:26:25 -0700189
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700190 /* returns display statistics for a given display
191 * intended to be used by the media framework to properly schedule
192 * video frames */
193 virtual status_t getDisplayStats(const sp<IBinder>& display,
194 DisplayStatInfo* stats) = 0;
195
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800196 /**
197 * Get transactional state of given display.
198 */
199 virtual status_t getDisplayState(const sp<IBinder>& display, ui::DisplayState*) = 0;
200
201 /**
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100202 * Gets immutable information about given physical display.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800203 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100204 virtual status_t getStaticDisplayInfo(const sp<IBinder>& display, ui::StaticDisplayInfo*) = 0;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800205
206 /**
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100207 * Gets dynamic information about given physical display.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800208 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100209 virtual status_t getDynamicDisplayInfo(const sp<IBinder>& display, ui::DynamicDisplayInfo*) = 0;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800210
Daniel Solomon42d04562019-01-20 21:03:19 -0800211 virtual status_t getDisplayNativePrimaries(const sp<IBinder>& display,
212 ui::DisplayPrimaries& primaries) = 0;
Michael Wright28f24d02016-07-12 13:30:53 -0700213 virtual status_t setActiveColorMode(const sp<IBinder>& display,
Peiyong Lin9f034472018-03-28 15:29:00 -0700214 ui::ColorMode colorMode) = 0;
Michael Wright28f24d02016-07-12 13:30:53 -0700215
Chia-I Wuff79ef82018-08-22 15:27:32 -0700216 /**
Galia Peycheva5492cb52019-10-30 14:13:16 +0100217 * Switches Auto Low Latency Mode on/off on the connected display, if it is
Marin Shalamanovb173f752021-02-16 19:38:36 +0100218 * available. This should only be called if the display supports Auto Low
219 * Latency Mode as reported in #getDynamicDisplayInfo.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100220 * For more information, see the HDMI 2.1 specification.
221 */
222 virtual void setAutoLowLatencyMode(const sp<IBinder>& display, bool on) = 0;
223
224 /**
Galia Peycheva5492cb52019-10-30 14:13:16 +0100225 * This will start sending infoframes to the connected display with
Marin Shalamanovb173f752021-02-16 19:38:36 +0100226 * ContentType=Game (if on=true). This should only be called if the display
227 * Game Content Type as reported in #getDynamicDisplayInfo.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100228 * For more information, see the HDMI 1.4 specification.
229 */
230 virtual void setGameContentType(const sp<IBinder>& display, bool on) = 0;
231
232 /**
Chia-I Wuff79ef82018-08-22 15:27:32 -0700233 * Capture the specified screen. This requires READ_FRAME_BUFFER
234 * permission. This function will fail if there is a secure window on
chaviwd2432892020-07-24 17:42:39 -0700235 * screen and DisplayCaptureArgs.captureSecureLayers is false.
Chia-I Wuff79ef82018-08-22 15:27:32 -0700236 *
237 * This function can capture a subregion (the source crop) of the screen.
238 * The subregion can be optionally rotated. It will also be scaled to
239 * match the size of the output buffer.
Peiyong Lin0e003c92018-09-17 11:09:51 -0700240 */
chaviwd2432892020-07-24 17:42:39 -0700241 virtual status_t captureDisplay(const DisplayCaptureArgs& args,
chaviw8ffc7b82020-08-18 11:25:37 -0700242 const sp<IScreenCaptureListener>& captureListener) = 0;
Svetoslavd85084b2014-03-20 10:28:31 -0700243
chaviwd2432892020-07-24 17:42:39 -0700244 virtual status_t captureDisplay(uint64_t displayOrLayerStack,
chaviw8ffc7b82020-08-18 11:25:37 -0700245 const sp<IScreenCaptureListener>& captureListener) = 0;
chaviw93df2ea2019-04-30 16:45:12 -0700246
Robert Carr866455f2019-04-02 16:28:26 -0700247 template <class AA>
248 struct SpHash {
249 size_t operator()(const sp<AA>& k) const { return std::hash<AA*>()(k.get()); }
250 };
251
Robert Carr578038f2018-03-09 12:25:24 -0800252 /**
253 * Capture a subtree of the layer hierarchy, potentially ignoring the root node.
chaviw3efadb12020-07-27 10:07:15 -0700254 * This requires READ_FRAME_BUFFER permission. This function will fail if there
255 * is a secure window on screen
Robert Carr578038f2018-03-09 12:25:24 -0800256 */
chaviw3efadb12020-07-27 10:07:15 -0700257 virtual status_t captureLayers(const LayerCaptureArgs& args,
chaviw8ffc7b82020-08-18 11:25:37 -0700258 const sp<IScreenCaptureListener>& captureListener) = 0;
Peiyong Lin0e003c92018-09-17 11:09:51 -0700259
Svetoslavd85084b2014-03-20 10:28:31 -0700260 /* Clears the frame statistics for animations.
261 *
262 * Requires the ACCESS_SURFACE_FLINGER permission.
263 */
264 virtual status_t clearAnimationFrameStats() = 0;
265
266 /* Gets the frame statistics for animations.
267 *
268 * Requires the ACCESS_SURFACE_FLINGER permission.
269 */
270 virtual status_t getAnimationFrameStats(FrameStats* outStats) const = 0;
Dan Stozac4f471e2016-03-24 09:31:08 -0700271
Kriti Dang49ad4132021-01-08 11:49:56 +0100272 /* Overrides the supported HDR modes for the given display device.
273 *
274 * Requires the ACCESS_SURFACE_FLINGER permission.
275 */
276 virtual status_t overrideHdrTypes(const sp<IBinder>& display,
277 const std::vector<ui::Hdr>& hdrTypes) = 0;
278
Tej Singhe2751772021-04-06 22:05:29 -0700279 /* Pulls surfaceflinger atoms global stats and layer stats to pipe to statsd.
280 *
281 * Requires the calling uid be from system server.
282 */
283 virtual status_t onPullAtom(const int32_t atomId, std::string* outData, bool* success) = 0;
284
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -0700285 virtual status_t enableVSyncInjections(bool enable) = 0;
286
287 virtual status_t injectVSync(nsecs_t when) = 0;
Kalle Raitaa099a242017-01-11 11:17:29 -0800288
289 /* Gets the list of active layers in Z order for debugging purposes
290 *
291 * Requires the ACCESS_SURFACE_FLINGER permission.
292 */
Vishnu Nair43bccf82020-06-05 10:53:37 -0700293 virtual status_t getLayerDebugInfo(std::vector<LayerDebugInfo>* outLayers) = 0;
Peiyong Lin0256f722018-08-31 15:45:10 -0700294
Ady Abraham37965d42018-11-01 13:43:32 -0700295 virtual status_t getColorManagement(bool* outGetColorManagement) const = 0;
Peiyong Linc6780972018-10-28 15:24:08 -0700296
297 /* Gets the composition preference of the default data space and default pixel format,
298 * as well as the wide color gamut data space and wide color gamut pixel format.
299 * If the wide color gamut data space is V0_SRGB, then it implies that the platform
300 * has no wide color gamut support.
301 *
302 * Requires the ACCESS_SURFACE_FLINGER permission.
303 */
304 virtual status_t getCompositionPreference(ui::Dataspace* defaultDataspace,
305 ui::PixelFormat* defaultPixelFormat,
306 ui::Dataspace* wideColorGamutDataspace,
307 ui::PixelFormat* wideColorGamutPixelFormat) const = 0;
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700308 /*
309 * Requires the ACCESS_SURFACE_FLINGER permission.
310 */
311 virtual status_t getDisplayedContentSamplingAttributes(const sp<IBinder>& display,
312 ui::PixelFormat* outFormat,
313 ui::Dataspace* outDataspace,
314 uint8_t* outComponentMask) const = 0;
Kevin DuBois74e53772018-11-19 10:52:38 -0800315
316 /* Turns on the color sampling engine on the display.
317 *
318 * Requires the ACCESS_SURFACE_FLINGER permission.
319 */
320 virtual status_t setDisplayContentSamplingEnabled(const sp<IBinder>& display, bool enable,
321 uint8_t componentMask,
Dominik Laskowski470df5f2020-04-02 22:27:42 -0700322 uint64_t maxFrames) = 0;
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700323
324 /* Returns statistics on the color profile of the last frame displayed for a given display
325 *
326 * Requires the ACCESS_SURFACE_FLINGER permission.
327 */
328 virtual status_t getDisplayedContentSample(const sp<IBinder>& display, uint64_t maxFrames,
329 uint64_t timestamp,
330 DisplayedFrameStats* outStats) const = 0;
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800331
332 /*
333 * Gets whether SurfaceFlinger can support protected content in GPU composition.
334 * Requires the ACCESS_SURFACE_FLINGER permission.
335 */
336 virtual status_t getProtectedContentSupport(bool* outSupported) const = 0;
Marissa Wallebc2c052019-01-16 19:16:55 -0800337
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800338 /*
339 * Queries whether the given display is a wide color display.
340 * Requires the ACCESS_SURFACE_FLINGER permission.
341 */
342 virtual status_t isWideColorDisplay(const sp<IBinder>& token,
343 bool* outIsWideColorDisplay) const = 0;
Dan Stoza84ab9372018-12-17 15:27:57 -0800344
345 /* Registers a listener to stream median luma updates from SurfaceFlinger.
346 *
347 * The sampling area is bounded by both samplingArea and the given stopLayerHandle
348 * (i.e., only layers behind the stop layer will be captured and sampled).
349 *
350 * Multiple listeners may be provided so long as they have independent listeners.
351 * If multiple listeners are provided, the effective sampling region for each listener will
352 * be bounded by whichever stop layer has a lower Z value.
353 *
354 * Requires the same permissions as captureLayers and captureScreen.
355 */
356 virtual status_t addRegionSamplingListener(const Rect& samplingArea,
357 const sp<IBinder>& stopLayerHandle,
358 const sp<IRegionSamplingListener>& listener) = 0;
359
360 /*
361 * Removes a listener that was streaming median luma updates from SurfaceFlinger.
362 */
363 virtual status_t removeRegionSamplingListener(const sp<IRegionSamplingListener>& listener) = 0;
Ady Abraham838de062019-02-04 10:24:03 -0800364
Alec Mouriadebf5c2021-01-05 12:57:36 -0800365 /* Registers a listener that streams fps updates from SurfaceFlinger.
366 *
Alec Mouria9a68a62021-03-04 19:14:50 -0800367 * The listener will stream fps updates for the layer tree rooted at the layer denoted by the
368 * task ID, i.e., the layer must have the task ID as part of its layer metadata with key
369 * METADATA_TASK_ID. If there is no such layer, then no fps is expected to be reported.
Alec Mouriadebf5c2021-01-05 12:57:36 -0800370 *
371 * Multiple listeners may be supported.
372 *
Alec Mouria9a68a62021-03-04 19:14:50 -0800373 * Requires the READ_FRAME_BUFFER permission.
Alec Mouriadebf5c2021-01-05 12:57:36 -0800374 */
Alec Mouria9a68a62021-03-04 19:14:50 -0800375 virtual status_t addFpsListener(int32_t taskId, const sp<gui::IFpsListener>& listener) = 0;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800376 /*
377 * Removes a listener that was streaming fps updates from SurfaceFlinger.
378 */
379 virtual status_t removeFpsListener(const sp<gui::IFpsListener>& listener) = 0;
380
Galia Peycheva8f04b302021-04-27 13:25:38 +0200381 /* Registers a listener to receive tunnel mode enabled updates from SurfaceFlinger.
382 *
383 * Requires ACCESS_SURFACE_FLINGER permission.
384 */
385 virtual status_t addTunnelModeEnabledListener(
386 const sp<gui::ITunnelModeEnabledListener>& listener) = 0;
387
388 /*
389 * Removes a listener that was receiving tunnel mode enabled updates from SurfaceFlinger.
390 *
391 * Requires ACCESS_SURFACE_FLINGER permission.
392 */
393 virtual status_t removeTunnelModeEnabledListener(
394 const sp<gui::ITunnelModeEnabledListener>& listener) = 0;
395
Steven Thomasf734df42020-04-13 21:09:28 -0700396 /* Sets the refresh rate boundaries for the display.
397 *
398 * The primary refresh rate range represents display manager's general guidance on the display
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100399 * modes we'll consider when switching refresh rates. Unless we get an explicit signal from an
Steven Thomasf734df42020-04-13 21:09:28 -0700400 * app, we should stay within this range.
401 *
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100402 * The app request refresh rate range allows us to consider more display modes when switching
Steven Thomasf734df42020-04-13 21:09:28 -0700403 * refresh rates. Although we should generally stay within the primary range, specific
404 * considerations, such as layer frame rate settings specified via the setFrameRate() api, may
405 * cause us to go outside the primary range. We never go outside the app request range. The app
406 * request range will be greater than or equal to the primary refresh rate range, never smaller.
407 *
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100408 * defaultMode is used to narrow the list of display modes SurfaceFlinger will consider
409 * switching between. Only modes with a mode group and resolution matching defaultMode
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100410 * will be considered for switching. The defaultMode corresponds to an ID of mode in the list
411 * of supported modes returned from getDynamicDisplayInfo().
Ana Krulec0782b882019-10-15 17:34:54 -0700412 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100413 virtual status_t setDesiredDisplayModeSpecs(
414 const sp<IBinder>& displayToken, ui::DisplayModeId defaultMode,
415 bool allowGroupSwitching, float primaryRefreshRateMin, float primaryRefreshRateMax,
416 float appRequestRefreshRateMin, float appRequestRefreshRateMax) = 0;
Ana Krulec0782b882019-10-15 17:34:54 -0700417
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100418 virtual status_t getDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
419 ui::DisplayModeId* outDefaultMode,
420 bool* outAllowGroupSwitching,
421 float* outPrimaryRefreshRateMin,
422 float* outPrimaryRefreshRateMax,
423 float* outAppRequestRefreshRateMin,
424 float* outAppRequestRefreshRateMax) = 0;
Ana Krulec0782b882019-10-15 17:34:54 -0700425 /*
Dan Gittik57e63c52019-01-18 16:37:54 +0000426 * Gets whether brightness operations are supported on a display.
427 *
428 * displayToken
429 * The token of the display.
430 * outSupport
431 * An output parameter for whether brightness operations are supported.
432 *
433 * Returns NO_ERROR upon success. Otherwise,
434 * NAME_NOT_FOUND if the display is invalid, or
435 * BAD_VALUE if the output parameter is invalid.
436 */
437 virtual status_t getDisplayBrightnessSupport(const sp<IBinder>& displayToken,
438 bool* outSupport) const = 0;
439
440 /*
441 * Sets the brightness of a display.
442 *
443 * displayToken
444 * The token of the display whose brightness is set.
445 * brightness
John Reck22be6962021-03-10 12:59:54 -0500446 * The DisplayBrightness info to set on the desired display.
Dan Gittik57e63c52019-01-18 16:37:54 +0000447 *
448 * Returns NO_ERROR upon success. Otherwise,
449 * NAME_NOT_FOUND if the display is invalid, or
450 * BAD_VALUE if the brightness is invalid, or
451 * INVALID_OPERATION if brightness operations are not supported.
452 */
John Reck22be6962021-03-10 12:59:54 -0500453 virtual status_t setDisplayBrightness(const sp<IBinder>& displayToken,
454 const gui::DisplayBrightness& brightness) = 0;
Ady Abraham8532d012019-05-08 14:50:56 -0700455
456 /*
John Reck88270902021-03-18 11:27:35 -0400457 * Adds a listener that receives HDR layer information. This is used in combination
458 * with setDisplayBrightness to adjust the display brightness depending on factors such
459 * as whether or not HDR is in use.
460 *
461 * Returns NO_ERROR upon success or NAME_NOT_FOUND if the display is invalid.
462 */
463 virtual status_t addHdrLayerInfoListener(const sp<IBinder>& displayToken,
464 const sp<gui::IHdrLayerInfoListener>& listener) = 0;
465 /*
466 * Removes a listener that was added with addHdrLayerInfoListener.
467 *
468 * Returns NO_ERROR upon success, NAME_NOT_FOUND if the display is invalid, and BAD_VALUE if
469 * the listener wasn't registered.
470 *
471 */
472 virtual status_t removeHdrLayerInfoListener(const sp<IBinder>& displayToken,
473 const sp<gui::IHdrLayerInfoListener>& listener) = 0;
474
475 /*
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100476 * Sends a power boost to the composer. This function is asynchronous.
Ady Abraham8532d012019-05-08 14:50:56 -0700477 *
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100478 * boostId
479 * boost id according to android::hardware::power::Boost
Ady Abraham8532d012019-05-08 14:50:56 -0700480 *
481 * Returns NO_ERROR upon success.
482 */
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100483 virtual status_t notifyPowerBoost(int32_t boostId) = 0;
Vishnu Nairb13bb952019-11-15 10:24:08 -0800484
485 /*
486 * Sets the global configuration for all the shadows drawn by SurfaceFlinger. Shadow follows
487 * material design guidelines.
488 *
489 * ambientColor
490 * Color to the ambient shadow. The alpha is premultiplied.
491 *
492 * spotColor
493 * Color to the spot shadow. The alpha is premultiplied. The position of the spot shadow
494 * depends on the light position.
495 *
496 * lightPosY/lightPosZ
497 * Position of the light used to cast the spot shadow. The X value is always the display
498 * width / 2.
499 *
500 * lightRadius
501 * Radius of the light casting the shadow.
502 */
503 virtual status_t setGlobalShadowSettings(const half4& ambientColor, const half4& spotColor,
504 float lightPosY, float lightPosZ,
505 float lightRadius) = 0;
Steven Thomas62a4cf82020-01-31 12:04:03 -0800506
507 /*
508 * Sets the intended frame rate for a surface. See ANativeWindow_setFrameRate() for more info.
509 */
510 virtual status_t setFrameRate(const sp<IGraphicBufferProducer>& surface, float frameRate,
Marin Shalamanovc5986772021-03-16 16:09:49 +0100511 int8_t compatibility, int8_t changeFrameRateStrategy) = 0;
Steven Thomasd4071902020-03-24 16:02:53 -0700512
513 /*
514 * Acquire a frame rate flexibility token from SurfaceFlinger. While this token is acquired,
515 * surface flinger will freely switch between frame rates in any way it sees fit, regardless of
516 * the current restrictions applied by DisplayManager. This is useful to get consistent behavior
517 * for tests. Release the token by releasing the returned IBinder reference.
518 */
519 virtual status_t acquireFrameRateFlexibilityToken(sp<IBinder>* outToken) = 0;
Ady Abraham74e17562020-08-24 18:18:19 -0700520
521 /*
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000522 * Sets the frame timeline vsync info received from choreographer that corresponds to next
Ady Abraham74e17562020-08-24 18:18:19 -0700523 * buffer submitted on that surface.
524 */
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000525 virtual status_t setFrameTimelineInfo(const sp<IGraphicBufferProducer>& surface,
526 const FrameTimelineInfo& frameTimelineInfo) = 0;
Pablo Gamito6ee484d2020-07-30 14:26:28 +0000527
528 /*
529 * Adds a TransactionTraceListener to listen for transaction tracing state updates.
530 */
531 virtual status_t addTransactionTraceListener(
532 const sp<gui::ITransactionTraceListener>& listener) = 0;
Ana Krulec31f2b3c2020-12-14 14:30:09 -0800533
534 /**
535 * Gets priority of the RenderEngine in SurfaceFlinger.
536 */
537 virtual int getGPUContextPriority() = 0;
Ady Abraham564f9de2021-02-03 18:34:33 -0800538
539 /**
Ady Abraham899dcdb2021-06-15 16:56:21 -0700540 * Gets the number of buffers SurfaceFlinger would need acquire. This number
541 * would be propagated to the client via MIN_UNDEQUEUED_BUFFERS so that the
542 * client could allocate enough buffers to match SF expectations of the
543 * pipeline depth. SurfaceFlinger will make sure that it will give the app at
544 * least the time configured as the 'appDuration' before trying to latch
545 * the buffer.
Ady Abraham564f9de2021-02-03 18:34:33 -0800546 *
547 * The total buffers needed for a given configuration is basically the
548 * numbers of vsyncs a single buffer is used across the stack. For the default
549 * configuration a buffer is held ~1 vsync by the app, ~1 vsync by SurfaceFlinger
550 * and 1 vsync by the display. The extra buffers are calculated as the
Ady Abraham899dcdb2021-06-15 16:56:21 -0700551 * number of additional buffers on top of the 2 buffers already present
552 * in MIN_UNDEQUEUED_BUFFERS.
Ady Abraham564f9de2021-02-03 18:34:33 -0800553 */
Ady Abraham899dcdb2021-06-15 16:56:21 -0700554 virtual status_t getMaxAcquiredBufferCount(int* buffers) const = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800555};
556
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800557// ----------------------------------------------------------------------------
558
Mathias Agopian3165cc22012-08-08 19:42:09 -0700559class BnSurfaceComposer: public BnInterface<ISurfaceComposer> {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800560public:
Ana Krulec13be8ad2018-08-21 02:43:56 +0000561 enum ISurfaceComposerTag {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800562 // Note: BOOT_FINISHED must remain this value, it is called from
563 // Java by ActivityManagerService.
564 BOOT_FINISHED = IBinder::FIRST_CALL_TRANSACTION,
565 CREATE_CONNECTION,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100566 GET_STATIC_DISPLAY_INFO,
Mathias Agopiand0566bc2011-11-17 17:49:17 -0800567 CREATE_DISPLAY_EVENT_CONNECTION,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700568 CREATE_DISPLAY,
Jesse Hall6c913be2013-08-08 12:15:49 -0700569 DESTROY_DISPLAY,
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800570 GET_PHYSICAL_DISPLAY_TOKEN,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700571 SET_TRANSACTION_STATE,
572 AUTHENTICATE_SURFACE,
Brian Anderson069b3652016-07-22 10:32:47 -0700573 GET_SUPPORTED_FRAME_TIMESTAMPS,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100574 GET_DISPLAY_MODES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
575 GET_ACTIVE_DISPLAY_MODE, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800576 GET_DISPLAY_STATE,
chaviwd2432892020-07-24 17:42:39 -0700577 CAPTURE_DISPLAY,
chaviwa76b2712017-09-20 12:02:26 -0700578 CAPTURE_LAYERS,
Svetoslavd85084b2014-03-20 10:28:31 -0700579 CLEAR_ANIMATION_FRAME_STATS,
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700580 GET_ANIMATION_FRAME_STATS,
581 SET_POWER_MODE,
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700582 GET_DISPLAY_STATS,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100583 GET_HDR_CAPABILITIES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
584 GET_DISPLAY_COLOR_MODES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
585 GET_ACTIVE_COLOR_MODE, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Michael Wright28f24d02016-07-12 13:30:53 -0700586 SET_ACTIVE_COLOR_MODE,
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -0700587 ENABLE_VSYNC_INJECTIONS,
Robert Carr1db73f62016-12-21 12:58:51 -0800588 INJECT_VSYNC,
Kalle Raitaa099a242017-01-11 11:17:29 -0800589 GET_LAYER_DEBUG_INFO,
Peiyong Lin0256f722018-08-31 15:45:10 -0700590 GET_COMPOSITION_PREFERENCE,
Ady Abraham37965d42018-11-01 13:43:32 -0700591 GET_COLOR_MANAGEMENT,
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700592 GET_DISPLAYED_CONTENT_SAMPLING_ATTRIBUTES,
Kevin DuBois74e53772018-11-19 10:52:38 -0800593 SET_DISPLAY_CONTENT_SAMPLING_ENABLED,
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700594 GET_DISPLAYED_CONTENT_SAMPLE,
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800595 GET_PROTECTED_CONTENT_SUPPORT,
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800596 IS_WIDE_COLOR_DISPLAY,
Daniel Solomon42d04562019-01-20 21:03:19 -0800597 GET_DISPLAY_NATIVE_PRIMARIES,
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800598 GET_PHYSICAL_DISPLAY_IDS,
Dan Stoza84ab9372018-12-17 15:27:57 -0800599 ADD_REGION_SAMPLING_LISTENER,
600 REMOVE_REGION_SAMPLING_LISTENER,
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100601 SET_DESIRED_DISPLAY_MODE_SPECS,
602 GET_DESIRED_DISPLAY_MODE_SPECS,
Dan Gittik57e63c52019-01-18 16:37:54 +0000603 GET_DISPLAY_BRIGHTNESS_SUPPORT,
604 SET_DISPLAY_BRIGHTNESS,
chaviwd2432892020-07-24 17:42:39 -0700605 CAPTURE_DISPLAY_BY_ID,
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100606 NOTIFY_POWER_BOOST,
Vishnu Nairb13bb952019-11-15 10:24:08 -0800607 SET_GLOBAL_SHADOW_SETTINGS,
Marin Shalamanovb173f752021-02-16 19:38:36 +0100608 GET_AUTO_LOW_LATENCY_MODE_SUPPORT, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100609 SET_AUTO_LOW_LATENCY_MODE,
Marin Shalamanovb173f752021-02-16 19:38:36 +0100610 GET_GAME_CONTENT_TYPE_SUPPORT, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100611 SET_GAME_CONTENT_TYPE,
Steven Thomas62a4cf82020-01-31 12:04:03 -0800612 SET_FRAME_RATE,
Steven Thomasd4071902020-03-24 16:02:53 -0700613 ACQUIRE_FRAME_RATE_FLEXIBILITY_TOKEN,
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000614 SET_FRAME_TIMELINE_INFO,
Pablo Gamito6ee484d2020-07-30 14:26:28 +0000615 ADD_TRANSACTION_TRACE_LISTENER,
Ana Krulec31f2b3c2020-12-14 14:30:09 -0800616 GET_GPU_CONTEXT_PRIORITY,
Ady Abraham899dcdb2021-06-15 16:56:21 -0700617 GET_MAX_ACQUIRED_BUFFER_COUNT,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100618 GET_DYNAMIC_DISPLAY_INFO,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800619 ADD_FPS_LISTENER,
620 REMOVE_FPS_LISTENER,
Kriti Dang49ad4132021-01-08 11:49:56 +0100621 OVERRIDE_HDR_TYPES,
John Reck88270902021-03-18 11:27:35 -0400622 ADD_HDR_LAYER_INFO_LISTENER,
623 REMOVE_HDR_LAYER_INFO_LISTENER,
Tej Singhe2751772021-04-06 22:05:29 -0700624 ON_PULL_ATOM,
Galia Peycheva8f04b302021-04-27 13:25:38 +0200625 ADD_TUNNEL_MODE_ENABLED_LISTENER,
626 REMOVE_TUNNEL_MODE_ENABLED_LISTENER,
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800627 // Always append new enum to the end.
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800628 };
629
Mathias Agopian3165cc22012-08-08 19:42:09 -0700630 virtual status_t onTransact(uint32_t code, const Parcel& data,
631 Parcel* reply, uint32_t flags = 0);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800632};
633
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800634} // namespace android