fixed #17685: [android] Audio in game couldn't be mute while a ring or a call is coming (#17686)

* fixed #17685: [android] Audio in game couldn't be mute while a ring or a call is coming

* Updates comments in AudioEngine-inl.cpp and removes extra empty line in javaactivity-android.cpp

* Puts audio focus relative code to another java file named Cocos2dxAudioFocusManager.java
Renames setAudioFocusLost to setAudioFocus.

* Renames JNI function.

* Register audio focus in onResume and unregister it in onPause.

Author: James Chen

cocos/audio/android/AudioEngine-inl.cpp

@@ -23,8 +23,6 @@
  ****************************************************************************/
 #if CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID
 
-#define LOG_TAG "cocos2d-x debug info"
-
 #include "audio/android/AudioEngine-inl.h"
 
 #include <unistd.h>
@@ -43,6 +41,7 @@
 #include "base/CCEventDispatcher.h"
 #include "base/CCEventType.h"
 #include "base/CCEventListenerCustom.h"
+#include "base/ccUTF8.h"
 #include "platform/android/CCFileUtils-android.h"
 #include "platform/android/jni/Java_org_cocos2dx_lib_Cocos2dxHelper.h"
 
@@ -55,8 +54,14 @@
 using namespace cocos2d;
 using namespace cocos2d::experimental;
 
-#define DELAY_TIME_TO_REMOVE 0.5f
+// Audio focus values synchronized with which in cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java
+static const int AUDIOFOCUS_GAIN = 0;
+static const int AUDIOFOCUS_LOST = 1;
+static const int AUDIOFOCUS_LOST_TRANSIENT = 2;
+static const int AUDIOFOCUS_LOST_TRANSIENT_CAN_DUCK = 3;
 
+static int __currentAudioFocus = AUDIOFOCUS_GAIN;
+static AudioEngineImpl* __impl = nullptr;
 
 class CallerThreadUtils : public ICallerThreadUtils
 {
@@ -117,6 +122,7 @@ AudioEngineImpl::AudioEngineImpl()
     , _lazyInitLoop(true)
 {
     __callerThreadUtils.setCallerThreadId(std::this_thread::get_id());
+    __impl = this;
 }
 
 AudioEngineImpl::~AudioEngineImpl()
@@ -145,6 +151,8 @@ AudioEngineImpl::~AudioEngineImpl()
     {
         Director::getInstance()->getEventDispatcher()->removeEventListener(_onResumeListener);
     }
+
+    __impl = nullptr;
 }
 
 bool AudioEngineImpl::init()
@@ -225,6 +233,14 @@ void AudioEngineImpl::onEnterForeground(EventCustom* event)
     _urlAudioPlayersNeedResume.clear();
 }
 
+void AudioEngineImpl::setAudioFocusForAllPlayers(bool isFocus)
+{
+    for (const auto& e : _audioPlayers)
+    {
+        e.second->setAudioFocus(isFocus);
+    }
+}
+
 int AudioEngineImpl::play2d(const std::string &filePath ,bool loop ,float volume)
 {
     ALOGV("play2d, _audioPlayers.size=%d", (int)_audioPlayers.size());
@@ -274,6 +290,7 @@ int AudioEngineImpl::play2d(const std::string &filePath ,bool loop ,float volume
 
             player->setLoop(loop);
             player->setVolume(volume);
+            player->setAudioFocus(__currentAudioFocus == AUDIOFOCUS_GAIN);
             player->play();
         } 
         else
@@ -439,4 +456,31 @@ void AudioEngineImpl::uncacheAll()
     }
 }
 
+// It's invoked from javaactivity-android.cpp
+void cocos_audioengine_focus_change(int focusChange)
+{
+    if (focusChange < AUDIOFOCUS_GAIN || focusChange > AUDIOFOCUS_LOST_TRANSIENT_CAN_DUCK)
+    {
+        CCLOGERROR("cocos_audioengine_focus_change: unknown value: %d", focusChange);
+        return;
+    }
+    CCLOG("cocos_audioengine_focus_change: %d", focusChange);
+    __currentAudioFocus = focusChange;
+
+    if (__impl == nullptr)
+    {
+        CCLOGWARN("cocos_audioengine_focus_change: AudioEngineImpl isn't ready!");
+        return;
+    }
+
+    if (__currentAudioFocus == AUDIOFOCUS_GAIN)
+    {
+        __impl->setAudioFocusForAllPlayers(true);
+    }
+    else
+    {
+        __impl->setAudioFocusForAllPlayers(false);
+    }
+}
+
 #endif

cocos/audio/android/AudioEngine-inl.h

