Changes between Version 71 and Version 72 of Getting-Started/Android

Timestamp:

Sep 27, 2017 3:15:15 AM (7 years ago)

Author:

ming

Comment:

--

Getting-Started/Android

@@ -115 +115 @@
 
 For sample usage, please refer to pjsua2 sample app. Ticket #1861 explains this feature in detail.
-
-== Setting up the target device ==
-
-To run or debug application (such as the sample applications below), first we need to setup the target device: 
- - using virtual device: http://developer.android.com/tools/devices/index.html
- - using real device: http://developer.android.com/tools/device.html
-
-
-== Building and running pjsua2 sample application == #pjsua2
-
-A sample application using [http://www.pjsip.org/docs/book-latest/html/index.html pjsua2 API] with SWIG Java binding, is located under {{{pjsip-apps/src/swig/java/android}}}. It is not built by default, and you need [http://www.swig.org/download.html SWIG] to build it.
-
-Follow these steps to build pjsua2 sample application:
- 1. Make sure SWIG is in the build environment PATH.
- 1. Run {{{make}}} from directory {{{$PJDIR/pjsip-apps/src/swig}}} (note that the Android NDK root should be in the PATH), e.g:
-     {{{
-$ cd /path/to/your/pjsip/dir
-$ cd pjsip-apps/src/swig
-$ make
-     }}}
-    This step should produce:
-    - native library {{{libpjsua2.so}}} in {{{pjsip-apps/src/swig/java/android/app/src/main/jniLibs/armeabi}}}
-      - note: if you are building for other target ABI, you'll need to manually move {{{libpjsua2.so}}} to the appropriate target ABI directory, e.g: {{{jniLibs/armeabi-v7a}}}, please check [https://developer.android.com/ndk/guides/abis.html#am here] for target ABI directory names.
-    - pjsua2 Java interface (a lot of {{{.java}}} files) in {{{pjsip-apps/src/swig/java/android/app/src/main/java/org/pjsip/pjsua2}}}
- 1. Make sure any library dependencies are copied to {{{pjsip-apps/src/swig/java/android/app/src/main/jniLibs/armeabi}}} (or the appropriate target ABI directory), e.g: {{{libopenh264.so}}} for video support.
- 1. Open pjsua2 app project in Android Studio, it is located in {{{pjsip-apps/src/swig/java/android}}}.
- 1. Run it.
-
-=== Log output ===
-
-The pjsua2 sample application will write log messages to '''!LogCat''' window.
-
-
-== Creating your own application == #create-own-app
-
-For developing Android application, you should use [http://www.pjsip.org/docs/book-latest/html/index.html pjsua2 API] whose Java interface available via SWIG Java binding.
-
- 1. First, build {{{pjproject}}} libraries as described above.
- 1. Also build {{{pjsua2 sample application}}} as described above, this step is required to generate the pjsua2 Java interface and the native library.
- 1. Create Android application outside the PJSIP sources for your project.
- 1. Get pjsua2 Java interface and native library from pjsua2 sample application:
-    1. Copy pjsua2 Java interface files from {{{pjsip-apps/src/swig/java/android/app/src/main/java}}} to your project's {{{app/src/main/java}}} folder, e.g:
-       {{{
-$ cd $YOUR_PROJECT_DIR/app/src/main/java
-$ cp -r $PJSIP_DIR/pjsip-apps/src/swig/java/android/app/src/main/java .
-
-# Cleanup excess pjsua2 application sources.
-$ rm -r org/pjsip/pjsua2/app
-       }}}
-    1. Copy native library {{{libpjsua2.so}}} from {{{pjsip-apps/src/swig/java/android/app/src/main/jniLibs}}} to your project's {{{app/src/main/jniLibs}}} folder:
-       {{{
-$ cd $YOUR_PROJECT_DIR/app/src/main/jniLibs
-$ cp -r $PJSIP_DIR/{pjsip-apps/src/swig/java/android/app/src/main/jniLibs .
-       }}}
- 1. Start writing your application, please check [http://www.pjsip.org/docs/book-latest/html/index.html pjsua2 docs] for reference.
-
-
-== Pjsua application with telnet interface == #pjsua
-
-There is also the usual [http://www.pjsip.org/pjsua.htm pjsua] with telnet command line user interface, which is located under {{{pjsip-apps/src/pjsua/android}}}. It is not built by default and you need [http://www.swig.org/download.html SWIG] to build it. Application flow and user interface are handled mainly in the native level, so it doesn't use pjsua2 API with Java interface.
-
-Follow these steps to build pjsua:
- 1. Make sure SWIG is in the build environment PATH.
-     - Alternatively, update SWIG path in {{{$PJDIR/pjsip-apps/src/pjsua/android/jni/Makefile}}} file.
- 1. Run {{{make}}} from directory {{{$PJDIR/pjsip-apps/src/pjsua/android/jni}}} (note that the Android NDK root should be in the PATH), e.g:
-     {{{
-$ cd /path/to/your/pjsip/dir
-$ cd pjsip-apps/src/pjsua/android/jni
-$ make
-     }}}
- 1. Open pjsua2 app project in Android Studio, it is located in {{{pjsip-apps/src/pjsua/android}}}.
- 1. Run it.
- 1. You will see telnet instructions on the device's screen. Telnet to this address to operate the application. See [wiki:PJSUA-CLI PJSUA CLI Manual] for command reference.
-
-
-{{{#!comment
-
-== Debugging native code with Eclipse == #debug-native
-
-Here are the steps for debugging PJSIP native code using Eclipse:
- 1. Build PJSIP with debugging enabled, e.g: insert {{{CFLAGS += -g}}} into {{{user.mak}}} in PJSIP root directory.
- 1. Make sure that the JNI part of the application is built using {{{ndk-build}}}. For reference, check pjsua's {{{Android.mk}}} build config in {{{pjsip-apps/src/pjsua/android/jni}}}, it contains sample of how to import PJSIP build settings (build search paths, build flags, etc) and SWIG invocation.
- 1. Enable NDK plugin for Eclipse, check [http://tools.android.com/recent/usingthendkplugin this] and follow the instructions.
-     - CDT can also be fetched from [http://www.eclipse.org/cdt/downloads.php CDT download page], normally Eclipse for C/C++ will have CDT installed, just make sure that the CDT version is 7.0.2 or newer.
- 1. It is recommended to introduce delay (about 5 seconds) in the application code between loading the native code library and calling any native functions (to be debugged), e.g:
-     {{{
-try {
-        System.loadLibrary("some_native_lib.so");
-} catch (UnsatisfiedLinkError e) {
-        return -1;
-}
-
-// Wait for GDB init
-if ((getApplicationInfo().flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0) {
-        try {
-                Thread.sleep(5000);
-        } catch (InterruptedException e) { }
-}
-
-// Start calling native functions here
-// ...
-     }}}
- 1. Load the PJSIP project to Eclipse (if not yet), and try put breakpoint anywhere in the PJSIP code before launching the Android application debug configuration in Eclipse.
-
-}}}
-
 
 == OpenSSL Support ==
@@ -297 +191 @@
 }}}
 
+== Trying our sample application and creating your own
+
+=== Setting up the target device ===
+
+To run or debug application (such as the sample applications below), first we need to setup the target device: 
+ - using virtual device: http://developer.android.com/tools/devices/index.html
+ - using real device: http://developer.android.com/tools/device.html
+
+
+=== Building and running pjsua2 sample application === #pjsua2
+
+A sample application using [http://www.pjsip.org/docs/book-latest/html/index.html pjsua2 API] with SWIG Java binding, is located under {{{pjsip-apps/src/swig/java/android}}}. It is not built by default, and you need [http://www.swig.org/download.html SWIG] to build it.
+
+Follow these steps to build pjsua2 sample application:
+ 1. Make sure SWIG is in the build environment PATH.
+ 1. Run {{{make}}} from directory {{{$PJDIR/pjsip-apps/src/swig}}} (note that the Android NDK root should be in the PATH), e.g:
+     {{{
+$ cd /path/to/your/pjsip/dir
+$ cd pjsip-apps/src/swig
+$ make
+     }}}
+    This step should produce:
+    - native library {{{libpjsua2.so}}} in {{{pjsip-apps/src/swig/java/android/app/src/main/jniLibs/armeabi}}}
+      - note: if you are building for other target ABI, you'll need to manually move {{{libpjsua2.so}}} to the appropriate target ABI directory, e.g: {{{jniLibs/armeabi-v7a}}}, please check [https://developer.android.com/ndk/guides/abis.html#am here] for target ABI directory names.
+    - pjsua2 Java interface (a lot of {{{.java}}} files) in {{{pjsip-apps/src/swig/java/android/app/src/main/java/org/pjsip/pjsua2}}}
+ 1. Make sure any library dependencies are copied to {{{pjsip-apps/src/swig/java/android/app/src/main/jniLibs/armeabi}}} (or the appropriate target ABI directory), e.g: {{{libopenh264.so}}} for video support.
+ 1. Open pjsua2 app project in Android Studio, it is located in {{{pjsip-apps/src/swig/java/android}}}.
+ 1. Run it.
+
+==== Log output ====
+
+The pjsua2 sample application will write log messages to '''!LogCat''' window.
+
+
+=== Creating your own application === #create-own-app
+
+For developing Android application, you should use [http://www.pjsip.org/docs/book-latest/html/index.html pjsua2 API] whose Java interface available via SWIG Java binding.
+
+ 1. First, build {{{pjproject}}} libraries as described above.
+ 1. Also build {{{pjsua2 sample application}}} as described above, this step is required to generate the pjsua2 Java interface and the native library.
+ 1. Create Android application outside the PJSIP sources for your project.
+ 1. Get pjsua2 Java interface and native library from pjsua2 sample application:
+    1. Copy pjsua2 Java interface files from {{{pjsip-apps/src/swig/java/android/app/src/main/java}}} to your project's {{{app/src/main/java}}} folder, e.g:
+       {{{
+$ cd $YOUR_PROJECT_DIR/app/src/main/java
+$ cp -r $PJSIP_DIR/pjsip-apps/src/swig/java/android/app/src/main/java .
+
+# Cleanup excess pjsua2 application sources.
+$ rm -r org/pjsip/pjsua2/app
+       }}}
+    1. Copy native library {{{libpjsua2.so}}} from {{{pjsip-apps/src/swig/java/android/app/src/main/jniLibs}}} to your project's {{{app/src/main/jniLibs}}} folder:
+       {{{
+$ cd $YOUR_PROJECT_DIR/app/src/main/jniLibs
+$ cp -r $PJSIP_DIR/{pjsip-apps/src/swig/java/android/app/src/main/jniLibs .
+       }}}
+ 1. Start writing your application, please check [http://www.pjsip.org/docs/book-latest/html/index.html pjsua2 docs] for reference.
+
+
+=== Pjsua sample application with telnet interface === #pjsua
+
+There is also the usual [http://www.pjsip.org/pjsua.htm pjsua] with telnet command line user interface, which is located under {{{pjsip-apps/src/pjsua/android}}}. It is not built by default and you need [http://www.swig.org/download.html SWIG] to build it. Application flow and user interface are handled mainly in the native level, so it doesn't use pjsua2 API with Java interface.
+
+Follow these steps to build pjsua:
+ 1. Make sure SWIG is in the build environment PATH.
+     - Alternatively, update SWIG path in {{{$PJDIR/pjsip-apps/src/pjsua/android/jni/Makefile}}} file.
+ 1. Run {{{make}}} from directory {{{$PJDIR/pjsip-apps/src/pjsua/android/jni}}} (note that the Android NDK root should be in the PATH), e.g:
+     {{{
+$ cd /path/to/your/pjsip/dir
+$ cd pjsip-apps/src/pjsua/android/jni
+$ make
+     }}}
+ 1. Open pjsua2 app project in Android Studio, it is located in {{{pjsip-apps/src/pjsua/android}}}.
+ 1. Run it.
+ 1. You will see telnet instructions on the device's screen. Telnet to this address to operate the application. See [wiki:PJSUA-CLI PJSUA CLI Manual] for command reference.
+
+
+{{{#!comment
+
+== Debugging native code with Eclipse == #debug-native
+
+Here are the steps for debugging PJSIP native code using Eclipse:
+ 1. Build PJSIP with debugging enabled, e.g: insert {{{CFLAGS += -g}}} into {{{user.mak}}} in PJSIP root directory.
+ 1. Make sure that the JNI part of the application is built using {{{ndk-build}}}. For reference, check pjsua's {{{Android.mk}}} build config in {{{pjsip-apps/src/pjsua/android/jni}}}, it contains sample of how to import PJSIP build settings (build search paths, build flags, etc) and SWIG invocation.
+ 1. Enable NDK plugin for Eclipse, check [http://tools.android.com/recent/usingthendkplugin this] and follow the instructions.
+     - CDT can also be fetched from [http://www.eclipse.org/cdt/downloads.php CDT download page], normally Eclipse for C/C++ will have CDT installed, just make sure that the CDT version is 7.0.2 or newer.
+ 1. It is recommended to introduce delay (about 5 seconds) in the application code between loading the native code library and calling any native functions (to be debugged), e.g:
+     {{{
+try {
+        System.loadLibrary("some_native_lib.so");
+} catch (UnsatisfiedLinkError e) {
+        return -1;
+}
+
+// Wait for GDB init
+if ((getApplicationInfo().flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0) {
+        try {
+                Thread.sleep(5000);
+        } catch (InterruptedException e) { }
+}
+
+// Start calling native functions here
+// ...
+     }}}
+ 1. Load the PJSIP project to Eclipse (if not yet), and try put breakpoint anywhere in the PJSIP code before launching the Android application debug configuration in Eclipse.
+
+}}}
+
+
 == Important Issue(s) when Developing Android Apps == #issues