eMusicTrack Class Reference

#include <eMusicTrackSDLMixer.h>

Collaboration diagram for eMusicTrack:

[legend]

List of all members.

Public Member Functions
	eMusicTrack ()
	eMusicTrack (const char *filename, bool isinstalled=false)
	~eMusicTrack ()
void	SetVolume (int newVolume)
int	GetVolume ()
void	Loop ()
tString const &	GetFileName ()
bool	Play ()
void	Stop ()
void	Next ()
void	Previous ()
void	Pause ()
void	VolumeUp ()
void	VolumeDown ()
void	Mute ()
void	Update ()
void	SetDirty ()
bool	LoadSong (tSong thesong)
void	LoadPlaylist (const char *filename)
void	SetPlaylist (int i)
void	FadeOut ()
bool	IsPlaying ()
bool	HasSong ()
void	UnloadSong ()
void	MusicFinished ()
Static Public Attributes
static bool	musicIsPlaying = 0
static eMusicTrack *	currentMusic = 0
Private Member Functions
void	Init (bool isinstalled)
Mix_Music *	LoadFile (const char *filename)
void	LoadAATrack (tSong &thesong)
void	LoadVorbisTrack (tSong &thesong)
void	PlayCurrentSequence ()
Private Attributes
bool	m_IsInstalled
int	m_Volume
bool	m_Loop
bool	m_IsPlaying
int	usePlaylist
bool	m_isDirty
bool	m_HasSong
bool	m_SequenceChange
double	m_Pos
std::map< tString, Mix_Music * > ::iterator	m_SequencePos
Uint32	m_StartTime
tSong	m_CurrentSong
std::map< tString, Mix_Music * >	m_Tracklist
eSoundMixer *	m_mixer
tString	m_Filename
Mix_Music *	m_Music
Mix_MusicType	m_MusicType
tPlayList *	m_Playlist

---

Detailed Description

Definition at line 60 of file eMusicTrackSDLMixer.h.

---

Constructor & Destructor Documentation

eMusicTrack::eMusicTrack

(

)

Definition at line 40 of file eMusicTrackSDLMixer.cpp.

References currentMusic, and Init().

                         {
#ifdef HAVE_LIBSDL_MIXER
    // Do nothing constructor
    if(! currentMusic) currentMusic = this;
    Init(true);
#endif // DEDICATED
}

Here is the call graph for this function:

eMusicTrack::eMusicTrack	(	const char *	filename,
		bool	isinstalled = false
	)

Definition at line 48 of file eMusicTrackSDLMixer.cpp.

References Init(), LoadSong(), and m_CurrentSong.

                                                               {
#ifdef HAVE_LIBSDL_MIXER
    Init(isinstalled);
    // Load file
    tString musFile = tString(filename);
    m_CurrentSong = tSong(musFile);
    LoadSong( m_CurrentSong );
#endif // DEDICATED
}

Here is the call graph for this function:

eMusicTrack::~eMusicTrack

(

)

Definition at line 71 of file eMusicTrackSDLMixer.cpp.

References m_Playlist, and m_Tracklist.

                          {
#ifdef HAVE_LIBSDL_MIXER
    // Do nothing destructor
    std::map<tString, Mix_Music*>::iterator trackIter;

    for(trackIter = m_Tracklist.begin(); trackIter != m_Tracklist.end(); trackIter++) {
        Mix_FreeMusic( (*trackIter).second );
    }

    delete m_Playlist;
#endif // DEDICATED
}

---

Member Function Documentation

void eMusicTrack::SetVolume

(

int

newVolume

)

[inline]

Definition at line 66 of file eMusicTrackSDLMixer.h.

{ m_Volume = newVolume; };

int eMusicTrack::GetVolume

(

)

[inline]

Definition at line 67 of file eMusicTrackSDLMixer.h.

References m_Volume.

{ m_Volume = newVolume; };

void eMusicTrack::Loop

(

)

[inline]

Definition at line 69 of file eMusicTrackSDLMixer.h.

References m_Loop.

{ m_Loop = true; };

tString const& eMusicTrack::GetFileName

(

)

[inline]

Definition at line 71 of file eMusicTrackSDLMixer.h.

References m_Filename.

Referenced by eSoundMixer::GetCurrentSong().

{ return m_Filename; };

Here is the caller graph for this function:

bool eMusicTrack::Play

(

)

Definition at line 195 of file eMusicTrackSDLMixer.cpp.

References currentMusic, FadeOut(), m_HasSong, m_IsPlaying, m_SequencePos, m_Tracklist, musicIsPlaying, and PlayCurrentSequence().

