OpenGL Programming/Installation/Android NDK

Our GLUT tutorials can be run on Android using the simple provided wrapper.

Note: the wrapper will be integrated in the next official FreeGLUT (version 3.0)!

= Making-of =

To understand of the GLUT wrapper works internally, see Android GLUT Wrapper.

= Dependencies =

First you'll need a minimal Java development environment:

Then get the Android NDK r9d from Android Developers to compile C/C++ code for Android.

Last you need to install the Android API level 10, get the Android SDK from the same site and use the android graphical tool to install it.

The programs themselves may also require the GLM and FreeType libraries - see the dedicated sections below.

Emulator (lack of) support for OpenGL ES 2.0
The Android emulator only supports OpenGL ES 2.0 since April 2012, requires a specific emulator configuration and system image, and doesn't seem to work on all platforms.

Also beware that the "API Demos" applications ships an "OpenGL ES 2.0" sample that silently and confusingly falls back to OpenGL ES 1.0 if 2.0 is not available, so it's not a good test to see if OpenGL ES 2.0 is supported.

It's still best to experiment with OpenGL 2.0 on Android with a supporting device.

Official documentation: https://developer.android.com/tools/devices/emulator.html#accel-graphics

= Connecting with USB =

When you connect your device through USB, you can use the  command (from the Android SDK) to browse the filesystem, install applications, debug them, etc.

$ adb devices List of devices attached 4520412B47C0207D	device

= Using our wrapper =

In this wikibook, the samples are based on the GLUT library.

Since GLUT is not ported to Android yet, we wrote a simple GLUT-compatible wrapper for Android (see the code repository).

Note: the wrapper is still in its early life and may change in the near future.

Compile tutorials code
Look at the 'android_wrapper/' directory. export PATH="$PATH:/usr/src/android-sdk-linux/tools:/usr/src/android-sdk-linux/platform-tools:/usr/src/android-ndk-r9d" make clean; make && make install
 * Plug your device (smartphone, tablet...) with USB
 * Add the Android tools to your PATH, for instance:
 * Inside the  directory, make   a symlink to the GLUT code you need to compile (e.g.  )
 * Make  a symlink to the tutorial you're compiling (e.g.  )
 * Now you can type:
 * You'll get an "OpenGL Wikibook" application on your device, ready to run!

Full-screen
To make your application full-screen, add this attribute in your AndroidManifest.xml

Keyboard
The default Android keyboard does not have keys such as F1/F2/F3.

Instead, you can use Hacker's Keyboard, an alternative input method with more keys:
 * homepage.
 * F-Droid / GPlay

Icon
Make sure your application has  defined in  :

Create two icons:
 * res/drawable/icon.png (48x48)
 * res/drawable-hdpi/icon.png (72x72)

Now your application will have a custom icon on the launcher.

= Debugging =

Browsing standard output
If you want to see your program's standard outputs (stdout and stderr), you need to redirect them to the system log :

To check the log files, you can use:
 * The command: adb logcat
 * The  utility, with its graphical GUI to browse the logs
 * Eclipse, which embeds a LogCat viewer similar to DDMS

Checking JNI calls
The following will turn on more checks when calling JNI from C/C++:

You'll get additional traces on the system log, and JNI will be more strict on what it accepts.

GDB
GDB can be enabled too.

Note: in NDKr7, use the "stabs" format for debug symbols in Android.mk, otherwise GDB will show the wrong source code lines :

GDB requires a debug build, add NDK_DEBUG=1 when building your C++ code:

When starting gdb, make sure your AndroidManifest.xml mentions it's debuggable, otherwise gdb will behave badly (lack of thread information, crash, etc.):

The gdb-server needs a few seconds to start on the device, so your program will start running before it can be paused by the debugger. A work-around is to add a wait in your  function:

To start the debug session, type: ndk-gdb --start

