eSoundMixer Class Reference

#include <eSoundMixer.h>

Collaboration diagram for eSoundMixer:

[legend]

List of all members.

Public Member Functions
	~eSoundMixer ()
void	Init ()
void	PushButton (int soundEffect)
void	PushButton (int soundEffect, eCoord location)
void	SetMicrophoneOwner (eGameObject *newOwner)
void	PlayContinuous (int soundEffect, eGameObject *owner)
void	RemoveContinuous (int soundEffect, eGameObject *owner)
void	LoadPlaylist ()
tString	GetCurrentSong ()
void	Update ()
Static Public Member Functions
static eSoundMixer *	GetMixer ()
static void	ShutDown ()
static void	SetMode (MusicMode newMode)
static void	SDLMusicFinished ()
static void	SongFinished ()
static bool	Music_play (REAL x)
static bool	Music_next_song (REAL x)
static bool	Music_previous_song (REAL x)
static bool	Music_stop (REAL x)
static bool	Music_pause (REAL x)
static bool	Music_volume_up (REAL x)
static bool	Music_volume_down (REAL x)
static void	ChannelFinished (int channel)
Private Member Functions
void	__channelFinished (int channel)
int	FirstAvailableChannel ()
	eSoundMixer ()
Private Attributes
bool	sound_is_there
SDL_AudioSpec	audio
tJUST_CONTROLLED_PTR< eGameObject >	m_Owner
bool	m_PlayMusic
bool	m_active
tSong	m_CurrentSong
tPlayList *	m_Playlist
std::deque< eWavData >	m_SoundEffects
std::deque< eChannel >	m_Channels
int	m_numChannels
Static Private Attributes
static eSoundMixer *	_instance = 0
static int	m_Mode = 0
static bool	m_isDirty = true
static eMusicTrack *	m_TitleTrack = 0
static eMusicTrack *	m_GuiTrack = 0
static eMusicTrack *	m_GameTrack = 0
static bool	m_musicIsPlaying = false

---

Detailed Description

Definition at line 99 of file eSoundMixer.h.

---

Constructor & Destructor Documentation

eSoundMixer::~eSoundMixer

(

)

Definition at line 353 of file eSoundMixer.cpp.

                          {
    // do nothing destructor
}

eSoundMixer::eSoundMixer

(

)

[private]

Definition at line 147 of file eSoundMixer.cpp.

References m_Owner, m_Playlist, m_PlayMusic, musicActive, and NULL.

Referenced by GetMixer().

{
#ifdef HAVE_LIBSDL_MIXER
    m_Owner = NULL;
    m_Playlist = NULL;

    if(musicActive == 1) {
        m_PlayMusic = true;
    } else {
        m_PlayMusic = false;
    }
#endif // DEDICATED
}

Here is the caller graph for this function:

---

Member Function Documentation

eSoundMixer * eSoundMixer::GetMixer

(

)

[static]

Definition at line 561 of file eSoundMixer.cpp.

References _instance, eSoundMixer(), and Init().

