blob: 8e00bcdb6e284d2e16b504fde4bde520d745e577 [file] [log] [blame]
Iliyan Malchev0ab886b2011-05-01 14:07:43 -07001/*
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 Agopianc958a7f2012-02-25 21:13:36 -080021#include <string.h>
Iliyan Malchev0ab886b2011-05-01 14:07:43 -070022#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
41typedef const native_handle_t* buffer_handle_t;
42
43// ---------------------------------------------------------------------------
44
45typedef 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
55typedef 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
70typedef 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.
105typedef ANativeWindowBuffer_t android_native_buffer_t;
106
107// ---------------------------------------------------------------------------
108
109/* attributes queriable with query() */
110enum {
111 NATIVE_WINDOW_WIDTH = 0,
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700112 NATIVE_WINDOW_HEIGHT = 1,
113 NATIVE_WINDOW_FORMAT = 2,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700114
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 Agopian42cc1ed2011-07-13 15:49:58 -0700133 NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS = 3,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700134
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 Agopian42cc1ed2011-07-13 15:49:58 -0700148 NATIVE_WINDOW_QUEUES_TO_WINDOW_COMPOSER = 4,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700149
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 Agopian42cc1ed2011-07-13 15:49:58 -0700156 NATIVE_WINDOW_CONCRETE_TYPE = 5,
Mathias Agopian51009162011-07-19 15:59:15 -0700157
158
159 /*
Michael I. Goldafcdef62012-04-09 18:21:13 -0700160 * Default width and height of ANativeWindow buffers, these are the
161 * dimensions of the window buffers irrespective of the
162 * NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS call and match the native window
Jamie Gennisaa3f4c32012-04-17 19:37:48 -0700163 * size unless overridden by NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS.
Mathias Agopian51009162011-07-19 15:59:15 -0700164 */
165 NATIVE_WINDOW_DEFAULT_WIDTH = 6,
166 NATIVE_WINDOW_DEFAULT_HEIGHT = 7,
167
168 /*
169 * transformation that will most-likely be applied to buffers. This is only
170 * a hint, the actual transformation applied might be different.
171 *
172 * INTENDED USE:
173 *
174 * The transform hint can be used by a producer, for instance the GLES
175 * driver, to pre-rotate the rendering such that the final transformation
176 * in the composer is identity. This can be very useful when used in
177 * conjunction with the h/w composer HAL, in situations where it
178 * cannot handle arbitrary rotations.
179 *
180 * 1. Before dequeuing a buffer, the GL driver (or any other ANW client)
181 * queries the ANW for NATIVE_WINDOW_TRANSFORM_HINT.
182 *
183 * 2. The GL driver overrides the width and height of the ANW to
184 * account for NATIVE_WINDOW_TRANSFORM_HINT. This is done by querying
185 * NATIVE_WINDOW_DEFAULT_{WIDTH | HEIGHT}, swapping the dimensions
186 * according to NATIVE_WINDOW_TRANSFORM_HINT and calling
187 * native_window_set_buffers_dimensions().
188 *
189 * 3. The GL driver dequeues a buffer of the new pre-rotated size.
190 *
191 * 4. The GL driver renders to the buffer such that the image is
192 * already transformed, that is applying NATIVE_WINDOW_TRANSFORM_HINT
193 * to the rendering.
194 *
195 * 5. The GL driver calls native_window_set_transform to apply
196 * inverse transformation to the buffer it just rendered.
197 * In order to do this, the GL driver needs
198 * to calculate the inverse of NATIVE_WINDOW_TRANSFORM_HINT, this is
199 * done easily:
200 *
201 * int hintTransform, inverseTransform;
202 * query(..., NATIVE_WINDOW_TRANSFORM_HINT, &hintTransform);
203 * inverseTransform = hintTransform;
204 * if (hintTransform & HAL_TRANSFORM_ROT_90)
205 * inverseTransform ^= HAL_TRANSFORM_ROT_180;
206 *
207 *
208 * 6. The GL driver queues the pre-transformed buffer.
209 *
210 * 7. The composer combines the buffer transform with the display
211 * transform. If the buffer transform happens to cancel out the
212 * display transform then no rotation is needed.
213 *
214 */
215 NATIVE_WINDOW_TRANSFORM_HINT = 8,
Jamie Gennisaa3f4c32012-04-17 19:37:48 -0700216
217 /*
218 * Boolean that indicates whether the consumer is running more than
219 * one buffer behind the producer.
220 */
221 NATIVE_WINDOW_CONSUMER_RUNNING_BEHIND = 9
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700222};
223
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700224/* Valid operations for the (*perform)() hook.
225 *
226 * Values marked as 'deprecated' are supported, but have been superceded by
227 * other functionality.
228 *
229 * Values marked as 'private' should be considered private to the framework.
230 * HAL implementation code with access to an ANativeWindow should not use these,
231 * as it may not interact properly with the framework's use of the
232 * ANativeWindow.
233 */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700234enum {
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700235 NATIVE_WINDOW_SET_USAGE = 0,
Mathias Agopian8ad54522011-07-29 17:52:36 -0700236 NATIVE_WINDOW_CONNECT = 1, /* deprecated */
237 NATIVE_WINDOW_DISCONNECT = 2, /* deprecated */
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700238 NATIVE_WINDOW_SET_CROP = 3, /* private */
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700239 NATIVE_WINDOW_SET_BUFFER_COUNT = 4,
240 NATIVE_WINDOW_SET_BUFFERS_GEOMETRY = 5, /* deprecated */
241 NATIVE_WINDOW_SET_BUFFERS_TRANSFORM = 6,
242 NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP = 7,
243 NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS = 8,
244 NATIVE_WINDOW_SET_BUFFERS_FORMAT = 9,
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700245 NATIVE_WINDOW_SET_SCALING_MODE = 10, /* private */
Mathias Agopianae3736a2011-07-13 18:40:38 -0700246 NATIVE_WINDOW_LOCK = 11, /* private */
247 NATIVE_WINDOW_UNLOCK_AND_POST = 12, /* private */
Mathias Agopian8ad54522011-07-29 17:52:36 -0700248 NATIVE_WINDOW_API_CONNECT = 13, /* private */
249 NATIVE_WINDOW_API_DISCONNECT = 14, /* private */
Michael I. Goldafcdef62012-04-09 18:21:13 -0700250 NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS = 15, /* private */
Jamie Gennisd21113a2012-05-03 14:21:24 -0700251 NATIVE_WINDOW_SET_POST_TRANSFORM_CROP = 16, /* private */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700252};
253
Mathias Agopian8ad54522011-07-29 17:52:36 -0700254/* parameter for NATIVE_WINDOW_[API_][DIS]CONNECT */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700255enum {
Jamie Gennis5423e9e2011-07-12 13:53:42 -0700256 /* Buffers will be queued by EGL via eglSwapBuffers after being filled using
257 * OpenGL ES.
258 */
259 NATIVE_WINDOW_API_EGL = 1,
260
261 /* Buffers will be queued after being filled using the CPU
262 */
263 NATIVE_WINDOW_API_CPU = 2,
264
265 /* Buffers will be queued by Stagefright after being filled by a video
266 * decoder. The video decoder can either be a software or hardware decoder.
267 */
268 NATIVE_WINDOW_API_MEDIA = 3,
269
270 /* Buffers will be queued by the the camera HAL.
271 */
272 NATIVE_WINDOW_API_CAMERA = 4,
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700273};
274
275/* parameter for NATIVE_WINDOW_SET_BUFFERS_TRANSFORM */
276enum {
277 /* flip source image horizontally */
278 NATIVE_WINDOW_TRANSFORM_FLIP_H = HAL_TRANSFORM_FLIP_H ,
279 /* flip source image vertically */
280 NATIVE_WINDOW_TRANSFORM_FLIP_V = HAL_TRANSFORM_FLIP_V,
281 /* rotate source image 90 degrees clock-wise */
282 NATIVE_WINDOW_TRANSFORM_ROT_90 = HAL_TRANSFORM_ROT_90,
283 /* rotate source image 180 degrees */
284 NATIVE_WINDOW_TRANSFORM_ROT_180 = HAL_TRANSFORM_ROT_180,
285 /* rotate source image 270 degrees clock-wise */
286 NATIVE_WINDOW_TRANSFORM_ROT_270 = HAL_TRANSFORM_ROT_270,
287};
288
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700289/* parameter for NATIVE_WINDOW_SET_SCALING_MODE */
290enum {
291 /* the window content is not updated (frozen) until a buffer of
292 * the window size is received (enqueued)
293 */
294 NATIVE_WINDOW_SCALING_MODE_FREEZE = 0,
295 /* the buffer is scaled in both dimensions to match the window size */
296 NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW = 1,
Daniel Lam29392a42012-04-11 18:19:46 -0700297 /* the buffer is scaled uniformly such that the smaller dimension
298 * of the buffer matches the window size (cropping in the process)
299 */
300 NATIVE_WINDOW_SCALING_MODE_SCALE_CROP = 2,
Jamie Gennisd21113a2012-05-03 14:21:24 -0700301 /* the window is clipped to the size of the buffer's crop rectangle; pixels
302 * outside the crop rectangle are treated as if they are completely
303 * transparent.
304 */
305 NATIVE_WINDOW_SCALING_MODE_NO_SCALE_CROP = 3,
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700306};
307
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700308/* values returned by the NATIVE_WINDOW_CONCRETE_TYPE query */
309enum {
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700310 NATIVE_WINDOW_FRAMEBUFFER = 0, /* FramebufferNativeWindow */
311 NATIVE_WINDOW_SURFACE = 1, /* Surface */
312 NATIVE_WINDOW_SURFACE_TEXTURE_CLIENT = 2, /* SurfaceTextureClient */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700313};
314
315/* parameter for NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
316 *
317 * Special timestamp value to indicate that timestamps should be auto-generated
318 * by the native window when queueBuffer is called. This is equal to INT64_MIN,
319 * defined directly to avoid problems with C99/C++ inclusion of stdint.h.
320 */
321static const int64_t NATIVE_WINDOW_TIMESTAMP_AUTO = (-9223372036854775807LL-1);
322
323struct ANativeWindow
324{
325#ifdef __cplusplus
326 ANativeWindow()
327 : flags(0), minSwapInterval(0), maxSwapInterval(0), xdpi(0), ydpi(0)
328 {
329 common.magic = ANDROID_NATIVE_WINDOW_MAGIC;
330 common.version = sizeof(ANativeWindow);
331 memset(common.reserved, 0, sizeof(common.reserved));
332 }
333
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700334 /* Implement the methods that sp<ANativeWindow> expects so that it
335 can be used to automatically refcount ANativeWindow's. */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700336 void incStrong(const void* id) const {
337 common.incRef(const_cast<android_native_base_t*>(&common));
338 }
339 void decStrong(const void* id) const {
340 common.decRef(const_cast<android_native_base_t*>(&common));
341 }
342#endif
343
344 struct android_native_base_t common;
345
346 /* flags describing some attributes of this surface or its updater */
347 const uint32_t flags;
348
349 /* min swap interval supported by this updated */
350 const int minSwapInterval;
351
352 /* max swap interval supported by this updated */
353 const int maxSwapInterval;
354
355 /* horizontal and vertical resolution in DPI */
356 const float xdpi;
357 const float ydpi;
358
359 /* Some storage reserved for the OEM's driver. */
360 intptr_t oem[4];
361
362 /*
363 * Set the swap interval for this surface.
364 *
365 * Returns 0 on success or -errno on error.
366 */
367 int (*setSwapInterval)(struct ANativeWindow* window,
368 int interval);
369
370 /*
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800371 * Hook called by EGL to acquire a buffer. After this call, the buffer
372 * is not locked, so its content cannot be modified. This call may block if
373 * no buffers are available.
374 *
375 * The window holds a reference to the buffer between dequeueBuffer and
376 * either queueBuffer or cancelBuffer, so clients only need their own
377 * reference if they might use the buffer after queueing or canceling it.
378 * Holding a reference to a buffer after queueing or canceling it is only
379 * allowed if a specific buffer count has been set.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700380 *
381 * Returns 0 on success or -errno on error.
382 */
383 int (*dequeueBuffer)(struct ANativeWindow* window,
384 struct ANativeWindowBuffer** buffer);
385
386 /*
387 * hook called by EGL to lock a buffer. This MUST be called before modifying
388 * the content of a buffer. The buffer must have been acquired with
389 * dequeueBuffer first.
390 *
391 * Returns 0 on success or -errno on error.
392 */
393 int (*lockBuffer)(struct ANativeWindow* window,
394 struct ANativeWindowBuffer* buffer);
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800395 /*
396 * Hook called by EGL when modifications to the render buffer are done.
397 * This unlocks and post the buffer.
398 *
399 * The window holds a reference to the buffer between dequeueBuffer and
400 * either queueBuffer or cancelBuffer, so clients only need their own
401 * reference if they might use the buffer after queueing or canceling it.
402 * Holding a reference to a buffer after queueing or canceling it is only
403 * allowed if a specific buffer count has been set.
404 *
405 * Buffers MUST be queued in the same order than they were dequeued.
406 *
407 * Returns 0 on success or -errno on error.
408 */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700409 int (*queueBuffer)(struct ANativeWindow* window,
410 struct ANativeWindowBuffer* buffer);
411
412 /*
413 * hook used to retrieve information about the native window.
414 *
415 * Returns 0 on success or -errno on error.
416 */
417 int (*query)(const struct ANativeWindow* window,
418 int what, int* value);
419
420 /*
421 * hook used to perform various operations on the surface.
422 * (*perform)() is a generic mechanism to add functionality to
423 * ANativeWindow while keeping backward binary compatibility.
424 *
425 * DO NOT CALL THIS HOOK DIRECTLY. Instead, use the helper functions
426 * defined below.
427 *
428 * (*perform)() returns -ENOENT if the 'what' parameter is not supported
429 * by the surface's implementation.
430 *
431 * The valid operations are:
432 * NATIVE_WINDOW_SET_USAGE
Mathias Agopian8ad54522011-07-29 17:52:36 -0700433 * NATIVE_WINDOW_CONNECT (deprecated)
434 * NATIVE_WINDOW_DISCONNECT (deprecated)
Jamie Gennis190b6e22012-04-30 16:32:06 -0700435 * NATIVE_WINDOW_SET_CROP (private)
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700436 * NATIVE_WINDOW_SET_BUFFER_COUNT
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700437 * NATIVE_WINDOW_SET_BUFFERS_GEOMETRY (deprecated)
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700438 * NATIVE_WINDOW_SET_BUFFERS_TRANSFORM
439 * NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700440 * NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS
441 * NATIVE_WINDOW_SET_BUFFERS_FORMAT
Jamie Gennis190b6e22012-04-30 16:32:06 -0700442 * NATIVE_WINDOW_SET_SCALING_MODE (private)
Mathias Agopianae3736a2011-07-13 18:40:38 -0700443 * NATIVE_WINDOW_LOCK (private)
444 * NATIVE_WINDOW_UNLOCK_AND_POST (private)
Mathias Agopian8ad54522011-07-29 17:52:36 -0700445 * NATIVE_WINDOW_API_CONNECT (private)
446 * NATIVE_WINDOW_API_DISCONNECT (private)
Michael I. Goldafcdef62012-04-09 18:21:13 -0700447 * NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS (private)
Jamie Gennisd21113a2012-05-03 14:21:24 -0700448 * NATIVE_WINDOW_SET_POST_TRANSFORM_CROP (private)
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700449 *
450 */
451
452 int (*perform)(struct ANativeWindow* window,
453 int operation, ... );
454
455 /*
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800456 * Hook used to cancel a buffer that has been dequeued.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700457 * No synchronization is performed between dequeue() and cancel(), so
458 * either external synchronization is needed, or these functions must be
459 * called from the same thread.
Jesse Hall7cd3e0a2011-12-12 10:32:55 -0800460 *
461 * The window holds a reference to the buffer between dequeueBuffer and
462 * either queueBuffer or cancelBuffer, so clients only need their own
463 * reference if they might use the buffer after queueing or canceling it.
464 * Holding a reference to a buffer after queueing or canceling it is only
465 * allowed if a specific buffer count has been set.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700466 */
467 int (*cancelBuffer)(struct ANativeWindow* window,
468 struct ANativeWindowBuffer* buffer);
469
470
471 void* reserved_proc[2];
472};
473
474 /* Backwards compatibility: use ANativeWindow (struct ANativeWindow in C).
475 * android_native_window_t is deprecated.
476 */
477typedef struct ANativeWindow ANativeWindow;
478typedef struct ANativeWindow android_native_window_t;
479
480/*
481 * native_window_set_usage(..., usage)
482 * Sets the intended usage flags for the next buffers
483 * acquired with (*lockBuffer)() and on.
484 * By default (if this function is never called), a usage of
485 * GRALLOC_USAGE_HW_RENDER | GRALLOC_USAGE_HW_TEXTURE
486 * is assumed.
487 * Calling this function will usually cause following buffers to be
488 * reallocated.
489 */
490
491static inline int native_window_set_usage(
492 struct ANativeWindow* window, int usage)
493{
494 return window->perform(window, NATIVE_WINDOW_SET_USAGE, usage);
495}
496
Mathias Agopian8ad54522011-07-29 17:52:36 -0700497/* deprecated. Always returns 0. Don't call. */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700498static inline int native_window_connect(
Mathias Agopian8ad54522011-07-29 17:52:36 -0700499 struct ANativeWindow* window, int api) {
Mathias Agopian319f4e22011-08-03 11:26:38 -0700500 return 0;
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700501}
502
Mathias Agopian8ad54522011-07-29 17:52:36 -0700503/* deprecated. Always returns 0. Don't call. */
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700504static inline int native_window_disconnect(
Mathias Agopian8ad54522011-07-29 17:52:36 -0700505 struct ANativeWindow* window, int api) {
Mathias Agopian319f4e22011-08-03 11:26:38 -0700506 return 0;
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700507}
508
509/*
510 * native_window_set_crop(..., crop)
511 * Sets which region of the next queued buffers needs to be considered.
Jamie Gennisd21113a2012-05-03 14:21:24 -0700512 * Depending on the scaling mode, a buffer's crop region is scaled and/or
513 * cropped to match the surface's size. This function sets the crop in
514 * pre-transformed buffer pixel coordinates.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700515 *
516 * The specified crop region applies to all buffers queued after it is called.
517 *
Jamie Gennisd21113a2012-05-03 14:21:24 -0700518 * If 'crop' is NULL, subsequently queued buffers won't be cropped.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700519 *
Jamie Gennisd21113a2012-05-03 14:21:24 -0700520 * An error is returned if for instance the crop region is invalid, out of the
521 * buffer's bound or if the window is invalid.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700522 */
523static inline int native_window_set_crop(
524 struct ANativeWindow* window,
525 android_native_rect_t const * crop)
526{
527 return window->perform(window, NATIVE_WINDOW_SET_CROP, crop);
528}
529
530/*
Jamie Gennisd21113a2012-05-03 14:21:24 -0700531 * native_window_set_post_transform_crop(..., crop)
532 * Sets which region of the next queued buffers needs to be considered.
533 * Depending on the scaling mode, a buffer's crop region is scaled and/or
534 * cropped to match the surface's size. This function sets the crop in
535 * post-transformed pixel coordinates.
536 *
537 * The specified crop region applies to all buffers queued after it is called.
538 *
539 * If 'crop' is NULL, subsequently queued buffers won't be cropped.
540 *
541 * An error is returned if for instance the crop region is invalid, out of the
542 * buffer's bound or if the window is invalid.
543 */
544static inline int native_window_set_post_transform_crop(
545 struct ANativeWindow* window,
546 android_native_rect_t const * crop)
547{
548 return window->perform(window, NATIVE_WINDOW_SET_POST_TRANSFORM_CROP, crop);
549}
550
551/*
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700552 * native_window_set_active_rect(..., active_rect)
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700553 *
Jamie Gennisd21113a2012-05-03 14:21:24 -0700554 * This function is deprectated and will be removed soon. For now it simply
555 * sets the post-transform crop for compatibility while multi-project commits
556 * get checked.
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700557 */
558static inline int native_window_set_active_rect(
559 struct ANativeWindow* window,
560 android_native_rect_t const * active_rect)
561{
Jamie Gennisd21113a2012-05-03 14:21:24 -0700562 return native_window_set_post_transform_crop(window, active_rect);
Jamie Gennisfb1ee572012-04-17 19:37:48 -0700563}
564
565/*
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700566 * native_window_set_buffer_count(..., count)
567 * Sets the number of buffers associated with this native window.
568 */
569static inline int native_window_set_buffer_count(
570 struct ANativeWindow* window,
571 size_t bufferCount)
572{
573 return window->perform(window, NATIVE_WINDOW_SET_BUFFER_COUNT, bufferCount);
574}
575
576/*
577 * native_window_set_buffers_geometry(..., int w, int h, int format)
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700578 * All buffers dequeued after this call will have the dimensions and format
579 * specified. A successful call to this function has the same effect as calling
580 * native_window_set_buffers_size and native_window_set_buffers_format.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700581 *
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700582 * XXX: This function is deprecated. The native_window_set_buffers_dimensions
583 * and native_window_set_buffers_format functions should be used instead.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700584 */
585static inline int native_window_set_buffers_geometry(
586 struct ANativeWindow* window,
587 int w, int h, int format)
588{
589 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_GEOMETRY,
590 w, h, format);
591}
592
593/*
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700594 * native_window_set_buffers_dimensions(..., int w, int h)
595 * All buffers dequeued after this call will have the dimensions specified.
Michael I. Goldafcdef62012-04-09 18:21:13 -0700596 * In particular, all buffers will have a fixed-size, independent from the
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700597 * native-window size. They will be scaled according to the scaling mode
598 * (see native_window_set_scaling_mode) upon window composition.
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700599 *
600 * If w and h are 0, the normal behavior is restored. That is, dequeued buffers
601 * following this call will be sized to match the window's size.
602 *
603 * Calling this function will reset the window crop to a NULL value, which
604 * disables cropping of the buffers.
605 */
606static inline int native_window_set_buffers_dimensions(
607 struct ANativeWindow* window,
608 int w, int h)
609{
610 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS,
611 w, h);
612}
613
614/*
Michael I. Goldafcdef62012-04-09 18:21:13 -0700615 * native_window_set_buffers_user_dimensions(..., int w, int h)
616 *
617 * Sets the user buffer size for the window, which overrides the
618 * window's size. All buffers dequeued after this call will have the
619 * dimensions specified unless overridden by
620 * native_window_set_buffers_dimensions. All buffers will have a
621 * fixed-size, independent from the native-window size. They will be
622 * scaled according to the scaling mode (see
623 * native_window_set_scaling_mode) upon window composition.
624 *
625 * If w and h are 0, the normal behavior is restored. That is, the
626 * default buffer size will match the windows's size.
627 *
628 * Calling this function will reset the window crop to a NULL value, which
629 * disables cropping of the buffers.
630 */
631static inline int native_window_set_buffers_user_dimensions(
632 struct ANativeWindow* window,
633 int w, int h)
634{
635 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS,
636 w, h);
637}
638
639/*
Jamie Gennis208ec5e2011-07-07 11:51:48 -0700640 * native_window_set_buffers_format(..., int format)
641 * All buffers dequeued after this call will have the format specified.
642 *
643 * If the specified format is 0, the default buffer format will be used.
644 */
645static inline int native_window_set_buffers_format(
646 struct ANativeWindow* window,
647 int format)
648{
649 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_FORMAT, format);
650}
651
652/*
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700653 * native_window_set_buffers_transform(..., int transform)
654 * All buffers queued after this call will be displayed transformed according
655 * to the transform parameter specified.
656 */
657static inline int native_window_set_buffers_transform(
658 struct ANativeWindow* window,
659 int transform)
660{
661 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_TRANSFORM,
662 transform);
663}
664
665/*
666 * native_window_set_buffers_timestamp(..., int64_t timestamp)
667 * All buffers queued after this call will be associated with the timestamp
668 * parameter specified. If the timestamp is set to NATIVE_WINDOW_TIMESTAMP_AUTO
669 * (the default), timestamps will be generated automatically when queueBuffer is
Glenn Kastenc322f672011-06-27 10:42:39 -0700670 * called. The timestamp is measured in nanoseconds, and is normally monotonically
671 * increasing. The timestamp should be unaffected by time-of-day adjustments,
672 * and for a camera should be strictly monotonic but for a media player may be
673 * reset when the position is set.
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700674 */
675static inline int native_window_set_buffers_timestamp(
676 struct ANativeWindow* window,
677 int64_t timestamp)
678{
679 return window->perform(window, NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP,
680 timestamp);
681}
682
Mathias Agopian42cc1ed2011-07-13 15:49:58 -0700683/*
684 * native_window_set_scaling_mode(..., int mode)
685 * All buffers queued after this call will be associated with the scaling mode
686 * specified.
687 */
688static inline int native_window_set_scaling_mode(
689 struct ANativeWindow* window,
690 int mode)
691{
692 return window->perform(window, NATIVE_WINDOW_SET_SCALING_MODE,
693 mode);
694}
695
Mathias Agopian8ad54522011-07-29 17:52:36 -0700696/*
697 * native_window_api_connect(..., int api)
698 * connects an API to this window. only one API can be connected at a time.
699 * Returns -EINVAL if for some reason the window cannot be connected, which
700 * can happen if it's connected to some other API.
701 */
702static inline int native_window_api_connect(
703 struct ANativeWindow* window, int api)
704{
Mathias Agopian319f4e22011-08-03 11:26:38 -0700705 return window->perform(window, NATIVE_WINDOW_API_CONNECT, api);
Mathias Agopian8ad54522011-07-29 17:52:36 -0700706}
707
708/*
709 * native_window_api_disconnect(..., int api)
710 * disconnect the API from this window.
711 * An error is returned if for instance the window wasn't connected in the
712 * first place.
713 */
714static inline int native_window_api_disconnect(
715 struct ANativeWindow* window, int api)
716{
Mathias Agopian319f4e22011-08-03 11:26:38 -0700717 return window->perform(window, NATIVE_WINDOW_API_DISCONNECT, api);
Mathias Agopian8ad54522011-07-29 17:52:36 -0700718}
719
720
Iliyan Malchev0ab886b2011-05-01 14:07:43 -0700721__END_DECLS
722
tedbo1ffdb382011-05-24 00:55:33 -0700723#endif /* SYSTEM_CORE_INCLUDE_ANDROID_WINDOW_H */