ORB_SLAM2在Android上的移植过程

ORB_SLAM2在Android上的移植过程

一直没时间写博客，最近抽时间写了些关于在ORB_SLAM2在Android上的移植过程，也算是点经验吧。

写完后一个手贱点了个链接，瞬间1/3工作量没了，深夜弄完也是醉了。。。

正文开始

---

这篇博客讲述如何在Android平台上移植ORB_SLAM2，讲述过程包括基本的Android环境的搭建和NDK环境的配置，Android下移植的基本概念，ORB的具体移植步骤等。

Android平台搭建和NDK环境配置

---

系统：windows7 32bit
IDE:Eclipse Luna
环境工具: ADT24.0.2、Android SDK、NDK r10b

PS:不推荐使用集成了ADT环境的Eclipse版本，因为在NDK编译的时候可能会报各种莫名其妙的错。同时默认JDK环境已经装好。

组件下载地址：百度网盘(包括ADT、NDK。SDK太大，请自行下载)

步骤：

安装Eclipse，注意区分Eclipse是32位还是64位的，下载对应版本安装即可。下载地址在前面给出。 下载ADT，不需要解压。打开安装好的Eclipse,在菜单栏点击Help–>Install new software,弹出如下界面：
点击右上角Add,出现：

第一栏随便填个名字，例如ADT，第二栏点击Archive，选择你下载的ADT压缩包，确定。在出现的列表中，全部选中，并取消勾选Contact all update sites….。点击next，则开始了ADT的安装，大概需要10分钟。可能还需要accept 协议什么的，这里略过不表。安装完成后提示重启Eclipse即安装成功。 下载Android SDK,并解压(路径不要有中文)。在Eclipse中选择Window–>preferences。在左边栏选中Android,在SDK Location中填入你解压文件夹的根目录，点击apply和OK，则Android环境配置基本完成。这是你的菜单栏应该有了这两项
更新SDK。点击Window–>Android SDK manager，弹出如下界面：

可能由于墙的问题会弹出列表无法加载，需要用代理或镜像，当然如果你有梯子也可以。这里介绍些镜像吧：
g.cn:80，在SDK Manager 中点击tools–>options:

按照上图设置即可。其他的镜像源还有北京化工大学镜像站，请自行谷狗。设置好后点击Packages–>reload即可得到对应的镜像。有默认选中的一些选项，一般选中一个sdk tools，一份sdk build-platform-tools，一个sdk build tools,然后一个Android版本即可（一般4.0以上）。选中后点击Install就会从镜像中下载对应的SDK，这个过程有长有短，视网络而定。
当上述步骤都完成后，Android开发环境就配置好了。 NDK环境配置：从上面给的百度网盘中下载ndk，解压（规则同sdk），打开Eclipse，点击Window–>Preferences，选择Android–>NDK，在右边界面中填入NDK Location即可。

Android移植基础

---

NDK是集成的Android中调用C++代码的工具包，核心是JNI（Java Native Interface）技术，具体这里略过不表。只说说NDK开发的基本步骤：
1. 编写Java代码：在Java中定义一个类，比如说叫NDKHelper吧，里面定义几个java的方法，只需要声明，不需要实现，如下所示:

public class NDKHelper {
    //NDK示例方法1
    public static native void ndkOne(int a,long b);

    //NDK示例方法2
    public static native int ndkTwo(String a,String b);
}

native标识符表示该函数将会利用C++代码完成实现。
接下来在工程上右键，Android Tools–>Add native support，出现如下界面：

名字就是最后我们要生成的库的名字，随便填，可修改。点击确定就会给你的工程添加C++编译支持，菜单栏会多了个小锤子：

这个是用来编译C++的快捷键。在你的工程目录下会新建jni目录和obj目录，其中jni目录用来存放和C++代码有关的东西，obj则存放C++进行编译时产生的中间件，最后生成的library会写入到libs文件夹下。
在jni文件夹中生成了如下文件，一个.cpp，一个Android.mk，其中.cpp是自动生成的，是用来编写C++部分的，而Android.mk类似C++里面的CMakeList，用来指定需要编译的文件和编译生成的模块名，一个最简单的Android.mk文件如下所示：

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE    := NDKTest
LOCAL_SRC_FILES := NDKTest.cpp
include $(BUILD_SHARED_LIBRARY)

