C4MusicSystem Class Reference

#include <C4MusicSystem.h>

Collaboration diagram for C4MusicSystem:

Public Member Functions
	C4MusicSystem ()
	~C4MusicSystem ()
void	Clear ()
void	ClearGame ()
void	UpdateVolume ()
void	Execute (bool force_buffer_checks=false)
void	NotifySuccess ()
bool	Init (const char *PlayList=nullptr)
bool	InitForScenario (C4Group &hGroup)
bool	Play (const char *szSongname=nullptr, bool fLoop=false, int fadetime_ms=0, double max_resume_time=0.0, bool allow_break=false)
bool	Play (C4MusicFile *NewFile, bool fLoop, double max_resume_time)
bool	Stop ()
void	FadeOut (int fadeout_ms)
int	SetPlayList (const char *szPlayList, bool fForceSwitch=false, int fadetime_ms=0, double max_resume_time=0.0)
bool	ToggleOnOff ()
void	SelectContext ()
ALCcontext *	GetContext () const
ALCdevice *	GetDevice () const
bool	IsMODInitialized ()
void	CompileFunc (class StdCompiler *comp)
void	SetMusicBreakMin (int32_t val)
void	SetMusicBreakMax (int32_t val)
void	SetMusicBreakChance (int32_t val)
void	SetMusicMaxPositionMemory (int32_t val)
int32_t	SetGameMusicLevel (int32_t val)

Protected Member Functions
void	LoadDir (const char *szPath)
void	Load (const char *szFile)
void	LoadMoreMusic ()
void	ClearSongs ()
bool	GrpContainsMusic (C4Group &rGrp)
bool	ScheduleWaitTime ()
bool	InitializeMOD ()
void	DeinitializeMOD ()

Protected Attributes
C4MusicFile *	Songs {nullptr}
int	SongCount {0}
int	ASongCount
int	SCounter
C4MusicFile *	PlayMusicFile {nullptr}
int	Volume {100}
bool	Loop
C4MusicFile *	FadeMusicFile {nullptr}
C4MusicFile *	upcoming_music_file {nullptr}
C4TimeMilliseconds	FadeTimeStart
C4TimeMilliseconds	FadeTimeEnd
bool	is_waiting {false}
C4TimeMilliseconds	wait_time_end
bool	MODInitialized

Friends
class	C4SoundEffect
class	C4SoundInstance
class	C4SoundSystem

Detailed Description

Definition at line 29 of file C4MusicSystem.h.

Constructor & Destructor Documentation

C4MusicSystem()

C4MusicSystem::C4MusicSystem

(

)

Definition at line 29 of file C4MusicSystem.cpp.

                            :
        playlist(),
        music_break_min(DefaultMusicBreak), music_break_max(DefaultMusicBreak),
        wait_time_end()
{
}

~C4MusicSystem()

C4MusicSystem::~C4MusicSystem

(

)

Definition at line 36 of file C4MusicSystem.cpp.

{
    Clear();
}

References Clear().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4MusicSystem::Clear

(

)

Definition at line 311 of file C4MusicSystem.cpp.

{
#if AUDIO_TK == AUDIO_TK_SDL_MIXER
    // Stop a fadeout
    Mix_HaltMusic();
#endif
    ClearSongs();
    if (MODInitialized) { DeinitializeMOD(); }
}

References ClearSongs(), DeinitializeMOD(), and MODInitialized.

Referenced by C4Application::Clear(), and ~C4MusicSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearGame()

void C4MusicSystem::ClearGame

(

)

Definition at line 321 of file C4MusicSystem.cpp.

{
    game_music_level = 100;
    music_break_min = music_break_max = DefaultMusicBreak;
    music_break_chance = DefaultMusicBreakChance;
    music_max_position_memory = DefaultMusicMaxPositionMemory;
    SetPlayList(nullptr);
    is_waiting = false;
    upcoming_music_file = nullptr;
}

References is_waiting, SetPlayList(), and upcoming_music_file.

Referenced by C4Game::Clear(), and C4Game::Default().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearSongs()

void C4MusicSystem::ClearSongs ( )

protected

Definition at line 297 of file C4MusicSystem.cpp.

{
    Stop();
    while (Songs)
    {
        C4MusicFile *pFile = Songs;
        Songs = pFile->pNext;
        delete pFile;
    }
    SongCount = 0;
    FadeMusicFile = upcoming_music_file = PlayMusicFile = nullptr;
    playlist_valid = false;
}

References FadeMusicFile, PlayMusicFile, C4MusicFile::pNext, SongCount, Songs, Stop(), and upcoming_music_file.

Referenced by Clear(), Init(), InitForScenario(), and LoadMoreMusic().

Here is the call graph for this function:

Here is the caller graph for this function:

CompileFunc()

void C4MusicSystem::CompileFunc

(

class StdCompiler *

comp

)

Definition at line 761 of file C4MusicSystem.cpp.

{
    comp->Value(mkNamingAdapt(playlist, "PlayList", StdCopyStrBuf()));
    comp->Value(mkNamingAdapt(game_music_level, "Volume", 100));
    comp->Value(mkNamingAdapt(music_break_min, "MusicBreakMin", DefaultMusicBreak));
    comp->Value(mkNamingAdapt(music_break_max, "MusicBreakMax", DefaultMusicBreak));
    comp->Value(mkNamingAdapt(music_break_chance, "MusicBreakChance", DefaultMusicBreakChance));
    comp->Value(mkNamingAdapt(music_max_position_memory, "MusicMaxPositionMemory", DefaultMusicMaxPositionMemory));
    // Wait time is not saved - begin savegame resume with a fresh song!
    // Reflect loaded values immediately
    if (comp->isDeserializer())
    {
        SetGameMusicLevel(game_music_level);
        SetPlayList(playlist.getData());
    }
}

