= Getting Started: Building for Microsoft Windows =
[[TracNav(Getting-Started/TOC)]]


This page describes how to use Microsoft Visual Studio to build pjsip libraries:

[[PageOutline(2-3,,inline)]]

  Note: You can also build for Windows using GNU tools such mingw. Follow the steps in [wiki:Getting-Started/Autoconf Getting Started: Building with GNU Tools/Autoconf].

== Build Preparation for Windows ==

 1. It is important that you create a config_site.h as described in [wiki:Getting-Started/Build-Preparation Build Preparation]
 2. [wiki:Getting-Started/Download-Source Get the source code], if you haven't already.

== Requirements ==

The Visual Studio based project files can be used with one of the following tools:

    * Microsoft Visual Studio 6,
    * Microsoft Visual Studio .NET 2002,
    * Microsoft Visual Studio .NET 2003,
    * Microsoft Visual Studio/C++ 2005 (including Express edition),
    * Microsoft Visual Studio 2008. You may need to fix the [wiki:FAQ#vs2008 IP Helper API header bug]. Follow the instructions for Visual Studio 2005.
    * '''Note for 1.x:''' Microsoft Visual Studio 2010 '''is currently unsupported'''.
      - this is because Visual Studio 2010 drops support for native Windows Mobile development, and hence is unable to import PJSIP projects. You may use VS 2010 but you'd have to manually remove Windows Mobile targets from all PJSIP project files.

In addition, the following SDK's are needed:

    * Essential: DirectX SDK (tested with DirectX version 8 and 9). After installing DirectX, add the paths to the include files and the library to Visual Studio.
    * Optional if not using Visual Studio 2008: Platform SDK (tested with Platform SDK for Windows Server 2003 SP1).
    * Optional: OpenSSL development kit is needed if TLS support is wanted. Learn more: [wiki:Getting-Started/Installing-OpenSSL-Windows Installing OpenSSL Libraries on Windows].

  Note: The new Platform SDK is still needed for Visual Studio 6, although VS6 comes with its own Platform SDK. The new Platform SDK is needed for Iphlpapi.[h|lib] for the new PJNATH library.

For the host, the following are required:

    * Windows NT, 2000, XP, 2003, or later ,
    * Windows 95/98 should work too, but this has not been tested,
    * Sufficient amount of RAM for the build process.

== Building the Projects ==

Follow the steps below to build the libraries/application using Visual Studio:

   1. For Visual Studio 6/2002/2003: open {{{pjproject.dsw}}} workspace file.
   1. For Visual Studio 8 (VS 2005): open {{{pjproject-vs8.sln}}} solution file.
   1. Set '''pjsua''' as Active Project.
   1. Set '''Win32''' as the platform.
   1. Select '''Debug''' or '''Release''' build as appropriate.
   1. Build the project. This will build '''pjsua''' application and all libraries needed by '''pjsua'''.
   1. After successful build, the pjsua application will be placed in pjsip-apps/bin directory, and the libraries in lib directory under each projects.

To build the samples:

   1. (Still using the same workspace)
   2. Set samples project as Active Project
   3. Select Debug or Release build as appropriate. See [wiki:Getting-Started/Visual-Studio-Build-Configuration Visual Studio Build Configuration] page for explanation of each provided build configuration
   4. Build the project. This will build all sample applications and all libraries needed.
   5. After successful build, the sample applications will be placed in pjsip-apps/bin/samples directory, and the libraries in lib directory under each projects.

 
== Debugging Sample Applications ==

Sample applications are built using Samples.mak makefile, therefore it is difficult to setup debugging session in Visual Studio for these applications. To solve this issue, the pjsip_apps workspace contain one project called sample_debug which can be used to debug a sample application.

To setup debugging using sample_debug project:

   1. Set sample_debug project as Active Project
   2. Edit debug.c file inside this project.
   3. Modify the #include line to include the particular sample application to debug
   4. Select Debug build.
   5. Build and debug the project.

== Next: Using pjproject libraries for your own application ==

   1. Put these include directories in the include search path of your project:
          * pjlib/include
          * pjlib-util/include
          * pjnath/include
          * pjmedia/include
          * pjsip/include
   2. Put the combined library directory '''lib''' (located in the root directory of pjproject source code) in the library search path
   3. Include the relevant PJ header files in the application source file. For example, using these would include ALL APIs exported by PJ:
{{{
         #include <pjlib.h>
         #include <pjlib-util.h>
         #include <pjnath.h>
         #include <pjsip.h>
         #include <pjsip_ua.h>
         #include <pjsip_simple.h>
         #include <pjsua-lib/pjsua.h>
         #include <pjmedia.h>
         #include <pjmedia-codec.h>
}}}
      (Note: the documentation of the relevant libraries should say which header files should be included to get the declaration of the APIs).
   4. Declare PJ_WIN32=1 macro in the project settings (declaring the macro in the source file may not be sufficient).
          * For Windows Mobile applications build with Visual C++, we need to declare PJ_WIN32_WINCE=1 macro in the project settings.
 
    5. Link with the main pjproject library {{{libpjproject}}}. It includes all the libraries provided. Note: the actual library names will be appended with the target name and the build configuration. For example: The actual library names will look like libpjproject-i386-win32-vc6-debug.lib depending on whether we are building the Debug or Release version of the library.


   6. Link with system specific libraries such as: wsock32.lib, ws2_32.lib, ole32.lib, dsound.lib
   
 
== Misc ==
[wiki:Getting-Started/Windows/2.0-dev]