Building PJSUA2
******************************

.. contents:: Table of Contents
    :depth: 2


The PJSUA2 C++ library is built by default by PJSIP build system. 
Standard C++ library is required.

The following sections applies to building SWIG Python, Java, or C# modules.

Common Requirements
======================================

#. On Linux/MacOS X/Unix, you need to build PJPROJECT with ``-fPIC`` option. 
   You can either put it in ``user.mak`` file in root pjproject directory like 
   this:

   .. code-block::

      export CFLAGS += -fPIC

   or you can specify it when calling :any:`configure`:

   .. code-block:: shell

      ./configure CFLAGS="-fPIC"

   Then rebuild pjproject.

#. Install `SWIG <http://www.swig.org>`_

   For Debian based distributions (such as Ubuntu):

   .. code-block:: shell

      sudo apt-get install swig

   For Windows and other platforms please see https://www.swig.org/download.html


Building Python SWIG Module
======================================
1. Install SWIG as shown above, and Python development package:

   For Debian based distributions (such as Ubuntu):

   .. code-block:: shell

      sudo apt-get install swig python3-dev

   For Windows (on MinGW/MinGW-w64 + MSYS2):

   .. code-block:: shell

      pacman -S swig python python-setuptools

   .. note::
      Make sure there's no existing Python installation to avoid conflicts

2. Build:

   .. code-block:: shell

      cd pjsip-apps/src/swig/python
      make
      make install

   .. note::

      The above will install the module to user's ``site-packages`` directory.

      If you're currently on a **virtualenv**, run ``python setup.py install`` instead.

   For Windows, you need to use GNU tools, e.g: `MinGW/MinGW-w64`, and follow the above `instructions to build PJSIP on Unix <https://docs.pjsip.org/en/latest/pjsua2/building.html#common-requirements>`__. Note that some video features may not work such as DirectShow renderer.

3. Test the installation:

   .. code-block:: shell

      $ python3
      > import pjsua2
      > ^Z



Building Java SWIG Module
======================================
1. Install SWIG as shown above.
2. Install JDK.
3. Build:

   .. code-block:: shell

      cd pjsip-apps/src/swig/java
      make
      make install

   TBD.


Building C# SWIG Module
======================================
See ticket :issue:`2086` (Add C# binding using SWIG, and support for Xamarin).

For Windows, check: :issue:`3217` (Add two VS2015 projects for CSharp: SWIG binding builder & sample app).