From f9a25d2f2fb35b1fc7e5003e4b7d16eae08682f9 Mon Sep 17 00:00:00 2001
From: Alastor Wu <alwu@mozilla.com>
Date: Mon, 8 May 2017 14:10:41 +0800
Subject: [PATCH] Bug 1357639 - part2 : use enum for audio focus states.
 r=sebastian

MozReview-Commit-ID: LwLxs7WS5XF

--HG--
extra : rebase_source : e220227d7e08fde2731221c34a37c25061bad8c7
---
 .../mozilla/gecko/media/AudioFocusAgent.java  | 43 ++++++++++++-------
 1 file changed, 28 insertions(+), 15 deletions(-)

diff --git a/mobile/android/base/java/org/mozilla/gecko/media/AudioFocusAgent.java b/mobile/android/base/java/org/mozilla/gecko/media/AudioFocusAgent.java
index 010674ea04cb..d221987a14cb 100644
--- a/mobile/android/base/java/org/mozilla/gecko/media/AudioFocusAgent.java
+++ b/mobile/android/base/java/org/mozilla/gecko/media/AudioFocusAgent.java
@@ -9,6 +9,7 @@ import android.content.Context;
 import android.content.Intent;
 import android.media.AudioManager;
 import android.media.AudioManager.OnAudioFocusChangeListener;
+import android.support.annotation.VisibleForTesting;
 import android.util.Log;
 
 public class AudioFocusAgent {
@@ -18,12 +19,14 @@ public class AudioFocusAgent {
     private AudioManager mAudioManager;
     private OnAudioFocusChangeListener mAfChangeListener;
 
-    public static final String OWN_FOCUS = "own_focus";
-    public static final String LOST_FOCUS = "lost_focus";
-    public static final String LOST_FOCUS_TRANSIENT = "lost_focus_transient";
-    public static final String LOST_FOCUS_TRANSIENT_CAN_DUCK = "lost_focus_transient_can_duck";
+    public enum State {
+        OWN_FOCUS,
+        LOST_FOCUS,
+        LOST_FOCUS_TRANSIENT,
+        LOST_FOCUS_TRANSIENT_CAN_DUCK
+    }
 
-    private String mAudioFocusState = LOST_FOCUS;
+    private State mAudioFocusState = State.LOST_FOCUS;
 
     @WrapForJNI(calledFrom = "gecko")
     public static void notifyStartedPlaying() {
@@ -58,29 +61,29 @@ public class AudioFocusAgent {
                         Log.d(LOGTAG, "onAudioFocusChange, AUDIOFOCUS_LOSS");
                         notifyObservers("audioFocusChanged", "lostAudioFocus");
                         notifyMediaControlService(MediaControlService.ACTION_PAUSE_BY_AUDIO_FOCUS);
-                        mAudioFocusState = LOST_FOCUS;
+                        mAudioFocusState = State.LOST_FOCUS;
                         break;
                     case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT:
                         Log.d(LOGTAG, "onAudioFocusChange, AUDIOFOCUS_LOSS_TRANSIENT");
                         notifyObservers("audioFocusChanged", "lostAudioFocusTransiently");
                         notifyMediaControlService(MediaControlService.ACTION_PAUSE_BY_AUDIO_FOCUS);
-                        mAudioFocusState = LOST_FOCUS_TRANSIENT;
+                        mAudioFocusState = State.LOST_FOCUS_TRANSIENT;
                         break;
                     case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK:
                         Log.d(LOGTAG, "onAudioFocusChange, AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK");
                         notifyMediaControlService(MediaControlService.ACTION_START_AUDIO_DUCK);
-                        mAudioFocusState = LOST_FOCUS_TRANSIENT_CAN_DUCK;
+                        mAudioFocusState = State.LOST_FOCUS_TRANSIENT_CAN_DUCK;
                         break;
                     case AudioManager.AUDIOFOCUS_GAIN:
-                        if (mAudioFocusState.equals(LOST_FOCUS_TRANSIENT_CAN_DUCK)) {
+                        if (mAudioFocusState.equals(State.LOST_FOCUS_TRANSIENT_CAN_DUCK)) {
                             Log.d(LOGTAG, "onAudioFocusChange, AUDIOFOCUS_GAIN (from DUCKING)");
                             notifyMediaControlService(MediaControlService.ACTION_STOP_AUDIO_DUCK);
-                        } else if (mAudioFocusState.equals(LOST_FOCUS_TRANSIENT)) {
+                        } else if (mAudioFocusState.equals(State.LOST_FOCUS_TRANSIENT)) {
                             Log.d(LOGTAG, "onAudioFocusChange, AUDIOFOCUS_GAIN");
                             notifyObservers("audioFocusChanged", "gainAudioFocus");
                             notifyMediaControlService(MediaControlService.ACTION_RESUME_BY_AUDIO_FOCUS);
                         }
-                        mAudioFocusState = OWN_FOCUS;
+                        mAudioFocusState = State.OWN_FOCUS;
                         break;
                     default:
                 }
@@ -109,7 +112,7 @@ public class AudioFocusAgent {
     private AudioFocusAgent() {}
 
     private void requestAudioFocusIfNeeded() {
-        if (mAudioFocusState.equals(OWN_FOCUS)) {
+        if (mAudioFocusState.equals(State.OWN_FOCUS)) {
             return;
         }
 
@@ -121,18 +124,18 @@ public class AudioFocusAgent {
             "AudioFocus request granted" : "AudioFoucs request failed";
         Log.d(LOGTAG, focusMsg);
         if (result == AudioManager.AUDIOFOCUS_GAIN) {
-            mAudioFocusState = OWN_FOCUS;
+            mAudioFocusState = State.OWN_FOCUS;
         }
     }
 
     private void abandonAudioFocusIfNeeded() {
-        if (!mAudioFocusState.equals(OWN_FOCUS)) {
+        if (!mAudioFocusState.equals(State.OWN_FOCUS)) {
             return;
         }
 
         Log.d(LOGTAG, "Abandon AudioFocus");
         mAudioManager.abandonAudioFocus(mAfChangeListener);
-        mAudioFocusState = LOST_FOCUS;
+        mAudioFocusState = State.LOST_FOCUS;
     }
 
     private void notifyMediaControlService(String action) {
@@ -140,4 +143,14 @@ public class AudioFocusAgent {
         intent.setAction(action);
         mContext.startService(intent);
     }
+
+    @VisibleForTesting
+    public State getAudioFocusState() {
+        return mAudioFocusState;
+    }
+
+    @VisibleForTesting
+    public void changeAudioFocus(int focusChange) {
+        mAfChangeListener.onAudioFocusChange(focusChange);
+    }
 }