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