References StdStrBuf::getData(), StdCompiler::isDeserializer(), mkNamingAdapt(), SetGameMusicLevel(), SetPlayList(), and StdCompiler::Value().

Here is the call graph for this function:

DeinitializeMOD()

void C4MusicSystem::DeinitializeMOD ( )

protected

Definition at line 97 of file C4MusicSystem.cpp.

{
#if AUDIO_TK == AUDIO_TK_SDL_MIXER
    Mix_CloseAudio();
    SDL_QuitSubSystem(SDL_INIT_AUDIO);
#elif AUDIO_TK == AUDIO_TK_OPENAL
#ifndef __APPLE__
    alutExit();
#endif
    alcDestroyContext(alcContext);
    alcCloseDevice(alcDevice);
    alcContext = nullptr;
    alcDevice = nullptr;
#endif
    MODInitialized = false;
}

References MODInitialized.

Referenced by Clear().

Here is the caller graph for this function:

Execute()

void C4MusicSystem::Execute

(

bool

force_buffer_checks = false

)

Definition at line 332 of file C4MusicSystem.cpp.

{
    // Execute music fading
    if (FadeMusicFile)
    {
        C4TimeMilliseconds tNow = C4TimeMilliseconds::Now();
        // Fading done?
        if (tNow >= FadeTimeEnd)
        {
            FadeMusicFile->Stop();
            FadeMusicFile = nullptr;
            if (PlayMusicFile)
            {
                PlayMusicFile->SetVolume(Volume);
            }
            else if (upcoming_music_file)
            {
                // Fade end -> start desired next immediately
                force_song_execution = true;
            }
        }
        else
        {
            // Fade process
            int fade_volume = 1000 * (tNow - FadeTimeStart) / (FadeTimeEnd - FadeTimeStart);
            FadeMusicFile->SetVolume(Volume * (1000 - fade_volume) / 1000);
            if (PlayMusicFile) PlayMusicFile->SetVolume(Volume * fade_volume / 1000);
        }
    }
    // Ensure a piece is played
#if AUDIO_TK != AUDIO_TK_SDL_MIXER
    if (!::Game.iTick35 || !::Game.IsRunning || force_song_execution || ::Game.IsPaused())
#else
    (void) force_song_execution;
#endif
    {
        if (!PlayMusicFile)
        {
            if (!is_waiting || (C4TimeMilliseconds::Now() >= wait_time_end))
            {
                // Play a song if no longer in silence mode and nothing is playing right now
                C4MusicFile *next_file = upcoming_music_file;
                is_waiting = false;
                upcoming_music_file = nullptr;
                if (next_file)
                    Play(next_file, false, 0.0);
                else
                    Play();
            }
        }
        else
        {
            // Calls NotifySuccess if a new piece had been selected.
            PlayMusicFile->CheckIfPlaying();
        }
    }
}

References C4MusicFile::CheckIfPlaying(), FadeMusicFile, FadeTimeEnd, FadeTimeStart, Game, is_waiting, C4Game::IsPaused(), C4Game::IsRunning, C4Game::iTick35, C4TimeMilliseconds::Now(), Play(), PlayMusicFile, C4MusicFile::SetVolume(), C4MusicFile::Stop(), upcoming_music_file, Volume, and wait_time_end.

Referenced by C4GraphicsSystem::DoSaveScreenshot(), and C4Application::GameTick().

Here is the call graph for this function:

Here is the caller graph for this function:

FadeOut()

void C4MusicSystem::FadeOut

(

int

fadeout_ms

)

Definition at line 606 of file C4MusicSystem.cpp.

{
    // Kill any previous fading music and schedule current piece to fade
    if (PlayMusicFile)
    {
        if (FadeMusicFile) FadeMusicFile->Stop();
        FadeMusicFile = PlayMusicFile;
        PlayMusicFile = nullptr;
        FadeTimeStart = C4TimeMilliseconds::Now();
        FadeTimeEnd = FadeTimeStart + fadeout_ms;
    }
}

References FadeMusicFile, FadeTimeEnd, FadeTimeStart, C4TimeMilliseconds::Now(), PlayMusicFile, and C4MusicFile::Stop().

Referenced by C4Game::Clear().

Here is the call graph for this function:

Here is the caller graph for this function:

GetContext()

ALCcontext* C4MusicSystem::GetContext ( ) const

inline

Definition at line 89 of file C4MusicSystem.h.

{ return alcContext; }

GetDevice()

ALCdevice* C4MusicSystem::GetDevice ( ) const

inline

Definition at line 90 of file C4MusicSystem.h.

{ return alcDevice; }

Referenced by C4SoundModifierList::Init().

Here is the caller graph for this function:

GrpContainsMusic()

bool C4MusicSystem::GrpContainsMusic ( C4Group &  rGrp )

protected

Definition at line 661 of file C4MusicSystem.cpp.

