Merge commit 'refs/pull/18383/head' of https://github.com/cocos2d/cocos2d-x into scgamex-v3

# Conflicts:
#	cocos/audio/AudioEngine.cpp

Author: stevetranby

cocos/audio/AudioEngine.cpp

@@ -209,6 +209,8 @@ int AudioEngine::play2d(const std::string& filePath, bool loop, float volume, fl
         // Steve: added check for null profileHelper
         if (profile && (!profileHelper || profile != &profileHelper->profile))
         {
+#warning FIXME: may want to comment out assert for release? (though it should by default in release build)
+            CC_ASSERT(!profile->name.empty()); // NOTE: may cause issues that were previously ignored, but should probably resolve them
             CCLOGINFO("profile = %p, profileHelper = %p, profile->name = %s", profile, profileHelper, profile->name.c_str());
             profileHelper = &_audioPathProfileHelperMap[profile->name];
             profileHelper->profile = *profile;
@@ -220,8 +222,25 @@ int AudioEngine::play2d(const std::string& filePath, bool loop, float volume, fl
         // TODO: consider this PR - https://github.com/cocos2d/cocos2d-x/pull/18383
         // - to allow play by removing oldest instance
         if (_audioIDInfoMap.size() >= _maxInstances) {
-            CCLOGERROR("Fail to play %s cause by limited max instance of AudioEngine",filePath.c_str());
-            break;
+            double oldestTimestamp = std::numeric_limits<double>::max();
+            int oldestId = INVALID_AUDIO_ID;
+            std::string ofilePath;
+            for(auto it = _audioIDInfoMap.begin(); it != _audioIDInfoMap.end(); ++it){
+                if(it->second.timestamp < oldestTimestamp && !it->second.loop){
+                    oldestId = it->first;
+                    oldestTimestamp = it->second.timestamp;
+                    ofilePath = *it->second.filePath;
+                }
+            }
+            
+            if(oldestId == INVALID_AUDIO_ID){
+                CCLOG("Fail to play %s cause by limited max instance of AudioEngine", filePath.c_str());
+                break;
+            }
+            
+            CCLOG("Max instance limit of AudioEngine exceeded. Stopping the oldest sound with id: %d and path: %s", oldestId, ofilePath.c_str());
+            
+            AudioEngine::stop(oldestId);
         }
 
         if (profileHelper)
@@ -256,6 +275,7 @@ int AudioEngine::play2d(const std::string& filePath, bool loop, float volume, fl
             audioRef.volume = volume;
             audioRef.loop = loop;
             audioRef.filePath = &it->first;
+            audioRef.timestamp = utils::gettime();
 
             if (profileHelper) {
                 profileHelper->lastPlayTime = utils::gettime();
@@ -375,6 +395,7 @@ void AudioEngine::stopAll()
 void AudioEngine::uncache(const std::string &filePath)
 {
     if(!_audioEngineImpl){
+        // TODO: any reason we should assert this instead? Why would it ever be null?
         return;
     }
     auto audioIDsIter = _audioPathIDMap.find(filePath);

cocos/audio/include/AudioEngine.h

@@ -335,6 +335,7 @@ class EXPORT_DLL AudioEngine
         bool loop;
         float duration;
         AudioState state;
+        double timestamp;
 
         AudioInfo();
         ~AudioInfo();

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

@@ -32,6 +32,7 @@ using namespace cocos2d::experimental;
 
 AudioEngineTests::AudioEngineTests()
 {
+    ADD_TEST_CASE(AudioIssueMaxInstanceTest);
     ADD_TEST_CASE(AudioIssue11143Test);
     ADD_TEST_CASE(AudioControlTest);
     ADD_TEST_CASE(AudioLoadTest);
@@ -651,12 +652,59 @@ std::string LargeAudioFileTest::title() const
     return "Test large audio file";
 }
 
-bool AudioIssue11143Test::init()
+bool AudioIssueMaxInstanceTest::init()
 {
     if (AudioEngineTestDemo::init())
     {
         auto& layerSize = this->getContentSize();
+        
+        auto playItem = TextButton::create("play", [](TextButton* button){
+            float diff = 0.05f;
+            
+            AudioEngine::play2d("background.wav", true);
+            
+            for(int i = 0; i < 200; i++){
+                float delay = diff * (i + 1);
+                int j = i % 10 + 81;
+                
+                char buff1[255];
+                snprintf(buff1, sizeof(buff1), "k%d", i);
+                std::string key = buff1;
+                
+                char buff2[255];
+                snprintf(buff2, sizeof(buff2), "audio/SoundEffectsFX009/FX0%d.mp3", j);
+                std::string path = buff2;
+                
+                button->scheduleOnce([path](float dt){
+                    AudioEngine::play2d(path);
+                }, delay, key);
+            }
+        });
+        playItem->setPosition(layerSize.width * 0.5f, layerSize.height * 0.5f);
+        addChild(playItem);
+        
+        return true;
+    }
+    
+    return false;
+}
 
+std::string AudioIssueMaxInstanceTest::title() const
+{
+    return "Max instance exceeded issue test";
+}
+
+std::string AudioIssueMaxInstanceTest::subtitle() const
+{
+    return "There shouldn't be any blank break in sound.\nBackground music shouldn't stop.";
+}
+
+bool AudioIssue11143Test::init()
+{
+    if (AudioEngineTestDemo::init())
+    {
+        auto& layerSize = this->getContentSize();
+        
         auto playItem = TextButton::create("play", [](TextButton* button){
             AudioEngine::play2d("audio/SoundEffectsFX009/FX082.mp3", true);
             AudioEngine::stopAll();
@@ -668,14 +716,14 @@ bool AudioIssue11143Test::init()
                 AudioEngine::stop(audioId);
                 AudioEngine::play2d("audio/SoundEffectsFX009/FX083.mp3");
             }, 0.3f, key);
-
+            
         });
         playItem->setPosition(layerSize.width * 0.5f, layerSize.height * 0.5f);
         addChild(playItem);
-
+        
         return true;
     }
-
+    
     return false;
 }
 

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

@@ -160,6 +160,17 @@ class AudioLoadTest : public AudioEngineTestDemo
     virtual std::string title() const override;
 };
 
+class AudioIssueMaxInstanceTest : public AudioEngineTestDemo
+{
+public:
+    CREATE_FUNC(AudioIssueMaxInstanceTest);
+    
+    virtual bool init() override;
+    
+    virtual std::string title() const override;
+    virtual std::string subtitle() const override;
+};
+
 class AudioIssue11143Test : public AudioEngineTestDemo
 {
 public: