lugre_sound.h

Go to the documentation of this file.

/*
http://www.opensource.org/licenses/mit-license.php  (MIT-License)

Copyright (c) 2007 Lugre-Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#ifndef LUGRE_SOUND_H
#define LUGRE_SOUND_H

#include "lugre_smartptr.h"

class lua_State;

namespace Lugre {

class cSoundSource : public cSmartPointable {
protected:
    cSoundSource(){};
public:
    virtual ~cSoundSource(){};

    virtual const bool Play() = 0;
    virtual const bool IsPlaying() = 0;
    virtual const bool IsPaused() = 0;
    virtual void Stop() = 0;
    virtual void Pause() = 0;

    virtual void SetVolume(const float volume) = 0;
    virtual const float GetVolume() = 0;

    virtual void SetMinMaxDistance(const float min, const float max) = 0;
    virtual void GetMinMaxDistance(float &min, float &max) = 0;

    

    virtual bool Is3D() = 0;
    
    virtual void SetPosition(const float x, const float y, const float z) = 0;
    virtual void SetVelocity(const float x, const float y, const float z) = 0;

    virtual void GetPosition(float &x, float &y, float &z) = 0;
    virtual void GetVelocity(float &x, float &y, float &z) = 0;

    // lua binding
    static void     LuaRegister     (lua_State *L);
};

class cSoundSystem : public cSmartPointable {
protected:
    cSoundSystem(){};
public:
    virtual ~cSoundSystem(){};

    virtual void SetListenerPosition(const float x, const float y, const float z) = 0;  
    virtual void SetListenerVelocity(const float x, const float y, const float z) = 0;
    virtual void GetListenerPosition(float &x, float &y, float &z) = 0;
    virtual void GetListenerVelocity(float &x, float &y, float &z) = 0;

    virtual void SetVolume(const float volume) = 0;
    virtual const float GetVolume() = 0;

    virtual void SetDistanceFactor(const float s) = 0;
    virtual const float GetDistanceFactor() = 0;

    virtual cSoundSource *CreateSoundSource(const char *filename) = 0;
    virtual cSoundSource *CreateSoundSource(const char *buffer, const int size, const int channels, const int bitrate, const int frequency) = 0;

    virtual cSoundSource *CreateSoundSource3D(const float x, const float y, const float z, const char *filename) = 0;
    virtual cSoundSource *CreateSoundSource3D(const float x, const float y, const float z, const char *buffer, const int size, const int channels, const int bitrate, const int frequency) = 0;
    
    virtual void Step() = 0;

    // lua binding
    static void     LuaRegister     (lua_State *L);
};

cSoundSystem *CreateSoundSystem(const char *name, const int frequency);

};

#endif