{
    // search for known file extensions
    return           rGrp.FindEntry("*.mid")
#ifdef USE_MP3
                     || rGrp.FindEntry("*.mp3")
#endif
                     || rGrp.FindEntry("*.xm")
                     || rGrp.FindEntry("*.it")
                     || rGrp.FindEntry("*.s3m")
                     || rGrp.FindEntry("*.mod")
                     || rGrp.FindEntry("*.ogg");
}

References C4Group::FindEntry().

Referenced by InitForScenario().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4MusicSystem::Init

(

const char *

PlayList = nullptr

)

Definition at line 114 of file C4MusicSystem.cpp.

{
    // init mod
    if (!MODInitialized && !InitializeMOD()) return false;
    // Might be reinitialisation
    ClearSongs();
    // Global music file
    LoadDir(Config.AtSystemDataPath(C4CFN_Music));
    // User music file
    LoadDir(Config.AtUserDataPath(C4CFN_Music));
    // read MoreMusic.txt
    LoadMoreMusic();
    // set play list
    SCounter = 0;
    if (PlayList) SetPlayList(PlayList); else SetPlayList(nullptr);
    // set initial volume
    UpdateVolume();
    // ok
    return true;
}

References C4Config::AtSystemDataPath(), C4Config::AtUserDataPath(), C4CFN_Music, ClearSongs(), Config, InitializeMOD(), LoadDir(), LoadMoreMusic(), MODInitialized, SCounter, SetPlayList(), and UpdateVolume().

Referenced by C4Application::PreInit().

Here is the call graph for this function:

Here is the caller graph for this function:

InitForScenario()

bool C4MusicSystem::InitForScenario

(

C4Group &

hGroup

)

Definition at line 135 of file C4MusicSystem.cpp.

{
    // check if the scenario contains music
    bool fLocalMusic = false;
    StdStrBuf MusicDir;
    if (GrpContainsMusic(hGroup))
    {
        // clear global songs
        ClearSongs();
        fLocalMusic = true;
        // add songs
        MusicDir.Take(Game.ScenarioFile.GetFullName());
        LoadDir(MusicDir.getData());
        // log
        LogF(LoadResStr("IDS_PRC_LOCALMUSIC"), MusicDir.getData());
    }
    // check for music folders in group set
    C4Group *pMusicFolder = nullptr;
    while ((pMusicFolder = Game.GroupSet.FindGroup(C4GSCnt_Music, pMusicFolder)))
    {
        if (!fLocalMusic)
        {
            // clear global songs
            ClearSongs();
            fLocalMusic = true;
        }
        // add songs
        MusicDir.Take(pMusicFolder->GetFullName());
        MusicDir.AppendChar(DirectorySeparator);
        MusicDir.Append(C4CFN_Music);
        LoadDir(MusicDir.getData());
        // log
        LogF(LoadResStr("IDS_PRC_LOCALMUSIC"), MusicDir.getData());
    }
    // no music?
    if (!SongCount) return false;
    // set play list
    SetPlayList(nullptr);
    // ok
    return true;
}

References StdStrBuf::Append(), StdStrBuf::AppendChar(), C4CFN_Music, C4GSCnt_Music, ClearSongs(), DirectorySeparator, C4GroupSet::FindGroup(), Game, StdStrBuf::getData(), C4Group::GetFullName(), C4Game::GroupSet, GrpContainsMusic(), LoadDir(), LoadResStr(), LogF(), C4Game::ScenarioFile, SetPlayList(), SongCount, and StdStrBuf::Take().

Here is the call graph for this function:

InitializeMOD()

bool C4MusicSystem::InitializeMOD ( )

protected

Definition at line 48 of file C4MusicSystem.cpp.

{
#if AUDIO_TK == AUDIO_TK_SDL_MIXER
    SDL_version compile_version;
    const SDL_version * link_version;
    MIX_VERSION(&compile_version);
    link_version=Mix_Linked_Version();
    LogF("SDL_mixer runtime version is %d.%d.%d (compiled with %d.%d.%d)",
         link_version->major, link_version->minor, link_version->patch,
         compile_version.major, compile_version.minor, compile_version.patch);
    if (SDL_InitSubSystem(SDL_INIT_AUDIO) != 0)
    {
        LogF("SDL_InitSubSystem(SDL_INIT_AUDIO): %s", SDL_GetError());
        return false;
    }
    //frequency, format, stereo, chunksize
    if (Mix_OpenAudio(44100, AUDIO_S16SYS, 2, 1024))
    {
        LogF("SDL_mixer: %s", SDL_GetError());
        return false;
    }
    MODInitialized = true;
    return true;
#elif AUDIO_TK == AUDIO_TK_OPENAL
    alcDevice = alcOpenDevice(nullptr);
    if (!alcDevice)
    {
        LogF("Sound system: OpenAL create context error");
        return false;
    }
    alcContext = alcCreateContext(alcDevice, nullptr);
    if (!alcContext)
    {
        LogF("Sound system: OpenAL create context error");
        return false;
    }
#ifndef __APPLE__
    if (!alutInitWithoutContext(nullptr, nullptr))
    {
        LogF("Sound system: ALUT init error");
        return false;
    }
#endif
    MODInitialized = true;
    return true;
#endif
    return false;
}

References LogF(), and MODInitialized.

Referenced by C4SoundSystem::Init(), and Init().

Here is the call graph for this function:

Here is the caller graph for this function:

IsMODInitialized()

bool C4MusicSystem::IsMODInitialized ( )

inline

Definition at line 93 of file C4MusicSystem.h.

{return MODInitialized;}

References MODInitialized.

Load()

