Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #ifndef SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H |
| 18 | #define SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H |
| 19 | |
| 20 | #include <stdint.h> |
Mathias Agopian | c958a7f | 2012-02-25 21:13:36 -0800 | [diff] [blame^] | 21 | #include <string.h> |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 22 | #include <sys/cdefs.h> |
| 23 | #include <system/graphics.h> |
| 24 | #include <cutils/native_handle.h> |
| 25 | |
| 26 | __BEGIN_DECLS |
| 27 | |
| 28 | /*****************************************************************************/ |
| 29 | |
| 30 | #define ANDROID_NATIVE_MAKE_CONSTANT(a,b,c,d) \ |
| 31 | (((unsigned)(a)<<24)|((unsigned)(b)<<16)|((unsigned)(c)<<8)|(unsigned)(d)) |
| 32 | |
| 33 | #define ANDROID_NATIVE_WINDOW_MAGIC \ |
| 34 | ANDROID_NATIVE_MAKE_CONSTANT('_','w','n','d') |
| 35 | |
| 36 | #define ANDROID_NATIVE_BUFFER_MAGIC \ |
| 37 | ANDROID_NATIVE_MAKE_CONSTANT('_','b','f','r') |
| 38 | |
| 39 | // --------------------------------------------------------------------------- |
| 40 | |
| 41 | typedef const native_handle_t* buffer_handle_t; |
| 42 | |
| 43 | // --------------------------------------------------------------------------- |
| 44 | |
| 45 | typedef struct android_native_rect_t |
| 46 | { |
| 47 | int32_t left; |
| 48 | int32_t top; |
| 49 | int32_t right; |
| 50 | int32_t bottom; |
| 51 | } android_native_rect_t; |
| 52 | |
| 53 | // --------------------------------------------------------------------------- |
| 54 | |
| 55 | typedef struct android_native_base_t |
| 56 | { |
| 57 | /* a magic value defined by the actual EGL native type */ |
| 58 | int magic; |
| 59 | |
| 60 | /* the sizeof() of the actual EGL native type */ |
| 61 | int version; |
| 62 | |
| 63 | void* reserved[4]; |
| 64 | |
| 65 | /* reference-counting interface */ |
| 66 | void (*incRef)(struct android_native_base_t* base); |
| 67 | void (*decRef)(struct android_native_base_t* base); |
| 68 | } android_native_base_t; |
| 69 | |
| 70 | typedef struct ANativeWindowBuffer |
| 71 | { |
| 72 | #ifdef __cplusplus |
| 73 | ANativeWindowBuffer() { |
| 74 | common.magic = ANDROID_NATIVE_BUFFER_MAGIC; |
| 75 | common.version = sizeof(ANativeWindowBuffer); |
| 76 | memset(common.reserved, 0, sizeof(common.reserved)); |
| 77 | } |
| 78 | |
| 79 | // Implement the methods that sp<ANativeWindowBuffer> expects so that it |
| 80 | // can be used to automatically refcount ANativeWindowBuffer's. |
| 81 | void incStrong(const void* id) const { |
| 82 | common.incRef(const_cast<android_native_base_t*>(&common)); |
| 83 | } |
| 84 | void decStrong(const void* id) const { |
| 85 | common.decRef(const_cast<android_native_base_t*>(&common)); |
| 86 | } |
| 87 | #endif |
| 88 | |
| 89 | struct android_native_base_t common; |
| 90 | |
| 91 | int width; |
| 92 | int height; |
| 93 | int stride; |
| 94 | int format; |
| 95 | int usage; |
| 96 | |
| 97 | void* reserved[2]; |
| 98 | |
| 99 | buffer_handle_t handle; |
| 100 | |
| 101 | void* reserved_proc[8]; |
| 102 | } ANativeWindowBuffer_t; |
| 103 | |
| 104 | // Old typedef for backwards compatibility. |
| 105 | typedef ANativeWindowBuffer_t android_native_buffer_t; |
| 106 | |
| 107 | // --------------------------------------------------------------------------- |
| 108 | |
| 109 | /* attributes queriable with query() */ |
| 110 | enum { |
| 111 | NATIVE_WINDOW_WIDTH = 0, |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 112 | NATIVE_WINDOW_HEIGHT = 1, |
| 113 | NATIVE_WINDOW_FORMAT = 2, |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 114 | |
| 115 | /* The minimum number of buffers that must remain un-dequeued after a buffer |
| 116 | * has been queued. This value applies only if set_buffer_count was used to |
| 117 | * override the number of buffers and if a buffer has since been queued. |
| 118 | * Users of the set_buffer_count ANativeWindow method should query this |
| 119 | * value before calling set_buffer_count. If it is necessary to have N |
| 120 | * buffers simultaneously dequeued as part of the steady-state operation, |
| 121 | * and this query returns M then N+M buffers should be requested via |
| 122 | * native_window_set_buffer_count. |
| 123 | * |
| 124 | * Note that this value does NOT apply until a single buffer has been |
| 125 | * queued. In particular this means that it is possible to: |
| 126 | * |
| 127 | * 1. Query M = min undequeued buffers |
| 128 | * 2. Set the buffer count to N + M |
| 129 | * 3. Dequeue all N + M buffers |
| 130 | * 4. Cancel M buffers |
| 131 | * 5. Queue, dequeue, queue, dequeue, ad infinitum |
| 132 | */ |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 133 | NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS = 3, |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 134 | |
| 135 | /* Check whether queueBuffer operations on the ANativeWindow send the buffer |
| 136 | * to the window compositor. The query sets the returned 'value' argument |
| 137 | * to 1 if the ANativeWindow DOES send queued buffers directly to the window |
| 138 | * compositor and 0 if the buffers do not go directly to the window |
| 139 | * compositor. |
| 140 | * |
| 141 | * This can be used to determine whether protected buffer content should be |
| 142 | * sent to the ANativeWindow. Note, however, that a result of 1 does NOT |
| 143 | * indicate that queued buffers will be protected from applications or users |
| 144 | * capturing their contents. If that behavior is desired then some other |
| 145 | * mechanism (e.g. the GRALLOC_USAGE_PROTECTED flag) should be used in |
| 146 | * conjunction with this query. |
| 147 | */ |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 148 | NATIVE_WINDOW_QUEUES_TO_WINDOW_COMPOSER = 4, |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 149 | |
| 150 | /* Get the concrete type of a ANativeWindow. See below for the list of |
| 151 | * possible return values. |
| 152 | * |
| 153 | * This query should not be used outside the Android framework and will |
| 154 | * likely be removed in the near future. |
| 155 | */ |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 156 | NATIVE_WINDOW_CONCRETE_TYPE = 5, |
Mathias Agopian | 5100916 | 2011-07-19 15:59:15 -0700 | [diff] [blame] | 157 | |
| 158 | |
| 159 | /* |
| 160 | * Default width and height of the ANativeWindow, these are the dimensions |
| 161 | * of the window irrespective of the NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS |
| 162 | * call. |
| 163 | */ |
| 164 | NATIVE_WINDOW_DEFAULT_WIDTH = 6, |
| 165 | NATIVE_WINDOW_DEFAULT_HEIGHT = 7, |
| 166 | |
| 167 | /* |
| 168 | * transformation that will most-likely be applied to buffers. This is only |
| 169 | * a hint, the actual transformation applied might be different. |
| 170 | * |
| 171 | * INTENDED USE: |
| 172 | * |
| 173 | * The transform hint can be used by a producer, for instance the GLES |
| 174 | * driver, to pre-rotate the rendering such that the final transformation |
| 175 | * in the composer is identity. This can be very useful when used in |
| 176 | * conjunction with the h/w composer HAL, in situations where it |
| 177 | * cannot handle arbitrary rotations. |
| 178 | * |
| 179 | * 1. Before dequeuing a buffer, the GL driver (or any other ANW client) |
| 180 | * queries the ANW for NATIVE_WINDOW_TRANSFORM_HINT. |
| 181 | * |
| 182 | * 2. The GL driver overrides the width and height of the ANW to |
| 183 | * account for NATIVE_WINDOW_TRANSFORM_HINT. This is done by querying |
| 184 | * NATIVE_WINDOW_DEFAULT_{WIDTH | HEIGHT}, swapping the dimensions |
| 185 | * according to NATIVE_WINDOW_TRANSFORM_HINT and calling |
| 186 | * native_window_set_buffers_dimensions(). |
| 187 | * |
| 188 | * 3. The GL driver dequeues a buffer of the new pre-rotated size. |
| 189 | * |
| 190 | * 4. The GL driver renders to the buffer such that the image is |
| 191 | * already transformed, that is applying NATIVE_WINDOW_TRANSFORM_HINT |
| 192 | * to the rendering. |
| 193 | * |
| 194 | * 5. The GL driver calls native_window_set_transform to apply |
| 195 | * inverse transformation to the buffer it just rendered. |
| 196 | * In order to do this, the GL driver needs |
| 197 | * to calculate the inverse of NATIVE_WINDOW_TRANSFORM_HINT, this is |
| 198 | * done easily: |
| 199 | * |
| 200 | * int hintTransform, inverseTransform; |
| 201 | * query(..., NATIVE_WINDOW_TRANSFORM_HINT, &hintTransform); |
| 202 | * inverseTransform = hintTransform; |
| 203 | * if (hintTransform & HAL_TRANSFORM_ROT_90) |
| 204 | * inverseTransform ^= HAL_TRANSFORM_ROT_180; |
| 205 | * |
| 206 | * |
| 207 | * 6. The GL driver queues the pre-transformed buffer. |
| 208 | * |
| 209 | * 7. The composer combines the buffer transform with the display |
| 210 | * transform. If the buffer transform happens to cancel out the |
| 211 | * display transform then no rotation is needed. |
| 212 | * |
| 213 | */ |
| 214 | NATIVE_WINDOW_TRANSFORM_HINT = 8, |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 215 | }; |
| 216 | |
| 217 | /* valid operations for the (*perform)() hook */ |
| 218 | enum { |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 219 | NATIVE_WINDOW_SET_USAGE = 0, |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 220 | NATIVE_WINDOW_CONNECT = 1, /* deprecated */ |
| 221 | NATIVE_WINDOW_DISCONNECT = 2, /* deprecated */ |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 222 | NATIVE_WINDOW_SET_CROP = 3, |
| 223 | NATIVE_WINDOW_SET_BUFFER_COUNT = 4, |
| 224 | NATIVE_WINDOW_SET_BUFFERS_GEOMETRY = 5, /* deprecated */ |
| 225 | NATIVE_WINDOW_SET_BUFFERS_TRANSFORM = 6, |
| 226 | NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP = 7, |
| 227 | NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS = 8, |
| 228 | NATIVE_WINDOW_SET_BUFFERS_FORMAT = 9, |
Mathias Agopian | ae3736a | 2011-07-13 18:40:38 -0700 | [diff] [blame] | 229 | NATIVE_WINDOW_SET_SCALING_MODE = 10, |
| 230 | NATIVE_WINDOW_LOCK = 11, /* private */ |
| 231 | NATIVE_WINDOW_UNLOCK_AND_POST = 12, /* private */ |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 232 | NATIVE_WINDOW_API_CONNECT = 13, /* private */ |
| 233 | NATIVE_WINDOW_API_DISCONNECT = 14, /* private */ |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 234 | }; |
| 235 | |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 236 | /* parameter for NATIVE_WINDOW_[API_][DIS]CONNECT */ |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 237 | enum { |
Jamie Gennis | 5423e9e | 2011-07-12 13:53:42 -0700 | [diff] [blame] | 238 | /* Buffers will be queued by EGL via eglSwapBuffers after being filled using |
| 239 | * OpenGL ES. |
| 240 | */ |
| 241 | NATIVE_WINDOW_API_EGL = 1, |
| 242 | |
| 243 | /* Buffers will be queued after being filled using the CPU |
| 244 | */ |
| 245 | NATIVE_WINDOW_API_CPU = 2, |
| 246 | |
| 247 | /* Buffers will be queued by Stagefright after being filled by a video |
| 248 | * decoder. The video decoder can either be a software or hardware decoder. |
| 249 | */ |
| 250 | NATIVE_WINDOW_API_MEDIA = 3, |
| 251 | |
| 252 | /* Buffers will be queued by the the camera HAL. |
| 253 | */ |
| 254 | NATIVE_WINDOW_API_CAMERA = 4, |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 255 | }; |
| 256 | |
| 257 | /* parameter for NATIVE_WINDOW_SET_BUFFERS_TRANSFORM */ |
| 258 | enum { |
| 259 | /* flip source image horizontally */ |
| 260 | NATIVE_WINDOW_TRANSFORM_FLIP_H = HAL_TRANSFORM_FLIP_H , |
| 261 | /* flip source image vertically */ |
| 262 | NATIVE_WINDOW_TRANSFORM_FLIP_V = HAL_TRANSFORM_FLIP_V, |
| 263 | /* rotate source image 90 degrees clock-wise */ |
| 264 | NATIVE_WINDOW_TRANSFORM_ROT_90 = HAL_TRANSFORM_ROT_90, |
| 265 | /* rotate source image 180 degrees */ |
| 266 | NATIVE_WINDOW_TRANSFORM_ROT_180 = HAL_TRANSFORM_ROT_180, |
| 267 | /* rotate source image 270 degrees clock-wise */ |
| 268 | NATIVE_WINDOW_TRANSFORM_ROT_270 = HAL_TRANSFORM_ROT_270, |
| 269 | }; |
| 270 | |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 271 | /* parameter for NATIVE_WINDOW_SET_SCALING_MODE */ |
| 272 | enum { |
| 273 | /* the window content is not updated (frozen) until a buffer of |
| 274 | * the window size is received (enqueued) |
| 275 | */ |
| 276 | NATIVE_WINDOW_SCALING_MODE_FREEZE = 0, |
| 277 | /* the buffer is scaled in both dimensions to match the window size */ |
| 278 | NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW = 1, |
| 279 | }; |
| 280 | |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 281 | /* values returned by the NATIVE_WINDOW_CONCRETE_TYPE query */ |
| 282 | enum { |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 283 | NATIVE_WINDOW_FRAMEBUFFER = 0, /* FramebufferNativeWindow */ |
| 284 | NATIVE_WINDOW_SURFACE = 1, /* Surface */ |
| 285 | NATIVE_WINDOW_SURFACE_TEXTURE_CLIENT = 2, /* SurfaceTextureClient */ |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 286 | }; |
| 287 | |
| 288 | /* parameter for NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP |
| 289 | * |
| 290 | * Special timestamp value to indicate that timestamps should be auto-generated |
| 291 | * by the native window when queueBuffer is called. This is equal to INT64_MIN, |
| 292 | * defined directly to avoid problems with C99/C++ inclusion of stdint.h. |
| 293 | */ |
| 294 | static const int64_t NATIVE_WINDOW_TIMESTAMP_AUTO = (-9223372036854775807LL-1); |
| 295 | |
| 296 | struct ANativeWindow |
| 297 | { |
| 298 | #ifdef __cplusplus |
| 299 | ANativeWindow() |
| 300 | : flags(0), minSwapInterval(0), maxSwapInterval(0), xdpi(0), ydpi(0) |
| 301 | { |
| 302 | common.magic = ANDROID_NATIVE_WINDOW_MAGIC; |
| 303 | common.version = sizeof(ANativeWindow); |
| 304 | memset(common.reserved, 0, sizeof(common.reserved)); |
| 305 | } |
| 306 | |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 307 | /* Implement the methods that sp<ANativeWindow> expects so that it |
| 308 | can be used to automatically refcount ANativeWindow's. */ |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 309 | void incStrong(const void* id) const { |
| 310 | common.incRef(const_cast<android_native_base_t*>(&common)); |
| 311 | } |
| 312 | void decStrong(const void* id) const { |
| 313 | common.decRef(const_cast<android_native_base_t*>(&common)); |
| 314 | } |
| 315 | #endif |
| 316 | |
| 317 | struct android_native_base_t common; |
| 318 | |
| 319 | /* flags describing some attributes of this surface or its updater */ |
| 320 | const uint32_t flags; |
| 321 | |
| 322 | /* min swap interval supported by this updated */ |
| 323 | const int minSwapInterval; |
| 324 | |
| 325 | /* max swap interval supported by this updated */ |
| 326 | const int maxSwapInterval; |
| 327 | |
| 328 | /* horizontal and vertical resolution in DPI */ |
| 329 | const float xdpi; |
| 330 | const float ydpi; |
| 331 | |
| 332 | /* Some storage reserved for the OEM's driver. */ |
| 333 | intptr_t oem[4]; |
| 334 | |
| 335 | /* |
| 336 | * Set the swap interval for this surface. |
| 337 | * |
| 338 | * Returns 0 on success or -errno on error. |
| 339 | */ |
| 340 | int (*setSwapInterval)(struct ANativeWindow* window, |
| 341 | int interval); |
| 342 | |
| 343 | /* |
Jesse Hall | 7cd3e0a | 2011-12-12 10:32:55 -0800 | [diff] [blame] | 344 | * Hook called by EGL to acquire a buffer. After this call, the buffer |
| 345 | * is not locked, so its content cannot be modified. This call may block if |
| 346 | * no buffers are available. |
| 347 | * |
| 348 | * The window holds a reference to the buffer between dequeueBuffer and |
| 349 | * either queueBuffer or cancelBuffer, so clients only need their own |
| 350 | * reference if they might use the buffer after queueing or canceling it. |
| 351 | * Holding a reference to a buffer after queueing or canceling it is only |
| 352 | * allowed if a specific buffer count has been set. |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 353 | * |
| 354 | * Returns 0 on success or -errno on error. |
| 355 | */ |
| 356 | int (*dequeueBuffer)(struct ANativeWindow* window, |
| 357 | struct ANativeWindowBuffer** buffer); |
| 358 | |
| 359 | /* |
| 360 | * hook called by EGL to lock a buffer. This MUST be called before modifying |
| 361 | * the content of a buffer. The buffer must have been acquired with |
| 362 | * dequeueBuffer first. |
| 363 | * |
| 364 | * Returns 0 on success or -errno on error. |
| 365 | */ |
| 366 | int (*lockBuffer)(struct ANativeWindow* window, |
| 367 | struct ANativeWindowBuffer* buffer); |
Jesse Hall | 7cd3e0a | 2011-12-12 10:32:55 -0800 | [diff] [blame] | 368 | /* |
| 369 | * Hook called by EGL when modifications to the render buffer are done. |
| 370 | * This unlocks and post the buffer. |
| 371 | * |
| 372 | * The window holds a reference to the buffer between dequeueBuffer and |
| 373 | * either queueBuffer or cancelBuffer, so clients only need their own |
| 374 | * reference if they might use the buffer after queueing or canceling it. |
| 375 | * Holding a reference to a buffer after queueing or canceling it is only |
| 376 | * allowed if a specific buffer count has been set. |
| 377 | * |
| 378 | * Buffers MUST be queued in the same order than they were dequeued. |
| 379 | * |
| 380 | * Returns 0 on success or -errno on error. |
| 381 | */ |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 382 | int (*queueBuffer)(struct ANativeWindow* window, |
| 383 | struct ANativeWindowBuffer* buffer); |
| 384 | |
| 385 | /* |
| 386 | * hook used to retrieve information about the native window. |
| 387 | * |
| 388 | * Returns 0 on success or -errno on error. |
| 389 | */ |
| 390 | int (*query)(const struct ANativeWindow* window, |
| 391 | int what, int* value); |
| 392 | |
| 393 | /* |
| 394 | * hook used to perform various operations on the surface. |
| 395 | * (*perform)() is a generic mechanism to add functionality to |
| 396 | * ANativeWindow while keeping backward binary compatibility. |
| 397 | * |
| 398 | * DO NOT CALL THIS HOOK DIRECTLY. Instead, use the helper functions |
| 399 | * defined below. |
| 400 | * |
| 401 | * (*perform)() returns -ENOENT if the 'what' parameter is not supported |
| 402 | * by the surface's implementation. |
| 403 | * |
| 404 | * The valid operations are: |
| 405 | * NATIVE_WINDOW_SET_USAGE |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 406 | * NATIVE_WINDOW_CONNECT (deprecated) |
| 407 | * NATIVE_WINDOW_DISCONNECT (deprecated) |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 408 | * NATIVE_WINDOW_SET_CROP |
| 409 | * NATIVE_WINDOW_SET_BUFFER_COUNT |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 410 | * NATIVE_WINDOW_SET_BUFFERS_GEOMETRY (deprecated) |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 411 | * NATIVE_WINDOW_SET_BUFFERS_TRANSFORM |
| 412 | * NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP |
Jamie Gennis | 208ec5e | 2011-07-07 11:51:48 -0700 | [diff] [blame] | 413 | * NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS |
| 414 | * NATIVE_WINDOW_SET_BUFFERS_FORMAT |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 415 | * NATIVE_WINDOW_SET_SCALING_MODE |
Mathias Agopian | ae3736a | 2011-07-13 18:40:38 -0700 | [diff] [blame] | 416 | * NATIVE_WINDOW_LOCK (private) |
| 417 | * NATIVE_WINDOW_UNLOCK_AND_POST (private) |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 418 | * NATIVE_WINDOW_API_CONNECT (private) |
| 419 | * NATIVE_WINDOW_API_DISCONNECT (private) |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 420 | * |
| 421 | */ |
| 422 | |
| 423 | int (*perform)(struct ANativeWindow* window, |
| 424 | int operation, ... ); |
| 425 | |
| 426 | /* |
Jesse Hall | 7cd3e0a | 2011-12-12 10:32:55 -0800 | [diff] [blame] | 427 | * Hook used to cancel a buffer that has been dequeued. |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 428 | * No synchronization is performed between dequeue() and cancel(), so |
| 429 | * either external synchronization is needed, or these functions must be |
| 430 | * called from the same thread. |
Jesse Hall | 7cd3e0a | 2011-12-12 10:32:55 -0800 | [diff] [blame] | 431 | * |
| 432 | * The window holds a reference to the buffer between dequeueBuffer and |
| 433 | * either queueBuffer or cancelBuffer, so clients only need their own |
| 434 | * reference if they might use the buffer after queueing or canceling it. |
| 435 | * Holding a reference to a buffer after queueing or canceling it is only |
| 436 | * allowed if a specific buffer count has been set. |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 437 | */ |
| 438 | int (*cancelBuffer)(struct ANativeWindow* window, |
| 439 | struct ANativeWindowBuffer* buffer); |
| 440 | |
| 441 | |
| 442 | void* reserved_proc[2]; |
| 443 | }; |
| 444 | |
| 445 | /* Backwards compatibility: use ANativeWindow (struct ANativeWindow in C). |
| 446 | * android_native_window_t is deprecated. |
| 447 | */ |
| 448 | typedef struct ANativeWindow ANativeWindow; |
| 449 | typedef struct ANativeWindow android_native_window_t; |
| 450 | |
| 451 | /* |
| 452 | * native_window_set_usage(..., usage) |
| 453 | * Sets the intended usage flags for the next buffers |
| 454 | * acquired with (*lockBuffer)() and on. |
| 455 | * By default (if this function is never called), a usage of |
| 456 | * GRALLOC_USAGE_HW_RENDER | GRALLOC_USAGE_HW_TEXTURE |
| 457 | * is assumed. |
| 458 | * Calling this function will usually cause following buffers to be |
| 459 | * reallocated. |
| 460 | */ |
| 461 | |
| 462 | static inline int native_window_set_usage( |
| 463 | struct ANativeWindow* window, int usage) |
| 464 | { |
| 465 | return window->perform(window, NATIVE_WINDOW_SET_USAGE, usage); |
| 466 | } |
| 467 | |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 468 | /* deprecated. Always returns 0. Don't call. */ |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 469 | static inline int native_window_connect( |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 470 | struct ANativeWindow* window, int api) { |
Mathias Agopian | 319f4e2 | 2011-08-03 11:26:38 -0700 | [diff] [blame] | 471 | return 0; |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 472 | } |
| 473 | |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 474 | /* deprecated. Always returns 0. Don't call. */ |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 475 | static inline int native_window_disconnect( |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 476 | struct ANativeWindow* window, int api) { |
Mathias Agopian | 319f4e2 | 2011-08-03 11:26:38 -0700 | [diff] [blame] | 477 | return 0; |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 478 | } |
| 479 | |
| 480 | /* |
| 481 | * native_window_set_crop(..., crop) |
| 482 | * Sets which region of the next queued buffers needs to be considered. |
| 483 | * A buffer's crop region is scaled to match the surface's size. |
| 484 | * |
| 485 | * The specified crop region applies to all buffers queued after it is called. |
| 486 | * |
| 487 | * if 'crop' is NULL, subsequently queued buffers won't be cropped. |
| 488 | * |
| 489 | * An error is returned if for instance the crop region is invalid, |
| 490 | * out of the buffer's bound or if the window is invalid. |
| 491 | */ |
| 492 | static inline int native_window_set_crop( |
| 493 | struct ANativeWindow* window, |
| 494 | android_native_rect_t const * crop) |
| 495 | { |
| 496 | return window->perform(window, NATIVE_WINDOW_SET_CROP, crop); |
| 497 | } |
| 498 | |
| 499 | /* |
| 500 | * native_window_set_buffer_count(..., count) |
| 501 | * Sets the number of buffers associated with this native window. |
| 502 | */ |
| 503 | static inline int native_window_set_buffer_count( |
| 504 | struct ANativeWindow* window, |
| 505 | size_t bufferCount) |
| 506 | { |
| 507 | return window->perform(window, NATIVE_WINDOW_SET_BUFFER_COUNT, bufferCount); |
| 508 | } |
| 509 | |
| 510 | /* |
| 511 | * native_window_set_buffers_geometry(..., int w, int h, int format) |
Jamie Gennis | 208ec5e | 2011-07-07 11:51:48 -0700 | [diff] [blame] | 512 | * All buffers dequeued after this call will have the dimensions and format |
| 513 | * specified. A successful call to this function has the same effect as calling |
| 514 | * native_window_set_buffers_size and native_window_set_buffers_format. |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 515 | * |
Jamie Gennis | 208ec5e | 2011-07-07 11:51:48 -0700 | [diff] [blame] | 516 | * XXX: This function is deprecated. The native_window_set_buffers_dimensions |
| 517 | * and native_window_set_buffers_format functions should be used instead. |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 518 | */ |
| 519 | static inline int native_window_set_buffers_geometry( |
| 520 | struct ANativeWindow* window, |
| 521 | int w, int h, int format) |
| 522 | { |
| 523 | return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_GEOMETRY, |
| 524 | w, h, format); |
| 525 | } |
| 526 | |
| 527 | /* |
Jamie Gennis | 208ec5e | 2011-07-07 11:51:48 -0700 | [diff] [blame] | 528 | * native_window_set_buffers_dimensions(..., int w, int h) |
| 529 | * All buffers dequeued after this call will have the dimensions specified. |
| 530 | * In particular, all buffers will have a fixed-size, independent form the |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 531 | * native-window size. They will be scaled according to the scaling mode |
| 532 | * (see native_window_set_scaling_mode) upon window composition. |
Jamie Gennis | 208ec5e | 2011-07-07 11:51:48 -0700 | [diff] [blame] | 533 | * |
| 534 | * If w and h are 0, the normal behavior is restored. That is, dequeued buffers |
| 535 | * following this call will be sized to match the window's size. |
| 536 | * |
| 537 | * Calling this function will reset the window crop to a NULL value, which |
| 538 | * disables cropping of the buffers. |
| 539 | */ |
| 540 | static inline int native_window_set_buffers_dimensions( |
| 541 | struct ANativeWindow* window, |
| 542 | int w, int h) |
| 543 | { |
| 544 | return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS, |
| 545 | w, h); |
| 546 | } |
| 547 | |
| 548 | /* |
| 549 | * native_window_set_buffers_format(..., int format) |
| 550 | * All buffers dequeued after this call will have the format specified. |
| 551 | * |
| 552 | * If the specified format is 0, the default buffer format will be used. |
| 553 | */ |
| 554 | static inline int native_window_set_buffers_format( |
| 555 | struct ANativeWindow* window, |
| 556 | int format) |
| 557 | { |
| 558 | return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_FORMAT, format); |
| 559 | } |
| 560 | |
| 561 | /* |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 562 | * native_window_set_buffers_transform(..., int transform) |
| 563 | * All buffers queued after this call will be displayed transformed according |
| 564 | * to the transform parameter specified. |
| 565 | */ |
| 566 | static inline int native_window_set_buffers_transform( |
| 567 | struct ANativeWindow* window, |
| 568 | int transform) |
| 569 | { |
| 570 | return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_TRANSFORM, |
| 571 | transform); |
| 572 | } |
| 573 | |
| 574 | /* |
| 575 | * native_window_set_buffers_timestamp(..., int64_t timestamp) |
| 576 | * All buffers queued after this call will be associated with the timestamp |
| 577 | * parameter specified. If the timestamp is set to NATIVE_WINDOW_TIMESTAMP_AUTO |
| 578 | * (the default), timestamps will be generated automatically when queueBuffer is |
Glenn Kasten | c322f67 | 2011-06-27 10:42:39 -0700 | [diff] [blame] | 579 | * called. The timestamp is measured in nanoseconds, and is normally monotonically |
| 580 | * increasing. The timestamp should be unaffected by time-of-day adjustments, |
| 581 | * and for a camera should be strictly monotonic but for a media player may be |
| 582 | * reset when the position is set. |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 583 | */ |
| 584 | static inline int native_window_set_buffers_timestamp( |
| 585 | struct ANativeWindow* window, |
| 586 | int64_t timestamp) |
| 587 | { |
| 588 | return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP, |
| 589 | timestamp); |
| 590 | } |
| 591 | |
Mathias Agopian | 42cc1ed | 2011-07-13 15:49:58 -0700 | [diff] [blame] | 592 | /* |
| 593 | * native_window_set_scaling_mode(..., int mode) |
| 594 | * All buffers queued after this call will be associated with the scaling mode |
| 595 | * specified. |
| 596 | */ |
| 597 | static inline int native_window_set_scaling_mode( |
| 598 | struct ANativeWindow* window, |
| 599 | int mode) |
| 600 | { |
| 601 | return window->perform(window, NATIVE_WINDOW_SET_SCALING_MODE, |
| 602 | mode); |
| 603 | } |
| 604 | |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 605 | |
| 606 | /* |
| 607 | * native_window_api_connect(..., int api) |
| 608 | * connects an API to this window. only one API can be connected at a time. |
| 609 | * Returns -EINVAL if for some reason the window cannot be connected, which |
| 610 | * can happen if it's connected to some other API. |
| 611 | */ |
| 612 | static inline int native_window_api_connect( |
| 613 | struct ANativeWindow* window, int api) |
| 614 | { |
Mathias Agopian | 319f4e2 | 2011-08-03 11:26:38 -0700 | [diff] [blame] | 615 | return window->perform(window, NATIVE_WINDOW_API_CONNECT, api); |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 616 | } |
| 617 | |
| 618 | /* |
| 619 | * native_window_api_disconnect(..., int api) |
| 620 | * disconnect the API from this window. |
| 621 | * An error is returned if for instance the window wasn't connected in the |
| 622 | * first place. |
| 623 | */ |
| 624 | static inline int native_window_api_disconnect( |
| 625 | struct ANativeWindow* window, int api) |
| 626 | { |
Mathias Agopian | 319f4e2 | 2011-08-03 11:26:38 -0700 | [diff] [blame] | 627 | return window->perform(window, NATIVE_WINDOW_API_DISCONNECT, api); |
Mathias Agopian | 8ad5452 | 2011-07-29 17:52:36 -0700 | [diff] [blame] | 628 | } |
| 629 | |
| 630 | |
Iliyan Malchev | 0ab886b | 2011-05-01 14:07:43 -0700 | [diff] [blame] | 631 | __END_DECLS |
| 632 | |
tedbo | 1ffdb38 | 2011-05-24 00:55:33 -0700 | [diff] [blame] | 633 | #endif /* SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H */ |