Extends how AppRTCMobile handles audio focus on Android

webrtc/examples/androidapp/src/org/appspot/apprtc/AppRTCAudioManager.java

 /*
  *  Copyright 2014 The WebRTC Project Authors. All rights reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
@@ skipping 57 matching lines @@
   // Contains the currently selected audio device.
   private AudioDevice selectedAudioDevice;
 
   // Contains a list of available audio devices. A Set collection is used to
   // avoid duplicate elements.
   private final Set<AudioDevice> audioDevices = new HashSet<AudioDevice>();
 
   // Broadcast receiver for wired headset intent broadcasts.
   private BroadcastReceiver wiredHeadsetReceiver;
 
+  // Callback method for changes in audio focus.
+  private AudioManager.OnAudioFocusChangeListener audioFocusChangeListener;
+
   // This method is called when the proximity sensor reports a state change,
   // e.g. from "NEAR to FAR" or from "FAR to NEAR".
   private void onProximitySensorChangedState() {
     if (!useSpeakerphone.equals(SPEAKERPHONE_AUTO)) {
       return;
     }
 
     // The proximity sensor should only be activated when there are exactly two
     // available audio devices.
     if (audioDevices.size() == 2 && audioDevices.contains(AppRTCAudioManager.AudioDevice.EARPIECE)
@@ skipping 48 matching lines @@
     Log.d(TAG, "init");
     if (initialized) {
       return;
     }
 
     // Store current audio state so we can restore it when close() is called.
     savedAudioMode = audioManager.getMode();
     savedIsSpeakerPhoneOn = audioManager.isSpeakerphoneOn();
     savedIsMicrophoneMute = audioManager.isMicrophoneMute();
 
-    // Request audio focus before making any device switch.
-    audioManager.requestAudioFocus(
-        null, AudioManager.STREAM_VOICE_CALL, AudioManager.AUDIOFOCUS_GAIN_TRANSIENT);
+    // Create an AudioManager.OnAudioFocusChangeListener instance.
+    audioFocusChangeListener = new AudioManager.OnAudioFocusChangeListener() {
+      // Called on the listener to notify if the audio focus for this listener has been changed.
+      // The |focusChange| value indicates whether the focus was gained, whether the focus was lost,
+      // and whether that loss is transient, or whether the new focus holder will hold it for an
+      // unknown amount of time.
+      // TODO(henrika): possibly extend support of handling audio-focus changes. Only contains
+      // logging for now.
+      @Override
+      public void onAudioFocusChange(int focusChange) {
+        String typeOfChange = "AUDIOFOCUS_NOT_DEFINED";
+        switch (focusChange) {
+          case AudioManager.AUDIOFOCUS_GAIN:
+            typeOfChange = "AUDIOFOCUS_GAIN";
+            break;
+          case AudioManager.AUDIOFOCUS_GAIN_TRANSIENT:
+            typeOfChange = "AUDIOFOCUS_GAIN_TRANSIENT";
+            break;
+          case AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE:
+            typeOfChange = "AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE";
+            break;
+          case AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK:
+            typeOfChange = "AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK";
+            break;
+          case AudioManager.AUDIOFOCUS_LOSS:
+            typeOfChange = "AUDIOFOCUS_LOSS";
+            break;
+          case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT:
+            typeOfChange = "AUDIOFOCUS_LOSS_TRANSIENT";
+            break;
+          case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK:
+            typeOfChange = "AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK";
+            break;
+          default:
+            typeOfChange = "AUDIOFOCUS_INVALID";
+            break;
+        }
+        Log.d(TAG, "onAudioFocusChange: " + typeOfChange);
+      }
+    };
+
+    // Request audio playout focus (without ducking) and install listener for changes in focus.
+    int result = audioManager.requestAudioFocus(audioFocusChangeListener,
+        AudioManager.STREAM_VOICE_CALL, AudioManager.AUDIOFOCUS_GAIN_TRANSIENT);
+    if (result == AudioManager.AUDIOFOCUS_REQUEST_GRANTED) {
+      Log.d(TAG, "Audio focus request granted for VOICE_CALL streams");
+    } else {
+      Log.e(TAG, "Audio focus request failed");
+    }
 
     // Start by setting MODE_IN_COMMUNICATION as default audio mode. It is
     // required to be in this mode when playout and/or recording starts for
     // best possible VoIP performance.
     // TODO(henrika): we migh want to start with RINGTONE mode here instead.
     audioManager.setMode(AudioManager.MODE_IN_COMMUNICATION);
 
     // Always disable microphone mute during a WebRTC call.
     setMicrophoneMute(false);
 
@@ skipping 14 matching lines @@
     if (!initialized) {
       return;
     }
 
     unregisterForWiredHeadsetIntentBroadcast();
 
     // Restore previously stored audio states.
     setSpeakerphoneOn(savedIsSpeakerPhoneOn);
     setMicrophoneMute(savedIsMicrophoneMute);
     audioManager.setMode(savedAudioMode);
-    audioManager.abandonAudioFocus(null);
+
+    // Abandon audio focus. Gives the previous focus owner, if any, focus.
+    audioManager.abandonAudioFocus(audioFocusChangeListener);
+    audioFocusChangeListener = null;
+    Log.d(TAG, "Abandoned audio focus for VOICE_CALL streams");
 
     if (proximitySensor != null) {
       proximitySensor.stop();
       proximitySensor = null;
     }
 
     initialized = false;
   }
 
   /** Changes selection of the currently active audio device. */
@@ skipping 163 matching lines @@
       Log.e(TAG, "Invalid device list");
     }
 
     if (onStateChangeListener != null) {
       // Run callback to notify a listening client. The client can then
       // use public getters to query the new state.
       onStateChangeListener.run();
     }
   }
 }