documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

Sound.cpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila ([email protected])
//
// 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));
    }
}


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;
}


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

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  :: 

previous page start next page

Menu

• Homepage

Table of contents

• Main Page
• Class List
  • sf::AudioResource
  • sf::Clock
  • sf::Color
  • sf::Context
  • sf::Drawable
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Font
  • sf::Ftp
  • sf::Ftp::Ftp::DirectoryResponse
  • sf::Ftp::Ftp::ListingResponse
  • sf::Ftp::Ftp::Response
  • sf::Glyph
  • sf::Http
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::Image
  • sf::Input
  • sf::IPAddress
  • sf::Listener
  • sf::Lock
  • sf::Matrix3
  • sf::Music
  • sf::Mutex
  • sf::NonCopyable
  • sf::Packet
  • sf::PostFX
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
  • sf::RenderWindow
  • sf::Resource< T >
  • sf::ResourcePtr< T >
  • sf::Selector< Type >
  • sf::SelectorBase
  • sf::Shape
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::Sound
  • sf::SoundBuffer
  • sf::SoundBufferRecorder
  • sf::SoundRecorder
  • sf::SoundStream
  • sf::SoundStream::SoundStream::Chunk
  • sf::Sprite
  • sf::String
  • sf::Thread
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::Window
  • sf::WindowListener
  • sf::WindowSettings
• Class Hierarchy
  • sf::AudioResource
    • sf::Sound
      • sf::SoundStream
        • sf::Music
    • sf::SoundBuffer
  • sf::Clock
  • sf::Color
  • sf::Drawable
    • sf::PostFX
    • sf::Shape
    • sf::Sprite
    • sf::String
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Ftp::Ftp::Response
    • sf::Ftp::Ftp::DirectoryResponse
    • sf::Ftp::Ftp::ListingResponse
  • sf::Glyph
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::IPAddress
  • sf::Listener
  • sf::Matrix3
  • sf::NonCopyable
    • sf::Context
    • sf::Ftp
    • sf::Http
    • sf::Input
    • sf::Lock
    • sf::Mutex
    • sf::Thread
      • sf::SoundRecorder
        • sf::SoundBufferRecorder
      • sf::SoundStream
    • sf::Window
      • sf::RenderWindow
  • sf::Packet
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
    • sf::RenderWindow
  • sf::Resource< T >
  • sf::Resource< Font >
    • sf::Font
  • sf::Resource< Image >
    • sf::Image
  • sf::Resource< SoundBuffer >
    • sf::SoundBuffer
  • sf::ResourcePtr< T >
  • sf::SelectorBase
    • sf::Selector< Type >
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::SoundStream::SoundStream::Chunk
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::WindowListener
    • sf::Input
    • sf::Window
  • sf::WindowSettings
• Class Members
• Namespace List
  • sf::Blend
  • sf::Joy
  • sf::Key
  • sf::Mouse
  • sf::Style
• Namespace Members
• File List
  • Arial.hpp
  • Audio.hpp
  • AudioDevice.cpp
  • AudioDevice.hpp
  • AudioResource.cpp
  • AudioResource.hpp
  • Clock.cpp
  • Clock.hpp
  • Color.cpp
  • Color.hpp
  • Config.hpp
  • Context.cpp
  • Context.hpp
  • Doxygen.hpp
  • Drawable.cpp
  • Drawable.hpp
  • Event.hpp
  • Font.cpp
  • Font.hpp
  • FontLoader.cpp
  • FontLoader.hpp
  • Ftp.cpp
  • Ftp.hpp
  • Glyph.hpp
  • Graphics.hpp
  • GraphicsContext.cpp
  • GraphicsContext.hpp
  • Http.cpp
  • Http.hpp
  • Image.cpp
  • Image.hpp
  • ImageLoader.cpp
  • ImageLoader.hpp
  • Input.cpp
  • Input.hpp
  • IPAddress.cpp
  • IPAddress.hpp
  • Cocoa/Joystick.cpp
  • Template for new ports/Joystick.cpp
  • Win32/Joystick.cpp
  • Cocoa/Joystick.hpp
  • Joystick.hpp
  • Template for new ports/Joystick.hpp
  • Win32/Joystick.hpp
  • Listener.cpp
  • Listener.hpp
  • Lock.cpp
  • Lock.hpp
  • Matrix3.cpp
  • Matrix3.hpp
  • Matrix3.inl
  • Music.cpp
  • Music.hpp
  • Mutex.cpp
  • Mutex.hpp
  • Win32/Mutex.hpp
  • Network.hpp
  • NonCopyable.hpp
  • OpenAL.hpp
  • OpenGL.hpp
  • Packet.cpp
  • Packet.hpp
  • Platform.cpp
  • Platform.hpp
  • Win32/Platform.hpp
  • PostFX.cpp
  • PostFX.hpp
  • Randomizer.cpp
  • Randomizer.hpp
  • Rect.hpp
  • Rect.inl
  • RenderTarget.cpp
  • RenderTarget.hpp
  • RenderWindow.cpp
  • RenderWindow.hpp
  • Resource.hpp
  • Resource.inl
  • ResourcePtr.inl
  • Selector.hpp
  • Selector.inl
  • SelectorBase.cpp
  • SelectorBase.hpp
  • SFML_Main.cpp
  • Shape.cpp
  • Shape.hpp
  • Sleep.cpp
  • Sleep.hpp
  • SocketHelper.cpp
  • SocketHelper.hpp
  • Win32/SocketHelper.hpp
  • Sockets.hpp
  • SocketTCP.cpp
  • SocketTCP.hpp
  • SocketUDP.cpp
  • SocketUDP.hpp
  • Sound.cpp
  • Sound.hpp
  • SoundBuffer.cpp
  • SoundBuffer.hpp
  • SoundBufferRecorder.cpp
  • SoundBufferRecorder.hpp
  • SoundFile.cpp
  • SoundFile.hpp
  • SoundFileDefault.cpp
  • SoundFileDefault.hpp
  • SoundFileOgg.cpp
  • SoundFileOgg.hpp
  • SoundRecorder.cpp
  • SoundRecorder.hpp
  • SoundStream.cpp
  • SoundStream.hpp
  • Sprite.cpp
  • Sprite.hpp
  • String.cpp
  • String.hpp
  • System.hpp
  • Thread.cpp
  • Thread.hpp
  • Win32/Thread.hpp
  • Unicode.cpp
  • Unicode.hpp
  • Unicode.inl
  • Vector2.hpp
  • Vector2.inl
  • Vector3.hpp
  • Vector3.inl
  • VideoMode.cpp
  • VideoMode.hpp
  • Cocoa/VideoModeSupport.cpp
  • Template for new ports/VideoModeSupport.cpp
  • Win32/VideoModeSupport.cpp
  • Cocoa/VideoModeSupport.hpp
  • Template for new ports/VideoModeSupport.hpp
  • VideoModeSupport.hpp
  • Win32/VideoModeSupport.hpp
  • View.cpp
  • View.hpp
  • Window.cpp
  • Window/Window.hpp
  • Window.hpp
  • WindowHandle.hpp
  • WindowImpl.cpp
  • WindowImpl.hpp
  • WindowImplCocoa.hpp
  • WindowImplWin32.cpp
  • WindowImplWin32.hpp
  • WindowImplXXX.cpp
  • WindowImplXXX.hpp
  • WindowListener.hpp
  • WindowSettings.hpp
  • WindowStyle.hpp

Get in touch

Submit feedback about this site to:

• [email protected]

© documentation.help. Design: rehmann.co.