LOCAL_PATH :=$(call my-dir)表示包含当前目录。
include $(CLEAR_VARS)表示清除全部非系统变量和部分系统变量；
LOCAL_MODULE := NDKTest 表示当前生成的模块名，最终会生成libNDKTest.so文件
LOCAL_SRC_FILES := NDKTest.cpp 表示当前需要编译的cpp文件；
include $(BUILD_SHARED_LIBRARY) 表示生成共享库，需要生成静态库请修改成BUILD_STATIC_LIBRARY。

其他基础命令：
LOCAL_C_INCLUDES:= 表示添加头文件进入编译环境
LOCAL_LDLIBS:= 表示添加系统静态库
LOCAL_SHARED_LIBRARIES:= 表示添加共享库
其他命令请自行查看API文档。

这里指定了进行编译时的各项条件，如果需要指定编译器版本和编译目标平台等信息，则需要在jni目录下新建Application.mk文件，基本语句如下：

APP_STL := gnustl_static
APP_CPPFLAGS := -frtti -fexceptions 
NDK_TOOLCHAIN_VERSION := 4.8
APP_ABI :=armeabi-v7a

APP_STL :=表示使用stl库，APP_CPPFLAGS表示一些CPP编译参数，NDK_TOOLCHAIN_VERSION 表示NDK使用的编译器版本，APP_ABI表示编译的目标平台，可以指定多个平台，平台之间用空格隔开，或者指定all则为全平台编译(armeabi,armeabi-v7a,mips,x86)。其他命令请自行查看API。

接下来编写对应的C++文件。
打开eclipse，点击Project–>build Project(若build automatically已勾选则会自动编译)打开命令行，cd到你的工程文件夹下的bin–>classes文件夹下，输入如下命令:

javah com.example.ndktest.NDKHelper

回车，则在你的classes文件夹下会生成对应的头文件。这里com.example.ndktest是你的package名字，NDKHelper是你的NDK函数的类名。
生成的头文件如下：

/* DO NOT EDIT THIS FILE - it is machine generated */
#include 
/* Header for class com_example_ndktest_NDKHelper */

#ifndef _Included_com_example_ndktest_NDKHelper
#define _Included_com_example_ndktest_NDKHelper
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     com_example_ndktest_NDKHelper
 * Method:    ndkOne
 * Signature: (IJ)V
 */
JNIEXPORT void JNICALL Java_com_example_ndktest_NDKHelper_ndkOne
  (JNIEnv *, jclass, jint, jlong);

/*
 * Class:     com_example_ndktest_NDKHelper
 * Method:    ndkTwo
 * Signature: (Ljava/lang/String;Ljava/lang/String;)I
 */
JNIEXPORT jint JNICALL Java_com_example_ndktest_NDKHelper_ndkTwo
  (JNIEnv *, jclass, jstring, jstring);

#ifdef __cplusplus
}
#endif
#endif

其他不用管，我们关注中间的两个函数声明：

JNIEXPORT void JNICALL Java_com_example_ndktest_NDKHelper_ndkOne(JNIEnv *, jclass, jint, jlong);

这个函数就是NDKHelper类中ndkOne函数对应的C++版本，其中JNIEXPORT和JNICALL是固定字段，void是函数返回值，函数名由Java字段+包名+类名+函数名组成，参数则多了几个JNI的系统参数JNIEnv 和jclass，其他的就是NDKHelper类中的对应参数，ndk会对该函数进行解析和链接，实现java和C++的对接。
将生成的.h头文件复制到jni目录下，新建对应的cpp文件，将该头文件include进来并对对应函数进行实现，实现过程就视函数功能而定。
这些工作完成后需要修改你的Android.mk文件，将刚刚新建的cpp和h文件包括进来。
然后点击开始那个小锤子或者直接项目右键RunAs–>Android Application，则C++部分会开始编译，编译具体过程可以在Eclipse下方Console窗口看到(如果没有Console窗口则点击Window–>Show Views，选择Console确定即可)。
编译完成后会生成对应的库存放在libs目录下，则你可以开始在Java里面调用刚才定义的ndkOne和ndkTwo函数实现具体的功能。

NDK基础到此为止，更深入的学习可以下载Android官方给的ndk samples.

ORB_SLAM2的移植

---

不想