PJSIP Android Builder

Easily build PJSIP with: OpenSSL, OpenH264, libyuv and G.729 (without Intel IPP) for Android, by using a Linux virtual machine.

Build matrix

Using Android API 18 (it's the default when you checkout the project and in the vagrant base box):

Library \ Builds for	armeabi	armeabi-v7a	x86	mips	arm64-v8a	x86_64	mips64
PJSIP 2.4.5	X	X	X	X
LibYUV r1580	X	X	X
G.729	X	X	X	X
OpenSSL 1.0.2g	X	X	X	X
OpenH264 1.0.0	X	X	X	X
If you want to compile LibYUV for mips, check why it has been disabled in #12.

Using Android API 21+:

Library \ Builds for	armeabi	armeabi-v7a	x86	mips	arm64-v8a	x86_64	mips64
PJSIP 2.4.5	X	X	X	X	X	X	X
LibYUV r1580	X	X	X	X	X	X	X
G.729	X	X	X	X	X	X	X
OpenSSL 1.0.2g	X	X	X	X	X	X
OpenH264 1.0.0	X	X	X	X

OpenSSL and OpenH264 have problems with 64 bit archs, as you can see from the build compatibility matrix. Check #2 and #8 for further reference. 64 bit builds are supported starting from Android API 21+, so if you compile using older Android APIs, you can do that only for: armeabi, armeabi-v7a, x86 and mips.

Purpose

I needed an easily replicable build system to build PJSIP http://www.pjsip.org/ native library with NDK for Android. So, I created a Linux virtual machine and wrote some scripts to download, install all the requirements needed to make it a complete build environment and some automated build scripts. If you want to contribute, your help is really appreciated :)

Setup

You have three options available. The first two require that you have vagrant installed on your system. The first option is the easiest and also the fastest, but may be not the most updated. The second one lets you create the base box exactly as I create it, and the third one is the slowest, as you have to install everything from the base OS and download tons of stuff. You choose.

With ready to use vagrant base box

You can find it here.

vagrant init gotev/pjsip-android-builder; vagrant up --provider virtualbox

then you can SSH into the VM and build PJSIP:

./build

Build the vagrant box from scratch

git clone https://github.com/gotev/pjsip-android-builder
cd pjsip-android-builder; vagrant up

This will setup a full Ubuntu Server 14.04.3 LTS from scratch with everything that's needed to compile PJSIP. This will take some time, as there are many things which has to be downloaded and installed, so relax or do some other thing while waiting. Be aware that you may encounter errors in the process, due to newer versions of the libraries being released and the versions used in config.conf not being available anymore. If that happens, check which are the new versions, update config.conf and retry from scratch. There may be also other errors due to compilation issues when newer compiler versions and tools are released...and that's a whole new story! After plenty of output, if everything is ok you will see:

The build system is ready! Execute: ./build to build PJSIP :)

then you can SSH into the VM and build PJSIP:

vagrant ssh
cd /pjsip-android-builder; ./build

Manual setup

First, you need a virtualization system. There are plenty of choices out there. Choose the one that you prefer (VirtualBox, vmWare, Vagrant, you name it). I'm supposing that you know what a virtual machine is and how to setup your environment to be able to run virtual machines. So, let's begin :)

1. Download the latest Ubuntu Server ISO (I've chosen 14.04.3 LTS): http://www.ubuntu.com/download/server
   I've chosen this distro because it has a good support for the applications that we need and it's kept updated. In the future, support to other distributions can be added as well, with your help :)
2. Create a new virtual machine with at least 1GB RAM and 20GB virtual hard drive. Add as many RAM and processors as you can, so the compilation process will be faster.
3. Install Ubuntu Server
4. SSH into your newly installed VM and execute the following commands, which will install all the required packages and files to be able to build PJSIP. This will take some time, as there are many things which has to be downloaded and installed, so relax or do some other thing while waiting
   

sudo apt-get install -y git
git clone https://github.com/alexbbb/pjsip-android-builder
cd pjsip-android-builder
./prepare-build-system

Build PJSIP

After you have successfully set up your VM, to build PJSIP, go into pjsip-android-builder and execute:

./build

When everything goes well, you will see an output like this:

Clear final build folder ...
Creating config site file for Android ...
Compile PJSIP for arch armeabi ...
Compile PJSUA for arch armeabi ...
Copying PJSUA .so library to final build directory ...
Copying OpenH264 .so library to final build directory ...
Copying libyuv .so library to final build directory ...
Compile PJSIP for arch armeabi-v7a ...
Compile PJSUA for arch armeabi-v7a ...
Copying PJSUA .so library to final build directory ...
Copying OpenH264 .so library to final build directory ...
Copying libyuv .so library to final build directory ...
Compile PJSIP for arch x86 ...
Compile PJSUA for arch x86 ...
Copying PJSUA .so library to final build directory ...
Copying OpenH264 .so library to final build directory ...
Copying libyuv .so library to final build directory ...
Compile PJSIP for arch x86_64 ...
Compile PJSUA for arch x86_64 ...
Copying PJSUA .so library to final build directory ...
Copying libyuv .so library to final build directory ...
Compile PJSIP for arch arm64-v8a ...
Compile PJSUA for arch arm64-v8a ...
Copying PJSUA .so library to final build directory ...
Copying libyuv .so library to final build directory ...
Copying PJSUA2 java bindings to final build directory ...
Finished! Check the generated output in /home/user/pjsip-android-builder/pjsip-build

