Skip to content

refactor(audio): Simplify available audio samples management #2773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xezon wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor(audio): Simplify available audio samples management #2773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8234fc4
refactor(audio): Simplify available audio samples management
xezon Jun 7, 2026
5fa4945
Fix loops
xezon Jun 7, 2026
8a9463a
Fix wrong function call in debug draw
xezon Jun 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Core/GameEngine/Include/Common/GameAudio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,8 @@ class AudioManager : public SubsystemInterface
virtual UnsignedInt getNum2DSamples() const = 0;
virtual UnsignedInt getNum3DSamples() const = 0;
virtual UnsignedInt getNumStreams() const = 0;
virtual UnsignedInt getAvailable2DSamples() const = 0;
virtual UnsignedInt getAvailable3DSamples() const = 0;

// Device Dependent calls to determine sound prioritization info
virtual Bool doesViolateLimit( AudioEventRTS *event ) const = 0;
Expand Down
17 changes: 0 additions & 17 deletions Core/GameEngine/Include/Common/GameSounds.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,6 @@ class SoundManager : public SubsystemInterface

virtual void addAudioEvent(AudioEventRTS *&eventToAdd); // pre-copied

virtual void notifyOf2DSampleStart();
virtual void notifyOf3DSampleStart();

virtual void notifyOf2DSampleCompletion();
virtual void notifyOf3DSampleCompletion();

virtual Int getAvailableSamples();
virtual Int getAvailable3DSamples();

// empty string means that this sound wasn't found or some error occurred. CHECK FOR EMPTY STRING.
virtual AsciiString getFilenameForPlayFromAudioEvent( const AudioEventRTS *eventToGetFrom );

Expand All @@ -87,12 +78,4 @@ class SoundManager : public SubsystemInterface
protected:
virtual Bool violatesVoice( AudioEventRTS *event );
virtual Bool isInterrupting( AudioEventRTS *event );


protected:
UnsignedInt m_num2DSamples;
UnsignedInt m_num3DSamples;

UnsignedInt m_numPlaying2DSamples;
UnsignedInt m_numPlaying3DSamples;
};
55 changes: 5 additions & 50 deletions Core/GameEngine/Source/Common/Audio/GameSounds.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,7 @@ void SoundManager::update()
//-------------------------------------------------------------------------------------------------
void SoundManager::reset()
{
m_numPlaying2DSamples = 0;
m_numPlaying3DSamples = 0;

}

//-------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -135,11 +134,6 @@ Real SoundManager::getCameraAudibleDistance()
//-------------------------------------------------------------------------------------------------
void SoundManager::addAudioEvent(AudioEventRTS *&eventToAdd)
{
if (m_num2DSamples == 0 && m_num3DSamples == 0) {
m_num2DSamples = TheAudio->getNum2DSamples();
m_num3DSamples = TheAudio->getNum3DSamples();
}

if (canPlayNow(eventToAdd)) {
#ifdef INTENSIVE_AUDIO_DEBUG
DEBUG_LOG((" - appended to request list with handle '%d'.", (UnsignedInt) eventToAdd->getPlayingHandle()));
Expand All @@ -153,46 +147,6 @@ void SoundManager::addAudioEvent(AudioEventRTS *&eventToAdd)
}
}

//-------------------------------------------------------------------------------------------------
void SoundManager::notifyOf2DSampleStart()
{
++m_numPlaying2DSamples;
}

//-------------------------------------------------------------------------------------------------
void SoundManager::notifyOf3DSampleStart()
{
++m_numPlaying3DSamples;
}

//-------------------------------------------------------------------------------------------------
void SoundManager::notifyOf2DSampleCompletion()
{
if (m_numPlaying2DSamples > 0) {
--m_numPlaying2DSamples;
}
}

//-------------------------------------------------------------------------------------------------
void SoundManager::notifyOf3DSampleCompletion()
{
if (m_numPlaying3DSamples > 0) {
--m_numPlaying3DSamples;
}
}

//-------------------------------------------------------------------------------------------------
Int SoundManager::getAvailableSamples()
{
return (m_num2DSamples - m_numPlaying2DSamples);
}

//-------------------------------------------------------------------------------------------------
Int SoundManager::getAvailable3DSamples()
{
return (m_num3DSamples - m_numPlaying3DSamples);
}