void C4MusicSystem::Load ( const char *  szFile )

protected

Definition at line 177 of file C4MusicSystem.cpp.

{
    // safety
    if (!szFile || !*szFile) return;
    C4MusicFile *NewSong=nullptr;
#if AUDIO_TK == AUDIO_TK_OPENAL
    // openal: Only ogg supported
    const char *szExt = GetExtension(szFile);
    if (SEqualNoCase(szExt, "ogg")) NewSong = new C4MusicFileOgg;
#elif AUDIO_TK == AUDIO_TK_SDL_MIXER
    if (GetMusicFileTypeByExtension(GetExtension(szFile)) == MUSICTYPE_UNKNOWN) return;
    NewSong = new C4MusicFileSDL;
#endif
    // unrecognized type/mod not initialized?
    if (!NewSong) return;
    // init music file
    NewSong->Init(szFile);
    // add song to list (push back)
    C4MusicFile *pCurr = Songs;
    while (pCurr && pCurr->pNext) pCurr = pCurr->pNext;
    if (pCurr) pCurr->pNext = NewSong; else Songs = NewSong;
    NewSong->pNext = nullptr;
    // count songs
    SongCount++;
    playlist_valid = false;
}

References GetExtension(), GetMusicFileTypeByExtension(), C4MusicFile::Init(), MUSICTYPE_UNKNOWN, C4MusicFile::pNext, SEqualNoCase(), SongCount, and Songs.

Referenced by LoadDir().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadDir()

void C4MusicSystem::LoadDir ( const char *  szPath )

protected

Definition at line 204 of file C4MusicSystem.cpp.

{
    char Path[_MAX_FNAME_LEN], File[_MAX_FNAME_LEN];
    C4Group *pDirGroup = nullptr;
    // split path
    SCopy(szPath, Path, _MAX_FNAME);
    char *pFileName = GetFilename(Path);
    SCopy(pFileName, File);
    *(pFileName - 1) = 0;
    // no file name?
    if (!File[0])
        // -> add the whole directory
        SCopy("*", File);
    // no wildcard match?
    else if (!SSearch(File, "*?"))
    {
        // then it's either a file or a directory - do the test with C4Group
        pDirGroup = new C4Group();
        if (!pDirGroup->Open(szPath))
        {
            // so it must be a file
            if (!pDirGroup->Open(Path))
            {
                // -> file/dir doesn't exist
                LogF("Music File not found: %s", szPath);
                delete pDirGroup;
                return;
            }
            // mother group is open... proceed with normal handling
        }
        else
        {
            // ok, set wildcard (load the whole directory)
            SCopy(szPath, Path);
            SCopy("*", File);
        }
    }
    // open directory group, if not already done so
    if (!pDirGroup)
    {
        pDirGroup = new C4Group();
        if (!pDirGroup->Open(Path))
        {
            LogF("Music File not found: %s", szPath);
            delete pDirGroup;
            return;
        }
    }
    // search file(s)
    char szFile[_MAX_FNAME_LEN];
    pDirGroup->ResetSearch();
    while (pDirGroup->FindNextEntry(File, szFile))
    {
        char strFullPath[_MAX_FNAME_LEN];
        sprintf(strFullPath, "%s%c%s", Path, DirectorySeparator, szFile);
        Load(strFullPath);
    }
    // free it
    delete pDirGroup;
}

References _MAX_FNAME, _MAX_FNAME_LEN, DirectorySeparator, C4Group::FindNextEntry(), GetFilename(), Load(), LogF(), C4Group::Open(), C4Group::ResetSearch(), SCopy(), sprintf, and SSearch().

Referenced by Init(), InitForScenario(), and LoadMoreMusic().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadMoreMusic()

void C4MusicSystem::LoadMoreMusic ( )

protected

Definition at line 265 of file C4MusicSystem.cpp.

{
    StdStrBuf MoreMusicFile;
    // load MoreMusic.txt
    if (!MoreMusicFile.LoadFromFile(Config.AtUserDataPath(C4CFN_MoreMusic))) return;
    // read contents
    char *pPos = MoreMusicFile.getMData();
    while (pPos && *pPos)
    {
        // get line
        char szLine[1024 + 1];
        SCopyUntil(pPos, szLine, '\n', 1024);
        pPos = strchr(pPos, '\n'); if (pPos) pPos++;
        // remove leading whitespace
        char *pLine = szLine;
        while (*pLine == ' ' || *pLine == '\t' || *pLine == '\r') pLine++;
        // and whitespace at end
        char *p = pLine + strlen(pLine) - 1;
        while (*p == ' ' || *p == '\t' || *p == '\r') { *p = 0; --p; }
        // comment?
        if (*pLine == '#')
        {
            // might be a "directive"
            if (SEqual(pLine, "#clear"))
                ClearSongs();
            continue;
        }
        // try to load file(s)
        LoadDir(pLine);
    }
}

References C4Config::AtUserDataPath(), C4CFN_MoreMusic, ClearSongs(), Config, StdStrBuf::getMData(), LoadDir(), StdStrBuf::LoadFromFile(), SCopyUntil(), and SEqual().

Referenced by Init().

Here is the call graph for this function:

Here is the caller graph for this function:

NotifySuccess()

void C4MusicSystem::NotifySuccess

(

)

Definition at line 567 of file C4MusicSystem.cpp.

