Updated README file

This commit is contained in:
Sylvain Berfini 2014-02-03 14:28:28 +01:00
parent ab27b1f0be
commit 8ea7c48f4c

30
README
View file

@ -3,7 +3,7 @@
To build liblinphone for Android, you must: To build liblinphone for Android, you must:
0) download the Android sdk with platform-tools and tools updated to latest revision (at least API 16 is needed), then add both 'tools' and 'platform-tools' folders in your path. 0) download the Android sdk with platform-tools and tools updated to latest revision (at least API 16 is needed), then add both 'tools' and 'platform-tools' folders in your path.
1) download the Android ndk (>=r9) from google and add it to your path. 1) download the Android ndk (>=r9) from google and add it to your path (no symlink !!!).
2) install yasm, curl, ant and the autotools: autoconf, automake, aclocal, libtoolize, pkgconfig 2) install yasm, curl, ant and the autotools: autoconf, automake, aclocal, libtoolize, pkgconfig
On 64 bits linux systems you'll need the ia32-libs package On 64 bits linux systems you'll need the ia32-libs package
With the latest Debian (multiarch), you need this: With the latest Debian (multiarch), you need this:
@ -19,8 +19,6 @@ To build liblinphone for Android, you must:
6) (Optional) To generate a libmediastreamer2 SDK zip containing a full jar and native libraries, run 6) (Optional) To generate a libmediastreamer2 SDK zip containing a full jar and native libraries, run
$ make mediastreamer2-sdk $ make mediastreamer2-sdk
To run the tutorials: To run the tutorials:
1) open the res/values/non_localizable_custom.xml file and change the value of the show_tutorials_instead_of_app to true. 1) open the res/values/non_localizable_custom.xml file and change the value of the show_tutorials_instead_of_app to true.
2) compile again using make && make install. 2) compile again using make && make install.
@ -32,27 +30,31 @@ To create an apk with a different package name, you need to edit the custom_rule
Some options can be passed to make, like "make SOME_OPTION=SOME_VALUE". Some options can be passed to make, like "make SOME_OPTION=SOME_VALUE".
ENABLE_GPL_THIRD_PARTIES
values: 0 (GPL third parties disabled) or 1 (GPL third parties enabled), default value: 1
GPL third parties are: X264, ZRTP and G729
BUILD_VIDEO BUILD_VIDEO
values: 0 (no video) or 1 (video enabled), default value: 1 values: 0 (no video) or 1 (video enabled), default value: 1
BUILD_X264 BUILD_X264
values: 0 (don't build x264) or 1 (build x264), default value: 0 values: 0 (don't build x264) or 1 (build x264), default value: 1
BUILD_AMRNB BUILD_AMRNB
values: 0 (don't build amrnb codec), light (try to use amrnb codec from android), full (build your own amrnb codec), default value: full values: 0 (don't build amrnb codec), light (try to use amrnb codec from android), full (build your own amrnb codec), default value: full
BUILD_AMRWB BUILD_AMRWB
values: 0 (don't build amrwb codec), 1 (build your own amrwb codec): default value: 0 values: 0 (don't build amrwb codec), 1 (build your own amrwb codec): default value: 1
BUILD_GPLV3_ZRTP BUILD_GPLV3_ZRTP
values: 0 (don't support ZRTP), 1 (support ZRTP and make the whole program GPLv3), default value: 0 values: 0 (don't support ZRTP), 1 (support ZRTP and make the whole program GPLv3), default value: 1
BUILD_SILK BUILD_SILK
values: 0 (don't build silk plugin), 1 (build silk) [silk is Skype nonfree patented audio codec], default value: 1 values: 0 (don't build silk plugin), 1 (build silk) [silk is Skype nonfree patented audio codec], default value: 1
BUILD_G729 BUILD_G729
values: 0 (don't build g729 plugin), 1 (build g729) [g729 is nonfree patented audio codec, contact Sipro lab for more details] values: 0 (don't build g729 plugin), 1 (build g729) [g729 is nonfree patented audio codec, contact Sipro lab for more details]
default value: 0 default value: 1
BUILD_TUNNEL BUILD_TUNNEL
values: 0 (don't build tunnel), 1 (build tunnel) [requires a non-free tunnel implementation in submodules/linphone/tunnel] values: 0 (don't build tunnel), 1 (build tunnel) [requires a non-free tunnel implementation in submodules/linphone/tunnel]
@ -74,5 +76,17 @@ BUILD_SQLITE
values: 0 (don't build sqlite3), 1 (build sqlite3) [used to store chat messages inside liblinphone] values: 0 (don't build sqlite3), 1 (build sqlite3) [used to store chat messages inside liblinphone]
default value: 1 default value: 1
BUILD_TLS
values: 0 (don't build tls), 1 (do build tls), default value: 1
BUILD_WEBRTC_ISAC
values: 0 (don't build isac), 1 (do build isac), default value: 1
BUILD_OPUS
values: 0 (don't build opus), 1 (do build opus), default value: 1
BUILD_UPNP
value: 0 (don't build upnp), 1 (do build upnp), default value: 1
If you encounter troubles with the make clean target and you are using the 8e android ndk, the solution can be found here: https://groups.google.com/forum/?fromgroups=#!topic/android-ndk/3wIbb-h3nDU If you encounter troubles with the make clean target and you are using the 8e android ndk, the solution can be found here: https://groups.google.com/forum/?fromgroups=#!topic/android-ndk/3wIbb-h3nDU
When using the ndk-r9b you may have an issue when compiling with x264. If so, use ndk-r9 instead. When using the ndk-r9b or ndk-r9c you may have an issue when compiling with x264. If so, use ndk-r9 instead.