README.android
author Gabriel Jacobo <gabomdq@gmail.com>
Mon, 14 Jan 2013 20:20:33 -0300
changeset 6816 b3d3ef1e15b5
parent 6678 afb9be20f8d2
child 6962 6ce8edb5577b
permissions -rw-r--r--
Fixes bug 1696, thanks Paul Geerts!
Also adds a bit of information about asset loading on Android.
paul@4727
     1
================================================================================
paul@4726
     2
Simple DirectMedia Layer for Android
paul@4727
     3
================================================================================
paul@4725
     4
slouken@4965
     5
Requirements:
slouken@4965
     6
slouken@4965
     7
Android SDK
slouken@4965
     8
http://developer.android.com/sdk/index.html
slouken@4965
     9
slouken@4965
    10
Android NDK r4 or later
slouken@4965
    11
http://developer.android.com/sdk/ndk/index.html
paul@4725
    12
slouken@4967
    13
paul@4727
    14
================================================================================
paul@4727
    15
 How the port works
paul@4727
    16
================================================================================
paul@4727
    17
paul@4727
    18
- Android applications are Java-based, optionally with parts written in C
paul@4727
    19
- As SDL apps are C-based, we use a small Java shim that uses JNI to talk to 
paul@4727
    20
the SDL library
paul@4727
    21
- This means that your application C code must be placed inside an android 
paul@4727
    22
Java project, along with some C support code that communicates with Java
paul@4727
    23
- This eventually produces a standard Android .apk package
paul@4727
    24
slouken@4967
    25
The Android Java code implements an "activity" and can be found in:
slouken@4967
    26
android-project/src/org/libsdl/app/SDLActivity.java
slouken@4967
    27
slouken@4967
    28
The Java code loads your game code, the SDL shared library, and
slouken@4967
    29
dispatches to native functions implemented in the SDL library:
slouken@4967
    30
src/SDL_android.cpp
slouken@4967
    31
slouken@4967
    32
Your project must include some glue code that starts your main() routine:
slouken@4967
    33
src/main/android/SDL_android_main.cpp
slouken@4967
    34
paul@4727
    35
paul@4727
    36
================================================================================
paul@4727
    37
 Building an app
paul@4727
    38
================================================================================
paul@4727
    39
paul@4725
    40
Instructions:
gabomdq@6678
    41
1. Copy the android-project directory wherever you want to keep your projects
gabomdq@6678
    42
   and rename it to the name of your project.
slouken@6631
    43
2. Move or symlink this SDL directory into the <project>/jni directory
slouken@6631
    44
3. Edit <project>/jni/src/Android.mk to include your source files
slouken@6631
    45
4. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
slouken@4964
    46
slouken@4964
    47
If you want to use the Eclipse IDE, skip to the Eclipse section below.
slouken@4964
    48
slouken@6631
    49
5. Edit <project>/local.properties to point to the Android SDK directory
slouken@6631
    50
6. Run 'ant debug' in android/project. This compiles the .java and eventually 
gabomdq@6678
    51
   creates a .apk with the native code embedded
slouken@6650
    52
7. 'ant debug install' will push the apk to the device or emulator (if connected)
paul@4725
    53
slouken@4965
    54
Here's an explanation of the files in the Android project, so you can customize them:
slouken@4965
    55
slouken@4965
    56
android-project/
gabomdq@6678
    57
	AndroidManifest.xml	- package manifest. Among others, it contains the class name
gabomdq@6678
    58
				  of the main activity.
slouken@4965
    59
	build.properties	- empty
gabomdq@6678
    60
	build.xml		- build description file, used by ant. The actual application name
gabomdq@6678
    61
				  is specified here.
gabomdq@6678
    62
	default.properties	- holds the target ABI for the application, can range between
gabomdq@6678
    63
				  android-5 and android-16
slouken@4965
    64
	local.properties	- holds the SDK path, you should change this to the path to your SDK
slouken@4967
    65
	jni/			- directory holding native code
gabomdq@6678
    66
	jni/Android.mk		- Android makefile that can call recursively the Android.mk files
gabomdq@6678
    67
				  in all subdirectories
gabomdq@6678
    68
	jni/SDL/		- (symlink to) directory holding the SDL library files
slouken@4965
    69
	jni/SDL/Android.mk	- Android makefile for creating the SDL shared library
