Android Development with OpenCV {#tutorial_dev_with_OCV_on_Android}
===============================

@prev_tutorial{tutorial_O4A_SDK}
@next_tutorial{tutorial_android_ocl_intro}

|    |    |
| -: | :- |
| Original author | Vsevolod Glumov |
| Compatibility | OpenCV >= 3.0 |

@warning
This tutorial is deprecated.

This tutorial has been created to help you use OpenCV library within your Android project.

This guide was written with Windows 7 in mind, though it should work with any other OS supported by
OpenCV4Android SDK.

This tutorial assumes you have the following installed and configured:

-   JDK
-   Android SDK and NDK
-   Eclipse IDE
-   ADT and CDT plugins for Eclipse

If you need help with anything of the above, you may refer to our @ref tutorial_android_dev_intro guide.

This tutorial also assumes you have OpenCV4Android SDK already installed on your development machine
and OpenCV Manager on your testing device correspondingly. If you need help with any of these, you
may consult our @ref tutorial_O4A_SDK tutorial.

If you encounter any error after thoroughly following these steps, feel free to contact us via
[OpenCV4Android](https://groups.google.com/group/android-opencv/) discussion group or OpenCV [Q&A
forum](http://answers.opencv.org) . We'll do our best to help you out.

Using OpenCV Library Within Your Android Project
------------------------------------------------

In this section we will explain how to make some existing project to use OpenCV. Starting with 2.4.2
release for Android, *OpenCV Manager* is used to provide apps with the best available version of
OpenCV. You can get more information here: `Android OpenCV Manager` and in these
[slides](https://docs.google.com/a/itseez.com/presentation/d/1EO_1kijgBg_BsjNp2ymk-aarg-0K279_1VZRcPplSuk/present#slide=id.p).

### Java

#### Application Development with Async Initialization

Using async initialization is a **recommended** way for application development. It uses the OpenCV
Manager to access OpenCV libraries externally installed in the target system.

-#  Add OpenCV library project to your workspace. Use menu
    File -\> Import -\> Existing project in your workspace.

    Press Browse button and locate OpenCV4Android SDK (`OpenCV-2.4.9-android-sdk/sdk`).

    ![](images/eclipse_opencv_dependency0.png)

-#  In application project add a reference to the OpenCV Java SDK in
    Project -\> Properties -\> Android -\> Library -\> Add select OpenCV Library - 2.4.9.

    ![](images/eclipse_opencv_dependency1.png)

In most cases OpenCV Manager may be installed automatically from Google Play. For the case, when
Google Play is not available, i.e. emulator, developer board, etc, you can install it manually using
adb tool. See `Manager Selection` for details.

There is a very base code snippet implementing the async initialization. It shows basic principles.
See the "15-puzzle" OpenCV sample for details.
@code{.java}
public class Sample1Java extends Activity implements CvCameraViewListener {

    private BaseLoaderCallback mLoaderCallback = new BaseLoaderCallback(this) {
        @Override
        public void onManagerConnected(int status) {
            switch (status) {
                case LoaderCallbackInterface.SUCCESS:
                {
                    Log.i(TAG, "OpenCV loaded successfully");
                    mOpenCvCameraView.enableView();
                } break;
                default:
                {
                    super.onManagerConnected(status);
                } break;
            }
        }
    };

    @Override
    public void onResume()
    {
        super.onResume();
        OpenCVLoader.initAsync(OpenCVLoader.OPENCV_VERSION_2_4_6, this, mLoaderCallback);
    }

    ...
}
@endcode
It this case application works with OpenCV Manager in asynchronous fashion. OnManagerConnected
callback will be called in UI thread, when initialization finishes. Please note, that it is not
allowed to use OpenCV calls or load OpenCV-dependent native libs before invoking this callback. Load
your own native libraries that depend on OpenCV after the successful OpenCV initialization. Default
BaseLoaderCallback implementation treat application context as Activity and calls Activity.finish()
method to exit in case of initialization failure. To override this behavior you need to override
finish() method of BaseLoaderCallback class and implement your own finalization method.

#### Application Development with Static Initialization

According to this approach all OpenCV binaries are included into your application package. It is
designed mostly for development purposes. This approach is deprecated for the production code,
release package is recommended to communicate with OpenCV Manager via the async initialization
described above.

-#  Add the OpenCV library project to your workspace the same way as for the async initialization
    above. Use menu File -\> Import -\> Existing project in your workspace, press Browse button and
    select OpenCV SDK path (`OpenCV-2.4.9-android-sdk/sdk`).

    ![](images/eclipse_opencv_dependency0.png)

-#  In the application project add a reference to the OpenCV4Android SDK in
    Project -\> Properties -\> Android -\> Library -\> Add select OpenCV Library - 2.4.9;

    ![](images/eclipse_opencv_dependency1.png)

-#  If your application project **doesn't have a JNI part**, just copy the corresponding OpenCV
    native libs from `<OpenCV-2.4.9-android-sdk>/sdk/native/libs/<target_arch>` to your project
    directory to folder `libs/<target_arch>`.

    In case of the application project **with a JNI part**, instead of manual libraries copying you
    need to modify your Android.mk file: add the following two code lines after the
    "include $(CLEAR_VARS)" and before
    "include path_to_OpenCV-2.4.9-android-sdk/sdk/native/jni/OpenCV.mk"
    @code{.make}
    OPENCV_CAMERA_MODULES:=on
    OPENCV_INSTALL_MODULES:=on
    @endcode
    The result should look like the following:
    @code{.make}
    include $(CLEAR_VARS)

    # OpenCV
    OPENCV_CAMERA_MODULES:=on
    OPENCV_INSTALL_MODULES:=on
    include ../../sdk/native/jni/OpenCV.mk
    @endcode
    After that the OpenCV libraries will be copied to your application `libs` folder during the JNI
    build.v

    Eclipse will automatically include all the libraries from the `libs` folder to the application
    package (APK).

-#  The last step of enabling OpenCV in your application is Java initialization code before calling
    OpenCV API. It can be done, for example, in the static section of the Activity class:
    @code{.java}
    static {
        if (!OpenCVLoader.initDebug()) {
            // Handle initialization error
        }
    }
    @endcode
    If you application includes other OpenCV-dependent native libraries you should load them
    **after** OpenCV initialization:
    @code{.java}
    static {
        if (!OpenCVLoader.initDebug()) {
            // Handle initialization error
        } else {
            System.loadLibrary("my_jni_lib1");
            System.loadLibrary("my_jni_lib2");
        }
    }
    @endcode

### Native/C++

To build your own Android application, using OpenCV as native part, the following steps should be
taken:

-#  You can use an environment variable to specify the location of OpenCV package or just hardcode
    absolute or relative path in the `jni/Android.mk` of your projects.
-#  The file `jni/Android.mk` should be written for the current application using the common rules
    for this file.

    For detailed information see the Android NDK documentation from the Android NDK archive, in the
    file `<path_where_NDK_is_placed>/docs/ANDROID-MK.html`.

-#  The following line:
    @code{.make}
    include C:\Work\OpenCV4Android\OpenCV-2.4.9-android-sdk\sdk\native\jni\OpenCV.mk
    @endcode
    Should be inserted into the `jni/Android.mk` file **after** this line:
    @code{.make}
    include $(CLEAR_VARS)
    @endcode
-#  Several variables can be used to customize OpenCV stuff, but you **don't need** to use them when
    your application uses the async initialization via the OpenCV Manager API.

    @note These variables should be set **before** the "include .../OpenCV.mk" line:
    @code{.make}
    OPENCV_INSTALL_MODULES:=on
    @endcode

    Copies necessary OpenCV dynamic libs to the project libs folder in order to include them
    into the APK.
    @code{.make}
    OPENCV_CAMERA_MODULES:=off
    @endcode
    Skip native OpenCV camera related libs copying to the project libs folder.
    @code{.make}
    OPENCV_LIB_TYPE:=STATIC
    @endcode
    Perform static linking with OpenCV. By default dynamic link is used and the project JNI lib
    depends on libopencv_java.so.

-#  The file `Application.mk` should exist and should contain lines:
    @code{.make}
    APP_STL := gnustl_static
    APP_CPPFLAGS := -frtti -fexceptions
    @endcode
    Also, the line like this one:
    @code{.make}
    APP_ABI := armeabi-v7a
    @endcode
    Should specify the application target platforms.

    In some cases a linkage error (like
    `"In function 'cv::toUtf16(std::basic_string<...>... undefined reference to 'mbstowcs'"`)
    happens when building an application JNI library, depending on OpenCV. The following line in the
    `Application.mk` usually fixes it:
    @code{.make}
    APP_PLATFORM := android-9
    @endcode

-#  Either use @ref tutorial_android_dev_intro_ndk "manual"  ndk-build invocation or
    @ref tutorial_android_dev_intro_eclipse "setup Eclipse CDT Builder" to build native JNI lib
    before (re)building the Java part and creating
    an APK.

Hello OpenCV Sample
-------------------

Here are basic steps to guide you trough the process of creating a simple OpenCV-centric
application. It will be capable of accessing camera output, processing it and displaying the result.

-#  Open Eclipse IDE, create a new clean workspace, create a new Android project
    File --\> New --\> Android Project
-#  Set name, target, package and minSDKVersion accordingly. The minimal SDK version for build with
    OpenCV4Android SDK is 11. Minimal device API Level (for application manifest) is 8.
-#  Allow Eclipse to create default activity. Lets name the activity HelloOpenCvActivity.
-#  Choose Blank Activity with full screen layout. Lets name the layout HelloOpenCvLayout.
-#  Import OpenCV library project to your workspace.
-#  Reference OpenCV library within your project properties.

    ![](images/dev_OCV_reference.png)

-#  Edit your layout file as xml file and pass the following layout there:
    @code{.xml}
    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        xmlns:opencv="http://schemas.android.com/apk/res-auto"
        android:layout_width="match_parent"
        android:layout_height="match_parent" >

        <org.opencv.android.JavaCameraView
            android:layout_width="fill_parent"
            android:layout_height="fill_parent"
            android:visibility="gone"
            android:id="@+id/HelloOpenCvView"
            opencv:show_fps="true"
            opencv:camera_id="any" />

    </LinearLayout>
    @endcode
-#  Add the following permissions to the `AndroidManifest.xml` file:
    @code{.xml}
    </application>

    <uses-permission android:name="android.permission.CAMERA"/>

    <uses-feature android:name="android.hardware.camera" android:required="false"/>
    <uses-feature android:name="android.hardware.camera.autofocus" android:required="false"/>
    <uses-feature android:name="android.hardware.camera.front" android:required="false"/>
    <uses-feature android:name="android.hardware.camera.front.autofocus" android:required="false"/>
    @endcode
-#  Set application theme in AndroidManifest.xml to hide title and system buttons.
    @code{.xml}
    <application
        android:icon="@drawable/icon"
        android:label="@string/app_name"
        android:theme="@android:style/Theme.NoTitleBar.Fullscreen" >
    @endcode
-#  Add OpenCV library initialization to your activity. Fix errors by adding required imports.
    @code{.java}
    private BaseLoaderCallback mLoaderCallback = new BaseLoaderCallback(this) {
        @Override
        public void onManagerConnected(int status) {
            switch (status) {
                case LoaderCallbackInterface.SUCCESS:
                {
                    Log.i(TAG, "OpenCV loaded successfully");
                    mOpenCvCameraView.enableView();
                } break;
                default:
                {
                    super.onManagerConnected(status);
                } break;
            }
        }
    };

    @Override
    public void onResume()
    {
        super.onResume();
        OpenCVLoader.initAsync(OpenCVLoader.OPENCV_VERSION_2_4_6, this, mLoaderCallback);
    }
    @endcode
-#  Defines that your activity implements CvCameraViewListener2 interface and fix activity related
    errors by defining missed methods. For this activity define onCreate, onDestroy and onPause and
    implement them according to the code snippet below. Fix errors by adding required imports.
    @code{.java}
    private CameraBridgeViewBase mOpenCvCameraView;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        Log.i(TAG, "called onCreate");
        super.onCreate(savedInstanceState);
        getWindow().addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON);
        setContentView(R.layout.HelloOpenCvLayout);
        mOpenCvCameraView = (CameraBridgeViewBase) findViewById(R.id.HelloOpenCvView);
        mOpenCvCameraView.setVisibility(SurfaceView.VISIBLE);
        mOpenCvCameraView.setCvCameraViewListener(this);
    }

    @Override
    public void onPause()
    {
        super.onPause();
        if (mOpenCvCameraView != null)
            mOpenCvCameraView.disableView();
    }

    public void onDestroy() {
        super.onDestroy();
        if (mOpenCvCameraView != null)
            mOpenCvCameraView.disableView();
    }

    public void onCameraViewStarted(int width, int height) {
    }

    public void onCameraViewStopped() {
    }

    public Mat onCameraFrame(CvCameraViewFrame inputFrame) {
        return inputFrame.rgba();
    }
    @endcode
-#  Run your application on device or emulator.

Lets discuss some most important steps. Every Android application with UI must implement Activity
and View. By the first steps we create blank activity and default view layout. The simplest
OpenCV-centric application must implement OpenCV initialization, create its own view to show preview
from camera and implements CvCameraViewListener2 interface to get frames from camera and process it.

First of all we create our application view using xml layout. Our layout consists of the only one
full screen component of class org.opencv.android.JavaCameraView. This class is implemented inside
OpenCV library. It is inherited from CameraBridgeViewBase, that extends SurfaceView and uses
standard Android camera API.

After creating layout we need to implement Activity class. OpenCV initialization process has been
already discussed above. In this sample we use asynchronous initialization. Implementation of
CvCameraViewListener interface allows you to add processing steps after frame grabbing from camera
and before its rendering on screen. The most important function is onCameraFrame. It is callback
function and it is called on retrieving frame from camera. The callback input is object of
CvCameraViewFrame class that represents frame from camera.

@note Do not save or use CvCameraViewFrame object out of onCameraFrame callback. This object does
not have its own state and its behavior out of callback is unpredictable!

It has rgba() and gray()
methods that allows to get frame as RGBA and one channel gray scale Mat respectively. It expects
that onCameraFrame function returns RGBA frame that will be drawn on the screen.