//-------------------------------------------------------------------------------------------------
AsciiString SoundManager::getFilenameForPlayFromAudioEvent( const AudioEventRTS *eventToGetFrom )
{
Expand Down Expand Up @@ -272,18 +226,19 @@ Bool SoundManager::canPlayNow( AudioEventRTS *event )

if (event->isPositionalAudio())
{
if (m_numPlaying3DSamples < m_num3DSamples)
if (TheAudio->getAvailable3DSamples() > 0)
{
return true;
}
#ifdef INTENSIVE_AUDIO_DEBUG
DEBUG_LOG(("- %d samples playing, %d samples available", m_numPlaying3DSamples, m_num3DSamples));
DEBUG_LOG(("- %d samples playing, %d samples available",
TheAudio->getNum3DSamples() - TheAudio->getAvailable3DSamples(), TheAudio->getNum3DSamples()));
Comment thread
greptile-apps[bot] marked this conversation as resolved.
#endif
}
else
{
// its a UI sound (and thus, 2-D)
if (m_numPlaying2DSamples < m_num2DSamples)
if (TheAudio->getAvailable2DSamples() > 0)
{
return true;
}
Expand Down
8 changes: 6 additions & 2 deletions Core/GameEngineDevice/Include/MilesAudioDevice/MilesAudioManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,8 @@ class MilesAudioManager : public AudioManager
virtual UnsignedInt getNum2DSamples() const override;
virtual UnsignedInt getNum3DSamples() const override;
virtual UnsignedInt getNumStreams() const override;
virtual UnsignedInt getAvailable2DSamples() const override;
virtual UnsignedInt getAvailable3DSamples() const override;

virtual Bool doesViolateLimit( AudioEventRTS *event ) const override;
virtual Bool isPlayingLowerPriority( AudioEventRTS *event ) const override;
Expand Down Expand Up @@ -301,8 +303,8 @@ class MilesAudioManager : public AudioManager

// Available handles for play. Note that there aren't handles open in advance for
// streaming things, only 2-D and 3-D sounds.
std::list<HSAMPLE> m_availableSamples;
std::list<H3DSAMPLE> m_available3DSamples;
std::vector<HSAMPLE> m_availableSamples;
std::vector<H3DSAMPLE> m_available3DSamples;

// Currently Playing audio. Useful if we have to preempt it.
// This should rarely if ever happen, as we mirror this in Sounds, and attempt to
Expand Down Expand Up @@ -368,6 +370,8 @@ class MilesAudioManagerDummy : public MilesAudioManager
virtual UnsignedInt getNum2DSamples() const override { return 0; }
virtual UnsignedInt getNum3DSamples() const override { return 0; }
virtual UnsignedInt getNumStreams() const override { return 0; }
virtual UnsignedInt getAvailable2DSamples() const override { return 0; }
virtual UnsignedInt getAvailable3DSamples() const override { return 0; }
virtual Bool doesViolateLimit(AudioEventRTS* event) const override { return false; }
virtual Bool isPlayingLowerPriority(AudioEventRTS* event) const override { return false; }
virtual Bool isPlayingAlready(AudioEventRTS* event) const override { return false; }
Expand Down
72 changes: 37 additions & 35 deletions Core/GameEngineDevice/Source/MilesAudioDevice/MilesAudioManager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,9 +165,8 @@ void MilesAudioManager::audioDebugDisplay(DebugDisplayInterface *dd, void *, FIL
dd->printf("Speech: %s ", (isOn(AudioAffect_Speech) ? "Yes" : "No"));
dd->printf("Music: %s\n", (isOn(AudioAffect_Music) ? "Yes" : "No"));
dd->printf("Channels Available: ");
dd->printf("%d Sounds ", m_sound->getAvailableSamples());

dd->printf("%d(%d) 3D Sounds\n", m_sound->getAvailable3DSamples(), m_available3DSamples.size() );
dd->printf("%u Sounds ", getAvailable2DSamples());
dd->printf("%u 3D Sounds\n", getAvailable3DSamples());
dd->printf("Volume: ");
dd->printf("Sound: %d ", REAL_TO_INT(m_soundVolume * 100.0f));
dd->printf("3DSound: %d ", REAL_TO_INT(m_sound3DVolume * 100.0f));
Expand Down Expand Up @@ -196,8 +195,8 @@ void MilesAudioManager::audioDebugDisplay(DebugDisplayInterface *dd, void *, FIL
fprintf( fp, "Speech: %s ", (isOn(AudioAffect_Speech) ? "Yes" : "No") );
fprintf( fp, "Music: %s\n", (isOn(AudioAffect_Music) ? "Yes" : "No") );
fprintf( fp, "Channels Available: " );
fprintf( fp, "%d Sounds ", m_sound->getAvailableSamples() );
fprintf( fp, "%d 3D Sounds\n", m_sound->getAvailable3DSamples() );
fprintf( fp, "%u Sounds ", getAvailable2DSamples() );
fprintf( fp, "%u 3D Sounds\n", getAvailable3DSamples() );
fprintf( fp, "Volume: ");
fprintf( fp, "Sound: %d ", REAL_TO_INT(m_soundVolume * 100.0f) );
fprintf( fp, "3DSound: %d ", REAL_TO_INT(m_sound3DVolume * 100.0f) );
Expand Down Expand Up @@ -740,7 +739,6 @@ void MilesAudioManager::playAudioEvent( AudioRequest* req )

if (sample3D) {
audio->m_file = playSample3D(event, sample3D);
m_sound->notifyOf3DSampleStart();
}

if( !audio->m_file )
Expand Down Expand Up @@ -807,7 +805,6 @@ void MilesAudioManager::playAudioEvent( AudioRequest* req )

if (sample) {
audio->m_file = playSample(event, sample);
m_sound->notifyOf2DSampleStart();
}

if (!audio->m_file) {
Expand Down Expand Up @@ -1042,17 +1039,6 @@ void MilesAudioManager::stopPlayingAudio( PlayingAudio *release )
if (prevStatus != PS_Stopping) {
return;
}
if (release->m_audioEventRTS->getAudioEventInfo()->m_soundType == AT_SoundEffect) {
if (release->m_type == PAT_Sample) {
if (release->m_sample) {
m_sound->notifyOf2DSampleCompletion();
}
} else {
if (release->m_3DSample) {
m_sound->notifyOf3DSampleCompletion();
}
}
}
releaseMilesHandles(release);
}

Expand Down Expand Up @@ -1175,48 +1161,49 @@ void MilesAudioManager::freeAllMilesHandles()
stopAllAudioImmediately();

// Walks through the available 2-D and 3-D handles and releases them
std::list<HSAMPLE>::iterator it;
for ( it = m_availableSamples.begin(); it != m_availableSamples.end(); ) {
std::vector<HSAMPLE>::iterator it;
for ( it = m_availableSamples.begin(); it != m_availableSamples.end(); ++it ) {
HSAMPLE sample = *it;
AIL_release_sample_handle(sample);
it = m_availableSamples.erase(it);
}

m_availableSamples.clear();
m_num2DSamples = 0;

std::list<H3DSAMPLE>::iterator it3D;
for ( it3D = m_available3DSamples.begin(); it3D != m_available3DSamples.end(); ) {
std::vector<H3DSAMPLE>::iterator it3D;
for ( it3D = m_available3DSamples.begin(); it3D != m_available3DSamples.end(); ++it3D ) {
H3DSAMPLE sample3D = *it3D;
AIL_release_3D_sample_handle(sample3D);
it3D = m_available3DSamples.erase(it3D);
}

m_available3DSamples.clear();
Comment thread
greptile-apps[bot] marked this conversation as resolved.
m_num3DSamples = 0;
m_numStreams = 0;
}

//-------------------------------------------------------------------------------------------------
HSAMPLE MilesAudioManager::getFirst2DSample( AudioEventRTS *event )
{
if (m_availableSamples.begin() != m_availableSamples.end()) {
HSAMPLE retSample = *m_availableSamples.begin();
m_availableSamples.erase(m_availableSamples.begin());
return (retSample);
if (!m_availableSamples.empty()) {
HSAMPLE retSample = m_availableSamples.back();
m_availableSamples.pop_back();
return retSample;
}

// Find the first sample of lower priority than my augmented priority that is interruptable and take its handle

// Find the first sample of lower priority than my augmented priority that is interruptible and take its handle
return nullptr;
}

//-------------------------------------------------------------------------------------------------
H3DSAMPLE MilesAudioManager::getFirst3DSample( AudioEventRTS *event )
{
if (m_available3DSamples.begin() != m_available3DSamples.end()) {
H3DSAMPLE retSample = *m_available3DSamples.begin();
m_available3DSamples.erase(m_available3DSamples.begin());
return (retSample);
if (!m_available3DSamples.empty()) {
H3DSAMPLE retSample = m_available3DSamples.back();
m_available3DSamples.pop_back();
return retSample;
}

// Find the first sample of lower priority than my augmented priority that is interruptable and take its handle
// Find the first sample of lower priority than my augmented priority that is interruptible and take its handle
return nullptr;
}

Expand Down Expand Up @@ -1755,6 +1742,18 @@ UnsignedInt MilesAudioManager::getNumStreams() const
return m_numStreams;
}

//-------------------------------------------------------------------------------------------------
UnsignedInt MilesAudioManager::getAvailable2DSamples() const
{
return (UnsignedInt)m_availableSamples.size();
}

//-------------------------------------------------------------------------------------------------
UnsignedInt MilesAudioManager::getAvailable3DSamples() const
{
return (UnsignedInt)m_available3DSamples.size();
}

//-------------------------------------------------------------------------------------------------
Bool MilesAudioManager::doesViolateLimit( AudioEventRTS *event ) const
{
Expand Down Expand Up @@ -2769,6 +2768,9 @@ void MilesAudioManager::initSamplePools()
return;
}

m_availableSamples.reserve(getAudioSettings()->m_sampleCount2D);
m_available3DSamples.reserve(getAudioSettings()->m_sampleCount3D);

int i = 0;
for (i = 0; i < getAudioSettings()->m_sampleCount2D; ++i) {
HSAMPLE sample = AIL_allocate_sample_handle(m_digitalHandle);
Expand Down
Loading