slouken@4967
    70
	jni/src/		- directory holding your C/C++ source
gabomdq@6678
    71
	jni/src/Android.mk	- Android makefile that you should customize to include your 
gabomdq@6678
    72
                                  source code and any library references
slouken@4965
    73
	res/			- directory holding resources for your application
gabomdq@6678
    74
	res/drawable-*		- directories holding icons for different phone hardware. Could be
gabomdq@6678
    75
				  one dir called "drawable".
gabomdq@6678
    76
	res/layout/main.xml	- Usually contains a file main.xml, which declares the screen layout.
gabomdq@6678
    77
				  We don't need it because we use the SDL video output.
gabomdq@6678
    78
	res/values/strings.xml	- strings used in your application, including the application name
gabomdq@6678
    79
				  shown on the phone.
gabomdq@6678
    80
	src/org/libsdl/app/SDLActivity.java - the Java class handling the initialization and binding
gabomdq@6678
    81
				  to SDL.  Be very careful changing this, as the SDL library relies
gabomdq@6678
    82
				  on this implementation.
slouken@4965
    83
slouken@4965
    84
slouken@4965
    85
================================================================================
slouken@6631
    86
 Customizing your application name
slouken@6631
    87
================================================================================
slouken@6631
    88
slouken@6631
    89
To customize your application name, edit AndroidManifest.xml and replace
slouken@6631
    90
"org.libsdl.app" with an identifier for your product package.
slouken@6631
    91
slouken@6631
    92
Then create a Java class extending SDLActivity and place it in a directory
slouken@6631
    93
under src matching your package, e.g.
slouken@6631
    94
	src/com/gamemaker/game/MyGame.java
slouken@6631
    95
slouken@6631
    96
Here's an example of a minimal class file:
slouken@6631
    97
--- MyGame.java --------------------------
slouken@6631
    98
package com.gamemaker.game;
slouken@6631
    99
slouken@6631
   100
import org.libsdl.app.SDLActivity; 
slouken@6631
   101
slouken@6631
   102
/* 
slouken@6631
   103
 * A sample wrapper class that just calls SDLActivity 
slouken@6631
   104
 */ 
slouken@6631
   105
gabomdq@6678
   106
public class MyGame extends SDLActivity { }
gabomdq@6678
   107
slouken@6631
   108
------------------------------------------
slouken@6631
   109
slouken@6631
   110
Then replace "SDLActivity" in AndroidManifest.xml with the name of your
slouken@6631
   111
class, .e.g. "MyGame"
slouken@6631
   112
slouken@6631
   113
================================================================================
slouken@6631
   114
 Customizing your application icon
slouken@6631
   115
================================================================================
slouken@6631
   116
slouken@6631
   117
Conceptually changing your icon is just replacing the icon.png files in the
gabomdq@6678
   118
drawable directories under the res directory. There are 3 directories for
gabomdq@6678
   119
different screen sizes. These can be replaced with 1 dir called 'drawable',
gabomdq@6678
   120
containing an icon file 'icon.png' with dimensions 48x48 or 72x72.
slouken@6631
   121
slouken@6631
   122
You may need to change the name of your icon in AndroidManifest.xml to match
gabomdq@6678
   123
this icon filename.
slouken@6631
   124
slouken@6631
   125
================================================================================
slouken@6646
   126
 Loading assets
slouken@6646
   127
================================================================================
slouken@6646
   128
slouken@6646
   129
Any files you put in the "assets" directory of your android-project directory
slouken@6646
   130
will get bundled into the application package and you can load them using the
slouken@6646
   131
standard functions in SDL_rwops.h.
slouken@6646
   132
slouken@6646
   133
There are also a few Android specific functions that allow you to get other
slouken@6646
   134
useful paths for saving and loading data:
slouken@6646
   135
SDL_AndroidGetInternalStoragePath()
slouken@6646
   136
SDL_AndroidGetExternalStorageState()
slouken@6646
   137
SDL_AndroidGetExternalStoragePath()
slouken@6646
   138
slouken@6646
   139
See SDL_system.h for more details on these functions.
slouken@6646
   140
gabomdq@6816
   141
The asset packaging system will, by default, compress certain file extensions.
gabomdq@6816
   142
SDL includes two asset file access mechanisms, the preferred one is the so
gabomdq@6816
   143
