Sound.h

Go to the documentation of this file.

/*
    This source file is part of Rigs of Rods
    Copyright 2005-2012 Pierre-Michel Ricordel
    Copyright 2007-2012 Thomas Fischer
 
    For more information, see http://www.rigsofrods.org/
 
    Rigs of Rods is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 3, as
    published by the Free Software Foundation.
 
    Rigs of Rods is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with Rigs of Rods. If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifdef USE_OPENAL
 
#pragma once
 
#include "Application.h"
#include "RefCountingObject.h"
 
#ifdef __APPLE__
#   include <OpenAL/al.h>
#else
#   include <AL/al.h>
#endif // __APPLE__
 
namespace RoR {
 
 
class Sound : public RefCountingObject<Sound>
{
    friend class SoundManager;
 
public:
    Sound(ALuint buffer, SoundManager* soundManager, int sourceIndex);
    virtual ~Sound() override {};
 
    void setPitch(float pitch);
    void setGain(float gain);
    void setPosition(Ogre::Vector3 pos);
    void setVelocity(Ogre::Vector3 vel);
    void setLoop(bool loop);
    void setEnabled(bool e);
    void play();
    void stop();
 
    bool getEnabled();
    bool isPlaying();
    float getAudibility() { return audibility; }
    float getGain() { return gain; }
    float getPitch() { return pitch; }
    bool getLoop() { return loop; }
    int getCurrentHardwareIndex() { return hardware_index; }
    ALuint getBuffer() { return buffer; }
    Ogre::Vector3 getPosition() { return position; }
    Ogre::Vector3 getVelocity() { return velocity; }
    int getSourceIndex() { return source_index; }
 
    enum RecomputeSource
    {
        REASON_PLAY,
        REASON_STOP,
        REASON_GAIN,
        REASON_LOOP,
        REASON_PTCH,
        REASON_POSN,
        REASON_VLCT
    };
 
private:
    void computeAudibility(Ogre::Vector3 pos);
 
    float audibility;
    float gain;
    float pitch;
    bool loop;
    bool enabled;
    bool should_play;
 
    // this value is changed dynamically, depending on whether the input is played or not.
    int hardware_index;
    ALuint buffer;
 
    Ogre::Vector3 position;
    Ogre::Vector3 velocity;
 
    SoundManager* sound_manager;
    // must not be changed during the lifetime of this object
    int source_index;
};
 
 
} // namespace RoR
 
#endif // USE_OPENAL