Changes between Version 87 and Version 88 of Getting-Started/iPhone

Timestamp:

Jun 15, 2016 2:25:51 AM (8 years ago)

Author:

ming

Comment:

--

Getting-Started/iPhone

@@ -60 +60 @@
  * for more info, run {{{./configure-iphone --help}}}
  * other customizations are similar to what is explained in [wiki:Getting-Started/Autoconf Building with GNU] page.
+
+=== Supporting multiple architectures (armv6, armv7, armv7s, arm64, and so on) ===
+
+You need to compile separately for each architecture. If your iPhone SDK has '''{{{llvm-gcc}}}''' compiler (which is the supported compiler starting iOS SDK 5) or '''{{{clang}}}''', then you need to set '''{{{ARCH}}}''' environment variable to the desired architecture before running {{{configure-iphone}}}, for example:
+{{{
+export ARCH="-arch arm64"
+}}}
+
+Then you need to combine the resulting libraries using the '''{{{lipo}}}''' command. For example:
+
+{{{
+lipo -arch armv6 lib/armv6/libpjlib.a -arch armv7 lib/armv7/libpjlib.a -create -output lib/libpjlib.a
+}}}
 
 == Simulator ==
@@ -173 +186 @@
 == Common problems ==
 
-=== Guide to accept calls in the background after ```kCFStreamNetworkServiceTypeVoIP``` is deprecated (iOS 9) ===
+=== Guide to accept calls in the background after ```kCFStreamNetworkServiceTypeVoIP``` is deprecated (iOS 9) === #bg-call
 
 Starting in iOS 9, [https://developer.apple.com/library/ios/documentation/CoreFoundation/Reference/CFSocketStreamRef/index.html#//apple_ref/doc/constant_group/Stream_Service_Types kCFStreamNetworkServiceTypeVoIP] is deprecated. Apple recommends that applications use VoIP Push Notifications (using !PushKit framework) to avoid persistent connections as described in the [https://developer.apple.com/library/ios/documentation/Performance/Conceptual/EnergyGuide-iOS/OptimizeVoIP.html Apple's official doc]. This will require application to implement the setup and handling of push notifications in the application layer (for additional guides, you can refer to [http://stackoverflow.com/questions/27245808/implement-pushkit-and-test-in-development-behavior here] and [http://pierremarcairoldi.com/ios-8-voip-notifications/ here]). For now, PJSIP will still use ```kCFStreamNetworkServiceTypeVoIP```, if you want to disable it right away, you can set ```PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT``` to 0.
-
-=== Unable to accept incoming call in background mode (iOS4) ===
-
-If while in the background, ipjsua (or your application) is unable to detect if there is an incoming call and display the local notification:
- 1. Note that background feature only works with TCP.
- 2. Make sure that voip is included in the required background modes (UIBackgroundModes) in the application’s Info.plist file.
- 3. Make sure that the TCP socket is successfully wrapped with CFReadStreamRef (check if there is a message: "Failed to configure TCP transport for VoIP usage").
- 4. Check whether you can accept the incoming call by bringing the app to the foreground. If yes, make sure that the incoming call request comes from the wrapped TCP socket (check the log for the INVITE request).
-
-Note: these steps do not troubleshoot audio problems.
 
 === Audio session management issue (iOS7) ===
@@ -203 +206 @@
  - [https://developer.apple.com/library/ios/documentation/AVFoundation/Reference/AVAudioSession_ClassReference/#//apple_ref/occ/instm/AVAudioSession/overrideOutputAudioPort:error: AVAudioSession::overrideOutputAudioPort] for toggling on/off built-in loudspeaker.
 
-=== Audio issue (no audio) (iOS7) ===
-
-There are a few reports that the audio is not working on iOS 7 (so far it's only reported to happen in iPhone 5) after getting the following error:
-
-{{{
-iPhone mediaserverd[45] <Error>: 10:53:59.986 ERROR:     [0x240b000] 740: _vp: initialize hw input: fs mismatched! REF=0.000000Hz, MIC=44100.000000Hz
-iPhone mediaserverd[45] <Error>: Resampler2 bad sample rate(s) :        0.00    16000.00
-}}}
-
-One solution is to set the sound device's clock rate to 44100 Hz as to avoid resampling.
-
-=== Audio issues (inability to mute, volume control center synchronization, playback reduced volume) (iOS7) ===
-
-There are several issues with the use of Voice Processing IO Audio Unit in iOS 7, such as unable to mute the volume using the side volume button, unable to synchronize with the control center volume slide bar, significantly reduced volume for audio playback to speaker after a call. Currently there is no workaround for this. Please refer to ticket #1697 for more details.
-
-=== Supporting multiple architectures (armv6, armv7, armv7s, arm64, and so on) ===
-
-You need to compile separately for each architecture. If your iPhone SDK has '''{{{llvm-gcc}}}''' compiler (which is the supported compiler starting iOS SDK 5) or '''{{{clang}}}''', then you need to set '''{{{ARCH}}}''' environment variable to the desired architecture before running {{{configure-iphone}}}, for example:
-{{{
-export ARCH="-arch arm64"
-}}}
-
-Then you need to combine the resulting libraries using the '''{{{lipo}}}''' command. For example:
-
-{{{
-lipo -arch armv6 lib/armv6/libpjlib.a -arch armv7 lib/armv7/libpjlib.a -create -output lib/libpjlib.a
-}}}
-
-=== Unable to support Bluetooth input ===
-
-Since Bluetooth input support is only available for iOS 3.1 or later, you need to specifically specify that your deployment target is iOS 3.1 or above. You can do this either in '''{{{user.mak}}}''':
-{{{
-export CFLAGS += -D__IPHONE_OS_VERSION_MIN_REQUIRED=30100
-}}}
-or in '''{{{config_site.h}}}''':
-{{{
-#define __IPHONE_OS_VERSION_MIN_REQUIRED 30100
-}}}
-You need to recompile PJSIP after this.
-
-=== Problem with interruption (by a phone call or an alarm), headset plug/unplug, or Bluetooth input === #interruption
+=== Crash after calling PJLIB APIs using Grand Central Dispatch (GCD) === #gcd-crash
+
+PJLIB API should be called from a registered thread, otherwise it will raise assertion such as "Calling pjlib from unknown/external thread...". With GCD, we cannot really be sure of which thread executing the PJLIB function. Registering that thread to PJLIB seems to be a simple and easy solution, however it potentially introduces a random crash which is harder to debug. Here are few possible crash scenarios:
+ - PJLIB's {{{pj_thread_desc}}} should remain valid until the registered thread stopped, otherwise crash of invalid pointer access may occur, e.g: in {{{pj_thread_check_stack()}}}.
+ - Some compatibility problems between GCD and PJLIB, see #1837 for more info.
+
+If you want to avoid any possibility of blocking operation by PJLIB (or any higher API layer such as PJMEDIA, PJNATH, PJSUA that usually calls PJLIB), instead of dispatching the task using GCD, the safest way is to create and manage your own thread pool and register that thread pool to PJLIB. Or alternatively, simply use PJSUA timer mechanism (with zero delay), see {{{pjsua_schedule_timer()/pjsua_schedule_timer2()}}} docs for more info.
+
+=== Audio lost or other issues with interruption (by a phone call or an alarm), headset plug/unplug, or Bluetooth input === #interruption
 
 For devices running iOS 4.0 or later, you need to enable your application to respond to remote-control events. This allows PJSIP to properly receive and process the above events. You can do this by adding the following code in your application:
@@ -251 +222 @@
 For more details, please refer to Apple's doc on [http://developer.apple.com/library/ios/#documentation/EventHandling/Conceptual/EventHandlingiPhoneOS/RemoteControl/RemoteControl.html Remote Control of Multimedia].
 
-=== Audio lost after interruption (iOS 7) === #interruption2
-
-It has been reported that any time an audio interruption happens, audio is lost until the application is killed/restarted, also reported that this occurs only on iOS7.
+It has also been reported that any time an audio interruption happens, audio is lost until the application is killed/restarted, also reported that this occurs only on iOS7.
 
 Here is the reported working solution:
@@ -270 +239 @@
    1. resume any other media if any
    1. if sound device was not shutdown forcefully, first connection to the bridge will cause sound device to be started, otherwise manual restarting the sound device, by setting playback & capture device, is required.
-
-
-=== Sound not working in the simulator ===
-
-Go to System Preferences > Sound > Sound Effects and then uncheck and recheck "Play user interface sound effects". If it still doesn't work, you can try some other suggestions [http://stackoverflow.com/questions/302399/sound-not-working-in-iphone-simulator here].
 
 === SIP transport keepalive while in background === #keepalive
@@ -314 +278 @@
 
 
-=== Crash after calling PJLIB APIs using Grand Central Dispatch (GCD) === #gcd-crash
-
-PJLIB API should be called from a registered thread, otherwise it will raise assertion such as "Calling pjlib from unknown/external thread...". With GCD, we cannot really be sure of which thread executing the PJLIB function. Registering that thread to PJLIB seems to be a simple and easy solution, however it potentially introduces a random crash which is harder to debug. Here are few possible crash scenarios:
- - PJLIB's {{{pj_thread_desc}}} should remain valid until the registered thread stopped, otherwise crash of invalid pointer access may occur, e.g: in {{{pj_thread_check_stack()}}}.
- - Some compatibility problems between GCD and PJLIB, see #1837 for more info.
-
-If you want to avoid any possibility of blocking operation by PJLIB (or any higher API layer such as PJMEDIA, PJNATH, PJSUA that usually calls PJLIB), instead of dispatching the task using GCD, the safest way is to create and manage your own thread pool and register that thread pool to PJLIB. Or alternatively, simply use PJSUA timer mechanism (with zero delay), see {{{pjsua_schedule_timer()/pjsua_schedule_timer2()}}} docs for more info.
-
+== Other Problems (problem specific to a particular iOS version/device/simulator) ==
+
+=== Unable to accept incoming call in background mode ===
+
+Starting in iOS 9, this method to accept incoming call in bg is deprecated, please have a look at [#bg-call].
+
+If while in the background, ipjsua (or your application) is unable to detect if there is an incoming call and display the local notification:
+ 1. Note that background feature only works with TCP.
+ 2. Make sure that voip is included in the required background modes (UIBackgroundModes) in the application’s Info.plist file.
+ 3. Make sure that the TCP socket is successfully wrapped with CFReadStreamRef (check if there is a message: "Failed to configure TCP transport for VoIP usage").
+ 4. Check whether you can accept the incoming call by bringing the app to the foreground. If yes, make sure that the incoming call request comes from the wrapped TCP socket (check the log for the INVITE request).
+
+Note: these steps do not troubleshoot audio problems.
+
+=== Audio issue (no audio) (iOS7) ===
+
+There are a few reports that the audio is not working on iOS 7 (so far it's only reported to happen in iPhone 5) after getting the following error:
+
+{{{
+iPhone mediaserverd[45] <Error>: 10:53:59.986 ERROR:     [0x240b000] 740: _vp: initialize hw input: fs mismatched! REF=0.000000Hz, MIC=44100.000000Hz
+iPhone mediaserverd[45] <Error>: Resampler2 bad sample rate(s) :        0.00    16000.00
+}}}
+
+One solution is to set the sound device's clock rate to 44100 Hz as to avoid resampling.
+
+=== Audio issues (inability to mute, volume control center synchronization, playback reduced volume) (iOS7) ===
+
+There are several issues with the use of Voice Processing IO Audio Unit in iOS 7, such as unable to mute the volume using the side volume button, unable to synchronize with the control center volume slide bar, significantly reduced volume for audio playback to speaker after a call. Currently there is no workaround for this. Please refer to ticket #1697 for more details.
+
+=== Unable to support Bluetooth input ===
+
+Since Bluetooth input support is only available for iOS 3.1 or later, you need to specifically specify that your deployment target is iOS 3.1 or above. You can do this either in '''{{{user.mak}}}''':
+{{{
+export CFLAGS += -D__IPHONE_OS_VERSION_MIN_REQUIRED=30100
+}}}
+or in '''{{{config_site.h}}}''':
+{{{
+#define __IPHONE_OS_VERSION_MIN_REQUIRED 30100
+}}}
+You need to recompile PJSIP after this.
+
+=== Sound not working in the simulator ===
+
+Go to System Preferences > Sound > Sound Effects and then uncheck and recheck "Play user interface sound effects". If it still doesn't work, you can try some other suggestions [http://stackoverflow.com/questions/302399/sound-not-working-in-iphone-simulator here].
 
 === List of Issues ===