called "File Descriptor" method, which is faster and doesn't involve the Dalvik
gabomdq@6816
   144
GC, but given this method does not work on compressed assets, there is also the
gabomdq@6816
   145
"Input Stream" method, which is automatically used as a fall back by SDL. You
gabomdq@6816
   146
may want to keep this fact in mind when building your APK, specially when large
gabomdq@6816
   147
files are involved.
gabomdq@6816
   148
For more information on which extensions get compressed by default and how to
gabomdq@6816
   149
disable this behaviour, see for example:
gabomdq@6816
   150
    
gabomdq@6816
   151
http://ponystyle.com/blog/2010/03/26/dealing-with-asset-compression-in-android-apps/
gabomdq@6816
   152
slouken@6646
   153
================================================================================
gabomdq@6330
   154
 Pause / Resume behaviour
gabomdq@6330
   155
================================================================================
gabomdq@6330
   156
slouken@6664
   157
If SDL is compiled with SDL_ANDROID_BLOCK_ON_PAUSE defined (the default),
slouken@6664
   158
the event loop will block itself when the app is paused (ie, when the user
slouken@6664
   159
returns to the main Android dashboard). Blocking is better in terms of battery
slouken@6664
   160
use, and it allows your app to spring back to life instantaneously after resume
slouken@6664
   161
(versus polling for a resume message).
slouken@6664
   162
gabomdq@6330
   163
Upon resume, SDL will attempt to restore the GL context automatically.
gabomdq@6330
   164
In modern devices (Android 3.0 and up) this will most likely succeed and your
gabomdq@6330
   165
app can continue to operate as it was.
slouken@6664
   166
gabomdq@6330
   167
However, there's a chance (on older hardware, or on systems under heavy load),
gabomdq@6330
   168
where the GL context can not be restored. In that case you have to listen for
gabomdq@6330
   169
a specific message, (which is not yet implemented!) and restore your textures
gabomdq@6330
   170
manually or quit the app (which is actually the kind of behaviour you'll see
gabomdq@6330
   171
under iOS, if the OS can not restore your GL context it will just kill your app)
gabomdq@6330
   172
gabomdq@6330
   173
================================================================================
gabomdq@6354
   174
 Threads and the JAVA VM
gabomdq@6354
   175
================================================================================
gabomdq@6354
   176
gabomdq@6354
   177
For a quick tour on how Linux native threads interoperate with the JAVA VM, take
gabomdq@6354
   178
a look here: http://developer.android.com/guide/practices/jni.html
gabomdq@6354
   179
If you want to use threads in your SDL app, it's strongly recommended that you
gabomdq@6354
   180
do so by creating them using SDL functions. This way, the required attach/detach
gabomdq@6354
   181
handling is managed by SDL automagically. If you have threads created by other
gabomdq@6354
   182
means and they make calls to SDL functions, make sure that you call
gabomdq@6354
   183
Android_JNI_SetupThread before doing anything else otherwise SDL will attach
gabomdq@6354
   184
your thread automatically anyway (when you make an SDL call), but it'll never
gabomdq@6354
   185
detach it.
gabomdq@6354
   186
gabomdq@6354
   187
================================================================================
slouken@6631
   188
 Using STL
slouken@6631
   189
================================================================================
slouken@6631
   190
slouken@6631
   191
You can use STL in your project by creating an Application.mk file in the jni
slouken@6631
   192
folder and adding the following line:
slouken@6631
   193
APP_STL := stlport_static
slouken@6631
   194
slouken@6631
   195
For more information check out CPLUSPLUS-SUPPORT.html in the NDK documentation.
slouken@6631
   196
slouken@6631
   197
================================================================================
slouken@4965
   198
 Additional documentation
slouken@4965
   199
================================================================================
slouken@4965
   200
gabomdq@6678
   201
The documentation in the NDK docs directory is very helpful in understanding the
gabomdq@6678
   202
build process and how to work with native code on the Android platform.
slouken@4965
   203
slouken@4965
   204
The best place to start is with docs/OVERVIEW.TXT
slouken@4965
   205
paul@4725
   206
slouken@4964
   207
================================================================================
slouken@4964
   208
 Using Eclipse
slouken@4964
   209
================================================================================
slouken@4964
   210
slouken@4965
   211
First make sure that you've installed Eclipse and the Android extensions as described here:
slouken@4965
   212
	http://developer.android.com/sdk/eclipse-adt.html