Unable to load native library
If you get errors such as: E/AndroidRuntime( 3021): java.lang.RuntimeException: Unable to start activity ComponentInfo{org.wikibooks.OpenGL/android.app.NativeActivity}: java.lang.IllegalArgumentException: Unable to load native library: /data/data/org.wikibook.OpenGL/lib/libnative-activity.so the system couldn't load your .so due to a low-level reason.

To get more information, you need to create a minimal Java application that loads the library manually: Compile, install and prepare it:
 * src/com/example/test_native_activity/Main.java
 * AndroidManifest.xml:

When you run this application, you'll get a more precise error in the Android logs, such as a wrong STL implementation: E/AndroidRuntime(3009): java.lang.UnsatisfiedLinkError: Cannot load library: reloc_library[1311]: 2323 cannot locate '_ZStlsISt11char_traitsIcEERSt13basic_ostreamIcT_ES5_PKc'... or a missing dependency: E/AndroidRuntime( 3327): java.lang.UnsatisfiedLinkError: Cannot load library:link_image[1962]: 2323 could not load needed library 'libglut.so.3' for 'libnative-activity.so' (load_library[1104]: Library 'libglut.so.3' not found)

In the worst case, the library might not even load properly. This may happen e.g. when the C++ constructor of a global static variable crashes while it is called at library loading time, even before your application is started. You'll need to reproduce library loading at the C level:

Then send it to the device and execute it: You can also use  for more precision:

There is no  for Android by default, but you can simulate it using:

= Abstracting differences between OpenGL and GLES2 =

When you only use GLES2 functions, your application is nearly portable to both desktops and mobile devices. There are still a couple issues to address:
 * The GLSL  is different
 * GLES2 requires precision hints that are not compatible with OpenGL 2.1.

See the Basic Tutorials 02 and 03 for details and a proposed solution.

= GLM =

To install GLM, you just need to extract the latest release in  (such that   exists). It is a header-only library that doesn't require separate compilation.

= SOIL =


 * Download the Simple OpenGL Image Library from http://lonesock.net/soil.html
 * Apply patch from android_wrapper/soil.patch.
 * Follow instructions in projects/Android/Makefile.
 * NDK module ready in src/build/soil/.

= FreeType =

If you need FreeType (a library to render fonts), you'll need to cross-compile it. Note: The Android system uses FreeType but internally it doesn't expose it to native apps.

First, prepare the cross-compiler from the NDK:

Then use it to cross-compile freetype:

Then write an  file in the new   directory:

See  and   in the NDK for details. The  bit is not documented, but is necessary to avoid mixed-up paths; it is used in the   NDK module.

(Alternatively you can install it in --prefix=/usr/src/ndk-standalone-14-arm/sysroot/usr if you don't plan to use the NDK build system.)

To use FreeType in your project, edit your :

= Troubleshootings =

Device is marked offline
The first time you connect your device to a new computer, it will ask to to confirm the computer fingerprint. Until you accept on the device screen, it's marked offline.

If you are not asked for confirmation, make sure your adb is up-to-date.

Allow USB access for non-root users
These days, Android devices are references in your /lib/udev/rules.d/, and unprivileged users now can securely connect to the device,

If adb gets permission issues with your new device:
 * See if it works when running  as root (to check if it's a permission issue, or something else).
 * Install the android-tools-adb package, which includes /lib/udev/rules.d/70-android-tools-adb.rules.
 * If that doesn't work, manually create an udev rule as follow.

First, determine your device's, by typing 'dmesg' after you plug it; check for : usb 2-1: New USB device found, idVendor=18d1, idProduct=4e22

Then create an udev rule as below, for instance in /etc/udev/rules.d/51-android.rules : SUBSYSTEM=="usb", ATTR{idVendor}=="18d1", MODE="0666", GROUP="plugdev"
 * 1) Galaxy S

(This can be further specialized by idProduct.)

Then restart your udev deamon:

If you plug your device, the USB character device should have the "plugdev" group: total 0 crw-rw-r-T 1 root plugdev 189, 140 janv. 19 21:50 013
 * 1) ll /dev/bus/usb/002/

= References =