[big refactoring] Audio latency fix for Android. Support to preload effects on Android now. (#15875)
* Audio latency fix for Android. Support preload effects on Android now.
Squashed commits:
[b6d80fe] log fix
[a0a918e] Fixes assetFd didn't be released while PcmData is returned from cache.
[4b956ba] Potential crash fix for PcmAudioPlayer while pause / resume.
[398ab8c] Updates LOG_TAG position in AudioEngine-inl.cpp
[e3634e7] include stdlib.h for posix_memalign
[9004074] fixes setVolume logical error.
[c96df46] Don't use another thread for mixing, enqueue is in a seperated thread, therefore doing mixing in another thread will waste more time.
[0a4c1a8] Adds setLoop, setVolume, setPostion support for Track
[c35fb20] Fixed include.
[cdd9d32] Do mixing by ourself. (TO BE POLISHED)
[6447025] µ -> u since µ could not be shown on some android devices.
[97be0c6] Don't send a silence clip.
[c1607ed] Make linter.py happy.
[0898b54] Puts enqueue & SetPlayState in PcmAudioPlayer::play to thread pool.
[b79fc01] Adds getDuration, getPosition support for PcmAudioPlayer
[80fa2ab] minor fix of the code position of resetting state to State::INITIALIZED
[d9c62f1] underrun fix for PcmAudioPlayer.
[9c2212a] UrlAudioPlayer, playOverMutex should be static, and should be used in update method.
[1519d2e] static variables
[19da936] _pcmAudioPlayer Null pointer check in AudioPlayerProvider.
[e6b0d14] Updates audio performance test.
[fc01dd4] Registers foreground & background event in AudioEngine-inl.cpp(android), the callback should invoke `provider`'s pause & resume method.
[e00a886] TBD: Pause & resume support for PcmAudioPlayerPool.
Since OpenSLES audio resources are expensive and device shared, we should delete all unused PcmAudioPlayers in pool while pause and re-create them while resume.
But this commit isn't finished yet, I don't find a better way to register pause&resume event in AudioEngine module.
[9e42ea3] Interleave mono audio to stereo audio. PcmAudioPlayerPool only contains PcmAudioPlayers with 2 channels.
[3f18d05] Adds a strategy for checking small size of different file formats.
[753ff49] Adds performance test for AudioEngine.
[09d3045] Releases an extra PcmAudioPlayer for UrlAudioPlayer while allocating PcmAudioPlayer fails.
[9dd4477] Using std::move for PcmData move constructor & move assignment.
[6ca3bcb] some fixes:
1) new -> new (std::nothrow)
2) break if allocate PcmAudioPlayer fails
3) renames 'initForPlayPcmData' to 'init'
4) PcmAudioPlayer destructor deadlock if 'init' failed
[54675b6] include path fix.
[a1903ca] More refactorings.
[19b9498] Makes linter.py happy. :)
[923c530] Fixes:
1) Avoid getFileInfo to be invoked twice
2) A critical bug fix for UrlAudioPlayer and adds detailed comments
3) __clang__ compiler option fix for AudioResamplerSinc.cpp.
[5ec4faf] minor fix.
[faaa0f3] output a log in the destructor of UrlAudioPlayer.
[9c20355] NewAudioEngineTest,TestControll crash fix.
[f114464] fixes an unused import.
[1dc5dab] Better algorithm for allocating PcmAudioPlayer.
[331a213] minor fix.
[e54084a] null -> nullptr
[f9a0389] Support uncache.
[89a364f] Removes unused update, and TODO uncache functionality.
[1732bf9] Supports AudioEngineImpl::setFinishCallback for android.
[43d1596] UrlAudioPlayer::stop fix.
[e2ee941] Test case fix in NewAudioEngineTest/AudioIssue11143Test
[5c5ba01] More fixes for making cpp-tests/New Audio Engine Test happy.
[8b554a3] Adds log while remove player from map.
[ed71322] If original file is larger than 30k bytes, consider it's a large audio file.
[fb1845a] Updates project.properties
[6f3839f] minor log output fix in AudioEngine-inl.cpp
[c68bc6c] Don't resample if the sample rate of the decoded pcm data matchs the device's.
[43ca45f] PcmAudioPlayers also need to be removed while they play over, but should not be deleted since their lifecycle is managed by PcmAudioPlayerPool.
[f5e63c9] Audio latency fix for Android. Support preload effects on Android now.
* Supports to loading audio files asynchronously.
* Crash fix for stop audio right after play2d.
* Minor fix for logic in AudioMixerController.cpp
* Adds missing files (CCThreadPool.h/.cpp).
* Minor fix for including.
* Minor fix for missing include <functional> in Track.h
* update license information in audio.h
* Don't use std::future/std::promise anymore since ndk counldn't support it well in armeabi arch.
* isSmallFile postion updated, fixes large audio file goto the checking logic of cache.
* std::atomic<int> isn't supported by ndk-r10e while compiling with `armeabi` arch, using a int with a mutex instead.
* fixes __isnanf & posix_memalign doesn't exist on low api (<=16) devices.
* namespace updated: cocos2d -> cocos2d::experimental
* Removes commented code in AudioMixerController.h/.cpp
* Removes unused code again, and fixes a memory leak of `Track` instance.
* Oops, namespace changed.
* Only outputs log in debug mode.
* Uses ALOGV for outputing logs in AudioEngine-inl.cpp
* const PcmData& -> PcmData for Track
* Fixes a protential crash in NewAudioEngineTest
* Adds `COCOS` prefix in header #ifndef COCOS_BALABALA #define COCOS_BALABALA
* Uses _ prefix for cocos code style instead of `m` prefix.
* Deletes AudioResamplerSinc related files.
* Bug fix from @minggo's reply on github.
* Don't need to invoke pause after in UrlAudioPlayer::prepare.
* Updates ThreadPool class, uses enum class and adds const keyword.
2016-07-18 10:22:40 +08:00
|
|
|
/****************************************************************************
|
2017-02-14 14:36:57 +08:00
|
|
|
Copyright (c) 2016-2017 Chukong Technologies Inc.
|
[big refactoring] Audio latency fix for Android. Support to preload effects on Android now. (#15875)
* Audio latency fix for Android. Support preload effects on Android now.
Squashed commits:
[b6d80fe] log fix
[a0a918e] Fixes assetFd didn't be released while PcmData is returned from cache.
[4b956ba] Potential crash fix for PcmAudioPlayer while pause / resume.
[398ab8c] Updates LOG_TAG position in AudioEngine-inl.cpp
[e3634e7] include stdlib.h for posix_memalign
[9004074] fixes setVolume logical error.
[c96df46] Don't use another thread for mixing, enqueue is in a seperated thread, therefore doing mixing in another thread will waste more time.
[0a4c1a8] Adds setLoop, setVolume, setPostion support for Track
[c35fb20] Fixed include.
[cdd9d32] Do mixing by ourself. (TO BE POLISHED)
[6447025] µ -> u since µ could not be shown on some android devices.
[97be0c6] Don't send a silence clip.
[c1607ed] Make linter.py happy.
[0898b54] Puts enqueue & SetPlayState in PcmAudioPlayer::play to thread pool.
[b79fc01] Adds getDuration, getPosition support for PcmAudioPlayer
[80fa2ab] minor fix of the code position of resetting state to State::INITIALIZED
[d9c62f1] underrun fix for PcmAudioPlayer.
[9c2212a] UrlAudioPlayer, playOverMutex should be static, and should be used in update method.
[1519d2e] static variables
[19da936] _pcmAudioPlayer Null pointer check in AudioPlayerProvider.
[e6b0d14] Updates audio performance test.
[fc01dd4] Registers foreground & background event in AudioEngine-inl.cpp(android), the callback should invoke `provider`'s pause & resume method.
[e00a886] TBD: Pause & resume support for PcmAudioPlayerPool.
Since OpenSLES audio resources are expensive and device shared, we should delete all unused PcmAudioPlayers in pool while pause and re-create them while resume.
But this commit isn't finished yet, I don't find a better way to register pause&resume event in AudioEngine module.
[9e42ea3] Interleave mono audio to stereo audio. PcmAudioPlayerPool only contains PcmAudioPlayers with 2 channels.
[3f18d05] Adds a strategy for checking small size of different file formats.
[753ff49] Adds performance test for AudioEngine.
[09d3045] Releases an extra PcmAudioPlayer for UrlAudioPlayer while allocating PcmAudioPlayer fails.
[9dd4477] Using std::move for PcmData move constructor & move assignment.
[6ca3bcb] some fixes:
1) new -> new (std::nothrow)
2) break if allocate PcmAudioPlayer fails
3) renames 'initForPlayPcmData' to 'init'
4) PcmAudioPlayer destructor deadlock if 'init' failed
[54675b6] include path fix.
[a1903ca] More refactorings.
[19b9498] Makes linter.py happy. :)
[923c530] Fixes:
1) Avoid getFileInfo to be invoked twice
2) A critical bug fix for UrlAudioPlayer and adds detailed comments
3) __clang__ compiler option fix for AudioResamplerSinc.cpp.
[5ec4faf] minor fix.
[faaa0f3] output a log in the destructor of UrlAudioPlayer.
[9c20355] NewAudioEngineTest,TestControll crash fix.
[f114464] fixes an unused import.
[1dc5dab] Better algorithm for allocating PcmAudioPlayer.
[331a213] minor fix.
[e54084a] null -> nullptr
[f9a0389] Support uncache.
[89a364f] Removes unused update, and TODO uncache functionality.
[1732bf9] Supports AudioEngineImpl::setFinishCallback for android.
[43d1596] UrlAudioPlayer::stop fix.
[e2ee941] Test case fix in NewAudioEngineTest/AudioIssue11143Test
[5c5ba01] More fixes for making cpp-tests/New Audio Engine Test happy.
[8b554a3] Adds log while remove player from map.
[ed71322] If original file is larger than 30k bytes, consider it's a large audio file.
[fb1845a] Updates project.properties
[6f3839f] minor log output fix in AudioEngine-inl.cpp
[c68bc6c] Don't resample if the sample rate of the decoded pcm data matchs the device's.
[43ca45f] PcmAudioPlayers also need to be removed while they play over, but should not be deleted since their lifecycle is managed by PcmAudioPlayerPool.
[f5e63c9] Audio latency fix for Android. Support preload effects on Android now.
* Supports to loading audio files asynchronously.
* Crash fix for stop audio right after play2d.
* Minor fix for logic in AudioMixerController.cpp
* Adds missing files (CCThreadPool.h/.cpp).
* Minor fix for including.
* Minor fix for missing include <functional> in Track.h
* update license information in audio.h
* Don't use std::future/std::promise anymore since ndk counldn't support it well in armeabi arch.
* isSmallFile postion updated, fixes large audio file goto the checking logic of cache.
* std::atomic<int> isn't supported by ndk-r10e while compiling with `armeabi` arch, using a int with a mutex instead.
* fixes __isnanf & posix_memalign doesn't exist on low api (<=16) devices.
* namespace updated: cocos2d -> cocos2d::experimental
* Removes commented code in AudioMixerController.h/.cpp
* Removes unused code again, and fixes a memory leak of `Track` instance.
* Oops, namespace changed.
* Only outputs log in debug mode.
* Uses ALOGV for outputing logs in AudioEngine-inl.cpp
* const PcmData& -> PcmData for Track
* Fixes a protential crash in NewAudioEngineTest
* Adds `COCOS` prefix in header #ifndef COCOS_BALABALA #define COCOS_BALABALA
* Uses _ prefix for cocos code style instead of `m` prefix.
* Deletes AudioResamplerSinc related files.
* Bug fix from @minggo's reply on github.
* Don't need to invoke pause after in UrlAudioPlayer::prepare.
* Updates ThreadPool class, uses enum class and adds const keyword.
2016-07-18 10:22:40 +08:00
|
|
|
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#define LOG_TAG "PcmAudioService"
|
|
|
|
|
|
|
|
#include "audio/android/PcmAudioService.h"
|
|
|
|
#include "audio/android/AudioMixerController.h"
|
|
|
|
|
|
|
|
namespace cocos2d { namespace experimental {
|
|
|
|
|
|
|
|
static std::vector<char> __silenceData;
|
|
|
|
|
|
|
|
#define AUDIO_PLAYER_BUFFER_COUNT (2)
|
|
|
|
|
|
|
|
class SLPcmAudioPlayerCallbackProxy
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
static void samplePlayerCallback(SLAndroidSimpleBufferQueueItf bq, void *context)
|
|
|
|
{
|
|
|
|
PcmAudioService *thiz = reinterpret_cast<PcmAudioService *>(context);
|
|
|
|
thiz->bqFetchBufferCallback(bq);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
PcmAudioService::PcmAudioService(SLEngineItf engineItf, SLObjectItf outputMixObject)
|
|
|
|
: _engineItf(engineItf), _outputMixObj(outputMixObject), _playObj(nullptr),
|
|
|
|
_playItf(nullptr), _volumeItf(nullptr), _bufferQueueItf(nullptr), _numChannels(-1),
|
|
|
|
_sampleRate(-1), _bufferSizeInBytes(0), _controller(nullptr)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
PcmAudioService::~PcmAudioService()
|
|
|
|
{
|
|
|
|
ALOGV("PcmAudioServicee() (%p), before destroy play object", this);
|
|
|
|
SL_DESTROY_OBJ(_playObj);
|
|
|
|
ALOGV("PcmAudioServicee() end");
|
|
|
|
}
|
|
|
|
|
|
|
|
bool PcmAudioService::enqueue()
|
|
|
|
{
|
|
|
|
if (_controller->hasPlayingTacks())
|
|
|
|
{
|
|
|
|
if (_controller->isPaused())
|
|
|
|
{
|
|
|
|
SLresult r = (*_bufferQueueItf)->Enqueue(_bufferQueueItf, __silenceData.data(), __silenceData.size());
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "enqueue silent data failed!");
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
_controller->mixOneFrame();
|
|
|
|
|
|
|
|
auto current = _controller->current();
|
|
|
|
ALOG_ASSERT(current != nullptr, "current buffer is nullptr ...");
|
|
|
|
SLresult r = (*_bufferQueueItf)->Enqueue(_bufferQueueItf, current->buf, current->size);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "enqueue failed!");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
SLresult r = (*_bufferQueueItf)->Enqueue(_bufferQueueItf, __silenceData.data(), __silenceData.size());
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "enqueue silent data failed!");
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void PcmAudioService::bqFetchBufferCallback(SLAndroidSimpleBufferQueueItf bq)
|
|
|
|
{
|
|
|
|
// FIXME: PcmAudioService instance may be destroyed, we need to find a way to wait...
|
|
|
|
// It's in sub thread
|
|
|
|
enqueue();
|
|
|
|
}
|
|
|
|
|
|
|
|
bool PcmAudioService::init(AudioMixerController* controller, int numChannels, int sampleRate, int bufferSizeInBytes)
|
|
|
|
{
|
|
|
|
_controller = controller;
|
|
|
|
_numChannels = numChannels;
|
|
|
|
_sampleRate = sampleRate;
|
|
|
|
_bufferSizeInBytes = bufferSizeInBytes;
|
|
|
|
|
|
|
|
SLuint32 channelMask = SL_SPEAKER_FRONT_CENTER;
|
|
|
|
|
|
|
|
if (numChannels > 1)
|
|
|
|
{
|
|
|
|
channelMask = SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT;
|
|
|
|
}
|
|
|
|
|
|
|
|
SLDataFormat_PCM formatPcm = {
|
|
|
|
SL_DATAFORMAT_PCM,
|
|
|
|
(SLuint32) numChannels,
|
|
|
|
(SLuint32) sampleRate * 1000,
|
|
|
|
SL_PCMSAMPLEFORMAT_FIXED_16,
|
|
|
|
SL_PCMSAMPLEFORMAT_FIXED_16,
|
|
|
|
channelMask,
|
|
|
|
SL_BYTEORDER_LITTLEENDIAN
|
|
|
|
};
|
|
|
|
|
|
|
|
SLDataLocator_AndroidSimpleBufferQueue locBufQueue = {
|
|
|
|
SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE,
|
|
|
|
AUDIO_PLAYER_BUFFER_COUNT
|
|
|
|
};
|
|
|
|
SLDataSource source = {&locBufQueue, &formatPcm};
|
|
|
|
|
|
|
|
SLDataLocator_OutputMix locOutmix = {
|
|
|
|
SL_DATALOCATOR_OUTPUTMIX,
|
|
|
|
_outputMixObj
|
|
|
|
};
|
|
|
|
SLDataSink sink = {&locOutmix, nullptr};
|
|
|
|
|
|
|
|
const SLInterfaceID ids[] = {
|
|
|
|
SL_IID_PLAY,
|
|
|
|
SL_IID_VOLUME,
|
|
|
|
SL_IID_ANDROIDSIMPLEBUFFERQUEUE,
|
|
|
|
};
|
|
|
|
|
|
|
|
const SLboolean req[] = {
|
|
|
|
SL_BOOLEAN_TRUE,
|
|
|
|
SL_BOOLEAN_TRUE,
|
|
|
|
SL_BOOLEAN_TRUE,
|
|
|
|
};
|
|
|
|
|
|
|
|
SLresult r;
|
|
|
|
|
|
|
|
r = (*_engineItf)->CreateAudioPlayer(_engineItf, &_playObj, &source, &sink,
|
|
|
|
sizeof(ids) / sizeof(ids[0]), ids, req);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "CreateAudioPlayer failed");
|
|
|
|
|
|
|
|
r = (*_playObj)->Realize(_playObj, SL_BOOLEAN_FALSE);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "Realize failed");
|
|
|
|
|
|
|
|
r = (*_playObj)->GetInterface(_playObj, SL_IID_PLAY, &_playItf);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "GetInterface SL_IID_PLAY failed");
|
|
|
|
|
|
|
|
r = (*_playObj)->GetInterface(_playObj, SL_IID_VOLUME, &_volumeItf);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "GetInterface SL_IID_VOLUME failed");
|
|
|
|
|
|
|
|
r = (*_playObj)->GetInterface(_playObj, SL_IID_ANDROIDSIMPLEBUFFERQUEUE, &_bufferQueueItf);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "GetInterface SL_IID_ANDROIDSIMPLEBUFFERQUEUE failed");
|
|
|
|
|
|
|
|
r = (*_bufferQueueItf)->RegisterCallback(_bufferQueueItf,
|
|
|
|
SLPcmAudioPlayerCallbackProxy::samplePlayerCallback,
|
|
|
|
this);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "_bufferQueueItf RegisterCallback failed");
|
|
|
|
|
|
|
|
if (__silenceData.empty())
|
|
|
|
{
|
|
|
|
__silenceData.resize(_numChannels * _bufferSizeInBytes, 0x00);
|
|
|
|
}
|
|
|
|
|
|
|
|
r = (*_bufferQueueItf)->Enqueue(_bufferQueueItf, __silenceData.data(), __silenceData.size());
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "_bufferQueueItf Enqueue failed");
|
|
|
|
|
|
|
|
r = (*_playItf)->SetPlayState(_playItf, SL_PLAYSTATE_PLAYING);
|
|
|
|
SL_RETURN_VAL_IF_FAILED(r, false, "SetPlayState failed");
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void PcmAudioService::pause()
|
|
|
|
{
|
|
|
|
SLresult r = (*_playItf)->SetPlayState(_playItf, SL_PLAYSTATE_PAUSED);
|
|
|
|
SL_RETURN_IF_FAILED(r, "PcmAudioService::pause failed");
|
|
|
|
}
|
|
|
|
|
|
|
|
void PcmAudioService::resume()
|
|
|
|
{
|
|
|
|
SLresult r = (*_playItf)->SetPlayState(_playItf, SL_PLAYSTATE_PLAYING);
|
|
|
|
SL_RETURN_IF_FAILED(r, "PcmAudioService::resume failed");
|
|
|
|
}
|
|
|
|
|
|
|
|
}} // namespace cocos2d { namespace experimental {
|