README.android
author Michael Sartain <mikesart@valvesoftware.com>
Thu, 11 Oct 2012 09:41:43 -0700
changeset 6570 45855398762c
parent 6387 58f0fb54bf88
child 6631 47ab7ba21530
permissions -rw-r--r--
Add GLX_X_VISUAL_TYPE_EXT so created window will use DirectColor if available (instead of TrueColor).
Our new X11 window was being created with the TrueColor attribute, and trying to set the gamma
on that would fail. This change checks for the visual_info extension, and uses that to ask for
DirectColor if available.
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:
slouken@4965
    41
1. Copy the android-project directory wherever you want to keep your projects and rename it to the name of your project.
slouken@6273
    42
2. Move this SDL directory into the <project>/jni directory and then copy
slouken@6273
    43
SDL_config_android.h to SDL_config.h inside the include folder
slouken@4964
    44
3. Place your application source files in the <project>/jni/src directory
slouken@4964
    45
4. Edit <project>/jni/src/Android.mk to include your source files
paul@4727
    46
5. Run 'ndk-build' (a script provided by the NDK). This compiles the C source
slouken@4964
    47
slouken@4964
    48
If you want to use the Eclipse IDE, skip to the Eclipse section below.
slouken@4964
    49
slouken@4964
    50
6. Edit <project>/local.properties to point to the Android SDK directory
slouken@4964
    51
7. Run 'ant debug' in android/project. This compiles the .java and eventually 
slouken@4964
    52
creates a .apk with the native code embedded
slouken@4964
    53
8. 'ant install' will push the apk to the device or emulator (if connected)
paul@4725
    54
slouken@4965
    55
Here's an explanation of the files in the Android project, so you can customize them:
slouken@4965
    56
slouken@4965
    57
android-project/
slouken@4965
    58
	AndroidManifest.xml	- package manifest, do not modify
slouken@4965
    59
	build.properties	- empty
slouken@4965
    60
	build.xml		- build description file, used by ant
icculus@6387
    61
	default.properties	- holds the ABI for the application, currently android-5 which corresponds to the Android 2.0 system image
slouken@4965
    62
	local.properties	- holds the SDK path, you should change this to the path to your SDK
slouken@4967
    63
	jni/			- directory holding native code
slouken@4965
    64
	jni/Android.mk		- Android makefile that includes all subdirectories
slouken@4965
    65
	jni/SDL/		- directory holding the SDL library files
slouken@4965
    66
	jni/SDL/Android.mk	- Android makefile for creating the SDL shared library
slouken@4967
    67
	jni/src/		- directory holding your C/C++ source
slouken@4965
    68
	jni/src/Android.mk	- Android makefile that you should customize to include your source code and any library references
slouken@4965
    69
	res/			- directory holding resources for your application
slouken@4965
    70
	res/drawable-*		- directories holding icons for different phone hardware
slouken@4965
    71
	res/layout/main.xml	- place holder for the main screen layout, overridden by the SDL video output
slouken@4965
    72
	res/values/strings.xml	- strings used in your application, including the application name shown on the phone.
slouken@4965
    73
	src/org/libsdl/app/SDLActivity.java	- the Java class handling the initialization and binding to SDL.  Be very careful changing this, as the SDL library relies on this implementation.
slouken@4965
    74
slouken@4965
    75
slouken@4965
    76
================================================================================
gabomdq@6330
    77
 Pause / Resume behaviour
gabomdq@6330
    78
================================================================================
gabomdq@6330
    79
gabomdq@6330
    80
If SDL is compiled with SDL_ANDROID_BLOCK_ON_PAUSE defined, the event loop will
gabomdq@6330
    81
block itself when the app is paused (ie, when the user returns to the main
gabomdq@6330
    82
Android dashboard). Blocking is better in terms of battery use, and it allows your
gabomdq@6330
    83
