C4MusicFileSDL Class Reference

#include <C4MusicFile.h>

Inheritance diagram for C4MusicFileSDL:

Collaboration diagram for C4MusicFileSDL:

Public Member Functions
	C4MusicFileSDL ()
	~C4MusicFileSDL () override
bool	Play (bool loop=false, double max_resume_time=0.0) override
void	Stop (int fadeout_ms=0) override
void	CheckIfPlaying () override
void	SetVolume (int) override
virtual bool	Init (const char *strFile)
virtual bool	HasCategory (const char *szcat) const
virtual double	GetRemainingTime ()
virtual bool	HasResumePos () const
virtual void	ClearResumePos ()
virtual C4TimeMilliseconds	GetLastInterruptionTime () const
virtual StdStrBuf	GetDebugInfo () const
bool	IsLooping () const
bool	HasBeenAnnounced () const
void	Announce ()

Public Attributes
char	FileName [_MAX_FNAME_LEN]
C4MusicFile *	pNext {nullptr}
int	LastPlayed {-1}
bool	NoPlay {false}
bool	loop {false}
bool	announced {false}

Protected Member Functions
bool	ExtractFile ()
bool	RemTempFile ()

Protected Attributes
char *	Data
Mix_Music *	Music
bool	SongExtracted {false}

Detailed Description

Definition at line 71 of file C4MusicFile.h.

Constructor & Destructor Documentation

C4MusicFileSDL()

C4MusicFileSDL::C4MusicFileSDL

(

)

Definition at line 73 of file C4MusicFile.cpp.

                              :
        Data(nullptr),
        Music(nullptr)
{
}

~C4MusicFileSDL()

C4MusicFileSDL::~C4MusicFileSDL ( )

override

Definition at line 79 of file C4MusicFile.cpp.

{
    Stop();
}

References Stop().

Here is the call graph for this function:

Member Function Documentation

Announce()

void C4MusicFile::Announce ( )

inherited

Definition at line 40 of file C4MusicFile.cpp.

{
    LogF(LoadResStr("IDS_PRC_PLAYMUSIC"), GetFilename(FileName));
    announced = true;
}

References C4MusicFile::announced, C4MusicFile::FileName, GetFilename(), LoadResStr(), and LogF().

Referenced by C4MusicSystem::Play().

Here is the call graph for this function:

Here is the caller graph for this function:

CheckIfPlaying()

void C4MusicFileSDL::CheckIfPlaying ( )

overridevirtual

Implements C4MusicFile.

Definition at line 160 of file C4MusicFile.cpp.

{
    if (!Mix_PlayingMusic())
        Application.MusicSystem.NotifySuccess();
}

References Application, C4Application::MusicSystem, and C4MusicSystem::NotifySuccess().

Here is the call graph for this function:

ClearResumePos()

virtual void C4MusicFile::ClearResumePos ( )

inlinevirtualinherited

Definition at line 49 of file C4MusicFile.h.

{ }

ExtractFile()

bool C4MusicFile::ExtractFile ( )

protectedinherited

Definition at line 46 of file C4MusicFile.cpp.

{
    // safety
    if (SongExtracted) return true;
    // extract entry
    if (!C4Group_CopyItem(FileName, Config.AtTempPath(C4CFN_TempMusic2))) return false;
    // ok
    SongExtracted = true;
    return true;
}

References C4Config::AtTempPath(), C4CFN_TempMusic2, C4Group_CopyItem(), Config, C4MusicFile::FileName, and C4MusicFile::SongExtracted.

Referenced by Play().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDebugInfo()

virtual StdStrBuf C4MusicFile::GetDebugInfo ( ) const

inlinevirtualinherited

Definition at line 52 of file C4MusicFile.h.

{ return StdStrBuf(FileName); }

References C4MusicFile::FileName.

Referenced by C4MusicSystem::Play().

Here is the caller graph for this function:

GetLastInterruptionTime()

virtual C4TimeMilliseconds C4MusicFile::GetLastInterruptionTime ( ) const

inlinevirtualinherited

Definition at line 50 of file C4MusicFile.h.

{ return C4TimeMilliseconds(); }

GetRemainingTime()

virtual double C4MusicFile::GetRemainingTime ( )

inlinevirtualinherited

Definition at line 47 of file C4MusicFile.h.

{ return 0.0; }

Referenced by C4MusicSystem::Play().

Here is the caller graph for this function:

HasBeenAnnounced()

bool C4MusicFile::HasBeenAnnounced ( ) const

inlineinherited

Definition at line 56 of file C4MusicFile.h.

{ return announced; }

References C4MusicFile::announced.

Referenced by C4MusicSystem::Play().

Here is the caller graph for this function:

HasCategory()

virtual bool C4MusicFile::HasCategory ( const char *  szcat ) const

inlinevirtualinherited

Definition at line 46 of file C4MusicFile.h.

{ return false; }

Referenced by C4MusicSystem::SetPlayList().

Here is the caller graph for this function:

HasResumePos()

virtual bool C4MusicFile::HasResumePos ( ) const

inlinevirtualinherited

Definition at line 48 of file C4MusicFile.h.

{ return false; }

Referenced by C4MusicSystem::Play().

Here is the caller graph for this function:

Init()

bool C4MusicFile::Init ( const char *  strFile )

virtualinherited

Definition at line 66 of file C4MusicFile.cpp.

{
    SCopy(szFile, FileName);
    return true;
}

References C4MusicFile::FileName, and SCopy().

Referenced by C4MusicSystem::Load().

Here is the call graph for this function:

Here is the caller graph for this function:

IsLooping()

bool C4MusicFile::IsLooping ( ) const

inlineinherited

Definition at line 54 of file C4MusicFile.h.