{
    // nothing played?
    if (!PlayMusicFile) return;
    // loop?
    if (Loop)
        if (PlayMusicFile->Play())
            return;
    // clear last played piece
    Stop();
    // force a wait time after this song?
    ScheduleWaitTime();
}

References Loop, C4MusicFile::Play(), PlayMusicFile, ScheduleWaitTime(), and Stop().

Referenced by C4MusicFileSDL::CheckIfPlaying(), and ConsoleDlgProc().

Here is the call graph for this function:

Here is the caller graph for this function:

Play() [1/2]

bool C4MusicSystem::Play	(	C4MusicFile *	NewFile,
		bool	fLoop,
		double	max_resume_time
	)

Definition at line 544 of file C4MusicSystem.cpp.

{
    // info
    if (::Config.Sound.Verbose)
    {
        LogF(R"(MusicSystem: PlaySong("%s", %s, %.3lf))", NewFile->GetDebugInfo().getData(), fLoop ? "true" : "false", max_resume_time);
    }
    // Play new song directly
    if (!NewFile->Play(fLoop, max_resume_time)) return false;
    PlayMusicFile = NewFile;
    NewFile->LastPlayed = SCounter++;
    Loop = fLoop;
 
    // Set volume
    PlayMusicFile->SetVolume(Volume);
 
    // Message first time a piece is played
    if (!NewFile->HasBeenAnnounced())
        NewFile->Announce();
 
    return true;
}

References C4MusicFile::Announce(), Config, StdStrBuf::getData(), C4MusicFile::GetDebugInfo(), C4MusicFile::HasBeenAnnounced(), C4MusicFile::LastPlayed, LogF(), Loop, C4MusicFile::Play(), PlayMusicFile, SCounter, C4MusicFile::SetVolume(), C4Config::Sound, C4ConfigSound::Verbose, and Volume.

Here is the call graph for this function:

Play() [2/2]

bool C4MusicSystem::Play	(	const char *	szSongname = nullptr,
		bool	fLoop = false,
		int	fadetime_ms = 0,
		double	max_resume_time = 0.0,
		bool	allow_break = false
	)

Definition at line 390 of file C4MusicSystem.cpp.

{
    // pause is done
    is_waiting = false;
    upcoming_music_file = nullptr;
 
    // music off?
    if (Game.IsRunning ? !Config.Sound.RXMusic : !Config.Sound.FEMusic)
        return false;
 
    // info
    if (::Config.Sound.Verbose)
    {
        LogF(R"(MusicSystem: Play("%s", %s, %d, %.3lf, %s))", szSongname ? szSongname : "(null)", fLoop ? "true" : "false", fadetime_ms, max_resume_time, allow_break ? "true" : "false");
    }
 
    C4MusicFile* NewFile = nullptr;
 
    // Specified song name
    if (szSongname && szSongname[0])
    {
        // Search in list
        for (NewFile = Songs; NewFile; NewFile = NewFile->pNext)
        {
            char songname[_MAX_FNAME_LEN];
            SCopy(szSongname, songname); DefaultExtension(songname, "mid");
            if (SEqual(GetFilename(NewFile->FileName), songname))
                break;
            SCopy(szSongname, songname); DefaultExtension(songname, "ogg");
            if (SEqual(GetFilename(NewFile->FileName), songname))
                break;
        }
    }
    else
    {
        // When resuming, prefer songs that were interrupted before
        if (max_resume_time > 0)
        {
            C4TimeMilliseconds t_now = C4TimeMilliseconds::Now();
            for (C4MusicFile *check_file = Songs; check_file; check_file = check_file->pNext)
                if (!check_file->NoPlay)
                {
                    if (check_file->HasResumePos() && check_file->GetRemainingTime() > max_resume_time)
                        if (!music_max_position_memory || (t_now - check_file->GetLastInterruptionTime() <= music_max_position_memory*1000))
                            if (!NewFile || NewFile->LastPlayed < check_file->LastPlayed)
                                NewFile = check_file;
                }
        }
 
        // Random song
        if (!NewFile)
        {
            // Intead of a new song, is a break also allowed?
            if (allow_break) ScheduleWaitTime();
            if (!is_waiting)
            {
                if (::Config.Sound.Verbose) LogF("  ASongCount=%d SCounter=%d", ASongCount, SCounter);
                // try to find random song
                int32_t new_file_playability = 0, new_file_num_rolls = 0;
                for (C4MusicFile *check_file = Songs; check_file; check_file = check_file->pNext)
                {
                    if (!check_file->NoPlay)
                    {
                        // Categorize song playability:
                        // 0 = no song found yet
                        // 1 = song was played recently
                        // 2 = song not played recently
                        // 3 = song was not played yet
                        int32_t check_file_playability = (check_file->LastPlayed < 0) ? 3 : (SCounter - check_file->LastPlayed <= ASongCount / 2) ? 1 : 2;
                        if (::Config.Sound.Verbose) LogF("  Song LastPlayed %d [%d] (%s)", int(check_file->LastPlayed), int(check_file_playability), check_file->GetDebugInfo().getData());
                        if (check_file_playability > new_file_playability)
                        {
                            // Found much better fit. Play this and reset number of songs found in same plyability
                            new_file_num_rolls = 1;
                            NewFile = check_file;
                            new_file_playability = check_file_playability;
                        }
                        else if (check_file_playability == new_file_playability)
                        {
                            // Found a fit in the same playability category: Roll for it
                            if (!UnsyncedRandom(++new_file_num_rolls)) NewFile = check_file;
                        }
                        else
                        {
                            // Worse playability - ignore this song
                        }
                    }
                }
            }
 
        }
    }
 
    // File (or wait time) found?
    if (!NewFile && !is_waiting)
        return false;
 
    // Stop/Fade out old music
    bool is_fading = (fadetime_ms && NewFile != PlayMusicFile && PlayMusicFile);
    if (!is_fading)
    {
        Stop();
    }
    else
    {
        C4TimeMilliseconds tNow = C4TimeMilliseconds::Now();
        if (FadeMusicFile)
        {
            if (FadeMusicFile == NewFile && FadeMusicFile->IsLooping() == fLoop && tNow < FadeTimeEnd)
            {
                // Fading back to a song while it wasn't fully faded out yet. Just swap our pointers and fix timings for that.
                FadeMusicFile = PlayMusicFile;
                PlayMusicFile = NewFile;
                FadeTimeEnd = tNow + fadetime_ms * (tNow - FadeTimeStart) / (FadeTimeEnd - FadeTimeStart);
                FadeTimeStart = FadeTimeEnd - fadetime_ms;
                return true;
            }
            else
            {
                // Fading to a third song while the previous wasn't faded out yet
                // That's pretty chaotic anyway, so just cancel the last song
                // Also happens if fading should already be done, in which case it won't harm to stop now
                // (It would stop on next call to Execute() anyway)
                // Also happens when fading back to the same song but loop status changes, but that should be really uncommon.
                FadeMusicFile->Stop();
            }
 
        }
        FadeMusicFile = PlayMusicFile;
        PlayMusicFile = nullptr;
        FadeTimeStart = tNow;
        FadeTimeEnd = FadeTimeStart + fadetime_ms;
    }
 
    // Waiting?
    if (!NewFile) return false;
 
    // If the old file is being faded out and a new file would just start, start delayed and without fading
    // so the beginning of a song isn't faded unnecesserily (because our songs often start very abruptly)
    if (is_fading && (!NewFile->HasResumePos() || NewFile->GetRemainingTime() <= max_resume_time))
    {
        upcoming_music_file = NewFile;
        is_waiting = true;
        wait_time_end = FadeTimeEnd;
        return false;
    }
 
    if (!Play(NewFile, fLoop, max_resume_time)) return false;
 
    if (is_fading) PlayMusicFile->SetVolume(0);
 
    return true;
}

