1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
/**
\page tutorial-create-android-sdk Tutorial: Building ViSP SDK for Android
\tableofcontents
\section android_sdk_intro Introduction
This tutorial is designed to help you build ViSP Android SDK which can be used to create Android Apps supporting ViSP Java functionalities.
\section android_sdk_prereq Prerequisites
This tutorial assumes you have the following software installed and configured: <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java Development Kit (JDK)</a>, <a href="https://developer.android.com/studio/">Android SDK and NDK</a>, <a href="https://www.python.org/downloads/">Python Interpreter</a>, <a href="https://ant.apache.org/bindownload.cgi">Apache Ant</a>, <a href="https://cmake.org/download/">CMake</a>, <a href="https://github.com/ninja-build/ninja/releases">Ninja</a> and <a href="https://ccache.samba.org/">ccache</a>.
\subsection android_sdk_prereq_linux On Ubuntu or debian
- Install <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java Development Kit (JDK)</a>
following \ref java_install_jdk tutorial.
\note At the time this tutorial was written `Java SE Development Kit 17` was incompatible with `gradle`.
If you encounter build issues running `python3 build_sdk.py ...` as described in \ref android_sdk_build section,
you may install `Java SE Development Kit 16`.
- To install <a href="https://developer.android.com/studio/">Android SDK and NDK</a> follow the link to
<a href="https://developer.android.com/studio/">Android Studio</a>, download and install Android Studio.
Once installed start Android Studio using default settings. This allows to download Android SDK that will be installed
in `$HOME/Android/Sdk` on Ubuntu. Now to install Android NDK, with Android Studio
start a new Native C++ Android project using the default configuration. From this new project enter
`"File > Settings... > Appearence > System Settings > Android SDK"` menu. Select the `"SDK Tools"` tab
and check the boxes next to `CMake`, and `NDK (Side by side)`.
Once all the tools are downloaded, you can exit Android Studio.
- Now to install <a href="https://www.python.org/downloads/">Python Interpreter (prefer version 3.x)</a>,
<a href="https://cmake.org/download/">CMake</a>, <a href="https://github.com/ninja-build/ninja/releases">Ninja</a>
and <a href="https://ccache.samba.org/">ccache</a> (a compiler cache for a faster build) run the following:
\code
$ sudo apt-get install python3 ant cmake-curses-gui ninja-build ccache
\endcode
- At the time this tutorial was written, on Ubuntu 20.04 LTS we got Android Studio BumbleBee 2021.1.1 Patch 1,
NDK 23.1 (see \ref android_sdk_ndk_version) and the following other tools versions:
\code
$ java --version
java 16.0.2 2021-07-20
$ python3 --version
Python 3.8.10
$ ant -version
Apache Ant(TM) version 1.10.7 compiled on October 24 2019
$ cmake -version
cmake version 3.23.0-rc1
$ ninja --version
1.10.0
$ ccache --version
ccache version 3.7.7
\endcode
\subsection android_sdk_prereq_osx On Mac OSX
- Install <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java Development Kit (JDK)</a>
following \ref java_install_jdk tutorial.
- To install <a href="https://developer.android.com/studio/">Android SDK and NDK</a> follow the link to
<a href="https://developer.android.com/studio/">Android Studio</a>, download and install Android Studio from dmg.
Once installed start Android Studio using default settings. This allows to download Android SDK that will
be installed in `$HOME/Library/Android/sdk` folder on OSX. Now to install Android NDK, with Android Studio
start a new Native C++ Android project using the default configuration. From this new project enter
`"Android Studio > Preferences > Appearence > System Settings > Android SDK"` menu. Select the `"SDK Tools"` tab
and check the boxes next to `LLDB`, `CMake`, and `NDK (Side by side)`.
Once all the tools are downloaded, you can exit Android Studio.
- Now to install <a href="https://www.python.org/downloads/">Python Interpreter (prefer versions 3.x)</a>,
<a href="https://cmake.org/download/">CMake</a>,
<a href="https://github.com/ninja-build/ninja/releases">Ninja</a>
and <a href="https://ccache.samba.org/">ccache</a> (a compiler cache for a faster build) run the following:
\code
$ brew install python3 ant cmake ninja ccache
\endcode
- At the time this tutorial was written, on macOS Catalina 10.15.7 we got Android Studio 3.5.1, NDK 22.0 (see \ref android_sdk_ndk_version) and the following other tools versions:
\code
$ java --version
openjdk 15.0.1 2020-10-20
$ python3 --version
Python 3.9.1
$ ant -version
Apache Ant(TM) version 1.10.9 compiled on September 27 2020
$ cmake -version
cmake version 3.19.5
$ ninja --version
1.10.2
$ ccache --version
ccache version 4.2
\endcode
\subsection android_sdk_prereq_win On Windows
- Install <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java Development Kit (JDK)</a>
following \ref java_install_jdk tutorial.
- To install <a href="https://developer.android.com/studio/">Android SDK and NDK</a> follow the link to
<a href="https://developer.android.com/studio/">Android Studio</a>,
download and install Android Studio for Windows 64-bit. Once installed start Android Studio using default settings.
This allows to download Android SDK. Now to install Android NDK, with Android Studio create a new Android project.
From this new project enter `"File > Settings... > Appearence & Behavior > System Settings > Android SDK"` menu.
Select the `"SDK Tools"` tab and check the boxes next to `LLDB`, `CMake`, and `NDK (Side by side)`.
Once all the tools are downloaded, you can exit Android Studio.
- Now install <a href="https://www.python.org/downloads/">Python Interpreter</a> without forgetting to add Python to environment variables.
- Download and install latest <a href="https://cmake.org/download/">CMake release</a> using Windows win64-x64 installer without forgetting
to add CMake to the system PATH for all users.
- Download <a href="https://github.com/ninja-build/ninja/releases">Ninja</a> for windows. Place `ninja.exe` in a suitable spot.
For example, in `%%VISP_WS%\Ninja`. Now make sure that CMake can find `ninja.exe` by adding `%%VISP_WS%\Ninja` to your `%%PATH%`.
- Download `ccache` for Windows from github and add its location (`%%VISP_WS%\ccache-win64`) to your `%%PATH%`
\code
C:\> cd %VISP_WS%
C:\> git clone https://github.com/nagayasu-shinya/ccache-win64.git
\endcode
- At the time this tutorial was written, on macOS Mojave 10.14.2 we got Android Studio 3.2.1, NDK 20.0 (see \ref android_sdk_ndk_version) and the following other tools versions:
\code
C:\>java -version
java version 11.0.4 2019-07-16 LTS
C:\>python --version
Python 3.7.4
C:\>cmake -version
cmake version 3.15.2
C:\>ninja --version
1.9.0
C:\>ccache --version
ccache version 3.7.2
\endcode
\section android_sdk_ws Create a workspace
Create a workspace in `$HOME/visp-ws` that will contain ViSP sources, build and dataset.
\code
$ export VISP_WS=$HOME/visp-ws
$ mkdir -p $VISP_WS
\endcode
\section android_sdk_get_source Get ViSP source code
There are different ways to get ViSP source code:
- You can download the <a href="https://visp.inria.fr/download">latest release</a> as a zip or a tarball. Once downloaded, uncompress the file using either
\code
$ tar xvzf visp-x.y.z.tar.gz -C $VISP_WS
\endcode
or
\code
$ unzip visp-x.y.z.zip -d $VISP_WS
\endcode
- You can also download a <a href="https://visp.inria.fr/download#snapshot">daily snapshot</a>. Once downloaded, uncompress the file using
\code
$ tar xvzf visp-snapshot-yyyy-mm-dd.tar.gz -C $VISP_WS
\endcode
- Or you get the cutting-edge ViSP from <a href="https://github.com/lagadic/visp">GitHub repository</a> using the following command
\code
$ cd $VISP_WS
$ git clone https://github.com/lagadic/visp.git
\endcode
We suppose now that ViSP source is in the directory `$VISP_WS/visp`. The following should be adapted if you downloaded ViSP from a zip or tarball. In that case, the source is rather in something like `$VISP_WS/visp-x.y.z`.
\section android_sdk_build Build ViSP Android SDK
Note that the scripts for building the SDK are included in the source code.
In the workspace create a build folder
\code
$ mkdir $VISP_WS/visp-build-android-sdk
\endcode
Enter the directory `$VISP_WS/platforms/android` having the python build script and check which are the command line options that are available.
\code
$ cd $VISP_WS/visp/platforms/android
$ python3 build_sdk.py --help
\endcode
Generally the script has to be used like:
\code
$ python3 build_sdk.py --config <ndk-*.config.py> --sdk_path <path-to-Android-Sdk> --ndk_path <path-to-Android-Sdk>/ndk-bundle <installation-directory> <visp-source-code-directory>
\endcode
In `$VISP_WS/visp/platforms/android` folder we provide different NDK config files:
\code
$ ls ndk-*.config.py
ndk-10.config.py ndk-17.config.py ndk-18.config.py ndk-22.config.py
ndk-16.config.py ndk-18-api-level-21.config.py ndk-20.config.py ndk-23.config.py
\endcode
The file that should be used after `--config` option should match your NDK version (see \ref android_sdk_ndk_version).
Above command will build SDK for multiple Android architectures. If you're aware on what Android architecture you'll be working on (refer <a href="https://android.gadgethacks.com/how-to/android-basics-see-what-kind-processor-you-have-arm-arm64-x86-0168051/">here</a>), say `x86_64`, you can do a minimal build by changing contents of `ndk-*.config.py` file
\code
ABIs = [
ABI("5", "x86_64", None)
]
\endcode
This will speed up the installation process.
Once build ViSP Android SDK will be available in `$VISP_WS/visp-build-android-sdk/ViSP-android-sdk/sdk` folder. Its content should be similar to the following:
\code
$ cd $VISP_WS/visp-build-android-sdk/ViSP-android-sdk/sdk
$ find . -maxdepth 3 -type d
./native
./native/3rdparty
./native/3rdparty/libs
./native/staticlibs
./native/staticlibs/x86_64
./native/staticlibs/arm64-v8a
./native/staticlibs/x86
./native/staticlibs/armeabi-v7a
./native/libs
./native/libs/x86_64
./native/libs/arm64-v8a
./native/libs/x86
./native/libs/armeabi-v7a
./native/jni
./native/jni/abi-armeabi-v7a
./native/jni/include
./native/jni/abi-x86_64
./native/jni/abi-arm64-v8a
./native/jni/abi-x86
./java
./java/src
./java/src/org
./java/javadoc
./java/res
./java/res/values
./etc
./etc/data
./etc/data/robot-simulator
./etc/data/wireframe-simulator
\endcode
\subsection android_sdk_build_linux On Linux or Debian
For example, on Ubuntu 20.04 the command might look like
\code
$ mkdir $VISP_WS/visp-build-android-sdk
$ cd $VISP_WS/visp/platforms/android
$ python3 build_sdk.py --config ndk-23.config.py --sdk_path $HOME/Android/Sdk --ndk_path $HOME/Android/Sdk/ndk/23.1.7779620 $VISP_WS/visp-build-android-sdk $VISP_WS/visp
\endcode
\subsection android_sdk_build_osx On Mac OSX
For example, on OSX the command might rather look like
\code
$ mkdir $VISP_WS/visp-build-android-sdk
$ cd $VISP_WS/visp/platforms/android
$ python3 build_sdk.py --config ndk-23.config.py --sdk_path $HOME/Library/Android/sdk --ndk_path $HOME/Library/Android/sdk/ndk-bundle $VISP_WS/visp-build-android-sdk $VISP_WS/visp
\endcode
\subsection android_sdk_build_win On Windows
For example, on Windows the command might rather look like
\code
C:\> mkdir %VISP_WS%\visp-build-android-sdk
C:\> cd %VISP_WS%\visp\platforms\android
C:\> python3 build_sdk.py --config ndk-23.config.py --sdk_path %USERPROFILE%\AppData\Local\Android\Sdk --ndk_path %USERPROFILE%\AppData\Local\Android\Sdk\ndk\23.1.7779620 %VISP_WS%\visp-build-android-sdk %VISP_WS%\visp
\endcode
\subsection android_sdk_build_issue Known issue
If you're experiencing problems with `ccache` or if you don't install `ccache`, you can try a build without it adding `--no_ccache` command line option like the following on Ubuntu:
\code
$ python3 build_sdk.py --no_ccache --config ndk-18.config.py --sdk_path $HOME/Android/Sdk --ndk_path $HOME/Android/Sdk/ndk-bundle $VISP_WS/visp-build-android-sdk $VISP_WS/visp
\endcode
\section android_sdk_tips Tips & tricks
\subsection android_sdk_ndk_version How to know Android NDK version
- Start Android Studio
- on Ubuntu enter `"File > Settings... > Appearance > System Settings"` menu, while on Mac OSX enter `"Android Studio > Preferences... > Appearance & Behavior > System Settings"` menu, then select `Android SDK` in the left part and select `"SDK Tools"` tab to see which is the NDK version that you are using.
The following swnapshot shows that NDK 18.1 is used:
\image html img-android-ndk-version-18.1.png
This other snapshot shows that NDK 20.0 is used:
\image html img-android-ndk-version-20.0.png
This other snapshot taken on Ubuntu 20.04 with Android Studio 4.1.2 shows that NDK 22.0 is used:
\image html img-android-ndk-version-22.0.png
\section android_sdk_next Next tutorial
You are now ready to follow \ref tutorial-android-getting-started where you'll be creating a sample Android App using ViSP SDK.
*/
|