@@ -72,6 +72,7 @@ class AudioEngineImpl : public cocos2d::Ref
     void uncacheAll();
     void preload(const std::string& filePath, const std::function<void(bool)>& callback);
 
+    void setAudioFocusForAllPlayers(bool isFocus);
 private:
 
     void onEnterBackground(EventCustom* event);

cocos/audio/android/IAudioPlayer.h

@@ -68,6 +68,8 @@ class IAudioPlayer
 
     virtual float getVolume() const = 0;
 
+    virtual void setAudioFocus(bool isFocus) = 0;
+
     virtual void setLoop(bool isLoop) = 0;
 
     virtual bool isLoop() const = 0;

cocos/audio/android/PcmAudioPlayer.cpp

@@ -110,6 +110,11 @@ float PcmAudioPlayer::getVolume() const
     return _track->getVolume();
 }
 
+void PcmAudioPlayer::setAudioFocus(bool isFocus)
+{
+    _track->setAudioFocus(isFocus);
+}
+
 void PcmAudioPlayer::setLoop(bool isLoop)
 {
     _track->setLoop(isLoop);

cocos/audio/android/PcmAudioPlayer.h

@@ -62,6 +62,8 @@ class PcmAudioPlayer : public IAudioPlayer
 
     virtual float getVolume() const override;
 
+    virtual void setAudioFocus(bool isFocus) override;
+
     virtual void setLoop(bool isLoop) override;
 
     virtual bool isLoop() const override;

cocos/audio/android/Track.cpp

@@ -41,6 +41,7 @@ Track::Track(const PcmData &pcmData)
         , _isVolumeDirty(true)
         , _isLoop(false)
         , _isInitialized(false)
+        , _isAudioFocus(true)
 {
     init(_pcmData.pcmBuffer->data(), _pcmData.numFrames, _pcmData.bitsPerSample / 8 * _pcmData.numChannels);
 }
@@ -52,7 +53,8 @@ Track::~Track()
 
 gain_minifloat_packed_t Track::getVolumeLR()
 {
-    gain_minifloat_t v = gain_from_float(_volume);
+    float volume = _isAudioFocus ? _volume : 0.0f;
+    gain_minifloat_t v = gain_from_float(volume);
     return gain_minifloat_pack(v, v);
 }
 
@@ -83,6 +85,12 @@ float Track::getVolume() const
     return _volume;
 }
 
+void Track::setAudioFocus(bool isFocus)
+{
+    _isAudioFocus = isFocus;
+    setVolumeDirty(true);
+}
+
 void Track::setState(State state)
 {
     std::lock_guard<std::mutex> lk(_stateMutex);

cocos/audio/android/Track.h

@@ -62,6 +62,8 @@ class Track : public PcmBufferProvider, public IVolumeProvider
     void setVolume(float volume);
     float getVolume() const;
 
+    void setAudioFocus(bool isFocus);
+
     bool setPosition(float pos);
     float getPosition() const;
 
@@ -96,6 +98,7 @@ class Track : public PcmBufferProvider, public IVolumeProvider
     std::mutex _volumeDirtyMutex;
     bool _isLoop;
     bool _isInitialized;
+    bool _isAudioFocus;
 
     friend class AudioMixerController;
 };

cocos/audio/android/UrlAudioPlayer.cpp

