blob: ef5353f5949509442207793241540501b10d18a8 [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>
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -100027#include <gui/FrameTimelineInfo.h>
Marissa Wall3dad52d2019-03-22 14:03:19 -070028#include <gui/ITransactionCompletedListener.h>
Ady Abraham62f216c2020-10-13 19:07:23 -070029#include <input/Flags.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
Vishnu Nair7b0eaef2021-11-11 01:01:57 +0000143 virtual status_t getPrimaryPhysicalDisplayId(PhysicalDisplayId*) const = 0;
144
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800145 // TODO(b/74619554): Remove this stopgap once the framework is display-agnostic.
146 std::optional<PhysicalDisplayId> getInternalDisplayId() const {
147 const auto displayIds = getPhysicalDisplayIds();
148 return displayIds.empty() ? std::nullopt : std::make_optional(displayIds.front());
149 }
150
151 /* get token for a physical display given its stable ID obtained via getPhysicalDisplayIds or a
152 * DisplayEventReceiver hotplug event.
153 */
154 virtual sp<IBinder> getPhysicalDisplayToken(PhysicalDisplayId displayId) const = 0;
155
156 // TODO(b/74619554): Remove this stopgap once the framework is display-agnostic.
157 sp<IBinder> getInternalDisplayToken() const {
158 const auto displayId = getInternalDisplayId();
159 return displayId ? getPhysicalDisplayToken(*displayId) : nullptr;
160 }
Mathias Agopiane57f2922012-08-09 16:29:12 -0700161
Mathias Agopian9cce3252010-02-09 17:46:37 -0800162 /* open/close transactions. requires ACCESS_SURFACE_FLINGER permission */
chaviw308ddba2020-08-11 16:23:51 -0700163 virtual status_t setTransactionState(
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000164 const FrameTimelineInfo& frameTimelineInfo, const Vector<ComposerState>& state,
Ady Abraham22c7b5c2020-09-22 19:33:40 -0700165 const Vector<DisplayState>& displays, uint32_t flags, const sp<IBinder>& applyToken,
chaviw308ddba2020-08-11 16:23:51 -0700166 const InputWindowCommands& inputWindowCommands, int64_t desiredPresentTime,
Ady Abrahamf0c56492020-12-17 18:04:15 -0800167 bool isAutoTimestamp, const client_cache_t& uncacheBuffer, bool hasListenerCallbacks,
Pablo Gamito7eb7ee72020-08-05 10:57:05 +0000168 const std::vector<ListenerCallbacks>& listenerCallbacks, uint64_t transactionId) = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800169
170 /* signal that we're done booting.
Mathias Agopian9cce3252010-02-09 17:46:37 -0800171 * Requires ACCESS_SURFACE_FLINGER permission
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800172 */
173 virtual void bootFinished() = 0;
174
Andy McFadden2adaf042012-12-18 09:49:45 -0800175 /* verify that an IGraphicBufferProducer was created by SurfaceFlinger.
Mathias Agopiane57f2922012-08-09 16:29:12 -0700176 */
177 virtual bool authenticateSurfaceTexture(
Andy McFadden2adaf042012-12-18 09:49:45 -0800178 const sp<IGraphicBufferProducer>& surface) const = 0;
Mathias Agopiane57f2922012-08-09 16:29:12 -0700179
Brian Anderson6b376712017-04-04 10:51:39 -0700180 /* Returns the frame timestamps supported by SurfaceFlinger.
181 */
182 virtual status_t getSupportedFrameTimestamps(
183 std::vector<FrameEvent>* outSupported) const = 0;
184
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700185 /* set display power mode. depending on the mode, it can either trigger
186 * screen on, off or low power mode and wait for it to complete.
Mathias Agopian041a0752013-03-15 18:31:56 -0700187 * requires ACCESS_SURFACE_FLINGER permission.
188 */
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700189 virtual void setPowerMode(const sp<IBinder>& display, int mode) = 0;
Mathias Agopian3094df32012-06-18 18:06:45 -0700190
Dan Stoza7f7da322014-05-02 15:26:25 -0700191
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700192 /* returns display statistics for a given display
193 * intended to be used by the media framework to properly schedule
194 * video frames */
195 virtual status_t getDisplayStats(const sp<IBinder>& display,
196 DisplayStatInfo* stats) = 0;
197
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800198 /**
199 * Get transactional state of given display.
200 */
201 virtual status_t getDisplayState(const sp<IBinder>& display, ui::DisplayState*) = 0;
202
203 /**
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100204 * Gets immutable information about given physical display.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800205 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100206 virtual status_t getStaticDisplayInfo(const sp<IBinder>& display, ui::StaticDisplayInfo*) = 0;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800207
208 /**
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100209 * Gets dynamic information about given physical display.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800210 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100211 virtual status_t getDynamicDisplayInfo(const sp<IBinder>& display, ui::DynamicDisplayInfo*) = 0;
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800212
Daniel Solomon42d04562019-01-20 21:03:19 -0800213 virtual status_t getDisplayNativePrimaries(const sp<IBinder>& display,
214 ui::DisplayPrimaries& primaries) = 0;
Michael Wright28f24d02016-07-12 13:30:53 -0700215 virtual status_t setActiveColorMode(const sp<IBinder>& display,
Peiyong Lin9f034472018-03-28 15:29:00 -0700216 ui::ColorMode colorMode) = 0;
Michael Wright28f24d02016-07-12 13:30:53 -0700217
Chia-I Wuff79ef82018-08-22 15:27:32 -0700218 /**
Galia Peycheva5492cb52019-10-30 14:13:16 +0100219 * Switches Auto Low Latency Mode on/off on the connected display, if it is
Marin Shalamanovb173f752021-02-16 19:38:36 +0100220 * available. This should only be called if the display supports Auto Low
221 * Latency Mode as reported in #getDynamicDisplayInfo.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100222 * For more information, see the HDMI 2.1 specification.
223 */
224 virtual void setAutoLowLatencyMode(const sp<IBinder>& display, bool on) = 0;
225
226 /**
Galia Peycheva5492cb52019-10-30 14:13:16 +0100227 * This will start sending infoframes to the connected display with
Marin Shalamanovb173f752021-02-16 19:38:36 +0100228 * ContentType=Game (if on=true). This should only be called if the display
229 * Game Content Type as reported in #getDynamicDisplayInfo.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100230 * For more information, see the HDMI 1.4 specification.
231 */
232 virtual void setGameContentType(const sp<IBinder>& display, bool on) = 0;
233
234 /**
Chia-I Wuff79ef82018-08-22 15:27:32 -0700235 * Capture the specified screen. This requires READ_FRAME_BUFFER
236 * permission. This function will fail if there is a secure window on
chaviwd2432892020-07-24 17:42:39 -0700237 * screen and DisplayCaptureArgs.captureSecureLayers is false.
Chia-I Wuff79ef82018-08-22 15:27:32 -0700238 *
239 * This function can capture a subregion (the source crop) of the screen.
240 * The subregion can be optionally rotated. It will also be scaled to
241 * match the size of the output buffer.
Peiyong Lin0e003c92018-09-17 11:09:51 -0700242 */
chaviwd2432892020-07-24 17:42:39 -0700243 virtual status_t captureDisplay(const DisplayCaptureArgs& args,
chaviw8ffc7b82020-08-18 11:25:37 -0700244 const sp<IScreenCaptureListener>& captureListener) = 0;
Svetoslavd85084b2014-03-20 10:28:31 -0700245
chaviwd2432892020-07-24 17:42:39 -0700246 virtual status_t captureDisplay(uint64_t displayOrLayerStack,
chaviw8ffc7b82020-08-18 11:25:37 -0700247 const sp<IScreenCaptureListener>& captureListener) = 0;
chaviw93df2ea2019-04-30 16:45:12 -0700248
Robert Carr866455f2019-04-02 16:28:26 -0700249 template <class AA>
250 struct SpHash {
251 size_t operator()(const sp<AA>& k) const { return std::hash<AA*>()(k.get()); }
252 };
253
Robert Carr578038f2018-03-09 12:25:24 -0800254 /**
255 * Capture a subtree of the layer hierarchy, potentially ignoring the root node.
chaviw3efadb12020-07-27 10:07:15 -0700256 * This requires READ_FRAME_BUFFER permission. This function will fail if there
257 * is a secure window on screen
Robert Carr578038f2018-03-09 12:25:24 -0800258 */
chaviw3efadb12020-07-27 10:07:15 -0700259 virtual status_t captureLayers(const LayerCaptureArgs& args,
chaviw8ffc7b82020-08-18 11:25:37 -0700260 const sp<IScreenCaptureListener>& captureListener) = 0;
Peiyong Lin0e003c92018-09-17 11:09:51 -0700261
Svetoslavd85084b2014-03-20 10:28:31 -0700262 /* Clears the frame statistics for animations.
263 *
264 * Requires the ACCESS_SURFACE_FLINGER permission.
265 */
266 virtual status_t clearAnimationFrameStats() = 0;
267
268 /* Gets the frame statistics for animations.
269 *
270 * Requires the ACCESS_SURFACE_FLINGER permission.
271 */
272 virtual status_t getAnimationFrameStats(FrameStats* outStats) const = 0;
Dan Stozac4f471e2016-03-24 09:31:08 -0700273
Kriti Dang49ad4132021-01-08 11:49:56 +0100274 /* Overrides the supported HDR modes for the given display device.
275 *
276 * Requires the ACCESS_SURFACE_FLINGER permission.
277 */
278 virtual status_t overrideHdrTypes(const sp<IBinder>& display,
279 const std::vector<ui::Hdr>& hdrTypes) = 0;
280
Tej Singhe2751772021-04-06 22:05:29 -0700281 /* Pulls surfaceflinger atoms global stats and layer stats to pipe to statsd.
282 *
283 * Requires the calling uid be from system server.
284 */
285 virtual status_t onPullAtom(const int32_t atomId, std::string* outData, bool* success) = 0;
286
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -0700287 virtual status_t enableVSyncInjections(bool enable) = 0;
288
289 virtual status_t injectVSync(nsecs_t when) = 0;
Kalle Raitaa099a242017-01-11 11:17:29 -0800290
291 /* Gets the list of active layers in Z order for debugging purposes
292 *
293 * Requires the ACCESS_SURFACE_FLINGER permission.
294 */
Vishnu Nair43bccf82020-06-05 10:53:37 -0700295 virtual status_t getLayerDebugInfo(std::vector<LayerDebugInfo>* outLayers) = 0;
Peiyong Lin0256f722018-08-31 15:45:10 -0700296
Ady Abraham37965d42018-11-01 13:43:32 -0700297 virtual status_t getColorManagement(bool* outGetColorManagement) const = 0;
Peiyong Linc6780972018-10-28 15:24:08 -0700298
299 /* Gets the composition preference of the default data space and default pixel format,
300 * as well as the wide color gamut data space and wide color gamut pixel format.
301 * If the wide color gamut data space is V0_SRGB, then it implies that the platform
302 * has no wide color gamut support.
303 *
304 * Requires the ACCESS_SURFACE_FLINGER permission.
305 */
306 virtual status_t getCompositionPreference(ui::Dataspace* defaultDataspace,
307 ui::PixelFormat* defaultPixelFormat,
308 ui::Dataspace* wideColorGamutDataspace,
309 ui::PixelFormat* wideColorGamutPixelFormat) const = 0;
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700310 /*
311 * Requires the ACCESS_SURFACE_FLINGER permission.
312 */
313 virtual status_t getDisplayedContentSamplingAttributes(const sp<IBinder>& display,
314 ui::PixelFormat* outFormat,
315 ui::Dataspace* outDataspace,
316 uint8_t* outComponentMask) const = 0;
Kevin DuBois74e53772018-11-19 10:52:38 -0800317
318 /* Turns on the color sampling engine on the display.
319 *
320 * Requires the ACCESS_SURFACE_FLINGER permission.
321 */
322 virtual status_t setDisplayContentSamplingEnabled(const sp<IBinder>& display, bool enable,
323 uint8_t componentMask,
Dominik Laskowski470df5f2020-04-02 22:27:42 -0700324 uint64_t maxFrames) = 0;
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700325
326 /* Returns statistics on the color profile of the last frame displayed for a given display
327 *
328 * Requires the ACCESS_SURFACE_FLINGER permission.
329 */
330 virtual status_t getDisplayedContentSample(const sp<IBinder>& display, uint64_t maxFrames,
331 uint64_t timestamp,
332 DisplayedFrameStats* outStats) const = 0;
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800333
334 /*
335 * Gets whether SurfaceFlinger can support protected content in GPU composition.
336 * Requires the ACCESS_SURFACE_FLINGER permission.
337 */
338 virtual status_t getProtectedContentSupport(bool* outSupported) const = 0;
Marissa Wallebc2c052019-01-16 19:16:55 -0800339
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800340 /*
341 * Queries whether the given display is a wide color display.
342 * Requires the ACCESS_SURFACE_FLINGER permission.
343 */
344 virtual status_t isWideColorDisplay(const sp<IBinder>& token,
345 bool* outIsWideColorDisplay) const = 0;
Dan Stoza84ab9372018-12-17 15:27:57 -0800346
347 /* Registers a listener to stream median luma updates from SurfaceFlinger.
348 *
349 * The sampling area is bounded by both samplingArea and the given stopLayerHandle
350 * (i.e., only layers behind the stop layer will be captured and sampled).
351 *
352 * Multiple listeners may be provided so long as they have independent listeners.
353 * If multiple listeners are provided, the effective sampling region for each listener will
354 * be bounded by whichever stop layer has a lower Z value.
355 *
356 * Requires the same permissions as captureLayers and captureScreen.
357 */
358 virtual status_t addRegionSamplingListener(const Rect& samplingArea,
359 const sp<IBinder>& stopLayerHandle,
360 const sp<IRegionSamplingListener>& listener) = 0;
361
362 /*
363 * Removes a listener that was streaming median luma updates from SurfaceFlinger.
364 */
365 virtual status_t removeRegionSamplingListener(const sp<IRegionSamplingListener>& listener) = 0;
Ady Abraham838de062019-02-04 10:24:03 -0800366
Alec Mouriadebf5c2021-01-05 12:57:36 -0800367 /* Registers a listener that streams fps updates from SurfaceFlinger.
368 *
Alec Mouria9a68a62021-03-04 19:14:50 -0800369 * The listener will stream fps updates for the layer tree rooted at the layer denoted by the
370 * task ID, i.e., the layer must have the task ID as part of its layer metadata with key
371 * METADATA_TASK_ID. If there is no such layer, then no fps is expected to be reported.
Alec Mouriadebf5c2021-01-05 12:57:36 -0800372 *
373 * Multiple listeners may be supported.
374 *
Alec Mouria9a68a62021-03-04 19:14:50 -0800375 * Requires the READ_FRAME_BUFFER permission.
Alec Mouriadebf5c2021-01-05 12:57:36 -0800376 */
Alec Mouria9a68a62021-03-04 19:14:50 -0800377 virtual status_t addFpsListener(int32_t taskId, const sp<gui::IFpsListener>& listener) = 0;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800378 /*
379 * Removes a listener that was streaming fps updates from SurfaceFlinger.
380 */
381 virtual status_t removeFpsListener(const sp<gui::IFpsListener>& listener) = 0;
382
Galia Peycheva8f04b302021-04-27 13:25:38 +0200383 /* Registers a listener to receive tunnel mode enabled updates from SurfaceFlinger.
384 *
385 * Requires ACCESS_SURFACE_FLINGER permission.
386 */
387 virtual status_t addTunnelModeEnabledListener(
388 const sp<gui::ITunnelModeEnabledListener>& listener) = 0;
389
390 /*
391 * Removes a listener that was receiving tunnel mode enabled updates from SurfaceFlinger.
392 *
393 * Requires ACCESS_SURFACE_FLINGER permission.
394 */
395 virtual status_t removeTunnelModeEnabledListener(
396 const sp<gui::ITunnelModeEnabledListener>& listener) = 0;
397
Steven Thomasf734df42020-04-13 21:09:28 -0700398 /* Sets the refresh rate boundaries for the display.
399 *
400 * The primary refresh rate range represents display manager's general guidance on the display
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100401 * modes we'll consider when switching refresh rates. Unless we get an explicit signal from an
Steven Thomasf734df42020-04-13 21:09:28 -0700402 * app, we should stay within this range.
403 *
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100404 * The app request refresh rate range allows us to consider more display modes when switching
Steven Thomasf734df42020-04-13 21:09:28 -0700405 * refresh rates. Although we should generally stay within the primary range, specific
406 * considerations, such as layer frame rate settings specified via the setFrameRate() api, may
407 * cause us to go outside the primary range. We never go outside the app request range. The app
408 * request range will be greater than or equal to the primary refresh rate range, never smaller.
409 *
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100410 * defaultMode is used to narrow the list of display modes SurfaceFlinger will consider
411 * switching between. Only modes with a mode group and resolution matching defaultMode
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100412 * will be considered for switching. The defaultMode corresponds to an ID of mode in the list
413 * of supported modes returned from getDynamicDisplayInfo().
Ana Krulec0782b882019-10-15 17:34:54 -0700414 */
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100415 virtual status_t setDesiredDisplayModeSpecs(
416 const sp<IBinder>& displayToken, ui::DisplayModeId defaultMode,
417 bool allowGroupSwitching, float primaryRefreshRateMin, float primaryRefreshRateMax,
418 float appRequestRefreshRateMin, float appRequestRefreshRateMax) = 0;
Ana Krulec0782b882019-10-15 17:34:54 -0700419
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100420 virtual status_t getDesiredDisplayModeSpecs(const sp<IBinder>& displayToken,
421 ui::DisplayModeId* outDefaultMode,
422 bool* outAllowGroupSwitching,
423 float* outPrimaryRefreshRateMin,
424 float* outPrimaryRefreshRateMax,
425 float* outAppRequestRefreshRateMin,
426 float* outAppRequestRefreshRateMax) = 0;
Ana Krulec0782b882019-10-15 17:34:54 -0700427 /*
Dan Gittik57e63c52019-01-18 16:37:54 +0000428 * Gets whether brightness operations are supported on a display.
429 *
430 * displayToken
431 * The token of the display.
432 * outSupport
433 * An output parameter for whether brightness operations are supported.
434 *
435 * Returns NO_ERROR upon success. Otherwise,
436 * NAME_NOT_FOUND if the display is invalid, or
437 * BAD_VALUE if the output parameter is invalid.
438 */
439 virtual status_t getDisplayBrightnessSupport(const sp<IBinder>& displayToken,
440 bool* outSupport) const = 0;
441
442 /*
443 * Sets the brightness of a display.
444 *
445 * displayToken
446 * The token of the display whose brightness is set.
447 * brightness
John Reck22be6962021-03-10 12:59:54 -0500448 * The DisplayBrightness info to set on the desired display.
Dan Gittik57e63c52019-01-18 16:37:54 +0000449 *
450 * Returns NO_ERROR upon success. Otherwise,
451 * NAME_NOT_FOUND if the display is invalid, or
452 * BAD_VALUE if the brightness is invalid, or
453 * INVALID_OPERATION if brightness operations are not supported.
454 */
John Reck22be6962021-03-10 12:59:54 -0500455 virtual status_t setDisplayBrightness(const sp<IBinder>& displayToken,
456 const gui::DisplayBrightness& brightness) = 0;
Ady Abraham8532d012019-05-08 14:50:56 -0700457
458 /*
John Reck88270902021-03-18 11:27:35 -0400459 * Adds a listener that receives HDR layer information. This is used in combination
460 * with setDisplayBrightness to adjust the display brightness depending on factors such
461 * as whether or not HDR is in use.
462 *
463 * Returns NO_ERROR upon success or NAME_NOT_FOUND if the display is invalid.
464 */
465 virtual status_t addHdrLayerInfoListener(const sp<IBinder>& displayToken,
466 const sp<gui::IHdrLayerInfoListener>& listener) = 0;
467 /*
468 * Removes a listener that was added with addHdrLayerInfoListener.
469 *
470 * Returns NO_ERROR upon success, NAME_NOT_FOUND if the display is invalid, and BAD_VALUE if
471 * the listener wasn't registered.
472 *
473 */
474 virtual status_t removeHdrLayerInfoListener(const sp<IBinder>& displayToken,
475 const sp<gui::IHdrLayerInfoListener>& listener) = 0;
476
477 /*
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100478 * Sends a power boost to the composer. This function is asynchronous.
Ady Abraham8532d012019-05-08 14:50:56 -0700479 *
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100480 * boostId
481 * boost id according to android::hardware::power::Boost
Ady Abraham8532d012019-05-08 14:50:56 -0700482 *
483 * Returns NO_ERROR upon success.
484 */
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100485 virtual status_t notifyPowerBoost(int32_t boostId) = 0;
Vishnu Nairb13bb952019-11-15 10:24:08 -0800486
487 /*
488 * Sets the global configuration for all the shadows drawn by SurfaceFlinger. Shadow follows
489 * material design guidelines.
490 *
491 * ambientColor
492 * Color to the ambient shadow. The alpha is premultiplied.
493 *
494 * spotColor
495 * Color to the spot shadow. The alpha is premultiplied. The position of the spot shadow
496 * depends on the light position.
497 *
498 * lightPosY/lightPosZ
499 * Position of the light used to cast the spot shadow. The X value is always the display
500 * width / 2.
501 *
502 * lightRadius
503 * Radius of the light casting the shadow.
504 */
505 virtual status_t setGlobalShadowSettings(const half4& ambientColor, const half4& spotColor,
506 float lightPosY, float lightPosZ,
507 float lightRadius) = 0;
Steven Thomas62a4cf82020-01-31 12:04:03 -0800508
509 /*
510 * Sets the intended frame rate for a surface. See ANativeWindow_setFrameRate() for more info.
511 */
512 virtual status_t setFrameRate(const sp<IGraphicBufferProducer>& surface, float frameRate,
Marin Shalamanovc5986772021-03-16 16:09:49 +0100513 int8_t compatibility, int8_t changeFrameRateStrategy) = 0;
Steven Thomasd4071902020-03-24 16:02:53 -0700514
515 /*
516 * Acquire a frame rate flexibility token from SurfaceFlinger. While this token is acquired,
517 * surface flinger will freely switch between frame rates in any way it sees fit, regardless of
518 * the current restrictions applied by DisplayManager. This is useful to get consistent behavior
519 * for tests. Release the token by releasing the returned IBinder reference.
520 */
521 virtual status_t acquireFrameRateFlexibilityToken(sp<IBinder>* outToken) = 0;
Ady Abraham74e17562020-08-24 18:18:19 -0700522
523 /*
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000524 * Sets the frame timeline vsync info received from choreographer that corresponds to next
Ady Abraham74e17562020-08-24 18:18:19 -0700525 * buffer submitted on that surface.
526 */
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000527 virtual status_t setFrameTimelineInfo(const sp<IGraphicBufferProducer>& surface,
528 const FrameTimelineInfo& frameTimelineInfo) = 0;
Pablo Gamito6ee484d2020-07-30 14:26:28 +0000529
530 /*
531 * Adds a TransactionTraceListener to listen for transaction tracing state updates.
532 */
533 virtual status_t addTransactionTraceListener(
534 const sp<gui::ITransactionTraceListener>& listener) = 0;
Ana Krulec31f2b3c2020-12-14 14:30:09 -0800535
536 /**
537 * Gets priority of the RenderEngine in SurfaceFlinger.
538 */
539 virtual int getGPUContextPriority() = 0;
Ady Abraham564f9de2021-02-03 18:34:33 -0800540
541 /**
Ady Abraham899dcdb2021-06-15 16:56:21 -0700542 * Gets the number of buffers SurfaceFlinger would need acquire. This number
543 * would be propagated to the client via MIN_UNDEQUEUED_BUFFERS so that the
544 * client could allocate enough buffers to match SF expectations of the
545 * pipeline depth. SurfaceFlinger will make sure that it will give the app at
546 * least the time configured as the 'appDuration' before trying to latch
547 * the buffer.
Ady Abraham564f9de2021-02-03 18:34:33 -0800548 *
549 * The total buffers needed for a given configuration is basically the
550 * numbers of vsyncs a single buffer is used across the stack. For the default
551 * configuration a buffer is held ~1 vsync by the app, ~1 vsync by SurfaceFlinger
552 * and 1 vsync by the display. The extra buffers are calculated as the
Ady Abraham899dcdb2021-06-15 16:56:21 -0700553 * number of additional buffers on top of the 2 buffers already present
554 * in MIN_UNDEQUEUED_BUFFERS.
Ady Abraham564f9de2021-02-03 18:34:33 -0800555 */
Ady Abraham899dcdb2021-06-15 16:56:21 -0700556 virtual status_t getMaxAcquiredBufferCount(int* buffers) const = 0;
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800557};
558
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800559// ----------------------------------------------------------------------------
560
Mathias Agopian3165cc22012-08-08 19:42:09 -0700561class BnSurfaceComposer: public BnInterface<ISurfaceComposer> {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800562public:
Ana Krulec13be8ad2018-08-21 02:43:56 +0000563 enum ISurfaceComposerTag {
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800564 // Note: BOOT_FINISHED must remain this value, it is called from
565 // Java by ActivityManagerService.
566 BOOT_FINISHED = IBinder::FIRST_CALL_TRANSACTION,
567 CREATE_CONNECTION,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100568 GET_STATIC_DISPLAY_INFO,
Mathias Agopiand0566bc2011-11-17 17:49:17 -0800569 CREATE_DISPLAY_EVENT_CONNECTION,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700570 CREATE_DISPLAY,
Jesse Hall6c913be2013-08-08 12:15:49 -0700571 DESTROY_DISPLAY,
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800572 GET_PHYSICAL_DISPLAY_TOKEN,
Mathias Agopiane57f2922012-08-09 16:29:12 -0700573 SET_TRANSACTION_STATE,
574 AUTHENTICATE_SURFACE,
Brian Anderson069b3652016-07-22 10:32:47 -0700575 GET_SUPPORTED_FRAME_TIMESTAMPS,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100576 GET_DISPLAY_MODES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
577 GET_ACTIVE_DISPLAY_MODE, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800578 GET_DISPLAY_STATE,
chaviwd2432892020-07-24 17:42:39 -0700579 CAPTURE_DISPLAY,
chaviwa76b2712017-09-20 12:02:26 -0700580 CAPTURE_LAYERS,
Svetoslavd85084b2014-03-20 10:28:31 -0700581 CLEAR_ANIMATION_FRAME_STATS,
Prashant Malani2c9b11f2014-05-25 01:36:31 -0700582 GET_ANIMATION_FRAME_STATS,
583 SET_POWER_MODE,
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700584 GET_DISPLAY_STATS,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100585 GET_HDR_CAPABILITIES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
586 GET_DISPLAY_COLOR_MODES, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
587 GET_ACTIVE_COLOR_MODE, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Michael Wright28f24d02016-07-12 13:30:53 -0700588 SET_ACTIVE_COLOR_MODE,
Sahil Dhanjuc1ba5c42016-06-07 20:09:20 -0700589 ENABLE_VSYNC_INJECTIONS,
Robert Carr1db73f62016-12-21 12:58:51 -0800590 INJECT_VSYNC,
Kalle Raitaa099a242017-01-11 11:17:29 -0800591 GET_LAYER_DEBUG_INFO,
Peiyong Lin0256f722018-08-31 15:45:10 -0700592 GET_COMPOSITION_PREFERENCE,
Ady Abraham37965d42018-11-01 13:43:32 -0700593 GET_COLOR_MANAGEMENT,
Kevin DuBois9c0a1762018-10-16 13:32:31 -0700594 GET_DISPLAYED_CONTENT_SAMPLING_ATTRIBUTES,
Kevin DuBois74e53772018-11-19 10:52:38 -0800595 SET_DISPLAY_CONTENT_SAMPLING_ENABLED,
Kevin DuBois1d4249a2018-08-29 10:45:14 -0700596 GET_DISPLAYED_CONTENT_SAMPLE,
Peiyong Lin3c2791e2019-01-14 17:05:18 -0800597 GET_PROTECTED_CONTENT_SUPPORT,
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800598 IS_WIDE_COLOR_DISPLAY,
Daniel Solomon42d04562019-01-20 21:03:19 -0800599 GET_DISPLAY_NATIVE_PRIMARIES,
Dominik Laskowskidcb38bb2019-01-25 02:35:50 -0800600 GET_PHYSICAL_DISPLAY_IDS,
Dan Stoza84ab9372018-12-17 15:27:57 -0800601 ADD_REGION_SAMPLING_LISTENER,
602 REMOVE_REGION_SAMPLING_LISTENER,
Marin Shalamanova7fe3042021-01-29 21:02:08 +0100603 SET_DESIRED_DISPLAY_MODE_SPECS,
604 GET_DESIRED_DISPLAY_MODE_SPECS,
Dan Gittik57e63c52019-01-18 16:37:54 +0000605 GET_DISPLAY_BRIGHTNESS_SUPPORT,
606 SET_DISPLAY_BRIGHTNESS,
chaviwd2432892020-07-24 17:42:39 -0700607 CAPTURE_DISPLAY_BY_ID,
Lais Andrade3a6e47d2020-04-02 11:20:16 +0100608 NOTIFY_POWER_BOOST,
Vishnu Nairb13bb952019-11-15 10:24:08 -0800609 SET_GLOBAL_SHADOW_SETTINGS,
Marin Shalamanovb173f752021-02-16 19:38:36 +0100610 GET_AUTO_LOW_LATENCY_MODE_SUPPORT, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100611 SET_AUTO_LOW_LATENCY_MODE,
Marin Shalamanovb173f752021-02-16 19:38:36 +0100612 GET_GAME_CONTENT_TYPE_SUPPORT, // Deprecated. Use GET_DYNAMIC_DISPLAY_INFO instead.
Galia Peycheva5492cb52019-10-30 14:13:16 +0100613 SET_GAME_CONTENT_TYPE,
Steven Thomas62a4cf82020-01-31 12:04:03 -0800614 SET_FRAME_RATE,
Steven Thomasd4071902020-03-24 16:02:53 -0700615 ACQUIRE_FRAME_RATE_FLEXIBILITY_TOKEN,
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000616 SET_FRAME_TIMELINE_INFO,
Pablo Gamito6ee484d2020-07-30 14:26:28 +0000617 ADD_TRANSACTION_TRACE_LISTENER,
Ana Krulec31f2b3c2020-12-14 14:30:09 -0800618 GET_GPU_CONTEXT_PRIORITY,
Ady Abraham899dcdb2021-06-15 16:56:21 -0700619 GET_MAX_ACQUIRED_BUFFER_COUNT,
Marin Shalamanov228f46b2021-01-28 21:11:45 +0100620 GET_DYNAMIC_DISPLAY_INFO,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800621 ADD_FPS_LISTENER,
622 REMOVE_FPS_LISTENER,
Kriti Dang49ad4132021-01-08 11:49:56 +0100623 OVERRIDE_HDR_TYPES,
John Reck88270902021-03-18 11:27:35 -0400624 ADD_HDR_LAYER_INFO_LISTENER,
625 REMOVE_HDR_LAYER_INFO_LISTENER,
Tej Singhe2751772021-04-06 22:05:29 -0700626 ON_PULL_ATOM,
Galia Peycheva8f04b302021-04-27 13:25:38 +0200627 ADD_TUNNEL_MODE_ENABLED_LISTENER,
628 REMOVE_TUNNEL_MODE_ENABLED_LISTENER,
Vishnu Nair7b0eaef2021-11-11 01:01:57 +0000629 GET_PRIMARY_PHYSICAL_DISPLAY_ID,
Peiyong Lin4f3fddf2019-01-24 17:21:24 -0800630 // Always append new enum to the end.
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800631 };
632
Mathias Agopian3165cc22012-08-08 19:42:09 -0700633 virtual status_t onTransact(uint32_t code, const Parcel& data,
634 Parcel* reply, uint32_t flags = 0);
The Android Open Source Projectedbf3b62009-03-03 19:31:44 -0800635};
636
Dominik Laskowski3cb3d4e2019-11-21 11:14:45 -0800637} // namespace android