1 /* 2 * Copyright 2018 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 /** 18 * @addtogroup NativeActivity Native Activity 19 * @{ 20 */ 21 22 /** 23 * @file surface_control.h 24 */ 25 26 #ifndef ANDROID_SURFACE_CONTROL_H 27 #define ANDROID_SURFACE_CONTROL_H 28 29 #include <sys/cdefs.h> 30 31 #include <android/data_space.h> 32 #include <android/hardware_buffer.h> 33 #include <android/hdr_metadata.h> 34 #include <android/native_window.h> 35 36 __BEGIN_DECLS 37 38 #if __ANDROID_API__ >= 29 39 40 struct ASurfaceControl; 41 42 /** 43 * The SurfaceControl API can be used to provide a hierarchy of surfaces for 44 * composition to the system compositor. ASurfaceControl represents a content node in 45 * this hierarchy. 46 */ 47 typedef struct ASurfaceControl ASurfaceControl; 48 49 /* 50 * Creates an ASurfaceControl with either ANativeWindow or an ASurfaceControl as its parent. 51 * |debug_name| is a debug name associated with this surface. It can be used to 52 * identify this surface in the SurfaceFlinger's layer tree. It must not be 53 * null. 54 * 55 * The caller takes ownership of the ASurfaceControl returned and must release it 56 * using ASurfaceControl_release below. 57 */ 58 ASurfaceControl* ASurfaceControl_createFromWindow(ANativeWindow* parent, const char* debug_name) 59 __INTRODUCED_IN(29); 60 61 ASurfaceControl* ASurfaceControl_create(ASurfaceControl* parent, const char* debug_name) 62 __INTRODUCED_IN(29); 63 64 /** 65 * Releases the |surface_control| object. After releasing the ASurfaceControl the caller no longer 66 * has ownership of the AsurfaceControl. The surface and it's children may remain on display as long 67 * as their parent remains on display. 68 */ 69 void ASurfaceControl_release(ASurfaceControl* surface_control) __INTRODUCED_IN(29); 70 71 struct ASurfaceTransaction; 72 73 /** 74 * ASurfaceTransaction is a collection of updates to the surface tree that must 75 * be applied atomically. 76 */ 77 typedef struct ASurfaceTransaction ASurfaceTransaction; 78 79 /** 80 * The caller takes ownership of the transaction and must release it using 81 * ASurfaceControl_delete below. 82 */ 83 ASurfaceTransaction* ASurfaceTransaction_create() __INTRODUCED_IN(29); 84 85 /** 86 * Destroys the |transaction| object. 87 */ 88 void ASurfaceTransaction_delete(ASurfaceTransaction* transaction) __INTRODUCED_IN(29); 89 90 /** 91 * Applies the updates accumulated in |transaction|. 92 * 93 * Note that the transaction is guaranteed to be applied atomically. The 94 * transactions which are applied on the same thread are also guaranteed to be 95 * applied in order. 96 */ 97 void ASurfaceTransaction_apply(ASurfaceTransaction* transaction) __INTRODUCED_IN(29); 98 99 /** 100 * An opaque handle returned during a callback that can be used to query general stats and stats for 101 * surfaces which were either removed or for which buffers were updated after this transaction was 102 * applied. 103 */ 104 typedef struct ASurfaceTransactionStats ASurfaceTransactionStats; 105 106 /** 107 * Since the transactions are applied asynchronously, the 108 * ASurfaceTransaction_OnComplete callback can be used to be notified when a frame 109 * including the updates in a transaction was presented. 110 * 111 * |context| is the optional context provided by the client that is passed into 112 * the callback. 113 * 114 * |stats| is an opaque handle that can be passed to ASurfaceTransactionStats functions to query 115 * information about the transaction. The handle is only valid during the callback. 116 * 117 * THREADING 118 * The transaction completed callback can be invoked on any thread. 119 */ 120 typedef void (*ASurfaceTransaction_OnComplete)(void* context, ASurfaceTransactionStats* stats) 121 __INTRODUCED_IN(29); 122 123 /** 124 * Returns the timestamp of when the frame was latched by the framework. Once a frame is 125 * latched by the framework, it is presented at the following hardware vsync. 126 */ 127 int64_t ASurfaceTransactionStats_getLatchTime(ASurfaceTransactionStats* surface_transaction_stats) 128 __INTRODUCED_IN(29); 129 130 /** 131 * Returns a sync fence that signals when the transaction has been presented. 132 * The recipient of the callback takes ownership of the fence and is responsible for closing 133 * it. 134 */ 135 int ASurfaceTransactionStats_getPresentFenceFd(ASurfaceTransactionStats* surface_transaction_stats) 136 __INTRODUCED_IN(29); 137 138 /** 139 * |outASurfaceControls| returns an array of ASurfaceControl pointers that were updated during the 140 * transaction. Stats for the surfaces can be queried through ASurfaceTransactionStats functions. 141 * When the client is done using the array, it must release it by calling 142 * ASurfaceTransactionStats_releaseASurfaceControls. 143 * 144 * |outASurfaceControlsSize| returns the size of the ASurfaceControls array. 145 */ 146 void ASurfaceTransactionStats_getASurfaceControls(ASurfaceTransactionStats* surface_transaction_stats, 147 ASurfaceControl*** outASurfaceControls, 148 size_t* outASurfaceControlsSize) 149 __INTRODUCED_IN(29); 150 /** 151 * Releases the array of ASurfaceControls that were returned by 152 * ASurfaceTransactionStats_getASurfaceControls. 153 */ 154 void ASurfaceTransactionStats_releaseASurfaceControls(ASurfaceControl** surface_controls) 155 __INTRODUCED_IN(29); 156 157 /** 158 * Returns the timestamp of when the CURRENT buffer was acquired. A buffer is considered 159 * acquired when its acquire_fence_fd has signaled. A buffer cannot be latched or presented until 160 * it is acquired. If no acquire_fence_fd was provided, this timestamp will be set to -1. 161 */ 162 int64_t ASurfaceTransactionStats_getAcquireTime(ASurfaceTransactionStats* surface_transaction_stats, 163 ASurfaceControl* surface_control) 164 __INTRODUCED_IN(29); 165 166 /** 167 * The returns the fence used to signal the release of the PREVIOUS buffer set on 168 * this surface. If this fence is valid (>=0), the PREVIOUS buffer has not yet been released and the 169 * fence will signal when the PREVIOUS buffer has been released. If the fence is -1 , the PREVIOUS 170 * buffer is already released. The recipient of the callback takes ownership of the 171 * previousReleaseFenceFd and is responsible for closing it. 172 * 173 * Each time a buffer is set through ASurfaceTransaction_setBuffer()/_setCachedBuffer() on a 174 * transaction which is applied, the framework takes a ref on this buffer. The framework treats the 175 * addition of a buffer to a particular surface as a unique ref. When a transaction updates or 176 * removes a buffer from a surface, or removes the surface itself from the tree, this ref is 177 * guaranteed to be released in the OnComplete callback for this transaction. The 178 * ASurfaceControlStats provided in the callback for this surface may contain an optional fence 179 * which must be signaled before the ref is assumed to be released. 180 * 181 * The client must ensure that all pending refs on a buffer are released before attempting to reuse 182 * this buffer, otherwise synchronization errors may occur. 183 */ 184 int ASurfaceTransactionStats_getPreviousReleaseFenceFd( 185 ASurfaceTransactionStats* surface_transaction_stats, 186 ASurfaceControl* surface_control) 187 __INTRODUCED_IN(29); 188 189 /** 190 * Sets the callback that will be invoked when the updates from this transaction 191 * are presented. For details on the callback semantics and data, see the 192 * comments on the ASurfaceTransaction_OnComplete declaration above. 193 */ 194 void ASurfaceTransaction_setOnComplete(ASurfaceTransaction* transaction, void* context, 195 ASurfaceTransaction_OnComplete func) __INTRODUCED_IN(29); 196 197 /** 198 * Reparents the |surface_control| from its old parent to the |new_parent| surface control. 199 * Any children of the* reparented |surface_control| will remain children of the |surface_control|. 200 * 201 * The |new_parent| can be null. Surface controls with a null parent do not appear on the display. 202 */ 203 void ASurfaceTransaction_reparent(ASurfaceTransaction* transaction, 204 ASurfaceControl* surface_control, ASurfaceControl* new_parent) 205 __INTRODUCED_IN(29); 206 207 /* Parameter for ASurfaceTransaction_setVisibility */ 208 enum { 209 ASURFACE_TRANSACTION_VISIBILITY_HIDE = 0, 210 ASURFACE_TRANSACTION_VISIBILITY_SHOW = 1, 211 }; 212 /** 213 * Updates the visibility of |surface_control|. If show is set to 214 * ASURFACE_TRANSACTION_VISIBILITY_HIDE, the |surface_control| and all surfaces in its subtree will 215 * be hidden. 216 */ 217 void ASurfaceTransaction_setVisibility(ASurfaceTransaction* transaction, 218 ASurfaceControl* surface_control, int8_t visibility) 219 __INTRODUCED_IN(29); 220 221 /** 222 * Updates the z order index for |surface_control|. Note that the z order for a surface 223 * is relative to other surfaces which are siblings of this surface. The behavior of sibilings with 224 * the same z order is undefined. 225 * 226 * Z orders may be from MIN_INT32 to MAX_INT32. A layer's default z order index is 0. 227 */ 228 void ASurfaceTransaction_setZOrder(ASurfaceTransaction* transaction, 229 ASurfaceControl* surface_control, int32_t z_order) 230 __INTRODUCED_IN(29); 231 232 /** 233 * Updates the AHardwareBuffer displayed for |surface_control|. If not -1, the 234 * acquire_fence_fd should be a file descriptor that is signaled when all pending work 235 * for the buffer is complete and the buffer can be safely read. 236 * 237 * The frameworks takes ownership of the |acquire_fence_fd| passed and is responsible 238 * for closing it. 239 */ 240 void ASurfaceTransaction_setBuffer(ASurfaceTransaction* transaction, 241 ASurfaceControl* surface_control, AHardwareBuffer* buffer, 242 int acquire_fence_fd = -1) __INTRODUCED_IN(29); 243 244 /** 245 * Updates the color for |surface_control|. This will make the background color for the 246 * ASurfaceControl visible in transparent regions of the surface. Colors |r|, |g|, 247 * and |b| must be within the range that is valid for |dataspace|. |dataspace| and |alpha| 248 * will be the dataspace and alpha set for the background color layer. 249 */ 250 void ASurfaceTransaction_setColor(ASurfaceTransaction* transaction, 251 ASurfaceControl* surface_control, float r, float g, float b, 252 float alpha, ADataSpace dataspace) 253 __INTRODUCED_IN(29); 254 255 /** 256 * |source| the sub-rect within the buffer's content to be rendered inside the surface's area 257 * The surface's source rect is clipped by the bounds of its current buffer. The source rect's width 258 * and height must be > 0. 259 * 260 * |destination| specifies the rect in the parent's space where this surface will be drawn. The post 261 * source rect bounds are scaled to fit the destination rect. The surface's destination rect is 262 * clipped by the bounds of its parent. The destination rect's width and height must be > 0. 263 * 264 * |transform| the transform applied after the source rect is applied to the buffer. This parameter 265 * should be set to 0 for no transform. To specify a transfrom use the NATIVE_WINDOW_TRANSFORM_* 266 * enum. 267 */ 268 void ASurfaceTransaction_setGeometry(ASurfaceTransaction* transaction, 269 ASurfaceControl* surface_control, const ARect& source, 270 const ARect& destination, int32_t transform) 271 __INTRODUCED_IN(29); 272 273 274 /* Parameter for ASurfaceTransaction_setBufferTransparency */ 275 enum { 276 ASURFACE_TRANSACTION_TRANSPARENCY_TRANSPARENT = 0, 277 ASURFACE_TRANSACTION_TRANSPARENCY_TRANSLUCENT = 1, 278 ASURFACE_TRANSACTION_TRANSPARENCY_OPAQUE = 2, 279 }; 280 /** 281 * Updates whether the content for the buffer associated with this surface is 282 * completely opaque. If true, every pixel of content inside the buffer must be 283 * opaque or visual errors can occur. 284 */ 285 void ASurfaceTransaction_setBufferTransparency(ASurfaceTransaction* transaction, 286 ASurfaceControl* surface_control, 287 int8_t transparency) 288 __INTRODUCED_IN(29); 289 290 /** 291 * Updates the region for the content on this surface updated in this 292 * transaction. If unspecified, the complete surface is assumed to be damaged. 293 */ 294 void ASurfaceTransaction_setDamageRegion(ASurfaceTransaction* transaction, 295 ASurfaceControl* surface_control, const ARect rects[], 296 uint32_t count) __INTRODUCED_IN(29); 297 298 /** 299 * Specifies a desiredPresentTime for the transaction. The framework will try to present 300 * the transaction at or after the time specified. 301 * 302 * Transactions will not be presented until all of their acquire fences have signaled even if the 303 * app requests an earlier present time. 304 * 305 * If an earlier transaction has a desired present time of x, and a later transaction has a desired 306 * present time that is before x, the later transaction will not preempt the earlier transaction. 307 */ 308 void ASurfaceTransaction_setDesiredPresentTime(ASurfaceTransaction* transaction, 309 int64_t desiredPresentTime) __INTRODUCED_IN(29); 310 311 /** 312 * Sets the alpha for the buffer. It uses a premultiplied blending. 313 * 314 * The |alpha| must be between 0.0 and 1.0. 315 */ 316 void ASurfaceTransaction_setBufferAlpha(ASurfaceTransaction* transaction, 317 ASurfaceControl* surface_control, float alpha) 318 __INTRODUCED_IN(29); 319 320 /** 321 * Sets the data space of the surface_control's buffers. 322 * 323 * If no data space is set, the surface control defaults to ADATASPACE_SRGB. 324 */ 325 void ASurfaceTransaction_setBufferDataSpace(ASurfaceTransaction* transaction, 326 ASurfaceControl* surface_control, ADataSpace data_space) 327 __INTRODUCED_IN(29); 328 329 /* 330 * SMPTE ST 2086 "Mastering Display Color Volume" static metadata 331 * 332 * When |metadata| is set to null, the framework does not use any smpte2086 metadata when rendering 333 * the surface's buffer. 334 */ 335 void ASurfaceTransaction_setHdrMetadata_smpte2086(ASurfaceTransaction* transaction, 336 ASurfaceControl* surface_control, 337 struct AHdrMetadata_smpte2086* metadata) 338 __INTRODUCED_IN(29); 339 340 /* 341 * Sets the CTA 861.3 "HDR Static Metadata Extension" static metadata on a surface. 342 * 343 * When |metadata| is set to null, the framework does not use any cta861.3 metadata when rendering 344 * the surface's buffer. 345 */ 346 void ASurfaceTransaction_setHdrMetadata_cta861_3(ASurfaceTransaction* transaction, 347 ASurfaceControl* surface_control, 348 struct AHdrMetadata_cta861_3* metadata) 349 __INTRODUCED_IN(29); 350 351 #endif // __ANDROID_API__ >= 29 352 353 __END_DECLS 354 355 #endif // ANDROID_SURFACE_CONTROL_H 356
