Project

General

Profile

Start to build Scol using CMAKE » History » Version 39

lpousse, 04/02/2019 03:41 PM

1 1 arkeon
h1. Start to build Scol using CMAKE
2 1 arkeon
3 1 arkeon
4 20 brainsandwich
h2. Tools
5 1 arkeon
6 20 brainsandwich
h3. Common to all platforms
7 1 arkeon
8 39 lpousse
* "CMake":http://www.cmake.org/download/ (While installing, allow CMake to add the CMake directory to the PATH)
9 39 lpousse
* Visual Studio Community 2015 Update 3
10 20 brainsandwich
* "Tortoise SVN":http://tortoisesvn.net/ (or any SVN client)
11 20 brainsandwich
* "Tortoise git":https://code.google.com/p/tortoisegit/ (or any Git client too)
12 1 arkeon
13 1 arkeon
h3. Windows target
14 1 arkeon
15 39 lpousse
* "DirectX9 SDK:https://www.microsoft.com/en-us/download/details.aspx?id=6812
16 39 lpousse
If the installation fails: https://support.microsoft.com/fr-fr/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010
17 39 lpousse
* a Perl installation (such as "Strawberry Perl":http://strawberryperl.com/)
18 39 lpousse
Be careful not to let Perl add paths to c headers and executables to your path as it can mess with your build environnement
19 39 lpousse
20 39 lpousse
The minimum compiler supported is the one in Visual Studio 2015.
21 20 brainsandwich
You can try with a newer version at your own risks !
22 1 arkeon
23 20 brainsandwich
h3. Android target
24 1 arkeon
25 20 brainsandwich
_With standard tools_
26 1 arkeon
27 20 brainsandwich
i.e. free tools found on the web or provided by Google
28 1 arkeon
29 20 brainsandwich
* "Java Development Kit (JDK)":http://www.oracle.com/technetwork/java/javase/downloads
30 20 brainsandwich
* "Android SDK":https://developer.android.com/sdk/installing
31 20 brainsandwich
* "Native Development Kit (NDK)":https://developer.android.com/tools/sdk/ndk
32 20 brainsandwich
* "Apache ANT":http://ant.apache.org/
33 1 arkeon
34 20 brainsandwich
_With Tegra Android Development Pack_
35 10 brainsandwich
36 20 brainsandwich
A package provided by Nvidia to build applications for Android. The download process requires authentication to the Nvidia Developper Network (it's free and not too spammy though)
37 20 brainsandwich
38 20 brainsandwich
* "TADP":https://developer.nvidia.com/gameworksdownload
39 20 brainsandwich
* On setup, let it download everything or at least the tools described in the previous section.
40 1 arkeon
41 20 brainsandwich
_SDK preparation_
42 20 brainsandwich
43 20 brainsandwich
You should launch the SDK to download other tools like emulators for each API you want to target.
44 39 lpousse
(Our target API is 19 so you can get any emulator above).
45 20 brainsandwich
46 20 brainsandwich
h3. Linux target
47 20 brainsandwich
48 30 arkeon
TODO.
49 20 brainsandwich
50 20 brainsandwich
h3. Mac OS target
51 20 brainsandwich
52 31 arkeon
TODO.
53 20 brainsandwich
54 7 brainsandwich
h2. Get the Scol sources
55 1 arkeon
56 20 brainsandwich
Scol uses Subversion for source control and you can use your SVN client to get the source code.
57 6 arkeon
58 1 arkeon
So first retrieve the sources from "https://svn.scolring.org/trunk/", accept the certificate and go take some coffee.
59 1 arkeon
The source directories contains most of the dependencies, and since some of them are modified they are provided in the sources.
60 7 brainsandwich
61 20 brainsandwich
Some sources like curl use Git as source control and are downloaded when building, so make sure it's installed before building the project
62 7 brainsandwich
63 20 brainsandwich
64 20 brainsandwich
65 1 arkeon
h2. Dependencies search paths
66 8 brainsandwich
67 1 arkeon
h3. Windows
68 1 arkeon
69 1 arkeon
Once you get the sources, you can execute "setWindowsSearchPaths.bat" in the dependencies directory.
70 1 arkeon
!!WARNING!! when you execute the bat file using the mouse the current directory is wrong.
71 1 arkeon
You need to start a DOS command line "cmd.exe" as administrator and go to the dependencies directory to start the bat file manually.
72 1 arkeon
 
73 1 arkeon
This will add needed environment variables and paths.
74 1 arkeon
75 1 arkeon
h3. Android
76 1 arkeon
77 20 brainsandwich
If you downloaded the TADP, the following variables are likely to be defined already (or they should look alike).
78 20 brainsandwich
If not, add these to the environment variables
79 1 arkeon
* ANDROID_HOME : path/to/sdk
80 1 arkeon
* ANDROID_SDK_HOME : path/to/sdk
81 1 arkeon
* ANDROID_SDK : path/to/sdk
82 1 arkeon
* ANDROID_NDK : path/to/ndk
83 1 arkeon
* ANT_HOME : path/to/ant
84 7 brainsandwich
* JAVA_HOME : path/to/jdk -- should be something like "C:\Progra~1\Java\<jdkfolder>"
85 1 arkeon
* CMAKE : path/to/cmake
86 7 brainsandwich
87 20 brainsandwich
Then you should add these variables into the PATH:
88 1 arkeon
89 20 brainsandwich
@%ANDROID_NDK%;%ANT_HOME%\bin;%ANDROID_SDK%\tools;%ANDROID_SDK%\platform-tools;%CMAKE%;%JAVA_HOME%\bin;@
90 1 arkeon
91 36 arkeon
92 36 arkeon
93 1 arkeon
94 36 arkeon
h2. Build needed dependencies
95 36 arkeon
96 36 arkeon
h3. From Windows, for Windows
97 32 arkeon
98 39 lpousse
To compile for 64 bits Windows, specify the 64 bits toolchain (trunk/dependencies/CMake/toolchain/win64.toolchain.cmake) for each CMake configuration, and replace every instance of "x86" by "x64" in the instructions below
99 37 arkeon
100 39 lpousse
Launch cmake-gui from a Visual Studio command line (it configures the environment so you can build things correctly)
101 22 hector
# Specify the source folder to trunk/dependencies and the build to trunk/dependencies/build/windows/x86
102 39 lpousse
# Hit Configure. In the message box, select your Visual Studio version as generator, and check "Use default native compilers" (for 64 bits, select the 64 bits variant of you VS version, select "Specify toolchain file for cross-compiling" and select the toolchain mentioned above). This first configure will take some time as it will download and compile some of the basic dependencies.
103 1 arkeon
104 1 arkeon
You will see a list of categories, under which are variables to tweak build parameters.
105 1 arkeon
The category SCOLDEPS contains CMake variables that enable/disable the build of individual SCOL dependencies.
106 1 arkeon
Some of these dependencies depend on one or several others. Since CMake needs to detect these "sub-dependencies" when configuring,
107 21 hector
we need to make several build passes, in order to build said "sub-dependencies" before the dependencies that depend on them.
108 21 hector
109 21 hector
# Leave all variables at their default values.
110 21 hector
# Keep hitting Configure until no variables are highlighted in red.
111 1 arkeon
# Hit Generate to generate a Visual Studio project.
112 1 arkeon
# Build the project in Visual Studio (Build->Batch Build, check debug and release for "INSTALL" configuration).
113 39 lpousse
# When the build is done, in CMake, check HYDRAX and SKYX under SCOLDEPS (leave the other variables as they are).
114 21 hector
# Hit Configure again. When configuring is done, you will see new variables appear in red. Leave them at their default values.
115 1 arkeon
# Repeat steps 2 to 4.
116 1 arkeon
# HYDRAX / SKYX build might fail due to header conflicts. To solve them, in Visual Studio :
117 1 arkeon
## In the solution explorer, open the properties of the *RenderSystem_Direct3D11* project.
118 1 arkeon
## In the properties window, Select *All configurations*.
119 25 hector
## Under *Configuration Properties* > *C/C++* > *General*, modify the *Other include directories* entry.
120 1 arkeon
## In the directories list, move the directory at the bottom all the way to the top.
121 22 hector
## Save the changes.
122 24 hector
## Repeat the same steps for the *RenderSystem_Direct3D9* project.
123 1 arkeon
## Re-run the build.
124 39 lpousse
# Optionnal: Check SCOLDEPS_BUILD_TUIO and SCOLDEPS_BUILD_TUIO, hit configure and repeat steps 2 to 4.
125 38 aurelio
126 39 lpousse
Almost everything is built with CMAKE, but FFMPEG still need manual process.
127 39 lpousse
Check the trunk/dependencies/ffmpeg/sources/README.txt file
128 39 lpousse
# sh ffmpeg_build.sh win32 release $SCOL_DEPENDENCIES_PATH/ffmpeg/sources/FFmpeg $SCOL_DEPENDENCIES_PATH/ffmpeg/sdk/windows/x86
129 39 lpousse
130 26 hector
Now every required dependency should be built. The ones that we left unchecked aren't needed.
131 26 hector
132 26 hector
h3. From Windows, for Android
133 26 hector
134 39 lpousse
Supported ABIs : armeabi-v7a, arm64-v8a, x86, x86_64
135 39 lpousse
Android API version : 19 (21 for 64 bits ABIs)
136 39 lpousse
137 7 brainsandwich
Do the same as for Windows target, but
138 39 lpousse
* If you did not already make a Windows build, run trunk/dependencies/boost/bootstrap.bat from a Visual Studio command line
139 39 lpousse
* Set source folder to trunk/dependencies and build folder to trunk/scol/build/android/<target ABI> (More generally, replace every instance of "windows/x86" in the build and install paths by "android/<target ABI>")
140 20 brainsandwich
* Specify the generator : "NMake"
141 39 lpousse
* The toolchain for crosscompile : trunk/dependencies/CMake/toolchain/android.<target ABI>.toolchain.cmake
142 39 lpousse
* When building the Scol dependencies uncheck CAUDIO_ENABLE_REROUTE_STL_ALLOCATIONS
143 39 lpousse
* Build dependencies with "nmake install" command from a Visual Studio command line.
144 39 lpousse
* FFmpeg build command line : ./ffmpeg_build.sh android release $SCOL_DEPENDENCIES_PATH/ffmpeg/sources/FFmpeg $SCOL_DEPENDENCIES_PATH/ffmpeg/sdk/android/<target ABI> $ANDROID_NDK <Android API version> <target ABI> $SCOL_DEPENDENCIES_PATH/sdk/android/<target ABI>
145 13 brainsandwich
146 13 brainsandwich
147 19 brainsandwich
148 20 brainsandwich
149 19 brainsandwich
h2. Build the Scol project
150 13 brainsandwich
151 20 brainsandwich
As for the dependencies:
152 13 brainsandwich
153 20 brainsandwich
h3. Windows target
154 3 arkeon
155 20 brainsandwich
* Set source folder to trunk/scol and build folder to trunk/scol/build/windows/x86
156 20 brainsandwich
* Configure, generate and build from Visual Studio
157 20 brainsandwich
158 20 brainsandwich
h3. Android target
159 20 brainsandwich
160 20 brainsandwich
* Set source folder to trunk/scol and build folder to trunk/scol/build/android/<target abi>
161 20 brainsandwich
* If you're using Nsight with Visual Studio (TADP), some build paramaters should be modified for each build if you want to install and test the project on a device :
162 20 brainsandwich
  - Open ScolLauncher subproject -> properties
163 20 brainsandwich
  - Configuration Properties -> General -> Configuration Type -> Make Application (ndk-build -> .apk|.so|.a)
164 20 brainsandwich
  - Configuration Properties -> Deployment -> Fast Deploy -> No
165 20 brainsandwich
  - Configuration Properties -> Ant Build -> Skip Ant Step -> No
166 20 brainsandwich
* Without TADP, after it's build, go to trunk/scol/build/android/<target abi>/App/bin, and run "ant debug install" if you wish to install the project on an emulator or your device  
167 1 arkeon
168 1 arkeon
h1. Start your new plugin
169 1 arkeon
170 1 arkeon
h2. Source paths
171 1 arkeon
172 1 arkeon
Start by creating a directory with your new plugin name in the trunk/scol/plugins folder.
173 1 arkeon
For example trunk/scol/plugins/myPlugin
174 4 arkeon
175 4 arkeon
Usually we prefer to separate the sources and the includes.
176 1 arkeon
So creates a "src" and "include" directory in your plugin folder.
177 1 arkeon
178 1 arkeon
Creates the empty files you will need for your project, usually :
179 1 arkeon
- include/myplugin.h for your classes declaration
180 1 arkeon
- src/myplugin.cpp for your classes definition
181 1 arkeon
- src/scolplugin.cpp for the Scol binding functions
182 1 arkeon
183 1 arkeon
h2. Dependencies
184 1 arkeon
185 1 arkeon
If your project need an external SDK or dependencies, add then in the trunk/dependencies directory.
186 1 arkeon
Then create a findMydepname.cmake file in trunk\scol\CMake\Packages.
187 1 arkeon
You can copy and change an existing Find.cmake file to make yours.
188 1 arkeon
Start from a simple one like FindMyo.cmake for example.
189 1 arkeon
190 1 arkeon
h2. Cmake files
191 1 arkeon
192 1 arkeon
It's time to creates the CMAKE script for your plugin.
193 1 arkeon
194 1 arkeon
Create a "CMakeLists.txt" file in the plugin directory.
195 1 arkeon
trunk/scol/plugins/myPlugin/CMakeLists.txt
196 1 arkeon
197 1 arkeon
And edit the file with a text editor.
198 1 arkeon
199 1 arkeon
<pre>
200 1 arkeon
#-------------------------------------------------------------------
201 1 arkeon
# This file is part of the CMake build system for Scol
202 1 arkeon
#
203 1 arkeon
# The contents of this file are placed in the public domain. Feel
204 1 arkeon
# free to make use of it in any way you like.
205 1 arkeon
#-------------------------------------------------------------------
206 1 arkeon
207 1 arkeon
############################################################
208 1 arkeon
# CmakeList file for Myplugin
209 1 arkeon
############################################################
210 1 arkeon
211 1 arkeon
#Your project name
212 1 arkeon
PROJECT(myPLugin)
213 1 arkeon
214 1 arkeon
# define header and source files for the library
215 1 arkeon
set (MYPLUGIN_HEADER_FILES
216 1 arkeon
  include/myplugin.h
217 1 arkeon
)
218 1 arkeon
219 1 arkeon
set (MYPLUGIN_SOURCE_FILES
220 1 arkeon
  src/myplugin.cpp
221 1 arkeon
  src/scolplugin.cpp
222 1 arkeon
)
223 1 arkeon
224 1 arkeon
# Add includes directories from dependencies
225 1 arkeon
#  include_directories(include ${MYDEP_INCLUDE_DIRS})
226 1 arkeon
227 1 arkeon
# Add definition for P4 optimizations, warnings removal.
228 1 arkeon
add_definitions(-DOPTI_P4 -D_CRT_SECURE_NO_WARNINGS -D)
229 1 arkeon
230 1 arkeon
# Add dependencies libraries
231 1 arkeon
#  set(LIBRARIES
232 1 arkeon
#    ${MYDEP_LIBRARIES}
233 1 arkeon
#    ${ZLIB_LIBRARIES}
234 1 arkeon
#    ${PNG_LIBRARIES}
235 1 arkeon
#  )
236 1 arkeon
237 1 arkeon
# setup Scol plugin target
238 1 arkeon
add_library(myPLugin
239 1 arkeon
  ${Scol_LIB_TYPE}
240 1 arkeon
  ${MYPLUGIN_HEADER_FILES}
241 1 arkeon
  ${MYPLUGIN_SOURCE_FILES}
242 1 arkeon
)
243 1 arkeon
add_dependencies(myPLugin kernel)
244 1 arkeon
245 1 arkeon
# set the dll version.
246 1 arkeon
set_target_properties(myPLugin PROPERTIES VERSION ${Scol_VERSION} SOVERSION ${Scol_VERSION_MAJOR})
247 1 arkeon
target_link_libraries(myPLugin ${LIBRARIES})
248 1 arkeon
249 1 arkeon
# install Scol
250 1 arkeon
scol_config_plugin(myPLugin)
251 1 arkeon
install(FILES ${MYPLUGIN_HEADER_FILES} DESTINATION include/SCOL/plugins/myPLugin)
252 1 arkeon
</pre>
253 1 arkeon
254 1 arkeon
Now we need to declare this new plugin in the common Scol cmake files.
255 1 arkeon
Edit the trunk/scol/CMakeLists.txt file and add your plugin definition like the following.
256 1 arkeon
257 1 arkeon
If you don't have dependencies.
258 1 arkeon
<pre>
259 1 arkeon
option(Scol_BUILD_MYPLUGIN "Build myPluginplugin, my library" TRUE)
260 1 arkeon
</pre>
261 1 arkeon
262 1 arkeon
If you have depencies
263 1 arkeon
<pre>
264 1 arkeon
cmake_dependent_option(Scol_BUILD_MYPLUGIN "Build myPlugin, my library." TRUE "MYDEP_FOUND;ZLIB_FOUND;PNG_FOUND" FALSE)
265 1 arkeon
</pre>
266 1 arkeon
267 1 arkeon
Now edit the trunk/scol/plugin/CMakeLists.txt file and add the following.
268 1 arkeon
<pre>
269 1 arkeon
# Configure myPlugin plugin build
270 1 arkeon
if (Scol_BUILD_MYPLUGIN)
271 1 arkeon
  add_subdirectory(myPlugin)
272 1 arkeon
endif ()
273 1 arkeon
</pre>
274 1 arkeon
275 1 arkeon
Only if you have dependencies, edit the trunk/scol/CMake/ScolDependencies.cmake file and add the dependencies resolution as the following
276 1 arkeon
277 1 arkeon
<pre>
278 1 arkeon
# Find MyDep
279 1 arkeon
find_package(MYDEP)
280 1 arkeon
macro_log_feature(MYDEP_FOUND "Mydep" "MydepLibrary" "http://Mydep.org/" FALSE "" "")
281 1 arkeon
</pre>
282 1 arkeon
283 1 arkeon
h2. Almost done
284 1 arkeon
285 1 arkeon
Open the CMAKE-gui again.
286 1 arkeon
Hit the "Configure button" and check if you found your plugin in the scol group.
287 1 arkeon
Then hit the generate button, and open the scol.sln project again.
288 1 arkeon
289 1 arkeon
You should have the project added in Visual Studio.