Referenced by cCockpit::cb_CurrentSong(), gCycle::DoTurn(), gExplosion::gExplosion(), gZone::gZone(), gGame::Init(), eMusicTrack::Init(), gCycle::MyInitAfterCreation(), gCycle::SyncEnemy(), gCamera::Timestep(), welcome(), zZone::zZone(), and gCycle::~gCycle().

                                   {
#ifdef HAVE_LIBSDL_MIXER
    if(_instance == 0) {
        _instance = new eSoundMixer();
        _instance->Init();
    }

#endif // DEDICATED
    return _instance;

Here is the call graph for this function:

Here is the caller graph for this function:

void eSoundMixer::ShutDown

(

)

[static]

Definition at line 541 of file eSoundMixer.cpp.

References _instance, m_active, m_GameTrack, m_GuiTrack, m_TitleTrack, NULL, and SetMicrophoneOwner().

Referenced by main().

                           {
#ifdef HAVE_LIBSDL_MIXER
    if ( _instance )
        _instance->SetMicrophoneOwner( NULL );

    if ( _instance && _instance->m_active )
    {
        Mix_CloseAudio();
        SDL_QuitSubSystem( SDL_INIT_AUDIO );
    }

    delete _instance;
    delete m_TitleTrack;
    delete m_GuiTrack;
    if(m_GameTrack) delete m_GameTrack;


#endif // DEDICATED

Here is the call graph for this function:

Here is the caller graph for this function:

void eSoundMixer::Init

(

)

Definition at line 233 of file eSoundMixer.cpp.

References a, ANNOUNCER_1, ANNOUNCER_2, ANNOUNCER_3, ANNOUNCER_GO, b, buffersize, c, ChannelFinished(), CYCLE_EXPLOSION, CYCLE_GRIND_WALL, CYCLE_MOTOR, CYCLE_TURN, tDirectories::Data(), tPath::GetReadPath(), guiTrack, LoadPlaylist(), m_active, m_Channels, m_GameTrack, m_GuiTrack, m_musicIsPlaying, m_numChannels, m_SoundEffects, m_TitleTrack, musicVolume, numSoundcardChannels, SDLMusicFinished(), SOUND_HIGH, SOUND_LOW, SOUND_MED, SOUND_OFF, sound_quality, titleTrack, and ZONE_SPAWN.

Referenced by GetMixer().

                       {
#ifdef HAVE_LIBSDL_MIXER
    bool initbase = false;

    m_active = false;

    const tPath& vpath = tDirectories::Data();

    // We haven't started playing any music yet
    m_musicIsPlaying = false;

    tString musFile;

    musFile = vpath.GetReadPath( titleTrack );
    std::cout << titleTrack << "\n";
    m_TitleTrack = new eMusicTrack(musFile, true);
    musFile = vpath.GetReadPath( guiTrack );
    std::cout << guiTrack << "\n";
    m_GuiTrack = new eMusicTrack(musFile, true);

    //m_GuiTrack->Loop();

    // Don't load a file for this, we don't know what we're playing until it's time
    // to play.
    m_GameTrack = new eMusicTrack();

    LoadPlaylist();

    int frequency;

    switch (sound_quality)
    {
    case SOUND_LOW:
        frequency=11025; break;
    case SOUND_MED:
        frequency=22050; break;
    case SOUND_HIGH:
        frequency=44100; break;
    case SOUND_OFF:
        return; break;
    default:
        frequency=22050;
    }

    if(!SDL_WasInit( SDL_INIT_AUDIO )) {
        int rc;
        rc = se_Wrap_SDL_InitSubSystem();
        if ( rc < 0 ) {
            //std::cerr << "Couldn't initialize audio, disabling.  I'm very sorry about that.\n";
            initbase = false;
            // todo: disable audio if we can't initialize it
        } else {
            initbase = true;
        }
    } else {
        initbase = true;
    }

    if( !initbase ) {
        return;
    }

    int rc;

    // guesstimate the desired number of samples to calculate in advance
    int samples = static_cast< int >( buffersize * 512 );

    rc = Mix_OpenAudio( frequency, AUDIO_S16LSB,
                        numSoundcardChannels, samples );

    if(rc==0) {
        // don't know what to do here
        int a,c;
        Uint16 b;
        Mix_QuerySpec(&a,&b,&c);
        //std::cout << "SDL_Mixer initialized with " << c << " channels.\n";
    } else {
        //std::cout << "Couldn't initialize SDL_Mixer, disabling sound.  I'm very sorry about that, I'll try to do better next time.\n";
        return;
    }

    // Register music finished callback
    Mix_VolumeMusic( musicVolume );
    Mix_HookMusicFinished( &eSoundMixer::SDLMusicFinished );

    // Now we're done with music and initializing sdl_mixer, we'll setup the sound
    // effect stuff
    //musFile = vpath.GetReadPath( titleTrack );

    m_SoundEffects.resize(15);
    m_SoundEffects[CYCLE_TURN].LoadWavFile(vpath.GetReadPath("sound/cycle_turn.ogg") );
    m_SoundEffects[CYCLE_TURN].SetVolume(60);
    m_SoundEffects[CYCLE_EXPLOSION].LoadWavFile(vpath.GetReadPath( "sound/expl.ogg" ));
    m_SoundEffects[ANNOUNCER_1].LoadWavFile(vpath.GetReadPath("sound/1voicemale.ogg") );
    m_SoundEffects[ANNOUNCER_2].LoadWavFile(vpath.GetReadPath("sound/2voicemale.ogg") );
    m_SoundEffects[ANNOUNCER_3].LoadWavFile(vpath.GetReadPath("sound/3voicemale.ogg") );
    m_SoundEffects[ANNOUNCER_GO].LoadWavFile(vpath.GetReadPath("sound/announcerGO.ogg"));
    //m_SoundEffects[NEW_MATCH].LoadWavFile(vpath.GetReadPath("sound/none.ogg") );
    //m_SoundEffects[NEW_ROUND].LoadWavFile(vpath.GetReadPath("sound/none.ogg") );
    //m_SoundEffects[ROUND_WINNER].LoadWavFile(vpath.GetReadPath("sound/none.ogg") );
    //m_SoundEffects[MATCH_WINNER].LoadWavFile(vpath.GetReadPath("sound/none.ogg") );
    m_SoundEffects[ZONE_SPAWN].LoadWavFile(vpath.GetReadPath("sound/zone_spawn.ogg") );
    m_SoundEffects[CYCLE_MOTOR].LoadWavFile(vpath.GetReadPath("sound/cyclrun.ogg") );
    m_SoundEffects[CYCLE_GRIND_WALL].LoadWavFile(vpath.GetReadPath("sound/grind.ogg") );

    Mix_Volume(-1, 50);
    Mix_VolumeMusic(100);

    m_numChannels = Mix_AllocateChannels(40);
    m_Channels.resize( m_numChannels );
    for(int i=0; i < m_numChannels; i++) {
        m_Channels[i].SetId(i);
    }
    Mix_ChannelFinished( &eSoundMixer::ChannelFinished );

    // only now, everything is all right
    m_active = true;
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eSoundMixer::SetMode

(

MusicMode

newMode

)

[static]

Definition at line 374 of file eSoundMixer.cpp.

References m_isDirty, and m_Mode.

Referenced by SongFinished(), and welcome().

                                           {
#ifdef HAVE_LIBSDL_MIXER
    m_Mode = newMode;
    m_isDirty = true;
#endif // DEDICATED
}

Here is the caller graph for this function:

void eSoundMixer::PushButton

(

int

soundEffect

)

Definition at line 411 of file eSoundMixer.cpp.

References FirstAvailableChannel(), m_active, m_Channels, and m_SoundEffects.

Referenced by gGame::Analysis(), gCycle::DoTurn(), gGame::GameLoop(), gExplosion::gExplosion(), gZone::gZone(), gCycle::SyncEnemy(), and zZone::zZone().

                                              {
#ifdef HAVE_LIBSDL_MIXER
    if (!m_active) return;

    int theChannel = FirstAvailableChannel();
    if( theChannel < 0) return;
    m_Channels[ theChannel ].PlaySound(m_SoundEffects[soundEffect]);
#endif // DEDICATED
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eSoundMixer::PushButton	(	int	soundEffect,
		eCoord	location
	)

Definition at line 421 of file eSoundMixer.cpp.

References FirstAvailableChannel(), m_active, m_Channels, m_Owner, and m_SoundEffects.

                                                               {
#ifdef HAVE_LIBSDL_MIXER
    if (!m_active) return;

    // If we don't have an owner yet, just call regular PushButton
    if(!m_Owner) return;

    int theChannel = FirstAvailableChannel();

    if( theChannel < 0) return;
    m_Channels[theChannel].Set3d(m_Owner->Position(), location, m_Owner->Direction());
    m_Channels[theChannel].PlaySound(m_SoundEffects[soundEffect]);
#endif // DEDICATED
}

Here is the call graph for this function:

void eSoundMixer::SetMicrophoneOwner

(

eGameObject *

newOwner

)

Definition at line 161 of file eSoundMixer.cpp.

References m_Owner.

Referenced by ShutDown(), and gCamera::Timestep().

                                                          {
#ifdef HAVE_LIBSDL_MIXER
    //std::cout << "Setting new microphone owner\n";
    m_Owner = newOwner;
#endif // DEDICATED
}

Here is the caller graph for this function:

void eSoundMixer::PlayContinuous	(	int	soundEffect,
		eGameObject *	owner
	)

Definition at line 436 of file eSoundMixer.cpp.

References FirstAvailableChannel(), m_active, m_Channels, m_Owner, m_SoundEffects, and SoundEffectString.

Referenced by gCycle::MyInitAfterCreation().

                                                                    {
#ifdef HAVE_LIBSDL_MIXER
    std::cout << "Playcontinuous: " << SoundEffectString[soundEffect] << "\n";
    if (!m_active) return;
    return;

    int theChannel = FirstAvailableChannel();
    if( theChannel < 0 || m_Channels[theChannel].isBusy()) {
        std::cout << "Can't loop, sorry.\n";
        return;
    }

    m_Channels[theChannel].SetOwner(owner);
    // If we don't have an owner yet, we need to delay starting
    if(!m_Owner) m_Channels[theChannel].DelayStarting();
    m_Channels[theChannel].SetHome(m_Owner);
    m_Channels[theChannel].LoopSound(m_SoundEffects[soundEffect]);
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eSoundMixer::RemoveContinuous	(	int	soundEffect,
		eGameObject *	owner
	)

Definition at line 456 of file eSoundMixer.cpp.

References m_Channels.

Referenced by gCycle::~gCycle().

                                                                      {
#ifdef HAVE_LIBSDL_MIXER
    for(std::deque<eChannel>::iterator i = m_Channels.begin(); i != m_Channels.end(); ++i) {
        if ((*i).GetOwner() == owner) {
            (*i).StopSound();
            std::cout << "removed continuous sound\n";
        }
    }
#endif
}

Here is the caller graph for this function:

void eSoundMixer::SDLMusicFinished

(

)

[static]

Definition at line 404 of file eSoundMixer.cpp.

References eMusicTrack::currentMusic, m_TitleTrack, and eMusicTrack::MusicFinished().

Referenced by Init().

                                   {
#ifdef HAVE_LIBSDL_MIXER
    // We're guaranteed to have this, so we'll just use it
    m_TitleTrack->currentMusic->MusicFinished();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eSoundMixer::SongFinished

(

)

[static]

Definition at line 381 of file eSoundMixer.cpp.

References GRID_TRACK, GUI_TRACK, m_isDirty, m_Mode, m_musicIsPlaying, SetMode(), and TITLE_TRACK.

Referenced by eMusicTrack::MusicFinished().

                               {
#ifdef HAVE_LIBSDL_MIXER
    // Music stopped
    m_musicIsPlaying = false;

    switch(m_Mode) {
    case TITLE_TRACK:
        // When the title track stops, we switch to the gui track
        SetMode(GUI_TRACK);
        break;
    case GUI_TRACK:
        m_isDirty = true;
        break;
    case GRID_TRACK:
        m_isDirty = true;
        break;
    default:
        break;
    }
#endif // DEDICATED

}

Here is the call graph for this function:

Here is the caller graph for this function:

static bool eSoundMixer::Music_play

(

REAL

x

)

[static]

static bool eSoundMixer::Music_next_song

(

REAL

x

)

[static]

static bool eSoundMixer::Music_previous_song

(

REAL

x

)

[static]

static bool eSoundMixer::Music_stop

(

REAL

x

)

[static]

static bool eSoundMixer::Music_pause

(

REAL

x

)

[static]

static bool eSoundMixer::Music_volume_up

(

REAL

x

)

[static]

static bool eSoundMixer::Music_volume_down

(

REAL

x

)

[static]

void eSoundMixer::LoadPlaylist

(

)

Definition at line 357 of file eSoundMixer.cpp.

References customPlaylist, tDirectories::Data(), tPath::GetReadPath(), eMusicTrack::LoadPlaylist(), m_GameTrack, playListFile, eMusicTrack::SetPlaylist(), and usePlaylist.

Referenced by Init().

                               {
#ifdef HAVE_LIBSDL_MIXER
    if(!m_GameTrack) return;

    if(usePlaylist == 1) {
        m_GameTrack->SetPlaylist(usePlaylist);
        m_GameTrack->LoadPlaylist(customPlaylist);
    } else {
        const tPath& vpath = tDirectories::Data();
        m_GameTrack->SetPlaylist(usePlaylist);
        m_GameTrack->LoadPlaylist(vpath.GetReadPath(playListFile) );
    }
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

tString eSoundMixer::GetCurrentSong

(

)

Definition at line 524 of file eSoundMixer.cpp.

References eMusicTrack::currentMusic, eMusicTrack::GetFileName(), m_GameTrack, NULL, pos, and tString::SubStr().

                                    {
    if(m_GameTrack != NULL)
        if(m_GameTrack->currentMusic != NULL) {
            tString const &str = m_GameTrack->currentMusic->GetFileName();
#ifndef WIN32
            size_t pos = str.find_last_of('/');
#else
            size_t pos = str.find_last_of('\\');
#endif
            if(pos == tString::npos) return str;
            if(pos == str.size()) return tString();
            return str.SubStr(pos + 1);
        }
    return tString(" ");

Here is the call graph for this function:

void eSoundMixer::ChannelFinished

(

int

channel

)

[static]

Definition at line 174 of file eSoundMixer.cpp.

References __channelFinished(), and _instance.

Referenced by Init().

                                             {
#ifdef HAVE_LIBSDL_MIXER
    _instance->__channelFinished(channel);
#endif // DEDICATED
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eSoundMixer::__channelFinished

(

int

channel

)

[private]

Definition at line 168 of file eSoundMixer.cpp.

References m_Channels.

Referenced by ChannelFinished().

                                               {
#ifdef HAVE_LIBSDL_MIXER
    m_Channels[channel].UnplaySound();
#endif // DEDICATED
}

Here is the caller graph for this function:

void eSoundMixer::Update

(

)

Definition at line 467 of file eSoundMixer.cpp.

References eMusicTrack::currentMusic, eMusicTrack::FadeOut(), GRID_TRACK, GUI_TRACK, eMusicTrack::IsPlaying(), m_active, m_Channels, m_GameTrack, m_GuiTrack, m_isDirty, m_Mode, m_musicIsPlaying, m_Owner, m_TitleTrack, eMusicTrack::Next(), eChannel::numChannels, eMusicTrack::Play(), eMusicTrack::SetDirty(), TITLE_TRACK, and eMusicTrack::Update().

Referenced by welcome().

                         {
#ifdef HAVE_LIBSDL_MIXER
    if (!m_active) return;
    // Stubbed my french fry

    // First we'll update all the channels
    for(int i=0; i<eChannel::numChannels; i++) {
        if( m_Channels[i].IsDelayed() ) {
            if( m_Owner ) {
                m_Channels[i].SetHome(m_Owner);
                m_Channels[i].Undelay();
            }
        }
        m_Channels[i].Update();
    }

    // We only act on music if the mode has changed, indicated by m_isDirty
    if (m_isDirty) {
        // Also, we only update if the music has stopped for some reason.
        if(!m_musicIsPlaying) {

            switch(m_Mode) {
            case TITLE_TRACK:
                m_TitleTrack->Play();
                m_Mode = TITLE_TRACK;
                m_isDirty = false;
                break;
            case GUI_TRACK:
                m_GuiTrack->Play();
                m_isDirty = false;
                break;
            case GRID_TRACK:
                if(m_GuiTrack->IsPlaying()) {
                    m_GuiTrack->FadeOut();
                    m_GameTrack->SetDirty();
                    m_GameTrack->Update();
                } else if(m_TitleTrack->IsPlaying()) {
                    m_TitleTrack->FadeOut();
                    m_GameTrack->SetDirty();
                    m_GameTrack->Update();
                } else {
                    m_GameTrack->Next();
                    m_GameTrack->Play();
                }
                m_isDirty = false;
                break;
            default:
                break;
            }
        }
    }
    // Go ahead and update the music track now.
    if ( m_GuiTrack && m_GuiTrack->currentMusic )
        m_GuiTrack->currentMusic->Update();
#endif // DEDICATED
}

Here is the call graph for this function:

Here is the caller graph for this function:

int eSoundMixer::FirstAvailableChannel

(

)

[private]

Definition at line 180 of file eSoundMixer.cpp.

References m_Channels, m_numChannels, and tASSERT.

Referenced by PlayContinuous(), and PushButton().

                                       {
#ifdef HAVE_LIBSDL_MIXER
    Uint32 oldesttime=0;
    int oldestchannel=-1;

    for( int i=0; i < m_numChannels; i++) {
        if( !m_Channels[i].isBusy() ) return i;
        else {
            if( m_Channels[i].StartTime() < oldesttime && !m_Channels[i].IsContinuous() ) {
                oldesttime = m_Channels[i].StartTime();
                oldestchannel = i;
            }
        }
    }
    //std::cout << "Couldn't get an available channel!\n";

    return oldestchannel;
    // TODO: error handling
    tASSERT( 0 );
#endif // DEDICATED
    return -1;
}

Here is the caller graph for this function:

---

Member Data Documentation

eSoundMixer * eSoundMixer::_instance = 0 [static, private]

Definition at line 156 of file eSoundMixer.h.

Referenced by ChannelFinished(), GetMixer(), and ShutDown().

bool eSoundMixer::sound_is_there [private]

Definition at line 157 of file eSoundMixer.h.

SDL_AudioSpec eSoundMixer::audio [private]

Definition at line 158 of file eSoundMixer.h.

int eSoundMixer::m_Mode = 0 [static, private]

Definition at line 160 of file eSoundMixer.h.

Referenced by SetMode(), SongFinished(), and Update().

tJUST_CONTROLLED_PTR< eGameObject > eSoundMixer::m_Owner [private]

Definition at line 161 of file eSoundMixer.h.

Referenced by eSoundMixer(), PlayContinuous(), PushButton(), SetMicrophoneOwner(), and Update().

bool eSoundMixer::m_isDirty = true [static, private]

Definition at line 165 of file eSoundMixer.h.

Referenced by SetMode(), SongFinished(), and Update().

bool eSoundMixer::m_PlayMusic [private]

Definition at line 167 of file eSoundMixer.h.

Referenced by eSoundMixer().

bool eSoundMixer::m_active [private]

Definition at line 169 of file eSoundMixer.h.

Referenced by Init(), PlayContinuous(), PushButton(), ShutDown(), and Update().

tSong eSoundMixer::m_CurrentSong [private]

Definition at line 171 of file eSoundMixer.h.

tPlayList* eSoundMixer::m_Playlist [private]

Definition at line 172 of file eSoundMixer.h.

Referenced by eSoundMixer().

std::deque<eWavData> eSoundMixer::m_SoundEffects [private]

Definition at line 174 of file eSoundMixer.h.

Referenced by Init(), PlayContinuous(), and PushButton().

std::deque<eChannel> eSoundMixer::m_Channels [private]

Definition at line 175 of file eSoundMixer.h.

Referenced by __channelFinished(), FirstAvailableChannel(), Init(), PlayContinuous(), PushButton(), RemoveContinuous(), and Update().

int eSoundMixer::m_numChannels [private]

Definition at line 176 of file eSoundMixer.h.

Referenced by FirstAvailableChannel(), and Init().

eMusicTrack * eSoundMixer::m_TitleTrack = 0 [static, private]

Definition at line 178 of file eSoundMixer.h.

Referenced by Init(), SDLMusicFinished(), ShutDown(), and Update().

eMusicTrack * eSoundMixer::m_GuiTrack = 0 [static, private]

Definition at line 179 of file eSoundMixer.h.

Referenced by Init(), ShutDown(), and Update().

eMusicTrack * eSoundMixer::m_GameTrack = 0 [static, private]

Definition at line 180 of file eSoundMixer.h.

Referenced by GetCurrentSong(), Init(), LoadPlaylist(), ShutDown(), and Update().

bool eSoundMixer::m_musicIsPlaying = false [static, private]

Definition at line 184 of file eSoundMixer.h.

Referenced by Init(), SongFinished(), and Update().

---

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

• src/engine/eSoundMixer.h
• src/engine/eSoundMixer.cpp

---