istereo2

annotate src/android/android_native_app_glue.h @ 23:7d795dade0bc

find changesets by author, revision, files, or words in the commit message
first pass at android port... compiles!
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 03 Oct 2015 06:10:30 +0300
parents
children
rev   line source
nuclear@23 1 /*
nuclear@23 2 * Copyright (C) 2010 The Android Open Source Project
nuclear@23 3 *
nuclear@23 4 * Licensed under the Apache License, Version 2.0 (the "License");
nuclear@23 5 * you may not use this file except in compliance with the License.
nuclear@23 6 * You may obtain a copy of the License at
nuclear@23 7 *
nuclear@23 8 * http://www.apache.org/licenses/LICENSE-2.0
nuclear@23 9 *
nuclear@23 10 * Unless required by applicable law or agreed to in writing, software
nuclear@23 11 * distributed under the License is distributed on an "AS IS" BASIS,
nuclear@23 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
nuclear@23 13 * See the License for the specific language governing permissions and
nuclear@23 14 * limitations under the License.
nuclear@23 15 *
nuclear@23 16 */
nuclear@23 17
nuclear@23 18 #ifndef _ANDROID_NATIVE_APP_GLUE_H
nuclear@23 19 #define _ANDROID_NATIVE_APP_GLUE_H
nuclear@23 20
nuclear@23 21 #include <poll.h>
nuclear@23 22 #include <pthread.h>
nuclear@23 23 #include <sched.h>
nuclear@23 24
nuclear@23 25 #include <android/configuration.h>
nuclear@23 26 #include <android/looper.h>
nuclear@23 27 #include <android/native_activity.h>
nuclear@23 28
nuclear@23 29 #ifdef __cplusplus
nuclear@23 30 extern "C" {
nuclear@23 31 #endif
nuclear@23 32
nuclear@23 33 /**
nuclear@23 34 * The native activity interface provided by <android/native_activity.h>
nuclear@23 35 * is based on a set of application-provided callbacks that will be called
nuclear@23 36 * by the Activity's main thread when certain events occur.
nuclear@23 37 *
nuclear@23 38 * This means that each one of this callbacks _should_ _not_ block, or they
nuclear@23 39 * risk having the system force-close the application. This programming
nuclear@23 40 * model is direct, lightweight, but constraining.
nuclear@23 41 *
nuclear@23 42 * The 'android_native_app_glue' static library is used to provide a different
nuclear@23 43 * execution model where the application can implement its own main event
nuclear@23 44 * loop in a different thread instead. Here's how it works:
nuclear@23 45 *
nuclear@23 46 * 1/ The application must provide a function named "android_main()" that
nuclear@23 47 * will be called when the activity is created, in a new thread that is
nuclear@23 48 * distinct from the activity's main thread.
nuclear@23 49 *
nuclear@23 50 * 2/ android_main() receives a pointer to a valid "android_app" structure
nuclear@23 51 * that contains references to other important objects, e.g. the
nuclear@23 52 * ANativeActivity obejct instance the application is running in.
nuclear@23 53 *
nuclear@23 54 * 3/ the "android_app" object holds an ALooper instance that already
nuclear@23 55 * listens to two important things:
nuclear@23 56 *
nuclear@23 57 * - activity lifecycle events (e.g. "pause", "resume"). See APP_CMD_XXX
nuclear@23 58 * declarations below.
nuclear@23 59 *
nuclear@23 60 * - input events coming from the AInputQueue attached to the activity.
nuclear@23 61 *
nuclear@23 62 * Each of these correspond to an ALooper identifier returned by
nuclear@23 63 * ALooper_pollOnce with values of LOOPER_ID_MAIN and LOOPER_ID_INPUT,
nuclear@23 64 * respectively.
nuclear@23 65 *
nuclear@23 66 * Your application can use the same ALooper to listen to additional
nuclear@23 67 * file-descriptors. They can either be callback based, or with return
nuclear@23 68 * identifiers starting with LOOPER_ID_USER.
nuclear@23 69 *
nuclear@23 70 * 4/ Whenever you receive a LOOPER_ID_MAIN or LOOPER_ID_INPUT event,
nuclear@23 71 * the returned data will point to an android_poll_source structure. You
nuclear@23 72 * can call the process() function on it, and fill in android_app->onAppCmd
nuclear@23 73 * and android_app->onInputEvent to be called for your own processing
nuclear@23 74 * of the event.
nuclear@23 75 *
nuclear@23 76 * Alternatively, you can call the low-level functions to read and process
nuclear@23 77 * the data directly... look at the process_cmd() and process_input()
nuclear@23 78 * implementations in the glue to see how to do this.
nuclear@23 79 *
nuclear@23 80 * See the sample named "native-activity" that comes with the NDK with a
nuclear@23 81 * full usage example. Also look at the JavaDoc of NativeActivity.
nuclear@23 82 */
nuclear@23 83
nuclear@23 84 struct android_app;
nuclear@23 85
nuclear@23 86 /**
nuclear@23 87 * Data associated with an ALooper fd that will be returned as the "outData"
nuclear@23 88 * when that source has data ready.
nuclear@23 89 */
nuclear@23 90 struct android_poll_source {
nuclear@23 91 // The identifier of this source. May be LOOPER_ID_MAIN or
nuclear@23 92 // LOOPER_ID_INPUT.
nuclear@23 93 int32_t id;
nuclear@23 94
nuclear@23 95 // The android_app this ident is associated with.
nuclear@23 96 struct android_app* app;
nuclear@23 97
nuclear@23 98 // Function to call to perform the standard processing of data from
nuclear@23 99 // this source.
nuclear@23 100 void (*process)(struct android_app* app, struct android_poll_source* source);
nuclear@23 101 };
nuclear@23 102
nuclear@23 103 /**
nuclear@23 104 * This is the interface for the standard glue code of a threaded
nuclear@23 105 * application. In this model, the application's code is running
nuclear@23 106 * in its own thread separate from the main thread of the process.
nuclear@23 107 * It is not required that this thread be associated with the Java
nuclear@23 108 * VM, although it will need to be in order to make JNI calls any
nuclear@23 109 * Java objects.
nuclear@23 110 */
nuclear@23 111 struct android_app {
nuclear@23 112 // The application can place a pointer to its own state object
nuclear@23 113 // here if it likes.
nuclear@23 114 void* userData;
nuclear@23 115
nuclear@23 116 // Fill this in with the function to process main app commands (APP_CMD_*)
nuclear@23 117 void (*onAppCmd)(struct android_app* app, int32_t cmd);
nuclear@23 118
nuclear@23 119 // Fill this in with the function to process input events. At this point
nuclear@23 120 // the event has already been pre-dispatched, and it will be finished upon
nuclear@23 121 // return. Return 1 if you have handled the event, 0 for any default
nuclear@23 122 // dispatching.
nuclear@23 123 int32_t (*onInputEvent)(struct android_app* app, AInputEvent* event);
nuclear@23 124
nuclear@23 125 // The ANativeActivity object instance that this app is running in.
nuclear@23 126 ANativeActivity* activity;
nuclear@23 127
nuclear@23 128 // The current configuration the app is running in.
nuclear@23 129 AConfiguration* config;
nuclear@23 130
nuclear@23 131 // This is the last instance's saved state, as provided at creation time.
nuclear@23 132 // It is NULL if there was no state. You can use this as you need; the
nuclear@23 133 // memory will remain around until you call android_app_exec_cmd() for
nuclear@23 134 // APP_CMD_RESUME, at which point it will be freed and savedState set to NULL.
nuclear@23 135 // These variables should only be changed when processing a APP_CMD_SAVE_STATE,
nuclear@23 136 // at which point they will be initialized to NULL and you can malloc your
nuclear@23 137 // state and place the information here. In that case the memory will be
nuclear@23 138 // freed for you later.
nuclear@23 139 void* savedState;
nuclear@23 140 size_t savedStateSize;
nuclear@23 141
nuclear@23 142 // The ALooper associated with the app's thread.
nuclear@23 143 ALooper* looper;
nuclear@23 144
nuclear@23 145 // When non-NULL, this is the input queue from which the app will
nuclear@23 146 // receive user input events.
nuclear@23 147 AInputQueue* inputQueue;
nuclear@23 148
nuclear@23 149 // When non-NULL, this is the window surface that the app can draw in.
nuclear@23 150 ANativeWindow* window;
nuclear@23 151
nuclear@23 152 // Current content rectangle of the window; this is the area where the
nuclear@23 153 // window's content should be placed to be seen by the user.
nuclear@23 154 ARect contentRect;
nuclear@23 155
nuclear@23 156 // Current state of the app's activity. May be either APP_CMD_START,
nuclear@23 157 // APP_CMD_RESUME, APP_CMD_PAUSE, or APP_CMD_STOP; see below.
nuclear@23 158 int activityState;
nuclear@23 159
nuclear@23 160 // This is non-zero when the application's NativeActivity is being
nuclear@23 161 // destroyed and waiting for the app thread to complete.
nuclear@23 162 int destroyRequested;
nuclear@23 163
nuclear@23 164 // -------------------------------------------------
nuclear@23 165 // Below are "private" implementation of the glue code.
nuclear@23 166
nuclear@23 167 pthread_mutex_t mutex;
nuclear@23 168 pthread_cond_t cond;
nuclear@23 169
nuclear@23 170 int msgread;
nuclear@23 171 int msgwrite;
nuclear@23 172
nuclear@23 173 pthread_t thread;
nuclear@23 174
nuclear@23 175 struct android_poll_source cmdPollSource;
nuclear@23 176 struct android_poll_source inputPollSource;
nuclear@23 177
nuclear@23 178 int running;
nuclear@23 179 int stateSaved;
nuclear@23 180 int destroyed;
nuclear@23 181 int redrawNeeded;
nuclear@23 182 AInputQueue* pendingInputQueue;
nuclear@23 183 ANativeWindow* pendingWindow;
nuclear@23 184 ARect pendingContentRect;
nuclear@23 185 };
nuclear@23 186
nuclear@23 187 enum {
nuclear@23 188 /**
nuclear@23 189 * Looper data ID of commands coming from the app's main thread, which
nuclear@23 190 * is returned as an identifier from ALooper_pollOnce(). The data for this
nuclear@23 191 * identifier is a pointer to an android_poll_source structure.
nuclear@23 192 * These can be retrieved and processed with android_app_read_cmd()
nuclear@23 193 * and android_app_exec_cmd().
nuclear@23 194 */
nuclear@23 195 LOOPER_ID_MAIN = 1,
nuclear@23 196
nuclear@23 197 /**
nuclear@23 198 * Looper data ID of events coming from the AInputQueue of the
nuclear@23 199 * application's window, which is returned as an identifier from
nuclear@23 200 * ALooper_pollOnce(). The data for this identifier is a pointer to an
nuclear@23 201 * android_poll_source structure. These can be read via the inputQueue
nuclear@23 202 * object of android_app.
nuclear@23 203 */
nuclear@23 204 LOOPER_ID_INPUT = 2,
nuclear@23 205
nuclear@23 206 /**
nuclear@23 207 * Start of user-defined ALooper identifiers.
nuclear@23 208 */
nuclear@23 209 LOOPER_ID_USER = 3,
nuclear@23 210 };
nuclear@23 211
nuclear@23 212 enum {
nuclear@23 213 /**
nuclear@23 214 * Command from main thread: the AInputQueue has changed. Upon processing
nuclear@23 215 * this command, android_app->inputQueue will be updated to the new queue
nuclear@23 216 * (or NULL).
nuclear@23 217 */
nuclear@23 218 APP_CMD_INPUT_CHANGED,
nuclear@23 219
nuclear@23 220 /**
nuclear@23 221 * Command from main thread: a new ANativeWindow is ready for use. Upon
nuclear@23 222 * receiving this command, android_app->window will contain the new window
nuclear@23 223 * surface.
nuclear@23 224 */
nuclear@23 225 APP_CMD_INIT_WINDOW,
nuclear@23 226
nuclear@23 227 /**
nuclear@23 228 * Command from main thread: the existing ANativeWindow needs to be
nuclear@23 229 * terminated. Upon receiving this command, android_app->window still
nuclear@23 230 * contains the existing window; after calling android_app_exec_cmd
nuclear@23 231 * it will be set to NULL.
nuclear@23 232 */
nuclear@23 233 APP_CMD_TERM_WINDOW,
nuclear@23 234
nuclear@23 235 /**
nuclear@23 236 * Command from main thread: the current ANativeWindow has been resized.
nuclear@23 237 * Please redraw with its new size.
nuclear@23 238 */
nuclear@23 239 APP_CMD_WINDOW_RESIZED,
nuclear@23 240
nuclear@23 241 /**
nuclear@23 242 * Command from main thread: the system needs that the current ANativeWindow
nuclear@23 243 * be redrawn. You should redraw the window before handing this to
nuclear@23 244 * android_app_exec_cmd() in order to avoid transient drawing glitches.
nuclear@23 245 */
nuclear@23 246 APP_CMD_WINDOW_REDRAW_NEEDED,
nuclear@23 247
nuclear@23 248 /**
nuclear@23 249 * Command from main thread: the content area of the window has changed,
nuclear@23 250 * such as from the soft input window being shown or hidden. You can
nuclear@23 251 * find the new content rect in android_app::contentRect.
nuclear@23 252 */
nuclear@23 253 APP_CMD_CONTENT_RECT_CHANGED,
nuclear@23 254
nuclear@23 255 /**
nuclear@23 256 * Command from main thread: the app's activity window has gained
nuclear@23 257 * input focus.
nuclear@23 258 */
nuclear@23 259 APP_CMD_GAINED_FOCUS,
nuclear@23 260
nuclear@23 261 /**
nuclear@23 262 * Command from main thread: the app's activity window has lost
nuclear@23 263 * input focus.
nuclear@23 264 */
nuclear@23 265 APP_CMD_LOST_FOCUS,
nuclear@23 266
nuclear@23 267 /**
nuclear@23 268 * Command from main thread: the current device configuration has changed.
nuclear@23 269 */
nuclear@23 270 APP_CMD_CONFIG_CHANGED,
nuclear@23 271
nuclear@23 272 /**
nuclear@23 273 * Command from main thread: the system is running low on memory.
nuclear@23 274 * Try to reduce your memory use.
nuclear@23 275 */
nuclear@23 276 APP_CMD_LOW_MEMORY,
nuclear@23 277
nuclear@23 278 /**
nuclear@23 279 * Command from main thread: the app's activity has been started.
nuclear@23 280 */
nuclear@23 281 APP_CMD_START,
nuclear@23 282
nuclear@23 283 /**
nuclear@23 284 * Command from main thread: the app's activity has been resumed.
nuclear@23 285 */
nuclear@23 286 APP_CMD_RESUME,
nuclear@23 287
nuclear@23 288 /**
nuclear@23 289 * Command from main thread: the app should generate a new saved state
nuclear@23 290 * for itself, to restore from later if needed. If you have saved state,
nuclear@23 291 * allocate it with malloc and place it in android_app.savedState with
nuclear@23 292 * the size in android_app.savedStateSize. The will be freed for you
nuclear@23 293 * later.
nuclear@23 294 */
nuclear@23 295 APP_CMD_SAVE_STATE,
nuclear@23 296
nuclear@23 297 /**
nuclear@23 298 * Command from main thread: the app's activity has been paused.
nuclear@23 299 */
nuclear@23 300 APP_CMD_PAUSE,
nuclear@23 301
nuclear@23 302 /**
nuclear@23 303 * Command from main thread: the app's activity has been stopped.
nuclear@23 304 */
nuclear@23 305 APP_CMD_STOP,
nuclear@23 306
nuclear@23 307 /**
nuclear@23 308 * Command from main thread: the app's activity is being destroyed,
nuclear@23 309 * and waiting for the app thread to clean up and exit before proceeding.
nuclear@23 310 */
nuclear@23 311 APP_CMD_DESTROY,
nuclear@23 312 };
nuclear@23 313
nuclear@23 314 /**
nuclear@23 315 * Call when ALooper_pollAll() returns LOOPER_ID_MAIN, reading the next
nuclear@23 316 * app command message.
nuclear@23 317 */
nuclear@23 318 int8_t android_app_read_cmd(struct android_app* android_app);
nuclear@23 319
nuclear@23 320 /**
nuclear@23 321 * Call with the command returned by android_app_read_cmd() to do the
nuclear@23 322 * initial pre-processing of the given command. You can perform your own
nuclear@23 323 * actions for the command after calling this function.
nuclear@23 324 */
nuclear@23 325 void android_app_pre_exec_cmd(struct android_app* android_app, int8_t cmd);
nuclear@23 326
nuclear@23 327 /**
nuclear@23 328 * Call with the command returned by android_app_read_cmd() to do the
nuclear@23 329 * final post-processing of the given command. You must have done your own
nuclear@23 330 * actions for the command before calling this function.
nuclear@23 331 */
nuclear@23 332 void android_app_post_exec_cmd(struct android_app* android_app, int8_t cmd);
nuclear@23 333
nuclear@23 334 /**
nuclear@23 335 * Dummy function you can call to ensure glue code isn't stripped.
nuclear@23 336 */
nuclear@23 337 void app_dummy();
nuclear@23 338
nuclear@23 339 /**
nuclear@23 340 * This is the function that application code must implement, representing
nuclear@23 341 * the main entry to the app.
nuclear@23 342 */
nuclear@23 343 extern void android_main(struct android_app* app);
nuclear@23 344
nuclear@23 345 #ifdef __cplusplus
nuclear@23 346 }
nuclear@23 347 #endif
nuclear@23 348
nuclear@23 349 #endif /* _ANDROID_NATIVE_APP_GLUE_H */