@@ -60,7 +60,7 @@ UrlAudioPlayer::UrlAudioPlayer(SLEngineItf engineItf, SLObjectItf outputMixObjec
         : _engineItf(engineItf), _outputMixObj(outputMixObject),
           _callerThreadUtils(callerThreadUtils), _id(-1), _assetFd(nullptr),
           _playObj(nullptr), _playItf(nullptr), _seekItf(nullptr), _volumeItf(nullptr),
-          _volume(0.0f), _duration(0.0f), _isLoop(false), _state(State::INVALID),
+          _volume(0.0f), _duration(0.0f), _isLoop(false), _isAudioFocus(true), _state(State::INVALID),
           _playEventCallback(nullptr), _isDestroyed(std::make_shared<bool>(false))
 {
     std::call_once(__onceFlag, [](){
@@ -215,16 +215,36 @@ void UrlAudioPlayer::play()
     }
 }
 
-void UrlAudioPlayer::setVolume(float volume)
+void UrlAudioPlayer::setVolumeToSLPlayer(float volume)
 {
-    _volume = volume;
     int dbVolume = 2000 * log10(volume);
     if (dbVolume < SL_MILLIBEL_MIN)
     {
         dbVolume = SL_MILLIBEL_MIN;
     }
     SLresult r = (*_volumeItf)->SetVolumeLevel(_volumeItf, dbVolume);
-    SL_RETURN_IF_FAILED(r, "UrlAudioPlayer::setVolume %d failed", dbVolume);
+    SL_RETURN_IF_FAILED(r, "UrlAudioPlayer::setVolumeToSLPlayer %d failed", dbVolume);
+}
+
+void UrlAudioPlayer::setVolume(float volume)
+{
+    _volume = volume;
+    if (_isAudioFocus)
+    {
+        setVolumeToSLPlayer(_volume);
+    }
+}
+
+float UrlAudioPlayer::getVolume() const
+{
+    return _volume;
+}
+
+void UrlAudioPlayer::setAudioFocus(bool isFocus)
+{
+    _isAudioFocus = isFocus;
+    float volume = _isAudioFocus ? _volume : 0.0f;
+    setVolumeToSLPlayer(volume);
 }
 
 float UrlAudioPlayer::getDuration() const
@@ -362,11 +382,6 @@ void UrlAudioPlayer::rewind()
 // Not supported currently. since cocos audio engine will new -> prepare -> play again.
 }
 
-float UrlAudioPlayer::getVolume() const
-{
-    return _volume;
-}
-
 void UrlAudioPlayer::setLoop(bool isLoop)
 {
     _isLoop = isLoop;

cocos/audio/android/UrlAudioPlayer.h

@@ -68,6 +68,8 @@ class UrlAudioPlayer : public IAudioPlayer
 
     virtual float getVolume() const override;
 
+    virtual void setAudioFocus(bool isFocus) override;
+
     virtual void setLoop(bool isLoop) override;
 
     virtual bool isLoop() const override;
@@ -97,6 +99,8 @@ class UrlAudioPlayer : public IAudioPlayer
 
     void playEventCallback(SLPlayItf caller, SLuint32 playEvent);
 
+    void setVolumeToSLPlayer(float volume);
+
 private:
     SLEngineItf _engineItf;
     SLObjectItf _outputMixObj;
@@ -115,6 +119,7 @@ class UrlAudioPlayer : public IAudioPlayer
     float _volume;
     float _duration;
     bool _isLoop;
+    bool _isAudioFocus;
     State _state;
 
     PlayEventCallback _playEventCallback;

cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java

@@ -33,16 +33,13 @@ of this software and associated documentation files (the "Software"), to deal
 import android.opengl.GLSurfaceView;
 import android.os.Build;
 import android.os.Bundle;
-import android.os.Handler;
 import android.os.Message;
 import android.preference.PreferenceManager.OnActivityResultListener;
-import android.util.AttributeSet;
 import android.util.Log;
-import android.view.ViewGroup;
 import android.view.View;
+import android.view.ViewGroup;
 import android.view.Window;
 import android.view.WindowManager;
-import android.widget.FrameLayout;
 
 import org.cocos2dx.lib.Cocos2dxHelper.Cocos2dxHelperListener;
 
@@ -74,7 +71,7 @@ public abstract class Cocos2dxActivity extends Activity implements Cocos2dxHelpe
     public Cocos2dxGLSurfaceView getGLSurfaceView(){
         return  mGLSurfaceView;
     }
-    
+
     public static Context getContext() {
         return sContext;
     }
@@ -135,12 +132,13 @@ protected void onCreate(final Bundle savedInstanceState) {
         Window window = this.getWindow();
         window.setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_ADJUST_PAN);
 
+        // Audio configuration
         this.setVolumeControlStream(AudioManager.STREAM_MUSIC);
     }
 
     //native method,call GLViewImpl::getGLContextAttrs() to get the OpenGL ES context attributions
     private static native int[] getGLContextAttrs();
-    
+
     // ===========================================================
     // Getter & Setter
     // ===========================================================
@@ -153,6 +151,7 @@ protected void onCreate(final Bundle savedInstanceState) {
     protected void onResume() {
     	Log.d(TAG, "onResume()");
         super.onResume();
+        Cocos2dxAudioFocusManager.registerAudioFocusListener(this);
         this.hideVirtualButton();
        	resumeIfHasFocus();
     }
@@ -178,12 +177,14 @@ private void resumeIfHasFocus() {
     protected void onPause() {
     	Log.d(TAG, "onPause()");
         super.onPause();
+        Cocos2dxAudioFocusManager.unregisterAudioFocusListener(this);
         Cocos2dxHelper.onPause();
         mGLSurfaceView.onPause();
     }
 
     @Override
     protected void onDestroy() {
+        Cocos2dxAudioFocusManager.unregisterAudioFocusListener(this);
         super.onDestroy();
     }