diff --git a/docs/Dependencies.txt b/docs/Dependencies.txt index 01440056..47cf2e7c 100644 --- a/docs/Dependencies.txt +++ b/docs/Dependencies.txt @@ -1,83 +1,89 @@ SIP SIMPLE client SDK dependencies ---------------------------------- Home page: http://sipsimpleclient.org SIP SIMPLE SDK depends upon the following third party C sources: -- PJSIP base revision 210 from 2020-02-14 +- PJSIP base revision 2.10 from 2020-02-14 https://github.com/pjsip/pjproject/archive/2.10.tar.gz + or PJSIP base revision 2.11 + https://github.com/pjsip/pjproject/archive/2.11.tar.gz + - ZRTP tag 6b3cd8e6783642292bad0c21e3e5e5ce45ff3e03 https://github.com/wernerd/ZRTPCPP.git Fetch and patch the dependencies using get_dependencies.sh script +./get_dependencies.sh will get 2.10 version of PJSIP +./get_dependencies.sh 2.11 will get 2.11 version of PJSIP + AMR codec --------- See codecs note below. Narrow-band Install opencore-amr using apt-get on Debian/Ubuntu On Mac: brew install opencore-amr Add to shell environment: export SIPSIMPLE_AMR_NB_PATH="/usr/local/opt/opencore-amr" Wide-band Source code: https://sourceforge.net/projects/opencore-amr/files/vo-amrwbenc A copy of the tree is included in ./deps/vo-amrwbenc-0.1.3 folder. cd ./deps/vo-amrwbenc-0.1.3/ On Mac: ./configure --prefix=/usr/local/opt/vo-amrwbenc make sudo make install Add to shell environment: export SIPSIMPLE_AMR_WB_PATH="/usr/local/opt/vo-amrwbenc" On Linux: ./configure --prefix=/usr/local/ make sudo make install Python dependencies available from AG Projects repositories: * python3-application http://download.ag-projects.com/SipSimpleSDK/Python3/ * python3-eventlib http://download.ag-projects.com/SipSimpleSDK/Python3/ * python3-gnutls http://download.ag-projects.com/SipSimpleSDK/Python3/ * python3-otr http://download.ag-projects.com/SipSimpleSDK/Python3/ * python3-msrplib http://download.ag-projects.com/SipSimpleSDK/Python3/ * python3-xcaplib http://download.ag-projects.com/SipSimpleSDK/Python3/ The dependencies for each package can be found inside debian/control file On a Debian or Ubuntu based system you can install their dependencies using: sudo mk-build-deps --install debian/control Codecs note ----------- Depending on what codecs have been compiled, one needs to modify in place: AudioCodecList inside sipsimple/configuration/datatypes.py RTPSettings inside sipsimple/configuration/setting.py diff --git a/docs/Install.linux b/docs/Install.linux index a943ae02..e1c655fb 100644 --- a/docs/Install.linux +++ b/docs/Install.linux @@ -1,122 +1,114 @@ SIP SIMPLE SDK installation on Linux ------------------------------------ http://sipsimpleclient.org This document described the installation procedure on Linux operating systems. Step 1. Prerequisites --------------------- Install the C compiling environment, Python3 and the development version for the following packages: * openssl * ffmpeg Step 2. Install system dependencies ----------------------------------- -SIP SIMPLE SDK depends upon the following third party sources: - -- PJSIP base revision 210 from 2020-02-14 - https://github.com/pjsip/pjproject/archive/2.10.tar.gz - -- ZRTP tag 6b3cd8e6783642292bad0c21e3e5e5ce45ff3e03 - https://github.com/wernerd/ZRTPCPP.git - -Fetch and patch the dependencies using ./get_dependencies.sh script +Fetch the dependencies using ./get_dependencies.sh script See Dependencies.txt for detailed description of the required libraries and their minimum version number. Use the appropriate package manager for your Linux distribution to install the following packages, notice the minimum version numbers. Using pip3 inside your user environment: pip3 install --user cython==0.29.37 dnspython lxml twisted python-dateutil \ greenlet zope.interface requests gmpy2 wheel gevent Step 3. Install AG Projects dependencies ---------------------------------------- - python3-application - python3-eventlib - python3-gnutls - python3-otr - python3-msrplib - python3-xcaplib For each of them, in the exact order as listed above, retrieve the packages using one of the following methods: Using darcs: darcs clone http://devel.ag-projects.com/repositories/PROJECT replace PROJECT with each of the names above Using git: git clone https://github.com/AGProjects/PROJECT replace PROJECT with each of the names above As tar archives from: http://download.ag-projects.com/SipSimpleSDK/Python3/ Install these packages by going into each directory. Install the software inside your user environment: pip3 install --user . Install system-wide using setup.py: sudo python3 setup.py install Build a debian package, check if makedeb.sh exists and run it for each project: ./makedeb.sh The debian package can be found inside ./dist folder Install the built debian package: sudo dpkg -i *.deb Step 4. Install SIP SIMPLE SDK ------------------------------ Using pip3 inside your user environment: pip3 install --user . System-wide using setup.py: sudo python3 setup.py install As a debian package: ./makedeb.sh The debian package can be found inside ./dist folder sudo dpkg -i *.deb Step 5. Testing SIP SIMPLE SDK ------------------------------ Use the command line tools provided by sipclients3 package. The executables start with sip- prefix. diff --git a/mac/03-install-python-deps.sh b/mac/03-install-python-deps.sh index ce2c361f..66aa2217 100644 --- a/mac/03-install-python-deps.sh +++ b/mac/03-install-python-deps.sh @@ -1,25 +1,25 @@ #!/bin/bash if [ ! -d ~/work ]; then mkdir ~/work fi arch=`python3 -c "import platform; print(platform.processor())"` -pver=`python3 -c "import sys; print(sys.version[0:3])"` +pver=`python3 -c "import sys; print(sys.version[0:4])"` envdir=sipsimple-python-$pver-$arch-env if [ ! -d ~/work/$envdir ]; then mkdir ~/work/$envdir virtualenv -p /usr/local/bin/python3 ~/work/$envdir else echo "Environment exists in ~/work/$envdir" fi source activate_venv.sh export CFLAGS="-I/opt/local/include" export LDFLAGS="-L/opt/local/lib" pip3 install --upgrade pip pip3 install -r python-requirements.txt pip3 install -r sipsimple-requirements.txt