Referenced by Next(), Previous(), and eSoundMixer::Update().

                       {
#ifdef HAVE_LIBSDL_MIXER
    //if(!m_HasSong) return false;

    // Fade out the song, if there's already one playing
    if(Mix_PlayingMusic() && !m_IsPlaying) {
        currentMusic->FadeOut();
    }

    m_SequencePos = m_Tracklist.begin();

    if(m_SequencePos == m_Tracklist.end()) {
        std::cout << "For some reason, this song has no tracks in the tracklist\n";
        musicIsPlaying = false;
        return false;
    } else {
        std::cout << "Should be playing the first sequence\n";
        m_HasSong = true;
        PlayCurrentSequence();
    }

#endif
    return musicIsPlaying;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::Stop

(

)

[inline]

Definition at line 74 of file eMusicTrackSDLMixer.h.

                {
#ifndef DEDICATED
        Mix_HaltMusic();
#endif

void eMusicTrack::Next

(

)

Definition at line 264 of file eMusicTrackSDLMixer.cpp.

References tPlayList::empty(), tPlayList::GetNextSong(), LoadSong(), m_CurrentSong, m_HasSong, m_isDirty, m_Playlist, m_Pos, and Play().

Referenced by Update(), and eSoundMixer::Update().

                       {
#ifdef HAVE_LIBSDL_MIXER
    tSong newSong;
    tString musFile;
    int numTries = 0;
    bool foundSong = false;

    if(! m_Playlist->empty() ) {
        do {
            numTries++;
            m_CurrentSong = m_Playlist->GetNextSong();
            foundSong = LoadSong( m_CurrentSong );
        } while(!foundSong && numTries < 5);
        if(foundSong) {
            m_Pos = 0.0;
            m_HasSong = true;
            Play();
            m_isDirty = false;
        }
    }
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::Previous

(

)

Definition at line 240 of file eMusicTrackSDLMixer.cpp.

References tPlayList::empty(), tPlayList::GetPreviousSong(), LoadSong(), m_CurrentSong, m_isDirty, m_Playlist, m_Pos, and Play().

                           {
#ifdef HAVE_LIBSDL_MIXER
    tSong newSong;
    tString musFile;
    // const tPath& vpath = tDirectories::Data();
    int numTries = 0;
    bool foundSong = false;

    if(! m_Playlist->empty() ) {
        do {
            numTries++;
            m_CurrentSong = m_Playlist->GetPreviousSong();
            foundSong = LoadSong( m_CurrentSong );
        } while(!foundSong && numTries < 5);
        if(foundSong) {
            m_Pos = 0.0;

            Play();
            m_isDirty = false;
        }
    }
#endif
}

Here is the call graph for this function:

void eMusicTrack::Pause

(

)

Definition at line 287 of file eMusicTrackSDLMixer.cpp.

                        {
#ifdef HAVE_LIBSDL_MIXER
    if(Mix_PausedMusic()==0) {
        Mix_PauseMusic();
    } else {
        Mix_ResumeMusic();
    }
#endif
}

void eMusicTrack::VolumeUp

(

)

Definition at line 297 of file eMusicTrackSDLMixer.cpp.

References m_Volume.

                           {
#ifdef HAVE_LIBSDL_MIXER
    m_Volume += 5;
    if(m_Volume > MIX_MAX_VOLUME) m_Volume = MIX_MAX_VOLUME;
    Mix_VolumeMusic(m_Volume);
#endif
}

void eMusicTrack::VolumeDown

(

)

Definition at line 305 of file eMusicTrackSDLMixer.cpp.

References m_Volume.

                             {
#ifdef HAVE_LIBSDL_MIXER
    m_Volume -= 5;
    if(m_Volume < 0) m_Volume = 0;
    Mix_VolumeMusic(m_Volume);
#endif
}

void eMusicTrack::Mute

(

)

void eMusicTrack::Update

(

)

Definition at line 344 of file eMusicTrackSDLMixer.cpp.

References m_HasSong, m_isDirty, m_Playlist, m_SequenceChange, Next(), and PlayCurrentSequence().

Referenced by eSoundMixer::Update().

                         {
#ifdef HAVE_LIBSDL_MIXER
    if(m_HasSong) {
        // First check to see if the sequence position has changed.  If so, start the
        // new track for it.
        if(m_SequenceChange==true) {
            PlayCurrentSequence();
            m_SequenceChange = false;
            std::cout << "Sequence change updating\n";
        }
        if(m_Playlist) {
            if(m_isDirty) {
                Next();
            }
        }
    }
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::SetDirty

(

)

Definition at line 338 of file eMusicTrackSDLMixer.cpp.

References m_isDirty.

Referenced by eSoundMixer::Update().

                           {
#ifdef HAVE_LIBSDL_MIXER
    m_isDirty = true;
#endif
}

Here is the caller graph for this function:

bool eMusicTrack::LoadSong

(

tSong

thesong

)

Definition at line 93 of file eMusicTrackSDLMixer.cpp.

References tString::GetFileMimeExtension(), LoadAATrack(), LoadFile(), LoadVorbisTrack(), tSong::location, m_Filename, m_HasSong, m_Music, m_Tracklist, and tSong::tracklist.

Referenced by eMusicTrack(), Next(), and Previous().

                                        {
#ifdef HAVE_LIBSDL_MIXER
    tString extension;
    m_Filename = thesong.location;

    if(m_Music) Mix_FreeMusic(m_Music);

    extension = thesong.location.GetFileMimeExtension();
    if(extension == ".aatrack") {
        LoadAATrack(thesong);
    } else {
        LoadVorbisTrack(thesong);
    }
    std::map<tString, tString>::iterator trackIter;

    // const tPath& vpath = tDirectories::Data();
    tString basepath("music/");
    // Now load the tracks
    for(trackIter = thesong.tracklist.begin(); trackIter != thesong.tracklist.end(); trackIter++) {
        //if(m_IsInstalled) {
        //    tString tmpFile = (*trackIter).second;
        //    basepath = tString("music/") + tmpFile;
        //    basepath = vpath.GetReadPath(basepath);
        //} else {
        basepath = (*trackIter).second;
        //}
        m_Tracklist[(*trackIter).first] = LoadFile(basepath);
    }
    m_HasSong = true;
#endif // DEDICATED
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::LoadPlaylist

(

const char *

filename

)

Definition at line 325 of file eMusicTrackSDLMixer.cpp.

References tPlayList::empty(), tPlayList::LoadPlaylist(), m_Playlist, NULL, tPlayList::Randomize(), tPlayList::SetPlaylist(), and usePlaylist.

Referenced by eSoundMixer::LoadPlaylist().

                                                   {
#ifdef HAVE_LIBSDL_MIXER
    if(m_Playlist != NULL) delete m_Playlist;

    m_Playlist = new tPlayList();
    m_Playlist->SetPlaylist(usePlaylist);
    if ( strlen(filename) > 0 )
        m_Playlist->LoadPlaylist(filename);

    if( !m_Playlist->empty()) m_Playlist->Randomize();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::SetPlaylist

(

int

i

)

[inline]

Definition at line 92 of file eMusicTrackSDLMixer.h.

References m_Playlist, tPlayList::SetPlaylist(), and usePlaylist.

Referenced by eSoundMixer::LoadPlaylist().

{ usePlaylist = i; if(m_Playlist) m_Playlist->SetPlaylist(i); };

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::FadeOut

(

)

Definition at line 313 of file eMusicTrackSDLMixer.cpp.

References m_IsPlaying, m_Pos, and m_StartTime.

Referenced by Play(), and eSoundMixer::Update().

                          {
#ifdef HAVE_LIBSDL_MIXER
    if(m_IsPlaying) {
        if(Mix_PlayingMusic()) {
            Mix_FadeOutMusic(200);
        }
    }
    m_Pos = (double) (SDL_GetTicks() - m_StartTime) / 1000.0;
    //std::cout << "Fading out music, pos: " << m_Pos << "\n";
#endif // DEDICATED
}

Here is the caller graph for this function:

bool eMusicTrack::IsPlaying

(

)

[inline]

Definition at line 95 of file eMusicTrackSDLMixer.h.

Referenced by eSoundMixer::Update().

{ return m_IsPlaying; };

Here is the caller graph for this function:

bool eMusicTrack::HasSong

(

)

[inline]

Definition at line 96 of file eMusicTrackSDLMixer.h.

References m_IsPlaying.

{ return m_IsPlaying; };

void eMusicTrack::UnloadSong

(

)

Definition at line 84 of file eMusicTrackSDLMixer.cpp.

References m_HasSong, m_Music, m_Pos, and m_StartTime.

                             {
#ifdef HAVE_LIBSDL_MIXER
    if(m_Music) Mix_FreeMusic(m_Music);
    m_Pos = 0.0;
    m_StartTime = 0;
    m_HasSong = false;
#endif
}

void eMusicTrack::MusicFinished

(

)

Definition at line 182 of file eMusicTrackSDLMixer.cpp.

References m_mixer, m_SequenceChange, m_SequencePos, m_Tracklist, and eSoundMixer::SongFinished().

Referenced by eSoundMixer::SDLMusicFinished().

                                {
#ifdef HAVE_LIBSDL_MIXER
    m_SequencePos++;

    if(m_SequencePos == m_Tracklist.end()) {
        m_mixer->SongFinished();
        return;
    }
    m_SequenceChange = true;
    std::cout << "Sequence change\n";
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::Init

(

bool

isinstalled

)

[private]

Definition at line 58 of file eMusicTrackSDLMixer.cpp.

References eSoundMixer::GetMixer(), m_HasSong, m_IsInstalled, m_Loop, m_mixer, m_Music, m_Playlist, m_SequencePos, m_Tracklist, m_Volume, NULL, and tNEW.

Referenced by eMusicTrack().

                                       {
#ifdef HAVE_LIBSDL_MIXER
    m_IsInstalled = isinstalled;
    m_Music = NULL;
    m_Playlist = tNEW(tPlayList)();
    m_Loop = false;
    m_Volume = 100;
    m_HasSong = false;
    m_mixer = eSoundMixer::GetMixer();
    m_SequencePos = m_Tracklist.begin();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

Mix_Music * eMusicTrack::LoadFile

(

const char *

filename

)

[private]

Definition at line 165 of file eMusicTrackSDLMixer.cpp.

References con, NULL, and tOutput::SetTemplateParameter().

Referenced by LoadSong().

                                                     {
    Mix_Music* theMusic = NULL;
#ifdef HAVE_LIBSDL_MIXER

    theMusic = Mix_LoadMUS( filename );
    if(!theMusic) {
        //TODO: move error Handling else where?
        tOutput error;
        error.SetTemplateParameter(1 , filename );
        error.SetTemplateParameter(2 , SDL_GetError() );
        error << "$sound_error_unknown";
        con << error;
    }
#endif // DEDICATED
    return theMusic;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::LoadAATrack

(

tSong &

thesong

)

[private]

Definition at line 126 of file eMusicTrackSDLMixer.cpp.

References tSong::author, tSong::genre, tIniFile::GetGroup(), tIniFile::GetValue(), tSong::location, m_IsInstalled, tSong::record, tSong::sequence, tSong::title, tSong::tracklist, and tSong::year.

Referenced by LoadSong().

                                            {
#ifdef HAVE_LIBSDL_MIXER
    tIniFile theFile(thesong.location);
    //theFile.Dump();

    thesong.author = theFile.GetValue("header", "author");
    thesong.year = theFile.GetValue("header", "year");
    thesong.record = theFile.GetValue("header", "record");
    thesong.title = theFile.GetValue("header", "title");
    thesong.genre = theFile.GetValue("header", "genre");

    tString isInstalledS = theFile.GetValue("header", "installed");
    if(isInstalledS == "yes") m_IsInstalled = true;
    else m_IsInstalled = false;

    std::cout << thesong.title << " by " << thesong.author << "\n";
    thesong.tracklist = theFile.GetGroup("tracks");
    thesong.sequence = theFile.GetGroup("sequence");
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eMusicTrack::LoadVorbisTrack

(

tSong &

thesong

)

[private]

Definition at line 148 of file eMusicTrackSDLMixer.cpp.

References tSong::author, tSong::genre, tSong::location, tSong::record, tSong::sequence, tSong::title, tSong::tracklist, and tSong::year.

Referenced by LoadSong().

                                                {
#ifdef HAVE_LIBSDL_MIXER
    // We set these so the same code can use tSong to play a song, but this track
    // is a single song, probably from the user's own playlist
    thesong.author = "Unknown";
    thesong.year = "Unknown";
    thesong.record = "Unknown";
    thesong.title = "Unknown";
    thesong.genre = "Unknown";

    thesong.tracklist[tString("only")] = thesong.location;
    thesong.sequence[tString("0")] = "only";
    std::cout << "Track: " << thesong.location << "\n";
    thesong.title = thesong.location;
#endif
}

Here is the caller graph for this function:

void eMusicTrack::PlayCurrentSequence

(

)

[private]

Definition at line 220 of file eMusicTrackSDLMixer.cpp.

References currentMusic, m_HasSong, m_IsPlaying, m_Volume, and musicIsPlaying.

Referenced by Play(), and Update().

                                      {
#ifdef HAVE_LIBSDL_MIXER
    int pmres;
    //if(!m_HasSong) return;
    pmres = Mix_PlayMusic((*m_SequencePos).second, 1);

    if( pmres == 0) {
        Mix_VolumeMusic(m_Volume);
        musicIsPlaying = true;
        m_IsPlaying = true;
        currentMusic = this;
        std::cout << "Playing the sequence\n";
    } else {
        std::cout << "Didn't play the sequence " << (*m_SequencePos).first << "\n";
        musicIsPlaying = false;
        m_HasSong = false;
    }
#endif // DEDICATED
}

Here is the caller graph for this function:

---

Member Data Documentation

bool eMusicTrack::musicIsPlaying = 0 [static]

Definition at line 99 of file eMusicTrackSDLMixer.h.

Referenced by Play(), and PlayCurrentSequence().

eMusicTrack * eMusicTrack::currentMusic = 0 [static]

Definition at line 102 of file eMusicTrackSDLMixer.h.

Referenced by eMusicTrack(), eSoundMixer::GetCurrentSong(), Play(), PlayCurrentSequence(), eSoundMixer::SDLMusicFinished(), and eSoundMixer::Update().

bool eMusicTrack::m_IsInstalled [private]

Definition at line 112 of file eMusicTrackSDLMixer.h.

Referenced by Init(), and LoadAATrack().

int eMusicTrack::m_Volume [private]

Definition at line 114 of file eMusicTrackSDLMixer.h.

Referenced by GetVolume(), Init(), PlayCurrentSequence(), VolumeDown(), and VolumeUp().

bool eMusicTrack::m_Loop [private]

Definition at line 115 of file eMusicTrackSDLMixer.h.

Referenced by Init(), and Loop().

bool eMusicTrack::m_IsPlaying [private]

Definition at line 117 of file eMusicTrackSDLMixer.h.

Referenced by FadeOut(), HasSong(), Play(), and PlayCurrentSequence().

int eMusicTrack::usePlaylist [private]

Definition at line 119 of file eMusicTrackSDLMixer.h.

Referenced by LoadPlaylist(), and SetPlaylist().

bool eMusicTrack::m_isDirty [private]

Definition at line 121 of file eMusicTrackSDLMixer.h.

Referenced by Next(), Previous(), SetDirty(), and Update().

bool eMusicTrack::m_HasSong [private]

Definition at line 123 of file eMusicTrackSDLMixer.h.

Referenced by Init(), LoadSong(), Next(), Play(), PlayCurrentSequence(), UnloadSong(), and Update().

bool eMusicTrack::m_SequenceChange [private]

Definition at line 125 of file eMusicTrackSDLMixer.h.

Referenced by MusicFinished(), and Update().

double eMusicTrack::m_Pos [private]

Definition at line 127 of file eMusicTrackSDLMixer.h.

Referenced by FadeOut(), Next(), Previous(), and UnloadSong().

std::map<tString, Mix_Music*>::iterator eMusicTrack::m_SequencePos [private]

Definition at line 128 of file eMusicTrackSDLMixer.h.

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

Uint32 eMusicTrack::m_StartTime [private]

Definition at line 129 of file eMusicTrackSDLMixer.h.

Referenced by FadeOut(), and UnloadSong().

tSong eMusicTrack::m_CurrentSong [private]

Definition at line 130 of file eMusicTrackSDLMixer.h.

Referenced by eMusicTrack(), Next(), and Previous().

std::map<tString, Mix_Music*> eMusicTrack::m_Tracklist [private]

Definition at line 132 of file eMusicTrackSDLMixer.h.

Referenced by Init(), LoadSong(), MusicFinished(), Play(), and ~eMusicTrack().

eSoundMixer* eMusicTrack::m_mixer [private]

Definition at line 133 of file eMusicTrackSDLMixer.h.

Referenced by Init(), and MusicFinished().

tString eMusicTrack::m_Filename [private]

Definition at line 136 of file eMusicTrackSDLMixer.h.

Referenced by GetFileName(), and LoadSong().

Mix_Music* eMusicTrack::m_Music [private]

Definition at line 137 of file eMusicTrackSDLMixer.h.

Referenced by Init(), LoadSong(), and UnloadSong().

Mix_MusicType eMusicTrack::m_MusicType [private]

Definition at line 138 of file eMusicTrackSDLMixer.h.

tPlayList* eMusicTrack::m_Playlist [private]

Definition at line 140 of file eMusicTrackSDLMixer.h.

Referenced by Init(), LoadPlaylist(), Next(), Previous(), SetPlaylist(), Update(), and ~eMusicTrack().

---

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

• src/engine/sound/sdl_mixer/eMusicTrackSDLMixer.h
• src/engine/sound/sdl_mixer/eMusicTrackSDLMixer.cpp

---