manager.h

Go to the documentation of this file.

/*
 * manager.h
 *
 * Copyright (C) 2001-2010 Atomic Blue (info@planeshift.it, http://www.planeshift.it)
 *
 * Credits : Saul Leite <leite@engineer.com>
 *           Mathias 'AgY' Voeroes <agy@operswithoutlife.net>
 *           and all past and present planeshift coders
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef _SOUND_MANAGER_H_
#define _SOUND_MANAGER_H_


//====================================================================================
// Crystal Space Includes
//====================================================================================
#include <cssysdef.h>
#include <iutil/objreg.h>
#include <csgeom/vector3.h>
#include <csutil/hash.h>
#include <iutil/timer.h>
#include <csutil/timer.h>
#include <csutil/randomgen.h>

//====================================================================================
// Project Includes
//====================================================================================
#include "util/singleton.h"

//------------------------------------------------------------------------------------
// Forward Declarations
//------------------------------------------------------------------------------------
class SoundSystem;
class SoundDataCache;
class SoundHandle;
class SoundControl;

enum
{
    LOOP        = true,
    DONT_LOOP   = false
};


#define VOLUME_ZERO 0.0f
#define VOLUME_MIN  0.0f
#define VOLUME_NORM 1.0f
#define VOLUME_MAX  2.0f

#define DEFAULT_SNDSYS_UPDATE_TIME 100
#define DEFAULT_SPEED_OF_SOUND 331
#define DEFAULT_DOPPLER_FACTOR 0.0
#define DEFAULT_SOUNDLIB_PATH "/planeshift/art/soundlib.xml"

class SoundSystemManager: public Singleton<SoundSystemManager>
{
public:
    bool                   Initialised;       
    SoundControl*          mainSndCtrl;
    csRef<iEventTimer>     eventTimer;        

    SoundSystemManager();

    ~SoundSystemManager();

    bool Initialize(iObjectRegistry* objectReg);

    bool IsHandleValid(uint handleID) const;

    void UpdateSound();

    bool Play2DSound(const char* name, bool loop, size_t loopstart,
                     size_t loopend, float volume_preset,
                     SoundControl* &sndCtrl, SoundHandle* &handle);

    bool Play3DSound(const char* name, bool loop, size_t loopstart,
                     size_t loopend, float volume_preset,
                     SoundControl* &sndCtrl, csVector3 pos, csVector3 dir,
                     float mindist, float maxdist, float rad, int type3d,
                     SoundHandle* &handle, bool dopplerEffect = true);

    bool StopSound(uint handleID);

    bool SetSoundSource(uint handleID, csVector3 position);

    void SetPlayerPosition(csVector3& pos);

    csVector3& GetPlayerPosition();

    void SetPlayerVelocity(csVector3 vel);

    void UpdateListener(csVector3 v, csVector3 f, csVector3 t);

    csVector3 GetListenerPos() const;

    void Update();

    SoundControl* AddSoundControl(uint sndCtrlID);
    void RemoveSoundControl(uint sndCtrlID);
    SoundControl* GetSoundControl(uint sndCtrlID) const;

    SoundSystem* GetSoundSystem() const { return soundSystem; }
    SoundDataCache* GetSoundDataCache() const { return soundDataCache; }

private:
    SoundSystem*                   soundSystem;
    SoundDataCache*                soundDataCache;
    csHash<SoundHandle*, uint>     soundHandles;       
    csHash<SoundControl*, uint>    soundControllers;   

    uint                           updateTime;         
    csTicks                        SndTime;            
    csTicks                        LastUpdateTime;     

    csVector3                      playerPosition;     
    csVector3                      playerVelocity;     

    uint                           speedOfSound;       
    float                          dopplerFactor;      

    uint FindHandleID();

    void RemoveHandle(uint handleID);

    void ChangePlayRate(SoundHandle* handle);

    bool InitSoundHandle(const char* name, bool loop, size_t loopstart,
                     size_t loopend, float volume_preset, int type3d,
                     SoundControl* &sndCtrl, SoundHandle* &handle, bool dopplerEffect);
};

#endif /*_SOUND_MANAGER_H_*/