Changes between Version 2 and Version 3 of Getting-Started/Autoconf

Timestamp:

Apr 28, 2009 5:26:51 PM (15 years ago)

Author:

ismangil

Comment:

--

Getting-Started/Autoconf

@@ -143 +143 @@
 export LDFLAGS +=
 
+== Using in your applications ==
+
+[wiki:Getting_Started_Using]
+
+Regardless of the build system being used, the following tasks are normally needed to be done in order to build application to use PJSIP and PJMEDIA:
+
+   1. Put these include directories in the include search path:
+          * pjlib/include
+          * pjlib-util/include
+          * pjnath/include
+          * pjmedia/include
+          * pjsip/include
+   2. Put these library directories in the library search path:
+          * pjlib/lib
+          * pjlib-util/lib
+          * pjnath/lib
+          * pjmedia/lib
+          * pjsip/lib
+   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 the OS macros.
+          * For Windows applications built with Visual Studio, we need to 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.
+          * For GNU build system/autoconf based build system, we need to declare PJ_AUTOCONF=1 macro when compiling the applications.
+
+      (Note: the old PJ build system requires declaring the target processor with PJ_M_XXX=1 macro, but this has been made obsolete. The target processor will be detected from compiler's predefined macro by pjlib/config.h file).
+   5.
+
+      Link with the appropriate PJ libraries. The following libraries will need to be included in the library link specifications:
+
+      pjlib
+          Base library used by all libraries. 
+      pjlib-util
+          Auxiliary library containing scanner, XML, STUN, MD5, getopt, etc, used by the SIP and media stack. 
+      pjnath
+          NAT helper library (STUN, TURN, ICE). 
+      pjsip
+          SIP core stack library. 
+      pjsip-ua
+          SIP user agent library containing INVITE session, call transfer, client registration, etc. 
+      pjsip-simple
+          SIP SIMPLE library for base event framework, presence, instant messaging, etc. 
+      pjsua
+          High level SIP UA library, combining SIP and media stack into high-level easy to use API. 
+      pjmedia
+          The media framework. 
+      pjmedia-codec
+          Container library for various codecs such as GSM, Speex, and iLBC. 
+
+       
+
+      Note: the actual library names will be appended with the target name and the build configuration. For example:
+
+      For Visual Studio builds
+
+          The actual library names will look like pjlib-i386-win32-vc6-debug.lib, pjlib-i386-win32-vc6-release.lib, etc., depending on whether we are building the Debug or Release version of the library.
+
+          An easier way to link with the libraries is to include PJ project files in the workspace, and to configure project dependencies so that the application depends on the PJ libraries. This way, we don't need to manually add each PJ libraries to the input library file specification, since VS will automatically link the dependency libraries with the application.
+      For Windows Mobile builds
+
+          Unfortunately the PJ libraries built for Windows Mobile will not be placed in the usual lib directory, but rather under the output directory under build/wince-evc4 project directory.
+
+          An easier way to link with the libraries is to include PJ project files in the workspace, and to configure project dependencies so that the application depends on the PJ libraries. This way, we don't need to manually add each PJ libraries to the input library file specification, since VS will automatically link the dependency libraries with the application.
+      For GNU builds
+
+          Use the template Makefile below (as described in Building Application using PJSIP with GNU Tools):
+          # Modify this to point to the PJSIP location.
+          PJBASE=/home/myself/pjproject-0.5.10.2
+
+          include $(PJBASE)/build.mak
+
+          CC      = $(APP_CC)
+          LDFLAGS = $(APP_LDFLAGS)
+          LDLIBS  = $(APP_LDLIBS)
+          CFLAGS  = $(APP_CFLAGS)
+          CPPFLAGS= ${CFLAGS}
+
+          # If your application is in a file named myapp.cpp or myapp.c
+          # this is the line you will need to build the binary.
+          all: myapp
+
+          myapp: myapp.cpp
+                   $(CC) -o $@ $< $(CPPFLAGS) $(LDFLAGS) $(LDLIBS)
+
+          clean:
+                  rm -f myapp.o myapp
+
+       
+   6.
+
+      Link with system spesific libraries:
+
+      Windows
+
+          Add (among other things): wsock32.lib, ws2_32.lib, ole32.lib, dsound.lib
+      Linux, *nix, *BSD
+
+          Add (among other things): '-lpthread -lm' (at least). If you use the template Makefile above, these would have been added by PJ.
+      MacOS X
+
+          Add (among other things): '-framework CoreAudio -lpthread -lm'. If you use the template Makefile above, these would have been added by PJ.
+
+