app to spring back to life instantaneously after resume (versus polling for
gabomdq@6330
    84
a resume message).
gabomdq@6330
    85
Upon resume, SDL will attempt to restore the GL context automatically.
gabomdq@6330
    86
In modern devices (Android 3.0 and up) this will most likely succeed and your
gabomdq@6330
    87
app can continue to operate as it was.
gabomdq@6330
    88
However, there's a chance (on older hardware, or on systems under heavy load),
gabomdq@6330
    89
where the GL context can not be restored. In that case you have to listen for
gabomdq@6330
    90
a specific message, (which is not yet implemented!) and restore your textures
gabomdq@6330
    91
manually or quit the app (which is actually the kind of behaviour you'll see
gabomdq@6330
    92
under iOS, if the OS can not restore your GL context it will just kill your app)
gabomdq@6330
    93
gabomdq@6330
    94
================================================================================
gabomdq@6354
    95
 Threads and the JAVA VM
gabomdq@6354
    96
================================================================================
gabomdq@6354
    97
gabomdq@6354
    98
For a quick tour on how Linux native threads interoperate with the JAVA VM, take
gabomdq@6354
    99
a look here: http://developer.android.com/guide/practices/jni.html
gabomdq@6354
   100
If you want to use threads in your SDL app, it's strongly recommended that you
gabomdq@6354
   101
do so by creating them using SDL functions. This way, the required attach/detach
gabomdq@6354
   102
handling is managed by SDL automagically. If you have threads created by other
gabomdq@6354
   103
means and they make calls to SDL functions, make sure that you call
gabomdq@6354
   104
Android_JNI_SetupThread before doing anything else otherwise SDL will attach
gabomdq@6354
   105
your thread automatically anyway (when you make an SDL call), but it'll never
gabomdq@6354
   106
detach it.
gabomdq@6354
   107
gabomdq@6354
   108
================================================================================
slouken@4965
   109
 Additional documentation
slouken@4965
   110
================================================================================
slouken@4965
   111
slouken@4965
   112
The documentation in the NDK docs directory is very helpful in understanding the build process and how to work with native code on the Android platform.
slouken@4965
   113
slouken@4965
   114
The best place to start is with docs/OVERVIEW.TXT
slouken@4965
   115
paul@4725
   116
slouken@4964
   117
================================================================================
slouken@4964
   118
 Using Eclipse
slouken@4964
   119
================================================================================
slouken@4964
   120
slouken@4965
   121
First make sure that you've installed Eclipse and the Android extensions as described here:
slouken@4965
   122
	http://developer.android.com/sdk/eclipse-adt.html
slouken@4965
   123
slouken@4965
   124
Once you've copied the SDL android project and customized it, you can create an Eclipse project from it:
slouken@4965
   125
 * File -> New -> Other
slouken@4965
   126
 * Select the Android -> Android Project wizard and click Next
slouken@4965
   127
 * Enter the name you'd like your project to have
slouken@4965
   128
 * Select "Create project from existing source" and browse for your project directory
icculus@6387
   129
 * Make sure the Build Target is set to Android 2.0
slouken@4965
   130
 * Click Finish
slouken@4964
   131
slouken@4964
   132
slouken@4964
   133
================================================================================
slouken@4965
   134
 Loading files and resources
slouken@4964
   135
================================================================================
slouken@4964
   136
slouken@4964
   137
NEED CONTENT
slouken@4964
   138
slouken@4964
   139
slouken@4964
   140
================================================================================
slouken@4964
   141
 Troubleshooting
slouken@4964
   142
================================================================================
slouken@4964
   143
slouken@4965
   144
You can create and run an emulator from the Eclipse IDE:
slouken@4965
   145
 * Window -> Android SDK and AVD Manager
slouken@4965
   146
slouken@4965
   147
You can see if adb can see any devices with the following command:
slouken@4965
   148
	adb devices
slouken@4965
   149
slouken@4965
   150
You can see the output of log messages on the default device with:
slouken@4965
   151
	adb logcat
