Skip to content

#15 - Limit the number of simultaneous sounds being played to prevent music cancellation #16

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
wants to merge 2 commits into
base: development
Choose a base branch
from
Open

#15 - Limit the number of simultaneous sounds being played to prevent music cancellation #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cc21d5
#15 - Limit the number of simultaneous sounds being played to prevent…
brisbang Jul 9, 2025
5a341ec
#15 - Max sounds limitation has improved code readability
brisbang Jul 9, 2025
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
17 changes: 17 additions & 0 deletions src/vfmodsound.pas
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ TFMODSound = class(TSound)
procedure FreeMusic( aData : Pointer; const aType : String ); override;
// Implementation of Sound Freeing
procedure FreeSound( aData : Pointer ); override;
// Implementation of Number of Channels Playing
function NumChannelsPlaying: Integer;
// Implementation of get error
function GetError( ) : AnsiString; override;
// Implementation of play Sound 3D
Expand All @@ -66,7 +68,9 @@ implementation
GLastError : FMOD_RESULT;
GGroupSounds : PFMOD_CHANNELGROUP;
GGroupMusic : PFMOD_CHANNELGROUP;
MaxConcurrentSounds : Integer; //Max number of sounds we can play before needing to steal a channel

const SoundLibMaxConcurrentChannels = 128; // Max number of channels playing at once by the library

procedure FMOD_CHECK( aResult : FMOD_RESULT );
begin
Expand All @@ -93,6 +97,8 @@ destructor TFMODSound.Destroy;
if GGroupSounds <> nil then FMOD_ChannelGroup_Release( GGroupSounds );
if GGroupMusic <> nil then FMOD_ChannelGroup_Release( GGroupMusic );

MaxConcurrentSounds := SoundLibMaxConcurrentChannels;

if GSystem <> nil then
begin
FMOD_System_Close(GSystem);
Expand All @@ -106,6 +112,14 @@ procedure TFMODSound.Update;
FMOD_System_Update( GSystem );
end;

function TFModSound.NumChannelsPlaying : Integer;
var Channels, RealChannels : Integer;
begin
Channels := 0; RealChannels := 0;
FMOD_System_GetChannelsPlaying( GSystem, Channels, RealChannels);
Exit(Channels);
end;

function TFMODSound.OpenDevice : Boolean;
const CPos : FMOD_VECTOR = ( x : 0.0; y : 0.0; z : 0.0 );
CVel : FMOD_VECTOR = ( x : 0.0; y : 0.0; z : 0.0 );
Expand Down Expand Up @@ -134,6 +148,7 @@ function TFMODSound.OpenDevice : Boolean;

FMOD_CHECK( FMOD_System_CreateChannelGroup( GSystem, 'sound', @GGroupSounds ) );
FMOD_CHECK( FMOD_System_CreateChannelGroup( GSystem, 'music', @GGroupMusic ) );
MaxConcurrentSounds := SoundLibMaxConcurrentChannels - 1; // Reserve one channel for music
FMOD_CHECK( FMOD_System_set3DListenerAttributes( GSystem, 0, @CPos, @CVel, @CFwd, @CUp ) );
Exit( True );
end;
Expand Down Expand Up @@ -228,6 +243,7 @@ procedure TFMODSound.PlaySound3D(aData: Pointer; aRelative: TCoord2D);
iPosition.x := aRelative.X * 0.2;
iPosition.y := aRelative.Y * 0.2;
iPosition.z := 0.0;
if NumChannelsPlaying() = MaxConcurrentSounds then Exit; //Do not allow more sounds than this or a channel will be stolen (e.g. music)
FMOD_CHECK( FMOD_System_PlaySound( GSystem, PFMOD_SOUND(aData), GGroupSounds, 1, @iChannel ) );
FMOD_CHECK( FMOD_Channel_SetVolume( iChannel, Single( Min( SoundVolume, 128 ) / 128.0 ) ) );
FMOD_CHECK( FMOD_Channel_set3DAttributes( iChannel, @iPosition, nil ) );
Expand All @@ -237,6 +253,7 @@ procedure TFMODSound.PlaySound3D(aData: Pointer; aRelative: TCoord2D);
procedure TFMODSound.PlaySound(aData: Pointer; aVolume: Byte; aPan: Integer);
var iChannel : PFMOD_CHANNEL;
begin
if NumChannelsPlaying() = MaxConcurrentSounds then Exit; //Do not allow more sounds than this or a channel will be stolen (e.g. music)
FMOD_CHECK( FMOD_System_PlaySound( GSystem, PFMOD_SOUND(aData), GGroupSounds, 1, @iChannel ) );
FMOD_CHECK( FMOD_Channel_SetVolume( iChannel, ( Single(aVolume) / 255.0 ) ) );
if aPan <> -1
Expand Down