References _MAX_FNAME_LEN, ASongCount, Config, DefaultExtension(), FadeMusicFile, FadeTimeEnd, FadeTimeStart, C4ConfigSound::FEMusic, C4MusicFile::FileName, Game, GetFilename(), C4MusicFile::GetRemainingTime(), C4MusicFile::HasResumePos(), is_waiting, C4MusicFile::IsLooping(), C4Game::IsRunning, C4MusicFile::LastPlayed, LogF(), C4TimeMilliseconds::Now(), PlayMusicFile, C4MusicFile::pNext, C4ConfigSound::RXMusic, ScheduleWaitTime(), SCopy(), SCounter, SEqual(), C4MusicFile::SetVolume(), Songs, C4Config::Sound, Stop(), C4MusicFile::Stop(), UnsyncedRandom(), upcoming_music_file, C4ConfigSound::Verbose, and wait_time_end.

Referenced by Execute(), C4Application::PreInit(), SetPlayList(), and ToggleOnOff().

Here is the call graph for this function:

Here is the caller graph for this function:

ScheduleWaitTime()

bool C4MusicSystem::ScheduleWaitTime ( )

protected

Definition at line 581 of file C4MusicSystem.cpp.

{
    // Roll for scheduling a break after the next piece.
    if (SCounter < 3) return false; // But not right away.
    if (int32_t(UnsyncedRandom(100)) >= music_break_chance) return false;
    if (music_break_max > 0)
    {
        int32_t music_break = music_break_min;
        if (music_break_max > music_break_min) music_break += UnsyncedRandom(music_break_max - music_break_min); // note that UnsyncedRandom has limited range
        if (music_break > 0)
        {
            is_waiting = true;
            wait_time_end = C4TimeMilliseconds::Now() + music_break;
            if (::Config.Sound.Verbose)
            {
                LogF("MusicSystem: Pause (%d msecs)", (int)music_break);
            }
            // After wait, do not resume previously started songs
            for (C4MusicFile *check_file = Songs; check_file; check_file = check_file->pNext)
                check_file->ClearResumePos();
        }
    }
    return is_waiting;
}

References Config, is_waiting, LogF(), C4TimeMilliseconds::Now(), C4MusicFile::pNext, SCounter, Songs, C4Config::Sound, UnsyncedRandom(), C4ConfigSound::Verbose, and wait_time_end.

Referenced by NotifySuccess(), and Play().

Here is the call graph for this function:

Here is the caller graph for this function:

SelectContext()

void C4MusicSystem::SelectContext

(

)

Definition at line 42 of file C4MusicSystem.cpp.

{
    alcMakeContextCurrent(alcContext);
}

Referenced by C4SoundModifier::C4SoundModifier(), C4SoundSystem::Execute(), C4SoundModifierList::Init(), C4SoundEffect::Load(), C4SoundLoaders::WavLoader::ReadInfo(), C4SoundInstance::Start(), C4SoundModifierReverb::Update(), C4SoundModifierEcho::Update(), and C4SoundModifierEqualizer::Update().

Here is the caller graph for this function:

SetGameMusicLevel()

int32_t C4MusicSystem::SetGameMusicLevel

(

int32_t

val

)

Definition at line 778 of file C4MusicSystem.cpp.

{
    game_music_level = Clamp<int32_t>(volume_percent, 0, 500); // allow max 5x the user setting
    UpdateVolume();
    return game_music_level;
}

References UpdateVolume().

Referenced by CompileFunc().

Here is the call graph for this function:

Here is the caller graph for this function:

SetMusicBreakChance()

void C4MusicSystem::SetMusicBreakChance ( int32_t  val )

inline

Definition at line 115 of file C4MusicSystem.h.

{ music_break_chance = Clamp<int32_t>(val, 0, 100); }

SetMusicBreakMax()

void C4MusicSystem::SetMusicBreakMax ( int32_t  val )

inline

Definition at line 114 of file C4MusicSystem.h.

{ music_break_max = std::max<int32_t>(val, 0); }

SetMusicBreakMin()

void C4MusicSystem::SetMusicBreakMin ( int32_t  val )

inline

Definition at line 113 of file C4MusicSystem.h.

{ music_break_min = std::max<int32_t>(val, 0); }

SetMusicMaxPositionMemory()

void C4MusicSystem::SetMusicMaxPositionMemory ( int32_t  val )

inline

Definition at line 116 of file C4MusicSystem.h.

{ music_max_position_memory = val; }

SetPlayList()

int C4MusicSystem::SetPlayList	(	const char *	szPlayList,
		bool	fForceSwitch = false,
		int	fadetime_ms = 0,
		double	max_resume_time = 0.0
	)

Definition at line 675 of file C4MusicSystem.cpp.

{
    // Shortcut if no change
    if (playlist_valid && playlist == szPlayList) return 0;
    // info
    if (::Config.Sound.Verbose)
    {
        LogF(R"(MusicSystem: SetPlayList("%s", %s, %d, %.3lf))", szPlayList ? szPlayList : "(null)", fForceSwitch ? "true" : "false", fadetime_ms, max_resume_time);
    }
    // reset
    C4MusicFile *pFile;
    for (pFile = Songs; pFile; pFile = pFile->pNext)
    {
        pFile->NoPlay = true;
    }
    ASongCount = 0;
    if (szPlayList && *szPlayList)
    {
        // match
        char szFileName[_MAX_FNAME_LEN];
        for (int cnt = 0; SGetModule(szPlayList, cnt, szFileName, _MAX_FNAME); cnt++)
            for (pFile = Songs; pFile; pFile = pFile->pNext) if (pFile->NoPlay)
                if (WildcardMatch(szFileName, GetFilename(pFile->FileName)) || pFile->HasCategory(szFileName))
                {
                    ASongCount++;
                    pFile->NoPlay = false;
                }
    }
    else
    {
        // default: all files except the ones beginning with an at ('@')
        // Ignore frontend and credits music
        for (pFile = Songs; pFile; pFile = pFile->pNext)
            if (*GetFilename(pFile->FileName) != '@' &&
                !pFile->HasCategory("frontend") &&
                !pFile->HasCategory("credits"))
            {
                ASongCount++;
                pFile->NoPlay = false;
            }
    }
    // Force switch of music if currently playing piece is not in list or idle because no music file matched
    if (fForceSwitch)
    {
        if (PlayMusicFile)
        {
            fForceSwitch = PlayMusicFile->NoPlay;
        }
        else
        {
            fForceSwitch = (!is_waiting || C4TimeMilliseconds::Now() >= wait_time_end);
        }
        if (fForceSwitch)
        {
            // Switch music. Switching to a break is also allowed, but won't be done if there is a piece to resume
            // Otherwise breaks would never occur if the playlist changes often.
            Play(nullptr, false, fadetime_ms, max_resume_time, PlayMusicFile != nullptr);
        }
    }
    // Remember setting (e.g. to be saved in savegames)
    playlist.Copy(szPlayList);
    playlist_valid = true; // do not re-calculate available song if playlist is reset to same value in the future
    return ASongCount;
}

References _MAX_FNAME, _MAX_FNAME_LEN, ASongCount, Config, StdStrBuf::Copy(), C4MusicFile::FileName, GetFilename(), C4MusicFile::HasCategory(), is_waiting, LogF(), C4MusicFile::NoPlay, C4TimeMilliseconds::Now(), Play(), PlayMusicFile, C4MusicFile::pNext, SGetModule(), Songs, C4Config::Sound, C4ConfigSound::Verbose, wait_time_end, and WildcardMatch().

Referenced by ClearGame(), CompileFunc(), Init(), and InitForScenario().

Here is the call graph for this function:

Here is the caller graph for this function:

Stop()

bool C4MusicSystem::Stop

(

)

Definition at line 619 of file C4MusicSystem.cpp.

{
    if (PlayMusicFile)
    {
        PlayMusicFile->Stop();
        PlayMusicFile=nullptr;
    }
    if (FadeMusicFile)
    {
        FadeMusicFile->Stop();
        FadeMusicFile = nullptr;
    }
    return true;
}

References FadeMusicFile, PlayMusicFile, and C4MusicFile::Stop().

Referenced by ClearSongs(), NotifySuccess(), Play(), and ToggleOnOff().

Here is the call graph for this function:

Here is the caller graph for this function:

ToggleOnOff()

bool C4MusicSystem::ToggleOnOff

(

)

