wiki:Getting-Started/Download-Source
Last modified 3 years ago Last modified on 03/21/15 08:38:24

Getting the Source Code Distribution

  1. Getting the Release tarball
  2. Getting from Subversion trunk
  3. Source Directories Layout
    1. Top-Level Directory Layout
    2. Individual Directory Inside Each Project

All libraries (PJLIB, PJLIB-UTIL, PJSIP, PJMEDIA, and PJMEDIA-CODEC) are currently distributed under a single source tree, collectively named as PJPROJECT or just PJ libraries. These libraries can be obtained by either downloading the release tarball or getting them from the source repository, the "Subversion trunk".

Getting the Release tarball

Getting the released tarball, in ZIP or TGZ format, which is a certain snapshot in time.

The latest released tarball can always be downloaded from the http://www.pjsip.org/download.htm.

Getting from Subversion trunk

PJPROJECT Subversion repository will always contain the latest/most up-to-date version of the sources. Normally the Subversion repository is always kept in a "good" state. However, there's always a chance that things break and the tree doesn't build correctly (particularly for the "not-so-popular" targets), so please consult the mailing list should there be any problems.

Using Subversion also has benefits of keeping the local copy of the source up to date with the main PJ source tree and to easily track the changes made to the local copy, if any. Learn more about using Subversion.

The path to the repository is:

  • For the current development version (2.x onwards):

https://svn.pjsip.org/repos/pjproject/trunk

  • For version 1.x:

https://svn.pjsip.org/repos/pjproject/branches/1.x/

  • For development projects not in any release, find it in:

https://svn.pjsip.org/repos/pjproject/branches/projects

No userid or password is needed.

Source Directories Layout

Top-Level Directory Layout

The top-level directories (denoted as $TOP here) in the source distribution contains the following sub-directories:

$TOP/build

Contains makefiles that are common for all projects.

$TOP/build.symbian

Contains MMP files for building Symbian target.

$TOP/pjlib

Contains header and source files of PJLIB. PJLIB is the base portability and framework library which is used by all other libraries

$TOP/pjlib-util

Contains PJLIB-UTIL header and source files. PJLIB-UTIL is an auxiliary library that contains utility functions such as scanner, XML, STUN, MD5 algorithm, getopt() implementation, etc.

$TOP/pjnath

Contains PJNATH header and source files. PJNATH contains STUN, TURN, and ICE implementation.

$TOP/pjmedia

Contains PJMEDIA and PJMEDIA-CODEC header and source files. The sources of various codec wrappers (such as GSM, Speex, and iLBC) can be found under this directory. The codec libraries themselves normally will be put under $TOP/third_party directory

$TOP/pjsip

Contains PJSIP header and source files. This library is the SIP protocol stack implementation.

$TOP/pjsip-apps

Contains source code for PJSUA and various sample applications, including the Python wrapper.

$TOP/tests

Contains various unit tests for the libraries.

$TOP/third_party

Contains source code for various third party libraries, such as Speex, iLBC, and GSM codecs.

Individual Directory Inside Each Project

Each library directory further contains these sub-directories:

bin

Contains binaries produced by the build process.

build

Contains build scripts/makefiles, project files, project workspace, etc. to build the project. In particular, it contains one Makefile file to build the project with GNU build systems, and a *.dsw workspace file to build the library with Microsoft Visual Studio 6 or later.

build/output

The build/output directory contains the object files and other files generated by the build process. To support building multiple targets with a single source tree, each build target will occupy a different subdirectory under this directory.

docs

Contains Doxygen configuration file (doxygen.cfg) to generate online documentation from the source files. The output documentation will be put in this directory as well (for example, docs/html directory for the HTML files).

(to generate Doxygen documentation from the source tree, just run "doxygen docs/doxygen.cfg" in the individual project directory. The generated files will reside in docs directory).

include

Contains the header files for the project.

lib

Contains libraries produced by the build process.

src

Contains the source files of the project.