eChannel Class Reference

#include <eChannel.h>

Collaboration diagram for eChannel:

[legend]

List of all members.

Public Member Functions
	eChannel ()
void	SetVolume (int volume)
int	GetId ()
void	SetId (int newID)
void	Set3d (eCoord home, eCoord soundPos, eCoord homeDirection)
void	PlaySound (eWavData &sound)
void	LoopSound (eWavData &sound)
void	StopSound ()
void	UnplaySound ()
Uint32	StartTime ()
bool	IsContinuous ()
void	Update ()
bool	isDirty ()
bool	isBusy ()
void	SetOwner (eGameObject *owner)
void	DelayStarting ()
bool	IsDelayed ()
void	Undelay ()
void	SetHome (eGameObject *home)
eGameObject *	GetOwner ()
Static Public Attributes
static int	numChannels = 0
Private Attributes
eWavData	m_Sound
bool	m_Delayed
bool	m_StartNow
int	m_Volume
int	m_ChannelID
Uint32	m_StartTime
bool	m_isDirty
bool	m_isPlaying
eGameObject *	m_Owner
eGameObject *	m_Home
bool	m_continuous

---

Detailed Description

Definition at line 82 of file eChannel.h.

---

Constructor & Destructor Documentation

eChannel::eChannel

(

)

Definition at line 86 of file eChannelSDLMixer.cpp.

References m_ChannelID, m_continuous, m_isDirty, m_isPlaying, m_Volume, and numChannels.

                   : m_Delayed(false) {
#ifdef HAVE_LIBSDL_MIXER
    m_ChannelID = numChannels;
    numChannels++;
    m_Volume = 50;
    m_isDirty = false;
    m_isPlaying = false;
    m_continuous = false;
#endif // DEDICATED
}

---

Member Function Documentation

void eChannel::SetVolume

(

int

volume

)

int eChannel::GetId

(

)

[inline]

Definition at line 86 of file eChannel.h.

{ return m_ChannelID; };

void eChannel::SetId

(

int

newID

)

[inline]

Definition at line 87 of file eChannel.h.

References m_ChannelID.

{ return m_ChannelID; };

void eChannel::Set3d	(	eCoord	home,
		eCoord	soundPos,
		eCoord	homeDirection
	)

Definition at line 117 of file eChannelSDLMixer.cpp.

References eCoord, EPS, m_ChannelID, M_PI, REAL, and sqrt().

