Sound.cpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//

// Headers
#include <SFML/Audio/Sound.hpp>
#include <SFML/Audio/SoundBuffer.hpp>
#include <SFML/Audio/OpenAL.hpp>
 
 
namespace sf
{
Sound::Sound()
{
    ALCheck(alGenSources(1, &mySource));
    ALCheck(alSourcei(mySource, AL_BUFFER, 0));
}
 

Sound::Sound(const SoundBuffer& Buffer, bool Loop, float Pitch, float Volume, const Vector3f& Position) :
myBuffer(NULL)
{
    ALCheck(alGenSources(1, &mySource));
 
    SetBuffer(Buffer);
    SetLoop(Loop);
    SetPitch(Pitch);
    SetVolume(Volume);
    SetPosition(Position);
}
 

Sound::Sound(const Sound& Copy) :
AudioResource(Copy),
myBuffer(NULL)
{
    ALCheck(alGenSources(1, &mySource));
 
    if (Copy.myBuffer)
        SetBuffer(*Copy.myBuffer);
    SetLoop(Copy.GetLoop());
    SetPitch(Copy.GetPitch());
    SetVolume(Copy.GetVolume());
    SetPosition(Copy.GetPosition());
    SetRelativeToListener(Copy.IsRelativeToListener());
    SetMinDistance(Copy.GetMinDistance());
    SetAttenuation(Copy.GetAttenuation());
}
 

Sound::~Sound()
{
    if (mySource)
    {
        if (myBuffer)
        {
            Stop();
            ALCheck(alSourcei(mySource, AL_BUFFER, 0));
            myBuffer->DetachSound(this);
        }
        ALCheck(alDeleteSources(1, &mySource));
    }
}
 

/// Play the sound
////////////////////////////////////////////////////////////
void Sound::Play()
{
    ALCheck(alSourcePlay(mySource));
}
 

void Sound::Pause()
{
    ALCheck(alSourcePause(mySource));
}
 

void Sound::Stop()
{
    ALCheck(alSourceStop(mySource));
}
 

void Sound::SetBuffer(const SoundBuffer& Buffer)
{
    // First detach from the previous buffer
    if (myBuffer)
    {
        Stop();
        myBuffer->DetachSound(this);
    }
 
    // Assign and use the new buffer
    myBuffer = &Buffer;
    myBuffer->AttachSound(this);
    ALCheck(alSourcei(mySource, AL_BUFFER, myBuffer->myBuffer));
}
 

void Sound::SetLoop(bool Loop)
{
    ALCheck(alSourcei(mySource, AL_LOOPING, Loop));
}
 

void Sound::SetPitch(float Pitch)
{
    ALCheck(alSourcef(mySource, AL_PITCH, Pitch));
}
 

void Sound::SetVolume(float Volume)
{
    ALCheck(alSourcef(mySource, AL_GAIN, Volume * 0.01f));
}

void Sound::SetPosition(float X, float Y, float Z)
{
    ALCheck(alSource3f(mySource, AL_POSITION, X, Y, Z));
}
 

void Sound::SetPosition(const Vector3f& Position)
{
    SetPosition(Position.x, Position.y, Position.z);
}
 

void Sound::SetRelativeToListener(bool Relative)
{
    ALCheck(alSourcei(mySource, AL_SOURCE_RELATIVE, Relative));
}
 

void Sound::SetMinDistance(float MinDistance)
{
    ALCheck(alSourcef(mySource, AL_REFERENCE_DISTANCE, MinDistance));
}
 

void Sound::SetAttenuation(float Attenuation)
{
    ALCheck(alSourcef(mySource, AL_ROLLOFF_FACTOR, Attenuation));
}
 

void Sound::SetPlayingOffset(float TimeOffset)
{
    ALCheck(alSourcef(mySource, AL_SEC_OFFSET, TimeOffset));
}
 

const SoundBuffer* Sound::GetBuffer() const
{
    return myBuffer;
}
 

bool Sound::GetLoop() const
{
    ALint Loop;
    ALCheck(alGetSourcei(mySource, AL_LOOPING, &Loop));
 
    return Loop != 0;
}
 

////////////////////////////////////////////////////////////
/// Get the pitch
////////////////////////////////////////////////////////////
float Sound::GetPitch() const
{
    ALfloat Pitch;
    ALCheck(alGetSourcef(mySource, AL_PITCH, &Pitch));
 
    return Pitch;
}
 

float Sound::GetVolume() const
{
    ALfloat Gain;
    ALCheck(alGetSourcef(mySource, AL_GAIN, &Gain));
 
    return Gain * 100.f;
}
 

Vector3f Sound::GetPosition() const
{
    Vector3f Position;
    ALCheck(alGetSource3f(mySource, AL_POSITION, &Position.x, &Position.y, &Position.z));
 
    return Position;
}
 

bool Sound::IsRelativeToListener() const
{
    ALint Relative;
    ALCheck(alGetSourcei(mySource, AL_SOURCE_RELATIVE, &Relative));
 
    return Relative != 0;
}
 

float Sound::GetMinDistance() const
{
    ALfloat MinDistance;
    ALCheck(alGetSourcef(mySource, AL_REFERENCE_DISTANCE, &MinDistance));
 
    return MinDistance;
}
 

float Sound::GetAttenuation() const
{
    ALfloat Attenuation;
    ALCheck(alGetSourcef(mySource, AL_ROLLOFF_FACTOR, &Attenuation));
 
    return Attenuation;
}
 

float Sound::GetPlayingOffset() const
{
    ALfloat Seconds = 0.f;
    ALCheck(alGetSourcef(mySource, AL_SEC_OFFSET, &Seconds));
 
    return Seconds;
}
 

Sound::Status Sound::GetStatus() const
{
    ALint State;
    ALCheck(alGetSourcei(mySource, AL_SOURCE_STATE, &State));
 
    switch (State)
    {
        case AL_INITIAL :
        case AL_STOPPED : return Stopped;
        case AL_PAUSED :  return Paused;
        case AL_PLAYING : return Playing;
    }
 
    return Stopped;
}
 

Sound& Sound::operator =(const Sound& Other)
{
    // Here we don't use the copy-and-swap idiom, because it would mess up
    // the list of sound instances contained in the buffers
 
    // Detach the sound instance from the previous buffer (if any)
    if (myBuffer)
    {
        Stop();
        myBuffer->DetachSound(this);
        myBuffer = NULL;
    }
 
    // Copy the sound attributes
    if (Other.myBuffer)
        SetBuffer(*Other.myBuffer);
    SetLoop(Other.GetLoop());
    SetPitch(Other.GetPitch());
    SetVolume(Other.GetVolume());
    SetPosition(Other.GetPosition());
    SetRelativeToListener(Other.IsRelativeToListener());
    SetMinDistance(Other.GetMinDistance());
    SetAttenuation(Other.GetAttenuation());
 
    return *this;
}
 

void Sound::ResetBuffer()
{
    // First stop the sound in case it is playing
    Stop();
 
    // Detach the buffer
    ALCheck(alSourcei(mySource, AL_BUFFER, 0));
    myBuffer = NULL;
}
 
} // namespace sf