= Getting the Source Code Distribution =
[[TracNav(Getting-Started/TOC)]]

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.

 
What is Subversion

Subversion (SVN) is Open Source version control system similar to CVS. Subversion homepage is in http://subversion.tigris.org/

 
Getting Subversion Client

A Subversion (SVN) client is needed to download the PJ source files from pjsip.org SVN tree. SVN client binaries can be downloaded from http://subversion.tigris.org/, and the program should be available for Windows, Linux, MacOS X, and many more platforms.

 
Getting the Source for The First Time

Once Subversion client is installed, the following commands can be used to initially retrieve the latest sources from the Subversion trunk:

  	

$ svn co http://svn.pjsip.org/repos/pjproject/trunk pjproject
$ cd pjproject

 
Keeping The Local Copy Up-to-Date

Once sources have been downloaded, we can keep the local copy up to date by periodically synchronizing the local source with the latest revision from the PJ's Subversion trunk. The mailing list provides best source of information about the availability of new updates in the trunk.

To update the local copy with the latest changes in the main PJ's repository:

  	

$ cd pjproject
$ svn update

 
Tracking Local and Remote Changes

To see what files have been changed locally:

  	

$ cd pjproject
$ svn status

The above command only compares local file against the original local copy, so it doesn't require Internet connection while performing the check.

To see both what files have been changed locally and what files have been updated in the PJ's Subversion repository:

  	

$ cd pjproject
$ svn status -u

Note that this command requires active Internet connection to query the status of PJPROJECT's source repository.

 
1.3 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 codecs (such as GSM, Speex, and iLBC) can be found under this 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/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.
build/wince-evc4

    This directory contains the project/workspace files to build Windows CE/WinCE version of the project using Microsoft Embedded Visual C++ 4.
build/wince-evc4/output

    This directory contains the library, executable, and object files generated by Windows Mobile build process.
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.