Definition at line 740 of file C4MusicSystem.cpp.

{
    // // command key for music toggle pressed
    // use different settings for game/menu (lobby also counts as "menu", so go by Game.IsRunning-flag rather than startup)
    if (Game.IsRunning)
    {
        // game music
        Config.Sound.RXMusic = !Config.Sound.RXMusic;
        if (!Config.Sound.RXMusic) Stop(); else Play();
        ::GraphicsSystem.FlashMessageOnOff(LoadResStr("IDS_CTL_MUSIC"), !!Config.Sound.RXMusic);
    }
    else
    {
        // game menu
        Config.Sound.FEMusic = !Config.Sound.FEMusic;
        if (!Config.Sound.FEMusic) Stop(); else Play();
    }
    // key processed
    return true;
}

References Config, C4ConfigSound::FEMusic, C4GraphicsSystem::FlashMessageOnOff(), Game, GraphicsSystem, C4Game::IsRunning, LoadResStr(), Play(), C4ConfigSound::RXMusic, C4Config::Sound, and Stop().

Referenced by C4Game::InitKeyboard(), C4StartupOptionsDlg::KeyMusicToggle(), and C4MainMenu::MenuCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateVolume()

void C4MusicSystem::UpdateVolume

(

)

Definition at line 634 of file C4MusicSystem.cpp.

{
    // Save volume for next file
    int32_t config_volume = Clamp<int32_t>(Config.Sound.MusicVolume, 0, 100);
    Volume = config_volume * game_music_level / 100;
    // Tell it to the act file
    if (PlayMusicFile)
        PlayMusicFile->SetVolume(Volume);
}

References Config, C4ConfigSound::MusicVolume, PlayMusicFile, C4MusicFile::SetVolume(), C4Config::Sound, and Volume.

Referenced by Init(), and SetGameMusicLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4SoundEffect

friend class C4SoundEffect

friend

Definition at line 31 of file C4MusicSystem.h.

C4SoundInstance

friend class C4SoundInstance

friend

Definition at line 32 of file C4MusicSystem.h.

C4SoundSystem

friend class C4SoundSystem

friend

Definition at line 33 of file C4MusicSystem.h.

Member Data Documentation

ASongCount

int C4MusicSystem::ASongCount

protected

Definition at line 56 of file C4MusicSystem.h.

Referenced by Play(), and SetPlayList().

FadeMusicFile

C4MusicFile* C4MusicSystem::FadeMusicFile {nullptr}

protected

Definition at line 63 of file C4MusicSystem.h.

Referenced by ClearSongs(), Execute(), FadeOut(), Play(), and Stop().

FadeTimeEnd

C4TimeMilliseconds C4MusicSystem::FadeTimeEnd

protected

Definition at line 64 of file C4MusicSystem.h.

Referenced by Execute(), FadeOut(), and Play().

FadeTimeStart

C4TimeMilliseconds C4MusicSystem::FadeTimeStart

protected

Definition at line 64 of file C4MusicSystem.h.

Referenced by Execute(), FadeOut(), and Play().

is_waiting

bool C4MusicSystem::is_waiting {false}

protected

Definition at line 67 of file C4MusicSystem.h.

Referenced by ClearGame(), Execute(), Play(), ScheduleWaitTime(), and SetPlayList().

Loop

bool C4MusicSystem::Loop

protected

Definition at line 60 of file C4MusicSystem.h.

Referenced by NotifySuccess(), and Play().

MODInitialized

bool C4MusicSystem::MODInitialized

protected

Definition at line 80 of file C4MusicSystem.h.

Referenced by Clear(), DeinitializeMOD(), C4SoundSystem::Init(), Init(), InitializeMOD(), IsMODInitialized(), C4SoundInstance::Playing(), and C4SoundInstance::Start().

PlayMusicFile

C4MusicFile* C4MusicSystem::PlayMusicFile {nullptr}

protected

Definition at line 59 of file C4MusicSystem.h.

Referenced by ClearSongs(), Execute(), FadeOut(), NotifySuccess(), Play(), SetPlayList(), Stop(), and UpdateVolume().

SCounter

int C4MusicSystem::SCounter

protected

Definition at line 56 of file C4MusicSystem.h.

Referenced by Init(), Play(), and ScheduleWaitTime().

SongCount

int C4MusicSystem::SongCount {0}

protected

Definition at line 56 of file C4MusicSystem.h.

Referenced by ClearSongs(), InitForScenario(), and Load().

Songs

C4MusicFile* C4MusicSystem::Songs {nullptr}

protected

Definition at line 55 of file C4MusicSystem.h.

Referenced by ClearSongs(), Load(), Play(), ScheduleWaitTime(), and SetPlayList().

upcoming_music_file

C4MusicFile * C4MusicSystem::upcoming_music_file {nullptr}

protected

Definition at line 63 of file C4MusicSystem.h.

Referenced by ClearGame(), ClearSongs(), Execute(), and Play().

Volume

int C4MusicSystem::Volume {100}

protected

Definition at line 60 of file C4MusicSystem.h.

Referenced by Execute(), Play(), and UpdateVolume().

wait_time_end

C4TimeMilliseconds C4MusicSystem::wait_time_end

protected

Definition at line 68 of file C4MusicSystem.h.

Referenced by Execute(), Play(), ScheduleWaitTime(), and SetPlayList().

---

The documentation for this class was generated from the following files:

• C4MusicSystem.h
• C4MusicSystem.cpp