Referenced by Update().

                                                                       {
#ifdef HAVE_LIBSDL_MIXER
    // the sound position relative to the microphone
    eCoord soundPosRelative = (soundPos - home).Turn( homeDirection.Conj() );

    // the distance to the microphone
    REAL distance = soundPosRelative.Norm();

    // the bearing in radians (taken from the inverse of the direction to put the discontinuous jump in the right spot)
    double bearing = atan2( -soundPosRelative.x, -soundPosRelative.y );

    // We get it in radians and need to convert to degrees because SDL_mixer is lame.
    // atan2's return value is specified to be between -PI and PI,
    // so we need to linearily transform the result.
    int bearingInt = 180 + (int) (bearing * 180.0/M_PI);

    // and the distance needs to be an integer, too. The conversion
    // could use some tweaking/customization.
    const REAL microphoneSize = 3;
    int distanceInt = 255 - int( 255 * microphoneSize / ( sqrt(distance) + microphoneSize ) );
    // clamp. Distance == 0 seems to be dangerous :(
    distanceInt = distanceInt > 255 ? 255 : distanceInt;
    distanceInt = distanceInt < 1 ? 1 : distanceInt;

    // override bearing for close sounds, the value of atan2 is undefined then
    if ( distance < EPS * microphoneSize )
        bearingInt = 0;

    // Remove the old effect, if present
    Mix_SetPosition(m_ChannelID, 0, 0);
    // Add the new effect
    Mix_SetPosition(m_ChannelID, bearingInt, distanceInt );
#endif // DEDICATED
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eChannel::PlaySound

(

eWavData &

sound

)

Definition at line 97 of file eChannelSDLMixer.cpp.

References eWavData::GetVolume(), eWavData::GetWavData(), m_ChannelID, m_isPlaying, and m_StartTime.

                                        {
#ifdef HAVE_LIBSDL_MIXER
    if(m_isPlaying) {
        Mix_HaltChannel(m_ChannelID);
        //std::cerr << "Channel occupied, halting: " << m_ChannelID << "\n";
    }
    int theChannel;
    Mix_Volume(m_ChannelID, sound.GetVolume());
    theChannel = Mix_PlayChannel(m_ChannelID, sound.GetWavData(), 0);

    if(theChannel != m_ChannelID) {
        // do nothing, but there's an error
        //std::cerr << "Couldn't play a sound: " << m_ChannelID << "\n";
    } else {
        m_isPlaying = true;
        m_StartTime = SDL_GetTicks();
    }
#endif // DEDICATED
}

Here is the call graph for this function:

void eChannel::LoopSound

(

eWavData &

sound

)

Definition at line 192 of file eChannelSDLMixer.cpp.

References eWavData::GetVolume(), eWavData::GetWavData(), m_ChannelID, m_continuous, m_Delayed, m_isPlaying, and m_Sound.

Referenced by Update().

                                        {
#ifdef HAVE_LIBSDL_MIXER
    //std::cout << "Looping sound\n";
    if(m_isPlaying) {
        Mix_HaltChannel(m_ChannelID);
        //std::cerr << "Channel occupied, halting: " << m_ChannelID << "\n";
    }
    m_continuous = true;
    m_Sound = sound;

    if(m_Delayed) {
        return;
    }
    int theChannel;
    Mix_Volume(m_ChannelID, sound.GetVolume());
    theChannel = Mix_PlayChannel(m_ChannelID, m_Sound.GetWavData(), -1);

    //std::cout << "Looping sound\n";
    if(theChannel < 0) {
        // do nothing, but there's an error
        //std::cerr << "Couldn't play a sound on channel: " << m_ChannelID << "\n";
    } else {
        m_isPlaying = true;
    }
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void eChannel::StopSound

(

)

[inline]

Definition at line 92 of file eChannel.h.

Referenced by Update().

                     {
#ifndef DEDICATED
        m_isDirty = true; m_isPlaying = false; Mix_HaltChannel(m_ChannelID);
#endif

Here is the caller graph for this function:

void eChannel::UnplaySound

(

)

Definition at line 179 of file eChannelSDLMixer.cpp.

References m_isDirty, and m_isPlaying.

                           {
#ifdef HAVE_LIBSDL_MIXER
    m_isDirty = true;
    m_isPlaying = false;
#endif // DEDICATED
}

Uint32 eChannel::StartTime

(

)

[inline]

Definition at line 102 of file eChannel.h.

{ return m_StartTime; };

bool eChannel::IsContinuous

(

)

[inline]

Definition at line 103 of file eChannel.h.

References m_StartTime.

{ return m_StartTime; };

void eChannel::Update

(

)

Definition at line 152 of file eChannelSDLMixer.cpp.

References eGameObject::Direction(), LoopSound(), m_ChannelID, m_continuous, m_Delayed, m_Home, m_isDirty, m_isPlaying, m_Owner, m_Sound, m_StartNow, eGameObject::Position(), Set3d(), and StopSound().

                      {
#ifdef HAVE_LIBSDL_MIXER
    if(m_isDirty && !m_isPlaying) {
        Mix_UnregisterAllEffects(m_ChannelID);
        m_isDirty = false;
    }

    if(m_continuous) {
        if(m_Delayed) {
            if(m_StartNow) {
                m_StartNow = false;
                m_Delayed = false;
                LoopSound(m_Sound);
                Set3d(m_Home->Position(), m_Owner->Position(), m_Home->Direction());
                std::cout << "Starting delayed effect\n";
            }
        } else {
            if(!m_Home || !m_Owner) {
                StopSound();
                return;
            }
            Set3d(m_Home->Position(), m_Owner->Position(), m_Home->Direction());
        }
    }
#endif // DEDICATED
}

Here is the call graph for this function:

bool eChannel::isDirty

(

)

[inline]

Definition at line 109 of file eChannel.h.

References m_isDirty.

{ return m_isDirty; };

bool eChannel::isBusy

(

)

[inline]

Definition at line 112 of file eChannel.h.

References m_isPlaying.

{ return m_isPlaying; };

void eChannel::SetOwner

(

eGameObject *

owner

)

Definition at line 186 of file eChannelSDLMixer.cpp.

References m_Owner.

                                          {
#ifdef HAVE_LIBSDL_MIXER
    m_Owner = owner;
#endif
}

void eChannel::DelayStarting

(

)

[inline]

Definition at line 115 of file eChannel.h.

{ m_Delayed = true; m_StartNow = false; };

bool eChannel::IsDelayed

(

)

[inline]

Definition at line 116 of file eChannel.h.

References m_Delayed, and m_StartNow.

{ m_Delayed = true; m_StartNow = false; };

void eChannel::Undelay

(

)

[inline]

Definition at line 117 of file eChannel.h.

References m_Delayed.

{ return m_Delayed; };

void eChannel::SetHome

(

eGameObject *

home

)

[inline]

Definition at line 118 of file eChannel.h.

References m_StartNow.

{ m_StartNow = true; };

eGameObject* eChannel::GetOwner

(

)

[inline]

Definition at line 119 of file eChannel.h.

{ m_Home = home; };

---

Member Data Documentation

int eChannel::numChannels = 0 [static]

Definition at line 119 of file eChannel.h.

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

eWavData eChannel::m_Sound [private]

Definition at line 127 of file eChannel.h.

Referenced by LoopSound(), and Update().

bool eChannel::m_Delayed [private]

Definition at line 128 of file eChannel.h.

Referenced by IsDelayed(), LoopSound(), Undelay(), and Update().

bool eChannel::m_StartNow [private]

Definition at line 129 of file eChannel.h.

Referenced by IsDelayed(), SetHome(), and Update().

int eChannel::m_Volume [private]

Definition at line 130 of file eChannel.h.

Referenced by eChannel().

int eChannel::m_ChannelID [private]

Definition at line 131 of file eChannel.h.

Referenced by eChannel(), LoopSound(), PlaySound(), Set3d(), SetId(), and Update().

Uint32 eChannel::m_StartTime [private]

Definition at line 132 of file eChannel.h.

Referenced by IsContinuous(), and PlaySound().

bool eChannel::m_isDirty [private]

Definition at line 133 of file eChannel.h.

Referenced by eChannel(), isDirty(), UnplaySound(), and Update().

bool eChannel::m_isPlaying [private]

Definition at line 134 of file eChannel.h.

Referenced by eChannel(), isBusy(), LoopSound(), PlaySound(), UnplaySound(), and Update().

eGameObject* eChannel::m_Owner [private]

Definition at line 135 of file eChannel.h.

Referenced by SetOwner(), and Update().

eGameObject* eChannel::m_Home [private]

Definition at line 136 of file eChannel.h.

Referenced by Update().

bool eChannel::m_continuous [private]

Definition at line 137 of file eChannel.h.

Referenced by eChannel(), LoopSound(), and Update().

---

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

• src/engine/sound/base/eChannel.h
• src/engine/sound/sdl_mixer/eChannelSDLMixer.cpp

---