slouken@4965
   213
slouken@4965
   214
Once you've copied the SDL android project and customized it, you can create an Eclipse project from it:
slouken@4965
   215
 * File -> New -> Other
slouken@4965
   216
 * Select the Android -> Android Project wizard and click Next
slouken@4965
   217
 * Enter the name you'd like your project to have
slouken@4965
   218
 * Select "Create project from existing source" and browse for your project directory
icculus@6387
   219
 * Make sure the Build Target is set to Android 2.0
slouken@4965
   220
 * Click Finish
slouken@4964
   221
slouken@4964
   222
slouken@4964
   223
================================================================================
slouken@6652
   224
 Using the emulator
slouken@4964
   225
================================================================================
slouken@4964
   226
slouken@6652
   227
There are some good tips and tricks for getting the most out of the
slouken@6652
   228
emulator here: http://developer.android.com/tools/devices/emulator.html
slouken@6652
   229
slouken@6652
   230
Especially useful is the info on setting up OpenGL ES 2.0 emulation.
slouken@4964
   231
gabomdq@6678
   232
Notice that this software emulator is incredibly slow and needs a lot of disk space.
gabomdq@6678
   233
Using a real device works better.
slouken@4964
   234
slouken@4964
   235
================================================================================
slouken@4964
   236
 Troubleshooting
slouken@4964
   237
================================================================================
slouken@4964
   238
slouken@4965
   239
You can create and run an emulator from the Eclipse IDE:
slouken@4965
   240
 * Window -> Android SDK and AVD Manager
slouken@4965
   241
slouken@4965
   242
You can see if adb can see any devices with the following command:
slouken@4965
   243
	adb devices
slouken@4965
   244
slouken@4965
   245
You can see the output of log messages on the default device with:
slouken@4965
   246
	adb logcat
slouken@4965
   247
slouken@4965
   248
You can push files to the device with:
slouken@4965
   249
	adb push local_file remote_path_and_file
slouken@4965
   250
slouken@4965
   251
You can push files to the SD Card at /sdcard, for example:
slouken@4965
   252
	adb push moose.dat /sdcard/moose.dat
paul@4727
   253
slouken@4976
   254
You can see the files on the SD card with a shell command:
slouken@4976
   255
	adb shell ls /sdcard/
slouken@4976
   256
slouken@4976
   257
You can start a command shell on the default device with:
slouken@4976
   258
	adb shell
slouken@4976
   259
gabomdq@6678
   260
You can remove the library files of your project (and not the SDL lib files) with:
slouken@4975
   261
	ndk-build clean
gabomdq@6678
   262
gabomdq@6678
   263
You can do a build with the following command:
slouken@4975
   264
	ndk-build
slouken@4975
   265
slouken@4973
   266
You can see the complete command line that ndk-build is using by passing V=1 on the command line:
slouken@4973
   267
	ndk-build V=1
slouken@4973
   268
gabomdq@6678
   269
If your application crashes in native code, you can use addr2line to convert the
gabomdq@6678
   270
addresses in the stack trace to lines in your code.
slouken@4973
   271
slouken@4973
   272
For example, if your crash looks like this:
slouken@4973
   273
I/DEBUG   (   31): signal 11 (SIGSEGV), code 2 (SEGV_ACCERR), fault addr 400085d0
slouken@4973
   274
I/DEBUG   (   31):  r0 00000000  r1 00001000  r2 00000003  r3 400085d4
slouken@4973
   275
I/DEBUG   (   31):  r4 400085d0  r5 40008000  r6 afd41504  r7 436c6a7c
slouken@4973
   276
I/DEBUG   (   31):  r8 436c6b30  r9 435c6fb0  10 435c6f9c  fp 4168d82c
slouken@4973
   277
I/DEBUG   (   31):  ip 8346aff0  sp 436c6a60  lr afd1c8ff  pc afd1c902  cpsr 60000030
slouken@4973
   278
I/DEBUG   (   31):          #00  pc 0001c902  /system/lib/libc.so
slouken@4973
   279
I/DEBUG   (   31):          #01  pc 0001ccf6  /system/lib/libc.so
slouken@4973
   280
I/DEBUG   (   31):          #02  pc 000014bc  /data/data/org.libsdl.app/lib/libmain.so
slouken@4973
   281