{ return loop; }

References C4MusicFile::loop.

Referenced by C4MusicSystem::Play().

Here is the caller graph for this function:

Play()

bool C4MusicFileSDL::Play ( bool  loop = false, double  max_resume_time = 0.0  )

overridevirtual

Implements C4MusicFile.

Definition at line 84 of file C4MusicFile.cpp.

{
    const SDL_version * link_version = Mix_Linked_Version();
    if (link_version->major < 1
        || (link_version->major == 1 && link_version->minor < 2)
        || (link_version->major == 1 && link_version->minor == 2 && link_version->patch < 7))
    {
        // Check existance and try extracting it
        if (!FileExists(FileName)) if (!ExtractFile())
                // Doesn't exist - or file is corrupt
            {
                LogF("Error reading %s", FileName);
                return false;
            }
        // Load
        Music = Mix_LoadMUS(SongExtracted ? Config.AtTempPath(C4CFN_TempMusic2) : FileName);
        // Load failed
        if (!Music)
        {
            LogF("SDL_mixer: %s", SDL_GetError());
            return false;
        }
        // Play Song
        if (Mix_PlayMusic(Music, loop? -1 : 1) == -1)
        {
            LogF("SDL_mixer: %s", SDL_GetError());
            return false;
        }
    }
    else
    {
        // Load Song
        // Fixme: Try loading this from the group incrementally for less lag
        size_t filesize;
        if (!C4Group_ReadFile(FileName, &Data, &filesize))
        {
            LogF("Error reading %s", FileName);
            return false;
        }
        // Mix_FreeMusic frees the RWop
        Music = Mix_LoadMUS_RW(SDL_RWFromConstMem(Data, filesize), 1);
        if (!Music)
        {
            LogF("SDL_mixer: %s", SDL_GetError());
            return false;
        }
        if (Mix_PlayMusic(Music, loop? -1 : 1) == -1)
        {
            LogF("SDL_mixer: %s", SDL_GetError());
            return false;
        }
    }
    return true;
}

References C4Config::AtTempPath(), C4CFN_TempMusic2, C4Group_ReadFile(), Config, Data, C4MusicFile::ExtractFile(), FileExists(), C4MusicFile::FileName, LogF(), C4MusicFile::loop, Music, and C4MusicFile::SongExtracted.

Here is the call graph for this function:

RemTempFile()

bool C4MusicFile::RemTempFile ( )

protectedinherited

Definition at line 57 of file C4MusicFile.cpp.

{
    if (!SongExtracted) return true;
    // delete it
    EraseFile(Config.AtTempPath(C4CFN_TempMusic2));
    SongExtracted = false;
    return true;
}

References C4Config::AtTempPath(), C4CFN_TempMusic2, Config, EraseFile(), and C4MusicFile::SongExtracted.

Referenced by Stop().

Here is the call graph for this function:

Here is the caller graph for this function:

SetVolume()

void C4MusicFileSDL::SetVolume ( int  iLevel )

overridevirtual

Implements C4MusicFile.

Definition at line 166 of file C4MusicFile.cpp.

{
    Mix_VolumeMusic((int) ((iLevel * MIX_MAX_VOLUME) / 100));
}

Stop()

void C4MusicFileSDL::Stop ( int  fadeout_ms = 0 )

overridevirtual

Implements C4MusicFile.

Definition at line 139 of file C4MusicFile.cpp.

{
    if (fadeout_ms && Music)
    {
        // Don't really stop yet
        Mix_FadeOutMusic(fadeout_ms);
        return;
    }
    if (Music)
    {
        Mix_FreeMusic(Music);
        Music = nullptr;
    }
    RemTempFile();
    if (Data)
    {
        delete[] Data;
        Data = nullptr;
    }
}

References Data, Music, and C4MusicFile::RemTempFile().

Referenced by ~C4MusicFileSDL().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

announced

bool C4MusicFile::announced {false}

inherited

Definition at line 39 of file C4MusicFile.h.

Referenced by C4MusicFile::Announce(), and C4MusicFile::HasBeenAnnounced().

Data

char* C4MusicFileSDL::Data

protected

Definition at line 81 of file C4MusicFile.h.

Referenced by Play(), and Stop().

FileName

char C4MusicFile::FileName[_MAX_FNAME_LEN]

inherited

Definition at line 34 of file C4MusicFile.h.

Referenced by C4MusicFile::Announce(), C4MusicFile::ExtractFile(), C4MusicFile::GetDebugInfo(), C4MusicFile::Init(), Play(), C4MusicSystem::Play(), and C4MusicSystem::SetPlayList().

LastPlayed

int C4MusicFile::LastPlayed {-1}

inherited

Definition at line 36 of file C4MusicFile.h.

Referenced by C4MusicSystem::Play().

loop

bool C4MusicFile::loop {false}

inherited

Definition at line 38 of file C4MusicFile.h.

Referenced by C4MusicFile::IsLooping(), and Play().

Music

Mix_Music* C4MusicFileSDL::Music

protected

Definition at line 82 of file C4MusicFile.h.

Referenced by Play(), and Stop().

NoPlay

bool C4MusicFile::NoPlay {false}

inherited

Definition at line 37 of file C4MusicFile.h.

Referenced by C4MusicSystem::SetPlayList().

pNext

C4MusicFile* C4MusicFile::pNext {nullptr}

inherited

Definition at line 35 of file C4MusicFile.h.

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

SongExtracted

bool C4MusicFile::SongExtracted {false}

protectedinherited

Definition at line 65 of file C4MusicFile.h.

Referenced by C4MusicFile::ExtractFile(), Play(), and C4MusicFile::RemTempFile().

---

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

• C4MusicFile.h
• C4MusicFile.cpp