slouken@4965
   152
slouken@4965
   153
You can push files to the device with:
slouken@4965
   154
	adb push local_file remote_path_and_file
slouken@4965
   155
slouken@4965
   156
You can push files to the SD Card at /sdcard, for example:
slouken@4965
   157
	adb push moose.dat /sdcard/moose.dat
paul@4727
   158
slouken@4976
   159
You can see the files on the SD card with a shell command:
slouken@4976
   160
	adb shell ls /sdcard/
slouken@4976
   161
slouken@4976
   162
You can start a command shell on the default device with:
slouken@4976
   163
	adb shell
slouken@4976
   164
slouken@4975
   165
You can do a clean build with the following commands:
slouken@4975
   166
	ndk-build clean
slouken@4975
   167
	ndk-build
slouken@4975
   168
slouken@4973
   169
You can see the complete command line that ndk-build is using by passing V=1 on the command line:
slouken@4973
   170
	ndk-build V=1
slouken@4973
   171
slouken@4973
   172
If your application crashes in native code, you can use addr2line to convert the addresses in the stack trace to lines in your code.
slouken@4973
   173
slouken@4973
   174
For example, if your crash looks like this:
slouken@4973
   175
I/DEBUG   (   31): signal 11 (SIGSEGV), code 2 (SEGV_ACCERR), fault addr 400085d0
slouken@4973
   176
I/DEBUG   (   31):  r0 00000000  r1 00001000  r2 00000003  r3 400085d4
slouken@4973
   177
I/DEBUG   (   31):  r4 400085d0  r5 40008000  r6 afd41504  r7 436c6a7c
slouken@4973
   178
I/DEBUG   (   31):  r8 436c6b30  r9 435c6fb0  10 435c6f9c  fp 4168d82c
slouken@4973
   179
I/DEBUG   (   31):  ip 8346aff0  sp 436c6a60  lr afd1c8ff  pc afd1c902  cpsr 60000030
slouken@4973
   180
I/DEBUG   (   31):          #00  pc 0001c902  /system/lib/libc.so
slouken@4973
   181
I/DEBUG   (   31):          #01  pc 0001ccf6  /system/lib/libc.so
slouken@4973
   182
I/DEBUG   (   31):          #02  pc 000014bc  /data/data/org.libsdl.app/lib/libmain.so
slouken@4973
   183
I/DEBUG   (   31):          #03  pc 00001506  /data/data/org.libsdl.app/lib/libmain.so
slouken@4973
   184
slouken@4973
   185
You can see that there's a crash in the C library being called from the main code.  I run addr2line with the debug version of my code:
slouken@4973
   186
	arm-eabi-addr2line -C -f -e obj/local/armeabi/libmain.so
slouken@4973
   187
and then paste in the number after "pc" in the call stack, from the line that I care about:
slouken@4973
   188
000014bc
slouken@4973
   189
slouken@4973
   190
I get output from addr2line showing that it's in the quit function, in testspriteminimal.c, on line 23.
slouken@4973
   191
slouken@4973
   192
You can add logging to your code to help show what's happening:
slouken@4973
   193
slouken@4973
   194
#include <android/log.h>
slouken@4973
   195
slouken@4973
   196
	__android_log_print(ANDROID_LOG_INFO, "foo", "Something happened! x = %d", x);
slouken@4973
   197
slouken@4974
   198
If you need to build without optimization turned on, you can create a file called "Application.mk" in the jni directory, with the following line in it:
slouken@4974
   199
APP_OPTIM := debug
slouken@4974
   200
paul@4727
   201
paul@4727
   202
================================================================================
paul@4727
   203
 Known issues
paul@4727
   204
================================================================================
paul@4727
   205
paul@4727
   206
- SDL audio (although it's mostly written, just not working properly yet)
paul@4727
   207
- TODO. I'm sure there's a bunch more stuff I haven't thought of