I/DEBUG   (   31):          #03  pc 00001506  /data/data/org.libsdl.app/lib/libmain.so
slouken@4973
   282
gabomdq@6678
   283
You can see that there's a crash in the C library being called from the main code.
gabomdq@6678
   284
I run addr2line with the debug version of my code:
slouken@4973
   285
	arm-eabi-addr2line -C -f -e obj/local/armeabi/libmain.so
slouken@4973
   286
and then paste in the number after "pc" in the call stack, from the line that I care about:
slouken@4973
   287
000014bc
slouken@4973
   288
slouken@4973
   289
I get output from addr2line showing that it's in the quit function, in testspriteminimal.c, on line 23.
slouken@4973
   290
slouken@4973
   291
You can add logging to your code to help show what's happening:
slouken@4973
   292
slouken@4973
   293
#include <android/log.h>
slouken@4973
   294
slouken@4973
   295
	__android_log_print(ANDROID_LOG_INFO, "foo", "Something happened! x = %d", x);
slouken@4973
   296
gabomdq@6678
   297
If you need to build without optimization turned on, you can create a file called
gabomdq@6678
   298
"Application.mk" in the jni directory, with the following line in it:
slouken@4974
   299
APP_OPTIM := debug
slouken@4974
   300
paul@4727
   301
paul@4727
   302
================================================================================
slouken@6650
   303
 Memory debugging
slouken@6650
   304
================================================================================
slouken@6650
   305
slouken@6650
   306
The best (and slowest) way to debug memory issues on Android is valgrind.
slouken@6650
   307
Valgrind has support for Android out of the box, just grab code using:
slouken@6650
   308
	svn co svn://svn.valgrind.org/valgrind/trunk valgrind
slouken@6650
   309
... and follow the instructions in the file README.android to build it.
slouken@6650
   310
slouken@6650
   311
One thing I needed to do on Mac OS X was change the path to the toolchain,
slouken@6650
   312
and add ranlib to the environment variables:
slouken@6650
   313
export RANLIB=$NDKROOT/toolchains/arm-linux-androideabi-4.4.3/prebuilt/darwin-x86/bin/arm-linux-androideabi-ranlib
slouken@6650
   314
slouken@6650
   315
Once valgrind is built, you can create a wrapper script to launch your
slouken@6650
   316
application with it, changing org.libsdl.app to your package identifier:
slouken@6650
   317
--- start_valgrind_app -------------------
slouken@6650
   318
#!/system/bin/sh
slouken@6650
   319
export TMPDIR=/data/data/org.libsdl.app
slouken@6650
   320
exec /data/local/Inst/bin/valgrind --log-file=/sdcard/valgrind.log --error-limit=no $*
slouken@6650
   321
------------------------------------------
slouken@6650
   322
slouken@6650
   323
Then push it to the device:
slouken@6650
   324
	adb push start_valgrind_app /data/local
slouken@6650
   325
slouken@6650
   326
and make it executable:
slouken@6650
   327
	adb shell chmod 755 /data/local/start_valgrind_app
slouken@6650
   328
slouken@6650
   329
and tell Android to use the script to launch your application:
slouken@6650
   330
	adb shell setprop wrap.org.libsdl.app "logwrapper /data/local/start_valgrind_app"
slouken@6650
   331
slouken@6650
   332
If the setprop command says "could not set property", it's likely that
slouken@6650
   333
your package name is too long and you should make it shorter by changing
slouken@6650
   334
AndroidManifest.xml and the path to your class file in android-project/src
slouken@6650
   335
slouken@6650
   336
You can then launch your application normally and waaaaaaaiiittt for it.
slouken@6650
   337
You can monitor the startup process with the logcat command above, and
slouken@6650
   338
when it's done (or even while it's running) you can grab the valgrind
slouken@6650
   339
output file:
slouken@6650
   340
	adb pull /sdcard/valgrind.log
slouken@6650
   341
slouken@6650
   342
When you're done instrumenting with valgrind, you can disable the wrapper:
slouken@6650
   343
	adb shell setprop wrap.org.libsdl.app ""
slouken@6650
   344
slouken@6650
   345
slouken@6650
   346
================================================================================
paul@4727
   347
 Known issues
paul@4727
   348
================================================================================
paul@4727
   349
paul@4727
   350
- TODO. I'm sure there's a bunch more stuff I haven't thought of