fixed #16477: [android, audio] Deadlock if preload the same file more than 3 times in preload callback. (#16478)

And added test case.

cocos/audio/android/AudioPlayerProvider.cpp

@@ -210,16 +210,16 @@ void AudioPlayerProvider::preloadEffect(const std::string &audioFilePath, const
         return;
     }
 
+    _pcmCacheMutex.lock();
+    auto&& iter = _pcmCache.find(audioFilePath);
+    if (iter != _pcmCache.end())
     {
-        std::lock_guard<std::mutex> lk(_pcmCacheMutex);
+        ALOGV("preload return from cache: (%s)", audioFilePath.c_str());
-        auto&& iter = _pcmCache.find(audioFilePath);
+        _pcmCacheMutex.unlock();
-        if (iter != _pcmCache.end())
+        cb(true, iter->second);
-        {
+        return;
-            ALOGV("preload return from cache: (%s)", audioFilePath.c_str());
-            cb(true, iter->second);
-            return;
-        }
     }
+    _pcmCacheMutex.unlock();
 
     auto info = getFileInfo(audioFilePath);
     preloadEffect(info, [this, cb, audioFilePath](bool succeed, PcmData data){
@@ -246,17 +246,17 @@ void AudioPlayerProvider::preloadEffect(const AudioFileInfo &info, const Preload
     {
         std::string audioFilePath = info.url;
 
+        // 1. First time check, if it wasn't in the cache, goto 2 step
+        _pcmCacheMutex.lock();
+        auto&& iter = _pcmCache.find(audioFilePath);
+        if (iter != _pcmCache.end())
         {
-            // 1. First time check, if it wasn't in the cache, goto 2 step
+            ALOGV("1. Return pcm data from cache, url: %s", info.url.c_str());
-            std::lock_guard<std::mutex> lk(_pcmCacheMutex);
+            _pcmCacheMutex.unlock();
-            auto&& iter = _pcmCache.find(audioFilePath);
+            cb(true, iter->second);
-            if (iter != _pcmCache.end())
+            return;
-            {
-                ALOGV("1. Return pcm data from cache, url: %s", info.url.c_str());
-                cb(true, iter->second);
-                return;
-            }
         }
+        _pcmCacheMutex.unlock();
 
         {
             // 2. Check whether the audio file is being preloaded, if it has been removed from map just now,
@@ -273,17 +273,19 @@ void AudioPlayerProvider::preloadEffect(const AudioFileInfo &info, const Preload
                 return;
             }
 
-            {   // 3. Check it in cache again. If it has been removed from map just now, the file is in
+           // 3. Check it in cache again. If it has been removed from map just now, the file is in
-                // the cache absolutely.
+            // the cache absolutely.
-                std::lock_guard<std::mutex> lk2(_pcmCacheMutex);
+            _pcmCacheMutex.lock();
-                auto&& iter = _pcmCache.find(audioFilePath);
+            auto&& iter = _pcmCache.find(audioFilePath);
-                if (iter != _pcmCache.end())
+            if (iter != _pcmCache.end())
-                {
+            {
-                    ALOGV("2. Return pcm data from cache, url: %s", info.url.c_str());
+                ALOGV("2. Return pcm data from cache, url: %s", info.url.c_str());
-                    cb(true, iter->second);
+                _pcmCacheMutex.unlock();
-                    return;
+                cb(true, iter->second);
-                }
+                return;
             }
+            _pcmCacheMutex.unlock();
+
 
             PreloadCallbackParam param;
             param.callback = cb;

tests/cpp-tests/Classes/NewAudioEngineTest/NewAudioEngineTest.cpp

@@ -43,6 +43,7 @@ AudioEngineTests::AudioEngineTests()
     ADD_TEST_CASE(AudioSwitchStateTest);
     ADD_TEST_CASE(AudioSmallFileTest);
     ADD_TEST_CASE(AudioPauseResumeAfterPlay);
+    ADD_TEST_CASE(AudioPreloadSameFileMultipleTimes);
 }
 
 namespace {
@@ -189,7 +190,7 @@ AudioEngineTestDemo::AudioEngineTestDemo()
 void AudioEngineTestDemo::onExit()
 {
     *_isDestroyed = true;
-    AudioEngine::stopAll();
+    AudioEngine::uncacheAll();
     TestCase::onExit();
 }
 
@@ -830,3 +831,32 @@ std::string AudioPauseResumeAfterPlay::subtitle() const
 {
     return "Should not crash";
 }
+
+/////////////////////////////////////////////////////////////////////////
+void AudioPreloadSameFileMultipleTimes::onEnter()
+{
+    AudioEngineTestDemo::onEnter();
+
+    for (int i = 0; i < 10; ++i)
+    {
+        AudioEngine::preload("audio/SoundEffectsFX009/FX082.mp3", [i](bool isSucceed){
+            log("111: %d preload %s", i, isSucceed ? "succeed" : "failed");
+            AudioEngine::preload("audio/SoundEffectsFX009/FX082.mp3", [i](bool isSucceed){
+                log("222: %d preload %s", i, isSucceed ? "succeed" : "failed");
+                AudioEngine::preload("audio/SoundEffectsFX009/FX082.mp3", [i](bool isSucceed){
+                    log("333: %d preload %s", i, isSucceed ? "succeed" : "failed");
+                });
+            });
+        });
+    }
+}
+
+std::string AudioPreloadSameFileMultipleTimes::title() const
+{
+    return "Preload same file multiple times";
+}
+
+std::string AudioPreloadSameFileMultipleTimes::subtitle() const
+{
+    return "Should not crash";
+}

tests/cpp-tests/Classes/NewAudioEngineTest/NewAudioEngineTest.h

@@ -210,4 +210,15 @@ public:
     virtual std::string subtitle() const override;
 };
 
+class AudioPreloadSameFileMultipleTimes : public AudioEngineTestDemo
+{
+public:
+    CREATE_FUNC(AudioPreloadSameFileMultipleTimes);
+    
+    virtual void onEnter() override;
+    
+    virtual std::string title() const override;
+    virtual std::string subtitle() const override;
+};
+
 #endif /* defined(__NEWAUDIOENGINE_TEST_H_) */