The script is going to create a new folder named pjsip-build organized as follows:

pjsip-build
 |-- logs/  contains the full build log for each target architecture
 |-- lib/   contains the compiled libraries for each target architecture
 |-- src/   contains PJSUA Java wrapper to work with the library

If something goes wrong during the compilation of a particular target architecture, the main script will be terminated and you can see the full log in ./pjsip-build/logs/<arch>.log. So for example if there's an error for x86, you can see the full log in ./pjsip-build/logs/x86.log

Build with G.729 codec

Please read G.729 codec disclaimer!

Use ./build-with-g729 script insted of ./build.

Configuration

It's possible to configure library versions and build settings by editing the config.conf file. Please read the comments in the file for more details.

Switch from Android API 18 to Android API 21

By default Android API 18 are used. If you want to compile with Android API 21, change the following in config.conf and leave the rest unchanged:

TARGET_ARCHS=("armeabi" "armeabi-v7a" "x86" "mips")
TARGET_ANDROID_API=21
SETUP_PACKAGES=0
DOWNLOAD_NDK=0
DOWNLOAD_SDK=0
DOWNLOAD_ANDROID_APIS=0
DOWNLOAD_PJSIP=1
DOWNLOAD_SWIG=0

Then:

./prepare-build-system; ./build

After recent changes from 1.0.0 to 1.1 I've not had the necessary time to fully test build with API 21, so if you encounter errors, file an issue with all the details or a pull request with the solution (which is the best option).

Build only OpenSSL

This project has separate independent script to build only OpenSSL library.

Usage:
./openssl-build <ANDROID_NDK_PATH> <OPENSSL_SOURCES_PATH> <ANDROID_TARGET_API> \
                <ANDROID_TARGET_ABI> <GCC_VERSION> <OUTPUT_PATH>

Supported target ABIs: armeabi, armeabi-v7a, x86, x86_64, arm64-v8a

Example using GCC 4.8, NDK 10e, OpenSSL 1.0.2d and Android API 21 for armeabi-v7a.
./openssl-build /home/user/android-ndk-r10e /home/user/openssl-1.0.2d 21 \
                armeabi-v7a 4.8 /home/user/output/armeabi-v7a

If you want to leverage on the config.conf properties and build OpenSSL for every configured target arch, you can use the following helper script:

./openssl-build-target-archs

When everything goes well, you will see an output like this:

Building OpenSSL for target arch armeabi ...
Building OpenSSL for target arch armeabi-v7a ...
Building OpenSSL for target arch x86 ...
Building OpenSSL for target arch x86_64 ...
Building OpenSSL for target arch arm64-v8a ...
Finished building OpenSSL! Check output folder: /home/user/pjsip-android-builder/openssl-build-output

The script is going to create a new folder named openssl-build-output organized as follows:

openssl-build-output
 |-- logs/  contains the full build log for each target architecture
 |-- libs/  contains the compiled libraries for each target architecture

If something goes wrong during the compilation of a particular target architecture, the main script will be terminated and you can see the full log in ./openssl-build-output/logs/<arch>.log. So for example if there's an error for x86, you can see the full log in ./openssl-build-output/logs/x86.log

Change OpenSSL release version

1. Go to OpenSSL download page and get the link to download the latest stable version (at the time of this writing the version is 1.0.2h and the link is: https://www.openssl.org/source/openssl-1.0.2h.tar.gz)
2. Edit config.conf and change:

OPENSSL_DOWNLOAD_URL="https://www.openssl.org/source/openssl-1.0.2h.tar.gz"
OPENSSL_DIR_NAME="openssl-1.0.2h"

DOWNLOAD_NDK=0
DOWNLOAD_SDK=0
DOWNLOAD_ANDROID_APIS=0
DOWNLOAD_PJSIP=0
DOWNLOAD_SWIG=0
DOWNLOAD_OPENSSL=1
DOWNLOAD_OPENH264=0
DOWNLOAD_LIBYUV=0

3. remove openssl-build-output and the old openssl-1.0.2g (or whatever version instead of 1.0.2g) directories
4. Execute ./prepare-build-system and the new OpenSSL will be downloaded and compiled (go get a coffee :D)
5. Rebuild PJSIP (by either using ./build or ./build-with-g729)

License

Copyright (C) 2015-2016 Aleksandar Gotev

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.